@bryntum/scheduler-vue-3-thin 7.3.0 → 7.3.1

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