初始化

G6.Graph

参数

名称类型默认值描述
containerStringHTMLElement图的 DOM 容器,可以传入该 DOM 的 id 或者直接传入容器的 HTML 节点对象
widthNumberundefined指定画布宽度,单位为 'px'
heightNumberundefined指定画布高度,单位为 'px'
rendererStringcanvas渲染引擎,支持 canvas 和 SVG。
fitViewBooleanfalse是否开启画布自适应。开启后图自动适配画布大小。
fitViewPaddingArrayNumberfitView 为 true 时生效。图适应画布时,指定四周的留白。- 可以是一个值, 例如:fitViewPadding: 20- 也可以是一个数组,例如:fitViewPadding: [ 20, 40, 50, 20 ]当指定一个值时,四边的边距都相等,当指定数组时,数组内数值依次对应 上,右,下,左四边的边距。
groupByTypesBooleantrue各种元素是否在一个分组内,决定节点和边的层级问题,默认情况下所有的节点在一个分组中,所有的边在一个分组中,当这个参数为 false 时,节点和边的层级根据生成的顺序确定。
autoPaintBooleantrue当图中元素更新,或视口变换时,是否自动重绘。建议在批量操作节点时关闭,以提高性能,完成批量操作后再打开,参见后面的 setAutoPaint() 方法。
modesObject设置画布的模式。详情可见 G6 中的 Mode 文档。
nodeStateStylesObject{}各个状态下节点的样式,例如hover、selected,3.1版本新增。
edgeStateStylesObject{}各个状态下边的样式,例如hover、selected,3.1版本新增。
defaultNodeObject{}默认状态下节点的配置,比如 shape, size, color。会被写入的 data 覆盖。
defaultEdgeObject{}默认状态下边的配置,比如 shape, size, color。会被写入的 data 覆盖。
pluginsArray[]向 graph 注册插件。插件机制请见:plugin
animateBooleanfalse是否启用全局动画。
animateCfgObject动画配置项,仅在 animate 为 true 时有效。
animateCfg.onFrameFunctionnull回调函数,用于自定义节点运动路径,为空时线性运动。
animateCfg.durationNumber500动画时长,单位为毫秒。
animateCfg.easingStringeaseLinear动画动效,可参见d3 ease。
minZoomNumber0.2最小缩放比例
maxZoomNumber10最大缩放比例
pixelRatioNumber1.0像素比率
groupTypeStringcircle节点分组类型,支持 circle 和 rect
groupStyleObjectgroupStyle 用于指定分组的样式,详情参看文档
layoutObject布局配置项,使用 type 字段指定使用的布局方式,type可取以下值:random, radial, mds, circular, fruchterman, force, dagre,各布局详细的配置请参考 Layout API文档

重点说明: G6 3.1 版本中实例化 Graph 时,新增了 nodeStateStylesedgeStateStyles两个配置项,删除了 nodeStyleedgeStyle ,使用 3.1 以下版本的同学,只需要将 nodeStyle 改成 nodeStateStyles ,将 edgeStyle 改成 edgeStateStyles ,配置内容保持不变。

用法

Graph 的初始化通过 new 进行实例化,实例化时需要传入需要的参数。

  1. const graph = new G6.Graph({
  2. container: '',
  3. width: 500,
  4. height: 500,
  5. modes: {
  6. default: ['drag-canvas'],
  7. },
  8. layout: {
  9. type: 'radial',
  10. unitRadius: 50,
  11. center: [500, 300],
  12. },
  13. });