Skip to content

Vizzu / Modules / types/data / Series

Interface: Series

types/data.Series

Defines a data series of the data set, and contains a particular variable's values in the data set and meta info about the variable.

Hierarchy

Properties

name

• name: string

Name of the data series. It will be the unique id of the series to reference it in various parts of the API, mainly in channel configuration and in data record filters. This name will also be used by default for Axis and Legend title.

Inherited from

SeriesMetaInfo.name

type

• Optional type: SeriesType

Type of the data series. If not set, the library will attempt to determine the type based on the type of the first value. Number type will result in measure, string type will result in dimension.

Inherited from

SeriesMetaInfo.type

unit

• Optional unit: string

Unit of the data series.

Inherited from

SeriesMetaInfo.unit

values

• Optional values: Values

The array that contains the values of the data series. The value types should match the data series' type property. If the data series is shorter than the longest data series defined, it will be internally extended with empty values.