offapi/com/sun/star/chart/ChartStatistics.idl

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