Bar

A bar chart provides a way of showing data values represented as vertical bars. It is sometimes used to show trend data, and the comparison of multiple data sets side by side.

Example Usage

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

Dataset Properties

The bar 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 color of the bars is generally set this way.

NameTypeScriptableIndexableDefault
backgroundColorColorYesYes'rgba(0, 0, 0, 0.1)'
borderColorColorYesYes'rgba(0, 0, 0, 0.1)'
borderSkippedstringYesYes'bottom'
borderWidthnumber|objectYesYes0
dataobject[]--required
hoverBackgroundColorColor-Yesundefined
hoverBorderColorColor-Yesundefined
hoverBorderWidthnumber-Yes1
labelstring--''
xAxisIDstring--first x axis
yAxisIDstring--first y axis

General

NameDescription
labelThe label for the dataset which appears in the legend and tooltips.
xAxisIDThe ID of the x axis to plot this dataset on.
yAxisIDThe ID of the y axis to plot this dataset on.

Styling

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

NameDescription
backgroundColorThe bar background color.
borderColorThe bar border color.
borderSkippedThe edge to skip when drawing bar.
borderWidthThe bar border width (in pixels).

All these values, if undefined, fallback to the associated elements.rectangle.* options.

borderSkipped

This setting is used to avoid drawing the bar stroke at the base of the fill.In general, this does not need to be changed except when creating chart typesthat derive from a bar chart.

Note: for negative bars in vertical chart, top and bottom are flipped. Same goes for left and right in horizontal chart.

Options are:

  • 'bottom'
  • 'left'
  • 'top'
  • 'right'
  • false

borderWidth

If this value is a number, it is applied to all sides of the rectangle (left, top, right, bottom), except borderSkipped. If this value is an object, the left property defines the left border width. Similarly the right, top and bottom properties can also be specified. Omitted borders and borderSkipped are skipped.

Interactions

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

NameDescription
hoverBackgroundColorThe bar background color when hovered.
hoverBorderColorThe bar border color when hovered.
hoverBorderWidthThe bar border width when hovered (in pixels).

All these values, if undefined, fallback to the associated elements.rectangle.* options.

Scale Configuration

The bar chart accepts the following configuration from the associated scale options:

NameTypeDefaultDescription
barPercentagenumber0.9Percent (0-1) of the available width each bar should be within the category width. 1.0 will take the whole category width and put the bars right next to each other. more…
categoryPercentagenumber0.8Percent (0-1) of the available width each category should be within the sample width. more…
barThicknessnumber|stringManually set width of each bar in pixels. If set to 'flex', it computes "optimal" sample widths that globally arrange bars side by side. If not set (default), bars are equally sized based on the smallest interval. more…
maxBarThicknessnumberSet this to ensure that bars are not sized thicker than this.
minBarLengthnumberSet this to ensure that bars have a minimum length in pixels.
gridLines.offsetGridLinesbooleantrueIf true, the bars for a particular data point fall between the grid lines. The grid line will move to the left by one half of the tick interval. If false, the grid line will go right down the middle of the bars. more…

Example Usage

  1. options = {
  2. scales: {
  3. xAxes: [{
  4. barPercentage: 0.5,
  5. barThickness: 6,
  6. maxBarThickness: 8,
  7. minBarLength: 2,
  8. gridLines: {
  9. offsetGridLines: true
  10. }
  11. }]
  12. }
  13. };

barThickness

If this value is a number, it is applied to the width of each bar, in pixels. When this is enforced, barPercentage and categoryPercentage are ignored.

If set to 'flex', the base sample widths are calculated automatically based on the previous and following samples so that they take the full available widths without overlap. Then, bars are sized using barPercentage and categoryPercentage. There is no gap when the percentage options are 1. This mode generates bars with different widths when data are not evenly spaced.

If not set (default), the base sample widths are calculated using the smallest interval that prevents bar overlapping, and bars are sized using barPercentage and categoryPercentage. This mode always generates bars equally sized.

offsetGridLines

If true, the bars for a particular data point fall between the grid lines. The grid line will move to the left by one half of the tick interval, which is the space between the grid lines. If false, the grid line will go right down the middle of the bars. This is set to true for a category scale in a bar chart while false for other scales or chart types by default.

Default Options

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

barPercentage vs categoryPercentage

The following shows the relationship between the bar percentage option and the category percentage option.

  1. // categoryPercentage: 1.0
  2. // barPercentage: 1.0
  3. Bar: | 1.0 | 1.0 |
  4. Category: | 1.0 |
  5. Sample: |===========|
  6. // categoryPercentage: 1.0
  7. // barPercentage: 0.5
  8. Bar: |.5| |.5|
  9. Category: | 1.0 |
  10. Sample: |==============|
  11. // categoryPercentage: 0.5
  12. // barPercentage: 1.0
  13. Bar: |1.||1.|
  14. Category: | .5 |
  15. Sample: |==============|

Data Structure

The data property of a dataset for a bar chart is specified as an array of numbers. Each point in the data array corresponds to the label at the same index on the x axis.

  1. data: [20, 10]

You can also specify the dataset as x/y coordinates when using the time scale.

  1. data: [{x:'2016-12-25', y:20}, {x:'2016-12-26', y:10}]

Stacked Bar Chart

Bar charts can be configured into stacked bar charts by changing the settings on the X and Y axes to enable stacking. Stacked bar charts can be used to show how one data series is made up of a number of smaller pieces.

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

The following dataset properties are specific to stacked bar charts.

NameTypeDescription
stackstringThe ID of the group to which this dataset belongs to (when stacked, each group will be a separate stack).

Horizontal Bar Chart

A horizontal bar chart is a variation on a vertical bar chart. It is sometimes used to show trend data, and the comparison of multiple data sets side by side.

Example

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

Config Options

The configuration options for the horizontal bar chart are the same as for the bar chart. However, any options specified on the x axis in a bar chart, are applied to the y axis in a horizontal bar chart.

The default horizontal bar configuration is specified in Chart.defaults.horizontalBar.