Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/kurkle/chartjs-chart-treemap

Chart.js module for creating treemap charts
https://github.com/kurkle/chartjs-chart-treemap

Last synced: 3 months ago
JSON representation

Chart.js module for creating treemap charts

Lists

README

        

# chartjs-chart-treemap

[Chart.js](https://www.chartjs.org/) **v3.8+, v4+** module for creating treemap charts. Implementation for Chart.js v2 is in [2.x branch](https://github.com/kurkle/chartjs-chart-treemap/tree/2.x)

[![npm](https://img.shields.io/npm/v/chartjs-chart-treemap.svg)](https://www.npmjs.com/package/chartjs-chart-treemap)
[![release](https://img.shields.io/github/release/kurkle/chartjs-chart-treemap.svg?style=flat-square)](https://github.com/kurkle/chartjs-chart-treemap/releases/latest)
![npm bundle size](https://img.shields.io/bundlephobia/min/chartjs-chart-treemap.svg)
![GitHub](https://img.shields.io/github/license/kurkle/chartjs-chart-treemap.svg)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=kurkle_chartjs-chart-treemap&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=kurkle_chartjs-chart-treemap)
[![documentation](https://img.shields.io/static/v1?message=Documentation&color=informational)](https://chartjs-chart-treemap.pages.dev)

![TreeMap Example Image](treemap.png)

## Documentation

You can find documentation for chartjs-chart-treemap at [https://chartjs-chart-treemap.pages.dev/](https://chartjs-chart-treemap.pages.dev/).

## Development

You first need to install node dependencies (requires [Node.js](https://nodejs.org/)):

```bash
> npm install
```

The following commands will then be available from the repository root:

```bash
> npm run build // build dist files
> npm run dev // build and watch for changes
> npm test // run all tests
> npm run lint // perform code linting
> npm package // create an archive with dist files and samples
```

## License

chartjs-chart-treemap is available under the [MIT license](https://opensource.org/licenses/MIT).