Skip to content

Commit

Permalink
docs(upgrade): 完善升级文档 (#2403)
Browse files Browse the repository at this point in the history
  • Loading branch information
simaQ committed May 6, 2020
1 parent 54f573b commit b4451df
Show file tree
Hide file tree
Showing 2 changed files with 60 additions and 44 deletions.
52 changes: 30 additions & 22 deletions docs/manual/upgrade.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,14 +32,14 @@ G2 4.0 在功能上全面兼容 3.x 的功能,在 API 接口上,我们进行

#### 不兼容改动

- `chart.source()` 接口废弃,请使用 `chart.data()` 接口,同时列定义请通过 `chart.scale()`  接口进行定义。
- `chart.coord()` 接口废弃,请使用 `chart.coordinate()`
- `chart.guide()` 接口废弃,请使用 `chart.annotation()`,同时不再支持 `chart.guide().html()`
- `chart.view()`  接口废弃,请使用 `chart.createView()`
- `chart.interact()`  接口废弃,请使用 `chart.interaction()`
- `chart.repaint()`  接口废弃,请使用 `chart.render(update: boolean)` 接口。
- 考虑到 G2 使用环境的不同(浏览器、mobile 等),v3 版本中关于图片下载的接口:`chart.toDataURL` 以及 `chart.downloadImage()` 接口废弃,具体方案可参考 [FAQ](./faq)
-  `G2.Global` 移除,默认的主题配置可以通过以下方式获取:
- 🗑️ `chart.source()` 接口废弃,请使用 `chart.data()` 接口,同时列定义请通过 `chart.scale()`  接口进行定义。
- 🗑️ `chart.coord()` 接口废弃,请使用 `chart.coordinate()`
- 🗑️ `chart.guide()` 接口废弃,请使用 `chart.annotation()`,同时不再支持 `chart.guide().html()`
- 🗑️ `chart.view()`  接口废弃,请使用 `chart.createView()`
- 🗑️ `chart.interact()`  接口废弃,请使用 `chart.interaction()`
- 🗑️ `chart.repaint()`  接口废弃,请使用 `chart.render(update: boolean)` 接口。
- 🗑️ 考虑到 G2 使用环境的不同(浏览器、mobile 等),v3 版本中关于图片下载的接口:`chart.toDataURL` 以及 `chart.downloadImage()` 接口废弃,具体方案可参考 [FAQ](./faq)
- 🗑️ `G2.Global` 移除,默认的主题配置可以通过以下方式获取:

```typescript
// 方式 1
Expand All @@ -50,20 +50,20 @@ const defaultTheme = getTheme();
const theme = chart.getTheme();
```

- `geometry.active()`  废弃,请使用 `geometry.state()` 接口。
- `geometry.select()`  废弃,请使用 `geometry.state()` 接口。
- `geometry.opacity()` 废弃,请使用 `geometry.color()`  中使用带透明度的颜色或者 `geometry.style()`  接口。
- 🗑️ `geometry.active()`  废弃,请使用 `geometry.state()` 接口。
- 🗑️ `geometry.select()`  废弃,请使用 `geometry.state()` 接口。
- 🗑️ `geometry.opacity()` 废弃,请使用 `geometry.color()`  中使用带透明度的颜色或者 `geometry.style()`  接口。
- 以下语法糖不再支持:
- `pointJitter()`  废弃,请使用 `point().adjust('jitter')`
- `pointDodge()`  废弃,请使用 `point().adjust('dodge')`
-  `intervalStack()` 废弃,请使用 `interval().adjust('stack')`
-  `intervalDodge()` 废弃,请使用 `interval().adjust('dodge')`
-  `intervalSymmetric()` 废弃,请使用 `interval().adjust('symmetric')`
-  `areaStack()` 废弃,请使用 `area().adjust('stack')`
-  `schemaDodge()` 废弃,请使用  `schema().adjust('stack')`
- `Venn`  以及 `Violin`  几何标记暂时移除,后续考虑以更好的方式支持。
- 移除 Interval 几何标记以下两个 shape: 'top-line' 及  'liquid-fill-gauge',用户可以通过自定义 Shape 机制自己实现。
- 移除 tail 类型的图例。
- 🗑️ `pointJitter()`  废弃,请使用 `point().adjust('jitter')`
- 🗑️ `pointDodge()`  废弃,请使用 `point().adjust('dodge')`
- 🗑️ `intervalStack()` 废弃,请使用 `interval().adjust('stack')`
- 🗑️ `intervalDodge()` 废弃,请使用 `interval().adjust('dodge')`
- 🗑️ `intervalSymmetric()` 废弃,请使用 `interval().adjust('symmetric')`
- 🗑️ `areaStack()` 废弃,请使用 `area().adjust('stack')`
- 🗑️ `schemaDodge()` 废弃,请使用  `schema().adjust('stack')`
- 🗑️ `Venn`  以及 `Violin`  几何标记暂时移除,后续考虑以更好的方式支持。
- 🗑️ 移除 Interval 几何标记以下两个 shape: 'top-line' 及  'liquid-fill-gauge',用户可以通过自定义 Shape 机制自己实现。
- 🗑️ 移除 tail 类型的图例。
- 内置常量重命名,一致使用小写 + '-' 命名规则,比如 `shape('hollowCircle')` 变更为 `shape('hollow-circle')`

#### 配置项以及接口变更
Expand Down Expand Up @@ -120,7 +120,15 @@ chart.axis('value', {

<img src="https://gw.alipayobjects.com/mdn/rms_f5c722/afts/img/A*j05pRJG3ovgAAAAAAAAAAABkARQnAQ" width=600 />

- `chart.legend()`  配置项更新,详见 [API](../api/classes/view#legend)
- `chart.legend()`  配置项更新,具体的配置见 [API](../api/classes/view#legend)。以下列举了一些 3.x 常用的属性以及 4.0 的替代方案:

- 🗑️ `clickable` 属性移除,如想要取消 legend 勾选交互,可以通过 `chart.removeInteraction('legend-filter')` 移除分类图例的勾选交互。
- 🗑️ `selectedMode` 属性移除,4.0 可通过自定义交互行为实现。
- 🗑️ `onClick` 属性移除,4.0 可通过监听 legend 事件实现:`chart.on('legend:click', (ev) => {})`
- 🗑️ `slidable` 属性移除,4.0 可以通过 `chart.removeInteraction('continuous-filter')` 移除连续图例的滑块交互。
- 🗑️ `hoverable` 属性移除,4.0 可以通过 `chart.interaction('legend-active')` 等交互行为实现,参考交互语法 demo: https://g2.antv.vision/en/examples/interaction/component#legend-active。
- 🗑️ `onHover` 属性移除,4.0 可以通过监听 legend 事件实现:`chart.on('legend:mousemove', (ev) => {})`

- `chart.axis()`  配置项更新,详见 [API](../api/classes/view#axis)
- `chart.annotation()`  各个类型的 annotation 配置项更新,详见 [API](../api/classes/view#annotation)
- `geometry().style()` 方法的回调函数写法变更,不再支持一个配置属性一个回调的方式,而是使用一个回调:
Expand Down
52 changes: 30 additions & 22 deletions docs/manual/upgrade.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,14 +32,14 @@ G2 4.0 在功能上全面兼容 3.x 的功能,在 API 接口上,我们进行

#### 不兼容改动

- `chart.source()` 接口废弃,请使用 `chart.data()` 接口,同时列定义请通过 `chart.scale()`  接口进行定义。
- `chart.coord()` 接口废弃,请使用 `chart.coordinate()`
- `chart.guide()` 接口废弃,请使用 `chart.annotation()`,同时不再支持 `chart.guide().html()`
- `chart.view()`  接口废弃,请使用 `chart.createView()`
- `chart.interact()`  接口废弃,请使用 `chart.interaction()`
- `chart.repaint()`  接口废弃,请使用 `chart.render(update: boolean)` 接口。
- 考虑到 G2 使用环境的不同(浏览器、mobile 等),v3 版本中关于图片下载的接口:`chart.toDataURL` 以及 `chart.downloadImage()` 接口废弃,具体方案可参考 [FAQ](./faq)
-  `G2.Global` 移除,默认的主题配置可以通过以下方式获取:
- 🗑️ `chart.source()` 接口废弃,请使用 `chart.data()` 接口,同时列定义请通过 `chart.scale()`  接口进行定义。
- 🗑️ `chart.coord()` 接口废弃,请使用 `chart.coordinate()`
- 🗑️ `chart.guide()` 接口废弃,请使用 `chart.annotation()`,同时不再支持 `chart.guide().html()`
- 🗑️ `chart.view()`  接口废弃,请使用 `chart.createView()`
- 🗑️ `chart.interact()`  接口废弃,请使用 `chart.interaction()`
- 🗑️ `chart.repaint()`  接口废弃,请使用 `chart.render(update: boolean)` 接口。
- 🗑️ 考虑到 G2 使用环境的不同(浏览器、mobile 等),v3 版本中关于图片下载的接口:`chart.toDataURL` 以及 `chart.downloadImage()` 接口废弃,具体方案可参考 [FAQ](./faq)
- 🗑️ `G2.Global` 移除,默认的主题配置可以通过以下方式获取:

```typescript
// 方式 1
Expand All @@ -50,20 +50,20 @@ const defaultTheme = getTheme();
const theme = chart.getTheme();
```

- `geometry.active()`  废弃,请使用 `geometry.state()` 接口。
- `geometry.select()`  废弃,请使用 `geometry.state()` 接口。
- `geometry.opacity()` 废弃,请使用 `geometry.color()`  中使用带透明度的颜色或者 `geometry.style()`  接口。
- 🗑️ `geometry.active()`  废弃,请使用 `geometry.state()` 接口。
- 🗑️ `geometry.select()`  废弃,请使用 `geometry.state()` 接口。
- 🗑️ `geometry.opacity()` 废弃,请使用 `geometry.color()`  中使用带透明度的颜色或者 `geometry.style()`  接口。
- 以下语法糖不再支持:
- `pointJitter()`  废弃,请使用 `point().adjust('jitter')`
- `pointDodge()`  废弃,请使用 `point().adjust('dodge')`
-  `intervalStack()` 废弃,请使用 `interval().adjust('stack')`
-  `intervalDodge()` 废弃,请使用 `interval().adjust('dodge')`
-  `intervalSymmetric()` 废弃,请使用 `interval().adjust('symmetric')`
-  `areaStack()` 废弃,请使用 `area().adjust('stack')`
-  `schemaDodge()` 废弃,请使用  `schema().adjust('stack')`
- `Venn`  以及 `Violin`  几何标记暂时移除,后续考虑以更好的方式支持。
- 移除 Interval 几何标记以下两个 shape: 'top-line' 及  'liquid-fill-gauge',用户可以通过自定义 Shape 机制自己实现。
- 移除 tail 类型的图例。
- 🗑️ `pointJitter()`  废弃,请使用 `point().adjust('jitter')`
- 🗑️ `pointDodge()`  废弃,请使用 `point().adjust('dodge')`
- 🗑️ `intervalStack()` 废弃,请使用 `interval().adjust('stack')`
- 🗑️ `intervalDodge()` 废弃,请使用 `interval().adjust('dodge')`
- 🗑️ `intervalSymmetric()` 废弃,请使用 `interval().adjust('symmetric')`
- 🗑️ `areaStack()` 废弃,请使用 `area().adjust('stack')`
- 🗑️ `schemaDodge()` 废弃,请使用  `schema().adjust('stack')`
- 🗑️ `Venn`  以及 `Violin`  几何标记暂时移除,后续考虑以更好的方式支持。
- 🗑️ 移除 Interval 几何标记以下两个 shape: 'top-line' 及  'liquid-fill-gauge',用户可以通过自定义 Shape 机制自己实现。
- 🗑️ 移除 tail 类型的图例。
- 内置常量重命名,一致使用小写 + '-' 命名规则,比如 `shape('hollowCircle')` 变更为 `shape('hollow-circle')`

#### 配置项以及接口变更
Expand Down Expand Up @@ -120,7 +120,15 @@ chart.axis('value', {

<img src="https://gw.alipayobjects.com/mdn/rms_f5c722/afts/img/A*j05pRJG3ovgAAAAAAAAAAABkARQnAQ" width=600 />

- `chart.legend()`  配置项更新,详见 [API](../api/classes/view#legend)
- `chart.legend()`  配置项更新,具体的配置见 [API](../api/classes/view#legend)。以下列举了一些 3.x 常用的属性以及 4.0 的替代方案:

- 🗑️ `clickable` 属性移除,如想要取消 legend 勾选交互,可以通过 `chart.removeInteraction('legend-filter')` 移除分类图例的勾选交互。
- 🗑️ `selectedMode` 属性移除,4.0 可通过自定义交互行为实现。
- 🗑️ `onClick` 属性移除,4.0 可通过监听 legend 事件实现:`chart.on('legend:click', (ev) => {})`
- 🗑️ `slidable` 属性移除,4.0 可以通过 `chart.removeInteraction('continuous-filter')` 移除连续图例的滑块交互。
- 🗑️ `hoverable` 属性移除,4.0 可以通过 `chart.interaction('legend-active')` 等交互行为实现,参考交互语法 demo: https://g2.antv.vision/en/examples/interaction/component#legend-active。
- 🗑️ `onHover` 属性移除,4.0 可以通过监听 legend 事件实现:`chart.on('legend:mousemove', (ev) => {})`

- `chart.axis()`  配置项更新,详见 [API](../api/classes/view#axis)
- `chart.annotation()`  各个类型的 annotation 配置项更新,详见 [API](../api/classes/view#annotation)
- `geometry().style()` 方法的回调函数写法变更,不再支持一个配置属性一个回调的方式,而是使用一个回调:
Expand Down

0 comments on commit b4451df

Please sign in to comment.