Skip to content

DefaultHeatmapTooltip API

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

Demos

Import

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

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

Props

NameTypeDescription
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 axis.

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 nameRule nameDescription
.MuiDefaultHeatmapTooltip-cellcellStyles applied to the cell element.
.MuiDefaultHeatmapTooltip-labelCelllabelCellStyles applied to the labelCell element.
.MuiDefaultHeatmapTooltip-markmarkStyles applied to the mark element.
.MuiDefaultHeatmapTooltip-markCellmarkCellStyles applied to the markCell element.
.MuiDefaultHeatmapTooltip-rootrootStyles applied to the root element.
.MuiDefaultHeatmapTooltip-rowrowStyles applied to the row element.
.MuiDefaultHeatmapTooltip-tabletableStyles applied to the table element.
.MuiDefaultHeatmapTooltip-valueCellvalueCellStyles applied to the valueCell element.

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