Language

The Free and Open Productivity Suite
Apache OpenOffice 4.1.10 released

API

SDK

Tips ‘n’ Tricks

Miscellaneous


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

unpublished enum LabelOrigin
Usage Restrictions
not published
Description
is used to specify how the labels have to be created.
See also
XDataSequence::generateLabel
.

Values
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.  
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.  
COLUMN Uses the column name for label generation. A spreadsheet range A1:A6 could, e.g., result in "Column A".  
ROW Uses the column name for label generation. A spreadsheet range A2:D2 could, e.g., result in "Row 2".  
Values' Details
SHORT_SIDE
SHORT_SIDE,
Description
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
LONG_SIDE,
Description
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
COLUMN,
Description
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
ROW,
Description
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".

Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.