Skip to content

Commit 0066e43

Browse files
authored
Merge pull request #5658 from plotly/describe-config-modebar-strings
Document enabling predefined hidden modebar buttons via config.modeBarButtonsToAdd
2 parents 2eca2a6 + faa9cdd commit 0066e43

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

src/plot_api/plot_config.js

+7-1
Original file line numberDiff line numberDiff line change
@@ -287,7 +287,13 @@ var configAttributes = {
287287
dflt: [],
288288
description: [
289289
'Add mode bar button using config objects',
290-
'See ./components/modebar/buttons.js for list of arguments.'
290+
'See ./components/modebar/buttons.js for list of arguments.',
291+
'To enable predefined modebar buttons e.g. shape drawing, hover and spikelines,',
292+
'simply provide their string name(s). This could include:',
293+
'*v1hovermode*, *hoverclosest*, *hovercompare*, *togglehover*, *togglespikelines*,',
294+
'*drawline*, *drawopenpath*, *drawclosedpath*, *drawcircle*, *drawrect* and *eraseshape*.',
295+
'Please note that these predefined buttons will only be shown if they are compatible',
296+
'with all trace types used in a graph.'
291297
].join(' ')
292298
},
293299
modeBarButtons: {

0 commit comments

Comments
 (0)