@opendata-ai/openchart-vue 8.0.0-rc.24 → 8.0.0-rc.26

package/dist/index.d.ts

@@ -1,8 +1,8 @@
-import { BarListSpec, ThemeConfig, DarkMode, ChartSpec, LayerSpec, GraphSpec, ElementRef, MarkEvent, Annotation, TextAnnotation, AnnotationOffset, ElementEdit, MapSpec, ChartLayout, TableSpec, SortState, SankeySpec, TileMapSpec, VizSpec } from '@opendata-ai/openchart-core';
+import { BarListSpec, ThemeConfig, DarkMode, ChartSpec, LayerSpec, GraphSpec, ElementRef, MarkEvent, Annotation, TextAnnotation, AnnotationOffset, ElementEdit, GeoMapSpec, ChartLayout, TableSpec, SortState, SankeySpec, TileMapSpec, VizSpec } from '@opendata-ai/openchart-core';
 export * from '@opendata-ai/openchart-core';
-import { MountOptions, ChartInstance, CameraFlightOptions, GraphHighlightTarget, GraphLegendData, GraphInstance, TableInstance, TableState, TableMountOptions, GraphTooltipFormatter, MapMarkEvent } from '@opendata-ai/openchart-vanilla';
-export { JPGExportOptions, PNGExportOptions, exportCSV, exportJPG, exportPNG, exportSVG } from '@opendata-ai/openchart-vanilla';
-export { ChartRenderer, CompileResult, CompiledGraphEdge, CompiledGraphNode, GraphCompilation, NormalizedBarListSpec, NormalizedChartSpec, NormalizedChrome, NormalizedGraphSpec, NormalizedMapSpec, NormalizedSankeySpec, NormalizedSpec, NormalizedTableSpec, SimulationConfig, ValidationError, ValidationErrorCode, ValidationResult, clearRenderers, compile, compileBarList, compileChart, compileGraph, compileMap, compileSankey, compileTable, getChartRenderer, normalizeSpec, registerChartRenderer, validateSpec } from '@opendata-ai/openchart-engine';
+import { MountOptions, ChartInstance, CameraFlightOptions, GraphHighlightTarget, GraphLegendData, GraphInstance, TableInstance, TableState, TableMountOptions, GeoMapMarkEvent, GraphTooltipFormatter } from '@opendata-ai/openchart-vanilla';
+export { JPGExportOptions, PNGExportOptions, SVGExportOptions, SpecSequenceOptions, exportCSV, exportJPG, exportPNG, exportSVG, exportSVGWithFonts, exportSpecSequence } from '@opendata-ai/openchart-vanilla';
+export { ChartRenderer, CompileResult, CompiledGraphEdge, CompiledGraphNode, GraphCompilation, NormalizedBarListSpec, NormalizedChartSpec, NormalizedChrome, NormalizedGeoMapSpec, NormalizedGraphSpec, NormalizedSankeySpec, NormalizedSpec, NormalizedTableSpec, NormalizedTileMapSpec, SimulationConfig, ValidationError, ValidationErrorCode, ValidationResult, clearRenderers, compile, compileBarList, compileChart, compileGeoMap, compileGraph, compileSankey, compileTable, compileTileMap, getChartRenderer, normalizeSpec, registerChartRenderer, validateSpec } from '@opendata-ai/openchart-engine';
 import * as vue from 'vue';
 import { PropType, CSSProperties, VNode, Ref, ShallowRef, InjectionKey, ComputedRef } from 'vue';
 import { ChartStoryOptions } from '@opendata-ai/openchart-vanilla/story';
@@ -80,6 +80,8 @@ interface ChartProps {
     spec: ChartSpec | LayerSpec | GraphSpec;
     theme?: ThemeConfig;
     darkMode?: DarkMode;
+    /** Rendering backend for point marks; see the vanilla `MountOptions.renderer`. */
+    renderer?: 'auto' | 'svg' | 'canvas';
     class?: string;
     style?: string | CSSProperties;
 }
