rename Plots getSubplotIdsInData -> findSubplotIds

Author: etpinard

src/plots/geo/layout/defaults.js

@@ -17,7 +17,7 @@ var supplyGeoAxisLayoutDefaults = require('./axis_defaults');
 
 
 module.exports = function supplyLayoutDefaults(layoutIn, layoutOut, fullData) {
-    var geos = Plots.getSubplotIdsInData(fullData, 'geo'),
+    var geos = Plots.findSubplotIds(fullData, 'geo'),
         geosLength = geos.length;
 
     var geoLayoutIn, geoLayoutOut;

src/plots/gl3d/layout/defaults.js

@@ -18,10 +18,8 @@ var supplyGl3dAxisLayoutDefaults = require('./axis_defaults');
 module.exports = function supplyLayoutDefaults(layoutIn, layoutOut, fullData) {
     if(!layoutOut._hasGL3D) return;
 
-    var scenes = Plots.getSubplotIdsInData(fullData, 'gl3d');
-
-    // Get number of scenes to compute default scene domain
-    var scenesLength = scenes.length;
+    var scenes = Plots.findSubplotIds(fullData, 'gl3d'),
+        scenesLength = scenes.length;
 
     var sceneLayoutIn, sceneLayoutOut;
 

src/plots/plots.js

@@ -140,8 +140,40 @@ plots.registerSubplot = function(_module) {
     subplotsRegistry[plotType] = _module;
 };
 
-// TODO separate the 'find subplot' step (which looks in layout)
-// from the 'get subplot ids' step (which looks in fullLayout._plots)
+/**
+ * Find subplot ids in data.
+ * Meant to be used in the defaults step.
+ *
+ * Use plots.getSubplotIds to grab the current
+ * subplot ids later on in Plotly.plot.
+ *
+ * @param {array} data plotly data array
+ *      (intended to be _fullData, but does not have to be).
+ * @param {string} type subplot type to look for.
+ *
+ * @return {array} list of subplot ids (strings).
+ *      N.B. these ids possibly un-ordered.
+ *
+ * TODO incorporate cartesian/gl2d axis finders in this paradigm.
+ */
+plots.findSubplotIds = function findSubplotIds(data, type) {
+    var subplotIds = [];
+
+    if(plots.subplotsRegistry[type] === undefined) return subplotIds;
+
+    var attr = plots.subplotsRegistry[type].attr;
+
+    for(var i = 0; i < data.length; i++) {
+        var trace = data[i];
+
+        if(plots.traceIs(trace, type) && subplotIds.indexOf(trace[attr]) === -1) {
+            subplotIds.push(trace[attr]);
+        }
+    }
+
+    return subplotIds;
+};
+
 plots.getSubplotIds = function getSubplotIds(layout, type) {
     if(plots.subplotsRegistry[type] === undefined) return [];
 
@@ -165,19 +197,6 @@ plots.getSubplotIds = function getSubplotIds(layout, type) {
     return subplotIds;
 };
 
-plots.getSubplotIdsInData = function getSubplotsInData(data, type) {
-    if(plots.subplotsRegistry[type] === undefined) return [];
-
-    var attr = plots.subplotsRegistry[type].attr,
-        subplotIds = [],
-        trace;
-
-    for (var i = 0; i < data.length; i++) {
-        trace = data[i];
-        if(Plotly.Plots.traceIs(trace, type) && subplotIds.indexOf(trace[attr])===-1) {
-            subplotIds.push(trace[attr]);
-        }
-    }
 
     return subplotIds;
 };

test/jasmine/tests/plots_test.js

@@ -145,31 +145,26 @@ describe('Test Plots', function() {
         });
     });
 
-    describe('Plots.getSubplotIdsInData', function() {
-        var getSubplotIdsInData = Plots.getSubplotIdsInData;
-
-        var ids, data;
-
-        it('it should return scene ids', function() {
-            data = [
-                {
-                    type: 'scatter3d',
-                    scene: 'scene'
-                },
-                {
-                    type: 'surface',
-                    scene: 'scene2'
-                },
-                {
-                    type: 'choropleth',
-                    geo: 'geo'
-                }
-            ];
-
-            ids = getSubplotIdsInData(data, 'geo');
+    describe('Plots.findSubplotIds', function() {
+        var findSubplotIds = Plots.findSubplotIds;
+        var ids;
+
+        it('should return subplots ids found in the data', function() {
+            var data = [{
+                type: 'scatter3d',
+                scene: 'scene'
+            }, {
+                type: 'surface',
+                scene: 'scene2'
+            }, {
+                type: 'choropleth',
+                geo: 'geo'
+            }];
+
+            ids = findSubplotIds(data, 'geo');
             expect(ids).toEqual(['geo']);
 
-            ids = getSubplotIdsInData(data, 'gl3d');
+            ids = findSubplotIds(data, 'gl3d');
             expect(ids).toEqual(['scene', 'scene2']);
         });