@syncfusion/ej2-treegrid 26.1.35-469198 → 26.1.35-760834

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 (111) hide show
  1. package/dist/ej2-treegrid.min.js +1 -1
  2. package/dist/ej2-treegrid.umd.min.js +1 -1
  3. package/dist/ej2-treegrid.umd.min.js.map +1 -1
  4. package/dist/es6/ej2-treegrid.es2015.js +156 -35
  5. package/dist/es6/ej2-treegrid.es2015.js.map +1 -1
  6. package/dist/es6/ej2-treegrid.es5.js +158 -35
  7. package/dist/es6/ej2-treegrid.es5.js.map +1 -1
  8. package/dist/global/ej2-treegrid.min.js +1 -1
  9. package/dist/global/ej2-treegrid.min.js.map +1 -1
  10. package/dist/ts/undefined +73 -602
  11. package/index.d.ts +4 -0
  12. package/index.js +4 -0
  13. package/package.json +1 -1
  14. package/src/index.d.ts +4 -0
  15. package/src/treegrid/actions/batch-edit.d.ts +73 -0
  16. package/src/treegrid/actions/clipboard.d.ts +36 -0
  17. package/src/treegrid/actions/column-chooser.d.ts +37 -0
  18. package/src/treegrid/actions/column-menu.d.ts +24 -0
  19. package/src/treegrid/actions/command-column.d.ts +24 -0
  20. package/src/treegrid/actions/context-menu.d.ts +42 -0
  21. package/src/treegrid/actions/crud-actions.d.ts +66 -0
  22. package/src/treegrid/actions/crud-actions.js +1 -1
  23. package/src/treegrid/actions/detail-row.d.ts +39 -0
  24. package/src/treegrid/actions/edit.d.ts +112 -0
  25. package/src/treegrid/actions/edit.js +3 -2
  26. package/src/treegrid/actions/excel-export.d.ts +59 -0
  27. package/src/treegrid/actions/excel-export.js +14 -3
  28. package/src/treegrid/actions/filter.d.ts +57 -0
  29. package/src/treegrid/actions/freeze-column.d.ts +28 -0
  30. package/src/treegrid/actions/index.d.ts +24 -0
  31. package/src/treegrid/actions/infinite-scroll.d.ts +96 -0
  32. package/src/treegrid/actions/logger.d.ts +25 -0
  33. package/src/treegrid/actions/page.d.ts +67 -0
  34. package/src/treegrid/actions/pdf-export.d.ts +55 -0
  35. package/src/treegrid/actions/print.d.ts +37 -0
  36. package/src/treegrid/actions/reorder.d.ts +36 -0
  37. package/src/treegrid/actions/resize.d.ts +36 -0
  38. package/src/treegrid/actions/rowdragdrop.d.ts +113 -0
  39. package/src/treegrid/actions/rowdragdrop.js +2 -2
  40. package/src/treegrid/actions/selection.d.ts +51 -0
  41. package/src/treegrid/actions/selection.js +9 -0
  42. package/src/treegrid/actions/sort.d.ts +63 -0
  43. package/src/treegrid/actions/summary.d.ts +47 -0
  44. package/src/treegrid/actions/toolbar.d.ts +52 -0
  45. package/src/treegrid/actions/virtual-scroll.d.ts +55 -0
  46. package/src/treegrid/actions/virtual-scroll.js +13 -1
  47. package/src/treegrid/base/constant.d.ts +162 -0
  48. package/src/treegrid/base/data.d.ts +90 -0
  49. package/src/treegrid/base/data.js +20 -3
  50. package/src/treegrid/base/index.d.ts +11 -0
  51. package/src/treegrid/base/interface.d.ts +182 -0
  52. package/src/treegrid/base/treegrid.d.ts +2190 -0
  53. package/src/treegrid/base/treegrid.js +86 -17
  54. package/src/treegrid/enum.d.ts +155 -0
  55. package/src/treegrid/index.d.ts +9 -0
  56. package/src/treegrid/models/column.d.ts +752 -0
  57. package/src/treegrid/models/edit-settings.d.ts +90 -0
  58. package/src/treegrid/models/filter-settings.d.ts +203 -0
  59. package/src/treegrid/models/index.d.ts +24 -0
  60. package/src/treegrid/models/infinite-scroll-settings.d.ts +25 -0
  61. package/src/treegrid/models/loading-indicator.d.ts +19 -0
  62. package/src/treegrid/models/page-settings.d.ts +60 -0
  63. package/src/treegrid/models/rowdrop-settings.d.ts +27 -0
  64. package/src/treegrid/models/search-settings.d.ts +71 -0
  65. package/src/treegrid/models/selection-settings.d.ts +79 -0
  66. package/src/treegrid/models/sort-settings.d.ts +40 -0
  67. package/src/treegrid/models/summary.d.ts +124 -0
  68. package/src/treegrid/models/textwrap-settings.d.ts +16 -0
  69. package/src/treegrid/renderer/index.d.ts +5 -0
  70. package/src/treegrid/renderer/render.d.ts +41 -0
  71. package/src/treegrid/renderer/virtual-row-model-generator.d.ts +16 -0
  72. package/src/treegrid/renderer/virtual-tree-content-render.d.ts +75 -0
  73. package/src/treegrid/renderer/virtual-tree-content-render.js +11 -6
  74. package/src/treegrid/utils.d.ts +70 -0
  75. package/styles/bootstrap5.3-lite.css +2 -1090
  76. package/styles/bootstrap5.3.css +3 -1091
  77. package/styles/fluent2-lite.css +8 -1129
  78. package/styles/fluent2.css +8 -1129
  79. package/styles/material3-dark-lite.css +10 -1098
  80. package/styles/material3-dark.css +10 -1098
  81. package/styles/material3-lite.css +10 -1098
  82. package/styles/material3.css +10 -1098
  83. package/styles/tailwind3-lite.css +77 -1213
  84. package/styles/tailwind3.css +84 -1220
  85. package/styles/treegrid/_bds-definition.scss +0 -25
  86. package/styles/treegrid/_bigger.scss +6 -6
  87. package/styles/treegrid/_bootstrap-dark-definition.scss +0 -25
  88. package/styles/treegrid/_bootstrap-definition.scss +0 -25
  89. package/styles/treegrid/_bootstrap4-definition.scss +0 -25
  90. package/styles/treegrid/_bootstrap5-definition.scss +0 -25
  91. package/styles/treegrid/_bootstrap5.3-definition.scss +0 -25
  92. package/styles/treegrid/_fabric-dark-definition.scss +0 -25
  93. package/styles/treegrid/_fabric-definition.scss +0 -25
  94. package/styles/treegrid/_fluent-definition.scss +0 -25
  95. package/styles/treegrid/_fluent2-definition.scss +0 -25
  96. package/styles/treegrid/_fusionnew-definition.scss +0 -25
  97. package/styles/treegrid/_highcontrast-definition.scss +0 -25
  98. package/styles/treegrid/_highcontrast-light-definition.scss +0 -25
  99. package/styles/treegrid/_layout.scss +29 -29
  100. package/styles/treegrid/_material-dark-definition.scss +0 -25
  101. package/styles/treegrid/_material-definition.scss +0 -25
  102. package/styles/treegrid/_material3-definition.scss +0 -25
  103. package/styles/treegrid/_tailwind-definition.scss +0 -25
  104. package/styles/treegrid/_tailwind3-definition.scss +17 -42
  105. package/styles/treegrid/bootstrap5.3.css +3 -1091
  106. package/styles/treegrid/fluent2.css +8 -1129
  107. package/styles/treegrid/material3-dark.css +10 -1098
  108. package/styles/treegrid/material3.css +10 -1098
  109. package/styles/treegrid/tailwind3.css +84 -1220
  110. package/treegrid.d.ts +4 -0
  111. package/treegrid.js +4 -0
