stream-charts 1.0.1 → 1.1.1

package/dist/src/app/charts/observables/ordinals.test.js

@@ -0,0 +1,102 @@
+import { datumOf } from "../series/timeSeries";
+import { seriesFrom } from "../series/baseSeries";
+import { range } from "rxjs";
+import { map } from "rxjs/operators";
+import { ordinalsObservable } from "./ordinals";
+export function sinFn(x, period) {
+    return Math.sin(2 * Math.PI * x / period);
+}
+describe('when generating ordinal series', () => {
+    const NUM_POINTS = 10;
+    const UPDATE_PERIOD = 25;
+    const seriesData = [["test1", sinFn(0, 250)], ["test2", sinFn(1, 251)], ["test3", sinFn(2, 252)]];
+    const initialData = seriesData
+        .map(([name, value], index) => seriesFrom(name, [datumOf(index, value)]));
+    test('should be able to generate ordinals', done => {
+        let results = [];
+        ordinalsObservable(sineDataObservable(initialData, NUM_POINTS, UPDATE_PERIOD)).subscribe(chartData => results.push(chartData));
+        // blocks until done is called
+        done();
+        expect(results).toHaveLength(NUM_POINTS);
+        results.forEach((result, timeIndex) => {
+            Array.from(result.newPoints.entries()).forEach(([seriesName, ordinalDatum], index) => {
+                expect(seriesName).toEqual(seriesData[index][0]);
+                // check the time for the datum (only one new-point datum)
+                expect(ordinalDatum).toBeDefined();
+                expect(ordinalDatum.length).toBe(1);
+                expect(ordinalDatum[0].time).toEqual(index + timeIndex * UPDATE_PERIOD);
+                // should be bounded (data is bounded)
+                expect(ordinalDatum[0].value).toBeLessThanOrEqual(1);
+                expect(ordinalDatum[0].value).toBeGreaterThanOrEqual(-1);
+            });
+            // the min time should be 1 and the max time should be (3 + timeIndex + updatePeriod)
+            expect(result.stats.minDatum.time.time).toBe(0);
+            expect(result.stats.maxDatum.time.time).toBe(2 + timeIndex * UPDATE_PERIOD);
+        });
+    });
+});
+/**
+ * Creates random data
+ * @param sequenceTime The current time
+ * @param maxTime The number of points in the series
+ * @param series The list of series names (identifiers) to update
+ * @param seriesMaxTimes The maximum time for each series
+ * @return The random chart data
+ */
+function sineData(sequenceTime, maxTime, series, seriesMaxTimes) {
+    const maxTimes = new Map(Array.from(seriesMaxTimes.entries()).map(([name, maxTime]) => [name, maxTime + sequenceTime]));
+    return {
+        seriesNames: new Set(series),
+        maxTime: sequenceTime,
+        maxTimes,
+        newPoints: new Map(series.map((name, index) => {
+            const time = sequenceTime + index;
+            const value = sinFn(time, maxTime + index);
+            return [name, [{ time, value }]];
+        }))
+    };
+}
+/**
+ * Creates an empty chart data object with all the values set to 0
+ * @param seriesList The list of series names (identifiers) to update
+ * @param currentTime=0] The current time
+ * @return An empty chart data object
+ */
+function initialChartData(seriesList, currentTime = 0) {
+    const maxTime = seriesList.reduce((tMax, series) => Math.max(tMax, series.last().map(datum => datum.time).getOrElse(-Infinity)), -Infinity);
+    return {
+        seriesNames: new Set(seriesList.map(series => series.name)),
+        maxTime,
+        maxTimes: new Map(seriesList.map(series => [series.name, series.last().map(datum => datum.time).getOrElse(0)])),
+        newPoints: new Map(seriesList.map(series => [
+            series.name,
+            [{
+                    time: series.last().map(datum => datum.time).getOrElse(0),
+                    value: series.last().map(datum => datum.value).getOrElse(0)
+                }]
+        ])),
+        currentTime: currentTime
+    };
+}
+/**
+ * Creates random set of time-series data, essentially creating a random walk for each series
+ * @param series The number of time-series for which to generate data (i.e. one for each neuron)
+ * @param numPoints The number of points to generate
+ * @param [updatePeriod=25] The time-interval between the generation of subsequent data points
+ * @return An observable that produces data.
+ */
+function sineDataObservable(series, numPoints = 10, updatePeriod = 25) {
+    const seriesNames = series.map(series => series.name);
+    const initialData = initialChartData(series);
+    return range(0, numPoints).pipe(
+    // convert the number sequence to a time
+    map(sequence => sequence * updatePeriod), 
+    // create a new (time, value) for each series
+    map(time => {
+        if (time <= initialData.maxTime) {
+            return initialData;
+        }
+        return sineData(time, numPoints * updatePeriod, seriesNames, initialData.maxTimes);
+    }));
+}
+//# sourceMappingURL=ordinals.test.js.map

