merged tag ooo/OOO330_m14
[LibreOffice.git] / offapi / com / sun / star / chart / ChartErrorCategory.idl
blob6f51ca054a07ea86386e36970c9b4d6f75c3bce6
1 /*************************************************************************
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
7 * OpenOffice.org - a multi-platform office productivity suite
9 * This file is part of OpenOffice.org.
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.
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).
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.
26 ************************************************************************/
27 #ifndef __com_sun_star_chart_ChartErrorCategory_idl__
28 #define __com_sun_star_chart_ChartErrorCategory_idl__
31 //=============================================================================
33 module com { module sun { module star { module chart {
35 //=============================================================================
37 /** specifies the category of error indicators.
39 published enum ChartErrorCategory
41 //-------------------------------------------------------------------------
43 /** error indicators are not displayed.
45 NONE,
47 //-------------------------------------------------------------------------
49 /** displays error indicators for the variance of the data row.
51 VARIANCE,
53 //-------------------------------------------------------------------------
55 /** displays error indicators for the standard deviation (square
56 root of variance) of the data row.
58 STANDARD_DEVIATION,
60 //-------------------------------------------------------------------------
62 /** The length of the error indicators is calculated for each data
63 point by taking the percentage given as
64 <member>ChartStatistics::PercentageError</member> of its
65 value.
67 @see ChartStatistics
69 PERCENT,
71 //-------------------------------------------------------------------------
73 /** The length of the error indicators for all data points is
74 calculated by taking the percentage given as
75 <member>ChartStatistics::ErrorMargin</member> of the largest
76 data point value.
78 @see ChartStatistics
80 ERROR_MARGIN,
82 //-------------------------------------------------------------------------
84 /** displays the same lower and upper error indicators for all
85 data points.
87 <p>The values for these are given as absolute numbers in
88 <member>ChartStatistics::ConstantErrorLow</member> and
89 <member>ChartStatistics::ConstantErrorHigh</member></p>
91 @see ChartStatistics
93 CONSTANT_VALUE
97 //=============================================================================
99 }; }; }; };
101 #endif