offapi/com/sun/star/chart2/Axis.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: Axis.idl,v $
  10  * $Revision: 1.3.94.1 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef com_sun_star_chart_Axis_idl
  31 #define com_sun_star_chart_Axis_idl
  32
  33 #include <com/sun/star/beans/PropertySet.idl>
  34
  35 #include <com/sun/star/chart/ChartAxisArrangeOrderType.idl>
  36 #include <com/sun/star/chart/ChartAxisPosition.idl>
  37 #include <com/sun/star/chart/ChartAxisLabelPosition.idl>
  38 #include <com/sun/star/chart/ChartAxisMarkPosition.idl>
  39
  40 #include <com/sun/star/chart2/XAxis.idl>
  41 #include <com/sun/star/chart2/XTitled.idl>
  42
  43 #include <com/sun/star/drawing/LineProperties.idl>
  44 #include <com/sun/star/style/CharacterProperties.idl>
  45 #include <com/sun/star/style/CharacterPropertiesAsian.idl>
  46 #include <com/sun/star/style/CharacterPropertiesComplex.idl>
  47
  48 module com
  49 {
  50 module sun
  51 {
  52 module star
  53 {
  54 module chart2
  55 {
  56
  57 service Axis
  58 {
  59     service ::com::sun::star::drawing::LineProperties;
  60
  61     service ::com::sun::star::style::CharacterProperties;
  62     service ::com::sun::star::beans::PropertySet;
  63     [optional] service ::com::sun::star::style::CharacterPropertiesAsian;
  64     [optional] service ::com::sun::star::style::CharacterPropertiesComplex;
  65
  66     interface ::com::sun::star::chart2::XAxis;
  67     [optional] interface ::com::sun::star::chart2::XTitled;
  68
  69     /** Determines, whether the axis should be rendered by the view.
  70      */
  71     [property]      boolean   Show;
  72
  73     /** Determines where the axis crosses the other axis.
  74      */
  75     [optional, property] com::sun::star::chart::ChartAxisPosition CrossoverPosition;
  76
  77     /** Determines the scale value on the other axis when CrossoverPosition is set to VALUE.
  78      */
  79     [optional, property] double CrossoverValue;
  80
  81     /** Determines whether to display text at the axis or not.
  82      */
  83     [property]      boolean   DisplayLabels;
  84
  85     /** Determines where the axis labels are placed.
  86      */
  87     [optional, property] com::sun::star::chart::ChartAxisLabelPosition LabelPosition;
  88
  89     /** Determines how to stagger the labels at the axis (side by side, even, odd, auto )
  90     */
  91     [property]      ::com::sun::star::chart::ChartAxisArrangeOrderType ArrangeOrder;
  92
  93     /** Determines wether the labels are allowed to break into more than one line
  94     */
  95     [property]      boolean   TextBreak;
  96
  97     /** Determines wether the labels are allowed to overlap
  98     */
  99     [property]      boolean   TextOverlap;
 100
 101     /** Determines wether the characters in a single labels should be stacked one upon each other
 102     */
 103     [property]      boolean   StackCharacters;
 104
 105     /** Determines the rotation of the text labels in degrees
 106      */
 107     [property]      double    TextRotation;
 108
 109     /** A NumberFormat key.
 110
 111         <p>If this property is not set, it is treated as auto.  This
 112         means linked to the source format.</p>
 113
 114         <p>To determine a source format, the axis can query the
 115         <type>XDataSequence</type>s used by the data series attached
 116         to it (see <member>XDataSequence::getNumberFormatKeyByIndex</member>).
 117         </p>
 118      */
 119     [property, maybevoid]      long      NumberFormat;
 120
 121     [property]      ::com::sun::star::awt::Size  ReferencePageSize;
 122
 123     /** determines what kind of tickmarks should be shown for major ticks.
 124
 125          @see <type>TickmarkStyle</type>.
 126     */
 127     [property]      long      MajorTickmarks;
 128
 129     /** determines what kind of tickmarks should be shown for minor ticks.
 130
 131         @see <type>TickmarkStyle</type>.
 132      */
 133     [property]      long      MinorTickmarks;
 134
 135     /** Determines where the interval marks are placed.
 136      */
 137     [optional, property] com::sun::star::chart::ChartAxisMarkPosition MarkPosition;
 138 };
 139
 140 } ; // chart2
 141 } ; // com
 142 } ; // sun
 143 } ; // star
 144
 145 #endif