@rinminase/ng-charts

v4.3.0

Published

2 years ago

Reactive, responsive, beautiful charts for Angular based on ng2-charts

Downloads

1,333

0High
0Medium
0Low

rinminase

chart.js chartjs ng-charts ng-chart angular charts ng2-charts ng2-chart

Introduction

Beautiful charts for Angular based on ng2-chartjs.

This library is updated for usage with Angular 13 and removes chart.js as a peer dependency.

Version Information

| Version | Chart.js Version | Branch | | ------------------- | ---------------- | ------ | | 4.x | 2.9 | master | | 5.x (beta/next) | 3.5 | dev |

Usage & Demo

Installation

You can install ng-charts using npm

npm install @rinminase/ng-charts

For Chart.js version 3.5+

npm install @rinminase/ng-charts@next

Using a CDN

You can use JSDelivr CDN and place it on your main HTML page

If you're using Chart.js version 2.9

  <body>
    ...
    <script src="https://cdn.jsdelivr.net/npm/@rinminase/ng-charts"></script>
  </body>

If you're using Chart.js version 3.5+

  <body>
    ...
    <script src="https://cdn.jsdelivr.net/npm/@rinminase/ng-charts@next"></script>
  </body>

Please note that version 5 of this package is still currently in beta and has not been thoroughly tested

Stackblitz Starting Templates

API

Import

import { ChartsModule } from '@rinminase/ng-charts';

// In your App's module:
imports: [
   ChartsModule
]

Chart types

There are one directive for all chart types: baseChart, and there are 8 types of charts: line, bar, radar, pie, polarArea, doughnut, bubble and scatter.

Properties

Note: For more information about possible options please refer to original chart.js documentation

data (SingleOrMultiDataSet) - set of points of the chart, it should be MultiDataSet only for line, bar, radar and doughnut, otherwise SingleDataSet
datasets (ChartDatasets[]) - data see about, the label for the dataset which appears in the legend and tooltips
labels (ChartLabel[]) - x axis labels. It's necessary for charts: line, bar and radar. And just labels (on hover) for charts: polarArea, pie and doughnut. Label is either a single string, or it may be a string[] representing a multi-line label where each array element is on a new line.
chartType (ChartType) - indicates the type of charts, it can be: line, bar, radar, pie, polarArea, doughnut
options (ChartOptions) - chart options (as from Chart.js documentation)
colors (Color | DatasetColor[]) - data colors per dataset will use default and|or random colors if not specified (see below)
legend: (boolean = false) - if true show legend below the chart, otherwise not be shown

Note Pie charts only contain one dataset unlike other charts, as such colors are formatted as such:

data = [10, 20, 30];
colors = [{
    backgroundColor: ["red", "#0F0", "rgba(41, 182, 246,0.75)"],
    borderColor: ["rgb(250,120,100)", "green", "#0086c3"],
}];

Events

chartClick: fires when click on a chart has occurred, returns information regarding active points and labels
chartHover: fires when mousemove (hover) on a chart has occurred, returns information regarding active points and labels

Colors

There are a set several default colors. Colors can be replaced using the colors attribute. If there is more data than colors, colors are generated randomly.

Dynamic Theming

The ChartsModule provides a service called ThemeService which allows clients to set a structure specifying colors override settings. This service may be called when the dynamic theme changes, with colors which fit the theme. The structure is interpreted as an override, with special functionality when dealing with arrays. Example:

type Theme = 'light-theme' | 'dark-theme';

private _selectedTheme: Theme = 'light-theme';
public get selectedTheme() {
  return this._selectedTheme;
}

public set selectedTheme(value) {
  this._selectedTheme = value;
  let overrides: ChartOptions;
  if (this.selectedTheme === 'dark-theme') {
    overrides = {
      legend: {
        labels: { fontColor: 'white' }
      },
      scales: {
        xAxes: [{
          ticks: { fontColor: 'white' },
          gridLines: { color: 'rgba(255,255,255,0.1)' }
        }],
        yAxes: [{
          ticks: { fontColor: 'white' },
          gridLines: { color: 'rgba(255,255,255,0.1)' }
        }]
      }
    };
  } else {
    overrides = {};
  }
  this.themeService.setColorschemesOptions(overrides);
}

constructor(private themeService: ThemeService) { }

setCurrentTheme(theme: Theme) {
  this.selectedTheme = theme;
}

The overrides object has the same type as the chart options object ChartOptions, and wherever a simple field is encountered it replaces the matching field in the options object. When an array is encountered (as in the xAxes and yAxes fields above), the single object inside the array is used as a template to override all array elements in the matching field in the options object. So in the case above, every axis will have its ticks and gridline colors changed.

Troubleshooting

Please follow this guidelines when reporting bugs and feature requests:

Use GitHub Issues board to report bugs and feature requests.
Please always write steps to reproduce the error.

Thanks for understanding!

FAQ

Why re-create this library when there is already an existing one at ng2-charts created by Valor Software?

The library doesn't seem to remove chart.js as its peer dependency, but needs it a lot. I seem to see the need to remove the additional library installed for your project and have this library install it instead
Instead of:
npm install ng2-chartjs chart.js
I wanted to do it this way:
npm install @rinminase/ng-charts
Which only adds one dependency to your project.

Will this library be updated when either ng2-charts or chart.js updates?

Yes. This is alongside with its other peer dependencies (angular and zonejs)

Built with

Angular 13 - Library setup
TypeScript - Language syntax
NodeJS - Environment
Circle CI - Continuous Integration (CI) service
Semantic Release📦🚀 - Releasing strategy