@logicflow/core 2.2.2 → 2.2.3-alpha.0

package/dist/docs/api/logicflow-instance/canvas.zh.md

@@ -1,199 +0,0 @@
----
-nav: API
-group:
-  title: LogicFlow 实例
-  order: 2
-title: 画布相关
-toc: content
-order: 8
----
-
-本页汇总 LogicFlow 实例中与画布尺寸、视口变换、坐标换算和边动画相关的方法。
-
-### resize
-
-调整画布尺寸；未传参数时自动按容器尺寸重算。
-
-**签名**
-
-```ts
-resize(width?: number, height?: number): void
-```
-
-**参数**
-
-| 名称 | 类型 | 必传 | 说明 |
-| :--- | :--- | :--- | :--- |
-| `width` | `number` | 否 | 目标宽度。 |
-| `height` | `number` | 否 | 目标高度。 |
-
-### focusOn
-
-将视口中心定位到指定节点，或指定坐标点。
-
-**签名**
-
-```ts
-focusOn(focusOnArgs: { id?: string; coordinate?: { x: number; y: number } }): void
-```
-
-**参数**
-
-| 名称 | 类型 | 必传 | 说明 |
-| :--- | :--- | :--- | :--- |
-| `focusOnArgs` | `object` | 是 | `id` 与 `coordinate` 二选一。 |
-
-### zoom
-
-按步进或指定倍率缩放画布，并可指定缩放原点。
-
-**签名**
-
-```ts
-zoom(zoomSize?: boolean | number, point?: [number, number]): string
-```
-
-**返回值**
-
-- `string`：当前缩放比例百分比。
-
-### resetZoom
-
-将画布缩放比例重置为 `1`。
-
-**签名**
-
-```ts
-resetZoom(): void
-```
-
-### setZoomMiniSize
-
-设置画布允许的最小缩放倍数。
-
-**签名**
-
-```ts
-setZoomMiniSize(size: number): void
-```
-
-### setZoomMaxSize
-
-设置画布允许的最大缩放倍数。
-
-**签名**
-
-```ts
-setZoomMaxSize(size: number): void
-```
-
-### getTransform
-
-获取当前画布变换状态（缩放与平移）。
-
-**签名**
-
-```ts
-getTransform(): {
-  SCALE_X: number;
-  SCALE_Y: number;
-  TRANSLATE_X: number;
-  TRANSLATE_Y: number;
-}
-```
-
-### translate
-
-按相对偏移量平移画布。
-
-**签名**
-
-```ts
-translate(x: number, y: number): void
-```
-
-### resetTranslate
-
-将画布平移状态重置到初始位置。
-
-**签名**
-
-```ts
-resetTranslate(): void
-```
-
-### translateCenter
-
-将当前图内容居中显示在画布视口内。
-
-**签名**
-
-```ts
-translateCenter(): void
-```
-
-### fitView
-
-自动调整缩放与平移，使图内容尽可能完整显示在当前视口。
-
-**签名**
-
-```ts
-fitView(verticalOffset?: number, horizontalOffset?: number): void
-```
-
-### getPointByClient
-
-将页面坐标转换为画布坐标（同时返回 DOM 层与 SVG 层坐标）。
-
-**签名**
-
-```ts
-getPointByClient(x: number, y: number): {
-  domOverlayPosition: { x: number; y: number };
-  canvasOverlayPosition: { x: number; y: number };
-}
-```
-
-### toFront
-
-将指定节点或边置于更高层级。
-
-**签名**
-
-```ts
-toFront(id: string): void
-```
-
-### openEdgeAnimation
-
-开启指定边的动画效果。
-
-**签名**
-
-```ts
-openEdgeAnimation(edgeId: string): void
-```
-
-### closeEdgeAnimation
-
-关闭指定边的动画效果。
-
-**签名**
-
-```ts
-closeEdgeAnimation(edgeId: string): void
-```
-
-### 常见组合示例
-
-```ts
-// 先自适应，再居中，再按指定倍率缩放
-lf.resize();
-lf.translateCenter();
-lf.zoom(1.2);
-
-// 点坐标转换后定位到该处
-const point = lf.getPointByClient(300, 200);
-lf.focusOn({ coordinate: point.canvasOverlayPosition });
-```

package/dist/docs/api/logicflow-instance/edge.en.md

