Merge pull request #2899 from plotly/categorical-sploms

etpinard · web-flow · commit 7bba2661c70c · 2018-08-15T16:27:44.000-04:00
Multi-axis-type sploms
diff --git a/src/plot_api/subroutines.js b/src/plot_api/subroutines.js
@@ -520,7 +520,7 @@ exports.doModeBar = function(gd) {
 
     for(var i = 0; i < fullLayout._basePlotModules.length; i++) {
         var updateFx = fullLayout._basePlotModules[i].updateFx;
-        if(updateFx) updateFx(fullLayout);
+        if(updateFx) updateFx(gd);
     }
 
     return Plots.previousPromises(gd);
diff --git a/src/plots/cartesian/axis_defaults.js b/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', {
diff --git a/src/plots/cartesian/graph_interact.js b/src/plots/cartesian/graph_interact.js
@@ -151,15 +151,16 @@ exports.initInteractions = function initInteractions(gd) {
         gd._fullLayout._lasthover.onmousedown(evt);
     };
 
-    exports.updateFx(fullLayout);
+    exports.updateFx(gd);
 };
 
 // Minimal set of update needed on 'modebar' edits.
 // We only need to update the <g .draglayer> cursor style.
 //
 // Note that changing the axis configuration and/or the fixedrange attribute
 // should trigger a full initInteractions.
