Skip to content

Commit 61b590e

Browse files
committed
doc: improve stackOrder documentation with usage notes
- Add important note that stackOrder should be defined for all series with the same stack name - Explain potential issues when stackOrder is only defined for some series - Address feedback from PR apache#448 comments
1 parent 9b741be commit 61b590e

File tree

4 files changed

+8
-0
lines changed

4 files changed

+8
-0
lines changed

en/option/series/bar.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,8 @@ Stack order. Optional values:
167167
+ `'seriesAsc'` (default, stack in series order)
168168
+ `'seriesDesc'` (reverse stack order)
169169

170+
**Note:** `stackOrder` should be defined for all series with the same `stack` name. If `stackOrder` is defined for only some of the series, the stack order may change unexpectedly when certain series are hidden (e.g., through legend toggle).
171+
170172
Not supported in polar coordinate system.
171173

172174
## sampling(string)

en/option/series/line.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,8 @@ Stack order. Optional values:
9191
+ `'seriesAsc'` (default, stack in series order)
9292
+ `'seriesDesc'` (reverse stack order)
9393

94+
**Note:** `stackOrder` should be defined for all series with the same `stack` name. If `stackOrder` is defined for only some of the series, the stack order may change unexpectedly when certain series are hidden (e.g., through legend toggle).
95+
9496
Not supported in polar coordinate system.
9597

9698
{{ use: partial-cursor() }}

zh/option/series/bar.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -243,6 +243,8 @@ option = {
243243
+ `'seriesAsc'`(默认,系列顺序堆叠)
244244
+ `'seriesDesc'`(反向堆叠)
245245

246+
**注意:** `stackOrder` 应该为所有具有相同 `stack` 名称的系列定义。如果只为部分系列定义 `stackOrder`,当某些系列被隐藏(如通过图例切换)时,可能会导致堆叠顺序发生意外变化。
247+
246248
当前不支持极坐标系。
247249

248250
## sampling(string)

zh/option/series/line.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,8 @@ const option = {
118118
+ `'seriesAsc'`(默认,系列顺序堆叠)
119119
+ `'seriesDesc'`(反向堆叠)
120120

121+
**注意:** `stackOrder` 应该为所有具有相同 `stack` 名称的系列定义。如果只为部分系列定义 `stackOrder`,当某些系列被隐藏(如通过图例切换)时,可能会导致堆叠顺序发生意外变化。
122+
121123
当前不支持极坐标系。
122124

123125
{{ use: partial-cursor() }}

0 commit comments

Comments
 (0)