add constant file and list options in descriptions

plotly · May 18, 2021 · 3293097 · 3293097
1 parent 5c17d6b
commit 3293097
Show file tree

Hide file tree

Showing 3 changed files with 48 additions and 35 deletions.
diff --git a/src/components/modebar/attributes.js b/src/components/modebar/attributes.js
@@ -1,5 +1,7 @@
 'use strict';
 
+var constants = require('./constants');
+
 module.exports = {
     editType: 'modebar',
 
@@ -43,7 +45,8 @@ module.exports = {
             'Determines which predefined modebar buttons to add.',
             'Please note that these buttons will only be shown if they are',
             'compatible with all trace types used in a graph.',
-            'Similar to `config.modeBarButtonsToAdd` option'
+            'Similar to `config.modeBarButtonsToAdd` option.',
+            'This may include *' + constants.backButtons.join('*, *') + '*.'
         ].join(' ')
     },
     remove: {
@@ -53,7 +56,8 @@ module.exports = {
         editType: 'modebar',
         description: [
             'Determines which predefined modebar buttons to remove.',
-            'Similar to `config.modeBarButtonsToRemove` option'
+            'Similar to `config.modeBarButtonsToRemove` option.',
+            'This may include *' + constants.foreButtons.join('*, *') + '*.'
         ].join(' ')
     }
 };
diff --git a/src/components/modebar/constants.js b/src/components/modebar/constants.js
@@ -0,0 +1,41 @@
+'use strict';
+
+var modeBarButtons = require('./buttons');
+var buttonList = Object.keys(modeBarButtons);
+
+var DRAW_MODES = [
+    'drawline',
+    'drawopenpath',
+    'drawclosedpath',
+    'drawcircle',
+    'drawrect',
+    'eraseshape'
+];
+
+var backButtons = [
+    'v1hovermode',
+    'hoverclosest',
+    'hovercompare',
+    'togglehover',
+    'togglespikelines'
+].concat(DRAW_MODES);
+
+var foreButtons = [];
+var addToForeButtons = function(b) {
+    if(backButtons.indexOf(b._cat || b.name) !== -1) return;
+    // for convenience add lowercase shotname e.g. zoomin as well fullname zoomInGeo
+    var name = b.name;
+    var _cat = (b._cat || b.name).toLowerCase();
+    if(foreButtons.indexOf(name) === -1) foreButtons.push(name);
+    if(foreButtons.indexOf(_cat) === -1) foreButtons.push(_cat);
+};
+buttonList.forEach(function(k) {
+    addToForeButtons(modeBarButtons[k]);
+});
+foreButtons.sort();
+
+module.exports = {
+    DRAW_MODES: DRAW_MODES,
+    backButtons: backButtons,
+    foreButtons: foreButtons
+};
diff --git a/src/components/modebar/manage.js b/src/components/modebar/manage.js
@@ -7,39 +7,7 @@ var isUnifiedHover = require('../fx/helpers').isUnifiedHover;
 
 var createModeBar = require('./modebar');
 var modeBarButtons = require('./buttons');
-var buttonList = Object.keys(modeBarButtons);
-
-var DRAW_MODES = [
-    'drawline',
-    'drawopenpath',
-    'drawclosedpath',
-    'drawcircle',
-    'drawrect',
-    'eraseshape'
-];
-
-var backButtons = [
-    'v1hovermode',
-    'hoverclosest',
-    'hovercompare',
-    'togglehover',
-    'togglespikelines'
-].concat(DRAW_MODES);
-
-var foreButtons = [];
-var addToForeButtons = function(b) {
-    if(backButtons.indexOf(b._cat || b.name) !== -1) return;
-    // for convenience add lowercase shotname e.g. zoomin as well fullname zoomInGeo
-    var name = b.name;
-    var _cat = (b._cat || b.name).toLowerCase();
-    if(foreButtons.indexOf(name) === -1) foreButtons.push(name);
-    if(foreButtons.indexOf(_cat) === -1) foreButtons.push(_cat);
-};
-buttonList.forEach(function(k) {
-    addToForeButtons(modeBarButtons[k]);
-});
-foreButtons.sort();
-
+var DRAW_MODES = require('./constants').DRAW_MODES;
 
 /**
  * ModeBar wrapper around 'create' and 'update',