| 16844 |
efrain |
1 |
<p align="center">
|
|
|
2 |
<img src="docs/.vuepress/public/hero-title.svg?sanitize=true">
|
|
|
3 |
</p>
|
|
|
4 |
|
|
|
5 |
<p align="center">
|
|
|
6 |
<a href="https://chartjs-plugin-datalabels.netlify.app/guide/getting-started.html"><img src="https://img.shields.io/github/release/chartjs/chartjs-plugin-datalabels.svg?style=flat-square&maxAge=600" alt="Downloads"></a>
|
|
|
7 |
<a href="https://travis-ci.org/chartjs/chartjs-plugin-datalabels"><img src="https://img.shields.io/travis/chartjs/chartjs-plugin-datalabels.svg?style=flat-square&maxAge=600" alt="Builds"></a>
|
|
|
8 |
<a href="https://codeclimate.com/github/chartjs/chartjs-plugin-datalabels"><img src="https://img.shields.io/codeclimate/c/chartjs/chartjs-plugin-datalabels.svg?style=flat-square&maxAge=600" alt="Coverage"></a>
|
|
|
9 |
<a href="https://github.com/chartjs/awesome"><img src="https://awesome.re/badge-flat2.svg" alt="Awesome"></a>
|
|
|
10 |
</p>
|
|
|
11 |
|
|
|
12 |
## Overview
|
|
|
13 |
|
|
|
14 |
Highly customizable [Chart.js](https://www.chartjs.org/) plugin that displays labels on data for any type of charts.
|
|
|
15 |
|
|
|
16 |
Requires [Chart.js](https://github.com/chartjs/Chart.js/releases) **3.x**.
|
|
|
17 |
|
|
|
18 |
## Documentation
|
|
|
19 |
|
|
|
20 |
- [Introduction](https://chartjs-plugin-datalabels.netlify.app/guide/)
|
|
|
21 |
- [Getting Started](https://chartjs-plugin-datalabels.netlify.app/guide/getting-started.html)
|
|
|
22 |
- [Options](https://chartjs-plugin-datalabels.netlify.app/guide/options.html)
|
|
|
23 |
- [Labels](https://chartjs-plugin-datalabels.netlify.app/guide/labels.html)
|
|
|
24 |
- [Positioning](https://chartjs-plugin-datalabels.netlify.app/guide/positioning.html)
|
|
|
25 |
- [Formatting](https://chartjs-plugin-datalabels.netlify.app/guide/formatting.html)
|
|
|
26 |
- [Events](https://chartjs-plugin-datalabels.netlify.app/guide/events.html)
|
|
|
27 |
- [TypeScript](https://chartjs-plugin-datalabels.netlify.app/guide/typescript.html)
|
|
|
28 |
- [Migration](https://chartjs-plugin-datalabels.netlify.app/guide/migration.html)
|
|
|
29 |
- [Samples](https://chartjs-plugin-datalabels.netlify.app/samples/)
|
|
|
30 |
|
|
|
31 |
## Development
|
|
|
32 |
|
|
|
33 |
You first need to install node dependencies (requires [Node.js](https://nodejs.org/)):
|
|
|
34 |
|
|
|
35 |
```
|
|
|
36 |
> npm install
|
|
|
37 |
```
|
|
|
38 |
|
|
|
39 |
The following commands will then be available from the repository root:
|
|
|
40 |
|
|
|
41 |
```
|
|
|
42 |
> npm run build // build dist files
|
|
|
43 |
> npm run build:dev // build and watch for changes
|
|
|
44 |
> npm run test // run all tests and generate code coverage
|
|
|
45 |
> npm run test:dev // run all tests and watch for changes
|
|
|
46 |
> npm run lint // perform code linting
|
|
|
47 |
> npm run lint -- --fix // automatically fix linting problems
|
|
|
48 |
> npm run docs // generate documentation (`dist/docs`)
|
|
|
49 |
> npm run docs:dev // generate documentation and watch for changes
|
|
|
50 |
```
|
|
|
51 |
|
|
|
52 |
## License
|
|
|
53 |
|
|
|
54 |
`chartjs-plugin-datalabels` is available under the [MIT license](LICENSE.md).
|