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_ChartStatistics_idl__
24#define __com_sun_star_chart_ChartStatistics_idl__
25
26#ifndef __com_sun_star_beans_XPropertySet_idl__
27#include <com/sun/star/beans/XPropertySet.idl>
28#endif
29
30#ifndef __com_sun_star_chart_ChartErrorCategory_idl__
31#include <com/sun/star/chart/ChartErrorCategory.idl>
32#endif
33
34#ifndef __com_sun_star_chart_ChartErrorIndicatorType_idl__
35#include <com/sun/star/chart/ChartErrorIndicatorType.idl>
36#endif
37
38#ifndef __com_sun_star_chart_ChartRegressionCurveType_idl__
39#include <com/sun/star/chart/ChartRegressionCurveType.idl>
40#endif
41
42#include <com/sun/star/chart/ErrorBarStyle.idl>
43
44//=============================================================================
45
46 module com {  module sun {  module star {  module chart {
47
48//=============================================================================
49
50/** offers statistical properties for the data in the chart. It is
51	available for a single data row and for the whole diagram.
52 */
53published service ChartStatistics
54{
55	interface com::sun::star::beans::XPropertySet;
56
57	//-------------------------------------------------------------------------
58
59	/** specifies the lower limit of the error range of a
60		data row.
61
62        <p>this setting is effective if the
63        <member>ChartStatistics::ErrorCategory</member> is set to
64        <member>ChartErrorCategory::CONSTANT_VALUE</member>.</p>
65
66        @see ConstantErrorHigh
67		@see ErrorCategory
68	 */
69	[property] double ConstantErrorLow;
70
71	//-------------------------------------------------------------------------
72
73	/** specifies the upper limit of the error range of a
74		data row.
75
76        <p>this setting is effective if the
77        <member>ChartStatistics::ErrorCategory</member> is set to
78        <member>ChartErrorCategory::CONSTANT_VALUE</member>.</p>
79
80        @see ConstantErrorLow
81        @see ErrorCategory
82	 */
83	[property] double ConstantErrorHigh;
84
85	//-------------------------------------------------------------------------
86
87	/** determines if the mean value for a data row is
88		displayed as a line.
89	 */
90	[property] boolean MeanValue;
91
92	//-------------------------------------------------------------------------
93
94	/** determines the type of error to indicate.
95
96        @deprecated
97
98        @see ChartErrorCategory
99        @see PercentageError
100        @see ErrorMargin
101        @see ConstantErrorLow
102        @see ConstantErrorHigh
103        @see ErrorIndicator
104	 */
105	[property] com::sun::star::chart::ChartErrorCategory ErrorCategory;
106
107    /** determines the style of the error bars. Use this instead of
108        ErrorCategory
109
110         @see ErrorBarStyle
111     */
112	[optional, property] long ErrorBarStyle;
113
114	//-------------------------------------------------------------------------
115
116	/** specifies the percentage that is used to display error bars.
117
118        <p>The length of the error indicators is calculated for each
119        data point by taking the given percentatge of its value.</p>
120
121        <p>this setting is effective if the
122        <member>ChartStatistics::ErrorCategory</member> is set to
123        <member>ChartErrorCategory::PERCENT</member>.</p>
124
125        @see ErrorCategory
126	 */
127	[property] double PercentageError;
128
129	//-------------------------------------------------------------------------
130
131	/** specifies the percentage for the margin of errors.
132
133        <p>The length of the error indicators is calculated by taking
134        the percentage given of the largest data point value.</p>
135
136        <p>this setting is effective if the
137        <member>ChartStatistics::ErrorCategory</member> is set to
138        <member>ChartErrorCategory::ERROR_MARGIN</member>.</p>
139
140        @see ErrorCategory
141	 */
142	[property] double ErrorMargin;
143
144	//-------------------------------------------------------------------------
145
146	/** determines how the error is indicated.
147
148        <p>You can enable indicators pointing up, down or both.</p>
149
150        @see ErrorCategory
151	 */
152	[property] com::sun::star::chart::ChartErrorIndicatorType ErrorIndicator;
153
154	//-------------------------------------------------------------------------
155
156	/** determines a type of regression for the data row values.
157
158        @see ChartRegressionCurveType
159	 */
160	[property] com::sun::star::chart::ChartRegressionCurveType RegressionCurves;
161
162    /** contains a cell range string for positve error bars. This
163        property is used when the <type>ErrorBarCategory</type> is set
164        to <member>ErrorBarCategory::FROM_DATA</member>.
165     */
166    [optional, property] string ErrorBarRangePositive;
167
168    /** contains a cell range string for negative error bars. This
169        property is used when the <type>ErrorBarCategory</type> is set
170        to <member>ErrorBarCategory::FROM_DATA</member>.
171     */
172    [optional, property] string ErrorBarRangeNegative;
173};
174
175//=============================================================================
176
177}; }; }; };
178
179#endif
180