offapi/com/sun/star/chart/ChartAxis.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21  module com {  module sun {  module star {  module chart {
  22
  23
  24 /** Specifies the axes in a diagram.
  25
  26     <p>Note: The text properties correlate to all axis description
  27     elements, not to just a single text element.</p>
  28  */
  29 published service ChartAxis
  30 {
  31     /** set the properties for the entire axis line as well as for the
  32         tick marks.
  33      */
  34     service com::sun::star::drawing::LineProperties;
  35
  36     /** set the properties for all text labels of the axis
  37      */
  38     service com::sun::star::style::CharacterProperties;
  39
  40     /** If a ChartAxis may be stored as XML element, this
  41         service should be supported in order to preserve unparsed XML
  42         attributes.
  43
  44         @since OOo 1.1.2
  45      */
  46     [optional] service com::sun::star::xml::UserDefinedAttributesSupplier;
  47
  48     /** Access to the sub elements of an axis like title and grids.
  49         @since OOo 3.4
  50      */
  51     [optional] interface com::sun::star::chart::XAxis;
  52
  53     interface com::sun::star::beans::XPropertySet;
  54
  55     /** Properties for scaling:
  56     */
  57
  58
  59     /** Contains the maximum value for the axis scale.
  60      */
  61     [optional, property] double Max;
  62
  63
  64     /** Contains the minimum value for the axis scale.
  65      */
  66     [optional, property] double Min;
  67
  68
  69     /** Contains the distance between the main tick marks.
  70      */
  71     [optional, property] double StepMain;
  72
  73
  74     /**
  75     Contains the number of help intervals within a main interval. E.g. a StepHelpCount of 5 divides
  76     the main interval into 5 pieces and thus produces 4 help tick marks.
  77     */
  78     [optional, property] long StepHelpCount;
  79
  80
  81     /** @deprecated
  82     User property StepHelpCount instead
  83     Contains the distance between the help tick marks.
  84     */
  85     [optional, property] double StepHelp;
  86
  87
  88     /** The maximum value of the axis scale is calculated by the chart if
  89         this property is `TRUE`.
  90      */
  91     [optional, property] boolean AutoMax;
  92
  93
  94     /** The minimum value of the axis scale is calculated by the chart if
  95         this property is `TRUE`.
  96      */
  97     [optional, property] boolean AutoMin;
  98
  99
 100     /** The distance between the main tick marks is calculated by the chart
 101         if this property is `TRUE`.
 102      */
 103     [optional, property] boolean AutoStepMain;
 104
 105
 106     /** The number of help intervals within a main interval is calculated by the
 107         chart if this property is `TRUE`.
 108     */
 109     [optional, property] boolean AutoStepHelp;
 110
 111
 112
 113     /** Determines if the axis is scaled logarithmically or
 114         not (linear).
 115      */
 116     [optional, property] boolean Logarithmic;
 117
 118
 119     /** determines which type of axis this is, e.g. a date-axis or a category-axis @see ChartAxisType
 120         @since OOo 3.4
 121      */
 122     [optional, property] long AxisType;
 123
 124
 125     /** if the current axis is a date-axis the intervals are chosen as given with TimeIncrement
 126         @since OOo 3.4
 127      */
 128     [optional, maybevoid, property] TimeIncrement TimeIncrement;
 129
 130
 131     /** Determines if the axis orientation is mathematical or reversed.
 132      */
 133     [optional, property] boolean ReverseDirection;
 134
 135
 136     /** Determines where the axis crosses the other axis.
 137      */
 138     [optional, property] com::sun::star::chart::ChartAxisPosition CrossoverPosition;
 139
 140
 141     /** Determines the scale value on the other axis when CrossoverPosition is set to VALUE.
 142      */
 143     [optional, property] double CrossoverValue;
 144
 145
 146     /** Indicates the reference value where bars or areas have their grounding.
 147         This property has only an effect when the used ODF file format does not allow for
 148         further axis positioning or the axis is a secondary y-axis.
 149      */
 150     [optional, property] double Origin;
 151
 152
 153     /** The origin is calculated by the chart if this property is `TRUE`.
 154      */
 155     [optional, property] boolean AutoOrigin;
 156
 157     /** Properties for interval marks:
 158     */
 159
 160
 161     /** Determines the type of the marks.@see ChartAxisMarks
 162      */
 163     [property] long Marks;
 164
 165
 166     /** Determines the type of the help marks.@see ChartAxisMarks
 167      */
 168     [property] long HelpMarks;
 169
 170     /** Determines where the interval marks are placed.
 171      */
 172     [optional, property] com::sun::star::chart::ChartAxisMarkPosition MarkPosition;
 173
 174     /** Properties for axes labels:
 175     */
 176
 177
 178     /** Determines whether to display text at the axis or not.
 179      */
 180     [property] boolean DisplayLabels;
 181
 182
 183     /** Contains the type id for the number formatter of the axis.
 184
 185         @see com::sun::star::util::XNumberFormatter
 186      */
 187     [property] long NumberFormat;
 188
 189
 190     /** determines whether to use the number format given by the
 191         container application, e.g.  a spreadsheet document, or from
 192         the own property #NumberFormat.
 193      */
 194     [optional, property] boolean LinkNumberFormatToSource;
 195
 196
 197     /** Determines where the axis labels are placed.
 198      */
 199     [optional, property] com::sun::star::chart::ChartAxisLabelPosition LabelPosition;
 200
 201
 202     /** Determines the rotation of the text elements
 203         (axis description) in 100th degrees.
 204      */
 205     [property] long TextRotation;
 206
 207
 208     /** The axis description may be arranged in a special order for a
 209         better placement.
 210      */
 211     [property] com::sun::star::chart::ChartAxisArrangeOrderType ArrangeOrder;
 212
 213
 214     /** Determines if long text is broken into multiple lines.
 215      */
 216     [property] boolean TextBreak;
 217
 218
 219     /** Determines if certain labels are hidden, if they would otherwise overlap.
 220         In this case, the value of this property must be set to `FALSE`.
 221      */
 222     [property] boolean TextCanOverlap;
 223
 224     /** Properties related to bar charts:
 225     */
 226
 227
 228     /** Determines the overlap of the bars in a bar-type chart.
 229
 230         <p>The value is given in percent of the width of the bars. The
 231         valid range is -100% to +100%. +100% means full overlap, -100%
 232         indicates a distance of one bar between 2 neighboring bars.</p>
 233      */
 234     [property] long Overlap;
 235
 236
 237     /** Specifies the width of the gaps between each set of data points
 238         in a bar chart.
 239
 240         <p>The value is given in percent of the width of a bar; the
 241         valid range is 0 to 600%.</p>
 242      */
 243     [property] long GapWidth;
 244 };
 245
 246
 247 }; }; }; };
 248
 249 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */