stream-charts 1.0.0 → 1.1.0

package/dist/src/app/charts/hooks/useInitialData.d.ts

@@ -0,0 +1,38 @@
+import { JSX } from "react";
+import { BaseSeries } from "../series/baseSeries";
+import { ChartData } from "../observables/ChartData";
+/**
+ * The values exposed through the {@link useInitialData} react hook
+ */
+type UseInitialDataValues<CD extends ChartData, D> = {
+    /**
+     * An array of series representing the initial data for the chart (i.e. static data
+     * before streaming starts) where D is a datum, whose type must be the same as that
+     * used for the Observable on the chart data
+     */
+    initialData: Array<BaseSeries<D>>;
+    /**
+     * Function that takes an array of series (which has elements of type D) and converts
+     * it into a chart data type, CD
+     * @param seriesList
+     */
+    asChartData?: (seriesList: Array<BaseSeries<D>>) => CD;
+};
+interface Props<CD extends ChartData, D> {
+    initialData: Array<BaseSeries<D>>;
+    asChartData?: (seriesList: Array<BaseSeries<D>>) => CD;
+    children: JSX.Element | Array<JSX.Element>;
+}
+/**
+ * The React context provider for the {@link UseInitialDataValues}
+ * @param props The properties
+ * @return The children wrapped in this provider
+ * @constructor
+ */
+export default function InitialDataProvider<CD extends ChartData, D>(props: Props<CD, D>): JSX.Element;
+/**
+ * React hook that sets up the React context for the initial data values.
+ * @return The {@link UseInitialDataValues} held in the React context.
+ */
+export declare function useInitialData<CD extends ChartData, D>(): UseInitialDataValues<CD, D>;
+export {};

package/dist/src/app/charts/hooks/useInitialData.js

@@ -0,0 +1,29 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { createContext, useContext } from "react";
+const defaultInitialDataValues = {
+    initialData: new Array()
+};
+const InitialDataContext = createContext(defaultInitialDataValues);
+/**
+ * The React context provider for the {@link UseInitialDataValues}
+ * @param props The properties
+ * @return The children wrapped in this provider
+ * @constructor
+ */
+export default function InitialDataProvider(props) {
+    const { initialData, asChartData } = props;
+    return _jsx(InitialDataContext.Provider, { value: { initialData, asChartData }, children: props.children });
+}
+/**
+ * React hook that sets up the React context for the initial data values.
+ * @return The {@link UseInitialDataValues} held in the React context.
+ */
+export function useInitialData() {
+    const context = useContext(InitialDataContext);
+    const { initialData } = context;
+    if (initialData === undefined) {
+        throw new Error("useInitialData can only be used when the parent is a <InitialDataProvider/>");
+    }
+    return context;
+}
+//# sourceMappingURL=useInitialData.js.map

package/dist/src/app/charts/hooks/useInitialData.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useInitialData.js","sourceRoot":"","sources":["../../../../../src/app/charts/hooks/useInitialData.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAC,aAAa,EAAO,UAAU,EAAC,MAAM,OAAO,CAAC;AAwBrD,MAAM,wBAAwB,GAAmC;IAC7D,WAAW,EAAE,IAAI,KAAK,EAAmB;CAC5C,CAAA;AAED,MAAM,kBAAkB,GAAG,aAAa,CAAiC,wBAAwB,CAAC,CAAA;AAQlG;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,mBAAmB,CAA0B,KAAmB;IACpF,MAAM,EACF,WAAW,EACX,WAAW,EACd,GAAG,KAAK,CAAA;IAET,OAAO,KAAC,kBAAkB,CAAC,QAAQ,IAAC,KAAK,EAAE,EAAC,WAAW,EAAE,WAAW,EAAC,YAChE,KAAK,CAAC,QAAQ,GACW,CAAA;AAClC,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,cAAc;IAC1B,MAAM,OAAO,GAAG,UAAU,CAA8B,kBAAkB,CAAC,CAAA;IAC3E,MAAM,EAAC,WAAW,EAAC,GAAG,OAAO,CAAA;IAC7B,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;QAC5B,MAAM,IAAI,KAAK,CAAC,6EAA6E,CAAC,CAAA;IAClG,CAAC;IACD,OAAO,OAAO,CAAA;AAClB,CAAC"}

package/dist/src/app/charts/hooks/useMouse.d.ts

@@ -0,0 +1,53 @@
+import { JSX } from "react";
+import { TooltipData } from "./useTooltip";
+export type UseMouseValues<D, TM> = {
+    /**
+     * Adds a mouse-over-series handler with the specified ID and handler function
+     * @param handlerId The handler ID
+     * @param handler The handler function called when a mouse-over-series event occurs.
+     * The handler function is handed the series name, the time (x-value), the actual
+     * series, and the mouse coordinates over which the mouse has moved over.
+     * @return The handler ID.
+     */
+    registerMouseOverHandler: (handlerId: string, handler: (seriesName: string, time: number, tooltipData: TooltipData<D, TM>, mouseCoords: [x: number, y: number]) => void) => string;
+    /**
+     * Removes the mouse-over-series handler with the specified ID
+     * @param handlerId The ID of the handler to remove
+     */
+    unregisterMouseOverHandler: (handlerId: string) => void;
+    /**
+     * Attempts to retrieve the mouse-over-series handler for the specified ID
+     * @param handlerId The ID of the handler
+     * @return The mouse-over-series handler for the ID, or `undefined` if not found
+     */
+    mouseOverHandlerFor: (handlerId: string, providerId?: string) => ((seriesName: string, time: number, tooltipData: TooltipData<D, TM>, mouseCoords: [x: number, y: number], providerId?: string) => void) | undefined;
+    /**
+     * Adds a mouse-leave-series handler with the specified ID and handler function
+     * @param handlerId The handler ID
+     * @param handler The handler function called when a mouse-leave-series event occurs
+     * @return The handler ID
+     */
+    registerMouseLeaveHandler: (handlerId: string, handler: (seriesName: string) => void) => string;
+    /**
+     * Removes the mouse-leave-series handler with the specified ID
+     * @param handlerId The ID of the handler to remove
+     */
+    unregisterMouseLeaveHandler: (handlerId: string) => void;
+    /**
+     * Attempts to retrieve the mouse-leave-series handler for the specified ID
+     * @param handlerId The ID of the handler
+     * @return The mouse-leave-series handler for the ID, or `undefined` if not found
+     */
+    mouseLeaveHandlerFor: (handlerId: string, providerId?: string) => ((seriesName: string, providerId?: string) => void) | undefined;
+};
+export declare const defaultMouseValues: () => UseMouseValues<any, any>;
+type Props = {
+    children: JSX.Element | Array<JSX.Element>;
+};
+export default function MouseProvider<D, TM>(props: Props): JSX.Element;
+/**
+ * React hook that sets up the React context for the mouse values.
+ * @return The {@link UseMouseValues} held in the React context.
+ */
+export declare function useMouse<D, TM>(): UseMouseValues<D, TM>;
+export {};

package/dist/src/app/charts/hooks/useMouse.js

@@ -0,0 +1,65 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { createContext, useContext, useRef } from "react";
+/**
+ * No operation function for use when a default function is needed
+ */
+const noop = () => {
+    /* empty on purpose */
+};
+export const defaultMouseValues = () => ({
+    registerMouseOverHandler: () => '',
+    unregisterMouseOverHandler: noop,
+    mouseOverHandlerFor: () => undefined,
+    registerMouseLeaveHandler: () => '',
+    unregisterMouseLeaveHandler: noop,
+    mouseLeaveHandlerFor: () => undefined,
+});
+const MouseContext = createContext(defaultMouseValues());
+export default function MouseProvider(props) {
+    const { children } = props;
+    const mouseOverHandlersRef = useRef(new Map());
+    const mouseLeaveHandlersRef = useRef(new Map());
+    return _jsx(MouseContext.Provider, { value: {
+            registerMouseOverHandler: (handlerId, handler) => {
+                mouseOverHandlersRef.current.set(handlerId, handler);
+                return handlerId;
+            },
+            unregisterMouseOverHandler: handlerId => mouseOverHandlersRef.current.delete(handlerId),
+            mouseOverHandlerFor: (handlerId, providerId) => {
+                const handlerHoc = mouseOverHandlersRef.current.get(handlerId);
+                if (handlerHoc !== undefined) {
+                    return (seriesName, time, tooltipData, mouseCoords) => {
+                        handlerHoc(seriesName, time, tooltipData, mouseCoords, providerId);
+                    };
+                }
+                return undefined;
+            },
+            registerMouseLeaveHandler: (handlerId, handler) => {
+                mouseLeaveHandlersRef.current.set(handlerId, handler);
+                return handlerId;
+            },
+            unregisterMouseLeaveHandler: handlerId => mouseLeaveHandlersRef.current.delete(handlerId),
+            mouseLeaveHandlerFor: (handlerId, providerId) => {
+                const handlerHoc = mouseLeaveHandlersRef.current.get(handlerId);
+                if (handlerHoc !== undefined) {
+                    return (seriesName) => {
+                        handlerHoc(seriesName, providerId);
+                    };
+                }
+                return undefined;
+            },
+        }, children: children });
+}
+/**
+ * React hook that sets up the React context for the mouse values.
+ * @return The {@link UseMouseValues} held in the React context.
+ */
+export function useMouse() {
+    const context = useContext(MouseContext);
+    const { mouseOverHandlerFor } = context;
+    if (mouseOverHandlerFor === undefined || mouseOverHandlerFor === null) {
+        throw new Error("useMouse can only be used when the parent is a <MouseProvider/>");
+    }
+    return context;
+}
+//# sourceMappingURL=useMouse.js.map

