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 :: chart2 :: data ::

unpublished interface XDataSequence
Usage Restrictions
not published
Description
allows acces to a one-dimensional sequence of data.

The data that is stored in this container may contain different types.


Methods' Summary
getData retrieves the data stored in this component.  
getSourceRangeRepresentation returns the (UI) range representation string used by this XDataSequence.  
generateLabel creates a label that describes the origin of this data sequence.  
getNumberFormatKeyByIndex returns a number format key for the value at the given index in the data sequence. If nIndex is -1, a key for the entire sequence should be returned, e.g. the most commonly used one.  
Methods' Details
getData
sequence< any >
getData();

Description
retrieves the data stored in this component.
Returns
a sequence containing the actual data. This sequence is a copy of the internal data. Therefore changing this object does not affect the content of the XDataSequence object.
getSourceRangeRepresentation
string
getSourceRangeRepresentation();

Description
returns the (UI) range representation string used by this XDataSequence.
generateLabel
sequence< string >
generateLabel( [in] LabelOrigin  eLabelOrigin );

Description
creates a label that describes the origin of this data sequence.

This is useful, if a XLabeledDataSequence has no label sequence. In this case you can call this method at the value sequence to obtain a fitting replacement label.

The sequence returned here may be empty if no suitable label can be generated.

The strings returned should be localized.

Parameter eLabelOrigin
denotes what part of the range should be used for label generation. If you have, e.g., one cell only, the parameter COLUMN enables you to get the name of the cell's column, the parameter ROW will give you its row name. If you have a non quadratic range you can ask for labels for the longer side with parameter LONG_SIDE or you can obtain labels for the shorter side with parameter SHORT_SIDE. If the range is not structured in a tabular way you may reveive no label.
Returns
Suitable labels for the given sequence depending on the range of the sequence and the parameter eLabelOrigin passed. In a spreadsheet this would typically be a label like "Column x" for the short side used as DataSeries name and maybe a sequence "Row 1" "Row 2" "Row 3" for the long side to be used as categories for example. Example: Assuming this sequence has a Rangerepresentation spanning row 5 and 6 in column 8. Following sequences of strings or similar strings are expected as return values: generateLabel( SHORT_SIDE ) -> "Column 8" generateLabel( LONG_SIDE ) -> "Row 5" "Row 6" generateLabel( COLUMN ) -> "Column 8" generateLabel( ROW ) -> "Row 5" "Row 6" Which strings exactly you return depends on the naming scheme of the application which provides its tabular data.
getNumberFormatKeyByIndex
long
getNumberFormatKeyByIndex( [in] long  nIndex )
raises( ::com::sun::star::lang::IndexOutOfBoundsException );

Description
returns a number format key for the value at the given index in the data sequence. If nIndex is -1, a key for the entire sequence should be returned, e.g. the most commonly used one.

If number formats are not supported, or there is no heuristic to return a key for the entire series, return 0 here.

The number format key must be valid for the ::com::sun::star::util::XNumberFormatsSupplier given by the XDataProvider, or 0 which is assumed to be always valid.

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.