offapi/com/sun/star/chart2/DataPointProperties.idl

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