@syncfusion/ej2-treegrid 20.4.54 → 21.1.37

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. package/CHANGELOG.md +2 -45
  2. package/dist/ej2-treegrid.min.js +2 -2
  3. package/dist/ej2-treegrid.umd.min.js +2 -2
  4. package/dist/ej2-treegrid.umd.min.js.map +1 -1
  5. package/dist/es6/ej2-treegrid.es2015.js +43 -15
  6. package/dist/es6/ej2-treegrid.es2015.js.map +1 -1
  7. package/dist/es6/ej2-treegrid.es5.js +42 -14
  8. package/dist/es6/ej2-treegrid.es5.js.map +1 -1
  9. package/dist/global/ej2-treegrid.min.js +2 -2
  10. package/dist/global/ej2-treegrid.min.js.map +1 -1
  11. package/dist/global/index.d.ts +1 -1
  12. package/package.json +10 -10
  13. package/src/treegrid/actions/freeze-column.js +3 -0
  14. package/src/treegrid/actions/rowdragdrop.js +8 -6
  15. package/src/treegrid/base/treegrid-model.d.ts +27 -16
  16. package/src/treegrid/base/treegrid.d.ts +33 -15
  17. package/src/treegrid/base/treegrid.js +29 -6
  18. package/src/treegrid/enum.d.ts +79 -138
  19. package/src/treegrid/models/column.d.ts +10 -8
  20. package/src/treegrid/models/edit-settings-model.d.ts +13 -9
  21. package/src/treegrid/models/edit-settings.d.ts +13 -9
  22. package/src/treegrid/models/filter-settings-model.d.ts +13 -8
  23. package/src/treegrid/models/filter-settings.d.ts +13 -8
  24. package/src/treegrid/models/loading-indicator-model.d.ts +4 -2
  25. package/src/treegrid/models/loading-indicator.d.ts +4 -2
  26. package/src/treegrid/models/page-settings-model.d.ts +1 -1
  27. package/src/treegrid/models/page-settings.d.ts +1 -1
  28. package/src/treegrid/models/search-settings-model.d.ts +9 -3
  29. package/src/treegrid/models/search-settings.d.ts +9 -3
  30. package/src/treegrid/models/selection-settings-model.d.ts +17 -8
  31. package/src/treegrid/models/selection-settings.d.ts +17 -8
  32. package/src/treegrid/models/summary-model.d.ts +2 -2
  33. package/src/treegrid/models/summary.d.ts +2 -2
  34. package/src/treegrid/renderer/render.js +2 -2
  35. package/styles/bootstrap-dark.css +2 -8
  36. package/styles/highcontrast-light.css +2 -8
  37. package/styles/treegrid/_bootstrap5-definition.scss +2 -2
  38. package/styles/treegrid/_fluent-definition.scss +2 -2
  39. package/styles/treegrid/_tailwind-definition.scss +2 -2
  40. package/styles/treegrid/bootstrap-dark.css +2 -8
  41. package/styles/treegrid/highcontrast-light.css +2 -8
  42. package/styles/treegrid/_material3-definition.scss +0 -28
@@ -1,49 +1,32 @@
1
1
  /**
2
- * Defines types of Filter Hierarchy
3
- * * Parent - Specifies the filter type as Parent.
4
- * * Child - Specifies the filter type as excel.
5
- * * Both - Specifies the filter type as filter bar
6
- * * None - Specifies the filter type as check box.
2
+ * Defines modes of Filter Hierarchy
3
+ * ```props
4
+ * * Parent :- Shows filtered records with its Parent records.
5
+ * * Child :- Shows filtered records with its Child records.
6
+ * * Both :- Shows filtered records with its Parent and Child records.
7
+ * * None :- Shows only the filetred records.
8
+ * ```
7
9
  */
