condense axisid, sceneid, geoid to subplotid

Author: alexcjohnson

src/lib/coerce.js

@@ -16,6 +16,7 @@ var nestedProperty = require('./nested_property');
 var getColorscale = require('../components/colorscale/get_scale');
 var colorscaleNames = Object.keys(require('../components/colorscale/scales'));
 
+var idRegex = /^([2-9]|[1-9][0-9]+)$/
 
 exports.valObjects = {
     data_array: {
@@ -158,53 +159,20 @@ exports.valObjects = {
             }
         }
     },
-    axisid: {
+    subplotid: {
         description: [
-            'An axis id string (e.g. \'x\', \'x2\', \'x3\', ...).'
+            'An id string of a subplot type (given by dflt), optionally',
+            'followed by an integer >1. e.g. if dflt=\'geo\', we can  have',
+            '\'geo\', \'geo2\', \'geo3\', ...'
         ].join(' '),
         requiredOpts: [],
         otherOpts: ['dflt'],
         coerceFunction: function(v, propOut, dflt) {
-            if(typeof v === 'string' && v.charAt(0)===dflt) {
-                var axnum = Number(v.substr(1));
-                if(axnum%1 === 0 && axnum>1) {
-                    propOut.set(v);
-                    return;
-                }
-            }
-            propOut.set(dflt);
-        }
-    },
-    sceneid: {
-        description: [
-            'A scene id string (e.g. \'scene\', \'scene2\', \'scene3\', ...).'
-        ].join(' '),
-        requiredOpts: [],
-        otherOpts: ['dflt'],
-        coerceFunction: function(v, propOut, dflt) {
-            if(typeof v === 'string' && v.substr(0,5)===dflt) {
-                var scenenum = Number(v.substr(5));
-                if(scenenum%1 === 0 && scenenum>1) {
-                    propOut.set(v);
-                    return;
-                }
-            }
-            propOut.set(dflt);
-        }
-    },
-    geoid: {
-        description: [
-            'A geo id string (e.g. \'geo\', \'geo2\', \'geo3\', ...).'
-        ].join(' '),
-        requiredOpts: [],
-        otherOpts: ['dflt'],
-        coerceFunction: function(v, propOut, dflt) {
-            if(typeof v === 'string' && v.substr(0,3)===dflt) {
-                var geonum = Number(v.substr(3));
-                if(geonum%1 === 0 && geonum>1) {
-                    propOut.set(v);
-                    return;
-                }
+            var dlen = dflt.length;
+            if(typeof v === 'string' && v.substr(0, dlen) === dflt &&
+                    idRegex.test(v.substr(dlen))) {
+                propOut.set(v);
+                return;
             }
             propOut.set(dflt);
         }

src/plots/cartesian/attributes.js

@@ -11,7 +11,7 @@
 
 module.exports = {
     xaxis: {
-        valType: 'axisid',
+        valType: 'subplotid',
         role: 'info',
         dflt: 'x',
         description: [
@@ -23,7 +23,7 @@ module.exports = {
         ].join(' ')
     },
     yaxis: {
-        valType: 'axisid',
+        valType: 'subplotid',
         role: 'info',
         dflt: 'y',
         description: [

src/plots/geo/layout/attributes.js

@@ -11,7 +11,7 @@
 
 module.exports = {
     geo: {
-        valType: 'geoid',
+        valType: 'subplotid',
         role: 'info',
         dflt: 'geo',
         description: [

src/plots/gl3d/layout/attributes.js

@@ -11,7 +11,7 @@
 
 module.exports = {
     scene: {
-        valType: 'sceneid',
+        valType: 'subplotid',
         role: 'info',
         dflt: 'scene',
         description: [

test/jasmine/tests/lib_test.js

@@ -588,6 +588,46 @@ describe('Test lib.js:', function() {
 
 
         });
+
+        describe('subplotid valtype', function() {
+            var dflt = 'slice';
+            var idAttrs = {
+                pizza: {
+                    valType: 'subplotid',
+                    dflt: dflt
+                }
+            };
+
+            var goodVals = ['slice', 'slice2', 'slice1492'];
+
+            goodVals.forEach(function(goodVal) {
+                it('should allow "' + goodVal + '"', function() {
+                    expect(coerce({pizza: goodVal}, {}, idAttrs, 'pizza'))
+                        .toEqual(goodVal);
+                });
+            });
+
+            var badVals = [
+                'slice0',
+                'slice1',
+                'Slice2',
+                '2slice',
+                '2',
+                2,
+                'slice2 ',
+                'slice2.0',
+                ' slice2',
+                'slice 2',
+                'slice01'
+            ];
+
+            badVals.forEach(function(badVal) {
+                it('should not allow "' + badVal + '"', function() {
+                    expect(coerce({pizza: badVal}, {}, idAttrs, 'pizza'))
+                        .toEqual(dflt);
+                });
+            });
+        });
     });
 
     describe('coerceFont', function() {