ScatterPlotPremium API

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

Name	Type	Default	Description
renderer*	'svg-batch' \| 'svg-single' \| 'webgl'	-	The type of renderer to use for the scatter plot. `svg-single`: Renders every scatter item in its own `<circle />` element. `svg-batch`: Renders all scatter items in a single batched SVG path. `webgl`: Renders scatter items using WebGL for better performance, at the cost of some limitations.
onItemClick	func	-	Callback fired when a marker is clicked directly. For closest-point clicks (the `ScatterChart` default), pass `onItemClick` to the chart container instead. 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.

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

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
.MuiScatterChart-focusedMark	focusedMark	Styles applied to the focused scatter mark element.
.MuiScatterChart-highlightedMark	highlightedMark	Styles applied to the highlighted scatter mark element.
.MuiScatterChart-root	root	Styles applied to the scatter plot element.
.MuiScatterChart-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.

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.