image: layout defaults: add scaleanchor, fix logic for reverse axis

antoinerg · antoinerg · commit 5c42db822759 · 2019-10-25T17:53:14.000-04:00
diff --git a/src/plots/cartesian/constraints.js b/src/plots/cartesian/constraints.js
@@ -17,7 +17,9 @@ var concatExtremes = require('./autorange').concatExtremes;
 var ALMOST_EQUAL = require('../../constants/numerical').ALMOST_EQUAL;
 var FROM_BL = require('../../constants/alignment').FROM_BL;
 
-exports.handleConstraintDefaults = function(containerIn, containerOut, coerce, allAxisIds, layoutOut) {
+exports.handleConstraintDefaults = function(containerIn, containerOut, coerce, opts) {
+    var allAxisIds = opts.allAxisIds;
+    var layoutOut = opts.layoutOut;
     var constraintGroups = layoutOut._axisConstraintGroups;
     var matchGroups = layoutOut._axisMatchGroups;
     var axId = containerOut._id;
@@ -53,14 +55,14 @@ exports.handleConstraintDefaults = function(containerIn, containerOut, coerce, a
     // 'matches' wins over 'scaleanchor' (for now)
     var scaleanchor, scaleOpts;
 
-    if(!matches && containerIn.scaleanchor && !(containerOut.fixedrange && constrain !== 'domain')) {
+    if(!matches && (containerIn.scaleanchor || opts.scaleanchorDflt) && !(containerOut.fixedrange && constrain !== 'domain')) {
         scaleOpts = getConstraintOpts(constraintGroups, thisID, allAxisIds, layoutOut, constrain);
         scaleanchor = Lib.coerce(containerIn, containerOut, {
             scaleanchor: {
                 valType: 'enumerated',
                 values: scaleOpts.linkableAxes || []
             }
-        }, 'scaleanchor');
+        }, 'scaleanchor', opts.scaleanchorDflt);
     }
 
     if(matches) {
diff --git a/src/plots/cartesian/layout_defaults.js b/src/plots/cartesian/layout_defaults.js
@@ -39,8 +39,10 @@ module.exports = function supplyLayoutDefaults(layoutIn, layoutOut, fullData) {
     var yaMayHide = {};
     var xaMustDisplay = {};
     var yaMustDisplay = {};
-    var yaMustForward = {};
-    var yaMayBackward = {};
+    var yaMustNotReverse = {};
+    var yaMayReverse = {};
+    var yaMustNotScaleanchor = {};
+    var yaMayScaleanchor = {};
     var outerTicks = {};
     var noGrids = {};
     var i, j;
@@ -74,24 +76,24 @@ module.exports = function supplyLayoutDefaults(layoutIn, layoutOut, fullData) {
         if(trace.type === 'funnel') {
             if(trace.orientation === 'h') {
                 if(xaName) xaMayHide[xaName] = true;
-                if(yaName) yaMayBackward[yaName] = true;
+                if(yaName) yaMayReverse[yaName] = true;
             } else {
                 if(yaName) yaMayHide[yaName] = true;
             }
+            yaMustNotScaleanchor[yaName] = true;
+        } else if(trace.type === 'image') {
+            if(yaName) yaMayReverse[yaName] = true;
+            if(yaName) yaMayScaleanchor[yaName] = true;
         } else {
             if(yaName) {
                 yaMustDisplay[yaName] = true;
-                yaMustForward[yaName] = true;
+                yaMustNotReverse[yaName] = true;
+                yaMustNotScaleanchor[yaName] = true;
             }
 
             if(!traceIs(trace, 'carpet') || (trace.type === 'carpet' && !trace._cheater)) {
                 if(xaName) xaMustDisplay[xaName] = true;
             }
-
-            if(trace.type === 'image') {
-                if(yaName) yaMustForward[yaName] = false;
-                if(yaName) yaMayBackward[yaName] = true;
-            }
         }
 
         // Two things trigger axis visibility:
@@ -197,7 +199,7 @@ module.exports = function supplyLayoutDefaults(layoutIn, layoutOut, fullData) {
             (axLetter === 'y' && !yaMustDisplay[axName] && yaMayHide[axName]);
 
         var reverseDflt =
-            (axLetter === 'y' && !yaMustForward[axName] && yaMayBackward[axName]);
+            (axLetter === 'y' && !yaMustNotReverse[axName] && yaMayReverse[axName]);
 
         var defaultOptions = {
             letter: axLetter,
@@ -299,7 +301,15 @@ module.exports = function supplyLayoutDefaults(layoutIn, layoutOut, fullData) {
         axLayoutIn = layoutIn[axName];
         axLayoutOut = layoutOut[axName];
 
-        handleConstraintDefaults(axLayoutIn, axLayoutOut, coerce, allAxisIds, layoutOut);
+        var scaleanchorDflt = null;
+        if(axLetter === 'y' && !axLayoutIn.hasOwnProperty('scaleanchor') && !yaMustNotScaleanchor[axName] && yaMayScaleanchor[axName]) {
+            scaleanchorDflt = axLayoutOut.anchor;
+        }
+        handleConstraintDefaults(axLayoutIn, axLayoutOut, coerce, {
+            allAxisIds: allAxisIds,
+            layoutOut: layoutOut,
+            scaleanchorDflt: scaleanchorDflt
+        });
     }
 
     for(i = 0; i < matchGroups.length; i++) {
diff --git a/test/image/baselines/image_axis_reverse.png b/test/image/baselines/image_axis_reverse.png
diff --git a/test/image/baselines/image_axis_type.png b/test/image/baselines/image_axis_type.png
diff --git a/test/image/mocks/image_adventurer.json b/test/image/mocks/image_adventurer.json
diff --git a/test/image/mocks/image_axis_type.json b/test/image/mocks/image_axis_type.json
@@ -28,6 +28,7 @@
       "width": 400, "height": 600, "title": {"text": "Image on categorical and log axes"},
       "grid": {"rows": 2, "columns": 1, "pattern": "independent"},
       "xaxis2": {"type": "log"},
-      "yaxis2": {"type": "log"}
+      "yaxis": {"scaleanchor": null},
+      "yaxis2": {"type": "log", "scaleanchor": null}
     }
 }
diff --git a/test/image/mocks/image_cat.json b/test/image/mocks/image_cat.json
@@ -1,6 +1,6 @@
 {
 "layout": {
-  "width": 400, "height": 400, "yaxis": {"scaleanchor": "x"}, "margin": {"t":25, "b": 25, "r": 25, "l": 40}
+  "width": 400, "height": 400, "yaxis": {"scaleanchor": "x", "autorange": "reversed"}, "margin": {"t":25, "b": 25, "r": 25, "l": 40}
 },
   "data": [
     {"x":[50, 150, 350, 50], "y":[350, 23, 100, 350]},
diff --git a/test/image/mocks/image_colormodel.json b/test/image/mocks/image_colormodel.json
@@ -19,6 +19,8 @@
   }],
   "layout": {
     "grid": {"rows": 2, "columns": 1, "pattern": "independent"},
+    "yaxis": {"scaleanchor": null},
+    "yaxis2": {"scaleanchor": null},
     "width": 600,
     "height": 400
   }
diff --git a/test/image/mocks/image_opacity.json b/test/image/mocks/image_opacity.json
@@ -5,6 +5,7 @@
     "z": [[[255, 0, 0], [0, 255, 0], [0, 0, 255]]]
     }],
     "layout": {
+      "yaxis": {"scaleanchor": null},
       "width": 400, "height": 400,
       "title": {
         "text": "image with opacity 0.1"
diff --git a/test/image/mocks/image_with_gaps.json b/test/image/mocks/image_with_gaps.json
@@ -9,6 +9,7 @@
     "zmax": [1, 1, 1]
   }],
   "layout": {
+    "yaxis": {"scaleanchor": null},
     "width": 400, "height": 400, "title": {"text": "Image with missing pixels"}
   }
 }
diff --git a/test/image/mocks/image_zmin_zmax.json b/test/image/mocks/image_zmin_zmax.json
@@ -60,6 +60,14 @@
   "layout": {
     "width": 400,
     "height": 800,
+    "yaxis": {"scaleanchor": null},
+    "yaxis2": {"scaleanchor": null},
+    "yaxis3": {"scaleanchor": null},
+    "yaxis4": {"scaleanchor": null},
+    "yaxis5": {"scaleanchor": null},
+    "yaxis6": {"scaleanchor": null},
+    "yaxis7": {"scaleanchor": null},
+    "yaxis8": {"scaleanchor": null},
     "grid": {
       "rows": 4,
       "columns": 2,
diff --git a/test/jasmine/tests/image_test.js b/test/jasmine/tests/image_test.js
@@ -100,6 +100,62 @@ describe('image supplyDefaults', function() {
     });
 });
 
+describe('image smart layout defaults', function() {
+    var gd;
+    beforeEach(function() {
+        gd = createGraphDiv();
+    });
+
+    afterEach(destroyGraphDiv);
+
+    it('should reverse yaxis if only images are present', function(done) {
+        Plotly.newPlot(gd, [{type: 'image', z: [[[255, 0, 0]]]}])
+        .then(function(gd) {
+            expect(gd._fullLayout.yaxis.range[0]).toBeGreaterThan(gd._fullLayout.yaxis.range[1]);
+        })
+        .catch(failTest)
+        .then(done);
+    });
+
+    it('should NOT reverse yaxis if another trace is present', function(done) {
+        Plotly.newPlot(gd, [{type: 'image', z: [[[255, 0, 0]]]}, {type: 'scatter', y: [5, 3, 2]}])
+        .then(function(gd) {
+            expect(gd._fullLayout.yaxis.range[1]).toBeGreaterThan(gd._fullLayout.yaxis.range[0]);
+        })
+        .catch(failTest)
+        .then(done);
+    });
+
+    it('should set scaleanchor to make square pixels if only images are present', function(done) {
+        Plotly.newPlot(gd, [{type: 'image', z: [[[255, 0, 0]]]}])
+        .then(function(gd) {
+            expect(gd._fullLayout.yaxis.scaleanchor).toBe('x');
+        })
+        .catch(failTest)
+        .then(done);
+    });
+
+    it('should NOT set scaleanchor if another trace is present', function(done) {
+        Plotly.newPlot(gd, [{type: 'image', z: [[[255, 0, 0]]]}, {type: 'scatter', y: [5, 3, 2]}])
+        .then(function(gd) {
+            expect(gd._fullLayout.yaxis.scaleanchor).toBe(undefined);
+        })
+        .catch(failTest)
+        .then(done);
+    });
+
+    it('should NOT set scaleanchor if it\'s already defined', function(done) {
+        Plotly.newPlot(gd, [
+          {type: 'image', z: [[[255, 0, 0]]]}, {type: 'scatter', y: [5, 3, 2]}
+        ], {yaxis: {scaleanchor: 'x3'}})
+        .then(function(gd) {
+            expect(gd._fullLayout.yaxis.scaleanchor).toBe(undefined);
+        })
+        .catch(failTest)
+        .then(done);
+    });
+});
+
 describe('image plot', function() {
     'use strict';
 
@@ -444,7 +500,7 @@ describe('image hover:', function() {
                 zmax: [1, 1, 1],
                 text: [['A', 'B', 'C'], ['D', 'E', 'F']],
                 hovertemplate: '%{text}<extra></extra>'
-            }], layout: {width: 400, height: 400}};
+            }], layout: {width: 400, height: 400, yaxis: {scaleanchor: null}}};
 
             Plotly.newPlot(gd, mockCopy)
             .then(function() {_hover(140, 200);})

Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,7 @@`
`28`	`28`	`"width": 400, "height": 600, "title": {"text": "Image on categorical and log axes"},`
`29`	`29`	`"grid": {"rows": 2, "columns": 1, "pattern": "independent"},`
`30`	`30`	`"xaxis2": {"type": "log"},`
`31`		`- "yaxis2": {"type": "log"}`
	`31`	`+ "yaxis": {"scaleanchor": null},`
	`32`	`+ "yaxis2": {"type": "log", "scaleanchor": null}`
`32`	`33`	`}`
`33`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"layout": {`
`3`		`- "width": 400, "height": 400, "yaxis": {"scaleanchor": "x"}, "margin": {"t":25, "b": 25, "r": 25, "l": 40}`
	`3`	`+ "width": 400, "height": 400, "yaxis": {"scaleanchor": "x", "autorange": "reversed"}, "margin": {"t":25, "b": 25, "r": 25, "l": 40}`
`4`	`4`	`},`
`5`	`5`	`"data": [`
`6`	`6`	`{"x":[50, 150, 350, 50], "y":[350, 23, 100, 350]},`
Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,8 @@`
`19`	`19`	`}],`
`20`	`20`	`"layout": {`
`21`	`21`	`"grid": {"rows": 2, "columns": 1, "pattern": "independent"},`
	`22`	`+ "yaxis": {"scaleanchor": null},`
	`23`	`+ "yaxis2": {"scaleanchor": null},`
`22`	`24`	`"width": 600,`
`23`	`25`	`"height": 400`
`24`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@`
`9`	`9`	`"zmax": [1, 1, 1]`
`10`	`10`	`}],`
`11`	`11`	`"layout": {`
	`12`	`+ "yaxis": {"scaleanchor": null},`
`12`	`13`	`"width": 400, "height": 400, "title": {"text": "Image with missing pixels"}`
`13`	`14`	`}`
`14`	`15`	`}`