logo

G2

  • 文档
  • 图表介绍
  • API
  • 图表示例
  • 主题
  • 周边生态
  • 所有产品antv logo arrow
  • 5.3.3
  • 快速上手
  • 简介
    • 什么是 G2
    • 在前端框架中使用
    • Spec 和 API
  • 核心概念
    • 图表(Chart)
      • G2 图表组成
      • 如何使用图表
    • 标记(Mark)
      • 概览
      • area
      • box
      • boxplot
      • cell
      • chord
      • density
      • gauge
      • heatmap
      • image
      • interval
      • line
      • lineX
      • lineY
      • link
      • liquid
      • sunburst
      • point
      • polygon
      • range
      • rangeX
      • rangeY
      • rect
      • shape
      • text
      • vector
      • wordCloud
    • 视图(View)
    • 数据(Data)
      • 概览
      • custom
      • ema
      • fetch
      • filter
      • fold
      • inline
      • join
      • kde
      • log
      • map
      • pick
      • rename
      • slice
      • sort
      • sortBy
    • 编码(Encode)
    • 比例尺(Scale)
      • 概览
      • band
      • linear
      • log
      • ordinal
      • point
      • quantile
      • quantize
      • sqrt
      • threshold
      • time
      • pow
    • 转换(Transform)
      • 概览
      • bin
      • binX
      • diffY
      • dodgeX
      • flexX
      • group
      • groupColor
      • groupX
      • groupY
      • jitter
      • jitterX
      • jitterY
      • normalizeY
      • pack
      • sample
      • select
      • selectX
      • selectY
      • sortColor
      • sortX
      • sortY
      • stackEnter
      • stackY
      • symmetryY
    • 坐标系(Coordinate)
      • 概览
      • fisheye
      • parallel
      • polar
      • theta
      • transpose
      • radial
      • cartesian3D
      • helix
    • 样式(Style)
    • 动画(Animate)
      • 概览
      • fadeIn
      • fadeOut
      • growInX
      • growInY
      • morphing
      • pathIn
      • scaleInX
      • scaleInY
      • scaleOutX
      • scaleOutY
      • waveIn
      • zoomIn
      • zoomOut
    • 状态(State)
    • 交互(Interaction)
      • 概览
      • brushAxisHighlight
      • brushHighlight
      • brushXHighlight
      • brushYHighlight
      • brushFilter
      • brushXFilter
      • brushYFilter
      • chartIndex
      • elementHighlight
      • elementHighlightByColor
      • elementHighlightByX
      • elementSelect
      • elementSelectByColor
      • elementSelectByX
      • fisheye
      • legendFilter
      • legendHighlight
      • poptip
      • scrollbarFilter
      • sliderFilter
    • 复合(Composition)
      • 概览
      • facetCircle
      • facetRect
      • repeatMatrix
      • spaceFlex
      • spaceLayer
      • timingKeyframe
    • 主题(Theme)
      • 概览
      • academy
      • classic
      • classicDark
    • 事件(Event)
    • 颜色映射(Color)
  • 图表 API
  • 图表组件
    • 标题(Title)
    • 坐标轴(Axis)
    • 图例(Legend)
    • 滚动条(Scrollbar)
    • 缩略轴(Slider)
    • 提示信息(Tooltip)
    • 数据标签(Label)
  • 进阶主题
    • 关系图(Graph)
      • forceGraph
      • pack
      • sankey
      • tree
      • treemap
    • 地图(Geo)
      • geoPath
      • geoView
    • 3D 图表(3D Chart)
      • 绘制 3D 图表
      • point3D
      • line3D
      • interval3D
      • surface3D
    • 插件扩展(Plugin)
      • renderer
      • rough
      • lottie
      • a11y
    • 按需打包
    • 设置纹理
    • 服务端渲染(SSR)
    • Spec 函数表达式支持 (5.3.0 支持)
  • 版本特性
    • 新版本特性
    • v4 升级 v5 指南
  • 常见问题 FAQ

事件(Event)

上一篇
classicDark
下一篇
颜色映射(Color)

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

G2 对外暴露了一些事件,用于获取图表的生命周期,以及交互信息。G2 导出了一个 ChartEvent 类型,用于定义事件的类型。

