HeatmapSeries API
Extended documentation for the HeatmapSeries interface with detailed information on the module's properties and available APIs.
Demos
Import
import { HeatmapSeries } from '@mui/x-charts-premium'
// or
import { HeatmapSeries } from '@mui/x-charts-pro'Data associated to each cell in the heatmap.
Each entry is a tuple [xIndex, yIndex, value].
Type:readonly HeatmapValueType[]
The scope to apply when the series is highlighted.
Type:HighlightScope<SeriesType>
The label to display on the tooltip or the legend. It can be a string or a function.
Type:string | ((location: 'tooltip' | 'legend') => string)
Defines the mark type for the series.
There is a default mark type for each series type.
Type:ChartsLabelMarkType
Function that formats values to be displayed in a tooltip.
Type:(value: number | null, context: { xIndex: number; yIndex: number }) => string | null