Merge pull request #5658 from plotly/describe-config-modebar-strings

Document enabling predefined hidden modebar buttons via config.modeBarButtonsToAdd
plotly · May 14, 2021 · 0066e43 · 0066e43
2 parents 2eca2a6 + faa9cdd
commit 0066e43
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/src/plot_api/plot_config.js b/src/plot_api/plot_config.js
@@ -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: {