import { HeatmapSeries } from '@wick-charts/react';
 
<HeatmapSeries data={heatmapData} />

Matrix heatmap series. Cells map (x, y) category keys onto a sequential color ramp derived from the theme (override via options.colors).

Renders a matrix heatmap — (x, y) category cells colored by value on a perceptual (OKLab) sequential ramp derived from the theme. Cells reveal with a diagonal entrance wave, morph smoothly when values update in place, and lift on hover. Pass 3 ramp stops via options.colors for a diverging scale. Use <HeatmapTooltip> for the hover overlay.

Props

dataHeatmapCellData[]

Cells to render. A flat array of { x, y, value, color? } entries.

xstring

Column key. Cells sharing an x stack into one column.

ystring

Row key. Cells sharing a y line up in one row.

valuenumber

Magnitude mapped onto the sequential color ramp between the domain min and max.

color?string

Override fill for this cell. Skips the ramp entirely.

options?Partial<HeatmapSeriesOptions>

Visual options override — ramp colors, gaps, labels, animation durations.

id?string

Stable series ID — same value across remounts.

visible?default trueboolean

Show/hide the series without unmounting it — excludes it from the Y-range fit and tooltip/legend. Default true. Live.