Heatmap API

API reference docs for the React Heatmap component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Charts - Heatmap

Import

import { Heatmap } from '@mui/x-charts-pro/Heatmap';
// or
import { Heatmap } from '@mui/x-charts-pro';

Learn about the difference by reading this guide on minimizing bundle size.

Props

Name	Type	Default	Description
series*	Array<object>	-	The series to display in the bar chart. An array of HeatmapSeriesType objects.
xAxis*	Array<{ barGapRatio?: number, categoryGapRatio?: number, classes?: object, colorMap?: { colors: Array<string>, type: 'ordinal', unknownColor?: string, values?: Array<Date \| number \| string> } \| { color: Array<string> \| func, max?: Date \| number, min?: Date \| number, type: 'continuous' } \| { colors: Array<string>, thresholds: Array<Date \| number>, type: 'piecewise' }, data?: array, dataKey?: string, disableLine?: bool, disableTicks?: bool, fill?: string, hideTooltip?: bool, id?: number \| string, label?: string, labelFontSize?: number, labelStyle?: object, max?: Date \| number, min?: Date \| number, position?: 'bottom' \| 'top', reverse?: bool, scaleType?: 'band', slotProps?: object, slots?: object, stroke?: string, sx?: Array<func \| object \| bool> \| func \| object, tickFontSize?: number, tickInterval?: 'auto' \| array \| func, tickLabelInterval?: 'auto' \| func, tickLabelPlacement?: 'middle' \| 'tick', tickLabelStyle?: object, tickMaxStep?: number, tickMinStep?: number, tickNumber?: number, tickPlacement?: 'end' \| 'extremities' \| 'middle' \| 'start', tickSize?: number, valueFormatter?: func, zoom?: { filterMode?: 'discard' \| 'keep', maxEnd?: number, maxSpan?: number, minSpan?: number, minStart?: number, panning?: bool, step?: number } \| bool }>	-	The configuration of the x-axes. If not provided, a default axis config is used. An array of AxisConfig objects.
yAxis*	Array<{ barGapRatio?: number, categoryGapRatio?: number, classes?: object, colorMap?: { colors: Array<string>, type: 'ordinal', unknownColor?: string, values?: Array<Date \| number \| string> } \| { color: Array<string> \| func, max?: Date \| number, min?: Date \| number, type: 'continuous' } \| { colors: Array<string>, thresholds: Array<Date \| number>, type: 'piecewise' }, data?: array, dataKey?: string, disableLine?: bool, disableTicks?: bool, fill?: string, hideTooltip?: bool, id?: number \| string, label?: string, labelFontSize?: number, labelStyle?: object, max?: Date \| number, min?: Date \| number, position?: 'left' \| 'right', reverse?: bool, scaleType?: 'band', slotProps?: object, slots?: object, stroke?: string, sx?: Array<func \| object \| bool> \| func \| object, tickFontSize?: number, tickInterval?: 'auto' \| array \| func, tickLabelInterval?: 'auto' \| func, tickLabelPlacement?: 'middle' \| 'tick', tickLabelStyle?: object, tickMaxStep?: number, tickMinStep?: number, tickNumber?: number, tickPlacement?: 'end' \| 'extremities' \| 'middle' \| 'start', tickSize?: number, valueFormatter?: func, zoom?: { filterMode?: 'discard' \| 'keep', maxEnd?: number, maxSpan?: number, minSpan?: number, minStart?: number, panning?: bool, step?: number } \| bool }>	-	The configuration of the y-axes. If not provided, a default axis config is used. An array of AxisConfig objects.
bottomAxis	object \| string	xAxisIds[0] The id of the first provided axis	Indicate which axis to display the bottom of the charts. Can be a string (the id of the axis) or an object `ChartsXAxisProps`.
colors	Array<string> \| func	blueberryTwilightPalette	Color palette used to colorize multiple series.
dataset	Array<object>	-	An array of objects that can be used to populate series and axes data using their `dataKey` property.
disableAxisListener	bool	false	If `true`, the charts will not listen to the mouse move event. It might break interactive features, but will improve performance.
height	number	-	The height of the chart in px. If not defined, it takes the height of the parent element.
highlightedItem	{ dataIndex?: number, seriesId?: number \| string }	-	The item currently highlighted. Turns highlighting into a controlled prop.
leftAxis	object \| string	yAxisIds[0] The id of the first provided axis	Indicate which axis to display the left of the charts. Can be a string (the id of the axis) or an object `ChartsYAxisProps`.
loading	bool	false	If `true`, a loading overlay is displayed.
margin	{ bottom?: number, left?: number, right?: number, top?: number }	object Depends on the charts type.	The margin between the SVG and the drawing area. It's used for leaving some space for extra information such as the x- and y-axis or legend. Accepts an object with the optional properties: `top`, `bottom`, `left`, and `right`.
onAxisClick	func	-	The function called for onClick events. The second argument contains information about all line/bar elements at the current mouse position. Signature:`function(event: MouseEvent, data: null \| AxisData) => void` `event` The mouse event recorded on the `<svg/>` element. `data` The data about the clicked axis and items associated with it.
onHighlightChange	func	-	The callback fired when the highlighted item changes. Signature:`function(highlightedItem: HighlightItemData \| null) => void` `highlightedItem` The newly highlighted item.
resolveSizeBeforeRender	bool	false	The chart will try to wait for the parent container to resolve its size before it renders for the first time. This can be useful in some scenarios where the chart appear to grow after the first render, like when used inside a grid.
rightAxis	object \| string	null	Indicate which axis to display the right of the charts. Can be a string (the id of the axis) or an object `ChartsYAxisProps`.
slotProps	object	{}	The props used for each component slot.
slots	object	{}	Overridable component slots. See Slots API below for more details.
tooltip	{ axisContent?: elementType, classes?: object, itemContent?: elementType, slotProps?: object, slots?: object, trigger?: 'axis' \| 'item' \| 'none' }	-	The configuration of the tooltip. See tooltip docs for more details.
topAxis	object \| string	null	Indicate which axis to display the top of the charts. Can be a string (the id of the axis) or an object `ChartsXAxisProps`.
width	number	-	The width of the chart in px. If not defined, it takes the width of the parent element.
zAxis	Array<{ colorMap?: { colors: Array<string>, type: 'ordinal', unknownColor?: string, values?: Array<Date \| number \| string> } \| { color: Array<string> \| func, max?: Date \| number, min?: Date \| number, type: 'continuous' } \| { colors: Array<string>, thresholds: Array<Date \| number>, type: 'piecewise' }, data?: array, dataKey?: string, id?: string, max?: number, min?: number }>	-	The configuration of the z-axes.

The component cannot hold a ref.

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class name	Rule name	Description
.MuiHeatmap-cell	cell	Styles applied to the heatmap cells.
.MuiHeatmap-faded	faded	Styles applied to the cell element if faded.
.MuiHeatmap-highlighted	highlighted	Styles applied to the cell element if highlighted.

You can override the style of the component using one of these customization options:

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.