Skip to content

docs: fix label callback type signatures inconsistency in axis docs #7283

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

Merged
moayuisuda merged 1 commit into from
Mar 27, 2026
+4 −4
Merged

docs: fix label callback type signatures inconsistency in axis docs #7283

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions site/docs/manual/component/axis.en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -409,8 +409,8 @@ For example, to configure label rotation, it's not configured under a label obje
| labelTextBaseline | Label text vertical baseline | `'top'` | `'middle'` | `'bottom'` | `'alphabetic'` | `'hanging'` | `(datum, index, data)=>string` | `'bottom'` | |
| labelAlign | Label alignment<br/>- 'horizontal' always horizontal<br/> - 'parallel' parallel to axis<br/> - 'perpendicular' perpendicular to axis | `'horizontal'` &#124; `'parallel'` &#124; `'perpendicular'` | `parallel` | |
| labelFilter | Label filtering | `(datum, index, data)=> boolean` | - | |
| labelFormatter | Label formatting, accepts function or [d3-format](https://d3js.org/d3-format) supported string | `string` \| `(datum, index, array) => string` | - | |
| labelRender | Custom label render, support HtmlString, the usage is the same as that of `labelFormatter` | `string` \| `(datum, index, array) => string` | - | |
| labelFormatter | Label formatting, accepts function or [d3-format](https://d3js.org/d3-format) supported string | `string` \| `(datum, index, data) => string` | - | |
| labelRender | Custom label render, support HtmlString, the usage is the same as that of `labelFormatter` | `string` \| `(datum, index, data) => string` | - | |
| transform | Label transform to avoid text overlap. Supports text ellipsis, overlap hiding, auto rotation | `Transform[]` | - | |
| labelTransform | Label transform shortcuts for local coordinate system transforms including scale, translate, rotate, skew, matrix transforms, see [transform](https://g.antv.antgroup.com/api/basic/display-object#transform) | `string` | - | |
| labelAutoHide | Auto hide overlapping labels, effective when size is set | `boolean` &#124; `HideOverlapCfg` | - | |
Expand Down
4 changes: 2 additions & 2 deletions site/docs/manual/component/axis.zh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -408,8 +408,8 @@ chart.options({
| labelTextBaseline | 刻度标签文字垂直基线 | `'top'` &#124; `'middle'` &#124; `'bottom'` &#124; `'alphabetic'` &#124; `'hanging'` &#124; `(datum, index, data)=>string` | `'bottom'` | |
| labelAlign | 刻度值对齐方式<br/>- 'horizontal' 始终保持水平<br/> - 'parallel' 平行于坐标轴<br/> - 'perpendicular' 垂直于坐标轴 | `'horizontal'` &#124; `'parallel'` &#124; `'perpendicular'` | `parallel` | |
| labelFilter | 刻度值过滤 | `(datum, index, data)=> boolean` | - | |
| labelFormatter | 刻度值格式化，可以传入一个函数或者是 [d3-format](https://d3js.org/d3-format) 支持的字符串 | `string` \| `(datum, index, array) => string` | - | |
| labelRender | 自定义 label 渲染，支持 HtmlString，用法同 `labelFormatter` | `string` \| `(datum, index, array) => string` | - | |
| labelFormatter | 刻度值格式化，可以传入一个函数或者是 [d3-format](https://d3js.org/d3-format) 支持的字符串 | `string` \| `(datum, index, data) => string` | - | |
| labelRender | 自定义 label 渲染，支持 HtmlString，用法同 `labelFormatter` | `string` \| `(datum, index, data) => string` | - | |
| transform | 刻度值转换，避免文本之间发生重叠。当前支持超长文本缩略、重叠刻度值隐藏、自动旋转 | `Transform[]` | - | |
| labelTransform | 刻度值转换，在局部坐标系下进行变换的快捷方式，包括缩放、平移、旋转、拉伸、矩阵变换，具体见[transform](https://g.antv.antgroup.com/api/basic/display-object#transform) | `string` | - | |
| labelAutoHide | 自动隐藏重叠的刻度值，设置 size 值的时候生效 | `boolean` &#124; `HideOverlapCfg` | - | |
Expand Down
Loading