8
- export declare type FilterHierarchyMode =
9
- /** Shows filtered records with its Parent records */
10
- 'Parent' |
11
- /** Shows filtered records with its Child records */
12
- 'Child' |
13
- /** Shows filtered records with its Parent and Child records */
14
- 'Both' |
15
- /** Shows only filetred records */
16
- 'None';
10
+ export declare type FilterHierarchyMode = 'Parent' | 'Child' | 'Both' | 'None';
17
11
  /**
18
12
  * Defines Predefined toolbar items.
19
- *
13
+ * ```props
14
+ * * Add :- Add new record.
15
+ * * Edit :- Edit the selected record.
16
+ * * Update :- Update the edited record.
17
+ * * Delete :- Delete the selected record.
18
+ * * Cancel :- Cancel the edited state.
19
+ * * Search :- Searches the TreeGrid records by given key.
20
+ * * ExpandAll :- Expands all the rows in TreeGrid.
21
+ * * CollapseAll :- Collapses all the rows in TreeGrid.
22
+ * * ExcelExport :- Export the TreeGrid to Excel.
23
+ * * PdfExport :- Export the TreeGrid to Pdf.
24
+ * * CsvExport :- Export the TreeGrid to Csv.
25
+ * * Print :- Print the TreeGrid.
26
+ * ```
20
27
  * @hidden
21
28
  */
22
- export declare type ToolbarItems =
23
- /** Add new record */
24
- 'Add' |
25
- /** Delete selected record */
26
- 'Delete' |
27
- /** Update edited record */
28
- 'Update' |
29
- /** Cancel the edited state */
30
- 'Cancel' |
31
- /** Edit the selected record */
32
- 'Edit' |
33
- /** Searches the TreeGrid records by given key */
34
- 'Search' |
35
- /** Expands all the rows in TreeGrid */
36
- 'ExpandAll' |
37
- /** Collapses all the rows in TreeGrid */
38
- 'CollapseAll' |
39
- /** Export the TreeGrid to Excel */
40
- 'ExcelExport' |
41
- /** Export the TreeGrid to Pdf */
42
- 'PdfExport' |
43
- /** Export the TreeGrid to Csv */
44
- 'CsvExport' |
45
- /** Print the TreeGrid */
46
- 'Print';
29
+ export declare type ToolbarItems = 'Add' | 'Delete' | 'Update' | 'Cancel' | 'Edit' | 'Search' | 'ExpandAll' | 'CollapseAll' | 'ExcelExport' | 'PdfExport' | 'CsvExport' | 'Print';
47
30
  /**
48
31
  * Defines Predefined toolbar items.
49
32
  *
@@ -67,56 +50,34 @@ export declare enum ToolbarItem {
67
50
  }
68
51
  /**
69
52
  * Defines different PageSizeMode
70
- * * All - Specifies the PageSizeMode as All
71
- * * Root - Specifies the PageSizeMode as Root
53
+ * ```props
54
+ * * All :- Defines the pageSizeMode as All
55
+ * * Root :- Defines the pageSizeMode as Root
56
+ * ```
72
57
  */
73
- export declare type PageSizeMode =
74
- /** Defines the pageSizeMode as All */
75
- 'All' |
76
- /** Defines the pageSizeMode as Root */
77
- 'Root';
58
+ export declare type PageSizeMode = 'All' | 'Root';
78
59
  /**
79
60
  * Defines predefined contextmenu items.
80
- *
61
+ * ```props
62
+ * * AutoFitAll :- Auto fit the size of all columns.
63
+ * * AutoFit :- Auto fit the current column.
64
+ * * SortAscending :- Sort the current column in ascending order.
65
+ * * SortDescending :- Sort the current column in descending order.
66
+ * * Edit :- Edit the current record.
67
+ * * Delete :- Delete the current record.
68
+ * * Save :- Save the edited record.
69
+ * * Cancel :- Cancel the edited state.
70
+ * * PdfExport :- Export the TreeGrid as Pdf format.
71
+ * * ExcelExport :- Export the TreeGrid as Excel format.
72
+ * * CsvExport :- Export the TreeGrid as CSV format.
73
+ * * FirstPage :- Go to the first page.
74
+ * * PrevPage :- Go to the previous page.
75
+ * * LastPage :- Go to the last page.
76
+ * * NextPage :- Go to the next page.
77
+ * ```
81
78
  * @hidden
82
79
  */
