# chartjs-plugin-annotation

> Annotations for Chart.js

Latest version **3.1.0** (published 2024-10-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install chartjs-plugin-annotation
pnpm add chartjs-plugin-annotation
yarn add chartjs-plugin-annotation
bun add chartjs-plugin-annotation
```

## Health

**Score 55/100 (C)** — status: stable.

Positive: has types; esm support; no vulnerabilities; high maintenance score; high quality score.

Warnings: low downloads.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 3.1.0 |
| Published | 2024-10-16 |
| First published | 2016-10-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 237.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 623 |
| Author | Evert Timberg |
| Maintainers | etimberg, chartjs-ci, compwright |

## Links

- npm: https://www.npmjs.com/package/chartjs-plugin-annotation
- Repository: https://github.com/chartjs/chartjs-plugin-annotation
- Homepage: https://www.chartjs.org/chartjs-plugin-annotation/index
- Issues: https://github.com/chartjs/chartjs-plugin-annotation/issues
- npm.io page: https://npm.io/package/chartjs-plugin-annotation

## Recent versions

- 3.1.0 (latest) — 2024-10-16
- 3.0.1 — 2023-05-15
- 3.0.0 — 2023-05-10
- 2.2.1 — 2023-03-15
- 2.2.0 — 2023-03-14
- 2.1.2 — 2023-01-12
- 2.1.1 — 2022-12-30
- 2.1.0 — 2022-11-17
- 2.0.1 — 2022-08-19
- 2.0.0 — 2022-07-26
- 1.4.0 — 2022-03-07
- 1.3.1 — 2022-02-07
- 1.3.0 — 2022-01-27
- 1.2.2 — 2021-12-29
- 1.2.1 — 2021-12-17
- … 22 more at https://npm.io/package/chartjs-plugin-annotation/versions

## README

# chartjs-plugin-annotation.js

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/chartjs/chartjs-plugin-annotation/ci.yml?branch=master)](https://github.com/chartjs/chartjs-plugin-annotation/actions/workflows/ci.yml)
[![Coverage Status](https://coveralls.io/repos/github/chartjs/chartjs-plugin-annotation/badge.svg?branch=master)](https://coveralls.io/github/chartjs/chartjs-plugin-annotation?branch=master)
[![release](https://img.shields.io/github/v/release/chartjs/chartjs-plugin-annotation?include_prereleases)](https://github.com/chartjs/chartjs-plugin-annotation/releases)
[![npm (latest)](https://img.shields.io/npm/v/chartjs-plugin-annotation/latest)](https://www.npmjs.com/package/chartjs-plugin-annotation/v/latest)
[![documentation](https://img.shields.io/static/v1?message=Documentation&color=informational)](https://www.chartjs.org/chartjs-plugin-annotation/index)
<a href="https://github.com/chartjs/awesome"><img src="https://awesome.re/badge-flat2.svg" alt="Awesome"></a>

An annotation plugin for Chart.js >= 4.0.0

---
> This plugin needs to be registered. It does not function as inline plugin.
---

For Chart.js 3.7.0 to 3.9.1 support, use [version 2.2.1 of this plugin](https://github.com/chartjs/chartjs-plugin-annotation/releases/tag/v2.2.1)

For Chart.js 3.0.0 to 3.6.2 support, use [version 1.4.0 of this plugin](https://github.com/chartjs/chartjs-plugin-annotation/releases/tag/v1.4.0)

For Chart.js 2.4.0 to 2.9.x support, use [version 0.5.7 of this plugin](https://github.com/chartjs/chartjs-plugin-annotation/releases/tag/v0.5.7)

This plugin draws lines, boxes, points, labels, polygons and ellipses on the chart area.

Annotations work with line, bar, scatter and bubble charts that use linear, logarithmic, time, or category scales. 
Furthermore you can use a doughnut label annotation which can be used to add contents (text, image, canvas) in the middle area of the doughnut charts.

![Example Screenshot](docs/guide/banner.png)

[View this example](https://www.chartjs.org/chartjs-plugin-annotation/latest/samples/intro.html)

## Documentation

You can find documentation for chartjs-plugin-annotation at [www.chartjs.org/chartjs-plugin-annotation](https://www.chartjs.org/chartjs-plugin-annotation/index).

## Contributing

Before submitting an issue or a pull request to the project, please take a moment to look over the [contributing guidelines](CONTRIBUTING.md) first.

## License

Chart.Annotation.js is available under the [MIT license](LICENSE.md).

---
_Source: https://npm.io/package/chartjs-plugin-annotation · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._