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 ::

interface XChartTypeTemplate

Methods' Summary
createDiagramByDataSource Creates a new diagram based upon the given data .  
supportsCategories  
changeDiagram Analyses the given diagram and reinterprets its DataSeries and ::Categories and creates a new diagram based on these series.  
changeDiagramData Changes the given diagram xDiagram by using the new data given in xDataSource.  
matchesTemplate States whether the given diagram could have been created by the template.  
getChartTypeForNewSeries Provides a chart type object that can be used to create new series.  
getDataInterpreter  
applyStyle Applies a chart-type specific style (e.g. symbols) to all series in the sequence aSeries.  
resetStyles Resets all styles that were changed from the default at any object in the chart and have not been later modified.  
Methods' Details
createDiagramByDataSource
XDiagram
createDiagramByDataSource( [in] ::com::sun::star::chart2::data::XDataSource  xDataSource,
[in] sequence< ::com::sun::star::beans::PropertyValue >  aArguments );

Description
Creates a new diagram based upon the given data .
Parameter xDataSource
This data source will be interpreted in a chart-type specific way and appropriate DataSeries will be created which serve as input for the new diagram.
Parameter aArguments
Arguments that tell the template how to slice the given range. The properties should be defined in a separate service.

For standard parameters that may be used, see the service StandardDiagramCreationParameters.

Returns
The new diagram which represents this ChartTypeTemplate.
supportsCategories
boolean
supportsCategories();

Returns
true if the template does support categories
changeDiagram
void
changeDiagram( [in] XDiagram  xDiagram );

Description
Analyses the given diagram and reinterprets its DataSeries and ::Categories and creates a new diagram based on these series.

Note, that if matchesTemplate returns true for the given XDiagram, the latter should not be changed.

Parameter xDiagram
The diagram given will be modified such that it represents this ChartTypeTemplate.
changeDiagramData
void
changeDiagramData( [in] XDiagram  xDiagram,
[in] ::com::sun::star::chart2::data::XDataSource  xDataSource,
[in] sequence< ::com::sun::star::beans::PropertyValue >  aArguments );

Description
Changes the given diagram xDiagram by using the new data given in xDataSource.

Note that the data is interpreted in a way that fits this template, but not necessarily the chart-types of the diagram. This method should only be called if the data-format of the diagram is compatible with the data-format of this template.

Ideally a matchesTemplate call for the given diagram should return true before this method is called.

Parameter xDataSource
This data source will be interpreted in a chart-type specific way and the DataSeries found in xDiagram will be adapted to the new data. Missing data series will be created and unused ones will be deleted in xDiagram.
Parameter aArguments
Arguments that tell the template how to slice the given range. The properties should be defined in a separate service.

For standard parameters that may be used, see the service StandardDiagramCreationParameters.

matchesTemplate
boolean
matchesTemplate( [in] XDiagram  xDiagram,
[in] boolean  bAdaptProperties );

Description
States whether the given diagram could have been created by the template.

The template will parse the ::DataSeriesTree of the diagram to determine if the structure matches the one which would have been created by createDiagramByDataSource.

For analysis all parts of the diagram may be used, e.g. also properties set at the data series (like symbols)./p>

Parameter xDiagram
The diagram to be analyzed.
Parameter bAdaptProperties
If true the properties of the template are set, such that the template matches more accurately. E.g. for a line-chart with symbols the property "Symbol" would be set to true. If this parameter is false the template itselfs stays unmodified.
Returns
true if the diagram given is structurally identical to a diagram that was created using createDiagramByDataSource or changeDiagram. If false is returned the template stays unmodified even if bAdaptProperties is true.
getChartTypeForNewSeries
XChartType
getChartTypeForNewSeries( [in] sequence< XChartType >  aFormerlyUsedChartTypes );

Description
Provides a chart type object that can be used to create new series.
Parameter aFormerlyUsedChartTypes
The list can be used to copy some aspects from old charttypes during the creation of a new chart type. The list might be empty.
getDataInterpreter
XDataInterpreter
getDataInterpreter();

applyStyle
void
applyStyle( [in] XDataSeries  xSeries,
[in] long  nChartTypeGroupIndex,
[in] long  nSeriesIndex,
[in] long  nSeriesCount );

Description
Applies a chart-type specific style (e.g. symbols) to all series in the sequence aSeries.
Parameter xSeries
a single data series to which a style will be applied
Parameter nChartTypeGroupIndex
Denotes in which chart-type group the series lies, such this method can apply different styles for different chart-type groups
Parameter nSeriesIndex
The index of the series inside the current chart-type group. nSeriesIndex does not uniquely identify a data series alone, but only together with nChartTypeGroupIndex
Parameter nSeriesCount
The number of series in the current chart-type group. @todo In the future, this should only change the "Style" property and no hard attributes.
resetStyles
void
resetStyles( [in] XDiagram  xDiagram );

Description
Resets all styles that were changed from the default at any object in the chart and have not been later modified.

In createDiagramByDataSource or changeDiagram a template might e.g. change the page background color or the line style of all data series. This method should reset all objects that still have the changed settings to the default.

If for example the template changed the ::com::sun::star::drawing::LineStyle of all series to NONE, this method should reset all series with LineStyle NONE back to SOLID. If a series has a style DASH, it must not be changed.

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.