stream-charts 1.2.1 → 2.0.1-snapshot

package/dist/app/charts/axes/autoScale.js

@@ -0,0 +1,188 @@
+import { firstIndexAtOrAfter } from "../utils";
+/**
+ * Clamps a domain to the auto-scaling limits, so that an auto-scaling axis never starts out past
+ * them. (When the domain lies entirely beyond a limit, it collapses onto that limit.)
+ * @param domain The domain
+ * @param min The smallest value the domain may reach
+ * @param max The largest value the domain may reach
+ * @return The domain, clamped to the limits
+ */
+export function clampedDomain(domain, min, max) {
+    const clamp = (value) => Math.min(max, Math.max(min, value));
+    return [clamp(domain[0]), clamp(domain[1])];
+}
+/**
+ * Whether two auto-scaling settings are the same (`undefined` means "not auto-scaling")
+ * @param a The first settings
+ * @param b The second settings
+ * @return `true` when they're the same; `false` otherwise
+ */
+export function sameAutoScale(a, b) {
+    if (a === undefined || b === undefined)
+        return a === b;
+    return a.domain[0] === b.domain[0] && a.domain[1] === b.domain[1] &&
+        a.min === b.min && a.max === b.max && a.padding === b.padding;
+}
+/**
+ * Grows an axis' domain to include the specified extent of the data, with the padding beyond it,
+ * without going past the auto-scaling limits. A side grows when the data reaches into its padding
+ * (not only when the data goes past the edge), so that the data always has the padding's room to
+ * spare (until a limit is reached), and it grows so that the data's extreme sits exactly the
+ * padding from the edge. The domain only ever grows: an extent that's within the domain, and
+ * clear of its padding, leaves the domain as it is.
+ *
+ * The padding is applied in the scale's own space (e.g. logarithmically, for a log scale), as a
+ * fraction of the axis' length.
+ * @param domain The axis' current domain
+ * @param extent The [min, max] of the data plotted against the axis, or `undefined` when there's
+ * no data
+ * @param autoScale The auto-scaling settings (the limits, and the padding)
+ * @param scale The axis' scale (only its kind matters: linear, log, ...)
+ * @return The grown domain (or the current domain, when there's nothing to grow for)
+ */
+export function grownDomain(domain, extent, autoScale, scale) {
+    if (extent === undefined)
+        return domain;
+    const [domainMin, domainMax] = domain;
+    const padding = Math.min(0.45, Math.max(0, autoScale.padding));
+    // a side grows when the data reaches into its padding (or past its edge). Where the data sits
+    // within the current domain is measured in the scale's own space, with a little tolerance, so
+    // that an extreme that sits exactly the padding from the edge (as growing leaves it) doesn't
+    // grow the domain again by rounding errors on every frame.
+    const tolerance = 1e-9;
+    const current = scale.copy().domain([domainMin, domainMax]).range([0, 1]);
+    const growsDown = extent[0] < domainMin || current(extent[0]) < padding - tolerance;
+    const growsUp = extent[1] > domainMax || current(extent[1]) > 1 - padding + tolerance;
+    if (!growsDown && !growsUp)
+        return domain;
+    let min = growsDown ? extent[0] : domainMin;
+    let max = growsUp ? extent[1] : domainMax;
+    if (padding > 0 && min < max) {
+        // the normalized scale over the grown domain, extended on each growing side so that the
+        // extreme sits `padding` of the (extended) axis' length from that edge: with n growing
+        // sides, each extension e satisfies e / (1 + n e) = padding
+        const normalized = scale.copy().domain([min, max]).range([0, 1]);
+        const growingSides = (growsDown ? 1 : 0) + (growsUp ? 1 : 0);
+        const extension = padding / (1 - growingSides * padding);
+        if (growsDown)
+            min = normalized.invert(-extension);
+        if (growsUp)
+            max = normalized.invert(1 + extension);
+    }
+    // (never past the limits -- and never shrinking a side, should the domain already be past one)
+    return [
+        growsDown ? Math.min(domainMin, Math.max(autoScale.min, min)) : domainMin,
+        growsUp ? Math.max(domainMax, Math.min(autoScale.max, max)) : domainMax,
+    ];
+}
+/**
+ * Extends an extent to include the specified value
+ * @param extent The extent so far, or `undefined` when there's none yet
+ * @param value The value to include
+ * @return The extent, including the value
+ */
+export function extentWith(extent, value) {
+    if (extent === undefined)
+        return [value, value];
+    return [Math.min(extent[0], value), Math.max(extent[1], value)];
+}
+/**
+ * Calculates the extent (the [min, max]) of the specified values, skipping those the y-scale
+ * can't show (e.g. values <= 0 on a log scale, or NaN)
+ * @param values The values
+ * @param yScale The y-axis' scale
+ * @return The extent of the values, or `undefined` when there are none (that can be shown)
+ */
+export function extentOf(values, yScale) {
+    let extent = undefined;
+    for (const value of values) {
+        if (Number.isFinite(yScale(value)))
+            extent = extentWith(extent, value);
+    }
+    return extent;
+}
+/**
+ * Calculates the extent (the [min, max] of the y-values) of a series' data that's visible within
+ * the x-axis' window: the values of the points within the window, and -- when the series is drawn
+ * with lines -- the lines' heights where they cross the window's left and right edges (a line from
+ * a point just off screen can reach higher, or lower, within the window than any point that's on
+ * screen). Values the y-scale can't show (e.g. values <= 0 on a log scale) are skipped.
+ *
+ * A point can have several values, each drawn as its own line across the points (e.g. an outlier
+ * series' value, and its bands' lower and upper bounds), so the crossings are calculated for each.
+ * They're calculated in the y-scale's own space (as the lines are drawn), so they're exact for
+ * straight lines, on any kind of scale.
+ * @param data The series' data, ordered by x
+ * @param window The x-axis' [start, end]
+ * @param yScale The y-axis' scale
+ * @param withLines Whether the series is drawn with lines (rather than just points)
+ * @param xOf The point's x-value (defaults to its `x`)
+ * @param valuesOf The point's y-values, each drawn as its own line (defaults to its `y`)
+ * @return The extent of the visible data, or `undefined` when nothing is visible
+ * @template P The type of the data's points
+ */
+export function visibleExtent(data, window, yScale, withLines, xOf = point => point.x, valuesOf = point => [point.y]) {
+    const [start, end] = window;
+    const showable = (value) => Number.isFinite(yScale(value));
+    // includes the heights where the lines between the two points cross x
+    const withCrossings = (extent, from, to, x) => {
+        const fromValues = valuesOf(from);
+        const toValues = valuesOf(to);
+        const fraction = xOf(to) === xOf(from) ? 1 : (x - xOf(from)) / (xOf(to) - xOf(from));
+        fromValues.forEach((fromValue, index) => {
+            const toValue = toValues[index];
+            if (toValue === undefined || !showable(fromValue) || !showable(toValue))
+                return;
+            const fromY = yScale(fromValue);
+            extent = extentWith(extent, yScale.invert(fromY + (yScale(toValue) - fromY) * fraction));
+        });
+        return extent;
+    };
+    let extent = undefined;
+    let index = firstIndexAtOrAfter(data, start, xOf);
+    // the lines entering through the window's left edge
+    if (withLines && index > 0 && index < data.length && xOf(data[index]) <= end) {
+        extent = withCrossings(extent, data[index - 1], data[index], start);
+    }
+    // the points within the window
+    for (; index < data.length && xOf(data[index]) <= end; index++) {
+        valuesOf(data[index]).forEach(value => {
+            if (showable(value))
+                extent = extentWith(extent, value);
+        });
+    }
+    // the lines leaving through the window's right edge (or, when no point is within the window,
+    // passing straight across it)
+    if (withLines && index > 0 && index < data.length && xOf(data[index - 1]) < end) {
+        extent = withCrossings(extent, data[index - 1], data[index], end);
+        if (xOf(data[index - 1]) < start)
+            extent = withCrossings(extent, data[index - 1], data[index], start);
+    }
+    return extent;
+}
+// the warnings already issued (each is only issued once)
+const issuedWarnings = new Set();
+/**
+ * Issues a warning to the console, once (e.g. about auto-scaling settings that are ignored)
+ * @param message The warning
+ */
+export function warnOnce(message) {
+    if (issuedWarnings.has(message))
+        return;
+    issuedWarnings.add(message);
+    console.warn(message);
+}
+/**
+ * Warns (once per axis) about the auto-scaling y-axes of a plot that doesn't support auto-scaling,
+ * whose `autoScale` setting is therefore ignored
+ * @param plotName The name of the plot (e.g. "BarPlot")
+ * @param yAxes The plot's y-axes, by their IDs
+ */
+export function warnAboutIgnoredAutoScale(plotName, yAxes) {
+    yAxes.forEach((axis, axisId) => {
+        if (axis.autoScale !== undefined) {
+            warnOnce(`The ${plotName} doesn't support auto-scaling y-axes, so the "autoScale" setting of y-axis "${axisId}" is ignored`);
+        }
+    });
+}
+//# sourceMappingURL=autoScale.js.map

