logo

G6

  • 文档
  • API
  • 图表示例
  • 社区
  • 所有产品antv logo arrow
  • 5.0.48
  • 简介
  • 开始使用
    • 快速开始
    • 安装
    • 前端框架集成
      • 在 React 中使用
      • 在 Vue 中使用
      • 在 Angular 中使用
    • 详细教程
  • 图 Graph
    • Graph - 图
    • Options 配置项
    • 内置扩展
    • Extension - 扩展
  • 数据 Data
  • 元素 Element
    • 元素总览
    • 元素状态
    • 节点 Node
      • 节点总览
      • 内置节点
        • 节点通用配置项
        • Diamond 菱形
        • Donut 甜甜圈
        • Ellipse 椭圆形
        • Hexagon 六边形
        • Html HTML
        • Image 图片
        • Rect 矩形
        • Star 五角形
        • Triangle 三角形
        • Circle 圆形
      • 自定义节点
      • 使用 React 定义节点
    • 边 Edge
      • 边总览
      • 内置边
        • 边通用配置项
        • Cubic 三次贝塞尔曲线
        • CubicHorizontal 水平三次贝塞尔曲线
        • CubicVertical 垂直三次贝塞尔曲线
        • Line 直线
        • Polyline 折线
        • Quadratic 二次贝塞尔曲线
      • 自定义边
    • 组合 Combo
      • 组合总览
      • 内置组合
        • 组合配置项
        • Circle 圆形
        • Rect 矩形
      • 自定义 Combo
    • 图形 Shape
      • 图形 Shape 与 KeyShape
      • 原子 Shape 以及其属性
      • 复合 Shape 的设计与实现
  • 布局 Layout
    • 布局总览
    • 内置布局
      • 布局通用配置项
      • AntvDagre 布局
      • Circular 环形布局
      • ComboCombined 复合布局
      • CompactBox 紧凑树
      • Concentric 同心圆布局
      • D3Force 力导向布局
      • D3Force3D 3D 力导向布局
      • Dagre 布局
      • Dendrogram 生态树
      • Fishbone 鱼骨布局
      • Force 力导向布局
      • ForceAtlas2 力导向布局
      • Fruchterman 力导向布局
      • Grid 网格布局
      • Indented 缩进树
      • MDS 高维数据降维布局
      • Mindmap 脑图树
      • Radial 径向布局
      • Random 随机布局
      • Snake 蛇形布局
    • 自定义布局
  • 交互 Behavior
    • 交互总览
    • 内置交互
      • AutoAdaptLabel 标签自适应显示
      • BrushSelect 框选
      • ClickSelect 点击选中
      • CollapseExpand 展开/收起元素
      • CreateEdge 创建边
      • DragCanvas 拖拽画布
      • DragElement 拖拽元素
      • DragElementForce 力导向拖拽元素
      • FixElementSize 缩放画布时固定元素大小
      • FocusElement 聚焦元素
      • HoverActivate 悬停激活
      • LassoSelect 套索选择
      • OptimizeViewportTransform 优化视口变换
      • ScrollCanvas 滚动画布
      • ZoomCanvas 缩放画布
    • 自定义交互
  • 插件 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
  • 常见问题
  • 参与贡献

插件总览

上一篇
自定义交互
下一篇
Background 背景

Resources

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

什么是插件

插件(Plugin)是 G6 中最灵活的扩展机制,用户可以通过插件来扩展 G6 的功能,例如在画布中额外挂载图形组件、实现撤销重做等功能。

绝大多数的定制需求都可以通过插件来实现,G6 内置了一些常用的插件,例如:Tooltip、Grid、History。

内置插件

G6 提供了丰富的内置插件,涵盖多种常见功能场景:

