@bryntum/grid-trial 7.1.1 → 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/grid.thin.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  /*!
2
2
  *
3
- * Bryntum Grid 7.1.1 (TRIAL VERSION)
3
+ * Bryntum Grid 7.1.3 (TRIAL VERSION)
4
4
  *
5
5
  * Copyright(c) 2026 Bryntum AB
6
6
  * https://bryntum.com/contact
@@ -349,10 +349,16 @@ type ActionConfig = {
349
349
  */
350
350
  cls?: string
351
351
  /**
352
- * A text to use for the action element´s `aria-label` value. If not provided, the
353
- * action´s `tooltip` will be used as the `aria-label` (if present).
352
+ * A text to use for the action element's `aria-label` value. If not provided, the
353
+ * action's `tooltip` will be used as the `aria-label` (if present).
354
354
  */
355
355
  ariaLabel?: string
356
+ /**
357
+ * A value to use for the action element's `aria-haspopup` attribute.
358
+ * Set to indicate that the action triggers a popup. This helps assistive technologies inform users that activating
359
+ * the action will display a popup element.
360
+ */
361
+ ariaHasPopup?: 'true'|'false'|'menu'|'listbox'|'tree'|'grid'|'dialog'|boolean
356
362
  /**
357
363
  * Tooltip text, or a config object which can reconfigure the shared
358
364
  * tooltip by setting boolean, numeric and string config values, or a function to return the tooltip text, passed the
@@ -612,7 +618,7 @@ type EmptyTextDomConfig = DomConfig & {
612
618
  /**
613
619
  * The grid region to add the empty text to
614
620
  */
615
- region?: string
621
+ region?: 'locked'|'normal'|string
616
622
  }
617
623
 
