Skip to content

Commit 89c89e8

Browse files
authored
docs: 优化升级文档 (#1711)
1 parent 7d80cc2 commit 89c89e8

File tree

4 files changed

+286
-42
lines changed

4 files changed

+286
-42
lines changed

docs/manual/getting-started.en.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ You can import by CDN in browser or you can import local source.
1111

1212
```html
1313
<!-- import CDN source -->
14-
<script type="text/javascript" src="https://unpkg.com/@antv/g2plot@latest/dist/g2plot.js"></script>
14+
<script type="text/javascript" src="https://unpkg.com/@antv/g2plot@latest/dist/g2plot.min.js"></script>
1515
<script>
1616
const plot = new G2Plot.Line('container', {
1717
// ...
@@ -22,7 +22,7 @@ You can import by CDN in browser or you can import local source.
2222

2323
```html
2424
<!-- import local source -->
25-
<script src="./g2plot.js"></script>
25+
<script src="./g2plot.min.js"></script>
2626
```
2727

2828
### Import via NPM

docs/manual/getting-started.zh.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ order: 1
1111

1212
```html
1313
<!-- 引入在线资源 -->
14-
<script type="text/javascript" src="https://unpkg.com/@antv/g2plot@latest/dist/g2plot.js"></script>
14+
<script type="text/javascript" src="https://unpkg.com/@antv/g2plot@latest/dist/g2plot.min.js"></script>
1515
<script>
1616
const plot = new G2Plot.Line('container', {
1717
// ...
@@ -22,7 +22,7 @@ order: 1
2222

2323
```html
2424
<!-- 下载到本地 引入本地脚本 -->
25-
<script src="./g2plot.js"></script>
25+
<script src="./g2plot.min.js"></script>
2626
```
2727

2828
### 通过 npm 安装

docs/manual/upgrade.en.md

+141-19
Original file line numberDiff line numberDiff line change
@@ -7,34 +7,112 @@ order: 7
77

88
G2Plot 2.0 持续开发中,截止目前,我们已经完成了 P0 、P1 级图表的开发,其它图表的开发也会如期进行,详情请参考[开发计划](https://www.yuque.com/antv/g2plot/ffgrfy#U9F3)
99

10-
## 图表变更
10+
## 删除图表
1111

12-
### 类型变更
12+
**Bubble**:
1313

14-
- 去掉 Bubble,合并到 Scatter 中,通过配置实现,参考图表示例-[Scatter](../../examples/scatter/basic)
14+
- 改用 Scatter 实现, 修改图表名称即可, 详细参考 [Scatter](../../examples/scatter/basic)
1515

16-
- 去掉 StackedArea、PercentStackedArea,合并到 Area 中,通过配置实现,参考图表示例-[Area](../../examples/area/basic)
16+
**StackedColumn**:
1717

18-
- 去掉 StackedColumn、RangeColumn、GroupedColumn、PercentStackedColumn,合并到 Column 中,通过配置实现,参考图表示例-[Column](../../examples/column/basic)
18+
- 改用 Column 实现。
19+
- 删除 stackField 配置,改为 seriesField,需要指定 `isStack: true` , 详细参考 [Column](../../examples/column/stacked)
1920

20-
- 去掉 StackedBar、GroupedBar、PercentStackedBar、RangeBar,合并到 Bar 中,通过配置实现,参考图表示例-[Bar](../../examples/bar/basic)
21+
**GroupedColumn**:
2122

22-
- 去掉 Donut,合并到 Pie 中,通过配置实现,参考图表示例-[Pie](../../examples/pie/basic)
23+
- 改用 Column 实现。
24+
- 删除 groupField 配置,改为 seriesField,需要指定 `isGroup: true` , 详细参考 [Column](../../examples/column/grouped)
2325

24-
- 去掉 DualLine、ColumnLine、StackedColumnLine、GroupedColumnLine,统一到 DualAxes 中,通过配置实现,参考图表示例-[DualAxes](../../examples/dual-axes/dual-line)
26+
**PercentStackedColumn**:
2527

26-
### 配置变更
28+
- 改用 Column 实现。
29+
- 删除 stackField 配置,改为 seriesField,需要指定 `isStack: true``isGroup: true` , 详细参考 [Column](../../examples/column/percent)
30+
31+
**RangeColumn**:
32+
33+
- 改用 Column 实现。
34+
- 删除 stackField 配置,改为 seriesField,需要指定 `isRange: true` , 详细参考 [Column](../../examples/column/range)
35+
- label 不再支持 topStyle、bottomStyle,详细配置请参考 [API](../../examples/column/range/API#label) 文档。
36+
37+
**StackedBar**:
38+
39+
- 改用 Bar 实现。
40+
- 删除 stackField 配置,改为 seriesField,需要指定 `isStack: true` , 详细参考 [Bar](../../examples/bar/stacked)
41+
42+
**GroupedBar**:
43+
44+
- 改用 Bar 实现。
45+
- 删除 groupField 配置,改为 seriesField,需要指定 `isGroup: true` , 详细参考 [Bar](../../examples/bar/stacked)
46+
47+
**PercentStackedBar**:
48+
49+
- 改用 Bar 实现。
50+
- 删除 stackField 配置,改为 seriesField,需要指定 `isStack: true``isGroup: true` , 详细参考 [Bar](../../examples/bar/stacked)
51+
52+
**RangeBar**:
53+
54+
- 改用 Bar 实现。
55+
- 删除 stackField 配置,改为 seriesField,需要指定 `isRange: true` , 详细参考 [Bar](../../examples/bar/stacked)
56+
- label 不再支持 topStyle、bottomStyle,详细配置请参考 [API](../../examples/bar/range/API#label) 文档
57+
58+
**Donut**:
59+
60+
- 改用 Pie 实现,修改图表名称即可 , 详细参考 [Pie](../../examples/pie/basic)
61+
62+
**DualLine**:
63+
64+
- 改用 DualAxes 实现,详细参考 [Demos](../../examples/dual-axes/dual-line)
65+
66+
**ColumnLine**:
67+
68+
- 改用 DualAxes 实现,详细参考 [Demos](../../examples/dual-axes/column-line)
69+
70+
**StackedColumnLine**:
71+
72+
- 改用 DualAxes 实现,详细参考 [Demos](../../examples/dual-axes/stacked-column-line)
73+
74+
**GroupedColumnLine**:
75+
76+
- 改用 DualAxes 实现,详细参考 [Demos](../../examples/dual-axes/grouped-column-line)
77+
78+
**StackedArea**:
79+
80+
- 改用 Area 实现。
81+
- 去掉 stackField ,改用 seriesField 。
82+
83+
**PercentStackedArea**:
84+
85+
- 改用 Area 实现。
86+
- 去掉 stackField ,改用 seriesField ,需要指定 `isStack: true`
87+
88+
**StepLine**:
89+
90+
- 改用 Line 实现,需要指定 stepType,详细参考 [Line](../../examples/line/step)
91+
92+
```ts
93+
// 变更前
94+
step: 'hvh', // 可以选择 hv, vh, hvh, vhv
95+
96+
// 变更后
97+
stepType: 'hvh', // 可以选择 hv, vh, hvh, vhv
98+
```
99+
100+
## 配置变更
27101

28102
G2Plot 2.0 兼容大部分的 1.x 版本图表功能和配置项,详情如下:
29103

30-
#### 通用配置
104+
### 通用配置
31105

32106
**title**: 不再支持
33107

34108
**description**: 不再支持
35109

36110
**forceFit**: 不再支持,改用 autoFit
37111

112+
**responsive**:不再支持,内置。
113+
114+
**guideLine**:不再支持,改用 [anniotations](../../examples/general/annotation) 实现。
115+
38116
**slider**:
39117

40118
```ts
@@ -115,11 +193,12 @@ animation: {
115193
}
116194
```
117195

118-
#### 私有配置
196+
### 私有配置
119197

120198
**Scatter**:
121199

122200
- pointSize: 不再支持,改用 size 。
201+
- shape: 去掉默认类型 circle,需要显性设置。
123202

124203
**Rose**:
125204

@@ -129,20 +208,63 @@ animation: {
129208

130209
**Bullet**:
131210

132-
```ts
133-
// 变更前
134-
range: [0, 0.5, 1],
135-
136-
...
137-
// 变更后采用实际数值
138-
range: [20, 50, 100],
139-
```
211+
- 改动较大,详细参考 [Bullet](../../examples/bullet/basic)
140212

141213
**WordCloud**:
142214

143215
- maskImage: 不再支持, 改用 imageMask。
144216
- wordStyle 选项中的 gridSize 改为 padding。
145217

218+
**TinyArea、 TinyColumn、 TinyLine**:
219+
220+
- 删除 xField 、yField。
221+
- data 类型由 object[] 变为 number[]
222+
223+
**Gauge**:
224+
225+
- 删除 color 、 min 、 max。
226+
- 删除 value , 改用 percent 。
227+
- 删除 pivot 改用 indicator。
228+
- 更新 range ,详细参考[Gauge](../../examples/gauge/basic#complex)
229+
230+
```ts
231+
// 变更前
232+
range: [0, 25, 50, 75, 100],
233+
color: ['#39B8FF', '#52619B', '#43E089', '#C0EDF3'],
234+
// 变更后
235+
range: {
236+
ticks: [0, 0.25, 0.5, 0.75, 1],
237+
color: ['#39B8FF', '#52619B', '#43E089', '#C0EDF3'],
238+
}
239+
```
240+
241+
**Radar**:
242+
243+
- 删除 radiusAxis ,改用 yAxis。
244+
- 删除 angleField , 改用 xField 。
245+
- 删除 radiusField , 改用 yField 。
246+
247+
**Liquid**:
248+
249+
- 删除 min 、max。
250+
- 删除 value ,改用 percent。
251+
- 更新 statistic 。
252+
253+
```ts
254+
// 变更前
255+
statistic: {
256+
formatter: (value) => 'xx',
257+
},
258+
// 变更后
259+
statistic: {
260+
content: {
261+
formatter: ({ percent }) => {
262+
return `xxx`;
263+
},
264+
},
265+
},
266+
```
267+
146268
## 遇到问题
147269

148270
我们尽可能收集了已知的所有不兼容变化和相关影响,但是有可能还是有一些场景我们没有考虑到。如果你在升级过程中遇到了问题,请到 [GitHub issues](https://github.com/antvis/G2Plot/issues) 进行反馈。我们会尽快响应和相应改进这篇文档。

0 commit comments

Comments
 (0)