Service DataPointProperties

Devguide

Index

Services' Summary

Interfaces' Summary

Properties' Summary

Services' Details

Interfaces' Details

Properties' Details

:: com :: sun :: star :: chart2 ::

service DataPointProperties

Included Services - Summary
::com::sun::star::beans::PropertySet	to give acces to the properties required by this service.

Properties' Summary
long Color	This is the main color of a data point.
short Transparency	This is the main transparency value of a data point.
::com::sun::star::drawing::FillStyle FillStyle	This enumeration selects the style with which the area will be filled.
::com::sun::star::awt::Gradient TransparencyGradient	[ OPTIONAL ] This describes the transparency of the fill area as a gradient.
::com::sun::star::awt::Gradient Gradient	[ OPTIONAL ]
::com::sun::star::drawing::Hatch Hatch	[ OPTIONAL ]
string TransparencyGradientName
string GradientName
string HatchName
string FillBitmapName
boolean FillBackground	If true, fills the background of a hatch with the color given in the Color property.
long BorderColor	Is used for borders around filled objects. See `LineColor`.
::com::sun::star::drawing::LineStyle BorderStyle	Is used for borders around filled objects. See `LineStyle`.
long BorderWidth	Is used for borders around filled objects. See `LineWidth`.
::com::sun::star::drawing::LineDash BorderDash	Is used for borders around filled objects. See `LineDash`.
string BorderDashName	[ OPTIONAL ] The name of a dash that can be found in the ::com::sun::star::container::XNameContainer "com.sun.star.drawing.LineDashTable", that can be created via the com::sun::star::uno::XMultiServiceFactory of the ChartDocument.
short BorderTransparency	[ OPTIONAL ] Is used for borders around filled objects. See `LineTransparence`.
::com::sun::star::drawing::LineStyle LineStyle
long LineWidth	Is only used for line-chart types.
::com::sun::star::drawing::LineDash LineDash	Is only used for line-chart types.
string LineDashName	[ OPTIONAL ] The name of a dash that can be found in the ::com::sun::star::container::XNameContainer "com.sun.star.drawing.LineDashTable", that can be created via the com::sun::star::uno::XMultiServiceFactory of the ChartDocument.
short FillBitmapOffsetX	This is the horizontal offset where the tile starts.
short FillBitmapOffsetY	This is the vertical offset where the tile starts. It is given in percent in relation to the width of the bitmap.
short FillBitmapPositionOffsetX	Every second line of tiles is moved the given percent of the witdh of the bitmap.
short FillBitmapPositionOffsetY	Every second row of tiles is moved the given percent of the width of the bitmap.
::com::sun::star::drawing::RectanglePoint FillBitmapRectanglePoint	The RectanglePoint specifies the position inside of the bitmap to use as the top left position for rendering.
boolean FillBitmapLogicalSize	specifies if the size is given in percentage or as an absolute value.
long FillBitmapSizeX	This is the width of the tile for filling.
long FillBitmapSizeY	This is the height of the tile for filling.
::com::sun::star::drawing::BitmapMode FillBitmapMode	this enum selects how a area is filled with a single bitmap.
Symbol Symbol	[ OPTIONAL ]
double Offset	[ OPTIONAL ] describes a value by which a data point is moved from its default position in percent of the maximum allowed distance.
long Geometry3D	[ OPTIONAL ] describes the geometry of a 3 dimensional datapoint. Number is one of constant group DataPointGeometry3D.
DataPointLabel Label
string LabelSeparator	[ OPTIONAL ] specifies a string that is used to separate the parts of a data label (caption)
long NumberFormat	[ OPTIONAL ] specifies a number format for the display of the value in the data label
long PercentageNumberFormat	[ OPTIONAL ] specifies a number format for the display of the percentage value in the data label
long LabelPlacement	[ OPTIONAL ] specifies a relative position for the data label
[ maybevoid ] ::com::sun::star::awt::Size ReferencePageSize	The size of the page at the moment when the font size for data labels was set.
[ maybevoid ] ::com::sun::star::beans::XPropertySet ErrorBarX	[ OPTIONAL ] If void, no error bars are shown for the data point in x-direction.
[ maybevoid ] ::com::sun::star::beans::XPropertySet ErrorBarY	[ OPTIONAL ] If void, no error bars are shown for the data point in y-direction.
[ maybevoid ] boolean ShowErrorBox	[ OPTIONAL ] In case ErrorBarX and ErrorBarY both are set, and error bars are shown, a box spanning all error-indicators is rendered.
[ maybevoid ] short PercentDiagonal	[ OPTIONAL ] A value between 0 and 100 indicating the percentage how round an edge should be.

