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 interface XChartType
Usage Restrictions
not published

Methods' Summary
getChartType A string representation of the chart type. This needs to be the service-name which can be used to create a charttype.  
createCoordinateSystem Creates a coordinate systems that fits the chart-type with its current settings and for the given dimension.  
getSupportedMandatoryRoles Returns a sequence of roles that are undestood by this chart type.  
getSupportedOptionalRoles Returns a sequence of roles that are understood in addition to the mandatory roles (see XChartType::getSupportedMandatoryRoles()).  
getRoleOfSequenceForSeriesLabel Returns the role of the ::XLabeledDataSequence of which the label will be taken to identify the DataSeries in dialogs or the legend.  
Methods' Details
getChartType
string
getChartType();

Description
A string representation of the chart type. This needs to be the service-name which can be used to create a charttype.
createCoordinateSystem
XCoordinateSystem
createCoordinateSystem( [in] long  DimensionCount )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
Creates a coordinate systems that fits the chart-type with its current settings and for the given dimension.
Throws
IllegalArgumentException This charttype cannot be displayed in the given dimension.
getSupportedMandatoryRoles
sequence< string >
getSupportedMandatoryRoles();

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

All roles must be listed in the order in which they are usually parsed. This ensures that glueing 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.

getSupportedOptionalRoles
sequence< string >
getSupportedOptionalRoles();

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

getRoleOfSequenceForSeriesLabel
string
getRoleOfSequenceForSeriesLabel();

Description
Returns the role of the ::XLabeledDataSequence of which the label will be taken to identify the DataSeries in dialogs or the legend.
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.