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-pro'
// or
import { LineSeriesType } from '@mui/x-charts'
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
If true
, line and area connect points separated by null
values.
Type:boolean
Default:false
The type of curve to use for the line.
Read more about curves at line interpolation.
Type:CurveType
Default:'monotoneX'
Do not render the line highlight item if set to true
.
Type:boolean
Default:false
The scope to apply when the series is highlighted.
Type:Partial<HighlightScope>
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:ChartsLabelMarkProps['type']
The shape of the mark elements.
Using 'circle' renders a <circle />
element, while all other options render a <path />
instead. The path causes a small decrease in performance.
Type:'circle' | 'cross' | 'diamond' | 'square' | 'star' | 'triangle' | 'wye'
Default:'circle'
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)
The key that identifies the stacking group.
Series with the same stack
property will be stacked together.
Type:string
Defines how stacked series handle negative values.
Type:StackOffsetType
Default:'none'
The order in which series' of the same group are stacked together.
Type:StackOrderType
Default:'none'
If true
, step curve starts and end at the first and last point.
By default the line is extended to fill the space before and after.
Type:boolean
Formatter used to render values in tooltip or other data display.
Type:SeriesValueFormatter<TValue>