Skip to content

Commit 5454d86

Browse files
authored
refactor(docs-radar): 更新雷达图文档 & api 走查功能是否具备 (#1875)
1 parent ffe9503 commit 5454d86

File tree

10 files changed

+39
-20
lines changed

10 files changed

+39
-20
lines changed

docs/manual/plots/radar.en.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -60,12 +60,16 @@ radarPlot.render();
6060

6161
<description>**required** _string_</description>
6262

63-
[DEMO](../../radar/basic#series)
64-
6563
对雷达图进行分组的字段,一般对应一个分类字段。通过该字段的值,雷达图将会被分为多个组,通过颜色进行区分,并上下重叠。
6664

6765
### Geometry Style
6866

67+
#### radius
68+
69+
<description>**optional** _number_</description>
70+
71+
雷达图的半径,原点为绘图区域中心(不包含图表组件区域)。配置值域为 (0,1],1 代表撑满绘图区域。
72+
6973
`markdown:docs/common/color.en.md`
7074

7175
#### smooth
@@ -112,8 +116,8 @@ radarPlot.render();
112116
| 细分配置 | 类型 | 功能描述 |
113117
| -------- | --------- | ---------- |
114118
| smooth | _boolean_ | 是否平滑 |
115-
| color | \_string | string[] | Function\_ | 填充面积颜色,也可以支持回调的方式设置,回调参数为 `color: (x, y, series) => string` |
116-
| style | \_object | Function\_ | 填充面积样式,也可以支持回调的方式设置,回调参数为 `style: (x, y, series) => object` |
119+
| color | `_string | string[] | Function_` | 填充面积颜色,也可以支持回调的方式设置,回调参数为 `color: (x, y, series) => string` |
120+
| style | `\_object | Function\_` | 填充面积样式,也可以支持回调的方式设置,回调参数为 `style: (x, y, series) => object` |
117121

118122
使用示例:
119123

@@ -129,9 +133,9 @@ radarPlot.render();
129133
}
130134
```
131135

132-
### Plot Components
136+
### About Plot Components
133137

134-
<img src="https://gw.alipayobjects.com/mdn/rms_d314dd/afts/img/A*oiTPQLqYUvIAAAAAAAAAAABkARQnAQ" alt="雷达图 图表组件" width="600">
138+
<img src="https://gw.alipayobjects.com/mdn/rms_d314dd/afts/img/A*KnguSICzqXEAAAAAAAAAAAAAARQnAQ" alt="雷达图 图表组件" width="600">
135139

136140
`markdown:docs/common/component.en.md`
137141

docs/manual/plots/radar.zh.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,12 +60,16 @@ radarPlot.render();
6060

6161
<description>**required** _string_</description>
6262

63-
[DEMO](../../radar/basic#series)
64-
6563
对雷达图进行分组的字段,一般对应一个分类字段。通过该字段的值,雷达图将会被分为多个组,通过颜色进行区分,并上下重叠。
6664

6765
### 图形样式
6866

67+
#### radius
68+
69+
<description>**optional** _number_</description>
70+
71+
雷达图的半径,原点为绘图区域中心(不包含图表组件区域)。配置值域为 (0,1],1 代表撑满绘图区域。
72+
6973
`markdown:docs/common/color.zh.md`
7074

7175
#### smooth
@@ -129,9 +133,9 @@ radarPlot.render();
129133
}
130134
```
131135

132-
### 图表组件
136+
### 图表组件介绍
133137

134-
<img src="https://gw.alipayobjects.com/mdn/rms_d314dd/afts/img/A*oiTPQLqYUvIAAAAAAAAAAABkARQnAQ" alt="雷达图 图表组件" width="600">
138+
<img src="https://gw.alipayobjects.com/mdn/rms_d314dd/afts/img/A*KnguSICzqXEAAAAAAAAAAAAAARQnAQ" alt="雷达图 图表组件" width="600">
135139

136140
### 图表组件
137141

examples/radar/basic/demo/area-alternate-grid.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,9 @@ fetch('https://gw.alipayobjects.com/os/bmw-prod/bda695a8-cd9f-4b78-a423-3d6d547c
5252
// 开启面积
5353
area: {},
5454
// 开启辅助点
55-
point: {},
55+
point: {
56+
size: 2,
57+
},
5658
});
5759
radarPlot.render();
5860
});

