new cartesian axis modebarbuttons attribute

alexcjohnson · alexcjohnson · commit e34618bfa24b · 2025-02-08T11:03:42.000-05:00
diff --git a/src/components/modebar/buttons.js b/src/components/modebar/buttons.js
@@ -256,12 +256,15 @@ function handleCartesian(gd, ev) {
         var mag = (val === 'in') ? 0.5 : 2;
         var r0 = (1 + mag) / 2;
         var r1 = (1 - mag) / 2;
-        var axName;
+        var axName, allowed;
 
         for(i = 0; i < axList.length; i++) {
             ax = axList[i];
+            allowed = ax.modebarbuttons === 'all' || ax.modebarbuttons.indexOf(
+                (val === 'auto' || val === 'reset') ? 'auto' : 'inout'
+            ) !== -1;
 
-            if(!ax.fixedrange) {
+            if(allowed && !ax.fixedrange) {
                 axName = ax._name;
                 if(val === 'auto') {
                     aobj[axName + '.autorange'] = true;
diff --git a/src/components/modebar/manage.js b/src/components/modebar/manage.js
@@ -269,7 +269,7 @@ function areAllAxesFixed(fullLayout) {
     var axList = axisIds.list({_fullLayout: fullLayout}, null, true);
 
     for(var i = 0; i < axList.length; i++) {
-        if(!axList[i].fixedrange) {
+        if(!axList[i].fixedrange && axList[i].modebarbuttons !== 'none') {
             return false;
         }
     }
diff --git a/src/plots/cartesian/layout_attributes.js b/src/plots/cartesian/layout_attributes.js
@@ -389,6 +389,18 @@ module.exports = {
             'If true, then zoom is disabled.'
         ].join(' ')
     },
+    modebarbuttons: {
+        valType: 'flaglist',
+        flags: ['auto', 'inout'],
+        extras: ['all', 'none'],
+        dflt: 'all',
+        editType: 'modebar',
+        description: [
+            'Determines which modebar buttons impact this axis.',
+            '*auto* allows the autoscale buttons, *inout* allows the',
+            'zoom-in and zoom-out buttons.'
+        ].join(' ')
+    },
     insiderange: {
         valType: 'info_array',
         items: [
diff --git a/src/plots/cartesian/layout_defaults.js b/src/plots/cartesian/layout_defaults.js
@@ -338,6 +338,7 @@ module.exports = function supplyLayoutDefaults(layoutIn, layoutOut, fullData) {
         });
 
         coerce('fixedrange');
+        coerce('modebarbuttons');
 
         addMissingMatchedAxis();
 
@@ -366,6 +367,7 @@ module.exports = function supplyLayoutDefaults(layoutIn, layoutOut, fullData) {
         }
 
         coerce('fixedrange');
+        coerce('modebarbuttons');
     }
 
     for(i = 0; i < yNames.length; i++) {
@@ -378,6 +380,7 @@ module.exports = function supplyLayoutDefaults(layoutIn, layoutOut, fullData) {
         var fixedRangeDflt = getComponentMethod('rangeslider', 'isVisible')(anchoredAxis);
 
         coerce('fixedrange', fixedRangeDflt);
+        coerce('modebarbuttons');
     }
 
     // Finally, handle scale constraints and matching axes.
diff --git a/test/jasmine/tests/modebar_test.js b/test/jasmine/tests/modebar_test.js
@@ -1193,6 +1193,62 @@ describe('ModeBar', function() {
                     assertRange('xaxis2', [-1, 4]);
                     assertRange('yaxis2', [0, 4]);
                 });
+
+                it('should respect modebarbuttons attribute', function(done) {
+                    Plotly.relayout(gd, {
+                        'xaxis.modebarbuttons': 'none',
+                        'xaxis2.modebarbuttons': 'auto',
+                        'yaxis.modebarbuttons': 'inout',
+                    }).then(function() {
+                        var buttonZoomIn = selectButton(modeBar, 'zoomIn2d');
+                        var buttonZoomOut = selectButton(modeBar, 'zoomOut2d');
+
+                        assertRange('xaxis', ['2016-01-01', '2016-04-01']);
+                        assertRange('yaxis', [1, 3]);
+                        assertRange('xaxis2', [-1, 4]);
+                        assertRange('yaxis2', [0, 4]);
+
+                        // xaxis and xaxis2 should not be affected by zoom in/out
+                        // yaxis and yaxis2 should be affected as in previous test
+                        buttonZoomIn.click();
+                        assertRange('xaxis', ['2016-01-01', '2016-04-01']);
+                        assertRange('yaxis', [1.5, 2.5]);
+                        assertRange('xaxis2', [-1, 4]);
+                        assertRange('yaxis2', [1, 3]);
+
+                        buttonZoomOut.click();
+                        assertRange('xaxis', ['2016-01-01', '2016-04-01']);
+                        assertRange('yaxis', [1, 3]);
+                        assertRange('xaxis2', [-1, 4]);
+                        assertRange('yaxis2', [0, 4]);
+
+                        return Plotly.relayout(gd, {
+                            'xaxis.range': ['2016-01-23 17:45', '2016-03-09 05:15'],
+                            'yaxis.range': [1.5, 2.5],
+                            'xaxis2.range': [0.25, 2.75],
+                            'yaxis2.range': [1, 3],
+                        });
+                    })
+                    .then(function() {
+                        var buttonAutoScale = selectButton(modeBar, 'autoScale2d');
+                        var buttonResetScale = selectButton(modeBar, 'resetScale2d');
+
+                        // xaxis and yaxis should not be affected by autorange
+                        // xaxis2 and yaxis2 should be affected as in previous test
+                        buttonAutoScale.click();
+                        assertRange('xaxis', ['2016-01-23 17:45', '2016-03-09 05:15']);
+                        assertRange('yaxis', [1.5, 2.5]);
+                        assertRange('xaxis2', [-0.5, 2.5]);
+                        assertRange('yaxis2', [0, 2.105263]);
+
+                        buttonResetScale.click();
+                        assertRange('xaxis', ['2016-01-23 17:45', '2016-03-09 05:15']);
+                        assertRange('yaxis', [1.5, 2.5]);
+                        assertRange('xaxis2', [-1, 4]);
+                        assertRange('yaxis2', [0, 4]);
+                    })
+                    .then(done, done.fail)
+                });
             });
 
             describe('buttons zoom2d, pan2d, select2d and lasso2d', function() {
diff --git a/test/plot-schema.json b/test/plot-schema.json
@@ -13912,6 +13912,20 @@
       "allticks"
      ]
     },
+    "modebarbuttons": {
+     "description": "Determines which modebar buttons impact this axis. *auto* allows the autoscale buttons, *inout* allows the zoom-in and zoom-out buttons.",
+     "dflt": "all",
+     "editType": "modebar",
+     "extras": [
+      "all",
+      "none"
+     ],
+     "flags": [
+      "auto",
+      "inout"
+     ],
+     "valType": "flaglist"
+    },
     "nticks": {
      "description": "Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to *auto*.",
      "dflt": 0,
@@ -15463,6 +15477,20 @@
       "allticks"
      ]
     },
+    "modebarbuttons": {
+     "description": "Determines which modebar buttons impact this axis. *auto* allows the autoscale buttons, *inout* allows the zoom-in and zoom-out buttons.",
+     "dflt": "all",
+     "editType": "modebar",
+     "extras": [
+      "all",
+      "none"
+     ],
+     "flags": [
+      "auto",
+      "inout"
+     ],
+     "valType": "flaglist"
+    },
     "nticks": {
      "description": "Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to *auto*.",
      "dflt": 0,

Original file line number	Diff line number	Diff line change
`@@ -269,7 +269,7 @@ function areAllAxesFixed(fullLayout) {`
`269`	`269`	`var axList = axisIds.list({_fullLayout: fullLayout}, null, true);`
`270`	`270`
`271`	`271`	`for(var i = 0; i < axList.length; i++) {`
`272`		`- if(!axList[i].fixedrange) {`
	`272`	`+ if(!axList[i].fixedrange && axList[i].modebarbuttons !== 'none') {`
`273`	`273`	`return false;`
`274`	`274`	`}`
`275`	`275`	`}`
Original file line number	Diff line number	Diff line change
`@@ -338,6 +338,7 @@ module.exports = function supplyLayoutDefaults(layoutIn, layoutOut, fullData) {`
`338`	`338`	`});`
`339`	`339`
`340`	`340`	`coerce('fixedrange');`
	`341`	`+ coerce('modebarbuttons');`
`341`	`342`
`342`	`343`	`addMissingMatchedAxis();`
`343`	`344`
`@@ -366,6 +367,7 @@ module.exports = function supplyLayoutDefaults(layoutIn, layoutOut, fullData) {`
`366`	`367`	`}`
`367`	`368`
`368`	`369`	`coerce('fixedrange');`
	`370`	`+ coerce('modebarbuttons');`
`369`	`371`	`}`
`370`	`372`
`371`	`373`	`for(i = 0; i < yNames.length; i++) {`
`@@ -378,6 +380,7 @@ module.exports = function supplyLayoutDefaults(layoutIn, layoutOut, fullData) {`
`378`	`380`	`var fixedRangeDflt = getComponentMethod('rangeslider', 'isVisible')(anchoredAxis);`
`379`	`381`
`380`	`382`	`coerce('fixedrange', fixedRangeDflt);`
	`383`	`+ coerce('modebarbuttons');`
`381`	`384`	`}`
`382`	`385`
`383`	`386`	`// Finally, handle scale constraints and matching axes.`