@bryntum/grid-angular-thin 7.1.1 → 7.1.2

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.
@@ -0,0 +1,2801 @@
1
+ /* eslint-disable @typescript-eslint/no-unused-vars */
2
+ /**
3
+ * Angular wrapper for Bryntum TreeGrid
4
+ */
5
+
6
+ import { Component, ElementRef, EventEmitter, Output, Input, SimpleChange, SimpleChanges, OnDestroy, OnInit } from '@angular/core';
7
+
8
+ import WrapperHelper from './wrapper.helper';
9
+
10
+ import { AjaxStore, AjaxStoreConfig, Base, Container, DomConfig, FormulaProviderConfig, KeyMapConfig, Mask, MaskConfig, Menu, MenuItem, MenuItemEntry, Model, ModelConfig, PagingToolbarConfig, Panel, PanelCollapserConfig, PanelCollapserOverlayConfig, PanelHeader, ScrollManager, ScrollManagerConfig, Scroller, ScrollerConfig, StateProvider, Store, StoreConfig, TabConfig, Tool, ToolConfig, ToolbarConfig, ToolbarItems, TooltipConfig, Widget } from '@bryntum/core-thin';
11
+ import { AIFilter, AIFilterConfig, CellCopyPaste, CellCopyPasteConfig, CellEdit, CellEditConfig, CellEditorContext, CellMenu, CellMenuConfig, CellTooltip, CellTooltipConfig, Charts, ChartsConfig, Column, ColumnAutoWidth, ColumnAutoWidthConfig, ColumnDragToolbar, ColumnDragToolbarConfig, ColumnPicker, ColumnPickerConfig, ColumnRename, ColumnRenameConfig, ColumnReorder, ColumnReorderConfig, ColumnResize, ColumnResizeConfig, ColumnStore, ColumnStoreConfig, GridContainerItemConfig, EmptyTextDomConfig, ExcelExporter, ExcelExporterConfig, ExportConfig, FileDrop, FileDropConfig, FillHandle, FillHandleConfig, Filter, FilterBar, FilterBarConfig, FilterConfig, Grid, GridBase, GridColumnConfig, GridLocation, GridLocationConfig, GridSelectionMode, GridStateInfo, Group, GroupConfig, GroupSummary, GroupSummaryConfig, HeaderMenu, HeaderMenuConfig, LockRows, LockRowsConfig, MergeCells, MergeCellsConfig, PdfExport, PdfExportConfig, PinColumns, PinColumnsConfig, PreserveScrollOptions, Print, PrintConfig, QuickFind, QuickFindConfig, RecordPositionContext, RegionResize, RegionResizeConfig, ResponsiveLevelConfig, Row, RowCopyPaste, RowCopyPasteConfig, RowEdit, RowEditConfig, RowEditorContext, RowExpander, RowExpanderConfig, RowReorder, RowReorderConfig, RowResize, RowResizeConfig, Search, SearchConfig, Sort, SortConfig, Split, SplitConfig, StickyCells, StickyCellsConfig, Stripe, StripeConfig, SubGrid, SubGridConfig, Summary, SummaryConfig, Tree, TreeConfig, TreeGrid, TreeGridListeners, TreeGroup, TreeGroupConfig, XLSColumn } from '@bryntum/grid-thin';
12
+
13
+ import { StringHelper } from '@bryntum/core-thin';
14
+
15
+ export type BryntumTreeGridProps = {
16
+ // Configs
17
+ /**
18
+ * Element (or element id) to adopt as this Widget's encapsulating element. The widget's
19
+ * content will be placed inside this element.
20
+ * ...
21
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-adopt)
22
+ */
23
+ adopt ? : HTMLElement|string
24
+ /**
25
+ * When this widget is a child of a [Container](https://bryntum.com/products/grid/docs/api/Core/widget/Container), it will by default be participating in a
26
+ * flexbox layout. This config allows you to set this widget's
27
+ * [align-self](https://developer.mozilla.org/en-US/docs/Web/CSS/align-self) style.
28
+ */
29
+ alignSelf ? : string
30
+ /**
31
+ * Set to `true` to animate row removals caused by filtering.
32
+ * @deprecated 7.0.0 Deprecated `animateFilterRemovals`. Use `transition.filterRemoval` instead
33
+ */
34
+ animateFilterRemovals ? : boolean
35
+ /**
36
+ * Controls if removing and inserting rows should be animated. Set to `false` to prevent those animations,
37
+ * removing the related delays.
38
+ * @deprecated 7.0.0 Deprecated `animateRemovingRows`. Use `transition.removeRecord` instead
39
+ */
40
+ animateRemovingRows ? : boolean
41
+ /**
42
+ * When the [Tree](https://bryntum.com/products/grid/docs/api/Grid/feature/Tree) feature is in use and the Store is a tree store, this
43
+ * config may be set to `true` to visually animate branch node expand and collapse operations.
44
+ * *This is not supported in Scheduler and Gantt*
45
+ * @deprecated 7.0.0 Deprecated `animateTreeNodeToggle`. Use `transition.toggleTreeNode` instead
46
+ */
47
+ animateTreeNodeToggle ? : boolean
48
+ /**
49
+ * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
50
+ * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
51
+ */
52
+ appendTo ? : HTMLElement|string
53
+ /**
54
+ * A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject
55
+ * into an element which will be linked using the `aria-describedby` attribute.
56
+ * ...
57
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-ariaDescription)
58
+ */
59
+ ariaDescription ? : string
60
+ /**
61
+ * A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject as
62
+ * the `aria-label` attribute.
63
+ * ...
64
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-ariaLabel)
65
+ */
66
+ ariaLabel ? : string
67
+ /**
68
+ * Automatically set grids height to fit all rows (no scrolling in the grid). In general you should avoid
69
+ * using `autoHeight: true`, since it will bypass Grids virtual rendering and render all rows at once, which
70
+ * in a larger grid is really bad for performance.
71
+ */
72
+ autoHeight ? : boolean
73
+ /**
74
+ * A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/grid/docs/api/Core/widget/Toolbar),
75
+ * or array of config objects representing the child items of a Toolbar. Another way to add a bbar is to use [strips](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-strips).
76
+ * ...
77
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-bbar)
78
+ */
79
+ bbar ? : (GridContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
80
+ /**
81
+ * Custom CSS classes to add to the panel's body element.
82
+ * ...
83
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-bodyCls)
84
+ */
85
+ bodyCls ? : string|object
86
+ /**
87
+ * An object where property names with a truthy value indicate which events should bubble up the ownership
88
+ * hierarchy when triggered.
89
+ * ...
90
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-bubbleEvents)
91
+ */
92
+ bubbleEvents ? : object
93
+ /**
94
+ * Set to `false` to not call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
95
+ * ...
96
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-callOnFunctions)
97
+ */
98
+ callOnFunctions ? : boolean
99
+ /**
100
+ * By default, if an event handler throws an exception, the error propagates up the stack and the
101
+ * application state is undefined. Code which follows the event handler will *not* be executed.
102
+ * ...
103
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-catchEventHandlerExceptions)
104
+ */
105
+ catchEventHandlerExceptions ? : boolean
106
+ /**
107
+ * Set to `false` to crop text in grid cells without ellipsis (...). When enabled, cells containing pure
108
+ * use `display : block`, instead of `display : flex` to allow ellipsis to work.
109
+ * <strong>NOTE</strong> Only supported in browsers that support `:has()` CSS selector
110
+ */
111
+ cellEllipsis ? : boolean
112
+ /**
113
+ * Custom CSS classes to add to element.
114
+ * May be specified as a space separated string, or as an object in which property names
115
+ * with truthy values are used as the class names:
116
+ * ...
117
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-cls)
118
+ */
119
+ cls ? : string|object
120
+ /**
121
+ * Controls whether the panel is collapsed (the body of the panel is hidden while only the header is
122
+ * visible). Only valid if the panel is [collapsible](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-collapsible).
123
+ */
124
+ collapsed ? : boolean
125
+ /**
126
+ * This config enables collapsibility for the panel. See [collapsed](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-collapsed).
127
+ * ...
128
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-collapsible)
129
+ */
130
+ collapsible ? : boolean|PanelCollapserConfig|PanelCollapserOverlayConfig
131
+ /**
132
+ * Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
133
+ * `style` block.
134
+ * ...
135
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-color)
136
+ */
137
+ color ? : string
138
+ /**
139
+ * Programmatic control over which column to start in when used in a grid layout.
140
+ */
141
+ column ? : number
142
+ /**
143
+ * Set to `false` to not show column lines. End result might be overruled by/differ between themes.
144
+ */
145
+ columnLines ? : boolean
146
+ /**
147
+ * Accepts column definitions for the grid during initialization. They will be used to create
148
+ * [Column](https://bryntum.com/products/grid/docs/api/Grid/column/Column) instances that are added to a [ColumnStore](#Grid/data/ColumnStore).
149
+ * ...
150
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-columns)
151
+ */
152
+ columns ? : ColumnStore|GridColumnConfig[]|ColumnStoreConfig
153
+ config ? : object
154
+ /**
155
+ * Custom CSS classes to add to the [contentElement](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-contentElement).
156
+ * May be specified as a space separated string, or as an object in which property names
157
+ * with truthy values are used as the class names:
158
+ * ...
159
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-contentElementCls)
160
+ */
161
+ contentElementCls ? : string|object
162
+ /**
163
+ * Event which is used to show context menus.
164
+ * Available options are: 'contextmenu', 'click', 'dblclick'.
165
+ */
166
+ contextMenuTriggerEvent ? : 'contextmenu'|'click'|'dblclick'
167
+ /**
168
+ * Convenient shortcut to set data in grids store both during initialization and at runtime. Can also be
169
+ * used to retrieve data at runtime, although we do recommend interacting with Grids store instead using
170
+ * the [store](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#property-store) property.
171
+ * ...
172
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-data)
173
+ */
174
+ data ? : object[]|Model[]|ModelConfig[]
175
+ /**
176
+ * When this Widget configuration is used in the Grid's RowExpander feature's `widget` config, provide the
177
+ * field on the expanded record to use for populating this widget's store (if applicable)
178
+ */
179
+ dataField ? : string
180
+ /**
181
+ * Object to apply to elements dataset (each key will be used as a data-attribute on the element)
182
+ */
183
+ dataset ? : Record<string, string>
184
+ /**
185
+ * Region to which columns are added when they have none specified
186
+ */
187
+ defaultRegion ? : string
188
+ /**
189
+ * Set to `true` to destroy the store when the grid is destroyed.
190
+ */
191
+ destroyStore ? : boolean
192
+ /**
193
+ * Check for CSS compatibility issues when upgrading to v7. Performs the following checks:
194
+ * ...
195
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-detectCSSCompatibilityIssues)
196
+ */
197
+ detectCSSCompatibilityIssues ? : boolean
198
+ /**
199
+ * Disable or enable the widget. It is similar to [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-readOnly) except a disabled widget
200
+ * cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
201
+ * ...
202
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-disabled)
203
+ */
204
+ disabled ? : boolean|'inert'
205
+ /**
206
+ * Set to `true` to not get a warning when calling [getState](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#function-getState) when there is a column
207
+ * configured without an `id`. But the recommended action is to always configure columns with an `id` when
208
+ * using states.
209
+ */
210
+ disableGridColumnIdWarning ? : boolean
211
+ /**
212
+ * Set to `true` to not get a warning when using another base class than GridRowModel for your grid data. If
213
+ * you do, and would like to use the full feature set of the grid then include the fields from GridRowModel
214
+ * in your model definition.
215
+ */
216
+ disableGridRowModelWarning ? : boolean
217
+ /**
218
+ * Controls the placement of this widget when it is added to a [panel's ](https://bryntum.com/products/grid/docs/api/Core/widget/Panel)
219
+ * [strips collection](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
220
+ * `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
221
+ * body. Such widgets are called "edge strips".
222
+ * ...
223
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-dock)
224
+ */
225
+ dock ? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
226
+ /**
227
+ * Make this Panel a docked drawer which slides out from one side of the browser viewport by default.
228
+ * ...
229
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-drawer)
230
+ * @param {'start','left','end','right','top','bottom'} side The side of the viewport to dock the drawer to. * `'start'` means the `inline-start` side. * `'end'` means the `inline-end` side.
231
+ * @param {string,number} size The size of the drawer in its collapsible axis.
232
+ * @param {boolean} inline If using the [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-appendTo) config to place the drawer inside a host widget, this may be set to `true` to make the drawer inline within that host. Note that, if using this, the layout of the host element must have `flex-direction` set appropriately.
233
+ * @param {boolean,object} autoClose Specifies what user actions should automatically close the drawer. Defaults to closing when the user clicks outside of the drawer or when focus moves outside of the drawer.
234
+ * @param {boolean,string} autoClose.mousedown If the user clicks outside of the drawer, the drawer will automatically be hidden. If the value is a string, it is used as a CSS selector to filter clicks which should close the drawer.
235
+ * @param {boolean,string} autoClose.focusout If focus moves outside of the drawer, the drawer will automatically be hidden.
236
+ * @param {string} autoClose.mouseout Hides the drawer when the mouse leaves the drawer after the `autoCloseDelay` period.
237
+ * @param {number} autoCloseDelay When using `mouseout`, this is the delay in milliseconds
238
+ */
239
+ drawer ? : boolean|{side?: 'start'|'left'|'end'|'right'|'top'|'bottom', size?: string|number, inline?: boolean, autoClose: { mousedown?: boolean|string, focusout?: boolean|string, mouseout?: string }, autoCloseDelay?: number}
240
+ /**
241
+ * An object specifying attributes to assign to the root element of this widget.
242
+ * Set `null` value to attribute to remove it.
243
+ * ...
244
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-elementAttributes)
245
+ */
246
+ elementAttributes ? : Record<string, string|null>
247
+ /**
248
+ * Text or HTML, or a [EmptyTextDomConfig](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#typedef-EmptyTextDomConfig) block to display when there is no data to display in the grid.
249
+ * When using multiple Grid regions, provide the `region` property to decide where the text is shown.
250
+ * By default, it is shown in the first region.
251
+ * ...
252
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-emptyText)
253
+ */
254
+ emptyText ? : string|EmptyTextDomConfig
255
+ /**
256
+ * Configure this as `true` to allow elements within cells to be styled as `position: sticky`.
257
+ * ...
258
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-enableSticky)
259
+ */
260
+ enableSticky ? : boolean
261
+ /**
262
+ * Set to `true` to allow text selection in the grid cells. Note, this cannot be used simultaneously with the
263
+ * `RowReorder` feature.
264
+ */
265
+ enableTextSelection ? : boolean
266
+ /**
267
+ * Set to `true` to listen for CTRL-Z (CMD-Z on Mac OS) keyboard event and trigger undo (redo when SHIFT is
268
+ * pressed). Only applicable when using a [StateTrackingManager](https://bryntum.com/products/grid/docs/api/Core/data/stm/StateTrackingManager).
269
+ */
270
+ enableUndoRedoKeys ? : boolean
271
+ extraData ? : any
272
+ /**
273
+ * Set to `true` to stretch the last column in a grid with all fixed width columns
274
+ * to fill extra available space if the grid's width is wider than the sum of all
275
+ * configured column widths.
276
+ */
277
+ fillLastColumn ? : boolean
278
+ /**
279
+ * Use fixed row height. Setting this to `true` will configure the underlying RowManager to use fixed row
280
+ * height, which sacrifices the ability to use rows with variable height to gain a fraction better
281
+ * performance.
282
+ * ...
283
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-fixedRowHeight)
284
+ */
285
+ fixedRowHeight ? : boolean
286
+ /**
287
+ * When this widget is a child of a [Container](https://bryntum.com/products/grid/docs/api/Core/widget/Container), it will by default be participating in a
288
+ * flexbox layout. This config allows you to set this widget's
289
+ * [flex](https://developer.mozilla.org/en-US/docs/Web/CSS/flex) style.
290
+ * This may be configured as a single number or a `&lt;flex-grow&gt; &lt;flex-shrink&gt; &lt;flex-basis&gt;` format string.
291
+ * numeric-only values are interpreted as the `flex-grow` value.
292
+ */
293
+ flex ? : number|string
294
+ /**
295
+ * Config object of a footer. May contain a `dock`, `html` and a `cls` property. A footer is not a widget,
296
+ * but rather plain HTML that follows the last element of the panel's body and [strips](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-strips).
297
+ * ...
298
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-footer)
299
+ */
300
+ footer ? : {
301
+ dock?: 'top'|'right'|'bottom'|'left'|'start'|'end'
302
+ html?: string
303
+ cls?: string
304
+ }|string
305
+ /**
306
+ * An object which names formula prefixes which will be applied to all columns configured with
307
+ * `formula : true`.
308
+ * ...
309
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-formulaProviders)
310
+ */
311
+ formulaProviders ? : Record<string, FormulaProviderConfig>
312
+ /**
313
+ * Refresh entire row when a record changes (`true`) or, if possible, only the cells affected (`false`).
314
+ * ...
315
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-fullRowRefresh)
316
+ */
317
+ fullRowRefresh ? : boolean
318
+ /**
319
+ * A function called for each row to determine its height. It is passed a [record](https://bryntum.com/products/grid/docs/api/Core/data/Model) and
320
+ * expected to return the desired height of that records row. If the function returns a falsy value, Grids
321
+ * configured [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-rowHeight) is used.
322
+ * ...
323
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-getRowHeight)
324
+ * @param {Core.data.Model} getRowHeight.record Record to determine row height for
325
+ * @returns {number} Desired row height
326
+ */
327
+ getRowHeight ? : (getRowHeight: { record: Model }) => number
328
+ /**
329
+ * A config [object](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#typedef-PanelHeader) for the panel's header or a string in place of a `title`.
330
+ * ...
331
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-header)
332
+ */
333
+ header ? : string|boolean|PanelHeader
334
+ /**
335
+ * Widget's height, used to set element `style.height`. Either specify a valid height string or a number,
336
+ * which will get 'px' appended. We recommend using CSS as the primary way to control height, but in some
337
+ * cases this config is convenient.
338
+ */
339
+ height ? : string|number
340
+ /**
341
+ * Configure with true to make widget initially hidden.
342
+ */
343
+ hidden ? : boolean
344
+ /**
345
+ * Set to `true` to hide the footer elements
346
+ */
347
+ hideFooters ? : boolean
348
+ /**
349
+ * Set to `true` to hide the column header elements
350
+ */
351
+ hideHeaders ? : boolean
352
+ /**
353
+ * Set to `true` to hide the Grid's horizontal scrollbar(s)
354
+ */
355
+ hideHorizontalScrollbar ? : boolean
356
+ /**
357
+ * A CSS class to add to hovered row elements
358
+ */
359
+ hoverCls ? : string
360
+ /**
361
+ * An icon to show before the [title](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-title). Either pass a CSS class as a string, or pass a
362
+ * [DomConfig](https://bryntum.com/products/grid/docs/api/Core/helper/DomHelper#typedef-DomConfig) object describing an element to represent the icon.
363
+ */
364
+ icon ? : string|DomConfig
365
+ /**
366
+ * Widget id, if not specified one will be generated. Also used for lookups through Widget.getById
367
+ */
368
+ id ? : string
369
+ /**
370
+ * Determines if the widgets read-only state should be controlled by its parent.
371
+ * ...
372
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-ignoreParentReadOnly)
373
+ */
374
+ ignoreParentReadOnly ? : boolean
375
+ /**
376
+ * Convenience setting to align input fields of child widgets. By default, the Field input element is
377
+ * placed immediately following the `label`. If you prefer to have all input fields aligned to the
378
+ * right, set this config to `'end'`.
379
+ * ...
380
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-inputFieldAlign)
381
+ */
382
+ inputFieldAlign ? : 'start'|'end'
383
+ /**
384
+ * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
385
+ */
386
+ insertBefore ? : HTMLElement|string
387
+ /**
388
+ * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
389
+ */
390
+ insertFirst ? : HTMLElement|string
391
+ /**
392
+ * See [Keyboard shortcuts](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#keyboard-shortcuts) for details
393
+ */
394
+ keyMap ? : Record<string, KeyMapConfig>
395
+ /**
396
+ * Convenience setting to use same label placement on all child widgets.
397
+ * ...
398
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-labelPosition)
399
+ */
400
+ labelPosition ? : 'before'|'above'|'align-before'|'auto'|null
401
+ /**
402
+ * The listener set for this object.
403
+ * ...
404
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-listeners)
405
+ */
406
+ listeners ? : TreeGridListeners
407
+ /**
408
+ * A [Mask](https://bryntum.com/products/grid/docs/api/Core/widget/Mask) config object, or a message to be shown when a store is performing a remote
409
+ * operation, or Crud Manager is loading data from the sever. Set to `null` to disable default load mask.
410
+ */
411
+ loadMask ? : string|MaskConfig|null
412
+ /**
413
+ * A [Mask](https://bryntum.com/products/grid/docs/api/Core/widget/Mask) config object to adjust the [maskDefaults](#Core/widget/Widget#config-maskDefaults)
414
+ * when data is loading. The message and optional configuration from the
415
+ * [loadMask](https://bryntum.com/products/grid/docs/api/Core/mixin/LoadMaskable#config-loadMask) config take priority over these options, just as they do
416
+ * for `maskDefaults`, respectively.
417
+ * ...
418
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-loadMaskDefaults)
419
+ */
420
+ loadMaskDefaults ? : MaskConfig
421
+ /**
422
+ * A [Mask](https://bryntum.com/products/grid/docs/api/Core/widget/Mask) config object to adjust the [maskDefaults](#Core/widget/Widget#config-maskDefaults)
423
+ * when an error occurs loading data.
424
+ * ...
425
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-loadMaskError)
426
+ */
427
+ loadMaskError ? : MaskConfig|Mask|boolean
428
+ /**
429
+ * Set to `false` to disable localization of this object.
430
+ */
431
+ localizable ? : boolean
432
+ /**
433
+ * Time in ms until a longpress is triggered
434
+ */
435
+ longPressTime ? : number
436
+ /**
437
+ * Widget's margin. This may be configured as a single number or a `TRBL` format string.
438
+ * numeric-only values are interpreted as pixels.
439
+ */
440
+ margin ? : number|string
441
+ /**
442
+ * Grids change the `maskDefaults` to cover only their `body` element.
443
+ */
444
+ maskDefaults ? : MaskConfig
445
+ /**
446
+ * Set to `true` to apply the default mask to the widget. Alternatively, this can be the mask message or a
447
+ * [Mask](https://bryntum.com/products/grid/docs/api/Core/widget/Mask) config object.
448
+ */
449
+ masked ? : boolean|string|MaskConfig
450
+ /**
451
+ * The element's maxHeight. Can be either a String or a Number (which will have 'px' appended). Note that
452
+ * like [height](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-height), *reading* the value will return the numeric value in pixels.
453
+ */
454
+ maxHeight ? : string|number
455
+ /**
456
+ * The elements maxWidth. Can be either a String or a Number (which will have 'px' appended). Note that
457
+ * like [width](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-width), *reading* the value will return the numeric value in pixels.
458
+ */
459
+ maxWidth ? : string|number
460
+ /**
461
+ * Grid's `min-height`. Defaults to `10em` to be sure that the Grid always has a height wherever it is
462
+ * inserted.
463
+ * ...
464
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-minHeight)
465
+ */
466
+ minHeight ? : string|number
467
+ /**
468
+ * The elements minWidth. Can be either a String or a Number (which will have 'px' appended). Note that
469
+ * like [width](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-width), *reading* the value will return the numeric value in pixels.
470
+ */
471
+ minWidth ? : string|number
472
+ /**
473
+ * Grid monitors window resize by default.
474
+ */
475
+ monitorResize ? : boolean
476
+ /**
477
+ * The owning Widget of this Widget. If this Widget is directly contained (that is, it is one of the
478
+ * [items](https://bryntum.com/products/grid/docs/api/Core/widget/Container#property-items) of a Container), this config will be ignored. In this case
479
+ * the owner is <strong>always</strong> the encapsulating Container.
480
+ * ...
481
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-owner)
482
+ */
483
+ owner ? : Widget|any
484
+ /**
485
+ * Specify plugins (an array of classes) in config
486
+ */
487
+ plugins ? : Function[]
488
+ /**
489
+ * True to preserve focused cell after loading new data
490
+ */
491
+ preserveFocusOnDatasetChange ? : boolean
492
+ /**
493
+ * Preserve the grid's vertical scroll position when changesets are applied, as in the case of remote
494
+ * changes, or when stores are configured with [syncDataOnLoad](https://bryntum.com/products/grid/docs/api/Core/data/Store#config-syncDataOnLoad).
495
+ */
496
+ preserveScroll ? : PreserveScrollOptions|boolean
497
+ /**
498
+ * Specify `true` to preserve vertical scroll position after store actions that trigger a `refresh` event,
499
+ * such as loading new data and filtering.
500
+ */
501
+ preserveScrollOnDatasetChange ? : boolean
502
+ /**
503
+ * Prevent tooltip from being displayed on touch devices. Useful for example for buttons that display a
504
+ * menu on click etc, since the tooltip would be displayed at the same time.
505
+ */
506
+ preventTooltipOnTouch ? : boolean
507
+ /**
508
+ * Set to `true` to make the grid read-only, by disabling any UIs for modifying data.
509
+ * ...
510
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-readOnly)
511
+ */
512
+ readOnly ? : boolean
513
+ relayStoreEvents ? : boolean
514
+ /**
515
+ * Either a default `rendition` to apply to all child widgets, or a map of renditions keyed by child widget
516
+ * `type`.
517
+ * ...
518
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-rendition)
519
+ */
520
+ rendition ? : string|Record<string, string>|null
521
+ /**
522
+ * Configure this property to allow the widget/component to be resized. Pressing <kbd>Shift</kbd> while resizing will
523
+ * constrain the aspect ratio.
524
+ * ...
525
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-resizable)
526
+ */
527
+ resizable ? : boolean|{
528
+ minWidth?: number
529
+ maxWidth?: number
530
+ minHeight?: number
531
+ maxHeight?: number
532
+ handles?: object
533
+ }
534
+ /**
535
+ * Set to `false` to only measure cell contents when double-clicking the edge between column headers.
536
+ */
537
+ resizeToFitIncludesHeader ? : boolean
538
+ /**
539
+ * "Break points" for which responsive config to use for columns and css.
540
+ * ...
541
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-responsiveLevels)
542
+ */
543
+ responsiveLevels ? : Record<string, number|string|ResponsiveLevelConfig>
544
+ /**
545
+ * Configure as `true` to have the component display a translucent ripple when its
546
+ * [focusElement](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-focusElement), or [element](#Core/widget/Widget#property-element) is tapped <em>if the
547
+ * current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
548
+ * ...
549
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-ripple)
550
+ */
551
+ ripple ? : boolean|{
552
+ delegate?: string
553
+ color?: string
554
+ radius?: number
555
+ clip?: string
556
+ }
557
+ /**
558
+ * If you are rendering this widget to a shadow root inside a web component, set this config to the shadowRoot. If not inside a web component, set it to `document.body`
559
+ */
560
+ rootElement ? : ShadowRoot|HTMLElement
561
+ /**
562
+ * Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
563
+ * overriden by specifying a [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
564
+ * a column [renderer](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-renderer).
565
+ * ...
566
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-rowHeight)
567
+ */
568
+ rowHeight ? : number
569
+ /**
570
+ * Set to `false` to not show row lines. End result might be overruled by/differ between themes.
571
+ */
572
+ rowLines ? : boolean
573
+ /**
574
+ * This may be configured as `true` to make the widget's element use the `direction:rtl` style.
575
+ * ...
576
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-rtl)
577
+ */
578
+ rtl ? : boolean
579
+ /**
580
+ * Configures whether the grid is scrollable in the `Y` axis. This is used to configure a [Scroller](https://bryntum.com/products/grid/docs/api/Core/helper/util/Scroller).
581
+ * See the [scrollerClass](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-scrollerClass) config option.
582
+ * ...
583
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-scrollable)
584
+ */
585
+ scrollable ? : boolean|ScrollerConfig|Scroller
586
+ /**
587
+ * The class to instantiate to use as the [scrollable](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-scrollable). Defaults to [Scroller](#Core/helper/util/Scroller).
588
+ */
589
+ scrollerClass ? : typeof Scroller
590
+ /**
591
+ * Configuration values for the [ScrollManager](https://bryntum.com/products/grid/docs/api/Core/util/ScrollManager) class on initialization. Returns the
592
+ * [ScrollManager](https://bryntum.com/products/grid/docs/api/Core/util/ScrollManager) at runtime.
593
+ */
594
+ scrollManager ? : ScrollManagerConfig|ScrollManager
595
+ /**
596
+ * Selection configuration settings, change these properties to control how selection works and what can be
597
+ * selected.
598
+ * ...
599
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-selectionMode)
600
+ */
601
+ selectionMode ? : GridSelectionMode
602
+ /**
603
+ * Configure as `true` to have the grid show a red "changed" tag in cells whose
604
+ * field value has changed and not yet been committed.
605
+ * ...
606
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-showDirty)
607
+ */
608
+ showDirty ? : boolean|{
609
+ duringEdit?: boolean
610
+ newRecord?: boolean
611
+ }
612
+ /**
613
+ * Programmatic control over how many columns to span when used in a grid layout.
614
+ */
615
+ span ? : number
616
+ /**
617
+ * This value can be one of the following:
618
+ * ...
619
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-stateful)
620
+ */
621
+ stateful ? : boolean|object|string[]
622
+ /**
623
+ * The events that, when fired by this component, should trigger it to save its state by calling
624
+ * [saveState](https://bryntum.com/products/grid/docs/api/Core/mixin/State#function-saveState).
625
+ * ...
626
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-statefulEvents)
627
+ */
628
+ statefulEvents ? : object|string[]
629
+ /**
630
+ * The key to use when saving this object's state in the [stateProvider](https://bryntum.com/products/grid/docs/api/Core/mixin/State#config-stateProvider). If this config is
631
+ * not assigned, and [stateful](https://bryntum.com/products/grid/docs/api/Core/mixin/State#config-stateful) is not set to `false`, the [id](#Core/widget/Widget#config-id)
632
+ * (if explicitly specified) will be used as the `stateId`.
633
+ * ...
634
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-stateId)
635
+ */
636
+ stateId ? : string
637
+ /**
638
+ * The `StateProvider` to use to save and restore this object's [state](https://bryntum.com/products/grid/docs/api/Core/mixin/State#property-state). By default, `state`
639
+ * will be saved using the [default state provider](https://bryntum.com/products/grid/docs/api/Core/state/StateProvider#property-instance-static).
640
+ * ...
641
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-stateProvider)
642
+ */
643
+ stateProvider ? : StateProvider
644
+ /**
645
+ * The properties of this settings object controls how grid is restored from state data.
646
+ * ...
647
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-stateSettings)
648
+ */
649
+ stateSettings ? : {
650
+ restoreUnconfiguredColumns?: boolean
651
+ }
652
+ /**
653
+ * The store instance or config object that holds the records to be displayed by this TreeGrid. If assigning
654
+ * a store instance, it must be configured with `tree: true`.
655
+ * ...
656
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-store)
657
+ */
658
+ store ? : Store|StoreConfig
659
+ /**
660
+ * An object containing widgets keyed by name. By default (when no `type` is given), strips are
661
+ * [toolbars](https://bryntum.com/products/grid/docs/api/Core/widget/Toolbar). If you want to pass an array, you can use
662
+ * the toolbar's [items](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-items).
663
+ * ...
664
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-strips)
665
+ */
666
+ strips ? : Record<string, GridContainerItemConfig>
667
+ /**
668
+ * An object containing sub grid configuration objects keyed by a `region` property.
669
+ * By default, grid has a 'locked' region (if configured with locked columns) and a 'normal' region.
670
+ * The 'normal' region defaults to use `flex: 1`.
671
+ * ...
672
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-subGridConfigs)
673
+ */
674
+ subGridConfigs ? : Record<string, SubGridConfig>
675
+ /**
676
+ * A [Mask](https://bryntum.com/products/grid/docs/api/Core/widget/Mask) config object, or a message to be shown when Crud Manager
677
+ * is persisting changes on the server. Set to `null` to disable default sync mask.
678
+ * ...
679
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-syncMask)
680
+ */
681
+ syncMask ? : string|MaskConfig|null
682
+ /**
683
+ * A configuration for the [tab](https://bryntum.com/products/grid/docs/api/Core/widget/Tab) created for this widget when it is placed in a
684
+ * [TabPanel](https://bryntum.com/products/grid/docs/api/Core/widget/TabPanel). For example, this config can be used to control the icon of the `tab` for
685
+ * this widget:
686
+ * ...
687
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-tab)
688
+ */
689
+ tab ? : boolean|TabConfig
690
+ /**
691
+ * When this container is used as a tab in a TabPanel, these items are added to the
692
+ * [TabBar](https://bryntum.com/products/grid/docs/api/Core/widget/TabBar) when this container is the active tab.
693
+ * ...
694
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-tabBarItems)
695
+ */
696
+ tabBarItems ? : ToolbarItems[]|Widget[]
697
+ /**
698
+ * A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/grid/docs/api/Core/widget/Toolbar),
699
+ * or array of config objects representing the child items of a Toolbar.
700
+ * This creates a toolbar docked to the top of the panel immediately below the header.
701
+ * ...
702
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-tbar)
703
+ */
704
+ tbar ? : (GridContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
705
+ /**
706
+ * A title to display in the header or owning TabPanel. Causes creation and docking of a header
707
+ * to the top if no header is configured.
708
+ * ...
709
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-title)
710
+ */
711
+ title ? : string
712
+ /**
713
+ * The [tools](https://bryntum.com/products/grid/docs/api/Core/widget/Tool) to add either before or after the `title` in the Panel header. Each
714
+ * property name is the reference by which an instantiated tool may be retrieved from the live
715
+ * `[tools](https://bryntum.com/products/grid/docs/api/Core/widget/mixin/Toolable#property-tools)` property.
716
+ * ...
717
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-tools)
718
+ */
719
+ tools ? : Record<string, ToolConfig>|null
720
+ /**
721
+ * Configure UI transitions for various actions in the grid.
722
+ */
723
+ transition ? : {
724
+ insertRecord?: boolean
725
+ removeRecord?: boolean
726
+ toggleColumn?: boolean
727
+ expandCollapseColumn?: boolean
728
+ toggleRegion?: boolean
729
+ toggleTreeNode?: boolean
730
+ toggleGroup?: boolean
731
+ filterRemoval?: boolean
732
+ }
733
+ /**
734
+ * Animation transition duration in milliseconds.
735
+ */
736
+ transitionDuration ? : number
737
+ type ? : 'treegrid'
738
+ /**
739
+ * Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
740
+ * as a space separated string, an array of strings, or as an object in which property names with truthy
741
+ * values are used as the class names.
742
+ * ...
743
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-ui)
744
+ */
745
+ ui ? : 'plain'|'toolbar'|string|object
746
+ /**
747
+ * A widgets weight determines its position among siblings when added to a [Container](https://bryntum.com/products/grid/docs/api/Core/widget/Container).
748
+ * Higher weights go further down.
749
+ */
750
+ weight ? : number
751
+ /**
752
+ * Widget's width, used to set element `style.width`. Either specify a valid width string or a number, which
753
+ * will get 'px' appended. We recommend using CSS as the primary way to control width, but in some cases
754
+ * this config is convenient.
755
+ */
756
+ width ? : string|number
757
+
758
+ // Features
759
+ /**
760
+ * AI-powered filter feature for Grid. Allows users to type natural language queries to filter grid data.
761
+ * ...
762
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/ai/AIFilter)
763
+ */
764
+ aiFilterFeature ? : object|boolean|string|AIFilter|AIFilterConfig
765
+ /**
766
+ * Allows using `[Ctrl/CMD + C]`, `[Ctrl/CMD + X]` and `[Ctrl/CMD + V]` to cut, copy and paste cell or cell ranges. Also
767
+ * makes cut, copy and paste actions available via the cell context menu.
768
+ * ...
769
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellCopyPaste)
770
+ */
771
+ cellCopyPasteFeature ? : object|boolean|string|CellCopyPaste|CellCopyPasteConfig
772
+ /**
773
+ * Adding this feature to the grid and other Bryntum products which are based on the Grid (i.e. Scheduler, SchedulerPro, and Gantt)
774
+ * enables cell editing. Any subclass of [Field](https://bryntum.com/products/grid/docs/api/Core/widget/Field) can be used
775
+ * as editor for the [Column](https://bryntum.com/products/grid/docs/api/Grid/column/Column). The most popular are:
776
+ * ...
777
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit)
778
+ */
779
+ cellEditFeature ? : object|boolean|string|CellEdit|CellEditConfig
780
+ /**
781
+ * Right click to display context menu for cells. To invoke the cell menu in a keyboard-accessible manner, use the
782
+ * `SPACE` key when the cell is focused.
783
+ * ...
784
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellMenu)
785
+ */
786
+ cellMenuFeature ? : object|boolean|string|CellMenu|CellMenuConfig
787
+ /**
788
+ * Displays a tooltip when hovering cells.
789
+ * ...
790
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellTooltip)
791
+ */
792
+ cellTooltipFeature ? : object|boolean|string|CellTooltip|CellTooltipConfig
793
+ /**
794
+ * Adds interactive charting to a Grid. [Charts](https://bryntum.com/products/grid/docs/api/Chart/widget/Chart) can be created from a selection of Grid data
795
+ * and updated in realtime as data changes. Supports many common chart types with extensive styling and customization
796
+ * options.
797
+ * ...
798
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Charts)
799
+ */
800
+ chartsFeature ? : object|boolean|string|Charts|ChartsConfig
801
+ /**
802
+ * Enables the [autoWidth](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-autoWidth) config for a grid's columns.
803
+ * ...
804
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnAutoWidth)
805
+ */
806
+ columnAutoWidthFeature ? : object|boolean|string|ColumnAutoWidth|ColumnAutoWidthConfig
807
+ /**
808
+ * Displays a toolbar while dragging column headers. Drop on a button in the toolbar to activate a certain function,
809
+ * for example to group by that column. This feature simplifies certain operations on touch devices.
810
+ * ...
811
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnDragToolbar)
812
+ */
813
+ columnDragToolbarFeature ? : object|boolean|string|ColumnDragToolbar|ColumnDragToolbarConfig
814
+ /**
815
+ * Displays a column picker (to show/hide columns) in the header context menu. Columns can be displayed in sub menus
816
+ * by region or tag. Grouped headers are displayed as menu hierarchies.
817
+ * ...
818
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnPicker)
819
+ */
820
+ columnPickerFeature ? : object|boolean|string|ColumnPicker|ColumnPickerConfig
821
+ /**
822
+ * Allows user to rename columns by either right-clicking column header or using keyboard shortcuts when column header
823
+ * is focused.
824
+ * ...
825
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnRename)
826
+ */
827
+ columnRenameFeature ? : object|boolean|string|ColumnRename|ColumnRenameConfig
828
+ /**
829
+ * Allows user to reorder columns by dragging headers. To get notified about column reorder listen to `change` event
830
+ * on [columns](https://bryntum.com/products/grid/docs/api/Grid/data/ColumnStore) store.
831
+ * ...
832
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnReorder)
833
+ */
834
+ columnReorderFeature ? : object|boolean|string|ColumnReorder|ColumnReorderConfig
835
+ /**
836
+ * Enables user to resize columns by dragging a handle on the right hand side of the header. To get notified about column
837
+ * resize listen to `change` event on [columns](https://bryntum.com/products/grid/docs/api/Grid/data/ColumnStore) store.
838
+ * ...
839
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnResize)
840
+ */
841
+ columnResizeFeature ? : object|boolean|string|ColumnResize|ColumnResizeConfig
842
+ /**
843
+ * A feature that allows exporting Grid data to Excel or CSV without involving the server. It uses
844
+ * [TableExporter](https://bryntum.com/products/grid/docs/api/Grid/util/TableExporter) class as data provider, 3rd party provider to generate XLS files, and
845
+ * [Microsoft XML specification](https://msdn.microsoft.com/en-us/library/office/documentformat.openxml.spreadsheet.aspx).
846
+ * ...
847
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/ExcelExporter)
848
+ */
849
+ excelExporterFeature ? : object|boolean|string|ExcelExporter|ExcelExporterConfig
850
+ /**
851
+ * An experimental feature that lets users drop files on a Widget. The widget fires an event when a file is dropped onto it.
852
+ * In the event, you get access to the raw files as strings, that were parsed by calling `readAsBinaryString`.
853
+ * ...
854
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/FileDrop)
855
+ */
856
+ fileDropFeature ? : object|boolean|string|FileDrop|FileDropConfig
857
+ /**
858
+ * This feature adds a fill handle to a Grid range selection, which when dragged, fills the cells being dragged over
859
+ * with values based on the values in the original selected range. This is similar to functionality normally seen in
860
+ * various spreadsheet applications.
861
+ * ...
862
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/FillHandle)
863
+ */
864
+ fillHandleFeature ? : object|boolean|string|FillHandle|FillHandleConfig
865
+ /**
866
+ * Feature that allows filtering of the grid by settings filters on columns. The actual filtering is done by the store.
867
+ * For info on programmatically handling filters, see [StoreFilter](https://bryntum.com/products/grid/docs/api/Core/data/mixin/StoreFilter).
868
+ * ...
869
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Filter)
870
+ */
871
+ filterFeature ? : object|boolean|string|Filter|FilterConfig
872
+ /**
873
+ * Feature that allows filtering of the grid by entering filters on column headers.
874
+ * The actual filtering is done by the store.
875
+ * For info on programmatically handling filters, see [StoreFilter](https://bryntum.com/products/grid/docs/api/Core/data/mixin/StoreFilter).
876
+ * ...
877
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/FilterBar)
878
+ */
879
+ filterBarFeature ? : object|boolean|string|FilterBar|FilterBarConfig
880
+ /**
881
+ * Enables rendering and handling of row groups. The actual grouping is done in the store, but triggered by
882
+ * <kbd>shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
883
+ * one anywhere on grid). Use <kbd>shift</kbd> + <kbd>alt</kbd> + click, or the context menu, to remove a column
884
+ * grouper.
885
+ * ...
886
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Group)
887
+ */
888
+ groupFeature ? : object|boolean|string|Group|GroupConfig
889
+ /**
890
+ * Displays a summary row as a group footer in a grouped grid. Uses the same configuration options on columns as
891
+ * [Summary](https://bryntum.com/products/grid/docs/api/Grid/feature/Summary).
892
+ * ...
893
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/GroupSummary)
894
+ */
895
+ groupSummaryFeature ? : object|boolean|string|GroupSummary|GroupSummaryConfig
896
+ /**
897
+ * Right click column header or focus it and press SPACE key to show the context menu for headers.
898
+ * ...
899
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/HeaderMenu)
900
+ */
901
+ headerMenuFeature ? : object|boolean|string|HeaderMenu|HeaderMenuConfig
902
+ /**
903
+ * This feature allows records which satisfy a certain condition to be locked at the top of the grid.
904
+ * ...
905
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/LockRows)
906
+ */
907
+ lockRowsFeature ? : object|boolean|string|LockRows|LockRowsConfig
908
+ /**
909
+ * This feature merges cells that have the same value in sorted (or [optionally](https://bryntum.com/products/grid/docs/api/Grid/feature/MergeCells#config-sortedOnly) any) columns
910
+ * configured to [mergeCells](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-mergeCells).
911
+ * ...
912
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/MergeCells)
913
+ */
914
+ mergeCellsFeature ? : object|boolean|string|MergeCells|MergeCellsConfig
915
+ /**
916
+ * Generates PDF/PNG files from the Grid component.
917
+ * ...
918
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/export/PdfExport)
919
+ */
920
+ pdfExportFeature ? : object|boolean|string|PdfExport|PdfExportConfig
921
+ /**
922
+ * Allows pinning columns to the start or end region of the grid without any additional subGrid configurations.
923
+ * When pinning to a region that does not yet exist, the feature creates the required subGrid on the fly.
924
+ * ...
925
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/PinColumns)
926
+ */
927
+ pinColumnsFeature ? : object|boolean|string|PinColumns|PinColumnsConfig
928
+ /**
929
+ * Allows printing Grid contents using browser print dialog.
930
+ * ...
931
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/export/Print)
932
+ */
933
+ printFeature ? : object|boolean|string|Print|PrintConfig
934
+ /**
935
+ * Feature that allows the user to search in a column by focusing a cell and typing. Navigate between hits using the
936
+ * keyboard, [f3] or [ctrl]/[cmd] + [g] moves to next, also pressing [shift] moves to previous.
937
+ * ...
938
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/QuickFind)
939
+ */
940
+ quickFindFeature ? : object|boolean|string|QuickFind|QuickFindConfig
941
+ /**
942
+ * Makes the splitter between grid [sections](https://bryntum.com/products/grid/docs/api/Grid/view/SubGrid) draggable, to let users resize, and
943
+ * collapse/expand the sections.
944
+ * ...
945
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/RegionResize)
946
+ */
947
+ regionResizeFeature ? : object|boolean|string|RegionResize|RegionResizeConfig
948
+ /**
949
+ * Allow using [Ctrl/CMD + C/X] and [Ctrl/CMD + V] to copy/cut-and-paste rows. Also makes cut, copy and paste actions
950
+ * available via the cell context menu.
951
+ * ...
952
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowCopyPaste)
953
+ */
954
+ rowCopyPasteFeature ? : object|boolean|string|RowCopyPaste|RowCopyPasteConfig
955
+ /**
956
+ * This feature allows editing of entire rows in a grid in a docked panel which by default slides out from the right.
957
+ * ...
958
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowEdit)
959
+ */
960
+ rowEditFeature ? : object|boolean|string|RowEdit|RowEditConfig
961
+ /**
962
+ * Enables expanding of Grid rows by either row click or double click, or by adding a separate Grid column which renders
963
+ * a button that expands or collapses the row.
964
+ * ...
965
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowExpander)
966
+ */
967
+ rowExpanderFeature ? : object|boolean|string|RowExpander|RowExpanderConfig
968
+ /**
969
+ * Allows user to reorder rows by dragging them. To get notified about row reorder listen to `change` event
970
+ * on the grid [store](https://bryntum.com/products/grid/docs/api/Core/data/Store).
971
+ * ...
972
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowReorder)
973
+ */
974
+ rowReorderFeature ? : object|boolean|string|RowReorder|RowReorderConfig
975
+ /**
976
+ * Enables user to change row height by dragging the bottom row border. After a resize operation, the [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/data/GridRowModel#field-rowHeight)
977
+ * field of the record is updated (when [applyToAllRows](https://bryntum.com/products/grid/docs/api/Grid/feature/RowResize#config-applyToAllRows) is `false`).
978
+ * ...
979
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowResize)
980
+ */
981
+ rowResizeFeature ? : object|boolean|string|RowResize|RowResizeConfig
982
+ /**
983
+ * <div class="external-example vertical" data-file="Grid/feature/Search.js"></div>
984
+ * ...
985
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Search)
986
+ */
987
+ searchFeature ? : object|boolean|string|Search|SearchConfig
988
+ /**
989
+ * Allows sorting of grid by clicking (or tapping) headers, also displays which columns grid is sorted by (numbered if
990
+ * using multisort). Use modifier keys for multisorting: [Ctrl/CMD + click] to add sorter, [Ctrl/CMD + Alt + click] to remove sorter.
991
+ * The actual sorting is done by the store, see [Store.sort()](https://bryntum.com/products/grid/docs/api/Core/data/mixin/StoreSort#function-sort).
992
+ * ...
993
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Sort)
994
+ */
995
+ sortFeature ? : object|boolean|string|Sort|SortConfig
996
+ /**
997
+ * This feature allows splitting the Grid into multiple views, either by using the cell context menu, or
998
+ * programmatically by calling [split()](https://bryntum.com/products/grid/docs/api/Grid/feature/Split#function-split).
999
+ * ...
1000
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Split)
1001
+ */
1002
+ splitFeature ? : object|boolean|string|Split|SplitConfig
1003
+ /**
1004
+ * A feature which pins configurable content from a grid row to the top of the grid
1005
+ * while the row scrolls off the top but is still visible.
1006
+ * ...
1007
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/StickyCells)
1008
+ */
1009
+ stickyCellsFeature ? : object|boolean|string|StickyCells|StickyCellsConfig
1010
+ /**
1011
+ * Stripes rows by adding alternating CSS classes to all row elements (`b-even` and `b-odd`).
1012
+ * ...
1013
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Stripe)
1014
+ */
1015
+ stripeFeature ? : object|boolean|string|Stripe|StripeConfig
1016
+ /**
1017
+ * Displays a summary row in the grid footer.
1018
+ * ...
1019
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Summary)
1020
+ */
1021
+ summaryFeature ? : object|boolean|string|Summary|SummaryConfig
1022
+ /**
1023
+ * Feature that makes the grid work more like a tree. Included by default in [TreeGrid](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid). Requires
1024
+ * exactly one [TreeColumn](https://bryntum.com/products/grid/docs/api/Grid/column/TreeColumn) among grids columns. That column will have its renderer replaced with a
1025
+ * tree renderer that adds padding and icon to give the appearance of a tree. The original renderer is preserved and
1026
+ * also called.
1027
+ * ...
1028
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Tree)
1029
+ */
1030
+ treeFeature ? : object|boolean|string|Tree|TreeConfig
1031
+ /**
1032
+ * A feature that allows transforming a flat dataset (or the leaves of a hierarchical) into a tree by specifying a
1033
+ * record field per parent level. Parents are generated based on each leaf's value for those fields.
1034
+ * ...
1035
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/TreeGroup)
1036
+ */
1037
+ treeGroupFeature ? : object|boolean|string|TreeGroup|TreeGroupConfig
1038
+
1039
+ }
1040
+
1041
+ @Component({
1042
+ selector : 'bryntum-tree-grid',
1043
+ template : ''
1044
+ })
1045
+ export class BryntumTreeGridComponent implements OnInit, OnDestroy {
1046
+
1047
+ public static instanceClass = TreeGrid;
1048
+
1049
+ public static instanceName = 'TreeGrid';
1050
+
1051
+ private static bryntumEvents: string[] = [
1052
+ 'onBeforeCancelCellEdit',
1053
+ 'onBeforeCancelRowEdit',
1054
+ 'onBeforeCellEditStart',
1055
+ 'onBeforeCellRangeDelete',
1056
+ 'onBeforeCellRangeEdit',
1057
+ 'onBeforeColumnDragStart',
1058
+ 'onBeforeColumnDropFinalize',
1059
+ 'onBeforeColumnResize',
1060
+ 'onBeforeCopy',
1061
+ 'onBeforeCSVExport',
1062
+ 'onBeforeDestroy',
1063
+ 'onBeforeExcelExport',
1064
+ 'onBeforeFillHandleDragStart',
1065
+ 'onBeforeFinishCellEdit',
1066
+ 'onBeforeFinishRowEdit',
1067
+ 'onBeforeHide',
1068
+ 'onBeforePaste',
1069
+ 'onBeforePdfExport',
1070
+ 'onBeforeRenderRow',
1071
+ 'onBeforeRenderRows',
1072
+ 'onBeforeRowCollapse',
1073
+ 'onBeforeRowExpand',
1074
+ 'onBeforeSelectionChange',
1075
+ 'onBeforeSetRecord',
1076
+ 'onBeforeShow',
1077
+ 'onBeforeStartRowEdit',
1078
+ 'onBeforeStateApply',
1079
+ 'onBeforeStateSave',
1080
+ 'onBeforeToggleGroup',
1081
+ 'onBeforeToggleNode',
1082
+ 'onCancelCellEdit',
1083
+ 'onCatchAll',
1084
+ 'onCellClick',
1085
+ 'onCellContextMenu',
1086
+ 'onCellDblClick',
1087
+ 'onCellMenuBeforeShow',
1088
+ 'onCellMenuItem',
1089
+ 'onCellMenuShow',
1090
+ 'onCellMenuToggleItem',
1091
+ 'onCellMouseEnter',
1092
+ 'onCellMouseLeave',
1093
+ 'onCellMouseOut',
1094
+ 'onCellMouseOver',
1095
+ 'onCollapse',
1096
+ 'onCollapseNode',
1097
+ 'onColumnDrag',
1098
+ 'onColumnDragStart',
1099
+ 'onColumnDrop',
1100
+ 'onColumnResize',
1101
+ 'onColumnResizeStart',
1102
+ 'onContextMenuItem',
1103
+ 'onContextMenuToggleItem',
1104
+ 'onCopy',
1105
+ 'onDataChange',
1106
+ 'onDestroy',
1107
+ 'onDirtyStateChange',
1108
+ 'onDragSelecting',
1109
+ 'onElementCreated',
1110
+ 'onExpand',
1111
+ 'onExpandNode',
1112
+ 'onFileDrop',
1113
+ 'onFillHandleBeforeDragFinalize',
1114
+ 'onFillHandleDrag',
1115
+ 'onFillHandleDragAbort',
1116
+ 'onFillHandleDragEnd',
1117
+ 'onFillHandleDragStart',
1118
+ 'onFinishCellEdit',
1119
+ 'onFinishRowEdit',
1120
+ 'onFocusIn',
1121
+ 'onFocusOut',
1122
+ 'onGridRowBeforeDragStart',
1123
+ 'onGridRowBeforeDropFinalize',
1124
+ 'onGridRowDrag',
1125
+ 'onGridRowDragAbort',
1126
+ 'onGridRowDragStart',
1127
+ 'onGridRowDrop',
1128
+ 'onHeaderClick',
1129
+ 'onHeaderMenuBeforeShow',
1130
+ 'onHeaderMenuItem',
1131
+ 'onHeaderMenuShow',
1132
+ 'onHeaderMenuToggleItem',
1133
+ 'onHide',
1134
+ 'onLockRows',
1135
+ 'onMouseOut',
1136
+ 'onMouseOver',
1137
+ 'onPaint',
1138
+ 'onPaste',
1139
+ 'onPdfExport',
1140
+ 'onReadOnly',
1141
+ 'onRecompose',
1142
+ 'onRenderRow',
1143
+ 'onRenderRows',
1144
+ 'onResize',
1145
+ 'onResponsive',
1146
+ 'onRowCollapse',
1147
+ 'onRowExpand',
1148
+ 'onRowMouseEnter',
1149
+ 'onRowMouseLeave',
1150
+ 'onScroll',
1151
+ 'onSelectionChange',
1152
+ 'onSelectionModeChange',
1153
+ 'onShow',
1154
+ 'onSplit',
1155
+ 'onSplitterCollapseClick',
1156
+ 'onSplitterDragEnd',
1157
+ 'onSplitterDragStart',
1158
+ 'onSplitterExpandClick',
1159
+ 'onStartCellEdit',
1160
+ 'onStartRowEdit',
1161
+ 'onSubGridCollapse',
1162
+ 'onSubGridExpand',
1163
+ 'onToggleGroup',
1164
+ 'onToggleNode',
1165
+ 'onToolClick',
1166
+ 'onUnlockRows',
1167
+ 'onUnsplit'
1168
+ ];
1169
+
1170
+ private static bryntumFeatureNames: string[] = [
1171
+ 'aiFilterFeature',
1172
+ 'cellCopyPasteFeature',
1173
+ 'cellEditFeature',
1174
+ 'cellMenuFeature',
1175
+ 'cellTooltipFeature',
1176
+ 'chartsFeature',
1177
+ 'columnAutoWidthFeature',
1178
+ 'columnDragToolbarFeature',
1179
+ 'columnPickerFeature',
1180
+ 'columnRenameFeature',
1181
+ 'columnReorderFeature',
1182
+ 'columnResizeFeature',
1183
+ 'excelExporterFeature',
1184
+ 'fileDropFeature',
1185
+ 'fillHandleFeature',
1186
+ 'filterFeature',
1187
+ 'filterBarFeature',
1188
+ 'groupFeature',
1189
+ 'groupSummaryFeature',
1190
+ 'headerMenuFeature',
1191
+ 'lockRowsFeature',
1192
+ 'mergeCellsFeature',
1193
+ 'pdfExportFeature',
1194
+ 'pinColumnsFeature',
1195
+ 'printFeature',
1196
+ 'quickFindFeature',
1197
+ 'regionResizeFeature',
1198
+ 'rowCopyPasteFeature',
1199
+ 'rowEditFeature',
1200
+ 'rowExpanderFeature',
1201
+ 'rowReorderFeature',
1202
+ 'rowResizeFeature',
1203
+ 'searchFeature',
1204
+ 'sortFeature',
1205
+ 'splitFeature',
1206
+ 'stickyCellsFeature',
1207
+ 'stripeFeature',
1208
+ 'summaryFeature',
1209
+ 'treeFeature',
1210
+ 'treeGroupFeature'
1211
+ ];
1212
+
1213
+ private static bryntumConfigs: string[] = BryntumTreeGridComponent.bryntumFeatureNames.concat([
1214
+ 'adopt',
1215
+ 'alignSelf',
1216
+ 'animateFilterRemovals',
1217
+ 'animateRemovingRows',
1218
+ 'animateTreeNodeToggle',
1219
+ 'appendTo',
1220
+ 'ariaDescription',
1221
+ 'ariaLabel',
1222
+ 'autoHeight',
1223
+ 'bbar',
1224
+ 'bodyCls',
1225
+ 'bubbleEvents',
1226
+ 'callOnFunctions',
1227
+ 'catchEventHandlerExceptions',
1228
+ 'cellEllipsis',
1229
+ 'cls',
1230
+ 'collapsed',
1231
+ 'collapsible',
1232
+ 'color',
1233
+ 'column',
1234
+ 'columnLines',
1235
+ 'columns',
1236
+ 'config',
1237
+ 'contentElementCls',
1238
+ 'contextMenuTriggerEvent',
1239
+ 'data',
1240
+ 'dataField',
1241
+ 'dataset',
1242
+ 'defaultRegion',
1243
+ 'destroyStore',
1244
+ 'detectCSSCompatibilityIssues',
1245
+ 'disabled',
1246
+ 'disableGridColumnIdWarning',
1247
+ 'disableGridRowModelWarning',
1248
+ 'dock',
1249
+ 'drawer',
1250
+ 'elementAttributes',
1251
+ 'emptyText',
1252
+ 'enableSticky',
1253
+ 'enableTextSelection',
1254
+ 'enableUndoRedoKeys',
1255
+ 'extraData',
1256
+ 'fillLastColumn',
1257
+ 'fixedRowHeight',
1258
+ 'flex',
1259
+ 'footer',
1260
+ 'formulaProviders',
1261
+ 'fullRowRefresh',
1262
+ 'getRowHeight',
1263
+ 'header',
1264
+ 'height',
1265
+ 'hidden',
1266
+ 'hideFooters',
1267
+ 'hideHeaders',
1268
+ 'hideHorizontalScrollbar',
1269
+ 'hoverCls',
1270
+ 'icon',
1271
+ 'id',
1272
+ 'ignoreParentReadOnly',
1273
+ 'inputFieldAlign',
1274
+ 'insertBefore',
1275
+ 'insertFirst',
1276
+ 'keyMap',
1277
+ 'labelPosition',
1278
+ 'listeners',
1279
+ 'loadMask',
1280
+ 'loadMaskDefaults',
1281
+ 'loadMaskError',
1282
+ 'localizable',
1283
+ 'longPressTime',
1284
+ 'margin',
1285
+ 'maskDefaults',
1286
+ 'masked',
1287
+ 'maxHeight',
1288
+ 'maxWidth',
1289
+ 'minHeight',
1290
+ 'minWidth',
1291
+ 'monitorResize',
1292
+ 'owner',
1293
+ 'plugins',
1294
+ 'preserveFocusOnDatasetChange',
1295
+ 'preserveScroll',
1296
+ 'preserveScrollOnDatasetChange',
1297
+ 'preventTooltipOnTouch',
1298
+ 'readOnly',
1299
+ 'relayStoreEvents',
1300
+ 'rendition',
1301
+ 'resizable',
1302
+ 'resizeToFitIncludesHeader',
1303
+ 'responsiveLevels',
1304
+ 'ripple',
1305
+ 'rootElement',
1306
+ 'rowHeight',
1307
+ 'rowLines',
1308
+ 'rtl',
1309
+ 'scrollable',
1310
+ 'scrollerClass',
1311
+ 'scrollManager',
1312
+ 'selectionMode',
1313
+ 'showDirty',
1314
+ 'span',
1315
+ 'stateful',
1316
+ 'statefulEvents',
1317
+ 'stateId',
1318
+ 'stateProvider',
1319
+ 'stateSettings',
1320
+ 'store',
1321
+ 'strips',
1322
+ 'subGridConfigs',
1323
+ 'syncMask',
1324
+ 'tab',
1325
+ 'tabBarItems',
1326
+ 'tbar',
1327
+ 'title',
1328
+ 'tools',
1329
+ 'transition',
1330
+ 'transitionDuration',
1331
+ 'type',
1332
+ 'ui',
1333
+ 'weight',
1334
+ 'width'
1335
+ ]);
1336
+
1337
+ private static bryntumConfigsOnly: string[] = [
1338
+ 'adopt',
1339
+ 'animateFilterRemovals',
1340
+ 'animateRemovingRows',
1341
+ 'ariaDescription',
1342
+ 'ariaLabel',
1343
+ 'autoHeight',
1344
+ 'bbar',
1345
+ 'bodyCls',
1346
+ 'bubbleEvents',
1347
+ 'collapsible',
1348
+ 'color',
1349
+ 'config',
1350
+ 'contentElementCls',
1351
+ 'contextMenuTriggerEvent',
1352
+ 'dataField',
1353
+ 'defaultRegion',
1354
+ 'destroyStore',
1355
+ 'detectCSSCompatibilityIssues',
1356
+ 'disableGridColumnIdWarning',
1357
+ 'disableGridRowModelWarning',
1358
+ 'dock',
1359
+ 'drawer',
1360
+ 'elementAttributes',
1361
+ 'enableSticky',
1362
+ 'enableTextSelection',
1363
+ 'fillLastColumn',
1364
+ 'fixedRowHeight',
1365
+ 'footer',
1366
+ 'formulaProviders',
1367
+ 'fullRowRefresh',
1368
+ 'getRowHeight',
1369
+ 'header',
1370
+ 'hideHorizontalScrollbar',
1371
+ 'hoverCls',
1372
+ 'icon',
1373
+ 'ignoreParentReadOnly',
1374
+ 'listeners',
1375
+ 'loadMask',
1376
+ 'loadMaskDefaults',
1377
+ 'loadMaskError',
1378
+ 'localizable',
1379
+ 'maskDefaults',
1380
+ 'masked',
1381
+ 'monitorResize',
1382
+ 'owner',
1383
+ 'plugins',
1384
+ 'preserveFocusOnDatasetChange',
1385
+ 'preserveScrollOnDatasetChange',
1386
+ 'preventTooltipOnTouch',
1387
+ 'relayStoreEvents',
1388
+ 'resizable',
1389
+ 'resizeToFitIncludesHeader',
1390
+ 'responsiveLevels',
1391
+ 'ripple',
1392
+ 'rootElement',
1393
+ 'scrollerClass',
1394
+ 'scrollManager',
1395
+ 'showDirty',
1396
+ 'stateful',
1397
+ 'statefulEvents',
1398
+ 'stateId',
1399
+ 'stateProvider',
1400
+ 'strips',
1401
+ 'subGridConfigs',
1402
+ 'syncMask',
1403
+ 'tab',
1404
+ 'tabBarItems',
1405
+ 'tbar',
1406
+ 'type',
1407
+ 'ui',
1408
+ 'weight'
1409
+ ];
1410
+
1411
+ private static bryntumProps: string[] = BryntumTreeGridComponent.bryntumFeatureNames.concat([
1412
+ 'alignSelf',
1413
+ 'animateTreeNodeToggle',
1414
+ 'appendTo',
1415
+ 'callOnFunctions',
1416
+ 'catchEventHandlerExceptions',
1417
+ 'cellEllipsis',
1418
+ 'cls',
1419
+ 'collapsed',
1420
+ 'column',
1421
+ 'columnLines',
1422
+ 'columns',
1423
+ 'data',
1424
+ 'dataset',
1425
+ 'disabled',
1426
+ 'emptyText',
1427
+ 'enableUndoRedoKeys',
1428
+ 'extraData',
1429
+ 'flex',
1430
+ 'focusVisible',
1431
+ 'hasChanges',
1432
+ 'height',
1433
+ 'hidden',
1434
+ 'hideFooters',
1435
+ 'hideHeaders',
1436
+ 'id',
1437
+ 'inputFieldAlign',
1438
+ 'insertBefore',
1439
+ 'insertFirst',
1440
+ 'keyMap',
1441
+ 'labelPosition',
1442
+ 'longPressTime',
1443
+ 'margin',
1444
+ 'maxHeight',
1445
+ 'maxWidth',
1446
+ 'minHeight',
1447
+ 'minWidth',
1448
+ 'originalStore',
1449
+ 'parent',
1450
+ 'preserveScroll',
1451
+ 'readOnly',
1452
+ 'rendition',
1453
+ 'rowHeight',
1454
+ 'rowLines',
1455
+ 'rtl',
1456
+ 'scrollable',
1457
+ 'selectedCell',
1458
+ 'selectedCells',
1459
+ 'selectedRecord',
1460
+ 'selectedRecords',
1461
+ 'selectedRows',
1462
+ 'selectionMode',
1463
+ 'span',
1464
+ 'state',
1465
+ 'stateSettings',
1466
+ 'store',
1467
+ 'title',
1468
+ 'tools',
1469
+ 'tooltip',
1470
+ 'transition',
1471
+ 'transitionDuration',
1472
+ 'width'
1473
+ ]);
1474
+
1475
+ private elementRef: ElementRef;
1476
+ public instance!: TreeGrid;
1477
+
1478
+ private bryntumConfig = {
1479
+ adopt : undefined,
1480
+ appendTo : undefined,
1481
+ href : undefined,
1482
+ angularComponent : this,
1483
+ features : {},
1484
+ listeners : {}
1485
+ };
1486
+
1487
+ constructor(element: ElementRef) {
1488
+ this.elementRef = element;
1489
+ }
1490
+
1491
+ // Configs only
1492
+ @Input() adopt ! : HTMLElement|string;
1493
+ @Input() animateFilterRemovals ! : boolean;
1494
+ @Input() animateRemovingRows ! : boolean;
1495
+ @Input() ariaDescription ! : string;
1496
+ @Input() ariaLabel ! : string;
1497
+ @Input() autoHeight ! : boolean;
1498
+ @Input() bbar ! : (GridContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null;
1499
+ @Input() bodyCls ! : string|object;
1500
+ @Input() bubbleEvents ! : object;
1501
+ @Input() collapsible ! : boolean|PanelCollapserConfig|PanelCollapserOverlayConfig;
1502
+ @Input() color ! : string;
1503
+ @Input() config ! : object;
1504
+ @Input() contentElementCls ! : string|object;
1505
+ @Input() contextMenuTriggerEvent ! : 'contextmenu'|'click'|'dblclick';
1506
+ @Input() dataField ! : string;
1507
+ @Input() defaultRegion ! : string;
1508
+ @Input() destroyStore ! : boolean;
1509
+ @Input() detectCSSCompatibilityIssues ! : boolean;
1510
+ @Input() disableGridColumnIdWarning ! : boolean;
1511
+ @Input() disableGridRowModelWarning ! : boolean;
1512
+ @Input() dock ! : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object;
1513
+ @Input() drawer ! : boolean|{side?: 'start'|'left'|'end'|'right'|'top'|'bottom', size?: string|number, inline?: boolean, autoClose: { mousedown?: boolean|string, focusout?: boolean|string, mouseout?: string }, autoCloseDelay?: number};
1514
+ @Input() elementAttributes ! : Record<string, string|null>;
1515
+ @Input() enableSticky ! : boolean;
1516
+ @Input() enableTextSelection ! : boolean;
1517
+ @Input() fillLastColumn ! : boolean;
1518
+ @Input() fixedRowHeight ! : boolean;
1519
+ @Input() footer ! : {
1520
+ dock?: 'top'|'right'|'bottom'|'left'|'start'|'end'
1521
+ html?: string
1522
+ cls?: string
1523
+ }|string;
1524
+ @Input() formulaProviders ! : Record<string, FormulaProviderConfig>;
1525
+ @Input() fullRowRefresh ! : boolean;
1526
+ @Input() getRowHeight ! : (getRowHeight: { record: Model }) => number;
1527
+ @Input() header ! : string|boolean|PanelHeader;
1528
+ @Input() hideHorizontalScrollbar ! : boolean;
1529
+ @Input() hoverCls ! : string;
1530
+ @Input() icon ! : string|DomConfig;
1531
+ @Input() ignoreParentReadOnly ! : boolean;
1532
+ @Input() listeners ! : TreeGridListeners;
1533
+ @Input() loadMask ! : string|MaskConfig|null;
1534
+ @Input() loadMaskDefaults ! : MaskConfig;
1535
+ @Input() loadMaskError ! : MaskConfig|Mask|boolean;
1536
+ @Input() localizable ! : boolean;
1537
+ @Input() maskDefaults ! : MaskConfig;
1538
+ @Input() masked ! : boolean|string|MaskConfig;
1539
+ @Input() monitorResize ! : boolean;
1540
+ @Input() owner ! : Widget|any;
1541
+ @Input() plugins ! : Function[];
1542
+ @Input() preserveFocusOnDatasetChange ! : boolean;
1543
+ @Input() preserveScrollOnDatasetChange ! : boolean;
1544
+ @Input() preventTooltipOnTouch ! : boolean;
1545
+ @Input() relayStoreEvents ! : boolean;
1546
+ @Input() resizable ! : boolean|{
1547
+ minWidth?: number
1548
+ maxWidth?: number
1549
+ minHeight?: number
1550
+ maxHeight?: number
1551
+ handles?: object
1552
+ };
1553
+ @Input() resizeToFitIncludesHeader ! : boolean;
1554
+ @Input() responsiveLevels ! : Record<string, number|string|ResponsiveLevelConfig>;
1555
+ @Input() ripple ! : boolean|{
1556
+ delegate?: string
1557
+ color?: string
1558
+ radius?: number
1559
+ clip?: string
1560
+ };
1561
+ @Input() rootElement ! : ShadowRoot|HTMLElement;
1562
+ @Input() scrollerClass ! : typeof Scroller;
1563
+ @Input() scrollManager ! : ScrollManagerConfig|ScrollManager;
1564
+ @Input() showDirty ! : boolean|{
1565
+ duringEdit?: boolean
1566
+ newRecord?: boolean
1567
+ };
1568
+ @Input() stateful ! : boolean|object|string[];
1569
+ @Input() statefulEvents ! : object|string[];
1570
+ @Input() stateId ! : string;
1571
+ @Input() stateProvider ! : StateProvider;
1572
+ @Input() strips ! : Record<string, GridContainerItemConfig>;
1573
+ @Input() subGridConfigs ! : Record<string, SubGridConfig>;
1574
+ @Input() syncMask ! : string|MaskConfig|null;
1575
+ @Input() tab ! : boolean|TabConfig;
1576
+ @Input() tabBarItems ! : ToolbarItems[]|Widget[];
1577
+ @Input() tbar ! : (GridContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null;
1578
+ @Input() type ! : 'treegrid';
1579
+ @Input() ui ! : 'plain'|'toolbar'|string|object;
1580
+ @Input() weight ! : number;
1581
+
1582
+ // Configs and properties
1583
+ @Input() alignSelf ! : string;
1584
+ @Input() animateTreeNodeToggle ! : boolean;
1585
+ @Input() appendTo ! : HTMLElement|string;
1586
+ @Input() callOnFunctions ! : boolean;
1587
+ @Input() catchEventHandlerExceptions ! : boolean;
1588
+ @Input() cellEllipsis ! : boolean;
1589
+ @Input() cls ! : string|object;
1590
+ @Input() collapsed ! : boolean;
1591
+ @Input() column ! : number;
1592
+ @Input() columnLines ! : boolean;
1593
+ @Input() columns ! : ColumnStore|GridColumnConfig[]|ColumnStoreConfig;
1594
+ @Input() data ! : object[]|Model[]|ModelConfig[];
1595
+ @Input() dataset ! : object|Record<string, string>;
1596
+ @Input() disabled ! : boolean|'inert';
1597
+ @Input() emptyText ! : string|EmptyTextDomConfig;
1598
+ @Input() enableUndoRedoKeys ! : boolean;
1599
+ @Input() extraData ! : any;
1600
+ @Input() flex ! : number|string;
1601
+ @Input() height ! : number|string;
1602
+ @Input() hidden ! : boolean;
1603
+ @Input() hideFooters ! : boolean;
1604
+ @Input() hideHeaders ! : boolean;
1605
+ @Input() id ! : string;
1606
+ @Input() inputFieldAlign ! : 'start'|'end';
1607
+ @Input() insertBefore ! : HTMLElement|string;
1608
+ @Input() insertFirst ! : HTMLElement|string;
1609
+ @Input() keyMap ! : Record<string, KeyMapConfig>;
1610
+ @Input() labelPosition ! : 'before'|'above'|'align-before'|'auto'|null;
1611
+ @Input() longPressTime ! : number;
1612
+ @Input() margin ! : number|string;
1613
+ @Input() maxHeight ! : string|number;
1614
+ @Input() maxWidth ! : string|number;
1615
+ @Input() minHeight ! : string|number;
1616
+ @Input() minWidth ! : string|number;
1617
+ @Input() preserveScroll ! : PreserveScrollOptions|boolean;
1618
+ @Input() readOnly ! : boolean;
1619
+ @Input() rendition ! : string|Record<string, string>|null;
1620
+ @Input() rowHeight ! : number;
1621
+ @Input() rowLines ! : boolean;
1622
+ @Input() rtl ! : boolean;
1623
+ @Input() scrollable ! : Scroller|boolean|ScrollerConfig;
1624
+ @Input() selectionMode ! : GridSelectionMode;
1625
+ @Input() span ! : number;
1626
+ @Input() stateSettings ! : {
1627
+ restoreUnconfiguredColumns?: boolean
1628
+ };
1629
+ @Input() store ! : Store|StoreConfig|AjaxStore|AjaxStoreConfig;
1630
+ @Input() title ! : string;
1631
+ @Input() tools ! : Record<string, Tool|ToolConfig>|null|Record<string, Tool>|Record<string, ToolConfig>;
1632
+ @Input() transition ! : {
1633
+ insertRecord?: boolean
1634
+ removeRecord?: boolean
1635
+ toggleColumn?: boolean
1636
+ expandCollapseColumn?: boolean
1637
+ toggleRegion?: boolean
1638
+ toggleTreeNode?: boolean
1639
+ toggleGroup?: boolean
1640
+ filterRemoval?: boolean
1641
+ };
1642
+ @Input() transitionDuration ! : number;
1643
+ @Input() width ! : number|string;
1644
+
1645
+ // Properties only
1646
+ @Input() focusVisible ! : boolean;
1647
+ @Input() hasChanges ! : boolean;
1648
+ @Input() originalStore ! : Store;
1649
+ @Input() parent ! : Widget;
1650
+ @Input() selectedCell ! : GridLocation|GridLocationConfig;
1651
+ @Input() selectedCells ! : GridLocation[]|GridLocationConfig[];
1652
+ @Input() selectedRecord ! : Model;
1653
+ @Input() selectedRecords ! : Model[]|number[];
1654
+ @Input() selectedRows ! : Model[]|number[];
1655
+ @Input() state ! : GridStateInfo;
1656
+ @Input() tooltip ! : string|TooltipConfig;
1657
+
1658
+ // Features
1659
+ @Input() aiFilterFeature ! : object|boolean|string|AIFilter|AIFilterConfig;
1660
+ @Input() cellCopyPasteFeature ! : object|boolean|string|CellCopyPaste|CellCopyPasteConfig;
1661
+ @Input() cellEditFeature ! : object|boolean|string|CellEdit|CellEditConfig;
1662
+ @Input() cellMenuFeature ! : object|boolean|string|CellMenu|CellMenuConfig;
1663
+ @Input() cellTooltipFeature ! : object|boolean|string|CellTooltip|CellTooltipConfig;
1664
+ @Input() chartsFeature ! : object|boolean|string|Charts|ChartsConfig;
1665
+ @Input() columnAutoWidthFeature ! : object|boolean|string|ColumnAutoWidth|ColumnAutoWidthConfig;
1666
+ @Input() columnDragToolbarFeature ! : object|boolean|string|ColumnDragToolbar|ColumnDragToolbarConfig;
1667
+ @Input() columnPickerFeature ! : object|boolean|string|ColumnPicker|ColumnPickerConfig;
1668
+ @Input() columnRenameFeature ! : object|boolean|string|ColumnRename|ColumnRenameConfig;
1669
+ @Input() columnReorderFeature ! : object|boolean|string|ColumnReorder|ColumnReorderConfig;
1670
+ @Input() columnResizeFeature ! : object|boolean|string|ColumnResize|ColumnResizeConfig;
1671
+ @Input() excelExporterFeature ! : object|boolean|string|ExcelExporter|ExcelExporterConfig;
1672
+ @Input() fileDropFeature ! : object|boolean|string|FileDrop|FileDropConfig;
1673
+ @Input() fillHandleFeature ! : object|boolean|string|FillHandle|FillHandleConfig;
1674
+ @Input() filterFeature ! : object|boolean|string|Filter|FilterConfig;
1675
+ @Input() filterBarFeature ! : object|boolean|string|FilterBar|FilterBarConfig;
1676
+ @Input() groupFeature ! : object|boolean|string|Group|GroupConfig;
1677
+ @Input() groupSummaryFeature ! : object|boolean|string|GroupSummary|GroupSummaryConfig;
1678
+ @Input() headerMenuFeature ! : object|boolean|string|HeaderMenu|HeaderMenuConfig;
1679
+ @Input() lockRowsFeature ! : object|boolean|string|LockRows|LockRowsConfig;
1680
+ @Input() mergeCellsFeature ! : object|boolean|string|MergeCells|MergeCellsConfig;
1681
+ @Input() pdfExportFeature ! : object|boolean|string|PdfExport|PdfExportConfig;
1682
+ @Input() pinColumnsFeature ! : object|boolean|string|PinColumns|PinColumnsConfig;
1683
+ @Input() printFeature ! : object|boolean|string|Print|PrintConfig;
1684
+ @Input() quickFindFeature ! : object|boolean|string|QuickFind|QuickFindConfig;
1685
+ @Input() regionResizeFeature ! : object|boolean|string|RegionResize|RegionResizeConfig;
1686
+ @Input() rowCopyPasteFeature ! : object|boolean|string|RowCopyPaste|RowCopyPasteConfig;
1687
+ @Input() rowEditFeature ! : object|boolean|string|RowEdit|RowEditConfig;
1688
+ @Input() rowExpanderFeature ! : object|boolean|string|RowExpander|RowExpanderConfig;
1689
+ @Input() rowReorderFeature ! : object|boolean|string|RowReorder|RowReorderConfig;
1690
+ @Input() rowResizeFeature ! : object|boolean|string|RowResize|RowResizeConfig;
1691
+ @Input() searchFeature ! : object|boolean|string|Search|SearchConfig;
1692
+ @Input() sortFeature ! : object|boolean|string|Sort|SortConfig;
1693
+ @Input() splitFeature ! : object|boolean|string|Split|SplitConfig;
1694
+ @Input() stickyCellsFeature ! : object|boolean|string|StickyCells|StickyCellsConfig;
1695
+ @Input() stripeFeature ! : object|boolean|string|Stripe|StripeConfig;
1696
+ @Input() summaryFeature ! : object|boolean|string|Summary|SummaryConfig;
1697
+ @Input() treeFeature ! : object|boolean|string|Tree|TreeConfig;
1698
+ @Input() treeGroupFeature ! : object|boolean|string|TreeGroup|TreeGroupConfig;
1699
+
1700
+ // Events emitters
1701
+ /**
1702
+ * Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
1703
+ * @param {object} event Event object
1704
+ * @param {Grid.view.Grid} event.source Owner grid
1705
+ * @param {Grid.util.GridLocation} event.editorContext Editing context
1706
+ */
1707
+ @Output() onBeforeCancelCellEdit: any = new EventEmitter<((event: { source: Grid, editorContext: GridLocation }) => Promise<boolean>|boolean|void)|string>();
1708
+ /**
1709
+ * Fires on the owning Grid before the row editing is canceled, return false to signal that the value is invalid and editing should not be finalized.
1710
+ * ...
1711
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-beforeCancelRowEdit)
1712
+ * @param {object} event Event object
1713
+ * @param {Grid.view.Grid} event.grid Target grid
1714
+ * @param {RowEditorContext} event.editorContext Editing context
1715
+ */
1716
+ @Output() onBeforeCancelRowEdit: any = new EventEmitter<((event: { grid: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string>();
1717
+ /**
1718
+ * Fires on the owning Grid before editing starts, return `false` to prevent editing
1719
+ * @param {object} event Event object
1720
+ * @param {Grid.view.Grid} event.source Owner grid
1721
+ * @param {CellEditorContext} event.editorContext Editing context
1722
+ */
1723
+ @Output() onBeforeCellEditStart: any = new EventEmitter<((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string>();
1724
+ /**
1725
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
1726
+ * buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
1727
+ * @param {object} event Event object
1728
+ * @param {Grid.view.Grid} event.source Owner grid
1729
+ * @param {(Grid.util.GridLocation|Core.data.Model)[]} event.gridSelection An array of cell selectors or records that will have their values deleted (the records themselves will not get deleted, only visible column values).
1730
+ */
1731
+ @Output() onBeforeCellRangeDelete: any = new EventEmitter<((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => Promise<boolean>|boolean|void)|string>();
1732
+ /**
1733
+ * Fires for each selected record on the owning Grid before editing a range of selected cell values
1734
+ * @param {object} event Event object
1735
+ * @param {Core.data.Model} event.record Current selected record from the range
1736
+ * @param {string} event.field The field being changed
1737
+ * @param {any} event.value The value being set
1738
+ */
1739
+ @Output() onBeforeCellRangeEdit: any = new EventEmitter<((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string>();
1740
+ /**
1741
+ * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
1742
+ * @param {object} event Event object
1743
+ * @param {Grid.view.Grid} event.source The grid instance.
1744
+ * @param {Grid.column.Column} event.column The dragged column.
1745
+ * @param {Event} event.event The browser event.
1746
+ */
1747
+ @Output() onBeforeColumnDragStart: any = new EventEmitter<((event: { source: Grid, column: Column, event: Event }) => Promise<boolean>|boolean|void)|string>();
1748
+ /**
1749
+ * This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
1750
+ * @param {object} event Event object
1751
+ * @param {Grid.view.Grid} event.source The grid instance.
1752
+ * @param {Grid.column.Column} event.column The dragged column.
1753
+ * @param {Grid.column.Column} event.insertBefore The column before which the dragged column will be inserted.
1754
+ * @param {Grid.column.Column} event.newParent The new parent column.
1755
+ * @param {Event} event.event The browser event.
1756
+ * @param {string} event.region The region where the column was dropped.
1757
+ */
1758
+ @Output() onBeforeColumnDropFinalize: any = new EventEmitter<((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => Promise<boolean>|boolean|void)|string>();
1759
+ /**
1760
+ * This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
1761
+ * `false`.
1762
+ * @param {object} event Event object
1763
+ * @param {Grid.view.Grid} event.source The grid instance
1764
+ * @param {Grid.column.Column} event.column The column
1765
+ * @param {Event} event.domEvent The browser event
1766
+ */
1767
+ @Output() onBeforeColumnResize: any = new EventEmitter<((event: { source: Grid, column: Column, domEvent: Event }) => Promise<boolean>|boolean|void)|string>();
1768
+ /**
1769
+ * Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
1770
+ * @param {object} event Event object
1771
+ * @param {Grid.view.Grid} event.source Owner grid
1772
+ * @param {Grid.util.GridLocation[]} event.cells The cells about to be copied or cut
1773
+ * @param {string} event.data The string data about to be copied or cut
1774
+ * @param {boolean} event.isCut `true` if this is a cut action
1775
+ * @param {string} event.entityName 'cell' to distinguish this event from other beforeCopy events
1776
+ */
1777
+ @Output() onBeforeCopy: any = new EventEmitter<((event: { source: Grid, cells: GridLocation[], data: string, isCut: boolean, entityName: string }) => Promise<boolean>|boolean|void)|string>();
1778
+ /**
1779
+ * Fires on the owning Grid before CSV export starts. Return `false` to cancel the export.
1780
+ * @param {object} event Event object
1781
+ * @param {ExportConfig} event.config Export config
1782
+ * @param {Grid.column.Column[]} event.columns An array of columns to export
1783
+ * @param {Core.data.Model[]} event.rows An array of records to export
1784
+ * @param {string} event.lineDelimiter The CSV delimiter to separate lines
1785
+ * @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
1786
+ */
1787
+ @Output() onBeforeCSVExport: any = new EventEmitter<((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => Promise<boolean>|boolean|void)|string>();
1788
+ /**
1789
+ * Fires before an object is destroyed.
1790
+ * @param {object} event Event object
1791
+ * @param {Core.Base} event.source The Object that is being destroyed.
1792
+ */
1793
+ @Output() onBeforeDestroy: any = new EventEmitter<((event: { source: Base }) => void)|string>();
1794
+ /**
1795
+ * Fires on the owning Grid before Excel export starts. Return `false` to cancel the export.
1796
+ * @param {object} event Event object
1797
+ * @param {ExportConfig} event.config Export config
1798
+ * @param {XLSColumn[]} event.columns An array of columns to export
1799
+ * @param {any[][]} event.rows An array of records to export
1800
+ */
1801
+ @Output() onBeforeExcelExport: any = new EventEmitter<((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => Promise<boolean>|boolean|void)|string>();
1802
+ /**
1803
+ * Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
1804
+ * @param {object} event Event object
1805
+ * @param {Grid.util.GridLocation} event.cell Information about the column / record
1806
+ * @param {MouseEvent} event.domEvent The raw DOM event
1807
+ */
1808
+ @Output() onBeforeFillHandleDragStart: any = new EventEmitter<((event: { cell: GridLocation, domEvent: MouseEvent }) => Promise<boolean>|boolean|void)|string>();
1809
+ /**
1810
+ * Fires on the owning Grid before the cell editing is finished, return false to signal that the value is invalid and editing should not be finalized.
1811
+ * @param {object} event Event object
1812
+ * @param {Grid.view.Grid} event.grid Target grid
1813
+ * @param {CellEditorContext} event.editorContext Editing context
1814
+ */
1815
+ @Output() onBeforeFinishCellEdit: any = new EventEmitter<((event: { grid: Grid, editorContext: CellEditorContext }) => void)|string>();
1816
+ /**
1817
+ * Fires on the owning Grid before the row editing is finished, return false to signal that the value is invalid and editing should not be finalized.
1818
+ * ...
1819
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-beforeFinishRowEdit)
1820
+ * @param {object} event Event object
1821
+ * @param {Grid.view.Grid} event.grid Target grid
1822
+ * @param {RowEditorContext} event.editorContext Editing context
1823
+ */
1824
+ @Output() onBeforeFinishRowEdit: any = new EventEmitter<((event: { grid: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string>();
1825
+ /**
1826
+ * Triggered before a widget is hidden. Return `false` to prevent the action.
1827
+ * @param {object} event Event object
1828
+ * @param {Core.widget.Widget} event.source The widget being hidden.
1829
+ */
1830
+ @Output() onBeforeHide: any = new EventEmitter<((event: { source: Widget }) => Promise<boolean>|boolean|void)|string>();
1831
+ /**
1832
+ * Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
1833
+ * @param {object} event Event object
1834
+ * @param {Grid.view.Grid} event.source Owner grid
1835
+ * @param {string} event.clipboardData The clipboardData about to be pasted
1836
+ * @param {Grid.util.GridLocation} event.targetCell The cell from which the paste will be started
1837
+ * @param {string} event.entityName 'cell' to distinguish this event from other beforePaste events
1838
+ * @param {string} event.text The raw text from clipboard
1839
+ */
1840
+ @Output() onBeforePaste: any = new EventEmitter<((event: { source: Grid, clipboardData: string, targetCell: GridLocation, entityName: string, text: string }) => Promise<boolean>|boolean|void)|string>();
1841
+ /**
1842
+ * Fires on the owning Grid before export started. Return `false` to cancel the export.
1843
+ * @param {object} event Event object
1844
+ * @param {PdfExportConfig} event.config Export config
1845
+ */
1846
+ @Output() onBeforePdfExport: any = new EventEmitter<((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string>();
1847
+ /**
1848
+ * Fires before a row is rendered.
1849
+ * @param {object} event Event object
1850
+ * @param {Grid.view.Grid} event.source The firing Grid instance.
1851
+ * @param {Grid.row.Row} event.row The row about to be rendered.
1852
+ * @param {Core.data.Model} event.record The record for the row.
1853
+ * @param {number} event.recordIndex The zero-based index of the record.
1854
+ */
1855
+ @Output() onBeforeRenderRow: any = new EventEmitter<((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string>();
1856
+ /**
1857
+ * Grid rows are about to be rendered
1858
+ * @param {object} event Event object
1859
+ * @param {Grid.view.Grid} event.source This grid.
1860
+ */
1861
+ @Output() onBeforeRenderRows: any = new EventEmitter<((event: { source: Grid }) => void)|string>();
1862
+ /**
1863
+ * This event fires before row collapse is started.
1864
+ * ...
1865
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-beforeRowCollapse)
1866
+ * @param {object} event Event object
1867
+ * @param {Core.data.Model} event.record Record
1868
+ */
1869
+ @Output() onBeforeRowCollapse: any = new EventEmitter<((event: { record: Model }) => Promise<boolean>|boolean|void)|string>();
1870
+ /**
1871
+ * This event fires before row expand is started.
1872
+ * ...
1873
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-beforeRowExpand)
1874
+ * @param {object} event Event object
1875
+ * @param {Core.data.Model} event.record Record
1876
+ */
1877
+ @Output() onBeforeRowExpand: any = new EventEmitter<((event: { record: Model }) => Promise<boolean>|boolean|void)|string>();
1878
+ /**
1879
+ * Fires before the selection changes. Returning `false` from a listener prevents the change
1880
+ * @param {object} event Event object
1881
+ * @param {string} event.action `'select'`/`'deselect'`
1882
+ * @param {'row','cell'} event.mode `'row'`/`'cell'`
1883
+ * @param {Grid.view.Grid} event.source
1884
+ * @param {Core.data.Model[]} event.deselected The records to be deselected in this operation.
1885
+ * @param {Core.data.Model[]} event.selected The records to be selected in this operation.
1886
+ * @param {Core.data.Model[]} event.selection The records in the current selection, before applying `selected` and `deselected`
1887
+ * @param {Grid.util.GridLocation[]} event.deselectedCells The cells to be deselected in this operation.
1888
+ * @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
1889
+ * @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
1890
+ */
1891
+ @Output() onBeforeSelectionChange: any = new EventEmitter<((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => Promise<boolean>|boolean|void)|string>();
1892
+ /**
1893
+ * Fired before this container will load record values into its child fields. This is useful if you
1894
+ * want to modify the UI before data is loaded (e.g. set some input field to be readonly)
1895
+ * @param {object} event Event object
1896
+ * @param {Core.widget.Container} event.source The container
1897
+ * @param {Core.data.Model} event.record The record
1898
+ */
1899
+ @Output() onBeforeSetRecord: any = new EventEmitter<((event: { source: Container, record: Model }) => void)|string>();
1900
+ /**
1901
+ * Triggered before a widget is shown. Return `false` to prevent the action.
1902
+ * @param {object} event Event object
1903
+ * @param {Core.widget.Widget,any} event.source The widget being shown
1904
+ */
1905
+ @Output() onBeforeShow: any = new EventEmitter<((event: { source: Widget|any }) => Promise<boolean>|boolean|void)|string>();
1906
+ /**
1907
+ * Fires on the owning Grid before editing starts, return `false` to prevent editing
1908
+ * @param {object} event Event object
1909
+ * @param {Grid.view.Grid} event.source Owner grid
1910
+ * @param {RowEditorContext} event.editorContext Editing context
1911
+ */
1912
+ @Output() onBeforeStartRowEdit: any = new EventEmitter<((event: { source: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string>();
1913
+ /**
1914
+ * Fired before state is applied to the source. Allows editing the state object or preventing the operation.
1915
+ * @param {object} event Event object
1916
+ * @param {GridStateInfo} event.state State object config
1917
+ */
1918
+ @Output() onBeforeStateApply: any = new EventEmitter<((event: { state: GridStateInfo }) => Promise<boolean>|boolean|void)|string>();
1919
+ /**
1920
+ * Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
1921
+ * @param {object} event Event object
1922
+ * @param {GridStateInfo} event.state State object config
1923
+ */
1924
+ @Output() onBeforeStateSave: any = new EventEmitter<((event: { state: GridStateInfo }) => Promise<boolean>|boolean|void)|string>();
1925
+ /**
1926
+ * Fired when a group is going to be expanded or collapsed using the UI.
1927
+ * Returning `false` from a listener prevents the operation
1928
+ * @param {object} event Event object
1929
+ * @param {Core.data.Model} event.groupRecord [DEPRECATED] Use `groupRecords` param instead
1930
+ * @param {Core.data.Model[]} event.groupRecords The group records being toggled
1931
+ * @param {boolean} event.collapse Collapsed (true) or expanded (false)
1932
+ * @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
1933
+ */
1934
+ @Output() onBeforeToggleGroup: any = new EventEmitter<((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => Promise<boolean>|boolean|void)|string>();
1935
+ /**
1936
+ * Fired before a parent node record toggles its collapsed state.
1937
+ * @param {object} event Event object
1938
+ * @param {Grid.view.Grid} event.source The firing Grid instance.
1939
+ * @param {Core.data.Model} event.record The record being toggled.
1940
+ * @param {boolean} event.collapse `true` if the node is being collapsed.
1941
+ */
1942
+ @Output() onBeforeToggleNode: any = new EventEmitter<((event: { source: Grid, record: Model, collapse: boolean }) => void)|string>();
1943
+ /**
1944
+ * Fires on the owning Grid when editing is cancelled
1945
+ * @param {object} event Event object
1946
+ * @param {Grid.view.Grid} event.source Owner grid
1947
+ * @param {Grid.util.GridLocation} event.editorContext Editing context
1948
+ * @param {Event} event.event Included if the cancellation was triggered by a DOM event
1949
+ */
1950
+ @Output() onCancelCellEdit: any = new EventEmitter<((event: { source: Grid, editorContext: GridLocation, event: Event }) => void)|string>();
1951
+ /**
1952
+ * Fires when any other event is fired from the object.
1953
+ * ...
1954
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-catchAll)
1955
+ * @param {object} event Event object
1956
+ * @param {{[key: string]: any, type: string}} event.event The Object that contains event details
1957
+ * @param {string} event.event.type The type of the event which is caught by the listener
1958
+ */
1959
+ @Output() onCatchAll: any = new EventEmitter<((event: {[key: string]: any, type: string}) => void)|string>();
1960
+ /**
1961
+ * Fired when user clicks in a grid cell
1962
+ * @param {object} event Event object
1963
+ * @param {Grid.view.Grid} event.grid The grid instance
1964
+ * @param {Core.data.Model} event.record The record representing the row
1965
+ * @param {Grid.column.Column} event.column The column to which the cell belongs
1966
+ * @param {HTMLElement} event.cellElement The cell HTML element
1967
+ * @param {HTMLElement} event.target The target element
1968
+ * @param {MouseEvent} event.event The native DOM event
1969
+ */
1970
+ @Output() onCellClick: any = new EventEmitter<((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string>();
1971
+ /**
1972
+ * Fired when user activates contextmenu in a grid cell
1973
+ * @param {object} event Event object
1974
+ * @param {Grid.view.Grid} event.grid The grid instance
1975
+ * @param {Core.data.Model} event.record The record representing the row
1976
+ * @param {Grid.column.Column} event.column The column to which the cell belongs
1977
+ * @param {HTMLElement} event.cellElement The cell HTML element
1978
+ * @param {HTMLElement} event.target The target element
1979
+ * @param {MouseEvent} event.event The native DOM event
1980
+ */
1981
+ @Output() onCellContextMenu: any = new EventEmitter<((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string>();
1982
+ /**
1983
+ * Fired when user double clicks a grid cell
1984
+ * @param {object} event Event object
1985
+ * @param {Grid.view.Grid} event.grid The grid instance
1986
+ * @param {Core.data.Model} event.record The record representing the row
1987
+ * @param {Grid.column.Column} event.column The column to which the cell belongs
1988
+ * @param {HTMLElement} event.cellElement The cell HTML element
1989
+ * @param {HTMLElement} event.target The target element
1990
+ * @param {MouseEvent} event.event The native DOM event
1991
+ */
1992
+ @Output() onCellDblClick: any = new EventEmitter<((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string>();
1993
+ /**
1994
+ * This event fires on the owning grid before the context menu is shown for a cell.
1995
+ * Allows manipulation of the items to show in the same way as in the [processItems](https://bryntum.com/products/grid/docs/api/Grid/feature/CellMenu#config-processItems).
1996
+ * ...
1997
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-cellMenuBeforeShow)
1998
+ * @param {object} event Event object
1999
+ * @param {Grid.view.Grid} event.source The grid
2000
+ * @param {Core.widget.Menu} event.menu The menu
2001
+ * @param {Record<string, MenuItemEntry>} event.items Menu item configs
2002
+ * @param {Grid.column.Column} event.column Column
2003
+ * @param {Core.data.Model} event.record Record
2004
+ */
2005
+ @Output() onCellMenuBeforeShow: any = new EventEmitter<((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => Promise<boolean>|boolean|void)|string>();
2006
+ /**
2007
+ * This event fires on the owning grid when an item is selected in the cell context menu.
2008
+ * @param {object} event Event object
2009
+ * @param {Grid.view.Grid} event.source The grid
2010
+ * @param {Core.widget.Menu} event.menu The menu
2011
+ * @param {Core.widget.MenuItem} event.item Selected menu item
2012
+ * @param {Grid.column.Column} event.column Column
2013
+ * @param {Core.data.Model} event.record Record
2014
+ */
2015
+ @Output() onCellMenuItem: any = new EventEmitter<((event: { source: Grid, menu: Menu, item: MenuItem, column: Column, record: Model }) => void)|string>();
2016
+ /**
2017
+ * This event fires on the owning grid after the context menu is shown for a cell.
2018
+ * @param {object} event Event object
2019
+ * @param {Grid.view.Grid} event.source The grid
2020
+ * @param {Core.widget.Menu} event.menu The menu
2021
+ * @param {Record<string, MenuItemEntry>} event.items Menu item configs
2022
+ * @param {Grid.column.Column} event.column Column
2023
+ * @param {Core.data.Model} event.record Record
2024
+ */
2025
+ @Output() onCellMenuShow: any = new EventEmitter<((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => void)|string>();
2026
+ /**
2027
+ * This event fires on the owning grid when a check item is toggled in the cell context menu.
2028
+ * @param {object} event Event object
2029
+ * @param {Grid.view.Grid} event.source The grid
2030
+ * @param {Core.widget.Menu} event.menu The menu
2031
+ * @param {Core.widget.MenuItem} event.item Selected menu item
2032
+ * @param {Grid.column.Column} event.column Column
2033
+ * @param {Core.data.Model} event.record Record
2034
+ * @param {boolean} event.checked Checked or not
2035
+ */
2036
+ @Output() onCellMenuToggleItem: any = new EventEmitter<((event: { source: Grid, menu: Menu, item: MenuItem, column: Column, record: Model, checked: boolean }) => void)|string>();
2037
+ /**
2038
+ * Fired when the mouse enters a cell
2039
+ * @param {object} event Event object
2040
+ * @param {Grid.view.Grid} event.source The grid instance
2041
+ * @param {Core.data.Model} event.record The record representing the hovered cell
2042
+ * @param {Grid.column.Column} event.column The column currently hovered
2043
+ * @param {HTMLElement} event.cellElement The cell HTML element
2044
+ * @param {MouseEvent} event.event The native DOM event
2045
+ */
2046
+ @Output() onCellMouseEnter: any = new EventEmitter<((event: { source: Grid, record: Model, column: Column, cellElement: HTMLElement, event: MouseEvent }) => void)|string>();
2047
+ /**
2048
+ * Fired when the mouse leaves a cell
2049
+ * @param {object} event Event object
2050
+ * @param {Grid.view.Grid} event.source The grid instance
2051
+ * @param {Core.data.Model} event.record The record representing the cell that the mouse left
2052
+ * @param {Grid.column.Column} event.column The column representing the cell that the mouse left
2053
+ * @param {HTMLElement} event.cellElement The cell HTML element that the mouse left
2054
+ * @param {MouseEvent} event.event The native DOM event
2055
+ */
2056
+ @Output() onCellMouseLeave: any = new EventEmitter<((event: { source: Grid, record: Model, column: Column, cellElement: HTMLElement, event: MouseEvent }) => void)|string>();
2057
+ /**
2058
+ * Fired when a user moves the mouse out of a grid cell
2059
+ * @param {object} event Event object
2060
+ * @param {Grid.view.Grid} event.grid The grid instance
2061
+ * @param {Core.data.Model} event.record The record representing the row
2062
+ * @param {Grid.column.Column} event.column The column to which the cell belongs
2063
+ * @param {HTMLElement} event.cellElement The cell HTML element
2064
+ * @param {HTMLElement} event.target The target element
2065
+ * @param {MouseEvent} event.event The native DOM event
2066
+ */
2067
+ @Output() onCellMouseOut: any = new EventEmitter<((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string>();
2068
+ /**
2069
+ * Fired when user moves the mouse over a grid cell
2070
+ * @param {object} event Event object
2071
+ * @param {Grid.view.Grid} event.grid The grid instance
2072
+ * @param {Core.data.Model} event.record The record representing the row
2073
+ * @param {Grid.column.Column} event.column The column to which the cell belongs
2074
+ * @param {HTMLElement} event.cellElement The cell HTML element
2075
+ * @param {HTMLElement} event.target The target element
2076
+ * @param {MouseEvent} event.event The native DOM event
2077
+ */
2078
+ @Output() onCellMouseOver: any = new EventEmitter<((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string>();
2079
+ /**
2080
+ * Fires when a Panel is collapsed using the [collapsible](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-collapsible) setting.
2081
+ * @param {object} event Event object
2082
+ * @param {Core.widget.Panel} event.source This Panel.
2083
+ */
2084
+ @Output() onCollapse: any = new EventEmitter<((event: { source: Panel }) => void)|string>();
2085
+ /**
2086
+ * Fired before a parent node record is collapsed.
2087
+ * @param {object} event Event object
2088
+ * @param {Grid.view.Grid} event.source The firing Grid instance.
2089
+ * @param {Core.data.Model} event.record The record which has been collapsed.
2090
+ */
2091
+ @Output() onCollapseNode: any = new EventEmitter<((event: { source: Grid, record: Model }) => void)|string>();
2092
+ /**
2093
+ * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
2094
+ * to indicate whether the drop position is valid or not.
2095
+ * @param {object} event Event object
2096
+ * @param {Grid.view.Grid} event.source The grid instance.
2097
+ * @param {Grid.column.Column} event.column The dragged column.
2098
+ * @param {Grid.column.Column} event.insertBefore The column before which the dragged column will be inserted (if not last).
2099
+ * @param {Event} event.event The browser event.
2100
+ * @param {object} event.context
2101
+ * @param {boolean} event.context.valid Set this to `true` or `false` to indicate whether the drop position is valid.
2102
+ */
2103
+ @Output() onColumnDrag: any = new EventEmitter<((event: { source: Grid, column: Column, insertBefore: Column, event: Event, context: { valid: boolean } }) => void)|string>();
2104
+ /**
2105
+ * This event is fired when a column drag gesture has started.
2106
+ * @param {object} event Event object
2107
+ * @param {Grid.view.Grid} event.source The grid instance.
2108
+ * @param {Grid.column.Column} event.column The dragged column.
2109
+ * @param {Event} event.event The browser event.
2110
+ */
2111
+ @Output() onColumnDragStart: any = new EventEmitter<((event: { source: Grid, column: Column, event: Event }) => void)|string>();
2112
+ /**
2113
+ * This event is always fired after a column is dropped. The `valid` param is `true` if the operation was not
2114
+ * vetoed and the column was moved in the column store.
2115
+ * @param {object} event Event object
2116
+ * @param {Grid.view.Grid} event.source The grid instance.
2117
+ * @param {Grid.column.Column} event.column The dragged column.
2118
+ * @param {Grid.column.Column} event.insertBefore The column before which the dragged column will be inserted.
2119
+ * @param {Grid.column.Column} event.newParent The new parent column.
2120
+ * @param {boolean} event.valid `true` if the operation was not vetoed.
2121
+ * @param {Event} event.event The browser event.
2122
+ * @param {string} event.region The region where the column was dropped.
2123
+ */
2124
+ @Output() onColumnDrop: any = new EventEmitter<((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => Promise<boolean>|boolean|void)|string>();
2125
+ /**
2126
+ * This event is fired after a resize gesture is completed.
2127
+ * @param {object} event Event object
2128
+ * @param {Grid.view.Grid} event.source The grid instance
2129
+ * @param {Grid.column.Column} event.column The resized column
2130
+ * @param {Event} event.domEvent The browser event
2131
+ */
2132
+ @Output() onColumnResize: any = new EventEmitter<((event: { source: Grid, column: Column, domEvent: Event }) => void)|string>();
2133
+ /**
2134
+ * This event is fired when a column resize gesture starts.
2135
+ * @param {object} event Event object
2136
+ * @param {Grid.view.Grid} event.source The grid instance
2137
+ * @param {Grid.column.Column} event.column The column
2138
+ * @param {Event} event.domEvent The browser event
2139
+ */
2140
+ @Output() onColumnResizeStart: any = new EventEmitter<((event: { source: Grid, column: Column, domEvent: Event }) => void)|string>();
2141
+ /**
2142
+ * This event fires on the owning widget when an item is selected in the context menu.
2143
+ * @param {object} event Event object
2144
+ * @param {Core.widget.Widget} event.source The owning widget
2145
+ * @param {Core.widget.Menu} event.menu The menu
2146
+ * @param {Core.widget.MenuItem} event.item Selected menu item
2147
+ */
2148
+ @Output() onContextMenuItem: any = new EventEmitter<((event: { source: Widget, menu: Menu, item: MenuItem }) => void)|string>();
2149
+ /**
2150
+ * This event fires on the owning widget when a check item is toggled in the context menu.
2151
+ * @param {object} event Event object
2152
+ * @param {Core.widget.Widget} event.source The owning widget
2153
+ * @param {Core.widget.Menu} event.menu The menu
2154
+ * @param {Core.widget.MenuItem} event.item Selected menu item
2155
+ * @param {boolean} event.checked Checked or not
2156
+ */
2157
+ @Output() onContextMenuToggleItem: any = new EventEmitter<((event: { source: Widget, menu: Menu, item: MenuItem, checked: boolean }) => void)|string>();
2158
+ /**
2159
+ * Fires on the owning Grid after a copy action is performed.
2160
+ * @param {object} event Event object
2161
+ * @param {Grid.view.Grid} event.source Owner grid
2162
+ * @param {Grid.util.GridLocation[]} event.cells The cells about to be copied or cut
2163
+ * @param {string} event.copiedDataString The concatenated data string that was copied or cut
2164
+ * @param {boolean} event.isCut `true` if this was a cut action
2165
+ * @param {string} event.entityName 'cell' to distinguish this event from other copy events
2166
+ */
2167
+ @Output() onCopy: any = new EventEmitter<((event: { source: Grid, cells: GridLocation[], copiedDataString: string, isCut: boolean, entityName: string }) => void)|string>();
2168
+ /**
2169
+ * Fired when data in the store changes.
2170
+ * ...
2171
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-dataChange)
2172
+ * @param {object} event Event object
2173
+ * @param {Grid.view.Grid} event.source Owning grid
2174
+ * @param {Core.data.Store} event.store The originating store
2175
+ * @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
2176
+ * @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
2177
+ * @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
2178
+ * @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
2179
+ */
2180
+ @Output() onDataChange: any = new EventEmitter<((event: { source: Grid, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string>();
2181
+ /**
2182
+ * Fires when an object is destroyed.
2183
+ * @param {object} event Event object
2184
+ * @param {Core.Base} event.source The Object that is being destroyed.
2185
+ */
2186
+ @Output() onDestroy: any = new EventEmitter<((event: { source: Base }) => void)|string>();
2187
+ /**
2188
+ * Fires when a field is mutated and the state of the [hasChanges](https://bryntum.com/products/grid/docs/api/Core/widget/Container#property-hasChanges) property changes
2189
+ * @param {object} event Event object
2190
+ * @param {Core.widget.Container} event.source The container.
2191
+ * @param {boolean} event.dirty The dirty state of the Container - `true` if there are any fields which have been changed since initial load.
2192
+ */
2193
+ @Output() onDirtyStateChange: any = new EventEmitter<((event: { source: Container, dirty: boolean }) => void)|string>();
2194
+ /**
2195
+ * Fires while drag selecting. UI will update with current range, but the cells will not be selected until
2196
+ * mouse up. This event can be listened for to perform actions while drag selecting.
2197
+ * @param {object} event Event object
2198
+ * @param {Grid.view.Grid} event.source
2199
+ * @param {GridLocationConfig[],Grid.util.GridLocation[]} event.selectedCells The cells that is currently being dragged over
2200
+ * @param {Core.data.Model[]} event.selectedRecords The records that is currently being dragged over
2201
+ */
2202
+ @Output() onDragSelecting: any = new EventEmitter<((event: { source: Grid, selectedCells: GridLocationConfig[]|GridLocation[], selectedRecords: Model[] }) => void)|string>();
2203
+ /**
2204
+ * Triggered when a widget's [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element) is available.
2205
+ * @param {object} event Event object
2206
+ * @param {HTMLElement} event.element The Widget's element.
2207
+ */
2208
+ @Output() onElementCreated: any = new EventEmitter<((event: { element: HTMLElement }) => void)|string>();
2209
+ /**
2210
+ * Fires when a Panel is expanded using the [collapsible](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-collapsible) setting.
2211
+ * @param {object} event Event object
2212
+ * @param {Core.widget.Panel} event.source This Panel.
2213
+ */
2214
+ @Output() onExpand: any = new EventEmitter<((event: { source: Panel }) => void)|string>();
2215
+ /**
2216
+ * Fired after a parent node record is expanded.
2217
+ * @param {object} event Event object
2218
+ * @param {Grid.view.Grid} event.source The firing Grid instance.
2219
+ * @param {Core.data.Model} event.record The record which has been expanded.
2220
+ */
2221
+ @Output() onExpandNode: any = new EventEmitter<((event: { source: Grid, record: Model }) => void)|string>();
2222
+ /**
2223
+ * Fired when a file is dropped on the widget element
2224
+ * @param {object} event Event object
2225
+ * @param {Grid.view.Grid} event.source The owning Grid instance
2226
+ * @param {DataTransferItem} event.file The dropped file descriptor
2227
+ * @param {DragEvent} event.domEvent The native DragEvent
2228
+ */
2229
+ @Output() onFileDrop: any = new EventEmitter<((event: { source: Grid, file: DataTransferItem, domEvent: DragEvent }) => void)|string>();
2230
+ /**
2231
+ * Fired before the FillHandle dragging is finalized and values are applied to cells, return `false` to prevent the
2232
+ * drag operation from applying data changes.
2233
+ * @param {object} event Event object
2234
+ * @param {Grid.util.GridLocation} event.from The from cell
2235
+ * @param {Grid.util.GridLocation} event.to The to cell
2236
+ * @param {MouseEvent} event.domEvent The raw DOM event
2237
+ */
2238
+ @Output() onFillHandleBeforeDragFinalize: any = new EventEmitter<((event: { from: GridLocation, to: GridLocation, domEvent: MouseEvent }) => Promise<boolean>|boolean|void)|string>();
2239
+ /**
2240
+ * Fired while dragging the FillHandle.
2241
+ * @param {object} event Event object
2242
+ * @param {Grid.util.GridLocation} event.from The from cell
2243
+ * @param {Grid.util.GridLocation} event.to The to cell
2244
+ * @param {MouseEvent} event.domEvent The raw DOM event
2245
+ */
2246
+ @Output() onFillHandleDrag: any = new EventEmitter<((event: { from: GridLocation, to: GridLocation, domEvent: MouseEvent }) => void)|string>();
2247
+ /**
2248
+ * Fired when a FillHandle drag operation is aborted.
2249
+ */
2250
+ @Output() onFillHandleDragAbort: any = new EventEmitter<(() => void)|string>();
2251
+ /**
2252
+ * Fired after a FillHandle drag operation.
2253
+ * @param {object} event Event object
2254
+ * @param {Grid.util.GridLocation} event.from The from cell
2255
+ * @param {Grid.util.GridLocation} event.to The to cell
2256
+ * @param {MouseEvent} event.domEvent The raw DOM event
2257
+ */
2258
+ @Output() onFillHandleDragEnd: any = new EventEmitter<((event: { from: GridLocation, to: GridLocation, domEvent: MouseEvent }) => void)|string>();
2259
+ /**
2260
+ * Fired when dragging of the FillHandle starts.
2261
+ * @param {object} event Event object
2262
+ * @param {Grid.util.GridLocation} event.cell Information about the column / record
2263
+ * @param {MouseEvent} event.domEvent The raw DOM event
2264
+ */
2265
+ @Output() onFillHandleDragStart: any = new EventEmitter<((event: { cell: GridLocation, domEvent: MouseEvent }) => Promise<boolean>|boolean|void)|string>();
2266
+ /**
2267
+ * Fires on the owning Grid when cell editing is finished
2268
+ * @param {object} event Event object
2269
+ * @param {Grid.view.Grid} event.grid Target grid
2270
+ * @param {CellEditorContext} event.editorContext Editing context
2271
+ */
2272
+ @Output() onFinishCellEdit: any = new EventEmitter<((event: { grid: Grid, editorContext: CellEditorContext }) => void)|string>();
2273
+ /**
2274
+ * Fires on the owning Grid before the row editing is finished, return false to signal that the value is invalid and editing should not be finalized.
2275
+ * ...
2276
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-finishRowEdit)
2277
+ * @param {object} event Event object
2278
+ * @param {Grid.view.Grid} event.grid Target grid
2279
+ * @param {RowEditorContext} event.editorContext Editing context
2280
+ */
2281
+ @Output() onFinishRowEdit: any = new EventEmitter<((event: { grid: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string>();
2282
+ /**
2283
+ * Fired when focus enters this Widget.
2284
+ * @param {object} event Event object
2285
+ * @param {Core.widget.Widget} event.source This Widget
2286
+ * @param {HTMLElement} event.fromElement The element which lost focus.
2287
+ * @param {HTMLElement} event.toElement The element which gained focus.
2288
+ * @param {Core.widget.Widget} event.fromWidget The widget which lost focus.
2289
+ * @param {Core.widget.Widget} event.toWidget The widget which gained focus.
2290
+ * @param {boolean} event.backwards `true` if the `toElement` is before the `fromElement` in document order.
2291
+ */
2292
+ @Output() onFocusIn: any = new EventEmitter<((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string>();
2293
+ /**
2294
+ * Fired when focus exits this Widget's ownership tree. This is different from a `blur` event.
2295
+ * focus moving from within this Widget's ownership tree, even if there are floating widgets
2296
+ * will not trigger this event. This is when focus exits this widget completely.
2297
+ * @param {object} event Event object
2298
+ * @param {Core.widget.Widget} event.source This Widget
2299
+ * @param {HTMLElement} event.fromElement The element which lost focus.
2300
+ * @param {HTMLElement} event.toElement The element which gained focus.
2301
+ * @param {Core.widget.Widget} event.fromWidget The widget which lost focus.
2302
+ * @param {Core.widget.Widget} event.toWidget The widget which gained focus.
2303
+ * @param {boolean} event.backwards `true` if the `toElement` is before the `fromElement` in document order.
2304
+ */
2305
+ @Output() onFocusOut: any = new EventEmitter<((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string>();
2306
+ /**
2307
+ * Fired before dragging starts, return false to prevent the drag operation.
2308
+ * @param {object} event Event object
2309
+ * @param {Grid.view.GridBase} event.source
2310
+ * @param {object} event.context
2311
+ * @param {Core.data.Model[]} event.context.records The dragged row records
2312
+ * @param {MouseEvent,TouchEvent} event.event
2313
+ */
2314
+ @Output() onGridRowBeforeDragStart: any = new EventEmitter<((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => Promise<boolean>|boolean|void)|string>();
2315
+ /**
2316
+ * Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
2317
+ * Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
2318
+ * @param {object} event Event object
2319
+ * @param {Grid.view.GridBase} event.source
2320
+ * @param {object} event.context
2321
+ * @param {boolean} event.context.valid Set this to true or false to indicate whether the drop position is valid
2322
+ * @param {Core.data.Model} event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
2323
+ * @param {Core.data.Model} event.context.parent The parent record of the current drop position (only applicable for trees)
2324
+ * @param {Core.data.Model[]} event.context.records The dragged row records
2325
+ * @param {RecordPositionContext[]} event.context.oldPositionContext An array of objects with information about the previous tree position. Objects contain the `record`, and its original `parentIndex` and `parentId` values
2326
+ * @param {MouseEvent} event.event
2327
+ */
2328
+ @Output() onGridRowBeforeDropFinalize: any = new EventEmitter<((event: { source: GridBase, context: { valid: boolean, insertBefore: Model, parent: Model, records: Model[], oldPositionContext: RecordPositionContext[] }, event: MouseEvent }) => Promise<boolean>|boolean|void)|string>();
2329
+ /**
2330
+ * Fired while the row is being dragged, in the listener function you have access to `context.insertBefore` a grid /
2331
+ * tree record, and additionally `context.parent` (a TreeNode) for trees. You can signal that the drop position is
2332
+ * valid or invalid by setting `context.valid = false;`
2333
+ * @param {object} event Event object
2334
+ * @param {Grid.view.GridBase} event.source
2335
+ * @param {object} event.context
2336
+ * @param {boolean} event.context.valid Set this to true or false to indicate whether the drop position is valid.
2337
+ * @param {Core.data.Model} event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
2338
+ * @param {Core.data.Model} event.context.parent The parent record of the current drop position (only applicable for trees)
2339
+ * @param {Core.data.Model[]} event.context.records The dragged row records
2340
+ * @param {MouseEvent} event.event
2341
+ */
2342
+ @Output() onGridRowDrag: any = new EventEmitter<((event: { source: GridBase, context: { valid: boolean, insertBefore: Model, parent: Model, records: Model[] }, event: MouseEvent }) => void)|string>();
2343
+ /**
2344
+ * Fired when a row drag operation is aborted
2345
+ * @param {object} event Event object
2346
+ * @param {Grid.view.GridBase} event.source
2347
+ * @param {object} event.context
2348
+ * @param {Core.data.Model[]} event.context.records The dragged row records
2349
+ * @param {MouseEvent} event.event
2350
+ */
2351
+ @Output() onGridRowDragAbort: any = new EventEmitter<((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent }) => void)|string>();
2352
+ /**
2353
+ * Fired when dragging starts.
2354
+ * @param {object} event Event object
2355
+ * @param {Grid.view.GridBase} event.source
2356
+ * @param {object} event.context
2357
+ * @param {Core.data.Model[]} event.context.records The dragged row records
2358
+ * @param {MouseEvent,TouchEvent} event.event
2359
+ */
2360
+ @Output() onGridRowDragStart: any = new EventEmitter<((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => void)|string>();
2361
+ /**
2362
+ * Fired after the row drop operation has completed, regardless of validity
2363
+ * @param {object} event Event object
2364
+ * @param {Grid.view.GridBase} event.source
2365
+ * @param {object} event.context
2366
+ * @param {boolean} event.context.valid true or false depending on whether the drop position was valid
2367
+ * @param {Core.data.Model} event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
2368
+ * @param {Core.data.Model} event.context.parent The parent record of the current drop position (only applicable for trees)
2369
+ * @param {Core.data.Model[]} event.context.records The dragged row records
2370
+ * @param {RecordPositionContext[]} event.context.oldPositionContext An array of objects with information about the previous tree position. Objects contain the record, and its original `parentIndex` and `parentId` values
2371
+ * @param {MouseEvent} event.event
2372
+ */
2373
+ @Output() onGridRowDrop: any = new EventEmitter<((event: { source: GridBase, context: { valid: boolean, insertBefore: Model, parent: Model, records: Model[], oldPositionContext: RecordPositionContext[] }, event: MouseEvent }) => void)|string>();
2374
+ /**
2375
+ * Fired when a grid header is clicked on.
2376
+ * ...
2377
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-headerClick)
2378
+ * @param {object} event Event object
2379
+ * @param {Event} event.domEvent The triggering DOM event.
2380
+ * @param {Grid.column.Column} event.column The column clicked on.
2381
+ */
2382
+ @Output() onHeaderClick: any = new EventEmitter<((event: { domEvent: Event, column: Column }) => Promise<boolean>|boolean|void)|string>();
2383
+ /**
2384
+ * This event fires on the owning Grid before the context menu is shown for a header.
2385
+ * Allows manipulation of the items to show in the same way as in the [processItems](https://bryntum.com/products/grid/docs/api/Grid/feature/HeaderMenu#config-processItems).
2386
+ * ...
2387
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-headerMenuBeforeShow)
2388
+ * @param {object} event Event object
2389
+ * @param {Grid.view.Grid} event.source The grid
2390
+ * @param {Core.widget.Menu} event.menu The menu
2391
+ * @param {Record<string, MenuItemEntry>} event.items Menu item configs
2392
+ * @param {Grid.column.Column} event.column Column
2393
+ */
2394
+ @Output() onHeaderMenuBeforeShow: any = new EventEmitter<((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => Promise<boolean>|boolean|void)|string>();
2395
+ /**
2396
+ * This event fires on the owning Grid when an item is selected in the header context menu.
2397
+ * @param {object} event Event object
2398
+ * @param {Grid.view.Grid} event.source The grid
2399
+ * @param {Core.widget.Menu} event.menu The menu
2400
+ * @param {Core.widget.MenuItem} event.item Selected menu item
2401
+ * @param {Grid.column.Column} event.column Column
2402
+ */
2403
+ @Output() onHeaderMenuItem: any = new EventEmitter<((event: { source: Grid, menu: Menu, item: MenuItem, column: Column }) => void)|string>();
2404
+ /**
2405
+ * This event fires on the owning Grid after the context menu is shown for a header
2406
+ * @param {object} event Event object
2407
+ * @param {Grid.view.Grid} event.source The grid
2408
+ * @param {Core.widget.Menu} event.menu The menu
2409
+ * @param {Record<string, MenuItemEntry>} event.items Menu item configs
2410
+ * @param {Grid.column.Column} event.column Column
2411
+ */
2412
+ @Output() onHeaderMenuShow: any = new EventEmitter<((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => void)|string>();
2413
+ /**
2414
+ * This event fires on the owning Grid when a check item is toggled in the header context menu.
2415
+ * @param {object} event Event object
2416
+ * @param {Grid.view.Grid} event.source The grid
2417
+ * @param {Core.widget.Menu} event.menu The menu
2418
+ * @param {Core.widget.MenuItem} event.item Selected menu item
2419
+ * @param {Grid.column.Column} event.column Column
2420
+ * @param {boolean} event.checked Checked or not
2421
+ */
2422
+ @Output() onHeaderMenuToggleItem: any = new EventEmitter<((event: { source: Grid, menu: Menu, item: MenuItem, column: Column, checked: boolean }) => void)|string>();
2423
+ /**
2424
+ * Triggered after a widget was hidden
2425
+ * @param {object} event Event object
2426
+ * @param {Core.widget.Widget} event.source The widget
2427
+ */
2428
+ @Output() onHide: any = new EventEmitter<((event: { source: Widget }) => void)|string>();
2429
+ /**
2430
+ * Fires when row locking is enabled.
2431
+ * @param {object} event Event object
2432
+ * @param {Grid.view.GridBase} event.clone The created clone
2433
+ */
2434
+ @Output() onLockRows: any = new EventEmitter<((event: { clone: GridBase }) => void)|string>();
2435
+ /**
2436
+ * Mouse moved out from element in grid
2437
+ * @param {object} event Event object
2438
+ * @param {MouseEvent} event.event The native browser event
2439
+ */
2440
+ @Output() onMouseOut: any = new EventEmitter<((event: { event: MouseEvent }) => void)|string>();
2441
+ /**
2442
+ * Mouse moved in over element in grid
2443
+ * @param {object} event Event object
2444
+ * @param {MouseEvent} event.event The native browser event
2445
+ */
2446
+ @Output() onMouseOver: any = new EventEmitter<((event: { event: MouseEvent }) => void)|string>();
2447
+ /**
2448
+ * Triggered when a widget which had been in a non-visible state for any reason
2449
+ * achieves visibility.
2450
+ * ...
2451
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-paint)
2452
+ * @param {object} event Event object
2453
+ * @param {Core.widget.Widget} event.source The widget being painted.
2454
+ * @param {boolean} event.firstPaint `true` if this is the first paint.
2455
+ */
2456
+ @Output() onPaint: any = new EventEmitter<((event: { source: Widget, firstPaint: boolean }) => void)|string>();
2457
+ /**
2458
+ * Fires on the owning Grid after a paste action is performed.
2459
+ * @param {object} event Event object
2460
+ * @param {Grid.view.Grid} event.source Owner grid
2461
+ * @param {string} event.clipboardData The clipboardData that was pasted
2462
+ * @param {Core.data.Model[]} event.modifiedRecords The records which have been modified due to the paste action
2463
+ * @param {Grid.util.GridLocation} event.targetCell The cell from which the paste will be started
2464
+ * @param {string} event.entityName 'cell' to distinguish this event from other paste events
2465
+ */
2466
+ @Output() onPaste: any = new EventEmitter<((event: { source: Grid, clipboardData: string, modifiedRecords: Model[], targetCell: GridLocation, entityName: string }) => void)|string>();
2467
+ /**
2468
+ * Fires on the owning Grid when export has finished
2469
+ * @param {object} event Event object
2470
+ * @param {Response} event.response Optional response, if received
2471
+ * @param {Error} event.error Optional error, if exception occurred
2472
+ */
2473
+ @Output() onPdfExport: any = new EventEmitter<((event: { response?: any, error?: Error }) => void)|string>();
2474
+ /**
2475
+ * Fired when a Widget's read only state is toggled
2476
+ * @param {object} event Event object
2477
+ * @param {boolean} event.readOnly Read only or not
2478
+ */
2479
+ @Output() onReadOnly: any = new EventEmitter<((event: { readOnly: boolean }) => void)|string>();
2480
+ /**
2481
+ * This event is fired after a widget's elements have been synchronized due to a direct or indirect call
2482
+ * to [recompose](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#function-recompose), if this results in some change to the widget's rendered DOM elements.
2483
+ */
2484
+ @Output() onRecompose: any = new EventEmitter<(() => void)|string>();
2485
+ /**
2486
+ * Fires after a row is rendered.
2487
+ * @param {object} event Event object
2488
+ * @param {Grid.view.Grid} event.source The firing Grid instance.
2489
+ * @param {Grid.row.Row} event.row The row that has been rendered.
2490
+ * @param {Core.data.Model} event.record The record for the row.
2491
+ * @param {number} event.recordIndex The zero-based index of the record.
2492
+ */
2493
+ @Output() onRenderRow: any = new EventEmitter<((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string>();
2494
+ /**
2495
+ * Grid rows have been rendered
2496
+ * @param {object} event Event object
2497
+ * @param {Grid.view.Grid} event.source This grid.
2498
+ */
2499
+ @Output() onRenderRows: any = new EventEmitter<((event: { source: Grid }) => void)|string>();
2500
+ /**
2501
+ * Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
2502
+ * @param {object} event Event object
2503
+ * @param {Core.widget.Widget} event.source This Widget
2504
+ * @param {number} event.width The new width
2505
+ * @param {number} event.height The new height
2506
+ * @param {number} event.oldWidth The old width
2507
+ * @param {number} event.oldHeight The old height
2508
+ */
2509
+ @Output() onResize: any = new EventEmitter<((event: { source: Widget, width: number, height: number, oldWidth: number, oldHeight: number }) => void)|string>();
2510
+ /**
2511
+ * Grid resize lead to a new responsive level being applied
2512
+ * @param {object} event Event object
2513
+ * @param {Grid.view.Grid} event.grid Grid that was resized
2514
+ * @param {string} event.level New responsive level (small, large, etc)
2515
+ * @param {number} event.width New width in px
2516
+ * @param {string} event.oldLevel Old responsive level
2517
+ * @param {number} event.oldWidth Old width in px
2518
+ */
2519
+ @Output() onResponsive: any = new EventEmitter<((event: { grid: Grid, level: string, width: number, oldLevel: string, oldWidth: number }) => void)|string>();
2520
+ /**
2521
+ * This event fires when a row has finished collapsing.
2522
+ * @param {object} event Event object
2523
+ * @param {Core.data.Model} event.record Record
2524
+ */
2525
+ @Output() onRowCollapse: any = new EventEmitter<((event: { record: Model }) => void)|string>();
2526
+ /**
2527
+ * This event fires when a row expand has finished expanding.
2528
+ * ...
2529
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-rowExpand)
2530
+ * @param {object} event Event object
2531
+ * @param {Core.data.Model} event.record Record
2532
+ * @param {object} event.expandedElements An object with the Grid region name as property and the expanded body element as value
2533
+ * @param {Core.widget.Widget} event.widget In case of expanding a Widget, this will be a reference to the instance created by the actual expansion. If there is multiple Grid regions, use the `widgets` param instead.
2534
+ * @param {object} event.widgets In case of expanding a Widget, this will be an object with the Grid region name as property and the reference to the widget instance created by the actual expansion
2535
+ */
2536
+ @Output() onRowExpand: any = new EventEmitter<((event: { record: Model, expandedElements: object, widget: Widget, widgets: object }) => void)|string>();
2537
+ /**
2538
+ * Fired when the mouse enters a row
2539
+ * @param {object} event Event object
2540
+ * @param {Grid.view.Grid} event.source The grid instance
2541
+ * @param {Core.data.Model} event.record The record representing the hovered row
2542
+ * @param {Grid.column.Column} event.column The column currently hovered
2543
+ * @param {HTMLElement} event.cellElement The cell HTML element
2544
+ * @param {MouseEvent} event.event The native DOM event
2545
+ */
2546
+ @Output() onRowMouseEnter: any = new EventEmitter<((event: { source: Grid, record: Model, column: Column, cellElement: HTMLElement, event: MouseEvent }) => void)|string>();
2547
+ /**
2548
+ * Fired when the mouse leaves a row
2549
+ * @param {object} event Event object
2550
+ * @param {Grid.view.Grid} event.source The grid instance
2551
+ * @param {Core.data.Model} event.record The record representing the row that the mouse left
2552
+ * @param {HTMLElement} event.cellElement The cell HTML element that the mouse left
2553
+ * @param {MouseEvent} event.event The native DOM event
2554
+ */
2555
+ @Output() onRowMouseLeave: any = new EventEmitter<((event: { source: Grid, record: Model, cellElement: HTMLElement, event: MouseEvent }) => void)|string>();
2556
+ /**
2557
+ * Grid has scrolled vertically
2558
+ * @param {object} event Event object
2559
+ * @param {Grid.view.Grid} event.source The firing Grid instance.
2560
+ * @param {number} event.scrollTop The vertical scroll position.
2561
+ */
2562
+ @Output() onScroll: any = new EventEmitter<((event: { source: Grid, scrollTop: number }) => void)|string>();
2563
+ /**
2564
+ * The selection has been changed.
2565
+ * @param {object} event Event object
2566
+ * @param {'select','deselect'} event.action `'select'`/`'deselect'`
2567
+ * @param {'row','cell'} event.mode `'row'`/`'cell'`
2568
+ * @param {Grid.view.Grid} event.source
2569
+ * @param {Core.data.Model[]} event.deselected The records deselected in this operation.
2570
+ * @param {Core.data.Model[]} event.selected The records selected in this operation.
2571
+ * @param {Core.data.Model[]} event.selection The records in the new selection.
2572
+ * @param {Grid.util.GridLocation[]} event.deselectedCells The cells deselected in this operation.
2573
+ * @param {Grid.util.GridLocation[]} event.selectedCells The cells selected in this operation.
2574
+ * @param {Grid.util.GridLocation[]} event.cellSelection The cells in the new selection.
2575
+ */
2576
+ @Output() onSelectionChange: any = new EventEmitter<((event: { action: 'select'|'deselect', mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => void)|string>();
2577
+ /**
2578
+ * The selectionMode configuration has been changed.
2579
+ * @param {object} event Event object
2580
+ * @param {object} event.selectionMode The new [selectionMode](https://bryntum.com/products/grid/docs/api/Grid/view/mixin/GridSelection#config-selectionMode)
2581
+ */
2582
+ @Output() onSelectionModeChange: any = new EventEmitter<((event: { selectionMode: object }) => void)|string>();
2583
+ /**
2584
+ * Triggered after a widget is shown.
2585
+ * @param {object} event Event object
2586
+ * @param {Core.widget.Widget} event.source The widget
2587
+ */
2588
+ @Output() onShow: any = new EventEmitter<((event: { source: Widget }) => void)|string>();
2589
+ /**
2590
+ * Fires when splitting the Grid.
2591
+ * @param {object} event Event object
2592
+ * @param {Grid.view.GridBase[]} event.subViews The sub views created by the split
2593
+ * @param {object} event.options The options passed to the split call
2594
+ * @param {'horizontal','vertical','both'} event.options.direction The direction of the split
2595
+ * @param {Grid.column.Column} event.options.atColumn The column to split at
2596
+ * @param {Core.data.Model} event.options.atRecord The record to split at
2597
+ */
2598
+ @Output() onSplit: any = new EventEmitter<((event: { subViews: GridBase[], options: { direction: 'horizontal'|'vertical'|'both', atColumn: Column, atRecord: Model } }) => void)|string>();
2599
+ /**
2600
+ * Fired by the Grid when the collapse icon is clicked. Return `false` to prevent the default collapse action,
2601
+ * if you want to implement your own behavior.
2602
+ * @param {object} event Event object
2603
+ * @param {Grid.view.Grid} event.source The Grid instance.
2604
+ * @param {Grid.view.SubGrid} event.subGrid The subgrid
2605
+ * @param {Event} event.domEvent The native DOM event
2606
+ */
2607
+ @Output() onSplitterCollapseClick: any = new EventEmitter<((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => Promise<boolean>|boolean|void)|string>();
2608
+ /**
2609
+ * Fired by the Grid after a sub-grid has been resized using the splitter
2610
+ * @param {object} event Event object
2611
+ * @param {Grid.view.Grid} event.source The Grid instance.
2612
+ * @param {Grid.view.SubGrid} event.subGrid The resized subgrid
2613
+ * @param {Event} event.domEvent The native DOM event
2614
+ */
2615
+ @Output() onSplitterDragEnd: any = new EventEmitter<((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => void)|string>();
2616
+ /**
2617
+ * Fired by the Grid when a sub-grid resize gesture starts
2618
+ * @param {object} event Event object
2619
+ * @param {Grid.view.Grid} event.source The Grid instance.
2620
+ * @param {Grid.view.SubGrid} event.subGrid The subgrid about to be resized
2621
+ * @param {Event} event.domEvent The native DOM event
2622
+ */
2623
+ @Output() onSplitterDragStart: any = new EventEmitter<((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => void)|string>();
2624
+ /**
2625
+ * Fired by the Grid when the expand icon is clicked. Return `false` to prevent the default expand action,
2626
+ * if you want to implement your own behavior.
2627
+ * @param {object} event Event object
2628
+ * @param {Grid.view.Grid} event.source The Grid instance.
2629
+ * @param {Grid.view.SubGrid} event.subGrid The subgrid
2630
+ * @param {Event} event.domEvent The native DOM event
2631
+ */
2632
+ @Output() onSplitterExpandClick: any = new EventEmitter<((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => Promise<boolean>|boolean|void)|string>();
2633
+ /**
2634
+ * Fires on the owning Grid when editing starts
2635
+ * @param {object} event Event object
2636
+ * @param {Grid.view.Grid} event.source Owner grid
2637
+ * @param {CellEditorContext} event.editorContext Editing context
2638
+ */
2639
+ @Output() onStartCellEdit: any = new EventEmitter<((event: { source: Grid, editorContext: CellEditorContext }) => void)|string>();
2640
+ /**
2641
+ * Fires on the owning Grid when editing starts
2642
+ * @param {object} event Event object
2643
+ * @param {Grid.view.Grid} event.source Owner grid
2644
+ * @param {RowEditorContext} event.editorContext Editing context
2645
+ */
2646
+ @Output() onStartRowEdit: any = new EventEmitter<((event: { source: Grid, editorContext: RowEditorContext }) => void)|string>();
2647
+ /**
2648
+ * Fires after a sub grid is collapsed.
2649
+ * @param {object} event Event object
2650
+ * @param {Grid.view.Grid} event.source The firing Grid instance
2651
+ * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
2652
+ */
2653
+ @Output() onSubGridCollapse: any = new EventEmitter<((event: { source: Grid, subGrid: SubGrid }) => void)|string>();
2654
+ /**
2655
+ * Fires after a sub grid is expanded.
2656
+ * @param {object} event Event object
2657
+ * @param {Grid.view.Grid} event.source The firing Grid instance
2658
+ * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
2659
+ */
2660
+ @Output() onSubGridExpand: any = new EventEmitter<((event: { source: Grid, subGrid: SubGrid }) => void)|string>();
2661
+ /**
2662
+ * Fired when one or more groups are expanded or collapsed
2663
+ * @param {object} event Event object
2664
+ * @param {Core.data.Model} event.groupRecord [DEPRECATED] Use `groupRecords` param instead
2665
+ * @param {Core.data.Model[]} event.groupRecords The group records being toggled
2666
+ * @param {boolean} event.collapse Collapsed (true) or expanded (false)
2667
+ * @param {boolean} event.allRecords True if this event is part of toggling all groups
2668
+ */
2669
+ @Output() onToggleGroup: any = new EventEmitter<((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, allRecords?: boolean }) => void)|string>();
2670
+ /**
2671
+ * Fired after a parent node record toggles its collapsed state.
2672
+ * @param {object} event Event object
2673
+ * @param {Core.data.Model} event.record The record being toggled.
2674
+ * @param {boolean} event.collapse `true` if the node is being collapsed.
2675
+ */
2676
+ @Output() onToggleNode: any = new EventEmitter<((event: { record: Model, collapse: boolean }) => void)|string>();
2677
+ /**
2678
+ * A header [tool](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-tools) has been clicked.
2679
+ * @param {object} event Event object
2680
+ * @param {Core.widget.Tool} event.source This Panel.
2681
+ * @param {Core.widget.Tool} event.tool The tool which is being clicked.
2682
+ */
2683
+ @Output() onToolClick: any = new EventEmitter<((event: { source: Tool, tool: Tool }) => void)|string>();
2684
+ /**
2685
+ * Fires when row locking is disabled.
2686
+ * @param {object} event Event object
2687
+ * @param {Grid.view.GridBase} event.clone The locked clone that will be destroyed
2688
+ */
2689
+ @Output() onUnlockRows: any = new EventEmitter<((event: { clone: GridBase }) => void)|string>();
2690
+ /**
2691
+ * Fires when un-splitting the Grid.
2692
+ */
2693
+ @Output() onUnsplit: any = new EventEmitter<(() => void)|string>();
2694
+
2695
+ /**
2696
+ * Create and append the underlying widget
2697
+ */
2698
+ ngOnInit(): void {
2699
+ const
2700
+ me = this,
2701
+ {
2702
+ elementRef,
2703
+ bryntumConfig
2704
+ } = me,
2705
+ {
2706
+ instanceClass,
2707
+ instanceName,
2708
+ bryntumConfigs,
2709
+ bryntumEvents
2710
+ } = BryntumTreeGridComponent;
2711
+
2712
+ bryntumConfigs.filter(prop => prop in this).forEach(prop => {
2713
+ // @ts-ignore
2714
+ WrapperHelper.applyPropValue(bryntumConfig, prop, this[prop]);
2715
+ if (['features', 'config'].includes(prop)) {
2716
+ WrapperHelper.devWarningConfigProp(instanceName, prop);
2717
+ }
2718
+ });
2719
+ // @ts-ignore
2720
+ bryntumEvents.filter(event => this[event] && this[event].observers.length > 0).forEach(event => {
2721
+ const
2722
+ uncapitalize = (str: string) => str.charAt(0).toLowerCase() + str.slice(1),
2723
+ eventName = (str: string) => uncapitalize(str.slice(2));
2724
+
2725
+ // @ts-ignore
2726
+ bryntumConfig.listeners[eventName(event)] = e => {
2727
+ // @ts-ignore
2728
+ me[event].emit(e);
2729
+ // EventEmitter does not return values in the normal way, work around it by setting `returnValue` flag
2730
+ // in Angular listeners
2731
+ return e.returnValue;
2732
+ };
2733
+ });
2734
+
2735
+ // If component has no container specified in config then use adopt to Wrapper's element
2736
+ const
2737
+ containerParam = [
2738
+ 'adopt',
2739
+ 'appendTo',
2740
+ 'insertAfter',
2741
+ 'insertBefore'
2742
+ // @ts-ignore
2743
+ ].find(prop => bryntumConfig[prop]);
2744
+ if (!containerParam) {
2745
+ if (instanceName === 'Button' || elementRef.nativeElement.getRootNode() instanceof ShadowRoot) {
2746
+ // Button should always be <a> or <button> inside owner element
2747
+ bryntumConfig.appendTo = elementRef.nativeElement;
2748
+ }
2749
+ else {
2750
+ bryntumConfig.adopt = elementRef.nativeElement;
2751
+ }
2752
+ }
2753
+ else {
2754
+ WrapperHelper.devWarningContainer(instanceName, containerParam);
2755
+ }
2756
+
2757
+ // @ts-ignore
2758
+ me.instance = instanceName === 'Widget' ? Widget.create(bryntumConfig) : new instanceClass(bryntumConfig);
2759
+
2760
+ // Backwards compatibility for gridInstance, schedulerInstance etc.
2761
+ // @ts-ignore
2762
+ me[StringHelper.uncapitalize(instanceName) + 'Instance'] = me.instance;
2763
+ //
2764
+ }
2765
+
2766
+ /**
2767
+ * Watch for changes
2768
+ * @param changes
2769
+ */
2770
+ ngOnChanges(changes: SimpleChanges): void {
2771
+ const
2772
+ { instance } = this,
2773
+ { instanceName } = BryntumTreeGridComponent;
2774
+ if (!instance) {
2775
+ return;
2776
+ }
2777
+ // Iterate over all changes
2778
+ Object.entries(changes).forEach(([prop, change]) => {
2779
+ const
2780
+ newValue = (change as SimpleChange).currentValue,
2781
+ { instance } = this,
2782
+ { bryntumConfigsOnly, bryntumProps } = BryntumTreeGridComponent;
2783
+ if (bryntumProps.includes(prop)) {
2784
+ WrapperHelper.applyPropValue(instance, prop, newValue, false);
2785
+ if (bryntumConfigsOnly.includes(prop)) {
2786
+ WrapperHelper.devWarningUpdateProp(instanceName, prop);
2787
+ }
2788
+ }
2789
+ });
2790
+ }
2791
+
2792
+ /**
2793
+ * Destroy the component
2794
+ */
2795
+ ngOnDestroy(): void {
2796
+ // @ts-ignore
2797
+ if (this.instance && this.instance.destroy) {
2798
+ this.instance.destroy();
2799
+ }
2800
+ }
2801
+ }