package/dist/src/app/charts/hooks/useMouse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useMouse.js","sourceRoot":"","sources":["../../../../../src/app/charts/hooks/useMouse.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAC,aAAa,EAAO,UAAU,EAAE,MAAM,EAAC,MAAM,OAAO,CAAC;AAG7D;;GAEG;AACH,MAAM,IAAI,GAAG,GAAG,EAAE;IACd,sBAAsB;AAC1B,CAAC,CAAA;AA+CD,MAAM,CAAC,MAAM,kBAAkB,GAAG,GAA6B,EAAE,CAAC,CAAC;IAC/D,wBAAwB,EAAE,GAAG,EAAE,CAAC,EAAE;IAClC,0BAA0B,EAAE,IAAI;IAChC,mBAAmB,EAAE,GAAG,EAAE,CAAC,SAAS;IACpC,yBAAyB,EAAE,GAAG,EAAE,CAAC,EAAE;IACnC,2BAA2B,EAAE,IAAI;IACjC,oBAAoB,EAAE,GAAG,EAAE,CAAC,SAAS;CACxC,CAAC,CAAA;AAEF,MAAM,YAAY,GAAG,aAAa,CAA2B,kBAAkB,EAAE,CAAC,CAAA;AAMlF,MAAM,CAAC,OAAO,UAAU,aAAa,CAAQ,KAAY;IACrD,MAAM,EAAC,QAAQ,EAAC,GAAG,KAAK,CAAA;IAExB,MAAM,oBAAoB,GAAG,MAAM,CAAqJ,IAAI,GAAG,EAAE,CAAC,CAAA;IAClM,MAAM,qBAAqB,GAAG,MAAM,CAAiE,IAAI,GAAG,EAAE,CAAC,CAAA;IAE/G,OAAO,KAAC,YAAY,CAAC,QAAQ,IACzB,KAAK,EAAE;YACH,wBAAwB,EAAE,CAAC,SAAS,EAAE,OAAO,EAAE,EAAE;gBAC7C,oBAAoB,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,CAAA;gBACpD,OAAO,SAAS,CAAA;YACpB,CAAC;YACD,0BAA0B,EAAE,SAAS,CAAC,EAAE,CAAC,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC;YACvF,mBAAmB,EAAE,CAAC,SAAS,EAAE,UAAU,EAAE,EAAE;gBAC3C,MAAM,UAAU,GAAG,oBAAoB,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;gBAC9D,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;oBAC3B,OAAO,CAAC,UAAkB,EAAE,IAAY,EAAE,WAA+B,EAAE,WAAmC,EAAC,EAAE;wBAC7G,UAAU,CAAC,UAAU,EAAE,IAAI,EAAE,WAAW,EAAE,WAAW,EAAE,UAAU,CAAC,CAAA;oBACtE,CAAC,CAAA;gBACL,CAAC;gBACD,OAAO,SAAS,CAAA;YACpB,CAAC;YAED,yBAAyB,EAAE,CAAC,SAAS,EAAE,OAAO,EAAE,EAAE;gBAC9C,qBAAqB,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,CAAA;gBACrD,OAAO,SAAS,CAAA;YACpB,CAAC;YACD,2BAA2B,EAAE,SAAS,CAAC,EAAE,CAAC,qBAAqB,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC;YACzF,oBAAoB,EAAE,CAAC,SAAS,EAAE,UAAU,EAAE,EAAE;gBAC5C,MAAM,UAAU,GAAG,qBAAqB,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;gBAC/D,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;oBAC3B,OAAO,CAAC,UAAkB,EAAC,EAAE;wBACzB,UAAU,CAAC,UAAU,EAAE,UAAU,CAAC,CAAA;oBACtC,CAAC,CAAA;gBACL,CAAC;gBACD,OAAO,SAAS,CAAA;YACpB,CAAC;SACJ,YAEA,QAAQ,GACW,CAAA;AAC5B,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,QAAQ;IACpB,MAAM,OAAO,GAAG,UAAU,CAAwB,YAAY,CAAC,CAAA;IAC/D,MAAM,EAAC,mBAAmB,EAAC,GAAG,OAAO,CAAA;IACrC,IAAI,mBAAmB,KAAK,SAAS,IAAI,mBAAmB,KAAK,IAAI,EAAE,CAAC;QACpE,MAAM,IAAI,KAAK,CAAC,iEAAiE,CAAC,CAAA;IACtF,CAAC;IACD,OAAO,OAAO,CAAA;AAClB,CAAC"}

