LibreOffice
LibreOffice 6.2 SDK API Reference
Included Services | Public Attributes | List of all members
DataPointProperties Service Reference

import"DataPointProperties.idl";

Inheritance diagram for DataPointProperties:
PropertySet FillProperties XPropertySet XFastPropertySet XMultiPropertySet XPropertyAccess XPropertyState XInterface XInterface XInterface XInterface XInterface DataPoint DataSeries

Included Services

service ::com::sun::star::beans::PropertySet
 to give access to the properties required by this service. More...
 
service ::com::sun::star::drawing::FillProperties
 to give access to the fill properties More...
 

Public Attributes

long Color
 points to a style that also supports this service (but not this property) that is used as default, if the PropertyState of a property is DEFAULT_VALUE. More...
 
short Transparency
 This is the main transparency value of a data point. More...
 
::com::sun::star::drawing::FillStyle FillStyle
 This enumeration selects the style with which the area will be filled. More...
 
::com::sun::star::awt::Gradient TransparencyGradient
 This describes the transparency of the fill area as a gradient. More...
 
::com::sun::star::awt::Gradient Gradient
 
::com::sun::star::drawing::Hatch Hatch
 
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. More...
 
long BorderColor
 Is used for borders around filled objects. More...
 
::com::sun::star::drawing::LineStyle BorderStyle
 Is used for borders around filled objects. More...
 
long BorderWidth
 Is used for borders around filled objects. More...
 
::com::sun::star::drawing::LineDash BorderDash
 Is used for borders around filled objects. More...
 
string BorderDashName
 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. More...
 
short BorderTransparency
 Is used for borders around filled objects. More...
 
::com::sun::star::drawing::LineStyle LineStyle
 
long LineWidth
 Is only used for line-chart types. More...
 
::com::sun::star::drawing::LineDash LineDash
 Is only used for line-chart types. More...
 
string LineDashName
 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. More...
 
short FillBitmapOffsetX
 This is the horizontal offset where the tile starts. More...
 
short FillBitmapOffsetY
 This is the vertical offset where the tile starts. More...
 
short FillBitmapPositionOffsetX
 Every second line of tiles is moved the given percent of the width of the bitmap. More...
 
short FillBitmapPositionOffsetY
 Every second row of tiles is moved the given percent of the width of the bitmap. More...
 
com::sun::star::drawing::RectanglePoint FillBitmapRectanglePoint
 The RectanglePoint specifies the position inside of the bitmap to use as the top left position for rendering. More...
 
boolean FillBitmapLogicalSize
 specifies if the size is given in percentage or as an absolute value. More...
 
long FillBitmapSizeX
 This is the width of the tile for filling. More...
 
long FillBitmapSizeY
 This is the height of the tile for filling. More...
 
com::sun::star::drawing::BitmapMode FillBitmapMode
 this enum selects how a area is filled with a single bitmap. More...
 
Symbol Symbol
 
double Offset
 describes a value by which a data point is moved from its default position in percent of the maximum allowed distance. More...
 
long Geometry3D
 describes the geometry of a 3 dimensional data point. More...
 
DataPointLabel Label
 
sequence< XDataPointCustomLabelFieldCustomLabelFields
 specifies a text with possible fields that is used as a data point label, if set then Label property is ignored More...
 
string LabelSeparator
 specifies a string that is used to separate the parts of a data label (caption) More...
 
boolean TextWordWrap
 specifies if the text of a data label (caption) must be wrapped More...
 
long NumberFormat
 specifies a number format for the display of the value in the data label More...
 
long PercentageNumberFormat
 specifies a number format for the display of the percentage value in the data label More...
 
long LabelPlacement
 specifies a relative position for the data label More...
 
com::sun::star::awt::Size ReferencePageSize
 The size of the page at the moment when the font size for data labels was set. More...
 
com::sun::star::beans::XPropertySet ErrorBarX
 If void, no error bars are shown for the data point in x-direction. More...
 
com::sun::star::beans::XPropertySet ErrorBarY
 If void, no error bars are shown for the data point in y-direction. More...
 
boolean ShowErrorBox
 In case ErrorBarX and ErrorBarY both are set, and error bars are shown, a box spanning all error-indicators is rendered. More...
 
short PercentDiagonal
 A value between 0 and 100 indicating the percentage how round an edge should be. More...
 
- Public Attributes inherited from FillProperties
FillStyle FillStyle
 This enumeration selects the style the area will be filled with. More...
 
com::sun::star::util::Color FillColor
 If the property FillStyle is set to FillStyle::SOLID, this is the color used. More...
 
short FillTransparence
 This is the transparence of the filled area. More...
 
string FillTransparenceGradientName
 If a gradient is used for transparency, this is the name of the used transparence gradient style or it is empty. More...
 
com::sun::star::awt::Gradient FillTransparenceGradient
 This describes the transparency of the fill area as a gradient. More...
 
