Interface: LineControllerDatasetOptions

Hierarchy

• ControllerDatasetOptions

• ScriptableAndArrayOptions<PointPrefixedOptions, ScriptableContext<line>>

• ScriptableOptions<LineOptions, ScriptableContext<line>>

• AnimationOptions<line>

  ↳ LineControllerDatasetOptions

Properties

animation

• animation: false | AnimationSpec<line> & { onComplete?: (event: AnimationEvent) => void ; onProgress?: (event: AnimationEvent) => void }

Inherited from: AnimationOptions.animation

Defined in: index.esm.d.ts:1533 (opens new window)

animations

• animations: AnimationsSpec<line>

Inherited from: AnimationOptions.animations

Defined in: index.esm.d.ts:1543 (opens new window)

backgroundColor

• backgroundColor: Scriptable<Color, ScriptableContext<line>>

Inherited from: ScriptableOptions.backgroundColor

Defined in: index.esm.d.ts:1588 (opens new window)

borderCapStyle

• borderCapStyle: Scriptable<CanvasLineCap, ScriptableContext<line>>

Line cap style. See MDN.

default ‘butt’

Inherited from: ScriptableOptions.borderCapStyle

Defined in: index.esm.d.ts:1656 (opens new window)

borderColor

• borderColor: Scriptable<Color, ScriptableContext<line>>

Inherited from: ScriptableOptions.borderColor

Defined in: index.esm.d.ts:1587 (opens new window)

borderDash

• borderDash: Scriptable<number[], ScriptableContext<line>>

Line dash. See MDN.

default []

Inherited from: ScriptableOptions.borderDash

Defined in: index.esm.d.ts:1661 (opens new window)

borderDashOffset

• borderDashOffset: Scriptable<number, ScriptableContext<line>>

Line dash offset. See MDN.

default 0.0

Inherited from: ScriptableOptions.borderDashOffset

Defined in: index.esm.d.ts:1666 (opens new window)

borderJoinStyle

• borderJoinStyle: Scriptable<CanvasLineJoin, ScriptableContext<line>>

Line join style. See MDN.

default ‘miter’

Inherited from: ScriptableOptions.borderJoinStyle

Defined in: index.esm.d.ts:1671 (opens new window)

borderWidth

• borderWidth: Scriptable<number, ScriptableContext<line>>

Inherited from: ScriptableOptions.borderWidth

