g6/docs/api/graphLayout/radial.zh.md
2020-11-13 22:33:15 +08:00

5.3 KiB
Raw Blame History

title order
辐射形 Radial 4

Radial 布局是将图布局成辐射状的布局方法。以一个 focusNode 为中心,其余节点按照与 focusNode 的度数关系排列在不同距离的环上。距离 focusNode 一度的节点布局在与其最近的第一个环上,距离 focusNode 二度的节点布局在第二个环上,以此类推。算法原文链接: More Flexible Radial Layout

img
const graph = new G6.Graph({
  container: 'mountNode',
  width: 1000,
  height: 600,
  layout: {
    type: 'radial',
    center: [ 200, 200 ],     // 可选,默认为图的中心
    linkDistance: 50,         // 可选,边长
    maxIteration: 1000,       // 可选
    focusNode: 'node11',      // 可选
    unitRadius: 100,          // 可选
    preventOverlap: true,     // 可选,必须配合 nodeSize
    nodeSize: 30,             // 可选
    strictRadial: false       // 可选
    workerEnabled: true       // 可选,开启 web-worker
  }
});

layoutCfg.center

类型 Array
示例[ 0, 0 ]
默认值:图的中心
是否必须false
说明:布局的中心

layoutCfg.linkDistance

类型 Number
默认值50
是否必须false
说明:边长度

layoutCfg.maxIteration

类型 Number
默认值1000
是否必须false
说明:停止迭代到最大迭代数

layoutCfg.focusNode

类型String | Object
默认值null
是否必须false
说明:辐射的中心点,默认为数据中第一个节点。可以传入节点 id 或节点本身

layoutCfg.unitRadius

类型Number
默认值100
是否必须false
说明:每一圈距离上一圈的距离。默认填充整个画布,即根据图的大小决定

layoutCfg.preventOverlap

类型Boolean
默认值false
是否必须false
说明:是否防止重叠,必须配合下面属性 nodeSize,只有设置了与当前图节点大小相同的 nodeSize 值,才能够进行节点重叠的碰撞检测

layoutCfg.nodeSize

类型 Number
默认值10
是否必须false
说明:节点大小(直径)。用于防止节点重叠时的碰撞检测

layoutCfg.nodeSpacing

类型: Number / Function
默认值: 0
是否必须: false
示例: Example 1: 10
Example 2:

(d) => {
  // d is a node
  if (d.id === 'node1') {
    return 100;
  }
  return 10;
};


描述: preventOverlaptrue 时生效, 防止重叠时节点边缘间距的最小值。可以是回调函数, 为不同节点设置不同的最小间距, 如示例 2 所示

layoutCfg.maxPreventOverlapIteration

类型 Number
默认值200
是否必须false
说明:防止重叠步骤的最大迭代次数

layoutCfg.strictRadial

类型 Boolean
默认值true
是否必须false
说明:是否必须是严格的 radial 布局,及每一层的节点严格布局在一个环上。preventOverlaptrue 时生效。

  • preventOverlaptrue,且 strictRadialfalse 时,有重叠的节点严格沿着所在的环展开,但在一个环上若节点过多,可能无法完全避免节点重叠。
  • preventOverlaptrue,且 strictRadialtrue  时,允许同环上重叠的节点不严格沿着该环布局,可以在该环的前后偏移以避免重叠。
img img img

preventOverlap = false。preventOverlap = falsestrictRadial = true。preventOverlap = falsestrictRadial = false。

layoutCfg.sortBy

类型: String
默认值: undefined
是否必须: false
说明: 同层节点布局后相距远近的依据。默认 undefined ,表示根据数据的拓扑结构(节点间最短路径)排布,即关系越近/点对间最短路径越小的节点将会被尽可能排列在一起;'data' 表示按照节点在数据中的顺序排列,即在数据顺序上靠近的节点将会尽可能排列在一起;也可以指定为节点数据中的某个字段名,例如 'cluster''name' 等(必须在数据中存在)

layoutCfg.sortStrength

类型: Number
默认值: 10
是否必须: false
说明: 同层节点根据 sortBy 排列的强度,数值越大,sortBy 指定的方式计算出距离越小的越靠近。sortBy 不为 undefined 时生效

layoutCfg.workerEnabled

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