Skip to content

Commit 2033251

Browse files
committed
add tip for legendId/legendName/legendIndex in legend actions (apache/echarts#21025)
1 parent e92688f commit 2033251

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

en/api/action.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,8 +141,11 @@ dispatchAction({
141141
name: string,
142142

143143
// The following parameters are supported since v5.6.0
144+
// the id of target legend component
144145
legendId: string,
146+
// the index of target legend component
145147
legendIndex: number,
148+
// the name of target legend component
146149
legendName: string
147150
})
148151
```
@@ -159,8 +162,11 @@ dispatchAction({
159162
name: string,
160163

161164
// The following parameters are supported since v5.6.0
165+
// the id of target legend component
162166
legendId: string,
167+
// the index of target legend component
163168
legendIndex: number,
169+
// the name of target legend component
164170
legendName: string
165171
})
166172
```
@@ -176,8 +182,11 @@ dispatchAction({
176182
name: string,
177183

178184
// The following parameters are supported since v5.6.0
185+
// the id of target legend component
179186
legendId: string,
187+
// the index of target legend component
180188
legendIndex: number,
189+
// the name of target legend component
181190
legendName: string
182191
})
183192
```
@@ -192,8 +201,11 @@ dispatchAction({
192201
type: 'legendAllSelect',
193202

194203
// The following parameters are supported since v5.6.0
204+
// the id of target legend component
195205
legendId: string,
206+
// the index of target legend component
196207
legendIndex: number,
208+
// the name of target legend component
197209
legendName: string
198210
})
199211
```
@@ -208,8 +220,11 @@ dispatchAction({
208220
type: 'legendInverseSelect',
209221

210222
// The following parameters are supported since v5.6.0
223+
// the id of target legend component
211224
legendId: string,
225+
// the index of target legend component
212226
legendIndex: number,
227+
// the name of target legend component
213228
legendName: string
214229
})
215230
```

0 commit comments

Comments
 (0)