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