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