logo

G6

  • 文档
  • API
  • 图表示例
  • 社区
  • 所有产品antv logo arrow
  • 5.0.49
  • 简介
  • 开始使用
    • 快速开始
    • 安装
    • 前端框架集成
      • 在 React 中使用
      • 在 Vue 中使用
      • 在 Angular 中使用
    • 详细教程
  • 图 Graph
    • Graph - 图
    • Options 配置项
    • 内置扩展
    • Extension - 扩展
  • 数据 Data
  • 元素 Element
    • 元素总览
    • 元素状态
    • 节点 Node
      • 节点总览
      • 节点通用配置项
      • 圆形节点 Circle
      • 菱形节点 Diamond
      • 甜甜圈节点 Donut
      • 椭圆形节点 Ellipse
      • 六边形节点 Hexagon
      • HTML节点 Html
      • 图片节点 Image
      • 矩形节点 Rect
      • 五角形节点 Star
      • 三角形节点 Triangle
      • 自定义节点
      • 使用 React 定义节点
    • 边 Edge
      • 边总览
      • 边通用配置项
      • 三次贝塞尔曲线边 Cubic
      • 水平三次贝塞尔曲线边 CubicHorizontal
      • 垂直三次贝塞尔曲线边 CubicVertical
      • 直线边 Line
      • 二次贝塞尔曲线边 Quadratic
      • 折线边 Polyline
      • 自定义边
    • 组合 Combo
      • 组合总览
      • 组合通用配置项
      • 圆形组合 Circle
      • 矩形组合 Rect
      • 自定义 Combo
    • 图形 Shape
      • 图形 Shape 与 KeyShape
      • 原子 Shape 以及其属性
      • 复合 Shape 的设计与实现
  • 布局 Layout
    • 布局总览
    • 布局通用配置项
    • AntV Dagre 布局 AntvDagre
    • 环形布局 Circular
    • 复合布局 ComboCombined
    • 紧凑树布局 CompactBox
    • 同心圆布局 Concentric
    • 3D D3力导向布局 D3Force3D
    • D3力导向布局 D3Force
    • Dagre 布局
    • 生态树 Dendrogram
    • 鱼骨布局 Fishbone
    • ForceAtlas2 力导向布局
    • Force 力导向布局
    • Fruchterman 力导向布局
    • 网格布局 Grid
    • 缩进树 Indented
    • 高维数据降维布局 MDS
    • 脑图树 Mindmap
    • 径向布局 Radial
    • 随机布局 Random
    • 蛇形布局 Snake
    • 自定义布局
  • 交互 Behavior
    • 交互总览
    • 缩放画布 ZoomCanvas
    • 标签自适应显示 AutoAdaptLabel
    • 框选 BrushSelect
    • 点击选中 ClickSelect
    • 展开/收起元素 CollapseExpand
    • 创建边 CreateEdge
    • 拖拽画布 DragCanvas
    • 拖拽元素 DragElement
    • 力导向拖拽元素 DragElementForce
    • 缩放画布时固定元素大小 FixElementSize
    • 聚焦元素 FocusElement
    • 悬停激活 HoverActivate
    • 套索选择 LassoSelect
    • 优化视口变换 OptimizeViewportTransform
    • 滚动画布 ScrollCanvas
    • 自定义交互
  • 插件 Plugin
    • 插件总览
    • 背景 Background
    • 气泡集 BubbleSets
    • 上下文菜单 Contextmenu
    • 边绑定 EdgeBundling
    • 边过滤镜 EdgeFilterLens
    • 鱼眼放大镜 Fisheye
    • 全屏展示 Fullscreen
    • 网格线 GridLine
    • 历史记录 History
    • 轮廓包围 Hull
    • 图例 Legend
    • 小地图 Minimap
    • 对齐线 Snapline
    • 时间条 Timebar
    • 工具栏 Toolbar
    • 提示框 Tooltip
    • 水印 Watermark
    • 自定义插件
  • 数据处理 Transform
    • 数据处理总览
    • 动态调整节点大小 MapNodeSize
    • 径向标签 PlaceRadialLabels
    • 平行边 ProcessParallelEdges
    • 自定义数据处理
  • 主题 Theme
    • 主题总览
    • 自定义主题
    • 色板
    • 自定义色板
  • 动画 Animation
    • 动画总览
    • 自定义动画
  • 扩展阅读
    • 事件
    • 渲染器
    • 坐标系
    • 下载图片
    • 使用 iconfont
    • 使用 3D
    • 项目打包
  • 版本特性
    • 新版本特性
    • 升级到 5.0
  • 常见问题
  • 参与贡献

组合总览

上一篇
自定义边
下一篇
组合通用配置项

资源

Ant Design
Galacea Effects
Umi-React 应用开发框架
Dumi-组件/文档研发工具
ahooks-React Hooks 库

社区

体验科技专栏
seeconfSEE Conf-蚂蚁体验科技大会

帮助

GitHub
StackOverflow

more products更多产品

Ant DesignAnt Design-企业级 UI 设计语言
yuque语雀-知识创作与分享工具
EggEgg-企业级 Node 开发框架
kitchenKitchen-Sketch 工具集
GalaceanGalacean-互动图形解决方案
xtech蚂蚁体验科技
© Copyright 2025 Ant Group Co., Ltd..备案号:京ICP备15032932号-38

Loading...

什么是组合

组合(Combo) 全称为 Combination,是 G6 中的一种特殊的图元素,它可以包含节点和子组合,类似“群组”或“容器”的概念。它通常用于表示集合关系,例如一个部门包含多个员工,一个城市包含多个区域等。

注意

不推荐在树图中使用 Combo。因为树图的布局与 Combo 的布局机制不兼容,容易导致节点错位或样式混乱。

