Skip to content

LineSeriesType API

Demos

Import

import { LineSeriesType } from '@mui/x-charts'

Properties

type

Type:'line'

areaOptional

Type:boolean

colorOptional

Type:string

connectNullsOptional

If true, line and area connect points separated by null values.

Type:boolean

Default:false

curveOptional

Type:CurveType

dataOptional

Data associated to the line.

Type:(number | null)[]

dataKeyOptional

The key used to retrieve data from the dataset.

Type:string

disableHighlightOptional

Do not render the line highlight item if set to true.

Type:boolean

Default:false

highlightScopeOptional

The scope to apply when the series is highlighted.

Type:Partial<HighlightScope>

idOptional

Type:SeriesId

labelOptional

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

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

showMarkOptional

Define which items of the series should display a mark.
If can be a boolean that applies to all items.
Or a callback that gets some item properties and returns true if the item should be displayed.

Type:boolean | ((params: ShowMarkParams) => boolean)

stackOptional

The key that identifies the stacking group.
Series with the same stack property will be stacked together.

Type:string

stackOffsetOptional

Defines how stacked series handle negative values.

Type:StackOffsetType

Default:'none'

stackOrderOptional

The order in which series' of the same group are stacked together.

Type:StackOrderType

Default:'none'

valueFormatterOptional

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

Type:SeriesValueFormatter<TValue>

xAxisKeyOptional

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

Type:string

yAxisKeyOptional

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

Type:string