LibreOffice
LibreOffice 6.2 SDK API Reference
Public Member Functions | List of all members
XChartType Interface Reference

import"XChartType.idl";

Inheritance diagram for XChartType:
XInterface ChartType CandleStickChartType

Public Member Functions

string getChartType ()
 A string representation of the chart type. More...
 
XCoordinateSystem createCoordinateSystem ([in] long DimensionCount) raises ( com::sun::star::lang::IllegalArgumentException )
 Creates a coordinate systems that fits the chart-type with its current settings and for the given dimension. More...
 
sequence< string > getSupportedMandatoryRoles ()
 Returns a sequence of roles that are understood by this chart type. More...
 
sequence< string > getSupportedOptionalRoles ()
 Returns a sequence of roles that are understood in addition to the mandatory roles (see XChartType::getSupportedMandatoryRoles()). More...
 
sequence< string > getSupportedPropertyRoles ()
 Returns a sequence with supported property mapping roles. More...
 
string getRoleOfSequenceForSeriesLabel ()
 Returns the role of the XLabeledDataSequence of which the label will be taken to identify the DataSeries in dialogs or the legend. 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...
 

Member Function Documentation

XCoordinateSystem createCoordinateSystem ( [in] long  DimensionCount)
raises (com::sun::star::lang::IllegalArgumentException
)

Creates a coordinate systems that fits the chart-type with its current settings and for the given dimension.

Exceptions
IllegalArgumentExceptionThis chart type cannot be displayed in the given dimension.
string getChartType ( )

A string representation of the chart type.

This needs to be the service-name which can be used to create a chart type.

string getRoleOfSequenceForSeriesLabel ( )

Returns the role of the XLabeledDataSequence of which the label will be taken to identify the DataSeries in dialogs or the legend.

sequence< string > getSupportedMandatoryRoles ( )

Returns a sequence of roles that are understood by this chart type.

All roles must be listed in the order in which they are usually parsed. This ensures that gluing sequences together and splitting them up apart again results in the same structure as before.

Note, that this does not involve optional roles, like error-bars.

sequence< string > getSupportedOptionalRoles ( )

Returns a sequence of roles that are understood in addition to the mandatory roles (see XChartType::getSupportedMandatoryRoles()).

An example for an optional role are error-bars.

sequence< string > getSupportedPropertyRoles ( )

Returns a sequence with supported property mapping roles.

An example for a property mapping role is FillColor.


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