ChartsAxisHighlight API

API reference docs for the React ChartsAxisHighlight 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 - Highlighting

Import

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

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

Props

Name	Type	Description
x	'band' \| 'line' \| 'none'
y	'band' \| 'line' \| 'none'

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
.MuiChartsAxisHighlight-root	root	Styles applied to the root 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.

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.