@opendata-ai/openchart-vanilla 8.4.1 → 8.5.1

package/dist/index.d.ts

@@ -1,9 +1,10 @@
 export { ChartLayout, ChartSpec, CompileOptions, TableLayout, TableSpec, VizSpec } from '@opendata-ai/openchart-engine';
-import { BarListSpec, BarListLayout, ThemeConfig, DarkMode, ChartLayout, ChartSpec, LayerSpec, AnimationEase, GraphSpec, TooltipContent, GeoMapSpec, GeoMapLayout, RectMark, Mark, BarTableCell, CategoryTableCell, TableCell, FlagTableCell, HeatmapTableCell, ImageTableCell, SparklineTableCell, TextTableCell, SankeySpec, SankeyLayout, TableSpec, SortState, TableLayout, TileMapSpec, TileMapLayout, ResolvedYouDrawIt } from '@opendata-ai/openchart-core';
+import { BarListSpec, BarListLayout, ThemeConfig, DarkMode, ChartLayout, ChartSpec, LayerSpec, GeoMapSpec, GeoMapLayout, RectMark, Mark, BarTableCell, CategoryTableCell, TableCell, FlagTableCell, HeatmapTableCell, ImageTableCell, SparklineTableCell, TextTableCell, SankeySpec, SankeyLayout, TableSpec, SortState, TableLayout, TileMapSpec, TileMapLayout, ResolvedYouDrawIt } from '@opendata-ai/openchart-core';
 import { J as JPGExportOptions, S as SVGExportOptions, C as Camera } from './mount-Bs8nFSf1.js';
 export { a as ChartInstance, E as ExportOptions, M as MountOptions, P as PNGExportOptions, U as UpdateOptions, c as createChart, e as exportCSV, b as exportJPG, d as exportPNG, f as exportSVG, g as exportSVGWithFonts } from './mount-Bs8nFSf1.js';
-import { Placement } from '@floating-ui/dom';
+export { C as CameraFlightOptions, G as GRAPH_3D_NOT_REGISTERED_ERROR, a as GraphCamera, b as GraphFlyTarget, c as GraphHighlightTarget, d as GraphInstance, e as GraphLegendData, f as GraphMountOptions, g as GraphRendererContext, h as GraphRendererFactory, i as GraphShell, j as GraphTooltipFormatter, k as GraphTooltipItem, T as TooltipManager, l as createGraph, m as createTooltipManager, r as registerGraphRenderer } from './renderer-registry-B5tW6yAZ.js';
 import './export-gif.js';
+import '@floating-ui/dom';
 
 /**
  * BarList mount API: the main entry point for vanilla JS barlist usage.
@@ -154,27 +155,6 @@ interface SpecSequenceOptions {
  */
 declare function exportSpecSequence(specs: Array<ChartSpec | LayerSpec>, options: SpecSequenceOptions): Promise<Blob>;
 
-/**
- * Animated camera for the graph.
- *
- * Flights interpolate between two `ZoomTransform`s along d3's geodesic
- * `interpolateZoom` path (smooth zoom-and-pan that pulls back to see both
- * endpoints before diving in). A flight is a {@link GraphAnimation}, driven by
- * the mount's AnimationScheduler.
- *
- * `interpolateZoom` operates on a `[cx, cy, width]` "view" — the graph-space
- * center and the graph-space width visible across the viewport. We convert the
- * ZoomTransform ⇄ view around a fixed viewport size.
- */
-
-/** Options controlling a camera flight. */
-interface CameraFlightOptions {
-    /** Duration in ms, or `'auto'` to derive from the zoom distance. */
-    duration?: number | 'auto';
-    /** Easing preset. Default `'smooth'`. */
-    ease?: AnimationEase;
-}
-
 /**
  * Creates a Web Worker running the force simulation.
  *
@@ -186,186 +166,6 @@ interface CameraFlightOptions {
  */
 declare function createSimulationWorker(): Worker;
 
