remove "alwaysSupplyDefaults" so visible: false does not contribute t…

…o stack config
ErwanMAS · ErwanMAS · Sep 8, 2018 · Aug 24, 2018 · Aug 31, 2018 · Aug 31, 2018
commit 9fdf5226430c756a8844847e1f2471e76e60a72c
diff --git a/src/plots/plots.js b/src/plots/plots.js
@@ -1181,14 +1181,6 @@ plots.supplyTraceDefaults = function(traceIn, traceOut, colorIndex, layout, trac
 
         plots.supplyTransformDefaults(traceIn, traceOut, layout);
     }
-    else if(_module && Registry.traceIs(traceOut, 'alwaysSupplyDefaults')) {
-        // Some types need *something* from supplyDefaults always, even if
-        // visible: false. Looking at you scatter: stack options even from
-        // hidden traces can control other traces in the stack.
-        // These types should bail out ASAP if visible is false.
-        // But we don't need any other cross-module attrs ^^ in this case.
-        _module.supplyDefaults(traceIn, traceOut, defaultColor, layout);
-    }
 
     return traceOut;
 };

diff --git a/src/traces/scatter/attributes.js b/src/traces/scatter/attributes.js
@@ -95,7 +95,8 @@ module.exports = {
         editType: 'calc',
         description: [
             'Only relevant when `stackgroup` is used, and only the first',
-            '`orientation` found in the `stackgroup` will be used. Sets the',
+            '`orientation` found in the `stackgroup` will be used - including',
+            'if `visible` is *legendonly* but not if it is `false`. Sets the',
             'stacking direction. With *v* (*h*), the y (x) values of subsequent',
             'traces are added. Also affects the default value of `fill`.'
         ].join(' ')
@@ -108,7 +109,8 @@ module.exports = {
         editType: 'calc',
         description: [
             'Only relevant when `stackgroup` is used, and only the first',
-            '`groupnorm` found in the `stackgroup` will be used.',
+            '`groupnorm` found in the `stackgroup` will be used - including',
+            'if `visible` is *legendonly* but not if it is `false`.',
             'Sets the normalization for the sum of this `stackgroup`.',
             'With *fraction*, the value of each trace at each location is',
             'divided by the sum of all trace values at that location.',
@@ -125,7 +127,8 @@ module.exports = {
         editType: 'calc',
         description: [
             'Only relevant when `stackgroup` is used, and only the first',
-            '`stackgaps` found in the `stackgroup` will be used.',
+            '`stackgaps` found in the `stackgroup` will be used - including',
+            'if `visible` is *legendonly* but not if it is `false`.',
             'Determines how we handle locations at which other traces in this',
             'group have data but this one does not.',
             'With *infer zero* we insert a zero at these locations.',

diff --git a/src/traces/scatter/defaults.js b/src/traces/scatter/defaults.js
@@ -27,13 +27,13 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
         return Lib.coerce(traceIn, traceOut, attributes, attr, dflt);
     }
 
-    var stackGroupOpts = handleStackDefaults(traceIn, traceOut, layout, coerce);
-
     var len = handleXYDefaults(traceIn, traceOut, layout, coerce);
     if(!len) traceOut.visible = false;
 
     if(!traceOut.visible) return;
 
+    var stackGroupOpts = handleStackDefaults(traceIn, traceOut, layout, coerce);
+
     var defaultMode = !stackGroupOpts && (len < constants.PTS_LINESONLY) ?
         'lines+markers' : 'lines';
     coerce('text');

diff --git a/src/traces/scatter/index.js b/src/traces/scatter/index.js
@@ -36,7 +36,7 @@ Scatter.name = 'scatter';
 Scatter.basePlotModule = require('../../plots/cartesian');
 Scatter.categories = [
     'cartesian', 'svg', 'symbols', 'errorBarsOK', 'showLegend', 'scatter-like',
-    'zoomScale', 'alwaysSupplyDefaults'
+    'zoomScale'
 ];
 Scatter.meta = {
     description: [

diff --git a/test/jasmine/tests/scatter_test.js b/test/jasmine/tests/scatter_test.js
@@ -1049,11 +1049,16 @@ describe('stacked area', function() {
             var xr = [2, 6];
             checkRanges({
                 x: xr, x2: xr, x3: xr, x4: xr, x5: xr, x6: xr,
-                y: [0, 4.21], y2: [0, 5.26],
-                y3: [0, 1.08], y4: [0, 1.08], y5: [0, 105.26], y6: [0, 105.26]
+                // now we lose the explicit config from the bottom trace,
+                // which we kept when it was visible: 'legendonly'
+                y: [0, 4.21], y2: [0, 4.21],
+                y3: [0, 4.32], y4: [0, 1.08], y5: [0, 105.26], y6: [0, 5.26]
             }, 'bottom trace visible: false');
 
-            return Plotly.restyle(gd, 'visible', false, [1, 4, 7, 10, 13, 16]);
+            // put the bottom traces back to legendonly so they still contribute
+            // config attributes, and hide the middles too
+            return Plotly.restyle(gd, 'visible', 'legendonly',
+                [0, 3, 6, 9, 12, 15, 1, 4, 7, 10, 13, 16]);
         })
         .then(function() {
             var xr = [3, 5];
@@ -1072,6 +1077,21 @@ describe('stacked area', function() {
                 y: [0, 7.37], y2: [0, 7.37],
                 y3: [0, 1.08], y4: [0, 1.08], y5: [0, 105.26], y6: [0, 105.26]
             }, 'top and bottom showing');
+
+            return Plotly.restyle(gd, {x: null, y: null}, [0, 3, 6, 9, 12, 15]);
+        })
+        .then(function() {
+            return Plotly.restyle(gd, 'visible', true, [1, 4, 7, 10, 13, 16]);
+        })
+        .then(function() {
+            var xr = [2, 6];
+            // an invalid trace (no data) implicitly has visible: false, and is
+            // equivalent to explicit visible: false in removing stack config.
+            checkRanges({
+                x: xr, x2: xr, x3: xr, x4: xr, x5: xr, x6: xr,
+                y: [0, 4.21], y2: [0, 4.21],
+                y3: [0, 4.32], y4: [0, 1.08], y5: [0, 105.26], y6: [0, 5.26]
+            }, 'bottom trace *implicit* visible: false');
         })
         .catch(failTest)
         .then(done);