You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/grid/api/rangeselection/afterresetrange_event.md
+8-5Lines changed: 8 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,11 +24,14 @@ afterResetRange: (
24
24
@params:
25
25
The callback of the event is called with the following parameters:
26
26
27
-
-`range: object` - the object of the reset range:
28
-
- `xStart?: string | number` - the starting column id
29
-
- `xEnd?: string | number` - the ending column id
30
-
- `yStart?: string | number` - the starting row id
31
-
- `yEnd?: string | number` - the ending row id
27
+
<table>
28
+
<tbody>
29
+
<tr>
30
+
<td><b>range</b></td>
31
+
<td>(<i>object</i>) the object with the reset range coordinates that contains the following options:<ul><li><b>`xStart`</b> - (<i>string | number</i>) the starting column id</li><li><b>`xEnd`</b> - (<i>string | number</i>) the ending column id</li><li><b>`yStart`</b> - (<i>string | number</i>) the starting row id</li><li><b>`yEnd`</b> - (<i>string | number</i>) the ending row id</li></ul></td>
Copy file name to clipboardExpand all lines: docs/grid/api/rangeselection/aftersetrange_event.md
+8-5Lines changed: 8 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,11 +24,14 @@ afterSetRange: (
24
24
@params:
25
25
The callback of the event is called with the following parameters:
26
26
27
-
-`range: object` - the object of the set range:
28
-
- `xStart?: string | number` - the starting column id
29
-
- `xEnd?: string | number` - the ending column id
30
-
- `yStart?: string | number` - the starting row id
31
-
- `yEnd?: string | number` - the ending row id
27
+
<table>
28
+
<tbody>
29
+
<tr>
30
+
<td><b>range</b></td>
31
+
<td>(<i>object</i>) the object with the set range coordinates that contains the following options:<ul><li><b>`xStart`</b> - (<i>string | number</i>) the starting column id</li><li><b>`xEnd`</b> - (<i>string | number</i>) the ending column id</li><li><b>`yStart`</b> - (<i>string | number</i>) the starting row id</li><li><b>`yEnd`</b> - (<i>string | number</i>) the ending row id</li></ul></td>
Copy file name to clipboardExpand all lines: docs/grid/api/rangeselection/beforeresetrange_event.md
+8-5Lines changed: 8 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,11 +24,14 @@ beforeResetRange: (
24
24
@params:
25
25
The callback of the event is called with the following parameters:
26
26
27
-
-`range: object` - the range object:
28
-
- `xStart?: string | number` - the starting column id
29
-
- `xEnd?: string | number` - the ending column id
30
-
- `yStart?: string | number` - the starting row id
31
-
- `yEnd?: string | number` - the ending row id
27
+
<table>
28
+
<tbody>
29
+
<tr>
30
+
<td><b>range</b></td>
31
+
<td>(<i>object</i>) an object with the range coordinates that contains the following options:<ul><li><b>`xStart`</b> - (<i>string | number</i>) the starting column id</li><li><b>`xEnd`</b> - (<i>string | number</i>) the ending column id</li><li><b>`yStart`</b> - (<i>string | number</i>) the starting row id</li><li><b>`yEnd`</b> - (<i>string | number</i>) the ending row id</li></ul></td>
32
+
</tr>
33
+
</tbody>
34
+
</table>
32
35
33
36
@returns:
34
37
Return `false` to prevent resetting of the range; otherwise, `true`.
Copy file name to clipboardExpand all lines: docs/grid/api/rangeselection/beforesetrange_event.md
+8-5Lines changed: 8 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,11 +24,14 @@ beforeSetRange: (
24
24
@params:
25
25
The callback of the event is called with the following parameters:
26
26
27
-
-`range: object` - the range object:
28
-
- `xStart?: string | number` - the starting column id
29
-
- `xEnd?: string | number` - the ending column id
30
-
- `yStart?: string | number` - the starting row id
31
-
- `yEnd?: string | number` - the ending row id
27
+
<table>
28
+
<tbody>
29
+
<tr>
30
+
<td><b>range</b></td>
31
+
<td>(<i>object</i>) an object with the range coordinates that contains the following options:<ul><li><b>`xStart`</b> - (<i>string | number</i>) the starting column id</li><li><b>`xEnd`</b> - (<i>string | number</i>) the ending column id</li><li><b>`yStart`</b> - (<i>string | number</i>) the starting row id</li><li><b>`yEnd`</b> - (<i>string | number</i>) the ending row id</li></ul></td>
32
+
</tr>
33
+
</tbody>
34
+
</table>
32
35
33
36
@returns:
34
37
Return `false` to prevent setting a range; otherwise, `true`.
-`cell: object` - an object with the `x` and `y` coordinates of a cell, where:
19
-
- `x: string | number` - the column id
20
-
- `y: string | number` - the row id
18
+
<table>
19
+
<tbody>
20
+
<tr>
21
+
<td><b>cell</b></td>
22
+
<td>(<i>object</i>) - an object with the `x` and `y` coordinates of a cell, where:<ul><li>`x` - (*string | number*) - the column id</li><li>`y` - (*string | number*) - the row id</li></ul></td>
23
+
</tr>
24
+
</tbody>
25
+
</table>
21
26
22
27
:::note
23
28
You can specify just `x` or `y` to check a column or a row, correspondingly.
The returned object with the current selection range contains the following properties:
227
227
228
-
-`xStart` - (*string | number*) the starting column id
229
-
-`xEnd` - (*string | number*) the ending column id
230
-
-`yStart` - (*string | number*) the starting row id
231
-
-`yEnd` - (*string | number*) the ending row id
228
+
<table>
229
+
<tbody>
230
+
<tr>
231
+
<td><b>xStart</b></td>
232
+
<td>(<i>string | number</i>) the starting column id</td>
233
+
</tr>
234
+
<tr>
235
+
<td><b>xEnd</b></td>
236
+
<td>(<i>string | number</i>) the ending column id</td>
237
+
</tr>
238
+
<tr>
239
+
<td><b>yStart</b></td>
240
+
<td>(<i>string | number</i>) the starting row id</td>
241
+
</tr>
242
+
<tr>
243
+
<td><b>yEnd</b></td>
244
+
<td>(<i>string | number</i>) the ending row id</td>
245
+
</tr>
246
+
</tbody>
247
+
</table>
232
248
233
249
### Getting an array of cells within the range
234
250
235
251
It is also possible to get an array of cells within the range selection by using the [`getRangedCells()`](grid/api/rangeselection/getrangedcells_method.md) method of the `range` object. It returns an array of objects where:
236
252
237
-
-`row` - (*object*) the row object
238
-
-`column` - (*object*) the column object
253
+
<table>
254
+
<tbody>
255
+
<tr>
256
+
<td><b>row</b></td>
257
+
<td>(<i>object</i>) the row object</td>
258
+
</tr>
259
+
<tr>
260
+
<td><b>column</b></td>
261
+
<td>(<i>object</i>) the column object</td>
262
+
</tr>
263
+
</tbody>
264
+
</table>
239
265
240
266
This example shows retrieving of the range of selected cells:
You can check whether a cell is within the current range using the [`isRanged()`](grid/api/rangeselection/isranged_method.md) method of the `range` object. The method takes the following parameter:
263
289
264
-
-`cell` - (*object*) - an object with the `x` and `y` coordinates of a cell, where:
265
-
-`x` - (*string | number*) - the column id
266
-
-`y` - (*string | number*) - the row id
290
+
<table>
291
+
<tbody>
292
+
<tr>
293
+
<td><b>cell</b></td>
294
+
<td>(<i>object</i>) - an object with the `x` and `y` coordinates of a cell, where:<ul><li>`x` - (*string | number*) - the column id</li><li>`y` - (*string | number*) - the row id</li></ul></td>
295
+
</tr>
296
+
</tbody>
297
+
</table>
267
298
268
299
:::note
269
300
You can specify just `x` or `y` to check a column or a row, correspondingly.
0 commit comments