Loading...
当连接到节点时,可以通过 NodeAnchor
来指定被连接的节点的锚点,锚点与连接点 ConnectionPoint 共同确定了边的起点和终点。
X6 内置了以下几种锚点定义。
可以在创建边时指定锚点:
const edge = graph.addEdge({source: {cell: 'source-id',anchor: {name: 'midSide',args: {dx: 10,},},},target: {cell: 'target-id',anchor: 'orth', // 没有参数时可以简化写法},})
创建之后可以调用 edge.setSource
和 edge.setTarget
方法来修改锚点:
edge.setSource({cell: 'source-id',anchor: {name: 'midSide',args: {dx: 10,},},})
在创建画布时,可以通过 connecting
选项来设置全局默认的锚点:
new Graph({connecting: {anchor: {name: 'midSide',args: {dx: 10,},},},})
没有参数时可以简化为:
new Graph({connecting: {anchor: 'midSide',},})
元素中心点,支持如下参数:
参数名 | 参数类型 | 是否必选 | 默认值 | 参数说明 |
---|---|---|---|---|
dx | number | string | 否 | 0 | X 轴偏移量,支持数字绝对偏移量和百分比相对偏移量。 |
dy | number | string | 否 | 0 | Y 轴偏移量,支持数字绝对偏移量和百分比相对偏移量。 |
rotate | boolean | 否 | false | 是否使用元素跟随节点旋转后的包围盒,默认不考虑旋转角度。 |
元素顶部中心点,支持如下参数:
参数名 | 参数类型 | 是否必选 | 默认值 | 参数说明 |
---|---|---|---|---|
dx | number | string | 否 | 0 | X 轴偏移量,支持数字绝对偏移量和百分比相对偏移量。 |
dy | number | string | 否 | 0 | Y 轴偏移量,支持数字绝对偏移量和百分比相对偏移量。 |
rotate | boolean | 否 | false | 是否使用元素跟随节点旋转后的包围盒,默认不考虑旋转角度。 |
元素底部中心点,支持如下参数:
参数名 | 参数类型 | 是否必选 | 默认值 | 参数说明 |
---|---|---|---|---|
dx | number | string | 否 | 0 | X 轴偏移量,支持数字绝对偏移量和百分比相对偏移量。 |
dy | number | string | 否 | 0 | Y 轴偏移量,支持数字绝对偏移量和百分比相对偏移量。 |
rotate | boolean | 否 | false | 是否使用元素跟随节点旋转后的包围盒,默认不考虑旋转角度。 |
元素左侧中心点,支持如下参数:
参数名 | 参数类型 | 是否必选 | 默认值 | 参数说明 |
---|---|---|---|---|
dx | number | string | 否 | 0 | X 轴偏移量,支持数字绝对偏移量和百分比相对偏移量。 |
dy | number | string | 否 | 0 | Y 轴偏移量,支持数字绝对偏移量和百分比相对偏移量。 |
rotate | boolean | 否 | false | 是否使用元素跟随节点旋转后的包围盒,默认不考虑旋转角度。 |
元素右侧中心点,支持如下参数:
参数名 | 参数类型 | 是否必选 | 默认值 | 参数说明 |
---|---|---|---|---|
dx | number | string | 否 | 0 | X 轴偏移量,支持数字绝对偏移量和百分比相对偏移量。 |
dy | number | string | 否 | 0 | Y 轴偏移量,支持数字绝对偏移量和百分比相对偏移量。 |
rotate | boolean | 否 | false | 是否使用元素跟随节点旋转后的包围盒,默认不考虑旋转角度。 |
最靠近边的那一侧中心点,支持如下参数:
参数名 | 参数类型 | 是否必选 | 默认值 | 参数说明 |
---|---|---|---|---|
padding | number | 否 | 0 | 通过放大元素的包围盒 padding 像素,来偏移中心点。 |
rotate | boolean | 否 | false | 是否使用元素跟随节点旋转后的包围盒,默认不考虑旋转角度。 |
direction | 'H' | 'V' | 否 | - | 连接点的方向,比如如果设置为 H ,只能连接到节点的左侧或者右侧的中心点,会根据位置自动判断。 |
元素左上角,支持如下参数:
参数名 | 参数类型 | 是否必选 | 默认值 | 参数说明 |
---|---|---|---|---|
dx | number | string | 否 | 0 | X 轴偏移量,支持数字绝对偏移量和百分比相对偏移量。 |
dy | number | string | 否 | 0 | Y 轴偏移量,支持数字绝对偏移量和百分比相对偏移量。 |
rotate | boolean | 否 | false | 是否使用元素跟随节点旋转后的包围盒,默认不考虑旋转角度。 |
元素右上角,支持如下参数:
参数名 | 参数类型 | 是否必选 | 默认值 | 参数说明 |
---|---|---|---|---|
dx | number | string | 否 | 0 | X 轴偏移量,支持数字绝对偏移量和百分比相对偏移量。 |
dy | number | string | 否 | 0 | Y 轴偏移量,支持数字绝对偏移量和百分比相对偏移量。 |
rotate | boolean | 否 | false | 是否使用元素跟随节点旋转后的包围盒,默认不考虑旋转角度。 |
元素左下角,支持如下参数:
参数名 | 参数类型 | 是否必选 | 默认值 | 参数说明 |
---|---|---|---|---|
dx | number | string | 否 | 0 | X 轴偏移量,支持数字绝对偏移量和百分比相对偏移量。 |
dy | number | string | 否 | 0 | Y 轴偏移量,支持数字绝对偏移量和百分比相对偏移量。 |
rotate | boolean | 否 | false | 是否使用元素跟随节点旋转后的包围盒,默认不考虑旋转角度。 |
元素右下角,支持如下参数:
参数名 | 参数类型 | 是否必选 | 默认值 | 参数说明 |
---|---|---|---|---|
dx | number | string | 否 | 0 | X 轴偏移量,支持数字绝对偏移量和百分比相对偏移量。 |
dy | number | string | 否 | 0 | Y 轴偏移量,支持数字绝对偏移量和百分比相对偏移量。 |
rotate | boolean | 否 | false | 是否使用元素跟随节点旋转后的包围盒,默认不考虑旋转角度。 |
正交点,支持如下参数:
参数名 | 参数类型 | 是否必选 | 默认值 | 参数说明 |
---|---|---|---|---|
padding | number | 否 | 0 | X 轴偏移量。 |
节点的中心,支持如下参数:
参数名 | 参数类型 | 是否必选 | 默认值 | 参数说明 |
---|---|---|---|---|
dx | number | 否 | 0 | X 轴偏移量。 |
dy | number | 否 | 0 | Y 轴偏移量。 |
锚点定义是一个具有如下签名的函数,返回锚点。
export type Definition<T> = (this: EdgeView,nodeView: NodeView,magnet: SVGElement,ref: Point.PointLike | SVGElement,args: T,type: Edge.TerminalType,) => Point
参数名 | 参数类型 | 参数说明 |
---|---|---|
this | EdgeView | 边的视图。 |
nodeView | NodeView | 连接的节点视图。 |
magnet | SVGElement | 连接的节点上的元素。 |
ref | Point.PointLike | SVGElement | 参照点/元素。 |
args | T | 参数。 |
type | Edge.TerminalType | 边的终端类型。 |
完成锚点定义后,我们先注册锚点:
Graph.registerAnchor('custom-anchor', ...)
注册以后我们就可以通过锚点名称来使用:
new Graph({connecting: {anchor: {name: 'custom-anchor',},},})