package/dist/src/app/charts/hooks/usePlotDimensions.d.ts

@@ -0,0 +1,34 @@
+import { Dimensions, Margin } from "../styling/margins";
+import { JSX } from "react";
+export declare const defaultMargin: Margin;
+export type PlotDimensionChangeHandler = (previousDimensions: Dimensions, newDimensions: Dimensions) => void;
+export type UsePlotDimensionsValues = {
+    /**
+     * The width and height (in pixels) of this chart
+     */
+    plotDimensions: Dimensions;
+    /**
+     * The plot margins for the border of main G
+     */
+    margin: Margin;
+    /**
+     * Update the plot dimensions (for example, on a window resize)
+     * @param dimensions the new dimensions of the plot
+     */
+    updateDimensions: (dimensions: Dimensions) => void;
+    registerPlotDimensionChangeHandler: (handler: PlotDimensionChangeHandler) => string;
+    unregisterPlotDimensionChangeHandler: (handlerId: string) => void;
+};
+export declare const defaultPlotDimensions: () => UsePlotDimensionsValues;
+type Props = {
+    containerDimensions: Dimensions;
+    margin: Margin;
+    children: JSX.Element | Array<JSX.Element>;
+};
+export default function PlotDimensionsProvider(props: Props): JSX.Element;
+/**
+ * React hook that sets up the React context for the plot-dimension values.
+ * @return The {@link UsePlotDimensionsValues} held in the React context.
+ */
+export declare function usePlotDimensions(): UsePlotDimensionsValues;
+export {};

package/dist/src/app/charts/hooks/usePlotDimensions.js

@@ -0,0 +1,73 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { dimensionsNotEqual, plotDimensionsFrom } from "../styling/margins";
+import { createContext, useContext, useEffect, useRef, useState } from "react";
+/**
+ * No operation function for use when a default function is needed
+ */
+const noop = () => {
+    /* empty on purpose */
+};
+export const defaultMargin = { top: 30, right: 20, bottom: 30, left: 50 };
+export const defaultPlotDimensions = () => ({
+    plotDimensions: { width: 0, height: 0 },
+    margin: defaultMargin,
+    updateDimensions: noop,
+    registerPlotDimensionChangeHandler: () => "",
+    unregisterPlotDimensionChangeHandler: noop
+});
+const PlotDimensionsContext = createContext(defaultPlotDimensions());
+export default function PlotDimensionsProvider(props) {
+    const { containerDimensions, margin, children } = props;
+    const [dimensions, setDimensions] = useState(defaultPlotDimensions().plotDimensions);
+    const plotDimensionChangeHandersRef = useRef(new Map());
+    // update the plot dimensions when the container size or margin change
+    useEffect(() => {
+        const newDimensions = plotDimensionsFrom(containerDimensions.width, containerDimensions.height, margin);
+        setDimensions(prevDimensions => {
+            if (dimensionsNotEqual(prevDimensions, newDimensions)) {
+                for (const handler of plotDimensionChangeHandersRef.current.values()) {
+                    handler(prevDimensions, newDimensions);
+                }
+                return newDimensions;
+            }
+            return prevDimensions;
+        });
+    }, [containerDimensions, margin]);
+    function updateDimensions(newDimensions) {
+        setDimensions(prevState => {
+            for (const handler of plotDimensionChangeHandersRef.current.values()) {
+                handler(prevState, newDimensions);
+            }
+            return newDimensions;
+        });
+    }
+    function registerPlotDimensionChangeHandler(handler) {
+        const handlerId = crypto.randomUUID();
+        plotDimensionChangeHandersRef.current.set(handlerId, handler);
+        return handlerId;
+    }
+    function unregisterPlotDimensionChangeHandler(handlerId) {
+        return plotDimensionChangeHandersRef.current.delete(handlerId);
+    }
+    return _jsx(PlotDimensionsContext.Provider, { value: {
+            plotDimensions: dimensions,
+            margin,
+            updateDimensions,
+            // updateDimensions: dimensions => setDimensions(dimensions),
+            registerPlotDimensionChangeHandler,
+            unregisterPlotDimensionChangeHandler
+        }, children: children });
+}
+/**
+ * React hook that sets up the React context for the plot-dimension values.
+ * @return The {@link UsePlotDimensionsValues} held in the React context.
+ */
+export function usePlotDimensions() {
+    const context = useContext(PlotDimensionsContext);
+    const { plotDimensions } = context;
+    if (plotDimensions === undefined || plotDimensions === null) {
+        throw new Error("usePlotDimensions can only be used when the parent is a <PlotDimensionsProvider/>");
+    }
+    return context;
+}
+//# sourceMappingURL=usePlotDimensions.js.map

