@syncfusion/ej2-grids 18.3.44 → 18.3.50-85492
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/CHANGELOG.md +1800 -1751
- package/README.md +81 -81
- package/dist/ej2-grids.umd.min.js +1 -10
- package/dist/ej2-grids.umd.min.js.map +1 -1
- package/dist/es6/ej2-grids.es2015.js +171 -105
- package/dist/es6/ej2-grids.es2015.js.map +1 -1
- package/dist/es6/ej2-grids.es5.js +726 -658
- package/dist/es6/ej2-grids.es5.js.map +1 -1
- package/helpers/e2e/index.js +3 -3
- package/license +10 -10
- package/package.json +81 -81
- package/src/grid/actions/batch-edit.js +2 -2
- package/src/grid/actions/dialog-edit.js +13 -13
- package/src/grid/actions/edit.js +4 -4
- package/src/grid/actions/excel-export.js +11 -2
- package/src/grid/actions/excel-filter.js +13 -13
- package/src/grid/actions/foreign-key.js +13 -13
- package/src/grid/actions/group.js +1 -1
- package/src/grid/actions/infinite-scroll.d.ts +1 -0
- package/src/grid/actions/infinite-scroll.js +1 -0
- package/src/grid/actions/inline-edit.js +13 -13
- package/src/grid/actions/normal-edit.js +3 -3
- package/src/grid/actions/page.js +6 -2
- package/src/grid/actions/pdf-export.js +12 -3
- package/src/grid/actions/print.js +4 -4
- package/src/grid/actions/resize.js +4 -1
- package/src/grid/actions/row-reorder.js +2 -2
- package/src/grid/actions/selection.js +23 -21
- package/src/grid/actions/toolbar.js +8 -8
- package/src/grid/base/constant.d.ts +2 -0
- package/src/grid/base/constant.js +2 -0
- package/src/grid/base/grid-model.d.ts +1283 -1284
- package/src/grid/base/grid.d.ts +49 -50
- package/src/grid/base/grid.js +34 -25
- package/src/grid/base/interface.d.ts +13 -0
- package/src/grid/base/util.js +3 -3
- package/src/grid/common/excel-filter-base.js +13 -13
- package/src/grid/models/aggregate-model.d.ts +74 -74
- package/src/grid/models/aggregate.js +19 -19
- package/src/grid/models/column-chooser-settings-model.d.ts +8 -8
- package/src/grid/models/column-chooser-settings.js +19 -19
- package/src/grid/models/column-model.d.ts +11 -11
- package/src/grid/models/column.d.ts +5 -5
- package/src/grid/models/column.js +6 -6
- package/src/grid/models/page-settings-model.d.ts +36 -36
- package/src/grid/models/page-settings.js +19 -19
- package/src/grid/renderer/caption-cell-renderer.js +16 -13
- package/src/grid/renderer/command-column-renderer.js +13 -13
- package/src/grid/renderer/content-renderer.js +16 -1
- package/src/grid/renderer/detail-expand-cell-renderer.js +13 -13
- package/src/grid/renderer/detail-header-indent-renderer.js +13 -13
- package/src/grid/renderer/dialog-edit-renderer.js +2 -1
- package/src/grid/renderer/dropdown-edit-cell.js +2 -2
- package/src/grid/renderer/edit-renderer.js +2 -2
- package/src/grid/renderer/expand-cell-renderer.js +13 -13
- package/src/grid/renderer/filter-cell-renderer.js +13 -13
- package/src/grid/renderer/footer-renderer.js +13 -13
- package/src/grid/renderer/freeze-renderer.js +13 -13
- package/src/grid/renderer/group-lazy-load-renderer.js +13 -13
- package/src/grid/renderer/header-cell-renderer.js +13 -13
- package/src/grid/renderer/header-indent-renderer.js +13 -13
- package/src/grid/renderer/indent-cell-renderer.js +13 -13
- package/src/grid/renderer/render.js +1 -1
- package/src/grid/renderer/row-drag-drop-renderer.js +13 -13
- package/src/grid/renderer/row-drag-header-indent-render.js +13 -13
- package/src/grid/renderer/stacked-cell-renderer.js +13 -13
- package/src/grid/renderer/summary-cell-renderer.js +13 -13
- package/src/grid/renderer/virtual-content-renderer.js +13 -13
- package/src/grid/renderer/virtual-freeze-renderer.js +13 -13
- package/src/grid/services/focus-strategy.d.ts +2 -1
- package/src/grid/services/focus-strategy.js +26 -16
- package/src/grid/services/group-model-generator.js +13 -13
- package/src/grid/services/row-model-generator.js +1 -1
- package/src/grid/services/summary-model-generator.js +13 -13
- package/src/pager/pager-dropdown.js +1 -1
- package/src/pager/pager-message.js +1 -1
- package/src/pager/pager-model.d.ts +59 -59
- package/src/pager/pager.js +19 -19
- package/styles/bootstrap-dark.css +0 -4
- package/styles/bootstrap.css +0 -4
- package/styles/bootstrap4.css +5 -4
- package/styles/bootstrap5-dark.css +0 -0
- package/styles/bootstrap5-dark.scss +0 -0
- package/styles/bootstrap5.css +0 -0
- package/styles/bootstrap5.scss +0 -0
- package/styles/excel-filter/_all.scss +2 -2
- package/styles/excel-filter/_bootstrap-dark-definition.scss +54 -54
- package/styles/excel-filter/_bootstrap-definition.scss +61 -61
- package/styles/excel-filter/_bootstrap4-definition.scss +70 -70
- package/styles/excel-filter/_fabric-dark-definition.scss +54 -54
- package/styles/excel-filter/_fabric-definition.scss +59 -59
- package/styles/excel-filter/_highcontrast-definition.scss +54 -54
- package/styles/excel-filter/_highcontrast-light-definition.scss +50 -50
- package/styles/excel-filter/_layout.scss +387 -387
- package/styles/excel-filter/_material-dark-definition.scss +56 -56
- package/styles/excel-filter/_material-definition.scss +57 -57
- package/styles/excel-filter/_office-365-definition.scss +1 -1
- package/styles/excel-filter/_theme.scss +18 -18
- package/styles/excel-filter/bootstrap-dark.css +0 -1
- package/styles/excel-filter/bootstrap.css +0 -1
- package/styles/excel-filter/bootstrap.scss +1 -0
- package/styles/excel-filter/bootstrap4.css +5 -1
- package/styles/excel-filter/fabric.scss +1 -0
- package/styles/excel-filter/highcontrast.scss +1 -0
- package/styles/excel-filter/icons/_bootstrap-dark.scss +29 -29
- package/styles/excel-filter/icons/_bootstrap.scss +29 -29
- package/styles/excel-filter/icons/_bootstrap4.scss +29 -29
- package/styles/excel-filter/icons/_fabric-dark.scss +29 -29
- package/styles/excel-filter/icons/_fabric.scss +29 -29
- package/styles/excel-filter/icons/_highcontrast-light.scss +29 -29
- package/styles/excel-filter/icons/_highcontrast.scss +29 -29
- package/styles/excel-filter/icons/_material-dark.scss +29 -29
- package/styles/excel-filter/icons/_material.scss +29 -29
- package/styles/excel-filter/material.scss +1 -0
- package/styles/fabric-dark.css +0 -3
- package/styles/fabric.css +0 -3
- package/styles/grid/_all.scss +2 -2
- package/styles/grid/_bootstrap-dark-definition.scss +497 -497
- package/styles/grid/_bootstrap-definition.scss +500 -500
- package/styles/grid/_bootstrap4-definition.scss +501 -502
- package/styles/grid/_fabric-dark-definition.scss +499 -499
- package/styles/grid/_fabric-definition.scss +499 -499
- package/styles/grid/_highcontrast-definition.scss +498 -498
- package/styles/grid/_highcontrast-light-definition.scss +495 -495
- package/styles/grid/_layout.scss +2908 -2908
- package/styles/grid/_material-dark-definition.scss +495 -495
- package/styles/grid/_material-definition.scss +495 -495
- package/styles/grid/_office-365-definition.scss +1 -1
- package/styles/grid/_theme.scss +529 -529
- package/styles/grid/bootstrap-dark.css +0 -4
- package/styles/grid/bootstrap.css +0 -4
- package/styles/grid/bootstrap.scss +1 -0
- package/styles/grid/bootstrap4.css +5 -4
- package/styles/grid/fabric-dark.css +0 -3
- package/styles/grid/fabric.css +0 -3
- package/styles/grid/fabric.scss +1 -0
- package/styles/grid/highcontrast-light.css +0 -3
- package/styles/grid/highcontrast.css +0 -3
- package/styles/grid/highcontrast.scss +1 -0
- package/styles/grid/icons/_bootstrap-dark.scss +180 -180
- package/styles/grid/icons/_bootstrap.scss +180 -180
- package/styles/grid/icons/_bootstrap4.scss +180 -180
- package/styles/grid/icons/_fabric-dark.scss +180 -180
- package/styles/grid/icons/_fabric.scss +180 -180
- package/styles/grid/icons/_highcontrast-light.scss +180 -180
- package/styles/grid/icons/_highcontrast.scss +181 -181
- package/styles/grid/icons/_material-dark.scss +180 -180
- package/styles/grid/icons/_material.scss +180 -180
- package/styles/grid/material-dark.css +0 -3
- package/styles/grid/material.css +0 -3
- package/styles/grid/material.scss +1 -0
- package/styles/highcontrast-light.css +0 -3
- package/styles/highcontrast.css +0 -3
- package/styles/material-dark.css +0 -3
- package/styles/material.css +0 -3
- package/styles/pager/_all.scss +2 -2
- package/styles/pager/_bootstrap-dark-definition.scss +112 -112
- package/styles/pager/_bootstrap-definition.scss +112 -112
- package/styles/pager/_bootstrap4-definition.scss +111 -112
- package/styles/pager/_fabric-dark-definition.scss +113 -113
- package/styles/pager/_fabric-definition.scss +112 -112
- package/styles/pager/_highcontrast-definition.scss +112 -112
- package/styles/pager/_highcontrast-light-definition.scss +112 -112
- package/styles/pager/_layout.scss +575 -575
- package/styles/pager/_material-dark-definition.scss +112 -112
- package/styles/pager/_material-definition.scss +111 -111
- package/styles/pager/_theme.scss +129 -129
- package/styles/pager/icons/_bootstrap-dark.scss +49 -49
- package/styles/pager/icons/_bootstrap.scss +49 -49
- package/styles/pager/icons/_bootstrap4.scss +49 -49
- package/styles/pager/icons/_fabric-dark.scss +49 -49
- package/styles/pager/icons/_fabric.scss +49 -49
- package/styles/pager/icons/_highcontrast-light.scss +49 -49
- package/styles/pager/icons/_highcontrast.scss +41 -41
- package/styles/pager/icons/_material-dark.scss +49 -49
- package/styles/pager/icons/_material.scss +41 -41
- package/styles/tailwind-dark.css +0 -0
- package/styles/tailwind-dark.scss +0 -0
- package/styles/tailwind.css +0 -0
- package/styles/tailwind.scss +0 -0
- package/dist/global/ej2-grids.min.js +0 -11
- package/dist/global/ej2-grids.min.js.map +0 -1
- package/dist/global/index.d.ts +0 -14
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { Component, ModuleDeclaration, ChildProperty, Browser, closest, extend, TouchEventArgs } from '@syncfusion/ej2-base';
|
|
1
|
+
import { Component, ModuleDeclaration, ChildProperty, Browser, closest, extend, TouchEventArgs } from '@syncfusion/ej2-base';
|
|
2
2
|
import {ComponentModel} from '@syncfusion/ej2-base';
|
|
3
3
|
|
|
4
4
|
/**
|
|
@@ -7,24 +7,24 @@ import {ComponentModel} from '@syncfusion/ej2-base';
|
|
|
7
7
|
export interface SortDescriptorModel {
|
|
8
8
|
|
|
9
9
|
/**
|
|
10
|
-
* Defines the field name of sort column.
|
|
11
|
-
* @default ''
|
|
12
|
-
*/
|
|
13
|
-
field?: string;
|
|
10
|
+
* Defines the field name of sort column.
|
|
11
|
+
* @default ''
|
|
12
|
+
*/
|
|
13
|
+
field?: string;
|
|
14
14
|
|
|
15
15
|
/**
|
|
16
|
-
* Defines the direction of sort column.
|
|
17
|
-
* @default ''
|
|
18
|
-
* @blazorDefaultValue null
|
|
19
|
-
*/
|
|
20
|
-
direction?: SortDirection;
|
|
16
|
+
* Defines the direction of sort column.
|
|
17
|
+
* @default ''
|
|
18
|
+
* @blazorDefaultValue null
|
|
19
|
+
*/
|
|
20
|
+
direction?: SortDirection;
|
|
21
21
|
|
|
22
22
|
/**
|
|
23
|
-
* @hidden
|
|
24
|
-
* Defines the sorted column whether or from grouping operation.
|
|
25
|
-
* @default false
|
|
26
|
-
*/
|
|
27
|
-
isFromGroup?: boolean;
|
|
23
|
+
* @hidden
|
|
24
|
+
* Defines the sorted column whether or from grouping operation.
|
|
25
|
+
* @default false
|
|
26
|
+
*/
|
|
27
|
+
isFromGroup?: boolean;
|
|
28
28
|
|
|
29
29
|
}
|
|
30
30
|
|
|
@@ -34,17 +34,17 @@ export interface SortDescriptorModel {
|
|
|
34
34
|
export interface SortSettingsModel {
|
|
35
35
|
|
|
36
36
|
/**
|
|
37
|
-
* Specifies the columns to sort at initial rendering of Grid.
|
|
38
|
-
* Also user can get current sorted columns.
|
|
39
|
-
* @default []
|
|
40
|
-
*/
|
|
41
|
-
columns?: SortDescriptorModel[];
|
|
37
|
+
* Specifies the columns to sort at initial rendering of Grid.
|
|
38
|
+
* Also user can get current sorted columns.
|
|
39
|
+
* @default []
|
|
40
|
+
*/
|
|
41
|
+
columns?: SortDescriptorModel[];
|
|
42
42
|
|
|
43
43
|
/**
|
|
44
|
-
* If `allowUnsort` set to false the user can not get the grid in unsorted state by clicking the sorted column header.
|
|
45
|
-
* @default true
|
|
46
|
-
*/
|
|
47
|
-
allowUnsort?: boolean;
|
|
44
|
+
* If `allowUnsort` set to false the user can not get the grid in unsorted state by clicking the sorted column header.
|
|
45
|
+
* @default true
|
|
46
|
+
*/
|
|
47
|
+
allowUnsort?: boolean;
|
|
48
48
|
|
|
49
49
|
}
|
|
50
50
|
|
|
@@ -54,130 +54,130 @@ export interface SortSettingsModel {
|
|
|
54
54
|
export interface PredicateModel {
|
|
55
55
|
|
|
56
56
|
/**
|
|
57
|
-
* Defines the field name of the filter column.
|
|
58
|
-
* @default ''
|
|
59
|
-
*/
|
|
60
|
-
field?: string;
|
|
61
|
-
|
|
62
|
-
/**
|
|
63
|
-
* Defines the operator to filter records. The available operators and its supported data types are:
|
|
64
|
-
* <table>
|
|
65
|
-
* <tr>
|
|
66
|
-
* <td colspan=1 rowspan=1>
|
|
67
|
-
* Operator<br/></td><td colspan=1 rowspan=1>
|
|
68
|
-
* Description<br/></td><td colspan=1 rowspan=1>
|
|
69
|
-
* Supported Types<br/></td></tr>
|
|
70
|
-
* <tr>
|
|
71
|
-
* <td colspan=1 rowspan=1>
|
|
72
|
-
* startswith<br/></td><td colspan=1 rowspan=1>
|
|
73
|
-
* Checks whether the value begins with the specified value.<br/></td><td colspan=1 rowspan=1>
|
|
74
|
-
* String<br/></td></tr>
|
|
75
|
-
* <tr>
|
|
76
|
-
* <td colspan=1 rowspan=1>
|
|
77
|
-
* endswith<br/></td><td colspan=1 rowspan=1>
|
|
78
|
-
* Checks whether the value ends with the specified value.<br/><br/></td><td colspan=1 rowspan=1>
|
|
79
|
-
* <br/>String<br/></td></tr>
|
|
80
|
-
* <tr>
|
|
81
|
-
* <td colspan=1 rowspan=1>
|
|
82
|
-
* contains<br/></td><td colspan=1 rowspan=1>
|
|
83
|
-
* Checks whether the value contains the specified value.<br/><br/></td><td colspan=1 rowspan=1>
|
|
84
|
-
* <br/>String<br/></td></tr>
|
|
85
|
-
* <tr>
|
|
86
|
-
* <td colspan=1 rowspan=1>
|
|
87
|
-
* equal<br/></td><td colspan=1 rowspan=1>
|
|
88
|
-
* Checks whether the value is equal to the specified value.<br/><br/></td><td colspan=1 rowspan=1>
|
|
89
|
-
* <br/>String | Number | Boolean | Date<br/></td></tr>
|
|
90
|
-
* <tr>
|
|
91
|
-
* <td colspan=1 rowspan=1>
|
|
92
|
-
* notequal<br/></td><td colspan=1 rowspan=1>
|
|
93
|
-
* Checks for values that are not equal to the specified value.<br/><br/></td><td colspan=1 rowspan=1>
|
|
94
|
-
* <br/>String | Number | Boolean | Date<br/></td></tr>
|
|
95
|
-
* <tr>
|
|
96
|
-
* <td colspan=1 rowspan=1>
|
|
97
|
-
* greaterthan<br/></td><td colspan=1 rowspan=1>
|
|
98
|
-
* Checks whether the value is greater than the specified value.<br/><br/></td><td colspan=1 rowspan=1>
|
|
99
|
-
* Number | Date<br/></td></tr>
|
|
100
|
-
* <tr>
|
|
101
|
-
* <td colspan=1 rowspan=1>
|
|
102
|
-
* greaterthanorequal<br/></td><td colspan=1 rowspan=1>
|
|
103
|
-
* Checks whether the value is greater than or equal to the specified value.<br/><br/></td><td colspan=1 rowspan=1>
|
|
104
|
-
* <br/>Number | Date<br/></td></tr>
|
|
105
|
-
* <tr>
|
|
106
|
-
* <td colspan=1 rowspan=1>
|
|
107
|
-
* lessthan<br/></td><td colspan=1 rowspan=1>
|
|
108
|
-
* Checks whether the value is less than the specified value.<br/><br/></td><td colspan=1 rowspan=1>
|
|
109
|
-
* <br/>Number | Date<br/></td></tr>
|
|
110
|
-
* <tr>
|
|
111
|
-
* <td colspan=1 rowspan=1>
|
|
112
|
-
* lessthanorequal<br/></td><td colspan=1 rowspan=1>
|
|
113
|
-
* Checks whether the value is less than or equal to the specified value.<br/><br/></td><td colspan=1 rowspan=1>
|
|
114
|
-
* <br/>Number | Date<br/></td></tr>
|
|
115
|
-
* </table>
|
|
116
|
-
* @default null
|
|
117
|
-
* @blazorType Syncfusion.Blazor.Operator
|
|
118
|
-
* @blazorDefaultValue Syncfusion.Blazor.Operator.None
|
|
119
|
-
*/
|
|
120
|
-
operator?: string;
|
|
121
|
-
|
|
122
|
-
/**
|
|
123
|
-
* Defines the value used to filter records.
|
|
124
|
-
* @default ''
|
|
125
|
-
*/
|
|
126
|
-
value?: string | number | Date | boolean;
|
|
127
|
-
|
|
128
|
-
/**
|
|
129
|
-
* If match case set to true, then filter records with exact match or else
|
|
130
|
-
* filter records with case insensitive(uppercase and lowercase letters treated as same).
|
|
131
|
-
* @default null
|
|
132
|
-
*/
|
|
133
|
-
matchCase?: boolean;
|
|
134
|
-
|
|
135
|
-
/**
|
|
136
|
-
* If ignoreAccent is set to true, then filter ignores the diacritic characters or accents while filtering.
|
|
137
|
-
* @default false
|
|
138
|
-
*/
|
|
139
|
-
ignoreAccent?: boolean;
|
|
140
|
-
|
|
141
|
-
/**
|
|
142
|
-
* Defines the relationship between one filter query and another by using AND or OR predicate.
|
|
143
|
-
* @default null
|
|
144
|
-
*/
|
|
145
|
-
predicate?: string;
|
|
146
|
-
|
|
147
|
-
/**
|
|
148
|
-
* @hidden
|
|
149
|
-
* Defines the actual filter value for the filter column.
|
|
150
|
-
*/
|
|
151
|
-
actualFilterValue?: Object;
|
|
152
|
-
|
|
153
|
-
/**
|
|
154
|
-
* @hidden
|
|
155
|
-
* Defines the actual filter operator for the filter column.
|
|
156
|
-
*/
|
|
157
|
-
actualOperator?: Object;
|
|
158
|
-
|
|
159
|
-
/**
|
|
160
|
-
* @hidden
|
|
161
|
-
* Defines the type of the filter column.
|
|
162
|
-
*/
|
|
163
|
-
type?: string;
|
|
164
|
-
|
|
165
|
-
/**
|
|
166
|
-
* @hidden
|
|
167
|
-
* Defines the predicate of filter column.
|
|
168
|
-
*/
|
|
169
|
-
ejpredicate?: Object;
|
|
170
|
-
|
|
171
|
-
/**
|
|
172
|
-
* Defines the UID of filter column.
|
|
173
|
-
*/
|
|
174
|
-
uid?: string;
|
|
175
|
-
|
|
176
|
-
/**
|
|
177
|
-
* @hidden
|
|
178
|
-
* Defines the foreignKey availability in filtered columns.
|
|
179
|
-
*/
|
|
180
|
-
isForeignKey?: boolean;
|
|
57
|
+
* Defines the field name of the filter column.
|
|
58
|
+
* @default ''
|
|
59
|
+
*/
|
|
60
|
+
field?: string;
|
|
61
|
+
|
|
62
|
+
/**
|
|
63
|
+
* Defines the operator to filter records. The available operators and its supported data types are:
|
|
64
|
+
* <table>
|
|
65
|
+
* <tr>
|
|
66
|
+
* <td colspan=1 rowspan=1>
|
|
67
|
+
* Operator<br/></td><td colspan=1 rowspan=1>
|
|
68
|
+
* Description<br/></td><td colspan=1 rowspan=1>
|
|
69
|
+
* Supported Types<br/></td></tr>
|
|
70
|
+
* <tr>
|
|
71
|
+
* <td colspan=1 rowspan=1>
|
|
72
|
+
* startswith<br/></td><td colspan=1 rowspan=1>
|
|
73
|
+
* Checks whether the value begins with the specified value.<br/></td><td colspan=1 rowspan=1>
|
|
74
|
+
* String<br/></td></tr>
|
|
75
|
+
* <tr>
|
|
76
|
+
* <td colspan=1 rowspan=1>
|
|
77
|
+
* endswith<br/></td><td colspan=1 rowspan=1>
|
|
78
|
+
* Checks whether the value ends with the specified value.<br/><br/></td><td colspan=1 rowspan=1>
|
|
79
|
+
* <br/>String<br/></td></tr>
|
|
80
|
+
* <tr>
|
|
81
|
+
* <td colspan=1 rowspan=1>
|
|
82
|
+
* contains<br/></td><td colspan=1 rowspan=1>
|
|
83
|
+
* Checks whether the value contains the specified value.<br/><br/></td><td colspan=1 rowspan=1>
|
|
84
|
+
* <br/>String<br/></td></tr>
|
|
85
|
+
* <tr>
|
|
86
|
+
* <td colspan=1 rowspan=1>
|
|
87
|
+
* equal<br/></td><td colspan=1 rowspan=1>
|
|
88
|
+
* Checks whether the value is equal to the specified value.<br/><br/></td><td colspan=1 rowspan=1>
|
|
89
|
+
* <br/>String | Number | Boolean | Date<br/></td></tr>
|
|
90
|
+
* <tr>
|
|
91
|
+
* <td colspan=1 rowspan=1>
|
|
92
|
+
* notequal<br/></td><td colspan=1 rowspan=1>
|
|
93
|
+
* Checks for values that are not equal to the specified value.<br/><br/></td><td colspan=1 rowspan=1>
|
|
94
|
+
* <br/>String | Number | Boolean | Date<br/></td></tr>
|
|
95
|
+
* <tr>
|
|
96
|
+
* <td colspan=1 rowspan=1>
|
|
97
|
+
* greaterthan<br/></td><td colspan=1 rowspan=1>
|
|
98
|
+
* Checks whether the value is greater than the specified value.<br/><br/></td><td colspan=1 rowspan=1>
|
|
99
|
+
* Number | Date<br/></td></tr>
|
|
100
|
+
* <tr>
|
|
101
|
+
* <td colspan=1 rowspan=1>
|
|
102
|
+
* greaterthanorequal<br/></td><td colspan=1 rowspan=1>
|
|
103
|
+
* Checks whether the value is greater than or equal to the specified value.<br/><br/></td><td colspan=1 rowspan=1>
|
|
104
|
+
* <br/>Number | Date<br/></td></tr>
|
|
105
|
+
* <tr>
|
|
106
|
+
* <td colspan=1 rowspan=1>
|
|
107
|
+
* lessthan<br/></td><td colspan=1 rowspan=1>
|
|
108
|
+
* Checks whether the value is less than the specified value.<br/><br/></td><td colspan=1 rowspan=1>
|
|
109
|
+
* <br/>Number | Date<br/></td></tr>
|
|
110
|
+
* <tr>
|
|
111
|
+
* <td colspan=1 rowspan=1>
|
|
112
|
+
* lessthanorequal<br/></td><td colspan=1 rowspan=1>
|
|
113
|
+
* Checks whether the value is less than or equal to the specified value.<br/><br/></td><td colspan=1 rowspan=1>
|
|
114
|
+
* <br/>Number | Date<br/></td></tr>
|
|
115
|
+
* </table>
|
|
116
|
+
* @default null
|
|
117
|
+
* @blazorType Syncfusion.Blazor.Operator
|
|
118
|
+
* @blazorDefaultValue Syncfusion.Blazor.Operator.None
|
|
119
|
+
*/
|
|
120
|
+
operator?: string;
|
|
121
|
+
|
|
122
|
+
/**
|
|
123
|
+
* Defines the value used to filter records.
|
|
124
|
+
* @default ''
|
|
125
|
+
*/
|
|
126
|
+
value?: string | number | Date | boolean;
|
|
127
|
+
|
|
128
|
+
/**
|
|
129
|
+
* If match case set to true, then filter records with exact match or else
|
|
130
|
+
* filter records with case insensitive(uppercase and lowercase letters treated as same).
|
|
131
|
+
* @default null
|
|
132
|
+
*/
|
|
133
|
+
matchCase?: boolean;
|
|
134
|
+
|
|
135
|
+
/**
|
|
136
|
+
* If ignoreAccent is set to true, then filter ignores the diacritic characters or accents while filtering.
|
|
137
|
+
* @default false
|
|
138
|
+
*/
|
|
139
|
+
ignoreAccent?: boolean;
|
|
140
|
+
|
|
141
|
+
/**
|
|
142
|
+
* Defines the relationship between one filter query and another by using AND or OR predicate.
|
|
143
|
+
* @default null
|
|
144
|
+
*/
|
|
145
|
+
predicate?: string;
|
|
146
|
+
|
|
147
|
+
/**
|
|
148
|
+
* @hidden
|
|
149
|
+
* Defines the actual filter value for the filter column.
|
|
150
|
+
*/
|
|
151
|
+
actualFilterValue?: Object;
|
|
152
|
+
|
|
153
|
+
/**
|
|
154
|
+
* @hidden
|
|
155
|
+
* Defines the actual filter operator for the filter column.
|
|
156
|
+
*/
|
|
157
|
+
actualOperator?: Object;
|
|
158
|
+
|
|
159
|
+
/**
|
|
160
|
+
* @hidden
|
|
161
|
+
* Defines the type of the filter column.
|
|
162
|
+
*/
|
|
163
|
+
type?: string;
|
|
164
|
+
|
|
165
|
+
/**
|
|
166
|
+
* @hidden
|
|
167
|
+
* Defines the predicate of filter column.
|
|
168
|
+
*/
|
|
169
|
+
ejpredicate?: Object;
|
|
170
|
+
|
|
171
|
+
/**
|
|
172
|
+
* Defines the UID of filter column.
|
|
173
|
+
*/
|
|
174
|
+
uid?: string;
|
|
175
|
+
|
|
176
|
+
/**
|
|
177
|
+
* @hidden
|
|
178
|
+
* Defines the foreignKey availability in filtered columns.
|
|
179
|
+
*/
|
|
180
|
+
isForeignKey?: boolean;
|
|
181
181
|
|
|
182
182
|
}
|
|
183
183
|
|
|
@@ -187,22 +187,22 @@ export interface PredicateModel {
|
|
|
187
187
|
export interface InfiniteScrollSettingsModel {
|
|
188
188
|
|
|
189
189
|
/**
|
|
190
|
-
* If `enableCache` is set to true, the Grid will cache the loaded data to be reused next time it is needed.
|
|
191
|
-
* @default false
|
|
192
|
-
*/
|
|
193
|
-
enableCache?: boolean;
|
|
190
|
+
* If `enableCache` is set to true, the Grid will cache the loaded data to be reused next time it is needed.
|
|
191
|
+
* @default false
|
|
192
|
+
*/
|
|
193
|
+
enableCache?: boolean;
|
|
194
194
|
|
|
195
195
|
/**
|
|
196
|
-
* Defines the number of blocks to be maintained in Grid while settings enableCache as true.
|
|
197
|
-
* @default 3
|
|
198
|
-
*/
|
|
199
|
-
maxBlocks?: number;
|
|
196
|
+
* Defines the number of blocks to be maintained in Grid while settings enableCache as true.
|
|
197
|
+
* @default 3
|
|
198
|
+
*/
|
|
199
|
+
maxBlocks?: number;
|
|
200
200
|
|
|
201
201
|
/**
|
|
202
|
-
* Defines the number of blocks will render at the initial Grid rendering while enableCache is enabled.
|
|
203
|
-
* @default 3
|
|
204
|
-
*/
|
|
205
|
-
initialBlocks?: number;
|
|
202
|
+
* Defines the number of blocks will render at the initial Grid rendering while enableCache is enabled.
|
|
203
|
+
* @default 3
|
|
204
|
+
*/
|
|
205
|
+
initialBlocks?: number;
|
|
206
206
|
|
|
207
207
|
}
|
|
208
208
|
|
|
@@ -212,73 +212,73 @@ export interface InfiniteScrollSettingsModel {
|
|
|
212
212
|
export interface FilterSettingsModel {
|
|
213
213
|
|
|
214
214
|
/**
|
|
215
|
-
* Specifies the columns to be filtered at initial rendering of the Grid. You can also get the columns that were currently filtered.
|
|
216
|
-
* @default []
|
|
217
|
-
*/
|
|
218
|
-
columns?: PredicateModel[];
|
|
215
|
+
* Specifies the columns to be filtered at initial rendering of the Grid. You can also get the columns that were currently filtered.
|
|
216
|
+
* @default []
|
|
217
|
+
*/
|
|
218
|
+
columns?: PredicateModel[];
|
|
219
219
|
|
|
220
220
|
/**
|
|
221
|
-
* Defines options for filtering type. The available options are
|
|
222
|
-
* * `Menu` - Specifies the filter type as menu.
|
|
223
|
-
* * `CheckBox` - Specifies the filter type as checkbox.
|
|
224
|
-
* * `FilterBar` - Specifies the filter type as filterbar.
|
|
225
|
-
* * `Excel` - Specifies the filter type as checkbox.
|
|
226
|
-
* @default FilterBar
|
|
227
|
-
*/
|
|
228
|
-
type?: FilterType;
|
|
221
|
+
* Defines options for filtering type. The available options are
|
|
222
|
+
* * `Menu` - Specifies the filter type as menu.
|
|
223
|
+
* * `CheckBox` - Specifies the filter type as checkbox.
|
|
224
|
+
* * `FilterBar` - Specifies the filter type as filterbar.
|
|
225
|
+
* * `Excel` - Specifies the filter type as checkbox.
|
|
226
|
+
* @default FilterBar
|
|
227
|
+
*/
|
|
228
|
+
type?: FilterType;
|
|
229
229
|
|
|
230
230
|
/**
|
|
231
|
-
* Defines the filter bar modes. The available options are,
|
|
232
|
-
* * `OnEnter`: Initiates filter operation after Enter key is pressed.
|
|
233
|
-
* * `Immediate`: Initiates filter operation after a certain time interval. By default, time interval is 1500 ms.
|
|
234
|
-
* @default OnEnter
|
|
235
|
-
*/
|
|
236
|
-
mode?: FilterBarMode;
|
|
231
|
+
* Defines the filter bar modes. The available options are,
|
|
232
|
+
* * `OnEnter`: Initiates filter operation after Enter key is pressed.
|
|
233
|
+
* * `Immediate`: Initiates filter operation after a certain time interval. By default, time interval is 1500 ms.
|
|
234
|
+
* @default OnEnter
|
|
235
|
+
*/
|
|
236
|
+
mode?: FilterBarMode;
|
|
237
237
|
|
|
238
238
|
/**
|
|
239
|
-
* Shows or hides the filtered status message on the pager.
|
|
240
|
-
* @default true
|
|
241
|
-
*/
|
|
242
|
-
showFilterBarStatus?: boolean;
|
|
239
|
+
* Shows or hides the filtered status message on the pager.
|
|
240
|
+
* @default true
|
|
241
|
+
*/
|
|
242
|
+
showFilterBarStatus?: boolean;
|
|
243
243
|
|
|
244
244
|
/**
|
|
245
|
-
* Defines the time delay (in milliseconds) in filtering records when the `Immediate` mode of filter bar is set.
|
|
246
|
-
* @default 1500
|
|
247
|
-
*/
|
|
248
|
-
immediateModeDelay?: number;
|
|
245
|
+
* Defines the time delay (in milliseconds) in filtering records when the `Immediate` mode of filter bar is set.
|
|
246
|
+
* @default 1500
|
|
247
|
+
*/
|
|
248
|
+
immediateModeDelay?: number;
|
|
249
249
|
|
|
250
250
|
/**
|
|
251
|
-
* The `operators` is used to override the default operators in filter menu. This should be defined by type wise
|
|
252
|
-
* (string, number, date and boolean). Based on the column type, this customize operator list will render in filter menu.
|
|
253
|
-
*
|
|
254
|
-
* > Check the [`Filter Menu Operator`](../../grid/how-to/#customizing-filter-menu-operators-list/) customization.
|
|
255
|
-
* @default null
|
|
256
|
-
*/
|
|
257
|
-
operators?: ICustomOptr;
|
|
251
|
+
* The `operators` is used to override the default operators in filter menu. This should be defined by type wise
|
|
252
|
+
* (string, number, date and boolean). Based on the column type, this customize operator list will render in filter menu.
|
|
253
|
+
*
|
|
254
|
+
* > Check the [`Filter Menu Operator`](../../grid/how-to/#customizing-filter-menu-operators-list/) customization.
|
|
255
|
+
* @default null
|
|
256
|
+
*/
|
|
257
|
+
operators?: ICustomOptr;
|
|
258
258
|
|
|
259
259
|
/**
|
|
260
|
-
* If ignoreAccent set to true, then filter ignores the diacritic characters or accents while filtering.
|
|
261
|
-
*
|
|
262
|
-
* > Check the [`Diacritics`](../../grid/filtering/#diacritics/) filtering.
|
|
263
|
-
* @default false
|
|
264
|
-
*/
|
|
265
|
-
ignoreAccent?: boolean;
|
|
260
|
+
* If ignoreAccent set to true, then filter ignores the diacritic characters or accents while filtering.
|
|
261
|
+
*
|
|
262
|
+
* > Check the [`Diacritics`](../../grid/filtering/#diacritics/) filtering.
|
|
263
|
+
* @default false
|
|
264
|
+
*/
|
|
265
|
+
ignoreAccent?: boolean;
|
|
266
266
|
|
|
267
267
|
/**
|
|
268
|
-
* If `enableCaseSensitivity` is set to true then searches grid records with exact match based on the filter
|
|
269
|
-
* operator. It will have no effect on number, boolean and Date fields.
|
|
270
|
-
*
|
|
271
|
-
* @default false
|
|
272
|
-
*/
|
|
273
|
-
enableCaseSensitivity?: boolean;
|
|
268
|
+
* If `enableCaseSensitivity` is set to true then searches grid records with exact match based on the filter
|
|
269
|
+
* operator. It will have no effect on number, boolean and Date fields.
|
|
270
|
+
*
|
|
271
|
+
* @default false
|
|
272
|
+
*/
|
|
273
|
+
enableCaseSensitivity?: boolean;
|
|
274
274
|
|
|
275
275
|
/**
|
|
276
|
-
* If 'showFilterBarOperator' is set to true, then it renders the dropdownlist component to select the operator
|
|
277
|
-
* in filterbar input
|
|
278
|
-
*
|
|
279
|
-
* @default false
|
|
280
|
-
*/
|
|
281
|
-
showFilterBarOperator?: boolean;
|
|
276
|
+
* If 'showFilterBarOperator' is set to true, then it renders the dropdownlist component to select the operator
|
|
277
|
+
* in filterbar input
|
|
278
|
+
*
|
|
279
|
+
* @default false
|
|
280
|
+
*/
|
|
281
|
+
showFilterBarOperator?: boolean;
|
|
282
282
|
|
|
283
283
|
}
|
|
284
284
|
|
|
@@ -288,64 +288,64 @@ export interface FilterSettingsModel {
|
|
|
288
288
|
export interface SelectionSettingsModel {
|
|
289
289
|
|
|
290
290
|
/**
|
|
291
|
-
* Grid supports row, cell, and both (row and cell) selection mode.
|
|
292
|
-
* @default Row
|
|
293
|
-
*/
|
|
294
|
-
mode?: SelectionMode;
|
|
291
|
+
* Grid supports row, cell, and both (row and cell) selection mode.
|
|
292
|
+
* @default Row
|
|
293
|
+
*/
|
|
294
|
+
mode?: SelectionMode;
|
|
295
295
|
|
|
296
296
|
/**
|
|
297
|
-
* The cell selection modes are flow and box. It requires the selection
|
|
298
|
-
* [`mode`](grid/#mode-selectionmode/) to be either cell or both.
|
|
299
|
-
* * `Flow`: Selects the range of cells between start index and end index that also includes the other cells of the selected rows.
|
|
300
|
-
* * `Box`: Selects the range of cells within the start and end column indexes that includes in between cells of rows within the range.
|
|
301
|
-
* * `BoxWithBorder`: Selects the range of cells as like Box mode with borders.
|
|
302
|
-
* @default Flow
|
|
303
|
-
*/
|
|
304
|
-
cellSelectionMode?: CellSelectionMode;
|
|
297
|
+
* The cell selection modes are flow and box. It requires the selection
|
|
298
|
+
* [`mode`](grid/#mode-selectionmode/) to be either cell or both.
|
|
299
|
+
* * `Flow`: Selects the range of cells between start index and end index that also includes the other cells of the selected rows.
|
|
300
|
+
* * `Box`: Selects the range of cells within the start and end column indexes that includes in between cells of rows within the range.
|
|
301
|
+
* * `BoxWithBorder`: Selects the range of cells as like Box mode with borders.
|
|
302
|
+
* @default Flow
|
|
303
|
+
*/
|
|
304
|
+
cellSelectionMode?: CellSelectionMode;
|
|
305
305
|
|
|
306
306
|
/**
|
|
307
|
-
* Defines options for selection type. They are
|
|
308
|
-
* * `Single`: Allows selection of only a row or a cell.
|
|
309
|
-
* * `Multiple`: Allows selection of multiple rows or cells.
|
|
310
|
-
* @default Single
|
|
311
|
-
*/
|
|
312
|
-
type?: SelectionType;
|
|
307
|
+
* Defines options for selection type. They are
|
|
308
|
+
* * `Single`: Allows selection of only a row or a cell.
|
|
309
|
+
* * `Multiple`: Allows selection of multiple rows or cells.
|
|
310
|
+
* @default Single
|
|
311
|
+
*/
|
|
312
|
+
type?: SelectionType;
|
|
313
313
|
|
|
314
314
|
/**
|
|
315
|
-
* If 'checkboxOnly' set to true, then the Grid selection is allowed only through checkbox.
|
|
316
|
-
*
|
|
317
|
-
* > To enable checkboxOnly selection, should specify the column type as`checkbox`.
|
|
318
|
-
* @default false
|
|
319
|
-
*/
|
|
320
|
-
checkboxOnly?: boolean;
|
|
315
|
+
* If 'checkboxOnly' set to true, then the Grid selection is allowed only through checkbox.
|
|
316
|
+
*
|
|
317
|
+
* > To enable checkboxOnly selection, should specify the column type as`checkbox`.
|
|
318
|
+
* @default false
|
|
319
|
+
*/
|
|
320
|
+
checkboxOnly?: boolean;
|
|
321
321
|
|
|
322
322
|
/**
|
|
323
|
-
* If 'persistSelection' set to true, then the Grid selection is persisted on all operations.
|
|
324
|
-
* For persisting selection in the Grid, any one of the column should be enabled as a primary key.
|
|
325
|
-
* @default false
|
|
326
|
-
*/
|
|
327
|
-
persistSelection?: boolean;
|
|
323
|
+
* If 'persistSelection' set to true, then the Grid selection is persisted on all operations.
|
|
324
|
+
* For persisting selection in the Grid, any one of the column should be enabled as a primary key.
|
|
325
|
+
* @default false
|
|
326
|
+
*/
|
|
327
|
+
persistSelection?: boolean;
|
|
328
328
|
|
|
329
329
|
/**
|
|
330
|
-
* Defines options for checkbox selection Mode. They are
|
|
331
|
-
* * `Default`: This is the default value of the checkboxMode. In this mode, user can select multiple rows by clicking rows one by one.
|
|
332
|
-
* * `ResetOnRowClick`: In ResetOnRowClick mode, on clicking a row it will reset previously selected row and also multiple
|
|
333
|
-
* rows can be selected by using CTRL or SHIFT key.
|
|
334
|
-
* @default Default
|
|
335
|
-
*/
|
|
336
|
-
checkboxMode?: CheckboxSelectionType;
|
|
330
|
+
* Defines options for checkbox selection Mode. They are
|
|
331
|
+
* * `Default`: This is the default value of the checkboxMode. In this mode, user can select multiple rows by clicking rows one by one.
|
|
332
|
+
* * `ResetOnRowClick`: In ResetOnRowClick mode, on clicking a row it will reset previously selected row and also multiple
|
|
333
|
+
* rows can be selected by using CTRL or SHIFT key.
|
|
334
|
+
* @default Default
|
|
335
|
+
*/
|
|
336
|
+
checkboxMode?: CheckboxSelectionType;
|
|
337
337
|
|
|
338
338
|
/**
|
|
339
|
-
* If 'enableSimpleMultiRowSelection' set to true, then the user can able to perform multiple row selection with single clicks.
|
|
340
|
-
* @default false
|
|
341
|
-
*/
|
|
342
|
-
enableSimpleMultiRowSelection?: boolean;
|
|
339
|
+
* If 'enableSimpleMultiRowSelection' set to true, then the user can able to perform multiple row selection with single clicks.
|
|
340
|
+
* @default false
|
|
341
|
+
*/
|
|
342
|
+
enableSimpleMultiRowSelection?: boolean;
|
|
343
343
|
|
|
344
344
|
/**
|
|
345
|
-
* If 'enableToggle' set to true, then the user can able to perform toggle for the selected row.
|
|
346
|
-
* @default true
|
|
347
|
-
*/
|
|
348
|
-
enableToggle?: boolean;
|
|
345
|
+
* If 'enableToggle' set to true, then the user can able to perform toggle for the selected row.
|
|
346
|
+
* @default true
|
|
347
|
+
*/
|
|
348
|
+
enableToggle?: boolean;
|
|
349
349
|
|
|
350
350
|
}
|
|
351
351
|
|
|
@@ -355,66 +355,66 @@ export interface SelectionSettingsModel {
|
|
|
355
355
|
export interface SearchSettingsModel {
|
|
356
356
|
|
|
357
357
|
/**
|
|
358
|
-
* Specifies the collection of fields included in search operation. By default, bounded columns of the Grid are included.
|
|
359
|
-
* @default []
|
|
360
|
-
*/
|
|
361
|
-
fields?: string[];
|
|
362
|
-
|
|
363
|
-
/**
|
|
364
|
-
* Specifies the key value to search Grid records at initial rendering.
|
|
365
|
-
* You can also get the current search key.
|
|
366
|
-
* @default ''
|
|
367
|
-
*/
|
|
368
|
-
key?: string;
|
|
369
|
-
|
|
370
|
-
/**
|
|
371
|
-
* Defines the operator to search records. The available operators are:
|
|
372
|
-
* <table>
|
|
373
|
-
* <tr>
|
|
374
|
-
* <td colspan=1 rowspan=1>
|
|
375
|
-
* Operator<br/></td><td colspan=1 rowspan=1>
|
|
376
|
-
* Description<br/></td></tr>
|
|
377
|
-
* <tr>
|
|
378
|
-
* <td colspan=1 rowspan=1>
|
|
379
|
-
* startswith<br/></td><td colspan=1 rowspan=1>
|
|
380
|
-
* Checks whether the string begins with the specified string.<br/></td></tr>
|
|
381
|
-
* <tr>
|
|
382
|
-
* <td colspan=1 rowspan=1>
|
|
383
|
-
* endswith<br/></td><td colspan=1 rowspan=1>
|
|
384
|
-
* Checks whether the string ends with the specified string.<br/></td></tr>
|
|
385
|
-
* <tr>
|
|
386
|
-
* <td colspan=1 rowspan=1>
|
|
387
|
-
* contains<br/></td><td colspan=1 rowspan=1>
|
|
388
|
-
* Checks whether the string contains the specified string. <br/></td></tr>
|
|
389
|
-
* <tr>
|
|
390
|
-
* <td colspan=1 rowspan=1>
|
|
391
|
-
* equal<br/></td><td colspan=1 rowspan=1>
|
|
392
|
-
* Checks whether the string is equal to the specified string.<br/></td></tr>
|
|
393
|
-
* <tr>
|
|
394
|
-
* <td colspan=1 rowspan=1>
|
|
395
|
-
* notequal<br/></td><td colspan=1 rowspan=1>
|
|
396
|
-
* Checks for strings not equal to the specified string. <br/></td></tr>
|
|
397
|
-
* </table>
|
|
398
|
-
* @default 'contains'
|
|
399
|
-
* @blazorType Syncfusion.Blazor.Operator
|
|
400
|
-
* @blazorDefaultValue Syncfusion.Blazor.Operator.Contains
|
|
401
|
-
*/
|
|
402
|
-
operator?: string;
|
|
403
|
-
|
|
404
|
-
/**
|
|
405
|
-
* If `ignoreCase` is set to false, searches records that match exactly, else
|
|
406
|
-
* searches records that are case insensitive(uppercase and lowercase letters treated the same).
|
|
407
|
-
* @default true
|
|
408
|
-
*/
|
|
409
|
-
ignoreCase?: boolean;
|
|
410
|
-
|
|
411
|
-
/**
|
|
412
|
-
* If ignoreAccent set to true, then filter ignores the diacritic characters or accents while filtering.
|
|
413
|
-
*
|
|
414
|
-
* > Check the [`Diacritics`](../../grid/filtering/#diacritics/) filtering.
|
|
415
|
-
* @default false
|
|
416
|
-
*/
|
|
417
|
-
ignoreAccent?: boolean;
|
|
358
|
+
* Specifies the collection of fields included in search operation. By default, bounded columns of the Grid are included.
|
|
359
|
+
* @default []
|
|
360
|
+
*/
|
|
361
|
+
fields?: string[];
|
|
362
|
+
|
|
363
|
+
/**
|
|
364
|
+
* Specifies the key value to search Grid records at initial rendering.
|
|
365
|
+
* You can also get the current search key.
|
|
366
|
+
* @default ''
|
|
367
|
+
*/
|
|
368
|
+
key?: string;
|
|
369
|
+
|
|
370
|
+
/**
|
|
371
|
+
* Defines the operator to search records. The available operators are:
|
|
372
|
+
* <table>
|
|
373
|
+
* <tr>
|
|
374
|
+
* <td colspan=1 rowspan=1>
|
|
375
|
+
* Operator<br/></td><td colspan=1 rowspan=1>
|
|
376
|
+
* Description<br/></td></tr>
|
|
377
|
+
* <tr>
|
|
378
|
+
* <td colspan=1 rowspan=1>
|
|
379
|
+
* startswith<br/></td><td colspan=1 rowspan=1>
|
|
380
|
+
* Checks whether the string begins with the specified string.<br/></td></tr>
|
|
381
|
+
* <tr>
|
|
382
|
+
* <td colspan=1 rowspan=1>
|
|
383
|
+
* endswith<br/></td><td colspan=1 rowspan=1>
|
|
384
|
+
* Checks whether the string ends with the specified string.<br/></td></tr>
|
|
385
|
+
* <tr>
|
|
386
|
+
* <td colspan=1 rowspan=1>
|
|
387
|
+
* contains<br/></td><td colspan=1 rowspan=1>
|
|
388
|
+
* Checks whether the string contains the specified string. <br/></td></tr>
|
|
389
|
+
* <tr>
|
|
390
|
+
* <td colspan=1 rowspan=1>
|
|
391
|
+
* equal<br/></td><td colspan=1 rowspan=1>
|
|
392
|
+
* Checks whether the string is equal to the specified string.<br/></td></tr>
|
|
393
|
+
* <tr>
|
|
394
|
+
* <td colspan=1 rowspan=1>
|
|
395
|
+
* notequal<br/></td><td colspan=1 rowspan=1>
|
|
396
|
+
* Checks for strings not equal to the specified string. <br/></td></tr>
|
|
397
|
+
* </table>
|
|
398
|
+
* @default 'contains'
|
|
399
|
+
* @blazorType Syncfusion.Blazor.Operator
|
|
400
|
+
* @blazorDefaultValue Syncfusion.Blazor.Operator.Contains
|
|
401
|
+
*/
|
|
402
|
+
operator?: string;
|
|
403
|
+
|
|
404
|
+
/**
|
|
405
|
+
* If `ignoreCase` is set to false, searches records that match exactly, else
|
|
406
|
+
* searches records that are case insensitive(uppercase and lowercase letters treated the same).
|
|
407
|
+
* @default true
|
|
408
|
+
*/
|
|
409
|
+
ignoreCase?: boolean;
|
|
410
|
+
|
|
411
|
+
/**
|
|
412
|
+
* If ignoreAccent set to true, then filter ignores the diacritic characters or accents while filtering.
|
|
413
|
+
*
|
|
414
|
+
* > Check the [`Diacritics`](../../grid/filtering/#diacritics/) filtering.
|
|
415
|
+
* @default false
|
|
416
|
+
*/
|
|
417
|
+
ignoreAccent?: boolean;
|
|
418
418
|
|
|
419
419
|
}
|
|
420
420
|
|
|
@@ -424,10 +424,10 @@ export interface SearchSettingsModel {
|
|
|
424
424
|
export interface RowDropSettingsModel {
|
|
425
425
|
|
|
426
426
|
/**
|
|
427
|
-
* Defines the ID of droppable component on which row drop should occur.
|
|
428
|
-
* @default null
|
|
429
|
-
*/
|
|
430
|
-
targetID?: string;
|
|
427
|
+
* Defines the ID of droppable component on which row drop should occur.
|
|
428
|
+
* @default null
|
|
429
|
+
*/
|
|
430
|
+
targetID?: string;
|
|
431
431
|
|
|
432
432
|
}
|
|
433
433
|
|
|
@@ -437,13 +437,13 @@ export interface RowDropSettingsModel {
|
|
|
437
437
|
export interface TextWrapSettingsModel {
|
|
438
438
|
|
|
439
439
|
/**
|
|
440
|
-
* Defines the `wrapMode` of the Grid. The available modes are:
|
|
441
|
-
* * `Both`: Wraps both the header and content.
|
|
442
|
-
* * `Content`: Wraps the header alone.
|
|
443
|
-
* * `Header`: Wraps the content alone.
|
|
444
|
-
* @default Both
|
|
445
|
-
*/
|
|
446
|
-
wrapMode?: WrapMode;
|
|
440
|
+
* Defines the `wrapMode` of the Grid. The available modes are:
|
|
441
|
+
* * `Both`: Wraps both the header and content.
|
|
442
|
+
* * `Content`: Wraps the header alone.
|
|
443
|
+
* * `Header`: Wraps the content alone.
|
|
444
|
+
* @default Both
|
|
445
|
+
*/
|
|
446
|
+
wrapMode?: WrapMode;
|
|
447
447
|
|
|
448
448
|
}
|
|
449
449
|
|
|
@@ -453,12 +453,12 @@ export interface TextWrapSettingsModel {
|
|
|
453
453
|
export interface ResizeSettingsModel {
|
|
454
454
|
|
|
455
455
|
/**
|
|
456
|
-
* Defines the mode of Grid column resizing. The available modes are:
|
|
457
|
-
* `Normal`: Columns will not be adjusted to fit the remaining space.
|
|
458
|
-
* `Auto`: Resized column width will be adjusted by other columns automatically.
|
|
459
|
-
* @default Normal
|
|
460
|
-
*/
|
|
461
|
-
mode?: ResizeMode;
|
|
456
|
+
* Defines the mode of Grid column resizing. The available modes are:
|
|
457
|
+
* `Normal`: Columns will not be adjusted to fit the remaining space.
|
|
458
|
+
* `Auto`: Resized column width will be adjusted by other columns automatically.
|
|
459
|
+
* @default Normal
|
|
460
|
+
*/
|
|
461
|
+
mode?: ResizeMode;
|
|
462
462
|
|
|
463
463
|
}
|
|
464
464
|
|
|
@@ -468,66 +468,66 @@ export interface ResizeSettingsModel {
|
|
|
468
468
|
export interface GroupSettingsModel {
|
|
469
469
|
|
|
470
470
|
/**
|
|
471
|
-
* If `showDropArea` is set to true, the group drop area element will be visible at the top of the Grid.
|
|
472
|
-
* @default true
|
|
473
|
-
*/
|
|
474
|
-
showDropArea?: boolean;
|
|
471
|
+
* If `showDropArea` is set to true, the group drop area element will be visible at the top of the Grid.
|
|
472
|
+
* @default true
|
|
473
|
+
*/
|
|
474
|
+
showDropArea?: boolean;
|
|
475
475
|
|
|
476
476
|
/**
|
|
477
|
-
* If `allowReordering` is set to true, Grid allows the grouped elements to be reordered.
|
|
478
|
-
* @default false
|
|
479
|
-
*/
|
|
480
|
-
allowReordering?: boolean;
|
|
477
|
+
* If `allowReordering` is set to true, Grid allows the grouped elements to be reordered.
|
|
478
|
+
* @default false
|
|
479
|
+
*/
|
|
480
|
+
allowReordering?: boolean;
|
|
481
481
|
|
|
482
482
|
/**
|
|
483
|
-
* If `showToggleButton` set to true, then the toggle button will be showed in the column headers which can be used to group
|
|
484
|
-
* or ungroup columns by clicking them.
|
|
485
|
-
* @default false
|
|
486
|
-
*/
|
|
487
|
-
showToggleButton?: boolean;
|
|
483
|
+
* If `showToggleButton` set to true, then the toggle button will be showed in the column headers which can be used to group
|
|
484
|
+
* or ungroup columns by clicking them.
|
|
485
|
+
* @default false
|
|
486
|
+
*/
|
|
487
|
+
showToggleButton?: boolean;
|
|
488
488
|
|
|
489
489
|
/**
|
|
490
|
-
* If `showGroupedColumn` is set to false, it hides the grouped column after grouping.
|
|
491
|
-
* @default false
|
|
492
|
-
*/
|
|
493
|
-
showGroupedColumn?: boolean;
|
|
490
|
+
* If `showGroupedColumn` is set to false, it hides the grouped column after grouping.
|
|
491
|
+
* @default false
|
|
492
|
+
*/
|
|
493
|
+
showGroupedColumn?: boolean;
|
|
494
494
|
|
|
495
495
|
/**
|
|
496
|
-
* If `showUngroupButton` set to false, then ungroup button is hidden in dropped element.
|
|
497
|
-
* It can be used to ungroup the grouped column when click on ungroup button.
|
|
498
|
-
* @default true
|
|
499
|
-
*/
|
|
500
|
-
showUngroupButton?: boolean;
|
|
496
|
+
* If `showUngroupButton` set to false, then ungroup button is hidden in dropped element.
|
|
497
|
+
* It can be used to ungroup the grouped column when click on ungroup button.
|
|
498
|
+
* @default true
|
|
499
|
+
*/
|
|
500
|
+
showUngroupButton?: boolean;
|
|
501
501
|
|
|
502
502
|
/**
|
|
503
|
-
* If `disablePageWiseAggregates` set to true, then the group aggregate value will
|
|
504
|
-
* be calculated from the whole data instead of paged data and two requests will be made for each page
|
|
505
|
-
* when Grid bound with remote service.
|
|
506
|
-
* @default false
|
|
507
|
-
*/
|
|
508
|
-
disablePageWiseAggregates?: boolean;
|
|
503
|
+
* If `disablePageWiseAggregates` set to true, then the group aggregate value will
|
|
504
|
+
* be calculated from the whole data instead of paged data and two requests will be made for each page
|
|
505
|
+
* when Grid bound with remote service.
|
|
506
|
+
* @default false
|
|
507
|
+
*/
|
|
508
|
+
disablePageWiseAggregates?: boolean;
|
|
509
509
|
|
|
510
510
|
/**
|
|
511
|
-
* Specifies the column names to group at initial rendering of the Grid.
|
|
512
|
-
* You can also get the currently grouped columns.
|
|
513
|
-
* @default []
|
|
514
|
-
*/
|
|
515
|
-
columns?: string[];
|
|
511
|
+
* Specifies the column names to group at initial rendering of the Grid.
|
|
512
|
+
* You can also get the currently grouped columns.
|
|
513
|
+
* @default []
|
|
514
|
+
*/
|
|
515
|
+
columns?: string[];
|
|
516
516
|
|
|
517
517
|
/**
|
|
518
|
-
* The Caption Template allows user to display the string or HTML element in group caption.
|
|
519
|
-
* > It accepts either the
|
|
520
|
-
* [template string](
|
|
521
|
-
* @default ''
|
|
522
|
-
*/
|
|
523
|
-
captionTemplate?: string;
|
|
518
|
+
* The Caption Template allows user to display the string or HTML element in group caption.
|
|
519
|
+
* > It accepts either the
|
|
520
|
+
* [template string](https://ej2.syncfusion.com/documentation/common/template-engine/) or the HTML element ID.
|
|
521
|
+
* @default ''
|
|
522
|
+
*/
|
|
523
|
+
captionTemplate?: string;
|
|
524
524
|
|
|
525
525
|
/**
|
|
526
|
-
* The Lazy load grouping, allows the Grid to render only the initial level caption rows in collapsed state while grouping.
|
|
527
|
-
* The child rows of each caption will render only when we expand the captions.
|
|
528
|
-
* @default false
|
|
529
|
-
*/
|
|
530
|
-
enableLazyLoading?: boolean;
|
|
526
|
+
* The Lazy load grouping, allows the Grid to render only the initial level caption rows in collapsed state while grouping.
|
|
527
|
+
* The child rows of each caption will render only when we expand the captions.
|
|
528
|
+
* @default false
|
|
529
|
+
*/
|
|
530
|
+
enableLazyLoading?: boolean;
|
|
531
531
|
|
|
532
532
|
}
|
|
533
533
|
|
|
@@ -537,90 +537,90 @@ export interface GroupSettingsModel {
|
|
|
537
537
|
export interface EditSettingsModel {
|
|
538
538
|
|
|
539
539
|
/**
|
|
540
|
-
* If `allowAdding` is set to true, new records can be added to the Grid.
|
|
541
|
-
* @default false
|
|
542
|
-
*/
|
|
543
|
-
allowAdding?: boolean;
|
|
540
|
+
* If `allowAdding` is set to true, new records can be added to the Grid.
|
|
541
|
+
* @default false
|
|
542
|
+
*/
|
|
543
|
+
allowAdding?: boolean;
|
|
544
544
|
|
|
545
545
|
/**
|
|
546
|
-
* If `allowEditing` is set to true, values can be updated in the existing record.
|
|
547
|
-
* @default false
|
|
548
|
-
*/
|
|
549
|
-
allowEditing?: boolean;
|
|
546
|
+
* If `allowEditing` is set to true, values can be updated in the existing record.
|
|
547
|
+
* @default false
|
|
548
|
+
*/
|
|
549
|
+
allowEditing?: boolean;
|
|
550
550
|
|
|
551
551
|
/**
|
|
552
|
-
* If `allowDeleting` is set to true, existing record can be deleted from the Grid.
|
|
553
|
-
* @default false
|
|
554
|
-
*/
|
|
555
|
-
allowDeleting?: boolean;
|
|
552
|
+
* If `allowDeleting` is set to true, existing record can be deleted from the Grid.
|
|
553
|
+
* @default false
|
|
554
|
+
*/
|
|
555
|
+
allowDeleting?: boolean;
|
|
556
556
|
|
|
557
557
|
/**
|
|
558
|
-
* Defines the mode to edit. The available editing modes are:
|
|
559
|
-
* * Normal
|
|
560
|
-
* * Dialog
|
|
561
|
-
* * Batch
|
|
562
|
-
* @default Normal
|
|
563
|
-
*/
|
|
564
|
-
mode?: EditMode;
|
|
558
|
+
* Defines the mode to edit. The available editing modes are:
|
|
559
|
+
* * Normal
|
|
560
|
+
* * Dialog
|
|
561
|
+
* * Batch
|
|
562
|
+
* @default Normal
|
|
563
|
+
*/
|
|
564
|
+
mode?: EditMode;
|
|
565
565
|
|
|
566
566
|
/**
|
|
567
|
-
* If `allowEditOnDblClick` is set to false, Grid will not allow editing of a record on double click.
|
|
568
|
-
* @default true
|
|
569
|
-
*/
|
|
570
|
-
allowEditOnDblClick?: boolean;
|
|
567
|
+
* If `allowEditOnDblClick` is set to false, Grid will not allow editing of a record on double click.
|
|
568
|
+
* @default true
|
|
569
|
+
*/
|
|
570
|
+
allowEditOnDblClick?: boolean;
|
|
571
571
|
|
|
572
572
|
/**
|
|
573
|
-
* if `showConfirmDialog` is set to false, confirm dialog does not show when batch changes are saved or discarded.
|
|
574
|
-
* @default true
|
|
575
|
-
*/
|
|
576
|
-
showConfirmDialog?: boolean;
|
|
573
|
+
* if `showConfirmDialog` is set to false, confirm dialog does not show when batch changes are saved or discarded.
|
|
574
|
+
* @default true
|
|
575
|
+
*/
|
|
576
|
+
showConfirmDialog?: boolean;
|
|
577
577
|
|
|
578
578
|
/**
|
|
579
|
-
* If `showDeleteConfirmDialog` is set to true, confirm dialog will show delete action. You can also cancel delete command.
|
|
580
|
-
* @default false
|
|
581
|
-
*/
|
|
582
|
-
showDeleteConfirmDialog?: boolean;
|
|
579
|
+
* If `showDeleteConfirmDialog` is set to true, confirm dialog will show delete action. You can also cancel delete command.
|
|
580
|
+
* @default false
|
|
581
|
+
*/
|
|
582
|
+
showDeleteConfirmDialog?: boolean;
|
|
583
583
|
|
|
584
584
|
/**
|
|
585
|
-
* Defines the custom edit elements for the dialog template.
|
|
586
|
-
* @default ''
|
|
587
|
-
* @aspType string
|
|
588
|
-
*/
|
|
589
|
-
template?: string | Object;
|
|
585
|
+
* Defines the custom edit elements for the dialog template.
|
|
586
|
+
* @default ''
|
|
587
|
+
* @aspType string
|
|
588
|
+
*/
|
|
589
|
+
template?: string | Object;
|
|
590
590
|
|
|
591
591
|
/**
|
|
592
|
-
* Defines the custom edit elements for the dialog header template.
|
|
593
|
-
* @default ''
|
|
594
|
-
* @aspType string
|
|
595
|
-
*/
|
|
596
|
-
headerTemplate?: string | Object;
|
|
592
|
+
* Defines the custom edit elements for the dialog header template.
|
|
593
|
+
* @default ''
|
|
594
|
+
* @aspType string
|
|
595
|
+
*/
|
|
596
|
+
headerTemplate?: string | Object;
|
|
597
597
|
|
|
598
598
|
/**
|
|
599
|
-
* Defines the custom edit elements for the dialog footer template.
|
|
600
|
-
* @default ''
|
|
601
|
-
* @aspType string
|
|
602
|
-
*/
|
|
603
|
-
footerTemplate?: string | Object;
|
|
599
|
+
* Defines the custom edit elements for the dialog footer template.
|
|
600
|
+
* @default ''
|
|
601
|
+
* @aspType string
|
|
602
|
+
*/
|
|
603
|
+
footerTemplate?: string | Object;
|
|
604
604
|
|
|
605
605
|
/**
|
|
606
|
-
* Defines the position of adding a new row. The available position are:
|
|
607
|
-
* * Top
|
|
608
|
-
* * Bottom
|
|
609
|
-
* @default Top
|
|
610
|
-
*/
|
|
611
|
-
newRowPosition?: NewRowPosition;
|
|
606
|
+
* Defines the position of adding a new row. The available position are:
|
|
607
|
+
* * Top
|
|
608
|
+
* * Bottom
|
|
609
|
+
* @default Top
|
|
610
|
+
*/
|
|
611
|
+
newRowPosition?: NewRowPosition;
|
|
612
612
|
|
|
613
613
|
/**
|
|
614
|
-
* Defines the dialog params to edit.
|
|
615
|
-
* @default {}
|
|
616
|
-
*/
|
|
617
|
-
dialog?: IDialogUI;
|
|
614
|
+
* Defines the dialog params to edit.
|
|
615
|
+
* @default {}
|
|
616
|
+
*/
|
|
617
|
+
dialog?: IDialogUI;
|
|
618
618
|
|
|
619
619
|
/**
|
|
620
|
-
* If allowNextRowEdit is set to true, editing is done to next row. By default allowNextRowEdit is set to false.
|
|
621
|
-
* @default false
|
|
622
|
-
*/
|
|
623
|
-
allowNextRowEdit?: boolean;
|
|
620
|
+
* If allowNextRowEdit is set to true, editing is done to next row. By default allowNextRowEdit is set to false.
|
|
621
|
+
* @default false
|
|
622
|
+
*/
|
|
623
|
+
allowNextRowEdit?: boolean;
|
|
624
624
|
|
|
625
625
|
}
|
|
626
626
|
|
|
@@ -630,1064 +630,1063 @@ export interface EditSettingsModel {
|
|
|
630
630
|
export interface GridModel extends ComponentModel{
|
|
631
631
|
|
|
632
632
|
/**
|
|
633
|
-
* Gets the parent Grid details.
|
|
634
|
-
|
|
635
|
-
*/
|
|
636
|
-
parentDetails?: ParentDetails;
|
|
637
|
-
|
|
638
|
-
/**
|
|
639
|
-
* Defines the schema of dataSource.
|
|
640
|
-
* If the `columns` declaration is empty or undefined then the `columns` are automatically generated from data source.
|
|
641
|
-
* {% codeBlock src='grid/columns/index.md' %}{% endcodeBlock %}
|
|
642
|
-
* @default []
|
|
643
|
-
*/
|
|
644
|
-
columns?: Column[] | string[] | ColumnModel[];
|
|
633
|
+
* Gets the parent Grid details.
|
|
634
|
+
* @deprecated
|
|
635
|
+
*/
|
|
636
|
+
parentDetails?: ParentDetails;
|
|
645
637
|
|
|
646
638
|
/**
|
|
647
|
-
*
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
* @default
|
|
651
|
-
*/
|
|
652
|
-
|
|
639
|
+
* Defines the schema of dataSource.
|
|
640
|
+
* If the `columns` declaration is empty or undefined then the `columns` are automatically generated from data source.
|
|
641
|
+
* {% codeBlock src='grid/columns/index.md' %}{% endcodeBlock %}
|
|
642
|
+
* @default []
|
|
643
|
+
*/
|
|
644
|
+
columns?: Column[] | string[] | ColumnModel[];
|
|
653
645
|
|
|
654
646
|
/**
|
|
655
|
-
* If `
|
|
656
|
-
*
|
|
657
|
-
|
|
658
|
-
|
|
659
|
-
|
|
647
|
+
* If `enableAltRow` is set to true, the grid will render with `e-altrow` CSS class to the alternative tr elements.
|
|
648
|
+
* > Check the [`AltRow`](../../grid/row/#styling-alternate-rows/) to customize the styles of alternative rows.
|
|
649
|
+
* {% codeBlock src='grid/enableAltRow/index.md' %}{% endcodeBlock %}
|
|
650
|
+
* @default true
|
|
651
|
+
*/
|
|
652
|
+
enableAltRow?: boolean;
|
|
660
653
|
|
|
661
654
|
/**
|
|
662
|
-
* If `
|
|
663
|
-
*
|
|
664
|
-
|
|
665
|
-
|
|
666
|
-
|
|
667
|
-
enableAutoFill?: boolean;
|
|
655
|
+
* If `enableHover` is set to true, the row hover is enabled in the Grid.
|
|
656
|
+
* {% codeBlock src='grid/enableHover/index.md' %}{% endcodeBlock %}
|
|
657
|
+
* @default true
|
|
658
|
+
*/
|
|
659
|
+
enableHover?: boolean;
|
|
668
660
|
|
|
669
661
|
/**
|
|
670
|
-
*
|
|
671
|
-
*
|
|
672
|
-
*
|
|
673
|
-
|
|
674
|
-
|
|
662
|
+
* If `enableAutoFill` is set to true, then the auto fill icon will displayed on cell selection for copy cells.
|
|
663
|
+
* It requires the selection `mode` to be Cell and `cellSelectionMode` to be `Box`.
|
|
664
|
+
* {% codeBlock src='grid/enableAutoFill/index.md' %}{% endcodeBlock %}
|
|
665
|
+
* @default false
|
|
666
|
+
*/
|
|
667
|
+
enableAutoFill?: boolean;
|
|
675
668
|
|
|
676
669
|
/**
|
|
677
|
-
|
|
678
|
-
*
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
*/
|
|
682
|
-
allowTextWrap?: boolean;
|
|
670
|
+
* Enables or disables the key board interaction of Grid.
|
|
671
|
+
* @default true
|
|
672
|
+
*/
|
|
673
|
+
allowKeyboard?: boolean;
|
|
683
674
|
|
|
684
675
|
/**
|
|
685
|
-
*
|
|
686
|
-
*
|
|
687
|
-
*
|
|
688
|
-
|
|
689
|
-
|
|
676
|
+
* If `allowTextWrap` set to true,
|
|
677
|
+
* then text content will wrap to the next line when its text content exceeds the width of the Column Cells.
|
|
678
|
+
* {% codeBlock src='grid/allowTextWrap/index.md' %}{% endcodeBlock %}
|
|
679
|
+
* @default false
|
|
680
|
+
*/
|
|
681
|
+
allowTextWrap?: boolean;
|
|
690
682
|
|
|
691
683
|
/**
|
|
692
|
-
*
|
|
693
|
-
*
|
|
694
|
-
|
|
695
|
-
|
|
684
|
+
* Configures the text wrap in the Grid.
|
|
685
|
+
* {% codeBlock src='grid/textWrapSettings/index.md' %}{% endcodeBlock %}
|
|
686
|
+
* @default {wrapMode:"Both"}
|
|
687
|
+
*/
|
|
688
|
+
textWrapSettings?: TextWrapSettingsModel;
|
|
696
689
|
|
|
697
690
|
/**
|
|
698
|
-
|
|
699
|
-
*
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
* @default false
|
|
703
|
-
*/
|
|
704
|
-
allowPaging?: boolean;
|
|
691
|
+
* Defines the resizing behavior of the Grid.
|
|
692
|
+
* @default {mode:"Normal"}
|
|
693
|
+
*/
|
|
694
|
+
resizeSettings?: ResizeSettingsModel;
|
|
705
695
|
|
|
706
696
|
/**
|
|
707
|
-
|
|
708
|
-
*
|
|
709
|
-
*
|
|
710
|
-
|
|
711
|
-
|
|
697
|
+
* If `allowPaging` is set to true, the pager renders at the footer of the Grid. It is used to handle page navigation in the Grid.
|
|
698
|
+
*
|
|
699
|
+
* > Check the [`Paging`](../../grid/paging/) to configure the grid pager.
|
|
700
|
+
* {% codeBlock src='grid/allowPaging/index.md' %}{% endcodeBlock %}
|
|
701
|
+
* @default false
|
|
702
|
+
*/
|
|
703
|
+
allowPaging?: boolean;
|
|
712
704
|
|
|
713
705
|
/**
|
|
714
|
-
*
|
|
715
|
-
*
|
|
716
|
-
* {
|
|
717
|
-
|
|
718
|
-
|
|
719
|
-
enableVirtualization?: boolean;
|
|
706
|
+
* Configures the pager in the Grid.
|
|
707
|
+
* {% codeBlock src='grid/pageSettings/index.md' %}{% endcodeBlock %}
|
|
708
|
+
* @default {currentPage: 1, pageSize: 12, pageCount: 8, enableQueryString: false, pageSizes: false, template: null}
|
|
709
|
+
*/
|
|
710
|
+
pageSettings?: PageSettingsModel;
|
|
720
711
|
|
|
721
712
|
/**
|
|
722
|
-
* If `
|
|
723
|
-
* and load subsequent
|
|
724
|
-
* {% codeBlock src='grid/
|
|
725
|
-
* @default false
|
|
726
|
-
*/
|
|
727
|
-
|
|
713
|
+
* If `enableVirtualization` set to true, then the Grid will render only the rows visible within the view-port
|
|
714
|
+
* and load subsequent rows on vertical scrolling. This helps to load large dataset in Grid.
|
|
715
|
+
* {% codeBlock src='grid/enableVirtualization/index.md' %}{% endcodeBlock %}
|
|
716
|
+
* @default false
|
|
717
|
+
*/
|
|
718
|
+
enableVirtualization?: boolean;
|
|
728
719
|
|
|
729
720
|
/**
|
|
730
|
-
* If `
|
|
731
|
-
* This helps to load large dataset in Grid.
|
|
732
|
-
* {% codeBlock src='grid/
|
|
733
|
-
* @default false
|
|
734
|
-
|
|
735
|
-
|
|
736
|
-
enableInfiniteScrolling?: boolean;
|
|
721
|
+
* If `enableColumnVirtualization` set to true, then the Grid will render only the columns visible within the view-port
|
|
722
|
+
* and load subsequent columns on horizontal scrolling. This helps to load large dataset of columns in Grid.
|
|
723
|
+
* {% codeBlock src='grid/enableColumnVirtualization/index.md' %}{% endcodeBlock %}
|
|
724
|
+
* @default false
|
|
725
|
+
*/
|
|
726
|
+
enableColumnVirtualization?: boolean;
|
|
737
727
|
|
|
738
728
|
/**
|
|
739
|
-
*
|
|
740
|
-
*
|
|
741
|
-
*
|
|
742
|
-
|
|
743
|
-
|
|
729
|
+
* If `enableInfiniteScrolling` set to true, then the data will be loaded in Grid when the scrollbar reaches the end.
|
|
730
|
+
* This helps to load large dataset in Grid.
|
|
731
|
+
* {% codeBlock src='grid/enableInfiniteScrolling/index.md' %}{% endcodeBlock %}
|
|
732
|
+
* @default false
|
|
733
|
+
* @deprecated
|
|
734
|
+
*/
|
|
735
|
+
enableInfiniteScrolling?: boolean;
|
|
744
736
|
|
|
745
737
|
/**
|
|
746
|
-
*
|
|
747
|
-
*
|
|
748
|
-
*
|
|
749
|
-
|
|
750
|
-
|
|
751
|
-
*/
|
|
752
|
-
allowSorting?: boolean;
|
|
738
|
+
* Configures the search behavior in the Grid.
|
|
739
|
+
* {% codeBlock src='grid/searchSettings/index.md' %}{% endcodeBlock %}
|
|
740
|
+
* @default { ignoreCase: true, fields: [], operator: 'contains', key: '' }
|
|
741
|
+
*/
|
|
742
|
+
searchSettings?: SearchSettingsModel;
|
|
753
743
|
|
|
754
744
|
/**
|
|
755
|
-
*
|
|
756
|
-
*
|
|
757
|
-
*
|
|
758
|
-
*
|
|
759
|
-
*
|
|
760
|
-
|
|
761
|
-
|
|
762
|
-
*/
|
|
763
|
-
clipMode?: ClipMode;
|
|
745
|
+
* If `allowSorting` is set to true, it allows sorting of grid records when column header is clicked.
|
|
746
|
+
*
|
|
747
|
+
* > Check the [`Sorting`](../../grid/sorting/) to customize its default behavior.
|
|
748
|
+
* {% codeBlock src='grid/allowSorting/index.md' %}{% endcodeBlock %}
|
|
749
|
+
* @default false
|
|
750
|
+
*/
|
|
751
|
+
allowSorting?: boolean;
|
|
764
752
|
|
|
765
753
|
/**
|
|
766
|
-
*
|
|
767
|
-
*
|
|
768
|
-
*
|
|
769
|
-
*
|
|
770
|
-
|
|
771
|
-
|
|
754
|
+
* Defines the mode of clip. The available modes are,
|
|
755
|
+
* `Clip`: Truncates the cell content when it overflows its area.
|
|
756
|
+
* `Ellipsis`: Displays ellipsis when the cell content overflows its area.
|
|
757
|
+
* `EllipsisWithTooltip`: Displays ellipsis when the cell content overflows its area,
|
|
758
|
+
* also it will display the tooltip while hover on ellipsis is applied..
|
|
759
|
+
* {% codeBlock src='grid/clipMode/index.md' %}{% endcodeBlock %}
|
|
760
|
+
* @default Ellipsis
|
|
761
|
+
*/
|
|
762
|
+
clipMode?: ClipMode;
|
|
772
763
|
|
|
773
764
|
/**
|
|
774
|
-
* If `
|
|
775
|
-
*
|
|
776
|
-
*
|
|
777
|
-
*
|
|
778
|
-
|
|
779
|
-
|
|
780
|
-
allowExcelExport?: boolean;
|
|
765
|
+
* If `allowMultiSorting` set to true, then it will allow the user to sort multiple column in the grid.
|
|
766
|
+
* > `allowSorting` should be true.
|
|
767
|
+
* {% codeBlock src='grid/allowMultiSorting/index.md' %}{% endcodeBlock %}
|
|
768
|
+
* @default false
|
|
769
|
+
*/
|
|
770
|
+
allowMultiSorting?: boolean;
|
|
781
771
|
|
|
782
772
|
/**
|
|
783
|
-
* If `
|
|
784
|
-
*
|
|
785
|
-
* > Check the [`
|
|
786
|
-
* {% codeBlock src='grid/
|
|
787
|
-
* @default false
|
|
788
|
-
*/
|
|
789
|
-
|
|
773
|
+
* If `allowExcelExport` set to true, then it will allow the user to export grid to Excel file.
|
|
774
|
+
*
|
|
775
|
+
* > Check the [`ExcelExport`](../../grid/excel-exporting/) to configure exporting document.
|
|
776
|
+
* {% codeBlock src='grid/allowExcelExport/index.md' %}{% endcodeBlock %}
|
|
777
|
+
* @default false
|
|
778
|
+
*/
|
|
779
|
+
allowExcelExport?: boolean;
|
|
790
780
|
|
|
791
781
|
/**
|
|
792
|
-
*
|
|
793
|
-
*
|
|
794
|
-
*
|
|
795
|
-
|
|
796
|
-
|
|
782
|
+
* If `allowPdfExport` set to true, then it will allow the user to export grid to Pdf file.
|
|
783
|
+
*
|
|
784
|
+
* > Check the [`Pdfexport`](../../grid/pdf-export/) to configure the exporting document.
|
|
785
|
+
* {% codeBlock src='grid/allowPdfExport/index.md' %}{% endcodeBlock %}
|
|
786
|
+
* @default false
|
|
787
|
+
*/
|
|
788
|
+
allowPdfExport?: boolean;
|
|
797
789
|
|
|
798
790
|
/**
|
|
799
|
-
* Configures the
|
|
800
|
-
* {% codeBlock src='grid/
|
|
801
|
-
* @default {
|
|
802
|
-
|
|
803
|
-
|
|
804
|
-
|
|
791
|
+
* Configures the sort settings.
|
|
792
|
+
* {% codeBlock src='grid/sortSettings/index.md' %}{% endcodeBlock %}
|
|
793
|
+
* @default {columns:[]}
|
|
794
|
+
*/
|
|
795
|
+
sortSettings?: SortSettingsModel;
|
|
796
|
+
|
|
797
|
+
/**
|
|
798
|
+
* Configures the infinite scroll settings.
|
|
799
|
+
* {% codeBlock src='grid/infiniteScrollSettings/index.md' %}{% endcodeBlock %}
|
|
800
|
+
* @default { enableCache: false, maxBlocks: 5, initialBlocks: 5 }
|
|
801
|
+
* @deprecated
|
|
802
|
+
*/
|
|
803
|
+
infiniteScrollSettings?: InfiniteScrollSettingsModel;
|
|
805
804
|
|
|
806
|
-
/**
|
|
807
|
-
* If `allowSelection` is set to true, it allows selection of (highlight row) Grid records by clicking it.
|
|
808
|
-
* {% codeBlock src='grid/allowSelection/index.md' %}{% endcodeBlock %}
|
|
809
|
-
* @default true
|
|
810
|
-
*/
|
|
811
|
-
allowSelection?: boolean;
|
|
805
|
+
/**
|
|
806
|
+
* If `allowSelection` is set to true, it allows selection of (highlight row) Grid records by clicking it.
|
|
807
|
+
* {% codeBlock src='grid/allowSelection/index.md' %}{% endcodeBlock %}
|
|
808
|
+
* @default true
|
|
809
|
+
*/
|
|
810
|
+
allowSelection?: boolean;
|
|
812
811
|
|
|
813
|
-
/**
|
|
814
|
-
* The `selectedRowIndex` allows you to select a row at initial rendering.
|
|
815
|
-
* You can also get the currently selected row index.
|
|
816
|
-
* {% codeBlock src='grid/selectedRowIndex/index.md' %}{% endcodeBlock %}
|
|
817
|
-
* @default -1
|
|
818
|
-
*/
|
|
819
|
-
selectedRowIndex?: number;
|
|
812
|
+
/**
|
|
813
|
+
* The `selectedRowIndex` allows you to select a row at initial rendering.
|
|
814
|
+
* You can also get the currently selected row index.
|
|
815
|
+
* {% codeBlock src='grid/selectedRowIndex/index.md' %}{% endcodeBlock %}
|
|
816
|
+
* @default -1
|
|
817
|
+
*/
|
|
818
|
+
selectedRowIndex?: number;
|
|
820
819
|
|
|
821
|
-
/**
|
|
822
|
-
* Configures the selection settings.
|
|
823
|
-
* {% codeBlock src='grid/selectionSettings/index.md' %}{% endcodeBlock %}
|
|
824
|
-
* @default {mode: 'Row', cellSelectionMode: 'Flow', type: 'Single'}
|
|
825
|
-
*/
|
|
826
|
-
selectionSettings?: SelectionSettingsModel;
|
|
820
|
+
/**
|
|
821
|
+
* Configures the selection settings.
|
|
822
|
+
* {% codeBlock src='grid/selectionSettings/index.md' %}{% endcodeBlock %}
|
|
823
|
+
* @default {mode: 'Row', cellSelectionMode: 'Flow', type: 'Single'}
|
|
824
|
+
*/
|
|
825
|
+
selectionSettings?: SelectionSettingsModel;
|
|
827
826
|
|
|
828
827
|
/**
|
|
829
|
-
* If `allowFiltering` set to true the filter bar will be displayed.
|
|
830
|
-
* If set to false the filter bar will not be displayed.
|
|
831
|
-
* Filter bar allows the user to filter grid records with required criteria.
|
|
832
|
-
*
|
|
833
|
-
* > Check the [`Filtering`](../../grid/filtering/) to customize its default behavior.
|
|
834
|
-
* {% codeBlock src='grid/allowFiltering/index.md' %}{% endcodeBlock %}
|
|
835
|
-
* @default false
|
|
836
|
-
*/
|
|
837
|
-
allowFiltering?: boolean;
|
|
828
|
+
* If `allowFiltering` set to true the filter bar will be displayed.
|
|
829
|
+
* If set to false the filter bar will not be displayed.
|
|
830
|
+
* Filter bar allows the user to filter grid records with required criteria.
|
|
831
|
+
*
|
|
832
|
+
* > Check the [`Filtering`](../../grid/filtering/) to customize its default behavior.
|
|
833
|
+
* {% codeBlock src='grid/allowFiltering/index.md' %}{% endcodeBlock %}
|
|
834
|
+
* @default false
|
|
835
|
+
*/
|
|
836
|
+
allowFiltering?: boolean;
|
|
838
837
|
|
|
839
838
|
/**
|
|
840
|
-
* If `allowReordering` is set to true, Grid columns can be reordered.
|
|
841
|
-
* Reordering can be done by drag and drop of a particular column from one index to another index.
|
|
842
|
-
* > If Grid is rendered with stacked headers, reordering is allowed only at the same level as the column headers.
|
|
843
|
-
* {% codeBlock src='grid/allowReordering/index.md' %}{% endcodeBlock %}
|
|
844
|
-
* @default false
|
|
845
|
-
*/
|
|
846
|
-
allowReordering?: boolean;
|
|
839
|
+
* If `allowReordering` is set to true, Grid columns can be reordered.
|
|
840
|
+
* Reordering can be done by drag and drop of a particular column from one index to another index.
|
|
841
|
+
* > If Grid is rendered with stacked headers, reordering is allowed only at the same level as the column headers.
|
|
842
|
+
* {% codeBlock src='grid/allowReordering/index.md' %}{% endcodeBlock %}
|
|
843
|
+
* @default false
|
|
844
|
+
*/
|
|
845
|
+
allowReordering?: boolean;
|
|
847
846
|
|
|
848
847
|
/**
|
|
849
|
-
* If `allowResizing` is set to true, Grid columns can be resized.
|
|
850
|
-
* {% codeBlock src='grid/allowResizing/index.md' %}{% endcodeBlock %}
|
|
851
|
-
* @default false
|
|
852
|
-
*/
|
|
853
|
-
allowResizing?: boolean;
|
|
848
|
+
* If `allowResizing` is set to true, Grid columns can be resized.
|
|
849
|
+
* {% codeBlock src='grid/allowResizing/index.md' %}{% endcodeBlock %}
|
|
850
|
+
* @default false
|
|
851
|
+
*/
|
|
852
|
+
allowResizing?: boolean;
|
|
854
853
|
|
|
855
854
|
/**
|
|
856
|
-
* If `allowRowDragAndDrop` is set to true, you can drag and drop grid rows at another grid.
|
|
857
|
-
* {% codeBlock src='grid/allowRowDragAndDrop/index.md' %}{% endcodeBlock %}
|
|
858
|
-
* @default false
|
|
859
|
-
*/
|
|
860
|
-
allowRowDragAndDrop?: boolean;
|
|
855
|
+
* If `allowRowDragAndDrop` is set to true, you can drag and drop grid rows at another grid.
|
|
856
|
+
* {% codeBlock src='grid/allowRowDragAndDrop/index.md' %}{% endcodeBlock %}
|
|
857
|
+
* @default false
|
|
858
|
+
*/
|
|
859
|
+
allowRowDragAndDrop?: boolean;
|
|
861
860
|
|
|
862
861
|
/**
|
|
863
|
-
* Configures the row drop settings.
|
|
864
|
-
* @default {targetID: ''}
|
|
865
|
-
*/
|
|
866
|
-
rowDropSettings?: RowDropSettingsModel;
|
|
862
|
+
* Configures the row drop settings.
|
|
863
|
+
* @default {targetID: ''}
|
|
864
|
+
*/
|
|
865
|
+
rowDropSettings?: RowDropSettingsModel;
|
|
867
866
|
|
|
868
867
|
/**
|
|
869
|
-
* Configures the filter settings of the Grid.
|
|
870
|
-
* {% codeBlock src='grid/filterSettings/index.md' %}{% endcodeBlock %}
|
|
871
|
-
* @default {columns: [], type: 'FilterBar', mode: 'Immediate', showFilterBarStatus: true, immediateModeDelay: 1500 , operators: {}}
|
|
872
|
-
*/
|
|
873
|
-
filterSettings?: FilterSettingsModel;
|
|
868
|
+
* Configures the filter settings of the Grid.
|
|
869
|
+
* {% codeBlock src='grid/filterSettings/index.md' %}{% endcodeBlock %}
|
|
870
|
+
* @default {columns: [], type: 'FilterBar', mode: 'Immediate', showFilterBarStatus: true, immediateModeDelay: 1500 , operators: {}}
|
|
871
|
+
*/
|
|
872
|
+
filterSettings?: FilterSettingsModel;
|
|
874
873
|
|
|
875
874
|
/**
|
|
876
|
-
* If `allowGrouping` set to true, then it will allow the user to dynamically group or ungroup columns.
|
|
877
|
-
* Grouping can be done by drag and drop columns from column header to group drop area.
|
|
878
|
-
*
|
|
879
|
-
* > Check the [`Grouping`](../../grid/grouping/) to customize its default behavior.
|
|
880
|
-
* {% codeBlock src='grid/allowGrouping/index.md' %}{% endcodeBlock %}
|
|
881
|
-
* @default false
|
|
882
|
-
*/
|
|
883
|
-
allowGrouping?: boolean;
|
|
875
|
+
* If `allowGrouping` set to true, then it will allow the user to dynamically group or ungroup columns.
|
|
876
|
+
* Grouping can be done by drag and drop columns from column header to group drop area.
|
|
877
|
+
*
|
|
878
|
+
* > Check the [`Grouping`](../../grid/grouping/) to customize its default behavior.
|
|
879
|
+
* {% codeBlock src='grid/allowGrouping/index.md' %}{% endcodeBlock %}
|
|
880
|
+
* @default false
|
|
881
|
+
*/
|
|
882
|
+
allowGrouping?: boolean;
|
|
884
883
|
|
|
885
884
|
/**
|
|
886
|
-
* If `enableImmutableMode` is set to true, the grid will reuse old rows if it exists in the new result instead of
|
|
887
|
-
* full refresh while performing the grid actions.
|
|
888
|
-
* @default false
|
|
889
|
-
*/
|
|
890
|
-
enableImmutableMode?: boolean;
|
|
885
|
+
* If `enableImmutableMode` is set to true, the grid will reuse old rows if it exists in the new result instead of
|
|
886
|
+
* full refresh while performing the grid actions.
|
|
887
|
+
* @default false
|
|
888
|
+
*/
|
|
889
|
+
enableImmutableMode?: boolean;
|
|
891
890
|
|
|
892
891
|
/**
|
|
893
|
-
* If `showColumnMenu` set to true, then it will enable the column menu options in each columns.
|
|
894
|
-
*
|
|
895
|
-
* > Check the [`Column menu`](../../grid/columns/#column-menu/) for its configuration.
|
|
896
|
-
* {% codeBlock src='grid/showColumnMenu/index.md' %}{% endcodeBlock %}
|
|
897
|
-
* @default false
|
|
898
|
-
*/
|
|
899
|
-
showColumnMenu?: boolean;
|
|
892
|
+
* If `showColumnMenu` set to true, then it will enable the column menu options in each columns.
|
|
893
|
+
*
|
|
894
|
+
* > Check the [`Column menu`](../../grid/columns/#column-menu/) for its configuration.
|
|
895
|
+
* {% codeBlock src='grid/showColumnMenu/index.md' %}{% endcodeBlock %}
|
|
896
|
+
* @default false
|
|
897
|
+
*/
|
|
898
|
+
showColumnMenu?: boolean;
|
|
900
899
|
|
|
901
900
|
/**
|
|
902
|
-
* Configures the group settings.
|
|
903
|
-
* {% codeBlock src='grid/groupSettings/index.md' %}{% endcodeBlock %}
|
|
904
|
-
* @default {showDropArea: true, showToggleButton: false, showGroupedColumn: false, showUngroupButton: true, columns: []}
|
|
905
|
-
*/
|
|
906
|
-
groupSettings?: GroupSettingsModel;
|
|
901
|
+
* Configures the group settings.
|
|
902
|
+
* {% codeBlock src='grid/groupSettings/index.md' %}{% endcodeBlock %}
|
|
903
|
+
* @default {showDropArea: true, showToggleButton: false, showGroupedColumn: false, showUngroupButton: true, columns: []}
|
|
904
|
+
*/
|
|
905
|
+
groupSettings?: GroupSettingsModel;
|
|
907
906
|
|
|
908
907
|
/**
|
|
909
|
-
* Configures the edit settings.
|
|
910
|
-
* {% codeBlock src='grid/editSettings/index.md' %}{% endcodeBlock %}
|
|
911
|
-
* @default { allowAdding: false, allowEditing: false, allowDeleting: false, mode:'Normal',
|
|
912
|
-
* allowEditOnDblClick: true, showConfirmDialog: true, showDeleteConfirmDialog: false }
|
|
913
|
-
*/
|
|
914
|
-
editSettings?: EditSettingsModel;
|
|
908
|
+
* Configures the edit settings.
|
|
909
|
+
* {% codeBlock src='grid/editSettings/index.md' %}{% endcodeBlock %}
|
|
910
|
+
* @default { allowAdding: false, allowEditing: false, allowDeleting: false, mode:'Normal',
|
|
911
|
+
* allowEditOnDblClick: true, showConfirmDialog: true, showDeleteConfirmDialog: false }
|
|
912
|
+
*/
|
|
913
|
+
editSettings?: EditSettingsModel;
|
|
915
914
|
|
|
916
915
|
/**
|
|
917
|
-
* Configures the Grid aggregate rows.
|
|
918
|
-
* {% codeBlock src='grid/aggregates/index.md' %}{% endcodeBlock %}
|
|
919
|
-
* > Check the [`Aggregates`](../../grid/aggregates/) for its configuration.
|
|
920
|
-
* @default []
|
|
921
|
-
*/
|
|
922
|
-
aggregates?: AggregateRowModel[];
|
|
916
|
+
* Configures the Grid aggregate rows.
|
|
917
|
+
* {% codeBlock src='grid/aggregates/index.md' %}{% endcodeBlock %}
|
|
918
|
+
* > Check the [`Aggregates`](../../grid/aggregates/) for its configuration.
|
|
919
|
+
* @default []
|
|
920
|
+
*/
|
|
921
|
+
aggregates?: AggregateRowModel[];
|
|
923
922
|
|
|
924
923
|
/**
|
|
925
|
-
* If `showColumnChooser` is set to true, it allows you to dynamically show or hide columns.
|
|
926
|
-
*
|
|
927
|
-
* > Check the [`ColumnChooser`](../../grid/columns/#column-chooser/) for its configuration.
|
|
928
|
-
* {% codeBlock src='grid/showColumnChooser/index.md' %}{% endcodeBlock %}
|
|
929
|
-
* @default false
|
|
930
|
-
*/
|
|
931
|
-
showColumnChooser?: boolean;
|
|
932
|
-
|
|
933
|
-
/**
|
|
934
|
-
* Configures the column chooser in the Grid.
|
|
935
|
-
* @default { columnChooserOperator: 'startsWith' }
|
|
936
|
-
*/
|
|
937
|
-
columnChooserSettings?: ColumnChooserSettingsModel;
|
|
938
|
-
|
|
939
|
-
/**
|
|
940
|
-
* If `enableHeaderFocus` set to true, then header element will be focused when focus moves to grid.
|
|
941
|
-
* @default false
|
|
942
|
-
*/
|
|
943
|
-
enableHeaderFocus?: boolean;
|
|
924
|
+
* If `showColumnChooser` is set to true, it allows you to dynamically show or hide columns.
|
|
925
|
+
*
|
|
926
|
+
* > Check the [`ColumnChooser`](../../grid/columns/#column-chooser/) for its configuration.
|
|
927
|
+
* {% codeBlock src='grid/showColumnChooser/index.md' %}{% endcodeBlock %}
|
|
928
|
+
* @default false
|
|
929
|
+
*/
|
|
930
|
+
showColumnChooser?: boolean;
|
|
931
|
+
|
|
932
|
+
/**
|
|
933
|
+
* Configures the column chooser in the Grid.
|
|
934
|
+
* @default { columnChooserOperator: 'startsWith' }
|
|
935
|
+
*/
|
|
936
|
+
columnChooserSettings?: ColumnChooserSettingsModel;
|
|
937
|
+
|
|
938
|
+
/**
|
|
939
|
+
* If `enableHeaderFocus` set to true, then header element will be focused when focus moves to grid.
|
|
940
|
+
* @default false
|
|
941
|
+
*/
|
|
942
|
+
enableHeaderFocus?: boolean;
|
|
944
943
|
|
|
945
944
|
/**
|
|
946
|
-
* Defines the scrollable height of the grid content.
|
|
947
|
-
* {% codeBlock src='grid/height/index.md' %}{% endcodeBlock %}
|
|
948
|
-
* @default 'auto'
|
|
949
|
-
*/
|
|
950
|
-
height?: string | number;
|
|
951
|
-
|
|
952
|
-
/**
|
|
953
|
-
* Defines the Grid width.
|
|
954
|
-
* {% codeBlock src='grid/width/index.md' %}{% endcodeBlock %}
|
|
955
|
-
* @default 'auto'
|
|
956
|
-
*/
|
|
957
|
-
width?: string | number;
|
|
958
|
-
|
|
959
|
-
/**
|
|
960
|
-
* Defines the mode of grid lines. The available modes are,
|
|
961
|
-
* * `Both`: Displays both horizontal and vertical grid lines.
|
|
962
|
-
* * `None`: No grid lines are displayed.
|
|
963
|
-
* * `Horizontal`: Displays the horizontal grid lines only.
|
|
964
|
-
* * `Vertical`: Displays the vertical grid lines only.
|
|
965
|
-
* * `Default`: Displays grid lines based on the theme.
|
|
966
|
-
* {% codeBlock src='grid/gridLines/index.md' %}{% endcodeBlock %}
|
|
967
|
-
* @default Default
|
|
968
|
-
*/
|
|
969
|
-
gridLines?: GridLine;
|
|
970
|
-
|
|
971
|
-
/**
|
|
972
|
-
* The row template that renders customized rows from the given template.
|
|
973
|
-
* By default, Grid renders a table row for every data source item.
|
|
974
|
-
* > * It accepts either [template string](../../common/template-engine/) or HTML element ID.
|
|
975
|
-
* > * The row template must be a table row.
|
|
976
|
-
*
|
|
977
|
-
* > Check the [`Row Template`](grid/row/) customization.
|
|
978
|
-
*/
|
|
979
|
-
rowTemplate?: string;
|
|
980
|
-
|
|
981
|
-
/**
|
|
982
|
-
* The detail template allows you to show or hide additional information about a particular row.
|
|
983
|
-
*
|
|
984
|
-
* > It accepts either the [template string](../../common/template-engine/) or the HTML element ID.
|
|
985
|
-
*
|
|
986
|
-
* {% codeBlock src="grid/detail-template-api/index.ts" %}{% endcodeBlock %}
|
|
987
|
-
*/
|
|
988
|
-
detailTemplate?: string;
|
|
989
|
-
|
|
990
|
-
/**
|
|
991
|
-
* Defines Grid options to render child Grid.
|
|
992
|
-
* It requires the [`queryString`](
|
|
993
|
-
* and child relationship.
|
|
994
|
-
*
|
|
995
|
-
* > Check the [`Child Grid`](../../grid/hierarchy-grid/) for its configuration.
|
|
996
|
-
* @blazorType GridModel<object>
|
|
997
|
-
*/
|
|
998
|
-
childGrid?: GridModel;
|
|
999
|
-
|
|
1000
|
-
/**
|
|
1001
|
-
* Defines the relationship between parent and child datasource. It acts as the foreign key for parent datasource.
|
|
1002
|
-
*/
|
|
1003
|
-
queryString?: string;
|
|
1004
|
-
|
|
1005
|
-
/**
|
|
1006
|
-
* Defines the print modes. The available print modes are
|
|
1007
|
-
* * `AllPages`: Prints all pages of the Grid.
|
|
1008
|
-
* * `CurrentPage`: Prints the current page of the Grid.
|
|
1009
|
-
* {% codeBlock src='grid/printMode/index.md' %}{% endcodeBlock %}
|
|
1010
|
-
* @default AllPages
|
|
1011
|
-
*/
|
|
1012
|
-
printMode?: PrintMode;
|
|
1013
|
-
|
|
1014
|
-
/**
|
|
1015
|
-
* Defines the hierarchy grid print modes. The available modes are
|
|
1016
|
-
* * `Expanded` - Prints the master grid with expanded child grids.
|
|
1017
|
-
* * `All` - Prints the master grid with all the child grids.
|
|
1018
|
-
* * `None` - Prints the master grid alone.
|
|
1019
|
-
* @default Expanded
|
|
1020
|
-
*/
|
|
1021
|
-
hierarchyPrintMode?: HierarchyGridPrintMode;
|
|
1022
|
-
|
|
1023
|
-
/**
|
|
1024
|
-
* It is used to render grid table rows.
|
|
1025
|
-
* If the `dataSource` is an array of JavaScript objects,
|
|
1026
|
-
* then Grid will create instance of [`DataManager`](https://ej2.syncfusion.com/documentation/data/
|
|
1027
|
-
* from this `dataSource`.
|
|
1028
|
-
* If the `dataSource` is an existing [`DataManager`](https://ej2.syncfusion.com/documentation/data/
|
|
1029
|
-
* the Grid will not initialize a new one.
|
|
1030
|
-
*
|
|
1031
|
-
* > Check the available [`Adaptors`](../../data/adaptors/) to customize the data operation.
|
|
1032
|
-
* {% codeBlock src='grid/dataSource/index.md' %}{% endcodeBlock %}
|
|
1033
|
-
* @default []
|
|
1034
|
-
* @isGenericType true
|
|
1035
|
-
*/
|
|
1036
|
-
dataSource?: Object | DataManager | DataResult;
|
|
1037
|
-
|
|
1038
|
-
/**
|
|
1039
|
-
* Defines the height of Grid rows.
|
|
1040
|
-
* {% codeBlock src='grid/rowHeight/index.md' %}{% endcodeBlock %}
|
|
1041
|
-
* @default null
|
|
1042
|
-
*/
|
|
1043
|
-
rowHeight?: number;
|
|
1044
|
-
|
|
1045
|
-
/**
|
|
1046
|
-
* Defines the external [`Query`](https://ej2.syncfusion.com/documentation/data/api-query.html)
|
|
1047
|
-
* that will be executed along with data processing.
|
|
1048
|
-
* {% codeBlock src='grid/query/index.md' %}{% endcodeBlock %}
|
|
1049
|
-
* @default null
|
|
1050
|
-
* @blazorType Syncfusion.Blazor.Data.Query
|
|
1051
|
-
*/
|
|
1052
|
-
query?: Query;
|
|
1053
|
-
|
|
1054
|
-
/**
|
|
1055
|
-
* Defines the currencyCode format of the Grid columns
|
|
1056
|
-
* @private
|
|
1057
|
-
*/
|
|
1058
|
-
currencyCode?: string;
|
|
1059
|
-
|
|
1060
|
-
/**
|
|
1061
|
-
* `toolbar` defines the ToolBar items of the Grid.
|
|
1062
|
-
* It contains built-in and custom toolbar items.
|
|
1063
|
-
* If a string value is assigned to the `toolbar` option, it is considered as the template for the whole Grid ToolBar.
|
|
1064
|
-
* If an array value is assigned, it is considered as the list of built-in and custom toolbar items in the Grid's Toolbar.
|
|
1065
|
-
* <br><br>
|
|
1066
|
-
* The available built-in ToolBar items are:
|
|
1067
|
-
* * Add: Adds a new record.
|
|
1068
|
-
* * Edit: Edits the selected record.
|
|
1069
|
-
* * Update: Updates the edited record.
|
|
1070
|
-
* * Delete: Deletes the selected record.
|
|
1071
|
-
* * Cancel: Cancels the edit state.
|
|
1072
|
-
* * Search: Searches records by the given key.
|
|
1073
|
-
* * Print: Prints the Grid.
|
|
1074
|
-
* * ExcelExport - Export the Grid to Excel(excelExport() method manually to make export.)
|
|
1075
|
-
* * PdfExport - Export the Grid to PDF(pdfExport() method manually to make export.)
|
|
1076
|
-
* * CsvExport - Export the Grid to CSV(csvExport() method manually to make export.)<br><br>
|
|
1077
|
-
* The following code example implements the custom toolbar items.
|
|
1078
|
-
*
|
|
1079
|
-
* > Check the [`Toolbar`](../../grid/tool-bar/#custom-toolbar-items/) to customize its default items.
|
|
1080
|
-
*
|
|
1081
|
-
* {% codeBlock src="grid/toolbar-api/index.ts" %}{% endcodeBlock %}
|
|
1082
|
-
* {% codeBlock src='grid/toolbar/index.md' %}{% endcodeBlock %}
|
|
1083
|
-
* @default null
|
|
1084
|
-
*/
|
|
1085
|
-
toolbar?: (ToolbarItems | string | ItemModel | ToolbarItem)[];
|
|
1086
|
-
|
|
1087
|
-
/**
|
|
1088
|
-
* `contextMenuItems` defines both built-in and custom context menu items.
|
|
1089
|
-
* <br><br>
|
|
1090
|
-
* The available built-in items are,
|
|
1091
|
-
* * `AutoFitAll` - Auto fit the size of all columns.
|
|
1092
|
-
* * `AutoFit` - Auto fit the current column.
|
|
1093
|
-
* * `Group` - Group by current column.
|
|
1094
|
-
* * `Ungroup` - Ungroup by current column.
|
|
1095
|
-
* * `Edit` - Edit the current record.
|
|
1096
|
-
* * `Delete` - Delete the current record.
|
|
1097
|
-
* * `Save` - Save the edited record.
|
|
1098
|
-
* * `Cancel` - Cancel the edited state.
|
|
1099
|
-
* * `Copy` - Copy the selected records.
|
|
1100
|
-
* * `PdfExport` - Export the grid as Pdf format.
|
|
1101
|
-
* * `ExcelExport` - Export the grid as Excel format.
|
|
1102
|
-
* * `CsvExport` - Export the grid as CSV format.
|
|
1103
|
-
* * `SortAscending` - Sort the current column in ascending order.
|
|
1104
|
-
* * `SortDescending` - Sort the current column in descending order.
|
|
1105
|
-
* * `FirstPage` - Go to the first page.
|
|
1106
|
-
* * `PrevPage` - Go to the previous page.
|
|
1107
|
-
* * `LastPage` - Go to the last page.
|
|
1108
|
-
* * `NextPage` - Go to the next page.
|
|
1109
|
-
*
|
|
1110
|
-
* @default null
|
|
1111
|
-
*/
|
|
1112
|
-
contextMenuItems?: ContextMenuItem[] | ContextMenuItemModel[];
|
|
1113
|
-
|
|
1114
|
-
/**
|
|
1115
|
-
* `columnMenuItems` defines both built-in and custom column menu items.
|
|
1116
|
-
* <br><br>
|
|
1117
|
-
* The available built-in items are,
|
|
1118
|
-
* * `AutoFitAll` - Auto fit the size of all columns.
|
|
1119
|
-
* * `AutoFit` - Auto fit the current column.
|
|
1120
|
-
* * `Group` - Group by current column.
|
|
1121
|
-
* * `Ungroup` - Ungroup by current column.
|
|
1122
|
-
* * `SortAscending` - Sort the current column in ascending order.
|
|
1123
|
-
* * `SortDescending` - Sort the current column in descending order.
|
|
1124
|
-
* * `Filter` - Filter options will show based on filterSettings property like checkbox filter, excel filter, menu filter.
|
|
1125
|
-
* @default null
|
|
1126
|
-
*/
|
|
1127
|
-
columnMenuItems?: ColumnMenuItem[] | ColumnMenuItemModel[];
|
|
1128
|
-
|
|
1129
|
-
/**
|
|
1130
|
-
* It used to render toolbar template
|
|
1131
|
-
* @default null
|
|
1132
|
-
*/
|
|
1133
|
-
toolbarTemplate?: string;
|
|
1134
|
-
|
|
1135
|
-
/**
|
|
1136
|
-
* It used to render pager template
|
|
1137
|
-
* @default null
|
|
1138
|
-
*/
|
|
1139
|
-
pagerTemplate?: string;
|
|
1140
|
-
|
|
1141
|
-
/**
|
|
1142
|
-
* Gets or sets the number of frozen rows.
|
|
1143
|
-
* {% codeBlock src='grid/frozenRows/index.md' %}{% endcodeBlock %}
|
|
1144
|
-
* @default 0
|
|
1145
|
-
*/
|
|
1146
|
-
frozenRows?: number;
|
|
1147
|
-
|
|
1148
|
-
/**
|
|
1149
|
-
* Gets or sets the number of frozen columns.
|
|
1150
|
-
* {% codeBlock src='grid/frozenColumns/index.md' %}{% endcodeBlock %}
|
|
1151
|
-
* @default 0
|
|
1152
|
-
*/
|
|
1153
|
-
frozenColumns?: number;
|
|
1154
|
-
|
|
1155
|
-
/**
|
|
1156
|
-
* `columnQueryMode`provides options to retrive data from the datasource.Their types are
|
|
1157
|
-
* * `All`: It Retrives whole datasource.
|
|
1158
|
-
* * `Schema`: Retrives data for all the defined columns in grid from the datasource.
|
|
1159
|
-
* * `ExcludeHidden`: Retrives data only for visible columns of grid from the dataSource.
|
|
1160
|
-
* @default All
|
|
1161
|
-
*/
|
|
1162
|
-
columnQueryMode?: ColumnQueryModeType;
|
|
1163
|
-
|
|
1164
|
-
/**
|
|
1165
|
-
* Gets or sets the current action details.
|
|
1166
|
-
* @default {}
|
|
1167
|
-
*/
|
|
1168
|
-
currentAction?: ActionArgs;
|
|
1169
|
-
|
|
1170
|
-
/**
|
|
1171
|
-
* Triggers when the component is created.
|
|
1172
|
-
* @event
|
|
1173
|
-
* @blazorProperty 'Created'
|
|
1174
|
-
*/
|
|
1175
|
-
created?: EmitType<Object>;
|
|
1176
|
-
|
|
1177
|
-
/**
|
|
1178
|
-
* Triggers when the component is destroyed.
|
|
1179
|
-
* @event
|
|
1180
|
-
* @blazorProperty 'Destroyed'
|
|
1181
|
-
*/
|
|
1182
|
-
destroyed?: EmitType<Object>;
|
|
1183
|
-
|
|
945
|
+
* Defines the scrollable height of the grid content.
|
|
946
|
+
* {% codeBlock src='grid/height/index.md' %}{% endcodeBlock %}
|
|
947
|
+
* @default 'auto'
|
|
948
|
+
*/
|
|
949
|
+
height?: string | number;
|
|
950
|
+
|
|
951
|
+
/**
|
|
952
|
+
* Defines the Grid width.
|
|
953
|
+
* {% codeBlock src='grid/width/index.md' %}{% endcodeBlock %}
|
|
954
|
+
* @default 'auto'
|
|
955
|
+
*/
|
|
956
|
+
width?: string | number;
|
|
957
|
+
|
|
958
|
+
/**
|
|
959
|
+
* Defines the mode of grid lines. The available modes are,
|
|
960
|
+
* * `Both`: Displays both horizontal and vertical grid lines.
|
|
961
|
+
* * `None`: No grid lines are displayed.
|
|
962
|
+
* * `Horizontal`: Displays the horizontal grid lines only.
|
|
963
|
+
* * `Vertical`: Displays the vertical grid lines only.
|
|
964
|
+
* * `Default`: Displays grid lines based on the theme.
|
|
965
|
+
* {% codeBlock src='grid/gridLines/index.md' %}{% endcodeBlock %}
|
|
966
|
+
* @default Default
|
|
967
|
+
*/
|
|
968
|
+
gridLines?: GridLine;
|
|
969
|
+
|
|
970
|
+
/**
|
|
971
|
+
* The row template that renders customized rows from the given template.
|
|
972
|
+
* By default, Grid renders a table row for every data source item.
|
|
973
|
+
* > * It accepts either [template string](../../common/template-engine/) or HTML element ID.
|
|
974
|
+
* > * The row template must be a table row.
|
|
975
|
+
*
|
|
976
|
+
* > Check the [`Row Template`](../../grid/row/) customization.
|
|
977
|
+
*/
|
|
978
|
+
rowTemplate?: string;
|
|
979
|
+
|
|
980
|
+
/**
|
|
981
|
+
* The detail template allows you to show or hide additional information about a particular row.
|
|
982
|
+
*
|
|
983
|
+
* > It accepts either the [template string](../../common/template-engine/) or the HTML element ID.
|
|
984
|
+
*
|
|
985
|
+
* {% codeBlock src="grid/detail-template-api/index.ts" %}{% endcodeBlock %}
|
|
986
|
+
*/
|
|
987
|
+
detailTemplate?: string;
|
|
988
|
+
|
|
989
|
+
/**
|
|
990
|
+
* Defines Grid options to render child Grid.
|
|
991
|
+
* It requires the [`queryString`](/#querystring) for parent
|
|
992
|
+
* and child relationship.
|
|
993
|
+
*
|
|
994
|
+
* > Check the [`Child Grid`](../../grid/hierarchy-grid/) for its configuration.
|
|
995
|
+
* @blazorType GridModel<object>
|
|
996
|
+
*/
|
|
997
|
+
childGrid?: GridModel;
|
|
998
|
+
|
|
999
|
+
/**
|
|
1000
|
+
* Defines the relationship between parent and child datasource. It acts as the foreign key for parent datasource.
|
|
1001
|
+
*/
|
|
1002
|
+
queryString?: string;
|
|
1003
|
+
|
|
1004
|
+
/**
|
|
1005
|
+
* Defines the print modes. The available print modes are
|
|
1006
|
+
* * `AllPages`: Prints all pages of the Grid.
|
|
1007
|
+
* * `CurrentPage`: Prints the current page of the Grid.
|
|
1008
|
+
* {% codeBlock src='grid/printMode/index.md' %}{% endcodeBlock %}
|
|
1009
|
+
* @default AllPages
|
|
1010
|
+
*/
|
|
1011
|
+
printMode?: PrintMode;
|
|
1012
|
+
|
|
1013
|
+
/**
|
|
1014
|
+
* Defines the hierarchy grid print modes. The available modes are
|
|
1015
|
+
* * `Expanded` - Prints the master grid with expanded child grids.
|
|
1016
|
+
* * `All` - Prints the master grid with all the child grids.
|
|
1017
|
+
* * `None` - Prints the master grid alone.
|
|
1018
|
+
* @default Expanded
|
|
1019
|
+
*/
|
|
1020
|
+
hierarchyPrintMode?: HierarchyGridPrintMode;
|
|
1021
|
+
|
|
1022
|
+
/**
|
|
1023
|
+
* It is used to render grid table rows.
|
|
1024
|
+
* If the `dataSource` is an array of JavaScript objects,
|
|
1025
|
+
* then Grid will create instance of [`DataManager`](https://ej2.syncfusion.com/documentation/api/data/dataManager/)
|
|
1026
|
+
* from this `dataSource`.
|
|
1027
|
+
* If the `dataSource` is an existing [`DataManager`](https://ej2.syncfusion.com/documentation/api/data/dataManager/),
|
|
1028
|
+
* the Grid will not initialize a new one.
|
|
1029
|
+
*
|
|
1030
|
+
* > Check the available [`Adaptors`](../../data/adaptors/) to customize the data operation.
|
|
1031
|
+
* {% codeBlock src='grid/dataSource/index.md' %}{% endcodeBlock %}
|
|
1032
|
+
* @default []
|
|
1033
|
+
* @isGenericType true
|
|
1034
|
+
*/
|
|
1035
|
+
dataSource?: Object | DataManager | DataResult;
|
|
1036
|
+
|
|
1037
|
+
/**
|
|
1038
|
+
* Defines the height of Grid rows.
|
|
1039
|
+
* {% codeBlock src='grid/rowHeight/index.md' %}{% endcodeBlock %}
|
|
1040
|
+
* @default null
|
|
1041
|
+
*/
|
|
1042
|
+
rowHeight?: number;
|
|
1043
|
+
|
|
1044
|
+
/**
|
|
1045
|
+
* Defines the external [`Query`](https://ej2.syncfusion.com/documentation/data/api-query.html)
|
|
1046
|
+
* that will be executed along with data processing.
|
|
1047
|
+
* {% codeBlock src='grid/query/index.md' %}{% endcodeBlock %}
|
|
1048
|
+
* @default null
|
|
1049
|
+
* @blazorType Syncfusion.Blazor.Data.Query
|
|
1050
|
+
*/
|
|
1051
|
+
query?: Query;
|
|
1052
|
+
|
|
1053
|
+
/**
|
|
1054
|
+
* Defines the currencyCode format of the Grid columns
|
|
1055
|
+
* @private
|
|
1056
|
+
*/
|
|
1057
|
+
currencyCode?: string;
|
|
1058
|
+
|
|
1059
|
+
/**
|
|
1060
|
+
* `toolbar` defines the ToolBar items of the Grid.
|
|
1061
|
+
* It contains built-in and custom toolbar items.
|
|
1062
|
+
* If a string value is assigned to the `toolbar` option, it is considered as the template for the whole Grid ToolBar.
|
|
1063
|
+
* If an array value is assigned, it is considered as the list of built-in and custom toolbar items in the Grid's Toolbar.
|
|
1064
|
+
* <br><br>
|
|
1065
|
+
* The available built-in ToolBar items are:
|
|
1066
|
+
* * Add: Adds a new record.
|
|
1067
|
+
* * Edit: Edits the selected record.
|
|
1068
|
+
* * Update: Updates the edited record.
|
|
1069
|
+
* * Delete: Deletes the selected record.
|
|
1070
|
+
* * Cancel: Cancels the edit state.
|
|
1071
|
+
* * Search: Searches records by the given key.
|
|
1072
|
+
* * Print: Prints the Grid.
|
|
1073
|
+
* * ExcelExport - Export the Grid to Excel(excelExport() method manually to make export.)
|
|
1074
|
+
* * PdfExport - Export the Grid to PDF(pdfExport() method manually to make export.)
|
|
1075
|
+
* * CsvExport - Export the Grid to CSV(csvExport() method manually to make export.)<br><br>
|
|
1076
|
+
* The following code example implements the custom toolbar items.
|
|
1077
|
+
*
|
|
1078
|
+
* > Check the [`Toolbar`](../../grid/tool-bar/#custom-toolbar-items/) to customize its default items.
|
|
1079
|
+
*
|
|
1080
|
+
* {% codeBlock src="grid/toolbar-api/index.ts" %}{% endcodeBlock %}
|
|
1081
|
+
* {% codeBlock src='grid/toolbar/index.md' %}{% endcodeBlock %}
|
|
1082
|
+
* @default null
|
|
1083
|
+
*/
|
|
1084
|
+
toolbar?: (ToolbarItems | string | ItemModel | ToolbarItem)[];
|
|
1085
|
+
|
|
1086
|
+
/**
|
|
1087
|
+
* `contextMenuItems` defines both built-in and custom context menu items.
|
|
1088
|
+
* <br><br>
|
|
1089
|
+
* The available built-in items are,
|
|
1090
|
+
* * `AutoFitAll` - Auto fit the size of all columns.
|
|
1091
|
+
* * `AutoFit` - Auto fit the current column.
|
|
1092
|
+
* * `Group` - Group by current column.
|
|
1093
|
+
* * `Ungroup` - Ungroup by current column.
|
|
1094
|
+
* * `Edit` - Edit the current record.
|
|
1095
|
+
* * `Delete` - Delete the current record.
|
|
1096
|
+
* * `Save` - Save the edited record.
|
|
1097
|
+
* * `Cancel` - Cancel the edited state.
|
|
1098
|
+
* * `Copy` - Copy the selected records.
|
|
1099
|
+
* * `PdfExport` - Export the grid as Pdf format.
|
|
1100
|
+
* * `ExcelExport` - Export the grid as Excel format.
|
|
1101
|
+
* * `CsvExport` - Export the grid as CSV format.
|
|
1102
|
+
* * `SortAscending` - Sort the current column in ascending order.
|
|
1103
|
+
* * `SortDescending` - Sort the current column in descending order.
|
|
1104
|
+
* * `FirstPage` - Go to the first page.
|
|
1105
|
+
* * `PrevPage` - Go to the previous page.
|
|
1106
|
+
* * `LastPage` - Go to the last page.
|
|
1107
|
+
* * `NextPage` - Go to the next page.
|
|
1108
|
+
*
|
|
1109
|
+
* @default null
|
|
1110
|
+
*/
|
|
1111
|
+
contextMenuItems?: ContextMenuItem[] | ContextMenuItemModel[];
|
|
1112
|
+
|
|
1113
|
+
/**
|
|
1114
|
+
* `columnMenuItems` defines both built-in and custom column menu items.
|
|
1115
|
+
* <br><br>
|
|
1116
|
+
* The available built-in items are,
|
|
1117
|
+
* * `AutoFitAll` - Auto fit the size of all columns.
|
|
1118
|
+
* * `AutoFit` - Auto fit the current column.
|
|
1119
|
+
* * `Group` - Group by current column.
|
|
1120
|
+
* * `Ungroup` - Ungroup by current column.
|
|
1121
|
+
* * `SortAscending` - Sort the current column in ascending order.
|
|
1122
|
+
* * `SortDescending` - Sort the current column in descending order.
|
|
1123
|
+
* * `Filter` - Filter options will show based on filterSettings property like checkbox filter, excel filter, menu filter.
|
|
1124
|
+
* @default null
|
|
1125
|
+
*/
|
|
1126
|
+
columnMenuItems?: ColumnMenuItem[] | ColumnMenuItemModel[];
|
|
1127
|
+
|
|
1128
|
+
/**
|
|
1129
|
+
* It used to render toolbar template
|
|
1130
|
+
* @default null
|
|
1131
|
+
*/
|
|
1132
|
+
toolbarTemplate?: string;
|
|
1133
|
+
|
|
1134
|
+
/**
|
|
1135
|
+
* It used to render pager template
|
|
1136
|
+
* @default null
|
|
1137
|
+
*/
|
|
1138
|
+
pagerTemplate?: string;
|
|
1139
|
+
|
|
1140
|
+
/**
|
|
1141
|
+
* Gets or sets the number of frozen rows.
|
|
1142
|
+
* {% codeBlock src='grid/frozenRows/index.md' %}{% endcodeBlock %}
|
|
1143
|
+
* @default 0
|
|
1144
|
+
*/
|
|
1145
|
+
frozenRows?: number;
|
|
1146
|
+
|
|
1147
|
+
/**
|
|
1148
|
+
* Gets or sets the number of frozen columns.
|
|
1149
|
+
* {% codeBlock src='grid/frozenColumns/index.md' %}{% endcodeBlock %}
|
|
1150
|
+
* @default 0
|
|
1151
|
+
*/
|
|
1152
|
+
frozenColumns?: number;
|
|
1153
|
+
|
|
1154
|
+
/**
|
|
1155
|
+
* `columnQueryMode`provides options to retrive data from the datasource.Their types are
|
|
1156
|
+
* * `All`: It Retrives whole datasource.
|
|
1157
|
+
* * `Schema`: Retrives data for all the defined columns in grid from the datasource.
|
|
1158
|
+
* * `ExcludeHidden`: Retrives data only for visible columns of grid from the dataSource.
|
|
1159
|
+
* @default All
|
|
1160
|
+
*/
|
|
1161
|
+
columnQueryMode?: ColumnQueryModeType;
|
|
1162
|
+
|
|
1163
|
+
/**
|
|
1164
|
+
* Gets or sets the current action details.
|
|
1165
|
+
* @default {}
|
|
1166
|
+
*/
|
|
1167
|
+
currentAction?: ActionArgs;
|
|
1168
|
+
|
|
1169
|
+
/**
|
|
1170
|
+
* Triggers when the component is created.
|
|
1171
|
+
* @event
|
|
1172
|
+
* @blazorProperty 'Created'
|
|
1173
|
+
*/
|
|
1174
|
+
created?: EmitType<Object>;
|
|
1175
|
+
|
|
1176
|
+
/**
|
|
1177
|
+
* Triggers when the component is destroyed.
|
|
1178
|
+
* @event
|
|
1179
|
+
* @blazorProperty 'Destroyed'
|
|
1180
|
+
*/
|
|
1181
|
+
destroyed?: EmitType<Object>;
|
|
1182
|
+
|
|
1184
1183
|
/**
|
|
1185
|
-
* This event allows customization of Grid properties before rendering.
|
|
1186
|
-
* @event
|
|
1187
|
-
* @blazorProperty 'OnLoad'
|
|
1188
|
-
*/
|
|
1189
|
-
load?: EmitType<Object>;
|
|
1190
|
-
|
|
1184
|
+
* This event allows customization of Grid properties before rendering.
|
|
1185
|
+
* @event
|
|
1186
|
+
* @blazorProperty 'OnLoad'
|
|
1187
|
+
*/
|
|
1188
|
+
load?: EmitType<Object>;
|
|
1189
|
+
|
|
1191
1190
|
/**
|
|
1192
|
-
* Triggered every time a request is made to access row information, element, or data.
|
|
1193
|
-
* This will be triggered before the row element is appended to the Grid element.
|
|
1194
|
-
* @event
|
|
1195
|
-
* @blazorProperty 'RowDataBound'
|
|
1196
|
-
*/
|
|
1197
|
-
rowDataBound?: EmitType<RowDataBoundEventArgs>;
|
|
1191
|
+
* Triggered every time a request is made to access row information, element, or data.
|
|
1192
|
+
* This will be triggered before the row element is appended to the Grid element.
|
|
1193
|
+
* @event
|
|
1194
|
+
* @blazorProperty 'RowDataBound'
|
|
1195
|
+
*/
|
|
1196
|
+
rowDataBound?: EmitType<RowDataBoundEventArgs>;
|
|
1198
1197
|
|
|
1199
1198
|
/**
|
|
1200
|
-
* Triggered every time a request is made to access cell information, element, or data.
|
|
1201
|
-
* This will be triggered before the cell element is appended to the Grid element.
|
|
1202
|
-
* @event
|
|
1203
|
-
* @blazorProperty 'QueryCellInfo'
|
|
1204
|
-
*/
|
|
1205
|
-
queryCellInfo?: EmitType<QueryCellInfoEventArgs>;
|
|
1199
|
+
* Triggered every time a request is made to access cell information, element, or data.
|
|
1200
|
+
* This will be triggered before the cell element is appended to the Grid element.
|
|
1201
|
+
* @event
|
|
1202
|
+
* @blazorProperty 'QueryCellInfo'
|
|
1203
|
+
*/
|
|
1204
|
+
queryCellInfo?: EmitType<QueryCellInfoEventArgs>;
|
|
1206
1205
|
|
|
1207
1206
|
/**
|
|
1208
|
-
* Triggered for stacked header.
|
|
1209
|
-
* @event
|
|
1210
|
-
* @blazorProperty 'HeaderCellInfo'
|
|
1211
|
-
*/
|
|
1212
|
-
headerCellInfo?: EmitType<HeaderCellInfoEventArgs>;
|
|
1207
|
+
* Triggered for stacked header.
|
|
1208
|
+
* @event
|
|
1209
|
+
* @blazorProperty 'HeaderCellInfo'
|
|
1210
|
+
*/
|
|
1211
|
+
headerCellInfo?: EmitType<HeaderCellInfoEventArgs>;
|
|
1213
1212
|
|
|
1214
1213
|
/**
|
|
1215
|
-
* Triggers when Grid actions such as sorting, filtering, paging, grouping etc., starts.
|
|
1216
|
-
* {% codeBlock src='grid/actionBegin/index.md' %}{% endcodeBlock %}
|
|
1217
|
-
* @event
|
|
1218
|
-
* @blazorProperty 'OnActionBegin'
|
|
1219
|
-
*/
|
|
1220
|
-
actionBegin?: EmitType<PageEventArgs | GroupEventArgs | FilterEventArgs | SearchEventArgs | SortEventArgs | AddEventArgs | SaveEventArgs | EditEventArgs | DeleteEventArgs | ActionEventArgs>;
|
|
1214
|
+
* Triggers when Grid actions such as sorting, filtering, paging, grouping etc., starts.
|
|
1215
|
+
* {% codeBlock src='grid/actionBegin/index.md' %}{% endcodeBlock %}
|
|
1216
|
+
* @event
|
|
1217
|
+
* @blazorProperty 'OnActionBegin'
|
|
1218
|
+
*/
|
|
1219
|
+
actionBegin?: EmitType<PageEventArgs | GroupEventArgs | FilterEventArgs | SearchEventArgs | SortEventArgs | AddEventArgs | SaveEventArgs | EditEventArgs | DeleteEventArgs | ActionEventArgs>;
|
|
1221
1220
|
|
|
1222
1221
|
/**
|
|
1223
|
-
* Triggers when Grid actions such as sorting, filtering, paging, grouping etc. are completed.
|
|
1224
|
-
* @event
|
|
1225
|
-
* @blazorProperty 'OnActionComplete'
|
|
1226
|
-
*/
|
|
1227
|
-
actionComplete?: EmitType<PageEventArgs | GroupEventArgs | FilterEventArgs | SearchEventArgs | SortEventArgs | AddEventArgs | SaveEventArgs | EditEventArgs | DeleteEventArgs | ActionEventArgs>;
|
|
1222
|
+
* Triggers when Grid actions such as sorting, filtering, paging, grouping etc. are completed.
|
|
1223
|
+
* @event
|
|
1224
|
+
* @blazorProperty 'OnActionComplete'
|
|
1225
|
+
*/
|
|
1226
|
+
actionComplete?: EmitType<PageEventArgs | GroupEventArgs | FilterEventArgs | SearchEventArgs | SortEventArgs | AddEventArgs | SaveEventArgs | EditEventArgs | DeleteEventArgs | ActionEventArgs>;
|
|
1228
1227
|
|
|
1229
1228
|
/**
|
|
1230
|
-
* Triggers when any Grid action failed to achieve the desired results.
|
|
1231
|
-
* @event
|
|
1232
|
-
* @blazorProperty 'OnActionFailure'
|
|
1233
|
-
*/
|
|
1234
|
-
actionFailure?: EmitType<FailureEventArgs>;
|
|
1229
|
+
* Triggers when any Grid action failed to achieve the desired results.
|
|
1230
|
+
* @event
|
|
1231
|
+
* @blazorProperty 'OnActionFailure'
|
|
1232
|
+
*/
|
|
1233
|
+
actionFailure?: EmitType<FailureEventArgs>;
|
|
1235
1234
|
|
|
1236
1235
|
/**
|
|
1237
|
-
* Triggers when data source is populated in the Grid.
|
|
1238
|
-
* @event
|
|
1239
|
-
* @blazorProperty 'DataBound'
|
|
1240
|
-
*/
|
|
1241
|
-
dataBound?: EmitType<Object>;
|
|
1236
|
+
* Triggers when data source is populated in the Grid.
|
|
1237
|
+
* @event
|
|
1238
|
+
* @blazorProperty 'DataBound'
|
|
1239
|
+
*/
|
|
1240
|
+
dataBound?: EmitType<Object>;
|
|
1242
1241
|
|
|
1243
1242
|
/**
|
|
1244
|
-
* Triggers when record is double clicked.
|
|
1245
|
-
* @event
|
|
1246
|
-
* @blazorProperty 'OnRecordDoubleClick'
|
|
1247
|
-
*/
|
|
1248
|
-
recordDoubleClick?: EmitType<RecordDoubleClickEventArgs>;
|
|
1243
|
+
* Triggers when record is double clicked.
|
|
1244
|
+
* @event
|
|
1245
|
+
* @blazorProperty 'OnRecordDoubleClick'
|
|
1246
|
+
*/
|
|
1247
|
+
recordDoubleClick?: EmitType<RecordDoubleClickEventArgs>;
|
|
1249
1248
|
|
|
1250
1249
|
/**
|
|
1251
|
-
* Triggers when record is clicked.
|
|
1252
|
-
* @event
|
|
1253
|
-
* @blazorProperty 'OnRecordClick'
|
|
1254
|
-
*/
|
|
1255
|
-
recordClick?: EmitType<RecordClickEventArgs>;
|
|
1250
|
+
* Triggers when record is clicked.
|
|
1251
|
+
* @event
|
|
1252
|
+
* @blazorProperty 'OnRecordClick'
|
|
1253
|
+
*/
|
|
1254
|
+
recordClick?: EmitType<RecordClickEventArgs>;
|
|
1256
1255
|
|
|
1257
1256
|
/**
|
|
1258
|
-
* Triggers before row selection occurs.
|
|
1259
|
-
* @event
|
|
1260
|
-
* @blazorProperty 'RowSelecting'
|
|
1261
|
-
*/
|
|
1262
|
-
rowSelecting?: EmitType<RowSelectingEventArgs>;
|
|
1257
|
+
* Triggers before row selection occurs.
|
|
1258
|
+
* @event
|
|
1259
|
+
* @blazorProperty 'RowSelecting'
|
|
1260
|
+
*/
|
|
1261
|
+
rowSelecting?: EmitType<RowSelectingEventArgs>;
|
|
1263
1262
|
|
|
1264
1263
|
/**
|
|
1265
|
-
* Triggers after a row is selected.
|
|
1266
|
-
* @event
|
|
1267
|
-
* @blazorProperty 'RowSelected'
|
|
1268
|
-
*/
|
|
1269
|
-
rowSelected?: EmitType<RowSelectEventArgs>;
|
|
1264
|
+
* Triggers after a row is selected.
|
|
1265
|
+
* @event
|
|
1266
|
+
* @blazorProperty 'RowSelected'
|
|
1267
|
+
*/
|
|
1268
|
+
rowSelected?: EmitType<RowSelectEventArgs>;
|
|
1270
1269
|
|
|
1271
1270
|
/**
|
|
1272
|
-
* Triggers before deselecting the selected row.
|
|
1273
|
-
* @event
|
|
1274
|
-
*/
|
|
1275
|
-
rowDeselecting?: EmitType<RowDeselectEventArgs>;
|
|
1271
|
+
* Triggers before deselecting the selected row.
|
|
1272
|
+
* @event
|
|
1273
|
+
*/
|
|
1274
|
+
rowDeselecting?: EmitType<RowDeselectEventArgs>;
|
|
1276
1275
|
|
|
1277
1276
|
/**
|
|
1278
|
-
* Triggers when a selected row is deselected.
|
|
1279
|
-
* @event
|
|
1280
|
-
* @blazorProperty 'RowDeselected'
|
|
1281
|
-
*/
|
|
1282
|
-
rowDeselected?: EmitType<RowDeselectEventArgs>;
|
|
1277
|
+
* Triggers when a selected row is deselected.
|
|
1278
|
+
* @event
|
|
1279
|
+
* @blazorProperty 'RowDeselected'
|
|
1280
|
+
*/
|
|
1281
|
+
rowDeselected?: EmitType<RowDeselectEventArgs>;
|
|
1283
1282
|
|
|
1284
1283
|
/**
|
|
1285
|
-
* Triggers before any cell selection occurs.
|
|
1286
|
-
* @event
|
|
1287
|
-
* @blazorProperty 'CellSelecting'
|
|
1288
|
-
*/
|
|
1289
|
-
cellSelecting?: EmitType<CellSelectingEventArgs>;
|
|
1284
|
+
* Triggers before any cell selection occurs.
|
|
1285
|
+
* @event
|
|
1286
|
+
* @blazorProperty 'CellSelecting'
|
|
1287
|
+
*/
|
|
1288
|
+
cellSelecting?: EmitType<CellSelectingEventArgs>;
|
|
1290
1289
|
|
|
1291
1290
|
/**
|
|
1292
|
-
* Triggers after a cell is selected.
|
|
1293
|
-
* @event
|
|
1294
|
-
* @blazorProperty 'CellSelected'
|
|
1295
|
-
*/
|
|
1296
|
-
cellSelected?: EmitType<CellSelectEventArgs>;
|
|
1291
|
+
* Triggers after a cell is selected.
|
|
1292
|
+
* @event
|
|
1293
|
+
* @blazorProperty 'CellSelected'
|
|
1294
|
+
*/
|
|
1295
|
+
cellSelected?: EmitType<CellSelectEventArgs>;
|
|
1297
1296
|
|
|
1298
1297
|
/**
|
|
1299
|
-
* Triggers before the selected cell is deselecting.
|
|
1300
|
-
* @event
|
|
1301
|
-
|
|
1302
|
-
*/
|
|
1303
|
-
cellDeselecting?: EmitType<CellDeselectEventArgs>;
|
|
1298
|
+
* Triggers before the selected cell is deselecting.
|
|
1299
|
+
* @event
|
|
1300
|
+
* @deprecated
|
|
1301
|
+
*/
|
|
1302
|
+
cellDeselecting?: EmitType<CellDeselectEventArgs>;
|
|
1304
1303
|
|
|
1305
1304
|
/**
|
|
1306
|
-
* Triggers when a particular selected cell is deselected.
|
|
1307
|
-
* @event
|
|
1308
|
-
|
|
1309
|
-
*/
|
|
1310
|
-
cellDeselected?: EmitType<CellDeselectEventArgs>;
|
|
1305
|
+
* Triggers when a particular selected cell is deselected.
|
|
1306
|
+
* @event
|
|
1307
|
+
* @deprecated
|
|
1308
|
+
*/
|
|
1309
|
+
cellDeselected?: EmitType<CellDeselectEventArgs>;
|
|
1311
1310
|
|
|
1312
1311
|
/**
|
|
1313
|
-
* Triggers when column header element drag (move) starts.
|
|
1314
|
-
* @event
|
|
1315
|
-
|
|
1316
|
-
*/
|
|
1317
|
-
columnDragStart?: EmitType<ColumnDragEventArgs>;
|
|
1312
|
+
* Triggers when column header element drag (move) starts.
|
|
1313
|
+
* @event
|
|
1314
|
+
* @deprecated
|
|
1315
|
+
*/
|
|
1316
|
+
columnDragStart?: EmitType<ColumnDragEventArgs>;
|
|
1318
1317
|
|
|
1319
1318
|
/**
|
|
1320
|
-
* Triggers when column header element is dragged (moved) continuously.
|
|
1321
|
-
* @event
|
|
1322
|
-
|
|
1323
|
-
*/
|
|
1324
|
-
columnDrag?: EmitType<ColumnDragEventArgs>;
|
|
1319
|
+
* Triggers when column header element is dragged (moved) continuously.
|
|
1320
|
+
* @event
|
|
1321
|
+
* @deprecated
|
|
1322
|
+
*/
|
|
1323
|
+
columnDrag?: EmitType<ColumnDragEventArgs>;
|
|
1325
1324
|
|
|
1326
1325
|
/**
|
|
1327
|
-
* Triggers when a column header element is dropped on the target column.
|
|
1328
|
-
* @event
|
|
1329
|
-
|
|
1330
|
-
*/
|
|
1331
|
-
columnDrop?: EmitType<ColumnDragEventArgs>;
|
|
1326
|
+
* Triggers when a column header element is dropped on the target column.
|
|
1327
|
+
* @event
|
|
1328
|
+
* @deprecated
|
|
1329
|
+
*/
|
|
1330
|
+
columnDrop?: EmitType<ColumnDragEventArgs>;
|
|
1332
1331
|
|
|
1333
1332
|
/**
|
|
1334
|
-
* Triggers after print action is completed.
|
|
1335
|
-
* @event
|
|
1336
|
-
|
|
1337
|
-
*/
|
|
1338
|
-
printComplete?: EmitType<PrintEventArgs>;
|
|
1333
|
+
* Triggers after print action is completed.
|
|
1334
|
+
* @event
|
|
1335
|
+
* @deprecated
|
|
1336
|
+
*/
|
|
1337
|
+
printComplete?: EmitType<PrintEventArgs>;
|
|
1339
1338
|
|
|
1340
1339
|
/**
|
|
1341
|
-
* Triggers before the print action starts.
|
|
1342
|
-
* @event
|
|
1343
|
-
|
|
1344
|
-
*/
|
|
1345
|
-
beforePrint?: EmitType<PrintEventArgs>;
|
|
1340
|
+
* Triggers before the print action starts.
|
|
1341
|
+
* @event
|
|
1342
|
+
* @deprecated
|
|
1343
|
+
*/
|
|
1344
|
+
beforePrint?: EmitType<PrintEventArgs>;
|
|
1346
1345
|
|
|
1347
1346
|
/**
|
|
1348
|
-
* Triggers before exporting each cell to PDF document. You can also customize the PDF cells.
|
|
1349
|
-
* @event
|
|
1350
|
-
|
|
1351
|
-
*/
|
|
1352
|
-
pdfQueryCellInfo?: EmitType<PdfQueryCellInfoEventArgs>;
|
|
1347
|
+
* Triggers before exporting each cell to PDF document. You can also customize the PDF cells.
|
|
1348
|
+
* @event
|
|
1349
|
+
* @deprecated
|
|
1350
|
+
*/
|
|
1351
|
+
pdfQueryCellInfo?: EmitType<PdfQueryCellInfoEventArgs>;
|
|
1353
1352
|
|
|
1354
1353
|
/**
|
|
1355
|
-
* Triggers before exporting each header cell to PDF document. You can also customize the PDF cells.
|
|
1356
|
-
* @event
|
|
1357
|
-
|
|
1358
|
-
*/
|
|
1359
|
-
pdfHeaderQueryCellInfo?: EmitType<PdfHeaderQueryCellInfoEventArgs>;
|
|
1354
|
+
* Triggers before exporting each header cell to PDF document. You can also customize the PDF cells.
|
|
1355
|
+
* @event
|
|
1356
|
+
* @deprecated
|
|
1357
|
+
*/
|
|
1358
|
+
pdfHeaderQueryCellInfo?: EmitType<PdfHeaderQueryCellInfoEventArgs>;
|
|
1360
1359
|
|
|
1361
1360
|
/**
|
|
1362
|
-
* Triggers before exporting aggregate cell to PDF document. You can also customize the PDF cells.
|
|
1363
|
-
* @event
|
|
1364
|
-
|
|
1365
|
-
*/
|
|
1366
|
-
pdfAggregateQueryCellInfo?: EmitType<AggregateQueryCellInfoEventArgs>;
|
|
1361
|
+
* Triggers before exporting aggregate cell to PDF document. You can also customize the PDF cells.
|
|
1362
|
+
* @event
|
|
1363
|
+
* @deprecated
|
|
1364
|
+
*/
|
|
1365
|
+
pdfAggregateQueryCellInfo?: EmitType<AggregateQueryCellInfoEventArgs>;
|
|
1367
1366
|
|
|
1368
1367
|
/**
|
|
1369
|
-
* Triggers before exporting aggregate cell to Excel document. You can also customize the PDF cells.
|
|
1370
|
-
* @event
|
|
1371
|
-
|
|
1372
|
-
*/
|
|
1373
|
-
excelAggregateQueryCellInfo?: EmitType<AggregateQueryCellInfoEventArgs>;
|
|
1368
|
+
* Triggers before exporting aggregate cell to Excel document. You can also customize the PDF cells.
|
|
1369
|
+
* @event
|
|
1370
|
+
* @deprecated
|
|
1371
|
+
*/
|
|
1372
|
+
excelAggregateQueryCellInfo?: EmitType<AggregateQueryCellInfoEventArgs>;
|
|
1374
1373
|
|
|
1375
1374
|
/**
|
|
1376
|
-
* Triggers before exporting each detail Grid to PDF document.
|
|
1377
|
-
* @event
|
|
1378
|
-
|
|
1379
|
-
*/
|
|
1380
|
-
exportDetailDataBound?: EmitType<ExportDetailDataBoundEventArgs>;
|
|
1375
|
+
* Triggers before exporting each detail Grid to PDF document.
|
|
1376
|
+
* @event
|
|
1377
|
+
* @deprecated
|
|
1378
|
+
*/
|
|
1379
|
+
exportDetailDataBound?: EmitType<ExportDetailDataBoundEventArgs>;
|
|
1381
1380
|
|
|
1382
1381
|
/**
|
|
1383
|
-
* Triggers before exporting each cell to Excel file.
|
|
1384
|
-
* You can also customize the Excel cells.
|
|
1385
|
-
* @event
|
|
1386
|
-
|
|
1387
|
-
*/
|
|
1388
|
-
excelQueryCellInfo?: EmitType<ExcelQueryCellInfoEventArgs>;
|
|
1382
|
+
* Triggers before exporting each cell to Excel file.
|
|
1383
|
+
* You can also customize the Excel cells.
|
|
1384
|
+
* @event
|
|
1385
|
+
* @deprecated
|
|
1386
|
+
*/
|
|
1387
|
+
excelQueryCellInfo?: EmitType<ExcelQueryCellInfoEventArgs>;
|
|
1389
1388
|
|
|
1390
1389
|
/**
|
|
1391
|
-
* Triggers before exporting each header cell to Excel file.
|
|
1392
|
-
* You can also customize the Excel cells.
|
|
1393
|
-
* @event
|
|
1394
|
-
|
|
1395
|
-
*/
|
|
1396
|
-
excelHeaderQueryCellInfo?: EmitType<ExcelHeaderQueryCellInfoEventArgs>;
|
|
1390
|
+
* Triggers before exporting each header cell to Excel file.
|
|
1391
|
+
* You can also customize the Excel cells.
|
|
1392
|
+
* @event
|
|
1393
|
+
* @deprecated
|
|
1394
|
+
*/
|
|
1395
|
+
excelHeaderQueryCellInfo?: EmitType<ExcelHeaderQueryCellInfoEventArgs>;
|
|
1397
1396
|
|
|
1398
1397
|
/**
|
|
1399
|
-
* Triggers before Grid data is exported to Excel file.
|
|
1400
|
-
* @event
|
|
1401
|
-
|
|
1402
|
-
*/
|
|
1403
|
-
beforeExcelExport?: EmitType<Object>;
|
|
1398
|
+
* Triggers before Grid data is exported to Excel file.
|
|
1399
|
+
* @event
|
|
1400
|
+
* @deprecated
|
|
1401
|
+
*/
|
|
1402
|
+
beforeExcelExport?: EmitType<Object>;
|
|
1404
1403
|
|
|
1405
1404
|
/**
|
|
1406
|
-
* Triggers after Grid data is exported to Excel file.
|
|
1407
|
-
* @event
|
|
1408
|
-
|
|
1409
|
-
*/
|
|
1410
|
-
excelExportComplete?: EmitType<ExcelExportCompleteArgs>;
|
|
1405
|
+
* Triggers after Grid data is exported to Excel file.
|
|
1406
|
+
* @event
|
|
1407
|
+
* @deprecated
|
|
1408
|
+
*/
|
|
1409
|
+
excelExportComplete?: EmitType<ExcelExportCompleteArgs>;
|
|
1411
1410
|
|
|
1412
1411
|
/**
|
|
1413
|
-
* Triggers before Grid data is exported to PDF document.
|
|
1414
|
-
* @event
|
|
1415
|
-
* @blazorProperty 'OnPdfExport'
|
|
1416
|
-
*/
|
|
1417
|
-
beforePdfExport?: EmitType<Object>;
|
|
1412
|
+
* Triggers before Grid data is exported to PDF document.
|
|
1413
|
+
* @event
|
|
1414
|
+
* @blazorProperty 'OnPdfExport'
|
|
1415
|
+
*/
|
|
1416
|
+
beforePdfExport?: EmitType<Object>;
|
|
1418
1417
|
|
|
1419
1418
|
/**
|
|
1420
|
-
* Triggers after Grid data is exported to PDF document.
|
|
1421
|
-
* @event
|
|
1422
|
-
|
|
1423
|
-
*/
|
|
1424
|
-
pdfExportComplete?: EmitType<PdfExportCompleteArgs>;
|
|
1419
|
+
* Triggers after Grid data is exported to PDF document.
|
|
1420
|
+
* @event
|
|
1421
|
+
* @deprecated
|
|
1422
|
+
*/
|
|
1423
|
+
pdfExportComplete?: EmitType<PdfExportCompleteArgs>;
|
|
1425
1424
|
|
|
1426
1425
|
/**
|
|
1427
|
-
* Triggers when row element's before drag(move).
|
|
1428
|
-
* @event
|
|
1429
|
-
|
|
1430
|
-
*/
|
|
1431
|
-
rowDragStartHelper?: EmitType<RowDragEventArgs>;
|
|
1426
|
+
* Triggers when row element's before drag(move).
|
|
1427
|
+
* @event
|
|
1428
|
+
* @deprecated
|
|
1429
|
+
*/
|
|
1430
|
+
rowDragStartHelper?: EmitType<RowDragEventArgs>;
|
|
1432
1431
|
|
|
1433
1432
|
/**
|
|
1434
|
-
* Triggers after detail row expands.
|
|
1435
|
-
* > This event triggers at initial expand.
|
|
1436
|
-
* @event
|
|
1437
|
-
* @blazorProperty 'DetailDataBound'
|
|
1438
|
-
*/
|
|
1439
|
-
detailDataBound?: EmitType<DetailDataBoundEventArgs>;
|
|
1433
|
+
* Triggers after detail row expands.
|
|
1434
|
+
* > This event triggers at initial expand.
|
|
1435
|
+
* @event
|
|
1436
|
+
* @blazorProperty 'DetailDataBound'
|
|
1437
|
+
*/
|
|
1438
|
+
detailDataBound?: EmitType<DetailDataBoundEventArgs>;
|
|
1440
1439
|
|
|
1441
1440
|
/**
|
|
1442
|
-
* Triggers when row element's drag(move) starts.
|
|
1443
|
-
* @event
|
|
1444
|
-
* @blazorProperty 'RowDrag'
|
|
1445
|
-
*/
|
|
1446
|
-
rowDragStart?: EmitType<RowDragEventArgs>;
|
|
1441
|
+
* Triggers when row element's drag(move) starts.
|
|
1442
|
+
* @event
|
|
1443
|
+
* @blazorProperty 'RowDrag'
|
|
1444
|
+
*/
|
|
1445
|
+
rowDragStart?: EmitType<RowDragEventArgs>;
|
|
1447
1446
|
|
|
1448
1447
|
/**
|
|
1449
|
-
* Triggers when row elements are dragged (moved) continuously.
|
|
1450
|
-
* @event
|
|
1451
|
-
|
|
1452
|
-
*/
|
|
1453
|
-
rowDrag?: EmitType<RowDragEventArgs>;
|
|
1448
|
+
* Triggers when row elements are dragged (moved) continuously.
|
|
1449
|
+
* @event
|
|
1450
|
+
* @deprecated
|
|
1451
|
+
*/
|
|
1452
|
+
rowDrag?: EmitType<RowDragEventArgs>;
|
|
1454
1453
|
|
|
1455
1454
|
/**
|
|
1456
|
-
* Triggers when row elements are dropped on the target row.
|
|
1457
|
-
* @event
|
|
1458
|
-
* @blazorProperty 'RowDrop'
|
|
1459
|
-
*/
|
|
1460
|
-
rowDrop?: EmitType<RowDragEventArgs>;
|
|
1455
|
+
* Triggers when row elements are dropped on the target row.
|
|
1456
|
+
* @event
|
|
1457
|
+
* @blazorProperty 'RowDrop'
|
|
1458
|
+
*/
|
|
1459
|
+
rowDrop?: EmitType<RowDragEventArgs>;
|
|
1461
1460
|
|
|
1462
1461
|
/**
|
|
1463
|
-
* Triggers when toolbar item is clicked.
|
|
1464
|
-
* @event
|
|
1465
|
-
* @blazorProperty 'OnToolbarClick'
|
|
1466
|
-
* @blazorType Syncfusion.Blazor.Navigations.ClickEventArgs
|
|
1467
|
-
*/
|
|
1468
|
-
toolbarClick?: EmitType<ClickEventArgs>;
|
|
1462
|
+
* Triggers when toolbar item is clicked.
|
|
1463
|
+
* @event
|
|
1464
|
+
* @blazorProperty 'OnToolbarClick'
|
|
1465
|
+
* @blazorType Syncfusion.Blazor.Navigations.ClickEventArgs
|
|
1466
|
+
*/
|
|
1467
|
+
toolbarClick?: EmitType<ClickEventArgs>;
|
|
1469
1468
|
|
|
1470
1469
|
/**
|
|
1471
|
-
* Triggers before the columnChooser open.
|
|
1472
|
-
* @event
|
|
1473
|
-
|
|
1474
|
-
*/
|
|
1475
|
-
beforeOpenColumnChooser?: EmitType<ColumnChooserEventArgs>;
|
|
1470
|
+
* Triggers before the columnChooser open.
|
|
1471
|
+
* @event
|
|
1472
|
+
* @deprecated
|
|
1473
|
+
*/
|
|
1474
|
+
beforeOpenColumnChooser?: EmitType<ColumnChooserEventArgs>;
|
|
1476
1475
|
|
|
1477
1476
|
/**
|
|
1478
|
-
* Triggers when records are added in batch mode.
|
|
1479
|
-
* @event
|
|
1480
|
-
|
|
1481
|
-
*/
|
|
1482
|
-
batchAdd?: EmitType<BatchAddArgs>;
|
|
1477
|
+
* Triggers when records are added in batch mode.
|
|
1478
|
+
* @event
|
|
1479
|
+
* @deprecated
|
|
1480
|
+
*/
|
|
1481
|
+
batchAdd?: EmitType<BatchAddArgs>;
|
|
1483
1482
|
|
|
1484
1483
|
/**
|
|
1485
|
-
* Triggers when records are deleted in batch mode.
|
|
1486
|
-
* @event
|
|
1487
|
-
|
|
1488
|
-
*/
|
|
1489
|
-
batchDelete?: EmitType<BatchDeleteArgs>;
|
|
1484
|
+
* Triggers when records are deleted in batch mode.
|
|
1485
|
+
* @event
|
|
1486
|
+
* @deprecated
|
|
1487
|
+
*/
|
|
1488
|
+
batchDelete?: EmitType<BatchDeleteArgs>;
|
|
1490
1489
|
|
|
1491
1490
|
/**
|
|
1492
|
-
* Triggers when cancel the batch edit changes batch mode.
|
|
1493
|
-
* @event
|
|
1494
|
-
|
|
1495
|
-
*/
|
|
1496
|
-
batchCancel?: EmitType<BatchCancelArgs>;
|
|
1491
|
+
* Triggers when cancel the batch edit changes batch mode.
|
|
1492
|
+
* @event
|
|
1493
|
+
* @deprecated
|
|
1494
|
+
*/
|
|
1495
|
+
batchCancel?: EmitType<BatchCancelArgs>;
|
|
1497
1496
|
|
|
1498
1497
|
/**
|
|
1499
|
-
* Triggers before records are added in batch mode.
|
|
1500
|
-
* @event
|
|
1501
|
-
* @blazorProperty 'OnBatchAdd'
|
|
1502
|
-
*/
|
|
1503
|
-
beforeBatchAdd?: EmitType<BeforeBatchAddArgs>;
|
|
1498
|
+
* Triggers before records are added in batch mode.
|
|
1499
|
+
* @event
|
|
1500
|
+
* @blazorProperty 'OnBatchAdd'
|
|
1501
|
+
*/
|
|
1502
|
+
beforeBatchAdd?: EmitType<BeforeBatchAddArgs>;
|
|
1504
1503
|
|
|
1505
1504
|
/**
|
|
1506
|
-
* Triggers before records are deleted in batch mode.
|
|
1507
|
-
* @event
|
|
1508
|
-
* @blazorProperty 'OnBatchDelete'
|
|
1509
|
-
*/
|
|
1510
|
-
beforeBatchDelete?: EmitType<BeforeBatchDeleteArgs>;
|
|
1505
|
+
* Triggers before records are deleted in batch mode.
|
|
1506
|
+
* @event
|
|
1507
|
+
* @blazorProperty 'OnBatchDelete'
|
|
1508
|
+
*/
|
|
1509
|
+
beforeBatchDelete?: EmitType<BeforeBatchDeleteArgs>;
|
|
1511
1510
|
|
|
1512
1511
|
/**
|
|
1513
|
-
* Triggers before records are saved in batch mode.
|
|
1514
|
-
* @event
|
|
1515
|
-
* @blazorProperty 'OnBatchSave'
|
|
1516
|
-
*/
|
|
1517
|
-
beforeBatchSave?: EmitType<BeforeBatchSaveArgs>;
|
|
1512
|
+
* Triggers before records are saved in batch mode.
|
|
1513
|
+
* @event
|
|
1514
|
+
* @blazorProperty 'OnBatchSave'
|
|
1515
|
+
*/
|
|
1516
|
+
beforeBatchSave?: EmitType<BeforeBatchSaveArgs>;
|
|
1518
1517
|
|
|
1519
1518
|
/**
|
|
1520
|
-
* Triggers before the record is to be edit.
|
|
1521
|
-
* @event
|
|
1522
|
-
* @blazorProperty 'OnBeginEdit'
|
|
1523
|
-
*/
|
|
1524
|
-
beginEdit?: EmitType<BeginEditArgs>;
|
|
1519
|
+
* Triggers before the record is to be edit.
|
|
1520
|
+
* @event
|
|
1521
|
+
* @blazorProperty 'OnBeginEdit'
|
|
1522
|
+
*/
|
|
1523
|
+
beginEdit?: EmitType<BeginEditArgs>;
|
|
1525
1524
|
|
|
1526
1525
|
/**
|
|
1527
|
-
* Triggers when command button is clicked.
|
|
1528
|
-
* @event
|
|
1529
|
-
* @blazorProperty 'CommandClicked'
|
|
1530
|
-
*/
|
|
1531
|
-
commandClick?: EmitType<CommandClickEventArgs>;
|
|
1526
|
+
* Triggers when command button is clicked.
|
|
1527
|
+
* @event
|
|
1528
|
+
* @blazorProperty 'CommandClicked'
|
|
1529
|
+
*/
|
|
1530
|
+
commandClick?: EmitType<CommandClickEventArgs>;
|
|
1532
1531
|
|
|
1533
1532
|
/**
|
|
1534
|
-
* Triggers when the cell is being edited.
|
|
1535
|
-
* @event
|
|
1536
|
-
* @blazorProperty 'OnCellEdit'
|
|
1537
|
-
*/
|
|
1538
|
-
cellEdit?: EmitType<CellEditArgs>;
|
|
1533
|
+
* Triggers when the cell is being edited.
|
|
1534
|
+
* @event
|
|
1535
|
+
* @blazorProperty 'OnCellEdit'
|
|
1536
|
+
*/
|
|
1537
|
+
cellEdit?: EmitType<CellEditArgs>;
|
|
1539
1538
|
|
|
1540
1539
|
/**
|
|
1541
|
-
* Triggers when cell is saved.
|
|
1542
|
-
* @event
|
|
1543
|
-
* @blazorProperty 'OnCellSave'
|
|
1544
|
-
*/
|
|
1545
|
-
cellSave?: EmitType<CellSaveArgs>;
|
|
1540
|
+
* Triggers when cell is saved.
|
|
1541
|
+
* @event
|
|
1542
|
+
* @blazorProperty 'OnCellSave'
|
|
1543
|
+
*/
|
|
1544
|
+
cellSave?: EmitType<CellSaveArgs>;
|
|
1546
1545
|
|
|
1547
1546
|
/**
|
|
1548
|
-
* Triggers when cell is saved.
|
|
1549
|
-
* @event
|
|
1550
|
-
* @blazorProperty 'CellSaved'
|
|
1551
|
-
*/
|
|
1552
|
-
cellSaved?: EmitType<CellSaveArgs>;
|
|
1547
|
+
* Triggers when cell is saved.
|
|
1548
|
+
* @event
|
|
1549
|
+
* @blazorProperty 'CellSaved'
|
|
1550
|
+
*/
|
|
1551
|
+
cellSaved?: EmitType<CellSaveArgs>;
|
|
1553
1552
|
|
|
1554
1553
|
/**
|
|
1555
|
-
* Triggers when column resize starts.
|
|
1556
|
-
* @event
|
|
1557
|
-
* @blazorProperty 'OnResizeStart'
|
|
1558
|
-
*/
|
|
1559
|
-
resizeStart?: EmitType<ResizeArgs>;
|
|
1554
|
+
* Triggers when column resize starts.
|
|
1555
|
+
* @event
|
|
1556
|
+
* @blazorProperty 'OnResizeStart'
|
|
1557
|
+
*/
|
|
1558
|
+
resizeStart?: EmitType<ResizeArgs>;
|
|
1560
1559
|
|
|
1561
1560
|
/**
|
|
1562
|
-
* Triggers on column resizing.
|
|
1563
|
-
* @event
|
|
1564
|
-
|
|
1565
|
-
*/
|
|
1566
|
-
resizing?: EmitType<ResizeArgs>;
|
|
1561
|
+
* Triggers on column resizing.
|
|
1562
|
+
* @event
|
|
1563
|
+
* @deprecated
|
|
1564
|
+
*/
|
|
1565
|
+
resizing?: EmitType<ResizeArgs>;
|
|
1567
1566
|
|
|
1568
1567
|
/**
|
|
1569
|
-
* Triggers when column resize ends.
|
|
1570
|
-
* @event
|
|
1571
|
-
* @blazorProperty 'ResizeStopped'
|
|
1572
|
-
*/
|
|
1573
|
-
resizeStop?: EmitType<ResizeArgs>;
|
|
1568
|
+
* Triggers when column resize ends.
|
|
1569
|
+
* @event
|
|
1570
|
+
* @blazorProperty 'ResizeStopped'
|
|
1571
|
+
*/
|
|
1572
|
+
resizeStop?: EmitType<ResizeArgs>;
|
|
1574
1573
|
|
|
1575
1574
|
/**
|
|
1576
|
-
* Triggers when any keyboard keys are pressed inside the grid.
|
|
1577
|
-
* @event
|
|
1578
|
-
|
|
1579
|
-
*/
|
|
1580
|
-
keyPressed?: EmitType<KeyboardEventArgs>;
|
|
1575
|
+
* Triggers when any keyboard keys are pressed inside the grid.
|
|
1576
|
+
* @event
|
|
1577
|
+
* @deprecated
|
|
1578
|
+
*/
|
|
1579
|
+
keyPressed?: EmitType<KeyboardEventArgs>;
|
|
1581
1580
|
|
|
1582
1581
|
/**
|
|
1583
|
-
* Triggers before data is bound to Grid.
|
|
1584
|
-
* @event
|
|
1585
|
-
* @blazorProperty 'OnDataBound'
|
|
1586
|
-
*/
|
|
1587
|
-
beforeDataBound?: EmitType<BeforeDataBoundArgs>;
|
|
1582
|
+
* Triggers before data is bound to Grid.
|
|
1583
|
+
* @event
|
|
1584
|
+
* @blazorProperty 'OnDataBound'
|
|
1585
|
+
*/
|
|
1586
|
+
beforeDataBound?: EmitType<BeforeDataBoundArgs>;
|
|
1588
1587
|
|
|
1589
1588
|
/**
|
|
1590
|
-
* Triggers before context menu opens.
|
|
1591
|
-
* @event
|
|
1592
|
-
|
|
1593
|
-
*/
|
|
1594
|
-
contextMenuOpen?: EmitType<BeforeOpenCloseMenuEventArgs>;
|
|
1589
|
+
* Triggers before context menu opens.
|
|
1590
|
+
* @event
|
|
1591
|
+
* @deprecated
|
|
1592
|
+
*/
|
|
1593
|
+
contextMenuOpen?: EmitType<BeforeOpenCloseMenuEventArgs>;
|
|
1595
1594
|
|
|
1596
1595
|
/**
|
|
1597
|
-
* Triggers when click on context menu.
|
|
1598
|
-
* @event
|
|
1599
|
-
* @blazorProperty 'ContextMenuItemClicked'
|
|
1600
|
-
* @blazorType ContextMenuClickEventArgs
|
|
1601
|
-
*/
|
|
1602
|
-
contextMenuClick?: EmitType<MenuEventArgs>;
|
|
1596
|
+
* Triggers when click on context menu.
|
|
1597
|
+
* @event
|
|
1598
|
+
* @blazorProperty 'ContextMenuItemClicked'
|
|
1599
|
+
* @blazorType ContextMenuClickEventArgs
|
|
1600
|
+
*/
|
|
1601
|
+
contextMenuClick?: EmitType<MenuEventArgs>;
|
|
1603
1602
|
|
|
1604
1603
|
/**
|
|
1605
|
-
* Triggers before column menu opens.
|
|
1606
|
-
* @event
|
|
1607
|
-
|
|
1608
|
-
*/
|
|
1609
|
-
columnMenuOpen?: EmitType<ColumnMenuOpenEventArgs>;
|
|
1604
|
+
* Triggers before column menu opens.
|
|
1605
|
+
* @event
|
|
1606
|
+
* @deprecated
|
|
1607
|
+
*/
|
|
1608
|
+
columnMenuOpen?: EmitType<ColumnMenuOpenEventArgs>;
|
|
1610
1609
|
|
|
1611
1610
|
/**
|
|
1612
|
-
* Triggers when click on column menu.
|
|
1613
|
-
* @event
|
|
1614
|
-
* @blazorProperty 'ColumnMenuItemClicked'
|
|
1615
|
-
* @blazorType ColumnMenuClickEventArgs
|
|
1616
|
-
*/
|
|
1617
|
-
columnMenuClick?: EmitType<MenuEventArgs>;
|
|
1611
|
+
* Triggers when click on column menu.
|
|
1612
|
+
* @event
|
|
1613
|
+
* @blazorProperty 'ColumnMenuItemClicked'
|
|
1614
|
+
* @blazorType ColumnMenuClickEventArgs
|
|
1615
|
+
*/
|
|
1616
|
+
columnMenuClick?: EmitType<MenuEventArgs>;
|
|
1618
1617
|
|
|
1619
1618
|
/**
|
|
1620
|
-
* Triggers when the check box state change in checkbox column.
|
|
1621
|
-
* @event
|
|
1622
|
-
|
|
1623
|
-
*/
|
|
1624
|
-
checkBoxChange?: EmitType<CheckBoxChangeEventArgs>;
|
|
1619
|
+
* Triggers when the check box state change in checkbox column.
|
|
1620
|
+
* @event
|
|
1621
|
+
* @deprecated
|
|
1622
|
+
*/
|
|
1623
|
+
checkBoxChange?: EmitType<CheckBoxChangeEventArgs>;
|
|
1625
1624
|
|
|
1626
1625
|
/**
|
|
1627
|
-
* Triggers before Grid copy action.
|
|
1628
|
-
* @event
|
|
1629
|
-
|
|
1630
|
-
*/
|
|
1631
|
-
beforeCopy?: EmitType<BeforeCopyEventArgs>;
|
|
1626
|
+
* Triggers before Grid copy action.
|
|
1627
|
+
* @event
|
|
1628
|
+
* @deprecated
|
|
1629
|
+
*/
|
|
1630
|
+
beforeCopy?: EmitType<BeforeCopyEventArgs>;
|
|
1632
1631
|
|
|
1633
1632
|
/**
|
|
1634
|
-
* Triggers before Grid paste action.
|
|
1635
|
-
* @event
|
|
1636
|
-
|
|
1637
|
-
*/
|
|
1638
|
-
beforePaste?: EmitType<BeforePasteEventArgs>;
|
|
1633
|
+
* Triggers before Grid paste action.
|
|
1634
|
+
* @event
|
|
1635
|
+
* @deprecated
|
|
1636
|
+
*/
|
|
1637
|
+
beforePaste?: EmitType<BeforePasteEventArgs>;
|
|
1639
1638
|
|
|
1640
1639
|
/**
|
|
1641
|
-
* Triggers before Grid autoFill action.
|
|
1642
|
-
* @event
|
|
1643
|
-
|
|
1644
|
-
*/
|
|
1645
|
-
beforeAutoFill?: EmitType<BeforeAutoFillEventArgs>;
|
|
1640
|
+
* Triggers before Grid autoFill action.
|
|
1641
|
+
* @event
|
|
1642
|
+
* @deprecated
|
|
1643
|
+
*/
|
|
1644
|
+
beforeAutoFill?: EmitType<BeforeAutoFillEventArgs>;
|
|
1646
1645
|
|
|
1647
1646
|
/**
|
|
1648
|
-
* Triggers when the grid actions such as Sorting, Paging, Grouping etc., are done to get column `dataSource`.
|
|
1649
|
-
* In this event,the current view column data and total record count should be assigned to the column `dataSource` based
|
|
1650
|
-
* on the action performed.
|
|
1651
|
-
* @event
|
|
1652
|
-
|
|
1653
|
-
*/
|
|
1654
|
-
columnDataStateChange?: EmitType<ColumnDataStateChangeEventArgs>;
|
|
1647
|
+
* Triggers when the grid actions such as Sorting, Paging, Grouping etc., are done to get column `dataSource`.
|
|
1648
|
+
* In this event,the current view column data and total record count should be assigned to the column `dataSource` based
|
|
1649
|
+
* on the action performed.
|
|
1650
|
+
* @event
|
|
1651
|
+
* @deprecated
|
|
1652
|
+
*/
|
|
1653
|
+
columnDataStateChange?: EmitType<ColumnDataStateChangeEventArgs>;
|
|
1655
1654
|
|
|
1656
1655
|
/**
|
|
1657
|
-
* Triggers when the grid actions such as Sorting, Paging, Grouping etc., are done.
|
|
1658
|
-
* In this event,the current view data and total record count should be assigned to the `dataSource` based on the action performed.
|
|
1659
|
-
* @event
|
|
1660
|
-
|
|
1661
|
-
*/
|
|
1662
|
-
dataStateChange?: EmitType<DataStateChangeEventArgs>;
|
|
1656
|
+
* Triggers when the grid actions such as Sorting, Paging, Grouping etc., are done.
|
|
1657
|
+
* In this event,the current view data and total record count should be assigned to the `dataSource` based on the action performed.
|
|
1658
|
+
* @event
|
|
1659
|
+
* @deprecated
|
|
1660
|
+
*/
|
|
1661
|
+
dataStateChange?: EmitType<DataStateChangeEventArgs>;
|
|
1663
1662
|
|
|
1664
1663
|
/**
|
|
1665
|
-
* Triggers when the grid data is added, deleted and updated.
|
|
1666
|
-
* Invoke the done method from the argument to start render after edit operation.
|
|
1667
|
-
* @event
|
|
1668
|
-
|
|
1669
|
-
*/
|
|
1670
|
-
dataSourceChanged?: EmitType<DataSourceChangedEventArgs>;
|
|
1664
|
+
* Triggers when the grid data is added, deleted and updated.
|
|
1665
|
+
* Invoke the done method from the argument to start render after edit operation.
|
|
1666
|
+
* @event
|
|
1667
|
+
* @deprecated
|
|
1668
|
+
*/
|
|
1669
|
+
dataSourceChanged?: EmitType<DataSourceChangedEventArgs>;
|
|
1671
1670
|
|
|
1672
1671
|
/**
|
|
1673
|
-
* Triggers before exporting each caption row to PDF/Excel/CSV document. You can also customize the export caption row values.
|
|
1674
|
-
* @event
|
|
1675
|
-
|
|
1676
|
-
*/
|
|
1677
|
-
exportGroupCaption?: EmitType<ExportGroupCaptionEventArgs>;
|
|
1672
|
+
* Triggers before exporting each caption row to PDF/Excel/CSV document. You can also customize the export caption row values.
|
|
1673
|
+
* @event
|
|
1674
|
+
* @deprecated
|
|
1675
|
+
*/
|
|
1676
|
+
exportGroupCaption?: EmitType<ExportGroupCaptionEventArgs>;
|
|
1678
1677
|
|
|
1679
1678
|
/**
|
|
1680
|
-
* Triggers when expand the caption row in lazy load grouping.
|
|
1681
|
-
* @event
|
|
1682
|
-
|
|
1683
|
-
*/
|
|
1684
|
-
lazyLoadGroupExpand?: EmitType<LazyLoadArgs>;
|
|
1679
|
+
* Triggers when expand the caption row in lazy load grouping.
|
|
1680
|
+
* @event
|
|
1681
|
+
* @deprecated
|
|
1682
|
+
*/
|
|
1683
|
+
lazyLoadGroupExpand?: EmitType<LazyLoadArgs>;
|
|
1685
1684
|
|
|
1686
1685
|
/**
|
|
1687
|
-
* Triggers when collapse the caption row in lazy load grouping.
|
|
1688
|
-
* @event
|
|
1689
|
-
|
|
1690
|
-
*/
|
|
1691
|
-
lazyLoadGroupCollapse?: EmitType<LazyLoadArgs>;
|
|
1686
|
+
* Triggers when collapse the caption row in lazy load grouping.
|
|
1687
|
+
* @event
|
|
1688
|
+
* @deprecated
|
|
1689
|
+
*/
|
|
1690
|
+
lazyLoadGroupCollapse?: EmitType<LazyLoadArgs>;
|
|
1692
1691
|
|
|
1693
1692
|
}
|