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