Skip to content

Commit 191d9e2

Browse files
committed
refactor: 💡 update the doc of custom edge
1 parent 588f5b7 commit 191d9e2

File tree

2 files changed

+20
-2
lines changed

2 files changed

+20
-2
lines changed

docs/api/customEdgeApi.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,3 +34,15 @@ getArrowStyle() {
3434
return style;
3535
}
3636
```
37+
38+
## setAttributes
39+
40+
设置连线`model`中的属性。
41+
42+
使用示例:
43+
44+
```ts
45+
setAttributes() {
46+
this.stroke = '#999999';
47+
}
48+
```

docs/guide/advance/customEdge.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,11 +76,17 @@ lf.register('process', (RegisterParam) => {
7676

7777
## 自定义连线的 Model
7878

79-
连线在`model`中维护了以下内容。
79+
连线的`model`中维护了以下内容。
8080

81-
- 连线的[数据属性](/api/edgeApi.html#数据属性)[样式属性](/api/edgeApi.html#样式属性)
81+
- 连线的[通用属性](/api/edgeApi.html#通用属性)
8282
- 连线的[边属性](/api/edgeApi.html#边属性)
8383

84+
为了保证连线的每一类属性都可以被正常设置,LF 在`model`的构造函数中按下图顺序对属性进行初始化。
85+
86+
<img src="../../assets/images/custom-edge-model.png" alt="连线属性初始化顺序" style="display: block; margin: 0 auto; zoom: 50%;" />
87+
88+
与节点一致,当我们需要为连线的自定义各类属性时,也应通过`setAttributes`方法来进行设置,其使用方式参考自定义节点`model`[章节](/guide/advance/customNode.html#自定义节点的-model)
89+
8490
## extendKey
8591

8692
当我们注册的自定义连线希望可以被其他自定义连线继承时,就需要为`view``model`都设置一个静态属性`extendKey`,以便在`lf.register`的第二个回调函数的参数中被访问到。

0 commit comments

Comments
 (0)