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_chart2_data_DataSequenceRole_idl
24#define com_sun_star_chart2_data_DataSequenceRole_idl
25
26module com
27{
28module sun
29{
30module star
31{
32module chart2
33{
34module data
35{
36
37/** a string that states in what way a <type>DataSequence</type>
38    should be used.  If this property is an empty string, no
39    proposition about usage is made.
40
41    <p>The strings can have any value.  However some values are
42    predefined and should always be interpreted in the same way.</p>
43
44    <dl>
45     <dt>label</dt>
46       <dd>values are used as a label for a series.  Usually, you
47           will have just one cell containing a string.</dd>
48     <dt>values-x</dt>
49       <dd>values are used as x-values in an XY- or bubble
50           diagram</dd>
51     <dt>values-y</dt>
52       <dd>values are used as y-values in an XY-Diagram or as values
53           in a bar, line, etc. chart</dd>
54     <dt>values-z</dt>
55       <dd>values may be used as z-values in a three-dimensional
56           XYZ-Diagram or a surface-chart</dd>
57     <dt>sizes</dt>
58       <dd>values are used as radius of the bubbles in a
59           Bubble-Diagram</dd>
60     <dt>error-bars-x-positive</dt>
61       <dd>values are used as error-information in positive x-direction for
62           displaying error-bars</dd>
63     <dt>error-bars-x-negative</dt>
64       <dd>values are used as error-information in negative x-direction for
65           displaying error-bars</dd>
66     <dt>error-bars-y-positive</dt>
67       <dd>values are used as error-information in positive y-direction for
68           displaying error-bars</dd>
69     <dt>error-bars-y-negative</dt>
70       <dd>values are used as error-information in negative y-direction for
71           displaying error-bars</dd>
72     <dt>categories</dt>
73       <dd>values are used for categories in the diagram</dd>
74    </dl>
75
76    <p>In a candle-stick chart you have the following roles:</p>
77
78    <dl>
79     <dt>values-first</dt>
80      <dd>the first value of a series of values.  In a stock-chart this
81          would be the opening course.</dd>
82     <dt>values-last</dt>
83      <dd>the last value of a series of values.  In a stock-chart this
84          would be the closing course.</dd>
85     <dt>values-min</dt>
86      <dd>the minimum value of a series of values.  In a stock-chart
87          this would be the lowest course that occurred during
88          trading.</dd>
89     <dt>values-max</dt>
90      <dd>the maximum value of a series of values.  In a stock-chart
91          this would be the highest course that occurred during
92          trading.</dd>
93    </dl>
94 */
95typedef string DataSequenceRole;
96
97} ; // data
98} ; // chart2
99} ; // com
100} ; // sun
101} ; // star
102
103
104#endif
105