Skip to content

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-pro'

Properties

Type:'heatmap'

Optional

Data associated to each bar.

Type:readonly HeatmapValueType[]

Optional

The key used to retrieve data from the dataset.

Type:string

Optional

The scope to apply when the series is highlighted.

Type:HighlightScope

Optional

The id of this series.

Type:SeriesId

Optional

The label to display on the tooltip or the legend. It can be a string or a function.

Type:string | ((location: 'tooltip' | 'legend') => string)

Optional

Defines the mark type for the series.

There is a default mark type for each series type.

Type:ChartsLabelMarkType

Optional

Formatter used to render values in tooltip or other data display.

Type:SeriesValueFormatter<TValue>

Optional

The id of the x-axis used to render the series.

Type:string

Optional

The id of the y-axis used to render the series.

Type:string