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

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.
Description
manages the chart document.
See also
XDiagram, XChartData

Methods' Summary
getTitle  
getSubTitle  
getLegend  
getArea  
getDiagram  
setDiagram sets the diagram for the chart document.  
getData  
attachData attaches data to the chart.  
Methods' Details
getTitle
::com::sun::star::drawing::XShape
getTitle();

Returns
the shape of the main title of the chart document.
See also
ChartTitle
getSubTitle
::com::sun::star::drawing::XShape
getSubTitle();

Returns
the shape of the subtitle of the chart document.

Usually the subtitle is smaller than the main title by default. And it is most commonly placed below the main title by default.

See also
ChartTitle
getLegend
::com::sun::star::drawing::XShape
getLegend();

Returns
the shape of the legend of the chart document.
See also
ChartLegend
getArea
::com::sun::star::beans::XPropertySet
getArea();

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 the diagram, in which the actual data is represented, you have to change the chart wall which you get from the X3DDisplay.

See also
ChartArea, X3DDisplay
getDiagram
XDiagram
getDiagram();

Returns
the diagram of the chart document.
See also
Diagram
setDiagram
void
setDiagram( [in] XDiagram  xDiagram );

Description
sets the diagram for the chart document.

Setting a new diagram implicitly disposes the previous diagram.

Parameter xDiagram
the new diagram that should be set for the chart. To create such a diagram component, you can use the ::com::sun::star::lang::XMultiServiceFactory, which should be implemented by an XChartDocument.
getData
XChartData
getData();

Returns
the data of the chart.

The returned object supports interface XChartDataArray which can be used to access the concrete data.

Since OOo 3.3 the returned object also supports interface XComplexDescriptionAccess which can be used to access complex hierarchical axis descriptions.

Since OOo 3.4 the returned object also supports interface XDateCategories.

See also
XChartData, XChartDataArray, XComplexDescriptionAccess, XDateCategories
attachData
void
attachData( [in] XChartData  xData );

Description
attaches data to the chart.

The given object needs to support interface XChartDataArray.

Since OOo 3.3 if the given object might support interface XComplexDescriptionAccess which allows to set complex hierarchical axis descriptions.

Since OOo 3.4 if the given object might support interface XDateCategories which allows to set date values as x values for category charts.

The given data is copied before it is applied to the chart. So changing xData after this call will have no effect on the chart.

Parameter xData
the object that provides the new data.
See also
XChartData, XChartDataArray, XComplexDescriptionAccess, XDateCategories
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.