@opendata-ai/openchart-vanilla 6.5.2 → 6.7.0

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 export { ChartLayout, ChartSpec, CompileOptions, TableLayout, TableSpec, VizSpec } from '@opendata-ai/openchart-engine';
-import { GraphSpec, ThemeConfig, DarkMode, ChartSpec, LayerSpec, ElementRef, ChartLayout, ChartEventHandlers, BarTableCell, CategoryTableCell, TableCell, FlagTableCell, HeatmapTableCell, ImageTableCell, SparklineTableCell, TextTableCell, Mark, TableSpec, SortState, TableLayout, TooltipContent } from '@opendata-ai/openchart-core';
+import { GraphSpec, ThemeConfig, DarkMode, ChartSpec, LayerSpec, ElementRef, ChartLayout, ChartEventHandlers, BarTableCell, CategoryTableCell, TableCell, FlagTableCell, HeatmapTableCell, ImageTableCell, SparklineTableCell, TextTableCell, SankeySpec, SankeyLayout, Mark, TableSpec, SortState, TableLayout, TooltipContent } from '@opendata-ai/openchart-core';
 
 /**
  * Export utilities: serialize charts to SVG, PNG, JPG, or CSV.
@@ -235,6 +235,49 @@ declare function renderCell(cell: TableCell): HTMLTableCellElement;
  */
 declare function observeResize(container: HTMLElement, callback: (width: number, height: number) => void): () => void;
 
+/**
+ * Sankey mount API: the main entry point for vanilla JS sankey usage.
+ *
+ * createSankey() takes a container, SankeySpec, and options, compiles the
+ * sankey, renders it as SVG, sets up responsive resizing, tooltip interaction,
+ * hover highlighting, and returns a SankeyInstance with update/resize/export/destroy.
+ */
+
+interface SankeyMountOptions {
+    /** Theme overrides. */
+    theme?: ThemeConfig;
+    /** Dark mode setting: "auto" (system pref), "force", or "off". */
+    darkMode?: DarkMode;
+    /** Enable responsive resizing. Defaults to true. */
+    responsive?: boolean;
+    /** Show tooltips on hover. Defaults to true. */
+    tooltip?: boolean;
+    /** Callback when a node is clicked. */
+    onNodeClick?: (node: Record<string, unknown>) => void;
+    /** Callback when a link is clicked. */
+    onLinkClick?: (link: Record<string, unknown>) => void;
+    /** Callback when a node is hovered (null on mouse leave). */
+    onNodeHover?: (node: Record<string, unknown> | null) => void;
+    /** Callback when a link is hovered (null on mouse leave). */
+    onLinkHover?: (link: Record<string, unknown> | null) => void;
+}
+interface SankeyInstance {
+    /** Re-compile and re-render with a new spec. */
+    update(spec: SankeySpec): void;
+    /** Re-compile at current container dimensions. */
+    resize(): void;
+    /** Export the sankey diagram. */
+    export(format: 'svg' | 'svg-with-fonts' | 'png' | 'jpg', options?: JPGExportOptions): string | Promise<Blob> | Promise<string>;
+    /** Remove all DOM elements and disconnect observers. */
+    destroy(): void;
+    /** The current compiled layout. */
+    readonly layout: SankeyLayout;
+}
+/**
+ * Create a sankey instance from a spec and mount it into a container.
+ */
+declare function createSankey(container: HTMLElement, spec: SankeySpec, options?: SankeyMountOptions): SankeyInstance;
+
 /**
  * SVG renderer: converts a ChartLayout into SVG DOM elements.
  *
@@ -411,4 +454,4 @@ interface TooltipManager {
  */
 declare function createTooltipManager(container: HTMLElement): TooltipManager;
 
-export { type ChartInstance, type ExportOptions, type GraphInstance, type GraphMountOptions, type JPGExportOptions, type KeyboardNavOptions, type MountOptions, type PNGExportOptions, type SVGExportOptions, type TableInstance, type TableMountOptions, type TableState, type TextEditOverlayConfig, type TooltipManager, type UpdateOptions, attachKeyboardNav, createChart, createGraph, createSimulationWorker, createTable, createTextEditOverlay, createTooltipManager, exportCSV, exportJPG, exportPNG, exportSVG, exportSVGWithFonts, observeResize, registerMarkRenderer, renderBarCell, renderCategoryCell, renderCell, renderChartSVG, renderFlagCell, renderHeatmapCell, renderImageCell, renderSparklineCell, renderTable, renderTextCell };
+export { type ChartInstance, type ExportOptions, type GraphInstance, type GraphMountOptions, type JPGExportOptions, type KeyboardNavOptions, type MountOptions, type PNGExportOptions, type SVGExportOptions, type SankeyInstance, type SankeyMountOptions, type TableInstance, type TableMountOptions, type TableState, type TextEditOverlayConfig, type TooltipManager, type UpdateOptions, attachKeyboardNav, createChart, createGraph, createSankey, createSimulationWorker, createTable, createTextEditOverlay, createTooltipManager, exportCSV, exportJPG, exportPNG, exportSVG, exportSVGWithFonts, observeResize, registerMarkRenderer, renderBarCell, renderCategoryCell, renderCell, renderChartSVG, renderFlagCell, renderHeatmapCell, renderImageCell, renderSparklineCell, renderTable, renderTextCell };