docs: refactor axis and legend api

antvis · Nov 21, 2022 · 9164aef · 9164aef
1 parent d7dff46
commit 9164aef
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 16 deletions.
diff --git a/site/docs/api/component/axis.zh.md b/site/docs/api/component/axis.zh.md
@@ -52,12 +52,12 @@ chart.render();
 
 ### 标题
 
-| 属性         | 描述                           | 类型                                    | 默认值    |
-| ------------ | ------------------------------ | --------------------------------------- | --------- |
-| title        | 标题，支持一段文本或自定义图形 | `string` \| `number` \| `DisplayObject` | `\-`      |
-| titleSpacing | 标题到坐标轴的距离             | `number`                                | `10`      |
-| titleAlign   | 标题相对坐标轴的位置           | `'start'` \| `'middle'` \| `'end'`      | `'start'` |
-| title[Style] | 标题对应的样式属性             | 与 text `style` 一致                    | `\-`      |
+| 属性          | 描述                                                           | 类型                                     | 默认值    |
+| ------------- | -------------------------------------------------------------- | ---------------------------------------- | --------- |
+| title         | 标题，支持一段文本或自定义图形                                 | `string` \| `number` \| `DisplayObject`  | `\-`      |
+| titleSpacing  | 标题到坐标轴的距离                                             | `number`                                 | `10`      |
+| titlePosition | 标题相对坐标轴的位置，支持首字母简写形式，如`'top'`简写为`'t'` | `'top'`\|`'bottom'`\|`'left'`\|`'right'` | `'lb'`    |
+| title[Style]  | 标题对应的样式属性                                             | 与 text `style` 一致                     | `\-`      |
 
 ### 轴线
 

diff --git a/site/docs/api/component/legend.zh.md b/site/docs/api/component/legend.zh.md
@@ -215,16 +215,15 @@ chart.render();
 
 <img alt="flow layout" src="https://mdn.alipayobjects.com/huamei_qa8qxu/afts/img/A*Lb43QoUm8ZEAAAAAAAAAAAAADmJ7AQ/original" width="400" />
 
-| 属性       | 描述                                                         | 类型     | 默认值 |
-| ---------- | ------------------------------------------------------------ | -------- | ------ |
-| width      | 图例区域高度                                                 | `number` | `\-`   |
-| height     | 图例区域宽度                                                 | `number` | `\-'   |
-| gridRow    | 指定每页显示的图例项数量                                     | `number` | `1`    |
-| gridCol    | 指定每列显示的图例项数量，为空或`Infinity`时表示列数不受限制 | `number` | `\-`   |
-| maxWidth   | 图例区域最大高度，超出该高度后图例项会分页显示               | `number` | `500`  |
-| maxHeight  | 图例区域最大宽度，超出该宽度后图例项会换行显示               | `number` | `20`   |
-| colPadding | 图例项之间的横向间隔                                         | `number` | `0`    |
-| rowPadding | 图例项之间的纵向间隔                                         | `number` | `0`    |
+| 属性       | 描述                                                         | 类型               | 默认值   |
+| ---------- | ------------------------------------------------------------ | ------------------ | -------- |
+| layout     | 布局方式，网格布局、流式布局                                 | `'flex'`\|`'grid'` | `'flex'` |
+| width      | 图例区域高度，超出该高度后图例项会分页显示                   | `number`           | `1000`   |
+| height     | 图例区域宽度，超出该宽度后图例项会换行显示                   | `number`           | `100`    |
+| gridRow    | 指定每页显示的图例项数量                                     | `number`           | `1`      |
+| gridCol    | 指定每列显示的图例项数量，为空时表示列数不受限制 | `number`           | `\-`     |
+| colPadding | 图例项之间的横向间隔                                         | `number`           | `0`      |
+| rowPadding | 图例项之间的纵向间隔                                         | `number`           | `0`      |
 
 ### 分页显示