Skip to content
This repository has been archived by the owner on Nov 25, 2021. It is now read-only.

Chart.js plugin to add an alternating background behind a barchart.

License

Notifications You must be signed in to change notification settings

datavisyn/chartjs-plugin-barchart-background

Repository files navigation

DEPRECATED: Alternating Barchart Background Chart.js Plugin

Target Discovery Platform NPM Package CircleCI

Chart.js plugin for adding an alternating background to chart axes, such as horizontal and vertical Barcharts, or Box and Violin Plots.

DEPRECATION Information

Please note that this project has been archived and is no longer being maintained.

Install

npm install --save chart.js chartjs-plugin-barchart-background

Usage and options

interface IChartJsPluginBarchartBackgroundOptions {
  /**
   * fill color
   * @default #f3f3f3
   */
  color: string;
  /**
   * render mode
   * options:
   *  * odd = first, third, ...
   *  * even = second, fourth, ...
   * @default 'odd'
   */
  mode: 'odd'|'even';
  /**
   * axis to render the alternating background for
   * @default: 'category'
   */
  axis: 'category'|'x'|'y';
}
options: {
  ...

  plugins: {
    chartJsPluginBarchartBackground: {
      color: '#efefef',
      mode: 'odd'
    }
  }

  ...
}

Samples

See the samples

Vertical

Horizontal

Building

npm install
npm run build

This repository is part of the Target Discovery Platform (TDP). For tutorials, API docs, and more information about the build and deployment process, see the documentation page.