Rename more stuff to sonification and clean up contributing

plotly · aliwelchoo · Jul 21, 2023 · Jul 21, 2023 · Jul 21, 2023 · Jul 21, 2023
commit d18c584ec0d208c73d0919f2b7c8780a0e51cd74
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -276,9 +276,9 @@ npm run baseline mock_*
 ```

 **IMPORTANT:** the `baseline`, `test-image` and `test-export` scripts do **not** bundle the source files before
-running the image tests. We recommend running `npm run watch` or `npm start` in
+running the image tests. We recommend running `npm start` in
 a separate tab to ensure that the most up-to-date code is used.
-Also if you are adding a new mock, you may need to re-run `npm start` or `npm run watch`
+Also if you are adding a new mock, you may need to re-run `npm start` 
 to be able to find the new mock in the browser.
 To help ensure valid attributes are used in your new mock(s), please run `npm run test-mock`
 or `npm run test-mock mock_name(s)` after adding new mocks or implementing any new attributes.

diff --git a/src/plot_api/accessibility.js → ...ility/sonification/enable_sonification.js b/src/plot_api/accessibility.js → ...ility/sonification/enable_sonification.js
diff --git a/src/plot_api/plot_api.js b/src/plot_api/plot_api.js
@@ -29,7 +29,7 @@ var manageArrays = require('./manage_arrays');
 var helpers = require('./helpers');
 var subroutines = require('./subroutines');
 var editTypes = require('./edit_types');
-var accessibility = require('./accessibility');
+var sonification = require('../accessibility/sonification/enable_sonification');

 var AX_NAME_PATTERN = require('../plots/cartesian/constants').AX_NAME_PATTERN;

@@ -392,7 +392,7 @@ function _doPlot(gd, data, layout, config) {
    }
    seq.push(saveRangeInitialForInsideTickLabels);

-    if(gd._context.sonification.enabled) seq.push(accessibility.enable_sonification);
+    if(gd._context.sonification.enabled) seq.push(sonification.enable_sonification);

    seq.push(Plots.previousPromises);


diff --git a/test/image/mocks/zz-chart2music.json b/test/image/mocks/zz-chart2music.json
@@ -0,0 +1,58 @@
+{
+    "data": [
+     {
+      "x": [1, 2, 3, 4],
+      "y": [10, 15, 13, 17],
+      "mode": "markers",
+      "type": "scatter",
+      "marker": {
+       "opacity": 0.5
+      }
+     },
+     {
+      "x": [2, 3, 4, 5],
+      "y": [16, 5, 11, 9],
+      "mode": "lines",
+      "type": "scatter",
+      "opacity": 0.5
+     },
+     {
+      "x": [1, 2, 3, 4],
+      "y": [12, 9, 15, 12],
+      "mode": "lines+markers",
+      "type": "scatter",
+      "opacity": 0.707,
+      "marker": {
+       "opacity": 0.707
+      }
+     },
+     {
+      "x": [1, 2, 3],
+      "y": [1, 2, 3],
+      "opacity": 0.2,
+      "line": { "width": 10, "color": "red" },
+      "marker": { "size": 20, "color": "blue" }
+     }
+    ],
+    "config": {
+       "sonification": {
+           "enabled": true,
+           "info": {
+               "notes": [
+                 "Sample notes to show"
+               ],
+               "annotations": [
+                 {
+                   "x": 6, 
+                   "label": "This is an annotation to show at x=6"
+                 }
+               ]
+           },
+           "closedCaptions": {
+               "generate": false,
+               "elId": "c2m-plotly-cc"
+           }
+       }
+    }
+   }
+
-Original file line number
+Diff line change
@@ -29,7 +29,7 @@ var manageArrays = require('./manage_arrays');
     var helpers = require('./helpers');
     var subroutines = require('./subroutines');
     var editTypes = require('./edit_types');
-    var accessibility = require('./accessibility');
+    var sonification = require('../accessibility/sonification/enable_sonification');
     var AX_NAME_PATTERN = require('../plots/cartesian/constants').AX_NAME_PATTERN;
@@ -392,7 +392,7 @@ function _doPlot(gd, data, layout, config) {
         }
         seq.push(saveRangeInitialForInsideTickLabels);
-        if(gd._context.sonification.enabled) seq.push(accessibility.enable_sonification);
+        if(gd._context.sonification.enabled) seq.push(sonification.enable_sonification);
             Copy link

  
      
    
  

  
      

  
    Contributor


      

  

  
    
      

      
            archmoj
  

      

      

      


        Oct 1, 2024


      
    

  


        
      
  
  
  
    

    There was a problem hiding this comment.


  

 
  
    

    Choose a reason for hiding this comment

    
      The reason will be displayed to describe this comment to others. Learn more.
    

    
      
      


  


  
    
      IS sonification key always present?
    
  
  


    

        
      
  
  
    
  
  
  
    
    Sorry, something went wrong.
  

  
    
  
    
      

              Uh oh!

              
There was an error while loading. Please reload this page.


  
  


          
      
  
    
    
      
        
            
    All reactions
         seq.push(Plots.previousPromises);
-          Expand Down