chartjs-plugin-chart2music
TypeScript icon, indicating that this package has built-in type declarations

0.5.1 • Public • Published

chartjs-plugin-chart2music

npm version

This is a beta release of this plugin. Not all chart.js features are supported yet.

Turns your chart.js charts into music so the blind can hear data. This plugin will automatically add Chart2Music, an interactive sonification library, to your chart.js charts. The contents of the chart element will be modified to best support screen reader users, and the interactions will be visually synchronized to provide support for keyboard-only users.

Check out our CodePen collection of examples using the plugin.

Getting started

Add the chartjs2music plugin to your existing chart.js code like this:

import {Chart} from "chart.js/auto";
import chartjs2music from "chartjs-plugin-chart2music";

Chart.register(chartjs2music);

That will register the plugin globally. Alternatively, if you only want to enable for a given chart, you can do this:

import {Chart} from "chart.js/auto";
import chartjs2music from "chartjs-plugin-chart2music";

new Chart(canvasElement, {
    type: "bar",
    data: {
        datasets: [{
            data: [1,4,2,8]
        }]
    },
    plugins: [chartjs2music]
})

Available options

The following plugin options are available:

Here's an example for providing options:

import {Chart} from "chart.js/auto";
import chartjs2music from "chartjs-plugin-chart2music";

new Chart(canvasElement, {
    type: "bar",
    data: {
        datasets: [{
            data: [1,4,2,8]
        }]
    },
    options: {
        plugins: {
            chartjs2music: {
                // All errors should be logged as errors
                errorCallback: console.error,
                // Here's a div I made to be the CC
                cc: myDiv,
                // The Y values should all be money
                axes: {
                    y: {
                        format: (value) => "$" + value
                    }
                }
            }
        }
    },
    plugins: [chartjs2music]
});

Supported features

This plugin is currently in beta, so not all of the chart.js features are currently supported.

A quick list of chart.js features we currently support includes:

  • Chart types: bar, doughnut, line, pie, polar, radar, scatter, and combinations therein.
  • Boxplots using the @sgratzl/chartjs-chart-boxplot plugin (only support boxplots when there are no other chart types present)
  • Wordclouds using the chartjs-chart-wordcloud plugin
  • Axes options: title, min, max, type="linear", type="logarithmic".
  • Chart title
  • Most data structures (not including parsing or non-standard axes identifiers)

Note that visual-specific chart features are ignored. This includes things like color, padding, line thickness, etc.

Things we plan to support in the future:

  • Interactions and updates
  • Other chart.js plugins
  • Complex parsing options for data
  • Date/Time support for axes
  • Subtitle
  • Dataset visibility (when you show/hide a category from the legend)
  • Radar charts
  • Custom formatting for axis tick values

Plugins we plan to support in the future:

Package Sidebar

Install

npm i chartjs-plugin-chart2music

Weekly Downloads

6,508

Version

0.5.1

License

MIT

Unpacked Size

55.8 kB

Total Files

7

Last publish

Collaborators

  • julianna-langston