83
- export declare type ContextMenuItem =
84
- /** `AutoFitAll` - Auto fit the size of all columns. */
85
- 'AutoFitAll' |
86
- /** `AutoFit` - Auto fit the current column. */
87
- 'AutoFit' |
88
- /** `SortAscending` - Sort the current column in ascending order. */
89
- 'SortAscending' |
90
- /** `SortDescending` - Sort the current column in descending order. */
91
- 'SortDescending' |
92
- /** `Edit` - Edit the current record. */
93
- 'Edit' |
94
- /** `Delete` - Delete the current record. */
95
- 'Delete' |
96
- /** `Save` - Save the edited record. */
97
- 'Save' |
98
- /** `Cancel` - Cancel the edited state. */
99
- 'Cancel' |
100
- /** `PdfExport` - Export the TreeGrid as Pdf format. */
101
- 'PdfExport' |
102
- /** `ExcelExport` - Export the TreeGrid as Excel format. */
103
- 'ExcelExport' |
104
- /** `CsvExport` - Export the TreeGrid as CSV format. */
105
- 'CsvExport' |
106
- /** `FirstPage` - Go to the first page. */
107
- 'FirstPage' |
108
- /** `PrevPage` - Go to the previous page. */
109
- 'PrevPage' |
110
- /** `LastPage` - Go to the last page. */
111
- 'LastPage' |
112
- /** `NextPage` - Go to the next page. */
113
- 'NextPage' |
114
- /** AddRow to the TreeGrid */
115
- 'AddRow' |
116
- /** `Indent` - Indents the record to one level of hierarchy */
117
- 'Indent' |
118
- /** `Outdent` - Outdent the record to one level of hierarchy */
119
- 'Outdent';
80
+ export declare type ContextMenuItem = 'AutoFitAll' | 'AutoFit' | 'SortAscending' | 'SortDescending' | 'Edit' | 'Delete' | 'Save' | 'Cancel' | 'PdfExport' | 'ExcelExport' | 'CsvExport' | 'FirstPage' | 'PrevPage' | 'LastPage' | 'NextPage' | 'AddRow' | 'Indent' | 'Outdent';
120
81
  /**
121
82
  * Defines predefined contextmenu items.
122
83
  *
@@ -144,69 +105,49 @@ export declare enum ContextMenuItems {
144
105
  }
145
106
  /**
146
107
  * Defines modes of editing.
108
+ * ```props
109
+ * * Cell :- Defines the editing mode as Cell.
110
+ * * Row :- Defines the editing mode as Row.
111
+ * * Dialog :- Defines the editing mode as Dialog.
112
+ * * Batch :- Defines the editing mode as Batch.
113
+ * ```
147
114
  */
148
- export declare type EditMode =
149
- /** Defines EditMode as Cell */
150
- 'Cell' |
151
- /** Defines EditMode as Row */
152
- 'Row' |
153
- /** Defines EditMode as Dialog */
154
- 'Dialog' |
155
- /** Defines EditMode as Batch */
156
- 'Batch';
115
+ export declare type EditMode = 'Cell' | 'Row' | 'Dialog' | 'Batch';
157
116
  /**
158
117
  * Defines the position where the new row has to be added.
118
+ * ```props
119
+ * * Top :- Defines new row position as top of all rows.
120
+ * * Bottom :- Defines new row position as bottom of all rows.
121
+ * * Above :- Defines new row position as above the selected row.
122
+ * * Below :- Defines new row position as below the selected row.
123
+ * * Child :- Defines new row position as child to the selected row.
124
+ * ```
159
125
  */
160
- export declare type RowPosition =
161
- /** Defines new row position as top of all rows */
162
- 'Top' |
163
- /** Defines new row position as bottom of all rows */
164
- 'Bottom' |
165
- /** Defines new row position as above the selected row */
166
- 'Above' |
167
- /** Defines new row position as below the selected row */
168
- 'Below' |
169
- /** Defines new row position as child to the selected row */
170
- 'Child';
126
+ export declare type RowPosition = 'Top' | 'Bottom' | 'Above' | 'Below' | 'Child';
171
127
  /**
172
128
  * Defines types of Filter
173
- * * Menu - Specifies the filter type as menu.
174
- * * Excel - Specifies the filter type as excel.
175
- * * FilterBar - Specifies the filter type as filter bar.
129
+ * ```props
130
+ * * Menu :- Defines the filter type as Menu.
131
+ * * Excel :- Defines the filter type as Excel.
132
+ * * FilterBar :- Defines the filter type as FilterBar.
133
+ * ```
176
134
  */
177
- export declare type FilterType =
178
- /** Defines FilterType as filterbar */
179
- 'FilterBar' |
180
- /** Defines FilterType as excel */
181
- 'Excel' |
182
- /** Defines FilterType as menu */
183
- 'Menu';
135
+ export declare type FilterType = 'FilterBar' | 'Excel' | 'Menu';
184
136
  /**
185
137
  * Defines the wrap mode.
186
- * * Both - Wraps both header and content.
187
- * * Header - Wraps header alone.
188
- * * Content - Wraps content alone.
138
+ * ```props
139
+ * * Both :- Wraps both header and content.
140
+ * * Header :- Wraps header alone.
141
+ * * Content :- Wraps content alone.
189
142
  */
