ScatterPlot API

API reference docs for the React ScatterPlot 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 { ScatterPlot } from '@mui/x-charts/ScatterChart';
// or
import { ScatterPlot } from '@mui/x-charts';
// or
import { ScatterPlot } from '@mui/x-charts-pro';

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

Props

Name Type Default Description

onItemClick

Name	Type	Default	Description
onItemClick	func	-	Callback fired when clicking on a scatter item. Signature:`function(event: MouseEvent, scatterItemIdentifier: ScatterItemIdentifier) => void` `event` Mouse event recorded on the `<svg/>` element. `scatterItemIdentifier` The scatter item identifier.
slotProps	object	{}	The props used for each component slot.
slots	object	{}	Overridable component slots. See Slots API below for more details.

func

Callback fired when clicking on a scatter item.

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

event Mouse event recorded on the <svg/> element.
scatterItemIdentifier The scatter item identifier.

slotProps

object

{}

The props used for each component slot.

slots

object

{}

Overridable component slots.

See Slots API below for more details.

The component cannot hold a ref.

Slots

Slot name	Class name	Default component	Description
marker		`ScatterMarker`	The component that renders the marker for a scatter point.
scatter

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.