ScatterSeries API
Extended documentation for the ScatterSeries interface with detailed information on the module's properties and available APIs.
Demos
Import
import { ScatterSeries } from '@mui/x-charts-premium'
// or
import { ScatterSeries } from '@mui/x-charts-pro'
// or
import { ScatterSeries } from '@mui/x-charts'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
}
If true, the interaction will not use element hover for this series.
Type:boolean
Default:false
The label to display on the tooltip or the legend. It can be a string or a function.
Type:string | ((location: 'tooltip' | 'legend') => string)
Defines the mark type for the series.
There is a default mark type for each series type.
Type:ChartsLabelMarkType
Type:{
/**
* The size of the preview marker in pixels.
* @default 1
*/
markerSize?: number
}
Formatter used to render values in tooltip or other data display.
Type:SeriesValueFormatter<TValue>