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