package/dist/src/app/charts/hooks/usePlotDimensions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"usePlotDimensions.js","sourceRoot":"","sources":["../../../../../src/app/charts/hooks/usePlotDimensions.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAa,kBAAkB,EAAU,kBAAkB,EAAC,MAAM,oBAAoB,CAAC;AAC9F,OAAO,EAAC,aAAa,EAAO,UAAU,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAC,MAAM,OAAO,CAAC;AAElF;;GAEG;AACH,MAAM,IAAI,GAAG,GAAG,EAAE;IACd,sBAAsB;AAC1B,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,aAAa,GAAW,EAAC,GAAG,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAC,CAAA;AAsB/E,MAAM,CAAC,MAAM,qBAAqB,GAAG,GAA4B,EAAE,CAAC,CAAC;IACjE,cAAc,EAAE,EAAC,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAC;IACrC,MAAM,EAAE,aAAa;IACrB,gBAAgB,EAAE,IAAI;IACtB,kCAAkC,EAAE,GAAG,EAAE,CAAC,EAAE;IAC5C,oCAAoC,EAAE,IAAI;CAC7C,CAAC,CAAA;AAEF,MAAM,qBAAqB,GAAG,aAAa,CAA0B,qBAAqB,EAAE,CAAC,CAAA;AAQ7F,MAAM,CAAC,OAAO,UAAU,sBAAsB,CAAC,KAAY;IACvD,MAAM,EACF,mBAAmB,EACnB,MAAM,EACN,QAAQ,EACX,GAAG,KAAK,CAAA;IAET,MAAM,CAAC,UAAU,EAAE,aAAa,CAAC,GAAG,QAAQ,CAAa,qBAAqB,EAAE,CAAC,cAAc,CAAC,CAAA;IAChG,MAAM,6BAA6B,GAAG,MAAM,CAA0C,IAAI,GAAG,EAAE,CAAC,CAAA;IAEhG,sEAAsE;IACtE,SAAS,CACL,GAAG,EAAE;QACD,MAAM,aAAa,GAAG,kBAAkB,CAAC,mBAAmB,CAAC,KAAK,EAAE,mBAAmB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QACvG,aAAa,CAAC,cAAc,CAAC,EAAE;YAC3B,IAAI,kBAAkB,CAAC,cAAc,EAAE,aAAa,CAAC,EAAE,CAAC;gBACpD,KAAI,MAAM,OAAO,IAAI,6BAA6B,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;oBAClE,OAAO,CAAC,cAAc,EAAE,aAAa,CAAC,CAAA;gBAC1C,CAAC;gBACD,OAAO,aAAa,CAAA;YACxB,CAAC;YACD,OAAO,cAAc,CAAA;QACzB,CAAC,CAAC,CAAA;IACN,CAAC,EACD,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAChC,CAAA;IAED,SAAS,gBAAgB,CAAC,aAAyB;QAC/C,aAAa,CAAC,SAAS,CAAC,EAAE;YACtB,KAAI,MAAM,OAAO,IAAI,6BAA6B,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;gBAClE,OAAO,CAAC,SAAS,EAAE,aAAa,CAAC,CAAA;YACrC,CAAC;YACD,OAAO,aAAa,CAAA;QACxB,CAAC,CAAC,CAAA;IACN,CAAC;IAED,SAAS,kCAAkC,CAAC,OAAmC;QAC3E,MAAM,SAAS,GAAG,MAAM,CAAC,UAAU,EAAE,CAAA;QACrC,6BAA6B,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,CAAA;QAC7D,OAAO,SAAS,CAAA;IACpB,CAAC;IAED,SAAS,oCAAoC,CAAC,SAAiB;QAC3D,OAAO,6BAA6B,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;IAClE,CAAC;IAED,OAAO,KAAC,qBAAqB,CAAC,QAAQ,IAClC,KAAK,EAAE;YACH,cAAc,EAAE,UAAU;YAC1B,MAAM;YACN,gBAAgB;YAChB,6DAA6D;YAC7D,kCAAkC;YAClC,oCAAoC;SACvC,YAEA,QAAQ,GACoB,CAAA;AACrC,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,iBAAiB;IAC7B,MAAM,OAAO,GAAG,UAAU,CAA0B,qBAAqB,CAAC,CAAA;IAC1E,MAAM,EAAC,cAAc,EAAC,GAAG,OAAO,CAAA;IAChC,IAAI,cAAc,KAAK,SAAS,IAAI,cAAc,KAAK,IAAI,EAAE,CAAC;QAC1D,MAAM,IAAI,KAAK,CAAC,mFAAmF,CAAC,CAAA;IACxG,CAAC;IACD,OAAO,OAAO,CAAA;AAClB,CAAC"}