Defined in: index.esm.d.ts:1586 (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: index.esm.d.ts:1676 (opens new window)

clip

• clip: number | 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: ControllerDatasetOptions.clip

Defined in: index.esm.d.ts:64 (opens new window)

cubicInterpolationMode

• cubicInterpolationMode: Scriptable<default | monotone, ScriptableContext<line>>

Interpolation mode to apply.

default ‘default’

Inherited from: ScriptableOptions.cubicInterpolationMode

Defined in: index.esm.d.ts:1681 (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: index.esm.d.ts:82 (opens new window)

hoverBackgroundColor

• hoverBackgroundColor: Scriptable<Color, ScriptableContext<line>>

Inherited from: ScriptableOptions.hoverBackgroundColor

Defined in: index.esm.d.ts:1594 (opens new window)

hoverBorderCapStyle

• hoverBorderCapStyle: Scriptable<CanvasLineCap, ScriptableContext<line>>

Inherited from: ScriptableOptions.hoverBorderCapStyle

Defined in: index.esm.d.ts:1705 (opens new window)

hoverBorderColor

• hoverBorderColor: Scriptable<Color, ScriptableContext<line>>

Inherited from: ScriptableOptions.hoverBorderColor

Defined in: index.esm.d.ts:1593 (opens new window)

hoverBorderDash

• hoverBorderDash: Scriptable<number[], ScriptableContext<line>>

Inherited from: ScriptableOptions.hoverBorderDash

Defined in: index.esm.d.ts:1706 (opens new window)

hoverBorderDashOffset

• hoverBorderDashOffset: Scriptable<number, ScriptableContext<line>>

Inherited from: ScriptableOptions.hoverBorderDashOffset

Defined in: index.esm.d.ts:1707 (opens new window)

hoverBorderJoinStyle

• hoverBorderJoinStyle: Scriptable<CanvasLineJoin, ScriptableContext<line>>

Inherited from: ScriptableOptions.hoverBorderJoinStyle

Defined in: index.esm.d.ts:1708 (opens new window)

hoverBorderWidth

• hoverBorderWidth: Scriptable<number, ScriptableContext<line>>

Inherited from: ScriptableOptions.hoverBorderWidth

Defined in: index.esm.d.ts:1592 (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: index.esm.d.ts:60 (opens new window)

label

• label: string

The label for the dataset which appears in the legend and tooltips.

Inherited from: ControllerDatasetOptions.label

Defined in: index.esm.d.ts:68 (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: index.esm.d.ts:52 (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: index.esm.d.ts:72 (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: index.esm.d.ts:43 (opens new window)

pointBackgroundColor

• pointBackgroundColor: ScriptableAndArray<Color, ScriptableContext<line>>

The fill color for points.

Inherited from: ScriptableAndArrayOptions.pointBackgroundColor

Defined in: index.esm.d.ts:1783 (opens new window)

pointBorderColor

• pointBorderColor: ScriptableAndArray<Color, ScriptableContext<line>>

The border color for points.

Inherited from: ScriptableAndArrayOptions.pointBorderColor

Defined in: index.esm.d.ts:1787 (opens new window)

pointBorderWidth

• pointBorderWidth: ScriptableAndArray<number, ScriptableContext<line>>

The width of the point border in pixels.

Inherited from: ScriptableAndArrayOptions.pointBorderWidth

Defined in: index.esm.d.ts:1791 (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: index.esm.d.ts:1795 (opens new window)

pointHoverBackgroundColor

• pointHoverBackgroundColor: ScriptableAndArray<Color, ScriptableContext<line>>

Point background color when hovered.

Inherited from: ScriptableAndArrayOptions.pointHoverBackgroundColor

Defined in: index.esm.d.ts:1814 (opens new window)

pointHoverBorderColor

• pointHoverBorderColor: ScriptableAndArray<Color, ScriptableContext<line>>

Point border color when hovered.

Inherited from: ScriptableAndArrayOptions.pointHoverBorderColor

Defined in: index.esm.d.ts:1818 (opens new window)

pointHoverBorderWidth

• pointHoverBorderWidth: ScriptableAndArray<number, ScriptableContext<line>>

Border width of point when hovered.

Inherited from: ScriptableAndArrayOptions.pointHoverBorderWidth

Defined in: index.esm.d.ts:1822 (opens new window)

pointHoverRadius

• pointHoverRadius: ScriptableAndArray<number, ScriptableContext<line>>

The radius of the point when hovered.

Inherited from: ScriptableAndArrayOptions.pointHoverRadius

Defined in: index.esm.d.ts:1826 (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: index.esm.d.ts:1799 (opens new window)

pointRotation

• pointRotation: ScriptableAndArray<number, ScriptableContext<line>>

The rotation of the point in degrees.

Inherited from: ScriptableAndArrayOptions.pointRotation

Defined in: index.esm.d.ts:1803 (opens new window)

pointStyle

• pointStyle: ScriptableAndArray<PointStyle, ScriptableContext<line>>

Style of the point.

Inherited from: ScriptableAndArrayOptions.pointStyle

Defined in: index.esm.d.ts:1807 (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: index.esm.d.ts:1693 (opens new window)

showLine

• showLine: boolean

Defined in: index.esm.d.ts:195 (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

Defined in: index.esm.d.ts:193 (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: index.esm.d.ts:77 (opens new window)

stepped

• stepped: Scriptable<boolean | before | after | middle, ScriptableContext<line>>

true to show the line as a stepped line (tension will be ignored).

default false

Inherited from: ScriptableOptions.stepped

Defined in: index.esm.d.ts:1691 (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: index.esm.d.ts:1686 (opens new window)

transitions

• transitions: TransitionsSpec<line>

Inherited from: AnimationOptions.transitions

Defined in: index.esm.d.ts:1544 (opens new window)

xAxisID

• xAxisID: string

The ID of the x axis to plot this dataset on.

Defined in: index.esm.d.ts:183 (opens new window)

yAxisID

• yAxisID: string

The ID of the y axis to plot this dataset on.

Defined in: index.esm.d.ts:187 (opens new window)