Skip to content

doc: update instruction for custom group being null apache/echarts#17349 #270

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Ovilia merged 2 commits into from
Aug 1, 2022
Merged

doc: update instruction for custom group being null apache/echarts#17349 #270

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
687b006
doc: update instruction for custom group being null apache/echarts#17349
Ovilia Jul 12, 2022
c273945
fix(custom): update null hints
Ovilia Aug 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion en/option/partial/zr-graphic.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@

`group` is the only type that can contain children, so that a group of elements can be positioned and transformed together.

{{ if: ${usageType} === 'customSeries' }}
Note that if any of its child is `null`, it means the child no longer exists. So if a group contains an element that is set to be `null/undefined` in a future `setOption` call, it should remove the previous element at the same index. If a child should not change, it should be `{}` in the new option. And a group can only contain children as `null/undefined/{}` if they exist in the previous `setOption`.

{{ /if }}

{{ use: partial-graphic-cpt-common-props(
type = 'group',
prefix = ${prefix},
Expand Down Expand Up @@ -2046,4 +2051,3 @@ Although the points will be interpolated, the consequent animation will be like
```

See this example [example](${galleryEditorPath}custom-spiral-race&edit=1&reset=1).

6 changes: 5 additions & 1 deletion zh/option/partial/zr-graphic.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@

group 是唯一的可以有子节点的容器。group 可以用来整体定位一组图形元素。

{{ if: ${usageType} === 'customSeries' }}
注意，如果其任意子节点是 `null`，这表示该子节点不再存在。所以，如果再次调用 `setOption` 时，一个子节点被设为 `null`，这意味着它之前对应序号的元素会被删除。如果希望一个子节点保持不变，应在新的配置项中使用 `{}` 表示。并且，仅当 group 的子节点在之前的 `setOption` 中存在时，才可以使用 `null/undefined/{}` 作为子节点。

{{ /if }}

{{ use: partial-graphic-cpt-common-props(
type = 'group',
prefix = ${prefix},
Expand Down Expand Up @@ -2017,4 +2022,3 @@ type TransformProp =
```

也参见这个 [例子](${galleryEditorPath}custom-spiral-race&edit=1&reset=1)。