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