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