Merge pull request #3274 from plotly/2925-default-colorbars

antoinerg · web-flow · commit 922bad611cd8 · 2018-11-23T12:24:14.000-05:00
initial implementation of `layout.colorscale`
diff --git a/src/components/colorscale/calc.js b/src/components/colorscale/calc.js
@@ -11,11 +11,14 @@
 
 var Lib = require('../../lib');
 
-var scales = require('./scales');
 var flipScale = require('./flip_scale');
 
 
-module.exports = function calc(trace, vals, containerStr, cLetter) {
+module.exports = function calc(gd, trace, opts) {
+    var fullLayout = gd._fullLayout;
+    var vals = opts.vals;
+    var containerStr = opts.containerStr;
+    var cLetter = opts.cLetter;
     var container = trace;
     var inputContainer = trace._input;
     var fullInputContainer = trace._fullInput;
@@ -84,9 +87,9 @@ module.exports = function calc(trace, vals, containerStr, cLetter) {
     doUpdate(autoAttr, (auto !== false || (min === undefined && max === undefined)));
 
     if(container.autocolorscale) {
-        if(min * max < 0) scl = scales.RdBu;
-        else if(min >= 0) scl = scales.Reds;
-        else scl = scales.Blues;
+        if(min * max < 0) scl = fullLayout.colorscale.diverging;
+        else if(min >= 0) scl = fullLayout.colorscale.sequential;
+        else scl = gd._fullLayout.colorscale.sequentialminus;
 
         // reversescale is handled at the containerOut level
         doUpdate('colorscale', scl, container.reversescale ? flipScale(scl) : scl);
diff --git a/src/components/colorscale/index.js b/src/components/colorscale/index.js
@@ -9,12 +9,20 @@
 
 'use strict';
 
+exports.moduleType = 'component';
+
+exports.name = 'colorscale';
+
 exports.scales = require('./scales');
 
 exports.defaultScale = require('./default_scale');
 
 exports.attributes = require('./attributes');
 
+exports.layoutAttributes = require('./layout_attributes');
+
+exports.supplyLayoutDefaults = require('./layout_defaults');
+
 exports.handleDefaults = require('./defaults');
 
 exports.calc = require('./calc');
diff --git a/src/components/colorscale/layout_attributes.js b/src/components/colorscale/layout_attributes.js
@@ -0,0 +1,46 @@
+/**
+* Copyright 2012-2018, Plotly, Inc.
+* All rights reserved.
+*
+* This source code is licensed under the MIT license found in the
+* LICENSE file in the root directory of this source tree.
+*/
+
+'use strict';
+
+var scales = require('./scales');
+
+var msg = 'Note that `autocolorscale` must be true for this attribute to work.';
+module.exports = {
+    editType: 'calc',
+    sequential: {
+        valType: 'colorscale',
+        dflt: scales.Reds,
+        role: 'style',
+        editType: 'calc',
+        description: [
+            'Sets the default sequential colorscale for positive values.',
+            msg
+        ].join(' ')
+    },
+    sequentialminus: {
+        valType: 'colorscale',
+        dflt: scales.Blues,
+        role: 'style',
+        editType: 'calc',
+        description: [
+            'Sets the default sequential colorscale for negative values.',
+            msg
+        ].join(' ')
+    },
+    diverging: {
+        valType: 'colorscale',
+        dflt: scales.RdBu,
+        role: 'style',
+        editType: 'calc',
+        description: [
+            'Sets the default diverging colorscale.',
+            msg
+        ].join(' ')
+    }
+};
diff --git a/src/components/colorscale/layout_defaults.js b/src/components/colorscale/layout_defaults.js
@@ -0,0 +1,26 @@
+/**
+* Copyright 2012-2018, Plotly, Inc.
+* All rights reserved.
+*
+* This source code is licensed under the MIT license found in the
+* LICENSE file in the root directory of this source tree.
+*/
+
+
+'use strict';
+
+var Lib = require('../../lib');
+var colorscaleAttrs = require('./layout_attributes');
+var Template = require('../../plot_api/plot_template');
+
+module.exports = function supplyLayoutDefaults(layoutIn, layoutOut) {
+    var colorscaleIn = layoutIn.colorscale;
+    var colorscaleOut = Template.newContainer(layoutOut, 'colorscale');
+    function coerce(attr, dflt) {
+        return Lib.coerce(colorscaleIn, colorscaleOut, colorscaleAttrs, attr, dflt);
+    }
+
+    coerce('sequential');
+    coerce('sequentialminus');
+    coerce('diverging');
+};
diff --git a/src/core.js b/src/core.js
@@ -53,7 +53,8 @@ register([
     require('./components/rangeslider'),
     require('./components/rangeselector'),
     require('./components/grid'),
-    require('./components/errorbars')
+    require('./components/errorbars'),
+    require('./components/colorscale')
 ]);
 
 // locales en and en-US are required for default behavior
diff --git a/src/plots/layout_attributes.js b/src/plots/layout_attributes.js
@@ -10,6 +10,7 @@
 
 var fontAttrs = require('./font_attributes');
 var colorAttrs = require('../components/color/attributes');
+var colorscaleAttrs = require('../components/colorscale/layout_attributes');
 
 var globalFont = fontAttrs({
     editType: 'calc',
@@ -188,6 +189,7 @@ module.exports = {
         editType: 'calc',
         description: 'Sets the default trace colors.'
     },
+    colorscale: colorscaleAttrs,
     datarevision: {
         valType: 'any',
         role: 'info',
diff --git a/src/traces/bar/calc.js b/src/traces/bar/calc.js
@@ -42,10 +42,18 @@ module.exports = function calc(gd, trace) {
 
     // auto-z and autocolorscale if applicable
     if(hasColorscale(trace, 'marker')) {
-        colorscaleCalc(trace, trace.marker.color, 'marker', 'c');
+        colorscaleCalc(gd, trace, {
+            vals: trace.marker.color,
+            containerStr: 'marker',
+            cLetter: 'c'
+        });
     }
     if(hasColorscale(trace, 'marker.line')) {
-        colorscaleCalc(trace, trace.marker.line.color, 'marker.line', 'c');
+        colorscaleCalc(gd, trace, {
+            vals: trace.marker.line.color,
+            containerStr: 'marker.line',
+            cLetter: 'c'
+        });
     }
 
     arraysToCalcdata(cd, trace);
diff --git a/src/traces/barpolar/calc.js b/src/traces/barpolar/calc.js
@@ -53,10 +53,18 @@ function calc(gd, trace) {
     }
 
     if(hasColorscale(trace, 'marker')) {
-        colorscaleCalc(trace, trace.marker.color, 'marker', 'c');
+        colorscaleCalc(gd, trace, {
+            vals: trace.marker.color,
+            containerStr: 'marker',
+            cLetter: 'c'
+        });
     }
     if(hasColorscale(trace, 'marker.line')) {
-        colorscaleCalc(trace, trace.marker.line.color, 'marker.line', 'c');
+        colorscaleCalc(gd, trace, {
+            vals: trace.marker.line.color,
+            containerStr: 'marker.line',
+            cLetter: 'c'
+        });
     }
 
     arraysToCalcdata(cd, trace);
diff --git a/src/traces/choropleth/calc.js b/src/traces/choropleth/calc.js
@@ -30,7 +30,11 @@ module.exports = function calc(gd, trace) {
     }
 
     arraysToCalcdata(calcTrace, trace);
-    colorscaleCalc(trace, trace.z, '', 'z');
+    colorscaleCalc(gd, trace, {
+        vals: trace.z,
+        containerStr: '',
+        cLetter: 'z'
+    });
     calcSelection(calcTrace, trace);
 
     return calcTrace;
diff --git a/src/traces/cone/calc.js b/src/traces/cone/calc.js
@@ -34,5 +34,9 @@ module.exports = function calc(gd, trace) {
     trace._len = len;
     trace._normMax = normMax;
 
-    colorscaleCalc(trace, [normMin, normMax], '', 'c');
+    colorscaleCalc(gd, trace, {
+        vals: [normMin, normMax],
+        containerStr: '',
+        cLetter: 'c'
+    });
 };
diff --git a/src/traces/contourcarpet/calc.js b/src/traces/contourcarpet/calc.js
@@ -101,7 +101,11 @@ function heatmappishCalc(gd, trace) {
 
     if(trace.contours.type === 'levels' && trace.contours.coloring !== 'none') {
         // auto-z and autocolorscale if applicable
-        colorscaleCalc(trace, z, '', 'z');
+        colorscaleCalc(gd, trace, {
+            vals: z,
+            containerStr: '',
+            cLetter: 'z'
+        });
     }
 
     return [cd0];
diff --git a/src/traces/heatmap/calc.js b/src/traces/heatmap/calc.js
@@ -146,7 +146,11 @@ module.exports = function calc(gd, trace) {
 
     // auto-z and autocolorscale if applicable
     if(!isContour || trace.contours.type !== 'constraint') {
-        colorscaleCalc(trace, z, '', 'z');
+        colorscaleCalc(gd, trace, {
+            vals: z,
+            containerStr: '',
+            cLetter: 'z'
+        });
     }
 
     if(isContour && trace.contours && trace.contours.coloring === 'heatmap') {
diff --git a/src/traces/mesh3d/calc.js b/src/traces/mesh3d/calc.js
@@ -12,6 +12,10 @@ var colorscaleCalc = require('../../components/colorscale/calc');
 
 module.exports = function calc(gd, trace) {
     if(trace.intensity) {
-        colorscaleCalc(trace, trace.intensity, '', 'c');
+        colorscaleCalc(gd, trace, {
+            vals: trace.intensity,
+            containerStr: '',
+            cLetter: 'c'
+        });
     }
 };
diff --git a/src/traces/parcats/calc.js b/src/traces/parcats/calc.js
@@ -73,7 +73,11 @@ module.exports = function calc(gd, trace) {
     // Process colorscale
     if(line) {
         if(hasColorscale(trace, 'line')) {
-            colorscaleCalc(trace, trace.line.color, 'line', 'c');
+            colorscaleCalc(gd, trace, {
+                vals: trace.line.color,
+                containerStr: 'line',
+                cLetter: 'c'
+            });
         }
         markerColorscale = Drawing.tryColorscale(line);
     } else {
diff --git a/src/traces/parcoords/calc.js b/src/traces/parcoords/calc.js
@@ -19,7 +19,11 @@ module.exports = function calc(gd, trace) {
     var cscale = cs ? trace.line.colorscale : [[0, trace.line.color], [1, trace.line.color]];
 
     if(hasColorscale(trace, 'line')) {
-        calcColorscale(trace, color, 'line', 'c');
+        calcColorscale(gd, trace, {
+            vals: color,
+            containerStr: 'line',
+            cLetter: 'c'
+        });
     }
 
     return wrap({
diff --git a/src/traces/scatter/calc.js b/src/traces/scatter/calc.js
@@ -87,7 +87,7 @@ function calc(gd, trace) {
     }
 
     arraysToCalcdata(cd, trace);
-    calcColorscale(trace);
+    calcColorscale(gd, trace);
     calcSelection(cd, trace);
 
     if(stackGroupOpts) {
diff --git a/src/traces/scatter/colorscale_calc.js b/src/traces/scatter/colorscale_calc.js
@@ -15,17 +15,29 @@ var calcColorscale = require('../../components/colorscale/calc');
 var subTypes = require('./subtypes');
 
 
-module.exports = function calcMarkerColorscale(trace) {
+module.exports = function calcMarkerColorscale(gd, trace) {
     if(subTypes.hasLines(trace) && hasColorscale(trace, 'line')) {
-        calcColorscale(trace, trace.line.color, 'line', 'c');
+        calcColorscale(gd, trace, {
+            vals: trace.line.color,
+            containerStr: 'line',
+            cLetter: 'c'
+        });
     }
 
     if(subTypes.hasMarkers(trace)) {
         if(hasColorscale(trace, 'marker')) {
-            calcColorscale(trace, trace.marker.color, 'marker', 'c');
+            calcColorscale(gd, trace, {
+                vals: trace.marker.color,
+                containerStr: 'marker',
+                cLetter: 'c'
+            });
         }
         if(hasColorscale(trace, 'marker.line')) {
-            calcColorscale(trace, trace.marker.line.color, 'marker.line', 'c');
+            calcColorscale(gd, trace, {
+                vals: trace.marker.line.color,
+                containerStr: 'marker.line',
+                cLetter: 'c'
+            });
         }
     }
 };
diff --git a/src/traces/scatter3d/calc.js b/src/traces/scatter3d/calc.js
@@ -21,7 +21,7 @@ module.exports = function calc(gd, trace) {
     var cd = [{x: false, y: false, trace: trace, t: {}}];
 
     arraysToCalcdata(cd, trace);
-    calcColorscales(trace);
+    calcColorscales(gd, trace);
 
     return cd;
 };
diff --git a/src/traces/scattercarpet/calc.js b/src/traces/scattercarpet/calc.js
@@ -50,7 +50,7 @@ module.exports = function calc(gd, trace) {
     cd[0].trace = trace;
 
     calcMarkerSize(trace, serieslen);
-    calcColorscale(trace);
+    calcColorscale(gd, trace);
     arraysToCalcdata(cd, trace);
     calcSelection(cd, trace);
 
diff --git a/src/traces/scattergeo/calc.js b/src/traces/scattergeo/calc.js
@@ -39,7 +39,7 @@ module.exports = function calc(gd, trace) {
     }
 
     arraysToCalcdata(calcTrace, trace);
-    calcMarkerColorscale(trace);
+    calcMarkerColorscale(gd, trace);
     calcSelection(calcTrace, trace);
 
     if(len) {
diff --git a/src/traces/scattergl/index.js b/src/traces/scattergl/index.js
@@ -84,7 +84,7 @@ function calc(gd, trace) {
     }
 
     // create scene options and scene
-    calcColorscales(trace);
+    calcColorscales(gd, trace);
     var opts = sceneOptions(gd, subplot, trace, positions, x, y);
     var scene = sceneUpdate(gd, subplot);
 
diff --git a/src/traces/scatterpolar/calc.js b/src/traces/scatterpolar/calc.js
@@ -45,7 +45,7 @@ module.exports = function calc(gd, trace) {
     var ppad = calcMarkerSize(trace, len);
     trace._extremes.x = Axes.findExtremes(radialAxis, rArray, {ppad: ppad});
 
-    calcColorscale(trace);
+    calcColorscale(gd, trace);
     arraysToCalcdata(cd, trace);
     calcSelection(cd, trace);
 
diff --git a/src/traces/scatterpolargl/index.js b/src/traces/scatterpolargl/index.js
@@ -38,7 +38,7 @@ function calc(gd, trace) {
     stash.r = rArray;
     stash.theta = thetaArray;
 
-    calcColorscales(trace);
+    calcColorscales(gd, trace);
 
     // only compute 'style' options in calc, as position options
     // depend on the radial range and must be set in plot
diff --git a/src/traces/scatterternary/calc.js b/src/traces/scatterternary/calc.js
@@ -72,7 +72,7 @@ module.exports = function calc(gd, trace) {
     }
 
     calcMarkerSize(trace, serieslen);
-    calcColorscale(trace);
+    calcColorscale(gd, trace);
     arraysToCalcdata(cd, trace);
     calcSelection(cd, trace);
 
diff --git a/src/traces/splom/index.js b/src/traces/splom/index.js
diff --git a/src/traces/streamtube/calc.js b/src/traces/streamtube/calc.js
diff --git a/src/traces/surface/calc.js b/src/traces/surface/calc.js
diff --git a/test/image/baselines/colorscale_template.png b/test/image/baselines/colorscale_template.png
diff --git a/test/image/mocks/colorscale_template.json b/test/image/mocks/colorscale_template.json
diff --git a/test/jasmine/assets/supply_defaults.js b/test/jasmine/assets/supply_defaults.js
diff --git a/test/jasmine/tests/colorscale_test.js b/test/jasmine/tests/colorscale_test.js

Original file line number	Diff line number	Diff line change
`@@ -53,10 +53,18 @@ function calc(gd, trace) {`
`53`	`53`	`}`
`54`	`54`
`55`	`55`	`if(hasColorscale(trace, 'marker')) {`
`56`		`- colorscaleCalc(trace, trace.marker.color, 'marker', 'c');`
	`56`	`+ colorscaleCalc(gd, trace, {`
	`57`	`+ vals: trace.marker.color,`
	`58`	`+ containerStr: 'marker',`
	`59`	`+ cLetter: 'c'`
	`60`	`+ });`
`57`	`61`	`}`
`58`	`62`	`if(hasColorscale(trace, 'marker.line')) {`
`59`		`- colorscaleCalc(trace, trace.marker.line.color, 'marker.line', 'c');`
	`63`	`+ colorscaleCalc(gd, trace, {`
	`64`	`+ vals: trace.marker.line.color,`
	`65`	`+ containerStr: 'marker.line',`
	`66`	`+ cLetter: 'c'`
	`67`	`+ });`
`60`	`68`	`}`
`61`	`69`
`62`	`70`	`arraysToCalcdata(cd, trace);`