This is an automated email from the ASF dual-hosted git repository.
100pah pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/echarts-doc.git
The following commit(s) were added to refs/heads/master by this push:
new 23ef53b4 Add doc for v6.1.0: `axis.startValue`; `series.clip`;
`axis.axisLine.onZero`.
new 96665171 Merge branch 'master' of
github.com:apache/incubator-echarts-doc
23ef53b4 is described below
commit 23ef53b42cfc31af8679501be0d27be393cd8406
Author: 100pah <[email protected]>
AuthorDate: Wed May 20 23:56:29 2026 +0800
Add doc for v6.1.0: `axis.startValue`; `series.clip`;
`axis.axisLine.onZero`.
---
en/option/component/axis-common.md | 20 ++++++++++++++------
en/option/partial/clip.md | 35 +++++++++++++++++++++++------------
en/option/series/bar.md | 3 ++-
en/option/series/boxplot.md | 6 ++++++
en/option/series/candlestick.md | 3 ++-
en/option/series/custom.md | 3 ++-
en/option/series/effectScatter.md | 3 ++-
en/option/series/line.md | 3 ++-
en/option/series/lines.md | 3 ++-
en/option/series/pictorialBar.md | 4 +++-
en/option/series/scatter.md | 3 ++-
zh/option/component/axis-common.md | 19 +++++++++++++------
zh/option/partial/clip.md | 34 ++++++++++++++++++++++------------
zh/option/series/bar.md | 3 ++-
zh/option/series/boxplot.md | 6 ++++++
zh/option/series/candlestick.md | 3 ++-
zh/option/series/custom.md | 3 ++-
zh/option/series/effectScatter.md | 3 ++-
zh/option/series/line.md | 3 ++-
zh/option/series/lines.md | 3 ++-
zh/option/series/pictorialBar.md | 4 +++-
zh/option/series/scatter.md | 3 ++-
22 files changed, 118 insertions(+), 52 deletions(-)
diff --git a/en/option/component/axis-common.md
b/en/option/component/axis-common.md
index 0f7f73ad..842d1c3a 100644
--- a/en/option/component/axis-common.md
+++ b/en/option/component/axis-common.md
@@ -266,11 +266,13 @@ Set this to `false` to prevent the axis line from showing.
{{ /if }}
{{ if: ${componentType} == 'xAxis' || ${componentType} == 'yAxis' }}
-##${prefix} onZero(boolean) = true
+##${prefix} onZero(boolean|string) = 'auto'
-<ExampleUIControlBoolean default="true" />
+<ExampleUIControlEnum options="auto,true,false" default="auto" />
+
+Specifies whether X or Y axis lies on the origin position (i.e., `0` point) of
its orthogonal axis. It works only if the orthogonal axis is ['value' |
'log'](~xAxis.type) axis and contains `0`.
-Specifies whether X or Y axis lies on the other's origin position, where value
is 0 on axis. Valid only if the other axis is of value type, and contains 0
value.
+{{ use: partial-version(version = '6.1.0', feature="The value 'auto' is
introduced") }}
##${prefix} onZeroAxisIndex(number)
@@ -1015,15 +1017,21 @@ This is unavailable for 'category' and 'time' axes.
Logged value should be passe
Base of logarithm, which is valid only for numeric axes with
[type](~${componentType}.type): 'log'.
-#${prefix} startValue(number)
+#${prefix} startValue(number) = 0
-<ExampleUIControlNumber />
+<ExampleUIControlNumber default="0" />
{{ use: partial-version(
version = '5.5.1'
) }}
+<div class="doc-partial-version">
+Before `v6.1.0` (exclusive), `startValue` is also used as
[axis.min](~yAxis.min) if it is not provided. Since `v6.1.0`, the two options
are no longer associated.
+</div>
+
+This is the start value of series shapes. Currently, it can be used only for
[bar](~series-bar) and [pictorialBar](~series-pictorialBar).
+
+Note: Currently, `startValue` is not supported to be used together with
[stack](~series-bar.stack) -- the effect may be unexpected.
-To specify the start value of the axis.
{{ use: partial-axis-common-axis-line(
prefix = ${prefix},
diff --git a/en/option/partial/clip.md b/en/option/partial/clip.md
index 9de6d4ec..9943133b 100644
--- a/en/option/partial/clip.md
+++ b/en/option/partial/clip.md
@@ -9,15 +9,26 @@
version = ${version|default("4.4.0")}
) }}
-If clip the overflow on the coordinate system. Clip results varies between
series:
-
-+ Scatter/EffectScatter：Ignore the symbols exceeds the coordinate system. Not
clip the elements.
-+ Bar：Clip all the overflowed. With bar width kept.
-+ Line：Clip the overflowed line.
-+ Lines: Clip all the overflowed.
-+ Candlestick: Ignore the elements exceeds the coordinate system.
-+ PictorialBar: Clip all the overflowed. (Supported since v5.5.0)
-+ Custom: Clip all the olverflowed.
-
-All these series have default value `true` except pictorialBar and custom
series. Set it to `false` if you don't want to clip.
-
+Whether to clip series shapes overflowing the coordinate system.
+
+The detailed clipping behavior is:
+
+{{ if: ${seriesType} === 'scatter' || ${seriesType} === 'effectScatter' }}
+A scatter symbol is removed only if the center is outside the coordinate
system. Otherwise, the shape is fully visible, regardless of partial overflow.
+{{ elif: ${seriesType} === 'bar' || ${seriesType} === 'pictorialBar' }}
+Since `v6.1.0`, overflowing parts of a bar is clipped.
+Before `v6.1.0` (exclusive), an element is removed only if it is fully outside
the coordinate system. Otherwise, the bar is fully visible, regardless of
partial overflow.
+This difference is noticeable when `axis.type: 'category', boundaryGap: false`
or `axis.type: 'value' | 'time' | 'log'`.
+{{ elif: ${seriesType} === 'line' }}
+- For the line: Overflowing parts of a line is clipped.
+- For data point symbols: A symbol is removed only if the center is outside
the coordinate system, otherwise it is fully visible, regardless of partial
overflow.
+{{ elif: ${seriesType} === 'lines' }}
+Overflowing parts of a shape is clipped.
+{{ elif: ${seriesType} === 'candlestick' }}
+Since `v6.1.0`, overflowing parts of a shape is clipped.
+Before `v6.1.0` (exclusive), an element is removed only if the center is
outside the coordinate system. Otherwise, the shape is fully visible,
regardless of partial overflow.
+{{ elif: ${seriesType} === 'boxplot' }}
+Overflowing parts of a shape is clipped.
+{{ elif: ${seriesType} === 'custom' }}
+Overflowing parts of a shape is clipped.
+{{ /if }}
diff --git a/en/option/series/bar.md b/en/option/series/bar.md
index 99e23bc3..5f6327f8 100644
--- a/en/option/series/bar.md
+++ b/en/option/series/bar.md
@@ -256,7 +256,8 @@ Select state of single data.
) }}
{{ use: partial-clip(
- prefix = "#"
+ prefix = "#",
+ seriesType = "bar"
) }}
{{ use: partial-marker(
diff --git a/en/option/series/boxplot.md b/en/option/series/boxplot.md
index 74d358af..d0ec6f30 100644
--- a/en/option/series/boxplot.md
+++ b/en/option/series/boxplot.md
@@ -261,6 +261,12 @@ Select state of single data.
hasType = true
) }}
+{{ use: partial-clip(
+ prefix = "#",
+ version = "6.1.0",
+ seriesType = "boxplot"
+) }}
+
{{ use: partial-z-zlevel(
prefix = "#",
componentName = "Boxplot "
diff --git a/en/option/series/candlestick.md b/en/option/series/candlestick.md
index 36f2386b..82243b05 100644
--- a/en/option/series/candlestick.md
+++ b/en/option/series/candlestick.md
@@ -286,7 +286,8 @@ Select state of single data.
{{ use: partial-clip(
prefix = "#",
- version = "4.5.0"
+ version = "4.5.0",
+ seriesType = "candlestick"
) }}
{{ use: partial-z-zlevel(
diff --git a/en/option/series/custom.md b/en/option/series/custom.md
index 2e78e1de..20226741 100644
--- a/en/option/series/custom.md
+++ b/en/option/series/custom.md
@@ -481,7 +481,8 @@ Value of data item.
{{ use: partial-clip(
prefix = "#",
- defaultClip = false
+ defaultClip = false,
+ seriesType = "custom"
) }}
{{ use: partial-z-zlevel(
diff --git a/en/option/series/effectScatter.md
b/en/option/series/effectScatter.md
index 360acc91..874092b8 100644
--- a/en/option/series/effectScatter.md
+++ b/en/option/series/effectScatter.md
@@ -290,7 +290,8 @@ Select state of the specified single data.
{{ use: partial-clip(
prefix = "#",
- version = "5.1.0"
+ version = "5.1.0",
+ seriesType = "effectScatter"
) }}
{{ use: partial-z-zlevel(
diff --git a/en/option/series/line.md b/en/option/series/line.md
index 83708c75..115d2c0b 100644
--- a/en/option/series/line.md
+++ b/en/option/series/line.md
@@ -70,7 +70,8 @@ Only work when main axis is `'category'` axis (`axis.type` is
`'category'`). Opt
Whether to connect the line across null points.
{{ use: partial-clip(
- prefix = "#"
+ prefix = "#",
+ seriesType = "line"
) }}
## triggerLineEvent(boolean) = false
diff --git a/en/option/series/lines.md b/en/option/series/lines.md
index 84b47260..35361290 100644
--- a/en/option/series/lines.md
+++ b/en/option/series/lines.md
@@ -281,7 +281,8 @@ Label of a single line. Available when
[polyline](~series-lines.polyline) is not
) }}
{{ use: partial-clip(
- prefix = "#"
+ prefix = "#",
+ seriesType = "lines"
) }}
{{ use: partial-z-zlevel(
diff --git a/en/option/series/pictorialBar.md b/en/option/series/pictorialBar.md
index d0e68103..e4671277 100644
--- a/en/option/series/pictorialBar.md
+++ b/en/option/series/pictorialBar.md
@@ -310,7 +310,9 @@ Select state of the specified single data.
{{ use: partial-clip(
prefix = "#",
- defaultClip = false
+ defaultClip = false,
+ version = "5.5.0",
+ seriesType = "pictorialBar"
) }}
{{ use: partial-z-zlevel(
diff --git a/en/option/series/scatter.md b/en/option/series/scatter.md
index 0d429036..5388a8d7 100644
--- a/en/option/series/scatter.md
+++ b/en/option/series/scatter.md
@@ -268,7 +268,8 @@ Select state of single data.
) }}
{{ use: partial-clip(
- prefix = "#"
+ prefix = "#",
+ seriesType = "scatter"
) }}
{{ use: partial-z-zlevel(
diff --git a/zh/option/component/axis-common.md
b/zh/option/component/axis-common.md
index a94da0ff..92e54f6d 100644
--- a/zh/option/component/axis-common.md
+++ b/zh/option/component/axis-common.md
@@ -264,11 +264,13 @@ myChart.setOption({
{{ /if }}
{{ if: ${componentType} == 'xAxis' || ${componentType} == 'yAxis' }}
-##${prefix} onZero(boolean) = true
+##${prefix} onZero(boolean|string) = 'auto'
-<ExampleUIControlBoolean default="true" />
+<ExampleUIControlEnum options="auto,true,false" default="auto" />
+
+X 轴或者 Y 轴的轴线是否在另一个轴的 0 刻度上。只有在另一个轴为 [数值轴（'value'）](~xAxis.type) 且包含 0 刻度时有效。
-X 轴或者 Y 轴的轴线是否在另一个轴的 0 刻度上，只有在另一个轴为数值轴且包含 0 刻度时有效。
+{{ use: partial-version(version = '6.1.0', feature="值 'auto' ") }}
##${prefix} onZeroAxisIndex(number)
@@ -1013,15 +1015,20 @@ max: function (value) {
对数轴的底数，只在对数轴中（[type](~${componentType}.type): 'log'）有效。
-#${prefix} startValue(number)
+#${prefix} startValue(number) = 0
-<ExampleUIControlNumber />
+<ExampleUIControlNumber default="0"/>
{{ use: partial-version(
version = '5.5.1'
) }}
+<div class="doc-partial-version">
+`v6.1.0`前（不包含），`startValue` 也会被用于 [axis.min](~yAxis.min) 若其未被指定。自从
`v6.1.0`，这两个配置项不再相关。
+</div>
+
+系列图形的起始值。目前只适用于 [柱状图（bar）](~series-bar) and
[象形柱状图（pictorialBar）](~series-pictorialBar)。
-用于指定轴的起始值。
+注：目前不支持 `startValue` 和 [stack](~series-bar.stack) 同时使用（其效果可能不符合预期）。
{{ use: partial-axis-common-axis-line(
prefix = ${prefix},
diff --git a/zh/option/partial/clip.md b/zh/option/partial/clip.md
index 9fb6a166..2c483707 100644
--- a/zh/option/partial/clip.md
+++ b/zh/option/partial/clip.md
@@ -9,15 +9,25 @@
version = ${version|default("4.4.0")}
) }}
-是否裁剪超出坐标系部分的图形，具体裁剪效果根据系列决定：
-
-+ 散点图/带有涟漪特效动画的散点（气泡）图：忽略中心点超出坐标系的图形，但是不裁剪单个图形
-+ 柱状图：裁掉完全超出的柱子，但是不会裁剪只超出部分的柱子
-+ 折线图：裁掉所有超出坐标系的折线部分，拐点图形的逻辑按照散点图处理
-+ 路径图：裁掉所有超出坐标系的部分
-+ K 线图：忽略整体都超出坐标系的图形，但是不裁剪单个图形
-+ 象形柱图：裁掉所有超出坐标系的部分（从 v5.5.0 开始支持）
-+ 自定义系列：裁掉所有超出坐标系的部分
-
-除了象形柱图和自定义系列，其它系列的默认值都为 true，及开启裁剪，如果你觉得不想要裁剪的话，可以设置成 false 关闭。
-
+是否基于坐标系区域对系列的图形进行剪裁。
+
+具体裁剪效果是：
+
+{{ if: ${seriesType} === 'scatter' || ${seriesType} === 'effectScatter' }}
+任一图形如果中心超出坐标系则被整体剪裁掉，否则整体保留哪怕部分超出。
+{{ elif: ${seriesType} === 'bar' || ${seriesType} === 'pictorialBar' }}
+自 `v6.1.0`，任一柱子超出坐标系的部分会被剪裁掉。
+`v6.1.0` 前（不含），任一柱子如果中心超出坐标系则被整体剪裁掉，否则整体保留哪怕部分超出。
+{{ elif: ${seriesType} === 'line' }}
+- 对于折线：剪裁掉折线的超出坐标系的部分。
+- 对于拐点图形：如果图形中心点超出坐标系，则此图形整体不显示；不会裁剪单个图形。
+{{ elif: ${seriesType} === 'lines' }}
+对于任一图形，裁掉超出坐标系的部分。
+{{ elif: ${seriesType} === 'candlestick' }}
+自 `v6.1.0`，任一图形超出坐标系的部分会被剪裁掉。
+`v6.1.0` 前（不含），任一图形如果中心超出坐标系则被整体剪裁掉，否则整体保留哪怕部分超出。
+{{ elif: ${seriesType} === 'boxplot' }}
+任一图形超出坐标系的部分会被剪裁掉。
+{{ elif: ${seriesType} === 'custom' }}
+对于任一图形，裁掉超出坐标系的部分。
+{{ /if }}
diff --git a/zh/option/series/bar.md b/zh/option/series/bar.md
index 95538995..eb18e1a4 100644
--- a/zh/option/series/bar.md
+++ b/zh/option/series/bar.md
@@ -335,7 +335,8 @@ option = {
) }}
{{ use: partial-clip(
- prefix = "#"
+ prefix = "#",
+ seriesType = "bar"
) }}
{{ use: partial-marker(
diff --git a/zh/option/series/boxplot.md b/zh/option/series/boxplot.md
index 91c2e4b8..4df49520 100644
--- a/zh/option/series/boxplot.md
+++ b/zh/option/series/boxplot.md
@@ -297,6 +297,12 @@ ECharts 并不内置对原始数据的处理，输入给 `boxplot` 的数据须
hasType = true
) }}
+{{ use: partial-clip(
+ prefix = "#",
+ version = "6.1.0",
+ seriesType = "boxplot"
+) }}
+
{{ use: partial-z-zlevel(
prefix = "#",
componentName = "盒须图"
diff --git a/zh/option/series/candlestick.md b/zh/option/series/candlestick.md
index 138a1a8f..30264e9a 100644
--- a/zh/option/series/candlestick.md
+++ b/zh/option/series/candlestick.md
@@ -475,7 +475,8 @@ series: [{
{{ use: partial-clip(
prefix = "#",
- version = "4.5.0"
+ version = "4.5.0",
+ seriesType = "candlestick"
) }}
{{ use: partial-z-zlevel(
diff --git a/zh/option/series/custom.md b/zh/option/series/custom.md
index 44f126ca..e3035dc0 100644
--- a/zh/option/series/custom.md
+++ b/zh/option/series/custom.md
@@ -466,7 +466,8 @@ renderItem 函数的第二个参数。
{{ use: partial-clip(
prefix = "#",
- defaultClip = false
+ defaultClip = false,
+ seriesType = "custom"
) }}
{{ use: partial-z-zlevel(
diff --git a/zh/option/series/effectScatter.md
b/zh/option/series/effectScatter.md
index cba83a27..259cf5a6 100644
--- a/zh/option/series/effectScatter.md
+++ b/zh/option/series/effectScatter.md
@@ -307,7 +307,8 @@ const option = {
{{ use: partial-clip(
prefix = "#",
- version = "5.1.0"
+ version = "5.1.0",
+ seriesType = "effectScatter"
) }}
{{ use: partial-z-zlevel(
diff --git a/zh/option/series/line.md b/zh/option/series/line.md
index 20d3bb0e..46235da5 100644
--- a/zh/option/series/line.md
+++ b/zh/option/series/line.md
@@ -99,7 +99,8 @@ const option = {
是否连接空数据。
{{ use: partial-clip(
- prefix = "#"
+ prefix = "#",
+ seriesType = "line"
) }}
## triggerLineEvent(boolean) = false
diff --git a/zh/option/series/lines.md b/zh/option/series/lines.md
index 9ccb9e3c..e08b3bbc 100644
--- a/zh/option/series/lines.md
+++ b/zh/option/series/lines.md
@@ -305,7 +305,8 @@ ECharts 2.x 里会用地图上的 `markLine` 去绘制迁徙效果，在 ECharts
) }}
{{ use: partial-clip(
- prefix = "#"
+ prefix = "#",
+ seriesType = "lines"
) }}
{{ use: partial-z-zlevel(
diff --git a/zh/option/series/pictorialBar.md b/zh/option/series/pictorialBar.md
index 6e826f40..e042a4b5 100644
--- a/zh/option/series/pictorialBar.md
+++ b/zh/option/series/pictorialBar.md
@@ -359,7 +359,9 @@ option = {
{{ use: partial-clip(
prefix = "#",
- defaultClip = false
+ defaultClip = false,
+ version = "5.5.0",
+ seriesType = "pictorialBar"
) }}
{{ use: partial-z-zlevel(
diff --git a/zh/option/series/scatter.md b/zh/option/series/scatter.md
index 01b3ae8d..a67bb026 100644
--- a/zh/option/series/scatter.md
+++ b/zh/option/series/scatter.md
@@ -337,7 +337,8 @@ const option = {
) }}
{{ use: partial-clip(
- prefix = "#"
+ prefix = "#",
+ seriesType = "scatter"
) }}
{{ use: partial-z-zlevel(
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