package/dist/src/app/charts/hooks/useTooltip.d.ts

@@ -0,0 +1,64 @@
+import { Series } from "../plots/plot";
+import { TooltipDimensions } from "../tooltips/tooltipUtils";
+import { JSX } from "react";
+/**
+ * Base interface for tooltip data that is passed through to the tooltip content provider
+ */
+export interface TooltipData<D, M> {
+    series: Series<D>;
+    metadata: M;
+}
+/**
+ * A higher-order function that returns a function that provides the tooltip content or
+ * `undefined` if no tooltip content is available.
+ * @return The tooltip content, or `undefined` if no tooltip content is available.
+ * @param seriesName The name of the series for which the tooltip content is being provided
+ * @param time The time (x-value) for which the tooltip content is being provided
+ * @param tooltipData The tooltip data
+ * @param mouseCoords The mouse coordinates over which the mouse is hovering
+ * @param providerId An optional ID of the tooltip content provider.
+ */
+type TooltipContentProvider<D, M> = (seriesName: string, time: number, tooltipData: TooltipData<D, M>, mouseCoords: [x: number, y: number], providerId?: string) => TooltipDimensions;
+/**
+ * The functions and values exposed through the {@link useTooltip} react hook
+ */
+export type UseTooltipValues<D, M> = {
+    /**
+     * Registers the provider of the tooltip content (generally the plot will register this).
+     * When this function is called again, overwrites the previously registered provider with the
+     * one specified. This function can be called repeatedly.
+     * @param provider The function that provides the content when called.
+     */
+    registerTooltipContentProvider: (provider: TooltipContentProvider<D, M>) => void;
+    /**
+     * @return The registered function that provides the tooltip content. If no function has been
+     * registered, then returns `undefined`.
+     */
+    tooltipContentProvider: () => (TooltipContentProvider<D, M> | undefined);
+    setVisibilityState: (visible: boolean) => void;
+    visibilityState: boolean;
+};
+/**
+ * The default values for the {@link UseTooltipValues}
+ */
+export declare const defaultTooltipValues: () => UseTooltipValues<any, any>;
+type Props = {
+    children: JSX.Element | Array<JSX.Element>;
+};
+/**
+ * The tooltip context provider allows registering and retrieving tooltip content providers. When
+ * a tooltip content provider is registered with a provider ID, then it must be retrieved with that
+ * same provider ID. This allows a chart to have multiple tooltip content providers, depending on
+ * the context or types of objects being moused over. When a tooltip content provider is registered
+ * without a provider ID, then the default provider ID is used.
+ * @param props The properties holding the children
+ * @constructor
+ * @return A JSX element containing the children
+ */
+export default function TooltipProvider<D, M>(props: Props): JSX.Element;
+/**
+ * React hook that sets up the React context for the mouse values.
+ * @return The {@link UseTooltipValues} held in the React context.
+ */
+export declare function useTooltip<D, M>(): UseTooltipValues<D, M>;
+export {};

package/dist/src/app/charts/hooks/useTooltip.js