examples/radar/basic/demo/area-grid.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,9 @@ fetch('https://gw.alipayobjects.com/os/bmw-prod/bda695a8-cd9f-4b78-a423-3d6d547c
5151
// 开启面积
5252
area: {},
5353
// 开启辅助点
54-
point: {},
54+
point: {
55+
size: 2,
56+
},
5557
});
5658
radarPlot.render();
5759
});

examples/radar/basic/demo/area.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,9 @@ fetch('https://gw.alipayobjects.com/os/bmw-prod/bda695a8-cd9f-4b78-a423-3d6d547c
3939
// 开启面积
4040
area: {},
4141
// 开启辅助点
42-
point: {},
42+
point: {
43+
size: 2,
44+
},
4345
});
4446
radarPlot.render();
4547
});

examples/radar/basic/demo/basic.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ const radarPlot = new Radar('container', {
2121
},
2222
},
2323
xAxis: {
24-
line: null,
2524
tickLine: null,
2625
},
2726
yAxis: {

examples/radar/basic/demo/line-alternate-grid.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,9 @@ fetch('https://gw.alipayobjects.com/os/bmw-prod/bda695a8-cd9f-4b78-a423-3d6d547c
5050
},
5151
},
5252
// 开启辅助点
53-
point: {},
53+
point: {
54+
size: 2,
55+
},
5456
});
5557
radarPlot.render();
5658
});

examples/radar/basic/demo/line-grid.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,9 @@ fetch('https://gw.alipayobjects.com/os/bmw-prod/bda695a8-cd9f-4b78-a423-3d6d547c
4949
},
5050
},
5151
// 开启辅助点
52-
point: {},
52+
point: {
53+
size: 2,
54+
},
5355
});
5456
radarPlot.render();
5557
});

examples/radar/basic/demo/line.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,9 @@ fetch('https://gw.alipayobjects.com/os/bmw-prod/bda695a8-cd9f-4b78-a423-3d6d547c
3737
},
3838
},
3939
// 开启辅助点
40-
point: {},
40+
point: {
41+
size: 2,
42+
},
4143
});
4244
radarPlot.render();
4345
});

examples/radar/basic/demo/meta.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,21 +10,21 @@
1010
"zh": "基础雷达图",
1111
"en": "Basic radar plot"
1212
},
13-
"screenshot": "https://gw.alipayobjects.com/mdn/rms_d314dd/afts/img/A*exgfQbvqKlMAAAAAAAAAAAAAARQnAQ"
13+
"screenshot": "https://gw.alipayobjects.com/mdn/rms_d314dd/afts/img/A*W-b2QoNhip0AAAAAAAAAAAAAARQnAQ"
1414
},
1515
{
1616
"filename": "line.ts",
1717
"title": {
1818
"zh": "基础雷达图",
19-
"en": "Basic radar plot"
19+
"en": "Radar plot"
2020
},
2121
"screenshot": "https://gw.alipayobjects.com/mdn/rms_d314dd/afts/img/A*exgfQbvqKlMAAAAAAAAAAAAAARQnAQ"
2222
},
2323
{
2424
"filename": "line-grid.ts",
2525
"title": {
2626
"zh": "基础雷达图(带网格)",
27-
"en": "Basic radar plot (with grid)"
27+
"en": "Radar plot (with grid)"
2828
},
2929
"screenshot": "https://gw.alipayobjects.com/mdn/rms_d314dd/afts/img/A*E70qQpBJ2kMAAAAAAAAAAAAAARQnAQ"
3030
},

0 commit comments

Comments
 (0)