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

   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_ErrorBarStyle_idl
  28 #define com_sun_star_chart_ErrorBarStyle_idl
  29
  30 module com {  module sun {  module star {  module chart {
  31
  32 /** specifies the style of error indicators.
  33  */
  34 published constants ErrorBarStyle
  35 {
  36     /** error indicators are not displayed.
  37      */
  38     const long NONE = 0;
  39
  40     /** displays error indicators for the variance of the data.
  41      */
  42     const long VARIANCE = 1;
  43
  44     /** displays error indicators for the standard deviation (square
  45         root of variance) of the data.
  46      */
  47     const long STANDARD_DEVIATION = 2;
  48
  49     /** the error indicators for all data points have the same
  50         absolute value as length for either direction.
  51
  52         <p>The values for these are given as absolute numbers in
  53         <member>ChartStatistics::ConstantErrorLow</member> and
  54         <member>ChartStatistics::ConstantErrorHigh</member></p>
  55
  56         @see ChartStatistics
  57      */
  58     const long ABSOLUTE = 3;
  59
  60     /** The length of the error indicators is calculated for each data
  61         point by taking the percentage given as
  62         <member>ChartStatistics::PercentageError</member> of its
  63         value.
  64
  65         @see ChartStatistics
  66      */
  67     const long RELATIVE = 4;
  68
  69     /** The length of the error indicators for all data points is
  70         calculated by taking the percentage given as
  71         <member>ChartStatistics::ErrorMargin</member> of the largest
  72         data point value.
  73
  74         @see ChartStatistics
  75      */
  76     const long ERROR_MARGIN = 5;
  77
  78     /** displays error indicators for the standard error, also known
  79         as the standard deviation of the mean (SDOM).
  80      */
  81     const long STANDARD_ERROR = 6;
  82
  83     /** Uses values given by cell ranges of the container document.
  84
  85         <p>The values for the cell ranges are given in the properties
  86         <member>ChartStatistics::ErrorBarRangePositive</member> for
  87         positive indicators and
  88         <member>ChartStatistics::ErrorBarRangeNegative</member> for
  89         negative indicators.</p>
  90      */
  91     const long FROM_DATA = 7;
  92 };
  93
  94 //=============================================================================
  95
  96 }; }; }; };
  97
  98 #endif