@bryntum/grid-trial 7.1.2 → 7.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -1
- package/fluent2-dark.css +1 -1
- package/fluent2-light.css +1 -1
- package/grid.css +2 -2
- package/grid.d.ts +388 -228
- package/grid.lwc.module.d.ts +1 -1
- package/grid.lwc.module.js +2 -2
- package/grid.module.d.ts +1 -1
- package/grid.module.js +40 -40
- package/grid.thin.d.ts +388 -228
- package/grid.umd.d.ts +1 -1
- package/grid.umd.js +45 -45
- package/grid.wc.module.d.ts +1 -1
- package/grid.wc.module.js +39 -39
- package/high-contrast-dark.css +1 -1
- package/high-contrast-light.css +1 -1
- package/material3-dark.css +1 -1
- package/material3-light.css +1 -1
- package/package.json +1 -1
- package/stockholm-dark.css +1 -1
- package/stockholm-light.css +1 -1
- package/svalbard-dark.css +1 -1
- package/svalbard-light.css +1 -1
- package/visby-dark.css +1 -1
- package/visby-light.css +1 -1
package/grid.thin.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/*!
|
|
2
2
|
*
|
|
3
|
-
* Bryntum Grid 7.1.
|
|
3
|
+
* Bryntum Grid 7.1.3 (TRIAL VERSION)
|
|
4
4
|
*
|
|
5
5
|
* Copyright(c) 2026 Bryntum AB
|
|
6
6
|
* https://bryntum.com/contact
|
|
@@ -7215,8 +7215,8 @@ type DateColumnConfig = {
|
|
|
7215
7215
|
*/
|
|
7216
7216
|
remoteChildCount?: number
|
|
7217
7217
|
/**
|
|
7218
|
-
* Renderer function, used to style the date displayed in the cell. Can also affect other aspects of
|
|
7219
|
-
*
|
|
7218
|
+
* Renderer function, used to style the date displayed in the cell. Can also affect other aspects of the cell,
|
|
7219
|
+
* such as styling.
|
|
7220
7220
|
* ...
|
|
7221
7221
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/DateColumn#config-renderer)
|
|
7222
7222
|
* @param {object} renderData Object containing renderer parameters
|
|
@@ -7377,9 +7377,9 @@ type DateColumnConfig = {
|
|
|
7377
7377
|
}
|
|
7378
7378
|
|
|
7379
7379
|
/**
|
|
7380
|
-
* A column that displays a date in the specified [format](https://bryntum.com/products/grid/docs/api/Grid/column/DateColumn#config-format). By default `L` format is used, which
|
|
7381
|
-
*
|
|
7382
|
-
*
|
|
7380
|
+
* A column that displays a date in the specified [format](https://bryntum.com/products/grid/docs/api/Grid/column/DateColumn#config-format). By default `L` format is used, which contains
|
|
7381
|
+
* the following info: full year, 2-digit month, and 2-digit day. Depending on the browser locale, the formatted date
|
|
7382
|
+
* might look different. [Intl.DateTimeFormat API](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat)
|
|
7383
7383
|
* is used to format the date. Here is an example of possible outputs depending on the browser locale:
|
|
7384
7384
|
* ...
|
|
7385
7385
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/DateColumn)
|
|
@@ -7413,8 +7413,8 @@ export class DateColumn extends Column {
|
|
|
7413
7413
|
*/
|
|
7414
7414
|
min: string|Date
|
|
7415
7415
|
/**
|
|
7416
|
-
* Renderer function, used to style the date displayed in the cell. Can also affect other aspects of
|
|
7417
|
-
*
|
|
7416
|
+
* Renderer function, used to style the date displayed in the cell. Can also affect other aspects of the cell,
|
|
7417
|
+
* such as styling.
|
|
7418
7418
|
*/
|
|
7419
7419
|
renderer: (renderData: { cellElement: HTMLElement, value: Date|null|undefined, record: Model, column: Column, grid: Grid, row: Row, size: { height: number, configuredHeight: number }, isExport: boolean, isMeasuring: boolean }) => string|DomConfig|DomConfig[]|void
|
|
7420
7420
|
/**
|
|
@@ -29535,6 +29535,14 @@ type GridListenersTypes = {
|
|
|
29535
29535
|
* @param {any} event.value The value being set
|
|
29536
29536
|
*/
|
|
29537
29537
|
beforeCellRangeEdit: (event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void
|
|
29538
|
+
/**
|
|
29539
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
29540
|
+
* @param {object} event Event object
|
|
29541
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
29542
|
+
* @param {Grid.column.Column} event.column The column
|
|
29543
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
29544
|
+
*/
|
|
29545
|
+
beforeColumnCollapseToggle: (event: { source: GridBase, column: Column, collapsed: boolean }) => void
|
|
29538
29546
|
/**
|
|
29539
29547
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
29540
29548
|
* @param {object} event Event object
|
|
@@ -29635,18 +29643,18 @@ type GridListenersTypes = {
|
|
|
29635
29643
|
/**
|
|
29636
29644
|
* Fires before a row is rendered.
|
|
29637
29645
|
* @param {object} event Event object
|
|
29638
|
-
* @param {Grid.view.
|
|
29639
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
29640
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
29641
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
29646
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
29647
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
29648
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
29649
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
29642
29650
|
*/
|
|
29643
|
-
beforeRenderRow: (event: { source:
|
|
29651
|
+
beforeRenderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
|
|
29644
29652
|
/**
|
|
29645
29653
|
* Grid rows are about to be rendered
|
|
29646
29654
|
* @param {object} event Event object
|
|
29647
|
-
* @param {Grid.view.
|
|
29655
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
29648
29656
|
*/
|
|
29649
|
-
beforeRenderRows: (event: { source:
|
|
29657
|
+
beforeRenderRows: (event: { source: GridBase }) => void
|
|
29650
29658
|
/**
|
|
29651
29659
|
* This event fires before row collapse is started.
|
|
29652
29660
|
* ...
|
|
@@ -29877,6 +29885,14 @@ type GridListenersTypes = {
|
|
|
29877
29885
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
29878
29886
|
*/
|
|
29879
29887
|
collapseNode: (event: { source: Grid, record: Model }) => void
|
|
29888
|
+
/**
|
|
29889
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
29890
|
+
* @param {object} event Event object
|
|
29891
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
29892
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
29893
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
29894
|
+
*/
|
|
29895
|
+
columnCollapseToggle: (event: { source: GridBase, column: Column, collapsed: boolean }) => void
|
|
29880
29896
|
/**
|
|
29881
29897
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
29882
29898
|
* to indicate whether the drop position is valid or not.
|
|
@@ -29958,14 +29974,14 @@ type GridListenersTypes = {
|
|
|
29958
29974
|
* ...
|
|
29959
29975
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-dataChange)
|
|
29960
29976
|
* @param {object} event Event object
|
|
29961
|
-
* @param {Grid.view.
|
|
29977
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
29962
29978
|
* @param {Core.data.Store} event.store The originating store
|
|
29963
29979
|
* @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
|
|
29964
29980
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
29965
29981
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
29966
29982
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
29967
29983
|
*/
|
|
29968
|
-
dataChange: (event: { source:
|
|
29984
|
+
dataChange: (event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void
|
|
29969
29985
|
/**
|
|
29970
29986
|
* Fires when an object is destroyed.
|
|
29971
29987
|
* @param {object} event Event object
|
|
@@ -30273,18 +30289,18 @@ type GridListenersTypes = {
|
|
|
30273
30289
|
/**
|
|
30274
30290
|
* Fires after a row is rendered.
|
|
30275
30291
|
* @param {object} event Event object
|
|
30276
|
-
* @param {Grid.view.
|
|
30277
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
30278
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
30279
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
30292
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
30293
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
30294
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
30295
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
30280
30296
|
*/
|
|
30281
|
-
renderRow: (event: { source:
|
|
30297
|
+
renderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
|
|
30282
30298
|
/**
|
|
30283
30299
|
* Grid rows have been rendered
|
|
30284
30300
|
* @param {object} event Event object
|
|
30285
|
-
* @param {Grid.view.
|
|
30301
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
30286
30302
|
*/
|
|
30287
|
-
renderRows: (event: { source:
|
|
30303
|
+
renderRows: (event: { source: GridBase }) => void
|
|
30288
30304
|
/**
|
|
30289
30305
|
* Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
|
|
30290
30306
|
* @param {object} event Event object
|
|
@@ -30344,10 +30360,10 @@ type GridListenersTypes = {
|
|
|
30344
30360
|
/**
|
|
30345
30361
|
* Grid has scrolled vertically
|
|
30346
30362
|
* @param {object} event Event object
|
|
30347
|
-
* @param {Grid.view.
|
|
30363
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
30348
30364
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
30349
30365
|
*/
|
|
30350
|
-
scroll: (event: { source:
|
|
30366
|
+
scroll: (event: { source: GridBase, scrollTop: number }) => void
|
|
30351
30367
|
/**
|
|
30352
30368
|
* The selection has been changed.
|
|
30353
30369
|
* @param {object} event Event object
|
|
@@ -30435,17 +30451,17 @@ type GridListenersTypes = {
|
|
|
30435
30451
|
/**
|
|
30436
30452
|
* Fires after a sub grid is collapsed.
|
|
30437
30453
|
* @param {object} event Event object
|
|
30438
|
-
* @param {Grid.view.
|
|
30454
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
30439
30455
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
30440
30456
|
*/
|
|
30441
|
-
subGridCollapse: (event: { source:
|
|
30457
|
+
subGridCollapse: (event: { source: GridBase, subGrid: SubGrid }) => void
|
|
30442
30458
|
/**
|
|
30443
30459
|
* Fires after a sub grid is expanded.
|
|
30444
30460
|
* @param {object} event Event object
|
|
30445
|
-
* @param {Grid.view.
|
|
30461
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
30446
30462
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
30447
30463
|
*/
|
|
30448
|
-
subGridExpand: (event: { source:
|
|
30464
|
+
subGridExpand: (event: { source: GridBase, subGrid: SubGrid }) => void
|
|
30449
30465
|
/**
|
|
30450
30466
|
* Fired when one or more groups are expanded or collapsed
|
|
30451
30467
|
* @param {object} event Event object
|
|
@@ -30538,6 +30554,14 @@ type GridListeners = {
|
|
|
30538
30554
|
* @param {any} event.value The value being set
|
|
30539
30555
|
*/
|
|
30540
30556
|
beforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
|
|
30557
|
+
/**
|
|
30558
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
30559
|
+
* @param {object} event Event object
|
|
30560
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
30561
|
+
* @param {Grid.column.Column} event.column The column
|
|
30562
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
30563
|
+
*/
|
|
30564
|
+
beforeColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
30541
30565
|
/**
|
|
30542
30566
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
30543
30567
|
* @param {object} event Event object
|
|
@@ -30638,18 +30662,18 @@ type GridListeners = {
|
|
|
30638
30662
|
/**
|
|
30639
30663
|
* Fires before a row is rendered.
|
|
30640
30664
|
* @param {object} event Event object
|
|
30641
|
-
* @param {Grid.view.
|
|
30642
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
30643
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
30644
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
30665
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
30666
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
30667
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
30668
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
30645
30669
|
*/
|
|
30646
|
-
beforeRenderRow?: ((event: { source:
|
|
30670
|
+
beforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
30647
30671
|
/**
|
|
30648
30672
|
* Grid rows are about to be rendered
|
|
30649
30673
|
* @param {object} event Event object
|
|
30650
|
-
* @param {Grid.view.
|
|
30674
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
30651
30675
|
*/
|
|
30652
|
-
beforeRenderRows?: ((event: { source:
|
|
30676
|
+
beforeRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
30653
30677
|
/**
|
|
30654
30678
|
* This event fires before row collapse is started.
|
|
30655
30679
|
* ...
|
|
@@ -30880,6 +30904,14 @@ type GridListeners = {
|
|
|
30880
30904
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
30881
30905
|
*/
|
|
30882
30906
|
collapseNode?: ((event: { source: Grid, record: Model }) => void)|string
|
|
30907
|
+
/**
|
|
30908
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
30909
|
+
* @param {object} event Event object
|
|
30910
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
30911
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
30912
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
30913
|
+
*/
|
|
30914
|
+
columnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
30883
30915
|
/**
|
|
30884
30916
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
30885
30917
|
* to indicate whether the drop position is valid or not.
|
|
@@ -30961,14 +30993,14 @@ type GridListeners = {
|
|
|
30961
30993
|
* ...
|
|
30962
30994
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-dataChange)
|
|
30963
30995
|
* @param {object} event Event object
|
|
30964
|
-
* @param {Grid.view.
|
|
30996
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
30965
30997
|
* @param {Core.data.Store} event.store The originating store
|
|
30966
30998
|
* @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
|
|
30967
30999
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
30968
31000
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
30969
31001
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
30970
31002
|
*/
|
|
30971
|
-
dataChange?: ((event: { source:
|
|
31003
|
+
dataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
|
|
30972
31004
|
/**
|
|
30973
31005
|
* Fires when an object is destroyed.
|
|
30974
31006
|
* @param {object} event Event object
|
|
@@ -31276,18 +31308,18 @@ type GridListeners = {
|
|
|
31276
31308
|
/**
|
|
31277
31309
|
* Fires after a row is rendered.
|
|
31278
31310
|
* @param {object} event Event object
|
|
31279
|
-
* @param {Grid.view.
|
|
31280
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
31281
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
31282
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
31311
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
31312
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
31313
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
31314
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
31283
31315
|
*/
|
|
31284
|
-
renderRow?: ((event: { source:
|
|
31316
|
+
renderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
31285
31317
|
/**
|
|
31286
31318
|
* Grid rows have been rendered
|
|
31287
31319
|
* @param {object} event Event object
|
|
31288
|
-
* @param {Grid.view.
|
|
31320
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
31289
31321
|
*/
|
|
31290
|
-
renderRows?: ((event: { source:
|
|
31322
|
+
renderRows?: ((event: { source: GridBase }) => void)|string
|
|
31291
31323
|
/**
|
|
31292
31324
|
* Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
|
|
31293
31325
|
* @param {object} event Event object
|
|
@@ -31347,10 +31379,10 @@ type GridListeners = {
|
|
|
31347
31379
|
/**
|
|
31348
31380
|
* Grid has scrolled vertically
|
|
31349
31381
|
* @param {object} event Event object
|
|
31350
|
-
* @param {Grid.view.
|
|
31382
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
31351
31383
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
31352
31384
|
*/
|
|
31353
|
-
scroll?: ((event: { source:
|
|
31385
|
+
scroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
|
|
31354
31386
|
/**
|
|
31355
31387
|
* The selection has been changed.
|
|
31356
31388
|
* @param {object} event Event object
|
|
@@ -31438,17 +31470,17 @@ type GridListeners = {
|
|
|
31438
31470
|
/**
|
|
31439
31471
|
* Fires after a sub grid is collapsed.
|
|
31440
31472
|
* @param {object} event Event object
|
|
31441
|
-
* @param {Grid.view.
|
|
31473
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
31442
31474
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
31443
31475
|
*/
|
|
31444
|
-
subGridCollapse?: ((event: { source:
|
|
31476
|
+
subGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
31445
31477
|
/**
|
|
31446
31478
|
* Fires after a sub grid is expanded.
|
|
31447
31479
|
* @param {object} event Event object
|
|
31448
|
-
* @param {Grid.view.
|
|
31480
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
31449
31481
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
31450
31482
|
*/
|
|
31451
|
-
subGridExpand?: ((event: { source:
|
|
31483
|
+
subGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
31452
31484
|
/**
|
|
31453
31485
|
* Fired when one or more groups are expanded or collapsed
|
|
31454
31486
|
* @param {object} event Event object
|
|
@@ -32376,6 +32408,14 @@ type GridConfig = {
|
|
|
32376
32408
|
* @param {any} event.value The value being set
|
|
32377
32409
|
*/
|
|
32378
32410
|
onBeforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
|
|
32411
|
+
/**
|
|
32412
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
32413
|
+
* @param {object} event Event object
|
|
32414
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
32415
|
+
* @param {Grid.column.Column} event.column The column
|
|
32416
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
32417
|
+
*/
|
|
32418
|
+
onBeforeColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
32379
32419
|
/**
|
|
32380
32420
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
32381
32421
|
* @param {object} event Event object
|
|
@@ -32476,18 +32516,18 @@ type GridConfig = {
|
|
|
32476
32516
|
/**
|
|
32477
32517
|
* Fires before a row is rendered.
|
|
32478
32518
|
* @param {object} event Event object
|
|
32479
|
-
* @param {Grid.view.
|
|
32480
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
32481
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
32482
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
32519
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
32520
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
32521
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
32522
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
32483
32523
|
*/
|
|
32484
|
-
onBeforeRenderRow?: ((event: { source:
|
|
32524
|
+
onBeforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
32485
32525
|
/**
|
|
32486
32526
|
* Grid rows are about to be rendered
|
|
32487
32527
|
* @param {object} event Event object
|
|
32488
|
-
* @param {Grid.view.
|
|
32528
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
32489
32529
|
*/
|
|
32490
|
-
onBeforeRenderRows?: ((event: { source:
|
|
32530
|
+
onBeforeRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
32491
32531
|
/**
|
|
32492
32532
|
* This event fires before row collapse is started.
|
|
32493
32533
|
* ...
|
|
@@ -32718,6 +32758,14 @@ type GridConfig = {
|
|
|
32718
32758
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
32719
32759
|
*/
|
|
32720
32760
|
onCollapseNode?: ((event: { source: Grid, record: Model }) => void)|string
|
|
32761
|
+
/**
|
|
32762
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
32763
|
+
* @param {object} event Event object
|
|
32764
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
32765
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
32766
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
32767
|
+
*/
|
|
32768
|
+
onColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
32721
32769
|
/**
|
|
32722
32770
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
32723
32771
|
* to indicate whether the drop position is valid or not.
|
|
@@ -32799,14 +32847,14 @@ type GridConfig = {
|
|
|
32799
32847
|
* ...
|
|
32800
32848
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-dataChange)
|
|
32801
32849
|
* @param {object} event Event object
|
|
32802
|
-
* @param {Grid.view.
|
|
32850
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
32803
32851
|
* @param {Core.data.Store} event.store The originating store
|
|
32804
32852
|
* @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
|
|
32805
32853
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
32806
32854
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
32807
32855
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
32808
32856
|
*/
|
|
32809
|
-
onDataChange?: ((event: { source:
|
|
32857
|
+
onDataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
|
|
32810
32858
|
/**
|
|
32811
32859
|
* Fires when an object is destroyed.
|
|
32812
32860
|
* @param {object} event Event object
|
|
@@ -33114,18 +33162,18 @@ type GridConfig = {
|
|
|
33114
33162
|
/**
|
|
33115
33163
|
* Fires after a row is rendered.
|
|
33116
33164
|
* @param {object} event Event object
|
|
33117
|
-
* @param {Grid.view.
|
|
33118
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
33119
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
33120
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
33165
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
33166
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
33167
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
33168
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
33121
33169
|
*/
|
|
33122
|
-
onRenderRow?: ((event: { source:
|
|
33170
|
+
onRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
33123
33171
|
/**
|
|
33124
33172
|
* Grid rows have been rendered
|
|
33125
33173
|
* @param {object} event Event object
|
|
33126
|
-
* @param {Grid.view.
|
|
33174
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
33127
33175
|
*/
|
|
33128
|
-
onRenderRows?: ((event: { source:
|
|
33176
|
+
onRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
33129
33177
|
/**
|
|
33130
33178
|
* Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
|
|
33131
33179
|
* @param {object} event Event object
|
|
@@ -33185,10 +33233,10 @@ type GridConfig = {
|
|
|
33185
33233
|
/**
|
|
33186
33234
|
* Grid has scrolled vertically
|
|
33187
33235
|
* @param {object} event Event object
|
|
33188
|
-
* @param {Grid.view.
|
|
33236
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
33189
33237
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
33190
33238
|
*/
|
|
33191
|
-
onScroll?: ((event: { source:
|
|
33239
|
+
onScroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
|
|
33192
33240
|
/**
|
|
33193
33241
|
* The selection has been changed.
|
|
33194
33242
|
* @param {object} event Event object
|
|
@@ -33276,17 +33324,17 @@ type GridConfig = {
|
|
|
33276
33324
|
/**
|
|
33277
33325
|
* Fires after a sub grid is collapsed.
|
|
33278
33326
|
* @param {object} event Event object
|
|
33279
|
-
* @param {Grid.view.
|
|
33327
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
33280
33328
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
33281
33329
|
*/
|
|
33282
|
-
onSubGridCollapse?: ((event: { source:
|
|
33330
|
+
onSubGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
33283
33331
|
/**
|
|
33284
33332
|
* Fires after a sub grid is expanded.
|
|
33285
33333
|
* @param {object} event Event object
|
|
33286
|
-
* @param {Grid.view.
|
|
33334
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
33287
33335
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
33288
33336
|
*/
|
|
33289
|
-
onSubGridExpand?: ((event: { source:
|
|
33337
|
+
onSubGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
33290
33338
|
/**
|
|
33291
33339
|
* Fired when one or more groups are expanded or collapsed
|
|
33292
33340
|
* @param {object} event Event object
|
|
@@ -33598,6 +33646,14 @@ type GridBaseListenersTypes = {
|
|
|
33598
33646
|
* @param {any} event.value The value being set
|
|
33599
33647
|
*/
|
|
33600
33648
|
beforeCellRangeEdit: (event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void
|
|
33649
|
+
/**
|
|
33650
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
33651
|
+
* @param {object} event Event object
|
|
33652
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
33653
|
+
* @param {Grid.column.Column} event.column The column
|
|
33654
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
33655
|
+
*/
|
|
33656
|
+
beforeColumnCollapseToggle: (event: { source: GridBase, column: Column, collapsed: boolean }) => void
|
|
33601
33657
|
/**
|
|
33602
33658
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
33603
33659
|
* @param {object} event Event object
|
|
@@ -33698,18 +33754,18 @@ type GridBaseListenersTypes = {
|
|
|
33698
33754
|
/**
|
|
33699
33755
|
* Fires before a row is rendered.
|
|
33700
33756
|
* @param {object} event Event object
|
|
33701
|
-
* @param {Grid.view.
|
|
33702
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
33703
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
33704
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
33757
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
33758
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
33759
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
33760
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
33705
33761
|
*/
|
|
33706
|
-
beforeRenderRow: (event: { source:
|
|
33762
|
+
beforeRenderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
|
|
33707
33763
|
/**
|
|
33708
33764
|
* Grid rows are about to be rendered
|
|
33709
33765
|
* @param {object} event Event object
|
|
33710
|
-
* @param {Grid.view.
|
|
33766
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
33711
33767
|
*/
|
|
33712
|
-
beforeRenderRows: (event: { source:
|
|
33768
|
+
beforeRenderRows: (event: { source: GridBase }) => void
|
|
33713
33769
|
/**
|
|
33714
33770
|
* This event fires before row collapse is started.
|
|
33715
33771
|
* ...
|
|
@@ -33940,6 +33996,14 @@ type GridBaseListenersTypes = {
|
|
|
33940
33996
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
33941
33997
|
*/
|
|
33942
33998
|
collapseNode: (event: { source: Grid, record: Model }) => void
|
|
33999
|
+
/**
|
|
34000
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
34001
|
+
* @param {object} event Event object
|
|
34002
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
34003
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
34004
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
34005
|
+
*/
|
|
34006
|
+
columnCollapseToggle: (event: { source: GridBase, column: Column, collapsed: boolean }) => void
|
|
33943
34007
|
/**
|
|
33944
34008
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
33945
34009
|
* to indicate whether the drop position is valid or not.
|
|
@@ -34021,14 +34085,14 @@ type GridBaseListenersTypes = {
|
|
|
34021
34085
|
* ...
|
|
34022
34086
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-dataChange)
|
|
34023
34087
|
* @param {object} event Event object
|
|
34024
|
-
* @param {Grid.view.
|
|
34088
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
34025
34089
|
* @param {Core.data.Store} event.store The originating store
|
|
34026
34090
|
* @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
|
|
34027
34091
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
34028
34092
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
34029
34093
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
34030
34094
|
*/
|
|
34031
|
-
dataChange: (event: { source:
|
|
34095
|
+
dataChange: (event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void
|
|
34032
34096
|
/**
|
|
34033
34097
|
* Fires when an object is destroyed.
|
|
34034
34098
|
* @param {object} event Event object
|
|
@@ -34336,18 +34400,18 @@ type GridBaseListenersTypes = {
|
|
|
34336
34400
|
/**
|
|
34337
34401
|
* Fires after a row is rendered.
|
|
34338
34402
|
* @param {object} event Event object
|
|
34339
|
-
* @param {Grid.view.
|
|
34340
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
34341
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
34342
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
34403
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
34404
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
34405
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
34406
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
34343
34407
|
*/
|
|
34344
|
-
renderRow: (event: { source:
|
|
34408
|
+
renderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
|
|
34345
34409
|
/**
|
|
34346
34410
|
* Grid rows have been rendered
|
|
34347
34411
|
* @param {object} event Event object
|
|
34348
|
-
* @param {Grid.view.
|
|
34412
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
34349
34413
|
*/
|
|
34350
|
-
renderRows: (event: { source:
|
|
34414
|
+
renderRows: (event: { source: GridBase }) => void
|
|
34351
34415
|
/**
|
|
34352
34416
|
* Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
|
|
34353
34417
|
* @param {object} event Event object
|
|
@@ -34407,10 +34471,10 @@ type GridBaseListenersTypes = {
|
|
|
34407
34471
|
/**
|
|
34408
34472
|
* Grid has scrolled vertically
|
|
34409
34473
|
* @param {object} event Event object
|
|
34410
|
-
* @param {Grid.view.
|
|
34474
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
34411
34475
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
34412
34476
|
*/
|
|
34413
|
-
scroll: (event: { source:
|
|
34477
|
+
scroll: (event: { source: GridBase, scrollTop: number }) => void
|
|
34414
34478
|
/**
|
|
34415
34479
|
* The selection has been changed.
|
|
34416
34480
|
* @param {object} event Event object
|
|
@@ -34498,17 +34562,17 @@ type GridBaseListenersTypes = {
|
|
|
34498
34562
|
/**
|
|
34499
34563
|
* Fires after a sub grid is collapsed.
|
|
34500
34564
|
* @param {object} event Event object
|
|
34501
|
-
* @param {Grid.view.
|
|
34565
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
34502
34566
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
34503
34567
|
*/
|
|
34504
|
-
subGridCollapse: (event: { source:
|
|
34568
|
+
subGridCollapse: (event: { source: GridBase, subGrid: SubGrid }) => void
|
|
34505
34569
|
/**
|
|
34506
34570
|
* Fires after a sub grid is expanded.
|
|
34507
34571
|
* @param {object} event Event object
|
|
34508
|
-
* @param {Grid.view.
|
|
34572
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
34509
34573
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
34510
34574
|
*/
|
|
34511
|
-
subGridExpand: (event: { source:
|
|
34575
|
+
subGridExpand: (event: { source: GridBase, subGrid: SubGrid }) => void
|
|
34512
34576
|
/**
|
|
34513
34577
|
* Fired when one or more groups are expanded or collapsed
|
|
34514
34578
|
* @param {object} event Event object
|
|
@@ -34601,6 +34665,14 @@ type GridBaseListeners = {
|
|
|
34601
34665
|
* @param {any} event.value The value being set
|
|
34602
34666
|
*/
|
|
34603
34667
|
beforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
|
|
34668
|
+
/**
|
|
34669
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
34670
|
+
* @param {object} event Event object
|
|
34671
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
34672
|
+
* @param {Grid.column.Column} event.column The column
|
|
34673
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
34674
|
+
*/
|
|
34675
|
+
beforeColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
34604
34676
|
/**
|
|
34605
34677
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
34606
34678
|
* @param {object} event Event object
|
|
@@ -34701,18 +34773,18 @@ type GridBaseListeners = {
|
|
|
34701
34773
|
/**
|
|
34702
34774
|
* Fires before a row is rendered.
|
|
34703
34775
|
* @param {object} event Event object
|
|
34704
|
-
* @param {Grid.view.
|
|
34705
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
34706
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
34707
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
34776
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
34777
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
34778
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
34779
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
34708
34780
|
*/
|
|
34709
|
-
beforeRenderRow?: ((event: { source:
|
|
34781
|
+
beforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
34710
34782
|
/**
|
|
34711
34783
|
* Grid rows are about to be rendered
|
|
34712
34784
|
* @param {object} event Event object
|
|
34713
|
-
* @param {Grid.view.
|
|
34785
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
34714
34786
|
*/
|
|
34715
|
-
beforeRenderRows?: ((event: { source:
|
|
34787
|
+
beforeRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
34716
34788
|
/**
|
|
34717
34789
|
* This event fires before row collapse is started.
|
|
34718
34790
|
* ...
|
|
@@ -34943,6 +35015,14 @@ type GridBaseListeners = {
|
|
|
34943
35015
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
34944
35016
|
*/
|
|
34945
35017
|
collapseNode?: ((event: { source: Grid, record: Model }) => void)|string
|
|
35018
|
+
/**
|
|
35019
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
35020
|
+
* @param {object} event Event object
|
|
35021
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
35022
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
35023
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
35024
|
+
*/
|
|
35025
|
+
columnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
34946
35026
|
/**
|
|
34947
35027
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
34948
35028
|
* to indicate whether the drop position is valid or not.
|
|
@@ -35024,14 +35104,14 @@ type GridBaseListeners = {
|
|
|
35024
35104
|
* ...
|
|
35025
35105
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-dataChange)
|
|
35026
35106
|
* @param {object} event Event object
|
|
35027
|
-
* @param {Grid.view.
|
|
35107
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
35028
35108
|
* @param {Core.data.Store} event.store The originating store
|
|
35029
35109
|
* @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
|
|
35030
35110
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
35031
35111
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
35032
35112
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
35033
35113
|
*/
|
|
35034
|
-
dataChange?: ((event: { source:
|
|
35114
|
+
dataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
|
|
35035
35115
|
/**
|
|
35036
35116
|
* Fires when an object is destroyed.
|
|
35037
35117
|
* @param {object} event Event object
|
|
@@ -35339,18 +35419,18 @@ type GridBaseListeners = {
|
|
|
35339
35419
|
/**
|
|
35340
35420
|
* Fires after a row is rendered.
|
|
35341
35421
|
* @param {object} event Event object
|
|
35342
|
-
* @param {Grid.view.
|
|
35343
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
35344
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
35345
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
35422
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
35423
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
35424
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
35425
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
35346
35426
|
*/
|
|
35347
|
-
renderRow?: ((event: { source:
|
|
35427
|
+
renderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
35348
35428
|
/**
|
|
35349
35429
|
* Grid rows have been rendered
|
|
35350
35430
|
* @param {object} event Event object
|
|
35351
|
-
* @param {Grid.view.
|
|
35431
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
35352
35432
|
*/
|
|
35353
|
-
renderRows?: ((event: { source:
|
|
35433
|
+
renderRows?: ((event: { source: GridBase }) => void)|string
|
|
35354
35434
|
/**
|
|
35355
35435
|
* Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
|
|
35356
35436
|
* @param {object} event Event object
|
|
@@ -35410,10 +35490,10 @@ type GridBaseListeners = {
|
|
|
35410
35490
|
/**
|
|
35411
35491
|
* Grid has scrolled vertically
|
|
35412
35492
|
* @param {object} event Event object
|
|
35413
|
-
* @param {Grid.view.
|
|
35493
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
35414
35494
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
35415
35495
|
*/
|
|
35416
|
-
scroll?: ((event: { source:
|
|
35496
|
+
scroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
|
|
35417
35497
|
/**
|
|
35418
35498
|
* The selection has been changed.
|
|
35419
35499
|
* @param {object} event Event object
|
|
@@ -35501,17 +35581,17 @@ type GridBaseListeners = {
|
|
|
35501
35581
|
/**
|
|
35502
35582
|
* Fires after a sub grid is collapsed.
|
|
35503
35583
|
* @param {object} event Event object
|
|
35504
|
-
* @param {Grid.view.
|
|
35584
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
35505
35585
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
35506
35586
|
*/
|
|
35507
|
-
subGridCollapse?: ((event: { source:
|
|
35587
|
+
subGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
35508
35588
|
/**
|
|
35509
35589
|
* Fires after a sub grid is expanded.
|
|
35510
35590
|
* @param {object} event Event object
|
|
35511
|
-
* @param {Grid.view.
|
|
35591
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
35512
35592
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
35513
35593
|
*/
|
|
35514
|
-
subGridExpand?: ((event: { source:
|
|
35594
|
+
subGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
35515
35595
|
/**
|
|
35516
35596
|
* Fired when one or more groups are expanded or collapsed
|
|
35517
35597
|
* @param {object} event Event object
|
|
@@ -36438,6 +36518,14 @@ type GridBaseConfig = {
|
|
|
36438
36518
|
* @param {any} event.value The value being set
|
|
36439
36519
|
*/
|
|
36440
36520
|
onBeforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
|
|
36521
|
+
/**
|
|
36522
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
36523
|
+
* @param {object} event Event object
|
|
36524
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
36525
|
+
* @param {Grid.column.Column} event.column The column
|
|
36526
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
36527
|
+
*/
|
|
36528
|
+
onBeforeColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
36441
36529
|
/**
|
|
36442
36530
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
36443
36531
|
* @param {object} event Event object
|
|
@@ -36538,18 +36626,18 @@ type GridBaseConfig = {
|
|
|
36538
36626
|
/**
|
|
36539
36627
|
* Fires before a row is rendered.
|
|
36540
36628
|
* @param {object} event Event object
|
|
36541
|
-
* @param {Grid.view.
|
|
36542
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
36543
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
36544
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
36629
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
36630
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
36631
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
36632
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
36545
36633
|
*/
|
|
36546
|
-
onBeforeRenderRow?: ((event: { source:
|
|
36634
|
+
onBeforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
36547
36635
|
/**
|
|
36548
36636
|
* Grid rows are about to be rendered
|
|
36549
36637
|
* @param {object} event Event object
|
|
36550
|
-
* @param {Grid.view.
|
|
36638
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
36551
36639
|
*/
|
|
36552
|
-
onBeforeRenderRows?: ((event: { source:
|
|
36640
|
+
onBeforeRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
36553
36641
|
/**
|
|
36554
36642
|
* This event fires before row collapse is started.
|
|
36555
36643
|
* ...
|
|
@@ -36780,6 +36868,14 @@ type GridBaseConfig = {
|
|
|
36780
36868
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
36781
36869
|
*/
|
|
36782
36870
|
onCollapseNode?: ((event: { source: Grid, record: Model }) => void)|string
|
|
36871
|
+
/**
|
|
36872
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
36873
|
+
* @param {object} event Event object
|
|
36874
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
36875
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
36876
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
36877
|
+
*/
|
|
36878
|
+
onColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
36783
36879
|
/**
|
|
36784
36880
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
36785
36881
|
* to indicate whether the drop position is valid or not.
|
|
@@ -36861,14 +36957,14 @@ type GridBaseConfig = {
|
|
|
36861
36957
|
* ...
|
|
36862
36958
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-dataChange)
|
|
36863
36959
|
* @param {object} event Event object
|
|
36864
|
-
* @param {Grid.view.
|
|
36960
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
36865
36961
|
* @param {Core.data.Store} event.store The originating store
|
|
36866
36962
|
* @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
|
|
36867
36963
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
36868
36964
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
36869
36965
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
36870
36966
|
*/
|
|
36871
|
-
onDataChange?: ((event: { source:
|
|
36967
|
+
onDataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
|
|
36872
36968
|
/**
|
|
36873
36969
|
* Fires when an object is destroyed.
|
|
36874
36970
|
* @param {object} event Event object
|
|
@@ -37176,18 +37272,18 @@ type GridBaseConfig = {
|
|
|
37176
37272
|
/**
|
|
37177
37273
|
* Fires after a row is rendered.
|
|
37178
37274
|
* @param {object} event Event object
|
|
37179
|
-
* @param {Grid.view.
|
|
37180
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
37181
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
37182
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
37275
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
37276
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
37277
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
37278
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
37183
37279
|
*/
|
|
37184
|
-
onRenderRow?: ((event: { source:
|
|
37280
|
+
onRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
37185
37281
|
/**
|
|
37186
37282
|
* Grid rows have been rendered
|
|
37187
37283
|
* @param {object} event Event object
|
|
37188
|
-
* @param {Grid.view.
|
|
37284
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
37189
37285
|
*/
|
|
37190
|
-
onRenderRows?: ((event: { source:
|
|
37286
|
+
onRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
37191
37287
|
/**
|
|
37192
37288
|
* Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
|
|
37193
37289
|
* @param {object} event Event object
|
|
@@ -37247,10 +37343,10 @@ type GridBaseConfig = {
|
|
|
37247
37343
|
/**
|
|
37248
37344
|
* Grid has scrolled vertically
|
|
37249
37345
|
* @param {object} event Event object
|
|
37250
|
-
* @param {Grid.view.
|
|
37346
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
37251
37347
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
37252
37348
|
*/
|
|
37253
|
-
onScroll?: ((event: { source:
|
|
37349
|
+
onScroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
|
|
37254
37350
|
/**
|
|
37255
37351
|
* The selection has been changed.
|
|
37256
37352
|
* @param {object} event Event object
|
|
@@ -37338,17 +37434,17 @@ type GridBaseConfig = {
|
|
|
37338
37434
|
/**
|
|
37339
37435
|
* Fires after a sub grid is collapsed.
|
|
37340
37436
|
* @param {object} event Event object
|
|
37341
|
-
* @param {Grid.view.
|
|
37437
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
37342
37438
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
37343
37439
|
*/
|
|
37344
|
-
onSubGridCollapse?: ((event: { source:
|
|
37440
|
+
onSubGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
37345
37441
|
/**
|
|
37346
37442
|
* Fires after a sub grid is expanded.
|
|
37347
37443
|
* @param {object} event Event object
|
|
37348
|
-
* @param {Grid.view.
|
|
37444
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
37349
37445
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
37350
37446
|
*/
|
|
37351
|
-
onSubGridExpand?: ((event: { source:
|
|
37447
|
+
onSubGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
37352
37448
|
/**
|
|
37353
37449
|
* Fired when one or more groups are expanded or collapsed
|
|
37354
37450
|
* @param {object} event Event object
|
|
@@ -37770,6 +37866,14 @@ export class GridBase extends Panel {
|
|
|
37770
37866
|
* @param {any} event.value The value being set
|
|
37771
37867
|
*/
|
|
37772
37868
|
onBeforeCellRangeEdit: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
|
|
37869
|
+
/**
|
|
37870
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
37871
|
+
* @param {object} event Event object
|
|
37872
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
37873
|
+
* @param {Grid.column.Column} event.column The column
|
|
37874
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
37875
|
+
*/
|
|
37876
|
+
onBeforeColumnCollapseToggle: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
37773
37877
|
/**
|
|
37774
37878
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
37775
37879
|
* @param {object} event Event object
|
|
@@ -37864,18 +37968,18 @@ export class GridBase extends Panel {
|
|
|
37864
37968
|
/**
|
|
37865
37969
|
* Fires before a row is rendered.
|
|
37866
37970
|
* @param {object} event Event object
|
|
37867
|
-
* @param {Grid.view.
|
|
37868
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
37869
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
37870
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
37971
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
37972
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
37973
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
37974
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
37871
37975
|
*/
|
|
37872
|
-
onBeforeRenderRow: ((event: { source:
|
|
37976
|
+
onBeforeRenderRow: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
37873
37977
|
/**
|
|
37874
37978
|
* Grid rows are about to be rendered
|
|
37875
37979
|
* @param {object} event Event object
|
|
37876
|
-
* @param {Grid.view.
|
|
37980
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
37877
37981
|
*/
|
|
37878
|
-
onBeforeRenderRows: ((event: { source:
|
|
37982
|
+
onBeforeRenderRows: ((event: { source: GridBase }) => void)|string
|
|
37879
37983
|
/**
|
|
37880
37984
|
* This event fires before row collapse is started.
|
|
37881
37985
|
* ...
|
|
@@ -38086,6 +38190,14 @@ export class GridBase extends Panel {
|
|
|
38086
38190
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
38087
38191
|
*/
|
|
38088
38192
|
onCollapseNode: ((event: { source: Grid, record: Model }) => void)|string
|
|
38193
|
+
/**
|
|
38194
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
38195
|
+
* @param {object} event Event object
|
|
38196
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
38197
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
38198
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
38199
|
+
*/
|
|
38200
|
+
onColumnCollapseToggle: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
38089
38201
|
/**
|
|
38090
38202
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
38091
38203
|
* to indicate whether the drop position is valid or not.
|
|
@@ -38150,14 +38262,14 @@ export class GridBase extends Panel {
|
|
|
38150
38262
|
* ...
|
|
38151
38263
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-dataChange)
|
|
38152
38264
|
* @param {object} event Event object
|
|
38153
|
-
* @param {Grid.view.
|
|
38265
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
38154
38266
|
* @param {Core.data.Store} event.store The originating store
|
|
38155
38267
|
* @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
|
|
38156
38268
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
38157
38269
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
38158
38270
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
38159
38271
|
*/
|
|
38160
|
-
onDataChange: ((event: { source:
|
|
38272
|
+
onDataChange: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
|
|
38161
38273
|
/**
|
|
38162
38274
|
* Fires when an object is destroyed.
|
|
38163
38275
|
* @param {object} event Event object
|
|
@@ -38395,18 +38507,18 @@ export class GridBase extends Panel {
|
|
|
38395
38507
|
/**
|
|
38396
38508
|
* Fires after a row is rendered.
|
|
38397
38509
|
* @param {object} event Event object
|
|
38398
|
-
* @param {Grid.view.
|
|
38399
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
38400
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
38401
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
38510
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
38511
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
38512
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
38513
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
38402
38514
|
*/
|
|
38403
|
-
onRenderRow: ((event: { source:
|
|
38515
|
+
onRenderRow: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
38404
38516
|
/**
|
|
38405
38517
|
* Grid rows have been rendered
|
|
38406
38518
|
* @param {object} event Event object
|
|
38407
|
-
* @param {Grid.view.
|
|
38519
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
38408
38520
|
*/
|
|
38409
|
-
onRenderRows: ((event: { source:
|
|
38521
|
+
onRenderRows: ((event: { source: GridBase }) => void)|string
|
|
38410
38522
|
/**
|
|
38411
38523
|
* Grid resize lead to a new responsive level being applied
|
|
38412
38524
|
* @param {object} event Event object
|
|
@@ -38456,10 +38568,10 @@ export class GridBase extends Panel {
|
|
|
38456
38568
|
/**
|
|
38457
38569
|
* Grid has scrolled vertically
|
|
38458
38570
|
* @param {object} event Event object
|
|
38459
|
-
* @param {Grid.view.
|
|
38571
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
38460
38572
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
38461
38573
|
*/
|
|
38462
|
-
onScroll: ((event: { source:
|
|
38574
|
+
onScroll: ((event: { source: GridBase, scrollTop: number }) => void)|string
|
|
38463
38575
|
/**
|
|
38464
38576
|
* The selection has been changed.
|
|
38465
38577
|
* @param {object} event Event object
|
|
@@ -38541,17 +38653,17 @@ export class GridBase extends Panel {
|
|
|
38541
38653
|
/**
|
|
38542
38654
|
* Fires after a sub grid is collapsed.
|
|
38543
38655
|
* @param {object} event Event object
|
|
38544
|
-
* @param {Grid.view.
|
|
38656
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
38545
38657
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
38546
38658
|
*/
|
|
38547
|
-
onSubGridCollapse: ((event: { source:
|
|
38659
|
+
onSubGridCollapse: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
38548
38660
|
/**
|
|
38549
38661
|
* Fires after a sub grid is expanded.
|
|
38550
38662
|
* @param {object} event Event object
|
|
38551
|
-
* @param {Grid.view.
|
|
38663
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
38552
38664
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
38553
38665
|
*/
|
|
38554
|
-
onSubGridExpand: ((event: { source:
|
|
38666
|
+
onSubGridExpand: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
38555
38667
|
/**
|
|
38556
38668
|
* Fired when one or more groups are expanded or collapsed
|
|
38557
38669
|
* @param {object} event Event object
|
|
@@ -40073,6 +40185,14 @@ type TreeGridListenersTypes = {
|
|
|
40073
40185
|
* @param {any} event.value The value being set
|
|
40074
40186
|
*/
|
|
40075
40187
|
beforeCellRangeEdit: (event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void
|
|
40188
|
+
/**
|
|
40189
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
40190
|
+
* @param {object} event Event object
|
|
40191
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
40192
|
+
* @param {Grid.column.Column} event.column The column
|
|
40193
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
40194
|
+
*/
|
|
40195
|
+
beforeColumnCollapseToggle: (event: { source: GridBase, column: Column, collapsed: boolean }) => void
|
|
40076
40196
|
/**
|
|
40077
40197
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
40078
40198
|
* @param {object} event Event object
|
|
@@ -40173,18 +40293,18 @@ type TreeGridListenersTypes = {
|
|
|
40173
40293
|
/**
|
|
40174
40294
|
* Fires before a row is rendered.
|
|
40175
40295
|
* @param {object} event Event object
|
|
40176
|
-
* @param {Grid.view.
|
|
40177
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
40178
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
40179
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
40296
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
40297
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
40298
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
40299
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
40180
40300
|
*/
|
|
40181
|
-
beforeRenderRow: (event: { source:
|
|
40301
|
+
beforeRenderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
|
|
40182
40302
|
/**
|
|
40183
40303
|
* Grid rows are about to be rendered
|
|
40184
40304
|
* @param {object} event Event object
|
|
40185
|
-
* @param {Grid.view.
|
|
40305
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
40186
40306
|
*/
|
|
40187
|
-
beforeRenderRows: (event: { source:
|
|
40307
|
+
beforeRenderRows: (event: { source: GridBase }) => void
|
|
40188
40308
|
/**
|
|
40189
40309
|
* This event fires before row collapse is started.
|
|
40190
40310
|
* ...
|
|
@@ -40415,6 +40535,14 @@ type TreeGridListenersTypes = {
|
|
|
40415
40535
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
40416
40536
|
*/
|
|
40417
40537
|
collapseNode: (event: { source: Grid, record: Model }) => void
|
|
40538
|
+
/**
|
|
40539
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
40540
|
+
* @param {object} event Event object
|
|
40541
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
40542
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
40543
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
40544
|
+
*/
|
|
40545
|
+
columnCollapseToggle: (event: { source: GridBase, column: Column, collapsed: boolean }) => void
|
|
40418
40546
|
/**
|
|
40419
40547
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
40420
40548
|
* to indicate whether the drop position is valid or not.
|
|
@@ -40496,14 +40624,14 @@ type TreeGridListenersTypes = {
|
|
|
40496
40624
|
* ...
|
|
40497
40625
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-dataChange)
|
|
40498
40626
|
* @param {object} event Event object
|
|
40499
|
-
* @param {Grid.view.
|
|
40627
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
40500
40628
|
* @param {Core.data.Store} event.store The originating store
|
|
40501
40629
|
* @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
|
|
40502
40630
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
40503
40631
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
40504
40632
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
40505
40633
|
*/
|
|
40506
|
-
dataChange: (event: { source:
|
|
40634
|
+
dataChange: (event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void
|
|
40507
40635
|
/**
|
|
40508
40636
|
* Fires when an object is destroyed.
|
|
40509
40637
|
* @param {object} event Event object
|
|
@@ -40811,18 +40939,18 @@ type TreeGridListenersTypes = {
|
|
|
40811
40939
|
/**
|
|
40812
40940
|
* Fires after a row is rendered.
|
|
40813
40941
|
* @param {object} event Event object
|
|
40814
|
-
* @param {Grid.view.
|
|
40815
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
40816
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
40817
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
40942
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
40943
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
40944
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
40945
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
40818
40946
|
*/
|
|
40819
|
-
renderRow: (event: { source:
|
|
40947
|
+
renderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
|
|
40820
40948
|
/**
|
|
40821
40949
|
* Grid rows have been rendered
|
|
40822
40950
|
* @param {object} event Event object
|
|
40823
|
-
* @param {Grid.view.
|
|
40951
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
40824
40952
|
*/
|
|
40825
|
-
renderRows: (event: { source:
|
|
40953
|
+
renderRows: (event: { source: GridBase }) => void
|
|
40826
40954
|
/**
|
|
40827
40955
|
* Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
|
|
40828
40956
|
* @param {object} event Event object
|
|
@@ -40882,10 +41010,10 @@ type TreeGridListenersTypes = {
|
|
|
40882
41010
|
/**
|
|
40883
41011
|
* Grid has scrolled vertically
|
|
40884
41012
|
* @param {object} event Event object
|
|
40885
|
-
* @param {Grid.view.
|
|
41013
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
40886
41014
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
40887
41015
|
*/
|
|
40888
|
-
scroll: (event: { source:
|
|
41016
|
+
scroll: (event: { source: GridBase, scrollTop: number }) => void
|
|
40889
41017
|
/**
|
|
40890
41018
|
* The selection has been changed.
|
|
40891
41019
|
* @param {object} event Event object
|
|
@@ -40973,17 +41101,17 @@ type TreeGridListenersTypes = {
|
|
|
40973
41101
|
/**
|
|
40974
41102
|
* Fires after a sub grid is collapsed.
|
|
40975
41103
|
* @param {object} event Event object
|
|
40976
|
-
* @param {Grid.view.
|
|
41104
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
40977
41105
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
40978
41106
|
*/
|
|
40979
|
-
subGridCollapse: (event: { source:
|
|
41107
|
+
subGridCollapse: (event: { source: GridBase, subGrid: SubGrid }) => void
|
|
40980
41108
|
/**
|
|
40981
41109
|
* Fires after a sub grid is expanded.
|
|
40982
41110
|
* @param {object} event Event object
|
|
40983
|
-
* @param {Grid.view.
|
|
41111
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
40984
41112
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
40985
41113
|
*/
|
|
40986
|
-
subGridExpand: (event: { source:
|
|
41114
|
+
subGridExpand: (event: { source: GridBase, subGrid: SubGrid }) => void
|
|
40987
41115
|
/**
|
|
40988
41116
|
* Fired when one or more groups are expanded or collapsed
|
|
40989
41117
|
* @param {object} event Event object
|
|
@@ -41076,6 +41204,14 @@ type TreeGridListeners = {
|
|
|
41076
41204
|
* @param {any} event.value The value being set
|
|
41077
41205
|
*/
|
|
41078
41206
|
beforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
|
|
41207
|
+
/**
|
|
41208
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
41209
|
+
* @param {object} event Event object
|
|
41210
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
41211
|
+
* @param {Grid.column.Column} event.column The column
|
|
41212
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
41213
|
+
*/
|
|
41214
|
+
beforeColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
41079
41215
|
/**
|
|
41080
41216
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
41081
41217
|
* @param {object} event Event object
|
|
@@ -41176,18 +41312,18 @@ type TreeGridListeners = {
|
|
|
41176
41312
|
/**
|
|
41177
41313
|
* Fires before a row is rendered.
|
|
41178
41314
|
* @param {object} event Event object
|
|
41179
|
-
* @param {Grid.view.
|
|
41180
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
41181
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
41182
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
41315
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
41316
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
41317
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
41318
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
41183
41319
|
*/
|
|
41184
|
-
beforeRenderRow?: ((event: { source:
|
|
41320
|
+
beforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
41185
41321
|
/**
|
|
41186
41322
|
* Grid rows are about to be rendered
|
|
41187
41323
|
* @param {object} event Event object
|
|
41188
|
-
* @param {Grid.view.
|
|
41324
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
41189
41325
|
*/
|
|
41190
|
-
beforeRenderRows?: ((event: { source:
|
|
41326
|
+
beforeRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
41191
41327
|
/**
|
|
41192
41328
|
* This event fires before row collapse is started.
|
|
41193
41329
|
* ...
|
|
@@ -41418,6 +41554,14 @@ type TreeGridListeners = {
|
|
|
41418
41554
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
41419
41555
|
*/
|
|
41420
41556
|
collapseNode?: ((event: { source: Grid, record: Model }) => void)|string
|
|
41557
|
+
/**
|
|
41558
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
41559
|
+
* @param {object} event Event object
|
|
41560
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
41561
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
41562
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
41563
|
+
*/
|
|
41564
|
+
columnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
41421
41565
|
/**
|
|
41422
41566
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
41423
41567
|
* to indicate whether the drop position is valid or not.
|
|
@@ -41499,14 +41643,14 @@ type TreeGridListeners = {
|
|
|
41499
41643
|
* ...
|
|
41500
41644
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-dataChange)
|
|
41501
41645
|
* @param {object} event Event object
|
|
41502
|
-
* @param {Grid.view.
|
|
41646
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
41503
41647
|
* @param {Core.data.Store} event.store The originating store
|
|
41504
41648
|
* @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
|
|
41505
41649
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
41506
41650
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
41507
41651
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
41508
41652
|
*/
|
|
41509
|
-
dataChange?: ((event: { source:
|
|
41653
|
+
dataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
|
|
41510
41654
|
/**
|
|
41511
41655
|
* Fires when an object is destroyed.
|
|
41512
41656
|
* @param {object} event Event object
|
|
@@ -41814,18 +41958,18 @@ type TreeGridListeners = {
|
|
|
41814
41958
|
/**
|
|
41815
41959
|
* Fires after a row is rendered.
|
|
41816
41960
|
* @param {object} event Event object
|
|
41817
|
-
* @param {Grid.view.
|
|
41818
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
41819
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
41820
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
41961
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
41962
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
41963
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
41964
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
41821
41965
|
*/
|
|
41822
|
-
renderRow?: ((event: { source:
|
|
41966
|
+
renderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
41823
41967
|
/**
|
|
41824
41968
|
* Grid rows have been rendered
|
|
41825
41969
|
* @param {object} event Event object
|
|
41826
|
-
* @param {Grid.view.
|
|
41970
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
41827
41971
|
*/
|
|
41828
|
-
renderRows?: ((event: { source:
|
|
41972
|
+
renderRows?: ((event: { source: GridBase }) => void)|string
|
|
41829
41973
|
/**
|
|
41830
41974
|
* Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
|
|
41831
41975
|
* @param {object} event Event object
|
|
@@ -41885,10 +42029,10 @@ type TreeGridListeners = {
|
|
|
41885
42029
|
/**
|
|
41886
42030
|
* Grid has scrolled vertically
|
|
41887
42031
|
* @param {object} event Event object
|
|
41888
|
-
* @param {Grid.view.
|
|
42032
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
41889
42033
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
41890
42034
|
*/
|
|
41891
|
-
scroll?: ((event: { source:
|
|
42035
|
+
scroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
|
|
41892
42036
|
/**
|
|
41893
42037
|
* The selection has been changed.
|
|
41894
42038
|
* @param {object} event Event object
|
|
@@ -41976,17 +42120,17 @@ type TreeGridListeners = {
|
|
|
41976
42120
|
/**
|
|
41977
42121
|
* Fires after a sub grid is collapsed.
|
|
41978
42122
|
* @param {object} event Event object
|
|
41979
|
-
* @param {Grid.view.
|
|
42123
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
41980
42124
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
41981
42125
|
*/
|
|
41982
|
-
subGridCollapse?: ((event: { source:
|
|
42126
|
+
subGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
41983
42127
|
/**
|
|
41984
42128
|
* Fires after a sub grid is expanded.
|
|
41985
42129
|
* @param {object} event Event object
|
|
41986
|
-
* @param {Grid.view.
|
|
42130
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
41987
42131
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
41988
42132
|
*/
|
|
41989
|
-
subGridExpand?: ((event: { source:
|
|
42133
|
+
subGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
41990
42134
|
/**
|
|
41991
42135
|
* Fired when one or more groups are expanded or collapsed
|
|
41992
42136
|
* @param {object} event Event object
|
|
@@ -42914,6 +43058,14 @@ type TreeGridConfig = {
|
|
|
42914
43058
|
* @param {any} event.value The value being set
|
|
42915
43059
|
*/
|
|
42916
43060
|
onBeforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
|
|
43061
|
+
/**
|
|
43062
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
43063
|
+
* @param {object} event Event object
|
|
43064
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
43065
|
+
* @param {Grid.column.Column} event.column The column
|
|
43066
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
43067
|
+
*/
|
|
43068
|
+
onBeforeColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
42917
43069
|
/**
|
|
42918
43070
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
42919
43071
|
* @param {object} event Event object
|
|
@@ -43014,18 +43166,18 @@ type TreeGridConfig = {
|
|
|
43014
43166
|
/**
|
|
43015
43167
|
* Fires before a row is rendered.
|
|
43016
43168
|
* @param {object} event Event object
|
|
43017
|
-
* @param {Grid.view.
|
|
43018
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
43019
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
43020
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
43169
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
43170
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
43171
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
43172
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
43021
43173
|
*/
|
|
43022
|
-
onBeforeRenderRow?: ((event: { source:
|
|
43174
|
+
onBeforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
43023
43175
|
/**
|
|
43024
43176
|
* Grid rows are about to be rendered
|
|
43025
43177
|
* @param {object} event Event object
|
|
43026
|
-
* @param {Grid.view.
|
|
43178
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
43027
43179
|
*/
|
|
43028
|
-
onBeforeRenderRows?: ((event: { source:
|
|
43180
|
+
onBeforeRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
43029
43181
|
/**
|
|
43030
43182
|
* This event fires before row collapse is started.
|
|
43031
43183
|
* ...
|
|
@@ -43256,6 +43408,14 @@ type TreeGridConfig = {
|
|
|
43256
43408
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
43257
43409
|
*/
|
|
43258
43410
|
onCollapseNode?: ((event: { source: Grid, record: Model }) => void)|string
|
|
43411
|
+
/**
|
|
43412
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
43413
|
+
* @param {object} event Event object
|
|
43414
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
43415
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
43416
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
43417
|
+
*/
|
|
43418
|
+
onColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
43259
43419
|
/**
|
|
43260
43420
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
43261
43421
|
* to indicate whether the drop position is valid or not.
|
|
@@ -43337,14 +43497,14 @@ type TreeGridConfig = {
|
|
|
43337
43497
|
* ...
|
|
43338
43498
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-dataChange)
|
|
43339
43499
|
* @param {object} event Event object
|
|
43340
|
-
* @param {Grid.view.
|
|
43500
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
43341
43501
|
* @param {Core.data.Store} event.store The originating store
|
|
43342
43502
|
* @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
|
|
43343
43503
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
43344
43504
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
43345
43505
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
43346
43506
|
*/
|
|
43347
|
-
onDataChange?: ((event: { source:
|
|
43507
|
+
onDataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
|
|
43348
43508
|
/**
|
|
43349
43509
|
* Fires when an object is destroyed.
|
|
43350
43510
|
* @param {object} event Event object
|
|
@@ -43652,18 +43812,18 @@ type TreeGridConfig = {
|
|
|
43652
43812
|
/**
|
|
43653
43813
|
* Fires after a row is rendered.
|
|
43654
43814
|
* @param {object} event Event object
|
|
43655
|
-
* @param {Grid.view.
|
|
43656
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
43657
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
43658
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
43815
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
43816
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
43817
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
43818
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
43659
43819
|
*/
|
|
43660
|
-
onRenderRow?: ((event: { source:
|
|
43820
|
+
onRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
43661
43821
|
/**
|
|
43662
43822
|
* Grid rows have been rendered
|
|
43663
43823
|
* @param {object} event Event object
|
|
43664
|
-
* @param {Grid.view.
|
|
43824
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
43665
43825
|
*/
|
|
43666
|
-
onRenderRows?: ((event: { source:
|
|
43826
|
+
onRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
43667
43827
|
/**
|
|
43668
43828
|
* Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
|
|
43669
43829
|
* @param {object} event Event object
|
|
@@ -43723,10 +43883,10 @@ type TreeGridConfig = {
|
|
|
43723
43883
|
/**
|
|
43724
43884
|
* Grid has scrolled vertically
|
|
43725
43885
|
* @param {object} event Event object
|
|
43726
|
-
* @param {Grid.view.
|
|
43886
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
43727
43887
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
43728
43888
|
*/
|
|
43729
|
-
onScroll?: ((event: { source:
|
|
43889
|
+
onScroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
|
|
43730
43890
|
/**
|
|
43731
43891
|
* The selection has been changed.
|
|
43732
43892
|
* @param {object} event Event object
|
|
@@ -43814,17 +43974,17 @@ type TreeGridConfig = {
|
|
|
43814
43974
|
/**
|
|
43815
43975
|
* Fires after a sub grid is collapsed.
|
|
43816
43976
|
* @param {object} event Event object
|
|
43817
|
-
* @param {Grid.view.
|
|
43977
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
43818
43978
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
43819
43979
|
*/
|
|
43820
|
-
onSubGridCollapse?: ((event: { source:
|
|
43980
|
+
onSubGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
43821
43981
|
/**
|
|
43822
43982
|
* Fires after a sub grid is expanded.
|
|
43823
43983
|
* @param {object} event Event object
|
|
43824
|
-
* @param {Grid.view.
|
|
43984
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
43825
43985
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
43826
43986
|
*/
|
|
43827
|
-
onSubGridExpand?: ((event: { source:
|
|
43987
|
+
onSubGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
43828
43988
|
/**
|
|
43829
43989
|
* Fired when one or more groups are expanded or collapsed
|
|
43830
43990
|
* @param {object} event Event object
|