Add config options to remove specific modebar buttons #23
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,166 @@ | ||
| /** | ||
| * Copyright 2012-2015, Plotly, Inc. | ||
| * All rights reserved. | ||
| * | ||
| * This source code is licensed under the MIT license found in the | ||
| * LICENSE file in the root directory of this source tree. | ||
| */ | ||
|
|
||
|
|
||
| 'use strict'; | ||
|
|
||
| var Plotly = require('../../plotly'); | ||
|
|
||
| var createModeBar = require('./'); | ||
| var modeBarButtons = require('./buttons'); | ||
|
|
||
| /** | ||
| * ModeBar wrapper around 'create' and 'update', | ||
| * chooses buttons to pass to ModeBar constructor based on | ||
| * plot type and plot config. | ||
| * | ||
| * @param {object} gd main plot object | ||
| * | ||
| */ | ||
| module.exports = function manageModeBar(gd) { | ||
| var fullLayout = gd._fullLayout, | ||
| context = gd._context, | ||
| modeBar = fullLayout._modeBar; | ||
|
|
||
| if(!context.displayModeBar && modeBar) { | ||
| modeBar.destroy(); | ||
| delete fullLayout._modeBar; | ||
| return; | ||
| } | ||
|
|
||
| if(!Array.isArray(context.modeBarButtonsToRemove)) { | ||
| throw new Error([ | ||
| '*modeBarButtonsToRemove* configuration options', | ||
| 'must be an array.' | ||
| ].join(' ')); | ||
| } | ||
|
|
||
| if(!Array.isArray(context.modeBarButtonsToAdd)) { | ||
| throw new Error([ | ||
| '*modeBarButtonsToAdd* configuration options', | ||
| 'must be an array.' | ||
| ].join(' ')); | ||
| } | ||
|
|
||
| var customButtons = context.modeBarButtons; | ||
| var buttonGroups; | ||
|
|
||
| if(Array.isArray(customButtons) && customButtons.length) { | ||
| buttonGroups = fillCustomButton(customButtons); | ||
| } | ||
| else { | ||
| buttonGroups = getButtonGroups( | ||
| fullLayout, | ||
| context.modeBarButtonsToRemove, | ||
| context.modeBarButtonsToAdd | ||
| ); | ||
| } | ||
|
|
||
| if(modeBar) modeBar.update(gd, buttonGroups); | ||
| else fullLayout._modeBar = createModeBar(gd, buttonGroups); | ||
| }; | ||
|
|
||
| // logic behind which buttons are displayed by default | ||
| function getButtonGroups(fullLayout, buttonsToRemove, buttonsToAdd) { | ||
| var groups = []; | ||
|
|
||
| function addGroup(newGroup) { | ||
| var out = []; | ||
|
|
||
| for(var i = 0; i < newGroup.length; i++) { | ||
| var button = newGroup[i]; | ||
| if(buttonsToRemove.indexOf(button) !== -1) continue; | ||
| out.push(modeBarButtons[button]); | ||
| } | ||
|
|
||
| groups.push(out); | ||
| } | ||
|
|
||
| // buttons common to all plot types | ||
| addGroup(['toImage', 'sendDataToCloud']); | ||
|
There was a problem hiding this comment. the modebar manager selects which buttons config objects to passed to the Modebar constructor based on the plot type. |
||
|
|
||
| if(fullLayout._hasGL3D) { | ||
| addGroup(['zoom3d', 'pan3d', 'orbitRotation', 'tableRotation']); | ||
| addGroup(['resetCameraDefault3d', 'resetCameraLastSave3d']); | ||
| addGroup(['hoverClosest3d']); | ||
| } | ||
|
|
||
| if(fullLayout._hasGeo) { | ||
| addGroup(['zoomInGeo', 'zoomOutGeo', 'resetGeo']); | ||
| addGroup(['hoverClosestGeo']); | ||
| } | ||
|
|
||
| var hasCartesian = fullLayout._hasCartesian, | ||
| hasGL2D = fullLayout._hasGL2D, | ||
| allAxesFixed = areAllAxesFixed(fullLayout); | ||
|
|
||
| if((hasCartesian || hasGL2D) && !allAxesFixed) { | ||
| addGroup(['zoom2d', 'pan2d']); | ||
| addGroup(['zoomIn2d', 'zoomOut2d', 'autoScale2d', 'resetScale2d']); | ||
| } | ||
|
|
||
| if(hasCartesian) { | ||
| addGroup(['hoverClosestCartesian', 'hoverCompareCartesian']); | ||
| } | ||
| if(hasGL2D) { | ||
| addGroup(['hoverClosestGl2d']); | ||
| } | ||
| if(fullLayout._hasPie) { | ||
| addGroup(['hoverClosestPie']); | ||
| } | ||
|
|
||
| // append buttonsToAdd to the groups | ||
| if(buttonsToAdd.length) { | ||
| if(Array.isArray(buttonsToAdd[0])) { | ||
| for(var i = 0; i < buttonsToAdd.length; i++) { | ||
| groups.push(buttonsToAdd[i]); | ||
| } | ||
| } | ||
| else groups.push(buttonsToAdd); | ||
| } | ||
|
|
||
| return groups; | ||
| } | ||
|
|
||
| function areAllAxesFixed(fullLayout) { | ||
| var axList = Plotly.Axes.list({_fullLayout: fullLayout}, null, true); | ||
| var allFixed = true; | ||
|
|
||
| for(var i = 0; i < axList.length; i++) { | ||
| if(!axList[i].fixedrange) { | ||
| allFixed = false; | ||
| break; | ||
| } | ||
| } | ||
|
|
||
| return allFixed; | ||
| } | ||
|
|
||
| // fill in custom buttons referring to default mode bar buttons | ||
| function fillCustomButton(customButtons) { | ||
| for(var i = 0; i < customButtons.length; i++) { | ||
| var buttonGroup = customButtons[i]; | ||
|
|
||
| for(var j = 0; j < buttonGroup.length; j++) { | ||
| var button = buttonGroup[j]; | ||
|
|
||
| if(typeof button === 'string') | ||
| if(modeBarButtons[button] !== undefined) { | ||
| customButtons[i][j] = modeBarButtons[button]; | ||
| } | ||
| else { | ||
| throw new Error([ | ||
| '*modeBarButtons* configuration options', | ||
| 'invalid button name' | ||
| ].join(' ')); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return customButtons; | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
if button
nameis part of themodebarButtonToRemoveplot config list, do not pass it the Modebar constructor.