LibreOffice
LibreOffice 6.2 SDK API Reference
Public Attributes | List of all members
TabularDataProviderArguments Service Reference

import"TabularDataProviderArguments.idl";

Public Attributes

string CellRangeRepresentation
 the range address string spanning all data. More...
 
::com::sun::star::chart::ChartDataRowSource DataRowSource
 determines, whether data sequences are created out of columns or rows in a table. More...
 
boolean FirstCellAsLabel
 If data comes from columns, the first row will provide the labels for all sequences, if data comes from rows, the first column will provide the labels for all sequences. More...
 
sequence< long > SequenceMapping
 determines the order of the created labeled sequences More...
 
boolean HasCategories
 If FALSE the data provider may create a data sequence containing generated categories that fit the rest of the data, like e.g. More...
 
string TableNumberList
 This property is for providing proprietary table indexes for each table appearing in a range given in CellRangeRepresentation. More...
 

Member Data Documentation

string CellRangeRepresentation
property

the range address string spanning all data.

The range address string must be interpretable by the component that implements XDataProvider and gets this property as argument to XDataProvider::detectArguments().

The representation string is of a form that may be used in the user interface. Example for OOo Calc: "$Sheet1.$A$1:$D$7", example for OOo Writer: "&lt;Table1.A1:D7&gt;".

When used as input, this range will be split in columns or rows depending on the property DataRowSource.

When used as output of XDataProvider::detectArguments() this is the range that spans the ranges of all given XDataSequences. If the result is ambiguous, i.e., a splitting of this range would not yield the same result, this property should be empty. The latter is the case, when ranges are overlapping, the lengths of sequences are not equal or even if the order of two sequences is swapped (e.g. data comes from column A, C, B).

determines, whether data sequences are created out of columns or rows in a table.

If this property is not given as argument it is assumed to com::sun::star::chart::ChartDataRowSource::COLUMNS, i.e., the default is "take data from columns".

boolean FirstCellAsLabel
property

If data comes from columns, the first row will provide the labels for all sequences, if data comes from rows, the first column will provide the labels for all sequences.

Even if this property is false, the XLabeledDataSequence may contain a label, but this will not be the first cell of the selection. It may be a generic string like "Column C".

If this property is not given as argument it is assumed to be FALSE, i.e., the default is "no labels".

boolean HasCategories
optionalproperty

If FALSE the data provider may create a data sequence containing generated categories that fit the rest of the data, like e.g.

"Row 12", "Row 13", etc.

This property is not relevant for the splitting up of the data. It just indicates, if the chart wants to use part of the data as categories, so that generic categories can be returned if it doesn't.

The generic category labeled sequence returned should be the first one in the returned XDataSource. It needs no label. The values should have their role set to "categories". The generic strings returned should also be localized.

sequence< long > SequenceMapping
property

determines the order of the created labeled sequences

For example a SequenceMapping of [3,0,2,1] indicates that the sequence from old position "3" should now be the first one. Then comes the sequence from old position "0". Then that one from old position "2" and then the sequence from old position "1".

If the SequenceMapping contains invalid indexes just ignore those single indexes. For example if you only have three labeled sequences and a SequenceMapping [2,5,1,0], you should ignore the "5" and continue to place the sequence from old index "1" to the next new position and so on.

If the given SequenceMapping does not cover all existing labeled sequences just put the remaining sequences in old order behind the others. For example you have 4 sequences and a SequenceMapping [3,1]. The result should be a as if [3,1,0,2] was given.

string TableNumberList
optionalproperty

This property is for providing proprietary table indexes for each table appearing in a range given in CellRangeRepresentation.

Deprecated:

This argument is supported by Spreadsheets in order to be able to export a document into the StarOffice 5.0 binary format.

Example: If you have the sheets (Sheet1, Sheet2, Sheet3) in your document and a chart uses the range "Sheet2.A1:.A5 Sheet3.A1:.A5 Sheet2.B1:.B5 Sheet1:B1:.B5", your TableNumberList would be "1 2 1 0". A simple range like "Sheet1.A1:.E4" would have the TableNumberList in "0"

.


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