@syncfusion/ej2-grids 20.3.47-54738 → 20.3.47-54739

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (161) hide show
  1. package/dist/ej2-grids.min.js +1 -0
  2. package/helpers/e2e/gridhelper.d.ts +59 -0
  3. package/helpers/e2e/index.d.ts +1 -0
  4. package/package.json +1 -1
  5. package/src/components.d.ts +5 -0
  6. package/src/grid/actions/aggregate.d.ts +31 -0
  7. package/src/grid/actions/batch-edit.d.ts +116 -0
  8. package/src/grid/actions/blazor-action.d.ts +47 -0
  9. package/src/grid/actions/checkbox-filter.d.ts +47 -0
  10. package/src/grid/actions/clipboard.d.ts +69 -0
  11. package/src/grid/actions/column-chooser.d.ts +114 -0
  12. package/src/grid/actions/column-menu.d.ts +99 -0
  13. package/src/grid/actions/command-column.d.ts +31 -0
  14. package/src/grid/actions/context-menu.d.ts +102 -0
  15. package/src/grid/actions/data.d.ts +110 -0
  16. package/src/grid/actions/detail-row.d.ts +73 -0
  17. package/src/grid/actions/dialog-edit.d.ts +21 -0
  18. package/src/grid/actions/edit.d.ts +271 -0
  19. package/src/grid/actions/excel-export.d.ts +89 -0
  20. package/src/grid/actions/excel-filter.d.ts +53 -0
  21. package/src/grid/actions/export-helper.d.ts +67 -0
  22. package/src/grid/actions/filter.d.ts +253 -0
  23. package/src/grid/actions/foreign-key.d.ts +20 -0
  24. package/src/grid/actions/freeze.d.ts +17 -0
  25. package/src/grid/actions/group.d.ts +178 -0
  26. package/src/grid/actions/infinite-scroll.d.ts +146 -0
  27. package/src/grid/actions/inline-edit.d.ts +21 -0
  28. package/src/grid/actions/lazy-load-group.d.ts +40 -0
  29. package/src/grid/actions/logger.d.ts +30 -0
  30. package/src/grid/actions/normal-edit.d.ts +76 -0
  31. package/src/grid/actions/page.d.ts +117 -0
  32. package/src/grid/actions/pdf-export.d.ts +142 -0
  33. package/src/grid/actions/print.d.ts +67 -0
  34. package/src/grid/actions/reorder.d.ts +95 -0
  35. package/src/grid/actions/resize.d.ts +117 -0
  36. package/src/grid/actions/row-reorder.d.ts +92 -0
  37. package/src/grid/actions/scroll.d.ts +114 -0
  38. package/src/grid/actions/search.d.ts +72 -0
  39. package/src/grid/actions/selection.d.ts +481 -0
  40. package/src/grid/actions/show-hide.d.ts +55 -0
  41. package/src/grid/actions/sort.d.ts +138 -0
  42. package/src/grid/actions/toolbar.d.ts +84 -0
  43. package/src/grid/actions/virtual-scroll.d.ts +23 -0
  44. package/src/grid/actions.d.ts +39 -0
  45. package/src/grid/aggregate.d.ts +4 -0
  46. package/src/grid/base/constant.d.ts +559 -0
  47. package/src/grid/base/enum.d.ts +704 -0
  48. package/src/grid/base/grid.d.ts +3627 -0
  49. package/src/grid/base/interface.d.ts +2567 -0
  50. package/src/grid/base/string-literals.d.ts +87 -0
  51. package/src/grid/base/type.d.ts +42 -0
  52. package/src/grid/base/util.d.ts +747 -0
  53. package/src/grid/base.d.ts +11 -0
  54. package/src/grid/column-chooser.d.ts +4 -0
  55. package/src/grid/column-menu.d.ts +4 -0
  56. package/src/grid/command-column.d.ts +4 -0
  57. package/src/grid/common/checkbox-filter-base.d.ts +137 -0
  58. package/src/grid/common/excel-filter-base.d.ts +115 -0
  59. package/src/grid/common/filter-interface.d.ts +42 -0
  60. package/src/grid/common/index.d.ts +5 -0
  61. package/src/grid/common.d.ts +6 -0
  62. package/src/grid/context-menu.d.ts +4 -0
  63. package/src/grid/detail-row.d.ts +4 -0
  64. package/src/grid/edit.d.ts +4 -0
  65. package/src/grid/excel-export.d.ts +4 -0
  66. package/src/grid/filter.d.ts +4 -0
  67. package/src/grid/foreign-key.d.ts +4 -0
  68. package/src/grid/freeze.d.ts +4 -0
  69. package/src/grid/group.d.ts +4 -0
  70. package/src/grid/index.d.ts +9 -0
  71. package/src/grid/infinite-scroll.d.ts +4 -0
  72. package/src/grid/lazy-load-group.d.ts +4 -0
  73. package/src/grid/logger.d.ts +4 -0
  74. package/src/grid/models/aggregate.d.ts +138 -0
  75. package/src/grid/models/cell.d.ts +38 -0
  76. package/src/grid/models/column-chooser-settings.d.ts +20 -0
  77. package/src/grid/models/column.d.ts +1122 -0
  78. package/src/grid/models/models.d.ts +7 -0
  79. package/src/grid/models/page-settings.d.ts +55 -0
  80. package/src/grid/models/row.d.ts +62 -0
  81. package/src/grid/models.d.ts +7 -0
  82. package/src/grid/page.d.ts +4 -0
  83. package/src/grid/pdf-export.d.ts +4 -0
  84. package/src/grid/renderer/autocomplete-edit-cell.d.ts +20 -0
  85. package/src/grid/renderer/batch-edit-renderer.d.ts +23 -0
  86. package/src/grid/renderer/boolean-edit-cell.d.ts +30 -0
  87. package/src/grid/renderer/boolean-filter-ui.d.ts +42 -0
  88. package/src/grid/renderer/caption-cell-renderer.d.ts +45 -0
  89. package/src/grid/renderer/cell-merge-renderer.d.ts +23 -0
  90. package/src/grid/renderer/cell-renderer.d.ts +91 -0
  91. package/src/grid/renderer/column-freeze-renderer.d.ts +166 -0
  92. package/src/grid/renderer/combobox-edit-cell.d.ts +19 -0
  93. package/src/grid/renderer/command-column-renderer.d.ts +31 -0
  94. package/src/grid/renderer/content-renderer.d.ts +210 -0
  95. package/src/grid/renderer/date-filter-ui.d.ts +31 -0
  96. package/src/grid/renderer/datepicker-edit-cell.d.ts +20 -0
  97. package/src/grid/renderer/default-edit-cell.d.ts +22 -0
  98. package/src/grid/renderer/detail-expand-cell-renderer.d.ts +21 -0
  99. package/src/grid/renderer/detail-header-indent-renderer.d.ts +20 -0
  100. package/src/grid/renderer/dialog-edit-renderer.d.ts +39 -0
  101. package/src/grid/renderer/dropdown-edit-cell.d.ts +32 -0
  102. package/src/grid/renderer/edit-cell-base.d.ts +25 -0
  103. package/src/grid/renderer/edit-renderer.d.ts +35 -0
  104. package/src/grid/renderer/expand-cell-renderer.d.ts +28 -0
  105. package/src/grid/renderer/filter-cell-renderer.d.ts +36 -0
  106. package/src/grid/renderer/filter-menu-operator.d.ts +43 -0
  107. package/src/grid/renderer/filter-menu-renderer.d.ts +65 -0
  108. package/src/grid/renderer/footer-renderer.d.ts +50 -0
  109. package/src/grid/renderer/freeze-renderer.d.ts +142 -0
  110. package/src/grid/renderer/group-lazy-load-renderer.d.ts +177 -0
  111. package/src/grid/renderer/header-cell-renderer.d.ts +54 -0
  112. package/src/grid/renderer/header-indent-renderer.d.ts +20 -0
  113. package/src/grid/renderer/header-renderer.d.ts +156 -0
  114. package/src/grid/renderer/indent-cell-renderer.d.ts +20 -0
  115. package/src/grid/renderer/inline-edit-renderer.d.ts +39 -0
  116. package/src/grid/renderer/inputmask-edit-cell.d.ts +18 -0
  117. package/src/grid/renderer/multiselect-edit-cell.d.ts +18 -0
  118. package/src/grid/renderer/number-filter-ui.d.ts +30 -0
  119. package/src/grid/renderer/numeric-edit-cell.d.ts +27 -0
  120. package/src/grid/renderer/render.d.ts +104 -0
  121. package/src/grid/renderer/responsive-dialog-renderer.d.ts +84 -0
  122. package/src/grid/renderer/row-drag-drop-renderer.d.ts +20 -0
  123. package/src/grid/renderer/row-drag-header-indent-render.d.ts +20 -0
  124. package/src/grid/renderer/row-renderer.d.ts +55 -0
  125. package/src/grid/renderer/stacked-cell-renderer.d.ts +23 -0
  126. package/src/grid/renderer/string-filter-ui.d.ts +39 -0
  127. package/src/grid/renderer/summary-cell-renderer.d.ts +15 -0
  128. package/src/grid/renderer/template-edit-cell.d.ts +13 -0
  129. package/src/grid/renderer/timepicker-edit-cell.d.ts +18 -0
  130. package/src/grid/renderer/toggleswitch-edit-cell.d.ts +27 -0
  131. package/src/grid/renderer/virtual-content-renderer.d.ts +221 -0
  132. package/src/grid/renderer/virtual-freeze-renderer.d.ts +382 -0
  133. package/src/grid/renderer.d.ts +42 -0
  134. package/src/grid/reorder.d.ts +4 -0
  135. package/src/grid/resize.d.ts +4 -0
  136. package/src/grid/row-reorder.d.ts +4 -0
  137. package/src/grid/selection.d.ts +4 -0
  138. package/src/grid/services/aria-service.d.ts +34 -0
  139. package/src/grid/services/cell-render-factory.d.ts +14 -0
  140. package/src/grid/services/focus-strategy.d.ts +192 -0
  141. package/src/grid/services/freeze-row-model-generator.d.ts +14 -0
  142. package/src/grid/services/group-model-generator.d.ts +68 -0
  143. package/src/grid/services/intersection-observer.d.ts +23 -0
  144. package/src/grid/services/renderer-factory.d.ts +14 -0
  145. package/src/grid/services/row-model-generator.d.ts +41 -0
  146. package/src/grid/services/service-locator.d.ts +14 -0
  147. package/src/grid/services/summary-model-generator.d.ts +43 -0
  148. package/src/grid/services/value-formatter.d.ts +16 -0
  149. package/src/grid/services/virtual-row-model-generator.d.ts +55 -0
  150. package/src/grid/services/width-controller.d.ts +35 -0
  151. package/src/grid/services.d.ts +11 -0
  152. package/src/grid/sort.d.ts +4 -0
  153. package/src/grid/toolbar.d.ts +4 -0
  154. package/src/grid/virtual-scroll.d.ts +4 -0
  155. package/src/index.d.ts +5 -0
  156. package/src/pager/external-message.d.ts +55 -0
  157. package/src/pager/index.d.ts +9 -0
  158. package/src/pager/numeric-container.d.ts +78 -0
  159. package/src/pager/pager-dropdown.d.ts +68 -0
  160. package/src/pager/pager-message.d.ts +50 -0
  161. package/src/pager/pager.d.ts +341 -0
