chartjs-plugin-chart2music 0.0.5 → 0.0.7

package/README.md

@@ -1,7 +1,7 @@
 # chartjs-plugin-chart2music
-chartjs plugin for chart2music.
+[![npm version](https://badge.fury.io/js/chartjs-plugin-chart2music.svg)](https://badge.fury.io/js/chartjs-plugin-chart2music)
 
-**This is a beta release of this plugin**
+**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.
 
@@ -13,9 +13,9 @@ Add the chartjs2music plugin to your existing chart.js code like this:
 
 ```js
 import {Chart} from "chart.js/auto";
-import plugin from "chartjs-plugin-chart2music";
+import chartjs2music from "chartjs-plugin-chart2music";
 
-Chart.register(plugin);
+Chart.register(chartjs2music);
 ```
 
 That will register the plugin globally. Alternatively, if you only want to enable for a given chart, you can do this:
@@ -36,12 +36,52 @@ new Chart(canvasElement, {
 
 ```
 
+## Available options
+
+The following plugin options are available:
+* `errorCallback` - A callback that will return errors if any arise while the plugin works.
+* `cc` - the equivalent of the [chart2music option `cc`](https://chart2music.com/docs/API/Config#axes)
+* `audioEngine` - the equivalent of the [chart2music option `audioEngine`](https://chart2music.com/docs/API/Config#cc)
+* `axes` - the equivalent of the [chart2music option `axes`](https://chart2music.com/docs/API/Config#axes)
+
+Here's an example for providing options:
+```js
+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, line, pie, doughnut, polar, radar, and combinations therein.
+* 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"`.