Top   Module   Use   Manual   Index 
 EXPORTING SERVICES | METHODS' SUMMARY | METHODS' DETAILS 

com :: sun :: star :: chart ::

interface XChartDocument

Base Interface
com::sun::star::frame::XModel

Description
manages the chart document.
See also
XDiagram
See also
XChartData


Known Services which Export this Interface

com::sun::star::chart::ChartDocument is the service for a chart document.

Methods' Summary

getTitle
getSubTitle
getLegend
getArea
getDiagram
setDiagram sets the diagram for the chart document.
getData
attachData attaches an external data source 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
See also
X3DDisplay
getDiagram
 
com::sun::star::chart::XDiagram
getDiagram();
Returns
the diagram of the chart document.
See also
Diagram
setDiagram
 
void
setDiagram(
[ in ] com::sun::star::chart::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 XMultiServiceFactory , which should be implemented by an XChartDocument .
getData
 
com::sun::star::chart::XChartData
getData();
Returns
the data source of the chart.
See also
ChartData
attachData
 
void
attachData(
[ in ] com::sun::star::chart::XChartData xData );

Description
attaches an external data source to the chart.
See also
ChartData
Parameter xData
the component that provides the new data.

Top of Page