Skip to content

LineSeriesType API

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

Demos

Import

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

Properties

Type:'line'


Optional

Type:boolean


Optional

The value of the line at the base of the series area.

- 'min' the area will fill the space under the line.
- 'max' the area will fill the space above the line.
- number the area will fill the space between this value and the line

Type:number | 'min' | 'max'

Default:0


Optional

Type:string


Optional

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

Type:boolean

Default:false


Optional

The type of curve to use for the line.
Read more about curves at line interpolation.

Type:CurveType

Default:'monotoneX'


Optional

Data associated to the line.

Type:(number | null)[]


Optional

The key used to retrieve data from the dataset.

Type:string


Optional

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

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

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)


Optional

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

Type:string


Optional

Defines how stacked series handle negative values.

Type:StackOffsetType

Default:'none'


Optional

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

Type:StackOrderType

Default:'none'


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 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 y-axis used to render the series.

Type:string