diff --git a/draftlogs/7358_add.md b/draftlogs/7358_add.md new file mode 100644 index 00000000000..a85b49dd665 --- /dev/null +++ b/draftlogs/7358_add.md @@ -0,0 +1 @@ +- Add modebarbuttons attribute to cartesian axes, to allow fine control over which buttons affect which axes [[#7358](https://github.com/plotly/plotly.js/pull/7358)] diff --git a/src/components/modebar/buttons.js b/src/components/modebar/buttons.js index 82c5dff9a48..6ed0e0178f4 100644 --- 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 index 1683b082617..6607175762e 100644 --- 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 index 32afc99457a..c3e4d7fe976 100644 --- 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 index 90351ecfa1b..dc929142646 100644 --- 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 index 0a9ea06c52a..e3c32c7f5db 100644 --- 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 index 6aa77cf3338..2172bc4431d 100644 --- 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,