-exports.updateFx = function(fullLayout) {
+exports.updateFx = function(gd) {
+    var fullLayout = gd._fullLayout;
     var cursor = fullLayout.dragmode === 'pan' ? 'move' : 'crosshair';
     setCursor(fullLayout._draggers, cursor);
 };
diff --git a/src/plots/cartesian/layout_defaults.js b/src/plots/cartesian/layout_defaults.js
@@ -157,7 +157,9 @@ module.exports = function supplyLayoutDefaults(layoutIn, layoutOut, fullData) {
         axLayoutOut._annIndices = [];
         axLayoutOut._shapeIndices = [];
 
-        handleTypeDefaults(axLayoutIn, axLayoutOut, coerce, traces, axName);
+        // set up some private properties
+        axLayoutOut._name = axName;
+        var id = axLayoutOut._id = name2id(axName);
 
         var overlayableAxes = getOverlayableAxes(axLetter, axName);
 
@@ -170,9 +172,11 @@ 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);
         handleAxisDefaults(axLayoutIn, axLayoutOut, coerce, defaultOptions, layoutOut);
 
         var spikecolor = coerce2('spikecolor'),
diff --git a/src/plots/cartesian/type_defaults.js b/src/plots/cartesian/type_defaults.js
@@ -6,32 +6,24 @@
 * LICENSE file in the root directory of this source tree.
 */
 
-
 'use strict';
 
 var Registry = require('../../registry');
 var autoType = require('./axis_autotype');
-var name2id = require('./axis_ids').name2id;
 
 /*
  *  data: the plot data to use in choosing auto type
  *  name: axis object name (ie 'xaxis') if one should be stored
  */
-module.exports = function handleTypeDefaults(containerIn, containerOut, coerce, data, name) {
-    // set up some private properties
-    if(name) {
-        containerOut._name = name;
-        containerOut._id = name2id(name);
-    }
+module.exports = function handleTypeDefaults(containerIn, containerOut, coerce, options) {
+    var axType = coerce('type', (options.splomStash || {}).type);
 
-    var axType = coerce('type');
     if(axType === '-') {
-        setAutoType(containerOut, data);
+        setAutoType(containerOut, options.data);
 
         if(containerOut.type === '-') {
             containerOut.type = 'linear';
-        }
-        else {
+        } else {
             // copy autoType back to input axis
             // note that if this object didn't exist
             // in the input layout, we have to put it in
@@ -89,9 +81,10 @@ function setAutoType(ax, data) {
     }
     else if(d0.type === 'splom') {
         var dimensions = d0.dimensions;
+        var diag = d0._diag;
         for(i = 0; i < dimensions.length; i++) {
             var dim = dimensions[i];
-            if(dim.visible) {
+            if(dim.visible && (diag[i][0] === id || diag[i][1] === id)) {
                 ax.type = autoType(dim.values, calendar);
                 break;
             }
diff --git a/src/plots/geo/index.js b/src/plots/geo/index.js
@@ -78,7 +78,8 @@ exports.clean = function(newFullData, newFullLayout, oldFullData, oldFullLayout)
     }
 };
 
-exports.updateFx = function(fullLayout) {
+exports.updateFx = function(gd) {
+    var fullLayout = gd._fullLayout;
     var subplotIds = fullLayout._subplots[GEO];
 
     for(var i = 0; i < subplotIds.length; i++) {
diff --git a/src/plots/gl2d/index.js b/src/plots/gl2d/index.js
@@ -138,7 +138,8 @@ exports.toSVG = function(gd) {
     }
 };
 
-exports.updateFx = function(fullLayout) {
+exports.updateFx = function(gd) {
+    var fullLayout = gd._fullLayout;
     var subplotIds = fullLayout._subplots.gl2d;
 
     for(var i = 0; i < subplotIds.length; i++) {
diff --git a/src/plots/gl3d/index.js b/src/plots/gl3d/index.js
@@ -129,7 +129,8 @@ exports.cleanId = function cleanId(id) {
     return SCENE + sceneNum;
 };
 
-exports.updateFx = function(fullLayout) {
+exports.updateFx = function(gd) {
+    var fullLayout = gd._fullLayout;
     var subplotIds = fullLayout._subplots[GL3D];
 
     for(var i = 0; i < subplotIds.length; i++) {
diff --git a/src/plots/gl3d/layout/axis_defaults.js b/src/plots/gl3d/layout/axis_defaults.js
@@ -39,7 +39,7 @@ module.exports = function supplyLayoutDefaults(layoutIn, layoutOut, options) {
         containerOut._id = axName[0] + options.scene;
         containerOut._name = axName;
 
-        handleTypeDefaults(containerIn, containerOut, coerce, options.data);
+        handleTypeDefaults(containerIn, containerOut, coerce, options);
 
         handleAxisDefaults(
             containerIn,
diff --git a/src/plots/mapbox/index.js b/src/plots/mapbox/index.js
@@ -152,7 +152,8 @@ function findAccessToken(gd, mapboxIds) {
     throw new Error(constants.noAccessTokenErrorMsg);
 }
 
-exports.updateFx = function(fullLayout) {
+exports.updateFx = function(gd) {
+    var fullLayout = gd._fullLayout;
     var subplotIds = fullLayout._subplots[MAPBOX];
 
     for(var i = 0; i < subplotIds.length; i++) {
diff --git a/src/traces/splom/attributes.js b/src/traces/splom/attributes.js
@@ -58,6 +58,23 @@ module.exports = {
             description: 'Sets the dimension values to be plotted.'
         },
 
+        axis: {
+            type: {
+                valType: 'enumerated',
+                values: ['linear', 'log', 'date', 'category'],
+                role: 'info',
+                editType: 'calc+clearAxisTypes',
+                description: [
+                    'Sets the axis type for this dimension\'s generated',
+                    'x and y axes.',
+                    'Note that the axis `type` values set in layout take',
+                    'precedence over this attribute.'
+                ].join(' ')
+            },
+
+            editType: 'calc+clearAxisTypes'
+        },
+
         // TODO should add an attribute to pin down x only vars and y only vars
         // like https://seaborn.pydata.org/generated/seaborn.pairplot.html
         // x_vars and y_vars
diff --git a/src/traces/splom/base_plot.js b/src/traces/splom/base_plot.js
@@ -45,36 +45,34 @@ function drag(gd) {
     for(var i = 0; i < cd.length; i++) {
         var cd0 = cd[i][0];
         var trace = cd0.trace;
-        var scene = cd0.t._scene;
+        var stash = cd0.t;
+        var scene = stash._scene;
 
         if(trace.type === 'splom' && scene && scene.matrix) {
-            dragOne(gd, trace, scene);
+            dragOne(gd, trace, stash, scene);
         }
     }
 }
 
-function dragOne(gd, trace, scene) {
-    var dimensions = trace.dimensions;
+function dragOne(gd, trace, stash, scene) {
     var visibleLength = scene.matrixOptions.data.length;
+    var visibleDims = stash.visibleDims;
     var ranges = new Array(visibleLength);
 
-    for(var i = 0, k = 0; i < dimensions.length; i++) {
-        if(dimensions[i].visible) {
-            var rng = ranges[k] = new Array(4);
+    for(var k = 0; k < visibleDims.length; k++) {
+        var i = visibleDims[k];
+        var rng = ranges[k] = new Array(4);
 
-            var xa = AxisIDs.getFromId(gd, trace._diag[i][0]);
-            if(xa) {
-                rng[0] = xa.r2l(xa.range[0]);
-                rng[2] = xa.r2l(xa.range[1]);
-            }
-
-            var ya = AxisIDs.getFromId(gd, trace._diag[i][1]);
-            if(ya) {
-                rng[1] = ya.r2l(ya.range[0]);
-                rng[3] = ya.r2l(ya.range[1]);
-            }
+        var xa = AxisIDs.getFromId(gd, trace._diag[i][0]);
+        if(xa) {
+            rng[0] = xa.r2l(xa.range[0]);
+            rng[2] = xa.r2l(xa.range[1]);
+        }
 
-            k++;
+        var ya = AxisIDs.getFromId(gd, trace._diag[i][1]);
+        if(ya) {
+            rng[1] = ya.r2l(ya.range[0]);
+            rng[3] = ya.r2l(ya.range[1]);
         }
     }
 
@@ -229,6 +227,30 @@ function clean(newFullData, newFullLayout, oldFullData, oldFullLayout, oldCalcda
     Cartesian.clean(newFullData, newFullLayout, oldFullData, oldFullLayout);
 }
 
+function updateFx(gd) {
+    Cartesian.updateFx(gd);
+
+    var fullLayout = gd._fullLayout;
+    var dragmode = fullLayout.dragmode;
+
+    // unset selection styles when coming out of a selection mode
+    if(dragmode === 'zoom' || dragmode === 'pan') {
+        var cd = gd.calcdata;
+
+        for(var i = 0; i < cd.length; i++) {
+            var cd0 = cd[i][0];
+            var trace = cd0.trace;
+
+            if(trace.type === 'splom') {
+                var scene = cd0.t._scene;
+                if(scene.selectBatch === null) {
+                    scene.matrix.update(scene.matrixOptions, null);
+                }
+            }
+        }
+    }
+}
+
 module.exports = {
     name: SPLOM,
     attr: Cartesian.attr,
@@ -239,6 +261,6 @@ module.exports = {
     plot: plot,
     drag: drag,
     clean: clean,
-    updateFx: Cartesian.updateFx,
+    updateFx: updateFx,
     toSVG: Cartesian.toSVG
 };
diff --git a/src/traces/splom/defaults.js b/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) {
@@ -113,14 +115,14 @@ function handleAxisDefaults(traceIn, traceOut, layout, coerce) {
 
     for(i = 0; i < dimLength; i++) {
         var dim = dimensions[i];
-        var xa = xaxes[i + xShift];
-        var ya = yaxes[i + yShift];
+        var xaId = xaxes[i + xShift];
+        var yaId = yaxes[i + yShift];
 
-        fillAxisStash(layout, xa, dim);
-        fillAxisStash(layout, ya, dim);
+        fillAxisStash(layout, xaId, dim);
+        fillAxisStash(layout, yaId, dim);
 
         // note that some the entries here may be undefined
-        diag[i] = [xa, ya];
+        diag[i] = [xaId, yaId];
     }
 
     // when lower half is omitted, override grid default
@@ -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;
+            }
+        }
     }
 }
 
diff --git a/src/traces/splom/index.js b/src/traces/splom/index.js
diff --git a/test/image/baselines/splom_mismatched-axis-types.png b/test/image/baselines/splom_mismatched-axis-types.png
diff --git a/test/image/baselines/splom_multi-axis-type.png b/test/image/baselines/splom_multi-axis-type.png
diff --git a/test/image/mocks/splom_mismatched-axis-types.json b/test/image/mocks/splom_mismatched-axis-types.json
diff --git a/test/image/mocks/splom_multi-axis-type.json b/test/image/mocks/splom_multi-axis-type.json
diff --git a/test/jasmine/tests/splom_test.js b/test/jasmine/tests/splom_test.js

Original file line number	Diff line number	Diff line change
`@@ -520,7 +520,7 @@ exports.doModeBar = function(gd) {`
`520`	`520`
`521`	`521`	`for(var i = 0; i < fullLayout._basePlotModules.length; i++) {`
`522`	`522`	`var updateFx = fullLayout._basePlotModules[i].updateFx;`
`523`		`- if(updateFx) updateFx(fullLayout);`
	`523`	`+ if(updateFx) updateFx(gd);`
`524`	`524`	`}`
`525`	`525`
`526`	`526`	`return Plots.previousPromises(gd);`
Original file line number	Diff line number	Diff line change
`@@ -78,7 +78,8 @@ exports.clean = function(newFullData, newFullLayout, oldFullData, oldFullLayout)`
`78`	`78`	`}`
`79`	`79`	`};`
`80`	`80`
`81`		`-exports.updateFx = function(fullLayout) {`
	`81`	`+exports.updateFx = function(gd) {`
	`82`	`+ var fullLayout = gd._fullLayout;`
`82`	`83`	`var subplotIds = fullLayout._subplots[GEO];`
`83`	`84`
`84`	`85`	`for(var i = 0; i < subplotIds.length; i++) {`
Original file line number	Diff line number	Diff line change
`@@ -138,7 +138,8 @@ exports.toSVG = function(gd) {`
`138`	`138`	`}`
`139`	`139`	`};`
`140`	`140`
`141`		`-exports.updateFx = function(fullLayout) {`
	`141`	`+exports.updateFx = function(gd) {`
	`142`	`+ var fullLayout = gd._fullLayout;`
`142`	`143`	`var subplotIds = fullLayout._subplots.gl2d;`
`143`	`144`
`144`	`145`	`for(var i = 0; i < subplotIds.length; i++) {`
Original file line number	Diff line number	Diff line change
`@@ -152,7 +152,8 @@ function findAccessToken(gd, mapboxIds) {`
`152`	`152`	`throw new Error(constants.noAccessTokenErrorMsg);`
`153`	`153`	`}`
`154`	`154`
`155`		`-exports.updateFx = function(fullLayout) {`
	`155`	`+exports.updateFx = function(gd) {`
	`156`	`+ var fullLayout = gd._fullLayout;`
`156`	`157`	`var subplotIds = fullLayout._subplots[MAPBOX];`
`157`	`158`
`158`	`159`	`for(var i = 0; i < subplotIds.length; i++) {`