@bryntum/grid-react-thin 7.1.1

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