G6 的内置 Combo 包括 circle(圆形组合)和 rect (矩形组合) 两种类型,分别如下图所示:

数据结构

定义 Combo 时,需要在图的数据对象中添加 combos 字段,每个 Combo 是一个对象,结构如下:

属性描述类型默认值必选
id组合的唯一标识符string-✓
type组合类型,内置组合类型名称或者自定义组合名称,比如 circle 或者 rectstring-
data组合数据,用于存储组合的自定义数据,可以在样式映射中通过回调函数获取object-
style组合样式object-
states组合初始状态string[]-
combo组合的父组合 ID。如果没有父组合,则为 nullstring | null-

combos 数组中一个数据项的示例:

{
"id": "combo1",
"type": "circle",
"data": { "groupName": "Group A" },
"style": { "fill": "lightblue", "stroke": "blue", "collapsed": true },
"states": [],
"combo": null
}

要将节点归属到某个 Combo,可以在节点数据中添加 combo 字段:

{
"nodes": [{ "id": "node1", "combo": "comboA" }], // node1 属于 comboA
"combos": [{ "id": "comboA" }] // 定义 comboA
}

配置方法

配置 Combo 的方式有三种,按优先级从高到低如下:

  • 使用 graph.setCombo() 动态配置
  • 实例化图时全局配置
  • 在数据中动态属性

这几个配置方法可以同时使用。有相同的配置项时,优先级高的方式将会覆盖优先级低的。

使用 graph.setCombo()

可在图实例创建后,使用 graph.setCombo() 动态设置 Combo 的样式映射逻辑。

该方法需要在 graph.render() 之前调用才会生效,并拥有最高优先级。

graph.setCombo({
style: {
type: 'circle',
style: { fill: '#7FFFD4', stroke: '#5CACEE', lineWidth: 2 },
},
});
graph.render();

实例化图时全局配置

在实例化图时可以通过 combo 配置 Combo 样式映射,这里的配置是全局的配置,将会在所有 Combo 上生效。

import { Graph } from '@antv/g6';
const graph = new Graph({
// 在组合配置中指定组合类型以及组合样式类型
combo: {
type: 'circle',
style: { fill: '#7FFFD4', stroke: '#5CACEE', lineWidth: 2 },
},
});

在数据中动态配置

如果需要为不同 Combo 进行不同的配置,可以将配置写入到 Combo 数据中。这种配置方式可以通过下面代码的形式直接写入数据:

// 在数据中指定组合类型以及组合样式类型
const data = {
combos: [
{
id: 'combo-1',
type: 'circle',
style: { size: 100, stroke: 'orange' },
},
],
};

调整优先级

如果你想让数据中配置的优先级高于全局配置,你可以采取以下方式:

const data = {
combos: [
{
id: 'combo-1',
type: 'circle',
style: { size: 100, stroke: 'orange' },
},
],
};
const graph = new Graph({
combo: {
type: (d) => d.type || 'rect',
style: {
stroke: (d) => d.style.stroke || 'blue',
},
},
});

示例

import { Graph, register, Rect, ExtensionCategory } from '@antv/g6';
const data = {
nodes: [
{
id: 'node1',
combo: 'combo1',
style: { x: 245, y: 200 },
},
{
id: 'node2',
combo: 'combo1',
style: { x: 210, y: 250 },
},
{
id: 'node3',
combo: 'combo1',
style: { x: 280, y: 245 },
},
{
id: 'node4',
combo: 'combo2',
style: { x: 400, y: 165 },
},
{
id: 'node5',
combo: 'combo2',
style: { x: 450, y: 162 },
},
{
id: 'node6',
combo: 'combo3',
style: { x: 425, y: 300 },
},
{
id: 'node7',
combo: 'combo3',
style: { x: 360, y: 332 },
},
],
edges: [],
combos: [
{
id: 'combo1',
combo: 'combo3',
data: { label: 'Combo A' },
},
{
id: 'combo2',
combo: 'combo3',
data: { label: 'Combo B' },
},
{
id: 'combo3',
data: { label: 'Combo C' },
},
{
id: 'combo4',
data: { label: 'Combo D' },
style: { x: 58, y: 248 },
},
],
};
const graph = new Graph({
container: 'container',
height: 450,
data,
node: {
style: {
labelText: (d) => d.id,
labelPlacement: 'center',
labelFill: '#fff',
labelFontSize: 10,
},
},
combo: {
type: 'circle',
style: {
padding: 2,
labelText: (d) => d.data.label,
labelPlacement: 'top',
},
},
behaviors: [
'collapse-expand',
{
type: 'drag-element',
dropEffect: 'link',
},
],
});
graph.render();

Combo 交互

只是简单地将 Combo 渲染出来,并没有多大的实用价值,只有支持一系列的交互操作后,才能最大程度地体现 Combo 的价值。

在 G6 中,我们内置了 drag-element、collapse-expand 三个交互。

drag-element

支持拖动节点和 Combo。拖动 Combo 过程中,会动态改变 Combo 中节点和边的位置,在拖拽完成以后,保持 Combo 和节点的相对位置不变。还可以通过设置 dropEffect: 'link' 在拖拽时改变 Combo 的从属关系。

collapse-expand

支持双击 Combo 收起和展开 Combo ,收起 Combo 以后,隐藏 Combo 中的所有节点,外部节点和 Combo 中节点有连线的情况下,所有连接会连接到 Combo 上面。

自定义组合

当内置组合无法满足需求时,G6 提供了强大的自定义能力:

  • 继承内置组合进行扩展
  • 创建全新的组合类型

与组合不同,自定义组合需要先注册后使用。详细教程请参考 自定义组合 文档。