:: com :: sun :: star :: chart2 ::

unpublished interface XDataProvider
Description
An application that provides data for a chart must implement this interface.

Methods' Summary
getDataByRangeRepresentation Creates a data source object that matches the given range representation string.  
getDataSequenceByRangeIdentifier Creates a single XDataSequence out of an identifying string that may be an internal name.  
replaceRange Requests to get a new range for a given XDataSequence .  
addDataChangeListener adds a listener that is called when data referred by any XDataSequence contained in  
removeDataChangeListener removes a previously added listener.  
Methods' Details
getDataByRangeRepresentation
XDataSource
getDataByRangeRepresentation( [in] string  aRangeRepresentation )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
Creates a data source object that matches the given range representation string.

This can be used for creating the necessary data for a new chart out of a previously selected range of cells in a spreadsheet.

Parameter aRangeIdentifier
is an identifier that can be can be interpreted by the component that implements this interface. The representation string is of a form that may be used in the user interface.
Throws
::com::sun::star::lang::IllegalArgumentException may be raised by the XDataProvider if it is unable to interpret the aRangeRepresentation string appropriately.
getDataSequenceByRangeIdentifier
XDataSequence
getDataSequenceByRangeIdentifier( [in] string  aRangeIdentifier )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
Creates a single XDataSequence out of an identifying string that may be an internal name.
Parameter aRangeIdentifier
is an identifier that can be interpreted by the component that implements this interface. The representation string may not be suitable for display in the user interface.
Throws
::com::sun::star::lang::IllegalArgumentException may be raised by the XDataProvider if it is unable to interpret the aRangeIdentifier string appropriately.
replaceRange
XDataSequence
replaceRange( [in] XDataSequence  aSeq )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
Requests to get a new range for a given XDataSequence .

This method is typically used to let the user choose a different range for values of part of a data series via the GUI.

Parameter sSeq
a data sequence that uses data from this data provider.
Throws
::com::sun::star::lang::IllegalArgumentException If aSeq can not be handled by this data provider.
Returns
a new XDataSequence that refers to the new range. Note that this component may support different optional interfaces than aSeq .
See also
unknown ?, unknown ?
addDataChangeListener
void
addDataChangeListener( [in] XDataChangeListener  aListener,
[in] XDataSource  aData );

Description
adds a listener that is called when data referred by any XDataSequence contained in
aData has changed.
Parameter aListener
the componenet that is called when the event occurs.
Parameter aData
the data which should be observed for changes
removeDataChangeListener
void
removeDataChangeListener( [in] XDataChangeListener  aListener,
[in] XDataSource  aData )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
removes a previously added listener.

Note: After a successful call one reference to aListener as well as to aData will be released.

Parameter aListener
the componenet that was called when the event occurs.
Parameter aData
the data which was observed for changes
Throws
::com::sun::star::lang::IllegalArgumentException if the given listener for the given data has not been added beforehand.
Top of Page