stream-charts 1.2.0 → 2.0.0

package/dist/app/charts/tooltips/Tooltip.js

@@ -1,92 +1,48 @@
-import { Fragment as _Fragment, jsx as _jsx } from "react/jsx-runtime";
-import { cloneElement, useEffect, useMemo } from "react";
-import { defaultTooltipStyle, removeTooltip } from "./tooltipUtils";
-import * as d3 from "d3";
+import { jsx as _jsx } from "react/jsx-runtime";
+import { useEffect, useMemo } from "react";
+import { defaultTooltipStyle } from "./tooltipUtils";
 import { useChart } from "../hooks/useChart";
-import { usePlotDimensions } from "../hooks/usePlotDimensions";
+import { TooltipStyleContext } from "./useTooltipStyle";
 /**
- * Tooltip component triggered by mouse-over-series events. When mounted, the tooltip component
- * registers a mouse-over handler with the {@link useMouse} hook using the
- * {@link UseMouseValues.registerMouseOverHandler} function. The handler renders the tooltip
- * by adding it to the SVG plot container. However, to remain general, this {@link Tooltip} also
- * uses the {@link useTooltip}'s {@link UseTooltipValues.tooltipContentProvider} to render the actual
- * content of the tooltip. The content provider is given the series' name on which the mouse-over
- * event occurred, the plot time associated with mouse-over event, and the {@link TimeSeries}
- * associated with the mouse-over event. The plot (for example {@link ScatterPlot}) is responsible
- * for rendering the tooltip, and it registers this tooltip-content provider with the {@link useTooltip}
- * hook.
+ * Shows a tooltip when the mouse is over one of the plot's elements (a series, a point, a spike, a
+ * bar, a band, and so on), while `visible` is `true`. What the tooltip shows is up to its content
+ * (its child -- for example, a `<ScatterPlotTooltipContent>`), which is built on
+ * {@link TooltipContent}.
  *
- * The {@link useChart} hook allows the plots and this tooltip to register methods needed its siblings.
+ * The plot hit-tests the mouse against what it drew, and calls the mouse-over handler this
+ * component registers (see `useMouse`), which hands what the plot knows about the element
+ * under the mouse to the content's tooltip-content provider (see `useTooltip`). The content
+ * shows itself, and hides itself again when the mouse leaves the element.
  *
- * ## on mount
- * 1. The plot (for example {@link ScatterPlot}) adds a d3 mouse-enter and mouse-leave event handlers
- *    to each series. The mouse-enter event handler performs a few tasks and then calls the
- *    mouse-over event handler registered by the {@link Tooltip} via the {@link useMouse} hook.
- * 2. The plot (for example {@link ScatterPlot}) registers the tooltip-content provider with the {@link useTooltip}
- *    hook using the {@link UseTooltipValues.registerTooltipContentProvider} function.
- * 3. {@link Tooltip} registers the handler for mouse-over events. The handler accepts the series
- *    name, plot time, and time-series associated with the mouse-over event, and returns the tooltip
- *    dimensions. In order to create/render the tooltip, it uses the {@link UseTooltipValues.tooltipContentProvider}
- *    function that was registered via the {@link useTooltip} hook.
- *
- * ## on mouse-over event
- * When the plot's (for example {@link ScatterPlot}) d3 mouse-enter event handler fires, the plot calls this
- * {@link Tooltip}'s mouse-over handler, which creates the tooltip, and calls the {@link UseTooltipValues.tooltipContentProvider}
- * registered by the plot to render the tooltip content, and get the tooltip size.
- *
- * @param props The properties of the tooltip (i.e. visibility and style)
- * @return null
+ * The content gets this tooltip's style (its `style` over the default tooltip style) through
+ * {@link useTooltipStyle}, and can override parts of it.
+ * @param props Whether the tooltip is shown, its style, and its content
+ * @return The content, while the tooltip is shown
+ * @template D The type of the series' datum
+ * @template S The type of the series style
+ * @template TM The type of the tooltip metadata
+ * @template AR The type of the axis range
+ * @template A The type of the axis
  */
 export function Tooltip(props) {
-    const { chartId, container, tooltip, mouse } = useChart();
-    const { tooltipContentProvider, setVisibilityState, } = tooltip;
-    const { margin, plotDimensions } = usePlotDimensions();
     const { visible, style, children } = props;
-    const { registerMouseOverHandler, unregisterMouseOverHandler, registerMouseLeaveHandler, unregisterMouseLeaveHandler } = mouse;
-    const tooltipStyle = useMemo(() => (Object.assign(Object.assign({}, defaultTooltipStyle), style)), [style]);
-    // let the tooltip context know whether the tooltip is visible
-    setVisibilityState(visible);
+    const { chartId, tooltip, mouse } = useChart();
+    const { tooltipContentProvider, setVisibilityState } = tooltip;
+    const { registerMouseOverHandler, unregisterMouseOverHandler } = mouse;
+    const tooltipStyle = useMemo(() => ({ ...defaultTooltipStyle, ...style }), [style]);
     useEffect(() => {
+        // let the tooltip context know whether the tooltip is visible
+        setVisibilityState(visible);
+        if (!visible)
+            return;
+        // hands the element under the mouse to the content's provider (looked up on each call,
+        // so it's always the one the content registered most recently)
         const handlerId = `tooltip-${chartId}`;
-        if (visible && container) {
-            const contentProvider = tooltipContentProvider();
-            if (contentProvider) {
-                // register this tooltip's mouse-over event handler with the useCharts hook
-                // so that the plots can call it when mouse-enter events are triggered (for
-                // example, a mouse-over a time-series in the plot).
-                registerMouseOverHandler(handlerId, ((seriesName, time, tooltipData, mouseCoords, providerId) => {
-                    // create the rounded rectangle for the tooltip's background
-                    const rect = d3.select(container)
-                        .append('rect')
-                        .attr('id', `r${time}-${seriesName}-${chartId}`)
-                        .attr('class', 'tooltip')
-                        .attr('rx', tooltipStyle.borderRadius)
-                        .attr('fill', tooltipStyle.backgroundColor)
-                        .attr('fill-opacity', tooltipStyle.backgroundOpacity)
-                        .attr('stroke', tooltipStyle.borderColor)
-                        .attr('stroke-width', tooltipStyle.borderWidth)
-                        .attr('stroke-opacity', tooltipStyle.borderOpacity);
-                    // call the callback to add the content
-                    const { x, y, contentWidth, contentHeight } = contentProvider(seriesName, time, tooltipData, mouseCoords, providerId);
-                    // set the position, width, and height of the tooltip rect based on the text height and width and the padding
-                    rect.attr('x', () => x)
-                        .attr('y', () => y)
-                        .attr('width', contentWidth + tooltipStyle.paddingLeft + tooltipStyle.paddingRight)
-                        .attr('height', contentHeight + tooltipStyle.paddingTop + tooltipStyle.paddingBottom);
-                }));
-                registerMouseLeaveHandler(handlerId, () => removeTooltip());
-            }
-        }
-        return () => {
-            unregisterMouseOverHandler(handlerId);
-            unregisterMouseLeaveHandler(handlerId);
-        };
-    }, [
-        chartId, container, margin, plotDimensions,
-        registerMouseOverHandler, tooltipContentProvider, tooltipStyle,
-        unregisterMouseOverHandler, visible, registerMouseLeaveHandler,
-        unregisterMouseLeaveHandler
-    ]);
-    return _jsx(_Fragment, { children: cloneElement(children, props) });
+        registerMouseOverHandler(handlerId, (seriesName, time, tooltipData, mouseCoords, providerId) => { var _a; return (_a = tooltipContentProvider()) === null || _a === void 0 ? void 0 : _a(seriesName, time, tooltipData, mouseCoords, providerId); });
+        return () => unregisterMouseOverHandler(handlerId);
+    }, [chartId, visible, tooltipContentProvider, setVisibilityState, registerMouseOverHandler, unregisterMouseOverHandler]);
+    // (the content is only mounted while the tooltip is visible, so hiding the tooltip also hides
+    // any content that's showing)
+    return (_jsx(TooltipStyleContext.Provider, { value: tooltipStyle, children: visible ? children : null }));
 }
 //# sourceMappingURL=Tooltip.js.map

