Skip to content

Commit 17017fa

Browse files
mafanya23mafanya23
committed
[update] move treegrid configs to grid api
1 parent 93ee18f commit 17017fa

File tree

7 files changed

+18
-43
lines changed

7 files changed

+18
-43
lines changed

‎docs/grid/api/api_overview.md‎

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -179,10 +179,12 @@ description: You can explore the API of Grid in the documentation of the DHTMLX
179179
| [](grid/api/grid_autowidth_config.md) | @getshort(grid/api/grid_autowidth_config.md) |
180180
| [](grid/api/grid_bottomsplit_config.md) | @getshort(grid/api/grid_bottomsplit_config.md) |
181181
| [](grid/api/grid_closable_config.md) | @getshort(grid/api/grid_closable_config.md) |
182+
| [](grid/api/grid_collapsed_config.md) | @getshort(grid/api/grid_collapsed_config.md) |
182183
| [](grid/api/grid_columns_config.md) | @getshort(grid/api/grid_columns_config.md) |
183184
| [](grid/api/grid_css_config.md) | @getshort(grid/api/grid_css_config.md) |
184185
| [](grid/api/grid_data_config.md) | @getshort(grid/api/grid_data_config.md) |
185186
| [](grid/api/grid_dragcopy_config.md) | @getshort(grid/api/grid_dragcopy_config.md) |
187+
| [](grid/api/grid_dragexpand_config.md) | @getshort(grid/api/grid_dragexpand_config.md) |
186188
| [](grid/api/grid_dragitem_config.md) | @getshort(grid/api/grid_dragitem_config.md) |
187189
| [](grid/api/grid_dragmode_config.md) | @getshort(grid/api/grid_dragmode_config.md) |
188190
| [](grid/api/grid_editable_config.md) | @getshort(grid/api/grid_editable_config.md) |
@@ -203,6 +205,7 @@ description: You can explore the API of Grid in the documentation of the DHTMLX
203205
| [](grid/api/grid_multiselection_config.md) | @getshort(grid/api/grid_multiselection_config.md) |
204206
| [](grid/api/grid_resizable_config.md) | @getshort(grid/api/grid_resizable_config.md) |
205207
| [](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) |
206209
| [](grid/api/grid_rowcss_config.md) | @getshort(grid/api/grid_rowcss_config.md) |
207210
| [](grid/api/grid_rowheight_config.md) | @getshort(grid/api/grid_rowheight_config.md) |
208211
| [](grid/api/grid_selection_config.md) | @getshort(grid/api/grid_selection_config.md) |
@@ -251,12 +254,3 @@ You will find the list of all the available configuration properties of a Grid c
251254
| [](grid/api/export/grid_png_method.md) | @getshort(grid/api/export/grid_png_method.md) |
252255
| [](grid/api/export/grid_xlsx_method.md) | @getshort(grid/api/export/grid_xlsx_method.md) |
253256

254-
## TreeGrid mode API
255-
256-
### TreeGrid mode properties
257-
258-
| Name | Description |
259-
| --------------------------------------------------- | ---------------------------------------------------------- |
260-
| [](grid/api/treegrid_mode/grid_collapsed_config.md) | @getshort(grid/api/treegrid_mode/grid_collapsed_config.md) |
261-
| [](grid/api/treegrid_mode/grid_dragexpand_config.md)| @getshort(grid/api/treegrid_mode/grid_dragexpand_config.md)|
262-
| [](grid/api/treegrid_mode/grid_rootparent_config.md)| @getshort(grid/api/treegrid_mode/grid_rootparent_config.md)|

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_rootparent_config.md renamed to docs/grid/api/grid_rootparent_config.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ description: You can explore the rootParent config of Grid in the documentation
88

99
@short: Optional. Defines the id of the root parent
1010

11+
:::note
12+
The property works only for Grid with the `type: "tree"` configuration option
13+
:::
14+
1115
@signature: rootParent?: string;
1216

