Box Annotations

Box annotations are used to draw rectangles on the chart area. This can be useful for highlighting different areas of a chart.

const options = { plugins: { autocolors: false, annotation: { annotations: { box1: { type: 'box', xMin: 1, xMax: 2, yMin: 50, yMax: 70, backgroundColor: 'rgba(255, 99, 132, 0.25)' } } } } };

const options = {
  plugins: {
    autocolors: false,
    annotation: {
      annotations: {
        box1: {
          type: 'box',
          xMin: 1,
          xMax: 2,
          yMin: 50,
          yMax: 70,
          backgroundColor: 'rgba(255, 99, 132, 0.25)'
        }
      }
    }
  }
};

const config = { type: 'line', data: { labels: ['January', 'February', 'March', 'April', 'May', 'June', 'July'], datasets: [{ label: 'My First Dataset', data: [65, 59, 80, 81, 56, 55, 40], fill: false, borderColor: 'rgb(75, 192, 192)', tension: 0.1 }] }, options };

const config = {
  type: 'line',
  data: {
    labels: ['January', 'February', 'March', 'April', 'May', 'June', 'July'],
    datasets: [{
      label: 'My First Dataset',
      data: [65, 59, 80, 81, 56, 55, 40],
      fill: false,
      borderColor: 'rgb(75, 192, 192)',
      tension: 0.1
    }]
  },
  options
};

Configuration

The following options are available for box annotations.

Name	Type	Scriptable	Default
display	boolean	Yes	true
adjustScaleRange	boolean	Yes	true
drawTime	string	Yes	'afterDatasetsDraw'
xScaleID	string	Yes	'x'
yScaleID	string	Yes	'y'
xMin	number	Yes	undefined
xMax	number	Yes	undefined
yMin	number	Yes	undefined
YMax	number	Yes	undefined
borderColor	Color	Yes	options.color
borderWidth	number	Yes	1
borderDash	number[]	Yes	[]
borderDashOffset	number	Yes	0
backgroundColor	Color	Yes	options.color
cornerRadius	number	Yes	0

General

If one of the axes does not match an axis in the chart, the box will take the entire chart dimension. The 4 coordinates, xMin, xMax, yMin, yMax are optional. If not specified, the box is expanded out to the edges in the respective direction.

Name	Description
display	Whether or not this annotation is visible
adjustScaleRange	Should the scale range be adjusted if this annotation is out of range
drawTime	See drawTime
xScaleID	ID of the X scale to bind onto, default is 'x'.
yScaleID	ID of the Y scale to bind onto, default is 'y'.
xMin	Left edge of the box in units along the x axis.
xMax	Right edge of the box in units along the x axis.
yMin	Top edge of the box in units along the y axis.
yMax	Bottom edge of the box in units along the y axis.

Styling

Name	Description
borderColor	Stroke color
borderWidth	Stroke width
borderDash	Length and spacing of dashes. See MDN (opens new window).
borderDashOffset	Offset for line dashes. See MDN (opens new window).
backgroundColor	Fill color
cornerRadius	Radius of box rectangle