filter layout additions if removed by config and vice versa

plotly · May 17, 2021 · 3daa2f3 · 3daa2f3
1 parent bf3416d
commit 3daa2f3
Show file tree

Hide file tree

Showing 2 changed files with 67 additions and 4 deletions.
diff --git a/src/components/modebar/manage.js b/src/components/modebar/manage.js
@@ -72,10 +72,33 @@ function getButtonGroups(gd) {
     var fullLayout = gd._fullLayout;
     var fullData = gd._fullData;
     var context = gd._context;
-    var buttonsToAdd = context.modeBarButtonsToAdd
-        .concat(fullLayout.modebar.add.split('+'));
-    var buttonsToRemove = context.modeBarButtonsToRemove
-        .concat(fullLayout.modebar.remove.split('+'));
+
+    function match(name, B) {
+        if(typeof B === 'string') {
+            if(B === name) return true;
+        } else {
+            if(B.name === name || B._cat === name) return true;
+        }
+        return false;
+    }
+
+    var buttonsToAdd = context.modeBarButtonsToAdd.concat(
+        fullLayout.modebar.add.split('+').filter(function(e) {
+            for(var i = 0; i < context.modeBarButtonsToRemove.length; i++) {
+                if(match(e, context.modeBarButtonsToRemove[i])) return false;
+            }
+            return true;
+        })
+    );
+
+    var buttonsToRemove = context.modeBarButtonsToRemove.concat(
+        fullLayout.modebar.remove.split('+').filter(function(e) {
+            for(var i = 0; i < context.modeBarButtonsToAdd.length; i++) {
+                if(match(e, context.modeBarButtonsToAdd[i])) return false;
+            }
+            return true;
+        })
+    );
 
     var hasCartesian = fullLayout._has('cartesian');
     var hasGL3D = fullLayout._has('gl3d');

diff --git a/test/jasmine/tests/modebar_test.js b/test/jasmine/tests/modebar_test.js
@@ -1726,6 +1726,46 @@ describe('ModeBar', function() {
             })
             .then(done, done.fail);
         });
+
+        it('add button if removed by layout and added by config', function(done) {
+            function countButtons() {
+                var modeBarEl = gd._fullLayout._modeBar.element;
+                return d3Select(modeBarEl).selectAll('a.modebar-btn').size();
+            }
+
+            var initial = 10;
+            Plotly.newPlot(gd, [{y: [1, 2]}], {
+                modebar: {
+                    remove: 'zoom'
+                }
+            }, {
+                modeBarButtonsToAdd: ['zoom']
+            })
+            .then(function() {
+                expect(countButtons()).toBe(initial);
+            })
+            .then(done, done.fail);
+        });
+
+        it('remove button if added by layout and removed by config', function(done) {
+            function countButtons() {
+                var modeBarEl = gd._fullLayout._modeBar.element;
+                return d3Select(modeBarEl).selectAll('a.modebar-btn').size();
+            }
+
+            var initial = 10;
+            Plotly.newPlot(gd, [{y: [1, 2]}], {
+                modebar: {
+                    add: 'drawline'
+                }
+            }, {
+                modeBarButtonsToRemove: ['drawline']
+            })
+            .then(function() {
+                expect(countButtons()).toBe(initial);
+            })
+            .then(done, done.fail);
+        });
     });
 
     describe('modebar html', function() {