HeatmapPlot API
API reference docs for the React HeatmapPlot component. Learn about the props, CSS, and other APIs of this exported module.
Demos
Import
import { HeatmapPlot } from '@mui/x-charts-pro/Heatmap';
// or
import { HeatmapPlot } from '@mui/x-charts-pro';Learn about the difference by reading this guide on minimizing bundle size.
Props of the native component are also available.
| Name | Type | Default | Description |
|---|---|---|---|
| borderRadius | number | - | The border radius of the heatmap cells in pixels. |
| className | string | - | A CSS class name applied to the root element. |
| slotProps | object | {} | The props used for each component slot. |
| slots | object | {} | Overridable component slots. See Slots API below for more details. |
The component cannot hold a ref.
| Slot name | Class name | Default component | Description |
|---|---|---|---|
| cell | HeatmapCell | The component that renders the heatmap cell. |
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.