summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/chart/XStatisticDisplay.idl
blob: 990f7b7dadaa47cf58fe65dbc10d207db09a16b3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_chart_XStatisticDisplay_idl__
#define __com_sun_star_chart_XStatisticDisplay_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif


//=============================================================================

 module com {  module sun {  module star {  module chart {

//=============================================================================

/** gives access to statistical elements for the chart.

    <p>Statistical elements are used by a
    <type>StockDiagram</type>.</p>

    @see XChartDocument
    @see StockDiagram
 */
published interface XStatisticDisplay: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    /** @returns
            the properties of the up bars of a stock chart which has
            <member>StockDiagram::UpDown</member> set to <TRUE/>.

        <p>The <em>UpBar</em> is the box that is drawn between the
        open and close value of a stock, when the closing value is
        above the opening value, i.e., the stock price rose.</p>

        @see ChartArea
     */
    com::sun::star::beans::XPropertySet getUpBar();

    //-------------------------------------------------------------------------

    /** @returns
            the properties of the down bars of a stock chart which has
            <member>StockDiagram::UpDown</member> set to <TRUE/>.

        <p>The <em>DownBar</em> is the box that is drawn between the
        open and close value of a stock, when the closing value is
        below the opening value, i.e., the stock price fell.</p>

        @see ChartArea
     */
    com::sun::star::beans::XPropertySet getDownBar();

    //-------------------------------------------------------------------------

    /** @returns
            the properties of the lines that are drawn between the
            lowest and highest stock value during a day.

        @see ChartLine
     */
    com::sun::star::beans::XPropertySet getMinMaxLine();

};

//=============================================================================

}; }; }; };

#endif