Skip to content

Commit 69f9afd

Browse files
mafanya23mafanya23
committed
Merge branch 'next' into 9.1
2 parents 7e212f9 + 0012371 commit 69f9afd

26 files changed

+815
-210
lines changed

‎docs/grid/api/api_overview.md‎

Lines changed: 15 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,13 @@ description: You can explore the API of Grid in the documentation of the DHTMLX
1414
| [](grid/api/grid_addrowcss_method.md) | @getshort(grid/api/grid_addrowcss_method.md) |
1515
| [](grid/api/grid_addspan_method.md) | @getshort(grid/api/grid_addspan_method.md) |
1616
| [](grid/api/grid_adjustcolumnwidth_method.md) | @getshort(grid/api/grid_adjustcolumnwidth_method.md) |
17+
| [](grid/api/grid_collapse_method.md) | @getshort(grid/api/grid_collapse_method.md) |
18+
| [](grid/api/grid_collapseall_method.md) | @getshort(grid/api/grid_collapseall_method.md) |
1719
| [](grid/api/grid_destructor_method.md) | @getshort(grid/api/grid_destructor_method.md) |
1820
| [](grid/api/grid_editcell_method.md) | @getshort(grid/api/grid_editcell_method.md) |
1921
| [](grid/api/grid_editend_method.md) | @getshort(grid/api/grid_editend_method.md) |
22+
| [](grid/api/grid_expand_method.md) | @getshort(grid/api/grid_expand_method.md) |
23+
| [](grid/api/grid_expandall_method.md) | @getshort(grid/api/grid_expandall_method.md) |
2024
| [](grid/api/grid_getcellrect_method.md) | @getshort(grid/api/grid_getcellrect_method.md) |
2125
| [](grid/api/grid_getcolumn_method.md) | @getshort(grid/api/grid_getcolumn_method.md) |
2226
| [](grid/api/grid_getheaderfilter_method.md) | @getshort(grid/api/grid_getheaderfilter_method.md) |
@@ -40,6 +44,7 @@ description: You can explore the API of Grid in the documentation of the DHTMLX
4044
:::info important
4145
- Use [the methods of DataCollection](data_collection.md) to work with data.
4246
- Apply [the methods of Selection](grid/api/api_overview.md#selection-methods) to manage the selection of Grid cells.
47+
- Use [the methods of TreeCollection](tree_collection.md#methods) to work with data of Grid in the TreeGrid mode.
4348
:::
4449

4550
## Grid events
@@ -48,10 +53,14 @@ description: You can explore the API of Grid in the documentation of the DHTMLX
4853

4954
| Name | Description |
5055
| ------------------------------------------ | ------------------------------------------------- |
56+
| [](grid/api/grid_aftercollapse_event.md) | @getshort(grid/api/grid_aftercollapse_event.md) |
5157
| [](grid/api/grid_aftereditend_event.md) | @getshort(grid/api/grid_aftereditend_event.md) |
5258
| [](grid/api/grid_aftereditstart_event.md) | @getshort(grid/api/grid_aftereditstart_event.md) |
59+
| [](grid/api/grid_afterexpand_event.md) | @getshort(grid/api/grid_afterexpand_event.md) |
60+
| [](grid/api/grid_beforecollapse_event.md) | @getshort(grid/api/grid_beforecollapse_event.md) |
5361
| [](grid/api/grid_beforeeditend_event.md) | @getshort(grid/api/grid_beforeeditend_event.md) |
5462
| [](grid/api/grid_beforeeditstart_event.md) | @getshort(grid/api/grid_beforeeditstart_event.md) |
63+
| [](grid/api/grid_beforeexpand_event.md) | @getshort(grid/api/grid_beforeexpand_event.md) |
5564

5665
### Mouse
5766

@@ -156,6 +165,7 @@ description: You can explore the API of Grid in the documentation of the DHTMLX
156165
:::info important
157166
- Use [the events of DataCollection](data_collection.md#events) to work with data of Grid.
158167
- Apply [the events of Selection](grid/api/api_overview.md#selection-events) to handle the selection of Grid cells.
168+
- Use [the events of TreeCollection](tree_collection.md#events) to work with data of Grid in the TreeGrid mode.
159169
:::
160170

161171
## Grid properties
@@ -168,10 +178,12 @@ description: You can explore the API of Grid in the documentation of the DHTMLX
168178
| [](grid/api/grid_autowidth_config.md) | @getshort(grid/api/grid_autowidth_config.md) |
169179
| [](grid/api/grid_bottomsplit_config.md) | @getshort(grid/api/grid_bottomsplit_config.md) |
170180
| [](grid/api/grid_closable_config.md) | @getshort(grid/api/grid_closable_config.md) |
181+
| [](grid/api/grid_collapsed_config.md) | @getshort(grid/api/grid_collapsed_config.md) |
171182
| [](grid/api/grid_columns_config.md) | @getshort(grid/api/grid_columns_config.md) |
172183
| [](grid/api/grid_css_config.md) | @getshort(grid/api/grid_css_config.md) |
173184
| [](grid/api/grid_data_config.md) | @getshort(grid/api/grid_data_config.md) |
174185
| [](grid/api/grid_dragcopy_config.md) | @getshort(grid/api/grid_dragcopy_config.md) |
186+
| [](grid/api/grid_dragexpand_config.md) | @getshort(grid/api/grid_dragexpand_config.md) |
175187
| [](grid/api/grid_dragitem_config.md) | @getshort(grid/api/grid_dragitem_config.md) |
176188
| [](grid/api/grid_dragmode_config.md) | @getshort(grid/api/grid_dragmode_config.md) |
177189
| [](grid/api/grid_editable_config.md) | @getshort(grid/api/grid_editable_config.md) |
@@ -193,11 +205,14 @@ description: You can explore the API of Grid in the documentation of the DHTMLX
193205
| [](grid/api/grid_multisort_config.md) | @getshort(grid/api/grid_multisort_config.md) |
194206
| [](grid/api/grid_resizable_config.md) | @getshort(grid/api/grid_resizable_config.md) |
195207
| [](grid/api/grid_rightsplit_config.md) | @getshort(grid/api/grid_rightsplit_config.md) |
208+
| [](grid/api/grid_rootparent_config.md) | @getshort(grid/api/grid_rootparent_config.md) |
196209
| [](grid/api/grid_rowcss_config.md) | @getshort(grid/api/grid_rowcss_config.md) |
197210
| [](grid/api/grid_rowheight_config.md) | @getshort(grid/api/grid_rowheight_config.md) |
198211
| [](grid/api/grid_selection_config.md) | @getshort(grid/api/grid_selection_config.md) |
199212
| [](grid/api/grid_sortable_config.md) | @getshort(grid/api/grid_sortable_config.md) |
200213
| [](grid/api/grid_spans_config.md) | @getshort(grid/api/grid_spans_config.md) |
214+
| [](grid/api/grid_subrow_config.md) | @getshort(grid/api/grid_subrow_config.md) |
215+
| [](grid/api/grid_subrowconfig_config.md) | @getshort(grid/api/grid_subrowconfig_config.md) |
201216
| [](grid/api/grid_summary_config.md) | @getshort(grid/api/grid_summary_config.md) |
202217
| [](grid/api/grid_tooltip_config.md) | @getshort(grid/api/grid_tooltip_config.md) |
203218
| [](grid/api/grid_topsplit_config.md) | @getshort(grid/api/grid_topsplit_config.md) |
@@ -239,39 +254,3 @@ You will find the list of all the available configuration properties of a Grid c
239254
| [](grid/api/export/grid_png_method.md) | @getshort(grid/api/export/grid_png_method.md) |
240255
| [](grid/api/export/grid_xlsx_method.md) | @getshort(grid/api/export/grid_xlsx_method.md) |
241256

242-
## TreeGrid mode API
243-
244-
### TreeGrid mode methods
245-
246-
| Name | Description |
247-
| ----------------------------------------------------- | ------------------------------------------------------------ |
248-
| [](grid/api/treegrid_mode/grid_collapse_method.md) | @getshort(grid/api/treegrid_mode/grid_collapse_method.md) |
249-
| [](grid/api/treegrid_mode/grid_collapseall_method.md) | @getshort(grid/api/treegrid_mode/grid_collapseall_method.md) |
250-
| [](grid/api/treegrid_mode/grid_expand_method.md) | @getshort(grid/api/treegrid_mode/grid_expand_method.md) |
251-
| [](grid/api/treegrid_mode/grid_expandall_method.md) | @getshort(grid/api/treegrid_mode/grid_expandall_method.md) |
252-
253-
:::info important
254-
- Use [the methods of TreeCollection](tree_collection.md) to work with data of Grid in the TreeGrid mode.
255-
:::
256-
257-
### TreeGrid mode events
258-
259-
| Name | Description |
260-
| ------------------------------------------------------- | ------------------------------------------------------------- |
261-
| [](grid/api/treegrid_mode/grid_aftercollapse_event.md) | @getshort(grid/api/treegrid_mode/grid_aftercollapse_event.md) |
262-
| [](grid/api/treegrid_mode/grid_afterexpand_event.md) | @getshort(grid/api/treegrid_mode/grid_afterexpand_event.md) |
263-
| [](grid/api/treegrid_mode/grid_beforecollapse_event.md) | @getshort(grid/api/treegrid_mode/grid_beforecollapse_event.md)|
264-
| [](grid/api/treegrid_mode/grid_beforeexpand_event.md) | @getshort(grid/api/treegrid_mode/grid_beforeexpand_event.md) |
265-
| [](grid/api/treegrid_mode/grid_expand_event.md) | @getshort(grid/api/treegrid_mode/grid_beforecollapse_event.md)|
266-
267-
:::info important
268-
- Use [the events of TreeCollection](tree_collection.md#events) to work with data of Grid in the TreeGrid mode.
269-
:::
270-
271-
### TreeGrid mode properties
272-
273-
| Name | Description |
274-
| --------------------------------------------------- | ---------------------------------------------------------- |
275-
| [](grid/api/treegrid_mode/grid_collapsed_config.md) | @getshort(grid/api/treegrid_mode/grid_collapsed_config.md) |
276-
| [](grid/api/treegrid_mode/grid_dragexpand_config.md)| @getshort(grid/api/treegrid_mode/grid_dragexpand_config.md)|
277-
| [](grid/api/treegrid_mode/grid_rootparent_config.md)| @getshort(grid/api/treegrid_mode/grid_rootparent_config.md)|

docs/grid/api/treegrid_mode/grid_aftercollapse_event.md renamed to docs/grid/api/grid_aftercollapse_event.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,12 @@ description: You can explore the afterCollapse event of Grid in the documentatio
66

77
# afterCollapse
88

9-
@short: fires after collapsing Grid in the TreeGrid mode
9+
@short: fires after collapsing a row that contains child rows
1010

1111
:::note
12-
The event works only for Grid with the `type: "tree"` configuration option
12+
The event works:
13+
- for Grid in the default mode with the `subRow` configuration option
14+
- for Grid in the TreeGrid mode (with the `type: "tree"` configuration option)
1315
:::
1416

1517
@signature: {'afterCollapse: (rowId: string | number) => void;'}
@@ -18,7 +20,11 @@ The event works only for Grid with the `type: "tree"` configuration option
1820
The callback of the event is called with the following parameter:
1921
- `rowId: string | number` - the id of a collapsed row
2022

21-
@example:
23+
@descr:
24+
25+
### Example
26+
27+
~~~jsx {2,9-11}
2228
const grid = new dhx.Grid("grid_container", {
2329
type: "tree",
2430
columns: [
@@ -30,8 +36,8 @@ const grid = new dhx.Grid("grid_container", {
3036
grid.events.on("afterCollapse", (rowId) => {
3137
// your logic here
3238
});
39+
~~~
3340

34-
@descr:
3541

3642

3743
@changelog: added in v6.4

docs/grid/api/treegrid_mode/grid_afterexpand_event.md renamed to docs/grid/api/grid_afterexpand_event.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,12 @@ description: You can explore the afterExpand event of Grid in the documentation
66

77
# afterExpand
88

9-
@short: fires after expanding Grid in the TreeGrid mode
9+
@short: fires after expanding a row that contains child rows
1010

1111
:::note
12-
The event works only for Grid with the `type: "tree"` configuration option
12+
The event works:
13+
- for Grid in the default mode with the `subRow` configuration option
14+
- for Grid in the TreeGrid mode (with the `type: "tree"` configuration option)
1315
:::
1416

1517
@signature: {'afterExpand: (rowId: string | number) => void;'}
@@ -19,7 +21,11 @@ The callback of the event is called with the following parameter:
1921

2022
- `rowId: string | number` - the id of an expanded row
2123

22-
@example:
24+
@descr:
25+
26+
### Example
27+
28+
~~~jsx {2,9-11}
2329
const grid = new dhx.Grid("grid_container", {
2430
type: "tree",
2531
columns: [
@@ -31,9 +37,7 @@ const grid = new dhx.Grid("grid_container", {
3137
grid.events.on("afterExpand", (rowId) => {
3238
// your logic here
3339
});
34-
35-
@descr:
36-
40+
~~~
3741

3842

3943
@changelog: added in v6.4

docs/grid/api/treegrid_mode/grid_beforecollapse_event.md renamed to docs/grid/api/grid_beforecollapse_event.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,12 @@ description: You can explore the beforeCollapse event of Grid in the documentati
66

77
# beforeCollapse
88

9-
@short: fires before collapsing Grid in the TreeGrid mode
9+
@short: fires before collapsing a row that contains child rows
1010

1111
:::note
12-
The event works only for Grid with the `type: "tree"` configuration option
12+
The event works:
13+
- for Grid in the default mode with the `subRow` configuration option
14+
- for Grid in the TreeGrid mode (with the `type: "tree"` configuration option)
1315
:::
1416

1517
@signature: {'beforeCollapse: (rowId: string | number) => boolean | void;'}
@@ -21,7 +23,11 @@ The callback of the event is called with the following parameter:
2123
@returns:
2224
Return `false` to block collapsing of a grid; otherwise, `true`.
2325

24-
@example:
26+
@descr:
27+
28+
### Example
29+
30+
~~~jsx {2,9-12}
2531
const grid = new dhx.Grid("grid_container", {
2632
type: "tree",
2733
columns: [
@@ -34,7 +40,7 @@ grid.events.on("beforeCollapse", (rowId) => {
3440
// your logic here
3541
return false;
3642
});
43+
~~~
3744

38-
@descr:
3945

4046
@changelog: added in v6.4

docs/grid/api/treegrid_mode/grid_beforeexpand_event.md renamed to docs/grid/api/grid_beforeexpand_event.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,29 @@ description: You can explore the beforeExpand event of Grid in the documentation
66

77
# beforeExpand
88

9-
@short: fires before expanding Grid in the TreeGrid mode
9+
@short: fires before expanding a row that contains child rows
1010

1111
:::note
12-
The event works only for Grid with the `type: "tree"` configuration option
12+
The event works:
13+
- for Grid in the default mode with the `subRow` configuration option
14+
- for Grid in the TreeGrid mode (with the `type: "tree"` configuration option)
1315
:::
1416

1517
@signature: {'beforeExpand: (rowId: string | number) => boolean | void;'}
1618

1719
@params:
18-
The callback of the event is called with the following parameters:
20+
The callback of the event is called with the following parameter:
1921

2022
- `rowId: string | number` - the id of an expanded row
2123

2224
@returns:
2325
Return `false` to block expanding of a grid; otherwise, `true`.
2426

25-
@example:
27+
@descr:
28+
29+
### Example
30+
31+
~~~jsx {2,9-12}
2632
const grid = new dhx.Grid("grid_container", {
2733
type: "tree",
2834
columns: [
@@ -35,9 +41,6 @@ grid.events.on("beforeExpand", (rowId) => {
3541
// your logic here
3642
return false;
3743
});
38-
39-
@descr:
40-
41-
44+
~~~
4245

4346
@changelog: added in v6.4

docs/grid/api/treegrid_mode/grid_collapse_method.md renamed to docs/grid/api/grid_collapse_method.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,22 @@ description: You can explore the collapse method of Grid in the documentation of
66

77
# collapse()
88

9-
@short: collapses a tree node by id
9+
@short: collapses a row that contains child rows by id
1010

1111
:::note
12-
The method works only for Grid with the `type: "tree"` configuration option
12+
The method works:
13+
- for Grid in the default mode with the `subRow` configuration option
14+
- for Grid in the TreeGrid mode (with the `type: "tree"` configuration option)
1315
:::
1416

1517
@signature: {'collapse(id: string | number): void;'}
1618

1719
@params:
18-
- `id: string | number` - the id of a node to collapse
20+
- `id: string | number` - the id of a row to collapse
1921

20-
@example:
22+
### Example
23+
24+
~~~jsx {2,9}
2125
const grid = new dhx.Grid("grid_container", {
2226
type: "tree",
2327
columns: [
@@ -27,6 +31,7 @@ const grid = new dhx.Grid("grid_container", {
2731
});
2832

2933
grid.collapse("native");
34+
~~~
3035

3136
@descr:
3237

docs/grid/api/treegrid_mode/grid_collapseall_method.md renamed to docs/grid/api/grid_collapseall_method.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,21 @@ description: You can explore the collapseAll method of Grid in the documentation
66

77
# collapseAll()
88

9-
@short: collapses all expanded tree nodes
9+
@short: collapses all expanded rows that contain child rows
1010

1111
:::note
12-
The method works only for Grid with the `type: "tree"` configuration option
12+
The method works:
13+
- for Grid in the default mode with the `subRow` configuration option
14+
- for Grid in the TreeGrid mode (with the `type: "tree"` configuration option)
1315
:::
1416

1517
@signature: {'collapseAll(): void;'}
1618

17-
@example:
19+
@descr:
20+
21+
### Example
22+
23+
~~~jsx {2,9}
1824
const grid = new dhx.Grid("grid_container", {
1925
type: "tree",
2026
columns: [
@@ -24,9 +30,7 @@ const grid = new dhx.Grid("grid_container", {
2430
});
2531

2632
grid.collapseAll();
27-
28-
@descr:
29-
33+
~~~
3034

3135

3236
@changelog: added in v6.3

docs/grid/api/treegrid_mode/grid_collapsed_config.md renamed to docs/grid/api/grid_collapsed_config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: You can explore the collapsed config of Grid in the documentation o
66

77
# collapsed
88

9-
@short: Optional. Defines that Grid in the TreeGrid mode is initialized in the collapsed state
9+
@short: Optional. Defines that Grid is initialized in the collapsed state
1010

1111
:::note
1212
The property works only for Grid with the `type: "tree"` configuration option

docs/grid/api/treegrid_mode/grid_dragexpand_config.md renamed to docs/grid/api/grid_dragexpand_config.md

File renamed without changes.

docs/grid/api/treegrid_mode/grid_expand_method.md renamed to docs/grid/api/grid_expand_method.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,22 @@ description: You can explore the expand method of Grid in the documentation of t
66

77
# expand()
88

9-
@short: expands a tree node by id
9+
@short: expands a row that contains child rows
1010

1111
:::note
12-
The method works only for Grid with the `type: "tree"` configuration option
12+
The method works:
13+
- for Grid in the default mode with the `subRow` configuration option
14+
- for Grid in the TreeGrid mode (with the `type: "tree"` configuration option)
1315
:::
1416

1517
@signature: {'expand(id: string | number): void;'}
1618

1719
@params:
18-
- `id: string | number` - the id of a node to expand
20+
- `id: string | number` - the id of a row to expand
1921

20-
@example:
22+
### Example
23+
24+
~~~jsx {2,9}
2125
const grid = new dhx.Grid("grid_container", {
2226
type: "tree",
2327
columns: [
@@ -27,5 +31,6 @@ const grid = new dhx.Grid("grid_container", {
2731
});
2832

2933
grid.expand("native");
34+
~~~
3035

3136
@descr:

0 commit comments

Comments
 (0)