# Interface: LineControllerDatasetOptions
# Hierarchy
ScriptableAndArrayOptions<PointPrefixedOptions,ScriptableContext<"line">>ScriptableAndArrayOptions<PointPrefixedHoverOptions,ScriptableContext<"line">>ScriptableOptions<Omit<LineOptions, keyofCommonElementOptions>,ScriptableContext<"line">>ScriptableAndArrayOptions<CommonElementOptions,ScriptableContext<"line">>ScriptableOptions<Omit<LineHoverOptions, keyofCommonHoverOptions>,ScriptableContext<"line">>ScriptableAndArrayOptions<CommonHoverOptions,ScriptableContext<"line">>AnimationOptions<"line">↳
LineControllerDatasetOptions
# Properties
# animation
• animation: false | AnimationSpec<"line"> & { onComplete?: (this: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, event: AnimationEvent) => void ; onProgress?: (this: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, event: AnimationEvent) => void }
# Inherited from
AnimationOptions.animation
# Defined in
types/index.d.ts:1757 (opens new window)
# animations
• animations: AnimationsSpec<"line">
# Inherited from
AnimationOptions.animations
# Defined in
types/index.d.ts:1767 (opens new window)
# backgroundColor
• backgroundColor: ScriptableAndArray<Color, ScriptableContext<"line">>
# Inherited from
ScriptableAndArrayOptions.backgroundColor
# Defined in
types/index.d.ts:1817 (opens new window)
# borderCapStyle
• borderCapStyle: Scriptable<CanvasLineCap, ScriptableContext<"line">>
Line cap style. See MDN.
Default
'butt'
# Inherited from
ScriptableOptions.borderCapStyle
# Defined in
types/index.d.ts:1897 (opens new window)
# borderColor
• borderColor: ScriptableAndArray<Color, ScriptableContext<"line">>
# Inherited from
ScriptableAndArrayOptions.borderColor
# Defined in
types/index.d.ts:1816 (opens new window)
# borderDash
• borderDash: Scriptable<number[], ScriptableContext<"line">>
Line dash. See MDN.
Default
[]
# Inherited from
ScriptableOptions.borderDash
# Defined in
types/index.d.ts:1902 (opens new window)
# borderDashOffset
• borderDashOffset: Scriptable<number, ScriptableContext<"line">>
Line dash offset. See MDN.
Default
0.0
# Inherited from
ScriptableOptions.borderDashOffset
# Defined in
types/index.d.ts:1907 (opens new window)
# borderJoinStyle
• borderJoinStyle: Scriptable<CanvasLineJoin, ScriptableContext<"line">>
Line join style. See MDN.
Default
'miter'
# Inherited from
ScriptableOptions.borderJoinStyle
# Defined in
types/index.d.ts:1912 (opens new window)
# borderWidth
• borderWidth: ScriptableAndArray<number, ScriptableContext<"line">>
# Inherited from
ScriptableAndArrayOptions.borderWidth
# Defined in
types/index.d.ts:1815 (opens new window)
# capBezierPoints
• capBezierPoints: Scriptable<boolean, ScriptableContext<"line">>
true to keep Bézier control inside the chart, false for no restriction.
Default
true
# Inherited from
ScriptableOptions.capBezierPoints
# Defined in
types/index.d.ts:1917 (opens new window)
# clip
• clip: number | false | ChartArea
How to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside chartArea. 0 = clip at chartArea. Clipping can also be configured per side: clip: {left: 5, top: false, right: -2, bottom: 0}
# Inherited from
# Defined in
types/index.d.ts:75 (opens new window)
# cubicInterpolationMode
• cubicInterpolationMode: Scriptable<"default" | "monotone", ScriptableContext<"line">>
Interpolation mode to apply.
Default
'default'
# Inherited from
ScriptableOptions.cubicInterpolationMode
# Defined in
types/index.d.ts:1922 (opens new window)
# fill
• fill: Scriptable<FillTarget | ComplexFillTarget, ScriptableContext<"line">>
Both line and radar charts support a fill option on the dataset object which can be used to create area between two datasets or a dataset and a boundary, i.e. the scale origin, start or end
# Inherited from
ScriptableOptions.fill
# Defined in
types/index.d.ts:1936 (opens new window)
# hidden
• hidden: boolean
Configures the visibility state of the dataset. Set it to true, to hide the dataset from the chart.
Default
false
# Inherited from
ControllerDatasetOptions.hidden
# Defined in
types/index.d.ts:93 (opens new window)
# hoverBackgroundColor
• hoverBackgroundColor: ScriptableAndArray<Color, ScriptableContext<"line">>
# Inherited from
ScriptableAndArrayOptions.hoverBackgroundColor
# Defined in
types/index.d.ts:1823 (opens new window)
# hoverBorderCapStyle
• hoverBorderCapStyle: Scriptable<CanvasLineCap, ScriptableContext<"line">>
# Inherited from
ScriptableOptions.hoverBorderCapStyle
# Defined in
types/index.d.ts:1954 (opens new window)
# hoverBorderColor
• hoverBorderColor: ScriptableAndArray<Color, ScriptableContext<"line">>
# Inherited from
ScriptableAndArrayOptions.hoverBorderColor
# Defined in
types/index.d.ts:1822 (opens new window)
# hoverBorderDash
• hoverBorderDash: Scriptable<number[], ScriptableContext<"line">>
# Inherited from
ScriptableOptions.hoverBorderDash
# Defined in
types/index.d.ts:1955 (opens new window)
# hoverBorderDashOffset
• hoverBorderDashOffset: Scriptable<number, ScriptableContext<"line">>
# Inherited from
ScriptableOptions.hoverBorderDashOffset
# Defined in
types/index.d.ts:1956 (opens new window)
# hoverBorderJoinStyle
• hoverBorderJoinStyle: Scriptable<CanvasLineJoin, ScriptableContext<"line">>
# Inherited from
ScriptableOptions.hoverBorderJoinStyle
# Defined in
types/index.d.ts:1957 (opens new window)
# hoverBorderWidth
• hoverBorderWidth: ScriptableAndArray<number, ScriptableContext<"line">>
# Inherited from
ScriptableAndArrayOptions.hoverBorderWidth
# Defined in
types/index.d.ts:1821 (opens new window)
# indexAxis
• indexAxis: "x" | "y"
The base axis of the chart. 'x' for vertical charts and 'y' for horizontal charts.
Default
'x'
# Inherited from
ControllerDatasetOptions.indexAxis
# Defined in
types/index.d.ts:71 (opens new window)
# label
• label: string
The label for the dataset which appears in the legend and tooltips.
# Inherited from
ControllerDatasetOptions.label
# Defined in
types/index.d.ts:79 (opens new window)
# normalized
• normalized: boolean
Chart.js is fastest if you provide data with indices that are unique, sorted, and consistent across datasets and provide the normalized: true option to let Chart.js know that you have done so.
# Inherited from
ControllerDatasetOptions.normalized
# Defined in
types/index.d.ts:63 (opens new window)
# order
• order: number
The drawing order of dataset. Also affects order for stacking, tooltip and legend.
# Inherited from
ControllerDatasetOptions.order
# Defined in
types/index.d.ts:83 (opens new window)
# parsing
• parsing: false | { [key: string]: string; }
How to parse the dataset. The parsing can be disabled by specifying parsing: false at chart options or dataset. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally.
# Inherited from
ControllerDatasetOptions.parsing
# Defined in
types/index.d.ts:54 (opens new window)
# pointBackgroundColor
• pointBackgroundColor: ScriptableAndArray<Color, ScriptableContext<"line">>
The fill color for points.
# Inherited from
ScriptableAndArrayOptions.pointBackgroundColor
# Defined in
types/index.d.ts:2033 (opens new window)
# pointBorderColor
• pointBorderColor: ScriptableAndArray<Color, ScriptableContext<"line">>
The border color for points.
# Inherited from
ScriptableAndArrayOptions.pointBorderColor
# Defined in
types/index.d.ts:2037 (opens new window)
# pointBorderWidth
• pointBorderWidth: ScriptableAndArray<number, ScriptableContext<"line">>
The width of the point border in pixels.
# Inherited from
ScriptableAndArrayOptions.pointBorderWidth
# Defined in
types/index.d.ts:2041 (opens new window)
# pointHitRadius
• pointHitRadius: ScriptableAndArray<number, ScriptableContext<"line">>
The pixel size of the non-displayed point that reacts to mouse events.
# Inherited from
ScriptableAndArrayOptions.pointHitRadius
# Defined in
types/index.d.ts:2045 (opens new window)
# pointHoverBackgroundColor
• pointHoverBackgroundColor: ScriptableAndArray<Color, ScriptableContext<"line">>
Point background color when hovered.
# Inherited from
ScriptableAndArrayOptions.pointHoverBackgroundColor
# Defined in
types/index.d.ts:2064 (opens new window)
# pointHoverBorderColor
• pointHoverBorderColor: ScriptableAndArray<Color, ScriptableContext<"line">>
Point border color when hovered.
# Inherited from
ScriptableAndArrayOptions.pointHoverBorderColor
# Defined in
types/index.d.ts:2068 (opens new window)
# pointHoverBorderWidth
• pointHoverBorderWidth: ScriptableAndArray<number, ScriptableContext<"line">>
Border width of point when hovered.
# Inherited from
ScriptableAndArrayOptions.pointHoverBorderWidth
# Defined in
types/index.d.ts:2072 (opens new window)
# pointHoverRadius
• pointHoverRadius: ScriptableAndArray<number, ScriptableContext<"line">>
The radius of the point when hovered.
# Inherited from
ScriptableAndArrayOptions.pointHoverRadius
# Defined in
types/index.d.ts:2076 (opens new window)
# pointRadius
• pointRadius: ScriptableAndArray<number, ScriptableContext<"line">>
The radius of the point shape. If set to 0, the point is not rendered.
# Inherited from
ScriptableAndArrayOptions.pointRadius
# Defined in
types/index.d.ts:2049 (opens new window)
# pointRotation
• pointRotation: ScriptableAndArray<number, ScriptableContext<"line">>
The rotation of the point in degrees.
# Inherited from
ScriptableAndArrayOptions.pointRotation
# Defined in
types/index.d.ts:2053 (opens new window)
# pointStyle
• pointStyle: ScriptableAndArray<PointStyle, ScriptableContext<"line">>
Style of the point.
# Inherited from
ScriptableAndArrayOptions.pointStyle
# Defined in
types/index.d.ts:2057 (opens new window)
# segment
• segment: Scriptable<{ backgroundColor: Scriptable<Color, ScriptableLineSegmentContext> ; borderCapStyle: Scriptable<CanvasLineCap, ScriptableLineSegmentContext> ; borderColor: Scriptable<Color, ScriptableLineSegmentContext> ; borderDash: Scriptable<number[], ScriptableLineSegmentContext> ; borderDashOffset: Scriptable<number, ScriptableLineSegmentContext> ; borderJoinStyle: Scriptable<CanvasLineJoin, ScriptableLineSegmentContext> ; borderWidth: Scriptable<number, ScriptableLineSegmentContext> }, ScriptableContext<"line">>
# Inherited from
ScriptableOptions.segment
# Defined in
types/index.d.ts:1942 (opens new window)
# showLine
• showLine: boolean
# Defined in
types/index.d.ts:213 (opens new window)
# spanGaps
• spanGaps: number | boolean
If true, lines will be drawn between points with no or null data. If false, points with NaN data will create a break in the line. Can also be a number specifying the maximum gap length to span. The unit of the value depends on the scale used.
Default
false
# Overrides
ScriptableOptions.spanGaps
# Defined in
types/index.d.ts:211 (opens new window)
# stack
• stack: string
The ID of the group to which this dataset belongs to (when stacked, each group will be a separate stack).
# Inherited from
ControllerDatasetOptions.stack
# Defined in
types/index.d.ts:88 (opens new window)
# stepped
• stepped: Scriptable<boolean | "middle" | "after" | "before", ScriptableContext<"line">>
true to show the line as a stepped line (tension will be ignored).
Default
false
# Inherited from
ScriptableOptions.stepped
# Defined in
types/index.d.ts:1932 (opens new window)
# tension
• tension: Scriptable<number, ScriptableContext<"line">>
Bézier curve tension (0 for no Bézier curves).
Default
0
# Inherited from
ScriptableOptions.tension
# Defined in
types/index.d.ts:1927 (opens new window)
# transitions
• transitions: TransitionsSpec<"line">
# Inherited from
AnimationOptions.transitions
# Defined in
types/index.d.ts:1768 (opens new window)
# xAxisID
• xAxisID: string
The ID of the x axis to plot this dataset on.
# Defined in
types/index.d.ts:201 (opens new window)
# yAxisID
• yAxisID: string
The ID of the y axis to plot this dataset on.