move all colorscale helpers to ./helpers.js and ./scales.js

Author: etpinard

src/components/colorscale/attributes.js

@@ -8,7 +8,7 @@
 
 'use strict';
 
-var palettes = require('./scales.js');
+var palettes = require('./scales.js').scales;
 var paletteStr = Object.keys(palettes);
 
 function code(s) {

src/components/colorscale/calc.js

@@ -6,13 +6,10 @@
 * LICENSE file in the root directory of this source tree.
 */
 
-
 'use strict';
 
 var Lib = require('../../lib');
-
-var flipScale = require('./flip_scale');
-
+var flipScale = require('./helpers').flipScale;
 
 module.exports = function calc(gd, trace, opts) {
     var fullLayout = gd._fullLayout;

src/components/colorscale/default_scale.js

@@ -6,18 +6,15 @@
 * LICENSE file in the root directory of this source tree.
 */
 
-
 'use strict';
 
 var isNumeric = require('fast-isnumeric');
 
 var Lib = require('../../lib');
-
 var hasColorbar = require('../colorbar/has_colorbar');
 var colorbarDefaults = require('../colorbar/defaults');
-var isValidScale = require('./is_valid_scale');
-var flipScale = require('./flip_scale');
 
+var isValidScale = require('./scales').isValid;
 
 module.exports = function colorScaleDefaults(traceIn, traceOut, layout, coerce, opts) {
     var prefix = opts.prefix,
@@ -47,12 +44,9 @@ module.exports = function colorScaleDefaults(traceIn, traceOut, layout, coerce,
 
     // reversescale is handled at the containerOut level
     var reverseScale = coerce(prefix + 'reversescale');
-    if(reverseScale) containerOut.colorscale = flipScale(sclOut);
-
-    // ... until Scatter.colorbar can handle marker line colorbars
-    if(prefix === 'marker.line.') return;
+    if(reverseScale) containerOut.colorscale = helpers.flipScale(sclOut);
 
-    if(!opts.noScale) {
+    if(!opts.noScale && prefix !== 'marker.line.') {
         // handles both the trace case where the dflt is listed in attributes and
         // the marker case where the dflt is determined by hasColorbar
         var showScaleDflt;

src/components/colorscale/defaults.js

@@ -6,15 +6,82 @@
 * LICENSE file in the root directory of this source tree.
 */
 
-
 'use strict';
 
 var d3 = require('d3');
 var tinycolor = require('tinycolor2');
 var isNumeric = require('fast-isnumeric');
 
+var Lib = require('../../lib');
 var Color = require('../color');
 
+var isValidScale = require('./scales').isValid;
+
+function hasColorscale(trace, containerStr) {
+    var container = containerStr ?
+        Lib.nestedProperty(trace, containerStr).get() || {} :
+        trace;
+    var color = container.color;
+
+    var isArrayWithOneNumber = false;
+    if(Lib.isArrayOrTypedArray(color)) {
+        for(var i = 0; i < color.length; i++) {
+            if(isNumeric(color[i])) {
+                isArrayWithOneNumber = true;
+                break;
+            }
+        }
+    }
+
+    return (
+        Lib.isPlainObject(container) && (
+            isArrayWithOneNumber ||
+            container.showscale === true ||
+            (isNumeric(container.cmin) && isNumeric(container.cmax)) ||
+            isValidScale(container.colorscale) ||
+            Lib.isPlainObject(container.colorbar)
+        )
+    );
+}
+
+/**
+ * Extract colorscale into numeric domain and color range.
+ *
+ * @param {array} scl colorscale array of arrays
+ * @param {number} cmin minimum color value (used to clamp scale)
+ * @param {number} cmax maximum color value (used to clamp scale)
+ */
+function extractScale(scl, cmin, cmax) {
+    var N = scl.length;
+    var domain = new Array(N);
+    var range = new Array(N);
+
+    for(var i = 0; i < N; i++) {
+        var si = scl[i];
+
+        domain[i] = cmin + si[0] * (cmax - cmin);
+        range[i] = si[1];
+    }
+
+    return {
+        domain: domain,
+        range: range
+    };
+}
+
+function flipScale(scl) {
+    var N = scl.length;
+    var sclNew = new Array(N);
+    var si;
+
+    for(var i = N - 1, j = 0; i >= 0; i--, j++) {
+        si = scl[i];
+        sclNew[j] = [1 - si[0], si[1]];
+    }
+
+    return sclNew;
+}
+
 /**
  * General colorscale function generator.
  *
@@ -28,7 +95,7 @@ var Color = require('../color');
  *
  * @return {function}
  */
-module.exports = function makeColorScaleFunc(specs, opts) {
+function makeColorScaleFunc(specs, opts) {
     opts = opts || {};
 
     var domain = specs.domain,
@@ -80,7 +147,7 @@ module.exports = function makeColorScaleFunc(specs, opts) {
     sclFunc.range = function() { return range; };
 
     return sclFunc;
-};
+}
 
 function colorArray2rbga(colorArray) {
     var colorObj = {
@@ -92,3 +159,10 @@ function colorArray2rbga(colorArray) {
 
     return tinycolor(colorObj).toRgbString();
 }
+
+module.exports = {
+    hasColorscale: hasColorscale,
+    extractScale: extractScale,
+    flipScale: flipScale,
+    makeColorScaleFunc: makeColorScaleFunc
+};

src/components/colorscale/extract_scale.js

@@ -6,35 +6,32 @@
 * LICENSE file in the root directory of this source tree.
 */
 
-
 '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');
+var scales = require('./scales');
+var helpers = require('./helpers');
 
-exports.hasColorscale = require('./has_colorscale');
+module.exports = {
+    moduleType: 'component',
+    name: 'colorscale',
 
-exports.isValidScale = require('./is_valid_scale');
+    attributes: require('./attributes'),
+    layoutAttributes: require('./layout_attributes'),
 
-exports.getScale = require('./get_scale');
+    supplyLayoutDefaults: require('./layout_defaults'),
+    handleDefaults: require('./defaults'),
 
-exports.flipScale = require('./flip_scale');
+    calc: require('./calc'),
 
-exports.extractScale = require('./extract_scale');
+    // ./scales.js is required in lib/coerce.js ;
+    // it needs to be a seperate module to avoid circular a dependency
+    scales: scales.scales,
+    defaultScale: scales.defaultScale,
+    getScale: scales.get,
+    isValidScale: scales.isValid,
 
-exports.makeColorScaleFunc = require('./make_color_scale_func');
+    hasColorscale: helpers.hasColorscale,
+    flipScale: helpers.flipScale,
+    extractScale: helpers.extractScale,
+    makeColorScaleFunc: helpers.makeColorScaleFunc
+};