布局总览

查看 Markdown编辑此页

概述

图布局是指将图中的元素按照一定的规则进行排列的过程，例如基于电荷弹性模型的力导向布局、逐次排布的网格布局、基于层次结构的树布局等。

布局类型

G6 提供了多种布局算法，用户可以根据自己的需求选择合适的布局算法：

AntVDagreLayout：基于 dagre 定制的布局
CircularLayout：环形布局
ComboCombinedLayout：适用于存在组合的布局
ConcentricLayout：同心圆布局
D3Force3DLayout：3D 力导向布局
D3ForceLayout：基于 D3 的力导向布局
DagreLayout：dagre 布局
FishboneLayout：鱼骨布局
ForceAtlas2Layout：ForceAtlas2 布局
ForceLayout：力导向布局
FruchtermanLayout：Fruchterman 布局
GridLayout：网格布局
MDSLayout：高维数据降维算法布局
RadialLayout：径向布局
RandomLayout：随机布局
SnakeLayout：蛇形布局
CompactBoxLayout: 紧凑树布局
DendrogramLayout: 树状布局
MindmapLayout: 思维导图布局
IndentedLayout: 缩进树布局

其中 CompactBox Layout、Dendrogram Layout、Mindmap Layout、Indented Layout 是树布局的一种，适用于树状结构的图。

注册布局

你可以直接使用内置布局，如果想要使用其他布局，需要先进行注册：

import { register, ExtensionCategory } from '@antv/g6';
import { CustomLayout } from 'package-name/or/path-to-your-custom-layout';

register(ExtensionCategory.LAYOUT, 'custom-layout', CustomLayout);

配置布局

通过 layout 配置项可以指定图的布局算法，例如：

{
  layout: {
    // 指定要使用的布局算法
    type: 'force',
    // 布局算法的配置项
    gravity: 10
    // ...
  }
}

也可在图实例化之后使用 graph.setLayout 来更新布局配置。

5.1 开始，布局文档中的通用字段已与 @antvis/layout 对齐。除了各布局自己的算法参数外，也建议同时关注 width、height、center、enableWorker、node、edge 等公共配置。

布局加速

G6 对一些布局算法提供了加速版本，包括：在 Web Worker 中执行布局算法、提供 WASM 版本的布局算法、GPU 加速的布局算法等。可按照下列方式使用：

在 Web Worker 中执行布局算法

除树布局外，G6 的所有内置布局算法都支持在 Web Worker 中执行。只需将 enableWorker 设置为 true 即可：

{
  layout: {
    type: 'force',
    enableWorker: true,
    // ...
  }
}

使用 WASM 版本布局算法

目前支持 WASM 版本的布局算法有：Fruchterman Layout ForceAtlas Layout Force Layout Dagre Layout。

首先安装 @antv/layout-wasm：

npm install @antv/layout-wasm --save

引入并注册布局算法：

import { register, Graph, ExtensionCategory } from '@antv/g6';
import { FruchtermanLayout, initThreads, supportsThreads } from '@antv/layout-wasm';

register(ExtensionCategory.LAYOUT, 'fruchterman-wasm', FruchtermanLayout);

初始化线程：

const supported = await supportsThreads();
const threads = await initThreads(supported);

初始化图并传入布局配置：

const graph = new Graph({
  // ... 其他配置
  layout: {
    type: 'fruchterman-wasm',
    threads,
    // ... 其他配置
  },
});

使用 GPU 加速布局

目前支持 GPU 加速的布局算法有：Fruchterman Layout GForce Layout。

首先安装 @antv/layout-gpu：

npm install @antv/layout-gpu --save

引入并注册布局算法：

import { register, Graph, ExtensionCategory } from '@antv/g6';
import { FruchtermanLayout } from '@antv/layout-gpu';

register(ExtensionCategory.LAYOUT, 'fruchterman-gpu', FruchtermanLayout);

初始化图并传入布局配置：

const graph = new Graph({
  // ... 其他配置
  layout: {
    type: 'fruchterman-gpu',
    // ... 其他配置
  },
});

执行布局

通常，在调用 graph.render() 后，G6 会自动执行布局算法。

如果需要手动执行布局算法，G6 提供了以下 API：

layout：执行布局算法
setLayout：设置布局算法
stopLayout：停止布局算法

自定义布局

如果内置布局算法无法满足需求，可以自定义布局算法，具体请参考自定义布局。

如果你正在从 G6 5.0 的布局配置迁移到 5.1，可继续阅读从 5.0 升级到 5.1（布局）。