@bryntum/grid-angular-thin 7.1.1

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