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
  • 常见问题
  • 参与贡献

展开/收起元素 CollapseExpand

上一篇
点击选中 ClickSelect
下一篇
创建边 CreateEdge

资源

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

概述

CollapseExpand 是 G6 中用于实现节点或组合(Combo)展开/收起功能的内置交互。通过双击(默认)或单击操作,用户可以灵活控制图元素的展开与收起状态,有效管理图结构的可视化层次,降低视觉复杂度。

使用场景

这一交互主要用于:

  • 管理大型层次结构图,实现树状图或网络图的分层浏览
  • 简化复杂图的展示,按需展开关注区域
  • 隐藏暂时不需要查看的分支节点,聚焦于重要信息

在线体验

createGraph(
{
data: {
nodes: [
{ id: 'node1', combo: 'combo1', style: { x: 250, y: 150 } },
{ id: 'node2', combo: 'combo1', style: { x: 350, y: 150 } },
{ id: 'node3', combo: 'combo2', style: { x: 250, y: 300 } },
],
edges: [],
combos: [
{ id: 'combo1', combo: 'combo2' },
{ id: 'combo2', style: {} },
],
},
node: { style: { fill: '#7e3feb' } },
edge: { style: { stroke: '#8b9baf' } },
behaviors: [
{
type: 'collapse-expand',
key: 'collapse-expand',
},
],
plugins: [{ type: 'grid-line', size: 30 }],
animation: true,
},
{ width: 600, height: 400 },
(gui, graph) => {
const options = {
key: 'collapse-expand',
type: 'collapse-expand',
animation: true,
enable: true,
};
const optionFolder = gui.addFolder('CollapseExpand Options');
optionFolder.add(options, 'type').disable(true);
optionFolder.add(options, 'animation');
optionFolder.add(options, 'enable');
optionFolder.onChange(({ property, value }) => {
graph.updateBehavior({
key: 'collapse-expand',
[property]: value,
});
graph.render();
});
},
);

基本用法

在图配置中添加这一 behavior:

1. 快速配置(静态)

使用字符串形式直接声明,这种方式简洁但仅支持默认配置,且配置后不可动态修改:

const graph = new Graph({
// 其他配置...
behaviors: ['collapse-expand'],
});

2. 对象配置(推荐)

使用对象形式进行配置,支持自定义参数,且可以在运行时动态更新配置:

const graph = new Graph({
// 其他配置...
behaviors: [
{
type: 'collapse-expand',
key: 'collapse-expand-1',
trigger: 'click', // 修改触发方式为单击
animation: true, // 启用动画效果
},
],
});

配置项

配置项说明类型默认值必选
type交互类型名称collapse-expand | stringcollapse-expand✓
animation是否启用展开/收起动画效果booleantrue
enable是否启用展开/收起功能boolean | ((event: IPointerEvent) => boolean)true
trigger触发方式,可选单击或双击click | dblclickdblclick
onCollapse完成收起时的回调函数(id: string) => void-
onExpand完成展开时的回调函数(id: string) => void-
align是否对准目标元素,避免视图偏移booleantrue

代码示例

基础展开/收起功能

const graph = new Graph({
container: 'container',
width: 800,
height: 600,
behaviors: ['collapse-expand'],
// 其他配置...
});

使用单击触发展开/收起

const graph = new Graph({
// 其他配置...
behaviors: [
{
type: 'collapse-expand',
trigger: 'click', // 将默认的双击触发改为单击触发
},
],
});

自定义展开/收起回调

const graph = new Graph({
// 其他配置...
behaviors: [
{
type: 'collapse-expand',
onCollapse: (id) => {
console.log(`节点 ${id} 已收起`);
// 执行自定义逻辑
},
onExpand: (id) => {
console.log(`节点 ${id} 已展开`);
// 执行自定义逻辑
},
},
],
});

条件性启用展开/收起功能

const graph = new Graph({
// 其他配置...
behaviors: [
{
type: 'collapse-expand',
// 只有当目标是节点类型时才启用展开/收起功能
enable: (event) => event.targetType === 'node',
},
],
});

关闭动画效果

const graph = new Graph({
// 其他配置...
behaviors: [
{
type: 'collapse-expand',
animation: false, // 关闭展开/收起动画效果
},
],
});

常见问题

1. 如何判断一个节点是否处于收起状态?

可以通过检查节点数据中的 collapsed 属性:

const isCollapsed = (nodeId) => {
const nodeData = graph.getNodeData(nodeId);
return nodeData?.style?.collapsed === true;
};

2. 如何以编程方式展开或收起节点?

除了通过用户交互触发,你还可以使用 collapseElement 或 expandElement 直接控制:

// 收起节点
graph.collapseElement('nodeId', { animation: true });
// 展开节点
graph.expandElement('nodeId', { animation: true });

实际案例

import { Graph } from '@antv/g6';
const graph = new Graph({
container: 'container',
data: {
nodes: [
{ id: 'node1', combo: 'combo1', style: { x: 300, y: 100 } },
{ id: 'node2', combo: 'combo1', style: { x: 300, y: 150 } },
{ id: 'node3', combo: 'combo2', style: { x: 100, y: 100 } },
{ id: 'node4', combo: 'combo2', style: { x: 50, y: 150 } },
{ id: 'node5', combo: 'combo2', style: { x: 150, y: 150 } },
],
edges: [
{ source: 'node1', target: 'node2' },
{ source: 'node3', target: 'node4' },
{ source: 'node3', target: 'node5' },
],
combos: [
{ id: 'combo1', style: { labelText: '双击折叠', collapsed: true } },
{ id: 'combo2', style: { labelText: '单击折叠', collapsed: false } },
],
},
behaviors: [
{
type: 'collapse-expand',
trigger: 'dblclick',
enable: (event) => event.targetType === 'combo' && event.target.id === 'combo1',
},
{
type: 'collapse-expand',
trigger: 'click',
enable: (event) => event.targetType === 'combo' && event.target.id === 'combo2',
},
],
});
graph.render();