rename Lib.num -> Lib.ensureNumber

etpinard · etpinard · commit 071249f917ca · 2017-05-31T11:16:36.000-04:00
diff --git a/src/lib/index.js b/src/lib/index.js
@@ -92,7 +92,7 @@ lib.pushUnique = require('./push_unique');
 
 lib.cleanNumber = require('./clean_number');
 
-lib.num = function num(v) {
+lib.ensureNumber = function num(v) {
     if(!isNumeric(v)) return BADNUM;
     v = Number(v);
     if(v < -FP_SAFE || v > FP_SAFE) return BADNUM;
diff --git a/src/plots/cartesian/axes.js b/src/plots/cartesian/axes.js
@@ -99,26 +99,27 @@ axes.coerceRef = function(containerIn, containerOut, gd, attr, dflt, extraOption
  * - for other types: coerce them to numbers
  */
 axes.coercePosition = function(containerOut, gd, coerce, axRef, attr, dflt) {
-    var ax, pos;
+    var cleanPos, pos;
 
     if(axRef === 'paper' || axRef === 'pixel') {
-        ax = { cleanPos: Lib.num };
+        cleanPos = Lib.ensureNumber;
         pos = coerce(attr, dflt);
     } else {
-        ax = axes.getFromId(gd, axRef);
+        var ax = axes.getFromId(gd, axRef);
         dflt = ax.fraction2r(dflt);
         pos = coerce(attr, dflt);
+        cleanPos = ax.cleanPos;
     }
 
-    containerOut[attr] = ax.cleanPos(pos);
+    containerOut[attr] = cleanPos(pos);
 };
 
 axes.cleanPosition = function(pos, gd, axRef) {
-    var ax = (axRef === 'paper' || axRef === 'pixel') ?
-        { cleanPos: Lib.num } :
-        axes.getFromId(gd, axRef);
+    var cleanPos = (axRef === 'paper' || axRef === 'pixel') ?
+        Lib.ensureNumber :
+        axes.getFromId(gd, axRef).cleanPos;
 
-    return ax.cleanPos(pos);
+    return cleanPos(pos);
 };
 
 axes.getDataToCoordFunc = function(gd, trace, target, targetArray) {
diff --git a/src/plots/cartesian/set_convert.js b/src/plots/cartesian/set_convert.js
@@ -16,7 +16,7 @@ var Lib = require('../../lib');
 var cleanNumber = Lib.cleanNumber;
 var ms2DateTime = Lib.ms2DateTime;
 var dateTime2ms = Lib.dateTime2ms;
-var num = Lib.num;
+var ensureNumber = Lib.ensureNumber;
 
 var numConstants = require('../../constants/numerical');
 var FP_SAFE = numConstants.FP_SAFE;
@@ -159,8 +159,8 @@ module.exports = function setConvert(ax, fullLayout) {
     function p2l(px) { return (px - ax._b) / ax._m; }
 
     // conversions among c/l/p are fairly simple - do them together for all axis types
-    ax.c2l = (ax.type === 'log') ? toLog : num;
-    ax.l2c = (ax.type === 'log') ? fromLog : num;
+    ax.c2l = (ax.type === 'log') ? toLog : ensureNumber;
+    ax.l2c = (ax.type === 'log') ? fromLog : ensureNumber;
 
     ax.l2p = l2p;
     ax.p2l = p2l;
@@ -176,20 +176,20 @@ module.exports = function setConvert(ax, fullLayout) {
     if(['linear', '-'].indexOf(ax.type) !== -1) {
         // all are data vals, but d and r need cleaning
         ax.d2r = ax.r2d = ax.d2c = ax.r2c = ax.d2l = ax.r2l = cleanNumber;
-        ax.c2d = ax.c2r = ax.l2d = ax.l2r = num;
+        ax.c2d = ax.c2r = ax.l2d = ax.l2r = ensureNumber;
 
         ax.d2p = ax.r2p = function(v) { return ax.l2p(cleanNumber(v)); };
         ax.p2d = ax.p2r = p2l;
 
-        ax.cleanPos = num;
+        ax.cleanPos = ensureNumber;
     }
     else if(ax.type === 'log') {
         // d and c are data vals, r and l are logged (but d and r need cleaning)
         ax.d2r = ax.d2l = function(v, clip) { return toLog(cleanNumber(v), clip); };
         ax.r2d = ax.r2c = function(v) { return fromLog(cleanNumber(v)); };
 
         ax.d2c = ax.r2l = cleanNumber;
-        ax.c2d = ax.l2r = num;
+        ax.c2d = ax.l2r = ensureNumber;
 
         ax.c2r = toLog;
         ax.l2d = fromLog;
@@ -200,7 +200,7 @@ module.exports = function setConvert(ax, fullLayout) {
         ax.r2p = function(v) { return ax.l2p(cleanNumber(v)); };
         ax.p2r = p2l;
 
-        ax.cleanPos = num;
+        ax.cleanPos = ensureNumber;
     }
     else if(ax.type === 'date') {
         // r and d are date strings, l and c are ms
@@ -233,7 +233,7 @@ module.exports = function setConvert(ax, fullLayout) {
 
         ax.d2r = ax.d2l_noadd = getCategoryIndex;
 
-        ax.l2r = ax.r2c = ax.c2r = num;
+        ax.l2r = ax.r2c = ax.c2r = ensureNumber;
         ax.r2l = getCategoryIndex;
 
         ax.d2p = function(v) { return ax.l2p(getCategoryIndex(v)); };
@@ -243,7 +243,7 @@ module.exports = function setConvert(ax, fullLayout) {
 
         ax.cleanPos = function(v) {
             if(typeof v === 'string' && v !== '') return v;
-            return num(v);
+            return ensureNumber(v);
         };
     }
 