@@ -0,0 +1,52 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { createContext, useContext, useRef } from "react";
+/**
+ * No operation function for use when a default function is needed
+ */
+const noop = () => {
+    /* empty on purpose */
+};
+/**
+ * The default values for the {@link UseTooltipValues}
+ */
+export const defaultTooltipValues = () => ({
+    registerTooltipContentProvider: noop,
+    tooltipContentProvider: () => undefined,
+    setVisibilityState: noop,
+    visibilityState: false,
+});
+const TooltipContext = createContext(defaultTooltipValues());
+/**
+ * The tooltip context provider allows registering and retrieving tooltip content providers. When
+ * a tooltip content provider is registered with a provider ID, then it must be retrieved with that
+ * same provider ID. This allows a chart to have multiple tooltip content providers, depending on
+ * the context or types of objects being moused over. When a tooltip content provider is registered
+ * without a provider ID, then the default provider ID is used.
+ * @param props The properties holding the children
+ * @constructor
+ * @return A JSX element containing the children
+ */
+export default function TooltipProvider(props) {
+    const { children } = props;
+    const tooltipContentProviderRef = useRef(undefined);
+    const visibilityStateRef = useRef(false);
+    return _jsx(TooltipContext.Provider, { value: {
+            registerTooltipContentProvider: provider => tooltipContentProviderRef.current = provider,
+            tooltipContentProvider: () => tooltipContentProviderRef.current,
+            setVisibilityState: (visible) => visibilityStateRef.current = visible,
+            visibilityState: visibilityStateRef.current
+        }, children: children });
+}
+/**
+ * React hook that sets up the React context for the mouse values.
+ * @return The {@link UseTooltipValues} held in the React context.
+ */
+export function useTooltip() {
+    const context = useContext(TooltipContext);
+    const { registerTooltipContentProvider } = context;
+    if (registerTooltipContentProvider === undefined || registerTooltipContentProvider === null) {
+        throw new Error("useTooltip can only be used when the parent is a <TooltipProvider/>");
+    }
+    return context;
+}
+//# sourceMappingURL=useTooltip.js.map

package/dist/src/app/charts/hooks/useTooltip.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useTooltip.js","sourceRoot":"","sources":["../../../../../src/app/charts/hooks/useTooltip.tsx"],"names":[],"mappings":";AAEA,OAAO,EAAC,aAAa,EAAO,UAAU,EAAE,MAAM,EAAC,MAAM,OAAO,CAAC;AAE7D;;GAEG;AACH,MAAM,IAAI,GAAG,GAAG,EAAE;IACd,sBAAsB;AAC1B,CAAC,CAAA;AA+CD;;GAEG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,GAA+B,EAAE,CAAC,CAAC;IACnE,8BAA8B,EAAE,IAAI;IACpC,sBAAsB,EAAE,GAAG,EAAE,CAAC,SAAS;IACvC,kBAAkB,EAAE,IAAI;IACxB,eAAe,EAAE,KAAK;CACzB,CAAC,CAAA;AAEF,MAAM,cAAc,GAAG,aAAa,CAA6B,oBAAoB,EAAE,CAAC,CAAA;AAMxF;;;;;;;;;GASG;AACH,MAAM,CAAC,OAAO,UAAU,eAAe,CAAO,KAAY;IACtD,MAAM,EAAC,QAAQ,EAAC,GAAG,KAAK,CAAA;IAExB,MAAM,yBAAyB,GAAG,MAAM,CAA+B,SAAS,CAAC,CAAA;IACjF,MAAM,kBAAkB,GAAG,MAAM,CAAU,KAAK,CAAC,CAAA;IAEjD,OAAO,KAAC,cAAc,CAAC,QAAQ,IAC3B,KAAK,EAAE;YACH,8BAA8B,EAAE,QAAQ,CAAC,EAAE,CAAC,yBAAyB,CAAC,OAAO,GAAG,QAAQ;YACxF,sBAAsB,EAAE,GAAG,EAAE,CAAC,yBAAyB,CAAC,OAAO;YAC/D,kBAAkB,EAAE,CAAC,OAAgB,EAAE,EAAE,CAAC,kBAAkB,CAAC,OAAO,GAAG,OAAO;YAC9E,eAAe,EAAE,kBAAkB,CAAC,OAAO;SAC9C,YAEA,QAAQ,GACa,CAAA;AAC9B,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,UAAU;IACtB,MAAM,OAAO,GAAG,UAAU,CAAyB,cAAc,CAAC,CAAA;IAClE,MAAM,EAAC,8BAA8B,EAAC,GAAG,OAAO,CAAA;IAChD,IAAI,8BAA8B,KAAK,SAAS,IAAI,8BAA8B,KAAK,IAAI,EAAE,CAAC;QAC1F,MAAM,IAAI,KAAK,CAAC,qEAAqE,CAAC,CAAA;IAC1F,CAAC;IACD,OAAO,OAAO,CAAA;AAClB,CAAC"}

