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