DataSeries Service Reference

reflects the model data of the object that has all the information for a DataRenderer to create a visible data series in a chart. More...

import"DataSeries.idl";

Inheritance diagram for DataSeries:

Included Services
service	::com::sun::star::beans::PropertySet
	allows to connect a CoordinateSystem to a DataSeries More...
service	DataPointProperties
	these properties serve as default for data points. More...
Included Services inherited from DataPointProperties
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...

Exported Interfaces
interface	XDataSeries
	allows setting a coordinate-system More...
interface	data::XDataSink
	allows attaching data sequences to a series. More...
interface	data::XDataSource
	allows querying the data that was set. More...
interface	XRegressionCurveContainer
	gives access to the data points contained in a data series. More...
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 Attributes
sequence< long >	AttributedDataPoints
	This service will be used to render this data series. More...
StackingDirection	StackingDirection
	indicates whether this series should be stacked with respect to the previous series. More...
boolean	VaryColorsByPoint
	If TRUE, the data points of this series get different colors by default, like in a pie chart. More...
long	AttachedAxisIndex
	This property describes whether the series should be shown at the main value axis or at the secondary value axis. More...
boolean	ShowLegendEntry
	This property describes whether the legend entry for the the data series should be shown. More...
sequence< long >	DeletedLegendEntries
	A sequence of indexes denoting which data points shouldn't be shown in the legend. More...
boolean	ShowCustomLeaderLines
	This property describes whether the data point and the data label are connected with a leader line. More...
Public Attributes inherited from DataPointProperties
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 an 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< XDataPointCustomLabelField >	CustomLabelFields
	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...
::com::sun::star::chart2::RelativePosition	CustomLabelPosition
	Custom position on the page associated to the CUSTOM label placement. 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 an 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...
boolean	FillUseSlideBackground
	If this is TRUE, and FillStyle is FillStyle::NONE: The area displays the slide background. More...

Additional Inherited Members
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...
Public Member Functions inherited from XDataSeries
::com::sun::star::beans::XPropertySet	getDataPointByIndex ([in] long nIndex) raises ( ::com::sun::star::lang::IndexOutOfBoundsException )
void	resetDataPoint ([in] long nIndex)
	the formatting of the specified data point is cleared More...
void	resetAllDataPoints ()
	all data point formatting are cleared More...
Public Member Functions inherited from XDataSink
void	setData ([in] sequence< XLabeledDataSequence > aData)
	sets new data sequences. More...
Public Member Functions inherited from XDataSource
sequence< XLabeledDataSequence >	getDataSequences ()
	returns data sequences. 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::PropertyValue >	getPropertyValues ()
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::PropertyState >	getPropertyStates ([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 )
Protected Member Functions inherited from XRegressionCurveContainer
void	addRegressionCurve ([in] XRegressionCurve aRegressionCurve) raises ( com::sun::star::lang::IllegalArgumentException )
	add a regression curve to the container More...
void	removeRegressionCurve ([in] XRegressionCurve aRegressionCurve) raises ( com::sun::star::container::NoSuchElementException )
	removes one regression curve from the container. More...
sequence< XRegressionCurve >	getRegressionCurves ()
	retrieve all regression curves More...
void	setRegressionCurves ([in] sequence< XRegressionCurve > aRegressionCurves) raises ( com::sun::star::lang::IllegalArgumentException )
	set all regression curves More...

Detailed Description

reflects the model data of the object that has all the information for a DataRenderer to create a visible data series in a chart.

It combines one or more DataSequences which are interpreted by evaluating their role-string.

See also

DataSequenceRole

Exported Interfaces

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

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

allows to connect a CoordinateSystem to a DataSeries

the property interface by which the properties of all supported services are exchanged

DataPointProperties

service DataPointProperties

these properties serve as default for data points.

So, an attribute for a data point comes from one point in the following hierarchy:

• default value of data series
• value from style of data series (if a style was set)
• value from hard attribute of data series (set with setPropertyValue)
• value from style of data point (if a style was set)
• value from hard attribute of data point (set with setPropertyValue)

Exported Interfaces

data::XDataSink

interface data::XDataSink

allows attaching data sequences to a series.

data::XDataSource

interface data::XDataSource

allows querying the data that was set.

XDataSeries

interface XDataSeries

allows setting a coordinate-system

XRegressionCurveContainer

interface XRegressionCurveContainer

optional

gives access to the data points contained in a data series.

The objects returned by the com::sun::star::container::XIndexAccess are of type com::sun::star::beans::XPropertySet and support the service DataPoint.establishes a broadcaster-listener mechanism for the com::sun::star::container::XIndexContainer to keep changes and the property DataSeries::AttributedDataPoints in sync.Holds regression curves (aka trend-lines) for a data series.

Member Data Documentation

AttachedAxisIndex

long AttachedAxisIndex

optionalproperty

This property describes whether the series should be shown at the main value axis or at the secondary value axis.

Having this property not set or setting it to 0 means that this data series will be scaled at the primary y-axis ( of the coordinate system in which this series is hosted ).

Setting this property to 1 means that this series should be scaled at the secondary y-axis. If there is no secondary axis the main axis should be used for scaling instead.

If you want to scale a series at a different x or z axis you need to create an additional coordinate system and host this series there.

AttributedDataPoints

sequence< long > AttributedDataPoints

optionalpropertyreadonly

This service will be used to render this data series.

This service name can be used to determine which DataSeries are of the same type.

The result of the DataSeries::DataSequenceRoles depends on the renderer service set here.

a sequence of indexes denoting which data points have set properties that differ from the default.

The default values are determined by the properties set at the DataPointProperties of the data series.

If the sequence is empty, that means that all data points look alike. They are formatted using the property values set in the data series.

The indexes in this sequence match the indexes used by the XIndexContainer.

This property is especially useful for large data series with only some formatted data points, because you do not have to iterate over all elements.

DeletedLegendEntries

sequence<long> DeletedLegendEntries

optionalproperty

A sequence of indexes denoting which data points shouldn't be shown in the legend.

Since

LibreOffice 7.0

ShowCustomLeaderLines

boolean ShowCustomLeaderLines

optionalproperty

This property describes whether the data point and the data label are connected with a leader line.

Since

LibreOffice 7.1

ShowLegendEntry

boolean ShowLegendEntry

optionalproperty

This property describes whether the legend entry for the the data series should be shown.

Since

LibreOffice 6.3

StackingDirection

StackingDirection StackingDirection

property

indicates whether this series should be stacked with respect to the previous series.

VaryColorsByPoint

boolean VaryColorsByPoint

optionalproperty

If TRUE, the data points of this series get different colors by default, like in a pie chart.

---

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

• com/sun/star/chart2/DataSeries.idl