@visactor/vchart-types 1.13.21-alpha.1 → 1.13.21-alpha.3

package/types/core/vchart.d.ts

@@ -22,6 +22,7 @@ import { Compiler } from '../compile/compiler';
 import type { IMorphConfig } from '../animation/spec';
 import type { DataLinkAxis, DataLinkSeries, IGlobalConfig, IVChart, IVChartRenderOption } from './interface';
 import { InstanceManager } from './instance-manager';
+import type { IChartPluginService } from '../plugin/chart/interface';
 export declare class VChart implements IVChart {
     readonly id: number;
     static useRegisters(comps: (() => void)[]): void;
@@ -77,6 +78,7 @@ export declare class VChart implements IVChart {
     private _context;
     private _isReleased;
     private _chartPlugin?;
+    get chartPlugin(): IChartPluginService<any>;
     private _onResize?;
     constructor(spec: ISpec, options: IInitOption);
     private _setNewSpec;

package/types/data/transforms/sankey.d.ts

@@ -1,4 +1,5 @@
 import type { SankeyOptions, SankeyData } from '@visactor/vgrammar-sankey';
+import { SankeyLayout } from '@visactor/vgrammar-sankey';
 export interface ISankeyOpt extends SankeyOptions {
     targetField: string;
     sourceField: string;
@@ -9,6 +10,7 @@ export interface ISankeyOpt extends SankeyOptions {
         y0: number;
         y1: number;
     };
+    customLayout?: (layout: SankeyLayout, originalData: SankeyData, view: ReturnType<ISankeyOpt['view']>, option: ISankeyOpt) => ReturnType<SankeyLayout['layout']>;
 }
 export declare const collectHierarchyField: (set: Set<any>, data: any[], field: string) => void;
 export declare const sankeyFormat: (data: any[]) => SankeyData[];

package/types/plugin/chart/index.d.ts

@@ -1,3 +1,4 @@
 export * from './media-query';
 export * from './formatter';
 export * from './register';
+export * from './scroll';

package/types/plugin/chart/plugin-service.d.ts

@@ -6,6 +6,7 @@ import type { IChartSpecInfo } from '../../chart/interface/common';
 export declare class ChartPluginService<T extends IChartPlugin = IChartPlugin> extends BasePluginService<T> implements IChartPluginService<T> {
     globalInstance: IVChart;
     constructor(globalInstance: IVChart);
+    getPlugin(name: string): T | undefined;
     onInit(chartSpec: any): void;
     onBeforeResize(width: number, height: number): void;
     onAfterChartSpecTransform(chartSpec: any, actionSource: VChartRenderActionSource): void;

package/types/plugin/chart/scroll/scroll.d.ts

@@ -1,4 +1,4 @@
-import type { IGroup } from '@visactor/vrender-core';
+import type { IGroup, IRectGraphicAttribute } from '@visactor/vrender-core';
 import { BasePlugin } from '../../base/base-plugin';
 import type { IChartPluginService } from '../interface';
 import type { IScrollPlugin } from './interface';
@@ -6,11 +6,15 @@ export declare class ScrollPlugin extends BasePlugin implements IScrollPlugin {
     static readonly pluginType: 'chart';
     static readonly type: string;
     readonly type: string;
+    readonly name: string;
     private _service;
     private _spec;
+    private _lastScrollX;
+    private _lastScrollY;
     private _scrollLimit;
     private _xScrollComponent;
     private _yScrollComponent;
+    private _event;
     constructor();
     onInit(service: IChartPluginService, chartSpec: any): void;
     onLayoutRectUpdate(service: IChartPluginService): void;
@@ -19,9 +23,19 @@ export declare class ScrollPlugin extends BasePlugin implements IScrollPlugin {
     protected _bindEvent(service: IChartPluginService): void;
     protected getRootMark(): IGroup;
     protected onWheel: (e: WheelEvent) => void;
+    private _computeFinalScrollY;
+    private _computeFinalScrollX;
     private _updateScrollY;
     private _getYScrollComponent;
     private _updateScrollX;
     private _getXScrollComponent;
+    scrollTo({ x, y }: {
+        x?: number;
+        y?: number;
+    }): void;
 }
-export declare const registerScrollPlugin: () => void;
+export declare const registerScrollPlugin: (theme?: {
+    size?: number;
+    railStyle?: Omit<IRectGraphicAttribute, 'width' | 'height'>;
+    sliderStyle?: Omit<IRectGraphicAttribute, 'width' | 'height'>;
+}) => void;

package/types/series/sankey/interface.d.ts

@@ -4,6 +4,8 @@ import type { IRectMarkSpec, ILinkPathMarkSpec } from '../../typings/visual';
 import type { IAnimationSpec } from '../../animation/spec';
 import type { SeriesMarkNameEnum } from '../interface/type';
 import type { ILabelSpec } from '../../component/label/interface';
+import type { SankeyLayout } from '@visactor/vgrammar-sankey';
+import type { ISankeyOpt } from '../../data/transforms/sankey';
 export type SankeyMark = 'node' | 'link' | 'label';
 export type SankeyAppearPreset = 'growIn' | 'fadeIn';
 export interface ISankeyAnimationParams {
@@ -34,6 +36,7 @@ export interface ISankeySeriesSpec extends Omit<ISeriesSpec, 'data'>, IAnimation
     maxLinkHeight?: number;
     iterations?: number;
     nodeKey?: string | number | ((datum: SankeyNodeDatum) => string | number);
+    depthKey?: string | number | ((datum: SankeyNodeDatum) => string | number);
     linkSortBy?: (a: SankeyLinkElement, b: SankeyLinkElement) => number;
     nodeSortBy?: (a: SankeyNodeElement, b: SankeyNodeElement) => number;
     setNodeLayer?: (datum: SankeyNodeDatum) => number;
@@ -53,6 +56,7 @@ export interface ISankeySeriesSpec extends Omit<ISeriesSpec, 'data'>, IAnimation
     };
     [SeriesMarkNameEnum.label]?: ISankeyLabelSpec | ISankeyLabelSpec[];
     overflow?: 'scroll' | 'hidden' | 'scroll-x' | 'scroll-y';
+    customLayout?: (layout: SankeyLayout, originalData: SankeyData, view: ReturnType<ISankeyOpt['view']>) => ReturnType<SankeyLayout['layout']>;
 }
 export interface SankeyLinkDatum {
     source: string | number;