add dimensions[i].axis.type

.. to more easily set axis type on splom-generated axes

Author: etpinard

src/plots/cartesian/axis_defaults.js

@@ -33,8 +33,8 @@ var setConvert = require('./set_convert');
  */
 module.exports = function handleAxisDefaults(containerIn, containerOut, coerce, options, layoutOut) {
     var letter = options.letter;
-    var id = containerOut._id;
     var font = options.font || {};
+    var splomStash = options.splomStash || {};
 
     var visible = coerce('visible', !options.cheateronly);
 
@@ -66,7 +66,7 @@ module.exports = function handleAxisDefaults(containerIn, containerOut, coerce,
     // template too.
     var dfltFontColor = (dfltColor !== layoutAttributes.color.dflt) ? dfltColor : font.color;
     // try to get default title from splom trace, fallback to graph-wide value
-    var dfltTitle = ((layoutOut._splomAxes || {})[letter] || {})[id] || layoutOut._dfltTitle[letter];
+    var dfltTitle = splomStash.label || layoutOut._dfltTitle[letter];
 
     coerce('title', dfltTitle);
     Lib.coerceFont(coerce, 'titlefont', {

src/plots/cartesian/layout_defaults.js

@@ -172,7 +172,8 @@ module.exports = function supplyLayoutDefaults(layoutIn, layoutOut, fullData) {
             bgColor: bgColor,
             calendar: layoutOut.calendar,
             automargin: true,
-            cheateronly: axLetter === 'x' && xaCheater[axName] && !xaNonCheater[axName]
+            cheateronly: axLetter === 'x' && xaCheater[axName] && !xaNonCheater[axName],
+            splomStash: ((layoutOut._splomAxes || {})[axLetter] || {})[id]
         };
 
         handleTypeDefaults(axLayoutIn, axLayoutOut, coerce, defaultOptions);

src/plots/cartesian/type_defaults.js

@@ -6,7 +6,6 @@
 * LICENSE file in the root directory of this source tree.
 */
 
-
 'use strict';
 
 var Registry = require('../../registry');
@@ -17,8 +16,8 @@ var autoType = require('./axis_autotype');
  *  name: axis object name (ie 'xaxis') if one should be stored
  */
 module.exports = function handleTypeDefaults(containerIn, containerOut, coerce, options) {
+    var axType = coerce('type', (options.splomStash || {}).type);
 
-    var axType = coerce('type');
     if(axType === '-') {
         setAutoType(containerOut, options.data);
 

src/traces/splom/defaults.js

@@ -61,6 +61,8 @@ function dimensionDefaults(dimIn, dimOut) {
 
     if(!(values && values.length)) dimOut.visible = false;
     else coerce('visible');
+
+    coerce('axis.type');
 }
 
 function handleAxisDefaults(traceIn, traceOut, layout, coerce) {
@@ -148,7 +150,13 @@ function fillAxisStash(layout, axId, dim) {
     var stash = layout._splomAxes[axLetter];
 
     if(!(axId in stash)) {
-        stash[axId] = (dim || {}).label || '';
+        var s = stash[axId] = {};
+        if(dim) {
+            s.label = dim.label || '';
+            if(dim.visible && dim.axis) {
+                s.type = dim.axis.type;
+            }
+        }
     }
 }
 

test/image/mocks/splom_multi-axis-type.json

@@ -16,11 +16,13 @@
         },
         {
           "label": "bool",
-          "values": [false, true, true, true, false, true, false, false, false, true]
+          "values": [false, true, true, true, false, true, false, false, false, true],
+          "axis": {"type": "category"}
         },
         {
           "label": "0/1",
-          "values": [0, 1, 1, 1, 1, 1, 0, 0, 0, 0]
+          "values": [0, 1, 1, 1, 1, 1, 0, 0, 0, 0],
+          "axis": {"type": "category"}
         },
         {
           "label": "string",
@@ -31,15 +33,6 @@
   ],
   "layout": {
     "hovermode": "closest",
-    "margin": {
-      "b": 80,
-      "l": 80,
-      "r": 30,
-      "t": 30
-    },
-    "yaxis2": {"type": "category"},
-    "yaxis3": {"type": "category"},
-    "xaxis3": {"type": "category"},
-    "xaxis4": {"type": "category"}
+    "margin": {"b": 80, "l": 80, "r": 30, "t": 30}
   }
 }

test/jasmine/tests/splom_test.js

@@ -357,6 +357,42 @@ describe('Test splom trace defaults:', function() {
         expect(fullLayout.xaxis2.type).toBe('date');
         expect(fullLayout.yaxis2.type).toBe('date');
     });
+
+    it('axis type in layout takes precedence over dimensions setting', function() {
+        _supply({
+            dimensions: [
+                {values: [1, 2, 1], axis: {type: 'category'}},
+                {values: [2, 1, 3]}
+            ]
+        }, {
+            xaxis: {type: 'linear'},
+            yaxis: {type: 'linear'},
+            xaxis2: {type: 'category'},
+            yaxis2: {type: 'category'}
+        });
+
+        var fullLayout = gd._fullLayout;
+        expect(fullLayout.xaxis.type).toBe('linear');
+        expect(fullLayout.yaxis.type).toBe('linear');
+        expect(fullLayout.xaxis2.type).toBe('category');
+        expect(fullLayout.yaxis2.type).toBe('category');
+    });
+
+    it('axis type setting should be skipped when dimension is not visible', function() {
+        _supply({
+            dimensions: [
+                {visible: false, values: [1, 2, 1], axis: {type: 'category'}},
+                {values: [-1, 2, 3], axis: {type: 'category'}},
+            ]
+        }, {
+        });
+
+        var fullLayout = gd._fullLayout;
+        expect(fullLayout.xaxis.type).toBe('linear');
+        expect(fullLayout.yaxis.type).toBe('linear');
+        expect(fullLayout.xaxis2.type).toBe('category');
+        expect(fullLayout.yaxis2.type).toBe('category');
+    });
 });
 
 describe('Test splom trace calc step:', function() {