@bryntum/grid-angular 7.1.1 → 7.1.3

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