@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,2986 @@
1
+ <!-- Vue 3 wrapper for Bryntum Grid -->
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, GridBase, GridColumnConfig, GridListeners, GridLocation, GridLocationConfig, GridSelectionMode, GridStateInfo, Group, GroupConfig, GroupSummary, GroupSummaryConfig, HeaderMenu, HeaderMenuConfig, LockRows, LockRowsConfig, MergeCells, MergeCellsConfig, PdfExport, PdfExportConfig, PinColumns, PinColumnsConfig, PreserveScrollOptions, Print, PrintConfig, QuickFind, QuickFindConfig, RecordPositionContext, RegionResize, RegionResizeConfig, ResponsiveLevelConfig, Row, RowCopyPaste, RowCopyPasteConfig, RowEdit, RowEditConfig, RowEditorContext, RowExpander, RowExpanderConfig, RowReorder, RowReorderConfig, RowResize, RowResizeConfig, Search, SearchConfig, Sort, SortConfig, Split, SplitConfig, StickyCells, StickyCellsConfig, Stripe, StripeConfig, SubGrid, SubGridConfig, Summary, SummaryConfig, Tree, TreeConfig, TreeGroup, TreeGroupConfig, XLSColumn } from '@bryntum/grid-thin';
38
+ import { Grid } 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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#config-listeners)
432
+ */
433
+ listeners ? : GridListeners
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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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/Grid#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
+ type ? : 'grid'
765
+ /**
766
+ * Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
767
+ * as a space separated string, an array of strings, or as an object in which property names with truthy
768
+ * values are used as the class names.
769
+ * ...
770
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#config-ui)
771
+ */
772
+ ui ? : 'plain'|'toolbar'|string|object
773
+ /**
774
+ * A widgets weight determines its position among siblings when added to a [Container](https://bryntum.com/products/grid/docs/api/Core/widget/Container).
775
+ * Higher weights go further down.
776
+ */
777
+ weight ? : number
778
+ /**
779
+ * Widget's width, used to set element `style.width`. Either specify a valid width string or a number, which
780
+ * will get 'px' appended. We recommend using CSS as the primary way to control width, but in some cases
781
+ * this config is convenient.
782
+ */
783
+ width ? : string|number
784
+
785
+ // Features
786
+ /**
787
+ * AI-powered filter feature for Grid. Allows users to type natural language queries to filter grid data.
788
+ * ...
789
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/ai/AIFilter)
790
+ */
791
+ aiFilterFeature ? : object|Boolean|string|AIFilter|AIFilterConfig
792
+ /**
793
+ * Allows using `[Ctrl/CMD + C]`, `[Ctrl/CMD + X]` and `[Ctrl/CMD + V]` to cut, copy and paste cell or cell ranges. Also
794
+ * makes cut, copy and paste actions available via the cell context menu.
795
+ * ...
796
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellCopyPaste)
797
+ */
798
+ cellCopyPasteFeature ? : object|Boolean|string|CellCopyPaste|CellCopyPasteConfig
799
+ /**
800
+ * Adding this feature to the grid and other Bryntum products which are based on the Grid (i.e. Scheduler, SchedulerPro, and Gantt)
801
+ * enables cell editing. Any subclass of [Field](https://bryntum.com/products/grid/docs/api/Core/widget/Field) can be used
802
+ * as editor for the [Column](https://bryntum.com/products/grid/docs/api/Grid/column/Column). The most popular are:
803
+ * ...
804
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit)
805
+ */
806
+ cellEditFeature ? : object|Boolean|string|CellEdit|CellEditConfig
807
+ /**
808
+ * Right click to display context menu for cells. To invoke the cell menu in a keyboard-accessible manner, use the
809
+ * `SPACE` key when the cell is focused.
810
+ * ...
811
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellMenu)
812
+ */
813
+ cellMenuFeature ? : object|Boolean|string|CellMenu|CellMenuConfig
814
+ /**
815
+ * Displays a tooltip when hovering cells.
816
+ * ...
817
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellTooltip)
818
+ */
819
+ cellTooltipFeature ? : object|Boolean|string|CellTooltip|CellTooltipConfig
820
+ /**
821
+ * 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
822
+ * and updated in realtime as data changes. Supports many common chart types with extensive styling and customization
823
+ * options.
824
+ * ...
825
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Charts)
826
+ */
827
+ chartsFeature ? : object|Boolean|string|Charts|ChartsConfig
828
+ /**
829
+ * Enables the [autoWidth](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-autoWidth) config for a grid's columns.
830
+ * ...
831
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnAutoWidth)
832
+ */
833
+ columnAutoWidthFeature ? : object|Boolean|string|ColumnAutoWidth|ColumnAutoWidthConfig
834
+ /**
835
+ * Displays a toolbar while dragging column headers. Drop on a button in the toolbar to activate a certain function,
836
+ * for example to group by that column. This feature simplifies certain operations on touch devices.
837
+ * ...
838
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnDragToolbar)
839
+ */
840
+ columnDragToolbarFeature ? : object|Boolean|string|ColumnDragToolbar|ColumnDragToolbarConfig
841
+ /**
842
+ * Displays a column picker (to show/hide columns) in the header context menu. Columns can be displayed in sub menus
843
+ * by region or tag. Grouped headers are displayed as menu hierarchies.
844
+ * ...
845
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnPicker)
846
+ */
847
+ columnPickerFeature ? : object|Boolean|string|ColumnPicker|ColumnPickerConfig
848
+ /**
849
+ * Allows user to rename columns by either right-clicking column header or using keyboard shortcuts when column header
850
+ * is focused.
851
+ * ...
852
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnRename)
853
+ */
854
+ columnRenameFeature ? : object|Boolean|string|ColumnRename|ColumnRenameConfig
855
+ /**
856
+ * Allows user to reorder columns by dragging headers. To get notified about column reorder listen to `change` event
857
+ * on [columns](https://bryntum.com/products/grid/docs/api/Grid/data/ColumnStore) store.
858
+ * ...
859
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnReorder)
860
+ */
861
+ columnReorderFeature ? : object|Boolean|string|ColumnReorder|ColumnReorderConfig
862
+ /**
863
+ * Enables user to resize columns by dragging a handle on the right hand side of the header. To get notified about column
864
+ * resize listen to `change` event on [columns](https://bryntum.com/products/grid/docs/api/Grid/data/ColumnStore) store.
865
+ * ...
866
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnResize)
867
+ */
868
+ columnResizeFeature ? : object|Boolean|string|ColumnResize|ColumnResizeConfig
869
+ /**
870
+ * A feature that allows exporting Grid data to Excel or CSV without involving the server. It uses
871
+ * [TableExporter](https://bryntum.com/products/grid/docs/api/Grid/util/TableExporter) class as data provider, 3rd party provider to generate XLS files, and
872
+ * [Microsoft XML specification](https://msdn.microsoft.com/en-us/library/office/documentformat.openxml.spreadsheet.aspx).
873
+ * ...
874
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/ExcelExporter)
875
+ */
876
+ excelExporterFeature ? : object|Boolean|string|ExcelExporter|ExcelExporterConfig
877
+ /**
878
+ * An experimental feature that lets users drop files on a Widget. The widget fires an event when a file is dropped onto it.
879
+ * In the event, you get access to the raw files as strings, that were parsed by calling `readAsBinaryString`.
880
+ * ...
881
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/FileDrop)
882
+ */
883
+ fileDropFeature ? : object|Boolean|string|FileDrop|FileDropConfig
884
+ /**
885
+ * This feature adds a fill handle to a Grid range selection, which when dragged, fills the cells being dragged over
886
+ * with values based on the values in the original selected range. This is similar to functionality normally seen in
887
+ * various spreadsheet applications.
888
+ * ...
889
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/FillHandle)
890
+ */
891
+ fillHandleFeature ? : object|Boolean|string|FillHandle|FillHandleConfig
892
+ /**
893
+ * Feature that allows filtering of the grid by settings filters on columns. The actual filtering is done by the store.
894
+ * For info on programmatically handling filters, see [StoreFilter](https://bryntum.com/products/grid/docs/api/Core/data/mixin/StoreFilter).
895
+ * ...
896
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Filter)
897
+ */
898
+ filterFeature ? : object|Boolean|string|Filter|FilterConfig
899
+ /**
900
+ * Feature that allows filtering of the grid by entering filters on column headers.
901
+ * The actual filtering is done by the store.
902
+ * For info on programmatically handling filters, see [StoreFilter](https://bryntum.com/products/grid/docs/api/Core/data/mixin/StoreFilter).
903
+ * ...
904
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/FilterBar)
905
+ */
906
+ filterBarFeature ? : object|Boolean|string|FilterBar|FilterBarConfig
907
+ /**
908
+ * Enables rendering and handling of row groups. The actual grouping is done in the store, but triggered by
909
+ * <kbd>shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
910
+ * one anywhere on grid). Use <kbd>shift</kbd> + <kbd>alt</kbd> + click, or the context menu, to remove a column
911
+ * grouper.
912
+ * ...
913
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Group)
914
+ */
915
+ groupFeature ? : object|Boolean|string|Group|GroupConfig
916
+ /**
917
+ * Displays a summary row as a group footer in a grouped grid. Uses the same configuration options on columns as
918
+ * [Summary](https://bryntum.com/products/grid/docs/api/Grid/feature/Summary).
919
+ * ...
920
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/GroupSummary)
921
+ */
922
+ groupSummaryFeature ? : object|Boolean|string|GroupSummary|GroupSummaryConfig
923
+ /**
924
+ * Right click column header or focus it and press SPACE key to show the context menu for headers.
925
+ * ...
926
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/HeaderMenu)
927
+ */
928
+ headerMenuFeature ? : object|Boolean|string|HeaderMenu|HeaderMenuConfig
929
+ /**
930
+ * This feature allows records which satisfy a certain condition to be locked at the top of the grid.
931
+ * ...
932
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/LockRows)
933
+ */
934
+ lockRowsFeature ? : object|Boolean|string|LockRows|LockRowsConfig
935
+ /**
936
+ * 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
937
+ * configured to [mergeCells](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-mergeCells).
938
+ * ...
939
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/MergeCells)
940
+ */
941
+ mergeCellsFeature ? : object|Boolean|string|MergeCells|MergeCellsConfig
942
+ /**
943
+ * Generates PDF/PNG files from the Grid component.
944
+ * ...
945
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/export/PdfExport)
946
+ */
947
+ pdfExportFeature ? : object|Boolean|string|PdfExport|PdfExportConfig
948
+ /**
949
+ * Allows pinning columns to the start or end region of the grid without any additional subGrid configurations.
950
+ * When pinning to a region that does not yet exist, the feature creates the required subGrid on the fly.
951
+ * ...
952
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/PinColumns)
953
+ */
954
+ pinColumnsFeature ? : object|Boolean|string|PinColumns|PinColumnsConfig
955
+ /**
956
+ * Allows printing Grid contents using browser print dialog.
957
+ * ...
958
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/export/Print)
959
+ */
960
+ printFeature ? : object|Boolean|string|Print|PrintConfig
961
+ /**
962
+ * Feature that allows the user to search in a column by focusing a cell and typing. Navigate between hits using the
963
+ * keyboard, [f3] or [ctrl]/[cmd] + [g] moves to next, also pressing [shift] moves to previous.
964
+ * ...
965
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/QuickFind)
966
+ */
967
+ quickFindFeature ? : object|Boolean|string|QuickFind|QuickFindConfig
968
+ /**
969
+ * Makes the splitter between grid [sections](https://bryntum.com/products/grid/docs/api/Grid/view/SubGrid) draggable, to let users resize, and
970
+ * collapse/expand the sections.
971
+ * ...
972
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/RegionResize)
973
+ */
974
+ regionResizeFeature ? : object|Boolean|string|RegionResize|RegionResizeConfig
975
+ /**
976
+ * Allow using [Ctrl/CMD + C/X] and [Ctrl/CMD + V] to copy/cut-and-paste rows. Also makes cut, copy and paste actions
977
+ * available via the cell context menu.
978
+ * ...
979
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowCopyPaste)
980
+ */
981
+ rowCopyPasteFeature ? : object|Boolean|string|RowCopyPaste|RowCopyPasteConfig
982
+ /**
983
+ * This feature allows editing of entire rows in a grid in a docked panel which by default slides out from the right.
984
+ * ...
985
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowEdit)
986
+ */
987
+ rowEditFeature ? : object|Boolean|string|RowEdit|RowEditConfig
988
+ /**
989
+ * Enables expanding of Grid rows by either row click or double click, or by adding a separate Grid column which renders
990
+ * a button that expands or collapses the row.
991
+ * ...
992
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowExpander)
993
+ */
994
+ rowExpanderFeature ? : object|Boolean|string|RowExpander|RowExpanderConfig
995
+ /**
996
+ * Allows user to reorder rows by dragging them. To get notified about row reorder listen to `change` event
997
+ * on the grid [store](https://bryntum.com/products/grid/docs/api/Core/data/Store).
998
+ * ...
999
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowReorder)
1000
+ */
1001
+ rowReorderFeature ? : object|Boolean|string|RowReorder|RowReorderConfig
1002
+ /**
1003
+ * 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)
1004
+ * field of the record is updated (when [applyToAllRows](https://bryntum.com/products/grid/docs/api/Grid/feature/RowResize#config-applyToAllRows) is `false`).
1005
+ * ...
1006
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowResize)
1007
+ */
1008
+ rowResizeFeature ? : object|Boolean|string|RowResize|RowResizeConfig
1009
+ /**
1010
+ * <div class="external-example vertical" data-file="Grid/feature/Search.js"></div>
1011
+ * ...
1012
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Search)
1013
+ */
1014
+ searchFeature ? : object|Boolean|string|Search|SearchConfig
1015
+ /**
1016
+ * Allows sorting of grid by clicking (or tapping) headers, also displays which columns grid is sorted by (numbered if
1017
+ * using multisort). Use modifier keys for multisorting: [Ctrl/CMD + click] to add sorter, [Ctrl/CMD + Alt + click] to remove sorter.
1018
+ * The actual sorting is done by the store, see [Store.sort()](https://bryntum.com/products/grid/docs/api/Core/data/mixin/StoreSort#function-sort).
1019
+ * ...
1020
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Sort)
1021
+ */
1022
+ sortFeature ? : object|Boolean|string|Sort|SortConfig
1023
+ /**
1024
+ * This feature allows splitting the Grid into multiple views, either by using the cell context menu, or
1025
+ * programmatically by calling [split()](https://bryntum.com/products/grid/docs/api/Grid/feature/Split#function-split).
1026
+ * ...
1027
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Split)
1028
+ */
1029
+ splitFeature ? : object|Boolean|string|Split|SplitConfig
1030
+ /**
1031
+ * A feature which pins configurable content from a grid row to the top of the grid
1032
+ * while the row scrolls off the top but is still visible.
1033
+ * ...
1034
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/StickyCells)
1035
+ */
1036
+ stickyCellsFeature ? : object|Boolean|string|StickyCells|StickyCellsConfig
1037
+ /**
1038
+ * Stripes rows by adding alternating CSS classes to all row elements (`b-even` and `b-odd`).
1039
+ * ...
1040
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Stripe)
1041
+ */
1042
+ stripeFeature ? : object|Boolean|string|Stripe|StripeConfig
1043
+ /**
1044
+ * Displays a summary row in the grid footer.
1045
+ * ...
1046
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Summary)
1047
+ */
1048
+ summaryFeature ? : object|Boolean|string|Summary|SummaryConfig
1049
+ /**
1050
+ * 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
1051
+ * 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
1052
+ * tree renderer that adds padding and icon to give the appearance of a tree. The original renderer is preserved and
1053
+ * also called.
1054
+ * ...
1055
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Tree)
1056
+ */
1057
+ treeFeature ? : object|Boolean|string|Tree|TreeConfig
1058
+ /**
1059
+ * A feature that allows transforming a flat dataset (or the leaves of a hierarchical) into a tree by specifying a
1060
+ * record field per parent level. Parents are generated based on each leaf's value for those fields.
1061
+ * ...
1062
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/TreeGroup)
1063
+ */
1064
+ treeGroupFeature ? : object|Boolean|string|TreeGroup|TreeGroupConfig
1065
+
1066
+ }>();
1067
+
1068
+ const emit = defineEmits<{
1069
+ /**
1070
+ * Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
1071
+ * @param {string} e Event name
1072
+ * @param {object} params Event parameters
1073
+ * @param {string} params.e Event name
1074
+ * @param {object} params.params Event parameters
1075
+ * @param {object} params.params.event Event object
1076
+ * @param {Grid.view.Grid} params.params.event.source Owner grid
1077
+ * @param {Grid.util.GridLocation} params.params.event.editorContext Editing context
1078
+ */
1079
+ (e: 'beforeCancelCellEdit', params: ((event: { source: Grid, editorContext: GridLocation }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1080
+ /**
1081
+ * 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.
1082
+ * ...
1083
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-beforeCancelRowEdit)
1084
+ * @param {string} e Event name
1085
+ * @param {object} params Event parameters
1086
+ * @param {string} params.e Event name
1087
+ * @param {object} params.params Event parameters
1088
+ * @param {object} params.params.event Event object
1089
+ * @param {Grid.view.Grid} params.params.event.grid Target grid
1090
+ * @param {RowEditorContext} params.params.event.editorContext Editing context
1091
+ */
1092
+ (e: 'beforeCancelRowEdit', params: ((event: { grid: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1093
+ /**
1094
+ * Fires on the owning Grid before editing starts, return `false` to prevent editing
1095
+ * @param {string} e Event name
1096
+ * @param {object} params Event parameters
1097
+ * @param {string} params.e Event name
1098
+ * @param {object} params.params Event parameters
1099
+ * @param {object} params.params.event Event object
1100
+ * @param {Grid.view.Grid} params.params.event.source Owner grid
1101
+ * @param {CellEditorContext} params.params.event.editorContext Editing context
1102
+ */
1103
+ (e: 'beforeCellEditStart', params: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1104
+ /**
1105
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
1106
+ * buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
1107
+ * @param {string} e Event name
1108
+ * @param {object} params Event parameters
1109
+ * @param {string} params.e Event name
1110
+ * @param {object} params.params Event parameters
1111
+ * @param {object} params.params.event Event object
1112
+ * @param {Grid.view.Grid} params.params.event.source Owner grid
1113
+ * @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).
1114
+ */
1115
+ (e: 'beforeCellRangeDelete', params: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1116
+ /**
1117
+ * Fires for each selected record on the owning Grid before editing a range of selected cell values
1118
+ * @param {string} e Event name
1119
+ * @param {object} params Event parameters
1120
+ * @param {string} params.e Event name
1121
+ * @param {object} params.params Event parameters
1122
+ * @param {object} params.params.event Event object
1123
+ * @param {Core.data.Model} params.params.event.record Current selected record from the range
1124
+ * @param {string} params.params.event.field The field being changed
1125
+ * @param {any} params.params.event.value The value being set
1126
+ */
1127
+ (e: 'beforeCellRangeEdit', params: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1128
+ /**
1129
+ * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
1130
+ * @param {string} e Event name
1131
+ * @param {object} params Event parameters
1132
+ * @param {string} params.e Event name
1133
+ * @param {object} params.params Event parameters
1134
+ * @param {object} params.params.event Event object
1135
+ * @param {Grid.view.Grid} params.params.event.source The grid instance.
1136
+ * @param {Grid.column.Column} params.params.event.column The dragged column.
1137
+ * @param {Event} params.params.event.event The browser event.
1138
+ */
1139
+ (e: 'beforeColumnDragStart', params: ((event: { source: Grid, column: Column, event: Event }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1140
+ /**
1141
+ * This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
1142
+ * @param {string} e Event name
1143
+ * @param {object} params Event parameters
1144
+ * @param {string} params.e Event name
1145
+ * @param {object} params.params Event parameters
1146
+ * @param {object} params.params.event Event object
1147
+ * @param {Grid.view.Grid} params.params.event.source The grid instance.
1148
+ * @param {Grid.column.Column} params.params.event.column The dragged column.
1149
+ * @param {Grid.column.Column} params.params.event.insertBefore The column before which the dragged column will be inserted.
1150
+ * @param {Grid.column.Column} params.params.event.newParent The new parent column.
1151
+ * @param {Event} params.params.event.event The browser event.
1152
+ * @param {string} params.params.event.region The region where the column was dropped.
1153
+ */
1154
+ (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
1155
+ /**
1156
+ * This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
1157
+ * `false`.
1158
+ * @param {string} e Event name
1159
+ * @param {object} params Event parameters
1160
+ * @param {string} params.e Event name
1161
+ * @param {object} params.params Event parameters
1162
+ * @param {object} params.params.event Event object
1163
+ * @param {Grid.view.Grid} params.params.event.source The grid instance
1164
+ * @param {Grid.column.Column} params.params.event.column The column
1165
+ * @param {Event} params.params.event.domEvent The browser event
1166
+ */
1167
+ (e: 'beforeColumnResize', params: ((event: { source: Grid, column: Column, domEvent: Event }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1168
+ /**
1169
+ * Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
1170
+ * @param {string} e Event name
1171
+ * @param {object} params Event parameters
1172
+ * @param {string} params.e Event name
1173
+ * @param {object} params.params Event parameters
1174
+ * @param {object} params.params.event Event object
1175
+ * @param {Grid.view.Grid} params.params.event.source Owner grid
1176
+ * @param {Grid.util.GridLocation[]} params.params.event.cells The cells about to be copied or cut
1177
+ * @param {string} params.params.event.data The string data about to be copied or cut
1178
+ * @param {boolean} params.params.event.isCut `true` if this is a cut action
1179
+ * @param {string} params.params.event.entityName 'cell' to distinguish this event from other beforeCopy events
1180
+ */
1181
+ (e: 'beforeCopy', params: ((event: { source: Grid, cells: GridLocation[], data: string, isCut: boolean, entityName: string }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1182
+ /**
1183
+ * Fires on the owning Grid before CSV export starts. Return `false` to cancel the export.
1184
+ * @param {string} e Event name
1185
+ * @param {object} params Event parameters
1186
+ * @param {string} params.e Event name
1187
+ * @param {object} params.params Event parameters
1188
+ * @param {object} params.params.event Event object
1189
+ * @param {ExportConfig} params.params.event.config Export config
1190
+ * @param {Grid.column.Column[]} params.params.event.columns An array of columns to export
1191
+ * @param {Core.data.Model[]} params.params.event.rows An array of records to export
1192
+ * @param {string} params.params.event.lineDelimiter The CSV delimiter to separate lines
1193
+ * @param {string} params.params.event.columnDelimiter The CSV delimiter to separate values on one line
1194
+ */
1195
+ (e: 'beforeCSVExport', params: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1196
+ /**
1197
+ * Fires before an object is destroyed.
1198
+ * @param {string} e Event name
1199
+ * @param {object} params Event parameters
1200
+ * @param {string} params.e Event name
1201
+ * @param {object} params.params Event parameters
1202
+ * @param {object} params.params.event Event object
1203
+ * @param {Core.Base} params.params.event.source The Object that is being destroyed.
1204
+ */
1205
+ (e: 'beforeDestroy', params: ((event: { source: Base }) => void)|string): void
1206
+ /**
1207
+ * Fires on the owning Grid before Excel export starts. Return `false` to cancel the export.
1208
+ * @param {string} e Event name
1209
+ * @param {object} params Event parameters
1210
+ * @param {string} params.e Event name
1211
+ * @param {object} params.params Event parameters
1212
+ * @param {object} params.params.event Event object
1213
+ * @param {ExportConfig} params.params.event.config Export config
1214
+ * @param {XLSColumn[]} params.params.event.columns An array of columns to export
1215
+ * @param {any[][]} params.params.event.rows An array of records to export
1216
+ */
1217
+ (e: 'beforeExcelExport', params: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1218
+ /**
1219
+ * Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
1220
+ * @param {string} e Event name
1221
+ * @param {object} params Event parameters
1222
+ * @param {string} params.e Event name
1223
+ * @param {object} params.params Event parameters
1224
+ * @param {object} params.params.event Event object
1225
+ * @param {Grid.util.GridLocation} params.params.event.cell Information about the column / record
1226
+ * @param {MouseEvent} params.params.event.domEvent The raw DOM event
1227
+ */
1228
+ (e: 'beforeFillHandleDragStart', params: ((event: { cell: GridLocation, domEvent: MouseEvent }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1229
+ /**
1230
+ * 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.
1231
+ * @param {string} e Event name
1232
+ * @param {object} params Event parameters
1233
+ * @param {string} params.e Event name
1234
+ * @param {object} params.params Event parameters
1235
+ * @param {object} params.params.event Event object
1236
+ * @param {Grid.view.Grid} params.params.event.grid Target grid
1237
+ * @param {CellEditorContext} params.params.event.editorContext Editing context
1238
+ */
1239
+ (e: 'beforeFinishCellEdit', params: ((event: { grid: Grid, editorContext: CellEditorContext }) => void)|string): void
1240
+ /**
1241
+ * 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.
1242
+ * ...
1243
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-beforeFinishRowEdit)
1244
+ * @param {string} e Event name
1245
+ * @param {object} params Event parameters
1246
+ * @param {string} params.e Event name
1247
+ * @param {object} params.params Event parameters
1248
+ * @param {object} params.params.event Event object
1249
+ * @param {Grid.view.Grid} params.params.event.grid Target grid
1250
+ * @param {RowEditorContext} params.params.event.editorContext Editing context
1251
+ */
1252
+ (e: 'beforeFinishRowEdit', params: ((event: { grid: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1253
+ /**
1254
+ * Triggered before a widget is hidden. Return `false` to prevent the action.
1255
+ * @param {string} e Event name
1256
+ * @param {object} params Event parameters
1257
+ * @param {string} params.e Event name
1258
+ * @param {object} params.params Event parameters
1259
+ * @param {object} params.params.event Event object
1260
+ * @param {Core.widget.Widget} params.params.event.source The widget being hidden.
1261
+ */
1262
+ (e: 'beforeHide', params: ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1263
+ /**
1264
+ * Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
1265
+ * @param {string} e Event name
1266
+ * @param {object} params Event parameters
1267
+ * @param {string} params.e Event name
1268
+ * @param {object} params.params Event parameters
1269
+ * @param {object} params.params.event Event object
1270
+ * @param {Grid.view.Grid} params.params.event.source Owner grid
1271
+ * @param {string} params.params.event.clipboardData The clipboardData about to be pasted
1272
+ * @param {Grid.util.GridLocation} params.params.event.targetCell The cell from which the paste will be started
1273
+ * @param {string} params.params.event.entityName 'cell' to distinguish this event from other beforePaste events
1274
+ * @param {string} params.params.event.text The raw text from clipboard
1275
+ */
1276
+ (e: 'beforePaste', params: ((event: { source: Grid, clipboardData: string, targetCell: GridLocation, entityName: string, text: string }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1277
+ /**
1278
+ * Fires on the owning Grid before export started. Return `false` to cancel the export.
1279
+ * @param {string} e Event name
1280
+ * @param {object} params Event parameters
1281
+ * @param {string} params.e Event name
1282
+ * @param {object} params.params Event parameters
1283
+ * @param {object} params.params.event Event object
1284
+ * @param {object} params.params.event.config Export config
1285
+ */
1286
+ (e: 'beforePdfExport', params: ((event: { config: object }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1287
+ /**
1288
+ * Fires before a row is rendered.
1289
+ * @param {string} e Event name
1290
+ * @param {object} params Event parameters
1291
+ * @param {string} params.e Event name
1292
+ * @param {object} params.params Event parameters
1293
+ * @param {object} params.params.event Event object
1294
+ * @param {Grid.view.Grid} params.params.event.source The firing Grid instance.
1295
+ * @param {Grid.row.Row} params.params.event.row The row about to be rendered.
1296
+ * @param {Core.data.Model} params.params.event.record The record for the row.
1297
+ * @param {number} params.params.event.recordIndex The zero-based index of the record.
1298
+ */
1299
+ (e: 'beforeRenderRow', params: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string): void
1300
+ /**
1301
+ * Grid rows are about to be rendered
1302
+ * @param {string} e Event name
1303
+ * @param {object} params Event parameters
1304
+ * @param {string} params.e Event name
1305
+ * @param {object} params.params Event parameters
1306
+ * @param {object} params.params.event Event object
1307
+ * @param {Grid.view.Grid} params.params.event.source This grid.
1308
+ */
1309
+ (e: 'beforeRenderRows', params: ((event: { source: Grid }) => void)|string): void
1310
+ /**
1311
+ * This event fires before row collapse is started.
1312
+ * ...
1313
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-beforeRowCollapse)
1314
+ * @param {string} e Event name
1315
+ * @param {object} params Event parameters
1316
+ * @param {string} params.e Event name
1317
+ * @param {object} params.params Event parameters
1318
+ * @param {object} params.params.event Event object
1319
+ * @param {Core.data.Model} params.params.event.record Record
1320
+ */
1321
+ (e: 'beforeRowCollapse', params: ((event: { record: Model }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1322
+ /**
1323
+ * This event fires before row expand is started.
1324
+ * ...
1325
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-beforeRowExpand)
1326
+ * @param {string} e Event name
1327
+ * @param {object} params Event parameters
1328
+ * @param {string} params.e Event name
1329
+ * @param {object} params.params Event parameters
1330
+ * @param {object} params.params.event Event object
1331
+ * @param {Core.data.Model} params.params.event.record Record
1332
+ */
1333
+ (e: 'beforeRowExpand', params: ((event: { record: Model }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1334
+ /**
1335
+ * Fires before the selection changes. Returning `false` from a listener prevents the change
1336
+ * @param {string} e Event name
1337
+ * @param {object} params Event parameters
1338
+ * @param {string} params.e Event name
1339
+ * @param {object} params.params Event parameters
1340
+ * @param {object} params.params.event Event object
1341
+ * @param {string} params.params.event.action `'select'`/`'deselect'`
1342
+ * @param {'row','cell'} params.params.event.mode `'row'`/`'cell'`
1343
+ * @param {Grid.view.Grid} params.params.event.source
1344
+ * @param {Core.data.Model[]} params.params.event.deselected The records to be deselected in this operation.
1345
+ * @param {Core.data.Model[]} params.params.event.selected The records to be selected in this operation.
1346
+ * @param {Core.data.Model[]} params.params.event.selection The records in the current selection, before applying `selected` and `deselected`
1347
+ * @param {Grid.util.GridLocation[]} params.params.event.deselectedCells The cells to be deselected in this operation.
1348
+ * @param {Grid.util.GridLocation[]} params.params.event.selectedCells The cells to be selected in this operation.
1349
+ * @param {Grid.util.GridLocation[]} params.params.event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
1350
+ */
1351
+ (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
1352
+ /**
1353
+ * Fired before this container will load record values into its child fields. This is useful if you
1354
+ * want to modify the UI before data is loaded (e.g. set some input field to be readonly)
1355
+ * @param {string} e Event name
1356
+ * @param {object} params Event parameters
1357
+ * @param {string} params.e Event name
1358
+ * @param {object} params.params Event parameters
1359
+ * @param {object} params.params.event Event object
1360
+ * @param {Core.widget.Container} params.params.event.source The container
1361
+ * @param {Core.data.Model} params.params.event.record The record
1362
+ */
1363
+ (e: 'beforeSetRecord', params: ((event: { source: Container, record: Model }) => void)|string): void
1364
+ /**
1365
+ * Triggered before a widget is shown. Return `false` to prevent the action.
1366
+ * @param {string} e Event name
1367
+ * @param {object} params Event parameters
1368
+ * @param {string} params.e Event name
1369
+ * @param {object} params.params Event parameters
1370
+ * @param {object} params.params.event Event object
1371
+ * @param {Core.widget.Widget,any} params.params.event.source The widget being shown
1372
+ */
1373
+ (e: 'beforeShow', params: ((event: { source: Widget|any }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1374
+ /**
1375
+ * Fires on the owning Grid before editing starts, return `false` to prevent editing
1376
+ * @param {string} e Event name
1377
+ * @param {object} params Event parameters
1378
+ * @param {string} params.e Event name
1379
+ * @param {object} params.params Event parameters
1380
+ * @param {object} params.params.event Event object
1381
+ * @param {Grid.view.Grid} params.params.event.source Owner grid
1382
+ * @param {RowEditorContext} params.params.event.editorContext Editing context
1383
+ */
1384
+ (e: 'beforeStartRowEdit', params: ((event: { source: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1385
+ /**
1386
+ * Fired before state is applied to the source. Allows editing the state object or preventing the operation.
1387
+ * @param {string} e Event name
1388
+ * @param {object} params Event parameters
1389
+ * @param {string} params.e Event name
1390
+ * @param {object} params.params Event parameters
1391
+ * @param {object} params.params.event Event object
1392
+ * @param {GridStateInfo} params.params.event.state State object config
1393
+ */
1394
+ (e: 'beforeStateApply', params: ((event: { state: GridStateInfo }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1395
+ /**
1396
+ * Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
1397
+ * @param {string} e Event name
1398
+ * @param {object} params Event parameters
1399
+ * @param {string} params.e Event name
1400
+ * @param {object} params.params Event parameters
1401
+ * @param {object} params.params.event Event object
1402
+ * @param {GridStateInfo} params.params.event.state State object config
1403
+ */
1404
+ (e: 'beforeStateSave', params: ((event: { state: GridStateInfo }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1405
+ /**
1406
+ * Fired when a group is going to be expanded or collapsed using the UI.
1407
+ * Returning `false` from a listener prevents the operation
1408
+ * @param {string} e Event name
1409
+ * @param {object} params Event parameters
1410
+ * @param {string} params.e Event name
1411
+ * @param {object} params.params Event parameters
1412
+ * @param {object} params.params.event Event object
1413
+ * @param {Core.data.Model} params.params.event.groupRecord [DEPRECATED] Use `groupRecords` param instead
1414
+ * @param {Core.data.Model[]} params.params.event.groupRecords The group records being toggled
1415
+ * @param {boolean} params.params.event.collapse Collapsed (true) or expanded (false)
1416
+ * @param {Event} params.params.event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
1417
+ */
1418
+ (e: 'beforeToggleGroup', params: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1419
+ /**
1420
+ * Fired before a parent node record toggles its collapsed state.
1421
+ * @param {string} e Event name
1422
+ * @param {object} params Event parameters
1423
+ * @param {string} params.e Event name
1424
+ * @param {object} params.params Event parameters
1425
+ * @param {object} params.params.event Event object
1426
+ * @param {Grid.view.Grid} params.params.event.source The firing Grid instance.
1427
+ * @param {Core.data.Model} params.params.event.record The record being toggled.
1428
+ * @param {boolean} params.params.event.collapse `true` if the node is being collapsed.
1429
+ */
1430
+ (e: 'beforeToggleNode', params: ((event: { source: Grid, record: Model, collapse: boolean }) => void)|string): void
1431
+ /**
1432
+ * Fires on the owning Grid when editing is cancelled
1433
+ * @param {string} e Event name
1434
+ * @param {object} params Event parameters
1435
+ * @param {string} params.e Event name
1436
+ * @param {object} params.params Event parameters
1437
+ * @param {object} params.params.event Event object
1438
+ * @param {Grid.view.Grid} params.params.event.source Owner grid
1439
+ * @param {Grid.util.GridLocation} params.params.event.editorContext Editing context
1440
+ * @param {Event} params.params.event.event Included if the cancellation was triggered by a DOM event
1441
+ */
1442
+ (e: 'cancelCellEdit', params: ((event: { source: Grid, editorContext: GridLocation, event: Event }) => void)|string): void
1443
+ /**
1444
+ * Fires when any other event is fired from the object.
1445
+ * ...
1446
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-catchAll)
1447
+ * @param {string} e Event name
1448
+ * @param {object} params Event parameters
1449
+ * @param {string} params.e Event name
1450
+ * @param {object} params.params Event parameters
1451
+ * @param {object} params.params.event Event object
1452
+ * @param {{[key: string]: any, type: string}} params.params.event.event The Object that contains event details
1453
+ * @param {string} params.params.event.event.type The type of the event which is caught by the listener
1454
+ */
1455
+ (e: 'catchAll', params: ((event: {[key: string]: any, type: string}) => void)|string): void
1456
+ /**
1457
+ * Fired when user clicks in a grid cell
1458
+ * @param {string} e Event name
1459
+ * @param {object} params Event parameters
1460
+ * @param {string} params.e Event name
1461
+ * @param {object} params.params Event parameters
1462
+ * @param {object} params.params.event Event object
1463
+ * @param {Grid.view.Grid} params.params.event.grid The grid instance
1464
+ * @param {Core.data.Model} params.params.event.record The record representing the row
1465
+ * @param {Grid.column.Column} params.params.event.column The column to which the cell belongs
1466
+ * @param {HTMLElement} params.params.event.cellElement The cell HTML element
1467
+ * @param {HTMLElement} params.params.event.target The target element
1468
+ * @param {MouseEvent} params.params.event.event The native DOM event
1469
+ */
1470
+ (e: 'cellClick', params: ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string): void
1471
+ /**
1472
+ * Fired when user activates contextmenu in a grid cell
1473
+ * @param {string} e Event name
1474
+ * @param {object} params Event parameters
1475
+ * @param {string} params.e Event name
1476
+ * @param {object} params.params Event parameters
1477
+ * @param {object} params.params.event Event object
1478
+ * @param {Grid.view.Grid} params.params.event.grid The grid instance
1479
+ * @param {Core.data.Model} params.params.event.record The record representing the row
1480
+ * @param {Grid.column.Column} params.params.event.column The column to which the cell belongs
1481
+ * @param {HTMLElement} params.params.event.cellElement The cell HTML element
1482
+ * @param {HTMLElement} params.params.event.target The target element
1483
+ * @param {MouseEvent} params.params.event.event The native DOM event
1484
+ */
1485
+ (e: 'cellContextMenu', params: ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string): void
1486
+ /**
1487
+ * Fired when user double clicks a grid cell
1488
+ * @param {string} e Event name
1489
+ * @param {object} params Event parameters
1490
+ * @param {string} params.e Event name
1491
+ * @param {object} params.params Event parameters
1492
+ * @param {object} params.params.event Event object
1493
+ * @param {Grid.view.Grid} params.params.event.grid The grid instance
1494
+ * @param {Core.data.Model} params.params.event.record The record representing the row
1495
+ * @param {Grid.column.Column} params.params.event.column The column to which the cell belongs
1496
+ * @param {HTMLElement} params.params.event.cellElement The cell HTML element
1497
+ * @param {HTMLElement} params.params.event.target The target element
1498
+ * @param {MouseEvent} params.params.event.event The native DOM event
1499
+ */
1500
+ (e: 'cellDblClick', params: ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string): void
1501
+ /**
1502
+ * This event fires on the owning grid before the context menu is shown for a cell.
1503
+ * 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).
1504
+ * ...
1505
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-cellMenuBeforeShow)
1506
+ * @param {string} e Event name
1507
+ * @param {object} params Event parameters
1508
+ * @param {string} params.e Event name
1509
+ * @param {object} params.params Event parameters
1510
+ * @param {object} params.params.event Event object
1511
+ * @param {Grid.view.Grid} params.params.event.source The grid
1512
+ * @param {Core.widget.Menu} params.params.event.menu The menu
1513
+ * @param {Record<string, MenuItemEntry>} params.params.event.items Menu item configs
1514
+ * @param {Grid.column.Column} params.params.event.column Column
1515
+ * @param {Core.data.Model} params.params.event.record Record
1516
+ */
1517
+ (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
1518
+ /**
1519
+ * This event fires on the owning grid when an item is selected in the cell context menu.
1520
+ * @param {string} e Event name
1521
+ * @param {object} params Event parameters
1522
+ * @param {string} params.e Event name
1523
+ * @param {object} params.params Event parameters
1524
+ * @param {object} params.params.event Event object
1525
+ * @param {Grid.view.Grid} params.params.event.source The grid
1526
+ * @param {Core.widget.Menu} params.params.event.menu The menu
1527
+ * @param {Core.widget.MenuItem} params.params.event.item Selected menu item
1528
+ * @param {Grid.column.Column} params.params.event.column Column
1529
+ * @param {Core.data.Model} params.params.event.record Record
1530
+ */
1531
+ (e: 'cellMenuItem', params: ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column, record: Model }) => void)|string): void
1532
+ /**
1533
+ * This event fires on the owning grid after the context menu is shown for a cell.
1534
+ * @param {string} e Event name
1535
+ * @param {object} params Event parameters
1536
+ * @param {string} params.e Event name
1537
+ * @param {object} params.params Event parameters
1538
+ * @param {object} params.params.event Event object
1539
+ * @param {Grid.view.Grid} params.params.event.source The grid
1540
+ * @param {Core.widget.Menu} params.params.event.menu The menu
1541
+ * @param {Record<string, MenuItemEntry>} params.params.event.items Menu item configs
1542
+ * @param {Grid.column.Column} params.params.event.column Column
1543
+ * @param {Core.data.Model} params.params.event.record Record
1544
+ */
1545
+ (e: 'cellMenuShow', params: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => void)|string): void
1546
+ /**
1547
+ * This event fires on the owning grid when a check item is toggled in the cell context menu.
1548
+ * @param {string} e Event name
1549
+ * @param {object} params Event parameters
1550
+ * @param {string} params.e Event name
1551
+ * @param {object} params.params Event parameters
1552
+ * @param {object} params.params.event Event object
1553
+ * @param {Grid.view.Grid} params.params.event.source The grid
1554
+ * @param {Core.widget.Menu} params.params.event.menu The menu
1555
+ * @param {Core.widget.MenuItem} params.params.event.item Selected menu item
1556
+ * @param {Grid.column.Column} params.params.event.column Column
1557
+ * @param {Core.data.Model} params.params.event.record Record
1558
+ * @param {boolean} params.params.event.checked Checked or not
1559
+ */
1560
+ (e: 'cellMenuToggleItem', params: ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column, record: Model, checked: boolean }) => void)|string): void
1561
+ /**
1562
+ * Fired when the mouse enters a cell
1563
+ * @param {string} e Event name
1564
+ * @param {object} params Event parameters
1565
+ * @param {string} params.e Event name
1566
+ * @param {object} params.params Event parameters
1567
+ * @param {object} params.params.event Event object
1568
+ * @param {Grid.view.Grid} params.params.event.source The grid instance
1569
+ * @param {Core.data.Model} params.params.event.record The record representing the hovered cell
1570
+ * @param {Grid.column.Column} params.params.event.column The column currently hovered
1571
+ * @param {HTMLElement} params.params.event.cellElement The cell HTML element
1572
+ * @param {MouseEvent} params.params.event.event The native DOM event
1573
+ */
1574
+ (e: 'cellMouseEnter', params: ((event: { source: Grid, record: Model, column: Column, cellElement: HTMLElement, event: MouseEvent }) => void)|string): void
1575
+ /**
1576
+ * Fired when the mouse leaves a cell
1577
+ * @param {string} e Event name
1578
+ * @param {object} params Event parameters
1579
+ * @param {string} params.e Event name
1580
+ * @param {object} params.params Event parameters
1581
+ * @param {object} params.params.event Event object
1582
+ * @param {Grid.view.Grid} params.params.event.source The grid instance
1583
+ * @param {Core.data.Model} params.params.event.record The record representing the cell that the mouse left
1584
+ * @param {Grid.column.Column} params.params.event.column The column representing the cell that the mouse left
1585
+ * @param {HTMLElement} params.params.event.cellElement The cell HTML element that the mouse left
1586
+ * @param {MouseEvent} params.params.event.event The native DOM event
1587
+ */
1588
+ (e: 'cellMouseLeave', params: ((event: { source: Grid, record: Model, column: Column, cellElement: HTMLElement, event: MouseEvent }) => void)|string): void
1589
+ /**
1590
+ * Fired when a user moves the mouse out of a grid cell
1591
+ * @param {string} e Event name
1592
+ * @param {object} params Event parameters
1593
+ * @param {string} params.e Event name
1594
+ * @param {object} params.params Event parameters
1595
+ * @param {object} params.params.event Event object
1596
+ * @param {Grid.view.Grid} params.params.event.grid The grid instance
1597
+ * @param {Core.data.Model} params.params.event.record The record representing the row
1598
+ * @param {Grid.column.Column} params.params.event.column The column to which the cell belongs
1599
+ * @param {HTMLElement} params.params.event.cellElement The cell HTML element
1600
+ * @param {HTMLElement} params.params.event.target The target element
1601
+ * @param {MouseEvent} params.params.event.event The native DOM event
1602
+ */
1603
+ (e: 'cellMouseOut', params: ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string): void
1604
+ /**
1605
+ * Fired when user moves the mouse over a grid cell
1606
+ * @param {string} e Event name
1607
+ * @param {object} params Event parameters
1608
+ * @param {string} params.e Event name
1609
+ * @param {object} params.params Event parameters
1610
+ * @param {object} params.params.event Event object
1611
+ * @param {Grid.view.Grid} params.params.event.grid The grid instance
1612
+ * @param {Core.data.Model} params.params.event.record The record representing the row
1613
+ * @param {Grid.column.Column} params.params.event.column The column to which the cell belongs
1614
+ * @param {HTMLElement} params.params.event.cellElement The cell HTML element
1615
+ * @param {HTMLElement} params.params.event.target The target element
1616
+ * @param {MouseEvent} params.params.event.event The native DOM event
1617
+ */
1618
+ (e: 'cellMouseOver', params: ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string): void
1619
+ /**
1620
+ * Fires when a Panel is collapsed using the [collapsible](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-collapsible) setting.
1621
+ * @param {string} e Event name
1622
+ * @param {object} params Event parameters
1623
+ * @param {string} params.e Event name
1624
+ * @param {object} params.params Event parameters
1625
+ * @param {object} params.params.event Event object
1626
+ * @param {Core.widget.Panel} params.params.event.source This Panel.
1627
+ */
1628
+ (e: 'collapse', params: ((event: { source: Panel }) => void)|string): void
1629
+ /**
1630
+ * Fired before a parent node record is collapsed.
1631
+ * @param {string} e Event name
1632
+ * @param {object} params Event parameters
1633
+ * @param {string} params.e Event name
1634
+ * @param {object} params.params Event parameters
1635
+ * @param {object} params.params.event Event object
1636
+ * @param {Grid.view.Grid} params.params.event.source The firing Grid instance.
1637
+ * @param {Core.data.Model} params.params.event.record The record which has been collapsed.
1638
+ */
1639
+ (e: 'collapseNode', params: ((event: { source: Grid, record: Model }) => void)|string): void
1640
+ /**
1641
+ * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
1642
+ * to indicate whether the drop position is valid or not.
1643
+ * @param {string} e Event name
1644
+ * @param {object} params Event parameters
1645
+ * @param {string} params.e Event name
1646
+ * @param {object} params.params Event parameters
1647
+ * @param {object} params.params.event Event object
1648
+ * @param {Grid.view.Grid} params.params.event.source The grid instance.
1649
+ * @param {Grid.column.Column} params.params.event.column The dragged column.
1650
+ * @param {Grid.column.Column} params.params.event.insertBefore The column before which the dragged column will be inserted (if not last).
1651
+ * @param {Event} params.params.event.event The browser event.
1652
+ * @param {object} params.params.event.context
1653
+ * @param {boolean} params.params.event.context.valid Set this to `true` or `false` to indicate whether the drop position is valid.
1654
+ */
1655
+ (e: 'columnDrag', params: ((event: { source: Grid, column: Column, insertBefore: Column, event: Event, context: { valid: boolean } }) => void)|string): void
1656
+ /**
1657
+ * This event is fired when a column drag gesture has started.
1658
+ * @param {string} e Event name
1659
+ * @param {object} params Event parameters
1660
+ * @param {string} params.e Event name
1661
+ * @param {object} params.params Event parameters
1662
+ * @param {object} params.params.event Event object
1663
+ * @param {Grid.view.Grid} params.params.event.source The grid instance.
1664
+ * @param {Grid.column.Column} params.params.event.column The dragged column.
1665
+ * @param {Event} params.params.event.event The browser event.
1666
+ */
1667
+ (e: 'columnDragStart', params: ((event: { source: Grid, column: Column, event: Event }) => void)|string): void
1668
+ /**
1669
+ * This event is always fired after a column is dropped. The `valid` param is `true` if the operation was not
1670
+ * vetoed and the column was moved in the column store.
1671
+ * @param {string} e Event name
1672
+ * @param {object} params Event parameters
1673
+ * @param {string} params.e Event name
1674
+ * @param {object} params.params Event parameters
1675
+ * @param {object} params.params.event Event object
1676
+ * @param {Grid.view.Grid} params.params.event.source The grid instance.
1677
+ * @param {Grid.column.Column} params.params.event.column The dragged column.
1678
+ * @param {Grid.column.Column} params.params.event.insertBefore The column before which the dragged column will be inserted.
1679
+ * @param {Grid.column.Column} params.params.event.newParent The new parent column.
1680
+ * @param {boolean} params.params.event.valid `true` if the operation was not vetoed.
1681
+ * @param {Event} params.params.event.event The browser event.
1682
+ * @param {string} params.params.event.region The region where the column was dropped.
1683
+ */
1684
+ (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
1685
+ /**
1686
+ * This event is fired after a resize gesture is completed.
1687
+ * @param {string} e Event name
1688
+ * @param {object} params Event parameters
1689
+ * @param {string} params.e Event name
1690
+ * @param {object} params.params Event parameters
1691
+ * @param {object} params.params.event Event object
1692
+ * @param {Grid.view.Grid} params.params.event.source The grid instance
1693
+ * @param {Grid.column.Column} params.params.event.column The resized column
1694
+ * @param {Event} params.params.event.domEvent The browser event
1695
+ */
1696
+ (e: 'columnResize', params: ((event: { source: Grid, column: Column, domEvent: Event }) => void)|string): void
1697
+ /**
1698
+ * This event is fired when a column resize gesture starts.
1699
+ * @param {string} e Event name
1700
+ * @param {object} params Event parameters
1701
+ * @param {string} params.e Event name
1702
+ * @param {object} params.params Event parameters
1703
+ * @param {object} params.params.event Event object
1704
+ * @param {Grid.view.Grid} params.params.event.source The grid instance
1705
+ * @param {Grid.column.Column} params.params.event.column The column
1706
+ * @param {Event} params.params.event.domEvent The browser event
1707
+ */
1708
+ (e: 'columnResizeStart', params: ((event: { source: Grid, column: Column, domEvent: Event }) => void)|string): void
1709
+ /**
1710
+ * This event fires on the owning widget when an item is selected in the context menu.
1711
+ * @param {string} e Event name
1712
+ * @param {object} params Event parameters
1713
+ * @param {string} params.e Event name
1714
+ * @param {object} params.params Event parameters
1715
+ * @param {object} params.params.event Event object
1716
+ * @param {Core.widget.Widget} params.params.event.source The owning widget
1717
+ * @param {Core.widget.Menu} params.params.event.menu The menu
1718
+ * @param {Core.widget.MenuItem} params.params.event.item Selected menu item
1719
+ */
1720
+ (e: 'contextMenuItem', params: ((event: { source: Widget, menu: Menu, item: MenuItem }) => void)|string): void
1721
+ /**
1722
+ * This event fires on the owning widget when a check item is toggled in the context menu.
1723
+ * @param {string} e Event name
1724
+ * @param {object} params Event parameters
1725
+ * @param {string} params.e Event name
1726
+ * @param {object} params.params Event parameters
1727
+ * @param {object} params.params.event Event object
1728
+ * @param {Core.widget.Widget} params.params.event.source The owning widget
1729
+ * @param {Core.widget.Menu} params.params.event.menu The menu
1730
+ * @param {Core.widget.MenuItem} params.params.event.item Selected menu item
1731
+ * @param {boolean} params.params.event.checked Checked or not
1732
+ */
1733
+ (e: 'contextMenuToggleItem', params: ((event: { source: Widget, menu: Menu, item: MenuItem, checked: boolean }) => void)|string): void
1734
+ /**
1735
+ * Fires on the owning Grid after a copy action is performed.
1736
+ * @param {string} e Event name
1737
+ * @param {object} params Event parameters
1738
+ * @param {string} params.e Event name
1739
+ * @param {object} params.params Event parameters
1740
+ * @param {object} params.params.event Event object
1741
+ * @param {Grid.view.Grid} params.params.event.source Owner grid
1742
+ * @param {Grid.util.GridLocation[]} params.params.event.cells The cells about to be copied or cut
1743
+ * @param {string} params.params.event.copiedDataString The concatenated data string that was copied or cut
1744
+ * @param {boolean} params.params.event.isCut `true` if this was a cut action
1745
+ * @param {string} params.params.event.entityName 'cell' to distinguish this event from other copy events
1746
+ */
1747
+ (e: 'copy', params: ((event: { source: Grid, cells: GridLocation[], copiedDataString: string, isCut: boolean, entityName: string }) => void)|string): void
1748
+ /**
1749
+ * Fired when data in the store changes.
1750
+ * ...
1751
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-dataChange)
1752
+ * @param {string} e Event name
1753
+ * @param {object} params Event parameters
1754
+ * @param {string} params.e Event name
1755
+ * @param {object} params.params Event parameters
1756
+ * @param {object} params.params.event Event object
1757
+ * @param {Grid.view.Grid} params.params.event.source Owning grid
1758
+ * @param {Core.data.Store} params.params.event.store The originating store
1759
+ * @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'`
1760
+ * @param {Core.data.Model} params.params.event.record Changed record, for actions that affects exactly one record (`'update'`)
1761
+ * @param {Core.data.Model[]} params.params.event.records Changed records, passed for all actions except `'removeAll'`
1762
+ * @param {object} params.params.event.changes Passed for the `'update'` action, info on which record fields changed
1763
+ */
1764
+ (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
1765
+ /**
1766
+ * Fires when an object is destroyed.
1767
+ * @param {string} e Event name
1768
+ * @param {object} params Event parameters
1769
+ * @param {string} params.e Event name
1770
+ * @param {object} params.params Event parameters
1771
+ * @param {object} params.params.event Event object
1772
+ * @param {Core.Base} params.params.event.source The Object that is being destroyed.
1773
+ */
1774
+ (e: 'destroy', params: ((event: { source: Base }) => void)|string): void
1775
+ /**
1776
+ * 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
1777
+ * @param {string} e Event name
1778
+ * @param {object} params Event parameters
1779
+ * @param {string} params.e Event name
1780
+ * @param {object} params.params Event parameters
1781
+ * @param {object} params.params.event Event object
1782
+ * @param {Core.widget.Container} params.params.event.source The container.
1783
+ * @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.
1784
+ */
1785
+ (e: 'dirtyStateChange', params: ((event: { source: Container, dirty: boolean }) => void)|string): void
1786
+ /**
1787
+ * Fires while drag selecting. UI will update with current range, but the cells will not be selected until
1788
+ * mouse up. This event can be listened for to perform actions while drag selecting.
1789
+ * @param {string} e Event name
1790
+ * @param {object} params Event parameters
1791
+ * @param {string} params.e Event name
1792
+ * @param {object} params.params Event parameters
1793
+ * @param {object} params.params.event Event object
1794
+ * @param {Grid.view.Grid} params.params.event.source
1795
+ * @param {GridLocationConfig[],Grid.util.GridLocation[]} params.params.event.selectedCells The cells that is currently being dragged over
1796
+ * @param {Core.data.Model[]} params.params.event.selectedRecords The records that is currently being dragged over
1797
+ */
1798
+ (e: 'dragSelecting', params: ((event: { source: Grid, selectedCells: GridLocationConfig[]|GridLocation[], selectedRecords: Model[] }) => void)|string): void
1799
+ /**
1800
+ * Triggered when a widget's [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element) is available.
1801
+ * @param {string} e Event name
1802
+ * @param {object} params Event parameters
1803
+ * @param {string} params.e Event name
1804
+ * @param {object} params.params Event parameters
1805
+ * @param {object} params.params.event Event object
1806
+ * @param {HTMLElement} params.params.event.element The Widget's element.
1807
+ */
1808
+ (e: 'elementCreated', params: ((event: { element: HTMLElement }) => void)|string): void
1809
+ /**
1810
+ * Fires when a Panel is expanded using the [collapsible](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-collapsible) setting.
1811
+ * @param {string} e Event name
1812
+ * @param {object} params Event parameters
1813
+ * @param {string} params.e Event name
1814
+ * @param {object} params.params Event parameters
1815
+ * @param {object} params.params.event Event object
1816
+ * @param {Core.widget.Panel} params.params.event.source This Panel.
1817
+ */
1818
+ (e: 'expand', params: ((event: { source: Panel }) => void)|string): void
1819
+ /**
1820
+ * Fired after a parent node record is expanded.
1821
+ * @param {string} e Event name
1822
+ * @param {object} params Event parameters
1823
+ * @param {string} params.e Event name
1824
+ * @param {object} params.params Event parameters
1825
+ * @param {object} params.params.event Event object
1826
+ * @param {Grid.view.Grid} params.params.event.source The firing Grid instance.
1827
+ * @param {Core.data.Model} params.params.event.record The record which has been expanded.
1828
+ */
1829
+ (e: 'expandNode', params: ((event: { source: Grid, record: Model }) => void)|string): void
1830
+ /**
1831
+ * Fired when a file is dropped on the widget element
1832
+ * @param {string} e Event name
1833
+ * @param {object} params Event parameters
1834
+ * @param {string} params.e Event name
1835
+ * @param {object} params.params Event parameters
1836
+ * @param {object} params.params.event Event object
1837
+ * @param {Grid.view.Grid} params.params.event.source The owning Grid instance
1838
+ * @param {DataTransferItem} params.params.event.file The dropped file descriptor
1839
+ * @param {DragEvent} params.params.event.domEvent The native DragEvent
1840
+ */
1841
+ (e: 'fileDrop', params: ((event: { source: Grid, file: DataTransferItem, domEvent: DragEvent }) => void)|string): void
1842
+ /**
1843
+ * Fired before the FillHandle dragging is finalized and values are applied to cells, return `false` to prevent the
1844
+ * drag operation from applying data changes.
1845
+ * @param {string} e Event name
1846
+ * @param {object} params Event parameters
1847
+ * @param {string} params.e Event name
1848
+ * @param {object} params.params Event parameters
1849
+ * @param {object} params.params.event Event object
1850
+ * @param {Grid.util.GridLocation} params.params.event.from The from cell
1851
+ * @param {Grid.util.GridLocation} params.params.event.to The to cell
1852
+ * @param {MouseEvent} params.params.event.domEvent The raw DOM event
1853
+ */
1854
+ (e: 'fillHandleBeforeDragFinalize', params: ((event: { from: GridLocation, to: GridLocation, domEvent: MouseEvent }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1855
+ /**
1856
+ * Fired while dragging the FillHandle.
1857
+ * @param {string} e Event name
1858
+ * @param {object} params Event parameters
1859
+ * @param {string} params.e Event name
1860
+ * @param {object} params.params Event parameters
1861
+ * @param {object} params.params.event Event object
1862
+ * @param {Grid.util.GridLocation} params.params.event.from The from cell
1863
+ * @param {Grid.util.GridLocation} params.params.event.to The to cell
1864
+ * @param {MouseEvent} params.params.event.domEvent The raw DOM event
1865
+ */
1866
+ (e: 'fillHandleDrag', params: ((event: { from: GridLocation, to: GridLocation, domEvent: MouseEvent }) => void)|string): void
1867
+ /**
1868
+ * Fired when a FillHandle drag operation is aborted.
1869
+ */
1870
+ (e: 'fillHandleDragAbort', params: (() => void)|string): void
1871
+ /**
1872
+ * Fired after a FillHandle drag operation.
1873
+ * @param {string} e Event name
1874
+ * @param {object} params Event parameters
1875
+ * @param {string} params.e Event name
1876
+ * @param {object} params.params Event parameters
1877
+ * @param {object} params.params.event Event object
1878
+ * @param {Grid.util.GridLocation} params.params.event.from The from cell
1879
+ * @param {Grid.util.GridLocation} params.params.event.to The to cell
1880
+ * @param {MouseEvent} params.params.event.domEvent The raw DOM event
1881
+ */
1882
+ (e: 'fillHandleDragEnd', params: ((event: { from: GridLocation, to: GridLocation, domEvent: MouseEvent }) => void)|string): void
1883
+ /**
1884
+ * Fired when dragging of the FillHandle starts.
1885
+ * @param {string} e Event name
1886
+ * @param {object} params Event parameters
1887
+ * @param {string} params.e Event name
1888
+ * @param {object} params.params Event parameters
1889
+ * @param {object} params.params.event Event object
1890
+ * @param {Grid.util.GridLocation} params.params.event.cell Information about the column / record
1891
+ * @param {MouseEvent} params.params.event.domEvent The raw DOM event
1892
+ */
1893
+ (e: 'fillHandleDragStart', params: ((event: { cell: GridLocation, domEvent: MouseEvent }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1894
+ /**
1895
+ * Fires on the owning Grid when cell editing is finished
1896
+ * @param {string} e Event name
1897
+ * @param {object} params Event parameters
1898
+ * @param {string} params.e Event name
1899
+ * @param {object} params.params Event parameters
1900
+ * @param {object} params.params.event Event object
1901
+ * @param {Grid.view.Grid} params.params.event.grid Target grid
1902
+ * @param {CellEditorContext} params.params.event.editorContext Editing context
1903
+ */
1904
+ (e: 'finishCellEdit', params: ((event: { grid: Grid, editorContext: CellEditorContext }) => void)|string): void
1905
+ /**
1906
+ * 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.
1907
+ * ...
1908
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-finishRowEdit)
1909
+ * @param {string} e Event name
1910
+ * @param {object} params Event parameters
1911
+ * @param {string} params.e Event name
1912
+ * @param {object} params.params Event parameters
1913
+ * @param {object} params.params.event Event object
1914
+ * @param {Grid.view.Grid} params.params.event.grid Target grid
1915
+ * @param {RowEditorContext} params.params.event.editorContext Editing context
1916
+ */
1917
+ (e: 'finishRowEdit', params: ((event: { grid: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1918
+ /**
1919
+ * Fired when focus enters this Widget.
1920
+ * @param {string} e Event name
1921
+ * @param {object} params Event parameters
1922
+ * @param {string} params.e Event name
1923
+ * @param {object} params.params Event parameters
1924
+ * @param {object} params.params.event Event object
1925
+ * @param {Core.widget.Widget} params.params.event.source This Widget
1926
+ * @param {HTMLElement} params.params.event.fromElement The element which lost focus.
1927
+ * @param {HTMLElement} params.params.event.toElement The element which gained focus.
1928
+ * @param {Core.widget.Widget} params.params.event.fromWidget The widget which lost focus.
1929
+ * @param {Core.widget.Widget} params.params.event.toWidget The widget which gained focus.
1930
+ * @param {boolean} params.params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
1931
+ */
1932
+ (e: 'focusIn', params: ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string): void
1933
+ /**
1934
+ * Fired when focus exits this Widget's ownership tree. This is different from a `blur` event.
1935
+ * focus moving from within this Widget's ownership tree, even if there are floating widgets
1936
+ * will not trigger this event. This is when focus exits this widget completely.
1937
+ * @param {string} e Event name
1938
+ * @param {object} params Event parameters
1939
+ * @param {string} params.e Event name
1940
+ * @param {object} params.params Event parameters
1941
+ * @param {object} params.params.event Event object
1942
+ * @param {Core.widget.Widget} params.params.event.source This Widget
1943
+ * @param {HTMLElement} params.params.event.fromElement The element which lost focus.
1944
+ * @param {HTMLElement} params.params.event.toElement The element which gained focus.
1945
+ * @param {Core.widget.Widget} params.params.event.fromWidget The widget which lost focus.
1946
+ * @param {Core.widget.Widget} params.params.event.toWidget The widget which gained focus.
1947
+ * @param {boolean} params.params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
1948
+ */
1949
+ (e: 'focusOut', params: ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string): void
1950
+ /**
1951
+ * Fired before dragging starts, return false to prevent the drag operation.
1952
+ * @param {string} e Event name
1953
+ * @param {object} params Event parameters
1954
+ * @param {string} params.e Event name
1955
+ * @param {object} params.params Event parameters
1956
+ * @param {object} params.params.event Event object
1957
+ * @param {Grid.view.GridBase} params.params.event.source
1958
+ * @param {object} params.params.event.context
1959
+ * @param {Core.data.Model[]} params.params.event.context.records The dragged row records
1960
+ * @param {MouseEvent,TouchEvent} params.params.event.event
1961
+ */
1962
+ (e: 'gridRowBeforeDragStart', params: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1963
+ /**
1964
+ * Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
1965
+ * Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
1966
+ * @param {string} e Event name
1967
+ * @param {object} params Event parameters
1968
+ * @param {string} params.e Event name
1969
+ * @param {object} params.params Event parameters
1970
+ * @param {object} params.params.event Event object
1971
+ * @param {Grid.view.GridBase} params.params.event.source
1972
+ * @param {object} params.params.event.context
1973
+ * @param {boolean} params.params.event.context.valid Set this to true or false to indicate whether the drop position is valid
1974
+ * @param {Core.data.Model} params.params.event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
1975
+ * @param {Core.data.Model} params.params.event.context.parent The parent record of the current drop position (only applicable for trees)
1976
+ * @param {Core.data.Model[]} params.params.event.context.records The dragged row records
1977
+ * @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
1978
+ * @param {MouseEvent} params.params.event.event
1979
+ */
1980
+ (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
1981
+ /**
1982
+ * Fired while the row is being dragged, in the listener function you have access to `context.insertBefore` a grid /
1983
+ * tree record, and additionally `context.parent` (a TreeNode) for trees. You can signal that the drop position is
1984
+ * valid or invalid by setting `context.valid = false;`
1985
+ * @param {string} e Event name
1986
+ * @param {object} params Event parameters
1987
+ * @param {string} params.e Event name
1988
+ * @param {object} params.params Event parameters
1989
+ * @param {object} params.params.event Event object
1990
+ * @param {Grid.view.GridBase} params.params.event.source
1991
+ * @param {object} params.params.event.context
1992
+ * @param {boolean} params.params.event.context.valid Set this to true or false to indicate whether the drop position is valid.
1993
+ * @param {Core.data.Model} params.params.event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
1994
+ * @param {Core.data.Model} params.params.event.context.parent The parent record of the current drop position (only applicable for trees)
1995
+ * @param {Core.data.Model[]} params.params.event.context.records The dragged row records
1996
+ * @param {MouseEvent} params.params.event.event
1997
+ */
1998
+ (e: 'gridRowDrag', params: ((event: { source: GridBase, context: { valid: boolean, insertBefore: Model, parent: Model, records: Model[] }, event: MouseEvent }) => void)|string): void
1999
+ /**
2000
+ * Fired when a row drag operation is aborted
2001
+ * @param {string} e Event name
2002
+ * @param {object} params Event parameters
2003
+ * @param {string} params.e Event name
2004
+ * @param {object} params.params Event parameters
2005
+ * @param {object} params.params.event Event object
2006
+ * @param {Grid.view.GridBase} params.params.event.source
2007
+ * @param {object} params.params.event.context
2008
+ * @param {Core.data.Model[]} params.params.event.context.records The dragged row records
2009
+ * @param {MouseEvent} params.params.event.event
2010
+ */
2011
+ (e: 'gridRowDragAbort', params: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent }) => void)|string): void
2012
+ /**
2013
+ * Fired when dragging starts.
2014
+ * @param {string} e Event name
2015
+ * @param {object} params Event parameters
2016
+ * @param {string} params.e Event name
2017
+ * @param {object} params.params Event parameters
2018
+ * @param {object} params.params.event Event object
2019
+ * @param {Grid.view.GridBase} params.params.event.source
2020
+ * @param {object} params.params.event.context
2021
+ * @param {Core.data.Model[]} params.params.event.context.records The dragged row records
2022
+ * @param {MouseEvent,TouchEvent} params.params.event.event
2023
+ */
2024
+ (e: 'gridRowDragStart', params: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => void)|string): void
2025
+ /**
2026
+ * Fired after the row drop operation has completed, regardless of validity
2027
+ * @param {string} e Event name
2028
+ * @param {object} params Event parameters
2029
+ * @param {string} params.e Event name
2030
+ * @param {object} params.params Event parameters
2031
+ * @param {object} params.params.event Event object
2032
+ * @param {Grid.view.GridBase} params.params.event.source
2033
+ * @param {object} params.params.event.context
2034
+ * @param {boolean} params.params.event.context.valid true or false depending on whether the drop position was valid
2035
+ * @param {Core.data.Model} params.params.event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
2036
+ * @param {Core.data.Model} params.params.event.context.parent The parent record of the current drop position (only applicable for trees)
2037
+ * @param {Core.data.Model[]} params.params.event.context.records The dragged row records
2038
+ * @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
2039
+ * @param {MouseEvent} params.params.event.event
2040
+ */
2041
+ (e: 'gridRowDrop', params: ((event: { source: GridBase, context: { valid: boolean, insertBefore: Model, parent: Model, records: Model[], oldPositionContext: RecordPositionContext[] }, event: MouseEvent }) => void)|string): void
2042
+ /**
2043
+ * Fired when a grid header is clicked on.
2044
+ * ...
2045
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-headerClick)
2046
+ * @param {string} e Event name
2047
+ * @param {object} params Event parameters
2048
+ * @param {string} params.e Event name
2049
+ * @param {object} params.params Event parameters
2050
+ * @param {object} params.params.event Event object
2051
+ * @param {Event} params.params.event.domEvent The triggering DOM event.
2052
+ * @param {Grid.column.Column} params.params.event.column The column clicked on.
2053
+ */
2054
+ (e: 'headerClick', params: ((event: { domEvent: Event, column: Column }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
2055
+ /**
2056
+ * This event fires on the owning Grid before the context menu is shown for a header.
2057
+ * 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).
2058
+ * ...
2059
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-headerMenuBeforeShow)
2060
+ * @param {string} e Event name
2061
+ * @param {object} params Event parameters
2062
+ * @param {string} params.e Event name
2063
+ * @param {object} params.params Event parameters
2064
+ * @param {object} params.params.event Event object
2065
+ * @param {Grid.view.Grid} params.params.event.source The grid
2066
+ * @param {Core.widget.Menu} params.params.event.menu The menu
2067
+ * @param {Record<string, MenuItemEntry>} params.params.event.items Menu item configs
2068
+ * @param {Grid.column.Column} params.params.event.column Column
2069
+ */
2070
+ (e: 'headerMenuBeforeShow', params: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
2071
+ /**
2072
+ * This event fires on the owning Grid when an item is selected in the header context menu.
2073
+ * @param {string} e Event name
2074
+ * @param {object} params Event parameters
2075
+ * @param {string} params.e Event name
2076
+ * @param {object} params.params Event parameters
2077
+ * @param {object} params.params.event Event object
2078
+ * @param {Grid.view.Grid} params.params.event.source The grid
2079
+ * @param {Core.widget.Menu} params.params.event.menu The menu
2080
+ * @param {Core.widget.MenuItem} params.params.event.item Selected menu item
2081
+ * @param {Grid.column.Column} params.params.event.column Column
2082
+ */
2083
+ (e: 'headerMenuItem', params: ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column }) => void)|string): void
2084
+ /**
2085
+ * This event fires on the owning Grid after the context menu is shown for a header
2086
+ * @param {string} e Event name
2087
+ * @param {object} params Event parameters
2088
+ * @param {string} params.e Event name
2089
+ * @param {object} params.params Event parameters
2090
+ * @param {object} params.params.event Event object
2091
+ * @param {Grid.view.Grid} params.params.event.source The grid
2092
+ * @param {Core.widget.Menu} params.params.event.menu The menu
2093
+ * @param {Record<string, MenuItemEntry>} params.params.event.items Menu item configs
2094
+ * @param {Grid.column.Column} params.params.event.column Column
2095
+ */
2096
+ (e: 'headerMenuShow', params: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => void)|string): void
2097
+ /**
2098
+ * This event fires on the owning Grid when a check item is toggled in the header context menu.
2099
+ * @param {string} e Event name
2100
+ * @param {object} params Event parameters
2101
+ * @param {string} params.e Event name
2102
+ * @param {object} params.params Event parameters
2103
+ * @param {object} params.params.event Event object
2104
+ * @param {Grid.view.Grid} params.params.event.source The grid
2105
+ * @param {Core.widget.Menu} params.params.event.menu The menu
2106
+ * @param {Core.widget.MenuItem} params.params.event.item Selected menu item
2107
+ * @param {Grid.column.Column} params.params.event.column Column
2108
+ * @param {boolean} params.params.event.checked Checked or not
2109
+ */
2110
+ (e: 'headerMenuToggleItem', params: ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column, checked: boolean }) => void)|string): void
2111
+ /**
2112
+ * Triggered after a widget was hidden
2113
+ * @param {string} e Event name
2114
+ * @param {object} params Event parameters
2115
+ * @param {string} params.e Event name
2116
+ * @param {object} params.params Event parameters
2117
+ * @param {object} params.params.event Event object
2118
+ * @param {Core.widget.Widget} params.params.event.source The widget
2119
+ */
2120
+ (e: 'hide', params: ((event: { source: Widget }) => void)|string): void
2121
+ /**
2122
+ * Fires when row locking is enabled.
2123
+ * @param {string} e Event name
2124
+ * @param {object} params Event parameters
2125
+ * @param {string} params.e Event name
2126
+ * @param {object} params.params Event parameters
2127
+ * @param {object} params.params.event Event object
2128
+ * @param {Grid.view.GridBase} params.params.event.clone The created clone
2129
+ */
2130
+ (e: 'lockRows', params: ((event: { clone: GridBase }) => void)|string): void
2131
+ /**
2132
+ * Mouse moved out from element in grid
2133
+ * @param {string} e Event name
2134
+ * @param {object} params Event parameters
2135
+ * @param {string} params.e Event name
2136
+ * @param {object} params.params Event parameters
2137
+ * @param {object} params.params.event Event object
2138
+ * @param {MouseEvent} params.params.event.event The native browser event
2139
+ */
2140
+ (e: 'mouseOut', params: ((event: { event: MouseEvent }) => void)|string): void
2141
+ /**
2142
+ * Mouse moved in over element in grid
2143
+ * @param {string} e Event name
2144
+ * @param {object} params Event parameters
2145
+ * @param {string} params.e Event name
2146
+ * @param {object} params.params Event parameters
2147
+ * @param {object} params.params.event Event object
2148
+ * @param {MouseEvent} params.params.event.event The native browser event
2149
+ */
2150
+ (e: 'mouseOver', params: ((event: { event: MouseEvent }) => void)|string): void
2151
+ /**
2152
+ * Triggered when a widget which had been in a non-visible state for any reason
2153
+ * achieves visibility.
2154
+ * ...
2155
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-paint)
2156
+ * @param {string} e Event name
2157
+ * @param {object} params Event parameters
2158
+ * @param {string} params.e Event name
2159
+ * @param {object} params.params Event parameters
2160
+ * @param {object} params.params.event Event object
2161
+ * @param {Core.widget.Widget} params.params.event.source The widget being painted.
2162
+ * @param {boolean} params.params.event.firstPaint `true` if this is the first paint.
2163
+ */
2164
+ (e: 'paint', params: ((event: { source: Widget, firstPaint: boolean }) => void)|string): void
2165
+ /**
2166
+ * Fires on the owning Grid after a paste action is performed.
2167
+ * @param {string} e Event name
2168
+ * @param {object} params Event parameters
2169
+ * @param {string} params.e Event name
2170
+ * @param {object} params.params Event parameters
2171
+ * @param {object} params.params.event Event object
2172
+ * @param {Grid.view.Grid} params.params.event.source Owner grid
2173
+ * @param {string} params.params.event.clipboardData The clipboardData that was pasted
2174
+ * @param {Core.data.Model[]} params.params.event.modifiedRecords The records which have been modified due to the paste action
2175
+ * @param {Grid.util.GridLocation} params.params.event.targetCell The cell from which the paste will be started
2176
+ * @param {string} params.params.event.entityName 'cell' to distinguish this event from other paste events
2177
+ */
2178
+ (e: 'paste', params: ((event: { source: Grid, clipboardData: string, modifiedRecords: Model[], targetCell: GridLocation, entityName: string }) => void)|string): void
2179
+ /**
2180
+ * Fires on the owning Grid when export has finished
2181
+ * @param {string} e Event name
2182
+ * @param {object} params Event parameters
2183
+ * @param {string} params.e Event name
2184
+ * @param {object} params.params Event parameters
2185
+ * @param {object} params.params.event Event object
2186
+ * @param {Response} params.params.event.response Optional response, if received
2187
+ * @param {Error} params.params.event.error Optional error, if exception occurred
2188
+ */
2189
+ (e: 'pdfExport', params: ((event: { response?: any, error?: Error }) => void)|string): void
2190
+ /**
2191
+ * Fired when a Widget's read only state is toggled
2192
+ * @param {string} e Event name
2193
+ * @param {object} params Event parameters
2194
+ * @param {string} params.e Event name
2195
+ * @param {object} params.params Event parameters
2196
+ * @param {object} params.params.event Event object
2197
+ * @param {boolean} params.params.event.readOnly Read only or not
2198
+ */
2199
+ (e: 'readOnly', params: ((event: { readOnly: boolean }) => void)|string): void
2200
+ /**
2201
+ * This event is fired after a widget's elements have been synchronized due to a direct or indirect call
2202
+ * 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.
2203
+ */
2204
+ (e: 'recompose', params: (() => void)|string): void
2205
+ /**
2206
+ * Fires after a row is rendered.
2207
+ * @param {string} e Event name
2208
+ * @param {object} params Event parameters
2209
+ * @param {string} params.e Event name
2210
+ * @param {object} params.params Event parameters
2211
+ * @param {object} params.params.event Event object
2212
+ * @param {Grid.view.Grid} params.params.event.source The firing Grid instance.
2213
+ * @param {Grid.row.Row} params.params.event.row The row that has been rendered.
2214
+ * @param {Core.data.Model} params.params.event.record The record for the row.
2215
+ * @param {number} params.params.event.recordIndex The zero-based index of the record.
2216
+ */
2217
+ (e: 'renderRow', params: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string): void
2218
+ /**
2219
+ * Grid rows have been rendered
2220
+ * @param {string} e Event name
2221
+ * @param {object} params Event parameters
2222
+ * @param {string} params.e Event name
2223
+ * @param {object} params.params Event parameters
2224
+ * @param {object} params.params.event Event object
2225
+ * @param {Grid.view.Grid} params.params.event.source This grid.
2226
+ */
2227
+ (e: 'renderRows', params: ((event: { source: Grid }) => void)|string): void
2228
+ /**
2229
+ * 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`*.
2230
+ * @param {string} e Event name
2231
+ * @param {object} params Event parameters
2232
+ * @param {string} params.e Event name
2233
+ * @param {object} params.params Event parameters
2234
+ * @param {object} params.params.event Event object
2235
+ * @param {Core.widget.Widget} params.params.event.source This Widget
2236
+ * @param {number} params.params.event.width The new width
2237
+ * @param {number} params.params.event.height The new height
2238
+ * @param {number} params.params.event.oldWidth The old width
2239
+ * @param {number} params.params.event.oldHeight The old height
2240
+ */
2241
+ (e: 'resize', params: ((event: { source: Widget, width: number, height: number, oldWidth: number, oldHeight: number }) => void)|string): void
2242
+ /**
2243
+ * Grid resize lead to a new responsive level being applied
2244
+ * @param {string} e Event name
2245
+ * @param {object} params Event parameters
2246
+ * @param {string} params.e Event name
2247
+ * @param {object} params.params Event parameters
2248
+ * @param {object} params.params.event Event object
2249
+ * @param {Grid.view.Grid} params.params.event.grid Grid that was resized
2250
+ * @param {string} params.params.event.level New responsive level (small, large, etc)
2251
+ * @param {number} params.params.event.width New width in px
2252
+ * @param {string} params.params.event.oldLevel Old responsive level
2253
+ * @param {number} params.params.event.oldWidth Old width in px
2254
+ */
2255
+ (e: 'responsive', params: ((event: { grid: Grid, level: string, width: number, oldLevel: string, oldWidth: number }) => void)|string): void
2256
+ /**
2257
+ * This event fires when a row has finished collapsing.
2258
+ * @param {string} e Event name
2259
+ * @param {object} params Event parameters
2260
+ * @param {string} params.e Event name
2261
+ * @param {object} params.params Event parameters
2262
+ * @param {object} params.params.event Event object
2263
+ * @param {Core.data.Model} params.params.event.record Record
2264
+ */
2265
+ (e: 'rowCollapse', params: ((event: { record: Model }) => void)|string): void
2266
+ /**
2267
+ * This event fires when a row expand has finished expanding.
2268
+ * ...
2269
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-rowExpand)
2270
+ * @param {string} e Event name
2271
+ * @param {object} params Event parameters
2272
+ * @param {string} params.e Event name
2273
+ * @param {object} params.params Event parameters
2274
+ * @param {object} params.params.event Event object
2275
+ * @param {Core.data.Model} params.params.event.record Record
2276
+ * @param {object} params.params.event.expandedElements An object with the Grid region name as property and the expanded body element as value
2277
+ * @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.
2278
+ * @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
2279
+ */
2280
+ (e: 'rowExpand', params: ((event: { record: Model, expandedElements: object, widget: Widget, widgets: object }) => void)|string): void
2281
+ /**
2282
+ * Fired when the mouse enters a row
2283
+ * @param {string} e Event name
2284
+ * @param {object} params Event parameters
2285
+ * @param {string} params.e Event name
2286
+ * @param {object} params.params Event parameters
2287
+ * @param {object} params.params.event Event object
2288
+ * @param {Grid.view.Grid} params.params.event.source The grid instance
2289
+ * @param {Core.data.Model} params.params.event.record The record representing the hovered row
2290
+ * @param {Grid.column.Column} params.params.event.column The column currently hovered
2291
+ * @param {HTMLElement} params.params.event.cellElement The cell HTML element
2292
+ * @param {MouseEvent} params.params.event.event The native DOM event
2293
+ */
2294
+ (e: 'rowMouseEnter', params: ((event: { source: Grid, record: Model, column: Column, cellElement: HTMLElement, event: MouseEvent }) => void)|string): void
2295
+ /**
2296
+ * Fired when the mouse leaves a row
2297
+ * @param {string} e Event name
2298
+ * @param {object} params Event parameters
2299
+ * @param {string} params.e Event name
2300
+ * @param {object} params.params Event parameters
2301
+ * @param {object} params.params.event Event object
2302
+ * @param {Grid.view.Grid} params.params.event.source The grid instance
2303
+ * @param {Core.data.Model} params.params.event.record The record representing the row that the mouse left
2304
+ * @param {HTMLElement} params.params.event.cellElement The cell HTML element that the mouse left
2305
+ * @param {MouseEvent} params.params.event.event The native DOM event
2306
+ */
2307
+ (e: 'rowMouseLeave', params: ((event: { source: Grid, record: Model, cellElement: HTMLElement, event: MouseEvent }) => void)|string): void
2308
+ /**
2309
+ * Grid has scrolled vertically
2310
+ * @param {string} e Event name
2311
+ * @param {object} params Event parameters
2312
+ * @param {string} params.e Event name
2313
+ * @param {object} params.params Event parameters
2314
+ * @param {object} params.params.event Event object
2315
+ * @param {Grid.view.Grid} params.params.event.source The firing Grid instance.
2316
+ * @param {number} params.params.event.scrollTop The vertical scroll position.
2317
+ */
2318
+ (e: 'scroll', params: ((event: { source: Grid, scrollTop: number }) => void)|string): void
2319
+ /**
2320
+ * The selection has been changed.
2321
+ * @param {string} e Event name
2322
+ * @param {object} params Event parameters
2323
+ * @param {string} params.e Event name
2324
+ * @param {object} params.params Event parameters
2325
+ * @param {object} params.params.event Event object
2326
+ * @param {'select','deselect'} params.params.event.action `'select'`/`'deselect'`
2327
+ * @param {'row','cell'} params.params.event.mode `'row'`/`'cell'`
2328
+ * @param {Grid.view.Grid} params.params.event.source
2329
+ * @param {Core.data.Model[]} params.params.event.deselected The records deselected in this operation.
2330
+ * @param {Core.data.Model[]} params.params.event.selected The records selected in this operation.
2331
+ * @param {Core.data.Model[]} params.params.event.selection The records in the new selection.
2332
+ * @param {Grid.util.GridLocation[]} params.params.event.deselectedCells The cells deselected in this operation.
2333
+ * @param {Grid.util.GridLocation[]} params.params.event.selectedCells The cells selected in this operation.
2334
+ * @param {Grid.util.GridLocation[]} params.params.event.cellSelection The cells in the new selection.
2335
+ */
2336
+ (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
2337
+ /**
2338
+ * The selectionMode configuration has been changed.
2339
+ * @param {string} e Event name
2340
+ * @param {object} params Event parameters
2341
+ * @param {string} params.e Event name
2342
+ * @param {object} params.params Event parameters
2343
+ * @param {object} params.params.event Event object
2344
+ * @param {object} params.params.event.selectionMode The new [selectionMode](https://bryntum.com/products/grid/docs/api/Grid/view/mixin/GridSelection#config-selectionMode)
2345
+ */
2346
+ (e: 'selectionModeChange', params: ((event: { selectionMode: object }) => void)|string): void
2347
+ /**
2348
+ * Triggered after a widget is shown.
2349
+ * @param {string} e Event name
2350
+ * @param {object} params Event parameters
2351
+ * @param {string} params.e Event name
2352
+ * @param {object} params.params Event parameters
2353
+ * @param {object} params.params.event Event object
2354
+ * @param {Core.widget.Widget} params.params.event.source The widget
2355
+ */
2356
+ (e: 'show', params: ((event: { source: Widget }) => void)|string): void
2357
+ /**
2358
+ * Fires when splitting the Grid.
2359
+ * @param {string} e Event name
2360
+ * @param {object} params Event parameters
2361
+ * @param {string} params.e Event name
2362
+ * @param {object} params.params Event parameters
2363
+ * @param {object} params.params.event Event object
2364
+ * @param {Grid.view.GridBase[]} params.params.event.subViews The sub views created by the split
2365
+ * @param {object} params.params.event.options The options passed to the split call
2366
+ * @param {'horizontal','vertical','both'} params.params.event.options.direction The direction of the split
2367
+ * @param {Grid.column.Column} params.params.event.options.atColumn The column to split at
2368
+ * @param {Core.data.Model} params.params.event.options.atRecord The record to split at
2369
+ */
2370
+ (e: 'split', params: ((event: { subViews: GridBase[], options: { direction: 'horizontal'|'vertical'|'both', atColumn: Column, atRecord: Model } }) => void)|string): void
2371
+ /**
2372
+ * Fired by the Grid when the collapse icon is clicked. Return `false` to prevent the default collapse action,
2373
+ * if you want to implement your own behavior.
2374
+ * @param {string} e Event name
2375
+ * @param {object} params Event parameters
2376
+ * @param {string} params.e Event name
2377
+ * @param {object} params.params Event parameters
2378
+ * @param {object} params.params.event Event object
2379
+ * @param {Grid.view.Grid} params.params.event.source The Grid instance.
2380
+ * @param {Grid.view.SubGrid} params.params.event.subGrid The subgrid
2381
+ * @param {Event} params.params.event.domEvent The native DOM event
2382
+ */
2383
+ (e: 'splitterCollapseClick', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
2384
+ /**
2385
+ * Fired by the Grid after a sub-grid has been resized using the splitter
2386
+ * @param {string} e Event name
2387
+ * @param {object} params Event parameters
2388
+ * @param {string} params.e Event name
2389
+ * @param {object} params.params Event parameters
2390
+ * @param {object} params.params.event Event object
2391
+ * @param {Grid.view.Grid} params.params.event.source The Grid instance.
2392
+ * @param {Grid.view.SubGrid} params.params.event.subGrid The resized subgrid
2393
+ * @param {Event} params.params.event.domEvent The native DOM event
2394
+ */
2395
+ (e: 'splitterDragEnd', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => void)|string): void
2396
+ /**
2397
+ * Fired by the Grid when a sub-grid resize gesture starts
2398
+ * @param {string} e Event name
2399
+ * @param {object} params Event parameters
2400
+ * @param {string} params.e Event name
2401
+ * @param {object} params.params Event parameters
2402
+ * @param {object} params.params.event Event object
2403
+ * @param {Grid.view.Grid} params.params.event.source The Grid instance.
2404
+ * @param {Grid.view.SubGrid} params.params.event.subGrid The subgrid about to be resized
2405
+ * @param {Event} params.params.event.domEvent The native DOM event
2406
+ */
2407
+ (e: 'splitterDragStart', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => void)|string): void
2408
+ /**
2409
+ * Fired by the Grid when the expand icon is clicked. Return `false` to prevent the default expand action,
2410
+ * if you want to implement your own behavior.
2411
+ * @param {string} e Event name
2412
+ * @param {object} params Event parameters
2413
+ * @param {string} params.e Event name
2414
+ * @param {object} params.params Event parameters
2415
+ * @param {object} params.params.event Event object
2416
+ * @param {Grid.view.Grid} params.params.event.source The Grid instance.
2417
+ * @param {Grid.view.SubGrid} params.params.event.subGrid The subgrid
2418
+ * @param {Event} params.params.event.domEvent The native DOM event
2419
+ */
2420
+ (e: 'splitterExpandClick', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
2421
+ /**
2422
+ * Fires on the owning Grid when editing starts
2423
+ * @param {string} e Event name
2424
+ * @param {object} params Event parameters
2425
+ * @param {string} params.e Event name
2426
+ * @param {object} params.params Event parameters
2427
+ * @param {object} params.params.event Event object
2428
+ * @param {Grid.view.Grid} params.params.event.source Owner grid
2429
+ * @param {CellEditorContext} params.params.event.editorContext Editing context
2430
+ */
2431
+ (e: 'startCellEdit', params: ((event: { source: Grid, editorContext: CellEditorContext }) => void)|string): void
2432
+ /**
2433
+ * Fires on the owning Grid when editing starts
2434
+ * @param {string} e Event name
2435
+ * @param {object} params Event parameters
2436
+ * @param {string} params.e Event name
2437
+ * @param {object} params.params Event parameters
2438
+ * @param {object} params.params.event Event object
2439
+ * @param {Grid.view.Grid} params.params.event.source Owner grid
2440
+ * @param {RowEditorContext} params.params.event.editorContext Editing context
2441
+ */
2442
+ (e: 'startRowEdit', params: ((event: { source: Grid, editorContext: RowEditorContext }) => void)|string): void
2443
+ /**
2444
+ * Fires after a sub grid is collapsed.
2445
+ * @param {string} e Event name
2446
+ * @param {object} params Event parameters
2447
+ * @param {string} params.e Event name
2448
+ * @param {object} params.params Event parameters
2449
+ * @param {object} params.params.event Event object
2450
+ * @param {Grid.view.Grid} params.params.event.source The firing Grid instance
2451
+ * @param {Grid.view.SubGrid} params.params.event.subGrid The sub grid instance
2452
+ */
2453
+ (e: 'subGridCollapse', params: ((event: { source: Grid, subGrid: SubGrid }) => void)|string): void
2454
+ /**
2455
+ * Fires after a sub grid is expanded.
2456
+ * @param {string} e Event name
2457
+ * @param {object} params Event parameters
2458
+ * @param {string} params.e Event name
2459
+ * @param {object} params.params Event parameters
2460
+ * @param {object} params.params.event Event object
2461
+ * @param {Grid.view.Grid} params.params.event.source The firing Grid instance
2462
+ * @param {Grid.view.SubGrid} params.params.event.subGrid The sub grid instance
2463
+ */
2464
+ (e: 'subGridExpand', params: ((event: { source: Grid, subGrid: SubGrid }) => void)|string): void
2465
+ /**
2466
+ * Fired when one or more groups are expanded or collapsed
2467
+ * @param {string} e Event name
2468
+ * @param {object} params Event parameters
2469
+ * @param {string} params.e Event name
2470
+ * @param {object} params.params Event parameters
2471
+ * @param {object} params.params.event Event object
2472
+ * @param {Core.data.Model} params.params.event.groupRecord [DEPRECATED] Use `groupRecords` param instead
2473
+ * @param {Core.data.Model[]} params.params.event.groupRecords The group records being toggled
2474
+ * @param {boolean} params.params.event.collapse Collapsed (true) or expanded (false)
2475
+ * @param {boolean} params.params.event.allRecords True if this event is part of toggling all groups
2476
+ */
2477
+ (e: 'toggleGroup', params: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, allRecords?: boolean }) => void)|string): void
2478
+ /**
2479
+ * Fired after a parent node record toggles its collapsed state.
2480
+ * @param {string} e Event name
2481
+ * @param {object} params Event parameters
2482
+ * @param {string} params.e Event name
2483
+ * @param {object} params.params Event parameters
2484
+ * @param {object} params.params.event Event object
2485
+ * @param {Core.data.Model} params.params.event.record The record being toggled.
2486
+ * @param {boolean} params.params.event.collapse `true` if the node is being collapsed.
2487
+ */
2488
+ (e: 'toggleNode', params: ((event: { record: Model, collapse: boolean }) => void)|string): void
2489
+ /**
2490
+ * A header [tool](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-tools) has been clicked.
2491
+ * @param {string} e Event name
2492
+ * @param {object} params Event parameters
2493
+ * @param {string} params.e Event name
2494
+ * @param {object} params.params Event parameters
2495
+ * @param {object} params.params.event Event object
2496
+ * @param {Core.widget.Tool} params.params.event.source This Panel.
2497
+ * @param {Core.widget.Tool} params.params.event.tool The tool which is being clicked.
2498
+ */
2499
+ (e: 'toolClick', params: ((event: { source: Tool, tool: Tool }) => void)|string): void
2500
+ /**
2501
+ * Fires when row locking is disabled.
2502
+ * @param {string} e Event name
2503
+ * @param {object} params Event parameters
2504
+ * @param {string} params.e Event name
2505
+ * @param {object} params.params Event parameters
2506
+ * @param {object} params.params.event Event object
2507
+ * @param {Grid.view.GridBase} params.params.event.clone The locked clone that will be destroyed
2508
+ */
2509
+ (e: 'unlockRows', params: ((event: { clone: GridBase }) => void)|string): void
2510
+ /**
2511
+ * Fires when un-splitting the Grid.
2512
+ */
2513
+ (e: 'unsplit', params: (() => void)|string): void
2514
+ }>();
2515
+
2516
+ const widgetData = {
2517
+ instanceClass : Grid,
2518
+ instanceName : 'Grid',
2519
+
2520
+ isView : true,
2521
+ dataStores : {
2522
+ 'originalStore': 'originals',
2523
+ 'store': 'data'
2524
+ },
2525
+ projectStores : false,
2526
+ featureNames : [
2527
+ 'aiFilterFeature',
2528
+ 'cellCopyPasteFeature',
2529
+ 'cellEditFeature',
2530
+ 'cellMenuFeature',
2531
+ 'cellTooltipFeature',
2532
+ 'chartsFeature',
2533
+ 'columnAutoWidthFeature',
2534
+ 'columnDragToolbarFeature',
2535
+ 'columnPickerFeature',
2536
+ 'columnRenameFeature',
2537
+ 'columnReorderFeature',
2538
+ 'columnResizeFeature',
2539
+ 'excelExporterFeature',
2540
+ 'fileDropFeature',
2541
+ 'fillHandleFeature',
2542
+ 'filterFeature',
2543
+ 'filterBarFeature',
2544
+ 'groupFeature',
2545
+ 'groupSummaryFeature',
2546
+ 'headerMenuFeature',
2547
+ 'lockRowsFeature',
2548
+ 'mergeCellsFeature',
2549
+ 'pdfExportFeature',
2550
+ 'pinColumnsFeature',
2551
+ 'printFeature',
2552
+ 'quickFindFeature',
2553
+ 'regionResizeFeature',
2554
+ 'rowCopyPasteFeature',
2555
+ 'rowEditFeature',
2556
+ 'rowExpanderFeature',
2557
+ 'rowReorderFeature',
2558
+ 'rowResizeFeature',
2559
+ 'searchFeature',
2560
+ 'sortFeature',
2561
+ 'splitFeature',
2562
+ 'stickyCellsFeature',
2563
+ 'stripeFeature',
2564
+ 'summaryFeature',
2565
+ 'treeFeature',
2566
+ 'treeGroupFeature'
2567
+ ],
2568
+
2569
+ configNames : [
2570
+ 'adopt',
2571
+ 'animateFilterRemovals',
2572
+ 'animateRemovingRows',
2573
+ 'ariaDescription',
2574
+ 'ariaLabel',
2575
+ 'autoHeight',
2576
+ 'bbar',
2577
+ 'bodyCls',
2578
+ 'bubbleEvents',
2579
+ 'collapsible',
2580
+ 'color',
2581
+ 'config',
2582
+ 'contentElementCls',
2583
+ 'contextMenuTriggerEvent',
2584
+ 'dataField',
2585
+ 'defaultRegion',
2586
+ 'destroyStore',
2587
+ 'detectCSSCompatibilityIssues',
2588
+ 'disableGridColumnIdWarning',
2589
+ 'disableGridRowModelWarning',
2590
+ 'dock',
2591
+ 'drawer',
2592
+ 'elementAttributes',
2593
+ 'enableSticky',
2594
+ 'enableTextSelection',
2595
+ 'fillLastColumn',
2596
+ 'fixedRowHeight',
2597
+ 'footer',
2598
+ 'formulaProviders',
2599
+ 'fullRowRefresh',
2600
+ 'getRowHeight',
2601
+ 'header',
2602
+ 'hideHorizontalScrollbar',
2603
+ 'hoverCls',
2604
+ 'icon',
2605
+ 'ignoreParentReadOnly',
2606
+ 'listeners',
2607
+ 'loadMask',
2608
+ 'loadMaskDefaults',
2609
+ 'loadMaskError',
2610
+ 'localizable',
2611
+ 'maskDefaults',
2612
+ 'masked',
2613
+ 'monitorResize',
2614
+ 'owner',
2615
+ 'plugins',
2616
+ 'preserveFocusOnDatasetChange',
2617
+ 'preserveScrollOnDatasetChange',
2618
+ 'preventTooltipOnTouch',
2619
+ 'relayStoreEvents',
2620
+ 'resizable',
2621
+ 'resizeToFitIncludesHeader',
2622
+ 'responsiveLevels',
2623
+ 'ripple',
2624
+ 'rootElement',
2625
+ 'scrollerClass',
2626
+ 'scrollManager',
2627
+ 'showDirty',
2628
+ 'stateful',
2629
+ 'statefulEvents',
2630
+ 'stateId',
2631
+ 'stateProvider',
2632
+ 'strips',
2633
+ 'subGridConfigs',
2634
+ 'syncMask',
2635
+ 'tab',
2636
+ 'tabBarItems',
2637
+ 'tbar',
2638
+ 'type',
2639
+ 'ui',
2640
+ 'weight'
2641
+ ],
2642
+ propertyConfigNames : [
2643
+ 'alignSelf',
2644
+ 'animateTreeNodeToggle',
2645
+ 'appendTo',
2646
+ 'callOnFunctions',
2647
+ 'catchEventHandlerExceptions',
2648
+ 'cellEllipsis',
2649
+ 'cls',
2650
+ 'collapsed',
2651
+ 'column',
2652
+ 'columnLines',
2653
+ 'columns',
2654
+ 'data',
2655
+ 'dataset',
2656
+ 'disabled',
2657
+ 'emptyText',
2658
+ 'enableUndoRedoKeys',
2659
+ 'extraData',
2660
+ 'flex',
2661
+ 'height',
2662
+ 'hidden',
2663
+ 'hideFooters',
2664
+ 'hideHeaders',
2665
+ 'id',
2666
+ 'inputFieldAlign',
2667
+ 'insertBefore',
2668
+ 'insertFirst',
2669
+ 'keyMap',
2670
+ 'labelPosition',
2671
+ 'longPressTime',
2672
+ 'margin',
2673
+ 'maxHeight',
2674
+ 'maxWidth',
2675
+ 'minHeight',
2676
+ 'minWidth',
2677
+ 'onBeforeCancelCellEdit',
2678
+ 'onBeforeCancelRowEdit',
2679
+ 'onBeforeCellEditStart',
2680
+ 'onBeforeCellRangeDelete',
2681
+ 'onBeforeCellRangeEdit',
2682
+ 'onBeforeColumnDragStart',
2683
+ 'onBeforeColumnDropFinalize',
2684
+ 'onBeforeColumnResize',
2685
+ 'onBeforeCopy',
2686
+ 'onBeforeCSVExport',
2687
+ 'onBeforeDestroy',
2688
+ 'onBeforeExcelExport',
2689
+ 'onBeforeFillHandleDragStart',
2690
+ 'onBeforeFinishCellEdit',
2691
+ 'onBeforeFinishRowEdit',
2692
+ 'onBeforeHide',
2693
+ 'onBeforePaste',
2694
+ 'onBeforePdfExport',
2695
+ 'onBeforeRenderRow',
2696
+ 'onBeforeRenderRows',
2697
+ 'onBeforeRowCollapse',
2698
+ 'onBeforeRowExpand',
2699
+ 'onBeforeSelectionChange',
2700
+ 'onBeforeSetRecord',
2701
+ 'onBeforeShow',
2702
+ 'onBeforeStartRowEdit',
2703
+ 'onBeforeStateApply',
2704
+ 'onBeforeStateSave',
2705
+ 'onBeforeToggleGroup',
2706
+ 'onBeforeToggleNode',
2707
+ 'onCancelCellEdit',
2708
+ 'onCatchAll',
2709
+ 'onCellClick',
2710
+ 'onCellContextMenu',
2711
+ 'onCellDblClick',
2712
+ 'onCellMenuBeforeShow',
2713
+ 'onCellMenuItem',
2714
+ 'onCellMenuShow',
2715
+ 'onCellMenuToggleItem',
2716
+ 'onCellMouseEnter',
2717
+ 'onCellMouseLeave',
2718
+ 'onCellMouseOut',
2719
+ 'onCellMouseOver',
2720
+ 'onCollapse',
2721
+ 'onCollapseNode',
2722
+ 'onColumnDrag',
2723
+ 'onColumnDragStart',
2724
+ 'onColumnDrop',
2725
+ 'onColumnResize',
2726
+ 'onColumnResizeStart',
2727
+ 'onContextMenuItem',
2728
+ 'onContextMenuToggleItem',
2729
+ 'onCopy',
2730
+ 'onDataChange',
2731
+ 'onDestroy',
2732
+ 'onDirtyStateChange',
2733
+ 'onDragSelecting',
2734
+ 'onElementCreated',
2735
+ 'onExpand',
2736
+ 'onExpandNode',
2737
+ 'onFileDrop',
2738
+ 'onFillHandleBeforeDragFinalize',
2739
+ 'onFillHandleDrag',
2740
+ 'onFillHandleDragAbort',
2741
+ 'onFillHandleDragEnd',
2742
+ 'onFillHandleDragStart',
2743
+ 'onFinishCellEdit',
2744
+ 'onFinishRowEdit',
2745
+ 'onFocusIn',
2746
+ 'onFocusOut',
2747
+ 'onGridRowBeforeDragStart',
2748
+ 'onGridRowBeforeDropFinalize',
2749
+ 'onGridRowDrag',
2750
+ 'onGridRowDragAbort',
2751
+ 'onGridRowDragStart',
2752
+ 'onGridRowDrop',
2753
+ 'onHeaderClick',
2754
+ 'onHeaderMenuBeforeShow',
2755
+ 'onHeaderMenuItem',
2756
+ 'onHeaderMenuShow',
2757
+ 'onHeaderMenuToggleItem',
2758
+ 'onHide',
2759
+ 'onLockRows',
2760
+ 'onMouseOut',
2761
+ 'onMouseOver',
2762
+ 'onPaint',
2763
+ 'onPaste',
2764
+ 'onPdfExport',
2765
+ 'onReadOnly',
2766
+ 'onRecompose',
2767
+ 'onRenderRow',
2768
+ 'onRenderRows',
2769
+ 'onResize',
2770
+ 'onResponsive',
2771
+ 'onRowCollapse',
2772
+ 'onRowExpand',
2773
+ 'onRowMouseEnter',
2774
+ 'onRowMouseLeave',
2775
+ 'onScroll',
2776
+ 'onSelectionChange',
2777
+ 'onSelectionModeChange',
2778
+ 'onShow',
2779
+ 'onSplit',
2780
+ 'onSplitterCollapseClick',
2781
+ 'onSplitterDragEnd',
2782
+ 'onSplitterDragStart',
2783
+ 'onSplitterExpandClick',
2784
+ 'onStartCellEdit',
2785
+ 'onStartRowEdit',
2786
+ 'onSubGridCollapse',
2787
+ 'onSubGridExpand',
2788
+ 'onToggleGroup',
2789
+ 'onToggleNode',
2790
+ 'onToolClick',
2791
+ 'onUnlockRows',
2792
+ 'onUnsplit',
2793
+ 'preserveScroll',
2794
+ 'readOnly',
2795
+ 'rendition',
2796
+ 'rowHeight',
2797
+ 'rowLines',
2798
+ 'rtl',
2799
+ 'scrollable',
2800
+ 'selectionMode',
2801
+ 'span',
2802
+ 'stateSettings',
2803
+ 'store',
2804
+ 'title',
2805
+ 'tools',
2806
+ 'transition',
2807
+ 'transitionDuration',
2808
+ 'width'
2809
+ ],
2810
+ propertyNames : [
2811
+ 'focusVisible',
2812
+ 'hasChanges',
2813
+ 'originalStore',
2814
+ 'parent',
2815
+ 'selectedCell',
2816
+ 'selectedCells',
2817
+ 'selectedRecord',
2818
+ 'selectedRecords',
2819
+ 'selectedRows',
2820
+ 'state',
2821
+ 'tooltip'
2822
+ ],
2823
+ eventNames : [
2824
+ 'beforeCancelCellEdit',
2825
+ 'beforeCancelRowEdit',
2826
+ 'beforeCellEditStart',
2827
+ 'beforeCellRangeDelete',
2828
+ 'beforeCellRangeEdit',
2829
+ 'beforeColumnDragStart',
2830
+ 'beforeColumnDropFinalize',
2831
+ 'beforeColumnResize',
2832
+ 'beforeCopy',
2833
+ 'beforeCSVExport',
2834
+ 'beforeDestroy',
2835
+ 'beforeExcelExport',
2836
+ 'beforeFillHandleDragStart',
2837
+ 'beforeFinishCellEdit',
2838
+ 'beforeFinishRowEdit',
2839
+ 'beforeHide',
2840
+ 'beforePaste',
2841
+ 'beforePdfExport',
2842
+ 'beforeRenderRow',
2843
+ 'beforeRenderRows',
2844
+ 'beforeRowCollapse',
2845
+ 'beforeRowExpand',
2846
+ 'beforeSelectionChange',
2847
+ 'beforeSetRecord',
2848
+ 'beforeShow',
2849
+ 'beforeStartRowEdit',
2850
+ 'beforeStateApply',
2851
+ 'beforeStateSave',
2852
+ 'beforeToggleGroup',
2853
+ 'beforeToggleNode',
2854
+ 'cancelCellEdit',
2855
+ 'catchAll',
2856
+ 'cellClick',
2857
+ 'cellContextMenu',
2858
+ 'cellDblClick',
2859
+ 'cellMenuBeforeShow',
2860
+ 'cellMenuItem',
2861
+ 'cellMenuShow',
2862
+ 'cellMenuToggleItem',
2863
+ 'cellMouseEnter',
2864
+ 'cellMouseLeave',
2865
+ 'cellMouseOut',
2866
+ 'cellMouseOver',
2867
+ 'collapse',
2868
+ 'collapseNode',
2869
+ 'columnDrag',
2870
+ 'columnDragStart',
2871
+ 'columnDrop',
2872
+ 'columnResize',
2873
+ 'columnResizeStart',
2874
+ 'contextMenuItem',
2875
+ 'contextMenuToggleItem',
2876
+ 'copy',
2877
+ 'dataChange',
2878
+ 'destroy',
2879
+ 'dirtyStateChange',
2880
+ 'dragSelecting',
2881
+ 'elementCreated',
2882
+ 'expand',
2883
+ 'expandNode',
2884
+ 'fileDrop',
2885
+ 'fillHandleBeforeDragFinalize',
2886
+ 'fillHandleDrag',
2887
+ 'fillHandleDragAbort',
2888
+ 'fillHandleDragEnd',
2889
+ 'fillHandleDragStart',
2890
+ 'finishCellEdit',
2891
+ 'finishRowEdit',
2892
+ 'focusIn',
2893
+ 'focusOut',
2894
+ 'gridRowBeforeDragStart',
2895
+ 'gridRowBeforeDropFinalize',
2896
+ 'gridRowDrag',
2897
+ 'gridRowDragAbort',
2898
+ 'gridRowDragStart',
2899
+ 'gridRowDrop',
2900
+ 'headerClick',
2901
+ 'headerMenuBeforeShow',
2902
+ 'headerMenuItem',
2903
+ 'headerMenuShow',
2904
+ 'headerMenuToggleItem',
2905
+ 'hide',
2906
+ 'lockRows',
2907
+ 'mouseOut',
2908
+ 'mouseOver',
2909
+ 'paint',
2910
+ 'paste',
2911
+ 'pdfExport',
2912
+ 'readOnly',
2913
+ 'recompose',
2914
+ 'renderRow',
2915
+ 'renderRows',
2916
+ 'resize',
2917
+ 'responsive',
2918
+ 'rowCollapse',
2919
+ 'rowExpand',
2920
+ 'rowMouseEnter',
2921
+ 'rowMouseLeave',
2922
+ 'scroll',
2923
+ 'selectionChange',
2924
+ 'selectionModeChange',
2925
+ 'show',
2926
+ 'split',
2927
+ 'splitterCollapseClick',
2928
+ 'splitterDragEnd',
2929
+ 'splitterDragStart',
2930
+ 'splitterExpandClick',
2931
+ 'startCellEdit',
2932
+ 'startRowEdit',
2933
+ 'subGridCollapse',
2934
+ 'subGridExpand',
2935
+ 'toggleGroup',
2936
+ 'toggleNode',
2937
+ 'toolClick',
2938
+ 'unlockRows',
2939
+ 'unsplit'
2940
+ ]
2941
+ };
2942
+
2943
+ const instance: {
2944
+ value?: Grid
2945
+ } = {};
2946
+
2947
+ const refElement = ref<HTMLDivElement>()!;
2948
+ // Storage for teleports (in-cell Vue component instances) automatically renderer by template
2949
+ const teleports = ref(new Map());
2950
+
2951
+ // Provide teleports for processCellContent
2952
+ provide('teleports', teleports);
2953
+
2954
+ onMounted(() => {
2955
+
2956
+ const me = getCurrentInstance()!;
2957
+
2958
+ instance.value = WrapperHelper.createWidget<typeof Grid>({
2959
+ me,
2960
+ widgetData,
2961
+ emit,
2962
+ element : refElement.value!,
2963
+ processCellContent : WrapperHelper.processCellContent,
2964
+ processEventContent : WrapperHelper.processEventContent,
2965
+ processWidgetContent : WrapperHelper.processWidgetContent,
2966
+ hasFrameworkRenderer : WrapperHelper.hasFrameworkRenderer,
2967
+ toRaw
2968
+ });
2969
+ WrapperHelper.relayStores(me.data, instance.value);
2970
+
2971
+ const watcher = (prop: string, callback: any) => watch(() => me.props[prop], callback);
2972
+ WrapperHelper.watchProps(instance.value, widgetData, watcher);
2973
+ });
2974
+
2975
+ onBeforeUnmount(() => {
2976
+ // @ts-ignore
2977
+ instance.value?.destroy?.();
2978
+ });
2979
+
2980
+ defineExpose({
2981
+ instance,
2982
+ refElement,
2983
+ teleports
2984
+ });
2985
+
2986
+ </script>