xref: /trunk/main/offapi/com/sun/star/chart2/ScaleData.idl (revision cdf0e10c)
1#ifndef com_sun_star_chart2_ScaleData_idl
2#define com_sun_star_chart2_ScaleData_idl
3
4#include <com/sun/star/chart2/XScaling.idl>
5#include <com/sun/star/chart2/AxisOrientation.idl>
6#include <com/sun/star/chart2/data/XLabeledDataSequence.idl>
7#include <com/sun/star/chart2/AxisType.idl>
8#include <com/sun/star/chart2/IncrementData.idl>
9#include <com/sun/star/chart/TimeIncrement.idl>
10
11//=============================================================================
12
13module com {  module sun {  module star {  module chart2 {
14
15//=============================================================================
16
17struct ScaleData
18{
19    /** if the any contains a double value this is used as a fixed
20        maximum.  Otherwise, if the any is empty or contains an
21        incompatible type, the maximum is automatic.
22
23        <p>If the maximum is automatic, this means, each view that
24        represents the model containing this scale, has to calculate a
25        maximum by its own means.</p>
26     */
27    any Minimum;
28
29    /** if the any contains a double value this is used as a fixed
30        minimum.  Otherwise, if the any is empty or contains an
31        incompatible type, the minimum is automatic.
32
33        <p>If the minimum is automatic, this means, each view that
34        represents the model containing this scale, has to calculate a
35        minimum by its own means.</p>
36     */
37    any Maximum;
38
39
40    /** The Origin indicates where other axes cross this axis.
41        If the any contains a double value that value is used.
42        Otherwise an appropriate value has to be calculated
43        by that instances using Origin.
44     */
45    any Origin;
46
47    /** Axis orientation (standard or reversed).
48
49        <p>If used at the Y axis in pie charts or doughnut charts, specifies
50        the rotation direction of the pie. The value
51        <const>AxisOrientation::MATHEMATICAL</const> rotates the pie
52        counterclockwise, the value <const>AxisOrientation::REVERSE</const>
53        rotates the pie clockwise.</p>
54
55        <p>Note: Is this a good place for the axis orientation? Two axes may
56        use the same scale, but point into two different directions.</p>
57     */
58    AxisOrientation     Orientation;
59
60    XScaling            Scaling;
61
62    data::XLabeledDataSequence Categories;
63
64    /** describes the type of the axis.
65
66        <p>It can be a real number axis or a category axis or something else.
67        AxisType is one value out of the constant group <type>AxisType</type>.</p>
68    */
69    long   AxisType;
70
71    /** if true an AxisType CATEGORY is interpreted as DATE if the underlying data given in Categories are dates
72    */
73    boolean AutoDateAxis;
74
75    /** describes wether data points on category or date axis are placed between tickmarks or not
76    if true the maximum on the scale will be expanded for one interval
77    */
78    boolean ShiftedCategoryPosition;
79
80    /** increment data to be used for not date-time axis
81    */
82    IncrementData IncrementData;
83
84    /** increment data to be used in case of date-time axis
85    */
86    ::com::sun::star::chart::TimeIncrement TimeIncrement;
87};
88
89//=============================================================================
90
91}; }; }; };
92
93#endif
94