g6/examples/net/dagreFlow/API.zh.md
2020-02-14 11:30:12 +08:00

2.7 KiB
Raw Blame History

title
API

rankdir

类型 String
可选值'TB' | 'BT' | 'LR' | 'RL'
默认值'TB'
是否必须false
说明布局的方向。TtopBbottomLleftRright

  • 'TB':从上至下布局;
  • 'BT':从下至上布局;
  • 'LR':从左至右布局;
  • 'RL':从右至左布局。

align

类型 String
可选值'UL' | 'UR' | 'DL' | 'DR'
默认值'UL'
是否必须false
说明节点对齐方式。UupperDdownLleftRright

  • 'UL':对齐到左上角;
  • 'UR':对齐到右上角;
  • 'DL':对齐到左下角;
  • 'DR':对齐到右下角。

nodesep

类型 Number
默认值50
是否必须false
说明节点间距px。在rankdir'TB''BT' 时是节点的水平间距;在rankdir'LR''RL' 时代表节点的竖直方向间距

ranksep

类型 Number
默认值50
是否必须false
说明层间距px。在rankdir'TB''BT' 时是竖直方向相邻层间距;在rankdir'LR''RL' 时代表水平方向相邻层间距

nodesepFunc

类型 Function
默认值undefined
示例

d => {
  // d 是一个节点
  if (d.id === 'testId') return 100;
  return 10;
};


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

ranksepFunc

类型 Function
默认值undefined
示例

d => {
  // d 是一个节点
  if (d.id === 'testId') return 100;
  return 10;
};


是否必须false
说明层间距px的回调函数通过该参数可以对不同节点设置不同的层间距。在rankdir 为 'TB' 或 'BT' 时是竖直方向相邻层间距;在rankdir 为 'LR' 或 'RL' 时代表水平方向相邻层间距。优先级低于 ranksep,即若设置了 ranksep,则 ranksepFunc 不生效

controlPoints

类型 Boolean
默认值true
是否必须false
说明:是否保留布局连线的控制点

workerEnabled

类型: Boolean
默认值: false
是否必须: false
说明: 是否启用 web-worker 以防布局计算时间过长阻塞页面交互