Change name of config to sonification, clean up directory

plotly · aliwelchoo · Jul 21, 2023 · Jul 21, 2023 · Jul 21, 2023 · Jul 21, 2023
commit ed189076b68de9d31c32bdd7d0fb6512108ae2bf
diff --git a/devtools/test_dashboard/index-mathjax3.html b/devtools/test_dashboard/index-mathjax3.html
@@ -24,10 +24,6 @@ <h4>no MathJax: Apple: $2, Orange: $3</h4>
     <div id="graph"></div>
   </div>
   <div id="snapshot"></div>
-  <div style="position:absolute; border-top: .3em solid #eee; bottom: 0px; left: 0; width: 100%">
-    <div style="margin-top: -1.2em; padding-left: 3px; font-weight: bold; color: #555; width:100%;">Closed Captions</div>
-    <div id="c2m-plotly-cc" style="width: 100%; height: 40px; padding: 18px 0 0 15px; color: #333">Test</div>
-  </div>
 
   <script>
     window.MathJax = {

diff --git a/devtools/test_dashboard/index-mathjax3chtml.html b/devtools/test_dashboard/index-mathjax3chtml.html
@@ -22,10 +22,6 @@
     <div id="graph"></div>
   </div>
   <div id="snapshot"></div>
-  <div style="position:absolute; border-top: .3em solid #eee; bottom: 0px; left: 0; width: 100%">
-    <div style="margin-top: -1.2em; padding-left: 3px; font-weight: bold; color: #555; width:100%;">Closed Captions</div>
-    <div id="c2m-plotly-cc" style="width: 100%; height: 40px; padding: 18px 0 0 15px; color: #333">Test</div>
-  </div>
 
   <script>
     window.MathJax = window.MathJax || {

diff --git a/devtools/test_dashboard/index-strict.html b/devtools/test_dashboard/index-strict.html
@@ -21,10 +21,6 @@
     <div id="graph"></div>
   </div>
   <div id="snapshot"></div>
-  <div style="position:absolute; border-top: .3em solid #eee; bottom: 0px; left: 0; width: 100%">
-    <div style="margin-top: -1.2em; padding-left: 3px; font-weight: bold; color: #555; width:100%;">Closed Captions</div>
-    <div id="c2m-plotly-cc" style="width: 100%; height: 40px; padding: 18px 0 0 15px; color: #333">Test</div>
-  </div>
 
   <script src="../../node_modules/mathjax-v2/MathJax.js?config=TeX-AMS-MML_SVG"></script>
   <script charset="utf-8" id="source" src="../../build/plotly.js"></script>

diff --git a/devtools/test_dashboard/index.html b/devtools/test_dashboard/index.html
@@ -20,10 +20,7 @@
     <div id="graph"></div>
   </div>
   <div id="snapshot"></div>
-  <div style="position:absolute; border-top: .3em solid #eee; bottom: 0px; left: 0; width: 100%">
-    <div style="margin-top: -1.2em; padding-left: 3px; font-weight: bold; color: #555; width:100%;">Closed Captions</div>
-    <div id="c2m-plotly-cc" style="width: 100%; height: 40px; padding: 18px 0 0 15px; color: #333">Test</div>
-  </div>
+
   <script src="../../node_modules/mathjax-v2/MathJax.js?config=TeX-AMS-MML_SVG"></script>
   <script charset="utf-8" id="source" src="../../build/plotly.js"></script>
   <script charset="utf-8" src="../../build/test_dashboard-bundle.js"></script>

diff --git a/src/accessibility/README.md b/src/accessibility/README.md
@@ -1,3 +1,3 @@
 # accesibility
 
-While anticipating more accesibility libraries in the future, as of today this is a trivial wrapper over the `c2m` directory.
+While anticipating more accessibility libraries in the future, as of today this is a trivial wrapper over the `c2m` directory.
diff --git a/src/accessibility/c2m/README.md → src/accessibility/sonification/README.md b/src/accessibility/c2m/README.md → src/accessibility/sonification/README.md
@@ -1,4 +1,4 @@
-# `plotly.js` wrapper for `c2m`, sonified charts
+# `plotly.js` wrapper for `chart2music`, sonified charts
 
 This wrapper attaches a context object to `gd._context._c2m` with the following properties:
 
@@ -15,7 +15,7 @@ The first three have most of their values set by the defaults in *src/plot_api/p
 **index.js** exposes the following api:
 
 * `initC2M(gd, defaultConfig)` full resets the `c2mChart` object.
-  * `defaultConfig` is equal to `gd._context.accessibility`, as defined in *src/plot_api/plot_config.js*.
+  * `defaultConfig` is equal to `gd._context.sonification`, as defined in *src/plot_api/plot_config.js*.
 
 
 * `initClosedCaptionDiv(gd, config)` finds or creates the closed caption div, depending on `config`.

diff --git a/src/accessibility/c2m/all_codecs.js → src/accessibility/sonification/all_codecs.js b/src/accessibility/c2m/all_codecs.js → src/accessibility/sonification/all_codecs.js
diff --git a/src/accessibility/c2m/index.js → src/accessibility/sonification/index.js b/src/accessibility/c2m/index.js → src/accessibility/sonification/index.js
@@ -5,10 +5,6 @@ var Fx = require('../../components/fx');
 var Lib = require('../../lib');
 
 var codecs = require('./all_codecs').codecs;
-// var codecs = [ require('./xy_scatter_codec') ]
-// I intentionally don't do that because
-// a) it's not possible in ESM w/ `import {}`
-// b) may break weak tree shakers who bail if `require()` not top-level
 
 function initC2M(gd, defaultConfig) {
     // TODO: should this be Lib.getGraphDiv()?

diff --git a/src/accessibility/c2m/xy_scatter_codec.js → ...sibility/sonification/xy_scatter_codec.js b/src/accessibility/c2m/xy_scatter_codec.js → ...sibility/sonification/xy_scatter_codec.js
diff --git a/src/plot_api/accessibility.js b/src/plot_api/accessibility.js
@@ -1,16 +1,10 @@
 'use strict';
 
-var c2mPlotly = require('../accessibility/c2m');
+var c2mPlotly = require('../accessibility/sonification');
 
-function enable(gd) {
+function enable_sonification(gd) {
     // Collecting defaults
-    var defaultConfig = gd._context.accessibility;
-
-    if(defaultConfig.library === 'chart2music') {
-        c2mPlotly.initC2M(gd, defaultConfig);
-    } else {
-        // User has some bunk configuration values, what do we do here?
-        return;
-    }
+    var defaultConfig = gd._context.sonification;
+    c2mPlotly.initC2M(gd, defaultConfig);
 }
-exports.enable = enable;
+exports.enable_sonification = enable_sonification;
diff --git a/src/plot_api/plot_api.js b/src/plot_api/plot_api.js
@@ -392,7 +392,7 @@ function _doPlot(gd, data, layout, config) {
     }
     seq.push(saveRangeInitialForInsideTickLabels);
 
-    if(gd._context.accessibility.enabled) seq.push(accessibility.enable);
+    if(gd._context.sonification.enabled) seq.push(accessibility.enable_sonification);
 
     seq.push(Plots.previousPromises);
 

diff --git a/src/plot_api/plot_config.js b/src/plot_api/plot_config.js
@@ -473,11 +473,10 @@ var configAttributes = {
         ].join(' ')
     },
 
-    accessibility: {
+    sonification: {
         valType: 'any',
         dflt: {
-            library: 'chart2music',
-            enabled: true,
+            enabled: false,
             options: {},
             info: {},
             closedCaptions: {generate: false, elId: 'c2m-plotly-cc', elClassname: 'c2m-plotly-closed_captions'}

diff --git a/test/image/mocks/line_scatter.json b/test/image/mocks/line_scatter.json
@@ -33,5 +33,14 @@
    "line": { "width": 10, "color": "red" },
    "marker": { "size": 20, "color": "blue" }
   }
- ]
+ ],
+ "config": {
+    "sonification": {
+        "enabled": true,
+        "closedCaptions": {
+            "generate": false,
+            "elId": "c2m-plotly-cc"
+        }
+    }
+ }
 }