@@ -0,0 +1,3627 @@
1
+ import { Component, ModuleDeclaration, ChildProperty, TouchEventArgs } from '@syncfusion/ej2-base';
2
+ import { INotifyPropertyChanged, L10n } from '@syncfusion/ej2-base';
3
+ import { KeyboardEvents, EmitType } from '@syncfusion/ej2-base';
4
+ import { Query, DataManager } from '@syncfusion/ej2-data';
5
+ import { ItemModel, ClickEventArgs } from '@syncfusion/ej2-navigations';
6
+ import { GridModel, ResizeSettingsModel } from './grid-model';
7
+ import { ReturnType, BatchChanges } from '../base/type';
8
+ import { IDialogUI, ScrollPositionType, ActionArgs, ExportGroupCaptionEventArgs, FilterUI, LazyLoadArgs } from './interface';
9
+ import { AggregateQueryCellInfoEventArgs } from './interface';
10
+ import { IRenderer, IValueFormatter, IFilterOperator, IIndex, RowDataBoundEventArgs, QueryCellInfoEventArgs } from './interface';
11
+ import { CellDeselectEventArgs, CellSelectEventArgs, CellSelectingEventArgs, ParentDetails, ContextMenuItemModel } from './interface';
12
+ import { PdfQueryCellInfoEventArgs, ExcelQueryCellInfoEventArgs, ExcelExportProperties, PdfExportProperties } from './interface';
13
+ import { PdfHeaderQueryCellInfoEventArgs, ExcelHeaderQueryCellInfoEventArgs, ExportDetailDataBoundEventArgs } from './interface';
14
+ import { ColumnMenuOpenEventArgs, BatchCancelArgs, RecordDoubleClickEventArgs, DataResult } from './interface';
15
+ import { HeaderCellInfoEventArgs, KeyboardEventArgs, RecordClickEventArgs, AdaptiveDialogEventArgs } from './interface';
16
+ import { FailureEventArgs, FilterEventArgs, ColumnDragEventArgs, GroupEventArgs, PrintEventArgs, ICustomOptr } from './interface';
17
+ import { RowDeselectEventArgs, RowSelectEventArgs, RowSelectingEventArgs, PageEventArgs, RowDragEventArgs } from './interface';
18
+ import { BeforeBatchAddArgs, BeforeBatchDeleteArgs, BeforeBatchSaveArgs, ResizeArgs, ColumnMenuItemModel } from './interface';
19
+ import { BatchAddArgs, BatchDeleteArgs, BeginEditArgs, CellEditArgs, CellSaveArgs, BeforeDataBoundArgs, RowInfo } from './interface';
20
+ import { DetailDataBoundEventArgs, ColumnChooserEventArgs, AddEventArgs, SaveEventArgs, EditEventArgs, DeleteEventArgs } from './interface';
21
+ import { ExcelExportCompleteArgs, PdfExportCompleteArgs, DataStateChangeEventArgs, DataSourceChangedEventArgs } from './interface';
22
+ import { SearchEventArgs, SortEventArgs, ISelectedCell, BeforeCopyEventArgs, ColumnDataStateChangeEventArgs } from './interface';
23
+ import { BeforePasteEventArgs, CheckBoxChangeEventArgs, CommandClickEventArgs, BeforeAutoFillEventArgs } from './interface';
24
+ import { Render } from '../renderer/render';
25
+ import { Column, ColumnModel, ActionEventArgs } from '../models/column';
26
+ import { SelectionType, GridLine, SortDirection, SelectionMode, PrintMode, FilterType, FilterBarMode } from './enum';
27
+ import { CheckboxSelectionType, HierarchyGridPrintMode, NewRowPosition, ClipMode, freezeMode, IndicatorType } from './enum';
28
+ import { WrapMode, ToolbarItems, ContextMenuItem, ColumnMenuItem, ToolbarItem, CellSelectionMode, EditMode, ResizeMode } from './enum';
29
+ import { ColumnQueryModeType, RowRenderingDirection } from './enum';
30
+ import { Data } from '../actions/data';
31
+ import { ServiceLocator } from '../services/service-locator';
32
+ import { ColumnWidthService } from '../services/width-controller';
33
+ import { AriaService } from '../services/aria-service';
34
+ import { FocusStrategy } from '../services/focus-strategy';
35
+ import { SortSettingsModel, SelectionSettingsModel, FilterSettingsModel, SearchSettingsModel, EditSettingsModel } from './grid-model';
36
+ import { SortDescriptorModel, PredicateModel, RowDropSettingsModel, GroupSettingsModel, TextWrapSettingsModel, LoadingIndicatorModel } from './grid-model';
37
+ import { InfiniteScrollSettingsModel } from './grid-model';
38
+ import { PageSettingsModel, AggregateRowModel, AggregateColumnModel, ColumnChooserSettingsModel } from '../models/models';
39
+ import { Sort } from '../actions/sort';
40
+ import { Page } from '../actions/page';
41
+ import { Selection } from '../actions/selection';
42
+ import { Filter } from '../actions/filter';
43
+ import { Search } from '../actions/search';
44
+ import { Resize } from '../actions/resize';
45
+ import { Reorder } from '../actions/reorder';
46
+ import { RowDD } from '../actions/row-reorder';
47
+ import { ShowHide } from '../actions/show-hide';
48
+ import { Scroll } from '../actions/scroll';
49
+ import { InfiniteScroll } from '../actions/infinite-scroll';
50
+ import { Group } from '../actions/group';
51
+ import { Print } from '../actions/print';
52
+ import { DetailRow } from '../actions/detail-row';
53
+ import { Toolbar } from '../actions/toolbar';
54
+ import { Edit } from '../actions/edit';
55
+ import { Row } from '../models/row';
56
+ import { ColumnChooser } from '../actions/column-chooser';
57
+ import { ExcelExport } from '../actions/excel-export';
58
+ import { PdfExport } from '../actions/pdf-export';
59
+ import { Clipboard } from '../actions/clipboard';
60
+ import { ContextMenu } from '../actions/context-menu';
61
+ import { BeforeOpenCloseMenuEventArgs, MenuEventArgs } from '@syncfusion/ej2-navigations';
62
+ import { ColumnMenu } from '../actions/column-menu';
63
+ import { CheckState } from './enum';
64
+ import { Aggregate } from '../actions/aggregate';
65
+ import { ColumnDeselectEventArgs, ColumnSelectEventArgs, ColumnSelectingEventArgs } from './interface';
66
+ import { Workbook } from '@syncfusion/ej2-excel-export';
67
+ /**
68
+ * Represents the field name and direction of sort column.
69
+ */
70
+ export declare class SortDescriptor extends ChildProperty<SortDescriptor> {
71
+ /**
72
+ * Defines the field name of sort column.
73
+ *
74
+ * @default ''
75
+ */
76
+ field: string;
77
+ /**
78
+ * Defines the direction of sort column.
79
+ *
80
+ * @default ''
81
+ */
82
+ direction: SortDirection;
83
+ /**
84
+ * @hidden
85
+ * Defines the sorted column whether or from grouping operation.
86
+ *
87
+ * @default false
88
+ */
89
+ isFromGroup: boolean;
90
+ }
91
+ /**
92
+ * Configures the sorting behavior of Grid.
93
+ */
94
+ export declare class SortSettings extends ChildProperty<SortSettings> {
95
+ /**
96
+ * Specifies the columns to sort at initial rendering of Grid.
97
+ * Also user can get current sorted columns.
98
+ *
99
+ * @default []
100
+ */
101
+ columns: SortDescriptorModel[];
102
+ /**
103
+ * If `allowUnsort` set to false the user can not get the grid in unsorted state by clicking the sorted column header.
104
+ *
105
+ * @default true
106
+ */
107
+ allowUnsort: boolean;
108
+ }
109
+ /**
110
+ * Represents the predicate for the filter column.
111
+ */
112
+ export declare class Predicate extends ChildProperty<Predicate> {
113
+ /**
114
+ * Defines the field name of the filter column.
115
+ *
116
+ * @default ''
117
+ */
118
+ field: string;
119
+ /**
120
+ * Defines the operator to filter records. The available operators and its supported data types are:
121
+ * <table>
122
+ * <tr>
123
+ * <td colspan=1 rowspan=1>
124
+ * Operator<br/></td><td colspan=1 rowspan=1>
125
+ * Description<br/></td><td colspan=1 rowspan=1>
126
+ * Supported Types<br/></td></tr>
127
+ * <tr>
128
+ * <td colspan=1 rowspan=1>
129
+ * startswith<br/></td><td colspan=1 rowspan=1>
130
+ * Checks whether the value begins with the specified value.<br/></td><td colspan=1 rowspan=1>
131
+ * String<br/></td></tr>
132
+ * <tr>
133
+ * <td colspan=1 rowspan=1>
134
+ * endswith<br/></td><td colspan=1 rowspan=1>
135
+ * Checks whether the value ends with the specified value.<br/><br/></td><td colspan=1 rowspan=1>
136
+ * <br/>String<br/></td></tr>
137
+ * <tr>
138
+ * <td colspan=1 rowspan=1>
139
+ * contains<br/></td><td colspan=1 rowspan=1>
140
+ * Checks whether the value contains the specified value.<br/><br/></td><td colspan=1 rowspan=1>
141
+ * <br/>String<br/></td></tr>
142
+ * <tr>
143
+ * <td colspan=1 rowspan=1>
144
+ * equal<br/></td><td colspan=1 rowspan=1>
145
+ * Checks whether the value is equal to the specified value.<br/><br/></td><td colspan=1 rowspan=1>
146
+ * <br/>String | Number | Boolean | Date<br/></td></tr>
147
+ * <tr>
148
+ * <td colspan=1 rowspan=1>
149
+ * notequal<br/></td><td colspan=1 rowspan=1>
150
+ * Checks for values that are not equal to the specified value.<br/><br/></td><td colspan=1 rowspan=1>
151
+ * <br/>String | Number | Boolean | Date<br/></td></tr>
152
+ * <tr>
153
+ * <td colspan=1 rowspan=1>
154
+ * greaterthan<br/></td><td colspan=1 rowspan=1>
155
+ * Checks whether the value is greater than the specified value.<br/><br/></td><td colspan=1 rowspan=1>
156
+ * Number | Date<br/></td></tr>
157
+ * <tr>
158
+ * <td colspan=1 rowspan=1>
159
+ * greaterthanorequal<br/></td><td colspan=1 rowspan=1>
160
+ * Checks whether the value is greater than or equal to the specified value.<br/><br/></td><td colspan=1 rowspan=1>
161
+ * <br/>Number | Date<br/></td></tr>
162
+ * <tr>
163
+ * <td colspan=1 rowspan=1>
164
+ * lessthan<br/></td><td colspan=1 rowspan=1>
165
+ * Checks whether the value is less than the specified value.<br/><br/></td><td colspan=1 rowspan=1>
166
+ * <br/>Number | Date<br/></td></tr>
167
+ * <tr>
168
+ * <td colspan=1 rowspan=1>
169
+ * lessthanorequal<br/></td><td colspan=1 rowspan=1>
170
+ * Checks whether the value is less than or equal to the specified value.<br/><br/></td><td colspan=1 rowspan=1>
171
+ * <br/>Number | Date<br/></td></tr>
172
+ * </table>
173
+ *
174
+ * @default null
175
+ */
176
+ operator: string;
177
+ /**
178
+ * Defines the value used to filter records.
179
+ *
180
+ * @default ''
181
+ */
182
+ value: string | number | Date | boolean;
183
+ /**
184
+ * If match case set to true, then filter records with exact match or else
185
+ * filter records with case insensitive(uppercase and lowercase letters treated as same).
186
+ *
187
+ * @default null
188
+ */
189
+ matchCase: boolean;
190
+ /**
191
+ * If ignoreAccent is set to true, then filter ignores the diacritic characters or accents while filtering.
192
+ *
193
+ * @default false
194
+ */
195
+ ignoreAccent: boolean;
196
+ /**
197
+ * Defines the relationship between one filter query and another by using AND or OR predicate.
198
+ *
199
+ * @default null
200
+ */
201
+ predicate: string;
202
+ /**
203
+ * @hidden
204
+ * Defines the actual filter value for the filter column.
205
+ */
206
+ actualFilterValue: Object;
207
+ /**
208
+ * @hidden
209
+ * Defines the actual filter operator for the filter column.
210
+ */
211
+ actualOperator: Object;
212
+ /**
213
+ * @hidden
214
+ * Defines the type of the filter column.
215
+ */
216
+ type: string;
217
+ /**
218
+ * @hidden
219
+ * Defines the predicate of filter column.
220
+ */
221
+ ejpredicate: Object;
222
+ /**
223
+ * Defines the UID of filter column.
224
+ */
225
+ uid: string;
226
+ /**
227
+ * @hidden
228
+ * Defines the foreignKey availability in filtered columns.
229
+ */
230
+ isForeignKey: boolean;
231
+ /**
232
+ * Defines the condition to add the new predicates on existing predicate with "and"/"or" operator.
233
+ *
234
+ * @default ''
235
+ */
236
+ condition: string;
237
+ }
238
+ /**
239
+ * Configures the infinite scroll behavior of Grid.
240
+ */
241
+ export declare class InfiniteScrollSettings extends ChildProperty<InfiniteScrollSettings> {
242
+ /**
243
+ * If `enableCache` is set to true, the Grid will cache the loaded data to be reused next time it is needed.
244
+ *
245
+ * @default false
246
+ */
247
+ enableCache: boolean;
248
+ /**
249
+ * Defines the number of blocks to be maintained in Grid while settings enableCache as true.
250
+ *
251
+ * @default 3
252
+ */
253
+ maxBlocks: number;
254
+ /**
255
+ * Defines the number of blocks will render at the initial Grid rendering while enableCache is enabled.
256
+ *
257
+ * @default 3
258
+ */
259
+ initialBlocks: number;
260
+ }
261
+ /**
262
+ * Configures the filtering behavior of the Grid.
263
+ */
264
+ export declare class FilterSettings extends ChildProperty<FilterSettings> {
265
+ /**
266
+ * Specifies the columns to be filtered at initial rendering of the Grid. You can also get the columns that were currently filtered.
267
+ *
268
+ * @default []
269
+ */
270
+ columns: PredicateModel[];
271
+ /**
272
+ * Defines options for filtering type. The available options are
273
+ * * `Menu` - Specifies the filter type as menu.
274
+ * * `CheckBox` - Specifies the filter type as checkbox.
275
+ * * `FilterBar` - Specifies the filter type as filterbar.
276
+ * * `Excel` - Specifies the filter type as checkbox.
277
+ *
278
+ * @default FilterBar
279
+ */
280
+ type: FilterType;
281
+ /**
282
+ * Defines the filter bar modes. The available options are,
283
+ * * `OnEnter`: Initiates filter operation after Enter key is pressed.
284
+ * * `Immediate`: Initiates filter operation after a certain time interval. By default, time interval is 1500 ms.
285
+ *
286
+ * @default OnEnter
287
+ */
288
+ mode: FilterBarMode;
289
+ /**
290
+ * Shows or hides the filtered status message on the pager.
291
+ *
292
+ * @default true
293
+ */
294
+ showFilterBarStatus: boolean;
295
+ /**
296
+ * Defines the time delay (in milliseconds) in filtering records when the `Immediate` mode of filter bar is set.
297
+ *
298
+ * @default 1500
299
+ */
300
+ immediateModeDelay: number;
301
+ /**
302
+ * The `operators` is used to override the default operators in filter menu. This should be defined by type wise
303
+ * (string, number, date and boolean). Based on the column type, this customize operator list will render in filter menu.
304
+ *
305
+ * > Check the [`Filter Menu Operator`](../../grid/filtering/filter-menu/#customizing-filter-menu-operators-list) customization.
306
+ *
307
+ * @default null
308
+ */
309
+ operators: ICustomOptr;
310
+ /**
311
+ * If ignoreAccent set to true, then filter ignores the diacritic characters or accents while filtering.
312
+ *
313
+ * > Check the [`Diacritics`](../../grid/filtering/filtering/#diacritics-filter) filtering.
314
+ *
315
+ * @default false
316
+ */
317
+ ignoreAccent: boolean;
318
+ /**
319
+ * If `enableCaseSensitivity` is set to true then searches grid records with exact match based on the filter
320
+ * operator. It will have no effect on number, boolean and Date fields.
321
+ *
322
+ * @default false
323
+ */
324
+ enableCaseSensitivity: boolean;
325
+ /**
326
+ * If 'showFilterBarOperator' is set to true, then it renders the dropdownlist component to select the operator
327
+ * in filterbar input
328
+ *
329
+ * @default false
330
+ */
331
+ showFilterBarOperator: boolean;
332
+ }
333
+ /**
334
+ * Configures the selection behavior of the Grid.
335
+ */
336
+ export declare class SelectionSettings extends ChildProperty<SelectionSettings> {
337
+ /**
338
+ * Grid supports row, cell, and both (row and cell) selection mode.
339
+ *
340
+ * @default Row
341
+ */
342
+ mode: SelectionMode;
343
+ /**
344
+ * The cell selection modes are flow and box. It requires the selection
345
+ * [`mode`](grid/#mode-selectionmode/) to be either cell or both.
346
+ * * `Flow`: Selects the range of cells between start index and end index that also includes the other cells of the selected rows.
347
+ * * `Box`: Selects the range of cells within the start and end column indexes that includes in between cells of rows within the range.
348
+ * * `BoxWithBorder`: Selects the range of cells as like Box mode with borders.
349
+ *
350
+ * @default Flow
351
+ */
352
+ cellSelectionMode: CellSelectionMode;
353
+ /**
354
+ * Defines options for selection type. They are
355
+ * * `Single`: Allows selection of only a row or a cell.
356
+ * * `Multiple`: Allows selection of multiple rows or cells.
357
+ *
358
+ * @default Single
359
+ */
360
+ type: SelectionType;
361
+ /**
362
+ * If 'checkboxOnly' set to true, then the Grid selection is allowed only through checkbox.
363
+ *
364
+ * > To enable checkboxOnly selection, should specify the column type as`checkbox`.
365
+ *
366
+ * @default false
367
+ */
368
+ checkboxOnly: boolean;
369
+ /**
370
+ * If 'persistSelection' set to true, then the Grid selection is persisted on all operations.
371
+ * For persisting selection in the Grid, any one of the column should be enabled as a primary key.
372
+ *
373
+ * @default false
374
+ */
375
+ persistSelection: boolean;
376
+ /**
377
+ * Defines options for checkbox selection Mode. They are
378
+ * * `Default`: This is the default value of the checkboxMode. In this mode, user can select multiple rows by clicking rows one by one.
379
+ * * `ResetOnRowClick`: In ResetOnRowClick mode, on clicking a row it will reset previously selected row and also multiple
380
+ * rows can be selected by using CTRL or SHIFT key.
381
+ *
382
+ * @default Default
383
+ */
384
+ checkboxMode: CheckboxSelectionType;
385
+ /**
386
+ * If 'enableSimpleMultiRowSelection' set to true, then the user can able to perform multiple row selection with single clicks.
387
+ *
388
+ * @default false
389
+ */
390
+ enableSimpleMultiRowSelection: boolean;
391
+ /**
392
+ * If 'enableToggle' set to true, then the user can able to perform toggle for the selected row.
393
+ *
394
+ * @default true
395
+ */
396
+ enableToggle: boolean;
397
+ /**
398
+ * If 'allowColumnSelection' set to true, then the user can able to select the columns.
399
+ *
400
+ * @default false
401
+ */
402
+ allowColumnSelection: boolean;
403
+ }
404
+ /**
405
+ * Configures the search behavior of the Grid.
406
+ */
407
+ export declare class SearchSettings extends ChildProperty<SearchSettings> {
408
+ /**
409
+ * Specifies the collection of fields included in search operation. By default, bounded columns of the Grid are included.
410
+ *
411
+ * @default []
412
+ */
413
+ fields: string[];
414
+ /**
415
+ * Specifies the key value to search Grid records at initial rendering.
416
+ * You can also get the current search key.
417
+ *
418
+ * @default ''
419
+ */
420
+ key: string;
421
+ /**
422
+ * Defines the operator to search records. The available operators are:
423
+ * <table>
424
+ * <tr>
425
+ * <td colspan=1 rowspan=1>
426
+ * Operator<br/></td><td colspan=1 rowspan=1>
427
+ * Description<br/></td></tr>
428
+ * <tr>
429
+ * <td colspan=1 rowspan=1>
430
+ * startswith<br/></td><td colspan=1 rowspan=1>
431
+ * Checks whether the string begins with the specified string.<br/></td></tr>
432
+ * <tr>
433
+ * <td colspan=1 rowspan=1>
434
+ * endswith<br/></td><td colspan=1 rowspan=1>
435
+ * Checks whether the string ends with the specified string.<br/></td></tr>
436
+ * <tr>
437
+ * <td colspan=1 rowspan=1>
438
+ * contains<br/></td><td colspan=1 rowspan=1>
439
+ * Checks whether the string contains the specified string. <br/></td></tr>
440
+ * <tr>
441
+ * <td colspan=1 rowspan=1>
442
+ * equal<br/></td><td colspan=1 rowspan=1>
443
+ * Checks whether the string is equal to the specified string.<br/></td></tr>
444
+ * <tr>
445
+ * <td colspan=1 rowspan=1>
446
+ * notequal<br/></td><td colspan=1 rowspan=1>
447
+ * Checks for strings not equal to the specified string. <br/></td></tr>
448
+ * </table>
449
+ *
450
+ * @default 'contains'
451
+ */
452
+ operator: string;
453
+ /**
454
+ * If `ignoreCase` is set to false, searches records that match exactly, else
455
+ * searches records that are case insensitive(uppercase and lowercase letters treated the same).
456
+ *
457
+ * @default true
458
+ */
459
+ ignoreCase: boolean;
460
+ /**
461
+ * If ignoreAccent set to true, then filter ignores the diacritic characters or accents while filtering.
462
+ *
463
+ * > Check the [`Diacritics`](../../grid/filtering/filtering/#diacritics-filter) filtering.
464
+ *
465
+ * @default false
466
+ */
467
+ ignoreAccent: boolean;
468
+ }
469
+ /**
470
+ * Configures the row drop settings of the Grid.
471
+ */
472
+ export declare class RowDropSettings extends ChildProperty<RowDropSettings> {
473
+ /**
474
+ * Defines the ID of droppable component on which row drop should occur.
475
+ *
476
+ * @default null
477
+ */
478
+ targetID: string;
479
+ }
480
+ /**
481
+ * Configures the text wrap settings of the Grid.
482
+ */
483
+ export declare class TextWrapSettings extends ChildProperty<TextWrapSettings> {
484
+ /**
485
+ * Defines the `wrapMode` of the Grid. The available modes are:
486
+ * * `Both`: Wraps both the header and content.
487
+ * * `Content`: Wraps the header alone.
488
+ * * `Header`: Wraps the content alone.
489
+ *
490
+ * @default Both
491
+ */
492
+ wrapMode: WrapMode;
493
+ }
494
+ /**
495
+ * Configures the resize behavior of the Grid.
496
+ */
497
+ export declare class ResizeSettings extends ChildProperty<ResizeSettings> {
498
+ /**
499
+ * Defines the mode of Grid column resizing. The available modes are:
500
+ * `Normal`: Columns will not be adjusted to fit the remaining space.
501
+ * `Auto`: Resized column width will be adjusted by other columns automatically.
502
+ *
503
+ * @default Normal
504
+ */
505
+ mode: ResizeMode;
506
+ }
507
+ /**
508
+ * Configures the group behavior of the Grid.
509
+ */
510
+ export declare class GroupSettings extends ChildProperty<GroupSettings> {
511
+ /**
512
+ * If `showDropArea` is set to true, the group drop area element will be visible at the top of the Grid.
513
+ *
514
+ * @default true
515
+ */
516
+ showDropArea: boolean;
517
+ /**
518
+ * If `allowReordering` is set to true, Grid allows the grouped elements to be reordered.
519
+ *
520
+ * @default false
521
+ */
522
+ allowReordering: boolean;
523
+ /**
524
+ * If `showToggleButton` set to true, then the toggle button will be showed in the column headers which can be used to group
525
+ * or ungroup columns by clicking them.
526
+ *
527
+ * @default false
528
+ */
529
+ showToggleButton: boolean;
530
+ /**
531
+ * If `showGroupedColumn` is set to false, it hides the grouped column after grouping.
532
+ *
533
+ * @default false
534
+ */
535
+ showGroupedColumn: boolean;
536
+ /**
537
+ * If `showUngroupButton` set to false, then ungroup button is hidden in dropped element.
538
+ * It can be used to ungroup the grouped column when click on ungroup button.
539
+ *
540
+ * @default true
541
+ */
542
+ showUngroupButton: boolean;
543
+ /**
544
+ * If `disablePageWiseAggregates` set to true, then the group aggregate value will
545
+ * be calculated from the whole data instead of paged data and two requests will be made for each page
546
+ * when Grid bound with remote service.
547
+ *
548
+ * @default false
549
+ */
550
+ disablePageWiseAggregates: boolean;
551
+ /**
552
+ * Specifies the column names to group at initial rendering of the Grid.
553
+ * You can also get the currently grouped columns.
554
+ *
555
+ * @default []
556
+ */
557
+ columns: string[];
558
+ /**
559
+ * The Caption Template allows user to display the string or HTML element in group caption.
560
+ * > It accepts either the
561
+ * [template string](https://ej2.syncfusion.com/documentation/common/template-engine/) or the HTML element ID.
562
+ *
563
+ * @default ''
564
+ */
565
+ captionTemplate: string | Object;
566
+ /**
567
+ * The Lazy load grouping, allows the Grid to render only the initial level caption rows in collapsed state while grouping.
568
+ * The child rows of each caption will render only when we expand the captions.
569
+ *
570
+ * @default false
571
+ */
572
+ enableLazyLoading: boolean;
573
+ }
574
+ /**
575
+ * Configures the edit behavior of the Grid.
576
+ */
577
+ export declare class EditSettings extends ChildProperty<EditSettings> {
578
+ /**
579
+ * If `allowAdding` is set to true, new records can be added to the Grid.
580
+ *
581
+ * @default false
582
+ */
583
+ allowAdding: boolean;
584
+ /**
585
+ * If `allowEditing` is set to true, values can be updated in the existing record.
586
+ *
587
+ * @default false
588
+ */
589
+ allowEditing: boolean;
590
+ /**
591
+ * If `allowDeleting` is set to true, existing record can be deleted from the Grid.
592
+ *
593
+ * @default false
594
+ */
595
+ allowDeleting: boolean;
596
+ /**
597
+ * Defines the mode to edit. The available editing modes are:
598
+ * * Normal
599
+ * * Dialog
600
+ * * Batch
601
+ *
602
+ * @default Normal
603
+ */
604
+ mode: EditMode;
605
+ /**
606
+ * If `allowEditOnDblClick` is set to false, Grid will not allow editing of a record on double click.
607
+ *
608
+ * @default true
609
+ */
610
+ allowEditOnDblClick: boolean;
611
+ /**
612
+ * if `showConfirmDialog` is set to false, confirm dialog does not show when batch changes are saved or discarded.
613
+ *
614
+ * @default true
615
+ */
616
+ showConfirmDialog: boolean;
617
+ /**
618
+ * If `showDeleteConfirmDialog` is set to true, confirm dialog will show delete action. You can also cancel delete command.
619
+ *
620
+ * @default false
621
+ */
622
+ showDeleteConfirmDialog: boolean;
623
+ /**
624
+ * Defines the custom edit elements for the dialog template.
625
+ *
626
+ * @default ''
627
+ * @aspType string
628
+ */
629
+ template: string | Object;
630
+ /**
631
+ * Defines the custom edit elements for the dialog header template.
632
+ *
633
+ * @default ''
634
+ * @aspType string
635
+ */
636
+ headerTemplate: string | Object;
637
+ /**
638
+ * Defines the custom edit elements for the dialog footer template.
639
+ *
640
+ * @default ''
641
+ * @aspType string
642
+ */
643
+ footerTemplate: string | Object;
644
+ /**
645
+ * Defines the position of adding a new row. The available position are:
646
+ * * Top
647
+ * * Bottom
648
+ *
649
+ * @default Top
650
+ */
651
+ newRowPosition: NewRowPosition;
652
+ /**
653
+ * Defines the dialog params to edit.
654
+ *
655
+ * @default {}
656
+ */
657
+ dialog: IDialogUI;
658
+ /**
659
+ * If allowNextRowEdit is set to true, editing is done to next row. By default allowNextRowEdit is set to false.
660
+ *
661
+ * @default false
662
+ */
663
+ allowNextRowEdit: boolean;
664
+ }
665
+ /**
666
+ * Configures the Loading Indicator of the Grid.
667
+ */
668
+ export declare class LoadingIndicator extends ChildProperty<LoadingIndicator> {
669
+ /**
670
+ * Defines the loading indicator. The available loading indicator are:
671
+ * * Spinner
672
+ * * Shimmer
673
+ *
674
+ * @default Spinner
675
+ */
676
+ indicatorType: IndicatorType;
677
+ }
678
+ /**
679
+ * Represents the Grid component.
680
+ * ```html
681
+ * <div id="grid"></div>
682
+ * <script>
683
+ * var gridObj = new Grid({ allowPaging: true });
684
+ * gridObj.appendTo("#grid");
685
+ * </script>
686
+ * ```
687
+ */
688
+ export declare class Grid extends Component<HTMLElement> implements INotifyPropertyChanged {
689
+ private gridPager;
690
+ private isInitial;
691
+ isPreventScrollEvent: boolean;
692
+ private columnModel;
693
+ private rowTemplateFn;
694
+ private editTemplateFn;
695
+ private editHeaderTemplateFn;
696
+ private editFooterTemplateFn;
697
+ private detailTemplateFn;
698
+ private sortedColumns;
699
+ private footerElement;
700
+ private inViewIndexes;
701
+ private mediaCol;
702
+ private getShowHideService;
703
+ private mediaColumn;
704
+ private keyA;
705
+ private frozenRightCount;
706
+ private frozenLeftCount;
707
+ private tablesCount;
708
+ private movableCount;
709
+ private visibleFrozenLeft;
710
+ private frozenName;
711
+ private visibleFrozenRight;
712
+ private visibleMovable;
713
+ private frozenLeftColumns;
714
+ private frozenRightColumns;
715
+ private movableColumns;
716
+ private media;
717
+ private isFreezeRefresh;
718
+ private headerMaskTable;
719
+ private movableHeaderMaskTable;
720
+ private rightHeaderMaskTable;
721
+ private contentMaskTable;
722
+ private movableContentMaskTable;
723
+ private rightContentMaskTable;
724
+ private footerContentMaskTable;
725
+ private movableFooterContentMaskTable;
726
+ private rightFooterContentMaskTable;
727
+ private maskRowContentScroll;
728
+ /** @hidden */
729
+ invokedFromMedia: boolean;
730
+ /** @hidden */
731
+ tableIndex: number;
732
+ private dataBoundFunction;
733
+ private dataToBeUpdated;
734
+ private componentRefresh;
735
+ /** @hidden */
736
+ recordsCount: number;
737
+ /** @hidden */
738
+ isVirtualAdaptive: boolean;
739
+ /** @hidden */
740
+ vRows: Row<Column>[];
741
+ /** @hidden */
742
+ vcRows: Row<Column>[];
743
+ /** @hidden */
744
+ vGroupOffsets: {
745
+ [x: number]: number;
746
+ };
747
+ /** @hidden */
748
+ isInitialLoad: boolean;
749
+ /** @hidden */
750
+ private rowUid;
751
+ /**
752
+ * @hidden
753
+ */
754
+ mergeCells: {
755
+ [key: string]: number;
756
+ };
757
+ /**
758
+ * @hidden
759
+ */
760
+ checkAllRows: CheckState;
761
+ /**
762
+ * @hidden
763
+ */
764
+ isCheckBoxSelection: boolean;
765
+ /**
766
+ * @hidden
767
+ */
768
+ isPersistSelection: boolean;
769
+ /**
770
+ * Gets the currently visible records of the Grid.
771
+ */
772
+ currentViewData: Object[];
773
+ /** @hidden */
774
+ /**
775
+ * Gets the parent Grid details.
776
+ */
777
+ parentDetails: ParentDetails;
778
+ /** @hidden */
779
+ isEdit: boolean;
780
+ /** @hidden */
781
+ commonQuery: Query;
782
+ /** @hidden */
783
+ scrollPosition: ScrollPositionType;
784
+ /** @hidden */
785
+ isLastCellPrimaryKey: boolean;
786
+ /** @hidden */
787
+ filterOperators: IFilterOperator;
788
+ /** @hidden */
789
+ localeObj: L10n;
790
+ /** @hidden */
791
+ isManualRefresh: boolean;
792
+ /** @hidden */
793
+ isAutoFitColumns: boolean;
794
+ /** @hidden */
795
+ enableDeepCompare: boolean;
796
+ /** @hidden */
797
+ totalDataRecordsCount: number;
798
+ /** @hidden */
799
+ disableSelectedRecords: Object[];
800
+ /** @hidden */
801
+ partialSelectedRecords: Object[];
802
+ isSelectedRowIndexUpdating: boolean;
803
+ private defaultLocale;
804
+ private keyConfigs;
805
+ private keyPress;
806
+ private toolTipObj;
807
+ private prevElement;
808
+ private stackedColumn;
809
+ private isExcel;
810
+ /** @hidden */
811
+ lockcolPositionCount: number;
812
+ /** @hidden */
813
+ prevPageMoving: boolean;
814
+ /** @hidden */
815
+ pageTemplateChange: boolean;
816
+ /** @hidden */
817
+ isAutoGen: boolean;
818
+ private mediaBindInstance;
819
+ /** @hidden */
820
+ commandDelIndex: number;
821
+ /** @hidden */
822
+ asyncTimeOut: number;
823
+ /** @hidden */
824
+ isExportGrid: boolean;
825
+ /**
826
+ * @hidden
827
+ */
828
+ renderModule: Render;
829
+ /**
830
+ * @hidden
831
+ */
832
+ headerModule: IRenderer;
833
+ /**
834
+ * @hidden
835
+ */
836
+ contentModule: IRenderer;
837
+ /**
838
+ * @hidden
839
+ */
840
+ valueFormatterService: IValueFormatter;
841
+ /**
842
+ * @hidden
843
+ */
844
+ serviceLocator: ServiceLocator;
845
+ /**
846
+ * @hidden
847
+ */
848
+ ariaService: AriaService;
849
+ /**
850
+ * The `keyboardModule` is used to manipulate keyboard interactions in the Grid.
851
+ */
852
+ keyboardModule: KeyboardEvents;
853
+ /**
854
+ * @hidden
855
+ */
856
+ widthService: ColumnWidthService;
857
+ /**
858
+ * The `rowDragAndDropModule` is used to manipulate row reordering in the Grid.
859
+ */
860
+ rowDragAndDropModule: RowDD;
861
+ /**
862
+ * The `pagerModule` is used to manipulate paging in the Grid.
863
+ */
864
+ pagerModule: Page;
865
+ /**
866
+ * The `sortModule` is used to manipulate sorting in the Grid.
867
+ */
868
+ sortModule: Sort;
869
+ /**
870
+ * The `filterModule` is used to manipulate filtering in the Grid.
871
+ */
872
+ filterModule: Filter;
873
+ /**
874
+ * The `selectionModule` is used to manipulate selection behavior in the Grid.
875
+ */
876
+ selectionModule: Selection;
877
+ /**
878
+ * The `showHider` is used to manipulate column's show/hide operation in the Grid.
879
+ */
880
+ showHider: ShowHide;
881
+ /**
882
+ * The `searchModule` is used to manipulate searching in the Grid.
883
+ */
884
+ searchModule: Search;
885
+ /**
886
+ * The `scrollModule` is used to manipulate scrolling in the Grid.
887
+ */
888
+ scrollModule: Scroll;
889
+ /**
890
+ * The `infiniteScrollModule` is used to manipulate infinite scrolling in the Grid.
891
+ */
892
+ infiniteScrollModule: InfiniteScroll;
893
+ /**
894
+ * The `reorderModule` is used to manipulate reordering in the Grid.
895
+ */
896
+ reorderModule: Reorder;
897
+ /**
898
+ * `resizeModule` is used to manipulate resizing in the Grid.
899
+ *
900
+ * @hidden
901
+ */
902
+ resizeModule: Resize;
903
+ /**
904
+ * The `groupModule` is used to manipulate grouping behavior in the Grid.
905
+ */
906
+ groupModule: Group;
907
+ /**
908
+ * The `printModule` is used to handle the printing feature of the Grid.
909
+ */
910
+ printModule: Print;
911
+ /**
912
+ * The `excelExportModule` is used to handle Excel exporting feature in the Grid.
913
+ */
914
+ excelExportModule: ExcelExport;
915
+ /**
916
+ * The `pdfExportModule` is used to handle PDF exporting feature in the Grid.
917
+ */
918
+ pdfExportModule: PdfExport;
919
+ /**
920
+ * `detailRowModule` is used to handle detail rows rendering in the Grid.
921
+ *
922
+ * @hidden
923
+ */
924
+ detailRowModule: DetailRow;
925
+ /**
926
+ * The `toolbarModule` is used to manipulate ToolBar items and its action in the Grid.
927
+ */
928
+ toolbarModule: Toolbar;
929
+ /**
930
+ * The `contextMenuModule` is used to handle context menu items and its action in the Grid.
931
+ */
932
+ contextMenuModule: ContextMenu;
933
+ /**
934
+ * The `columnMenuModule` is used to manipulate column menu items and its action in the Grid.
935
+ */
936
+ columnMenuModule: ColumnMenu;
937
+ /**
938
+ * The `editModule` is used to handle Grid content manipulation.
939
+ */
940
+ editModule: Edit;
941
+ /**
942
+ * `clipboardModule` is used to handle Grid copy action.
943
+ */
944
+ clipboardModule: Clipboard;
945
+ /**
946
+ * `columnchooserModule` is used to dynamically show or hide the Grid columns.
947
+ *
948
+ * @hidden
949
+ */
950
+ columnChooserModule: ColumnChooser;
951
+ /**
952
+ * The `aggregateModule` is used to manipulate aggregate functionality in the Grid.
953
+ *
954
+ * @hidden
955
+ */
956
+ aggregateModule: Aggregate;
957
+ private commandColumnModule;
958
+ private loggerModule;
959
+ private enableLogger;
960
+ /** @hidden */
961
+ focusModule: FocusStrategy;
962
+ adaptiveDlgTarget: HTMLElement;
963
+ protected needsID: boolean;
964
+ /**
965
+ * Defines the schema of dataSource.
966
+ * If the `columns` declaration is empty or undefined then the `columns` are automatically generated from data source.
967
+ * {% codeBlock src='grid/columns/index.md' %}{% endcodeBlock %}
968
+ *
969
+ * @default []
970
+ */
971
+ columns: Column[] | string[] | ColumnModel[];
972
+ /**
973
+ * If `enableAltRow` is set to true, the grid will render with `e-altrow` CSS class to the alternative tr elements.
974
+ * > Check the [`AltRow`](../../grid/row/row/#using-css-customize-alternate-rows/) to customize the styles of alternative rows.
975
+ * {% codeBlock src='grid/enableAltRow/index.md' %}{% endcodeBlock %}
976
+ *
977
+ * @default true
978
+ */
979
+ enableAltRow: boolean;
980
+ /**
981
+ * If `enableHover` is set to true, the row hover is enabled in the Grid.
982
+ * {% codeBlock src='grid/enableHover/index.md' %}{% endcodeBlock %}
983
+ *
984
+ * @default true
985
+ */
986
+ enableHover: boolean;
987
+ /**
988
+ * If `enableAutoFill` is set to true, then the auto fill icon will displayed on cell selection for copy cells.
989
+ * It requires the selection `mode` to be Cell and `cellSelectionMode` to be `Box`.
990
+ * {% codeBlock src='grid/enableAutoFill/index.md' %}{% endcodeBlock %}
991
+ *
992
+ * @default false
993
+ */
994
+ enableAutoFill: boolean;
995
+ /**
996
+ * Enables or disables the key board interaction of Grid.
997
+ *
998
+ * @default true
999
+ */
1000
+ allowKeyboard: boolean;
1001
+ /**
1002
+ * If 'enableStickyHeader' set to true, then the user can able to make the column headers visible when the document is scrolled.
1003
+ *
1004
+ * @default false
1005
+ */
1006
+ enableStickyHeader: boolean;
1007
+ /**
1008
+ * If `allowTextWrap` set to true,
1009
+ * then text content will wrap to the next line when its text content exceeds the width of the Column Cells.
1010
+ * {% codeBlock src='grid/allowTextWrap/index.md' %}{% endcodeBlock %}
1011
+ *
1012
+ * @default false
1013
+ */
1014
+ allowTextWrap: boolean;
1015
+ /**
1016
+ * Configures the text wrap in the Grid.
1017
+ * {% codeBlock src='grid/textWrapSettings/index.md' %}{% endcodeBlock %}
1018
+ *
1019
+ * @default {wrapMode:"Both"}
1020
+ */
1021
+ textWrapSettings: TextWrapSettingsModel;
1022
+ /**
1023
+ * Defines the resizing behavior of the Grid.
1024
+ *
1025
+ * @default {mode:"Normal"}
1026
+ */
1027
+ resizeSettings: ResizeSettingsModel;
1028
+ /**
1029
+ * 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.
1030
+ *
1031
+ * > Check the [`Paging`](../../grid/paging/) to configure the grid pager.
1032
+ * {% codeBlock src='grid/allowPaging/index.md' %}{% endcodeBlock %}
1033
+ *
1034
+ * @default false
1035
+ */
1036
+ allowPaging: boolean;
1037
+ /**
1038
+ * Configures the pager in the Grid.
1039
+ * {% codeBlock src='grid/pageSettings/index.md' %}{% endcodeBlock %}
1040
+ *
1041
+ * @default {currentPage: 1, pageSize: 12, pageCount: 8, enableQueryString: false, pageSizes: false, template: null}
1042
+ */
1043
+ pageSettings: PageSettingsModel;
1044
+ /**
1045
+ * Configures the Loading Indicator of the Grid.
1046
+ *
1047
+ * @default {indicatorType: 'Spinner'}
1048
+ */
1049
+ loadingIndicator: LoadingIndicatorModel;
1050
+ /**
1051
+ * Specifies the shimmer effect for Grid virtual and infinite scrolling.
1052
+ *
1053
+ * @default true
1054
+ */
1055
+ enableVirtualMaskRow: boolean;
1056
+ /**
1057
+ * If `enableVirtualization` set to true, then the Grid will render only the rows visible within the view-port
1058
+ * and load subsequent rows on vertical scrolling. This helps to load large dataset in Grid.
1059
+ * {% codeBlock src='grid/enableVirtualization/index.md' %}{% endcodeBlock %}
1060
+ *
1061
+ * @default false
1062
+ */
1063
+ enableVirtualization: boolean;
1064
+ /**
1065
+ * If `enableColumnVirtualization` set to true, then the Grid will render only the columns visible within the view-port
1066
+ * and load subsequent columns on horizontal scrolling. This helps to load large dataset of columns in Grid.
1067
+ * {% codeBlock src='grid/enableColumnVirtualization/index.md' %}{% endcodeBlock %}
1068
+ *
1069
+ * @default false
1070
+ */
1071
+ enableColumnVirtualization: boolean;
1072
+ /**
1073
+ * If `enableInfiniteScrolling` set to true, then the data will be loaded in Grid when the scrollbar reaches the end.
1074
+ * This helps to load large dataset in Grid.
1075
+ * {% codeBlock src='grid/enableInfiniteScrolling/index.md' %}{% endcodeBlock %}
1076
+ *
1077
+ * @default false
1078
+ */
1079
+ enableInfiniteScrolling: boolean;
1080
+ /**
1081
+ * Configures the search behavior in the Grid.
1082
+ * {% codeBlock src='grid/searchSettings/index.md' %}{% endcodeBlock %}
1083
+ *
1084
+ * @default { ignoreCase: true, fields: [], operator: 'contains', key: '' }
1085
+ */
1086
+ searchSettings: SearchSettingsModel;
1087
+ /**
1088
+ * If `allowSorting` is set to true, it allows sorting of grid records when column header is clicked.
1089
+ *
1090
+ * > Check the [`Sorting`](../../grid/sorting/) to customize its default behavior.
1091
+ * {% codeBlock src='grid/allowSorting/index.md' %}{% endcodeBlock %}
1092
+ *
1093
+ * @default false
1094
+ */
1095
+ allowSorting: boolean;
1096
+ /**
1097
+ * Defines the mode of clip. The available modes are,
1098
+ * `Clip`: Truncates the cell content when it overflows its area.
1099
+ * `Ellipsis`: Displays ellipsis when the cell content overflows its area.
1100
+ * `EllipsisWithTooltip`: Displays ellipsis when the cell content overflows its area,
1101
+ * also it will display the tooltip while hover on ellipsis is applied.
1102
+ * {% codeBlock src='grid/clipMode/index.md' %}{% endcodeBlock %}
1103
+ *
1104
+ * @default Ellipsis
1105
+ */
1106
+ clipMode: ClipMode;
1107
+ /**
1108
+ * If `allowMultiSorting` set to true, then it will allow the user to sort multiple column in the grid.
1109
+ * > `allowSorting` should be true.
1110
+ * {% codeBlock src='grid/allowMultiSorting/index.md' %}{% endcodeBlock %}
1111
+ *
1112
+ * @default false
1113
+ */
1114
+ allowMultiSorting: boolean;
1115
+ /**
1116
+ * If `allowExcelExport` set to true, then it will allow the user to export grid to Excel file.
1117
+ *
1118
+ * > Check the [`ExcelExport`](../../grid/excel-export/excel-exporting/) to configure exporting document.
1119
+ * {% codeBlock src='grid/allowExcelExport/index.md' %}{% endcodeBlock %}
1120
+ *
1121
+ * @default false
1122
+ */
1123
+ allowExcelExport: boolean;
1124
+ /**
1125
+ * If `allowPdfExport` set to true, then it will allow the user to export grid to Pdf file.
1126
+ *
1127
+ * > Check the [`Pdfexport`](../../grid/pdf-export/pdf-export/) to configure the exporting document.
1128
+ * {% codeBlock src='grid/allowPdfExport/index.md' %}{% endcodeBlock %}
1129
+ *
1130
+ * @default false
1131
+ */
1132
+ allowPdfExport: boolean;
1133
+ /**
1134
+ * Configures the sort settings.
1135
+ * {% codeBlock src='grid/sortSettings/index.md' %}{% endcodeBlock %}
1136
+ *
1137
+ * @default {columns:[]}
1138
+ */
1139
+ sortSettings: SortSettingsModel;
1140
+ /**
1141
+ * Configures the infinite scroll settings.
1142
+ * {% codeBlock src='grid/infiniteScrollSettings/index.md' %}{% endcodeBlock %}
1143
+ *
1144
+ * @default { enableCache: false, maxBlocks: 5, initialBlocks: 5 }
1145
+ */
1146
+ infiniteScrollSettings: InfiniteScrollSettingsModel;
1147
+ /**
1148
+ * If `allowSelection` is set to true, it allows selection of (highlight row) Grid records by clicking it.
1149
+ * {% codeBlock src='grid/allowSelection/index.md' %}{% endcodeBlock %}
1150
+ *
1151
+ * @default true
1152
+ */
1153
+ allowSelection: boolean;
1154
+ /**
1155
+ * The `selectedRowIndex` allows you to select a row at initial rendering.
1156
+ * You can also get the currently selected row index.
1157
+ * {% codeBlock src='grid/selectedRowIndex/index.md' %}{% endcodeBlock %}
1158
+ *
1159
+ * @default -1
1160
+ */
1161
+ selectedRowIndex: number;
1162
+ /**
1163
+ * Configures the selection settings.
1164
+ * {% codeBlock src='grid/selectionSettings/index.md' %}{% endcodeBlock %}
1165
+ *
1166
+ * @default {mode: 'Row', cellSelectionMode: 'Flow', type: 'Single'}
1167
+ */
1168
+ selectionSettings: SelectionSettingsModel;
1169
+ /**
1170
+ * If `allowFiltering` set to true the filter bar will be displayed.
1171
+ * If set to false the filter bar will not be displayed.
1172
+ * Filter bar allows the user to filter grid records with required criteria.
1173
+ *
1174
+ * > Check the [`Filtering`](../../grid/filtering/filtering/) to customize its default behavior.
1175
+ * {% codeBlock src='grid/allowFiltering/index.md' %}{% endcodeBlock %}
1176
+ *
1177
+ * @default false
1178
+ */
1179
+ allowFiltering: boolean;
1180
+ /**
1181
+ * Defines the grid row elements rendering direction. The available directions are,
1182
+ * * `Horizontal`: Renders the grid row elements in the horizontal direction
1183
+ * * `Vertical`: Renders the grid row elements in the vertical direction
1184
+ *
1185
+ * @default Horizontal
1186
+ */
1187
+ rowRenderingMode: RowRenderingDirection;
1188
+ /**
1189
+ * If `enableAdaptiveUI` set to true the grid filter, sort, and edit dialogs render adaptively.
1190
+ *
1191
+ * @default false
1192
+ */
1193
+ enableAdaptiveUI: boolean;
1194
+ /**
1195
+ * If `allowReordering` is set to true, Grid columns can be reordered.
1196
+ * Reordering can be done by drag and drop of a particular column from one index to another index.
1197
+ * > If Grid is rendered with stacked headers, reordering is allowed only at the same level as the column headers.
1198
+ * {% codeBlock src='grid/allowReordering/index.md' %}{% endcodeBlock %}
1199
+ *
1200
+ * @default false
1201
+ */
1202
+ allowReordering: boolean;
1203
+ /**
1204
+ * If `allowResizing` is set to true, Grid columns can be resized.
1205
+ * {% codeBlock src='grid/allowResizing/index.md' %}{% endcodeBlock %}
1206
+ *
1207
+ * @default false
1208
+ */
1209
+ allowResizing: boolean;
1210
+ /**
1211
+ * If `allowRowDragAndDrop` is set to true, you can drag and drop grid rows at another grid.
1212
+ * {% codeBlock src='grid/allowRowDragAndDrop/index.md' %}{% endcodeBlock %}
1213
+ *
1214
+ * @default false
1215
+ */
1216
+ allowRowDragAndDrop: boolean;
1217
+ /**
1218
+ * Configures the row drop settings.
1219
+ *
1220
+ * @default {targetID: ''}
1221
+ */
1222
+ rowDropSettings: RowDropSettingsModel;
1223
+ /**
1224
+ * Configures the filter settings of the Grid.
1225
+ * {% codeBlock src='grid/filterSettings/index.md' %}{% endcodeBlock %}
1226
+ *
1227
+ * @default {columns: [], type: 'FilterBar', mode: 'Immediate', showFilterBarStatus: true, immediateModeDelay: 1500 , operators: {}}
1228
+ */
1229
+ filterSettings: FilterSettingsModel;
1230
+ /**
1231
+ * If `allowGrouping` set to true, then it will allow the user to dynamically group or ungroup columns.
1232
+ * Grouping can be done by drag and drop columns from column header to group drop area.
1233
+ *
1234
+ * > Check the [`Grouping`](../../grid/grouping/grouping/) to customize its default behavior.
1235
+ * {% codeBlock src='grid/allowGrouping/index.md' %}{% endcodeBlock %}
1236
+ *
1237
+ * @default false
1238
+ */
1239
+ allowGrouping: boolean;
1240
+ /**
1241
+ * If `enableImmutableMode` is set to true, the grid will reuse old rows if it exists in the new result instead of
1242
+ * full refresh while performing the grid actions.
1243
+ *
1244
+ * @default false
1245
+ */
1246
+ enableImmutableMode: boolean;
1247
+ /**
1248
+ * If `showColumnMenu` set to true, then it will enable the column menu options in each columns.
1249
+ *
1250
+ * > Check the [`Column menu`](../../grid/columns/column-menu/) for its configuration.
1251
+ * {% codeBlock src='grid/showColumnMenu/index.md' %}{% endcodeBlock %}
1252
+ *
1253
+ * @default false
1254
+ */
1255
+ showColumnMenu: boolean;
1256
+ /**
1257
+ * Configures the group settings.
1258
+ * {% codeBlock src='grid/groupSettings/index.md' %}{% endcodeBlock %}
1259
+ *
1260
+ * @default {showDropArea: true, showToggleButton: false, showGroupedColumn: false, showUngroupButton: true, columns: []}
1261
+ */
1262
+ groupSettings: GroupSettingsModel;
1263
+ /**
1264
+ * Configures the edit settings.
1265
+ * {% codeBlock src='grid/editSettings/index.md' %}{% endcodeBlock %}
1266
+ *
1267
+ * @default { allowAdding: false, allowEditing: false, allowDeleting: false, mode:'Normal',
1268
+ * allowEditOnDblClick: true, showConfirmDialog: true, showDeleteConfirmDialog: false }
1269
+ */
1270
+ editSettings: EditSettingsModel;
1271
+ /**
1272
+ * Configures the Grid aggregate rows.
1273
+ * {% codeBlock src='grid/aggregates/index.md' %}{% endcodeBlock %}
1274
+ * > Check the [`Aggregates`](../../grid/aggregates/aggregates/) for its configuration.
1275
+ *
1276
+ * @default []
1277
+ */
1278
+ aggregates: AggregateRowModel[];
1279
+ /**
1280
+ * If `showColumnChooser` is set to true, it allows you to dynamically show or hide columns.
1281
+ *
1282
+ * > Check the [`ColumnChooser`](../../grid/columns/column-chooser/) for its configuration.
1283
+ * {% codeBlock src='grid/showColumnChooser/index.md' %}{% endcodeBlock %}
1284
+ *
1285
+ * @default false
1286
+ */
1287
+ showColumnChooser: boolean;
1288
+ /**
1289
+ * Configures the column chooser in the Grid.
1290
+ *
1291
+ * @default { columnChooserOperator: 'startsWith' }
1292
+ */
1293
+ columnChooserSettings: ColumnChooserSettingsModel;
1294
+ /**
1295
+ * If `enableHeaderFocus` set to true, then header element will be focused when focus moves to grid.
1296
+ *
1297
+ * @default false
1298
+ */
1299
+ enableHeaderFocus: boolean;
1300
+ /**
1301
+ * Defines the scrollable height of the grid content.
1302
+ * {% codeBlock src='grid/height/index.md' %}{% endcodeBlock %}
1303
+ *
1304
+ * @default 'auto'
1305
+ */
1306
+ height: string | number;
1307
+ /**
1308
+ * Defines the Grid width.
1309
+ * {% codeBlock src='grid/width/index.md' %}{% endcodeBlock %}
1310
+ *
1311
+ * @default 'auto'
1312
+ */
1313
+ width: string | number;
1314
+ /**
1315
+ * Defines the mode of grid lines. The available modes are,
1316
+ * * `Both`: Displays both horizontal and vertical grid lines.
1317
+ * * `None`: No grid lines are displayed.
1318
+ * * `Horizontal`: Displays the horizontal grid lines only.
1319
+ * * `Vertical`: Displays the vertical grid lines only.
1320
+ * * `Default`: Displays grid lines based on the theme.
1321
+ * {% codeBlock src='grid/gridLines/index.md' %}{% endcodeBlock %}
1322
+ *
1323
+ * @default Default
1324
+ */
1325
+ gridLines: GridLine;
1326
+ /**
1327
+ * The row template that renders customized rows from the given template.
1328
+ * By default, Grid renders a table row for every data source item.
1329
+ * > * It accepts either [template string](../../common/template-engine/) or HTML element ID.
1330
+ * > * The row template must be a table row.
1331
+ *
1332
+ * > Check the [`Row Template`](../../grid/row/row-template/) customization.
1333
+ */
1334
+ rowTemplate: string;
1335
+ /**
1336
+ * The detail template allows you to show or hide additional information about a particular row.
1337
+ *
1338
+ * > It accepts either the [template string](../../common/template-engine/) or the HTML element ID.
1339
+ *
1340
+ * {% codeBlock src="grid/detail-template-api/index.ts" %}{% endcodeBlock %}
1341
+ */
1342
+ detailTemplate: string;
1343
+ /**
1344
+ * Defines Grid options to render child Grid.
1345
+ * It requires the [`queryString`](/#querystring) for parent
1346
+ * and child relationship.
1347
+ *
1348
+ * > Check the [`Child Grid`](../../grid/hierarchy-grid/) for its configuration.
1349
+ */
1350
+ childGrid: GridModel;
1351
+ /**
1352
+ * Defines the relationship between parent and child datasource. It acts as the foreign key for parent datasource.
1353
+ */
1354
+ queryString: string;
1355
+ /**
1356
+ * Defines the print modes. The available print modes are
1357
+ * * `AllPages`: Prints all pages of the Grid.
1358
+ * * `CurrentPage`: Prints the current page of the Grid.
1359
+ * {% codeBlock src='grid/printMode/index.md' %}{% endcodeBlock %}
1360
+ *
1361
+ * @default AllPages
1362
+ */
1363
+ printMode: PrintMode;
1364
+ /**
1365
+ * Defines the hierarchy grid print modes. The available modes are
1366
+ * * `Expanded` - Prints the master grid with expanded child grids.
1367
+ * * `All` - Prints the master grid with all the child grids.
1368
+ * * `None` - Prints the master grid alone.
1369
+ *
1370
+ * @default Expanded
1371
+ */
1372
+ hierarchyPrintMode: HierarchyGridPrintMode;
1373
+ /**
1374
+ * It is used to render grid table rows.
1375
+ * If the `dataSource` is an array of JavaScript objects,
1376
+ * then Grid will create instance of [`DataManager`](https://ej2.syncfusion.com/documentation/api/data/dataManager/)
1377
+ * from this `dataSource`.
1378
+ * If the `dataSource` is an existing [`DataManager`](https://ej2.syncfusion.com/documentation/api/data/dataManager/),
1379
+ * the Grid will not initialize a new one.
1380
+ *
1381
+ * > Check the available [`Adaptors`](../../data/adaptors/) to customize the data operation.
1382
+ * {% codeBlock src='grid/dataSource/index.md' %}{% endcodeBlock %}
1383
+ *
1384
+ * @default []
1385
+ * @isGenericType true
1386
+ */
1387
+ dataSource: Object | DataManager | DataResult;
1388
+ /**
1389
+ * Defines the height of Grid rows.
1390
+ * {% codeBlock src='grid/rowHeight/index.md' %}{% endcodeBlock %}
1391
+ *
1392
+ * @default null
1393
+ */
1394
+ rowHeight: number;
1395
+ /**
1396
+ * Defines the external [`Query`](https://ej2.syncfusion.com/documentation/data/api-query.html)
1397
+ * that will be executed along with data processing.
1398
+ * {% codeBlock src='grid/query/index.md' %}{% endcodeBlock %}
1399
+ *
1400
+ * @default null
1401
+ */
1402
+ query: Query;
1403
+ /**
1404
+ * Defines the currencyCode format of the Grid columns
1405
+ *
1406
+ * @private
1407
+ */
1408
+ private currencyCode;
1409
+ /**
1410
+ * `toolbar` defines the ToolBar items of the Grid.
1411
+ * It contains built-in and custom toolbar items.
1412
+ * If a string value is assigned to the `toolbar` option, it is considered as the template for the whole Grid ToolBar.
1413
+ * If an array value is assigned, it is considered as the list of built-in and custom toolbar items in the Grid's Toolbar.
1414
+ * <br><br>
1415
+ * The available built-in ToolBar items are:
1416
+ * * Add: Adds a new record.
1417
+ * * Edit: Edits the selected record.
1418
+ * * Update: Updates the edited record.
1419
+ * * Delete: Deletes the selected record.
1420
+ * * Cancel: Cancels the edit state.
1421
+ * * Search: Searches records by the given key.
1422
+ * * Print: Prints the Grid.
1423
+ * * ExcelExport - Export the Grid to Excel(excelExport() method manually to make export.)
1424
+ * * PdfExport - Export the Grid to PDF(pdfExport() method manually to make export.)
1425
+ * * CsvExport - Export the Grid to CSV(csvExport() method manually to make export.)<br><br>
1426
+ * The following code example implements the custom toolbar items.
1427
+ *
1428
+ * > Check the [`Toolbar`](../../grid/tool-bar/tool-bar-items/#custom-toolbar-items/) to customize its default items.
1429
+ *
1430
+ * {% codeBlock src="grid/toolbar-api/index.ts" %}{% endcodeBlock %}
1431
+ * {% codeBlock src='grid/toolbar/index.md' %}{% endcodeBlock %}
1432
+ *
1433
+ * @default null
1434
+ */
1435
+ toolbar: (ToolbarItems | string | ItemModel | ToolbarItem)[];
1436
+ /**
1437
+ * `contextMenuItems` defines both built-in and custom context menu items.
1438
+ * <br><br>
1439
+ * The available built-in items are,
1440
+ * * `AutoFitAll` - Auto fit the size of all columns.
1441
+ * * `AutoFit` - Auto fit the current column.
1442
+ * * `Group` - Group by current column.
1443
+ * * `Ungroup` - Ungroup by current column.
1444
+ * * `Edit` - Edit the current record.
1445
+ * * `Delete` - Delete the current record.
1446
+ * * `Save` - Save the edited record.
1447
+ * * `Cancel` - Cancel the edited state.
1448
+ * * `Copy` - Copy the selected records.
1449
+ * * `PdfExport` - Export the grid as Pdf format.
1450
+ * * `ExcelExport` - Export the grid as Excel format.
1451
+ * * `CsvExport` - Export the grid as CSV format.
1452
+ * * `SortAscending` - Sort the current column in ascending order.
1453
+ * * `SortDescending` - Sort the current column in descending order.
1454
+ * * `FirstPage` - Go to the first page.
1455
+ * * `PrevPage` - Go to the previous page.
1456
+ * * `LastPage` - Go to the last page.
1457
+ * * `NextPage` - Go to the next page.
1458
+ *
1459
+ * @default null
1460
+ */
1461
+ contextMenuItems: ContextMenuItem[] | ContextMenuItemModel[];
1462
+ /**
1463
+ * `columnMenuItems` defines both built-in and custom column menu items.
1464
+ * <br><br>
1465
+ * The available built-in items are,
1466
+ * * `AutoFitAll` - Auto fit the size of all columns.
1467
+ * * `AutoFit` - Auto fit the current column.
1468
+ * * `Group` - Group by current column.
1469
+ * * `Ungroup` - Ungroup by current column.
1470
+ * * `SortAscending` - Sort the current column in ascending order.
1471
+ * * `SortDescending` - Sort the current column in descending order.
1472
+ * * `Filter` - Filter options will show based on filterSettings property like checkbox filter, excel filter, menu filter.
1473
+ *
1474
+ * @default null
1475
+ */
1476
+ columnMenuItems: ColumnMenuItem[] | ColumnMenuItemModel[];
1477
+ /**
1478
+ * It used to render toolbar template
1479
+ *
1480
+ * @default null
1481
+ */
1482
+ toolbarTemplate: string;
1483
+ /**
1484
+ * It used to render pager template
1485
+ *
1486
+ * @default null
1487
+ */
1488
+ pagerTemplate: string;
1489
+ /**
1490
+ * Gets or sets the number of frozen rows.
1491
+ * {% codeBlock src='grid/frozenRows/index.md' %}{% endcodeBlock %}
1492
+ *
1493
+ * @default 0
1494
+ */
1495
+ frozenRows: number;
1496
+ /**
1497
+ * Gets or sets the number of frozen columns.
1498
+ * {% codeBlock src='grid/frozenColumns/index.md' %}{% endcodeBlock %}
1499
+ *
1500
+ * @default 0
1501
+ */
1502
+ frozenColumns: number;
1503
+ /**
1504
+ * Defines the own class for the grid element.
1505
+ *
1506
+ * @default ''
1507
+ */
1508
+ cssClass: string;
1509
+ /**
1510
+ * `columnQueryMode`provides options to retrive data from the datasource.Their types are
1511
+ * * `All`: It Retrives whole datasource.
1512
+ * * `Schema`: Retrives data for all the defined columns in grid from the datasource.
1513
+ * * `ExcludeHidden`: Retrives data only for visible columns of grid from the dataSource.
1514
+ *
1515
+ * @default All
1516
+ */
1517
+ columnQueryMode: ColumnQueryModeType;
1518
+ /**
1519
+ * Gets or sets the current action details.
1520
+ *
1521
+ * @default {}
1522
+ */
1523
+ currentAction: ActionArgs;
1524
+ /**
1525
+ * Defines the version for Grid persistence.
1526
+ */
1527
+ ej2StatePersistenceVersion: string;
1528
+ /**
1529
+ * Triggers when the component is created.
1530
+ *
1531
+ * @event created
1532
+ */
1533
+ created: EmitType<Object>;
1534
+ /**
1535
+ * Triggers when the component is destroyed.
1536
+ *
1537
+ * @event destroyed
1538
+ */
1539
+ destroyed: EmitType<Object>;
1540
+ /**
1541
+ * This event allows customization of Grid properties before rendering.
1542
+ *
1543
+ * @event load
1544
+ */
1545
+ load: EmitType<Object>;
1546
+ /**
1547
+ * Triggered every time a request is made to access row information, element, or data.
1548
+ * This will be triggered before the row element is appended to the Grid element.
1549
+ *
1550
+ * @event rowDataBound
1551
+ */
1552
+ rowDataBound: EmitType<RowDataBoundEventArgs>;
1553
+ /**
1554
+ * Triggered every time a request is made to access cell information, element, or data.
1555
+ * This will be triggered before the cell element is appended to the Grid element.
1556
+ *
1557
+ * @event queryCellInfo
1558
+ */
1559
+ queryCellInfo: EmitType<QueryCellInfoEventArgs>;
1560
+ /**
1561
+ * Triggered for stacked header.
1562
+ *
1563
+ * @event headerCellInfo
1564
+ */
1565
+ headerCellInfo: EmitType<HeaderCellInfoEventArgs>;
1566
+ /**
1567
+ * Triggers when Grid actions such as sorting, filtering, paging, grouping etc., starts.
1568
+ *
1569
+ * {% codeBlock src='grid/actionBegin/index.md' %}{% endcodeBlock %}
1570
+ *
1571
+ * @event actionBegin
1572
+ */
1573
+ actionBegin: EmitType<PageEventArgs | GroupEventArgs | FilterEventArgs | SearchEventArgs | SortEventArgs | AddEventArgs | SaveEventArgs | EditEventArgs | DeleteEventArgs | ActionEventArgs>;
1574
+ /**
1575
+ * Triggers when Grid actions such as sorting, filtering, paging, grouping etc. are completed.
1576
+ *
1577
+ * @event actionComplete
1578
+ */
1579
+ actionComplete: EmitType<PageEventArgs | GroupEventArgs | FilterEventArgs | SearchEventArgs | SortEventArgs | AddEventArgs | SaveEventArgs | EditEventArgs | DeleteEventArgs | ActionEventArgs>;
1580
+ /**
1581
+ * Triggers when any Grid action failed to achieve the desired results.
1582
+ *
1583
+ * @event actionFailure
1584
+ */
1585
+ actionFailure: EmitType<FailureEventArgs>;
1586
+ /**
1587
+ * Triggers when data source is populated in the Grid.
1588
+ *
1589
+ * @event dataBound
1590
+ */
1591
+ dataBound: EmitType<Object>;
1592
+ /**
1593
+ * Triggers when record is double clicked.
1594
+ *
1595
+ * @event recordDoubleClick
1596
+ */
1597
+ recordDoubleClick: EmitType<RecordDoubleClickEventArgs>;
1598
+ /**
1599
+ * Triggers when record is clicked.
1600
+ *
1601
+ * @event recordClick
1602
+ */
1603
+ recordClick: EmitType<RecordClickEventArgs>;
1604
+ /**
1605
+ * Triggers before row selection occurs.
1606
+ *
1607
+ * @event rowSelecting
1608
+ */
1609
+ rowSelecting: EmitType<RowSelectingEventArgs>;
1610
+ /**
1611
+ * Triggers after a row is selected.
1612
+ *
1613
+ * @event rowSelected
1614
+ */
1615
+ rowSelected: EmitType<RowSelectEventArgs>;
1616
+ /**
1617
+ * Triggers before deselecting the selected row.
1618
+ *
1619
+ * @event rowDeselecting
1620
+ */
1621
+ rowDeselecting: EmitType<RowDeselectEventArgs>;
1622
+ /**
1623
+ * Triggers when a selected row is deselected.
1624
+ *
1625
+ * @event rowDeselected
1626
+ */
1627
+ rowDeselected: EmitType<RowDeselectEventArgs>;
1628
+ /**
1629
+ * Triggers before any cell selection occurs.
1630
+ *
1631
+ * @event cellSelecting
1632
+ */
1633
+ cellSelecting: EmitType<CellSelectingEventArgs>;
1634
+ /**
1635
+ * Triggers after a cell is selected.
1636
+ *
1637
+ * @event cellSelected
1638
+ */
1639
+ cellSelected: EmitType<CellSelectEventArgs>;
1640
+ /**
1641
+ * Triggers before the selected cell is deselecting.
1642
+ *
1643
+ * @event cellDeselecting
1644
+ */
1645
+ cellDeselecting: EmitType<CellDeselectEventArgs>;
1646
+ /**
1647
+ * Triggers when a particular selected cell is deselected.
1648
+ *
1649
+ * @event cellDeselected
1650
+ */
1651
+ cellDeselected: EmitType<CellDeselectEventArgs>;
1652
+ /**
1653
+ * Triggers before column selection occurs.
1654
+ *
1655
+ * @event columnSelecting
1656
+ */
1657
+ columnSelecting: EmitType<ColumnSelectingEventArgs>;
1658
+ /**
1659
+ * Triggers after a column is selected.
1660
+ *
1661
+ * @event columnSelected
1662
+ */
1663
+ columnSelected: EmitType<ColumnSelectEventArgs>;
1664
+ /**
1665
+ * Triggers before deselecting the selected column.
1666
+ *
1667
+ * @event columnDeselecting
1668
+ */
1669
+ columnDeselecting: EmitType<ColumnDeselectEventArgs>;
1670
+ /**
1671
+ * Triggers when a selected column is deselected.
1672
+ *
1673
+ * @event columnDeselected
1674
+ */
1675
+ columnDeselected: EmitType<ColumnDeselectEventArgs>;
1676
+ /**
1677
+ * Triggers when column header element drag (move) starts.
1678
+ *
1679
+ * @event columnDragStart
1680
+ */
1681
+ columnDragStart: EmitType<ColumnDragEventArgs>;
1682
+ /**
1683
+ * Triggers when column header element is dragged (moved) continuously.
1684
+ *
1685
+ * @event columnDrag
1686
+ */
1687
+ columnDrag: EmitType<ColumnDragEventArgs>;
1688
+ /**
1689
+ * Triggers when a column header element is dropped on the target column.
1690
+ *
1691
+ * @event columnDrop
1692
+ */
1693
+ columnDrop: EmitType<ColumnDragEventArgs>;
1694
+ /**
1695
+ * Triggers after print action is completed.
1696
+ *
1697
+ * @event printComplete
1698
+ */
1699
+ printComplete: EmitType<PrintEventArgs>;
1700
+ /**
1701
+ * Triggers before the print action starts.
1702
+ *
1703
+ * @event beforePrint
1704
+ */
1705
+ beforePrint: EmitType<PrintEventArgs>;
1706
+ /**
1707
+ * Triggers before exporting each cell to PDF document. You can also customize the PDF cells.
1708
+ *
1709
+ * @event pdfQueryCellInfo
1710
+ */
1711
+ pdfQueryCellInfo: EmitType<PdfQueryCellInfoEventArgs>;
1712
+ /**
1713
+ * Triggers before exporting each header cell to PDF document. You can also customize the PDF cells.
1714
+ *
1715
+ * @event pdfHeaderQueryCellInfo
1716
+ */
1717
+ pdfHeaderQueryCellInfo: EmitType<PdfHeaderQueryCellInfoEventArgs>;
1718
+ /**
1719
+ * Triggers before exporting aggregate cell to PDF document. You can also customize the PDF cells.
1720
+ *
1721
+ * @event pdfAggregateQueryCellInfo
1722
+ */
1723
+ pdfAggregateQueryCellInfo: EmitType<AggregateQueryCellInfoEventArgs>;
1724
+ /**
1725
+ * Triggers before exporting aggregate cell to Excel document. You can also customize the PDF cells.
1726
+ *
1727
+ * @event excelAggregateQueryCellInfo
1728
+ */
1729
+ excelAggregateQueryCellInfo: EmitType<AggregateQueryCellInfoEventArgs>;
1730
+ /**
1731
+ * Triggers before exporting each detail Grid to PDF document.
1732
+ *
1733
+ * @event exportDetailDataBound
1734
+ */
1735
+ exportDetailDataBound: EmitType<ExportDetailDataBoundEventArgs>;
1736
+ /**
1737
+ * Triggers before exporting each cell to Excel file.
1738
+ * You can also customize the Excel cells.
1739
+ *
1740
+ * @event excelQueryCellInfo
1741
+ */
1742
+ excelQueryCellInfo: EmitType<ExcelQueryCellInfoEventArgs>;
1743
+ /**
1744
+ * Triggers before exporting each header cell to Excel file.
1745
+ * You can also customize the Excel cells.
1746
+ *
1747
+ * @event excelHeaderQueryCellInfo
1748
+ */
1749
+ excelHeaderQueryCellInfo: EmitType<ExcelHeaderQueryCellInfoEventArgs>;
1750
+ /**
1751
+ * Triggers before Grid data is exported to Excel file.
1752
+ *
1753
+ * @event beforeExcelExport
1754
+ */
1755
+ beforeExcelExport: EmitType<Object>;
1756
+ /**
1757
+ * Triggers after Grid data is exported to Excel file.
1758
+ *
1759
+ * @event excelExportComplete
1760
+ */
1761
+ excelExportComplete: EmitType<ExcelExportCompleteArgs>;
1762
+ /**
1763
+ * Triggers before Grid data is exported to PDF document.
1764
+ *
1765
+ * @event beforePdfExport
1766
+ */
1767
+ beforePdfExport: EmitType<Object>;
1768
+ /**
1769
+ * Triggers after Grid data is exported to PDF document.
1770
+ *
1771
+ * @event pdfExportComplete
1772
+ */
1773
+ pdfExportComplete: EmitType<PdfExportCompleteArgs>;
1774
+ /**
1775
+ * Triggers when row element's before drag(move).
1776
+ *
1777
+ * @event rowDragStartHelper
1778
+ */
1779
+ rowDragStartHelper: EmitType<RowDragEventArgs>;
1780
+ /**
1781
+ * Triggers after detail row expands.
1782
+ * > This event triggers at initial expand.
1783
+ *
1784
+ * @event detailDataBound
1785
+ */
1786
+ detailDataBound: EmitType<DetailDataBoundEventArgs>;
1787
+ /**
1788
+ * Triggers when row element's drag(move) starts.
1789
+ *
1790
+ * @event rowDragStart
1791
+ */
1792
+ rowDragStart: EmitType<RowDragEventArgs>;
1793
+ /**
1794
+ * Triggers when row elements are dragged (moved) continuously.
1795
+ *
1796
+ * @event rowDrag
1797
+ */
1798
+ rowDrag: EmitType<RowDragEventArgs>;
1799
+ /**
1800
+ * Triggers when row elements are dropped on the target row.
1801
+ *
1802
+ * @event rowDrop
1803
+ */
1804
+ rowDrop: EmitType<RowDragEventArgs>;
1805
+ /**
1806
+ * Triggers when toolbar item is clicked.
1807
+ *
1808
+ * @event toolbarClick
1809
+ */
1810
+ toolbarClick: EmitType<ClickEventArgs>;
1811
+ /**
1812
+ * Triggers before the columnChooser open.
1813
+ *
1814
+ * @event beforeOpenColumnChooser
1815
+ */
1816
+ beforeOpenColumnChooser: EmitType<ColumnChooserEventArgs>;
1817
+ /**
1818
+ * Triggers before adaptive filter and sort dialogs open.
1819
+ *
1820
+ * @event beforeOpenAdaptiveDialog
1821
+ */
1822
+ beforeOpenAdaptiveDialog: EmitType<AdaptiveDialogEventArgs>;
1823
+ /**
1824
+ * Triggers when records are added in batch mode.
1825
+ *
1826
+ * @event batchAdd
1827
+ */
1828
+ batchAdd: EmitType<BatchAddArgs>;
1829
+ /**
1830
+ * Triggers when records are deleted in batch mode.
1831
+ *
1832
+ * @event batchDelete
1833
+ */
1834
+ batchDelete: EmitType<BatchDeleteArgs>;
1835
+ /**
1836
+ * Triggers when cancel the batch edit changes batch mode.
1837
+ *
1838
+ * @event batchCancel
1839
+ */
1840
+ batchCancel: EmitType<BatchCancelArgs>;
1841
+ /**
1842
+ * Triggers before records are added in batch mode.
1843
+ *
1844
+ * @event beforeBatchAdd
1845
+ */
1846
+ beforeBatchAdd: EmitType<BeforeBatchAddArgs>;
1847
+ /**
1848
+ * Triggers before records are deleted in batch mode.
1849
+ *
1850
+ * @event beforeBatchDelete
1851
+ */
1852
+ beforeBatchDelete: EmitType<BeforeBatchDeleteArgs>;
1853
+ /**
1854
+ * Triggers before records are saved in batch mode.
1855
+ *
1856
+ * @event beforeBatchSave
1857
+ */
1858
+ beforeBatchSave: EmitType<BeforeBatchSaveArgs>;
1859
+ /**
1860
+ * Triggers before the record is to be edit.
1861
+ *
1862
+ * @event beginEdit
1863
+ */
1864
+ beginEdit: EmitType<BeginEditArgs>;
1865
+ /**
1866
+ * Triggers when command button is clicked.
1867
+ *
1868
+ * @event commandClick
1869
+ */
1870
+ commandClick: EmitType<CommandClickEventArgs>;
1871
+ /**
1872
+ * Triggers when the cell is being edited.
1873
+ *
1874
+ * @event cellEdit
1875
+ */
1876
+ cellEdit: EmitType<CellEditArgs>;
1877
+ /**
1878
+ * Triggers when cell is saved.
1879
+ *
1880
+ * @event cellSave
1881
+ */
1882
+ cellSave: EmitType<CellSaveArgs>;
1883
+ /**
1884
+ * Triggers when cell is saved.
1885
+ *
1886
+ * @event cellSaved
1887
+ */
1888
+ cellSaved: EmitType<CellSaveArgs>;
1889
+ /**
1890
+ * Triggers when column resize starts.
1891
+ *
1892
+ * @event resizeStart
1893
+ */
1894
+ resizeStart: EmitType<ResizeArgs>;
1895
+ /**
1896
+ * Triggers on column resizing.
1897
+ *
1898
+ * @event resizing
1899
+ */
1900
+ resizing: EmitType<ResizeArgs>;
1901
+ /**
1902
+ * Triggers when column resize ends.
1903
+ *
1904
+ * @event resizeStop
1905
+ */
1906
+ resizeStop: EmitType<ResizeArgs>;
1907
+ /**
1908
+ * Triggers when any keyboard keys are pressed inside the grid.
1909
+ *
1910
+ * @event keyPressed
1911
+ */
1912
+ keyPressed: EmitType<KeyboardEventArgs>;
1913
+ /**
1914
+ * Triggers before data is bound to Grid.
1915
+ *
1916
+ * @event beforeDataBound
1917
+ */
1918
+ beforeDataBound: EmitType<BeforeDataBoundArgs>;
1919
+ /**
1920
+ * Triggers before context menu opens.
1921
+ *
1922
+ * @event contextMenuOpen
1923
+ */
1924
+ contextMenuOpen: EmitType<BeforeOpenCloseMenuEventArgs>;
1925
+ /**
1926
+ * Triggers when click on context menu.
1927
+ *
1928
+ * @event contextMenuClick
1929
+ */
1930
+ contextMenuClick: EmitType<MenuEventArgs>;
1931
+ /**
1932
+ * Triggers before column menu opens.
1933
+ *
1934
+ * @event columnMenuOpen
1935
+ */
1936
+ columnMenuOpen: EmitType<ColumnMenuOpenEventArgs>;
1937
+ /**
1938
+ * Triggers when click on column menu.
1939
+ *
1940
+ * @event columnMenuClick
1941
+ */
1942
+ columnMenuClick: EmitType<MenuEventArgs>;
1943
+ /**
1944
+ * Triggers when the check box state change in checkbox column.
1945
+ *
1946
+ * @event checkBoxChange
1947
+ */
1948
+ checkBoxChange: EmitType<CheckBoxChangeEventArgs>;
1949
+ /**
1950
+ * Triggers before Grid copy action.
1951
+ *
1952
+ * @event beforeCopy
1953
+ */
1954
+ beforeCopy: EmitType<BeforeCopyEventArgs>;
1955
+ /**
1956
+ * Triggers before Grid paste action.
1957
+ *
1958
+ * @event beforePaste
1959
+ */
1960
+ beforePaste: EmitType<BeforePasteEventArgs>;
1961
+ /**
1962
+ * Triggers before Grid autoFill action.
1963
+ *
1964
+ * @event beforeAutoFill
1965
+ */
1966
+ beforeAutoFill: EmitType<BeforeAutoFillEventArgs>;
1967
+ /**
1968
+ * Triggers when the grid actions such as Sorting, Paging, Grouping etc., are done to get column `dataSource`.
1969
+ * In this event,the current view column data and total record count should be assigned to the column `dataSource` based
1970
+ * on the action performed.
1971
+ *
1972
+ * @event columnDataStateChange
1973
+ */
1974
+ columnDataStateChange: EmitType<ColumnDataStateChangeEventArgs>;
1975
+ /**
1976
+ * Triggers when the grid actions such as Sorting, Paging, Grouping etc., are done.
1977
+ * In this event,the current view data and total record count should be assigned to the `dataSource` based on the action performed.
1978
+ *
1979
+ * @event dataStateChange
1980
+ */
1981
+ dataStateChange: EmitType<DataStateChangeEventArgs>;
1982
+ /**
1983
+ * Triggers when the grid data is added, deleted and updated.
1984
+ * Invoke the done method from the argument to start render after edit operation.
1985
+ *
1986
+ * @event dataSourceChanged
1987
+ */
1988
+ dataSourceChanged: EmitType<DataSourceChangedEventArgs>;
1989
+ /**
1990
+ * Triggers before exporting each caption row to PDF/Excel/CSV document. You can also customize the export caption row values.
1991
+ *
1992
+ * @event exportGroupCaption
1993
+ */
1994
+ exportGroupCaption: EmitType<ExportGroupCaptionEventArgs>;
1995
+ /**
1996
+ * Triggers when expand the caption row in lazy load grouping.
1997
+ *
1998
+ * @event lazyLoadGroupExpand
1999
+ */
2000
+ lazyLoadGroupExpand: EmitType<LazyLoadArgs>;
2001
+ /**
2002
+ * Triggers when collapse the caption row in lazy load grouping.
2003
+ *
2004
+ * @event lazyLoadGroupCollapse
2005
+ */
2006
+ lazyLoadGroupCollapse: EmitType<LazyLoadArgs>;
2007
+ /**
2008
+ * Constructor for creating the component
2009
+ *
2010
+ * @param {GridModel} options - specifies the options
2011
+ * @param {string | HTMLElement} element - specifies the element
2012
+ * @hidden
2013
+ */
2014
+ constructor(options?: GridModel, element?: string | HTMLElement);
2015
+ /**
2016
+ * Get the properties to be maintained in the persisted state.
2017
+ *
2018
+ * @returns {string} returns the persist data
2019
+ */
2020
+ getPersistData(): string;
2021
+ /**
2022
+ * To provide the array of modules needed for component rendering
2023
+ *
2024
+ * @returns {ModuleDeclaration[]} Returns the module Declaration
2025
+ * @hidden
2026
+ */
2027
+ requiredModules(): ModuleDeclaration[];
2028
+ extendRequiredModules(modules: ModuleDeclaration[]): void;
2029
+ /**
2030
+ * For internal use only - Initialize the event handler;
2031
+ *
2032
+ * @returns {void}
2033
+ * @private
2034
+ */
2035
+ protected preRender(): void;
2036
+ private initProperties;
2037
+ /**
2038
+ * For internal use only - To Initialize the component rendering.
2039
+ *
2040
+ * @returns {void}
2041
+ * @private
2042
+ */
2043
+ protected render(): void;
2044
+ /**
2045
+ * By default, grid shows the spinner for all its actions. You can use this method to show spinner at your needed time.
2046
+ *
2047
+ * @returns {void}
2048
+ */
2049
+ showSpinner(): void;
2050
+ /**
2051
+ * By default, grid shows the spinner for all its actions. You can use this method to show spinner at your needed time.
2052
+ *
2053
+ * @returns {void}
2054
+ */
2055
+ hideSpinner(): void;
2056
+ showMaskRow(axisDirection?: string, dialogElement?: Element): void;
2057
+ private getContentMaskColumns;
2058
+ private getMovableContentMaskColumns;
2059
+ private getRightContentMaskColumns;
2060
+ private createEmptyMaskTable;
2061
+ private createMaskTable;
2062
+ private applyMaskRow;
2063
+ private createMaskRow;
2064
+ private getShimmerTemplate;
2065
+ addShimmerEffect(): void;
2066
+ private translateMaskRow;
2067
+ removeMaskRow(): void;
2068
+ private refreshMaskRow;
2069
+ private refreshMaskRowColgroupWidth;
2070
+ private updateStackedFilter;
2071
+ getMediaColumns(): void;
2072
+ private pushMediaColumn;
2073
+ /**
2074
+ * @param {Column} col - specifies the column
2075
+ * @returns {void}
2076
+ * @hidden
2077
+ */
2078
+ updateMediaColumns(col: Column): void;
2079
+ /**
2080
+ * @param {number} columnIndex - specifies the column index
2081
+ * @param {MediaQueryList} e - specifies the MediaQueryList
2082
+ * @returns {void}
2083
+ * @hidden
2084
+ */
2085
+ mediaQueryUpdate(columnIndex: number, e?: MediaQueryList): void;
2086
+ private refreshMediaCol;
2087
+ private removeMediaListener;
2088
+ /**
2089
+ * For internal use only - Initialize the event handler
2090
+ *
2091
+ * @returns {void}
2092
+ * @private
2093
+ */
2094
+ protected eventInitializer(): void;
2095
+ /**
2096
+ * Destroys the component (detaches/removes all event handlers, attributes, classes, and empties the component element).
2097
+ *
2098
+ * @function destroy
2099
+ * @returns {void}
2100
+ */
2101
+ destroy(): void;
2102
+ private destroyDependentModules;
2103
+ /**
2104
+ * For internal use only - Get the module name.
2105
+ *
2106
+ * @returns {string} returns the module name
2107
+ * @private
2108
+ */
2109
+ protected getModuleName(): string;
2110
+ private enableBoxSelection;
2111
+ private setCSSClass;
2112
+ /**
2113
+ * Called internally if any of the property value changed.
2114
+ *
2115
+ * @param {GridModel} newProp - Defines new properties
2116
+ * @param {GridModel} oldProp - Defines old properties
2117
+ * @returns {void}
2118
+ * @hidden
2119
+ */
2120
+ onPropertyChanged(newProp: GridModel, oldProp: GridModel): void;
2121
+ private extendedPropertyChange;
2122
+ private maintainSelection;
2123
+ /**
2124
+ * @param {Object} prop - Defines the property
2125
+ * @param {boolean} muteOnChange - Defines the mute on change
2126
+ * @returns {void}
2127
+ * @private
2128
+ */
2129
+ setProperties(prop: Object, muteOnChange?: boolean): void;
2130
+ /**
2131
+ * @hidden
2132
+ * @returns {void}
2133
+ */
2134
+ setTablesCount(): void;
2135
+ /**
2136
+ * @hidden
2137
+ * @returns {number} - Returns the tables count
2138
+ */
2139
+ getTablesCount(): number;
2140
+ /**
2141
+ * @hidden
2142
+ * @returns {void}
2143
+ */
2144
+ updateDefaultCursor(): void;
2145
+ private updateColumnModel;
2146
+ private updateColumnLevelFrozen;
2147
+ private updateFrozenColumns;
2148
+ getFrozenLeftCount(): number;
2149
+ isFrozenGrid(): boolean;
2150
+ getFrozenMode(): freezeMode;
2151
+ private updateLockableColumns;
2152
+ private checkLockColumns;
2153
+ /**
2154
+ * Gets the columns from the Grid.
2155
+ *
2156
+ * @param {boolean} isRefresh - Defines the boolean whether to refresh
2157
+ * @returns {Column[]} - returns the column
2158
+ */
2159
+ getColumns(isRefresh?: boolean): Column[];
2160
+ /**
2161
+ * @private
2162
+ * @param {string} stackedHeader - Defines the stacked header
2163
+ * @param {Column[]} col - Defines the column
2164
+ * @returns {Column} Returns the Column
2165
+ */
2166
+ getStackedHeaderColumnByHeaderText(stackedHeader: string, col: Column[]): Column;
2167
+ /**
2168
+ * @private
2169
+ * @returns {number[]} Returns the column indexes
2170
+ */
2171
+ getColumnIndexesInView(): number[];
2172
+ /**
2173
+ * @private
2174
+ * @returns {Query} - returns the query
2175
+ */
2176
+ getQuery(): Query;
2177
+ /**
2178
+ * @private
2179
+ * @returns {object} - returns the locale constants
2180
+ */
2181
+ getLocaleConstants(): Object;
2182
+ /**
2183
+ * @param {number[]} indexes - specifies the indexes
2184
+ * @returns {void}
2185
+ * @private
2186
+ */
2187
+ setColumnIndexesInView(indexes: number[]): void;
2188
+ /**
2189
+ * Gets the visible columns from the Grid.
2190
+ *
2191
+ * @returns {Column[]} returns the column
2192
+ */
2193
+ getVisibleColumns(): Column[];
2194
+ /**
2195
+ * Gets the header div of the Grid.
2196
+ *
2197
+ * @returns {Element} - Returns the element
2198
+ */
2199
+ getHeaderContent(): Element;
2200
+ /**
2201
+ * Sets the header div of the Grid to replace the old header.
2202
+ *
2203
+ * @param {Element} element - Specifies the Grid header.
2204
+ * @returns {void}
2205
+ */
2206
+ setGridHeaderContent(element: Element): void;
2207
+ /**
2208
+ * Gets the content table of the Grid.
2209
+ *
2210
+ * @returns {Element} - Returns the element
2211
+ */
2212
+ getContentTable(): Element;
2213
+ /**
2214
+ * Sets the content table of the Grid to replace the old content table.
2215
+ *
2216
+ * @param {Element} element - Specifies the Grid content table.
2217
+ * @returns {void}
2218
+ */
2219
+ setGridContentTable(element: Element): void;
2220
+ /**
2221
+ * Gets the content div of the Grid.
2222
+ *
2223
+ * @returns {Element} Returns the element
2224
+ */
2225
+ getContent(): Element;
2226
+ /**
2227
+ * Sets the content div of the Grid to replace the old Grid content.
2228
+ *
2229
+ * @param {Element} element - Specifies the Grid content.
2230
+ * @returns {void}
2231
+ */
2232
+ setGridContent(element: Element): void;
2233
+ /**
2234
+ * Gets the header table element of the Grid.
2235
+ *
2236
+ * @returns {Element} returns the element
2237
+ */
2238
+ getHeaderTable(): Element;
2239
+ /**
2240
+ * Sets the header table of the Grid to replace the old one.
2241
+ *
2242
+ * @param {Element} element - Specifies the Grid header table.
2243
+ * @returns {void}
2244
+ */
2245
+ setGridHeaderTable(element: Element): void;
2246
+ /**
2247
+ * Gets the footer div of the Grid.
2248
+ *
2249
+ * @returns {Element} returns the element
2250
+ */
2251
+ getFooterContent(): Element;
2252
+ /**
2253
+ * Gets the footer table element of the Grid.
2254
+ *
2255
+ * @returns {Element} returns the element
2256
+ */
2257
+ getFooterContentTable(): Element;
2258
+ /**
2259
+ * Gets the pager of the Grid.
2260
+ *
2261
+ * @returns {Element} returns the element
2262
+ */
2263
+ getPager(): Element;
2264
+ /**
2265
+ * Sets the pager of the Grid to replace the old pager.
2266
+ *
2267
+ * @param {Element} element - Specifies the Grid pager.
2268
+ * @returns {void}
2269
+ */
2270
+ setGridPager(element: Element): void;
2271
+ /**
2272
+ * Gets a row by index.
2273
+ *
2274
+ * @param {number} index - Specifies the row index.
2275
+ * @returns {Element} returns the element
2276
+ */
2277
+ getRowByIndex(index: number): Element;
2278
+ /**
2279
+ * Gets a movable tables row by index.
2280
+ *
2281
+ * @param {number} index - Specifies the row index.
2282
+ * @returns {Element} returns the element
2283
+ */
2284
+ getMovableRowByIndex(index: number): Element;
2285
+ /**
2286
+ * Gets a frozen tables row by index.
2287
+ *
2288
+ * @param {number} index - Specifies the row index.
2289
+ * @returns {Element} returns the element
2290
+ */
2291
+ getFrozenRowByIndex(index: number): Element;
2292
+ /**
2293
+ * Gets all the data rows of the Grid.
2294
+ *
2295
+ * @returns {Element[]} returns the element
2296
+ */
2297
+ getRows(): Element[];
2298
+ /**
2299
+ * Gets a frozen right tables row element by index.
2300
+ *
2301
+ * @param {number} index - Specifies the row index.
2302
+ * @returns {Element} returns the element
2303
+ */
2304
+ getFrozenRightRowByIndex(index: number): Element;
2305
+ /**
2306
+ * Get a row information based on cell
2307
+ *
2308
+ * @param {Element | EventTarget} target - specifies the element
2309
+ * @returns {RowInfo} returns the row info
2310
+ */
2311
+ getRowInfo(target: Element | EventTarget): RowInfo;
2312
+ /**
2313
+ * Gets the Grid's movable content rows from frozen grid.
2314
+ *
2315
+ * @returns {Element[]} returns the element
2316
+ */
2317
+ getMovableRows(): Element[];
2318
+ /**
2319
+ * Gets the Grid's frozen right content rows from frozen grid.
2320
+ *
2321
+ * @returns {Element[]} returns the element
2322
+ */
2323
+ getFrozenRightRows(): Element[];
2324
+ /**
2325
+ * Gets all the Grid's data rows.
2326
+ *
2327
+ * @returns {Element[]} returns the element
2328
+ */
2329
+ getDataRows(): Element[];
2330
+ /**
2331
+ * @param {boolean} includeAdd - specifies includeAdd
2332
+ * @returns {Element[]} returns the element
2333
+ * @hidden
2334
+ */
2335
+ getAllDataRows(includeAdd?: boolean): Element[];
2336
+ /**
2337
+ * @param {HTMLElement[]} fRows - Defines the frozen Rows
2338
+ * @param {HTMLElement[]} mrows - Defines the movable Rows
2339
+ * @returns {HTMLElement[]} Returns the element
2340
+ * @hidden
2341
+ */
2342
+ addMovableRows(fRows: HTMLElement[], mrows: HTMLElement[]): HTMLElement[];
2343
+ private generateDataRows;
2344
+ /**
2345
+ * Gets all the Grid's movable table data rows.
2346
+ *
2347
+ * @returns {Element[]} Returns the element
2348
+ */
2349
+ getMovableDataRows(): Element[];
2350
+ /**
2351
+ * @param {boolean} includeAdd Defines the include add in boolean
2352
+ * @returns {Element[]} Returns the element
2353
+ * @hidden
2354
+ */
2355
+ getAllMovableDataRows(includeAdd?: boolean): Element[];
2356
+ /**
2357
+ * Gets all the Grid's frozen table data rows.
2358
+ *
2359
+ * @returns {Element[]} returns the element
2360
+ */
2361
+ getFrozenDataRows(): Element[];
2362
+ /**
2363
+ * @param {boolean} includeAdd Defines the include add in boolean
2364
+ * @returns {Element[]} Returns the element
2365
+ * @hidden
2366
+ */
2367
+ getAllFrozenDataRows(includeAdd?: boolean): Element[];
2368
+ /**
2369
+ * Gets all the Grid's frozen right table data rows.
2370
+ *
2371
+ * @returns {Element[]} Returns the Element
2372
+ */
2373
+ getFrozenRightDataRows(): Element[];
2374
+ /**
2375
+ * @param {boolean} includeAdd Defines the include add in boolean
2376
+ * @returns {Element[]} Returns the element
2377
+ * @hidden
2378
+ */
2379
+ getAllFrozenRightDataRows(includeAdd?: boolean): Element[];
2380
+ /**
2381
+ * Updates particular cell value based on the given primary key value.
2382
+ * > Primary key column must be specified using `columns.isPrimaryKey` property.
2383
+ *
2384
+ * @param {string| number} key - Specifies the PrimaryKey value of dataSource.
2385
+ * @param {string } field - Specifies the field name which you want to update.
2386
+ * @param {string | number | boolean | Date} value - To update new value for the particular cell.
2387
+ * @returns {void}
2388
+ */
2389
+ setCellValue(key: string | number, field: string, value: string | number | boolean | Date): void;
2390
+ /**
2391
+ * @param {string} columnUid - Defines column uid
2392
+ * @returns {void}
2393
+ * @hidden
2394
+ */
2395
+ refreshReactColumnTemplateByUid(columnUid: string): void;
2396
+ /**
2397
+ * @param {string} columnUid - Defines column uid
2398
+ * @returns {void}
2399
+ * @hidden
2400
+ */
2401
+ refreshReactHeaderTemplateByUid(columnUid: string): void;
2402
+ /**
2403
+ * Updates and refresh the particular row values based on the given primary key value.
2404
+ * > Primary key column must be specified using `columns.isPrimaryKey` property.
2405
+ *
2406
+ * @param {string| number} key - Specifies the PrimaryKey value of dataSource.
2407
+ * @param {Object} rowData - To update new data for the particular row.
2408
+ * @returns {void}
2409
+ */
2410
+ setRowData(key: string | number, rowData?: Object): void;
2411
+ private setFrozenRowData;
2412
+ /**
2413
+ * Gets a cell by row and column index.
2414
+ *
2415
+ * @param {number} rowIndex - Specifies the row index.
2416
+ * @param {number} columnIndex - Specifies the column index.
2417
+ * @returns {Element} Returns the Element
2418
+ */
2419
+ getCellFromIndex(rowIndex: number, columnIndex: number): Element;
2420
+ /**
2421
+ * Gets a movable table cell by row and column index.
2422
+ *
2423
+ * @param {number} rowIndex - Specifies the row index.
2424
+ * @param {number} columnIndex - Specifies the column index.
2425
+ * @returns {Element} Returns the Element
2426
+ */
2427
+ getMovableCellFromIndex(rowIndex: number, columnIndex: number): Element;
2428
+ /**
2429
+ * Gets a frozen right table cell by row and column index.
2430
+ *
2431
+ * @param {number} rowIndex - Specifies the row index.
2432
+ * @param {number} columnIndex - Specifies the column index.
2433
+ * @returns {Element} Returns the Element
2434
+ */
2435
+ getFrozenRightCellFromIndex(rowIndex: number, columnIndex: number): Element;
2436
+ /**
2437
+ * Gets a column header by column index.
2438
+ *
2439
+ * @param {number} index - Specifies the column index.
2440
+ * @returns {Element} Returns the Element
2441
+ */
2442
+ getColumnHeaderByIndex(index: number): Element;
2443
+ /**
2444
+ * Gets a movable column header by column index.
2445
+ *
2446
+ * @param {number} index - Specifies the column index.
2447
+ * @returns {Element} Returns the Element
2448
+ */
2449
+ getMovableColumnHeaderByIndex(index: number): Element;
2450
+ /**
2451
+ * Gets a frozen right column header by column index.
2452
+ *
2453
+ * @param {number} index - Specifies the column index.
2454
+ * @returns {Element} Returns the Element
2455
+ */
2456
+ getFrozenRightColumnHeaderByIndex(index: number): Element;
2457
+ /**
2458
+ * Gets a frozen left column header by column index.
2459
+ *
2460
+ * @param {number} index - Specifies the column index.
2461
+ * @returns {Element} Returns the Element
2462
+ */
2463
+ getFrozenLeftColumnHeaderByIndex(index: number): Element;
2464
+ /**
2465
+ * @param {string} uid - Defines the uid
2466
+ * @param {boolean} isMovable - Defines isMovable
2467
+ * @param {boolean} isFrozenRight - Defines isFrozenRight
2468
+ * @returns {Row<Column>} Returns the row object
2469
+ * @hidden
2470
+ */
2471
+ getRowObjectFromUID(uid: string, isMovable?: boolean, isFrozenRight?: boolean): Row<Column>;
2472
+ private rowObject;
2473
+ /**
2474
+ * @hidden
2475
+ * @returns {Row<Column>[]} Returns the Row object
2476
+ */
2477
+ getRowsObject(): Row<Column>[];
2478
+ /**
2479
+ * @hidden
2480
+ * @returns {Row<Column>[]} Returns the Row object
2481
+ */
2482
+ getMovableRowsObject(): Row<Column>[];
2483
+ /**
2484
+ * @hidden
2485
+ * @returns {Row<Column>[]} Returns the Row object
2486
+ */
2487
+ getFrozenRightRowsObject(): Row<Column>[];
2488
+ /**
2489
+ * Gets a column header by column name.
2490
+ *
2491
+ * @param {string} field - Specifies the column name.
2492
+ * @returns {Element} - Returns the element
2493
+ */
2494
+ getColumnHeaderByField(field: string): Element;
2495
+ /**
2496
+ * Gets a column header by UID.
2497
+ *
2498
+ * @param {string} uid - Specifies the column uid.
2499
+ * @returns {Element} - Returns the element
2500
+ */
2501
+ getColumnHeaderByUid(uid: string): Element;
2502
+ /**
2503
+ * @hidden
2504
+ * @param {number} index - Defines the index
2505
+ * @returns {Column} Returns the column
2506
+ */
2507
+ getColumnByIndex(index: number): Column;
2508
+ /**
2509
+ * Gets a Column by column name.
2510
+ *
2511
+ * @param {string} field - Specifies the column name.
2512
+ * @returns {Column} Returns the column
2513
+ */
2514
+ getColumnByField(field: string): Column;
2515
+ /**
2516
+ * Gets a column index by column name.
2517
+ *
2518
+ * @param {string} field - Specifies the column name.
2519
+ * @returns {number} Returns the index by field
2520
+ */
2521
+ getColumnIndexByField(field: string): number;
2522
+ /**
2523
+ * Gets a column by UID.
2524
+ *
2525
+ * @param {string} uid - Specifies the column UID.
2526
+ * @returns {Column} Returns the column
2527
+ */
2528
+ getColumnByUid(uid: string): Column;
2529
+ /**
2530
+ * @param {Column[]} columns - Defines the columns
2531
+ * @param {Column[]} stackedColumn - Defines the stacked columns
2532
+ * @returns {Column[]} Returns the columns
2533
+ * @hidden
2534
+ */
2535
+ getStackedColumns(columns: Column[], stackedColumn?: Column[]): Column[];
2536
+ /**
2537
+ * Gets a column index by UID.
2538
+ *
2539
+ * @param {string} uid - Specifies the column UID.
2540
+ * @returns {number} Returns the column by index
2541
+ */
2542
+ getColumnIndexByUid(uid: string): number;
2543
+ /**
2544
+ * Gets UID by column name.
2545
+ *
2546
+ * @param {string} field - Specifies the column name.
2547
+ * @returns {string} Returns the column by field
2548
+ */
2549
+ getUidByColumnField(field: string): string;
2550
+ /**
2551
+ * Gets column index by column uid value.
2552
+ *
2553
+ * @private
2554
+ * @param {string} uid - Specifies the column uid.
2555
+ * @returns {number} Returns the column by field
2556
+ */
2557
+ getNormalizedColumnIndex(uid: string): number;
2558
+ /**
2559
+ * Gets indent cell count.
2560
+ *
2561
+ * @private
2562
+ * @returns {number} Returns the indent count
2563
+ */
2564
+ getIndentCount(): number;
2565
+ /**
2566
+ * Gets the collection of column fields.
2567
+ *
2568
+ * @returns {string[]} Returns the Field names
2569
+ */
2570
+ getColumnFieldNames(): string[];
2571
+ /**
2572
+ * Gets a compiled row template.
2573
+ *
2574
+ * @returns {Function} Returns the row TEmplate
2575
+ * @private
2576
+ */
2577
+ getRowTemplate(): Function;
2578
+ /**
2579
+ * Gets a compiled detail row template.
2580
+ *
2581
+ * @private
2582
+ * @returns {Function} Returns the Detail template
2583
+ */
2584
+ getDetailTemplate(): Function;
2585
+ /**
2586
+ * Gets a compiled detail row template.
2587
+ *
2588
+ * @private
2589
+ * @returns {Function}Returns the Edit template
2590
+ */
2591
+ getEditTemplate(): Function;
2592
+ /**
2593
+ * Gets a compiled dialog edit header template.
2594
+ *
2595
+ * @private
2596
+ * @returns {Function} returns template function
2597
+ */
2598
+ getEditHeaderTemplate(): Function;
2599
+ /**
2600
+ * Gets a compiled dialog edit footer template.
2601
+ *
2602
+ * @private
2603
+ * @returns {Function} Returns the Footer template
2604
+ */
2605
+ getEditFooterTemplate(): Function;
2606
+ /**
2607
+ * Get the names of the primary key columns of the Grid.
2608
+ *
2609
+ * @returns {string[]} Returns the field names
2610
+ */
2611
+ getPrimaryKeyFieldNames(): string[];
2612
+ /**
2613
+ * Refreshes the Grid header and content.
2614
+ *
2615
+ * @returns {void}
2616
+ */
2617
+ refresh(): void;
2618
+ /**
2619
+ * Refreshes the Grid header.
2620
+ *
2621
+ * @returns {void}
2622
+ */
2623
+ refreshHeader(): void;
2624
+ /**
2625
+ * Gets the collection of selected rows.
2626
+ *
2627
+ * @returns {Element[]} Returns the element
2628
+ */
2629
+ getSelectedRows(): Element[];
2630
+ /**
2631
+ * Gets the collection of selected row indexes.
2632
+ *
2633
+ * @returns {number[]} Returns the Selected row indexes
2634
+ */
2635
+ getSelectedRowIndexes(): number[];
2636
+ /**
2637
+ * Gets the collection of selected row and cell indexes.
2638
+ *
2639
+ * @returns {number[]} Returns the Selected row cell indexes
2640
+ */
2641
+ getSelectedRowCellIndexes(): ISelectedCell[];
2642
+ /**
2643
+ * Gets the collection of selected records.
2644
+ *
2645
+ * @returns {Object[]} Returns the selected records
2646
+ * @isGenericType true
2647
+ */
2648
+ getSelectedRecords(): Object[];
2649
+ /**
2650
+ * Gets the collection of selected columns uid.
2651
+ *
2652
+ * @returns {string[]} Returns the selected column uid
2653
+ * @isGenericType true
2654
+ */
2655
+ getSelectedColumnsUid(): string[];
2656
+ /**
2657
+ * Gets the data module.
2658
+ *
2659
+ * @returns {Data} Returns the data
2660
+ */
2661
+ getDataModule(): Data;
2662
+ /**
2663
+ * Shows a column by its column name.
2664
+ *
2665
+ * @param {string|string[]} keys - Defines a single or collection of column names.
2666
+ * @param {string} showBy - Defines the column key either as field name or header text.
2667
+ * @returns {void}
2668
+ */
2669
+ showColumns(keys: string | string[], showBy?: string): void;
2670
+ /**
2671
+ * Hides a column by column name.
2672
+ *
2673
+ * @param {string|string[]} keys - Defines a single or collection of column names.
2674
+ * @param {string} hideBy - Defines the column key either as field name or header text.
2675
+ * @returns {void}
2676
+ */
2677
+ hideColumns(keys: string | string[], hideBy?: string): void;
2678
+ /**
2679
+ * @hidden
2680
+ * @returns {number} Returns the Frozen column
2681
+ */
2682
+ getFrozenColumns(): number;
2683
+ /**
2684
+ * @hidden
2685
+ * @returns {number} Returns the Frozen Right column count
2686
+ */
2687
+ getFrozenRightColumnsCount(): number;
2688
+ /**
2689
+ * @hidden
2690
+ * @returns {number} Returns the Frozen Left column
2691
+ */
2692
+ getFrozenLeftColumnsCount(): number;
2693
+ /**
2694
+ * @hidden
2695
+ * @returns {number} Returns the movable column count
2696
+ */
2697
+ getMovableColumnsCount(): number;
2698
+ /**
2699
+ * @hidden
2700
+ * @returns {void}
2701
+ */
2702
+ setFrozenCount(): void;
2703
+ /**
2704
+ * @hidden
2705
+ * @returns {number} Returns the visible Frozen left count
2706
+ */
2707
+ getVisibleFrozenLeftCount(): number;
2708
+ /**
2709
+ * @hidden
2710
+ * @returns {number} Returns the visible Frozen Right count
2711
+ */
2712
+ getVisibleFrozenRightCount(): number;
2713
+ /**
2714
+ * @hidden
2715
+ * @returns {number} Returns the visible movable count
2716
+ */
2717
+ getVisibleMovableCount(): number;
2718
+ /**
2719
+ * @hidden
2720
+ * @returns {Column[]} Returns the column
2721
+ */
2722
+ getFrozenRightColumns(): Column[];
2723
+ /**
2724
+ * @hidden
2725
+ * @returns {Column[]} Returns the column
2726
+ */
2727
+ getFrozenLeftColumns(): Column[];
2728
+ /**
2729
+ * @hidden
2730
+ * @returns {Column[]} Returns the column
2731
+ */
2732
+ getMovableColumns(): Column[];
2733
+ private splitFrozenCount;
2734
+ /**
2735
+ * @hidden
2736
+ * @returns {number} Returns the visible frozen columns count
2737
+ */
2738
+ getVisibleFrozenColumns(): number;
2739
+ /**
2740
+ * Get the current Filter operator and field.
2741
+ *
2742
+ * @returns {FilterUI} Returns the filter UI
2743
+ */
2744
+ getFilterUIInfo(): FilterUI;
2745
+ private getVisibleFrozenColumnsCount;
2746
+ private getVisibleFrozenCount;
2747
+ private getFrozenCount;
2748
+ /**
2749
+ * Navigates to the specified target page.
2750
+ *
2751
+ * @param {number} pageNo - Defines the page number to navigate.
2752
+ * @returns {void}
2753
+ */
2754
+ goToPage(pageNo: number): void;
2755
+ /**
2756
+ * Defines the text of external message.
2757
+ *
2758
+ * @param {string} message - Defines the message to update.
2759
+ * @returns {void}
2760
+ */
2761
+ updateExternalMessage(message: string): void;
2762
+ /**
2763
+ * Sorts a column with the given options.
2764
+ *
2765
+ * @param {string} columnName - Defines the column name to be sorted.
2766
+ * @param {SortDirection} direction - Defines the direction of sorting field.
2767
+ * @param {boolean} isMultiSort - Specifies whether the previous sorted columns are to be maintained.
2768
+ * @returns {void}
2769
+ */
2770
+ sortColumn(columnName: string, direction: SortDirection, isMultiSort?: boolean): void;
2771
+ /**
2772
+ * Clears all the sorted columns of the Grid.
2773
+ *
2774
+ * @returns {void}
2775
+ */
2776
+ clearSorting(): void;
2777
+ /**
2778
+ * Remove sorted column by field name.
2779
+ *
2780
+ * @param {string} field - Defines the column field name to remove sort.
2781
+ * @returns {void}
2782
+ * @hidden
2783
+ */
2784
+ removeSortColumn(field: string): void;
2785
+ /**
2786
+ * @hidden
2787
+ * @returns {void}
2788
+ */
2789
+ clearGridActions(): void;
2790
+ /**
2791
+ * Filters grid row by column name with the given options.
2792
+ *
2793
+ * @param {string} fieldName - Defines the field name of the column.
2794
+ * @param {string} filterOperator - Defines the operator to filter records.
2795
+ * @param {string | number | Date | boolean} filterValue - Defines the value used to filter records.
2796
+ * @param {string} predicate - Defines the relationship between one filter query and another by using AND or OR predicate.
2797
+ * @param {boolean} matchCase - If match case is set to true, the grid filters the records with exact match. if false, it filters case
2798
+ * insensitive records (uppercase and lowercase letters treated the same).
2799
+ * @param {boolean} ignoreAccent - If ignoreAccent set to true,
2800
+ * then filter ignores the diacritic characters or accents while filtering.
2801
+ * @param {string} actualFilterValue - Defines the actual filter value for the filter column.
2802
+ * @param {string} actualOperator - Defines the actual filter operator for the filter column.
2803
+ * @returns {void}
2804
+ */
2805
+ filterByColumn(fieldName: string, filterOperator: string, filterValue: string | number | Date | boolean | number[] | string[] | Date[] | boolean[] | null, predicate?: string, matchCase?: boolean, ignoreAccent?: boolean, actualFilterValue?: string, actualOperator?: string): void;
2806
+ /**
2807
+ * Clears all the filtered rows of the Grid.
2808
+ *
2809
+ * @param {string[]} fields - Defines the Fields
2810
+ * @returns {void}
2811
+ */
2812
+ clearFiltering(fields?: string[]): void;
2813
+ /**
2814
+ * Removes filtered column by field name.
2815
+ *
2816
+ * @param {string} field - Defines column field name to remove filter.
2817
+ * @param {boolean} isClearFilterBar - Specifies whether the filter bar value needs to be cleared.
2818
+ * @returns {void}
2819
+ * @hidden
2820
+ */
2821
+ removeFilteredColsByField(field: string, isClearFilterBar?: boolean): void;
2822
+ /**
2823
+ * Selects a row by given index.
2824
+ *
2825
+ * @param {number} index - Defines the row index.
2826
+ * @param {boolean} isToggle - If set to true, then it toggles the selection.
2827
+ * @returns {void}
2828
+ */
2829
+ selectRow(index: number, isToggle?: boolean): void;
2830
+ /**
2831
+ * Selects a collection of rows by indexes.
2832
+ *
2833
+ * @param {number[]} rowIndexes - Specifies the row indexes.
2834
+ * @returns {void}
2835
+ */
2836
+ selectRows(rowIndexes: number[]): void;
2837
+ /**
2838
+ * Deselects the current selected rows and cells.
2839
+ *
2840
+ * @returns {void}
2841
+ */
2842
+ clearSelection(): void;
2843
+ /**
2844
+ * Selects a cell by the given index.
2845
+ *
2846
+ * @param {IIndex} cellIndex - Defines the row and column indexes.
2847
+ * @param {boolean} isToggle - If set to true, then it toggles the selection.
2848
+ * @returns {void}
2849
+ */
2850
+ selectCell(cellIndex: IIndex, isToggle?: boolean): void;
2851
+ /**
2852
+ * Selects a range of cells from start and end indexes.
2853
+ *
2854
+ * @param {IIndex} startIndex - Specifies the row and column's start index.
2855
+ * @param {IIndex} endIndex - Specifies the row and column's end index.
2856
+ * @returns {void}
2857
+ */
2858
+ selectCellsByRange(startIndex: IIndex, endIndex?: IIndex): void;
2859
+ /**
2860
+ * Searches Grid records using the given key.
2861
+ * You can customize the default search option by using the
2862
+ * [`searchSettings`](./#searchsettings/).
2863
+ *
2864
+ * @param {string} searchString - Defines the key.
2865
+ * @returns {void}
2866
+ */
2867
+ search(searchString: string): void;
2868
+ /**
2869
+ * By default, prints all the pages of the Grid and hides the pager.
2870
+ * > You can customize print options using the
2871
+ * [`printMode`](./#printmode).
2872
+ *
2873
+ * @returns {void}
2874
+ */
2875
+ print(): void;
2876
+ /**
2877
+ * Delete a record with Given options. If fieldname and data is not given then grid will delete the selected record.
2878
+ * > `editSettings.allowDeleting` should be true.
2879
+ *
2880
+ * @param {string} fieldname - Defines the primary key field, 'Name of the column'.
2881
+ * @param {Object} data - Defines the JSON data of the record to be deleted.
2882
+ * @returns {void}
2883
+ */
2884
+ deleteRecord(fieldname?: string, data?: Object): void;
2885
+ /**
2886
+ * Starts edit the selected row. At least one row must be selected before invoking this method.
2887
+ * `editSettings.allowEditing` should be true.
2888
+ * {% codeBlock src='grid/startEdit/index.md' %}{% endcodeBlock %}
2889
+ *
2890
+ * @returns {void}
2891
+ */
2892
+ startEdit(): void;
2893
+ /**
2894
+ * If Grid is in editable state, you can save a record by invoking endEdit.
2895
+ *
2896
+ * @returns {void}
2897
+ */
2898
+ endEdit(): void;
2899
+ /**
2900
+ * Cancels edited state.
2901
+ *
2902
+ * @returns {void}
2903
+ */
2904
+ closeEdit(): void;
2905
+ /**
2906
+ * Adds a new record to the Grid. Without passing parameters, it adds empty rows.
2907
+ * > `editSettings.allowEditing` should be true.
2908
+ *
2909
+ * @param {Object} data - Defines the new add record data.
2910
+ * @param {number} index - Defines the row index to be added
2911
+ * @returns {void}
2912
+ */
2913
+ addRecord(data?: Object, index?: number): void;
2914
+ /**
2915
+ * Delete any visible row by TR element.
2916
+ *
2917
+ * @param {HTMLTableRowElement} tr - Defines the table row element.
2918
+ * @returns {void}
2919
+ */
2920
+ deleteRow(tr: HTMLTableRowElement): void;
2921
+ /**
2922
+ * Changes a particular cell into edited state based on the row index and field name provided in the `batch` mode.
2923
+ *
2924
+ * @param {number} index - Defines row index to edit a particular cell.
2925
+ * @param {string} field - Defines the field name of the column to perform batch edit.
2926
+ * @returns {void}
2927
+ */
2928
+ editCell(index: number, field: string): void;
2929
+ /**
2930
+ * Saves the cell that is currently edited. It does not save the value to the DataSource.
2931
+ *
2932
+ * @returns {void}
2933
+ * {% codeBlock src='grid/saveCell/index.md' %}{% endcodeBlock %}
2934
+ */
2935
+ saveCell(): void;
2936
+ /**
2937
+ * To update the specified cell by given value without changing into edited state.
2938
+ *
2939
+ * @param {number} rowIndex Defines the row index.
2940
+ * @param {string} field Defines the column field.
2941
+ * @param {string | number | boolean | Date} value - Defines the value to be changed.
2942
+ * @returns {void}
2943
+ */
2944
+ updateCell(rowIndex: number, field: string, value: string | number | boolean | Date): void;
2945
+ /**
2946
+ * To update the specified row by given values without changing into edited state.
2947
+ *
2948
+ * {% codeBlock src='grid/updateRow/index.md' %}{% endcodeBlock %}
2949
+ *
2950
+ * @param {number} index Defines the row index.
2951
+ * @param {Object} data Defines the data object to be updated.
2952
+ * @returns {void}
2953
+ */
2954
+ updateRow(index: number, data: Object): void;
2955
+ /**
2956
+ * Gets the added, edited,and deleted data before bulk save to the DataSource in batch mode.
2957
+ *
2958
+ * @returns {Object} Returns the batch changes
2959
+ */
2960
+ getBatchChanges(): Object;
2961
+ /**
2962
+ * Enables or disables ToolBar items.
2963
+ *
2964
+ * @param {string[]} items - Defines the collection of itemID of ToolBar items.
2965
+ * @param {boolean} isEnable - Defines the items to be enabled or disabled.
2966
+ * @returns {void}
2967
+ */
2968
+ enableToolbarItems(items: string[], isEnable: boolean): void;
2969
+ /**
2970
+ * Copy the selected rows or cells data into clipboard.
2971
+ *
2972
+ * @param {boolean} withHeader - Specifies whether the column header text needs to be copied along with rows or cells.
2973
+ * @returns {void}
2974
+ */
2975
+ copy(withHeader?: boolean): void;
2976
+ /**
2977
+ * @hidden
2978
+ * @returns {void}
2979
+ */
2980
+ recalcIndentWidth(): void;
2981
+ /**
2982
+ * @hidden
2983
+ * @returns {void}
2984
+ */
2985
+ resetIndentWidth(): void;
2986
+ /**
2987
+ * @hidden
2988
+ * @returns {boolean} Returns isRowDragable
2989
+ */
2990
+ isRowDragable(): boolean;
2991
+ /**
2992
+ * Changes the Grid column positions by field names.
2993
+ *
2994
+ * @param {string} fromFName - Defines the origin field name.
2995
+ * @param {string} toFName - Defines the destination field name.
2996
+ * @returns {void}
2997
+ */
2998
+ reorderColumns(fromFName: string | string[], toFName: string): void;
2999
+ /**
3000
+ * Changes the Grid column positions by field index. If you invoke reorderColumnByIndex multiple times,
3001
+ * then you won't get the same results every time.
3002
+ *
3003
+ * @param {number} fromIndex - Defines the origin field index.
3004
+ * @param {number} toIndex - Defines the destination field index.
3005
+ * @returns {void}
3006
+ */
3007
+ reorderColumnByIndex(fromIndex: number, toIndex: number): void;
3008
+ /**
3009
+ * Changes the Grid column positions by field index. If you invoke reorderColumnByTargetIndex multiple times,
3010
+ * then you will get the same results every time.
3011
+ *
3012
+ * @param {string} fieldName - Defines the field name.
3013
+ * @param {number} toIndex - Defines the destination field index.
3014
+ * @returns {void}
3015
+ */
3016
+ reorderColumnByTargetIndex(fieldName: string | string[], toIndex: number): void;
3017
+ /**
3018
+ * Changes the Grid Row position with given indexes.
3019
+ *
3020
+ * @param {number} fromIndexes - Defines the origin Indexes.
3021
+ * @param {number} toIndex - Defines the destination Index.
3022
+ * @returns {void}
3023
+ */
3024
+ reorderRows(fromIndexes: number[], toIndex: number): void;
3025
+ /**
3026
+ * @param {ReturnType} e - Defines the Return type
3027
+ * @returns {void}
3028
+ * @hidden
3029
+ */
3030
+ refreshDataSource(e: ReturnType): void;
3031
+ /**
3032
+ * @param {boolean} enable -Defines the enable
3033
+ * @returns {void}
3034
+ * @hidden
3035
+ */
3036
+ disableRowDD(enable: boolean): void;
3037
+ /**
3038
+ * Changes the column width to automatically fit its content to ensure that the width shows the content without wrapping/hiding.
3039
+ * > * This method ignores the hidden columns.
3040
+ * > * Uses the `autoFitColumns` method in the `dataBound` event to resize at initial rendering.
3041
+ *
3042
+ * @param {string |string[]} fieldNames - Defines the column names.
3043
+ * @returns {void}
3044
+ *
3045
+ *
3046
+ * ```typescript
3047
+ * <div id="Grid"></div>
3048
+ * <script>
3049
+ * let gridObj: Grid = new Grid({
3050
+ * dataSource: employeeData,
3051
+ * columns: [
3052
+ * { field: 'OrderID', headerText: 'Order ID', width:100 },
3053
+ * { field: 'EmployeeID', headerText: 'Employee ID' }],
3054
+ * dataBound: () => gridObj.autoFitColumns('EmployeeID')
3055
+ * });
3056
+ * gridObj.appendTo('#Grid');
3057
+ * </script>
3058
+ * ```
3059
+ *
3060
+ */
3061
+ autoFitColumns(fieldNames?: string | string[]): void;
3062
+ /**
3063
+ * @param {number} x - Defines the number
3064
+ * @param {number} y - Defines the number
3065
+ * @param {Element} target - Defines the Element
3066
+ * @returns {void}
3067
+ * @hidden
3068
+ */
3069
+ createColumnchooser(x: number, y: number, target: Element): void;
3070
+ private initializeServices;
3071
+ private processModel;
3072
+ private initForeignColumn;
3073
+ private enableVerticalRendering;
3074
+ private gridRender;
3075
+ dataReady(): void;
3076
+ private updateRTL;
3077
+ private createGridPopUpElement;
3078
+ private updateGridLines;
3079
+ private updateResizeLines;
3080
+ /**
3081
+ * The function is used to apply text wrap
3082
+ *
3083
+ * @returns {void}
3084
+ * @hidden
3085
+ */
3086
+ applyTextWrap(): void;
3087
+ /**
3088
+ * The function is used to remove text wrap
3089
+ *
3090
+ * @returns {void}
3091
+ * @hidden
3092
+ */
3093
+ removeTextWrap(): void;
3094
+ /**
3095
+ * The function is used to add Tooltip to the grid cell that has ellipsiswithtooltip clip mode.
3096
+ *
3097
+ * @returns {void}
3098
+ * @hidden
3099
+ */
3100
+ createTooltip(): void;
3101
+ /** @hidden
3102
+ * @returns {void}
3103
+ */
3104
+ freezeRefresh(): void;
3105
+ private getTooltipStatus;
3106
+ private mouseMoveHandler;
3107
+ /**
3108
+ * @param {MouseEvent} e - Defines the mouse event
3109
+ * @returns {void}
3110
+ * @hidden
3111
+ */
3112
+ hoverFrozenRows(e: MouseEvent): void;
3113
+ private isEllipsisTooltip;
3114
+ private scrollHandler;
3115
+ /**
3116
+ * To create table for ellipsiswithtooltip
3117
+ *
3118
+ * @param {Element} table - Defines the table
3119
+ * @param {string} tag - Defines the tag
3120
+ * @param {string} type - Defines the type
3121
+ * @returns {HTMLDivElement} Returns the HTML div ELement
3122
+ * @hidden
3123
+ */
3124
+ protected createTable(table: Element, tag: string, type: string): HTMLDivElement;
3125
+ private onKeyPressed;
3126
+ /**
3127
+ * Binding events to the element while component creation.
3128
+ *
3129
+ * @hidden
3130
+ * @returns {void}
3131
+ */
3132
+ wireEvents(): void;
3133
+ /**
3134
+ * Unbinding events from the element while component destroy.
3135
+ *
3136
+ * @hidden
3137
+ * @returns {void}
3138
+ */
3139
+ unwireEvents(): void;
3140
+ /**
3141
+ * @hidden
3142
+ * @returns {void}
3143
+ */
3144
+ addListener(): void;
3145
+ /**
3146
+ * @hidden
3147
+ * @returns {void}
3148
+ */
3149
+ removeListener(): void;
3150
+ /**
3151
+ * Get current visible data of grid.
3152
+ *
3153
+ * @returns {Object[]} Returns the current view records
3154
+ * @isGenericType true
3155
+ */
3156
+ getCurrentViewRecords(): Object[];
3157
+ private mouseClickHandler;
3158
+ private checkEdit;
3159
+ private dblClickHandler;
3160
+ private focusOutHandler;
3161
+ private isChildGrid;
3162
+ /**
3163
+ * @param {Object} persistedData - Defines the persisted data
3164
+ * @returns {void}
3165
+ * @hidden
3166
+ */
3167
+ mergePersistGridData(persistedData?: Object): void;
3168
+ private mergeColumns;
3169
+ /**
3170
+ * @hidden
3171
+ * @returns {boolean} Returns the isDetail
3172
+ */
3173
+ isDetail(): boolean;
3174
+ private isCommandColumn;
3175
+ private isForeignKeyEnabled;
3176
+ private keyPressHandler;
3177
+ private keyDownHandler;
3178
+ private keyActionHandler;
3179
+ /**
3180
+ * @param {Function[]} modules - Defines the modules
3181
+ * @returns {void}
3182
+ * @hidden
3183
+ */
3184
+ setInjectedModules(modules: Function[]): void;
3185
+ private updateColumnObject;
3186
+ /**
3187
+ * Gets the foreign columns from Grid.
3188
+ *
3189
+ * @returns {Column[]} Returns Foreign key column
3190
+ */
3191
+ getForeignKeyColumns(): Column[];
3192
+ /**
3193
+ * @hidden
3194
+ * @returns {number} Returns row height
3195
+ */
3196
+ getRowHeight(): number;
3197
+ /**
3198
+ * Refreshes the Grid column changes.
3199
+ *
3200
+ * @returns {void}
3201
+ */
3202
+ refreshColumns(): void;
3203
+ /**
3204
+ * Export Grid data to Excel file(.xlsx).
3205
+ *
3206
+ * @param {ExcelExportProperties} excelExportProperties - Defines the export properties of the Grid.
3207
+ * @param {boolean} isMultipleExport - Define to enable multiple export.
3208
+ * @param {Workbook} workbook - Defines the Workbook if multiple export is enabled.
3209
+ * @param {boolean} isBlob - If 'isBlob' set to true, then it will be returned as blob data.
3210
+ * @returns {Promise<any>} Returns the excelexport
3211
+ */
3212
+ excelExport(excelExportProperties?: ExcelExportProperties, isMultipleExport?: boolean, workbook?: Workbook, isBlob?: boolean): Promise<any>;
3213
+ /**
3214
+ * Export Grid data to CSV file.
3215
+ *
3216
+ * @param {ExcelExportProperties} excelExportProperties - Defines the export properties of the Grid.
3217
+ * @param {boolean} isMultipleExport - Define to enable multiple export.
3218
+ * @param {Workbook} workbook - Defines the Workbook if multiple export is enabled.
3219
+ * @param {boolean} isBlob - If 'isBlob' set to true, then it will be returned as blob data.
3220
+ * @returns {Promise<any>} Returns csv export
3221
+ */
3222
+ csvExport(excelExportProperties?: ExcelExportProperties, isMultipleExport?: boolean, workbook?: Workbook, isBlob?: boolean): Promise<any>;
3223
+ /**
3224
+ * Export Grid data to PDF document.
3225
+ *
3226
+ * @param {pdfExportProperties} pdfExportProperties - Defines the export properties of the Grid.
3227
+ * @param {isMultipleExport} isMultipleExport - Define to enable multiple export.
3228
+ * @param {pdfDoc} pdfDoc - Defined the Pdf Document if multiple export is enabled.
3229
+ * @param {boolean} isBlob - If 'isBlob' set to true, then it will be returned as blob data.
3230
+ * @returns {Promise<any>} Returns pdfexport
3231
+ */
3232
+ pdfExport(pdfExportProperties?: PdfExportProperties, isMultipleExport?: boolean, pdfDoc?: Object, isBlob?: boolean): Promise<Object>;
3233
+ /**
3234
+ * Groups a column by column name.
3235
+ *
3236
+ * @param {string} columnName - Defines the column name to group.
3237
+ * @returns {void}
3238
+ */
3239
+ groupColumn(columnName: string): void;
3240
+ /**
3241
+ * Expands all the grouped rows of the Grid.
3242
+ *
3243
+ * @returns {void}
3244
+ */
3245
+ groupExpandAll(): void;
3246
+ /**
3247
+ * Collapses all the grouped rows of the Grid.
3248
+ *
3249
+ * @returns {void}
3250
+ */
3251
+ groupCollapseAll(): void;
3252
+ /**
3253
+ * Expands or collapses grouped rows by target element.
3254
+ *
3255
+ * @param {Element} target - Defines the target element of the grouped row.
3256
+ * @returns {void}
3257
+ */
3258
+ /**
3259
+ * Clears all the grouped columns of the Grid.
3260
+ *
3261
+ * @returns {void}
3262
+ */
3263
+ clearGrouping(): void;
3264
+ /**
3265
+ * Ungroups a column by column name.
3266
+ *
3267
+ * {% codeBlock src='grid/ungroupColumn/index.md' %}{% endcodeBlock %}
3268
+ *
3269
+ * @param {string} columnName - Defines the column name to ungroup.
3270
+ * @returns {void}
3271
+ */
3272
+ ungroupColumn(columnName: string): void;
3273
+ /**
3274
+ * Column chooser can be displayed on screen by given position(X and Y axis).
3275
+ *
3276
+ * @param {number} x - Defines the X axis.
3277
+ * @param {number} y - Defines the Y axis.
3278
+ * @returns {void}
3279
+ */
3280
+ openColumnChooser(x?: number, y?: number): void;
3281
+ private scrollRefresh;
3282
+ /**
3283
+ * Collapses a detail row with the given target.
3284
+ *
3285
+ * @param {Element} target - Defines the expanded element to collapse.
3286
+ * @returns {void}
3287
+ */
3288
+ /**
3289
+ * Collapses all the detail rows of the Grid.
3290
+ *
3291
+ * @returns {void}
3292
+ */
3293
+ detailCollapseAll(): void;
3294
+ /**
3295
+ * Expands a detail row with the given target.
3296
+ *
3297
+ * @param {Element} target - Defines the collapsed element to expand.
3298
+ * @returns {void}
3299
+ */
3300
+ /**
3301
+ * Expands all the detail rows of the Grid.
3302
+ *
3303
+ * @returns {void}
3304
+ */
3305
+ detailExpandAll(): void;
3306
+ /**
3307
+ * Deselects the currently selected cells.
3308
+ *
3309
+ * @returns {void}
3310
+ */
3311
+ clearCellSelection(): void;
3312
+ /**
3313
+ * Deselects the currently selected rows.
3314
+ *
3315
+ * @returns {void}
3316
+ */
3317
+ clearRowSelection(): void;
3318
+ /**
3319
+ * Selects a collection of cells by row and column indexes.
3320
+ *
3321
+ * @param {ISelectedCell[]} rowCellIndexes - Specifies the row and column indexes.
3322
+ * @returns {void}
3323
+ */
3324
+ selectCells(rowCellIndexes: ISelectedCell[]): void;
3325
+ /**
3326
+ * Selects a range of rows from start and end row indexes.
3327
+ *
3328
+ * @param {number} startIndex - Specifies the start row index.
3329
+ * @param {number} endIndex - Specifies the end row index.
3330
+ * @returns {void}
3331
+ */
3332
+ selectRowsByRange(startIndex: number, endIndex?: number): void;
3333
+ /**
3334
+ * @hidden
3335
+ * @returns {boolean} Returns whether context menu is open or not
3336
+ */
3337
+ isContextMenuOpen(): boolean;
3338
+ /**
3339
+ * @param {Function} module - Defines the module
3340
+ * @returns {boolean} return the injected modules
3341
+ * @hidden
3342
+ */
3343
+ ensureModuleInjected(module: Function): boolean;
3344
+ /**
3345
+ * Destroys the given template reference.
3346
+ *
3347
+ * @param {string[]} propertyNames - Defines the collection of template name.
3348
+ * @param {any} index - specifies the index
3349
+ */
3350
+ destroyTemplate(propertyNames?: string[], index?: any): void;
3351
+ /**
3352
+ * @param {string | string[]} type - Defines the type
3353
+ * @param {Object} args - Defines the arguments
3354
+ * @returns {void}
3355
+ * @hidden
3356
+ * @private
3357
+ */
3358
+ log(type: string | string[], args?: Object): void;
3359
+ /**
3360
+ * @param {Element} element - Defines the element
3361
+ * @returns {void}
3362
+ * @hidden
3363
+ */
3364
+ applyBiggerTheme(element: Element): void;
3365
+ /**
3366
+ * @hidden
3367
+ * @returns {Object} Returns the previous row data
3368
+ */
3369
+ getPreviousRowData(): Object;
3370
+ /**
3371
+ * Hides the scrollbar placeholder of Grid content when grid content is not overflown.
3372
+ *
3373
+ * @returns {void}
3374
+ */
3375
+ hideScroll(): void;
3376
+ /**
3377
+ * Get row index by primary key or row data.
3378
+ *
3379
+ * @param {string | Object} value - Defines the primary key value.
3380
+ * @returns {number} Returns the index
3381
+ */
3382
+ getRowIndexByPrimaryKey(value: string | Object): number;
3383
+ /**
3384
+ * @param {string} field - Defines the field name
3385
+ * @returns {Column} returns the column
3386
+ * @hidden
3387
+ */
3388
+ grabColumnByFieldFromAllCols(field: string): Column;
3389
+ /**
3390
+ * @param {string} uid - Defines the uid
3391
+ * @returns {Column} returns the column
3392
+ * @hidden
3393
+ */
3394
+ grabColumnByUidFromAllCols(uid: string): Column;
3395
+ /**
3396
+ * Get all filtered records from the Grid and it returns array of objects for the local dataSource, returns a promise object if the Grid has remote data.
3397
+ *
3398
+ * @returns {Object[] | Promise<Object>} Returns the filtered records
3399
+ */
3400
+ getFilteredRecords(): Object[] | Promise<Object>;
3401
+ private getUserAgent;
3402
+ /**
3403
+ * @param {TouchEventArgs} e - Defines the TouchEventArgs
3404
+ * @returns {void}
3405
+ * @hidden
3406
+ */
3407
+ tapEvent(e: TouchEventArgs): void;
3408
+ /**
3409
+ * @param {string} prefix - specifies the prefix
3410
+ * @returns {string} returns the row uid
3411
+ * @hidden
3412
+ */
3413
+ getRowUid(prefix: string): string;
3414
+ /**
3415
+ * @hidden
3416
+ * @returns {Element} returns the element
3417
+ */
3418
+ getMovableVirtualContent(): Element;
3419
+ /**
3420
+ * @hidden
3421
+ * @returns {Element} returns the element
3422
+ */
3423
+ getFrozenVirtualContent(): Element;
3424
+ /**
3425
+ * @hidden
3426
+ * @returns {Element} returns the element
3427
+ */
3428
+ getMovableVirtualHeader(): Element;
3429
+ /**
3430
+ * @hidden
3431
+ * @returns {Element} returns the element
3432
+ */
3433
+ getFrozenVirtualHeader(): Element;
3434
+ /**
3435
+ * @param {string} uid - specifies the uid
3436
+ * @returns {Element} returns the element
3437
+ * @hidden
3438
+ */
3439
+ getRowElementByUID(uid: string): Element;
3440
+ /**
3441
+ * Gets the hidden columns from the Grid.
3442
+ *
3443
+ * @returns {Column[]} Returns the Column
3444
+ */
3445
+ getHiddenColumns(): Column[];
3446
+ /**
3447
+ * calculatePageSizeByParentHeight
3448
+ *
3449
+ * @param {number | string } containerHeight - specifies the container height
3450
+ * @returns {number} returns the page size
3451
+ */
3452
+ calculatePageSizeByParentHeight(containerHeight: number | string): number;
3453
+ private getNoncontentHeight;
3454
+ /**
3455
+ *To perform aggregate operation on a column.
3456
+ *
3457
+ * @param {AggregateColumnModel} summaryCol - Pass Aggregate Column details.
3458
+ * @param {Object} summaryData - Pass JSON Array for which its field values to be calculated.
3459
+ * @returns {number} returns the summary values
3460
+ */
3461
+ getSummaryValues(summaryCol: AggregateColumnModel, summaryData: Object): number;
3462
+ /**
3463
+ * Sends a Post request to export Grid to Excel file in server side.
3464
+ *
3465
+ * @param {string} url - Pass Url for server side excel export action.
3466
+ * @returns {void}
3467
+ */
3468
+ serverExcelExport(url: string): void;
3469
+ /**
3470
+ * Sends a Post request to export Grid to Pdf file in server side.
3471
+ *
3472
+ * @param {string} url - Pass Url for server side pdf export action.
3473
+ * @returns {void}
3474
+ */
3475
+ serverPdfExport(url: string): void;
3476
+ /**
3477
+ * Sends a Post request to export Grid to CSV file in server side.
3478
+ *
3479
+ * @param {string} url - Pass Url for server side pdf export action.
3480
+ * @returns {void}
3481
+ */
3482
+ serverCsvExport(url: string): void;
3483
+ /**
3484
+ * @param {string} url - Defines exporting url
3485
+ * @returns {void}
3486
+ * @hidden
3487
+ */
3488
+ exportGrid(url: string): void;
3489
+ /**
3490
+ * @param {Column[]} columns - Defines array of columns
3491
+ * @param {string[]} include - Defines array of sting
3492
+ * @returns {Column[]} returns array of columns
3493
+ * @hidden
3494
+ */
3495
+ setHeaderText(columns: Column[], include: string[]): Column[];
3496
+ private getFormat;
3497
+ /**
3498
+ * @hidden
3499
+ * @returns {boolean} returns the isCollapseStateEnabled
3500
+ */
3501
+ isCollapseStateEnabled(): boolean;
3502
+ /**
3503
+ * @param {number} key - Defines the primary key value.
3504
+ * @param {Object} rowData - Defines the rowData
3505
+ * @returns {void}
3506
+ */
3507
+ updateRowValue(key: number, rowData: Object): void;
3508
+ /**
3509
+ * @hidden
3510
+ * @returns {void}
3511
+ */
3512
+ setForeignKeyData(): void;
3513
+ /**
3514
+ * @param {string} field - specifies the field
3515
+ * @returns {void}
3516
+ * @hidden
3517
+ */
3518
+ resetFilterDlgPosition(field: string): void;
3519
+ /**
3520
+ * @hidden
3521
+ * @returns {void}
3522
+ */
3523
+ renderTemplates(): void;
3524
+ /**
3525
+ * Apply the changes to the Grid without refreshing the rows.
3526
+ *
3527
+ * @param {BatchChanges} changes - Defines changes to be updated.
3528
+ * @returns {void}
3529
+ */
3530
+ batchUpdate(changes: BatchChanges): void;
3531
+ /**
3532
+ * Apply the changes to the Grid in one batch after 50ms without refreshing the rows.
3533
+ *
3534
+ * @param {BatchChanges} changes - Defines changes to be updated.
3535
+ * @returns {void}
3536
+ */
3537
+ batchAsyncUpdate(changes: BatchChanges): void;
3538
+ private processBulkRowChanges;
3539
+ private processRowChanges;
3540
+ private setNewData;
3541
+ private deleteRowElement;
3542
+ private bulkRefresh;
3543
+ private renderRowElement;
3544
+ private addRowObject;
3545
+ /**
3546
+ * @hidden
3547
+ * @returns {void}
3548
+ */
3549
+ updateVisibleExpandCollapseRows(): void;
3550
+ /**
3551
+ * @param {string | number} height - specifies the height
3552
+ * @returns {number | string} - specifies the height number
3553
+ * @hidden
3554
+ */
3555
+ getHeight(height: string | number): number | string;
3556
+ /**
3557
+ * @hidden
3558
+ * @returns {Element} - returns frozen right content
3559
+ */
3560
+ getFrozenRightContent(): Element;
3561
+ /**
3562
+ * @hidden
3563
+ * @returns {Element} - returns frozen right header
3564
+ */
3565
+ getFrozenRightHeader(): Element;
3566
+ /**
3567
+ * @hidden
3568
+ * @returns {Element} - returns movable header tbody
3569
+ */
3570
+ getMovableHeaderTbody(): Element;
3571
+ /**
3572
+ * @hidden
3573
+ * @returns {Element} - returns movable content tbody
3574
+ */
3575
+ getMovableContentTbody(): Element;
3576
+ /**
3577
+ * @hidden
3578
+ * @returns {Element} - returns frozen header tbody
3579
+ */
3580
+ getFrozenHeaderTbody(): Element;
3581
+ /**
3582
+ * @hidden
3583
+ * @returns {Element} - returns frozen left content tbody
3584
+ */
3585
+ getFrozenLeftContentTbody(): Element;
3586
+ /**
3587
+ * @hidden
3588
+ * @returns {Element} - returns frozen right header tbody
3589
+ */
3590
+ getFrozenRightHeaderTbody(): Element;
3591
+ /**
3592
+ * @returns {Element} returns frozen right content tbody
3593
+ * @hidden
3594
+ */
3595
+ getFrozenRightContentTbody(): Element;
3596
+ /**
3597
+ * @param {boolean} isCustom - Defines custom filter dialog open
3598
+ * @returns {void}
3599
+ * @hidden
3600
+ */
3601
+ showResponsiveCustomFilter(isCustom?: boolean): void;
3602
+ /**
3603
+ * @param {boolean} isCustom - Defines custom sort dialog open
3604
+ * @returns {void}
3605
+ * @hidden
3606
+ */
3607
+ showResponsiveCustomSort(isCustom?: boolean): void;
3608
+ /**
3609
+ * To manually show the vertical row mode filter dialog
3610
+ *
3611
+ * @returns {void}
3612
+ */
3613
+ showAdaptiveFilterDialog(): void;
3614
+ /**
3615
+ * To manually show the vertical row sort filter dialog
3616
+ *
3617
+ * @returns {void}
3618
+ */
3619
+ showAdaptiveSortDialog(): void;
3620
+ /**
3621
+ * @param {boolean} isColVirtualization - Defines column virtualization
3622
+ * @returns {Column[]} returns array of column models
3623
+ * @hidden
3624
+ */
3625
+ getCurrentVisibleColumns(isColVirtualization?: boolean): Column[];
3626
+ private enableInfiniteAggrgate;
3627
+ }