Skip to content

Commit 50999c3

Browse files
authored
fix: 升级官网主题 & 修复文档命名错误 (#2508)
* chore: update gatsby-theme-antv * docs: 修复文档命名错误 * docs: 图表组件增加 slider 的 api 文档,增加说明
1 parent 1623ca8 commit 50999c3

File tree

6 files changed

+23
-15
lines changed

6 files changed

+23
-15
lines changed
File renamed without changes.

docs/common/component.en.md

+4
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,7 @@ Same for xAxis and yAxis. **Note**: Since `DualAxes` or `BidirectionalBar` has d
1919
#### annotations
2020

2121
`markdown:docs/common/annotations.en.md`
22+
23+
#### slider
24+
25+
`markdown:docs/common/slider.en.md`

docs/common/component.zh.md

+4
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,7 @@ xAxis、yAxis 配置相同。**注意**:由于 DualAxes(双轴图) 和 Bidirec
1919
#### annotations
2020

2121
`markdown:docs/common/annotations.zh.md`
22+
23+
#### slider
24+
25+
`markdown:docs/common/slider.zh.md`

docs/common/slider.en.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
Object type refer to [ShapeAttrs](/en/docs/api/graphic-style)
1+
> Only line plot, area plot and dual-axes plot are supported.
22
33
| Properties | Type | Description |
44
| --------------- | -------------- | --------------------------------------- |
55
| start | _number_ | Default starting position |
66
| end | _number_ | Default ending position |
77
| height | _number_ | Slider height |
88
| trendCfg | _TrendCfg_ | Configuration of background trends |
9-
| backgroundStyle | _object_ | Background style |
10-
| foregroundStyle | _object_ | Foreground style |
9+
| backgroundStyle | _object_ | Background style, reference[Graphic Style](/en/docs/api/graphic-style) |
10+
| foregroundStyle | _object_ | Foreground style, reference[Graphic Style](/en/docs/api/graphic-style) |
1111
| handlerStyle | _HandlerStyle_ | Handler configuration |
12-
| textStyle | _object_ | Text style |
12+
| textStyle | _object_ | Text style, reference[Graphic Style](/en/docs/api/graphic-style) |
1313
| minLimit | _number_ | Lower limit of sliding position allowed |
1414
| maxLimit | _number_ | Upper limit of sliding position allowed |
1515
| formatter | _Function_ | Slider text formatting function |
@@ -21,9 +21,9 @@ Types of __*TrendCfg*__ are as follow:
2121
| data | _number[]_ | Trend data |
2222
| smooth | _boolean_ | Whether smooth |
2323
| isArea | _boolean_ | Whether area |
24-
| backgroundStyle | _object_ | Background style configuration |
25-
| lineStyle | _object_ | Line style configuration |
26-
| areaStyle | _object_ | Area style configuration |
24+
| backgroundStyle | _object_ | Background style configuration, reference[Graphic Style](/en/docs/api/graphic-style) |
25+
| lineStyle | _object_ | Line style configuration, reference[Graphic Style](/en/docs/api/graphic-style) |
26+
| areaStyle | _object_ | Area style configuration, reference[Graphic Style](/en/docs/api/graphic-style) |
2727

2828
Types of __*HandlerStyle*__ are as follow:
2929

docs/common/slider.zh.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
object 类型的请参考[绘图属性](/zh/docs/api/graphic-style)
1+
> 目前只适用于:折线图、面积图、双轴图。
22
33
| 配置项 | 类型 | 功能描述 |
44
| --------------- | -------------- | ------------------ |
55
| start | _number_ | 默认起始位置 |
66
| end | _number_ | 默认结束位置 |
77
| height | _number_ | 缩略轴高度 |
88
| trendCfg | _TrendCfg_ | 背景趋势的配置 |
9-
| backgroundStyle | _object_ | 背景配置 |
10-
| foregroundStyle | _object_ | 背景配置 |
9+
| backgroundStyle | _object_ | 背景配置,参考[绘图属性](/zh/docs/api/graphic-style) |
10+
| foregroundStyle | _object_ | 前景配置,参考[绘图属性](/zh/docs/api/graphic-style) |
1111
| handlerStyle | _HandlerStyle_ | handler 配置 |
12-
| textStyle | _object_ | 文本配置 |
12+
| textStyle | _object_ | 文本配置,参考[绘图属性](/zh/docs/api/graphic-style) |
1313
| minLimit | _number_ | 允许滑动位置下限 |
1414
| maxLimit | _number_ | 允许滑动位置上限 |
1515
| formatter | _Function_ | 滑块文本格式化函数 |
@@ -21,9 +21,9 @@ __*TrendCfg*__ 类型如下:
2121
| data | _number[]_ | 统计文本的样式 |
2222
| smooth | _boolean_ | 是否平滑 |
2323
| isArea | _boolean_ | 是否面积图 |
24-
| backgroundStyle | _object_ | 背景样式配置 |
25-
| lineStyle | _object_ | line 样式配置 |
26-
| areaStyle | _object_ | area 样式配置 |
24+
| backgroundStyle | _object_ | 背景样式配置,参考[绘图属性](/zh/docs/api/graphic-style) |
25+
| lineStyle | _object_ | line 样式配置,参考[绘图属性](/zh/docs/api/graphic-style) |
26+
| areaStyle | _object_ | area 样式配置,参考[绘图属性](/zh/docs/api/graphic-style) |
2727

2828
__*HandlerStyle*__ 类型如下:
2929

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@
6363
},
6464
"devDependencies": {
6565
"@antv/data-set": "^0.11.5",
66-
"@antv/gatsby-theme-antv": "^1.0.4",
66+
"@antv/gatsby-theme-antv": "^1.1.2",
6767
"@babel/core": "^7.10.4",
6868
"@babel/plugin-transform-runtime": "^7.11.5",
6969
"@babel/preset-env": "^7.10.4",

0 commit comments

Comments
 (0)