logo

Ant Design Charts

  • Manual
  • Options
  • Examples
  • Productsantv logo arrow
  • 2.0.0
  • Component Overview
  • Common Configuration Statistical Charts
    • Chart composition
    • Component
      • 标题(Title)
      • Axis
      • Legend
      • Scrollbar
      • Slider
      • Tooltip
      • Label
    • Core
      • Color En
      • View
      • Data
        • overview
        • custom
        • ema
        • fetch
        • filter
        • fold
        • inline
        • join
        • kde
        • log
        • map
        • pick
        • rename
        • slice
        • sort
        • sortBy
      • Scale
        • overview
        • band
        • linear
        • log
        • ordinal
        • point
        • pow
        • quantile
        • quantize
        • sqrt
        • threshold
        • time
      • Transform
        • overview
        • bin
        • binX
        • diffY
        • dodgeX
        • flexX
        • group
        • groupColor
        • groupX
        • groupY
        • jitter
        • jitterX
        • jitterY
        • normalizeY
        • pack
        • sample
        • select
        • selectX
        • selectX
        • sortColor
        • sortX
        • sortY
        • stackEnter
        • stackY
        • symmetryY
      • Coordinate
        • overview
        • fisheye
        • parallel
        • polar
        • radial
        • theta
        • transpose
        • cartesian3D
      • 样式(Style)
      • Animate
        • overview
        • fadeIn
        • fadeOut
        • growInX
        • growInY
        • morphing
        • pathIn
        • scaleInX
        • scaleInY
        • scaleOutX
        • scaleOutY
        • waveIn
        • zoomIn
        • zoomOut
      • 状态(State)
      • Interaction
        • Overview
        • brushAxisHighlight
        • brushHighlight
        • brushXHighlight
        • brushYHighlight
        • brushFilter
        • brushXFilter
        • brushYFilter
        • chartIndex
        • elementHighlight
        • elementHighlightByColor
        • elementHighlightByX
        • elementSelect
        • elementSelectByColor
        • elementSelectByX
        • fisheye
        • legendFilter
        • legendHighlight
        • poptip
        • scrollbarFilter
        • sliderFilter
      • Composition
        • overview
        • facetCircle
        • facetRect
        • repeatMatrix
        • spaceFlex
        • spaceLayer
        • timingKeyframe
      • Theme
        • overview
        • Academy
        • classic
        • classicDark
      • event
    • Specal Plot
      • Area
      • Bar
      • CirclePacking
      • DualAxes
      • Gauge
      • Line
      • Rose
      • Sankey
      • Scatter
      • Sunburst
      • Treemap
      • Venn
      • WordCloud
      • Column
      • Pie
      • BidirectionalBar
      • Box
      • Bullet
      • Funnel
      • Heatmap
      • Histogram
      • Liquid
      • Radar
      • Stock
      • Tiny
      • Violin
      • Waterfall
      • RadialBar
  • Relation Graph Components
    • Overview
    • MindMap
    • Fishbone
    • IndentedTree
    • Dendrogram
    • OrganizationChart
    • FlowGraph
    • FlowDirectionGraph
    • NetworkGraph
    • FAQ

brushXHighlight

Previous
brushHighlight
Next
brushYHighlight

Resources

Ant Design
Galacea Effects
Umi-React Application Framework
Dumi-Component doc generator
ahooks-React Hooks Library

Community

Ant Financial Experience Tech
seeconfSEE Conf-Experience Tech Conference

Help

GitHub
StackOverflow

more productsMore Productions

Ant DesignAnt Design-Enterprise UI design language
yuqueYuque-Knowledge creation and Sharing tool
EggEgg-Enterprise-class Node development framework
kitchenKitchen-Sketch Tool set
GalaceanGalacean-互动图形解决方案
xtechLiven Experience technology
© Copyright 2025 Ant Group Co., Ltd..备案号:京ICP备15032932号-38

Loading...

概述

brushXHighlight 是一种特殊的brushHighlight 交互。在保留基础高亮功能的同时,将 y 轴框选范围固定为全域(从最小值到最大值),专注于 x 轴方向的数据选区操作。适用于需要横向数据对比的场景(如时间序列分析),通过消除垂直方向干扰提升操作精度。

  • 触发:框选元素。

  • 结束:单击图表区域。

  • 影响状态:

框选范围的元素变为 active 状态。

框选范围以外的元素变为 inactive 状态。

交互内置状态:

({
inactive: { opacity: 0.5 },
});
example
{
"autoFit": true,
"state": {
"inactive": {
"stroke": "gray"
}
},
"interaction": {
"brushXHighlight": true
}
}

使用方式

配置 brushXHighlight 交互有两种方式

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

({
interaction: { brushXHighlight: true },
});

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

({
interaction: {
brushXHighlight: {
series: true,
},
},
});

配置层级

交互可以配置在 Mark 层级:

({
interaction: { brushXHighlight: true },
});

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

({
interaction: { brushXHighlight: true },
});

配置项

属性描述类型默认值必选
reversebrush 是否反转booleanfalse
series是否是系列元素booleanfalse
facet是否跨分面booleanfalse
selectedHandles可以 resize 的手柄方向string[]['handle-e', 'handle-w']
brushRegion框选区域(x, y, x1, y1, extent) => any(x, y, x1, y1,[minX, minY, maxX, maxY]) => [x, minY, x1, maxY]
mask框选区域的蒙版样式mask详见 mask
maskHandle框选区域的手柄样式maskHandle详见 maskHandle

mask

配置框选区域的蒙版的样式。

属性描述类型默认值必选
maskFill蒙版的填充色string#777
maskFillOpacity蒙版的填充透明度number0.3
maskStroke蒙版的描边string#fff
maskStrokeOpacity描边透明度number
maskLineWidth蒙版描边的宽度number
maskLineDash描边的虚线配置,第一个值为虚线每个分段的长度,第二个值为分段间隔的距离。lineDash 设为[0,0]的效果为没有描边。[number,number]
maskOpacity蒙版的整体透明度number
maskShadowColor蒙版阴影颜色string
maskShadowBlur蒙版阴影的高斯模糊系数number
maskShadowOffsetX设置阴影距蒙版的水平距离number
maskShadowOffsetY设置阴影距蒙版的垂直距离number
maskCursor鼠标样式。同 css 的鼠标样式stringdefault

在配置框选区域的蒙版样式的时候,不是以对象的形式来配置,而是以 mask前缀加属性的方式来配置。

({
interaction: {
brushXHighlight: {
maskFill: '#000',
maskFillOpacity: 0.2,
maskStroke: 'red',
maskStrokeOpacity: 0.9,
maskLineWidth: 2,
maskLineDash: [4, 8],
maskOpacity: 0.2,
maskShadowColor: '#d3d3d3',
maskShadowBlur: 10,
maskShadowOffsetX: 10,
maskShadowOffsetY: 10,
maskCursor: 'pointer',
},
},
});

maskHandle

八个方向的 handle 的名字分别如下(按照东南西北命名),按照 mask[handleName][styleAttribute] 格式设置对应的属性,也可以通过 maskHandleSize 设置宽度。

custom-style
属性描述类型默认值必选
mask[handleName]Render自定义蒙版手柄的渲染函数(g, options, document) => DisplayObject
mask[handleName]Size蒙版手柄的宽度string
mask[handleName]Fill蒙版手柄的填充色string
mask[handleName]FillOpacity蒙版手柄的填充透明度number
mask[handleName]Stroke蒙版手柄的描边string
mask[handleName]StrokeOpacity描边透明度number
mask[handleName]LineWidth蒙版手柄描边的宽度number
mask[handleName]LineDash描边的虚线配置,第一个值为虚线每个分段的长度,第二个值为分段间隔的距离。lineDash 设为[0,0]的效果为没有描边。[number,number]
mask[handleName]Opacity蒙版手柄的整体透明度number
mask[handleName]ShadowColor蒙版手柄阴影颜色string
mask[handleName]ShadowBlur蒙版手柄阴影的高斯模糊系数number
mask[handleName]ShadowOffsetX设置阴影距蒙版手柄的水平距离number
mask[handleName]ShadowOffsetY设置阴影距蒙版手柄的垂直距离number
mask[handleName]Cursor鼠标样式。同 css 的鼠标样式stringdefault

事件

监听事件

支持以下的事件:

  • brush:start - 开始创建 brush 的时候触发
  • brush:end - brush 更新大小和位置完成时候触发
  • brush:remove - brush 移除的时候触发
  • brush:highlight - brush 改变大小和位置时触发
chart.on('brush:highlight', (e) => {
console.log(e.data.selection);
console.log(e.nativeEvent);
});

触发交互

支持以下的事件:

  • brush:highlight - 高亮数据
  • brush:remove - 移除 brush
chart.emit('brush:remove');
chart.emit('brush:highlight', { data: { selection } });

示例

多视图图表联动

(() => {
const container = document.createElement('div');
const focusContainer = document.createElement('div');
const contextContainer = document.createElement('div');
container.append(focusContainer);
container.append(contextContainer);
function createPathRender(compute) {
return (group, options, document) => {
if (!group.handle) {
const path = document.createElement('path');
group.handle = path;
group.appendChild(group.handle);
}
const { handle } = group;
const { x, y, width, height, ...rest } = options;
if (width === undefined || height === undefined) return handle;
handle.attr({ ...compute(x, y, width, height), ...rest });
return handle;
};
}
// 渲染 focus 视图
const focus = new G2.Chart({
container: focusContainer,
height: 360,
paddingLeft: 50,
});
focus
.area()
.data({
value:
'https://gw.alipayobjects.com/os/bmw-prod/551d80c6-a6be-4f3c-a82a-abd739e12977.csv',
})
.encode('x', 'date')
.encode('y', 'close')
.animate(false)
.axis('x', { grid: false, title: false, tickCount: 5 })
.axis('y', { grid: false, tickCount: 5 })
.interaction('tooltip', false)
.interaction('brushXFilter', true);
focus.render();
// 渲染 context 视图
const context = new G2.Chart({
container: contextContainer,
paddingLeft: 50,
paddingTop: 0,
paddingBottom: 0,
height: 60,
});
context
.area()
.data({
value:
'https://gw.alipayobjects.com/os/bmw-prod/551d80c6-a6be-4f3c-a82a-abd739e12977.csv',
})
.encode('x', 'date')
.encode('y', 'close')
.animate(false)
.axis(false)
.interaction('tooltip', false)
.interaction('brushXHighlight', {
series: true,
maskOpacity: 0.3,
maskFill: '#777',
maskHandleWRender: createPathRender((x, y, width, height) => ({
d: 'M-0.5,31.5c-2.5,0,-4.5,2,-4.5,4.5v30c0,2.5,2,4.5,4.5,4.5V31.5z',
transform: `translate(${x + width / 2}, ${y - height / 2})`,
})),
maskHandleERender: createPathRender((x, y, width, height) => ({
d: 'M0.5,31.5c2.5,0,4.5,2,4.5,4.5v30c0,2.5,-2,4.5,-4.5,4.5V31.5z',
transform: `translate(${x + width / 2}, ${y - height / 2})`,
})),
maskHandleEFill: '#D3D8E0',
maskHandleWFill: '#D3D8E0',
});
context.render();
// 添加事件监听器在不同图表之间交流
focus.on('brush:filter', (e) => {
const { nativeEvent } = e;
if (!nativeEvent) return;
const { selection } = e.data;
const { x: scaleX } = focus.getScale();
const [[x1, x2]] = selection;
const domainX = scaleX.getOptions().domain;
if (x1 === domainX[0] && x2 === domainX[1]) {
context.emit('brush:remove', {});
} else {
context.emit('brush:highlight', { data: { selection } });
}
});
context.on('brush:highlight', (e) => {
const { nativeEvent, data } = e;
if (!nativeEvent) return;
const { selection } = data;
focus.emit('brush:filter', { data: { selection } });
});
context.on('brush:remove', (e) => {
const { nativeEvent } = e;
if (!nativeEvent) return;
const { x: scaleX, y: scaleY } = context.getScale();
const selection = [scaleX.getOptions().domain, scaleY.getOptions().domain];
focus.emit('brush:filter', { data: { selection } });
});
return container;
})();