Documentation / @ripl/charts / createHeatmapChart

Function: createHeatmapChart()

createHeatmapChart<TData>(target, options): HeatmapChart<TData>

Defined in: charts/src/charts/heatmap.ts:481

Factory function that creates a new HeatmapChart instance.

Type Parameters

Type Parameter	Default type
TData	unknown

Parameters

Parameter	Type
target	string | Context<Element, Record<string, unknown>> | HTMLElement
options	HeatmapChartOptions<TData>

Returns

HeatmapChart<TData>

Example

createHeatmapChart(target, {
    data: [
        { day: 'Mon', hour: '9', load: 12 },
        { day: 'Mon', hour: '10', load: 30 },
        { day: 'Tue', hour: '9', load: 18 },
    ],
    xBy: 'hour',
    yBy: 'day',
    value: 'load',
    xCategories: ['9', '10'],
    yCategories: ['Mon', 'Tue'],
});