@bryntum/grid-thin-trial 7.3.0 → 7.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/grid.css +4 -4
- package/grid.css.map +2 -2
- package/grid.d.ts +363 -333
- package/lib/column/CheckColumn.js +1 -1
- package/lib/column/Column.js +1 -1
- package/lib/column/TreeColumn.js +1 -1
- package/lib/feature/ColumnPicker.js +1 -1
- package/lib/feature/FilterBar.js +1 -1
- package/lib/feature/RegionResize.css +4 -4
- package/lib/feature/RowExpander.js +1 -1
- package/lib/feature/RowReorder.js +1 -1
- package/lib/row/RowManager.js +1 -1
- package/lib/view/Bar.js +1 -1
- package/lib/view/GridBase.js +1 -1
- package/lib/view/mixin/GridSelection.js +1 -1
- package/lib/widget/ChecklistFilterCombo.js +1 -1
- package/package.json +1 -1
package/grid.d.ts
CHANGED
|
@@ -402,7 +402,8 @@ type GridSelectionMode = {
|
|
|
402
402
|
checkboxIndex?: number|string
|
|
403
403
|
/**
|
|
404
404
|
* Select rows only when clicking in the checkbox column.
|
|
405
|
-
* Requires cell selection config to be `false` and checkbox to be set to `true`. This setting
|
|
405
|
+
* Requires cell selection config to be `false` and checkbox to be set to `true`. This setting allows
|
|
406
|
+
* clicking on other cells without affecting selection. This setting was previously named
|
|
406
407
|
* `rowCheckboxSelection`
|
|
407
408
|
*/
|
|
408
409
|
checkboxOnly?: boolean
|
|
@@ -2670,7 +2671,7 @@ type CheckColumnListenersTypes = {
|
|
|
2670
2671
|
* @param {Core.data.Model} event.record The record for the row containing the cell.
|
|
2671
2672
|
* @param {boolean} event.checked The new checked status of the cell.
|
|
2672
2673
|
*/
|
|
2673
|
-
beforeToggle: (event: { source: Column, record: Model, checked: boolean }) =>
|
|
2674
|
+
beforeToggle: (event: { source: Column, record: Model, checked: boolean }) => boolean|void
|
|
2674
2675
|
/**
|
|
2675
2676
|
* Fires when any other event is fired from the object.
|
|
2676
2677
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/column/CheckColumn#event-catchAll)
|
|
@@ -2723,7 +2724,7 @@ type CheckColumnListeners = {
|
|
|
2723
2724
|
* @param {Core.data.Model} event.record The record for the row containing the cell.
|
|
2724
2725
|
* @param {boolean} event.checked The new checked status of the cell.
|
|
2725
2726
|
*/
|
|
2726
|
-
beforeToggle?: ((event: { source: Column, record: Model, checked: boolean }) =>
|
|
2727
|
+
beforeToggle?: ((event: { source: Column, record: Model, checked: boolean }) => boolean|void)|string
|
|
2727
2728
|
/**
|
|
2728
2729
|
* Fires when any other event is fired from the object.
|
|
2729
2730
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/column/CheckColumn#event-catchAll)
|
|
@@ -3345,7 +3346,7 @@ type CheckColumnConfig = {
|
|
|
3345
3346
|
* @param {Core.data.Model} event.record The record for the row containing the cell.
|
|
3346
3347
|
* @param {boolean} event.checked The new checked status of the cell.
|
|
3347
3348
|
*/
|
|
3348
|
-
onBeforeToggle?: ((event: { source: Column, record: Model, checked: boolean }) =>
|
|
3349
|
+
onBeforeToggle?: ((event: { source: Column, record: Model, checked: boolean }) => boolean|void)|string
|
|
3349
3350
|
/**
|
|
3350
3351
|
* Fires when any other event is fired from the object.
|
|
3351
3352
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/column/CheckColumn#event-catchAll)
|
|
@@ -3419,7 +3420,7 @@ export class CheckColumn extends WidgetColumn {
|
|
|
3419
3420
|
* @param {Core.data.Model} event.record The record for the row containing the cell.
|
|
3420
3421
|
* @param {boolean} event.checked The new checked status of the cell.
|
|
3421
3422
|
*/
|
|
3422
|
-
onBeforeToggle: ((event: { source: Column, record: Model, checked: boolean }) =>
|
|
3423
|
+
onBeforeToggle: ((event: { source: Column, record: Model, checked: boolean }) => boolean|void)|string
|
|
3423
3424
|
/**
|
|
3424
3425
|
* Fires when any other event is fired from the object.
|
|
3425
3426
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/column/CheckColumn#event-catchAll)
|
|
@@ -13257,7 +13258,7 @@ type ColumnStoreListenersTypes = {
|
|
|
13257
13258
|
* @param {Core.data.Model[]} event.records The records which are to be added
|
|
13258
13259
|
* @param {Core.data.Model} event.parent The parent node when using a tree store
|
|
13259
13260
|
*/
|
|
13260
|
-
beforeAdd: (event: { source: Store, records: Model[], parent: Model }) =>
|
|
13261
|
+
beforeAdd: (event: { source: Store, records: Model[], parent: Model }) => boolean|void
|
|
13261
13262
|
/**
|
|
13262
13263
|
* Fired before committing changes. Return false from handler to abort commit
|
|
13263
13264
|
* @param {object} event Event object
|
|
@@ -13284,14 +13285,14 @@ type ColumnStoreListenersTypes = {
|
|
|
13284
13285
|
* @param {Core.data.Store,any} event.source The
|
|
13285
13286
|
* @param {(Core.data.Model|any)[]} event.records The nodes to indent.
|
|
13286
13287
|
*/
|
|
13287
|
-
beforeIndent: (event: { source: Store|any, records: (Model|any)[] }) =>
|
|
13288
|
+
beforeIndent: (event: { source: Store|any, records: (Model|any)[] }) => boolean|void
|
|
13288
13289
|
/**
|
|
13289
13290
|
* Fired before nodes in the tree are outdented. Return `false` from a listener to prevent the outdent.
|
|
13290
13291
|
* @param {object} event Event object
|
|
13291
13292
|
* @param {Core.data.Store,any} event.source This store
|
|
13292
13293
|
* @param {(Core.data.Model|any)[]} event.records Nodes to be outdented
|
|
13293
13294
|
*/
|
|
13294
|
-
beforeOutdent: (event: { source: Store|any, records: (Model|any)[] }) =>
|
|
13295
|
+
beforeOutdent: (event: { source: Store|any, records: (Model|any)[] }) => boolean|void
|
|
13295
13296
|
/**
|
|
13296
13297
|
* Fired before records are removed from this store by the [remove](https://bryntum.com/products/grid/docs/api/Core/data/mixin/StoreCRUD#function-remove) or [removeAll](#Core/data/mixin/StoreCRUD#function-removeAll).
|
|
13297
13298
|
* Also fired when removing a child record in a tree store using [removeChild](https://bryntum.com/products/grid/docs/api/Core/data/mixin/TreeNode#function-removeChild).
|
|
@@ -13303,7 +13304,7 @@ type ColumnStoreListenersTypes = {
|
|
|
13303
13304
|
* @param {boolean} event.isMove This flag is `true` if the child node is being removed by [appendChild](https://bryntum.com/products/grid/docs/api/Core/data/mixin/TreeNode#function-appendChild) to be moved *within the same tree*.
|
|
13304
13305
|
* @param {boolean} event.removingAll This flag is `true` if the operation is removing the store's entire data set.
|
|
13305
13306
|
*/
|
|
13306
|
-
beforeRemove: (event: { source: Store, records: Model[], parent: Model, isMove: boolean, removingAll: boolean }) =>
|
|
13307
|
+
beforeRemove: (event: { source: Store, records: Model[], parent: Model, isMove: boolean, removingAll: boolean }) => boolean|void
|
|
13307
13308
|
/**
|
|
13308
13309
|
* Fired before sorting
|
|
13309
13310
|
* @param {object} event Event object
|
|
@@ -13515,7 +13516,7 @@ type ColumnStoreListeners = {
|
|
|
13515
13516
|
* @param {Core.data.Model[]} event.records The records which are to be added
|
|
13516
13517
|
* @param {Core.data.Model} event.parent The parent node when using a tree store
|
|
13517
13518
|
*/
|
|
13518
|
-
beforeAdd?: ((event: { source: Store, records: Model[], parent: Model }) =>
|
|
13519
|
+
beforeAdd?: ((event: { source: Store, records: Model[], parent: Model }) => boolean|void)|string
|
|
13519
13520
|
/**
|
|
13520
13521
|
* Fired before committing changes. Return false from handler to abort commit
|
|
13521
13522
|
* @param {object} event Event object
|
|
@@ -13542,14 +13543,14 @@ type ColumnStoreListeners = {
|
|
|
13542
13543
|
* @param {Core.data.Store,any} event.source The
|
|
13543
13544
|
* @param {(Core.data.Model|any)[]} event.records The nodes to indent.
|
|
13544
13545
|
*/
|
|
13545
|
-
beforeIndent?: ((event: { source: Store|any, records: (Model|any)[] }) =>
|
|
13546
|
+
beforeIndent?: ((event: { source: Store|any, records: (Model|any)[] }) => boolean|void)|string
|
|
13546
13547
|
/**
|
|
13547
13548
|
* Fired before nodes in the tree are outdented. Return `false` from a listener to prevent the outdent.
|
|
13548
13549
|
* @param {object} event Event object
|
|
13549
13550
|
* @param {Core.data.Store,any} event.source This store
|
|
13550
13551
|
* @param {(Core.data.Model|any)[]} event.records Nodes to be outdented
|
|
13551
13552
|
*/
|
|
13552
|
-
beforeOutdent?: ((event: { source: Store|any, records: (Model|any)[] }) =>
|
|
13553
|
+
beforeOutdent?: ((event: { source: Store|any, records: (Model|any)[] }) => boolean|void)|string
|
|
13553
13554
|
/**
|
|
13554
13555
|
* Fired before records are removed from this store by the [remove](https://bryntum.com/products/grid/docs/api/Core/data/mixin/StoreCRUD#function-remove) or [removeAll](#Core/data/mixin/StoreCRUD#function-removeAll).
|
|
13555
13556
|
* Also fired when removing a child record in a tree store using [removeChild](https://bryntum.com/products/grid/docs/api/Core/data/mixin/TreeNode#function-removeChild).
|
|
@@ -13561,7 +13562,7 @@ type ColumnStoreListeners = {
|
|
|
13561
13562
|
* @param {boolean} event.isMove This flag is `true` if the child node is being removed by [appendChild](https://bryntum.com/products/grid/docs/api/Core/data/mixin/TreeNode#function-appendChild) to be moved *within the same tree*.
|
|
13562
13563
|
* @param {boolean} event.removingAll This flag is `true` if the operation is removing the store's entire data set.
|
|
13563
13564
|
*/
|
|
13564
|
-
beforeRemove?: ((event: { source: Store, records: Model[], parent: Model, isMove: boolean, removingAll: boolean }) =>
|
|
13565
|
+
beforeRemove?: ((event: { source: Store, records: Model[], parent: Model, isMove: boolean, removingAll: boolean }) => boolean|void)|string
|
|
13565
13566
|
/**
|
|
13566
13567
|
* Fired before sorting
|
|
13567
13568
|
* @param {object} event Event object
|
|
@@ -14069,7 +14070,7 @@ type ColumnStoreConfig = {
|
|
|
14069
14070
|
* @param {Core.data.Model[]} event.records The records which are to be added
|
|
14070
14071
|
* @param {Core.data.Model} event.parent The parent node when using a tree store
|
|
14071
14072
|
*/
|
|
14072
|
-
onBeforeAdd?: ((event: { source: Store, records: Model[], parent: Model }) =>
|
|
14073
|
+
onBeforeAdd?: ((event: { source: Store, records: Model[], parent: Model }) => boolean|void)|string
|
|
14073
14074
|
/**
|
|
14074
14075
|
* Fired before committing changes. Return false from handler to abort commit
|
|
14075
14076
|
* @param {object} event Event object
|
|
@@ -14096,14 +14097,14 @@ type ColumnStoreConfig = {
|
|
|
14096
14097
|
* @param {Core.data.Store,any} event.source The
|
|
14097
14098
|
* @param {(Core.data.Model|any)[]} event.records The nodes to indent.
|
|
14098
14099
|
*/
|
|
14099
|
-
onBeforeIndent?: ((event: { source: Store|any, records: (Model|any)[] }) =>
|
|
14100
|
+
onBeforeIndent?: ((event: { source: Store|any, records: (Model|any)[] }) => boolean|void)|string
|
|
14100
14101
|
/**
|
|
14101
14102
|
* Fired before nodes in the tree are outdented. Return `false` from a listener to prevent the outdent.
|
|
14102
14103
|
* @param {object} event Event object
|
|
14103
14104
|
* @param {Core.data.Store,any} event.source This store
|
|
14104
14105
|
* @param {(Core.data.Model|any)[]} event.records Nodes to be outdented
|
|
14105
14106
|
*/
|
|
14106
|
-
onBeforeOutdent?: ((event: { source: Store|any, records: (Model|any)[] }) =>
|
|
14107
|
+
onBeforeOutdent?: ((event: { source: Store|any, records: (Model|any)[] }) => boolean|void)|string
|
|
14107
14108
|
/**
|
|
14108
14109
|
* Fired before records are removed from this store by the [remove](https://bryntum.com/products/grid/docs/api/Core/data/mixin/StoreCRUD#function-remove) or [removeAll](#Core/data/mixin/StoreCRUD#function-removeAll).
|
|
14109
14110
|
* Also fired when removing a child record in a tree store using [removeChild](https://bryntum.com/products/grid/docs/api/Core/data/mixin/TreeNode#function-removeChild).
|
|
@@ -14115,7 +14116,7 @@ type ColumnStoreConfig = {
|
|
|
14115
14116
|
* @param {boolean} event.isMove This flag is `true` if the child node is being removed by [appendChild](https://bryntum.com/products/grid/docs/api/Core/data/mixin/TreeNode#function-appendChild) to be moved *within the same tree*.
|
|
14116
14117
|
* @param {boolean} event.removingAll This flag is `true` if the operation is removing the store's entire data set.
|
|
14117
14118
|
*/
|
|
14118
|
-
onBeforeRemove?: ((event: { source: Store, records: Model[], parent: Model, isMove: boolean, removingAll: boolean }) =>
|
|
14119
|
+
onBeforeRemove?: ((event: { source: Store, records: Model[], parent: Model, isMove: boolean, removingAll: boolean }) => boolean|void)|string
|
|
14119
14120
|
/**
|
|
14120
14121
|
* Fired before sorting
|
|
14121
14122
|
* @param {object} event Event object
|
|
@@ -14339,7 +14340,7 @@ export class ColumnStore extends Store {
|
|
|
14339
14340
|
* @param {Core.data.Model[]} event.records The records which are to be added
|
|
14340
14341
|
* @param {Core.data.Model} event.parent The parent node when using a tree store
|
|
14341
14342
|
*/
|
|
14342
|
-
onBeforeAdd: ((event: { source: Store, records: Model[], parent: Model }) =>
|
|
14343
|
+
onBeforeAdd: ((event: { source: Store, records: Model[], parent: Model }) => boolean|void)|string
|
|
14343
14344
|
/**
|
|
14344
14345
|
* Fired before committing changes. Return false from handler to abort commit
|
|
14345
14346
|
* @param {object} event Event object
|
|
@@ -14366,14 +14367,14 @@ export class ColumnStore extends Store {
|
|
|
14366
14367
|
* @param {Core.data.Store,any} event.source The
|
|
14367
14368
|
* @param {(Core.data.Model|any)[]} event.records The nodes to indent.
|
|
14368
14369
|
*/
|
|
14369
|
-
onBeforeIndent: ((event: { source: Store|any, records: (Model|any)[] }) =>
|
|
14370
|
+
onBeforeIndent: ((event: { source: Store|any, records: (Model|any)[] }) => boolean|void)|string
|
|
14370
14371
|
/**
|
|
14371
14372
|
* Fired before nodes in the tree are outdented. Return `false` from a listener to prevent the outdent.
|
|
14372
14373
|
* @param {object} event Event object
|
|
14373
14374
|
* @param {Core.data.Store,any} event.source This store
|
|
14374
14375
|
* @param {(Core.data.Model|any)[]} event.records Nodes to be outdented
|
|
14375
14376
|
*/
|
|
14376
|
-
onBeforeOutdent: ((event: { source: Store|any, records: (Model|any)[] }) =>
|
|
14377
|
+
onBeforeOutdent: ((event: { source: Store|any, records: (Model|any)[] }) => boolean|void)|string
|
|
14377
14378
|
/**
|
|
14378
14379
|
* Fired before records are removed from this store by the [remove](https://bryntum.com/products/grid/docs/api/Core/data/mixin/StoreCRUD#function-remove) or [removeAll](#Core/data/mixin/StoreCRUD#function-removeAll).
|
|
14379
14380
|
* Also fired when removing a child record in a tree store using [removeChild](https://bryntum.com/products/grid/docs/api/Core/data/mixin/TreeNode#function-removeChild).
|
|
@@ -14385,7 +14386,7 @@ export class ColumnStore extends Store {
|
|
|
14385
14386
|
* @param {boolean} event.isMove This flag is `true` if the child node is being removed by [appendChild](https://bryntum.com/products/grid/docs/api/Core/data/mixin/TreeNode#function-appendChild) to be moved *within the same tree*.
|
|
14386
14387
|
* @param {boolean} event.removingAll This flag is `true` if the operation is removing the store's entire data set.
|
|
14387
14388
|
*/
|
|
14388
|
-
onBeforeRemove: ((event: { source: Store, records: Model[], parent: Model, isMove: boolean, removingAll: boolean }) =>
|
|
14389
|
+
onBeforeRemove: ((event: { source: Store, records: Model[], parent: Model, isMove: boolean, removingAll: boolean }) => boolean|void)|string
|
|
14389
14390
|
/**
|
|
14390
14391
|
* Fired before sorting
|
|
14391
14392
|
* @param {object} event Event object
|
|
@@ -22345,13 +22346,15 @@ type RowReorderConfig = {
|
|
|
22345
22346
|
* data (e.g. to copy instead of move), you can provide an object with a `transferData` method.
|
|
22346
22347
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowReorder#config-allowCrossGridDrag)
|
|
22347
22348
|
* @property {Function} allowCrossGridDrag.transferData A function which decides what should happen to the dragged records upon drop. It receives a single context object with information about the drag drop state.
|
|
22348
|
-
* @property {
|
|
22349
|
-
* @property {Grid.view.GridBase} allowCrossGridDrag.transferData.
|
|
22350
|
-
* @property {
|
|
22351
|
-
* @property {Core.data.Model} allowCrossGridDrag.transferData.
|
|
22352
|
-
* @property {Core.data.Model} allowCrossGridDrag.transferData.
|
|
22349
|
+
* @property {object} allowCrossGridDrag.transferData.data Context object describing the drag drop state.
|
|
22350
|
+
* @property {Grid.view.GridBase} allowCrossGridDrag.transferData.data.sourceGrid The source grid
|
|
22351
|
+
* @property {Grid.view.GridBase} allowCrossGridDrag.transferData.data.targetGrid the target grid
|
|
22352
|
+
* @property {Core.data.Model[]} allowCrossGridDrag.transferData.data.records The dragged records
|
|
22353
|
+
* @property {Core.data.Model} allowCrossGridDrag.transferData.data.insertBefore The record to insert before
|
|
22354
|
+
* @property {Core.data.Model} allowCrossGridDrag.transferData.data.parent The parent record of the current drop position (only applicable for trees)
|
|
22355
|
+
* @property {Promise<any>,void} allowCrossGridDrag.transferData.returns May return a `Promise` to signal that the transfer is asynchronous. The drop operation will wait for the `Promise` to resolve before finalizing.
|
|
22353
22356
|
*/
|
|
22354
|
-
allowCrossGridDrag?: boolean|{ transferData: (sourceGrid: GridBase, targetGrid: GridBase, records: Model[], insertBefore: Model, parent: Model) => void }
|
|
22357
|
+
allowCrossGridDrag?: boolean|{ transferData: (data: { sourceGrid: GridBase, targetGrid: GridBase, records: Model[], insertBefore: Model, parent: Model }) => Promise<any>|void }
|
|
22355
22358
|
/**
|
|
22356
22359
|
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
22357
22360
|
* hierarchy when triggered.
|
|
@@ -28411,14 +28414,14 @@ type GridListenersTypes = {
|
|
|
28411
28414
|
* @param {string} event.lineDelimiter The CSV delimiter to separate lines
|
|
28412
28415
|
* @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
|
|
28413
28416
|
*/
|
|
28414
|
-
beforeCSVExport: (event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
28417
|
+
beforeCSVExport: (event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void
|
|
28415
28418
|
/**
|
|
28416
28419
|
* Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
|
|
28417
28420
|
* @param {object} event Event object
|
|
28418
28421
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
28419
28422
|
* @param {Grid.util.GridLocation} event.editorContext Editing context
|
|
28420
28423
|
*/
|
|
28421
|
-
beforeCancelCellEdit: (event: { source: Grid, editorContext: GridLocation }) =>
|
|
28424
|
+
beforeCancelCellEdit: (event: { source: Grid, editorContext: GridLocation }) => boolean|void
|
|
28422
28425
|
/**
|
|
28423
28426
|
* 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.
|
|
28424
28427
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-beforeCancelRowEdit)
|
|
@@ -28433,7 +28436,7 @@ type GridListenersTypes = {
|
|
|
28433
28436
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
28434
28437
|
* @param {CellEditorContext} event.editorContext Editing context
|
|
28435
28438
|
*/
|
|
28436
|
-
beforeCellEditStart: (event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
28439
|
+
beforeCellEditStart: (event: { source: Grid, editorContext: CellEditorContext }) => boolean|void
|
|
28437
28440
|
/**
|
|
28438
28441
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
28439
28442
|
* buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
|
|
@@ -28441,7 +28444,7 @@ type GridListenersTypes = {
|
|
|
28441
28444
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
28442
28445
|
* @param {(Grid.util.GridLocation|Core.data.Model)[]} 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).
|
|
28443
28446
|
*/
|
|
28444
|
-
beforeCellRangeDelete: (event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
28447
|
+
beforeCellRangeDelete: (event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void
|
|
28445
28448
|
/**
|
|
28446
28449
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
28447
28450
|
* @param {object} event Event object
|
|
@@ -28449,7 +28452,7 @@ type GridListenersTypes = {
|
|
|
28449
28452
|
* @param {string} event.field The field being changed
|
|
28450
28453
|
* @param {any} event.value The value being set
|
|
28451
28454
|
*/
|
|
28452
|
-
beforeCellRangeEdit: (event: { record: Model, field: string, value: any }) =>
|
|
28455
|
+
beforeCellRangeEdit: (event: { record: Model, field: string, value: any }) => boolean|void
|
|
28453
28456
|
/**
|
|
28454
28457
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
28455
28458
|
* @param {object} event Event object
|
|
@@ -28465,7 +28468,7 @@ type GridListenersTypes = {
|
|
|
28465
28468
|
* @param {Grid.column.Column} event.column The dragged column.
|
|
28466
28469
|
* @param {Event} event.event The browser event.
|
|
28467
28470
|
*/
|
|
28468
|
-
beforeColumnDragStart: (event: { source: Grid, column: Column, event: Event }) =>
|
|
28471
|
+
beforeColumnDragStart: (event: { source: Grid, column: Column, event: Event }) => boolean|void
|
|
28469
28472
|
/**
|
|
28470
28473
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
28471
28474
|
* @param {object} event Event object
|
|
@@ -28476,7 +28479,7 @@ type GridListenersTypes = {
|
|
|
28476
28479
|
* @param {Event} event.event The browser event.
|
|
28477
28480
|
* @param {string} event.region The region where the column was dropped.
|
|
28478
28481
|
*/
|
|
28479
|
-
beforeColumnDropFinalize: (event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
28482
|
+
beforeColumnDropFinalize: (event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void
|
|
28480
28483
|
/**
|
|
28481
28484
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
28482
28485
|
* `false`.
|
|
@@ -28485,7 +28488,7 @@ type GridListenersTypes = {
|
|
|
28485
28488
|
* @param {Grid.column.Column} event.column The column
|
|
28486
28489
|
* @param {Event} event.domEvent The browser event
|
|
28487
28490
|
*/
|
|
28488
|
-
beforeColumnResize: (event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
28491
|
+
beforeColumnResize: (event: { source: Grid, column: Column, domEvent: Event }) => boolean|void
|
|
28489
28492
|
/**
|
|
28490
28493
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
28491
28494
|
* @param {object} event Event object
|
|
@@ -28509,14 +28512,14 @@ type GridListenersTypes = {
|
|
|
28509
28512
|
* @param {XLSColumn[]} event.columns An array of columns to export
|
|
28510
28513
|
* @param {any[][]} event.rows An array of records to export
|
|
28511
28514
|
*/
|
|
28512
|
-
beforeExcelExport: (event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
28515
|
+
beforeExcelExport: (event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void
|
|
28513
28516
|
/**
|
|
28514
28517
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
28515
28518
|
* @param {object} event Event object
|
|
28516
28519
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
28517
28520
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
28518
28521
|
*/
|
|
28519
|
-
beforeFillHandleDragStart: (event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
28522
|
+
beforeFillHandleDragStart: (event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void
|
|
28520
28523
|
/**
|
|
28521
28524
|
* 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.
|
|
28522
28525
|
* @param {object} event Event object
|
|
@@ -28537,7 +28540,7 @@ type GridListenersTypes = {
|
|
|
28537
28540
|
* @param {object} event Event object
|
|
28538
28541
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
28539
28542
|
*/
|
|
28540
|
-
beforeHide: (event: { source: Widget }) =>
|
|
28543
|
+
beforeHide: (event: { source: Widget }) => boolean|void
|
|
28541
28544
|
/**
|
|
28542
28545
|
* Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
|
|
28543
28546
|
* @param {object} event Event object
|
|
@@ -28553,7 +28556,7 @@ type GridListenersTypes = {
|
|
|
28553
28556
|
* @param {object} event Event object
|
|
28554
28557
|
* @param {PdfExportConfig} event.config Export config
|
|
28555
28558
|
*/
|
|
28556
|
-
beforePdfExport: (event: { config: PdfExportConfig }) =>
|
|
28559
|
+
beforePdfExport: (event: { config: PdfExportConfig }) => boolean|void
|
|
28557
28560
|
/**
|
|
28558
28561
|
* Fires before a row is rendered.
|
|
28559
28562
|
* @param {object} event Event object
|
|
@@ -28596,7 +28599,7 @@ type GridListenersTypes = {
|
|
|
28596
28599
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
28597
28600
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
28598
28601
|
*/
|
|
28599
|
-
beforeSelectionChange: (event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
28602
|
+
beforeSelectionChange: (event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => boolean|void
|
|
28600
28603
|
/**
|
|
28601
28604
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
28602
28605
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -28617,19 +28620,19 @@ type GridListenersTypes = {
|
|
|
28617
28620
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
28618
28621
|
* @param {RowEditorContext} event.editorContext Editing context
|
|
28619
28622
|
*/
|
|
28620
|
-
beforeStartRowEdit: (event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
28623
|
+
beforeStartRowEdit: (event: { source: Grid, editorContext: RowEditorContext }) => boolean|void
|
|
28621
28624
|
/**
|
|
28622
28625
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
28623
28626
|
* @param {object} event Event object
|
|
28624
28627
|
* @param {GridStateInfo} event.state State object config
|
|
28625
28628
|
*/
|
|
28626
|
-
beforeStateApply: (event: { state: GridStateInfo }) =>
|
|
28629
|
+
beforeStateApply: (event: { state: GridStateInfo }) => boolean|void
|
|
28627
28630
|
/**
|
|
28628
28631
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
28629
28632
|
* @param {object} event Event object
|
|
28630
28633
|
* @param {GridStateInfo} event.state State object config
|
|
28631
28634
|
*/
|
|
28632
|
-
beforeStateSave: (event: { state: GridStateInfo }) =>
|
|
28635
|
+
beforeStateSave: (event: { state: GridStateInfo }) => boolean|void
|
|
28633
28636
|
/**
|
|
28634
28637
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
28635
28638
|
* Returning `false` from a listener prevents the operation
|
|
@@ -28639,7 +28642,7 @@ type GridListenersTypes = {
|
|
|
28639
28642
|
* @param {boolean} event.collapse Collapsed (true) or expanded (false)
|
|
28640
28643
|
* @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
28641
28644
|
*/
|
|
28642
|
-
beforeToggleGroup: (event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
28645
|
+
beforeToggleGroup: (event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void
|
|
28643
28646
|
/**
|
|
28644
28647
|
* Fired before a parent node record toggles its collapsed state.
|
|
28645
28648
|
* @param {object} event Event object
|
|
@@ -28708,7 +28711,7 @@ type GridListenersTypes = {
|
|
|
28708
28711
|
* @param {Grid.column.Column} event.column Column
|
|
28709
28712
|
* @param {Core.data.Model} event.record Record
|
|
28710
28713
|
*/
|
|
28711
|
-
cellMenuBeforeShow: (event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
28714
|
+
cellMenuBeforeShow: (event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void
|
|
28712
28715
|
/**
|
|
28713
28716
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
28714
28717
|
* @param {object} event Event object
|
|
@@ -28835,7 +28838,7 @@ type GridListenersTypes = {
|
|
|
28835
28838
|
* @param {Event} event.event The browser event.
|
|
28836
28839
|
* @param {string} event.region The region where the column was dropped.
|
|
28837
28840
|
*/
|
|
28838
|
-
columnDrop: (event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
28841
|
+
columnDrop: (event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void
|
|
28839
28842
|
/**
|
|
28840
28843
|
* This event is fired after a resize gesture is completed.
|
|
28841
28844
|
* @param {object} event Event object
|
|
@@ -28975,7 +28978,7 @@ type GridListenersTypes = {
|
|
|
28975
28978
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
28976
28979
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
28977
28980
|
*/
|
|
28978
|
-
fillHandleDragStart: (event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
28981
|
+
fillHandleDragStart: (event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void
|
|
28979
28982
|
/**
|
|
28980
28983
|
* Fires on the owning Grid when cell editing is finished
|
|
28981
28984
|
* @param {object} event Event object
|
|
@@ -29023,7 +29026,7 @@ type GridListenersTypes = {
|
|
|
29023
29026
|
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
29024
29027
|
* @param {MouseEvent,TouchEvent} event.event
|
|
29025
29028
|
*/
|
|
29026
|
-
gridRowBeforeDragStart: (event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
29029
|
+
gridRowBeforeDragStart: (event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void
|
|
29027
29030
|
/**
|
|
29028
29031
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
29029
29032
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
@@ -29090,7 +29093,7 @@ type GridListenersTypes = {
|
|
|
29090
29093
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
29091
29094
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
29092
29095
|
*/
|
|
29093
|
-
headerClick: (event: { domEvent: Event, column: Column }) =>
|
|
29096
|
+
headerClick: (event: { domEvent: Event, column: Column }) => boolean|void
|
|
29094
29097
|
/**
|
|
29095
29098
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
29096
29099
|
* 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).
|
|
@@ -29101,7 +29104,7 @@ type GridListenersTypes = {
|
|
|
29101
29104
|
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
29102
29105
|
* @param {Grid.column.Column} event.column Column
|
|
29103
29106
|
*/
|
|
29104
|
-
headerMenuBeforeShow: (event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
29107
|
+
headerMenuBeforeShow: (event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void
|
|
29105
29108
|
/**
|
|
29106
29109
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
29107
29110
|
* @param {object} event Event object
|
|
@@ -29312,7 +29315,7 @@ type GridListenersTypes = {
|
|
|
29312
29315
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
29313
29316
|
* @param {Event} event.domEvent The native DOM event
|
|
29314
29317
|
*/
|
|
29315
|
-
splitterCollapseClick: (event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
29318
|
+
splitterCollapseClick: (event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void
|
|
29316
29319
|
/**
|
|
29317
29320
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
29318
29321
|
* @param {object} event Event object
|
|
@@ -29337,7 +29340,7 @@ type GridListenersTypes = {
|
|
|
29337
29340
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
29338
29341
|
* @param {Event} event.domEvent The native DOM event
|
|
29339
29342
|
*/
|
|
29340
|
-
splitterExpandClick: (event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
29343
|
+
splitterExpandClick: (event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void
|
|
29341
29344
|
/**
|
|
29342
29345
|
* Fires on the owning Grid when editing starts
|
|
29343
29346
|
* @param {object} event Event object
|
|
@@ -29426,14 +29429,14 @@ type GridListeners = {
|
|
|
29426
29429
|
* @param {string} event.lineDelimiter The CSV delimiter to separate lines
|
|
29427
29430
|
* @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
|
|
29428
29431
|
*/
|
|
29429
|
-
beforeCSVExport?: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
29432
|
+
beforeCSVExport?: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void)|string
|
|
29430
29433
|
/**
|
|
29431
29434
|
* Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
|
|
29432
29435
|
* @param {object} event Event object
|
|
29433
29436
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
29434
29437
|
* @param {Grid.util.GridLocation} event.editorContext Editing context
|
|
29435
29438
|
*/
|
|
29436
|
-
beforeCancelCellEdit?: ((event: { source: Grid, editorContext: GridLocation }) =>
|
|
29439
|
+
beforeCancelCellEdit?: ((event: { source: Grid, editorContext: GridLocation }) => boolean|void)|string
|
|
29437
29440
|
/**
|
|
29438
29441
|
* 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.
|
|
29439
29442
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-beforeCancelRowEdit)
|
|
@@ -29448,7 +29451,7 @@ type GridListeners = {
|
|
|
29448
29451
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
29449
29452
|
* @param {CellEditorContext} event.editorContext Editing context
|
|
29450
29453
|
*/
|
|
29451
|
-
beforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
29454
|
+
beforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => boolean|void)|string
|
|
29452
29455
|
/**
|
|
29453
29456
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
29454
29457
|
* buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
|
|
@@ -29456,7 +29459,7 @@ type GridListeners = {
|
|
|
29456
29459
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
29457
29460
|
* @param {(Grid.util.GridLocation|Core.data.Model)[]} 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).
|
|
29458
29461
|
*/
|
|
29459
|
-
beforeCellRangeDelete?: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
29462
|
+
beforeCellRangeDelete?: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void)|string
|
|
29460
29463
|
/**
|
|
29461
29464
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
29462
29465
|
* @param {object} event Event object
|
|
@@ -29464,7 +29467,7 @@ type GridListeners = {
|
|
|
29464
29467
|
* @param {string} event.field The field being changed
|
|
29465
29468
|
* @param {any} event.value The value being set
|
|
29466
29469
|
*/
|
|
29467
|
-
beforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) =>
|
|
29470
|
+
beforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => boolean|void)|string
|
|
29468
29471
|
/**
|
|
29469
29472
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
29470
29473
|
* @param {object} event Event object
|
|
@@ -29480,7 +29483,7 @@ type GridListeners = {
|
|
|
29480
29483
|
* @param {Grid.column.Column} event.column The dragged column.
|
|
29481
29484
|
* @param {Event} event.event The browser event.
|
|
29482
29485
|
*/
|
|
29483
|
-
beforeColumnDragStart?: ((event: { source: Grid, column: Column, event: Event }) =>
|
|
29486
|
+
beforeColumnDragStart?: ((event: { source: Grid, column: Column, event: Event }) => boolean|void)|string
|
|
29484
29487
|
/**
|
|
29485
29488
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
29486
29489
|
* @param {object} event Event object
|
|
@@ -29491,7 +29494,7 @@ type GridListeners = {
|
|
|
29491
29494
|
* @param {Event} event.event The browser event.
|
|
29492
29495
|
* @param {string} event.region The region where the column was dropped.
|
|
29493
29496
|
*/
|
|
29494
|
-
beforeColumnDropFinalize?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
29497
|
+
beforeColumnDropFinalize?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void)|string
|
|
29495
29498
|
/**
|
|
29496
29499
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
29497
29500
|
* `false`.
|
|
@@ -29500,7 +29503,7 @@ type GridListeners = {
|
|
|
29500
29503
|
* @param {Grid.column.Column} event.column The column
|
|
29501
29504
|
* @param {Event} event.domEvent The browser event
|
|
29502
29505
|
*/
|
|
29503
|
-
beforeColumnResize?: ((event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
29506
|
+
beforeColumnResize?: ((event: { source: Grid, column: Column, domEvent: Event }) => boolean|void)|string
|
|
29504
29507
|
/**
|
|
29505
29508
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
29506
29509
|
* @param {object} event Event object
|
|
@@ -29524,14 +29527,14 @@ type GridListeners = {
|
|
|
29524
29527
|
* @param {XLSColumn[]} event.columns An array of columns to export
|
|
29525
29528
|
* @param {any[][]} event.rows An array of records to export
|
|
29526
29529
|
*/
|
|
29527
|
-
beforeExcelExport?: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
29530
|
+
beforeExcelExport?: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void)|string
|
|
29528
29531
|
/**
|
|
29529
29532
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
29530
29533
|
* @param {object} event Event object
|
|
29531
29534
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
29532
29535
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
29533
29536
|
*/
|
|
29534
|
-
beforeFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
29537
|
+
beforeFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
29535
29538
|
/**
|
|
29536
29539
|
* 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.
|
|
29537
29540
|
* @param {object} event Event object
|
|
@@ -29552,7 +29555,7 @@ type GridListeners = {
|
|
|
29552
29555
|
* @param {object} event Event object
|
|
29553
29556
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
29554
29557
|
*/
|
|
29555
|
-
beforeHide?: ((event: { source: Widget }) =>
|
|
29558
|
+
beforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
29556
29559
|
/**
|
|
29557
29560
|
* Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
|
|
29558
29561
|
* @param {object} event Event object
|
|
@@ -29568,7 +29571,7 @@ type GridListeners = {
|
|
|
29568
29571
|
* @param {object} event Event object
|
|
29569
29572
|
* @param {PdfExportConfig} event.config Export config
|
|
29570
29573
|
*/
|
|
29571
|
-
beforePdfExport?: ((event: { config: PdfExportConfig }) =>
|
|
29574
|
+
beforePdfExport?: ((event: { config: PdfExportConfig }) => boolean|void)|string
|
|
29572
29575
|
/**
|
|
29573
29576
|
* Fires before a row is rendered.
|
|
29574
29577
|
* @param {object} event Event object
|
|
@@ -29611,7 +29614,7 @@ type GridListeners = {
|
|
|
29611
29614
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
29612
29615
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
29613
29616
|
*/
|
|
29614
|
-
beforeSelectionChange?: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
29617
|
+
beforeSelectionChange?: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => boolean|void)|string
|
|
29615
29618
|
/**
|
|
29616
29619
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
29617
29620
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -29632,19 +29635,19 @@ type GridListeners = {
|
|
|
29632
29635
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
29633
29636
|
* @param {RowEditorContext} event.editorContext Editing context
|
|
29634
29637
|
*/
|
|
29635
|
-
beforeStartRowEdit?: ((event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
29638
|
+
beforeStartRowEdit?: ((event: { source: Grid, editorContext: RowEditorContext }) => boolean|void)|string
|
|
29636
29639
|
/**
|
|
29637
29640
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
29638
29641
|
* @param {object} event Event object
|
|
29639
29642
|
* @param {GridStateInfo} event.state State object config
|
|
29640
29643
|
*/
|
|
29641
|
-
beforeStateApply?: ((event: { state: GridStateInfo }) =>
|
|
29644
|
+
beforeStateApply?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
29642
29645
|
/**
|
|
29643
29646
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
29644
29647
|
* @param {object} event Event object
|
|
29645
29648
|
* @param {GridStateInfo} event.state State object config
|
|
29646
29649
|
*/
|
|
29647
|
-
beforeStateSave?: ((event: { state: GridStateInfo }) =>
|
|
29650
|
+
beforeStateSave?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
29648
29651
|
/**
|
|
29649
29652
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
29650
29653
|
* Returning `false` from a listener prevents the operation
|
|
@@ -29654,7 +29657,7 @@ type GridListeners = {
|
|
|
29654
29657
|
* @param {boolean} event.collapse Collapsed (true) or expanded (false)
|
|
29655
29658
|
* @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
29656
29659
|
*/
|
|
29657
|
-
beforeToggleGroup?: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
29660
|
+
beforeToggleGroup?: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void)|string
|
|
29658
29661
|
/**
|
|
29659
29662
|
* Fired before a parent node record toggles its collapsed state.
|
|
29660
29663
|
* @param {object} event Event object
|
|
@@ -29723,7 +29726,7 @@ type GridListeners = {
|
|
|
29723
29726
|
* @param {Grid.column.Column} event.column Column
|
|
29724
29727
|
* @param {Core.data.Model} event.record Record
|
|
29725
29728
|
*/
|
|
29726
|
-
cellMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
29729
|
+
cellMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void)|string
|
|
29727
29730
|
/**
|
|
29728
29731
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
29729
29732
|
* @param {object} event Event object
|
|
@@ -29850,7 +29853,7 @@ type GridListeners = {
|
|
|
29850
29853
|
* @param {Event} event.event The browser event.
|
|
29851
29854
|
* @param {string} event.region The region where the column was dropped.
|
|
29852
29855
|
*/
|
|
29853
|
-
columnDrop?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
29856
|
+
columnDrop?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void)|string
|
|
29854
29857
|
/**
|
|
29855
29858
|
* This event is fired after a resize gesture is completed.
|
|
29856
29859
|
* @param {object} event Event object
|
|
@@ -29990,7 +29993,7 @@ type GridListeners = {
|
|
|
29990
29993
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
29991
29994
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
29992
29995
|
*/
|
|
29993
|
-
fillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
29996
|
+
fillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
29994
29997
|
/**
|
|
29995
29998
|
* Fires on the owning Grid when cell editing is finished
|
|
29996
29999
|
* @param {object} event Event object
|
|
@@ -30038,7 +30041,7 @@ type GridListeners = {
|
|
|
30038
30041
|
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
30039
30042
|
* @param {MouseEvent,TouchEvent} event.event
|
|
30040
30043
|
*/
|
|
30041
|
-
gridRowBeforeDragStart?: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
30044
|
+
gridRowBeforeDragStart?: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void)|string
|
|
30042
30045
|
/**
|
|
30043
30046
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
30044
30047
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
@@ -30105,7 +30108,7 @@ type GridListeners = {
|
|
|
30105
30108
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
30106
30109
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
30107
30110
|
*/
|
|
30108
|
-
headerClick?: ((event: { domEvent: Event, column: Column }) =>
|
|
30111
|
+
headerClick?: ((event: { domEvent: Event, column: Column }) => boolean|void)|string
|
|
30109
30112
|
/**
|
|
30110
30113
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
30111
30114
|
* 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).
|
|
@@ -30116,7 +30119,7 @@ type GridListeners = {
|
|
|
30116
30119
|
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
30117
30120
|
* @param {Grid.column.Column} event.column Column
|
|
30118
30121
|
*/
|
|
30119
|
-
headerMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
30122
|
+
headerMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void)|string
|
|
30120
30123
|
/**
|
|
30121
30124
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
30122
30125
|
* @param {object} event Event object
|
|
@@ -30327,7 +30330,7 @@ type GridListeners = {
|
|
|
30327
30330
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
30328
30331
|
* @param {Event} event.domEvent The native DOM event
|
|
30329
30332
|
*/
|
|
30330
|
-
splitterCollapseClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
30333
|
+
splitterCollapseClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
30331
30334
|
/**
|
|
30332
30335
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
30333
30336
|
* @param {object} event Event object
|
|
@@ -30352,7 +30355,7 @@ type GridListeners = {
|
|
|
30352
30355
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
30353
30356
|
* @param {Event} event.domEvent The native DOM event
|
|
30354
30357
|
*/
|
|
30355
|
-
splitterExpandClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
30358
|
+
splitterExpandClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
30356
30359
|
/**
|
|
30357
30360
|
* Fires on the owning Grid when editing starts
|
|
30358
30361
|
* @param {object} event Event object
|
|
@@ -31236,14 +31239,14 @@ type GridConfig = {
|
|
|
31236
31239
|
* @param {string} event.lineDelimiter The CSV delimiter to separate lines
|
|
31237
31240
|
* @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
|
|
31238
31241
|
*/
|
|
31239
|
-
onBeforeCSVExport?: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
31242
|
+
onBeforeCSVExport?: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void)|string
|
|
31240
31243
|
/**
|
|
31241
31244
|
* Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
|
|
31242
31245
|
* @param {object} event Event object
|
|
31243
31246
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
31244
31247
|
* @param {Grid.util.GridLocation} event.editorContext Editing context
|
|
31245
31248
|
*/
|
|
31246
|
-
onBeforeCancelCellEdit?: ((event: { source: Grid, editorContext: GridLocation }) =>
|
|
31249
|
+
onBeforeCancelCellEdit?: ((event: { source: Grid, editorContext: GridLocation }) => boolean|void)|string
|
|
31247
31250
|
/**
|
|
31248
31251
|
* 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.
|
|
31249
31252
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-beforeCancelRowEdit)
|
|
@@ -31258,7 +31261,7 @@ type GridConfig = {
|
|
|
31258
31261
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
31259
31262
|
* @param {CellEditorContext} event.editorContext Editing context
|
|
31260
31263
|
*/
|
|
31261
|
-
onBeforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
31264
|
+
onBeforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => boolean|void)|string
|
|
31262
31265
|
/**
|
|
31263
31266
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
31264
31267
|
* buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
|
|
@@ -31266,7 +31269,7 @@ type GridConfig = {
|
|
|
31266
31269
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
31267
31270
|
* @param {(Grid.util.GridLocation|Core.data.Model)[]} 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).
|
|
31268
31271
|
*/
|
|
31269
|
-
onBeforeCellRangeDelete?: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
31272
|
+
onBeforeCellRangeDelete?: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void)|string
|
|
31270
31273
|
/**
|
|
31271
31274
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
31272
31275
|
* @param {object} event Event object
|
|
@@ -31274,7 +31277,7 @@ type GridConfig = {
|
|
|
31274
31277
|
* @param {string} event.field The field being changed
|
|
31275
31278
|
* @param {any} event.value The value being set
|
|
31276
31279
|
*/
|
|
31277
|
-
onBeforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) =>
|
|
31280
|
+
onBeforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => boolean|void)|string
|
|
31278
31281
|
/**
|
|
31279
31282
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
31280
31283
|
* @param {object} event Event object
|
|
@@ -31290,7 +31293,7 @@ type GridConfig = {
|
|
|
31290
31293
|
* @param {Grid.column.Column} event.column The dragged column.
|
|
31291
31294
|
* @param {Event} event.event The browser event.
|
|
31292
31295
|
*/
|
|
31293
|
-
onBeforeColumnDragStart?: ((event: { source: Grid, column: Column, event: Event }) =>
|
|
31296
|
+
onBeforeColumnDragStart?: ((event: { source: Grid, column: Column, event: Event }) => boolean|void)|string
|
|
31294
31297
|
/**
|
|
31295
31298
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
31296
31299
|
* @param {object} event Event object
|
|
@@ -31301,7 +31304,7 @@ type GridConfig = {
|
|
|
31301
31304
|
* @param {Event} event.event The browser event.
|
|
31302
31305
|
* @param {string} event.region The region where the column was dropped.
|
|
31303
31306
|
*/
|
|
31304
|
-
onBeforeColumnDropFinalize?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
31307
|
+
onBeforeColumnDropFinalize?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void)|string
|
|
31305
31308
|
/**
|
|
31306
31309
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
31307
31310
|
* `false`.
|
|
@@ -31310,7 +31313,7 @@ type GridConfig = {
|
|
|
31310
31313
|
* @param {Grid.column.Column} event.column The column
|
|
31311
31314
|
* @param {Event} event.domEvent The browser event
|
|
31312
31315
|
*/
|
|
31313
|
-
onBeforeColumnResize?: ((event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
31316
|
+
onBeforeColumnResize?: ((event: { source: Grid, column: Column, domEvent: Event }) => boolean|void)|string
|
|
31314
31317
|
/**
|
|
31315
31318
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
31316
31319
|
* @param {object} event Event object
|
|
@@ -31334,14 +31337,14 @@ type GridConfig = {
|
|
|
31334
31337
|
* @param {XLSColumn[]} event.columns An array of columns to export
|
|
31335
31338
|
* @param {any[][]} event.rows An array of records to export
|
|
31336
31339
|
*/
|
|
31337
|
-
onBeforeExcelExport?: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
31340
|
+
onBeforeExcelExport?: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void)|string
|
|
31338
31341
|
/**
|
|
31339
31342
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
31340
31343
|
* @param {object} event Event object
|
|
31341
31344
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
31342
31345
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
31343
31346
|
*/
|
|
31344
|
-
onBeforeFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
31347
|
+
onBeforeFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
31345
31348
|
/**
|
|
31346
31349
|
* 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.
|
|
31347
31350
|
* @param {object} event Event object
|
|
@@ -31362,7 +31365,7 @@ type GridConfig = {
|
|
|
31362
31365
|
* @param {object} event Event object
|
|
31363
31366
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
31364
31367
|
*/
|
|
31365
|
-
onBeforeHide?: ((event: { source: Widget }) =>
|
|
31368
|
+
onBeforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
31366
31369
|
/**
|
|
31367
31370
|
* Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
|
|
31368
31371
|
* @param {object} event Event object
|
|
@@ -31378,7 +31381,7 @@ type GridConfig = {
|
|
|
31378
31381
|
* @param {object} event Event object
|
|
31379
31382
|
* @param {PdfExportConfig} event.config Export config
|
|
31380
31383
|
*/
|
|
31381
|
-
onBeforePdfExport?: ((event: { config: PdfExportConfig }) =>
|
|
31384
|
+
onBeforePdfExport?: ((event: { config: PdfExportConfig }) => boolean|void)|string
|
|
31382
31385
|
/**
|
|
31383
31386
|
* Fires before a row is rendered.
|
|
31384
31387
|
* @param {object} event Event object
|
|
@@ -31421,7 +31424,7 @@ type GridConfig = {
|
|
|
31421
31424
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
31422
31425
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
31423
31426
|
*/
|
|
31424
|
-
onBeforeSelectionChange?: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
31427
|
+
onBeforeSelectionChange?: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => boolean|void)|string
|
|
31425
31428
|
/**
|
|
31426
31429
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
31427
31430
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -31442,19 +31445,19 @@ type GridConfig = {
|
|
|
31442
31445
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
31443
31446
|
* @param {RowEditorContext} event.editorContext Editing context
|
|
31444
31447
|
*/
|
|
31445
|
-
onBeforeStartRowEdit?: ((event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
31448
|
+
onBeforeStartRowEdit?: ((event: { source: Grid, editorContext: RowEditorContext }) => boolean|void)|string
|
|
31446
31449
|
/**
|
|
31447
31450
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
31448
31451
|
* @param {object} event Event object
|
|
31449
31452
|
* @param {GridStateInfo} event.state State object config
|
|
31450
31453
|
*/
|
|
31451
|
-
onBeforeStateApply?: ((event: { state: GridStateInfo }) =>
|
|
31454
|
+
onBeforeStateApply?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
31452
31455
|
/**
|
|
31453
31456
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
31454
31457
|
* @param {object} event Event object
|
|
31455
31458
|
* @param {GridStateInfo} event.state State object config
|
|
31456
31459
|
*/
|
|
31457
|
-
onBeforeStateSave?: ((event: { state: GridStateInfo }) =>
|
|
31460
|
+
onBeforeStateSave?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
31458
31461
|
/**
|
|
31459
31462
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
31460
31463
|
* Returning `false` from a listener prevents the operation
|
|
@@ -31464,7 +31467,7 @@ type GridConfig = {
|
|
|
31464
31467
|
* @param {boolean} event.collapse Collapsed (true) or expanded (false)
|
|
31465
31468
|
* @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
31466
31469
|
*/
|
|
31467
|
-
onBeforeToggleGroup?: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
31470
|
+
onBeforeToggleGroup?: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void)|string
|
|
31468
31471
|
/**
|
|
31469
31472
|
* Fired before a parent node record toggles its collapsed state.
|
|
31470
31473
|
* @param {object} event Event object
|
|
@@ -31533,7 +31536,7 @@ type GridConfig = {
|
|
|
31533
31536
|
* @param {Grid.column.Column} event.column Column
|
|
31534
31537
|
* @param {Core.data.Model} event.record Record
|
|
31535
31538
|
*/
|
|
31536
|
-
onCellMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
31539
|
+
onCellMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void)|string
|
|
31537
31540
|
/**
|
|
31538
31541
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
31539
31542
|
* @param {object} event Event object
|
|
@@ -31660,7 +31663,7 @@ type GridConfig = {
|
|
|
31660
31663
|
* @param {Event} event.event The browser event.
|
|
31661
31664
|
* @param {string} event.region The region where the column was dropped.
|
|
31662
31665
|
*/
|
|
31663
|
-
onColumnDrop?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
31666
|
+
onColumnDrop?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void)|string
|
|
31664
31667
|
/**
|
|
31665
31668
|
* This event is fired after a resize gesture is completed.
|
|
31666
31669
|
* @param {object} event Event object
|
|
@@ -31800,7 +31803,7 @@ type GridConfig = {
|
|
|
31800
31803
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
31801
31804
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
31802
31805
|
*/
|
|
31803
|
-
onFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
31806
|
+
onFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
31804
31807
|
/**
|
|
31805
31808
|
* Fires on the owning Grid when cell editing is finished
|
|
31806
31809
|
* @param {object} event Event object
|
|
@@ -31848,7 +31851,7 @@ type GridConfig = {
|
|
|
31848
31851
|
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
31849
31852
|
* @param {MouseEvent,TouchEvent} event.event
|
|
31850
31853
|
*/
|
|
31851
|
-
onGridRowBeforeDragStart?: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
31854
|
+
onGridRowBeforeDragStart?: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void)|string
|
|
31852
31855
|
/**
|
|
31853
31856
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
31854
31857
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
@@ -31915,7 +31918,7 @@ type GridConfig = {
|
|
|
31915
31918
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
31916
31919
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
31917
31920
|
*/
|
|
31918
|
-
onHeaderClick?: ((event: { domEvent: Event, column: Column }) =>
|
|
31921
|
+
onHeaderClick?: ((event: { domEvent: Event, column: Column }) => boolean|void)|string
|
|
31919
31922
|
/**
|
|
31920
31923
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
31921
31924
|
* 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).
|
|
@@ -31926,7 +31929,7 @@ type GridConfig = {
|
|
|
31926
31929
|
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
31927
31930
|
* @param {Grid.column.Column} event.column Column
|
|
31928
31931
|
*/
|
|
31929
|
-
onHeaderMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
31932
|
+
onHeaderMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void)|string
|
|
31930
31933
|
/**
|
|
31931
31934
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
31932
31935
|
* @param {object} event Event object
|
|
@@ -32137,7 +32140,7 @@ type GridConfig = {
|
|
|
32137
32140
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
32138
32141
|
* @param {Event} event.domEvent The native DOM event
|
|
32139
32142
|
*/
|
|
32140
|
-
onSplitterCollapseClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
32143
|
+
onSplitterCollapseClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
32141
32144
|
/**
|
|
32142
32145
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
32143
32146
|
* @param {object} event Event object
|
|
@@ -32162,7 +32165,7 @@ type GridConfig = {
|
|
|
32162
32165
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
32163
32166
|
* @param {Event} event.domEvent The native DOM event
|
|
32164
32167
|
*/
|
|
32165
|
-
onSplitterExpandClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
32168
|
+
onSplitterExpandClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
32166
32169
|
/**
|
|
32167
32170
|
* Fires on the owning Grid when editing starts
|
|
32168
32171
|
* @param {object} event Event object
|
|
@@ -32271,19 +32274,19 @@ export class Grid extends GridBase {
|
|
|
32271
32274
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
32272
32275
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
32273
32276
|
*/
|
|
32274
|
-
onBeforeSelectionChange: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
32277
|
+
onBeforeSelectionChange: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => boolean|void)|string
|
|
32275
32278
|
/**
|
|
32276
32279
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
32277
32280
|
* @param {object} event Event object
|
|
32278
32281
|
* @param {GridStateInfo} event.state State object config
|
|
32279
32282
|
*/
|
|
32280
|
-
onBeforeStateApply: ((event: { state: GridStateInfo }) =>
|
|
32283
|
+
onBeforeStateApply: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
32281
32284
|
/**
|
|
32282
32285
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
32283
32286
|
* @param {object} event Event object
|
|
32284
32287
|
* @param {GridStateInfo} event.state State object config
|
|
32285
32288
|
*/
|
|
32286
|
-
onBeforeStateSave: ((event: { state: GridStateInfo }) =>
|
|
32289
|
+
onBeforeStateSave: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
32287
32290
|
/**
|
|
32288
32291
|
* Fires when any other event is fired from the object.
|
|
32289
32292
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-catchAll)
|
|
@@ -32389,7 +32392,7 @@ export class Grid extends GridBase {
|
|
|
32389
32392
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
32390
32393
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
32391
32394
|
*/
|
|
32392
|
-
onHeaderClick: ((event: { domEvent: Event, column: Column }) =>
|
|
32395
|
+
onHeaderClick: ((event: { domEvent: Event, column: Column }) => boolean|void)|string
|
|
32393
32396
|
/**
|
|
32394
32397
|
* Mouse moved out from element in grid
|
|
32395
32398
|
* @param {object} event Event object
|
|
@@ -32467,14 +32470,14 @@ type GridBaseListenersTypes = {
|
|
|
32467
32470
|
* @param {string} event.lineDelimiter The CSV delimiter to separate lines
|
|
32468
32471
|
* @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
|
|
32469
32472
|
*/
|
|
32470
|
-
beforeCSVExport: (event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
32473
|
+
beforeCSVExport: (event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void
|
|
32471
32474
|
/**
|
|
32472
32475
|
* Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
|
|
32473
32476
|
* @param {object} event Event object
|
|
32474
32477
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
32475
32478
|
* @param {Grid.util.GridLocation} event.editorContext Editing context
|
|
32476
32479
|
*/
|
|
32477
|
-
beforeCancelCellEdit: (event: { source: Grid, editorContext: GridLocation }) =>
|
|
32480
|
+
beforeCancelCellEdit: (event: { source: Grid, editorContext: GridLocation }) => boolean|void
|
|
32478
32481
|
/**
|
|
32479
32482
|
* 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.
|
|
32480
32483
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-beforeCancelRowEdit)
|
|
@@ -32489,7 +32492,7 @@ type GridBaseListenersTypes = {
|
|
|
32489
32492
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
32490
32493
|
* @param {CellEditorContext} event.editorContext Editing context
|
|
32491
32494
|
*/
|
|
32492
|
-
beforeCellEditStart: (event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
32495
|
+
beforeCellEditStart: (event: { source: Grid, editorContext: CellEditorContext }) => boolean|void
|
|
32493
32496
|
/**
|
|
32494
32497
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
32495
32498
|
* buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
|
|
@@ -32497,7 +32500,7 @@ type GridBaseListenersTypes = {
|
|
|
32497
32500
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
32498
32501
|
* @param {(Grid.util.GridLocation|Core.data.Model)[]} 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).
|
|
32499
32502
|
*/
|
|
32500
|
-
beforeCellRangeDelete: (event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
32503
|
+
beforeCellRangeDelete: (event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void
|
|
32501
32504
|
/**
|
|
32502
32505
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
32503
32506
|
* @param {object} event Event object
|
|
@@ -32505,7 +32508,7 @@ type GridBaseListenersTypes = {
|
|
|
32505
32508
|
* @param {string} event.field The field being changed
|
|
32506
32509
|
* @param {any} event.value The value being set
|
|
32507
32510
|
*/
|
|
32508
|
-
beforeCellRangeEdit: (event: { record: Model, field: string, value: any }) =>
|
|
32511
|
+
beforeCellRangeEdit: (event: { record: Model, field: string, value: any }) => boolean|void
|
|
32509
32512
|
/**
|
|
32510
32513
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
32511
32514
|
* @param {object} event Event object
|
|
@@ -32521,7 +32524,7 @@ type GridBaseListenersTypes = {
|
|
|
32521
32524
|
* @param {Grid.column.Column} event.column The dragged column.
|
|
32522
32525
|
* @param {Event} event.event The browser event.
|
|
32523
32526
|
*/
|
|
32524
|
-
beforeColumnDragStart: (event: { source: Grid, column: Column, event: Event }) =>
|
|
32527
|
+
beforeColumnDragStart: (event: { source: Grid, column: Column, event: Event }) => boolean|void
|
|
32525
32528
|
/**
|
|
32526
32529
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
32527
32530
|
* @param {object} event Event object
|
|
@@ -32532,7 +32535,7 @@ type GridBaseListenersTypes = {
|
|
|
32532
32535
|
* @param {Event} event.event The browser event.
|
|
32533
32536
|
* @param {string} event.region The region where the column was dropped.
|
|
32534
32537
|
*/
|
|
32535
|
-
beforeColumnDropFinalize: (event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
32538
|
+
beforeColumnDropFinalize: (event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void
|
|
32536
32539
|
/**
|
|
32537
32540
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
32538
32541
|
* `false`.
|
|
@@ -32541,7 +32544,7 @@ type GridBaseListenersTypes = {
|
|
|
32541
32544
|
* @param {Grid.column.Column} event.column The column
|
|
32542
32545
|
* @param {Event} event.domEvent The browser event
|
|
32543
32546
|
*/
|
|
32544
|
-
beforeColumnResize: (event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
32547
|
+
beforeColumnResize: (event: { source: Grid, column: Column, domEvent: Event }) => boolean|void
|
|
32545
32548
|
/**
|
|
32546
32549
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
32547
32550
|
* @param {object} event Event object
|
|
@@ -32565,14 +32568,14 @@ type GridBaseListenersTypes = {
|
|
|
32565
32568
|
* @param {XLSColumn[]} event.columns An array of columns to export
|
|
32566
32569
|
* @param {any[][]} event.rows An array of records to export
|
|
32567
32570
|
*/
|
|
32568
|
-
beforeExcelExport: (event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
32571
|
+
beforeExcelExport: (event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void
|
|
32569
32572
|
/**
|
|
32570
32573
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
32571
32574
|
* @param {object} event Event object
|
|
32572
32575
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
32573
32576
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
32574
32577
|
*/
|
|
32575
|
-
beforeFillHandleDragStart: (event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
32578
|
+
beforeFillHandleDragStart: (event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void
|
|
32576
32579
|
/**
|
|
32577
32580
|
* 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.
|
|
32578
32581
|
* @param {object} event Event object
|
|
@@ -32593,7 +32596,7 @@ type GridBaseListenersTypes = {
|
|
|
32593
32596
|
* @param {object} event Event object
|
|
32594
32597
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
32595
32598
|
*/
|
|
32596
|
-
beforeHide: (event: { source: Widget }) =>
|
|
32599
|
+
beforeHide: (event: { source: Widget }) => boolean|void
|
|
32597
32600
|
/**
|
|
32598
32601
|
* Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
|
|
32599
32602
|
* @param {object} event Event object
|
|
@@ -32609,7 +32612,7 @@ type GridBaseListenersTypes = {
|
|
|
32609
32612
|
* @param {object} event Event object
|
|
32610
32613
|
* @param {PdfExportConfig} event.config Export config
|
|
32611
32614
|
*/
|
|
32612
|
-
beforePdfExport: (event: { config: PdfExportConfig }) =>
|
|
32615
|
+
beforePdfExport: (event: { config: PdfExportConfig }) => boolean|void
|
|
32613
32616
|
/**
|
|
32614
32617
|
* Fires before a row is rendered.
|
|
32615
32618
|
* @param {object} event Event object
|
|
@@ -32652,7 +32655,7 @@ type GridBaseListenersTypes = {
|
|
|
32652
32655
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
32653
32656
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
32654
32657
|
*/
|
|
32655
|
-
beforeSelectionChange: (event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
32658
|
+
beforeSelectionChange: (event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => boolean|void
|
|
32656
32659
|
/**
|
|
32657
32660
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
32658
32661
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -32673,19 +32676,19 @@ type GridBaseListenersTypes = {
|
|
|
32673
32676
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
32674
32677
|
* @param {RowEditorContext} event.editorContext Editing context
|
|
32675
32678
|
*/
|
|
32676
|
-
beforeStartRowEdit: (event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
32679
|
+
beforeStartRowEdit: (event: { source: Grid, editorContext: RowEditorContext }) => boolean|void
|
|
32677
32680
|
/**
|
|
32678
32681
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
32679
32682
|
* @param {object} event Event object
|
|
32680
32683
|
* @param {GridStateInfo} event.state State object config
|
|
32681
32684
|
*/
|
|
32682
|
-
beforeStateApply: (event: { state: GridStateInfo }) =>
|
|
32685
|
+
beforeStateApply: (event: { state: GridStateInfo }) => boolean|void
|
|
32683
32686
|
/**
|
|
32684
32687
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
32685
32688
|
* @param {object} event Event object
|
|
32686
32689
|
* @param {GridStateInfo} event.state State object config
|
|
32687
32690
|
*/
|
|
32688
|
-
beforeStateSave: (event: { state: GridStateInfo }) =>
|
|
32691
|
+
beforeStateSave: (event: { state: GridStateInfo }) => boolean|void
|
|
32689
32692
|
/**
|
|
32690
32693
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
32691
32694
|
* Returning `false` from a listener prevents the operation
|
|
@@ -32695,7 +32698,7 @@ type GridBaseListenersTypes = {
|
|
|
32695
32698
|
* @param {boolean} event.collapse Collapsed (true) or expanded (false)
|
|
32696
32699
|
* @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
32697
32700
|
*/
|
|
32698
|
-
beforeToggleGroup: (event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
32701
|
+
beforeToggleGroup: (event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void
|
|
32699
32702
|
/**
|
|
32700
32703
|
* Fired before a parent node record toggles its collapsed state.
|
|
32701
32704
|
* @param {object} event Event object
|
|
@@ -32764,7 +32767,7 @@ type GridBaseListenersTypes = {
|
|
|
32764
32767
|
* @param {Grid.column.Column} event.column Column
|
|
32765
32768
|
* @param {Core.data.Model} event.record Record
|
|
32766
32769
|
*/
|
|
32767
|
-
cellMenuBeforeShow: (event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
32770
|
+
cellMenuBeforeShow: (event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void
|
|
32768
32771
|
/**
|
|
32769
32772
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
32770
32773
|
* @param {object} event Event object
|
|
@@ -32891,7 +32894,7 @@ type GridBaseListenersTypes = {
|
|
|
32891
32894
|
* @param {Event} event.event The browser event.
|
|
32892
32895
|
* @param {string} event.region The region where the column was dropped.
|
|
32893
32896
|
*/
|
|
32894
|
-
columnDrop: (event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
32897
|
+
columnDrop: (event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void
|
|
32895
32898
|
/**
|
|
32896
32899
|
* This event is fired after a resize gesture is completed.
|
|
32897
32900
|
* @param {object} event Event object
|
|
@@ -33031,7 +33034,7 @@ type GridBaseListenersTypes = {
|
|
|
33031
33034
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
33032
33035
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
33033
33036
|
*/
|
|
33034
|
-
fillHandleDragStart: (event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
33037
|
+
fillHandleDragStart: (event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void
|
|
33035
33038
|
/**
|
|
33036
33039
|
* Fires on the owning Grid when cell editing is finished
|
|
33037
33040
|
* @param {object} event Event object
|
|
@@ -33079,7 +33082,7 @@ type GridBaseListenersTypes = {
|
|
|
33079
33082
|
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
33080
33083
|
* @param {MouseEvent,TouchEvent} event.event
|
|
33081
33084
|
*/
|
|
33082
|
-
gridRowBeforeDragStart: (event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
33085
|
+
gridRowBeforeDragStart: (event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void
|
|
33083
33086
|
/**
|
|
33084
33087
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
33085
33088
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
@@ -33146,7 +33149,7 @@ type GridBaseListenersTypes = {
|
|
|
33146
33149
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
33147
33150
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
33148
33151
|
*/
|
|
33149
|
-
headerClick: (event: { domEvent: Event, column: Column }) =>
|
|
33152
|
+
headerClick: (event: { domEvent: Event, column: Column }) => boolean|void
|
|
33150
33153
|
/**
|
|
33151
33154
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
33152
33155
|
* 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).
|
|
@@ -33157,7 +33160,7 @@ type GridBaseListenersTypes = {
|
|
|
33157
33160
|
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
33158
33161
|
* @param {Grid.column.Column} event.column Column
|
|
33159
33162
|
*/
|
|
33160
|
-
headerMenuBeforeShow: (event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
33163
|
+
headerMenuBeforeShow: (event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void
|
|
33161
33164
|
/**
|
|
33162
33165
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
33163
33166
|
* @param {object} event Event object
|
|
@@ -33368,7 +33371,7 @@ type GridBaseListenersTypes = {
|
|
|
33368
33371
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
33369
33372
|
* @param {Event} event.domEvent The native DOM event
|
|
33370
33373
|
*/
|
|
33371
|
-
splitterCollapseClick: (event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
33374
|
+
splitterCollapseClick: (event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void
|
|
33372
33375
|
/**
|
|
33373
33376
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
33374
33377
|
* @param {object} event Event object
|
|
@@ -33393,7 +33396,7 @@ type GridBaseListenersTypes = {
|
|
|
33393
33396
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
33394
33397
|
* @param {Event} event.domEvent The native DOM event
|
|
33395
33398
|
*/
|
|
33396
|
-
splitterExpandClick: (event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
33399
|
+
splitterExpandClick: (event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void
|
|
33397
33400
|
/**
|
|
33398
33401
|
* Fires on the owning Grid when editing starts
|
|
33399
33402
|
* @param {object} event Event object
|
|
@@ -33482,14 +33485,14 @@ type GridBaseListeners = {
|
|
|
33482
33485
|
* @param {string} event.lineDelimiter The CSV delimiter to separate lines
|
|
33483
33486
|
* @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
|
|
33484
33487
|
*/
|
|
33485
|
-
beforeCSVExport?: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
33488
|
+
beforeCSVExport?: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void)|string
|
|
33486
33489
|
/**
|
|
33487
33490
|
* Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
|
|
33488
33491
|
* @param {object} event Event object
|
|
33489
33492
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
33490
33493
|
* @param {Grid.util.GridLocation} event.editorContext Editing context
|
|
33491
33494
|
*/
|
|
33492
|
-
beforeCancelCellEdit?: ((event: { source: Grid, editorContext: GridLocation }) =>
|
|
33495
|
+
beforeCancelCellEdit?: ((event: { source: Grid, editorContext: GridLocation }) => boolean|void)|string
|
|
33493
33496
|
/**
|
|
33494
33497
|
* 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.
|
|
33495
33498
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-beforeCancelRowEdit)
|
|
@@ -33504,7 +33507,7 @@ type GridBaseListeners = {
|
|
|
33504
33507
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
33505
33508
|
* @param {CellEditorContext} event.editorContext Editing context
|
|
33506
33509
|
*/
|
|
33507
|
-
beforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
33510
|
+
beforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => boolean|void)|string
|
|
33508
33511
|
/**
|
|
33509
33512
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
33510
33513
|
* buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
|
|
@@ -33512,7 +33515,7 @@ type GridBaseListeners = {
|
|
|
33512
33515
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
33513
33516
|
* @param {(Grid.util.GridLocation|Core.data.Model)[]} 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).
|
|
33514
33517
|
*/
|
|
33515
|
-
beforeCellRangeDelete?: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
33518
|
+
beforeCellRangeDelete?: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void)|string
|
|
33516
33519
|
/**
|
|
33517
33520
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
33518
33521
|
* @param {object} event Event object
|
|
@@ -33520,7 +33523,7 @@ type GridBaseListeners = {
|
|
|
33520
33523
|
* @param {string} event.field The field being changed
|
|
33521
33524
|
* @param {any} event.value The value being set
|
|
33522
33525
|
*/
|
|
33523
|
-
beforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) =>
|
|
33526
|
+
beforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => boolean|void)|string
|
|
33524
33527
|
/**
|
|
33525
33528
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
33526
33529
|
* @param {object} event Event object
|
|
@@ -33536,7 +33539,7 @@ type GridBaseListeners = {
|
|
|
33536
33539
|
* @param {Grid.column.Column} event.column The dragged column.
|
|
33537
33540
|
* @param {Event} event.event The browser event.
|
|
33538
33541
|
*/
|
|
33539
|
-
beforeColumnDragStart?: ((event: { source: Grid, column: Column, event: Event }) =>
|
|
33542
|
+
beforeColumnDragStart?: ((event: { source: Grid, column: Column, event: Event }) => boolean|void)|string
|
|
33540
33543
|
/**
|
|
33541
33544
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
33542
33545
|
* @param {object} event Event object
|
|
@@ -33547,7 +33550,7 @@ type GridBaseListeners = {
|
|
|
33547
33550
|
* @param {Event} event.event The browser event.
|
|
33548
33551
|
* @param {string} event.region The region where the column was dropped.
|
|
33549
33552
|
*/
|
|
33550
|
-
beforeColumnDropFinalize?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
33553
|
+
beforeColumnDropFinalize?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void)|string
|
|
33551
33554
|
/**
|
|
33552
33555
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
33553
33556
|
* `false`.
|
|
@@ -33556,7 +33559,7 @@ type GridBaseListeners = {
|
|
|
33556
33559
|
* @param {Grid.column.Column} event.column The column
|
|
33557
33560
|
* @param {Event} event.domEvent The browser event
|
|
33558
33561
|
*/
|
|
33559
|
-
beforeColumnResize?: ((event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
33562
|
+
beforeColumnResize?: ((event: { source: Grid, column: Column, domEvent: Event }) => boolean|void)|string
|
|
33560
33563
|
/**
|
|
33561
33564
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
33562
33565
|
* @param {object} event Event object
|
|
@@ -33580,14 +33583,14 @@ type GridBaseListeners = {
|
|
|
33580
33583
|
* @param {XLSColumn[]} event.columns An array of columns to export
|
|
33581
33584
|
* @param {any[][]} event.rows An array of records to export
|
|
33582
33585
|
*/
|
|
33583
|
-
beforeExcelExport?: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
33586
|
+
beforeExcelExport?: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void)|string
|
|
33584
33587
|
/**
|
|
33585
33588
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
33586
33589
|
* @param {object} event Event object
|
|
33587
33590
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
33588
33591
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
33589
33592
|
*/
|
|
33590
|
-
beforeFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
33593
|
+
beforeFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
33591
33594
|
/**
|
|
33592
33595
|
* 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.
|
|
33593
33596
|
* @param {object} event Event object
|
|
@@ -33608,7 +33611,7 @@ type GridBaseListeners = {
|
|
|
33608
33611
|
* @param {object} event Event object
|
|
33609
33612
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
33610
33613
|
*/
|
|
33611
|
-
beforeHide?: ((event: { source: Widget }) =>
|
|
33614
|
+
beforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
33612
33615
|
/**
|
|
33613
33616
|
* Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
|
|
33614
33617
|
* @param {object} event Event object
|
|
@@ -33624,7 +33627,7 @@ type GridBaseListeners = {
|
|
|
33624
33627
|
* @param {object} event Event object
|
|
33625
33628
|
* @param {PdfExportConfig} event.config Export config
|
|
33626
33629
|
*/
|
|
33627
|
-
beforePdfExport?: ((event: { config: PdfExportConfig }) =>
|
|
33630
|
+
beforePdfExport?: ((event: { config: PdfExportConfig }) => boolean|void)|string
|
|
33628
33631
|
/**
|
|
33629
33632
|
* Fires before a row is rendered.
|
|
33630
33633
|
* @param {object} event Event object
|
|
@@ -33667,7 +33670,7 @@ type GridBaseListeners = {
|
|
|
33667
33670
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
33668
33671
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
33669
33672
|
*/
|
|
33670
|
-
beforeSelectionChange?: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
33673
|
+
beforeSelectionChange?: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => boolean|void)|string
|
|
33671
33674
|
/**
|
|
33672
33675
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
33673
33676
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -33688,19 +33691,19 @@ type GridBaseListeners = {
|
|
|
33688
33691
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
33689
33692
|
* @param {RowEditorContext} event.editorContext Editing context
|
|
33690
33693
|
*/
|
|
33691
|
-
beforeStartRowEdit?: ((event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
33694
|
+
beforeStartRowEdit?: ((event: { source: Grid, editorContext: RowEditorContext }) => boolean|void)|string
|
|
33692
33695
|
/**
|
|
33693
33696
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
33694
33697
|
* @param {object} event Event object
|
|
33695
33698
|
* @param {GridStateInfo} event.state State object config
|
|
33696
33699
|
*/
|
|
33697
|
-
beforeStateApply?: ((event: { state: GridStateInfo }) =>
|
|
33700
|
+
beforeStateApply?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
33698
33701
|
/**
|
|
33699
33702
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
33700
33703
|
* @param {object} event Event object
|
|
33701
33704
|
* @param {GridStateInfo} event.state State object config
|
|
33702
33705
|
*/
|
|
33703
|
-
beforeStateSave?: ((event: { state: GridStateInfo }) =>
|
|
33706
|
+
beforeStateSave?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
33704
33707
|
/**
|
|
33705
33708
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
33706
33709
|
* Returning `false` from a listener prevents the operation
|
|
@@ -33710,7 +33713,7 @@ type GridBaseListeners = {
|
|
|
33710
33713
|
* @param {boolean} event.collapse Collapsed (true) or expanded (false)
|
|
33711
33714
|
* @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
33712
33715
|
*/
|
|
33713
|
-
beforeToggleGroup?: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
33716
|
+
beforeToggleGroup?: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void)|string
|
|
33714
33717
|
/**
|
|
33715
33718
|
* Fired before a parent node record toggles its collapsed state.
|
|
33716
33719
|
* @param {object} event Event object
|
|
@@ -33779,7 +33782,7 @@ type GridBaseListeners = {
|
|
|
33779
33782
|
* @param {Grid.column.Column} event.column Column
|
|
33780
33783
|
* @param {Core.data.Model} event.record Record
|
|
33781
33784
|
*/
|
|
33782
|
-
cellMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
33785
|
+
cellMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void)|string
|
|
33783
33786
|
/**
|
|
33784
33787
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
33785
33788
|
* @param {object} event Event object
|
|
@@ -33906,7 +33909,7 @@ type GridBaseListeners = {
|
|
|
33906
33909
|
* @param {Event} event.event The browser event.
|
|
33907
33910
|
* @param {string} event.region The region where the column was dropped.
|
|
33908
33911
|
*/
|
|
33909
|
-
columnDrop?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
33912
|
+
columnDrop?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void)|string
|
|
33910
33913
|
/**
|
|
33911
33914
|
* This event is fired after a resize gesture is completed.
|
|
33912
33915
|
* @param {object} event Event object
|
|
@@ -34046,7 +34049,7 @@ type GridBaseListeners = {
|
|
|
34046
34049
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
34047
34050
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
34048
34051
|
*/
|
|
34049
|
-
fillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
34052
|
+
fillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
34050
34053
|
/**
|
|
34051
34054
|
* Fires on the owning Grid when cell editing is finished
|
|
34052
34055
|
* @param {object} event Event object
|
|
@@ -34094,7 +34097,7 @@ type GridBaseListeners = {
|
|
|
34094
34097
|
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
34095
34098
|
* @param {MouseEvent,TouchEvent} event.event
|
|
34096
34099
|
*/
|
|
34097
|
-
gridRowBeforeDragStart?: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
34100
|
+
gridRowBeforeDragStart?: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void)|string
|
|
34098
34101
|
/**
|
|
34099
34102
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
34100
34103
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
@@ -34161,7 +34164,7 @@ type GridBaseListeners = {
|
|
|
34161
34164
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
34162
34165
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
34163
34166
|
*/
|
|
34164
|
-
headerClick?: ((event: { domEvent: Event, column: Column }) =>
|
|
34167
|
+
headerClick?: ((event: { domEvent: Event, column: Column }) => boolean|void)|string
|
|
34165
34168
|
/**
|
|
34166
34169
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
34167
34170
|
* 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).
|
|
@@ -34172,7 +34175,7 @@ type GridBaseListeners = {
|
|
|
34172
34175
|
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
34173
34176
|
* @param {Grid.column.Column} event.column Column
|
|
34174
34177
|
*/
|
|
34175
|
-
headerMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
34178
|
+
headerMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void)|string
|
|
34176
34179
|
/**
|
|
34177
34180
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
34178
34181
|
* @param {object} event Event object
|
|
@@ -34383,7 +34386,7 @@ type GridBaseListeners = {
|
|
|
34383
34386
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
34384
34387
|
* @param {Event} event.domEvent The native DOM event
|
|
34385
34388
|
*/
|
|
34386
|
-
splitterCollapseClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
34389
|
+
splitterCollapseClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
34387
34390
|
/**
|
|
34388
34391
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
34389
34392
|
* @param {object} event Event object
|
|
@@ -34408,7 +34411,7 @@ type GridBaseListeners = {
|
|
|
34408
34411
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
34409
34412
|
* @param {Event} event.domEvent The native DOM event
|
|
34410
34413
|
*/
|
|
34411
|
-
splitterExpandClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
34414
|
+
splitterExpandClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
34412
34415
|
/**
|
|
34413
34416
|
* Fires on the owning Grid when editing starts
|
|
34414
34417
|
* @param {object} event Event object
|
|
@@ -35291,14 +35294,14 @@ type GridBaseConfig = {
|
|
|
35291
35294
|
* @param {string} event.lineDelimiter The CSV delimiter to separate lines
|
|
35292
35295
|
* @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
|
|
35293
35296
|
*/
|
|
35294
|
-
onBeforeCSVExport?: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
35297
|
+
onBeforeCSVExport?: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void)|string
|
|
35295
35298
|
/**
|
|
35296
35299
|
* Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
|
|
35297
35300
|
* @param {object} event Event object
|
|
35298
35301
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
35299
35302
|
* @param {Grid.util.GridLocation} event.editorContext Editing context
|
|
35300
35303
|
*/
|
|
35301
|
-
onBeforeCancelCellEdit?: ((event: { source: Grid, editorContext: GridLocation }) =>
|
|
35304
|
+
onBeforeCancelCellEdit?: ((event: { source: Grid, editorContext: GridLocation }) => boolean|void)|string
|
|
35302
35305
|
/**
|
|
35303
35306
|
* 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.
|
|
35304
35307
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-beforeCancelRowEdit)
|
|
@@ -35313,7 +35316,7 @@ type GridBaseConfig = {
|
|
|
35313
35316
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
35314
35317
|
* @param {CellEditorContext} event.editorContext Editing context
|
|
35315
35318
|
*/
|
|
35316
|
-
onBeforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
35319
|
+
onBeforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => boolean|void)|string
|
|
35317
35320
|
/**
|
|
35318
35321
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
35319
35322
|
* buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
|
|
@@ -35321,7 +35324,7 @@ type GridBaseConfig = {
|
|
|
35321
35324
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
35322
35325
|
* @param {(Grid.util.GridLocation|Core.data.Model)[]} 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).
|
|
35323
35326
|
*/
|
|
35324
|
-
onBeforeCellRangeDelete?: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
35327
|
+
onBeforeCellRangeDelete?: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void)|string
|
|
35325
35328
|
/**
|
|
35326
35329
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
35327
35330
|
* @param {object} event Event object
|
|
@@ -35329,7 +35332,7 @@ type GridBaseConfig = {
|
|
|
35329
35332
|
* @param {string} event.field The field being changed
|
|
35330
35333
|
* @param {any} event.value The value being set
|
|
35331
35334
|
*/
|
|
35332
|
-
onBeforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) =>
|
|
35335
|
+
onBeforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => boolean|void)|string
|
|
35333
35336
|
/**
|
|
35334
35337
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
35335
35338
|
* @param {object} event Event object
|
|
@@ -35345,7 +35348,7 @@ type GridBaseConfig = {
|
|
|
35345
35348
|
* @param {Grid.column.Column} event.column The dragged column.
|
|
35346
35349
|
* @param {Event} event.event The browser event.
|
|
35347
35350
|
*/
|
|
35348
|
-
onBeforeColumnDragStart?: ((event: { source: Grid, column: Column, event: Event }) =>
|
|
35351
|
+
onBeforeColumnDragStart?: ((event: { source: Grid, column: Column, event: Event }) => boolean|void)|string
|
|
35349
35352
|
/**
|
|
35350
35353
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
35351
35354
|
* @param {object} event Event object
|
|
@@ -35356,7 +35359,7 @@ type GridBaseConfig = {
|
|
|
35356
35359
|
* @param {Event} event.event The browser event.
|
|
35357
35360
|
* @param {string} event.region The region where the column was dropped.
|
|
35358
35361
|
*/
|
|
35359
|
-
onBeforeColumnDropFinalize?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
35362
|
+
onBeforeColumnDropFinalize?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void)|string
|
|
35360
35363
|
/**
|
|
35361
35364
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
35362
35365
|
* `false`.
|
|
@@ -35365,7 +35368,7 @@ type GridBaseConfig = {
|
|
|
35365
35368
|
* @param {Grid.column.Column} event.column The column
|
|
35366
35369
|
* @param {Event} event.domEvent The browser event
|
|
35367
35370
|
*/
|
|
35368
|
-
onBeforeColumnResize?: ((event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
35371
|
+
onBeforeColumnResize?: ((event: { source: Grid, column: Column, domEvent: Event }) => boolean|void)|string
|
|
35369
35372
|
/**
|
|
35370
35373
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
35371
35374
|
* @param {object} event Event object
|
|
@@ -35389,14 +35392,14 @@ type GridBaseConfig = {
|
|
|
35389
35392
|
* @param {XLSColumn[]} event.columns An array of columns to export
|
|
35390
35393
|
* @param {any[][]} event.rows An array of records to export
|
|
35391
35394
|
*/
|
|
35392
|
-
onBeforeExcelExport?: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
35395
|
+
onBeforeExcelExport?: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void)|string
|
|
35393
35396
|
/**
|
|
35394
35397
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
35395
35398
|
* @param {object} event Event object
|
|
35396
35399
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
35397
35400
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
35398
35401
|
*/
|
|
35399
|
-
onBeforeFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
35402
|
+
onBeforeFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
35400
35403
|
/**
|
|
35401
35404
|
* 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.
|
|
35402
35405
|
* @param {object} event Event object
|
|
@@ -35417,7 +35420,7 @@ type GridBaseConfig = {
|
|
|
35417
35420
|
* @param {object} event Event object
|
|
35418
35421
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
35419
35422
|
*/
|
|
35420
|
-
onBeforeHide?: ((event: { source: Widget }) =>
|
|
35423
|
+
onBeforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
35421
35424
|
/**
|
|
35422
35425
|
* Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
|
|
35423
35426
|
* @param {object} event Event object
|
|
@@ -35433,7 +35436,7 @@ type GridBaseConfig = {
|
|
|
35433
35436
|
* @param {object} event Event object
|
|
35434
35437
|
* @param {PdfExportConfig} event.config Export config
|
|
35435
35438
|
*/
|
|
35436
|
-
onBeforePdfExport?: ((event: { config: PdfExportConfig }) =>
|
|
35439
|
+
onBeforePdfExport?: ((event: { config: PdfExportConfig }) => boolean|void)|string
|
|
35437
35440
|
/**
|
|
35438
35441
|
* Fires before a row is rendered.
|
|
35439
35442
|
* @param {object} event Event object
|
|
@@ -35476,7 +35479,7 @@ type GridBaseConfig = {
|
|
|
35476
35479
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
35477
35480
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
35478
35481
|
*/
|
|
35479
|
-
onBeforeSelectionChange?: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
35482
|
+
onBeforeSelectionChange?: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => boolean|void)|string
|
|
35480
35483
|
/**
|
|
35481
35484
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
35482
35485
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -35497,19 +35500,19 @@ type GridBaseConfig = {
|
|
|
35497
35500
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
35498
35501
|
* @param {RowEditorContext} event.editorContext Editing context
|
|
35499
35502
|
*/
|
|
35500
|
-
onBeforeStartRowEdit?: ((event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
35503
|
+
onBeforeStartRowEdit?: ((event: { source: Grid, editorContext: RowEditorContext }) => boolean|void)|string
|
|
35501
35504
|
/**
|
|
35502
35505
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
35503
35506
|
* @param {object} event Event object
|
|
35504
35507
|
* @param {GridStateInfo} event.state State object config
|
|
35505
35508
|
*/
|
|
35506
|
-
onBeforeStateApply?: ((event: { state: GridStateInfo }) =>
|
|
35509
|
+
onBeforeStateApply?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
35507
35510
|
/**
|
|
35508
35511
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
35509
35512
|
* @param {object} event Event object
|
|
35510
35513
|
* @param {GridStateInfo} event.state State object config
|
|
35511
35514
|
*/
|
|
35512
|
-
onBeforeStateSave?: ((event: { state: GridStateInfo }) =>
|
|
35515
|
+
onBeforeStateSave?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
35513
35516
|
/**
|
|
35514
35517
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
35515
35518
|
* Returning `false` from a listener prevents the operation
|
|
@@ -35519,7 +35522,7 @@ type GridBaseConfig = {
|
|
|
35519
35522
|
* @param {boolean} event.collapse Collapsed (true) or expanded (false)
|
|
35520
35523
|
* @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
35521
35524
|
*/
|
|
35522
|
-
onBeforeToggleGroup?: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
35525
|
+
onBeforeToggleGroup?: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void)|string
|
|
35523
35526
|
/**
|
|
35524
35527
|
* Fired before a parent node record toggles its collapsed state.
|
|
35525
35528
|
* @param {object} event Event object
|
|
@@ -35588,7 +35591,7 @@ type GridBaseConfig = {
|
|
|
35588
35591
|
* @param {Grid.column.Column} event.column Column
|
|
35589
35592
|
* @param {Core.data.Model} event.record Record
|
|
35590
35593
|
*/
|
|
35591
|
-
onCellMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
35594
|
+
onCellMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void)|string
|
|
35592
35595
|
/**
|
|
35593
35596
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
35594
35597
|
* @param {object} event Event object
|
|
@@ -35715,7 +35718,7 @@ type GridBaseConfig = {
|
|
|
35715
35718
|
* @param {Event} event.event The browser event.
|
|
35716
35719
|
* @param {string} event.region The region where the column was dropped.
|
|
35717
35720
|
*/
|
|
35718
|
-
onColumnDrop?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
35721
|
+
onColumnDrop?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void)|string
|
|
35719
35722
|
/**
|
|
35720
35723
|
* This event is fired after a resize gesture is completed.
|
|
35721
35724
|
* @param {object} event Event object
|
|
@@ -35855,7 +35858,7 @@ type GridBaseConfig = {
|
|
|
35855
35858
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
35856
35859
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
35857
35860
|
*/
|
|
35858
|
-
onFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
35861
|
+
onFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
35859
35862
|
/**
|
|
35860
35863
|
* Fires on the owning Grid when cell editing is finished
|
|
35861
35864
|
* @param {object} event Event object
|
|
@@ -35903,7 +35906,7 @@ type GridBaseConfig = {
|
|
|
35903
35906
|
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
35904
35907
|
* @param {MouseEvent,TouchEvent} event.event
|
|
35905
35908
|
*/
|
|
35906
|
-
onGridRowBeforeDragStart?: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
35909
|
+
onGridRowBeforeDragStart?: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void)|string
|
|
35907
35910
|
/**
|
|
35908
35911
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
35909
35912
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
@@ -35970,7 +35973,7 @@ type GridBaseConfig = {
|
|
|
35970
35973
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
35971
35974
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
35972
35975
|
*/
|
|
35973
|
-
onHeaderClick?: ((event: { domEvent: Event, column: Column }) =>
|
|
35976
|
+
onHeaderClick?: ((event: { domEvent: Event, column: Column }) => boolean|void)|string
|
|
35974
35977
|
/**
|
|
35975
35978
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
35976
35979
|
* 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).
|
|
@@ -35981,7 +35984,7 @@ type GridBaseConfig = {
|
|
|
35981
35984
|
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
35982
35985
|
* @param {Grid.column.Column} event.column Column
|
|
35983
35986
|
*/
|
|
35984
|
-
onHeaderMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
35987
|
+
onHeaderMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void)|string
|
|
35985
35988
|
/**
|
|
35986
35989
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
35987
35990
|
* @param {object} event Event object
|
|
@@ -36192,7 +36195,7 @@ type GridBaseConfig = {
|
|
|
36192
36195
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
36193
36196
|
* @param {Event} event.domEvent The native DOM event
|
|
36194
36197
|
*/
|
|
36195
|
-
onSplitterCollapseClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
36198
|
+
onSplitterCollapseClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
36196
36199
|
/**
|
|
36197
36200
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
36198
36201
|
* @param {object} event Event object
|
|
@@ -36217,7 +36220,7 @@ type GridBaseConfig = {
|
|
|
36217
36220
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
36218
36221
|
* @param {Event} event.domEvent The native DOM event
|
|
36219
36222
|
*/
|
|
36220
|
-
onSplitterExpandClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
36223
|
+
onSplitterExpandClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
36221
36224
|
/**
|
|
36222
36225
|
* Fires on the owning Grid when editing starts
|
|
36223
36226
|
* @param {object} event Event object
|
|
@@ -36635,14 +36638,14 @@ export class GridBase extends Panel {
|
|
|
36635
36638
|
* @param {string} event.lineDelimiter The CSV delimiter to separate lines
|
|
36636
36639
|
* @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
|
|
36637
36640
|
*/
|
|
36638
|
-
onBeforeCSVExport: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
36641
|
+
onBeforeCSVExport: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void)|string
|
|
36639
36642
|
/**
|
|
36640
36643
|
* Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
|
|
36641
36644
|
* @param {object} event Event object
|
|
36642
36645
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
36643
36646
|
* @param {Grid.util.GridLocation} event.editorContext Editing context
|
|
36644
36647
|
*/
|
|
36645
|
-
onBeforeCancelCellEdit: ((event: { source: Grid, editorContext: GridLocation }) =>
|
|
36648
|
+
onBeforeCancelCellEdit: ((event: { source: Grid, editorContext: GridLocation }) => boolean|void)|string
|
|
36646
36649
|
/**
|
|
36647
36650
|
* 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.
|
|
36648
36651
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-beforeCancelRowEdit)
|
|
@@ -36657,7 +36660,7 @@ export class GridBase extends Panel {
|
|
|
36657
36660
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
36658
36661
|
* @param {CellEditorContext} event.editorContext Editing context
|
|
36659
36662
|
*/
|
|
36660
|
-
onBeforeCellEditStart: ((event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
36663
|
+
onBeforeCellEditStart: ((event: { source: Grid, editorContext: CellEditorContext }) => boolean|void)|string
|
|
36661
36664
|
/**
|
|
36662
36665
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
36663
36666
|
* buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
|
|
@@ -36665,7 +36668,7 @@ export class GridBase extends Panel {
|
|
|
36665
36668
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
36666
36669
|
* @param {(Grid.util.GridLocation|Core.data.Model)[]} 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).
|
|
36667
36670
|
*/
|
|
36668
|
-
onBeforeCellRangeDelete: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
36671
|
+
onBeforeCellRangeDelete: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void)|string
|
|
36669
36672
|
/**
|
|
36670
36673
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
36671
36674
|
* @param {object} event Event object
|
|
@@ -36673,7 +36676,7 @@ export class GridBase extends Panel {
|
|
|
36673
36676
|
* @param {string} event.field The field being changed
|
|
36674
36677
|
* @param {any} event.value The value being set
|
|
36675
36678
|
*/
|
|
36676
|
-
onBeforeCellRangeEdit: ((event: { record: Model, field: string, value: any }) =>
|
|
36679
|
+
onBeforeCellRangeEdit: ((event: { record: Model, field: string, value: any }) => boolean|void)|string
|
|
36677
36680
|
/**
|
|
36678
36681
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
36679
36682
|
* @param {object} event Event object
|
|
@@ -36689,7 +36692,7 @@ export class GridBase extends Panel {
|
|
|
36689
36692
|
* @param {Grid.column.Column} event.column The dragged column.
|
|
36690
36693
|
* @param {Event} event.event The browser event.
|
|
36691
36694
|
*/
|
|
36692
|
-
onBeforeColumnDragStart: ((event: { source: Grid, column: Column, event: Event }) =>
|
|
36695
|
+
onBeforeColumnDragStart: ((event: { source: Grid, column: Column, event: Event }) => boolean|void)|string
|
|
36693
36696
|
/**
|
|
36694
36697
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
36695
36698
|
* @param {object} event Event object
|
|
@@ -36700,7 +36703,7 @@ export class GridBase extends Panel {
|
|
|
36700
36703
|
* @param {Event} event.event The browser event.
|
|
36701
36704
|
* @param {string} event.region The region where the column was dropped.
|
|
36702
36705
|
*/
|
|
36703
|
-
onBeforeColumnDropFinalize: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
36706
|
+
onBeforeColumnDropFinalize: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void)|string
|
|
36704
36707
|
/**
|
|
36705
36708
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
36706
36709
|
* `false`.
|
|
@@ -36709,7 +36712,7 @@ export class GridBase extends Panel {
|
|
|
36709
36712
|
* @param {Grid.column.Column} event.column The column
|
|
36710
36713
|
* @param {Event} event.domEvent The browser event
|
|
36711
36714
|
*/
|
|
36712
|
-
onBeforeColumnResize: ((event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
36715
|
+
onBeforeColumnResize: ((event: { source: Grid, column: Column, domEvent: Event }) => boolean|void)|string
|
|
36713
36716
|
/**
|
|
36714
36717
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
36715
36718
|
* @param {object} event Event object
|
|
@@ -36733,14 +36736,14 @@ export class GridBase extends Panel {
|
|
|
36733
36736
|
* @param {XLSColumn[]} event.columns An array of columns to export
|
|
36734
36737
|
* @param {any[][]} event.rows An array of records to export
|
|
36735
36738
|
*/
|
|
36736
|
-
onBeforeExcelExport: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
36739
|
+
onBeforeExcelExport: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void)|string
|
|
36737
36740
|
/**
|
|
36738
36741
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
36739
36742
|
* @param {object} event Event object
|
|
36740
36743
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
36741
36744
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
36742
36745
|
*/
|
|
36743
|
-
onBeforeFillHandleDragStart: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
36746
|
+
onBeforeFillHandleDragStart: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
36744
36747
|
/**
|
|
36745
36748
|
* 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.
|
|
36746
36749
|
* @param {object} event Event object
|
|
@@ -36771,7 +36774,7 @@ export class GridBase extends Panel {
|
|
|
36771
36774
|
* @param {object} event Event object
|
|
36772
36775
|
* @param {PdfExportConfig} event.config Export config
|
|
36773
36776
|
*/
|
|
36774
|
-
onBeforePdfExport: ((event: { config: PdfExportConfig }) =>
|
|
36777
|
+
onBeforePdfExport: ((event: { config: PdfExportConfig }) => boolean|void)|string
|
|
36775
36778
|
/**
|
|
36776
36779
|
* Fires before a row is rendered.
|
|
36777
36780
|
* @param {object} event Event object
|
|
@@ -36814,26 +36817,26 @@ export class GridBase extends Panel {
|
|
|
36814
36817
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
36815
36818
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
36816
36819
|
*/
|
|
36817
|
-
onBeforeSelectionChange: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
36820
|
+
onBeforeSelectionChange: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => boolean|void)|string
|
|
36818
36821
|
/**
|
|
36819
36822
|
* Fires on the owning Grid before editing starts, return `false` to prevent editing
|
|
36820
36823
|
* @param {object} event Event object
|
|
36821
36824
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
36822
36825
|
* @param {RowEditorContext} event.editorContext Editing context
|
|
36823
36826
|
*/
|
|
36824
|
-
onBeforeStartRowEdit: ((event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
36827
|
+
onBeforeStartRowEdit: ((event: { source: Grid, editorContext: RowEditorContext }) => boolean|void)|string
|
|
36825
36828
|
/**
|
|
36826
36829
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
36827
36830
|
* @param {object} event Event object
|
|
36828
36831
|
* @param {GridStateInfo} event.state State object config
|
|
36829
36832
|
*/
|
|
36830
|
-
onBeforeStateApply: ((event: { state: GridStateInfo }) =>
|
|
36833
|
+
onBeforeStateApply: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
36831
36834
|
/**
|
|
36832
36835
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
36833
36836
|
* @param {object} event Event object
|
|
36834
36837
|
* @param {GridStateInfo} event.state State object config
|
|
36835
36838
|
*/
|
|
36836
|
-
onBeforeStateSave: ((event: { state: GridStateInfo }) =>
|
|
36839
|
+
onBeforeStateSave: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
36837
36840
|
/**
|
|
36838
36841
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
36839
36842
|
* Returning `false` from a listener prevents the operation
|
|
@@ -36843,7 +36846,7 @@ export class GridBase extends Panel {
|
|
|
36843
36846
|
* @param {boolean} event.collapse Collapsed (true) or expanded (false)
|
|
36844
36847
|
* @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
36845
36848
|
*/
|
|
36846
|
-
onBeforeToggleGroup: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
36849
|
+
onBeforeToggleGroup: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void)|string
|
|
36847
36850
|
/**
|
|
36848
36851
|
* Fired before a parent node record toggles its collapsed state.
|
|
36849
36852
|
* @param {object} event Event object
|
|
@@ -36912,7 +36915,7 @@ export class GridBase extends Panel {
|
|
|
36912
36915
|
* @param {Grid.column.Column} event.column Column
|
|
36913
36916
|
* @param {Core.data.Model} event.record Record
|
|
36914
36917
|
*/
|
|
36915
|
-
onCellMenuBeforeShow: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
36918
|
+
onCellMenuBeforeShow: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void)|string
|
|
36916
36919
|
/**
|
|
36917
36920
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
36918
36921
|
* @param {object} event Event object
|
|
@@ -37033,7 +37036,7 @@ export class GridBase extends Panel {
|
|
|
37033
37036
|
* @param {Event} event.event The browser event.
|
|
37034
37037
|
* @param {string} event.region The region where the column was dropped.
|
|
37035
37038
|
*/
|
|
37036
|
-
onColumnDrop: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
37039
|
+
onColumnDrop: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void)|string
|
|
37037
37040
|
/**
|
|
37038
37041
|
* This event is fired after a resize gesture is completed.
|
|
37039
37042
|
* @param {object} event Event object
|
|
@@ -37137,7 +37140,7 @@ export class GridBase extends Panel {
|
|
|
37137
37140
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
37138
37141
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
37139
37142
|
*/
|
|
37140
|
-
onFillHandleDragStart: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
37143
|
+
onFillHandleDragStart: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
37141
37144
|
/**
|
|
37142
37145
|
* Fires on the owning Grid when cell editing is finished
|
|
37143
37146
|
* @param {object} event Event object
|
|
@@ -37161,7 +37164,7 @@ export class GridBase extends Panel {
|
|
|
37161
37164
|
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
37162
37165
|
* @param {MouseEvent,TouchEvent} event.event
|
|
37163
37166
|
*/
|
|
37164
|
-
onGridRowBeforeDragStart: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
37167
|
+
onGridRowBeforeDragStart: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void)|string
|
|
37165
37168
|
/**
|
|
37166
37169
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
37167
37170
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
@@ -37228,7 +37231,7 @@ export class GridBase extends Panel {
|
|
|
37228
37231
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
37229
37232
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
37230
37233
|
*/
|
|
37231
|
-
onHeaderClick: ((event: { domEvent: Event, column: Column }) =>
|
|
37234
|
+
onHeaderClick: ((event: { domEvent: Event, column: Column }) => boolean|void)|string
|
|
37232
37235
|
/**
|
|
37233
37236
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
37234
37237
|
* 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).
|
|
@@ -37239,7 +37242,7 @@ export class GridBase extends Panel {
|
|
|
37239
37242
|
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
37240
37243
|
* @param {Grid.column.Column} event.column Column
|
|
37241
37244
|
*/
|
|
37242
|
-
onHeaderMenuBeforeShow: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
37245
|
+
onHeaderMenuBeforeShow: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void)|string
|
|
37243
37246
|
/**
|
|
37244
37247
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
37245
37248
|
* @param {object} event Event object
|
|
@@ -37408,7 +37411,7 @@ export class GridBase extends Panel {
|
|
|
37408
37411
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
37409
37412
|
* @param {Event} event.domEvent The native DOM event
|
|
37410
37413
|
*/
|
|
37411
|
-
onSplitterCollapseClick: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
37414
|
+
onSplitterCollapseClick: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
37412
37415
|
/**
|
|
37413
37416
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
37414
37417
|
* @param {object} event Event object
|
|
@@ -37433,7 +37436,7 @@ export class GridBase extends Panel {
|
|
|
37433
37436
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
37434
37437
|
* @param {Event} event.domEvent The native DOM event
|
|
37435
37438
|
*/
|
|
37436
|
-
onSplitterExpandClick: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
37439
|
+
onSplitterExpandClick: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
37437
37440
|
/**
|
|
37438
37441
|
* Fires on the owning Grid when editing starts
|
|
37439
37442
|
* @param {object} event Event object
|
|
@@ -38085,7 +38088,7 @@ type SubGridListenersTypes = {
|
|
|
38085
38088
|
* @param {object} event Event object
|
|
38086
38089
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
38087
38090
|
*/
|
|
38088
|
-
beforeHide: (event: { source: Widget }) =>
|
|
38091
|
+
beforeHide: (event: { source: Widget }) => boolean|void
|
|
38089
38092
|
/**
|
|
38090
38093
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
38091
38094
|
* @param {object} event Event object
|
|
@@ -38215,7 +38218,7 @@ type SubGridListeners = {
|
|
|
38215
38218
|
* @param {object} event Event object
|
|
38216
38219
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
38217
38220
|
*/
|
|
38218
|
-
beforeHide?: ((event: { source: Widget }) =>
|
|
38221
|
+
beforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
38219
38222
|
/**
|
|
38220
38223
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
38221
38224
|
* @param {object} event Event object
|
|
@@ -38704,7 +38707,7 @@ type SubGridConfig = {
|
|
|
38704
38707
|
* @param {object} event Event object
|
|
38705
38708
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
38706
38709
|
*/
|
|
38707
|
-
onBeforeHide?: ((event: { source: Widget }) =>
|
|
38710
|
+
onBeforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
38708
38711
|
/**
|
|
38709
38712
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
38710
38713
|
* @param {object} event Event object
|
|
@@ -38938,14 +38941,14 @@ type TreeGridListenersTypes = {
|
|
|
38938
38941
|
* @param {string} event.lineDelimiter The CSV delimiter to separate lines
|
|
38939
38942
|
* @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
|
|
38940
38943
|
*/
|
|
38941
|
-
beforeCSVExport: (event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
38944
|
+
beforeCSVExport: (event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void
|
|
38942
38945
|
/**
|
|
38943
38946
|
* Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
|
|
38944
38947
|
* @param {object} event Event object
|
|
38945
38948
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
38946
38949
|
* @param {Grid.util.GridLocation} event.editorContext Editing context
|
|
38947
38950
|
*/
|
|
38948
|
-
beforeCancelCellEdit: (event: { source: Grid, editorContext: GridLocation }) =>
|
|
38951
|
+
beforeCancelCellEdit: (event: { source: Grid, editorContext: GridLocation }) => boolean|void
|
|
38949
38952
|
/**
|
|
38950
38953
|
* 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.
|
|
38951
38954
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-beforeCancelRowEdit)
|
|
@@ -38960,7 +38963,7 @@ type TreeGridListenersTypes = {
|
|
|
38960
38963
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
38961
38964
|
* @param {CellEditorContext} event.editorContext Editing context
|
|
38962
38965
|
*/
|
|
38963
|
-
beforeCellEditStart: (event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
38966
|
+
beforeCellEditStart: (event: { source: Grid, editorContext: CellEditorContext }) => boolean|void
|
|
38964
38967
|
/**
|
|
38965
38968
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
38966
38969
|
* buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
|
|
@@ -38968,7 +38971,7 @@ type TreeGridListenersTypes = {
|
|
|
38968
38971
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
38969
38972
|
* @param {(Grid.util.GridLocation|Core.data.Model)[]} 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).
|
|
38970
38973
|
*/
|
|
38971
|
-
beforeCellRangeDelete: (event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
38974
|
+
beforeCellRangeDelete: (event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void
|
|
38972
38975
|
/**
|
|
38973
38976
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
38974
38977
|
* @param {object} event Event object
|
|
@@ -38976,7 +38979,7 @@ type TreeGridListenersTypes = {
|
|
|
38976
38979
|
* @param {string} event.field The field being changed
|
|
38977
38980
|
* @param {any} event.value The value being set
|
|
38978
38981
|
*/
|
|
38979
|
-
beforeCellRangeEdit: (event: { record: Model, field: string, value: any }) =>
|
|
38982
|
+
beforeCellRangeEdit: (event: { record: Model, field: string, value: any }) => boolean|void
|
|
38980
38983
|
/**
|
|
38981
38984
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
38982
38985
|
* @param {object} event Event object
|
|
@@ -38992,7 +38995,7 @@ type TreeGridListenersTypes = {
|
|
|
38992
38995
|
* @param {Grid.column.Column} event.column The dragged column.
|
|
38993
38996
|
* @param {Event} event.event The browser event.
|
|
38994
38997
|
*/
|
|
38995
|
-
beforeColumnDragStart: (event: { source: Grid, column: Column, event: Event }) =>
|
|
38998
|
+
beforeColumnDragStart: (event: { source: Grid, column: Column, event: Event }) => boolean|void
|
|
38996
38999
|
/**
|
|
38997
39000
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
38998
39001
|
* @param {object} event Event object
|
|
@@ -39003,7 +39006,7 @@ type TreeGridListenersTypes = {
|
|
|
39003
39006
|
* @param {Event} event.event The browser event.
|
|
39004
39007
|
* @param {string} event.region The region where the column was dropped.
|
|
39005
39008
|
*/
|
|
39006
|
-
beforeColumnDropFinalize: (event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
39009
|
+
beforeColumnDropFinalize: (event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void
|
|
39007
39010
|
/**
|
|
39008
39011
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
39009
39012
|
* `false`.
|
|
@@ -39012,7 +39015,7 @@ type TreeGridListenersTypes = {
|
|
|
39012
39015
|
* @param {Grid.column.Column} event.column The column
|
|
39013
39016
|
* @param {Event} event.domEvent The browser event
|
|
39014
39017
|
*/
|
|
39015
|
-
beforeColumnResize: (event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
39018
|
+
beforeColumnResize: (event: { source: Grid, column: Column, domEvent: Event }) => boolean|void
|
|
39016
39019
|
/**
|
|
39017
39020
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
39018
39021
|
* @param {object} event Event object
|
|
@@ -39036,14 +39039,14 @@ type TreeGridListenersTypes = {
|
|
|
39036
39039
|
* @param {XLSColumn[]} event.columns An array of columns to export
|
|
39037
39040
|
* @param {any[][]} event.rows An array of records to export
|
|
39038
39041
|
*/
|
|
39039
|
-
beforeExcelExport: (event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
39042
|
+
beforeExcelExport: (event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void
|
|
39040
39043
|
/**
|
|
39041
39044
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
39042
39045
|
* @param {object} event Event object
|
|
39043
39046
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
39044
39047
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
39045
39048
|
*/
|
|
39046
|
-
beforeFillHandleDragStart: (event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
39049
|
+
beforeFillHandleDragStart: (event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void
|
|
39047
39050
|
/**
|
|
39048
39051
|
* 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.
|
|
39049
39052
|
* @param {object} event Event object
|
|
@@ -39064,7 +39067,7 @@ type TreeGridListenersTypes = {
|
|
|
39064
39067
|
* @param {object} event Event object
|
|
39065
39068
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
39066
39069
|
*/
|
|
39067
|
-
beforeHide: (event: { source: Widget }) =>
|
|
39070
|
+
beforeHide: (event: { source: Widget }) => boolean|void
|
|
39068
39071
|
/**
|
|
39069
39072
|
* Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
|
|
39070
39073
|
* @param {object} event Event object
|
|
@@ -39080,7 +39083,7 @@ type TreeGridListenersTypes = {
|
|
|
39080
39083
|
* @param {object} event Event object
|
|
39081
39084
|
* @param {PdfExportConfig} event.config Export config
|
|
39082
39085
|
*/
|
|
39083
|
-
beforePdfExport: (event: { config: PdfExportConfig }) =>
|
|
39086
|
+
beforePdfExport: (event: { config: PdfExportConfig }) => boolean|void
|
|
39084
39087
|
/**
|
|
39085
39088
|
* Fires before a row is rendered.
|
|
39086
39089
|
* @param {object} event Event object
|
|
@@ -39123,7 +39126,7 @@ type TreeGridListenersTypes = {
|
|
|
39123
39126
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
39124
39127
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
39125
39128
|
*/
|
|
39126
|
-
beforeSelectionChange: (event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
39129
|
+
beforeSelectionChange: (event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => boolean|void
|
|
39127
39130
|
/**
|
|
39128
39131
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
39129
39132
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -39144,19 +39147,19 @@ type TreeGridListenersTypes = {
|
|
|
39144
39147
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
39145
39148
|
* @param {RowEditorContext} event.editorContext Editing context
|
|
39146
39149
|
*/
|
|
39147
|
-
beforeStartRowEdit: (event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
39150
|
+
beforeStartRowEdit: (event: { source: Grid, editorContext: RowEditorContext }) => boolean|void
|
|
39148
39151
|
/**
|
|
39149
39152
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
39150
39153
|
* @param {object} event Event object
|
|
39151
39154
|
* @param {GridStateInfo} event.state State object config
|
|
39152
39155
|
*/
|
|
39153
|
-
beforeStateApply: (event: { state: GridStateInfo }) =>
|
|
39156
|
+
beforeStateApply: (event: { state: GridStateInfo }) => boolean|void
|
|
39154
39157
|
/**
|
|
39155
39158
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
39156
39159
|
* @param {object} event Event object
|
|
39157
39160
|
* @param {GridStateInfo} event.state State object config
|
|
39158
39161
|
*/
|
|
39159
|
-
beforeStateSave: (event: { state: GridStateInfo }) =>
|
|
39162
|
+
beforeStateSave: (event: { state: GridStateInfo }) => boolean|void
|
|
39160
39163
|
/**
|
|
39161
39164
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
39162
39165
|
* Returning `false` from a listener prevents the operation
|
|
@@ -39166,7 +39169,7 @@ type TreeGridListenersTypes = {
|
|
|
39166
39169
|
* @param {boolean} event.collapse Collapsed (true) or expanded (false)
|
|
39167
39170
|
* @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
39168
39171
|
*/
|
|
39169
|
-
beforeToggleGroup: (event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
39172
|
+
beforeToggleGroup: (event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void
|
|
39170
39173
|
/**
|
|
39171
39174
|
* Fired before a parent node record toggles its collapsed state.
|
|
39172
39175
|
* @param {object} event Event object
|
|
@@ -39235,7 +39238,7 @@ type TreeGridListenersTypes = {
|
|
|
39235
39238
|
* @param {Grid.column.Column} event.column Column
|
|
39236
39239
|
* @param {Core.data.Model} event.record Record
|
|
39237
39240
|
*/
|
|
39238
|
-
cellMenuBeforeShow: (event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
39241
|
+
cellMenuBeforeShow: (event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void
|
|
39239
39242
|
/**
|
|
39240
39243
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
39241
39244
|
* @param {object} event Event object
|
|
@@ -39362,7 +39365,7 @@ type TreeGridListenersTypes = {
|
|
|
39362
39365
|
* @param {Event} event.event The browser event.
|
|
39363
39366
|
* @param {string} event.region The region where the column was dropped.
|
|
39364
39367
|
*/
|
|
39365
|
-
columnDrop: (event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
39368
|
+
columnDrop: (event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void
|
|
39366
39369
|
/**
|
|
39367
39370
|
* This event is fired after a resize gesture is completed.
|
|
39368
39371
|
* @param {object} event Event object
|
|
@@ -39502,7 +39505,7 @@ type TreeGridListenersTypes = {
|
|
|
39502
39505
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
39503
39506
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
39504
39507
|
*/
|
|
39505
|
-
fillHandleDragStart: (event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
39508
|
+
fillHandleDragStart: (event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void
|
|
39506
39509
|
/**
|
|
39507
39510
|
* Fires on the owning Grid when cell editing is finished
|
|
39508
39511
|
* @param {object} event Event object
|
|
@@ -39550,7 +39553,7 @@ type TreeGridListenersTypes = {
|
|
|
39550
39553
|
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
39551
39554
|
* @param {MouseEvent,TouchEvent} event.event
|
|
39552
39555
|
*/
|
|
39553
|
-
gridRowBeforeDragStart: (event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
39556
|
+
gridRowBeforeDragStart: (event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void
|
|
39554
39557
|
/**
|
|
39555
39558
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
39556
39559
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
@@ -39617,7 +39620,7 @@ type TreeGridListenersTypes = {
|
|
|
39617
39620
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
39618
39621
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
39619
39622
|
*/
|
|
39620
|
-
headerClick: (event: { domEvent: Event, column: Column }) =>
|
|
39623
|
+
headerClick: (event: { domEvent: Event, column: Column }) => boolean|void
|
|
39621
39624
|
/**
|
|
39622
39625
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
39623
39626
|
* 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).
|
|
@@ -39628,7 +39631,7 @@ type TreeGridListenersTypes = {
|
|
|
39628
39631
|
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
39629
39632
|
* @param {Grid.column.Column} event.column Column
|
|
39630
39633
|
*/
|
|
39631
|
-
headerMenuBeforeShow: (event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
39634
|
+
headerMenuBeforeShow: (event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void
|
|
39632
39635
|
/**
|
|
39633
39636
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
39634
39637
|
* @param {object} event Event object
|
|
@@ -39839,7 +39842,7 @@ type TreeGridListenersTypes = {
|
|
|
39839
39842
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
39840
39843
|
* @param {Event} event.domEvent The native DOM event
|
|
39841
39844
|
*/
|
|
39842
|
-
splitterCollapseClick: (event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
39845
|
+
splitterCollapseClick: (event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void
|
|
39843
39846
|
/**
|
|
39844
39847
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
39845
39848
|
* @param {object} event Event object
|
|
@@ -39864,7 +39867,7 @@ type TreeGridListenersTypes = {
|
|
|
39864
39867
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
39865
39868
|
* @param {Event} event.domEvent The native DOM event
|
|
39866
39869
|
*/
|
|
39867
|
-
splitterExpandClick: (event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
39870
|
+
splitterExpandClick: (event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void
|
|
39868
39871
|
/**
|
|
39869
39872
|
* Fires on the owning Grid when editing starts
|
|
39870
39873
|
* @param {object} event Event object
|
|
@@ -39953,14 +39956,14 @@ type TreeGridListeners = {
|
|
|
39953
39956
|
* @param {string} event.lineDelimiter The CSV delimiter to separate lines
|
|
39954
39957
|
* @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
|
|
39955
39958
|
*/
|
|
39956
|
-
beforeCSVExport?: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
39959
|
+
beforeCSVExport?: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void)|string
|
|
39957
39960
|
/**
|
|
39958
39961
|
* Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
|
|
39959
39962
|
* @param {object} event Event object
|
|
39960
39963
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
39961
39964
|
* @param {Grid.util.GridLocation} event.editorContext Editing context
|
|
39962
39965
|
*/
|
|
39963
|
-
beforeCancelCellEdit?: ((event: { source: Grid, editorContext: GridLocation }) =>
|
|
39966
|
+
beforeCancelCellEdit?: ((event: { source: Grid, editorContext: GridLocation }) => boolean|void)|string
|
|
39964
39967
|
/**
|
|
39965
39968
|
* 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.
|
|
39966
39969
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-beforeCancelRowEdit)
|
|
@@ -39975,7 +39978,7 @@ type TreeGridListeners = {
|
|
|
39975
39978
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
39976
39979
|
* @param {CellEditorContext} event.editorContext Editing context
|
|
39977
39980
|
*/
|
|
39978
|
-
beforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
39981
|
+
beforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => boolean|void)|string
|
|
39979
39982
|
/**
|
|
39980
39983
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
39981
39984
|
* buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
|
|
@@ -39983,7 +39986,7 @@ type TreeGridListeners = {
|
|
|
39983
39986
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
39984
39987
|
* @param {(Grid.util.GridLocation|Core.data.Model)[]} 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).
|
|
39985
39988
|
*/
|
|
39986
|
-
beforeCellRangeDelete?: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
39989
|
+
beforeCellRangeDelete?: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void)|string
|
|
39987
39990
|
/**
|
|
39988
39991
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
39989
39992
|
* @param {object} event Event object
|
|
@@ -39991,7 +39994,7 @@ type TreeGridListeners = {
|
|
|
39991
39994
|
* @param {string} event.field The field being changed
|
|
39992
39995
|
* @param {any} event.value The value being set
|
|
39993
39996
|
*/
|
|
39994
|
-
beforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) =>
|
|
39997
|
+
beforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => boolean|void)|string
|
|
39995
39998
|
/**
|
|
39996
39999
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
39997
40000
|
* @param {object} event Event object
|
|
@@ -40007,7 +40010,7 @@ type TreeGridListeners = {
|
|
|
40007
40010
|
* @param {Grid.column.Column} event.column The dragged column.
|
|
40008
40011
|
* @param {Event} event.event The browser event.
|
|
40009
40012
|
*/
|
|
40010
|
-
beforeColumnDragStart?: ((event: { source: Grid, column: Column, event: Event }) =>
|
|
40013
|
+
beforeColumnDragStart?: ((event: { source: Grid, column: Column, event: Event }) => boolean|void)|string
|
|
40011
40014
|
/**
|
|
40012
40015
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
40013
40016
|
* @param {object} event Event object
|
|
@@ -40018,7 +40021,7 @@ type TreeGridListeners = {
|
|
|
40018
40021
|
* @param {Event} event.event The browser event.
|
|
40019
40022
|
* @param {string} event.region The region where the column was dropped.
|
|
40020
40023
|
*/
|
|
40021
|
-
beforeColumnDropFinalize?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
40024
|
+
beforeColumnDropFinalize?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void)|string
|
|
40022
40025
|
/**
|
|
40023
40026
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
40024
40027
|
* `false`.
|
|
@@ -40027,7 +40030,7 @@ type TreeGridListeners = {
|
|
|
40027
40030
|
* @param {Grid.column.Column} event.column The column
|
|
40028
40031
|
* @param {Event} event.domEvent The browser event
|
|
40029
40032
|
*/
|
|
40030
|
-
beforeColumnResize?: ((event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
40033
|
+
beforeColumnResize?: ((event: { source: Grid, column: Column, domEvent: Event }) => boolean|void)|string
|
|
40031
40034
|
/**
|
|
40032
40035
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
40033
40036
|
* @param {object} event Event object
|
|
@@ -40051,14 +40054,14 @@ type TreeGridListeners = {
|
|
|
40051
40054
|
* @param {XLSColumn[]} event.columns An array of columns to export
|
|
40052
40055
|
* @param {any[][]} event.rows An array of records to export
|
|
40053
40056
|
*/
|
|
40054
|
-
beforeExcelExport?: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
40057
|
+
beforeExcelExport?: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void)|string
|
|
40055
40058
|
/**
|
|
40056
40059
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
40057
40060
|
* @param {object} event Event object
|
|
40058
40061
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
40059
40062
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
40060
40063
|
*/
|
|
40061
|
-
beforeFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
40064
|
+
beforeFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
40062
40065
|
/**
|
|
40063
40066
|
* 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.
|
|
40064
40067
|
* @param {object} event Event object
|
|
@@ -40079,7 +40082,7 @@ type TreeGridListeners = {
|
|
|
40079
40082
|
* @param {object} event Event object
|
|
40080
40083
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
40081
40084
|
*/
|
|
40082
|
-
beforeHide?: ((event: { source: Widget }) =>
|
|
40085
|
+
beforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
40083
40086
|
/**
|
|
40084
40087
|
* Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
|
|
40085
40088
|
* @param {object} event Event object
|
|
@@ -40095,7 +40098,7 @@ type TreeGridListeners = {
|
|
|
40095
40098
|
* @param {object} event Event object
|
|
40096
40099
|
* @param {PdfExportConfig} event.config Export config
|
|
40097
40100
|
*/
|
|
40098
|
-
beforePdfExport?: ((event: { config: PdfExportConfig }) =>
|
|
40101
|
+
beforePdfExport?: ((event: { config: PdfExportConfig }) => boolean|void)|string
|
|
40099
40102
|
/**
|
|
40100
40103
|
* Fires before a row is rendered.
|
|
40101
40104
|
* @param {object} event Event object
|
|
@@ -40138,7 +40141,7 @@ type TreeGridListeners = {
|
|
|
40138
40141
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
40139
40142
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
40140
40143
|
*/
|
|
40141
|
-
beforeSelectionChange?: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
40144
|
+
beforeSelectionChange?: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => boolean|void)|string
|
|
40142
40145
|
/**
|
|
40143
40146
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
40144
40147
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -40159,19 +40162,19 @@ type TreeGridListeners = {
|
|
|
40159
40162
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
40160
40163
|
* @param {RowEditorContext} event.editorContext Editing context
|
|
40161
40164
|
*/
|
|
40162
|
-
beforeStartRowEdit?: ((event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
40165
|
+
beforeStartRowEdit?: ((event: { source: Grid, editorContext: RowEditorContext }) => boolean|void)|string
|
|
40163
40166
|
/**
|
|
40164
40167
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
40165
40168
|
* @param {object} event Event object
|
|
40166
40169
|
* @param {GridStateInfo} event.state State object config
|
|
40167
40170
|
*/
|
|
40168
|
-
beforeStateApply?: ((event: { state: GridStateInfo }) =>
|
|
40171
|
+
beforeStateApply?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
40169
40172
|
/**
|
|
40170
40173
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
40171
40174
|
* @param {object} event Event object
|
|
40172
40175
|
* @param {GridStateInfo} event.state State object config
|
|
40173
40176
|
*/
|
|
40174
|
-
beforeStateSave?: ((event: { state: GridStateInfo }) =>
|
|
40177
|
+
beforeStateSave?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
40175
40178
|
/**
|
|
40176
40179
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
40177
40180
|
* Returning `false` from a listener prevents the operation
|
|
@@ -40181,7 +40184,7 @@ type TreeGridListeners = {
|
|
|
40181
40184
|
* @param {boolean} event.collapse Collapsed (true) or expanded (false)
|
|
40182
40185
|
* @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
40183
40186
|
*/
|
|
40184
|
-
beforeToggleGroup?: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
40187
|
+
beforeToggleGroup?: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void)|string
|
|
40185
40188
|
/**
|
|
40186
40189
|
* Fired before a parent node record toggles its collapsed state.
|
|
40187
40190
|
* @param {object} event Event object
|
|
@@ -40250,7 +40253,7 @@ type TreeGridListeners = {
|
|
|
40250
40253
|
* @param {Grid.column.Column} event.column Column
|
|
40251
40254
|
* @param {Core.data.Model} event.record Record
|
|
40252
40255
|
*/
|
|
40253
|
-
cellMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
40256
|
+
cellMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void)|string
|
|
40254
40257
|
/**
|
|
40255
40258
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
40256
40259
|
* @param {object} event Event object
|
|
@@ -40377,7 +40380,7 @@ type TreeGridListeners = {
|
|
|
40377
40380
|
* @param {Event} event.event The browser event.
|
|
40378
40381
|
* @param {string} event.region The region where the column was dropped.
|
|
40379
40382
|
*/
|
|
40380
|
-
columnDrop?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
40383
|
+
columnDrop?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void)|string
|
|
40381
40384
|
/**
|
|
40382
40385
|
* This event is fired after a resize gesture is completed.
|
|
40383
40386
|
* @param {object} event Event object
|
|
@@ -40517,7 +40520,7 @@ type TreeGridListeners = {
|
|
|
40517
40520
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
40518
40521
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
40519
40522
|
*/
|
|
40520
|
-
fillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
40523
|
+
fillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
40521
40524
|
/**
|
|
40522
40525
|
* Fires on the owning Grid when cell editing is finished
|
|
40523
40526
|
* @param {object} event Event object
|
|
@@ -40565,7 +40568,7 @@ type TreeGridListeners = {
|
|
|
40565
40568
|
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
40566
40569
|
* @param {MouseEvent,TouchEvent} event.event
|
|
40567
40570
|
*/
|
|
40568
|
-
gridRowBeforeDragStart?: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
40571
|
+
gridRowBeforeDragStart?: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void)|string
|
|
40569
40572
|
/**
|
|
40570
40573
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
40571
40574
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
@@ -40632,7 +40635,7 @@ type TreeGridListeners = {
|
|
|
40632
40635
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
40633
40636
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
40634
40637
|
*/
|
|
40635
|
-
headerClick?: ((event: { domEvent: Event, column: Column }) =>
|
|
40638
|
+
headerClick?: ((event: { domEvent: Event, column: Column }) => boolean|void)|string
|
|
40636
40639
|
/**
|
|
40637
40640
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
40638
40641
|
* 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).
|
|
@@ -40643,7 +40646,7 @@ type TreeGridListeners = {
|
|
|
40643
40646
|
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
40644
40647
|
* @param {Grid.column.Column} event.column Column
|
|
40645
40648
|
*/
|
|
40646
|
-
headerMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
40649
|
+
headerMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void)|string
|
|
40647
40650
|
/**
|
|
40648
40651
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
40649
40652
|
* @param {object} event Event object
|
|
@@ -40854,7 +40857,7 @@ type TreeGridListeners = {
|
|
|
40854
40857
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
40855
40858
|
* @param {Event} event.domEvent The native DOM event
|
|
40856
40859
|
*/
|
|
40857
|
-
splitterCollapseClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
40860
|
+
splitterCollapseClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
40858
40861
|
/**
|
|
40859
40862
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
40860
40863
|
* @param {object} event Event object
|
|
@@ -40879,7 +40882,7 @@ type TreeGridListeners = {
|
|
|
40879
40882
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
40880
40883
|
* @param {Event} event.domEvent The native DOM event
|
|
40881
40884
|
*/
|
|
40882
|
-
splitterExpandClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
40885
|
+
splitterExpandClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
40883
40886
|
/**
|
|
40884
40887
|
* Fires on the owning Grid when editing starts
|
|
40885
40888
|
* @param {object} event Event object
|
|
@@ -41763,14 +41766,14 @@ type TreeGridConfig = {
|
|
|
41763
41766
|
* @param {string} event.lineDelimiter The CSV delimiter to separate lines
|
|
41764
41767
|
* @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
|
|
41765
41768
|
*/
|
|
41766
|
-
onBeforeCSVExport?: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
41769
|
+
onBeforeCSVExport?: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void)|string
|
|
41767
41770
|
/**
|
|
41768
41771
|
* Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
|
|
41769
41772
|
* @param {object} event Event object
|
|
41770
41773
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
41771
41774
|
* @param {Grid.util.GridLocation} event.editorContext Editing context
|
|
41772
41775
|
*/
|
|
41773
|
-
onBeforeCancelCellEdit?: ((event: { source: Grid, editorContext: GridLocation }) =>
|
|
41776
|
+
onBeforeCancelCellEdit?: ((event: { source: Grid, editorContext: GridLocation }) => boolean|void)|string
|
|
41774
41777
|
/**
|
|
41775
41778
|
* 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.
|
|
41776
41779
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-beforeCancelRowEdit)
|
|
@@ -41785,7 +41788,7 @@ type TreeGridConfig = {
|
|
|
41785
41788
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
41786
41789
|
* @param {CellEditorContext} event.editorContext Editing context
|
|
41787
41790
|
*/
|
|
41788
|
-
onBeforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
41791
|
+
onBeforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => boolean|void)|string
|
|
41789
41792
|
/**
|
|
41790
41793
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
41791
41794
|
* buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
|
|
@@ -41793,7 +41796,7 @@ type TreeGridConfig = {
|
|
|
41793
41796
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
41794
41797
|
* @param {(Grid.util.GridLocation|Core.data.Model)[]} 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).
|
|
41795
41798
|
*/
|
|
41796
|
-
onBeforeCellRangeDelete?: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
41799
|
+
onBeforeCellRangeDelete?: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void)|string
|
|
41797
41800
|
/**
|
|
41798
41801
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
41799
41802
|
* @param {object} event Event object
|
|
@@ -41801,7 +41804,7 @@ type TreeGridConfig = {
|
|
|
41801
41804
|
* @param {string} event.field The field being changed
|
|
41802
41805
|
* @param {any} event.value The value being set
|
|
41803
41806
|
*/
|
|
41804
|
-
onBeforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) =>
|
|
41807
|
+
onBeforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => boolean|void)|string
|
|
41805
41808
|
/**
|
|
41806
41809
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
41807
41810
|
* @param {object} event Event object
|
|
@@ -41817,7 +41820,7 @@ type TreeGridConfig = {
|
|
|
41817
41820
|
* @param {Grid.column.Column} event.column The dragged column.
|
|
41818
41821
|
* @param {Event} event.event The browser event.
|
|
41819
41822
|
*/
|
|
41820
|
-
onBeforeColumnDragStart?: ((event: { source: Grid, column: Column, event: Event }) =>
|
|
41823
|
+
onBeforeColumnDragStart?: ((event: { source: Grid, column: Column, event: Event }) => boolean|void)|string
|
|
41821
41824
|
/**
|
|
41822
41825
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
41823
41826
|
* @param {object} event Event object
|
|
@@ -41828,7 +41831,7 @@ type TreeGridConfig = {
|
|
|
41828
41831
|
* @param {Event} event.event The browser event.
|
|
41829
41832
|
* @param {string} event.region The region where the column was dropped.
|
|
41830
41833
|
*/
|
|
41831
|
-
onBeforeColumnDropFinalize?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
41834
|
+
onBeforeColumnDropFinalize?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void)|string
|
|
41832
41835
|
/**
|
|
41833
41836
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
41834
41837
|
* `false`.
|
|
@@ -41837,7 +41840,7 @@ type TreeGridConfig = {
|
|
|
41837
41840
|
* @param {Grid.column.Column} event.column The column
|
|
41838
41841
|
* @param {Event} event.domEvent The browser event
|
|
41839
41842
|
*/
|
|
41840
|
-
onBeforeColumnResize?: ((event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
41843
|
+
onBeforeColumnResize?: ((event: { source: Grid, column: Column, domEvent: Event }) => boolean|void)|string
|
|
41841
41844
|
/**
|
|
41842
41845
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
41843
41846
|
* @param {object} event Event object
|
|
@@ -41861,14 +41864,14 @@ type TreeGridConfig = {
|
|
|
41861
41864
|
* @param {XLSColumn[]} event.columns An array of columns to export
|
|
41862
41865
|
* @param {any[][]} event.rows An array of records to export
|
|
41863
41866
|
*/
|
|
41864
|
-
onBeforeExcelExport?: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
41867
|
+
onBeforeExcelExport?: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void)|string
|
|
41865
41868
|
/**
|
|
41866
41869
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
41867
41870
|
* @param {object} event Event object
|
|
41868
41871
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
41869
41872
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
41870
41873
|
*/
|
|
41871
|
-
onBeforeFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
41874
|
+
onBeforeFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
41872
41875
|
/**
|
|
41873
41876
|
* 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.
|
|
41874
41877
|
* @param {object} event Event object
|
|
@@ -41889,7 +41892,7 @@ type TreeGridConfig = {
|
|
|
41889
41892
|
* @param {object} event Event object
|
|
41890
41893
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
41891
41894
|
*/
|
|
41892
|
-
onBeforeHide?: ((event: { source: Widget }) =>
|
|
41895
|
+
onBeforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
41893
41896
|
/**
|
|
41894
41897
|
* Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
|
|
41895
41898
|
* @param {object} event Event object
|
|
@@ -41905,7 +41908,7 @@ type TreeGridConfig = {
|
|
|
41905
41908
|
* @param {object} event Event object
|
|
41906
41909
|
* @param {PdfExportConfig} event.config Export config
|
|
41907
41910
|
*/
|
|
41908
|
-
onBeforePdfExport?: ((event: { config: PdfExportConfig }) =>
|
|
41911
|
+
onBeforePdfExport?: ((event: { config: PdfExportConfig }) => boolean|void)|string
|
|
41909
41912
|
/**
|
|
41910
41913
|
* Fires before a row is rendered.
|
|
41911
41914
|
* @param {object} event Event object
|
|
@@ -41948,7 +41951,7 @@ type TreeGridConfig = {
|
|
|
41948
41951
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
41949
41952
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
41950
41953
|
*/
|
|
41951
|
-
onBeforeSelectionChange?: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
41954
|
+
onBeforeSelectionChange?: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => boolean|void)|string
|
|
41952
41955
|
/**
|
|
41953
41956
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
41954
41957
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -41969,19 +41972,19 @@ type TreeGridConfig = {
|
|
|
41969
41972
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
41970
41973
|
* @param {RowEditorContext} event.editorContext Editing context
|
|
41971
41974
|
*/
|
|
41972
|
-
onBeforeStartRowEdit?: ((event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
41975
|
+
onBeforeStartRowEdit?: ((event: { source: Grid, editorContext: RowEditorContext }) => boolean|void)|string
|
|
41973
41976
|
/**
|
|
41974
41977
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
41975
41978
|
* @param {object} event Event object
|
|
41976
41979
|
* @param {GridStateInfo} event.state State object config
|
|
41977
41980
|
*/
|
|
41978
|
-
onBeforeStateApply?: ((event: { state: GridStateInfo }) =>
|
|
41981
|
+
onBeforeStateApply?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
41979
41982
|
/**
|
|
41980
41983
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
41981
41984
|
* @param {object} event Event object
|
|
41982
41985
|
* @param {GridStateInfo} event.state State object config
|
|
41983
41986
|
*/
|
|
41984
|
-
onBeforeStateSave?: ((event: { state: GridStateInfo }) =>
|
|
41987
|
+
onBeforeStateSave?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
41985
41988
|
/**
|
|
41986
41989
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
41987
41990
|
* Returning `false` from a listener prevents the operation
|
|
@@ -41991,7 +41994,7 @@ type TreeGridConfig = {
|
|
|
41991
41994
|
* @param {boolean} event.collapse Collapsed (true) or expanded (false)
|
|
41992
41995
|
* @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
41993
41996
|
*/
|
|
41994
|
-
onBeforeToggleGroup?: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
41997
|
+
onBeforeToggleGroup?: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void)|string
|
|
41995
41998
|
/**
|
|
41996
41999
|
* Fired before a parent node record toggles its collapsed state.
|
|
41997
42000
|
* @param {object} event Event object
|
|
@@ -42060,7 +42063,7 @@ type TreeGridConfig = {
|
|
|
42060
42063
|
* @param {Grid.column.Column} event.column Column
|
|
42061
42064
|
* @param {Core.data.Model} event.record Record
|
|
42062
42065
|
*/
|
|
42063
|
-
onCellMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
42066
|
+
onCellMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void)|string
|
|
42064
42067
|
/**
|
|
42065
42068
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
42066
42069
|
* @param {object} event Event object
|
|
@@ -42187,7 +42190,7 @@ type TreeGridConfig = {
|
|
|
42187
42190
|
* @param {Event} event.event The browser event.
|
|
42188
42191
|
* @param {string} event.region The region where the column was dropped.
|
|
42189
42192
|
*/
|
|
42190
|
-
onColumnDrop?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
42193
|
+
onColumnDrop?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void)|string
|
|
42191
42194
|
/**
|
|
42192
42195
|
* This event is fired after a resize gesture is completed.
|
|
42193
42196
|
* @param {object} event Event object
|
|
@@ -42327,7 +42330,7 @@ type TreeGridConfig = {
|
|
|
42327
42330
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
42328
42331
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
42329
42332
|
*/
|
|
42330
|
-
onFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
42333
|
+
onFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
42331
42334
|
/**
|
|
42332
42335
|
* Fires on the owning Grid when cell editing is finished
|
|
42333
42336
|
* @param {object} event Event object
|
|
@@ -42375,7 +42378,7 @@ type TreeGridConfig = {
|
|
|
42375
42378
|
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
42376
42379
|
* @param {MouseEvent,TouchEvent} event.event
|
|
42377
42380
|
*/
|
|
42378
|
-
onGridRowBeforeDragStart?: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
42381
|
+
onGridRowBeforeDragStart?: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void)|string
|
|
42379
42382
|
/**
|
|
42380
42383
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
42381
42384
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
@@ -42442,7 +42445,7 @@ type TreeGridConfig = {
|
|
|
42442
42445
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
42443
42446
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
42444
42447
|
*/
|
|
42445
|
-
onHeaderClick?: ((event: { domEvent: Event, column: Column }) =>
|
|
42448
|
+
onHeaderClick?: ((event: { domEvent: Event, column: Column }) => boolean|void)|string
|
|
42446
42449
|
/**
|
|
42447
42450
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
42448
42451
|
* 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).
|
|
@@ -42453,7 +42456,7 @@ type TreeGridConfig = {
|
|
|
42453
42456
|
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
42454
42457
|
* @param {Grid.column.Column} event.column Column
|
|
42455
42458
|
*/
|
|
42456
|
-
onHeaderMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
42459
|
+
onHeaderMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void)|string
|
|
42457
42460
|
/**
|
|
42458
42461
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
42459
42462
|
* @param {object} event Event object
|
|
@@ -42664,7 +42667,7 @@ type TreeGridConfig = {
|
|
|
42664
42667
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
42665
42668
|
* @param {Event} event.domEvent The native DOM event
|
|
42666
42669
|
*/
|
|
42667
|
-
onSplitterCollapseClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
42670
|
+
onSplitterCollapseClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
42668
42671
|
/**
|
|
42669
42672
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
42670
42673
|
* @param {object} event Event object
|
|
@@ -42689,7 +42692,7 @@ type TreeGridConfig = {
|
|
|
42689
42692
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
42690
42693
|
* @param {Event} event.domEvent The native DOM event
|
|
42691
42694
|
*/
|
|
42692
|
-
onSplitterExpandClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
42695
|
+
onSplitterExpandClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
42693
42696
|
/**
|
|
42694
42697
|
* Fires on the owning Grid when editing starts
|
|
42695
42698
|
* @param {object} event Event object
|
|
@@ -42799,19 +42802,19 @@ export class TreeGrid extends Grid {
|
|
|
42799
42802
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
42800
42803
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
42801
42804
|
*/
|
|
42802
|
-
onBeforeSelectionChange: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
42805
|
+
onBeforeSelectionChange: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => boolean|void)|string
|
|
42803
42806
|
/**
|
|
42804
42807
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
42805
42808
|
* @param {object} event Event object
|
|
42806
42809
|
* @param {GridStateInfo} event.state State object config
|
|
42807
42810
|
*/
|
|
42808
|
-
onBeforeStateApply: ((event: { state: GridStateInfo }) =>
|
|
42811
|
+
onBeforeStateApply: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
42809
42812
|
/**
|
|
42810
42813
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
42811
42814
|
* @param {object} event Event object
|
|
42812
42815
|
* @param {GridStateInfo} event.state State object config
|
|
42813
42816
|
*/
|
|
42814
|
-
onBeforeStateSave: ((event: { state: GridStateInfo }) =>
|
|
42817
|
+
onBeforeStateSave: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
42815
42818
|
/**
|
|
42816
42819
|
* Fires when any other event is fired from the object.
|
|
42817
42820
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-catchAll)
|
|
@@ -42917,7 +42920,7 @@ export class TreeGrid extends Grid {
|
|
|
42917
42920
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
42918
42921
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
42919
42922
|
*/
|
|
42920
|
-
onHeaderClick: ((event: { domEvent: Event, column: Column }) =>
|
|
42923
|
+
onHeaderClick: ((event: { domEvent: Event, column: Column }) => boolean|void)|string
|
|
42921
42924
|
/**
|
|
42922
42925
|
* Mouse moved out from element in grid
|
|
42923
42926
|
* @param {object} event Event object
|
|
@@ -43031,7 +43034,7 @@ type ExportDialogListenersTypes = {
|
|
|
43031
43034
|
* @param {object} event Event object
|
|
43032
43035
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
43033
43036
|
*/
|
|
43034
|
-
beforeHide: (event: { source: Widget }) =>
|
|
43037
|
+
beforeHide: (event: { source: Widget }) => boolean|void
|
|
43035
43038
|
/**
|
|
43036
43039
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
43037
43040
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -43051,13 +43054,13 @@ type ExportDialogListenersTypes = {
|
|
|
43051
43054
|
* @param {object} event Event object
|
|
43052
43055
|
* @param {any} event.state State object config
|
|
43053
43056
|
*/
|
|
43054
|
-
beforeStateApply: (event: { state: any }) =>
|
|
43057
|
+
beforeStateApply: (event: { state: any }) => boolean|void
|
|
43055
43058
|
/**
|
|
43056
43059
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
43057
43060
|
* @param {object} event Event object
|
|
43058
43061
|
* @param {any} event.state State object config
|
|
43059
43062
|
*/
|
|
43060
|
-
beforeStateSave: (event: { state: any }) =>
|
|
43063
|
+
beforeStateSave: (event: { state: any }) => boolean|void
|
|
43061
43064
|
/**
|
|
43062
43065
|
* Fires when cancel button is clicked. Popup will hide itself.
|
|
43063
43066
|
*/
|
|
@@ -43208,7 +43211,7 @@ type ExportDialogListeners = {
|
|
|
43208
43211
|
* @param {object} event Event object
|
|
43209
43212
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
43210
43213
|
*/
|
|
43211
|
-
beforeHide?: ((event: { source: Widget }) =>
|
|
43214
|
+
beforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
43212
43215
|
/**
|
|
43213
43216
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
43214
43217
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -43228,13 +43231,13 @@ type ExportDialogListeners = {
|
|
|
43228
43231
|
* @param {object} event Event object
|
|
43229
43232
|
* @param {any} event.state State object config
|
|
43230
43233
|
*/
|
|
43231
|
-
beforeStateApply?: ((event: { state: any }) =>
|
|
43234
|
+
beforeStateApply?: ((event: { state: any }) => boolean|void)|string
|
|
43232
43235
|
/**
|
|
43233
43236
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
43234
43237
|
* @param {object} event Event object
|
|
43235
43238
|
* @param {any} event.state State object config
|
|
43236
43239
|
*/
|
|
43237
|
-
beforeStateSave?: ((event: { state: any }) =>
|
|
43240
|
+
beforeStateSave?: ((event: { state: any }) => boolean|void)|string
|
|
43238
43241
|
/**
|
|
43239
43242
|
* Fires when cancel button is clicked. Popup will hide itself.
|
|
43240
43243
|
*/
|
|
@@ -44100,7 +44103,7 @@ type ExportDialogConfig = {
|
|
|
44100
44103
|
* @param {object} event Event object
|
|
44101
44104
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
44102
44105
|
*/
|
|
44103
|
-
onBeforeHide?: ((event: { source: Widget }) =>
|
|
44106
|
+
onBeforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
44104
44107
|
/**
|
|
44105
44108
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
44106
44109
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -44120,13 +44123,13 @@ type ExportDialogConfig = {
|
|
|
44120
44123
|
* @param {object} event Event object
|
|
44121
44124
|
* @param {any} event.state State object config
|
|
44122
44125
|
*/
|
|
44123
|
-
onBeforeStateApply?: ((event: { state: any }) =>
|
|
44126
|
+
onBeforeStateApply?: ((event: { state: any }) => boolean|void)|string
|
|
44124
44127
|
/**
|
|
44125
44128
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
44126
44129
|
* @param {object} event Event object
|
|
44127
44130
|
* @param {any} event.state State object config
|
|
44128
44131
|
*/
|
|
44129
|
-
onBeforeStateSave?: ((event: { state: any }) =>
|
|
44132
|
+
onBeforeStateSave?: ((event: { state: any }) => boolean|void)|string
|
|
44130
44133
|
/**
|
|
44131
44134
|
* Fires when cancel button is clicked. Popup will hide itself.
|
|
44132
44135
|
*/
|
|
@@ -44285,13 +44288,13 @@ export class ExportDialog extends Popup {
|
|
|
44285
44288
|
* @param {object} event Event object
|
|
44286
44289
|
* @param {any} event.state State object config
|
|
44287
44290
|
*/
|
|
44288
|
-
onBeforeStateApply: ((event: { state: any }) =>
|
|
44291
|
+
onBeforeStateApply: ((event: { state: any }) => boolean|void)|string
|
|
44289
44292
|
/**
|
|
44290
44293
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
44291
44294
|
* @param {object} event Event object
|
|
44292
44295
|
* @param {any} event.state State object config
|
|
44293
44296
|
*/
|
|
44294
|
-
onBeforeStateSave: ((event: { state: any }) =>
|
|
44297
|
+
onBeforeStateSave: ((event: { state: any }) => boolean|void)|string
|
|
44295
44298
|
/**
|
|
44296
44299
|
* Fires when cancel button is clicked. Popup will hide itself.
|
|
44297
44300
|
*/
|
|
@@ -44422,7 +44425,7 @@ type GridElementEventsClassConfig = {
|
|
|
44422
44425
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
44423
44426
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
44424
44427
|
*/
|
|
44425
|
-
onHeaderClick?: ((event: { domEvent: Event, column: Column }) =>
|
|
44428
|
+
onHeaderClick?: ((event: { domEvent: Event, column: Column }) => boolean|void)|string
|
|
44426
44429
|
/**
|
|
44427
44430
|
* Mouse moved out from element in grid
|
|
44428
44431
|
* @param {object} event Event object
|
|
@@ -44560,7 +44563,7 @@ export class GridElementEventsClass {
|
|
|
44560
44563
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
44561
44564
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
44562
44565
|
*/
|
|
44563
|
-
onHeaderClick: ((event: { domEvent: Event, column: Column }) =>
|
|
44566
|
+
onHeaderClick: ((event: { domEvent: Event, column: Column }) => boolean|void)|string
|
|
44564
44567
|
/**
|
|
44565
44568
|
* Mouse moved out from element in grid
|
|
44566
44569
|
* @param {object} event Event object
|
|
@@ -44716,7 +44719,7 @@ type GridSelectionClassConfig = {
|
|
|
44716
44719
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
44717
44720
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
44718
44721
|
*/
|
|
44719
|
-
onBeforeSelectionChange?: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
44722
|
+
onBeforeSelectionChange?: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => boolean|void)|string
|
|
44720
44723
|
/**
|
|
44721
44724
|
* Fires while drag selecting. UI will update with current range, but the cells will not be selected until
|
|
44722
44725
|
* mouse up. This event can be listened for to perform actions while drag selecting.
|
|
@@ -44802,7 +44805,7 @@ export class GridSelectionClass {
|
|
|
44802
44805
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
44803
44806
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
44804
44807
|
*/
|
|
44805
|
-
onBeforeSelectionChange: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
44808
|
+
onBeforeSelectionChange: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => boolean|void)|string
|
|
44806
44809
|
/**
|
|
44807
44810
|
* Fires while drag selecting. UI will update with current range, but the cells will not be selected until
|
|
44808
44811
|
* mouse up. This event can be listened for to perform actions while drag selecting.
|
|
@@ -44960,13 +44963,13 @@ type GridStateClassConfig = {
|
|
|
44960
44963
|
* @param {object} event Event object
|
|
44961
44964
|
* @param {GridStateInfo} event.state State object config
|
|
44962
44965
|
*/
|
|
44963
|
-
onBeforeStateApply?: ((event: { state: GridStateInfo }) =>
|
|
44966
|
+
onBeforeStateApply?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
44964
44967
|
/**
|
|
44965
44968
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
44966
44969
|
* @param {object} event Event object
|
|
44967
44970
|
* @param {GridStateInfo} event.state State object config
|
|
44968
44971
|
*/
|
|
44969
|
-
onBeforeStateSave?: ((event: { state: GridStateInfo }) =>
|
|
44972
|
+
onBeforeStateSave?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
44970
44973
|
}
|
|
44971
44974
|
|
|
44972
44975
|
export class GridStateClass {
|
|
@@ -44993,13 +44996,13 @@ export class GridStateClass {
|
|
|
44993
44996
|
* @param {object} event Event object
|
|
44994
44997
|
* @param {GridStateInfo} event.state State object config
|
|
44995
44998
|
*/
|
|
44996
|
-
onBeforeStateApply: ((event: { state: GridStateInfo }) =>
|
|
44999
|
+
onBeforeStateApply: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
44997
45000
|
/**
|
|
44998
45001
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
44999
45002
|
* @param {object} event Event object
|
|
45000
45003
|
* @param {GridStateInfo} event.state State object config
|
|
45001
45004
|
*/
|
|
45002
|
-
onBeforeStateSave: ((event: { state: GridStateInfo }) =>
|
|
45005
|
+
onBeforeStateSave: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
45003
45006
|
/**
|
|
45004
45007
|
* Creates an instance of the class using the supplied configuration
|
|
45005
45008
|
* @param {GridStateClassConfig} [config]
|
|
@@ -45066,7 +45069,7 @@ type AIFilterFieldListenersTypes = {
|
|
|
45066
45069
|
* @param {object} event Event object
|
|
45067
45070
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
45068
45071
|
*/
|
|
45069
|
-
beforeHide: (event: { source: Widget }) =>
|
|
45072
|
+
beforeHide: (event: { source: Widget }) => boolean|void
|
|
45070
45073
|
/**
|
|
45071
45074
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
45072
45075
|
* @param {object} event Event object
|
|
@@ -45228,7 +45231,7 @@ type AIFilterFieldListeners = {
|
|
|
45228
45231
|
* @param {object} event Event object
|
|
45229
45232
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
45230
45233
|
*/
|
|
45231
|
-
beforeHide?: ((event: { source: Widget }) =>
|
|
45234
|
+
beforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
45232
45235
|
/**
|
|
45233
45236
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
45234
45237
|
* @param {object} event Event object
|
|
@@ -45436,6 +45439,15 @@ type AIFilterFieldConfig = {
|
|
|
45436
45439
|
* Set to `true` to centre the Widget in browser viewport space.
|
|
45437
45440
|
*/
|
|
45438
45441
|
centered?: boolean
|
|
45442
|
+
/**
|
|
45443
|
+
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
45444
|
+
* to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-isValid)
|
|
45445
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-required) check.
|
|
45446
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-checkValidity)
|
|
45447
|
+
* @param {Core.widget.Field} field The field being validated
|
|
45448
|
+
* @returns {void}
|
|
45449
|
+
*/
|
|
45450
|
+
checkValidity?: ((field: Field) => void)|string
|
|
45439
45451
|
/**
|
|
45440
45452
|
* Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
|
|
45441
45453
|
* in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
|
|
@@ -45990,7 +46002,7 @@ type AIFilterFieldConfig = {
|
|
|
45990
46002
|
* @param {object} event Event object
|
|
45991
46003
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
45992
46004
|
*/
|
|
45993
|
-
onBeforeHide?: ((event: { source: Widget }) =>
|
|
46005
|
+
onBeforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
45994
46006
|
/**
|
|
45995
46007
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
45996
46008
|
* @param {object} event Event object
|
|
@@ -46187,7 +46199,7 @@ type ChecklistFilterComboListenersTypes = {
|
|
|
46187
46199
|
* @param {object} event Event object
|
|
46188
46200
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
46189
46201
|
*/
|
|
46190
|
-
beforeHide: (event: { source: Widget }) =>
|
|
46202
|
+
beforeHide: (event: { source: Widget }) => boolean|void
|
|
46191
46203
|
/**
|
|
46192
46204
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
46193
46205
|
* @param {object} event Event object
|
|
@@ -46355,7 +46367,7 @@ type ChecklistFilterComboListeners = {
|
|
|
46355
46367
|
* @param {object} event Event object
|
|
46356
46368
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
46357
46369
|
*/
|
|
46358
|
-
beforeHide?: ((event: { source: Widget }) =>
|
|
46370
|
+
beforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
46359
46371
|
/**
|
|
46360
46372
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
46361
46373
|
* @param {object} event Event object
|
|
@@ -46586,6 +46598,15 @@ type ChecklistFilterComboConfig = {
|
|
|
46586
46598
|
* Set to `true` to centre the Widget in browser viewport space.
|
|
46587
46599
|
*/
|
|
46588
46600
|
centered?: boolean
|
|
46601
|
+
/**
|
|
46602
|
+
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
46603
|
+
* to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-isValid)
|
|
46604
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-required) check.
|
|
46605
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-checkValidity)
|
|
46606
|
+
* @param {Core.widget.Field} field The field being validated
|
|
46607
|
+
* @returns {void}
|
|
46608
|
+
*/
|
|
46609
|
+
checkValidity?: ((field: Field) => void)|string
|
|
46589
46610
|
/**
|
|
46590
46611
|
* A config object to configure the [ChipView](https://bryntum.com/products/grid/docs/api/Core/widget/ChipView) to display the
|
|
46591
46612
|
* selected value set when [multiSelect](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-multiSelect) is `true`.
|
|
@@ -47309,7 +47330,7 @@ type ChecklistFilterComboConfig = {
|
|
|
47309
47330
|
* @param {object} event Event object
|
|
47310
47331
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
47311
47332
|
*/
|
|
47312
|
-
onBeforeHide?: ((event: { source: Widget }) =>
|
|
47333
|
+
onBeforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
47313
47334
|
/**
|
|
47314
47335
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
47315
47336
|
* @param {object} event Event object
|
|
@@ -47518,7 +47539,7 @@ type GridChartDesignerListenersTypes = {
|
|
|
47518
47539
|
* @param {object} event Event object
|
|
47519
47540
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
47520
47541
|
*/
|
|
47521
|
-
beforeHide: (event: { source: Widget }) =>
|
|
47542
|
+
beforeHide: (event: { source: Widget }) => boolean|void
|
|
47522
47543
|
/**
|
|
47523
47544
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
47524
47545
|
* @param {object} event Event object
|
|
@@ -47632,7 +47653,7 @@ type GridChartDesignerListeners = {
|
|
|
47632
47653
|
* @param {object} event Event object
|
|
47633
47654
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
47634
47655
|
*/
|
|
47635
|
-
beforeHide?: ((event: { source: Widget }) =>
|
|
47656
|
+
beforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
47636
47657
|
/**
|
|
47637
47658
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
47638
47659
|
* @param {object} event Event object
|
|
@@ -48174,7 +48195,7 @@ type GridChartDesignerConfig = {
|
|
|
48174
48195
|
* @param {object} event Event object
|
|
48175
48196
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
48176
48197
|
*/
|
|
48177
|
-
onBeforeHide?: ((event: { source: Widget }) =>
|
|
48198
|
+
onBeforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
48178
48199
|
/**
|
|
48179
48200
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
48180
48201
|
* @param {object} event Event object
|
|
@@ -48326,7 +48347,7 @@ type GridFieldFilterPickerListenersTypes = {
|
|
|
48326
48347
|
* @param {object} event Event object
|
|
48327
48348
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
48328
48349
|
*/
|
|
48329
|
-
beforeHide: (event: { source: Widget }) =>
|
|
48350
|
+
beforeHide: (event: { source: Widget }) => boolean|void
|
|
48330
48351
|
/**
|
|
48331
48352
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
48332
48353
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -48463,7 +48484,7 @@ type GridFieldFilterPickerListeners = {
|
|
|
48463
48484
|
* @param {object} event Event object
|
|
48464
48485
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
48465
48486
|
*/
|
|
48466
|
-
beforeHide?: ((event: { source: Widget }) =>
|
|
48487
|
+
beforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
48467
48488
|
/**
|
|
48468
48489
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
48469
48490
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -49190,7 +49211,7 @@ type GridFieldFilterPickerConfig = {
|
|
|
49190
49211
|
* @param {object} event Event object
|
|
49191
49212
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
49192
49213
|
*/
|
|
49193
|
-
onBeforeHide?: ((event: { source: Widget }) =>
|
|
49214
|
+
onBeforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
49194
49215
|
/**
|
|
49195
49216
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
49196
49217
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -49362,7 +49383,7 @@ type GridFieldFilterPickerGroupListenersTypes = {
|
|
|
49362
49383
|
* @param {Core.widget.FieldFilterPicker} event.source The FieldFilterPicker instance that fired the event.
|
|
49363
49384
|
* @param {CollectionFilterConfig} event.filter The [CollectionFilter](https://bryntum.com/products/grid/docs/api/Core/util/CollectionFilter) configuration object for the filter represented by this [FieldFilterPicker](https://bryntum.com/products/grid/docs/api/Core/widget/FieldFilterPicker).
|
|
49364
49385
|
*/
|
|
49365
|
-
beforeAddFilter: (event: { source: FieldFilterPicker, filter: CollectionFilterConfig }) =>
|
|
49386
|
+
beforeAddFilter: (event: { source: FieldFilterPicker, filter: CollectionFilterConfig }) => boolean|void
|
|
49366
49387
|
/**
|
|
49367
49388
|
* Fires before an object is destroyed.
|
|
49368
49389
|
* @param {object} event Event object
|
|
@@ -49374,7 +49395,7 @@ type GridFieldFilterPickerGroupListenersTypes = {
|
|
|
49374
49395
|
* @param {object} event Event object
|
|
49375
49396
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
49376
49397
|
*/
|
|
49377
|
-
beforeHide: (event: { source: Widget }) =>
|
|
49398
|
+
beforeHide: (event: { source: Widget }) => boolean|void
|
|
49378
49399
|
/**
|
|
49379
49400
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
49380
49401
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -49507,7 +49528,7 @@ type GridFieldFilterPickerGroupListeners = {
|
|
|
49507
49528
|
* @param {Core.widget.FieldFilterPicker} event.source The FieldFilterPicker instance that fired the event.
|
|
49508
49529
|
* @param {CollectionFilterConfig} event.filter The [CollectionFilter](https://bryntum.com/products/grid/docs/api/Core/util/CollectionFilter) configuration object for the filter represented by this [FieldFilterPicker](https://bryntum.com/products/grid/docs/api/Core/widget/FieldFilterPicker).
|
|
49509
49530
|
*/
|
|
49510
|
-
beforeAddFilter?: ((event: { source: FieldFilterPicker, filter: CollectionFilterConfig }) =>
|
|
49531
|
+
beforeAddFilter?: ((event: { source: FieldFilterPicker, filter: CollectionFilterConfig }) => boolean|void)|string
|
|
49511
49532
|
/**
|
|
49512
49533
|
* Fires before an object is destroyed.
|
|
49513
49534
|
* @param {object} event Event object
|
|
@@ -49519,7 +49540,7 @@ type GridFieldFilterPickerGroupListeners = {
|
|
|
49519
49540
|
* @param {object} event Event object
|
|
49520
49541
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
49521
49542
|
*/
|
|
49522
|
-
beforeHide?: ((event: { source: Widget }) =>
|
|
49543
|
+
beforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
49523
49544
|
/**
|
|
49524
49545
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
49525
49546
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -50248,7 +50269,7 @@ type GridFieldFilterPickerGroupConfig = {
|
|
|
50248
50269
|
* @param {Core.widget.FieldFilterPicker} event.source The FieldFilterPicker instance that fired the event.
|
|
50249
50270
|
* @param {CollectionFilterConfig} event.filter The [CollectionFilter](https://bryntum.com/products/grid/docs/api/Core/util/CollectionFilter) configuration object for the filter represented by this [FieldFilterPicker](https://bryntum.com/products/grid/docs/api/Core/widget/FieldFilterPicker).
|
|
50250
50271
|
*/
|
|
50251
|
-
onBeforeAddFilter?: ((event: { source: FieldFilterPicker, filter: CollectionFilterConfig }) =>
|
|
50272
|
+
onBeforeAddFilter?: ((event: { source: FieldFilterPicker, filter: CollectionFilterConfig }) => boolean|void)|string
|
|
50252
50273
|
/**
|
|
50253
50274
|
* Fires before an object is destroyed.
|
|
50254
50275
|
* @param {object} event Event object
|
|
@@ -50260,7 +50281,7 @@ type GridFieldFilterPickerGroupConfig = {
|
|
|
50260
50281
|
* @param {object} event Event object
|
|
50261
50282
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
50262
50283
|
*/
|
|
50263
|
-
onBeforeHide?: ((event: { source: Widget }) =>
|
|
50284
|
+
onBeforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
50264
50285
|
/**
|
|
50265
50286
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
50266
50287
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -50436,7 +50457,7 @@ type GroupBarListenersTypes = {
|
|
|
50436
50457
|
* @param {object} event Event object
|
|
50437
50458
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
50438
50459
|
*/
|
|
50439
|
-
beforeHide: (event: { source: Widget }) =>
|
|
50460
|
+
beforeHide: (event: { source: Widget }) => boolean|void
|
|
50440
50461
|
/**
|
|
50441
50462
|
* User going to activate an item in the list either by pointer or keyboard.
|
|
50442
50463
|
* The active record, list item index, and the triggering event are passed.
|
|
@@ -50448,7 +50469,7 @@ type GroupBarListenersTypes = {
|
|
|
50448
50469
|
* @param {number} event.index List item index
|
|
50449
50470
|
* @param {Event} event.event Triggering event
|
|
50450
50471
|
*/
|
|
50451
|
-
beforeItem: (event: { source: List, item: HTMLElement, record: Model, index: number, event: Event }) =>
|
|
50472
|
+
beforeItem: (event: { source: List, item: HTMLElement, record: Model, index: number, event: Event }) => boolean|void
|
|
50452
50473
|
/**
|
|
50453
50474
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
50454
50475
|
* @param {object} event Event object
|
|
@@ -50594,7 +50615,7 @@ type GroupBarListeners = {
|
|
|
50594
50615
|
* @param {object} event Event object
|
|
50595
50616
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
50596
50617
|
*/
|
|
50597
|
-
beforeHide?: ((event: { source: Widget }) =>
|
|
50618
|
+
beforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
50598
50619
|
/**
|
|
50599
50620
|
* User going to activate an item in the list either by pointer or keyboard.
|
|
50600
50621
|
* The active record, list item index, and the triggering event are passed.
|
|
@@ -50606,7 +50627,7 @@ type GroupBarListeners = {
|
|
|
50606
50627
|
* @param {number} event.index List item index
|
|
50607
50628
|
* @param {Event} event.event Triggering event
|
|
50608
50629
|
*/
|
|
50609
|
-
beforeItem?: ((event: { source: List, item: HTMLElement, record: Model, index: number, event: Event }) =>
|
|
50630
|
+
beforeItem?: ((event: { source: List, item: HTMLElement, record: Model, index: number, event: Event }) => boolean|void)|string
|
|
50610
50631
|
/**
|
|
50611
50632
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
50612
50633
|
* @param {object} event Event object
|
|
@@ -51293,7 +51314,7 @@ type GroupBarConfig = {
|
|
|
51293
51314
|
* @param {object} event Event object
|
|
51294
51315
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
51295
51316
|
*/
|
|
51296
|
-
onBeforeHide?: ((event: { source: Widget }) =>
|
|
51317
|
+
onBeforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
51297
51318
|
/**
|
|
51298
51319
|
* User going to activate an item in the list either by pointer or keyboard.
|
|
51299
51320
|
* The active record, list item index, and the triggering event are passed.
|
|
@@ -51305,7 +51326,7 @@ type GroupBarConfig = {
|
|
|
51305
51326
|
* @param {number} event.index List item index
|
|
51306
51327
|
* @param {Event} event.event Triggering event
|
|
51307
51328
|
*/
|
|
51308
|
-
onBeforeItem?: ((event: { source: List, item: HTMLElement, record: Model, index: number, event: Event }) =>
|
|
51329
|
+
onBeforeItem?: ((event: { source: List, item: HTMLElement, record: Model, index: number, event: Event }) => boolean|void)|string
|
|
51309
51330
|
/**
|
|
51310
51331
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
51311
51332
|
* @param {object} event Event object
|
|
@@ -51495,7 +51516,7 @@ type TreeComboListenersTypes = {
|
|
|
51495
51516
|
* @param {object} event Event object
|
|
51496
51517
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
51497
51518
|
*/
|
|
51498
|
-
beforeHide: (event: { source: Widget }) =>
|
|
51519
|
+
beforeHide: (event: { source: Widget }) => boolean|void
|
|
51499
51520
|
/**
|
|
51500
51521
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
51501
51522
|
* @param {object} event Event object
|
|
@@ -51663,7 +51684,7 @@ type TreeComboListeners = {
|
|
|
51663
51684
|
* @param {object} event Event object
|
|
51664
51685
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
51665
51686
|
*/
|
|
51666
|
-
beforeHide?: ((event: { source: Widget }) =>
|
|
51687
|
+
beforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
51667
51688
|
/**
|
|
51668
51689
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
51669
51690
|
* @param {object} event Event object
|
|
@@ -51894,6 +51915,15 @@ type TreeComboConfig = {
|
|
|
51894
51915
|
* Set to `true` to centre the Widget in browser viewport space.
|
|
51895
51916
|
*/
|
|
51896
51917
|
centered?: boolean
|
|
51918
|
+
/**
|
|
51919
|
+
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
51920
|
+
* to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-isValid)
|
|
51921
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-required) check.
|
|
51922
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-checkValidity)
|
|
51923
|
+
* @param {Core.widget.Field} field The field being validated
|
|
51924
|
+
* @returns {void}
|
|
51925
|
+
*/
|
|
51926
|
+
checkValidity?: ((field: Field) => void)|string
|
|
51897
51927
|
/**
|
|
51898
51928
|
* A config object to configure the [ChipView](https://bryntum.com/products/grid/docs/api/Core/widget/ChipView) to display the
|
|
51899
51929
|
* selected value set when [multiSelect](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-multiSelect) is `true`.
|
|
@@ -52608,7 +52638,7 @@ type TreeComboConfig = {
|
|
|
52608
52638
|
* @param {object} event Event object
|
|
52609
52639
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
52610
52640
|
*/
|
|
52611
|
-
onBeforeHide?: ((event: { source: Widget }) =>
|
|
52641
|
+
onBeforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
52612
52642
|
/**
|
|
52613
52643
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
52614
52644
|
* @param {object} event Event object
|