Skip to content

Commit

Permalink
docs: 添加 chart 和 view 对象的 api 文档 & 修复 shapeAttrs 链接文档 404 (#3172)
Browse files Browse the repository at this point in the history
* docs: 修复 绘图属性 文档链接 4, 使用绝对路径

* docs(chart): 添加 chart 和 view 对象的 api 文档

* docs: 文案修改

* docs: 文档优化

* docs: 通用 api 文档适用于 examples 中,使用 common 的 new-chart 文档

Co-authored-by: xinming <xinming.lxj@antfin.com>
  • Loading branch information
visiky and xinming authored Jan 5, 2021
1 parent baebc30 commit 5658ae7
Show file tree
Hide file tree
Showing 12 changed files with 444 additions and 100 deletions.
8 changes: 4 additions & 4 deletions docs/api/general/annotation.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ _**option**_ 配置如下:
| 参数名 | 类型 | 是否必选 | 默认值 | 描述 |
| ------- | ------------------- | -------- | ------ | ------------------ |
| padding | number \| number[]; | | - | 文本背景周围的留白 |
| style | [ShapeAttrs](shape) | | - | 文本背景的样式 |
| style | [ShapeAttrs](/zh/docs/api/shape/shape-attrs) | | - | 文本背景的样式 |

#### option.maxLength

Expand Down Expand Up @@ -150,13 +150,13 @@ _**option**_ 配置如下:

<description> _null | { style?: ShapeAttrs }_ **optional** </description>

point 设置。点击 [ShapeAttrs](shape) 查看详细样式配置。
point 设置。点击 [ShapeAttrs](/zh/docs/api/shape/shape-attrs) 查看详细样式配置。

#### option.line

<description> _null | { style?: ShapeAttrs, length?: number }_ **optional** </description>

line 设置。点击 [ShapeAttrs](shape) 查看详细样式配置。
line 设置。点击 [ShapeAttrs](/zh/docs/api/shape/shape-attrs) 查看详细样式配置。

#### option.text

Expand Down Expand Up @@ -198,7 +198,7 @@ line 长度。

<description> _null | { style?: ShapeAttrs }_ **optional** _default:_ `0`</description>

标注区间的配置。点击 [ShapeAttrs](shape) 查看详细样式配置。
标注区间的配置。点击 [ShapeAttrs](/zh/docs/api/shape/shape-attrs) 查看详细样式配置。

#### option.text

Expand Down
12 changes: 6 additions & 6 deletions docs/api/general/axis.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ _AxisOption_ 配置如下:

| 参数名 | 类型 | 是否必选 | 默认值 | 描述 |
| ------ | ------------------- | -------- | ------ | -------------------- |
| style | [ShapeAttrs](shape) | | - | 坐标轴线的样式配置项 |
| style | [ShapeAttrs](/zh/docs/api/shape/shape-attrs) | | - | 坐标轴线的样式配置项 |

### AxisOption.tickLine

Expand All @@ -53,7 +53,7 @@ _AxisOption_ 配置如下:

| 参数名 | 类型 | 是否必选 | 默认值 | 描述 |
| --------- | ------------------- | -------- | ------ | ---------------------------------------------------------- |
| style | [ShapeAttrs](shape) | | - | 坐标轴刻度线的样式配置项 |
| style | [ShapeAttrs](/zh/docs/api/shape/shape-attrs) | | - | 坐标轴刻度线的样式配置项 |
| alignTick | boolean | | - | 是否同刻度线对齐,如果值为 false,则会显示在两个刻度中间。 |
| length | number | | - | 长度 |

Expand All @@ -65,7 +65,7 @@ _AxisOption_ 配置如下:

| 参数名 | 类型 | 是否必选 | 默认值 | 描述 |
| ------ | ------------------- | -------- | ------ | ------------------------ |
| style | [ShapeAttrs](shape) | | - | 坐标轴刻度线的样式配置项 |
| style | [ShapeAttrs](/zh/docs/api/shape/shape-attrs) | | - | 坐标轴刻度线的样式配置项 |
| count | number | | - | 子刻度个数 |
| length | number | | - | 子刻度线长度 |

Expand All @@ -77,7 +77,7 @@ _AxisOption_ 配置如下:

| 参数名 | 类型 | 是否必选 | 默认值 | 描述 |
| ---------- | ------------------- | -------- | ------ | ------------------------ |
| style | [ShapeAttrs](shape) | | - | 坐标轴刻度线的样式配置项 |
| style | [ShapeAttrs](/zh/docs/api/shape/shape-attrs) | | - | 坐标轴刻度线的样式配置项 |
| offset | number | | - | 标题距离坐标轴的距离 |
| autoRotate | boolean | | - | 是否自动旋转 |

Expand All @@ -89,7 +89,7 @@ _AxisOption_ 配置如下:

| 参数名 | 类型 | 是否必选 | 默认值 | 描述 |
| ------------ | ------------------------------------------------------ | -------- | ------- | ------------------------ |
| style | [ShapeAttrs](shape) | | - | 坐标轴刻度线的样式配置项 |
| style | [ShapeAttrs](/zh/docs/api/shape/shape-attrs) | | - | 坐标轴刻度线的样式配置项 |
| offset | number | | - | label 的偏移量 |
| rotate | number | | - | 文本旋转角度 |
| autoRotate | boolean | | `true` | 是否自动旋转 |
Expand All @@ -115,7 +115,7 @@ _GridLineCfg_ 配置如下:
| 参数名 | 类型 | 是否必选 | 默认值 | 描述 |
| ------ | ------------------- | -------- | ------ | ---------------------------------- |
| type | 'line' \| 'circle' | | - | 栅格线的类型,'line' 或者 'circle' |
| style | [ShapeAttrs](shape) | | - | 坐标轴刻度线的样式配置项 |
| style | [ShapeAttrs](/zh/docs/api/shape/shape-attrs) | | - | 坐标轴刻度线的样式配置项 |

### AxisOption.animate

Expand Down
2 changes: 1 addition & 1 deletion docs/api/general/chart.en.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 绘制图表 - Chart
title: 图表 - Chart
order: 0
redirect_from:
- /en/docs/api
Expand Down
Loading

0 comments on commit 5658ae7

Please sign in to comment.