190
- export declare type WrapMode =
191
- /** Wraps both header and content */
192
- 'Both' |
193
- /** Wraps header alone */
194
- 'Header' |
195
- /** Wraps content alone */
196
- 'Content';
143
+ export declare type WrapMode = 'Both' | 'Header' | 'Content';
197
144
  /**
198
145
  * Defines types of CopyHierarchyMode. They are
199
- * * Parent
200
- * * Child
201
- * * Both
202
- * * None
146
+ * ```props
147
+ * * Parent :- Defines CopyHiearchyMode as Parent.
148
+ * * Child :- Defines CopyHiearchyMode as Child.
149
+ * * Both :- Defines CopyHiearchyMode as Both.
150
+ * * None :- Defines CopyHiearchyMode as None.
151
+ * ```
203
152
  */
204
- export declare type CopyHierarchyType =
205
- /** Defines CopyHiearchyMode as Parent */
206
- 'Parent' |
207
- /** Defines CopyHiearchyMode as Child */
208
- 'Child' |
209
- /** Defines CopyHiearchyMode as Both */
210
- 'Both' |
211
- /** Defines CopyHiearchyMode as None */
212
- 'None';
153
+ export declare type CopyHierarchyType = 'Parent' | 'Child' | 'Both' | 'None';
@@ -172,8 +172,8 @@ export declare class Column {
172
172
  /**
173
173
  * It is used to change display value with the given format and does not affect the original data.
174
174
  * Gets the format from the user which can be standard or custom
175
- * [`number`](../../../common/internationalization/#supported-format-string)
176
- * and [`date`](../../../common/internationalization/#supported-format-string-1) formats.
175
+ * [`number`](https://ej2.syncfusion.com/documentation/common/internationalization/#supported-format-string)
176
+ * and [`date`](https://ej2.syncfusion.com/documentation/common/internationalization/#supported-format-string-1) formats.
177
177
  *
178
178
  * @default null
179
179
  * @aspType string
@@ -403,9 +403,11 @@ export interface ColumnModel {
403
403
  columns?: Column[] | string[] | ColumnModel[];
404
404
  /**
405
405
  * Defines the cell content's overflow mode. The available modes are
406
- * * `Clip` - Truncates the cell content when it overflows its area.
407
- * * `Ellipsis` - Displays ellipsis when the cell content overflows its area.
408
- * * `EllipsisWithTooltip` - Displays ellipsis when the cell content overflows its area
406
+ * ```props
407
+ * * Clip :- Truncates the cell content when it overflows its area.
408
+ * * Ellipsis :- Displays ellipsis when the cell content overflows its area.
409
+ * * EllipsisWithTooltip :- Displays ellipsis when the cell content overflows its area also it will display tooltip while hover on ellipsis applied cell.
410
+ * ```
409
411
  * also it will display tooltip while hover on ellipsis applied cell.
410
412
  *
411
413
  * @default Syncfusion.EJ2.Grids.ClipMode.Ellipsis
@@ -471,8 +473,8 @@ export interface ColumnModel {
471
473
  /**
472
474
  * It is used to change display value with the given format and does not affect the original data.
473
475
  * Gets the format from the user which can be standard or custom
474
- * [`number`](../../../common/internationalization/#supported-format-string)
475
- * and [`date`](../../../common/internationalization/#supported-format-string-1) formats.
476
+ * [`number`](https://ej2.syncfusion.com/documentation/common/internationalization/#supported-format-string)
477
+ * and [`date`](https://ej2.syncfusion.com/documentation/common/internationalization/#supported-format-string-1) formats.
476
478
  *
477
479
  * @default null
478
480
  * @aspType string
@@ -524,7 +526,7 @@ export interface ColumnModel {
524
526
  commands?: CommandModel[];
525
527
  /**
526
528
  * Defines the column template that renders customized element in each cell of the column.
527
- * It accepts either [template string](../../../common/template-engine/) or HTML element ID.
529
+ * It accepts either [template string](https://ej2.syncfusion.com/documentation/common/template-engine/) or HTML element ID.
528
530
  *
529
531
  * @default null
530
532
  */
@@ -28,10 +28,12 @@ export interface EditSettingsModel {
28
28
 
29
29
  /**
30
30
  * Defines the mode to edit. The available editing modes are:
31
- * * Cell
32
- * * Row
33
- * * Dialog
34
- * * Batch
31
+ * ```props
32
+ * * Cell :- Defines the editing mode as Cell.
33
+ * * Row :- Defines the editing mode as Row.
34
+ * * Dialog :- Defines the editing mode as Dialog.
35
+ * * Batch :- Defines the editing mode as Batch.
36
+ * ```
35
37
  *
36
38
  * @default Cell
37
39
  * @isEnumeration true
@@ -40,11 +42,13 @@ export interface EditSettingsModel {
40
42
 
41
43
  /**
42
44
  * Defines the row position for new records. The available row positions are:
43
- * * Top
44
- * * Bottom
45
- * * Above
46
- * * Below
47
- * * Child
45
+ * ```props
46
+ * * Top :- Defines the row position as Top.
47
+ * * Bottom :- Defines the row position as Bottom.
48
+ * * Above :- Defines the row position as Above.
49
+ * * Below :- Defines the row position as Below.
50
+ * * Child :- Defines the row position as Child.
51
+ * ```
48
52
  * {% codeBlock src='treegrid/newRowPosition/index.md' %}{% endcodeBlock %}
49
53
  *
50
54
  * @default Top
@@ -25,10 +25,12 @@ export declare class EditSettings extends ChildProperty<EditSettings> {
25
25
  allowDeleting: boolean;
26
26
  /**
27
27
  * Defines the mode to edit. The available editing modes are:
28
- * * Cell
29
- * * Row
30
- * * Dialog
31
- * * Batch
28
+ * ```props
29
+ * * Cell :- Defines the editing mode as Cell.
30
+ * * Row :- Defines the editing mode as Row.
31
+ * * Dialog :- Defines the editing mode as Dialog.
32
+ * * Batch :- Defines the editing mode as Batch.
33
+ * ```
32
34
  *
33
35
  * @default Cell
34
36
  * @isEnumeration true
@@ -36,11 +38,13 @@ export declare class EditSettings extends ChildProperty<EditSettings> {
36
38
  mode: EditMode;
37
39
  /**
38
40
  * Defines the row position for new records. The available row positions are:
39
- * * Top
40
- * * Bottom
41
- * * Above
42
- * * Below
43
- * * Child
41
+ * ```props
42
+ * * Top :- Defines the row position as Top.
43
+ * * Bottom :- Defines the row position as Bottom.
44
+ * * Above :- Defines the row position as Above.
45
+ * * Below :- Defines the row position as Below.
46
+ * * Child :- Defines the row position as Child.
47
+ * ```
44
48
  * {% codeBlock src='treegrid/newRowPosition/index.md' %}{% endcodeBlock %}
45
49
  *
46
50
  * @default Top
@@ -161,9 +161,10 @@ export interface FilterSettingsModel {
161
161
 
162
162
  /**
163
163
  * Defines the filter bar modes. The available options are,
164
- * * `OnEnter`: Initiates filter operation after Enter key is pressed.
165
- * * `Immediate`: Initiates filter operation after a certain time interval. By default, time interval is 1500 ms.
166
- *
164
+ * ```props
165
+ * * OnEnter :- Initiates filter operation after Enter key is pressed.
166
+ * * Immediate :- Initiates filter operation after a certain time interval. By default, time interval is 1500 ms.
167
+ * ```
167
168
  * @default Syncfusion.EJ2.Grids.FilterBarMode.OnEnter
168
169
  * @isEnumeration true
169
170
  * @aspType Syncfusion.EJ2.Grids.FilterBarMode
@@ -204,14 +205,18 @@ export interface FilterSettingsModel {
204
205
  ignoreAccent?: boolean;
205
206
 
206
207
  /**
207
- * Defines the filter types. The available options are,
208
- * `Parent`: Shows the filtered record with parent record.
209
- * `Child`: Shows the filtered record with child record.
210
- * `Both` : shows the filtered record with both parent and child record.
211
- * `None` : Shows only filtered record.
208
+ * Defines the filter hierarchy modes. The available options are,
209
+ * ```props
210
+ * * Parent :- Shows the filtered record with parent record.
211
+ * * Child :- Shows the filtered record with child record.
212
+ * * Both :- Shows the filtered record with both parent and child record.
213
+ * * None :- Shows only the filtered record.
214
+ * ```
212
215
  * {% codeBlock src='treegrid/hierarchyMode/index.md' %}{% endcodeBlock %}
213
216
  *
214
217
  * @default Parent
218
+ * @isEnumeration true
219
+ * @aspType FilterHierarchyMode
215
220
  */
216
221
  hierarchyMode?: FilterHierarchyMode;
217
222
 
@@ -146,9 +146,10 @@ export declare class FilterSettings extends ChildProperty<FilterSettings> {
146
146
  type: FilterType;
147
147
  /**
148
148
  * Defines the filter bar modes. The available options are,
149
- * * `OnEnter`: Initiates filter operation after Enter key is pressed.
150
- * * `Immediate`: Initiates filter operation after a certain time interval. By default, time interval is 1500 ms.
151
- *
149
+ * ```props
150
+ * * OnEnter :- Initiates filter operation after Enter key is pressed.
151
+ * * Immediate :- Initiates filter operation after a certain time interval. By default, time interval is 1500 ms.
152
+ * ```
152
153
  * @default Syncfusion.EJ2.Grids.FilterBarMode.OnEnter
153
154
  * @isEnumeration true
154
155
  * @aspType Syncfusion.EJ2.Grids.FilterBarMode
@@ -184,14 +185,18 @@ export declare class FilterSettings extends ChildProperty<FilterSettings> {
184
185
  */
185
186
  ignoreAccent: boolean;
186
187
  /**
187
- * Defines the filter types. The available options are,
188
- * `Parent`: Shows the filtered record with parent record.
189
- * `Child`: Shows the filtered record with child record.
190
- * `Both` : shows the filtered record with both parent and child record.
191
- * `None` : Shows only filtered record.
188
+ * Defines the filter hierarchy modes. The available options are,
189
+ * ```props
190
+ * * Parent :- Shows the filtered record with parent record.
191
+ * * Child :- Shows the filtered record with child record.
192
+ * * Both :- Shows the filtered record with both parent and child record.
193
+ * * None :- Shows only the filtered record.
194
+ * ```
192
195
  * {% codeBlock src='treegrid/hierarchyMode/index.md' %}{% endcodeBlock %}
193
196
  *
194
197
  * @default Parent
198
+ * @isEnumeration true
199
+ * @aspType FilterHierarchyMode
195
200
  */
196
201
  hierarchyMode: FilterHierarchyMode;
197
202
  }
@@ -7,8 +7,10 @@ export interface LoadingIndicatorModel {
7
7
 
8
8
  /**
9
9
  * Defines the loading indicator. The available loading indicator are:
10
- * * Spinner
11
- * * Shimmer
10
+ * ```props
11
+ * * Spinner :- Defines Loading Indicator as Spinner.
12
+ * * Shimmer :- Defines Loading Indicator as Shimmer.
13
+ * ```
12
14
  *
13
15
  * @default Syncfusion.EJ2.Grids.IndicatorType.Spinner
14
16
  * @isEnumeration true
@@ -6,8 +6,10 @@ import { IndicatorType } from '@syncfusion/ej2-grids';
6
6
  export declare class LoadingIndicator extends ChildProperty<LoadingIndicator> {
7
7
  /**
8
8
  * Defines the loading indicator. The available loading indicator are:
9
- * * Spinner
10
- * * Shimmer
9
+ * ```props
10
+ * * Spinner :- Defines Loading Indicator as Spinner.
11
+ * * Shimmer :- Defines Loading Indicator as Shimmer.
12
+ * ```
11
13
  *
12
14
  * @default Syncfusion.EJ2.Grids.IndicatorType.Spinner
13
15
  * @isEnumeration true
@@ -50,7 +50,7 @@ export interface PageSettingsModel {
50
50
 
51
51
  /**
52
52
  * Defines the template which renders customized elements in pager of TreeGrid instead of default elements.
53
- * It accepts either [template string](../../../common/template-engine/) or HTML element ID.
53
+ * It accepts either [template string](https://ej2.syncfusion.com/documentation/common/template-engine/) or HTML element ID.
54
54
  *
55
55
  * @default null
56
56
  */
@@ -43,7 +43,7 @@ export declare class PageSettings extends ChildProperty<PageSettings> {
43
43
  pageSizes: boolean | (number | string)[];
44
44
  /**
45
45
  * Defines the template which renders customized elements in pager of TreeGrid instead of default elements.
46
- * It accepts either [template string](../../../common/template-engine/) or HTML element ID.
46
+ * It accepts either [template string](https://ej2.syncfusion.com/documentation/common/template-engine/) or HTML element ID.
47
47
  *
48
48
  * @default null
49
49
  */
@@ -60,11 +60,17 @@ export interface SearchSettingsModel {
60
60
  key?: string;
61
61
 
62
62
  /**
63
- * Defines the filter types. The available options are,
64
- * * `Parent`: Initiates filter operation after Enter key is pressed.
65
- * * `Child`: Initiates filter operation after a certain time interval. By default, time interval is 1500 ms.
63
+ * Defines the search hierarchy modes. The available options are,
64
+ * ```props
65
+ * * Parent :- Shows the searched record with parent record.
66
+ * * Child :- Shows the searched record with child record.
67
+ * * Both :- shows the searched record with both parent and child record.
68
+ * * None :- Shows only the searched record.
69
+ * ```
66
70
  *
67
71
  * @default Parent
72
+ * @isEnumeration true
73
+ * @aspType FilterHierarchyMode
68
74
  */
69
75
  hierarchyMode?: FilterHierarchyMode;
70
76
 
@@ -55,11 +55,17 @@ export declare class SearchSettings extends ChildProperty<SearchSettings> {
55
55
  */
56
56
  key: string;
57
57
  /**
58
- * Defines the filter types. The available options are,
59
- * * `Parent`: Initiates filter operation after Enter key is pressed.
60
- * * `Child`: Initiates filter operation after a certain time interval. By default, time interval is 1500 ms.
58
+ * Defines the search hierarchy modes. The available options are,
59
+ * ```props
60
+ * * Parent :- Shows the searched record with parent record.
61
+ * * Child :- Shows the searched record with child record.
62
+ * * Both :- shows the searched record with both parent and child record.
63
+ * * None :- Shows only the searched record.
64
+ * ```
61
65
  *
62
66
  * @default Parent
67
+ * @isEnumeration true
68
+ * @aspType FilterHierarchyMode
63
69
  */
64
70
  hierarchyMode: FilterHierarchyMode;
65
71
  }
@@ -7,6 +7,11 @@ export interface SelectionSettingsModel {
7
7
 
8
8
  /**
9
9
  * TreeGrid supports row, cell, and both (row and cell) selection mode.
10
+ * ```props
11
+ * * Row :- Selects the entire row.
12
+ * * Cell :- Selects the cell alone.
13
+ * * Both :- Selects the entire row and its cell.
14
+ * ```
10
15
  *
11
16
  * @default Syncfusion.EJ2.Grids.SelectionMode.Row
12
17
  * @isEnumeration true
@@ -17,9 +22,10 @@ export interface SelectionSettingsModel {
17
22
  /**
18
23
  * The cell selection modes are flow and box. It requires the selection
19
24
  * [`mode`](#mode) to be either cell or both.
20
- * * `Flow`: Selects the range of cells between start index and end index that also includes the other cells of the selected rows.
21
- * * `Box`: Selects the range of cells within the start and end column indexes that includes in between cells of rows within the range.
22
- *
25
+ * ```props
26
+ * * Flow :- Selects the range of cells between start index and end index that also includes the other cells of the selected rows.
27
+ * * Box :- Selects the range of cells within the start and end column indexes that includes in between cells of rows within the range.
28
+ * ```
23
29
  * @default Syncfusion.EJ2.Grids.CellSelectionMode.Flow
24
30
  * @isEnumeration true
25
31
  * @aspType Syncfusion.EJ2.Grids.CellSelectionMode
@@ -28,9 +34,10 @@ export interface SelectionSettingsModel {
28
34
 
29
35
  /**
30
36
  * Defines options for selection type. They are
31
- * * `Single`: Allows selection of only a row or a cell.
32
- * * `Multiple`: Allows selection of multiple rows or cells.
33
- *
37
+ * ```props
38
+ * * Single :- Allows selection of only a row or a cell.
39
+ * * Multiple :- Allows selection of multiple rows or cells.
40
+ * ```
34
41
  * @default Syncfusion.EJ2.Grids.SelectionType.Single
35
42
  * @isEnumeration true
36
43
  * @aspType Syncfusion.EJ2.Grids.SelectionType
@@ -47,8 +54,10 @@ export interface SelectionSettingsModel {
47
54
 
48
55
  /**
49
56
  * Defines options for checkbox selection Mode. They are
50
- * * `Default`: This is the default value of the checkboxMode. In this mode, user can select multiple rows by clicking rows one by one.
51
- * * `ResetOnRowClick`: In ResetOnRowClick mode, on clicking a row it will reset previously selected row and also multiple
57
+ * ```props
58
+ * * Default :- This is the default value of the checkboxMode. In this mode, user can select multiple rows by clicking rows one by one.
59
+ * * ResetOnRowClick :- In ResetOnRowClick mode, on clicking a row it will reset previously selected row and also multiple.
60
+ * ```
52
61
  * rows can be selected by using CTRL or SHIFT key.
53
62
  *
54
63
  * @default Syncfusion.EJ2.Grids.CheckboxSelectionType.Default
@@ -6,6 +6,11 @@ import { SelectionMode, CellSelectionMode, SelectionType, CheckboxSelectionType
6
6
  export declare class SelectionSettings extends ChildProperty<SelectionSettings> {
7
7
  /**
8
8
  * TreeGrid supports row, cell, and both (row and cell) selection mode.
9
+ * ```props
10
+ * * Row :- Selects the entire row.
11
+ * * Cell :- Selects the cell alone.
12
+ * * Both :- Selects the entire row and its cell.
13
+ * ```
9
14
  *
10
15
  * @default Syncfusion.EJ2.Grids.SelectionMode.Row
11
16
  * @isEnumeration true
@@ -15,9 +20,10 @@ export declare class SelectionSettings extends ChildProperty<SelectionSettings>
15
20
  /**
16
21
  * The cell selection modes are flow and box. It requires the selection
17
22
  * [`mode`](#mode) to be either cell or both.
18
- * * `Flow`: Selects the range of cells between start index and end index that also includes the other cells of the selected rows.
19
- * * `Box`: Selects the range of cells within the start and end column indexes that includes in between cells of rows within the range.
20
- *
23
+ * ```props
24
+ * * Flow :- Selects the range of cells between start index and end index that also includes the other cells of the selected rows.
25
+ * * Box :- Selects the range of cells within the start and end column indexes that includes in between cells of rows within the range.
26
+ * ```
21
27
  * @default Syncfusion.EJ2.Grids.CellSelectionMode.Flow
22
28
  * @isEnumeration true
23
29
  * @aspType Syncfusion.EJ2.Grids.CellSelectionMode
@@ -25,9 +31,10 @@ export declare class SelectionSettings extends ChildProperty<SelectionSettings>
25
31
  cellSelectionMode: CellSelectionMode;
26
32
  /**
27
33
  * Defines options for selection type. They are
28
- * * `Single`: Allows selection of only a row or a cell.
29
- * * `Multiple`: Allows selection of multiple rows or cells.
30
- *
34
+ * ```props
35
+ * * Single :- Allows selection of only a row or a cell.
36
+ * * Multiple :- Allows selection of multiple rows or cells.
37
+ * ```
31
38
  * @default Syncfusion.EJ2.Grids.SelectionType.Single
32
39
  * @isEnumeration true
33
40
  * @aspType Syncfusion.EJ2.Grids.SelectionType
@@ -42,8 +49,10 @@ export declare class SelectionSettings extends ChildProperty<SelectionSettings>
42
49
  persistSelection: boolean;
43
50
  /**
44
51
  * Defines options for checkbox selection Mode. They are
45
- * * `Default`: This is the default value of the checkboxMode. In this mode, user can select multiple rows by clicking rows one by one.
46
- * * `ResetOnRowClick`: In ResetOnRowClick mode, on clicking a row it will reset previously selected row and also multiple
52
+ * ```props
53
+ * * Default :- This is the default value of the checkboxMode. In this mode, user can select multiple rows by clicking rows one by one.
54
+ * * ResetOnRowClick :- In ResetOnRowClick mode, on clicking a row it will reset previously selected row and also multiple.
55
+ * ```
47
56
  * rows can be selected by using CTRL or SHIFT key.
48
57
  *
49
58
  * @default Syncfusion.EJ2.Grids.CheckboxSelectionType.Default