Included Services - Details

::com::sun::star::beans::PropertySet

Description to give acces to the properties required by this service.

Properties' Details

Color

long Color; Description This is the main color of a data point. For charts with filled areas, like bar-charts, this should map to the `FillColor` of the objects. For line-charts this should map to the `LineColor` property. See also ::com::sun::star::drawing::FillProperties, ::com::sun::star::drawing::LineProperties

Transparency

short Transparency; Description This is the main transparency value of a data point. For charts with filled areas, like bar-charts, this should map to the `FillTransparence` of the objects. For line-charts this should map to the `LineTransparence` property. See also ::com::sun::star::drawing::FillProperties, ::com::sun::star::drawing::LineProperties

FillStyle

::com::sun::star::drawing::FillStyle FillStyle; Description This enumeration selects the style with which the area will be filled.

TransparencyGradient

::com::sun::star::awt::Gradient TransparencyGradient; Usage Restrictions optional Description This describes the transparency of the fill area as a gradient.

Gradient

::com::sun::star::awt::Gradient Gradient; Usage Restrictions optional

Hatch

::com::sun::star::drawing::Hatch Hatch; Usage Restrictions optional

TransparencyGradientName

string TransparencyGradientName;

GradientName

string GradientName;

HatchName

string HatchName;

FillBitmapName

string FillBitmapName;

FillBackground

boolean FillBackground; Description If true, fills the background of a hatch with the color given in the Color property.

BorderColor

long BorderColor; Description Is used for borders around filled objects. See `LineColor`. See also ::com::sun::star::drawing::LineProperties

BorderStyle

::com::sun::star::drawing::LineStyle BorderStyle; Description Is used for borders around filled objects. See `LineStyle`. See also ::com::sun::star::drawing::LineProperties

BorderWidth

long BorderWidth; Description Is used for borders around filled objects. See `LineWidth`. See also ::com::sun::star::drawing::LineProperties

BorderDash

::com::sun::star::drawing::LineDash BorderDash; Description Is used for borders around filled objects. See `LineDash`. See also ::com::sun::star::drawing::LineProperties

BorderDashName

string BorderDashName; Usage Restrictions optional Description The name of a dash that can be found in the ::com::sun::star::container::XNameContainer "com.sun.star.drawing.LineDashTable", that can be created via the com::sun::star::uno::XMultiServiceFactory of the ChartDocument.

BorderTransparency

short BorderTransparency; Usage Restrictions optional Description Is used for borders around filled objects. See `LineTransparence`. See also ::com::sun::star::drawing::LineProperties

LineStyle

::com::sun::star::drawing::LineStyle LineStyle;

LineWidth

long LineWidth; Description Is only used for line-chart types. See also ::com::sun::star::drawing::LineProperties

LineDash

::com::sun::star::drawing::LineDash LineDash; Description Is only used for line-chart types. See also ::com::sun::star::drawing::LineProperties

LineDashName

string LineDashName; Usage Restrictions optional Description The name of a dash that can be found in the ::com::sun::star::container::XNameContainer "com.sun.star.drawing.LineDashTable", that can be created via the com::sun::star::uno::XMultiServiceFactory of the ChartDocument.

FillBitmapOffsetX

