@syncfusion/ej2-treegrid 31.1.17 → 31.1.21

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 (136) hide show
  1. package/dist/ej2-treegrid.min.js +2 -2
  2. package/dist/ej2-treegrid.umd.min.js +2 -2
  3. package/dist/ej2-treegrid.umd.min.js.map +1 -1
  4. package/dist/es6/ej2-treegrid.es2015.js +13 -4
  5. package/dist/es6/ej2-treegrid.es2015.js.map +1 -1
  6. package/dist/es6/ej2-treegrid.es5.js +13 -4
  7. package/dist/es6/ej2-treegrid.es5.js.map +1 -1
  8. package/dist/global/ej2-treegrid.min.js +2 -2
  9. package/dist/global/ej2-treegrid.min.js.map +1 -1
  10. package/dist/global/index.d.ts +1 -1
  11. package/package.json +14 -50
  12. package/src/treegrid/actions/edit.js +1 -1
  13. package/src/treegrid/actions/rowdragdrop.js +12 -3
  14. package/styles/bootstrap4-lite.css +8 -0
  15. package/styles/bootstrap4.css +8 -0
  16. package/styles/treegrid/bootstrap4.css +8 -0
  17. package/dist/ts/index.d.ts +0 -4
  18. package/dist/ts/index.ts +0 -4
  19. package/dist/ts/treegrid/actions/batch-edit.d.ts +0 -74
  20. package/dist/ts/treegrid/actions/batch-edit.ts +0 -627
  21. package/dist/ts/treegrid/actions/clipboard.d.ts +0 -36
  22. package/dist/ts/treegrid/actions/clipboard.ts +0 -174
  23. package/dist/ts/treegrid/actions/column-chooser.d.ts +0 -37
  24. package/dist/ts/treegrid/actions/column-chooser.ts +0 -55
  25. package/dist/ts/treegrid/actions/column-menu.d.ts +0 -24
  26. package/dist/ts/treegrid/actions/column-menu.ts +0 -39
  27. package/dist/ts/treegrid/actions/command-column.d.ts +0 -24
  28. package/dist/ts/treegrid/actions/command-column.ts +0 -32
  29. package/dist/ts/treegrid/actions/context-menu.d.ts +0 -42
  30. package/dist/ts/treegrid/actions/context-menu.ts +0 -149
  31. package/dist/ts/treegrid/actions/crud-actions.d.ts +0 -66
  32. package/dist/ts/treegrid/actions/crud-actions.ts +0 -388
  33. package/dist/ts/treegrid/actions/detail-row.d.ts +0 -39
  34. package/dist/ts/treegrid/actions/detail-row.ts +0 -124
  35. package/dist/ts/treegrid/actions/edit.d.ts +0 -121
  36. package/dist/ts/treegrid/actions/edit.ts +0 -1083
  37. package/dist/ts/treegrid/actions/excel-export.d.ts +0 -67
  38. package/dist/ts/treegrid/actions/excel-export.ts +0 -240
  39. package/dist/ts/treegrid/actions/filter.d.ts +0 -57
  40. package/dist/ts/treegrid/actions/filter.ts +0 -231
  41. package/dist/ts/treegrid/actions/freeze-column.d.ts +0 -28
  42. package/dist/ts/treegrid/actions/freeze-column.ts +0 -119
  43. package/dist/ts/treegrid/actions/index.d.ts +0 -24
  44. package/dist/ts/treegrid/actions/index.ts +0 -24
  45. package/dist/ts/treegrid/actions/infinite-scroll.d.ts +0 -96
  46. package/dist/ts/treegrid/actions/infinite-scroll.ts +0 -320
  47. package/dist/ts/treegrid/actions/logger.d.ts +0 -25
  48. package/dist/ts/treegrid/actions/logger.ts +0 -136
  49. package/dist/ts/treegrid/actions/page.d.ts +0 -67
  50. package/dist/ts/treegrid/actions/page.ts +0 -212
  51. package/dist/ts/treegrid/actions/pdf-export.d.ts +0 -63
  52. package/dist/ts/treegrid/actions/pdf-export.ts +0 -182
  53. package/dist/ts/treegrid/actions/print.d.ts +0 -37
  54. package/dist/ts/treegrid/actions/print.ts +0 -69
  55. package/dist/ts/treegrid/actions/reorder.d.ts +0 -36
  56. package/dist/ts/treegrid/actions/reorder.ts +0 -60
  57. package/dist/ts/treegrid/actions/resize.d.ts +0 -36
  58. package/dist/ts/treegrid/actions/resize.ts +0 -54
  59. package/dist/ts/treegrid/actions/rowdragdrop.d.ts +0 -405
  60. package/dist/ts/treegrid/actions/rowdragdrop.ts +0 -1896
  61. package/dist/ts/treegrid/actions/selection.d.ts +0 -51
  62. package/dist/ts/treegrid/actions/selection.ts +0 -530
  63. package/dist/ts/treegrid/actions/sort.d.ts +0 -63
  64. package/dist/ts/treegrid/actions/sort.ts +0 -149
  65. package/dist/ts/treegrid/actions/summary.d.ts +0 -47
  66. package/dist/ts/treegrid/actions/summary.ts +0 -231
  67. package/dist/ts/treegrid/actions/toolbar.d.ts +0 -52
  68. package/dist/ts/treegrid/actions/toolbar.ts +0 -154
  69. package/dist/ts/treegrid/actions/virtual-scroll.d.ts +0 -90
  70. package/dist/ts/treegrid/actions/virtual-scroll.ts +0 -306
  71. package/dist/ts/treegrid/base/constant.d.ts +0 -158
  72. package/dist/ts/treegrid/base/constant.ts +0 -158
  73. package/dist/ts/treegrid/base/data.d.ts +0 -90
  74. package/dist/ts/treegrid/base/data.ts +0 -904
  75. package/dist/ts/treegrid/base/index.d.ts +0 -11
  76. package/dist/ts/treegrid/base/index.ts +0 -11
  77. package/dist/ts/treegrid/base/interface.d.ts +0 -186
  78. package/dist/ts/treegrid/base/interface.ts +0 -191
  79. package/dist/ts/treegrid/base/treegrid-model.d.ts +0 -1100
  80. package/dist/ts/treegrid/base/treegrid.d.ts +0 -2422
  81. package/dist/ts/treegrid/base/treegrid.ts +0 -5962
  82. package/dist/ts/treegrid/enum.d.ts +0 -152
  83. package/dist/ts/treegrid/enum.ts +0 -217
  84. package/dist/ts/treegrid/index.d.ts +0 -9
  85. package/dist/ts/treegrid/index.ts +0 -9
  86. package/dist/ts/treegrid/models/column-chooser-settings-model.d.ts +0 -62
  87. package/dist/ts/treegrid/models/column-chooser-settings.d.ts +0 -53
  88. package/dist/ts/treegrid/models/column-chooser-settings.ts +0 -67
  89. package/dist/ts/treegrid/models/column-model.d.ts +0 -30
  90. package/dist/ts/treegrid/models/column.d.ts +0 -697
  91. package/dist/ts/treegrid/models/column.ts +0 -800
  92. package/dist/ts/treegrid/models/edit-settings-model.d.ts +0 -100
  93. package/dist/ts/treegrid/models/edit-settings.d.ts +0 -89
  94. package/dist/ts/treegrid/models/edit-settings.ts +0 -111
  95. package/dist/ts/treegrid/models/filter-settings-model.d.ts +0 -216
  96. package/dist/ts/treegrid/models/filter-settings.d.ts +0 -195
  97. package/dist/ts/treegrid/models/filter-settings.ts +0 -237
  98. package/dist/ts/treegrid/models/index.d.ts +0 -24
  99. package/dist/ts/treegrid/models/index.ts +0 -24
  100. package/dist/ts/treegrid/models/infinite-scroll-settings-model.d.ts +0 -29
  101. package/dist/ts/treegrid/models/infinite-scroll-settings.d.ts +0 -25
  102. package/dist/ts/treegrid/models/infinite-scroll-settings.ts +0 -31
  103. package/dist/ts/treegrid/models/loading-indicator-model.d.ts +0 -21
  104. package/dist/ts/treegrid/models/loading-indicator.d.ts +0 -19
  105. package/dist/ts/treegrid/models/loading-indicator.ts +0 -21
  106. package/dist/ts/treegrid/models/page-settings-model.d.ts +0 -66
  107. package/dist/ts/treegrid/models/page-settings.d.ts +0 -57
  108. package/dist/ts/treegrid/models/page-settings.ts +0 -73
  109. package/dist/ts/treegrid/models/rowdrop-settings-model.d.ts +0 -15
  110. package/dist/ts/treegrid/models/rowdrop-settings.d.ts +0 -34
  111. package/dist/ts/treegrid/models/rowdrop-settings.ts +0 -37
  112. package/dist/ts/treegrid/models/search-settings-model.d.ts +0 -79
  113. package/dist/ts/treegrid/models/search-settings.d.ts +0 -73
  114. package/dist/ts/treegrid/models/search-settings.ts +0 -83
  115. package/dist/ts/treegrid/models/selection-settings-model.d.ts +0 -76
  116. package/dist/ts/treegrid/models/selection-settings.d.ts +0 -68
  117. package/dist/ts/treegrid/models/selection-settings.ts +0 -82
  118. package/dist/ts/treegrid/models/sort-settings-model.d.ts +0 -49
  119. package/dist/ts/treegrid/models/sort-settings.d.ts +0 -43
  120. package/dist/ts/treegrid/models/sort-settings.ts +0 -51
  121. package/dist/ts/treegrid/models/summary-model.d.ts +0 -93
  122. package/dist/ts/treegrid/models/summary.d.ts +0 -126
  123. package/dist/ts/treegrid/models/summary.ts +0 -170
  124. package/dist/ts/treegrid/models/textwrap-settings-model.d.ts +0 -21
  125. package/dist/ts/treegrid/models/textwrap-settings.d.ts +0 -19
  126. package/dist/ts/treegrid/models/textwrap-settings.ts +0 -21
  127. package/dist/ts/treegrid/renderer/index.d.ts +0 -5
  128. package/dist/ts/treegrid/renderer/index.ts +0 -5
  129. package/dist/ts/treegrid/renderer/render.d.ts +0 -41
  130. package/dist/ts/treegrid/renderer/render.ts +0 -379
  131. package/dist/ts/treegrid/renderer/virtual-row-model-generator.d.ts +0 -16
  132. package/dist/ts/treegrid/renderer/virtual-row-model-generator.ts +0 -90
  133. package/dist/ts/treegrid/renderer/virtual-tree-content-render.d.ts +0 -353
  134. package/dist/ts/treegrid/renderer/virtual-tree-content-render.ts +0 -1125
  135. package/dist/ts/treegrid/utils.d.ts +0 -70
  136. package/dist/ts/treegrid/utils.ts +0 -217
