stream-charts 1.2.0 → 2.0.0

package/dist/app/charts/hooks/useAxes.js

@@ -1,184 +1,24 @@
-import { jsx as _jsx } from "react/jsx-runtime";
-import { AxesState } from "../axes/AxesState";
-import { createContext, useContext, useRef } from "react";
-import { usePlotDimensions } from "./usePlotDimensions";
-import { Optional } from "result-fn";
+import { createContext, useContext } from "react";
+// the context is generic over the same type parameters as `UseAxesValues`, but a context
+// object can't itself carry unbound generics -- `useAxes` below casts it back to the caller's
+// concrete types, which is safe because `<AxesProvider/>` is what actually supplies the value
+//
+// IMPORTANT: as with `ChartContext` (see its identical note in useChart.tsx), this is NOT
+// statically enforced across the component tree -- each consumer casts to its own hardcoded
+// AR/A, independent of whatever `<AxesProvider<AR, A>>` ancestor actually supplied. A mismatched
+// axis-range/axis kind only fails at runtime, not at compile time.
+export const AxesContext = createContext(undefined);
 /**
- * No operation function for use when a default function is needed
- */
-const noop = () => {
-    /* empty on purpose */
-};
-export const defaultAxesValues = () => ({
-    xAxesState: AxesState.empty(),
-    yAxesState: AxesState.empty(),
-    addXAxis: noop,
-    addYAxis: noop,
-    setAxisAssignments: noop,
-    axisAssignmentsFor: () => ({ xAxis: "", yAxis: "" }),
-    updateAxisRanges: noop,
-    axesRanges: () => new Map(),
-    axisRangeFor: () => Optional.empty(),
-    setAxesRanges: noop,
-    setAxisRangeFor: noop,
-    setAxisIntervalFor: noop,
-    setOriginalAxisIntervalFor: noop,
-    resetAxisIntervalFor: noop,
-    resetAxesRanges: noop,
-    addAxesRangesUpdateHandler: () => noop,
-    removeAxesRangesUpdateHandler: () => noop,
-});
-// the context for axes
-const AxesContext = createContext(defaultAxesValues());
-/**
- * The React context provider for the {@link UseAxesValues}
- * @param props The properties
- * @return The children wrapped in this provider
- */
-export default function AxesProvider(props) {
-    const { onUpdateAxesInterval, children } = props;
-    const plotDimensions = usePlotDimensions();
-    const xAxesStateRef = useRef(AxesState.empty());
-    const yAxesStateRef = useRef(AxesState.empty());
-    const axisAssignmentsRef = useRef(new Map());
-    const axesBoundsUpdateHandlersRef = useRef(new Map());
-    const axesRangeRef = useRef(new Map());
-    /**
-     * Retrieves the x-axis and y-axis assignments for the specified series. If the axis does not have
-     * an assignment, then we assume it is using the default x- and y-axes.
-     * @param seriesName The name of the series for which to retrieve the axes assignments
-     * @return An {@link AxesAssignment} for the specified axes.
-     */
-    function axisAssignmentsFor(seriesName) {
-        return axisAssignmentsRef.current.get(seriesName) || {
-            xAxis: xAxesStateRef.current.axisDefaultId().getOrElse(""),
-            yAxis: yAxesStateRef.current.axisDefaultId().getOrElse("")
-        };
-    }
-    /**
-     * Called when the domain/range is updated on one or more of the chart's axes (generally x-axes). In turn,
-     * dispatches the update to all the internal domain/range update handlers.
-     * @param updates A map holding the axis ID to the updated axis time-range (i.e., map(axis_id, axis_time_range))
-     */
-    function updateAxisRanges(updates) {
-        // update the current time-ranges reference
-        updates.forEach((range, id) => {
-            axesRangeRef.current.set(id, range);
-        });
-        // dispatch the updates to all the registered handlers
-        axesBoundsUpdateHandlersRef.current
-            .forEach((handler) => handler(updates, plotDimensions.plotDimensions));
-    }
-    /**
-     * Sets the axis ranges specified in the input map
-     * @param ranges The ranges to set
-     */
-    function setAxesRanges(ranges) {
-        ranges.forEach((range, id) => {
-            axesRangeRef.current.set(id, range);
-        });
-    }
-    /**
-     * Sets the axis range for the specified axis ID
-     * @param axisId The axis ID
-     * @param range The range to set
-     */
-    function setAxisRangeFor(axisId, range) {
-        axesRangeRef.current.set(axisId, range);
-    }
-    /**
-     * Sets the axis bounds for the specified axis ID. Note that this does not
-     * change the original axis interval
-     * @param axisId The axis ID
-     * @param interval The interval
-     */
-    function setAxisIntervalFor(axisId, interval) {
-        Optional.ofNullable(axesRangeRef.current.get(axisId))
-            .map(range => range.update(interval.start, interval.end))
-            .ifPresent(updatedRange => axesRangeRef.current.set(axisId, updatedRange));
-    }
-    /**
-     * Sets the original axis interval for the axis range
-     * @param axisId The axis ID
-     * @param interval The interval to which to set the origin interval
-     */
-    function setOriginalAxisIntervalFor(axisId, interval) {
-        Optional.ofNullable(axesRangeRef.current.get(axisId))
-            .map(range => range.updateOriginal(interval.start, interval.end))
-            .ifPresent(updatedRange => axesRangeRef.current.set(axisId, updatedRange));
-    }
-    /**
-     * Resets the bounds for the specified axis to the original range
-     * @param axisId The ID of the axis
-     */
-    function resetAxisIntervalFor(axisId) {
-        Optional
-            .ofNullable(axesRangeRef.current.get(axisId))
-            .map(range => new Map([[axisId, range]]))
-            .ifPresent(updates => updateAxisRanges(updates));
-    }
-    /**
-     * Resets the bounds of all the axes to their original value or to the values specified
-     * in the optional bounds map.
-     * @param [axesRanges=new Map()] An optional map holds bounds for specified axes. The map
-     * associates an axis ID with the new bounds.
-     */
-    function resetAxesRanges(axesRanges = new Map()) {
-        updateAxisRanges(axesRanges);
-    }
-    /**
-     * Adds a handler to deal with updates to the bounds of the axes
-     * @param handlerId the unique ID of the handler
-     * @param handler The handler function that accepts a map of updates and a plot dimension
-     * @return A map with all the handlers
-     */
-    function addAxesRangesUpdateHandler(handlerId, handler) {
-        if (axesBoundsUpdateHandlersRef.current.has(handlerId)) {
-            throw new Error(`Handler with ID already exists, please remove it before adding it; ` +
-                `handler_id: ${handlerId}; ` +
-                `existing_handler_ids: [${Array.from(axesBoundsUpdateHandlersRef.current.keys()).join(", ")}]`);
-        }
-        return axesBoundsUpdateHandlersRef.current.set(handlerId, handler);
-    }
-    return _jsx(AxesContext.Provider, { value: {
-            xAxesState: xAxesStateRef.current,
-            yAxesState: yAxesStateRef.current,
-            addXAxis: (axis, id, range) => {
-                xAxesStateRef.current = xAxesStateRef.current.addAxis(axis, id);
-                if (range !== undefined) {
-                    axesRangeRef.current.set(id, range);
-                }
-            },
-            addYAxis: (axis, id, range) => {
-                yAxesStateRef.current = yAxesStateRef.current.addAxis(axis, id);
-                if (range !== undefined) {
-                    axesRangeRef.current.set(id, range);
-                }
-            },
-            setAxisAssignments: assignments => axisAssignmentsRef.current = assignments,
-            axisAssignmentsFor: seriesName => axisAssignmentsFor(seriesName),
-            updateAxisRanges,
-            axesRanges: () => new Map(axesRangeRef.current),
-            axisRangeFor: axisId => Optional.ofNullable(axesRangeRef.current.get(axisId)),
-            setAxesRanges,
-            setAxisRangeFor,
-            setAxisIntervalFor,
-            setOriginalAxisIntervalFor,
-            resetAxesRanges,
-            resetAxisIntervalFor,
-            onUpdateAxesInterval,
-            addAxesRangesUpdateHandler,
-            removeAxesRangesUpdateHandler: handlerId => axesBoundsUpdateHandlersRef.current.delete(handlerId),
-        }, children: children });
-}
-/**
- * React hook that sets up the React context for the chart values.
+ * React hook for the chart's axes: their state, ranges, and the functions for updating them.
+ * Must be used within an {@link AxesProvider} (i.e. within a `<Chart>`).
  * @return The {@link UseAxesValues} held in the React context.
+ * @throws Error when used outside an `<AxesProvider>`
+ * @template AR The type of the axis range (e.g. {@link ContinuousAxisRange} or {@link OrdinalAxisRange})
+ * @template A The axis type
  */
 export function useAxes() {
     const context = useContext(AxesContext);
-    const { xAxesState } = context;
-    if (xAxesState === undefined || xAxesState === null) {
+    if (context === undefined) {
         throw new Error("useAxes can only be used when the parent is a <AxesProvider/>");
     }
     return context;

package/dist/app/charts/hooks/useAxes.js.map

@@ -1 +1 @@
-{"version":3,"file":"useAxes.js","sourceRoot":"","sources":["../../../../src/app/charts/hooks/useAxes.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAC,SAAS,EAAC,MAAM,mBAAmB,CAAC;AAG5C,OAAO,EAAC,aAAa,EAAO,UAAU,EAAE,MAAM,EAAC,MAAM,OAAO,CAAC;AAE7D,OAAO,EAAC,iBAAiB,EAAC,MAAM,qBAAqB,CAAC;AAGtD,OAAO,EAAC,QAAQ,EAAC,MAAM,WAAW,CAAC;AAEnC;;GAEG;AACH,MAAM,IAAI,GAAG,GAAG,EAAE;IACd,sBAAsB;AAC1B,CAAC,CAAA;AAqHD,MAAM,CAAC,MAAM,iBAAiB,GAAG,GAA4B,EAAE,CAAC,CAAC;IAC7D,UAAU,EAAE,SAAS,CAAC,KAAK,EAAE;IAC7B,UAAU,EAAE,SAAS,CAAC,KAAK,EAAE;IAC7B,QAAQ,EAAE,IAAI;IACd,QAAQ,EAAE,IAAI;IACd,kBAAkB,EAAE,IAAI;IACxB,kBAAkB,EAAE,GAAG,EAAE,CAAC,CAAC,EAAC,KAAK,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAC,CAAC;IAClD,gBAAgB,EAAE,IAAI;IACtB,UAAU,EAAE,GAAG,EAAE,CAAC,IAAI,GAAG,EAAe;IACxC,YAAY,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,KAAK,EAAE;IACpC,aAAa,EAAE,IAAI;IACnB,eAAe,EAAE,IAAI;IACrB,kBAAkB,EAAE,IAAI;IACxB,0BAA0B,EAAE,IAAI;IAChC,oBAAoB,EAAE,IAAI;IAC1B,eAAe,EAAE,IAAI;IACrB,0BAA0B,EAAE,GAAG,EAAE,CAAC,IAAI;IACtC,6BAA6B,EAAE,GAAG,EAAE,CAAC,IAAI;CAC5C,CAAC,CAAA;AAEF,uBAAuB;AACvB,MAAM,WAAW,GAAG,aAAa,CAA0B,iBAAiB,EAAE,CAAC,CAAA;AAY/E;;;;GAIG;AACH,MAAM,CAAC,OAAO,UAAU,YAAY,CAA+C,KAAY;IAC3F,MAAM,EAAC,oBAAoB,EAAE,QAAQ,EAAC,GAAG,KAAK,CAAA;IAE9C,MAAM,cAAc,GAAG,iBAAiB,EAAE,CAAA;IAE1C,MAAM,aAAa,GAAG,MAAM,CAAe,SAAS,CAAC,KAAK,EAAK,CAAC,CAAA;IAChE,MAAM,aAAa,GAAG,MAAM,CAAe,SAAS,CAAC,KAAK,EAAK,CAAC,CAAA;IAChE,MAAM,kBAAkB,GAAG,MAAM,CAA8B,IAAI,GAAG,EAAE,CAAC,CAAA;IACzE,MAAM,2BAA2B,GAAG,MAAM,CAAuE,IAAI,GAAG,EAAE,CAAC,CAAA;IAC3H,MAAM,YAAY,GAAG,MAAM,CAAkB,IAAI,GAAG,EAAE,CAAC,CAAA;IAEvD;;;;;OAKG;IACH,SAAS,kBAAkB,CAAC,UAAkB;QAC1C,OAAO,kBAAkB,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI;YACjD,KAAK,EAAE,aAAa,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC;YAC1D,KAAK,EAAE,aAAa,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC;SAC7D,CAAA;IACL,CAAC;IAED;;;;OAIG;IACH,SAAS,gBAAgB,CAAC,OAAwB;QAC9C,2CAA2C;QAC3C,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,EAAE,EAAE;YAC1B,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,EAAE,KAAK,CAAC,CAAA;QACvC,CAAC,CAAC,CAAA;QACF,sDAAsD;QACtD,2BAA2B,CAAC,OAAO;aAC9B,OAAO,CAAC,CAAC,OAAO,EAAI,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,cAAc,CAAC,cAAc,CAAC,CAAC,CAAA;IAChF,CAAC;IAED;;;OAGG;IACH,SAAS,aAAa,CAAC,MAAuB;QAC1C,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,EAAE,EAAE;YACzB,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,EAAE,KAAK,CAAC,CAAA;QACvC,CAAC,CAAC,CAAA;IACN,CAAC;IAED;;;;OAIG;IACH,SAAS,eAAe,CAAC,MAAc,EAAE,KAAS;QAC9C,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;IAC3C,CAAC;IAED;;;;;OAKG;IACH,SAAS,kBAAkB,CAAC,MAAc,EAAE,QAAsB;QAC9D,QAAQ,CAAC,UAAU,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;aAChD,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,CAAO,CAAC;aAC9D,SAAS,CAAC,YAAY,CAAC,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAA;IAClF,CAAC;IAED;;;;OAIG;IACH,SAAS,0BAA0B,CAAC,MAAc,EAAE,QAAsB;QACtE,QAAQ,CAAC,UAAU,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;aAChD,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,cAAc,CAAC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,CAAO,CAAC;aACtE,SAAS,CAAC,YAAY,CAAC,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAA;IAClF,CAAC;IAED;;;OAGG;IACH,SAAS,oBAAoB,CAAC,MAAc;QACxC,QAAQ;aACH,UAAU,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;aAC5C,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,GAAG,CAAa,CAAC,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;aACpD,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAA;IACxD,CAAC;IAED;;;;;OAKG;IACH,SAAS,eAAe,CAAC,aAA8B,IAAI,GAAG,EAAE;QAC5D,gBAAgB,CAAC,UAAU,CAAC,CAAA;IAChC,CAAC;IAED;;;;;OAKG;IACH,SAAS,0BAA0B,CAC/B,SAAiB,EACjB,OAAgE;QAEhE,IAAI,2BAA2B,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;YACrD,MAAM,IAAI,KAAK,CACX,qEAAqE;gBACrE,eAAe,SAAS,IAAI;gBAC5B,0BAA0B,KAAK,CAAC,IAAI,CAAC,2BAA2B,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CACjG,CAAA;QACL,CAAC;QACH,OAAO,2BAA2B,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,CAAA;IACpE,CAAC;IAED,OAAO,KAAC,WAAW,CAAC,QAAQ,IACxB,KAAK,EAAE;YACH,UAAU,EAAE,aAAa,CAAC,OAAO;YACjC,UAAU,EAAE,aAAa,CAAC,OAAO;YACjC,QAAQ,EAAE,CAAC,IAAI,EAAE,EAAE,EAAE,KAAS,EAAE,EAAE;gBAC9B,aAAa,CAAC,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAA;gBAC/D,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;oBACtB,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,EAAE,KAAK,CAAC,CAAA;gBACvC,CAAC;YACL,CAAC;YACD,QAAQ,EAAE,CAAC,IAAI,EAAE,EAAE,EAAE,KAAS,EAAE,EAAE;gBAC9B,aAAa,CAAC,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAA;gBAC/D,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;oBACtB,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,EAAE,KAAK,CAAC,CAAA;gBACvC,CAAC;YACL,CAAC;YACD,kBAAkB,EAAE,WAAW,CAAC,EAAE,CAAC,kBAAkB,CAAC,OAAO,GAAG,WAAW;YAC3E,kBAAkB,EAAE,UAAU,CAAC,EAAE,CAAC,kBAAkB,CAAC,UAAU,CAAC;YAChE,gBAAgB;YAChB,UAAU,EAAE,GAAG,EAAE,CAAC,IAAI,GAAG,CAAa,YAAY,CAAC,OAAO,CAAC;YAC3D,YAAY,EAAE,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YAC7E,aAAa;YACb,eAAe;YACf,kBAAkB;YAClB,0BAA0B;YAC1B,eAAe;YACf,oBAAoB;YACpB,oBAAoB;YACpB,0BAA0B;YAC1B,6BAA6B,EAAE,SAAS,CAAC,EAAE,CAAC,2BAA2B,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC;SACpG,YAEA,QAAQ,GACU,CAAA;AAC3B,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,OAAO;IACnB,MAAM,OAAO,GAAG,UAAU,CAAuB,WAAW,CAAC,CAAA;IAC7D,MAAM,EAAC,UAAU,EAAC,GAAG,OAAO,CAAA;IAC5B,IAAI,UAAU,KAAK,SAAS,IAAI,UAAU,KAAK,IAAI,EAAE,CAAC;QAClD,MAAM,IAAI,KAAK,CAAC,+DAA+D,CAAC,CAAA;IACpF,CAAC;IACD,OAAO,OAAO,CAAA;AAClB,CAAC"}
+{"version":3,"file":"useAxes.js","sourceRoot":"","sources":["../../../../src/app/charts/hooks/useAxes.tsx"],"names":[],"mappings":"AAGA,OAAO,EAAC,aAAa,EAAE,UAAU,EAAC,MAAM,OAAO,CAAC;AAgJhD,yFAAyF;AACzF,8FAA8F;AAC9F,8FAA8F;AAC9F,EAAE;AACF,0FAA0F;AAC1F,4FAA4F;AAC5F,iGAAiG;AACjG,mEAAmE;AACnE,MAAM,CAAC,MAAM,WAAW,GAAG,aAAa,CAAU,SAAS,CAAC,CAAA;AAE5D;;;;;;;GAOG;AACH,MAAM,UAAU,OAAO;IACnB,MAAM,OAAO,GAAG,UAAU,CAAC,WAAW,CAAC,CAAA;IACvC,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QACxB,MAAM,IAAI,KAAK,CAAC,+DAA+D,CAAC,CAAA;IACpF,CAAC;IACD,OAAO,OAA+B,CAAA;AAC1C,CAAC"}

package/dist/app/charts/hooks/useCanvasSurface.d.ts

@@ -0,0 +1,25 @@
+import type { CanvasContext } from "../d3types";
+/**
+ * The values exposed through the {@link useCanvasSurface} react hook.
+ */
+export type UseCanvasSurfaceValues = {
+    /**
+     * The `<canvas>` element backing the chart.
+     */
+    canvas: HTMLCanvasElement | null;
+    /**
+     * The canvas drawing context and redraw-registration API for the chart.
+     */
+    canvasContext: CanvasContext | null;
+};
+export declare const CanvasSurfaceContext: import("react").Context<UseCanvasSurfaceValues>;
+/**
+ * React hook that reads the canvas element and canvas drawing context from context. This is set
+ * up by {@link CanvasSurfaceProvider}, which sizes the canvas from {@link usePlotDimensions} (the
+ * single source of truth for the chart's dimensions) rather than from static width/height props,
+ * so that the canvas stays correctly sized even if dimensions change via
+ * `usePlotDimensions().updateDimensions(...)` independent of any prop.
+ * @return The {@link UseCanvasSurfaceValues} held in the React context.
+ */
+export declare function useCanvasSurface(): UseCanvasSurfaceValues;
+//# sourceMappingURL=useCanvasSurface.d.ts.map

package/dist/app/charts/hooks/useCanvasSurface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useCanvasSurface.d.ts","sourceRoot":"","sources":["../../../../src/app/charts/hooks/useCanvasSurface.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,YAAY,CAAC;AAE9C;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACjC;;OAEG;IACH,MAAM,EAAE,iBAAiB,GAAG,IAAI,CAAA;IAChC;;OAEG;IACH,aAAa,EAAE,aAAa,GAAG,IAAI,CAAA;CACtC,CAAA;AAOD,eAAO,MAAM,oBAAoB,iDAAoE,CAAA;AAErG;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,IAAI,sBAAsB,CAEzD"}

package/dist/app/charts/hooks/useCanvasSurface.js

@@ -0,0 +1,18 @@
+import { createContext, useContext } from "react";
+const defaultCanvasSurfaceValues = {
+    canvas: null,
+    canvasContext: null,
+};
+export const CanvasSurfaceContext = createContext(defaultCanvasSurfaceValues);
+/**
+ * React hook that reads the canvas element and canvas drawing context from context. This is set
+ * up by {@link CanvasSurfaceProvider}, which sizes the canvas from {@link usePlotDimensions} (the
+ * single source of truth for the chart's dimensions) rather than from static width/height props,
+ * so that the canvas stays correctly sized even if dimensions change via
+ * `usePlotDimensions().updateDimensions(...)` independent of any prop.
+ * @return The {@link UseCanvasSurfaceValues} held in the React context.
+ */
+export function useCanvasSurface() {
+    return useContext(CanvasSurfaceContext);
+}
+//# sourceMappingURL=useCanvasSurface.js.map

package/dist/app/charts/hooks/useCanvasSurface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useCanvasSurface.js","sourceRoot":"","sources":["../../../../src/app/charts/hooks/useCanvasSurface.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAE,UAAU,EAAC,MAAM,OAAO,CAAC;AAiBhD,MAAM,0BAA0B,GAA2B;IACvD,MAAM,EAAE,IAAI;IACZ,aAAa,EAAE,IAAI;CACtB,CAAA;AAED,MAAM,CAAC,MAAM,oBAAoB,GAAG,aAAa,CAAyB,0BAA0B,CAAC,CAAA;AAErG;;;;;;;GAOG;AACH,MAAM,UAAU,gBAAgB;IAC5B,OAAO,UAAU,CAAC,oBAAoB,CAAC,CAAA;AAC3C,CAAC"}

package/dist/app/charts/hooks/useChart.d.ts

@@ -1,20 +1,20 @@
-import { JSX, MutableRefObject } from "react";
-import { GSelection } from "../d3types";
-import { BaseAxis, SeriesLineStyle, SeriesStyle } from "../axes/axes";
-import { UseAxesValues } from "./useAxes";
-import { UseMouseValues } from "./useMouse";
-import { UseTooltipValues } from "./useTooltip";
-import { SvgStyle } from "../styling/svgStyle";
+import type { CanvasContext } from "../d3types";
+import type { BaseAxis, SeriesStyle } from "../axes/axes";
+import { type UseAxesValues } from "./useAxes";
+import { type UseMouseValues } from "./useMouse";
+import { type UseTooltipValues } from "./useTooltip";
 import { BaseAxisRange } from "../axes/BaseAxisRange";
-export type NoTooltipMetadata = {};
+export type NoTooltipMetadata = object;
 /**
  * The values exposed through the {@link useChart} react hook
  * @param chartId The unique ID for the chart
- * @param mainG The root <g> element for the chart
- * @param container The SVG element which is the container for this chart
+ * @param canvasContext The canvas drawing context and redraw-registration API for the chart
+ * @param canvas The `<canvas>` element which is the container for this chart
  * @template D The type of the series' datum
  * @template S The type of the series style
  * @template TM The type of the tooltip's metadata (data about the series data)
+ * @template AR The type of the axis range
+ * @template A The type of the axis
  */
 export interface UseChartValues<D, S extends SeriesStyle, TM, AR extends BaseAxisRange, A extends BaseAxis> {
     /**
@@ -22,62 +22,48 @@ export interface UseChartValues<D, S extends SeriesStyle, TM, AR extends BaseAxi
      */
     chartId: number;
     /**
-     * The root <g> element for the chart
+     * The canvas drawing context and redraw-registration API for the chart. Axes, plots, and the
+     * tracker register a draw function here (via `canvasContext.register(id, drawFn, zIndex)`)
+     * instead of creating/updating SVG elements. Replaces the old `mainG`.
      */
-    mainG: GSelection | null;
+    canvasContext: CanvasContext | null;
     /**
-     * The SVG element which is the container for this chart
+     * The `<canvas>` element which is the container for this chart. Replaces the old `container`
+     * (root `<svg>` element).
      */
-    container: SVGSVGElement | null;
+    canvas: HTMLCanvasElement | null;
     /**
      * Base color
      */
     color: string;
     /**
-     * The base/default background color. This can be overridden by the {@link Props.svgStyle} property.
+     * The base/default background color. This can be overridden by the {@link ChartProps.svgStyle} property.
      */
     backgroundColor: string;
-    /**
-     * Overrides for the SVG style
-     */
-    svgStyle: Partial<SvgStyle>;
     /**
      * A `map(series_name -> series_line_style)`
      */
     seriesStyles: Map<string, S>;
     axes: UseAxesValues<AR, A>;
     /**
-     * A regular expression uses against the series names to determine which series to show in the chart
+     * A regular expression used against the series names to determine which series to show in the chart
      */
     seriesFilter: RegExp;
     mouse: UseMouseValues<D, TM>;
     tooltip: UseTooltipValues<D, TM>;
-    /**
-     * Ref tracking the currently-hovered series name (null when nothing is hovered).
-     * Updated by the Legend; read by plots so new path elements use the correct stroke.
-     */
-    hoveredSeriesRef: MutableRefObject<string | null>;
 }
-export interface Props {
-    chartId: number;
-    container: SVGSVGElement | null;
-    mainG: GSelection | null;
-    color: string;
-    backgroundColor: string;
-    svgStyle: Partial<SvgStyle>;
-    seriesStyles?: Map<string, SeriesLineStyle>;
-    seriesFilter?: RegExp;
-    hoveredSeriesRef: MutableRefObject<string | null>;
-    children: JSX.Element | Array<JSX.Element>;
-}
-/**
- * The React context provider for the {@link UseChartValues}
- * @param props The properties
- * @return The children wrapped in this provider
- */
-export default function ChartProvider(props: Props): JSX.Element;
+export declare const ChartContext: import("react").Context<unknown>;
 /**
- * React hook that sets up the React context for the chart values.
+ * React hook for the chart's values: its ID, canvas, colors, styles, axes, mouse and tooltip
+ * handlers, and highlighted series. Must be used within a `ChartProvider` (i.e. within a
+ * `<Chart>`).
  * @return The {@link UseChartValues} held in the React context.
+ * @throws Error when used outside a `<ChartProvider>`
+ * @template D The type of the series' datum
+ * @template S The type of the series style
+ * @template TM The type of the tooltip's metadata (data about the series data)
+ * @template AR The type of the axis range
+ * @template A The type of the axis
  */
 export declare function useChart<D, S extends SeriesStyle, TM, AR extends BaseAxisRange, A extends BaseAxis>(): UseChartValues<D, S, TM, AR, A>;
+//# sourceMappingURL=useChart.d.ts.map

package/dist/app/charts/hooks/useChart.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useChart.d.ts","sourceRoot":"","sources":["../../../../src/app/charts/hooks/useChart.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,YAAY,CAAC;AAC9C,OAAO,KAAK,EAAC,QAAQ,EAAE,WAAW,EAAC,MAAM,cAAc,CAAC;AACxD,OAAO,EAAC,KAAK,aAAa,EAAC,MAAM,WAAW,CAAC;AAC7C,OAAO,EAAC,KAAK,cAAc,EAAC,MAAM,YAAY,CAAC;AAC/C,OAAO,EAAC,KAAK,gBAAgB,EAAC,MAAM,cAAc,CAAC;AACnD,OAAO,EAAC,aAAa,EAAC,MAAM,uBAAuB,CAAC;AAGpD,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAA;AAEtC;;;;;;;;;;GAUG;AACH,MAAM,WAAW,cAAc,CAAC,CAAC,EAAE,CAAC,SAAS,WAAW,EAAE,EAAE,EAAE,EAAE,SAAS,aAAa,EAAE,CAAC,SAAS,QAAQ;IACtG;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IACf;;;;OAIG;IACH,aAAa,EAAE,aAAa,GAAG,IAAI,CAAA;IACnC;;;OAGG;IACH,MAAM,EAAE,iBAAiB,GAAG,IAAI,CAAA;IAChC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,eAAe,EAAE,MAAM,CAAA;IACvB;;OAEG;IACH,YAAY,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,CAAA;IAK5B,IAAI,EAAE,aAAa,CAAC,EAAE,EAAE,CAAC,CAAC,CAAA;IAK1B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IAKpB,KAAK,EAAE,cAAc,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;IAC5B,OAAO,EAAE,gBAAgB,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;CACnC;AAiBD,eAAO,MAAM,YAAY,kCAAkD,CAAA;AAE3E;;;;;;;;;;;GAWG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,CAAC,SAAS,WAAW,EAAE,EAAE,EAAE,EAAE,SAAS,aAAa,EAAE,CAAC,SAAS,QAAQ,KAAK,cAAc,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,CAOtI"}

package/dist/app/charts/hooks/useChart.js

@@ -1,54 +1,32 @@
-import { jsx as _jsx } from "react/jsx-runtime";
 import { createContext, useContext } from "react";
-import { defaultAxesValues, useAxes } from "./useAxes";
-import { defaultMouseValues, useMouse } from "./useMouse";
-import { defaultTooltipValues, useTooltip } from "./useTooltip";
-const defaultUseChartValues = {
-    chartId: NaN,
-    container: null,
-    mainG: null,
-    color: '#d2933f',
-    backgroundColor: '#EEE',
-    svgStyle: new Map(),
-    seriesStyles: new Map(),
-    // axes
-    axes: defaultAxesValues(),
-    // data
-    seriesFilter: /./,
-    // internal chart-interaction event handlers
-    mouse: defaultMouseValues(),
-    tooltip: defaultTooltipValues(),
-    hoveredSeriesRef: { current: null },
-};
-const ChartContext = createContext(defaultUseChartValues);
+import { defaultUseChartValues } from "./defaultUseChartValues";
+// the context is generic over the same type parameters as `UseChartValues`, but a context
+// object can't itself carry unbound generics -- `useChart` below casts it back to the caller's
+// concrete types, which is safe because `<ChartProvider/>` is what actually supplies the value
+//
+// IMPORTANT: this is NOT statically enforced across the component tree. `<Chart<CD, D, S, TM, AR,
+// A>>`'s AR/A are never referenced by its own Props type, so they can't even be inferred from
+// JSX; and every descendant (each axis component) calls `useChart<...>()` with its OWN hardcoded
+// generic arguments, entirely independent of whatever the ancestor `<Chart<...>>` was
+// instantiated with. Nothing at the type level stops e.g. a `<Chart<..., ContinuousAxisRange,
+// ContinuousNumericAxis>>` from having an `<OrdinalAxis>` child that casts this same context to
+// `UseChartValues<..., OrdinalAxisRange, OrdinalStringAxis>` internally -- a real mismatch here
+// only fails at runtime (a bad cast surfacing as a confusing error deeper in axis/plot code), not
+// at compile time. Making this a real compile-time guarantee would need a per-instantiation-typed
+// context (e.g. a context factory called once per concrete AR/A pairing) -- a broader refactor
+// than the type parameters alone might suggest, and not something to casually "fix" locally.
+export const ChartContext = createContext(defaultUseChartValues());
 /**
- * The React context provider for the {@link UseChartValues}
- * @param props The properties
- * @return The children wrapped in this provider
- */
-export default function ChartProvider(props) {
-    const { chartId, container, mainG, color, backgroundColor, seriesFilter = defaultUseChartValues.seriesFilter, svgStyle, seriesStyles = new Map(), hoveredSeriesRef, } = props;
-    const axes = useAxes();
-    const mouse = useMouse();
-    const tooltip = useTooltip();
-    return _jsx(ChartContext.Provider, { value: {
-            chartId,
-            color,
-            backgroundColor,
-            svgStyle,
-            seriesStyles,
-            seriesFilter,
-            mainG,
-            container,
-            axes,
-            mouse,
-            tooltip,
-            hoveredSeriesRef,
-        }, children: props.children });
-}
-/**
- * React hook that sets up the React context for the chart values.
+ * React hook for the chart's values: its ID, canvas, colors, styles, axes, mouse and tooltip
+ * handlers, and highlighted series. Must be used within a `ChartProvider` (i.e. within a
+ * `<Chart>`).
  * @return The {@link UseChartValues} held in the React context.
+ * @throws Error when used outside a `<ChartProvider>`
+ * @template D The type of the series' datum
+ * @template S The type of the series style
+ * @template TM The type of the tooltip's metadata (data about the series data)
+ * @template AR The type of the axis range
+ * @template A The type of the axis
  */
 export function useChart() {
     const context = useContext(ChartContext);

package/dist/app/charts/hooks/useChart.js.map

@@ -1 +1 @@
-{"version":3,"file":"useChart.js","sourceRoot":"","sources":["../../../../src/app/charts/hooks/useChart.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAC,aAAa,EAAyB,UAAU,EAAC,MAAM,OAAO,CAAC;AAGvE,OAAO,EAAC,iBAAiB,EAAE,OAAO,EAAgB,MAAM,WAAW,CAAC;AACpE,OAAO,EAAC,kBAAkB,EAAE,QAAQ,EAAiB,MAAM,YAAY,CAAC;AACxE,OAAO,EAAC,oBAAoB,EAAE,UAAU,EAAmB,MAAM,cAAc,CAAC;AAsEhF,MAAM,qBAAqB,GAA4C;IACnE,OAAO,EAAE,GAAG;IACZ,SAAS,EAAE,IAAI;IACf,KAAK,EAAE,IAAI;IACX,KAAK,EAAE,SAAS;IAChB,eAAe,EAAE,MAAM;IACvB,QAAQ,EAAE,IAAI,GAAG,EAAE;IACnB,YAAY,EAAE,IAAI,GAAG,EAAE;IAEvB,OAAO;IACP,IAAI,EAAE,iBAAiB,EAAE;IAEzB,OAAO;IACP,YAAY,EAAE,GAAG;IAEjB,4CAA4C;IAC5C,KAAK,EAAE,kBAAkB,EAAE;IAC3B,OAAO,EAAE,oBAAoB,EAAE;IAC/B,gBAAgB,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE;CACtC,CAAA;AAED,MAAM,YAAY,GAAG,aAAa,CAA0C,qBAAqB,CAAC,CAAA;AAgBlG;;;;GAIG;AACH,MAAM,CAAC,OAAO,UAAU,aAAa,CAAC,KAAY;IAC9C,MAAM,EACF,OAAO,EACP,SAAS,EACT,KAAK,EACL,KAAK,EACL,eAAe,EACf,YAAY,GAAG,qBAAqB,CAAC,YAAY,EACjD,QAAQ,EACR,YAAY,GAAG,IAAI,GAAG,EAA2B,EACjD,gBAAgB,GACnB,GAAG,KAAK,CAAA;IAET,MAAM,IAAI,GAAG,OAAO,EAAE,CAAA;IACtB,MAAM,KAAK,GAAG,QAAQ,EAAE,CAAA;IACxB,MAAM,OAAO,GAAG,UAAU,EAAE,CAAA;IAE5B,OAAO,KAAC,YAAY,CAAC,QAAQ,IACzB,KAAK,EAAE;YACH,OAAO;YACP,KAAK;YACL,eAAe;YACf,QAAQ;YACR,YAAY;YACZ,YAAY;YACZ,KAAK;YACL,SAAS;YAET,IAAI;YACJ,KAAK;YACL,OAAO;YACP,gBAAgB;SACnB,YAEA,KAAK,CAAC,QAAQ,GACK,CAAA;AAC5B,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,QAAQ;IACpB,MAAM,OAAO,GAAG,UAAU,CAAkC,YAAY,CAAC,CAAA;IACzE,MAAM,EAAC,OAAO,EAAC,GAAG,OAAO,CAAA;IACzB,IAAI,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CAAC,iEAAiE,CAAC,CAAA;IACtF,CAAC;IACD,OAAO,OAAO,CAAA;AAClB,CAAC"}
+{"version":3,"file":"useChart.js","sourceRoot":"","sources":["../../../../src/app/charts/hooks/useChart.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAE,UAAU,EAAC,MAAM,OAAO,CAAC;AAOhD,OAAO,EAAC,qBAAqB,EAAC,MAAM,yBAAyB,CAAC;AAgE9D,0FAA0F;AAC1F,+FAA+F;AAC/F,+FAA+F;AAC/F,EAAE;AACF,kGAAkG;AAClG,8FAA8F;AAC9F,iGAAiG;AACjG,sFAAsF;AACtF,8FAA8F;AAC9F,gGAAgG;AAChG,gGAAgG;AAChG,kGAAkG;AAClG,kGAAkG;AAClG,+FAA+F;AAC/F,6FAA6F;AAC7F,MAAM,CAAC,MAAM,YAAY,GAAG,aAAa,CAAU,qBAAqB,EAAE,CAAC,CAAA;AAE3E;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,QAAQ;IACpB,MAAM,OAAO,GAAG,UAAU,CAAC,YAAY,CAAoC,CAAA;IAC3E,MAAM,EAAC,OAAO,EAAC,GAAG,OAAO,CAAA;IACzB,IAAI,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CAAC,iEAAiE,CAAC,CAAA;IACtF,CAAC;IACD,OAAO,OAAO,CAAA;AAClB,CAAC"}

package/dist/app/charts/hooks/useDataSource.d.ts

@@ -0,0 +1,68 @@
+import type { ChartData } from "../observables/ChartData";
+import type { BaseSeries } from "../series/baseSeries";
+import type { StreamingDataSource } from "../datasources/StreamingDataSource";
+/**
+ * The chart's data: its data source, the series the source held when it was handed to the chart,
+ * and the chart's streaming settings and callbacks
+ * @template CD The type of the chart data
+ * @template D The type of datum held in each series
+ * @template S The type of series
+ */
+export interface ChartDataValues<CD extends ChartData, D, S extends BaseSeries<D> = BaseSeries<D>> {
+    /**
+     * The data source handed to the chart (its `dataSource` prop)
+     */
+    dataSource: StreamingDataSource<CD, D, S>;
+    /**
+     * The series the data source held when it was handed to the chart (a new data source means
+     * new initial data, so plots keyed on it reset)
+     */
+    initialData: Array<S>;
+    /**
+     * The time (ms) over which incoming data is batched before the plot redraws
+     */
+    windowingTime: number;
+    /**
+     * The period (ms) at which the data source's generator emits new data, when known. When
+     * provided, batching switches from wall-clock-based to a fixed tick count derived from
+     * `windowingTime / dataUpdatePeriod` (see the view drivers in `subscriptions/viewDrivers.ts`).
+     */
+    dataUpdatePeriod?: number;
+    /**
+     * Called when the chart time is updated (e.g. by plots whose axes aren't time)
+     * @param time The new chart time
+     */
+    onUpdateChartTime: (time: number) => void;
+}
+export declare const ChartDataContext: import("react").Context<unknown>;
+/**
+ * @return The {@link StreamingDataSource} handed to the enclosing {@link Chart} through its
+ * `dataSource` prop (`undefined` only outside of a chart)
+ * @template CD The type of the chart data
+ * @template D The type of datum held in each series
+ * @template S The type of series
+ */
+export declare function useDataSource<CD extends ChartData, D, S extends BaseSeries<D> = BaseSeries<D>>(): StreamingDataSource<CD, D, S> | undefined;
+/**
+ * @return The series the chart's data source held when it was handed to the chart (for
+ * components that need the set of series up front, e.g. the legend, or a plot resetting itself
+ * for new data)
+ * @throws Error when used outside a `<Chart>`
+ * @template D The type of the datum held in each series
+ */
+export declare function useInitialData<D>(): {
+    initialData: Array<BaseSeries<D>>;
+};
+/**
+ * @return The chart's streaming settings (how updates are batched for rendering) and callbacks
+ * @throws Error when used outside a `<Chart>`
+ */
+export declare function useStreamingSettings(): Pick<ChartDataValues<ChartData, unknown>, 'windowingTime' | 'dataUpdatePeriod' | 'onUpdateChartTime'>;
+/**
+ * Subscribes the calling component to the data source's running state, so it re-renders when the
+ * source starts or stops (e.g. to switch the zoom pivot, or hide markers while running).
+ * @param dataSource The data source, or `undefined` (in which case this is always `false`)
+ * @return Whether the data source is currently running
+ */
+export declare function useDataSourceRunning<CD extends ChartData, D>(dataSource: StreamingDataSource<CD, D> | undefined): boolean;
+//# sourceMappingURL=useDataSource.d.ts.map

package/dist/app/charts/hooks/useDataSource.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useDataSource.d.ts","sourceRoot":"","sources":["../../../../src/app/charts/hooks/useDataSource.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,0BAA0B,CAAC;AACxD,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,sBAAsB,CAAC;AACrD,OAAO,KAAK,EAAC,mBAAmB,EAAC,MAAM,oCAAoC,CAAC;AAE5E;;;;;;GAMG;AACH,MAAM,WAAW,eAAe,CAAC,EAAE,SAAS,SAAS,EAAE,CAAC,EAAE,CAAC,SAAS,UAAU,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC;IAC7F;;OAEG;IACH,UAAU,EAAE,mBAAmB,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;IACzC;;;OAGG;IACH,WAAW,EAAE,KAAK,CAAC,CAAC,CAAC,CAAA;IACrB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IACrB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB;;;OAGG;IACH,iBAAiB,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAA;CAC5C;AAKD,eAAO,MAAM,gBAAgB,kCAAoC,CAAA;AAcjE;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,EAAE,SAAS,SAAS,EAAE,CAAC,EAAE,CAAC,SAAS,UAAU,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,KAAK,mBAAmB,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,SAAS,CAE3I;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,CAAC,KAAK;IAAC,WAAW,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAA;CAAC,CAGvE;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,IAAI,IAAI,CAAC,eAAe,CAAC,SAAS,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,kBAAkB,GAAG,mBAAmB,CAAC,CAG5I;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,EAAE,SAAS,SAAS,EAAE,CAAC,EAAE,UAAU,EAAE,mBAAmB,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,SAAS,GAAG,OAAO,CAWzH"}

package/dist/app/charts/hooks/useDataSource.js

@@ -0,0 +1,63 @@
+import { createContext, useCallback, useContext, useSyncExternalStore } from "react";
+// the context is generic over the same type parameters as `ChartDataValues`, but a context object
+// can't itself carry unbound generics -- the hooks below cast it back to the caller's concrete
+// types, which is safe because `<Chart/>` is what actually supplies the value
+export const ChartDataContext = createContext(undefined);
+/**
+ * @return The chart's data, and its streaming settings
+ * @throws Error when used outside a `<Chart>`
+ */
+function useChartData() {
+    const context = useContext(ChartDataContext);
+    if (context === undefined) {
+        throw new Error("The chart's data can only be used within a <Chart/>");
+    }
+    return context;
+}
+/**
+ * @return The {@link StreamingDataSource} handed to the enclosing {@link Chart} through its
+ * `dataSource` prop (`undefined` only outside of a chart)
+ * @template CD The type of the chart data
+ * @template D The type of datum held in each series
+ * @template S The type of series
+ */
+export function useDataSource() {
+    var _a;
+    return (_a = useContext(ChartDataContext)) === null || _a === void 0 ? void 0 : _a.dataSource;
+}
+/**
+ * @return The series the chart's data source held when it was handed to the chart (for
+ * components that need the set of series up front, e.g. the legend, or a plot resetting itself
+ * for new data)
+ * @throws Error when used outside a `<Chart>`
+ * @template D The type of the datum held in each series
+ */
+export function useInitialData() {
+    const { initialData } = useChartData();
+    return { initialData };
+}
+/**
+ * @return The chart's streaming settings (how updates are batched for rendering) and callbacks
+ * @throws Error when used outside a `<Chart>`
+ */
+export function useStreamingSettings() {
+    const { windowingTime, dataUpdatePeriod, onUpdateChartTime } = useChartData();
+    return { windowingTime, dataUpdatePeriod, onUpdateChartTime };
+}
+/**
+ * Subscribes the calling component to the data source's running state, so it re-renders when the
+ * source starts or stops (e.g. to switch the zoom pivot, or hide markers while running).
+ * @param dataSource The data source, or `undefined` (in which case this is always `false`)
+ * @return Whether the data source is currently running
+ */
+export function useDataSourceRunning(dataSource) {
+    const subscribe = useCallback((onChange) => {
+        if (dataSource === undefined)
+            return () => {
+            };
+        const subscription = dataSource.isRunningObservable.subscribe(() => onChange());
+        return () => subscription.unsubscribe();
+    }, [dataSource]);
+    return useSyncExternalStore(subscribe, () => { var _a; return (_a = dataSource === null || dataSource === void 0 ? void 0 : dataSource.running) !== null && _a !== void 0 ? _a : false; });
+}
+//# sourceMappingURL=useDataSource.js.map

package/dist/app/charts/hooks/useDataSource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useDataSource.js","sourceRoot":"","sources":["../../../../src/app/charts/hooks/useDataSource.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAE,WAAW,EAAE,UAAU,EAAE,oBAAoB,EAAC,MAAM,OAAO,CAAC;AAuCnF,kGAAkG;AAClG,+FAA+F;AAC/F,8EAA8E;AAC9E,MAAM,CAAC,MAAM,gBAAgB,GAAG,aAAa,CAAU,SAAS,CAAC,CAAA;AAEjE;;;GAGG;AACH,SAAS,YAAY;IACjB,MAAM,OAAO,GAAG,UAAU,CAAC,gBAAgB,CAAC,CAAA;IAC5C,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QACxB,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAA;IAC1E,CAAC;IACD,OAAO,OAAoC,CAAA;AAC/C,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,aAAa;;IACzB,OAAO,MAAC,UAAU,CAAC,gBAAgB,CAA2C,0CAAE,UAAU,CAAA;AAC9F,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,cAAc;IAC1B,MAAM,EAAC,WAAW,EAAC,GAAG,YAAY,EAA+B,CAAA;IACjE,OAAO,EAAC,WAAW,EAAC,CAAA;AACxB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,oBAAoB;IAChC,MAAM,EAAC,aAAa,EAAE,gBAAgB,EAAE,iBAAiB,EAAC,GAAG,YAAY,EAA2C,CAAA;IACpH,OAAO,EAAC,aAAa,EAAE,gBAAgB,EAAE,iBAAiB,EAAC,CAAA;AAC/D,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,oBAAoB,CAA0B,UAAkD;IAC5G,MAAM,SAAS,GAAG,WAAW,CACzB,CAAC,QAAoB,EAAgB,EAAE;QACnC,IAAI,UAAU,KAAK,SAAS;YAAE,OAAO,GAAG,EAAE;YAC1C,CAAC,CAAA;QACD,MAAM,YAAY,GAAG,UAAU,CAAC,mBAAmB,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAA;QAC/E,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,WAAW,EAAE,CAAA;IAC3C,CAAC,EACD,CAAC,UAAU,CAAC,CACf,CAAA;IACD,OAAO,oBAAoB,CAAC,SAAS,EAAE,GAAG,EAAE,WAAC,OAAA,MAAA,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,OAAO,mCAAI,KAAK,CAAA,EAAA,CAAC,CAAA;AAC9E,CAAC"}