@@ -0,0 +1,2190 @@
1
+ import { Component, ModuleDeclaration } from '@syncfusion/ej2-base';
2
+ import { EmitType } from '@syncfusion/ej2-base';
3
+ import { INotifyPropertyChanged, KeyboardEvents } from '@syncfusion/ej2-base';
4
+ import { Column, ColumnModel } from '../models/column';
5
+ import { BeforeBatchSaveArgs, BeforeBatchAddArgs, BatchDeleteArgs, BeforeBatchDeleteArgs } from '@syncfusion/ej2-grids';
6
+ import { ColumnQueryModeType, HeaderCellInfoEventArgs } from '@syncfusion/ej2-grids';
7
+ import { RowDragEventArgs, RowDropSettingsModel } from '@syncfusion/ej2-grids';
8
+ import { LoadingIndicatorModel } from '../models/loading-indicator-model';
9
+ import { DetailDataBoundEventArgs, ClipMode, ColumnChooser } from '@syncfusion/ej2-grids';
10
+ import { SearchEventArgs, AddEventArgs, EditEventArgs, DeleteEventArgs } from '@syncfusion/ej2-grids';
11
+ import { SaveEventArgs, CellSaveArgs, BatchAddArgs, BatchCancelArgs, BeginEditArgs, CellEditArgs } from '@syncfusion/ej2-grids';
12
+ import { TextWrapSettingsModel } from '../models/textwrap-settings-model';
13
+ import { Filter } from '../actions/filter';
14
+ import { BeforeCopyEventArgs, BeforePasteEventArgs } from '@syncfusion/ej2-grids';
15
+ import { TreeClipboard } from '../actions/clipboard';
16
+ import { Aggregate } from '../actions/summary';
17
+ import { Reorder } from '../actions/reorder';
18
+ import { Resize } from '../actions/resize';
19
+ import { Selection as TreeGridSelection } from '../actions/selection';
20
+ import { ColumnMenu } from '../actions/column-menu';
21
+ import { DetailRow } from '../actions/detail-row';
22
+ import { Freeze } from '../actions/freeze-column';
23
+ import { Print } from '../actions/print';
24
+ import { TreeGridModel } from './treegrid-model';
25
+ import { FilterSettingsModel } from '../models/filter-settings-model';
26
+ import { SearchSettingsModel } from '../models/search-settings-model';
27
+ import { RowInfo, RowDataBoundEventArgs, PageEventArgs, FilterEventArgs, FailureEventArgs, SortEventArgs } from '@syncfusion/ej2-grids';
28
+ import { RowSelectingEventArgs, RowSelectEventArgs, RowDeselectEventArgs, IIndex, ISelectedCell } from '@syncfusion/ej2-grids';
29
+ import { CellSelectEventArgs, CellDeselectEventArgs } from '@syncfusion/ej2-grids';
30
+ import { SelectionSettingsModel } from '../models/selection-settings-model';
31
+ import { SortDirection, ColumnDragEventArgs } from '@syncfusion/ej2-grids';
32
+ import { PrintMode, Data, ContextMenuItemModel } from '@syncfusion/ej2-grids';
33
+ import { ColumnMenuItem, ColumnMenuItemModel, CheckBoxChangeEventArgs } from '@syncfusion/ej2-grids';
34
+ import { ExcelExportCompleteArgs, ExcelHeaderQueryCellInfoEventArgs, ExcelQueryCellInfoEventArgs } from '@syncfusion/ej2-grids';
35
+ import { PdfExportCompleteArgs, PdfHeaderQueryCellInfoEventArgs, PdfQueryCellInfoEventArgs } from '@syncfusion/ej2-grids';
36
+ import { ExcelExportProperties, PdfExportProperties, CellSelectingEventArgs, PrintEventArgs } from '@syncfusion/ej2-grids';
37
+ import { ColumnMenuOpenEventArgs } from '@syncfusion/ej2-grids';
38
+ import { BeforeDataBoundArgs } from '@syncfusion/ej2-grids';
39
+ import { DataManager, Query } from '@syncfusion/ej2-data';
40
+ import { Grid, QueryCellInfoEventArgs } from '@syncfusion/ej2-grids';
41
+ import { Render } from '../renderer/render';
42
+ import { DataManipulation } from './data';
43
+ import { RowDD } from '../actions/rowdragdrop';
44
+ import { Sort } from '../actions/sort';
45
+ import { ITreeData, RowExpandedEventArgs, RowCollapsedEventArgs, RowCollapsingEventArgs, TreeGridExcelExportProperties } from './interface';
46
+ import { DataStateChangeEventArgs, RowExpandingEventArgs, TreeGridPdfExportProperties } from './interface';
47
+ import { GridLine } from '@syncfusion/ej2-grids';
48
+ import { DataSourceChangedEventArgs, RecordDoubleClickEventArgs, ResizeArgs } from '@syncfusion/ej2-grids';
49
+ import { ToolbarItems, ToolbarItem, ContextMenuItem, RowPosition, CopyHierarchyType } from '../enum';
50
+ import { ItemModel, ClickEventArgs, BeforeOpenCloseMenuEventArgs, MenuEventArgs } from '@syncfusion/ej2-navigations';
51
+ import { PageSettingsModel } from '../models/page-settings-model';
52
+ import { AggregateRowModel } from '../models/summary-model';
53
+ import { ExcelExport } from '../actions/excel-export';
54
+ import { PdfExport } from '../actions/pdf-export';
55
+ import { Toolbar } from '../actions/toolbar';
56
+ import { Page } from '../actions/page';
57
+ import { ContextMenu } from '../actions/context-menu';
58
+ import { EditSettingsModel } from '../models/edit-settings-model';
59
+ import { Edit } from '../actions/edit';
60
+ import { SortSettingsModel } from '../models/sort-settings-model';
61
+ import { InfiniteScrollSettingsModel } from '../models/infinite-scroll-settings-model';
62
+ /**
63
+ * Represents the TreeGrid component.
64
+ * ```html
65
+ * <div id='treegrid'></div>
66
+ * <script>
67
+ * var treegridObj = new TreeGrid({ allowPaging: true });
68
+ * treegridObj.appendTo('#treegrid');
69
+ * </script>
70
+ * ```
71
+ */
72
+ export declare class TreeGrid extends Component<HTMLElement> implements INotifyPropertyChanged {
73
+ constructor(options?: TreeGridModel, element?: Element);
74
+ private defaultLocale;
75
+ private dataResults;
76
+ private l10n;
77
+ dataModule: DataManipulation;
78
+ private registeredTemplate;
79
+ private uniqueIDCollection;
80
+ private uniqueIDFilterCollection;
81
+ private changedRecords;
82
+ private deletedRecords;
83
+ private addedRecords;
84
+ private targetElement;
85
+ private isGantt;
86
+ private isAddedFromGantt;
87
+ private isIndentEnabled;
88
+ private indentOutdentAction;
89
+ private parentQuery;
90
+ private isCollapsedEventTriggered;
91
+ private isCollapsingEventTriggered;
92
+ private isExpandedEventTriggered;
93
+ private isExpandingEventTriggered;
94
+ private collapseAllPrevent;
95
+ private expandAllPrevent;
96
+ /**
97
+ * The `sortModule` is used to manipulate sorting in TreeGrid.
98
+ */
99
+ sortModule: Sort;
100
+ private action;
101
+ private dropIndex;
102
+ private dropPosition;
103
+ private modifiedRecords;
104
+ private selectedRecords;
105
+ private selectedRows;
106
+ private loggerModule;
107
+ private isSelfReference;
108
+ private columnModel;
109
+ private isExpandAll;
110
+ private isCollapseAll;
111
+ private isExpandRefresh;
112
+ private gridSettings;
113
+ private isEditCollapse;
114
+ private treeColumnTextAlign;
115
+ private treeColumnField;
116
+ private stackedHeader;
117
+ private isExcel;
118
+ /** @hidden */
119
+ initialRender: boolean;
120
+ /** @hidden */
121
+ flatData: Object[];
122
+ /** @hidden */
123
+ private infiniteScrollData;
124
+ /** @hidden */
125
+ private remoteCollapsedData;
126
+ /** @hidden */
127
+ private remoteExpandedData;
128
+ /** @hidden */
129
+ isLocalData: boolean;
130
+ /** @hidden */
131
+ parentData: Object[];
132
+ /**
133
+ * @hidden
134
+ */
135
+ renderModule: Render;
136
+ /** @hidden */
137
+ summaryModule: Aggregate;
138
+ /**
139
+ * The `reorderModule` is used to manipulate reordering in TreeGrid.
140
+ */
141
+ reorderModule: Reorder;
142
+ /**
143
+ * The `columnMenuModule` is used to manipulate column menu items and its action in TreeGrid.
144
+ */
145
+ columnMenuModule: ColumnMenu;
146
+ /**
147
+ * The `rowDragandDrop` is used to manipulate Row Reordering in TreeGrid.
148
+ */
149
+ rowDragAndDropModule: RowDD;
150
+ /**
151
+ * The `contextMenuModule` is used to handle context menu items and its action in the TreeGrid.
152
+ */
153
+ contextMenuModule: ContextMenu;
154
+ /**
155
+ * `detailRowModule` is used to handle detail rows rendering in the TreeGrid.
156
+ *
157
+ * @hidden
158
+ */
159
+ detailRowModule: DetailRow;
160
+ /**
161
+ * `freezeModule` is used to freeze the rows and columns in the TreeGrid.
162
+ *
163
+ * @hidden
164
+ */
165
+ freezeModule: Freeze;
166
+ /**
167
+ * Gets or sets the number of frozen rows.
168
+ *
169
+ * @default 0
170
+ */
171
+ frozenRows: number;
172
+ /**
173
+ * Gets or sets the number of frozen columns.
174
+ *
175
+ * @default 0
176
+ */
177
+ frozenColumns: number;
178
+ /**
179
+ * Defines the mode of clip. The available modes are,
180
+ * ```props
181
+ * * Clip :- Truncates the cell content when it overflows its area.
182
+ * * Ellipsis :- Displays ellipsis when the cell content overflows its area.
183
+ * * EllipsisWithTooltip :- Displays ellipsis when the cell content overflows its area,
184
+ * ```
185
+ * also it will display the tooltip while hover on ellipsis is applied.
186
+ *
187
+ * @default Syncfusion.EJ2.Grids.ClipMode.Ellipsis
188
+ * @aspType Syncfusion.EJ2.Grids.ClipMode
189
+ * @isEnumeration true
190
+ */
191
+ clipMode: ClipMode;
192
+ /**
193
+ * `resizeModule` is used to manipulate resizing in the TreeGrid.
194
+ *
195
+ * @hidden
196
+ */
197
+ resizeModule: Resize;
198
+ /**
199
+ * The `keyboardModule` is used to manipulate keyboard interactions in TreeGrid.
200
+ */
201
+ keyboardModule: KeyboardEvents;
202
+ /**
203
+ * The `printModule` is used to handle the printing feature of the TreeGrid.
204
+ */
205
+ printModule: Print;
206
+ /**
207
+ * `clipboardModule` is used to handle TreeGrid copy action.
208
+ */
209
+ clipboardModule: TreeClipboard;
210
+ private keyConfigs;
211
+ /** @hidden */
212
+ filterModule: Filter;
213
+ excelExportModule: ExcelExport;
214
+ pdfExportModule: PdfExport;
215
+ selectionModule: TreeGridSelection;
216
+ /** @hidden */
217
+ /** @hidden */
218
+ grid: Grid;
219
+ /**
220
+ * Defines the schema of dataSource.
221
+ * If the `columns` declaration is empty or undefined then the `columns` are automatically generated from data source.
222
+ * {% codeBlock src='treegrid/columns/index.md' %}{% endcodeBlock %}
223
+ *
224
+ * @default []
225
+ */
226
+ columns: ColumnModel[] | string[] | Column[];
227
+ /**
228
+ * Specifies the mapping property path for child records in data source
229
+ * {% codeBlock src='treegrid/childMapping/index.md' %}{% endcodeBlock %}
230
+ *
231
+ * @default null
232
+ */
233
+ childMapping: string;
234
+ /**
235
+ * Specifies whether record is parent or not for the remote data binding
236
+ *
237
+ * @default null
238
+ */
239
+ hasChildMapping: string;
240
+ /**
241
+ * Specifies the index of the column that needs to have the expander button.
242
+ *
243
+ * @default 0
244
+ */
245
+ treeColumnIndex: number;
246
+ /**
247
+ * Specifies the name of the field in the dataSource, which contains the id of that row.
248
+ * {% codeBlock src='treegrid/idMapping/index.md' %}{% endcodeBlock %}
249
+ *
250
+ * @default null
251
+ */
252
+ idMapping: string;
253
+ /**
254
+ * Specifies the name of the field in the dataSource, which contains the parent’s id
255
+ * {% codeBlock src='treegrid/parentIdMapping/index.md' %}{% endcodeBlock %}
256
+ *
257
+ * @default null
258
+ */
259
+ parentIdMapping: string;
260
+ /**
261
+ * Specifies whether to load all the rows in collapsed state when the TreeGrid is rendered for the first time.
262
+ *
263
+ * @default false
264
+ */
265
+ enableCollapseAll: boolean;
266
+ /**
267
+ * Specifies the mapping property path for the expand status of a record in data source.
268
+ *
269
+ * @default null
270
+ */
271
+ expandStateMapping: string;
272
+ /**
273
+ * If `allowRowDragAndDrop` is set to true, you can drag and drop treegrid rows at another treegrid.
274
+ *
275
+ * @default false
276
+ */
277
+ allowRowDragAndDrop: boolean;
278
+ /**
279
+ * It is used to render TreeGrid table rows.
280
+ * {% codeBlock src='treegrid/dataSource/index.md' %}{% endcodeBlock %}
281
+ *
282
+ * @default []
283
+ * @isGenericType true
284
+ * @isDataSource true
285
+ */
286
+ dataSource: Object | DataManager;
287
+ /**
288
+ * Defines the external [`Query`](https://ej2.syncfusion.com/documentation/data/api-query.html)
289
+ * that will be executed along with data processing.
290
+ *
291
+ * @default null
292
+ */
293
+ query: Query;
294
+ /**
295
+ * @hidden
296
+ */
297
+ cloneQuery: Query;
298
+ /**
299
+ * Defines the print modes. The available print modes are
300
+ * ```props
301
+ * * AllPages :- Prints all pages of the TreeGrid.
302
+ * * CurrentPage :- Prints the current page of the TreeGrid.
303
+ * ```
304
+ *
305
+ * @default Syncfusion.EJ2.Grids.PrintMode.AllPages
306
+ * @isEnumeration true
307
+ * @aspType Syncfusion.EJ2.Grids.PrintMode
308
+ */
309
+ printMode: PrintMode;
310
+ /**
311
+ * If `allowPaging` is set to true, pager renders.
312
+ *
313
+ * @default false
314
+ */
315
+ allowPaging: boolean;
316
+ /**
317
+ * If `loadChildOnDemand` is enabled, parent records are render in expanded state.
318
+ *
319
+ * @default false
320
+ */
321
+ loadChildOnDemand: boolean;
322
+ /**
323
+ * If `allowTextWrap` set to true,
324
+ * then text content will wrap to the next line when its text content exceeds the width of the Column Cells.
325
+ *
326
+ * @default false
327
+ */
328
+ allowTextWrap: boolean;
329
+ /**
330
+ * Configures the text wrap in the TreeGrid.
331
+ *
332
+ * @default {wrapMode:"Both"}
333
+ */
334
+ textWrapSettings: TextWrapSettingsModel;
335
+ /**
336
+ * If `allowReordering` is set to true, TreeGrid columns can be reordered.
337
+ * Reordering can be done by drag and drop of a particular column from one index to another index.
338
+ * > If TreeGrid is rendered with stacked headers, reordering is allowed only at the same level as the column headers.
339
+ *
340
+ * @default false
341
+ */
342
+ allowReordering: boolean;
343
+ /**
344
+ * If `allowResizing` is set to true, TreeGrid columns can be resized.
345
+ *
346
+ * @default false
347
+ */
348
+ allowResizing: boolean;
349
+ /**
350
+ * If `autoCheckHierarchy` is set to true, hierarchy checkbox selection is enabled in TreeGrid.
351
+ *
352
+ * @default false
353
+ */
354
+ autoCheckHierarchy: boolean;
355
+ /**
356
+ * Configures the pager in the TreeGrid.
357
+ *
358
+ * @default {currentPage: 1, pageSize: 12, pageCount: 8, enableQueryString: false, pageSizes: false, template: null}
359
+ */
360
+ pageSettings: PageSettingsModel;
361
+ /**
362
+ * Configures the row drop settings of the TreeGrid.
363
+ */
364
+ rowDropSettings: RowDropSettingsModel;
365
+ /**
366
+ * Defines the currencyCode format of the Tree Grid columns
367
+ *
368
+ * @private
369
+ */
370
+ private currencyCode;
371
+ /**
372
+ * @hidden
373
+ * It used to render pager template
374
+ * @default null
375
+ * @aspType string
376
+ */
377
+ pagerTemplate: string | Function;
378
+ /**
379
+ * If `showColumnMenu` set to true, then it will enable the column menu options in each columns.
380
+ *
381
+ * > Check the [`Column menu`](../../treegrid/columns/#column-menu/) for its configuration.
382
+ *
383
+ * @default false
384
+ */
385
+ showColumnMenu: boolean;
386
+ /**
387
+ * If `showColumnChooser` is set to true, it allows you to dynamically show or hide columns.
388
+ *
389
+ * @default false
390
+ */
391
+ showColumnChooser: boolean;
392
+ /**
393
+ * If `allowSorting` is set to true, it allows sorting of treegrid records when column header is clicked.
394
+ *
395
+ * @default false
396
+ */
397
+ allowSorting: boolean;
398
+ /**
399
+ * If `allowMultiSorting` set to true, then it will allow the user to sort multiple column in the treegrid.
400
+ * > `allowSorting` should be true.
401
+ *
402
+ * @default true
403
+ */
404
+ allowMultiSorting: boolean;
405
+ /**
406
+ * Configures the sort settings of the TreeGrid.
407
+ *
408
+ * @default {columns:[]}
409
+ */
410
+ sortSettings: SortSettingsModel;
411
+ /**
412
+ * Configures the TreeGrid aggregate rows.
413
+ * > Check the [`Aggregates`](../../treegrid/aggregates/aggregates) for its configuration.
414
+ *
415
+ * @default []
416
+ */
417
+ aggregates: AggregateRowModel[];
418
+ /**
419
+ * Configures the edit settings.
420
+ *
421
+ * @default { allowAdding: false, allowEditing: false, allowDeleting: false, mode:'Normal',
422
+ * allowEditOnDblClick: true, showConfirmDialog: true, showDeleteConfirmDialog: false }
423
+ */
424
+ editSettings: EditSettingsModel;
425
+ /**
426
+ * If `allowFiltering` is set to true the filter bar will be displayed.
427
+ * If set to false the filter bar will not be displayed.
428
+ * Filter bar allows the user to filter tree grid records with required criteria.
429
+ *
430
+ * @default false
431
+ */
432
+ allowFiltering: boolean;
433
+ /**
434
+ * The detail template allows you to show or hide additional information about a particular row.
435
+ *
436
+ * > It accepts either the [template string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals)
437
+ * or the HTML element ID.
438
+ *
439
+ * @aspType string
440
+ */
441
+ detailTemplate: string | Function;
442
+ /**
443
+ * Configures the filter settings of the TreeGrid.
444
+ *
445
+ * @default {columns: [], type: 'FilterBar', mode: 'Immediate', showFilterBarStatus: true, immediateModeDelay: 1500 , operators: {}}
446
+ */
447
+ filterSettings: FilterSettingsModel;
448
+ /**
449
+ * Configures the search settings of the TreeGrid.
450
+ *
451
+ * @default {search: [] , operators: {}}
452
+ */
453
+ searchSettings: SearchSettingsModel;
454
+ /**
455
+ * `toolbar` defines the ToolBar items of the TreeGrid.
456
+ * It contains built-in and custom toolbar items.
457
+ * If a string value is assigned to the `toolbar` option, it is considered as the template for the whole TreeGrid ToolBar.
458
+ * If an array value is assigned, it is considered as the list of built-in and custom toolbar items in the TreeGrid's Toolbar.
459
+ * <br><br>
460
+ * The available built-in ToolBar items are:
461
+ * * Search: Searches records by the given key.
462
+ * * ExpandAll: Expands all the rows in TreeGrid
463
+ * * CollapseAll: Collapses all the rows in TreeGrid
464
+ * * ExcelExport - Export the TreeGrid to Excel(excelExport() method manually to make export.)
465
+ * * PdfExport - Export the TreeGrid to PDF(pdfExport() method manually to make export.)
466
+ * * CsvExport - Export the TreeGrid to CSV(csvExport() method manually to make export.)<br><br>
467
+ * The following code example implements the custom toolbar items.
468
+ *
469
+ * @default null
470
+ */
471
+ toolbar: (ToolbarItems | string | ItemModel | ToolbarItem)[];
472
+ /**
473
+ * @hidden
474
+ * It used to render toolbar template
475
+ * @default null
476
+ * @aspType string
477
+ */
478
+ toolbarTemplate: string | Function;
479
+ /**
480
+ * Defines the mode of TreeGrid lines. The available modes are,
481
+ * ```props
482
+ * * Both :- Displays both horizontal and vertical TreeGrid lines.
483
+ * * None :- No TreeGrid lines are displayed.
484
+ * * Horizontal :- Displays the horizontal TreeGrid lines only.
485
+ * * Vertical :- Displays the vertical TreeGrid lines only.
486
+ * * Default :- Displays TreeGrid lines based on the theme.
487
+ * ```
488
+ *
489
+ * @default Syncfusion.EJ2.Grids.GridLine.Default
490
+ * @isEnumeration true
491
+ * @aspType Syncfusion.EJ2.Grids.GridLine
492
+ */
493
+ gridLines: GridLine;
494
+ /**
495
+ * `contextMenuItems` defines both built-in and custom context menu items.
496
+ * <br><br>
497
+ * The available built-in items are,
498
+ * * `AutoFitAll` - Auto fit the size of all columns.
499
+ * * `AutoFit` - Auto fit the current column.
500
+ * * `Edit` - Edit the current record.
501
+ * * `Delete` - Delete the current record.
502
+ * * `Save` - Save the edited record.
503
+ * * `Cancel` - Cancel the edited state.
504
+ * * `PdfExport` - Export the grid as Pdf format.
505
+ * * `ExcelExport` - Export the grid as Excel format.
506
+ * * `CsvExport` - Export the grid as CSV format.
507
+ * * `SortAscending` - Sort the current column in ascending order.
508
+ * * `SortDescending` - Sort the current column in descending order.
509
+ * * `FirstPage` - Go to the first page.
510
+ * * `PrevPage` - Go to the previous page.
511
+ * * `LastPage` - Go to the last page.
512
+ * * `NextPage` - Go to the next page.
513
+ *
514
+ * @default null
515
+ */
516
+ contextMenuItems: ContextMenuItem[] | ContextMenuItemModel[];
517
+ /**
518
+ * `columnMenuItems` defines both built-in and custom column menu items.
519
+ * <br><br>
520
+ * The available built-in items are,
521
+ * * `AutoFitAll` - Auto fit the size of all columns.
522
+ * * `AutoFit` - Auto fit the current column.
523
+ * * `SortAscending` - Sort the current column in ascending order.
524
+ * * `SortDescending` - Sort the current column in descending order.
525
+ * * `Filter` - Filter options will show based on filterSettings property like filterbar, menu filter.
526
+ *
527
+ * @default null
528
+ */
529
+ columnMenuItems: ColumnMenuItem[] | ColumnMenuItemModel[];
530
+ /**
531
+ * The row template that renders customized rows from the given template.
532
+ * By default, TreeGrid renders a table row for every data source item.
533
+ * > * It accepts either [template string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals)
534
+ * or HTML element ID.
535
+ * > * The row template must be a table row.
536
+ *
537
+ * > Check the [`Row Template`](../../treegrid/row) customization.
538
+ *
539
+ * @aspType string
540
+ */
541
+ rowTemplate: string | Function;
542
+ /**
543
+ * `copyHierarchyMode` Defines the copy clipboard types.
544
+ * <br><br>
545
+ * The available built-in items are,
546
+ * * `Parent` - Copy the selected data with parent record.
547
+ * * `Child` - Copy the selected data with child record.
548
+ * * `Both` - Copy the selected data with both parent and child record.
549
+ * * `None` - Copy only the selected record.
550
+ *
551
+ * @default Parent
552
+ */
553
+ copyHierarchyMode: CopyHierarchyType;
554
+ /**
555
+ * Defines the height of TreeGrid rows.
556
+ *
557
+ * @default null
558
+ */
559
+ rowHeight: number;
560
+ /**
561
+ * If `enableAltRow` is set to true, the TreeGrid will render with `e-altrow` CSS class to the alternative tr elements.
562
+ * > Check the [`AltRow`](../../treegrid/row/#styling-alternate-rows/) to customize the styles of alternative rows.
563
+ *
564
+ * @default true
565
+ */
566
+ enableAltRow: boolean;
567
+ /**
568
+ * Enables or disables the key board interaction of TreeGrid.
569
+ *
570
+ * @hidden
571
+ * @default true
572
+ */
573
+ allowKeyboard: boolean;
574
+ /**
575
+ * If `enableHover` is set to true, the row hover is enabled in the TreeGrid.
576
+ *
577
+ * @default false
578
+ */
579
+ enableHover: boolean;
580
+ /**
581
+ * If `enableAutoFill` is set to true, then the auto fill icon will displayed on cell selection for copy cells.
582
+ * It requires the selection `mode` to be Cell and `cellSelectionMode` to be `Box`.
583
+ *
584
+ * @default false
585
+ */
586
+ enableAutoFill: boolean;
587
+ /**
588
+ * If `enableAdaptiveUI` is set to true, the pop-up UI will become adaptive to small screens,
589
+ * and be used for filtering and other features.
590
+ * ```html
591
+ * <div id='treegrid'></div>
592
+ * <script>
593
+ * var treegridObj = new TreeGrid({ enableAdaptiveUI: true });
594
+ * treegridObj.appendTo('#treegrid');
595
+ * </script>
596
+ * ```
597
+ *
598
+ * @default false
599
+ */
600
+ enableAdaptiveUI: boolean;
601
+ /**
602
+ * If `enableImmutableMode` is set to true, the TreeGrid will reuse old rows if it exists in the new result instead of
603
+ * full refresh while performing the TreeGrid actions.
604
+ *
605
+ * @default false
606
+ */
607
+ enableImmutableMode: boolean;
608
+ /**
609
+ * Defines the scrollable height of the TreeGrid content.
610
+ *
611
+ * @default 'auto'
612
+ */
613
+ height: string | number;
614
+ /**
615
+ * Defines the TreeGrid width.
616
+ *
617
+ * @default 'auto'
618
+ */
619
+ width: string | number;
620
+ /**
621
+ * Configures the loading indicator of the Tree Grid. Specifies whether to display spinner or shimmer effect
622
+ * during the waiting time on any actions (paging, sorting, filtering, CRUD operations) performed in Tree Grid.
623
+ *
624
+ * @default {indicatorType: 'Spinner'}
625
+ */
626
+ loadingIndicator: LoadingIndicatorModel;
627
+ /**
628
+ * Specifies whether to display shimmer effect during scrolling action in virtual scrolling feature.
629
+ * If disabled, spinner is shown instead of shimmer effect.
630
+ *
631
+ * @default true
632
+ */
633
+ enableVirtualMaskRow: boolean;
634
+ /**
635
+ * If `enableVirtualization` set to true, then the TreeGrid will render only the rows visible within the view-port
636
+ * and load subsequent rows on vertical scrolling. This helps to load large dataset in TreeGrid.
637
+ *
638
+ * @default false
639
+ */
640
+ enableVirtualization: boolean;
641
+ /**
642
+ * If `enableColumnVirtualization` set to true, then the Tree Grid will render only the columns visible within the view-port
643
+ * and load subsequent columns on horizontal scrolling. This helps to load large dataset of columns in Tree Grid.
644
+ *
645
+ * @default false
646
+ */
647
+ enableColumnVirtualization: boolean;
648
+ /**
649
+ * Specifies whether to display or remove the untrusted HTML values in the TreeGrid component.
650
+ * If `enableHtmlSanitizer` is set to true, then it will sanitize any suspected untrusted strings and scripts before rendering them.
651
+ *
652
+ * @default false
653
+ */
654
+ enableHtmlSanitizer: boolean;
655
+ /**
656
+ * If `enableInfiniteScrolling` set to true, then the data will be loaded in TreeGrid when the scrollbar reaches the end.
657
+ * This helps to load large dataset in TreeGrid.
658
+ *
659
+ * @default false
660
+ * @deprecated
661
+ */
662
+ enableInfiniteScrolling: boolean;
663
+ /**
664
+ * Configures the infinite scroll settings.
665
+ *
666
+ * @default { enableCache: false, maxBlocks: 5, initialBlocks: 5 }
667
+ * @deprecated
668
+ */
669
+ infiniteScrollSettings: InfiniteScrollSettingsModel;
670
+ /**
671
+ * `columnQueryMode`provides options to retrieves data from the data source.Their types are
672
+ * * `All`: It retrieves whole data source.
673
+ * * `Schema`: retrieves data for all the defined columns in TreeGrid from the data source.
674
+ * * `ExcludeHidden`: retrieves data only for visible columns of TreeGrid from the data Source.
675
+ *
676
+ * @default All
677
+ */
678
+ columnQueryMode: ColumnQueryModeType;
679
+ /**
680
+ * Triggers when the component is created.
681
+ *
682
+ * @event created
683
+ */
684
+ created: EmitType<Object>;
685
+ /**
686
+ * This event allows customization of TreeGrid properties before rendering.
687
+ *
688
+ * @event load
689
+ */
690
+ load: EmitType<Object>;
691
+ /**
692
+ * Triggers while expanding the TreeGrid record
693
+ *
694
+ * @event expanding
695
+ */
696
+ expanding: EmitType<RowExpandingEventArgs>;
697
+ /**
698
+ * Triggers after the record is expanded
699
+ *
700
+ * @event expanded
701
+ */
702
+ expanded: EmitType<RowExpandedEventArgs>;
703
+ /**
704
+ * Triggers while collapsing the TreeGrid record
705
+ *
706
+ * @event collapsing
707
+ */
708
+ collapsing: EmitType<RowCollapsingEventArgs>;
709
+ /**
710
+ * Triggers after the record is collapsed.
711
+ *
712
+ * @event collapsed
713
+ */
714
+ collapsed: EmitType<RowCollapsedEventArgs>;
715
+ /**
716
+ * Triggers when cell is saved.
717
+ *
718
+ * @event cellSave
719
+ */
720
+ cellSave: EmitType<CellSaveArgs>;
721
+ /**
722
+ * Triggers when cell is saved.
723
+ *
724
+ * @event cellSaved
725
+ */
726
+ cellSaved: EmitType<CellSaveArgs>;
727
+ /**
728
+ * Triggers when TreeGrid actions such as sorting, filtering, paging etc., starts.
729
+ * @event actionBegin
730
+ */
731
+ actionBegin: EmitType<PageEventArgs | FilterEventArgs | SortEventArgs | SearchEventArgs | AddEventArgs | SaveEventArgs | EditEventArgs | DeleteEventArgs>;
732
+ /**
733
+ * Triggers when TreeGrid actions such as sorting, filtering, paging etc. are completed.
734
+ * @event actionComplete
735
+ */
736
+ actionComplete: EmitType<PageEventArgs | FilterEventArgs | SortEventArgs | SearchEventArgs | AddEventArgs | SaveEventArgs | EditEventArgs | DeleteEventArgs>;
737
+ /**
738
+ * Triggers before the record is to be edit.
739
+ * @event beginEdit
740
+ */
741
+ beginEdit: EmitType<BeginEditArgs>;
742
+ /**
743
+ * Triggers when records are added in batch mode.
744
+ * @event batchAdd
745
+ */
746
+ batchAdd: EmitType<BatchAddArgs>;
747
+ /**
748
+ * Triggers when records are deleted in batch mode.
749
+ * @event batchDelete
750
+ */
751
+ batchDelete: EmitType<BatchDeleteArgs>;
752
+ /**
753
+ * Triggers before records are added in batch mode.
754
+ * @event batchCancel
755
+ */
756
+ batchCancel: EmitType<BatchCancelArgs>;
757
+ /**
758
+ * Triggers before records are added in batch mode.
759
+ * @event beforeBatchAdd
760
+ */
761
+ beforeBatchAdd: EmitType<BeforeBatchAddArgs>;
762
+ /**
763
+ * Triggers before records are deleted in batch mode.
764
+ * @event beforeBatchDelete
765
+ */
766
+ beforeBatchDelete: EmitType<BeforeBatchDeleteArgs>;
767
+ /**
768
+ * Triggers before records are saved in batch mode.
769
+ * @event beforeBatchSave
770
+ */
771
+ beforeBatchSave: EmitType<BeforeBatchSaveArgs>;
772
+ /**
773
+ * Triggers when the cell is being edited.
774
+ * @event cellEdit
775
+ */
776
+ cellEdit: EmitType<CellEditArgs>;
777
+ /**
778
+ * Triggers when any TreeGrid action failed to achieve the desired results.
779
+ *
780
+ * @event actionFailure
781
+ */
782
+ actionFailure: EmitType<FailureEventArgs>;
783
+ /**
784
+ * Triggers when data source is populated in the TreeGrid.
785
+ *
786
+ * @event dataBound
787
+ */
788
+ dataBound: EmitType<Object>;
789
+ /**
790
+ * Triggers when the TreeGrid data is added, deleted and updated.
791
+ * Invoke the done method from the argument to start render after edit operation.
792
+ *
793
+ * @event dataSourceChanged
794
+ * @deprecated
795
+ */
796
+ dataSourceChanged: EmitType<DataSourceChangedEventArgs>;
797
+ /**
798
+ * Triggers when the TreeGrid actions such as Sorting, Paging etc., are done.
799
+ * In this event,the current view data and total record count should be assigned to the `dataSource` based on the action performed.
800
+ *
801
+ * @event dataStateChange
802
+ * @deprecated
803
+ */
804
+ dataStateChange: EmitType<DataStateChangeEventArgs>;
805
+ /**
806
+ * Triggers when record is double clicked.
807
+ *
808
+ * @event recordDoubleClick
809
+ */
810
+ recordDoubleClick: EmitType<RecordDoubleClickEventArgs>;
811
+ /**
812
+ * Triggered every time a request is made to access row information, element, or data.
813
+ * This will be triggered before the row element is appended to the TreeGrid element.
814
+ *
815
+ * @event rowDataBound
816
+ */
817
+ rowDataBound: EmitType<RowDataBoundEventArgs>;
818
+ /**
819
+ * Triggers after detail row expands.
820
+ * > This event triggers at initial expand.
821
+ *
822
+ * @event detailDataBound
823
+ */
824
+ detailDataBound: EmitType<DetailDataBoundEventArgs>;
825
+ /**
826
+ * Triggered every time a request is made to access cell information, element, or data.
827
+ * This will be triggered before the cell element is appended to the TreeGrid element.
828
+ *
829
+ * @event queryCellInfo
830
+ */
831
+ queryCellInfo: EmitType<QueryCellInfoEventArgs>;
832
+ /**
833
+ * If `allowSelection` is set to true, it allows selection of (highlight row) TreeGrid records by clicking it.
834
+ *
835
+ * @default true
836
+ */
837
+ allowSelection: boolean;
838
+ /**
839
+ * Triggers before row selection occurs.
840
+ *
841
+ * @event rowSelecting
842
+ */
843
+ rowSelecting: EmitType<RowSelectingEventArgs>;
844
+ /**
845
+ * Triggers after a row is selected.
846
+ *
847
+ * @event rowSelected
848
+ */
849
+ rowSelected: EmitType<RowSelectEventArgs>;
850
+ /**
851
+ * Triggers before deselecting the selected row.
852
+ *
853
+ * @event rowSelected
854
+ * @deprecated
855
+ */
856
+ rowDeselecting: EmitType<RowDeselectEventArgs>;
857
+ /**
858
+ * Triggers when a selected row is deselected.
859
+ *
860
+ * @event rowDeselected
861
+ */
862
+ rowDeselected: EmitType<RowDeselectEventArgs>;
863
+ /**
864
+ * Triggered for stacked header.
865
+ *
866
+ * @event headerCellInfo
867
+ */
868
+ headerCellInfo: EmitType<HeaderCellInfoEventArgs>;
869
+ /**
870
+ * Triggers before any cell selection occurs.
871
+ *
872
+ * @event cellSelecting
873
+ */
874
+ cellSelecting: EmitType<CellSelectingEventArgs>;
875
+ /**
876
+ * Triggers before column menu opens.
877
+ *
878
+ * @event columnMenuOpen
879
+ * @deprecated
880
+ */
881
+ columnMenuOpen: EmitType<ColumnMenuOpenEventArgs>;
882
+ /**
883
+ * Triggers when click on column menu.
884
+ *
885
+ * @event columnMenuClick
886
+ */
887
+ columnMenuClick: EmitType<MenuEventArgs>;
888
+ /**
889
+ * Triggers after a cell is selected.
890
+ *
891
+ * @event cellSelected
892
+ */
893
+ cellSelected: EmitType<CellSelectEventArgs>;
894
+ /**
895
+ * Triggers before the selected cell is deselecting.
896
+ *
897
+ * @event cellDeselecting
898
+ * @deprecated
899
+ */
900
+ cellDeselecting: EmitType<CellDeselectEventArgs>;
901
+ /**
902
+ * Triggers when a particular selected cell is deselected.
903
+ *
904
+ * @event cellDeselected
905
+ * @deprecated
906
+ */
907
+ cellDeselected: EmitType<CellDeselectEventArgs>;
908
+ /**
909
+ * Triggers when column resize starts.
910
+ *
911
+ * @event resizeStart
912
+ * @deprecated
913
+ */
914
+ resizeStart: EmitType<ResizeArgs>;
915
+ /**
916
+ * Triggers on column resizing.
917
+ *
918
+ * @event resizing
919
+ * @deprecated
920
+ */
921
+ resizing: EmitType<ResizeArgs>;
922
+ /**
923
+ * Triggers when column resize ends.
924
+ *
925
+ * @event resizeStop
926
+ * @deprecated
927
+ */
928
+ resizeStop: EmitType<ResizeArgs>;
929
+ /**
930
+ * Triggers when column header element drag (move) starts.
931
+ *
932
+ * @event columnDragStart
933
+ * @deprecated
934
+ */
935
+ columnDragStart: EmitType<ColumnDragEventArgs>;
936
+ /**
937
+ * Triggers when column header element is dragged (moved) continuously.
938
+ *
939
+ * @event columnDrag
940
+ * @deprecated
941
+ */
942
+ columnDrag: EmitType<ColumnDragEventArgs>;
943
+ /**
944
+ * Triggers when a column header element is dropped on the target column.
945
+ *
946
+ * @event columnDrop
947
+ * @deprecated
948
+ */
949
+ columnDrop: EmitType<ColumnDragEventArgs>;
950
+ /**
951
+ * Triggers when the check box state change in checkbox column.
952
+ *
953
+ * @event checkboxChange
954
+ * @deprecated
955
+ */
956
+ checkboxChange: EmitType<CheckBoxChangeEventArgs>;
957
+ /**
958
+ * Triggers after print action is completed.
959
+ *
960
+ * @event printComplete
961
+ * @deprecated
962
+ */
963
+ printComplete: EmitType<PrintEventArgs>;
964
+ /**
965
+ * Triggers before the print action starts.
966
+ *
967
+ * @event beforePrint
968
+ * @deprecated
969
+ */
970
+ beforePrint: EmitType<PrintEventArgs>;
971
+ /**
972
+ * Triggers when toolbar item is clicked.
973
+ *
974
+ * @event toolbarClick
975
+ */
976
+ toolbarClick: EmitType<ClickEventArgs>;
977
+ /**
978
+ * Triggers before data is bound to Tree Grid.
979
+ *
980
+ * @event beforeDataBound
981
+ */
982
+ beforeDataBound: EmitType<BeforeDataBoundArgs>;
983
+ /**
984
+ * Triggers before context menu opens.
985
+ *
986
+ * @event contextMenuOpen
987
+ * @deprecated
988
+ */
989
+ contextMenuOpen: EmitType<BeforeOpenCloseMenuEventArgs>;
990
+ /**
991
+ * Triggers when click on context menu.
992
+ *
993
+ * @event contextMenuClick
994
+ */
995
+ contextMenuClick: EmitType<MenuEventArgs>;
996
+ /**
997
+ * Triggers before TreeGrid copy action.
998
+ *
999
+ * @event beforeCopy
1000
+ * @deprecated
1001
+ */
1002
+ beforeCopy: EmitType<BeforeCopyEventArgs>;
1003
+ /**
1004
+ * Triggers before TreeGrid paste action.
1005
+ *
1006
+ * @event beforePaste
1007
+ * @deprecated
1008
+ */
1009
+ beforePaste: EmitType<BeforePasteEventArgs>;
1010
+ /**
1011
+ * Triggers when row elements are dragged (moved) continuously.
1012
+ *
1013
+ * @event rowDrag
1014
+ * @deprecated
1015
+ */
1016
+ rowDrag: EmitType<RowDragEventArgs>;
1017
+ /**
1018
+ * Triggers when row element’s drag(move) starts.
1019
+ *
1020
+ * @event rowDragStart
1021
+ * @deprecated
1022
+ */
1023
+ rowDragStart: EmitType<RowDragEventArgs>;
1024
+ /**
1025
+ * Triggers when row element’s before drag(move).
1026
+ *
1027
+ * @event rowDragStartHelper
1028
+ * @deprecated
1029
+ */
1030
+ rowDragStartHelper: EmitType<RowDragEventArgs>;
1031
+ /**
1032
+ * Triggers when row elements are dropped on the target row.
1033
+ *
1034
+ * @event rowDrop
1035
+ * @deprecated
1036
+ */
1037
+ rowDrop: EmitType<RowDragEventArgs>;
1038
+ /**
1039
+ * The `selectedRowIndex` allows you to select a row at initial rendering.
1040
+ * You can also get the currently selected row index.
1041
+ *
1042
+ * @default -1
1043
+ */
1044
+ selectedRowIndex: number;
1045
+ /**
1046
+ * Configures the selection settings.
1047
+ *
1048
+ * @default {mode: 'Row', cellSelectionMode: 'Flow', type: 'Single'}
1049
+ */
1050
+ selectionSettings: SelectionSettingsModel;
1051
+ /**
1052
+ * If `allowExcelExport` set to true, then it will allow the user to export treegrid to Excel file.
1053
+ *
1054
+ * > Check the [`ExcelExport`](../../treegrid/excel-export/) to configure exporting document.
1055
+ *
1056
+ * @default false
1057
+ */
1058
+ allowExcelExport: boolean;
1059
+ /**
1060
+ * If `allowPdfExport` set to true, then it will allow the user to export treegrid to Pdf file.
1061
+ *
1062
+ * > Check the [`Pdfexport`](../../treegrid/pdf-export/) to configure the exporting document.
1063
+ *
1064
+ * @default false
1065
+ */
1066
+ allowPdfExport: boolean;
1067
+ /**
1068
+ * Triggers before exporting each cell to PDF document.
1069
+ * You can also customize the PDF cells.
1070
+ *
1071
+ * @event pdfQueryCellInfo
1072
+ * @deprecated
1073
+ */
1074
+ pdfQueryCellInfo: EmitType<PdfQueryCellInfoEventArgs>;
1075
+ /**
1076
+ * Triggers before exporting each header cell to PDF document.
1077
+ * You can also customize the PDF cells.
1078
+ *
1079
+ * @event pdfHeaderQueryCellInfo
1080
+ * @deprecated
1081
+ */
1082
+ pdfHeaderQueryCellInfo: EmitType<PdfHeaderQueryCellInfoEventArgs>;
1083
+ /**
1084
+ * Triggers before exporting each cell to Excel file.
1085
+ * You can also customize the Excel cells.
1086
+ *
1087
+ * @event excelQueryCellInfo
1088
+ * @deprecated
1089
+ */
1090
+ excelQueryCellInfo: EmitType<ExcelQueryCellInfoEventArgs>;
1091
+ /**
1092
+ * Triggers before exporting each header cell to Excel file.
1093
+ * You can also customize the Excel cells.
1094
+ *
1095
+ * @event excelHeaderQueryCellInfo
1096
+ * @deprecated
1097
+ */
1098
+ excelHeaderQueryCellInfo: EmitType<ExcelHeaderQueryCellInfoEventArgs>;
1099
+ /**
1100
+ * Triggers before TreeGrid data is exported to Excel file.
1101
+ *
1102
+ * @event beforeExcelExport
1103
+ */
1104
+ beforeExcelExport: EmitType<Object>;
1105
+ /**
1106
+ * Triggers after TreeGrid data is exported to Excel file.
1107
+ *
1108
+ * @event excelExportComplete
1109
+ * @deprecated
1110
+ */
1111
+ excelExportComplete: EmitType<ExcelExportCompleteArgs>;
1112
+ /**
1113
+ * Triggers before TreeGrid data is exported to PDF document.
1114
+ *
1115
+ * @event beforePdfExport
1116
+ */
1117
+ beforePdfExport: EmitType<Object>;
1118
+ /**
1119
+ * Triggers after TreeGrid data is exported to PDF document.
1120
+ *
1121
+ * @event pdfExportComplete
1122
+ * @deprecated
1123
+ */
1124
+ pdfExportComplete: EmitType<PdfExportCompleteArgs>;
1125
+ /**
1126
+ * Export TreeGrid data to Excel file(.xlsx).
1127
+ *
1128
+ * @param {ExcelExportProperties | TreeGridExcelExportProperties} excelExportProperties - Defines the export properties of the Tree Grid.
1129
+ * @param {boolean} isMultipleExport - Define to enable multiple export.
1130
+ * @param {workbook} workbook - Defines the Workbook if multiple export is enabled.
1131
+ * @param {boolean} isBlob - If 'isBlob' set to true, then it will be returned as blob data.
1132
+ * @returns {Promise<any>} - Returns promise object of export action
1133
+ */
1134
+ excelExport(excelExportProperties?: ExcelExportProperties | TreeGridExcelExportProperties, isMultipleExport?: boolean, workbook?: any, isBlob?: boolean): Promise<any>;
1135
+ /**
1136
+ * Export TreeGrid data to CSV file.
1137
+ *
1138
+ * @param {ExcelExportProperties} excelExportProperties - Defines the export properties of the TreeGrid.
1139
+ * @param {boolean} isMultipleExport - Define to enable multiple export.
1140
+ * @param {workbook} workbook - Defines the Workbook if multiple export is enabled.
1141
+ * @param {boolean} isBlob - If 'isBlob' set to true, then it will be returned as blob data.
1142
+ * @returns {Promise<any>} - Returns promise object of export action
1143
+ */
1144
+ csvExport(excelExportProperties?: ExcelExportProperties, isMultipleExport?: boolean, workbook?: any, isBlob?: boolean): Promise<any>;
1145
+ /**
1146
+ * Export TreeGrid data to PDF document.
1147
+ *
1148
+ * @param {PdfExportProperties | TreeGridPdfExportProperties} pdfExportProperties - Defines the export properties of the Tree Grid.
1149
+ * @param {boolean} isMultipleExport - Define to enable multiple export.
1150
+ * @param {Object} pdfDoc - Defined the Pdf Document if multiple export is enabled.
1151
+ * @param {boolean} isBlob - If 'isBlob' set to true, then it will be returned as blob data.
1152
+ * @returns {Promise<any>} - Returns promise object of export action
1153
+ */
1154
+ pdfExport(pdfExportProperties?: PdfExportProperties | TreeGridPdfExportProperties, isMultipleExport?: boolean, pdfDoc?: Object, isBlob?: boolean): Promise<Object>;
1155
+ /**
1156
+ * Sends a post request to export tree grid to excel file in server side.
1157
+ *
1158
+ * @param {string} url - Pass URL for server side excel export action.
1159
+ * @returns {void}
1160
+ */
1161
+ serverExcelExport(url: string): void;
1162
+ /**
1163
+ * Sends a post request to export tree grid to pdf file in server side.
1164
+ *
1165
+ * @param {string} url - Pass URL for server-side pdf export action.
1166
+ * @returns {void}
1167
+ */
1168
+ serverPdfExport(url: string): void;
1169
+ /**
1170
+ * Sends a Post request to export Tree Grid to CSV file in server side.
1171
+ *
1172
+ * @param {string} url - Pass URL for server-side csv export action.
1173
+ * @returns {void}
1174
+ */
1175
+ serverCsvExport(url: string): void;
1176
+ /**
1177
+ * Exports the TreeGrid data to the specified URL using a POST request.
1178
+ *
1179
+ * @param {string} url - Defines exporting url
1180
+ * @returns {void}
1181
+ */
1182
+ private exportTreeGrid;
1183
+ /**
1184
+ * Sets the header text and other properties for an array of columns based on specified criteria.
1185
+ *
1186
+ * @param {Column[]} columns - Defines array of columns
1187
+ * @param {string[]} include - Defines array of sting
1188
+ * @returns {Column[]} returns array of columns
1189
+ */
1190
+ private setHeaderText;
1191
+ /**
1192
+ * Retrieves the appropriate format string from the given format options.
1193
+ *
1194
+ * @param {string | NumberFormatOptions | DateFormatOptions} format - The format options to retrieve the format string from.
1195
+ * @returns {string} The format string extracted from the provided format options.
1196
+ */
1197
+ private getFormat;
1198
+ /**
1199
+ * For internal use only - Get the module name.
1200
+ *
1201
+ * @private
1202
+ * @returns {string} Returns TreeGrid module name
1203
+ */
1204
+ protected getModuleName(): string;
1205
+ /**
1206
+ * For internal use only - Initialize the event handler;
1207
+ *
1208
+ * @private
1209
+ * @returns {void}
1210
+ */
1211
+ protected preRender(): void;
1212
+ /**
1213
+ * Sorts a column with the given options.
1214
+ *
1215
+ * @param {string} columnName - Defines the column name to be sorted.
1216
+ * @param {SortDirection} direction - Defines the direction of sorting field.
1217
+ * @param {boolean} isMultiSort - Specifies whether the previous sorted columns are to be maintained.
1218
+ * @returns {void}
1219
+ */
1220
+ sortByColumn(columnName: string, direction: SortDirection, isMultiSort?: boolean): void;
1221
+ /**
1222
+ * Clears all the sorted columns of the TreeGrid.
1223
+ *
1224
+ * @returns {void}
1225
+ */
1226
+ clearSorting(): void;
1227
+ /**
1228
+ * Remove sorted column by field name.
1229
+ *
1230
+ * @param {string} field - Defines the column field name to remove sort.
1231
+ * @returns {void}
1232
+ * @hidden
1233
+ */
1234
+ removeSortColumn(field: string): void;
1235
+ /**
1236
+ * Searches TreeGrid records using the given key.
1237
+ * You can customize the default search option by using the
1238
+ * [`searchSettings`](./#searchsettings/).
1239
+ *
1240
+ * @param {string} searchString - Defines the key.
1241
+ * @returns {void}
1242
+ */
1243
+ search(searchString: string): void;
1244
+ /**
1245
+ * Changes the column width to automatically fit its content to ensure that the width shows the content without wrapping/hiding.
1246
+ * > * This method ignores the hidden columns.
1247
+ * > * Uses the `autoFitColumns` method in the `dataBound` event to resize at initial rendering.
1248
+ *
1249
+ * @param {string |string[]} fieldNames - Defines the column names.
1250
+ * @returns {void}
1251
+ *
1252
+ *
1253
+ *
1254
+ */
1255
+ autoFitColumns(fieldNames?: string | string[]): void;
1256
+ /**
1257
+ * Changes the TreeGrid column positions by field names.
1258
+ *
1259
+ * @param {string} fromFName - Defines the origin field name.
1260
+ * @param {string} toFName - Defines the destination field name.
1261
+ * @returns {void}
1262
+ */
1263
+ reorderColumns(fromFName: string | string[], toFName: string): void;
1264
+ private TreeGridLocale;
1265
+ /**
1266
+ * By default, prints all the pages of the TreeGrid and hides the pager.
1267
+ * > You can customize print options using the
1268
+ * [`printMode`](./#printmode).
1269
+ *
1270
+ * @returns {void}
1271
+ */
1272
+ print(): void;
1273
+ private treeGridkeyActionHandler;
1274
+ private findnextRowElement;
1275
+ private findPreviousRowElement;
1276
+ private initProperties;
1277
+ /**
1278
+ * Binding events to the element while component creation.
1279
+ *
1280
+ * @hidden
1281
+ * @returns {void}
1282
+ */
1283
+ wireEvents(): void;
1284
+ /**
1285
+ * To provide the array of modules needed for component rendering
1286
+ *
1287
+ * @returns {ModuleDeclaration[]} - Returns TreeGrid modules collection
1288
+ * @hidden
1289
+ */
1290
+ requiredModules(): ModuleDeclaration[];
1291
+ extendRequiredModules(modules: ModuleDeclaration[]): void;
1292
+ private isCommandColumn;
1293
+ /**
1294
+ * Unbinding events from the element while component destroy.
1295
+ *
1296
+ * @hidden
1297
+ * @returns {void}
1298
+ */
1299
+ unwireEvents(): void;
1300
+ /**
1301
+ * Logs tree grid error message on console
1302
+ *
1303
+ * @param {string | string[]} types - Tree Grid error type
1304
+ * @param {object} args - Error details
1305
+ * @hidden
1306
+ * @private
1307
+ * @returns {void}
1308
+ */
1309
+ log(types: string | string[], args?: Object): void;
1310
+ /**
1311
+ * For internal use only - To Initialize the component rendering.
1312
+ *
1313
+ * @private
1314
+ * @returns {void}
1315
+ */
1316
+ protected render(): void;
1317
+ private actionFailureHandler;
1318
+ private refreshToolbarItems;
1319
+ private afterGridRender;
1320
+ private convertTreeData;
1321
+ private bindGridProperties;
1322
+ private triggerEvents;
1323
+ private IsExpandCollapseClicked;
1324
+ private bindGridEvents;
1325
+ private lastRowBorder;
1326
+ private isPixelHeight;
1327
+ private extendedGridDataBoundEvent;
1328
+ private objectEqualityChecker;
1329
+ private bindCallBackEvents;
1330
+ private extendedGridEditEvents;
1331
+ private updateRowTemplate;
1332
+ private bindedDataSource;
1333
+ private extendedGridActionEvents;
1334
+ private extendedGridEvents;
1335
+ private bindGridDragEvents;
1336
+ /**
1337
+ * Renders TreeGrid component
1338
+ *
1339
+ * @private
1340
+ * @returns {void}
1341
+ */
1342
+ protected loadGrid(): void;
1343
+ /**
1344
+ * AutoGenerate TreeGrid columns from first record
1345
+ *
1346
+ * @hidden
1347
+ * @returns {void}
1348
+ */
1349
+ private autoGenerateColumns;
1350
+ private getGridEditSettings;
1351
+ /**
1352
+ * Defines grid toolbar from treegrid toolbar model
1353
+ *
1354
+ * @hidden
1355
+ * @returns {Object[]} - returns context menu items
1356
+ */
1357
+ private getContextMenu;
1358
+ /**
1359
+ * Defines grid toolbar from treegrid toolbar model
1360
+ *
1361
+ * @hidden
1362
+ * @returns {Object[]} - Returns toolbar items
1363
+ */
1364
+ private getGridToolbar;
1365
+ private getGridColumns;
1366
+ /**
1367
+ * Called internally if any of the property value changed.
1368
+ *
1369
+ * @param {TreeGridModel} newProp - properties details which has to be modified
1370
+ * @hidden
1371
+ * @returns {void}
1372
+ */
1373
+ onPropertyChanged(newProp: TreeGridModel): void;
1374
+ private updateTreeColumnTextAlign;
1375
+ /**
1376
+ * Destroys the component (detaches/removes all event handlers, attributes, classes, and empties the component element).
1377
+ *
1378
+ * @method destroy
1379
+ * @returns {void}
1380
+ */
1381
+ destroy(): void;
1382
+ /**
1383
+ * Update the TreeGrid model
1384
+ *
1385
+ * @method dataBind
1386
+ * @returns {void}
1387
+ * @private
1388
+ */
1389
+ dataBind(): void;
1390
+ /**
1391
+ * Get the properties to be maintained in the persisted state.
1392
+ *
1393
+ * @returns {string} - Returns persist properties details
1394
+ * @hidden
1395
+ */
1396
+ getPersistData(): string;
1397
+ private ignoreInArrays;
1398
+ private ignoreInColumn;
1399
+ private mouseClickHandler;
1400
+ /**
1401
+ * Returns TreeGrid rows
1402
+ *
1403
+ * @returns {HTMLTableRowElement[]} - Returns row elements collection
1404
+ */
1405
+ getRows(): HTMLTableRowElement[];
1406
+ /**
1407
+ * Gets the pager of the TreeGrid.
1408
+ *
1409
+ * @returns {Element} - Returns pager element
1410
+ */
1411
+ getPager(): Element;
1412
+ /**
1413
+ * Adds a new record to the TreeGrid. Without passing parameters, it adds empty rows.
1414
+ * > `editSettings.allowEditing` should be true.
1415
+ *
1416
+ * @param {Object} data - Defines the new add record data.
1417
+ * @param {number} index - Defines the row index to be added.
1418
+ * @param {RowPosition} position - Defines the new row position to be added.
1419
+ * @returns {void}
1420
+ */
1421
+ addRecord(data?: Object, index?: number, position?: RowPosition): void;
1422
+ /**
1423
+ * Cancels edited state.
1424
+ *
1425
+ * @returns {void}
1426
+ */
1427
+ closeEdit(): void;
1428
+ /**
1429
+ * Saves the cell that is currently edited. It does not save the value to the DataSource.
1430
+ *
1431
+ * @returns {void}
1432
+ */
1433
+ saveCell(): void;
1434
+ /**
1435
+ * To update the specified cell by given value without changing into edited state.
1436
+ *
1437
+ * @param {number} rowIndex Defines the row index.
1438
+ * @param {string} field Defines the column field.
1439
+ * @param {string | number | boolean | Date} value - Defines the value to be changed.
1440
+ * @returns {void}
1441
+ */
1442
+ updateCell(rowIndex: number, field: string, value: string | number | boolean | Date): void;
1443
+ /**
1444
+ * To update the specified row by given values without changing into edited state.
1445
+ *
1446
+ * @param {number} index Defines the row index.
1447
+ * @param {Object} data Defines the data object to be updated.
1448
+ * @returns {void}
1449
+ */
1450
+ updateRow(index: number, data: Object): void;
1451
+ /**
1452
+ * Delete a record with Given options. If fieldName and data is not given then TreeGrid will delete the selected record.
1453
+ * > `editSettings.allowDeleting` should be true.
1454
+ *
1455
+ * @param {string} fieldName - Defines the primary key field, 'Name of the column'.
1456
+ * @param {Object} data - Defines the JSON data of the record to be deleted.
1457
+ * @returns {void}
1458
+ */
1459
+ deleteRecord(fieldName?: string, data?: Object): void;
1460
+ /**
1461
+ * To edit any particular row by TR element.
1462
+ *
1463
+ * @param {HTMLTableRowElement} row - Defines the table row to be edited.
1464
+ * @returns {void}
1465
+ */
1466
+ startEdit(row?: HTMLTableRowElement): void;
1467
+ /**
1468
+ * To edit any particular cell using row index and cell index.
1469
+ *
1470
+ * @param {number} rowIndex - Defines row index to edit a particular cell.
1471
+ * @param {string} field - Defines the field name of the column to perform cell edit.
1472
+ * @returns {void}
1473
+ */
1474
+ editCell(rowIndex?: number, field?: string): void;
1475
+ /**
1476
+ * Enables or disables ToolBar items.
1477
+ *
1478
+ * @param {string[]} items - Defines the collection of itemID of ToolBar items.
1479
+ * @param {boolean} isEnable - Defines the items to be enabled or disabled.
1480
+ * @returns {void}
1481
+ */
1482
+ enableToolbarItems(items: string[], isEnable: boolean): void;
1483
+ /**
1484
+ * If TreeGrid is in editable state, you can save a record by invoking endEdit.
1485
+ *
1486
+ * @returns {void}
1487
+ */
1488
+ endEdit(): void;
1489
+ /**
1490
+ * Column chooser can be displayed on screen by given position(X and Y axis).
1491
+ *
1492
+ * @param {number} x - Defines the X axis.
1493
+ * @param {number} y - Defines the Y axis.
1494
+ * @returns {void}
1495
+ */
1496
+ openColumnChooser(x?: number, y?: number): void;
1497
+ /**
1498
+ * Delete any visible row by TR element.
1499
+ *
1500
+ * @param {HTMLTableRowElement} tr - Defines the table row element.
1501
+ * @returns {void}
1502
+ */
1503
+ deleteRow(tr: HTMLTableRowElement): void;
1504
+ /**
1505
+ * Get the names of the primary key columns of the TreeGrid.
1506
+ *
1507
+ * @returns {string[]} - Returns primary key collection
1508
+ */
1509
+ getPrimaryKeyFieldNames(): string[];
1510
+ /**
1511
+ * Updates particular cell value based on the given primary key value.
1512
+ * > Primary key column must be specified using `columns.isPrimaryKey` property.
1513
+ *
1514
+ * @param {string| number} key - Specifies the PrimaryKey value of dataSource.
1515
+ * @param {string } field - Specifies the field name which you want to update.
1516
+ * @param {string | number | boolean | Date} value - To update new value for the particular cell.
1517
+ * @returns {void}
1518
+ */
1519
+ setCellValue(key: string | number, field: string, value: string | number | boolean | Date): void;
1520
+ /**
1521
+ * Updates and refresh the particular row values based on the given primary key value.
1522
+ * > Primary key column must be specified using `columns.isPrimaryKey` property.
1523
+ *
1524
+ * @param {string| number} key - Specifies the PrimaryKey value of dataSource.
1525
+ * @param {Object} rowData - To update new data for the particular row.
1526
+ * @returns {void}
1527
+ */
1528
+ setRowData(key: string | number, rowData?: ITreeData): void;
1529
+ /**
1530
+ * Navigates to the specified target page.
1531
+ *
1532
+ * @param {number} pageNo - Defines the page number to navigate.
1533
+ * @returns {void}
1534
+ */
1535
+ goToPage(pageNo: number): void;
1536
+ /**
1537
+ * Defines the text of external message.
1538
+ *
1539
+ * @param {string} message - Defines the message to update.
1540
+ * @returns {void}
1541
+ */
1542
+ updateExternalMessage(message: string): void;
1543
+ /**
1544
+ * Gets a cell by row and column index.
1545
+ *
1546
+ * @param {number} rowIndex - Specifies the row index.
1547
+ * @param {number} columnIndex - Specifies the column index.
1548
+ * @returns {Element} - Returns cell element in grid content
1549
+ */
1550
+ getCellFromIndex(rowIndex: number, columnIndex: number): Element;
1551
+ /**
1552
+ * Gets a Column by column name.
1553
+ *
1554
+ * @param {string} field - Specifies the column name.
1555
+ * @returns {Column} - Returns tree grid column
1556
+ */
1557
+ getColumnByField(field: string): Column;
1558
+ /**
1559
+ * Gets a column by UID.
1560
+ *
1561
+ * @param {string} uid - Specifies the column UID.
1562
+ * @returns {Column} - Returns tree grid column
1563
+ */
1564
+ getColumnByUid(uid: string): Column;
1565
+ /**
1566
+ * Gets the collection of column fields.
1567
+ *
1568
+ * @returns {string[]} - Returns column field name as collection
1569
+ */
1570
+ getColumnFieldNames(): string[];
1571
+ /**
1572
+ * Gets the footer div of the TreeGrid.
1573
+ *
1574
+ * @returns {Element} - Returns footer content div element
1575
+ */
1576
+ getFooterContent(): Element;
1577
+ /**
1578
+ * Gets the footer table element of the TreeGrid.
1579
+ *
1580
+ * @returns {Element} - Returns footer content table element
1581
+ */
1582
+ getFooterContentTable(): Element;
1583
+ /**
1584
+ * Shows a column by its column name.
1585
+ *
1586
+ * @param {string|string[]} keys - Defines a single or collection of column names.
1587
+ * @param {string} showBy - Defines the column key either as field name or header text.
1588
+ * @returns {void}
1589
+ */
1590
+ showColumns(keys: string | string[], showBy?: string): void;
1591
+ /**
1592
+ * Hides a column by column name.
1593
+ *
1594
+ * @param {string|string[]} keys - Defines a single or collection of column names.
1595
+ * @param {string} hideBy - Defines the column key either as field name or header text.
1596
+ * @returns {void}
1597
+ */
1598
+ hideColumns(keys: string | string[], hideBy?: string): void;
1599
+ /**
1600
+ * Gets a column header by column name.
1601
+ *
1602
+ * @param {string} field - Specifies the column name.
1603
+ * @returns {Element} - Returns column header element
1604
+ */
1605
+ getColumnHeaderByField(field: string): Element;
1606
+ /**
1607
+ * Gets a column header by column index.
1608
+ *
1609
+ * @param {number} index - Specifies the column index.
1610
+ * @returns {Element} - Returns column header element
1611
+ */
1612
+ getColumnHeaderByIndex(index: number): Element;
1613
+ /**
1614
+ * Gets a column header by UID.
1615
+ *
1616
+ * @param {string} uid - Specifies the column uid.
1617
+ * @returns {Element} - Returns column header element
1618
+ */
1619
+ getColumnHeaderByUid(uid: string): Element;
1620
+ /**
1621
+ * Gets a column index by column name.
1622
+ *
1623
+ * @param {string} field - Specifies the column name.
1624
+ * @returns {number} - Returns column index
1625
+ */
1626
+ getColumnIndexByField(field: string): number;
1627
+ private getVirtualColIndexByUid;
1628
+ /**
1629
+ * Gets a column index by UID.
1630
+ *
1631
+ * @param {string} uid - Specifies the column UID.
1632
+ * @returns {number} - Returns column index
1633
+ */
1634
+ getColumnIndexByUid(uid: string): number;
1635
+ /**
1636
+ * Gets the columns from the TreeGrid.
1637
+ *
1638
+ * @param {boolean} isRefresh - Defined whether to update DOM
1639
+ * @returns {Column[]} - Returns treegrid columns collection
1640
+ */
1641
+ getColumns(isRefresh?: boolean): Column[];
1642
+ private updateColumnModel;
1643
+ private updateColumnsWidth;
1644
+ /**
1645
+ * Gets the content div of the TreeGrid.
1646
+ *
1647
+ * @returns {Element} - Return tree grid content element
1648
+ */
1649
+ getContent(): Element;
1650
+ private mergePersistTreeGridData;
1651
+ private mergeColumns;
1652
+ private setFrozenCount;
1653
+ private splitFrozenCount;
1654
+ private isFrozenGrid;
1655
+ private updateTreeGridModel;
1656
+ /**
1657
+ * Gets the content table of the TreeGrid.
1658
+ *
1659
+ * @returns {Element} - Returns content table element
1660
+ */
1661
+ getContentTable(): Element;
1662
+ /**
1663
+ * Gets all the TreeGrid's data rows.
1664
+ *
1665
+ * @returns {Element[]} - Returns row elements
1666
+ */
1667
+ getDataRows(): Element[];
1668
+ /**
1669
+ * Get current visible data of TreeGrid.
1670
+ *
1671
+ * @returns {Object[]} - Returns current view records
1672
+ * @isGenericType true
1673
+ */
1674
+ getCurrentViewRecords(): Object[];
1675
+ /**
1676
+ * Gets the added, edited,and deleted data before bulk save to the DataSource in batch mode.
1677
+ *
1678
+ * @returns {Object} - Returns batch changes
1679
+ */
1680
+ getBatchChanges(): Object;
1681
+ /**
1682
+ * Gets the header div of the TreeGrid.
1683
+ *
1684
+ * @returns {Element} - Returns Header content element
1685
+ */
1686
+ getHeaderContent(): Element;
1687
+ /**
1688
+ * Gets the header table element of the TreeGrid.
1689
+ *
1690
+ * @returns {Element} - Return header table element
1691
+ */
1692
+ getHeaderTable(): Element;
1693
+ /**
1694
+ * Gets a row by index.
1695
+ *
1696
+ * @param {number} index - Specifies the row index.
1697
+ * @returns {Element} - Returns row element
1698
+ */
1699
+ getRowByIndex(index: number): Element;
1700
+ /**
1701
+ * Get a row information based on cell
1702
+ *
1703
+ * @param {Element | EventTarget} target - Target row element
1704
+ * @returns {RowInfo} - Returns row information in a JSON object
1705
+ */
1706
+ getRowInfo(target: Element | EventTarget): RowInfo;
1707
+ /**
1708
+ * Gets UID by column name.
1709
+ *
1710
+ * @param {string} field - Specifies the column name.
1711
+ * @returns {string} - Returns unique id based on column field name given
1712
+ */
1713
+ getUidByColumnField(field: string): string;
1714
+ /**
1715
+ * Gets the visible columns from the TreeGrid.
1716
+ *
1717
+ * @returns {Column[]} - Returns visible columns collection
1718
+ */
1719
+ getVisibleColumns(): Column[];
1720
+ /**
1721
+ * By default, TreeGrid shows the spinner for all its actions. You can use this method to show spinner at your needed time.
1722
+ *
1723
+ * @returns {void}
1724
+ */
1725
+ showSpinner(): void;
1726
+ /**
1727
+ * Manually shown spinner needs to hide by `hideSpinnner`.
1728
+ *
1729
+ * @returns {void}
1730
+ */
1731
+ hideSpinner(): void;
1732
+ /**
1733
+ * Refreshes the TreeGrid header and content.
1734
+ *
1735
+ * @returns {void}
1736
+ */
1737
+ refresh(): void;
1738
+ /**
1739
+ * Get the records of checked rows.
1740
+ *
1741
+ * @returns {Object[]} - Returns records that has been checked
1742
+ * @isGenericType true
1743
+ */
1744
+ getCheckedRecords(): Object[];
1745
+ /**
1746
+ * Get the visible records corresponding to rows visually displayed.
1747
+ *
1748
+ * @returns {Object[]} - Returns visible records based on collapse state of rows
1749
+ * @isGenericType true
1750
+ */
1751
+ getVisibleRecords(): Object[];
1752
+ /**
1753
+ * Get the indexes of checked rows.
1754
+ *
1755
+ * @returns {number[]} - Returns checked row indexes
1756
+ */
1757
+ getCheckedRowIndexes(): number[];
1758
+ /**
1759
+ * Checked the checkboxes using rowIndexes.
1760
+ *
1761
+ * @param {number[]} indexes - row indexes
1762
+ * @returns {void}
1763
+ */
1764
+ selectCheckboxes(indexes: number[]): void;
1765
+ /**
1766
+ * Refreshes the TreeGrid column changes.
1767
+ *
1768
+ * @param {boolean} refreshUI - Defined whether to refresh the DOM
1769
+ * @returns {void}
1770
+ */
1771
+ refreshColumns(refreshUI?: boolean): void;
1772
+ /**
1773
+ * Refreshes the TreeGrid header.
1774
+ *
1775
+ * @returns {void}
1776
+ */
1777
+ refreshHeader(): void;
1778
+ /**
1779
+ * Expands or collapse child records
1780
+ *
1781
+ * @param {HTMLElement} target - Expand collapse icon cell as target element
1782
+ * @returns {void}
1783
+ * @hidden
1784
+ */
1785
+ private expandCollapseRequest;
1786
+ /**
1787
+ * Expands child rows
1788
+ *
1789
+ * @param {HTMLTableRowElement} row - Expands the given row
1790
+ * @param {Object} record - Expands the given record
1791
+ * @param {Object} key - Primary key value
1792
+ * @param {number} level - Specifies the hierarchical level of the record
1793
+ * @returns {void}
1794
+ */
1795
+ expandRow(row: HTMLTableRowElement, record?: Object, key?: Object, level?: number): void;
1796
+ private expandRows;
1797
+ private expandCollapseAllChildren;
1798
+ private getCollapseExpandRecords;
1799
+ /**
1800
+ * Collapses child rows
1801
+ *
1802
+ * @param {HTMLTableRowElement} row - Collapse the given row
1803
+ * @param {Object} record - Collapse the given record
1804
+ * @param {Object} key - Primary key value
1805
+ * @returns {void}
1806
+ */
1807
+ collapseRow(row: HTMLTableRowElement, record?: Object, key?: Object): void;
1808
+ private collapseRows;
1809
+ private updateExpandStateMapping;
1810
+ /**
1811
+ * Expands the records at specific hierarchical level
1812
+ *
1813
+ * @param {number} level - Expands the parent rows at given level
1814
+ * @returns {void}
1815
+ */
1816
+ expandAtLevel(level: number): void;
1817
+ /**
1818
+ * Expands the records by given primary key value
1819
+ *
1820
+ * @param {Object} key - Expands the parent rows with given primary key value
1821
+ * @returns {void}
1822
+ */
1823
+ expandByKey(key: Object): void;
1824
+ private expandAction;
1825
+ private getRecordDetails;
1826
+ /**
1827
+ * Collapses the records at specific hierarchical level
1828
+ *
1829
+ * @param {number} level - Define the parent row level which needs to be collapsed
1830
+ * @returns {void}
1831
+ */
1832
+ collapseAtLevel(level: number): void;
1833
+ /**
1834
+ * Collapses the records by given primary key value
1835
+ *
1836
+ * @param {Object} key - Collapses the parent rows with given primary key value
1837
+ * @returns {void}
1838
+ */
1839
+ collapseByKey(key: Object): void;
1840
+ private expandCollapseActionByKey;
1841
+ private collapseAction;
1842
+ /**
1843
+ * Expands All the rows
1844
+ *
1845
+ * @returns {void}
1846
+ */
1847
+ expandAll(): void;
1848
+ /**
1849
+ * Collapses All the rows
1850
+ *
1851
+ * @returns {void}
1852
+ */
1853
+ collapseAll(): void;
1854
+ private expandCollapseAll;
1855
+ private expandCollapse;
1856
+ private updateChildOnDemand;
1857
+ private remoteExpand;
1858
+ private localExpand;
1859
+ private updateAltRow;
1860
+ private treeColumnRowTemplate;
1861
+ private collapseRemoteChild;
1862
+ /**
1863
+ * Method to sanitize html element
1864
+ *
1865
+ * @param {any} value - Specifies the html value to sanitize
1866
+ * @returns {any} Returns the sanitized html value
1867
+ * @hidden
1868
+ */
1869
+ private sanitize;
1870
+ /**
1871
+ * Updates the rows and cells
1872
+ *
1873
+ * @param {Object[]} records - Updates the given records
1874
+ * @param {HTMLTableRowElement[]} rows - Updates the given rows
1875
+ * @param {number} index - Updates the given cell index
1876
+ * @returns {void}
1877
+ */
1878
+ private updateRowAndCellElements;
1879
+ /**
1880
+ * @hidden
1881
+ * @returns {void}
1882
+ */
1883
+ addListener(): void;
1884
+ private updateResultModel;
1885
+ /**
1886
+ * @hidden
1887
+ * @returns {void}
1888
+ */
1889
+ private removeListener;
1890
+ /**
1891
+ * Filters TreeGrid row by column name with the given options.
1892
+ *
1893
+ * @param {string} fieldName - Defines the field name of the column.
1894
+ * @param {string} filterOperator - Defines the operator to filter records.
1895
+ * @param {string | number | Date | boolean} filterValue - Defines the value used to filter records.
1896
+ * @param {string} predicate - Defines the relationship between one filter query and another by using AND or OR predicate.
1897
+ * @param {boolean} matchCase - If match case is set to true, the TreeGrid filters the records with exact match. if false, it filters
1898
+ * case insensitive records (uppercase and lowercase letters are treated the same).
1899
+ * @param {boolean} ignoreAccent - If ignoreAccent is set to true,
1900
+ * then filter ignores diacritic characters or accents while filtering.
1901
+ * @param {string} actualFilterValue - Defines the actual filter value for filter column.
1902
+ * @param {string} actualOperator - Defines the actual filter operator for filter column.
1903
+ * @returns {void}
1904
+ */
1905
+ filterByColumn(fieldName: string, filterOperator: string, filterValue: string | number | Date | boolean | number[] | string[] | Date[] | boolean[], predicate?: string, matchCase?: boolean, ignoreAccent?: boolean, actualFilterValue?: string, actualOperator?: string): void;
1906
+ /**
1907
+ * Clears all the filtered rows of the TreeGrid.
1908
+ *
1909
+ * @returns {void}
1910
+ */
1911
+ clearFiltering(): void;
1912
+ /**
1913
+ * Removes filtered column by field name.
1914
+ *
1915
+ * @param {string} field - Defines column field name to remove filter.
1916
+ * @param {boolean} isClearFilterBar - Specifies whether the filter bar value needs to be cleared.
1917
+ * @returns {void}
1918
+ * @hidden
1919
+ */
1920
+ removeFilteredColsByField(field: string, isClearFilterBar?: boolean): void;
1921
+ /**
1922
+ * Selects a row by given index.
1923
+ *
1924
+ * @param {number} index - Defines the row index.
1925
+ * @param {boolean} isToggle - If set to true, then it toggles the selection.
1926
+ * @returns {void}
1927
+ */
1928
+ selectRow(index: number, isToggle?: boolean): void;
1929
+ /**
1930
+ * Selects a collection of rows by indexes.
1931
+ *
1932
+ * @param {number[]} rowIndexes - Specifies the row indexes.
1933
+ * @returns {void}
1934
+ */
1935
+ selectRows(rowIndexes: number[]): void;
1936
+ /**
1937
+ * Deselects the current selected rows and cells.
1938
+ *
1939
+ * @returns {void}
1940
+ */
1941
+ clearSelection(): void;
1942
+ /**
1943
+ * Copy the selected rows or cells data into clipboard.
1944
+ *
1945
+ * @param {boolean} withHeader - Specifies whether the column header text needs to be copied along with rows or cells.
1946
+ * @returns {void}
1947
+ */
1948
+ copy(withHeader?: boolean): void;
1949
+ /**
1950
+ * Paste data from clipboard to selected cells.
1951
+ *
1952
+ * @param {boolean} data - Specifies the date for paste.
1953
+ * @param {boolean} rowIndex - Specifies the row index.
1954
+ * @param {boolean} colIndex - Specifies the column index.
1955
+ * @returns {void}
1956
+ */
1957
+ paste(data: string, rowIndex: number, colIndex: number): void;
1958
+ /**
1959
+ * Selects a cell by the given index.
1960
+ *
1961
+ * @param {IIndex} cellIndex - Defines the row and column indexes.
1962
+ * @param {boolean} isToggle - If set to true, then it toggles the selection.
1963
+ * @returns {void}
1964
+ */
1965
+ selectCell(cellIndex: IIndex, isToggle?: boolean): void;
1966
+ /**
1967
+ * Gets the collection of selected rows.
1968
+ *
1969
+ * @returns {Element[]} - Returns selected row elements collection
1970
+ */
1971
+ getSelectedRows(): Element[];
1972
+ /**
1973
+ * Gets a movable table cell by row and column index.
1974
+ *
1975
+ * @param {number} rowIndex - Specifies the row index.
1976
+ * @param {number} columnIndex - Specifies the column index.
1977
+ * @returns {Element} - Returns movable cell element from the indexes passed
1978
+ *
1979
+ * @deprecated This method is deprecated. Use getCellFromIndex method instead.
1980
+ */
1981
+ getMovableCellFromIndex(rowIndex: number, columnIndex: number): Element;
1982
+ /**
1983
+ * Gets all the TreeGrid's movable table data rows.
1984
+ *
1985
+ * @returns {Element[]} - Returns element collection of movable rows
1986
+ *
1987
+ * @deprecated This method is deprecated. Use getDataRows method instead.
1988
+ */
1989
+ getMovableDataRows(): Element[];
1990
+ /**
1991
+ * Gets a movable tables row by index.
1992
+ *
1993
+ * @param {number} index - Specifies the row index.
1994
+ * @returns {Element} - Returns movable row based on index passed
1995
+ *
1996
+ * @deprecated This method is deprecated. Use getRowByIndex method instead.
1997
+ */
1998
+ getMovableRowByIndex(index: number): Element;
1999
+ /**
2000
+ * Gets the TreeGrid's movable content rows from frozen treegrid.
2001
+ *
2002
+ * @returns {Element[]}: Returns movable row element
2003
+ * @deprecated This method is deprecated. Use getRows method instead.
2004
+ */
2005
+ getMovableRows(): Element[];
2006
+ /**
2007
+ * Gets a frozen right tables row element by index.
2008
+ *
2009
+ * @param {number} index - Specifies the row index.
2010
+ * @returns {Element} returns the element
2011
+ *
2012
+ * @deprecated This method is deprecated. Use getRowByIndex method instead.
2013
+ */
2014
+ getFrozenRightRowByIndex(index: number): Element;
2015
+ /**
2016
+ * Gets the Tree Grid's frozen right content rows from frozen Tree Grid.
2017
+ *
2018
+ * @returns {Element[]} returns the element
2019
+ *
2020
+ * @deprecated This method is deprecated. Use getRows method instead.
2021
+ */
2022
+ getFrozenRightRows(): Element[];
2023
+ /**
2024
+ * Gets all the Tree Grid's frozen right table data rows.
2025
+ *
2026
+ * @returns {Element[]} Returns the Element
2027
+ *
2028
+ * @deprecated This method is deprecated. Use getDataRows method instead.
2029
+ */
2030
+ getFrozenRightDataRows(): Element[];
2031
+ /**
2032
+ * Gets a frozen right table cell by row and column index.
2033
+ *
2034
+ * @param {number} rowIndex - Specifies the row index.
2035
+ * @param {number} columnIndex - Specifies the column index.
2036
+ * @returns {Element} Returns the Element
2037
+ *
2038
+ * @deprecated This method is deprecated. Use getCellFromIndex method instead.
2039
+ */
2040
+ getFrozenRightCellFromIndex(rowIndex: number, columnIndex: number): Element;
2041
+ /**
2042
+ * Gets a frozen left column header by column index.
2043
+ *
2044
+ * @param {number} index - Specifies the column index.
2045
+ * @returns {Element} Returns the Element
2046
+ *
2047
+ * @deprecated This method is deprecated. Use getColumnHeaderByIndex method instead.
2048
+ */
2049
+ getFrozenLeftColumnHeaderByIndex(index: number): Element;
2050
+ /**
2051
+ * Gets a frozen right column header by column index.
2052
+ *
2053
+ * @param {number} index - Specifies the column index.
2054
+ * @returns {Element} Returns the Element
2055
+ *
2056
+ * @deprecated This method is deprecated. Use getColumnHeaderByIndex method instead.
2057
+ */
2058
+ getFrozenRightColumnHeaderByIndex(index: number): Element;
2059
+ /**
2060
+ * Gets a movable column header by column index.
2061
+ *
2062
+ * @param {number} index - Specifies the column index.
2063
+ * @returns {Element} Returns the Element
2064
+ *
2065
+ * @deprecated This method is deprecated. Use getColumnHeaderByIndex method instead.
2066
+ */
2067
+ getMovableColumnHeaderByIndex(index: number): Element;
2068
+ /**
2069
+ * @hidden
2070
+ * @returns {number} Returns the movable column count
2071
+ */
2072
+ getMovableColumnsCount(): number;
2073
+ /**
2074
+ * @hidden
2075
+ * @returns {number} Returns the Frozen Left column
2076
+ */
2077
+ getFrozenLeftColumnsCount(): number;
2078
+ /**
2079
+ * @hidden
2080
+ * @returns {number} Returns the Frozen Right column count
2081
+ */
2082
+ getFrozenRightColumnsCount(): number;
2083
+ /**
2084
+ * @hidden
2085
+ * @returns {Column[]} Returns the column
2086
+ */
2087
+ getFrozenLeftColumns(): Column[];
2088
+ /**
2089
+ * @hidden
2090
+ * @returns {Column[]} Returns the column
2091
+ */
2092
+ getFrozenRightColumns(): Column[];
2093
+ /**
2094
+ * @hidden
2095
+ * @returns {number} Returns the visible movable count
2096
+ */
2097
+ getVisibleMovableCount(): number;
2098
+ /**
2099
+ * @hidden
2100
+ * @returns {number} Returns the visible Frozen Right count
2101
+ */
2102
+ getVisibleFrozenRightCount(): number;
2103
+ /**
2104
+ * @hidden
2105
+ * @returns {number} Returns the visible Frozen left count
2106
+ */
2107
+ getVisibleFrozenLeftCount(): number;
2108
+ /**
2109
+ * @hidden
2110
+ * @returns {Column[]} Returns the column
2111
+ */
2112
+ getMovableColumns(): Column[];
2113
+ /**
2114
+ * Gets the number of frozen column in tree grid
2115
+ *
2116
+ * @hidden
2117
+ * @returns {number} - Returns frozen column count
2118
+ */
2119
+ getFrozenColumns(): number;
2120
+ private getFrozenCount;
2121
+ /**
2122
+ * Gets the collection of selected row indexes.
2123
+ *
2124
+ * @returns {number[]} - Returns selected rows index collection
2125
+ */
2126
+ getSelectedRowIndexes(): number[];
2127
+ /**
2128
+ * Gets the collection of selected row and cell indexes.
2129
+ *
2130
+ * @returns {ISelectedCell[]} - Returns selected cell's index details
2131
+ */
2132
+ getSelectedRowCellIndexes(): ISelectedCell[];
2133
+ /**
2134
+ * Gets the collection of selected records.
2135
+ *
2136
+ * @isGenericType true
2137
+ * @returns {Object[]} - Returns selected records collection
2138
+ */
2139
+ getSelectedRecords(): Object[];
2140
+ /**
2141
+ * Gets the data module.
2142
+ *
2143
+ * @returns {{baseModule: Data, treeModule: DataManipulation}}: Returns grid and treegrid data module
2144
+ */
2145
+ getDataModule(): {
2146
+ baseModule: Data;
2147
+ treeModule: DataManipulation;
2148
+ };
2149
+ /**
2150
+ * Reorder the rows based on given indexes and position
2151
+ *
2152
+ * @param {number[]} fromIndexes - Source indexes of rows
2153
+ * @param {number} toIndex - Destination index of row
2154
+ * @param {string} position - Defines drop position as above or below or child
2155
+ * @returns {void}
2156
+ */
2157
+ reorderRows(fromIndexes: number[], toIndex: number, position: string): void;
2158
+ /**
2159
+ * Indents the record to one level of hierarchy. Moves the selected row as the last child of its previous row.
2160
+ *
2161
+ * @param {Object} record – specifies the record to do indented
2162
+ * @returns {void}
2163
+ */
2164
+ indent(record?: Object): void;
2165
+ /**
2166
+ * Outdent the record to one level of hierarchy. Moves the selected row as sibling to its parent row.
2167
+ *
2168
+ * @param {Object} record – specifies the record to do outdented
2169
+ * @returns {void}
2170
+ */
2171
+ outdent(record?: Object): void;
2172
+ /**
2173
+ * `columnchooserModule` is used to dynamically show or hide the TreeGrid columns.
2174
+ *
2175
+ * @hidden
2176
+ */
2177
+ columnChooserModule: ColumnChooser;
2178
+ /**
2179
+ * The `toolbarModule` is used to manipulate ToolBar items and its action in the TreeGrid.
2180
+ */
2181
+ toolbarModule: Toolbar;
2182
+ /**
2183
+ * The `editModule` is used to handle TreeGrid content manipulation.
2184
+ */
2185
+ editModule: Edit;
2186
+ /**
2187
+ * The `pagerModule` is used to manipulate paging in the TreeGrid.
2188
+ */
2189
+ pagerModule: Page;
2190
+ }