@bryntum/schedulerpro-vue-3-thin 7.3.0 → 7.3.2

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