LibreOffice LibreOffice 25.8 SDK API Reference

Included Services | Exported Interfaces | Public Attributes | List of all members
ChartDocument Service Referencepublished

is the service for a chart document. More...

`import"ChartDocument.idl";`

Inheritance diagram for ChartDocument:

## Included Services
service | ::com::sun::star::xml::UserDefinedAttributesSupplier
| If a ChartDocument may be stored as XML file, this service should be supported in order to preserve unparsed XML attributes. More...

## Exported Interfaces
interface | ::com::sun::star::chart::XChartDocument
interface | ::com::sun::star::beans::XPropertySet
interface | ::com::sun::star::drawing::XDrawPageSupplier

## Public Attributes
boolean | HasMainTitle
| determines if the main title is shown or hidden. More...
boolean | HasSubTitle
| determines if the subtitle is shown or hidden. More...
boolean | HasLegend
| determines if the legend is shown or hidden. More...

## Additional Inherited Members
Public Member Functions inherited from XChartDocument
com::sun::star::drawing::XShape | getTitle ()
com::sun::star::drawing::XShape | getSubTitle ()
com::sun::star::drawing::XShape | getLegend ()
com::sun::star::beans::XPropertySet | getArea ()
com::sun::star::chart::XDiagram | getDiagram ()
void | setDiagram ([in] com::sun::star::chart::XDiagram xDiagram)
| sets the diagram for the chart document. More...
com::sun::star::chart::XChartData | getData ()
void | attachData ([in] com::sun::star::chart::XChartData xData)
| attaches data to the chart. More...
Public Member Functions inherited from XModel
boolean | attachResource ([in] string URL, [in] sequence< com::sun::star::beans::PropertyValue > Arguments)
| informs a model about its resource description. More...
string | getURL ()
| provides information about the location of this model More...
sequence< com::sun::star::beans::PropertyValue > | getArgs ()
| provides read access on currently representation of the com::sun::star::document::MediaDescriptor of this model which describes the model and its state More...
void | connectController ([in] XController Controller)
| is called whenever a new controller is created for this model. More...
void | disconnectController ([in] XController Controller)
| is called whenever an existing controller should be deregistered at this model. More...
void | lockControllers ()
| suspends some notifications to the controllers which are used for display updates. More...
void | unlockControllers ()
| resumes the notifications which were suspended by XModel::lockControllers(). More...
boolean | hasControllersLocked ()
| determines if there is at least one lock remaining. More...
XController | getCurrentController ()
| provides access to the controller which currently controls this model More...
void | setCurrentController ([in] XController Controller) raises ( com::sun::star::container::NoSuchElementException )
| sets a registered controller as the current controller. More...
com::sun::star::uno::XInterface | getCurrentSelection ()
| provides read access on current selection on controller More...
Public Member Functions inherited from XComponent
void | dispose ()
| The owner of an object calls this method to explicitly free all resources kept by this object and thus break cyclic references. More...
void | addEventListener ([in] XEventListener xListener)
| adds an event listener to the object. More...
void | removeEventListener ([in] XEventListener aListener)
| removes an event listener from the listener list. More...
Public Member Functions inherited from XInterface
any | queryInterface ([in] type aType)
| queries for a new interface to an existing UNO object. More...
void | acquire ()
| increases the reference counter by one. More...
void | release ()
| decreases the reference counter by one. More...
Public Member Functions inherited from XPropertySet
com::sun::star::beans::XPropertySetInfo | getPropertySetInfo ()
void | setPropertyValue ([in] string aPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
| sets the value of the property with the specified name. More...
any | getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
void | addPropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
| adds an XPropertyChangeListener to the specified property. More...
void | removePropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
| removes an XPropertyChangeListener from the listener list. More...
void | addVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
| adds an XVetoableChangeListener to the specified property with the name PropertyName. More...
void | removeVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
| removes an XVetoableChangeListener from the listener list. More...
Protected Member Functions inherited from XChartDocument
com::sun::star::drawing::XShape | getTitle ()
com::sun::star::drawing::XShape | getSubTitle ()
com::sun::star::drawing::XShape | getLegend ()
com::sun::star::beans::XPropertySet | getArea ()
com::sun::star::chart::XDiagram | getDiagram ()
void | setDiagram ([in] com::sun::star::chart::XDiagram xDiagram)
| sets the diagram for the chart document. More...
com::sun::star::chart::XChartData | getData ()
void | attachData ([in] com::sun::star::chart::XChartData xData)
| attaches data to the chart. More...
Protected Member Functions inherited from XModel
boolean | attachResource ([in] string URL, [in] sequence< com::sun::star::beans::PropertyValue > Arguments)
| informs a model about its resource description. More...
string | getURL ()
| provides information about the location of this model More...
sequence< com::sun::star::beans::PropertyValue > | getArgs ()
| provides read access on currently representation of the com::sun::star::document::MediaDescriptor of this model which describes the model and its state More...
void | connectController ([in] XController Controller)
| is called whenever a new controller is created for this model. More...
void | disconnectController ([in] XController Controller)
| is called whenever an existing controller should be deregistered at this model. More...
void | lockControllers ()
| suspends some notifications to the controllers which are used for display updates. More...
void | unlockControllers ()
| resumes the notifications which were suspended by XModel::lockControllers(). More...
boolean | hasControllersLocked ()
| determines if there is at least one lock remaining. More...
XController | getCurrentController ()
| provides access to the controller which currently controls this model More...
void | setCurrentController ([in] XController Controller) raises ( com::sun::star::container::NoSuchElementException )
| sets a registered controller as the current controller. More...
com::sun::star::uno::XInterface | getCurrentSelection ()
| provides read access on current selection on controller More...
Protected Member Functions inherited from XComponent
void | dispose ()
| The owner of an object calls this method to explicitly free all resources kept by this object and thus break cyclic references. More...
void | addEventListener ([in] XEventListener xListener)
| adds an event listener to the object. More...
void | removeEventListener ([in] XEventListener aListener)
| removes an event listener from the listener list. More...
Protected Member Functions inherited from XInterface
any | queryInterface ([in] type aType)
| queries for a new interface to an existing UNO object. More...
void | acquire ()
| increases the reference counter by one. More...
void | release ()
| decreases the reference counter by one. More...
Protected Member Functions inherited from XPropertySet
com::sun::star::beans::XPropertySetInfo | getPropertySetInfo ()
void | setPropertyValue ([in] string aPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
| sets the value of the property with the specified name. More...
any | getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
void | addPropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
| adds an XPropertyChangeListener to the specified property. More...
void | removePropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
| removes an XPropertyChangeListener from the listener list. More...
void | addVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
| adds an XVetoableChangeListener to the specified property with the name PropertyName. More...
void | removeVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
| removes an XVetoableChangeListener from the listener list. More...
Protected Member Functions inherited from XDrawPageSupplier
com::sun::star::drawing::XDrawPage | getDrawPage ()
| returns the DrawPage. More...
Protected Attributes inherited from UserDefinedAttributesSupplier
::com::sun::star::container::XNameContainer | UserDefinedAttributes
| This container holds the AttributeData elements that represent uninterpreted XML attributes. More...

## Detailed Description

is the service for a chart document.

A chart document consists of a reference to the data source, the diagram and some additional elements like a main title, a sub-title or a legend.

See also
  Diagram
  ChartLegend
  ChartTitle
  ChartDataArray

Developers Guide
  Charts - Working With Charts - Document Structure

## Exported Interfaces

## ◆ ::com::sun::star::xml::UserDefinedAttributesSupplier

service ::com::sun::star::xml::UserDefinedAttributesSupplier
| optional

If a ChartDocument may be stored as XML file, this service should be supported in order to preserve unparsed XML attributes.

Since
  OOo 1.1.2

## Exported Interfaces

## ◆ ::com::sun::star::beans::XPropertySet

interface ::com::sun::star::beans::XPropertySet

## ◆ ::com::sun::star::chart::XChartDocument

interface ::com::sun::star::chart::XChartDocument

## ◆ ::com::sun::star::drawing::XDrawPageSupplier

interface ::com::sun::star::drawing::XDrawPageSupplier
| optional

## Member Data Documentation

## ◆ HasLegend

boolean HasLegend
| property

determines if the legend is shown or hidden.

## ◆ HasMainTitle

boolean HasMainTitle
| property

determines if the main title is shown or hidden.

## ◆ HasSubTitle

boolean HasSubTitle
| property

determines if the subtitle is shown or hidden.

The documentation for this service was generated from the following file:

- com/sun/star/chart/ChartDocument.idl