You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@echarts.apache.org by ov...@apache.org on 2021/09/06 10:20:20 UTC
[echarts-handbook] branch master updated: fix: improve table of
contents
This is an automated email from the ASF dual-hosted git repository.
ovilia pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/echarts-handbook.git
The following commit(s) were added to refs/heads/master by this push:
new 77321aa fix: improve table of contents
new 79da6d4 Merge branch 'master' of github.com:apache/incubator-echarts-handbook
77321aa is described below
commit 77321aa2019432c4f66960cc569a9c79c3067a4e
Author: Ovilia <zw...@gmail.com>
AuthorDate: Mon Sep 6 18:19:37 2021 +0800
fix: improve table of contents
---
.../en/basics/release-note/v5-upgrade-guide.md | 26 +++++++++++-----------
.../zh/basics/release-note/v5-upgrade-guide.md | 22 +++++++++---------
2 files changed, 24 insertions(+), 24 deletions(-)
diff --git a/contents/en/basics/release-note/v5-upgrade-guide.md b/contents/en/basics/release-note/v5-upgrade-guide.md
index e1ab3b4..ddd84f7 100644
--- a/contents/en/basics/release-note/v5-upgrade-guide.md
+++ b/contents/en/basics/release-note/v5-upgrade-guide.md
@@ -4,7 +4,7 @@ This guide is for those who want to upgrade from echarts 4.x (hereafter `v4`) to
## Breaking Changes
-#### Default theme
+### Default Theme
First of all, the default theme has been changed. `v5` has made a lot of changes and optimizations on the theme design. If you still want to keep the colors of the old version, you can manually declare the colors as follows.
@@ -49,9 +49,9 @@ var chart = echarts.init(dom, themeEC4);
chart.setOption(/* ... */);
```
-#### Importing ECharts
+### Importing ECharts
-##### Removing Support for Default Exports
+#### Removing Support for Default Exports
Since `v5`, echarts only provides `named exports`.
@@ -71,7 +71,7 @@ import * as echarts from 'echarts';
import * as echarts from 'echarts/lib/echarts';
```
-##### tree-shaking API
+#### Tree-shaking API
In 5.0.1, we introduced the new [tree-shaking API](${lang}/basics/import)
@@ -97,11 +97,11 @@ require('echarts/lib/component/grid');
Second, because our source code has been rewritten using TypeScript, `v5` will no longer support importing files from `echarts/src`. You need to change it to import from `echarts/lib`.
-##### Dependency Adjustment
+#### Dependency Changes
> Note: This section is only for developers who use tree-shaking interfaces to ensure a minimal bundle size, not for those who imports the whole package.
-In order to keep the size of the bundle small enough, we remove some dependencies that would have been imported by default. For example, as mentioned above, when using the new on-demand interface, `CanvasRenderer` is no longer introduced by default, which ensures that unneeded Canvas rendering code is not imported when only SVG rendering mode is used, and in addition, the following dependencies are adjusted.
+In order to keep the size of the bundle small enough, we remove some dependencies that would have been imported by default. For example, as mentioned above, when using the new on-demand interface, `CanvasRenderer` is no longer included by default, which ensures that unneeded Canvas rendering code is not imported when only SVG rendering mode is used, and in addition, the following dependencies are adjusted.
- The right-angle coordinate system component is no longer introduced by default when using line charts and bar charts, so the following introduction method was used before
@@ -132,17 +132,17 @@ Or
require('echarts/lib/component/aria');
```
-#### Removes Built-in GeoJSON
+### Built-in GeoJSON Removed
`v5` removes the built-in geoJSON (previously in the `echarts/map` folder). These geoJSON files were always sourced from third parties. If users still need them, they can go get them from the old version, or find more appropriate data and register it with ECharts via the registerMap interface.
-#### Browser Compatibility
+### Browser Compatibility
IE8 is no longer supported by `v5`. We no longer maintain and upgrade the previous [VML renderer](https://github.com/ecomfe/zrender/tree/4.3.2/src/vml) for IE8 compatibility. If developers have a strong need for a VML renderer, they are welcome to submit a pull request to upgrade the VML renderer or maintain a separate third-party VML renderer, as we support registration of standalone renderers starting with `v5.0.1`.
-#### ECharts configuration item adjustment
+### Configuration Item Adjustment
-##### Visual style settings priority change
+#### Visual Style Settings Priority Changes
The priority of the visuals between [visualMap component](${optionPath}visualMap) and [itemStyle](${optionPath}series-scatter.itemStyle) | [lineStyle](${optionPath}series-scatter.lineStyle) | [areaStyle](${optionPath}series-scatter.areaStyle) are reversed since `v5`.
@@ -150,13 +150,13 @@ That is, previously in `v4`, the visuals (i.e., color, symbol, symbolSize, ...)
In most cases, users will probably not notice this change when migrating from `v4` to `v5`. But users can still check that if [visualMap component](${optionPath}visualMap) and [itemStyle](${optionPath}series-scatter.itemStyle) | [lineStyle](${optionPath}series-scatter.lineStyle) | [areaStyle](${optionPath}series-scatter.areaStyle) are both specified.
-##### `padding` for Rich Text
+#### `padding` for Rich Text
`v5` adjusts the [rich.?.padding](${optionPath}series-scatter.label.rich.<style_name>.padding) to make it more compliant with CSS specifications. In `v4`, for example `rich. .padding: [11, 22, 33, 44]` means that `padding-top` is `33` and `padding-bottom` is `11`. The position of the top and bottom is adjusted in `v5`, `rich. .padding: [11, 22, 33, 44]` means that `padding-top` is `11` and `padding-bottom` is `33`.
If the user is using [rich.?.padding](${optionPath}series-scatter.label.rich.<style_name>.padding), this order needs to be adjusted.
-## ECharts Related Extensions
+## Extensions
These extensions need to be upgraded to new version to support echarts `v5`:
@@ -164,7 +164,7 @@ These extensions need to be upgraded to new version to support echarts `v5`:
- [echarts-wordcloud](https://github.com/ecomfe/echarts-wordcloud)
- [echarts-liquidfill](https://github.com/ecomfe/echarts-liquidfill)
-## Deprecated API
+## Deprecated APIs
Some of the API and echarts options are deprecated since `v5`, but are still backward compatible. Users can **keep using these deprecated API**, with only some warning will be printed to console in dev mode. But if users have spare time, it is recommended to upgraded to new API for the consideration of long term maintenance.
diff --git a/contents/zh/basics/release-note/v5-upgrade-guide.md b/contents/zh/basics/release-note/v5-upgrade-guide.md
index 6f25617..716123b 100644
--- a/contents/zh/basics/release-note/v5-upgrade-guide.md
+++ b/contents/zh/basics/release-note/v5-upgrade-guide.md
@@ -4,7 +4,7 @@
## 非兼容性改变
-#### 默认主题（theme）
+### 默认主题（theme）
首先是默认主题的改动，`v5` 在配色等主题设计上做了很多的优化来达到更好的视觉效果。如果大家依旧想保留旧版本的颜色，可以手动声明颜色，如下：
@@ -49,9 +49,9 @@ var chart = echarts.init(dom, themeEC4);
chart.setOption(/* ... */);
```
-#### 引用 ECharts
+### 引用 ECharts
-##### 去除 default exports 的支持
+#### 去除 default exports 的支持
如果使用者在 `v4` 中这样引用了 echarts：
@@ -71,7 +71,7 @@ import * as echarts from 'echarts';
import * as echarts from 'echarts/lib/echarts';
```
-##### 按需引入
+#### 按需引入
在 5.0.1 中，我们引入了新的[按需引入接口](${lang}/basics/import)
@@ -99,7 +99,7 @@ require('echarts/lib/component/grid');
其次，因为我们的源代码已使用 TypeScript 重写，`v5` 将不再支持从 `echarts/src` 引用文件，需要改为从`echarts/lib`引入。
-##### 依赖调整
+#### 依赖调整
> 注意：该部分只针对为了保证较小的打包体积而是用按需引入接口的开发者，如果是全量引入的不需要关注
@@ -134,17 +134,17 @@ echarts.use(AriaComponent);
require('echarts/lib/component/aria');
```
-#### 去除内置的 geoJSON
+### 去除内置的 geoJSON
`v5` 移除了内置的 geoJSON（原先在 `echarts/map` 文件夹下）。这些 geoJSON 文件本就一直来源于第三方。如果使用者仍然需要他们，可以去从老版本中得到，或者自己寻找更合适的数据然后通过 registerMap 接口注册到 ECharts 中。
-#### 浏览器兼容性
+### 浏览器兼容性
`v5` 不再支持 IE8 浏览器。我们不再继续维护和升级之前的 [VML 渲染器](https://github.com/ecomfe/zrender/tree/4.3.2/src/vml) 来着实现 IE8 的兼容。如果使用者确实有很强的需求，那么欢迎提 pull request 来升级 VML 渲染器，或者单独维护一个第三方 VML 渲染器，我们从 `v5.0.1` 开始支持注册独立的渲染器了。
-#### ECharts 配置项调整
+### 配置项调整
-##### 视觉样式设置的优先级改变
+#### 视觉样式设置的优先级改变
`v5` 对调了 [visualMap 组件](${optionPath}visualMap) 和 [itemStyle](${optionPath}series-scatter.itemStyle) | [lineStyle](${optionPath}series-scatter.lineStyle) | [areaStyle](${optionPath}series-scatter.areaStyle) 的视觉样式优先级。
@@ -152,13 +152,13 @@ require('echarts/lib/component/aria');
在绝大多处情况下，这个变化并不会带来什么影响。但是为保险起见，使用者在升级 `v4` 到 `v5` 时，还是可以检查下，是否有同时使用 [visualMap](${optionPath}visualMap) 和 [itemStyle](${optionPath}series-scatter.itemStyle) | [lineStyle](${optionPath}series-scatter.lineStyle) | [areaStyle](${optionPath}series-scatter.areaStyle) 的情况。
-##### 富文本的 `padding`
+#### 富文本的 `padding`
`v5` 调整了 [rich.?.padding](${optionPath}series-scatter.label.rich.<style_name>.padding) 的格式使其更符合 CSS 的规范。`v4` 里，例如 `rich.?.padding: [11, 22, 33, 44]` 表示 `padding-top` 是 `33` 且 `padding-bottom` 是 `11`。在 `v5` 中调整了上下的位置，`rich.?.padding: [11, 22, 33, 44]` 表示 `padding-top` 是 `11` 且 `padding-bottom` 是 `33`。
如果使用者有在使用 [rich.?.padding](${optionPath}series-scatter.label.rich.<style_name>.padding)，需要注意调整下这个顺序。
-## ECharts 的相关扩展
+## 扩展的兼容
如果想要升级到 `v5` ，下面这些扩展需要升级到最新的版本实现兼容。
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@echarts.apache.org
For additional commands, e-mail: commits-help@echarts.apache.org