618
624
  type GridScrollOptions = {
@@ -3281,7 +3287,7 @@ type CheckColumnConfig = {
3281
3287
  */
3282
3288
  cellMenuItems?: Record<string, MenuItemEntry>
3283
3289
  /**
3284
- * The `aria-label` to use for the default checkbox widget of cells in this Column
3290
+ * The `aria-label` used for the default checkbox widget in this column’s cells.
3285
3291
  */
3286
3292
  checkAriaLabel?: string
3287
3293
  /**
@@ -3840,7 +3846,7 @@ export class CheckColumn extends WidgetColumn {
3840
3846
  */
3841
3847
  static readonly isCheckColumn: boolean
3842
3848
  /**
3843
- * The `aria-label` to use for the default checkbox widget of cells in this Column
3849
+ * The `aria-label` used for the default checkbox widget in this column’s cells.
3844
3850
  */
3845
3851
  checkAriaLabel: string
3846
3852
  /**
@@ -7209,8 +7215,8 @@ type DateColumnConfig = {
7209
7215
  */
7210
7216
  remoteChildCount?: number
7211
7217
  /**
7212
- * Renderer function, used to style the date displayed in the cell. Can also affect other aspects of
7213
- * the cell, such as styling.
7218
+ * Renderer function, used to style the date displayed in the cell. Can also affect other aspects of the cell,
7219
+ * such as styling.
7214
7220
  * ...
7215
7221
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/DateColumn#config-renderer)
7216
7222
  * @param {object} renderData Object containing renderer parameters
@@ -7371,9 +7377,9 @@ type DateColumnConfig = {
7371
7377
  }
7372
7378
 
7373
7379
  /**
7374
- * 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
7375
- * contains the following info: full year, 2-digit month, and 2-digit day. Depending on the browser locale,
7376
- * the formatted date might look different. [Intl.DateTimeFormat API](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat)
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)
7377
7383
  * is used to format the date. Here is an example of possible outputs depending on the browser locale:
7378
7384
  * ...
7379
7385
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/DateColumn)
@@ -7407,8 +7413,8 @@ export class DateColumn extends Column {
7407
7413
  */
7408
7414
  min: string|Date
7409
7415
  /**
7410
- * Renderer function, used to style the date displayed in the cell. Can also affect other aspects of
7411
- * the cell, such as styling.
7416
+ * Renderer function, used to style the date displayed in the cell. Can also affect other aspects of the cell,
7417
+ * such as styling.
7412
7418
  */
7413
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
7414
7420
  /**
@@ -12077,7 +12083,8 @@ type TimeColumnConfig = {
12077
12083
  */
12078
12084
  flex?: number|string
12079
12085
  /**
12080
- * Time format
12086
+ * Time format for time displayed in cell and editor
12087
+ * (see [format](https://bryntum.com/products/grid/docs/api/Core/helper/DateHelper#function-format-static) for formatting options)
12081
12088
  */
12082
12089
  format?: string
12083
12090
  /**
@@ -12474,7 +12481,8 @@ export class TimeColumn extends Column {
12474
12481
  */
12475
12482
  static readonly isTimeColumn: boolean
12476
12483
  /**
12477
- * Time format
12484
+ * Time format for time displayed in cell and editor
12485
+ * (see [format](https://bryntum.com/products/grid/docs/api/Core/helper/DateHelper#function-format-static) for formatting options)
12478
12486
  */
12479
12487
  format: string
12480
12488
  /**
@@ -14732,7 +14740,9 @@ type ColumnStoreConfig = {
14732
14740
  */
14733
14741
  pageStartParamName?: string
14734
14742
  /**
14735
- * Specify true to reapply filters when a record is added to the store.
14743
+ * Specify `true` to reapply filters when a record is added to or moved within the store.
14744
+ * This includes tree node operations like indent/outdent in Gantt, or any move operation
14745
+ * that changes a node's parent.
14736
14746
  */
14737
14747
  reapplyFilterOnAdd?: boolean
14738
14748
  /**
@@ -27389,9 +27399,9 @@ export class PdfExport extends InstancePlugin {
27389
27399
  /**
27390
27400
  * Starts the export process. Accepts a config object which overrides any default configs.
27391
27401
  * <strong>NOTE</strong>. Component should not be interacted with when export is in progress
27392
- * @param {object} config
27402
+ * @param {PdfExportConfig} config
27393
27403
  */
27394
- export(config: object): Promise<any>;
27404
+ export(config: PdfExportConfig): Promise<any>;
27395
27405
  /**
27396
27406
  * This method accepts all stylesheets (link and style tags) which are supposed to be put on the page. Use
27397
27407
  * this hook method to filter or modify them.
@@ -27803,9 +27813,9 @@ export class Print extends PdfExport {
27803
27813
  /**
27804
27814
  * Starts the print process. Accepts a config object which overrides any default configs.
27805
27815
  * <strong>NOTE</strong> Component should not be interacted with when print is in progress
27806
- * @param {object} config
27816
+ * @param {PrintConfig} config
27807
27817
  */
27808
- print(config: object): Promise<any>;
27818
+ print(config: PrintConfig): Promise<any>;
27809
27819
  /**
27810
27820
  * Shows the [print dialog](https://bryntum.com/products/grid/docs/api/Grid/view/export/ExportDialog)
27811
27821
  */
@@ -29155,9 +29165,9 @@ export class PrintMixinClass {
29155
29165
  /**
29156
29166
  * Starts the print process. Accepts a config object which overrides any default configs.
29157
29167
  * <strong>NOTE</strong> Component should not be interacted with when print is in progress
29158
- * @param {object} config
29168
+ * @param {PrintConfig} config
29159
29169
  */
29160
- print(config: object): Promise<any>;
29170
+ print(config: PrintConfig): Promise<any>;
29161
29171
  /**
29162
29172
  * Shows the [print dialog](https://bryntum.com/products/grid/docs/api/Grid/view/export/ExportDialog)
29163
29173
  */
@@ -29345,6 +29355,10 @@ export class GridLocation {
29345
29355
  * The cell DOM element which this `GridLocation` references.
29346
29356
  */
29347
29357
  readonly cell: HTMLElement
29358
+ /**
29359
+ * Yields the [Column](https://bryntum.com/products/grid/docs/api/Grid/column/Column) of this location.
29360
+ */
29361
+ readonly column: Column
29348
29362
  /**
29349
29363
  * Yields the column index of this location.
29350
29364
  */
@@ -29353,6 +29367,10 @@ export class GridLocation {
29353
29367
  * This property is `true` if the focus is inside the cell, not *on* the cell.
29354
29368
  */
29355
29369
  readonly containsFocus: boolean
29370
+ /**
29371
+ * The grid which this `GridLocation` references.
29372
+ */
29373
+ readonly grid: Grid
29356
29374
  /**
29357
29375
  * This property is `true` if the focus target is not the cell itself.
29358
29376
  */
@@ -29369,6 +29387,10 @@ export class GridLocation {
29369
29387
  * Yields `true` if the cell and row are selectable.
29370
29388
  */
29371
29389
  readonly isSelectable: boolean
29390
+ /**
29391
+ * Yields the [Model](https://bryntum.com/products/grid/docs/api/Core/data/Model) of this location, or `null` if the location is a column header.
29392
+ */
29393
+ readonly record: Model
29372
29394
  /**
29373
29395
  * Yields the row index of this location.
29374
29396
  */
@@ -29513,6 +29535,14 @@ type GridListenersTypes = {
29513
29535
  * @param {any} event.value The value being set
29514
29536
  */
29515
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
29516
29546
  /**
29517
29547
  * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
29518
29548
  * @param {object} event Event object
@@ -29607,24 +29637,24 @@ type GridListenersTypes = {
29607
29637
  /**
29608
29638
  * Fires on the owning Grid before export started. Return `false` to cancel the export.
29609
29639
  * @param {object} event Event object
29610
- * @param {object} event.config Export config
29640
+ * @param {PdfExportConfig} event.config Export config
29611
29641
  */
29612
- beforePdfExport: (event: { config: object }) => Promise<boolean>|boolean|void
29642
+ beforePdfExport: (event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void
29613
29643
  /**
29614
29644
  * Fires before a row is rendered.
29615
29645
  * @param {object} event Event object
29616
- * @param {Grid.view.Grid} event.source The firing Grid instance.
29617
- * @param {Grid.row.Row} event.row The row about to be rendered.
29618
- * @param {Core.data.Model} event.record The record for the row.
29619
- * @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
29620
29650
  */
29621
- beforeRenderRow: (event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void
29651
+ beforeRenderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
29622
29652
  /**
29623
29653
  * Grid rows are about to be rendered
29624
29654
  * @param {object} event Event object
29625
- * @param {Grid.view.Grid} event.source This grid.
29655
+ * @param {Grid.view.GridBase} event.source This grid.
29626
29656
  */
29627
- beforeRenderRows: (event: { source: Grid }) => void
29657
+ beforeRenderRows: (event: { source: GridBase }) => void
29628
29658
  /**
29629
29659
  * This event fires before row collapse is started.
29630
29660
  * ...
@@ -29855,6 +29885,14 @@ type GridListenersTypes = {
29855
29885
  * @param {Core.data.Model} event.record The record which has been collapsed.
29856
29886
  */
29857
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
29858
29896
  /**
29859
29897
  * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
29860
29898
  * to indicate whether the drop position is valid or not.
@@ -29936,14 +29974,14 @@ type GridListenersTypes = {
29936
29974
  * ...
29937
29975
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-dataChange)
29938
29976
  * @param {object} event Event object
29939
- * @param {Grid.view.Grid} event.source Owning grid
29977
+ * @param {Grid.view.GridBase} event.source Owning grid
29940
29978
  * @param {Core.data.Store} event.store The originating store
29941
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'`
29942
29980
  * @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
29943
29981
  * @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
29944
29982
  * @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
29945
29983
  */
29946
- dataChange: (event: { source: Grid, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void
29984
+ dataChange: (event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void
29947
29985
  /**
29948
29986
  * Fires when an object is destroyed.
29949
29987
  * @param {object} event Event object
@@ -30251,18 +30289,18 @@ type GridListenersTypes = {
30251
30289
  /**
30252
30290
  * Fires after a row is rendered.
30253
30291
  * @param {object} event Event object
30254
- * @param {Grid.view.Grid} event.source The firing Grid instance.
30255
- * @param {Grid.row.Row} event.row The row that has been rendered.
30256
- * @param {Core.data.Model} event.record The record for the row.
30257
- * @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
30258
30296
  */
30259
- renderRow: (event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void
30297
+ renderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
30260
30298
  /**
30261
30299
  * Grid rows have been rendered
30262
30300
  * @param {object} event Event object
30263
- * @param {Grid.view.Grid} event.source This grid.
30301
+ * @param {Grid.view.GridBase} event.source This grid.
30264
30302
  */
30265
- renderRows: (event: { source: Grid }) => void
30303
+ renderRows: (event: { source: GridBase }) => void
30266
30304
  /**
30267
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`*.
30268
30306
  * @param {object} event Event object
@@ -30322,10 +30360,10 @@ type GridListenersTypes = {
30322
30360
  /**
30323
30361
  * Grid has scrolled vertically
30324
30362
  * @param {object} event Event object
30325
- * @param {Grid.view.Grid} event.source The firing Grid instance.
30363
+ * @param {Grid.view.GridBase} event.source The firing Grid instance.
30326
30364
  * @param {number} event.scrollTop The vertical scroll position.
30327
30365
  */
30328
- scroll: (event: { source: Grid, scrollTop: number }) => void
30366
+ scroll: (event: { source: GridBase, scrollTop: number }) => void
30329
30367
  /**
30330
30368
  * The selection has been changed.
30331
30369
  * @param {object} event Event object
@@ -30413,17 +30451,17 @@ type GridListenersTypes = {
30413
30451
  /**
30414
30452
  * Fires after a sub grid is collapsed.
30415
30453
  * @param {object} event Event object
30416
- * @param {Grid.view.Grid} event.source The firing Grid instance
30454
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
30417
30455
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
30418
30456
  */
30419
- subGridCollapse: (event: { source: Grid, subGrid: SubGrid }) => void
30457
+ subGridCollapse: (event: { source: GridBase, subGrid: SubGrid }) => void
30420
30458
  /**
30421
30459
  * Fires after a sub grid is expanded.
30422
30460
  * @param {object} event Event object
30423
- * @param {Grid.view.Grid} event.source The firing Grid instance
30461
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
30424
30462
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
30425
30463
  */
30426
- subGridExpand: (event: { source: Grid, subGrid: SubGrid }) => void
30464
+ subGridExpand: (event: { source: GridBase, subGrid: SubGrid }) => void
30427
30465
  /**
30428
30466
  * Fired when one or more groups are expanded or collapsed
30429
30467
  * @param {object} event Event object
@@ -30516,6 +30554,14 @@ type GridListeners = {
30516
30554
  * @param {any} event.value The value being set
30517
30555
  */
30518
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
30519
30565
  /**
30520
30566
  * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
30521
30567
  * @param {object} event Event object
@@ -30610,24 +30656,24 @@ type GridListeners = {
30610
30656
  /**
30611
30657
  * Fires on the owning Grid before export started. Return `false` to cancel the export.
30612
30658
  * @param {object} event Event object
30613
- * @param {object} event.config Export config
30659
+ * @param {PdfExportConfig} event.config Export config
30614
30660
  */
30615
- beforePdfExport?: ((event: { config: object }) => Promise<boolean>|boolean|void)|string
30661
+ beforePdfExport?: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
30616
30662
  /**
30617
30663
  * Fires before a row is rendered.
30618
30664
  * @param {object} event Event object
30619
- * @param {Grid.view.Grid} event.source The firing Grid instance.
30620
- * @param {Grid.row.Row} event.row The row about to be rendered.
30621
- * @param {Core.data.Model} event.record The record for the row.
30622
- * @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
30623
30669
  */
30624
- beforeRenderRow?: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
30670
+ beforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
30625
30671
  /**
30626
30672
  * Grid rows are about to be rendered
30627
30673
  * @param {object} event Event object
30628
- * @param {Grid.view.Grid} event.source This grid.
30674
+ * @param {Grid.view.GridBase} event.source This grid.
30629
30675
  */
30630
- beforeRenderRows?: ((event: { source: Grid }) => void)|string
30676
+ beforeRenderRows?: ((event: { source: GridBase }) => void)|string
30631
30677
  /**
30632
30678
  * This event fires before row collapse is started.
30633
30679
  * ...
@@ -30858,6 +30904,14 @@ type GridListeners = {
30858
30904
  * @param {Core.data.Model} event.record The record which has been collapsed.
30859
30905
  */
30860
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
30861
30915
  /**
30862
30916
  * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
30863
30917
  * to indicate whether the drop position is valid or not.
@@ -30939,14 +30993,14 @@ type GridListeners = {
30939
30993
  * ...
30940
30994
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-dataChange)
30941
30995
  * @param {object} event Event object
30942
- * @param {Grid.view.Grid} event.source Owning grid
30996
+ * @param {Grid.view.GridBase} event.source Owning grid
30943
30997
  * @param {Core.data.Store} event.store The originating store
30944
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'`
30945
30999
  * @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
30946
31000
  * @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
30947
31001
  * @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
30948
31002
  */
30949
- dataChange?: ((event: { source: Grid, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
31003
+ dataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
30950
31004
  /**
30951
31005
  * Fires when an object is destroyed.
30952
31006
  * @param {object} event Event object
@@ -31254,18 +31308,18 @@ type GridListeners = {
31254
31308
  /**
31255
31309
  * Fires after a row is rendered.
31256
31310
  * @param {object} event Event object
31257
- * @param {Grid.view.Grid} event.source The firing Grid instance.
31258
- * @param {Grid.row.Row} event.row The row that has been rendered.
31259
- * @param {Core.data.Model} event.record The record for the row.
31260
- * @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
31261
31315
  */
31262
- renderRow?: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
31316
+ renderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
31263
31317
  /**
31264
31318
  * Grid rows have been rendered
31265
31319
  * @param {object} event Event object
31266
- * @param {Grid.view.Grid} event.source This grid.
31320
+ * @param {Grid.view.GridBase} event.source This grid.
31267
31321
  */
31268
- renderRows?: ((event: { source: Grid }) => void)|string
31322
+ renderRows?: ((event: { source: GridBase }) => void)|string
31269
31323
  /**
31270
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`*.
31271
31325
  * @param {object} event Event object
@@ -31325,10 +31379,10 @@ type GridListeners = {
31325
31379
  /**
31326
31380
  * Grid has scrolled vertically
31327
31381
  * @param {object} event Event object
31328
- * @param {Grid.view.Grid} event.source The firing Grid instance.
31382
+ * @param {Grid.view.GridBase} event.source The firing Grid instance.
31329
31383
  * @param {number} event.scrollTop The vertical scroll position.
31330
31384
  */
31331
- scroll?: ((event: { source: Grid, scrollTop: number }) => void)|string
31385
+ scroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
31332
31386
  /**
31333
31387
  * The selection has been changed.
31334
31388
  * @param {object} event Event object
@@ -31416,17 +31470,17 @@ type GridListeners = {
31416
31470
  /**
31417
31471
  * Fires after a sub grid is collapsed.
31418
31472
  * @param {object} event Event object
31419
- * @param {Grid.view.Grid} event.source The firing Grid instance
31473
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
31420
31474
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
31421
31475
  */
31422
- subGridCollapse?: ((event: { source: Grid, subGrid: SubGrid }) => void)|string
31476
+ subGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
31423
31477
  /**
31424
31478
  * Fires after a sub grid is expanded.
31425
31479
  * @param {object} event Event object
31426
- * @param {Grid.view.Grid} event.source The firing Grid instance
31480
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
31427
31481
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
31428
31482
  */
31429
- subGridExpand?: ((event: { source: Grid, subGrid: SubGrid }) => void)|string
31483
+ subGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
31430
31484
  /**
31431
31485
  * Fired when one or more groups are expanded or collapsed
31432
31486
  * @param {object} event Event object
@@ -32354,6 +32408,14 @@ type GridConfig = {
32354
32408
  * @param {any} event.value The value being set
32355
32409
  */
32356
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
32357
32419
  /**
32358
32420
  * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
32359
32421
  * @param {object} event Event object
@@ -32448,24 +32510,24 @@ type GridConfig = {
32448
32510
  /**
32449
32511
  * Fires on the owning Grid before export started. Return `false` to cancel the export.
32450
32512
  * @param {object} event Event object
32451
- * @param {object} event.config Export config
32513
+ * @param {PdfExportConfig} event.config Export config
32452
32514
  */
32453
- onBeforePdfExport?: ((event: { config: object }) => Promise<boolean>|boolean|void)|string
32515
+ onBeforePdfExport?: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
32454
32516
  /**
32455
32517
  * Fires before a row is rendered.
32456
32518
  * @param {object} event Event object
32457
- * @param {Grid.view.Grid} event.source The firing Grid instance.
32458
- * @param {Grid.row.Row} event.row The row about to be rendered.
32459
- * @param {Core.data.Model} event.record The record for the row.
32460
- * @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
32461
32523
  */
32462
- onBeforeRenderRow?: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
32524
+ onBeforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
32463
32525
  /**
32464
32526
  * Grid rows are about to be rendered
32465
32527
  * @param {object} event Event object
32466
- * @param {Grid.view.Grid} event.source This grid.
32528
+ * @param {Grid.view.GridBase} event.source This grid.
32467
32529
  */
32468
- onBeforeRenderRows?: ((event: { source: Grid }) => void)|string
32530
+ onBeforeRenderRows?: ((event: { source: GridBase }) => void)|string
32469
32531
  /**
32470
32532
  * This event fires before row collapse is started.
32471
32533
  * ...
@@ -32696,6 +32758,14 @@ type GridConfig = {
32696
32758
  * @param {Core.data.Model} event.record The record which has been collapsed.
32697
32759
  */
32698
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
32699
32769
  /**
32700
32770
  * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
32701
32771
  * to indicate whether the drop position is valid or not.
@@ -32777,14 +32847,14 @@ type GridConfig = {
32777
32847
  * ...
32778
32848
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-dataChange)
32779
32849
  * @param {object} event Event object
32780
- * @param {Grid.view.Grid} event.source Owning grid
32850
+ * @param {Grid.view.GridBase} event.source Owning grid
32781
32851
  * @param {Core.data.Store} event.store The originating store
32782
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'`
32783
32853
  * @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
32784
32854
  * @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
32785
32855
  * @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
32786
32856
  */
32787
- onDataChange?: ((event: { source: Grid, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
32857
+ onDataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
32788
32858
  /**
32789
32859
  * Fires when an object is destroyed.
32790
32860
  * @param {object} event Event object
@@ -33092,18 +33162,18 @@ type GridConfig = {
33092
33162
  /**
33093
33163
  * Fires after a row is rendered.
33094
33164
  * @param {object} event Event object
33095
- * @param {Grid.view.Grid} event.source The firing Grid instance.
33096
- * @param {Grid.row.Row} event.row The row that has been rendered.
33097
- * @param {Core.data.Model} event.record The record for the row.
33098
- * @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
33099
33169
  */
33100
- onRenderRow?: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
33170
+ onRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
33101
33171
  /**
33102
33172
  * Grid rows have been rendered
33103
33173
  * @param {object} event Event object
33104
- * @param {Grid.view.Grid} event.source This grid.
33174
+ * @param {Grid.view.GridBase} event.source This grid.
33105
33175
  */
33106
- onRenderRows?: ((event: { source: Grid }) => void)|string
33176
+ onRenderRows?: ((event: { source: GridBase }) => void)|string
33107
33177
  /**
33108
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`*.
33109
33179
  * @param {object} event Event object
@@ -33163,10 +33233,10 @@ type GridConfig = {
33163
33233
  /**
33164
33234
  * Grid has scrolled vertically
33165
33235
  * @param {object} event Event object
33166
- * @param {Grid.view.Grid} event.source The firing Grid instance.
33236
+ * @param {Grid.view.GridBase} event.source The firing Grid instance.
33167
33237
  * @param {number} event.scrollTop The vertical scroll position.
33168
33238
  */
33169
- onScroll?: ((event: { source: Grid, scrollTop: number }) => void)|string
33239
+ onScroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
33170
33240
  /**
33171
33241
  * The selection has been changed.
33172
33242
  * @param {object} event Event object
@@ -33254,17 +33324,17 @@ type GridConfig = {
33254
33324
  /**
33255
33325
  * Fires after a sub grid is collapsed.
33256
33326
  * @param {object} event Event object
33257
- * @param {Grid.view.Grid} event.source The firing Grid instance
33327
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
33258
33328
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
33259
33329
  */
33260
- onSubGridCollapse?: ((event: { source: Grid, subGrid: SubGrid }) => void)|string
33330
+ onSubGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
33261
33331
  /**
33262
33332
  * Fires after a sub grid is expanded.
33263
33333
  * @param {object} event Event object
33264
- * @param {Grid.view.Grid} event.source The firing Grid instance
33334
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
33265
33335
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
33266
33336
  */
33267
- onSubGridExpand?: ((event: { source: Grid, subGrid: SubGrid }) => void)|string
33337
+ onSubGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
33268
33338
  /**
33269
33339
  * Fired when one or more groups are expanded or collapsed
33270
33340
  * @param {object} event Event object
@@ -33576,6 +33646,14 @@ type GridBaseListenersTypes = {
33576
33646
  * @param {any} event.value The value being set
33577
33647
  */
33578
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
33579
33657
  /**
33580
33658
  * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
33581
33659
  * @param {object} event Event object
@@ -33670,24 +33748,24 @@ type GridBaseListenersTypes = {
33670
33748
  /**
33671
33749
  * Fires on the owning Grid before export started. Return `false` to cancel the export.
33672
33750
  * @param {object} event Event object
33673
- * @param {object} event.config Export config
33751
+ * @param {PdfExportConfig} event.config Export config
33674
33752
  */
33675
- beforePdfExport: (event: { config: object }) => Promise<boolean>|boolean|void
33753
+ beforePdfExport: (event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void
33676
33754
  /**
33677
33755
  * Fires before a row is rendered.
33678
33756
  * @param {object} event Event object
33679
- * @param {Grid.view.Grid} event.source The firing Grid instance.
33680
- * @param {Grid.row.Row} event.row The row about to be rendered.
33681
- * @param {Core.data.Model} event.record The record for the row.
33682
- * @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
33683
33761
  */
33684
- beforeRenderRow: (event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void
33762
+ beforeRenderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
33685
33763
  /**
33686
33764
  * Grid rows are about to be rendered
33687
33765
  * @param {object} event Event object
33688
- * @param {Grid.view.Grid} event.source This grid.
33766
+ * @param {Grid.view.GridBase} event.source This grid.
33689
33767
  */
33690
- beforeRenderRows: (event: { source: Grid }) => void
33768
+ beforeRenderRows: (event: { source: GridBase }) => void
33691
33769
  /**
33692
33770
  * This event fires before row collapse is started.
33693
33771
  * ...
@@ -33918,6 +33996,14 @@ type GridBaseListenersTypes = {
33918
33996
  * @param {Core.data.Model} event.record The record which has been collapsed.
33919
33997
  */
33920
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
33921
34007
  /**
33922
34008
  * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
33923
34009
  * to indicate whether the drop position is valid or not.
@@ -33999,14 +34085,14 @@ type GridBaseListenersTypes = {
33999
34085
  * ...
34000
34086
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-dataChange)
34001
34087
  * @param {object} event Event object
34002
- * @param {Grid.view.Grid} event.source Owning grid
34088
+ * @param {Grid.view.GridBase} event.source Owning grid
34003
34089
  * @param {Core.data.Store} event.store The originating store
34004
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'`
34005
34091
  * @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
34006
34092
  * @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
34007
34093
  * @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
34008
34094
  */
34009
- dataChange: (event: { source: Grid, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void
34095
+ dataChange: (event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void
34010
34096
  /**
34011
34097
  * Fires when an object is destroyed.
34012
34098
  * @param {object} event Event object
@@ -34314,18 +34400,18 @@ type GridBaseListenersTypes = {
34314
34400
  /**
34315
34401
  * Fires after a row is rendered.
34316
34402
  * @param {object} event Event object
34317
- * @param {Grid.view.Grid} event.source The firing Grid instance.
34318
- * @param {Grid.row.Row} event.row The row that has been rendered.
34319
- * @param {Core.data.Model} event.record The record for the row.
34320
- * @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
34321
34407
  */
34322
- renderRow: (event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void
34408
+ renderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
34323
34409
  /**
34324
34410
  * Grid rows have been rendered
34325
34411
  * @param {object} event Event object
34326
- * @param {Grid.view.Grid} event.source This grid.
34412
+ * @param {Grid.view.GridBase} event.source This grid.
34327
34413
  */
34328
- renderRows: (event: { source: Grid }) => void
34414
+ renderRows: (event: { source: GridBase }) => void
34329
34415
  /**
34330
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`*.
34331
34417
  * @param {object} event Event object
@@ -34385,10 +34471,10 @@ type GridBaseListenersTypes = {
34385
34471
  /**
34386
34472
  * Grid has scrolled vertically
34387
34473
  * @param {object} event Event object
34388
- * @param {Grid.view.Grid} event.source The firing Grid instance.
34474
+ * @param {Grid.view.GridBase} event.source The firing Grid instance.
34389
34475
  * @param {number} event.scrollTop The vertical scroll position.
34390
34476
  */
34391
- scroll: (event: { source: Grid, scrollTop: number }) => void
34477
+ scroll: (event: { source: GridBase, scrollTop: number }) => void
34392
34478
  /**
34393
34479
  * The selection has been changed.
34394
34480
  * @param {object} event Event object
@@ -34476,17 +34562,17 @@ type GridBaseListenersTypes = {
34476
34562
  /**
34477
34563
  * Fires after a sub grid is collapsed.
34478
34564
  * @param {object} event Event object
34479
- * @param {Grid.view.Grid} event.source The firing Grid instance
34565
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
34480
34566
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
34481
34567
  */
34482
- subGridCollapse: (event: { source: Grid, subGrid: SubGrid }) => void
34568
+ subGridCollapse: (event: { source: GridBase, subGrid: SubGrid }) => void
34483
34569
  /**
34484
34570
  * Fires after a sub grid is expanded.
34485
34571
  * @param {object} event Event object
34486
- * @param {Grid.view.Grid} event.source The firing Grid instance
34572
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
34487
34573
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
34488
34574
  */
34489
- subGridExpand: (event: { source: Grid, subGrid: SubGrid }) => void
34575
+ subGridExpand: (event: { source: GridBase, subGrid: SubGrid }) => void
34490
34576
  /**
34491
34577
  * Fired when one or more groups are expanded or collapsed
34492
34578
  * @param {object} event Event object
@@ -34579,6 +34665,14 @@ type GridBaseListeners = {
34579
34665
  * @param {any} event.value The value being set
34580
34666
  */
34581
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
34582
34676
  /**
34583
34677
  * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
34584
34678
  * @param {object} event Event object
@@ -34673,24 +34767,24 @@ type GridBaseListeners = {
34673
34767
  /**
34674
34768
  * Fires on the owning Grid before export started. Return `false` to cancel the export.
34675
34769
  * @param {object} event Event object
34676
- * @param {object} event.config Export config
34770
+ * @param {PdfExportConfig} event.config Export config
34677
34771
  */
34678
- beforePdfExport?: ((event: { config: object }) => Promise<boolean>|boolean|void)|string
34772
+ beforePdfExport?: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
34679
34773
  /**
34680
34774
  * Fires before a row is rendered.
34681
34775
  * @param {object} event Event object
34682
- * @param {Grid.view.Grid} event.source The firing Grid instance.
34683
- * @param {Grid.row.Row} event.row The row about to be rendered.
34684
- * @param {Core.data.Model} event.record The record for the row.
34685
- * @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
34686
34780
  */
34687
- beforeRenderRow?: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
34781
+ beforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
34688
34782
  /**
34689
34783
  * Grid rows are about to be rendered
34690
34784
  * @param {object} event Event object
34691
- * @param {Grid.view.Grid} event.source This grid.
34785
+ * @param {Grid.view.GridBase} event.source This grid.
34692
34786
  */
34693
- beforeRenderRows?: ((event: { source: Grid }) => void)|string
34787
+ beforeRenderRows?: ((event: { source: GridBase }) => void)|string
34694
34788
  /**
34695
34789
  * This event fires before row collapse is started.
34696
34790
  * ...
@@ -34921,6 +35015,14 @@ type GridBaseListeners = {
34921
35015
  * @param {Core.data.Model} event.record The record which has been collapsed.
34922
35016
  */
34923
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
34924
35026
  /**
34925
35027
  * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
34926
35028
  * to indicate whether the drop position is valid or not.
@@ -35002,14 +35104,14 @@ type GridBaseListeners = {
35002
35104
  * ...
35003
35105
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-dataChange)
35004
35106
  * @param {object} event Event object
35005
- * @param {Grid.view.Grid} event.source Owning grid
35107
+ * @param {Grid.view.GridBase} event.source Owning grid
35006
35108
  * @param {Core.data.Store} event.store The originating store
35007
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'`
35008
35110
  * @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
35009
35111
  * @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
35010
35112
  * @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
35011
35113
  */
35012
- dataChange?: ((event: { source: Grid, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
35114
+ dataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
35013
35115
  /**
35014
35116
  * Fires when an object is destroyed.
35015
35117
  * @param {object} event Event object
@@ -35317,18 +35419,18 @@ type GridBaseListeners = {
35317
35419
  /**
35318
35420
  * Fires after a row is rendered.
35319
35421
  * @param {object} event Event object
35320
- * @param {Grid.view.Grid} event.source The firing Grid instance.
35321
- * @param {Grid.row.Row} event.row The row that has been rendered.
35322
- * @param {Core.data.Model} event.record The record for the row.
35323
- * @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
35324
35426
  */
35325
- renderRow?: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
35427
+ renderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
35326
35428
  /**
35327
35429
  * Grid rows have been rendered
35328
35430
  * @param {object} event Event object
35329
- * @param {Grid.view.Grid} event.source This grid.
35431
+ * @param {Grid.view.GridBase} event.source This grid.
35330
35432
  */
35331
- renderRows?: ((event: { source: Grid }) => void)|string
35433
+ renderRows?: ((event: { source: GridBase }) => void)|string
35332
35434
  /**
35333
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`*.
35334
35436
  * @param {object} event Event object
@@ -35388,10 +35490,10 @@ type GridBaseListeners = {
35388
35490
  /**
35389
35491
  * Grid has scrolled vertically
35390
35492
  * @param {object} event Event object
35391
- * @param {Grid.view.Grid} event.source The firing Grid instance.
35493
+ * @param {Grid.view.GridBase} event.source The firing Grid instance.
35392
35494
  * @param {number} event.scrollTop The vertical scroll position.
35393
35495
  */
35394
- scroll?: ((event: { source: Grid, scrollTop: number }) => void)|string
35496
+ scroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
35395
35497
  /**
35396
35498
  * The selection has been changed.
35397
35499
  * @param {object} event Event object
@@ -35479,17 +35581,17 @@ type GridBaseListeners = {
35479
35581
  /**
35480
35582
  * Fires after a sub grid is collapsed.
35481
35583
  * @param {object} event Event object
35482
- * @param {Grid.view.Grid} event.source The firing Grid instance
35584
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
35483
35585
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
35484
35586
  */
35485
- subGridCollapse?: ((event: { source: Grid, subGrid: SubGrid }) => void)|string
35587
+ subGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
35486
35588
  /**
35487
35589
  * Fires after a sub grid is expanded.
35488
35590
  * @param {object} event Event object
35489
- * @param {Grid.view.Grid} event.source The firing Grid instance
35591
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
35490
35592
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
35491
35593
  */
35492
- subGridExpand?: ((event: { source: Grid, subGrid: SubGrid }) => void)|string
35594
+ subGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
35493
35595
  /**
35494
35596
  * Fired when one or more groups are expanded or collapsed
35495
35597
  * @param {object} event Event object
@@ -36416,6 +36518,14 @@ type GridBaseConfig = {
36416
36518
  * @param {any} event.value The value being set
36417
36519
  */
36418
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
36419
36529
  /**
36420
36530
  * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
36421
36531
  * @param {object} event Event object
@@ -36510,24 +36620,24 @@ type GridBaseConfig = {
36510
36620
  /**
36511
36621
  * Fires on the owning Grid before export started. Return `false` to cancel the export.
36512
36622
  * @param {object} event Event object
36513
- * @param {object} event.config Export config
36623
+ * @param {PdfExportConfig} event.config Export config
36514
36624
  */
36515
- onBeforePdfExport?: ((event: { config: object }) => Promise<boolean>|boolean|void)|string
36625
+ onBeforePdfExport?: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
36516
36626
  /**
36517
36627
  * Fires before a row is rendered.
36518
36628
  * @param {object} event Event object
36519
- * @param {Grid.view.Grid} event.source The firing Grid instance.
36520
- * @param {Grid.row.Row} event.row The row about to be rendered.
36521
- * @param {Core.data.Model} event.record The record for the row.
36522
- * @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
36523
36633
  */
36524
- onBeforeRenderRow?: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
36634
+ onBeforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
36525
36635
  /**
36526
36636
  * Grid rows are about to be rendered
36527
36637
  * @param {object} event Event object
36528
- * @param {Grid.view.Grid} event.source This grid.
36638
+ * @param {Grid.view.GridBase} event.source This grid.
36529
36639
  */
36530
- onBeforeRenderRows?: ((event: { source: Grid }) => void)|string
36640
+ onBeforeRenderRows?: ((event: { source: GridBase }) => void)|string
36531
36641
  /**
36532
36642
  * This event fires before row collapse is started.
36533
36643
  * ...
@@ -36758,6 +36868,14 @@ type GridBaseConfig = {
36758
36868
  * @param {Core.data.Model} event.record The record which has been collapsed.
36759
36869
  */
36760
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
36761
36879
  /**
36762
36880
  * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
36763
36881
  * to indicate whether the drop position is valid or not.
@@ -36839,14 +36957,14 @@ type GridBaseConfig = {
36839
36957
  * ...
36840
36958
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-dataChange)
36841
36959
  * @param {object} event Event object
36842
- * @param {Grid.view.Grid} event.source Owning grid
36960
+ * @param {Grid.view.GridBase} event.source Owning grid
36843
36961
  * @param {Core.data.Store} event.store The originating store
36844
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'`
36845
36963
  * @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
36846
36964
  * @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
36847
36965
  * @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
36848
36966
  */
36849
- onDataChange?: ((event: { source: Grid, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
36967
+ onDataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
36850
36968
  /**
36851
36969
  * Fires when an object is destroyed.
36852
36970
  * @param {object} event Event object
@@ -37154,18 +37272,18 @@ type GridBaseConfig = {
37154
37272
  /**
37155
37273
  * Fires after a row is rendered.
37156
37274
  * @param {object} event Event object
37157
- * @param {Grid.view.Grid} event.source The firing Grid instance.
37158
- * @param {Grid.row.Row} event.row The row that has been rendered.
37159
- * @param {Core.data.Model} event.record The record for the row.
37160
- * @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
37161
37279
  */
37162
- onRenderRow?: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
37280
+ onRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
37163
37281
  /**
37164
37282
  * Grid rows have been rendered
37165
37283
  * @param {object} event Event object
37166
- * @param {Grid.view.Grid} event.source This grid.
37284
+ * @param {Grid.view.GridBase} event.source This grid.
37167
37285
  */
37168
- onRenderRows?: ((event: { source: Grid }) => void)|string
37286
+ onRenderRows?: ((event: { source: GridBase }) => void)|string
37169
37287
  /**
37170
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`*.
37171
37289
  * @param {object} event Event object
@@ -37225,10 +37343,10 @@ type GridBaseConfig = {
37225
37343
  /**
37226
37344
  * Grid has scrolled vertically
37227
37345
  * @param {object} event Event object
37228
- * @param {Grid.view.Grid} event.source The firing Grid instance.
37346
+ * @param {Grid.view.GridBase} event.source The firing Grid instance.
37229
37347
  * @param {number} event.scrollTop The vertical scroll position.
37230
37348
  */
37231
- onScroll?: ((event: { source: Grid, scrollTop: number }) => void)|string
37349
+ onScroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
37232
37350
  /**
37233
37351
  * The selection has been changed.
37234
37352
  * @param {object} event Event object
@@ -37316,17 +37434,17 @@ type GridBaseConfig = {
37316
37434
  /**
37317
37435
  * Fires after a sub grid is collapsed.
37318
37436
  * @param {object} event Event object
37319
- * @param {Grid.view.Grid} event.source The firing Grid instance
37437
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
37320
37438
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
37321
37439
  */
37322
- onSubGridCollapse?: ((event: { source: Grid, subGrid: SubGrid }) => void)|string
37440
+ onSubGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
37323
37441
  /**
37324
37442
  * Fires after a sub grid is expanded.
37325
37443
  * @param {object} event Event object
37326
- * @param {Grid.view.Grid} event.source The firing Grid instance
37444
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
37327
37445
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
37328
37446
  */
37329
- onSubGridExpand?: ((event: { source: Grid, subGrid: SubGrid }) => void)|string
37447
+ onSubGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
37330
37448
  /**
37331
37449
  * Fired when one or more groups are expanded or collapsed
37332
37450
  * @param {object} event Event object
@@ -37748,6 +37866,14 @@ export class GridBase extends Panel {
37748
37866
  * @param {any} event.value The value being set
37749
37867
  */
37750
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
37751
37877
  /**
37752
37878
  * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
37753
37879
  * @param {object} event Event object
@@ -37836,24 +37962,24 @@ export class GridBase extends Panel {
37836
37962
  /**
37837
37963
  * Fires on the owning Grid before export started. Return `false` to cancel the export.
37838
37964
  * @param {object} event Event object
37839
- * @param {object} event.config Export config
37965
+ * @param {PdfExportConfig} event.config Export config
37840
37966
  */
37841
- onBeforePdfExport: ((event: { config: object }) => Promise<boolean>|boolean|void)|string
37967
+ onBeforePdfExport: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
37842
37968
  /**
37843
37969
  * Fires before a row is rendered.
37844
37970
  * @param {object} event Event object
37845
- * @param {Grid.view.Grid} event.source The firing Grid instance.
37846
- * @param {Grid.row.Row} event.row The row about to be rendered.
37847
- * @param {Core.data.Model} event.record The record for the row.
37848
- * @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
37849
37975
  */
37850
- onBeforeRenderRow: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
37976
+ onBeforeRenderRow: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
37851
37977
  /**
37852
37978
  * Grid rows are about to be rendered
37853
37979
  * @param {object} event Event object
37854
- * @param {Grid.view.Grid} event.source This grid.
37980
+ * @param {Grid.view.GridBase} event.source This grid.
37855
37981
  */
37856
- onBeforeRenderRows: ((event: { source: Grid }) => void)|string
37982
+ onBeforeRenderRows: ((event: { source: GridBase }) => void)|string
37857
37983
  /**
37858
37984
  * This event fires before row collapse is started.
37859
37985
  * ...
@@ -38064,6 +38190,14 @@ export class GridBase extends Panel {
38064
38190
  * @param {Core.data.Model} event.record The record which has been collapsed.
38065
38191
  */
38066
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
38067
38201
  /**
38068
38202
  * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
38069
38203
  * to indicate whether the drop position is valid or not.
@@ -38128,14 +38262,14 @@ export class GridBase extends Panel {
38128
38262
  * ...
38129
38263
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-dataChange)
38130
38264
  * @param {object} event Event object
38131
- * @param {Grid.view.Grid} event.source Owning grid
38265
+ * @param {Grid.view.GridBase} event.source Owning grid
38132
38266
  * @param {Core.data.Store} event.store The originating store
38133
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'`
38134
38268
  * @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
38135
38269
  * @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
38136
38270
  * @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
38137
38271
  */
38138
- onDataChange: ((event: { source: Grid, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
38272
+ onDataChange: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
38139
38273
  /**
38140
38274
  * Fires when an object is destroyed.
38141
38275
  * @param {object} event Event object
@@ -38373,18 +38507,18 @@ export class GridBase extends Panel {
38373
38507
  /**
38374
38508
  * Fires after a row is rendered.
38375
38509
  * @param {object} event Event object
38376
- * @param {Grid.view.Grid} event.source The firing Grid instance.
38377
- * @param {Grid.row.Row} event.row The row that has been rendered.
38378
- * @param {Core.data.Model} event.record The record for the row.
38379
- * @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
38380
38514
  */
38381
- onRenderRow: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
38515
+ onRenderRow: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
38382
38516
  /**
38383
38517
  * Grid rows have been rendered
38384
38518
  * @param {object} event Event object
38385
- * @param {Grid.view.Grid} event.source This grid.
38519
+ * @param {Grid.view.GridBase} event.source This grid.
38386
38520
  */
38387
- onRenderRows: ((event: { source: Grid }) => void)|string
38521
+ onRenderRows: ((event: { source: GridBase }) => void)|string
38388
38522
  /**
38389
38523
  * Grid resize lead to a new responsive level being applied
38390
38524
  * @param {object} event Event object
@@ -38434,10 +38568,10 @@ export class GridBase extends Panel {
38434
38568
  /**
38435
38569
  * Grid has scrolled vertically
38436
38570
  * @param {object} event Event object
38437
- * @param {Grid.view.Grid} event.source The firing Grid instance.
38571
+ * @param {Grid.view.GridBase} event.source The firing Grid instance.
38438
38572
  * @param {number} event.scrollTop The vertical scroll position.
38439
38573
  */
38440
- onScroll: ((event: { source: Grid, scrollTop: number }) => void)|string
38574
+ onScroll: ((event: { source: GridBase, scrollTop: number }) => void)|string
38441
38575
  /**
38442
38576
  * The selection has been changed.
38443
38577
  * @param {object} event Event object
@@ -38519,17 +38653,17 @@ export class GridBase extends Panel {
38519
38653
  /**
38520
38654
  * Fires after a sub grid is collapsed.
38521
38655
  * @param {object} event Event object
38522
- * @param {Grid.view.Grid} event.source The firing Grid instance
38656
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
38523
38657
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
38524
38658
  */
38525
- onSubGridCollapse: ((event: { source: Grid, subGrid: SubGrid }) => void)|string
38659
+ onSubGridCollapse: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
38526
38660
  /**
38527
38661
  * Fires after a sub grid is expanded.
38528
38662
  * @param {object} event Event object
38529
- * @param {Grid.view.Grid} event.source The firing Grid instance
38663
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
38530
38664
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
38531
38665
  */
38532
- onSubGridExpand: ((event: { source: Grid, subGrid: SubGrid }) => void)|string
38666
+ onSubGridExpand: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
38533
38667
  /**
38534
38668
  * Fired when one or more groups are expanded or collapsed
38535
38669
  * @param {object} event Event object
@@ -38841,9 +38975,9 @@ export class GridBase extends Panel {
38841
38975
  /**
38842
38976
  * Starts the print process. Accepts a config object which overrides any default configs.
38843
38977
  * <strong>NOTE</strong> Component should not be interacted with when print is in progress
38844
- * @param {object} config
38978
+ * @param {PrintConfig} config
38845
38979
  */
38846
- print(config: object): Promise<any>;
38980
+ print(config: PrintConfig): Promise<any>;
38847
38981
  /**
38848
38982
  * Triggers a render of all the cells in a column.
38849
38983
  * @param {Grid.column.Column,Grid.column.Column[]} column
@@ -40051,6 +40185,14 @@ type TreeGridListenersTypes = {
40051
40185
  * @param {any} event.value The value being set
40052
40186
  */
40053
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
40054
40196
  /**
40055
40197
  * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
40056
40198
  * @param {object} event Event object
@@ -40145,24 +40287,24 @@ type TreeGridListenersTypes = {
40145
40287
  /**
40146
40288
  * Fires on the owning Grid before export started. Return `false` to cancel the export.
40147
40289
  * @param {object} event Event object
40148
- * @param {object} event.config Export config
40290
+ * @param {PdfExportConfig} event.config Export config
40149
40291
  */
40150
- beforePdfExport: (event: { config: object }) => Promise<boolean>|boolean|void
40292
+ beforePdfExport: (event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void
40151
40293
  /**
40152
40294
  * Fires before a row is rendered.
40153
40295
  * @param {object} event Event object
40154
- * @param {Grid.view.Grid} event.source The firing Grid instance.
40155
- * @param {Grid.row.Row} event.row The row about to be rendered.
40156
- * @param {Core.data.Model} event.record The record for the row.
40157
- * @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
40158
40300
  */
40159
- beforeRenderRow: (event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void
40301
+ beforeRenderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
40160
40302
  /**
40161
40303
  * Grid rows are about to be rendered
40162
40304
  * @param {object} event Event object
40163
- * @param {Grid.view.Grid} event.source This grid.
40305
+ * @param {Grid.view.GridBase} event.source This grid.
40164
40306
  */
40165
- beforeRenderRows: (event: { source: Grid }) => void
40307
+ beforeRenderRows: (event: { source: GridBase }) => void
40166
40308
  /**
40167
40309
  * This event fires before row collapse is started.
40168
40310
  * ...
@@ -40393,6 +40535,14 @@ type TreeGridListenersTypes = {
40393
40535
  * @param {Core.data.Model} event.record The record which has been collapsed.
40394
40536
  */
40395
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
40396
40546
  /**
40397
40547
  * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
40398
40548
  * to indicate whether the drop position is valid or not.
@@ -40474,14 +40624,14 @@ type TreeGridListenersTypes = {
40474
40624
  * ...
40475
40625
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-dataChange)
40476
40626
  * @param {object} event Event object
40477
- * @param {Grid.view.Grid} event.source Owning grid
40627
+ * @param {Grid.view.GridBase} event.source Owning grid
40478
40628
  * @param {Core.data.Store} event.store The originating store
40479
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'`
40480
40630
  * @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
40481
40631
  * @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
40482
40632
  * @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
40483
40633
  */
40484
- dataChange: (event: { source: Grid, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void
40634
+ dataChange: (event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void
40485
40635
  /**
40486
40636
  * Fires when an object is destroyed.
40487
40637
  * @param {object} event Event object
@@ -40789,18 +40939,18 @@ type TreeGridListenersTypes = {
40789
40939
  /**
40790
40940
  * Fires after a row is rendered.
40791
40941
  * @param {object} event Event object
40792
- * @param {Grid.view.Grid} event.source The firing Grid instance.
40793
- * @param {Grid.row.Row} event.row The row that has been rendered.
40794
- * @param {Core.data.Model} event.record The record for the row.
40795
- * @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
40796
40946
  */
40797
- renderRow: (event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void
40947
+ renderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
40798
40948
  /**
40799
40949
  * Grid rows have been rendered
40800
40950
  * @param {object} event Event object
40801
- * @param {Grid.view.Grid} event.source This grid.
40951
+ * @param {Grid.view.GridBase} event.source This grid.
40802
40952
  */
40803
- renderRows: (event: { source: Grid }) => void
40953
+ renderRows: (event: { source: GridBase }) => void
40804
40954
  /**
40805
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`*.
40806
40956
  * @param {object} event Event object
@@ -40860,10 +41010,10 @@ type TreeGridListenersTypes = {
40860
41010
  /**
40861
41011
  * Grid has scrolled vertically
40862
41012
  * @param {object} event Event object
40863
- * @param {Grid.view.Grid} event.source The firing Grid instance.
41013
+ * @param {Grid.view.GridBase} event.source The firing Grid instance.
40864
41014
  * @param {number} event.scrollTop The vertical scroll position.
40865
41015
  */
40866
- scroll: (event: { source: Grid, scrollTop: number }) => void
41016
+ scroll: (event: { source: GridBase, scrollTop: number }) => void
40867
41017
  /**
40868
41018
  * The selection has been changed.
40869
41019
  * @param {object} event Event object
@@ -40951,17 +41101,17 @@ type TreeGridListenersTypes = {
40951
41101
  /**
40952
41102
  * Fires after a sub grid is collapsed.
40953
41103
  * @param {object} event Event object
40954
- * @param {Grid.view.Grid} event.source The firing Grid instance
41104
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
40955
41105
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
40956
41106
  */
40957
- subGridCollapse: (event: { source: Grid, subGrid: SubGrid }) => void
41107
+ subGridCollapse: (event: { source: GridBase, subGrid: SubGrid }) => void
40958
41108
  /**
40959
41109
  * Fires after a sub grid is expanded.
40960
41110
  * @param {object} event Event object
40961
- * @param {Grid.view.Grid} event.source The firing Grid instance
41111
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
40962
41112
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
40963
41113
  */
40964
- subGridExpand: (event: { source: Grid, subGrid: SubGrid }) => void
41114
+ subGridExpand: (event: { source: GridBase, subGrid: SubGrid }) => void
40965
41115
  /**
40966
41116
  * Fired when one or more groups are expanded or collapsed
40967
41117
  * @param {object} event Event object
@@ -41054,6 +41204,14 @@ type TreeGridListeners = {
41054
41204
  * @param {any} event.value The value being set
41055
41205
  */
41056
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
41057
41215
  /**
41058
41216
  * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
41059
41217
  * @param {object} event Event object
@@ -41148,24 +41306,24 @@ type TreeGridListeners = {
41148
41306
  /**
41149
41307
  * Fires on the owning Grid before export started. Return `false` to cancel the export.
41150
41308
  * @param {object} event Event object
41151
- * @param {object} event.config Export config
41309
+ * @param {PdfExportConfig} event.config Export config
41152
41310
  */
41153
- beforePdfExport?: ((event: { config: object }) => Promise<boolean>|boolean|void)|string
41311
+ beforePdfExport?: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
41154
41312
  /**
41155
41313
  * Fires before a row is rendered.
41156
41314
  * @param {object} event Event object
41157
- * @param {Grid.view.Grid} event.source The firing Grid instance.
41158
- * @param {Grid.row.Row} event.row The row about to be rendered.
41159
- * @param {Core.data.Model} event.record The record for the row.
41160
- * @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
41161
41319
  */
41162
- beforeRenderRow?: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
41320
+ beforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
41163
41321
  /**
41164
41322
  * Grid rows are about to be rendered
41165
41323
  * @param {object} event Event object
41166
- * @param {Grid.view.Grid} event.source This grid.
41324
+ * @param {Grid.view.GridBase} event.source This grid.
41167
41325
  */
41168
- beforeRenderRows?: ((event: { source: Grid }) => void)|string
41326
+ beforeRenderRows?: ((event: { source: GridBase }) => void)|string
41169
41327
  /**
41170
41328
  * This event fires before row collapse is started.
41171
41329
  * ...
@@ -41396,6 +41554,14 @@ type TreeGridListeners = {
41396
41554
  * @param {Core.data.Model} event.record The record which has been collapsed.
41397
41555
  */
41398
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
41399
41565
  /**
41400
41566
  * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
41401
41567
  * to indicate whether the drop position is valid or not.
@@ -41477,14 +41643,14 @@ type TreeGridListeners = {
41477
41643
  * ...
41478
41644
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-dataChange)
41479
41645
  * @param {object} event Event object
41480
- * @param {Grid.view.Grid} event.source Owning grid
41646
+ * @param {Grid.view.GridBase} event.source Owning grid
41481
41647
  * @param {Core.data.Store} event.store The originating store
41482
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'`
41483
41649
  * @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
41484
41650
  * @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
41485
41651
  * @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
41486
41652
  */
41487
- dataChange?: ((event: { source: Grid, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
41653
+ dataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
41488
41654
  /**
41489
41655
  * Fires when an object is destroyed.
41490
41656
  * @param {object} event Event object
@@ -41792,18 +41958,18 @@ type TreeGridListeners = {
41792
41958
  /**
41793
41959
  * Fires after a row is rendered.
41794
41960
  * @param {object} event Event object
41795
- * @param {Grid.view.Grid} event.source The firing Grid instance.
41796
- * @param {Grid.row.Row} event.row The row that has been rendered.
41797
- * @param {Core.data.Model} event.record The record for the row.
41798
- * @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
41799
41965
  */
41800
- renderRow?: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
41966
+ renderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
41801
41967
  /**
41802
41968
  * Grid rows have been rendered
41803
41969
  * @param {object} event Event object
41804
- * @param {Grid.view.Grid} event.source This grid.
41970
+ * @param {Grid.view.GridBase} event.source This grid.
41805
41971
  */
41806
- renderRows?: ((event: { source: Grid }) => void)|string
41972
+ renderRows?: ((event: { source: GridBase }) => void)|string
41807
41973
  /**
41808
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`*.
41809
41975
  * @param {object} event Event object
@@ -41863,10 +42029,10 @@ type TreeGridListeners = {
41863
42029
  /**
41864
42030
  * Grid has scrolled vertically
41865
42031
  * @param {object} event Event object
41866
- * @param {Grid.view.Grid} event.source The firing Grid instance.
42032
+ * @param {Grid.view.GridBase} event.source The firing Grid instance.
41867
42033
  * @param {number} event.scrollTop The vertical scroll position.
41868
42034
  */
41869
- scroll?: ((event: { source: Grid, scrollTop: number }) => void)|string
42035
+ scroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
41870
42036
  /**
41871
42037
  * The selection has been changed.
41872
42038
  * @param {object} event Event object
@@ -41954,17 +42120,17 @@ type TreeGridListeners = {
41954
42120
  /**
41955
42121
  * Fires after a sub grid is collapsed.
41956
42122
  * @param {object} event Event object
41957
- * @param {Grid.view.Grid} event.source The firing Grid instance
42123
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
41958
42124
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
41959
42125
  */
41960
- subGridCollapse?: ((event: { source: Grid, subGrid: SubGrid }) => void)|string
42126
+ subGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
41961
42127
  /**
41962
42128
  * Fires after a sub grid is expanded.
41963
42129
  * @param {object} event Event object
41964
- * @param {Grid.view.Grid} event.source The firing Grid instance
42130
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
41965
42131
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
41966
42132
  */
41967
- subGridExpand?: ((event: { source: Grid, subGrid: SubGrid }) => void)|string
42133
+ subGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
41968
42134
  /**
41969
42135
  * Fired when one or more groups are expanded or collapsed
41970
42136
  * @param {object} event Event object
@@ -42892,6 +43058,14 @@ type TreeGridConfig = {
42892
43058
  * @param {any} event.value The value being set
42893
43059
  */
42894
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
42895
43069
  /**
42896
43070
  * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
42897
43071
  * @param {object} event Event object
@@ -42986,24 +43160,24 @@ type TreeGridConfig = {
42986
43160
  /**
42987
43161
  * Fires on the owning Grid before export started. Return `false` to cancel the export.
42988
43162
  * @param {object} event Event object
42989
- * @param {object} event.config Export config
43163
+ * @param {PdfExportConfig} event.config Export config
42990
43164
  */
42991
- onBeforePdfExport?: ((event: { config: object }) => Promise<boolean>|boolean|void)|string
43165
+ onBeforePdfExport?: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
42992
43166
  /**
42993
43167
  * Fires before a row is rendered.
42994
43168
  * @param {object} event Event object
42995
- * @param {Grid.view.Grid} event.source The firing Grid instance.
42996
- * @param {Grid.row.Row} event.row The row about to be rendered.
42997
- * @param {Core.data.Model} event.record The record for the row.
42998
- * @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
42999
43173
  */
43000
- onBeforeRenderRow?: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
43174
+ onBeforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
43001
43175
  /**
43002
43176
  * Grid rows are about to be rendered
43003
43177
  * @param {object} event Event object
43004
- * @param {Grid.view.Grid} event.source This grid.
43178
+ * @param {Grid.view.GridBase} event.source This grid.
43005
43179
  */
43006
- onBeforeRenderRows?: ((event: { source: Grid }) => void)|string
43180
+ onBeforeRenderRows?: ((event: { source: GridBase }) => void)|string
43007
43181
  /**
43008
43182
  * This event fires before row collapse is started.
43009
43183
  * ...
@@ -43234,6 +43408,14 @@ type TreeGridConfig = {
43234
43408
  * @param {Core.data.Model} event.record The record which has been collapsed.
43235
43409
  */
43236
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
43237
43419
  /**
43238
43420
  * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
43239
43421
  * to indicate whether the drop position is valid or not.
@@ -43315,14 +43497,14 @@ type TreeGridConfig = {
43315
43497
  * ...
43316
43498
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-dataChange)
43317
43499
  * @param {object} event Event object
43318
- * @param {Grid.view.Grid} event.source Owning grid
43500
+ * @param {Grid.view.GridBase} event.source Owning grid
43319
43501
  * @param {Core.data.Store} event.store The originating store
43320
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'`
43321
43503
  * @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
43322
43504
  * @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
43323
43505
  * @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
43324
43506
  */
43325
- onDataChange?: ((event: { source: Grid, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
43507
+ onDataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
43326
43508
  /**
43327
43509
  * Fires when an object is destroyed.
43328
43510
  * @param {object} event Event object
@@ -43630,18 +43812,18 @@ type TreeGridConfig = {
43630
43812
  /**
43631
43813
  * Fires after a row is rendered.
43632
43814
  * @param {object} event Event object
43633
- * @param {Grid.view.Grid} event.source The firing Grid instance.
43634
- * @param {Grid.row.Row} event.row The row that has been rendered.
43635
- * @param {Core.data.Model} event.record The record for the row.
43636
- * @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
43637
43819
  */
43638
- onRenderRow?: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
43820
+ onRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
43639
43821
  /**
43640
43822
  * Grid rows have been rendered
43641
43823
  * @param {object} event Event object
43642
- * @param {Grid.view.Grid} event.source This grid.
43824
+ * @param {Grid.view.GridBase} event.source This grid.
43643
43825
  */
43644
- onRenderRows?: ((event: { source: Grid }) => void)|string
43826
+ onRenderRows?: ((event: { source: GridBase }) => void)|string
43645
43827
  /**
43646
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`*.
43647
43829
  * @param {object} event Event object
@@ -43701,10 +43883,10 @@ type TreeGridConfig = {
43701
43883
  /**
43702
43884
  * Grid has scrolled vertically
43703
43885
  * @param {object} event Event object
43704
- * @param {Grid.view.Grid} event.source The firing Grid instance.
43886
+ * @param {Grid.view.GridBase} event.source The firing Grid instance.
43705
43887
  * @param {number} event.scrollTop The vertical scroll position.
43706
43888
  */
43707
- onScroll?: ((event: { source: Grid, scrollTop: number }) => void)|string
43889
+ onScroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
43708
43890
  /**
43709
43891
  * The selection has been changed.
43710
43892
  * @param {object} event Event object
@@ -43792,17 +43974,17 @@ type TreeGridConfig = {
43792
43974
  /**
43793
43975
  * Fires after a sub grid is collapsed.
43794
43976
  * @param {object} event Event object
43795
- * @param {Grid.view.Grid} event.source The firing Grid instance
43977
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
43796
43978
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
43797
43979
  */
43798
- onSubGridCollapse?: ((event: { source: Grid, subGrid: SubGrid }) => void)|string
43980
+ onSubGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
43799
43981
  /**
43800
43982
  * Fires after a sub grid is expanded.
43801
43983
  * @param {object} event Event object
43802
- * @param {Grid.view.Grid} event.source The firing Grid instance
43984
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
43803
43985
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
43804
43986
  */
43805
- onSubGridExpand?: ((event: { source: Grid, subGrid: SubGrid }) => void)|string
43987
+ onSubGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
43806
43988
  /**
43807
43989
  * Fired when one or more groups are expanded or collapsed
43808
43990
  * @param {object} event Event object