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