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