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