@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
@@ -91,6 +91,8 @@ defineProps<{
91
91
  /**
92
92
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
93
93
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#property-element).
94
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
95
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceHistogram#config-appendTo)
94
96
  */
95
97
  appendTo ? : HTMLElement|string
96
98
  /**
@@ -667,10 +669,14 @@ defineProps<{
667
669
  inputFieldAlign ? : 'start'|'end'
668
670
  /**
669
671
  * 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.
672
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
673
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceHistogram#config-insertBefore)
670
674
  */
671
675
  insertBefore ? : HTMLElement|string
672
676
  /**
673
677
  * 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.
678
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
679
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceHistogram#config-insertFirst)
674
680
  */
675
681
  insertFirst ? : HTMLElement|string
676
682
  /**
@@ -838,7 +844,12 @@ defineProps<{
838
844
  * Can be omitted in favor of individual store configs or [crudManager](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/mixin/SchedulerStores#config-crudManager) config.
839
845
  * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceHistogram#config-project)
840
846
  */
841
- project ? : ProjectModel|ProjectModelConfig|object
847
+ project ? : ProjectModel|ProjectModelConfig|object|null
848
+ /**
849
+ * The project model class to use when creating the project instance. Override this to use a custom project
850
+ * model class. In SchedulerPro and Gantt, this is overridden to use their respective project model classes.
851
+ */
852
+ projectModelClass ? : typeof ProjectModel
842
853
  /**
843
854
  * Set to `true` to make the grid read-only, by disabling any UIs for modifying data.
844
855
  * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceHistogram#config-readOnly)
@@ -1632,162 +1643,136 @@ const emit = defineEmits<{
1632
1643
  * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceHistogram#event-beforeAssignmentDelete)
1633
1644
  * @param {string} e Event name
1634
1645
  * @param {object} params Event parameters
1635
- * @param {string} params.e Event name
1636
- * @param {object} params.params Event parameters
1637
- * @param {object} params.params.event Event object
1638
- * @param {Scheduler.view.Scheduler} params.params.event.source The Scheduler instance
1639
- * @param {Scheduler.model.SchedulerAssignmentModel[]} params.params.event.assignmentRecords The assignment records about to be deleted
1640
- * @param {object} params.params.event.context Additional removal context. This allows you to process the deletion by calling `context.finalize()` if you return `false` from the event handler.
1641
- * @param {Function} params.params.event.context.finalize Function to call to finalize the removal. Used to asynchronously decide to remove the records or not. Provide `false` to the function to prevent the removal.
1642
- * @param {boolean} [params.params.event.context.finalize.removeRecords] Provide `false` to the function to prevent the removal.
1646
+ * @param {object} params.event Event object
1647
+ * @param {Scheduler.view.Scheduler} params.event.source The Scheduler instance
1648
+ * @param {Scheduler.model.SchedulerAssignmentModel[]} params.event.assignmentRecords The assignment records about to be deleted
1649
+ * @param {object} params.event.context Additional removal context. This allows you to process the deletion by calling `context.finalize()` if you return `false` from the event handler.
1650
+ * @param {Function} params.event.context.finalize Function to call to finalize the removal. Used to asynchronously decide to remove the records or not. Provide `false` to the function to prevent the removal.
1651
+ * @param {boolean} [params.event.context.finalize.removeRecords] Provide `false` to the function to prevent the removal.
1643
1652
  */
1644
1653
  (e: 'beforeAssignmentDelete', params: ((event: { source: Scheduler, assignmentRecords: SchedulerAssignmentModel[], context: { finalize: { removeRecords?: boolean } } }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1645
1654
  /**
1646
1655
  * Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
1647
1656
  * @param {string} e Event name
1648
1657
  * @param {object} params Event parameters
1649
- * @param {string} params.e Event name
1650
- * @param {object} params.params Event parameters
1651
- * @param {object} params.params.event Event object
1652
- * @param {Grid.view.Grid} params.params.event.source Owner grid
1653
- * @param {Grid.util.GridLocation} params.params.event.editorContext Editing context
1658
+ * @param {object} params.event Event object
1659
+ * @param {Grid.view.Grid} params.event.source Owner grid
1660
+ * @param {Grid.util.GridLocation} params.event.editorContext Editing context
1654
1661
  */
1655
- (e: 'beforeCancelCellEdit', params: ((event: { source: Grid, editorContext: GridLocation }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1662
+ (e: 'beforeCancelCellEdit', params: ((event: { source: Grid, editorContext: GridLocation }) => boolean|void)|string): boolean|void
1656
1663
  /**
1657
1664
  * 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.
1658
1665
  * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceHistogram#event-beforeCancelRowEdit)
1659
1666
  * @param {string} e Event name
1660
1667
  * @param {object} params Event parameters
1661
- * @param {string} params.e Event name
1662
- * @param {object} params.params Event parameters
1663
- * @param {object} params.params.event Event object
1664
- * @param {Grid.view.Grid} params.params.event.grid Target grid
1665
- * @param {RowEditorContext} params.params.event.editorContext Editing context
1668
+ * @param {object} params.event Event object
1669
+ * @param {Grid.view.Grid} params.event.grid Target grid
1670
+ * @param {RowEditorContext} params.event.editorContext Editing context
1666
1671
  */
1667
1672
  (e: 'beforeCancelRowEdit', params: ((event: { grid: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1668
1673
  /**
1669
1674
  * Fires on the owning Grid before editing starts, return `false` to prevent editing
1670
1675
  * @param {string} e Event name
1671
1676
  * @param {object} params Event parameters
1672
- * @param {string} params.e Event name
1673
- * @param {object} params.params Event parameters
1674
- * @param {object} params.params.event Event object
1675
- * @param {Grid.view.Grid} params.params.event.source Owner grid
1676
- * @param {CellEditorContext} params.params.event.editorContext Editing context
1677
+ * @param {object} params.event Event object
1678
+ * @param {Grid.view.Grid} params.event.source Owner grid
1679
+ * @param {CellEditorContext} params.event.editorContext Editing context
1677
1680
  */
1678
- (e: 'beforeCellEditStart', params: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1681
+ (e: 'beforeCellEditStart', params: ((event: { source: Grid, editorContext: CellEditorContext }) => boolean|void)|string): boolean|void
1679
1682
  /**
1680
1683
  * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
1681
1684
  * buttons while [autoEdit](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
1682
1685
  * @param {string} e Event name
1683
1686
  * @param {object} params Event parameters
1684
- * @param {string} params.e Event name
1685
- * @param {object} params.params Event parameters
1686
- * @param {object} params.params.event Event object
1687
- * @param {Grid.view.Grid} params.params.event.source Owner grid
1688
- * @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).
1687
+ * @param {object} params.event Event object
1688
+ * @param {Grid.view.Grid} params.event.source Owner grid
1689
+ * @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).
1689
1690
  */
1690
- (e: 'beforeCellRangeDelete', params: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1691
+ (e: 'beforeCellRangeDelete', params: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void)|string): boolean|void
1691
1692
  /**
1692
1693
  * Fires for each selected record on the owning Grid before editing a range of selected cell values
1693
1694
  * @param {string} e Event name
1694
1695
  * @param {object} params Event parameters
1695
- * @param {string} params.e Event name
1696
- * @param {object} params.params Event parameters
1697
- * @param {object} params.params.event Event object
1698
- * @param {Core.data.Model} params.params.event.record Current selected record from the range
1699
- * @param {string} params.params.event.field The field being changed
1700
- * @param {any} params.params.event.value The value being set
1696
+ * @param {object} params.event Event object
1697
+ * @param {Core.data.Model} params.event.record Current selected record from the range
1698
+ * @param {string} params.event.field The field being changed
1699
+ * @param {any} params.event.value The value being set
1701
1700
  */
1702
- (e: 'beforeCellRangeEdit', params: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1701
+ (e: 'beforeCellRangeEdit', params: ((event: { record: Model, field: string, value: any }) => boolean|void)|string): boolean|void
1703
1702
  /**
1704
1703
  * This event is triggered before a parent column is collapsed or expanded.
1705
1704
  * @param {string} e Event name
1706
1705
  * @param {object} params Event parameters
1707
- * @param {string} params.e Event name
1708
- * @param {object} params.params Event parameters
1709
- * @param {object} params.params.event Event object
1710
- * @param {Grid.view.GridBase} params.params.event.source The grid instance
1711
- * @param {Grid.column.Column} params.params.event.column The column
1712
- * @param {boolean} params.params.event.collapsed `true` if the column is being collapsed, `false` if expanded
1706
+ * @param {object} params.event Event object
1707
+ * @param {Grid.view.GridBase} params.event.source The grid instance
1708
+ * @param {Grid.column.Column} params.event.column The column
1709
+ * @param {boolean} params.event.collapsed `true` if the column is being collapsed, `false` if expanded
1713
1710
  */
1714
1711
  (e: 'beforeColumnCollapseToggle', params: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string): void
1715
1712
  /**
1716
1713
  * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
1717
1714
  * @param {string} e Event name
1718
1715
  * @param {object} params Event parameters
1719
- * @param {string} params.e Event name
1720
- * @param {object} params.params Event parameters
1721
- * @param {object} params.params.event Event object
1722
- * @param {Grid.view.Grid} params.params.event.source The grid instance.
1723
- * @param {Grid.column.Column} params.params.event.column The dragged column.
1724
- * @param {Event} params.params.event.event The browser event.
1716
+ * @param {object} params.event Event object
1717
+ * @param {Grid.view.Grid} params.event.source The grid instance.
1718
+ * @param {Grid.column.Column} params.event.column The dragged column.
1719
+ * @param {Event} params.event.event The browser event.
1725
1720
  */
1726
- (e: 'beforeColumnDragStart', params: ((event: { source: Grid, column: Column, event: Event }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1721
+ (e: 'beforeColumnDragStart', params: ((event: { source: Grid, column: Column, event: Event }) => boolean|void)|string): boolean|void
1727
1722
  /**
1728
1723
  * This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
1729
1724
  * @param {string} e Event name
1730
1725
  * @param {object} params Event parameters
1731
- * @param {string} params.e Event name
1732
- * @param {object} params.params Event parameters
1733
- * @param {object} params.params.event Event object
1734
- * @param {Grid.view.Grid} params.params.event.source The grid instance.
1735
- * @param {Grid.column.Column} params.params.event.column The dragged column.
1736
- * @param {Grid.column.Column} params.params.event.insertBefore The column before which the dragged column will be inserted.
1737
- * @param {Grid.column.Column} params.params.event.newParent The new parent column.
1738
- * @param {Event} params.params.event.event The browser event.
1739
- * @param {string} params.params.event.region The region where the column was dropped.
1726
+ * @param {object} params.event Event object
1727
+ * @param {Grid.view.Grid} params.event.source The grid instance.
1728
+ * @param {Grid.column.Column} params.event.column The dragged column.
1729
+ * @param {Grid.column.Column} params.event.insertBefore The column before which the dragged column will be inserted.
1730
+ * @param {Grid.column.Column} params.event.newParent The new parent column.
1731
+ * @param {Event} params.event.event The browser event.
1732
+ * @param {string} params.event.region The region where the column was dropped.
1740
1733
  */
1741
- (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
1734
+ (e: 'beforeColumnDropFinalize', params: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void)|string): boolean|void
1742
1735
  /**
1743
1736
  * This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
1744
1737
  * `false`.
1745
1738
  * @param {string} e Event name
1746
1739
  * @param {object} params Event parameters
1747
- * @param {string} params.e Event name
1748
- * @param {object} params.params Event parameters
1749
- * @param {object} params.params.event Event object
1750
- * @param {Grid.view.Grid} params.params.event.source The grid instance
1751
- * @param {Grid.column.Column} params.params.event.column The column
1752
- * @param {Event} params.params.event.domEvent The browser event
1740
+ * @param {object} params.event Event object
1741
+ * @param {Grid.view.Grid} params.event.source The grid instance
1742
+ * @param {Grid.column.Column} params.event.column The column
1743
+ * @param {Event} params.event.domEvent The browser event
1753
1744
  */
1754
- (e: 'beforeColumnResize', params: ((event: { source: Grid, column: Column, domEvent: Event }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1745
+ (e: 'beforeColumnResize', params: ((event: { source: Grid, column: Column, domEvent: Event }) => boolean|void)|string): boolean|void
1755
1746
  /**
1756
1747
  * Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
1757
1748
  * @param {string} e Event name
1758
1749
  * @param {object} params Event parameters
1759
- * @param {string} params.e Event name
1760
- * @param {object} params.params Event parameters
1761
- * @param {object} params.params.event Event object
1762
- * @param {Grid.view.Grid} params.params.event.source Owner grid
1763
- * @param {Grid.util.GridLocation[]} params.params.event.cells The cells about to be copied or cut
1764
- * @param {string} params.params.event.data The string data about to be copied or cut
1765
- * @param {boolean} params.params.event.isCut `true` if this is a cut action
1766
- * @param {string} params.params.event.entityName 'cell' to distinguish this event from other beforeCopy events
1750
+ * @param {object} params.event Event object
1751
+ * @param {Grid.view.Grid} params.event.source Owner grid
1752
+ * @param {Grid.util.GridLocation[]} params.event.cells The cells about to be copied or cut
1753
+ * @param {string} params.event.data The string data about to be copied or cut
1754
+ * @param {boolean} params.event.isCut `true` if this is a cut action
1755
+ * @param {string} params.event.entityName 'cell' to distinguish this event from other beforeCopy events
1767
1756
  */
1768
1757
  (e: 'beforeCopy', params: ((event: { source: Grid, cells: GridLocation[], data: string, isCut: boolean, entityName: string }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1769
1758
  /**
1770
1759
  * Fires on the owning Grid before CSV export starts. Return `false` to cancel the export.
1771
1760
  * @param {string} e Event name
1772
1761
  * @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 {ExportConfig} params.params.event.config Export config
1777
- * @param {Grid.column.Column[]} params.params.event.columns An array of columns to export
1778
- * @param {Core.data.Model[]} params.params.event.rows An array of records to export
1779
- * @param {string} params.params.event.lineDelimiter The CSV delimiter to separate lines
1780
- * @param {string} params.params.event.columnDelimiter The CSV delimiter to separate values on one line
1762
+ * @param {object} params.event Event object
1763
+ * @param {ExportConfig} params.event.config Export config
1764
+ * @param {Grid.column.Column[]} params.event.columns An array of columns to export
1765
+ * @param {Core.data.Model[]} params.event.rows An array of records to export
1766
+ * @param {string} params.event.lineDelimiter The CSV delimiter to separate lines
1767
+ * @param {string} params.event.columnDelimiter The CSV delimiter to separate values on one line
1781
1768
  */
1782
- (e: 'beforeCSVExport', params: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1769
+ (e: 'beforeCSVExport', params: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void)|string): boolean|void
1783
1770
  /**
1784
1771
  * Fires before an object is destroyed.
1785
1772
  * @param {string} e Event name
1786
1773
  * @param {object} params Event parameters
1787
- * @param {string} params.e Event name
1788
- * @param {object} params.params Event parameters
1789
- * @param {object} params.params.event Event object
1790
- * @param {Core.Base} params.params.event.source The Object that is being destroyed.
1774
+ * @param {object} params.event Event object
1775
+ * @param {Core.Base} params.event.source The Object that is being destroyed.
1791
1776
  */
1792
1777
  (e: 'beforeDestroy', params: ((event: { source: Base }) => void)|string): void
1793
1778
  /**
@@ -1797,48 +1782,40 @@ const emit = defineEmits<{
1797
1782
  * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceHistogram#event-beforeEventDelete)
1798
1783
  * @param {string} e Event name
1799
1784
  * @param {object} params Event parameters
1800
- * @param {string} params.e Event name
1801
- * @param {object} params.params Event parameters
1802
- * @param {object} params.params.event Event object
1803
- * @param {Scheduler.view.Scheduler,any} params.params.event.source The Scheduler instance
1804
- * @param {Scheduler.model.SchedulerEventModel[]} params.params.event.eventRecords The records about to be deleted
1805
- * @param {object} params.params.event.context Additional removal context. This allows you to process the deletion by calling `context.finalize()` if you return `false` from the event handler.
1806
- * @param {Function} params.params.event.context.finalize Function to call to finalize the removal. Used to asynchronously decide to remove the records or not. Provide `false` to the function to prevent the removal.
1807
- * @param {boolean} [params.params.event.context.finalize.removeRecords] Provide `false` to the function to prevent the removal.
1785
+ * @param {object} params.event Event object
1786
+ * @param {Scheduler.view.Scheduler,any} params.event.source The Scheduler instance
1787
+ * @param {Scheduler.model.SchedulerEventModel[]} params.event.eventRecords The records about to be deleted
1788
+ * @param {object} params.event.context Additional removal context. This allows you to process the deletion by calling `context.finalize()` if you return `false` from the event handler.
1789
+ * @param {Function} params.event.context.finalize Function to call to finalize the removal. Used to asynchronously decide to remove the records or not. Provide `false` to the function to prevent the removal.
1790
+ * @param {boolean} [params.event.context.finalize.removeRecords] Provide `false` to the function to prevent the removal.
1808
1791
  */
1809
1792
  (e: 'beforeEventDelete', params: ((event: { source: Scheduler|any, eventRecords: SchedulerEventModel[], context: { finalize: { removeRecords?: boolean } } }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1810
1793
  /**
1811
1794
  * Fires on the owning Grid before Excel export starts. Return `false` to cancel the export.
1812
1795
  * @param {string} e Event name
1813
1796
  * @param {object} params Event parameters
1814
- * @param {string} params.e Event name
1815
- * @param {object} params.params Event parameters
1816
- * @param {object} params.params.event Event object
1817
- * @param {ExportConfig} params.params.event.config Export config
1818
- * @param {XLSColumn[]} params.params.event.columns An array of columns to export
1819
- * @param {any[][]} params.params.event.rows An array of records to export
1797
+ * @param {object} params.event Event object
1798
+ * @param {ExportConfig} params.event.config Export config
1799
+ * @param {XLSColumn[]} params.event.columns An array of columns to export
1800
+ * @param {any[][]} params.event.rows An array of records to export
1820
1801
  */
1821
- (e: 'beforeExcelExport', params: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1802
+ (e: 'beforeExcelExport', params: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void)|string): boolean|void
1822
1803
  /**
1823
1804
  * Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
1824
1805
  * @param {string} e Event name
1825
1806
  * @param {object} params Event parameters
1826
- * @param {string} params.e Event name
1827
- * @param {object} params.params Event parameters
1828
- * @param {object} params.params.event Event object
1829
- * @param {Grid.util.GridLocation} params.params.event.cell Information about the column / record
1830
- * @param {MouseEvent} params.params.event.domEvent The raw DOM event
1807
+ * @param {object} params.event Event object
1808
+ * @param {Grid.util.GridLocation} params.event.cell Information about the column / record
1809
+ * @param {MouseEvent} params.event.domEvent The raw DOM event
1831
1810
  */
1832
- (e: 'beforeFillHandleDragStart', params: ((event: { cell: GridLocation, domEvent: MouseEvent }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1811
+ (e: 'beforeFillHandleDragStart', params: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string): boolean|void
1833
1812
  /**
1834
1813
  * 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.
1835
1814
  * @param {string} e Event name
1836
1815
  * @param {object} params Event parameters
1837
- * @param {string} params.e Event name
1838
- * @param {object} params.params Event parameters
1839
- * @param {object} params.params.event Event object
1840
- * @param {Grid.view.Grid} params.params.event.grid Target grid
1841
- * @param {CellEditorContext} params.params.event.editorContext Editing context
1816
+ * @param {object} params.event Event object
1817
+ * @param {Grid.view.Grid} params.event.grid Target grid
1818
+ * @param {CellEditorContext} params.event.editorContext Editing context
1842
1819
  */
1843
1820
  (e: 'beforeFinishCellEdit', params: ((event: { grid: Grid, editorContext: CellEditorContext }) => void)|string): void
1844
1821
  /**
@@ -1846,132 +1823,110 @@ const emit = defineEmits<{
1846
1823
  * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceHistogram#event-beforeFinishRowEdit)
1847
1824
  * @param {string} e Event name
1848
1825
  * @param {object} params Event parameters
1849
- * @param {string} params.e Event name
1850
- * @param {object} params.params Event parameters
1851
- * @param {object} params.params.event Event object
1852
- * @param {Grid.view.Grid} params.params.event.grid Target grid
1853
- * @param {RowEditorContext} params.params.event.editorContext Editing context
1826
+ * @param {object} params.event Event object
1827
+ * @param {Grid.view.Grid} params.event.grid Target grid
1828
+ * @param {RowEditorContext} params.event.editorContext Editing context
1854
1829
  */
1855
1830
  (e: 'beforeFinishRowEdit', params: ((event: { grid: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1856
1831
  /**
1857
1832
  * Triggered before a widget is hidden. Return `false` to prevent the action.
1858
1833
  * @param {string} e Event name
1859
1834
  * @param {object} params Event parameters
1860
- * @param {string} params.e Event name
1861
- * @param {object} params.params Event parameters
1862
- * @param {object} params.params.event Event object
1863
- * @param {Core.widget.Widget} params.params.event.source The widget being hidden.
1835
+ * @param {object} params.event Event object
1836
+ * @param {Core.widget.Widget} params.event.source The widget being hidden.
1864
1837
  */
1865
- (e: 'beforeHide', params: ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1838
+ (e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
1866
1839
  /**
1867
1840
  * Fires before the component stores a record's histogram data into the cache.
1868
1841
  * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceHistogram#event-beforeHistogramDataCacheSet)
1869
1842
  * @param {string} e Event name
1870
1843
  * @param {object} params Event parameters
1871
- * @param {string} params.e Event name
1872
- * @param {object} params.params Event parameters
1873
- * @param {object} params.params.event Event object
1874
- * @param {Scheduler.view.TimelineHistogram} params.params.event.source The component instance
1875
- * @param {Core.data.Model} params.params.event.record Record the histogram data of which is ready.
1876
- * @param {object} params.params.event.data The record histogram data.
1844
+ * @param {object} params.event Event object
1845
+ * @param {Scheduler.view.TimelineHistogram} params.event.source The component instance
1846
+ * @param {Core.data.Model} params.event.record Record the histogram data of which is ready.
1847
+ * @param {object} params.event.data The record histogram data.
1877
1848
  */
1878
1849
  (e: 'beforeHistogramDataCacheSet', params: ((event: { source: TimelineHistogram, record: Model, data: object }) => void)|string): void
1879
1850
  /**
1880
1851
  * Fires on the owning Scheduler or Gantt widget before pan starts. Return `false` to prevent the operation.
1881
1852
  * @param {string} e Event name
1882
1853
  * @param {object} params Event parameters
1883
- * @param {string} params.e Event name
1884
- * @param {object} params.params Event parameters
1885
- * @param {object} params.params.event Event object
1886
- * @param {Event} params.params.event.event The native browser DOM event
1854
+ * @param {object} params.event Event object
1855
+ * @param {Event} params.event.event The native browser DOM event
1887
1856
  */
1888
- (e: 'beforePan', params: ((event: { event: Event }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1857
+ (e: 'beforePan', params: ((event: { event: Event }) => boolean|void)|string): boolean|void
1889
1858
  /**
1890
1859
  * Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
1891
1860
  * @param {string} e Event name
1892
1861
  * @param {object} params Event parameters
1893
- * @param {string} params.e Event name
1894
- * @param {object} params.params Event parameters
1895
- * @param {object} params.params.event Event object
1896
- * @param {Grid.view.Grid} params.params.event.source Owner grid
1897
- * @param {string} params.params.event.clipboardData The clipboardData about to be pasted
1898
- * @param {Grid.util.GridLocation} params.params.event.targetCell The cell from which the paste will be started
1899
- * @param {string} params.params.event.entityName 'cell' to distinguish this event from other beforePaste events
1900
- * @param {string} params.params.event.text The raw text from clipboard
1862
+ * @param {object} params.event Event object
1863
+ * @param {Grid.view.Grid} params.event.source Owner grid
1864
+ * @param {string} params.event.clipboardData The clipboardData about to be pasted
1865
+ * @param {Grid.util.GridLocation} params.event.targetCell The cell from which the paste will be started
1866
+ * @param {string} params.event.entityName 'cell' to distinguish this event from other beforePaste events
1867
+ * @param {string} params.event.text The raw text from clipboard
1901
1868
  */
1902
1869
  (e: 'beforePaste', params: ((event: { source: Grid, clipboardData: string, targetCell: GridLocation, entityName: string, text: string }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1903
1870
  /**
1904
1871
  * Fires on the owning Grid before export started. Return `false` to cancel the export.
1905
1872
  * @param {string} e Event name
1906
1873
  * @param {object} params Event parameters
1907
- * @param {string} params.e Event name
1908
- * @param {object} params.params Event parameters
1909
- * @param {object} params.params.event Event object
1910
- * @param {PdfExportConfig} params.params.event.config Export config
1874
+ * @param {object} params.event Event object
1875
+ * @param {PdfExportConfig} params.event.config Export config
1911
1876
  */
1912
- (e: 'beforePdfExport', params: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1877
+ (e: 'beforePdfExport', params: ((event: { config: PdfExportConfig }) => boolean|void)|string): boolean|void
1913
1878
  /**
1914
1879
  * Fired before the [viewPreset](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/mixin/TimelineViewPresets#config-viewPreset) is changed.
1915
1880
  * @param {string} e Event name
1916
1881
  * @param {object} params Event parameters
1917
- * @param {string} params.e Event name
1918
- * @param {object} params.params Event parameters
1919
- * @param {object} params.params.event Event object
1920
- * @param {Scheduler.view.Scheduler} params.params.event.source This Scheduler instance.
1921
- * @param {Date} params.params.event.startDate The new start date of the timeline.
1922
- * @param {Date} params.params.event.endDate The new end date of the timeline.
1923
- * @param {Scheduler.preset.ViewPreset} params.params.event.from The outgoing ViewPreset.
1924
- * @param {Scheduler.preset.ViewPreset} params.params.event.to The ViewPreset being switched to.
1882
+ * @param {object} params.event Event object
1883
+ * @param {Scheduler.view.Scheduler} params.event.source This Scheduler instance.
1884
+ * @param {Date} params.event.startDate The new start date of the timeline.
1885
+ * @param {Date} params.event.endDate The new end date of the timeline.
1886
+ * @param {Scheduler.preset.ViewPreset} params.event.from The outgoing ViewPreset.
1887
+ * @param {Scheduler.preset.ViewPreset} params.event.to The ViewPreset being switched to.
1925
1888
  */
1926
- (e: 'beforePresetChange', params: ((event: { source: Scheduler, startDate: Date, endDate: Date, from: ViewPreset, to: ViewPreset }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1889
+ (e: 'beforePresetChange', params: ((event: { source: Scheduler, startDate: Date, endDate: Date, from: ViewPreset, to: ViewPreset }) => boolean|void)|string): boolean|void
1927
1890
  /**
1928
1891
  * Fires before the component renders a row.
1929
1892
  * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceHistogram#event-beforeRenderHistogramRow)
1930
1893
  * @param {string} e Event name
1931
1894
  * @param {object} params Event parameters
1932
- * @param {string} params.e Event name
1933
- * @param {object} params.params Event parameters
1934
- * @param {object} params.params.event Event object
1935
- * @param {Scheduler.view.TimelineHistogram} params.params.event.source The component instance
1936
- * @param {Core.data.Model} params.params.event.record Record the histogram data of which is ready.
1937
- * @param {HistogramConfig} params.params.event.histogramConfig Configuration object that will be applied to `histogramWidget`.
1938
- * @param {Core.widget.graph.Histogram} params.params.event.histogramWidget The underlying widget that is used to render a chart.
1895
+ * @param {object} params.event Event object
1896
+ * @param {Scheduler.view.TimelineHistogram} params.event.source The component instance
1897
+ * @param {Core.data.Model} params.event.record Record the histogram data of which is ready.
1898
+ * @param {HistogramConfig} params.event.histogramConfig Configuration object that will be applied to `histogramWidget`.
1899
+ * @param {Core.widget.graph.Histogram} params.event.histogramWidget The underlying widget that is used to render a chart.
1939
1900
  */
1940
1901
  (e: 'beforeRenderHistogramRow', params: ((event: { source: TimelineHistogram, record: Model, histogramConfig: HistogramConfig, histogramWidget: Histogram }) => void)|string): void
1941
1902
  /**
1942
1903
  * Fires before the component renders a histogram in a cell.
1943
1904
  * @param {string} e Event name
1944
1905
  * @param {object} params Event parameters
1945
- * @param {string} params.e Event name
1946
- * @param {object} params.params Event parameters
1947
- * @param {object} params.params.event Event object
1948
- * @param {Scheduler.view.TimelineHistogram} params.params.event.source The component instance
1949
- * @param {Core.data.Model} params.params.event.record Record the histogram data of which is ready.
1950
- * @param {HistogramConfig} params.params.event.histogramConfig Configuration object that will be applied to `histogramWidget`.
1951
- * @param {Core.widget.graph.Histogram} params.params.event.histogramWidget The underlying widget that is used to render a chart.
1906
+ * @param {object} params.event Event object
1907
+ * @param {Scheduler.view.TimelineHistogram} params.event.source The component instance
1908
+ * @param {Core.data.Model} params.event.record Record the histogram data of which is ready.
1909
+ * @param {HistogramConfig} params.event.histogramConfig Configuration object that will be applied to `histogramWidget`.
1910
+ * @param {Core.widget.graph.Histogram} params.event.histogramWidget The underlying widget that is used to render a chart.
1952
1911
  */
1953
1912
  (e: 'beforeRenderRecordHistogram', params: ((event: { source: TimelineHistogram, record: Model, histogramConfig: HistogramConfig, histogramWidget: Histogram }) => void)|string): void
1954
1913
  /**
1955
1914
  * Fires before a row is rendered.
1956
1915
  * @param {string} e Event name
1957
1916
  * @param {object} params Event parameters
1958
- * @param {string} params.e Event name
1959
- * @param {object} params.params Event parameters
1960
- * @param {object} params.params.event Event object
1961
- * @param {Grid.view.GridBase} params.params.event.source The firing Grid instance
1962
- * @param {Grid.row.Row} params.params.event.row The row about to be rendered
1963
- * @param {Core.data.Model} params.params.event.record The record for the row
1964
- * @param {number} params.params.event.recordIndex The zero-based index of the record
1917
+ * @param {object} params.event Event object
1918
+ * @param {Grid.view.GridBase} params.event.source The firing Grid instance
1919
+ * @param {Grid.row.Row} params.event.row The row about to be rendered
1920
+ * @param {Core.data.Model} params.event.record The record for the row
1921
+ * @param {number} params.event.recordIndex The zero-based index of the record
1965
1922
  */
1966
1923
  (e: 'beforeRenderRow', params: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string): void
1967
1924
  /**
1968
1925
  * Grid rows are about to be rendered
1969
1926
  * @param {string} e Event name
1970
1927
  * @param {object} params Event parameters
1971
- * @param {string} params.e Event name
1972
- * @param {object} params.params Event parameters
1973
- * @param {object} params.params.event Event object
1974
- * @param {Grid.view.GridBase} params.params.event.source This grid.
1928
+ * @param {object} params.event Event object
1929
+ * @param {Grid.view.GridBase} params.event.source This grid.
1975
1930
  */
1976
1931
  (e: 'beforeRenderRows', params: ((event: { source: GridBase }) => void)|string): void
1977
1932
  /**
@@ -1979,10 +1934,8 @@ const emit = defineEmits<{
1979
1934
  * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceHistogram#event-beforeRowCollapse)
1980
1935
  * @param {string} e Event name
1981
1936
  * @param {object} params Event parameters
1982
- * @param {string} params.e Event name
1983
- * @param {object} params.params Event parameters
1984
- * @param {object} params.params.event Event object
1985
- * @param {Core.data.Model} params.params.event.record Record
1937
+ * @param {object} params.event Event object
1938
+ * @param {Core.data.Model} params.event.record Record
1986
1939
  */
1987
1940
  (e: 'beforeRowCollapse', params: ((event: { record: Model }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1988
1941
  /**
@@ -1990,119 +1943,99 @@ const emit = defineEmits<{
1990
1943
  * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceHistogram#event-beforeRowExpand)
1991
1944
  * @param {string} e Event name
1992
1945
  * @param {object} params Event parameters
1993
- * @param {string} params.e Event name
1994
- * @param {object} params.params Event parameters
1995
- * @param {object} params.params.event Event object
1996
- * @param {Core.data.Model} params.params.event.record Record
1946
+ * @param {object} params.event Event object
1947
+ * @param {Core.data.Model} params.event.record Record
1997
1948
  */
1998
1949
  (e: 'beforeRowExpand', params: ((event: { record: Model }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1999
1950
  /**
2000
1951
  * Fires before the selection changes. Returning `false` from a listener prevents the change
2001
1952
  * @param {string} e Event name
2002
1953
  * @param {object} params Event parameters
2003
- * @param {string} params.e Event name
2004
- * @param {object} params.params Event parameters
2005
- * @param {object} params.params.event Event object
2006
- * @param {string} params.params.event.action `'select'`/`'deselect'`
2007
- * @param {'row','cell'} params.params.event.mode `'row'`/`'cell'`
2008
- * @param {Grid.view.Grid} params.params.event.source
2009
- * @param {Core.data.Model[]} params.params.event.deselected The records to be deselected in this operation.
2010
- * @param {Core.data.Model[]} params.params.event.selected The records to be selected in this operation.
2011
- * @param {Core.data.Model[]} params.params.event.selection The records in the current selection, before applying `selected` and `deselected`
2012
- * @param {Grid.util.GridLocation[]} params.params.event.deselectedCells The cells to be deselected in this operation.
2013
- * @param {Grid.util.GridLocation[]} params.params.event.selectedCells The cells to be selected in this operation.
2014
- * @param {Grid.util.GridLocation[]} params.params.event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
1954
+ * @param {object} params.event Event object
1955
+ * @param {string} params.event.action `'select'`/`'deselect'`
1956
+ * @param {'row','cell'} params.event.mode `'row'`/`'cell'`
1957
+ * @param {Grid.view.Grid} params.event.source
1958
+ * @param {Core.data.Model[]} params.event.deselected The records to be deselected in this operation.
1959
+ * @param {Core.data.Model[]} params.event.selected The records to be selected in this operation.
1960
+ * @param {Core.data.Model[]} params.event.selection The records in the current selection, before applying `selected` and `deselected`
1961
+ * @param {Grid.util.GridLocation[]} params.event.deselectedCells The cells to be deselected in this operation.
1962
+ * @param {Grid.util.GridLocation[]} params.event.selectedCells The cells to be selected in this operation.
1963
+ * @param {Grid.util.GridLocation[]} params.event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
2015
1964
  */
2016
- (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
1965
+ (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
2017
1966
  /**
2018
1967
  * Fired before this container will load record values into its child fields. This is useful if you
2019
1968
  * want to modify the UI before data is loaded (e.g. set some input field to be readonly)
2020
1969
  * @param {string} e Event name
2021
1970
  * @param {object} params Event parameters
2022
- * @param {string} params.e Event name
2023
- * @param {object} params.params Event parameters
2024
- * @param {object} params.params.event Event object
2025
- * @param {Core.widget.Container} params.params.event.source The container
2026
- * @param {Core.data.Model} params.params.event.record The record
1971
+ * @param {object} params.event Event object
1972
+ * @param {Core.widget.Container} params.event.source The container
1973
+ * @param {Core.data.Model} params.event.record The record
2027
1974
  */
2028
1975
  (e: 'beforeSetRecord', params: ((event: { source: Container, record: Model }) => void)|string): void
2029
1976
  /**
2030
1977
  * Triggered before a widget is shown. Return `false` to prevent the action.
2031
1978
  * @param {string} e Event name
2032
1979
  * @param {object} params Event parameters
2033
- * @param {string} params.e Event name
2034
- * @param {object} params.params Event parameters
2035
- * @param {object} params.params.event Event object
2036
- * @param {Core.widget.Widget,any} params.params.event.source The widget being shown
1980
+ * @param {object} params.event Event object
1981
+ * @param {Core.widget.Widget,any} params.event.source The widget being shown
2037
1982
  */
2038
1983
  (e: 'beforeShow', params: ((event: { source: Widget|any }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
2039
1984
  /**
2040
1985
  * Fires on the owning Grid before editing starts, return `false` to prevent editing
2041
1986
  * @param {string} e Event name
2042
1987
  * @param {object} params Event parameters
2043
- * @param {string} params.e Event name
2044
- * @param {object} params.params Event parameters
2045
- * @param {object} params.params.event Event object
2046
- * @param {Grid.view.Grid} params.params.event.source Owner grid
2047
- * @param {RowEditorContext} params.params.event.editorContext Editing context
1988
+ * @param {object} params.event Event object
1989
+ * @param {Grid.view.Grid} params.event.source Owner grid
1990
+ * @param {RowEditorContext} params.event.editorContext Editing context
2048
1991
  */
2049
- (e: 'beforeStartRowEdit', params: ((event: { source: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1992
+ (e: 'beforeStartRowEdit', params: ((event: { source: Grid, editorContext: RowEditorContext }) => boolean|void)|string): boolean|void
2050
1993
  /**
2051
1994
  * Fired before state is applied to the source. Allows editing the state object or preventing the operation.
2052
1995
  * @param {string} e Event name
2053
1996
  * @param {object} params Event parameters
2054
- * @param {string} params.e Event name
2055
- * @param {object} params.params Event parameters
2056
- * @param {object} params.params.event Event object
2057
- * @param {GridStateInfo} params.params.event.state State object config
1997
+ * @param {object} params.event Event object
1998
+ * @param {GridStateInfo} params.event.state State object config
2058
1999
  */
2059
- (e: 'beforeStateApply', params: ((event: { state: GridStateInfo }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
2000
+ (e: 'beforeStateApply', params: ((event: { state: GridStateInfo }) => boolean|void)|string): boolean|void
2060
2001
  /**
2061
2002
  * Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
2062
2003
  * @param {string} e Event name
2063
2004
  * @param {object} params Event parameters
2064
- * @param {string} params.e Event name
2065
- * @param {object} params.params Event parameters
2066
- * @param {object} params.params.event Event object
2067
- * @param {GridStateInfo} params.params.event.state State object config
2005
+ * @param {object} params.event Event object
2006
+ * @param {GridStateInfo} params.event.state State object config
2068
2007
  */
2069
- (e: 'beforeStateSave', params: ((event: { state: GridStateInfo }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
2008
+ (e: 'beforeStateSave', params: ((event: { state: GridStateInfo }) => boolean|void)|string): boolean|void
2070
2009
  /**
2071
2010
  * Fired when a group is going to be expanded or collapsed using the UI.
2072
2011
  * Returning `false` from a listener prevents the operation
2073
2012
  * @param {string} e Event name
2074
2013
  * @param {object} params Event parameters
2075
- * @param {string} params.e Event name
2076
- * @param {object} params.params Event parameters
2077
- * @param {object} params.params.event Event object
2078
- * @param {Core.data.Model} params.params.event.groupRecord [DEPRECATED] Use `groupRecords` param instead
2079
- * @param {Core.data.Model[]} params.params.event.groupRecords The group records being toggled
2080
- * @param {boolean} params.params.event.collapse Collapsed (true) or expanded (false)
2081
- * @param {Event} params.params.event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
2014
+ * @param {object} params.event Event object
2015
+ * @param {Core.data.Model} params.event.groupRecord [DEPRECATED] Use `groupRecords` param instead
2016
+ * @param {Core.data.Model[]} params.event.groupRecords The group records being toggled
2017
+ * @param {boolean} params.event.collapse Collapsed (true) or expanded (false)
2018
+ * @param {Event} params.event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
2082
2019
  */
2083
- (e: 'beforeToggleGroup', params: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
2020
+ (e: 'beforeToggleGroup', params: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void)|string): boolean|void
2084
2021
  /**
2085
2022
  * Fired before a parent node record toggles its collapsed state.
2086
2023
  * @param {string} e Event name
2087
2024
  * @param {object} params Event parameters
2088
- * @param {string} params.e Event name
2089
- * @param {object} params.params Event parameters
2090
- * @param {object} params.params.event Event object
2091
- * @param {Grid.view.Grid} params.params.event.source The firing Grid instance.
2092
- * @param {Core.data.Model} params.params.event.record The record being toggled.
2093
- * @param {boolean} params.params.event.collapse `true` if the node is being collapsed.
2025
+ * @param {object} params.event Event object
2026
+ * @param {Grid.view.Grid} params.event.source The firing Grid instance.
2027
+ * @param {Core.data.Model} params.event.record The record being toggled.
2028
+ * @param {boolean} params.event.collapse `true` if the node is being collapsed.
2094
2029
  */
2095
2030
  (e: 'beforeToggleNode', params: ((event: { source: Grid, record: Model, collapse: boolean }) => void)|string): void
2096
2031
  /**
2097
2032
  * Fires on the owning Grid when editing is cancelled
2098
2033
  * @param {string} e Event name
2099
2034
  * @param {object} params Event parameters
2100
- * @param {string} params.e Event name
2101
- * @param {object} params.params Event parameters
2102
- * @param {object} params.params.event Event object
2103
- * @param {Grid.view.Grid} params.params.event.source Owner grid
2104
- * @param {Grid.util.GridLocation} params.params.event.editorContext Editing context
2105
- * @param {Event} params.params.event.event Included if the cancellation was triggered by a DOM event
2035
+ * @param {object} params.event Event object
2036
+ * @param {Grid.view.Grid} params.event.source Owner grid
2037
+ * @param {Grid.util.GridLocation} params.event.editorContext Editing context
2038
+ * @param {Event} params.event.event Included if the cancellation was triggered by a DOM event
2106
2039
  */
2107
2040
  (e: 'cancelCellEdit', params: ((event: { source: Grid, editorContext: GridLocation, event: Event }) => void)|string): void
2108
2041
  /**
@@ -2110,56 +2043,48 @@ const emit = defineEmits<{
2110
2043
  * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceHistogram#event-catchAll)
2111
2044
  * @param {string} e Event name
2112
2045
  * @param {object} params Event parameters
2113
- * @param {string} params.e Event name
2114
- * @param {object} params.params Event parameters
2115
- * @param {object} params.params.event Event object
2116
- * @param {{[key: string]: any, type: string}} params.params.event.event The Object that contains event details
2117
- * @param {string} params.params.event.event.type The type of the event which is caught by the listener
2046
+ * @param {object} params.event Event object
2047
+ * @param {{[key: string]: any, type: string}} params.event.event The Object that contains event details
2048
+ * @param {string} params.event.event.type The type of the event which is caught by the listener
2118
2049
  */
2119
2050
  (e: 'catchAll', params: ((event: {[key: string]: any, type: string}) => void)|string): void
2120
2051
  /**
2121
2052
  * Fired when user clicks in a grid cell
2122
2053
  * @param {string} e Event name
2123
2054
  * @param {object} params Event parameters
2124
- * @param {string} params.e Event name
2125
- * @param {object} params.params Event parameters
2126
- * @param {object} params.params.event Event object
2127
- * @param {Grid.view.Grid} params.params.event.grid The grid instance
2128
- * @param {Core.data.Model} params.params.event.record The record representing the row
2129
- * @param {Grid.column.Column} params.params.event.column The column to which the cell belongs
2130
- * @param {HTMLElement} params.params.event.cellElement The cell HTML element
2131
- * @param {HTMLElement} params.params.event.target The target element
2132
- * @param {MouseEvent} params.params.event.event The native DOM event
2055
+ * @param {object} params.event Event object
2056
+ * @param {Grid.view.Grid} params.event.grid The grid instance
2057
+ * @param {Core.data.Model} params.event.record The record representing the row
2058
+ * @param {Grid.column.Column} params.event.column The column to which the cell belongs
2059
+ * @param {HTMLElement} params.event.cellElement The cell HTML element
2060
+ * @param {HTMLElement} params.event.target The target element
2061
+ * @param {MouseEvent} params.event.event The native DOM event
2133
2062
  */
2134
2063
  (e: 'cellClick', params: ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string): void
2135
2064
  /**
2136
2065
  * Fired when user activates contextmenu in a grid cell
2137
2066
  * @param {string} e Event name
2138
2067
  * @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 {Grid.view.Grid} params.params.event.grid The grid instance
2143
- * @param {Core.data.Model} params.params.event.record The record representing the row
2144
- * @param {Grid.column.Column} params.params.event.column The column to which the cell belongs
2145
- * @param {HTMLElement} params.params.event.cellElement The cell HTML element
2146
- * @param {HTMLElement} params.params.event.target The target element
2147
- * @param {MouseEvent} params.params.event.event The native DOM event
2068
+ * @param {object} params.event Event object
2069
+ * @param {Grid.view.Grid} params.event.grid The grid instance
2070
+ * @param {Core.data.Model} params.event.record The record representing the row
2071
+ * @param {Grid.column.Column} params.event.column The column to which the cell belongs
2072
+ * @param {HTMLElement} params.event.cellElement The cell HTML element
2073
+ * @param {HTMLElement} params.event.target The target element
2074
+ * @param {MouseEvent} params.event.event The native DOM event
2148
2075
  */
2149
2076
  (e: 'cellContextMenu', params: ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string): void
2150
2077
  /**
2151
2078
  * Fired when user double clicks a grid cell
2152
2079
  * @param {string} e Event name
2153
2080
  * @param {object} params Event parameters
2154
- * @param {string} params.e Event name
2155
- * @param {object} params.params Event parameters
2156
- * @param {object} params.params.event Event object
2157
- * @param {Grid.view.Grid} params.params.event.grid The grid instance
2158
- * @param {Core.data.Model} params.params.event.record The record representing the row
2159
- * @param {Grid.column.Column} params.params.event.column The column to which the cell belongs
2160
- * @param {HTMLElement} params.params.event.cellElement The cell HTML element
2161
- * @param {HTMLElement} params.params.event.target The target element
2162
- * @param {MouseEvent} params.params.event.event The native DOM event
2081
+ * @param {object} params.event Event object
2082
+ * @param {Grid.view.Grid} params.event.grid The grid instance
2083
+ * @param {Core.data.Model} params.event.record The record representing the row
2084
+ * @param {Grid.column.Column} params.event.column The column to which the cell belongs
2085
+ * @param {HTMLElement} params.event.cellElement The cell HTML element
2086
+ * @param {HTMLElement} params.event.target The target element
2087
+ * @param {MouseEvent} params.event.event The native DOM event
2163
2088
  */
2164
2089
  (e: 'cellDblClick', params: ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string): void
2165
2090
  /**
@@ -2168,148 +2093,126 @@ const emit = defineEmits<{
2168
2093
  * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceHistogram#event-cellMenuBeforeShow)
2169
2094
  * @param {string} e Event name
2170
2095
  * @param {object} params Event parameters
2171
- * @param {string} params.e Event name
2172
- * @param {object} params.params Event parameters
2173
- * @param {object} params.params.event Event object
2174
- * @param {Grid.view.Grid} params.params.event.source The grid
2175
- * @param {Core.widget.Menu} params.params.event.menu The menu
2176
- * @param {Record<string, MenuItemEntry>} params.params.event.items Menu item configs
2177
- * @param {Grid.column.Column} params.params.event.column Column
2178
- * @param {Core.data.Model} params.params.event.record Record
2096
+ * @param {object} params.event Event object
2097
+ * @param {Grid.view.Grid} params.event.source The grid
2098
+ * @param {Core.widget.Menu} params.event.menu The menu
2099
+ * @param {Record<string, MenuItemEntry>} params.event.items Menu item configs
2100
+ * @param {Grid.column.Column} params.event.column Column
2101
+ * @param {Core.data.Model} params.event.record Record
2179
2102
  */
2180
- (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
2103
+ (e: 'cellMenuBeforeShow', params: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void)|string): boolean|void
2181
2104
  /**
2182
2105
  * This event fires on the owning grid when an item is selected in the cell context menu.
2183
2106
  * @param {string} e Event name
2184
2107
  * @param {object} params Event parameters
2185
- * @param {string} params.e Event name
2186
- * @param {object} params.params Event parameters
2187
- * @param {object} params.params.event Event object
2188
- * @param {Grid.view.Grid} params.params.event.source The grid
2189
- * @param {Core.widget.Menu} params.params.event.menu The menu
2190
- * @param {Core.widget.MenuItem} params.params.event.item Selected menu item
2191
- * @param {Grid.column.Column} params.params.event.column Column
2192
- * @param {Core.data.Model} params.params.event.record Record
2108
+ * @param {object} params.event Event object
2109
+ * @param {Grid.view.Grid} params.event.source The grid
2110
+ * @param {Core.widget.Menu} params.event.menu The menu
2111
+ * @param {Core.widget.MenuItem} params.event.item Selected menu item
2112
+ * @param {Grid.column.Column} params.event.column Column
2113
+ * @param {Core.data.Model} params.event.record Record
2193
2114
  */
2194
2115
  (e: 'cellMenuItem', params: ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column, record: Model }) => void)|string): void
2195
2116
  /**
2196
2117
  * This event fires on the owning grid after the context menu is shown for a cell.
2197
2118
  * @param {string} e Event name
2198
2119
  * @param {object} params Event parameters
2199
- * @param {string} params.e Event name
2200
- * @param {object} params.params Event parameters
2201
- * @param {object} params.params.event Event object
2202
- * @param {Grid.view.Grid} params.params.event.source The grid
2203
- * @param {Core.widget.Menu} params.params.event.menu The menu
2204
- * @param {Record<string, MenuItemEntry>} params.params.event.items Menu item configs
2205
- * @param {Grid.column.Column} params.params.event.column Column
2206
- * @param {Core.data.Model} params.params.event.record Record
2120
+ * @param {object} params.event Event object
2121
+ * @param {Grid.view.Grid} params.event.source The grid
2122
+ * @param {Core.widget.Menu} params.event.menu The menu
2123
+ * @param {Record<string, MenuItemEntry>} params.event.items Menu item configs
2124
+ * @param {Grid.column.Column} params.event.column Column
2125
+ * @param {Core.data.Model} params.event.record Record
2207
2126
  */
2208
2127
  (e: 'cellMenuShow', params: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => void)|string): void
2209
2128
  /**
2210
2129
  * This event fires on the owning grid when a check item is toggled in the cell context menu.
2211
2130
  * @param {string} e Event name
2212
2131
  * @param {object} params Event parameters
2213
- * @param {string} params.e Event name
2214
- * @param {object} params.params Event parameters
2215
- * @param {object} params.params.event Event object
2216
- * @param {Grid.view.Grid} params.params.event.source The grid
2217
- * @param {Core.widget.Menu} params.params.event.menu The menu
2218
- * @param {Core.widget.MenuItem} params.params.event.item Selected menu item
2219
- * @param {Grid.column.Column} params.params.event.column Column
2220
- * @param {Core.data.Model} params.params.event.record Record
2221
- * @param {boolean} params.params.event.checked Checked or not
2132
+ * @param {object} params.event Event object
2133
+ * @param {Grid.view.Grid} params.event.source The grid
2134
+ * @param {Core.widget.Menu} params.event.menu The menu
2135
+ * @param {Core.widget.MenuItem} params.event.item Selected menu item
2136
+ * @param {Grid.column.Column} params.event.column Column
2137
+ * @param {Core.data.Model} params.event.record Record
2138
+ * @param {boolean} params.event.checked Checked or not
2222
2139
  */
2223
2140
  (e: 'cellMenuToggleItem', params: ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column, record: Model, checked: boolean }) => void)|string): void
2224
2141
  /**
2225
2142
  * Fired when the mouse enters a cell
2226
2143
  * @param {string} e Event name
2227
2144
  * @param {object} params Event parameters
2228
- * @param {string} params.e Event name
2229
- * @param {object} params.params Event parameters
2230
- * @param {object} params.params.event Event object
2231
- * @param {Grid.view.Grid} params.params.event.source The grid instance
2232
- * @param {Core.data.Model} params.params.event.record The record representing the hovered cell
2233
- * @param {Grid.column.Column} params.params.event.column The column currently hovered
2234
- * @param {HTMLElement} params.params.event.cellElement The cell HTML element
2235
- * @param {MouseEvent} params.params.event.event The native DOM event
2145
+ * @param {object} params.event Event object
2146
+ * @param {Grid.view.Grid} params.event.source The grid instance
2147
+ * @param {Core.data.Model} params.event.record The record representing the hovered cell
2148
+ * @param {Grid.column.Column} params.event.column The column currently hovered
2149
+ * @param {HTMLElement} params.event.cellElement The cell HTML element
2150
+ * @param {MouseEvent} params.event.event The native DOM event
2236
2151
  */
2237
2152
  (e: 'cellMouseEnter', params: ((event: { source: Grid, record: Model, column: Column, cellElement: HTMLElement, event: MouseEvent }) => void)|string): void
2238
2153
  /**
2239
2154
  * Fired when the mouse leaves a cell
2240
2155
  * @param {string} e Event name
2241
2156
  * @param {object} params Event parameters
2242
- * @param {string} params.e Event name
2243
- * @param {object} params.params Event parameters
2244
- * @param {object} params.params.event Event object
2245
- * @param {Grid.view.Grid} params.params.event.source The grid instance
2246
- * @param {Core.data.Model} params.params.event.record The record representing the cell that the mouse left
2247
- * @param {Grid.column.Column} params.params.event.column The column representing the cell that the mouse left
2248
- * @param {HTMLElement} params.params.event.cellElement The cell HTML element that the mouse left
2249
- * @param {MouseEvent} params.params.event.event The native DOM event
2157
+ * @param {object} params.event Event object
2158
+ * @param {Grid.view.Grid} params.event.source The grid instance
2159
+ * @param {Core.data.Model} params.event.record The record representing the cell that the mouse left
2160
+ * @param {Grid.column.Column} params.event.column The column representing the cell that the mouse left
2161
+ * @param {HTMLElement} params.event.cellElement The cell HTML element that the mouse left
2162
+ * @param {MouseEvent} params.event.event The native DOM event
2250
2163
  */
2251
2164
  (e: 'cellMouseLeave', params: ((event: { source: Grid, record: Model, column: Column, cellElement: HTMLElement, event: MouseEvent }) => void)|string): void
2252
2165
  /**
2253
2166
  * Fired when a user moves the mouse out of a grid cell
2254
2167
  * @param {string} e Event name
2255
2168
  * @param {object} params Event parameters
2256
- * @param {string} params.e Event name
2257
- * @param {object} params.params Event parameters
2258
- * @param {object} params.params.event Event object
2259
- * @param {Grid.view.Grid} params.params.event.grid The grid instance
2260
- * @param {Core.data.Model} params.params.event.record The record representing the row
2261
- * @param {Grid.column.Column} params.params.event.column The column to which the cell belongs
2262
- * @param {HTMLElement} params.params.event.cellElement The cell HTML element
2263
- * @param {HTMLElement} params.params.event.target The target element
2264
- * @param {MouseEvent} params.params.event.event The native DOM event
2169
+ * @param {object} params.event Event object
2170
+ * @param {Grid.view.Grid} params.event.grid The grid instance
2171
+ * @param {Core.data.Model} params.event.record The record representing the row
2172
+ * @param {Grid.column.Column} params.event.column The column to which the cell belongs
2173
+ * @param {HTMLElement} params.event.cellElement The cell HTML element
2174
+ * @param {HTMLElement} params.event.target The target element
2175
+ * @param {MouseEvent} params.event.event The native DOM event
2265
2176
  */
2266
2177
  (e: 'cellMouseOut', params: ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string): void
2267
2178
  /**
2268
2179
  * Fired when user moves the mouse over a grid cell
2269
2180
  * @param {string} e Event name
2270
2181
  * @param {object} params Event parameters
2271
- * @param {string} params.e Event name
2272
- * @param {object} params.params Event parameters
2273
- * @param {object} params.params.event Event object
2274
- * @param {Grid.view.Grid} params.params.event.grid The grid instance
2275
- * @param {Core.data.Model} params.params.event.record The record representing the row
2276
- * @param {Grid.column.Column} params.params.event.column The column to which the cell belongs
2277
- * @param {HTMLElement} params.params.event.cellElement The cell HTML element
2278
- * @param {HTMLElement} params.params.event.target The target element
2279
- * @param {MouseEvent} params.params.event.event The native DOM event
2182
+ * @param {object} params.event Event object
2183
+ * @param {Grid.view.Grid} params.event.grid The grid instance
2184
+ * @param {Core.data.Model} params.event.record The record representing the row
2185
+ * @param {Grid.column.Column} params.event.column The column to which the cell belongs
2186
+ * @param {HTMLElement} params.event.cellElement The cell HTML element
2187
+ * @param {HTMLElement} params.event.target The target element
2188
+ * @param {MouseEvent} params.event.event The native DOM event
2280
2189
  */
2281
2190
  (e: 'cellMouseOver', params: ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string): void
2282
2191
  /**
2283
2192
  * Fires when a Panel is collapsed using the [collapsible](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Panel#config-collapsible) setting.
2284
2193
  * @param {string} e Event name
2285
2194
  * @param {object} params Event parameters
2286
- * @param {string} params.e Event name
2287
- * @param {object} params.params Event parameters
2288
- * @param {object} params.params.event Event object
2289
- * @param {Core.widget.Panel} params.params.event.source This Panel.
2195
+ * @param {object} params.event Event object
2196
+ * @param {Core.widget.Panel} params.event.source This Panel.
2290
2197
  */
2291
2198
  (e: 'collapse', params: ((event: { source: Panel }) => void)|string): void
2292
2199
  /**
2293
2200
  * Fired before a parent node record is collapsed.
2294
2201
  * @param {string} e Event name
2295
2202
  * @param {object} params Event parameters
2296
- * @param {string} params.e Event name
2297
- * @param {object} params.params Event parameters
2298
- * @param {object} params.params.event Event object
2299
- * @param {Grid.view.Grid} params.params.event.source The firing Grid instance.
2300
- * @param {Core.data.Model} params.params.event.record The record which has been collapsed.
2203
+ * @param {object} params.event Event object
2204
+ * @param {Grid.view.Grid} params.event.source The firing Grid instance.
2205
+ * @param {Core.data.Model} params.event.record The record which has been collapsed.
2301
2206
  */
2302
2207
  (e: 'collapseNode', params: ((event: { source: Grid, record: Model }) => void)|string): void
2303
2208
  /**
2304
2209
  * This event is triggered after a parent column has been collapsed or expanded.
2305
2210
  * @param {string} e Event name
2306
2211
  * @param {object} params Event parameters
2307
- * @param {string} params.e Event name
2308
- * @param {object} params.params Event parameters
2309
- * @param {object} params.params.event Event object
2310
- * @param {Grid.view.GridBase} params.params.event.source The Grid instance
2311
- * @param {Grid.column.Column} params.params.event.column The column being toggled
2312
- * @param {boolean} params.params.event.collapsed `true` if the column is now collapsed, `false` if expanded
2212
+ * @param {object} params.event Event object
2213
+ * @param {Grid.view.GridBase} params.event.source The Grid instance
2214
+ * @param {Grid.column.Column} params.event.column The column being toggled
2215
+ * @param {boolean} params.event.collapsed `true` if the column is now collapsed, `false` if expanded
2313
2216
  */
2314
2217
  (e: 'columnCollapseToggle', params: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string): void
2315
2218
  /**
@@ -2317,27 +2220,23 @@ const emit = defineEmits<{
2317
2220
  * to indicate whether the drop position is valid or not.
2318
2221
  * @param {string} e Event name
2319
2222
  * @param {object} params Event parameters
2320
- * @param {string} params.e Event name
2321
- * @param {object} params.params Event parameters
2322
- * @param {object} params.params.event Event object
2323
- * @param {Grid.view.Grid} params.params.event.source The grid instance.
2324
- * @param {Grid.column.Column} params.params.event.column The dragged column.
2325
- * @param {Grid.column.Column} params.params.event.insertBefore The column before which the dragged column will be inserted (if not last).
2326
- * @param {Event} params.params.event.event The browser event.
2327
- * @param {object} params.params.event.context
2328
- * @param {boolean} params.params.event.context.valid Set this to `true` or `false` to indicate whether the drop position is valid.
2223
+ * @param {object} params.event Event object
2224
+ * @param {Grid.view.Grid} params.event.source The grid instance.
2225
+ * @param {Grid.column.Column} params.event.column The dragged column.
2226
+ * @param {Grid.column.Column} params.event.insertBefore The column before which the dragged column will be inserted (if not last).
2227
+ * @param {Event} params.event.event The browser event.
2228
+ * @param {object} params.event.context
2229
+ * @param {boolean} params.event.context.valid Set this to `true` or `false` to indicate whether the drop position is valid.
2329
2230
  */
2330
2231
  (e: 'columnDrag', params: ((event: { source: Grid, column: Column, insertBefore: Column, event: Event, context: { valid: boolean } }) => void)|string): void
2331
2232
  /**
2332
2233
  * This event is fired when a column drag gesture has started.
2333
2234
  * @param {string} e Event name
2334
2235
  * @param {object} params Event parameters
2335
- * @param {string} params.e Event name
2336
- * @param {object} params.params Event parameters
2337
- * @param {object} params.params.event Event object
2338
- * @param {Grid.view.Grid} params.params.event.source The grid instance.
2339
- * @param {Grid.column.Column} params.params.event.column The dragged column.
2340
- * @param {Event} params.params.event.event The browser event.
2236
+ * @param {object} params.event Event object
2237
+ * @param {Grid.view.Grid} params.event.source The grid instance.
2238
+ * @param {Grid.column.Column} params.event.column The dragged column.
2239
+ * @param {Event} params.event.event The browser event.
2341
2240
  */
2342
2241
  (e: 'columnDragStart', params: ((event: { source: Grid, column: Column, event: Event }) => void)|string): void
2343
2242
  /**
@@ -2345,90 +2244,76 @@ const emit = defineEmits<{
2345
2244
  * vetoed and the column was moved in the column store.
2346
2245
  * @param {string} e Event name
2347
2246
  * @param {object} params Event parameters
2348
- * @param {string} params.e Event name
2349
- * @param {object} params.params Event parameters
2350
- * @param {object} params.params.event Event object
2351
- * @param {Grid.view.Grid} params.params.event.source The grid instance.
2352
- * @param {Grid.column.Column} params.params.event.column The dragged column.
2353
- * @param {Grid.column.Column} params.params.event.insertBefore The column before which the dragged column will be inserted.
2354
- * @param {Grid.column.Column} params.params.event.newParent The new parent column.
2355
- * @param {boolean} params.params.event.valid `true` if the operation was not vetoed.
2356
- * @param {Event} params.params.event.event The browser event.
2357
- * @param {string} params.params.event.region The region where the column was dropped.
2247
+ * @param {object} params.event Event object
2248
+ * @param {Grid.view.Grid} params.event.source The grid instance.
2249
+ * @param {Grid.column.Column} params.event.column The dragged column.
2250
+ * @param {Grid.column.Column} params.event.insertBefore The column before which the dragged column will be inserted.
2251
+ * @param {Grid.column.Column} params.event.newParent The new parent column.
2252
+ * @param {boolean} params.event.valid `true` if the operation was not vetoed.
2253
+ * @param {Event} params.event.event The browser event.
2254
+ * @param {string} params.event.region The region where the column was dropped.
2358
2255
  */
2359
- (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
2256
+ (e: 'columnDrop', params: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void)|string): boolean|void
2360
2257
  /**
2361
2258
  * This event is fired after a resize gesture is completed.
2362
2259
  * @param {string} e Event name
2363
2260
  * @param {object} params Event parameters
2364
- * @param {string} params.e Event name
2365
- * @param {object} params.params Event parameters
2366
- * @param {object} params.params.event Event object
2367
- * @param {Grid.view.Grid} params.params.event.source The grid instance
2368
- * @param {Grid.column.Column} params.params.event.column The resized column
2369
- * @param {Event} params.params.event.domEvent The browser event
2261
+ * @param {object} params.event Event object
2262
+ * @param {Grid.view.Grid} params.event.source The grid instance
2263
+ * @param {Grid.column.Column} params.event.column The resized column
2264
+ * @param {Event} params.event.domEvent The browser event
2370
2265
  */
2371
2266
  (e: 'columnResize', params: ((event: { source: Grid, column: Column, domEvent: Event }) => void)|string): void
2372
2267
  /**
2373
2268
  * This event is fired when a column resize gesture starts.
2374
2269
  * @param {string} e Event name
2375
2270
  * @param {object} params Event parameters
2376
- * @param {string} params.e Event name
2377
- * @param {object} params.params Event parameters
2378
- * @param {object} params.params.event Event object
2379
- * @param {Grid.view.Grid} params.params.event.source The grid instance
2380
- * @param {Grid.column.Column} params.params.event.column The column
2381
- * @param {Event} params.params.event.domEvent The browser event
2271
+ * @param {object} params.event Event object
2272
+ * @param {Grid.view.Grid} params.event.source The grid instance
2273
+ * @param {Grid.column.Column} params.event.column The column
2274
+ * @param {Event} params.event.domEvent The browser event
2382
2275
  */
2383
2276
  (e: 'columnResizeStart', params: ((event: { source: Grid, column: Column, domEvent: Event }) => void)|string): void
2384
2277
  /**
2385
2278
  * This event fires on the owning widget when an item is selected in the context menu.
2386
2279
  * @param {string} e Event name
2387
2280
  * @param {object} params Event parameters
2388
- * @param {string} params.e Event name
2389
- * @param {object} params.params Event parameters
2390
- * @param {object} params.params.event Event object
2391
- * @param {Core.widget.Widget} params.params.event.source The owning widget
2392
- * @param {Core.widget.Menu} params.params.event.menu The menu
2393
- * @param {Core.widget.MenuItem} params.params.event.item Selected menu item
2281
+ * @param {object} params.event Event object
2282
+ * @param {Core.widget.Widget} params.event.source The owning widget
2283
+ * @param {Core.widget.Menu} params.event.menu The menu
2284
+ * @param {Core.widget.MenuItem} params.event.item Selected menu item
2394
2285
  */
2395
2286
  (e: 'contextMenuItem', params: ((event: { source: Widget, menu: Menu, item: MenuItem }) => void)|string): void
2396
2287
  /**
2397
2288
  * This event fires on the owning widget when a check item is toggled in the context menu.
2398
2289
  * @param {string} e Event name
2399
2290
  * @param {object} params Event parameters
2400
- * @param {string} params.e Event name
2401
- * @param {object} params.params Event parameters
2402
- * @param {object} params.params.event Event object
2403
- * @param {Core.widget.Widget} params.params.event.source The owning widget
2404
- * @param {Core.widget.Menu} params.params.event.menu The menu
2405
- * @param {Core.widget.MenuItem} params.params.event.item Selected menu item
2406
- * @param {boolean} params.params.event.checked Checked or not
2291
+ * @param {object} params.event Event object
2292
+ * @param {Core.widget.Widget} params.event.source The owning widget
2293
+ * @param {Core.widget.Menu} params.event.menu The menu
2294
+ * @param {Core.widget.MenuItem} params.event.item Selected menu item
2295
+ * @param {boolean} params.event.checked Checked or not
2407
2296
  */
2408
2297
  (e: 'contextMenuToggleItem', params: ((event: { source: Widget, menu: Menu, item: MenuItem, checked: boolean }) => void)|string): void
2409
2298
  /**
2410
2299
  * Fires on the owning Grid after a copy action is performed.
2411
2300
  * @param {string} e Event name
2412
2301
  * @param {object} params Event parameters
2413
- * @param {string} params.e Event name
2414
- * @param {object} params.params Event parameters
2415
- * @param {object} params.params.event Event object
2416
- * @param {Grid.view.Grid} params.params.event.source Owner grid
2417
- * @param {Grid.util.GridLocation[]} params.params.event.cells The cells about to be copied or cut
2418
- * @param {string} params.params.event.copiedDataString The concatenated data string that was copied or cut
2419
- * @param {boolean} params.params.event.isCut `true` if this was a cut action
2420
- * @param {string} params.params.event.entityName 'cell' to distinguish this event from other copy events
2302
+ * @param {object} params.event Event object
2303
+ * @param {Grid.view.Grid} params.event.source Owner grid
2304
+ * @param {Grid.util.GridLocation[]} params.event.cells The cells about to be copied or cut
2305
+ * @param {string} params.event.copiedDataString The concatenated data string that was copied or cut
2306
+ * @param {boolean} params.event.isCut `true` if this was a cut action
2307
+ * @param {string} params.event.entityName 'cell' to distinguish this event from other copy events
2421
2308
  */
2422
2309
  (e: 'copy', params: ((event: { source: Grid, cells: GridLocation[], copiedDataString: string, isCut: boolean, entityName: string }) => void)|string): void
2423
2310
  /**
2424
2311
  * Fires on the owning Scheduler/Gantt when the line indicating the current time is updated (see [currentTimeLineUpdateInterval](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/TimeRanges#config-currentTimeLineUpdateInterval)).
2425
2312
  * @param {string} e Event name
2426
2313
  * @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 {Scheduler.view.Scheduler} params.params.event.source The scheduler
2431
- * @param {Date} params.params.event.date The current date
2314
+ * @param {object} params.event Event object
2315
+ * @param {Scheduler.view.Scheduler} params.event.source The scheduler
2316
+ * @param {Date} params.event.date The current date
2432
2317
  */
2433
2318
  (e: 'currentTimelineUpdate', params: ((event: { source: Scheduler, date: Date }) => void)|string): void
2434
2319
  /**
@@ -2436,15 +2321,13 @@ const emit = defineEmits<{
2436
2321
  * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceHistogram#event-dataChange)
2437
2322
  * @param {string} e Event name
2438
2323
  * @param {object} params Event parameters
2439
- * @param {string} params.e Event name
2440
- * @param {object} params.params Event parameters
2441
- * @param {object} params.params.event Event object
2442
- * @param {Grid.view.GridBase} params.params.event.source Owning grid
2443
- * @param {Core.data.Store} params.params.event.store The originating store
2444
- * @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'`
2445
- * @param {Core.data.Model} params.params.event.record Changed record, for actions that affects exactly one record (`'update'`)
2446
- * @param {Core.data.Model[]} params.params.event.records Changed records, passed for all actions except `'removeAll'`
2447
- * @param {object} params.params.event.changes Passed for the `'update'` action, info on which record fields changed
2324
+ * @param {object} params.event Event object
2325
+ * @param {Grid.view.GridBase} params.event.source Owning grid
2326
+ * @param {Core.data.Store} params.event.store The originating store
2327
+ * @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'`
2328
+ * @param {Core.data.Model} params.event.record Changed record, for actions that affects exactly one record (`'update'`)
2329
+ * @param {Core.data.Model[]} params.event.records Changed records, passed for all actions except `'removeAll'`
2330
+ * @param {object} params.event.changes Passed for the `'update'` action, info on which record fields changed
2448
2331
  */
2449
2332
  (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
2450
2333
  /**
@@ -2454,37 +2337,31 @@ const emit = defineEmits<{
2454
2337
  * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceHistogram#event-dateRangeChange)
2455
2338
  * @param {string} e Event name
2456
2339
  * @param {object} params Event parameters
2457
- * @param {string} params.e Event name
2458
- * @param {object} params.params Event parameters
2459
- * @param {object} params.params.event Event object
2460
- * @param {Scheduler.view.TimelineBase} params.params.event.source This Scheduler/Gantt instance.
2461
- * @param {object} params.params.event.old The old date range
2462
- * @param {Date} params.params.event.old.startDate the old start date.
2463
- * @param {Date} params.params.event.old.endDate the old end date.
2464
- * @param {object} params.params.event.new The new date range
2465
- * @param {Date} params.params.event.new.startDate the new start date.
2466
- * @param {Date} params.params.event.new.endDate the new end date.
2340
+ * @param {object} params.event Event object
2341
+ * @param {Scheduler.view.TimelineBase} params.event.source This Scheduler/Gantt instance.
2342
+ * @param {object} params.event.old The old date range
2343
+ * @param {Date} params.event.old.startDate the old start date.
2344
+ * @param {Date} params.event.old.endDate the old end date.
2345
+ * @param {object} params.event.new The new date range
2346
+ * @param {Date} params.event.new.startDate the new start date.
2347
+ * @param {Date} params.event.new.endDate the new end date.
2467
2348
  */
2468
2349
  (e: 'dateRangeChange', params: ((event: { source: TimelineBase, old: { startDate: Date, endDate: Date }, new: { startDate: Date, endDate: Date } }) => void)|string): void
2469
2350
  /**
2470
2351
  * Fires when an object is destroyed.
2471
2352
  * @param {string} e Event name
2472
2353
  * @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 {Core.Base} params.params.event.source The Object that is being destroyed.
2354
+ * @param {object} params.event Event object
2355
+ * @param {Core.Base} params.event.source The Object that is being destroyed.
2477
2356
  */
2478
2357
  (e: 'destroy', params: ((event: { source: Base }) => void)|string): void
2479
2358
  /**
2480
2359
  * 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
2481
2360
  * @param {string} e Event name
2482
2361
  * @param {object} params Event parameters
2483
- * @param {string} params.e Event name
2484
- * @param {object} params.params Event parameters
2485
- * @param {object} params.params.event Event object
2486
- * @param {Core.widget.Container} params.params.event.source The container.
2487
- * @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.
2362
+ * @param {object} params.event Event object
2363
+ * @param {Core.widget.Container} params.event.source The container.
2364
+ * @param {boolean} params.event.dirty The dirty state of the Container - `true` if there are any fields which have been changed since initial load.
2488
2365
  */
2489
2366
  (e: 'dirtyStateChange', params: ((event: { source: Container, dirty: boolean }) => void)|string): void
2490
2367
  /**
@@ -2492,55 +2369,45 @@ const emit = defineEmits<{
2492
2369
  * mouse up. This event can be listened for to perform actions while drag selecting.
2493
2370
  * @param {string} e Event name
2494
2371
  * @param {object} params Event parameters
2495
- * @param {string} params.e Event name
2496
- * @param {object} params.params Event parameters
2497
- * @param {object} params.params.event Event object
2498
- * @param {Grid.view.Grid} params.params.event.source
2499
- * @param {GridLocationConfig[],Grid.util.GridLocation[]} params.params.event.selectedCells The cells that is currently being dragged over
2500
- * @param {Core.data.Model[]} params.params.event.selectedRecords The records that is currently being dragged over
2372
+ * @param {object} params.event Event object
2373
+ * @param {Grid.view.Grid} params.event.source
2374
+ * @param {GridLocationConfig[],Grid.util.GridLocation[]} params.event.selectedCells The cells that is currently being dragged over
2375
+ * @param {Core.data.Model[]} params.event.selectedRecords The records that is currently being dragged over
2501
2376
  */
2502
2377
  (e: 'dragSelecting', params: ((event: { source: Grid, selectedCells: GridLocationConfig[]|GridLocation[], selectedRecords: Model[] }) => void)|string): void
2503
2378
  /**
2504
2379
  * Triggered when a widget's [element](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#property-element) is available.
2505
2380
  * @param {string} e Event name
2506
2381
  * @param {object} params Event parameters
2507
- * @param {string} params.e Event name
2508
- * @param {object} params.params Event parameters
2509
- * @param {object} params.params.event Event object
2510
- * @param {HTMLElement} params.params.event.element The Widget's element.
2382
+ * @param {object} params.event Event object
2383
+ * @param {HTMLElement} params.event.element The Widget's element.
2511
2384
  */
2512
2385
  (e: 'elementCreated', params: ((event: { element: HTMLElement }) => void)|string): void
2513
2386
  /**
2514
2387
  * Fires when a Panel is expanded using the [collapsible](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Panel#config-collapsible) setting.
2515
2388
  * @param {string} e Event name
2516
2389
  * @param {object} params Event parameters
2517
- * @param {string} params.e Event name
2518
- * @param {object} params.params Event parameters
2519
- * @param {object} params.params.event Event object
2520
- * @param {Core.widget.Panel} params.params.event.source This Panel.
2390
+ * @param {object} params.event Event object
2391
+ * @param {Core.widget.Panel} params.event.source This Panel.
2521
2392
  */
2522
2393
  (e: 'expand', params: ((event: { source: Panel }) => void)|string): void
2523
2394
  /**
2524
2395
  * Fired after a parent node record is expanded.
2525
2396
  * @param {string} e Event name
2526
2397
  * @param {object} params Event parameters
2527
- * @param {string} params.e Event name
2528
- * @param {object} params.params Event parameters
2529
- * @param {object} params.params.event Event object
2530
- * @param {Grid.view.Grid} params.params.event.source The firing Grid instance.
2531
- * @param {Core.data.Model} params.params.event.record The record which has been expanded.
2398
+ * @param {object} params.event Event object
2399
+ * @param {Grid.view.Grid} params.event.source The firing Grid instance.
2400
+ * @param {Core.data.Model} params.event.record The record which has been expanded.
2532
2401
  */
2533
2402
  (e: 'expandNode', params: ((event: { source: Grid, record: Model }) => void)|string): void
2534
2403
  /**
2535
2404
  * Fired when a file is dropped on the widget element
2536
2405
  * @param {string} e Event name
2537
2406
  * @param {object} params Event parameters
2538
- * @param {string} params.e Event name
2539
- * @param {object} params.params Event parameters
2540
- * @param {object} params.params.event Event object
2541
- * @param {Grid.view.Grid} params.params.event.source The owning Grid instance
2542
- * @param {DataTransferItem} params.params.event.file The dropped file descriptor
2543
- * @param {DragEvent} params.params.event.domEvent The native DragEvent
2407
+ * @param {object} params.event Event object
2408
+ * @param {Grid.view.Grid} params.event.source The owning Grid instance
2409
+ * @param {DataTransferItem} params.event.file The dropped file descriptor
2410
+ * @param {DragEvent} params.event.domEvent The native DragEvent
2544
2411
  */
2545
2412
  (e: 'fileDrop', params: ((event: { source: Grid, file: DataTransferItem, domEvent: DragEvent }) => void)|string): void
2546
2413
  /**
@@ -2548,24 +2415,20 @@ const emit = defineEmits<{
2548
2415
  * drag operation from applying data changes.
2549
2416
  * @param {string} e Event name
2550
2417
  * @param {object} params Event parameters
2551
- * @param {string} params.e Event name
2552
- * @param {object} params.params Event parameters
2553
- * @param {object} params.params.event Event object
2554
- * @param {Grid.util.GridLocation} params.params.event.from The from cell
2555
- * @param {Grid.util.GridLocation} params.params.event.to The to cell
2556
- * @param {MouseEvent} params.params.event.domEvent The raw DOM event
2418
+ * @param {object} params.event Event object
2419
+ * @param {Grid.util.GridLocation} params.event.from The from cell
2420
+ * @param {Grid.util.GridLocation} params.event.to The to cell
2421
+ * @param {MouseEvent} params.event.domEvent The raw DOM event
2557
2422
  */
2558
2423
  (e: 'fillHandleBeforeDragFinalize', params: ((event: { from: GridLocation, to: GridLocation, domEvent: MouseEvent }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
2559
2424
  /**
2560
2425
  * Fired while dragging the FillHandle.
2561
2426
  * @param {string} e Event name
2562
2427
  * @param {object} params Event parameters
2563
- * @param {string} params.e Event name
2564
- * @param {object} params.params Event parameters
2565
- * @param {object} params.params.event Event object
2566
- * @param {Grid.util.GridLocation} params.params.event.from The from cell
2567
- * @param {Grid.util.GridLocation} params.params.event.to The to cell
2568
- * @param {MouseEvent} params.params.event.domEvent The raw DOM event
2428
+ * @param {object} params.event Event object
2429
+ * @param {Grid.util.GridLocation} params.event.from The from cell
2430
+ * @param {Grid.util.GridLocation} params.event.to The to cell
2431
+ * @param {MouseEvent} params.event.domEvent The raw DOM event
2569
2432
  */
2570
2433
  (e: 'fillHandleDrag', params: ((event: { from: GridLocation, to: GridLocation, domEvent: MouseEvent }) => void)|string): void
2571
2434
  /**
@@ -2576,34 +2439,28 @@ const emit = defineEmits<{
2576
2439
  * Fired after a FillHandle drag operation.
2577
2440
  * @param {string} e Event name
2578
2441
  * @param {object} params Event parameters
2579
- * @param {string} params.e Event name
2580
- * @param {object} params.params Event parameters
2581
- * @param {object} params.params.event Event object
2582
- * @param {Grid.util.GridLocation} params.params.event.from The from cell
2583
- * @param {Grid.util.GridLocation} params.params.event.to The to cell
2584
- * @param {MouseEvent} params.params.event.domEvent The raw DOM event
2442
+ * @param {object} params.event Event object
2443
+ * @param {Grid.util.GridLocation} params.event.from The from cell
2444
+ * @param {Grid.util.GridLocation} params.event.to The to cell
2445
+ * @param {MouseEvent} params.event.domEvent The raw DOM event
2585
2446
  */
2586
2447
  (e: 'fillHandleDragEnd', params: ((event: { from: GridLocation, to: GridLocation, domEvent: MouseEvent }) => void)|string): void
2587
2448
  /**
2588
2449
  * Fired when dragging of the FillHandle starts.
2589
2450
  * @param {string} e Event name
2590
2451
  * @param {object} params Event parameters
2591
- * @param {string} params.e Event name
2592
- * @param {object} params.params Event parameters
2593
- * @param {object} params.params.event Event object
2594
- * @param {Grid.util.GridLocation} params.params.event.cell Information about the column / record
2595
- * @param {MouseEvent} params.params.event.domEvent The raw DOM event
2452
+ * @param {object} params.event Event object
2453
+ * @param {Grid.util.GridLocation} params.event.cell Information about the column / record
2454
+ * @param {MouseEvent} params.event.domEvent The raw DOM event
2596
2455
  */
2597
- (e: 'fillHandleDragStart', params: ((event: { cell: GridLocation, domEvent: MouseEvent }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
2456
+ (e: 'fillHandleDragStart', params: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string): boolean|void
2598
2457
  /**
2599
2458
  * Fires on the owning Grid when cell editing is finished
2600
2459
  * @param {string} e Event name
2601
2460
  * @param {object} params Event parameters
2602
- * @param {string} params.e Event name
2603
- * @param {object} params.params Event parameters
2604
- * @param {object} params.params.event Event object
2605
- * @param {Grid.view.Grid} params.params.event.grid Target grid
2606
- * @param {CellEditorContext} params.params.event.editorContext Editing context
2461
+ * @param {object} params.event Event object
2462
+ * @param {Grid.view.Grid} params.event.grid Target grid
2463
+ * @param {CellEditorContext} params.event.editorContext Editing context
2607
2464
  */
2608
2465
  (e: 'finishCellEdit', params: ((event: { grid: Grid, editorContext: CellEditorContext }) => void)|string): void
2609
2466
  /**
@@ -2611,26 +2468,22 @@ const emit = defineEmits<{
2611
2468
  * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceHistogram#event-finishRowEdit)
2612
2469
  * @param {string} e Event name
2613
2470
  * @param {object} params Event parameters
2614
- * @param {string} params.e Event name
2615
- * @param {object} params.params Event parameters
2616
- * @param {object} params.params.event Event object
2617
- * @param {Grid.view.Grid} params.params.event.grid Target grid
2618
- * @param {RowEditorContext} params.params.event.editorContext Editing context
2471
+ * @param {object} params.event Event object
2472
+ * @param {Grid.view.Grid} params.event.grid Target grid
2473
+ * @param {RowEditorContext} params.event.editorContext Editing context
2619
2474
  */
2620
2475
  (e: 'finishRowEdit', params: ((event: { grid: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
2621
2476
  /**
2622
2477
  * Fired when focus enters this Widget.
2623
2478
  * @param {string} e Event name
2624
2479
  * @param {object} params Event parameters
2625
- * @param {string} params.e Event name
2626
- * @param {object} params.params Event parameters
2627
- * @param {object} params.params.event Event object
2628
- * @param {Core.widget.Widget} params.params.event.source This Widget
2629
- * @param {HTMLElement} params.params.event.fromElement The element which lost focus.
2630
- * @param {HTMLElement} params.params.event.toElement The element which gained focus.
2631
- * @param {Core.widget.Widget} params.params.event.fromWidget The widget which lost focus.
2632
- * @param {Core.widget.Widget} params.params.event.toWidget The widget which gained focus.
2633
- * @param {boolean} params.params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
2480
+ * @param {object} params.event Event object
2481
+ * @param {Core.widget.Widget} params.event.source This Widget
2482
+ * @param {HTMLElement} params.event.fromElement The element which lost focus.
2483
+ * @param {HTMLElement} params.event.toElement The element which gained focus.
2484
+ * @param {Core.widget.Widget} params.event.fromWidget The widget which lost focus.
2485
+ * @param {Core.widget.Widget} params.event.toWidget The widget which gained focus.
2486
+ * @param {boolean} params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
2634
2487
  */
2635
2488
  (e: 'focusIn', params: ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string): void
2636
2489
  /**
@@ -2639,15 +2492,13 @@ const emit = defineEmits<{
2639
2492
  * will not trigger this event. This is when focus exits this widget completely.
2640
2493
  * @param {string} e Event name
2641
2494
  * @param {object} params Event parameters
2642
- * @param {string} params.e Event name
2643
- * @param {object} params.params Event parameters
2644
- * @param {object} params.params.event Event object
2645
- * @param {Core.widget.Widget} params.params.event.source This Widget
2646
- * @param {HTMLElement} params.params.event.fromElement The element which lost focus.
2647
- * @param {HTMLElement} params.params.event.toElement The element which gained focus.
2648
- * @param {Core.widget.Widget} params.params.event.fromWidget The widget which lost focus.
2649
- * @param {Core.widget.Widget} params.params.event.toWidget The widget which gained focus.
2650
- * @param {boolean} params.params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
2495
+ * @param {object} params.event Event object
2496
+ * @param {Core.widget.Widget} params.event.source This Widget
2497
+ * @param {HTMLElement} params.event.fromElement The element which lost focus.
2498
+ * @param {HTMLElement} params.event.toElement The element which gained focus.
2499
+ * @param {Core.widget.Widget} params.event.fromWidget The widget which lost focus.
2500
+ * @param {Core.widget.Widget} params.event.toWidget The widget which gained focus.
2501
+ * @param {boolean} params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
2651
2502
  */
2652
2503
  (e: 'focusOut', params: ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string): void
2653
2504
  /**
@@ -2655,42 +2506,36 @@ const emit = defineEmits<{
2655
2506
  * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceHistogram#event-generateScalePoints)
2656
2507
  * @param {string} e Event name
2657
2508
  * @param {object} params Event parameters
2658
- * @param {string} params.e Event name
2659
- * @param {object} params.params Event parameters
2660
- * @param {object} params.params.event Event object
2661
- * @param {SchedulerPro.view.ResourceHistogram} params.params.event.source The component instance
2662
- * @param {ScalePoint[]} params.params.event.scalePoints Array of objects representing scale points. Each entry can have properties: * `value` - point value * `unit` - point value unit * `text` - label text (if not provided the point will not have a label displayed)
2509
+ * @param {object} params.event Event object
2510
+ * @param {SchedulerPro.view.ResourceHistogram} params.event.source The component instance
2511
+ * @param {ScalePoint[]} params.event.scalePoints Array of objects representing scale points. Each entry can have properties: * `value` - point value * `unit` - point value unit * `text` - label text (if not provided the point will not have a label displayed)
2663
2512
  */
2664
2513
  (e: 'generateScalePoints', params: ((event: { source: ResourceHistogram, scalePoints: ScalePoint[] }) => void)|string): void
2665
2514
  /**
2666
2515
  * Fired before dragging starts, return false to prevent the drag operation.
2667
2516
  * @param {string} e Event name
2668
2517
  * @param {object} params Event parameters
2669
- * @param {string} params.e Event name
2670
- * @param {object} params.params Event parameters
2671
- * @param {object} params.params.event Event object
2672
- * @param {Grid.view.GridBase} params.params.event.source
2673
- * @param {object} params.params.event.context
2674
- * @param {Core.data.Model[]} params.params.event.context.records The dragged row records
2675
- * @param {MouseEvent,TouchEvent} params.params.event.event
2518
+ * @param {object} params.event Event object
2519
+ * @param {Grid.view.GridBase} params.event.source
2520
+ * @param {object} params.event.context
2521
+ * @param {Core.data.Model[]} params.event.context.records The dragged row records
2522
+ * @param {MouseEvent,TouchEvent} params.event.event
2676
2523
  */
2677
- (e: 'gridRowBeforeDragStart', params: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
2524
+ (e: 'gridRowBeforeDragStart', params: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void)|string): boolean|void
2678
2525
  /**
2679
2526
  * Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
2680
2527
  * Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
2681
2528
  * @param {string} e Event name
2682
2529
  * @param {object} params Event parameters
2683
- * @param {string} params.e Event name
2684
- * @param {object} params.params Event parameters
2685
- * @param {object} params.params.event Event object
2686
- * @param {Grid.view.GridBase} params.params.event.source
2687
- * @param {object} params.params.event.context
2688
- * @param {boolean} params.params.event.context.valid Set this to true or false to indicate whether the drop position is valid
2689
- * @param {Core.data.Model} params.params.event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
2690
- * @param {Core.data.Model} params.params.event.context.parent The parent record of the current drop position (only applicable for trees)
2691
- * @param {Core.data.Model[]} params.params.event.context.records The dragged row records
2692
- * @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
2693
- * @param {MouseEvent} params.params.event.event
2530
+ * @param {object} params.event Event object
2531
+ * @param {Grid.view.GridBase} params.event.source
2532
+ * @param {object} params.event.context
2533
+ * @param {boolean} params.event.context.valid Set this to true or false to indicate whether the drop position is valid
2534
+ * @param {Core.data.Model} params.event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
2535
+ * @param {Core.data.Model} params.event.context.parent The parent record of the current drop position (only applicable for trees)
2536
+ * @param {Core.data.Model[]} params.event.context.records The dragged row records
2537
+ * @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
2538
+ * @param {MouseEvent} params.event.event
2694
2539
  */
2695
2540
  (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
2696
2541
  /**
@@ -2699,59 +2544,51 @@ const emit = defineEmits<{
2699
2544
  * valid or invalid by setting `context.valid = false;`
2700
2545
  * @param {string} e Event name
2701
2546
  * @param {object} params Event parameters
2702
- * @param {string} params.e Event name
2703
- * @param {object} params.params Event parameters
2704
- * @param {object} params.params.event Event object
2705
- * @param {Grid.view.GridBase} params.params.event.source
2706
- * @param {object} params.params.event.context
2707
- * @param {boolean} params.params.event.context.valid Set this to true or false to indicate whether the drop position is valid.
2708
- * @param {Core.data.Model} params.params.event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
2709
- * @param {Core.data.Model} params.params.event.context.parent The parent record of the current drop position (only applicable for trees)
2710
- * @param {Core.data.Model[]} params.params.event.context.records The dragged row records
2711
- * @param {MouseEvent} params.params.event.event
2547
+ * @param {object} params.event Event object
2548
+ * @param {Grid.view.GridBase} params.event.source
2549
+ * @param {object} params.event.context
2550
+ * @param {boolean} params.event.context.valid Set this to true or false to indicate whether the drop position is valid.
2551
+ * @param {Core.data.Model} params.event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
2552
+ * @param {Core.data.Model} params.event.context.parent The parent record of the current drop position (only applicable for trees)
2553
+ * @param {Core.data.Model[]} params.event.context.records The dragged row records
2554
+ * @param {MouseEvent} params.event.event
2712
2555
  */
2713
2556
  (e: 'gridRowDrag', params: ((event: { source: GridBase, context: { valid: boolean, insertBefore: Model, parent: Model, records: Model[] }, event: MouseEvent }) => void)|string): void
2714
2557
  /**
2715
2558
  * Fired when a row drag operation is aborted
2716
2559
  * @param {string} e Event name
2717
2560
  * @param {object} params Event parameters
2718
- * @param {string} params.e Event name
2719
- * @param {object} params.params Event parameters
2720
- * @param {object} params.params.event Event object
2721
- * @param {Grid.view.GridBase} params.params.event.source
2722
- * @param {object} params.params.event.context
2723
- * @param {Core.data.Model[]} params.params.event.context.records The dragged row records
2724
- * @param {MouseEvent} params.params.event.event
2561
+ * @param {object} params.event Event object
2562
+ * @param {Grid.view.GridBase} params.event.source
2563
+ * @param {object} params.event.context
2564
+ * @param {Core.data.Model[]} params.event.context.records The dragged row records
2565
+ * @param {MouseEvent} params.event.event
2725
2566
  */
2726
2567
  (e: 'gridRowDragAbort', params: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent }) => void)|string): void
2727
2568
  /**
2728
2569
  * Fired when dragging starts.
2729
2570
  * @param {string} e Event name
2730
2571
  * @param {object} params Event parameters
2731
- * @param {string} params.e Event name
2732
- * @param {object} params.params Event parameters
2733
- * @param {object} params.params.event Event object
2734
- * @param {Grid.view.GridBase} params.params.event.source
2735
- * @param {object} params.params.event.context
2736
- * @param {Core.data.Model[]} params.params.event.context.records The dragged row records
2737
- * @param {MouseEvent,TouchEvent} params.params.event.event
2572
+ * @param {object} params.event Event object
2573
+ * @param {Grid.view.GridBase} params.event.source
2574
+ * @param {object} params.event.context
2575
+ * @param {Core.data.Model[]} params.event.context.records The dragged row records
2576
+ * @param {MouseEvent,TouchEvent} params.event.event
2738
2577
  */
2739
2578
  (e: 'gridRowDragStart', params: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => void)|string): void
2740
2579
  /**
2741
2580
  * Fired after the row drop operation has completed, regardless of validity
2742
2581
  * @param {string} e Event name
2743
2582
  * @param {object} params Event parameters
2744
- * @param {string} params.e Event name
2745
- * @param {object} params.params Event parameters
2746
- * @param {object} params.params.event Event object
2747
- * @param {Grid.view.GridBase} params.params.event.source
2748
- * @param {object} params.params.event.context
2749
- * @param {boolean} params.params.event.context.valid true or false depending on whether the drop position was valid
2750
- * @param {Core.data.Model} params.params.event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
2751
- * @param {Core.data.Model} params.params.event.context.parent The parent record of the current drop position (only applicable for trees)
2752
- * @param {Core.data.Model[]} params.params.event.context.records The dragged row records
2753
- * @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
2754
- * @param {MouseEvent} params.params.event.event
2583
+ * @param {object} params.event Event object
2584
+ * @param {Grid.view.GridBase} params.event.source
2585
+ * @param {object} params.event.context
2586
+ * @param {boolean} params.event.context.valid true or false depending on whether the drop position was valid
2587
+ * @param {Core.data.Model} params.event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
2588
+ * @param {Core.data.Model} params.event.context.parent The parent record of the current drop position (only applicable for trees)
2589
+ * @param {Core.data.Model[]} params.event.context.records The dragged row records
2590
+ * @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
2591
+ * @param {MouseEvent} params.event.event
2755
2592
  */
2756
2593
  (e: 'gridRowDrop', params: ((event: { source: GridBase, context: { valid: boolean, insertBefore: Model, parent: Model, records: Model[], oldPositionContext: RecordPositionContext[] }, event: MouseEvent }) => void)|string): void
2757
2594
  /**
@@ -2759,76 +2596,64 @@ const emit = defineEmits<{
2759
2596
  * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceHistogram#event-headerClick)
2760
2597
  * @param {string} e Event name
2761
2598
  * @param {object} params Event parameters
2762
- * @param {string} params.e Event name
2763
- * @param {object} params.params Event parameters
2764
- * @param {object} params.params.event Event object
2765
- * @param {Event} params.params.event.domEvent The triggering DOM event.
2766
- * @param {Grid.column.Column} params.params.event.column The column clicked on.
2599
+ * @param {object} params.event Event object
2600
+ * @param {Event} params.event.domEvent The triggering DOM event.
2601
+ * @param {Grid.column.Column} params.event.column The column clicked on.
2767
2602
  */
2768
- (e: 'headerClick', params: ((event: { domEvent: Event, column: Column }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
2603
+ (e: 'headerClick', params: ((event: { domEvent: Event, column: Column }) => boolean|void)|string): boolean|void
2769
2604
  /**
2770
2605
  * This event fires on the owning Grid before the context menu is shown for a header.
2771
2606
  * 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).
2772
2607
  * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceHistogram#event-headerMenuBeforeShow)
2773
2608
  * @param {string} e Event name
2774
2609
  * @param {object} params Event parameters
2775
- * @param {string} params.e Event name
2776
- * @param {object} params.params Event parameters
2777
- * @param {object} params.params.event Event object
2778
- * @param {Grid.view.Grid} params.params.event.source The grid
2779
- * @param {Core.widget.Menu} params.params.event.menu The menu
2780
- * @param {Record<string, MenuItemEntry>} params.params.event.items Menu item configs
2781
- * @param {Grid.column.Column} params.params.event.column Column
2610
+ * @param {object} params.event Event object
2611
+ * @param {Grid.view.Grid} params.event.source The grid
2612
+ * @param {Core.widget.Menu} params.event.menu The menu
2613
+ * @param {Record<string, MenuItemEntry>} params.event.items Menu item configs
2614
+ * @param {Grid.column.Column} params.event.column Column
2782
2615
  */
2783
- (e: 'headerMenuBeforeShow', params: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
2616
+ (e: 'headerMenuBeforeShow', params: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void)|string): boolean|void
2784
2617
  /**
2785
2618
  * This event fires on the owning Grid when an item is selected in the header context menu.
2786
2619
  * @param {string} e Event name
2787
2620
  * @param {object} params Event parameters
2788
- * @param {string} params.e Event name
2789
- * @param {object} params.params Event parameters
2790
- * @param {object} params.params.event Event object
2791
- * @param {Grid.view.Grid} params.params.event.source The grid
2792
- * @param {Core.widget.Menu} params.params.event.menu The menu
2793
- * @param {Core.widget.MenuItem} params.params.event.item Selected menu item
2794
- * @param {Grid.column.Column} params.params.event.column Column
2621
+ * @param {object} params.event Event object
2622
+ * @param {Grid.view.Grid} params.event.source The grid
2623
+ * @param {Core.widget.Menu} params.event.menu The menu
2624
+ * @param {Core.widget.MenuItem} params.event.item Selected menu item
2625
+ * @param {Grid.column.Column} params.event.column Column
2795
2626
  */
2796
2627
  (e: 'headerMenuItem', params: ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column }) => void)|string): void
2797
2628
  /**
2798
2629
  * This event fires on the owning Grid after the context menu is shown for a header
2799
2630
  * @param {string} e Event name
2800
2631
  * @param {object} params Event parameters
2801
- * @param {string} params.e Event name
2802
- * @param {object} params.params Event parameters
2803
- * @param {object} params.params.event Event object
2804
- * @param {Grid.view.Grid} params.params.event.source The grid
2805
- * @param {Core.widget.Menu} params.params.event.menu The menu
2806
- * @param {Record<string, MenuItemEntry>} params.params.event.items Menu item configs
2807
- * @param {Grid.column.Column} params.params.event.column Column
2632
+ * @param {object} params.event Event object
2633
+ * @param {Grid.view.Grid} params.event.source The grid
2634
+ * @param {Core.widget.Menu} params.event.menu The menu
2635
+ * @param {Record<string, MenuItemEntry>} params.event.items Menu item configs
2636
+ * @param {Grid.column.Column} params.event.column Column
2808
2637
  */
2809
2638
  (e: 'headerMenuShow', params: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => void)|string): void
2810
2639
  /**
2811
2640
  * This event fires on the owning Grid when a check item is toggled in the header context menu.
2812
2641
  * @param {string} e Event name
2813
2642
  * @param {object} params Event parameters
2814
- * @param {string} params.e Event name
2815
- * @param {object} params.params Event parameters
2816
- * @param {object} params.params.event Event object
2817
- * @param {Grid.view.Grid} params.params.event.source The grid
2818
- * @param {Core.widget.Menu} params.params.event.menu The menu
2819
- * @param {Core.widget.MenuItem} params.params.event.item Selected menu item
2820
- * @param {Grid.column.Column} params.params.event.column Column
2821
- * @param {boolean} params.params.event.checked Checked or not
2643
+ * @param {object} params.event Event object
2644
+ * @param {Grid.view.Grid} params.event.source The grid
2645
+ * @param {Core.widget.Menu} params.event.menu The menu
2646
+ * @param {Core.widget.MenuItem} params.event.item Selected menu item
2647
+ * @param {Grid.column.Column} params.event.column Column
2648
+ * @param {boolean} params.event.checked Checked or not
2822
2649
  */
2823
2650
  (e: 'headerMenuToggleItem', params: ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column, checked: boolean }) => void)|string): void
2824
2651
  /**
2825
2652
  * Triggered after a widget was hidden
2826
2653
  * @param {string} e Event name
2827
2654
  * @param {object} params Event parameters
2828
- * @param {string} params.e Event name
2829
- * @param {object} params.params Event parameters
2830
- * @param {object} params.params.event Event object
2831
- * @param {Core.widget.Widget} params.params.event.source The widget
2655
+ * @param {object} params.event Event object
2656
+ * @param {Core.widget.Widget} params.event.source The widget
2832
2657
  */
2833
2658
  (e: 'hide', params: ((event: { source: Widget }) => void)|string): void
2834
2659
  /**
@@ -2837,54 +2662,44 @@ const emit = defineEmits<{
2837
2662
  * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceHistogram#event-histogramDataCacheSet)
2838
2663
  * @param {string} e Event name
2839
2664
  * @param {object} params Event parameters
2840
- * @param {string} params.e Event name
2841
- * @param {object} params.params Event parameters
2842
- * @param {object} params.params.event Event object
2843
- * @param {Scheduler.view.TimelineHistogram} params.params.event.source The component instance
2844
- * @param {Core.data.Model} params.params.event.record Record the histogram data of which is ready.
2845
- * @param {object} params.params.event.data The record histogram data.
2665
+ * @param {object} params.event Event object
2666
+ * @param {Scheduler.view.TimelineHistogram} params.event.source The component instance
2667
+ * @param {Core.data.Model} params.event.record Record the histogram data of which is ready.
2668
+ * @param {object} params.event.data The record histogram data.
2846
2669
  */
2847
2670
  (e: 'histogramDataCacheSet', params: ((event: { source: TimelineHistogram, record: Model, data: object }) => void)|string): void
2848
2671
  /**
2849
2672
  * Fires when row locking is enabled.
2850
2673
  * @param {string} e Event name
2851
2674
  * @param {object} params Event parameters
2852
- * @param {string} params.e Event name
2853
- * @param {object} params.params Event parameters
2854
- * @param {object} params.params.event Event object
2855
- * @param {Grid.view.GridBase} params.params.event.clone The created clone
2675
+ * @param {object} params.event Event object
2676
+ * @param {Grid.view.GridBase} params.event.clone The created clone
2856
2677
  */
2857
2678
  (e: 'lockRows', params: ((event: { clone: GridBase }) => void)|string): void
2858
2679
  /**
2859
2680
  * Mouse moved out from element in grid
2860
2681
  * @param {string} e Event name
2861
2682
  * @param {object} params Event parameters
2862
- * @param {string} params.e Event name
2863
- * @param {object} params.params Event parameters
2864
- * @param {object} params.params.event Event object
2865
- * @param {MouseEvent} params.params.event.event The native browser event
2683
+ * @param {object} params.event Event object
2684
+ * @param {MouseEvent} params.event.event The native browser event
2866
2685
  */
2867
2686
  (e: 'mouseOut', params: ((event: { event: MouseEvent }) => void)|string): void
2868
2687
  /**
2869
2688
  * Mouse moved in over element in grid
2870
2689
  * @param {string} e Event name
2871
2690
  * @param {object} params Event parameters
2872
- * @param {string} params.e Event name
2873
- * @param {object} params.params Event parameters
2874
- * @param {object} params.params.event Event object
2875
- * @param {MouseEvent} params.params.event.event The native browser event
2691
+ * @param {object} params.event Event object
2692
+ * @param {MouseEvent} params.event.event The native browser event
2876
2693
  */
2877
2694
  (e: 'mouseOver', params: ((event: { event: MouseEvent }) => void)|string): void
2878
2695
  /**
2879
2696
  * Fires when the requested date range cannot fit into any zoom level higher than the current level.
2880
2697
  * @param {string} e Event name
2881
2698
  * @param {object} params Event parameters
2882
- * @param {string} params.e Event name
2883
- * @param {object} params.params Event parameters
2884
- * @param {object} params.params.event Event object
2885
- * @param {number} params.params.event.currentZoomLevel The current zoom level
2886
- * @param {Date} params.params.event.startDate The requested start date
2887
- * @param {Date} params.params.event.endDate The requested end date
2699
+ * @param {object} params.event Event object
2700
+ * @param {number} params.event.currentZoomLevel The current zoom level
2701
+ * @param {Date} params.event.startDate The requested start date
2702
+ * @param {Date} params.event.endDate The requested end date
2888
2703
  */
2889
2704
  (e: 'noZoomChange', params: ((event: { currentZoomLevel: number, startDate: Date, endDate: Date }) => void)|string): void
2890
2705
  /**
@@ -2893,61 +2708,51 @@ const emit = defineEmits<{
2893
2708
  * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceHistogram#event-paint)
2894
2709
  * @param {string} e Event name
2895
2710
  * @param {object} params Event parameters
2896
- * @param {string} params.e Event name
2897
- * @param {object} params.params Event parameters
2898
- * @param {object} params.params.event Event object
2899
- * @param {Core.widget.Widget} params.params.event.source The widget being painted.
2900
- * @param {boolean} params.params.event.firstPaint `true` if this is the first paint.
2711
+ * @param {object} params.event Event object
2712
+ * @param {Core.widget.Widget} params.event.source The widget being painted.
2713
+ * @param {boolean} params.event.firstPaint `true` if this is the first paint.
2901
2714
  */
2902
2715
  (e: 'paint', params: ((event: { source: Widget, firstPaint: boolean }) => void)|string): void
2903
2716
  /**
2904
2717
  * Fires on the owning Grid after a paste action is performed.
2905
2718
  * @param {string} e Event name
2906
2719
  * @param {object} params Event parameters
2907
- * @param {string} params.e Event name
2908
- * @param {object} params.params Event parameters
2909
- * @param {object} params.params.event Event object
2910
- * @param {Grid.view.Grid} params.params.event.source Owner grid
2911
- * @param {string} params.params.event.clipboardData The clipboardData that was pasted
2912
- * @param {Core.data.Model[]} params.params.event.modifiedRecords The records which have been modified due to the paste action
2913
- * @param {Grid.util.GridLocation} params.params.event.targetCell The cell from which the paste will be started
2914
- * @param {string} params.params.event.entityName 'cell' to distinguish this event from other paste events
2720
+ * @param {object} params.event Event object
2721
+ * @param {Grid.view.Grid} params.event.source Owner grid
2722
+ * @param {string} params.event.clipboardData The clipboardData that was pasted
2723
+ * @param {Core.data.Model[]} params.event.modifiedRecords The records which have been modified due to the paste action
2724
+ * @param {Grid.util.GridLocation} params.event.targetCell The cell from which the paste will be started
2725
+ * @param {string} params.event.entityName 'cell' to distinguish this event from other paste events
2915
2726
  */
2916
2727
  (e: 'paste', params: ((event: { source: Grid, clipboardData: string, modifiedRecords: Model[], targetCell: GridLocation, entityName: string }) => void)|string): void
2917
2728
  /**
2918
2729
  * Fires on the owning Grid when export has finished
2919
2730
  * @param {string} e Event name
2920
2731
  * @param {object} params Event parameters
2921
- * @param {string} params.e Event name
2922
- * @param {object} params.params Event parameters
2923
- * @param {object} params.params.event Event object
2924
- * @param {Response} [params.params.event.response] Optional response, if received
2925
- * @param {Error} [params.params.event.error] Optional error, if exception occurred
2732
+ * @param {object} params.event Event object
2733
+ * @param {Response} [params.event.response] Optional response, if received
2734
+ * @param {Error} [params.event.error] Optional error, if exception occurred
2926
2735
  */
2927
2736
  (e: 'pdfExport', params: ((event: { response?: Response, error?: Error }) => void)|string): void
2928
2737
  /**
2929
2738
  * Fired after the [viewPreset](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/mixin/TimelineViewPresets#config-viewPreset) has changed.
2930
2739
  * @param {string} e Event name
2931
2740
  * @param {object} params Event parameters
2932
- * @param {string} params.e Event name
2933
- * @param {object} params.params Event parameters
2934
- * @param {object} params.params.event Event object
2935
- * @param {Scheduler.view.Scheduler} params.params.event.source This Scheduler instance.
2936
- * @param {Date} params.params.event.startDate The new start date of the timeline.
2937
- * @param {Date} params.params.event.centerDate The new center date of the timeline.
2938
- * @param {Date} params.params.event.endDate The new end date of the timeline.
2939
- * @param {Scheduler.preset.ViewPreset} params.params.event.from The outgoing ViewPreset.
2940
- * @param {Scheduler.preset.ViewPreset} params.params.event.to The ViewPreset being switched to.
2741
+ * @param {object} params.event Event object
2742
+ * @param {Scheduler.view.Scheduler} params.event.source This Scheduler instance.
2743
+ * @param {Date} params.event.startDate The new start date of the timeline.
2744
+ * @param {Date} params.event.centerDate The new center date of the timeline.
2745
+ * @param {Date} params.event.endDate The new end date of the timeline.
2746
+ * @param {Scheduler.preset.ViewPreset} params.event.from The outgoing ViewPreset.
2747
+ * @param {Scheduler.preset.ViewPreset} params.event.to The ViewPreset being switched to.
2941
2748
  */
2942
- (e: 'presetChange', params: ((event: { source: Scheduler, startDate: Date, centerDate: Date, endDate: Date, from: ViewPreset, to: ViewPreset }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
2749
+ (e: 'presetChange', params: ((event: { source: Scheduler, startDate: Date, centerDate: Date, endDate: Date, from: ViewPreset, to: ViewPreset }) => boolean|void)|string): boolean|void
2943
2750
  /**
2944
2751
  * Fired when a Widget's read only state is toggled
2945
2752
  * @param {string} e Event name
2946
2753
  * @param {object} params Event parameters
2947
- * @param {string} params.e Event name
2948
- * @param {object} params.params Event parameters
2949
- * @param {object} params.params.event Event object
2950
- * @param {boolean} params.params.event.readOnly Read only or not
2754
+ * @param {object} params.event Event object
2755
+ * @param {boolean} params.event.readOnly Read only or not
2951
2756
  */
2952
2757
  (e: 'readOnly', params: ((event: { readOnly: boolean }) => void)|string): void
2953
2758
  /**
@@ -2959,37 +2764,31 @@ const emit = defineEmits<{
2959
2764
  * Fires after a row is rendered.
2960
2765
  * @param {string} e Event name
2961
2766
  * @param {object} params Event parameters
2962
- * @param {string} params.e Event name
2963
- * @param {object} params.params Event parameters
2964
- * @param {object} params.params.event Event object
2965
- * @param {Grid.view.GridBase} params.params.event.source The firing Grid instance
2966
- * @param {Grid.row.Row} params.params.event.row The row that has been rendered
2967
- * @param {Core.data.Model} params.params.event.record The record for the row
2968
- * @param {number} params.params.event.recordIndex The zero-based index of the record
2767
+ * @param {object} params.event Event object
2768
+ * @param {Grid.view.GridBase} params.event.source The firing Grid instance
2769
+ * @param {Grid.row.Row} params.event.row The row that has been rendered
2770
+ * @param {Core.data.Model} params.event.record The record for the row
2771
+ * @param {number} params.event.recordIndex The zero-based index of the record
2969
2772
  */
2970
2773
  (e: 'renderRow', params: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string): void
2971
2774
  /**
2972
2775
  * Grid rows have been rendered
2973
2776
  * @param {string} e Event name
2974
2777
  * @param {object} params Event parameters
2975
- * @param {string} params.e Event name
2976
- * @param {object} params.params Event parameters
2977
- * @param {object} params.params.event Event object
2978
- * @param {Grid.view.GridBase} params.params.event.source This grid.
2778
+ * @param {object} params.event Event object
2779
+ * @param {Grid.view.GridBase} params.event.source This grid.
2979
2780
  */
2980
2781
  (e: 'renderRows', params: ((event: { source: GridBase }) => void)|string): void
2981
2782
  /**
2982
2783
  * 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`*.
2983
2784
  * @param {string} e Event name
2984
2785
  * @param {object} params Event parameters
2985
- * @param {string} params.e Event name
2986
- * @param {object} params.params Event parameters
2987
- * @param {object} params.params.event Event object
2988
- * @param {Core.widget.Widget} params.params.event.source This Widget
2989
- * @param {number} params.params.event.width The new width
2990
- * @param {number} params.params.event.height The new height
2991
- * @param {number} params.params.event.oldWidth The old width
2992
- * @param {number} params.params.event.oldHeight The old height
2786
+ * @param {object} params.event Event object
2787
+ * @param {Core.widget.Widget} params.event.source This Widget
2788
+ * @param {number} params.event.width The new width
2789
+ * @param {number} params.event.height The new height
2790
+ * @param {number} params.event.oldWidth The old width
2791
+ * @param {number} params.event.oldHeight The old height
2993
2792
  */
2994
2793
  (e: 'resize', params: ((event: { source: Widget, width: number, height: number, oldWidth: number, oldHeight: number }) => void)|string): void
2995
2794
  /**
@@ -2998,54 +2797,46 @@ const emit = defineEmits<{
2998
2797
  * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceHistogram#event-resourceMenuBeforeShow)
2999
2798
  * @param {string} e Event name
3000
2799
  * @param {object} params Event parameters
3001
- * @param {string} params.e Event name
3002
- * @param {object} params.params Event parameters
3003
- * @param {object} params.params.event Event object
3004
- * @param {Scheduler.view.Scheduler} params.params.event.source The grid
3005
- * @param {Core.widget.Menu} params.params.event.menu The menu
3006
- * @param {Record<string, MenuItemEntry>} params.params.event.items Menu item configs
3007
- * @param {Grid.column.Column} params.params.event.column Column
3008
- * @param {Scheduler.model.SchedulerResourceModel} params.params.event.resourceRecord Record
2800
+ * @param {object} params.event Event object
2801
+ * @param {Scheduler.view.Scheduler} params.event.source The grid
2802
+ * @param {Core.widget.Menu} params.event.menu The menu
2803
+ * @param {Record<string, MenuItemEntry>} params.event.items Menu item configs
2804
+ * @param {Grid.column.Column} params.event.column Column
2805
+ * @param {Scheduler.model.SchedulerResourceModel} params.event.resourceRecord Record
3009
2806
  */
3010
- (e: 'resourceMenuBeforeShow', params: ((event: { source: Scheduler, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, resourceRecord: SchedulerResourceModel }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
2807
+ (e: 'resourceMenuBeforeShow', params: ((event: { source: Scheduler, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, resourceRecord: SchedulerResourceModel }) => boolean|void)|string): boolean|void
3011
2808
  /**
3012
2809
  * This event fires on the owning scheduler when an item is selected in the context menu.
3013
2810
  * @param {string} e Event name
3014
2811
  * @param {object} params Event parameters
3015
- * @param {string} params.e Event name
3016
- * @param {object} params.params Event parameters
3017
- * @param {object} params.params.event Event object
3018
- * @param {Scheduler.view.Scheduler} params.params.event.source The grid
3019
- * @param {Core.widget.Menu} params.params.event.menu The menu
3020
- * @param {Core.widget.MenuItem} params.params.event.item Selected menu item
3021
- * @param {Scheduler.model.SchedulerResourceModel} params.params.event.record Record
2812
+ * @param {object} params.event Event object
2813
+ * @param {Scheduler.view.Scheduler} params.event.source The grid
2814
+ * @param {Core.widget.Menu} params.event.menu The menu
2815
+ * @param {Core.widget.MenuItem} params.event.item Selected menu item
2816
+ * @param {Scheduler.model.SchedulerResourceModel} params.event.record Record
3022
2817
  */
3023
2818
  (e: 'resourceMenuItem', params: ((event: { source: Scheduler, menu: Menu, item: MenuItem, record: SchedulerResourceModel }) => void)|string): void
3024
2819
  /**
3025
2820
  * This event fires on the owning scheduler after the context menu is shown for a resource.
3026
2821
  * @param {string} e Event name
3027
2822
  * @param {object} params Event parameters
3028
- * @param {string} params.e Event name
3029
- * @param {object} params.params Event parameters
3030
- * @param {object} params.params.event Event object
3031
- * @param {Scheduler.view.Scheduler} params.params.event.source The grid
3032
- * @param {Core.widget.Menu} params.params.event.menu The menu
3033
- * @param {Record<string, MenuItemEntry>} params.params.event.items Menu item configs
3034
- * @param {Scheduler.model.SchedulerResourceModel} params.params.event.record Record
2823
+ * @param {object} params.event Event object
2824
+ * @param {Scheduler.view.Scheduler} params.event.source The grid
2825
+ * @param {Core.widget.Menu} params.event.menu The menu
2826
+ * @param {Record<string, MenuItemEntry>} params.event.items Menu item configs
2827
+ * @param {Scheduler.model.SchedulerResourceModel} params.event.record Record
3035
2828
  */
3036
2829
  (e: 'resourceMenuShow', params: ((event: { source: Scheduler, menu: Menu, items: Record<string, MenuItemEntry>, record: SchedulerResourceModel }) => void)|string): void
3037
2830
  /**
3038
2831
  * This event fires on the owning grid when a check item is toggled in the context menu.
3039
2832
  * @param {string} e Event name
3040
2833
  * @param {object} params Event parameters
3041
- * @param {string} params.e Event name
3042
- * @param {object} params.params Event parameters
3043
- * @param {object} params.params.event Event object
3044
- * @param {Scheduler.view.Scheduler} params.params.event.source The grid
3045
- * @param {Core.widget.Menu} params.params.event.menu The menu
3046
- * @param {Core.widget.MenuItem} params.params.event.item Selected menu item
3047
- * @param {Scheduler.model.SchedulerResourceModel} params.params.event.resourceRecord Record
3048
- * @param {boolean} params.params.event.checked Checked or not
2834
+ * @param {object} params.event Event object
2835
+ * @param {Scheduler.view.Scheduler} params.event.source The grid
2836
+ * @param {Core.widget.Menu} params.event.menu The menu
2837
+ * @param {Core.widget.MenuItem} params.event.item Selected menu item
2838
+ * @param {Scheduler.model.SchedulerResourceModel} params.event.resourceRecord Record
2839
+ * @param {boolean} params.event.checked Checked or not
3049
2840
  */
3050
2841
  (e: 'resourceMenuToggleItem', params: ((event: { source: Scheduler, menu: Menu, item: MenuItem, resourceRecord: SchedulerResourceModel, checked: boolean }) => void)|string): void
3051
2842
  /**
@@ -3053,14 +2844,12 @@ const emit = defineEmits<{
3053
2844
  * `enableMouseEvents: true`.
3054
2845
  * @param {string} e Event name
3055
2846
  * @param {object} params Event parameters
3056
- * @param {string} params.e Event name
3057
- * @param {object} params.params Event parameters
3058
- * @param {object} params.params.event Event object
3059
- * @param {SchedulerPro.view.SchedulerPro} params.params.event.source This Scheduler
3060
- * @param {SchedulerPro.feature.ResourceNonWorkingTime} params.params.event.feature The ResourceNonWorkingTime feature
3061
- * @param {Scheduler.model.ResourceTimeRangeModel} params.params.event.resourceTimeRangeRecord Resource time range record
3062
- * @param {Scheduler.model.SchedulerResourceModel} params.params.event.resourceRecord Resource record
3063
- * @param {MouseEvent} params.params.event.domEvent Browser event
2847
+ * @param {object} params.event Event object
2848
+ * @param {SchedulerPro.view.SchedulerPro} params.event.source This Scheduler
2849
+ * @param {SchedulerPro.feature.ResourceNonWorkingTime} params.event.feature The ResourceNonWorkingTime feature
2850
+ * @param {Scheduler.model.ResourceTimeRangeModel} params.event.resourceTimeRangeRecord Resource time range record
2851
+ * @param {Scheduler.model.SchedulerResourceModel} params.event.resourceRecord Resource record
2852
+ * @param {MouseEvent} params.event.domEvent Browser event
3064
2853
  */
3065
2854
  (e: 'resourceNonWorkingTimeClick', params: ((event: { source: SchedulerPro, feature: ResourceNonWorkingTime, resourceTimeRangeRecord: ResourceTimeRangeModel, resourceRecord: SchedulerResourceModel, domEvent: MouseEvent }) => void)|string): void
3066
2855
  /**
@@ -3068,14 +2857,12 @@ const emit = defineEmits<{
3068
2857
  * with `enableMouseEvents: true`.
3069
2858
  * @param {string} e Event name
3070
2859
  * @param {object} params Event parameters
3071
- * @param {string} params.e Event name
3072
- * @param {object} params.params Event parameters
3073
- * @param {object} params.params.event Event object
3074
- * @param {SchedulerPro.view.SchedulerPro} params.params.event.source This Scheduler
3075
- * @param {SchedulerPro.feature.ResourceNonWorkingTime} params.params.event.feature The ResourceNonWorkingTime feature
3076
- * @param {Scheduler.model.ResourceTimeRangeModel} params.params.event.resourceTimeRangeRecord Resource time range record
3077
- * @param {Scheduler.model.SchedulerResourceModel} params.params.event.resourceRecord Resource record
3078
- * @param {MouseEvent} params.params.event.domEvent Browser event
2860
+ * @param {object} params.event Event object
2861
+ * @param {SchedulerPro.view.SchedulerPro} params.event.source This Scheduler
2862
+ * @param {SchedulerPro.feature.ResourceNonWorkingTime} params.event.feature The ResourceNonWorkingTime feature
2863
+ * @param {Scheduler.model.ResourceTimeRangeModel} params.event.resourceTimeRangeRecord Resource time range record
2864
+ * @param {Scheduler.model.SchedulerResourceModel} params.event.resourceRecord Resource record
2865
+ * @param {MouseEvent} params.event.domEvent Browser event
3079
2866
  */
3080
2867
  (e: 'resourceNonWorkingTimeContextMenu', params: ((event: { source: SchedulerPro, feature: ResourceNonWorkingTime, resourceTimeRangeRecord: ResourceTimeRangeModel, resourceRecord: SchedulerResourceModel, domEvent: MouseEvent }) => void)|string): void
3081
2868
  /**
@@ -3083,14 +2870,12 @@ const emit = defineEmits<{
3083
2870
  * with `enableMouseEvents: true`.
3084
2871
  * @param {string} e Event name
3085
2872
  * @param {object} params Event parameters
3086
- * @param {string} params.e Event name
3087
- * @param {object} params.params Event parameters
3088
- * @param {object} params.params.event Event object
3089
- * @param {SchedulerPro.view.SchedulerPro} params.params.event.source This Scheduler
3090
- * @param {SchedulerPro.feature.ResourceNonWorkingTime} params.params.event.feature The ResourceNonWorkingTime feature
3091
- * @param {Scheduler.model.ResourceTimeRangeModel} params.params.event.resourceTimeRangeRecord Resource time range record
3092
- * @param {Scheduler.model.SchedulerResourceModel} params.params.event.resourceRecord Resource record
3093
- * @param {MouseEvent} params.params.event.domEvent Browser event
2873
+ * @param {object} params.event Event object
2874
+ * @param {SchedulerPro.view.SchedulerPro} params.event.source This Scheduler
2875
+ * @param {SchedulerPro.feature.ResourceNonWorkingTime} params.event.feature The ResourceNonWorkingTime feature
2876
+ * @param {Scheduler.model.ResourceTimeRangeModel} params.event.resourceTimeRangeRecord Resource time range record
2877
+ * @param {Scheduler.model.SchedulerResourceModel} params.event.resourceRecord Resource record
2878
+ * @param {MouseEvent} params.event.domEvent Browser event
3094
2879
  */
3095
2880
  (e: 'resourceNonWorkingTimeDblClick', params: ((event: { source: SchedulerPro, feature: ResourceNonWorkingTime, resourceTimeRangeRecord: ResourceTimeRangeModel, resourceRecord: SchedulerResourceModel, domEvent: MouseEvent }) => void)|string): void
3096
2881
  /**
@@ -3098,14 +2883,12 @@ const emit = defineEmits<{
3098
2883
  * with `enableMouseEvents: true`.
3099
2884
  * @param {string} e Event name
3100
2885
  * @param {object} params Event parameters
3101
- * @param {string} params.e Event name
3102
- * @param {object} params.params Event parameters
3103
- * @param {object} params.params.event Event object
3104
- * @param {SchedulerPro.view.SchedulerPro} params.params.event.source This Scheduler
3105
- * @param {SchedulerPro.feature.ResourceNonWorkingTime} params.params.event.feature The ResourceNonWorkingTime feature
3106
- * @param {Scheduler.model.ResourceTimeRangeModel} params.params.event.resourceTimeRangeRecord Resource time range record
3107
- * @param {Scheduler.model.SchedulerResourceModel} params.params.event.resourceRecord Resource record
3108
- * @param {MouseEvent} params.params.event.domEvent Browser event
2886
+ * @param {object} params.event Event object
2887
+ * @param {SchedulerPro.view.SchedulerPro} params.event.source This Scheduler
2888
+ * @param {SchedulerPro.feature.ResourceNonWorkingTime} params.event.feature The ResourceNonWorkingTime feature
2889
+ * @param {Scheduler.model.ResourceTimeRangeModel} params.event.resourceTimeRangeRecord Resource time range record
2890
+ * @param {Scheduler.model.SchedulerResourceModel} params.event.resourceRecord Resource record
2891
+ * @param {MouseEvent} params.event.domEvent Browser event
3109
2892
  */
3110
2893
  (e: 'resourceNonWorkingTimeMouseDown', params: ((event: { source: SchedulerPro, feature: ResourceNonWorkingTime, resourceTimeRangeRecord: ResourceTimeRangeModel, resourceRecord: SchedulerResourceModel, domEvent: MouseEvent }) => void)|string): void
3111
2894
  /**
@@ -3113,14 +2896,12 @@ const emit = defineEmits<{
3113
2896
  * with `enableMouseEvents: true`.
3114
2897
  * @param {string} e Event name
3115
2898
  * @param {object} params Event parameters
3116
- * @param {string} params.e Event name
3117
- * @param {object} params.params Event parameters
3118
- * @param {object} params.params.event Event object
3119
- * @param {SchedulerPro.view.SchedulerPro} params.params.event.source This Scheduler
3120
- * @param {SchedulerPro.feature.ResourceNonWorkingTime} params.params.event.feature The ResourceNonWorkingTime feature
3121
- * @param {Scheduler.model.ResourceTimeRangeModel} params.params.event.resourceTimeRangeRecord Resource time range record
3122
- * @param {Scheduler.model.SchedulerResourceModel} params.params.event.resourceRecord Resource record
3123
- * @param {MouseEvent} params.params.event.domEvent Browser event
2899
+ * @param {object} params.event Event object
2900
+ * @param {SchedulerPro.view.SchedulerPro} params.event.source This Scheduler
2901
+ * @param {SchedulerPro.feature.ResourceNonWorkingTime} params.event.feature The ResourceNonWorkingTime feature
2902
+ * @param {Scheduler.model.ResourceTimeRangeModel} params.event.resourceTimeRangeRecord Resource time range record
2903
+ * @param {Scheduler.model.SchedulerResourceModel} params.event.resourceRecord Resource record
2904
+ * @param {MouseEvent} params.event.domEvent Browser event
3124
2905
  */
3125
2906
  (e: 'resourceNonWorkingTimeMouseOut', params: ((event: { source: SchedulerPro, feature: ResourceNonWorkingTime, resourceTimeRangeRecord: ResourceTimeRangeModel, resourceRecord: SchedulerResourceModel, domEvent: MouseEvent }) => void)|string): void
3126
2907
  /**
@@ -3128,14 +2909,12 @@ const emit = defineEmits<{
3128
2909
  * with `enableMouseEvents: true`.
3129
2910
  * @param {string} e Event name
3130
2911
  * @param {object} params Event parameters
3131
- * @param {string} params.e Event name
3132
- * @param {object} params.params Event parameters
3133
- * @param {object} params.params.event Event object
3134
- * @param {SchedulerPro.view.SchedulerPro} params.params.event.source This Scheduler
3135
- * @param {SchedulerPro.feature.ResourceNonWorkingTime} params.params.event.feature The ResourceNonWorkingTime feature
3136
- * @param {Scheduler.model.ResourceTimeRangeModel} params.params.event.resourceTimeRangeRecord Resource time range record
3137
- * @param {Scheduler.model.SchedulerResourceModel} params.params.event.resourceRecord Resource record
3138
- * @param {MouseEvent} params.params.event.domEvent Browser event
2912
+ * @param {object} params.event Event object
2913
+ * @param {SchedulerPro.view.SchedulerPro} params.event.source This Scheduler
2914
+ * @param {SchedulerPro.feature.ResourceNonWorkingTime} params.event.feature The ResourceNonWorkingTime feature
2915
+ * @param {Scheduler.model.ResourceTimeRangeModel} params.event.resourceTimeRangeRecord Resource time range record
2916
+ * @param {Scheduler.model.SchedulerResourceModel} params.event.resourceRecord Resource record
2917
+ * @param {MouseEvent} params.event.domEvent Browser event
3139
2918
  */
3140
2919
  (e: 'resourceNonWorkingTimeMouseOver', params: ((event: { source: SchedulerPro, feature: ResourceNonWorkingTime, resourceTimeRangeRecord: ResourceTimeRangeModel, resourceRecord: SchedulerResourceModel, domEvent: MouseEvent }) => void)|string): void
3141
2920
  /**
@@ -3143,14 +2922,12 @@ const emit = defineEmits<{
3143
2922
  * with `enableMouseEvents: true`.
3144
2923
  * @param {string} e Event name
3145
2924
  * @param {object} params Event parameters
3146
- * @param {string} params.e Event name
3147
- * @param {object} params.params Event parameters
3148
- * @param {object} params.params.event Event object
3149
- * @param {SchedulerPro.view.SchedulerPro} params.params.event.source This Scheduler
3150
- * @param {SchedulerPro.feature.ResourceNonWorkingTime} params.params.event.feature The ResourceNonWorkingTime feature
3151
- * @param {Scheduler.model.ResourceTimeRangeModel} params.params.event.resourceTimeRangeRecord Resource time range record
3152
- * @param {Scheduler.model.SchedulerResourceModel} params.params.event.resourceRecord Resource record
3153
- * @param {MouseEvent} params.params.event.domEvent Browser event
2925
+ * @param {object} params.event Event object
2926
+ * @param {SchedulerPro.view.SchedulerPro} params.event.source This Scheduler
2927
+ * @param {SchedulerPro.feature.ResourceNonWorkingTime} params.event.feature The ResourceNonWorkingTime feature
2928
+ * @param {Scheduler.model.ResourceTimeRangeModel} params.event.resourceTimeRangeRecord Resource time range record
2929
+ * @param {Scheduler.model.SchedulerResourceModel} params.event.resourceRecord Resource record
2930
+ * @param {MouseEvent} params.event.domEvent Browser event
3154
2931
  */
3155
2932
  (e: 'resourceNonWorkingTimeMouseUp', params: ((event: { source: SchedulerPro, feature: ResourceNonWorkingTime, resourceTimeRangeRecord: ResourceTimeRangeModel, resourceRecord: SchedulerResourceModel, domEvent: MouseEvent }) => void)|string): void
3156
2933
  /**
@@ -3158,14 +2935,12 @@ const emit = defineEmits<{
3158
2935
  * `enableMouseEvents: true`.
3159
2936
  * @param {string} e Event name
3160
2937
  * @param {object} params Event parameters
3161
- * @param {string} params.e Event name
3162
- * @param {object} params.params Event parameters
3163
- * @param {object} params.params.event Event object
3164
- * @param {Scheduler.view.Scheduler} params.params.event.source This Scheduler
3165
- * @param {Scheduler.feature.ResourceTimeRanges} params.params.event.feature The ResourceTimeRange feature
3166
- * @param {Scheduler.model.ResourceTimeRangeModel} params.params.event.resourceTimeRangeRecord Resource time range record
3167
- * @param {Scheduler.model.SchedulerResourceModel} params.params.event.resourceRecord Resource record
3168
- * @param {MouseEvent} params.params.event.domEvent Browser event
2938
+ * @param {object} params.event Event object
2939
+ * @param {Scheduler.view.Scheduler} params.event.source This Scheduler
2940
+ * @param {Scheduler.feature.ResourceTimeRanges} params.event.feature The ResourceTimeRange feature
2941
+ * @param {Scheduler.model.ResourceTimeRangeModel} params.event.resourceTimeRangeRecord Resource time range record
2942
+ * @param {Scheduler.model.SchedulerResourceModel} params.event.resourceRecord Resource record
2943
+ * @param {MouseEvent} params.event.domEvent Browser event
3169
2944
  */
3170
2945
  (e: 'resourceTimeRangeClick', params: ((event: { source: Scheduler, feature: ResourceTimeRanges, resourceTimeRangeRecord: ResourceTimeRangeModel, resourceRecord: SchedulerResourceModel, domEvent: MouseEvent }) => void)|string): void
3171
2946
  /**
@@ -3173,14 +2948,12 @@ const emit = defineEmits<{
3173
2948
  * with `enableMouseEvents: true`.
3174
2949
  * @param {string} e Event name
3175
2950
  * @param {object} params Event parameters
3176
- * @param {string} params.e Event name
3177
- * @param {object} params.params Event parameters
3178
- * @param {object} params.params.event Event object
3179
- * @param {Scheduler.view.Scheduler} params.params.event.source This Scheduler
3180
- * @param {Scheduler.feature.ResourceTimeRanges} params.params.event.feature The ResourceTimeRange feature
3181
- * @param {Scheduler.model.ResourceTimeRangeModel} params.params.event.resourceTimeRangeRecord Resource time range record
3182
- * @param {Scheduler.model.SchedulerResourceModel} params.params.event.resourceRecord Resource record
3183
- * @param {MouseEvent} params.params.event.domEvent Browser event
2951
+ * @param {object} params.event Event object
2952
+ * @param {Scheduler.view.Scheduler} params.event.source This Scheduler
2953
+ * @param {Scheduler.feature.ResourceTimeRanges} params.event.feature The ResourceTimeRange feature
2954
+ * @param {Scheduler.model.ResourceTimeRangeModel} params.event.resourceTimeRangeRecord Resource time range record
2955
+ * @param {Scheduler.model.SchedulerResourceModel} params.event.resourceRecord Resource record
2956
+ * @param {MouseEvent} params.event.domEvent Browser event
3184
2957
  */
3185
2958
  (e: 'resourceTimeRangeContextMenu', params: ((event: { source: Scheduler, feature: ResourceTimeRanges, resourceTimeRangeRecord: ResourceTimeRangeModel, resourceRecord: SchedulerResourceModel, domEvent: MouseEvent }) => void)|string): void
3186
2959
  /**
@@ -3188,14 +2961,12 @@ const emit = defineEmits<{
3188
2961
  * with `enableMouseEvents: true`.
3189
2962
  * @param {string} e Event name
3190
2963
  * @param {object} params Event parameters
3191
- * @param {string} params.e Event name
3192
- * @param {object} params.params Event parameters
3193
- * @param {object} params.params.event Event object
3194
- * @param {Scheduler.view.Scheduler} params.params.event.source This Scheduler
3195
- * @param {Scheduler.feature.ResourceTimeRanges} params.params.event.feature The ResourceTimeRange feature
3196
- * @param {Scheduler.model.ResourceTimeRangeModel} params.params.event.resourceTimeRangeRecord Resource time range record
3197
- * @param {Scheduler.model.SchedulerResourceModel} params.params.event.resourceRecord Resource record
3198
- * @param {MouseEvent} params.params.event.domEvent Browser event
2964
+ * @param {object} params.event Event object
2965
+ * @param {Scheduler.view.Scheduler} params.event.source This Scheduler
2966
+ * @param {Scheduler.feature.ResourceTimeRanges} params.event.feature The ResourceTimeRange feature
2967
+ * @param {Scheduler.model.ResourceTimeRangeModel} params.event.resourceTimeRangeRecord Resource time range record
2968
+ * @param {Scheduler.model.SchedulerResourceModel} params.event.resourceRecord Resource record
2969
+ * @param {MouseEvent} params.event.domEvent Browser event
3199
2970
  */
3200
2971
  (e: 'resourceTimeRangeDblClick', params: ((event: { source: Scheduler, feature: ResourceTimeRanges, resourceTimeRangeRecord: ResourceTimeRangeModel, resourceRecord: SchedulerResourceModel, domEvent: MouseEvent }) => void)|string): void
3201
2972
  /**
@@ -3203,14 +2974,12 @@ const emit = defineEmits<{
3203
2974
  * with `enableMouseEvents: true`.
3204
2975
  * @param {string} e Event name
3205
2976
  * @param {object} params Event parameters
3206
- * @param {string} params.e Event name
3207
- * @param {object} params.params Event parameters
3208
- * @param {object} params.params.event Event object
3209
- * @param {Scheduler.view.Scheduler} params.params.event.source This Scheduler
3210
- * @param {Scheduler.feature.ResourceTimeRanges} params.params.event.feature The ResourceTimeRange feature
3211
- * @param {Scheduler.model.ResourceTimeRangeModel} params.params.event.resourceTimeRangeRecord Resource time range record
3212
- * @param {Scheduler.model.SchedulerResourceModel} params.params.event.resourceRecord Resource record
3213
- * @param {MouseEvent} params.params.event.domEvent Browser event
2977
+ * @param {object} params.event Event object
2978
+ * @param {Scheduler.view.Scheduler} params.event.source This Scheduler
2979
+ * @param {Scheduler.feature.ResourceTimeRanges} params.event.feature The ResourceTimeRange feature
2980
+ * @param {Scheduler.model.ResourceTimeRangeModel} params.event.resourceTimeRangeRecord Resource time range record
2981
+ * @param {Scheduler.model.SchedulerResourceModel} params.event.resourceRecord Resource record
2982
+ * @param {MouseEvent} params.event.domEvent Browser event
3214
2983
  */
3215
2984
  (e: 'resourceTimeRangeMouseDown', params: ((event: { source: Scheduler, feature: ResourceTimeRanges, resourceTimeRangeRecord: ResourceTimeRangeModel, resourceRecord: SchedulerResourceModel, domEvent: MouseEvent }) => void)|string): void
3216
2985
  /**
@@ -3218,14 +2987,12 @@ const emit = defineEmits<{
3218
2987
  * with `enableMouseEvents: true`.
3219
2988
  * @param {string} e Event name
3220
2989
  * @param {object} params Event parameters
3221
- * @param {string} params.e Event name
3222
- * @param {object} params.params Event parameters
3223
- * @param {object} params.params.event Event object
3224
- * @param {Scheduler.view.Scheduler} params.params.event.source This Scheduler
3225
- * @param {Scheduler.feature.ResourceTimeRanges} params.params.event.feature The ResourceTimeRange feature
3226
- * @param {Scheduler.model.ResourceTimeRangeModel} params.params.event.resourceTimeRangeRecord Resource time range record
3227
- * @param {Scheduler.model.SchedulerResourceModel} params.params.event.resourceRecord Resource record
3228
- * @param {MouseEvent} params.params.event.domEvent Browser event
2990
+ * @param {object} params.event Event object
2991
+ * @param {Scheduler.view.Scheduler} params.event.source This Scheduler
2992
+ * @param {Scheduler.feature.ResourceTimeRanges} params.event.feature The ResourceTimeRange feature
2993
+ * @param {Scheduler.model.ResourceTimeRangeModel} params.event.resourceTimeRangeRecord Resource time range record
2994
+ * @param {Scheduler.model.SchedulerResourceModel} params.event.resourceRecord Resource record
2995
+ * @param {MouseEvent} params.event.domEvent Browser event
3229
2996
  */
3230
2997
  (e: 'resourceTimeRangeMouseOut', params: ((event: { source: Scheduler, feature: ResourceTimeRanges, resourceTimeRangeRecord: ResourceTimeRangeModel, resourceRecord: SchedulerResourceModel, domEvent: MouseEvent }) => void)|string): void
3231
2998
  /**
@@ -3233,14 +3000,12 @@ const emit = defineEmits<{
3233
3000
  * with `enableMouseEvents: true`.
3234
3001
  * @param {string} e Event name
3235
3002
  * @param {object} params Event parameters
3236
- * @param {string} params.e Event name
3237
- * @param {object} params.params Event parameters
3238
- * @param {object} params.params.event Event object
3239
- * @param {Scheduler.view.Scheduler} params.params.event.source This Scheduler
3240
- * @param {Scheduler.feature.ResourceTimeRanges} params.params.event.feature The ResourceTimeRange feature
3241
- * @param {Scheduler.model.ResourceTimeRangeModel} params.params.event.resourceTimeRangeRecord Resource time range record
3242
- * @param {Scheduler.model.SchedulerResourceModel} params.params.event.resourceRecord Resource record
3243
- * @param {MouseEvent} params.params.event.domEvent Browser event
3003
+ * @param {object} params.event Event object
3004
+ * @param {Scheduler.view.Scheduler} params.event.source This Scheduler
3005
+ * @param {Scheduler.feature.ResourceTimeRanges} params.event.feature The ResourceTimeRange feature
3006
+ * @param {Scheduler.model.ResourceTimeRangeModel} params.event.resourceTimeRangeRecord Resource time range record
3007
+ * @param {Scheduler.model.SchedulerResourceModel} params.event.resourceRecord Resource record
3008
+ * @param {MouseEvent} params.event.domEvent Browser event
3244
3009
  */
3245
3010
  (e: 'resourceTimeRangeMouseOver', params: ((event: { source: Scheduler, feature: ResourceTimeRanges, resourceTimeRangeRecord: ResourceTimeRangeModel, resourceRecord: SchedulerResourceModel, domEvent: MouseEvent }) => void)|string): void
3246
3011
  /**
@@ -3248,38 +3013,32 @@ const emit = defineEmits<{
3248
3013
  * with `enableMouseEvents: true`.
3249
3014
  * @param {string} e Event name
3250
3015
  * @param {object} params Event parameters
3251
- * @param {string} params.e Event name
3252
- * @param {object} params.params Event parameters
3253
- * @param {object} params.params.event Event object
3254
- * @param {Scheduler.view.Scheduler} params.params.event.source This Scheduler
3255
- * @param {Scheduler.feature.ResourceTimeRanges} params.params.event.feature The ResourceTimeRange feature
3256
- * @param {Scheduler.model.ResourceTimeRangeModel} params.params.event.resourceTimeRangeRecord Resource time range record
3257
- * @param {Scheduler.model.SchedulerResourceModel} params.params.event.resourceRecord Resource record
3258
- * @param {MouseEvent} params.params.event.domEvent Browser event
3016
+ * @param {object} params.event Event object
3017
+ * @param {Scheduler.view.Scheduler} params.event.source This Scheduler
3018
+ * @param {Scheduler.feature.ResourceTimeRanges} params.event.feature The ResourceTimeRange feature
3019
+ * @param {Scheduler.model.ResourceTimeRangeModel} params.event.resourceTimeRangeRecord Resource time range record
3020
+ * @param {Scheduler.model.SchedulerResourceModel} params.event.resourceRecord Resource record
3021
+ * @param {MouseEvent} params.event.domEvent Browser event
3259
3022
  */
3260
3023
  (e: 'resourceTimeRangeMouseUp', params: ((event: { source: Scheduler, feature: ResourceTimeRanges, resourceTimeRangeRecord: ResourceTimeRangeModel, resourceRecord: SchedulerResourceModel, domEvent: MouseEvent }) => void)|string): void
3261
3024
  /**
3262
3025
  * Grid resize lead to a new responsive level being applied
3263
3026
  * @param {string} e Event name
3264
3027
  * @param {object} params Event parameters
3265
- * @param {string} params.e Event name
3266
- * @param {object} params.params Event parameters
3267
- * @param {object} params.params.event Event object
3268
- * @param {Grid.view.Grid} params.params.event.grid Grid that was resized
3269
- * @param {string} params.params.event.level New responsive level (small, large, etc)
3270
- * @param {number} params.params.event.width New width in px
3271
- * @param {string} params.params.event.oldLevel Old responsive level
3272
- * @param {number} params.params.event.oldWidth Old width in px
3028
+ * @param {object} params.event Event object
3029
+ * @param {Grid.view.Grid} params.event.grid Grid that was resized
3030
+ * @param {string} params.event.level New responsive level (small, large, etc)
3031
+ * @param {number} params.event.width New width in px
3032
+ * @param {string} params.event.oldLevel Old responsive level
3033
+ * @param {number} params.event.oldWidth Old width in px
3273
3034
  */
3274
3035
  (e: 'responsive', params: ((event: { grid: Grid, level: string, width: number, oldLevel: string, oldWidth: number }) => void)|string): void
3275
3036
  /**
3276
3037
  * This event fires when a row has finished collapsing.
3277
3038
  * @param {string} e Event name
3278
3039
  * @param {object} params Event parameters
3279
- * @param {string} params.e Event name
3280
- * @param {object} params.params Event parameters
3281
- * @param {object} params.params.event Event object
3282
- * @param {Core.data.Model} params.params.event.record Record
3040
+ * @param {object} params.event Event object
3041
+ * @param {Core.data.Model} params.event.record Record
3283
3042
  */
3284
3043
  (e: 'rowCollapse', params: ((event: { record: Model }) => void)|string): void
3285
3044
  /**
@@ -3287,103 +3046,87 @@ const emit = defineEmits<{
3287
3046
  * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceHistogram#event-rowExpand)
3288
3047
  * @param {string} e Event name
3289
3048
  * @param {object} params Event parameters
3290
- * @param {string} params.e Event name
3291
- * @param {object} params.params Event parameters
3292
- * @param {object} params.params.event Event object
3293
- * @param {Core.data.Model} params.params.event.record Record
3294
- * @param {object} params.params.event.expandedElements An object with the Grid region name as property and the expanded body element as value
3295
- * @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.
3296
- * @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
3049
+ * @param {object} params.event Event object
3050
+ * @param {Core.data.Model} params.event.record Record
3051
+ * @param {object} params.event.expandedElements An object with the Grid region name as property and the expanded body element as value
3052
+ * @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.
3053
+ * @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
3297
3054
  */
3298
3055
  (e: 'rowExpand', params: ((event: { record: Model, expandedElements: object, widget: Widget, widgets: object }) => void)|string): void
3299
3056
  /**
3300
3057
  * Fired when the mouse enters a row
3301
3058
  * @param {string} e Event name
3302
3059
  * @param {object} params Event parameters
3303
- * @param {string} params.e Event name
3304
- * @param {object} params.params Event parameters
3305
- * @param {object} params.params.event Event object
3306
- * @param {Grid.view.Grid} params.params.event.source The grid instance
3307
- * @param {Core.data.Model} params.params.event.record The record representing the hovered row
3308
- * @param {Grid.column.Column} params.params.event.column The column currently hovered
3309
- * @param {HTMLElement} params.params.event.cellElement The cell HTML element
3310
- * @param {MouseEvent} params.params.event.event The native DOM event
3060
+ * @param {object} params.event Event object
3061
+ * @param {Grid.view.Grid} params.event.source The grid instance
3062
+ * @param {Core.data.Model} params.event.record The record representing the hovered row
3063
+ * @param {Grid.column.Column} params.event.column The column currently hovered
3064
+ * @param {HTMLElement} params.event.cellElement The cell HTML element
3065
+ * @param {MouseEvent} params.event.event The native DOM event
3311
3066
  */
3312
3067
  (e: 'rowMouseEnter', params: ((event: { source: Grid, record: Model, column: Column, cellElement: HTMLElement, event: MouseEvent }) => void)|string): void
3313
3068
  /**
3314
3069
  * Fired when the mouse leaves a row
3315
3070
  * @param {string} e Event name
3316
3071
  * @param {object} params Event parameters
3317
- * @param {string} params.e Event name
3318
- * @param {object} params.params Event parameters
3319
- * @param {object} params.params.event Event object
3320
- * @param {Grid.view.Grid} params.params.event.source The grid instance
3321
- * @param {Core.data.Model} params.params.event.record The record representing the row that the mouse left
3322
- * @param {HTMLElement} params.params.event.cellElement The cell HTML element that the mouse left
3323
- * @param {MouseEvent} params.params.event.event The native DOM event
3072
+ * @param {object} params.event Event object
3073
+ * @param {Grid.view.Grid} params.event.source The grid instance
3074
+ * @param {Core.data.Model} params.event.record The record representing the row that the mouse left
3075
+ * @param {HTMLElement} params.event.cellElement The cell HTML element that the mouse left
3076
+ * @param {MouseEvent} params.event.event The native DOM event
3324
3077
  */
3325
3078
  (e: 'rowMouseLeave', params: ((event: { source: Grid, record: Model, cellElement: HTMLElement, event: MouseEvent }) => void)|string): void
3326
3079
  /**
3327
3080
  * Grid has scrolled vertically
3328
3081
  * @param {string} e Event name
3329
3082
  * @param {object} params Event parameters
3330
- * @param {string} params.e Event name
3331
- * @param {object} params.params Event parameters
3332
- * @param {object} params.params.event Event object
3333
- * @param {Grid.view.GridBase} params.params.event.source The firing Grid instance.
3334
- * @param {number} params.params.event.scrollTop The vertical scroll position.
3083
+ * @param {object} params.event Event object
3084
+ * @param {Grid.view.GridBase} params.event.source The firing Grid instance.
3085
+ * @param {number} params.event.scrollTop The vertical scroll position.
3335
3086
  */
3336
3087
  (e: 'scroll', params: ((event: { source: GridBase, scrollTop: number }) => void)|string): void
3337
3088
  /**
3338
3089
  * The selection has been changed.
3339
3090
  * @param {string} e Event name
3340
3091
  * @param {object} params Event parameters
3341
- * @param {string} params.e Event name
3342
- * @param {object} params.params Event parameters
3343
- * @param {object} params.params.event Event object
3344
- * @param {'select','deselect'} params.params.event.action `'select'`/`'deselect'`
3345
- * @param {'row','cell'} params.params.event.mode `'row'`/`'cell'`
3346
- * @param {Grid.view.Grid} params.params.event.source
3347
- * @param {Core.data.Model[]} params.params.event.deselected The records deselected in this operation.
3348
- * @param {Core.data.Model[]} params.params.event.selected The records selected in this operation.
3349
- * @param {Core.data.Model[]} params.params.event.selection The records in the new selection.
3350
- * @param {Grid.util.GridLocation[]} params.params.event.deselectedCells The cells deselected in this operation.
3351
- * @param {Grid.util.GridLocation[]} params.params.event.selectedCells The cells selected in this operation.
3352
- * @param {Grid.util.GridLocation[]} params.params.event.cellSelection The cells in the new selection.
3092
+ * @param {object} params.event Event object
3093
+ * @param {'select','deselect'} params.event.action `'select'`/`'deselect'`
3094
+ * @param {'row','cell'} params.event.mode `'row'`/`'cell'`
3095
+ * @param {Grid.view.Grid} params.event.source
3096
+ * @param {Core.data.Model[]} params.event.deselected The records deselected in this operation.
3097
+ * @param {Core.data.Model[]} params.event.selected The records selected in this operation.
3098
+ * @param {Core.data.Model[]} params.event.selection The records in the new selection.
3099
+ * @param {Grid.util.GridLocation[]} params.event.deselectedCells The cells deselected in this operation.
3100
+ * @param {Grid.util.GridLocation[]} params.event.selectedCells The cells selected in this operation.
3101
+ * @param {Grid.util.GridLocation[]} params.event.cellSelection The cells in the new selection.
3353
3102
  */
3354
3103
  (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
3355
3104
  /**
3356
3105
  * The selectionMode configuration has been changed.
3357
3106
  * @param {string} e Event name
3358
3107
  * @param {object} params Event parameters
3359
- * @param {string} params.e Event name
3360
- * @param {object} params.params Event parameters
3361
- * @param {object} params.params.event Event object
3362
- * @param {object} params.params.event.selectionMode The new [selectionMode](https://bryntum.com/products/schedulerpro/docs/api/Grid/view/mixin/GridSelection#config-selectionMode)
3108
+ * @param {object} params.event Event object
3109
+ * @param {object} params.event.selectionMode The new [selectionMode](https://bryntum.com/products/schedulerpro/docs/api/Grid/view/mixin/GridSelection#config-selectionMode)
3363
3110
  */
3364
3111
  (e: 'selectionModeChange', params: ((event: { selectionMode: object }) => void)|string): void
3365
3112
  /**
3366
3113
  * Triggered after a widget is shown.
3367
3114
  * @param {string} e Event name
3368
3115
  * @param {object} params Event parameters
3369
- * @param {string} params.e Event name
3370
- * @param {object} params.params Event parameters
3371
- * @param {object} params.params.event Event object
3372
- * @param {Core.widget.Widget} params.params.event.source The widget
3116
+ * @param {object} params.event Event object
3117
+ * @param {Core.widget.Widget} params.event.source The widget
3373
3118
  */
3374
3119
  (e: 'show', params: ((event: { source: Widget }) => void)|string): void
3375
3120
  /**
3376
3121
  * Fires when splitting the Grid.
3377
3122
  * @param {string} e Event name
3378
3123
  * @param {object} params Event parameters
3379
- * @param {string} params.e Event name
3380
- * @param {object} params.params Event parameters
3381
- * @param {object} params.params.event Event object
3382
- * @param {Grid.view.GridBase[]} params.params.event.subViews The sub views created by the split
3383
- * @param {object} params.params.event.options The options passed to the split call
3384
- * @param {'horizontal','vertical','both'} params.params.event.options.direction The direction of the split
3385
- * @param {Grid.column.Column} params.params.event.options.atColumn The column to split at
3386
- * @param {Core.data.Model} params.params.event.options.atRecord The record to split at
3124
+ * @param {object} params.event Event object
3125
+ * @param {Grid.view.GridBase[]} params.event.subViews The sub views created by the split
3126
+ * @param {object} params.event.options The options passed to the split call
3127
+ * @param {'horizontal','vertical','both'} params.event.options.direction The direction of the split
3128
+ * @param {Grid.column.Column} params.event.options.atColumn The column to split at
3129
+ * @param {Core.data.Model} params.event.options.atRecord The record to split at
3387
3130
  */
3388
3131
  (e: 'split', params: ((event: { subViews: GridBase[], options: { direction: 'horizontal'|'vertical'|'both', atColumn: Column, atRecord: Model } }) => void)|string): void
3389
3132
  /**
@@ -3391,36 +3134,30 @@ const emit = defineEmits<{
3391
3134
  * if you want to implement your own behavior.
3392
3135
  * @param {string} e Event name
3393
3136
  * @param {object} params Event parameters
3394
- * @param {string} params.e Event name
3395
- * @param {object} params.params Event parameters
3396
- * @param {object} params.params.event Event object
3397
- * @param {Grid.view.Grid} params.params.event.source The Grid instance.
3398
- * @param {Grid.view.SubGrid} params.params.event.subGrid The subgrid
3399
- * @param {Event} params.params.event.domEvent The native DOM event
3137
+ * @param {object} params.event Event object
3138
+ * @param {Grid.view.Grid} params.event.source The Grid instance.
3139
+ * @param {Grid.view.SubGrid} params.event.subGrid The subgrid
3140
+ * @param {Event} params.event.domEvent The native DOM event
3400
3141
  */
3401
- (e: 'splitterCollapseClick', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
3142
+ (e: 'splitterCollapseClick', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string): boolean|void
3402
3143
  /**
3403
3144
  * Fired by the Grid after a sub-grid has been resized using the splitter
3404
3145
  * @param {string} e Event name
3405
3146
  * @param {object} params Event parameters
3406
- * @param {string} params.e Event name
3407
- * @param {object} params.params Event parameters
3408
- * @param {object} params.params.event Event object
3409
- * @param {Grid.view.Grid} params.params.event.source The Grid instance.
3410
- * @param {Grid.view.SubGrid} params.params.event.subGrid The resized subgrid
3411
- * @param {Event} params.params.event.domEvent The native DOM event
3147
+ * @param {object} params.event Event object
3148
+ * @param {Grid.view.Grid} params.event.source The Grid instance.
3149
+ * @param {Grid.view.SubGrid} params.event.subGrid The resized subgrid
3150
+ * @param {Event} params.event.domEvent The native DOM event
3412
3151
  */
3413
3152
  (e: 'splitterDragEnd', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => void)|string): void
3414
3153
  /**
3415
3154
  * Fired by the Grid when a sub-grid resize gesture starts
3416
3155
  * @param {string} e Event name
3417
3156
  * @param {object} params Event parameters
3418
- * @param {string} params.e Event name
3419
- * @param {object} params.params Event parameters
3420
- * @param {object} params.params.event Event object
3421
- * @param {Grid.view.Grid} params.params.event.source The Grid instance.
3422
- * @param {Grid.view.SubGrid} params.params.event.subGrid The subgrid about to be resized
3423
- * @param {Event} params.params.event.domEvent The native DOM event
3157
+ * @param {object} params.event Event object
3158
+ * @param {Grid.view.Grid} params.event.source The Grid instance.
3159
+ * @param {Grid.view.SubGrid} params.event.subGrid The subgrid about to be resized
3160
+ * @param {Event} params.event.domEvent The native DOM event
3424
3161
  */
3425
3162
  (e: 'splitterDragStart', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => void)|string): void
3426
3163
  /**
@@ -3428,56 +3165,46 @@ const emit = defineEmits<{
3428
3165
  * if you want to implement your own behavior.
3429
3166
  * @param {string} e Event name
3430
3167
  * @param {object} params Event parameters
3431
- * @param {string} params.e Event name
3432
- * @param {object} params.params Event parameters
3433
- * @param {object} params.params.event Event object
3434
- * @param {Grid.view.Grid} params.params.event.source The Grid instance.
3435
- * @param {Grid.view.SubGrid} params.params.event.subGrid The subgrid
3436
- * @param {Event} params.params.event.domEvent The native DOM event
3168
+ * @param {object} params.event Event object
3169
+ * @param {Grid.view.Grid} params.event.source The Grid instance.
3170
+ * @param {Grid.view.SubGrid} params.event.subGrid The subgrid
3171
+ * @param {Event} params.event.domEvent The native DOM event
3437
3172
  */
3438
- (e: 'splitterExpandClick', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
3173
+ (e: 'splitterExpandClick', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string): boolean|void
3439
3174
  /**
3440
3175
  * Fires on the owning Grid when editing starts
3441
3176
  * @param {string} e Event name
3442
3177
  * @param {object} params Event parameters
3443
- * @param {string} params.e Event name
3444
- * @param {object} params.params Event parameters
3445
- * @param {object} params.params.event Event object
3446
- * @param {Grid.view.Grid} params.params.event.source Owner grid
3447
- * @param {CellEditorContext} params.params.event.editorContext Editing context
3178
+ * @param {object} params.event Event object
3179
+ * @param {Grid.view.Grid} params.event.source Owner grid
3180
+ * @param {CellEditorContext} params.event.editorContext Editing context
3448
3181
  */
3449
3182
  (e: 'startCellEdit', params: ((event: { source: Grid, editorContext: CellEditorContext }) => void)|string): void
3450
3183
  /**
3451
3184
  * Fires on the owning Grid when editing starts
3452
3185
  * @param {string} e Event name
3453
3186
  * @param {object} params Event parameters
3454
- * @param {string} params.e Event name
3455
- * @param {object} params.params Event parameters
3456
- * @param {object} params.params.event Event object
3457
- * @param {Grid.view.Grid} params.params.event.source Owner grid
3458
- * @param {RowEditorContext} params.params.event.editorContext Editing context
3187
+ * @param {object} params.event Event object
3188
+ * @param {Grid.view.Grid} params.event.source Owner grid
3189
+ * @param {RowEditorContext} params.event.editorContext Editing context
3459
3190
  */
3460
3191
  (e: 'startRowEdit', params: ((event: { source: Grid, editorContext: RowEditorContext }) => void)|string): void
3461
3192
  /**
3462
3193
  * Fires after a sub grid is collapsed.
3463
3194
  * @param {string} e Event name
3464
3195
  * @param {object} params Event parameters
3465
- * @param {string} params.e Event name
3466
- * @param {object} params.params Event parameters
3467
- * @param {object} params.params.event Event object
3468
- * @param {Grid.view.GridBase} params.params.event.source The firing Grid instance
3469
- * @param {Grid.view.SubGrid} params.params.event.subGrid The sub grid instance
3196
+ * @param {object} params.event Event object
3197
+ * @param {Grid.view.GridBase} params.event.source The firing Grid instance
3198
+ * @param {Grid.view.SubGrid} params.event.subGrid The sub grid instance
3470
3199
  */
3471
3200
  (e: 'subGridCollapse', params: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string): void
3472
3201
  /**
3473
3202
  * Fires after a sub grid is expanded.
3474
3203
  * @param {string} e Event name
3475
3204
  * @param {object} params Event parameters
3476
- * @param {string} params.e Event name
3477
- * @param {object} params.params Event parameters
3478
- * @param {object} params.params.event Event object
3479
- * @param {Grid.view.GridBase} params.params.event.source The firing Grid instance
3480
- * @param {Grid.view.SubGrid} params.params.event.subGrid The sub grid instance
3205
+ * @param {object} params.event Event object
3206
+ * @param {Grid.view.GridBase} params.event.source The firing Grid instance
3207
+ * @param {Grid.view.SubGrid} params.event.subGrid The sub grid instance
3481
3208
  */
3482
3209
  (e: 'subGridExpand', params: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string): void
3483
3210
  /**
@@ -3485,63 +3212,53 @@ const emit = defineEmits<{
3485
3212
  * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceHistogram#event-tickSizeChange)
3486
3213
  * @param {string} e Event name
3487
3214
  * @param {object} params Event parameters
3488
- * @param {string} params.e Event name
3489
- * @param {object} params.params Event parameters
3490
- * @param {object} params.params.event Event object
3491
- * @param {Scheduler.view.Scheduler} params.params.event.source This Scheduler instance.
3492
- * @param {number} params.params.event.tickSize The tick size in pixels
3215
+ * @param {object} params.event Event object
3216
+ * @param {Scheduler.view.Scheduler} params.event.source This Scheduler instance.
3217
+ * @param {number} params.event.tickSize The tick size in pixels
3493
3218
  */
3494
3219
  (e: 'tickSizeChange', params: ((event: { source: Scheduler, tickSize: number }) => void)|string): void
3495
3220
  /**
3496
3221
  * Fired when the timeaxis has changed, for example by zooming or configuring a new time span.
3497
3222
  * @param {string} e Event name
3498
3223
  * @param {object} params Event parameters
3499
- * @param {string} params.e Event name
3500
- * @param {object} params.params Event parameters
3501
- * @param {object} params.params.event Event object
3502
- * @param {Scheduler.view.Scheduler} params.params.event.source This Scheduler
3503
- * @param {object} params.params.event.config Config object used to reconfigure the time axis.
3504
- * @param {Date} params.params.event.config.startDate New start date (if supplied)
3505
- * @param {Date} params.params.event.config.endDate New end date (if supplied)
3224
+ * @param {object} params.event Event object
3225
+ * @param {Scheduler.view.Scheduler} params.event.source This Scheduler
3226
+ * @param {object} params.event.config Config object used to reconfigure the time axis.
3227
+ * @param {Date} params.event.config.startDate New start date (if supplied)
3228
+ * @param {Date} params.event.config.endDate New end date (if supplied)
3506
3229
  */
3507
3230
  (e: 'timeAxisChange', params: ((event: { source: Scheduler, config: { startDate: Date, endDate: Date } }) => void)|string): void
3508
3231
  /**
3509
3232
  * Fires after a click on a time axis cell
3510
3233
  * @param {string} e Event name
3511
3234
  * @param {object} params Event parameters
3512
- * @param {string} params.e Event name
3513
- * @param {object} params.params Event parameters
3514
- * @param {object} params.params.event Event object
3515
- * @param {Scheduler.column.TimeAxisColumn,Scheduler.column.VerticalTimeAxisColumn} params.params.event.source The column object
3516
- * @param {Date} params.params.event.startDate The start date of the header cell
3517
- * @param {Date} params.params.event.endDate The end date of the header cell
3518
- * @param {Event} params.params.event.event The event object
3235
+ * @param {object} params.event Event object
3236
+ * @param {Scheduler.column.TimeAxisColumn,Scheduler.column.VerticalTimeAxisColumn} params.event.source The column object
3237
+ * @param {Date} params.event.startDate The start date of the header cell
3238
+ * @param {Date} params.event.endDate The end date of the header cell
3239
+ * @param {Event} params.event.event The event object
3519
3240
  */
3520
3241
  (e: 'timeAxisHeaderClick', params: ((event: { source: TimeAxisColumn|VerticalTimeAxisColumn, startDate: Date, endDate: Date, event: Event }) => void)|string): void
3521
3242
  /**
3522
3243
  * Fires after a right click on a time axis cell
3523
3244
  * @param {string} e Event name
3524
3245
  * @param {object} params Event parameters
3525
- * @param {string} params.e Event name
3526
- * @param {object} params.params Event parameters
3527
- * @param {object} params.params.event Event object
3528
- * @param {Scheduler.column.TimeAxisColumn,Scheduler.column.VerticalTimeAxisColumn} params.params.event.source The column object
3529
- * @param {Date} params.params.event.startDate The start date of the header cell
3530
- * @param {Date} params.params.event.endDate The end date of the header cell
3531
- * @param {Event} params.params.event.event The event object
3246
+ * @param {object} params.event Event object
3247
+ * @param {Scheduler.column.TimeAxisColumn,Scheduler.column.VerticalTimeAxisColumn} params.event.source The column object
3248
+ * @param {Date} params.event.startDate The start date of the header cell
3249
+ * @param {Date} params.event.endDate The end date of the header cell
3250
+ * @param {Event} params.event.event The event object
3532
3251
  */
3533
3252
  (e: 'timeAxisHeaderContextMenu', params: ((event: { source: TimeAxisColumn|VerticalTimeAxisColumn, startDate: Date, endDate: Date, event: Event }) => void)|string): void
3534
3253
  /**
3535
3254
  * Fires after a double click on a time axis cell
3536
3255
  * @param {string} e Event name
3537
3256
  * @param {object} params Event parameters
3538
- * @param {string} params.e Event name
3539
- * @param {object} params.params Event parameters
3540
- * @param {object} params.params.event Event object
3541
- * @param {Scheduler.column.TimeAxisColumn,Scheduler.column.VerticalTimeAxisColumn} params.params.event.source The column object
3542
- * @param {Date} params.params.event.startDate The start date of the header cell
3543
- * @param {Date} params.params.event.endDate The end date of the header cell
3544
- * @param {Event} params.params.event.event The event object
3257
+ * @param {object} params.event Event object
3258
+ * @param {Scheduler.column.TimeAxisColumn,Scheduler.column.VerticalTimeAxisColumn} params.event.source The column object
3259
+ * @param {Date} params.event.startDate The start date of the header cell
3260
+ * @param {Date} params.event.endDate The end date of the header cell
3261
+ * @param {Event} params.event.event The event object
3545
3262
  */
3546
3263
  (e: 'timeAxisHeaderDblClick', params: ((event: { source: TimeAxisColumn|VerticalTimeAxisColumn, startDate: Date, endDate: Date, event: Event }) => void)|string): void
3547
3264
  /**
@@ -3550,50 +3267,42 @@ const emit = defineEmits<{
3550
3267
  * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceHistogram#event-timeAxisHeaderMenuBeforeShow)
3551
3268
  * @param {string} e Event name
3552
3269
  * @param {object} params Event parameters
3553
- * @param {string} params.e Event name
3554
- * @param {object} params.params Event parameters
3555
- * @param {object} params.params.event Event object
3556
- * @param {Scheduler.view.Scheduler} params.params.event.source The scheduler
3557
- * @param {Core.widget.Menu} params.params.event.menu The menu
3558
- * @param {Record<string, MenuItemEntry>} params.params.event.items Menu item configs
3559
- * @param {Grid.column.Column} params.params.event.column Time axis column
3270
+ * @param {object} params.event Event object
3271
+ * @param {Scheduler.view.Scheduler} params.event.source The scheduler
3272
+ * @param {Core.widget.Menu} params.event.menu The menu
3273
+ * @param {Record<string, MenuItemEntry>} params.event.items Menu item configs
3274
+ * @param {Grid.column.Column} params.event.column Time axis column
3560
3275
  */
3561
- (e: 'timeAxisHeaderMenuBeforeShow', params: ((event: { source: Scheduler, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
3276
+ (e: 'timeAxisHeaderMenuBeforeShow', params: ((event: { source: Scheduler, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void)|string): boolean|void
3562
3277
  /**
3563
3278
  * This event fires on the owning Scheduler or Gantt widget when an item is selected in the header context menu.
3564
3279
  * @param {string} e Event name
3565
3280
  * @param {object} params Event parameters
3566
- * @param {string} params.e Event name
3567
- * @param {object} params.params Event parameters
3568
- * @param {object} params.params.event Event object
3569
- * @param {Scheduler.view.Scheduler} params.params.event.source The scheduler
3570
- * @param {Core.widget.Menu} params.params.event.menu The menu
3571
- * @param {Core.widget.MenuItem} params.params.event.item Selected menu item
3572
- * @param {Grid.column.Column} params.params.event.column Time axis column
3281
+ * @param {object} params.event Event object
3282
+ * @param {Scheduler.view.Scheduler} params.event.source The scheduler
3283
+ * @param {Core.widget.Menu} params.event.menu The menu
3284
+ * @param {Core.widget.MenuItem} params.event.item Selected menu item
3285
+ * @param {Grid.column.Column} params.event.column Time axis column
3573
3286
  */
3574
3287
  (e: 'timeAxisHeaderMenuItem', params: ((event: { source: Scheduler, menu: Menu, item: MenuItem, column: Column }) => void)|string): void
3575
3288
  /**
3576
3289
  * This event fires on the owning Scheduler or Gantt widget after the context menu is shown for a header
3577
3290
  * @param {string} e Event name
3578
3291
  * @param {object} params Event parameters
3579
- * @param {string} params.e Event name
3580
- * @param {object} params.params Event parameters
3581
- * @param {object} params.params.event Event object
3582
- * @param {Scheduler.view.Scheduler} params.params.event.source The scheduler
3583
- * @param {Core.widget.Menu} params.params.event.menu The menu
3584
- * @param {Record<string, MenuItemEntry>} params.params.event.items Menu item configs
3585
- * @param {Grid.column.Column} params.params.event.column Time axis column
3292
+ * @param {object} params.event Event object
3293
+ * @param {Scheduler.view.Scheduler} params.event.source The scheduler
3294
+ * @param {Core.widget.Menu} params.event.menu The menu
3295
+ * @param {Record<string, MenuItemEntry>} params.event.items Menu item configs
3296
+ * @param {Grid.column.Column} params.event.column Time axis column
3586
3297
  */
3587
3298
  (e: 'timeAxisHeaderMenuShow', params: ((event: { source: Scheduler, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => void)|string): void
3588
3299
  /**
3589
3300
  * Fired when the pointer-activated [timelineContext](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/mixin/TimelineDomEvents#property-timelineContext) has changed.
3590
3301
  * @param {string} e Event name
3591
3302
  * @param {object} params Event parameters
3592
- * @param {string} params.e Event name
3593
- * @param {object} params.params Event parameters
3594
- * @param {object} params.params.event Event object
3595
- * @param {Scheduler.util.TimelineContext} params.params.event.oldContext The tick/resource context being deactivated.
3596
- * @param {Scheduler.util.TimelineContext} params.params.event.context The tick/resource context being activated.
3303
+ * @param {object} params.event Event object
3304
+ * @param {Scheduler.util.TimelineContext} params.event.oldContext The tick/resource context being deactivated.
3305
+ * @param {Scheduler.util.TimelineContext} params.event.context The tick/resource context being activated.
3597
3306
  */
3598
3307
  (e: 'timelineContextChange', params: ((event: { oldContext: TimelineContext, context: TimelineContext }) => void)|string): void
3599
3308
  /**
@@ -3602,107 +3311,89 @@ const emit = defineEmits<{
3602
3311
  * scheduler column changes width.
3603
3312
  * @param {string} e Event name
3604
3313
  * @param {object} params Event parameters
3605
- * @param {string} params.e Event name
3606
- * @param {object} params.params Event parameters
3607
- * @param {object} params.params.event Event object
3608
- * @param {Core.widget.Widget} params.params.event.source This Scheduler
3609
- * @param {number} params.params.event.width The new width
3610
- * @param {number} params.params.event.height The new height
3611
- * @param {number} params.params.event.oldWidth The old width
3612
- * @param {number} params.params.event.oldHeight The old height
3314
+ * @param {object} params.event Event object
3315
+ * @param {Core.widget.Widget} params.event.source This Scheduler
3316
+ * @param {number} params.event.width The new width
3317
+ * @param {number} params.event.height The new height
3318
+ * @param {number} params.event.oldWidth The old width
3319
+ * @param {number} params.event.oldHeight The old height
3613
3320
  */
3614
3321
  (e: 'timelineViewportResize', params: ((event: { source: Widget, width: number, height: number, oldWidth: number, oldHeight: number }) => void)|string): void
3615
3322
  /**
3616
3323
  * Fired on the owning Scheduler or Gantt widget when a click happens on a time range header element
3617
3324
  * @param {string} e Event name
3618
3325
  * @param {object} params Event parameters
3619
- * @param {string} params.e Event name
3620
- * @param {object} params.params Event parameters
3621
- * @param {object} params.params.event Event object
3622
- * @param {Scheduler.view.Scheduler} params.params.event.source Scheduler instance
3623
- * @param {Scheduler.model.TimeSpan} params.params.event.timeRangeRecord The record
3624
- * @param {MouseEvent} params.params.event.domEvent Browser event
3326
+ * @param {object} params.event Event object
3327
+ * @param {Scheduler.view.Scheduler} params.event.source Scheduler instance
3328
+ * @param {Scheduler.model.TimeSpan} params.event.timeRangeRecord The record
3329
+ * @param {MouseEvent} params.event.domEvent Browser event
3625
3330
  */
3626
3331
  (e: 'timeRangeHeaderClick', params: ((event: { source: Scheduler, timeRangeRecord: TimeSpan, domEvent: MouseEvent }) => void)|string): void
3627
3332
  /**
3628
3333
  * Fired on the owning Scheduler or Gantt widget when a right click happens on a time range header element
3629
3334
  * @param {string} e Event name
3630
3335
  * @param {object} params Event parameters
3631
- * @param {string} params.e Event name
3632
- * @param {object} params.params Event parameters
3633
- * @param {object} params.params.event Event object
3634
- * @param {Scheduler.view.Scheduler} params.params.event.source Scheduler instance
3635
- * @param {Scheduler.model.TimeSpan} params.params.event.timeRangeRecord The record
3636
- * @param {MouseEvent} params.params.event.domEvent Browser event
3336
+ * @param {object} params.event Event object
3337
+ * @param {Scheduler.view.Scheduler} params.event.source Scheduler instance
3338
+ * @param {Scheduler.model.TimeSpan} params.event.timeRangeRecord The record
3339
+ * @param {MouseEvent} params.event.domEvent Browser event
3637
3340
  */
3638
3341
  (e: 'timeRangeHeaderContextMenu', params: ((event: { source: Scheduler, timeRangeRecord: TimeSpan, domEvent: MouseEvent }) => void)|string): void
3639
3342
  /**
3640
3343
  * Fired on the owning Scheduler or Gantt widget when a double click happens on a time range header element
3641
3344
  * @param {string} e Event name
3642
3345
  * @param {object} params Event parameters
3643
- * @param {string} params.e Event name
3644
- * @param {object} params.params Event parameters
3645
- * @param {object} params.params.event Event object
3646
- * @param {Scheduler.view.Scheduler} params.params.event.source Scheduler instance
3647
- * @param {Scheduler.model.TimeSpan} params.params.event.timeRangeRecord The record
3648
- * @param {MouseEvent} params.params.event.domEvent Browser event
3346
+ * @param {object} params.event Event object
3347
+ * @param {Scheduler.view.Scheduler} params.event.source Scheduler instance
3348
+ * @param {Scheduler.model.TimeSpan} params.event.timeRangeRecord The record
3349
+ * @param {MouseEvent} params.event.domEvent Browser event
3649
3350
  */
3650
3351
  (e: 'timeRangeHeaderDblClick', params: ((event: { source: Scheduler, timeRangeRecord: TimeSpan, domEvent: MouseEvent }) => void)|string): void
3651
3352
  /**
3652
3353
  * Fired when one or more groups are expanded or collapsed
3653
3354
  * @param {string} e Event name
3654
3355
  * @param {object} params Event parameters
3655
- * @param {string} params.e Event name
3656
- * @param {object} params.params Event parameters
3657
- * @param {object} params.params.event Event object
3658
- * @param {Core.data.Model} params.params.event.groupRecord [DEPRECATED] Use `groupRecords` param instead
3659
- * @param {Core.data.Model[]} params.params.event.groupRecords The group records being toggled
3660
- * @param {boolean} params.params.event.collapse Collapsed (true) or expanded (false)
3661
- * @param {boolean} [params.params.event.allRecords] True if this event is part of toggling all groups
3356
+ * @param {object} params.event Event object
3357
+ * @param {Core.data.Model} params.event.groupRecord [DEPRECATED] Use `groupRecords` param instead
3358
+ * @param {Core.data.Model[]} params.event.groupRecords The group records being toggled
3359
+ * @param {boolean} params.event.collapse Collapsed (true) or expanded (false)
3360
+ * @param {boolean} [params.event.allRecords] True if this event is part of toggling all groups
3662
3361
  */
3663
3362
  (e: 'toggleGroup', params: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, allRecords?: boolean }) => void)|string): void
3664
3363
  /**
3665
3364
  * Fired after a parent node record toggles its collapsed state.
3666
3365
  * @param {string} e Event name
3667
3366
  * @param {object} params Event parameters
3668
- * @param {string} params.e Event name
3669
- * @param {object} params.params Event parameters
3670
- * @param {object} params.params.event Event object
3671
- * @param {Core.data.Model} params.params.event.record The record being toggled.
3672
- * @param {boolean} params.params.event.collapse `true` if the node is being collapsed.
3367
+ * @param {object} params.event Event object
3368
+ * @param {Core.data.Model} params.event.record The record being toggled.
3369
+ * @param {boolean} params.event.collapse `true` if the node is being collapsed.
3673
3370
  */
3674
3371
  (e: 'toggleNode', params: ((event: { record: Model, collapse: boolean }) => void)|string): void
3675
3372
  /**
3676
3373
  * A header [tool](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Panel#config-tools) has been clicked.
3677
3374
  * @param {string} e Event name
3678
3375
  * @param {object} params Event parameters
3679
- * @param {string} params.e Event name
3680
- * @param {object} params.params Event parameters
3681
- * @param {object} params.params.event Event object
3682
- * @param {Core.widget.Tool} params.params.event.source This Panel.
3683
- * @param {Core.widget.Tool} params.params.event.tool The tool which is being clicked.
3376
+ * @param {object} params.event Event object
3377
+ * @param {Core.widget.Tool} params.event.source This Panel.
3378
+ * @param {Core.widget.Tool} params.event.tool The tool which is being clicked.
3684
3379
  */
3685
3380
  (e: 'toolClick', params: ((event: { source: Tool, tool: Tool }) => void)|string): void
3686
3381
  /**
3687
3382
  * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
3688
3383
  * @param {string} e Event name
3689
3384
  * @param {object} params Event parameters
3690
- * @param {string} params.e Event name
3691
- * @param {object} params.params Event parameters
3692
- * @param {object} params.params.event Event object
3693
- * @param {Grid.view.Grid} params.params.event.source The grid instance
3694
- * @param {(string|Function)[]} params.params.event.groupers Array of field names or functions representing the current grouping levels
3695
- * @param {(string|Function)[]} params.params.event.oldGroupers Array of field names or functions representing the previous grouping levels
3385
+ * @param {object} params.event Event object
3386
+ * @param {Grid.view.Grid} params.event.source The grid instance
3387
+ * @param {(string|Function)[]} params.event.groupers Array of field names or functions representing the current grouping levels
3388
+ * @param {(string|Function)[]} params.event.oldGroupers Array of field names or functions representing the previous grouping levels
3696
3389
  */
3697
3390
  (e: 'treeGroup', params: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string): void
3698
3391
  /**
3699
3392
  * Fires when row locking is disabled.
3700
3393
  * @param {string} e Event name
3701
3394
  * @param {object} params Event parameters
3702
- * @param {string} params.e Event name
3703
- * @param {object} params.params Event parameters
3704
- * @param {object} params.params.event Event object
3705
- * @param {Grid.view.GridBase} params.params.event.clone The locked clone that will be destroyed
3395
+ * @param {object} params.event Event object
3396
+ * @param {Grid.view.GridBase} params.event.clone The locked clone that will be destroyed
3706
3397
  */
3707
3398
  (e: 'unlockRows', params: ((event: { clone: GridBase }) => void)|string): void
3708
3399
  /**
@@ -3715,16 +3406,14 @@ const emit = defineEmits<{
3715
3406
  * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceHistogram#event-visibleDateRangeChange)
3716
3407
  * @param {string} e Event name
3717
3408
  * @param {object} params Event parameters
3718
- * @param {string} params.e Event name
3719
- * @param {object} params.params Event parameters
3720
- * @param {object} params.params.event Event object
3721
- * @param {Scheduler.view.Scheduler} params.params.event.source This Scheduler instance.
3722
- * @param {object} params.params.event.old The old date range
3723
- * @param {Date} params.params.event.old.startDate the old start date.
3724
- * @param {Date} params.params.event.old.endDate the old end date.
3725
- * @param {object} params.params.event.new The new date range
3726
- * @param {Date} params.params.event.new.startDate the new start date.
3727
- * @param {Date} params.params.event.new.endDate the new end date.
3409
+ * @param {object} params.event Event object
3410
+ * @param {Scheduler.view.Scheduler} params.event.source This Scheduler instance.
3411
+ * @param {object} params.event.old The old date range
3412
+ * @param {Date} params.event.old.startDate the old start date.
3413
+ * @param {Date} params.event.old.endDate the old end date.
3414
+ * @param {object} params.event.new The new date range
3415
+ * @param {Date} params.event.new.startDate the new start date.
3416
+ * @param {Date} params.event.new.endDate the new end date.
3728
3417
  */
3729
3418
  (e: 'visibleDateRangeChange', params: ((event: { source: Scheduler, old: { startDate: Date, endDate: Date }, new: { startDate: Date, endDate: Date } }) => void)|string): void
3730
3419
  /**
@@ -3732,11 +3421,9 @@ const emit = defineEmits<{
3732
3421
  * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceHistogram#event-zoomLevelChange)
3733
3422
  * @param {string} e Event name
3734
3423
  * @param {object} params Event parameters
3735
- * @param {string} params.e Event name
3736
- * @param {object} params.params Event parameters
3737
- * @param {object} params.params.event Event object
3738
- * @param {Scheduler.view.TimelineBase} params.params.event.source
3739
- * @param {number} params.params.event.zoomLevel New zoom level
3424
+ * @param {object} params.event Event object
3425
+ * @param {Scheduler.view.TimelineBase} params.event.source
3426
+ * @param {number} params.event.zoomLevel New zoom level
3740
3427
  */
3741
3428
  (e: 'zoomLevelChange', params: ((event: { source: TimelineBase, zoomLevel: number }) => void)|string): void
3742
3429
  }>();
@@ -3891,6 +3578,7 @@ const widgetData = {
3891
3578
  'preserveFocusOnDatasetChange',
3892
3579
  'preserveScrollOnDatasetChange',
3893
3580
  'preventTooltipOnTouch',
3581
+ 'projectModelClass',
3894
3582
  'relayStoreEvents',
3895
3583
  'resizable',
3896
3584
  'resizeToFitIncludesHeader',