chartjs-plugin-barchart-background

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

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
chartjs-plugin-barchart-background
103.0.0a year ago5 years agoMinified + gzip package size for chartjs-plugin-barchart-background in KB

Readme

DEPRECATED: Alternating Barchart Background Chart.js Plugin
!Target Discovery Platformtdp-imagetdp-url !NPM Packagenpm-imagenpm-url !CircleCIcircleci-imagecircleci-url
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.