string FillGradientName
 If the property FillStyle is set to FillStyle::GRADIENT, this is the name of the used fill gradient style. More...
 
com::sun::star::awt::Gradient FillGradient
 If the property FillStyle is set to FillStyle::GRADIENT, this describes the gradient used. More...
 
string FillHatchName
 If the property FillStyle is set to FillStyle::HATCH, this is the name of the used fill hatch style. More...
 
Hatch FillHatch
 If the property FillStyle is set to FillStyle::HATCH, this describes the hatch used. More...
 
boolean FillBackground
 if this is TRUE, the transparent background of a hatch filled area is drawn in the current background color. More...
 
string FillBitmapName
 If the property FillStyle is set to FillStyle::BITMAP, this is the name of the used fill bitmap style. More...
 
com::sun::star::awt::XBitmap FillBitmap
 If the property FillStyle is set to FillStyle::BITMAP, this is the bitmap used. More...
 
string FillBitmapURL
 If the property FillStyle is set to FillStyle::BITMAP, this is a URL to the bitmap used. More...
 
short FillBitmapPositionOffsetX
 This is the horizontal offset where the tile starts. More...
 
short FillBitmapPositionOffsetY
 This is the vertical offset where the tile starts. More...
 
short FillBitmapOffsetX
 Every second line of tiles is moved the given percent of the width of the bitmap. More...
 
short FillBitmapOffsetY
 Every second row of tiles is moved the given percent of the height of the bitmap. More...
 
RectanglePoint FillBitmapRectanglePoint
 The RectanglePoint specifies the position inside of the bitmap to use as the top left position for rendering. More...
 
boolean FillBitmapLogicalSize
 specifies if the size is given in percentage or as an absolute value. More...
 
long FillBitmapSizeX
 This is the width of the tile for filling. More...
 
long FillBitmapSizeY
 This is the height of the tile for filling. More...
 
BitmapMode FillBitmapMode
 this enum selects how a area is filled with a single bitmap. More...
 
boolean FillBitmapStretch
 if set, the fill bitmap is stretched to fill the area of the shape. More...
 
boolean FillBitmapTile
 if set, the fill bitmap is repeated to fill the area of the shape. More...
 
com::sun::star::text::GraphicCrop GraphicCrop
 contains the cropping of the object. More...
 

Additional Inherited Members

- Exported Interfaces inherited from PropertySet
interface com::sun::star::beans::XPropertySet
 
interface com::sun::star::beans::XFastPropertySet
 
interface com::sun::star::beans::XMultiPropertySet
 
interface com::sun::star::beans::XPropertyAccess
 
interface com::sun::star::beans::XPropertyState
 
- Public Member Functions inherited from XPropertySet
com::sun::star::beans::XPropertySetInfo getPropertySetInfo ()
 
