@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.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
|
|
@@ -110027,8 +110027,8 @@ type DateColumnConfig = {
|
|
|
110027
110027
|
*/
|
|
110028
110028
|
remoteChildCount?: number
|
|
110029
110029
|
/**
|
|
110030
|
-
* Renderer function, used to style the date displayed in the cell. Can also affect other aspects of
|
|
110031
|
-
*
|
|
110030
|
+
* Renderer function, used to style the date displayed in the cell. Can also affect other aspects of the cell,
|
|
110031
|
+
* such as styling.
|
|
110032
110032
|
* ...
|
|
110033
110033
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/DateColumn#config-renderer)
|
|
110034
110034
|
* @param {object} renderData Object containing renderer parameters
|
|
@@ -110189,9 +110189,9 @@ type DateColumnConfig = {
|
|
|
110189
110189
|
}
|
|
110190
110190
|
|
|
110191
110191
|
/**
|
|
110192
|
-
* 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
|
|
110193
|
-
*
|
|
110194
|
-
*
|
|
110192
|
+
* 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
|
|
110193
|
+
* the following info: full year, 2-digit month, and 2-digit day. Depending on the browser locale, the formatted date
|
|
110194
|
+
* might look different. [Intl.DateTimeFormat API](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat)
|
|
110195
110195
|
* is used to format the date. Here is an example of possible outputs depending on the browser locale:
|
|
110196
110196
|
* ...
|
|
110197
110197
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/DateColumn)
|
|
@@ -110225,8 +110225,8 @@ export class DateColumn extends Column {
|
|
|
110225
110225
|
*/
|
|
110226
110226
|
min: string|Date
|
|
110227
110227
|
/**
|
|
110228
|
-
* Renderer function, used to style the date displayed in the cell. Can also affect other aspects of
|
|
110229
|
-
*
|
|
110228
|
+
* Renderer function, used to style the date displayed in the cell. Can also affect other aspects of the cell,
|
|
110229
|
+
* such as styling.
|
|
110230
110230
|
*/
|
|
110231
110231
|
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
|
|
110232
110232
|
/**
|
|
@@ -132379,6 +132379,14 @@ type GridListenersTypes = {
|
|
|
132379
132379
|
* @param {any} event.value The value being set
|
|
132380
132380
|
*/
|
|
132381
132381
|
beforeCellRangeEdit: (event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void
|
|
132382
|
+
/**
|
|
132383
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
132384
|
+
* @param {object} event Event object
|
|
132385
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
132386
|
+
* @param {Grid.column.Column} event.column The column
|
|
132387
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
132388
|
+
*/
|
|
132389
|
+
beforeColumnCollapseToggle: (event: { source: GridBase, column: Column, collapsed: boolean }) => void
|
|
132382
132390
|
/**
|
|
132383
132391
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
132384
132392
|
* @param {object} event Event object
|
|
@@ -132479,18 +132487,18 @@ type GridListenersTypes = {
|
|
|
132479
132487
|
/**
|
|
132480
132488
|
* Fires before a row is rendered.
|
|
132481
132489
|
* @param {object} event Event object
|
|
132482
|
-
* @param {Grid.view.
|
|
132483
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
132484
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
132485
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
132490
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
132491
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
132492
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
132493
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
132486
132494
|
*/
|
|
132487
|
-
beforeRenderRow: (event: { source:
|
|
132495
|
+
beforeRenderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
|
|
132488
132496
|
/**
|
|
132489
132497
|
* Grid rows are about to be rendered
|
|
132490
132498
|
* @param {object} event Event object
|
|
132491
|
-
* @param {Grid.view.
|
|
132499
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
132492
132500
|
*/
|
|
132493
|
-
beforeRenderRows: (event: { source:
|
|
132501
|
+
beforeRenderRows: (event: { source: GridBase }) => void
|
|
132494
132502
|
/**
|
|
132495
132503
|
* This event fires before row collapse is started.
|
|
132496
132504
|
* ...
|
|
@@ -132721,6 +132729,14 @@ type GridListenersTypes = {
|
|
|
132721
132729
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
132722
132730
|
*/
|
|
132723
132731
|
collapseNode: (event: { source: Grid, record: Model }) => void
|
|
132732
|
+
/**
|
|
132733
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
132734
|
+
* @param {object} event Event object
|
|
132735
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
132736
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
132737
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
132738
|
+
*/
|
|
132739
|
+
columnCollapseToggle: (event: { source: GridBase, column: Column, collapsed: boolean }) => void
|
|
132724
132740
|
/**
|
|
132725
132741
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
132726
132742
|
* to indicate whether the drop position is valid or not.
|
|
@@ -132802,14 +132818,14 @@ type GridListenersTypes = {
|
|
|
132802
132818
|
* ...
|
|
132803
132819
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-dataChange)
|
|
132804
132820
|
* @param {object} event Event object
|
|
132805
|
-
* @param {Grid.view.
|
|
132821
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
132806
132822
|
* @param {Core.data.Store} event.store The originating store
|
|
132807
132823
|
* @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'`
|
|
132808
132824
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
132809
132825
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
132810
132826
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
132811
132827
|
*/
|
|
132812
|
-
dataChange: (event: { source:
|
|
132828
|
+
dataChange: (event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void
|
|
132813
132829
|
/**
|
|
132814
132830
|
* Fires when an object is destroyed.
|
|
132815
132831
|
* @param {object} event Event object
|
|
@@ -133117,18 +133133,18 @@ type GridListenersTypes = {
|
|
|
133117
133133
|
/**
|
|
133118
133134
|
* Fires after a row is rendered.
|
|
133119
133135
|
* @param {object} event Event object
|
|
133120
|
-
* @param {Grid.view.
|
|
133121
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
133122
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
133123
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
133136
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
133137
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
133138
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
133139
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
133124
133140
|
*/
|
|
133125
|
-
renderRow: (event: { source:
|
|
133141
|
+
renderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
|
|
133126
133142
|
/**
|
|
133127
133143
|
* Grid rows have been rendered
|
|
133128
133144
|
* @param {object} event Event object
|
|
133129
|
-
* @param {Grid.view.
|
|
133145
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
133130
133146
|
*/
|
|
133131
|
-
renderRows: (event: { source:
|
|
133147
|
+
renderRows: (event: { source: GridBase }) => void
|
|
133132
133148
|
/**
|
|
133133
133149
|
* 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`*.
|
|
133134
133150
|
* @param {object} event Event object
|
|
@@ -133188,10 +133204,10 @@ type GridListenersTypes = {
|
|
|
133188
133204
|
/**
|
|
133189
133205
|
* Grid has scrolled vertically
|
|
133190
133206
|
* @param {object} event Event object
|
|
133191
|
-
* @param {Grid.view.
|
|
133207
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
133192
133208
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
133193
133209
|
*/
|
|
133194
|
-
scroll: (event: { source:
|
|
133210
|
+
scroll: (event: { source: GridBase, scrollTop: number }) => void
|
|
133195
133211
|
/**
|
|
133196
133212
|
* The selection has been changed.
|
|
133197
133213
|
* @param {object} event Event object
|
|
@@ -133279,17 +133295,17 @@ type GridListenersTypes = {
|
|
|
133279
133295
|
/**
|
|
133280
133296
|
* Fires after a sub grid is collapsed.
|
|
133281
133297
|
* @param {object} event Event object
|
|
133282
|
-
* @param {Grid.view.
|
|
133298
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
133283
133299
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
133284
133300
|
*/
|
|
133285
|
-
subGridCollapse: (event: { source:
|
|
133301
|
+
subGridCollapse: (event: { source: GridBase, subGrid: SubGrid }) => void
|
|
133286
133302
|
/**
|
|
133287
133303
|
* Fires after a sub grid is expanded.
|
|
133288
133304
|
* @param {object} event Event object
|
|
133289
|
-
* @param {Grid.view.
|
|
133305
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
133290
133306
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
133291
133307
|
*/
|
|
133292
|
-
subGridExpand: (event: { source:
|
|
133308
|
+
subGridExpand: (event: { source: GridBase, subGrid: SubGrid }) => void
|
|
133293
133309
|
/**
|
|
133294
133310
|
* Fired when one or more groups are expanded or collapsed
|
|
133295
133311
|
* @param {object} event Event object
|
|
@@ -133382,6 +133398,14 @@ type GridListeners = {
|
|
|
133382
133398
|
* @param {any} event.value The value being set
|
|
133383
133399
|
*/
|
|
133384
133400
|
beforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
|
|
133401
|
+
/**
|
|
133402
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
133403
|
+
* @param {object} event Event object
|
|
133404
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
133405
|
+
* @param {Grid.column.Column} event.column The column
|
|
133406
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
133407
|
+
*/
|
|
133408
|
+
beforeColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
133385
133409
|
/**
|
|
133386
133410
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
133387
133411
|
* @param {object} event Event object
|
|
@@ -133482,18 +133506,18 @@ type GridListeners = {
|
|
|
133482
133506
|
/**
|
|
133483
133507
|
* Fires before a row is rendered.
|
|
133484
133508
|
* @param {object} event Event object
|
|
133485
|
-
* @param {Grid.view.
|
|
133486
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
133487
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
133488
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
133509
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
133510
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
133511
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
133512
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
133489
133513
|
*/
|
|
133490
|
-
beforeRenderRow?: ((event: { source:
|
|
133514
|
+
beforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
133491
133515
|
/**
|
|
133492
133516
|
* Grid rows are about to be rendered
|
|
133493
133517
|
* @param {object} event Event object
|
|
133494
|
-
* @param {Grid.view.
|
|
133518
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
133495
133519
|
*/
|
|
133496
|
-
beforeRenderRows?: ((event: { source:
|
|
133520
|
+
beforeRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
133497
133521
|
/**
|
|
133498
133522
|
* This event fires before row collapse is started.
|
|
133499
133523
|
* ...
|
|
@@ -133724,6 +133748,14 @@ type GridListeners = {
|
|
|
133724
133748
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
133725
133749
|
*/
|
|
133726
133750
|
collapseNode?: ((event: { source: Grid, record: Model }) => void)|string
|
|
133751
|
+
/**
|
|
133752
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
133753
|
+
* @param {object} event Event object
|
|
133754
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
133755
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
133756
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
133757
|
+
*/
|
|
133758
|
+
columnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
133727
133759
|
/**
|
|
133728
133760
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
133729
133761
|
* to indicate whether the drop position is valid or not.
|
|
@@ -133805,14 +133837,14 @@ type GridListeners = {
|
|
|
133805
133837
|
* ...
|
|
133806
133838
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-dataChange)
|
|
133807
133839
|
* @param {object} event Event object
|
|
133808
|
-
* @param {Grid.view.
|
|
133840
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
133809
133841
|
* @param {Core.data.Store} event.store The originating store
|
|
133810
133842
|
* @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'`
|
|
133811
133843
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
133812
133844
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
133813
133845
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
133814
133846
|
*/
|
|
133815
|
-
dataChange?: ((event: { source:
|
|
133847
|
+
dataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
|
|
133816
133848
|
/**
|
|
133817
133849
|
* Fires when an object is destroyed.
|
|
133818
133850
|
* @param {object} event Event object
|
|
@@ -134120,18 +134152,18 @@ type GridListeners = {
|
|
|
134120
134152
|
/**
|
|
134121
134153
|
* Fires after a row is rendered.
|
|
134122
134154
|
* @param {object} event Event object
|
|
134123
|
-
* @param {Grid.view.
|
|
134124
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
134125
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
134126
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
134155
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
134156
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
134157
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
134158
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
134127
134159
|
*/
|
|
134128
|
-
renderRow?: ((event: { source:
|
|
134160
|
+
renderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
134129
134161
|
/**
|
|
134130
134162
|
* Grid rows have been rendered
|
|
134131
134163
|
* @param {object} event Event object
|
|
134132
|
-
* @param {Grid.view.
|
|
134164
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
134133
134165
|
*/
|
|
134134
|
-
renderRows?: ((event: { source:
|
|
134166
|
+
renderRows?: ((event: { source: GridBase }) => void)|string
|
|
134135
134167
|
/**
|
|
134136
134168
|
* 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`*.
|
|
134137
134169
|
* @param {object} event Event object
|
|
@@ -134191,10 +134223,10 @@ type GridListeners = {
|
|
|
134191
134223
|
/**
|
|
134192
134224
|
* Grid has scrolled vertically
|
|
134193
134225
|
* @param {object} event Event object
|
|
134194
|
-
* @param {Grid.view.
|
|
134226
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
134195
134227
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
134196
134228
|
*/
|
|
134197
|
-
scroll?: ((event: { source:
|
|
134229
|
+
scroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
|
|
134198
134230
|
/**
|
|
134199
134231
|
* The selection has been changed.
|
|
134200
134232
|
* @param {object} event Event object
|
|
@@ -134282,17 +134314,17 @@ type GridListeners = {
|
|
|
134282
134314
|
/**
|
|
134283
134315
|
* Fires after a sub grid is collapsed.
|
|
134284
134316
|
* @param {object} event Event object
|
|
134285
|
-
* @param {Grid.view.
|
|
134317
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
134286
134318
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
134287
134319
|
*/
|
|
134288
|
-
subGridCollapse?: ((event: { source:
|
|
134320
|
+
subGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
134289
134321
|
/**
|
|
134290
134322
|
* Fires after a sub grid is expanded.
|
|
134291
134323
|
* @param {object} event Event object
|
|
134292
|
-
* @param {Grid.view.
|
|
134324
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
134293
134325
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
134294
134326
|
*/
|
|
134295
|
-
subGridExpand?: ((event: { source:
|
|
134327
|
+
subGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
134296
134328
|
/**
|
|
134297
134329
|
* Fired when one or more groups are expanded or collapsed
|
|
134298
134330
|
* @param {object} event Event object
|
|
@@ -135220,6 +135252,14 @@ type GridConfig = {
|
|
|
135220
135252
|
* @param {any} event.value The value being set
|
|
135221
135253
|
*/
|
|
135222
135254
|
onBeforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
|
|
135255
|
+
/**
|
|
135256
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
135257
|
+
* @param {object} event Event object
|
|
135258
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
135259
|
+
* @param {Grid.column.Column} event.column The column
|
|
135260
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
135261
|
+
*/
|
|
135262
|
+
onBeforeColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
135223
135263
|
/**
|
|
135224
135264
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
135225
135265
|
* @param {object} event Event object
|
|
@@ -135320,18 +135360,18 @@ type GridConfig = {
|
|
|
135320
135360
|
/**
|
|
135321
135361
|
* Fires before a row is rendered.
|
|
135322
135362
|
* @param {object} event Event object
|
|
135323
|
-
* @param {Grid.view.
|
|
135324
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
135325
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
135326
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
135363
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
135364
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
135365
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
135366
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
135327
135367
|
*/
|
|
135328
|
-
onBeforeRenderRow?: ((event: { source:
|
|
135368
|
+
onBeforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
135329
135369
|
/**
|
|
135330
135370
|
* Grid rows are about to be rendered
|
|
135331
135371
|
* @param {object} event Event object
|
|
135332
|
-
* @param {Grid.view.
|
|
135372
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
135333
135373
|
*/
|
|
135334
|
-
onBeforeRenderRows?: ((event: { source:
|
|
135374
|
+
onBeforeRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
135335
135375
|
/**
|
|
135336
135376
|
* This event fires before row collapse is started.
|
|
135337
135377
|
* ...
|
|
@@ -135562,6 +135602,14 @@ type GridConfig = {
|
|
|
135562
135602
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
135563
135603
|
*/
|
|
135564
135604
|
onCollapseNode?: ((event: { source: Grid, record: Model }) => void)|string
|
|
135605
|
+
/**
|
|
135606
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
135607
|
+
* @param {object} event Event object
|
|
135608
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
135609
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
135610
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
135611
|
+
*/
|
|
135612
|
+
onColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
135565
135613
|
/**
|
|
135566
135614
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
135567
135615
|
* to indicate whether the drop position is valid or not.
|
|
@@ -135643,14 +135691,14 @@ type GridConfig = {
|
|
|
135643
135691
|
* ...
|
|
135644
135692
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-dataChange)
|
|
135645
135693
|
* @param {object} event Event object
|
|
135646
|
-
* @param {Grid.view.
|
|
135694
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
135647
135695
|
* @param {Core.data.Store} event.store The originating store
|
|
135648
135696
|
* @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'`
|
|
135649
135697
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
135650
135698
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
135651
135699
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
135652
135700
|
*/
|
|
135653
|
-
onDataChange?: ((event: { source:
|
|
135701
|
+
onDataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
|
|
135654
135702
|
/**
|
|
135655
135703
|
* Fires when an object is destroyed.
|
|
135656
135704
|
* @param {object} event Event object
|
|
@@ -135958,18 +136006,18 @@ type GridConfig = {
|
|
|
135958
136006
|
/**
|
|
135959
136007
|
* Fires after a row is rendered.
|
|
135960
136008
|
* @param {object} event Event object
|
|
135961
|
-
* @param {Grid.view.
|
|
135962
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
135963
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
135964
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
136009
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
136010
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
136011
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
136012
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
135965
136013
|
*/
|
|
135966
|
-
onRenderRow?: ((event: { source:
|
|
136014
|
+
onRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
135967
136015
|
/**
|
|
135968
136016
|
* Grid rows have been rendered
|
|
135969
136017
|
* @param {object} event Event object
|
|
135970
|
-
* @param {Grid.view.
|
|
136018
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
135971
136019
|
*/
|
|
135972
|
-
onRenderRows?: ((event: { source:
|
|
136020
|
+
onRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
135973
136021
|
/**
|
|
135974
136022
|
* 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`*.
|
|
135975
136023
|
* @param {object} event Event object
|
|
@@ -136029,10 +136077,10 @@ type GridConfig = {
|
|
|
136029
136077
|
/**
|
|
136030
136078
|
* Grid has scrolled vertically
|
|
136031
136079
|
* @param {object} event Event object
|
|
136032
|
-
* @param {Grid.view.
|
|
136080
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
136033
136081
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
136034
136082
|
*/
|
|
136035
|
-
onScroll?: ((event: { source:
|
|
136083
|
+
onScroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
|
|
136036
136084
|
/**
|
|
136037
136085
|
* The selection has been changed.
|
|
136038
136086
|
* @param {object} event Event object
|
|
@@ -136120,17 +136168,17 @@ type GridConfig = {
|
|
|
136120
136168
|
/**
|
|
136121
136169
|
* Fires after a sub grid is collapsed.
|
|
136122
136170
|
* @param {object} event Event object
|
|
136123
|
-
* @param {Grid.view.
|
|
136171
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
136124
136172
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
136125
136173
|
*/
|
|
136126
|
-
onSubGridCollapse?: ((event: { source:
|
|
136174
|
+
onSubGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
136127
136175
|
/**
|
|
136128
136176
|
* Fires after a sub grid is expanded.
|
|
136129
136177
|
* @param {object} event Event object
|
|
136130
|
-
* @param {Grid.view.
|
|
136178
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
136131
136179
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
136132
136180
|
*/
|
|
136133
|
-
onSubGridExpand?: ((event: { source:
|
|
136181
|
+
onSubGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
136134
136182
|
/**
|
|
136135
136183
|
* Fired when one or more groups are expanded or collapsed
|
|
136136
136184
|
* @param {object} event Event object
|
|
@@ -136442,6 +136490,14 @@ type GridBaseListenersTypes = {
|
|
|
136442
136490
|
* @param {any} event.value The value being set
|
|
136443
136491
|
*/
|
|
136444
136492
|
beforeCellRangeEdit: (event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void
|
|
136493
|
+
/**
|
|
136494
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
136495
|
+
* @param {object} event Event object
|
|
136496
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
136497
|
+
* @param {Grid.column.Column} event.column The column
|
|
136498
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
136499
|
+
*/
|
|
136500
|
+
beforeColumnCollapseToggle: (event: { source: GridBase, column: Column, collapsed: boolean }) => void
|
|
136445
136501
|
/**
|
|
136446
136502
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
136447
136503
|
* @param {object} event Event object
|
|
@@ -136542,18 +136598,18 @@ type GridBaseListenersTypes = {
|
|
|
136542
136598
|
/**
|
|
136543
136599
|
* Fires before a row is rendered.
|
|
136544
136600
|
* @param {object} event Event object
|
|
136545
|
-
* @param {Grid.view.
|
|
136546
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
136547
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
136548
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
136601
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
136602
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
136603
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
136604
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
136549
136605
|
*/
|
|
136550
|
-
beforeRenderRow: (event: { source:
|
|
136606
|
+
beforeRenderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
|
|
136551
136607
|
/**
|
|
136552
136608
|
* Grid rows are about to be rendered
|
|
136553
136609
|
* @param {object} event Event object
|
|
136554
|
-
* @param {Grid.view.
|
|
136610
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
136555
136611
|
*/
|
|
136556
|
-
beforeRenderRows: (event: { source:
|
|
136612
|
+
beforeRenderRows: (event: { source: GridBase }) => void
|
|
136557
136613
|
/**
|
|
136558
136614
|
* This event fires before row collapse is started.
|
|
136559
136615
|
* ...
|
|
@@ -136784,6 +136840,14 @@ type GridBaseListenersTypes = {
|
|
|
136784
136840
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
136785
136841
|
*/
|
|
136786
136842
|
collapseNode: (event: { source: Grid, record: Model }) => void
|
|
136843
|
+
/**
|
|
136844
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
136845
|
+
* @param {object} event Event object
|
|
136846
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
136847
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
136848
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
136849
|
+
*/
|
|
136850
|
+
columnCollapseToggle: (event: { source: GridBase, column: Column, collapsed: boolean }) => void
|
|
136787
136851
|
/**
|
|
136788
136852
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
136789
136853
|
* to indicate whether the drop position is valid or not.
|
|
@@ -136865,14 +136929,14 @@ type GridBaseListenersTypes = {
|
|
|
136865
136929
|
* ...
|
|
136866
136930
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-dataChange)
|
|
136867
136931
|
* @param {object} event Event object
|
|
136868
|
-
* @param {Grid.view.
|
|
136932
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
136869
136933
|
* @param {Core.data.Store} event.store The originating store
|
|
136870
136934
|
* @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'`
|
|
136871
136935
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
136872
136936
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
136873
136937
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
136874
136938
|
*/
|
|
136875
|
-
dataChange: (event: { source:
|
|
136939
|
+
dataChange: (event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void
|
|
136876
136940
|
/**
|
|
136877
136941
|
* Fires when an object is destroyed.
|
|
136878
136942
|
* @param {object} event Event object
|
|
@@ -137180,18 +137244,18 @@ type GridBaseListenersTypes = {
|
|
|
137180
137244
|
/**
|
|
137181
137245
|
* Fires after a row is rendered.
|
|
137182
137246
|
* @param {object} event Event object
|
|
137183
|
-
* @param {Grid.view.
|
|
137184
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
137185
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
137186
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
137247
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
137248
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
137249
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
137250
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
137187
137251
|
*/
|
|
137188
|
-
renderRow: (event: { source:
|
|
137252
|
+
renderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
|
|
137189
137253
|
/**
|
|
137190
137254
|
* Grid rows have been rendered
|
|
137191
137255
|
* @param {object} event Event object
|
|
137192
|
-
* @param {Grid.view.
|
|
137256
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
137193
137257
|
*/
|
|
137194
|
-
renderRows: (event: { source:
|
|
137258
|
+
renderRows: (event: { source: GridBase }) => void
|
|
137195
137259
|
/**
|
|
137196
137260
|
* 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`*.
|
|
137197
137261
|
* @param {object} event Event object
|
|
@@ -137251,10 +137315,10 @@ type GridBaseListenersTypes = {
|
|
|
137251
137315
|
/**
|
|
137252
137316
|
* Grid has scrolled vertically
|
|
137253
137317
|
* @param {object} event Event object
|
|
137254
|
-
* @param {Grid.view.
|
|
137318
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
137255
137319
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
137256
137320
|
*/
|
|
137257
|
-
scroll: (event: { source:
|
|
137321
|
+
scroll: (event: { source: GridBase, scrollTop: number }) => void
|
|
137258
137322
|
/**
|
|
137259
137323
|
* The selection has been changed.
|
|
137260
137324
|
* @param {object} event Event object
|
|
@@ -137342,17 +137406,17 @@ type GridBaseListenersTypes = {
|
|
|
137342
137406
|
/**
|
|
137343
137407
|
* Fires after a sub grid is collapsed.
|
|
137344
137408
|
* @param {object} event Event object
|
|
137345
|
-
* @param {Grid.view.
|
|
137409
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
137346
137410
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
137347
137411
|
*/
|
|
137348
|
-
subGridCollapse: (event: { source:
|
|
137412
|
+
subGridCollapse: (event: { source: GridBase, subGrid: SubGrid }) => void
|
|
137349
137413
|
/**
|
|
137350
137414
|
* Fires after a sub grid is expanded.
|
|
137351
137415
|
* @param {object} event Event object
|
|
137352
|
-
* @param {Grid.view.
|
|
137416
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
137353
137417
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
137354
137418
|
*/
|
|
137355
|
-
subGridExpand: (event: { source:
|
|
137419
|
+
subGridExpand: (event: { source: GridBase, subGrid: SubGrid }) => void
|
|
137356
137420
|
/**
|
|
137357
137421
|
* Fired when one or more groups are expanded or collapsed
|
|
137358
137422
|
* @param {object} event Event object
|
|
@@ -137445,6 +137509,14 @@ type GridBaseListeners = {
|
|
|
137445
137509
|
* @param {any} event.value The value being set
|
|
137446
137510
|
*/
|
|
137447
137511
|
beforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
|
|
137512
|
+
/**
|
|
137513
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
137514
|
+
* @param {object} event Event object
|
|
137515
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
137516
|
+
* @param {Grid.column.Column} event.column The column
|
|
137517
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
137518
|
+
*/
|
|
137519
|
+
beforeColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
137448
137520
|
/**
|
|
137449
137521
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
137450
137522
|
* @param {object} event Event object
|
|
@@ -137545,18 +137617,18 @@ type GridBaseListeners = {
|
|
|
137545
137617
|
/**
|
|
137546
137618
|
* Fires before a row is rendered.
|
|
137547
137619
|
* @param {object} event Event object
|
|
137548
|
-
* @param {Grid.view.
|
|
137549
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
137550
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
137551
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
137620
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
137621
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
137622
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
137623
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
137552
137624
|
*/
|
|
137553
|
-
beforeRenderRow?: ((event: { source:
|
|
137625
|
+
beforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
137554
137626
|
/**
|
|
137555
137627
|
* Grid rows are about to be rendered
|
|
137556
137628
|
* @param {object} event Event object
|
|
137557
|
-
* @param {Grid.view.
|
|
137629
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
137558
137630
|
*/
|
|
137559
|
-
beforeRenderRows?: ((event: { source:
|
|
137631
|
+
beforeRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
137560
137632
|
/**
|
|
137561
137633
|
* This event fires before row collapse is started.
|
|
137562
137634
|
* ...
|
|
@@ -137787,6 +137859,14 @@ type GridBaseListeners = {
|
|
|
137787
137859
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
137788
137860
|
*/
|
|
137789
137861
|
collapseNode?: ((event: { source: Grid, record: Model }) => void)|string
|
|
137862
|
+
/**
|
|
137863
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
137864
|
+
* @param {object} event Event object
|
|
137865
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
137866
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
137867
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
137868
|
+
*/
|
|
137869
|
+
columnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
137790
137870
|
/**
|
|
137791
137871
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
137792
137872
|
* to indicate whether the drop position is valid or not.
|
|
@@ -137868,14 +137948,14 @@ type GridBaseListeners = {
|
|
|
137868
137948
|
* ...
|
|
137869
137949
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-dataChange)
|
|
137870
137950
|
* @param {object} event Event object
|
|
137871
|
-
* @param {Grid.view.
|
|
137951
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
137872
137952
|
* @param {Core.data.Store} event.store The originating store
|
|
137873
137953
|
* @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'`
|
|
137874
137954
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
137875
137955
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
137876
137956
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
137877
137957
|
*/
|
|
137878
|
-
dataChange?: ((event: { source:
|
|
137958
|
+
dataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
|
|
137879
137959
|
/**
|
|
137880
137960
|
* Fires when an object is destroyed.
|
|
137881
137961
|
* @param {object} event Event object
|
|
@@ -138183,18 +138263,18 @@ type GridBaseListeners = {
|
|
|
138183
138263
|
/**
|
|
138184
138264
|
* Fires after a row is rendered.
|
|
138185
138265
|
* @param {object} event Event object
|
|
138186
|
-
* @param {Grid.view.
|
|
138187
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
138188
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
138189
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
138266
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
138267
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
138268
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
138269
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
138190
138270
|
*/
|
|
138191
|
-
renderRow?: ((event: { source:
|
|
138271
|
+
renderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
138192
138272
|
/**
|
|
138193
138273
|
* Grid rows have been rendered
|
|
138194
138274
|
* @param {object} event Event object
|
|
138195
|
-
* @param {Grid.view.
|
|
138275
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
138196
138276
|
*/
|
|
138197
|
-
renderRows?: ((event: { source:
|
|
138277
|
+
renderRows?: ((event: { source: GridBase }) => void)|string
|
|
138198
138278
|
/**
|
|
138199
138279
|
* 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`*.
|
|
138200
138280
|
* @param {object} event Event object
|
|
@@ -138254,10 +138334,10 @@ type GridBaseListeners = {
|
|
|
138254
138334
|
/**
|
|
138255
138335
|
* Grid has scrolled vertically
|
|
138256
138336
|
* @param {object} event Event object
|
|
138257
|
-
* @param {Grid.view.
|
|
138337
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
138258
138338
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
138259
138339
|
*/
|
|
138260
|
-
scroll?: ((event: { source:
|
|
138340
|
+
scroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
|
|
138261
138341
|
/**
|
|
138262
138342
|
* The selection has been changed.
|
|
138263
138343
|
* @param {object} event Event object
|
|
@@ -138345,17 +138425,17 @@ type GridBaseListeners = {
|
|
|
138345
138425
|
/**
|
|
138346
138426
|
* Fires after a sub grid is collapsed.
|
|
138347
138427
|
* @param {object} event Event object
|
|
138348
|
-
* @param {Grid.view.
|
|
138428
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
138349
138429
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
138350
138430
|
*/
|
|
138351
|
-
subGridCollapse?: ((event: { source:
|
|
138431
|
+
subGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
138352
138432
|
/**
|
|
138353
138433
|
* Fires after a sub grid is expanded.
|
|
138354
138434
|
* @param {object} event Event object
|
|
138355
|
-
* @param {Grid.view.
|
|
138435
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
138356
138436
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
138357
138437
|
*/
|
|
138358
|
-
subGridExpand?: ((event: { source:
|
|
138438
|
+
subGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
138359
138439
|
/**
|
|
138360
138440
|
* Fired when one or more groups are expanded or collapsed
|
|
138361
138441
|
* @param {object} event Event object
|
|
@@ -139282,6 +139362,14 @@ type GridBaseConfig = {
|
|
|
139282
139362
|
* @param {any} event.value The value being set
|
|
139283
139363
|
*/
|
|
139284
139364
|
onBeforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
|
|
139365
|
+
/**
|
|
139366
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
139367
|
+
* @param {object} event Event object
|
|
139368
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
139369
|
+
* @param {Grid.column.Column} event.column The column
|
|
139370
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
139371
|
+
*/
|
|
139372
|
+
onBeforeColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
139285
139373
|
/**
|
|
139286
139374
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
139287
139375
|
* @param {object} event Event object
|
|
@@ -139382,18 +139470,18 @@ type GridBaseConfig = {
|
|
|
139382
139470
|
/**
|
|
139383
139471
|
* Fires before a row is rendered.
|
|
139384
139472
|
* @param {object} event Event object
|
|
139385
|
-
* @param {Grid.view.
|
|
139386
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
139387
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
139388
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
139473
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
139474
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
139475
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
139476
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
139389
139477
|
*/
|
|
139390
|
-
onBeforeRenderRow?: ((event: { source:
|
|
139478
|
+
onBeforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
139391
139479
|
/**
|
|
139392
139480
|
* Grid rows are about to be rendered
|
|
139393
139481
|
* @param {object} event Event object
|
|
139394
|
-
* @param {Grid.view.
|
|
139482
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
139395
139483
|
*/
|
|
139396
|
-
onBeforeRenderRows?: ((event: { source:
|
|
139484
|
+
onBeforeRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
139397
139485
|
/**
|
|
139398
139486
|
* This event fires before row collapse is started.
|
|
139399
139487
|
* ...
|
|
@@ -139624,6 +139712,14 @@ type GridBaseConfig = {
|
|
|
139624
139712
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
139625
139713
|
*/
|
|
139626
139714
|
onCollapseNode?: ((event: { source: Grid, record: Model }) => void)|string
|
|
139715
|
+
/**
|
|
139716
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
139717
|
+
* @param {object} event Event object
|
|
139718
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
139719
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
139720
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
139721
|
+
*/
|
|
139722
|
+
onColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
139627
139723
|
/**
|
|
139628
139724
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
139629
139725
|
* to indicate whether the drop position is valid or not.
|
|
@@ -139705,14 +139801,14 @@ type GridBaseConfig = {
|
|
|
139705
139801
|
* ...
|
|
139706
139802
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-dataChange)
|
|
139707
139803
|
* @param {object} event Event object
|
|
139708
|
-
* @param {Grid.view.
|
|
139804
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
139709
139805
|
* @param {Core.data.Store} event.store The originating store
|
|
139710
139806
|
* @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'`
|
|
139711
139807
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
139712
139808
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
139713
139809
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
139714
139810
|
*/
|
|
139715
|
-
onDataChange?: ((event: { source:
|
|
139811
|
+
onDataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
|
|
139716
139812
|
/**
|
|
139717
139813
|
* Fires when an object is destroyed.
|
|
139718
139814
|
* @param {object} event Event object
|
|
@@ -140020,18 +140116,18 @@ type GridBaseConfig = {
|
|
|
140020
140116
|
/**
|
|
140021
140117
|
* Fires after a row is rendered.
|
|
140022
140118
|
* @param {object} event Event object
|
|
140023
|
-
* @param {Grid.view.
|
|
140024
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
140025
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
140026
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
140119
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
140120
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
140121
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
140122
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
140027
140123
|
*/
|
|
140028
|
-
onRenderRow?: ((event: { source:
|
|
140124
|
+
onRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
140029
140125
|
/**
|
|
140030
140126
|
* Grid rows have been rendered
|
|
140031
140127
|
* @param {object} event Event object
|
|
140032
|
-
* @param {Grid.view.
|
|
140128
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
140033
140129
|
*/
|
|
140034
|
-
onRenderRows?: ((event: { source:
|
|
140130
|
+
onRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
140035
140131
|
/**
|
|
140036
140132
|
* 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`*.
|
|
140037
140133
|
* @param {object} event Event object
|
|
@@ -140091,10 +140187,10 @@ type GridBaseConfig = {
|
|
|
140091
140187
|
/**
|
|
140092
140188
|
* Grid has scrolled vertically
|
|
140093
140189
|
* @param {object} event Event object
|
|
140094
|
-
* @param {Grid.view.
|
|
140190
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
140095
140191
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
140096
140192
|
*/
|
|
140097
|
-
onScroll?: ((event: { source:
|
|
140193
|
+
onScroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
|
|
140098
140194
|
/**
|
|
140099
140195
|
* The selection has been changed.
|
|
140100
140196
|
* @param {object} event Event object
|
|
@@ -140182,17 +140278,17 @@ type GridBaseConfig = {
|
|
|
140182
140278
|
/**
|
|
140183
140279
|
* Fires after a sub grid is collapsed.
|
|
140184
140280
|
* @param {object} event Event object
|
|
140185
|
-
* @param {Grid.view.
|
|
140281
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
140186
140282
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
140187
140283
|
*/
|
|
140188
|
-
onSubGridCollapse?: ((event: { source:
|
|
140284
|
+
onSubGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
140189
140285
|
/**
|
|
140190
140286
|
* Fires after a sub grid is expanded.
|
|
140191
140287
|
* @param {object} event Event object
|
|
140192
|
-
* @param {Grid.view.
|
|
140288
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
140193
140289
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
140194
140290
|
*/
|
|
140195
|
-
onSubGridExpand?: ((event: { source:
|
|
140291
|
+
onSubGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
140196
140292
|
/**
|
|
140197
140293
|
* Fired when one or more groups are expanded or collapsed
|
|
140198
140294
|
* @param {object} event Event object
|
|
@@ -140614,6 +140710,14 @@ export class GridBase extends Panel {
|
|
|
140614
140710
|
* @param {any} event.value The value being set
|
|
140615
140711
|
*/
|
|
140616
140712
|
onBeforeCellRangeEdit: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
|
|
140713
|
+
/**
|
|
140714
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
140715
|
+
* @param {object} event Event object
|
|
140716
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
140717
|
+
* @param {Grid.column.Column} event.column The column
|
|
140718
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
140719
|
+
*/
|
|
140720
|
+
onBeforeColumnCollapseToggle: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
140617
140721
|
/**
|
|
140618
140722
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
140619
140723
|
* @param {object} event Event object
|
|
@@ -140708,18 +140812,18 @@ export class GridBase extends Panel {
|
|
|
140708
140812
|
/**
|
|
140709
140813
|
* Fires before a row is rendered.
|
|
140710
140814
|
* @param {object} event Event object
|
|
140711
|
-
* @param {Grid.view.
|
|
140712
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
140713
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
140714
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
140815
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
140816
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
140817
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
140818
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
140715
140819
|
*/
|
|
140716
|
-
onBeforeRenderRow: ((event: { source:
|
|
140820
|
+
onBeforeRenderRow: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
140717
140821
|
/**
|
|
140718
140822
|
* Grid rows are about to be rendered
|
|
140719
140823
|
* @param {object} event Event object
|
|
140720
|
-
* @param {Grid.view.
|
|
140824
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
140721
140825
|
*/
|
|
140722
|
-
onBeforeRenderRows: ((event: { source:
|
|
140826
|
+
onBeforeRenderRows: ((event: { source: GridBase }) => void)|string
|
|
140723
140827
|
/**
|
|
140724
140828
|
* This event fires before row collapse is started.
|
|
140725
140829
|
* ...
|
|
@@ -140930,6 +141034,14 @@ export class GridBase extends Panel {
|
|
|
140930
141034
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
140931
141035
|
*/
|
|
140932
141036
|
onCollapseNode: ((event: { source: Grid, record: Model }) => void)|string
|
|
141037
|
+
/**
|
|
141038
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
141039
|
+
* @param {object} event Event object
|
|
141040
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
141041
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
141042
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
141043
|
+
*/
|
|
141044
|
+
onColumnCollapseToggle: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
140933
141045
|
/**
|
|
140934
141046
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
140935
141047
|
* to indicate whether the drop position is valid or not.
|
|
@@ -140994,14 +141106,14 @@ export class GridBase extends Panel {
|
|
|
140994
141106
|
* ...
|
|
140995
141107
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-dataChange)
|
|
140996
141108
|
* @param {object} event Event object
|
|
140997
|
-
* @param {Grid.view.
|
|
141109
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
140998
141110
|
* @param {Core.data.Store} event.store The originating store
|
|
140999
141111
|
* @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'`
|
|
141000
141112
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
141001
141113
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
141002
141114
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
141003
141115
|
*/
|
|
141004
|
-
onDataChange: ((event: { source:
|
|
141116
|
+
onDataChange: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
|
|
141005
141117
|
/**
|
|
141006
141118
|
* Fires when an object is destroyed.
|
|
141007
141119
|
* @param {object} event Event object
|
|
@@ -141239,18 +141351,18 @@ export class GridBase extends Panel {
|
|
|
141239
141351
|
/**
|
|
141240
141352
|
* Fires after a row is rendered.
|
|
141241
141353
|
* @param {object} event Event object
|
|
141242
|
-
* @param {Grid.view.
|
|
141243
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
141244
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
141245
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
141354
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
141355
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
141356
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
141357
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
141246
141358
|
*/
|
|
141247
|
-
onRenderRow: ((event: { source:
|
|
141359
|
+
onRenderRow: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
141248
141360
|
/**
|
|
141249
141361
|
* Grid rows have been rendered
|
|
141250
141362
|
* @param {object} event Event object
|
|
141251
|
-
* @param {Grid.view.
|
|
141363
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
141252
141364
|
*/
|
|
141253
|
-
onRenderRows: ((event: { source:
|
|
141365
|
+
onRenderRows: ((event: { source: GridBase }) => void)|string
|
|
141254
141366
|
/**
|
|
141255
141367
|
* Grid resize lead to a new responsive level being applied
|
|
141256
141368
|
* @param {object} event Event object
|
|
@@ -141300,10 +141412,10 @@ export class GridBase extends Panel {
|
|
|
141300
141412
|
/**
|
|
141301
141413
|
* Grid has scrolled vertically
|
|
141302
141414
|
* @param {object} event Event object
|
|
141303
|
-
* @param {Grid.view.
|
|
141415
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
141304
141416
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
141305
141417
|
*/
|
|
141306
|
-
onScroll: ((event: { source:
|
|
141418
|
+
onScroll: ((event: { source: GridBase, scrollTop: number }) => void)|string
|
|
141307
141419
|
/**
|
|
141308
141420
|
* The selection has been changed.
|
|
141309
141421
|
* @param {object} event Event object
|
|
@@ -141385,17 +141497,17 @@ export class GridBase extends Panel {
|
|
|
141385
141497
|
/**
|
|
141386
141498
|
* Fires after a sub grid is collapsed.
|
|
141387
141499
|
* @param {object} event Event object
|
|
141388
|
-
* @param {Grid.view.
|
|
141500
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
141389
141501
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
141390
141502
|
*/
|
|
141391
|
-
onSubGridCollapse: ((event: { source:
|
|
141503
|
+
onSubGridCollapse: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
141392
141504
|
/**
|
|
141393
141505
|
* Fires after a sub grid is expanded.
|
|
141394
141506
|
* @param {object} event Event object
|
|
141395
|
-
* @param {Grid.view.
|
|
141507
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
141396
141508
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
141397
141509
|
*/
|
|
141398
|
-
onSubGridExpand: ((event: { source:
|
|
141510
|
+
onSubGridExpand: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
141399
141511
|
/**
|
|
141400
141512
|
* Fired when one or more groups are expanded or collapsed
|
|
141401
141513
|
* @param {object} event Event object
|
|
@@ -142917,6 +143029,14 @@ type TreeGridListenersTypes = {
|
|
|
142917
143029
|
* @param {any} event.value The value being set
|
|
142918
143030
|
*/
|
|
142919
143031
|
beforeCellRangeEdit: (event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void
|
|
143032
|
+
/**
|
|
143033
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
143034
|
+
* @param {object} event Event object
|
|
143035
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
143036
|
+
* @param {Grid.column.Column} event.column The column
|
|
143037
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
143038
|
+
*/
|
|
143039
|
+
beforeColumnCollapseToggle: (event: { source: GridBase, column: Column, collapsed: boolean }) => void
|
|
142920
143040
|
/**
|
|
142921
143041
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
142922
143042
|
* @param {object} event Event object
|
|
@@ -143017,18 +143137,18 @@ type TreeGridListenersTypes = {
|
|
|
143017
143137
|
/**
|
|
143018
143138
|
* Fires before a row is rendered.
|
|
143019
143139
|
* @param {object} event Event object
|
|
143020
|
-
* @param {Grid.view.
|
|
143021
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
143022
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
143023
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
143140
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
143141
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
143142
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
143143
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
143024
143144
|
*/
|
|
143025
|
-
beforeRenderRow: (event: { source:
|
|
143145
|
+
beforeRenderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
|
|
143026
143146
|
/**
|
|
143027
143147
|
* Grid rows are about to be rendered
|
|
143028
143148
|
* @param {object} event Event object
|
|
143029
|
-
* @param {Grid.view.
|
|
143149
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
143030
143150
|
*/
|
|
143031
|
-
beforeRenderRows: (event: { source:
|
|
143151
|
+
beforeRenderRows: (event: { source: GridBase }) => void
|
|
143032
143152
|
/**
|
|
143033
143153
|
* This event fires before row collapse is started.
|
|
143034
143154
|
* ...
|
|
@@ -143259,6 +143379,14 @@ type TreeGridListenersTypes = {
|
|
|
143259
143379
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
143260
143380
|
*/
|
|
143261
143381
|
collapseNode: (event: { source: Grid, record: Model }) => void
|
|
143382
|
+
/**
|
|
143383
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
143384
|
+
* @param {object} event Event object
|
|
143385
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
143386
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
143387
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
143388
|
+
*/
|
|
143389
|
+
columnCollapseToggle: (event: { source: GridBase, column: Column, collapsed: boolean }) => void
|
|
143262
143390
|
/**
|
|
143263
143391
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
143264
143392
|
* to indicate whether the drop position is valid or not.
|
|
@@ -143340,14 +143468,14 @@ type TreeGridListenersTypes = {
|
|
|
143340
143468
|
* ...
|
|
143341
143469
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-dataChange)
|
|
143342
143470
|
* @param {object} event Event object
|
|
143343
|
-
* @param {Grid.view.
|
|
143471
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
143344
143472
|
* @param {Core.data.Store} event.store The originating store
|
|
143345
143473
|
* @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'`
|
|
143346
143474
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
143347
143475
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
143348
143476
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
143349
143477
|
*/
|
|
143350
|
-
dataChange: (event: { source:
|
|
143478
|
+
dataChange: (event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void
|
|
143351
143479
|
/**
|
|
143352
143480
|
* Fires when an object is destroyed.
|
|
143353
143481
|
* @param {object} event Event object
|
|
@@ -143655,18 +143783,18 @@ type TreeGridListenersTypes = {
|
|
|
143655
143783
|
/**
|
|
143656
143784
|
* Fires after a row is rendered.
|
|
143657
143785
|
* @param {object} event Event object
|
|
143658
|
-
* @param {Grid.view.
|
|
143659
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
143660
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
143661
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
143786
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
143787
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
143788
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
143789
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
143662
143790
|
*/
|
|
143663
|
-
renderRow: (event: { source:
|
|
143791
|
+
renderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
|
|
143664
143792
|
/**
|
|
143665
143793
|
* Grid rows have been rendered
|
|
143666
143794
|
* @param {object} event Event object
|
|
143667
|
-
* @param {Grid.view.
|
|
143795
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
143668
143796
|
*/
|
|
143669
|
-
renderRows: (event: { source:
|
|
143797
|
+
renderRows: (event: { source: GridBase }) => void
|
|
143670
143798
|
/**
|
|
143671
143799
|
* 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`*.
|
|
143672
143800
|
* @param {object} event Event object
|
|
@@ -143726,10 +143854,10 @@ type TreeGridListenersTypes = {
|
|
|
143726
143854
|
/**
|
|
143727
143855
|
* Grid has scrolled vertically
|
|
143728
143856
|
* @param {object} event Event object
|
|
143729
|
-
* @param {Grid.view.
|
|
143857
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
143730
143858
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
143731
143859
|
*/
|
|
143732
|
-
scroll: (event: { source:
|
|
143860
|
+
scroll: (event: { source: GridBase, scrollTop: number }) => void
|
|
143733
143861
|
/**
|
|
143734
143862
|
* The selection has been changed.
|
|
143735
143863
|
* @param {object} event Event object
|
|
@@ -143817,17 +143945,17 @@ type TreeGridListenersTypes = {
|
|
|
143817
143945
|
/**
|
|
143818
143946
|
* Fires after a sub grid is collapsed.
|
|
143819
143947
|
* @param {object} event Event object
|
|
143820
|
-
* @param {Grid.view.
|
|
143948
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
143821
143949
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
143822
143950
|
*/
|
|
143823
|
-
subGridCollapse: (event: { source:
|
|
143951
|
+
subGridCollapse: (event: { source: GridBase, subGrid: SubGrid }) => void
|
|
143824
143952
|
/**
|
|
143825
143953
|
* Fires after a sub grid is expanded.
|
|
143826
143954
|
* @param {object} event Event object
|
|
143827
|
-
* @param {Grid.view.
|
|
143955
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
143828
143956
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
143829
143957
|
*/
|
|
143830
|
-
subGridExpand: (event: { source:
|
|
143958
|
+
subGridExpand: (event: { source: GridBase, subGrid: SubGrid }) => void
|
|
143831
143959
|
/**
|
|
143832
143960
|
* Fired when one or more groups are expanded or collapsed
|
|
143833
143961
|
* @param {object} event Event object
|
|
@@ -143920,6 +144048,14 @@ type TreeGridListeners = {
|
|
|
143920
144048
|
* @param {any} event.value The value being set
|
|
143921
144049
|
*/
|
|
143922
144050
|
beforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
|
|
144051
|
+
/**
|
|
144052
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
144053
|
+
* @param {object} event Event object
|
|
144054
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
144055
|
+
* @param {Grid.column.Column} event.column The column
|
|
144056
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
144057
|
+
*/
|
|
144058
|
+
beforeColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
143923
144059
|
/**
|
|
143924
144060
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
143925
144061
|
* @param {object} event Event object
|
|
@@ -144020,18 +144156,18 @@ type TreeGridListeners = {
|
|
|
144020
144156
|
/**
|
|
144021
144157
|
* Fires before a row is rendered.
|
|
144022
144158
|
* @param {object} event Event object
|
|
144023
|
-
* @param {Grid.view.
|
|
144024
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
144025
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
144026
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
144159
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
144160
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
144161
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
144162
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
144027
144163
|
*/
|
|
144028
|
-
beforeRenderRow?: ((event: { source:
|
|
144164
|
+
beforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
144029
144165
|
/**
|
|
144030
144166
|
* Grid rows are about to be rendered
|
|
144031
144167
|
* @param {object} event Event object
|
|
144032
|
-
* @param {Grid.view.
|
|
144168
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
144033
144169
|
*/
|
|
144034
|
-
beforeRenderRows?: ((event: { source:
|
|
144170
|
+
beforeRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
144035
144171
|
/**
|
|
144036
144172
|
* This event fires before row collapse is started.
|
|
144037
144173
|
* ...
|
|
@@ -144262,6 +144398,14 @@ type TreeGridListeners = {
|
|
|
144262
144398
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
144263
144399
|
*/
|
|
144264
144400
|
collapseNode?: ((event: { source: Grid, record: Model }) => void)|string
|
|
144401
|
+
/**
|
|
144402
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
144403
|
+
* @param {object} event Event object
|
|
144404
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
144405
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
144406
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
144407
|
+
*/
|
|
144408
|
+
columnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
144265
144409
|
/**
|
|
144266
144410
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
144267
144411
|
* to indicate whether the drop position is valid or not.
|
|
@@ -144343,14 +144487,14 @@ type TreeGridListeners = {
|
|
|
144343
144487
|
* ...
|
|
144344
144488
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-dataChange)
|
|
144345
144489
|
* @param {object} event Event object
|
|
144346
|
-
* @param {Grid.view.
|
|
144490
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
144347
144491
|
* @param {Core.data.Store} event.store The originating store
|
|
144348
144492
|
* @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'`
|
|
144349
144493
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
144350
144494
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
144351
144495
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
144352
144496
|
*/
|
|
144353
|
-
dataChange?: ((event: { source:
|
|
144497
|
+
dataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
|
|
144354
144498
|
/**
|
|
144355
144499
|
* Fires when an object is destroyed.
|
|
144356
144500
|
* @param {object} event Event object
|
|
@@ -144658,18 +144802,18 @@ type TreeGridListeners = {
|
|
|
144658
144802
|
/**
|
|
144659
144803
|
* Fires after a row is rendered.
|
|
144660
144804
|
* @param {object} event Event object
|
|
144661
|
-
* @param {Grid.view.
|
|
144662
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
144663
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
144664
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
144805
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
144806
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
144807
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
144808
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
144665
144809
|
*/
|
|
144666
|
-
renderRow?: ((event: { source:
|
|
144810
|
+
renderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
144667
144811
|
/**
|
|
144668
144812
|
* Grid rows have been rendered
|
|
144669
144813
|
* @param {object} event Event object
|
|
144670
|
-
* @param {Grid.view.
|
|
144814
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
144671
144815
|
*/
|
|
144672
|
-
renderRows?: ((event: { source:
|
|
144816
|
+
renderRows?: ((event: { source: GridBase }) => void)|string
|
|
144673
144817
|
/**
|
|
144674
144818
|
* 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`*.
|
|
144675
144819
|
* @param {object} event Event object
|
|
@@ -144729,10 +144873,10 @@ type TreeGridListeners = {
|
|
|
144729
144873
|
/**
|
|
144730
144874
|
* Grid has scrolled vertically
|
|
144731
144875
|
* @param {object} event Event object
|
|
144732
|
-
* @param {Grid.view.
|
|
144876
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
144733
144877
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
144734
144878
|
*/
|
|
144735
|
-
scroll?: ((event: { source:
|
|
144879
|
+
scroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
|
|
144736
144880
|
/**
|
|
144737
144881
|
* The selection has been changed.
|
|
144738
144882
|
* @param {object} event Event object
|
|
@@ -144820,17 +144964,17 @@ type TreeGridListeners = {
|
|
|
144820
144964
|
/**
|
|
144821
144965
|
* Fires after a sub grid is collapsed.
|
|
144822
144966
|
* @param {object} event Event object
|
|
144823
|
-
* @param {Grid.view.
|
|
144967
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
144824
144968
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
144825
144969
|
*/
|
|
144826
|
-
subGridCollapse?: ((event: { source:
|
|
144970
|
+
subGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
144827
144971
|
/**
|
|
144828
144972
|
* Fires after a sub grid is expanded.
|
|
144829
144973
|
* @param {object} event Event object
|
|
144830
|
-
* @param {Grid.view.
|
|
144974
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
144831
144975
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
144832
144976
|
*/
|
|
144833
|
-
subGridExpand?: ((event: { source:
|
|
144977
|
+
subGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
144834
144978
|
/**
|
|
144835
144979
|
* Fired when one or more groups are expanded or collapsed
|
|
144836
144980
|
* @param {object} event Event object
|
|
@@ -145758,6 +145902,14 @@ type TreeGridConfig = {
|
|
|
145758
145902
|
* @param {any} event.value The value being set
|
|
145759
145903
|
*/
|
|
145760
145904
|
onBeforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
|
|
145905
|
+
/**
|
|
145906
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
145907
|
+
* @param {object} event Event object
|
|
145908
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
145909
|
+
* @param {Grid.column.Column} event.column The column
|
|
145910
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
145911
|
+
*/
|
|
145912
|
+
onBeforeColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
145761
145913
|
/**
|
|
145762
145914
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
145763
145915
|
* @param {object} event Event object
|
|
@@ -145858,18 +146010,18 @@ type TreeGridConfig = {
|
|
|
145858
146010
|
/**
|
|
145859
146011
|
* Fires before a row is rendered.
|
|
145860
146012
|
* @param {object} event Event object
|
|
145861
|
-
* @param {Grid.view.
|
|
145862
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
145863
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
145864
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
146013
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
146014
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
146015
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
146016
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
145865
146017
|
*/
|
|
145866
|
-
onBeforeRenderRow?: ((event: { source:
|
|
146018
|
+
onBeforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
145867
146019
|
/**
|
|
145868
146020
|
* Grid rows are about to be rendered
|
|
145869
146021
|
* @param {object} event Event object
|
|
145870
|
-
* @param {Grid.view.
|
|
146022
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
145871
146023
|
*/
|
|
145872
|
-
onBeforeRenderRows?: ((event: { source:
|
|
146024
|
+
onBeforeRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
145873
146025
|
/**
|
|
145874
146026
|
* This event fires before row collapse is started.
|
|
145875
146027
|
* ...
|
|
@@ -146100,6 +146252,14 @@ type TreeGridConfig = {
|
|
|
146100
146252
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
146101
146253
|
*/
|
|
146102
146254
|
onCollapseNode?: ((event: { source: Grid, record: Model }) => void)|string
|
|
146255
|
+
/**
|
|
146256
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
146257
|
+
* @param {object} event Event object
|
|
146258
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
146259
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
146260
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
146261
|
+
*/
|
|
146262
|
+
onColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
146103
146263
|
/**
|
|
146104
146264
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
146105
146265
|
* to indicate whether the drop position is valid or not.
|
|
@@ -146181,14 +146341,14 @@ type TreeGridConfig = {
|
|
|
146181
146341
|
* ...
|
|
146182
146342
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-dataChange)
|
|
146183
146343
|
* @param {object} event Event object
|
|
146184
|
-
* @param {Grid.view.
|
|
146344
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
146185
146345
|
* @param {Core.data.Store} event.store The originating store
|
|
146186
146346
|
* @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'`
|
|
146187
146347
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
146188
146348
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
146189
146349
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
146190
146350
|
*/
|
|
146191
|
-
onDataChange?: ((event: { source:
|
|
146351
|
+
onDataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
|
|
146192
146352
|
/**
|
|
146193
146353
|
* Fires when an object is destroyed.
|
|
146194
146354
|
* @param {object} event Event object
|
|
@@ -146496,18 +146656,18 @@ type TreeGridConfig = {
|
|
|
146496
146656
|
/**
|
|
146497
146657
|
* Fires after a row is rendered.
|
|
146498
146658
|
* @param {object} event Event object
|
|
146499
|
-
* @param {Grid.view.
|
|
146500
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
146501
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
146502
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
146659
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
146660
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
146661
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
146662
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
146503
146663
|
*/
|
|
146504
|
-
onRenderRow?: ((event: { source:
|
|
146664
|
+
onRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
146505
146665
|
/**
|
|
146506
146666
|
* Grid rows have been rendered
|
|
146507
146667
|
* @param {object} event Event object
|
|
146508
|
-
* @param {Grid.view.
|
|
146668
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
146509
146669
|
*/
|
|
146510
|
-
onRenderRows?: ((event: { source:
|
|
146670
|
+
onRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
146511
146671
|
/**
|
|
146512
146672
|
* 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`*.
|
|
146513
146673
|
* @param {object} event Event object
|
|
@@ -146567,10 +146727,10 @@ type TreeGridConfig = {
|
|
|
146567
146727
|
/**
|
|
146568
146728
|
* Grid has scrolled vertically
|
|
146569
146729
|
* @param {object} event Event object
|
|
146570
|
-
* @param {Grid.view.
|
|
146730
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
146571
146731
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
146572
146732
|
*/
|
|
146573
|
-
onScroll?: ((event: { source:
|
|
146733
|
+
onScroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
|
|
146574
146734
|
/**
|
|
146575
146735
|
* The selection has been changed.
|
|
146576
146736
|
* @param {object} event Event object
|
|
@@ -146658,17 +146818,17 @@ type TreeGridConfig = {
|
|
|
146658
146818
|
/**
|
|
146659
146819
|
* Fires after a sub grid is collapsed.
|
|
146660
146820
|
* @param {object} event Event object
|
|
146661
|
-
* @param {Grid.view.
|
|
146821
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
146662
146822
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
146663
146823
|
*/
|
|
146664
|
-
onSubGridCollapse?: ((event: { source:
|
|
146824
|
+
onSubGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
146665
146825
|
/**
|
|
146666
146826
|
* Fires after a sub grid is expanded.
|
|
146667
146827
|
* @param {object} event Event object
|
|
146668
|
-
* @param {Grid.view.
|
|
146828
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
146669
146829
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
146670
146830
|
*/
|
|
146671
|
-
onSubGridExpand?: ((event: { source:
|
|
146831
|
+
onSubGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
146672
146832
|
/**
|
|
146673
146833
|
* Fired when one or more groups are expanded or collapsed
|
|
146674
146834
|
* @param {object} event Event object
|