click event
import { Chart, ChartEvent } from '@antv/g2';
const chart = new Chart({
container,
canvas,
});
chart.data([
{ genre: 'Sports', sold: 275 },
{ genre: 'Strategy', sold: 115 },
{ genre: 'Action', sold: 120 },
{ genre: 'Shooter', sold: 350 },
{ genre: 'Other', sold: 150 },
]);
chart
.interval()
.encode('x', 'genre')
.encode('y', 'sold')
.encode('color', 'genre')
.axis({ x: { animate: false }, y: { animate: false } });
chart.on('interval:click', (e) => {
console.log(e.data.data); // 展示点击的数据
});
chart.on('element:click', (e) => {
console.log(e.data.data); // 展示点击的数据
});
chart.render();

生命周期事件

如果想要获取图表的生命周期信息,可以通过下面的方式:

chart.on(ChartEvent.AFTER_RENDER, (ev) => {
console.log(ev);
});

G2 目前提供了以下生命周期事件:

事件名说明
ChartEvent.BEFORE_RENDER渲染前
ChartEvent.BEFORE_PAINT绘制前
ChartEvent.AFTER_PAINT绘制后
ChartEvent.AFTER_RENDER渲染后
ChartEvent.BEFORE_CHANGE_DATA更改数据前
ChartEvent.AFTER_CHANGE_DATA更改数据后
ChartEvent.BEFORE_CLEAR清理画布前
ChartEvent.AFTER_CLEAR清理画布后
ChartEvent.BEFORE_DESTROY销毁画布前
ChartEvent.AFTER_DESTROY销毁画布后
ChartEvent.BEFORE_CHANGE_SIZE更改画布尺寸前
ChartEvent.AFTER_CHANGE_SIZE更改画布尺寸后
  • 渲染前:指 G2 着手开始处理数据,进行布局,绘制图形等操作。
  • 绘制前: 指完成数据处理,布局,绘制图形等操作,但是还没有进行绘制。
  • 绘制后: 指 G2 完成所有的绘制操作,但可能存在动画,动画结束后,图表才算真正的渲染完成。
  • 渲染后: 指 G2 完成所有的绘制操作,包括动画。
  • 清理画布后: 容器中的图表已经被清理,但是 G2 实例还存在,可以继续使用。
  • 销毁画布后: G2 实例已经被销毁,无法再使用。

交互事件

如果你想要获取图表的交互信息,可以通过下面的方式:

  • 监听全局 element 事件
chart.on(`element:${ChartEvent.EventType}`, (ev) => {
console.log(ev);
});
  • 监听指定 element 事件
chart.on(`${markType}:${ChartEvent.EventType}`, (ev) => {
console.log(ev);
});
// 如,监听柱状图中的柱子的点击事件
chart.on(`interval:${ChartEvent.CLICK}`, (ev) => {
console.log(ev);
});
  • 监听 plot 区域事件
chart.on('plot:click', (event) => console.log(event));
  • 监听全局 component 事件
chart.on('component:click', (event) => console.log(event));
  • 监听全局 label 事件
chart.on('label:click', (event) => console.log(event));

点击事件

事件名说明回调参数
ChartEvent.CLICK点击Event
ChartEvent.DBLCLICK双击Event

指针事件

事件名说明回调参数
ChartEvent.POINTER_TAPEvent
ChartEvent.POINTER_DOWN当指针按下时Event
ChartEvent.POINTER_UP当指针松开时Event
ChartEvent.POINTER_OVER当指针进入目标元素时Event
ChartEvent.POINTER_OUT当指针离开目标元素时Event
ChartEvent.POINTER_MOVE当指针改变坐标时Event
ChartEvent.POINTER_ENTER当指针进入目标元素或其子元素时Event
ChartEvent.POINTER_LEAVE当指针离开目标元素或其子元素时Event
ChartEvent.POINTER_UPOUTSIDEEvent

拖拽事件

如果希望监听拖拽事件,需要设置 draggable 和 droppable 属性

chart.interval().style('draggable', true).style('droppable', true);
事件名说明回调参数
ChartEvent.DRAG_START开始拖拽时Event
ChartEvent.DRAG拖拽过程中Event
ChartEvent.DRAG_END拖拽完成时Event
ChartEvent.DRAG_ENTER元素被拖拽进入目标元素内时Event
ChartEvent.DRAG_LEAVE元素被拖拽离开目标元素时Event
ChartEvent.DRAG_OVER元素被拖拽悬停在目标元素内时Event
ChartEvent.DROP元素被放置到目标元素内时Event

典型案例

详见交互-事件示例