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