Skip to content

Commit 0645b4c

Browse files
committed
[update] complete grid docs for v9.2
1 parent c082765 commit 0645b4c

File tree

10 files changed

+49
-39
lines changed

10 files changed

+49
-39
lines changed
64.4 KB
Loading

docs/grid/api/api_overview.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -43,12 +43,12 @@ description: You can explore the API of Grid in the documentation of the DHTMLX
4343

4444
:::info important
4545
- Use [the methods of DataCollection](data_collection.md) to work with data.
46-
- Apply [the methods of Selection](grid/api/api_overview.md#selection-methods) to manage the selection of Grid cells.
47-
- Apply [the methods of RangeSelection](grid/api/api_overview.md#rangeselection-methods) to manage the range selection within Grid.
48-
- Apply [the methods of BlockSelection](grid/api/api_overview.md#blockselection-methods) to manage the block selection within Grid.
49-
- Use [the methods of Export](grid/api/api_overview.md#export-methods) to work with data export within Grid.
50-
- Use [the methods of History](grid/api/api_overview.md#history-methods) to manage the history of actions within Grid.
5146
- Use [the methods of TreeCollection](tree_collection.md#methods) to work with data of Grid in the TreeGrid mode.
47+
- Use [the methods of the Selection object](grid/api/api_overview.md#selection-methods) to work with the selection of Grid cells.
48+
- Use [the methods of the RangeSelection module](grid/api/api_overview.md#rangeselection-methods) to work with the range selection within Grid.
49+
- Use [the methods of the BlockSelection module](grid/api/api_overview.md#blockselection-methods) to work with the block selection within Grid.
50+
- Use [the methods of the Export module](grid/api/api_overview.md#export-methods) to work with data export within Grid.
51+
- Use [the methods of the History module](grid/api/api_overview.md#history-methods) to work with the history of actions within Grid.
5252
:::
5353

5454
## Grid events
@@ -167,14 +167,14 @@ description: You can explore the API of Grid in the documentation of the DHTMLX
167167
| [](grid/api/grid_beforerowresize_event.md) | @getshort(grid/api/grid_beforerowresize_event.md) |
168168

169169
:::info important
170-
- Use [the events of DataCollection](data_collection.md#events) to work with data of Grid.
171-
- Apply [the events of Selection](grid/api/api_overview.md#selection-events) to handle the selection of Grid cells.
172-
- Apply [the events of RangeSelection](grid/api/api_overview.md#rangeselection-events) to handle the range selection within Grid.
173-
- Apply [the events of BlockSelection](grid/api/api_overview.md#blockselection-events) to handle the block selection within Grid.
174-
- Use [the events of Clipboard](grid/api/api_overview.md#clipboard-events) to work with clipboard within Grid.
175-
- Use [the events of DragPanel](grid/api/api_overview.md#dragpanel-events) to work with drag panel within Grid.
176-
- Use [the events of History](grid/api/api_overview.md#history-events) to work with the history of actions within Grid.
177-
- Use [the events of TreeCollection](tree_collection.md#events) to work with data of Grid in the TreeGrid mode.
170+
- Use [the events of DataCollection](data_collection.md#events) to work with data of Grid.
171+
- Use [the events of TreeCollection](tree_collection.md#events) to work with data of Grid in the TreeGrid mode.
172+
- Use [the events of the Selection object](grid/api/api_overview.md#selection-events) to work with the selection of Grid cells.
173+
- Use [the events of the RangeSelection module](grid/api/api_overview.md#rangeselection-events) to work with the range selection within Grid.
174+
- Use [the events of the BlockSelection module](grid/api/api_overview.md#blockselection-events) to work with the block selection within Grid.
175+
- Use [the events of the Clipboard module](grid/api/api_overview.md#clipboard-events) to work with clipboard within Grid.
176+
- Use [the events of the DragPanel module](grid/api/api_overview.md#dragpanel-events) to work with drag panel within Grid.
177+
- Use [the events of the History module](grid/api/api_overview.md#history-events) to work with the history of actions within Grid.
178178
:::
179179

180180
## Grid properties

docs/grid/api/blockselection/disable_method.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: You can explore the disable method of Grid block selection in the d
66

77
# disable()
88

9-
@short: disables the `BlockSelection` module and resets processing of block selection
9+
@short: disables the BlockSelection module and resets processing of block selection in Grid
1010

1111
@signature: {'disable(): void;'}
1212

docs/grid/api/blockselection/enable_method.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: You can explore the enable method of Grid block selection in the do
66

77
# enable()
88

9-
@short: enables the `BlockSelection` module and activates the capabilities of block selection in Grid
9+
@short: enables the BlockSelection module and activates the capabilities of block selection in Grid
1010

1111
@signature: {'enable(): void;'}
1212

docs/grid/api/rangeselection/disable_method.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: You can explore the disable method of Grid range selection in the d
66

77
# disable()
88

9-
@short: disables the `RangeSelection` module and resets the current range
9+
@short: disables the RangeSelection module and resets the current range in Grid
1010

1111
### Usage
1212

docs/grid/api/rangeselection/enable_method.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: You can explore the enable method of Grid range selection in the do
66

77
# enable()
88

9-
@short: activates the `RangeSelection` module
9+
@short: enables the RangeSelection module and activates the capabilities of range selection in Grid
1010

1111
### Usage
1212

docs/grid/api/rangeselection/getrange_method.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: You can explore the getRange method of Grid range selection in the
66

77
# getRange()
88

9-
@short: returns the current selection range or `null` if no range is set
9+
@short: returns the current selection range
1010

1111
### Usage
1212

docs/grid/configuration.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2083,6 +2083,10 @@ If you use the GPL version of DHTMLX Grid (or DHTMLX Suite), you will be able to
20832083
**Note**, to be able to drag-n-drop a column and (or) multiple rows, you need to use PRO version of the DHTMLX Grid (or DHTMLX Suite) package.
20842084
:::
20852085
2086+
![](../assets/grid/dnd_treegrid_mode.png)
2087+
2088+
**Related sample**: [Grid. Drag-and-Drop in TreeGrid mode](https://snippet.dhtmlx.com/0tuk0y5f)
2089+
20862090
### Drag-n-drop inside the grid
20872091
20882092
It is possible to reorder a row or column of Grid by drag and drop. To enable the functionality, define the [`dragItem: "both"`](grid/api/grid_dragitem_config.md) property in the configuration object of Grid:
@@ -2446,7 +2450,7 @@ The list of the shortcut keys for editing:
24462450
</tr>
24472451
<tr>
24482452
<td><b>Delete</b></td>
2449-
<td>clears the data in the selected cells. Works only with the <a href="../usage_blockselection/#keyboard-navigation">`BlockSelection` module</a> in the "range" mode</td>
2453+
<td>clears data in the selected cells. Works only with the <a href="../usage_blockselection/#keyboard-navigation">`BlockSelection` module</a> in the "range" mode</td>
24502454
</tr>
24512455
</tbody>
24522456
</table>

docs/grid/features.md

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,17 @@ In this section you can find out how to initialize Grid, how to load data into t
4646

4747
## How to configure Grid
4848

49+
### How to work with TreeGrid mode
50+
51+
In this section you will find the ways of working with the TreeGrid mode of Grid.
52+
53+
| Topic | Description |
54+
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
55+
| [Enabling TreeGrid mode](../treegrid_mode/#initialization) | Learn how to enable the TreeGrid mode of Grid |
56+
| [Configuring TreeGrid mode](../treegrid_mode/#configuration)| Learn how to configure the TreeGrid mode of Grid |
57+
| [Data loading in TreeGrid mode](../treegrid_mode/#data-loading)| Learn how to load data in the TreeGrid mode of Grid |
58+
| [Working with TreeGrid mode](../treegrid_mode/#work-with-grid-in-the-treegrid-mode) | Learn how to expand/collapse nodes |
59+
4960
### How to configure columns
5061

5162
In this section you will get to know how to configure Grid columns on Grid initialization.
@@ -124,7 +135,7 @@ In this section you will get to know how to configure the drag-n-drop functional
124135
| [Drag-n-drop between grids](../configuration/#drag-n-drop-between-grids) | Learn how to configure drag-n-drop between grids ([Example](https://snippet.dhtmlx.com/qx9a86ax)) |
125136
| [Drag-n-drop of multiple rows](grid/configuration.md#drag-n-drop-of-multiple-rows) | Learn how to allow end users to drag-n-drop several rows at once |
126137
| [Copying of rows during drag-n-drop](../api/grid_dragcopy_config/) | Learn how to copy a row to a target during drag-n-drop ([Example](https://snippet.dhtmlx.com/23slivyz)) |
127-
| [Using the DragPanel module](../usage_dragpanel/) | Learn how to use the DragPanel module that provides additional functionality for moving rows in the Grid |
138+
| [Using the DragPanel module](../usage_dragpanel/) | Learn how to use the DragPanel module that provides additional functionality for moving rows in the Grid ([Example](https://snippet.dhtmlx.com/oyk02cr6)) |
128139

129140
## How to render custom statistics in the column header/footer and in the spans
130141

@@ -291,7 +302,7 @@ In this section you will get to know how to work with the range selection functi
291302
| Topic | Description |
292303
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
293304
| [Configuring range selection](../configuration/#managing-range-selection-in-grid) | Learn how to configure the range selection module within Grid |
294-
| [Working with range selection](../usage_rangeselection/) | Learn how to enable/disable range selection, set/reset range selection, get the range selection object, and check whether a cell is in the range |
305+
| [Working with range selection](../usage_rangeselection/) | Learn how to enable/disable range selection, set/reset range selection, get the range selection object, and check whether a cell is in the range ([Example](https://snippet.dhtmlx.com/42fp5qvt)) |
295306
| [Range Selection API](../../category/rangeselection-api/) | Learn how to use the API of the RangeSelection module to manage the range selection within Grid |
296307

297308

@@ -301,7 +312,7 @@ In this section you will get to know how to work with the block selection functi
301312

302313
| Topic | Description |
303314
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
304-
| [Configuring block selection](../configuration/#managing-block-selection-in-grid) | Learn how to configure the block selection module within Grid ([Example](https://snippet.dhtmlx.com/8gx20g1d)) |
315+
| [Configuring block selection](../configuration/#managing-block-selection-in-grid) | Learn how to configure the block selection module within Grid ([Example](https://snippet.dhtmlx.com/8kttktiy)) |
305316
| [Working with block selection](../usage_blockselection/) | Learn how to enable/disable block selection in Grid, check the main features of the BlockSelection module and explore how it interacts with other modules |
306317
| [BlockSelection API](../../category/blockselection-api/) | Learn how to use API of the BlockSelection module to manage the block selection within Grid |
307318

@@ -311,7 +322,7 @@ In this section you will get to know how to work with the clipboard functionalit
311322

312323
| Topic | Description |
313324
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
314-
| [Configuring clipboard](../configuration/#clipboard) | Learn how to configure the Clipboard module within Grid |
325+
| [Configuring clipboard](../configuration/#clipboard) | Learn how to configure the Clipboard module within Grid ([Example](https://snippet.dhtmlx.com/1fnkhwm0)) |
315326
| [Working with clipboard](../usage_clipboard/) | Learn how to enable the clipboard in Grid, check the main features and explore the peculiarities of using the Clipboard module |
316327
| [Clipboard API](../../category/clipboard-events/) | Learn how to use API of the Clipboard module to manage the clipboard operations within Grid |
317328

@@ -321,23 +332,11 @@ In this section you will get to know how to work with the history of Grid action
321332

322333
| Topic | Description |
323334
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
324-
| [Configuring history of Grid actions](../configuration/#history-of-grid-actions) | Learn how to configure the History module within Grid |
335+
| [Configuring history of Grid actions](../configuration/#history-of-grid-actions) | Learn how to configure the History module within Grid ([Example](https://snippet.dhtmlx.com/m88562wf)) |
325336
| [Working with history of actions](../usage_history/) | Learn how to enable the history of actions in Grid, check the main features and explore the peculiarities of using the History module |
326337
| [History API](../../category/history-api/) | Learn how to use API of the History module to manage the history of operations within Grid |
327338

328339

329-
## How to work with TreeGrid mode
330-
331-
In this section you will find the ways of working with the TreeGrid mode of Grid.
332-
333-
| Topic | Description |
334-
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
335-
| [Enabling TreeGrid mode](../treegrid_mode/#initialization) | Learn how to enable the TreeGrid mode of Grid |
336-
| [Configuring TreeGrid mode](../treegrid_mode/#configuration)| Learn how to configure the TreeGrid mode of Grid |
337-
| [Data loading in TreeGrid mode](../treegrid_mode/#data-loading)| Learn how to load data in the TreeGrid mode of Grid |
338-
| [Working with TreeGrid mode](../treegrid_mode/#work-with-grid-in-the-treegrid-mode) | Learn how to expand/collapse nodes |
339-
340-
341340
## How to scroll Grid
342341

343342
In this section you will learn how to scroll Grid to the necessary position.
@@ -384,7 +383,14 @@ In this section you can find out corresponding references of Grid API.
384383
| [Grid properties](../api/api_overview/#grid-properties) | Check the list of Grid properties |
385384
| [Grid column properties](../api/api_gridcolumn_properties/) | Check the list of properties of a Grid column |
386385
| [DataCollection API](../../data_collection/) | Check the API of DataCollection to work with Grid data |
387-
| [Selection API](../../category/selection-api/) | Check the API of Selection to manage the selection of Grid cells |
386+
| [TreeCollection API](../../tree_collection/) | Check the API of TreeCollection to work with Grid data in the TreeGrid mode |
387+
| [Selection API](../../category/selection-api/) | Check the API of the Selection object to manage the selection of Grid cells |
388+
| [RangeSelection API](../../category/rangeselection-api/) | Check the API of the RangeSelection module to manage the range selection in Grid |
389+
| [BlockSelection API](../../category/blockselection-api/) | Check the API of the BlockSelection module to manage the block selection in Grid |
390+
| [Clipboard API](../../category/clipboard-events/) | Check the API of the Clipboard module to work with clipboard in Grid |
391+
| [DragPanel API](../../category/dragpanel-events/) | Check the API of the DragPanel module to work with drag panel within Grid |
392+
| [History API](../../category/history-api/) | Check the API of the History module to work with the history of Grid actions |
393+
| [Export API](../../category/export-methods-1/) | Check the API of the Export module to export Grid data |
388394

389395

390396
## Common functionality

docs/whatsnew.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,9 @@ Released on June X, 2025
3838

3939
### Updates
4040

41-
- Grid. The logic and appearance of the [drag-n-drop functionality](grid/configuration.md/#drag-n-drop) is improved
41+
- Grid. The logic and appearance of the [drag-n-drop functionality](grid/configuration.md/#drag-n-drop) is improved. Check the [related sample](https://snippet.dhtmlx.com/0tuk0y5f)
4242
- Grid. The [export to Excel](grid/usage.md/#exporting-data-to-excel) functionality is updated
43-
- Grid. The possibility to clear data while editing a cell by using the `Delete` shortcut key is added
43+
- Grid. The possibility to [clear data in selected cells by using the `Delete` shortcut key](grid/configuration.md/#shortcut-keys-for-editing) is added
4444

4545
### Fixes
4646

0 commit comments

Comments
 (0)