Skip to content

Vizzu / Modules / types/data

Module: types/data

Interfaces

Type Aliases

AggregatorType

Ƭ AggregatorType: "sum" | "count" | "min" | "max" | "mean" | "distinct"

Types of the different available data series aggregators:

  • sum: sum of the values (default)
  • count: count of the values
  • min: minima of the values
  • max: maxima of the values
  • mean: average/mean of the values
  • distinct: number of different values

FilterCallback

Ƭ FilterCallback: (record: Record) => boolean

Type declaration

▸ (record): boolean

A callback function receives a record

Parameters

Name Type
record Record

Returns

boolean


SeriesDescriptor

Ƭ SeriesDescriptor: SeriesName | `${AggregatorType}(${SeriesName})`

The name of a series either alone or combined with an aggregator function.


SeriesInfo

Ƭ SeriesInfo: DimensionSeriesInfo | MeasureSeriesInfo

MetaInfo for different series types.


SeriesList

Ƭ SeriesList: SeriesDescriptor[]

Array or a single data series.


SeriesName

Ƭ SeriesName: string

Name of the data series.


SeriesType

Ƭ SeriesType: "dimension" | "measure"

Type of the data series:

  • 'dimension' - categorical data containing strings (dates should also be added as strings);
  • 'measure' - continuous data containing numbers.

Set

Ƭ Set: TableBySeries | TableByRecords

Data set is a collection of related data series. Each chart works on a single data set.


Value

Ƭ Value: string | number

Represents a categorical or data value


ValueArray

Ƭ ValueArray: Value[]

Values of a data record in the order of the series in the dataset.


Values

Ƭ Values: string[] | (number | null)[]

List of data values in a series.