G2Plot 2.0 Upgrade guide

5 min read

Summary

G2Plot 2.0 is under continuous development. Up to now, we have completed the development of P0 and P1 charts, and the development of other charts will be carried out as scheduled. More details please reference Development Plan.

Abandoned charts

Chart nameDescriptionExample
Bubble改用 Scatter 实现, 修改图表名称即可。Scatter
StackedColumn改用 Column 实现。
删除 stackField 配置,改为 seriesField,需要指定 isStack: true
Column
GroupedColumn改用 Column 实现。
删除 groupField 配置,改为 seriesField,需要指定 isGroup: true
Column
PercentStackedColumn改用 Column 实现。
删除 stackField 配置,改为 seriesField,需要指定 isStack: trueisPercent: true
Column
RangeColumn改用 Column 实现。
删除 stackField 配置,需要指定 isRange: true
label 不再支持 topStyle、bottomStyle,详细配置请参考 API 文档。
Column
StackedBar改用 Bar 实现。
删除 stackField 配置,改为 seriesField,需要指定 isStack: true
Bar
PercentStackedBar改用 Bar 实现。
删除 stackField 配置,改为 seriesField,需要指定 isStack: trueisPercent: true
Bar
RangeBar改用 Bar 实现。
删除 stackField 配置,需要指定 isRange: true
label 不再支持 topStyle、bottomStyle,详细配置请参考 API 文档
Bar
Donut改用 Pie 实现,修改图表名称即可。Pie
DualLine改用 DualAxes 实现。Demos
ColumnLine改用 DualAxes 实现。Demos
StackedColumnLine改用 DualAxes 实现。Demos
GroupedColumnLine改用 DualAxes 实现。Demos
StackedArea改用 Area 实现。
去掉 stackField ,改用 seriesField。
Area
PercentStackedArea改用 Area 实现。去掉 stackField ,改用 seriesField ,需要指定 isPercent: trueArea
StepLine改用 Line 实现,需要指定 stepType。
1.0 版版本可以使用默认 step ,2.0 版本必须手动指定 stepType(hv, vh, hvh, vhv),
Line

Configuration change

G2Plot 2.0 is compatible with most of the chart functions and configuration items of version 1.x. The details are as follows:

General attributes

PropertiesDescriptionExample
title不再支持-
description不再支持-
forceFit不再支持,改用 autoFit-
responsive不再支持,内置-
guideLine不再支持,改用 annotations 实现。-
labellabel.type 会有兼容性问题,如果报错修改 type 配置或者去掉-
slider写法变更示例
scrollbar写法变更示例
events写法变更示例
visible写法变更示例
animation写法变更示例

Private configuration

Chart nameDescriptionExample
ScatterpointSize: 不再支持,改用 size。
shape: 去掉默认类型 circle,需要显性设置。
trendline: 不再支持,改用 regressionLine,删除 showConfidence、confidenceStyle 配置,新增 algorithm 配置
-
RosecategoryField: 不再支持,改用 xField。
radiusField: 不再支持,改用 yField。
colorField: 不再支持,改用 seriesField。
-
Bullet改动较大,详细参考 Bullet-
WordCloudmaskImage: 不再支持, 改用 imageMask。
wordStyle 选项中的 gridSize 改为 padding。
data 不再做限制,但需要指定 wordField、weightField。
-
TinyArea、TinyColumn、 TinyLine删除 xField 、yField。
data 类型由 object[] 变为 number[]。
-
Gauge删除 color 、 min 、 max。
删除 value , 改用 percent。
删除 pivot 改用 indicator。
更新 range ,详细参考Gauge
示例
Radar删除 radiusAxis ,改用 yAxis。
删除 angleField , 改用 xField。
删除 radiusField , 改用 yField。
-
Liquid删除 min 、max。
删除 value ,改用 percent。
更新 statistic。
示例

Problems

We've collected as much as possible all known incompatible changes and related impacts, but there may still be scenarios that we haven't taken into account. If you have problems during the upgrade process, please go to GitHub issues for feedback. We will respond and improve this document as soon as possible.