ng2-charts - npm Package Compare versions

Comparing version 2.0.0-beta to 2.0.0-beta.1

package.json

 {
   "name": "ng2-charts",
-  "version": "2.0.0-beta",
+  "version": "2.0.0-beta.1",
   "peerDependencies": {
@@ -5,0 +5,0 @@ "@angular/common": "^7.2.0",

README.md

@@ -1,2 +0,2 @@
-# Deprecated
+[# Deprecated
 
@@ -8,1 +8,97 @@ Please use `ng-chartjs` instead
 npmjs.com link: https://www.npmjs.com/package/ng-chartjs
+](# ng2-charts [![npm version](https://badge.fury.io/js/ng2-charts.svg)](http://badge.fury.io/js/ng2-charts) [![npm downloads](https://img.shields.io/npm/dm/ng2-charts.svg)](https://npmjs.org/ng2-charts) [![slack](https://ngx-slack.herokuapp.com/badge.svg)](https://ngx-slack.herokuapp.com)
+Beautiful charts for Angular2 based on Chart.js
+
+<!-- [![Sauce Test Status](https://saucelabs.com/browser-matrix/valorkin.svg)](https://saucelabs.com/u/valorkin) -->
+[![NPM](https://nodei.co/npm/ng2-charts.png?downloads=true&downloadRank=true&stars=true)](https://npmjs.org/ng2-charts)
+[![NPM](https://nodei.co/npm-dl/ng2-charts.png?height=3&months=9)](https://npmjs.org/ng2-charts)
+
+
+# Usage & Demo
+
+Sample in below website uses ng2-charts@1.1.0
+
+[http://valor-software.github.io/ng2-charts/](http://valor-software.github.io/ng2-charts/)
+[http://plnkr.co/edit/7fGsiuRjcF0M0Ffeoml2?p=preview](http://plnkr.co/edit/7fGsiuRjcF0M0Ffeoml2?p=preview)
+
+
+- - -
+
+### Installation
+
+1. You can install ***ng2-charts*** using npm
+
+  ```bash
+  npm install ng2-charts --save
+  ```
+2. You need to install and include `Chart.js` library in application via `html` or `webpack bundler` (more options can be found in official `chart.js` [documentation](http://www.chartjs.org/docs/#getting-started))
+
+  ```bash
+  npm install chart.js --save
+  ```
+
+  **Important**: Embedding `Chart.js` in application is mandatory!
+
+  ```html
+  <script src="node_modules/chart.js/src/chart.js"></script>
+  ```
+### Usage & Demo
+ Demo and API details of ***ng2-charts*** can be found here:
+  [demo](http://valor-software.github.io/ng2-charts/) and [source code](https://github.com/valor-software/ng2-charts/tree/master/demo).
+
+### System.js
+
+System.js bundles can be found in `bundles` directory of npm package or at [npm cdn](https://npmcdn.com/ng2-charts/bundles/)
+
+
+## API
+
+### Import
+```typescript
+import { ChartsModule } from 'ng2-charts/ng2-charts';
+
+// In your App's module:
+imports: [
+   ChartsModule
+]
+```
+
+### Chart types
+There are one directive for all chart types: `base-chart`, and there are 6 types of charts: , `line`, `bar`, `radar`, `pie`, `polarArea`, `doughnut`.
+
+### Properties
+
+**Note**: For more information about possible options please refer to original [chart.js](http://www.chartjs.org/docs) documentation
+
+- `data` (`Array<number[]> | number[]`) -  set of points of the chart, it should be `Array<number[]>` only for `line`, `bar` and `radar`, otherwise `number[]`;
+- `datasets` (`Array<{data: Array<number[]> | number[], label: string}>`) - `data` see about, the `label` for the dataset which appears in the legend and tooltips
+- `labels` (`?Array<any>`) - x axis labels. It's necessary for charts: `line`, `bar` and `radar`. And just labels (on hover) for charts: `polarArea`, `pie` and `doughnut`
+- `chartType` (`?string`) - indicates the type of charts, it can be: `line`, `bar`, `radar`, `pie`, `polarArea`, `doughnut`
+- `options` (`?any`) - chart options (as from [Chart.js documentation](http://www.chartjs.org/docs/))
+- `colors` (`?Array<any>`) - data colors, 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
+
+### 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.
+
+
+## Troubleshooting
+
+Please follow this guidelines when reporting bugs and feature requests:
+
+1. Use [GitHub Issues](https://github.com/valor-software/ng2-charts/issues) board to report bugs and feature requests (not our email address)
+2. Please **always** write steps to reproduce the error. That way we can focus on fixing the bug, not scratching our heads trying to reproduce it.
+
+Thanks for understanding!
+
+### License
+
+The MIT License (see the [LICENSE](https://github.com/valor-software/ng2-charts/blob/master/LICENSE) file for the full text)
+)

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

239476

increased by1.82%

Number of lines in readme file

104

increased by1200%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes