AntV Skills
v1.0.0Generate G2 v5 chart code. Use when user asks for G2 charts, bar charts, line charts, pie charts, scatter plots, area charts, or any data visualization with...
Like a lobster shell, security has layers — review code before you run it.
G2 v5 Chart Code Generator
You are an expert in AntV G2 v5 charting library. Generate accurate, runnable code following G2 v5 best practices.
Core Constraints (MUST follow)
containeris mandatory:new Chart({ container: 'container', ... })- Use Spec Mode ONLY:
chart.options({ type: 'interval', data, encode: {...} }) chart.options()只能调用一次:多次调用会完整覆盖前一次配置,只有最后一次生效。多 mark 叠加必须用type: 'view'+children数组,而不是多次调用chart.options()encodeobject: Replace v4's.position('x*y')withencode: { x, y }transformmust be array:transform: [{ type: 'stackY' }]labelsis plural: Uselabels: [{ text: 'field' }]notlabel: {}coordinate规则:- 坐标系类型直接写:
coordinate: { type: 'theta' }、coordinate: { type: 'polar' } - transpose 是变换不是坐标系类型,必须写在
transform数组里:coordinate: { transform: [{ type: 'transpose' }] } - ❌ 禁止:
coordinate: { type: 'transpose' }
- 坐标系类型直接写:
- 范围编码(甘特图、candlestick 等):
encode: { y: 'start', y1: 'end' },禁止y: ['start', 'end'] - 样式原则:用户描述中提到的样式(radius、fillOpacity、color、fontSize 等)必须完整保留;用户未提及的装饰性样式(
shadowBlur、shadowColor、shadowOffsetX/Y等)不要自行添加 animate规则:用户未明确要求动画时不要添加animate配置(G2 自带默认动画),只有用户明确描述动画需求时才添加scale.color.palette只能用合法值:palette 通过 d3-scale-chromatic 查找,非法名称会抛Unknown palette错误。不要推断或创造不存在的名称(如'blueOrange'、'redGreen'、'hot'、'jet'、'coolwarm'等均非法)。合法的常用值:顺序色阶'blues'|'greens'|'reds'|'ylOrRd'|'viridis'|'plasma'|'turbo';发散色阶'rdBu'|'rdYlGn'|'spectral';不确定时用range: ['#startColor', '#endColor']自定义替代- 禁止在用户代码中使用
d3.*:G2 内部使用 d3,但d3对象不会暴露到用户代码作用域,调用d3.sum()等会抛ReferenceError: d3 is not defined。如需聚合,优先使用 G2 内置选项(如sortX的reducer: 'sum'),不得不自定义时用原生 JS:d3.sum(arr, d=>d.v)→arr.reduce((s,d)=>s+d.v,0);d3.max(arr, d=>d.v)→Math.max(...arr.map(d=>d.v)) - 用户未指定配色时,禁止使用白色或近白色作为图形填充色:
style: { fill: '#fff' }、style: { fill: 'white' }、style: { fill: '#ffffff' }等在白色背景下会让图形完全不可见。未指定配色时应依赖 G2 的encode.color自动分配主题色,或使用有明确视觉区分度的颜色(如'#5B8FF9')。以下是合法例外:label 文字fill: '#fff'(深色背景内标签)、分隔线stroke: '#fff'(堆叠/pack/treemap 的分隔白线)
⛔ Forbidden Patterns (禁止使用的写法)
禁止使用 V4 语法,必须使用 V5 Spec 模式:
// ❌ 禁止:V4 createView
const view = chart.createView();
view.options({...});
// ❌ 禁止:V4 链式 API 调用
chart.interval()
.data([...])
.encode('x', 'genre')
.encode('y', 'sold')
.style({ radius: 4 });
// ❌ 禁止:V4 链式 encode
chart.line().encode('x', 'date').encode('y', 'value');
// ❌ 禁止:V4 source
chart.source(data);
// ❌ 禁止:V4 position
chart.interval().position('genre*sold');
// ✅ 正确:V5 Spec 模式
chart.options({
type: 'interval',
data: [...],
encode: { x: 'genre', y: 'sold' },
style: { radius: 4 },
});
原因:V5 使用 Spec 模式,结构清晰,易于序列化、动态生成和调试。
createView 的正确 V5 替代方案
chart.createView() 在 V4 中用于"多视图共享容器但数据各异",V5 中对应两种场景:
场景 A:同一坐标系内叠加多个 mark(最常见)
→ 用 type: 'view' + children 数组:
// ✅ 多 mark 叠加(折线 + 散点)
chart.options({
type: 'view',
data,
children: [
{ type: 'line', encode: { x: 'date', y: 'value' } },
{ type: 'point', encode: { x: 'date', y: 'value' } },
],
});
场景 B:多个独立坐标系并排/叠加(如人口金字塔、butterfly 图)
→ 用 type: 'spaceLayer' + children(各子 view 有独立数据和坐标系):
// ✅ 人口金字塔:左右两侧独立视图叠加,共享 Y 轴
chart.options({
type: 'spaceLayer',
children: [
{
type: 'interval',
data: leftData, // 左侧数据(负值或翻转)
coordinate: { transform: [{ type: 'transpose' }, { type: 'reflectX' }] },
encode: { x: 'age', y: 'male' },
axis: { y: { position: 'right' } },
},
{
type: 'interval',
data: rightData, // 右侧数据
coordinate: { transform: [{ type: 'transpose' }] },
encode: { x: 'age', y: 'female' },
axis: { y: false },
},
],
});
// ✅ 更简单方案:单一视图 + 负值技巧(数据可在一个数组里)
chart.options({
type: 'interval',
data: combinedData, // 合并数据,用负值区分方向
coordinate: { transform: [{ type: 'transpose' }] },
encode: {
x: 'age',
y: (d) => d.sex === 'male' ? -d.population : d.population,
color: 'sex',
},
axis: {
y: { labelFormatter: (d) => Math.abs(d) }, // 显示绝对值
},
});
选择原则:
- 两侧数据结构相同、只是方向相反 → 优先用负值技巧(单
interval,代码最简洁) - 两侧需要完全独立的坐标系/比例尺 → 用
spaceLayer
❌ 禁止使用的幻觉 Mark 类型(G2 中不存在)
以下类型来自其他图表库(如 ECharts、Vega),G2 中不存在,使用将导致运行时报错:
| ❌ 错误写法 | ✅ 正确替换 |
|---|---|
type: 'ruleX' | type: 'lineX'(垂直参考线) |
type: 'ruleY' | type: 'lineY'(水平参考线) |
type: 'regionX' | type: 'rangeX'(X 轴区间高亮) |
type: 'regionY' | type: 'rangeY'(Y 轴区间高亮) |
type: 'venn' | type: 'path' + data.transform: [{ type: 'venn' }] |
G2 合法 mark 类型完整列表(不得凭空创造其他 type):
- 基础:
interval、line、area、point、rect、cell、text、image、path、polygon、shape - 连接:
link、connector、vector - 参考线/区域:
lineX、lineY、rangeX、rangeY;range(极少用,仅在 x/y 均需限定二维矩形时使用,且数据的 x/y 字段必须是[start,end]数组) - 统计:
box、boxplot、density、heatmap、beeswarm - 层次/关系:
treemap、pack、partition、tree、sankey、chord、forceGraph - 特殊:
wordCloud、gauge、liquid - 需引入扩展包:
sunburst(需@antv/g2-extension-plot,见 旭日图)
Basic Structure
import { Chart } from '@antv/g2';
const chart = new Chart({ container: 'container', width: 640, height: 480 });
chart.options({
type: 'interval', // Mark type
data: [...], // Data array
encode: { x: 'field', y: 'field', color: 'field' },
transform: [], // Data transforms
scale: {}, // Scale config
coordinate: {}, // Coordinate system
style: {}, // Style config
labels: [], // Data labels
tooltip: {}, // Tooltip config
axis: {}, // Axis config
legend: {}, // Legend config
});
chart.render();
Core (核心概念)
核心概念是 G2 的基础,理解这些概念是正确使用 G2 的前提。
Chart 初始化
Chart 是 G2 的核心类,所有图表都从 Chart 实例开始。
import { Chart } from '@antv/g2';
const chart = new Chart({
container: 'container', // 必填:DOM 容器 ID 或元素
width: 640, // 可选:宽度
height: 480, // 可选:高度
autoFit: true, // 可选:自适应容器大小
padding: 'auto', // 可选:内边距
theme: 'light', // 可选:主题
});
详细文档: Chart 初始化
encode 通道系统
encode 将数据字段映射到视觉通道,是 G2 的核心概念。
| 通道 | 用途 | 示例 |
|---|---|---|
x | X 轴位置 | encode: { x: 'month' } |
y | Y 轴位置 | encode: { y: 'value' } |
color | 颜色 | encode: { color: 'category' } |
size | 大小 | encode: { size: 'population' } |
shape | 形状 | encode: { shape: 'type' } |
详细文档: encode 通道系统
视图组合 (view + children)
使用 view 类型配合 children 数组组合多个 mark。
chart.options({
type: 'view',
data,
children: [
{ type: 'line', encode: { x: 'date', y: 'value' } },
{ type: 'point', encode: { x: 'date', y: 'value' } },
],
});
详细文档: 视图组合
Concepts (概念指南)
概念指南帮助选择正确的图表类型和配置方案。
图表类型选择
根据数据特征和可视化目标选择合适的图表类型:
| 数据关系 | 推荐图表 | Mark |
|---|---|---|
| 比较 | 柱状图、条形图 | interval |
| 趋势 | 折线图、面积图 | line、area |
| 占比 | 饼图、环形图 | interval + theta |
| 分布 | 直方图、箱线图 | rect、boxplot |
| 相关 | 散点图、气泡图 | point |
| 层级 | 矩形树图、旭日图 | treemap、sunburst(需扩展包) |
详细文档: 图表类型选择指南
视觉通道
视觉通道是数据到视觉属性的映射方式:
| 通道类型 | 适合数据 | 感知精度 |
|---|---|---|
| 位置 | 连续/离散 | 最高 |
| 长度 | 连续 | 高 |
| 颜色(色相) | 离散 | 中 |
| 颜色(亮度) | 连续 | 中 |
| 大小 | 连续 | 中低 |
| 形状 | 离散 | 低 |
详细文档: 视觉通道
配色理论
选择合适的配色方案提升图表可读性:
| 场景 | 推荐方案 | 示例 |
|---|---|---|
| 分类数据 | 离散色板 | category10、category20 |
| 连续数据 | 顺序色板 | Blues、RdYlBu |
| 正负对比 | 发散色板 | RdYlGn |
详细文档: 配色理论
Marks (图表类型)
Marks 是 G2 的核心可视化元素,决定了数据的视觉表现形式。每种 Mark 适合特定的数据类型和可视化场景。
柱状图系列 (Interval)
柱状图用于比较分类数据的大小,是最常用的图表类型。基础柱状图使用 interval mark,堆叠柱状图需要添加 stackY transform,分组柱状图使用 dodgeX transform。
| 类型 | Mark | 关键配置 |
|---|---|---|
| 基础柱状图 | interval | - |
| 堆叠柱状图 | interval | transform: [{ type: 'stackY' }] |
| 分组柱状图 | interval | transform: [{ type: 'dodgeX' }] |
| 百分比柱状图 | interval | transform: [{ type: 'normalizeY' }] |
| 水平柱状图 | interval | coordinate: { transform: [{ type: 'transpose' }] } |
折线图系列 (Line)
折线图用于展示数据随时间或有序类别的变化趋势。支持单线、多线对比,以及不同插值方式。
| 类型 | Mark | 关键配置 |
|---|---|---|
| 基础折线图 | line | - |
| 多系列折线 | line | encode: { color: 'category' } |
| 平滑曲线 | line | style: { curve: 'smooth' } |
| 阶梯线 | line | style: { curve: 'step' } |
详细文档: 基础折线图 | 多系列折线 | LineX/LineY
面积图系列 (Area)
面积图在折线图基础上填充区域,强调数量随时间的变化程度。堆叠面积图用于展示各部分对整体的贡献。
| 类型 | Mark | 关键配置 |
|---|---|---|
| 基础面积图 | area | - |
| 堆叠面积图 | area | transform: [{ type: 'stackY' }] |
饼图/环形图 (Arc)
饼图用于展示各部分占整体的比例关系。使用 theta 坐标系配合 interval mark 实现。
| 类型 | Mark | 关键配置 |
|---|---|---|
| 饼图 | interval | coordinate: { type: 'theta' } + stackY |
| 环形图 | interval | coordinate: { type: 'theta', innerRadius: 0.6 } |
散点图/气泡图 (Point)
散点图用于展示两个数值变量的关系,气泡图通过点的大小展示第三个维度。
| 类型 | Mark | 关键配置 |
|---|---|---|
| 散点图 | point | encode: { x, y } |
| 气泡图 | point | encode: { x, y, size } |
直方图 (Histogram)
直方图用于展示连续数值数据的分布情况,使用 rect 标记配合 binX 转换实现。与柱状图不同,直方图的柱子之间无间隔,表示数据连续。
| 类型 | Mark | 关键配置 |
|---|---|---|
| 基础直方图 | rect | transform: [{ type: 'binX', y: 'count' }] |
| 多分布对比 | rect | groupBy 分组 |
详细文档: 直方图
玫瑰图/玉珏图 (Polar Charts)
极坐标系下的图表,通过半径或弧长表示数值大小,视觉上更加美观。
| 类型 | Mark | 关键配置 |
|---|---|---|
| 玫瑰图 | interval | coordinate: { type: 'polar' } |
| 玉珏图 | interval | coordinate: { type: 'radial' } |
统计分布图 (Distribution)
展示数据分布特征的图表,适用于统计分析和探索性数据分析。
| 类型 | Mark | 用途 |
|---|---|---|
| 箱线图 | boxplot | 数据分布统计 |
| 箱型图(Box) | box | 手动指定五数概括的箱线图 |
| 密度图 | density | 核密度估计曲线 |
| 小提琴图 | density + boxplot | 密度分布 + 统计信息 |
| 多边形 | polygon | 自定义多边形区域 |
关系图 (Relation)
展示数据之间关系的图表,适用于网络分析和集合关系展示。
| 类型 | Mark | 用途 |
|---|---|---|
| 桑基图 | sankey | 流向/转移关系 |
| 和弦图 | chord | 矩阵流向关系 |
| 韦恩图 | path + venn数据变换 | 集合交集关系(venn 是 data transform,不是 mark type) |
| 弧长连接图 | line + point | 节点链接关系 |
项目管理图 (Project)
适用于项目管理和进度跟踪的图表。
| 类型 | Mark | 用途 |
|---|---|---|
| 甘特图 | interval | 任务时间安排 |
| 子弹图 | interval + point | KPI 指标展示 |
金融图表 (Finance)
适用于金融数据分析的专业图表。
| 类型 | Mark | 用途 |
|---|---|---|
| K线图 | link + interval | 股票四价数据 |
详细文档: K线图
多维数据图 (Multivariate)
展示多维数据关系的图表。
| 类型 | Mark | 用途 |
|---|---|---|
| 平行坐标系 | line | 多维数据关系分析 |
| 雷达图 | line | 多维数据对比 |
对比图 (Comparison)
适用于数据对比的图表。
| 类型 | Mark | 用途 |
|---|---|---|
| 双向柱状图 | interval | 正负数据对比 |
详细文档: 双向柱状图
基础标记 (Basic Marks)
基础标记是 G2 的底层构建块,可独立使用或组合构建复杂图表。
| 类型 | Mark | 用途 |
|---|---|---|
| 矩形 | rect | 矩形区域,直方图/热力图基础 |
| 文本 | text | 文本标注和标签 |
| 图片 | image | 图片标记,数据点用图片表示 |
| 路径 | path | 自定义路径绘制 |
| 链接 | link | 两点之间的连线 |
| 连接器 | connector | 数据点之间的连接线 |
| 形状 | shape | 自定义形状绘制 |
| 向量 | vector | 向量/箭头标记,风场图等 |
详细文档: rect | text | image | path | link | connector | shape | vector
范围标记 (Range)
范围标记用于展示数据的区间范围。
| 类型 | Mark | 用途 |
|---|---|---|
| 时间段/区间高亮(X 方向) | rangeX | X 轴区间,encode: { x: 'start', x1: 'end' } |
| 数值范围高亮(Y 方向) | rangeY | Y 轴区间,encode: { y: 'min', y1: 'max' } |
| 二维矩形区域 | range | x/y 字段为 [start,end] 数组,encode: { x:'x', y:'y' },极少使用 |
详细文档: range/rangeY | rangeX
分布与打包图 (Distribution & Pack)
| 类型 | Mark | 用途 |
|---|---|---|
| 蜂群图 | point + pack | 数据点紧密排列展示分布 |
| 打包图 | pack | 层级数据的圆形打包 |
层次结构图 (Hierarchy)
展示层级数据的图表,通过面积或半径表示数值占比。
| 类型 | Mark | 用途 |
|---|---|---|
| 矩形树图 | treemap | 层级数据占比 |
| 旭日图 | sunburst⚠️ | 多层级同心圆展示(需引入 @antv/g2-extension-plot) |
| 分区图 | partition | 层级数据分区展示 |
| 树图 | tree | 树形层级结构 |
其他图表
| 类型 | Mark | 用途 |
|---|---|---|
| 热力图 | cell | 二维矩阵数据可视化 |
| 密度热力图 | heatmap | 连续密度热力图 |
| 仪表盘 | gauge | 指标进度展示 |
| 词云 | wordCloud | 文本频率可视化 |
| 水波图 | liquid | 百分比进度 |
Data (数据变换)
数据变换在数据加载阶段执行,配置在 data.transform 中,影响所有使用该数据的标记。
⚠️ 关键区别:Data Transform vs Mark Transform
这是 LLM 最容易混淆的地方!
| 特性 | Data Transform | Mark Transform |
|---|---|---|
| 配置位置 | data.transform | transform(与 data、encode 同级) |
| 执行时机 | 数据加载阶段,绑定到标记之前 | 标记渲染过程中 |
| 作用范围 | 影响所有使用该数据的标记 | 仅影响当前标记 |
| 典型操作 | 数据结构转换、过滤、排序 | 视觉变换、聚合、防重叠 |
chart.options({
type: 'interval',
{
type: 'inline',
value: data,
transform: [ // ✅ Data Transform:数据预处理
{ type: 'fold', fields: ['a', 'b'] }, // 宽表转长表
{ type: 'filter', callback: (d) => d.value > 100 },
{ type: 'sort', callback: (a, b) => b.value - a.value },
],
},
transform: [ // ✅ Mark Transform:视觉变换
{ type: 'stackY' }, // 堆叠
{ type: 'dodgeX' }, // 分组
],
});
Data Transform 类型(配置在 data.transform)
| 变换 | 类型 | 用途 | 示例场景 |
|---|---|---|---|
| fold | fold | 宽表转长表 | 多列数据转多系列 |
| filter | filter | 条件过滤数据 | 过滤无效数据 |
| sort | sort | 使用回调函数排序 | 自定义排序逻辑 |
| sortBy | sortBy | 按字段排序 | 按字段值排序 |
| map | map | 数据映射转换 | 添加计算字段 |
| join | join | 合并数据表 | 关联外部数据 |
| pick | pick | 选择指定字段 | 精简字段 |
| rename | rename | 重命名字段 | 字段重命名 |
| slice | slice | 截取数据范围 | 分页/截取 |
| ema | ema | 指数移动平均 | 时间序列平滑 |
| kde | kde | 核密度估计 | 密度图/小提琴图 |
| log | log | 打印数据到控制台 | 调试 |
| custom | custom | 自定义数据处理 | 复杂转换 |
数据格式与模式
| 类型 | 用途 |
|---|---|
| 表格数据格式 | G2 接受的标准表格数据格式说明 |
| 数据变换模式 | Data Transform 和 Mark Transform 的组合使用模式 |
详细文档: filter | sort | sortBy | fold | slice | ema | kde | log | fetch | 表格数据格式 | 数据变换模式
常见错误:Data Transform 放错位置
// ❌ 错误:fold 是数据变换,不能放在 mark transform
chart.options({
type: 'interval',
wideData,
transform: [{ type: 'fold', fields: ['a', 'b'] }], // ❌ 错误!
});
// ✅ 正确:fold 放在 data.transform
chart.options({
type: 'interval',
{
type: 'inline',
value: wideData,
transform: [{ type: 'fold', fields: ['a', 'b'] }], // ✅ 正确
},
transform: [{ type: 'stackY' }], // mark transform
});
组合示例:宽表数据 + 堆叠图
// 宽表数据:每个月有多个类型的数据列
const wideData = [
{ year: '2000', '类型 A': 21, '类型 B': 16, '类型 C': 8 },
{ year: '2001', '类型 A': 25, '类型 B': 16, '类型 C': 8 },
// ...
];
chart.options({
type: 'interval',
{
type: 'inline',
value: wideData,
transform: [
// ✅ Data Transform:宽表转长表
{ type: 'fold', fields: ['类型 A', '类型 B', '类型 C'], key: 'type', value: 'value' },
],
},
encode: { x: 'year', y: 'value', color: 'type' },
transform: [
// ✅ Mark Transform:堆叠
{ type: 'stackY' },
],
coordinate: { type: 'polar' }, // 极坐标系
});
Transforms (标记变换)
标记变换在绑定视觉通道时执行,配置在 mark 的 transform 数组中,用于数据聚合、防重叠等。
配置位置:transform 数组,与 data、encode 同级,不是在 data.transform 中。
chart.options({
type: 'interval',
data,
encode: { x: 'category', y: 'value', color: 'type' },
transform: [ // ✅ Mark Transform:与 data/encode 同级
{ type: 'stackY' },
{ type: 'sortX', by: 'y' },
],
});
防重叠变换
| 变换 | 类型 | 用途 |
|---|---|---|
| 堆叠 | stackY | 数据堆叠,用于堆叠图 |
| 分组 | dodgeX | 数据分组,用于分组图 |
| 抖动 | jitter | 散点抖动避免重叠 |
| X轴抖动 | jitterX | X 方向抖动 |
| Y轴抖动 | jitterY | Y 方向抖动 |
| 打包 | pack | 紧密排列数据点 |
聚合变换
| 变换 | 类型 | 用途 |
|---|---|---|
| 通用分组 | group | 通用分组聚合 |
| 分组聚合 | groupX / groupY | 按维度分组并聚合 |
| 分组颜色 | groupColor | 按颜色分组聚合 |
| 分箱 | bin | 二维分箱 |
| X轴分箱 | binX | X 轴方向分箱 |
| 采样 | sample | 数据采样 |
详细文档: group | groupX | groupY | groupColor | bin | binX | sample
排序变换
| 变换 | 类型 | 用途 |
|---|---|---|
| X轴排序 | sortX | 按 X 通道排序 |
| Y轴排序 | sortY | 按 Y 通道排序 |
| 颜色排序 | sortColor | 按颜色通道排序 |
选取变换
| 变换 | 类型 | 用途 |
|---|---|---|
| 选取 | select | 全局选取数据 |
| X轴选取 | selectX | 按 X 分组选取 |
| Y轴选取 | selectY | 按 Y 分组选取 |
其他变换
| 变换 | 类型 | 用途 |
|---|---|---|
| 归一化 | normalizeY | Y 轴归一化 |
| 差值 | diffY | 计算差值 |
| 对称 | symmetryY | Y 轴对称 |
| 弹性X | flexX | X 轴弹性布局 |
| 堆叠入场 | stackEnter | 入场动画堆叠 |
详细文档: normalizeY | diffY | symmetryY | flexX | stackEnter
Interactions (交互)
G5 提供丰富的内置交互,用于数据探索和图表操作。
选择类交互
| 交互 | 类型 | 用途 |
|---|---|---|
| 元素选择 | elementSelect | 点击选择数据元素 |
| 按条件选择 | elementSelectBy | 按条件批量选择元素 |
| 框选 | brush / brushX / brushY | 矩形区域选择 |
| 二维框选 | brushXY | XY 同时框选 |
| 轴框选 | brushAxis | 坐标轴范围选择 |
| 图例过滤 | legendFilter | 点击图例筛选数据 |
详细文档: elementSelect | elementSelectBy | brush | brushXY | brushAxis | legendFilter
高亮类交互
| 交互 | 类型 | 用途 |
|---|---|---|
| 元素高亮 | elementHighlight | 悬停高亮元素 |
| 按条件高亮 | elementHighlightBy | 按条件批量高亮元素 |
| 悬停缩放 | elementHoverScale | 悬停时元素放大 |
| 图例高亮 | legendHighlight | 悬停图例高亮对应元素 |
| 框选高亮 | brushXHighlight / brushYHighlight | 框选区域高亮 |
详细文档: elementHighlight | elementHighlightBy | elementHoverScale | legendHighlight | brushXHighlight | brushYHighlight | 单轴框选高亮
过滤类交互
| 交互 | 类型 | 用途 |
|---|---|---|
| 滑动条过滤 | sliderFilter | 滑动条筛选数据范围 |
| 滚动条过滤 | scrollbarFilter | 滚动条筛选数据 |
| 框选过滤 | brushFilter | 框选区域过滤数据 |
| X轴框选过滤 | brushXFilter | X 轴方向框选过滤 |
| Y轴框选过滤 | brushYFilter | Y 轴方向框选过滤 |
| 自适应过滤 | adaptiveFilter | 自适应数据过滤 |
详细文档: sliderFilter | scrollbarFilter | brushFilter | brushXFilter | brushYFilter | adaptiveFilter
其他交互
| 交互 | 类型 | 用途 |
|---|---|---|
| 提示信息 | tooltip | 悬停显示数据详情 |
| 气泡提示 | poptip | 简洁气泡提示 |
| 下钻 | drilldown | 层级数据下钻 |
| 矩形树图下钻 | treemapDrilldown | 矩形树图层级下钻 |
| 缩放 | fisheye | 鱼眼放大镜效果 |
| 滚轮滑动 | sliderWheel | 鼠标滚轮控制滑动条 |
| 拖拽移动 | elementPointMove | 拖拽数据点移动 |
| 图表索引 | chartIndex | 多图表联动索引线 |
详细文档: tooltip | poptip | drilldown | treemapDrilldown | fisheye | sliderWheel | elementPointMove | chartIndex
Components (组件)
组件是图表的辅助元素,如坐标轴、图例、提示信息等。
坐标轴 (Axis)
坐标轴展示数据维度,支持丰富的样式配置。
图例 (Legend)
图例展示数据分类或连续数值映射,支持分类图例和连续图例(色带)。
| 类型 | 用途 |
|---|---|
| 分类图例 | 离散分类数据的颜色映射说明 |
| 连续图例 | 连续数值的颜色/大小映射说明(色带) |
提示信息 (Tooltip)
Tooltip 在悬停时显示数据详情,支持自定义模板和格式化。
详细文档: Tooltip 配置
其他组件
| 组件 | 用途 |
|---|---|
| 标题 | 图表标题 |
| 标签 | 数据标签 |
| 滚动条 | 数据滚动浏览 |
| 滑动条 | 数据范围选择 |
| 标注 | 数据标注和辅助线 |
Scales (比例尺)
比例尺将数据值映射到视觉通道,如位置、颜色、大小等。
⚠️ 刻度控制:tickMethod vs labelFormatter(高频错误)
自定义刻度时,位置和文字是两个独立配置,职责不同不能混用:
| 配置项 | 位置 | 签名 | 职责 |
|---|---|---|---|
scale.y.tickMethod | scale | (min, max, count, base?) => number[] | 刻度的数值位置 |
axis.y.labelFormatter | axis | (value) => string | 刻度的显示文字 ⭐ |
axis.y.tickFormatter | axis | (datum, index, array, vector) => DisplayObject | 刻度线图形(极少用) |
// ❌ 错误:tickMethod 参数不是 scale 对象,返回值不是对象数组
scale: { y: { tickMethod: (scale) => scale.ticks().map(v => ({ value: v, text: '...' })) } }
// ✅ 正确:职责分离
scale: { y: { type: 'log', tickMethod: (min, max, n, base) => [1, 10, 100, 1000] } },
axis: { y: { labelFormatter: (v) => `${Math.log10(v)}` } }
⚠️ 默认行为(不要过度指定 type)
G2 会根据数据类型自动推断 scale 类型,非特殊情况下不要手动指定 type:
| 数据类型 | 自动推断的 scale | 示例 |
|---|---|---|
| 数值字段 | linear | { value: 100 } → linear |
| 分类字段 | band | { category: 'A' } → band |
| Date 对象 | time | { date: new Date() } → time |
// ❌ 错误:不必要的 type 指定,可能导致渲染异常
chart.options({
scale: {
x: { type: 'linear' }, // ❌ 数值字段默认就是 linear
y: { type: 'linear' }, // ❌ 不需要指定
},
});
// ✅ 正确:让 G2 自动推断,只在需要时配置 domain/range
chart.options({
scale: {
y: { domain: [0, 100] }, // ✅ 只配置需要的属性
color: { range: ['#1890ff', '#52c41a'] },
},
});
需要手动指定 type 的特殊情况:
| 场景 | type | 说明 |
|---|---|---|
| 对数刻度 | log | 跨数量级数据 |
| 幂函数刻度 | pow | 非线性数据映射 |
| 平方根刻度 | sqrt | 非负数据的压缩 |
| 字符串日期 | time | 日期字段是字符串而非 Date 对象时 |
| 自定义映射 | ordinal | 离散值到离散值 |
| 渐变色 | sequential | 连续数值到颜色渐变 |
| 分段映射 | threshold | 按阈值分段映射到颜色 |
| 等量分段 | quantize / quantile | 连续数据离散化 |
比例尺类型
| 比例尺 | 类型 | 用途 |
|---|---|---|
| 线性 | linear | 连续数值映射(默认) |
| 分类 | band | 离散分类映射(默认) |
| 点 | point | 离散点位置映射 |
| 时间 | time | 时间数据映射 |
| 对数 | log | 对数刻度 |
| 幂/平方根 | pow / sqrt | 幂函数/平方根映射 |
| 序数 | ordinal | 离散值到离散值映射 |
| 顺序 | sequential | 连续值到颜色渐变 |
| 分位数/量化 | quantile / quantize | 连续数据离散化映射 |
| 阈值 | threshold | 按阈值分段映射 |
详细文档: linear | band | point | time | log | pow/sqrt | ordinal | sequential | quantile/quantize | threshold
Coordinates (坐标系)
坐标系定义数据到画布位置的映射方式,不同坐标系产生不同图表形态。
| 坐标系 | 类型 | 用途 |
|---|---|---|
| 笛卡尔 | cartesian | 直角坐标系(默认) |
| 极坐标 | polar | 雷达图、玫瑰图 |
| Theta | theta | 饼图、环形图 |
| 径向 | radial | 径向坐标系,玉珏图 |
| 转置 | transpose | X/Y 轴交换 |
| 平行 | parallel | 平行坐标系 |
| 螺旋 | helix | 螺旋坐标系 |
| 鱼眼 | fisheye | 局部放大效果 |
详细文档: cartesian | polar | theta | radial | transpose | parallel | helix | fisheye
Compositions (组合视图)
组合视图用于创建多图表布局,如分面、多视图叠加等。
| 组合 | 类型 | 用途 |
|---|---|---|
| 基础视图 | view | 单视图容器,组合多个 mark |
| 分面图 | facetRect | 按维度拆分矩形网格多图 |
| 圆形分面 | facetCircle | 按维度拆分环形多图 |
| 重复矩阵 | repeatMatrix | 多变量组合矩阵图 |
| 空间层叠 | spaceLayer | 多图层叠加 |
| 空间弹性 | spaceFlex | 弹性布局 |
| 时间关键帧 | timingKeyframe | 动画序列 |
| 地理视图 | geoView | 地理坐标系视图 |
| 地图 | geoPath | 地理路径绘制 |
详细文档: view | facetRect | facetCircle | repeatMatrix | spaceLayer | spaceFlex | timingKeyframe | geoView | 地图
Themes (主题)
主题定义图表的整体视觉风格,包括颜色、字体、间距等。
Palettes (调色板)
调色板定义颜色序列,用于分类数据或连续数据的颜色映射。
详细文档: category10 | category20
Animations (动画)
动画增强图表的表现力,支持入场、更新、退场动画配置。
⚠️ 重要规则:G2 底层自带默认动画效果,用户没有明确要求动画时不要添加 animate 配置。只有用户明确描述了动画需求(如"渐入动画"、"波浪入场"等)时,才查阅参考文档添加对应的 animate 配置。
Label Transforms (标签变换)
标签变换用于处理标签重叠、溢出等问题,提升标签可读性。
| 变换 | 类型 | 用途 |
|---|---|---|
| 溢出隐藏 | overflowHide | 超出区域的标签隐藏 |
| 重叠隐藏 | overlapHide | 重叠标签自动隐藏 |
| 重叠偏移 | overlapDodgeY | 重叠标签 Y 方向偏移 |
| 对比反转 | contrastReverse | 标签颜色自动反转以保证对比度 |
| 溢出调整 | exceedAdjust | 超出画布边界的标签位置调整 |
| 溢出描边 | overflowStroke | 溢出区域添加描边标记 |
详细文档: overflowHide | overlapHide | overlapDodgeY | contrastReverse | exceedAdjust | overflowStroke
Patterns (模式)
模式是常见场景的最佳实践,包含迁移指南、性能优化、响应式适配等。
迁移指南
| 模式 | 用途 |
|---|---|
| v4 → v5 迁移 | G2 v4 代码迁移到 v5 |
详细文档: v4 → v5 迁移
性能优化
数据预聚合、LTTB 降采样、Canvas 渲染器确认、高频实时数据节流更新。
| 场景 | 数据量 | 建议方案 |
|---|---|---|
| 折线图 | < 1,000 点 | 直接渲染 |
| 折线图 | 1,000 ~ 10,000 点 | 降采样到 500 点以内 |
| 折线图 | > 10,000 点 | 后端聚合 + 时间范围过滤 |
| 散点图 | < 5,000 点 | 直接渲染 |
| 散点图 | 5,000 ~ 50,000 点 | Canvas 渲染 + 降采样 |
详细文档: 性能优化
响应式适配
autoFit 自适应、ResizeObserver 动态调整、移动端字体/边距适配。
详细文档: 响应式适配
Recipes (配方)
配方是常见场景的完整解决方案,包含多个配置组合。
API Migration (v4 → v5)
| v4 (Deprecated) | v5 (Correct) |
|---|---|
chart.source(data) | chart.options({ data }) |
.position('x*y') | encode: { x: 'x', y: 'y' } |
.color('field') | encode: { color: 'field' } |
.adjust('stack') | transform: [{ type: 'stackY' }] |
.adjust('dodge') | transform: [{ type: 'dodgeX' }] |
label: {} | labels: [{}] |
Common Mistakes
// ❌ Wrong: v4 syntax
chart.source(data);
chart.interval().position('genre*sold').color('genre');
// ✅ Correct: v5 Spec syntax
chart.options({ type: 'interval', data, encode: { x: 'genre', y: 'sold', color: 'genre' } });
// ❌ Wrong: missing container
const chart = new Chart({ width: 640, height: 480 });
// ✅ Correct: container required
const chart = new Chart({ container: 'container', width: 640, height: 480 });
// ❌ Wrong: transform as object
chart.options({ transform: { type: 'stackY' } });
// ✅ Correct: transform as array
chart.options({ transform: [{ type: 'stackY' }] });
// ❌ Wrong: label (singular)
chart.options({ label: { text: 'value' } });
// ✅ Correct: labels (plural)
chart.options({ labels: [{ text: 'value' }] });
// ❌ Wrong: 多次调用 chart.options() —— 每次调用完整替换前一次,只有最后一次生效
chart.options({ type: 'interval', data, encode: { x: 'x', y: 'y' } }); // ❌ 被覆盖,不渲染
chart.options({ type: 'line', data, encode: { x: 'x', y: 'y' } }); // ❌ 被覆盖,不渲染
chart.options({ type: 'text', data, encode: { x: 'x', y: 'y', text: 'label' } }); // 只有这个生效
// ✅ Correct: 多 mark 叠加必须用 type: 'view' + children
chart.options({
type: 'view',
data, // 共享数据(子 mark 可以覆盖)
children: [
{ type: 'interval', encode: { x: 'x', y: 'y' } },
{ type: 'line', encode: { x: 'x', y: 'y' } },
{ type: 'text', encode: { x: 'x', y: 'y', text: 'label' } },
],
});
// ✅ 子 mark 需要不同数据时,在 children 里单独指定 data
chart.options({
type: 'view',
mainData,
children: [
{ type: 'interval', encode: { x: 'x', y: 'y' } }, // 用父级 mainData
{ type: 'text', labelData, encode: { x: 'x', text: 'label' } }, // 用独立数据
],
});
// ⚠️ 多 mark 组合规则:
// 1. 只能使用 children,禁止使用 marks、layers 等配置
// 2. children 不能嵌套(children 内不能再有 children)
// 3. 复杂组合使用 spaceLayer/spaceFlex
// ❌ Wrong: 使用 marks(禁止)
chart.options({
type: 'view',
data,
marks: [...], // ❌ 禁止!
});
// ❌ Wrong: 使用 layers(禁止)
chart.options({
type: 'view',
data,
layers: [...], // ❌ 禁止!
});
// ✅ Correct: 使用 children
chart.options({
type: 'view',
data,
children: [ // ✅ 正确
{ type: 'line', encode: { x: 'year', y: 'value' } },
{ type: 'point', encode: { x: 'year', y: 'value' } },
],
});
// ❌ Wrong: children 嵌套(禁止)
chart.options({
type: 'view',
children: [
{
type: 'view',
children: [...], // ❌ 禁止!children 不能嵌套
},
],
});
// ✅ Correct: 使用 spaceLayer/spaceFlex 处理复杂组合
chart.options({
type: 'spaceLayer',
children: [
{ type: 'view', children: [...] }, // ✅ spaceLayer 下可以有 view + children
{ type: 'line', ... },
],
});
// ❌ Wrong: unnecessary scale type specification
chart.options({
scale: {
x: { type: 'linear' }, // ❌ 不需要,默认就是 linear
y: { type: 'linear' }, // ❌ 不需要
},
});
// ✅ Correct: let G2 infer scale type automatically
chart.options({
scale: {
y: { domain: [0, 100] }, // ✅ 只配置需要的属性
},
});
Output Format
- 只输出一个完整的 JavaScript 代码块,不需要任何解释文字
- 使用
import { Chart } from '@antv/g2' container必须为'container'- 代码末尾必须有
chart.render(); - 禁止返回 HTML 代码
- 关键配置处可加简短注释,但不要过度注释
Comments
Loading comments...
