offapi/com/sun/star/chart/ChartAxis.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: ChartAxis.idl,v $
  10  * $Revision: 1.21 $
  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_ChartAxis_idl__
  31 #define __com_sun_star_chart_ChartAxis_idl__
  32
  33 #ifndef __com_sun_star_drawing_LineProperties_idl__
  34 #include <com/sun/star/drawing/LineProperties.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_style_CharacterProperties_idl__
  38 #include <com/sun/star/style/CharacterProperties.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_beans_XPropertySet_idl__
  42 #include <com/sun/star/beans/XPropertySet.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_chart_ChartAxisArrangeOrderType_idl__
  46 #include <com/sun/star/chart/ChartAxisArrangeOrderType.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_chart_ChartAxisPosition_idl__
  50 #include <com/sun/star/chart/ChartAxisPosition.idl>
  51 #endif
  52
  53 #ifndef __com_sun_star_chart_ChartAxisLabelPosition_idl__
  54 #include <com/sun/star/chart/ChartAxisLabelPosition.idl>
  55 #endif
  56
  57 #ifndef __com_sun_star_chart_ChartAxisMarkPosition_idl__
  58 #include <com/sun/star/chart/ChartAxisMarkPosition.idl>
  59 #endif
  60
  61 #ifndef _com_sun_star_xml_UserDefinedAttributeSupplier_idl_
  62 #include <com/sun/star/xml/UserDefinedAttributeSupplier.idl>
  63 #endif
  64
  65 //=============================================================================
  66
  67  module com {  module sun {  module star {  module chart {
  68
  69 //=============================================================================
  70
  71 /** Specifies the axes in a diagram.
  72
  73     <p>Note: The text properties correlate to all axis description
  74     elements, not to just a single text element.</p>
  75  */
  76 published service ChartAxis
  77 {
  78
  79
  80     /** set the properties for the entire axis line as well as for the
  81         tick marks.
  82      */
  83     service com::sun::star::drawing::LineProperties;
  84
  85     /** set the properties for all text labels of the axis
  86      */
  87     service com::sun::star::style::CharacterProperties;
  88
  89         /** If a <type>ChartAxis</type> may be stored as XML element, this
  90             service should be supported in order to preserve unparsed XML
  91             attributes.
  92
  93         @since OOo 1.1.2
  94      */
  95     [optional] service com::sun::star::xml::UserDefinedAttributeSupplier;
  96
  97     interface com::sun::star::beans::XPropertySet;
  98
  99     //-------------------------------------------------------------------------
 100     /** Properties for scaling:
 101     */
 102
 103     //-------------------------------------------------------------------------
 104
 105     /** Contains the maximum value for the axis scale.
 106      */
 107     [optional, property] double Max;
 108
 109     //-------------------------------------------------------------------------
 110
 111     /** Contains the minimum value for the axis scale.
 112      */
 113     [optional, property] double Min;
 114
 115     //-------------------------------------------------------------------------
 116
 117     /** Contains the distance between the main tick marks.
 118      */
 119     [optional, property] double StepMain;
 120
 121     //-------------------------------------------------------------------------
 122
 123     /**
 124     Contains the number of help intervals within a main interval. E.g. a StepHelpCount of 5 divides
 125     the main interval into 5 pieces and thus producces 4 help tick marks.
 126     */
 127     [optional, property] long StepHelpCount;
 128
 129     //-------------------------------------------------------------------------
 130
 131     /** @deprecated
 132     User property StepHelpCount instead
 133     Contains the distance between the help tick marks.
 134     */
 135     [optional, property] double StepHelp;
 136
 137     //-------------------------------------------------------------------------
 138
 139     /** The maximium value of the axis scale is calculated by the chart if
 140         this property is <TRUE/>.
 141      */
 142     [optional, property] boolean AutoMax;
 143
 144     //-------------------------------------------------------------------------
 145
 146     /** The minimum value of the axis scale is calculated by the chart if
 147         this property is <TRUE/>.
 148      */
 149     [optional, property] boolean AutoMin;
 150
 151     //-------------------------------------------------------------------------
 152
 153     /** The distance between the main tick marks is calculated by the chart
 154         if this property is <TRUE/>.
 155      */
 156     [optional, property] boolean AutoStepMain;
 157
 158     //-------------------------------------------------------------------------
 159
 160     /** The number of help intervals within a main interval is calculated by the
 161         chart if this property is <TRUE/>.
 162     */
 163     [optional, property] boolean AutoStepHelp;
 164
 165
 166     //-------------------------------------------------------------------------
 167
 168     /** Determines if the axis is scaled logarithmically or
 169         not (linear).
 170      */
 171     [optional, property] boolean Logarithmic;
 172
 173     //-------------------------------------------------------------------------
 174
 175     /** Determines if the axis orientation is mathematical or reversed.
 176      */
 177     [optional, property] boolean ReverseDirection;
 178
 179     //-------------------------------------------------------------------------
 180
 181     /** Determines where the axis crosses the other axis.
 182      */
 183     [optional, property] com::sun::star::chart::ChartAxisPosition CrossoverPosition;
 184
 185     //-------------------------------------------------------------------------
 186
 187     /** Determines the scale value on the other axis when CrossoverPosition is set to VALUE.
 188      */
 189     [optional, property] double CrossoverValue;
 190
 191     //-------------------------------------------------------------------------
 192
 193     /** Indicates the reference value where bars or areas have their grounding.
 194         This property has only an effect when the used odf fileformat does not allow for
 195         further axis posiioning or the axis is a secondary y-axis.
 196      */
 197     [optional, property] double Origin;
 198
 199     //-------------------------------------------------------------------------
 200
 201     /** The origin is calculated by the chart if this property is <TRUE/>.
 202      */
 203     [optional, property] boolean AutoOrigin;
 204
 205     //-------------------------------------------------------------------------
 206     /** Properties for interval marks:
 207     */
 208
 209     //-------------------------------------------------------------------------
 210
 211     /** Determines the type of the marks.@see ChartAxisMarks
 212      */
 213     [property] long Marks;
 214
 215     //-------------------------------------------------------------------------
 216
 217     /** Determines the type of the help marks.@see ChartAxisMarks
 218      */
 219     [property] long HelpMarks;
 220     //-------------------------------------------------------------------------
 221
 222     /** Determines where the interval marks are placed.
 223      */
 224     [optional, property] com::sun::star::chart::ChartAxisMarkPosition MarkPosition;
 225
 226     //-------------------------------------------------------------------------
 227     /** Properties for axes labels:
 228     */
 229
 230     //-------------------------------------------------------------------------
 231
 232     /** Determines whether to display text at the axis or not.
 233      */
 234     [property] boolean DisplayLabels;
 235
 236     //-------------------------------------------------------------------------
 237
 238     /** Contains the type id for the number formatter of the axis.
 239
 240         @see com::sun::star::util::XNumberFormatter
 241      */
 242     [property] long NumberFormat;
 243
 244     //-------------------------------------------------------------------------
 245
 246     /** determines whether to use the number format given by the
 247         container application, e.g.  a spreadsheet document, or from
 248         the own property <member>NumberFormat</member>.
 249      */
 250     [optional, property] boolean LinkNumberFormatToSource;
 251
 252     //-------------------------------------------------------------------------
 253
 254     /** Determines where the axis labels are placed.
 255      */
 256     [optional, property] com::sun::star::chart::ChartAxisLabelPosition LabelPosition;
 257
 258     //-------------------------------------------------------------------------
 259
 260     /** Determines the rotation of the text elements
 261         (axis description) in 100th degrees.
 262      */
 263     [property] long TextRotation;
 264
 265     //-------------------------------------------------------------------------
 266
 267     /** The axis description may be arranged in a special order for a
 268         better placement.
 269      */
 270     [property] com::sun::star::chart::ChartAxisArrangeOrderType ArrangeOrder;
 271
 272     //-------------------------------------------------------------------------
 273
 274     /** Determines if long text is broken into multiple lines.
 275      */
 276     [property] boolean TextBreak;
 277
 278     //-------------------------------------------------------------------------
 279
 280     /** Determines if certain labels are hidden, if they would otherwise overlap.
 281         In this case, the value of this property must be set to <FALSE/>.
 282      */
 283     [property] boolean TextCanOverlap;
 284
 285     //-------------------------------------------------------------------------
 286     /** Properties related to bar charts:
 287     */
 288
 289     //-------------------------------------------------------------------------
 290
 291     /** Determines the overlap of the bars in a bar-type chart.
 292
 293         <p>The value is given in percent of the width of the bars. The
 294         valid range is -100% to +100%. +100% means full overlap, -100%
 295         indicates a distance of one bar between 2 neighboring bars.</p>
 296      */
 297     [property] long Overlap;
 298
 299     //-------------------------------------------------------------------------
 300
 301     /** Specifies the width of the gaps between each set of data points
 302         in a bar chart.
 303
 304         <p>The value is given in percent of the width of a bar; the
 305         valid range is 0 to 600%.</p>
 306      */
 307     [property] long GapWidth;
 308 };
 309
 310 //=============================================================================
 311
 312 }; }; }; };
 313
 314 #endif