Skip to content
TrademarkTrademark
Docs
Data

Heatmap

Updated: November 16, 2026
View on GitHub

Heatmap draws one row per row of data and one cell per column you name, each cell in one of five steps of a single hue against the largest value in the grid. Use it to find patterns across two periods, like which months pay out in which years. Empty, zero and negative cells stay neutral: a heatmap shows how much, not which way (DivergingBars shows direction). It takes the card, title, description, valueFormat, locale, tooltip, loading, error, emptyState and errorState the other charts take.

columns lists row keys, left to right, or { key, label } when the heading should read differently from the key. rowKey names the key each row's name comes from ("label" by default). Each cell's hover card and accessible name say its row, its column and its value, or "No data".

Colour and scale

The cells are emerald by default; color takes any palette name or CSS colour. The scale under the grid reads "Less" to "More": rename its ends with legend={{ less: "Kevesebb", more: "Több" }}, or hide it with legend={{ display: false }}.

API reference

Type
Default
title
React.ReactNode—
description
React.ReactNode—
valueFormat
numbercompactpercentNumberFormatOptions(value: number) => string
—
locale
string—
tooltip
booleantrue
loading
boolean—
error
boolean—
emptyState
React.ReactNode—
errorState
React.ReactNode—
aria-label
string—
datarequired
One row per line of cells: a year, a client, a weekday.
readonly DataPoint[]—
columnsrequired
The columns, left to right, as row keys or { key, label }.
readonly (SeriesKey<DataPoint> | HeatmapColumn<DataPoint>)[]—
rowKey
The row key that names each row. Defaults to "label".
SeriesKey<DataPoint>"label" as SeriesKey<T>
color
The hue the cells are drawn in. Defaults to emerald.
ColorValue—
legend
The scale under the grid: display, and the less and more labels.
{ display?: boolean; less?: string; more?: string }—
…and every FlexProps propinherited—
Edit this page on GitHub