package/dist/src/app/charts/observables/ordinals.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ordinals.test.js","sourceRoot":"","sources":["../../../../../src/app/charts/observables/ordinals.test.ts"],"names":[],"mappings":"AACA,OAAO,EAAQ,OAAO,EAAa,MAAM,sBAAsB,CAAC;AAChE,OAAO,EAAC,UAAU,EAAC,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAa,KAAK,EAAC,MAAM,MAAM,CAAC;AACvC,OAAO,EAAC,GAAG,EAAC,MAAM,gBAAgB,CAAC;AACnC,OAAO,EAAmB,kBAAkB,EAAC,MAAM,YAAY,CAAC;AAEhE,MAAM,UAAU,KAAK,CAAC,CAAS,EAAE,MAAc;IAC3C,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,CAAA;AAC7C,CAAC;AAED,QAAQ,CAAC,gCAAgC,EAAE,GAAG,EAAE;IAC5C,MAAM,UAAU,GAAG,EAAE,CAAA;IACrB,MAAM,aAAa,GAAG,EAAE,CAAA;IACxB,MAAM,UAAU,GAA4B,CAAC,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAA;IAE1H,MAAM,WAAW,GAAsB,UAAU;SAC5C,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;IAE7E,IAAI,CAAC,qCAAqC,EAAE,IAAI,CAAC,EAAE;QAC/C,IAAI,OAAO,GAA4B,EAAE,CAAA;QACzC,kBAAkB,CACd,kBAAkB,CAAC,WAAW,EAAE,UAAU,EAAE,aAAa,CAAC,CAC7D,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAA;QAEjD,8BAA8B;QAC9B,IAAI,EAAE,CAAA;QAEN,MAAM,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC,UAAU,CAAC,CAAA;QAExC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE;YAClC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,EAAE,YAAY,CAAC,EAAE,KAAK,EAAE,EAAE;gBACjF,MAAM,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;gBAEhD,0DAA0D;gBAC1D,MAAM,CAAC,YAAY,CAAC,CAAC,WAAW,EAAE,CAAA;gBAClC,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;gBACnC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,KAAK,GAAE,SAAS,GAAG,aAAa,CAAC,CAAA;gBAEtE,sCAAsC;gBACtC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAA;gBACpD,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,CAAA;YAC5D,CAAC,CAAC,CAAA;YAEF,qFAAqF;YACrF,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;YAC/C,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,SAAS,GAAG,aAAa,CAAC,CAAA;QAC/E,CAAC,CAAC,CAAA;IAEN,CAAC,CAAC,CAAA;AAEN,CAAC,CAAC,CAAA;AAEF;;;;;;;GAOG;AACH,SAAS,QAAQ,CACb,YAAoB,EACpB,OAAe,EACf,MAAqB,EACrB,cAAmC;IAEnC,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,IAAI,CAC/B,cAAc,CAAC,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,OAAO,GAAG,YAAY,CAAC,CAAC,CACrF,CAAA;IACD,OAAO;QACH,WAAW,EAAE,IAAI,GAAG,CAAC,MAAM,CAAC;QAC5B,OAAO,EAAE,YAAY;QACrB,QAAQ;QACR,SAAS,EAAE,IAAI,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;YAC1C,MAAM,IAAI,GAAG,YAAY,GAAG,KAAK,CAAA;YACjC,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,EAAE,OAAO,GAAG,KAAK,CAAC,CAAA;YAC1C,OAAO,CAAC,IAAI,EAAE,CAAC,EAAC,IAAI,EAAE,KAAK,EAAC,CAAC,CAAC,CAAA;QAClC,CAAC,CAAC,CAAC;KACN,CAAC;AACN,CAAC;AAED;;;;;GAKG;AACH,SAAS,gBAAgB,CAAC,UAA6B,EAAE,cAAsB,CAAC;IAC5E,MAAM,OAAO,GAAG,UAAU,CAAC,MAAM,CAC7B,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,CAAC,EAC7F,CAAC,QAAQ,CACZ,CAAA;IACD,OAAO;QACH,WAAW,EAAE,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC3D,OAAO;QACP,QAAQ,EAAE,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/G,SAAS,EAAE,IAAI,GAAG,CAAuB,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;YAC9D,MAAM,CAAC,IAAI;YACX,CAAC;oBACG,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;oBACzD,KAAK,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;iBAC9D,CAAC;SACL,CAAC,CAAC;QACH,WAAW,EAAE,WAAW;KAC3B,CAAA;AACL,CAAC;AAED;;;;;;GAMG;AACH,SAAS,kBAAkB,CACvB,MAAyB,EACzB,YAAoB,EAAE,EACtB,eAAuB,EAAE;IAEzB,MAAM,WAAW,GAAG,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IACrD,MAAM,WAAW,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAA;IAC5C,OAAO,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,IAAI;IAC3B,wCAAwC;IACxC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,GAAG,YAAY,CAAC;IAExC,6CAA6C;IAC7C,GAAG,CAAC,IAAI,CAAC,EAAE;QACP,IAAI,IAAI,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC;YAC9B,OAAO,WAAW,CAAA;QACtB,CAAC;QACD,OAAO,QAAQ,CAAC,IAAI,EAAE,SAAS,GAAG,YAAY,EAAE,WAAW,EAAE,WAAW,CAAC,QAAQ,CAAC,CAAA;IACtF,CAAC,CAAC,CACL,CAAA;AACL,CAAC"}