@@ -1,273 +0,0 @@
----
-nav: API
-group:
-  title: LogicFlow Instance
-  order: 2
-title: Edges
-toc: content
-order: 3
----
-
-This page documents instance helpers for creating, querying, updating, and deleting edges.
-
-### setDefaultEdgeType
-
-Sets the default edge type used when users draw new connections.
-
-**Signature**
-
-```ts
-setDefaultEdgeType(type: string): void
-```
-
-**Parameters**
-
-| Name | Type | Required | Description |
-| :--- | :--- | :--- | :--- |
-| `type` | `string` | Yes | Edge type such as `line`, `polyline`, or `bezier`. |
-
-**Example**
-
-```ts
-lf.setDefaultEdgeType('line');
-```
-
-### addEdge
-
-Creates an edge between two nodes.
-
-**Signature**
-
-```ts
-addEdge(edgeConfig: EdgeConfig): BaseEdgeModel
-```
-
-**Parameters**
-
-| Name | Type | Required | Description |
-| :--- | :--- | :--- | :--- |
-| `edgeConfig` | [`EdgeConfig`](../type/MainTypes.en.md#edgeconfig) | Yes | Edge configuration. |
-
-**Returns**
-
-| Type | Description |
-| :--- | :--- |
-| `BaseEdgeModel` | New edge model. |
-
-**Example**
-
-```ts
-lf.addEdge({
-  sourceNodeId: '10',
-  targetNodeId: '21',
-  text: 'Label',
-});
-```
-
-### getEdgeDataById
-
-Returns serialized edge data.
-
-**Signature**
-
-```ts
-getEdgeDataById(edgeId: string): EdgeConfig | undefined
-```
-
-**Parameters**
-
-| Name | Type | Required | Description |
-| :--- | :--- | :--- | :--- |
-| `edgeId` | `string` | Yes | Edge id. |
-
-**Returns**
-
-| Type | Description |
-| :--- | :--- |
-| [`EdgeConfig`](../type/MainTypes.en.md#edgeconfig) \| `undefined` | Data snapshot. |
-
-**Example**
-
-```ts
-lf.getEdgeDataById('edge_1');
-```
-
-### getEdgeModelById
-
-Returns the live edge model.
-
-**Signature**
-
-```ts
-getEdgeModelById(edgeId: string): BaseEdgeModel | undefined
-```
-
-**Parameters**
-
-| Name | Type | Required | Description |
-| :--- | :--- | :--- | :--- |
-| `edgeId` | `string` | Yes | Edge id. |
-
-**Returns**
-
-| Type | Description |
-| :--- | :--- |
-| `BaseEdgeModel \| undefined` | Model or `undefined`. |
-
-**Example**
-
-```ts
-lf.getEdgeModelById('edge_1');
-```
-
-### getEdgeModels
-
-Filters edge models by endpoints or other fields.
-
-**Signature**
-
-```ts
-getEdgeModels(edgeFilter: EdgeFilter): BaseEdgeModel[]
-```
-
-**Parameters**
-
-| Name | Type | Required | Description |
-| :--- | :--- | :--- | :--- |
-| `edgeFilter` | `EdgeFilter` | Yes | Filter object (commonly `sourceNodeId` / `targetNodeId`; see types). |
-
-**Returns**
-
-| Type | Description |
-| :--- | :--- |
-| `BaseEdgeModel[]` | Matching models. |
-
-**Example**
-
-```ts
-lf.getEdgeModels({
-  sourceNodeId: 'nodeA_id',
-  targetNodeId: 'nodeB_id',
-});
-```
-
-### changeEdgeId
-
-Renames an edge; generates an id when `newId` is omitted.
-
-**Signature**
-
-```ts
-changeEdgeId(oldId: string, newId?: string): void
-```
-
-**Parameters**
-
-| Name | Type | Required | Description |
-| :--- | :--- | :--- | :--- |
-| `oldId` | `string` | Yes | Current id. |
-| `newId` | `string` | No | New id. |
-
-**Example**
-
-```ts
-lf.changeEdgeId('oldId', 'newId');
-```
-
-### changeEdgeType
-
-Swaps the registered edge type.
-
-**Signature**
-
-```ts
-changeEdgeType(edgeId: string, type: string): void
-```
-
-**Parameters**
-
-| Name | Type | Required | Description |
-| :--- | :--- | :--- | :--- |
-| `edgeId` | `string` | Yes | Edge id. |
-| `type` | `string` | Yes | New type. |
-
-**Example**
-
-```ts
-lf.changeEdgeType('edgeId', 'bezier');
-```
-
-### deleteEdge
-
-Deletes an edge by id.
-
-**Signature**
-
-```ts
-deleteEdge(id: string): void
-```
-
-**Parameters**
-
-| Name | Type | Required | Description |
-| :--- | :--- | :--- | :--- |
-| `id` | `string` | Yes | Edge id. |
-
-**Example**
-
-```ts
-lf.deleteEdge('edge_1');
-```
-
-### deleteEdgeByNodeId
-
-Deletes edges matching endpoint filters.
-
-**Signature**
-
-```ts
-deleteEdgeByNodeId(config: EdgeFilter): void
-```
-
-**Parameters**
-
-| Name | Type | Required | Description |
-| :--- | :--- | :--- | :--- |
-| `config` | `EdgeFilter` | Yes | Endpoint filter (see [`EdgeConfig`](../type/MainTypes.en.md#edgeconfig) fields). |
-
-**Example**
-
-```ts
-lf.deleteEdgeByNodeId({
-  sourceNodeId: 'id1',
-  targetNodeId: 'id2',
-});
-```
-
-### getNodeEdges
-
-Lists all edge models attached to a node.
-
-**Signature**
-
-```ts
-getNodeEdges(id: string): BaseEdgeModel[]
-```
-
-**Parameters**
-
-| Name | Type | Required | Description |
-| :--- | :--- | :--- | :--- |
-| `id` | `string` | Yes | Node id. |
-
-**Returns**
-
-| Type | Description |
-| :--- | :--- |
-| `BaseEdgeModel[]` | Related edges. |
-
-**Example**
-
-```ts
-const edgeModels = lf.getNodeEdges('node_id');
-```

package/dist/docs/api/logicflow-instance/edge.zh.md

@@ -1,273 +0,0 @@
----
-nav: API
-group:
-  title: LogicFlow 实例
-  order: 2
-title: 边相关
-toc: content
-order: 3
----
-
-本页汇总 LogicFlow 实例中与边的创建、查询、修改和删除相关的方法。
-
-### setDefaultEdgeType
-
-设置默认边类型（用于用户手动连线时的新边类型）。
-
-**签名**
-
-```ts
-setDefaultEdgeType(type: string): void
-```
-
-**参数**
-
-| 名称 | 类型 | 必传 | 说明 |
-| :--- | :--- | :--- | :--- |
-| `type` | `string` | 是 | 默认边类型，例如 `line` / `polyline` / `bezier`。 |
-
-**示例**
-
-```ts
-lf.setDefaultEdgeType('line');
-```
-
-### addEdge
-
-创建连接两个节点的边。
-
-**签名**
-
-```ts
-addEdge(edgeConfig: EdgeConfig): BaseEdgeModel
-```
-
-**参数**
-
-| 名称 | 类型 | 必传 | 说明 |
-| :--- | :--- | :--- | :--- |
-| `edgeConfig` | [`EdgeConfig`](../type/MainTypes.zh.md#edgeconfig边配置) | 是 | 边配置。 |
-
-**返回值**
-
-| 类型 | 说明 |
-| :--- | :--- |
-| `BaseEdgeModel` | 新增边的 model 实例。 |
-
-**示例**
-
-```ts
-lf.addEdge({
-  sourceNodeId: '10',
-  targetNodeId: '21',
-  text: '边文案',
-});
-```
-
-### getEdgeDataById
-
-通过 ID 获取边的数据。
-
-**签名**
-
-```ts
-getEdgeDataById(edgeId: string): EdgeConfig | undefined
-```
-
-**参数**
-
-| 名称 | 类型 | 必传 | 说明 |
-| :--- | :--- | :--- | :--- |
-| `edgeId` | `string` | 是 | 边 ID。 |
-
-**返回值**
-
-| 类型 | 说明 |
-| :--- | :--- |
-| [`EdgeConfig`](../type/MainTypes.zh.md#edgeconfig边配置) \| `undefined` | 边数据；不存在时返回 `undefined`。 |
-
-**示例**
-
-```ts
-lf.getEdgeDataById('edge_1');
-```
-
-### getEdgeModelById
-
-通过 ID 获取边的 model。
-
-**签名**
-
-```ts
-getEdgeModelById(edgeId: string): BaseEdgeModel | undefined
-```
-
-**参数**
-
-| 名称 | 类型 | 必传 | 说明 |
-| :--- | :--- | :--- | :--- |
-| `edgeId` | `string` | 是 | 边 ID。 |
-
-**返回值**
-
-| 类型 | 说明 |
-| :--- | :--- |
-| `BaseEdgeModel \| undefined` | 边 model；不存在时返回 `undefined`。 |
-
-**示例**
-
-```ts
-lf.getEdgeModelById('edge_1');
-```
-
-### getEdgeModels
-
-按过滤条件获取边 model 列表。
-
-**签名**
-
-```ts
-getEdgeModels(edgeFilter: EdgeFilter): BaseEdgeModel[]
-```
-
-**参数**
-
-| 名称 | 类型 | 必传 | 说明 |
-| :--- | :--- | :--- | :--- |
-| `edgeFilter` | [`EdgeFilter`](../type/MainTypes.zh.md#edgeconfig边配置) | 是 | 边过滤条件。 |
-
-**返回值**
-
-| 类型 | 说明 |
-| :--- | :--- |
-| `BaseEdgeModel[]` | 满足条件的边 model 列表。 |
-
-**示例**
-
-```ts
-lf.getEdgeModels({
-  sourceNodeId: 'nodeA_id',
-  targetNodeId: 'nodeB_id',
-});
-```
-
-### changeEdgeId
-
-修改边 ID；若不传新 ID，会自动生成一个唯一 ID。
-
-**签名**
-
-```ts
-changeEdgeId(oldId: string, newId?: string): void
-```
-
-**参数**
-
-| 名称 | 类型 | 必传 | 说明 |
-| :--- | :--- | :--- | :--- |
-| `oldId` | `string` | 是 | 当前边 ID。 |
-| `newId` | `string` | 否 | 新边 ID。 |
-
-**示例**
-
-```ts
-lf.changeEdgeId('oldId', 'newId');
-```
-
-### changeEdgeType
-
-切换边类型。
-
-**签名**
-
-```ts
-changeEdgeType(edgeId: string, type: string): void
-```
-
-**参数**
-
-| 名称 | 类型 | 必传 | 说明 |
-| :--- | :--- | :--- | :--- |
-| `edgeId` | `string` | 是 | 边 ID。 |
-| `type` | `string` | 是 | 新边类型。 |
-
-**示例**
-
-```ts
-lf.changeEdgeType('edgeId', 'bezier');
-```
-
-### deleteEdge
-
-按边 ID 删除边。
-
-**签名**
-
-```ts
-deleteEdge(id: string): void
-```
-
-**参数**
-
-| 名称 | 类型 | 必传 | 说明 |
-| :--- | :--- | :--- | :--- |
-| `id` | `string` | 是 | 边 ID。 |
-
-**示例**
-
-```ts
-lf.deleteEdge('edge_1');
-```
-
-### deleteEdgeByNodeId
-
-按起点/终点节点过滤删除边。
-
-**签名**
-
-```ts
-deleteEdgeByNodeId(config: EdgeFilter): void
-```
-
-**参数**
-
-| 名称 | 类型 | 必传 | 说明 |
-| :--- | :--- | :--- | :--- |
-| `config` | [`EdgeFilter`](../type/MainTypes.zh.md#edgeconfig边配置) | 是 | 起点/终点过滤条件。 |
-
-**示例**
-
-```ts
-lf.deleteEdgeByNodeId({
-  sourceNodeId: 'id1',
-  targetNodeId: 'id2',
-});
-```
-
-### getNodeEdges
-
-获取节点关联的所有边 model。
-
-**签名**
-
-```ts
-getNodeEdges(id: string): BaseEdgeModel[]
-```
-
-**参数**
-
-| 名称 | 类型 | 必传 | 说明 |
-| :--- | :--- | :--- | :--- |
-| `id` | `string` | 是 | 节点 ID。 |
-
-**返回值**
-
-| 类型 | 说明 |
-| :--- | :--- |
-| `BaseEdgeModel[]` | 节点关联边的 model 列表。 |
-
-**示例**
-
-```ts
-const edgeModels = lf.getNodeEdges('node_id');
-```