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