offapi/com/sun/star/chart2/Axis.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 #ifndef com_sun_star_chart2_Axis_idl
  20 #define com_sun_star_chart2_Axis_idl
  21
  22 #include <com/sun/star/beans/PropertySet.idl>
  23 #include <com/sun/star/awt/Size.idl>
  24 #include <com/sun/star/chart/ChartAxisArrangeOrderType.idl>
  25 #include <com/sun/star/chart/ChartAxisPosition.idl>
  26 #include <com/sun/star/chart/ChartAxisLabelPosition.idl>
  27 #include <com/sun/star/chart/ChartAxisMarkPosition.idl>
  28 #include <com/sun/star/chart2/XAxis.idl>
  29 #include <com/sun/star/chart2/XTitled.idl>
  30 #include <com/sun/star/drawing/LineProperties.idl>
  31 #include <com/sun/star/style/CharacterProperties.idl>
  32 #include <com/sun/star/style/CharacterPropertiesAsian.idl>
  33 #include <com/sun/star/style/CharacterPropertiesComplex.idl>
  34
  35 module com
  36 {
  37 module sun
  38 {
  39 module star
  40 {
  41 module chart2
  42 {
  43
  44 service Axis
  45 {
  46     service ::com::sun::star::drawing::LineProperties;
  47
  48     service ::com::sun::star::style::CharacterProperties;
  49     service ::com::sun::star::beans::PropertySet;
  50     [optional] service ::com::sun::star::style::CharacterPropertiesAsian;
  51     [optional] service ::com::sun::star::style::CharacterPropertiesComplex;
  52
  53     interface ::com::sun::star::chart2::XAxis;
  54     [optional] interface ::com::sun::star::chart2::XTitled;
  55
  56     /** Determines, whether the axis should be rendered by the view.
  57      */
  58     [property]      boolean   Show;
  59
  60     /** Determines where the axis crosses the other axis.
  61      */
  62     [optional, property] com::sun::star::chart::ChartAxisPosition CrossoverPosition;
  63
  64     /** Determines the scale value on the other axis when CrossoverPosition is set to VALUE.
  65      */
  66     [optional, property] double CrossoverValue;
  67
  68     /** Determines whether to display text at the axis or not.
  69      */
  70     [property]      boolean   DisplayLabels;
  71
  72     /** Determines where the axis labels are placed.
  73      */
  74     [optional, property] com::sun::star::chart::ChartAxisLabelPosition LabelPosition;
  75
  76     /** Determines how to stagger the labels at the axis (side by side, even, odd, auto )
  77     */
  78     [property]      ::com::sun::star::chart::ChartAxisArrangeOrderType ArrangeOrder;
  79
  80     /** Determines whether the labels are allowed to break into more than one line
  81     */
  82     [property]      boolean   TextBreak;
  83
  84     /** Determines whether the labels are allowed to overlap
  85     */
  86     [property]      boolean   TextOverlap;
  87
  88     /** Determines whether the characters in a single labels should be stacked one upon each other
  89     */
  90     [property]      boolean   StackCharacters;
  91
  92     /** Determines the rotation of the text labels in degrees
  93      */
  94     [property]      double    TextRotation;
  95
  96     /** A NumberFormat key.
  97
  98         <p>If this property is not set, it is treated as auto.  This
  99         means linked to the source format.</p>
 100
 101         <p>To determine a source format, the axis can query the
 102         XDataSequences used by the data series attached
 103         to it (see XDataSequence::getNumberFormatKeyByIndex()).
 104         </p>
 105      */
 106     [property, maybevoid]      long      NumberFormat;
 107
 108     [property]      ::com::sun::star::awt::Size  ReferencePageSize;
 109
 110     /** determines what kind of tickmarks should be shown for major ticks.
 111
 112          @see TickmarkStyle.
 113     */
 114     [property]      long      MajorTickmarks;
 115
 116     /** determines what kind of tickmarks should be shown for minor ticks.
 117
 118         @see TickmarkStyle.
 119      */
 120     [property]      long      MinorTickmarks;
 121
 122     /** Determines where the interval marks are placed.
 123      */
 124     [optional, property] com::sun::star::chart::ChartAxisMarkPosition MarkPosition;
 125
 126     /** Determines display units are avaiblable for axis
 127
 128         @since LibreOffice 4.3
 129      */
 130     [optional, property] boolean DisplayUnits;
 131
 132     /** Determines built in display unit value for axis
 133
 134         @since LibreOffice 4.3
 135      */
 136     [optional, property] string BuiltInUnit;
 137
 138     /** Compatibility option: determines which strategy should be tried first for fixing axis labels overlapping issues
 139
 140         @since LibreOffice 5.1
 141      */
 142     [optional, property] boolean TryStaggeringFirst;
 143
 144 };
 145
 146 } ; // chart2
 147 } ; // com
 148 } ; // sun
 149 } ; // star
 150
 151 #endif
 152
 153 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */