1/************************************************************************* 2 * 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * Copyright 2000, 2010 Oracle and/or its affiliates. 6 * 7 * OpenOffice.org - a multi-platform office productivity suite 8 * 9 * This file is part of OpenOffice.org. 10 * 11 * OpenOffice.org is free software: you can redistribute it and/or modify 12 * it under the terms of the GNU Lesser General Public License version 3 13 * only, as published by the Free Software Foundation. 14 * 15 * OpenOffice.org is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU Lesser General Public License version 3 for more details 19 * (a copy is included in the LICENSE file that accompanied this code). 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * version 3 along with OpenOffice.org. If not, see 23 * <http://www.openoffice.org/license.html> 24 * for a copy of the LGPLv3 License. 25 * 26 ************************************************************************/ 27#ifndef __com_sun_star_chart_ChartStatistics_idl__ 28#define __com_sun_star_chart_ChartStatistics_idl__ 29 30#ifndef __com_sun_star_beans_XPropertySet_idl__ 31#include <com/sun/star/beans/XPropertySet.idl> 32#endif 33 34#ifndef __com_sun_star_chart_ChartErrorCategory_idl__ 35#include <com/sun/star/chart/ChartErrorCategory.idl> 36#endif 37 38#ifndef __com_sun_star_chart_ChartErrorIndicatorType_idl__ 39#include <com/sun/star/chart/ChartErrorIndicatorType.idl> 40#endif 41 42#ifndef __com_sun_star_chart_ChartRegressionCurveType_idl__ 43#include <com/sun/star/chart/ChartRegressionCurveType.idl> 44#endif 45 46#include <com/sun/star/chart/ErrorBarStyle.idl> 47 48//============================================================================= 49 50 module com { module sun { module star { module chart { 51 52//============================================================================= 53 54/** offers statistical properties for the data in the chart. It is 55 available for a single data row and for the whole diagram. 56 */ 57published service ChartStatistics 58{ 59 interface com::sun::star::beans::XPropertySet; 60 61 //------------------------------------------------------------------------- 62 63 /** specifies the lower limit of the error range of a 64 data row. 65 66 <p>this setting is effective if the 67 <member>ChartStatistics::ErrorCategory</member> is set to 68 <member>ChartErrorCategory::CONSTANT_VALUE</member>.</p> 69 70 @see ConstantErrorHigh 71 @see ErrorCategory 72 */ 73 [property] double ConstantErrorLow; 74 75 //------------------------------------------------------------------------- 76 77 /** specifies the upper limit of the error range of a 78 data row. 79 80 <p>this setting is effective if the 81 <member>ChartStatistics::ErrorCategory</member> is set to 82 <member>ChartErrorCategory::CONSTANT_VALUE</member>.</p> 83 84 @see ConstantErrorLow 85 @see ErrorCategory 86 */ 87 [property] double ConstantErrorHigh; 88 89 //------------------------------------------------------------------------- 90 91 /** determines if the mean value for a data row is 92 displayed as a line. 93 */ 94 [property] boolean MeanValue; 95 96 //------------------------------------------------------------------------- 97 98 /** determines the type of error to indicate. 99 100 @deprecated 101 102 @see ChartErrorCategory 103 @see PercentageError 104 @see ErrorMargin 105 @see ConstantErrorLow 106 @see ConstantErrorHigh 107 @see ErrorIndicator 108 */ 109 [property] com::sun::star::chart::ChartErrorCategory ErrorCategory; 110 111 /** determines the style of the error bars. Use this instead of 112 ErrorCategory 113 114 @see ErrorBarStyle 115 */ 116 [optional, property] long ErrorBarStyle; 117 118 //------------------------------------------------------------------------- 119 120 /** specifies the percentage that is used to display error bars. 121 122 <p>The length of the error indicators is calculated for each 123 data point by taking the given percentatge of its value.</p> 124 125 <p>this setting is effective if the 126 <member>ChartStatistics::ErrorCategory</member> is set to 127 <member>ChartErrorCategory::PERCENT</member>.</p> 128 129 @see ErrorCategory 130 */ 131 [property] double PercentageError; 132 133 //------------------------------------------------------------------------- 134 135 /** specifies the percentage for the margin of errors. 136 137 <p>The length of the error indicators is calculated by taking 138 the percentage given of the largest data point value.</p> 139 140 <p>this setting is effective if the 141 <member>ChartStatistics::ErrorCategory</member> is set to 142 <member>ChartErrorCategory::ERROR_MARGIN</member>.</p> 143 144 @see ErrorCategory 145 */ 146 [property] double ErrorMargin; 147 148 //------------------------------------------------------------------------- 149 150 /** determines how the error is indicated. 151 152 <p>You can enable indicators pointing up, down or both.</p> 153 154 @see ErrorCategory 155 */ 156 [property] com::sun::star::chart::ChartErrorIndicatorType ErrorIndicator; 157 158 //------------------------------------------------------------------------- 159 160 /** determines a type of regression for the data row values. 161 162 @see ChartRegressionCurveType 163 */ 164 [property] com::sun::star::chart::ChartRegressionCurveType RegressionCurves; 165 166 /** contains a cell range string for positve error bars. This 167 property is used when the <type>ErrorBarCategory</type> is set 168 to <member>ErrorBarCategory::FROM_DATA</member>. 169 */ 170 [optional, property] string ErrorBarRangePositive; 171 172 /** contains a cell range string for negative error bars. This 173 property is used when the <type>ErrorBarCategory</type> is set 174 to <member>ErrorBarCategory::FROM_DATA</member>. 175 */ 176 [optional, property] string ErrorBarRangeNegative; 177}; 178 179//============================================================================= 180 181}; }; }; }; 182 183#endif 184