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