Skip to content

Document enabling predefined hidden modebar buttons via config.modeBarButtonsToAdd #5658

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 14, 2021
Merged

Document enabling predefined hidden modebar buttons via config.modeBarButtonsToAdd #5658

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6702713
provide info about predefined hidden modebar buttons
archmoj May 14, 2021
faa9cdd
Update src/plot_api/plot_config.js
archmoj May 14, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion src/plot_api/plot_config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -287,7 +287,13 @@ var configAttributes = {
dflt: [],
description: [
'Add mode bar button using config objects',
'See ./components/modebar/buttons.js for list of arguments.'
'See ./components/modebar/buttons.js for list of arguments.',
'To enable predefined modebar buttons e.g. shape drawing, hover and spikelines,',
'simply provide their string name(s). This could include:',
'*v1hovermode*, *hoverclosest*, *hovercompare*, *togglehover*, *togglespikelines*,',
'*drawline*, *drawopenpath*, *drawclosedpath*, *drawcircle*, *drawrect* and *eraseshape*.',
'Please note that these predefined buttons will only be shown if they are compatible',
'with all trace types used in a graph.'
].join(' ')
},
modeBarButtons: {
Expand Down