@moxa/graph 3.0.0-beta.1 → 3.0.0-beta.11

package/core/graph/graph.d.ts

@@ -4,91 +4,98 @@ import { DataController } from '@antv/g6/lib/runtime/data';
 import { ElementController } from '@antv/g6/lib/runtime/element';
 import { ViewportController } from '@antv/g6/lib/runtime/viewport';
 import { BehaviorConfig, DesignTokenConfig, EdgeData, ElementType, GraphConfig, GraphData, GraphRendererType, GroupData, LayoutConfig, NodeData, PartialEdgeData, PartialGroupData, PartialNodeData, PluginConfig, TokenConfig, TokenValues, UserThemeType, ZoomRange } from '../model';
+import { DrillDownState } from '../../behaviors/drill-down';
 declare class Graph {
     private renderer;
     private dataManager;
     private configManager;
+    private historyDrillCleanup;
     graphReady: boolean;
     /**
-     * 獲取圖形實例
-     * @returns 圖形實例
+     * Get graph instance
+     * @returns Graph instance
      */
     get graph(): G6Graph;
     /**
-     * 獲取容器元素
-     * @returns 容器元素
+     * Get container element
+     * @returns Container element
      */
     get container(): HTMLElement;
     /**
-     * 獲取畫布元素
-     * @returns 畫布元素
+     * Get canvas element
+     * @returns Canvas element
      */
     get canvas(): HTMLCanvasElement | SVGAElement;
     /**
-     * 獲取元素控制器
-     * @returns 元素控制器
+     * Get element controller
+     * @returns Element controller
      */
     get elementController(): ElementController;
     /**
-     * 獲取數據控制器
-     * @returns 數據控制器
+     * Get data controller
+     * @returns Data controller
      */
     get dataController(): DataController;
     /**
-     * 獲取行為控制器
-     * @returns 行為控制器
+     * Get behavior controller
+     * @returns Behavior controller
      */
     get behaviorController(): BehaviorController;
     /**
-     * 獲取視野控制器
-     * @returns 視野控制器
+     * Get viewport controller
+     * @returns Viewport controller
      */
     get viewportController(): ViewportController;
     /**
-     * 獲取代幣配置
-     * @returns 代幣配置
+     * Get token config
+     * @returns Token config
      */
     get tokenConfig(): TokenConfig;
     /**
-     * 獲取圖示精靈文字
-     * @returns 圖示精靈文字
+     * Get icon sprite text
+     * @returns Icon sprite text
      */
     get iconSpriteText(): string;
     /**
-     * 建構函數
-     * @param config - 圖形配置
+     * Constructor
+     * @param config - Graph config
      */
     constructor(config: GraphConfig);
     /**
-     * 初始化圖形
+     * Initialize graph
      */
     private initGraph;
     /**
-     * 設置事件處理器
+     * Setup event handlers
      */
     private setupEventHandlers;
     /**
-     * 檢查元素是否存在
-     * @param id - 元素ID
-     * @returns 元素是否存在
+     * Setup History and Drill-Down integration
+     * Each drill level has its own independent history stack
+     */
+    private setupHistoryDrillIntegration;
+    /**
+     * Check if element exists
+     * @param id - Element ID
+     * @returns Whether element exists
      */
     isElementExist(id: string): boolean;
     /**
-     * 檢查元素是否顯示
-     * @param id - 元素ID
-     * @returns 元素是否顯示
+     * Check if element is visible
+     * @param id - Element ID
+     * @returns Whether element is visible
      */
     isElementShow(id: string): boolean;
     /**
-     * 檢查元素是否在視野內
-     * @param id - 元素ID
-     * @returns 元素是否在視野內
+     * Check if element is in viewport
+     * @param id - Element ID
+     * @returns Whether element is in viewport
      */
     isElementInView(id: string): boolean;
     /**
-     * 獲取元素的邊界框
-     * @param id - 元素ID或元素ID列表
-     * @returns 元素的邊界框
+     * Get element bounding box
+     * @param id - Element ID or array of element IDs
+     * @returns Element bounding box
      */
     getElementBoundingBox(id: string | string[]): {
         width: number;
@@ -99,121 +106,122 @@ declare class Graph {
         max: import('@antv/g').Tuple3Number;
     };
     /**
-     * 獲取圖形配置
-     * @returns 當前圖形配置
+     * Get graph config
+     * @returns Current graph config
      */
     getConfig(): GraphConfig;
     /**
-     * 獲取圖形大小
-     * @returns 圖形的寬度和高度
+     * Get graph size
+     * @returns Width and height of the graph
      */
     getSize(): {
         width: number;
         height: number;
     };
     /**
-     * 獲取元素類型
-     * @param id - 元素ID
-     * @returns 元素類型
+     * Get element type
+     * @param id - Element ID
+     * @returns Element type
      */
     getElementType(id: string): ElementType | null;
     /**
-     * 獲取元素狀態
-     * @param id - 元素ID
-     * @returns 元素狀態
+     * Get element state
+     * @param id - Element ID
+     * @returns Element state
      */
     getElementState(id: string): string[];
     /**
-     * 根據狀態獲取元素
-     * @param type - 元素類型
-     * @param state - 元素狀態
-     * @returns 元素數據
+     * Get elements by state
+     * @param type - Element type
+     * @param state - Element state
+     * @returns Element data
      */
     getElementByState(type: 'node', state: string): NodeData[];
     getElementByState(type: 'edge', state: string): EdgeData[];
     getElementByState(type: 'group', state: string): GroupData[];
     /**
-     * 根據元素類型獲取元素數據
-     * @param types - 元素類型列表
-     * @returns 元素數據列表
+     * Get element data by types
+     * @param types - Element type list
+     * @returns Element data list
      */
     getElementByTypes(types: ElementType[]): (NodeData | EdgeData | GroupData)[];
     /**
-     * 設置渲染器
-     * @param renderer - 渲染器類型
+     * Set renderer
+     * @param renderer - Renderer type
      */
     setRenderer(renderer: GraphRendererType): void;
     /**
-     * 獲取主題
-     * @returns 當前主題
+     * Get theme
+     * @returns Current theme
      */
     getTheme(): UserThemeType;
     getThemeTokens(): TokenValues;
     /**
-     * 設置主題
-     * @param theme - 主題類型
+     * Set theme
+     * @param theme - Theme type
      */
     setTheme(theme: UserThemeType): void;
-    setThemeTokens(config: DesignTokenConfig | any): void;
+    setThemeTokens(_config: DesignTokenConfig | any): void;
     /**
-     * 獲取佈局配置
-     * @returns 佈局配置
+     * Get layout config
+     * @returns Layout config
      */
     getLayout(): LayoutConfig;
     /**
-     * 設置佈局配置
-     * @param config - 佈局配置
+     * Set layout config
+     * @param config - Layout config
      */
     setLayout(config: LayoutConfig): void;
     /**
-     * 執行佈局計算
-     * @param layoutOptions - 可選的佈局配置，若提供則優先使用
+     * Execute layout
+     * @param layoutOptions - Optional layout config, takes priority if provided
      */
     layout(layoutOptions?: LayoutConfig): Promise<void>;
     /**
-     * 調整圖形大小
-     * @param width - 寬度
-     * @param height - 高度
+     * Resize graph
+     * @param width - Width
+     * @param height - Height
      */
     resize(): void;
     resize(width?: number, height?: number): void;
     /**
-     * 刷新圖形
+     * Refresh graph
      */
     refresh(): void;
     /**
-     * 設置是否自動調整大小
-     * @param auto - 是否自動調整大小
+     * Set auto size
+     * @param auto - Whether to auto size
      */
     autoSize(auto: boolean): void;
     /**
-     * 縮放圖形
-     * @param ratio - 縮放比例
+     * Zoom graph
+     * @param ratio - Zoom ratio
      */
     zoom(ratio: number): void;
     /**
-     * 縮放到指定比例
-     * @param ratio - 縮放比例
+     * Zoom to ratio
+     * @param ratio - Zoom ratio
      */
     zoomTo(ratio: number): void;
     /**
-     * 獲取當前縮放比例
-     * @returns 縮放比例
+     * Get current zoom ratio
+     * @returns Zoom ratio
      */
     getZoom(): number;
     /**
-     * @param zoomRange - 設定縮放比例範圍
-     * @example [0.5, 5] - [min, max] 包含最小和最大縮放比例
+     * Set zoom range
+     * @param zoomRange - Zoom range
+     * @example [0.5, 5] - [min, max] includes min and max zoom ratio
      */
     setZoomRange(zoomRange: ZoomRange): void;
     /**
-     * 獲取縮放比例範圍
-     * @returns {ZoomRange} 取得縮放比例範圍
+     * Get zoom range
+     * @returns {ZoomRange} Zoom range
      */
     getZoomRange(): ZoomRange;
     /**
-     * 獲取常用點
-     * @returns 常用點
+     * Get common points
+     * @returns Common points
      */
     getCommonPoints(): {
         middle: {
@@ -238,14 +246,14 @@ declare class Graph {
         };
     };
     /**
-     * 獲取圖形邊界矩形
-     * @returns 邊界矩形
+     * Get graph bounding rect
+     * @returns Bounding rect
      */
     getBoundingRect(): DOMRect;
     /**
-     * 將畫布坐標轉換為視口坐標
-     * @param point - 畫布坐標
-     * @returns 視口坐標
+     * Convert canvas coordinates to viewport coordinates
+     * @param point - Canvas coordinates
+     * @returns Viewport coordinates
      */
     canvasToViewport(point: {
         x: number;
@@ -255,9 +263,9 @@ declare class Graph {
         y: number;
     };
     /**
-     * 將視口坐標轉換為畫布坐標
-     * @param point - 視口坐標
-     * @returns 畫布坐標
+     * Convert viewport coordinates to canvas coordinates
+     * @param point - Viewport coordinates
+     * @returns Canvas coordinates
      */
     viewportToCanvas(point: {
         x: number;
@@ -267,197 +275,220 @@ declare class Graph {
         y: number;
     };
     /**
-     * 適應視口
+     * Fit view
      */
     fitView(): void;
     /**
-     * 適應中心
+     * Fit center
      */
     fitCenter(): void;
     /**
-     * 聚焦元素
-     * @param id - 元素ID
+     * Focus element
+     * @param id - Element ID
      */
     focusItem(id: string): void;
     /**
-     * 撤銷上一步操作
+     * Undo last operation
      */
     undo(): void;
     /**
-     * 重做上一步操作
+     * Redo last operation
      */
     redo(): void;
     /**
-     * 渲染圖形
+     * Drill into specified group
+     * @param groupId - Group ID to drill into
+     */
+    drillIntoGroup(groupId: string): void;
+    /**
+     * Drill out of current group
+     */
+    drillOutOfGroup(): void;
+    /**
+     * Reset drill navigation to root level
+     */
+    resetDrill(): void;
+    /**
+     * Get current drill-down state
+     * @returns Current drill-down state, returns undefined if drill-down behavior is not enabled
+     */
+    getDrillDownState(): DrillDownState | undefined;
+    /**
+     * Set drill-down state
+     * @param state - New drill-down state
+     */
+    setDrillDownState(state: DrillDownState): void;
+    /**
+     * Render graph
      */
     render(): void;
     /**
-     * 設置圖形數據
-     * @param data - 圖形數據
+     * Set graph data
+     * @param data - Graph data
      */
     setData(data: GraphData): void;
     /**
-     * 清空圖形
+     * Clear graph
      */
     clear(): Promise<void>;
     destroy(): Promise<void>;
     /**
-     * 獲取事件
-     * @returns 事件對象
+     * Get events
+     * @returns Event object
      */
     getEvent(): Record<string, any>;
     /**
-     * 檢查是否有指定事件
-     * @param eventName - 事件名稱
-     * @returns 是否有指定事件
+     * Check if event exists
+     * @param eventName - Event name
+     * @returns Whether event exists
      */
     hasEvent(eventName: string): boolean;
     /**
-     * 獲取行為配置
-     * @returns BehaviorConfig 格式的行為配置
+     * Get behavior config
+     * @returns Behavior config in BehaviorConfig format
      */
     getBehavior(): BehaviorConfig;
     /**
-     * 獲取行為實例
-     * @param key - 行為的唯一識別符
-     * @returns 行為實例
+     * Get behavior instance
+     * @param key - Unique identifier for behavior
+     * @returns Behavior instance
      */
     getBehaviorInstance<T extends BaseBehaviorOptions = any>(key: string): BaseBehavior<T>;
     /**
-     * 設置行為配置
-     * @param config - BehaviorConfig 行為配置
+     * Set behavior config
+     * @param config - BehaviorConfig behavior config
      */
     setBehavior(config: BehaviorConfig): void;
     /**
-     * 監聽事件
-     * @param eventName - 事件名稱
-     * @param callback - 回調函數
+     * Listen to event
+     * @param eventName - Event name
+     * @param callback - Callback function
      */
     on<T extends IEvent>(eventName: string, callback: (e: T) => void): void;
     /**
-     * 監聽事件（一次性）
-     * @param eventName - 事件名稱
-     * @param callback - 回調函數
+     * Listen to event (once)
+     * @param eventName - Event name
+     * @param callback - Callback function
      */
     once<T extends IEvent>(eventName: string, callback: (e: T) => void): void;
     /**
-     * 取消監聽事件
-     * @param eventName - 事件名稱
-     * @param callback - 回調函數
+     * Remove event listener
+     * @param eventName - Event name
+     * @param callback - Callback function
      */
     off(): void;
     off(eventName: string): void;
     /**
-     * 獲取節點數據
-     * @param id - 節點ID
-     * @returns 節點數據
+     * Get node data
+     * @param id - Node ID
+     * @returns Node data
      */
     getNodeData(): NodeData[];
     getNodeData(id: string): NodeData;
     getNodeData(id: string[]): NodeData[];
     /**
-     * 添加節點
-     * @param node - 節點數據
+     * Add node
+     * @param node - Node data
      */
     addNode(node: NodeData | NodeData[]): void;
     /**
-     * 更新節點
-     * @param node - 節點數據
+     * Update node
+     * @param node - Node data
      */
     updateNode(node: PartialNodeData | PartialNodeData[]): void;
     /**
-     * 移除節點
-     * @param id - 節點ID
+     * Remove node
+     * @param id - Node ID
      */
     removeNode(id: string | string[]): void;
     /**
-     * 顯示元素
-     * @param id - 元素ID
+     * Show element
+     * @param id - Element ID
      */
     showElement(id: string | string[]): void;
     /**
-     * 隱藏元素
-     * @param id - 元素ID
+     * Hide element
+     * @param id - Element ID
      */
     hideElement(id: string | string[]): void;
     /**
-     * 移除任一元素
-     * @param id - 元素ID，可以是字符串或字符串数组
+     * Remove element
+     * @param id - Element ID, can be string or string array
      */
     removeElement(id: string | string[]): void;
     /**
-     * 設置元素狀態
-     * @param stateMap - 狀態映射
+     * Set element state
+     * @param stateMap - State map
      */
     setElementState(stateMap: Record<string, State | State[]>): void;
     /**
-     * 清除元素狀態
-     * @param id - 元素ID
+     * Clear element state
+     * @param id - Element ID
      */
     clearElementState(id: string | string[]): void;
     /**
-     * 獲取邊數據
-     * @param id - 邊ID
-     * @returns 邊數據
+     * Get edge data
+     * @param id - Edge ID
+     * @returns Edge data
      */
     getEdgeData(): EdgeData[];
     getEdgeData(id: string): EdgeData;
     getEdgeData(id: string[]): EdgeData[];
     /**
-     * 檢查節點是否孤立
-     * @param nodeId - 節點ID
-     * @returns 是否孤立
+     * Check if node is isolated
+     * @param nodeId - Node ID
+     * @returns Whether isolated
      */
     isIsolated(nodeId: string): boolean;
     /**
-     * 添加邊
-     * @param edge - 邊數據
+     * Add edge
+     * @param edge - Edge data
      */
     addEdge(edge: EdgeData | EdgeData[]): void;
     /**
-     * 移除邊
-     * @param id - 邊ID
+     * Remove edge
+     * @param id - Edge ID
      */
     removeEdge(id: string | string[]): void;
     /**
-     * 更新邊
-     * @param edge - 邊數據
+     * Update edge
+     * @param edge - Edge data
      */
     updateEdge(edge: PartialEdgeData | PartialEdgeData[]): void;
     /**
-     * 獲取組數據
-     * @param id - 組ID
-     * @returns 組數據
+     * Get group data
+     * @param id - Group ID
+     * @returns Group data
      */
     getGroupData(): GroupData[];
     getGroupData(id: string): GroupData;
     getGroupData(id: string[]): GroupData[];
     /**
-     * 獲取子元素數據
-     * @param id - 元素ID
-     * @param option - 選項
-     * @param option.level - 遞迴層級
-     * @returns 子元素數據
+     * Get children data
+     * @param id - Element ID
+     * @param option - Options
+     * @param option.level - Recursive level
+     * @returns Children data
      */
     getChildrenData(id: string, option?: {
         level?: number;
     }): (NodeData | GroupData)[];
     /**
-     * 添加組
-     * @param group - 組數據
+     * Add group
+     * @param group - Group data
      */
     addGroup(group: GroupData | GroupData[]): void;
     /**
-     * 將一組元素分配到指定的組。
+     * Assign elements to a specified group.
      *
-     * 此方法將 `ids` 數組中每個元素的父組更新為提供的 `groupId`。它首先檢查 `ids` 數組中的任何元素是否是 `groupId` 的子元素，如果是，則記錄警告並退出而不進行任何更改。
+     * This method updates the parent group of each element in the `ids` array to the provided `groupId`. It first checks if any element in the `ids` array is a child of `groupId`, and if so, logs a warning and exits without making any changes.
      *
-     * @param ids - 要分配到組的元素ID數組。
-     * @param groupId - 要分配元素的組ID。
+     * @param ids - Array of element IDs to assign to the group.
+     * @param groupId - Group ID to assign elements to.
      *
      * @remarks
-     * - 如果 `ids` 數組中的某個元素已經是 `groupId` 的子元素，該方法將記錄警告並且不會對任何元素進行分配。
-     * - 該方法確定每個元素的類型（'node' 或 'group'），並相應地進行更新。
+     * - If an element in the `ids` array is already a child of `groupId`, the method will log a warning and not assign any elements.
+     * - The method determines the type of each element ('node' or 'group') and updates accordingly.
      *
      * @example
      * ```typescript
@@ -468,43 +499,43 @@ declare class Graph {
      */
     assignGroup(ids: string[], groupId: string): void;
     /**
-     * 移除組
-     * @param id - 組ID，可以是單個字符串或字符串数组
-     * @param option - 選項
-     * @param option.recursive - 是否遞迴移除子組，默認為false
+     * Remove group
+     * @param id - Group ID, can be single string or string array
+     * @param option - Options
+     * @param option.recursive - Whether to recursively remove child groups, defaults to false
      */
     removeGroup(id: string | string[], option?: {
         recursive?: boolean;
     }): void;
     /**
-     * 更新組
-     * @param group - 組數據
+     * Update group
+     * @param group - Group data
      */
     updateGroup(group: PartialGroupData | PartialGroupData[]): void;
     /**
-     * 展開組
-     * @param id - 組ID
+     * Expand group
+     * @param id - Group ID
      */
-    expandGroup(id: string | string[]): void;
+    expandGroup(id: string | string[]): Promise<void>;
     /**
-     * 折疊組
-     * @param id - 組ID
+     * Collapse group
+     * @param id - Group ID
      */
-    collapseGroup(id: string | string[]): void;
+    collapseGroup(id: string | string[]): Promise<void>;
     /**
-     * 獲取插件配置
-     * @returns PluginConfig 格式的插件配置
+     * Get plugin config
+     * @returns Plugin config in PluginConfig format
      */
     getPlugin(): PluginConfig;
     /**
-     * 獲取插件實例
-     * @param keyOrType - 插件的鍵或類型
-     * @returns 插件實例
+     * Get plugin instance
+     * @param keyOrType - Plugin key or type
+     * @returns Plugin instance
      */
     getPluginInstance<T>(keyOrType: string): T;
     /**
-     * 設置插件配置
-     * @param config - PluginConfig 插件配置
+     * Set plugin config
+     * @param config - PluginConfig plugin config
      */
     setPlugin(config: PluginConfig): void;
 }