npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@rinminase/ng-charts

v4.3.0

Published

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

Downloads

1,392

Readme

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

  1. 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

  1. 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:

  1. Use GitHub Issues board to report bugs and feature requests.
  2. 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