LibreOffice
LibreOffice 24.8 SDK API 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;
Public Types | |
typedef sequence< long > | AttributedDataPoints |
This service will be used to render this data series. | |
typedef sequence< long > | DeletedLegendEntries |
A sequence of indexes denoting which data points shouldn't be shown in the legend. | |
![]() | |
typedef sequence< XDataPointCustomLabelField > | CustomLabelFields |
specifies a text with possible fields that is used as a data point label, if set then Label property is ignored | |
Included Services | |
service | ::com::sun::star::beans::PropertySet |
allows to connect a CoordinateSystem to a DataSeries | |
service | DataPointProperties |
these properties serve as default for data points. | |
![]() | |
service | ::com::sun::star::beans::PropertySet |
to give access to the properties required by this service. | |
service | ::com::sun::star::drawing::FillProperties |
to give access to the fill properties | |
Exported Interfaces | |
interface | XDataSeries |
allows setting a coordinate-system | |
interface | data::XDataSink |
allows attaching data sequences to a series. | |
interface | data::XDataSource |
allows querying the data that was set. | |
interface | XRegressionCurveContainer |
gives access to the data points contained in a data series. | |
![]() | |
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 | |
StackingDirection | StackingDirection |
indicates whether this series should be stacked with respect to the previous series. | |
boolean | VaryColorsByPoint |
If TRUE , the data points of this series get different colors by default, like in a pie chart. | |
long | AttachedAxisIndex |
This property describes whether the series should be shown at the main value axis or at the secondary value axis. | |
boolean | ShowLegendEntry |
This property describes whether the legend entry for the the data series should be shown. | |
boolean | ShowCustomLeaderLines |
This property describes whether the data point and the data label are connected with a leader line. | |
![]() | |
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 . | |
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 |
This describes the transparency of the fill area as a gradient. | |
::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. | |
long | BorderColor |
Is used for borders around filled objects. | |
::com::sun::star::drawing::LineStyle | BorderStyle |
Is used for borders around filled objects. | |
long | BorderWidth |
Is used for borders around filled objects. | |
::com::sun::star::drawing::LineDash | BorderDash |
Is used for borders around filled objects. | |
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. | |
short | BorderTransparency |
Is used for borders around filled objects. | |
::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 |
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. | |
short | FillBitmapPositionOffsetX |
Every second line of tiles is moved the given percent of the width 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 an area is filled with a single bitmap. | |
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. | |
long | Geometry3D |
describes the geometry of a 3 dimensional data point. | |
DataPointLabel | Label |
string | LabelSeparator |
specifies a string that is used to separate the parts of a data label (caption) | |
boolean | TextWordWrap |
specifies if the text of a data label (caption) must be wrapped | |
long | NumberFormat |
specifies a number format for the display of the value in the data label | |
long | PercentageNumberFormat |
specifies a number format for the display of the percentage value in the data label | |
long | LabelPlacement |
specifies a relative position for the data label | |
com::sun::star::awt::Size | ReferencePageSize |
The size of the page at the moment when the font size for data labels was set. | |
com::sun::star::beans::XPropertySet | ErrorBarX |
If void, no error bars are shown for the data point in x-direction. | |
com::sun::star::beans::XPropertySet | ErrorBarY |
If void, no error bars are shown for the data point in y-direction. | |
boolean | ShowErrorBox |
In case ErrorBarX and ErrorBarY both are set, and error bars are shown, a box spanning all error-indicators is rendered. | |
short | PercentDiagonal |
A value between 0 and 100 indicating the percentage how round an edge should be. | |
::com::sun::star::chart2::RelativePosition | CustomLabelPosition |
Custom position on the page associated to the CUSTOM label placement. | |
::com::sun::star::chart2::RelativeSize | CustomLabelSize |
Custom size associated with the CUSTOM label placement. | |
![]() | |
FillStyle | FillStyle |
This enumeration selects the style the area will be filled with. | |
com::sun::star::util::Color | FillColor |
If the property FillStyle is set to FillStyle::SOLID, this is the color used. | |
short | FillTransparence |
This is the transparence of the filled area. | |
string | FillTransparenceGradientName |
If a gradient is used for transparency, this is the name of the used transparence gradient style or it is empty. | |
com::sun::star::awt::Gradient | FillTransparenceGradient |
This describes the transparency of the fill area as a gradient. | |
string | FillGradientName |
If the property FillStyle is set to FillStyle::GRADIENT, this is the name of the used fill gradient style. | |
com::sun::star::awt::Gradient | FillGradient |
If the property FillStyle is set to FillStyle::GRADIENT, this describes the gradient used. | |
string | FillHatchName |
If the property FillStyle is set to FillStyle::HATCH, this is the name of the used fill hatch style. | |
Hatch | FillHatch |
If the property FillStyle is set to FillStyle::HATCH, this describes the hatch used. | |
boolean | FillBackground |
if this is TRUE , the transparent background of a hatch filled area is drawn in the current background color. | |
string | FillBitmapName |
If the property FillStyle is set to FillStyle::BITMAP, this is the name of the used fill bitmap style. | |
com::sun::star::awt::XBitmap | FillBitmap |
If the property FillStyle is set to FillStyle::BITMAP, this is the bitmap used. | |
string | FillBitmapURL |
If the property FillStyle is set to FillStyle::BITMAP, this is a URL to the bitmap used. | |
short | FillBitmapPositionOffsetX |
This is the horizontal offset where the tile starts. | |
short | FillBitmapPositionOffsetY |
This is the vertical offset where the tile starts. | |
short | FillBitmapOffsetX |
Every second line of tiles is moved the given percent of the width of the bitmap. | |
short | FillBitmapOffsetY |
Every second row of tiles is moved the given percent of the height of the bitmap. | |
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. | |
BitmapMode | FillBitmapMode |
this enum selects how an area is filled with a single bitmap. | |
boolean | FillBitmapStretch |
if set, the fill bitmap is stretched to fill the area of the shape. | |
boolean | FillBitmapTile |
if set, the fill bitmap is repeated to fill the area of the shape. | |
com::sun::star::text::GraphicCrop | GraphicCrop |
contains the cropping of the object. | |
boolean | FillUseSlideBackground |
If this is TRUE , and FillStyle is FillStyle::NONE: The area displays the slide background. | |
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.
|
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.
|
optionalproperty |
A sequence of indexes denoting which data points shouldn't be shown in the legend.
allows to connect a CoordinateSystem to a DataSeries
the property interface by which the properties of all supported services are exchanged
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:
interface data::XDataSink |
allows attaching data sequences to a series.
interface data::XDataSource |
allows querying the data that was set.
interface XDataSeries |
allows setting a coordinate-system
|
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.
|
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.
|
optionalproperty |
This property describes whether the data point and the data label are connected with a leader line.
|
optionalproperty |
This property describes whether the legend entry for the the data series should be shown.
|
property |
indicates whether this series should be stacked with respect to the previous series.
|
optionalproperty |
If TRUE
, the data points of this series get different colors by default, like in a pie chart.