xref: /aoo4110/main/offapi/com/sun/star/chart2/Axis.idl (revision b1cdbd2c) 
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_Axis_idl
24#define com_sun_star_chart_Axis_idl
25
26#include <com/sun/star/beans/PropertySet.idl>
27
28#include <com/sun/star/chart/ChartAxisArrangeOrderType.idl>
29#include <com/sun/star/chart/ChartAxisPosition.idl>
30#include <com/sun/star/chart/ChartAxisLabelPosition.idl>
31#include <com/sun/star/chart/ChartAxisMarkPosition.idl>
32
33#include <com/sun/star/chart2/XAxis.idl>
34#include <com/sun/star/chart2/XTitled.idl>
35
36#include <com/sun/star/drawing/LineProperties.idl>
37#include <com/sun/star/style/CharacterProperties.idl>
38#include <com/sun/star/style/CharacterPropertiesAsian.idl>
39#include <com/sun/star/style/CharacterPropertiesComplex.idl>
40
41module com
42{
43module sun
44{
45module star
46{
47module chart2
48{
49
50service Axis
51{
52    service ::com::sun::star::drawing::LineProperties;
53
54    service ::com::sun::star::style::CharacterProperties;
55    service ::com::sun::star::beans::PropertySet;
56    [optional] service ::com::sun::star::style::CharacterPropertiesAsian;
57    [optional] service ::com::sun::star::style::CharacterPropertiesComplex;
58
59    interface ::com::sun::star::chart2::XAxis;
60    [optional] interface ::com::sun::star::chart2::XTitled;
61
62    /** Determines, whether the axis should be rendered by the view.
63     */
64    [property]      boolean   Show;
65
66    /** Determines where the axis crosses the other axis.
67	 */
68	[optional, property] com::sun::star::chart::ChartAxisPosition CrossoverPosition;
69
70    /** Determines the scale value on the other axis when CrossoverPosition is set to VALUE.
71	 */
72	[optional, property] double CrossoverValue;
73
74    /** Determines whether to display text at the axis or not.
75	 */
76    [property]      boolean   DisplayLabels;
77
78    /** Determines where the axis labels are placed.
79	 */
80	[optional, property] com::sun::star::chart::ChartAxisLabelPosition LabelPosition;
81
82    /** Determines how to stagger the labels at the axis (side by side, even, odd, auto )
83    */
84    [property]      ::com::sun::star::chart::ChartAxisArrangeOrderType ArrangeOrder;
85
86    /** Determines wether the labels are allowed to break into more than one line
87    */
88    [property]      boolean   TextBreak;
89
90    /** Determines wether the labels are allowed to overlap
91    */
92    [property]      boolean   TextOverlap;
93
94    /** Determines wether the characters in a single labels should be stacked one upon each other
95    */
96    [property]      boolean   StackCharacters;
97
98	/** Determines the rotation of the text labels in degrees
99	 */
100    [property]      double    TextRotation;
101
102    /** A NumberFormat key.
103
104        <p>If this property is not set, it is treated as auto.  This
105        means linked to the source format.</p>
106
107        <p>To determine a source format, the axis can query the
108        <type>XDataSequence</type>s used by the data series attached
109        to it (see <member>XDataSequence::getNumberFormatKeyByIndex</member>).
110        </p>
111     */
112    [property, maybevoid]      long      NumberFormat;
113
114    [property]      ::com::sun::star::awt::Size  ReferencePageSize;
115
116    /** determines what kind of tickmarks should be shown for major ticks.
117
118         @see <type>TickmarkStyle</type>.
119    */
120    [property]      long      MajorTickmarks;
121
122    /** determines what kind of tickmarks should be shown for minor ticks.
123
124        @see <type>TickmarkStyle</type>.
125     */
126    [property]      long      MinorTickmarks;
127
128    /** Determines where the interval marks are placed.
129	 */
130	[optional, property] com::sun::star::chart::ChartAxisMarkPosition MarkPosition;
131};
132
133} ; // chart2
134} ; // com
135} ; // sun
136} ; // star
137
138#endif
139