ChartsVoronoiHandler API

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

Component demos

For examples and details on the usage of this React component, visit the component demo pages:

Charts - Scatter
Charts - Scatter demonstration

Import

import { ChartsVoronoiHandler } from '@mui/x-charts/ChartsVoronoiHandler';
// or
import { ChartsVoronoiHandler } from '@mui/x-charts';

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

Props

onItemClick

Callback fired when clicking on a scatter item.

Type:func

Signature:

function(event: MouseEvent, scatterItemIdentifier: ScatterItemIdentifier) => void

event Mouse event catched at the svg level
scatterItemIdentifier Identify whihc item got clicked

voronoiMaxRadius

Defines the maximal distance between a scatter point and the pointer that triggers the interaction. If undefined, the radius is assumed to be infinite.

Type:number

Default:undefined

The component cannot hold a ref.