1317
@example:
@@ -26,6 +30,6 @@ const grid = new dhx.Grid("grid_container", {
2630
@descr:
2731

2832
By default, the root parent takes the id of the Grid container.
29-
If the id of the container is set to null or defined as an HTML element, the value of the root parent will be auto-generated.
33+
If the id of the container is set to `null` or defined as an HTML element, the value of the root parent will be auto-generated.
3034

3135
@changelog: added in v7.1

‎docs/grid/treegrid_mode.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ There is also a set of properties you can provide for Grid in the TreeGrid mode
4040

4141
### Collapsed mode
4242

43-
To initialize Grid in the TreeGrid mode in the collapsed state, use the [collapsed](grid/api/treegrid_mode/grid_collapsed_config.md) property:
43+
To initialize Grid in the TreeGrid mode in the collapsed state, use the [collapsed](grid/api/grid_collapsed_config.md) property:
4444

4545
~~~jsx {7}
4646
const grid = new dhx.Grid("grid_container", {
@@ -57,7 +57,7 @@ const grid = new dhx.Grid("grid_container", {
5757

5858
### Expanding collapsed rows on drag-n-drop
5959

60-
If you have collapsed rows in your Grid in the TreeGrid mode, they will expand automatically when you move the mouse pointer over them during drag-n-drop. To disable this functionality, set the [dragExpand](grid/api/treegrid_mode/grid_dragexpand_config.md) property to *false*:
60+
If you have collapsed rows in your Grid in the TreeGrid mode, they will expand automatically when you move the mouse pointer over them during drag-n-drop. To disable this functionality, set the [dragExpand](grid/api/grid_dragexpand_config.md) property to *false*:
6161

6262
~~~jsx {7}
6363
const grid = new dhx.Grid("grid_container", {
@@ -75,7 +75,7 @@ const grid = new dhx.Grid("grid_container", {
7575

7676
### Defining the id of the root parent
7777

78-
To define the id of the root parent, use the [rootParent](grid/api/treegrid_mode/grid_rootparent_config.md) configuration property:
78+
To define the id of the root parent, use the [rootParent](grid/api/grid_rootparent_config.md) configuration property:
7979

8080
~~~jsx {3}
8181
const grid = new dhx.Grid("grid_container", {

‎docs/whatsnew.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -785,9 +785,9 @@ Released on April 18, 2023
785785
- [the ability to select multiple cells/rows in TreeGrid](grid/configuration.md#multiple-selection-of-grid-cells)
786786
- [the ability to drag-n-drop multiple rows](grid/configuration.md#drag-n-drop-of-multiple-rows)
787787
- The ability to define [whether collapsed rows should expand while hovering them over during drag-n-drop](grid/configuration.md):
788-
- new property: [`dragExpand`](grid/api/treegrid_mode/grid_dragexpand_config.md)
788+
- new property: [`dragExpand`](grid/api/grid_dragexpand_config.md)
789789
- The ability to initialize TreeGrid in the collapsed state:
790-
- new property: [`collapsed`](grid/api/treegrid_mode/grid_collapsed_config.md)
790+
- new property: [`collapsed`](grid/api/grid_collapsed_config.md)
791791

792792
### Updates
793793

@@ -1691,7 +1691,7 @@ Check the [Migration article](migration.md#70---71) to keep in step with the lat
16911691
- The ability to [customize the tooltip of a column](grid/customization.md#adding-template-to-tooltip) via the [tooltipTemplate](grid/api/api_gridcolumn_properties.md) configuration option of a TreeGrid column
16921692
- The ability [to define the height for a separate row of TreeGrid](grid/configuration.md#row-height)
16931693
- New events are added: [beforeRowResize](grid/api/grid_beforerowresize_event.md) and [afterRowResize](grid/api/grid_afterrowresize_event.md), [beforeSort](grid/api/grid_beforesort_event.md) and [afterSort](grid/api/grid_aftersort_event.md)
1694-
- The ability to define the id of the parent root via the [rootParent](grid/api/treegrid_mode/grid_rootparent_config.md) configuration option of TreeGrid
1694+
- The ability to define the id of the parent root via the [rootParent](grid/api/grid_rootparent_config.md) configuration option of TreeGrid
16951695

16961696
#### Window
16971697

‎sidebars.js‎

Lines changed: 3 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -2618,10 +2618,12 @@ module.exports = {
26182618
"grid/api/grid_autowidth_config",
26192619
"grid/api/grid_bottomsplit_config",
26202620
"grid/api/grid_closable_config",
2621+
"grid/api/grid_collapsed_config",
26212622
"grid/api/grid_columns_config",
26222623
"grid/api/grid_css_config",
26232624
"grid/api/grid_data_config",
26242625
"grid/api/grid_dragcopy_config",
2626+
"grid/api/grid_dragexpand_config",
26252627
"grid/api/grid_dragitem_config",
26262628
"grid/api/grid_dragmode_config",
26272629
"grid/api/grid_editable_config",
@@ -2642,6 +2644,7 @@ module.exports = {
26422644
"grid/api/grid_multiselection_config",
26432645
"grid/api/grid_resizable_config",
26442646
"grid/api/grid_rightsplit_config",
2647+
"grid/api/grid_rootparent_config",
26452648
"grid/api/grid_rowcss_config",
26462649
"grid/api/grid_rowheight_config",
26472650
"grid/api/grid_selection_config",
@@ -2732,32 +2735,6 @@ module.exports = {
27322735
"grid/api/export/grid_xlsx_method"
27332736
],
27342737
},
2735-
{
2736-
type: "category",
2737-
label: "TreeGrid mode API",
2738-
link: {
2739-
type: 'generated-index',
2740-
title: "TreeGrid mode API",
2741-
keywords: ['treegrid mode api'],
2742-
image: '/img/docusaurus.png'
2743-
},
2744-
items: [
2745-
{
2746-
type: "category",
2747-
label: "Properties",
2748-
link: {
2749-
type: 'generated-index',
2750-
title: "Properties",
2751-
keywords: ['grid treegrid mode properties'],
2752-
image: '/img/docusaurus.png'
2753-
},
2754-
items: [
2755-
"grid/api/treegrid_mode/grid_collapsed_config",
2756-
"grid/api/treegrid_mode/grid_dragexpand_config",
2757-
"grid/api/treegrid_mode/grid_rootparent_config",
2758-
],
2759-
},
2760-
]},
27612738
],
27622739
},
27632740
"grid/features",

0 commit comments

Comments
 (0)