make scrollZoom a flaglist w/ dflt 'gl3d+geo+mapbox'

- which match the current "default", but will make scrollZoom:false disable zoom for all subplots!
plotly · etpinard · Jan 16, 2019 · Dec 26, 2018 · Dec 26, 2018 · Jan 8, 2019
commit c83538a4ae0c6b16f0341d5953422aeeb3ab7bd9
diff --git a/src/plot_api/plot_api.js b/src/plot_api/plot_api.js
@@ -507,6 +507,25 @@ function setPlotContext(gd, config) {
     // Check if gd has a specified widht/height to begin with
     context._hasZeroHeight = context._hasZeroHeight || gd.clientHeight === 0;
     context._hasZeroWidth = context._hasZeroWidth || gd.clientWidth === 0;
+
+    // fill context._scrollZoom helper to help manage scrollZoom flaglist
+    var szIn = context.scrollZoom;
+    var szOut = context._scrollZoom = {};
+    if(szIn === true) {
+        szOut.cartesian = 1;
+        szOut.gl3d = 1;
+        szOut.geo = 1;
+        szOut.mapbox = 1;
+    } else if(typeof szIn === 'string') {
+        var parts = szIn.split('+');
+        for(i = 0; i < parts.length; i++) {
+            szOut[parts[i]] = 1;
+        }
+    } else if(szIn !== false) {
+        szOut.gl3d = 1;
+        szOut.geo = 1;
+        szOut.mapbox = 1;
+    }
 }
 
 function plotLegacyPolar(gd, data, layout) {

@@ -145,11 +145,16 @@ var configAttributes = {
     },
 
     scrollZoom: {
 scrollZoom: { 
     valType: 'flaglist', 
     flags: ['cartesian', 'gl3d', 'geo', 'mapbox'], 
     extras: [true, false], 
     dflt: 'gl3d+geo+mapbox', 
     description: [ 
         'Determines whether mouse wheel or two-finger scroll zooms is enable.', 
         'Turned on by default for gl3d, geo and mapbox subplots', 
         '(as these subplot types do not have zoombox via pan),', 
         'but turned off by default for cartesian subplots.', 
         'Set `scrollZoom` to *false* to disable scrolling for all subplots.' 
     ].join(' ') 
 }, 
 scrollZoom: { 
     valType: 'flaglist', 
     flags: ['cartesian', 'gl3d', 'geo', 'mapbox'], 
     extras: [true, false], 
     dflt: 'gl3d+geo+mapbox', 
     description: [ 
         'Determines whether mouse wheel or two-finger scroll zooms is enable.', 
         'Turned on by default for gl3d, geo and mapbox subplots', 
         '(as these subplot types do not have zoombox via pan),', 
         'but turned off by default for cartesian subplots.', 
         'Set `scrollZoom` to *false* to disable scrolling for all subplots.' 
     ].join(' ') 
 }, 
-        valType: 'boolean',
-        dflt: false,
+        valType: 'flaglist',
+        flags: ['cartesian', 'gl3d', 'geo', 'mapbox'],
+        extras: [true, false],
+        dflt: 'gl3d+geo+mapbox',
         description: [
-            'Determines whether mouse wheel or two-finger scroll zooms is',
-            'enable. Has an effect only on cartesian subplots.'
+            'Determines whether mouse wheel or two-finger scroll zooms is enable.',
+            'Turned on by default for gl3d, geo and mapbox subplots',
+            '(as these subplot types do not have zoombox via pan),',
+            'but turned off by default for cartesian subplots.',
+            'Set `scrollZoom` to *false* to disable scrolling for all subplots.'
         ].join(' ')
     },
     doubleClick: {

@@ -417,7 +417,7 @@ function makeDragBox(gd, plotinfo, x, y, w, h, ns, ew) {
         // deactivate mousewheel scrolling on embedded graphs
         // devs can override this with layout._enablescrollzoom,
         // but _ ensures this setting won't leave their page
-        if(!gd._context.scrollZoom && !gd._fullLayout._enablescrollzoom) {
+        if(!gd._context._scrollZoom.cartesian && !gd._fullLayout._enablescrollzoom) {
             return;
         }
 

@@ -38,7 +38,7 @@ function Scene2D(options, fullLayout) {
     this.pixelRatio = options.plotGlPixelRatio || window.devicePixelRatio;
     this.id = options.id;
     this.staticPlot = !!options.staticPlot;
-    this.scrollZoom = this.graphDiv._context.scrollZoom;
+    this.scrollZoom = this.graphDiv._context._scrollZoom.cartesian;
 
     this.fullData = null;
     this.updateRefs(fullLayout);

@@ -760,4 +760,61 @@ describe('config argument', function() {
             .then(done);
         });
     });
+
+    describe('scrollZoom:', function() {
+        var gd;
+
+        beforeEach(function() { gd = createGraphDiv(); });
+
+        afterEach(destroyGraphDiv);
+
+        function plot(config) {
+            return Plotly.plot(gd, [], {}, config);
+        }
+
+        it('should fill in scrollZoom default', function(done) {
+            plot(undefined).then(function() {
+                expect(gd._context.scrollZoom).toBe('gl3d+geo+mapbox');
+                expect(gd._context._scrollZoom).toEqual({gl3d: 1, geo: 1, mapbox: 1});
+            })
+            .catch(failTest)
+            .then(done);
+        });
+
+        it('should fill in blank scrollZoom value', function(done) {
+            plot({scrollZoom: null}).then(function() {
+                expect(gd._context.scrollZoom).toBe(null);
+                expect(gd._context._scrollZoom).toEqual({gl3d: 1, geo: 1, mapbox: 1});
+            })
+            .catch(failTest)
+            .then(done);
+        });
+
+        it('should honor scrollZoom:true', function(done) {
+            plot({scrollZoom: true}).then(function() {
+                expect(gd._context.scrollZoom).toBe(true);
+                expect(gd._context._scrollZoom).toEqual({gl3d: 1, geo: 1, cartesian: 1, mapbox: 1});
+            })
+            .catch(failTest)
+            .then(done);
+        });
+
+        it('should honor scrollZoom:false', function(done) {
+            plot({scrollZoom: false}).then(function() {
+                expect(gd._context.scrollZoom).toBe(false);
+                expect(gd._context._scrollZoom).toEqual({});
+            })
+            .catch(failTest)
+            .then(done);
+        });
+
+        it('should honor scrollZoom flaglist', function(done) {
+            plot({scrollZoom: 'mapbox+cartesian'}).then(function() {
+                expect(gd._context.scrollZoom).toBe('mapbox+cartesian');
+                expect(gd._context._scrollZoom).toEqual({mapbox: 1, cartesian: 1});
+            })
+            .catch(failTest)
+            .then(done);
+        });
+    });
 });