xref: /AOO41X/main/offapi/com/sun/star/chart/ChartDataCaption.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
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_ChartDataCaption_idl__
24#define __com_sun_star_chart_ChartDataCaption_idl__
25
26
27//=============================================================================
28
29 module com {  module sun {  module star {  module chart {
30
31//=============================================================================
32
33/** These values specify how the captions of data points are displayed.
34 */
35published constants ChartDataCaption
36{
37    //-------------------------------------------------------------------------
38
39    /** No captions are displayed.
40     */
41    const long NONE = 0;
42
43    //-------------------------------------------------------------------------
44
45    /** The caption contains the value of the data point in the number
46        format of the axis that is attached to the respective data
47        series.
48     */
49    const long VALUE = 1;
50
51    //-------------------------------------------------------------------------
52
53    /** The caption contains the value of the data point in percent of
54        all data points of one category.
55
56        <p>That means, if a data point is the first one of a series,
57        the percentage is calculated by using the first data points of
58        all available series.</p>
59     */
60    const long PERCENT = 2;
61
62    //-------------------------------------------------------------------------
63
64    /** The caption contains the category name of the category to
65        which a data point belongs.
66     */
67    const long TEXT = 4;
68
69    //-------------------------------------------------------------------------
70
71    /** The number formatter is always used for displaying the value
72        as value.  So this setting is deprecated.
73
74        @deprecated
75     */
76    const long FORMAT = 8;
77
78    //-------------------------------------------------------------------------
79
80    /** The symbol of data column/row is additionally displayed in the caption.
81     */
82    const long SYMBOL = 16;
83};
84
85//=============================================================================
86
87}; }; }; };
88
89#endif
90