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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21  module com {  module sun {  module star {  module chart {
  22
  23
  24 /** offers statistical properties for the data in the chart. It is
  25     available for a single data row and for the whole diagram.
  26  */
  27 published service ChartStatistics
  28 {
  29     interface com::sun::star::beans::XPropertySet;
  30
  31
  32     /** specifies the lower limit of the error range of a
  33         data row.
  34
  35         <p>this setting is effective if the
  36         ChartStatistics::ErrorCategory is set to
  37         ChartErrorCategory::CONSTANT_VALUE.</p>
  38
  39         @see ConstantErrorHigh
  40         @see ErrorCategory
  41      */
  42     [property] double ConstantErrorLow;
  43
  44
  45     /** specifies the upper limit of the error range of a
  46         data row.
  47
  48         <p>this setting is effective if the
  49         ChartStatistics::ErrorCategory is set to
  50         ChartErrorCategory::CONSTANT_VALUE.</p>
  51
  52         @see ConstantErrorLow
  53         @see ErrorCategory
  54      */
  55     [property] double ConstantErrorHigh;
  56
  57
  58     /** determines if the mean value for a data row is
  59         displayed as a line.
  60      */
  61     [property] boolean MeanValue;
  62
  63
  64     /** determines the type of error to indicate.
  65
  66         @deprecated
  67
  68         @see ChartErrorCategory
  69         @see PercentageError
  70         @see ErrorMargin
  71         @see ConstantErrorLow
  72         @see ConstantErrorHigh
  73         @see ErrorIndicator
  74      */
  75     [property] com::sun::star::chart::ChartErrorCategory ErrorCategory;
  76
  77     /** determines the style of the error bars. Use this instead of
  78         ErrorCategory
  79
  80          @see ErrorBarStyle
  81      */
  82     [optional, property] long ErrorBarStyle;
  83
  84
  85     /** specifies the percentage that is used to display error bars.
  86
  87         <p>The length of the error indicators is calculated for each
  88         data point by taking the given percentage of its value.</p>
  89
  90         <p>this setting is effective if the
  91         ChartStatistics::ErrorCategory is set to
  92         ChartErrorCategory::PERCENT.</p>
  93
  94         @see ErrorCategory
  95      */
  96     [property] double PercentageError;
  97
  98
  99     /** specifies the percentage for the margin of errors.
 100
 101         <p>The length of the error indicators is calculated by taking
 102         the percentage given of the largest data point value.</p>
 103
 104         <p>this setting is effective if the
 105         ChartStatistics::ErrorCategory is set to
 106         ChartErrorCategory::ERROR_MARGIN.</p>
 107
 108         @see ErrorCategory
 109      */
 110     [property] double ErrorMargin;
 111
 112
 113     /** determines how the error is indicated.
 114
 115         <p>You can enable indicators pointing up, down or both.</p>
 116
 117         @see ErrorCategory
 118      */
 119     [property] com::sun::star::chart::ChartErrorIndicatorType ErrorIndicator;
 120
 121
 122     /** determines a type of regression for the data row values.
 123
 124         @see ChartRegressionCurveType
 125      */
 126     [property] com::sun::star::chart::ChartRegressionCurveType RegressionCurves;
 127
 128     /** contains a cell range string for positive error bars. This
 129         property is used when the ErrorBarCategory is set
 130         to ErrorBarCategory::FROM_DATA.
 131      */
 132     [optional, property] string ErrorBarRangePositive;
 133
 134     /** contains a cell range string for negative error bars. This
 135         property is used when the ErrorBarCategory is set
 136         to ErrorBarCategory::FROM_DATA.
 137      */
 138     [optional, property] string ErrorBarRangeNegative;
 139 };
 140
 141
 142 }; }; }; };
 143
 144 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */