chartjs-plugin-chart2music 0.0.5 → 0.0.6

package/README.md

@@ -1,5 +1,5 @@
 # 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**
 
@@ -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"`.

package/dist/plugin.js

@@ -215,7 +215,7 @@ var chartjs2music = (function (c2mChart) {
                 options.errorCallback?.(`Unable to connect chart2music to chart. The chart is of type "${invalidType}", which is not one of the supported chart types for this plugin. This plugin supports: ${Object.keys(chartjs_c2m_converter).join(", ")}`);
                 return;
             }
-            const axes = generateAxes(chart);
+            let axes = generateAxes(chart);
             if (chart.config.type === "wordCloud") {
                 delete axes.x.minimum;
                 delete axes.x.maximum;
@@ -242,6 +242,17 @@ var chartjs2music = (function (c2mChart) {
                 delete scrub?.data;
                 delete axes.x.valueLabels;
             }
+            axes = {
+                ...axes,
+                x: {
+                    ...axes.x,
+                    ...(options.axes?.x)
+                },
+                y: {
+                    ...axes.y,
+                    ...(options.axes?.y)
+                },
+            };
             const c2mOptions = {
                 cc,
                 element: chart.canvas,

package/dist/plugin.mjs

@@ -214,7 +214,7 @@ const plugin = {
             options.errorCallback?.(`Unable to connect chart2music to chart. The chart is of type "${invalidType}", which is not one of the supported chart types for this plugin. This plugin supports: ${Object.keys(chartjs_c2m_converter).join(", ")}`);
             return;
         }
-        const axes = generateAxes(chart);
+        let axes = generateAxes(chart);
         if (chart.config.type === "wordCloud") {
             delete axes.x.minimum;
             delete axes.x.maximum;
@@ -241,6 +241,17 @@ const plugin = {
             delete scrub?.data;
             delete axes.x.valueLabels;
         }
+        axes = {
+            ...axes,
+            x: {
+                ...axes.x,
+                ...(options.axes?.x)
+            },
+            y: {
+                ...axes.y,
+                ...(options.axes?.y)
+            },
+        };
         const c2mOptions = {
             cc,
             element: chart.canvas,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "chartjs-plugin-chart2music",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "type": "module",
   "description": "Chart.js plugin for Chart2Music. Turns chart.js charts into music so the blind can hear data.",
   "main": "dist/plugin.js",