@bryntum/grid-thin-trial 7.3.0 → 7.3.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/grid.css +4 -4
- package/grid.css.map +2 -2
- package/grid.d.ts +440 -335
- package/lib/column/ChartColumn.js +1 -1
- package/lib/column/CheckColumn.js +1 -1
- package/lib/column/Column.js +1 -1
- package/lib/column/NumberColumn.js +1 -1
- package/lib/column/TreeColumn.js +1 -1
- package/lib/data/ColumnStore.js +1 -1
- package/lib/feature/CellEdit.js +1 -1
- package/lib/feature/CellTooltip.js +1 -1
- package/lib/feature/ColumnPicker.js +1 -1
- package/lib/feature/FilterBar.js +1 -1
- package/lib/feature/GridFeatureManager.js +1 -1
- package/lib/feature/Group.js +1 -1
- package/lib/feature/RegionResize.css +4 -4
- package/lib/feature/RowCopyPaste.js +1 -1
- package/lib/feature/RowExpander.js +1 -1
- package/lib/feature/RowReorder.js +1 -1
- package/lib/feature/base/CopyPasteBase.js +1 -1
- package/lib/feature/experimental/ExcelExporter.js +1 -1
- package/lib/feature/export/Print.js +1 -1
- package/lib/feature/export/exporter/ExporterBase.js +6 -6
- package/lib/row/Row.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/locales/grid.locale.Ar.js +1 -1
- package/locales/grid.locale.Bg.js +1 -1
- package/locales/grid.locale.Ca.js +1 -1
- package/locales/grid.locale.Cs.js +1 -1
- package/locales/grid.locale.Da.js +1 -1
- package/locales/grid.locale.De.js +1 -1
- package/locales/grid.locale.El.js +1 -1
- package/locales/grid.locale.En.js +1 -1
- package/locales/grid.locale.EnGb.js +1 -1
- package/locales/grid.locale.Es.js +1 -1
- package/locales/grid.locale.Et.js +1 -1
- package/locales/grid.locale.Eu.js +1 -1
- package/locales/grid.locale.Fi.js +1 -1
- package/locales/grid.locale.FrFr.js +1 -1
- package/locales/grid.locale.Gl.js +1 -1
- package/locales/grid.locale.He.js +1 -1
- package/locales/grid.locale.Hi.js +1 -1
- package/locales/grid.locale.Hr.js +1 -1
- package/locales/grid.locale.Hu.js +1 -1
- package/locales/grid.locale.Id.js +1 -1
- package/locales/grid.locale.It.js +1 -1
- package/locales/grid.locale.Ja.js +1 -1
- package/locales/grid.locale.Kk.js +1 -1
- package/locales/grid.locale.Ko.js +1 -1
- package/locales/grid.locale.Lt.js +1 -1
- package/locales/grid.locale.Lv.js +1 -1
- package/locales/grid.locale.Ms.js +1 -1
- package/locales/grid.locale.Nl.js +1 -1
- package/locales/grid.locale.No.js +1 -1
- package/locales/grid.locale.Pl.js +1 -1
- package/locales/grid.locale.Pt.js +1 -1
- package/locales/grid.locale.PtBr.js +1 -1
- package/locales/grid.locale.Ro.js +1 -1
- package/locales/grid.locale.Ru.js +1 -1
- package/locales/grid.locale.Sk.js +1 -1
- package/locales/grid.locale.Sl.js +1 -1
- package/locales/grid.locale.Sr.js +1 -1
- package/locales/grid.locale.SrRs.js +1 -1
- package/locales/grid.locale.SvSE.js +1 -1
- package/locales/grid.locale.Th.js +1 -1
- package/locales/grid.locale.Tr.js +1 -1
- package/locales/grid.locale.Uk.js +1 -1
- package/locales/grid.locale.Vi.js +1 -1
- package/locales/grid.locale.ZhCn.js +1 -1
- package/locales/grid.locale.ZhTw.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
|
|
@@ -16030,6 +16031,8 @@ type CellTooltipConfig = {
|
|
|
16030
16031
|
/**
|
|
16031
16032
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
16032
16033
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
16034
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
16035
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellTooltip#config-appendTo)
|
|
16033
16036
|
*/
|
|
16034
16037
|
appendTo?: HTMLElement|string
|
|
16035
16038
|
/**
|
|
@@ -16291,10 +16294,11 @@ type CellTooltipConfig = {
|
|
|
16291
16294
|
* @param {Core.widget.Tooltip} context.tip The tooltip instance
|
|
16292
16295
|
* @param {HTMLElement} context.element The Element for which the Tooltip is monitoring mouse movement
|
|
16293
16296
|
* @param {HTMLElement} context.activeTarget The target element that triggered the show
|
|
16297
|
+
* @param {HTMLElement} [context.forElement] Alias for `activeTarget`, provided for backward compatibility
|
|
16294
16298
|
* @param {Event} context.event The raw DOM event
|
|
16295
16299
|
* @returns {string,Promise<any>}
|
|
16296
16300
|
*/
|
|
16297
|
-
getHtml?: ((context: { tip: Tooltip, element: HTMLElement, activeTarget: HTMLElement, event: Event }) => Promise<string|Promise<any>>)|string
|
|
16301
|
+
getHtml?: ((context: { tip: Tooltip, element: HTMLElement, activeTarget: HTMLElement, forElement?: HTMLElement, event: Event }) => Promise<string|Promise<any>>)|string
|
|
16298
16302
|
/**
|
|
16299
16303
|
* A config [object](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#typedef-PanelHeader) for the panel's header or a string in place of a `title`.
|
|
16300
16304
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellTooltip#config-header)
|
|
@@ -16370,10 +16374,14 @@ type CellTooltipConfig = {
|
|
|
16370
16374
|
inputFieldAlign?: 'start'|'end'
|
|
16371
16375
|
/**
|
|
16372
16376
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
16377
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
16378
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellTooltip#config-insertBefore)
|
|
16373
16379
|
*/
|
|
16374
16380
|
insertBefore?: HTMLElement|string
|
|
16375
16381
|
/**
|
|
16376
16382
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
16383
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
16384
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellTooltip#config-insertFirst)
|
|
16377
16385
|
*/
|
|
16378
16386
|
insertFirst?: HTMLElement|string
|
|
16379
16387
|
/**
|
|
@@ -22345,13 +22353,15 @@ type RowReorderConfig = {
|
|
|
22345
22353
|
* data (e.g. to copy instead of move), you can provide an object with a `transferData` method.
|
|
22346
22354
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowReorder#config-allowCrossGridDrag)
|
|
22347
22355
|
* @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.
|
|
22356
|
+
* @property {object} allowCrossGridDrag.transferData.data Context object describing the drag drop state.
|
|
22357
|
+
* @property {Grid.view.GridBase} allowCrossGridDrag.transferData.data.sourceGrid The source grid
|
|
22358
|
+
* @property {Grid.view.GridBase} allowCrossGridDrag.transferData.data.targetGrid the target grid
|
|
22359
|
+
* @property {Core.data.Model[]} allowCrossGridDrag.transferData.data.records The dragged records
|
|
22360
|
+
* @property {Core.data.Model} allowCrossGridDrag.transferData.data.insertBefore The record to insert before
|
|
22361
|
+
* @property {Core.data.Model} allowCrossGridDrag.transferData.data.parent The parent record of the current drop position (only applicable for trees)
|
|
22362
|
+
* @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
22363
|
*/
|
|
22354
|
-
allowCrossGridDrag?: boolean|{ transferData: (sourceGrid: GridBase, targetGrid: GridBase, records: Model[], insertBefore: Model, parent: Model) => void }
|
|
22364
|
+
allowCrossGridDrag?: boolean|{ transferData: (data: { sourceGrid: GridBase, targetGrid: GridBase, records: Model[], insertBefore: Model, parent: Model }) => Promise<any>|void }
|
|
22355
22365
|
/**
|
|
22356
22366
|
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
22357
22367
|
* hierarchy when triggered.
|
|
@@ -28411,14 +28421,14 @@ type GridListenersTypes = {
|
|
|
28411
28421
|
* @param {string} event.lineDelimiter The CSV delimiter to separate lines
|
|
28412
28422
|
* @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
|
|
28413
28423
|
*/
|
|
28414
|
-
beforeCSVExport: (event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
28424
|
+
beforeCSVExport: (event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void
|
|
28415
28425
|
/**
|
|
28416
28426
|
* Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
|
|
28417
28427
|
* @param {object} event Event object
|
|
28418
28428
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
28419
28429
|
* @param {Grid.util.GridLocation} event.editorContext Editing context
|
|
28420
28430
|
*/
|
|
28421
|
-
beforeCancelCellEdit: (event: { source: Grid, editorContext: GridLocation }) =>
|
|
28431
|
+
beforeCancelCellEdit: (event: { source: Grid, editorContext: GridLocation }) => boolean|void
|
|
28422
28432
|
/**
|
|
28423
28433
|
* 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
28434
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-beforeCancelRowEdit)
|
|
@@ -28433,7 +28443,7 @@ type GridListenersTypes = {
|
|
|
28433
28443
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
28434
28444
|
* @param {CellEditorContext} event.editorContext Editing context
|
|
28435
28445
|
*/
|
|
28436
|
-
beforeCellEditStart: (event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
28446
|
+
beforeCellEditStart: (event: { source: Grid, editorContext: CellEditorContext }) => boolean|void
|
|
28437
28447
|
/**
|
|
28438
28448
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
28439
28449
|
* 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 +28451,7 @@ type GridListenersTypes = {
|
|
|
28441
28451
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
28442
28452
|
* @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
28453
|
*/
|
|
28444
|
-
beforeCellRangeDelete: (event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
28454
|
+
beforeCellRangeDelete: (event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void
|
|
28445
28455
|
/**
|
|
28446
28456
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
28447
28457
|
* @param {object} event Event object
|
|
@@ -28449,7 +28459,7 @@ type GridListenersTypes = {
|
|
|
28449
28459
|
* @param {string} event.field The field being changed
|
|
28450
28460
|
* @param {any} event.value The value being set
|
|
28451
28461
|
*/
|
|
28452
|
-
beforeCellRangeEdit: (event: { record: Model, field: string, value: any }) =>
|
|
28462
|
+
beforeCellRangeEdit: (event: { record: Model, field: string, value: any }) => boolean|void
|
|
28453
28463
|
/**
|
|
28454
28464
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
28455
28465
|
* @param {object} event Event object
|
|
@@ -28465,7 +28475,7 @@ type GridListenersTypes = {
|
|
|
28465
28475
|
* @param {Grid.column.Column} event.column The dragged column.
|
|
28466
28476
|
* @param {Event} event.event The browser event.
|
|
28467
28477
|
*/
|
|
28468
|
-
beforeColumnDragStart: (event: { source: Grid, column: Column, event: Event }) =>
|
|
28478
|
+
beforeColumnDragStart: (event: { source: Grid, column: Column, event: Event }) => boolean|void
|
|
28469
28479
|
/**
|
|
28470
28480
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
28471
28481
|
* @param {object} event Event object
|
|
@@ -28476,7 +28486,7 @@ type GridListenersTypes = {
|
|
|
28476
28486
|
* @param {Event} event.event The browser event.
|
|
28477
28487
|
* @param {string} event.region The region where the column was dropped.
|
|
28478
28488
|
*/
|
|
28479
|
-
beforeColumnDropFinalize: (event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
28489
|
+
beforeColumnDropFinalize: (event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void
|
|
28480
28490
|
/**
|
|
28481
28491
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
28482
28492
|
* `false`.
|
|
@@ -28485,7 +28495,7 @@ type GridListenersTypes = {
|
|
|
28485
28495
|
* @param {Grid.column.Column} event.column The column
|
|
28486
28496
|
* @param {Event} event.domEvent The browser event
|
|
28487
28497
|
*/
|
|
28488
|
-
beforeColumnResize: (event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
28498
|
+
beforeColumnResize: (event: { source: Grid, column: Column, domEvent: Event }) => boolean|void
|
|
28489
28499
|
/**
|
|
28490
28500
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
28491
28501
|
* @param {object} event Event object
|
|
@@ -28509,14 +28519,14 @@ type GridListenersTypes = {
|
|
|
28509
28519
|
* @param {XLSColumn[]} event.columns An array of columns to export
|
|
28510
28520
|
* @param {any[][]} event.rows An array of records to export
|
|
28511
28521
|
*/
|
|
28512
|
-
beforeExcelExport: (event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
28522
|
+
beforeExcelExport: (event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void
|
|
28513
28523
|
/**
|
|
28514
28524
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
28515
28525
|
* @param {object} event Event object
|
|
28516
28526
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
28517
28527
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
28518
28528
|
*/
|
|
28519
|
-
beforeFillHandleDragStart: (event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
28529
|
+
beforeFillHandleDragStart: (event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void
|
|
28520
28530
|
/**
|
|
28521
28531
|
* 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
28532
|
* @param {object} event Event object
|
|
@@ -28537,7 +28547,7 @@ type GridListenersTypes = {
|
|
|
28537
28547
|
* @param {object} event Event object
|
|
28538
28548
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
28539
28549
|
*/
|
|
28540
|
-
beforeHide: (event: { source: Widget }) =>
|
|
28550
|
+
beforeHide: (event: { source: Widget }) => boolean|void
|
|
28541
28551
|
/**
|
|
28542
28552
|
* Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
|
|
28543
28553
|
* @param {object} event Event object
|
|
@@ -28553,7 +28563,7 @@ type GridListenersTypes = {
|
|
|
28553
28563
|
* @param {object} event Event object
|
|
28554
28564
|
* @param {PdfExportConfig} event.config Export config
|
|
28555
28565
|
*/
|
|
28556
|
-
beforePdfExport: (event: { config: PdfExportConfig }) =>
|
|
28566
|
+
beforePdfExport: (event: { config: PdfExportConfig }) => boolean|void
|
|
28557
28567
|
/**
|
|
28558
28568
|
* Fires before a row is rendered.
|
|
28559
28569
|
* @param {object} event Event object
|
|
@@ -28596,7 +28606,7 @@ type GridListenersTypes = {
|
|
|
28596
28606
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
28597
28607
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
28598
28608
|
*/
|
|
28599
|
-
beforeSelectionChange: (event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
28609
|
+
beforeSelectionChange: (event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => boolean|void
|
|
28600
28610
|
/**
|
|
28601
28611
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
28602
28612
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -28617,19 +28627,19 @@ type GridListenersTypes = {
|
|
|
28617
28627
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
28618
28628
|
* @param {RowEditorContext} event.editorContext Editing context
|
|
28619
28629
|
*/
|
|
28620
|
-
beforeStartRowEdit: (event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
28630
|
+
beforeStartRowEdit: (event: { source: Grid, editorContext: RowEditorContext }) => boolean|void
|
|
28621
28631
|
/**
|
|
28622
28632
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
28623
28633
|
* @param {object} event Event object
|
|
28624
28634
|
* @param {GridStateInfo} event.state State object config
|
|
28625
28635
|
*/
|
|
28626
|
-
beforeStateApply: (event: { state: GridStateInfo }) =>
|
|
28636
|
+
beforeStateApply: (event: { state: GridStateInfo }) => boolean|void
|
|
28627
28637
|
/**
|
|
28628
28638
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
28629
28639
|
* @param {object} event Event object
|
|
28630
28640
|
* @param {GridStateInfo} event.state State object config
|
|
28631
28641
|
*/
|
|
28632
|
-
beforeStateSave: (event: { state: GridStateInfo }) =>
|
|
28642
|
+
beforeStateSave: (event: { state: GridStateInfo }) => boolean|void
|
|
28633
28643
|
/**
|
|
28634
28644
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
28635
28645
|
* Returning `false` from a listener prevents the operation
|
|
@@ -28639,7 +28649,7 @@ type GridListenersTypes = {
|
|
|
28639
28649
|
* @param {boolean} event.collapse Collapsed (true) or expanded (false)
|
|
28640
28650
|
* @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
28641
28651
|
*/
|
|
28642
|
-
beforeToggleGroup: (event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
28652
|
+
beforeToggleGroup: (event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void
|
|
28643
28653
|
/**
|
|
28644
28654
|
* Fired before a parent node record toggles its collapsed state.
|
|
28645
28655
|
* @param {object} event Event object
|
|
@@ -28708,7 +28718,7 @@ type GridListenersTypes = {
|
|
|
28708
28718
|
* @param {Grid.column.Column} event.column Column
|
|
28709
28719
|
* @param {Core.data.Model} event.record Record
|
|
28710
28720
|
*/
|
|
28711
|
-
cellMenuBeforeShow: (event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
28721
|
+
cellMenuBeforeShow: (event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void
|
|
28712
28722
|
/**
|
|
28713
28723
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
28714
28724
|
* @param {object} event Event object
|
|
@@ -28835,7 +28845,7 @@ type GridListenersTypes = {
|
|
|
28835
28845
|
* @param {Event} event.event The browser event.
|
|
28836
28846
|
* @param {string} event.region The region where the column was dropped.
|
|
28837
28847
|
*/
|
|
28838
|
-
columnDrop: (event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
28848
|
+
columnDrop: (event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void
|
|
28839
28849
|
/**
|
|
28840
28850
|
* This event is fired after a resize gesture is completed.
|
|
28841
28851
|
* @param {object} event Event object
|
|
@@ -28975,7 +28985,7 @@ type GridListenersTypes = {
|
|
|
28975
28985
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
28976
28986
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
28977
28987
|
*/
|
|
28978
|
-
fillHandleDragStart: (event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
28988
|
+
fillHandleDragStart: (event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void
|
|
28979
28989
|
/**
|
|
28980
28990
|
* Fires on the owning Grid when cell editing is finished
|
|
28981
28991
|
* @param {object} event Event object
|
|
@@ -29023,7 +29033,7 @@ type GridListenersTypes = {
|
|
|
29023
29033
|
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
29024
29034
|
* @param {MouseEvent,TouchEvent} event.event
|
|
29025
29035
|
*/
|
|
29026
|
-
gridRowBeforeDragStart: (event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
29036
|
+
gridRowBeforeDragStart: (event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void
|
|
29027
29037
|
/**
|
|
29028
29038
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
29029
29039
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
@@ -29090,7 +29100,7 @@ type GridListenersTypes = {
|
|
|
29090
29100
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
29091
29101
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
29092
29102
|
*/
|
|
29093
|
-
headerClick: (event: { domEvent: Event, column: Column }) =>
|
|
29103
|
+
headerClick: (event: { domEvent: Event, column: Column }) => boolean|void
|
|
29094
29104
|
/**
|
|
29095
29105
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
29096
29106
|
* 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 +29111,7 @@ type GridListenersTypes = {
|
|
|
29101
29111
|
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
29102
29112
|
* @param {Grid.column.Column} event.column Column
|
|
29103
29113
|
*/
|
|
29104
|
-
headerMenuBeforeShow: (event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
29114
|
+
headerMenuBeforeShow: (event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void
|
|
29105
29115
|
/**
|
|
29106
29116
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
29107
29117
|
* @param {object} event Event object
|
|
@@ -29312,7 +29322,7 @@ type GridListenersTypes = {
|
|
|
29312
29322
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
29313
29323
|
* @param {Event} event.domEvent The native DOM event
|
|
29314
29324
|
*/
|
|
29315
|
-
splitterCollapseClick: (event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
29325
|
+
splitterCollapseClick: (event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void
|
|
29316
29326
|
/**
|
|
29317
29327
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
29318
29328
|
* @param {object} event Event object
|
|
@@ -29337,7 +29347,7 @@ type GridListenersTypes = {
|
|
|
29337
29347
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
29338
29348
|
* @param {Event} event.domEvent The native DOM event
|
|
29339
29349
|
*/
|
|
29340
|
-
splitterExpandClick: (event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
29350
|
+
splitterExpandClick: (event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void
|
|
29341
29351
|
/**
|
|
29342
29352
|
* Fires on the owning Grid when editing starts
|
|
29343
29353
|
* @param {object} event Event object
|
|
@@ -29426,14 +29436,14 @@ type GridListeners = {
|
|
|
29426
29436
|
* @param {string} event.lineDelimiter The CSV delimiter to separate lines
|
|
29427
29437
|
* @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
|
|
29428
29438
|
*/
|
|
29429
|
-
beforeCSVExport?: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
29439
|
+
beforeCSVExport?: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void)|string
|
|
29430
29440
|
/**
|
|
29431
29441
|
* Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
|
|
29432
29442
|
* @param {object} event Event object
|
|
29433
29443
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
29434
29444
|
* @param {Grid.util.GridLocation} event.editorContext Editing context
|
|
29435
29445
|
*/
|
|
29436
|
-
beforeCancelCellEdit?: ((event: { source: Grid, editorContext: GridLocation }) =>
|
|
29446
|
+
beforeCancelCellEdit?: ((event: { source: Grid, editorContext: GridLocation }) => boolean|void)|string
|
|
29437
29447
|
/**
|
|
29438
29448
|
* 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
29449
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-beforeCancelRowEdit)
|
|
@@ -29448,7 +29458,7 @@ type GridListeners = {
|
|
|
29448
29458
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
29449
29459
|
* @param {CellEditorContext} event.editorContext Editing context
|
|
29450
29460
|
*/
|
|
29451
|
-
beforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
29461
|
+
beforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => boolean|void)|string
|
|
29452
29462
|
/**
|
|
29453
29463
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
29454
29464
|
* 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 +29466,7 @@ type GridListeners = {
|
|
|
29456
29466
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
29457
29467
|
* @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
29468
|
*/
|
|
29459
|
-
beforeCellRangeDelete?: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
29469
|
+
beforeCellRangeDelete?: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void)|string
|
|
29460
29470
|
/**
|
|
29461
29471
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
29462
29472
|
* @param {object} event Event object
|
|
@@ -29464,7 +29474,7 @@ type GridListeners = {
|
|
|
29464
29474
|
* @param {string} event.field The field being changed
|
|
29465
29475
|
* @param {any} event.value The value being set
|
|
29466
29476
|
*/
|
|
29467
|
-
beforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) =>
|
|
29477
|
+
beforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => boolean|void)|string
|
|
29468
29478
|
/**
|
|
29469
29479
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
29470
29480
|
* @param {object} event Event object
|
|
@@ -29480,7 +29490,7 @@ type GridListeners = {
|
|
|
29480
29490
|
* @param {Grid.column.Column} event.column The dragged column.
|
|
29481
29491
|
* @param {Event} event.event The browser event.
|
|
29482
29492
|
*/
|
|
29483
|
-
beforeColumnDragStart?: ((event: { source: Grid, column: Column, event: Event }) =>
|
|
29493
|
+
beforeColumnDragStart?: ((event: { source: Grid, column: Column, event: Event }) => boolean|void)|string
|
|
29484
29494
|
/**
|
|
29485
29495
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
29486
29496
|
* @param {object} event Event object
|
|
@@ -29491,7 +29501,7 @@ type GridListeners = {
|
|
|
29491
29501
|
* @param {Event} event.event The browser event.
|
|
29492
29502
|
* @param {string} event.region The region where the column was dropped.
|
|
29493
29503
|
*/
|
|
29494
|
-
beforeColumnDropFinalize?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
29504
|
+
beforeColumnDropFinalize?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void)|string
|
|
29495
29505
|
/**
|
|
29496
29506
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
29497
29507
|
* `false`.
|
|
@@ -29500,7 +29510,7 @@ type GridListeners = {
|
|
|
29500
29510
|
* @param {Grid.column.Column} event.column The column
|
|
29501
29511
|
* @param {Event} event.domEvent The browser event
|
|
29502
29512
|
*/
|
|
29503
|
-
beforeColumnResize?: ((event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
29513
|
+
beforeColumnResize?: ((event: { source: Grid, column: Column, domEvent: Event }) => boolean|void)|string
|
|
29504
29514
|
/**
|
|
29505
29515
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
29506
29516
|
* @param {object} event Event object
|
|
@@ -29524,14 +29534,14 @@ type GridListeners = {
|
|
|
29524
29534
|
* @param {XLSColumn[]} event.columns An array of columns to export
|
|
29525
29535
|
* @param {any[][]} event.rows An array of records to export
|
|
29526
29536
|
*/
|
|
29527
|
-
beforeExcelExport?: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
29537
|
+
beforeExcelExport?: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void)|string
|
|
29528
29538
|
/**
|
|
29529
29539
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
29530
29540
|
* @param {object} event Event object
|
|
29531
29541
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
29532
29542
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
29533
29543
|
*/
|
|
29534
|
-
beforeFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
29544
|
+
beforeFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
29535
29545
|
/**
|
|
29536
29546
|
* 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
29547
|
* @param {object} event Event object
|
|
@@ -29552,7 +29562,7 @@ type GridListeners = {
|
|
|
29552
29562
|
* @param {object} event Event object
|
|
29553
29563
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
29554
29564
|
*/
|
|
29555
|
-
beforeHide?: ((event: { source: Widget }) =>
|
|
29565
|
+
beforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
29556
29566
|
/**
|
|
29557
29567
|
* Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
|
|
29558
29568
|
* @param {object} event Event object
|
|
@@ -29568,7 +29578,7 @@ type GridListeners = {
|
|
|
29568
29578
|
* @param {object} event Event object
|
|
29569
29579
|
* @param {PdfExportConfig} event.config Export config
|
|
29570
29580
|
*/
|
|
29571
|
-
beforePdfExport?: ((event: { config: PdfExportConfig }) =>
|
|
29581
|
+
beforePdfExport?: ((event: { config: PdfExportConfig }) => boolean|void)|string
|
|
29572
29582
|
/**
|
|
29573
29583
|
* Fires before a row is rendered.
|
|
29574
29584
|
* @param {object} event Event object
|
|
@@ -29611,7 +29621,7 @@ type GridListeners = {
|
|
|
29611
29621
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
29612
29622
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
29613
29623
|
*/
|
|
29614
|
-
beforeSelectionChange?: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
29624
|
+
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
29625
|
/**
|
|
29616
29626
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
29617
29627
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -29632,19 +29642,19 @@ type GridListeners = {
|
|
|
29632
29642
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
29633
29643
|
* @param {RowEditorContext} event.editorContext Editing context
|
|
29634
29644
|
*/
|
|
29635
|
-
beforeStartRowEdit?: ((event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
29645
|
+
beforeStartRowEdit?: ((event: { source: Grid, editorContext: RowEditorContext }) => boolean|void)|string
|
|
29636
29646
|
/**
|
|
29637
29647
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
29638
29648
|
* @param {object} event Event object
|
|
29639
29649
|
* @param {GridStateInfo} event.state State object config
|
|
29640
29650
|
*/
|
|
29641
|
-
beforeStateApply?: ((event: { state: GridStateInfo }) =>
|
|
29651
|
+
beforeStateApply?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
29642
29652
|
/**
|
|
29643
29653
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
29644
29654
|
* @param {object} event Event object
|
|
29645
29655
|
* @param {GridStateInfo} event.state State object config
|
|
29646
29656
|
*/
|
|
29647
|
-
beforeStateSave?: ((event: { state: GridStateInfo }) =>
|
|
29657
|
+
beforeStateSave?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
29648
29658
|
/**
|
|
29649
29659
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
29650
29660
|
* Returning `false` from a listener prevents the operation
|
|
@@ -29654,7 +29664,7 @@ type GridListeners = {
|
|
|
29654
29664
|
* @param {boolean} event.collapse Collapsed (true) or expanded (false)
|
|
29655
29665
|
* @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
29656
29666
|
*/
|
|
29657
|
-
beforeToggleGroup?: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
29667
|
+
beforeToggleGroup?: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void)|string
|
|
29658
29668
|
/**
|
|
29659
29669
|
* Fired before a parent node record toggles its collapsed state.
|
|
29660
29670
|
* @param {object} event Event object
|
|
@@ -29723,7 +29733,7 @@ type GridListeners = {
|
|
|
29723
29733
|
* @param {Grid.column.Column} event.column Column
|
|
29724
29734
|
* @param {Core.data.Model} event.record Record
|
|
29725
29735
|
*/
|
|
29726
|
-
cellMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
29736
|
+
cellMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void)|string
|
|
29727
29737
|
/**
|
|
29728
29738
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
29729
29739
|
* @param {object} event Event object
|
|
@@ -29850,7 +29860,7 @@ type GridListeners = {
|
|
|
29850
29860
|
* @param {Event} event.event The browser event.
|
|
29851
29861
|
* @param {string} event.region The region where the column was dropped.
|
|
29852
29862
|
*/
|
|
29853
|
-
columnDrop?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
29863
|
+
columnDrop?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void)|string
|
|
29854
29864
|
/**
|
|
29855
29865
|
* This event is fired after a resize gesture is completed.
|
|
29856
29866
|
* @param {object} event Event object
|
|
@@ -29990,7 +30000,7 @@ type GridListeners = {
|
|
|
29990
30000
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
29991
30001
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
29992
30002
|
*/
|
|
29993
|
-
fillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
30003
|
+
fillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
29994
30004
|
/**
|
|
29995
30005
|
* Fires on the owning Grid when cell editing is finished
|
|
29996
30006
|
* @param {object} event Event object
|
|
@@ -30038,7 +30048,7 @@ type GridListeners = {
|
|
|
30038
30048
|
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
30039
30049
|
* @param {MouseEvent,TouchEvent} event.event
|
|
30040
30050
|
*/
|
|
30041
|
-
gridRowBeforeDragStart?: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
30051
|
+
gridRowBeforeDragStart?: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void)|string
|
|
30042
30052
|
/**
|
|
30043
30053
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
30044
30054
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
@@ -30105,7 +30115,7 @@ type GridListeners = {
|
|
|
30105
30115
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
30106
30116
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
30107
30117
|
*/
|
|
30108
|
-
headerClick?: ((event: { domEvent: Event, column: Column }) =>
|
|
30118
|
+
headerClick?: ((event: { domEvent: Event, column: Column }) => boolean|void)|string
|
|
30109
30119
|
/**
|
|
30110
30120
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
30111
30121
|
* 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 +30126,7 @@ type GridListeners = {
|
|
|
30116
30126
|
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
30117
30127
|
* @param {Grid.column.Column} event.column Column
|
|
30118
30128
|
*/
|
|
30119
|
-
headerMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
30129
|
+
headerMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void)|string
|
|
30120
30130
|
/**
|
|
30121
30131
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
30122
30132
|
* @param {object} event Event object
|
|
@@ -30327,7 +30337,7 @@ type GridListeners = {
|
|
|
30327
30337
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
30328
30338
|
* @param {Event} event.domEvent The native DOM event
|
|
30329
30339
|
*/
|
|
30330
|
-
splitterCollapseClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
30340
|
+
splitterCollapseClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
30331
30341
|
/**
|
|
30332
30342
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
30333
30343
|
* @param {object} event Event object
|
|
@@ -30352,7 +30362,7 @@ type GridListeners = {
|
|
|
30352
30362
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
30353
30363
|
* @param {Event} event.domEvent The native DOM event
|
|
30354
30364
|
*/
|
|
30355
|
-
splitterExpandClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
30365
|
+
splitterExpandClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
30356
30366
|
/**
|
|
30357
30367
|
* Fires on the owning Grid when editing starts
|
|
30358
30368
|
* @param {object} event Event object
|
|
@@ -30550,6 +30560,8 @@ type GridConfig = {
|
|
|
30550
30560
|
/**
|
|
30551
30561
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
30552
30562
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
30563
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
30564
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#config-appendTo)
|
|
30553
30565
|
*/
|
|
30554
30566
|
appendTo?: HTMLElement|string
|
|
30555
30567
|
/**
|
|
@@ -30864,10 +30876,14 @@ type GridConfig = {
|
|
|
30864
30876
|
inputFieldAlign?: 'start'|'end'
|
|
30865
30877
|
/**
|
|
30866
30878
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
30879
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
30880
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#config-insertBefore)
|
|
30867
30881
|
*/
|
|
30868
30882
|
insertBefore?: HTMLElement|string
|
|
30869
30883
|
/**
|
|
30870
30884
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
30885
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
30886
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#config-insertFirst)
|
|
30871
30887
|
*/
|
|
30872
30888
|
insertFirst?: HTMLElement|string
|
|
30873
30889
|
/**
|
|
@@ -31236,14 +31252,14 @@ type GridConfig = {
|
|
|
31236
31252
|
* @param {string} event.lineDelimiter The CSV delimiter to separate lines
|
|
31237
31253
|
* @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
|
|
31238
31254
|
*/
|
|
31239
|
-
onBeforeCSVExport?: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
31255
|
+
onBeforeCSVExport?: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void)|string
|
|
31240
31256
|
/**
|
|
31241
31257
|
* Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
|
|
31242
31258
|
* @param {object} event Event object
|
|
31243
31259
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
31244
31260
|
* @param {Grid.util.GridLocation} event.editorContext Editing context
|
|
31245
31261
|
*/
|
|
31246
|
-
onBeforeCancelCellEdit?: ((event: { source: Grid, editorContext: GridLocation }) =>
|
|
31262
|
+
onBeforeCancelCellEdit?: ((event: { source: Grid, editorContext: GridLocation }) => boolean|void)|string
|
|
31247
31263
|
/**
|
|
31248
31264
|
* 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
31265
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-beforeCancelRowEdit)
|
|
@@ -31258,7 +31274,7 @@ type GridConfig = {
|
|
|
31258
31274
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
31259
31275
|
* @param {CellEditorContext} event.editorContext Editing context
|
|
31260
31276
|
*/
|
|
31261
|
-
onBeforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
31277
|
+
onBeforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => boolean|void)|string
|
|
31262
31278
|
/**
|
|
31263
31279
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
31264
31280
|
* 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 +31282,7 @@ type GridConfig = {
|
|
|
31266
31282
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
31267
31283
|
* @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
31284
|
*/
|
|
31269
|
-
onBeforeCellRangeDelete?: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
31285
|
+
onBeforeCellRangeDelete?: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void)|string
|
|
31270
31286
|
/**
|
|
31271
31287
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
31272
31288
|
* @param {object} event Event object
|
|
@@ -31274,7 +31290,7 @@ type GridConfig = {
|
|
|
31274
31290
|
* @param {string} event.field The field being changed
|
|
31275
31291
|
* @param {any} event.value The value being set
|
|
31276
31292
|
*/
|
|
31277
|
-
onBeforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) =>
|
|
31293
|
+
onBeforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => boolean|void)|string
|
|
31278
31294
|
/**
|
|
31279
31295
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
31280
31296
|
* @param {object} event Event object
|
|
@@ -31290,7 +31306,7 @@ type GridConfig = {
|
|
|
31290
31306
|
* @param {Grid.column.Column} event.column The dragged column.
|
|
31291
31307
|
* @param {Event} event.event The browser event.
|
|
31292
31308
|
*/
|
|
31293
|
-
onBeforeColumnDragStart?: ((event: { source: Grid, column: Column, event: Event }) =>
|
|
31309
|
+
onBeforeColumnDragStart?: ((event: { source: Grid, column: Column, event: Event }) => boolean|void)|string
|
|
31294
31310
|
/**
|
|
31295
31311
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
31296
31312
|
* @param {object} event Event object
|
|
@@ -31301,7 +31317,7 @@ type GridConfig = {
|
|
|
31301
31317
|
* @param {Event} event.event The browser event.
|
|
31302
31318
|
* @param {string} event.region The region where the column was dropped.
|
|
31303
31319
|
*/
|
|
31304
|
-
onBeforeColumnDropFinalize?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
31320
|
+
onBeforeColumnDropFinalize?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void)|string
|
|
31305
31321
|
/**
|
|
31306
31322
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
31307
31323
|
* `false`.
|
|
@@ -31310,7 +31326,7 @@ type GridConfig = {
|
|
|
31310
31326
|
* @param {Grid.column.Column} event.column The column
|
|
31311
31327
|
* @param {Event} event.domEvent The browser event
|
|
31312
31328
|
*/
|
|
31313
|
-
onBeforeColumnResize?: ((event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
31329
|
+
onBeforeColumnResize?: ((event: { source: Grid, column: Column, domEvent: Event }) => boolean|void)|string
|
|
31314
31330
|
/**
|
|
31315
31331
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
31316
31332
|
* @param {object} event Event object
|
|
@@ -31334,14 +31350,14 @@ type GridConfig = {
|
|
|
31334
31350
|
* @param {XLSColumn[]} event.columns An array of columns to export
|
|
31335
31351
|
* @param {any[][]} event.rows An array of records to export
|
|
31336
31352
|
*/
|
|
31337
|
-
onBeforeExcelExport?: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
31353
|
+
onBeforeExcelExport?: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void)|string
|
|
31338
31354
|
/**
|
|
31339
31355
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
31340
31356
|
* @param {object} event Event object
|
|
31341
31357
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
31342
31358
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
31343
31359
|
*/
|
|
31344
|
-
onBeforeFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
31360
|
+
onBeforeFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
31345
31361
|
/**
|
|
31346
31362
|
* 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
31363
|
* @param {object} event Event object
|
|
@@ -31362,7 +31378,7 @@ type GridConfig = {
|
|
|
31362
31378
|
* @param {object} event Event object
|
|
31363
31379
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
31364
31380
|
*/
|
|
31365
|
-
onBeforeHide?: ((event: { source: Widget }) =>
|
|
31381
|
+
onBeforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
31366
31382
|
/**
|
|
31367
31383
|
* Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
|
|
31368
31384
|
* @param {object} event Event object
|
|
@@ -31378,7 +31394,7 @@ type GridConfig = {
|
|
|
31378
31394
|
* @param {object} event Event object
|
|
31379
31395
|
* @param {PdfExportConfig} event.config Export config
|
|
31380
31396
|
*/
|
|
31381
|
-
onBeforePdfExport?: ((event: { config: PdfExportConfig }) =>
|
|
31397
|
+
onBeforePdfExport?: ((event: { config: PdfExportConfig }) => boolean|void)|string
|
|
31382
31398
|
/**
|
|
31383
31399
|
* Fires before a row is rendered.
|
|
31384
31400
|
* @param {object} event Event object
|
|
@@ -31421,7 +31437,7 @@ type GridConfig = {
|
|
|
31421
31437
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
31422
31438
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
31423
31439
|
*/
|
|
31424
|
-
onBeforeSelectionChange?: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
31440
|
+
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
31441
|
/**
|
|
31426
31442
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
31427
31443
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -31442,19 +31458,19 @@ type GridConfig = {
|
|
|
31442
31458
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
31443
31459
|
* @param {RowEditorContext} event.editorContext Editing context
|
|
31444
31460
|
*/
|
|
31445
|
-
onBeforeStartRowEdit?: ((event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
31461
|
+
onBeforeStartRowEdit?: ((event: { source: Grid, editorContext: RowEditorContext }) => boolean|void)|string
|
|
31446
31462
|
/**
|
|
31447
31463
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
31448
31464
|
* @param {object} event Event object
|
|
31449
31465
|
* @param {GridStateInfo} event.state State object config
|
|
31450
31466
|
*/
|
|
31451
|
-
onBeforeStateApply?: ((event: { state: GridStateInfo }) =>
|
|
31467
|
+
onBeforeStateApply?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
31452
31468
|
/**
|
|
31453
31469
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
31454
31470
|
* @param {object} event Event object
|
|
31455
31471
|
* @param {GridStateInfo} event.state State object config
|
|
31456
31472
|
*/
|
|
31457
|
-
onBeforeStateSave?: ((event: { state: GridStateInfo }) =>
|
|
31473
|
+
onBeforeStateSave?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
31458
31474
|
/**
|
|
31459
31475
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
31460
31476
|
* Returning `false` from a listener prevents the operation
|
|
@@ -31464,7 +31480,7 @@ type GridConfig = {
|
|
|
31464
31480
|
* @param {boolean} event.collapse Collapsed (true) or expanded (false)
|
|
31465
31481
|
* @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
31466
31482
|
*/
|
|
31467
|
-
onBeforeToggleGroup?: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
31483
|
+
onBeforeToggleGroup?: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void)|string
|
|
31468
31484
|
/**
|
|
31469
31485
|
* Fired before a parent node record toggles its collapsed state.
|
|
31470
31486
|
* @param {object} event Event object
|
|
@@ -31533,7 +31549,7 @@ type GridConfig = {
|
|
|
31533
31549
|
* @param {Grid.column.Column} event.column Column
|
|
31534
31550
|
* @param {Core.data.Model} event.record Record
|
|
31535
31551
|
*/
|
|
31536
|
-
onCellMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
31552
|
+
onCellMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void)|string
|
|
31537
31553
|
/**
|
|
31538
31554
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
31539
31555
|
* @param {object} event Event object
|
|
@@ -31660,7 +31676,7 @@ type GridConfig = {
|
|
|
31660
31676
|
* @param {Event} event.event The browser event.
|
|
31661
31677
|
* @param {string} event.region The region where the column was dropped.
|
|
31662
31678
|
*/
|
|
31663
|
-
onColumnDrop?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
31679
|
+
onColumnDrop?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void)|string
|
|
31664
31680
|
/**
|
|
31665
31681
|
* This event is fired after a resize gesture is completed.
|
|
31666
31682
|
* @param {object} event Event object
|
|
@@ -31800,7 +31816,7 @@ type GridConfig = {
|
|
|
31800
31816
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
31801
31817
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
31802
31818
|
*/
|
|
31803
|
-
onFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
31819
|
+
onFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
31804
31820
|
/**
|
|
31805
31821
|
* Fires on the owning Grid when cell editing is finished
|
|
31806
31822
|
* @param {object} event Event object
|
|
@@ -31848,7 +31864,7 @@ type GridConfig = {
|
|
|
31848
31864
|
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
31849
31865
|
* @param {MouseEvent,TouchEvent} event.event
|
|
31850
31866
|
*/
|
|
31851
|
-
onGridRowBeforeDragStart?: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
31867
|
+
onGridRowBeforeDragStart?: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void)|string
|
|
31852
31868
|
/**
|
|
31853
31869
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
31854
31870
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
@@ -31915,7 +31931,7 @@ type GridConfig = {
|
|
|
31915
31931
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
31916
31932
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
31917
31933
|
*/
|
|
31918
|
-
onHeaderClick?: ((event: { domEvent: Event, column: Column }) =>
|
|
31934
|
+
onHeaderClick?: ((event: { domEvent: Event, column: Column }) => boolean|void)|string
|
|
31919
31935
|
/**
|
|
31920
31936
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
31921
31937
|
* 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 +31942,7 @@ type GridConfig = {
|
|
|
31926
31942
|
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
31927
31943
|
* @param {Grid.column.Column} event.column Column
|
|
31928
31944
|
*/
|
|
31929
|
-
onHeaderMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
31945
|
+
onHeaderMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void)|string
|
|
31930
31946
|
/**
|
|
31931
31947
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
31932
31948
|
* @param {object} event Event object
|
|
@@ -32137,7 +32153,7 @@ type GridConfig = {
|
|
|
32137
32153
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
32138
32154
|
* @param {Event} event.domEvent The native DOM event
|
|
32139
32155
|
*/
|
|
32140
|
-
onSplitterCollapseClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
32156
|
+
onSplitterCollapseClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
32141
32157
|
/**
|
|
32142
32158
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
32143
32159
|
* @param {object} event Event object
|
|
@@ -32162,7 +32178,7 @@ type GridConfig = {
|
|
|
32162
32178
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
32163
32179
|
* @param {Event} event.domEvent The native DOM event
|
|
32164
32180
|
*/
|
|
32165
|
-
onSplitterExpandClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
32181
|
+
onSplitterExpandClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
32166
32182
|
/**
|
|
32167
32183
|
* Fires on the owning Grid when editing starts
|
|
32168
32184
|
* @param {object} event Event object
|
|
@@ -32271,19 +32287,19 @@ export class Grid extends GridBase {
|
|
|
32271
32287
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
32272
32288
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
32273
32289
|
*/
|
|
32274
|
-
onBeforeSelectionChange: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
32290
|
+
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
32291
|
/**
|
|
32276
32292
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
32277
32293
|
* @param {object} event Event object
|
|
32278
32294
|
* @param {GridStateInfo} event.state State object config
|
|
32279
32295
|
*/
|
|
32280
|
-
onBeforeStateApply: ((event: { state: GridStateInfo }) =>
|
|
32296
|
+
onBeforeStateApply: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
32281
32297
|
/**
|
|
32282
32298
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
32283
32299
|
* @param {object} event Event object
|
|
32284
32300
|
* @param {GridStateInfo} event.state State object config
|
|
32285
32301
|
*/
|
|
32286
|
-
onBeforeStateSave: ((event: { state: GridStateInfo }) =>
|
|
32302
|
+
onBeforeStateSave: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
32287
32303
|
/**
|
|
32288
32304
|
* Fires when any other event is fired from the object.
|
|
32289
32305
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-catchAll)
|
|
@@ -32389,7 +32405,7 @@ export class Grid extends GridBase {
|
|
|
32389
32405
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
32390
32406
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
32391
32407
|
*/
|
|
32392
|
-
onHeaderClick: ((event: { domEvent: Event, column: Column }) =>
|
|
32408
|
+
onHeaderClick: ((event: { domEvent: Event, column: Column }) => boolean|void)|string
|
|
32393
32409
|
/**
|
|
32394
32410
|
* Mouse moved out from element in grid
|
|
32395
32411
|
* @param {object} event Event object
|
|
@@ -32467,14 +32483,14 @@ type GridBaseListenersTypes = {
|
|
|
32467
32483
|
* @param {string} event.lineDelimiter The CSV delimiter to separate lines
|
|
32468
32484
|
* @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
|
|
32469
32485
|
*/
|
|
32470
|
-
beforeCSVExport: (event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
32486
|
+
beforeCSVExport: (event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void
|
|
32471
32487
|
/**
|
|
32472
32488
|
* Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
|
|
32473
32489
|
* @param {object} event Event object
|
|
32474
32490
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
32475
32491
|
* @param {Grid.util.GridLocation} event.editorContext Editing context
|
|
32476
32492
|
*/
|
|
32477
|
-
beforeCancelCellEdit: (event: { source: Grid, editorContext: GridLocation }) =>
|
|
32493
|
+
beforeCancelCellEdit: (event: { source: Grid, editorContext: GridLocation }) => boolean|void
|
|
32478
32494
|
/**
|
|
32479
32495
|
* 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
32496
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-beforeCancelRowEdit)
|
|
@@ -32489,7 +32505,7 @@ type GridBaseListenersTypes = {
|
|
|
32489
32505
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
32490
32506
|
* @param {CellEditorContext} event.editorContext Editing context
|
|
32491
32507
|
*/
|
|
32492
|
-
beforeCellEditStart: (event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
32508
|
+
beforeCellEditStart: (event: { source: Grid, editorContext: CellEditorContext }) => boolean|void
|
|
32493
32509
|
/**
|
|
32494
32510
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
32495
32511
|
* 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 +32513,7 @@ type GridBaseListenersTypes = {
|
|
|
32497
32513
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
32498
32514
|
* @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
32515
|
*/
|
|
32500
|
-
beforeCellRangeDelete: (event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
32516
|
+
beforeCellRangeDelete: (event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void
|
|
32501
32517
|
/**
|
|
32502
32518
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
32503
32519
|
* @param {object} event Event object
|
|
@@ -32505,7 +32521,7 @@ type GridBaseListenersTypes = {
|
|
|
32505
32521
|
* @param {string} event.field The field being changed
|
|
32506
32522
|
* @param {any} event.value The value being set
|
|
32507
32523
|
*/
|
|
32508
|
-
beforeCellRangeEdit: (event: { record: Model, field: string, value: any }) =>
|
|
32524
|
+
beforeCellRangeEdit: (event: { record: Model, field: string, value: any }) => boolean|void
|
|
32509
32525
|
/**
|
|
32510
32526
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
32511
32527
|
* @param {object} event Event object
|
|
@@ -32521,7 +32537,7 @@ type GridBaseListenersTypes = {
|
|
|
32521
32537
|
* @param {Grid.column.Column} event.column The dragged column.
|
|
32522
32538
|
* @param {Event} event.event The browser event.
|
|
32523
32539
|
*/
|
|
32524
|
-
beforeColumnDragStart: (event: { source: Grid, column: Column, event: Event }) =>
|
|
32540
|
+
beforeColumnDragStart: (event: { source: Grid, column: Column, event: Event }) => boolean|void
|
|
32525
32541
|
/**
|
|
32526
32542
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
32527
32543
|
* @param {object} event Event object
|
|
@@ -32532,7 +32548,7 @@ type GridBaseListenersTypes = {
|
|
|
32532
32548
|
* @param {Event} event.event The browser event.
|
|
32533
32549
|
* @param {string} event.region The region where the column was dropped.
|
|
32534
32550
|
*/
|
|
32535
|
-
beforeColumnDropFinalize: (event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
32551
|
+
beforeColumnDropFinalize: (event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void
|
|
32536
32552
|
/**
|
|
32537
32553
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
32538
32554
|
* `false`.
|
|
@@ -32541,7 +32557,7 @@ type GridBaseListenersTypes = {
|
|
|
32541
32557
|
* @param {Grid.column.Column} event.column The column
|
|
32542
32558
|
* @param {Event} event.domEvent The browser event
|
|
32543
32559
|
*/
|
|
32544
|
-
beforeColumnResize: (event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
32560
|
+
beforeColumnResize: (event: { source: Grid, column: Column, domEvent: Event }) => boolean|void
|
|
32545
32561
|
/**
|
|
32546
32562
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
32547
32563
|
* @param {object} event Event object
|
|
@@ -32565,14 +32581,14 @@ type GridBaseListenersTypes = {
|
|
|
32565
32581
|
* @param {XLSColumn[]} event.columns An array of columns to export
|
|
32566
32582
|
* @param {any[][]} event.rows An array of records to export
|
|
32567
32583
|
*/
|
|
32568
|
-
beforeExcelExport: (event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
32584
|
+
beforeExcelExport: (event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void
|
|
32569
32585
|
/**
|
|
32570
32586
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
32571
32587
|
* @param {object} event Event object
|
|
32572
32588
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
32573
32589
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
32574
32590
|
*/
|
|
32575
|
-
beforeFillHandleDragStart: (event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
32591
|
+
beforeFillHandleDragStart: (event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void
|
|
32576
32592
|
/**
|
|
32577
32593
|
* 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
32594
|
* @param {object} event Event object
|
|
@@ -32593,7 +32609,7 @@ type GridBaseListenersTypes = {
|
|
|
32593
32609
|
* @param {object} event Event object
|
|
32594
32610
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
32595
32611
|
*/
|
|
32596
|
-
beforeHide: (event: { source: Widget }) =>
|
|
32612
|
+
beforeHide: (event: { source: Widget }) => boolean|void
|
|
32597
32613
|
/**
|
|
32598
32614
|
* Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
|
|
32599
32615
|
* @param {object} event Event object
|
|
@@ -32609,7 +32625,7 @@ type GridBaseListenersTypes = {
|
|
|
32609
32625
|
* @param {object} event Event object
|
|
32610
32626
|
* @param {PdfExportConfig} event.config Export config
|
|
32611
32627
|
*/
|
|
32612
|
-
beforePdfExport: (event: { config: PdfExportConfig }) =>
|
|
32628
|
+
beforePdfExport: (event: { config: PdfExportConfig }) => boolean|void
|
|
32613
32629
|
/**
|
|
32614
32630
|
* Fires before a row is rendered.
|
|
32615
32631
|
* @param {object} event Event object
|
|
@@ -32652,7 +32668,7 @@ type GridBaseListenersTypes = {
|
|
|
32652
32668
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
32653
32669
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
32654
32670
|
*/
|
|
32655
|
-
beforeSelectionChange: (event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
32671
|
+
beforeSelectionChange: (event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => boolean|void
|
|
32656
32672
|
/**
|
|
32657
32673
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
32658
32674
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -32673,19 +32689,19 @@ type GridBaseListenersTypes = {
|
|
|
32673
32689
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
32674
32690
|
* @param {RowEditorContext} event.editorContext Editing context
|
|
32675
32691
|
*/
|
|
32676
|
-
beforeStartRowEdit: (event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
32692
|
+
beforeStartRowEdit: (event: { source: Grid, editorContext: RowEditorContext }) => boolean|void
|
|
32677
32693
|
/**
|
|
32678
32694
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
32679
32695
|
* @param {object} event Event object
|
|
32680
32696
|
* @param {GridStateInfo} event.state State object config
|
|
32681
32697
|
*/
|
|
32682
|
-
beforeStateApply: (event: { state: GridStateInfo }) =>
|
|
32698
|
+
beforeStateApply: (event: { state: GridStateInfo }) => boolean|void
|
|
32683
32699
|
/**
|
|
32684
32700
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
32685
32701
|
* @param {object} event Event object
|
|
32686
32702
|
* @param {GridStateInfo} event.state State object config
|
|
32687
32703
|
*/
|
|
32688
|
-
beforeStateSave: (event: { state: GridStateInfo }) =>
|
|
32704
|
+
beforeStateSave: (event: { state: GridStateInfo }) => boolean|void
|
|
32689
32705
|
/**
|
|
32690
32706
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
32691
32707
|
* Returning `false` from a listener prevents the operation
|
|
@@ -32695,7 +32711,7 @@ type GridBaseListenersTypes = {
|
|
|
32695
32711
|
* @param {boolean} event.collapse Collapsed (true) or expanded (false)
|
|
32696
32712
|
* @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
32697
32713
|
*/
|
|
32698
|
-
beforeToggleGroup: (event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
32714
|
+
beforeToggleGroup: (event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void
|
|
32699
32715
|
/**
|
|
32700
32716
|
* Fired before a parent node record toggles its collapsed state.
|
|
32701
32717
|
* @param {object} event Event object
|
|
@@ -32764,7 +32780,7 @@ type GridBaseListenersTypes = {
|
|
|
32764
32780
|
* @param {Grid.column.Column} event.column Column
|
|
32765
32781
|
* @param {Core.data.Model} event.record Record
|
|
32766
32782
|
*/
|
|
32767
|
-
cellMenuBeforeShow: (event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
32783
|
+
cellMenuBeforeShow: (event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void
|
|
32768
32784
|
/**
|
|
32769
32785
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
32770
32786
|
* @param {object} event Event object
|
|
@@ -32891,7 +32907,7 @@ type GridBaseListenersTypes = {
|
|
|
32891
32907
|
* @param {Event} event.event The browser event.
|
|
32892
32908
|
* @param {string} event.region The region where the column was dropped.
|
|
32893
32909
|
*/
|
|
32894
|
-
columnDrop: (event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
32910
|
+
columnDrop: (event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void
|
|
32895
32911
|
/**
|
|
32896
32912
|
* This event is fired after a resize gesture is completed.
|
|
32897
32913
|
* @param {object} event Event object
|
|
@@ -33031,7 +33047,7 @@ type GridBaseListenersTypes = {
|
|
|
33031
33047
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
33032
33048
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
33033
33049
|
*/
|
|
33034
|
-
fillHandleDragStart: (event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
33050
|
+
fillHandleDragStart: (event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void
|
|
33035
33051
|
/**
|
|
33036
33052
|
* Fires on the owning Grid when cell editing is finished
|
|
33037
33053
|
* @param {object} event Event object
|
|
@@ -33079,7 +33095,7 @@ type GridBaseListenersTypes = {
|
|
|
33079
33095
|
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
33080
33096
|
* @param {MouseEvent,TouchEvent} event.event
|
|
33081
33097
|
*/
|
|
33082
|
-
gridRowBeforeDragStart: (event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
33098
|
+
gridRowBeforeDragStart: (event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void
|
|
33083
33099
|
/**
|
|
33084
33100
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
33085
33101
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
@@ -33146,7 +33162,7 @@ type GridBaseListenersTypes = {
|
|
|
33146
33162
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
33147
33163
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
33148
33164
|
*/
|
|
33149
|
-
headerClick: (event: { domEvent: Event, column: Column }) =>
|
|
33165
|
+
headerClick: (event: { domEvent: Event, column: Column }) => boolean|void
|
|
33150
33166
|
/**
|
|
33151
33167
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
33152
33168
|
* 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 +33173,7 @@ type GridBaseListenersTypes = {
|
|
|
33157
33173
|
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
33158
33174
|
* @param {Grid.column.Column} event.column Column
|
|
33159
33175
|
*/
|
|
33160
|
-
headerMenuBeforeShow: (event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
33176
|
+
headerMenuBeforeShow: (event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void
|
|
33161
33177
|
/**
|
|
33162
33178
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
33163
33179
|
* @param {object} event Event object
|
|
@@ -33368,7 +33384,7 @@ type GridBaseListenersTypes = {
|
|
|
33368
33384
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
33369
33385
|
* @param {Event} event.domEvent The native DOM event
|
|
33370
33386
|
*/
|
|
33371
|
-
splitterCollapseClick: (event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
33387
|
+
splitterCollapseClick: (event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void
|
|
33372
33388
|
/**
|
|
33373
33389
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
33374
33390
|
* @param {object} event Event object
|
|
@@ -33393,7 +33409,7 @@ type GridBaseListenersTypes = {
|
|
|
33393
33409
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
33394
33410
|
* @param {Event} event.domEvent The native DOM event
|
|
33395
33411
|
*/
|
|
33396
|
-
splitterExpandClick: (event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
33412
|
+
splitterExpandClick: (event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void
|
|
33397
33413
|
/**
|
|
33398
33414
|
* Fires on the owning Grid when editing starts
|
|
33399
33415
|
* @param {object} event Event object
|
|
@@ -33482,14 +33498,14 @@ type GridBaseListeners = {
|
|
|
33482
33498
|
* @param {string} event.lineDelimiter The CSV delimiter to separate lines
|
|
33483
33499
|
* @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
|
|
33484
33500
|
*/
|
|
33485
|
-
beforeCSVExport?: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
33501
|
+
beforeCSVExport?: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void)|string
|
|
33486
33502
|
/**
|
|
33487
33503
|
* Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
|
|
33488
33504
|
* @param {object} event Event object
|
|
33489
33505
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
33490
33506
|
* @param {Grid.util.GridLocation} event.editorContext Editing context
|
|
33491
33507
|
*/
|
|
33492
|
-
beforeCancelCellEdit?: ((event: { source: Grid, editorContext: GridLocation }) =>
|
|
33508
|
+
beforeCancelCellEdit?: ((event: { source: Grid, editorContext: GridLocation }) => boolean|void)|string
|
|
33493
33509
|
/**
|
|
33494
33510
|
* 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
33511
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-beforeCancelRowEdit)
|
|
@@ -33504,7 +33520,7 @@ type GridBaseListeners = {
|
|
|
33504
33520
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
33505
33521
|
* @param {CellEditorContext} event.editorContext Editing context
|
|
33506
33522
|
*/
|
|
33507
|
-
beforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
33523
|
+
beforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => boolean|void)|string
|
|
33508
33524
|
/**
|
|
33509
33525
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
33510
33526
|
* 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 +33528,7 @@ type GridBaseListeners = {
|
|
|
33512
33528
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
33513
33529
|
* @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
33530
|
*/
|
|
33515
|
-
beforeCellRangeDelete?: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
33531
|
+
beforeCellRangeDelete?: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void)|string
|
|
33516
33532
|
/**
|
|
33517
33533
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
33518
33534
|
* @param {object} event Event object
|
|
@@ -33520,7 +33536,7 @@ type GridBaseListeners = {
|
|
|
33520
33536
|
* @param {string} event.field The field being changed
|
|
33521
33537
|
* @param {any} event.value The value being set
|
|
33522
33538
|
*/
|
|
33523
|
-
beforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) =>
|
|
33539
|
+
beforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => boolean|void)|string
|
|
33524
33540
|
/**
|
|
33525
33541
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
33526
33542
|
* @param {object} event Event object
|
|
@@ -33536,7 +33552,7 @@ type GridBaseListeners = {
|
|
|
33536
33552
|
* @param {Grid.column.Column} event.column The dragged column.
|
|
33537
33553
|
* @param {Event} event.event The browser event.
|
|
33538
33554
|
*/
|
|
33539
|
-
beforeColumnDragStart?: ((event: { source: Grid, column: Column, event: Event }) =>
|
|
33555
|
+
beforeColumnDragStart?: ((event: { source: Grid, column: Column, event: Event }) => boolean|void)|string
|
|
33540
33556
|
/**
|
|
33541
33557
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
33542
33558
|
* @param {object} event Event object
|
|
@@ -33547,7 +33563,7 @@ type GridBaseListeners = {
|
|
|
33547
33563
|
* @param {Event} event.event The browser event.
|
|
33548
33564
|
* @param {string} event.region The region where the column was dropped.
|
|
33549
33565
|
*/
|
|
33550
|
-
beforeColumnDropFinalize?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
33566
|
+
beforeColumnDropFinalize?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void)|string
|
|
33551
33567
|
/**
|
|
33552
33568
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
33553
33569
|
* `false`.
|
|
@@ -33556,7 +33572,7 @@ type GridBaseListeners = {
|
|
|
33556
33572
|
* @param {Grid.column.Column} event.column The column
|
|
33557
33573
|
* @param {Event} event.domEvent The browser event
|
|
33558
33574
|
*/
|
|
33559
|
-
beforeColumnResize?: ((event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
33575
|
+
beforeColumnResize?: ((event: { source: Grid, column: Column, domEvent: Event }) => boolean|void)|string
|
|
33560
33576
|
/**
|
|
33561
33577
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
33562
33578
|
* @param {object} event Event object
|
|
@@ -33580,14 +33596,14 @@ type GridBaseListeners = {
|
|
|
33580
33596
|
* @param {XLSColumn[]} event.columns An array of columns to export
|
|
33581
33597
|
* @param {any[][]} event.rows An array of records to export
|
|
33582
33598
|
*/
|
|
33583
|
-
beforeExcelExport?: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
33599
|
+
beforeExcelExport?: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void)|string
|
|
33584
33600
|
/**
|
|
33585
33601
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
33586
33602
|
* @param {object} event Event object
|
|
33587
33603
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
33588
33604
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
33589
33605
|
*/
|
|
33590
|
-
beforeFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
33606
|
+
beforeFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
33591
33607
|
/**
|
|
33592
33608
|
* 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
33609
|
* @param {object} event Event object
|
|
@@ -33608,7 +33624,7 @@ type GridBaseListeners = {
|
|
|
33608
33624
|
* @param {object} event Event object
|
|
33609
33625
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
33610
33626
|
*/
|
|
33611
|
-
beforeHide?: ((event: { source: Widget }) =>
|
|
33627
|
+
beforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
33612
33628
|
/**
|
|
33613
33629
|
* Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
|
|
33614
33630
|
* @param {object} event Event object
|
|
@@ -33624,7 +33640,7 @@ type GridBaseListeners = {
|
|
|
33624
33640
|
* @param {object} event Event object
|
|
33625
33641
|
* @param {PdfExportConfig} event.config Export config
|
|
33626
33642
|
*/
|
|
33627
|
-
beforePdfExport?: ((event: { config: PdfExportConfig }) =>
|
|
33643
|
+
beforePdfExport?: ((event: { config: PdfExportConfig }) => boolean|void)|string
|
|
33628
33644
|
/**
|
|
33629
33645
|
* Fires before a row is rendered.
|
|
33630
33646
|
* @param {object} event Event object
|
|
@@ -33667,7 +33683,7 @@ type GridBaseListeners = {
|
|
|
33667
33683
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
33668
33684
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
33669
33685
|
*/
|
|
33670
|
-
beforeSelectionChange?: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
33686
|
+
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
33687
|
/**
|
|
33672
33688
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
33673
33689
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -33688,19 +33704,19 @@ type GridBaseListeners = {
|
|
|
33688
33704
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
33689
33705
|
* @param {RowEditorContext} event.editorContext Editing context
|
|
33690
33706
|
*/
|
|
33691
|
-
beforeStartRowEdit?: ((event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
33707
|
+
beforeStartRowEdit?: ((event: { source: Grid, editorContext: RowEditorContext }) => boolean|void)|string
|
|
33692
33708
|
/**
|
|
33693
33709
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
33694
33710
|
* @param {object} event Event object
|
|
33695
33711
|
* @param {GridStateInfo} event.state State object config
|
|
33696
33712
|
*/
|
|
33697
|
-
beforeStateApply?: ((event: { state: GridStateInfo }) =>
|
|
33713
|
+
beforeStateApply?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
33698
33714
|
/**
|
|
33699
33715
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
33700
33716
|
* @param {object} event Event object
|
|
33701
33717
|
* @param {GridStateInfo} event.state State object config
|
|
33702
33718
|
*/
|
|
33703
|
-
beforeStateSave?: ((event: { state: GridStateInfo }) =>
|
|
33719
|
+
beforeStateSave?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
33704
33720
|
/**
|
|
33705
33721
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
33706
33722
|
* Returning `false` from a listener prevents the operation
|
|
@@ -33710,7 +33726,7 @@ type GridBaseListeners = {
|
|
|
33710
33726
|
* @param {boolean} event.collapse Collapsed (true) or expanded (false)
|
|
33711
33727
|
* @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
33712
33728
|
*/
|
|
33713
|
-
beforeToggleGroup?: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
33729
|
+
beforeToggleGroup?: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void)|string
|
|
33714
33730
|
/**
|
|
33715
33731
|
* Fired before a parent node record toggles its collapsed state.
|
|
33716
33732
|
* @param {object} event Event object
|
|
@@ -33779,7 +33795,7 @@ type GridBaseListeners = {
|
|
|
33779
33795
|
* @param {Grid.column.Column} event.column Column
|
|
33780
33796
|
* @param {Core.data.Model} event.record Record
|
|
33781
33797
|
*/
|
|
33782
|
-
cellMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
33798
|
+
cellMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void)|string
|
|
33783
33799
|
/**
|
|
33784
33800
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
33785
33801
|
* @param {object} event Event object
|
|
@@ -33906,7 +33922,7 @@ type GridBaseListeners = {
|
|
|
33906
33922
|
* @param {Event} event.event The browser event.
|
|
33907
33923
|
* @param {string} event.region The region where the column was dropped.
|
|
33908
33924
|
*/
|
|
33909
|
-
columnDrop?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
33925
|
+
columnDrop?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void)|string
|
|
33910
33926
|
/**
|
|
33911
33927
|
* This event is fired after a resize gesture is completed.
|
|
33912
33928
|
* @param {object} event Event object
|
|
@@ -34046,7 +34062,7 @@ type GridBaseListeners = {
|
|
|
34046
34062
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
34047
34063
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
34048
34064
|
*/
|
|
34049
|
-
fillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
34065
|
+
fillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
34050
34066
|
/**
|
|
34051
34067
|
* Fires on the owning Grid when cell editing is finished
|
|
34052
34068
|
* @param {object} event Event object
|
|
@@ -34094,7 +34110,7 @@ type GridBaseListeners = {
|
|
|
34094
34110
|
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
34095
34111
|
* @param {MouseEvent,TouchEvent} event.event
|
|
34096
34112
|
*/
|
|
34097
|
-
gridRowBeforeDragStart?: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
34113
|
+
gridRowBeforeDragStart?: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void)|string
|
|
34098
34114
|
/**
|
|
34099
34115
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
34100
34116
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
@@ -34161,7 +34177,7 @@ type GridBaseListeners = {
|
|
|
34161
34177
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
34162
34178
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
34163
34179
|
*/
|
|
34164
|
-
headerClick?: ((event: { domEvent: Event, column: Column }) =>
|
|
34180
|
+
headerClick?: ((event: { domEvent: Event, column: Column }) => boolean|void)|string
|
|
34165
34181
|
/**
|
|
34166
34182
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
34167
34183
|
* 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 +34188,7 @@ type GridBaseListeners = {
|
|
|
34172
34188
|
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
34173
34189
|
* @param {Grid.column.Column} event.column Column
|
|
34174
34190
|
*/
|
|
34175
|
-
headerMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
34191
|
+
headerMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void)|string
|
|
34176
34192
|
/**
|
|
34177
34193
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
34178
34194
|
* @param {object} event Event object
|
|
@@ -34383,7 +34399,7 @@ type GridBaseListeners = {
|
|
|
34383
34399
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
34384
34400
|
* @param {Event} event.domEvent The native DOM event
|
|
34385
34401
|
*/
|
|
34386
|
-
splitterCollapseClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
34402
|
+
splitterCollapseClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
34387
34403
|
/**
|
|
34388
34404
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
34389
34405
|
* @param {object} event Event object
|
|
@@ -34408,7 +34424,7 @@ type GridBaseListeners = {
|
|
|
34408
34424
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
34409
34425
|
* @param {Event} event.domEvent The native DOM event
|
|
34410
34426
|
*/
|
|
34411
|
-
splitterExpandClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
34427
|
+
splitterExpandClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
34412
34428
|
/**
|
|
34413
34429
|
* Fires on the owning Grid when editing starts
|
|
34414
34430
|
* @param {object} event Event object
|
|
@@ -34605,6 +34621,8 @@ type GridBaseConfig = {
|
|
|
34605
34621
|
/**
|
|
34606
34622
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
34607
34623
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
34624
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
34625
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-appendTo)
|
|
34608
34626
|
*/
|
|
34609
34627
|
appendTo?: HTMLElement|string
|
|
34610
34628
|
/**
|
|
@@ -34919,10 +34937,14 @@ type GridBaseConfig = {
|
|
|
34919
34937
|
inputFieldAlign?: 'start'|'end'
|
|
34920
34938
|
/**
|
|
34921
34939
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
34940
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
34941
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-insertBefore)
|
|
34922
34942
|
*/
|
|
34923
34943
|
insertBefore?: HTMLElement|string
|
|
34924
34944
|
/**
|
|
34925
34945
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
34946
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
34947
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-insertFirst)
|
|
34926
34948
|
*/
|
|
34927
34949
|
insertFirst?: HTMLElement|string
|
|
34928
34950
|
/**
|
|
@@ -35291,14 +35313,14 @@ type GridBaseConfig = {
|
|
|
35291
35313
|
* @param {string} event.lineDelimiter The CSV delimiter to separate lines
|
|
35292
35314
|
* @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
|
|
35293
35315
|
*/
|
|
35294
|
-
onBeforeCSVExport?: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
35316
|
+
onBeforeCSVExport?: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void)|string
|
|
35295
35317
|
/**
|
|
35296
35318
|
* Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
|
|
35297
35319
|
* @param {object} event Event object
|
|
35298
35320
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
35299
35321
|
* @param {Grid.util.GridLocation} event.editorContext Editing context
|
|
35300
35322
|
*/
|
|
35301
|
-
onBeforeCancelCellEdit?: ((event: { source: Grid, editorContext: GridLocation }) =>
|
|
35323
|
+
onBeforeCancelCellEdit?: ((event: { source: Grid, editorContext: GridLocation }) => boolean|void)|string
|
|
35302
35324
|
/**
|
|
35303
35325
|
* 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
35326
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-beforeCancelRowEdit)
|
|
@@ -35313,7 +35335,7 @@ type GridBaseConfig = {
|
|
|
35313
35335
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
35314
35336
|
* @param {CellEditorContext} event.editorContext Editing context
|
|
35315
35337
|
*/
|
|
35316
|
-
onBeforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
35338
|
+
onBeforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => boolean|void)|string
|
|
35317
35339
|
/**
|
|
35318
35340
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
35319
35341
|
* 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 +35343,7 @@ type GridBaseConfig = {
|
|
|
35321
35343
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
35322
35344
|
* @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
35345
|
*/
|
|
35324
|
-
onBeforeCellRangeDelete?: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
35346
|
+
onBeforeCellRangeDelete?: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void)|string
|
|
35325
35347
|
/**
|
|
35326
35348
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
35327
35349
|
* @param {object} event Event object
|
|
@@ -35329,7 +35351,7 @@ type GridBaseConfig = {
|
|
|
35329
35351
|
* @param {string} event.field The field being changed
|
|
35330
35352
|
* @param {any} event.value The value being set
|
|
35331
35353
|
*/
|
|
35332
|
-
onBeforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) =>
|
|
35354
|
+
onBeforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => boolean|void)|string
|
|
35333
35355
|
/**
|
|
35334
35356
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
35335
35357
|
* @param {object} event Event object
|
|
@@ -35345,7 +35367,7 @@ type GridBaseConfig = {
|
|
|
35345
35367
|
* @param {Grid.column.Column} event.column The dragged column.
|
|
35346
35368
|
* @param {Event} event.event The browser event.
|
|
35347
35369
|
*/
|
|
35348
|
-
onBeforeColumnDragStart?: ((event: { source: Grid, column: Column, event: Event }) =>
|
|
35370
|
+
onBeforeColumnDragStart?: ((event: { source: Grid, column: Column, event: Event }) => boolean|void)|string
|
|
35349
35371
|
/**
|
|
35350
35372
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
35351
35373
|
* @param {object} event Event object
|
|
@@ -35356,7 +35378,7 @@ type GridBaseConfig = {
|
|
|
35356
35378
|
* @param {Event} event.event The browser event.
|
|
35357
35379
|
* @param {string} event.region The region where the column was dropped.
|
|
35358
35380
|
*/
|
|
35359
|
-
onBeforeColumnDropFinalize?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
35381
|
+
onBeforeColumnDropFinalize?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void)|string
|
|
35360
35382
|
/**
|
|
35361
35383
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
35362
35384
|
* `false`.
|
|
@@ -35365,7 +35387,7 @@ type GridBaseConfig = {
|
|
|
35365
35387
|
* @param {Grid.column.Column} event.column The column
|
|
35366
35388
|
* @param {Event} event.domEvent The browser event
|
|
35367
35389
|
*/
|
|
35368
|
-
onBeforeColumnResize?: ((event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
35390
|
+
onBeforeColumnResize?: ((event: { source: Grid, column: Column, domEvent: Event }) => boolean|void)|string
|
|
35369
35391
|
/**
|
|
35370
35392
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
35371
35393
|
* @param {object} event Event object
|
|
@@ -35389,14 +35411,14 @@ type GridBaseConfig = {
|
|
|
35389
35411
|
* @param {XLSColumn[]} event.columns An array of columns to export
|
|
35390
35412
|
* @param {any[][]} event.rows An array of records to export
|
|
35391
35413
|
*/
|
|
35392
|
-
onBeforeExcelExport?: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
35414
|
+
onBeforeExcelExport?: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void)|string
|
|
35393
35415
|
/**
|
|
35394
35416
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
35395
35417
|
* @param {object} event Event object
|
|
35396
35418
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
35397
35419
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
35398
35420
|
*/
|
|
35399
|
-
onBeforeFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
35421
|
+
onBeforeFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
35400
35422
|
/**
|
|
35401
35423
|
* 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
35424
|
* @param {object} event Event object
|
|
@@ -35417,7 +35439,7 @@ type GridBaseConfig = {
|
|
|
35417
35439
|
* @param {object} event Event object
|
|
35418
35440
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
35419
35441
|
*/
|
|
35420
|
-
onBeforeHide?: ((event: { source: Widget }) =>
|
|
35442
|
+
onBeforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
35421
35443
|
/**
|
|
35422
35444
|
* Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
|
|
35423
35445
|
* @param {object} event Event object
|
|
@@ -35433,7 +35455,7 @@ type GridBaseConfig = {
|
|
|
35433
35455
|
* @param {object} event Event object
|
|
35434
35456
|
* @param {PdfExportConfig} event.config Export config
|
|
35435
35457
|
*/
|
|
35436
|
-
onBeforePdfExport?: ((event: { config: PdfExportConfig }) =>
|
|
35458
|
+
onBeforePdfExport?: ((event: { config: PdfExportConfig }) => boolean|void)|string
|
|
35437
35459
|
/**
|
|
35438
35460
|
* Fires before a row is rendered.
|
|
35439
35461
|
* @param {object} event Event object
|
|
@@ -35476,7 +35498,7 @@ type GridBaseConfig = {
|
|
|
35476
35498
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
35477
35499
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
35478
35500
|
*/
|
|
35479
|
-
onBeforeSelectionChange?: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
35501
|
+
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
35502
|
/**
|
|
35481
35503
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
35482
35504
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -35497,19 +35519,19 @@ type GridBaseConfig = {
|
|
|
35497
35519
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
35498
35520
|
* @param {RowEditorContext} event.editorContext Editing context
|
|
35499
35521
|
*/
|
|
35500
|
-
onBeforeStartRowEdit?: ((event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
35522
|
+
onBeforeStartRowEdit?: ((event: { source: Grid, editorContext: RowEditorContext }) => boolean|void)|string
|
|
35501
35523
|
/**
|
|
35502
35524
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
35503
35525
|
* @param {object} event Event object
|
|
35504
35526
|
* @param {GridStateInfo} event.state State object config
|
|
35505
35527
|
*/
|
|
35506
|
-
onBeforeStateApply?: ((event: { state: GridStateInfo }) =>
|
|
35528
|
+
onBeforeStateApply?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
35507
35529
|
/**
|
|
35508
35530
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
35509
35531
|
* @param {object} event Event object
|
|
35510
35532
|
* @param {GridStateInfo} event.state State object config
|
|
35511
35533
|
*/
|
|
35512
|
-
onBeforeStateSave?: ((event: { state: GridStateInfo }) =>
|
|
35534
|
+
onBeforeStateSave?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
35513
35535
|
/**
|
|
35514
35536
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
35515
35537
|
* Returning `false` from a listener prevents the operation
|
|
@@ -35519,7 +35541,7 @@ type GridBaseConfig = {
|
|
|
35519
35541
|
* @param {boolean} event.collapse Collapsed (true) or expanded (false)
|
|
35520
35542
|
* @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
35521
35543
|
*/
|
|
35522
|
-
onBeforeToggleGroup?: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
35544
|
+
onBeforeToggleGroup?: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void)|string
|
|
35523
35545
|
/**
|
|
35524
35546
|
* Fired before a parent node record toggles its collapsed state.
|
|
35525
35547
|
* @param {object} event Event object
|
|
@@ -35588,7 +35610,7 @@ type GridBaseConfig = {
|
|
|
35588
35610
|
* @param {Grid.column.Column} event.column Column
|
|
35589
35611
|
* @param {Core.data.Model} event.record Record
|
|
35590
35612
|
*/
|
|
35591
|
-
onCellMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
35613
|
+
onCellMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void)|string
|
|
35592
35614
|
/**
|
|
35593
35615
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
35594
35616
|
* @param {object} event Event object
|
|
@@ -35715,7 +35737,7 @@ type GridBaseConfig = {
|
|
|
35715
35737
|
* @param {Event} event.event The browser event.
|
|
35716
35738
|
* @param {string} event.region The region where the column was dropped.
|
|
35717
35739
|
*/
|
|
35718
|
-
onColumnDrop?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
35740
|
+
onColumnDrop?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void)|string
|
|
35719
35741
|
/**
|
|
35720
35742
|
* This event is fired after a resize gesture is completed.
|
|
35721
35743
|
* @param {object} event Event object
|
|
@@ -35855,7 +35877,7 @@ type GridBaseConfig = {
|
|
|
35855
35877
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
35856
35878
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
35857
35879
|
*/
|
|
35858
|
-
onFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
35880
|
+
onFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
35859
35881
|
/**
|
|
35860
35882
|
* Fires on the owning Grid when cell editing is finished
|
|
35861
35883
|
* @param {object} event Event object
|
|
@@ -35903,7 +35925,7 @@ type GridBaseConfig = {
|
|
|
35903
35925
|
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
35904
35926
|
* @param {MouseEvent,TouchEvent} event.event
|
|
35905
35927
|
*/
|
|
35906
|
-
onGridRowBeforeDragStart?: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
35928
|
+
onGridRowBeforeDragStart?: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void)|string
|
|
35907
35929
|
/**
|
|
35908
35930
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
35909
35931
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
@@ -35970,7 +35992,7 @@ type GridBaseConfig = {
|
|
|
35970
35992
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
35971
35993
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
35972
35994
|
*/
|
|
35973
|
-
onHeaderClick?: ((event: { domEvent: Event, column: Column }) =>
|
|
35995
|
+
onHeaderClick?: ((event: { domEvent: Event, column: Column }) => boolean|void)|string
|
|
35974
35996
|
/**
|
|
35975
35997
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
35976
35998
|
* 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 +36003,7 @@ type GridBaseConfig = {
|
|
|
35981
36003
|
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
35982
36004
|
* @param {Grid.column.Column} event.column Column
|
|
35983
36005
|
*/
|
|
35984
|
-
onHeaderMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
36006
|
+
onHeaderMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void)|string
|
|
35985
36007
|
/**
|
|
35986
36008
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
35987
36009
|
* @param {object} event Event object
|
|
@@ -36192,7 +36214,7 @@ type GridBaseConfig = {
|
|
|
36192
36214
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
36193
36215
|
* @param {Event} event.domEvent The native DOM event
|
|
36194
36216
|
*/
|
|
36195
|
-
onSplitterCollapseClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
36217
|
+
onSplitterCollapseClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
36196
36218
|
/**
|
|
36197
36219
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
36198
36220
|
* @param {object} event Event object
|
|
@@ -36217,7 +36239,7 @@ type GridBaseConfig = {
|
|
|
36217
36239
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
36218
36240
|
* @param {Event} event.domEvent The native DOM event
|
|
36219
36241
|
*/
|
|
36220
|
-
onSplitterExpandClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
36242
|
+
onSplitterExpandClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
36221
36243
|
/**
|
|
36222
36244
|
* Fires on the owning Grid when editing starts
|
|
36223
36245
|
* @param {object} event Event object
|
|
@@ -36635,14 +36657,14 @@ export class GridBase extends Panel {
|
|
|
36635
36657
|
* @param {string} event.lineDelimiter The CSV delimiter to separate lines
|
|
36636
36658
|
* @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
|
|
36637
36659
|
*/
|
|
36638
|
-
onBeforeCSVExport: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
36660
|
+
onBeforeCSVExport: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void)|string
|
|
36639
36661
|
/**
|
|
36640
36662
|
* Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
|
|
36641
36663
|
* @param {object} event Event object
|
|
36642
36664
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
36643
36665
|
* @param {Grid.util.GridLocation} event.editorContext Editing context
|
|
36644
36666
|
*/
|
|
36645
|
-
onBeforeCancelCellEdit: ((event: { source: Grid, editorContext: GridLocation }) =>
|
|
36667
|
+
onBeforeCancelCellEdit: ((event: { source: Grid, editorContext: GridLocation }) => boolean|void)|string
|
|
36646
36668
|
/**
|
|
36647
36669
|
* 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
36670
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-beforeCancelRowEdit)
|
|
@@ -36657,7 +36679,7 @@ export class GridBase extends Panel {
|
|
|
36657
36679
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
36658
36680
|
* @param {CellEditorContext} event.editorContext Editing context
|
|
36659
36681
|
*/
|
|
36660
|
-
onBeforeCellEditStart: ((event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
36682
|
+
onBeforeCellEditStart: ((event: { source: Grid, editorContext: CellEditorContext }) => boolean|void)|string
|
|
36661
36683
|
/**
|
|
36662
36684
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
36663
36685
|
* 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 +36687,7 @@ export class GridBase extends Panel {
|
|
|
36665
36687
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
36666
36688
|
* @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
36689
|
*/
|
|
36668
|
-
onBeforeCellRangeDelete: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
36690
|
+
onBeforeCellRangeDelete: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void)|string
|
|
36669
36691
|
/**
|
|
36670
36692
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
36671
36693
|
* @param {object} event Event object
|
|
@@ -36673,7 +36695,7 @@ export class GridBase extends Panel {
|
|
|
36673
36695
|
* @param {string} event.field The field being changed
|
|
36674
36696
|
* @param {any} event.value The value being set
|
|
36675
36697
|
*/
|
|
36676
|
-
onBeforeCellRangeEdit: ((event: { record: Model, field: string, value: any }) =>
|
|
36698
|
+
onBeforeCellRangeEdit: ((event: { record: Model, field: string, value: any }) => boolean|void)|string
|
|
36677
36699
|
/**
|
|
36678
36700
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
36679
36701
|
* @param {object} event Event object
|
|
@@ -36689,7 +36711,7 @@ export class GridBase extends Panel {
|
|
|
36689
36711
|
* @param {Grid.column.Column} event.column The dragged column.
|
|
36690
36712
|
* @param {Event} event.event The browser event.
|
|
36691
36713
|
*/
|
|
36692
|
-
onBeforeColumnDragStart: ((event: { source: Grid, column: Column, event: Event }) =>
|
|
36714
|
+
onBeforeColumnDragStart: ((event: { source: Grid, column: Column, event: Event }) => boolean|void)|string
|
|
36693
36715
|
/**
|
|
36694
36716
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
36695
36717
|
* @param {object} event Event object
|
|
@@ -36700,7 +36722,7 @@ export class GridBase extends Panel {
|
|
|
36700
36722
|
* @param {Event} event.event The browser event.
|
|
36701
36723
|
* @param {string} event.region The region where the column was dropped.
|
|
36702
36724
|
*/
|
|
36703
|
-
onBeforeColumnDropFinalize: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
36725
|
+
onBeforeColumnDropFinalize: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void)|string
|
|
36704
36726
|
/**
|
|
36705
36727
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
36706
36728
|
* `false`.
|
|
@@ -36709,7 +36731,7 @@ export class GridBase extends Panel {
|
|
|
36709
36731
|
* @param {Grid.column.Column} event.column The column
|
|
36710
36732
|
* @param {Event} event.domEvent The browser event
|
|
36711
36733
|
*/
|
|
36712
|
-
onBeforeColumnResize: ((event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
36734
|
+
onBeforeColumnResize: ((event: { source: Grid, column: Column, domEvent: Event }) => boolean|void)|string
|
|
36713
36735
|
/**
|
|
36714
36736
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
36715
36737
|
* @param {object} event Event object
|
|
@@ -36733,14 +36755,14 @@ export class GridBase extends Panel {
|
|
|
36733
36755
|
* @param {XLSColumn[]} event.columns An array of columns to export
|
|
36734
36756
|
* @param {any[][]} event.rows An array of records to export
|
|
36735
36757
|
*/
|
|
36736
|
-
onBeforeExcelExport: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
36758
|
+
onBeforeExcelExport: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void)|string
|
|
36737
36759
|
/**
|
|
36738
36760
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
36739
36761
|
* @param {object} event Event object
|
|
36740
36762
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
36741
36763
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
36742
36764
|
*/
|
|
36743
|
-
onBeforeFillHandleDragStart: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
36765
|
+
onBeforeFillHandleDragStart: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
36744
36766
|
/**
|
|
36745
36767
|
* 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
36768
|
* @param {object} event Event object
|
|
@@ -36771,7 +36793,7 @@ export class GridBase extends Panel {
|
|
|
36771
36793
|
* @param {object} event Event object
|
|
36772
36794
|
* @param {PdfExportConfig} event.config Export config
|
|
36773
36795
|
*/
|
|
36774
|
-
onBeforePdfExport: ((event: { config: PdfExportConfig }) =>
|
|
36796
|
+
onBeforePdfExport: ((event: { config: PdfExportConfig }) => boolean|void)|string
|
|
36775
36797
|
/**
|
|
36776
36798
|
* Fires before a row is rendered.
|
|
36777
36799
|
* @param {object} event Event object
|
|
@@ -36814,26 +36836,26 @@ export class GridBase extends Panel {
|
|
|
36814
36836
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
36815
36837
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
36816
36838
|
*/
|
|
36817
|
-
onBeforeSelectionChange: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
36839
|
+
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
36840
|
/**
|
|
36819
36841
|
* Fires on the owning Grid before editing starts, return `false` to prevent editing
|
|
36820
36842
|
* @param {object} event Event object
|
|
36821
36843
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
36822
36844
|
* @param {RowEditorContext} event.editorContext Editing context
|
|
36823
36845
|
*/
|
|
36824
|
-
onBeforeStartRowEdit: ((event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
36846
|
+
onBeforeStartRowEdit: ((event: { source: Grid, editorContext: RowEditorContext }) => boolean|void)|string
|
|
36825
36847
|
/**
|
|
36826
36848
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
36827
36849
|
* @param {object} event Event object
|
|
36828
36850
|
* @param {GridStateInfo} event.state State object config
|
|
36829
36851
|
*/
|
|
36830
|
-
onBeforeStateApply: ((event: { state: GridStateInfo }) =>
|
|
36852
|
+
onBeforeStateApply: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
36831
36853
|
/**
|
|
36832
36854
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
36833
36855
|
* @param {object} event Event object
|
|
36834
36856
|
* @param {GridStateInfo} event.state State object config
|
|
36835
36857
|
*/
|
|
36836
|
-
onBeforeStateSave: ((event: { state: GridStateInfo }) =>
|
|
36858
|
+
onBeforeStateSave: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
36837
36859
|
/**
|
|
36838
36860
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
36839
36861
|
* Returning `false` from a listener prevents the operation
|
|
@@ -36843,7 +36865,7 @@ export class GridBase extends Panel {
|
|
|
36843
36865
|
* @param {boolean} event.collapse Collapsed (true) or expanded (false)
|
|
36844
36866
|
* @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
36845
36867
|
*/
|
|
36846
|
-
onBeforeToggleGroup: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
36868
|
+
onBeforeToggleGroup: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void)|string
|
|
36847
36869
|
/**
|
|
36848
36870
|
* Fired before a parent node record toggles its collapsed state.
|
|
36849
36871
|
* @param {object} event Event object
|
|
@@ -36912,7 +36934,7 @@ export class GridBase extends Panel {
|
|
|
36912
36934
|
* @param {Grid.column.Column} event.column Column
|
|
36913
36935
|
* @param {Core.data.Model} event.record Record
|
|
36914
36936
|
*/
|
|
36915
|
-
onCellMenuBeforeShow: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
36937
|
+
onCellMenuBeforeShow: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void)|string
|
|
36916
36938
|
/**
|
|
36917
36939
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
36918
36940
|
* @param {object} event Event object
|
|
@@ -37033,7 +37055,7 @@ export class GridBase extends Panel {
|
|
|
37033
37055
|
* @param {Event} event.event The browser event.
|
|
37034
37056
|
* @param {string} event.region The region where the column was dropped.
|
|
37035
37057
|
*/
|
|
37036
|
-
onColumnDrop: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
37058
|
+
onColumnDrop: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void)|string
|
|
37037
37059
|
/**
|
|
37038
37060
|
* This event is fired after a resize gesture is completed.
|
|
37039
37061
|
* @param {object} event Event object
|
|
@@ -37137,7 +37159,7 @@ export class GridBase extends Panel {
|
|
|
37137
37159
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
37138
37160
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
37139
37161
|
*/
|
|
37140
|
-
onFillHandleDragStart: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
37162
|
+
onFillHandleDragStart: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
37141
37163
|
/**
|
|
37142
37164
|
* Fires on the owning Grid when cell editing is finished
|
|
37143
37165
|
* @param {object} event Event object
|
|
@@ -37161,7 +37183,7 @@ export class GridBase extends Panel {
|
|
|
37161
37183
|
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
37162
37184
|
* @param {MouseEvent,TouchEvent} event.event
|
|
37163
37185
|
*/
|
|
37164
|
-
onGridRowBeforeDragStart: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
37186
|
+
onGridRowBeforeDragStart: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void)|string
|
|
37165
37187
|
/**
|
|
37166
37188
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
37167
37189
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
@@ -37228,7 +37250,7 @@ export class GridBase extends Panel {
|
|
|
37228
37250
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
37229
37251
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
37230
37252
|
*/
|
|
37231
|
-
onHeaderClick: ((event: { domEvent: Event, column: Column }) =>
|
|
37253
|
+
onHeaderClick: ((event: { domEvent: Event, column: Column }) => boolean|void)|string
|
|
37232
37254
|
/**
|
|
37233
37255
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
37234
37256
|
* 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 +37261,7 @@ export class GridBase extends Panel {
|
|
|
37239
37261
|
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
37240
37262
|
* @param {Grid.column.Column} event.column Column
|
|
37241
37263
|
*/
|
|
37242
|
-
onHeaderMenuBeforeShow: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
37264
|
+
onHeaderMenuBeforeShow: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void)|string
|
|
37243
37265
|
/**
|
|
37244
37266
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
37245
37267
|
* @param {object} event Event object
|
|
@@ -37408,7 +37430,7 @@ export class GridBase extends Panel {
|
|
|
37408
37430
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
37409
37431
|
* @param {Event} event.domEvent The native DOM event
|
|
37410
37432
|
*/
|
|
37411
|
-
onSplitterCollapseClick: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
37433
|
+
onSplitterCollapseClick: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
37412
37434
|
/**
|
|
37413
37435
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
37414
37436
|
* @param {object} event Event object
|
|
@@ -37433,7 +37455,7 @@ export class GridBase extends Panel {
|
|
|
37433
37455
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
37434
37456
|
* @param {Event} event.domEvent The native DOM event
|
|
37435
37457
|
*/
|
|
37436
|
-
onSplitterExpandClick: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
37458
|
+
onSplitterExpandClick: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
37437
37459
|
/**
|
|
37438
37460
|
* Fires on the owning Grid when editing starts
|
|
37439
37461
|
* @param {object} event Event object
|
|
@@ -38085,7 +38107,7 @@ type SubGridListenersTypes = {
|
|
|
38085
38107
|
* @param {object} event Event object
|
|
38086
38108
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
38087
38109
|
*/
|
|
38088
|
-
beforeHide: (event: { source: Widget }) =>
|
|
38110
|
+
beforeHide: (event: { source: Widget }) => boolean|void
|
|
38089
38111
|
/**
|
|
38090
38112
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
38091
38113
|
* @param {object} event Event object
|
|
@@ -38215,7 +38237,7 @@ type SubGridListeners = {
|
|
|
38215
38237
|
* @param {object} event Event object
|
|
38216
38238
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
38217
38239
|
*/
|
|
38218
|
-
beforeHide?: ((event: { source: Widget }) =>
|
|
38240
|
+
beforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
38219
38241
|
/**
|
|
38220
38242
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
38221
38243
|
* @param {object} event Event object
|
|
@@ -38704,7 +38726,7 @@ type SubGridConfig = {
|
|
|
38704
38726
|
* @param {object} event Event object
|
|
38705
38727
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
38706
38728
|
*/
|
|
38707
|
-
onBeforeHide?: ((event: { source: Widget }) =>
|
|
38729
|
+
onBeforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
38708
38730
|
/**
|
|
38709
38731
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
38710
38732
|
* @param {object} event Event object
|
|
@@ -38938,14 +38960,14 @@ type TreeGridListenersTypes = {
|
|
|
38938
38960
|
* @param {string} event.lineDelimiter The CSV delimiter to separate lines
|
|
38939
38961
|
* @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
|
|
38940
38962
|
*/
|
|
38941
|
-
beforeCSVExport: (event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
38963
|
+
beforeCSVExport: (event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void
|
|
38942
38964
|
/**
|
|
38943
38965
|
* Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
|
|
38944
38966
|
* @param {object} event Event object
|
|
38945
38967
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
38946
38968
|
* @param {Grid.util.GridLocation} event.editorContext Editing context
|
|
38947
38969
|
*/
|
|
38948
|
-
beforeCancelCellEdit: (event: { source: Grid, editorContext: GridLocation }) =>
|
|
38970
|
+
beforeCancelCellEdit: (event: { source: Grid, editorContext: GridLocation }) => boolean|void
|
|
38949
38971
|
/**
|
|
38950
38972
|
* 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
38973
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-beforeCancelRowEdit)
|
|
@@ -38960,7 +38982,7 @@ type TreeGridListenersTypes = {
|
|
|
38960
38982
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
38961
38983
|
* @param {CellEditorContext} event.editorContext Editing context
|
|
38962
38984
|
*/
|
|
38963
|
-
beforeCellEditStart: (event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
38985
|
+
beforeCellEditStart: (event: { source: Grid, editorContext: CellEditorContext }) => boolean|void
|
|
38964
38986
|
/**
|
|
38965
38987
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
38966
38988
|
* 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 +38990,7 @@ type TreeGridListenersTypes = {
|
|
|
38968
38990
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
38969
38991
|
* @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
38992
|
*/
|
|
38971
|
-
beforeCellRangeDelete: (event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
38993
|
+
beforeCellRangeDelete: (event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void
|
|
38972
38994
|
/**
|
|
38973
38995
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
38974
38996
|
* @param {object} event Event object
|
|
@@ -38976,7 +38998,7 @@ type TreeGridListenersTypes = {
|
|
|
38976
38998
|
* @param {string} event.field The field being changed
|
|
38977
38999
|
* @param {any} event.value The value being set
|
|
38978
39000
|
*/
|
|
38979
|
-
beforeCellRangeEdit: (event: { record: Model, field: string, value: any }) =>
|
|
39001
|
+
beforeCellRangeEdit: (event: { record: Model, field: string, value: any }) => boolean|void
|
|
38980
39002
|
/**
|
|
38981
39003
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
38982
39004
|
* @param {object} event Event object
|
|
@@ -38992,7 +39014,7 @@ type TreeGridListenersTypes = {
|
|
|
38992
39014
|
* @param {Grid.column.Column} event.column The dragged column.
|
|
38993
39015
|
* @param {Event} event.event The browser event.
|
|
38994
39016
|
*/
|
|
38995
|
-
beforeColumnDragStart: (event: { source: Grid, column: Column, event: Event }) =>
|
|
39017
|
+
beforeColumnDragStart: (event: { source: Grid, column: Column, event: Event }) => boolean|void
|
|
38996
39018
|
/**
|
|
38997
39019
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
38998
39020
|
* @param {object} event Event object
|
|
@@ -39003,7 +39025,7 @@ type TreeGridListenersTypes = {
|
|
|
39003
39025
|
* @param {Event} event.event The browser event.
|
|
39004
39026
|
* @param {string} event.region The region where the column was dropped.
|
|
39005
39027
|
*/
|
|
39006
|
-
beforeColumnDropFinalize: (event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
39028
|
+
beforeColumnDropFinalize: (event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void
|
|
39007
39029
|
/**
|
|
39008
39030
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
39009
39031
|
* `false`.
|
|
@@ -39012,7 +39034,7 @@ type TreeGridListenersTypes = {
|
|
|
39012
39034
|
* @param {Grid.column.Column} event.column The column
|
|
39013
39035
|
* @param {Event} event.domEvent The browser event
|
|
39014
39036
|
*/
|
|
39015
|
-
beforeColumnResize: (event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
39037
|
+
beforeColumnResize: (event: { source: Grid, column: Column, domEvent: Event }) => boolean|void
|
|
39016
39038
|
/**
|
|
39017
39039
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
39018
39040
|
* @param {object} event Event object
|
|
@@ -39036,14 +39058,14 @@ type TreeGridListenersTypes = {
|
|
|
39036
39058
|
* @param {XLSColumn[]} event.columns An array of columns to export
|
|
39037
39059
|
* @param {any[][]} event.rows An array of records to export
|
|
39038
39060
|
*/
|
|
39039
|
-
beforeExcelExport: (event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
39061
|
+
beforeExcelExport: (event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void
|
|
39040
39062
|
/**
|
|
39041
39063
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
39042
39064
|
* @param {object} event Event object
|
|
39043
39065
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
39044
39066
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
39045
39067
|
*/
|
|
39046
|
-
beforeFillHandleDragStart: (event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
39068
|
+
beforeFillHandleDragStart: (event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void
|
|
39047
39069
|
/**
|
|
39048
39070
|
* 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
39071
|
* @param {object} event Event object
|
|
@@ -39064,7 +39086,7 @@ type TreeGridListenersTypes = {
|
|
|
39064
39086
|
* @param {object} event Event object
|
|
39065
39087
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
39066
39088
|
*/
|
|
39067
|
-
beforeHide: (event: { source: Widget }) =>
|
|
39089
|
+
beforeHide: (event: { source: Widget }) => boolean|void
|
|
39068
39090
|
/**
|
|
39069
39091
|
* Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
|
|
39070
39092
|
* @param {object} event Event object
|
|
@@ -39080,7 +39102,7 @@ type TreeGridListenersTypes = {
|
|
|
39080
39102
|
* @param {object} event Event object
|
|
39081
39103
|
* @param {PdfExportConfig} event.config Export config
|
|
39082
39104
|
*/
|
|
39083
|
-
beforePdfExport: (event: { config: PdfExportConfig }) =>
|
|
39105
|
+
beforePdfExport: (event: { config: PdfExportConfig }) => boolean|void
|
|
39084
39106
|
/**
|
|
39085
39107
|
* Fires before a row is rendered.
|
|
39086
39108
|
* @param {object} event Event object
|
|
@@ -39123,7 +39145,7 @@ type TreeGridListenersTypes = {
|
|
|
39123
39145
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
39124
39146
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
39125
39147
|
*/
|
|
39126
|
-
beforeSelectionChange: (event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
39148
|
+
beforeSelectionChange: (event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => boolean|void
|
|
39127
39149
|
/**
|
|
39128
39150
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
39129
39151
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -39144,19 +39166,19 @@ type TreeGridListenersTypes = {
|
|
|
39144
39166
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
39145
39167
|
* @param {RowEditorContext} event.editorContext Editing context
|
|
39146
39168
|
*/
|
|
39147
|
-
beforeStartRowEdit: (event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
39169
|
+
beforeStartRowEdit: (event: { source: Grid, editorContext: RowEditorContext }) => boolean|void
|
|
39148
39170
|
/**
|
|
39149
39171
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
39150
39172
|
* @param {object} event Event object
|
|
39151
39173
|
* @param {GridStateInfo} event.state State object config
|
|
39152
39174
|
*/
|
|
39153
|
-
beforeStateApply: (event: { state: GridStateInfo }) =>
|
|
39175
|
+
beforeStateApply: (event: { state: GridStateInfo }) => boolean|void
|
|
39154
39176
|
/**
|
|
39155
39177
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
39156
39178
|
* @param {object} event Event object
|
|
39157
39179
|
* @param {GridStateInfo} event.state State object config
|
|
39158
39180
|
*/
|
|
39159
|
-
beforeStateSave: (event: { state: GridStateInfo }) =>
|
|
39181
|
+
beforeStateSave: (event: { state: GridStateInfo }) => boolean|void
|
|
39160
39182
|
/**
|
|
39161
39183
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
39162
39184
|
* Returning `false` from a listener prevents the operation
|
|
@@ -39166,7 +39188,7 @@ type TreeGridListenersTypes = {
|
|
|
39166
39188
|
* @param {boolean} event.collapse Collapsed (true) or expanded (false)
|
|
39167
39189
|
* @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
39168
39190
|
*/
|
|
39169
|
-
beforeToggleGroup: (event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
39191
|
+
beforeToggleGroup: (event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void
|
|
39170
39192
|
/**
|
|
39171
39193
|
* Fired before a parent node record toggles its collapsed state.
|
|
39172
39194
|
* @param {object} event Event object
|
|
@@ -39235,7 +39257,7 @@ type TreeGridListenersTypes = {
|
|
|
39235
39257
|
* @param {Grid.column.Column} event.column Column
|
|
39236
39258
|
* @param {Core.data.Model} event.record Record
|
|
39237
39259
|
*/
|
|
39238
|
-
cellMenuBeforeShow: (event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
39260
|
+
cellMenuBeforeShow: (event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void
|
|
39239
39261
|
/**
|
|
39240
39262
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
39241
39263
|
* @param {object} event Event object
|
|
@@ -39362,7 +39384,7 @@ type TreeGridListenersTypes = {
|
|
|
39362
39384
|
* @param {Event} event.event The browser event.
|
|
39363
39385
|
* @param {string} event.region The region where the column was dropped.
|
|
39364
39386
|
*/
|
|
39365
|
-
columnDrop: (event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
39387
|
+
columnDrop: (event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void
|
|
39366
39388
|
/**
|
|
39367
39389
|
* This event is fired after a resize gesture is completed.
|
|
39368
39390
|
* @param {object} event Event object
|
|
@@ -39502,7 +39524,7 @@ type TreeGridListenersTypes = {
|
|
|
39502
39524
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
39503
39525
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
39504
39526
|
*/
|
|
39505
|
-
fillHandleDragStart: (event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
39527
|
+
fillHandleDragStart: (event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void
|
|
39506
39528
|
/**
|
|
39507
39529
|
* Fires on the owning Grid when cell editing is finished
|
|
39508
39530
|
* @param {object} event Event object
|
|
@@ -39550,7 +39572,7 @@ type TreeGridListenersTypes = {
|
|
|
39550
39572
|
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
39551
39573
|
* @param {MouseEvent,TouchEvent} event.event
|
|
39552
39574
|
*/
|
|
39553
|
-
gridRowBeforeDragStart: (event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
39575
|
+
gridRowBeforeDragStart: (event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void
|
|
39554
39576
|
/**
|
|
39555
39577
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
39556
39578
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
@@ -39617,7 +39639,7 @@ type TreeGridListenersTypes = {
|
|
|
39617
39639
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
39618
39640
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
39619
39641
|
*/
|
|
39620
|
-
headerClick: (event: { domEvent: Event, column: Column }) =>
|
|
39642
|
+
headerClick: (event: { domEvent: Event, column: Column }) => boolean|void
|
|
39621
39643
|
/**
|
|
39622
39644
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
39623
39645
|
* 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 +39650,7 @@ type TreeGridListenersTypes = {
|
|
|
39628
39650
|
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
39629
39651
|
* @param {Grid.column.Column} event.column Column
|
|
39630
39652
|
*/
|
|
39631
|
-
headerMenuBeforeShow: (event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
39653
|
+
headerMenuBeforeShow: (event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void
|
|
39632
39654
|
/**
|
|
39633
39655
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
39634
39656
|
* @param {object} event Event object
|
|
@@ -39839,7 +39861,7 @@ type TreeGridListenersTypes = {
|
|
|
39839
39861
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
39840
39862
|
* @param {Event} event.domEvent The native DOM event
|
|
39841
39863
|
*/
|
|
39842
|
-
splitterCollapseClick: (event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
39864
|
+
splitterCollapseClick: (event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void
|
|
39843
39865
|
/**
|
|
39844
39866
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
39845
39867
|
* @param {object} event Event object
|
|
@@ -39864,7 +39886,7 @@ type TreeGridListenersTypes = {
|
|
|
39864
39886
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
39865
39887
|
* @param {Event} event.domEvent The native DOM event
|
|
39866
39888
|
*/
|
|
39867
|
-
splitterExpandClick: (event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
39889
|
+
splitterExpandClick: (event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void
|
|
39868
39890
|
/**
|
|
39869
39891
|
* Fires on the owning Grid when editing starts
|
|
39870
39892
|
* @param {object} event Event object
|
|
@@ -39953,14 +39975,14 @@ type TreeGridListeners = {
|
|
|
39953
39975
|
* @param {string} event.lineDelimiter The CSV delimiter to separate lines
|
|
39954
39976
|
* @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
|
|
39955
39977
|
*/
|
|
39956
|
-
beforeCSVExport?: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
39978
|
+
beforeCSVExport?: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void)|string
|
|
39957
39979
|
/**
|
|
39958
39980
|
* Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
|
|
39959
39981
|
* @param {object} event Event object
|
|
39960
39982
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
39961
39983
|
* @param {Grid.util.GridLocation} event.editorContext Editing context
|
|
39962
39984
|
*/
|
|
39963
|
-
beforeCancelCellEdit?: ((event: { source: Grid, editorContext: GridLocation }) =>
|
|
39985
|
+
beforeCancelCellEdit?: ((event: { source: Grid, editorContext: GridLocation }) => boolean|void)|string
|
|
39964
39986
|
/**
|
|
39965
39987
|
* 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
39988
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-beforeCancelRowEdit)
|
|
@@ -39975,7 +39997,7 @@ type TreeGridListeners = {
|
|
|
39975
39997
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
39976
39998
|
* @param {CellEditorContext} event.editorContext Editing context
|
|
39977
39999
|
*/
|
|
39978
|
-
beforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
40000
|
+
beforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => boolean|void)|string
|
|
39979
40001
|
/**
|
|
39980
40002
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
39981
40003
|
* 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 +40005,7 @@ type TreeGridListeners = {
|
|
|
39983
40005
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
39984
40006
|
* @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
40007
|
*/
|
|
39986
|
-
beforeCellRangeDelete?: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
40008
|
+
beforeCellRangeDelete?: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void)|string
|
|
39987
40009
|
/**
|
|
39988
40010
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
39989
40011
|
* @param {object} event Event object
|
|
@@ -39991,7 +40013,7 @@ type TreeGridListeners = {
|
|
|
39991
40013
|
* @param {string} event.field The field being changed
|
|
39992
40014
|
* @param {any} event.value The value being set
|
|
39993
40015
|
*/
|
|
39994
|
-
beforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) =>
|
|
40016
|
+
beforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => boolean|void)|string
|
|
39995
40017
|
/**
|
|
39996
40018
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
39997
40019
|
* @param {object} event Event object
|
|
@@ -40007,7 +40029,7 @@ type TreeGridListeners = {
|
|
|
40007
40029
|
* @param {Grid.column.Column} event.column The dragged column.
|
|
40008
40030
|
* @param {Event} event.event The browser event.
|
|
40009
40031
|
*/
|
|
40010
|
-
beforeColumnDragStart?: ((event: { source: Grid, column: Column, event: Event }) =>
|
|
40032
|
+
beforeColumnDragStart?: ((event: { source: Grid, column: Column, event: Event }) => boolean|void)|string
|
|
40011
40033
|
/**
|
|
40012
40034
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
40013
40035
|
* @param {object} event Event object
|
|
@@ -40018,7 +40040,7 @@ type TreeGridListeners = {
|
|
|
40018
40040
|
* @param {Event} event.event The browser event.
|
|
40019
40041
|
* @param {string} event.region The region where the column was dropped.
|
|
40020
40042
|
*/
|
|
40021
|
-
beforeColumnDropFinalize?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
40043
|
+
beforeColumnDropFinalize?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void)|string
|
|
40022
40044
|
/**
|
|
40023
40045
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
40024
40046
|
* `false`.
|
|
@@ -40027,7 +40049,7 @@ type TreeGridListeners = {
|
|
|
40027
40049
|
* @param {Grid.column.Column} event.column The column
|
|
40028
40050
|
* @param {Event} event.domEvent The browser event
|
|
40029
40051
|
*/
|
|
40030
|
-
beforeColumnResize?: ((event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
40052
|
+
beforeColumnResize?: ((event: { source: Grid, column: Column, domEvent: Event }) => boolean|void)|string
|
|
40031
40053
|
/**
|
|
40032
40054
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
40033
40055
|
* @param {object} event Event object
|
|
@@ -40051,14 +40073,14 @@ type TreeGridListeners = {
|
|
|
40051
40073
|
* @param {XLSColumn[]} event.columns An array of columns to export
|
|
40052
40074
|
* @param {any[][]} event.rows An array of records to export
|
|
40053
40075
|
*/
|
|
40054
|
-
beforeExcelExport?: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
40076
|
+
beforeExcelExport?: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void)|string
|
|
40055
40077
|
/**
|
|
40056
40078
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
40057
40079
|
* @param {object} event Event object
|
|
40058
40080
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
40059
40081
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
40060
40082
|
*/
|
|
40061
|
-
beforeFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
40083
|
+
beforeFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
40062
40084
|
/**
|
|
40063
40085
|
* 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
40086
|
* @param {object} event Event object
|
|
@@ -40079,7 +40101,7 @@ type TreeGridListeners = {
|
|
|
40079
40101
|
* @param {object} event Event object
|
|
40080
40102
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
40081
40103
|
*/
|
|
40082
|
-
beforeHide?: ((event: { source: Widget }) =>
|
|
40104
|
+
beforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
40083
40105
|
/**
|
|
40084
40106
|
* Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
|
|
40085
40107
|
* @param {object} event Event object
|
|
@@ -40095,7 +40117,7 @@ type TreeGridListeners = {
|
|
|
40095
40117
|
* @param {object} event Event object
|
|
40096
40118
|
* @param {PdfExportConfig} event.config Export config
|
|
40097
40119
|
*/
|
|
40098
|
-
beforePdfExport?: ((event: { config: PdfExportConfig }) =>
|
|
40120
|
+
beforePdfExport?: ((event: { config: PdfExportConfig }) => boolean|void)|string
|
|
40099
40121
|
/**
|
|
40100
40122
|
* Fires before a row is rendered.
|
|
40101
40123
|
* @param {object} event Event object
|
|
@@ -40138,7 +40160,7 @@ type TreeGridListeners = {
|
|
|
40138
40160
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
40139
40161
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
40140
40162
|
*/
|
|
40141
|
-
beforeSelectionChange?: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
40163
|
+
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
40164
|
/**
|
|
40143
40165
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
40144
40166
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -40159,19 +40181,19 @@ type TreeGridListeners = {
|
|
|
40159
40181
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
40160
40182
|
* @param {RowEditorContext} event.editorContext Editing context
|
|
40161
40183
|
*/
|
|
40162
|
-
beforeStartRowEdit?: ((event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
40184
|
+
beforeStartRowEdit?: ((event: { source: Grid, editorContext: RowEditorContext }) => boolean|void)|string
|
|
40163
40185
|
/**
|
|
40164
40186
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
40165
40187
|
* @param {object} event Event object
|
|
40166
40188
|
* @param {GridStateInfo} event.state State object config
|
|
40167
40189
|
*/
|
|
40168
|
-
beforeStateApply?: ((event: { state: GridStateInfo }) =>
|
|
40190
|
+
beforeStateApply?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
40169
40191
|
/**
|
|
40170
40192
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
40171
40193
|
* @param {object} event Event object
|
|
40172
40194
|
* @param {GridStateInfo} event.state State object config
|
|
40173
40195
|
*/
|
|
40174
|
-
beforeStateSave?: ((event: { state: GridStateInfo }) =>
|
|
40196
|
+
beforeStateSave?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
40175
40197
|
/**
|
|
40176
40198
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
40177
40199
|
* Returning `false` from a listener prevents the operation
|
|
@@ -40181,7 +40203,7 @@ type TreeGridListeners = {
|
|
|
40181
40203
|
* @param {boolean} event.collapse Collapsed (true) or expanded (false)
|
|
40182
40204
|
* @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
40183
40205
|
*/
|
|
40184
|
-
beforeToggleGroup?: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
40206
|
+
beforeToggleGroup?: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void)|string
|
|
40185
40207
|
/**
|
|
40186
40208
|
* Fired before a parent node record toggles its collapsed state.
|
|
40187
40209
|
* @param {object} event Event object
|
|
@@ -40250,7 +40272,7 @@ type TreeGridListeners = {
|
|
|
40250
40272
|
* @param {Grid.column.Column} event.column Column
|
|
40251
40273
|
* @param {Core.data.Model} event.record Record
|
|
40252
40274
|
*/
|
|
40253
|
-
cellMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
40275
|
+
cellMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void)|string
|
|
40254
40276
|
/**
|
|
40255
40277
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
40256
40278
|
* @param {object} event Event object
|
|
@@ -40377,7 +40399,7 @@ type TreeGridListeners = {
|
|
|
40377
40399
|
* @param {Event} event.event The browser event.
|
|
40378
40400
|
* @param {string} event.region The region where the column was dropped.
|
|
40379
40401
|
*/
|
|
40380
|
-
columnDrop?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
40402
|
+
columnDrop?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void)|string
|
|
40381
40403
|
/**
|
|
40382
40404
|
* This event is fired after a resize gesture is completed.
|
|
40383
40405
|
* @param {object} event Event object
|
|
@@ -40517,7 +40539,7 @@ type TreeGridListeners = {
|
|
|
40517
40539
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
40518
40540
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
40519
40541
|
*/
|
|
40520
|
-
fillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
40542
|
+
fillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
40521
40543
|
/**
|
|
40522
40544
|
* Fires on the owning Grid when cell editing is finished
|
|
40523
40545
|
* @param {object} event Event object
|
|
@@ -40565,7 +40587,7 @@ type TreeGridListeners = {
|
|
|
40565
40587
|
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
40566
40588
|
* @param {MouseEvent,TouchEvent} event.event
|
|
40567
40589
|
*/
|
|
40568
|
-
gridRowBeforeDragStart?: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
40590
|
+
gridRowBeforeDragStart?: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void)|string
|
|
40569
40591
|
/**
|
|
40570
40592
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
40571
40593
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
@@ -40632,7 +40654,7 @@ type TreeGridListeners = {
|
|
|
40632
40654
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
40633
40655
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
40634
40656
|
*/
|
|
40635
|
-
headerClick?: ((event: { domEvent: Event, column: Column }) =>
|
|
40657
|
+
headerClick?: ((event: { domEvent: Event, column: Column }) => boolean|void)|string
|
|
40636
40658
|
/**
|
|
40637
40659
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
40638
40660
|
* 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 +40665,7 @@ type TreeGridListeners = {
|
|
|
40643
40665
|
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
40644
40666
|
* @param {Grid.column.Column} event.column Column
|
|
40645
40667
|
*/
|
|
40646
|
-
headerMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
40668
|
+
headerMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void)|string
|
|
40647
40669
|
/**
|
|
40648
40670
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
40649
40671
|
* @param {object} event Event object
|
|
@@ -40854,7 +40876,7 @@ type TreeGridListeners = {
|
|
|
40854
40876
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
40855
40877
|
* @param {Event} event.domEvent The native DOM event
|
|
40856
40878
|
*/
|
|
40857
|
-
splitterCollapseClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
40879
|
+
splitterCollapseClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
40858
40880
|
/**
|
|
40859
40881
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
40860
40882
|
* @param {object} event Event object
|
|
@@ -40879,7 +40901,7 @@ type TreeGridListeners = {
|
|
|
40879
40901
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
40880
40902
|
* @param {Event} event.domEvent The native DOM event
|
|
40881
40903
|
*/
|
|
40882
|
-
splitterExpandClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
40904
|
+
splitterExpandClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
40883
40905
|
/**
|
|
40884
40906
|
* Fires on the owning Grid when editing starts
|
|
40885
40907
|
* @param {object} event Event object
|
|
@@ -41077,6 +41099,8 @@ type TreeGridConfig = {
|
|
|
41077
41099
|
/**
|
|
41078
41100
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
41079
41101
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
41102
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
41103
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-appendTo)
|
|
41080
41104
|
*/
|
|
41081
41105
|
appendTo?: HTMLElement|string
|
|
41082
41106
|
/**
|
|
@@ -41391,10 +41415,14 @@ type TreeGridConfig = {
|
|
|
41391
41415
|
inputFieldAlign?: 'start'|'end'
|
|
41392
41416
|
/**
|
|
41393
41417
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
41418
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
41419
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-insertBefore)
|
|
41394
41420
|
*/
|
|
41395
41421
|
insertBefore?: HTMLElement|string
|
|
41396
41422
|
/**
|
|
41397
41423
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
41424
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
41425
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-insertFirst)
|
|
41398
41426
|
*/
|
|
41399
41427
|
insertFirst?: HTMLElement|string
|
|
41400
41428
|
/**
|
|
@@ -41763,14 +41791,14 @@ type TreeGridConfig = {
|
|
|
41763
41791
|
* @param {string} event.lineDelimiter The CSV delimiter to separate lines
|
|
41764
41792
|
* @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
|
|
41765
41793
|
*/
|
|
41766
|
-
onBeforeCSVExport?: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
41794
|
+
onBeforeCSVExport?: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void)|string
|
|
41767
41795
|
/**
|
|
41768
41796
|
* Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
|
|
41769
41797
|
* @param {object} event Event object
|
|
41770
41798
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
41771
41799
|
* @param {Grid.util.GridLocation} event.editorContext Editing context
|
|
41772
41800
|
*/
|
|
41773
|
-
onBeforeCancelCellEdit?: ((event: { source: Grid, editorContext: GridLocation }) =>
|
|
41801
|
+
onBeforeCancelCellEdit?: ((event: { source: Grid, editorContext: GridLocation }) => boolean|void)|string
|
|
41774
41802
|
/**
|
|
41775
41803
|
* 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
41804
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-beforeCancelRowEdit)
|
|
@@ -41785,7 +41813,7 @@ type TreeGridConfig = {
|
|
|
41785
41813
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
41786
41814
|
* @param {CellEditorContext} event.editorContext Editing context
|
|
41787
41815
|
*/
|
|
41788
|
-
onBeforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
41816
|
+
onBeforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => boolean|void)|string
|
|
41789
41817
|
/**
|
|
41790
41818
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
41791
41819
|
* 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 +41821,7 @@ type TreeGridConfig = {
|
|
|
41793
41821
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
41794
41822
|
* @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
41823
|
*/
|
|
41796
|
-
onBeforeCellRangeDelete?: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
41824
|
+
onBeforeCellRangeDelete?: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void)|string
|
|
41797
41825
|
/**
|
|
41798
41826
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
41799
41827
|
* @param {object} event Event object
|
|
@@ -41801,7 +41829,7 @@ type TreeGridConfig = {
|
|
|
41801
41829
|
* @param {string} event.field The field being changed
|
|
41802
41830
|
* @param {any} event.value The value being set
|
|
41803
41831
|
*/
|
|
41804
|
-
onBeforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) =>
|
|
41832
|
+
onBeforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => boolean|void)|string
|
|
41805
41833
|
/**
|
|
41806
41834
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
41807
41835
|
* @param {object} event Event object
|
|
@@ -41817,7 +41845,7 @@ type TreeGridConfig = {
|
|
|
41817
41845
|
* @param {Grid.column.Column} event.column The dragged column.
|
|
41818
41846
|
* @param {Event} event.event The browser event.
|
|
41819
41847
|
*/
|
|
41820
|
-
onBeforeColumnDragStart?: ((event: { source: Grid, column: Column, event: Event }) =>
|
|
41848
|
+
onBeforeColumnDragStart?: ((event: { source: Grid, column: Column, event: Event }) => boolean|void)|string
|
|
41821
41849
|
/**
|
|
41822
41850
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
41823
41851
|
* @param {object} event Event object
|
|
@@ -41828,7 +41856,7 @@ type TreeGridConfig = {
|
|
|
41828
41856
|
* @param {Event} event.event The browser event.
|
|
41829
41857
|
* @param {string} event.region The region where the column was dropped.
|
|
41830
41858
|
*/
|
|
41831
|
-
onBeforeColumnDropFinalize?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
41859
|
+
onBeforeColumnDropFinalize?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void)|string
|
|
41832
41860
|
/**
|
|
41833
41861
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
41834
41862
|
* `false`.
|
|
@@ -41837,7 +41865,7 @@ type TreeGridConfig = {
|
|
|
41837
41865
|
* @param {Grid.column.Column} event.column The column
|
|
41838
41866
|
* @param {Event} event.domEvent The browser event
|
|
41839
41867
|
*/
|
|
41840
|
-
onBeforeColumnResize?: ((event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
41868
|
+
onBeforeColumnResize?: ((event: { source: Grid, column: Column, domEvent: Event }) => boolean|void)|string
|
|
41841
41869
|
/**
|
|
41842
41870
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
41843
41871
|
* @param {object} event Event object
|
|
@@ -41861,14 +41889,14 @@ type TreeGridConfig = {
|
|
|
41861
41889
|
* @param {XLSColumn[]} event.columns An array of columns to export
|
|
41862
41890
|
* @param {any[][]} event.rows An array of records to export
|
|
41863
41891
|
*/
|
|
41864
|
-
onBeforeExcelExport?: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
41892
|
+
onBeforeExcelExport?: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void)|string
|
|
41865
41893
|
/**
|
|
41866
41894
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
41867
41895
|
* @param {object} event Event object
|
|
41868
41896
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
41869
41897
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
41870
41898
|
*/
|
|
41871
|
-
onBeforeFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
41899
|
+
onBeforeFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
41872
41900
|
/**
|
|
41873
41901
|
* 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
41902
|
* @param {object} event Event object
|
|
@@ -41889,7 +41917,7 @@ type TreeGridConfig = {
|
|
|
41889
41917
|
* @param {object} event Event object
|
|
41890
41918
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
41891
41919
|
*/
|
|
41892
|
-
onBeforeHide?: ((event: { source: Widget }) =>
|
|
41920
|
+
onBeforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
41893
41921
|
/**
|
|
41894
41922
|
* Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
|
|
41895
41923
|
* @param {object} event Event object
|
|
@@ -41905,7 +41933,7 @@ type TreeGridConfig = {
|
|
|
41905
41933
|
* @param {object} event Event object
|
|
41906
41934
|
* @param {PdfExportConfig} event.config Export config
|
|
41907
41935
|
*/
|
|
41908
|
-
onBeforePdfExport?: ((event: { config: PdfExportConfig }) =>
|
|
41936
|
+
onBeforePdfExport?: ((event: { config: PdfExportConfig }) => boolean|void)|string
|
|
41909
41937
|
/**
|
|
41910
41938
|
* Fires before a row is rendered.
|
|
41911
41939
|
* @param {object} event Event object
|
|
@@ -41948,7 +41976,7 @@ type TreeGridConfig = {
|
|
|
41948
41976
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
41949
41977
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
41950
41978
|
*/
|
|
41951
|
-
onBeforeSelectionChange?: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
41979
|
+
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
41980
|
/**
|
|
41953
41981
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
41954
41982
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -41969,19 +41997,19 @@ type TreeGridConfig = {
|
|
|
41969
41997
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
41970
41998
|
* @param {RowEditorContext} event.editorContext Editing context
|
|
41971
41999
|
*/
|
|
41972
|
-
onBeforeStartRowEdit?: ((event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
42000
|
+
onBeforeStartRowEdit?: ((event: { source: Grid, editorContext: RowEditorContext }) => boolean|void)|string
|
|
41973
42001
|
/**
|
|
41974
42002
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
41975
42003
|
* @param {object} event Event object
|
|
41976
42004
|
* @param {GridStateInfo} event.state State object config
|
|
41977
42005
|
*/
|
|
41978
|
-
onBeforeStateApply?: ((event: { state: GridStateInfo }) =>
|
|
42006
|
+
onBeforeStateApply?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
41979
42007
|
/**
|
|
41980
42008
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
41981
42009
|
* @param {object} event Event object
|
|
41982
42010
|
* @param {GridStateInfo} event.state State object config
|
|
41983
42011
|
*/
|
|
41984
|
-
onBeforeStateSave?: ((event: { state: GridStateInfo }) =>
|
|
42012
|
+
onBeforeStateSave?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
41985
42013
|
/**
|
|
41986
42014
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
41987
42015
|
* Returning `false` from a listener prevents the operation
|
|
@@ -41991,7 +42019,7 @@ type TreeGridConfig = {
|
|
|
41991
42019
|
* @param {boolean} event.collapse Collapsed (true) or expanded (false)
|
|
41992
42020
|
* @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
41993
42021
|
*/
|
|
41994
|
-
onBeforeToggleGroup?: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
42022
|
+
onBeforeToggleGroup?: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void)|string
|
|
41995
42023
|
/**
|
|
41996
42024
|
* Fired before a parent node record toggles its collapsed state.
|
|
41997
42025
|
* @param {object} event Event object
|
|
@@ -42060,7 +42088,7 @@ type TreeGridConfig = {
|
|
|
42060
42088
|
* @param {Grid.column.Column} event.column Column
|
|
42061
42089
|
* @param {Core.data.Model} event.record Record
|
|
42062
42090
|
*/
|
|
42063
|
-
onCellMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
42091
|
+
onCellMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void)|string
|
|
42064
42092
|
/**
|
|
42065
42093
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
42066
42094
|
* @param {object} event Event object
|
|
@@ -42187,7 +42215,7 @@ type TreeGridConfig = {
|
|
|
42187
42215
|
* @param {Event} event.event The browser event.
|
|
42188
42216
|
* @param {string} event.region The region where the column was dropped.
|
|
42189
42217
|
*/
|
|
42190
|
-
onColumnDrop?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
42218
|
+
onColumnDrop?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void)|string
|
|
42191
42219
|
/**
|
|
42192
42220
|
* This event is fired after a resize gesture is completed.
|
|
42193
42221
|
* @param {object} event Event object
|
|
@@ -42327,7 +42355,7 @@ type TreeGridConfig = {
|
|
|
42327
42355
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
42328
42356
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
42329
42357
|
*/
|
|
42330
|
-
onFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
42358
|
+
onFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
42331
42359
|
/**
|
|
42332
42360
|
* Fires on the owning Grid when cell editing is finished
|
|
42333
42361
|
* @param {object} event Event object
|
|
@@ -42375,7 +42403,7 @@ type TreeGridConfig = {
|
|
|
42375
42403
|
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
42376
42404
|
* @param {MouseEvent,TouchEvent} event.event
|
|
42377
42405
|
*/
|
|
42378
|
-
onGridRowBeforeDragStart?: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
42406
|
+
onGridRowBeforeDragStart?: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void)|string
|
|
42379
42407
|
/**
|
|
42380
42408
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
42381
42409
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
@@ -42442,7 +42470,7 @@ type TreeGridConfig = {
|
|
|
42442
42470
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
42443
42471
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
42444
42472
|
*/
|
|
42445
|
-
onHeaderClick?: ((event: { domEvent: Event, column: Column }) =>
|
|
42473
|
+
onHeaderClick?: ((event: { domEvent: Event, column: Column }) => boolean|void)|string
|
|
42446
42474
|
/**
|
|
42447
42475
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
42448
42476
|
* 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 +42481,7 @@ type TreeGridConfig = {
|
|
|
42453
42481
|
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
42454
42482
|
* @param {Grid.column.Column} event.column Column
|
|
42455
42483
|
*/
|
|
42456
|
-
onHeaderMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
42484
|
+
onHeaderMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void)|string
|
|
42457
42485
|
/**
|
|
42458
42486
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
42459
42487
|
* @param {object} event Event object
|
|
@@ -42664,7 +42692,7 @@ type TreeGridConfig = {
|
|
|
42664
42692
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
42665
42693
|
* @param {Event} event.domEvent The native DOM event
|
|
42666
42694
|
*/
|
|
42667
|
-
onSplitterCollapseClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
42695
|
+
onSplitterCollapseClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
42668
42696
|
/**
|
|
42669
42697
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
42670
42698
|
* @param {object} event Event object
|
|
@@ -42689,7 +42717,7 @@ type TreeGridConfig = {
|
|
|
42689
42717
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
42690
42718
|
* @param {Event} event.domEvent The native DOM event
|
|
42691
42719
|
*/
|
|
42692
|
-
onSplitterExpandClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
42720
|
+
onSplitterExpandClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
42693
42721
|
/**
|
|
42694
42722
|
* Fires on the owning Grid when editing starts
|
|
42695
42723
|
* @param {object} event Event object
|
|
@@ -42799,19 +42827,19 @@ export class TreeGrid extends Grid {
|
|
|
42799
42827
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
42800
42828
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
42801
42829
|
*/
|
|
42802
|
-
onBeforeSelectionChange: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
42830
|
+
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
42831
|
/**
|
|
42804
42832
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
42805
42833
|
* @param {object} event Event object
|
|
42806
42834
|
* @param {GridStateInfo} event.state State object config
|
|
42807
42835
|
*/
|
|
42808
|
-
onBeforeStateApply: ((event: { state: GridStateInfo }) =>
|
|
42836
|
+
onBeforeStateApply: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
42809
42837
|
/**
|
|
42810
42838
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
42811
42839
|
* @param {object} event Event object
|
|
42812
42840
|
* @param {GridStateInfo} event.state State object config
|
|
42813
42841
|
*/
|
|
42814
|
-
onBeforeStateSave: ((event: { state: GridStateInfo }) =>
|
|
42842
|
+
onBeforeStateSave: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
42815
42843
|
/**
|
|
42816
42844
|
* Fires when any other event is fired from the object.
|
|
42817
42845
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-catchAll)
|
|
@@ -42917,7 +42945,7 @@ export class TreeGrid extends Grid {
|
|
|
42917
42945
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
42918
42946
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
42919
42947
|
*/
|
|
42920
|
-
onHeaderClick: ((event: { domEvent: Event, column: Column }) =>
|
|
42948
|
+
onHeaderClick: ((event: { domEvent: Event, column: Column }) => boolean|void)|string
|
|
42921
42949
|
/**
|
|
42922
42950
|
* Mouse moved out from element in grid
|
|
42923
42951
|
* @param {object} event Event object
|
|
@@ -43031,7 +43059,7 @@ type ExportDialogListenersTypes = {
|
|
|
43031
43059
|
* @param {object} event Event object
|
|
43032
43060
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
43033
43061
|
*/
|
|
43034
|
-
beforeHide: (event: { source: Widget }) =>
|
|
43062
|
+
beforeHide: (event: { source: Widget }) => boolean|void
|
|
43035
43063
|
/**
|
|
43036
43064
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
43037
43065
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -43051,13 +43079,13 @@ type ExportDialogListenersTypes = {
|
|
|
43051
43079
|
* @param {object} event Event object
|
|
43052
43080
|
* @param {any} event.state State object config
|
|
43053
43081
|
*/
|
|
43054
|
-
beforeStateApply: (event: { state: any }) =>
|
|
43082
|
+
beforeStateApply: (event: { state: any }) => boolean|void
|
|
43055
43083
|
/**
|
|
43056
43084
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
43057
43085
|
* @param {object} event Event object
|
|
43058
43086
|
* @param {any} event.state State object config
|
|
43059
43087
|
*/
|
|
43060
|
-
beforeStateSave: (event: { state: any }) =>
|
|
43088
|
+
beforeStateSave: (event: { state: any }) => boolean|void
|
|
43061
43089
|
/**
|
|
43062
43090
|
* Fires when cancel button is clicked. Popup will hide itself.
|
|
43063
43091
|
*/
|
|
@@ -43208,7 +43236,7 @@ type ExportDialogListeners = {
|
|
|
43208
43236
|
* @param {object} event Event object
|
|
43209
43237
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
43210
43238
|
*/
|
|
43211
|
-
beforeHide?: ((event: { source: Widget }) =>
|
|
43239
|
+
beforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
43212
43240
|
/**
|
|
43213
43241
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
43214
43242
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -43228,13 +43256,13 @@ type ExportDialogListeners = {
|
|
|
43228
43256
|
* @param {object} event Event object
|
|
43229
43257
|
* @param {any} event.state State object config
|
|
43230
43258
|
*/
|
|
43231
|
-
beforeStateApply?: ((event: { state: any }) =>
|
|
43259
|
+
beforeStateApply?: ((event: { state: any }) => boolean|void)|string
|
|
43232
43260
|
/**
|
|
43233
43261
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
43234
43262
|
* @param {object} event Event object
|
|
43235
43263
|
* @param {any} event.state State object config
|
|
43236
43264
|
*/
|
|
43237
|
-
beforeStateSave?: ((event: { state: any }) =>
|
|
43265
|
+
beforeStateSave?: ((event: { state: any }) => boolean|void)|string
|
|
43238
43266
|
/**
|
|
43239
43267
|
* Fires when cancel button is clicked. Popup will hide itself.
|
|
43240
43268
|
*/
|
|
@@ -43388,6 +43416,8 @@ type ExportDialogConfig = {
|
|
|
43388
43416
|
/**
|
|
43389
43417
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
43390
43418
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
43419
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
43420
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/export/ExportDialog#config-appendTo)
|
|
43391
43421
|
*/
|
|
43392
43422
|
appendTo?: HTMLElement|string
|
|
43393
43423
|
/**
|
|
@@ -43689,10 +43719,14 @@ type ExportDialogConfig = {
|
|
|
43689
43719
|
inputFieldAlign?: 'start'|'end'
|
|
43690
43720
|
/**
|
|
43691
43721
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
43722
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
43723
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/export/ExportDialog#config-insertBefore)
|
|
43692
43724
|
*/
|
|
43693
43725
|
insertBefore?: HTMLElement|string
|
|
43694
43726
|
/**
|
|
43695
43727
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
43728
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
43729
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/export/ExportDialog#config-insertFirst)
|
|
43696
43730
|
*/
|
|
43697
43731
|
insertFirst?: HTMLElement|string
|
|
43698
43732
|
/**
|
|
@@ -44100,7 +44134,7 @@ type ExportDialogConfig = {
|
|
|
44100
44134
|
* @param {object} event Event object
|
|
44101
44135
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
44102
44136
|
*/
|
|
44103
|
-
onBeforeHide?: ((event: { source: Widget }) =>
|
|
44137
|
+
onBeforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
44104
44138
|
/**
|
|
44105
44139
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
44106
44140
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -44120,13 +44154,13 @@ type ExportDialogConfig = {
|
|
|
44120
44154
|
* @param {object} event Event object
|
|
44121
44155
|
* @param {any} event.state State object config
|
|
44122
44156
|
*/
|
|
44123
|
-
onBeforeStateApply?: ((event: { state: any }) =>
|
|
44157
|
+
onBeforeStateApply?: ((event: { state: any }) => boolean|void)|string
|
|
44124
44158
|
/**
|
|
44125
44159
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
44126
44160
|
* @param {object} event Event object
|
|
44127
44161
|
* @param {any} event.state State object config
|
|
44128
44162
|
*/
|
|
44129
|
-
onBeforeStateSave?: ((event: { state: any }) =>
|
|
44163
|
+
onBeforeStateSave?: ((event: { state: any }) => boolean|void)|string
|
|
44130
44164
|
/**
|
|
44131
44165
|
* Fires when cancel button is clicked. Popup will hide itself.
|
|
44132
44166
|
*/
|
|
@@ -44285,13 +44319,13 @@ export class ExportDialog extends Popup {
|
|
|
44285
44319
|
* @param {object} event Event object
|
|
44286
44320
|
* @param {any} event.state State object config
|
|
44287
44321
|
*/
|
|
44288
|
-
onBeforeStateApply: ((event: { state: any }) =>
|
|
44322
|
+
onBeforeStateApply: ((event: { state: any }) => boolean|void)|string
|
|
44289
44323
|
/**
|
|
44290
44324
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
44291
44325
|
* @param {object} event Event object
|
|
44292
44326
|
* @param {any} event.state State object config
|
|
44293
44327
|
*/
|
|
44294
|
-
onBeforeStateSave: ((event: { state: any }) =>
|
|
44328
|
+
onBeforeStateSave: ((event: { state: any }) => boolean|void)|string
|
|
44295
44329
|
/**
|
|
44296
44330
|
* Fires when cancel button is clicked. Popup will hide itself.
|
|
44297
44331
|
*/
|
|
@@ -44422,7 +44456,7 @@ type GridElementEventsClassConfig = {
|
|
|
44422
44456
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
44423
44457
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
44424
44458
|
*/
|
|
44425
|
-
onHeaderClick?: ((event: { domEvent: Event, column: Column }) =>
|
|
44459
|
+
onHeaderClick?: ((event: { domEvent: Event, column: Column }) => boolean|void)|string
|
|
44426
44460
|
/**
|
|
44427
44461
|
* Mouse moved out from element in grid
|
|
44428
44462
|
* @param {object} event Event object
|
|
@@ -44560,7 +44594,7 @@ export class GridElementEventsClass {
|
|
|
44560
44594
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
44561
44595
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
44562
44596
|
*/
|
|
44563
|
-
onHeaderClick: ((event: { domEvent: Event, column: Column }) =>
|
|
44597
|
+
onHeaderClick: ((event: { domEvent: Event, column: Column }) => boolean|void)|string
|
|
44564
44598
|
/**
|
|
44565
44599
|
* Mouse moved out from element in grid
|
|
44566
44600
|
* @param {object} event Event object
|
|
@@ -44716,7 +44750,7 @@ type GridSelectionClassConfig = {
|
|
|
44716
44750
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
44717
44751
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
44718
44752
|
*/
|
|
44719
|
-
onBeforeSelectionChange?: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
44753
|
+
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
44754
|
/**
|
|
44721
44755
|
* Fires while drag selecting. UI will update with current range, but the cells will not be selected until
|
|
44722
44756
|
* mouse up. This event can be listened for to perform actions while drag selecting.
|
|
@@ -44802,7 +44836,7 @@ export class GridSelectionClass {
|
|
|
44802
44836
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
44803
44837
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
44804
44838
|
*/
|
|
44805
|
-
onBeforeSelectionChange: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
44839
|
+
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
44840
|
/**
|
|
44807
44841
|
* Fires while drag selecting. UI will update with current range, but the cells will not be selected until
|
|
44808
44842
|
* mouse up. This event can be listened for to perform actions while drag selecting.
|
|
@@ -44960,13 +44994,13 @@ type GridStateClassConfig = {
|
|
|
44960
44994
|
* @param {object} event Event object
|
|
44961
44995
|
* @param {GridStateInfo} event.state State object config
|
|
44962
44996
|
*/
|
|
44963
|
-
onBeforeStateApply?: ((event: { state: GridStateInfo }) =>
|
|
44997
|
+
onBeforeStateApply?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
44964
44998
|
/**
|
|
44965
44999
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
44966
45000
|
* @param {object} event Event object
|
|
44967
45001
|
* @param {GridStateInfo} event.state State object config
|
|
44968
45002
|
*/
|
|
44969
|
-
onBeforeStateSave?: ((event: { state: GridStateInfo }) =>
|
|
45003
|
+
onBeforeStateSave?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
44970
45004
|
}
|
|
44971
45005
|
|
|
44972
45006
|
export class GridStateClass {
|
|
@@ -44993,13 +45027,13 @@ export class GridStateClass {
|
|
|
44993
45027
|
* @param {object} event Event object
|
|
44994
45028
|
* @param {GridStateInfo} event.state State object config
|
|
44995
45029
|
*/
|
|
44996
|
-
onBeforeStateApply: ((event: { state: GridStateInfo }) =>
|
|
45030
|
+
onBeforeStateApply: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
44997
45031
|
/**
|
|
44998
45032
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
44999
45033
|
* @param {object} event Event object
|
|
45000
45034
|
* @param {GridStateInfo} event.state State object config
|
|
45001
45035
|
*/
|
|
45002
|
-
onBeforeStateSave: ((event: { state: GridStateInfo }) =>
|
|
45036
|
+
onBeforeStateSave: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
45003
45037
|
/**
|
|
45004
45038
|
* Creates an instance of the class using the supplied configuration
|
|
45005
45039
|
* @param {GridStateClassConfig} [config]
|
|
@@ -45066,7 +45100,7 @@ type AIFilterFieldListenersTypes = {
|
|
|
45066
45100
|
* @param {object} event Event object
|
|
45067
45101
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
45068
45102
|
*/
|
|
45069
|
-
beforeHide: (event: { source: Widget }) =>
|
|
45103
|
+
beforeHide: (event: { source: Widget }) => boolean|void
|
|
45070
45104
|
/**
|
|
45071
45105
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
45072
45106
|
* @param {object} event Event object
|
|
@@ -45228,7 +45262,7 @@ type AIFilterFieldListeners = {
|
|
|
45228
45262
|
* @param {object} event Event object
|
|
45229
45263
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
45230
45264
|
*/
|
|
45231
|
-
beforeHide?: ((event: { source: Widget }) =>
|
|
45265
|
+
beforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
45232
45266
|
/**
|
|
45233
45267
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
45234
45268
|
* @param {object} event Event object
|
|
@@ -45387,6 +45421,8 @@ type AIFilterFieldConfig = {
|
|
|
45387
45421
|
/**
|
|
45388
45422
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
45389
45423
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
45424
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
45425
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-appendTo)
|
|
45390
45426
|
*/
|
|
45391
45427
|
appendTo?: HTMLElement|string
|
|
45392
45428
|
/**
|
|
@@ -45436,6 +45472,15 @@ type AIFilterFieldConfig = {
|
|
|
45436
45472
|
* Set to `true` to centre the Widget in browser viewport space.
|
|
45437
45473
|
*/
|
|
45438
45474
|
centered?: boolean
|
|
45475
|
+
/**
|
|
45476
|
+
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
45477
|
+
* 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)
|
|
45478
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-required) check.
|
|
45479
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-checkValidity)
|
|
45480
|
+
* @param {Core.widget.Field} field The field being validated
|
|
45481
|
+
* @returns {void}
|
|
45482
|
+
*/
|
|
45483
|
+
checkValidity?: ((field: Field) => void)|string
|
|
45439
45484
|
/**
|
|
45440
45485
|
* 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
45486
|
* 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
|
|
@@ -45642,10 +45687,14 @@ type AIFilterFieldConfig = {
|
|
|
45642
45687
|
inputWidth?: string|number
|
|
45643
45688
|
/**
|
|
45644
45689
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
45690
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
45691
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-insertBefore)
|
|
45645
45692
|
*/
|
|
45646
45693
|
insertBefore?: HTMLElement|string
|
|
45647
45694
|
/**
|
|
45648
45695
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
45696
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
45697
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-insertFirst)
|
|
45649
45698
|
*/
|
|
45650
45699
|
insertFirst?: HTMLElement|string
|
|
45651
45700
|
/**
|
|
@@ -45990,7 +46039,7 @@ type AIFilterFieldConfig = {
|
|
|
45990
46039
|
* @param {object} event Event object
|
|
45991
46040
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
45992
46041
|
*/
|
|
45993
|
-
onBeforeHide?: ((event: { source: Widget }) =>
|
|
46042
|
+
onBeforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
45994
46043
|
/**
|
|
45995
46044
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
45996
46045
|
* @param {object} event Event object
|
|
@@ -46187,7 +46236,7 @@ type ChecklistFilterComboListenersTypes = {
|
|
|
46187
46236
|
* @param {object} event Event object
|
|
46188
46237
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
46189
46238
|
*/
|
|
46190
|
-
beforeHide: (event: { source: Widget }) =>
|
|
46239
|
+
beforeHide: (event: { source: Widget }) => boolean|void
|
|
46191
46240
|
/**
|
|
46192
46241
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
46193
46242
|
* @param {object} event Event object
|
|
@@ -46355,7 +46404,7 @@ type ChecklistFilterComboListeners = {
|
|
|
46355
46404
|
* @param {object} event Event object
|
|
46356
46405
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
46357
46406
|
*/
|
|
46358
|
-
beforeHide?: ((event: { source: Widget }) =>
|
|
46407
|
+
beforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
46359
46408
|
/**
|
|
46360
46409
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
46361
46410
|
* @param {object} event Event object
|
|
@@ -46524,6 +46573,8 @@ type ChecklistFilterComboConfig = {
|
|
|
46524
46573
|
/**
|
|
46525
46574
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
46526
46575
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
46576
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
46577
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-appendTo)
|
|
46527
46578
|
*/
|
|
46528
46579
|
appendTo?: HTMLElement|string
|
|
46529
46580
|
/**
|
|
@@ -46586,6 +46637,15 @@ type ChecklistFilterComboConfig = {
|
|
|
46586
46637
|
* Set to `true` to centre the Widget in browser viewport space.
|
|
46587
46638
|
*/
|
|
46588
46639
|
centered?: boolean
|
|
46640
|
+
/**
|
|
46641
|
+
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
46642
|
+
* 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)
|
|
46643
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-required) check.
|
|
46644
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-checkValidity)
|
|
46645
|
+
* @param {Core.widget.Field} field The field being validated
|
|
46646
|
+
* @returns {void}
|
|
46647
|
+
*/
|
|
46648
|
+
checkValidity?: ((field: Field) => void)|string
|
|
46589
46649
|
/**
|
|
46590
46650
|
* A config object to configure the [ChipView](https://bryntum.com/products/grid/docs/api/Core/widget/ChipView) to display the
|
|
46591
46651
|
* selected value set when [multiSelect](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-multiSelect) is `true`.
|
|
@@ -46877,10 +46937,14 @@ type ChecklistFilterComboConfig = {
|
|
|
46877
46937
|
inputWidth?: string|number
|
|
46878
46938
|
/**
|
|
46879
46939
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
46940
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
46941
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-insertBefore)
|
|
46880
46942
|
*/
|
|
46881
46943
|
insertBefore?: HTMLElement|string
|
|
46882
46944
|
/**
|
|
46883
46945
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
46946
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
46947
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-insertFirst)
|
|
46884
46948
|
*/
|
|
46885
46949
|
insertFirst?: HTMLElement|string
|
|
46886
46950
|
/**
|
|
@@ -47309,7 +47373,7 @@ type ChecklistFilterComboConfig = {
|
|
|
47309
47373
|
* @param {object} event Event object
|
|
47310
47374
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
47311
47375
|
*/
|
|
47312
|
-
onBeforeHide?: ((event: { source: Widget }) =>
|
|
47376
|
+
onBeforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
47313
47377
|
/**
|
|
47314
47378
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
47315
47379
|
* @param {object} event Event object
|
|
@@ -47518,7 +47582,7 @@ type GridChartDesignerListenersTypes = {
|
|
|
47518
47582
|
* @param {object} event Event object
|
|
47519
47583
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
47520
47584
|
*/
|
|
47521
|
-
beforeHide: (event: { source: Widget }) =>
|
|
47585
|
+
beforeHide: (event: { source: Widget }) => boolean|void
|
|
47522
47586
|
/**
|
|
47523
47587
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
47524
47588
|
* @param {object} event Event object
|
|
@@ -47632,7 +47696,7 @@ type GridChartDesignerListeners = {
|
|
|
47632
47696
|
* @param {object} event Event object
|
|
47633
47697
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
47634
47698
|
*/
|
|
47635
|
-
beforeHide?: ((event: { source: Widget }) =>
|
|
47699
|
+
beforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
47636
47700
|
/**
|
|
47637
47701
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
47638
47702
|
* @param {object} event Event object
|
|
@@ -47757,6 +47821,8 @@ type GridChartDesignerConfig = {
|
|
|
47757
47821
|
/**
|
|
47758
47822
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
47759
47823
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
47824
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
47825
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridChartDesigner#config-appendTo)
|
|
47760
47826
|
*/
|
|
47761
47827
|
appendTo?: HTMLElement|string
|
|
47762
47828
|
/**
|
|
@@ -47932,10 +47998,14 @@ type GridChartDesignerConfig = {
|
|
|
47932
47998
|
ignoreParentReadOnly?: boolean
|
|
47933
47999
|
/**
|
|
47934
48000
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
48001
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
48002
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridChartDesigner#config-insertBefore)
|
|
47935
48003
|
*/
|
|
47936
48004
|
insertBefore?: HTMLElement|string
|
|
47937
48005
|
/**
|
|
47938
48006
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
48007
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
48008
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridChartDesigner#config-insertFirst)
|
|
47939
48009
|
*/
|
|
47940
48010
|
insertFirst?: HTMLElement|string
|
|
47941
48011
|
/**
|
|
@@ -48174,7 +48244,7 @@ type GridChartDesignerConfig = {
|
|
|
48174
48244
|
* @param {object} event Event object
|
|
48175
48245
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
48176
48246
|
*/
|
|
48177
|
-
onBeforeHide?: ((event: { source: Widget }) =>
|
|
48247
|
+
onBeforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
48178
48248
|
/**
|
|
48179
48249
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
48180
48250
|
* @param {object} event Event object
|
|
@@ -48326,7 +48396,7 @@ type GridFieldFilterPickerListenersTypes = {
|
|
|
48326
48396
|
* @param {object} event Event object
|
|
48327
48397
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
48328
48398
|
*/
|
|
48329
|
-
beforeHide: (event: { source: Widget }) =>
|
|
48399
|
+
beforeHide: (event: { source: Widget }) => boolean|void
|
|
48330
48400
|
/**
|
|
48331
48401
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
48332
48402
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -48463,7 +48533,7 @@ type GridFieldFilterPickerListeners = {
|
|
|
48463
48533
|
* @param {object} event Event object
|
|
48464
48534
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
48465
48535
|
*/
|
|
48466
|
-
beforeHide?: ((event: { source: Widget }) =>
|
|
48536
|
+
beforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
48467
48537
|
/**
|
|
48468
48538
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
48469
48539
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -48618,6 +48688,8 @@ type GridFieldFilterPickerConfig = {
|
|
|
48618
48688
|
/**
|
|
48619
48689
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
48620
48690
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
48691
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
48692
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-appendTo)
|
|
48621
48693
|
*/
|
|
48622
48694
|
appendTo?: HTMLElement|string
|
|
48623
48695
|
/**
|
|
@@ -48852,10 +48924,14 @@ type GridFieldFilterPickerConfig = {
|
|
|
48852
48924
|
inputFieldAlign?: 'start'|'end'
|
|
48853
48925
|
/**
|
|
48854
48926
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
48927
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
48928
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-insertBefore)
|
|
48855
48929
|
*/
|
|
48856
48930
|
insertBefore?: HTMLElement|string
|
|
48857
48931
|
/**
|
|
48858
48932
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
48933
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
48934
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-insertFirst)
|
|
48859
48935
|
*/
|
|
48860
48936
|
insertFirst?: HTMLElement|string
|
|
48861
48937
|
/**
|
|
@@ -49190,7 +49266,7 @@ type GridFieldFilterPickerConfig = {
|
|
|
49190
49266
|
* @param {object} event Event object
|
|
49191
49267
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
49192
49268
|
*/
|
|
49193
|
-
onBeforeHide?: ((event: { source: Widget }) =>
|
|
49269
|
+
onBeforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
49194
49270
|
/**
|
|
49195
49271
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
49196
49272
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -49362,7 +49438,7 @@ type GridFieldFilterPickerGroupListenersTypes = {
|
|
|
49362
49438
|
* @param {Core.widget.FieldFilterPicker} event.source The FieldFilterPicker instance that fired the event.
|
|
49363
49439
|
* @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
49440
|
*/
|
|
49365
|
-
beforeAddFilter: (event: { source: FieldFilterPicker, filter: CollectionFilterConfig }) =>
|
|
49441
|
+
beforeAddFilter: (event: { source: FieldFilterPicker, filter: CollectionFilterConfig }) => boolean|void
|
|
49366
49442
|
/**
|
|
49367
49443
|
* Fires before an object is destroyed.
|
|
49368
49444
|
* @param {object} event Event object
|
|
@@ -49374,7 +49450,7 @@ type GridFieldFilterPickerGroupListenersTypes = {
|
|
|
49374
49450
|
* @param {object} event Event object
|
|
49375
49451
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
49376
49452
|
*/
|
|
49377
|
-
beforeHide: (event: { source: Widget }) =>
|
|
49453
|
+
beforeHide: (event: { source: Widget }) => boolean|void
|
|
49378
49454
|
/**
|
|
49379
49455
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
49380
49456
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -49507,7 +49583,7 @@ type GridFieldFilterPickerGroupListeners = {
|
|
|
49507
49583
|
* @param {Core.widget.FieldFilterPicker} event.source The FieldFilterPicker instance that fired the event.
|
|
49508
49584
|
* @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
49585
|
*/
|
|
49510
|
-
beforeAddFilter?: ((event: { source: FieldFilterPicker, filter: CollectionFilterConfig }) =>
|
|
49586
|
+
beforeAddFilter?: ((event: { source: FieldFilterPicker, filter: CollectionFilterConfig }) => boolean|void)|string
|
|
49511
49587
|
/**
|
|
49512
49588
|
* Fires before an object is destroyed.
|
|
49513
49589
|
* @param {object} event Event object
|
|
@@ -49519,7 +49595,7 @@ type GridFieldFilterPickerGroupListeners = {
|
|
|
49519
49595
|
* @param {object} event Event object
|
|
49520
49596
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
49521
49597
|
*/
|
|
49522
|
-
beforeHide?: ((event: { source: Widget }) =>
|
|
49598
|
+
beforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
49523
49599
|
/**
|
|
49524
49600
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
49525
49601
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -49677,6 +49753,8 @@ type GridFieldFilterPickerGroupConfig = {
|
|
|
49677
49753
|
/**
|
|
49678
49754
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
49679
49755
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
49756
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
49757
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-appendTo)
|
|
49680
49758
|
*/
|
|
49681
49759
|
appendTo?: HTMLElement|string
|
|
49682
49760
|
/**
|
|
@@ -49923,10 +50001,14 @@ type GridFieldFilterPickerGroupConfig = {
|
|
|
49923
50001
|
inputFieldAlign?: 'start'|'end'
|
|
49924
50002
|
/**
|
|
49925
50003
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
50004
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
50005
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-insertBefore)
|
|
49926
50006
|
*/
|
|
49927
50007
|
insertBefore?: HTMLElement|string
|
|
49928
50008
|
/**
|
|
49929
50009
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
50010
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
50011
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-insertFirst)
|
|
49930
50012
|
*/
|
|
49931
50013
|
insertFirst?: HTMLElement|string
|
|
49932
50014
|
/**
|
|
@@ -50248,7 +50330,7 @@ type GridFieldFilterPickerGroupConfig = {
|
|
|
50248
50330
|
* @param {Core.widget.FieldFilterPicker} event.source The FieldFilterPicker instance that fired the event.
|
|
50249
50331
|
* @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
50332
|
*/
|
|
50251
|
-
onBeforeAddFilter?: ((event: { source: FieldFilterPicker, filter: CollectionFilterConfig }) =>
|
|
50333
|
+
onBeforeAddFilter?: ((event: { source: FieldFilterPicker, filter: CollectionFilterConfig }) => boolean|void)|string
|
|
50252
50334
|
/**
|
|
50253
50335
|
* Fires before an object is destroyed.
|
|
50254
50336
|
* @param {object} event Event object
|
|
@@ -50260,7 +50342,7 @@ type GridFieldFilterPickerGroupConfig = {
|
|
|
50260
50342
|
* @param {object} event Event object
|
|
50261
50343
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
50262
50344
|
*/
|
|
50263
|
-
onBeforeHide?: ((event: { source: Widget }) =>
|
|
50345
|
+
onBeforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
50264
50346
|
/**
|
|
50265
50347
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
50266
50348
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -50436,7 +50518,7 @@ type GroupBarListenersTypes = {
|
|
|
50436
50518
|
* @param {object} event Event object
|
|
50437
50519
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
50438
50520
|
*/
|
|
50439
|
-
beforeHide: (event: { source: Widget }) =>
|
|
50521
|
+
beforeHide: (event: { source: Widget }) => boolean|void
|
|
50440
50522
|
/**
|
|
50441
50523
|
* User going to activate an item in the list either by pointer or keyboard.
|
|
50442
50524
|
* The active record, list item index, and the triggering event are passed.
|
|
@@ -50448,7 +50530,7 @@ type GroupBarListenersTypes = {
|
|
|
50448
50530
|
* @param {number} event.index List item index
|
|
50449
50531
|
* @param {Event} event.event Triggering event
|
|
50450
50532
|
*/
|
|
50451
|
-
beforeItem: (event: { source: List, item: HTMLElement, record: Model, index: number, event: Event }) =>
|
|
50533
|
+
beforeItem: (event: { source: List, item: HTMLElement, record: Model, index: number, event: Event }) => boolean|void
|
|
50452
50534
|
/**
|
|
50453
50535
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
50454
50536
|
* @param {object} event Event object
|
|
@@ -50594,7 +50676,7 @@ type GroupBarListeners = {
|
|
|
50594
50676
|
* @param {object} event Event object
|
|
50595
50677
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
50596
50678
|
*/
|
|
50597
|
-
beforeHide?: ((event: { source: Widget }) =>
|
|
50679
|
+
beforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
50598
50680
|
/**
|
|
50599
50681
|
* User going to activate an item in the list either by pointer or keyboard.
|
|
50600
50682
|
* The active record, list item index, and the triggering event are passed.
|
|
@@ -50606,7 +50688,7 @@ type GroupBarListeners = {
|
|
|
50606
50688
|
* @param {number} event.index List item index
|
|
50607
50689
|
* @param {Event} event.event Triggering event
|
|
50608
50690
|
*/
|
|
50609
|
-
beforeItem?: ((event: { source: List, item: HTMLElement, record: Model, index: number, event: Event }) =>
|
|
50691
|
+
beforeItem?: ((event: { source: List, item: HTMLElement, record: Model, index: number, event: Event }) => boolean|void)|string
|
|
50610
50692
|
/**
|
|
50611
50693
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
50612
50694
|
* @param {object} event Event object
|
|
@@ -50773,6 +50855,8 @@ type GroupBarConfig = {
|
|
|
50773
50855
|
/**
|
|
50774
50856
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
50775
50857
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
50858
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
50859
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-appendTo)
|
|
50776
50860
|
*/
|
|
50777
50861
|
appendTo?: HTMLElement|string
|
|
50778
50862
|
/**
|
|
@@ -50822,9 +50906,11 @@ type GroupBarConfig = {
|
|
|
50822
50906
|
/**
|
|
50823
50907
|
* If [closable](https://bryntum.com/products/grid/docs/api/Core/widget/ChipView#config-closable) is `true`, this is the name of a callback function to handle what the "close"
|
|
50824
50908
|
* action means. If not provided, the record representing the chip is removed from the store.
|
|
50909
|
+
* @param {Core.data.Model[]} records Records to be closed
|
|
50910
|
+
* @param {object} options Close options
|
|
50825
50911
|
* @returns {void}
|
|
50826
50912
|
*/
|
|
50827
|
-
closeHandler?: string|(() => void)
|
|
50913
|
+
closeHandler?: string|((records: Model[], options: object) => void)
|
|
50828
50914
|
/**
|
|
50829
50915
|
* Custom CSS classes to add to element.
|
|
50830
50916
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -50999,10 +51085,14 @@ type GroupBarConfig = {
|
|
|
50999
51085
|
ignoreParentReadOnly?: boolean
|
|
51000
51086
|
/**
|
|
51001
51087
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
51088
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
51089
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-insertBefore)
|
|
51002
51090
|
*/
|
|
51003
51091
|
insertBefore?: HTMLElement|string
|
|
51004
51092
|
/**
|
|
51005
51093
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
51094
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
51095
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-insertFirst)
|
|
51006
51096
|
*/
|
|
51007
51097
|
insertFirst?: HTMLElement|string
|
|
51008
51098
|
/**
|
|
@@ -51293,7 +51383,7 @@ type GroupBarConfig = {
|
|
|
51293
51383
|
* @param {object} event Event object
|
|
51294
51384
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
51295
51385
|
*/
|
|
51296
|
-
onBeforeHide?: ((event: { source: Widget }) =>
|
|
51386
|
+
onBeforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
51297
51387
|
/**
|
|
51298
51388
|
* User going to activate an item in the list either by pointer or keyboard.
|
|
51299
51389
|
* The active record, list item index, and the triggering event are passed.
|
|
@@ -51305,7 +51395,7 @@ type GroupBarConfig = {
|
|
|
51305
51395
|
* @param {number} event.index List item index
|
|
51306
51396
|
* @param {Event} event.event Triggering event
|
|
51307
51397
|
*/
|
|
51308
|
-
onBeforeItem?: ((event: { source: List, item: HTMLElement, record: Model, index: number, event: Event }) =>
|
|
51398
|
+
onBeforeItem?: ((event: { source: List, item: HTMLElement, record: Model, index: number, event: Event }) => boolean|void)|string
|
|
51309
51399
|
/**
|
|
51310
51400
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
51311
51401
|
* @param {object} event Event object
|
|
@@ -51495,7 +51585,7 @@ type TreeComboListenersTypes = {
|
|
|
51495
51585
|
* @param {object} event Event object
|
|
51496
51586
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
51497
51587
|
*/
|
|
51498
|
-
beforeHide: (event: { source: Widget }) =>
|
|
51588
|
+
beforeHide: (event: { source: Widget }) => boolean|void
|
|
51499
51589
|
/**
|
|
51500
51590
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
51501
51591
|
* @param {object} event Event object
|
|
@@ -51663,7 +51753,7 @@ type TreeComboListeners = {
|
|
|
51663
51753
|
* @param {object} event Event object
|
|
51664
51754
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
51665
51755
|
*/
|
|
51666
|
-
beforeHide?: ((event: { source: Widget }) =>
|
|
51756
|
+
beforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
51667
51757
|
/**
|
|
51668
51758
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
51669
51759
|
* @param {object} event Event object
|
|
@@ -51832,6 +51922,8 @@ type TreeComboConfig = {
|
|
|
51832
51922
|
/**
|
|
51833
51923
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
51834
51924
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
51925
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
51926
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-appendTo)
|
|
51835
51927
|
*/
|
|
51836
51928
|
appendTo?: HTMLElement|string
|
|
51837
51929
|
/**
|
|
@@ -51894,6 +51986,15 @@ type TreeComboConfig = {
|
|
|
51894
51986
|
* Set to `true` to centre the Widget in browser viewport space.
|
|
51895
51987
|
*/
|
|
51896
51988
|
centered?: boolean
|
|
51989
|
+
/**
|
|
51990
|
+
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
51991
|
+
* 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)
|
|
51992
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-required) check.
|
|
51993
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-checkValidity)
|
|
51994
|
+
* @param {Core.widget.Field} field The field being validated
|
|
51995
|
+
* @returns {void}
|
|
51996
|
+
*/
|
|
51997
|
+
checkValidity?: ((field: Field) => void)|string
|
|
51897
51998
|
/**
|
|
51898
51999
|
* A config object to configure the [ChipView](https://bryntum.com/products/grid/docs/api/Core/widget/ChipView) to display the
|
|
51899
52000
|
* selected value set when [multiSelect](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-multiSelect) is `true`.
|
|
@@ -52185,10 +52286,14 @@ type TreeComboConfig = {
|
|
|
52185
52286
|
inputWidth?: string|number
|
|
52186
52287
|
/**
|
|
52187
52288
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
52289
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
52290
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-insertBefore)
|
|
52188
52291
|
*/
|
|
52189
52292
|
insertBefore?: HTMLElement|string
|
|
52190
52293
|
/**
|
|
52191
52294
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
52295
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
52296
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-insertFirst)
|
|
52192
52297
|
*/
|
|
52193
52298
|
insertFirst?: HTMLElement|string
|
|
52194
52299
|
/**
|
|
@@ -52608,7 +52713,7 @@ type TreeComboConfig = {
|
|
|
52608
52713
|
* @param {object} event Event object
|
|
52609
52714
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
52610
52715
|
*/
|
|
52611
|
-
onBeforeHide?: ((event: { source: Widget }) =>
|
|
52716
|
+
onBeforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
52612
52717
|
/**
|
|
52613
52718
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
52614
52719
|
* @param {object} event Event object
|