X6 默认提供了以下几种路由:
路由名称 | 说明 |
---|---|
normal | 默认路由,原样返回路径点 |
orth | 正交路由,由水平或垂直的正交线段组成 |
oneSide | 受限正交路由,由受限的三段水平或垂直的正交线段组成 |
manhattan | 智能正交路由,由水平或垂直的正交线段组成,并自动避开路径上的其他节点(障碍) |
metro | 智能地铁线路由,由水平或垂直的正交线段和斜角线段组成,类似地铁轨道图,并自动避开路径上的其他节点(障碍) |
er | 实体关系路由,由 Z 字形的斜角线段组成 |
- normal
系统的默认路由,该路由原样返回传入的 vertices
路径点。
- orth
正交路由,该路由在路径上添加额外的一些点,使边的每一条线段都水平或垂直正交。
支持的参数如下表:
参数名 | 参数类型 | 是否必选 | 默认值 | 参数说明 |
---|---|---|---|---|
padding | SideOptions | 否 | 20 | 设置锚点距离转角的最小距离 |
SideOptions
定义如下:
export type SideOptions =
| number
| {
vertical?: number
horizontal?: number
left?: number
top?: number
right?: number
bottom?: number
}
例如:
graph.addEdge({
source,
target,
vertices: [
{ x: 100, y: 200 },
{ x: 300, y: 120 },
],
router: {
name: 'orth',
args: {
padding: {
left: 50,
},
},
},
})
以下是效果图
- oneSide
oneSide
路由是正交路由 orth
的受限版本,该路生成一个严格的三段路由:从起始节点的 side
侧开始,经过中间段,再从终止节点的 side
侧结束路由。需要特别注意的是,使用该路由时请不要同时指定 vertices
,否则路由效果会非常差
支持的参数如下表:
参数名 | 参数类型 | 是否必选 | 默认值 | 参数说明 |
---|---|---|---|---|
side | 'left' | 'right' | 'top' | 'bottom' | 否 | 'bottom' | 路由的起始/结束方向,默认值为 'bottom' |
padding | SideOptions | 否 | 20 | 设置锚点距离转角的最小距离 |
例如:
graph.addEdge({
source,
target,
router: {
name: 'oneSide',
args: { side: 'right' },
},
})
以下是效果图
- manhattan
曼哈顿路由manhattan
路由是正交路由orth
的智能版本,该路由由水平或垂直的正交线段组成,并自动避开路径上的其他节点(障碍)。
支持的参数如下表:
参数名 | 参数类型 | 是否必选 | 默认值 | 参数说明 |
---|---|---|---|---|
step | number | 否 | 10 | 路由算法步进步长,其值越小计算量越大,推荐使用画布的网格大小 |
excludeTerminals | (‘source’ | ‘target’)[] | 否 | [] | 忽略起始或终止节点,忽略后不参与障碍物计算 |
excludeShapes | string[] | 否 | [] | 忽略指定形状的节点,忽略后不参与障碍物计算 |
excludeNodes | (Node | string)[] | 否 | [] | 忽略的节点,忽略后不参与障碍物计算忽略的节点,忽略后不参与障碍物计算 |
startDirections | string[] | 否 | [‘top’, ‘right’, ‘bottom’, ‘left’] | 支持从哪些方向开始路由 |
endDirections | string[] | 否 | [‘top’, ‘right’, ‘bottom’, ‘left’] | 支持从哪些方向结束路由 |
padding | SideOptions | 否 | - | 设置锚点距离转角的最小距离 |
例如:
graph.addEdge({
source,
target,
router: {
name: 'manhattan',
args: {
startDirections: ['top'],
endDirections: ['bottom'],
},
},
})
注意:
manhattan 路由的特性是自动避开路径中的障碍物,如果出现无法避开的情况,就会自动降级到 orth 路由,并在控制台增加了 warn:Unable to execute manhattan algorithm, use orth instead。
以下是效果图
- metro
地铁路由 metro
是曼哈顿路由 manhattan
的一个变种,它由水平或垂直的正交线段和斜角线段组成,类似地铁轨道图,并自动避开路径上的其他节点(障碍)。其选项与 manhattan
一样,但 maxDirectionChange
的默认值为 45,表示路由线段的最大倾斜角度为 45 度。
例如:
graph.addEdge({
source,
target,
router: {
name: 'metro',
args: {
startDirections: ['top'],
endDirections: ['bottom'],
},
},
})
以下是效果图
- er
实体关系路由 er
由 Z 字形的斜角线段组成,常用于表示 ER 图中的实体之间的连线。
支持的参数如下表:
参数名 | 参数类型 | 是否必选 | 默认值 | 参数说明 |
---|---|---|---|---|
offset | number |‘center’ | 否 | 32 | 路由的第一个点和最后一个点与节点之间的距离。当取值为 'center' 时,节点距离的中心作为路由点坐标 |
min | number | 否 | 16 | 路由的第一个点和最后一个点与节点之间的最小距离 |
direction | ‘T’|‘B’|‘L’|‘R’|‘H’|‘V’ | 否 | - | 路由方向,缺省时将自动选择最优方向 |
例如:
graph.addEdge({
source,
target,
router: {
name: 'er',
args: {
offset: 24,
},
},
})
以下是效果图
- 自定义路由
除了内置路由,还可以按照一定规则来创建自定义路由,例如,实现随机的路由:
// 路由参数
interface RandomRouterArgs {
bounces?: number
}
function randomRouter(
vertices: Point.PointLike[],
args: RandomRouterArgs,
view: EdgeView,
) {
const bounces = args.bounces || 20
const points = vertices.map((p) => Point.create(p))
for (var i = 0; i < bounces; i++) {
const sourceCorner = view.sourceBBox.getCenter()
const targetCorner = view.targetBBox.getCenter()
const randomPoint = Point.random(
sourceCorner.x,
targetCorner.x,
sourceCorner.y,
targetCorner.y,
)
points.push(randomPoint)
}
return points
}
Graph.registerRouter('random', randomRouter)
edge.setRouter('random', { bounces: 3 })
以下是效果图