Scatter API

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

Import

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

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

Props

Name	Type	Description
color*	string
colorGetter*	func	Function to get the color of a scatter item given its data index. The data index argument is optional. If not provided, the color for the entire series is returned. If provided, the color for the specific scatter item is returned. Signature:`function(dataIndex: number \| undefined) => string`
series*	DefaultizedScatterSeriesType
xScale*	func \| func \| func \| func \| func \| func \| func
yScale*	func \| func \| func \| func \| func \| func \| func
classes	Partial	See CSS classes API below for more details.
onItemClick	func	Callback fired when clicking on a scatter item. Signature:`function(event: MouseEvent, scatterItemIdentifier: ScatterItemIdentifier) => void` `event` Mouse event recorded on the element. `scatterItemIdentifier` The scatter item identifier.
slotProps	ScatterSlotProps
slots	ScatterSlots	See Slots API below for more details.

The component cannot hold a ref.

Slots

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

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
.MuiScatter-focusedMark	focusedMark	Styles applied to the focused scatter mark element.
.MuiScatter-marker	marker	Styles applied to an individual scatter marker element. Not applied when using the `svg-batch` renderer.
.MuiScatter-root	root	Styles applied to the scatter plot element.
.MuiScatter-series	series	Styles applied to the group surrounding a series' scatter elements.

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.