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

elementHighlightByColor

上一篇
elementHighlight
下一篇
elementHighlightByX

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

概述

elementHighlightByColor 交互的对象是图表元素 element,当鼠标悬浮在元素上时,高亮和鼠标悬浮的元素拥有相同 color 通道值的元素。

  • 触发:鼠标悬浮在元素上。

  • 结束:鼠标移出元素。

  • 影响状态:

悬浮的元素变为 active 状态。

其他元素变为 inactive 状态。

交互内置状态:

({
// active 状态下的元素为1px黑色边框
state: { active: { lineWidth: '1', stroke: '#000' } },
});
example
import { Chart } from '@antv/g2';
const chart = new Chart({ container: 'container' });
chart.options({
type: 'interval',
data: {
type: 'fetch',
value:
'https://gw.alipayobjects.com/os/bmw-prod/f129b517-158d-41a9-83a3-3294d639b39e.csv',
format: 'csv',
},
encode: { x: 'state', y: 'population', color: 'age' },
transform: [
{ type: 'stackY' },
{ type: 'sortX', by: 'y', reverse: true, slice: 5 },
],
state: {
active: { fill: 'red', linkFillOpacity: 0.5 },
inactive: { opacity: 0.5 },
},
axis: { y: { labelFormatter: '~s' } },
interaction: { elementHighlightByColor: { link: true } },
});
chart.render();

使用方式

配置 elementHighlightByColor 交互有两种方式:

第一种,传入 boolean 设置是否开启交互。

({
type: 'interval',
interaction: { elementHighlightByColor: true }, // 采用默认配置
});

第二种,传入 配置项 对交互进行配置。

({
type: 'line',
interaction: {
elementHighlightByColor: {
background: true,
},
},
});

配置层级

交互可以配置在 Mark 层级:

({
type: 'interval',
interaction: { elementHighlightByColor: true },
});

也可以配置在 View 层级,视图上声明的交互会传递给 children 声明的标记,如果该标记有声明对应的交互,就合并;否则不影响。

({
type: 'view',
interaction: { elementHighlightByColor: true },
});

配置项

元素高亮交互配置有两处:

  1. 交互配置
  2. 元素高亮的样式

交互配置

属性描述类型默认值
background是否高亮背景booleanfalse
region鼠标移动到元素空白区域时是否触发高亮(效果见下图)booleanfalse
link是否展示连接线booleanfalse
example

元素高亮样式配置

属性描述类型默认值
offset主方向上的便偏移量number0
background是否高亮背景backgroundStyle详见backgroundstyle
link是否展示连接线linkStyle详见linkStyle

backgroundStyle

元素高亮背景样式详见自定义高亮

属性描述类型默认值必选
backgroundRadius背景圆角number | (datum, index, data) => number0
backgroundFill背景填充色string | (datum, index, data) => stringtransparent
backgroundFillOpacity背景填充透明度number | (datum, index, data) => number-
backgroundStroke背景的描边string | (datum, index, data) => string-
backgroundStrokeOpacity背景描边透明度number | (datum, index, data) => number-
backgroundLineWidth背景描边的宽度number | (datum, index, data) => number-
backgroundLineDash背景描边的虚线配置,第一个值为虚线每个分段的长度,第二个值为分段间隔的距离。lineDash 设为[0,0]的效果为没有描边。[number,number] | (datum, index, data) => [number , number]-
backgroundOpacity背景的整体透明度number | (datum, index, data) => number-
backgroundShadowColor背景阴影颜色string | (datum, index, data) => string-
backgroundShadowBlur背景阴影的高斯模糊系数number | (datum, index, data) => number-
backgroundShadowOffsetX设置阴影距背景的水平距离number | (datum, index, data) => number-
backgroundShadowOffsetY设置阴影距背景的垂直距离number | (datum, index, data) => number-
backgroundCursor背景鼠标样式。同 css 的鼠标样式。string | (datum, index, data) => stringdefault
({
state: {
active: {
backgroundRadius: 50,
backgroundFill: '#000',
backgroundFillOpacity: 0.9,
backgroundStroke: '#DAF5EC',
backgroundStrokeOpacity: 0.9,
backgroundLineWidth: 2,
backgroundLineDash: [4, 8],
backgroundOpacity: 1,
backgroundShadowColor: '#d3d3d3',
backgroundShadowBlur: 10,
backgroundShadowOffsetX: 10,
backgroundShadowOffsetY: 10,
backgroundCursor: 'pointer',
},
},
});

linkStyle

连接样式详见示例连接线

