@syncfusion/ej2-treegrid 28.2.4 → 29.1.33
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.
- package/README.md +2 -2
- package/dist/ej2-treegrid.min.js +2 -2
- package/dist/ej2-treegrid.umd.min.js +2 -2
- package/dist/ej2-treegrid.umd.min.js.map +1 -1
- package/dist/es6/ej2-treegrid.es2015.js +1275 -519
- package/dist/es6/ej2-treegrid.es2015.js.map +1 -1
- package/dist/es6/ej2-treegrid.es5.js +1277 -519
- package/dist/es6/ej2-treegrid.es5.js.map +1 -1
- package/dist/global/ej2-treegrid.min.js +2 -2
- package/dist/global/ej2-treegrid.min.js.map +1 -1
- package/dist/global/index.d.ts +1 -1
- package/package.json +10 -10
- package/src/treegrid/actions/batch-edit.js +12 -5
- package/src/treegrid/actions/edit.js +12 -12
- package/src/treegrid/actions/page.js +1 -1
- package/src/treegrid/actions/rowdragdrop.d.ts +21 -1
- package/src/treegrid/actions/rowdragdrop.js +248 -48
- package/src/treegrid/actions/summary.js +1 -1
- package/src/treegrid/actions/virtual-scroll.d.ts +34 -1
- package/src/treegrid/actions/virtual-scroll.js +58 -11
- package/src/treegrid/base/constant.d.ts +0 -4
- package/src/treegrid/base/constant.js +0 -4
- package/src/treegrid/base/data.js +48 -47
- package/src/treegrid/base/treegrid-model.d.ts +195 -208
- package/src/treegrid/base/treegrid.d.ts +598 -411
- package/src/treegrid/base/treegrid.js +523 -306
- package/src/treegrid/enum.d.ts +77 -80
- package/src/treegrid/enum.js +2 -2
- package/src/treegrid/models/column.d.ts +122 -177
- package/src/treegrid/models/column.js +14 -26
- package/src/treegrid/models/edit-settings-model.d.ts +24 -25
- package/src/treegrid/models/edit-settings.d.ts +25 -26
- package/src/treegrid/models/edit-settings.js +1 -1
- package/src/treegrid/models/filter-settings-model.d.ts +41 -49
- package/src/treegrid/models/filter-settings.d.ts +43 -51
- package/src/treegrid/models/filter-settings.js +2 -2
- package/src/treegrid/models/infinite-scroll-settings-model.d.ts +4 -4
- package/src/treegrid/models/infinite-scroll-settings.d.ts +4 -4
- package/src/treegrid/models/infinite-scroll-settings.js +1 -1
- package/src/treegrid/models/loading-indicator-model.d.ts +3 -4
- package/src/treegrid/models/loading-indicator.d.ts +4 -4
- package/src/treegrid/models/loading-indicator.js +1 -1
- package/src/treegrid/models/page-settings-model.d.ts +10 -13
- package/src/treegrid/models/page-settings.d.ts +11 -14
- package/src/treegrid/models/page-settings.js +1 -1
- package/src/treegrid/models/rowdrop-settings-model.d.ts +1 -1
- package/src/treegrid/models/rowdrop-settings.d.ts +13 -6
- package/src/treegrid/models/rowdrop-settings.js +1 -1
- package/src/treegrid/models/search-settings-model.d.ts +13 -11
- package/src/treegrid/models/search-settings.d.ts +14 -12
- package/src/treegrid/models/search-settings.js +1 -1
- package/src/treegrid/models/selection-settings-model.d.ts +18 -29
- package/src/treegrid/models/selection-settings.d.ts +18 -29
- package/src/treegrid/models/sort-settings-model.d.ts +8 -5
- package/src/treegrid/models/sort-settings.d.ts +10 -7
- package/src/treegrid/models/sort-settings.js +2 -2
- package/src/treegrid/models/summary-model.d.ts +28 -29
- package/src/treegrid/models/summary.d.ts +32 -30
- package/src/treegrid/models/summary.js +4 -1
- package/src/treegrid/models/textwrap-settings-model.d.ts +7 -4
- package/src/treegrid/models/textwrap-settings.d.ts +8 -5
- package/src/treegrid/models/textwrap-settings.js +1 -1
- package/src/treegrid/renderer/render.js +11 -5
- package/src/treegrid/renderer/virtual-row-model-generator.js +5 -4
- package/src/treegrid/renderer/virtual-tree-content-render.d.ts +277 -0
- package/src/treegrid/renderer/virtual-tree-content-render.js +328 -35
- package/src/treegrid/utils.d.ts +1 -1
- package/styles/bootstrap-lite.css +0 -12
- package/styles/bootstrap.css +0 -12
- package/styles/bootstrap5-dark-lite.css +1 -1
- package/styles/bootstrap5-dark.css +1 -1
- package/styles/treegrid/_layout.scss +0 -1
- package/styles/treegrid/_material-dark-definition.scss +2 -2
- package/styles/treegrid/_material-definition.scss +2 -2
- package/styles/treegrid/bootstrap.css +0 -12
- package/styles/treegrid/bootstrap5-dark.css +1 -1
- package/styles/treegrid/icons/_bootstrap.scss +0 -17
- package/styles/treegrid/icons/_bootstrap5.scss +1 -1
- package/styles/treegrid/icons/_fabric-dark.scss +1 -1
- package/styles/treegrid/icons/_fabric.scss +1 -1
- package/styles/treegrid/icons/_fluent2.scss +1 -1
- package/styles/treegrid/icons/_fusionnew.scss +1 -0
- package/styles/treegrid/icons/_highcontrast-light.scss +1 -1
- package/styles/treegrid/icons/_tailwind-dark.scss +2 -2
|
@@ -3,67 +3,68 @@ import { ICustomOptr, FilterBarMode, FilterType } from '@syncfusion/ej2-grids';
|
|
|
3
3
|
import { FilterHierarchyMode } from '../enum';
|
|
4
4
|
import { PredicateModel } from './filter-settings-model';
|
|
5
5
|
/**
|
|
6
|
-
* Represents the
|
|
6
|
+
* Represents the filter configuration for a column in the TreeGrid.
|
|
7
7
|
*/
|
|
8
8
|
export declare class Predicate extends ChildProperty<Predicate> {
|
|
9
9
|
/**
|
|
10
|
-
*
|
|
10
|
+
* Specifies the field name of the column to apply the filter on.
|
|
11
11
|
*
|
|
12
12
|
* @default ''
|
|
13
13
|
*/
|
|
14
14
|
field: string;
|
|
15
15
|
/**
|
|
16
|
-
*
|
|
16
|
+
* Specifies the operator used for filtering TreeGrid records. The available operators support a variety of data types
|
|
17
|
+
* and offer different filtering mechanisms. Details for each operator are provided below:
|
|
17
18
|
* <table>
|
|
18
19
|
* <tr>
|
|
19
20
|
* <td colspan=1 rowspan=1>
|
|
20
21
|
* Operator<br/></td><td colspan=1 rowspan=1>
|
|
21
22
|
* Description<br/></td><td colspan=1 rowspan=1>
|
|
22
|
-
* Supported Types<br/></td></tr>
|
|
23
|
+
* Supported Data Types<br/></td></tr>
|
|
23
24
|
* <tr>
|
|
24
25
|
* <td colspan=1 rowspan=1>
|
|
25
26
|
* startswith<br/></td><td colspan=1 rowspan=1>
|
|
26
|
-
* Checks
|
|
27
|
+
* Checks if the value starts with the specified input.<br/></td><td colspan=1 rowspan=1>
|
|
27
28
|
* String<br/></td></tr>
|
|
28
29
|
* <tr>
|
|
29
30
|
* <td colspan=1 rowspan=1>
|
|
30
31
|
* endswith<br/></td><td colspan=1 rowspan=1>
|
|
31
|
-
* Checks
|
|
32
|
+
* Checks if the value ends with the specified input.<br/><br/></td><td colspan=1 rowspan=1>
|
|
32
33
|
* <br/>String<br/></td></tr>
|
|
33
34
|
* <tr>
|
|
34
35
|
* <td colspan=1 rowspan=1>
|
|
35
36
|
* contains<br/></td><td colspan=1 rowspan=1>
|
|
36
|
-
* Checks
|
|
37
|
+
* Checks if the value contains the specified input anywhere within it.<br/><br/></td><td colspan=1 rowspan=1>
|
|
37
38
|
* <br/>String<br/></td></tr>
|
|
38
39
|
* <tr>
|
|
39
40
|
* <td colspan=1 rowspan=1>
|
|
40
41
|
* equal<br/></td><td colspan=1 rowspan=1>
|
|
41
|
-
* Checks
|
|
42
|
+
* Checks if the value is exactly equal to the specified input.<br/><br/></td><td colspan=1 rowspan=1>
|
|
42
43
|
* <br/>String | Number | Boolean | Date<br/></td></tr>
|
|
43
44
|
* <tr>
|
|
44
45
|
* <td colspan=1 rowspan=1>
|
|
45
46
|
* notequal<br/></td><td colspan=1 rowspan=1>
|
|
46
|
-
*
|
|
47
|
+
* Identifies values that are not equal to the specified input.<br/><br/></td><td colspan=1 rowspan=1>
|
|
47
48
|
* <br/>String | Number | Boolean | Date<br/></td></tr>
|
|
48
49
|
* <tr>
|
|
49
50
|
* <td colspan=1 rowspan=1>
|
|
50
51
|
* greaterthan<br/></td><td colspan=1 rowspan=1>
|
|
51
|
-
*
|
|
52
|
+
* Verifies if the value is greater than the specified input.<br/><br/></td><td colspan=1 rowspan=1>
|
|
52
53
|
* Number | Date<br/></td></tr>
|
|
53
54
|
* <tr>
|
|
54
55
|
* <td colspan=1 rowspan=1>
|
|
55
56
|
* greaterthanorequal<br/></td><td colspan=1 rowspan=1>
|
|
56
|
-
*
|
|
57
|
+
* Verifies if the value is greater than or equal to the specified input.<br/><br/></td><td colspan=1 rowspan=1>
|
|
57
58
|
* <br/>Number | Date<br/></td></tr>
|
|
58
59
|
* <tr>
|
|
59
60
|
* <td colspan=1 rowspan=1>
|
|
60
61
|
* lessthan<br/></td><td colspan=1 rowspan=1>
|
|
61
|
-
* Checks
|
|
62
|
+
* Checks if the value is less than the specified input.<br/><br/></td><td colspan=1 rowspan=1>
|
|
62
63
|
* <br/>Number | Date<br/></td></tr>
|
|
63
64
|
* <tr>
|
|
64
65
|
* <td colspan=1 rowspan=1>
|
|
65
66
|
* lessthanorequal<br/></td><td colspan=1 rowspan=1>
|
|
66
|
-
* Checks
|
|
67
|
+
* Checks if the value is less than or equal to the specified input.<br/><br/></td><td colspan=1 rowspan=1>
|
|
67
68
|
* <br/>Number | Date<br/></td></tr>
|
|
68
69
|
* </table>
|
|
69
70
|
*
|
|
@@ -71,85 +72,84 @@ export declare class Predicate extends ChildProperty<Predicate> {
|
|
|
71
72
|
*/
|
|
72
73
|
operator: string;
|
|
73
74
|
/**
|
|
74
|
-
*
|
|
75
|
+
* Specifies the value to filter the column's data by.
|
|
75
76
|
*
|
|
76
77
|
* @default ''
|
|
77
78
|
*/
|
|
78
79
|
value: string | number | Date | boolean;
|
|
79
80
|
/**
|
|
80
|
-
*
|
|
81
|
-
* filter records with case insensitive(uppercase and lowercase letters treated as same) in Tree Grid.
|
|
81
|
+
* Applies case-sensitive filtering if set to `true`. When false, filtering is case-insensitive.
|
|
82
82
|
*
|
|
83
83
|
* @default null
|
|
84
84
|
*/
|
|
85
85
|
matchCase: boolean;
|
|
86
86
|
/**
|
|
87
|
-
*
|
|
87
|
+
* Ignores diacritic characters during filtering if set to `true`.
|
|
88
88
|
*
|
|
89
89
|
* @default false
|
|
90
90
|
*/
|
|
91
91
|
ignoreAccent: boolean;
|
|
92
92
|
/**
|
|
93
|
-
* Defines relationship between
|
|
93
|
+
* Defines the logical relationship between multiple filter conditions ('AND' / 'OR').
|
|
94
94
|
*
|
|
95
95
|
* @default null
|
|
96
96
|
*/
|
|
97
97
|
predicate: string;
|
|
98
98
|
/**
|
|
99
99
|
* @hidden
|
|
100
|
-
*
|
|
100
|
+
* Holds the actual value used for filtering the column.
|
|
101
101
|
*/
|
|
102
102
|
actualFilterValue: Object;
|
|
103
103
|
/**
|
|
104
104
|
* @hidden
|
|
105
|
-
*
|
|
105
|
+
* Represents the actual filter operator applied to the column.
|
|
106
106
|
*/
|
|
107
107
|
actualOperator: Object;
|
|
108
108
|
/**
|
|
109
109
|
* @hidden
|
|
110
|
-
* Defines the type of the filter column
|
|
110
|
+
* Defines the data type of the filter column.
|
|
111
111
|
*/
|
|
112
112
|
type: string;
|
|
113
113
|
/**
|
|
114
114
|
* @hidden
|
|
115
|
-
*
|
|
115
|
+
* Represents the internal predicate condition for the filter column.
|
|
116
116
|
*/
|
|
117
117
|
ejpredicate: Object;
|
|
118
118
|
/**
|
|
119
119
|
* @hidden
|
|
120
|
-
*
|
|
120
|
+
* Unique identifier for the filter column.
|
|
121
121
|
*/
|
|
122
122
|
uid: string;
|
|
123
123
|
/**
|
|
124
124
|
* @hidden
|
|
125
|
-
*
|
|
125
|
+
* Indicates whether the column is a foreign key in the filter set.
|
|
126
126
|
*/
|
|
127
127
|
isForeignKey: boolean;
|
|
128
128
|
}
|
|
129
129
|
/**
|
|
130
|
-
* Configures the filtering behavior of the TreeGrid.
|
|
130
|
+
* Configures the filtering behavior of the TreeGrid, enabling complex data filtering capabilities.
|
|
131
131
|
*/
|
|
132
132
|
export declare class FilterSettings extends ChildProperty<FilterSettings> {
|
|
133
133
|
/**
|
|
134
|
-
* Specifies the
|
|
134
|
+
* Specifies the initial filter configuration for TreeGrid columns or retrieves the current filter state.
|
|
135
135
|
*
|
|
136
136
|
* @default []
|
|
137
137
|
*/
|
|
138
138
|
columns: PredicateModel[];
|
|
139
139
|
/**
|
|
140
|
-
*
|
|
141
|
-
* * `Menu
|
|
142
|
-
* * `FilterBar
|
|
140
|
+
* Sets the filtering interface type. Options include:
|
|
141
|
+
* * `Menu`: Provides a menu for filtering options.
|
|
142
|
+
* * `FilterBar`: Allows direct input filtering in a bar at the top of each column.
|
|
143
|
+
* * `Excel` : Specifies the filter type as excel.
|
|
144
|
+
* * `CheckBox` : Specifies the filter type as check box.
|
|
143
145
|
*
|
|
144
146
|
* @default FilterBar
|
|
145
147
|
*/
|
|
146
148
|
type: FilterType;
|
|
147
149
|
/**
|
|
148
|
-
*
|
|
149
|
-
*
|
|
150
|
-
* *
|
|
151
|
-
* * Immediate :- Initiates filter operation after a certain time interval. By default, time interval is 1500 ms.
|
|
152
|
-
* ```
|
|
150
|
+
* Determines the mode of the filter bar operation. Options include:
|
|
151
|
+
* * `OnEnter`: Filtering is triggered upon pressing the Enter key.
|
|
152
|
+
* * `Immediate`: Filtering occurs after a short delay automatically.
|
|
153
153
|
*
|
|
154
154
|
* @default Syncfusion.EJ2.Grids.FilterBarMode.OnEnter
|
|
155
155
|
* @isEnumeration true
|
|
@@ -157,43 +157,35 @@ export declare class FilterSettings extends ChildProperty<FilterSettings> {
|
|
|
157
157
|
*/
|
|
158
158
|
mode: FilterBarMode;
|
|
159
159
|
/**
|
|
160
|
-
* Shows or hides the
|
|
160
|
+
* Shows or hides the status message related to filtering actions on the pager.
|
|
161
161
|
*
|
|
162
162
|
* @default true
|
|
163
163
|
*/
|
|
164
164
|
showFilterBarStatus: boolean;
|
|
165
165
|
/**
|
|
166
|
-
*
|
|
166
|
+
* Determines the delay in milliseconds before filtering is triggered in `Immediate` mode.
|
|
167
167
|
*
|
|
168
168
|
* @default 1500
|
|
169
169
|
*/
|
|
170
170
|
immediateModeDelay: number;
|
|
171
171
|
/**
|
|
172
|
-
*
|
|
173
|
-
* (string, number, date and boolean). Based on the column type, this customize operator list will render in filter menu.
|
|
174
|
-
*
|
|
175
|
-
* > Check the `Filter Menu Operator` customization.
|
|
172
|
+
* Allows customization of the default operators offered in the filter menu by defining custom operators for string, number, date, and boolean types.
|
|
176
173
|
*
|
|
177
174
|
* @default null
|
|
178
175
|
*/
|
|
179
176
|
operators: ICustomOptr;
|
|
180
177
|
/**
|
|
181
|
-
* If
|
|
182
|
-
*
|
|
183
|
-
* > Check the [`Diacritics`](../../treegrid/filtering/#diacritics/) filtering.
|
|
178
|
+
* If set to `true`, filtering ignores accent characters, making diacritic characters identical to their unaccented versions.
|
|
184
179
|
*
|
|
185
180
|
* @default false
|
|
186
181
|
*/
|
|
187
182
|
ignoreAccent: boolean;
|
|
188
183
|
/**
|
|
189
|
-
*
|
|
190
|
-
*
|
|
191
|
-
* *
|
|
192
|
-
* *
|
|
193
|
-
* *
|
|
194
|
-
* * None :- Shows only the filtered record.
|
|
195
|
-
* ```
|
|
196
|
-
* {% codeBlock src='treegrid/hierarchyMode/index.md' %}{% endcodeBlock %}
|
|
184
|
+
* Specifies how the hierarchy should be maintained during filtering:
|
|
185
|
+
* * `Parent`: Displays the filtered records along with their parent records.
|
|
186
|
+
* * `Child`: Displays the filtered records along with their child records.
|
|
187
|
+
* * `Both`: Displays the filtered records with both parent and child records.
|
|
188
|
+
* * `None`: Only displays the filtered records.
|
|
197
189
|
*
|
|
198
190
|
* @default Parent
|
|
199
191
|
* @isEnumeration true
|
|
@@ -19,7 +19,7 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
|
|
|
19
19
|
};
|
|
20
20
|
import { Collection, Property, ChildProperty } from '@syncfusion/ej2-base';
|
|
21
21
|
/**
|
|
22
|
-
* Represents the
|
|
22
|
+
* Represents the filter configuration for a column in the TreeGrid.
|
|
23
23
|
*/
|
|
24
24
|
var Predicate = /** @class */ (function (_super) {
|
|
25
25
|
__extends(Predicate, _super);
|
|
@@ -66,7 +66,7 @@ var Predicate = /** @class */ (function (_super) {
|
|
|
66
66
|
}(ChildProperty));
|
|
67
67
|
export { Predicate };
|
|
68
68
|
/**
|
|
69
|
-
* Configures the filtering behavior of the TreeGrid.
|
|
69
|
+
* Configures the filtering behavior of the TreeGrid, enabling complex data filtering capabilities.
|
|
70
70
|
*/
|
|
71
71
|
var FilterSettings = /** @class */ (function (_super) {
|
|
72
72
|
__extends(FilterSettings, _super);
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { Property, ChildProperty } from '@syncfusion/ej2-base';import { InfiniteScrollSettings as GridInfiniteScrollSettings} from '@syncfusion/ej2-grids';
|
|
1
|
+
import { Property, ChildProperty } from '@syncfusion/ej2-base';import { InfiniteScrollSettings as GridInfiniteScrollSettings } from '@syncfusion/ej2-grids';
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
4
|
* Interface for a class InfiniteScrollSettings
|
|
@@ -6,21 +6,21 @@ import { Property, ChildProperty } from '@syncfusion/ej2-base';import { Infinite
|
|
|
6
6
|
export interface InfiniteScrollSettingsModel {
|
|
7
7
|
|
|
8
8
|
/**
|
|
9
|
-
* If `enableCache` is set to true, the Tree Grid will cache the loaded data
|
|
9
|
+
* If `enableCache` is set to true, the Tree Grid will cache the loaded data for reuse in future requests, improving performance.
|
|
10
10
|
*
|
|
11
11
|
* @default false
|
|
12
12
|
*/
|
|
13
13
|
enableCache?: boolean;
|
|
14
14
|
|
|
15
15
|
/**
|
|
16
|
-
*
|
|
16
|
+
* Specifies the number of data blocks to maintain in the Tree Grid's cache when `enableCache` is true.
|
|
17
17
|
*
|
|
18
18
|
* @default 3
|
|
19
19
|
*/
|
|
20
20
|
maxBlocks?: number;
|
|
21
21
|
|
|
22
22
|
/**
|
|
23
|
-
*
|
|
23
|
+
* Specifies the number of data blocks to render initially when the Tree Grid loads, if caching is enabled.
|
|
24
24
|
*
|
|
25
25
|
* @default 3
|
|
26
26
|
*/
|
|
@@ -1,23 +1,23 @@
|
|
|
1
1
|
import { ChildProperty } from '@syncfusion/ej2-base';
|
|
2
2
|
import { InfiniteScrollSettings as GridInfiniteScrollSettings } from '@syncfusion/ej2-grids';
|
|
3
3
|
/**
|
|
4
|
-
* Configures the infinite scroll behavior of Tree Grid.
|
|
4
|
+
* Configures the infinite scroll behavior of the Tree Grid.
|
|
5
5
|
*/
|
|
6
6
|
export declare class InfiniteScrollSettings extends ChildProperty<GridInfiniteScrollSettings> {
|
|
7
7
|
/**
|
|
8
|
-
* If `enableCache` is set to true, the Tree Grid will cache the loaded data
|
|
8
|
+
* If `enableCache` is set to true, the Tree Grid will cache the loaded data for reuse in future requests, improving performance.
|
|
9
9
|
*
|
|
10
10
|
* @default false
|
|
11
11
|
*/
|
|
12
12
|
enableCache: boolean;
|
|
13
13
|
/**
|
|
14
|
-
*
|
|
14
|
+
* Specifies the number of data blocks to maintain in the Tree Grid's cache when `enableCache` is true.
|
|
15
15
|
*
|
|
16
16
|
* @default 3
|
|
17
17
|
*/
|
|
18
18
|
maxBlocks: number;
|
|
19
19
|
/**
|
|
20
|
-
*
|
|
20
|
+
* Specifies the number of data blocks to render initially when the Tree Grid loads, if caching is enabled.
|
|
21
21
|
*
|
|
22
22
|
* @default 3
|
|
23
23
|
*/
|
|
@@ -19,7 +19,7 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
|
|
|
19
19
|
};
|
|
20
20
|
import { Property, ChildProperty } from '@syncfusion/ej2-base';
|
|
21
21
|
/**
|
|
22
|
-
* Configures the infinite scroll behavior of Tree Grid.
|
|
22
|
+
* Configures the infinite scroll behavior of the Tree Grid.
|
|
23
23
|
*/
|
|
24
24
|
var InfiniteScrollSettings = /** @class */ (function (_super) {
|
|
25
25
|
__extends(InfiniteScrollSettings, _super);
|
|
@@ -6,17 +6,16 @@ import { Property, ChildProperty } from '@syncfusion/ej2-base';
|
|
|
6
6
|
export interface LoadingIndicatorModel {
|
|
7
7
|
|
|
8
8
|
/**
|
|
9
|
-
*
|
|
9
|
+
* Specifies the type of loading indicator to be displayed. You can choose between:
|
|
10
10
|
* ```props
|
|
11
|
-
* * Spinner
|
|
12
|
-
* * Shimmer
|
|
11
|
+
* * `Spinner`: Displays a spinning loader to indicate ongoing loading.
|
|
12
|
+
* * `Shimmer`: Displays a shimmer effect that suggests content is loading.
|
|
13
13
|
* ```
|
|
14
14
|
*
|
|
15
15
|
* @default Syncfusion.EJ2.Grids.IndicatorType.Spinner
|
|
16
16
|
* @isEnumeration true
|
|
17
17
|
* @aspType Syncfusion.EJ2.Grids.IndicatorType
|
|
18
18
|
*/
|
|
19
|
-
|
|
20
19
|
indicatorType?: IndicatorType;
|
|
21
20
|
|
|
22
21
|
}
|
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
import { ChildProperty } from '@syncfusion/ej2-base';
|
|
2
2
|
import { IndicatorType } from '@syncfusion/ej2-grids';
|
|
3
3
|
/**
|
|
4
|
-
* Configures the
|
|
4
|
+
* Configures the loading indicator for the Tree Grid, allowing you to display a visual indicator during data loading operations to enhance user experience.
|
|
5
5
|
*/
|
|
6
6
|
export declare class LoadingIndicator extends ChildProperty<LoadingIndicator> {
|
|
7
7
|
/**
|
|
8
|
-
*
|
|
8
|
+
* Specifies the type of loading indicator to be displayed. You can choose between:
|
|
9
9
|
* ```props
|
|
10
|
-
* * Spinner
|
|
11
|
-
* * Shimmer
|
|
10
|
+
* * `Spinner`: Displays a spinning loader to indicate ongoing loading.
|
|
11
|
+
* * `Shimmer`: Displays a shimmer effect that suggests content is loading.
|
|
12
12
|
* ```
|
|
13
13
|
*
|
|
14
14
|
* @default Syncfusion.EJ2.Grids.IndicatorType.Spinner
|
|
@@ -19,7 +19,7 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
|
|
|
19
19
|
};
|
|
20
20
|
import { Property, ChildProperty } from '@syncfusion/ej2-base';
|
|
21
21
|
/**
|
|
22
|
-
* Configures the
|
|
22
|
+
* Configures the loading indicator for the Tree Grid, allowing you to display a visual indicator during data loading operations to enhance user experience.
|
|
23
23
|
*/
|
|
24
24
|
var LoadingIndicator = /** @class */ (function (_super) {
|
|
25
25
|
__extends(LoadingIndicator, _super);
|
|
@@ -6,21 +6,21 @@ import { Property, ChildProperty } from '@syncfusion/ej2-base';import { PageSize
|
|
|
6
6
|
export interface PageSettingsModel {
|
|
7
7
|
|
|
8
8
|
/**
|
|
9
|
-
*
|
|
9
|
+
* Specifies the number of records to display per page in the TreeGrid. Adjust this setting to control the volume of data presented on each page.
|
|
10
10
|
*
|
|
11
11
|
* @default 12
|
|
12
12
|
*/
|
|
13
13
|
pageSize?: number;
|
|
14
14
|
|
|
15
15
|
/**
|
|
16
|
-
*
|
|
16
|
+
* Determines the number of page numbers displayed in the TreeGrid pager container. This setting helps users navigate between different parts of the dataset.
|
|
17
17
|
*
|
|
18
18
|
* @default 8
|
|
19
19
|
*/
|
|
20
20
|
pageCount?: number;
|
|
21
21
|
|
|
22
22
|
/**
|
|
23
|
-
*
|
|
23
|
+
* Sets the current page number in the TreeGrid, defining which page of data is initially displayed to users.
|
|
24
24
|
*
|
|
25
25
|
* @default 1
|
|
26
26
|
*/
|
|
@@ -28,29 +28,26 @@ export interface PageSettingsModel {
|
|
|
28
28
|
|
|
29
29
|
/**
|
|
30
30
|
* @hidden
|
|
31
|
-
*
|
|
31
|
+
* Retrieves the total number of records in the TreeGrid. This property is primarily used internally by the TreeGrid component.
|
|
32
32
|
*/
|
|
33
33
|
totalRecordsCount?: number;
|
|
34
34
|
|
|
35
35
|
/**
|
|
36
|
-
*
|
|
37
|
-
* then it pass current page information as a query string along with the URL while navigating to other page in TreeGrid.
|
|
36
|
+
* When set to true, appends the current page information as a query string to the remote service URL during page navigation within the TreeGrid.
|
|
38
37
|
*
|
|
39
38
|
* @default false
|
|
40
39
|
*/
|
|
41
40
|
enableQueryString?: boolean;
|
|
42
41
|
|
|
43
42
|
/**
|
|
44
|
-
*
|
|
45
|
-
* It renders DropDownList in the pager of TreeGrid which allow us to select pageSize from DropDownList.
|
|
43
|
+
* Enables a DropDownList in the TreeGrid pager, allowing users to select the page size. Accepts either a boolean to toggle this feature or an array of page size options.
|
|
46
44
|
*
|
|
47
45
|
* @default false
|
|
48
46
|
*/
|
|
49
47
|
pageSizes?: boolean | (number | string)[];
|
|
50
48
|
|
|
51
49
|
/**
|
|
52
|
-
*
|
|
53
|
-
* It accepts either [template string](https://ej2.syncfusion.com/documentation/common/template-engine/) or HTML element ID.
|
|
50
|
+
* Provides a custom template for rendering pager elements in the TreeGrid, offering enhanced flexibility and control over the pager's appearance and functionality. Accepts a template string or the ID of an HTML element.
|
|
54
51
|
*
|
|
55
52
|
* @default null
|
|
56
53
|
* @aspType string
|
|
@@ -58,9 +55,9 @@ export interface PageSettingsModel {
|
|
|
58
55
|
template?: string | Function;
|
|
59
56
|
|
|
60
57
|
/**
|
|
61
|
-
* Specifies the mode
|
|
62
|
-
* * `All`:
|
|
63
|
-
* * `Root`:
|
|
58
|
+
* Specifies the mode for counting records on a page, determining whether all records are counted or only zeroth level parent records. The available options are:
|
|
59
|
+
* * `All`: Includes all records in the count.
|
|
60
|
+
* * `Root`: Includes only zeroth level parent records.
|
|
64
61
|
*
|
|
65
62
|
* @default All
|
|
66
63
|
*/
|
|
@@ -1,58 +1,55 @@
|
|
|
1
1
|
import { ChildProperty } from '@syncfusion/ej2-base';
|
|
2
2
|
import { PageSizeMode } from '../enum';
|
|
3
3
|
/**
|
|
4
|
-
* Configures the paging behavior of the TreeGrid.
|
|
4
|
+
* Configures the paging behavior of the TreeGrid, enabling you to manage and display data efficiently across multiple pages.
|
|
5
5
|
*/
|
|
6
6
|
export declare class PageSettings extends ChildProperty<PageSettings> {
|
|
7
7
|
/**
|
|
8
|
-
*
|
|
8
|
+
* Specifies the number of records to display per page in the TreeGrid. Adjust this setting to control the volume of data presented on each page.
|
|
9
9
|
*
|
|
10
10
|
* @default 12
|
|
11
11
|
*/
|
|
12
12
|
pageSize: number;
|
|
13
13
|
/**
|
|
14
|
-
*
|
|
14
|
+
* Determines the number of page numbers displayed in the TreeGrid pager container. This setting helps users navigate between different parts of the dataset.
|
|
15
15
|
*
|
|
16
16
|
* @default 8
|
|
17
17
|
*/
|
|
18
18
|
pageCount: number;
|
|
19
19
|
/**
|
|
20
|
-
*
|
|
20
|
+
* Sets the current page number in the TreeGrid, defining which page of data is initially displayed to users.
|
|
21
21
|
*
|
|
22
22
|
* @default 1
|
|
23
23
|
*/
|
|
24
24
|
currentPage: number;
|
|
25
25
|
/**
|
|
26
26
|
* @hidden
|
|
27
|
-
*
|
|
27
|
+
* Retrieves the total number of records in the TreeGrid. This property is primarily used internally by the TreeGrid component.
|
|
28
28
|
*/
|
|
29
29
|
totalRecordsCount: number;
|
|
30
30
|
/**
|
|
31
|
-
*
|
|
32
|
-
* then it pass current page information as a query string along with the URL while navigating to other page in TreeGrid.
|
|
31
|
+
* When set to true, appends the current page information as a query string to the remote service URL during page navigation within the TreeGrid.
|
|
33
32
|
*
|
|
34
33
|
* @default false
|
|
35
34
|
*/
|
|
36
35
|
enableQueryString: boolean;
|
|
37
36
|
/**
|
|
38
|
-
*
|
|
39
|
-
* It renders DropDownList in the pager of TreeGrid which allow us to select pageSize from DropDownList.
|
|
37
|
+
* Enables a DropDownList in the TreeGrid pager, allowing users to select the page size. Accepts either a boolean to toggle this feature or an array of page size options.
|
|
40
38
|
*
|
|
41
39
|
* @default false
|
|
42
40
|
*/
|
|
43
41
|
pageSizes: boolean | (number | string)[];
|
|
44
42
|
/**
|
|
45
|
-
*
|
|
46
|
-
* It accepts either [template string](https://ej2.syncfusion.com/documentation/common/template-engine/) or HTML element ID.
|
|
43
|
+
* Provides a custom template for rendering pager elements in the TreeGrid, offering enhanced flexibility and control over the pager's appearance and functionality. Accepts a template string or the ID of an HTML element.
|
|
47
44
|
*
|
|
48
45
|
* @default null
|
|
49
46
|
* @aspType string
|
|
50
47
|
*/
|
|
51
48
|
template: string | Function;
|
|
52
49
|
/**
|
|
53
|
-
* Specifies the mode
|
|
54
|
-
* * `All`:
|
|
55
|
-
* * `Root`:
|
|
50
|
+
* Specifies the mode for counting records on a page, determining whether all records are counted or only zeroth level parent records. The available options are:
|
|
51
|
+
* * `All`: Includes all records in the count.
|
|
52
|
+
* * `Root`: Includes only zeroth level parent records.
|
|
56
53
|
*
|
|
57
54
|
* @default All
|
|
58
55
|
*/
|
|
@@ -19,7 +19,7 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
|
|
|
19
19
|
};
|
|
20
20
|
import { Property, ChildProperty } from '@syncfusion/ej2-base';
|
|
21
21
|
/**
|
|
22
|
-
* Configures the paging behavior of the TreeGrid.
|
|
22
|
+
* Configures the paging behavior of the TreeGrid, enabling you to manage and display data efficiently across multiple pages.
|
|
23
23
|
*/
|
|
24
24
|
var PageSettings = /** @class */ (function (_super) {
|
|
25
25
|
__extends(PageSettings, _super);
|
|
@@ -6,7 +6,7 @@ import { Property, ChildProperty } from '@syncfusion/ej2-base';import { ITreeDat
|
|
|
6
6
|
export interface RowDropSettingsModel {
|
|
7
7
|
|
|
8
8
|
/**
|
|
9
|
-
*
|
|
9
|
+
* Specifies the ID of the droppable component where rows can be dragged and dropped. Ensures that the row drop operation targets the correct component within the application.
|
|
10
10
|
*
|
|
11
11
|
* @default null
|
|
12
12
|
*/
|
|
@@ -1,27 +1,34 @@
|
|
|
1
1
|
import { ChildProperty } from '@syncfusion/ej2-base';
|
|
2
2
|
import { ITreeData } from '..';
|
|
3
3
|
/**
|
|
4
|
-
* Configures the row
|
|
4
|
+
* Configures the settings for row dragging and dropping within the TreeGrid, allowing for enhanced user interaction and data manipulation capabilities.
|
|
5
5
|
*/
|
|
6
6
|
export declare class RowDropSettings extends ChildProperty<RowDropSettings> {
|
|
7
7
|
/**
|
|
8
|
-
*
|
|
8
|
+
* Specifies the ID of the droppable component where rows can be dragged and dropped. Ensures that the row drop operation targets the correct component within the application.
|
|
9
9
|
*
|
|
10
10
|
* @default null
|
|
11
11
|
*/
|
|
12
12
|
targetID: string;
|
|
13
13
|
}
|
|
14
|
+
/**
|
|
15
|
+
* Interface for TreeGrid row drop action event arguments, providing detailed information about the row drop operation and its related context.
|
|
16
|
+
*/
|
|
14
17
|
export interface TreeActionEventArgs {
|
|
18
|
+
/** Identifies the type of request made during the action. */
|
|
15
19
|
requestType?: string;
|
|
20
|
+
/** Contains the data of the row(s) involved in the action, either a single row or an array of rows. */
|
|
16
21
|
data?: ITreeData | ITreeData[];
|
|
22
|
+
/** Refers to the rows affected by the action. */
|
|
17
23
|
row?: Object[];
|
|
24
|
+
/** A boolean value indicating whether the action should be canceled. */
|
|
18
25
|
cancel?: boolean;
|
|
19
|
-
/**
|
|
26
|
+
/** Describes the specific action being performed. */
|
|
20
27
|
action?: string;
|
|
21
|
-
/**
|
|
28
|
+
/** Indicates the target index where the row(s) will be dropped. */
|
|
22
29
|
dropIndex?: number;
|
|
23
|
-
/**
|
|
30
|
+
/** Specifies the position where the dragged record will be dropped relative to the target. */
|
|
24
31
|
dropPosition?: string;
|
|
25
|
-
/**
|
|
32
|
+
/** Lists the records that have been modified as a result of the action. */
|
|
26
33
|
modifiedRecords?: ITreeData[];
|
|
27
34
|
}
|
|
@@ -19,7 +19,7 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
|
|
|
19
19
|
};
|
|
20
20
|
import { Property, ChildProperty } from '@syncfusion/ej2-base';
|
|
21
21
|
/**
|
|
22
|
-
* Configures the row
|
|
22
|
+
* Configures the settings for row dragging and dropping within the TreeGrid, allowing for enhanced user interaction and data manipulation capabilities.
|
|
23
23
|
*/
|
|
24
24
|
var RowDropSettings = /** @class */ (function (_super) {
|
|
25
25
|
__extends(RowDropSettings, _super);
|