revise new attribute names and val types

archmoj · archmoj · commit fb67c82a0066 · 2020-11-03T13:43:05.000-05:00
diff --git a/src/plots/cartesian/axes.js b/src/plots/cartesian/axes.js
@@ -217,7 +217,7 @@ var getDataConversions = axes.getDataConversions = function(gd, trace, target, t
     if(Array.isArray(d2cTarget)) {
         ax = {
             type: autoType(targetArray, undefined, {
-                convertNumeric: gd._fullLayout.axesconvertnumeric
+                autotypenumbers: gd._fullLayout.autotypenumbers
             }),
             _categories: []
         };
diff --git a/src/plots/cartesian/axis_autotype.js b/src/plots/cartesian/axis_autotype.js
@@ -15,12 +15,12 @@ var Lib = require('../../lib');
 var BADNUM = require('../../constants/numerical').BADNUM;
 
 module.exports = function autoType(array, calendar, opts) {
-    var convertNumeric = opts.convertNumeric;
+    var convertNumeric = opts.autotypenumbers !== 'strict'; // compare against strict, just in case autotypenumbers was not provided in opts
 
     if(!opts.noMultiCategory && multiCategory(array)) return 'multicategory';
     if(convertNumeric && moreDates(array, calendar)) return 'date';
     if(category(array)) return 'category';
-    if(linearOK(array, convertNumeric)) return 'linear';
+    if(linearOK(array)) return 'linear';
     else return convertNumeric ? '-' : 'category';
 };
 
diff --git a/src/plots/cartesian/layout_attributes.js b/src/plots/cartesian/layout_attributes.js
@@ -102,14 +102,17 @@ module.exports = {
             'the axis in question.'
         ].join(' ')
     },
-    convertnumeric: {
-        valType: 'boolean',
+    autotypenumbers: {
+        valType: 'enumerated',
+        values: ['convert types', 'strict'],
+        dflt: 'convert types',
         role: 'info',
         editType: 'calc',
         description: [
-            'Determines whether or not a numeric string in data for this axis may be',
+            'Using *strict* a numeric string in trace data is not converted to a number.',
+            'Using *accept strings* a numeric string in trace data may be',
             'treated as a number during automatic axis `type` detection.',
-            'Defaults to layout.axesconvertnumeric.'
+            'Defaults to layout.autotypenumbers.'
         ].join(' ')
     },
     autorange: {
diff --git a/src/plots/cartesian/layout_defaults.js b/src/plots/cartesian/layout_defaults.js
@@ -38,7 +38,7 @@ function appendList(cont, k, item) {
 }
 
 module.exports = function supplyLayoutDefaults(layoutIn, layoutOut, fullData) {
-    var convertnumericDflt = layoutOut.axesconvertnumeric;
+    var autotypenumbersDflt = layoutOut.autotypenumbers;
 
     var ax2traces = {};
     var xaMayHide = {};
@@ -248,7 +248,7 @@ module.exports = function supplyLayoutDefaults(layoutIn, layoutOut, fullData) {
             automargin: true,
             visibleDflt: visibleDflt,
             reverseDflt: reverseDflt,
-            convertnumericDflt: convertnumericDflt,
+            autotypenumbersDflt: autotypenumbersDflt,
             splomStash: ((layoutOut._splomAxes || {})[axLetter] || {})[axId]
         };
 
@@ -313,7 +313,7 @@ module.exports = function supplyLayoutDefaults(layoutIn, layoutOut, fullData) {
             automargin: true,
             visibleDflt: false,
             reverseDflt: false,
-            convertnumericDflt: convertnumericDflt,
+            autotypenumbersDflt: autotypenumbersDflt,
             splomStash: ((layoutOut._splomAxes || {})[axLetter] || {})[axId]
         };
 
diff --git a/src/plots/cartesian/type_defaults.js b/src/plots/cartesian/type_defaults.js
@@ -16,7 +16,7 @@ var autoType = require('./axis_autotype');
  *  name: axis object name (ie 'xaxis') if one should be stored
  */
 module.exports = function handleTypeDefaults(containerIn, containerOut, coerce, options) {
-    coerce('convertnumeric', options.convertnumericDflt);
+    coerce('autotypenumbers', options.autotypenumbersDflt);
     var axType = coerce('type', (options.splomStash || {}).type);
 
     if(axType === '-') {
@@ -69,7 +69,7 @@ function setAutoType(ax, data) {
         opts.noMultiCategory = true;
     }
 
-    opts.convertNumeric = ax.convertnumeric;
+    opts.autotypenumbers = ax.autotypenumbers;
 
     // check all boxes on this x axis to see
     // if they're dates, numbers, or categories
diff --git a/src/plots/gl3d/layout/axis_attributes.js b/src/plots/gl3d/layout/axis_attributes.js
@@ -78,7 +78,7 @@ module.exports = overrideAll({
     type: extendFlat({}, axesAttrs.type, {
         values: ['-', 'linear', 'log', 'date', 'category']
     }),
-    convertnumeric: axesAttrs.convertnumeric,
+    autotypenumbers: axesAttrs.autotypenumbers,
     autorange: axesAttrs.autorange,
     rangemode: axesAttrs.rangemode,
     range: extendFlat({}, axesAttrs.range, {
diff --git a/src/plots/gl3d/layout/defaults.js b/src/plots/gl3d/layout/defaults.js
@@ -40,7 +40,7 @@ module.exports = function supplyLayoutDefaults(layoutIn, layoutOut, fullData) {
         font: layoutOut.font,
         fullData: fullData,
         getDfltFromLayout: getDfltFromLayout,
-        convertnumericDflt: layoutOut.axesconvertnumeric,
+        autotypenumbersDflt: layoutOut.autotypenumbers,
         paper_bgcolor: layoutOut.paper_bgcolor,
         calendar: layoutOut.calendar
     });
@@ -110,7 +110,7 @@ function handleGl3dDefaults(sceneLayoutIn, sceneLayoutOut, coerce, opts) {
         data: fullGl3dData,
         bgColor: bgColorCombined,
         calendar: opts.calendar,
-        convertnumericDflt: opts.convertnumericDflt,
+        autotypenumbersDflt: opts.autotypenumbersDflt,
         fullLayout: opts.fullLayout
     });
 
diff --git a/src/plots/layout_attributes.js b/src/plots/layout_attributes.js
@@ -292,14 +292,17 @@ module.exports = {
             'Sets the background color of the plotting area in-between x and y axes.'
         ].join(' ')
     },
-    axesconvertnumeric: {
-        valType: 'boolean',
-        dflt: true,
+    autotypenumbers: {
+        valType: 'enumerated',
+        values: ['convert types', 'strict'],
+        dflt: 'convert types',
         role: 'info',
         editType: 'calc',
         description: [
-            'Determines whether or not a numeric string in trace data may be',
-            'treated as a number during automatic axis `type` detection.'
+            'Using *strict* a numeric string in trace data is not converted to a number.',
+            'Using *accept strings* a numeric string in trace data may be',
+            'treated as a number during automatic axis `type` detection.',
+            'This is the default value; however it could be overridden for individual axes.'
         ].join(' ')
     },
     separators: {
diff --git a/src/plots/plots.js b/src/plots/plots.js
@@ -1476,7 +1476,7 @@ plots.supplyLayoutGlobalDefaults = function(layoutIn, layoutOut, formatObj) {
         layoutOut._dataTemplate = template.data;
     }
 
-    coerce('axesconvertnumeric');
+    coerce('autotypenumbers');
 
     var globalFont = Lib.coerceFont(coerce, 'font');
 
diff --git a/src/plots/polar/layout_attributes.js b/src/plots/polar/layout_attributes.js
@@ -61,7 +61,7 @@ var radialAxisAttrs = {
     type: extendFlat({}, axesAttrs.type, {
         values: ['-', 'linear', 'log', 'date', 'category']
     }),
-    convertnumeric: axesAttrs.convertnumeric,
+    autotypenumbers: axesAttrs.autotypenumbers,
 
     autorange: extendFlat({}, axesAttrs.autorange, {editType: 'plot'}),
     rangemode: {
@@ -180,7 +180,7 @@ var angularAxisAttrs = {
             'If *category, use `period` to set the number of integer coordinates around polar axis.'
         ].join(' ')
     },
-    convertnumeric: axesAttrs.convertnumeric,
+    autotypenumbers: axesAttrs.autotypenumbers,
 
     categoryorder: axesAttrs.categoryorder,
     categoryarray: axesAttrs.categoryarray,
diff --git a/src/plots/polar/layout_defaults.js b/src/plots/polar/layout_defaults.js
@@ -188,7 +188,7 @@ function handleDefaults(contIn, contOut, coerce, opts) {
 }
 
 function handleAxisTypeDefaults(axIn, axOut, coerce, subplotData, dataAttr, options) {
-    var convertnumeric = coerce('convertnumeric', options.convertnumericDflt);
+    var autotypenumbers = coerce('autotypenumbers', options.autotypenumbersDflt);
     var axType = coerce('type');
 
     if(axType === '-') {
@@ -203,7 +203,7 @@ function handleAxisTypeDefaults(axIn, axOut, coerce, subplotData, dataAttr, opti
 
         if(trace && trace[dataAttr]) {
             axOut.type = autoType(trace[dataAttr], 'gregorian', {
-                convertNumeric: convertnumeric
+                autotypenumbers: autotypenumbers
             });
         }
 
@@ -227,7 +227,7 @@ module.exports = function supplyLayoutDefaults(layoutIn, layoutOut, fullData) {
         attributes: layoutAttributes,
         handleDefaults: handleDefaults,
         font: layoutOut.font,
-        convertnumericDflt: layoutOut.axesconvertnumeric,
+        autotypenumbersDflt: layoutOut.autotypenumbers,
         paper_bgcolor: layoutOut.paper_bgcolor,
         fullData: fullData,
         layoutOut: layoutOut
diff --git a/src/plots/ternary/layout_defaults.js b/src/plots/ternary/layout_defaults.js
@@ -27,7 +27,7 @@ module.exports = function supplyLayoutDefaults(layoutIn, layoutOut, fullData) {
         attributes: layoutAttributes,
         handleDefaults: handleTernaryDefaults,
         font: layoutOut.font,
-        convertnumericDflt: layoutOut.axesconvertnumeric,
+        autotypenumbersDflt: layoutOut.autotypenumbers,
         paper_bgcolor: layoutOut.paper_bgcolor
     });
 };
diff --git a/src/traces/box/defaults.js b/src/traces/box/defaults.js
@@ -111,7 +111,7 @@ function handleSampleDefaults(traceIn, traceOut, coerce, layout) {
 
     var calendar = 'gregorian'; // TODO: should we use ax.calendar here?
     var opts = {
-        convertNumeric: true // TODO: should we use ax.convertnumeric here?
+        autotypenumbers: 'convert types' // TODO: should we use ax.autotypenumbers here?
     };
 
     var defaultOrientation, len;
diff --git a/src/traces/carpet/ab_defaults.js b/src/traces/carpet/ab_defaults.js
@@ -47,6 +47,7 @@ function mimickAxisDefaults(traceIn, traceOut, fullLayout, dfltColor) {
             calendar: traceOut.calendar,
             dfltColor: dfltColor,
             bgColor: fullLayout.paper_bgcolor,
+            autotypenumbersDflt: fullLayout.autotypenumbers,
             fullLayout: fullLayout
         };
 
diff --git a/src/traces/carpet/axis_attributes.js b/src/traces/carpet/axis_attributes.js
@@ -88,7 +88,7 @@ module.exports = {
             'the axis in question.'
         ].join(' ')
     },
-    convertnumeric: axesAttrs.convertnumeric,
+    autotypenumbers: axesAttrs.autotypenumbers,
     autorange: {
         valType: 'enumerated',
         values: [true, false, 'reversed'],
diff --git a/src/traces/carpet/axis_defaults.js b/src/traces/carpet/axis_defaults.js
@@ -51,7 +51,7 @@ module.exports = function handleAxisDefaults(containerIn, containerOut, options)
     }
 
     // now figure out type and do some more initialization
-    coerce('convertnumeric', options.convertnumericDflt);
+    coerce('autotypenumbers', options.autotypenumbersDflt);
     var axType = coerce('type');
     if(axType === '-') {
         if(options.data) setAutoType(containerOut, options.data);
@@ -221,6 +221,6 @@ function setAutoType(ax, data) {
     var calendar = ax[calAttr];
 
     ax.type = autoType(data, calendar, {
-        convertNumeric: ax.convertnumeric
+        autotypenumbers: ax.autotypenumbers
     });
 }
diff --git a/test/jasmine/tests/axes_test.js b/test/jasmine/tests/axes_test.js
@@ -190,7 +190,7 @@ describe('Test axes', function() {
 
         beforeEach(function() {
             layoutOut = {
-                axesconvertnumeric: true,
+                autotypenumbers: 'convert types',
                 _has: Plots._hasPlotType,
                 _basePlotModules: [],
                 _dfltTitle: {x: 'x', y: 'y'},
@@ -337,10 +337,10 @@ describe('Test axes', function() {
         });
 
         describe('autotype disable/enable converting numeric strings', function() {
-            it('should disable converting numeric strings using axis.convertnumeric', function() {
+            it('should disable converting numeric strings using axis.autotypenumbers', function() {
                 layoutIn = {
                     xaxis: {},
-                    yaxis: { convertnumeric: false }
+                    yaxis: { autotypenumbers: 'strict' }
                 };
 
                 supplyLayoutDefaults(layoutIn, layoutOut, [{
@@ -351,17 +351,17 @@ describe('Test axes', function() {
                     y: ['0', '1', '1970', '2000']
                 }]);
 
-                expect(layoutOut.xaxis.convertnumeric).toBe(true);
-                expect(layoutOut.yaxis.convertnumeric).toBe(false);
+                expect(layoutOut.xaxis.autotypenumbers).toBe('convert types');
+                expect(layoutOut.yaxis.autotypenumbers).toBe('strict');
                 expect(layoutOut.xaxis.type).toBe('linear');
                 expect(layoutOut.yaxis.type).toBe('category');
             });
 
-            it('should enable converting numeric strings using axis.convertnumeric and inherit defaults from layout.axesconvertnumeric', function() {
-                layoutOut.axesconvertnumeric = false;
+            it('should enable converting numeric strings using axis.autotypenumbers and inherit defaults from layout.autotypenumbers', function() {
+                layoutOut.autotypenumbers = 'strict';
 
                 layoutIn = {
-                    xaxis: { convertnumeric: true },
+                    xaxis: { autotypenumbers: 'convert types' },
                     yaxis: {}
                 };
 
@@ -373,8 +373,8 @@ describe('Test axes', function() {
                     y: ['0', '1', '1970', '2000']
                 }]);
 
-                expect(layoutOut.xaxis.convertnumeric).toBe(true);
-                expect(layoutOut.yaxis.convertnumeric).toBe(false);
+                expect(layoutOut.xaxis.autotypenumbers).toBe('convert types');
+                expect(layoutOut.yaxis.autotypenumbers).toBe('strict');
                 expect(layoutOut.xaxis.type).toBe('linear');
                 expect(layoutOut.yaxis.type).toBe('category');
             });
diff --git a/test/jasmine/tests/box_test.js b/test/jasmine/tests/box_test.js
@@ -637,10 +637,10 @@ describe('Test boxes supplyDefaults', function() {
 });
 
 describe('Test box autoType', function() {
-    it('should disable converting numeric strings using axis.convertnumeric', function() {
+    it('should disable converting numeric strings using axis.autotypenumbers', function() {
         var gd = {
             layout: {
-                xaxis: { convertnumeric: false }
+                xaxis: { autotypenumbers: 'strict' }
             },
             data: [{
                 type: 'box',
@@ -657,15 +657,15 @@ describe('Test box autoType', function() {
 
         supplyAllDefaults(gd);
 
-        expect(gd._fullLayout.xaxis.convertnumeric).toBe(false);
+        expect(gd._fullLayout.xaxis.autotypenumbers).toBe('strict');
         expect(gd._fullLayout.xaxis.type).toBe('category');
     });
 
-    it('should enable converting numeric strings using axis.convertnumeric', function() {
+    it('should enable converting numeric strings using axis.autotypenumbers', function() {
         var gd = {
             layout: {
-                axesconvertnumeric: false,
-                xaxis: { convertnumeric: true }
+                autotypenumbers: 'strict',
+                xaxis: { autotypenumbers: 'convert types' }
             },
             data: [{
                 type: 'box',
@@ -682,14 +682,14 @@ describe('Test box autoType', function() {
 
         supplyAllDefaults(gd);
 
-        expect(gd._fullLayout.xaxis.convertnumeric).toBe(true);
+        expect(gd._fullLayout.xaxis.autotypenumbers).toBe('convert types');
         expect(gd._fullLayout.xaxis.type).toBe('linear');
     });
 
-    it('should enable converting numeric inherit defaults from layout.axesconvertnumeric', function() {
+    it('should enable converting numeric inherit defaults from layout.autotypenumbers', function() {
         var gd = {
             layout: {
-                axesconvertnumeric: false,
+                autotypenumbers: 'strict',
                 xaxis: {}
             },
             data: [{
@@ -707,7 +707,7 @@ describe('Test box autoType', function() {
 
         supplyAllDefaults(gd);
 
-        expect(gd._fullLayout.xaxis.convertnumeric).toBe(false);
+        expect(gd._fullLayout.xaxis.autotypenumbers).toBe('strict');
         expect(gd._fullLayout.xaxis.type).toBe('category');
     });
 });
diff --git a/test/jasmine/tests/carpet_test.js b/test/jasmine/tests/carpet_test.js
diff --git a/test/jasmine/tests/gl3dlayout_test.js b/test/jasmine/tests/gl3dlayout_test.js
diff --git a/test/jasmine/tests/polar_test.js b/test/jasmine/tests/polar_test.js

Original file line number	Diff line number	Diff line change
`@@ -1476,7 +1476,7 @@ plots.supplyLayoutGlobalDefaults = function(layoutIn, layoutOut, formatObj) {`
`1476`	`1476`	`layoutOut._dataTemplate = template.data;`
`1477`	`1477`	`}`
`1478`	`1478`
`1479`		`- coerce('axesconvertnumeric');`
	`1479`	`+ coerce('autotypenumbers');`
`1480`	`1480`
`1481`	`1481`	`var globalFont = Lib.coerceFont(coerce, 'font');`
`1482`	`1482`