属性描述类型默认值必选
linkRadius连接线圆角number | (datum, index, data) => number0
linkFill连接线填充色string | (datum, index, data) => stringtransparent
linkFillOpacity连接线填充透明度number | (datum, index, data) => number-
linkStroke连接线的描边string | (datum, index, data) => string-
linkStrokeOpacity连接线描边透明度number | (datum, index, data) => number-
linkLineWidth连接线描边的宽度number | (datum, index, data) => number-
linkLineDash连接线描边的虚线配置,第一个值为虚线每个分段的长度,第二个值为分段间隔的距离。lineDash 设为[0,0]的效果为没有描边。[number,number] | (datum, index, data) => [number , number]-
linkOpacity连接线的整体透明度number | (datum, index, data) => number-
linkShadowColor连接线阴影颜色string | (datum, index, data) => string-
linkShadowBlur连接线阴影的高斯模糊系数number | (datum, index, data) => number-
linkShadowOffsetX设置阴影距连接线的水平距离number | (datum, index, data) => number-
linkShadowOffsetY设置阴影距连接线的垂直距离number | (datum, index, data) => number-
linkCursor连接线鼠标样式。同 css 的鼠标样式。string | (datum, index, data) => stringdefault
({
state: {
active: {
linkRadius: 50,
linkFill: '#000',
linkFillOpacity: 0.9,
linkStroke: '#DAF5EC',
linkStrokeOpacity: 0.9,
linkLineWidth: 2,
linkLineDash: [4, 8],
linkOpacity: 1,
linkShadowColor: '#d3d3d3',
linkShadowBlur: 10,
linkShadowOffsetX: 10,
linkShadowOffsetY: 10,
linkCursor: 'pointer',
},
},
});

事件

监听事件

支持以下的事件:

  • element:highlight - 元素高亮时触发
  • element:unhighlight - 元素取消高亮时触发
chart.on('element:highlight', (e) => {
console.log(e.data.data);
console.log(e.data.group);
console.log(e.nativeEvent);
});
chart.on('element:unhighlight', (e) => {
console.log(e.nativeEvent);
});

触发交互

支持以下的事件:

  • element:highlight - 高亮数据
  • element:unhighlight - 取消高亮
chart.emit('element:highlight', {
data: { data: { population: 5038433 } },
});
chart.emit('element:unhighlight', {});

示例

基础高亮

import { Chart } from '@antv/g2';
const chart = new Chart({
container: 'container',
});
chart.options({
type: 'interval',
data: {
type: 'fetch',
value:
'https://gw.alipayobjects.com/os/bmw-prod/f129b517-158d-41a9-83a3-3294d639b39e.csv',
format: 'csv',
},
encode: { x: 'state', y: 'population', color: 'age' },
transform: [
{ type: 'stackY' },
{ type: 'sortX', by: 'y', reverse: true, slice: 5 },
],
state: {
active: { fill: 'red', linkFillOpacity: 0.5 },
inactive: { opacity: 0.5 },
},
axis: { y: { labelFormatter: '~s' } },
interaction: { elementHighlightByColor: true },
});
chart.render();

带连接线高亮

import { Chart } from '@antv/g2';
const chart = new Chart({
container: 'container',
});
chart.options({
type: 'interval',
data: {
type: 'fetch',
value:
'https://gw.alipayobjects.com/os/bmw-prod/f129b517-158d-41a9-83a3-3294d639b39e.csv',
format: 'csv',
},
encode: { x: 'state', y: 'population', color: 'age' },
transform: [
{ type: 'stackY' },
{ type: 'sortX', by: 'y', reverse: true, slice: 5 },
],
state: {
active: {
fill: 'red',
linkRadius: 50,
linkFill: 'green',
linkFillOpacity: 0.9,
linkStroke: '#DAF5EC',
linkStrokeOpacity: 0.9,
linkLineWidth: 2,
linkOpacity: 1,
linkCursor: 'pointer',
},
inactive: { opacity: 0.5 },
},
axis: { y: { labelFormatter: '~s' } },
interaction: {
elementHighlightByColor: { link: true, background: true },
},
});
chart.render();

transpose

import { Chart } from '@antv/g2';
const chart = new Chart({
container: 'container',
});
chart.options({
type: 'interval',
height: 600,
transform: [
{ type: 'stackY' },
{ type: 'sortX', by: 'y', reverse: true, slice: 5 },
],
coordinate: { transform: [{ type: 'transpose' }] },
data: {
type: 'fetch',
value:
'https://gw.alipayobjects.com/os/bmw-prod/f129b517-158d-41a9-83a3-3294d639b39e.csv',
format: 'csv',
},
legend: false,
encode: {
x: 'state',
y: 'population',
color: 'age',
},
axis: {
y: { labelFormatter: '~s' },
},
scale: {
x: { paddingInner: 0.2 },
},
state: {
active: {
linkFill: (d) => (d.state === 'CA' ? 'red' : undefined),
stroke: '#000',
lineWidth: 1,
linkFillOpacity: 0.5,
},
inactive: {
opacity: 0.6,
},
},
interaction: {
elementHighlightByColor: {
link: true,
},
},
});
chart.render();