Line

A line chart is a way of plotting data points on a line. Often, it is used to show trend data, or the comparison of two data sets.

Example Usage

  1. var myLineChart = new Chart(ctx, {
  2. type: 'line',
  3. data: data,
  4. options: options
  5. });

Dataset Properties

The line chart allows a number of properties to be specified for each dataset. These are used to set display properties for a specific dataset. For example, the colour of a line is generally set this way.

NameTypeScriptableIndexableDefault
backgroundColorColorYes-‘rgba(0, 0, 0, 0.1)’
borderCapStylestringYes-‘butt’
borderColorColorYes-‘rgba(0, 0, 0, 0.1)’
borderDashnumber[]Yes-[]
borderDashOffsetnumberYes-0.0
borderJoinStylestringYes-‘miter’
borderWidthnumberYes-3
cubicInterpolationModestringYes-‘default’
clipnumber|object--borderWidth / 2
fillboolean|stringYes-true
hoverBackgroundColorColorYes-undefined
hoverBorderCapStylestringYes-undefined
hoverBorderColorColorYes-undefined
hoverBorderDashnumber[]Yes-undefined
hoverBorderDashOffsetnumberYes-undefined
hoverBorderJoinStylestringYes-undefined
hoverBorderWidthnumberYes-undefined
labelstring--‘’
lineTensionnumber--0.4
ordernumber--0
pointBackgroundColorColorYesYes‘rgba(0, 0, 0, 0.1)’
pointBorderColorColorYesYes‘rgba(0, 0, 0, 0.1)’
pointBorderWidthnumberYesYes1
pointHitRadiusnumberYesYes1
pointHoverBackgroundColorColorYesYesundefined
pointHoverBorderColorColorYesYesundefined
pointHoverBorderWidthnumberYesYes1
pointHoverRadiusnumberYesYes4
pointRadiusnumberYesYes3
pointRotationnumberYesYes0
pointStylestring|ImageYesYes‘circle’
showLineboolean--undefined
spanGapsboolean--undefined
steppedLineboolean|string--false
xAxisIDstring--first x axis
yAxisIDstring--first y axis

General

NameDescription
labelThe label for the dataset which appears in the legend and tooltips.
orderThe drawing order of dataset. Also affects order for stacking, tooltip, and legend.
xAxisIDThe ID of the x axis to plot this dataset on.
yAxisIDThe ID of the y axis to plot this dataset on.

Point Styling

The style of each point can be controlled with the following properties:

NameDescription
pointBackgroundColorThe fill color for points.
pointBorderColorThe border color for points.
pointBorderWidthThe width of the point border in pixels.
pointHitRadiusThe pixel size of the non-displayed point that reacts to mouse events.
pointRadiusThe radius of the point shape. If set to 0, the point is not rendered.
pointRotationThe rotation of the point in degrees.
pointStyleStyle of the point. more…

All these values, if undefined, fallback first to the dataset options then to the associated elements.point.* options.

Line Styling

The style of the line can be controlled with the following properties:

NameDescription
backgroundColorThe line fill color.
borderCapStyleCap style of the line. See MDN.
borderColorThe line color.
borderDashLength and spacing of dashes. See MDN.
borderDashOffsetOffset for line dashes. See MDN.
borderJoinStyleLine joint style. See MDN.
borderWidthThe line width (in pixels).
clipHow 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}
fillHow to fill the area under the line. See area charts.
lineTensionBezier curve tension of the line. Set to 0 to draw straightlines. This option is ignored if monotone cubic interpolation is used.
showLineIf false, the line is not drawn for this dataset.
spanGapsIf 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.

If the value is undefined, showLine and spanGaps fallback to the associated chart configuration options. The rest of the values fallback to the associated elements.line.* options.

Interactions

The interaction with each point can be controlled with the following properties:

NameDescription
pointHoverBackgroundColorPoint background color when hovered.
pointHoverBorderColorPoint border color when hovered.
pointHoverBorderWidthBorder width of point when hovered.
pointHoverRadiusThe radius of the point when hovered.

cubicInterpolationMode

The following interpolation modes are supported.

  • 'default'
  • 'monotone'

The 'default' algorithm uses a custom weighted cubic interpolation, which produces pleasant curves for all types of datasets.

The 'monotone' algorithm is more suited to y = f(x) datasets : it preserves monotonicity (or piecewise monotonicity) of the dataset being interpolated, and ensures local extremums (if any) stay at input data points.

If left untouched (undefined), the global options.elements.line.cubicInterpolationMode property is used.

Stepped Line

The following values are supported for steppedLine.

  • false: No Step Interpolation (default)
  • true: Step-before Interpolation (eq. 'before')
  • 'before': Step-before Interpolation
  • 'after': Step-after Interpolation
  • 'middle': Step-middle Interpolation

If the steppedLine value is set to anything other than false, lineTension will be ignored.

Configuration Options

The line chart defines the following configuration options. These options are merged with the global chart configuration options, Chart.defaults.global, to form the options passed to the chart.

NameTypeDefaultDescription
showLinesbooleantrueIf false, the lines between points are not drawn.
spanGapsbooleanfalseIf false, NaN data causes a break in the line.

Default Options

It is common to want to apply a configuration setting to all created line charts. The global line chart settings are stored in Chart.defaults.line. Changing the global options only affects charts created after the change. Existing charts are not changed.

For example, to configure all line charts with spanGaps = true you would do:

  1. Chart.defaults.line.spanGaps = true;

Data Structure

The data property of a dataset for a line chart can be passed in two formats.

number[]

  1. data: [20, 10]

When the data array is an array of numbers, the x axis is generally a category. The points are placed onto the axis using their position in the array. When a line chart is created with a category axis, the labels property of the data object must be specified.

Point[]

  1. data: [{
  2. x: 10,
  3. y: 20
  4. }, {
  5. x: 15,
  6. y: 10
  7. }]

This alternate is used for sparse datasets, such as those in scatter charts. Each data point is specified using an object containing x and y properties.

Stacked Area Chart

Line charts can be configured into stacked area charts by changing the settings on the y axis to enable stacking. Stacked area charts can be used to show how one data trend is made up of a number of smaller pieces.

  1. var stackedLine = new Chart(ctx, {
  2. type: 'line',
  3. data: data,
  4. options: {
  5. scales: {
  6. yAxes: [{
  7. stacked: true
  8. }]
  9. }
  10. }
  11. });