void setPropertyValue ([in] string aPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
 sets the value of the property with the specified name. More...
 
any getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 
void addPropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 adds an XPropertyChangeListener to the specified property. More...
 
void removePropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 removes an XPropertyChangeListener from the listener list. More...
 
void addVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 adds an XVetoableChangeListener to the specified property with the name PropertyName. More...
 
void removeVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 removes an XVetoableChangeListener from the listener list. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 
- Protected Member Functions inherited from XFastPropertySet
void setFastPropertyValue ([in] long nHandle, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
 sets the value to the property with the specified name. More...
 
any getFastPropertyValue ([in] long nHandle) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 
- Protected Member Functions inherited from XMultiPropertySet
com::sun::star::beans::XPropertySetInfo getPropertySetInfo ()
 
void setPropertyValues ([in] sequence< string > aPropertyNames, [in] sequence< any > aValues) raises ( com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
 sets the values to the properties with the specified names. More...
 
sequence< any > getPropertyValues ([in] sequence< string > aPropertyNames)
 
void addPropertiesChangeListener ([in] sequence< string > aPropertyNames, [in] com::sun::star::beans::XPropertiesChangeListener xListener)
 adds an XPropertiesChangeListener to the specified property with the specified names. More...
 
void removePropertiesChangeListener ([in] com::sun::star::beans::XPropertiesChangeListener xListener)
 removes an XPropertiesChangeListener from the listener list. More...
 
void firePropertiesChangeEvent ([in] sequence< string > aPropertyNames, [in] com::sun::star::beans::XPropertiesChangeListener xListener)
 fires a sequence of PropertyChangeEvents to the specified listener. More...
 
- Protected Member Functions inherited from XPropertyAccess
sequence< com::sun::star::beans::PropertyValuegetPropertyValues ()
 
void setPropertyValues ([in] sequence< com::sun::star::beans::PropertyValue > aProps) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
 sets the values of given properties. More...
 
- Protected Member Functions inherited from XPropertyState
com::sun::star::beans::PropertyState getPropertyState ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException )
 
sequence< com::sun::star::beans::PropertyStategetPropertyStates ([in] sequence< string > aPropertyName) raises ( com::sun::star::beans::UnknownPropertyException )
 
void setPropertyToDefault ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException )
 Sets the property to default value. More...
 
any getPropertyDefault ([in] string aPropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 

Exported Interfaces

to give access to the properties required by this service.

to give access to the fill properties

Note that there is access for some of them through some alias.

Since
LibreOffice 5.1

Member Data Documentation

long BorderColor
property

Is used for borders around filled objects.

See LineColor.

See also
com::sun::star::drawing::LineProperties
::com::sun::star::drawing::LineDash BorderDash
property

Is used for borders around filled objects.

See LineDash.

See also
com::sun::star::drawing::LineProperties
string BorderDashName
optionalproperty

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.

::com::sun::star::drawing::LineStyle BorderStyle
property

Is used for borders around filled objects.

See LineStyle.

See also
com::sun::star::drawing::LineProperties
short BorderTransparency
optionalproperty

Is used for borders around filled objects.

See LineTransparence.

See also
com::sun::star::drawing::LineProperties
long BorderWidth
property

Is used for borders around filled objects.

See LineWidth.

See also
com::sun::star::drawing::LineProperties
long Color
property

points to a style that also supports this service (but not this property) that is used as default, if the PropertyState of a property is DEFAULT_VALUE.

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
sequence<XDataPointCustomLabelField> CustomLabelFields
optionalproperty

specifies a text with possible fields that is used as a data point label, if set then Label property is ignored

Since
LibreOffice 6.1
com::sun::star::beans::XPropertySet ErrorBarX
optionalpropertymaybevoid

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.

com::sun::star::beans::XPropertySet ErrorBarY
optionalpropertymaybevoid

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.

boolean FillBackground
property

If TRUE, fills the background of a hatch with the color given in the Color property.

boolean FillBitmapLogicalSize
property

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.

com::sun::star::drawing::BitmapMode FillBitmapMode
property

this enum selects how a area is filled with a single bitmap.

string FillBitmapName
property
short FillBitmapOffsetX
property

This is the horizontal offset where the tile starts.

It is given in percent in relation to the width of the bitmap.

short FillBitmapOffsetY
property

This is the vertical offset where the tile starts.

It is given in percent in relation to the width of the bitmap.

short FillBitmapPositionOffsetX
property

Every second line of tiles is moved the given percent of the width of the bitmap.

short FillBitmapPositionOffsetY
property

Every second row of tiles is moved the given percent of the width of the bitmap.

com::sun::star::drawing::RectanglePoint FillBitmapRectanglePoint
property

The RectanglePoint specifies the position inside of the bitmap to use as the top left position for rendering.

long FillBitmapSizeX
property

This is the width of the tile for filling.

Depending on the property FillBitmapLogicalSize, this is either relative or absolute.

long FillBitmapSizeY
property

This is the height of the tile for filling.

Depending on the property FillBitmapLogicalSize, this is either relative or absolute.

::com::sun::star::drawing::FillStyle FillStyle
property

This enumeration selects the style with which the area will be filled.

long Geometry3D
optionalproperty

describes the geometry of a 3 dimensional data point.

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

::com::sun::star::awt::Gradient Gradient
optionalproperty
string GradientName
property
::com::sun::star::drawing::Hatch Hatch
optionalproperty
string HatchName
property
DataPointLabel Label
property
long LabelPlacement
optionalproperty

specifies a relative position for the data label

See also
com::sun::star::chart::DataLabelPlacement
string LabelSeparator
optionalproperty

specifies a string that is used to separate the parts of a data label (caption)

::com::sun::star::drawing::LineDash LineDash
property

Is only used for line-chart types.

See also
com::sun::star::drawing::LineProperties
string LineDashName
optionalproperty

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.

::com::sun::star::drawing::LineStyle LineStyle
property
long LineWidth
property

Is only used for line-chart types.

See also
com::sun::star::drawing::LineProperties
long NumberFormat
optionalproperty

specifies a number format for the display of the value in the data label

double Offset
optionalproperty

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.

long PercentageNumberFormat
optionalproperty

specifies a number format for the display of the percentage value in the data label

short PercentDiagonal
optionalpropertymaybevoid

A value between 0 and 100 indicating the percentage how round an edge should be.

com::sun::star::awt::Size ReferencePageSize
propertymaybevoid

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).

boolean ShowErrorBox
optionalpropertymaybevoid

In case ErrorBarX and ErrorBarY both are set, and error bars are shown, a box spanning all error-indicators is rendered.

Symbol Symbol
optionalproperty
boolean TextWordWrap
optionalproperty

specifies if the text of a data label (caption) must be wrapped

Since
LibreOffice 5.1
short Transparency
property

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
::com::sun::star::awt::Gradient TransparencyGradient
optionalproperty

This describes the transparency of the fill area as a gradient.

string TransparencyGradientName
property

The documentation for this service was generated from the following file: