@opendata-ai/openchart-vanilla 6.3.0 → 6.5.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, 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, Mark, TableSpec, SortState, TableLayout, TooltipContent } from '@opendata-ai/openchart-core';
 
 /**
  * Export utilities: serialize charts to SVG, PNG, JPG, or CSV.
@@ -151,12 +151,18 @@ interface MountOptions extends ChartEventHandlers {
     onDataPointClick?: (data: Record<string, unknown>) => void;
     /** Enable responsive resizing. Defaults to true. */
     responsive?: boolean;
+    /** Initial selected element. */
+    selectedElement?: ElementRef;
+}
+interface UpdateOptions {
+    /** Override the selected element after update. When omitted, preserves current selection. */
+    selectedElement?: ElementRef;
 }
 interface ExportOptions extends JPGExportOptions {
 }
 interface ChartInstance {
     /** Re-compile and re-render with a new spec. */
-    update(spec: ChartSpec | LayerSpec | GraphSpec): void;
+    update(spec: ChartSpec | LayerSpec | GraphSpec, options?: UpdateOptions): void;
     /** Re-compile at current container dimensions. */
     resize(): void;
     /** Export the chart. */
@@ -170,6 +176,14 @@ interface ChartInstance {
     destroy(): void;
     /** The current compiled layout (for hooks / debugging). */
     readonly layout: ChartLayout;
+    /** Get the currently selected element, or null if none. */
+    getSelectedElement(): ElementRef | null;
+    /** Programmatically select an element. Silent no-op if element not found. */
+    select(ref: ElementRef): void;
+    /** Deselect the current element. */
+    deselect(): void;
+    /** Whether inline text editing is active. */
+    readonly isEditing: boolean;
 }
 /**
  * Create a chart instance from a spec and mount it into a container.
@@ -245,7 +259,9 @@ declare function registerMarkRenderer<T extends Mark>(type: T['type'], renderer:
  * @param container - DOM element to mount the SVG into.
  * @returns The created SVG element.
  */
-declare function renderChartSVG(layout: ChartLayout, container: HTMLElement): SVGElement;
+declare function renderChartSVG(layout: ChartLayout, container: HTMLElement, opts?: {
+    animate?: boolean;
+}): SVGElement;
 
 /**
  * Table keyboard navigation: arrow-key cell navigation, Enter to sort,
@@ -326,6 +342,11 @@ declare function createTable(container: HTMLElement, spec: TableSpec, options?:
  * The returned element replaces or appends to the given container.
  */
 
+/** Options for renderTable(). */
+interface TableRenderOptions {
+    /** Whether to apply entrance animation on this render. */
+    animate?: boolean;
+}
 /**
  * Render a TableLayout into a full DOM structure.
  *
@@ -333,7 +354,34 @@ declare function createTable(container: HTMLElement, spec: TableSpec, options?:
  * @param container - The container element to render into.
  * @returns The wrapper element that was created.
  */
-declare function renderTable(layout: TableLayout, container: HTMLElement): HTMLElement;
+declare function renderTable(layout: TableLayout, container: HTMLElement, opts?: TableRenderOptions): HTMLElement;
+
+/**
+ * Text edit overlay: creates a positioned textarea over an SVG text element
+ * for inline editing. Handles commit (Enter), cancel (Escape), and
+ * click-outside-to-commit behavior.
+ */
+interface TextEditOverlayConfig {
+    /** The container div that holds the SVG. */
+    container: HTMLElement;
+    /** The root SVG element. */
+    svg: SVGSVGElement;
+    /** The SVG text element being edited. */
+    targetElement: SVGElement;
+    /** Current text content to populate the textarea. */
+    currentText: string;
+    /** Called when the user commits the edit (Enter or click outside). */
+    onCommit: (newText: string) => void;
+    /** Called when the user cancels the edit (Escape). */
+    onCancel: () => void;
+}
+/**
+ * Create an inline text editing overlay positioned over an SVG text element.
+ * Returns an object with a `destroy()` method to clean up.
+ */
+declare function createTextEditOverlay(config: TextEditOverlayConfig): {
+    destroy: () => void;
+};
 
 /**
  * Tooltip manager: creates and positions a floating tooltip element.
@@ -363,4 +411,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 TooltipManager, attachKeyboardNav, createChart, createGraph, createSimulationWorker, createTable, 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 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 };