@opendata-ai/openchart-vue 7.11.0 → 8.0.0-rc.1

package/dist/index.d.ts

@@ -1,10 +1,11 @@
-import { BarListSpec, ThemeConfig, DarkMode, ChartSpec, LayerSpec, GraphSpec, ElementRef, MarkEvent, Annotation, TextAnnotation, AnnotationOffset, ElementEdit, ChartLayout, TableSpec, SortState, SankeySpec, TileMapSpec, VizSpec } from '@opendata-ai/openchart-core';
+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';
 export * from '@opendata-ai/openchart-core';
 import { MountOptions, ChartInstance, GraphInstance, TableInstance, TableState, TableMountOptions } 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, NormalizedSankeySpec, NormalizedSpec, NormalizedTableSpec, SimulationConfig, ValidationError, ValidationErrorCode, ValidationResult, clearRenderers, compile, compileBarList, compileChart, compileGraph, compileSankey, compileTable, getChartRenderer, normalizeSpec, registerChartRenderer, validateSpec } from '@opendata-ai/openchart-engine';
+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 * as vue from 'vue';
-import { PropType, CSSProperties, Ref, ShallowRef, InjectionKey, ComputedRef } from 'vue';
+import { PropType, CSSProperties, VNode, Ref, ShallowRef, InjectionKey, ComputedRef } from 'vue';
+import { ChartStoryOptions } from '@opendata-ai/openchart-vanilla/story';
 
 interface BarListRowEvent {
     label: string;
@@ -175,6 +176,85 @@ declare const Chart: vue.DefineComponent<vue.ExtractPropTypes<{
     highlight: string[] | null;
 }, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
 
+interface ChartStoryProps {
+    spec: ChartSpec | LayerSpec | GraphSpec | MapSpec;
+    steps: ChartStoryOptions['steps'];
+    narrative?: VNode[];
+    step?: number;
+    triggerPosition?: number;
+    cameraMode?: 'step' | 'scrub';
+    mountOptions?: MountOptions;
+}
+declare const ChartStory: vue.DefineComponent<vue.ExtractPropTypes<{
+    spec: {
+        type: PropType<ChartSpec | LayerSpec | GraphSpec | MapSpec>;
+        required: true;
+    };
+    steps: {
+        type: PropType<ChartStoryOptions["steps"]>;
+        required: true;
+    };
+    narrative: {
+        type: PropType<VNode[]>;
+        default: undefined;
+    };
+    step: {
+        type: NumberConstructor;
+        default: undefined;
+    };
+    triggerPosition: {
+        type: NumberConstructor;
+        default: undefined;
+    };
+    cameraMode: {
+        type: PropType<"step" | "scrub">;
+        default: undefined;
+    };
+    mountOptions: {
+        type: PropType<MountOptions>;
+        default: undefined;
+    };
+}>, () => VNode<vue.RendererNode, vue.RendererElement, {
+    [key: string]: any;
+}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
+    spec: {
+        type: PropType<ChartSpec | LayerSpec | GraphSpec | MapSpec>;
+        required: true;
+    };
+    steps: {
+        type: PropType<ChartStoryOptions["steps"]>;
+        required: true;
+    };
+    narrative: {
+        type: PropType<VNode[]>;
+        default: undefined;
+    };
+    step: {
+        type: NumberConstructor;
+        default: undefined;
+    };
+    triggerPosition: {
+        type: NumberConstructor;
+        default: undefined;
+    };
+    cameraMode: {
+        type: PropType<"step" | "scrub">;
+        default: undefined;
+    };
+    mountOptions: {
+        type: PropType<MountOptions>;
+        default: undefined;
+    };
+}>> & Readonly<{}>, {
+    step: number;
+    narrative: VNode<vue.RendererNode, vue.RendererElement, {
+        [key: string]: any;
+    }>[];
+    triggerPosition: number;
+    cameraMode: "step" | "scrub";
+    mountOptions: MountOptions;
+}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
+
 /**
  * useChart: composable for manual chart lifecycle control.
  *
@@ -526,6 +606,76 @@ declare const Graph: vue.DefineComponent<vue.ExtractPropTypes<{
     style: string | CSSProperties;
 }, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
 
+type MapFeatureEvent = {
+    id: string | number;
+    name?: string;
+    data: Record<string, unknown> | null;
+};
+
+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: MapFeatureEvent) => true;
+    'mark-hover': (_event: MapFeatureEvent | 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: MapFeatureEvent) => any) | undefined;
+    "onMark-hover"?: ((_event: MapFeatureEvent | null) => any) | undefined;
+}>, {
+    theme: ThemeConfig;
+    darkMode: DarkMode;
+    class: string;
+    style: string | CSSProperties;
+}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
+
 interface SankeyProps {
     spec: SankeySpec;
     theme?: ThemeConfig;
@@ -751,4 +901,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, DataTable, type DataTableProps, 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 };
+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 };