Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


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

unpublished service DataSeries
Usage Restrictions
not published
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

Included Services - Summary
::com::sun::star::beans::PropertySet

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

DataPointProperties

these properties serve as default for data points. (details)

Exported Interfaces - Summary
XDataSeries

allows setting a coordinate-system

::com::sun::star::chart2::data::XDataSink

allows attaching data sequences to a series.

::com::sun::star::chart2::data::XDataSource

allows querying the data that was set.

XRegressionCurveContainer

Holds regression curves (aka trend-lines) for a data series. (details)

Properties' Summary
[ readonly ] sequence< long >
AttributedDataPoints
[ OPTIONAL ]
a sequence of indexes denoting which data points have set properties that differ from the default.  
StackingDirection
StackingDirection
indicates wether this series should be stacked with respect to the previous series.  
boolean
VaryColorsByPoint
[ OPTIONAL ]
If true, the data points of this series get different colors by default, like in a pie chart.  
long
AttachedAxisIndex
[ OPTIONAL ]
This property describes wether 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 ).  
Included Services - Details
::com::sun::star::beans::PropertySet
Description
the property interface by which the properties of all supported services are exchanged
DataPointProperties
Description
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 - Details
XDataSeries
Description
allows setting a coordinate-system
::com::sun::star::chart2::data::XDataSink
Description
allows attaching data sequences to a series.
::com::sun::star::chart2::data::XDataSource
Description
allows querying the data that was set.
XRegressionCurveContainer
Usage Restrictions
optional
Description
Holds regression curves (aka trend-lines) for a data series.
Properties' Details
AttributedDataPoints
[ readonly ] sequence< long > AttributedDataPoints;
Usage Restrictions
optional
Description
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 propery 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.

StackingDirection
StackingDirection StackingDirection;
Description
indicates wether this series should be stacked with respect to the previous series.
VaryColorsByPoint
boolean VaryColorsByPoint;
Usage Restrictions
optional
Description
If true, the data points of this series get different colors by default, like in a pie chart.
AttachedAxisIndex
long AttachedAxisIndex;
Usage Restrictions
optional
Description
This property describes wether 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.


 
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.