@logicflow/layout 1.2.0-alpha.16 → 2.0.0

package/LICENSE

@@ -0,0 +1,206 @@
+                              Apache License
+
+                        Version 2.0, January 2004
+
+                     http://www.apache.org/licenses/
+
+
+
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "{}"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright (C) 2017 Beijing Didi Infinity Technology and Development Co.,Ltd. All rights reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -2,16 +2,79 @@
 
 layout 扩展包
 
+## 安装
+```shell
+npm install @logicflow/layout
+```
+or
+```shell
+yarn add @logicflow/layout
+```
+or
+```shell
+pnpm add @logicflow/layout
+```
+
 ## 使用方式
 
 ```js
 import LogicFlow from '@logicflow/core';
-import { dagre } from '@logicflow/layout';
+import { Dagre } from '@logicflow/layout';
 
 const lf = new LogicFlow({
   container: '#app',
-  plugin: [dagre]
+  plugins: [Dagre]
 })
 
+// 基本使用方式 - 无参数
 lf.extension.dagre.layout()
+
+// 使用布局参数
+lf.extension.dagre.layout({
+  rankdir: 'LR', // 从坐到右布局
+  ranksep: 100    // 层级间距
+  nodesep: 50,   // 节点间距
+})
+```
+
+## DagreOption 参数说明
+
+| 参数名 | 类型 | 默认值 | 说明 |
+|-------|-----|-------|------|
+| rankdir | string | 'LR' | 布局方向，'LR'(左到右), 'TB'(上到下), 'BT'(下到上), 'RL'(右到左) |
+| align | string | 'UL' | 节点对齐方式，'UL'(上左), 'UR'(上右), 'DL'(下左), 'DR'(下右) |
+| nodesep | number | 100 | 节点间的水平间距(像素) |
+| ranksep | number | 150 | 层级间的垂直间距(像素) |
+| marginx | number | 120 | 图的水平边距(像素) |
+| marginy | number | 120 | 图的垂直边距(像素) |
+| ranker | string | 'tight-tree' | 排名算法，'network-simplex', 'tight-tree', 'longest-path' |
+| edgesep | number | 10 | 边之间的水平间距(像素) |
+| acyclicer | string | undefined | 如果设置为'greedy'，使用贪心算法查找反馈弧集，用于使图变为无环图 |
+| isDefaultAnchor | boolean | false | 是否是系统默认锚点（默认上下左右4个锚点），当为true时会自动调整连线的路径 |
+
+## 布局方向示例
+
+### 从左到右 (LR)
+
+```js
+lf.extension.dagre.layout({
+  rankdir: 'LR'  // 默认值
+})
+```
+
+### 从上到下 (TB)
+
+```js
+lf.extension.dagre.layout({
+  rankdir: 'TB'
+})
+```
+
+### 默认锚点的话（默认上下左右4个锚点）， 会自动调整连线的路径以及起终点位置
+
+```js
+lf.extension.dagre.layout({
+  rankdir: 'TB',
+  isDefaultAnchor: true  // 调整连线锚点
+})
 ```

package/dist/index.min.js

@@ -0,0 +1,2 @@
+!function(e){"function"==typeof define&&define.amd?define(e):e()}((function(){"use strict";Object.defineProperty(exports,"__esModule",{value:!0});require("tslib").__exportStar(require("./dagre"),exports)}));
+//# sourceMappingURL=index.min.js.map

package/dist/index.min.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.min.js","sources":["../src/index.ts"],"sourcesContent":["export * from './dagre'\n"],"names":["__exportStar","require","exports"],"mappings":"mKAAuBA,aAAAC,QAAA,WAAAC"}

package/es/dagre.d.ts

@@ -1,25 +1,73 @@
-import { DagreLayoutOptions } from '@antv/layout';
+/**
+ * @fileoverview Dagre布局插件 - 提供自动化图形布局功能
+ *
+ * 本插件基于dagre.js实现LogicFlow的自动化布局功能，支持多种布局方向
+ * 可自动计算节点位置和连线路径，实现整洁的图形展示
+ */
+import LogicFlow, { BaseEdgeModel } from '@logicflow/core';
+import { GraphLabel } from 'dagre';
+import NodeConfig = LogicFlow.NodeConfig;
+import Point = LogicFlow.Point;
+/**
+ * Dagre布局配置选项接口
+ * @interface DagreOption
+ * @extends GraphLabel - 继承dagre原生配置
+ */
+export interface DagreOption extends GraphLabel {
+    /**
+     * 是否是默认锚点
+     * true: 会根据布局方向自动计算边的路径点
+     */
+    isDefaultAnchor?: boolean;
+}
+/**
+ * Dagre插件接口定义
+ */
+export interface DagrePlugin {
+    /**
+     * 执行布局计算
+     * @param option - 布局配置选项
+     */
+    layout(option: DagreOption): void;
+}
+/**
+ * Dagre布局类 - LogicFlow自动布局插件
+ * 基于dagre.js提供图的自动布局能力
+ */
 export declare class Dagre {
+    /** 插件名称，用于在LogicFlow中注册 */
     static pluginName: string;
-    lf: any;
-    option: DagreLayoutOptions;
-    render(lf: any): void;
+    /** LogicFlow实例引用 */
+    lf: LogicFlow;
+    /** 当前布局配置 */
+    option: DagreOption;
+    /**
+     * 插件初始化方法，由LogicFlow自动调用
+     * @param lf - LogicFlow实例
+     */
+    render(lf: LogicFlow): void;
+    /**
+     * 执行布局算法，重新排列图中的节点和边
+     * @param option - 布局配置选项
+     */
+    layout(option?: DagreOption): void;
+    /**
+     * 计算字符串显示宽度（用于文本定位）
+     * @param word - 要计算的文本
+     * @returns 估算的文本像素宽度
+     */
     getBytesLength(word: string): number;
     /**
-     * option: {
-     *   rankdir: "TB", // layout 方向, 可选 TB, BT, LR, RL
-     *   align: undefined, // 节点对齐方式，可选 UL, UR, DL, DR
-     *   nodeSize: undefined, // 节点大小
-     *   nodesepFunc: undefined, // 节点水平间距(px)
-     *   ranksepFunc: undefined, // 每一层节点之间间距
-     *   nodesep: 40, // 节点水平间距(px) 注意：如果有grid，需要保证nodesep为grid的偶数倍
-     *   ranksep: 40, // 每一层节点之间间距 注意：如果有grid，需要保证ranksep为grid的偶数倍
-     *   controlPoints: false, // 是否保留布局连线的控制点
-     *   radial: false, // 是否基于 dagre 进行辐射布局
-     *   focusNode: null, // radial 为 true 时生效，关注的节点
-     * };
+     * 优化折线路径点，移除冗余点
+     * @param points - 原始路径点数组
+     * @returns 优化后的路径点数组
+     */
+    pointFilter(points: Point[]): Point[];
+    /**
+     * 计算边的折线路径点
+     * @param model - 边模型
+     * @param nodes - 节点数据数组
+     * @returns 计算后的路径点数组，如果无法计算则返回undefined
      */
-    layout(option?: {}): void;
-    pointFilter(points: any): any;
-    calcPointsList(model: any, nodes: any): any;
+    calcPointsList(model: BaseEdgeModel, nodes: NodeConfig[]): Point[] | undefined;
 }