package/dist/src/app/charts/plots/BarPlot.d.ts

@@ -0,0 +1,81 @@
+import { AxesAssignment } from "./plot";
+import { BarSeriesStyle } from "../styling/barPlotStyle";
+export type BarChartElementId = {
+    readonly currentValue: string;
+    readonly meanValue: string;
+    readonly minMax: string;
+    readonly windowedMeanValue: string;
+    readonly windowedMinMax: string;
+};
+export declare const BAR_CHART_TOOLTIP_PROVIDER_IDS: BarChartElementId;
+interface Props {
+    /**
+     * Holds the mapping between a series and the axis it uses (is assigned). The
+     * map's key holds the series name, and the value is an {@link AxesAssignment}
+     * object holding the ID of the assigned x-axis and y-axis.
+     */
+    axisAssignments?: Map<string, AxesAssignment>;
+    showMinMaxBars?: boolean;
+    showWindowedMinMaxBars?: boolean;
+    showValueLines?: boolean;
+    showMeanValueLines?: boolean;
+    showWindowedMeanValueLines?: boolean;
+    /**
+     * The number of milliseconds worth of data to hold in memory before dropping it. Defaults to
+     * infinity (i.e. no data is dropped)
+     */
+    dropDataAfter?: number;
+    /**
+     * Enables panning (default is false)
+     */
+    panEnabled?: boolean;
+    /**
+     * Enables zooming (default is false)
+     */
+    zoomEnabled?: boolean;
+    /**
+     * When true, requires that the shift or control key be pressed while scrolling
+     * in order to activate the zoom
+     */
+    zoomKeyModifiersRequired?: boolean;
+    /**
+     * The (optional, default = 2 pixels) top and bottom margin (in pixels) for the spike lines in the plot.
+     * Margins on individual series can also be set through the {@link Chart.seriesStyles} property.
+     */
+    barMargin?: number;
+    /**
+     * The (optional) default style for the bar series that are used if no other styles are specified
+     */
+    barSeriesStyle?: BarSeriesStyle;
+}
+/**
+ * Renders a streaming bar plot for the series in the initial data and those sourced by the
+ * observable specified as a property in the {@link Chart}. This component uses the {@link useChart}
+ * hook, and therefore must be a child of the {@link Chart} to be plugged in to the
+ * chart ecosystem (axes, tracker, tooltip).
+ *
+ * For a relatively complete example of how to use this plot component, see the
+ * <a href="https://github.com/robphilipp/stream-charts-examples">`StreamingBarChart` example</a>
+ *
+ * @param props The properties associated with the bar plot
+ * @constructor
+ * @example
+ * ```typescript
+ * <BarPlot
+ *     barMargin={1}
+ *     dropDataAfter={5000}
+ *     // panEnabled={true}
+ *     // zoomEnabled={true}
+ *     // zoomKeyModifiersRequired={true}
+ *     // withCadenceOf={50}
+ *
+ *     showMinMaxBars={showMinMax}
+ *     showValueLines={showValue}
+ *     showMeanValueLines={showMean}
+ *     showWindowedMinMaxBars={showWinMinMax}
+ *     showWindowedMeanValueLines={showWinMean}
+ * />
+ * ```
+ */
+export declare function BarPlot(props: Props): null;
+export {};