分类插件名称注册类型功能描述
视觉样式增强
网格线grid-line在画布上显示网格参考线
背景background为画布添加背景图片或颜色
水印watermark为画布添加水印,保护版权
轮廓包围hull为指定节点集合创建轮廓
气泡集bubble-sets创建平滑气泡状的元素集合轮廓
对齐线snapline拖动元素时显示对齐参考线
导航与概览
缩略图minimap显示图的缩略预览,支持导航
全屏fullscreen支持图表全屏显示和退出
时间轴timebar提供时序数据的筛选和播放控制
交互控件
工具栏toolbar提供常用操作按钮集合
上下文菜单contextmenu右键点击时显示可选操作菜单
提示框tooltip悬停时显示元素详细信息
图例legend显示图表数据的类别和对应样式说明
数据探索
鱼眼放大镜fisheye提供焦点+上下文的探索体验
边过滤镜edge-filter-lens在指定区域内筛选显示边
边绑定edge-bundling将相似路径的边捆绑在一起,减少视觉混乱
高级功能
历史记录history支持撤销/重做操作
相机设置camera-setting配置3D场景下的相机参数

各插件的详细配置可参考 内置插件文档。

配置方式

基本配置

在图实例初始化时,通过 plugins 数组指定需要的插件:

import { Graph } from '@antv/g6';
const graph = new Graph({
// 其他配置...
plugins: ['grid', 'minimap', 'tooltip'],
});

配置插件参数

对于需要自定义参数的插件,可以使用 object 形式配置属性:

const graph = new Graph({
// 其他配置...
plugins: [
'grid',
{
type: 'tooltip',
key: 'my-tooltip', // 为插件指定key,便于后续更新
getContent: (e) => `<div>节点:${e.target.id}</div>`,
},
],
});

动态更新插件

G6 支持在图实例运行期间动态管理插件,满足复杂交互需求:

通过 getPlugins 方法获取当前插件列表:

// 获取插件列表
const plugins = graph.getPlugins();
// console.log(plugins) 👉 ['minimap', 'grid']

可以通过 setPlugins 方法调整插件:

// 添加新插件
graph.setPlugins((plugins) => [...plugins, 'minimap']);
// 移除插件
graph.setPlugins((plugins) => plugins.filter((p) => p !== 'grid'));

可以通过 updatePlugin 方法更新插件的配置:

const graph = new Graph({
// 其他配置...
plugins: [
{
type: 'tooltip',
key: 'my-tooltip',
getContent: (e) => `<div>节点:${e.target.id}</div>`,
},
],
});
// 更新单个插件
graph.updatePlugin({
key: 'my-tooltip',
getContent: (e) => `<div>更新的内容:${e.target.id}</div>`,
});

注意

使用 updatePlugin 方法时,需要在初始化时为插件指定唯一的 key。

卸载插件

使用 setPlugins 方法同样可以卸载插件,将插件配置列表置为空即可:

// 卸载所有插件
graph.setPlugins([]);

调用插件方法

一些插件提供了可供用户调用的 API 方法,例如 history 插件提供了 undo 和 redo 方法,用户可以通过调用这些方法来实现撤销和重做操作。

要调用这些方法,需要先获取到插件实例,可通过 getPluginInstance 方法获取:

// 配置插件
const graph = new Graph({
plugins: [{ type: 'history', key: 'my-history' }],
});
// 获取插件实例
const history = graph.getPluginInstance('my-history');
// 调用插件方法
history.undo();
history.redo();

注意

graph.getPluginInstance 方法接收插件 key 值作为参数,因此如果需要获取插件实例,需要将对应插件配置为 object 的形式,并传入 key 值。

更多与插件相关的 API 请参考 插件 API 文档。

自定义插件

当内置插件无法满足需求时,你可以:

  • 继承和扩展现有插件
  • 创建全新的自定义插件

自定义插件需要先注册后使用。详细教程请参考 自定义插件 文档。

import { register, ExtensionCategory } from '@antv/g6';
import { MyCustomPlugin } from './my-custom-plugin';
// 注册自定义插件
register(ExtensionCategory.PLUGIN, 'my-custom-plugin', MyCustomPlugin);
// 使用自定义插件
const graph = new Graph({
plugins: ['my-custom-plugin'],
});

通过合理组合和配置插件,你可以构建出功能丰富、交互体验出色的图可视化应用。