@k2b/ui 0.27.0 → 0.29.0

package/dist/browser/content/chart-inspection-core.js

@@ -0,0 +1,557 @@
+import { positionTooltipSurface } from "../feedback/tooltip-position";
+export const sameChartDatum = (a, b) => a.role === b.role && a.index === b.index && a.seriesIndex === b.seriesIndex;
+const object = value => typeof value === "object" && value !== null;
+const pair = value => Array.isArray(value) && value.length === 2 && value.every(n => typeof n === "number" && Number.isFinite(n));
+const roles = new Set(["point", "item", "bin", "box", "outlier", "value", "cell", "interval"]);
+export function isChartDatum(value) {
+  return object(value) && Number.isInteger(value.index) && typeof value.index === "number" && value.index >= 0 && (value.seriesIndex === undefined || typeof value.seriesIndex === "number" && Number.isInteger(value.seriesIndex) && value.seriesIndex >= 0) && typeof value.role === "string" && roles.has(value.role) && pair(value.anchor) && (value.grid === undefined || pair(value.grid)) && (value.label === undefined || typeof value.label === "string") && Array.isArray(value.values) && value.values.every(field => object(field) && typeof field.key === "string" && (typeof field.value === "string" || typeof field.value === "number" && Number.isFinite(field.value)) && (field.formatted === undefined || typeof field.formatted === "string"));
+}
+
+/** Adds or removes only the tooltip id, keeping descriptions the host put on the container. */
+const describe = (container, id, on) => {
+  const ids = (container.getAttribute("aria-describedby") ?? "").split(/\s+/).filter(token => token && token !== id);
+  if (on) ids.push(id);
+  if (ids.length) container.setAttribute("aria-describedby", ids.join(" "));else container.removeAttribute("aria-describedby");
+};
+
+/** Enhances existing SVG nodes. Pointer/focus changes never rebuild the chart. */
+export function createChartInspector(options) {
+  const source = Symbol("chart cursor");
+  let entries;
+  let sortedPoints = [];
+  const byElement = new Map();
+  let active;
+  let highlighted = [];
+  let pinned = false;
+  let pointerStart;
+  let moved = false;
+  let pending;
+  let frame;
+  // The cursor this chart is subscribed to. Closing reads it instead of the cursor prop: a chart also closes
+  // while it unmounts, when a parent `<Show>` may already have dropped the value the prop came from.
+  let linkedCursor;
+  const records = () => {
+    if (!entries || entries.length > 0 && !entries[0].element.isConnected) {
+      entries = [];
+      byElement.clear();
+      sortedPoints = [];
+      for (const element of Array.from(options.container()?.querySelectorAll("[data-chart-datum]") ?? [])) {
+        try {
+          const value = JSON.parse(element.getAttribute("data-chart-datum") ?? "null");
+          if (isChartDatum(value)) {
+            const entry = {
+              element,
+              datum: value
+            };
+            entries.push(entry);
+            byElement.set(element, entry);
+          }
+        } catch {
+          /* Only valid renderer metadata participates in inspection. */
+        }
+      }
+      sortedPoints = entries.filter(entry => entry.datum.role === "point").sort((a, b) => a.datum.anchor[0] - b.datum.anchor[0]);
+    }
+    return entries;
+  };
+  const highlightColor = item => {
+    // Read the actual paint before applying inspection styles, including
+    // custom series and threshold colors. Invisible points use their line.
+    const point = item.element.querySelector(".stdlib-chart-inspection-point");
+    const source = point ? options.container()?.querySelector(options.kind() === "line" ? `.stdlib-chart-line.stdlib-chart-series-${(item.datum.seriesIndex ?? 0) % 8}` : ".stdlib-chart-sparkline, .stdlib-chart-stat-sparkline") : item.element.querySelector(".stdlib-chart-bar-gauge-fill, .stdlib-chart-gauge-fill, .stdlib-chart-stat-value") ?? item.element.querySelector("rect, path, circle");
+    const paint = source ? source.ownerDocument.defaultView?.getComputedStyle(source) : undefined;
+    const color = (point || item.element.hasAttribute("data-chart-reference") ? paint?.stroke : paint?.fill) || `var(--stdlib-chart-c${(item.datum.seriesIndex ?? 0) % 8 + 1})`;
+    return `color-mix(in srgb, ${color} 72%, var(--k2b-chart-highlight-mix))`;
+  };
+  const selectData = selected => {
+    for (const entry of records()) {
+      const matches = selected.some(datum => sameChartDatum(datum, entry.datum));
+      if (matches) entry.element.style.setProperty("--k2b-chart-selection-color", highlightColor(entry));else entry.element.style.removeProperty("--k2b-chart-selection-color");
+      entry.element.toggleAttribute("data-selected", matches);
+    }
+  };
+  const screenPoint = entry => {
+    const matrix = entry.element.getScreenCTM?.();
+    const [x, y] = entry.datum.anchor;
+    if (matrix) return {
+      x: matrix.a * x + matrix.c * y + matrix.e,
+      y: matrix.b * x + matrix.d * y + matrix.f
+    };
+    const rect = entry.element.getBoundingClientRect();
+    return {
+      x: rect.x + rect.width / 2,
+      y: rect.y + rect.height / 2
+    };
+  };
+  const visibleRecords = () => {
+    const nodes = records();
+    if (options.kind() !== "map") return nodes;
+    const viewport = options.container()?.querySelector(".stdlib-chart-map-viewport");
+    if (!viewport?.getScreenCTM?.()) return nodes;
+    const root = viewport.ownerSVGElement?.getBoundingClientRect();
+    if (!root?.width || !root.height) return nodes;
+    const width = viewport?.width?.baseVal.value;
+    const height = viewport?.height?.baseVal.value;
+    if (!width || !height) return nodes;
+    const left = root.left + viewport.x.baseVal.value;
+    const top = root.top + viewport.y.baseVal.value;
+    const clip = {
+      left,
+      top,
+      right: left + width,
+      bottom: top + height
+    };
+    return nodes.filter(entry => {
+      const point = screenPoint(entry);
+      return point.x >= clip.left && point.x <= clip.right && point.y >= clip.top && point.y <= clip.bottom;
+    });
+  };
+  const rawX = entry => entry.datum.values.find(field => field.key === "x")?.value;
+  const seriesChart = () => options.kind() === "line" || options.kind() === "sparkline";
+  const clearHighlight = () => {
+    for (const entry of highlighted) {
+      entry.element.removeAttribute("data-inspected");
+      entry.element.style.removeProperty("--k2b-chart-inspection-color");
+      if (!entry.element.getAttribute("style")) entry.element.removeAttribute("style");
+    }
+    highlighted = [];
+  };
+  const close = (broadcast = true, cancelPending = true) => {
+    const state = linkedCursor?.read();
+    if (broadcast && state && state.source !== source) return;
+    if (broadcast) linkedCursor?.clear(source);
+    options.container()?.removeAttribute("data-cursor-source");
+    pinned = false;
+    active = undefined;
+    clearHighlight();
+    const container = options.container(),
+      id = options.tooltip()?.id;
+    if (container && id) describe(container, id, false);
+    options.container()?.removeAttribute("data-inspecting");
+    const tooltip = options.tooltip();
+    if (tooltip) {
+      try {
+        if (tooltip.matches(":popover-open")) tooltip.hidePopover();
+      } catch {
+        /* Detached during navigation. */
+      }
+    }
+    if (cancelPending) {
+      if (frame !== undefined) cancelAnimationFrame(frame);
+      frame = undefined;
+      pending = undefined;
+    }
+  };
+  const invalidate = () => {
+    options.cursor?.()?.clear(source);
+    close(false);
+    entries = undefined;
+    sortedPoints = [];
+    byElement.clear();
+    receive(options.cursor?.()?.read() ?? null);
+  };
+  const show = (entry, broadcast = true) => {
+    const x = rawX(entry);
+    if (broadcast && options.kind() === "line" && typeof x === "number") options.cursor?.()?.move(source, x);
+    const tooltip = options.tooltip(),
+      anchor = options.anchor(),
+      container = options.container();
+    if (!tooltip || !anchor || !container || !options.enabled()) return;
+    if (active === entry && tooltip.matches(":popover-open")) return;
+    clearHighlight();
+    active = entry;
+    highlighted = options.kind() === "line" ? records().filter(candidate => rawX(candidate) === rawX(entry)) : [entry];
+    for (const item of highlighted) {
+      item.element.style.setProperty("--k2b-chart-inspection-color", highlightColor(item));
+      item.element.setAttribute("data-inspected", "true");
+    }
+    const document = tooltip.ownerDocument;
+    const contents = highlighted.map(item => ({
+      item,
+      content: options.format({
+        kind: options.kind(),
+        datum: item.datum
+      }),
+      missing: false
+    }));
+    if (options.cursor?.() && options.kind() === "line") {
+      const present = new Set(highlighted.map(item => item.datum.seriesIndex));
+      for (const item of records()) {
+        if (present.has(item.datum.seriesIndex)) continue;
+        present.add(item.datum.seriesIndex);
+        contents.push({
+          item,
+          content: options.format({
+            kind: options.kind(),
+            datum: item.datum
+          }),
+          missing: true
+        });
+      }
+      contents.sort((a, b) => (a.item.datum.seriesIndex ?? 0) - (b.item.datum.seriesIndex ?? 0));
+    }
+    tooltip.replaceChildren();
+    const sharedTitle = typeof x === "number" ? options.cursor?.()?.formatX?.(x) : undefined;
+    const commonTitle = sharedTitle ?? (contents.every(({
+      content
+    }) => content.title === contents[0]?.content.title) ? contents[0]?.content.title : undefined);
+    if (commonTitle) {
+      const title = document.createElement("strong");
+      title.className = "k2b-chart__tooltip-title";
+      title.textContent = commonTitle;
+      tooltip.append(title);
+    }
+    for (const {
+      item,
+      content,
+      missing
+    } of contents) {
+      if (content.title && !commonTitle) {
+        const title = document.createElement("strong");
+        title.className = "k2b-chart__tooltip-title";
+        title.textContent = content.title;
+        tooltip.append(title);
+      }
+      for (const row of content.rows) {
+        const line = document.createElement("span");
+        line.className = "k2b-chart__tooltip-row";
+        if (options.kind() === "line") {
+          const swatch = document.createElement("i");
+          swatch.setAttribute("aria-hidden", "true");
+          const series = container.querySelector(`.stdlib-chart-line.stdlib-chart-series-${(item.datum.seriesIndex ?? 0) % 8}`);
+          swatch.style.background = series ? getComputedStyle(series).stroke : `var(--stdlib-chart-c${(item.datum.seriesIndex ?? 0) % 8 + 1})`;
+          line.append(swatch);
+        }
+        const label = document.createElement("span");
+        label.textContent = `${row.label}: `;
+        const value = document.createElement("b");
+        value.textContent = missing ? "—" : row.value;
+        line.append(label, value);
+        tooltip.append(line);
+      }
+    }
+    const rect = container.getBoundingClientRect(),
+      point = screenPoint(entry);
+    anchor.style.left = `${point.x - rect.left}px`;
+    anchor.style.top = `${point.y - rect.top}px`;
+    updatePlotBounds();
+    container.style.setProperty("--k2b-chart-inspection-x", `${point.x - rect.left}px`);
+    container.setAttribute("data-inspecting", seriesChart() ? "series" : "datum");
+    describe(container, tooltip.id, true);
+    try {
+      if (!tooltip.matches(":popover-open")) tooltip.showPopover();
+      positionTooltipSurface(tooltip, anchor);
+    } catch {
+      /* SVG titles remain available without the Popover API. */
+    }
+  };
+  const updatePlotBounds = () => {
+    const container = options.container();
+    if (!container) return;
+    const axes = Array.from(container.querySelectorAll(".stdlib-chart-axis")).map(axis => axis.getBoundingClientRect());
+    if (axes.length < 2) return;
+    const left = Math.min(...axes.map(a => a.left)),
+      right = Math.max(...axes.map(a => a.right));
+    const top = Math.min(...axes.map(a => a.top)),
+      bottom = Math.max(...axes.map(a => a.bottom));
+    if (right <= left || bottom <= top) return;
+    const rect = container.getBoundingClientRect();
+    for (const [name, value] of Object.entries({
+      left: left - rect.left,
+      right: rect.right - right,
+      top: top - rect.top,
+      bottom: rect.bottom - bottom
+    })) container.style.setProperty(`--k2b-chart-plot-${name}`, `${value}px`);
+    return {
+      left,
+      right,
+      top,
+      bottom
+    };
+  };
+  const receive = state => {
+    if (state?.source === source) return;
+    close(false, false);
+    if (!state || options.kind() !== "line") return;
+    const entry = records().find(item => rawX(item) === state.x);
+    if (entry) show(entry, false);
+  };
+  const linkCursor = cursor => {
+    linkedCursor = cursor;
+    const unsubscribe = cursor?.subscribe(receive);
+    return () => {
+      unsubscribe?.();
+      cursor?.clear(source);
+      linkedCursor = undefined;
+    };
+  };
+  const nearest = (x, y, target) => {
+    if (target?.closest("button,a") && !target.closest("[data-chart-datum]")) return;
+    const nodes = visibleRecords();
+    // A mark wins before the plot bounds: the first and last points of a line sit on the plot's edges, so half of
+    // their hit area lies outside it.
+    const direct = target?.closest("[data-chart-datum]");
+    const hit = direct ? byElement.get(direct) : undefined;
+    if (hit && nodes.includes(hit)) return hit;
+    if (seriesChart()) {
+      const plot = updatePlotBounds();
+      if (plot && (x < plot.left || x > plot.right || y < plot.top || y > plot.bottom)) return;
+    }
+    // Exact shapes win. A small physical hit radius also reaches tiny or
+    // zero-sized marks; distant whitespace leaves the chart unselected.
+    const points = seriesChart() ? sortedPoints : nodes;
+    if (seriesChart() && points.length) {
+      const matrix = points[0].element.getScreenCTM?.();
+      if (matrix) {
+        const determinant = matrix.a * matrix.d - matrix.b * matrix.c;
+        if (!determinant) return;
+        const targetX = ((x - matrix.e) * matrix.d - (y - matrix.f) * matrix.c) / determinant;
+        let low = 0,
+          high = points.length - 1;
+        while (low < high) {
+          const mid = Math.floor((low + high) / 2);
+          if (points[mid].datum.anchor[0] < targetX) low = mid + 1;else high = mid;
+        }
+        const previous = Math.max(0, low - 1);
+        return Math.abs(points[previous].datum.anchor[0] - targetX) <= Math.abs(points[low].datum.anchor[0] - targetX) ? points[previous] : points[low];
+      }
+    }
+    const matrices = new Map();
+    let best,
+      distance = Infinity;
+    for (const entry of points) {
+      const svg = entry.element.ownerSVGElement;
+      if (svg && !matrices.has(svg)) matrices.set(svg, svg.getScreenCTM?.() ?? null);
+      const matrix = svg ? matrices.get(svg) : null;
+      const [ax, ay] = entry.datum.anchor;
+      const point = matrix ? {
+        x: matrix.a * ax + matrix.c * ay + matrix.e,
+        y: matrix.b * ax + matrix.d * ay + matrix.f
+      } : screenPoint(entry);
+      const dx = point.x - x,
+        dy = point.y - y;
+      const next = seriesChart() ? Math.abs(dx) : Math.hypot(dx, dy);
+      if (next < distance) {
+        distance = next;
+        best = entry;
+      }
+    }
+    return seriesChart() || distance <= 24 ? best : undefined;
+  };
+  const move = event => {
+    if (event.target instanceof Node && options.tooltip()?.contains(event.target)) return;
+    if (pointerStart && Math.hypot(event.clientX - pointerStart.x, event.clientY - pointerStart.y) > 6) moved = true;
+    if (!options.enabled() || pinned || event.pointerType === "touch" || event.buttons) return;
+    pending = {
+      x: event.clientX,
+      y: event.clientY,
+      target: event.target instanceof Element ? event.target : null
+    };
+    if (frame !== undefined) return;
+    frame = requestAnimationFrame(() => {
+      frame = undefined;
+      const sample = pending;
+      pending = undefined;
+      if (!sample) return;
+      const entry = nearest(sample.x, sample.y, sample.target);
+      if (entry) {
+        show(entry);
+        if (seriesChart()) {
+          const container = options.container();
+          container?.setAttribute("data-cursor-source", "true");
+          container?.style.setProperty("--k2b-chart-inspection-y", `${sample.y - container.getBoundingClientRect().top}px`);
+        }
+      } else close();
+    });
+  };
+  const down = event => {
+    pointerStart = {
+      x: event.clientX,
+      y: event.clientY
+    };
+    moved = false;
+  };
+  const click = event => {
+    if (!options.enabled() || moved || event.target instanceof Element && event.target.closest("button,a")) return;
+    const entry = nearest(event.clientX, event.clientY, event.target instanceof Element ? event.target : null);
+    if (!entry) {
+      close();
+      return;
+    }
+    pinned = true;
+    show(entry);
+    options.select({
+      kind: options.kind(),
+      datum: entry.datum
+    });
+  };
+  const focus = event => {
+    if (event.target !== options.container() || !options.enabled()) return;
+    const nodes = visibleRecords();
+    const first = options.kind() === "line" ? sortedPoints.at(-1) : nodes[0];
+    if (first) show(first);
+  };
+  const key = event => {
+    if (!options.enabled() || event.target !== options.container()) return false;
+    if (event.key === "Escape") {
+      close();
+      return true;
+    }
+    if (event.key === "Enter" && active) {
+      if (options.kind() === "map" && !visibleRecords().includes(active)) {
+        close();
+        return true;
+      }
+      event.preventDefault();
+      pinned = true;
+      const link = active.element.closest("a");
+      if (link) link.dispatchEvent(new MouseEvent("click", {
+        bubbles: true,
+        cancelable: true
+      }));else options.select({
+        kind: options.kind(),
+        datum: active.datum
+      });
+      return true;
+    }
+    const navigationChart = options.kind() === "map" || options.kind() === "stateTimeline";
+    if (navigationChart && !event.altKey) return false;
+    if (!["Home", "End", "ArrowLeft", "ArrowRight", "ArrowUp", "ArrowDown"].includes(event.key)) return false;
+    let nodes = visibleRecords();
+    if (seriesChart()) nodes = [...nodes].sort((a, b) => a.datum.anchor[0] - b.datum.anchor[0]);
+    if (options.kind() === "line") {
+      const seen = new Set();
+      nodes = nodes.filter(entry => {
+        const x = rawX(entry);
+        if (seen.has(x)) return false;
+        seen.add(x);
+        return true;
+      });
+    }
+    if (!nodes.length) return false;
+    event.preventDefault();
+    pinned = false;
+    let index = active ? options.kind() === "line" ? nodes.findIndex(entry => rawX(entry) === rawX(active)) : nodes.indexOf(active) : -1;
+    if (event.key === "Home") index = 0;else if (event.key === "End") index = nodes.length - 1;else if (active?.datum.grid && ["ArrowUp", "ArrowDown", "ArrowLeft", "ArrowRight"].includes(event.key)) {
+      const [x, y] = active.datum.grid;
+      const dx = event.key === "ArrowLeft" ? -1 : event.key === "ArrowRight" ? 1 : 0;
+      const dy = event.key === "ArrowUp" ? -1 : event.key === "ArrowDown" ? 1 : 0;
+      const next = nodes.filter(entry => entry.datum.grid && (dx ? entry.datum.grid[1] === y && (entry.datum.grid[0] - x) * dx > 0 : entry.datum.grid[0] === x && (entry.datum.grid[1] - y) * dy > 0)).sort((a, b) => Math.abs(a.datum.grid[0] - x) + Math.abs(a.datum.grid[1] - y) - Math.abs(b.datum.grid[0] - x) - Math.abs(b.datum.grid[1] - y))[0];
+      if (next) index = nodes.indexOf(next);
+    } else index += event.key === "ArrowLeft" || event.key === "ArrowUp" ? -1 : 1;
+    show(nodes[Math.max(0, Math.min(nodes.length - 1, index))]);
+    return true;
+  };
+  return {
+    selectDatum: selected => selectData(selected ? [selected] : []),
+    selectData,
+    linkCursor,
+    destroy: () => close(false),
+    move,
+    down,
+    click,
+    focus,
+    key,
+    close: () => close(),
+    invalidate,
+    leave: () => {
+      if (!pinned) close();
+    }
+  };
+}
+
+/** Dismiss inspection on outside interaction, but allow the tooltip itself to scroll. */
+export function closeChartInspectionOnOutside(options) {
+  const outside = event => {
+    if (event.target instanceof Node && !options.container()?.contains(event.target)) options.close();
+  };
+  const scroll = event => {
+    if (event.target instanceof Node && options.tooltip()?.contains(event.target)) return;
+    options.close();
+  };
+  window.addEventListener("pointerdown", outside);
+  window.addEventListener("scroll", scroll, true);
+  window.addEventListener("resize", options.close);
+  return () => {
+    window.removeEventListener("pointerdown", outside);
+    window.removeEventListener("scroll", scroll, true);
+    window.removeEventListener("resize", options.close);
+  };
+}
+let tooltipId = 0;
+
+/** Attach inspection to stdlib SVG rendered with inspect: true, without a framework. */
+export function inspectChart(container, options) {
+  const document = container.ownerDocument;
+  const anchor = document.createElement("span");
+  anchor.className = "k2b-chart__anchor";
+  anchor.setAttribute("aria-hidden", "true");
+  const tooltip = document.createElement("span");
+  tooltip.className = "k2b-tooltip k2b-chart__tooltip";
+  tooltip.setAttribute("role", "tooltip");
+  tooltip.setAttribute("popover", "manual");
+  tooltip.setAttribute("data-instant", "true");
+  do {
+    tooltip.id = `k2b-chart-tooltip-${++tooltipId}`;
+  } while (document.getElementById(tooltip.id));
+  container.append(anchor, tooltip);
+  const addedTabindex = !container.hasAttribute("tabindex");
+  if (addedTabindex) container.setAttribute("tabindex", "0");
+  const inspector = createChartInspector({
+    container: () => container,
+    cursor: () => options.cursor,
+    tooltip: () => tooltip,
+    anchor: () => anchor,
+    kind: () => options.kind,
+    enabled: () => true,
+    format: options.format,
+    select: selection => options.select?.(selection)
+  });
+  container.addEventListener("pointerdown", inspector.down);
+  container.addEventListener("pointermove", inspector.move);
+  container.addEventListener("click", inspector.click);
+  container.addEventListener("pointerleave", inspector.leave);
+  container.addEventListener("focusin", inspector.focus);
+  container.addEventListener("focusout", inspector.close);
+  container.addEventListener("keydown", inspector.key);
+  const removeOutside = closeChartInspectionOnOutside({
+    container: () => container,
+    tooltip: () => tooltip,
+    close: inspector.close
+  });
+  const unlinkCursor = inspector.linkCursor(options.cursor);
+  let destroyed = false;
+  return {
+    invalidate: () => {
+      if (!destroyed) inspector.invalidate();
+    },
+    close: () => {
+      if (!destroyed) inspector.close();
+    },
+    destroy() {
+      if (destroyed) return;
+      destroyed = true;
+      container.removeEventListener("pointerdown", inspector.down);
+      container.removeEventListener("pointermove", inspector.move);
+      container.removeEventListener("click", inspector.click);
+      container.removeEventListener("pointerleave", inspector.leave);
+      container.removeEventListener("focusin", inspector.focus);
+      container.removeEventListener("focusout", inspector.close);
+      container.removeEventListener("keydown", inspector.key);
+      removeOutside();
+      unlinkCursor();
+      inspector.destroy();
+      for (const element of container.querySelectorAll("[data-chart-datum]")) {
+        element.removeAttribute("data-inspected");
+        element.style.removeProperty("--k2b-chart-inspection-color");
+        if (!element.getAttribute("style")) element.removeAttribute("style");
+      }
+      // Inspection geometry the inspector wrote onto the host container.
+      for (const name of ["inspection-x", "inspection-y", "plot-left", "plot-right", "plot-top", "plot-bottom"]) container.style.removeProperty(`--k2b-chart-${name}`);
+      anchor.remove();
+      tooltip.remove();
+      if (addedTabindex) container.removeAttribute("tabindex");
+    }
+  };
+}
+//# sourceMappingURL=chart-inspection-core.js.map