offapi/com/sun/star/chart/ChartErrorCategory.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: ChartErrorCategory.idl,v $
  10  * $Revision: 1.10 $
  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_ChartErrorCategory_idl__
  31 #define __com_sun_star_chart_ChartErrorCategory_idl__
  32
  33
  34 //=============================================================================
  35
  36  module com {  module sun {  module star {  module chart {
  37
  38 //=============================================================================
  39
  40 /** specifies the category of error indicators.
  41  */
  42 published enum ChartErrorCategory
  43 {
  44     //-------------------------------------------------------------------------
  45
  46     /** error indicators are not displayed.
  47      */
  48     NONE,
  49
  50     //-------------------------------------------------------------------------
  51
  52     /** displays error indicators for the variance of the data row.
  53      */
  54     VARIANCE,
  55
  56     //-------------------------------------------------------------------------
  57
  58     /** displays error indicators for the standard deviation (square
  59         root of variance) of the data row.
  60      */
  61     STANDARD_DEVIATION,
  62
  63     //-------------------------------------------------------------------------
  64
  65     /** The length of the error indicators is calculated for each data
  66         point by taking the percentage given as
  67         <member>ChartStatistics::PercentageError</member> of its
  68         value.
  69
  70         @see ChartStatistics
  71      */
  72     PERCENT,
  73
  74     //-------------------------------------------------------------------------
  75
  76     /** The length of the error indicators for all data points is
  77         calculated by taking the percentage given as
  78         <member>ChartStatistics::ErrorMargin</member> of the largest
  79         data point value.
  80
  81         @see ChartStatistics
  82      */
  83     ERROR_MARGIN,
  84
  85     //-------------------------------------------------------------------------
  86
  87     /** displays the same lower and upper error indicators for all
  88         data points.
  89
  90         <p>The values for these are given as absolute numbers in
  91         <member>ChartStatistics::ConstantErrorLow</member> and
  92         <member>ChartStatistics::ConstantErrorHigh</member></p>
  93
  94         @see ChartStatistics
  95      */
  96     CONSTANT_VALUE
  97
  98 };
  99
 100 //=============================================================================
 101
 102 }; }; }; };
 103
 104 #endif