Skip to content

Commit

Permalink
docs: update dagre docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
Yanyan-Wang committed Jun 3, 2020
1 parent 80fa552 commit 73b38e4
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/api/layout/Graph.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -507,7 +507,7 @@ d => {
};
```
<br />**是否必须**:false<br />**说明**:节点间距(px)的回调函数,通过该参数可以对不同节点设置不同的节点间距。在`rankdir` 为 'TB' 或 'BT' 时是节点的水平间距;在`rankdir` 为 'LR' 或 'RL' 时代表节点的竖直方向间距。优先级低于 `nodesep`,即若设置了 `nodesep`,则 `nodesepFunc` 不生效
<br />**是否必须**:false<br />**说明**:节点间距(px)的回调函数,通过该参数可以对不同节点设置不同的节点间距。在`rankdir` 为 'TB' 或 'BT' 时是节点的水平间距;在`rankdir` 为 'LR' 或 'RL' 时代表节点的竖直方向间距。优先级高于 `nodesep`,即若设置了 `nodesep`,则 `nodesepFunc` 不生效
#### ranksepFunc
Expand All @@ -521,7 +521,7 @@ d => {
};
```
<br />**是否必须**:false<br />**说明**:层间距(px)的回调函数,通过该参数可以对不同节点设置不同的层间距。在`rankdir` 为 'TB' 或 'BT' 时是竖直方向相邻层间距;在`rankdir` 为 'LR' 或 'RL' 时代表水平方向相邻层间距。优先级低于 `ranksep`,即若设置了 `ranksep`,则 `ranksepFunc` 不生效
<br />**是否必须**:false<br />**说明**:层间距(px)的回调函数,通过该参数可以对不同节点设置不同的层间距。在`rankdir` 为 'TB' 或 'BT' 时是竖直方向相邻层间距;在`rankdir` 为 'LR' 或 'RL' 时代表水平方向相邻层间距。优先级高于 `ranksep`,即若设置了 `ranksep`,则 `ranksepFunc` 不生效
#### controlPoints
Expand Down
2 changes: 1 addition & 1 deletion docs/manual/middle/layout.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ const graph = new G6.Graph({
| align | String | 'UL' / 'UR' / 'DL' / 'DR' | 'UL' | 节点对齐方式。U:upper;D:down;L:left;R:right |
| nodesep | Number | 40 | 50 |`rankdir``'TB'``'BT'` 时代表节点水平间距(px);在 `rankdir``'LR'``'RL'` 时代表节点的竖直间距。优先级高于 `nodesepFunc` |
| ranksep | Number | 40 | 50 | 层间距(px)。在`rankdir``'TB'``'BT'` 时是竖直方向相邻层间距;在`rankdir``'LR'``'RL'` 时代表水平方向相邻层间距。优先级高于 `ranksepFunc` |
| nodesepFunc<br /><br /> | Function | d => {<br />  // d 是一个节点<br />  if (d.id === 'node1') {<br />    return 100;<br />  }<br />  return 10;<br />} | undefined | 节点水平间距(px)的回调函数,通过该参数可以对不同节点设置不同的节点间距。在`rankdir` 为 'TB' 或 'BT' 时是节点的水平间距;在`rankdir` 为 'LR' 或 'RL' 时是节点的竖直间距。优先级低于 `nodesep`,即若设置了 `nodesep`,则 `nodesepFunc` 不生效 |
| nodesepFunc<br /><br /> | Function | d => {<br />  // d 是一个节点<br />  if (d.id === 'node1') {<br />    return 100;<br />  }<br />  return 10;<br />} | undefined | 节点水平间距(px)的回调函数,通过该参数可以对不同节点设置不同的节点间距。在`rankdir` 为 'TB' 或 'BT' 时是节点的水平间距;在`rankdir` 为 'LR' 或 'RL' 时是节点的竖直间距。优先级高于 `nodesep`,即若设置了 `nodesep`,则 `nodesepFunc` 不生效 |
| ranksepFunc<br /><br /> | Function | d => {<br />  // d 是一个节点<br />  if (d.id === 'node1') {<br />    return 100;<br />  }<br />  return 10;<br />} | undefined | 层间距(px)的回调函数,通过该参数可以对不同节点设置不同的层间距。在`rankdir` 为 'TB' 或 'BT' 时是竖直方向相邻层间距;在`rankdir` 为 'LR' 或 'RL' 时代表水平方向相邻层间距。优先级低于 `ranksep`,即若设置了 `ranksep`,则 `ranksepFunc` 不生效 |
| controlPoints | Boolean | true | true | 是否保留布局连线的控制点 |
| workerEnabled | Boolean | true / false | false | 是否启用 web-worker 以防布局计算时间过长阻塞页面交互 |
Expand Down
2 changes: 1 addition & 1 deletion examples/net/dagreFlow/API.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ d => {
};
```

<br />**是否必须**:false<br />**说明**:节点间距(px)的回调函数,通过该参数可以对不同节点设置不同的节点间距。在`rankdir` 为 'TB' 或 'BT' 时是节点的水平间距;在`rankdir` 为 'LR' 或 'RL' 时代表节点的竖直方向间距。优先级低于 `nodesep`,即若设置了 `nodesep`,则 `nodesepFunc` 不生效
<br />**是否必须**:false<br />**说明**:节点间距(px)的回调函数,通过该参数可以对不同节点设置不同的节点间距。在`rankdir` 为 'TB' 或 'BT' 时是节点的水平间距;在`rankdir` 为 'LR' 或 'RL' 时代表节点的竖直方向间距。优先级高于 `nodesep`,即若设置了 `nodesep`,则 `nodesepFunc` 不生效

## ranksepFunc

Expand Down

0 comments on commit 73b38e4

Please sign in to comment.