Fix and test cheater axis visibility test

Author: rreusser

src/plots/cartesian/layout_defaults.js

@@ -30,6 +30,7 @@ module.exports = function supplyLayoutDefaults(layoutIn, layoutOut, fullData) {
         xaListGl2d = [],
         yaListGl2d = [],
         xaListCheater = [],
+        xaListNonCheater = [],
         outerTicks = {},
         noGrids = {},
         i;
@@ -52,15 +53,18 @@ module.exports = function supplyLayoutDefaults(layoutIn, layoutOut, fullData) {
         var xaName = axisIds.id2name(trace.xaxis),
             yaName = axisIds.id2name(trace.yaxis);
 
-        // Note that we track the *opposite* of whether it's a cheater plot
-        // because that makes it straightforward to check that any trace on
-        // this axis that's *not* a cheater will make it visible
-        //
-        // There are three conditions that cause an axis to get marked as non
-        // cheater (which is to say, visible by default):
-        //   1. It's not in the carpet category at all
-        //   2. Or if it is, then it's not a non-cheater carpet axis
-        if(Registry.traceIs(trace, 'carpet') && (!trace.type === 'carpet' || trace._cheater)) {
+        // Two things trigger axis visibility:
+        // 1. is not carpet
+        // 2. carpet that's not cheater
+        if(!Registry.traceIs(trace, 'carpet') || (trace.type === 'carpet' && !trace._cheater)) {
+            if(xaName) Lib.pushUnique(xaListNonCheater, xaName);
+        }
+
+        // The above check for definitely-not-cheater is not adequate. This
+        // second list tracks which axes *could* be a cheater so that the
+        // full condition triggering hiding is:
+        //   *could* be a cheater and *is not definitely visible*
+        if(trace.type === 'carpet' && trace._cheater) {
             if(xaName) Lib.pushUnique(xaListCheater, xaName);
         }
 
@@ -182,7 +186,7 @@ module.exports = function supplyLayoutDefaults(layoutIn, layoutOut, fullData) {
             data: fullData,
             bgColor: bgColor,
             calendar: layoutOut.calendar,
-            cheateronly: axLetter === 'x' && xaListCheater.indexOf(axName) !== -1
+            cheateronly: axLetter === 'x' && (xaListCheater.indexOf(axName) !== -1 && xaListNonCheater.indexOf(axName) === -1)
         };
 
         handleAxisDefaults(axLayoutIn, axLayoutOut, coerce, defaultOptions, layoutOut);

test/jasmine/tests/carpet_test.js

@@ -118,6 +118,109 @@ describe('carpet supplyDefaults', function() {
     });*/
 });
 
+describe('supplyDefaults visibility check', function() {
+    it('does not hide empty subplots', function() {
+        var gd = {data: [], layout: {xaxis: {}}};
+        Plots.supplyDefaults(gd);
+        expect(gd._fullLayout.xaxis.visible).toBe(true);
+    });
+
+    it('does not hide axes with non-carpet traces', function() {
+        var gd = {data: [{x: []}]};
+        Plots.supplyDefaults(gd);
+        expect(gd._fullLayout.xaxis.visible).toBe(true);
+    });
+
+    it('does not hide axes with non-cheater carpet', function() {
+        var gd = {data: [{
+            type: 'carpet',
+            a: [1, 2, 3],
+            b: [1, 2],
+            x: [[1, 2, 3], [4, 5, 6]],
+            y: [[1, 2, 3], [4, 5, 6]],
+        }, {
+            type: 'contourcarpet',
+            z: [[1, 2, 3], [4, 5, 6]],
+        }]};
+        Plots.supplyDefaults(gd);
+        expect(gd._fullLayout.xaxis.visible).toBe(true);
+    });
+
+    it('hides axes with cheater', function() {
+        var gd = {data: [{
+            type: 'carpet',
+            a: [1, 2, 3],
+            b: [1, 2],
+            y: [[1, 2, 3], [4, 5, 6]],
+        }, {
+            type: 'contourcarpet',
+            z: [[1, 2, 3], [4, 5, 6]],
+        }]};
+        Plots.supplyDefaults(gd);
+        expect(gd._fullLayout.xaxis.visible).toBe(false);
+    });
+
+    it('does not hide an axis with cheater and non-cheater carpet', function() {
+        var gd = {
+            data: [{
+                carpetid: 'c1',
+                type: 'carpet',
+                a: [1, 2, 3],
+                b: [1, 2],
+                x: [[1, 2, 3], [4, 5, 6]],
+                y: [[1, 2, 3], [4, 5, 6]],
+            }, {
+                carpetid: 'c2',
+                type: 'carpet',
+                a: [1, 2, 3],
+                b: [1, 2],
+                y: [[1, 2, 3], [4, 5, 6]],
+            }, {
+                carpetid: 'c1',
+                type: 'contourcarpet',
+                z: [[1, 2, 3], [4, 5, 6]],
+            }, {
+                carpetid: 'c2',
+                type: 'contourcarpet',
+                z: [[1, 2, 3], [4, 5, 6]],
+            }]
+        };
+
+        Plots.supplyDefaults(gd);
+        expect(gd._fullLayout.xaxis.visible).toBe(true);
+    });
+
+    it('does not hide an axis with cheater and non-cheater carpet', function() {
+        var gd = {
+            data: [{
+                carpetid: 'c1',
+                type: 'carpet',
+                a: [1, 2, 3],
+                b: [1, 2],
+                x: [[1, 2, 3], [4, 5, 6]],
+                y: [[1, 2, 3], [4, 5, 6]],
+            }, {
+                carpetid: 'c2',
+                type: 'carpet',
+                a: [1, 2, 3],
+                b: [1, 2],
+                y: [[1, 2, 3], [4, 5, 6]],
+            }, {
+                carpetid: 'c1',
+                type: 'contourcarpet',
+                z: [[1, 2, 3], [4, 5, 6]],
+            }, {
+                carpetid: 'c2',
+                type: 'contourcarpet',
+                z: [[1, 2, 3], [4, 5, 6]],
+            }]
+        };
+
+        Plots.supplyDefaults(gd);
+        expect(gd._fullLayout.xaxis.visible).toBe(true);
+    });
+});
+
 describe('carpet smooth_fill_2d_array', function() {
     if(!test.smoothFill2D) return;
     var _;