Skip to content

Sync incremental legend documentation from G2 #3145

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Copilot wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Sync incremental legend documentation from G2 #3145

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3b37677
Initial plan
Copilot Jan 23, 2026
6732f77
Add missing "隐藏图例" section and update itemSpacing description in Chin…
Copilot Jan 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion site/docs/options/plots/legend.zh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,24 @@ Ant Design Charts 中 **图例（Legend）** 是图表的辅助元素，使用
});
```

## 隐藏图例

隐藏各个通道的图例：

```js
({
legend: { color: false }, // 隐藏 color 通道的图例
});
```

隐藏多个图例：

```js
({
legend: false,
});
```

## 配置项

Ant Design Charts 中图例分为 **连续图例** 和 **分类图例** 两种，由于这两种图例的结构不同，所以配置项也存在差异。
Expand Down Expand Up @@ -92,7 +110,7 @@ Ant Design Charts 中图例分为 **连续图例** 和 **分类图例** 两种
| itemBackground <Badge type="success">分类图例</Badge> | 配置图例项的背景 | [itemBackground](#itembackground) | 详见[itemBackground](#itembackground) |
| itemWidth <Badge type="success">分类图例</Badge> | 配置图例项的宽度 | number | - |
| itemSpan <Badge type="success">分类图例</Badge> | 配置图例项图标、标签和值的空间划分 | number \| number[] | `[1, 1, 1]` |
| itemSpacing <Badge type="success">分类图例</Badge> | 配置图例项图标、标签、值之间的间距（启用 focus 时还包括聚焦图标间距） | number \| number[] | `[8, 8, 4]` |
| itemSpacing <Badge type="success">分类图例</Badge> | 配置图例项图标、标签、值、聚焦图标之间的间距 | number \| number[] | `[8, 8, 4]` |
| nav <Badge type="success">分类图例</Badge> | 配置图例的分页器 | [nav](#nav) | 详见[nav](#nav) |
| poptip <Badge type="success">分类图例</Badge> | 图例项提示 | [poptip](#poptip) | 详见[poptip](#poptip) |
| focus <Badge type="success">分类图例</Badge> | 是否启用图例聚焦 | boolean | false | |
Expand Down