DefaultHeatmapTooltip API

API reference docs for the React DefaultHeatmapTooltip 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:

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

Name	Type	Description
classes*	object	Override or extend the styles applied to the component. See CSS classes API below for more details.
getColor*	func	Get the color of the item with index `dataIndex`. Signature:`function(dataIndex: number) => string` `dataIndex` The data index of the item. Returns: The color to display.
itemData*	{ dataIndex: number, seriesId: number \| string, type: 'heatmap' }	The data used to identify the triggered item.
series*	object	The series linked to the triggered item.

The component cannot hold a ref.

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
.MuiDefaultHeatmapTooltip-cell	cell	Styles applied to the cell element.
.MuiDefaultHeatmapTooltip-labelCell	labelCell	Styles applied to the labelCell element.
.MuiDefaultHeatmapTooltip-mark	mark	Styles applied to the mark element.
.MuiDefaultHeatmapTooltip-markCell	markCell	Styles applied to the markCell element.
.MuiDefaultHeatmapTooltip-paper	paper	Styles applied to the paper element.
.MuiDefaultHeatmapTooltip-root	root	Styles applied to the root element.
.MuiDefaultHeatmapTooltip-row	row	Styles applied to the row element.
.MuiDefaultHeatmapTooltip-table	table	Styles applied to the table element.
.MuiDefaultHeatmapTooltip-valueCell	valueCell	Styles applied to the valueCell element.

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.

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