IDataSeries
Data series is a sequence of data points that are all computed from a single measure, scoped for particular attribute elements.
export interface IDataSeries extends DataSeriesDescriptorMethods, Iterable<DataPoint>
Extends: DataSeriesDescriptorMethods, Iterable<DataPoint>
Remarks
In other words, data series allows iterating over two dimensional data view _along_ the dimension which contains the measures (via inclusion of MeasureGroupIdentifier).
For convenience, the data series is iterable over Data Points. You can use it either in for-of loop or spread data series into an array of DataPoints.
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| Descriptor of this data series - what measure it was calculated from, whether it is scoped and if so to what attribute headers. | ||
| Unique identifier of the data series. This can be used to directly access this data series from data view. |
Methods
Method | Description |
|---|---|
Property details
IDataSeries.descriptorproperty
Descriptor of this data series - what measure it was calculated from, whether it is scoped and if so to what attribute headers.
readonly descriptor: DataSeriesDescriptor;
IDataSeries.idproperty
Unique identifier of the data series. This can be used to directly access this data series from data view.
readonly id: DataSeriesId;
Method details
IDataSeries.dataPoints()method
dataPoints(): DataPoint[];
Returns
- all data points in this series
Remarks
the series is iterable over data points; if you want to iterate using for-of loop then it is not necessary to call this method - just use for (const dataPoint of series) {...}
IDataSeries.rawData()method
rawData(): DataValue[];
Returns
- all raw, unformatted data for this series.
Remarks
if you need to work with fully annotated and formatted data, use the DataPoint iterator.