| /************************************************************** |
| * |
| * 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_ChartStatistics_idl__ |
| #define __com_sun_star_chart_ChartStatistics_idl__ |
| |
| #ifndef __com_sun_star_beans_XPropertySet_idl__ |
| #include <com/sun/star/beans/XPropertySet.idl> |
| #endif |
| |
| #ifndef __com_sun_star_chart_ChartErrorCategory_idl__ |
| #include <com/sun/star/chart/ChartErrorCategory.idl> |
| #endif |
| |
| #ifndef __com_sun_star_chart_ChartErrorIndicatorType_idl__ |
| #include <com/sun/star/chart/ChartErrorIndicatorType.idl> |
| #endif |
| |
| #ifndef __com_sun_star_chart_ChartRegressionCurveType_idl__ |
| #include <com/sun/star/chart/ChartRegressionCurveType.idl> |
| #endif |
| |
| #include <com/sun/star/chart/ErrorBarStyle.idl> |
| |
| //============================================================================= |
| |
| module com { module sun { module star { module chart { |
| |
| //============================================================================= |
| |
| /** offers statistical properties for the data in the chart. It is |
| available for a single data row and for the whole diagram. |
| */ |
| published service ChartStatistics |
| { |
| interface com::sun::star::beans::XPropertySet; |
| |
| //------------------------------------------------------------------------- |
| |
| /** specifies the lower limit of the error range of a |
| data row. |
| |
| <p>this setting is effective if the |
| <member>ChartStatistics::ErrorCategory</member> is set to |
| <member>ChartErrorCategory::CONSTANT_VALUE</member>.</p> |
| |
| @see ConstantErrorHigh |
| @see ErrorCategory |
| */ |
| [property] double ConstantErrorLow; |
| |
| //------------------------------------------------------------------------- |
| |
| /** specifies the upper limit of the error range of a |
| data row. |
| |
| <p>this setting is effective if the |
| <member>ChartStatistics::ErrorCategory</member> is set to |
| <member>ChartErrorCategory::CONSTANT_VALUE</member>.</p> |
| |
| @see ConstantErrorLow |
| @see ErrorCategory |
| */ |
| [property] double ConstantErrorHigh; |
| |
| //------------------------------------------------------------------------- |
| |
| /** determines if the mean value for a data row is |
| displayed as a line. |
| */ |
| [property] boolean MeanValue; |
| |
| //------------------------------------------------------------------------- |
| |
| /** determines the type of error to indicate. |
| |
| @deprecated |
| |
| @see ChartErrorCategory |
| @see PercentageError |
| @see ErrorMargin |
| @see ConstantErrorLow |
| @see ConstantErrorHigh |
| @see ErrorIndicator |
| */ |
| [property] com::sun::star::chart::ChartErrorCategory ErrorCategory; |
| |
| /** determines the style of the error bars. Use this instead of |
| ErrorCategory |
| |
| @see ErrorBarStyle |
| */ |
| [optional, property] long ErrorBarStyle; |
| |
| //------------------------------------------------------------------------- |
| |
| /** specifies the percentage that is used to display error bars. |
| |
| <p>The length of the error indicators is calculated for each |
| data point by taking the given percentatge of its value.</p> |
| |
| <p>this setting is effective if the |
| <member>ChartStatistics::ErrorCategory</member> is set to |
| <member>ChartErrorCategory::PERCENT</member>.</p> |
| |
| @see ErrorCategory |
| */ |
| [property] double PercentageError; |
| |
| //------------------------------------------------------------------------- |
| |
| /** specifies the percentage for the margin of errors. |
| |
| <p>The length of the error indicators is calculated by taking |
| the percentage given of the largest data point value.</p> |
| |
| <p>this setting is effective if the |
| <member>ChartStatistics::ErrorCategory</member> is set to |
| <member>ChartErrorCategory::ERROR_MARGIN</member>.</p> |
| |
| @see ErrorCategory |
| */ |
| [property] double ErrorMargin; |
| |
| //------------------------------------------------------------------------- |
| |
| /** determines how the error is indicated. |
| |
| <p>You can enable indicators pointing up, down or both.</p> |
| |
| @see ErrorCategory |
| */ |
| [property] com::sun::star::chart::ChartErrorIndicatorType ErrorIndicator; |
| |
| //------------------------------------------------------------------------- |
| |
| /** determines a type of regression for the data row values. |
| |
| @see ChartRegressionCurveType |
| */ |
| [property] com::sun::star::chart::ChartRegressionCurveType RegressionCurves; |
| |
| /** contains a cell range string for positve error bars. This |
| property is used when the <type>ErrorBarCategory</type> is set |
| to <member>ErrorBarCategory::FROM_DATA</member>. |
| */ |
| [optional, property] string ErrorBarRangePositive; |
| |
| /** contains a cell range string for negative error bars. This |
| property is used when the <type>ErrorBarCategory</type> is set |
| to <member>ErrorBarCategory::FROM_DATA</member>. |
| */ |
| [optional, property] string ErrorBarRangeNegative; |
| }; |
| |
| //============================================================================= |
| |
| }; }; }; }; |
| |
| #endif |