数据标签(Label)
概述
G2 中数据标签(Label) 是给图表添加标注的手段之一,对当前的一组数据进行的内容标注。包括数据点、连接线、文本数值等元素,根据不同的图表类型选择使用。通过简洁的文字说明,减少误解,使图表更易解读,并且强调关键数据或趋势,引导关注重要信息。
元素
包括连接线、文本数值元素,根据不同的图表类型选择使用。
其中,饼图、环形图、玫瑰图等可以用连接线元素连接 label 文本元素和 mark 图形
使用/配置方式
mark 标记添加
chart.options({
type: 'interval',
labels: [
{ text: 'genre' }, // 指定绑定的字段
{
text: 'sold', // 指定绑定的字段
fill: '#fff', // 指定样式
},
],
});
在 View 层级
可在 view 配置 labelTransform 声明标签转化
- API 方式
chart.options({
type: 'view',
labelTransform: [{ type: 'overlapHide' }, { type: 'contrastReverse' }],
});
- spec 配置
({
type: 'view',
labelTransform: [{ type: 'overlapHide' }, { type: 'contrastReverse' }],
});
标记标签
每一个标记都可以有多个标签,下面是一个简单的例子:
import { Chart } from '@antv/g2';
const chart = new Chart({
container: 'container',
});
chart.options({
type: 'interval',
height: 300,
data: [
{ genre: 'Sports', sold: 275 },
{ genre: 'Strategy', sold: 115 },
{ genre: 'Action', sold: 120 },
{ genre: 'Shooter', sold: 350 },
{ genre: 'Other', sold: 150 },
],
encode: { x: 'genre', y: 'sold' },
labels: [
{ text: 'genre', style: { dy: -15 } },
{ text: 'sold', style: { fill: '#fff', dy: 5 } },
],
});
chart.render();
配置项
| 属性 | 描述 | 类型 | 默认值 | 必选 |
|---|---|---|---|---|
| dx | 标签文字在水平方向的偏移量,也可通过 style.dx 配置 | number | 0 | |
| dy | 标签文字在垂直方向的偏移量,也可通过 style.dy 配置 | number | 0 | |
| offset | 标签偏移距离,也可通过 style.offset 配置 | number | - | |
| text | 标签数据通道,类似 mark 标记的 x 通道,对应到文本元素上,可以用回调自定义 string 文本. |
string | Function | - | |
| innerHTML | 和 text 配置类似,同时配置 text 会失效,可以用回调自定义 string 文本或 HTMElement 复杂 html |
string | Function | - | |
| formatter | 标签文本格式化 | string | Function<string> | - | |
| render | 和 innerHTML 配置类型一致 |
string | Function | - | |
| selector | 标签选择器,可以保留或隐藏标签。 | selector | {type: 'cartesian' } |
|
| transform | 标签转换,用来优化标签的展示,解决标签重叠、颜色不明显的问题 | transform | - | |
| position | 标签相对图形位置,并非标签方向。 | position | - | |
| style | 标签样式配置 | style | - | |
| background | 是否展示背景颜色 | boolean | 详见background | |
| connector | 是否展示连接线 在 饼图和环形图等非笛卡尔坐标系下使用 | boolean | 详见connector |
text & innerHTML
label 标签文本元素内容配置
import { Chart } from '@antv/g2';
const chart = new Chart({
container: 'container',
});
chart.options({
type: 'interval',
height: 340,
insetTop: 20,
data: [
{ genre: 'Sports', sold: 275 },
{ genre: 'Strategy', sold: 115 },
{ genre: 'Action', sold: 120 },
{ genre: 'Shooter', sold: 350 },
{ genre: 'Other', sold: 150 },
],
encode: { x: 'genre', y: 'sold' },
labels: [
{ text: 'sold', style: { dy: -30 } }, // text 映射 字段 sold
{ text: ({ genre }) => genre, style: { dy: -20 } }, // text 自定义 返回 string 类型
{
innerHTML: 'genre',
dx: 20,
dy: 10,
style: { fill: '#fff', color: '#333', fontSize: 10 },
}, // innerHTML 映射 字段 genre 注: 背景色有时会黑色,需要配置 fill 背景色. color 文本颜色 HTMElement 本身也可以配置样式
{
// innerHTML 自定义 返回 HTMElement 类型数据
innerHTML: ({ genre, sold }) =>
`<div style="padding:0 4px;border-radius: 10px;background: #f5f5f5;border: 2px solid #5ea9e6;font-size: 11px;">${genre}:${sold}</div>`,
dx: 10,
dy: 50,
style: { fill: 'rgba(0,0,0,0)', color: '#333' },
},
],
});
chart.render();
同时,页可以尝试 用 render 配置 HTMLElement, 传参和 innerHTML 有区别,但返回时一致的。
type RenderFunc = (text: string, datum: object, index: number, {channel: Record<string, Channel>}) => String | HTMLElement;
selector
label 标签选择器
对于一个图形对应多个数据项的标记来说,我们可以通过 selector 去选择需要保留的标记。目前支持的值如下:
first- 第一个last- 最后一个function- 自定义选择器
import { Chart } from '@antv/g2';
const chart = new Chart({
container: 'container',
});
chart.options({
type: 'line',
autoFit: true,
height: 300,
insetLeft: 40,
insetRight: 40,
data: {
type: 'fetch',
value: 'https://assets.antv.antgroup.com/g2/indices.json',
},
encode: { x: (d) => new Date(d.Date), y: 'Close', color: 'Symbol' },
scale: { y: { type: 'log' } },
axis: { y: { title: '↑ Change in price (%)' } },
labels: [
{
text: ({ Symbol }) => `first ${Symbol}`,
selector: 'first', // 在 mark 图形中第一个
fontSize: 13,
style: { fill: 'blue', fontWeight: 600, dx: -50 },
},
{
text: ({ Symbol }) => `last ${Symbol}`,
selector: 'last', // 在 mark 图形中最后一个
fontSize: 13,
style: { fill: 'red', fontWeight: 600 },
},
{
text: ({ Symbol }) => `custom ${Symbol}`,
selector: (v) => {
// 自定义筛选, 返回所有 label 标签数组,内含坐标等信息。需要返回这些信息,可以进行过滤处理。
return v.filter(({ bounds }) => {
const bound = bounds[0];
return (
// 筛选在图表中坐标在 x:[200,200.5] y:[200,350] 的 label 标签
bound[0] > 200 &&
bound[0] < 200.5 &&
bound[1] > 200 &&
bound[1] < 350
);
});
},
fontSize: 13,
style: { fill: '#ac1ce6', fontWeight: 600 },
},
],
});
chart.render();
transform
label 标签转换
当标签的展示不符合预期的时候,比如重叠、颜色不明显,我们可以使用标签转换(Label Transform) 来优化标签的展示。并且,可以直接配置到视图层级 view,对整个视图的标签做处理。
当前支持的标签转化如下:
| type | 描述 |
|---|---|
| overlapDodgeY | 对位置碰撞的标签在 y 方向上进行调整,防止标签重叠 |
| contrastReverse | 标签颜色在图形背景上对比度低的情况下,从指定色板选择一个对比度最优的颜色 |
| overflowStroke | 标签在溢出情况下,从指定色板选择一个对比度最优的颜色进行描边 |
| overflowHide | 对于标签在图形上放置不下的时候,隐藏标签 |
| overlapHide | 对位置碰撞的标签进行隐藏,默认保留前一个,隐藏后一个 |
| exceedAdjust | 会自动对标签做溢出检测和矫正,即当标签超出指定区域时,会对标签自动做反方向的位移 |
不同的转化类型,针对不同的标签问题情况。所以明确每个 transform 标签转化的区别十分有必要。
overlapDodgeY
针对标签拥挤重叠导致的混乱情况,会对重叠的标签在 y 方向做调整。
问题案例
import { Chart } from '@antv/g2';
const chart = new Chart({
container: 'container',
});
chart.options({
type: 'line',
autoFit: true,
height: 300,
insetLeft: 40,
insetRight: 40,
data: {
type: 'fetch',
value:
'https://gw.alipayobjects.com/os/bmw-prod/cb99c4ab-e0a3-4c76-9586-fe7fa2ff1a8c.csv',
},
encode: {
x: (d) => new Date(d.date).getFullYear(),
y: 'price',
color: 'symbol',
},
transform: [{ type: 'groupX', y: 'mean' }],
labels: [{ text: 'price' }],
});
chart.render();
配置 overlapDodgeY 转化标签
import { Chart } from '@antv/g2';
const chart = new Chart({
container: 'container',
});
chart.options({
type: 'line',
autoFit: true,
height: 300,
insetLeft: 40,
insetRight: 40,
data: {
type: 'fetch',
value:
'https://gw.alipayobjects.com/os/bmw-prod/cb99c4ab-e0a3-4c76-9586-fe7fa2ff1a8c.csv',
},
encode: {
x: (d) => new Date(d.date).getFullYear(),
y: 'price',
color: 'symbol',
},
transform: [{ type: 'groupX', y: 'mean' }],
labels: [{ text: 'price', transform: [{ type: 'overlapDodgeY' }] }],
});
chart.render();
| 属性 | 描述 | 类型 | 默认值 | 必选 |
|---|---|---|---|---|
| maxIterations | 位置调整的最大迭代次数。 | number | 10 |
|
| padding | 期望调整之后,标签和标签之间的间距 | number | 1 |
|
| maxError | 最大误差,指实际间距和期望间距 padding 之间的误差 | number | 0.1 |
contrastReverse
contrastReverse 标签颜色在图形背景上颜色对比度低的情况下,从指定色板选择一个对比度最优的颜色。针对图形颜色和 label 标签颜色相近而显示不明显的问题,多数出现在多颜色的柱状图(mark inteval)颜色多变不能用或手动更改 label 颜色困难的时候。
问题案例
当部分图形颜色和标签颜色接近时,会出现看不清的问题。
import { Chart } from '@antv/g2';
const chart = new Chart({
container: 'container',
});
chart.options({
type: 'interval',
height: 300,
data: [
{ genre: 'Sports', sold: 40 },
{ genre: 'Strategy', sold: 115 },
{ genre: 'Action', sold: 120 },
{ genre: 'Shooter', sold: 350 },
{ genre: 'Other', sold: 150 },
],
encode: { x: 'genre', y: 'sold', color: 'genre' },
scale: {
color: { range: ['#ff0000', '#f0d2fc', '#2b00ff', '#ff8000', '#064501'] },
},
labels: [{ text: 'genre' }],
});
chart.render();
配置 contrastReverse 转化标签
对不明显的 label 标签 颜色进行优化
import { Chart } from '@antv/g2';
const chart = new Chart({
container: 'container',
});
chart.options({
type: 'interval',
height: 300,
data: [
{ genre: 'Sports', sold: 40 },
{ genre: 'Strategy', sold: 115 },
{ genre: 'Action', sold: 120 },
{ genre: 'Shooter', sold: 350 },
{ genre: 'Other', sold: 150 },
],
encode: { x: 'genre', y: 'sold', color: 'genre' },
scale: {
color: { range: ['#ff0000', '#f0d2fc', '#2b00ff', '#ff8000', '#064501'] },
},
labels: [{ text: 'genre', transform: [{ type: 'contrastReverse' }] }],
});
chart.render();
| 属性 | 描述 | 类型 | 默认值 | 必选 |
|---|---|---|---|---|
| threshold | 标签和背景图形的颜色对比度阈值,超过阈值才会推荐颜色提升对比度 | Type |
4.5 |
|
| palette | 对比度提升算法中,备选的颜色色板 | Type |
['#000', '#fff'] |
overflowStroke
overflowStroke 从指定色板选择一个与标签颜色相比,对比度最优的颜色进行描边。类似字幕黑底白字原理,针对 label 溢出元素后可读性变差问题。
问题案例
下面示例中 label 颜色与背景柱形区分明显,但溢出部分可读性又非常差。
import { Chart } from '@antv/g2';
const chart = new Chart({
container: 'container',
});
chart.options({
width: 200,
type: 'interval',
scale: {
color: { range: ['#222'] },
},
autoFit: true,
data: [
{ letter: 'A', frequency: 8167 },
{ letter: 'B', frequency: 1492 },
{ letter: 'C', frequency: 2782 },
{ letter: 'D', frequency: 4253 },
{ letter: 'E', frequency: 2702 },
{ letter: 'H', frequency: 6094 },
{ letter: 'I', frequency: 2288 },
],
encode: { x: 'letter', y: 'frequency', color: () => 'bar' },
labels: [
{
text: 'frequency',
transform: [
{
type: 'contrastReverse',
},
],
},
],
});
chart.render();
配置 overflowStroke 优化溢出标签的描边
import { Chart } from '@antv/g2';
const chart = new Chart({
container: 'container',
});
chart.options({
width: 200,
type: 'interval',
scale: {
color: { range: ['#222'] },
},
autoFit: true,
data: [
{ letter: 'A', frequency: 8167 },
{ letter: 'B', frequency: 1492 },
{ letter: 'C', frequency: 2782 },
{ letter: 'D', frequency: 4253 },
{ letter: 'E', frequency: 2702 },
{ letter: 'H', frequency: 6094 },
{ letter: 'I', frequency: 2288 },
],
encode: { x: 'letter', y: 'frequency', color: () => 'bar' },
labels: [
{
text: 'frequency',
transform: [
{
type: 'contrastReverse',
},
{
type: 'overflowStroke',
},
],
},
],
});
chart.render();
| 属性 | 描述 | 类型 | 默认值 | 必选 |
|---|---|---|---|---|
| threshold | 溢出阈值,越大越不越容易触发描边 | number |
2 | |
| palette | 描边备选的颜色色板,会自动选择与标签颜色对比度最大的颜色 | string[] |
['#000', '#fff'] |
overflowHide
overflowHide 对于标签在图形上放置不下的时候,隐藏标签。和 overlapDodgeY 的区别在于:
overlapDodgeY针对label标签和label标签之间的,是多个label标签重叠导致的模糊不清。overflowHide针对label标签和mark图形之间的, 是多个小的图形导致的模糊不清.
问题案例
当一个图有多个小的图形组成,如果每个小图形都映射有一个 label 标签都话,就会出现重叠和图表不清的情况。比如旭日图、矩形树图等。
配置 overflowHide 转化标签
对 label 标签超出对应的图形,进行隐藏。 注:部分特殊图表,内置了 label 配置,可以在视图层面配置。
尝试一下:
import { plotlib } from '@antv/g2-extension-plot';
import { Runtime, corelib, extend } from '@antv/g2';
const Chart = extend(Runtime, { ...corelib(), ...plotlib() });
const chart = new Chart({
container: 'container',
autoFit: true,
});
chart.options({
type: 'sunburst',
data: {
type: 'fetch',
value: 'https://gw.alipayobjects.com/os/antvdemo/assets/data/sunburst.json',
},
encode: { value: 'sum' },
labels: [
{
text: 'name',
transform: [
{
type: 'overflowHide',
},
],
},
],
});
chart.render();
overlapHide
overlapHide 对位置碰撞的标签进行隐藏,默认保留前一个,隐藏后一个。和 overlapDodgeY 的区别在于 overlapHide 进行隐藏,而不是移动。
问题案例
当部分图形颜色和标签颜色接近时,会出现看不清的问题。
import { Chart } from '@antv/g2';
const chart = new Chart({
container: 'container',
});
chart.options({
type: 'line',
autoFit: true,
height: 300,
insetLeft: 40,
insetRight: 40,
data: {
type: 'fetch',
value:
'https://gw.alipayobjects.com/os/bmw-prod/cb99c4ab-e0a3-4c76-9586-fe7fa2ff1a8c.csv',
},
encode: {
x: (d) => new Date(d.date).getFullYear(),
y: 'price',
color: 'symbol',
},
transform: [{ type: 'groupX', y: 'mean' }],
labels: [{ text: 'price' }],
});
chart.render();
配置 overlapHide 转化标签
对不明显的 label 标签 颜色进行优化
import { Chart } from '@antv/g2';
const chart = new Chart({
container: 'container',
});
chart.options({
type: 'line',
autoFit: true,
height: 300,
insetLeft: 40,
insetRight: 40,
data: {
type: 'fetch',
value:
'https://gw.alipayobjects.com/os/bmw-prod/cb99c4ab-e0a3-4c76-9586-fe7fa2ff1a8c.csv',
},
encode: {
x: (d) => new Date(d.date).getFullYear(),
y: 'price',
color: 'symbol',
},
transform: [{ type: 'groupX', y: 'mean' }],
labels: [{ text: 'price', transform: [{ type: 'overlapHide' }] }],
});
chart.render();
exceedAdjust
exceedAdjust 会自动对标签做溢出检测和矫正,即当标签超出指定区域时,会对标签自动做反方向的位移。
配置项
| 属性 | 说明 | 类型 | 默认值 |
|---|---|---|---|
| bounds | 指定检测边界的区域类型,5.3.4 开始支持 |
'view' | 'main' |
'view' |
| offsetX | 触发自动调整位置,位移时 X 轴偏移附加值 | number |
0 |
| offsetY | 触发自动调整位置,位移时 Y 轴偏移附加值 | number |
0 |
'view':检测标签是否超出整个视图区域(包含 margin 和 padding)'main':检测标签是否超出主区域(不包含 margin 和 padding)'offsetX':触发自动调整位置,位移时 X 轴偏移附加值,左侧边界向右偏移,右侧边界向左偏移'offsetY':触发自动调整位置,位移时 Y 轴偏移附加值,上侧边界向下偏移,下侧边界向上偏移
问题案例
label 标签会超出图表,超出的部分会被截断。
import { Chart } from '@antv/g2';
const chart = new Chart({
container: 'container',
});
chart.options({
type: 'line',
autoFit: true,
height: 300,
data: {
type: 'fetch',
value:
'https://gw.alipayobjects.com/os/bmw-prod/cb99c4ab-e0a3-4c76-9586-fe7fa2ff1a8c.csv',
},
encode: {
x: (d) => new Date(d.date).getFullYear(),
y: 'price',
color: 'symbol',
},
transform: [{ type: 'groupX', y: 'mean' }],
labels: [{ text: 'price' }],
});
chart.render();
配置 exceedAdjust 转化标签 - 默认 view 边界
对超出视图的 label 标签进行方向优化,默认边界为视图区域(View Area)。
import { Chart } from '@antv/g2';
const chart = new Chart({
container: 'container',
});
const data = [
{
date: '2025-07-01',
price: 600,
showLabel: 1,
tooltip: '最低价 ¥600',
},
{
date: '2025-07-02',
price: 660,
},
{
date: '2025-07-03',
price: 778,
},
{
date: '2025-07-04',
price: 780,
},
{
date: '2025-07-05',
price: 810,
},
{
date: '2025-07-06',
price: 815,
},
{
date: '2025-07-07',
price: 778,
},
{
date: '2025-07-08',
price: 778,
},
{
date: '2025-07-09',
price: 778,
},
{
date: '2025-07-10',
price: 778,
},
{
date: '2025-07-11',
price: 890,
},
{
date: '2025-07-12',
price: 814,
},
{
date: '2025-07-13',
price: 890,
},
{
date: '2025-07-14',
price: 820,
},
{
date: '2025-07-15',
price: 790,
},
{
date: '2025-07-16',
price: 810,
},
{
date: '2025-07-17',
price: 790,
},
{
date: '2025-07-18',
price: 860,
},
{
date: '2025-07-19',
price: 780,
},
{
date: '2025-07-20',
price: 860,
},
{
date: '2025-07-21',
price: 860,
},
{
date: '2025-07-22',
price: 860,
},
{
date: '2025-07-23',
price: 860,
},
{
date: '2025-07-24',
price: 860,
},
{
date: '2025-07-25',
price: 860,
},
{
date: '2025-07-26',
price: 860,
},
{
date: '2025-07-27',
price: 860,
},
{
date: '2025-07-28',
price: 860,
},
{
date: '2025-07-29',
price: 860,
},
{
date: '2025-07-30',
price: 860,
},
{
date: '2025-07-31',
price: 860,
},
{
date: '2025-08-01',
price: 860,
},
{
date: '2025-08-02',
price: 860,
},
{
date: '2025-08-03',
price: 860,
},
{
date: '2025-08-04',
price: 860,
},
{
date: '2025-08-05',
price: 860,
},
{
date: '2025-08-06',
price: 860,
},
{
date: '2025-08-07',
price: 860,
},
{
date: '2025-08-08',
price: 860,
},
{
date: '2025-08-09',
price: 860,
},
{
date: '2025-08-10',
price: 860,
},
{
date: '2025-08-11',
price: 860,
},
{
date: '2025-08-12',
price: 860,
},
{
date: '2025-08-13',
price: 860,
},
{
date: '2025-08-14',
price: 860,
},
{
date: '2025-08-15',
price: 860,
},
{
date: '2025-08-16',
price: 740,
},
{
date: '2025-08-17',
price: 740,
},
{
date: '2025-08-18',
price: 740,
},
{
date: '2025-08-19',
price: 740,
},
{
date: '2025-08-20',
price: 740,
},
{
date: '2025-08-21',
price: 740,
},
{
date: '2025-08-22',
price: 740,
},
{
date: '2025-08-23',
price: 740,
},
{
date: '2025-08-24',
price: 740,
},
{
date: '2025-08-25',
price: 740,
},
{
date: '2025-08-26',
price: 740,
},
{
date: '2025-08-27',
price: 740,
},
{
date: '2025-08-28',
price: 740,
},
{
date: '2025-08-29',
price: 740,
},
{
date: '2025-08-30',
price: 740,
},
{
date: '2025-08-31',
price: 740,
showLabel: 1,
tooltip: '最高价 ¥740',
},
];
const result = (data.filter((item) => item.showLabel) || []).map((item) => {
return {
type: 'lineX',
data: [item],
encode: {
x: 'date',
y: 'price',
color: 'linear-gradient(-90deg, #1677FF5B 0%,#1677FF 100%)',
},
style: {
lineWidth: 3,
lineDash: [3, 3],
},
labels: item.tooltip
? [
{
text: 'tooltip',
fill: '#000000',
fillOpacity: 1,
fontSize: 22,
fontWeight: 500,
lineHeight: 30,
textAlign: 'center',
background: true,
backgroundFill: '#ffffff',
backgroundRadius: 24,
backgroundOpacity: 1,
backgroundPadding: [10, 16],
backgroundRadius: 10,
backgroundShadowColor: 'rgba(42,102,187,0.17)',
backgroundShadowBlur: 22,
transform: [{ type: 'exceedAdjust' }], // 默认 view 边界
},
]
: [],
};
});
chart.options({
width: 654,
height: 310,
type: 'view',
margin: 20,
marginLeft: 10,
insetLeft: 24,
insetRight: 24,
insetBottom: 24,
animate: false,
axis: {
x: {
title: '',
size: 16,
line: true,
lineLineWidth: 1.5,
lineStroke: '#DEE3EB',
tick: false,
labelFontSize: 22,
labelFill: '#545C67',
labelFontWeight: 500,
labelDy: 8,
labelFormatter: (str) => {
if (/^\d{4}-\d{2}-\d{2}$/.test(str)) {
const [year, month, day] = str.split('-');
return `${+month}月${+day}日`;
}
return str;
},
tickFilter: (d, index) => {
if (data[index]?.showLabel) {
return true;
}
return false;
},
},
y: {
title: '',
tick: false,
line: true,
lineStroke: '#DEE3EB',
lineLineWidth: 1.5,
labelDx: -8,
labelFontSize: 22,
labelFill: '#545C67',
labelFontWeight: 500,
grid: false,
},
},
scale: {
y: {
type: 'linear',
tickCount: 5,
domain: [600, 860],
nice: true,
},
},
children: [
{
type: 'area',
data: data,
encode: {
x: 'date',
y: 'price',
shape: 'smooth',
},
style: {
fill: `linear-gradient(-90deg, rgba(255,255,255,0) 0%, rgba(255,255,255,0) 50%,rgba(105, 168, 255, 0.61) 100%)`,
},
},
{
type: 'line',
data: data,
encode: {
x: 'date',
y: 'price',
shape: 'smooth',
},
style: {
stroke:
'linear-gradient(0deg, #91BDFF 0%, #1777FF 24.148%, #1777FF 75.172%,#1677FF32 100%)',
lineWidth: 6,
},
},
...result,
],
});
chart.render();
可以看出,设置区域为视图区域的时候,依然会遮挡坐标轴刻度值标签,此时需要修改 bounds 参数。
配置 exceedAdjust 转化标签 - main 边界
使用 bounds: 'main' 配置,在标签超出主区域(不包含 margin 和 padding)时就会进行调整。
import { Chart } from '@antv/g2';
const chart = new Chart({
container: 'container',
});
const data = [
{
date: '2025-07-01',
price: 600,
showLabel: 1,
tooltip: '最低价 ¥600',
},
{
date: '2025-07-02',
price: 660,
},
{
date: '2025-07-03',
price: 778,
},
{
date: '2025-07-04',
price: 780,
},
{
date: '2025-07-05',
price: 810,
},
{
date: '2025-07-06',
price: 815,
},
{
date: '2025-07-07',
price: 778,
},
{
date: '2025-07-08',
price: 778,
},
{
date: '2025-07-09',
price: 778,
},
{
date: '2025-07-10',
price: 778,
},
{
date: '2025-07-11',
price: 890,
},
{
date: '2025-07-12',
price: 814,
},
{
date: '2025-07-13',
price: 890,
},
{
date: '2025-07-14',
price: 820,
},
{
date: '2025-07-15',
price: 790,
},
{
date: '2025-07-16',
price: 810,
},
{
date: '2025-07-17',
price: 790,
},
{
date: '2025-07-18',
price: 860,
},
{
date: '2025-07-19',
price: 780,
},
{
date: '2025-07-20',
price: 860,
},
{
date: '2025-07-21',
price: 860,
},
{
date: '2025-07-22',
price: 860,
},
{
date: '2025-07-23',
price: 860,
},
{
date: '2025-07-24',
price: 860,
},
{
date: '2025-07-25',
price: 860,
},
{
date: '2025-07-26',
price: 860,
},
{
date: '2025-07-27',
price: 860,
},
{
date: '2025-07-28',
price: 860,
},
{
date: '2025-07-29',
price: 860,
},
{
date: '2025-07-30',
price: 860,
},
{
date: '2025-07-31',
price: 860,
},
{
date: '2025-08-01',
price: 860,
},
{
date: '2025-08-02',
price: 860,
},
{
date: '2025-08-03',
price: 860,
},
{
date: '2025-08-04',
price: 860,
},
{
date: '2025-08-05',
price: 860,
},
{
date: '2025-08-06',
price: 860,
},
{
date: '2025-08-07',
price: 860,
},
{
date: '2025-08-08',
price: 860,
},
{
date: '2025-08-09',
price: 860,
},
{
date: '2025-08-10',
price: 860,
},
{
date: '2025-08-11',
price: 860,
},
{
date: '2025-08-12',
price: 860,
},
{
date: '2025-08-13',
price: 860,
},
{
date: '2025-08-14',
price: 860,
},
{
date: '2025-08-15',
price: 860,
},
{
date: '2025-08-16',
price: 740,
},
{
date: '2025-08-17',
price: 740,
},
{
date: '2025-08-18',
price: 740,
},
{
date: '2025-08-19',
price: 740,
},
{
date: '2025-08-20',
price: 740,
},
{
date: '2025-08-21',
price: 740,
},
{
date: '2025-08-22',
price: 740,
},
{
date: '2025-08-23',
price: 740,
},
{
date: '2025-08-24',
price: 740,
},
{
date: '2025-08-25',
price: 740,
},
{
date: '2025-08-26',
price: 740,
},
{
date: '2025-08-27',
price: 740,
},
{
date: '2025-08-28',
price: 740,
},
{
date: '2025-08-29',
price: 740,
},
{
date: '2025-08-30',
price: 740,
},
{
date: '2025-08-31',
price: 740,
showLabel: 1,
tooltip: '最高价 ¥740',
},
];
const result = (data.filter((item) => item.showLabel) || []).map((item) => {
return {
type: 'lineX',
data: [item],
encode: {
x: 'date',
y: 'price',
color: 'linear-gradient(-90deg, #1677FF5B 0%,#1677FF 100%)',
},
style: {
lineWidth: 3,
lineDash: [3, 3],
},
labels: item.tooltip
? [
{
text: 'tooltip',
fill: '#000000',
fillOpacity: 1,
fontSize: 22,
fontWeight: 500,
lineHeight: 30,
textAlign: 'center',
background: true,
backgroundFill: '#ffffff',
backgroundRadius: 24,
backgroundOpacity: 1,
backgroundPadding: [10, 16],
backgroundRadius: 10,
backgroundShadowColor: 'rgba(42,102,187,0.17)',
backgroundShadowBlur: 22,
transform: [{ type: 'exceedAdjust', bounds: 'main', offsetX: 15 }], // 边界配置为主区域,并且水平方向偏移为 15
},
]
: [],
};
});
chart.options({
width: 654,
height: 310,
type: 'view',
margin: 20,
marginLeft: 10,
insetLeft: 24,
insetRight: 24,
insetBottom: 24,
animate: false,
axis: {
x: {
title: '',
size: 16,
line: true,
lineLineWidth: 1.5,
lineStroke: '#DEE3EB',
tick: false,
labelFontSize: 22,
labelFill: '#545C67',
labelFontWeight: 500,
labelDy: 8,
labelFormatter: (str) => {
if (/^\d{4}-\d{2}-\d{2}$/.test(str)) {
const [year, month, day] = str.split('-');
return `${+month}月${+day}日`;
}
return str;
},
tickFilter: (d, index) => {
if (data[index]?.showLabel) {
return true;
}
return false;
},
},
y: {
title: '',
tick: false,
line: true,
lineStroke: '#DEE3EB',
lineLineWidth: 1.5,
labelDx: -8,
labelFontSize: 22,
labelFill: '#545C67',
labelFontWeight: 500,
grid: false,
},
},
scale: {
y: {
type: 'linear',
tickCount: 5,
domain: [600, 860],
nice: true,
},
},
children: [
{
type: 'area',
data: data,
encode: {
x: 'date',
y: 'price',
shape: 'smooth',
},
style: {
fill: `linear-gradient(-90deg, rgba(255,255,255,0) 0%, rgba(255,255,255,0) 50%,rgba(105, 168, 255, 0.61) 100%)`,
},
},
{
type: 'line',
data: data,
encode: {
x: 'date',
y: 'price',
shape: 'smooth',
},
style: {
stroke:
'linear-gradient(0deg, #91BDFF 0%, #1777FF 24.148%, #1777FF 75.172%,#1677FF32 100%)',
lineWidth: 6,
},
},
...result,
],
});
chart.render();
position
在笛卡尔坐标系下
支持 9 种位置:top, left, right, bottom, top-left, top-right, bottom-left, bottom-right, inside。
import * as G2 from '@antv/g2';
const { Chart, ChartEvent } = G2;
const chart = new Chart({
container: 'container',
});
const container = chart.getContainer();
chart.options({
height: 300,
type: 'cell',
data: [
{ x: 'x-a', y: 'y-a', data: 1 },
{ x: 'x-a', y: 'y-b', data: 3 },
{ x: 'x-a', y: 'y-c', data: 2 },
{ x: 'x-b', y: 'y-a', data: 8 },
{ x: 'x-b', y: 'y-b', data: 5 },
{ x: 'x-b', y: 'y-c', data: 6 },
{ x: 'x-c', y: 'y-a', data: 7 },
{ x: 'x-c', y: 'y-b', data: 4 },
{ x: 'x-c', y: 'y-c', data: 9 },
],
legend: false,
axis: false,
encode: {
x: 'x', // 编码 x 轴
y: 'y', // 编码 y 轴
color: 'data', // 使用数据中的 data1 字段
},
labels: [
{
text: 'data',
style: { fontSize: 16, stroke: '#fff', lineWidth: 2 },
},
],
style: {
inset: 5,
lineWidth: 10,
},
});
// 插入Encode-Color 选择器
const selectorContainer = document.createElement('div');
selectorContainer.textContent = 'position: ';
const selector = document.createElement('select');
selector.innerHTML = [
'top',
'left',
'right',
'bottom',
'top-left',
'top-right',
'bottom-left',
'bottom-right',
'inside',
].reduce((v, position) => {
return `${v}<option value="${position}" ${
position === 'top' ? 'selected' : ''
}>${position}</option>`;
}, '');
selector.onchange = (e) => {
chart.options({
labels: [
{
text: 'data',
position: e.target.value,
style: { fontSize: 16, stroke: '#fff', lineWidth: 2 },
},
],
});
chart.render(); // 重新渲染图表
};
selectorContainer.appendChild(selector);
container.insertBefore(selectorContainer, container.childNodes[0]);
chart.render();
非笛卡尔坐标系下
支持 outside, inside 两种。见 饼图/环形图。
| position | 用途 | 使用前 | 使用后 |
|---|---|---|---|
spider |
调整标签沿坐标轴边沿两端对齐,适用于 polar 坐标系 | ||
surround |
调整标签环形环绕做坐标系,适用于 polar 坐标系下的玫瑰图 |
此外,针对面积图提供特殊 area,见 面积图特殊标签。针对 radial 类型的图标,增加了 spider、surround 两种类型。
| position | 用途 | 使用前 | 使用后 |
|---|---|---|---|
area |
将面积图的标签显示在面积区域中心,并设置一定的旋转角度 |
style
style 标签样式配置,内部做了处理,可以直接在配置项配置样式。具体样式配置,可参考 文本样式配置、connector 连接线样式、background 背景样式 。
({
labels: [
{
style: {
fontSize: 20,
fontWeight: 600,
lineHeight: 30,
textAlign: 'center',
connectorStroke: '#000',
connectorLineWidth: 2,
backgroundFill: '#f5f5f5',
backgroundRadius: 4,
},
},
],
});
文本样式配置
标签文本样式配置,继承自 G 引擎的 Text, 其上的样式都通用。
| 属性 | 描述 | 类型 | 默认值 | 必选 |
|---|---|---|---|---|
| fontSize | 标签文字大小 | number | Function<number> | - | |
| fontFamily | 标签文字字体 | string | Function<string> | - | |
| fontWeight | 标签文字粗细 | number | Function<number> | - | |
| lineHeight | 标签文字的行高 | number | Function<number> | - | |
| textAlign | 设置标签文字内容的水平对齐方式, 支持的属性:center | end | left | right | start,默认值为start |
string | Function<string> | start |
|
| textBaseline | 设置在绘制标签文字时垂直方向的基线, 支持的属性:top | middle | bottom | alphabetic | hanging。默认值为bottom |
string | Function<string> | bottom |
|
| fill | 标签文字的填充色 | string | Function<string> | - | |
| fillOpacity | 标签文字的填充透明度 | number | Function<number> | - | |
| stroke | 标签文字的描边 | string | Function<string> | - | |
| strokeOpacity | 标签文字描边透明度 | number | Function<number> | - | |
| lineWidth | 标签文字描边宽度 | number | Function<number> | - | |
| lineDash | 标签文字描边的虚线配置,第一个值为虚线每个分段的长度,第二个值为分段间隔的距离。lineDash 设为[0, 0]的效果为没有描边。 | [number,number] | Function<[number, number]> | - | |
| opacity | 标签文字的整体透明度 | number | Function<number> | - | |
| shadowColor | 标签文字阴影颜色 | string | Function<string> | - | |
| shadowBlur | 标签文字阴影的高斯模糊系数 | number | Function<number> | - | |
| shadowOffsetX | 标签文字阴影水平偏移量 | number | Function<number> | - | |
| shadowOffsetY | 标签文字阴影垂直偏移量 | number | Function<number> | - | |
| cursor | 鼠标样式。同 css 的鼠标样式,默认 ‘default’。 | string | Function<string> | default |
|
| dx | 标签文字在水平方向的偏移量 | number | Function<number> | 0 | |
| dy | 标签文字在垂直方向的偏移量 | number | Function<number> | 0 |
({
labels: [
{
fill: '#000',
fontSize: 20,
lineHeight: 30,
fontWeight: 600,
textAlign: 'center',
textBaseline: 'middle',
fontFamily: 'sans-serif',
opacity: 0.9,
cursor: 'pointer',
lineDash: [3, 4],
lineWidth: 2,
stroke: '#fff',
strokeOpacity: 0.4,
shadowOffsetX: 10,
shadowOffsetY: 10,
shadowColor: '#000',
shadowBlur: 2,
},
],
});
connector
标签连接线样式配置,格式为: connector${style}, 如: connectorStroke 代表连接线的颜色。 需要 position spider、surround 才会有 connector 元素。
| 参数 | 说明 | 类型 | 默认值 | 必选 |
|---|---|---|---|---|
| connectorStroke | 连接线的颜色 | string | - | |
| connectorStrokeOpacity | 连接线的透明度 | number | - | |
| connectorLineWidth | 连接线描边宽度 | number | - | |
| connectorLineDash | 连接线虚线配置,第一个值为虚线每个分段的长度,第二个值为分段间隔的距离。lineDash 设为[0,0]的效果为没有描边。 | [number,number] | - | |
| connectorOpacity | 连接线的整体透明度 | number | - | |
| connectorShadowColor | 连接线阴影颜色 | string | - | |
| connectorShadowBlur | 连接线阴影的高斯模糊系数 | number | - | |
| connectorShadowOffsetX | 连接线阴影水平偏移量 | number | - | |
| connectorShadowOffsetY | 连接线阴影垂直偏移量 | number | - | |
| connectorCursor | 鼠标样式。同 css 的鼠标样式 | string | default |
|
| connectorDistance | 连接线和文本的距离 | number | - |
import { Chart } from '@antv/g2';
const chart = new Chart({
container: 'container',
});
chart.options({
type: 'interval',
width: 500,
height: 400,
data: [
{ id: 'c', value: 526 },
{ id: 'sass', value: 220 },
{ id: 'php', value: 325 },
{ id: 'elixir', value: 561 },
],
encode: { y: 'value', color: 'id' },
transform: [{ type: 'stackY' }],
coordinate: { type: 'theta', innerRadius: 0.25, outerRadius: 0.8 },
legend: false,
labels: [
{
text: 'id',
position: 'spider',
fontWeight: 'bold',
fontSize: 14,
textBaseline: 'bottom',
textAlign: (d) => (['c', 'sass'].includes(d.id) ? 'end' : 'start'),
connectorDistance: 5, // 文本和连接线的间距
connectorStroke: '#0649f2',
connectorLineWidth: 1,
connectorLineDash: [3, 4],
connectorOpacity: 0.8,
},
],
});
chart.render();
background
标签文本背景框样式配置,格式为: background${style}, 如: backgroundFill 代表背景框填充色。
| 参数 | 说明 | 类型 | 默认值 | 必选 |
|---|---|---|---|---|
| backgroundFill | 背景框的填充色 | string | - | |
| backgroundFillOpacity | 背景框的填充透明度 | number | - | |
| backgroundStroke | 背景框的描边 | string | - | |
| backgroundStrokeOpacity | 背景框描边透明度 | number | - | |
| backgroundLineWidth | 背景框描边宽度 | number | - | |
| backgroundLineDash | 背景框描边虚线配置,第一个值为虚线每个分段的长度,第二个值为分段间隔的距离。lineDash 设为[0,0]的效果为没有描边。 | [number,number] | - | |
| backgroundOpacity | 背景框的整体透明度 | number | - | |
| backgroundShadowColor | 背景框阴影颜色 | string | - | |
| backgroundShadowBlur | 背景框阴影的高斯模糊系数 | number | - | |
| backgroundShadowOffsetX | 背景框阴影水平偏移量 | number | - | |
| backgroundShadowOffsetY | 背景框阴影垂直偏移量 | number | - | |
| backgroundCursor | 鼠标样式。同 css 的鼠标样式 | string | default |
|
| backgroundRadius | 背景框圆角半径 | number | - | |
| backgroundPadding | 背景框内边距 | number[] | - |
import { Chart } from '@antv/g2';
const chart = new Chart({
container: 'container',
});
chart.options({
type: 'interval',
width: 500,
height: 400,
data: [
{ id: 'c', value: 526 },
{ id: 'sass', value: 220 },
{ id: 'php', value: 325 },
{ id: 'elixir', value: 561 },
],
encode: { y: 'value', color: 'id' },
transform: [{ type: 'stackY' }],
coordinate: { type: 'theta', innerRadius: 0.25, outerRadius: 0.8 },
legend: false,
labels: [
{
text: 'value',
fill: '#0700fa', // 文本样式
background: true, // 背景展示
backgroundFill: '#fff',
backgroundRadius: 4,
backgroundPadding: [10, 10, 10, 10],
backgroundOpacity: 0.4,
backgroundStroke: '#000',
backgroundLineDash: [3, 4],
backgroundLineWidth: 1,
},
],
});
chart.render();