@@ -1,1100 +0,0 @@
1
- import { Component, addClass, createElement, EventHandler, isNullOrUndefined, ModuleDeclaration, extend, merge, SanitizeHtmlHelper} from '@syncfusion/ej2-base';import { removeClass, EmitType, Complex, Collection, KeyboardEventArgs, getValue, NumberFormatOptions, DateFormatOptions } from '@syncfusion/ej2-base';import {Event, Property, NotifyPropertyChanges, INotifyPropertyChanged, setValue, KeyboardEvents, L10n } from '@syncfusion/ej2-base';import { Column, ColumnModel } from '../models/column';import { BeforeBatchSaveArgs, BeforeBatchAddArgs, BatchDeleteArgs, BeforeBatchDeleteArgs, Row, getNumberFormat } from '@syncfusion/ej2-grids';import { GridModel, ColumnQueryModeType, HeaderCellInfoEventArgs, EditSettingsModel as GridEditModel, Freeze as FreezeColumn } from '@syncfusion/ej2-grids';import { RowDragEventArgs, RowDropEventArgs, RowDropSettingsModel, RowDropSettings, getUid, parentsUntil } from '@syncfusion/ej2-grids';import { LoadingIndicator } from '../models/loading-indicator';import { LoadingIndicatorModel } from '../models/loading-indicator-model';import { TextAlign } from'@syncfusion/ej2-grids';import { DetailDataBoundEventArgs, ClipMode, ColumnChooser} from '@syncfusion/ej2-grids';import { SearchEventArgs, AddEventArgs, EditEventArgs, DeleteEventArgs} from '@syncfusion/ej2-grids';import { SaveEventArgs, CellSaveArgs, BatchAddArgs, BatchCancelArgs, BeginEditArgs, CellEditArgs} from '@syncfusion/ej2-grids';import { FilterSettings } from '../models/filter-settings';import { TextWrapSettings } from '../models/textwrap-settings';import { TextWrapSettingsModel } from '../models/textwrap-settings-model';import {Filter} from '../actions/filter';import { Logger as TreeLogger } from '../actions/logger';import { BeforeCopyEventArgs, BeforePasteEventArgs } from '@syncfusion/ej2-grids';import { TreeClipboard } from '../actions/clipboard';import {Aggregate} from '../actions/summary';import { Reorder } from '../actions/reorder';import { Resize } from '../actions/resize';import { Selection as TreeGridSelection } from '../actions/selection';import { ColumnMenu } from '../actions/column-menu';import { DetailRow } from '../actions/detail-row';import { Freeze } from '../actions/freeze-column';import { Print } from '../actions/print';import * as events from '../base/constant';import { FilterSettingsModel } from '../models/filter-settings-model';import { SearchSettings} from '../models/search-settings';import { SearchSettingsModel } from '../models/search-settings-model';import {RowInfo, RowDataBoundEventArgs, PageEventArgs, FilterEventArgs, FailureEventArgs, SortEventArgs } from '@syncfusion/ej2-grids';import { RowSelectingEventArgs, RowSelectEventArgs, RowDeselectingEventArgs, RowDeselectEventArgs, IIndex, ISelectedCell } from '@syncfusion/ej2-grids';import {ColumnModel as GridColumnModel, Column as GridColumn, CellSelectEventArgs, CellDeselectEventArgs } from '@syncfusion/ej2-grids';import { SelectionSettings } from '../models/selection-settings';import { SelectionSettingsModel } from '../models/selection-settings-model';import {getActualProperties, SortDirection, getObject, ColumnDragEventArgs } from '@syncfusion/ej2-grids';import { PrintMode, Data, IGrid, ContextMenuItemModel } from '@syncfusion/ej2-grids';import { ColumnMenuItem, ColumnMenuItemModel, CheckBoxChangeEventArgs } from '@syncfusion/ej2-grids';import { ExcelExportCompleteArgs, ExcelHeaderQueryCellInfoEventArgs, ExcelQueryCellInfoEventArgs, AggregateQueryCellInfoEventArgs } from '@syncfusion/ej2-grids';import { PdfExportCompleteArgs, PdfHeaderQueryCellInfoEventArgs, PdfQueryCellInfoEventArgs } from '@syncfusion/ej2-grids';import { ExcelExportProperties, PdfExportProperties, CellSelectingEventArgs, PrintEventArgs } from '@syncfusion/ej2-grids';import { ColumnMenuOpenEventArgs } from '@syncfusion/ej2-grids';import {BeforeDataBoundArgs} from '@syncfusion/ej2-grids';import { DataManager, ReturnOption, RemoteSaveAdaptor, Query, JsonAdaptor, Deferred, UrlAdaptor } from '@syncfusion/ej2-data';import { createSpinner, hideSpinner, showSpinner, Dialog } from '@syncfusion/ej2-popups';import { isRemoteData, isOffline, extendArray, isCountRequired, findChildrenRecords } from '../utils';import { Grid, QueryCellInfoEventArgs, Logger } from '@syncfusion/ej2-grids';import { Render } from '../renderer/render';import { VirtualTreeContentRenderer } from '../renderer/virtual-tree-content-render';import { DataManipulation } from './data';import { RowDD } from '../actions/rowdragdrop';import { Sort } from '../actions/sort';import { ITreeData, RowExpandedEventArgs, RowCollapsedEventArgs, RowCollapsingEventArgs, TreeGridExcelExportProperties, ActionEventArgs } from './interface';import { DataStateChangeEventArgs, RowExpandingEventArgs, TreeGridPdfExportProperties } from './interface';import { iterateArrayOrObject, GridLine } from '@syncfusion/ej2-grids';import { DataSourceChangedEventArgs, RecordDoubleClickEventArgs, ResizeArgs } from '@syncfusion/ej2-grids';import { ToolbarItems, ToolbarItem, ContextMenuItem, ContextMenuItems, RowPosition, CopyHierarchyType } from '../enum';import { ItemModel, ClickEventArgs, BeforeOpenCloseMenuEventArgs, MenuEventArgs } from '@syncfusion/ej2-navigations';import { PageSettings } from '../models/page-settings';import { PageSettingsModel } from '../models/page-settings-model';import { AggregateRow } from '../models/summary';import { AggregateRowModel } from '../models/summary-model';import { ExcelExport } from '../actions/excel-export';import { PdfExport } from '../actions/pdf-export';import { Toolbar } from '../actions/toolbar';import { Page } from '../actions/page';import { ContextMenu } from '../actions/context-menu';import { EditSettings } from '../models/edit-settings';import { EditSettingsModel } from '../models/edit-settings-model';import { Edit} from '../actions/edit';import { SortSettings } from '../models/sort-settings';import { SortSettingsModel } from '../models/sort-settings-model';import { isHidden, getExpandStatus } from '../utils';import { editAction } from '../actions/crud-actions';import { InfiniteScrollSettings } from '../models/infinite-scroll-settings';import { InfiniteScrollSettingsModel } from '../models/infinite-scroll-settings-model';import { TreeActionEventArgs } from '..';import * as literals from '../base/constant';import { ColumnChooserSettings } from '../models/column-chooser-settings';import { ColumnChooserSettingsModel } from '../models/column-chooser-settings-model';
2
- import {ComponentModel} from '@syncfusion/ej2-base';
3
-
4
- /**
5
- * Interface for a class TreeGrid
6
- */
7
- export interface TreeGridModel extends ComponentModel{
8
-
9
- /**
10
- * Specifies the number of rows that should remain visible and fixed at the top of the TreeGrid during scrolling.
11
- *
12
- * This feature helps improve readability in data-heavy grids by keeping the header rows or key rows visible.
13
- *
14
- * @default 0
15
- */
16
- frozenRows?: number;
17
-
18
- /**
19
- * Specifies the number of columns that should remain visible and fixed on the left side of the TreeGrid during horizontal scrolling.
20
- *
21
- * This feature ensures key columns, such as identifiers, stay visible while users scroll through data.
22
- *
23
- * @default 0
24
- */
25
- frozenColumns?: number;
26
-
27
- /**
28
- * Defines the options for printing the TreeGrid.
29
- * The available print modes are:
30
- * * `AllPages`: Prints all pages of the TreeGrid.
31
- * * `CurrentPage`: Prints only the current page of the TreeGrid.
32
- *
33
- * @default Syncfusion.EJ2.Grids.ClipMode.Ellipsis
34
- * @aspType Syncfusion.EJ2.Grids.ClipMode
35
- * @isEnumeration true
36
- */
37
- clipMode?: ClipMode;
38
-
39
- /**
40
- * Defines the schema of dataSource.
41
- * If the `columns` declaration is empty or undefined then the `columns` are automatically generated from data source.
42
- * {% codeBlock src='treegrid/columns/index.md' %}{% endcodeBlock %}   
43
- *
44
- * @default []
45
- */
46
- columns?: ColumnModel[] | string[] | Column[];
47
-
48
- /**
49
- * Specifies the mapping property path for child records in data source
50
- * {% codeBlock src='treegrid/childMapping/index.md' %}{% endcodeBlock %}
51
- *
52
- * @default null
53
- */
54
- childMapping?: string;
55
-
56
- /**
57
- * Specifies whether record is parent or not for the remote data binding
58
- *
59
- * @default null
60
- */
61
- hasChildMapping?: string;
62
-
63
- /**
64
- * Specifies the index of the column that needs to have the expander button.
65
- *
66
- * @default 0
67
- */
68
- treeColumnIndex?: number;
69
-
70
- /**
71
- * Specifies the name of the field in the dataSource, which contains the id of that row.
72
- * {% codeBlock src='treegrid/idMapping/index.md' %}{% endcodeBlock %}
73
- *
74
- * @default null
75
- */
76
- idMapping?: string;
77
-
78
- /**
79
- * Specifies the name of the field in the dataSource, which contains the parent’s id
80
- * {% codeBlock src='treegrid/parentIdMapping/index.md' %}{% endcodeBlock %}
81
- *
82
- * @default null
83
- */
84
- parentIdMapping?: string;
85
-
86
- /**
87
- * Specifies whether to load all rows in a collapsed state when the TreeGrid is initially rendered.
88
- *
89
- * This setting is particularly useful when dealing with large datasets, as it helps enhance loading performance by
90
- * reducing initial data rendering.
91
- *
92
- * @default false
93
- */
94
- enableCollapseAll?: boolean;
95
-
96
- /**
97
- * Specifies the mapping property path for the expand status of a record in data source.
98
- *
99
- * @default null
100
- */
101
- expandStateMapping?: string;
102
-
103
- /**
104
- * If `allowRowDragAndDrop` is set to true, row reordering functionality is enabled, allowing rows to be dragged
105
- * and dropped within the TreeGrid or across TreeGrids.
106
- *
107
- * This feature enables users to reorganize data dynamically via drag-and-drop operations.
108
- *
109
- * @default false
110
- */
111
- allowRowDragAndDrop?: boolean;
112
-
113
- /**
114
- * It is used to render TreeGrid table rows.
115
- * {% codeBlock src='treegrid/dataSource/index.md' %}{% endcodeBlock %}
116
- *
117
- * @default []
118
- * @isGenericType true
119
- * @isDataSource true
120
- */
121
- dataSource?: Object | DataManager;
122
-
123
- /**
124
- * Defines the external [Query](https://ej2.syncfusion.com/documentation/data/api-query.html)
125
- * that will be executed along with data processing.
126
- *
127
- * @default null
128
- */
129
- query?: Query;
130
-
131
- /**
132
- * @hidden
133
- */
134
- cloneQuery?: Query;
135
-
136
- /**
137
- * Defines the options for printing the TreeGrid.
138
- * The available print modes are:
139
- * * `AllPages`: Prints all pages of the TreeGrid.
140
- * * `CurrentPage`: Prints only the current page of the TreeGrid.
141
- *
142
- * @default Syncfusion.EJ2.Grids.PrintMode.AllPages
143
- * @isEnumeration true
144
- * @aspType Syncfusion.EJ2.Grids.PrintMode
145
- */
146
- printMode?: PrintMode;
147
-
148
- /**
149
- * If `allowPaging` is set to true, pager renders.
150
- *
151
- * @default false
152
- */
153
- allowPaging?: boolean;
154
-
155
- /**
156
- * When enabled, only parent records would be rendered during the initial render and child records will be loaded only when expanding a parent record.
157
- * This property is only applicable for remote data binding.
158
- * Loading child records on demand can improve the performance of data-bound controls with a large number of records.
159
- * Child records are only loaded when they are requested, rather than loading all child records at once.
160
- *
161
- * @default true
162
- */
163
- loadChildOnDemand?: boolean;
164
-
165
- /**
166
- * If `allowTextWrap` set to true,
167
- * then text content will wrap to the next line when its text content exceeds the width of the Column Cells.
168
- *
169
- * @default false
170
- */
171
- allowTextWrap?: boolean;
172
-
173
- /**
174
- * Configures the text wrap in the TreeGrid.
175
- *
176
- * @default {wrapMode:"Both"}
177
- */
178
- textWrapSettings?: TextWrapSettingsModel;
179
-
180
- /**
181
- * If `allowReordering` is set to true, TreeGrid columns can be reordered.
182
- * Reordering can be done by drag and drop of a particular column from one index to another index.
183
- * > If TreeGrid is rendered with stacked headers, reordering is allowed only at the same level as the column headers.
184
- *
185
- * @default false
186
- */
187
- allowReordering?: boolean;
188
-
189
- /**
190
- * If `allowResizing` is set to true, TreeGrid columns can be resized.
191
- *
192
- * @default false
193
- */
194
- allowResizing?: boolean;
195
-
196
- /**
197
- * If `autoCheckHierarchy` is set to true, hierarchy checkbox selection is enabled in TreeGrid.
198
- *
199
- * @default false
200
- */
201
- autoCheckHierarchy?: boolean;
202
-
203
- /**
204
- * Configures the pager in the TreeGrid.
205
- *
206
- * @default {currentPage: 1, pageSize: 12, pageCount: 8, enableQueryString: false, pageSizes: false, template: null}
207
- */
208
- pageSettings?: PageSettingsModel;
209
-
210
- /**
211
- * Configures the row drop settings of the TreeGrid.
212
- */
213
- rowDropSettings?: RowDropSettingsModel;
214
-
215
- /**
216
- * Defines the currencyCode format of the Tree Grid columns
217
- *
218
- * @private
219
- */
220
- currencyCode?: string;
221
-
222
- /**
223
- * It used to render pager template
224
- * @default null
225
- * @aspType string
226
- */
227
- pagerTemplate?: string | Function;
228
-
229
- /**
230
- * If `showColumnMenu` set to true, then it will enable the column menu options in each columns.
231
- *
232
- * > Check the [Column menu](../../treegrid/columns/#column-menu/) for its configuration.
233
- *
234
- * @default false
235
- */
236
- showColumnMenu?: boolean;
237
-
238
- /**
239
- * If `showColumnChooser` is set to true, it allows you to dynamically show or hide columns.
240
- *
241
- * @default false
242
- */
243
- showColumnChooser?: boolean;
244
-
245
- /**
246
- * Configures the column chooser in the Grid.
247
- *
248
- * @default { columnChooserOperator: 'startsWith' }
249
- */
250
- columnChooserSettings?: ColumnChooserSettingsModel;
251
-
252
- /**
253
- * If `allowSorting` is set to true, it allows sorting of treegrid records when column header is clicked.
254
- *
255
- * @default false
256
- */
257
- allowSorting?: boolean;
258
-
259
- /**
260
- * If `allowMultiSorting` set to true, then it will allow the user to sort multiple column in the treegrid.
261
- * > `allowSorting` should be true.
262
- *
263
- * @default true
264
- */
265
- allowMultiSorting?: boolean;
266
-
267
- /**
268
- * Configures the sort settings of the TreeGrid.
269
- *
270
- * @default {columns:[]}
271
- */
272
- sortSettings?: SortSettingsModel;
273
-
274
- /**
275
- * Configures the TreeGrid aggregate rows.
276
- * > Check the [Aggregates](../../treegrid/aggregates/aggregates) for its configuration.
277
- *
278
- * @default []
279
- */
280
- aggregates?: AggregateRowModel[];
281
-
282
- /**
283
- * Configures the edit settings.
284
- *
285
- * @default { allowAdding: false, allowEditing: false, allowDeleting: false, mode:'Normal',
286
- * allowEditOnDblClick: true, showConfirmDialog: true, showDeleteConfirmDialog: false }
287
- */
288
- editSettings?: EditSettingsModel;
289
-
290
- /**
291
- * If `allowFiltering` is set to true the filter bar will be displayed.
292
- * If set to false the filter bar will not be displayed.
293
- * Filter bar allows the user to filter tree grid records with required criteria.
294
- *
295
- * @default false
296
- */
297
- allowFiltering?: boolean;
298
-
299
- /**
300
- * The detail template allows you to show or hide additional information about a particular row.
301
- *
302
- * > It accepts either the [template string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals)
303
- * or the HTML element ID.
304
- *
305
- * @aspType string
306
- */
307
- detailTemplate?: string | Function;
308
-
309
- /**
310
- * Configures the filter settings of the TreeGrid.
311
- *
312
- * @default {columns: [], type: 'FilterBar', mode: 'Immediate', showFilterBarStatus: true, immediateModeDelay: 1500 , operators: {}}
313
- */
314
- filterSettings?: FilterSettingsModel;
315
-
316
- /**
317
- * Configures the search settings of the TreeGrid.
318
- *
319
- * @default {search: [] , operators: {}}
320
- */
321
- searchSettings?: SearchSettingsModel;
322
-
323
- /**
324
- * `toolbar` defines the ToolBar items of the TreeGrid.
325
- * It contains built-in and custom toolbar items.
326
- * If a string value is assigned to the `toolbar` option, it is considered as the template for the whole TreeGrid ToolBar.
327
- * If an array value is assigned, it is considered as the list of built-in and custom toolbar items in the TreeGrid's Toolbar.
328
- * <br><br>
329
- * The available built-in ToolBar items are:
330
- * * Search: Searches records by the given key.
331
- * * ExpandAll: Expands all the rows in TreeGrid
332
- * * CollapseAll: Collapses all the rows in TreeGrid
333
- * * ExcelExport - Export the TreeGrid to Excel(excelExport() method manually to make export.)
334
- * * PdfExport - Export the TreeGrid to PDF(pdfExport() method manually to make export.)
335
- * * CsvExport - Export the TreeGrid to CSV(csvExport() method manually to make export.)<br><br>
336
- * The following code example implements the custom toolbar items.
337
- *
338
- * @default null
339
- */
340
- toolbar?: (ToolbarItems | string| ItemModel | ToolbarItem)[];
341
-
342
- /**
343
- * @hidden
344
- * It used to render toolbar template
345
- * @default null
346
- * @aspType string
347
- */
348
- toolbarTemplate?: string | Function;
349
-
350
- /**
351
- * Defines how TreeGrid content lines are displayed, determining the visibility of vertical and horizontal lines.
352
- *
353
- * * `Both`: Displays both horizontal and vertical grid lines.
354
- * * `None`: Hides both horizontal and vertical grid lines.
355
- * * `Horizontal`: Displays only horizontal grid lines.
356
- * * `Vertical`: Displays only vertical grid lines.
357
- * * `Default`: Adjusts line visibility based on the theme.
358
- *
359
- * @default Syncfusion.EJ2.Grids.GridLine.Default
360
- * @isEnumeration true
361
- * @aspType Syncfusion.EJ2.Grids.GridLine
362
- */
363
- gridLines?: GridLine;
364
-
365
- /**
366
- * `contextMenuItems` defines both built-in and custom context menu items.
367
- * <br><br>
368
- * The available built-in items are,
369
- * * `AutoFitAll` - Auto fit the size of all columns.
370
- * * `AutoFit` - Auto fit the current column.
371
- * * `Edit` - Edit the current record.
372
- * * `Delete` - Delete the current record.
373
- * * `Save` - Save the edited record.
374
- * * `Cancel` - Cancel the edited state.
375
- * * `PdfExport` - Export the grid as Pdf format.
376
- * * `ExcelExport` - Export the grid as Excel format.
377
- * * `CsvExport` - Export the grid as CSV format.
378
- * * `SortAscending` - Sort the current column in ascending order.
379
- * * `SortDescending` - Sort the current column in descending order.
380
- * * `FirstPage` - Go to the first page.
381
- * * `PrevPage` - Go to the previous page.
382
- * * `LastPage` - Go to the last page.
383
- * * `NextPage` - Go to the next page.
384
- *
385
- * @default null
386
- */
387
- contextMenuItems?: ContextMenuItem[] | ContextMenuItemModel[];
388
-
389
- /**
390
- * `columnMenuItems` defines both built-in and custom column menu items.
391
- * <br><br>
392
- * The available built-in items are,
393
- * * `AutoFitAll` - Auto fit the size of all columns.
394
- * * `AutoFit` - Auto fit the current column.
395
- * * `SortAscending` - Sort the current column in ascending order.
396
- * * `SortDescending` - Sort the current column in descending order.
397
- * * `Filter` - Filter options will show based on filterSettings property like filterbar, menu filter.
398
- *
399
- * @default null
400
- */
401
- columnMenuItems?: ColumnMenuItem[] | ColumnMenuItemModel[];
402
-
403
- /**
404
- * The row template that renders customized rows from the given template.
405
- * By default, TreeGrid renders a table row for every data source item.
406
- * > * It accepts either [template string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals)
407
- * or HTML element ID.
408
- * > * The row template must be a table row.
409
- *
410
- * > Check the [Row Template](../../treegrid/row) customization.
411
- *
412
- * @aspType string
413
- */
414
- rowTemplate?: string | Function;
415
-
416
- /**
417
- * `copyHierarchyMode` Defines the copy clipboard types.
418
- * <br><br>
419
- * The available built-in items are,
420
- * * `Parent` - Copy the selected data with parent record.
421
- * * `Child` - Copy the selected data with child record.
422
- * * `Both` - Copy the selected data with both parent and child record.
423
- * * `None` - Copy only the selected record.
424
- *
425
- * @default Parent
426
- */
427
- copyHierarchyMode?: CopyHierarchyType;
428
-
429
- /**
430
- * Defines the height of TreeGrid rows.
431
- *
432
- * @default null
433
- */
434
- rowHeight?: number;
435
-
436
- /**
437
- * If `enableAltRow` is set to true, the TreeGrid will render with `e-altrow` CSS class to the alternative tr elements.   
438
- * > Check the [AltRow](../../treegrid/row/#styling-alternate-rows/) to customize the styles of alternative rows.
439
- *
440
- * @default true 
441
- */
442
- enableAltRow?: boolean;
443
-
444
- /**
445
- * Enables or disables the key board interaction of TreeGrid.    
446
- *
447
- * @hidden
448
- * @default true
449
- */
450
- allowKeyboard?: boolean;
451
-
452
- /**
453
- * If `enableHover` is set to true, the row hover is enabled in the TreeGrid.
454
- *
455
- * @default false
456
- */
457
- enableHover?: boolean;
458
-
459
- /**
460
- * If `enableAutoFill` is set to true, then the auto fill icon will displayed on cell selection for copy cells.
461
- * It requires the selection `mode` to be Cell and `cellSelectionMode` to be `Box`.
462
- *
463
- * @default false
464
- */
465
- enableAutoFill?: boolean;
466
-
467
- /**
468
- * If `enableAdaptiveUI` is set to true, the pop-up UI will become adaptive to small screens,
469
- * and be used for filtering and other features.
470
- * ```html
471
- * <div id='treegrid'></div>
472
- * <script>
473
- * var treegridObj = new TreeGrid({ enableAdaptiveUI: true });
474
- * treegridObj.appendTo('#treegrid');
475
- * </script>
476
- * ```
477
- *
478
- * @default false
479
- */
480
- enableAdaptiveUI?: boolean;
481
-
482
- /**
483
- * If `enableImmutableMode` is set to true, the TreeGrid will reuse old rows if it exists in the new result instead of
484
- * full refresh while performing the TreeGrid actions.
485
- *
486
- * @default false
487
- */
488
- enableImmutableMode?: boolean;
489
-
490
- /**
491
- * Enables the sticky header feature, which keeps the column headers visible while scrolling the Tree Grid content or the entire document.
492
- *
493
- * @default false
494
- */
495
- enableStickyHeader?: boolean;
496
-
497
- /**
498
- * The empty record template that renders customized element or text or image instead of displaying the empty record message in the TreeGrid.
499
- *
500
- * > It accepts either the [template string](../../common/template-engine/) or the HTML element ID.
501
- *
502
- * @default null
503
- * @aspType string
504
- */
505
- emptyRecordTemplate?: string | Function;
506
-
507
- /**
508
- * Defines the scrollable height of the TreeGrid content.
509
- *
510
- * @default 'auto'
511
- */
512
- height?: string | number;
513
-
514
- /**
515
- * Defines the TreeGrid width.
516
- *
517
- * @default 'auto'
518
- */
519
- width?: string | number;
520
-
521
- /**
522
- * Configures the loading indicator of the Tree Grid. Specifies whether to display spinner or shimmer effect
523
- * during the waiting time on any actions (paging, sorting, filtering, CRUD operations) performed in Tree Grid.
524
- *
525
- * @default {indicatorType: 'Spinner'}
526
- */
527
- loadingIndicator?: LoadingIndicatorModel;
528
-
529
- /**
530
- * Specifies whether to display shimmer effect during scrolling action in virtual scrolling feature.
531
- * If disabled, spinner is shown instead of shimmer effect.
532
- *
533
- * @default true
534
- */
535
- enableVirtualMaskRow?: boolean;
536
-
537
- /**
538
- * If `enableVirtualization` set to true, then the TreeGrid will render only the rows visible within the view-port
539
- * and load subsequent rows on vertical scrolling. This helps to load large dataset in TreeGrid.
540
- *
541
- * @default false
542
- */
543
- enableVirtualization?: boolean;
544
-
545
- /**
546
- * Enables column virtualization in the TreeGrid. When set to `true`, only columns visible within the viewport are rendered.
547
- * Additional columns are loaded as you horizontally scroll. This is beneficial for rendering large datasets efficiently.
548
- *
549
- * @default false
550
- */
551
- enableColumnVirtualization?: boolean;
552
-
553
- /**
554
- * Determines whether to sanitize untrusted HTML content in the TreeGrid. If `true`, potentially harmful HTML strings
555
- * and scripts are sanitized before rendering to protect against XSS attacks.
556
- *
557
- * @default false
558
- */
559
- enableHtmlSanitizer?: boolean;
560
-
561
- /**
562
- * Enables infinite scrolling in the TreeGrid. When set to `true`, additional data is loaded as the scrollbar
563
- * reaches the end. Useful for handling large datasets.
564
- *
565
- * @default false
566
- */
567
- enableInfiniteScrolling?: boolean;
568
-
569
- /**
570
- * Configures settings for infinite scrolling.
571
- *
572
- * @default { enableCache: false, maxBlocks: 5, initialBlocks: 5 }
573
- */
574
- infiniteScrollSettings?: InfiniteScrollSettingsModel;
575
-
576
- /**
577
- * Specifies how data is retrieved from the data source for the TreeGrid.
578
- * The available modes are:
579
- * * `All`: Retrieve the entire data source.
580
- * * `Schema`: Retrieve data only for defined columns.
581
- * * `ExcludeHidden`: Retrieve data only for visible columns in the TreeGrid.
582
- *
583
- * @default All
584
- */
585
- columnQueryMode?: ColumnQueryModeType;
586
-
587
- /**
588
- * If `allowSelection` is set to true, selection of (highlight row) TreeGrid records by clicking is allowed.
589
- *
590
- * @default true
591
- */
592
- allowSelection?: boolean;
593
-
594
- /**
595
- * Specifies the index of the row to be selected upon initial rendering.
596
- * Also retrieves the index of the currently selected row.
597
- *
598
- * @default -1
599
- */
600
- selectedRowIndex?: number;
601
-
602
- /**
603
- * Configures the selection behavior.
604
- *
605
- * @default {mode: 'Row', cellSelectionMode: 'Flow', type: 'Single'}
606
- */
607
- selectionSettings?: SelectionSettingsModel;
608
-
609
- /**
610
- * Enables exporting the TreeGrid to an Excel file if set to true.
611
- *
612
- * > Check the [ExcelExport](../../treegrid/excel-export/) documentation for more details.
613
- *
614
- * @default false
615
- */
616
- allowExcelExport?: boolean;
617
-
618
- /**
619
- * Enables exporting the TreeGrid to a PDF file if set to true.
620
- *
621
- * > Check the [PdfExport](../../treegrid/pdf-export/) documentation for more details.
622
- *
623
- * @default false
624
- */
625
- allowPdfExport?: boolean;
626
-
627
- /**
628
- * Triggers when the component is created.
629
- *
630
- * @event created
631
- */
632
- created?: EmitType<Object>;
633
-
634
- /**
635
- * Allows customization of TreeGrid properties before rendering.
636
- *
637
- * @event load
638
- */
639
- load?: EmitType<Object>;
640
-
641
- /**
642
- * Triggers while a TreeGrid record is expanding.
643
- *
644
- * @event expanding
645
- */
646
- expanding?: EmitType<RowExpandingEventArgs>;
647
-
648
- /**
649
- * Triggers after a TreeGrid record is expanded.
650
- *
651
- * @event expanded
652
- */
653
- expanded?: EmitType<RowExpandedEventArgs>;
654
-
655
- /**
656
- * Triggers while a TreeGrid record is collapsing.
657
- *
658
- * @event collapsing
659
- */
660
- collapsing?: EmitType<RowCollapsingEventArgs>;
661
-
662
- /**
663
- * Triggers after a TreeGrid record is collapsed.
664
- *
665
- * @event collapsed
666
- */
667
- collapsed?: EmitType<RowCollapsedEventArgs>;
668
-
669
- /**
670
- * Triggers when a cell is being saved.
671
- *
672
- * @event cellSave
673
- */
674
- cellSave?: EmitType<CellSaveArgs>;
675
-
676
- /**
677
- * Triggers after a cell is saved.
678
- *
679
- * @event cellSaved
680
- */
681
- cellSaved?: EmitType<CellSaveArgs>;
682
-
683
- /**
684
- * Triggers when TreeGrid actions like sorting, filtering, paging, etc., start.
685
- *
686
- * @event actionBegin
687
- */
688
- actionBegin?: EmitType<PageEventArgs | FilterEventArgs | SortEventArgs | SearchEventArgs | AddEventArgs | SaveEventArgs | EditEventArgs | DeleteEventArgs>;
689
-
690
- /**
691
- * Triggers when TreeGrid actions like sorting, filtering, paging, etc., are completed.
692
- *
693
- * @event actionComplete
694
- */
695
- actionComplete?: EmitType<PageEventArgs | FilterEventArgs | SortEventArgs | SearchEventArgs | AddEventArgs | SaveEventArgs | EditEventArgs | DeleteEventArgs>;
696
-
697
- /**
698
- * Triggers before a record is edited.
699
- *
700
- * @event beginEdit
701
- */
702
- beginEdit?: EmitType<BeginEditArgs>;
703
-
704
- /**
705
- * Triggers when records are added in batch mode.
706
- *
707
- * @event batchAdd
708
- */
709
- batchAdd?: EmitType<BatchAddArgs>;
710
-
711
- /**
712
- * Triggers when records are deleted in batch mode.
713
- *
714
- * @event batchDelete
715
- */
716
- batchDelete?: EmitType<BatchDeleteArgs>;
717
-
718
- /**
719
- * Triggers before records are cancelled in batch mode.
720
- *
721
- * @event batchCancel
722
- */
723
- batchCancel?: EmitType<BatchCancelArgs>;
724
-
725
- /**
726
- * Triggers before records are added in batch mode.
727
- *
728
- * @event beforeBatchAdd
729
- */
730
- beforeBatchAdd?: EmitType<BeforeBatchAddArgs>;
731
-
732
- /**
733
- * Triggers before records are deleted in batch mode.
734
- *
735
- * @event beforeBatchDelete
736
- */
737
- beforeBatchDelete?: EmitType<BeforeBatchDeleteArgs>;
738
-
739
- /**
740
- * Triggers before records are saved in batch mode.
741
- *
742
- * @event beforeBatchSave
743
- */
744
- beforeBatchSave?: EmitType<BeforeBatchSaveArgs>;
745
-
746
- /**
747
- * Triggers when a cell is being edited.
748
- *
749
- * @event cellEdit
750
- */
751
- cellEdit?: EmitType<CellEditArgs>;
752
-
753
- /**
754
- * Triggers when any TreeGrid action fails to achieve the desired results.
755
- *
756
- * @event actionFailure
757
- */
758
- actionFailure?: EmitType<FailureEventArgs>;
759
-
760
- /**
761
- * Triggers when the data source is populated in the TreeGrid.
762
- *
763
- * @event dataBound
764
- */
765
- dataBound?: EmitType<Object>;
766
-
767
- /**
768
- * Triggers when data in the TreeGrid is added, deleted, or updated.
769
- * Invoke the done method from the argument to start rendering after an edit operation.
770
- *
771
- * @event dataSourceChanged
772
- * @deprecated
773
- */
774
- dataSourceChanged?: EmitType<DataSourceChangedEventArgs>;
775
-
776
- /**
777
- * Triggers when TreeGrid actions such as sorting, paging, etc., are completed.
778
- * The current view data and total record count should be assigned to the dataSource based on the action performed.
779
- *
780
- * @event dataStateChange
781
- * @deprecated
782
- */
783
- dataStateChange?: EmitType<DataStateChangeEventArgs>;
784
-
785
- /**
786
- * Triggers when a record is double-clicked.
787
- *
788
- * @event recordDoubleClick
789
- */
790
- recordDoubleClick?: EmitType<RecordDoubleClickEventArgs>;
791
-
792
- /**
793
- * Triggered every time a request is made to access row information, element, or data.
794
- * This event is triggered before the row element is appended to the TreeGrid element.
795
- *
796
- * @event rowDataBound
797
- */
798
- rowDataBound?: EmitType<RowDataBoundEventArgs>;
799
-
800
- /**
801
- * Triggers after a detail row expands. This event triggers initially during the first expand.
802
- *
803
- * @event detailDataBound
804
- */
805
- detailDataBound?: EmitType<DetailDataBoundEventArgs>;
806
-
807
- /**
808
- * Triggered every time a request is made to access cell information, element, or data.
809
- * This event is triggered before the cell element is appended to the TreeGrid element.
810
- *
811
- * @event queryCellInfo
812
- */
813
- queryCellInfo?: EmitType<QueryCellInfoEventArgs>;
814
-
815
- /**
816
- * Triggers before row selection occurs.
817
- *
818
- * @event rowSelecting
819
- */
820
- rowSelecting?: EmitType<RowSelectingEventArgs>;
821
-
822
- /**
823
- * Triggers after a row is selected.
824
- *
825
- * @event rowSelected
826
- */
827
- rowSelected?: EmitType<RowSelectEventArgs>;
828
-
829
- /**
830
- * Triggers before the selected row is deselected.
831
- *
832
- * @event rowDeselecting
833
- * @deprecated
834
- */
835
- rowDeselecting?: EmitType<RowDeselectEventArgs>;
836
-
837
- /**
838
- * Triggers when a selected row is deselected.
839
- *
840
- * @event rowDeselected
841
- */
842
- rowDeselected?: EmitType<RowDeselectEventArgs>;
843
-
844
- /**
845
- * Triggered for accessing header information.
846
- *
847
- * @event headerCellInfo
848
- */
849
- headerCellInfo?: EmitType<HeaderCellInfoEventArgs>;
850
-
851
- /**
852
- * Triggers before any cell selection occurs.
853
- *
854
- * @event cellSelecting
855
- */
856
- cellSelecting?: EmitType<CellSelectingEventArgs>;
857
-
858
- /**
859
- * Triggers before the column menu opens.
860
- *
861
- * @event columnMenuOpen
862
- * @deprecated
863
- */
864
- columnMenuOpen?: EmitType<ColumnMenuOpenEventArgs>;
865
-
866
- /**
867
- * Triggers when there is a click on the column menu.
868
- *
869
- * @event columnMenuClick
870
- */
871
- columnMenuClick?: EmitType<MenuEventArgs>;
872
-
873
- /**
874
- * Triggers after a cell is selected.
875
- *
876
- * @event cellSelected
877
- */
878
- cellSelected?: EmitType<CellSelectEventArgs>;
879
-
880
- /**
881
- * Triggers before a selected cell is deselected.
882
- *
883
- * @event cellDeselecting
884
- * @deprecated
885
- */
886
- cellDeselecting?: EmitType<CellDeselectEventArgs>;
887
-
888
- /**
889
- * Triggers when a selected cell is deselected.
890
- *
891
- * @event cellDeselected
892
- * @deprecated
893
- */
894
- cellDeselected?: EmitType<CellDeselectEventArgs>;
895
-
896
- /**
897
- * Triggers when column resizing starts.
898
- *
899
- * @event resizeStart
900
- * @deprecated
901
- */
902
- resizeStart?: EmitType<ResizeArgs>;
903
-
904
- /**
905
- * Triggers during column resizing.
906
- *
907
- * @event resizing
908
- */
909
- resizing?: EmitType<ResizeArgs>;
910
-
911
- /**
912
- * Triggers when column resizing ends.
913
- *
914
- * @event resizeStop
915
- */
916
- resizeStop?: EmitType<ResizeArgs>;
917
-
918
- /**
919
- * Triggers when column header dragging begins.
920
- *
921
- * @event columnDragStart
922
- */
923
- columnDragStart?: EmitType<ColumnDragEventArgs>;
924
-
925
- /**
926
- * Triggers continuously while the column header is being dragged.
927
- *
928
- * @event columnDrag
929
- */
930
- columnDrag?: EmitType<ColumnDragEventArgs>;
931
-
932
- /**
933
- * Triggers when a column header is dropped onto the target column.
934
- *
935
- * @event columnDrop
936
- */
937
- columnDrop?: EmitType<ColumnDragEventArgs>;
938
-
939
- /**
940
- * Triggers when the state of a checkbox changes in a checkbox column.
941
- *
942
- * @event checkboxChange
943
- */
944
- checkboxChange?: EmitType<CheckBoxChangeEventArgs>;
945
-
946
- /**
947
- * Triggers after the print action has been completed.
948
- *
949
- * @event printComplete
950
- */
951
- printComplete?: EmitType<PrintEventArgs>;
952
-
953
- /**
954
- * Triggers before the print action begins.
955
- *
956
- * @event beforePrint
957
- */
958
- beforePrint?: EmitType<PrintEventArgs>;
959
-
960
- /**
961
- * Triggers when a toolbar item is clicked.
962
- *
963
- * @event toolbarClick
964
- */
965
- toolbarClick?: EmitType<ClickEventArgs>;
966
-
967
- /**
968
- * Triggers before data is bound to the TreeGrid.
969
- *
970
- * @event beforeDataBound
971
- */
972
- beforeDataBound?: EmitType<BeforeDataBoundArgs>;
973
-
974
- /**
975
- * Triggers before the context menu opens.
976
- *
977
- * @event contextMenuOpen
978
- */
979
- contextMenuOpen?: EmitType<BeforeOpenCloseMenuEventArgs>;
980
-
981
- /**
982
- * Triggers when an item in the context menu is clicked.
983
- *
984
- * @event contextMenuClick
985
- */
986
- contextMenuClick?: EmitType<MenuEventArgs>;
987
-
988
- /**
989
- * Triggers before the TreeGrid copy action is initiated.
990
- *
991
- * @event beforeCopy
992
- */
993
- beforeCopy?: EmitType<BeforeCopyEventArgs>;
994
-
995
- /**
996
- * Triggers before the TreeGrid paste action is initiated.
997
- *
998
- * @event beforePaste
999
- */
1000
- beforePaste?: EmitType<BeforePasteEventArgs>;
1001
-
1002
- /**
1003
- * Triggers continuously while row elements are being dragged.
1004
- *
1005
- * @event rowDrag
1006
- */
1007
- rowDrag?: EmitType<RowDragEventArgs>;
1008
-
1009
- /**
1010
- * Triggers when row element dragging starts.
1011
- *
1012
- * @event rowDragStart
1013
- */
1014
- rowDragStart?: EmitType<RowDragEventArgs>;
1015
-
1016
- /**
1017
- * Triggers just before the row element dragging begins.
1018
- *
1019
- * @event rowDragStartHelper
1020
- */
1021
- rowDragStartHelper?: EmitType<RowDragEventArgs>;
1022
-
1023
- /**
1024
- * Triggers when a row element is dropped onto the target row.
1025
- *
1026
- * @event rowDrop
1027
- */
1028
- rowDrop?: EmitType<RowDragEventArgs>;
1029
-
1030
- /**
1031
- * Triggers before each cell is exported to a PDF document, allowing customization of cells.
1032
- *
1033
- * @event pdfQueryCellInfo
1034
- */
1035
- pdfQueryCellInfo?: EmitType<PdfQueryCellInfoEventArgs>;
1036
-
1037
- /**
1038
- * Triggers before each header cell is exported to a PDF document, allowing customization of cells.
1039
- *
1040
- * @event pdfHeaderQueryCellInfo
1041
- */
1042
- pdfHeaderQueryCellInfo?: EmitType<PdfHeaderQueryCellInfoEventArgs>;
1043
-
1044
- /**
1045
- * Triggers before each cell is exported to an Excel file, allowing customization of cells.
1046
- *
1047
- * @event excelQueryCellInfo
1048
- */
1049
- excelQueryCellInfo?: EmitType<ExcelQueryCellInfoEventArgs>;
1050
-
1051
- /**
1052
- * Triggers before exporting aggregate cell to PDF document. You can also customize the PDF cells.
1053
- *
1054
- * @event pdfAggregateQueryCellInfo
1055
- */
1056
- pdfAggregateQueryCellInfo?: EmitType<AggregateQueryCellInfoEventArgs>;
1057
-
1058
- /**
1059
- * Triggers before exporting aggregate cell to Excel document.
1060
- *
1061
- * @event excelAggregateQueryCellInfo
1062
- */
1063
- excelAggregateQueryCellInfo?: EmitType<AggregateQueryCellInfoEventArgs>;
1064
-
1065
- /**
1066
- * Triggers before each header cell is exported to an Excel file, allowing customization of cells.
1067
- *
1068
- * @event excelHeaderQueryCellInfo
1069
- */
1070
- excelHeaderQueryCellInfo?: EmitType<ExcelHeaderQueryCellInfoEventArgs>;
1071
-
1072
- /**
1073
- * Triggers before TreeGrid data is exported to an Excel file.
1074
- *
1075
- * @event beforeExcelExport
1076
- */
1077
- beforeExcelExport?: EmitType<Object>;
1078
-
1079
- /**
1080
- * Triggers after TreeGrid data is exported to an Excel file.
1081
- *
1082
- * @event excelExportComplete
1083
- */
1084
- excelExportComplete?: EmitType<ExcelExportCompleteArgs>;
1085
-
1086
- /**
1087
- * Triggers before TreeGrid data is exported to a PDF document.
1088
- *
1089
- * @event beforePdfExport
1090
- */
1091
- beforePdfExport?: EmitType<Object>;
1092
-
1093
- /**
1094
- * Triggers after TreeGrid data is exported to a PDF document.
1095
- *
1096
- * @event pdfExportComplete
1097
- */
1098
- pdfExportComplete?: EmitType<PdfExportCompleteArgs>;
1099
-
1100
- }