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