@opendata-ai/openchart-vanilla 6.27.2 → 6.28.4

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, TileMapSpec, TileMapLayout, TooltipContent } from '@opendata-ai/openchart-core';
+import { BarListSpec, BarListLayout, ThemeConfig, DarkMode, GraphSpec, 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.
@@ -76,6 +76,40 @@ declare function exportJPG(svgElement: SVGElement, options?: JPGExportOptions):
  */
 declare function exportCSV(data: Record<string, unknown>[]): string;
 
+/**
+ * BarList mount API: the main entry point for vanilla JS barlist usage.
+ *
+ * createBarList() takes a container, BarListSpec, and options, compiles the
+ * barlist, renders it as SVG, sets up responsive resizing, tooltip interaction,
+ * and returns a BarListInstance with update/resize/export/destroy.
+ */
+
+interface BarListMountOptions {
+    theme?: ThemeConfig;
+    darkMode?: DarkMode;
+    responsive?: boolean;
+    watermark?: boolean;
+    tooltip?: boolean;
+    onRowClick?: (row: {
+        label: string;
+        value: number;
+        data: Record<string, unknown>;
+    }) => void;
+    onRowHover?: (row: {
+        label: string;
+        value: number;
+        data: Record<string, unknown>;
+    } | null) => void;
+}
+interface BarListInstance {
+    update(spec: BarListSpec): void;
+    resize(): void;
+    export(format: 'svg' | 'svg-with-fonts' | 'png' | 'jpg', options?: JPGExportOptions | SVGExportOptions): string | Promise<Blob> | Promise<string>;
+    destroy(): void;
+    readonly layout: BarListLayout;
+}
+declare function createBarList(container: HTMLElement, spec: BarListSpec, options?: BarListMountOptions): BarListInstance;
+
 /**
  * Creates a Web Worker running the force simulation.
  *
@@ -525,4 +559,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 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 };
+export { type BarListInstance, type BarListMountOptions, 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, createBarList, 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 };