Skip to content

ScatterSeriesType API

Extended documentation for the ScatterSeriesType interface with detailed information on the module's properties and available APIs.

Demos

Import

import { ScatterSeriesType } from '@mui/x-charts-pro'
// or
import { ScatterSeriesType } from '@mui/x-charts'

Properties

Type:'scatter'


Optional

Type:string


Optional

Type:ScatterValueType[]


Optional

The keys used to retrieve data from the dataset.

When this prop is provided, all of x, y, and id must be provided.
While z is optional.

Type:{
/**
* The key used to retrieve data from the dataset for the X axis.
*/
x: string
/**
* The key used to retrieve data from the dataset for the Y axis.
*/
y: string
/**
* The key used to retrieve data from the dataset for the Z axis.
*/
z?: string
/**
* The key used to retrieve data from the dataset for the id.
*/
id: string
}


Optional

If true, the interaction will not use element hover for this series.

Type:boolean

Default:false


Optional

The scope to apply when the series is highlighted.

Type:Partial<HighlightScope>


Optional

Type:SeriesId


Optional

The label to display on the tooltip or the legend. It can be a string or a function.

Type:string | ((location: 'tooltip' | 'legend') => string)


Optional

Type:number


Optional

Formatter used to render values in tooltip or other data display.

Type:SeriesValueFormatter<TValue>


Optional

The id of the x-axis used to render the series.

Type:string


Optional

The id of the y-axis used to render the series.

Type:string


Optional

The id of the z-axis used to render the series.

Type:string