@bryntum/grid-vue-3-thin 7.3.0 → 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 (35) hide show
  1. package/README.md +4 -4
  2. package/lib/chunks/Bc2x_WPR.js.map +1 -1
  3. package/lib/chunks/Be7ZZzGW.js.map +1 -1
  4. package/lib/chunks/BpNo5v3W.js.map +1 -1
  5. package/lib/chunks/{BeyOFZne.js → C87PnYXS.js} +11 -9
  6. package/lib/chunks/C87PnYXS.js.map +1 -0
  7. package/lib/chunks/{Ba35uKyP.js → C9RmZYoQ.js} +7 -5
  8. package/lib/chunks/C9RmZYoQ.js.map +1 -0
  9. package/lib/chunks/CAlh-Y8B.js.map +1 -1
  10. package/lib/chunks/CWYhi4DG.js.map +1 -1
  11. package/lib/chunks/CcfDAcJD.js.map +1 -1
  12. package/lib/chunks/{BGeNcVH6.js → DZ2V6NNc.js} +12 -10
  13. package/lib/chunks/DZ2V6NNc.js.map +1 -0
  14. package/lib/chunks/w2GDktIt.js.map +1 -1
  15. package/lib/components/BryntumAIFilterField.js +1 -1
  16. package/lib/components/BryntumChecklistFilterCombo.js +1 -1
  17. package/lib/components/BryntumTreeCombo.js +1 -1
  18. package/lib/index.js +3 -3
  19. package/package.json +1 -1
  20. package/src/components/BryntumAIFilterField.vue +80 -106
  21. package/src/components/BryntumAIFilterFieldProps.ts +9 -0
  22. package/src/components/BryntumChecklistFilterCombo.vue +81 -109
  23. package/src/components/BryntumChecklistFilterComboProps.ts +9 -0
  24. package/src/components/BryntumGrid.vue +523 -755
  25. package/src/components/BryntumGridBase.vue +523 -755
  26. package/src/components/BryntumGridChartDesigner.vue +43 -69
  27. package/src/components/BryntumGridFieldFilterPicker.vue +53 -85
  28. package/src/components/BryntumGridFieldFilterPickerGroup.vue +57 -91
  29. package/src/components/BryntumGroupBar.vue +65 -101
  30. package/src/components/BryntumTreeCombo.vue +81 -109
  31. package/src/components/BryntumTreeComboProps.ts +9 -0
  32. package/src/components/BryntumTreeGrid.vue +523 -755
  33. package/lib/chunks/BGeNcVH6.js.map +0 -1
  34. package/lib/chunks/Ba35uKyP.js.map +0 -1
  35. package/lib/chunks/BeyOFZne.js.map +0 -1
