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

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