Skip to content

Commit 08522f8

Browse files
Whf0403whf01206399
andauthored
docs: improve documentation for element/edge configuration (#6861)
* docs: improve documentation/element/edge configuration * docs: improve the edge of defaultValue --------- Co-authored-by: whf01206399 <[email protected]>
1 parent 50688e0 commit 08522f8

File tree

17 files changed

+1303
-434
lines changed

17 files changed

+1303
-434
lines changed

packages/site/docs/manual/element/edge/build-in/BaseEdge.zh.md

Lines changed: 685 additions & 108 deletions
Large diffs are not rendered by default.

packages/site/docs/manual/element/edge/build-in/Cubic.zh.md

Lines changed: 25 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,38 @@
22
title: Cubic 三次贝塞尔曲线
33
---
44

5-
<embed src="@/common/api/elements/edges/cubic.md"></embed>
5+
## 概述
66

7-
> 如果元素有其特定的属性,我们将在下面列出。对于所有的通用样式属性,见[BaseEdge](./BaseEdge.zh.md)
7+
三次贝塞尔曲线是一种通用的平滑曲线,其控制点可以自由分布,适合连接任意方向的节点。
8+
9+
使用场景:
10+
11+
- 适用于任意布局的图,如网络图、关系图。
812

9-
## style.controlPoints
13+
- 当需要平滑连接节点且无特定方向要求时使用。
1014

11-
> _[**[number, number] \| [number, number, number] \| Float32Array**,_ _[number, number] \| [number, number, number] \| Float32Array\_\_]_
15+
## 在线体验
1216

13-
控制点数组,用于定义曲线的形状。如果不指定,将会通过 `curveOffset``curvePosition` 来计算控制点
17+
<embed src="@/common/api/elements/edges/cubic.md"></embed>
18+
19+
## 样式配置
20+
21+
> 如果元素有其特定的属性,我们将在下面列出。对于所有的通用样式属性,见[BaseEdge](./BaseEdge.zh.md)
1422
15-
## style.curveOffset
23+
| 属性 | 描述 | 类型 | 默认值 | 必选 |
24+
| ------------- | -------------------------------------------------------------------------------------------------- | ---------------------------------- | ------ | ---- |
25+
| controlPoints | 控制点数组,用于定义曲线的形状。如果不指定,将会通过 `curveOffset``curvePosition` 来计算控制点 | [[Point](#point), [Point](#point)] | - | |
26+
| curvePosition | 控制点在两端点连线上的相对位置,范围为`0-1` | number &#124; number[] | 0.5 | |
27+
| curveOffset | 控制点距离两端点连线的距离,可理解为控制边的弯曲程度 | number &#124; number[] | 20 | |
1628

17-
> _number \| [number, number]_ **Default:** `20`
29+
#### Point
1830

19-
控制点距离两端点连线的距离,可理解为控制边的弯曲程度
31+
```typescript
32+
type Point = [number, number] | [number, number, number] | Float32Array;
33+
```
2034

21-
## style.curvePosition
35+
## 示例
2236

23-
> _number \| [number, number]_ **Default:** `0.5`
37+
### 内置三次贝塞尔曲线边效果
2438

25-
控制点在两端点连线上的相对位置,范围为`0-1`
39+
<Playground path="element/edge/demo/cubic.js" rid="default-cubic-edge" height='520px'></Playground>

packages/site/docs/manual/element/edge/build-in/CubicHorizontal.zh.md

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,33 @@
22
title: CubicHorizontal 水平三次贝塞尔曲线
33
---
44

5+
## 概述
6+
7+
水平三次贝塞尔曲线是一种平滑的曲线,其控制点主要沿水平方向分布,适合在水平方向上连接节点。
8+
9+
使用场景:
10+
11+
- 适用于水平布局的图,如流程图、层次结构图。
12+
13+
- 当需要强调水平方向的连接关系时使用。
14+
515
> 特别注意,计算控制点时主要考虑 x 轴上的距离,忽略 y 轴的变化
616
7-
<embed src="@/common/api/elements/edges/cubic-horizontal.md"></embed>
17+
## 在线体验
818

9-
> 如果元素有其特定的属性,我们将在下面列出。对于所有的通用样式属性,见[BaseEdge](./BaseEdge.zh.md)
19+
<embed src="@/common/api/elements/edges/cubic-horizontal.md"></embed>
1020

11-
## style.curveOffset
21+
## 样式配置
1222

13-
> _number \| [number, number]_ **Default:** `[0, 0]`
23+
> 如果元素有其特定的属性,我们将在下面列出。对于所有的通用样式属性,见[BaseEdge](./BaseEdge.zh.md)
1424
15-
控制点距离两端点连线的距离,可理解为控制边的弯曲程度
25+
| 属性 | 描述 | 类型 | 默认值 | 必选 |
26+
| ------------- | ---------------------------------------------------- | ---------------------- | --------- | ---- |
27+
| curvePosition | 控制点在两端点连线上的相对位置,范围为`0-1` | number &#124; number[] | [0.5,0.5] | |
28+
| curveOffset | 控制点距离两端点连线的距离,可理解为控制边的弯曲程度 | number &#124; number[] | [0,0] | |
1629

17-
## style.curvePosition
30+
## 示例
1831

19-
> _number \| [number, number]_ **Default:** `[0.5, 0.5]`
32+
### 内置水平三次贝塞尔曲线边效果
2033

21-
控制点在两端点连线上的相对位置,范围为`0-1`
34+
<Playground path="element/edge/demo/horizontal-cubic.js" rid="default-cubic-horizontal-edge" height='520px'></Playground>

packages/site/docs/manual/element/edge/build-in/CubicRadial.zh.md

Lines changed: 0 additions & 23 deletions
This file was deleted.

packages/site/docs/manual/element/edge/build-in/CubicVertical.en.md

Lines changed: 0 additions & 23 deletions
This file was deleted.

packages/site/docs/manual/element/edge/build-in/CubicVertical.zh.md

Lines changed: 22 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,33 @@
22
title: CubicVertical 垂直三次贝塞尔曲线
33
---
44

5-
特别注意,计算控制点时主要考虑 y 轴上的距离,忽略 x 轴的变化
5+
## 概述
66

7-
<embed src="@/common/api/elements/edges/cubic-vertical.md"></embed>
7+
垂直三次贝塞尔曲线是一种平滑的曲线,其控制点主要沿垂直方向分布,适合在垂直方向上连接节点。
88

9-
> 如果元素有其特定的属性,我们将在下面列出。对于所有的通用样式属性,见[BaseEdge](./BaseEdge.zh.md)
9+
使用场景:
10+
11+
- 适用于垂直布局的图,如组织结构图、树状图。
12+
13+
- 当需要强调垂直方向的连接关系时使用。
14+
15+
**特别注意,计算控制点时主要考虑 y 轴上的距离,忽略 x 轴的变化**
1016

11-
## style.curveOffset
17+
## 在线体验
1218

13-
> _number \| [number, number]_ **Default:** `[0, 0]`
19+
<embed src="@/common/api/elements/edges/cubic-vertical.md"></embed>
20+
21+
## 样式配置
22+
23+
> 如果元素有其特定的属性,我们将在下面列出。对于所有的通用样式属性,见[BaseEdge](./BaseEdge.zh.md)
1424
15-
控制点距离两端点连线的距离,可理解为控制边的弯曲程度
25+
| 属性 | 描述 | 类型 | 默认值 | 必选 |
26+
| ------------- | ---------------------------------------------------- | ---------------------- | --------- | ---- |
27+
| curvePosition | 控制点在两端点连线上的相对位置,范围为`0-1` | number &#124; number[] | [0.5,0.5] | |
28+
| curveOffset | 控制点距离两端点连线的距离,可理解为控制边的弯曲程度 | number &#124; number[] | [0,0] | |
1629

17-
## style.curvePosition
30+
## 示例
1831

19-
> _number \| [number, number]_ **Default:** `[0.5, 0.5]`
32+
### 内置垂直三次贝塞尔曲线边效果
2033

21-
控制点在两端点连线上的相对位置,范围为`0-1`
34+
<Playground path="element/edge/demo/vertical-cubic.js" rid="default-vertical-cubic-edge" height='520px'></Playground>

packages/site/docs/manual/element/edge/build-in/Line.zh.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,26 @@
22
title: Line 直线
33
---
44

5+
## 概述
6+
7+
直线是最简单的边类型,直接连接两个节点,没有任何弯曲。
8+
9+
使用场景:
10+
11+
- 适用于简单的图,如拓扑图、流程图。
12+
13+
- 当需要快速绘制且无需复杂视觉效果时使用。
14+
15+
## 在线体验
16+
517
<embed src="@/common/api/elements/edges/line.md"></embed>
618

19+
## 样式配置
20+
721
> 如果元素有其特定的属性,我们将在下面列出。对于所有的通用样式属性,见[BaseEdge](./BaseEdge.zh.md)
22+
23+
## 示例
24+
25+
### 内置直线边效果
26+
27+
<Playground path="element/edge/demo/line.js" rid="default-line-edge" height='520px'></Playground>

packages/site/docs/manual/element/edge/build-in/Polyline.zh.md

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,29 @@
22
title: Polyline 折线
33
---
44

5-
<embed src="@/common/api/elements/edges/polyline.md"></embed>
6-
7-
> 如果元素有其特定的属性,我们将在下面列出。对于所有的通用样式属性,见[BaseEdge](./BaseEdge.zh.md)
5+
## 概述
86

9-
## style.controlPoints
7+
折线是由多条直线段组成的边,适合在复杂布局中绕过障碍物连接节点。
108

11-
> _[number, number] \| [number, number, number] \| Float32Array\_\_[]_
9+
使用场景:
1210

13-
控制点数组
11+
- 适用于复杂布局的图,如电路图、管道图。
1412

15-
## style.radius
13+
- 当需要绕过其他节点或障碍物时使用。
1614

17-
> _number_ **Default:** `0`
15+
## 在线体验
1816

19-
圆角半径
17+
<embed src="@/common/api/elements/edges/polyline.md"></embed>
2018

21-
## style.router
19+
## 样式配置
2220

23-
> _false \| [OrthRouter](#orthrouter) \| [ShortestPathRouter](#shortestpathrouter)_ **Default:** `false`
21+
> 如果元素有其特定的属性,我们将在下面列出。对于所有的通用样式属性,见[BaseEdge](./BaseEdge.zh.md)
2422
25-
是否启用路由,默认开启且 controlPoints 会自动计入
23+
| 属性 | 描述 | 类型 | 默认值 | 必选 |
24+
| ------------- | -------------------------------- | --------------------------------------------------------------------------------------- | ------ | ---- |
25+
| controlPoints | 控制点数组,用于定义折线的转折点 | [Point](#point)[] | [] | |
26+
| radius | 转折点圆角半径 | number | 0 | |
27+
| router | 是否启用路由 | false &#124; [OrthRouter](#orthrouter) &#124; [ShortestPathRouter](#shortestpathrouter) | false | |
2628

2729
### OrthRouter
2830

@@ -64,3 +66,9 @@ type Point = [number, number] | [number, number, number] | Float32Array;
6466
```typescript
6567
type Padding = number | [number, number] | [number, number, number, number];
6668
```
69+
70+
## 示例
71+
72+
### 内置折线边效果
73+
74+
<Playground path="element/edge/demo/polyline.js" rid="default-polyline-edge" height='520px'></Playground>

packages/site/docs/manual/element/edge/build-in/Quadratic.zh.md

Lines changed: 25 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,38 @@
22
title: Quadratic 二次贝塞尔曲线
33
---
44

5-
<embed src="@/common/api/elements/edges/quadratic.md"></embed>
5+
## 概述
66

7-
> 如果元素有其特定的属性,我们将在下面列出。对于所有的通用样式属性,见[BaseEdge](./BaseEdge.zh.md)
7+
二次贝塞尔曲线是一种平滑的曲线,其形状由起点、终点和一个控制点决定。
8+
9+
使用场景:
10+
11+
- 适用于中等复杂度的图,如关系图、网络图。
812

9-
## style.controlPoint
13+
- 当需要平滑连接节点且计算资源有限时使用。
1014

11-
> _[number, number] \| [number, number, number] \| Float32Array_
15+
## 在线体验
1216

13-
控制点,用于定义曲线的形状。如果不指定,将会通过`curveOffset``curvePosition`来计算控制点
17+
<embed src="@/common/api/elements/edges/quadratic.md"></embed>
18+
19+
## 样式配置
20+
21+
> 如果元素有其特定的属性,我们将在下面列出。对于所有的通用样式属性,见[BaseEdge](./BaseEdge.zh.md)
1422
15-
## style.curveOffset
23+
| 属性 | 描述 | 类型 | 默认值 | 必选 |
24+
| ------------- | -------------------------------------------------------------------------------------------------- | --------------- | ------ | ---- |
25+
| controlPoints | 控制点数组,用于定义曲线的形状。如果不指定,将会通过 `curveOffset``curvePosition` 来计算控制点 | [Point](#point) | - | |
26+
| curvePosition | 控制点在两端点连线上的相对位置,范围为`0-1` | number | 0.5 | |
27+
| curveOffset | 控制点距离两端点连线的距离,可理解为控制边的弯曲程度 | number | 30 | |
1628

17-
> _number_ **Default:** `30`
29+
#### Point
1830

19-
控制点距离两端点连线的距离,可理解为控制边的弯曲程度
31+
```typescript
32+
type Point = [number, number] | [number, number, number] | Float32Array;
33+
```
2034

21-
## style.curvePosition
35+
## 示例
2236

23-
> _number_ **Default:** `0.5`
37+
### 内置二次贝塞尔曲线边效果
2438

25-
控制点在两端点连线上的相对位置,范围为`0-1`
39+
<Playground path="element/edge/demo/quadratic.js" rid="default-quadratic-edge" height='520px'></Playground>

0 commit comments

Comments
 (0)