charton

Appearance

charton API

charton API / @chart-on/core / index / HeatmapSeriesOptions

Interface: HeatmapSeriesOptions ​

Defined in: packages/core/src/series.ts:3971

Options for a heatmap series (chart.addHeatmap): the colour ramp and value range, cell gap and opacity, how cells combine when zoomed out, the hover inspector and memory limits.

Properties ​

cellReduce? ​

optional cellReduce?: CellReduce

Defined in: packages/core/src/series.ts:3993

How cells combine where several fall into one device pixel (zoomed out, or many rows in a short pane): 'max' (default) shows the largest, so a thin level never vanishes as the view pans; 'sum' their total; 'nearest' only the cell at the pixel centre. Rows are exact at any depth (read from reduction levels, which memoryBudget pays for), columns up to 8 per pixel; past that, evenly spaced columns are read (a sum is scaled up to stand for the ones skipped).

colors? ​

optional colors?: string[]

Defined in: packages/core/src/series.ts:3976

Color ramp low → high; defaults to theme.heatmap.

format ​

format: (value) => string

Defined in: packages/core/src/series.ts:3996

Parameters ​

value ​

number

Returns ​

string

gap ​

gap: number

Defined in: packages/core/src/series.ts:3982

Gap between cells in css px (hidden when cells get too small).

highPercentile ​

highPercentile: number

Defined in: packages/core/src/series.ts:3980

inspector ​

inspector: boolean

Defined in: packages/core/src/series.ts:3995

Show the hover inspector grid with neighbouring cell values.

legend? ​

optional legend?: boolean

Defined in: packages/core/src/series.ts:3974

false leaves this series out of the legend. Default true.

lowPercentile ​

lowPercentile: number

Defined in: packages/core/src/series.ts:3979

maxColumns? ​

optional maxColumns?: number

Defined in: packages/core/src/series.ts:3998

Most columns kept; older ones are dropped. Default: as many as the budget and the GPU allow.

memoryBudget? ​

optional memoryBudget?: number

Defined in: packages/core/src/series.ts:4004

Bytes the grid may use, counting 8 per cell (GPU texture plus CPU copy), plus about a third more for the reduction levels unless cellReduce is 'nearest'. Lowers the column cap for tall grids. Default 256 MiB.

opacity ​

opacity: number

Defined in: packages/core/src/series.ts:3983

range? ​

optional range?: object

Defined in: packages/core/src/series.ts:3978

Fixed value range; otherwise derived from percentiles of positive values.

max ​

max: number

min ​

min: number

title ​

title: string

Defined in: packages/core/src/series.ts:3972