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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 #ifndef com_sun_star_chart2_ScaleData_idl
   3 #define com_sun_star_chart2_ScaleData_idl
   4
   5 #include <com/sun/star/chart2/XScaling.idl>
   6 #include <com/sun/star/chart2/AxisOrientation.idl>
   7 #include <com/sun/star/chart2/data/XLabeledDataSequence.idl>
   8 #include <com/sun/star/chart2/AxisType.idl>
   9 #include <com/sun/star/chart2/IncrementData.idl>
  10 #include <com/sun/star/chart/TimeIncrement.idl>
  11
  12 //=============================================================================
  13
  14 module com {  module sun {  module star {  module chart2 {
  15
  16 //=============================================================================
  17
  18 struct ScaleData
  19 {
  20     /** if the any contains a double value this is used as a fixed
  21         maximum.  Otherwise, if the any is empty or contains an
  22         incompatible type, the maximum is automatic.
  23
  24         <p>If the maximum is automatic, this means, each view that
  25         represents the model containing this scale, has to calculate a
  26         maximum by its own means.</p>
  27      */
  28     any Minimum;
  29
  30     /** if the any contains a double value this is used as a fixed
  31         minimum.  Otherwise, if the any is empty or contains an
  32         incompatible type, the minimum is automatic.
  33
  34         <p>If the minimum is automatic, this means, each view that
  35         represents the model containing this scale, has to calculate a
  36         minimum by its own means.</p>
  37      */
  38     any Maximum;
  39
  40
  41     /** The Origin indicates where other axes cross this axis.
  42         If the any contains a double value that value is used.
  43         Otherwise an appropriate value has to be calculated
  44         by that instances using Origin.
  45      */
  46     any Origin;
  47
  48     /** Axis orientation (standard or reversed).
  49
  50         <p>If used at the Y axis in pie charts or doughnut charts, specifies
  51         the rotation direction of the pie. The value
  52         <const>AxisOrientation::MATHEMATICAL</const> rotates the pie
  53         counterclockwise, the value <const>AxisOrientation::REVERSE</const>
  54         rotates the pie clockwise.</p>
  55
  56         <p>Note: Is this a good place for the axis orientation? Two axes may
  57         use the same scale, but point into two different directions.</p>
  58      */
  59     AxisOrientation     Orientation;
  60
  61     XScaling            Scaling;
  62
  63     com::sun::star::chart2::data::XLabeledDataSequence Categories;
  64
  65     /** describes the type of the axis.
  66
  67         <p>It can be a real number axis or a category axis or something else.
  68         AxisType is one value out of the constant group <type>AxisType</type>.</p>
  69     */
  70     long   AxisType;
  71
  72     /** if true an AxisType CATEGORY is interpreted as DATE if the underlying data given in Categories are dates
  73     */
  74     boolean AutoDateAxis;
  75
  76     /** describes whether data points on category or date axis are placed between tickmarks or not
  77     if true the maximum on the scale will be expanded for one interval
  78     */
  79     boolean ShiftedCategoryPosition;
  80
  81     /** increment data to be used for not date-time axis
  82     */
  83     IncrementData IncrementData;
  84
  85     /** increment data to be used in case of date-time axis
  86     */
  87     ::com::sun::star::chart::TimeIncrement TimeIncrement;
  88 };
  89
  90 //=============================================================================
  91
  92 }; }; }; };
  93
  94 #endif
  95
  96 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */