@logicflow/core 1.2.27 → 2.0.0-beta.1

package/{types → es}/model/GraphModel.d.ts

@@ -1,150 +1,83 @@
-import BaseNodeModel from './node/BaseNodeModel';
-import BaseEdgeModel from './edge/BaseEdgeModel';
-import EditConfigModel from './EditConfigModel';
-import TransformModel from './TransformModel';
-import { EventType, OverlapMode } from '../constant/constant';
-import { AdditionData, Point, NodeConfig, EdgeConfig, PointTuple, NodeMoveRule, GraphConfigData, VirtualRectSize } from '../type';
+import { BaseEdgeModel, BaseNodeModel, EditConfigModel, Model, TransformModel } from '.';
+import { ElementState, EventType, OverlapMode } from '../constant';
+import LogicFlow from '../LogicFlow';
+import { Options as LFOptions } from '../options';
 import EventEmitter from '../event/eventEmitter';
-import { Theme } from '../constant/DefaultTheme';
-import { Definition } from '../options';
-import { AnimationConfig } from '../constant/DefaultAnimation';
-declare type BaseNodeModelId = string;
-declare type ElementModeId = string;
-declare class GraphModel {
+import PointTuple = LogicFlow.PointTuple;
+import GraphData = LogicFlow.GraphData;
+import NodeConfig = LogicFlow.NodeConfig;
+export interface Constructable<T> {
+    new (...args: any): T;
+}
+export declare class GraphModel {
     /**
      * LogicFlow画布挂载元素
      * 也就是初始化LogicFlow实例时传入的container
      */
-    rootEl: HTMLElement;
-    /**
-     * LogicFlow画布宽度
-     */
+    readonly rootEl: HTMLElement;
+    readonly flowId?: string;
     width: number;
-    /**
-     * LogicFlow画布高度
-     */
     height: number;
+    theme: LogicFlow.Theme;
+    readonly eventCenter: EventEmitter;
+    readonly modelMap: Map<string, LogicFlow.GraphElementCtor>;
     /**
-     * 主题配置
-     * @see todo docs link
-     */
-    theme: Theme;
-    /**
-     * 事件中心
-     * @see todo docs link
-     */
-    eventCenter: EventEmitter;
-    /**
-     * 维护所有节点和边类型对应的model
-     */
-    modelMap: Map<any, any>;
-    /**
-     * 位于当前画布顶部的元素。
-     * 此元素只在堆叠模式为默认模式下存在。
-     * 用于在默认模式下将之前的顶部元素恢复初始高度。
-     */
-    topElement: BaseNodeModel | BaseEdgeModel;
-    /**
-     * 控制是否开启动画
+     * 位于当前画布顶部的元素
+     * 此元素只在堆叠模式为默认模式下存在
+     * 用于在默认模式下将之前的顶部元素回复初始高度
      */
-    animation: AnimationConfig;
-    /**
-     * 自定义全局id生成器
-     * @see todo docs link
-     */
-    idGenerator: (type?: string) => string;
-    /**
-     * 节点间连线、连线变更时的边的生成规则
-     */
-    edgeGenerator: Definition['edgeGenerator'];
+    topElement?: BaseNodeModel | BaseEdgeModel;
+    animation?: boolean | LFOptions.AnimationConfig;
+    idGenerator?: (type?: string) => string | undefined;
+    edgeGenerator: LFOptions.Definition['edgeGenerator'];
     /**
      * 节点移动规则判断
      * 在节点移动的时候，会出发此数组中的所有规则判断
      */
-    nodeMoveRules: NodeMoveRule[];
+    nodeMoveRules: Model.NodeMoveRule[];
     /**
      * 获取自定义连线轨迹
      */
-    customTrajectory: Definition['customTrajectory'];
-    /**
-     * 在图上操作创建边时，默认使用的边类型.
-     */
+    customTrajectory: LFOptions.Definition['customTrajectory'];
     edgeType: string;
-    /**
-     * 当前图上所有节点的model
-     */
     nodes: BaseNodeModel[];
-    /**
-     * 当前图上所有边的model
-     */
     edges: BaseEdgeModel[];
+    fakeNode?: BaseNodeModel | null;
     /**
-     * 元素重合时堆叠模式
-     * 默认模式，节点和边被选中，会被显示在最上面。当取消选中后，元素会恢复之前的层级。
-     * 递增模式，节点和边被选中，会被显示在最上面。当取消选中后，元素会保持层级。
-     * @see todo link
+     * 元素重合时堆叠模式：
+     * - DEFAULT（默认模式）：节点和边被选中，会被显示在最上面。当取消选中后，元素会恢复之前的层级
+     * - INCREASE（递增模式）：节点和边被选中，会被显示在最上面。当取消选中后，元素会保持当前层级
      */
     overlapMode: OverlapMode;
-    /**
-     * 背景配置
-     * @see todo link
-     */
-    background: any;
-    /**
-     * 控制画布的缩放、平移
-     * @see todo link
-     */
+    background?: boolean | LFOptions.BackgroundConfig;
+    gridSize: number;
     transformModel: TransformModel;
-    /**
-     * 控制流程图编辑相关配置
-     * @see todo link
-     */
     editConfigModel: EditConfigModel;
-    /**
-     * 网格大小
-     * @see todo link
-     */
-    gridSize: number;
-    /**
-     * 局部渲染
-     * @see todo logicflow性能
-     */
     partial: boolean;
-    /**
-     * 外部拖动节点进入画布的过程中，用fakerNode来和画布上正是的节点区分开
-     */
-    fakerNode: BaseNodeModel;
-    [key: string]: any;
-    constructor(options: Definition);
-    get nodesMap(): {
-        [key: string]: {
-            index: number;
-            model: BaseNodeModel;
-        };
-    };
+    [propName: string]: any;
+    constructor(options: LFOptions.Common);
+    get nodesMap(): GraphModel.NodesMapType;
     get edgesMap(): {
         [key: string]: {
             index: number;
             model: BaseEdgeModel;
         };
     };
-    get modelsMap(): {
-        [key: string]: BaseNodeModel | BaseEdgeModel;
-    };
+    get modelsMap(): GraphModel.ModelsMapType;
     /**
      * 基于zIndex对元素进行排序。
      * todo: 性能优化
      */
-    get sortElements(): any[];
+    get sortElements(): (BaseEdgeModel | BaseNodeModel)[];
     /**
      * 当前编辑的元素，低频操作，先循环找。
      */
-    get textEditElement(): BaseNodeModel | BaseEdgeModel;
+    get textEditElement(): BaseEdgeModel | BaseNodeModel | undefined;
     /**
      * 当前画布所有被选中的元素
      */
-    get selectElements(): Map<any, any>;
-    get selectNodes(): any[];
+    get selectElements(): Map<string, BaseEdgeModel | BaseNodeModel>;
+    get selectNodes(): BaseNodeModel[];
     /**
      * 获取指定区域内的所有元素
      * @param leftTopPoint 表示区域左上角的点
@@ -153,30 +86,21 @@ declare class GraphModel {
      * @param wholeNode 是否要整个节点都在区域内部
      * @param ignoreHideElement 是否忽略隐藏的节点
      */
-    getAreaElement(leftTopPoint: PointTuple, rightBottomPoint: PointTuple, wholeEdge?: boolean, wholeNode?: boolean, ignoreHideElement?: boolean): any[];
+    getAreaElement(leftTopPoint: PointTuple, rightBottomPoint: PointTuple, wholeEdge?: boolean, wholeNode?: boolean, ignoreHideElement?: boolean): LogicFlow.GraphElement[];
     /**
      * 获取指定类型元素对应的Model
      */
-    getModel(type: string): any;
+    getModel(type: string): LogicFlow.GraphElementCtor | undefined;
     /**
      * 基于Id获取节点的model
      */
-    getNodeModelById(nodeId: BaseNodeModelId): BaseNodeModel;
+    getNodeModelById(nodeId: string): BaseNodeModel | undefined;
     /**
      * 因为流程图所在的位置可以是页面任何地方
      * 当内部事件需要获取触发事件时，其相对于画布左上角的位置
      * 需要事件触发位置减去画布相对于client的位置
      */
-    getPointByClient({ x: x1, y: y1 }: Point): {
-        domOverlayPosition: {
-            x: number;
-            y: number;
-        };
-        canvasOverlayPosition: {
-            x: number;
-            y: number;
-        };
-    };
+    getPointByClient({ x: x1, y: y1, }: LogicFlow.Point): LogicFlow.ClientPosition;
     /**
      * 判断一个元素是否在指定矩形区域内。
      * @param element 节点或者边
@@ -185,21 +109,18 @@ declare class GraphModel {
      * @param wholeEdge 边的起点和终点都在区域内才算
      * @param wholeNode 节点的box都在区域内才算
      */
-    isElementInArea(element: any, lt: PointTuple, rb: PointTuple, wholeEdge?: boolean, wholeNode?: boolean): boolean;
+    isElementInArea(element: BaseEdgeModel | BaseNodeModel, lt: PointTuple, rb: PointTuple, wholeEdge?: boolean, wholeNode?: boolean): boolean;
     /**
      * 使用新的数据重新设置整个画布的元素
      * 注意：将会清除画布上所有已有的节点和边
      * @param { object } graphData 图数据
      */
-    graphDataToModel(graphData: GraphConfigData): void;
+    graphDataToModel(graphData: Partial<LogicFlow.GraphConfigData>): void;
     /**
      * 获取画布数据
      */
-    modelToGraphData(): GraphConfigData;
-    modelToHistoryData(): false | {
-        nodes: any[];
-        edges: any[];
-    };
+    modelToGraphData(): GraphData;
+    modelToHistoryData(): GraphData | false;
     /**
      * 获取边的model
      */
@@ -211,13 +132,13 @@ declare class GraphModel {
     /**
      * 所有节点上所有边的model
      */
-    getNodeEdges(nodeId: any): BaseEdgeModel[];
+    getNodeEdges(nodeId: string): BaseEdgeModel[];
     /**
      * 获取选中的元素数据
      * @param isIgnoreCheck 是否包括sourceNode和targetNode没有被选中的边,默认包括。
      * 复制的时候不能包括此类边, 因为复制的时候不允许悬空的边
      */
-    getSelectElements(isIgnoreCheck?: boolean): GraphConfigData;
+    getSelectElements(isIgnoreCheck?: boolean): GraphData;
     /**
      * 修改对应元素 model 中的属性
      * 注意：此方法慎用，除非您对logicflow内部有足够的了解。
@@ -229,11 +150,11 @@ declare class GraphModel {
     updateAttributes(id: string, attributes: object): void;
     /**
      * 修改节点的id， 如果不传新的id，会内部自动创建一个。
-     * @param { string } oldId 将要被修改的id
+     * @param { string } nodeId 将要被修改的id
      * @param { string } newId 可选，修改后的id
      * @returns 修改后的节点id, 如果传入的oldId不存在，返回空字符串
      */
-    changeNodeId<T extends string>(oldId: any, newId?: T | string): T | string;
+    changeNodeId(nodeId: string, newId?: string): string;
     /**
      * 修改边的id， 如果不传新的id，会内部自动创建一个。
      * @param { string } oldId 将要被修改的id
@@ -244,15 +165,15 @@ declare class GraphModel {
     /**
      * 内部保留方法，请勿直接使用
      */
-    setFakerNode(nodeModel: BaseNodeModel): void;
+    setFakeNode(nodeModel: BaseNodeModel): void;
     /**
      * 内部保留方法，请勿直接使用
      */
-    removeFakerNode(): void;
+    removeFakeNode(): void;
     /**
      * 设置指定类型的Model,请勿直接使用
      */
-    setModel(type: string, ModelClass: any): Map<any, any>;
+    setModel(type: string, ModelClass: LogicFlow.GraphElementCtor): Map<string, LogicFlow.GraphElementCtor>;
     /**
      * 将某个元素放置到顶部。
      * 如果堆叠模式为默认模式，则将原置顶元素重新恢复原有层级。
@@ -260,67 +181,69 @@ declare class GraphModel {
      * @see todo link 堆叠模式
      * @param id 元素Id
      */
-    toFront(id: any): void;
+    toFront(id: string): void;
     /**
      * 设置元素的zIndex.
      * 注意：默认堆叠模式下，不建议使用此方法。
      * @see todo link 堆叠模式
      * @param id 元素id
-     * @param zIndex zIndex的值，可以传数字，也支持传入'top' 和 'bottom'
+     * @param zIndex zIndex的值，可以传数字，也支持传入 'top' 和 'bottom'
      */
     setElementZIndex(id: string, zIndex: number | 'top' | 'bottom'): void;
     /**
      * 删除节点
      * @param {string} nodeId 节点Id
      */
-    deleteNode(id: any): void;
+    deleteNode(nodeId: string): void;
     /**
      * 添加节点
      * @param nodeConfig 节点配置
      * @param eventType 新增节点事件类型，默认EventType.NODE_ADD, 在Dnd拖拽时，会传入EventType.NODE_DND_ADD
+     * @param event MouseEvent 鼠标事件
      */
-    addNode(nodeConfig: NodeConfig, eventType?: EventType, event?: MouseEvent): any;
+    addNode(nodeConfig: NodeConfig, eventType?: EventType, event?: MouseEvent): BaseNodeModel;
     /**
      * 将node节点位置进行grid修正
      * 同时处理node内文字的偏移量
      * 返回一个位置修正过的复制节点NodeModel
      * @param node
      */
-    getModelAfterSnapToGrid(node: NodeConfig): any;
+    getModelAfterSnapToGrid(node: NodeConfig): BaseNodeModel;
     /**
-    * 克隆节点
-    * @param nodeId 节点Id
-    */
-    cloneNode(nodeId: string): BaseNodeModel;
+     * 克隆节点
+     * @param nodeId 节点Id
+     */
+    cloneNode(nodeId: string): LogicFlow.NodeData | undefined;
     /**
      * 移动节点-相对位置
-     * @param nodeModel 节点Id
+     * @param nodeId 节点Id
      * @param deltaX X轴移动距离
      * @param deltaY Y轴移动距离
      * @param isIgnoreRule 是否忽略移动规则限制
      */
-    moveNode(nodeId: BaseNodeModelId, deltaX: number, deltaY: number, isIgnoreRule?: boolean): void;
+    moveNode(nodeId: string, deltaX: number, deltaY: number, isIgnoreRule?: boolean): void;
     /**
      * 移动节点-绝对位置
-     * @param nodeModel 节点Id
+     * @param nodeId 节点Id
      * @param x X轴目标位置
      * @param y Y轴目标位置
+     * @param isIgnoreRule 是否忽略条件，默认为 false
      */
-    moveNode2Coordinate(nodeId: BaseNodeModelId, x: number, y: number, isIgnoreRule?: boolean): void;
+    moveNode2Coordinate(nodeId: string, x: number, y: number, isIgnoreRule?: boolean): void;
     /**
      * 显示节点、连线文本编辑框
-     * @param elementId 节点id
+     * @param id 节点 or 连线 id
      */
-    editText(id: ElementModeId): void;
+    editText(id: string): void;
     /**
      * 给两个节点之间添加一条边
      * @param {object} edgeConfig
      */
-    addEdge(edgeConfig: EdgeConfig): BaseEdgeModel;
+    addEdge(edgeConfig: LogicFlow.EdgeConfig): BaseEdgeModel;
     /**
      * 移动边，内部方法，请勿直接使用
      */
-    moveEdge(nodeId: BaseNodeModelId, deltaX: number, deltaY: number): void;
+    moveEdge(nodeId: string, deltaX: number, deltaY: number): void;
     /**
      * 如果有文案了，当节点移动引起文案位置修改时，找出当前文案位置与最新边距离最短距离的点
      * 最大程度保持节点位置不变且在边上
@@ -334,31 +257,31 @@ declare class GraphModel {
      * @param sourceNodeId 边的起始节点
      * @param targetNodeId 边的目的节点
      */
-    deleteEdgeBySourceAndTarget(sourceNodeId: any, targetNodeId: any): void;
+    deleteEdgeBySourceAndTarget(sourceNodeId: string, targetNodeId: string): void;
     /**
      * 基于边Id删除边
      */
-    deleteEdgeById(id: any): void;
+    deleteEdgeById(id: string): void;
     /**
      * 删除以节点Id为起点的所有边
      */
-    deleteEdgeBySource(sourceNodeId: any): void;
+    deleteEdgeBySource(sourceNodeId: string): void;
     /**
      * 删除以节点Id为终点的所有边
      */
-    deleteEdgeByTarget(targetNodeId: any): void;
+    deleteEdgeByTarget(targetNodeId: string): void;
     /**
      * 设置元素的状态，在需要保证整个画布上所有的元素只有一个元素拥有此状态时可以调用此方法。
      * 例如文本编辑、菜单显示等。
      * additionStateData: 传递的额外值，如菜单显示的时候，需要传递期望菜单显示的位置。
      */
-    setElementStateById(id: ElementModeId, state: number, additionStateData?: AdditionData): void;
+    setElementStateById(id: string, state: ElementState, additionStateData?: Model.AdditionStateDataType): void;
     /**
      * 更新节点或边的文案
      * @param id 节点或者边id
      * @param value 文案内容
      */
-    updateText(id: ElementModeId, value: string): void;
+    updateText(id: string, value: string): void;
     /**
      * 选中节点
      * @param id 节点Id
@@ -400,54 +323,55 @@ declare class GraphModel {
      * })
      *
      */
-    addNodeMoveRules(fn: NodeMoveRule): void;
+    addNodeMoveRules(fn: Model.NodeMoveRule): void;
     /**
      * 设置默认的边类型
      * 也就是设置在节点直接有用户手动绘制的连线类型。
-     * @param type Options.EdgeType
+     * @param type LFOptions.EdgeType
      */
-    setDefaultEdgeType(type: string): void;
+    setDefaultEdgeType(type: LFOptions.EdgeType): void;
     /**
-    * 修改指定节点类型
-    * @param id 节点id
-    * @param type 节点类型
-    */
-    changeNodeType(id: any, type: string): void;
+     * 修改指定节点类型
+     * @param id 节点id
+     * @param type 节点类型
+     */
+    changeNodeType(id: string, type: string): void;
     /**
      * 切换边的类型
      * @param id 边Id
      * @param type 边类型
      */
-    changeEdgeType(id: any, type: any): void;
+    changeEdgeType(id: string, type: LFOptions.EdgeType): void;
     /**
      * 获取所有以此节点为终点的边
      */
-    getNodeIncomingEdge(nodeId: any): any[];
+    getNodeIncomingEdge(nodeId: string): BaseEdgeModel[];
     /**
      * 获取所有以此节点为起点的边
      */
-    getNodeOutgoingEdge(nodeId: any): any[];
+    getNodeOutgoingEdge(nodeId: string): BaseEdgeModel[];
     /**
      * 获取所有以此锚点为终点的边
      */
-    getAnchorIncomingEdge(anchorId: any): any[];
+    getAnchorIncomingEdge(anchorId?: string): BaseEdgeModel[];
     /**
+     * TODO: 命名问题 outcoming -> outgoing or incoming
      * 获取所有以此锚点为起点的边
      */
-    getAnchorOutcomingEdge(anchorId: any): any[];
+    getAnchorOutcomingEdge(anchorId?: string): BaseEdgeModel[];
     /**
      * 获取节点连接到的所有起始节点
      */
-    getNodeIncomingNode(nodeId: any): any[];
+    getNodeIncomingNode(nodeId?: string): BaseNodeModel[];
     /**
      * 获取节点连接到的所有目标节点
      */
-    getNodeOutgoingNode(nodeId: any): any[];
+    getNodeOutgoingNode(nodeId?: string): BaseNodeModel[];
     /**
      * 设置主题
      * todo docs link
      */
-    setTheme(style: Theme): void;
+    setTheme(style: Partial<LogicFlow.Theme>): void;
     /**
      * 重新设置画布的宽高
      */
@@ -460,7 +384,7 @@ declare class GraphModel {
      * 获取图形区域虚拟矩型的尺寸和中心坐标
      * @returns
      */
-    getVirtualRectSize(): VirtualRectSize;
+    getVirtualRectSize(): GraphModel.VirtualRectProps;
     /**
      * 将图形整体移动到画布中心
      */
@@ -473,14 +397,30 @@ declare class GraphModel {
     fitView(verticalOffset?: number, horizontalOffset?: number): void;
     /**
      * 开启边的动画
-     * @param edgeId any
+     * @param edgeId string
      */
-    openEdgeAnimation(edgeId: any): void;
+    openEdgeAnimation(edgeId: string): void;
     /**
      * 关闭边的动画
-     * @param edgeId any
+     * @param edgeId string
      */
-    closeEdgeAnimation(edgeId: any): void;
+    closeEdgeAnimation(edgeId: string): void;
+}
+export declare namespace GraphModel {
+    type NodesMapType = Record<string, {
+        index: number;
+        model: BaseNodeModel;
+    }>;
+    type EdgesMapType = Record<string, {
+        index: number;
+        model: BaseEdgeModel;
+    }>;
+    type ModelsMapType = Record<string, BaseNodeModel | BaseEdgeModel>;
+    type VirtualRectProps = {
+        width: number;
+        height: number;
+        x: number;
+        y: number;
+    };
 }
-export { GraphModel };
 export default GraphModel;