package/dist/app/charts/axes/autoScale.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"autoScale.js","sourceRoot":"","sources":["../../../../src/app/charts/axes/autoScale.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,mBAAmB,EAAC,MAAM,UAAU,CAAC;AA2B7C;;;;;;;GAOG;AACH,MAAM,UAAU,aAAa,CACzB,MAAkC,EAClC,GAAW,EACX,GAAW;IAEX,MAAM,KAAK,GAAG,CAAC,KAAa,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAA;IACpE,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;AAC/C,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,CAAwB,EAAE,CAAwB;IAC5E,IAAI,CAAC,KAAK,SAAS,IAAI,CAAC,KAAK,SAAS;QAAE,OAAO,CAAC,KAAK,CAAC,CAAA;IACtD,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;QAC7D,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,OAAO,KAAK,CAAC,CAAC,OAAO,CAAA;AACrE,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,WAAW,CACvB,MAAkC,EAClC,MAA8C,EAC9C,SAAqD,EACrD,KAA6C;IAE7C,IAAI,MAAM,KAAK,SAAS;QAAE,OAAO,MAAM,CAAA;IACvC,MAAM,CAAC,SAAS,EAAE,SAAS,CAAC,GAAG,MAAM,CAAA;IACrC,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC,CAAA;IAE9D,8FAA8F;IAC9F,8FAA8F;IAC9F,6FAA6F;IAC7F,2DAA2D;IAC3D,MAAM,SAAS,GAAG,IAAI,CAAA;IACtB,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;IACzE,MAAM,SAAS,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,GAAG,SAAS,CAAA;IACnF,MAAM,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,OAAO,GAAG,SAAS,CAAA;IACrF,IAAI,CAAC,SAAS,IAAI,CAAC,OAAO;QAAE,OAAO,MAAM,CAAA;IAEzC,IAAI,GAAG,GAAG,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IAC3C,IAAI,GAAG,GAAG,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IACzC,IAAI,OAAO,GAAG,CAAC,IAAI,GAAG,GAAG,GAAG,EAAE,CAAC;QAC3B,wFAAwF;QACxF,uFAAuF;QACvF,4DAA4D;QAC5D,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;QAChE,MAAM,YAAY,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;QAC5D,MAAM,SAAS,GAAG,OAAO,GAAG,CAAC,CAAC,GAAG,YAAY,GAAG,OAAO,CAAC,CAAA;QACxD,IAAI,SAAS;YAAE,GAAG,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,CAAA;QAClD,IAAI,OAAO;YAAE,GAAG,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,GAAG,SAAS,CAAC,CAAA;IACvD,CAAC;IACD,+FAA+F;IAC/F,OAAO;QACH,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;QACzE,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;KAC1E,CAAA;AACL,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,UAAU,CACtB,MAA8C,EAC9C,KAAa;IAEb,IAAI,MAAM,KAAK,SAAS;QAAE,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAA;IAC/C,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAA;AACnE,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,QAAQ,CACpB,MAAwB,EACxB,MAA8C;IAE9C,IAAI,MAAM,GAA2C,SAAS,CAAA;IAC9D,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QACzB,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAAE,MAAM,GAAG,UAAU,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;IAC1E,CAAC;IACD,OAAO,MAAM,CAAA;AACjB,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,aAAa,CACzB,IAA4C,EAC5C,MAAoC,EACpC,MAA8C,EAC9C,SAAkB,EAClB,MAA4B,KAAK,CAAC,EAAE,CAAE,KAAuB,CAAC,CAAC,EAC/D,WAAwC,KAAK,CAAC,EAAE,CAAC,CAAE,KAAuB,CAAC,CAAC,CAAC;IAE7E,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,GAAG,MAAM,CAAA;IAC3B,MAAM,QAAQ,GAAG,CAAC,KAAa,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;IAClE,sEAAsE;IACtE,MAAM,aAAa,GAAG,CAClB,MAA8C,EAC9C,IAAO,EACP,EAAK,EACL,CAAS,EAC6B,EAAE;QACxC,MAAM,UAAU,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAA;QACjC,MAAM,QAAQ,GAAG,QAAQ,CAAC,EAAE,CAAC,CAAA;QAC7B,MAAM,QAAQ,GAAG,GAAG,CAAC,EAAE,CAAC,KAAK,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC,CAAA;QACpF,UAAU,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE;YACpC,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAA;YAC/B,IAAI,OAAO,KAAK,SAAS,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;gBAAE,OAAM;YAC/E,MAAM,KAAK,GAAG,MAAM,CAAC,SAAS,CAAC,CAAA;YAC/B,MAAM,GAAG,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAA;QAC5F,CAAC,CAAC,CAAA;QACF,OAAO,MAAM,CAAA;IACjB,CAAC,CAAA;IAED,IAAI,MAAM,GAA2C,SAAS,CAAA;IAC9D,IAAI,KAAK,GAAG,mBAAmB,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,CAAC,CAAA;IAEjD,oDAAoD;IACpD,IAAI,SAAS,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,GAAG,IAAI,CAAC,MAAM,IAAI,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,GAAG,EAAE,CAAC;QAC3E,MAAM,GAAG,aAAa,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAA;IACvE,CAAC;IAED,+BAA+B;IAC/B,OAAO,KAAK,GAAG,IAAI,CAAC,MAAM,IAAI,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC;QAC7D,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YAClC,IAAI,QAAQ,CAAC,KAAK,CAAC;gBAAE,MAAM,GAAG,UAAU,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;QAC3D,CAAC,CAAC,CAAA;IACN,CAAC;IAED,6FAA6F;IAC7F,8BAA8B;IAC9B,IAAI,SAAS,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,GAAG,IAAI,CAAC,MAAM,IAAI,GAAG,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC;QAC9E,MAAM,GAAG,aAAa,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC,CAAA;QACjE,IAAI,GAAG,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,GAAG,KAAK;YAAE,MAAM,GAAG,aAAa,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAA;IACzG,CAAC;IACD,OAAO,MAAM,CAAA;AACjB,CAAC;AAED,yDAAyD;AACzD,MAAM,cAAc,GAAG,IAAI,GAAG,EAAU,CAAA;AAExC;;;GAGG;AACH,MAAM,UAAU,QAAQ,CAAC,OAAe;IACpC,IAAI,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC;QAAE,OAAM;IACvC,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;IAC3B,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;AACzB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,yBAAyB,CAAC,QAAgB,EAAE,KAA0B;IAClF,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE;QAC3B,IAAK,IAAkC,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;YAC9D,QAAQ,CAAC,OAAO,QAAQ,+EAA+E,MAAM,cAAc,CAAC,CAAA;QAChI,CAAC;IACL,CAAC,CAAC,CAAA;AACN,CAAC"}