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