@opendata-ai/openchart-vanilla 6.25.4 → 6.26.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, SankeySpec, SankeyLayout, 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, TileMapSpec, TileMapLayout, TooltipContent } from '@opendata-ai/openchart-core';
 
 /**
  * Export utilities: serialize charts to SVG, PNG, JPG, or CSV.
@@ -321,6 +321,7 @@ declare function registerMarkRenderer<T extends Mark>(type: T['type'], renderer:
  */
 declare function renderChartSVG(layout: ChartLayout, container: HTMLElement, opts?: {
     animate?: boolean;
+    crosshair?: boolean;
 }): SVGElement;
 
 /**
@@ -445,6 +446,57 @@ declare function createTextEditOverlay(config: TextEditOverlayConfig): {
     destroy: () => void;
 };
 
+/**
+ * TileMap mount API: the main entry point for vanilla JS tilemap usage.
+ *
+ * createTileMap() takes a container, TileMapSpec, and options, compiles the
+ * tilemap, renders it as SVG, sets up responsive resizing, tooltip interaction,
+ * and returns a TileMapInstance with update/resize/export/destroy.
+ */
+
+interface TileMapMountOptions {
+    /** Theme overrides. */
+    theme?: ThemeConfig;
+    /** Dark mode setting: "auto" (system pref), "force", or "off". */
+    darkMode?: DarkMode;
+    /** Enable responsive resizing. Defaults to true. */
+    responsive?: boolean;
+    /** Show the tryOpenData.ai watermark. Defaults to true. */
+    watermark?: boolean;
+    /** Show tooltips on hover. Defaults to true. */
+    tooltip?: boolean;
+    /** Callback when a tile is clicked. */
+    onTileClick?: (tile: {
+        stateCode: string;
+        stateName: string;
+        value: number | null;
+        data: Record<string, unknown>;
+    }) => void;
+    /** Callback when a tile is hovered (null on mouse leave). */
+    onTileHover?: (tile: {
+        stateCode: string;
+        stateName: string;
+        value: number | null;
+        data: Record<string, unknown>;
+    } | null) => void;
+}
+interface TileMapInstance {
+    /** Re-compile and re-render with a new spec. */
+    update(spec: TileMapSpec): void;
+    /** Re-compile at current container dimensions. */
+    resize(): void;
+    /** Export the tilemap. */
+    export(format: 'svg' | 'svg-with-fonts' | 'png' | 'jpg', options?: JPGExportOptions | SVGExportOptions): string | Promise<Blob> | Promise<string>;
+    /** Remove all DOM elements and disconnect observers. */
+    destroy(): void;
+    /** The current compiled layout. */
+    readonly layout: TileMapLayout;
+}
+/**
+ * Create a tilemap instance from a spec and mount it into a container.
+ */
+declare function createTileMap(container: HTMLElement, spec: TileMapSpec, options?: TileMapMountOptions): TileMapInstance;
+
 /**
  * Tooltip manager: creates and positions a floating tooltip element.
  *
@@ -473,4 +525,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 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 };
+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 TileMapInstance, type TileMapMountOptions, type TooltipManager, type UpdateOptions, attachKeyboardNav, createChart, createGraph, createSankey, createSimulationWorker, createTable, createTextEditOverlay, createTileMap, createTooltipManager, exportCSV, exportJPG, exportPNG, exportSVG, exportSVGWithFonts, observeResize, registerMarkRenderer, renderBarCell, renderCategoryCell, renderCell, renderChartSVG, renderFlagCell, renderHeatmapCell, renderImageCell, renderSparklineCell, renderTable, renderTextCell };