com::sun::star::chart2::data Module Reference

Chart data provider interfaces. More...

Classes
service	DatabaseDataProvider
service	DataFilter
	A filter gets some data and provides some data. More...
service	DataProvider
service	DataSequence
	describes a container for a sequence of values. More...
service	DataSink
	describes a service that allows reading two-dimensional data in the form of a sequence of DataSequences. More...
service	DataSource
	describes a service that allows reading two-dimensional data in the form of a sequence of DataSequences. More...
struct	HighlightedRange
service	LabeledDataSequence
	describes a container for a sequence pair of value-sequences, one for a label and one for the associated data. More...
struct	PivotTableFieldEntry
	Pivot table field entry data. More...
service	RangeHighlighter
service	RangeHighlightListener
	A selection change listener that is attached to a XRangeHighlighter in order to get notified about selection changes that affect range highlighting. More...
service	TabularDataProviderArguments
interface	XDatabaseDataProvider
	identifies a XDataProvider for result sets. More...
interface	XDataProvider
	An application that provides data for a chart must implement this interface. More...
interface	XDataReceiver
interface	XDataSequence
	allows access to a one-dimensional sequence of data. More...
interface	XDataSink
	is a container for sequences of data. More...
interface	XDataSource
	provides access to sequences of data. More...
interface	XLabeledDataSequence
	allows access to a one-dimensional sequence of data. More...
interface	XLabeledDataSequence2
interface	XNumericalDataSequence
	allows access to a one-dimensional sequence of double precision floating-point numbers. More...
interface	XPivotTableDataProvider
	Data provider specific for pivot chart data. More...
interface	XRangeHighlighter
interface	XRangeXMLConversion
	An application that provides data for a chart must implement this interface. More...
interface	XSheetDataProvider
	Interface specific to spreadsheet data provider backend. More...
interface	XTextualDataSequence
	allows access to a one-dimensional sequence of strings. More...

Typedefs
typedef string	DataSequenceRole
	a string that states in what way a DataSequence should be used. More...

Enumerations
enum	LabelOrigin { SHORT_SIDE, LONG_SIDE, COLUMN, ROW }
	is used to specify how the labels have to be created. More...

Detailed Description

Chart data provider interfaces.

Typedef Documentation

DataSequenceRole

typedef string DataSequenceRole

a string that states in what way a DataSequence should be used.

If this property is an empty string, no proposition about usage is made.

The strings can have any value. However some values are predefined and should always be interpreted in the same way.

label

values are used as a label for a series. Usually, you will have just one cell containing a string.

values-x

values are used as x-values in an XY- or bubble diagram

values-y

values are used as y-values in an XY-Diagram or as values in a bar, line, etc. chart

values-z

values may be used as z-values in a three-dimensional XYZ-Diagram or a surface-chart

sizes

values are used as radius of the bubbles in a Bubble-Diagram

error-bars-x-positive

values are used as error-information in positive x-direction for displaying error-bars

error-bars-x-negative

values are used as error-information in negative x-direction for displaying error-bars

error-bars-y-positive

values are used as error-information in positive y-direction for displaying error-bars

error-bars-y-negative

values are used as error-information in negative y-direction for displaying error-bars

categories

values are used for categories in the diagram

In a candle-stick chart you have the following roles:

values-first

the first value of a series of values. In a stock-chart this would be the opening course.

values-last

the last value of a series of values. In a stock-chart this would be the closing course.

values-min

the minimum value of a series of values. In a stock-chart this would be the lowest course that occurred during trading.

values-max

the maximum value of a series of values. In a stock-chart this would be the highest course that occurred during trading.

Enumeration Type Documentation

LabelOrigin

enum LabelOrigin

is used to specify how the labels have to be created.

See also

XDataSequence::generateLabel().

Enumerator
SHORT_SIDE	If a range spans a single row over more than one column, this parameter has the same effect as ROW. If the range spans a single column over more than one row, this is the same as COLUMN. In case of a range spanning more than one column and row, the shorter range of both should be used (e.g. a spreadsheet range A1:B10 should treat columns as short side). In case of a rectangular range, or a range that is composed of more than one contiguous sub-regions, the short side cannot be determined, thus XDataSequence::generateLabel() will return an empty sequence.
LONG_SIDE	This is exactly the opposite of SHORT_SIDE. I.e., if SHORT_SIDE has the same effect as ROW, LONG_SIDE will have the same effect as COLUMN and the other way round. See also LabelOrigin::SHORT_SIDE
COLUMN	Uses the column name for label generation. A spreadsheet range A1:A6 could, e.g., result in "Column A". If a range consists of more than one column the result of label generation may be empty. Of course, it could also succeed with a string like "Columns A to B".
ROW	Uses the column name for label generation. A spreadsheet range A2:D2 could, e.g., result in "Row 2". If a range consists of more than one row the result of label generation may be empty. Of course, it could also succeed with a string like "Rows 1-3".