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