buildSlicedSeries

Groups three parallel columns, a key, a slice and a value, into a series read at one slice, or returns null when any column does not resolve.

@internote/canvas-sdkFunction
On this page
import { buildSlicedSeries } from '@internote/canvas-sdk';

A row whose slice or value is not a number is dropped; a repeated key and slice pair keeps its first reading. For a slice column of names, use namedSliceOf: this reading puts the slice on a number line so it can be interpolated, and a name has none.

#Signature

(
    datasets: Record<string, ChalkDataset> | undefined,
    keysBinding: unknown,
    valuesBinding: unknown,
    sliceBinding: unknown,
): SlicedSeries | null

#Parameters

datasets
The document's datasets.
keysBinding
The binding of the column naming each thing, such as a country.
valuesBinding
The binding of the column holding each reading.
sliceBinding
The binding of the column naming each slice, such as a year.

#Example

const series = buildSlicedSeries(ctx.datasets, attrs.keys, attrs.values, attrs.slice);
const year = ctx.parameters.numbers().year;
const readings = series ? seriesAt(series, year) : new Map();

Declared in packages/canvas-sdk/src/data/sliced-series.ts:53.

Last updated