@logicflow/core 1.2.0-alpha.4 → 1.2.0-alpha.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logicflow/core",
-  "version": "1.2.0-alpha.4",
+  "version": "1.2.0-alpha.5",
   "description": "LogicFlow core, to quickly build flowchart editor",
   "main": "dist/logic-flow.js",
   "unpkg": "dist/logic-flow.js",

package/types/model/node/BaseNodeModel.d.ts

@@ -196,7 +196,14 @@ export default class BaseNodeModel implements IBaseNodeModel {
     setProperties(properties: any): void;
     setZIndex(zIndex?: number): void;
     /**
-     * @deprecated 不推荐直接使用updateAttributes，请使用setProperties、updateText、move等方法更新节点属性。
+     * 设置节点属性；
+     * 支持属性请参考节点属性文档
+     * http://logic-flow.org/api/nodeModelApi.html#%E6%95%B0%E6%8D%AE%E5%B1%9E%E6%80%A7
+     * @example
+     * nodeModel.updateAttributes({
+     *  width: 100,
+     *  height: 100
+     * })
      */
     updateAttributes(attributes: any): void;
 }

package/types/util/edge.d.ts

@@ -26,8 +26,11 @@ export declare const isBboxOverLapping: (b1: PBBox, b2: PBBox) => boolean;
 export declare const filterRepeatPoints: (points: PolyPoint[]) => PolyPoint[];
 export declare const getSimplePolyline: (sPoint: PolyPoint, tPoint: PolyPoint) => PolyPoint[];
 export declare const getExpandedBBox: (bbox: PBBox, offset: number) => PBBox;
-export declare const pointDirection: (point: PolyPoint, bbox: PBBox) => Direction;
-export declare const getExpandedBBoxPoint: (bbox: PBBox, point: PolyPoint) => PolyPoint;
+/**
+ * 判断点与中心点边的方向：是否水平，true水平，false垂直
+ */
+export declare const pointDirection: (point: PolyPoint, node: BaseNode) => Direction;
+export declare const getExpandedBBoxPoint: (bbox: PBBox, point: PolyPoint, direction: any) => PolyPoint;
 export declare const mergeBBox: (b1: PBBox, b2: PBBox) => PBBox;
 export declare const getBBoxOfPoints: (points?: PolyPoint[], offset?: number) => PBBox;
 export declare const getPointsFromBBox: (bbox: PBBox) => PolyPoint[];
@@ -46,6 +49,14 @@ export declare const getNextNeighborPoints: (points: PolyPoint[], point: PolyPoi
 export declare const pathFinder: (points: PolyPoint[], start: PolyPoint, goal: PolyPoint, sBBox: PBBox, tBBox: PBBox, os: PolyPoint, ot: PolyPoint) => PolyPoint[];
 export declare const getBoxByOriginNode: (node: BaseNode) => PBBox;
 export declare const pointFilter: (points: PolyPoint[]) => PolyPoint[];
+/**
+ * 计算折线点
+ * @param start 连线的开始点坐标
+ * @param end 连线的结束点坐标
+ * @param sNode 连线连接的开始节点
+ * @param tNode 连线连接的结束节点
+ * @param offset 连线箭头距离
+ */
 export declare const getPolylinePoints: (start: PolyPoint, end: PolyPoint, sNode: BaseNode, tNode: BaseNode, offset: number) => PolyPoint[];
 /**
  * 获取折线中最长的一个线