@genome-spy/core 0.14.0

package/src/scale/scale.js

@@ -0,0 +1,441 @@
+/*!
+ * Adapted from vega-encode:
+ * https://github.com/vega/vega/blob/master/packages/vega-encode/src/Scale.js
+ *
+ * Copyright (c) 2015-2018, University of Washington Interactive Data Lab
+ * All rights reserved.
+ *
+ * BSD-3-Clause License: https://github.com/vega/vega-lite/blob/master/LICENSE
+ */
+
+/* eslint-disable */
+
+import { tickCount } from "./ticks";
+import {
+    error,
+    inherits,
+    isArray,
+    isFunction,
+    isString,
+    peek,
+    stringValue,
+    toSet,
+    zoomLinear,
+    zoomLog,
+    zoomPow,
+    zoomSymlog,
+} from "vega-util";
+
+import {
+    Ordinal,
+    Band,
+    Point,
+    Sequential,
+    Diverging,
+    Linear,
+    Log,
+    Pow,
+    Sqrt,
+    Symlog,
+    Time,
+    UTC,
+    Quantile,
+    Quantize,
+    Threshold,
+    BinOrdinal,
+    isContinuous,
+    isInterpolating,
+    isLogarithmic,
+    bandSpace,
+    interpolateColors,
+    interpolateRange,
+    interpolate as getInterpolate,
+    scale as getScale,
+    scheme as getScheme,
+    scaleImplicit,
+    quantizeInterpolator,
+} from "vega-scale";
+
+import { range as sequence } from "d3-array";
+
+import { interpolate, interpolateRound } from "d3-interpolate";
+
+const Locus = "locus";
+const Index = "index";
+
+var DEFAULT_COUNT = 5;
+
+function includeZero(scale) {
+    const type = scale.type;
+    return !scale.bins && (type === Linear || type === Pow || type === Sqrt);
+}
+
+function includePad(type) {
+    return isContinuous(type) && ![Sequential, Index, Locus].includes(type);
+}
+
+function ensureLogger(logger) {
+    return (
+        logger || {
+            warn: (msg, ...rest) => console.warn(msg, ...rest),
+        }
+    );
+}
+
+var SKIP = toSet([
+    "set",
+    "modified",
+    "clear",
+    "type",
+    "scheme",
+    "schemeExtent",
+    "schemeCount",
+    "domain",
+    "domainMin",
+    "domainMid",
+    "domainMax",
+    "domainRaw",
+    "domainImplicit",
+    "nice",
+    "zero",
+    "bins",
+    "range",
+    "rangeStep",
+    "round",
+    "reverse",
+    "interpolate",
+    "interpolateGamma",
+    "zoom",
+    "fp64",
+    "name",
+]);
+
+export function configureScale(_, scale, logger) {
+    logger = ensureLogger(logger);
+
+    for (const key in _) {
+        if (!SKIP[key]) {
+            // padding is a scale property for band/point but not others
+            if (key === "padding" && includePad(scale.type)) continue;
+            // invoke scale property setter, raise warning if not found
+            isFunction(scale[key])
+                ? scale[key](_[key])
+                : logger.warn("Unsupported scale property: " + key);
+        }
+    }
+
+    configureRange(
+        scale,
+        _,
+        configureBins(scale, _, configureDomain(scale, _, logger))
+    );
+}
+
+export default function createScale(_, logger) {
+    const key = scaleKey(_);
+    const scale = getScale(key);
+
+    if (!scale) {
+        throw new Error("Unknown scale type: " + key);
+    }
+
+    const scaleInstance = scale();
+
+    configureScale(_, scaleInstance, logger);
+
+    return scaleInstance;
+}
+
+function scaleKey(_) {
+    var t = _.type,
+        d = "",
+        n;
+
+    // backwards compatibility pre Vega 5.
+    if (t === Sequential) return Sequential + "-" + Linear;
+
+    if (isContinuousColor(_)) {
+        n = _.rawDomain
+            ? _.rawDomain.length
+            : _.domain
+            ? _.domain.length + +(_.domainMid != null)
+            : 0;
+        d = n === 2 ? Sequential + "-" : n === 3 ? Diverging + "-" : "";
+    }
+
+    return (d + t || Linear).toLowerCase();
+}
+
+function isContinuousColor(_) {
+    const t = _.type;
+    return (
+        isContinuous(t) &&
+        t !== Time &&
+        t !== UTC &&
+        (_.scheme || (_.range && _.range.length && _.range.every(isString)))
+    );
+}
+
+export function configureDomain(scale, _, logger) {
+    if (!scale.domain) {
+        return 0;
+    }
+
+    logger = ensureLogger(logger);
+
+    // check raw domain, if provided use that and exit early
+    var raw = rawDomain(scale, _.domainRaw, logger);
+    if (raw > -1) return raw;
+
+    var domain = _.domain,
+        type = scale.type,
+        zero = _.zero || (_.zero === undefined && includeZero(scale)),
+        n,
+        mid;
+
+    if (!domain) return 0;
+
+    // adjust continuous domain for minimum pixel padding
+    if (includePad(type) && _.padding && domain[0] !== peek(domain)) {
+        domain = padDomain(
+            type,
+            domain,
+            _.range,
+            _.padding,
+            _.exponent,
+            _.constant
+        );
+    }
+
+    // adjust domain based on zero, min, max settings
+    if (
+        zero ||
+        _.domainMin != null ||
+        _.domainMax != null ||
+        _.domainMid != null
+    ) {
+        n = (domain = domain.slice()).length - 1 || 1;
+        if (zero) {
+            if (domain[0] > 0) domain[0] = 0;
+            if (domain[n] < 0) domain[n] = 0;
+        }
+        if (_.domainMin != null) domain[0] = _.domainMin;
+        if (_.domainMax != null) domain[n] = _.domainMax;
+
+        if (_.domainMid != null) {
+            mid = _.domainMid;
+            if (mid < domain[0] || mid > domain[n]) {
+                logger.warn("Scale domainMid exceeds domain min or max.", mid);
+            }
+            domain.splice(n, 0, mid);
+        }
+    }
+
+    // set the scale domain
+    scale.domain(domainCheck(type, domain, logger));
+
+    // if ordinal scale domain is defined, prevent implicit
+    // domain construction as side-effect of scale lookup
+    if (type === Ordinal) {
+        scale.unknown(_.domainImplicit ? scaleImplicit : undefined);
+    }
+
+    // perform 'nice' adjustment as requested
+    if (_.nice && scale.nice) {
+        scale.nice((_.nice !== true && tickCount(scale, _.nice)) || null);
+    }
+
+    // return the cardinality of the domain
+    return domain.length;
+}
+
+function rawDomain(scale, raw, logger) {
+    if (raw) {
+        scale.domain(domainCheck(scale.type, raw, logger));
+        return raw.length;
+    } else {
+        return -1;
+    }
+}
+
+function padDomain(type, domain, range, pad, exponent, constant) {
+    var span = Math.abs(peek(range) - range[0]),
+        frac = span / (span - 2 * pad),
+        d =
+            type === Log
+                ? zoomLog(domain, null, frac)
+                : type === Sqrt
+                ? zoomPow(domain, null, frac, 0.5)
+                : type === Pow
+                ? zoomPow(domain, null, frac, exponent || 1)
+                : type === Symlog
+                ? zoomSymlog(domain, null, frac, constant || 1)
+                : zoomLinear(domain, null, frac);
+
+    domain = domain.slice();
+    domain[0] = d[0];
+    domain[domain.length - 1] = d[1];
+    return domain;
+}
+
+function domainCheck(type, domain, logger) {
+    if (isLogarithmic(type)) {
+        // sum signs of domain values
+        // if all pos or all neg, abs(sum) === domain.length
+        var s = Math.abs(
+            domain.reduce(function (s, v) {
+                return s + (v < 0 ? -1 : v > 0 ? 1 : 0);
+            }, 0)
+        );
+
+        if (s !== domain.length) {
+            logger.warn(
+                "Log scale domain includes zero: " + stringValue(domain)
+            );
+        }
+    }
+    return domain;
+}
+
+function configureBins(scale, _, count) {
+    let bins = _.bins;
+
+    if (bins && !isArray(bins)) {
+        // generate bin boundary array
+        const domain =
+                (bins.start == null || bins.stop == null) && scale.domain(),
+            start = bins.start == null ? domain[0] : bins.start,
+            stop = bins.stop == null ? peek(domain) : bins.stop,
+            step = bins.step;
+
+        if (!step) error("Scale bins parameter missing step property.");
+        bins = sequence(start, stop + step, step);
+    }
+
+    if (bins) {
+        // assign bin boundaries to scale instance
+        scale.bins = bins;
+    } else if (scale.bins) {
+        // no current bins, remove bins if previously set
+        delete scale.bins;
+    }
+
+    // special handling for bin-ordinal scales
+    if (scale.type === BinOrdinal) {
+        if (!bins) {
+            // the domain specifies the bins
+            scale.bins = scale.domain();
+        } else if (!_.domain && !_.domainRaw) {
+            // the bins specify the domain
+            scale.domain(bins);
+            count = bins.length;
+        }
+    }
+
+    // return domain cardinality
+    return count;
+}
+
+function configureRange(scale, _, count) {
+    var type = scale.type,
+        round = _.round || false,
+        range = _.range;
+
+    // if range step specified, calculate full range extent
+    if (_.rangeStep != null) {
+        range = configureRangeStep(type, _, count);
+    }
+
+    // else if a range scheme is defined, use that
+    else if (_.scheme) {
+        range = configureScheme(type, _, count);
+        if (isFunction(range)) {
+            if (scale.interpolator) {
+                return scale.interpolator(range);
+            } else {
+                error(
+                    `Scale type ${type} does not support interpolating color schemes.`
+                );
+            }
+        }
+    }
+
+    // given a range array for an interpolating scale, convert to interpolator
+    if (range && isInterpolating(type)) {
+        return scale.interpolator(
+            interpolateColors(
+                flip(range, _.reverse),
+                _.interpolate,
+                _.interpolateGamma
+            )
+        );
+    }
+
+    // configure rounding / interpolation
+    if (range && _.interpolate && scale.interpolate) {
+        scale.interpolate(getInterpolate(_.interpolate, _.interpolateGamma));
+    } else if (isFunction(scale.round)) {
+        scale.round(round);
+    } else if (isFunction(scale.rangeRound)) {
+        scale.interpolate(round ? interpolateRound : interpolate);
+    }
+
+    if (range) scale.range(flip(range, _.reverse));
+}
+
+function configureRangeStep(type, _, count) {
+    if (type !== Band && type !== Point) {
+        error("Only band and point scales support rangeStep.");
+    }
+
+    // calculate full range based on requested step size and padding
+    var outer = (_.paddingOuter != null ? _.paddingOuter : _.padding) || 0,
+        inner =
+            type === Point
+                ? 1
+                : (_.paddingInner != null ? _.paddingInner : _.padding) || 0;
+    return [0, _.rangeStep * bandSpace(count, inner, outer)];
+}
+
+function configureScheme(type, _, count) {
+    var extent = _.schemeExtent,
+        name,
+        scheme;
+
+    if (isArray(_.scheme)) {
+        scheme = interpolateColors(_.scheme, _.interpolate, _.interpolateGamma);
+    } else {
+        name = _.scheme.toLowerCase();
+        scheme = getScheme(name);
+        if (!scheme) error(`Unrecognized scheme name: ${_.scheme}`);
+    }
+
+    // determine size for potential discrete range
+    count =
+        type === Threshold
+            ? count + 1
+            : type === BinOrdinal
+            ? count - 1
+            : type === Quantile || type === Quantize
+            ? +_.schemeCount || DEFAULT_COUNT
+            : count;
+
+    // adjust and/or quantize scheme as appropriate
+    return isInterpolating(type)
+        ? adjustScheme(scheme, extent, _.reverse)
+        : isFunction(scheme)
+        ? quantizeInterpolator(adjustScheme(scheme, extent), count)
+        : type === Ordinal
+        ? scheme
+        : scheme.slice(0, count);
+}
+
+function adjustScheme(scheme, extent, reverse) {
+    return isFunction(scheme) && (extent || reverse)
+        ? interpolateRange(scheme, flip(extent || [0, 1], reverse))
+        : scheme;
+}
+
+function flip(array, reverse) {
+    return reverse ? array.slice().reverse() : array;
+}