You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@echarts.apache.org by su...@apache.org on 2025/08/06 22:21:33 UTC
(echarts-doc) branch v6-doc-supplement-2 updated (19fdd60c -> 9328d92d)
This is an automated email from the ASF dual-hosted git repository.
sushuang pushed a change to branch v6-doc-supplement-2
in repository https://gitbox.apache.org/repos/asf/echarts-doc.git
from 19fdd60c Add doc for preserveAspect.
new 5c870a45 Tweak geoJSON example api.
new 9328d92d Add doc geo.clip and roamTrigger.
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
en/api/echarts.md | 105 ++++++++++++++++++++++++------------
en/option/component/axis-common.md | 2 +
en/option/component/geo-common.md | 17 +++++-
en/option/partial/coord-sys.md | 2 +-
en/option/partial/view-coord-sys.md | 53 +++++++++++++++---
en/option/series/sankey.md | 3 +-
en/option/series/tree.md | 3 +-
zh/api/echarts.md | 104 ++++++++++++++++++++++++-----------
zh/option/component/axis-common.md | 2 +
zh/option/component/geo-common.md | 16 +++++-
zh/option/partial/coord-sys.md | 2 +-
zh/option/partial/view-coord-sys.md | 56 ++++++++++++++++---
zh/option/series/sankey.md | 3 +-
zh/option/series/tree.md | 3 +-
14 files changed, 284 insertions(+), 87 deletions(-)
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@echarts.apache.org
For additional commands, e-mail: commits-help@echarts.apache.org
(echarts-doc) 01/02: Tweak geoJSON example api.
Posted by su...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
sushuang pushed a commit to branch v6-doc-supplement-2
in repository https://gitbox.apache.org/repos/asf/echarts-doc.git
commit 5c870a4558a8830d88b7fcba5c6a75591fcba64e
Author: 100pah <su...@gmail.com>
AuthorDate: Thu Aug 7 06:20:45 2025 +0800
Tweak geoJSON example api.
---
en/api/echarts.md | 105 ++++++++++++++++++++++++++++++++++++------------------
zh/api/echarts.md | 104 ++++++++++++++++++++++++++++++++++++-----------------
2 files changed, 143 insertions(+), 66 deletions(-)
diff --git a/en/api/echarts.md b/en/api/echarts.md
index e430abe8..06cb9ddc 100644
--- a/en/api/echarts.md
+++ b/en/api/echarts.md
@@ -159,49 +159,86 @@ Registers available maps. This can only be used after including [geo](option.htm
Please refer to [option.geo](option.html#geo.map) for usage.
-**Parameters**
-+ `mapName`
+**Parameters:**
++ **@param `mapName`:**
Map name, referring to `map` value set in [geo](option.html#geo) component or [map](option.html#series-map).
-+ `opt`
++ **@param `opt.geoJSON`:**
- + `geoJSON` Optional. Data in GeoJson format. See [https://geojson.org/](https://geojson.org/) for more format information. Can be a JSON string or a parsed object. This key can also be `geoJson`.
+ Optional. Data in GeoJSON format. See [https://geojson.org/](https://geojson.org/) for more format information. Can be a JSON string or a parsed object. This key can also be `geoJson`.
- + `svg` Optional. Data in SVG format. Can be a SVG string or a parsed SVG DOM object. See more info in [SVG Base Map](tutorial.html#SVG%20Base%20Map%20in%20Geo%20Coords%20and%20Map%20SeriesSVG%20Base%20Map). Introduced in v5.1.0
+ For example, A minimal geoJSON:
+ ```ts
+ const geoJSONSample = {
+ "type": "FeatureCollection",
+ "features": [
+ {
+ "type": "Feature",
+ "geometry": {
+ "type": "Polygon",
+ "coordinates": [
+ [[200, 3000], [500, 3000], [500, 5000], [200, 5000]]
+ ]
+ },
+ "properties": {
+ "name": "Some Place",
+ "cp": [220, 2100]
+ }
+ }
+ ]
+ };
+ echarts.registerMap('my_geo_sample', {geoJSON: geoJSONSample});
+ ```
+ Note:
+ + `features[i].properties.name` in GeoJSON is required by ECharts to query the corresponding region, or display the label. Property `name` is used by default, but can also be other properties, see [geo.nameProperty](option.html#geo.nameProperty).
+ + `features[i].properties.cp` is an optional property that ECharts can recoganize. It provides coordinates on which the label can be displayed. If not provided, the label will be displayed at the center of the region.
- + `specialAreas` Optional. zoomed part of a specific area in the map for better visual effect. Only work for `geoJSON`.
++ **@param `opt.svg`:**
-**For example [USA Population Estimates](${galleryEditorPath}map-usa): **
-```ts
-echarts.registerMap('USA', usaJson, {
- // Move Alaska to the bottom left of United States
- Alaska: {
- // Upper left longitude
- left: -131,
- // Upper left latitude
- top: 25,
- // Range of longitude
- width: 15
- },
- // Hawaii
- Hawaii: {
- left: -110,
- top: 28,
- width: 5
- },
- // Puerto Rico
- 'Puerto Rico': {
- left: -76,
- top: 26,
- width: 2
- }
-});
-```
+ Optional. Data in SVG format. Can be a SVG string or a parsed SVG DOM object. See more info in [SVG Base Map](tutorial.html#SVG%20Base%20Map%20in%20Geo%20Coords%20and%20Map%20SeriesSVG%20Base%20Map). Introduced in `v5.1.0`.
-Note:
+ For example, A minimal SVG:
+ ```ts
+ const mySVG = `<?xml version="1.0" encoding="utf-8"?>
+ <svg xmlns="http://www.w3.org/2000/svg" xmlns:ooo="http://xml.openoffice.org/svg/export" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.2" fill-rule="evenodd" xml:space="preserve">
+ <path name="left_rect" d="M 0,0 L 0,100 100,100 100,0 Z" fill="#765" stroke="rgb(56,93,138)" stroke-width="0" stroke-linecap="square" stroke-linejoin="miter"/>
+ </svg>`;
+ echarts.registerMap('my_geo_sample', {svg: mySVG});
+ ```
+
++ **@param `opt.specialAreas`:**
+
+ Optional. zoomed part of a specific area in the map for better visual effect. Only work for `geoJSON`.
+
+ **[An example of specialAreas](${galleryEditorPath}map-usa): **
+ ```ts
+ echarts.registerMap('USA', usaJson, {
+ // Move Alaska to the bottom left of United States
+ Alaska: {
+ // Upper left longitude
+ left: -131,
+ // Upper left latitude
+ top: 25,
+ // Range of longitude
+ width: 15
+ },
+ // Hawaii
+ Hawaii: {
+ left: -110,
+ top: 28,
+ width: 5
+ },
+ // Puerto Rico
+ 'Puerto Rico': {
+ left: -76,
+ top: 26,
+ width: 2
+ }
+ });
+ ```
-If you only import the required components in your project, starting from v5.3.0 `registerMap` has to be used after the `MapChart` or `GeoComponent` is imported.
+Note: If you only import the required components in your project, starting from v5.3.0 `registerMap` cannot be called unless `MapChart` or `GeoComponent` is imported (ES module import).
## getMap(Function)
```ts
diff --git a/zh/api/echarts.md b/zh/api/echarts.md
index 6aafeb7b..e08cf795 100644
--- a/zh/api/echarts.md
+++ b/zh/api/echarts.md
@@ -158,47 +158,87 @@ echarts.use(
使用方法见 [option.geo](option.html#geo.map)。
**参数：**
-+ `mapName`
++ **@param `mapName`:**
地图名称，在 [geo](option.html#geo) 组件或者 [map](option.html#series-map) 图表类型中设置的 `map` 对应的就是该值。
-+ `opt`
- + `geoJSON` 可选。GeoJson 格式的数据，具体格式见 [https://geojson.org/](https://geojson.org/)。可以是 JSON 字符串，也可以是解析得到的对象。这个参数也可以写为 `geoJson`，效果相同。
++ **@param `opt.geoJSON`:**
- + `svg` 可选。从 `v5.1.0` 开始支持SVG 格式的数据。可以是字符串，也可以是解析得到的 SVG DOM 对象。更多信息参见 [SVG 底图](tutorial.html#%E5%9C%B0%E7%90%86%E5%9D%90%E6%A0%87%E7%B3%BB%E5%92%8C%E5%9C%B0%E5%9B%BE%E7%B3%BB%E5%88%97%E7%9A%84%20SVG%20%E5%BA%95%E5%9B%BE)。
+ 可选。GeoJSON 格式的数据，具体格式见 [https://geojson.org/](https://geojson.org/)。可以是 JSON 字符串，也可以是解析得到的对象。这个参数也可以写为 `geoJson`，效果相同。
- + `specialAreas` 可选。将地图中的部分区域缩放到合适的位置，可以使得整个地图的显示更加好看。只在 `geoJSON` 中生效，`svg` 中不生效。
+ 例如，一个极小的 GeoJSON：
+ ```ts
+ const geoJSONSample = {
+ "type": "FeatureCollection",
+ "features": [
+ {
+ "type": "Feature",
+ "geometry": {
+ "type": "Polygon",
+ "coordinates": [
+ [[2000, 2000], [5000, 2000], [5000, 5000], [2000, 5000]]
+ ]
+ },
+ "properties": {
+ "name": "Some Place",
+ "cp": [220, 2100]
+ }
+ }
+ ]
+ };
+ echarts.registerMap('my_geo_sample', geoJSONSample);
+ ```
+ 注：
+ + GeoJSON 中的 `features[i].properties.name` 被 ECharts 默认使用来索引这个区域，或者显示图标文字。也可以使用其他属性名，参见 [geo.nameProperty](option.html#geo.nameProperty)。
+ Note:
+ + GeoJSON 中的 `features[i].properties.cp` 是个 ECharts 可识别的可选属性。它提供了标签的位置坐标。如果没有提供，标签自动放置在相应区域的中心。
-示例 [USA Population Estimates](${galleryEditorPath}map-usa)：
++ **@param `opt.svg`:**
-```ts
-echarts.registerMap('USA', usaJson, {
- // 把阿拉斯加移到美国主大陆左下方
- Alaska: {
- // 左上角经度
- left: -131,
- // 左上角纬度
- top: 25,
- // 经度横跨的范围
- width: 15
- },
- // 夏威夷
- Hawaii: {
- left: -110,
- top: 28,
- width: 5
- },
- // 波多黎各
- 'Puerto Rico': {
- left: -76,
- top: 26,
- width: 2
- }
-});
-```
+ 可选。从 `v5.1.0` 开始支持SVG 格式的数据。可以是字符串，也可以是解析得到的 SVG DOM 对象。更多信息参见 [SVG 底图](tutorial.html#%E5%9C%B0%E7%90%86%E5%9D%90%E6%A0%87%E7%B3%BB%E5%92%8C%E5%9C%B0%E5%9B%BE%E7%B3%BB%E5%88%97%E7%9A%84%20SVG%20%E5%BA%95%E5%9B%BE)。
+
+ 例如，一个极小的 SVG：
+ ```ts
+ const mySVG = `<?xml version="1.0" encoding="utf-8"?>
+ <svg xmlns="http://www.w3.org/2000/svg" xmlns:ooo="http://xml.openoffice.org/svg/export" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.2" fill-rule="evenodd" xml:space="preserve">
+ <path name="left_rect" d="M 0,0 L 0,100 100,100 100,0 Z" fill="#765" stroke="rgb(56,93,138)" stroke-width="0" stroke-linecap="square" stroke-linejoin="miter"/>
+ </svg>`;
+ echarts.registerMap('my_geo_sample', {svg: mySVG});
+ ```
+
++ **@param `opt.specialAreas`:**
+
+ 可选。将地图中的部分区域缩放到合适的位置，可以使得整个地图的显示更加好看。只在 `geoJSON` 中生效，`svg` 中不生效。
+
+ [specialAreas 示例](${galleryEditorPath}map-usa)：
+ ```ts
+ echarts.registerMap('USA', usaJson, {
+ // 把阿拉斯加移到美国主大陆左下方
+ Alaska: {
+ // 左上角经度
+ left: -131,
+ // 左上角纬度
+ top: 25,
+ // 经度横跨的范围
+ width: 15
+ },
+ // 夏威夷
+ Hawaii: {
+ left: -110,
+ top: 28,
+ width: 5
+ },
+ // 波多黎各
+ 'Puerto Rico': {
+ left: -76,
+ top: 26,
+ width: 2
+ }
+ });
+ ```
-注：如果你在项目中使用了按需引入，从 v5.3.0 开始`registerMap`必须要在引入地图组件后才能使用。
+注：如果你在项目中使用了按需引入，从 v5.3.0 开始 `registerMap` 必须要在`MapChart` 或 `GeoComponent` 被 `import`（ES module import）后才能使用。
## getMap(Function)
```ts
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@echarts.apache.org
For additional commands, e-mail: commits-help@echarts.apache.org
(echarts-doc) 02/02: Add doc geo.clip and roamTrigger.
Posted by su...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
sushuang pushed a commit to branch v6-doc-supplement-2
in repository https://gitbox.apache.org/repos/asf/echarts-doc.git
commit 9328d92d2ac83f2b7250a0dde44c032080a69d1d
Author: 100pah <su...@gmail.com>
AuthorDate: Thu Aug 7 06:21:20 2025 +0800
Add doc geo.clip and roamTrigger.
---
en/option/component/axis-common.md | 2 ++
en/option/component/geo-common.md | 17 ++++++++++-
en/option/partial/coord-sys.md | 2 +-
en/option/partial/view-coord-sys.md | 53 +++++++++++++++++++++++++++++++----
en/option/series/sankey.md | 3 +-
en/option/series/tree.md | 3 +-
zh/option/component/axis-common.md | 2 ++
zh/option/component/geo-common.md | 16 ++++++++++-
zh/option/partial/coord-sys.md | 2 +-
zh/option/partial/view-coord-sys.md | 56 ++++++++++++++++++++++++++++++++-----
zh/option/series/sankey.md | 3 +-
zh/option/series/tree.md | 3 +-
12 files changed, 141 insertions(+), 21 deletions(-)
diff --git a/en/option/component/axis-common.md b/en/option/component/axis-common.md
index 41482796..8642911f 100644
--- a/en/option/component/axis-common.md
+++ b/en/option/component/axis-common.md
@@ -654,6 +654,8 @@ The content displayed at the end of the text after truncation.
{{ if: ${componentType} === 'xAxis' || ${componentType} === 'yAxis' }}
#${prefix} nameMoveOverlap(boolean) = true
+<ExampleUIControlBoolean default="true"/>
+
{{ use: partial-version(version = "6.0.0") }}
Whether to move axis name to avoid overlap with axis labels.
diff --git a/en/option/component/geo-common.md b/en/option/component/geo-common.md
index 1c422638..5337e181 100644
--- a/en/option/component/geo-common.md
+++ b/en/option/component/geo-common.md
@@ -167,7 +167,8 @@ Note: `stream` is not required in the `projection`.
{{ use: partial-view-coord-sys-common(
prefix = ${prefix},
componentMainType = ${componentMainType},
- componentSubType = ${componentSubType}
+ componentSubType = ${componentSubType},
+ supportClip = true
) }}
@@ -342,6 +343,20 @@ Size of map, see [layoutCenter](${componentNameInLink}.layoutCenter) for more in
componentNameInLink = ${componentNameInLink}
) }}
+#${prefix} clip(boolean) = false
+
+{{ use: partial-version(version = "6.0.0") }}
+
+{{ use: partial-view-coord-sys-allocated-rect-desc(
+ componentNameReadable = ${componentNameReadable},
+ componentNameInLink = ${componentNameInLink},
+ isGeoOrMap = true
+) }}
+
+`clip` specifies whether to hide the outside part of the map with respect to the allocated rect.
+
+**See example:** [geo roam indicator](${galleryEditorPath}doc-example/geo-roam-indicator&edit=1&reset=1).
+
{{ target: partial-geo-common-state }}
diff --git a/en/option/partial/coord-sys.md b/en/option/partial/coord-sys.md
index 3b4eebbc..4efbf8d7 100644
--- a/en/option/partial/coord-sys.md
+++ b/en/option/partial/coord-sys.md
@@ -276,7 +276,7 @@ When `geoIndex` or `geoId` is specified, [series-map.map](~series-map.map) other
## geoId(number) = undefined
{{ if: ${version} }}
-{{ use: partial-version(version = ${version}) }}
+{{ use: partial-version(version = ${version|minVersion('6.0.0')}) }}
{{ /if }}
The id of the [geographic coordinate system](~geo) to base on. When mutiple `geographic` exist within an ECharts instance, use this to specify the corresponding `geographic`.
diff --git a/en/option/partial/view-coord-sys.md b/en/option/partial/view-coord-sys.md
index 0f2ad29f..99bdbf50 100644
--- a/en/option/partial/view-coord-sys.md
+++ b/en/option/partial/view-coord-sys.md
@@ -116,27 +116,58 @@ When [roaming](~${componentNameInLink}.roam), the values in [center](~${componen
When roaming, the values in [center](~${componentNameInLink}.center) and [zoom](~${componentNameInLink}.zoom) will be modified correspondingly.
+#${prefix} roamTrigger(string) = ${roamTriggerDefault|default("'selfRect'")}
+{{ use: partial-version(version = "6.0.0") }}
+
+[Roaming](~${componentNameInLink}.roam) can be triggered by mouse dragging or mouse wheel.
+
+Options:
+- `'selfRect'`:
+
+ The roaming can only be triggered on the bounding rect of the graphic elements.
+
+- `'global'`:
+
+ {{ if: ${supportClip} }}If `clip: true`, the roaming can only be triggered at any position within the clipped area. Otherwise it can be triggered in canvas globally.{{ else }}The roaming can be triggered in canvas globally.{{ /if }}
+
+{{ if: ${isGeoOrMap} }}
+**See example:** [geo roam indicator](${galleryEditorPath}doc-example/geo-roam-indicator&edit=1&reset=1).
+{{ /if }}
{{ target: partial-preserve-aspect }}
#${prefix} preserveAspect(boolean|string) = ${preserveAspectDefault|default(false)}
+{{ if: ${componentNameInLink} === 'geo' || ${componentNameInLink} === 'series-map' }}
+{{ var: isGeoOrMap = true }}
+{{ /if }}
+
<ExampleUIControlBoolean default="false" />
{{ use: partial-version(version = "6.0.0") }}
-`aspect ratio` here refers to `width / height` of the original bounding rect of the content to be rendered.
+`aspect ratio` here refers to `width / height`.
-Suppose a `rectangular area` allocated to `${componentNameReadable}` is defined by [${componentNameInLink}.left](~${componentNameInLink}.left) / [.right](~${componentNameInLink}.right) / [.top](~${componentNameInLink}.top) / [.bottom](~${componentNameInLink}.bottom) / [.width](~${componentNameInLink}.width) / [.height](~${componentNameInLink}.height).
+"preserve aspect" refers whether to preserve the `aspect ratio` of the original bounding rect of the content to be rendered.
+
+{{ use: partial-view-coord-sys-allocated-rect-desc(
+ componentNameReadable = ${componentNameReadable},
+ componentNameInLink = ${componentNameInLink},
+ isGeoOrMap = ${isGeoOrMap}
+) }}
+
+But the `aspect ratio` of this rectangle may not match that of the content's original bounding rect, which may cause distortion.
Options of `preserveAspect`:
-- `null`/`undefined`/`false` (default): `aspect ratio` will not be preserved, but stretched to fill the `${componentNameReadable} rectangular area`, which may cause distortion.
-- `'contain'`/`true`: The `aspect ratio` is preserved; the bounding rect of the content are fully contained by the `${componentNameReadable} rectangular area`, and scaled up as much as possible to meet the `${componentNameReadable} rectangular area`. [preserveAspectAlign](~${componentNameInLink}.preserveAspectAlign) and [preserveAspectVerticalAlign](~${componentNameInLink}.preserveAspectVerticalAlign) can be used to adjust the position in this case.
-- `'cover'`: The `aspect ratio` is preserved; the bounding rect of the content covers the `${componentNameReadable} rectangular area`, and scaled down as much as possible to meet the `${componentNameReadable} rectangular area`. [preserveAspectAlign](~${componentNameInLink}.preserveAspectAlign) and [preserveAspectVerticalAlign](~${componentNameInLink}.preserveAspectVerticalAlign) can be used to adjust the position in this case.
+- `null`/`undefined`/`false` (default): The original `aspect ratio` of the content will not be preserved, but stretched to fill the `${componentNameReadable} rectangular area`, which may cause distortion.
+- `'contain'`/`true`: The original `aspect ratio` of the content is preserved; the bounding rect of the content are fully contained by the `${componentNameReadable} rectangular area`, and scaled up as much as possible to meet the `${componentNameReadable} rectangular area`. [preserveAspectAlign](~${componentNameInLink}.preserveAspectAlign) and [preserveAspectVerticalAlign](~${componentNameInLink}.preserveAspectVerticalAlign) can be used to adjust the position in this case.
+- `'cover'`: The original `aspect ratio` of the content is preserved; the bounding rect of the content covers the `${componentNameReadable} rectangular area`, and scaled down as much as possible to meet the `${componentNameReadable} rectangular area`. [preserveAspectAlign](~${componentNameInLink}.preserveAspectAlign) and [preserveAspectVerticalAlign](~${componentNameInLink}.preserveAspectVerticalAlign) can be used to adjust the position in this case.
-{{ if: (${componentNameInLink} === 'geo' || ${componentNameInLink} === 'series-map') }}
+{{ if: ${isGeoOrMap} }}
Notice: When using [layoutCenter](~${componentNameInLink}.layoutCenter) and [layoutSize](~${componentNameInLink}.layoutSize), the `aspect radio` is always preserved, regardless of this `preserveAspect`.
+
+**See example:** [geo roam indicator](${galleryEditorPath}doc-example/geo-roam-indicator&edit=1&reset=1).
{{ /if }}
#${prefix} preserveAspectAlign(string) = 'center'
@@ -149,6 +180,8 @@ Options: `'left'` | `'right'` | `'center'`.
See [preserveAspect](~${componentNameInLink}.preserveAspect).
+See example [geo roam indicator](${galleryEditorPath}doc-example/geo-roam-indicator&edit=1&reset=1).
+
#${prefix} preserveAspectVerticalAlign(string) = 'middle'
<ExampleUIControlEnum options="top,bottom,middle" default="middle" />
@@ -158,3 +191,11 @@ See [preserveAspect](~${componentNameInLink}.preserveAspect).
Options: `'top'` | `'bottom'` | `'middle'`.
See [preserveAspect](~${componentNameInLink}.preserveAspect).
+
+See example [geo roam indicator](${galleryEditorPath}doc-example/geo-roam-indicator&edit=1&reset=1).
+
+
+
+{{ target: partial-view-coord-sys-allocated-rect-desc }}
+
+A `rectangular area` allocated to `${componentNameReadable}` is determined by [${componentNameInLink}.left](~${componentNameInLink}.left) / [.right](~${componentNameInLink}.right) / [.top](~${componentNameInLink}.top) / [.bottom](~${componentNameInLink}.bottom) / [.width](~${componentNameInLink}.width) / [.height](~${componentNameInLink}.height){{ if: ${isGeoOrMap} }} / [.aspectScale](~${componentNameInLink}.aspectScale){{ /if }}.
\ No newline at end of file
diff --git a/en/option/series/sankey.md b/en/option/series/sankey.md
index 399c898e..16d0b10b 100644
--- a/en/option/series/sankey.md
+++ b/en/option/series/sankey.md
@@ -95,7 +95,8 @@ The drag-and-drop interaction of the node, which is enabled by default. After op
{{ use: partial-view-coord-sys-common(
prefix = '#',
componentMainType = 'series',
- componentSubType = 'sankey'
+ componentSubType = 'sankey',
+ roamTriggerDefault = "'global'",
) }}
diff --git a/en/option/series/tree.md b/en/option/series/tree.md
index 06856bdf..83c5fde1 100644
--- a/en/option/series/tree.md
+++ b/en/option/series/tree.md
@@ -48,7 +48,8 @@ The tree diagram is mainly used to visualize the tree data structure, which is a
{{ use: partial-view-coord-sys-common(
prefix = '#',
componentMainType = 'series',
- componentSubType = 'tree'
+ componentSubType = 'tree',
+ roamTriggerDefault = "'global'"
) }}
diff --git a/zh/option/component/axis-common.md b/zh/option/component/axis-common.md
index d17e064d..a1904f0f 100644
--- a/zh/option/component/axis-common.md
+++ b/zh/option/component/axis-common.md
@@ -650,6 +650,8 @@ splitLine: {
{{ if: ${componentType} === 'xAxis' || ${componentType} === 'yAxis' }}
#${prefix} nameMoveOverlap(boolean) = true
+<ExampleUIControlBoolean default="true"/>
+
{{ use: partial-version(version = "6.0.0") }}
当 axis name 和 axis label 重叠时，是否自动移动 axis name 来避免重叠。
diff --git a/zh/option/component/geo-common.md b/zh/option/component/geo-common.md
index 0770313f..67cb49a8 100644
--- a/zh/option/component/geo-common.md
+++ b/zh/option/component/geo-common.md
@@ -165,7 +165,8 @@ series: {
{{ use: partial-view-coord-sys-common(
prefix = ${prefix},
componentMainType = ${componentMainType},
- componentSubType = ${componentSubType}
+ componentSubType = ${componentSubType},
+ supportClip = true
) }}
@@ -336,6 +337,19 @@ layoutSize: 100
componentNameInLink = ${componentNameInLink}
) }}
+#${prefix} clip(boolean) = false
+
+{{ use: partial-version(version = "6.0.0") }}
+
+{{ use: partial-view-coord-sys-allocated-rect-desc(
+ componentNameReadable = ${componentNameReadable},
+ componentNameInLink = ${componentNameInLink},
+ isGeoOrMap = true
+) }}
+
+当地图超出这个分配的矩形区域时，`clip` 决定了是否剪裁超出部分。
+
+**参见示例：** [geo roam indicator](${galleryEditorPath}doc-example/geo-roam-indicator&edit=1&reset=1).
{{ target: partial-geo-common-state }}
diff --git a/zh/option/partial/coord-sys.md b/zh/option/partial/coord-sys.md
index ea32c5c7..c050e006 100644
--- a/zh/option/partial/coord-sys.md
+++ b/zh/option/partial/coord-sys.md
@@ -279,7 +279,7 @@
## geoId(number) = undefined
{{ if: ${version} }}
-{{ use: partial-version(version = ${version}) }}
+{{ use: partial-version(version = ${version|minVersion('6.0.0')}) }}
{{ /if }}
布局时所基于的 [地理坐标系](~geo) 的 id。当一个 ECharts 实例中存在多个地理坐标系时，用其指定所使用的坐标系。
diff --git a/zh/option/partial/view-coord-sys.md b/zh/option/partial/view-coord-sys.md
index 487b11e2..0788a6a9 100644
--- a/zh/option/partial/view-coord-sys.md
+++ b/zh/option/partial/view-coord-sys.md
@@ -115,6 +115,24 @@ center: ['50%', '50%']
当缩放和平移时，[center](~${componentNameInLink}.center) 和 [zoom](~${componentNameInLink}.zoom) 的值会被相应改变。
+#${prefix} roamTrigger(string) = ${roamTriggerDefault|default("'selfRect'")}
+
+{{ use: partial-version(version = "6.0.0") }}
+
+[缩放和平移（roam）](~${componentNameInLink}.roam) 可被鼠标触发。
+
+Options:
+- `'selfRect'`:
+
+ 缩放和平移的触发点只能是图形元素形成的包围盒中。
+
+- `'global'`:
+
+ {{ if: ${supportClip} }}如果 `clip: true`，缩放和平移的触发点是剪裁矩形中的任何地方；否则，触发点是画布中的任何地方。{{ else }}缩放和平移的触发点是画布中的任何地方。{{ /if }}
+
+{{ if: ${isGeoOrMap} }}
+参见示例 [geo roam indicator](${galleryEditorPath}doc-example/geo-roam-indicator&edit=1&reset=1).
+{{ /if }}
{{ target: partial-geo-preserve-aspect }}
@@ -123,22 +141,35 @@ center: ['50%', '50%']
#${prefix} preserveAspect(boolean|string) = ${preserveAspectDefault|default(false)}
+{{ if: ${componentNameInLink} === 'geo' || ${componentNameInLink} === 'series-map' }}
+{{ var: isGeoOrMap = true }}
+{{ /if }}
+
<ExampleUIControlBoolean default="false" />
{{ use: partial-version(version = "6.0.0") }}
-`aspect ratio`（宽高比）在此处指的是要渲染的内容的原始包围盒的 `width / height`。
+`aspect ratio` 指 `width / height`。
+
+"preserve aspect" 指是否要保持被渲染的内容的原始包围盒的 `aspect ratio`。
+
+{{ use: partial-view-coord-sys-allocated-rect-desc(
+ componentNameReadable = ${componentNameReadable},
+ componentNameInLink = ${componentNameInLink},
+ isGeoOrMap = ${isGeoOrMap}
+) }}
-假设为 ${componentNameReadable} 分配的 `矩形区域` 是通过以下配置定义的：
-[${componentNameInLink}.left](~${componentNameInLink}.left) / [.right](~${componentNameInLink}.right) / [.top](~${componentNameInLink}.top) / [.bottom](~${componentNameInLink}.bottom) / [.width](~${componentNameInLink}.width) / [.height](~${componentNameInLink}.height)。
+但是这个矩形的 `aspect ratio` 不一定和内容的原始 `aspect ratio` 一致，从而可能导致内容被拉伸而失真。
`preserveAspect` 的不同选项有如下效果：
-- `null` / `undefined` / `false`（默认）：不会保留宽高比，而是拉伸内容以填满 `${componentNameReadable}矩形区域`。拉伸有可能导致图形失真。
-- `'contain'` / `true`：保留宽高比。内容的包围盒被完整地包含在 `${componentNameReadable}矩形区域` 中，并尽可能放大以触达边界。此时可使用 [preserveAspectAlign](~${componentNameInLink}.preserveAspectAlign) 和 [preserveAspectVerticalAlign](~${componentNameInLink}.preserveAspectVerticalAlign) 调整位置。
-- `'cover'`：保留宽高比。内容的包围盒会覆盖整个 `${componentNameReadable}矩形区域`，并尽可能缩小以触达边界。此时可使用 [preserveAspectAlign](~${componentNameInLink}.preserveAspectAlign) 和 [preserveAspectVerticalAlign](~${componentNameInLink}.preserveAspectVerticalAlign) 调整位置。
+- `null` / `undefined` / `false`（默认）：不会保持内容的原始 `aspect ratio`，而是拉伸内容以填满 `${componentNameReadable}矩形区域`。拉伸有可能导致图形失真。
+- `'contain'` / `true`：保持内容的 `aspect ratio`。内容的包围盒被完整地包含在 `${componentNameReadable}矩形区域` 中，并尽可能放大以触达边界。此时可使用 [preserveAspectAlign](~${componentNameInLink}.preserveAspectAlign) 和 [preserveAspectVerticalAlign](~${componentNameInLink}.preserveAspectVerticalAlign) 调整位置。
+- `'cover'`：保持内容的原始 `aspect ratio`。内容的包围盒会覆盖整个 `${componentNameReadable}矩形区域`，并尽可能缩小以触达边界。此时可使用 [preserveAspectAlign](~${componentNameInLink}.preserveAspectAlign) 和 [preserveAspectVerticalAlign](~${componentNameInLink}.preserveAspectVerticalAlign) 调整位置。
-{{ if: (${componentNameInLink} === 'geo' || ${componentNameInLink} === 'series-map') }}
+{{ if: ${isGeoOrMap} }}
注意：当使用 [layoutCenter](~${componentNameInLink}.layoutCenter) 和 [layoutSize](~${componentNameInLink}.layoutSize) 时，始终会保留宽高比，无论 `preserveAspect` 配置为何值。
+
+**参见示例：** [geo roam indicator](${galleryEditorPath}doc-example/geo-roam-indicator&edit=1&reset=1).
{{ /if }}
#${prefix} preserveAspectAlign(string) = 'center'
@@ -151,6 +182,8 @@ center: ['50%', '50%']
参见 [preserveAspect](~${componentNameInLink}.preserveAspect)。
+参见示例 [geo roam indicator](${galleryEditorPath}doc-example/geo-roam-indicator&edit=1&reset=1).
+
#${prefix} preserveAspectVerticalAlign(string) = 'middle'
<ExampleUIControlEnum options="top,bottom,middle" default="middle" />
@@ -160,3 +193,12 @@ center: ['50%', '50%']
Options: `'top'` | `'bottom'` | `'middle'`。
参见 [preserveAspect](~${componentNameInLink}.preserveAspect)。
+
+参见示例 [geo roam indicator](${galleryEditorPath}doc-example/geo-roam-indicator&edit=1&reset=1).
+
+
+
+{{ target: partial-view-coord-sys-allocated-rect-desc }}
+
+为 ${componentNameReadable} 分配的 `矩形区域` 是通过以下配置决定的：
+[${componentNameInLink}.left](~${componentNameInLink}.left) / [.right](~${componentNameInLink}.right) / [.top](~${componentNameInLink}.top) / [.bottom](~${componentNameInLink}.bottom) / [.width](~${componentNameInLink}.width) / [.height](~${componentNameInLink}.height){{ if: ${isGeoOrMap} }} / [.aspectScale](~${componentNameInLink}.aspectScale){{ /if }}。
diff --git a/zh/option/series/sankey.md b/zh/option/series/sankey.md
index ed6da977..01632a44 100644
--- a/zh/option/series/sankey.md
+++ b/zh/option/series/sankey.md
@@ -98,7 +98,8 @@ const option = {"tooltip":{"trigger":"item","triggerOn":"mousemove"},"series":[{
{{ use: partial-view-coord-sys-common(
prefix = '#',
componentMainType = 'series',
- componentSubType = 'sankey'
+ componentSubType = 'sankey',
+ roamTriggerDefault = "'global'"
) }}
diff --git a/zh/option/series/tree.md b/zh/option/series/tree.md
index f0f77155..5777251c 100644
--- a/zh/option/series/tree.md
+++ b/zh/option/series/tree.md
@@ -91,7 +91,8 @@ const option = {
{{ use: partial-view-coord-sys-common(
prefix = '#',
componentMainType = 'series',
- componentSubType = 'tree'
+ componentSubType = 'tree',
+ roamTriggerDefault = "'global'"
) }}
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@echarts.apache.org
For additional commands, e-mail: commits-help@echarts.apache.org