@@ -96,6 +98,10 @@ declare const Chart: vue.DefineComponent<vue.ExtractPropTypes<{
         type: PropType<DarkMode>;
         default: undefined;
     };
+    renderer: {
+        type: PropType<"auto" | "svg" | "canvas">;
+        default: undefined;
+    };
     class: {
         type: StringConstructor;
         default: undefined;
@@ -143,6 +149,10 @@ declare const Chart: vue.DefineComponent<vue.ExtractPropTypes<{
         type: PropType<DarkMode>;
         default: undefined;
     };
+    renderer: {
+        type: PropType<"auto" | "svg" | "canvas">;
+        default: undefined;
+    };
     class: {
         type: StringConstructor;
         default: undefined;
@@ -180,13 +190,14 @@ declare const Chart: vue.DefineComponent<vue.ExtractPropTypes<{
     darkMode: DarkMode;
     class: string;
     style: string | CSSProperties;
+    renderer: "auto" | "canvas" | "svg";
     selectedElement: ElementRef;
     highlight: string[] | null;
     editable: boolean;
 }, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
 
 interface ChartStoryProps {
-    spec: ChartSpec | LayerSpec | GraphSpec | MapSpec;
+    spec: ChartSpec | LayerSpec | GraphSpec | GeoMapSpec;
     steps: ChartStoryOptions['steps'];
     narrative?: VNode[];
     step?: number;
@@ -196,7 +207,7 @@ interface ChartStoryProps {
 }
 declare const ChartStory: vue.DefineComponent<vue.ExtractPropTypes<{
     spec: {
-        type: PropType<ChartSpec | LayerSpec | GraphSpec | MapSpec>;
+        type: PropType<ChartSpec | LayerSpec | GraphSpec | GeoMapSpec>;
         required: true;
     };
     steps: {
@@ -227,7 +238,7 @@ declare const ChartStory: vue.DefineComponent<vue.ExtractPropTypes<{
     [key: string]: any;
 }>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
     spec: {
-        type: PropType<ChartSpec | LayerSpec | GraphSpec | MapSpec>;
+        type: PropType<ChartSpec | LayerSpec | GraphSpec | GeoMapSpec>;
         required: true;
     };
     steps: {
@@ -280,6 +291,8 @@ interface UseChartOptions {
     onDataPointClick?: MountOptions['onDataPointClick'];
     /** Enable responsive resizing. Defaults to true. */
     responsive?: boolean;
+    /** Rendering backend for point marks; see the vanilla `MountOptions.renderer`. */
+    renderer?: MountOptions['renderer'];
 }
 interface UseChartReturn {
     /** Template ref to attach to the container div. */
@@ -612,6 +625,70 @@ declare const DataTable: vue.DefineComponent<vue.ExtractPropTypes<{
     page: number;
 }, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
 
+interface GeoMapProps {
+    spec: GeoMapSpec;
+    theme?: ThemeConfig;
+    darkMode?: DarkMode;
+    class?: string;
+    style?: string | CSSProperties;
+}
+declare const GeoMap: vue.DefineComponent<vue.ExtractPropTypes<{
+    spec: {
+        type: PropType<GeoMapSpec>;
+        required: true;
+    };
+    theme: {
+        type: PropType<ThemeConfig>;
+        default: undefined;
+    };
+    darkMode: {
+        type: PropType<DarkMode>;
+        default: undefined;
+    };
+    class: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    style: {
+        type: PropType<string | CSSProperties>;
+        default: undefined;
+    };
+}>, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
+    [key: string]: any;
+}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {
+    'mark-click': (_event: GeoMapMarkEvent) => true;
+    'mark-hover': (_event: GeoMapMarkEvent | null) => true;
+}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
+    spec: {
+        type: PropType<GeoMapSpec>;
+        required: true;
+    };
+    theme: {
+        type: PropType<ThemeConfig>;
+        default: undefined;
+    };
+    darkMode: {
+        type: PropType<DarkMode>;
+        default: undefined;
+    };
+    class: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    style: {
+        type: PropType<string | CSSProperties>;
+        default: undefined;
+    };
+}>> & Readonly<{
+    "onMark-click"?: ((_event: GeoMapMarkEvent) => any) | undefined;
+    "onMark-hover"?: ((_event: GeoMapMarkEvent | null) => any) | undefined;
+}>, {
+    theme: ThemeConfig;
+    darkMode: DarkMode;
+    class: string;
+    style: string | CSSProperties;
+}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
+
 /** Tooltip prop: `false` off, `true` default, or an object with a formatter. */
 type GraphTooltipProp = boolean | {
     formatter?: GraphTooltipFormatter;
@@ -743,70 +820,6 @@ declare const Graph: vue.DefineComponent<vue.ExtractPropTypes<{
     fitOnLoad: boolean;
 }, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
 
-interface MapProps {
-    spec: MapSpec;
-    theme?: ThemeConfig;
-    darkMode?: DarkMode;
-    class?: string;
-    style?: string | CSSProperties;
-}
-declare const GeoMap: vue.DefineComponent<vue.ExtractPropTypes<{
-    spec: {
-        type: PropType<MapSpec>;
-        required: true;
-    };
-    theme: {
-        type: PropType<ThemeConfig>;
-        default: undefined;
-    };
-    darkMode: {
-        type: PropType<DarkMode>;
-        default: undefined;
-    };
-    class: {
-        type: StringConstructor;
-        default: undefined;
-    };
-    style: {
-        type: PropType<string | CSSProperties>;
-        default: undefined;
-    };
-}>, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
-    [key: string]: any;
-}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {
-    'mark-click': (_event: MapMarkEvent) => true;
-    'mark-hover': (_event: MapMarkEvent | null) => true;
-}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
-    spec: {
-        type: PropType<MapSpec>;
-        required: true;
-    };
-    theme: {
-        type: PropType<ThemeConfig>;
-        default: undefined;
-    };
-    darkMode: {
-        type: PropType<DarkMode>;
-        default: undefined;
-    };
-    class: {
-        type: StringConstructor;
-        default: undefined;
-    };
-    style: {
-        type: PropType<string | CSSProperties>;
-        default: undefined;
-    };
-}>> & Readonly<{
-    "onMark-click"?: ((_event: MapMarkEvent) => any) | undefined;
-    "onMark-hover"?: ((_event: MapMarkEvent | null) => any) | undefined;
-}>, {
-    theme: ThemeConfig;
-    darkMode: DarkMode;
-    class: string;
-    style: string | CSSProperties;
-}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
-
 interface SankeyProps {
     spec: SankeySpec;
     theme?: ThemeConfig;
@@ -1032,4 +1045,4 @@ declare const Visualization: vue.DefineComponent<vue.ExtractPropTypes<{
     style: string | CSSProperties;
 }, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
 
-export { BarList, type BarListProps, type BarListRowEvent, Chart, type ChartProps, ChartStory, type ChartStoryProps, DataTable, type DataTableProps, GeoMap, Graph, type GraphHandle, type GraphProps, type MapProps, Sankey, type SankeyProps, TileMap, type TileMapProps, type UseChartOptions, type UseChartReturn, type UseGraphReturn, type UseTableReturn, type UseTableStateOptions, type UseTableStateReturn, Visualization, type VisualizationProps, VizDarkModeKey, VizThemeKey, VizThemeProvider, type VizThemeProviderProps, useChart, useDarkMode, useGraph, useTable, useTableState, useVizDarkMode, useVizTheme };
+export { BarList, type BarListProps, type BarListRowEvent, Chart, type ChartProps, ChartStory, type ChartStoryProps, DataTable, type DataTableProps, GeoMap, type GeoMapProps, Graph, type GraphHandle, type GraphProps, Sankey, type SankeyProps, TileMap, type TileMapProps, type UseChartOptions, type UseChartReturn, type UseGraphReturn, type UseTableReturn, type UseTableStateOptions, type UseTableStateReturn, Visualization, type VisualizationProps, VizDarkModeKey, VizThemeKey, VizThemeProvider, type VizThemeProviderProps, useChart, useDarkMode, useGraph, useTable, useTableState, useVizDarkMode, useVizTheme };