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 XChartDocument
Base Interfaces
XChartDocument
┗ ::com::sun::star::frame::XModel
   ┗ ::com::sun::star::lang::XComponent

::com::sun::star::frame::XModel
(referenced interface's summary:)
represents a component which is created from an URL and arguments.

Methods' Summary
getFirstDiagram @todo allow more than one diagram  
setFirstDiagram @todo allow more than one diagram  
createInternalDataProvider creates an internal com::sun::star::chart2::XDataProvider that is handled by the chart document itself.  
hasInternalDataProvider  
getDataProvider Returns the currently set data provider. This may be an internal one, if createInternalDataProvider has been called before, or an external one if ::XDataReceiver::attachDataProvider has been called.  
setChartTypeManager sets a new component that is able to create different chart type templates (components of type ChartTypeTemplate)  
getChartTypeManager retrieves the component that is able to create different chart type templates (components of type ChartTypeTemplate)  
getPageBackground Gives access to the page background appearance.  
Methods' Details
getFirstDiagram
XDiagram
getFirstDiagram();

Description
@todo allow more than one diagram

Notes: this is preliminary, we need an API that supports more than one diagram. The method name getDiagram exists in the css.chart API, so there is would be no way to chose either this or the other method from Basic (it would chose one or the other by random).

setFirstDiagram
void
setFirstDiagram( [in] XDiagram  xDiagram );

Description
@todo allow more than one diagram

Notes: this is preliminary, we need an API that supports more than one diagram. The method name setDiagram exists in the css.chart API, so there is would be no way to chose either this or the other method from Basic (it would chose one or the other by random).

createInternalDataProvider
void
createInternalDataProvider( [in] boolean  bCloneExistingData )
raises( ::com::sun::star::util::CloseVetoException );

Description
creates an internal com::sun::star::chart2::XDataProvider that is handled by the chart document itself.

When the model is stored, the data provider will also be stored in a sub-storage.

Parameter bCloneExistingData
if true and a data provider was previously attached, its referred data will be copied to the new internal data provider. Note, that the range representation set before will usually change after cloning.

Throws
com::sun::star::util:CloseVetoException If the new data provider could not be created due to a failed removal of the former data provider.
hasInternalDataProvider
boolean
hasInternalDataProvider();

Returns
true if the data provider set at the chart document is an internal one.

This is the case directly after createInternalDataProvider has been called, but this is not necessary. The chart can also create an internal data provider by other means, e.g. a call to ::com::sun::star::frame::XModel::initNew.

getDataProvider
::com::sun::star::chart2::data::XDataProvider
getDataProvider();

Description
Returns the currently set data provider. This may be an internal one, if createInternalDataProvider has been called before, or an external one if ::XDataReceiver::attachDataProvider has been called.
setChartTypeManager
void
setChartTypeManager( [in] XChartTypeManager  xNewManager );

Description
sets a new component that is able to create different chart type templates (components of type ChartTypeTemplate)
getChartTypeManager
XChartTypeManager
getChartTypeManager();

Description
retrieves the component that is able to create different chart type templates (components of type ChartTypeTemplate)
getPageBackground
::com::sun::star::beans::XPropertySet
getPageBackground();

Description
Gives access to the page background appearance.
Returns
the properties of the background area of the chart document.

The area's extent is equal to the document size. If you want to access properties of the background area of a single diagram (the part where data points are actually plotted in), you have to get its wall. You can get the wall by calling XDiagram::getWall.

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.