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

5.0 KiB
Raw Blame History

title order
Force 力导向 2

Force 布局经典的力导向布局方法,与 d3 的力导向布局方法相对应。其属性也与 d3.js 的力导布局参数相对应。

img
const graph = new G6.Graph({
  container: 'mountNode',
  width: 1000,
  height: 600,
  layout: {
    type: 'force',
    center: [ 200, 200 ],     // 可选,默认为图的中心
    linkDistance: 50,         // 可选,边长
    nodeStrength: 30,         // 可选
    edgeStrength: 0.1,        // 可选
    collideStrength: 0.8,     // 可选
    nodeSize: 30,             // 可选
    alpha: 0.3,               // 可选
    alphaDecay: 0.028,        // 可选
    alphaMin: 0.01,           // 可选
    forceSimulation: null,    // 可选
    onTick: () => {           // 可选
      console.log('ticking');
    },
    onLayoutEnd: () => {      // 可选
      console.log('force layout done');
    }
  }
);

layoutCfg.center

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

layoutCfg.linkDistance

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

layoutCfg.nodeStrength

类型 Number / Function
默认值null
是否必须false
说明:节点作用力,正数代表节点之间的引力作用,负数代表节点之间的斥力作用

layoutCfg.edgeStrength

类型Number / Function
默认值null
是否必须false
说明:边的作用力,默认根据节点的出入度自适应

layoutCfg.preventOverlap

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

layoutCfg.collideStrength

类型Number
默认值1
是否必须false
说明:防止重叠的力强度,范围 [0, 1]

layoutCfg.nodeSize

类型 Number
默认值10
是否必须false
说明:节点大小(直径)。用于碰撞检测。若不指定,则根据传入的节点的 size 属性计算。若即不指定,节点中也没有 size,则默认大小为 10

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.alpha

类型Number
默认值0.3
是否必须false
说明:当前的迭代收敛阈值

layoutCfg.alphaDecay

类型Number
默认值0.028
是否必须false
说明:迭代阈值的衰减率。范围 [0, 1]。0.028 对应迭代数为 300

layoutCfg.alphaMin

类型Number
默认值0.001
是否必须false
说明:停止迭代的阈值

layoutCfg.clustering

类型Boolean
默认值false
是否必须false
说明:是否按照聚类信息布局

layoutCfg.clusterNodeStrength

类型Number
默认值-1
是否必须false
说明:聚类节点作用力。负数代表斥力

layoutCfg.clusterEdgeStrength

类型Number
默认值0.1
是否必须false
说明:聚类边作用力

layoutCfg.clusterEdgeDistance

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

layoutCfg.clusterNodeSize

类型Number
默认值10
是否必须false
说明:聚类节点大小 / 直径,直径越大,越分散

layoutCfg.clusterFociStrength

类型Number
默认值0.8
是否必须false
说明:用于 foci 的力

layoutCfg.forceSimulation

类型Object
默认值null
是否必须false
说明:自定义 force 方法,若不指定,则使用 d3.js 的方法

layoutCfg.onTick

类型Function
默认值{}
是否必须false
说明:每一次迭代的回调函数

layoutCfg.onLayoutEnd

类型Function
默认值{}
是否必须false
说明:布局完成后的回调函数

layoutCfg.workerEnabled

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