package/dist/src/app/charts/observables/ChartData.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Intended base interface for chart data. All chart data need to hold
+ * a {@link Set} of series names.
+ * @see TimeSeriesChartData
+ * @see IterateChartData
+ * @see OrdinalChartData
+ */
+export interface ChartData {
+    seriesNames: Set<string>;
+}
+/**
+ * @return A default {@link ChartData} object with an empty set of series
+ * names
+ */
+export declare function defaultChartData(): ChartData;
+/**
+ * Creates and returns a deep copy of the {@link ChartData}
+ * @param data The chart data to copy
+ * @return A deep copy of the chart data
+ */
+export declare function copyChartData(data: ChartData): {
+    seriesNames: Set<string>;
+};

package/dist/src/app/charts/observables/ChartData.js

@@ -0,0 +1,20 @@
+/**
+ * @return A default {@link ChartData} object with an empty set of series
+ * names
+ */
+export function defaultChartData() {
+    return {
+        seriesNames: new Set()
+    };
+}
+/**
+ * Creates and returns a deep copy of the {@link ChartData}
+ * @param data The chart data to copy
+ * @return A deep copy of the chart data
+ */
+export function copyChartData(data) {
+    return {
+        seriesNames: new Set(data.seriesNames.values()),
+    };
+}
+//# sourceMappingURL=ChartData.js.map

package/dist/src/app/charts/observables/ChartData.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChartData.js","sourceRoot":"","sources":["../../../../../src/app/charts/observables/ChartData.ts"],"names":[],"mappings":"AAWA;;;GAGG;AACH,MAAM,UAAU,gBAAgB;IAC5B,OAAO;QACH,WAAW,EAAE,IAAI,GAAG,EAAU;KACjC,CAAA;AACL,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,IAAe;IACzC,OAAO;QACH,WAAW,EAAE,IAAI,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC;KAClD,CAAA;AACL,CAAC"}

package/dist/src/app/charts/observables/iterates.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Utilities for plotting function iterates. For example suppose that f[1](x) = f(x), f[2](x) = f(f(x)),
+ * f[3](x) = f(f(f(x))), and f[m](x) = f(f(f....(x))), where the function is applied m times. Given this,
+ * then an iterate (Poincare) plot shows points (f[m](x), f[m+1](x)), which is a 1-iterate. Plots of
+ * points (f[m](x), f[m+n](x)) are n-iterates.
+ *
+ * 1. Convert series to chart data observable in the usual way
+ * 2. Accepts that chart-data observable and converts that observable to an iterate-chart-data observable
+ */
+import { Observable } from "rxjs";
+import { TimeSeriesChartData } from "../series/timeSeriesChartData";
+import { IterateDatum } from "../series/iterateSeries";
+import { ChartData } from "./ChartData";
+export interface IterateChartData extends ChartData {
+    /**
+     * The min values for (time, iterate n, and iterate n+1) for the data in the newPoints map
+     */
+    minIterate: IterateDatum;
+    /**
+     * The max values for (time, iterate n, and iterate n+1) for the data in the newPoints map
+     */
+    maxIterate: IterateDatum;
+    /**
+     * Holds the association of the series name to the current min time for that series
+     */
+    minIterates: Map<string, IterateDatum>;
+    /**
+     * Holds the association of the series name to the current max time for that series
+     */
+    maxIterates: Map<string, IterateDatum>;
+    /**
+     * Map holding the name of the series (the time-series identifier) and the associated
+     * data points for that time-series (`map(series_name -> array(datum))`)
+     */
+    newPoints: Map<string, Array<IterateDatum>>;
+}
+/**
+ * Makes a deep copy of the iterate chart data
+ * @param data The iterate chart data to copy
+ */
+export declare const copyIterateDataFrom: (data: IterateChartData) => IterateChartData;
+/**
+ * Accepts a {@link TimeSeriesChartData} observable and converts it to an observable of {@link IterateChartData}
+ * for the specified n-iterate. suppose that `f[0](x) = x`, `f[1](x) = f(x)`, `f[2](x) = f(f(x))`,
+ * `f[3](x) = f(f(f(x)))`, and `f[m](x) = f(f(f....(x)))`, where the function is applied `m` times. Given this,
+ * then an iterate (Poincare) plot shows points `(f[m](x), f[m+1](x))`, which is a 1-iterate. Plots of
+ * points `(f[m](x), f[m+n](x))` are n-iterates.
+ * @param dataObservable The observable over {@link TimeSeriesChartData}
+ * @param [n=1] The iterate distance
+ * @return An over {@link IterateChartData} holding the n-iterate for the incoming chart data
+ */
+export declare function iteratesObservable(dataObservable: Observable<TimeSeriesChartData>, n?: number): Observable<IterateChartData>;