IDataSeriesCollection
Home > @gooddata/sdk-ui > IDataSeriesCollection
IDataSeriesCollection interface
An iterable collection of data series.
Signature:
export interface IDataSeriesCollection extends Iterable<IDataSeries>
Extends: Iterable<IDataSeries>
Remarks
The collection additionally includes basic information about the origin of the data series that can be iterated - their number, measures they were calculated from and the scoping attributes.
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| count | readonly | number | Number of available data series. |
| fromMeasures | readonly | IMeasureDescriptor[] | Descriptors of measures that are used in the data series. |
| fromMeasuresDef | readonly | IMeasure[] | Definitions of measures which were sent to execution and resulted in the data series. |
| scopingAttributes? | readonly | IAttributeDescriptor[] | (Optional) Descriptors of attributes that are used to create data series with scoped measure values. |
| scopingAttributesDef? | readonly | IAttribute[] | (Optional) Definitions of attributes which were sent to execution and resulted in the data series with scoped measure values. |
Methods
| Method | Description |
|---|---|
| allForMeasure(localIdOrMeasure) | Returns iterator over all data series created for particular measure. |
| firstForMeasure(localIdOrMeasure) | Returns first-found data series for the provided measure. |
| toArray() | Returns all data series in an array. |