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