xref: /AOO41X/main/offapi/com/sun/star/chart/XStatisticDisplay.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_chart_XStatisticDisplay_idl__
24#define __com_sun_star_chart_XStatisticDisplay_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_beans_XPropertySet_idl__
31#include <com/sun/star/beans/XPropertySet.idl>
32#endif
33
34
35//=============================================================================
36
37 module com {  module sun {  module star {  module chart {
38
39//=============================================================================
40
41/** gives access to statistical elements for the chart.
42
43    <p>Statistical elements are used by a
44    <type>StockDiagram</type>.</p>
45
46    @see XChartDocument
47    @see StockDiagram
48 */
49published interface XStatisticDisplay: com::sun::star::uno::XInterface
50{
51    //-------------------------------------------------------------------------
52
53    /** @returns
54            the properties of the up bars of a stock chart which has
55            <member>StockDiagram::UpDown</member> set to <TRUE/>.
56
57        <p>The <em>UpBar</em> is the box that is drawn between the
58        open and close value of a stock, when the closing value is
59        above the opening value, i.e., the stock price rose.</p>
60
61        @see ChartArea
62     */
63    com::sun::star::beans::XPropertySet getUpBar();
64
65    //-------------------------------------------------------------------------
66
67    /** @returns
68            the properties of the down bars of a stock chart which has
69            <member>StockDiagram::UpDown</member> set to <TRUE/>.
70
71        <p>The <em>DownBar</em> is the box that is drawn between the
72        open and close value of a stock, when the closing value is
73        below the opening value, i.e., the stock price fell.</p>
74
75        @see ChartArea
76     */
77    com::sun::star::beans::XPropertySet getDownBar();
78
79    //-------------------------------------------------------------------------
80
81    /** @returns
82            the properties of the lines that are drawn between the
83            lowest and highest stock value during a day.
84
85        @see ChartLine
86     */
87    com::sun::star::beans::XPropertySet getMinMaxLine();
88
89};
90
91//=============================================================================
92
93}; }; }; };
94
95#endif
96