velo-plot 2.20.0 → 3.1.0

package/dist/velo-plot.js

@@ -1,32 +1,37 @@
-import { A as r, D as s, l as t, f as n, L as i, j as g, u as l, N as o, a5 as c, S as E, c as m, N as u, a4 as T, v as A, B as N, k as f, o as L, F as P, y as d } from "./ChartCore-ivzLqxVb.js";
-import { E as h } from "./axisFormat-CzumxpCL.js";
-import { h as C, f as I, c as M, d as R, g as _, r as v } from "./index.core-COREBDNq.js";
+import { E as g } from "./axisFormat-Sz4WIJfQ.js";
+import { D as o, e as l, d as u, L as E, a as f, N as m, P, S as p, c as T, N as d, h as L, b as x, f as N, g as R, p as S } from "./ChartCore-AnR_3Xkb.js";
+import { c as C, d as H, g as M, r as b } from "./PluginRegistry-CzMHebYP.js";
+function t(e) {
+  return e;
+}
+function s(e, a) {
+  return (r) => ({
+    ...a(r),
+    manifest: e
+  });
+}
 export {
-  r as AnimationEngine,
-  s as DARK_THEME,
-  t as DEFAULT_ANIMATION_CONFIG,
-  n as DEFAULT_THEME,
-  h as EventEmitter,
-  i as LIGHT_THEME,
-  g as LinearScale,
-  l as LogScale,
-  o as NativeWebGLRenderer,
-  c as PluginManagerImpl,
-  E as Series,
-  m as createChart,
-  C as createConfigurablePlugin,
-  u as createNativeRenderer,
-  I as createPlugin,
-  T as createPluginContext,
-  M as createRenderer,
-  A as createScale,
+  o as DARK_THEME,
+  l as DEFAULT_THEME,
+  g as EventEmitter,
+  u as LIGHT_THEME,
+  E as LinearScale,
+  f as LogScale,
+  m as NativeWebGLRenderer,
+  P as PluginManagerImpl,
+  p as Series,
+  T as createChart,
+  s as createConfigurablePlugin,
+  d as createNativeRenderer,
+  t as createPlugin,
+  L as createPluginContext,
+  C as createRenderer,
+  x as createScale,
   N as createTheme,
-  R as definePlugin,
-  f as easings,
-  _ as getPluginRegistry,
-  L as getSharedAnimationEngine,
-  P as getThemeByName,
-  d as parseColor,
-  v as registerPlugin
+  H as definePlugin,
+  M as getPluginRegistry,
+  R as getThemeByName,
+  S as parseColor,
+  b as registerPlugin
 };
 //# sourceMappingURL=velo-plot.js.map

package/dist/velo-plot.js.map

@@ -1 +1 @@
-{"version":3,"file":"velo-plot.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;"}
+{"version":3,"file":"velo-plot.js","sources":["../src/plugins/createPlugin.ts"],"sourcesContent":["import type { ChartPlugin, PluginFactory, PluginManifest } from \"./types\";\n\nexport function createPlugin<TConfig = void, TApi extends Record<string, unknown> = {}>(\n  definition: ChartPlugin<TConfig> & { api?: TApi },\n): ChartPlugin<TConfig> & { api: TApi } {\n  return definition as ChartPlugin<TConfig> & { api: TApi };\n}\n\nexport function createConfigurablePlugin<TConfig = void>(\n  manifest: PluginManifest,\n  factory: (config?: TConfig) => Omit<ChartPlugin<TConfig>, \"manifest\">,\n): PluginFactory<TConfig> {\n  return (config?: TConfig) => ({\n    ...factory(config),\n    manifest,\n  });\n}\n"],"names":["createPlugin","definition","createConfigurablePlugin","manifest","factory","config"],"mappings":";;;AAEO,SAASA,EACdC,GACsC;AACtC,SAAOA;AACT;AAEO,SAASC,EACdC,GACAC,GACwB;AACxB,SAAO,CAACC,OAAsB;AAAA,IAC5B,GAAGD,EAAQC,CAAM;AAAA,IACjB,UAAAF;AAAA,EAAA;AAEJ;"}

package/dist/vue/StackedPlot.vue.d.ts

@@ -0,0 +1,48 @@
+import { UseStackedPlotOptions } from './useStackedPlot';
+
+declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<UseStackedPlotOptions & {
+    width?: number | string;
+    height?: number | string;
+    class?: string;
+    ariaLabel?: string;
+}>, {
+    width: string;
+    height: number;
+}>>, {
+    getStack: () => import('..').StackedChart | null;
+    fitAll: (opts?: {
+        x?: import('..').Range;
+        padding?: number;
+    }) => void | undefined;
+    resetAll: () => void | undefined;
+    getBounds: () => import('..').Bounds | null;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<UseStackedPlotOptions & {
+    width?: number | string;
+    height?: number | string;
+    class?: string;
+    ariaLabel?: string;
+}>, {
+    width: string;
+    height: number;
+}>>> & Readonly<{}>, {
+    width: number | string;
+    height: number | string;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToRuntimeProps<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};
+type __VLS_WithDefaults<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify<P[K] & {
+        default: D[K];
+    }> : P[K];
+};
+type __VLS_Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};

package/dist/vue/VeloPlot.vue.d.ts

@@ -0,0 +1,64 @@
+import { UseVeloPlotOptions } from './useVeloPlot';
+import { VeloPlotSeries } from '../bindings/shared';
+import { Bounds, CursorOptions, ZoomOptions } from '../types';
+
+declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<UseVeloPlotOptions & {
+    series?: VeloPlotSeries[];
+    zoom?: ZoomOptions;
+    width?: number | string;
+    height?: number | string;
+    class?: string;
+    cursor?: CursorOptions;
+    ariaLabel?: string;
+    keyboardNav?: boolean;
+}>, {
+    series: () => never[];
+    width: string;
+    height: number;
+    keyboardNav: boolean;
+}>>, {
+    getChart: () => import('..').Chart | null;
+    resetZoom: () => void;
+    getBounds: () => Bounds | null;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    zoomChange: (bounds: Bounds) => void;
+}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<UseVeloPlotOptions & {
+    series?: VeloPlotSeries[];
+    zoom?: ZoomOptions;
+    width?: number | string;
+    height?: number | string;
+    class?: string;
+    cursor?: CursorOptions;
+    ariaLabel?: string;
+    keyboardNav?: boolean;
+}>, {
+    series: () => never[];
+    width: string;
+    height: number;
+    keyboardNav: boolean;
+}>>> & Readonly<{
+    onZoomChange?: ((bounds: Bounds) => any) | undefined;
+}>, {
+    width: number | string;
+    height: number | string;
+    series: VeloPlotSeries[];
+    keyboardNav: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToRuntimeProps<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};
+type __VLS_WithDefaults<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify<P[K] & {
+        default: D[K];
+    }> : P[K];
+};
+type __VLS_Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};

package/dist/vue/index.d.ts

@@ -0,0 +1,250 @@
+import { useVeloPlot as useVeloPlotImpl } from './useVeloPlot';
+export { default as VeloPlot } from './VeloPlot.vue';
+export { default as StackedPlot } from './StackedPlot.vue';
+export { useVeloPlot, type UseVeloPlotOptions, type UseVeloPlotReturn } from './useVeloPlot';
+export { useStackedPlot, type UseStackedPlotOptions } from './useStackedPlot';
+export { useIndicator } from './useIndicator';
+export { useChartSync, useChartGroup } from './useChartSync';
+/** @deprecated Use `VeloPlot` instead. **Removed in v4.0.** */
+export declare const SciPlot: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+    zoom: {
+        type: import('vue').PropType<import('..').ZoomOptions>;
+    };
+    xAxis: {
+        type: import('vue').PropType<import('..').AxisOptions>;
+    };
+    yAxis: {
+        type: import('vue').PropType<import('..').AxisOptions | import('..').AxisOptions[]>;
+    };
+    cursor: {
+        type: import('vue').PropType<import('..').CursorOptions>;
+    };
+    toolbar: {
+        type: import('vue').PropType<import('../types').ToolbarOptions>;
+    };
+    id: {
+        type: import('vue').PropType<string>;
+    };
+    width: {
+        type: import('vue').PropType<string | number>;
+        default: string;
+    };
+    tooltip: {
+        type: import('vue').PropType<import('..').TooltipOptions>;
+    };
+    theme: {
+        type: import('vue').PropType<string | object>;
+    };
+    loading: {
+        type: import('vue').PropType<boolean | import('..').PluginLoadingConfig>;
+    };
+    devicePixelRatio: {
+        type: import('vue').PropType<number>;
+    };
+    background: {
+        type: import('vue').PropType<string>;
+    };
+    colorScheme: {
+        type: import('vue').PropType<string>;
+    };
+    height: {
+        type: import('vue').PropType<string | number>;
+        default: number;
+    };
+    series: {
+        type: import('vue').PropType<import('..').VeloPlotSeries[]>;
+        default: () => never[];
+    };
+    renderer: {
+        type: import('vue').PropType<"webgl" | "webgpu">;
+    };
+    showLegend: {
+        type: import('vue').PropType<boolean>;
+    };
+    legendPosition: {
+        type: import('vue').PropType<{
+            x: number;
+            y: number;
+        }>;
+    };
+    showControls: {
+        type: import('vue').PropType<boolean>;
+    };
+    autoScroll: {
+        type: import('vue').PropType<boolean>;
+    };
+    showStatistics: {
+        type: import('vue').PropType<boolean>;
+    };
+    animations: {
+        type: import('vue').PropType<boolean | import('..').ChartAnimationConfig>;
+    };
+    responsive: {
+        type: import('vue').PropType<(boolean | import('../core').ResponsiveConfig) & (boolean | {
+            reducedMotion?: boolean | "auto";
+        })>;
+    };
+    plugins: {
+        type: import('vue').PropType<import('..').ChartPlugin<unknown>[]>;
+    };
+    layout: {
+        type: import('vue').PropType<import('..').LayoutOptions>;
+    };
+    readOnly: {
+        type: import('vue').PropType<boolean>;
+    };
+    debug: {
+        type: import('vue').PropType<boolean | import('..').DebugOverlayOptions>;
+    };
+    locale: {
+        type: import('vue').PropType<string | import('..').LocaleConfig>;
+    };
+    keyBindings: {
+        type: import('vue').PropType<boolean | import('..').KeyBinding[]>;
+    };
+    clipboard: {
+        type: import('vue').PropType<boolean | import('..').ClipboardOptions>;
+    };
+    class: {
+        type: import('vue').PropType<string>;
+    };
+    ariaLabel: {
+        type: import('vue').PropType<string>;
+    };
+    autoResize: {
+        type: import('vue').PropType<boolean>;
+    };
+    keyboardNav: {
+        type: import('vue').PropType<boolean>;
+        default: boolean;
+    };
+}>, {
+    getChart: () => import('..').Chart | null;
+    resetZoom: () => void;
+    getBounds: () => import('..').Bounds | null;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    zoomChange: (bounds: import('..').Bounds) => void;
+}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    zoom: {
+        type: import('vue').PropType<import('..').ZoomOptions>;
+    };
+    xAxis: {
+        type: import('vue').PropType<import('..').AxisOptions>;
+    };
+    yAxis: {
+        type: import('vue').PropType<import('..').AxisOptions | import('..').AxisOptions[]>;
+    };
+    cursor: {
+        type: import('vue').PropType<import('..').CursorOptions>;
+    };
+    toolbar: {
+        type: import('vue').PropType<import('../types').ToolbarOptions>;
+    };
+    id: {
+        type: import('vue').PropType<string>;
+    };
+    width: {
+        type: import('vue').PropType<string | number>;
+        default: string;
+    };
+    tooltip: {
+        type: import('vue').PropType<import('..').TooltipOptions>;
+    };
+    theme: {
+        type: import('vue').PropType<string | object>;
+    };
+    loading: {
+        type: import('vue').PropType<boolean | import('..').PluginLoadingConfig>;
+    };
+    devicePixelRatio: {
+        type: import('vue').PropType<number>;
+    };
+    background: {
+        type: import('vue').PropType<string>;
+    };
+    colorScheme: {
+        type: import('vue').PropType<string>;
+    };
+    height: {
+        type: import('vue').PropType<string | number>;
+        default: number;
+    };
+    series: {
+        type: import('vue').PropType<import('..').VeloPlotSeries[]>;
+        default: () => never[];
+    };
+    renderer: {
+        type: import('vue').PropType<"webgl" | "webgpu">;
+    };
+    showLegend: {
+        type: import('vue').PropType<boolean>;
+    };
+    legendPosition: {
+        type: import('vue').PropType<{
+            x: number;
+            y: number;
+        }>;
+    };
+    showControls: {
+        type: import('vue').PropType<boolean>;
+    };
+    autoScroll: {
+        type: import('vue').PropType<boolean>;
+    };
+    showStatistics: {
+        type: import('vue').PropType<boolean>;
+    };
+    animations: {
+        type: import('vue').PropType<boolean | import('..').ChartAnimationConfig>;
+    };
+    responsive: {
+        type: import('vue').PropType<(boolean | import('../core').ResponsiveConfig) & (boolean | {
+            reducedMotion?: boolean | "auto";
+        })>;
+    };
+    plugins: {
+        type: import('vue').PropType<import('..').ChartPlugin<unknown>[]>;
+    };
+    layout: {
+        type: import('vue').PropType<import('..').LayoutOptions>;
+    };
+    readOnly: {
+        type: import('vue').PropType<boolean>;
+    };
+    debug: {
+        type: import('vue').PropType<boolean | import('..').DebugOverlayOptions>;
+    };
+    locale: {
+        type: import('vue').PropType<string | import('..').LocaleConfig>;
+    };
+    keyBindings: {
+        type: import('vue').PropType<boolean | import('..').KeyBinding[]>;
+    };
+    clipboard: {
+        type: import('vue').PropType<boolean | import('..').ClipboardOptions>;
+    };
+    class: {
+        type: import('vue').PropType<string>;
+    };
+    ariaLabel: {
+        type: import('vue').PropType<string>;
+    };
+    autoResize: {
+        type: import('vue').PropType<boolean>;
+    };
+    keyboardNav: {
+        type: import('vue').PropType<boolean>;
+        default: boolean;
+    };
+}>> & Readonly<{
+    onZoomChange?: ((bounds: import('..').Bounds) => any) | undefined;
+}>, {
+    width: number | string;
+    height: number | string;
+    series: import('..').VeloPlotSeries[];
+    keyboardNav: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+/** @deprecated Use `useVeloPlot` instead. **Removed in v4.0.** */
+export declare const useSciPlot: typeof useVeloPlotImpl;
+/** @deprecated Use `useVeloPlot` instead. **Removed in v4.0.** */
+export declare const useSciChart: typeof useVeloPlotImpl;

package/dist/vue/useChartSync.d.ts

@@ -0,0 +1,52 @@
+import { ChartLike, SyncOptions, ChartGroup } from '../core/sync';
+
+export declare function useChartSync(charts: () => ChartLike[], options?: SyncOptions): {
+    group: import('vue').Ref<{
+        add: (chart: ChartLike) => ChartGroup;
+        addAll: (...charts: ChartLike[]) => ChartGroup;
+        remove: (chart: ChartLike) => ChartGroup;
+        getCharts: () => ChartLike[];
+        size: () => number;
+        has: (chart: ChartLike) => boolean;
+        syncAxis: (axis: import('..').SyncAxis) => ChartGroup;
+        syncZoom: (enabled: boolean) => ChartGroup;
+        syncPan: (enabled: boolean) => ChartGroup;
+        syncCursor: (enabled: boolean) => ChartGroup;
+        syncSelection: (enabled: boolean) => ChartGroup;
+        updateOptions: (partial: Partial<SyncOptions>) => ChartGroup;
+        getOptions: () => Readonly<SyncOptions>;
+        syncTo: (bounds: Partial<import('..').Bounds>, excludeChartId?: string) => void;
+        resetAll: () => void;
+        fitAll: (options?: {
+            x?: import('..').Range;
+            padding?: number;
+        }) => void;
+        batch: <T>(fn: () => T) => T;
+        clearAllSelections: () => void;
+        destroy: () => void;
+    } | null, ChartGroup | {
+        add: (chart: ChartLike) => ChartGroup;
+        addAll: (...charts: ChartLike[]) => ChartGroup;
+        remove: (chart: ChartLike) => ChartGroup;
+        getCharts: () => ChartLike[];
+        size: () => number;
+        has: (chart: ChartLike) => boolean;
+        syncAxis: (axis: import('..').SyncAxis) => ChartGroup;
+        syncZoom: (enabled: boolean) => ChartGroup;
+        syncPan: (enabled: boolean) => ChartGroup;
+        syncCursor: (enabled: boolean) => ChartGroup;
+        syncSelection: (enabled: boolean) => ChartGroup;
+        updateOptions: (partial: Partial<SyncOptions>) => ChartGroup;
+        getOptions: () => Readonly<SyncOptions>;
+        syncTo: (bounds: Partial<import('..').Bounds>, excludeChartId?: string) => void;
+        resetAll: () => void;
+        fitAll: (options?: {
+            x?: import('..').Range;
+            padding?: number;
+        }) => void;
+        batch: <T>(fn: () => T) => T;
+        clearAllSelections: () => void;
+        destroy: () => void;
+    } | null>;
+};
+export declare const useChartGroup: typeof useChartSync;

package/dist/vue/useIndicator.d.ts

@@ -0,0 +1,23 @@
+import { AddIndicatorOptions, AddIndicatorResult } from '../core/indicator/addIndicator';
+import { IndicatorPresetName } from '../core/indicator/indicatorPresets';
+import { IndicatorHost } from '../bindings/shared';
+
+export declare function useIndicator(host: () => IndicatorHost, preset: IndicatorPresetName, options?: AddIndicatorOptions): {
+    result: import('vue').Ref<{
+        id: string;
+        preset: IndicatorPresetName;
+        placement: "overlay" | "oscillator";
+        seriesIds: string[];
+        paneId?: string | undefined;
+    } | null, (AddIndicatorResult & {
+        paneId?: string;
+    }) | {
+        id: string;
+        preset: IndicatorPresetName;
+        placement: "overlay" | "oscillator";
+        seriesIds: string[];
+        paneId?: string | undefined;
+    } | null>;
+    isLoading: import('vue').Ref<boolean, boolean>;
+    error: import('vue').Ref<Error | null, Error | null>;
+};

package/dist/vue/useStackedPlot.d.ts

@@ -0,0 +1,15 @@
+import { StackedChart, StackedChartOptions } from '../core/stacked';
+import { Range } from '../types';
+
+export interface UseStackedPlotOptions extends Omit<StackedChartOptions, "container"> {
+}
+export declare function useStackedPlot(options: UseStackedPlotOptions): {
+    containerRef: import('vue').Ref<HTMLDivElement | null, HTMLDivElement | null>;
+    stack: import('vue').ShallowRef<StackedChart | null, StackedChart | null>;
+    isReady: import('vue').Ref<boolean, boolean>;
+    fitAll: (opts?: {
+        x?: Range;
+        padding?: number;
+    }) => void | undefined;
+    resetAll: () => void | undefined;
+};

package/dist/vue/useVeloPlot.d.ts

@@ -0,0 +1,20 @@
+import { Ref } from 'vue';
+import { Chart } from '../core/Chart';
+import { SeriesOptions, SeriesUpdateData, ZoomOptions, Bounds } from '../types';
+import { ChartBindingOptions } from '../bindings/shared';
+
+export interface UseVeloPlotOptions extends ChartBindingOptions {
+}
+export interface UseVeloPlotReturn {
+    containerRef: Ref<HTMLDivElement | null>;
+    chart: Ref<Chart | null>;
+    isReady: Ref<boolean>;
+    error: Ref<Error | null>;
+    bounds: Ref<Bounds | null>;
+    addSeries: (options: SeriesOptions) => void;
+    updateSeries: (id: string, data: SeriesUpdateData) => void;
+    removeSeries: (id: string) => void;
+    zoom: (options: ZoomOptions) => void;
+    resetZoom: () => void;
+}
+export declare function useVeloPlot(options?: UseVeloPlotOptions): UseVeloPlotReturn;

package/dist/vue.d.ts

@@ -0,0 +1 @@
+export * from './vue/index'