short FillBitmapOffsetX; Description This is the horizontal offset where the tile starts. It is given in percent in relation to the width of the bitmap.

FillBitmapOffsetY

short FillBitmapOffsetY; Description This is the vertical offset where the tile starts. It is given in percent in relation to the width of the bitmap.

FillBitmapPositionOffsetX

short FillBitmapPositionOffsetX; Description Every second line of tiles is moved the given percent of the witdh of the bitmap.

FillBitmapPositionOffsetY

short FillBitmapPositionOffsetY; Description Every second row of tiles is moved the given percent of the width of the bitmap.

FillBitmapRectanglePoint

::com::sun::star::drawing::RectanglePoint FillBitmapRectanglePoint; Description The RectanglePoint specifies the position inside of the bitmap to use as the top left position for rendering.

FillBitmapLogicalSize

boolean FillBitmapLogicalSize; Description specifies if the size is given in percentage or as an absolute value. If this is true, the properties FillBitmapSizeX and FillBitmapSizeY contain the size of the tile in percent of the size of the original bitmap. If this is false, the size of the tile is specified with 1/100th mm.

FillBitmapSizeX

long FillBitmapSizeX; Description This is the width of the tile for filling. Depending on the property FillBitmapLogicalSize, this is either relative or absolute.

FillBitmapSizeY

long FillBitmapSizeY; Description This is the height of the tile for filling. Depending on the property FillBitmapLogicalSize, this is either relative or absolute.

FillBitmapMode

::com::sun::star::drawing::BitmapMode FillBitmapMode; Description this enum selects how a area is filled with a single bitmap.

Symbol

Symbol Symbol; Usage Restrictions optional

Offset

double Offset; Usage Restrictions optional Description describes a value by which a data point is moved from its default position in percent of the maximum allowed distance. This is especially useful for the explosion of pie-chart segments.

Geometry3D

long Geometry3D; Usage Restrictions optional Description describes the geometry of a 3 dimensional datapoint. Number is one of constant group DataPointGeometry3D. This is especially used for 3D bar-charts. CUBOID==0 CYLINDER==1 CONE==2 PYRAMID==3 CUBOID==else

Label

DataPointLabel Label;

LabelSeparator

string LabelSeparator; Usage Restrictions optional Description specifies a string that is used to separate the parts of a data label (caption)

NumberFormat

long NumberFormat; Usage Restrictions optional Description specifies a number format for the display of the value in the data label

PercentageNumberFormat

long PercentageNumberFormat; Usage Restrictions optional Description specifies a number format for the display of the percentage value in the data label

LabelPlacement

long LabelPlacement; Usage Restrictions optional Description specifies a relative position for the data label See also ::com::sun::star::chart::DataLabelPlacement

ReferencePageSize

[ maybevoid ] ::com::sun::star::awt::Size ReferencePageSize; Description The size of the page at the moment when the font size for data labels was set. This size is used to resize text in the view when the size of the page has changed since the font sizes were set (automatic text scaling).

ErrorBarX

[ maybevoid ] ::com::sun::star::beans::XPropertySet ErrorBarX; Usage Restrictions optional Description If void, no error bars are shown for the data point in x-direction. The ::com::sun::star::beans::XPropertySet must support the service ErrorBar.

ErrorBarY

[ maybevoid ] ::com::sun::star::beans::XPropertySet ErrorBarY; Usage Restrictions optional Description If void, no error bars are shown for the data point in y-direction. The ::com::sun::star::beans::XPropertySet must support the service ErrorBar.

ShowErrorBox

[ maybevoid ] boolean ShowErrorBox; Usage Restrictions optional Description In case ErrorBarX and ErrorBarY both are set, and error bars are shown, a box spanning all error-indicators is rendered.

PercentDiagonal

[ maybevoid ] short PercentDiagonal; Usage Restrictions optional Description A value between 0 and 100 indicating the percentage how round an edge should be.

Top of Page

Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

API

SDK

Tips ‘n’ Tricks

Miscellaneous