@@ -999,182 +999,152 @@ const emit = defineEmits<{
999
999
  * Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
1000
1000
  * @param {string} e Event name
1001
1001
  * @param {object} params Event parameters
1002
- * @param {string} params.e Event name
1003
- * @param {object} params.params Event parameters
1004
- * @param {object} params.params.event Event object
1005
- * @param {Grid.view.Grid} params.params.event.source Owner grid
1006
- * @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
1007
1005
  */
1008
- (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
1009
1007
  /**
1010
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.
1011
1009
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-beforeCancelRowEdit)
1012
1010
  * @param {string} e Event name
1013
1011
  * @param {object} params Event parameters
1014
- * @param {string} params.e Event name
1015
- * @param {object} params.params Event parameters
1016
- * @param {object} params.params.event Event object
1017
- * @param {Grid.view.Grid} params.params.event.grid Target grid
1018
- * @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
1019
1015
  */
1020
1016
  (e: 'beforeCancelRowEdit', params: ((event: { grid: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1021
1017
  /**
1022
1018
  * Fires on the owning Grid before editing starts, return `false` to prevent editing
1023
1019
  * @param {string} e Event name
1024
1020
  * @param {object} params Event parameters
1025
- * @param {string} params.e Event name
1026
- * @param {object} params.params Event parameters
1027
- * @param {object} params.params.event Event object
1028
- * @param {Grid.view.Grid} params.params.event.source Owner grid
1029
- * @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
1030
1024
  */
1031
- (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
1032
1026
  /**
1033
1027
  * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
1034
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.
1035
1029
  * @param {string} e Event name
1036
1030
  * @param {object} params Event parameters
1037
- * @param {string} params.e Event name
1038
- * @param {object} params.params Event parameters
1039
- * @param {object} params.params.event Event object
1040
- * @param {Grid.view.Grid} params.params.event.source Owner grid
1041
- * @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).
1042
1034
  */
1043
- (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
1044
1036
  /**
1045
1037
  * Fires for each selected record on the owning Grid before editing a range of selected cell values
1046
1038
  * @param {string} e Event name
1047
1039
  * @param {object} params Event parameters
1048
- * @param {string} params.e Event name
1049
- * @param {object} params.params Event parameters
1050
- * @param {object} params.params.event Event object
1051
- * @param {Core.data.Model} params.params.event.record Current selected record from the range
1052
- * @param {string} params.params.event.field The field being changed
1053
- * @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
1054
1044
  */
1055
- (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
1056
1046
  /**
1057
1047
  * This event is triggered before a parent column is collapsed or expanded.
1058
1048
  * @param {string} e Event name
1059
1049
  * @param {object} params Event parameters
1060
- * @param {string} params.e Event name
1061
- * @param {object} params.params Event parameters
1062
- * @param {object} params.params.event Event object
1063
- * @param {Grid.view.GridBase} params.params.event.source The grid instance
1064
- * @param {Grid.column.Column} params.params.event.column The column
1065
- * @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
1066
1054
  */
1067
1055
  (e: 'beforeColumnCollapseToggle', params: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string): void
1068
1056
  /**
1069
1057
  * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
1070
1058
  * @param {string} e Event name
1071
1059
  * @param {object} params Event parameters
1072
- * @param {string} params.e Event name
1073
- * @param {object} params.params Event parameters
1074
- * @param {object} params.params.event Event object
1075
- * @param {Grid.view.Grid} params.params.event.source The grid instance.
1076
- * @param {Grid.column.Column} params.params.event.column The dragged column.
1077
- * @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.
1078
1064
  */
1079
- (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
1080
1066
  /**
1081
1067
  * This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
1082
1068
  * @param {string} e Event name
1083
1069
  * @param {object} params Event parameters
1084
- * @param {string} params.e Event name
1085
- * @param {object} params.params Event parameters
1086
- * @param {object} params.params.event Event object
1087
- * @param {Grid.view.Grid} params.params.event.source The grid instance.
1088
- * @param {Grid.column.Column} params.params.event.column The dragged column.
1089
- * @param {Grid.column.Column} params.params.event.insertBefore The column before which the dragged column will be inserted.
1090
- * @param {Grid.column.Column} params.params.event.newParent The new parent column.
1091
- * @param {Event} params.params.event.event The browser event.
1092
- * @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.
1093
1077
  */
1094
- (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
1095
1079
  /**
1096
1080
  * This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
1097
1081
  * `false`.
1098
1082
  * @param {string} e Event name
1099
1083
  * @param {object} params Event parameters
1100
- * @param {string} params.e Event name
1101
- * @param {object} params.params Event parameters
1102
- * @param {object} params.params.event Event object
1103
- * @param {Grid.view.Grid} params.params.event.source The grid instance
1104
- * @param {Grid.column.Column} params.params.event.column The column
1105
- * @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
1106
1088
  */
1107
- (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
1108
1090
  /**
1109
1091
  * Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
1110
1092
  * @param {string} e Event name
1111
1093
  * @param {object} params Event parameters
1112
- * @param {string} params.e Event name
1113
- * @param {object} params.params Event parameters
1114
- * @param {object} params.params.event Event object
1115
- * @param {Grid.view.Grid} params.params.event.source Owner grid
1116
- * @param {Grid.util.GridLocation[]} params.params.event.cells The cells about to be copied or cut
1117
- * @param {string} params.params.event.data The string data about to be copied or cut
1118
- * @param {boolean} params.params.event.isCut `true` if this is a cut action
1119
- * @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
1120
1100
  */
1121
1101
  (e: 'beforeCopy', params: ((event: { source: Grid, cells: GridLocation[], data: string, isCut: boolean, entityName: string }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1122
1102
  /**
1123
1103
  * Fires on the owning Grid before CSV export starts. Return `false` to cancel the export.
1124
1104
  * @param {string} e Event name
1125
1105
  * @param {object} params Event parameters
1126
- * @param {string} params.e Event name
1127
- * @param {object} params.params Event parameters
1128
- * @param {object} params.params.event Event object
1129
- * @param {ExportConfig} params.params.event.config Export config
1130
- * @param {Grid.column.Column[]} params.params.event.columns An array of columns to export
1131
- * @param {Core.data.Model[]} params.params.event.rows An array of records to export
1132
- * @param {string} params.params.event.lineDelimiter The CSV delimiter to separate lines
1133
- * @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
1134
1112
  */
1135
- (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
1136
1114
  /**
1137
1115
  * Fires before an object is destroyed.
1138
1116
  * @param {string} e Event name
1139
1117
  * @param {object} params Event parameters
1140
- * @param {string} params.e Event name
1141
- * @param {object} params.params Event parameters
1142
- * @param {object} params.params.event Event object
1143
- * @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.
1144
1120
  */
1145
1121
  (e: 'beforeDestroy', params: ((event: { source: Base }) => void)|string): void
1146
1122
  /**
1147
1123
  * Fires on the owning Grid before Excel export starts. Return `false` to cancel the export.
1148
1124
  * @param {string} e Event name
1149
1125
  * @param {object} params Event parameters
1150
- * @param {string} params.e Event name
1151
- * @param {object} params.params Event parameters
1152
- * @param {object} params.params.event Event object
1153
- * @param {ExportConfig} params.params.event.config Export config
1154
- * @param {XLSColumn[]} params.params.event.columns An array of columns to export
1155
- * @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
1156
1130
  */
1157
- (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
1158
1132
  /**
1159
1133
  * Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
1160
1134
  * @param {string} e Event name
1161
1135
  * @param {object} params Event parameters
1162
- * @param {string} params.e Event name
1163
- * @param {object} params.params Event parameters
1164
- * @param {object} params.params.event Event object
1165
- * @param {Grid.util.GridLocation} params.params.event.cell Information about the column / record
1166
- * @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
1167
1139
  */
1168
- (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
1169
1141
  /**
1170
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.
1171
1143
  * @param {string} e Event name
1172
1144
  * @param {object} params Event parameters
1173
- * @param {string} params.e Event name
1174
- * @param {object} params.params Event parameters
1175
- * @param {object} params.params.event Event object
1176
- * @param {Grid.view.Grid} params.params.event.grid Target grid
1177
- * @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
1178
1148
  */
1179
1149
  (e: 'beforeFinishCellEdit', params: ((event: { grid: Grid, editorContext: CellEditorContext }) => void)|string): void
1180
1150
  /**
@@ -1182,68 +1152,56 @@ const emit = defineEmits<{
1182
1152
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-beforeFinishRowEdit)
1183
1153
  * @param {string} e Event name
1184
1154
  * @param {object} params Event parameters
1185
- * @param {string} params.e Event name
1186
- * @param {object} params.params Event parameters
1187
- * @param {object} params.params.event Event object
1188
- * @param {Grid.view.Grid} params.params.event.grid Target grid
1189
- * @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
1190
1158
  */
1191
1159
  (e: 'beforeFinishRowEdit', params: ((event: { grid: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1192
1160
  /**
1193
1161
  * Triggered before a widget is hidden. Return `false` to prevent the action.
1194
1162
  * @param {string} e Event name
1195
1163
  * @param {object} params Event parameters
1196
- * @param {string} params.e Event name
1197
- * @param {object} params.params Event parameters
1198
- * @param {object} params.params.event Event object
1199
- * @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.
1200
1166
  */
1201
- (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
1202
1168
  /**
1203
1169
  * Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
1204
1170
  * @param {string} e Event name
1205
1171
  * @param {object} params Event parameters
1206
- * @param {string} params.e Event name
1207
- * @param {object} params.params Event parameters
1208
- * @param {object} params.params.event Event object
1209
- * @param {Grid.view.Grid} params.params.event.source Owner grid
1210
- * @param {string} params.params.event.clipboardData The clipboardData about to be pasted
1211
- * @param {Grid.util.GridLocation} params.params.event.targetCell The cell from which the paste will be started
1212
- * @param {string} params.params.event.entityName 'cell' to distinguish this event from other beforePaste events
1213
- * @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
1214
1178
  */
1215
1179
  (e: 'beforePaste', params: ((event: { source: Grid, clipboardData: string, targetCell: GridLocation, entityName: string, text: string }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1216
1180
  /**
1217
1181
  * Fires on the owning Grid before export started. Return `false` to cancel the export.
1218
1182
  * @param {string} e Event name
1219
1183
  * @param {object} params Event parameters
1220
- * @param {string} params.e Event name
1221
- * @param {object} params.params Event parameters
1222
- * @param {object} params.params.event Event object
1223
- * @param {PdfExportConfig} params.params.event.config Export config
1184
+ * @param {object} params.event Event object
1185
+ * @param {PdfExportConfig} params.event.config Export config
1224
1186
  */
1225
- (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
1226
1188
  /**
1227
1189
  * Fires before a row is rendered.
1228
1190
  * @param {string} e Event name
1229
1191
  * @param {object} params Event parameters
1230
- * @param {string} params.e Event name
1231
- * @param {object} params.params Event parameters
1232
- * @param {object} params.params.event Event object
1233
- * @param {Grid.view.GridBase} params.params.event.source The firing Grid instance
1234
- * @param {Grid.row.Row} params.params.event.row The row about to be rendered
1235
- * @param {Core.data.Model} params.params.event.record The record for the row
1236
- * @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
1237
1197
  */
1238
1198
  (e: 'beforeRenderRow', params: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string): void
1239
1199
  /**
1240
1200
  * Grid rows are about to be rendered
1241
1201
  * @param {string} e Event name
1242
1202
  * @param {object} params Event parameters
1243
- * @param {string} params.e Event name
1244
- * @param {object} params.params Event parameters
1245
- * @param {object} params.params.event Event object
1246
- * @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.
1247
1205
  */
1248
1206
  (e: 'beforeRenderRows', params: ((event: { source: GridBase }) => void)|string): void
1249
1207
  /**
@@ -1251,10 +1209,8 @@ const emit = defineEmits<{
1251
1209
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-beforeRowCollapse)
1252
1210
  * @param {string} e Event name
1253
1211
  * @param {object} params Event parameters
1254
- * @param {string} params.e Event name
1255
- * @param {object} params.params Event parameters
1256
- * @param {object} params.params.event Event object
1257
- * @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
1258
1214
  */
1259
1215
  (e: 'beforeRowCollapse', params: ((event: { record: Model }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1260
1216
  /**
@@ -1262,119 +1218,99 @@ const emit = defineEmits<{
1262
1218
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-beforeRowExpand)
1263
1219
  * @param {string} e Event name
1264
1220
  * @param {object} params Event parameters
1265
- * @param {string} params.e Event name
1266
- * @param {object} params.params Event parameters
1267
- * @param {object} params.params.event Event object
1268
- * @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
1269
1223
  */
1270
1224
  (e: 'beforeRowExpand', params: ((event: { record: Model }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1271
1225
  /**
1272
1226
  * Fires before the selection changes. Returning `false` from a listener prevents the change
1273
1227
  * @param {string} e Event name
1274
1228
  * @param {object} params Event parameters
1275
- * @param {string} params.e Event name
1276
- * @param {object} params.params Event parameters
1277
- * @param {object} params.params.event Event object
1278
- * @param {string} params.params.event.action `'select'`/`'deselect'`
1279
- * @param {'row','cell'} params.params.event.mode `'row'`/`'cell'`
1280
- * @param {Grid.view.Grid} params.params.event.source
1281
- * @param {Core.data.Model[]} params.params.event.deselected The records to be deselected in this operation.
1282
- * @param {Core.data.Model[]} params.params.event.selected The records to be selected in this operation.
1283
- * @param {Core.data.Model[]} params.params.event.selection The records in the current selection, before applying `selected` and `deselected`
1284
- * @param {Grid.util.GridLocation[]} params.params.event.deselectedCells The cells to be deselected in this operation.
1285
- * @param {Grid.util.GridLocation[]} params.params.event.selectedCells The cells to be selected in this operation.
1286
- * @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`
1287
1239
  */
1288
- (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
1289
1241
  /**
1290
1242
  * Fired before this container will load record values into its child fields. This is useful if you
1291
1243
  * want to modify the UI before data is loaded (e.g. set some input field to be readonly)
1292
1244
  * @param {string} e Event name
1293
1245
  * @param {object} params Event parameters
1294
- * @param {string} params.e Event name
1295
- * @param {object} params.params Event parameters
1296
- * @param {object} params.params.event Event object
1297
- * @param {Core.widget.Container} params.params.event.source The container
1298
- * @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
1299
1249
  */
1300
1250
  (e: 'beforeSetRecord', params: ((event: { source: Container, record: Model }) => void)|string): void
1301
1251
  /**
1302
1252
  * Triggered before a widget is shown. Return `false` to prevent the action.
1303
1253
  * @param {string} e Event name
1304
1254
  * @param {object} params Event parameters
1305
- * @param {string} params.e Event name
1306
- * @param {object} params.params Event parameters
1307
- * @param {object} params.params.event Event object
1308
- * @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
1309
1257
  */
1310
1258
  (e: 'beforeShow', params: ((event: { source: Widget|any }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1311
1259
  /**
1312
1260
  * Fires on the owning Grid before editing starts, return `false` to prevent editing
1313
1261
  * @param {string} e Event name
1314
1262
  * @param {object} params Event parameters
1315
- * @param {string} params.e Event name
1316
- * @param {object} params.params Event parameters
1317
- * @param {object} params.params.event Event object
1318
- * @param {Grid.view.Grid} params.params.event.source Owner grid
1319
- * @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
1320
1266
  */
1321
- (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
1322
1268
  /**
1323
1269
  * Fired before state is applied to the source. Allows editing the state object or preventing the operation.
1324
1270
  * @param {string} e Event name
1325
1271
  * @param {object} params Event parameters
1326
- * @param {string} params.e Event name
1327
- * @param {object} params.params Event parameters
1328
- * @param {object} params.params.event Event object
1329
- * @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
1330
1274
  */
1331
- (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
1332
1276
  /**
1333
1277
  * Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
1334
1278
  * @param {string} e Event name
1335
1279
  * @param {object} params Event parameters
1336
- * @param {string} params.e Event name
1337
- * @param {object} params.params Event parameters
1338
- * @param {object} params.params.event Event object
1339
- * @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
1340
1282
  */
1341
- (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
1342
1284
  /**
1343
1285
  * Fired when a group is going to be expanded or collapsed using the UI.
1344
1286
  * Returning `false` from a listener prevents the operation
1345
1287
  * @param {string} e Event name
1346
1288
  * @param {object} params Event parameters
1347
- * @param {string} params.e Event name
1348
- * @param {object} params.params Event parameters
1349
- * @param {object} params.params.event Event object
1350
- * @param {Core.data.Model} params.params.event.groupRecord [DEPRECATED] Use `groupRecords` param instead
1351
- * @param {Core.data.Model[]} params.params.event.groupRecords The group records being toggled
1352
- * @param {boolean} params.params.event.collapse Collapsed (true) or expanded (false)
1353
- * @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.
1354
1294
  */
1355
- (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
1356
1296
  /**
1357
1297
  * Fired before a parent node record toggles its collapsed state.
1358
1298
  * @param {string} e Event name
1359
1299
  * @param {object} params Event parameters
1360
- * @param {string} params.e Event name
1361
- * @param {object} params.params Event parameters
1362
- * @param {object} params.params.event Event object
1363
- * @param {Grid.view.Grid} params.params.event.source The firing Grid instance.
1364
- * @param {Core.data.Model} params.params.event.record The record being toggled.
1365
- * @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.
1366
1304
  */
1367
1305
  (e: 'beforeToggleNode', params: ((event: { source: Grid, record: Model, collapse: boolean }) => void)|string): void
1368
1306
  /**
1369
1307
  * Fires on the owning Grid when editing is cancelled
1370
1308
  * @param {string} e Event name
1371
1309
  * @param {object} params Event parameters
1372
- * @param {string} params.e Event name
1373
- * @param {object} params.params Event parameters
1374
- * @param {object} params.params.event Event object
1375
- * @param {Grid.view.Grid} params.params.event.source Owner grid
1376
- * @param {Grid.util.GridLocation} params.params.event.editorContext Editing context
1377
- * @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
1378
1314
  */
1379
1315
  (e: 'cancelCellEdit', params: ((event: { source: Grid, editorContext: GridLocation, event: Event }) => void)|string): void
1380
1316
  /**
@@ -1382,56 +1318,48 @@ const emit = defineEmits<{
1382
1318
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-catchAll)
1383
1319
  * @param {string} e Event name
1384
1320
  * @param {object} params Event parameters
1385
- * @param {string} params.e Event name
1386
- * @param {object} params.params Event parameters
1387
- * @param {object} params.params.event Event object
1388
- * @param {{[key: string]: any, type: string}} params.params.event.event The Object that contains event details
1389
- * @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
1390
1324
  */
1391
1325
  (e: 'catchAll', params: ((event: {[key: string]: any, type: string}) => void)|string): void
1392
1326
  /**
1393
1327
  * Fired when user clicks in a grid cell
1394
1328
  * @param {string} e Event name
1395
1329
  * @param {object} params Event parameters
1396
- * @param {string} params.e Event name
1397
- * @param {object} params.params Event parameters
1398
- * @param {object} params.params.event Event object
1399
- * @param {Grid.view.Grid} params.params.event.grid The grid instance
1400
- * @param {Core.data.Model} params.params.event.record The record representing the row
1401
- * @param {Grid.column.Column} params.params.event.column The column to which the cell belongs
1402
- * @param {HTMLElement} params.params.event.cellElement The cell HTML element
1403
- * @param {HTMLElement} params.params.event.target The target element
1404
- * @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
1405
1337
  */
1406
1338
  (e: 'cellClick', params: ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string): void
1407
1339
  /**
1408
1340
  * Fired when user activates contextmenu in a grid cell
1409
1341
  * @param {string} e Event name
1410
1342
  * @param {object} params Event parameters
1411
- * @param {string} params.e Event name
1412
- * @param {object} params.params Event parameters
1413
- * @param {object} params.params.event Event object
1414
- * @param {Grid.view.Grid} params.params.event.grid The grid instance
1415
- * @param {Core.data.Model} params.params.event.record The record representing the row
1416
- * @param {Grid.column.Column} params.params.event.column The column to which the cell belongs
1417
- * @param {HTMLElement} params.params.event.cellElement The cell HTML element
1418
- * @param {HTMLElement} params.params.event.target The target element
1419
- * @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
1420
1350
  */
1421
1351
  (e: 'cellContextMenu', params: ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string): void
1422
1352
  /**
1423
1353
  * Fired when user double clicks a grid cell
1424
1354
  * @param {string} e Event name
1425
1355
  * @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 {Grid.view.Grid} params.params.event.grid The grid instance
1430
- * @param {Core.data.Model} params.params.event.record The record representing the row
1431
- * @param {Grid.column.Column} params.params.event.column The column to which the cell belongs
1432
- * @param {HTMLElement} params.params.event.cellElement The cell HTML element
1433
- * @param {HTMLElement} params.params.event.target The target element
1434
- * @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
1435
1363
  */
1436
1364
  (e: 'cellDblClick', params: ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string): void
1437
1365
  /**
@@ -1440,148 +1368,126 @@ const emit = defineEmits<{
1440
1368
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-cellMenuBeforeShow)
1441
1369
  * @param {string} e Event name
1442
1370
  * @param {object} params Event parameters
1443
- * @param {string} params.e Event name
1444
- * @param {object} params.params Event parameters
1445
- * @param {object} params.params.event Event object
1446
- * @param {Grid.view.Grid} params.params.event.source The grid
1447
- * @param {Core.widget.Menu} params.params.event.menu The menu
1448
- * @param {Record<string, MenuItemEntry>} params.params.event.items Menu item configs
1449
- * @param {Grid.column.Column} params.params.event.column Column
1450
- * @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
1451
1377
  */
1452
- (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
1453
1379
  /**
1454
1380
  * This event fires on the owning grid when an item is selected in the cell context menu.
1455
1381
  * @param {string} e Event name
1456
1382
  * @param {object} params Event parameters
1457
- * @param {string} params.e Event name
1458
- * @param {object} params.params Event parameters
1459
- * @param {object} params.params.event Event object
1460
- * @param {Grid.view.Grid} params.params.event.source The grid
1461
- * @param {Core.widget.Menu} params.params.event.menu The menu
1462
- * @param {Core.widget.MenuItem} params.params.event.item Selected menu item
1463
- * @param {Grid.column.Column} params.params.event.column Column
1464
- * @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
1465
1389
  */
1466
1390
  (e: 'cellMenuItem', params: ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column, record: Model }) => void)|string): void
1467
1391
  /**
1468
1392
  * This event fires on the owning grid after the context menu is shown for a cell.
1469
1393
  * @param {string} e Event name
1470
1394
  * @param {object} params Event parameters
1471
- * @param {string} params.e Event name
1472
- * @param {object} params.params Event parameters
1473
- * @param {object} params.params.event Event object
1474
- * @param {Grid.view.Grid} params.params.event.source The grid
1475
- * @param {Core.widget.Menu} params.params.event.menu The menu
1476
- * @param {Record<string, MenuItemEntry>} params.params.event.items Menu item configs
1477
- * @param {Grid.column.Column} params.params.event.column Column
1478
- * @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
1479
1401
  */
1480
1402
  (e: 'cellMenuShow', params: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => void)|string): void
1481
1403
  /**
1482
1404
  * This event fires on the owning grid when a check item is toggled in the cell context menu.
1483
1405
  * @param {string} e Event name
1484
1406
  * @param {object} params Event parameters
1485
- * @param {string} params.e Event name
1486
- * @param {object} params.params Event parameters
1487
- * @param {object} params.params.event Event object
1488
- * @param {Grid.view.Grid} params.params.event.source The grid
1489
- * @param {Core.widget.Menu} params.params.event.menu The menu
1490
- * @param {Core.widget.MenuItem} params.params.event.item Selected menu item
1491
- * @param {Grid.column.Column} params.params.event.column Column
1492
- * @param {Core.data.Model} params.params.event.record Record
1493
- * @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
1494
1414
  */
1495
1415
  (e: 'cellMenuToggleItem', params: ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column, record: Model, checked: boolean }) => void)|string): void
1496
1416
  /**
1497
1417
  * Fired when the mouse enters a cell
1498
1418
  * @param {string} e Event name
1499
1419
  * @param {object} params Event parameters
1500
- * @param {string} params.e Event name
1501
- * @param {object} params.params Event parameters
1502
- * @param {object} params.params.event Event object
1503
- * @param {Grid.view.Grid} params.params.event.source The grid instance
1504
- * @param {Core.data.Model} params.params.event.record The record representing the hovered cell
1505
- * @param {Grid.column.Column} params.params.event.column The column currently hovered
1506
- * @param {HTMLElement} params.params.event.cellElement The cell HTML element
1507
- * @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
1508
1426
  */
1509
1427
  (e: 'cellMouseEnter', params: ((event: { source: Grid, record: Model, column: Column, cellElement: HTMLElement, event: MouseEvent }) => void)|string): void
1510
1428
  /**
1511
1429
  * Fired when the mouse leaves a cell
1512
1430
  * @param {string} e Event name
1513
1431
  * @param {object} params Event parameters
1514
- * @param {string} params.e Event name
1515
- * @param {object} params.params Event parameters
1516
- * @param {object} params.params.event Event object
1517
- * @param {Grid.view.Grid} params.params.event.source The grid instance
1518
- * @param {Core.data.Model} params.params.event.record The record representing the cell that the mouse left
1519
- * @param {Grid.column.Column} params.params.event.column The column representing the cell that the mouse left
1520
- * @param {HTMLElement} params.params.event.cellElement The cell HTML element that the mouse left
1521
- * @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
1522
1438
  */
1523
1439
  (e: 'cellMouseLeave', params: ((event: { source: Grid, record: Model, column: Column, cellElement: HTMLElement, event: MouseEvent }) => void)|string): void
1524
1440
  /**
1525
1441
  * Fired when a user moves the mouse out of a grid cell
1526
1442
  * @param {string} e Event name
1527
1443
  * @param {object} params Event parameters
1528
- * @param {string} params.e Event name
1529
- * @param {object} params.params Event parameters
1530
- * @param {object} params.params.event Event object
1531
- * @param {Grid.view.Grid} params.params.event.grid The grid instance
1532
- * @param {Core.data.Model} params.params.event.record The record representing the row
1533
- * @param {Grid.column.Column} params.params.event.column The column to which the cell belongs
1534
- * @param {HTMLElement} params.params.event.cellElement The cell HTML element
1535
- * @param {HTMLElement} params.params.event.target The target element
1536
- * @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
1537
1451
  */
1538
1452
  (e: 'cellMouseOut', params: ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string): void
1539
1453
  /**
1540
1454
  * Fired when user moves the mouse over a grid cell
1541
1455
  * @param {string} e Event name
1542
1456
  * @param {object} params Event parameters
1543
- * @param {string} params.e Event name
1544
- * @param {object} params.params Event parameters
1545
- * @param {object} params.params.event Event object
1546
- * @param {Grid.view.Grid} params.params.event.grid The grid instance
1547
- * @param {Core.data.Model} params.params.event.record The record representing the row
1548
- * @param {Grid.column.Column} params.params.event.column The column to which the cell belongs
1549
- * @param {HTMLElement} params.params.event.cellElement The cell HTML element
1550
- * @param {HTMLElement} params.params.event.target The target element
1551
- * @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
1552
1464
  */
1553
1465
  (e: 'cellMouseOver', params: ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string): void
1554
1466
  /**
1555
1467
  * Fires when a Panel is collapsed using the [collapsible](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-collapsible) setting.
1556
1468
  * @param {string} e Event name
1557
1469
  * @param {object} params Event parameters
1558
- * @param {string} params.e Event name
1559
- * @param {object} params.params Event parameters
1560
- * @param {object} params.params.event Event object
1561
- * @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.
1562
1472
  */
1563
1473
  (e: 'collapse', params: ((event: { source: Panel }) => void)|string): void
1564
1474
  /**
1565
1475
  * Fired before a parent node record is collapsed.
1566
1476
  * @param {string} e Event name
1567
1477
  * @param {object} params Event parameters
1568
- * @param {string} params.e Event name
1569
- * @param {object} params.params Event parameters
1570
- * @param {object} params.params.event Event object
1571
- * @param {Grid.view.Grid} params.params.event.source The firing Grid instance.
1572
- * @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.
1573
1481
  */
1574
1482
  (e: 'collapseNode', params: ((event: { source: Grid, record: Model }) => void)|string): void
1575
1483
  /**
1576
1484
  * This event is triggered after a parent column has been collapsed or expanded.
1577
1485
  * @param {string} e Event name
1578
1486
  * @param {object} params Event parameters
1579
- * @param {string} params.e Event name
1580
- * @param {object} params.params Event parameters
1581
- * @param {object} params.params.event Event object
1582
- * @param {Grid.view.GridBase} params.params.event.source The Grid instance
1583
- * @param {Grid.column.Column} params.params.event.column The column being toggled
1584
- * @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
1585
1491
  */
1586
1492
  (e: 'columnCollapseToggle', params: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string): void
1587
1493
  /**
@@ -1589,27 +1495,23 @@ const emit = defineEmits<{
1589
1495
  * to indicate whether the drop position is valid or not.
1590
1496
  * @param {string} e Event name
1591
1497
  * @param {object} params Event parameters
1592
- * @param {string} params.e Event name
1593
- * @param {object} params.params Event parameters
1594
- * @param {object} params.params.event Event object
1595
- * @param {Grid.view.Grid} params.params.event.source The grid instance.
1596
- * @param {Grid.column.Column} params.params.event.column The dragged column.
1597
- * @param {Grid.column.Column} params.params.event.insertBefore The column before which the dragged column will be inserted (if not last).
1598
- * @param {Event} params.params.event.event The browser event.
1599
- * @param {object} params.params.event.context
1600
- * @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.
1601
1505
  */
1602
1506
  (e: 'columnDrag', params: ((event: { source: Grid, column: Column, insertBefore: Column, event: Event, context: { valid: boolean } }) => void)|string): void
1603
1507
  /**
1604
1508
  * This event is fired when a column drag gesture has started.
1605
1509
  * @param {string} e Event name
1606
1510
  * @param {object} params Event parameters
1607
- * @param {string} params.e Event name
1608
- * @param {object} params.params Event parameters
1609
- * @param {object} params.params.event Event object
1610
- * @param {Grid.view.Grid} params.params.event.source The grid instance.
1611
- * @param {Grid.column.Column} params.params.event.column The dragged column.
1612
- * @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.
1613
1515
  */
1614
1516
  (e: 'columnDragStart', params: ((event: { source: Grid, column: Column, event: Event }) => void)|string): void
1615
1517
  /**
@@ -1617,79 +1519,67 @@ const emit = defineEmits<{
1617
1519
  * vetoed and the column was moved in the column store.
1618
1520
  * @param {string} e Event name
1619
1521
  * @param {object} params Event parameters
1620
- * @param {string} params.e Event name
1621
- * @param {object} params.params Event parameters
1622
- * @param {object} params.params.event Event object
1623
- * @param {Grid.view.Grid} params.params.event.source The grid instance.
1624
- * @param {Grid.column.Column} params.params.event.column The dragged column.
1625
- * @param {Grid.column.Column} params.params.event.insertBefore The column before which the dragged column will be inserted.
1626
- * @param {Grid.column.Column} params.params.event.newParent The new parent column.
1627
- * @param {boolean} params.params.event.valid `true` if the operation was not vetoed.
1628
- * @param {Event} params.params.event.event The browser event.
1629
- * @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.
1630
1530
  */
1631
- (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
1632
1532
  /**
1633
1533
  * This event is fired after a resize gesture is completed.
1634
1534
  * @param {string} e Event name
1635
1535
  * @param {object} params Event parameters
1636
- * @param {string} params.e Event name
1637
- * @param {object} params.params Event parameters
1638
- * @param {object} params.params.event Event object
1639
- * @param {Grid.view.Grid} params.params.event.source The grid instance
1640
- * @param {Grid.column.Column} params.params.event.column The resized column
1641
- * @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
1642
1540
  */
1643
1541
  (e: 'columnResize', params: ((event: { source: Grid, column: Column, domEvent: Event }) => void)|string): void
1644
1542
  /**
1645
1543
  * This event is fired when a column resize gesture starts.
1646
1544
  * @param {string} e Event name
1647
1545
  * @param {object} params Event parameters
1648
- * @param {string} params.e Event name
1649
- * @param {object} params.params Event parameters
1650
- * @param {object} params.params.event Event object
1651
- * @param {Grid.view.Grid} params.params.event.source The grid instance
1652
- * @param {Grid.column.Column} params.params.event.column The column
1653
- * @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
1654
1550
  */
1655
1551
  (e: 'columnResizeStart', params: ((event: { source: Grid, column: Column, domEvent: Event }) => void)|string): void
1656
1552
  /**
1657
1553
  * This event fires on the owning widget when an item is selected in the context menu.
1658
1554
  * @param {string} e Event name
1659
1555
  * @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 {Core.widget.Widget} params.params.event.source The owning widget
1664
- * @param {Core.widget.Menu} params.params.event.menu The menu
1665
- * @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
1666
1560
  */
1667
1561
  (e: 'contextMenuItem', params: ((event: { source: Widget, menu: Menu, item: MenuItem }) => void)|string): void
1668
1562
  /**
1669
1563
  * This event fires on the owning widget when a check item is toggled in the context menu.
1670
1564
  * @param {string} e Event name
1671
1565
  * @param {object} params Event parameters
1672
- * @param {string} params.e Event name
1673
- * @param {object} params.params Event parameters
1674
- * @param {object} params.params.event Event object
1675
- * @param {Core.widget.Widget} params.params.event.source The owning widget
1676
- * @param {Core.widget.Menu} params.params.event.menu The menu
1677
- * @param {Core.widget.MenuItem} params.params.event.item Selected menu item
1678
- * @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
1679
1571
  */
1680
1572
  (e: 'contextMenuToggleItem', params: ((event: { source: Widget, menu: Menu, item: MenuItem, checked: boolean }) => void)|string): void
1681
1573
  /**
1682
1574
  * Fires on the owning Grid after a copy action is performed.
1683
1575
  * @param {string} e Event name
1684
1576
  * @param {object} params Event parameters
1685
- * @param {string} params.e Event name
1686
- * @param {object} params.params Event parameters
1687
- * @param {object} params.params.event Event object
1688
- * @param {Grid.view.Grid} params.params.event.source Owner grid
1689
- * @param {Grid.util.GridLocation[]} params.params.event.cells The cells about to be copied or cut
1690
- * @param {string} params.params.event.copiedDataString The concatenated data string that was copied or cut
1691
- * @param {boolean} params.params.event.isCut `true` if this was a cut action
1692
- * @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
1693
1583
  */
1694
1584
  (e: 'copy', params: ((event: { source: Grid, cells: GridLocation[], copiedDataString: string, isCut: boolean, entityName: string }) => void)|string): void
1695
1585
  /**
@@ -1697,36 +1587,30 @@ const emit = defineEmits<{
1697
1587
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-dataChange)
1698
1588
  * @param {string} e Event name
1699
1589
  * @param {object} params Event parameters
1700
- * @param {string} params.e Event name
1701
- * @param {object} params.params Event parameters
1702
- * @param {object} params.params.event Event object
1703
- * @param {Grid.view.GridBase} params.params.event.source Owning grid
1704
- * @param {Core.data.Store} params.params.event.store The originating store
1705
- * @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'`
1706
- * @param {Core.data.Model} params.params.event.record Changed record, for actions that affects exactly one record (`'update'`)
1707
- * @param {Core.data.Model[]} params.params.event.records Changed records, passed for all actions except `'removeAll'`
1708
- * @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
1709
1597
  */
1710
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
1711
1599
  /**
1712
1600
  * Fires when an object is destroyed.
1713
1601
  * @param {string} e Event name
1714
1602
  * @param {object} params Event parameters
1715
- * @param {string} params.e Event name
1716
- * @param {object} params.params Event parameters
1717
- * @param {object} params.params.event Event object
1718
- * @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.
1719
1605
  */
1720
1606
  (e: 'destroy', params: ((event: { source: Base }) => void)|string): void
1721
1607
  /**
1722
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
1723
1609
  * @param {string} e Event name
1724
1610
  * @param {object} params Event parameters
1725
- * @param {string} params.e Event name
1726
- * @param {object} params.params Event parameters
1727
- * @param {object} params.params.event Event object
1728
- * @param {Core.widget.Container} params.params.event.source The container.
1729
- * @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.
1730
1614
  */
1731
1615
  (e: 'dirtyStateChange', params: ((event: { source: Container, dirty: boolean }) => void)|string): void
1732
1616
  /**
@@ -1734,55 +1618,45 @@ const emit = defineEmits<{
1734
1618
  * mouse up. This event can be listened for to perform actions while drag selecting.
1735
1619
  * @param {string} e Event name
1736
1620
  * @param {object} params Event parameters
1737
- * @param {string} params.e Event name
1738
- * @param {object} params.params Event parameters
1739
- * @param {object} params.params.event Event object
1740
- * @param {Grid.view.Grid} params.params.event.source
1741
- * @param {GridLocationConfig[],Grid.util.GridLocation[]} params.params.event.selectedCells The cells that is currently being dragged over
1742
- * @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
1743
1625
  */
1744
1626
  (e: 'dragSelecting', params: ((event: { source: Grid, selectedCells: GridLocationConfig[]|GridLocation[], selectedRecords: Model[] }) => void)|string): void
1745
1627
  /**
1746
1628
  * Triggered when a widget's [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element) is available.
1747
1629
  * @param {string} e Event name
1748
1630
  * @param {object} params Event parameters
1749
- * @param {string} params.e Event name
1750
- * @param {object} params.params Event parameters
1751
- * @param {object} params.params.event Event object
1752
- * @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.
1753
1633
  */
1754
1634
  (e: 'elementCreated', params: ((event: { element: HTMLElement }) => void)|string): void
1755
1635
  /**
1756
1636
  * Fires when a Panel is expanded using the [collapsible](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-collapsible) setting.
1757
1637
  * @param {string} e Event name
1758
1638
  * @param {object} params Event parameters
1759
- * @param {string} params.e Event name
1760
- * @param {object} params.params Event parameters
1761
- * @param {object} params.params.event Event object
1762
- * @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.
1763
1641
  */
1764
1642
  (e: 'expand', params: ((event: { source: Panel }) => void)|string): void
1765
1643
  /**
1766
1644
  * Fired after a parent node record is expanded.
1767
1645
  * @param {string} e Event name
1768
1646
  * @param {object} params Event parameters
1769
- * @param {string} params.e Event name
1770
- * @param {object} params.params Event parameters
1771
- * @param {object} params.params.event Event object
1772
- * @param {Grid.view.Grid} params.params.event.source The firing Grid instance.
1773
- * @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.
1774
1650
  */
1775
1651
  (e: 'expandNode', params: ((event: { source: Grid, record: Model }) => void)|string): void
1776
1652
  /**
1777
1653
  * Fired when a file is dropped on the widget element
1778
1654
  * @param {string} e Event name
1779
1655
  * @param {object} params Event parameters
1780
- * @param {string} params.e Event name
1781
- * @param {object} params.params Event parameters
1782
- * @param {object} params.params.event Event object
1783
- * @param {Grid.view.Grid} params.params.event.source The owning Grid instance
1784
- * @param {DataTransferItem} params.params.event.file The dropped file descriptor
1785
- * @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
1786
1660
  */
1787
1661
  (e: 'fileDrop', params: ((event: { source: Grid, file: DataTransferItem, domEvent: DragEvent }) => void)|string): void
1788
1662
  /**
@@ -1790,24 +1664,20 @@ const emit = defineEmits<{
1790
1664
  * drag operation from applying data changes.
1791
1665
  * @param {string} e Event name
1792
1666
  * @param {object} params Event parameters
1793
- * @param {string} params.e Event name
1794
- * @param {object} params.params Event parameters
1795
- * @param {object} params.params.event Event object
1796
- * @param {Grid.util.GridLocation} params.params.event.from The from cell
1797
- * @param {Grid.util.GridLocation} params.params.event.to The to cell
1798
- * @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
1799
1671
  */
1800
1672
  (e: 'fillHandleBeforeDragFinalize', params: ((event: { from: GridLocation, to: GridLocation, domEvent: MouseEvent }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1801
1673
  /**
1802
1674
  * Fired while dragging the FillHandle.
1803
1675
  * @param {string} e Event name
1804
1676
  * @param {object} params Event parameters
1805
- * @param {string} params.e Event name
1806
- * @param {object} params.params Event parameters
1807
- * @param {object} params.params.event Event object
1808
- * @param {Grid.util.GridLocation} params.params.event.from The from cell
1809
- * @param {Grid.util.GridLocation} params.params.event.to The to cell
1810
- * @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
1811
1681
  */
1812
1682
  (e: 'fillHandleDrag', params: ((event: { from: GridLocation, to: GridLocation, domEvent: MouseEvent }) => void)|string): void
1813
1683
  /**
@@ -1818,34 +1688,28 @@ const emit = defineEmits<{
1818
1688
  * Fired after a FillHandle drag operation.
1819
1689
  * @param {string} e Event name
1820
1690
  * @param {object} params Event parameters
1821
- * @param {string} params.e Event name
1822
- * @param {object} params.params Event parameters
1823
- * @param {object} params.params.event Event object
1824
- * @param {Grid.util.GridLocation} params.params.event.from The from cell
1825
- * @param {Grid.util.GridLocation} params.params.event.to The to cell
1826
- * @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
1827
1695
  */
1828
1696
  (e: 'fillHandleDragEnd', params: ((event: { from: GridLocation, to: GridLocation, domEvent: MouseEvent }) => void)|string): void
1829
1697
  /**
1830
1698
  * Fired when dragging of the FillHandle starts.
1831
1699
  * @param {string} e Event name
1832
1700
  * @param {object} params Event parameters
1833
- * @param {string} params.e Event name
1834
- * @param {object} params.params Event parameters
1835
- * @param {object} params.params.event Event object
1836
- * @param {Grid.util.GridLocation} params.params.event.cell Information about the column / record
1837
- * @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
1838
1704
  */
1839
- (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
1840
1706
  /**
1841
1707
  * Fires on the owning Grid when cell editing is finished
1842
1708
  * @param {string} e Event name
1843
1709
  * @param {object} params Event parameters
1844
- * @param {string} params.e Event name
1845
- * @param {object} params.params Event parameters
1846
- * @param {object} params.params.event Event object
1847
- * @param {Grid.view.Grid} params.params.event.grid Target grid
1848
- * @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
1849
1713
  */
1850
1714
  (e: 'finishCellEdit', params: ((event: { grid: Grid, editorContext: CellEditorContext }) => void)|string): void
1851
1715
  /**
@@ -1853,26 +1717,22 @@ const emit = defineEmits<{
1853
1717
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-finishRowEdit)
1854
1718
  * @param {string} e Event name
1855
1719
  * @param {object} params Event parameters
1856
- * @param {string} params.e Event name
1857
- * @param {object} params.params Event parameters
1858
- * @param {object} params.params.event Event object
1859
- * @param {Grid.view.Grid} params.params.event.grid Target grid
1860
- * @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
1861
1723
  */
1862
1724
  (e: 'finishRowEdit', params: ((event: { grid: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1863
1725
  /**
1864
1726
  * Fired when focus enters this Widget.
1865
1727
  * @param {string} e Event name
1866
1728
  * @param {object} params Event parameters
1867
- * @param {string} params.e Event name
1868
- * @param {object} params.params Event parameters
1869
- * @param {object} params.params.event Event object
1870
- * @param {Core.widget.Widget} params.params.event.source This Widget
1871
- * @param {HTMLElement} params.params.event.fromElement The element which lost focus.
1872
- * @param {HTMLElement} params.params.event.toElement The element which gained focus.
1873
- * @param {Core.widget.Widget} params.params.event.fromWidget The widget which lost focus.
1874
- * @param {Core.widget.Widget} params.params.event.toWidget The widget which gained focus.
1875
- * @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.
1876
1736
  */
1877
1737
  (e: 'focusIn', params: ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string): void
1878
1738
  /**
@@ -1881,46 +1741,40 @@ const emit = defineEmits<{
1881
1741
  * will not trigger this event. This is when focus exits this widget completely.
1882
1742
  * @param {string} e Event name
1883
1743
  * @param {object} params Event parameters
1884
- * @param {string} params.e Event name
1885
- * @param {object} params.params Event parameters
1886
- * @param {object} params.params.event Event object
1887
- * @param {Core.widget.Widget} params.params.event.source This Widget
1888
- * @param {HTMLElement} params.params.event.fromElement The element which lost focus.
1889
- * @param {HTMLElement} params.params.event.toElement The element which gained focus.
1890
- * @param {Core.widget.Widget} params.params.event.fromWidget The widget which lost focus.
1891
- * @param {Core.widget.Widget} params.params.event.toWidget The widget which gained focus.
1892
- * @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.
1893
1751
  */
1894
1752
  (e: 'focusOut', params: ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string): void
1895
1753
  /**
1896
1754
  * Fired before dragging starts, return false to prevent the drag operation.
1897
1755
  * @param {string} e Event name
1898
1756
  * @param {object} params Event parameters
1899
- * @param {string} params.e Event name
1900
- * @param {object} params.params Event parameters
1901
- * @param {object} params.params.event Event object
1902
- * @param {Grid.view.GridBase} params.params.event.source
1903
- * @param {object} params.params.event.context
1904
- * @param {Core.data.Model[]} params.params.event.context.records The dragged row records
1905
- * @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
1906
1762
  */
1907
- (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
1908
1764
  /**
1909
1765
  * Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
1910
1766
  * Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
1911
1767
  * @param {string} e Event name
1912
1768
  * @param {object} params Event parameters
1913
- * @param {string} params.e Event name
1914
- * @param {object} params.params Event parameters
1915
- * @param {object} params.params.event Event object
1916
- * @param {Grid.view.GridBase} params.params.event.source
1917
- * @param {object} params.params.event.context
1918
- * @param {boolean} params.params.event.context.valid Set this to true or false to indicate whether the drop position is valid
1919
- * @param {Core.data.Model} params.params.event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
1920
- * @param {Core.data.Model} params.params.event.context.parent The parent record of the current drop position (only applicable for trees)
1921
- * @param {Core.data.Model[]} params.params.event.context.records The dragged row records
1922
- * @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
1923
- * @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
1924
1778
  */
1925
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
1926
1780
  /**
@@ -1929,59 +1783,51 @@ const emit = defineEmits<{
1929
1783
  * valid or invalid by setting `context.valid = false;`
1930
1784
  * @param {string} e Event name
1931
1785
  * @param {object} params Event parameters
1932
- * @param {string} params.e Event name
1933
- * @param {object} params.params Event parameters
1934
- * @param {object} params.params.event Event object
1935
- * @param {Grid.view.GridBase} params.params.event.source
1936
- * @param {object} params.params.event.context
1937
- * @param {boolean} params.params.event.context.valid Set this to true or false to indicate whether the drop position is valid.
1938
- * @param {Core.data.Model} params.params.event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
1939
- * @param {Core.data.Model} params.params.event.context.parent The parent record of the current drop position (only applicable for trees)
1940
- * @param {Core.data.Model[]} params.params.event.context.records The dragged row records
1941
- * @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
1942
1794
  */
1943
1795
  (e: 'gridRowDrag', params: ((event: { source: GridBase, context: { valid: boolean, insertBefore: Model, parent: Model, records: Model[] }, event: MouseEvent }) => void)|string): void
1944
1796
  /**
1945
1797
  * Fired when a row drag operation is aborted
1946
1798
  * @param {string} e Event name
1947
1799
  * @param {object} params Event parameters
1948
- * @param {string} params.e Event name
1949
- * @param {object} params.params Event parameters
1950
- * @param {object} params.params.event Event object
1951
- * @param {Grid.view.GridBase} params.params.event.source
1952
- * @param {object} params.params.event.context
1953
- * @param {Core.data.Model[]} params.params.event.context.records The dragged row records
1954
- * @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
1955
1805
  */
1956
1806
  (e: 'gridRowDragAbort', params: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent }) => void)|string): void
1957
1807
  /**
1958
1808
  * Fired when dragging starts.
1959
1809
  * @param {string} e Event name
1960
1810
  * @param {object} params Event parameters
1961
- * @param {string} params.e Event name
1962
- * @param {object} params.params Event parameters
1963
- * @param {object} params.params.event Event object
1964
- * @param {Grid.view.GridBase} params.params.event.source
1965
- * @param {object} params.params.event.context
1966
- * @param {Core.data.Model[]} params.params.event.context.records The dragged row records
1967
- * @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
1968
1816
  */
1969
1817
  (e: 'gridRowDragStart', params: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => void)|string): void
1970
1818
  /**
1971
1819
  * Fired after the row drop operation has completed, regardless of validity
1972
1820
  * @param {string} e Event name
1973
1821
  * @param {object} params Event parameters
1974
- * @param {string} params.e Event name
1975
- * @param {object} params.params Event parameters
1976
- * @param {object} params.params.event Event object
1977
- * @param {Grid.view.GridBase} params.params.event.source
1978
- * @param {object} params.params.event.context
1979
- * @param {boolean} params.params.event.context.valid true or false depending on whether the drop position was valid
1980
- * @param {Core.data.Model} params.params.event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
1981
- * @param {Core.data.Model} params.params.event.context.parent The parent record of the current drop position (only applicable for trees)
1982
- * @param {Core.data.Model[]} params.params.event.context.records The dragged row records
1983
- * @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
1984
- * @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
1985
1831
  */
1986
1832
  (e: 'gridRowDrop', params: ((event: { source: GridBase, context: { valid: boolean, insertBefore: Model, parent: Model, records: Model[], oldPositionContext: RecordPositionContext[] }, event: MouseEvent }) => void)|string): void
1987
1833
  /**
@@ -1989,106 +1835,88 @@ const emit = defineEmits<{
1989
1835
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-headerClick)
1990
1836
  * @param {string} e Event name
1991
1837
  * @param {object} params Event parameters
1992
- * @param {string} params.e Event name
1993
- * @param {object} params.params Event parameters
1994
- * @param {object} params.params.event Event object
1995
- * @param {Event} params.params.event.domEvent The triggering DOM event.
1996
- * @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.
1997
1841
  */
1998
- (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
1999
1843
  /**
2000
1844
  * This event fires on the owning Grid before the context menu is shown for a header.
2001
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).
2002
1846
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-headerMenuBeforeShow)
2003
1847
  * @param {string} e Event name
2004
1848
  * @param {object} params Event parameters
2005
- * @param {string} params.e Event name
2006
- * @param {object} params.params Event parameters
2007
- * @param {object} params.params.event Event object
2008
- * @param {Grid.view.Grid} params.params.event.source The grid
2009
- * @param {Core.widget.Menu} params.params.event.menu The menu
2010
- * @param {Record<string, MenuItemEntry>} params.params.event.items Menu item configs
2011
- * @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
2012
1854
  */
2013
- (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
2014
1856
  /**
2015
1857
  * This event fires on the owning Grid when an item is selected in the header context menu.
2016
1858
  * @param {string} e Event name
2017
1859
  * @param {object} params Event parameters
2018
- * @param {string} params.e Event name
2019
- * @param {object} params.params Event parameters
2020
- * @param {object} params.params.event Event object
2021
- * @param {Grid.view.Grid} params.params.event.source The grid
2022
- * @param {Core.widget.Menu} params.params.event.menu The menu
2023
- * @param {Core.widget.MenuItem} params.params.event.item Selected menu item
2024
- * @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
2025
1865
  */
2026
1866
  (e: 'headerMenuItem', params: ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column }) => void)|string): void
2027
1867
  /**
2028
1868
  * This event fires on the owning Grid after the context menu is shown for a header
2029
1869
  * @param {string} e Event name
2030
1870
  * @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.Grid} params.params.event.source The grid
2035
- * @param {Core.widget.Menu} params.params.event.menu The menu
2036
- * @param {Record<string, MenuItemEntry>} params.params.event.items Menu item configs
2037
- * @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
2038
1876
  */
2039
1877
  (e: 'headerMenuShow', params: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => void)|string): void
2040
1878
  /**
2041
1879
  * This event fires on the owning Grid when a check item is toggled in the header context menu.
2042
1880
  * @param {string} e Event name
2043
1881
  * @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.Grid} params.params.event.source The grid
2048
- * @param {Core.widget.Menu} params.params.event.menu The menu
2049
- * @param {Core.widget.MenuItem} params.params.event.item Selected menu item
2050
- * @param {Grid.column.Column} params.params.event.column Column
2051
- * @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
2052
1888
  */
2053
1889
  (e: 'headerMenuToggleItem', params: ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column, checked: boolean }) => void)|string): void
2054
1890
  /**
2055
1891
  * Triggered after a widget was hidden
2056
1892
  * @param {string} e Event name
2057
1893
  * @param {object} params Event parameters
2058
- * @param {string} params.e Event name
2059
- * @param {object} params.params Event parameters
2060
- * @param {object} params.params.event Event object
2061
- * @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
2062
1896
  */
2063
1897
  (e: 'hide', params: ((event: { source: Widget }) => void)|string): void
2064
1898
  /**
2065
1899
  * Fires when row locking is enabled.
2066
1900
  * @param {string} e Event name
2067
1901
  * @param {object} params Event parameters
2068
- * @param {string} params.e Event name
2069
- * @param {object} params.params Event parameters
2070
- * @param {object} params.params.event Event object
2071
- * @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
2072
1904
  */
2073
1905
  (e: 'lockRows', params: ((event: { clone: GridBase }) => void)|string): void
2074
1906
  /**
2075
1907
  * Mouse moved out from element in grid
2076
1908
  * @param {string} e Event name
2077
1909
  * @param {object} params Event parameters
2078
- * @param {string} params.e Event name
2079
- * @param {object} params.params Event parameters
2080
- * @param {object} params.params.event Event object
2081
- * @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
2082
1912
  */
2083
1913
  (e: 'mouseOut', params: ((event: { event: MouseEvent }) => void)|string): void
2084
1914
  /**
2085
1915
  * Mouse moved in over element in grid
2086
1916
  * @param {string} e Event name
2087
1917
  * @param {object} params Event parameters
2088
- * @param {string} params.e Event name
2089
- * @param {object} params.params Event parameters
2090
- * @param {object} params.params.event Event object
2091
- * @param {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
2092
1920
  */
2093
1921
  (e: 'mouseOver', params: ((event: { event: MouseEvent }) => void)|string): void
2094
1922
  /**
@@ -2097,46 +1925,38 @@ const emit = defineEmits<{
2097
1925
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-paint)
2098
1926
  * @param {string} e Event name
2099
1927
  * @param {object} params Event parameters
2100
- * @param {string} params.e Event name
2101
- * @param {object} params.params Event parameters
2102
- * @param {object} params.params.event Event object
2103
- * @param {Core.widget.Widget} params.params.event.source The widget being painted.
2104
- * @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.
2105
1931
  */
2106
1932
  (e: 'paint', params: ((event: { source: Widget, firstPaint: boolean }) => void)|string): void
2107
1933
  /**
2108
1934
  * Fires on the owning Grid after a paste action is performed.
2109
1935
  * @param {string} e Event name
2110
1936
  * @param {object} params Event parameters
2111
- * @param {string} params.e Event name
2112
- * @param {object} params.params Event parameters
2113
- * @param {object} params.params.event Event object
2114
- * @param {Grid.view.Grid} params.params.event.source Owner grid
2115
- * @param {string} params.params.event.clipboardData The clipboardData that was pasted
2116
- * @param {Core.data.Model[]} params.params.event.modifiedRecords The records which have been modified due to the paste action
2117
- * @param {Grid.util.GridLocation} params.params.event.targetCell The cell from which the paste will be started
2118
- * @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
2119
1943
  */
2120
1944
  (e: 'paste', params: ((event: { source: Grid, clipboardData: string, modifiedRecords: Model[], targetCell: GridLocation, entityName: string }) => void)|string): void
2121
1945
  /**
2122
1946
  * Fires on the owning Grid when export has finished
2123
1947
  * @param {string} e Event name
2124
1948
  * @param {object} params Event parameters
2125
- * @param {string} params.e Event name
2126
- * @param {object} params.params Event parameters
2127
- * @param {object} params.params.event Event object
2128
- * @param {Response} [params.params.event.response] Optional response, if received
2129
- * @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
2130
1952
  */
2131
1953
  (e: 'pdfExport', params: ((event: { response?: Response, error?: Error }) => void)|string): void
2132
1954
  /**
2133
1955
  * Fired when a Widget's read only state is toggled
2134
1956
  * @param {string} e Event name
2135
1957
  * @param {object} params Event parameters
2136
- * @param {string} params.e Event name
2137
- * @param {object} params.params Event parameters
2138
- * @param {object} params.params.event Event object
2139
- * @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
2140
1960
  */
2141
1961
  (e: 'readOnly', params: ((event: { readOnly: boolean }) => void)|string): void
2142
1962
  /**
@@ -2148,61 +1968,51 @@ const emit = defineEmits<{
2148
1968
  * Fires after a row is rendered.
2149
1969
  * @param {string} e Event name
2150
1970
  * @param {object} params Event parameters
2151
- * @param {string} params.e Event name
2152
- * @param {object} params.params Event parameters
2153
- * @param {object} params.params.event Event object
2154
- * @param {Grid.view.GridBase} params.params.event.source The firing Grid instance
2155
- * @param {Grid.row.Row} params.params.event.row The row that has been rendered
2156
- * @param {Core.data.Model} params.params.event.record The record for the row
2157
- * @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
2158
1976
  */
2159
1977
  (e: 'renderRow', params: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string): void
2160
1978
  /**
2161
1979
  * Grid rows have been rendered
2162
1980
  * @param {string} e Event name
2163
1981
  * @param {object} params Event parameters
2164
- * @param {string} params.e Event name
2165
- * @param {object} params.params Event parameters
2166
- * @param {object} params.params.event Event object
2167
- * @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.
2168
1984
  */
2169
1985
  (e: 'renderRows', params: ((event: { source: GridBase }) => void)|string): void
2170
1986
  /**
2171
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`*.
2172
1988
  * @param {string} e Event name
2173
1989
  * @param {object} params Event parameters
2174
- * @param {string} params.e Event name
2175
- * @param {object} params.params Event parameters
2176
- * @param {object} params.params.event Event object
2177
- * @param {Core.widget.Widget} params.params.event.source This Widget
2178
- * @param {number} params.params.event.width The new width
2179
- * @param {number} params.params.event.height The new height
2180
- * @param {number} params.params.event.oldWidth The old width
2181
- * @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
2182
1996
  */
2183
1997
  (e: 'resize', params: ((event: { source: Widget, width: number, height: number, oldWidth: number, oldHeight: number }) => void)|string): void
2184
1998
  /**
2185
1999
  * Grid resize lead to a new responsive level being applied
2186
2000
  * @param {string} e Event name
2187
2001
  * @param {object} params Event parameters
2188
- * @param {string} params.e Event name
2189
- * @param {object} params.params Event parameters
2190
- * @param {object} params.params.event Event object
2191
- * @param {Grid.view.Grid} params.params.event.grid Grid that was resized
2192
- * @param {string} params.params.event.level New responsive level (small, large, etc)
2193
- * @param {number} params.params.event.width New width in px
2194
- * @param {string} params.params.event.oldLevel Old responsive level
2195
- * @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
2196
2008
  */
2197
2009
  (e: 'responsive', params: ((event: { grid: Grid, level: string, width: number, oldLevel: string, oldWidth: number }) => void)|string): void
2198
2010
  /**
2199
2011
  * This event fires when a row has finished collapsing.
2200
2012
  * @param {string} e Event name
2201
2013
  * @param {object} params Event parameters
2202
- * @param {string} params.e Event name
2203
- * @param {object} params.params Event parameters
2204
- * @param {object} params.params.event Event object
2205
- * @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
2206
2016
  */
2207
2017
  (e: 'rowCollapse', params: ((event: { record: Model }) => void)|string): void
2208
2018
  /**
@@ -2210,103 +2020,87 @@ const emit = defineEmits<{
2210
2020
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-rowExpand)
2211
2021
  * @param {string} e Event name
2212
2022
  * @param {object} params Event parameters
2213
- * @param {string} params.e Event name
2214
- * @param {object} params.params Event parameters
2215
- * @param {object} params.params.event Event object
2216
- * @param {Core.data.Model} params.params.event.record Record
2217
- * @param {object} params.params.event.expandedElements An object with the Grid region name as property and the expanded body element as value
2218
- * @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.
2219
- * @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
2220
2028
  */
2221
2029
  (e: 'rowExpand', params: ((event: { record: Model, expandedElements: object, widget: Widget, widgets: object }) => void)|string): void
2222
2030
  /**
2223
2031
  * Fired when the mouse enters a row
2224
2032
  * @param {string} e Event name
2225
2033
  * @param {object} params Event parameters
2226
- * @param {string} params.e Event name
2227
- * @param {object} params.params Event parameters
2228
- * @param {object} params.params.event Event object
2229
- * @param {Grid.view.Grid} params.params.event.source The grid instance
2230
- * @param {Core.data.Model} params.params.event.record The record representing the hovered row
2231
- * @param {Grid.column.Column} params.params.event.column The column currently hovered
2232
- * @param {HTMLElement} params.params.event.cellElement The cell HTML element
2233
- * @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
2234
2040
  */
2235
2041
  (e: 'rowMouseEnter', params: ((event: { source: Grid, record: Model, column: Column, cellElement: HTMLElement, event: MouseEvent }) => void)|string): void
2236
2042
  /**
2237
2043
  * Fired when the mouse leaves a row
2238
2044
  * @param {string} e Event name
2239
2045
  * @param {object} params Event parameters
2240
- * @param {string} params.e Event name
2241
- * @param {object} params.params Event parameters
2242
- * @param {object} params.params.event Event object
2243
- * @param {Grid.view.Grid} params.params.event.source The grid instance
2244
- * @param {Core.data.Model} params.params.event.record The record representing the row that the mouse left
2245
- * @param {HTMLElement} params.params.event.cellElement The cell HTML element that the mouse left
2246
- * @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
2247
2051
  */
2248
2052
  (e: 'rowMouseLeave', params: ((event: { source: Grid, record: Model, cellElement: HTMLElement, event: MouseEvent }) => void)|string): void
2249
2053
  /**
2250
2054
  * Grid has scrolled vertically
2251
2055
  * @param {string} e Event name
2252
2056
  * @param {object} params Event parameters
2253
- * @param {string} params.e Event name
2254
- * @param {object} params.params Event parameters
2255
- * @param {object} params.params.event Event object
2256
- * @param {Grid.view.GridBase} params.params.event.source The firing Grid instance.
2257
- * @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.
2258
2060
  */
2259
2061
  (e: 'scroll', params: ((event: { source: GridBase, scrollTop: number }) => void)|string): void
2260
2062
  /**
2261
2063
  * The selection has been changed.
2262
2064
  * @param {string} e Event name
2263
2065
  * @param {object} params Event parameters
2264
- * @param {string} params.e Event name
2265
- * @param {object} params.params Event parameters
2266
- * @param {object} params.params.event Event object
2267
- * @param {'select','deselect'} params.params.event.action `'select'`/`'deselect'`
2268
- * @param {'row','cell'} params.params.event.mode `'row'`/`'cell'`
2269
- * @param {Grid.view.Grid} params.params.event.source
2270
- * @param {Core.data.Model[]} params.params.event.deselected The records deselected in this operation.
2271
- * @param {Core.data.Model[]} params.params.event.selected The records selected in this operation.
2272
- * @param {Core.data.Model[]} params.params.event.selection The records in the new selection.
2273
- * @param {Grid.util.GridLocation[]} params.params.event.deselectedCells The cells deselected in this operation.
2274
- * @param {Grid.util.GridLocation[]} params.params.event.selectedCells The cells selected in this operation.
2275
- * @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.
2276
2076
  */
2277
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
2278
2078
  /**
2279
2079
  * The selectionMode configuration has been changed.
2280
2080
  * @param {string} e Event name
2281
2081
  * @param {object} params Event parameters
2282
- * @param {string} params.e Event name
2283
- * @param {object} params.params Event parameters
2284
- * @param {object} params.params.event Event object
2285
- * @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)
2286
2084
  */
2287
2085
  (e: 'selectionModeChange', params: ((event: { selectionMode: object }) => void)|string): void
2288
2086
  /**
2289
2087
  * Triggered after a widget is shown.
2290
2088
  * @param {string} e Event name
2291
2089
  * @param {object} params Event parameters
2292
- * @param {string} params.e Event name
2293
- * @param {object} params.params Event parameters
2294
- * @param {object} params.params.event Event object
2295
- * @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
2296
2092
  */
2297
2093
  (e: 'show', params: ((event: { source: Widget }) => void)|string): void
2298
2094
  /**
2299
2095
  * Fires when splitting the Grid.
2300
2096
  * @param {string} e Event name
2301
2097
  * @param {object} params Event parameters
2302
- * @param {string} params.e Event name
2303
- * @param {object} params.params Event parameters
2304
- * @param {object} params.params.event Event object
2305
- * @param {Grid.view.GridBase[]} params.params.event.subViews The sub views created by the split
2306
- * @param {object} params.params.event.options The options passed to the split call
2307
- * @param {'horizontal','vertical','both'} params.params.event.options.direction The direction of the split
2308
- * @param {Grid.column.Column} params.params.event.options.atColumn The column to split at
2309
- * @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
2310
2104
  */
2311
2105
  (e: 'split', params: ((event: { subViews: GridBase[], options: { direction: 'horizontal'|'vertical'|'both', atColumn: Column, atRecord: Model } }) => void)|string): void
2312
2106
  /**
@@ -2314,36 +2108,30 @@ const emit = defineEmits<{
2314
2108
  * if you want to implement your own behavior.
2315
2109
  * @param {string} e Event name
2316
2110
  * @param {object} params Event parameters
2317
- * @param {string} params.e Event name
2318
- * @param {object} params.params Event parameters
2319
- * @param {object} params.params.event Event object
2320
- * @param {Grid.view.Grid} params.params.event.source The Grid instance.
2321
- * @param {Grid.view.SubGrid} params.params.event.subGrid The subgrid
2322
- * @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
2323
2115
  */
2324
- (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
2325
2117
  /**
2326
2118
  * Fired by the Grid after a sub-grid has been resized using the splitter
2327
2119
  * @param {string} e Event name
2328
2120
  * @param {object} params Event parameters
2329
- * @param {string} params.e Event name
2330
- * @param {object} params.params Event parameters
2331
- * @param {object} params.params.event Event object
2332
- * @param {Grid.view.Grid} params.params.event.source The Grid instance.
2333
- * @param {Grid.view.SubGrid} params.params.event.subGrid The resized subgrid
2334
- * @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
2335
2125
  */
2336
2126
  (e: 'splitterDragEnd', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => void)|string): void
2337
2127
  /**
2338
2128
  * Fired by the Grid when a sub-grid resize gesture starts
2339
2129
  * @param {string} e Event name
2340
2130
  * @param {object} params Event parameters
2341
- * @param {string} params.e Event name
2342
- * @param {object} params.params Event parameters
2343
- * @param {object} params.params.event Event object
2344
- * @param {Grid.view.Grid} params.params.event.source The Grid instance.
2345
- * @param {Grid.view.SubGrid} params.params.event.subGrid The subgrid about to be resized
2346
- * @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
2347
2135
  */
2348
2136
  (e: 'splitterDragStart', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => void)|string): void
2349
2137
  /**
@@ -2351,113 +2139,93 @@ const emit = defineEmits<{
2351
2139
  * if you want to implement your own behavior.
2352
2140
  * @param {string} e Event name
2353
2141
  * @param {object} params Event parameters
2354
- * @param {string} params.e Event name
2355
- * @param {object} params.params Event parameters
2356
- * @param {object} params.params.event Event object
2357
- * @param {Grid.view.Grid} params.params.event.source The Grid instance.
2358
- * @param {Grid.view.SubGrid} params.params.event.subGrid The subgrid
2359
- * @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
2360
2146
  */
2361
- (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
2362
2148
  /**
2363
2149
  * Fires on the owning Grid when editing starts
2364
2150
  * @param {string} e Event name
2365
2151
  * @param {object} params Event parameters
2366
- * @param {string} params.e Event name
2367
- * @param {object} params.params Event parameters
2368
- * @param {object} params.params.event Event object
2369
- * @param {Grid.view.Grid} params.params.event.source Owner grid
2370
- * @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
2371
2155
  */
2372
2156
  (e: 'startCellEdit', params: ((event: { source: Grid, editorContext: CellEditorContext }) => void)|string): void
2373
2157
  /**
2374
2158
  * Fires on the owning Grid when editing starts
2375
2159
  * @param {string} e Event name
2376
2160
  * @param {object} params Event parameters
2377
- * @param {string} params.e Event name
2378
- * @param {object} params.params Event parameters
2379
- * @param {object} params.params.event Event object
2380
- * @param {Grid.view.Grid} params.params.event.source Owner grid
2381
- * @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
2382
2164
  */
2383
2165
  (e: 'startRowEdit', params: ((event: { source: Grid, editorContext: RowEditorContext }) => void)|string): void
2384
2166
  /**
2385
2167
  * Fires after a sub grid is collapsed.
2386
2168
  * @param {string} e Event name
2387
2169
  * @param {object} params Event parameters
2388
- * @param {string} params.e Event name
2389
- * @param {object} params.params Event parameters
2390
- * @param {object} params.params.event Event object
2391
- * @param {Grid.view.GridBase} params.params.event.source The firing Grid instance
2392
- * @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
2393
2173
  */
2394
2174
  (e: 'subGridCollapse', params: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string): void
2395
2175
  /**
2396
2176
  * Fires after a sub grid is expanded.
2397
2177
  * @param {string} e Event name
2398
2178
  * @param {object} params Event parameters
2399
- * @param {string} params.e Event name
2400
- * @param {object} params.params Event parameters
2401
- * @param {object} params.params.event Event object
2402
- * @param {Grid.view.GridBase} params.params.event.source The firing Grid instance
2403
- * @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
2404
2182
  */
2405
2183
  (e: 'subGridExpand', params: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string): void
2406
2184
  /**
2407
2185
  * Fired when one or more groups are expanded or collapsed
2408
2186
  * @param {string} e Event name
2409
2187
  * @param {object} params Event parameters
2410
- * @param {string} params.e Event name
2411
- * @param {object} params.params Event parameters
2412
- * @param {object} params.params.event Event object
2413
- * @param {Core.data.Model} params.params.event.groupRecord [DEPRECATED] Use `groupRecords` param instead
2414
- * @param {Core.data.Model[]} params.params.event.groupRecords The group records being toggled
2415
- * @param {boolean} params.params.event.collapse Collapsed (true) or expanded (false)
2416
- * @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
2417
2193
  */
2418
2194
  (e: 'toggleGroup', params: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, allRecords?: boolean }) => void)|string): void
2419
2195
  /**
2420
2196
  * Fired after a parent node record toggles its collapsed state.
2421
2197
  * @param {string} e Event name
2422
2198
  * @param {object} params Event parameters
2423
- * @param {string} params.e Event name
2424
- * @param {object} params.params Event parameters
2425
- * @param {object} params.params.event Event object
2426
- * @param {Core.data.Model} params.params.event.record The record being toggled.
2427
- * @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.
2428
2202
  */
2429
2203
  (e: 'toggleNode', params: ((event: { record: Model, collapse: boolean }) => void)|string): void
2430
2204
  /**
2431
2205
  * A header [tool](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-tools) has been clicked.
2432
2206
  * @param {string} e Event name
2433
2207
  * @param {object} params Event parameters
2434
- * @param {string} params.e Event name
2435
- * @param {object} params.params Event parameters
2436
- * @param {object} params.params.event Event object
2437
- * @param {Core.widget.Tool} params.params.event.source This Panel.
2438
- * @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.
2439
2211
  */
2440
2212
  (e: 'toolClick', params: ((event: { source: Tool, tool: Tool }) => void)|string): void
2441
2213
  /**
2442
2214
  * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
2443
2215
  * @param {string} e Event name
2444
2216
  * @param {object} params Event parameters
2445
- * @param {string} params.e Event name
2446
- * @param {object} params.params Event parameters
2447
- * @param {object} params.params.event Event object
2448
- * @param {Grid.view.Grid} params.params.event.source The grid instance
2449
- * @param {(string|Function)[]} params.params.event.groupers Array of field names or functions representing the current grouping levels
2450
- * @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
2451
2221
  */
2452
2222
  (e: 'treeGroup', params: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string): void
2453
2223
  /**
2454
2224
  * Fires when row locking is disabled.
2455
2225
  * @param {string} e Event name
2456
2226
  * @param {object} params Event parameters
2457
- * @param {string} params.e Event name
2458
- * @param {object} params.params Event parameters
2459
- * @param {object} params.params.event Event object
2460
- * @param {Grid.view.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
2461
2229
  */
2462
2230
  (e: 'unlockRows', params: ((event: { clone: GridBase }) => void)|string): void
2463
2231
  /**