add doc for apache/echarts#20129

apache · Dec 28, 2024 · fbc7270 · fbc7270
1 parent 0e7a43d
commit fbc7270
Show file tree

Hide file tree

Showing 2 changed files with 75 additions and 10 deletions.
diff --git a/en/api/action.md b/en/api/action.md
@@ -138,7 +138,12 @@ Selects legend.
 dispatchAction({
     type: 'legendSelect',
     // legend name
-    name: string
+    name: string,
+
+    // The following parameters are supported since v5.6.0
+    legendId: string,
+    legendIndex: number,
+    legendName: string
 })
 ```
 
@@ -151,7 +156,12 @@ Unselects the legend.
 dispatchAction({
     type: 'legendUnSelect',
     // legend name
-    name: string
+    name: string,
+
+    // The following parameters are supported since v5.6.0
+    legendId: string,
+    legendIndex: number,
+    legendName: string
 })
 ```
 
@@ -163,7 +173,12 @@ Toggles legend selecting state.
 dispatchAction({
     type: 'legendToggleSelect',
     // legend name
-    name: string
+    name: string,
+
+    // The following parameters are supported since v5.6.0
+    legendId: string,
+    legendIndex: number,
+    legendName: string
 })
 ```
 
@@ -174,7 +189,12 @@ Selects all legends.
 
 ```ts
 dispatchAction({
-    type: 'legendAllSelect'
+    type: 'legendAllSelect',
+
+    // The following parameters are supported since v5.6.0
+    legendId: string,
+    legendIndex: number,
+    legendName: string
 })
 ```
 
@@ -185,7 +205,12 @@ Inverses all legends.
 
 ```ts
 dispatchAction({
-    type: 'legendInverseSelect'
+    type: 'legendInverseSelect',
+
+    // The following parameters are supported since v5.6.0
+    legendId: string,
+    legendIndex: number,
+    legendName: string
 })
 ```
 

diff --git a/zh/api/action.md b/zh/api/action.md
@@ -137,7 +137,15 @@ dispatchAction({
 dispatchAction({
     type: 'legendSelect',
     // 图例名称
-    name: string
+    name: string,
+
+    // 下列参数自 v5.6.0 起开始支持
+    // 图例组件ID
+    legendId: string,
+    // 图例组件索引
+    legendIndex: number,
+    // 图例组件名称
+    legendName: string
 })
 ```
 
@@ -150,7 +158,15 @@ dispatchAction({
 dispatchAction({
     type: 'legendUnSelect',
     // 图例名称
-    name: string
+    name: string,
+
+    // 下列参数自 v5.6.0 起开始支持
+    // 图例组件ID
+    legendId: string,
+    // 图例组件索引
+    legendIndex: number,
+    // 图例组件名称
+    legendName: string
 })
 ```
 
@@ -162,7 +178,15 @@ dispatchAction({
 dispatchAction({
     type: 'legendToggleSelect',
     // 图例名称
-    name: string
+    name: string,
+
+    // 下列参数自 v5.6.0 起开始支持
+    // 图例组件ID
+    legendId: string,
+    // 图例组件索引
+    legendIndex: number,
+    // 图例组件名称
+    legendName: string
 })
 ```
 
@@ -172,7 +196,15 @@ dispatchAction({
 将图例全选。
 ```ts
 dispatchAction({
-    type: 'legendAllSelect'
+    type: 'legendAllSelect',
+
+    // 下列参数自 v5.6.0 起开始支持
+    // 图例组件ID
+    legendId: string,
+    // 图例组件索引
+    legendIndex: number,
+    // 图例组件名称
+    legendName: string
 })
 ```
 
@@ -182,7 +214,15 @@ dispatchAction({
 将图例反选。
 ```ts
 dispatchAction({
-    type: 'legendInverseSelect'
+    type: 'legendInverseSelect',
+
+    // 下列参数自 v5.6.0 起开始支持
+    // 图例组件ID
+    legendId: string,
+    // 图例组件索引
+    legendIndex: number,
+    // 图例组件名称
+    legendName: string
 })
 ```