offapi/com/sun/star/chart2/DataPointProperties.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 DataPointProperties
  30 {
  31     /** to give access to the properties required by this service.
  32     */
  33     service ::com::sun::star::beans::PropertySet;
  34
  35     /** to give access to the fill properties
  36
  37         Note that there is access for some of them
  38         through some alias.
  39
  40         @since LibreOffice 5.1
  41     */
  42     service ::com::sun::star::drawing::FillProperties;
  43
  44
  45     /** points to a style that also supports this service (but not
  46         this property) that is used as default, if the PropertyState
  47         of a property is <code>DEFAULT_VALUE</code>.
  48      */
  49 //     [optional, property] ::com::sun::star::style::XStyle        Style;
  50
  51     // Common Properties
  52
  53
  54     /** This is the main color of a data point.
  55
  56         <p>For charts with filled areas, like bar-charts, this should
  57         map to the <code>FillColor</code> of the objects.  For
  58         line-charts this should map to the <code>LineColor</code>
  59         property.</p>
  60
  61         @see com::sun::star::drawing::FillProperties
  62         @see com::sun::star::drawing::LineProperties
  63      */
  64     [property] long                                   Color;
  65
  66     /** This is the main transparency value of a data point.
  67
  68         <p>For charts with filled areas, like bar-charts, this should
  69         map to the <code>FillTransparence</code> of the objects.  For
  70         line-charts this should map to the
  71         <code>LineTransparence</code> property.</p>
  72
  73         @see com::sun::star::drawing::FillProperties
  74         @see com::sun::star::drawing::LineProperties
  75      */
  76     [property] short                                  Transparency;
  77
  78
  79     // Fill Properties
  80
  81     /** This enumeration selects the style with which the area will be filled.
  82     */
  83     [property] ::com::sun::star::drawing::FillStyle   FillStyle;
  84
  85     /** This describes the transparency of the fill area as a gradient.
  86     */
  87     [optional, property] ::com::sun::star::awt::Gradient        TransparencyGradient;
  88     [optional, property] ::com::sun::star::awt::Gradient        Gradient;
  89     [optional, property] ::com::sun::star::drawing::Hatch       Hatch;
  90
  91     [property] string TransparencyGradientName;
  92     [property] string GradientName;
  93     [property] string HatchName;
  94     [property] string FillBitmapName;
  95
  96     /** If `TRUE`, fills the background of a hatch with the color
  97         given in the #Color property.
  98      */
  99     [property] boolean FillBackground;
 100
 101     /** Is used for borders around filled objects.  See
 102         <code>LineColor</code>.
 103
 104         @see com::sun::star::drawing::LineProperties
 105      */
 106     [property] long                                   BorderColor;
 107     /** Is used for borders around filled objects.  See
 108         <code>LineStyle</code>.
 109
 110         @see com::sun::star::drawing::LineProperties
 111      */
 112     [property] ::com::sun::star::drawing::LineStyle   BorderStyle;
 113     /** Is used for borders around filled objects.  See
 114         <code>LineWidth</code>.
 115
 116         @see com::sun::star::drawing::LineProperties
 117      */
 118     [property] long                                   BorderWidth;
 119     /** Is used for borders around filled objects.  See
 120         <code>LineDash</code>.
 121
 122         @see com::sun::star::drawing::LineProperties
 123      */
 124     [property] ::com::sun::star::drawing::LineDash    BorderDash;
 125
 126     /** The name of a dash that can be found in the
 127         com::sun::star::container::XNameContainer
 128         "com.sun.star.drawing.LineDashTable", that can be created via
 129         the
 130         com::sun::star::uno::XMultiServiceFactory
 131         of the ChartDocument.
 132      */
 133     [optional, property] string                       BorderDashName;
 134
 135     /** Is used for borders around filled objects.  See
 136         <code>LineTransparence</code>.
 137
 138         @see com::sun::star::drawing::LineProperties
 139      */
 140     [optional, property] short                        BorderTransparency;
 141
 142
 143     // Line Properties
 144     [property] ::com::sun::star::drawing::LineStyle   LineStyle;
 145     /** Is only used for line-chart types.
 146
 147         @see com::sun::star::drawing::LineProperties
 148      */
 149     [property] long                                   LineWidth;
 150     /** Is only used for line-chart types.
 151
 152         @see com::sun::star::drawing::LineProperties
 153      */
 154     [property] ::com::sun::star::drawing::LineDash    LineDash;
 155
 156     /** The name of a dash that can be found in the
 157         com::sun::star::container::XNameContainer
 158         "com.sun.star.drawing.LineDashTable", that can be created via
 159         the
 160         com::sun::star::uno::XMultiServiceFactory
 161         of the ChartDocument.
 162      */
 163     [optional, property] string                       LineDashName;
 164
 165
 166     // bitmap properties /copied from drawing::FillProperties
 167
 168     /** This is the horizontal offset where the tile starts.
 169
 170         <p>It is given in percent in relation to the width of the bitmap.
 171     */
 172     [property] short FillBitmapOffsetX;
 173
 174     /** This is the vertical offset where the tile starts.
 175
 176         It is given in percent in relation to the width of the bitmap.
 177     */
 178     [property] short FillBitmapOffsetY;
 179
 180     /** Every second line of tiles is moved the given percent of the
 181         width of the bitmap.
 182     */
 183     [property] short FillBitmapPositionOffsetX;
 184
 185     /** Every second row of tiles is moved the given percent of the
 186         width of the bitmap.
 187     */
 188     [property] short FillBitmapPositionOffsetY;
 189
 190     /** The RectanglePoint specifies the position inside of the bitmap to
 191         use as the top left position for rendering.
 192     */
 193     [property] com::sun::star::drawing::RectanglePoint FillBitmapRectanglePoint;
 194
 195     /** specifies if the size is given in percentage or
 196         as an absolute value.
 197
 198         <p>If this is `TRUE`, the properties FillBitmapSizeX
 199         and  FillBitmapSizeY contain the size of the tile in percent
 200         of the size of the original bitmap. If this
 201         is `FALSE`, the size of the tile is specified
 202         with 1/100th mm.
 203     */
 204     [property] boolean FillBitmapLogicalSize;
 205
 206     /** This is the width of the tile for filling.
 207
 208         <p>Depending on the property FillBitmapLogicalSize, this is
 209         either relative or absolute.
 210     */
 211     [property] long FillBitmapSizeX;
 212
 213     /** This is the height of the tile for filling.
 214
 215         <p>Depending on the property FillBitmapLogicalSize, this
 216         is either relative or absolute.
 217     */
 218     [property] long FillBitmapSizeY;
 219
 220     /** this enum selects how an area is filled with a single bitmap.
 221     */
 222     [property] com::sun::star::drawing::BitmapMode FillBitmapMode;
 223
 224
 225     /**
 226      */
 227     [optional, property] Symbol                       Symbol;
 228
 229     /** describes a value by which a data point is moved from its
 230         default position in percent of the maximum allowed distance.
 231
 232         <p>This is especially useful for the explosion of pie-chart
 233         segments.</p>
 234      */
 235     [optional, property] double                       Offset;
 236
 237     /** describes the geometry of a 3 dimensional data point.
 238         Number is one of constant group DataPointGeometry3D.
 239         <p>This is especially used for 3D bar-charts.</p>
 240         <p>CUBOID==0 CYLINDER==1 CONE==2 PYRAMID==3 CUBOID==else</p>
 241     */
 242     [optional, property] long                         Geometry3D;
 243
 244     [property] DataPointLabel                         Label;
 245
 246     /** specifies a text with possible fields that is used as a data point label,
 247         if set then Label property is ignored
 248
 249         @since LibreOffice 6.1
 250     */
 251     [optional, property] sequence<XDataPointCustomLabelField>  CustomLabelFields;
 252
 253     /** specifies a string that is used to separate the parts of a data label (caption)
 254      */
 255     [optional, property] string LabelSeparator;
 256
 257     /** specifies if the text of a data label (caption) must be wrapped
 258
 259         @since LibreOffice 5.1
 260      */
 261     [optional, property] boolean TextWordWrap;
 262
 263     /** specifies a number format for the display of the value in the data label
 264      */
 265     [optional, property] long NumberFormat;
 266
 267     /** specifies a number format for the display of the percentage value in the data label
 268      */
 269     [optional, property] long PercentageNumberFormat;
 270
 271     /** specifies a relative position for the data label
 272
 273         @see ::com::sun::star::chart::DataLabelPlacement
 274      */
 275     [optional, property] long LabelPlacement;
 276
 277     /** The size of the page at the moment when the font size for
 278         data labels was set.
 279
 280         <p>This size is used to resize text in the view when the size
 281         of the page has changed since the font sizes were set
 282         (automatic text scaling).</p>
 283      */
 284     [maybevoid, property] com::sun::star::awt::Size   ReferencePageSize;
 285
 286     // statistics
 287
 288     /** If void, no error bars are shown for the data point in
 289         x-direction.
 290
 291         <p>The com::sun::star::beans::XPropertySet
 292         must support the service ErrorBar.</p>
 293      */
 294     [optional, maybevoid, property] com::sun::star::beans::XPropertySet      ErrorBarX;
 295
 296     /** If void, no error bars are shown for the data point in
 297         y-direction.
 298
 299         <p>The com::sun::star::beans::XPropertySet
 300         must support the service ErrorBar.</p>
 301      */
 302     [optional, maybevoid, property] com::sun::star::beans::XPropertySet      ErrorBarY;
 303
 304     /** In case #ErrorBarX and
 305         #ErrorBarY both are set, and error bars are
 306         shown, a box spanning all error-indicators is rendered.
 307      */
 308     [optional, maybevoid, property] boolean           ShowErrorBox;
 309
 310
 311     /** A value between 0 and 100 indicating the percentage how round an edge should be.
 312     */
 313     [optional, maybevoid, property] short             PercentDiagonal;
 314
 315     /** Custom position on the page associated to the CUSTOM label placement.
 316
 317         @since LibreOffice 7.0
 318     */
 319     [optional, maybevoid, property] ::com::sun::star::chart2::RelativePosition CustomLabelPosition;
 320
 321     /** Custom size associated with the CUSTOM label placement.
 322
 323         @since LibreOffice 24.8
 324     */
 325     [optional, maybevoid, property] ::com::sun::star::chart2::RelativeSize CustomLabelSize;
 326 };
 327
 328 } ; // chart2
 329 } ; // com
 330 } ; // sun
 331 } ; // star
 332
 333
 334 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */