ChartsBrushOverlay API

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

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

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

Component that renders visual feedback during brush interaction

Props

Name	Type	Description
className	string	A CSS class name applied to the root element.

The component cannot hold a ref.

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.