-/**
- * Graph mount API: the main entry point for vanilla JS graph usage.
- *
- * createGraph() takes a container, GraphSpec, and options, compiles the graph,
- * creates a force simulation, canvas renderer, spatial index, interaction
- * manager, and search manager, then runs an animation loop driven by
- * simulation ticks. Returns a GraphInstance with update/search/zoom/destroy.
- */
-
-/**
- * A programmatic highlight target. Resolved once at call time into a node id set
- * and rendered through the focus model (eased crossfade). See {@link GraphInstance.highlight}.
- */
-type GraphHighlightTarget = {
-    nodeIds: string[];
-} | {
-    category: {
-        field: string;
-        value: string | string[];
-    };
-} | {
-    neighborsOf: string;
-    includeSelf?: boolean;
-};
-/** A hovered node or edge, passed to a tooltip formatter. */
-interface GraphTooltipItem {
-    kind: 'node' | 'edge';
-    /** The raw datum (node record, or edge record with source/target). */
-    data: Record<string, unknown>;
-}
-/**
- * Custom tooltip content builder. Receives the hovered item and the library's
- * default {@link TooltipContent}, returns replacement content.
- *
- * Safety contract:
- * - A returned `TooltipContent` or `string` is escaped by the library (strings
- *   are inserted via `textContent`, never `innerHTML`).
- * - A returned `HTMLElement` is trusted verbatim — the host owns sanitization.
- * - `null` suppresses the tooltip for that item.
- */
-type GraphTooltipFormatter = (item: GraphTooltipItem, defaults: TooltipContent) => TooltipContent | string | HTMLElement | null;
-/** Built-in legend data (headless mirror of the rendered legend). */
-interface GraphLegendData {
-    field: string | null;
-    nodes: Array<{
-        label: string;
-        color: string;
-        count?: number;
-        active: boolean;
-    }>;
-    edges: Array<{
-        label: string;
-        color: string;
-        count?: number;
-    }>;
-}
-interface GraphMountOptions {
-    theme?: ThemeConfig;
-    darkMode?: DarkMode;
-    /**
-     * Sink for advisory spec warnings from the compiler (unknown `seedNode` id,
-     * deprecations, and so on). Defaults to `console.warn`. Each distinct message
-     * is emitted at most once per instance, so a warning that survives every
-     * recompile doesn't spam the console on `update()`.
-     */
-    onWarn?: (message: string) => void;
-    responsive?: boolean;
-    /** Show the OpenData watermark. Defaults to true. */
-    watermark?: boolean;
-    /** Show the built-in tooltip; pass an object for a custom formatter. Defaults to true. */
-    tooltip?: boolean | {
-        formatter?: GraphTooltipFormatter;
-    };
-    /**
-     * Built-in legend. `true` (default) renders an interactive legend with counts.
-     * `false` renders none (set this if you render your own legend). An object
-     * toggles interactivity/counts.
-     */
-    legend?: boolean | {
-        interactive?: boolean;
-        counts?: boolean;
-    };
-    onNodeClick?: (node: Record<string, unknown>) => void;
-    onNodeDoubleClick?: (node: Record<string, unknown>) => void;
-    onNodeHover?: (node: Record<string, unknown> | null) => void;
-    onEdgeHover?: (edge: Record<string, unknown> | null) => void;
-    onSelectionChange?: (nodeIds: string[]) => void;
-    /** Fired when the user hovers a legend entry (null on leave). */
-    onLegendHover?: (entry: {
-        field: string;
-        value: string;
-    } | null) => void;
-    /** Fired when legend toggle state changes; `activeValues` is the active category set (empty = all). */
-    onLegendToggle?: (activeValues: string[]) => void;
-    /** Fired whenever the highlight set changes (programmatic or legend), null when cleared. */
-    onHighlightChange?: (nodeIds: string[] | null) => void;
-    /**
-     * Fit the graph to the viewport on the first tick. Default true. Set false to
-     * restore a saved camera (e.g. getCamera() + flyTo) without the initial fit.
-     */
-    fitOnLoad?: boolean;
-    /** Camera change callback, rAF-coalesced (fires at most once per rendered frame). */
-    onCameraChange?: (camera: {
-        x: number;
-        y: number;
-        k: number;
-    }) => void;
-    /** Skip the entrance reveal/flight on mount (spec unchanged; used by wrappers when recreating for a theme/darkMode-only change so the entrance doesn't replay). Warmup still runs. */
-    suppressEntrance?: boolean;
-}
-interface GraphInstance {
-    update(spec: GraphSpec): void;
-    /** Re-compile encoding/legend/chrome without restarting the simulation. Preserves node positions. */
-    updateVisuals(spec: GraphSpec): void;
-    search(query: string): void;
-    clearSearch(): void;
-    /** Fit all nodes into the viewport. Animated by default; `{ duration: 0 }` snaps. */
-    zoomToFit(opts?: CameraFlightOptions & {
-        padding?: number;
-    }): void;
-    /** Fly to a node and zoom in (default scale 2). Tracks the node while it settles. */
-    zoomToNode(nodeId: string, opts?: CameraFlightOptions & {
-        scale?: number;
-    }): void;
-    /** Fly the camera to a graph-space target. */
-    flyTo(target: {
-        x: number;
-        y: number;
-        k?: number;
-    }, opts?: CameraFlightOptions): void;
-    /** Center the camera on a graph-space point (keeps current zoom). */
-    centerAt(x: number, y: number, opts?: CameraFlightOptions): void;
-    /** Current camera (graph-space center-ish transform components). */
-    getCamera(): {
-        x: number;
-        y: number;
-        k: number;
-    };
-    /** Select a node; `{ fly: true }` also flies to it (default follows interaction.select.flyTo). */
-    selectNode(nodeId: string, opts?: {
-        fly?: boolean;
-    } & CameraFlightOptions): void;
-    getSelectedNodes(): string[];
-    /** Node ids currently matching the active search query. */
-    getSearchMatches(): string[];
-    /**
-     * Emphasize a set of nodes; eased via the focus model. Layers over the
-     * standing category filter (`setActiveCategories`) rather than replacing it:
-     * the effective set is the intersection, or the highlight alone when the two
-     * are disjoint. Legend toggle state is untouched.
-     */
-    highlight(target: GraphHighlightTarget, opts?: {
-        dimOpacity?: number;
-    }): void;
-    /**
-     * Clear the transient highlight, returning to the standing category filter.
-     * Does NOT clear the filter — use `setActiveCategories([])` for that.
-     */
-    clearHighlight(): void;
-    /** The effective highlighted node ids, or null when nothing is highlighted. */
-    getHighlight(): string[] | null;
-    /** Headless snapshot of the legend (node categories + edge categories). */
-    getLegend(): GraphLegendData;
-    /** Set the active category filter declaratively (replaces legend toggle state). */
-    setActiveCategories(values: string[]): void;
-    /** Current active category values (empty = all active, no filter). */
-    getActiveCategories(): string[];
-    resize(): void;
-    destroy(): void;
-}
-/**
- * Create a graph instance from a spec and mount it into a container.
- *
- * @param container - The DOM element to render into.
- * @param spec - The graph spec.
- * @param options - Mount options.
- * @returns A GraphInstance with update/search/zoom/destroy methods.
- */
-declare function createGraph(container: HTMLElement, spec: GraphSpec, options?: GraphMountOptions): GraphInstance;
-
 /**
  * Map camera utilities: zoom, pan, and focus for map visualizations.
  *
@@ -773,54 +573,6 @@ interface TileMapInstance {
  */
 declare function createTileMap(container: HTMLElement, spec: TileMapSpec, options?: TileMapMountOptions): TileMapInstance;
 
-/**
- * Tooltip manager: creates and positions a floating tooltip element.
- *
- * Shows tooltip content near the mouse/touch position with viewport
- * edge avoidance via @floating-ui/dom. Touch support via tap-to-show,
- * tap-outside-to-hide.
- */
-
-interface TooltipShowOptions {
-    /**
-     * Floating-ui placement. Defaults to 'bottom-start' for mark hover
-     * (the legacy behavior). Line/area snap-tooltips pass 'right-start'
-     * so the card sits beside the snapped point and flips to 'left-start'
-     * via the flip middleware when crowding the right edge.
-     */
-    placement?: Placement;
-}
-/**
- * Content accepted by {@link TooltipManager.show}. A structured
- * {@link TooltipContent} is rendered by the manager; `{ text }` is inserted as
- * plain text (escaped via textContent); `{ element }` is a caller-owned node
- * trusted verbatim (the host owns sanitization).
- */
-type TooltipInput = TooltipContent | {
-    text: string;
-} | {
-    element: HTMLElement;
-};
-interface TooltipManager {
-    /** Show the tooltip with content at a given position. */
-    show(content: TooltipInput, x: number, y: number, opts?: TooltipShowOptions): void;
-    /** Hide the tooltip. */
-    hide(): void;
-    /** Remove the tooltip element and clean up event listeners. */
-    destroy(): void;
-}
-/**
- * Create a tooltip manager attached to a container element.
- *
- * The manager creates a floating div positioned relative to the container.
- * Content is rendered as a title line with optional color indicator,
- * followed by a compact list of field-value pairs.
- *
- * @param container - The parent element for the tooltip.
- * @returns TooltipManager with show/hide/destroy methods.
- */
-declare function createTooltipManager(container: HTMLElement): TooltipManager;
-
 /**
  * "You draw it" interaction layer: the DOM/SVG overlay for the `youDrawIt`
  * spec option (NYT-style draw-then-reveal engagement format).
@@ -867,4 +619,4 @@ interface YouDrawItController {
  */
 declare function createYouDrawIt(options: YouDrawItOptions): YouDrawItController;
 
-export { type BarListInstance, type BarListMountOptions, CANVAS_DEFAULT_UPDATE_MAX_MARKS, Camera, type CameraFlightOptions, DEFAULT_UPDATE_MAX_MARKS, type GeoMapCameraOptions, type GeoMapInstance, type GeoMapMarkEvent, type GeoMapMountOptions, type GraphHighlightTarget, type GraphInstance, type GraphLegendData, type GraphMountOptions, type GraphTooltipFormatter, type GraphTooltipItem, JPGExportOptions, type KeyboardNavOptions, SVGExportOptions, type SankeyInstance, type SankeyMountOptions, type SpecSequenceOptions, type TableInstance, type TableMountOptions, type TableState, type TextEditOverlayConfig, type TileMapInstance, type TileMapMountOptions, type TooltipManager, VECTOR_EXPORT_MAX_POINTS, type YouDrawItController, type YouDrawItOptions, attachKeyboardNav, createBarList, createGeoMap, createGraph, createSankey, createSimulationWorker, createTable, createTextEditOverlay, createTileMap, createTooltipManager, createYouDrawIt, exportSpecSequence, materializeCanvasModeSVG, observeResize, rectPathWithCorners, registerMarkRenderer, renderBarCell, renderCategoryCell, renderCell, renderChartSVG, renderFlagCell, renderHeatmapCell, renderImageCell, renderSparklineCell, renderTable, renderTextCell };
+export { type BarListInstance, type BarListMountOptions, CANVAS_DEFAULT_UPDATE_MAX_MARKS, Camera, DEFAULT_UPDATE_MAX_MARKS, type GeoMapCameraOptions, type GeoMapInstance, type GeoMapMarkEvent, type GeoMapMountOptions, JPGExportOptions, type KeyboardNavOptions, SVGExportOptions, type SankeyInstance, type SankeyMountOptions, type SpecSequenceOptions, type TableInstance, type TableMountOptions, type TableState, type TextEditOverlayConfig, type TileMapInstance, type TileMapMountOptions, VECTOR_EXPORT_MAX_POINTS, type YouDrawItController, type YouDrawItOptions, attachKeyboardNav, createBarList, createGeoMap, createSankey, createSimulationWorker, createTable, createTextEditOverlay, createTileMap, createYouDrawIt, exportSpecSequence, materializeCanvasModeSVG, observeResize, rectPathWithCorners, registerMarkRenderer, renderBarCell, renderCategoryCell, renderCell, renderChartSVG, renderFlagCell, renderHeatmapCell, renderImageCell, renderSparklineCell, renderTable, renderTextCell };