Skip to content

Commit

Permalink
docs: 修复教程页的 404 链接 & 优化 api 文档的字体间距等样式' (#2167)
Browse files Browse the repository at this point in the history 
* docs: 修复教程页存在的 404 链接

* docs(style): 调整官网文档样式

* chore: 更新 antv-theme

* docs(style): 文档样式调整
  • Loading branch information
@visiky
visiky authored Jan 2, 2021
1 parent 2468149 commit 2f401dc
Show file tree
Hide file tree
Showing 22 changed files with 182 additions and 149 deletions.
8 changes: 4 additions & 4 deletions docs/api/plot-api.zh.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ import { Line } from '@antv/g2plot';

const line = new Line(container', options);
// 1. `container`： 图表渲染的 DOM 容器 id 或者 HTMLElement 实例
// 2. `options`： 图表配置数据，不同的图表功能请参考[各图表配置项](./plots/line)
// 2. `options`： 图表配置数据，不同的图表功能请参考[基础图表 API]
```
创建好的图表实例，都具有两个公开属性：
- container: HTMLElement： 图表渲染的 DOM 容器。
- options: PlotOptions： 图表当前的所有全量配置项 options，是有用户传入，以及图表内置的默认配置项合并之后结果。
- container `HTMLElement`: 图表渲染的 DOM 容器。
- options `PlotOptions`: 图表当前的所有全量配置项 options，是有用户传入，以及图表内置的默认配置项合并之后结果。
对于 API，分别罗列图表实例的所有 API 方法。如果按照功能分类，主要可以分成为：生命周期函数、事件、状态量 等 API
Expand All @@ -42,7 +42,7 @@ plot.render();
plot.update(options: Partial<PlotOptions>);
```
通过这个方法，可以增量的更新图表配置，方法会自动将传入的增量配置合并到当前的配置项中，并自动掉调用 `render` 方法，无需手动调用。
通过这个方法，可以增量的更新图表配置，方法会自动将传入的增量配置合并到当前的配置项中，并自动调用 `render` 方法，无需手动调用。
### 4. changeData
Expand Down
4 changes: 2 additions & 2 deletions docs/api/plots/radar.en.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -116,8 +116,8 @@ radarPlot.render();
| 细分配置 | 类型 | 功能描述 |
| -------- | --------- | ---------- |
| smooth | _boolean_ | 是否平滑 |
| color | `_string | string[] | Function_` | 填充面积颜色，也可以支持回调的方式设置，回调参数为 `color: (x, y, series) => string` |
| style | `\_object | Function\_` | 填充面积样式，也可以支持回调的方式设置，回调参数为 `style: (x, y, series) => object` |
| color | _string \| string[] \| Function_ | 填充面积颜色，也可以支持回调的方式设置，回调参数为 `color: (x, y, series) => string` |
| style | _object \| Function_ | 填充面积样式，也可以支持回调的方式设置，回调参数为 `style: (x, y, series) => object` |

使用示例：

Expand Down
4 changes: 2 additions & 2 deletions docs/api/plots/radar.zh.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -116,8 +116,8 @@ radarPlot.render();
| 细分配置 | 类型 | 功能描述 |
| -------- | --------- | ---------- |
| smooth | _boolean_ | 是否平滑 |
| color | \_string | string[] | Function\_ | 填充面积颜色，也可以支持回调的方式设置，回调参数为 `color: (x, y, series) => string` |
| style | \_object | Function\_ | 填充面积样式，也可以支持回调的方式设置，回调参数为 `style: (x, y, series) => object` |
| color | _string \| string[] \| Function_ | 填充面积颜色，也可以支持回调的方式设置，回调参数为 `color: (x, y, series) => string` |
| style | _object \| Function_ | 填充面积样式，也可以支持回调的方式设置，回调参数为 `style: (x, y, series) => object` |

使用示例：

Expand Down
6 changes: 3 additions & 3 deletions docs/common/interactions.zh.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
在 G2Plot 中，透传了 G2 的交互语法，同时也内置了一些与具体 plot 绑定的交互。

使用方式：
```plain
```ts
// 开启「鼠标移入图表元素（柱状图的柱子、点图的点等）时触发 active」的交互
interactions: [{ type: 'element-active' }]

Expand All @@ -15,12 +15,12 @@ interactions: [{ type: 'element-active' }, { type: 'brush' }]

#### 移除交互

```plain
```ts
plot.chart.removeInteraction('interaction-type');
```

使用示例：
```plain
```ts
// 移除 图例筛选 交互
plot.chart.removeInteraction('legend-filter');
```
Expand Down
30 changes: 15 additions & 15 deletions docs/common/label.en.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,22 @@

| 属性名 | 类型 | 介绍 |
| ------------ | ---------------------------------------------------------- | ------------------------------------------------------------------------------------------ |
| type | string | 当用户使用了自定义的 label 类型，需要声明具体的 type 类型，否则会使用默认的 label 类型渲染（饼图 label 支持 `inner|outer|spider`）|
| offset | number | label 的偏移量 |
| offsetX | number | label 相对于数据点在 X 方向的偏移距离 |
| offsetY | number | label 相对于数据点在 Y 方向的偏移距离 |
| content | string \| IGroup \| IShape \| GeometryLabelContentCallback | 展示的文本内容，如果不声明则按照参与映射的第一字段的值进行显示 |
| type | _string_ | 当用户使用了自定义的 label 类型，需要声明具体的 type 类型，否则会使用默认的 label 类型渲染（饼图 label 支持 `inner|outer|spider`）|
| offset | _number_ | label 的偏移量 |
| offsetX | _number_ | label 相对于数据点在 X 方向的偏移距离 |
| offsetY | _number_ | label 相对于数据点在 Y 方向的偏移距离 |
| content | _string \| IGroup \| IShape \| GeometryLabelContentCallback_ | 展示的文本内容，如果不声明则按照参与映射的第一字段的值进行显示 |
| style | object | label 文本图形属性样式 |
| autoRotate | string | 是否自动旋转，默认 true |
| rotate | number | 文本旋转角度 |
| labelLine | null \| boolean \|object | 用于设置文本连接线的样式属性，null 表示不展示。 |
| labelEmit | boolean | 只对极坐标下的文本生效，表示文本是否按照角度进行放射状显示，true 表示开启，false 表示关闭 |
| layout | 'overlap' \| 'fixedOverlap' \| 'limitInShape' | 文本布局类型，支持多种布局函数组合使用。 |
| position | 'top' \| 'bottom' \| 'middle' \| 'left' \| 'right' | 指定当前 label 与当前图形的相对位置 |
| animate | boolean \| AnimateOption | 动画配置。 |
| formatter | Function | 格式化函数 |
| autoHide | boolean | 是否自动隐藏，默认 false |
|
| autoRotate | _string_ | 是否自动旋转，默认 true |
| rotate | _number_ | 文本旋转角度 |
| labelLine | _null \| _boolean_ \|object_ | 用于设置文本连接线的样式属性，null 表示不展示。 |
| labelEmit | _boolean_ | 只对极坐标下的文本生效，表示文本是否按照角度进行放射状显示，true 表示开启，false 表示关闭 |
| layout | _'overlap' \| 'fixedOverlap' \| 'limitInShape'_ | 文本布局类型，支持多种布局函数组合使用。 |
| position | _'top' \| 'bottom' \| 'middle' \| 'left' \| 'right'_ | 指定当前 label 与当前图形的相对位置 |
| animate | _boolean \| AnimateOption_ | 动画配置。 |
| formatter | _Function_ | 格式化函数 |
| autoHide | _boolean_ | 是否自动隐藏，默认 false |
|

示例代码：

Expand Down
28 changes: 14 additions & 14 deletions docs/common/label.zh.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,21 @@

| 属性名 | 类型 | 介绍 |
| ------------ | ---------------------------------------------------------- | ------------------------------------------------------------------------------------------ |
| type | string | 当用户使用了自定义的 label 类型，需要声明具体的 type 类型，否则会使用默认的 label 类型渲染（饼图 label 支持 `inner|outer|spider`）|
| offset | number | label 的偏移量 |
| offsetX | number | label 相对于数据点在 X 方向的偏移距离 |
| offsetY | number | label 相对于数据点在 Y 方向的偏移距离 |
| content | string \| IGroup \| IShape \| GeometryLabelContentCallback | 展示的文本内容，如果不声明则按照参与映射的第一字段的值进行显示 |
| type | _string_ | 当用户使用了自定义的 label 类型，需要声明具体的 type 类型，否则会使用默认的 label 类型渲染（饼图 label 支持 `inner|outer|spider`）|
| offset | _number_ | label 的偏移量 |
| offsetX | _number_ | label 相对于数据点在 X 方向的偏移距离 |
| offsetY | _number_ | label 相对于数据点在 Y 方向的偏移距离 |
| content | _string \| IGroup \| IShape \| GeometryLabelContentCallback_ | 展示的文本内容，如果不声明则按照参与映射的第一字段的值进行显示 |
| style | object | label 文本图形属性样式 |
| autoRotate | string | 是否自动旋转，默认 true |
| rotate | number | 文本旋转角度 |
| labelLine | null \| boolean \|object | 用于设置文本连接线的样式属性，null 表示不展示。 |
| labelEmit | boolean | 只对极坐标下的文本生效，表示文本是否按照角度进行放射状显示，true 表示开启，false 表示关闭 |
| layout | 'overlap' \| 'fixedOverlap' \| 'limitInShape' | 文本布局类型，支持多种布局函数组合使用。 |
| position | 'top' \| 'bottom' \| 'middle' \| 'left' \| 'right' | 指定当前 label 与当前图形的相对位置 |
| animate | boolean \| AnimateOption | 动画配置。 |
| formatter | Function | 格式化函数 |
| autoHide | boolean | 是否自动隐藏，默认 false |
| autoRotate | _string_ | 是否自动旋转，默认 true |
| rotate | _number_ | 文本旋转角度 |
| labelLine | _null \| _boolean_ \|object_ | 用于设置文本连接线的样式属性，null 表示不展示。 |
| labelEmit | _boolean_ | 只对极坐标下的文本生效，表示文本是否按照角度进行放射状显示，true 表示开启，false 表示关闭 |
| layout | _'overlap' \| 'fixedOverlap' \| 'limitInShape'_ | 文本布局类型，支持多种布局函数组合使用。 |
| position | _'top' \| 'bottom' \| 'middle' \| 'left' \| 'right'_ | 指定当前 label 与当前图形的相对位置 |
| animate | _boolean \| AnimateOption_ | 动画配置。 |
| formatter | _Function_ | 格式化函数 |
| autoHide | _boolean_ | 是否自动隐藏，默认 false |
|

示例代码：
Expand Down
16 changes: 8 additions & 8 deletions docs/common/line-style.en.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

| Attr | Type | Description |
| ------------- | --------------- | ------------------------------------------------------------------------------------------------------ |
| stroke | string | color of the line |
| lineWidth | number | width of the line |
| stroke | _string_ | color of the line |
| lineWidth | _number_ | width of the line |
| lineDash | [number,number] | configure dashed line, the first parameter is the length of each segment, the second parameter is the gap between segment. When lineDash is set to [0,0], there is no effect. |
| opacity | number | opacity |
| shadowColor | string | shadow color |
| shadowBlur | number | Gaussian blur coefficient |
| shadowOffsetX | number | configure horizontal distance between shadow and line |
| shadowOffsetY | number | configure vertical distance between shadow and line |
| cursor | string | mouse style, same as the mouse style of CSS, default value : 'default' |
| opacity | _number_ | opacity |
| shadowColor | _string_ | shadow color |
| shadowBlur | _number_ | Gaussian blur coefficient |
| shadowOffsetX | _number_ | configure horizontal distance between shadow and line |
| shadowOffsetY | _number_ | configure vertical distance between shadow and line |
| cursor | _string_ | mouse style, same as the mouse style of CSS, default value : 'default' |

Example：

Expand Down
Loading

0 comments on commit 2f401dc

Please sign in to comment.