xref: /AOO41X/main/offapi/com/sun/star/chart/ErrorBarStyle.idl (revision d5bd2f9e3a2ae3e1afd69ce26d2fa06adc6f3f31)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef com_sun_star_chart_ErrorBarStyle_idl
24#define com_sun_star_chart_ErrorBarStyle_idl
25
26module com {  module sun {  module star {  module chart {
27
28/** specifies the style of error indicators.
29 */
30published constants ErrorBarStyle
31{
32    /** error indicators are not displayed.
33     */
34    const long NONE = 0;
35
36    /** displays error indicators for the variance of the data.
37     */
38    const long VARIANCE = 1;
39
40    /** displays error indicators for the standard deviation (square
41        root of variance) of the data.
42     */
43    const long STANDARD_DEVIATION = 2;
44
45    /** the error indicators for all data points have the same
46        absolute value as length for either direction.
47
48        <p>The values for these are given as absolute numbers in
49        <member>ChartStatistics::ConstantErrorLow</member> and
50        <member>ChartStatistics::ConstantErrorHigh</member></p>
51
52        @see ChartStatistics
53     */
54    const long ABSOLUTE = 3;
55
56    /** The length of the error indicators is calculated for each data
57        point by taking the percentage given as
58        <member>ChartStatistics::PercentageError</member> of its
59        value.
60
61        @see ChartStatistics
62     */
63    const long RELATIVE = 4;
64
65    /** The length of the error indicators for all data points is
66        calculated by taking the percentage given as
67        <member>ChartStatistics::ErrorMargin</member> of the largest
68        data point value.
69
70        @see ChartStatistics
71     */
72    const long ERROR_MARGIN = 5;
73
74    /** displays error indicators for the standard error, also known
75        as the standard deviation of the mean (SDOM).
76     */
77    const long STANDARD_ERROR = 6;
78
79    /** Uses values given by cell ranges of the container document.
80
81        <p>The values for the cell ranges are given in the properties
82        <member>ChartStatistics::ErrorBarRangePositive</member> for
83        positive indicators and
84        <member>ChartStatistics::ErrorBarRangeNegative</member> for
85        negative indicators.</p>
86     */
87    const long FROM_DATA = 7;
88};
89
90//=============================================================================
91
92}; }; }; };
93
94#endif
95