package/dist/app/charts/tooltips/Tooltip.js.map

@@ -1 +1 @@
-{"version":3,"file":"Tooltip.js","sourceRoot":"","sources":["../../../../src/app/charts/tooltips/Tooltip.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAC,YAAY,EAAE,SAAS,EAAE,OAAO,EAAM,MAAM,OAAO,CAAC;AAC5D,OAAO,EAAC,mBAAmB,EAAE,aAAa,EAAe,MAAM,gBAAgB,CAAC;AAChF,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,EAAC,QAAQ,EAAC,MAAM,mBAAmB,CAAC;AAC3C,OAAO,EAAC,iBAAiB,EAAC,MAAM,4BAA4B,CAAC;AAW7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAM,UAAU,OAAO,CAA6E,KAAY;IAC5G,MAAM,EACF,OAAO,EACP,SAAS,EACT,OAAO,EACP,KAAK,EACR,GAAG,QAAQ,EAAmB,CAAA;IAE/B,MAAM,EACF,sBAAsB,EACtB,kBAAkB,GACrB,GAAG,OAAO,CAAA;IAEX,MAAM,EAAC,MAAM,EAAE,cAAc,EAAC,GAAG,iBAAiB,EAAE,CAAA;IAEpD,MAAM,EACF,OAAO,EACP,KAAK,EACL,QAAQ,EACX,GAAG,KAAK,CAAA;IAET,MAAM,EACF,wBAAwB,EACxB,0BAA0B,EAC1B,yBAAyB,EACzB,2BAA2B,EAC9B,GAAG,KAAK,CAAA;IAET,MAAM,YAAY,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,iCAAK,mBAAmB,GAAK,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAA;IAEjF,8DAA8D;IAC9D,kBAAkB,CAAC,OAAO,CAAC,CAAA;IAE3B,SAAS,CACL,GAAG,EAAE;QACD,MAAM,SAAS,GAAG,WAAW,OAAO,EAAE,CAAA;QACtC,IAAI,OAAO,IAAI,SAAS,EAAE,CAAC;YACvB,MAAM,eAAe,GAAG,sBAAsB,EAAE,CAAA;YAChD,IAAI,eAAe,EAAE,CAAC;gBAClB,2EAA2E;gBAC3E,2EAA2E;gBAC3E,oDAAoD;gBACpD,wBAAwB,CACpB,SAAS,EACT,CACI,CACI,UAAkB,EAClB,IAAY,EACZ,WAA+B,EAC/B,WAAmC,EACnC,UAAmB,EACrB,EAAE;oBACA,4DAA4D;oBAC5D,MAAM,IAAI,GAAG,EAAE,CAAC,MAAM,CAA4B,SAAS,CAAC;yBACvD,MAAM,CAAiB,MAAM,CAAC;yBAC9B,IAAI,CAAC,IAAI,EAAE,IAAI,IAAI,IAAI,UAAU,IAAI,OAAO,EAAE,CAAC;yBAC/C,IAAI,CAAC,OAAO,EAAE,SAAS,CAAC;yBACxB,IAAI,CAAC,IAAI,EAAE,YAAY,CAAC,YAAY,CAAC;yBACrC,IAAI,CAAC,MAAM,EAAE,YAAY,CAAC,eAAe,CAAC;yBAC1C,IAAI,CAAC,cAAc,EAAE,YAAY,CAAC,iBAAiB,CAAC;yBACpD,IAAI,CAAC,QAAQ,EAAE,YAAY,CAAC,WAAW,CAAC;yBACxC,IAAI,CAAC,cAAc,EAAE,YAAY,CAAC,WAAW,CAAC;yBAC9C,IAAI,CAAC,gBAAgB,EAAE,YAAY,CAAC,aAAa,CAAC,CAAA;oBAEvD,uCAAuC;oBACvC,MAAM,EACF,CAAC,EACD,CAAC,EACD,YAAY,EACZ,aAAa,EAChB,GAAG,eAAe,CAAC,UAAU,EAAE,IAAI,EAAE,WAAW,EAAE,WAAW,EAAE,UAAU,CAAC,CAAA;oBAE3E,6GAA6G;oBAC7G,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;yBAClB,IAAI,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;yBAClB,IAAI,CAAC,OAAO,EAAE,YAAY,GAAG,YAAY,CAAC,WAAW,GAAG,YAAY,CAAC,YAAY,CAAC;yBAClF,IAAI,CAAC,QAAQ,EAAE,aAAa,GAAG,YAAY,CAAC,UAAU,GAAG,YAAY,CAAC,aAAa,CAAC,CAAA;gBAE7F,CAAC,CACJ,CACJ,CAAA;gBAED,yBAAyB,CAAC,SAAS,EAAE,GAAG,EAAE,CAAC,aAAa,EAAE,CAAC,CAAA;YAC/D,CAAC;QACL,CAAC;QACD,OAAO,GAAG,EAAE;YACR,0BAA0B,CAAC,SAAS,CAAC,CAAA;YACrC,2BAA2B,CAAC,SAAS,CAAC,CAAA;QAC1C,CAAC,CAAA;IACL,CAAC,EACD;QACI,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,cAAc;QAC1C,wBAAwB,EAAE,sBAAsB,EAAE,YAAY;QAC9D,0BAA0B,EAAE,OAAO,EAAE,yBAAyB;QAC9D,2BAA2B;KAC9B,CACJ,CAAA;IAED,OAAO,4BAAG,YAAY,CAAC,QAAQ,EAAE,KAAK,CAAC,GAAI,CAAA;AAC/C,CAAC"}
+{"version":3,"file":"Tooltip.js","sourceRoot":"","sources":["../../../../src/app/charts/tooltips/Tooltip.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAW,SAAS,EAAE,OAAO,EAAC,MAAM,OAAO,CAAC;AACnD,OAAO,EAAC,mBAAmB,EAAoB,MAAM,gBAAgB,CAAC;AACtE,OAAO,EAAC,QAAQ,EAAC,MAAM,mBAAmB,CAAC;AAI3C,OAAO,EAAC,mBAAmB,EAAC,MAAM,mBAAmB,CAAC;AActD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,UAAU,OAAO,CAA6E,KAAY;IAC5G,MAAM,EAAC,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAC,GAAG,KAAK,CAAA;IAExC,MAAM,EAAC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAC,GAAG,QAAQ,EAAmB,CAAA;IAC7D,MAAM,EAAC,sBAAsB,EAAE,kBAAkB,EAAC,GAAG,OAAO,CAAA;IAC5D,MAAM,EAAC,wBAAwB,EAAE,0BAA0B,EAAC,GAAG,KAAK,CAAA;IAEpE,MAAM,YAAY,GAAG,OAAO,CAAe,GAAG,EAAE,CAAC,CAAC,EAAC,GAAG,mBAAmB,EAAE,GAAG,KAAK,EAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAA;IAE/F,SAAS,CACL,GAAG,EAAE;QACD,8DAA8D;QAC9D,kBAAkB,CAAC,OAAO,CAAC,CAAA;QAC3B,IAAI,CAAC,OAAO;YAAE,OAAM;QAEpB,uFAAuF;QACvF,+DAA+D;QAC/D,MAAM,SAAS,GAAG,WAAW,OAAO,EAAE,CAAA;QACtC,wBAAwB,CACpB,SAAS,EACT,CACI,UAAkB,EAClB,IAAY,EACZ,WAA+B,EAC/B,WAAmC,EACnC,UAAmB,EACrB,EAAE,WAAC,OAAA,MAAA,sBAAsB,EAAE,0CAAG,UAAU,EAAE,IAAI,EAAE,WAAW,EAAE,WAAW,EAAE,UAAU,CAAC,CAAA,EAAA,CAC1F,CAAA;QACD,OAAO,GAAG,EAAE,CAAC,0BAA0B,CAAC,SAAS,CAAC,CAAA;IACtD,CAAC,EACD,CAAC,OAAO,EAAE,OAAO,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,wBAAwB,EAAE,0BAA0B,CAAC,CACvH,CAAA;IAED,8FAA8F;IAC9F,8BAA8B;IAC9B,OAAO,CACH,KAAC,mBAAmB,CAAC,QAAQ,IAAC,KAAK,EAAE,YAAY,YAC5C,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,GACC,CAClC,CAAA;AACL,CAAC"}

package/dist/app/charts/tooltips/TooltipContent.d.ts

@@ -0,0 +1,81 @@
+import { type CSSProperties, type ReactElement, type ReactNode } from "react";
+import type { TooltipData } from "../hooks/useTooltip";
+import type { TooltipStyle } from "./tooltipUtils";
+/**
+ * Turns what the plot hands the tooltip about the element under the mouse into the content to show
+ * (any value you like), or `undefined` to show nothing.
+ * @param seriesName The name of the series under the mouse
+ * @param time A value that depends on the plot: usually the time under the mouse (see the plot's
+ * documentation)
+ * @param tooltipData The series' data, and the plot's metadata about the element under the mouse
+ * @param providerId Which kind of element is under the mouse, for a plot that has several (e.g. the
+ * bar plot)
+ * @return The tooltip's content, or `undefined` to show no tooltip
+ * @template D The type of the series' datum
+ * @template M The type of the plot's tooltip metadata
+ * @template C The type of the tooltip's content
+ */
+export type TooltipCapture<D, M, C> = (seriesName: string, time: number, tooltipData: TooltipData<D, M>, providerId?: string) => C | undefined;
+/**
+ * The properties of the {@link TooltipContent}
+ * @template D The type of the series' datum
+ * @template M The type of the plot's tooltip metadata
+ * @template C The type of the tooltip's content
+ */
+export interface TooltipContentProps<D, M, C> {
+    /**
+     * Turns what the plot hands the tooltip into the tooltip's content. Called on every mouse move
+     * over an element, so keep it quick -- and copy what you need out of the series, which the data
+     * source keeps changing.
+     */
+    capture: TooltipCapture<D, M, C>;
+    /**
+     * Renders the content (inside the tooltip's box)
+     * @param content The content returned by `capture`
+     * @param style The tooltip's style
+     * @return What to show in the tooltip's box
+     */
+    children: (content: C, style: TooltipStyle) => ReactNode;
+    /**
+     * Overrides of the style of the enclosing {@link Tooltip}
+     */
+    style?: Partial<TooltipStyle>;
+    /**
+     * Additional CSS for the tooltip's box (e.g. its line height)
+     */
+    boxStyle?: CSSProperties;
+    /**
+     * Where the tooltip's top goes (relative to the chart), given its content and its rendered
+     * height -- for a tooltip that isn't placed below the mouse (e.g. one centered on a raster
+     * plot's row). By default, the tooltip goes just below the mouse.
+     */
+    topFor?: (content: C, height: number) => number;
+}
+/**
+ * The building block of every tooltip's content. Put a component built on it inside a
+ * {@link Tooltip}, and when the mouse moves over one of the plot's elements, it calls `capture` with
+ * what the plot knows about that element, and shows what `children` renders, in a box next to the
+ * mouse (styled like the enclosing `<Tooltip>`). It hides again when the mouse leaves the element.
+ *
+ * Under the hood, it registers the chart's tooltip-content provider (one per chart: registering
+ * replaces the previous one), and a mouse-leave handler, and renders its box as a React portal on
+ * the page's `body`, which `useTooltipPlacement` places next to the mouse once it's rendered
+ * (and so its size is known).
+ * @example
+ * function MyScatterTooltip(): JSX.Element {
+ *     return (
+ *         <TooltipContent<Datum, ScatterTooltipMetadata, {seriesName: string, count: number}>
+ *             capture={(seriesName, _time, {series}) => ({seriesName, count: series.length})}
+ *         >
+ *             {({seriesName, count}) => <div>{seriesName}: {count} points</div>}
+ *         </TooltipContent>
+ *     )
+ * }
+ * @param props The capture and render functions, and the style
+ * @return The tooltip's box (a portal), or `null` when nothing is hovered
+ * @template D The type of the series' datum
+ * @template M The type of the plot's tooltip metadata
+ * @template C The type of the tooltip's content
+ */
+export declare function TooltipContent<D, M, C>(props: TooltipContentProps<D, M, C>): ReactElement | null;
+//# sourceMappingURL=TooltipContent.d.ts.map

package/dist/app/charts/tooltips/TooltipContent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TooltipContent.d.ts","sourceRoot":"","sources":["../../../../src/app/charts/tooltips/TooltipContent.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,aAAa,EAAE,KAAK,YAAY,EAAE,KAAK,SAAS,EAAuC,MAAM,OAAO,CAAC;AAIlH,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,qBAAqB,CAAC;AAIrD,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,gBAAgB,CAAC;AAIjD;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAClC,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,MAAM,EACZ,WAAW,EAAE,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,EAC9B,UAAU,CAAC,EAAE,MAAM,KAClB,CAAC,GAAG,SAAS,CAAA;AAElB;;;;;GAKG;AACH,MAAM,WAAW,mBAAmB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC;IACxC;;;;OAIG;IACH,OAAO,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;IAChC;;;;;OAKG;IACH,QAAQ,EAAE,CAAC,OAAO,EAAE,CAAC,EAAE,KAAK,EAAE,YAAY,KAAK,SAAS,CAAA;IACxD;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,CAAA;IAC7B;;OAEG;IACH,QAAQ,CAAC,EAAE,aAAa,CAAA;IACxB;;;;OAIG;IACH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,KAAK,MAAM,CAAA;CAClD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,YAAY,GAAG,IAAI,CAiFhG"}

package/dist/app/charts/tooltips/TooltipContent.js

@@ -0,0 +1,99 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { useEffect, useMemo, useRef, useState } from "react";
+import { createPortal } from "react-dom";
+import { useChart } from "../hooks/useChart";
+import { usePlotDimensions } from "../hooks/usePlotDimensions";
+import { withAlpha } from "../styling/canvasStyle";
+import { tooltipAnchorFor, useTooltipPlacement } from "./useTooltipPlacement";
+import { useTooltipStyle } from "./useTooltipStyle";
+/**
+ * The building block of every tooltip's content. Put a component built on it inside a
+ * {@link Tooltip}, and when the mouse moves over one of the plot's elements, it calls `capture` with
+ * what the plot knows about that element, and shows what `children` renders, in a box next to the
+ * mouse (styled like the enclosing `<Tooltip>`). It hides again when the mouse leaves the element.
+ *
+ * Under the hood, it registers the chart's tooltip-content provider (one per chart: registering
+ * replaces the previous one), and a mouse-leave handler, and renders its box as a React portal on
+ * the page's `body`, which `useTooltipPlacement` places next to the mouse once it's rendered
+ * (and so its size is known).
+ * @example
+ * function MyScatterTooltip(): JSX.Element {
+ *     return (
+ *         <TooltipContent<Datum, ScatterTooltipMetadata, {seriesName: string, count: number}>
+ *             capture={(seriesName, _time, {series}) => ({seriesName, count: series.length})}
+ *         >
+ *             {({seriesName, count}) => <div>{seriesName}: {count} points</div>}
+ *         </TooltipContent>
+ *     )
+ * }
+ * @param props The capture and render functions, and the style
+ * @return The tooltip's box (a portal), or `null` when nothing is hovered
+ * @template D The type of the series' datum
+ * @template M The type of the plot's tooltip metadata
+ * @template C The type of the tooltip's content
+ */
+export function TooltipContent(props) {
+    var _a;
+    const { capture, children, style, boxStyle, topFor } = props;
+    const { chartId, canvas, tooltip, mouse } = useChart();
+    const { registerTooltipContentProvider } = tooltip;
+    const { registerMouseLeaveHandler, unregisterMouseLeaveHandler } = mouse;
+    const { margin, plotDimensions } = usePlotDimensions();
+    const enclosingStyle = useTooltipStyle();
+    const tooltipStyle = useMemo(() => ({ ...enclosingStyle, ...style }), [enclosingStyle, style]);
+    // what's shown, and where (null when nothing is hovered)
+    const [shown, setShown] = useState(null);
+    const tooltipRef = useRef(null);
+    // the latest capture and placement functions, so that the registered provider always uses the
+    // current ones without having to be registered again whenever they change
+    const captureRef = useRef(capture);
+    const topForRef = useRef(topFor);
+    useEffect(() => {
+        captureRef.current = capture;
+        topForRef.current = topFor;
+    });
+    // the plot calls the provider whenever the mouse is over one of its elements
+    useEffect(() => {
+        if (canvas === null)
+            return;
+        registerTooltipContentProvider((seriesName, time, tooltipData, mouseCoords, providerId) => {
+            const content = captureRef.current(seriesName, time, tooltipData, providerId);
+            if (content === undefined) {
+                setShown(null);
+                return;
+            }
+            const placeTop = topForRef.current;
+            const anchor = tooltipAnchorFor(mouseCoords, canvas, placeTop !== undefined ? height => placeTop(content, height) : undefined);
+            setShown({ content, anchor });
+        });
+    }, [canvas, registerTooltipContentProvider]);
+    // hides the tooltip when the mouse leaves the element
+    useEffect(() => {
+        const handlerId = `tooltip-content-leave-${chartId}`;
+        registerMouseLeaveHandler(handlerId, () => setShown(null));
+        return () => unregisterMouseLeaveHandler(handlerId);
+    }, [chartId, registerMouseLeaveHandler, unregisterMouseLeaveHandler]);
+    // places the tooltip next to the mouse, once it's rendered (and so its size is known)
+    useTooltipPlacement(tooltipRef, (_a = shown === null || shown === void 0 ? void 0 : shown.anchor) !== null && _a !== void 0 ? _a : null, plotDimensions, margin, tooltipStyle);
+    if (shown === null)
+        return null;
+    const tooltipBoxStyle = {
+        position: 'fixed',
+        // (placed next to the mouse, from its rendered size, by `useTooltipPlacement`, before it's
+        // painted)
+        left: 0,
+        top: 0,
+        backgroundColor: withAlpha(tooltipStyle.backgroundColor, tooltipStyle.backgroundOpacity),
+        border: `${tooltipStyle.borderWidth}px solid ${withAlpha(tooltipStyle.borderColor, tooltipStyle.borderOpacity)}`,
+        borderRadius: tooltipStyle.borderRadius,
+        padding: `${tooltipStyle.paddingTop}px ${tooltipStyle.paddingRight}px ${tooltipStyle.paddingBottom}px ${tooltipStyle.paddingLeft}px`,
+        fontFamily: tooltipStyle.fontFamily,
+        fontSize: tooltipStyle.fontSize,
+        color: tooltipStyle.fontColor,
+        pointerEvents: 'none',
+        zIndex: 9999,
+        ...boxStyle,
+    };
+    return createPortal(_jsx("div", { ref: tooltipRef, style: tooltipBoxStyle, children: children(shown.content, tooltipStyle) }), document.body);
+}
+//# sourceMappingURL=TooltipContent.js.map

package/dist/app/charts/tooltips/TooltipContent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TooltipContent.js","sourceRoot":"","sources":["../../../../src/app/charts/tooltips/TooltipContent.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAwD,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAC,MAAM,OAAO,CAAC;AAClH,OAAO,EAAC,YAAY,EAAC,MAAM,WAAW,CAAC;AACvC,OAAO,EAAC,QAAQ,EAAC,MAAM,mBAAmB,CAAC;AAC3C,OAAO,EAAC,iBAAiB,EAAC,MAAM,4BAA4B,CAAC;AAI7D,OAAO,EAAC,SAAS,EAAC,MAAM,wBAAwB,CAAC;AAEjD,OAAO,EAAC,gBAAgB,EAAsB,mBAAmB,EAAC,MAAM,uBAAuB,CAAC;AAChG,OAAO,EAAC,eAAe,EAAC,MAAM,mBAAmB,CAAC;AA2DlD;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,UAAU,cAAc,CAAU,KAAmC;;IACvE,MAAM,EAAC,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAC,GAAG,KAAK,CAAA;IAE1D,MAAM,EAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAC,GAAG,QAAQ,EAA8C,CAAA;IAChG,MAAM,EAAC,8BAA8B,EAAC,GAAG,OAAO,CAAA;IAChD,MAAM,EAAC,yBAAyB,EAAE,2BAA2B,EAAC,GAAG,KAAK,CAAA;IACtE,MAAM,EAAC,MAAM,EAAE,cAAc,EAAC,GAAG,iBAAiB,EAAE,CAAA;IAEpD,MAAM,cAAc,GAAG,eAAe,EAAE,CAAA;IACxC,MAAM,YAAY,GAAG,OAAO,CAAe,GAAG,EAAE,CAAC,CAAC,EAAC,GAAG,cAAc,EAAE,GAAG,KAAK,EAAC,CAAC,EAAE,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC,CAAA;IAE1G,yDAAyD;IACzD,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,CAA+C,IAAI,CAAC,CAAA;IACtF,MAAM,UAAU,GAAG,MAAM,CAAiB,IAAI,CAAC,CAAA;IAE/C,8FAA8F;IAC9F,0EAA0E;IAC1E,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,CAAA;IAClC,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,CAAA;IAChC,SAAS,CAAC,GAAG,EAAE;QACX,UAAU,CAAC,OAAO,GAAG,OAAO,CAAA;QAC5B,SAAS,CAAC,OAAO,GAAG,MAAM,CAAA;IAC9B,CAAC,CAAC,CAAA;IAEF,6EAA6E;IAC7E,SAAS,CACL,GAAG,EAAE;QACD,IAAI,MAAM,KAAK,IAAI;YAAE,OAAM;QAC3B,8BAA8B,CAAC,CAAC,UAAU,EAAE,IAAI,EAAE,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,EAAE;YACtF,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC,UAAU,EAAE,IAAI,EAAE,WAAW,EAAE,UAAU,CAAC,CAAA;YAC7E,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;gBACxB,QAAQ,CAAC,IAAI,CAAC,CAAA;gBACd,OAAM;YACV,CAAC;YACD,MAAM,QAAQ,GAAG,SAAS,CAAC,OAAO,CAAA;YAClC,MAAM,MAAM,GAAG,gBAAgB,CAC3B,WAAW,EAAE,MAAM,EACnB,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAC3E,CAAA;YACD,QAAQ,CAAC,EAAC,OAAO,EAAE,MAAM,EAAC,CAAC,CAAA;QAC/B,CAAC,CAAC,CAAA;IACN,CAAC,EACD,CAAC,MAAM,EAAE,8BAA8B,CAAC,CAC3C,CAAA;IAED,sDAAsD;IACtD,SAAS,CACL,GAAG,EAAE;QACD,MAAM,SAAS,GAAG,yBAAyB,OAAO,EAAE,CAAA;QACpD,yBAAyB,CAAC,SAAS,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAA;QAC1D,OAAO,GAAG,EAAE,CAAC,2BAA2B,CAAC,SAAS,CAAC,CAAA;IACvD,CAAC,EACD,CAAC,OAAO,EAAE,yBAAyB,EAAE,2BAA2B,CAAC,CACpE,CAAA;IAED,sFAAsF;IACtF,mBAAmB,CAAC,UAAU,EAAE,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,MAAM,mCAAI,IAAI,EAAE,cAAc,EAAE,MAAM,EAAE,YAAY,CAAC,CAAA;IAE5F,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,IAAI,CAAA;IAE/B,MAAM,eAAe,GAAkB;QACnC,QAAQ,EAAE,OAAO;QACjB,2FAA2F;QAC3F,WAAW;QACX,IAAI,EAAE,CAAC;QACP,GAAG,EAAE,CAAC;QACN,eAAe,EAAE,SAAS,CAAC,YAAY,CAAC,eAAe,EAAE,YAAY,CAAC,iBAAiB,CAAC;QACxF,MAAM,EAAE,GAAG,YAAY,CAAC,WAAW,YAAY,SAAS,CAAC,YAAY,CAAC,WAAW,EAAE,YAAY,CAAC,aAAa,CAAC,EAAE;QAChH,YAAY,EAAE,YAAY,CAAC,YAAY;QACvC,OAAO,EAAE,GAAG,YAAY,CAAC,UAAU,MAAM,YAAY,CAAC,YAAY,MAAM,YAAY,CAAC,aAAa,MAAM,YAAY,CAAC,WAAW,IAAI;QACpI,UAAU,EAAE,YAAY,CAAC,UAAU;QACnC,QAAQ,EAAE,YAAY,CAAC,QAAQ;QAC/B,KAAK,EAAE,YAAY,CAAC,SAAS;QAC7B,aAAa,EAAE,MAAM;QACrB,MAAM,EAAE,IAAI;QACZ,GAAG,QAAQ;KACd,CAAA;IACD,OAAO,YAAY,CACf,cAAK,GAAG,EAAE,UAAU,EAAE,KAAK,EAAE,eAAe,YAAG,QAAQ,CAAC,KAAK,CAAC,OAAO,EAAE,YAAY,CAAC,GAAO,EAC3F,QAAQ,CAAC,IAAI,CAChB,CAAA;AACL,CAAC"}

package/dist/app/charts/tooltips/tooltipUtils.d.ts

@@ -1,6 +1,8 @@
-import { Series } from "../plots/plot";
-import { Dimensions, Margin } from "../styling/margins";
-import { OrdinalStringAxis } from "../axes/axes";
+import type { Series } from "../plots/plot";
+import type { Dimensions, Margin } from "../styling/margins";
+import type { OrdinalStringAxis } from "../axes/axes";
+import type { ScaleContinuousNumeric } from "d3";
+import type { Datum } from "../series/timeSeries";
 /**
  * Properties for rendering the tooltip. This is the style for the container
  * of the content.
@@ -40,52 +42,48 @@ export interface TooltipStyle {
     paddingTop: number;
     paddingBottom: number;
 }
-export declare const defaultTooltipStyle: TooltipStyle;
-export interface TooltipDimensions {
-    x: number;
-    y: number;
-    contentWidth: number;
-    contentHeight: number;
-}
 /**
- * Removes the tooltip when the mouse has moved away from the spike
+ * The default tooltip style
  */
-export declare function removeTooltip(): void;
+export declare const defaultTooltipStyle: TooltipStyle;
 /**
- * Calculates the x-coordinate of the upper left-hand side of the tooltip rectangle (obviously without
- * "rounded corners"). Adjusts the x-coordinate so that tooltip is visible on the edges of the plot.
- * @param x The current x-coordinate of the mouse
- * @param textWidth The width of the tooltip text
+ * Calculates the x-coordinate of the left side of the tooltip. The tooltip goes to the right of the
+ * mouse, unless it would run past the right edge of the plot, in which case it goes to the left of
+ * the mouse (and never past the left edge of the chart).
+ * @param x The x-coordinate of the mouse, relative to the chart
+ * @param width The tooltip's (rendered) width, including its padding and border
  * @param plotDimensions The dimensions of the plot
- * @param tooltipStyle The tooltip style information
+ * @param tooltipStyle The tooltip style information (its left padding is used as the gap between
+ * the mouse and the tooltip)
  * @param margin The plot margin
- * @return The x-coordinate of the lower left-hand side of the tooltip rectangle
+ * @return The x-coordinate of the tooltip's left side, relative to the chart
  */
-export declare function tooltipX(x: number, textWidth: number, plotDimensions: Dimensions, tooltipStyle: TooltipStyle, margin: Margin): number;
+export declare function tooltipX(x: number, width: number, plotDimensions: Dimensions, tooltipStyle: TooltipStyle, margin: Margin): number;
 /**
- * Calculates the y-coordinate of the upper-left-hand corner of the tooltip rectangle. Adjusts the y-coordinate
- * so that the tooltip is visible on the upper edge of the plot
- * @param y The y-coordinate of the mouse
- * @param textHeight The height of the header and neuron ID text
+ * Calculates the y-coordinate of the top of the tooltip. The tooltip goes below the mouse, unless it
+ * would run past the bottom of the plot, in which case it's moved up so that its bottom lines up
+ * with the plot's bottom (and never past the top edge of the chart).
+ * @param y The y-coordinate of the mouse, relative to the chart
+ * @param height The tooltip's (rendered) height, including its padding and border
  * @param plotDimensions The dimensions of the plot
- * @param tooltipStyle The tooltip style information
+ * @param tooltipStyle The tooltip style information (its top padding is used as the gap between
+ * the mouse and the tooltip)
  * @param margin The plot margin
- * @return The y-coordinate of the lower-left-hand corner of the tooltip rectangle
+ * @return The y-coordinate of the tooltip's top, relative to the chart
  */
-export declare function tooltipY(y: number, textHeight: number, plotDimensions: Dimensions, tooltipStyle: TooltipStyle, margin: Margin): number;
+export declare function tooltipY(y: number, height: number, plotDimensions: Dimensions, tooltipStyle: TooltipStyle, margin: Margin): number;
 /**
- * Calculates the y-coordinate for the upper-left-hand the tooltip rectangle. Adjusts the y-coordinate so
- * that the tooltip is visible on the upper and lower edges of the plot
- * @param seriesName The name of the series
- * @param textHeight The height of the header and neuron ID text
+ * Calculates the y-coordinate of the top of a tooltip for a category (e.g. a raster plot's row):
+ * the tooltip is centered on the category, but kept within the plot's top and bottom edges.
+ * @param seriesName The name of the series (the category)
+ * @param height The tooltip's (rendered) height, including its padding and border
  * @param axis The category axis for determining the y-value of the tooltip
- * @param tooltipStyle The tooltip style
  * @param margin The plot margin
  * @param categoryHeight The height (in pixels) of the category
  * @param plotDimensions The dimensions of the plot
- * @return The y-coordinate of the lower-left-hand corner of the tooltip rectangle
+ * @return The y-coordinate of the tooltip's top, relative to the chart
  */
-export declare function categoryTooltipY(seriesName: string, textHeight: number, axis: OrdinalStringAxis, tooltipStyle: TooltipStyle, margin: Margin, categoryHeight: number, plotDimensions: Dimensions): number;
+export declare function categoryTooltipY(seriesName: string, height: number, axis: OrdinalStringAxis, margin: Margin, categoryHeight: number, plotDimensions: Dimensions): number;
 /**
  * Returns the (time, value) point that comes just before the mouse and just after the mouse
  * @param data The time-series data
@@ -93,9 +91,161 @@ export declare function categoryTooltipY(seriesName: string, textHeight: number,
  * @param xFrom A function that extracts the x-value from the datum
  * @param emptyDatum A function that returns an empty datum
  * @template D The type of the datum in the data-series
- * @return {[[number, number], [number, number]]} the (time, value) point that comes just before
- * the mouse and just after the mouse. If the mouse is after the last point, then the "after" point
- * is `[NaN, NaN]`. If the mouse is before the first point, then the "before" point is `[NaN, NaN]`.
+ * @return The point that comes just before the mouse and just after the mouse. If the mouse is
+ * after the last point, then the "after" point is the empty datum. If the mouse is before the
+ * first point, then the "before" point is the empty datum. (Both are, for an empty series.)
  */
 export declare function boundingPoints<D>(data: Series<D>, value: number, xFrom: (value: D) => number, emptyDatum: () => D): [D, D];
+/**
+ * Finds the first point whose x-value is within the tolerance of the specified value, along with
+ * the points before and after it
+ * @param data The series' data
+ * @param value The x-value to look for
+ * @param tolerance How far (in the x-value's units) a point's x-value may be from the value
+ * @param xFrom A function that extracts the x-value from the datum
+ * @param emptyDatum A function that returns an empty datum (for a point that doesn't exist)
+ * @return The point before, the point, the point after, and the point's index (-1 when no point
+ * is within the tolerance, in which case the point and the point before are empty, and the point
+ * after is the series' first point)
+ * @template D The type of the datum in the data-series
+ */
 export declare function findPointAndNeighbors<D>(data: Series<D>, value: number, tolerance: number, xFrom: (value: D) => number, emptyDatum: () => D): [D, D, D, number];
+/**
+ * The points of a scatter series that a tooltip shows (and the plot highlights), depending on
+ * where the mouse is over the series:
+ * - directly over a data point: that `point`, along with the points `before` and `after` it
+ * - over a line segment between two points: the points `before` and `after` the mouse
+ *
+ * `before` and `after` are undefined when there's no such point (e.g. before the first point).
+ */
+export type ScatterTooltipPoints = {
+    kind: 'point';
+    before?: Datum;
+    point: Datum;
+    after?: Datum;
+} | {
+    kind: 'segment';
+    before?: Datum;
+    after?: Datum;
+};
+/**
+ * The scatter plot's tooltip metadata: the points the tooltip shows
+ */
+export interface ScatterTooltipMetadata {
+    points: ScatterTooltipPoints;
+}
+/**
+ * Determines which of a scatter series' points a tooltip shows, from where the mouse is: when the
+ * mouse is over a data point, that point (and its neighbors); otherwise the points on either side
+ * of the mouse (the segment it's over).
+ *
+ * The mouse is over a point when it's within `pointRadius` pixels of it -- or, when the point's
+ * nearest neighbor is closer than three times that, within a third of the way to that neighbor.
+ * Otherwise, with dense data (points a few pixels apart), the mouse would almost always be within
+ * the radius of some point, and the segments between them could hardly be hovered at all.
+ * @param data The series' data, ordered by x
+ * @param mouse The mouse's coordinates, within the plot area (i.e. in the axes' ranges)
+ * @param xScale The series' x-axis scale
+ * @param yScale The series' y-axis scale
+ * @param pointRadius How close (in pixels) the mouse must be to a data point to be over it
+ * @return The points the tooltip shows
+ */
+export declare function scatterTooltipPoints(data: {
+    length: number;
+    [index: number]: Datum;
+}, mouse: [x: number, y: number], xScale: ScaleContinuousNumeric<number, number>, yScale: ScaleContinuousNumeric<number, number>, pointRadius: number): ScatterTooltipPoints;
+/**
+ * The points a scatter tooltip shows, as a list (e.g. for highlighting them)
+ * @param points The points the tooltip shows
+ * @return The points, in order
+ */
+export declare function scatterTooltipPointList(points: ScatterTooltipPoints): Array<Datum>;
+/**
+ * A sparkline: a small line chart of a series' values over time (e.g. for a tooltip), as an SVG
+ * path, and where its last point is
+ */
+export interface Sparkline {
+    path: string;
+    end: [x: number, y: number];
+    mark?: [x: number, y: number];
+}
+/**
+ * Creates a sparkline of the specified (time-ordered) values: time runs left to right across the
+ * width, and the values are scaled to fill the height (the highest at the top). Values that
+ * aren't finite are skipped.
+ *
+ * A long series is reduced to (at most) four points per pixel column -- the column's first,
+ * lowest, highest, and last values, in the order they occurred -- so that the path stays small,
+ * while still tracing the line's true shape, spikes included.
+ * @param data The values, ordered by time
+ * @param width The sparkline's width (in pixels)
+ * @param height The sparkline's height (in pixels)
+ * @param padding The space (in pixels) to leave around the line, within the width and height
+ * @param valueRange The (fixed) range of values the height spans (values outside it are drawn at
+ * its edge) -- by default, the range of the values themselves
+ * @param markedTime The time of a point to mark (e.g. the hovered point), whose position is
+ * returned as the sparkline's `mark` -- by default, none
+ * @return The sparkline, or `undefined` when there are fewer than two values to draw
+ */
+export declare function sparklineFor(data: {
+    length: number;
+    [index: number]: {
+        time: number;
+        value: number;
+    };
+}, width: number, height: number, padding?: number, valueRange?: [min: number, max: number], markedTime?: number): Sparkline | undefined;
+/**
+ * The raster plot's tooltip metadata: all of the hovered series' spikes that the chart holds (the
+ * tooltip data's `series` holds just the hovered spike)
+ */
+export interface RasterTooltipMetadata {
+    spikes: Series<Datum>;
+}
+/**
+ * Statistics of a series' (time, value) points -- e.g. a raster chart's spikes, or a scatter
+ * chart's points -- over the window of data that the chart holds. Those that need at least two
+ * points are undefined when there's only one.
+ */
+export interface SeriesStatistics {
+    count: number;
+    meanValue: number | undefined;
+    valueStandardDeviation: number | undefined;
+    meanInterval: number | undefined;
+}
+/**
+ * Calculates the statistics of a series' (time, value) points: their count, the mean and the
+ * (sample) standard deviation of their values, and the mean time between consecutive points.
+ * Points whose value or time isn't finite are skipped.
+ * @param spikes The points (e.g. spikes), ordered by time
+ * @return The statistics
+ */
+export declare function seriesStatistics(spikes: {
+    length: number;
+    [index: number]: Datum;
+}): SeriesStatistics;
+/**
+ * Formats a value, or shows a dash when there isn't one (e.g. the standard deviation of a single
+ * point)
+ * @param value The value, if there is one
+ * @param formatter Formats the value
+ * @return The formatted value, or a dash
+ */
+export declare function valueOrMissing(value: number | undefined, formatter: (value: number) => string): string;
+/**
+ * Calculates the (sample) autocorrelation of a series' values, by lag: for each lag `k` (in
+ * points, not time -- a series' points needn't be evenly spaced in time), the correlation between
+ * the values and the values `k` points later,
+ * <p>`r[k] = sum[t](x[t] - mean) * (x[t+k] - mean) / sum[t](x[t] - mean)^2`</p>
+ * so `r[0]` is 1, and the values are between -1 and 1. Points whose value or time isn't finite are
+ * skipped.
+ * @param points The series' points, ordered by time
+ * @param maxLag The largest lag -- by default, a quarter of the number of points (the usual rule
+ * of thumb, since the estimates for larger lags rest on too few pairs of points), but no more than 50
+ * @return The autocorrelation for each lag, from 0 to the largest lag, or `undefined` when there
+ * are fewer than four points (so no lag beyond 0), or the values don't vary
+ */
+export declare function autocorrelation(points: {
+    length: number;
+    [index: number]: Datum;
+}, maxLag?: number): Array<number> | undefined;
+//# sourceMappingURL=tooltipUtils.d.ts.map

package/dist/app/charts/tooltips/tooltipUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tooltipUtils.d.ts","sourceRoot":"","sources":["../../../../src/app/charts/tooltips/tooltipUtils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,eAAe,CAAC;AAC1C,OAAO,KAAK,EAAC,UAAU,EAAE,MAAM,EAAC,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,cAAc,CAAC;AACpD,OAAO,KAAK,EAAC,sBAAsB,EAAC,MAAM,IAAI,CAAC;AAC/C,OAAO,KAAK,EAAC,KAAK,EAAC,MAAM,sBAAsB,CAAC;AAGhD;;;GAGG;AACH,MAAM,WAAW,YAAY;IACzB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAA;IAEhB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB,iBAAiB,EAAE,MAAM,CAAC;IAE1B,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IAErB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,eAAO,MAAM,mBAAmB,EAAE,YAsBjC,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAMjI;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAMlI;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,gBAAgB,CAC5B,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,iBAAiB,EACvB,MAAM,EAAE,MAAM,EACd,cAAc,EAAE,MAAM,EACtB,cAAc,EAAE,UAAU,GAC3B,MAAM,CAKR;AA4BD;;;;;;;;;;GAUG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,MAAM,EAAE,UAAU,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAe1H;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,qBAAqB,CAAC,CAAC,EACnC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,EACf,KAAK,EAAE,MAAM,EACb,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,MAAM,EAC3B,UAAU,EAAE,MAAM,CAAC,GACpB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,CAOnB;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,oBAAoB,GAC1B;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,MAAM,CAAC,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,KAAK,CAAC;IAAC,KAAK,CAAC,EAAE,KAAK,CAAA;CAAE,GAC9D;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,MAAM,CAAC,EAAE,KAAK,CAAC;IAAC,KAAK,CAAC,EAAE,KAAK,CAAA;CAAE,CAAA;AAExD;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACnC,MAAM,EAAE,oBAAoB,CAAA;CAC/B;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,oBAAoB,CAChC,IAAI,EAAE;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,CAAA;CAAE,EAChD,KAAK,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,CAAC,EAC7B,MAAM,EAAE,sBAAsB,CAAC,MAAM,EAAE,MAAM,CAAC,EAC9C,MAAM,EAAE,sBAAsB,CAAC,MAAM,EAAE,MAAM,CAAC,EAC9C,WAAW,EAAE,MAAM,GACpB,oBAAoB,CAiCtB;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,oBAAoB,GAAG,KAAK,CAAC,KAAK,CAAC,CAKlF;AAED;;;GAGG;AACH,MAAM,WAAW,SAAS;IAEtB,IAAI,EAAE,MAAM,CAAA;IAEZ,GAAG,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,CAAC,CAAA;IAE3B,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,CAAC,CAAA;CAChC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,YAAY,CACxB,IAAI,EAAE;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,CAAC,KAAK,EAAE,MAAM,GAAG;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,EAC1E,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,MAAU,EACnB,UAAU,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,CAAC,EACvC,UAAU,CAAC,EAAE,MAAM,GACpB,SAAS,GAAG,SAAS,CAyDvB;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IAClC,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,CAAA;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAE7B,KAAK,EAAE,MAAM,CAAA;IAEb,SAAS,EAAE,MAAM,GAAG,SAAS,CAAA;IAE7B,sBAAsB,EAAE,MAAM,GAAG,SAAS,CAAA;IAE1C,YAAY,EAAE,MAAM,GAAG,SAAS,CAAA;CACnC;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,CAAA;CAAE,GAAG,gBAAgB,CAmBrG;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,EAAE,SAAS,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,GAAG,MAAM,CAEtG;AAKD;;;;;;;;;;;;GAYG;AACH,wBAAgB,eAAe,CAC3B,MAAM,EAAE;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,CAAA;CAAE,EAClD,MAAM,CAAC,EAAE,MAAM,GAChB,KAAK,CAAC,MAAM,CAAC,GAAG,SAAS,CAqB3B"}