@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.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
@@ -1542,10 +1542,16 @@ type ActionConfig = {
1542
1542
  */
1543
1543
  cls?: string
1544
1544
  /**
1545
- * A text to use for the action element´s `aria-label` value. If not provided, the
1546
- * action´s `tooltip` will be used as the `aria-label` (if present).
1545
+ * A text to use for the action element's `aria-label` value. If not provided, the
1546
+ * action's `tooltip` will be used as the `aria-label` (if present).
1547
1547
  */
1548
1548
  ariaLabel?: string
1549
+ /**
1550
+ * A value to use for the action element's `aria-haspopup` attribute.
1551
+ * Set to indicate that the action triggers a popup. This helps assistive technologies inform users that activating
1552
+ * the action will display a popup element.
1553
+ */
1554
+ ariaHasPopup?: 'true'|'false'|'menu'|'listbox'|'tree'|'grid'|'dialog'|boolean
1549
1555
  /**
1550
1556
  * Tooltip text, or a config object which can reconfigure the shared
1551
1557
  * tooltip by setting boolean, numeric and string config values, or a function to return the tooltip text, passed the
@@ -1805,7 +1811,7 @@ type EmptyTextDomConfig = DomConfig & {
1805
1811
  /**
1806
1812
  * The grid region to add the empty text to
1807
1813
  */
1808
- region?: string
1814
+ region?: 'locked'|'normal'|string
1809
1815
  }
1810
1816
 
1811
1817
  type GridScrollOptions = {
@@ -3486,7 +3492,9 @@ type AjaxStoreConfig = {
3486
3492
  */
3487
3493
  readUrl?: string
3488
3494
  /**
3489
- * Specify true to reapply filters when a record is added to the store.
3495
+ * Specify `true` to reapply filters when a record is added to or moved within the store.
3496
+ * This includes tree node operations like indent/outdent in Gantt, or any move operation
3497
+ * that changes a node's parent.
3490
3498
  */
3491
3499
  reapplyFilterOnAdd?: boolean
3492
3500
  /**
@@ -4727,6 +4735,16 @@ export class Duration {
4727
4735
  * @param {number,string,object,Core.data.Duration} source The data to be converted into a Duration.
4728
4736
  */
4729
4737
  static from(source: number|string|object|Duration): Duration;
4738
+ /**
4739
+ * Returns a new Duration which is the sum of this Duration and the passed Duration. The returned Duration unit is the same as this Duration's unit.
4740
+ * @param {Core.data.Duration} otherDuration
4741
+ */
4742
+ add(otherDuration: Duration): Duration;
4743
+ /**
4744
+ * Returns a new Duration which is the difference between this Duration and the passed Duration. The returned Duration unit is the same as this Duration's unit.
4745
+ * @param {Core.data.Duration} otherDuration
4746
+ */
4747
+ diff(otherDuration: Duration): Duration;
4730
4748
  /**
4731
4749
  * Returns truthy value if this Duration equals the passed value.
4732
4750
  * @param {Core.data.Duration} value
@@ -6196,7 +6214,9 @@ type StoreConfig = {
6196
6214
  */
6197
6215
  pageStartParamName?: string
6198
6216
  /**
6199
- * Specify true to reapply filters when a record is added to the store.
6217
+ * Specify `true` to reapply filters when a record is added to or moved within the store.
6218
+ * This includes tree node operations like indent/outdent in Gantt, or any move operation
6219
+ * that changes a node's parent.
6200
6220
  */
6201
6221
  reapplyFilterOnAdd?: boolean
6202
6222
  /**
@@ -7379,7 +7399,7 @@ export class Store extends Base {
7379
7399
  * <strong>It will not remove other filters applied to the store!</strong>
7380
7400
  * @param {object,CollectionFilterConfig,CollectionFilterConfig[],Function} newFilters A [filter](https://bryntum.com/products/grid/docs/api/Core/util/CollectionFilter) config, or an array of [filter](https://bryntum.com/products/grid/docs/api/Core/util/CollectionFilter) configs, or a function to use for filtering, or a special object like: `{ replace : true, filters : newFilters }`
7381
7401
  */
7382
- filter(newFilters: {
7402
+ filter(newFilters?: {
7383
7403
  replace?: boolean
7384
7404
  silent?: boolean
7385
7405
  filters?: CollectionFilterConfig|CollectionFilterConfig[]|Function
@@ -9765,7 +9785,9 @@ type StoreFilterClassConfig = {
9765
9785
  */
9766
9786
  filters?: CollectionFilterConfig|CollectionFilterConfig[]
9767
9787
  /**
9768
- * Specify true to reapply filters when a record is added to the store.
9788
+ * Specify `true` to reapply filters when a record is added to or moved within the store.
9789
+ * This includes tree node operations like indent/outdent in Gantt, or any move operation
9790
+ * that changes a node's parent.
9769
9791
  */
9770
9792
  reapplyFilterOnAdd?: boolean
9771
9793
  /**
@@ -9861,7 +9883,7 @@ export class StoreFilterClass {
9861
9883
  * <strong>It will not remove other filters applied to the store!</strong>
9862
9884
  * @param {object,CollectionFilterConfig,CollectionFilterConfig[],Function} newFilters A [filter](https://bryntum.com/products/grid/docs/api/Core/util/CollectionFilter) config, or an array of [filter](https://bryntum.com/products/grid/docs/api/Core/util/CollectionFilter) configs, or a function to use for filtering, or a special object like: `{ replace : true, filters : newFilters }`
9863
9885
  */
9864
- filter(newFilters: {
9886
+ filter(newFilters?: {
9865
9887
  replace?: boolean
9866
9888
  silent?: boolean
9867
9889
  filters?: CollectionFilterConfig|CollectionFilterConfig[]|Function
@@ -10879,6 +10901,44 @@ export class TreeNodeClass {
10879
10901
 
10880
10902
  export const TreeNode : <T extends AnyConstructor<Base>>(base : T) => AnyConstructor<InstanceType<T> & TreeNodeClass>
10881
10903
 
10904
+ /**
10905
+ * Type with configuration options for [RevisionTransaction](https://bryntum.com/products/grid/docs/api/Core/data/stm/RevisionTransaction) class.
10906
+ */
10907
+ type RevisionTransactionConfig = {
10908
+ /**
10909
+ * Transaction title
10910
+ */
10911
+ title?: string
10912
+ }
10913
+
10914
+ /**
10915
+ * Transaction with additional metadata utilized by the Revisions feature
10916
+ * ...
10917
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/data/stm/RevisionTransaction)
10918
+ */
10919
+ export class RevisionTransaction extends Transaction {
10920
+ /**
10921
+ * Identifies an object as an instance of [RevisionTransaction](https://bryntum.com/products/grid/docs/api/Core/data/stm/RevisionTransaction) class, or subclass thereof.
10922
+ */
10923
+ static readonly isRevisionTransaction: boolean
10924
+ /**
10925
+ * Identifies an object as an instance of [RevisionTransaction](https://bryntum.com/products/grid/docs/api/Core/data/stm/RevisionTransaction) class, or subclass thereof.
10926
+ */
10927
+ readonly isRevisionTransaction: boolean
10928
+ /**
10929
+ * Creates an instance of the class using the supplied configuration
10930
+ * @param {RevisionTransactionConfig} config
10931
+ */
10932
+ constructor(config?: RevisionTransactionConfig);
10933
+ /**
10934
+ * Creates [RevisionTransaction](https://bryntum.com/products/grid/docs/api/Core/data/stm/RevisionTransaction) from [Transaction](#Core/data/stm/Transaction)
10935
+ * with additional metadata utilized by the revisions feature
10936
+ * @param {Core.data.stm.Transaction[]} transactions Transactions to group into revision
10937
+ * @param {object} config Additional config to apply to revision transaction
10938
+ */
10939
+ static from(transactions: Transaction[], config: object): RevisionTransaction;
10940
+ }
10941
+
10882
10942
  /**
10883
10943
  * Type with available listeners functions for [StateTrackingManager](https://bryntum.com/products/grid/docs/api/Core/data/stm/StateTrackingManager) class.
10884
10944
  * Could be used for callbacks typings in TypeScript application.
@@ -11458,7 +11518,7 @@ type TransactionConfig = {
11458
11518
  }
11459
11519
 
11460
11520
  /**
11461
- * STM transaction class, holds list of actions constituting a transaction.
11521
+ * STM transaction class holds a list of actions constituting a transaction.
11462
11522
  * ...
11463
11523
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/data/stm/Transaction)
11464
11524
  */
@@ -15446,7 +15506,8 @@ export class ObjectHelper {
15446
15506
  */
15447
15507
  static toFixed(number: number, digits: number): string;
15448
15508
  /**
15449
- * Creates a new object where key is a property in array item (`ref` by default) or index in the array and value is array item.
15509
+ * Creates a new object where key is a property in array item (`ref` by default) or index in the array and value is
15510
+ * array item.
15450
15511
  * @param {object[]} arrayOfItems Array to transform.
15451
15512
  * @param {string} prop Property to read the key from. `ref` by default.
15452
15513
  */
@@ -17468,15 +17529,15 @@ export class LoadMaskableClass {
17468
17529
  export const LoadMaskable : <T extends AnyConstructor<Base>>(base : T) => AnyConstructor<InstanceType<T> & LoadMaskableClass>
17469
17530
 
17470
17531
  /**
17471
- * Simplifies overriding class methods by allowing methods from another class to be used as overrides.
17472
- * Overrides are defined as own classes. They must at a minimum contain a static getter named targetClass, which
17473
- * should return the class to override. Apply the override by calling [apply()](https://bryntum.com/products/grid/docs/api/Core/mixin/Override#function-apply-static).
17532
+ * Simplifies overriding class methods by allowing methods from another class to be used as overrides. Overrides are
17533
+ * defined as own classes. They must at a minimum contain a static getter named `target´, which should return an object
17534
+ * with the class to override. Apply the override by calling [apply()](https://bryntum.com/products/grid/docs/api/Core/mixin/Override#function-apply-static).
17474
17535
  * ...
17475
17536
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/mixin/Override)
17476
17537
  */
17477
17538
  export class Override {
17478
17539
  /**
17479
- * Apply override. We strongly suggest that you at least specify a maxVersion for your overrides.
17540
+ * Apply override. We strongly suggest that you at least specify `maxVersion` for your overrides.
17480
17541
  * @param {object} override An override class definition
17481
17542
  */
17482
17543
  static apply(override: object): void;
@@ -106038,7 +106099,7 @@ type CheckColumnConfig = {
106038
106099
  */
106039
106100
  cellMenuItems?: Record<string, MenuItemEntry>
106040
106101
  /**
106041
- * The `aria-label` to use for the default checkbox widget of cells in this Column
106102
+ * The `aria-label` used for the default checkbox widget in this column’s cells.
106042
106103
  */
106043
106104
  checkAriaLabel?: string
106044
106105
  /**
@@ -106597,7 +106658,7 @@ export class CheckColumn extends WidgetColumn {
106597
106658
  */
106598
106659
  static readonly isCheckColumn: boolean
106599
106660
  /**
106600
- * The `aria-label` to use for the default checkbox widget of cells in this Column
106661
+ * The `aria-label` used for the default checkbox widget in this column’s cells.
106601
106662
  */
106602
106663
  checkAriaLabel: string
106603
106664
  /**
@@ -109966,8 +110027,8 @@ type DateColumnConfig = {
109966
110027
  */
109967
110028
  remoteChildCount?: number
109968
110029
  /**
109969
- * Renderer function, used to style the date displayed in the cell. Can also affect other aspects of
109970
- * the cell, such as styling.
110030
+ * Renderer function, used to style the date displayed in the cell. Can also affect other aspects of the cell,
110031
+ * such as styling.
109971
110032
  * ...
109972
110033
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/DateColumn#config-renderer)
109973
110034
  * @param {object} renderData Object containing renderer parameters
@@ -110128,9 +110189,9 @@ type DateColumnConfig = {
110128
110189
  }
110129
110190
 
110130
110191
  /**
110131
- * 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
110132
- * contains the following info: full year, 2-digit month, and 2-digit day. Depending on the browser locale,
110133
- * the formatted date might look different. [Intl.DateTimeFormat API](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat)
110192
+ * A column that displays a date in the specified [format](https://bryntum.com/products/grid/docs/api/Grid/column/DateColumn#config-format). By default `L` format is used, which contains
110193
+ * the following info: full year, 2-digit month, and 2-digit day. Depending on the browser locale, the formatted date
110194
+ * might look different. [Intl.DateTimeFormat API](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat)
110134
110195
  * is used to format the date. Here is an example of possible outputs depending on the browser locale:
110135
110196
  * ...
110136
110197
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/DateColumn)
@@ -110164,8 +110225,8 @@ export class DateColumn extends Column {
110164
110225
  */
110165
110226
  min: string|Date
110166
110227
  /**
110167
- * Renderer function, used to style the date displayed in the cell. Can also affect other aspects of
110168
- * the cell, such as styling.
110228
+ * Renderer function, used to style the date displayed in the cell. Can also affect other aspects of the cell,
110229
+ * such as styling.
110169
110230
  */
110170
110231
  renderer: (renderData: { cellElement: HTMLElement, value: Date|null|undefined, record: Model, column: Column, grid: Grid, row: Row, size: { height: number, configuredHeight: number }, isExport: boolean, isMeasuring: boolean }) => string|DomConfig|DomConfig[]|void
110171
110232
  /**
@@ -114834,7 +114895,8 @@ type TimeColumnConfig = {
114834
114895
  */
114835
114896
  flex?: number|string
114836
114897
  /**
114837
- * Time format
114898
+ * Time format for time displayed in cell and editor
114899
+ * (see [format](https://bryntum.com/products/grid/docs/api/Core/helper/DateHelper#function-format-static) for formatting options)
114838
114900
  */
114839
114901
  format?: string
114840
114902
  /**
@@ -115231,7 +115293,8 @@ export class TimeColumn extends Column {
115231
115293
  */
115232
115294
  static readonly isTimeColumn: boolean
115233
115295
  /**
115234
- * Time format
115296
+ * Time format for time displayed in cell and editor
115297
+ * (see [format](https://bryntum.com/products/grid/docs/api/Core/helper/DateHelper#function-format-static) for formatting options)
115235
115298
  */
115236
115299
  format: string
115237
115300
  /**
@@ -117521,7 +117584,9 @@ type ColumnStoreConfig = {
117521
117584
  */
117522
117585
  pageStartParamName?: string
117523
117586
  /**
117524
- * Specify true to reapply filters when a record is added to the store.
117587
+ * Specify `true` to reapply filters when a record is added to or moved within the store.
117588
+ * This includes tree node operations like indent/outdent in Gantt, or any move operation
117589
+ * that changes a node's parent.
117525
117590
  */
117526
117591
  reapplyFilterOnAdd?: boolean
117527
117592
  /**
@@ -130178,9 +130243,9 @@ export class PdfExport extends InstancePlugin {
130178
130243
  /**
130179
130244
  * Starts the export process. Accepts a config object which overrides any default configs.
130180
130245
  * <strong>NOTE</strong>. Component should not be interacted with when export is in progress
130181
- * @param {object} config
130246
+ * @param {PdfExportConfig} config
130182
130247
  */
130183
- export(config: object): Promise<any>;
130248
+ export(config: PdfExportConfig): Promise<any>;
130184
130249
  /**
130185
130250
  * This method accepts all stylesheets (link and style tags) which are supposed to be put on the page. Use
130186
130251
  * this hook method to filter or modify them.
@@ -130592,9 +130657,9 @@ export class Print extends PdfExport {
130592
130657
  /**
130593
130658
  * Starts the print process. Accepts a config object which overrides any default configs.
130594
130659
  * <strong>NOTE</strong> Component should not be interacted with when print is in progress
130595
- * @param {object} config
130660
+ * @param {PrintConfig} config
130596
130661
  */
130597
- print(config: object): Promise<any>;
130662
+ print(config: PrintConfig): Promise<any>;
130598
130663
  /**
130599
130664
  * Shows the [print dialog](https://bryntum.com/products/grid/docs/api/Grid/view/export/ExportDialog)
130600
130665
  */
@@ -131944,9 +132009,9 @@ export class PrintMixinClass {
131944
132009
  /**
131945
132010
  * Starts the print process. Accepts a config object which overrides any default configs.
131946
132011
  * <strong>NOTE</strong> Component should not be interacted with when print is in progress
131947
- * @param {object} config
132012
+ * @param {PrintConfig} config
131948
132013
  */
131949
- print(config: object): Promise<any>;
132014
+ print(config: PrintConfig): Promise<any>;
131950
132015
  /**
131951
132016
  * Shows the [print dialog](https://bryntum.com/products/grid/docs/api/Grid/view/export/ExportDialog)
131952
132017
  */
@@ -132134,6 +132199,10 @@ export class GridLocation {
132134
132199
  * The cell DOM element which this `GridLocation` references.
132135
132200
  */
132136
132201
  readonly cell: HTMLElement
132202
+ /**
132203
+ * Yields the [Column](https://bryntum.com/products/grid/docs/api/Grid/column/Column) of this location.
132204
+ */
132205
+ readonly column: Column
132137
132206
  /**
132138
132207
  * Yields the column index of this location.
132139
132208
  */
@@ -132142,6 +132211,10 @@ export class GridLocation {
132142
132211
  * This property is `true` if the focus is inside the cell, not *on* the cell.
132143
132212
  */
132144
132213
  readonly containsFocus: boolean
132214
+ /**
132215
+ * The grid which this `GridLocation` references.
132216
+ */
132217
+ readonly grid: Grid
132145
132218
  /**
132146
132219
  * This property is `true` if the focus target is not the cell itself.
132147
132220
  */
@@ -132158,6 +132231,10 @@ export class GridLocation {
132158
132231
  * Yields `true` if the cell and row are selectable.
132159
132232
  */
132160
132233
  readonly isSelectable: boolean
132234
+ /**
132235
+ * 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.
132236
+ */
132237
+ readonly record: Model
132161
132238
  /**
132162
132239
  * Yields the row index of this location.
132163
132240
  */
@@ -132302,6 +132379,14 @@ type GridListenersTypes = {
132302
132379
  * @param {any} event.value The value being set
132303
132380
  */
132304
132381
  beforeCellRangeEdit: (event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void
132382
+ /**
132383
+ * This event is triggered before a parent column is collapsed or expanded.
132384
+ * @param {object} event Event object
132385
+ * @param {Grid.view.GridBase} event.source The grid instance
132386
+ * @param {Grid.column.Column} event.column The column
132387
+ * @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
132388
+ */
132389
+ beforeColumnCollapseToggle: (event: { source: GridBase, column: Column, collapsed: boolean }) => void
132305
132390
  /**
132306
132391
  * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
132307
132392
  * @param {object} event Event object
@@ -132396,24 +132481,24 @@ type GridListenersTypes = {
132396
132481
  /**
132397
132482
  * Fires on the owning Grid before export started. Return `false` to cancel the export.
132398
132483
  * @param {object} event Event object
132399
- * @param {object} event.config Export config
132484
+ * @param {PdfExportConfig} event.config Export config
132400
132485
  */
132401
- beforePdfExport: (event: { config: object }) => Promise<boolean>|boolean|void
132486
+ beforePdfExport: (event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void
132402
132487
  /**
132403
132488
  * Fires before a row is rendered.
132404
132489
  * @param {object} event Event object
132405
- * @param {Grid.view.Grid} event.source The firing Grid instance.
132406
- * @param {Grid.row.Row} event.row The row about to be rendered.
132407
- * @param {Core.data.Model} event.record The record for the row.
132408
- * @param {number} event.recordIndex The zero-based index of the record.
132490
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
132491
+ * @param {Grid.row.Row} event.row The row about to be rendered
132492
+ * @param {Core.data.Model} event.record The record for the row
132493
+ * @param {number} event.recordIndex The zero-based index of the record
132409
132494
  */
132410
- beforeRenderRow: (event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void
132495
+ beforeRenderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
132411
132496
  /**
132412
132497
  * Grid rows are about to be rendered
132413
132498
  * @param {object} event Event object
132414
- * @param {Grid.view.Grid} event.source This grid.
132499
+ * @param {Grid.view.GridBase} event.source This grid.
132415
132500
  */
132416
- beforeRenderRows: (event: { source: Grid }) => void
132501
+ beforeRenderRows: (event: { source: GridBase }) => void
132417
132502
  /**
132418
132503
  * This event fires before row collapse is started.
132419
132504
  * ...
@@ -132644,6 +132729,14 @@ type GridListenersTypes = {
132644
132729
  * @param {Core.data.Model} event.record The record which has been collapsed.
132645
132730
  */
132646
132731
  collapseNode: (event: { source: Grid, record: Model }) => void
132732
+ /**
132733
+ * This event is triggered after a parent column has been collapsed or expanded.
132734
+ * @param {object} event Event object
132735
+ * @param {Grid.view.GridBase} event.source The Grid instance
132736
+ * @param {Grid.column.Column} event.column The column being toggled
132737
+ * @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
132738
+ */
132739
+ columnCollapseToggle: (event: { source: GridBase, column: Column, collapsed: boolean }) => void
132647
132740
  /**
132648
132741
  * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
132649
132742
  * to indicate whether the drop position is valid or not.
@@ -132725,14 +132818,14 @@ type GridListenersTypes = {
132725
132818
  * ...
132726
132819
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-dataChange)
132727
132820
  * @param {object} event Event object
132728
- * @param {Grid.view.Grid} event.source Owning grid
132821
+ * @param {Grid.view.GridBase} event.source Owning grid
132729
132822
  * @param {Core.data.Store} event.store The originating store
132730
132823
  * @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
132731
132824
  * @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
132732
132825
  * @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
132733
132826
  * @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
132734
132827
  */
132735
- dataChange: (event: { source: Grid, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void
132828
+ dataChange: (event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void
132736
132829
  /**
132737
132830
  * Fires when an object is destroyed.
132738
132831
  * @param {object} event Event object
@@ -133040,18 +133133,18 @@ type GridListenersTypes = {
133040
133133
  /**
133041
133134
  * Fires after a row is rendered.
133042
133135
  * @param {object} event Event object
133043
- * @param {Grid.view.Grid} event.source The firing Grid instance.
133044
- * @param {Grid.row.Row} event.row The row that has been rendered.
133045
- * @param {Core.data.Model} event.record The record for the row.
133046
- * @param {number} event.recordIndex The zero-based index of the record.
133136
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
133137
+ * @param {Grid.row.Row} event.row The row that has been rendered
133138
+ * @param {Core.data.Model} event.record The record for the row
133139
+ * @param {number} event.recordIndex The zero-based index of the record
133047
133140
  */
133048
- renderRow: (event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void
133141
+ renderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
133049
133142
  /**
133050
133143
  * Grid rows have been rendered
133051
133144
  * @param {object} event Event object
133052
- * @param {Grid.view.Grid} event.source This grid.
133145
+ * @param {Grid.view.GridBase} event.source This grid.
133053
133146
  */
133054
- renderRows: (event: { source: Grid }) => void
133147
+ renderRows: (event: { source: GridBase }) => void
133055
133148
  /**
133056
133149
  * Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
133057
133150
  * @param {object} event Event object
@@ -133111,10 +133204,10 @@ type GridListenersTypes = {
133111
133204
  /**
133112
133205
  * Grid has scrolled vertically
133113
133206
  * @param {object} event Event object
133114
- * @param {Grid.view.Grid} event.source The firing Grid instance.
133207
+ * @param {Grid.view.GridBase} event.source The firing Grid instance.
133115
133208
  * @param {number} event.scrollTop The vertical scroll position.
133116
133209
  */
133117
- scroll: (event: { source: Grid, scrollTop: number }) => void
133210
+ scroll: (event: { source: GridBase, scrollTop: number }) => void
133118
133211
  /**
133119
133212
  * The selection has been changed.
133120
133213
  * @param {object} event Event object
@@ -133202,17 +133295,17 @@ type GridListenersTypes = {
133202
133295
  /**
133203
133296
  * Fires after a sub grid is collapsed.
133204
133297
  * @param {object} event Event object
133205
- * @param {Grid.view.Grid} event.source The firing Grid instance
133298
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
133206
133299
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
133207
133300
  */
133208
- subGridCollapse: (event: { source: Grid, subGrid: SubGrid }) => void
133301
+ subGridCollapse: (event: { source: GridBase, subGrid: SubGrid }) => void
133209
133302
  /**
133210
133303
  * Fires after a sub grid is expanded.
133211
133304
  * @param {object} event Event object
133212
- * @param {Grid.view.Grid} event.source The firing Grid instance
133305
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
133213
133306
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
133214
133307
  */
133215
- subGridExpand: (event: { source: Grid, subGrid: SubGrid }) => void
133308
+ subGridExpand: (event: { source: GridBase, subGrid: SubGrid }) => void
133216
133309
  /**
133217
133310
  * Fired when one or more groups are expanded or collapsed
133218
133311
  * @param {object} event Event object
@@ -133305,6 +133398,14 @@ type GridListeners = {
133305
133398
  * @param {any} event.value The value being set
133306
133399
  */
133307
133400
  beforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
133401
+ /**
133402
+ * This event is triggered before a parent column is collapsed or expanded.
133403
+ * @param {object} event Event object
133404
+ * @param {Grid.view.GridBase} event.source The grid instance
133405
+ * @param {Grid.column.Column} event.column The column
133406
+ * @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
133407
+ */
133408
+ beforeColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
133308
133409
  /**
133309
133410
  * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
133310
133411
  * @param {object} event Event object
@@ -133399,24 +133500,24 @@ type GridListeners = {
133399
133500
  /**
133400
133501
  * Fires on the owning Grid before export started. Return `false` to cancel the export.
133401
133502
  * @param {object} event Event object
133402
- * @param {object} event.config Export config
133503
+ * @param {PdfExportConfig} event.config Export config
133403
133504
  */
133404
- beforePdfExport?: ((event: { config: object }) => Promise<boolean>|boolean|void)|string
133505
+ beforePdfExport?: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
133405
133506
  /**
133406
133507
  * Fires before a row is rendered.
133407
133508
  * @param {object} event Event object
133408
- * @param {Grid.view.Grid} event.source The firing Grid instance.
133409
- * @param {Grid.row.Row} event.row The row about to be rendered.
133410
- * @param {Core.data.Model} event.record The record for the row.
133411
- * @param {number} event.recordIndex The zero-based index of the record.
133509
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
133510
+ * @param {Grid.row.Row} event.row The row about to be rendered
133511
+ * @param {Core.data.Model} event.record The record for the row
133512
+ * @param {number} event.recordIndex The zero-based index of the record
133412
133513
  */
133413
- beforeRenderRow?: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
133514
+ beforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
133414
133515
  /**
133415
133516
  * Grid rows are about to be rendered
133416
133517
  * @param {object} event Event object
133417
- * @param {Grid.view.Grid} event.source This grid.
133518
+ * @param {Grid.view.GridBase} event.source This grid.
133418
133519
  */
133419
- beforeRenderRows?: ((event: { source: Grid }) => void)|string
133520
+ beforeRenderRows?: ((event: { source: GridBase }) => void)|string
133420
133521
  /**
133421
133522
  * This event fires before row collapse is started.
133422
133523
  * ...
@@ -133647,6 +133748,14 @@ type GridListeners = {
133647
133748
  * @param {Core.data.Model} event.record The record which has been collapsed.
133648
133749
  */
133649
133750
  collapseNode?: ((event: { source: Grid, record: Model }) => void)|string
133751
+ /**
133752
+ * This event is triggered after a parent column has been collapsed or expanded.
133753
+ * @param {object} event Event object
133754
+ * @param {Grid.view.GridBase} event.source The Grid instance
133755
+ * @param {Grid.column.Column} event.column The column being toggled
133756
+ * @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
133757
+ */
133758
+ columnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
133650
133759
  /**
133651
133760
  * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
133652
133761
  * to indicate whether the drop position is valid or not.
@@ -133728,14 +133837,14 @@ type GridListeners = {
133728
133837
  * ...
133729
133838
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-dataChange)
133730
133839
  * @param {object} event Event object
133731
- * @param {Grid.view.Grid} event.source Owning grid
133840
+ * @param {Grid.view.GridBase} event.source Owning grid
133732
133841
  * @param {Core.data.Store} event.store The originating store
133733
133842
  * @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
133734
133843
  * @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
133735
133844
  * @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
133736
133845
  * @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
133737
133846
  */
133738
- dataChange?: ((event: { source: Grid, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
133847
+ dataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
133739
133848
  /**
133740
133849
  * Fires when an object is destroyed.
133741
133850
  * @param {object} event Event object
@@ -134043,18 +134152,18 @@ type GridListeners = {
134043
134152
  /**
134044
134153
  * Fires after a row is rendered.
134045
134154
  * @param {object} event Event object
134046
- * @param {Grid.view.Grid} event.source The firing Grid instance.
134047
- * @param {Grid.row.Row} event.row The row that has been rendered.
134048
- * @param {Core.data.Model} event.record The record for the row.
134049
- * @param {number} event.recordIndex The zero-based index of the record.
134155
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
134156
+ * @param {Grid.row.Row} event.row The row that has been rendered
134157
+ * @param {Core.data.Model} event.record The record for the row
134158
+ * @param {number} event.recordIndex The zero-based index of the record
134050
134159
  */
134051
- renderRow?: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
134160
+ renderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
134052
134161
  /**
134053
134162
  * Grid rows have been rendered
134054
134163
  * @param {object} event Event object
134055
- * @param {Grid.view.Grid} event.source This grid.
134164
+ * @param {Grid.view.GridBase} event.source This grid.
134056
134165
  */
134057
- renderRows?: ((event: { source: Grid }) => void)|string
134166
+ renderRows?: ((event: { source: GridBase }) => void)|string
134058
134167
  /**
134059
134168
  * Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
134060
134169
  * @param {object} event Event object
@@ -134114,10 +134223,10 @@ type GridListeners = {
134114
134223
  /**
134115
134224
  * Grid has scrolled vertically
134116
134225
  * @param {object} event Event object
134117
- * @param {Grid.view.Grid} event.source The firing Grid instance.
134226
+ * @param {Grid.view.GridBase} event.source The firing Grid instance.
134118
134227
  * @param {number} event.scrollTop The vertical scroll position.
134119
134228
  */
134120
- scroll?: ((event: { source: Grid, scrollTop: number }) => void)|string
134229
+ scroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
134121
134230
  /**
134122
134231
  * The selection has been changed.
134123
134232
  * @param {object} event Event object
@@ -134205,17 +134314,17 @@ type GridListeners = {
134205
134314
  /**
134206
134315
  * Fires after a sub grid is collapsed.
134207
134316
  * @param {object} event Event object
134208
- * @param {Grid.view.Grid} event.source The firing Grid instance
134317
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
134209
134318
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
134210
134319
  */
134211
- subGridCollapse?: ((event: { source: Grid, subGrid: SubGrid }) => void)|string
134320
+ subGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
134212
134321
  /**
134213
134322
  * Fires after a sub grid is expanded.
134214
134323
  * @param {object} event Event object
134215
- * @param {Grid.view.Grid} event.source The firing Grid instance
134324
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
134216
134325
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
134217
134326
  */
134218
- subGridExpand?: ((event: { source: Grid, subGrid: SubGrid }) => void)|string
134327
+ subGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
134219
134328
  /**
134220
134329
  * Fired when one or more groups are expanded or collapsed
134221
134330
  * @param {object} event Event object
@@ -135143,6 +135252,14 @@ type GridConfig = {
135143
135252
  * @param {any} event.value The value being set
135144
135253
  */
135145
135254
  onBeforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
135255
+ /**
135256
+ * This event is triggered before a parent column is collapsed or expanded.
135257
+ * @param {object} event Event object
135258
+ * @param {Grid.view.GridBase} event.source The grid instance
135259
+ * @param {Grid.column.Column} event.column The column
135260
+ * @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
135261
+ */
135262
+ onBeforeColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
135146
135263
  /**
135147
135264
  * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
135148
135265
  * @param {object} event Event object
@@ -135237,24 +135354,24 @@ type GridConfig = {
135237
135354
  /**
135238
135355
  * Fires on the owning Grid before export started. Return `false` to cancel the export.
135239
135356
  * @param {object} event Event object
135240
- * @param {object} event.config Export config
135357
+ * @param {PdfExportConfig} event.config Export config
135241
135358
  */
135242
- onBeforePdfExport?: ((event: { config: object }) => Promise<boolean>|boolean|void)|string
135359
+ onBeforePdfExport?: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
135243
135360
  /**
135244
135361
  * Fires before a row is rendered.
135245
135362
  * @param {object} event Event object
135246
- * @param {Grid.view.Grid} event.source The firing Grid instance.
135247
- * @param {Grid.row.Row} event.row The row about to be rendered.
135248
- * @param {Core.data.Model} event.record The record for the row.
135249
- * @param {number} event.recordIndex The zero-based index of the record.
135363
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
135364
+ * @param {Grid.row.Row} event.row The row about to be rendered
135365
+ * @param {Core.data.Model} event.record The record for the row
135366
+ * @param {number} event.recordIndex The zero-based index of the record
135250
135367
  */
135251
- onBeforeRenderRow?: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
135368
+ onBeforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
135252
135369
  /**
135253
135370
  * Grid rows are about to be rendered
135254
135371
  * @param {object} event Event object
135255
- * @param {Grid.view.Grid} event.source This grid.
135372
+ * @param {Grid.view.GridBase} event.source This grid.
135256
135373
  */
135257
- onBeforeRenderRows?: ((event: { source: Grid }) => void)|string
135374
+ onBeforeRenderRows?: ((event: { source: GridBase }) => void)|string
135258
135375
  /**
135259
135376
  * This event fires before row collapse is started.
135260
135377
  * ...
@@ -135485,6 +135602,14 @@ type GridConfig = {
135485
135602
  * @param {Core.data.Model} event.record The record which has been collapsed.
135486
135603
  */
135487
135604
  onCollapseNode?: ((event: { source: Grid, record: Model }) => void)|string
135605
+ /**
135606
+ * This event is triggered after a parent column has been collapsed or expanded.
135607
+ * @param {object} event Event object
135608
+ * @param {Grid.view.GridBase} event.source The Grid instance
135609
+ * @param {Grid.column.Column} event.column The column being toggled
135610
+ * @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
135611
+ */
135612
+ onColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
135488
135613
  /**
135489
135614
  * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
135490
135615
  * to indicate whether the drop position is valid or not.
@@ -135566,14 +135691,14 @@ type GridConfig = {
135566
135691
  * ...
135567
135692
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-dataChange)
135568
135693
  * @param {object} event Event object
135569
- * @param {Grid.view.Grid} event.source Owning grid
135694
+ * @param {Grid.view.GridBase} event.source Owning grid
135570
135695
  * @param {Core.data.Store} event.store The originating store
135571
135696
  * @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
135572
135697
  * @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
135573
135698
  * @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
135574
135699
  * @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
135575
135700
  */
135576
- onDataChange?: ((event: { source: Grid, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
135701
+ onDataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
135577
135702
  /**
135578
135703
  * Fires when an object is destroyed.
135579
135704
  * @param {object} event Event object
@@ -135881,18 +136006,18 @@ type GridConfig = {
135881
136006
  /**
135882
136007
  * Fires after a row is rendered.
135883
136008
  * @param {object} event Event object
135884
- * @param {Grid.view.Grid} event.source The firing Grid instance.
135885
- * @param {Grid.row.Row} event.row The row that has been rendered.
135886
- * @param {Core.data.Model} event.record The record for the row.
135887
- * @param {number} event.recordIndex The zero-based index of the record.
136009
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
136010
+ * @param {Grid.row.Row} event.row The row that has been rendered
136011
+ * @param {Core.data.Model} event.record The record for the row
136012
+ * @param {number} event.recordIndex The zero-based index of the record
135888
136013
  */
135889
- onRenderRow?: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
136014
+ onRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
135890
136015
  /**
135891
136016
  * Grid rows have been rendered
135892
136017
  * @param {object} event Event object
135893
- * @param {Grid.view.Grid} event.source This grid.
136018
+ * @param {Grid.view.GridBase} event.source This grid.
135894
136019
  */
135895
- onRenderRows?: ((event: { source: Grid }) => void)|string
136020
+ onRenderRows?: ((event: { source: GridBase }) => void)|string
135896
136021
  /**
135897
136022
  * Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
135898
136023
  * @param {object} event Event object
@@ -135952,10 +136077,10 @@ type GridConfig = {
135952
136077
  /**
135953
136078
  * Grid has scrolled vertically
135954
136079
  * @param {object} event Event object
135955
- * @param {Grid.view.Grid} event.source The firing Grid instance.
136080
+ * @param {Grid.view.GridBase} event.source The firing Grid instance.
135956
136081
  * @param {number} event.scrollTop The vertical scroll position.
135957
136082
  */
135958
- onScroll?: ((event: { source: Grid, scrollTop: number }) => void)|string
136083
+ onScroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
135959
136084
  /**
135960
136085
  * The selection has been changed.
135961
136086
  * @param {object} event Event object
@@ -136043,17 +136168,17 @@ type GridConfig = {
136043
136168
  /**
136044
136169
  * Fires after a sub grid is collapsed.
136045
136170
  * @param {object} event Event object
136046
- * @param {Grid.view.Grid} event.source The firing Grid instance
136171
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
136047
136172
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
136048
136173
  */
136049
- onSubGridCollapse?: ((event: { source: Grid, subGrid: SubGrid }) => void)|string
136174
+ onSubGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
136050
136175
  /**
136051
136176
  * Fires after a sub grid is expanded.
136052
136177
  * @param {object} event Event object
136053
- * @param {Grid.view.Grid} event.source The firing Grid instance
136178
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
136054
136179
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
136055
136180
  */
136056
- onSubGridExpand?: ((event: { source: Grid, subGrid: SubGrid }) => void)|string
136181
+ onSubGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
136057
136182
  /**
136058
136183
  * Fired when one or more groups are expanded or collapsed
136059
136184
  * @param {object} event Event object
@@ -136365,6 +136490,14 @@ type GridBaseListenersTypes = {
136365
136490
  * @param {any} event.value The value being set
136366
136491
  */
136367
136492
  beforeCellRangeEdit: (event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void
136493
+ /**
136494
+ * This event is triggered before a parent column is collapsed or expanded.
136495
+ * @param {object} event Event object
136496
+ * @param {Grid.view.GridBase} event.source The grid instance
136497
+ * @param {Grid.column.Column} event.column The column
136498
+ * @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
136499
+ */
136500
+ beforeColumnCollapseToggle: (event: { source: GridBase, column: Column, collapsed: boolean }) => void
136368
136501
  /**
136369
136502
  * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
136370
136503
  * @param {object} event Event object
@@ -136459,24 +136592,24 @@ type GridBaseListenersTypes = {
136459
136592
  /**
136460
136593
  * Fires on the owning Grid before export started. Return `false` to cancel the export.
136461
136594
  * @param {object} event Event object
136462
- * @param {object} event.config Export config
136595
+ * @param {PdfExportConfig} event.config Export config
136463
136596
  */
136464
- beforePdfExport: (event: { config: object }) => Promise<boolean>|boolean|void
136597
+ beforePdfExport: (event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void
136465
136598
  /**
136466
136599
  * Fires before a row is rendered.
136467
136600
  * @param {object} event Event object
136468
- * @param {Grid.view.Grid} event.source The firing Grid instance.
136469
- * @param {Grid.row.Row} event.row The row about to be rendered.
136470
- * @param {Core.data.Model} event.record The record for the row.
136471
- * @param {number} event.recordIndex The zero-based index of the record.
136601
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
136602
+ * @param {Grid.row.Row} event.row The row about to be rendered
136603
+ * @param {Core.data.Model} event.record The record for the row
136604
+ * @param {number} event.recordIndex The zero-based index of the record
136472
136605
  */
136473
- beforeRenderRow: (event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void
136606
+ beforeRenderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
136474
136607
  /**
136475
136608
  * Grid rows are about to be rendered
136476
136609
  * @param {object} event Event object
136477
- * @param {Grid.view.Grid} event.source This grid.
136610
+ * @param {Grid.view.GridBase} event.source This grid.
136478
136611
  */
136479
- beforeRenderRows: (event: { source: Grid }) => void
136612
+ beforeRenderRows: (event: { source: GridBase }) => void
136480
136613
  /**
136481
136614
  * This event fires before row collapse is started.
136482
136615
  * ...
@@ -136707,6 +136840,14 @@ type GridBaseListenersTypes = {
136707
136840
  * @param {Core.data.Model} event.record The record which has been collapsed.
136708
136841
  */
136709
136842
  collapseNode: (event: { source: Grid, record: Model }) => void
136843
+ /**
136844
+ * This event is triggered after a parent column has been collapsed or expanded.
136845
+ * @param {object} event Event object
136846
+ * @param {Grid.view.GridBase} event.source The Grid instance
136847
+ * @param {Grid.column.Column} event.column The column being toggled
136848
+ * @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
136849
+ */
136850
+ columnCollapseToggle: (event: { source: GridBase, column: Column, collapsed: boolean }) => void
136710
136851
  /**
136711
136852
  * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
136712
136853
  * to indicate whether the drop position is valid or not.
@@ -136788,14 +136929,14 @@ type GridBaseListenersTypes = {
136788
136929
  * ...
136789
136930
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-dataChange)
136790
136931
  * @param {object} event Event object
136791
- * @param {Grid.view.Grid} event.source Owning grid
136932
+ * @param {Grid.view.GridBase} event.source Owning grid
136792
136933
  * @param {Core.data.Store} event.store The originating store
136793
136934
  * @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
136794
136935
  * @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
136795
136936
  * @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
136796
136937
  * @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
136797
136938
  */
136798
- dataChange: (event: { source: Grid, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void
136939
+ dataChange: (event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void
136799
136940
  /**
136800
136941
  * Fires when an object is destroyed.
136801
136942
  * @param {object} event Event object
@@ -137103,18 +137244,18 @@ type GridBaseListenersTypes = {
137103
137244
  /**
137104
137245
  * Fires after a row is rendered.
137105
137246
  * @param {object} event Event object
137106
- * @param {Grid.view.Grid} event.source The firing Grid instance.
137107
- * @param {Grid.row.Row} event.row The row that has been rendered.
137108
- * @param {Core.data.Model} event.record The record for the row.
137109
- * @param {number} event.recordIndex The zero-based index of the record.
137247
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
137248
+ * @param {Grid.row.Row} event.row The row that has been rendered
137249
+ * @param {Core.data.Model} event.record The record for the row
137250
+ * @param {number} event.recordIndex The zero-based index of the record
137110
137251
  */
137111
- renderRow: (event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void
137252
+ renderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
137112
137253
  /**
137113
137254
  * Grid rows have been rendered
137114
137255
  * @param {object} event Event object
137115
- * @param {Grid.view.Grid} event.source This grid.
137256
+ * @param {Grid.view.GridBase} event.source This grid.
137116
137257
  */
137117
- renderRows: (event: { source: Grid }) => void
137258
+ renderRows: (event: { source: GridBase }) => void
137118
137259
  /**
137119
137260
  * Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
137120
137261
  * @param {object} event Event object
@@ -137174,10 +137315,10 @@ type GridBaseListenersTypes = {
137174
137315
  /**
137175
137316
  * Grid has scrolled vertically
137176
137317
  * @param {object} event Event object
137177
- * @param {Grid.view.Grid} event.source The firing Grid instance.
137318
+ * @param {Grid.view.GridBase} event.source The firing Grid instance.
137178
137319
  * @param {number} event.scrollTop The vertical scroll position.
137179
137320
  */
137180
- scroll: (event: { source: Grid, scrollTop: number }) => void
137321
+ scroll: (event: { source: GridBase, scrollTop: number }) => void
137181
137322
  /**
137182
137323
  * The selection has been changed.
137183
137324
  * @param {object} event Event object
@@ -137265,17 +137406,17 @@ type GridBaseListenersTypes = {
137265
137406
  /**
137266
137407
  * Fires after a sub grid is collapsed.
137267
137408
  * @param {object} event Event object
137268
- * @param {Grid.view.Grid} event.source The firing Grid instance
137409
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
137269
137410
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
137270
137411
  */
137271
- subGridCollapse: (event: { source: Grid, subGrid: SubGrid }) => void
137412
+ subGridCollapse: (event: { source: GridBase, subGrid: SubGrid }) => void
137272
137413
  /**
137273
137414
  * Fires after a sub grid is expanded.
137274
137415
  * @param {object} event Event object
137275
- * @param {Grid.view.Grid} event.source The firing Grid instance
137416
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
137276
137417
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
137277
137418
  */
137278
- subGridExpand: (event: { source: Grid, subGrid: SubGrid }) => void
137419
+ subGridExpand: (event: { source: GridBase, subGrid: SubGrid }) => void
137279
137420
  /**
137280
137421
  * Fired when one or more groups are expanded or collapsed
137281
137422
  * @param {object} event Event object
@@ -137368,6 +137509,14 @@ type GridBaseListeners = {
137368
137509
  * @param {any} event.value The value being set
137369
137510
  */
137370
137511
  beforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
137512
+ /**
137513
+ * This event is triggered before a parent column is collapsed or expanded.
137514
+ * @param {object} event Event object
137515
+ * @param {Grid.view.GridBase} event.source The grid instance
137516
+ * @param {Grid.column.Column} event.column The column
137517
+ * @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
137518
+ */
137519
+ beforeColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
137371
137520
  /**
137372
137521
  * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
137373
137522
  * @param {object} event Event object
@@ -137462,24 +137611,24 @@ type GridBaseListeners = {
137462
137611
  /**
137463
137612
  * Fires on the owning Grid before export started. Return `false` to cancel the export.
137464
137613
  * @param {object} event Event object
137465
- * @param {object} event.config Export config
137614
+ * @param {PdfExportConfig} event.config Export config
137466
137615
  */
137467
- beforePdfExport?: ((event: { config: object }) => Promise<boolean>|boolean|void)|string
137616
+ beforePdfExport?: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
137468
137617
  /**
137469
137618
  * Fires before a row is rendered.
137470
137619
  * @param {object} event Event object
137471
- * @param {Grid.view.Grid} event.source The firing Grid instance.
137472
- * @param {Grid.row.Row} event.row The row about to be rendered.
137473
- * @param {Core.data.Model} event.record The record for the row.
137474
- * @param {number} event.recordIndex The zero-based index of the record.
137620
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
137621
+ * @param {Grid.row.Row} event.row The row about to be rendered
137622
+ * @param {Core.data.Model} event.record The record for the row
137623
+ * @param {number} event.recordIndex The zero-based index of the record
137475
137624
  */
137476
- beforeRenderRow?: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
137625
+ beforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
137477
137626
  /**
137478
137627
  * Grid rows are about to be rendered
137479
137628
  * @param {object} event Event object
137480
- * @param {Grid.view.Grid} event.source This grid.
137629
+ * @param {Grid.view.GridBase} event.source This grid.
137481
137630
  */
137482
- beforeRenderRows?: ((event: { source: Grid }) => void)|string
137631
+ beforeRenderRows?: ((event: { source: GridBase }) => void)|string
137483
137632
  /**
137484
137633
  * This event fires before row collapse is started.
137485
137634
  * ...
@@ -137710,6 +137859,14 @@ type GridBaseListeners = {
137710
137859
  * @param {Core.data.Model} event.record The record which has been collapsed.
137711
137860
  */
137712
137861
  collapseNode?: ((event: { source: Grid, record: Model }) => void)|string
137862
+ /**
137863
+ * This event is triggered after a parent column has been collapsed or expanded.
137864
+ * @param {object} event Event object
137865
+ * @param {Grid.view.GridBase} event.source The Grid instance
137866
+ * @param {Grid.column.Column} event.column The column being toggled
137867
+ * @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
137868
+ */
137869
+ columnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
137713
137870
  /**
137714
137871
  * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
137715
137872
  * to indicate whether the drop position is valid or not.
@@ -137791,14 +137948,14 @@ type GridBaseListeners = {
137791
137948
  * ...
137792
137949
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-dataChange)
137793
137950
  * @param {object} event Event object
137794
- * @param {Grid.view.Grid} event.source Owning grid
137951
+ * @param {Grid.view.GridBase} event.source Owning grid
137795
137952
  * @param {Core.data.Store} event.store The originating store
137796
137953
  * @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
137797
137954
  * @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
137798
137955
  * @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
137799
137956
  * @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
137800
137957
  */
137801
- dataChange?: ((event: { source: Grid, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
137958
+ dataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
137802
137959
  /**
137803
137960
  * Fires when an object is destroyed.
137804
137961
  * @param {object} event Event object
@@ -138106,18 +138263,18 @@ type GridBaseListeners = {
138106
138263
  /**
138107
138264
  * Fires after a row is rendered.
138108
138265
  * @param {object} event Event object
138109
- * @param {Grid.view.Grid} event.source The firing Grid instance.
138110
- * @param {Grid.row.Row} event.row The row that has been rendered.
138111
- * @param {Core.data.Model} event.record The record for the row.
138112
- * @param {number} event.recordIndex The zero-based index of the record.
138266
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
138267
+ * @param {Grid.row.Row} event.row The row that has been rendered
138268
+ * @param {Core.data.Model} event.record The record for the row
138269
+ * @param {number} event.recordIndex The zero-based index of the record
138113
138270
  */
138114
- renderRow?: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
138271
+ renderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
138115
138272
  /**
138116
138273
  * Grid rows have been rendered
138117
138274
  * @param {object} event Event object
138118
- * @param {Grid.view.Grid} event.source This grid.
138275
+ * @param {Grid.view.GridBase} event.source This grid.
138119
138276
  */
138120
- renderRows?: ((event: { source: Grid }) => void)|string
138277
+ renderRows?: ((event: { source: GridBase }) => void)|string
138121
138278
  /**
138122
138279
  * Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
138123
138280
  * @param {object} event Event object
@@ -138177,10 +138334,10 @@ type GridBaseListeners = {
138177
138334
  /**
138178
138335
  * Grid has scrolled vertically
138179
138336
  * @param {object} event Event object
138180
- * @param {Grid.view.Grid} event.source The firing Grid instance.
138337
+ * @param {Grid.view.GridBase} event.source The firing Grid instance.
138181
138338
  * @param {number} event.scrollTop The vertical scroll position.
138182
138339
  */
138183
- scroll?: ((event: { source: Grid, scrollTop: number }) => void)|string
138340
+ scroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
138184
138341
  /**
138185
138342
  * The selection has been changed.
138186
138343
  * @param {object} event Event object
@@ -138268,17 +138425,17 @@ type GridBaseListeners = {
138268
138425
  /**
138269
138426
  * Fires after a sub grid is collapsed.
138270
138427
  * @param {object} event Event object
138271
- * @param {Grid.view.Grid} event.source The firing Grid instance
138428
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
138272
138429
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
138273
138430
  */
138274
- subGridCollapse?: ((event: { source: Grid, subGrid: SubGrid }) => void)|string
138431
+ subGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
138275
138432
  /**
138276
138433
  * Fires after a sub grid is expanded.
138277
138434
  * @param {object} event Event object
138278
- * @param {Grid.view.Grid} event.source The firing Grid instance
138435
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
138279
138436
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
138280
138437
  */
138281
- subGridExpand?: ((event: { source: Grid, subGrid: SubGrid }) => void)|string
138438
+ subGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
138282
138439
  /**
138283
138440
  * Fired when one or more groups are expanded or collapsed
138284
138441
  * @param {object} event Event object
@@ -139205,6 +139362,14 @@ type GridBaseConfig = {
139205
139362
  * @param {any} event.value The value being set
139206
139363
  */
139207
139364
  onBeforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
139365
+ /**
139366
+ * This event is triggered before a parent column is collapsed or expanded.
139367
+ * @param {object} event Event object
139368
+ * @param {Grid.view.GridBase} event.source The grid instance
139369
+ * @param {Grid.column.Column} event.column The column
139370
+ * @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
139371
+ */
139372
+ onBeforeColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
139208
139373
  /**
139209
139374
  * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
139210
139375
  * @param {object} event Event object
@@ -139299,24 +139464,24 @@ type GridBaseConfig = {
139299
139464
  /**
139300
139465
  * Fires on the owning Grid before export started. Return `false` to cancel the export.
139301
139466
  * @param {object} event Event object
139302
- * @param {object} event.config Export config
139467
+ * @param {PdfExportConfig} event.config Export config
139303
139468
  */
139304
- onBeforePdfExport?: ((event: { config: object }) => Promise<boolean>|boolean|void)|string
139469
+ onBeforePdfExport?: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
139305
139470
  /**
139306
139471
  * Fires before a row is rendered.
139307
139472
  * @param {object} event Event object
139308
- * @param {Grid.view.Grid} event.source The firing Grid instance.
139309
- * @param {Grid.row.Row} event.row The row about to be rendered.
139310
- * @param {Core.data.Model} event.record The record for the row.
139311
- * @param {number} event.recordIndex The zero-based index of the record.
139473
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
139474
+ * @param {Grid.row.Row} event.row The row about to be rendered
139475
+ * @param {Core.data.Model} event.record The record for the row
139476
+ * @param {number} event.recordIndex The zero-based index of the record
139312
139477
  */
139313
- onBeforeRenderRow?: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
139478
+ onBeforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
139314
139479
  /**
139315
139480
  * Grid rows are about to be rendered
139316
139481
  * @param {object} event Event object
139317
- * @param {Grid.view.Grid} event.source This grid.
139482
+ * @param {Grid.view.GridBase} event.source This grid.
139318
139483
  */
139319
- onBeforeRenderRows?: ((event: { source: Grid }) => void)|string
139484
+ onBeforeRenderRows?: ((event: { source: GridBase }) => void)|string
139320
139485
  /**
139321
139486
  * This event fires before row collapse is started.
139322
139487
  * ...
@@ -139547,6 +139712,14 @@ type GridBaseConfig = {
139547
139712
  * @param {Core.data.Model} event.record The record which has been collapsed.
139548
139713
  */
139549
139714
  onCollapseNode?: ((event: { source: Grid, record: Model }) => void)|string
139715
+ /**
139716
+ * This event is triggered after a parent column has been collapsed or expanded.
139717
+ * @param {object} event Event object
139718
+ * @param {Grid.view.GridBase} event.source The Grid instance
139719
+ * @param {Grid.column.Column} event.column The column being toggled
139720
+ * @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
139721
+ */
139722
+ onColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
139550
139723
  /**
139551
139724
  * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
139552
139725
  * to indicate whether the drop position is valid or not.
@@ -139628,14 +139801,14 @@ type GridBaseConfig = {
139628
139801
  * ...
139629
139802
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-dataChange)
139630
139803
  * @param {object} event Event object
139631
- * @param {Grid.view.Grid} event.source Owning grid
139804
+ * @param {Grid.view.GridBase} event.source Owning grid
139632
139805
  * @param {Core.data.Store} event.store The originating store
139633
139806
  * @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
139634
139807
  * @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
139635
139808
  * @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
139636
139809
  * @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
139637
139810
  */
139638
- onDataChange?: ((event: { source: Grid, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
139811
+ onDataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
139639
139812
  /**
139640
139813
  * Fires when an object is destroyed.
139641
139814
  * @param {object} event Event object
@@ -139943,18 +140116,18 @@ type GridBaseConfig = {
139943
140116
  /**
139944
140117
  * Fires after a row is rendered.
139945
140118
  * @param {object} event Event object
139946
- * @param {Grid.view.Grid} event.source The firing Grid instance.
139947
- * @param {Grid.row.Row} event.row The row that has been rendered.
139948
- * @param {Core.data.Model} event.record The record for the row.
139949
- * @param {number} event.recordIndex The zero-based index of the record.
140119
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
140120
+ * @param {Grid.row.Row} event.row The row that has been rendered
140121
+ * @param {Core.data.Model} event.record The record for the row
140122
+ * @param {number} event.recordIndex The zero-based index of the record
139950
140123
  */
139951
- onRenderRow?: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
140124
+ onRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
139952
140125
  /**
139953
140126
  * Grid rows have been rendered
139954
140127
  * @param {object} event Event object
139955
- * @param {Grid.view.Grid} event.source This grid.
140128
+ * @param {Grid.view.GridBase} event.source This grid.
139956
140129
  */
139957
- onRenderRows?: ((event: { source: Grid }) => void)|string
140130
+ onRenderRows?: ((event: { source: GridBase }) => void)|string
139958
140131
  /**
139959
140132
  * Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
139960
140133
  * @param {object} event Event object
@@ -140014,10 +140187,10 @@ type GridBaseConfig = {
140014
140187
  /**
140015
140188
  * Grid has scrolled vertically
140016
140189
  * @param {object} event Event object
140017
- * @param {Grid.view.Grid} event.source The firing Grid instance.
140190
+ * @param {Grid.view.GridBase} event.source The firing Grid instance.
140018
140191
  * @param {number} event.scrollTop The vertical scroll position.
140019
140192
  */
140020
- onScroll?: ((event: { source: Grid, scrollTop: number }) => void)|string
140193
+ onScroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
140021
140194
  /**
140022
140195
  * The selection has been changed.
140023
140196
  * @param {object} event Event object
@@ -140105,17 +140278,17 @@ type GridBaseConfig = {
140105
140278
  /**
140106
140279
  * Fires after a sub grid is collapsed.
140107
140280
  * @param {object} event Event object
140108
- * @param {Grid.view.Grid} event.source The firing Grid instance
140281
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
140109
140282
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
140110
140283
  */
140111
- onSubGridCollapse?: ((event: { source: Grid, subGrid: SubGrid }) => void)|string
140284
+ onSubGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
140112
140285
  /**
140113
140286
  * Fires after a sub grid is expanded.
140114
140287
  * @param {object} event Event object
140115
- * @param {Grid.view.Grid} event.source The firing Grid instance
140288
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
140116
140289
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
140117
140290
  */
140118
- onSubGridExpand?: ((event: { source: Grid, subGrid: SubGrid }) => void)|string
140291
+ onSubGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
140119
140292
  /**
140120
140293
  * Fired when one or more groups are expanded or collapsed
140121
140294
  * @param {object} event Event object
@@ -140537,6 +140710,14 @@ export class GridBase extends Panel {
140537
140710
  * @param {any} event.value The value being set
140538
140711
  */
140539
140712
  onBeforeCellRangeEdit: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
140713
+ /**
140714
+ * This event is triggered before a parent column is collapsed or expanded.
140715
+ * @param {object} event Event object
140716
+ * @param {Grid.view.GridBase} event.source The grid instance
140717
+ * @param {Grid.column.Column} event.column The column
140718
+ * @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
140719
+ */
140720
+ onBeforeColumnCollapseToggle: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
140540
140721
  /**
140541
140722
  * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
140542
140723
  * @param {object} event Event object
@@ -140625,24 +140806,24 @@ export class GridBase extends Panel {
140625
140806
  /**
140626
140807
  * Fires on the owning Grid before export started. Return `false` to cancel the export.
140627
140808
  * @param {object} event Event object
140628
- * @param {object} event.config Export config
140809
+ * @param {PdfExportConfig} event.config Export config
140629
140810
  */
140630
- onBeforePdfExport: ((event: { config: object }) => Promise<boolean>|boolean|void)|string
140811
+ onBeforePdfExport: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
140631
140812
  /**
140632
140813
  * Fires before a row is rendered.
140633
140814
  * @param {object} event Event object
140634
- * @param {Grid.view.Grid} event.source The firing Grid instance.
140635
- * @param {Grid.row.Row} event.row The row about to be rendered.
140636
- * @param {Core.data.Model} event.record The record for the row.
140637
- * @param {number} event.recordIndex The zero-based index of the record.
140815
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
140816
+ * @param {Grid.row.Row} event.row The row about to be rendered
140817
+ * @param {Core.data.Model} event.record The record for the row
140818
+ * @param {number} event.recordIndex The zero-based index of the record
140638
140819
  */
140639
- onBeforeRenderRow: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
140820
+ onBeforeRenderRow: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
140640
140821
  /**
140641
140822
  * Grid rows are about to be rendered
140642
140823
  * @param {object} event Event object
140643
- * @param {Grid.view.Grid} event.source This grid.
140824
+ * @param {Grid.view.GridBase} event.source This grid.
140644
140825
  */
140645
- onBeforeRenderRows: ((event: { source: Grid }) => void)|string
140826
+ onBeforeRenderRows: ((event: { source: GridBase }) => void)|string
140646
140827
  /**
140647
140828
  * This event fires before row collapse is started.
140648
140829
  * ...
@@ -140853,6 +141034,14 @@ export class GridBase extends Panel {
140853
141034
  * @param {Core.data.Model} event.record The record which has been collapsed.
140854
141035
  */
140855
141036
  onCollapseNode: ((event: { source: Grid, record: Model }) => void)|string
141037
+ /**
141038
+ * This event is triggered after a parent column has been collapsed or expanded.
141039
+ * @param {object} event Event object
141040
+ * @param {Grid.view.GridBase} event.source The Grid instance
141041
+ * @param {Grid.column.Column} event.column The column being toggled
141042
+ * @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
141043
+ */
141044
+ onColumnCollapseToggle: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
140856
141045
  /**
140857
141046
  * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
140858
141047
  * to indicate whether the drop position is valid or not.
@@ -140917,14 +141106,14 @@ export class GridBase extends Panel {
140917
141106
  * ...
140918
141107
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-dataChange)
140919
141108
  * @param {object} event Event object
140920
- * @param {Grid.view.Grid} event.source Owning grid
141109
+ * @param {Grid.view.GridBase} event.source Owning grid
140921
141110
  * @param {Core.data.Store} event.store The originating store
140922
141111
  * @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
140923
141112
  * @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
140924
141113
  * @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
140925
141114
  * @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
140926
141115
  */
140927
- onDataChange: ((event: { source: Grid, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
141116
+ onDataChange: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
140928
141117
  /**
140929
141118
  * Fires when an object is destroyed.
140930
141119
  * @param {object} event Event object
@@ -141162,18 +141351,18 @@ export class GridBase extends Panel {
141162
141351
  /**
141163
141352
  * Fires after a row is rendered.
141164
141353
  * @param {object} event Event object
141165
- * @param {Grid.view.Grid} event.source The firing Grid instance.
141166
- * @param {Grid.row.Row} event.row The row that has been rendered.
141167
- * @param {Core.data.Model} event.record The record for the row.
141168
- * @param {number} event.recordIndex The zero-based index of the record.
141354
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
141355
+ * @param {Grid.row.Row} event.row The row that has been rendered
141356
+ * @param {Core.data.Model} event.record The record for the row
141357
+ * @param {number} event.recordIndex The zero-based index of the record
141169
141358
  */
141170
- onRenderRow: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
141359
+ onRenderRow: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
141171
141360
  /**
141172
141361
  * Grid rows have been rendered
141173
141362
  * @param {object} event Event object
141174
- * @param {Grid.view.Grid} event.source This grid.
141363
+ * @param {Grid.view.GridBase} event.source This grid.
141175
141364
  */
141176
- onRenderRows: ((event: { source: Grid }) => void)|string
141365
+ onRenderRows: ((event: { source: GridBase }) => void)|string
141177
141366
  /**
141178
141367
  * Grid resize lead to a new responsive level being applied
141179
141368
  * @param {object} event Event object
@@ -141223,10 +141412,10 @@ export class GridBase extends Panel {
141223
141412
  /**
141224
141413
  * Grid has scrolled vertically
141225
141414
  * @param {object} event Event object
141226
- * @param {Grid.view.Grid} event.source The firing Grid instance.
141415
+ * @param {Grid.view.GridBase} event.source The firing Grid instance.
141227
141416
  * @param {number} event.scrollTop The vertical scroll position.
141228
141417
  */
141229
- onScroll: ((event: { source: Grid, scrollTop: number }) => void)|string
141418
+ onScroll: ((event: { source: GridBase, scrollTop: number }) => void)|string
141230
141419
  /**
141231
141420
  * The selection has been changed.
141232
141421
  * @param {object} event Event object
@@ -141308,17 +141497,17 @@ export class GridBase extends Panel {
141308
141497
  /**
141309
141498
  * Fires after a sub grid is collapsed.
141310
141499
  * @param {object} event Event object
141311
- * @param {Grid.view.Grid} event.source The firing Grid instance
141500
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
141312
141501
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
141313
141502
  */
141314
- onSubGridCollapse: ((event: { source: Grid, subGrid: SubGrid }) => void)|string
141503
+ onSubGridCollapse: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
141315
141504
  /**
141316
141505
  * Fires after a sub grid is expanded.
141317
141506
  * @param {object} event Event object
141318
- * @param {Grid.view.Grid} event.source The firing Grid instance
141507
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
141319
141508
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
141320
141509
  */
141321
- onSubGridExpand: ((event: { source: Grid, subGrid: SubGrid }) => void)|string
141510
+ onSubGridExpand: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
141322
141511
  /**
141323
141512
  * Fired when one or more groups are expanded or collapsed
141324
141513
  * @param {object} event Event object
@@ -141630,9 +141819,9 @@ export class GridBase extends Panel {
141630
141819
  /**
141631
141820
  * Starts the print process. Accepts a config object which overrides any default configs.
141632
141821
  * <strong>NOTE</strong> Component should not be interacted with when print is in progress
141633
- * @param {object} config
141822
+ * @param {PrintConfig} config
141634
141823
  */
141635
- print(config: object): Promise<any>;
141824
+ print(config: PrintConfig): Promise<any>;
141636
141825
  /**
141637
141826
  * Triggers a render of all the cells in a column.
141638
141827
  * @param {Grid.column.Column,Grid.column.Column[]} column
@@ -142840,6 +143029,14 @@ type TreeGridListenersTypes = {
142840
143029
  * @param {any} event.value The value being set
142841
143030
  */
142842
143031
  beforeCellRangeEdit: (event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void
143032
+ /**
143033
+ * This event is triggered before a parent column is collapsed or expanded.
143034
+ * @param {object} event Event object
143035
+ * @param {Grid.view.GridBase} event.source The grid instance
143036
+ * @param {Grid.column.Column} event.column The column
143037
+ * @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
143038
+ */
143039
+ beforeColumnCollapseToggle: (event: { source: GridBase, column: Column, collapsed: boolean }) => void
142843
143040
  /**
142844
143041
  * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
142845
143042
  * @param {object} event Event object
@@ -142934,24 +143131,24 @@ type TreeGridListenersTypes = {
142934
143131
  /**
142935
143132
  * Fires on the owning Grid before export started. Return `false` to cancel the export.
142936
143133
  * @param {object} event Event object
142937
- * @param {object} event.config Export config
143134
+ * @param {PdfExportConfig} event.config Export config
142938
143135
  */
142939
- beforePdfExport: (event: { config: object }) => Promise<boolean>|boolean|void
143136
+ beforePdfExport: (event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void
142940
143137
  /**
142941
143138
  * Fires before a row is rendered.
142942
143139
  * @param {object} event Event object
142943
- * @param {Grid.view.Grid} event.source The firing Grid instance.
142944
- * @param {Grid.row.Row} event.row The row about to be rendered.
142945
- * @param {Core.data.Model} event.record The record for the row.
142946
- * @param {number} event.recordIndex The zero-based index of the record.
143140
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
143141
+ * @param {Grid.row.Row} event.row The row about to be rendered
143142
+ * @param {Core.data.Model} event.record The record for the row
143143
+ * @param {number} event.recordIndex The zero-based index of the record
142947
143144
  */
142948
- beforeRenderRow: (event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void
143145
+ beforeRenderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
142949
143146
  /**
142950
143147
  * Grid rows are about to be rendered
142951
143148
  * @param {object} event Event object
142952
- * @param {Grid.view.Grid} event.source This grid.
143149
+ * @param {Grid.view.GridBase} event.source This grid.
142953
143150
  */
142954
- beforeRenderRows: (event: { source: Grid }) => void
143151
+ beforeRenderRows: (event: { source: GridBase }) => void
142955
143152
  /**
142956
143153
  * This event fires before row collapse is started.
142957
143154
  * ...
@@ -143182,6 +143379,14 @@ type TreeGridListenersTypes = {
143182
143379
  * @param {Core.data.Model} event.record The record which has been collapsed.
143183
143380
  */
143184
143381
  collapseNode: (event: { source: Grid, record: Model }) => void
143382
+ /**
143383
+ * This event is triggered after a parent column has been collapsed or expanded.
143384
+ * @param {object} event Event object
143385
+ * @param {Grid.view.GridBase} event.source The Grid instance
143386
+ * @param {Grid.column.Column} event.column The column being toggled
143387
+ * @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
143388
+ */
143389
+ columnCollapseToggle: (event: { source: GridBase, column: Column, collapsed: boolean }) => void
143185
143390
  /**
143186
143391
  * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
143187
143392
  * to indicate whether the drop position is valid or not.
@@ -143263,14 +143468,14 @@ type TreeGridListenersTypes = {
143263
143468
  * ...
143264
143469
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-dataChange)
143265
143470
  * @param {object} event Event object
143266
- * @param {Grid.view.Grid} event.source Owning grid
143471
+ * @param {Grid.view.GridBase} event.source Owning grid
143267
143472
  * @param {Core.data.Store} event.store The originating store
143268
143473
  * @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
143269
143474
  * @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
143270
143475
  * @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
143271
143476
  * @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
143272
143477
  */
143273
- dataChange: (event: { source: Grid, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void
143478
+ dataChange: (event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void
143274
143479
  /**
143275
143480
  * Fires when an object is destroyed.
143276
143481
  * @param {object} event Event object
@@ -143578,18 +143783,18 @@ type TreeGridListenersTypes = {
143578
143783
  /**
143579
143784
  * Fires after a row is rendered.
143580
143785
  * @param {object} event Event object
143581
- * @param {Grid.view.Grid} event.source The firing Grid instance.
143582
- * @param {Grid.row.Row} event.row The row that has been rendered.
143583
- * @param {Core.data.Model} event.record The record for the row.
143584
- * @param {number} event.recordIndex The zero-based index of the record.
143786
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
143787
+ * @param {Grid.row.Row} event.row The row that has been rendered
143788
+ * @param {Core.data.Model} event.record The record for the row
143789
+ * @param {number} event.recordIndex The zero-based index of the record
143585
143790
  */
143586
- renderRow: (event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void
143791
+ renderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
143587
143792
  /**
143588
143793
  * Grid rows have been rendered
143589
143794
  * @param {object} event Event object
143590
- * @param {Grid.view.Grid} event.source This grid.
143795
+ * @param {Grid.view.GridBase} event.source This grid.
143591
143796
  */
143592
- renderRows: (event: { source: Grid }) => void
143797
+ renderRows: (event: { source: GridBase }) => void
143593
143798
  /**
143594
143799
  * Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
143595
143800
  * @param {object} event Event object
@@ -143649,10 +143854,10 @@ type TreeGridListenersTypes = {
143649
143854
  /**
143650
143855
  * Grid has scrolled vertically
143651
143856
  * @param {object} event Event object
143652
- * @param {Grid.view.Grid} event.source The firing Grid instance.
143857
+ * @param {Grid.view.GridBase} event.source The firing Grid instance.
143653
143858
  * @param {number} event.scrollTop The vertical scroll position.
143654
143859
  */
143655
- scroll: (event: { source: Grid, scrollTop: number }) => void
143860
+ scroll: (event: { source: GridBase, scrollTop: number }) => void
143656
143861
  /**
143657
143862
  * The selection has been changed.
143658
143863
  * @param {object} event Event object
@@ -143740,17 +143945,17 @@ type TreeGridListenersTypes = {
143740
143945
  /**
143741
143946
  * Fires after a sub grid is collapsed.
143742
143947
  * @param {object} event Event object
143743
- * @param {Grid.view.Grid} event.source The firing Grid instance
143948
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
143744
143949
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
143745
143950
  */
143746
- subGridCollapse: (event: { source: Grid, subGrid: SubGrid }) => void
143951
+ subGridCollapse: (event: { source: GridBase, subGrid: SubGrid }) => void
143747
143952
  /**
143748
143953
  * Fires after a sub grid is expanded.
143749
143954
  * @param {object} event Event object
143750
- * @param {Grid.view.Grid} event.source The firing Grid instance
143955
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
143751
143956
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
143752
143957
  */
143753
- subGridExpand: (event: { source: Grid, subGrid: SubGrid }) => void
143958
+ subGridExpand: (event: { source: GridBase, subGrid: SubGrid }) => void
143754
143959
  /**
143755
143960
  * Fired when one or more groups are expanded or collapsed
143756
143961
  * @param {object} event Event object
@@ -143843,6 +144048,14 @@ type TreeGridListeners = {
143843
144048
  * @param {any} event.value The value being set
143844
144049
  */
143845
144050
  beforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
144051
+ /**
144052
+ * This event is triggered before a parent column is collapsed or expanded.
144053
+ * @param {object} event Event object
144054
+ * @param {Grid.view.GridBase} event.source The grid instance
144055
+ * @param {Grid.column.Column} event.column The column
144056
+ * @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
144057
+ */
144058
+ beforeColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
143846
144059
  /**
143847
144060
  * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
143848
144061
  * @param {object} event Event object
@@ -143937,24 +144150,24 @@ type TreeGridListeners = {
143937
144150
  /**
143938
144151
  * Fires on the owning Grid before export started. Return `false` to cancel the export.
143939
144152
  * @param {object} event Event object
143940
- * @param {object} event.config Export config
144153
+ * @param {PdfExportConfig} event.config Export config
143941
144154
  */
143942
- beforePdfExport?: ((event: { config: object }) => Promise<boolean>|boolean|void)|string
144155
+ beforePdfExport?: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
143943
144156
  /**
143944
144157
  * Fires before a row is rendered.
143945
144158
  * @param {object} event Event object
143946
- * @param {Grid.view.Grid} event.source The firing Grid instance.
143947
- * @param {Grid.row.Row} event.row The row about to be rendered.
143948
- * @param {Core.data.Model} event.record The record for the row.
143949
- * @param {number} event.recordIndex The zero-based index of the record.
144159
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
144160
+ * @param {Grid.row.Row} event.row The row about to be rendered
144161
+ * @param {Core.data.Model} event.record The record for the row
144162
+ * @param {number} event.recordIndex The zero-based index of the record
143950
144163
  */
143951
- beforeRenderRow?: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
144164
+ beforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
143952
144165
  /**
143953
144166
  * Grid rows are about to be rendered
143954
144167
  * @param {object} event Event object
143955
- * @param {Grid.view.Grid} event.source This grid.
144168
+ * @param {Grid.view.GridBase} event.source This grid.
143956
144169
  */
143957
- beforeRenderRows?: ((event: { source: Grid }) => void)|string
144170
+ beforeRenderRows?: ((event: { source: GridBase }) => void)|string
143958
144171
  /**
143959
144172
  * This event fires before row collapse is started.
143960
144173
  * ...
@@ -144185,6 +144398,14 @@ type TreeGridListeners = {
144185
144398
  * @param {Core.data.Model} event.record The record which has been collapsed.
144186
144399
  */
144187
144400
  collapseNode?: ((event: { source: Grid, record: Model }) => void)|string
144401
+ /**
144402
+ * This event is triggered after a parent column has been collapsed or expanded.
144403
+ * @param {object} event Event object
144404
+ * @param {Grid.view.GridBase} event.source The Grid instance
144405
+ * @param {Grid.column.Column} event.column The column being toggled
144406
+ * @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
144407
+ */
144408
+ columnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
144188
144409
  /**
144189
144410
  * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
144190
144411
  * to indicate whether the drop position is valid or not.
@@ -144266,14 +144487,14 @@ type TreeGridListeners = {
144266
144487
  * ...
144267
144488
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-dataChange)
144268
144489
  * @param {object} event Event object
144269
- * @param {Grid.view.Grid} event.source Owning grid
144490
+ * @param {Grid.view.GridBase} event.source Owning grid
144270
144491
  * @param {Core.data.Store} event.store The originating store
144271
144492
  * @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
144272
144493
  * @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
144273
144494
  * @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
144274
144495
  * @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
144275
144496
  */
144276
- dataChange?: ((event: { source: Grid, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
144497
+ dataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
144277
144498
  /**
144278
144499
  * Fires when an object is destroyed.
144279
144500
  * @param {object} event Event object
@@ -144581,18 +144802,18 @@ type TreeGridListeners = {
144581
144802
  /**
144582
144803
  * Fires after a row is rendered.
144583
144804
  * @param {object} event Event object
144584
- * @param {Grid.view.Grid} event.source The firing Grid instance.
144585
- * @param {Grid.row.Row} event.row The row that has been rendered.
144586
- * @param {Core.data.Model} event.record The record for the row.
144587
- * @param {number} event.recordIndex The zero-based index of the record.
144805
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
144806
+ * @param {Grid.row.Row} event.row The row that has been rendered
144807
+ * @param {Core.data.Model} event.record The record for the row
144808
+ * @param {number} event.recordIndex The zero-based index of the record
144588
144809
  */
144589
- renderRow?: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
144810
+ renderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
144590
144811
  /**
144591
144812
  * Grid rows have been rendered
144592
144813
  * @param {object} event Event object
144593
- * @param {Grid.view.Grid} event.source This grid.
144814
+ * @param {Grid.view.GridBase} event.source This grid.
144594
144815
  */
144595
- renderRows?: ((event: { source: Grid }) => void)|string
144816
+ renderRows?: ((event: { source: GridBase }) => void)|string
144596
144817
  /**
144597
144818
  * Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
144598
144819
  * @param {object} event Event object
@@ -144652,10 +144873,10 @@ type TreeGridListeners = {
144652
144873
  /**
144653
144874
  * Grid has scrolled vertically
144654
144875
  * @param {object} event Event object
144655
- * @param {Grid.view.Grid} event.source The firing Grid instance.
144876
+ * @param {Grid.view.GridBase} event.source The firing Grid instance.
144656
144877
  * @param {number} event.scrollTop The vertical scroll position.
144657
144878
  */
144658
- scroll?: ((event: { source: Grid, scrollTop: number }) => void)|string
144879
+ scroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
144659
144880
  /**
144660
144881
  * The selection has been changed.
144661
144882
  * @param {object} event Event object
@@ -144743,17 +144964,17 @@ type TreeGridListeners = {
144743
144964
  /**
144744
144965
  * Fires after a sub grid is collapsed.
144745
144966
  * @param {object} event Event object
144746
- * @param {Grid.view.Grid} event.source The firing Grid instance
144967
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
144747
144968
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
144748
144969
  */
144749
- subGridCollapse?: ((event: { source: Grid, subGrid: SubGrid }) => void)|string
144970
+ subGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
144750
144971
  /**
144751
144972
  * Fires after a sub grid is expanded.
144752
144973
  * @param {object} event Event object
144753
- * @param {Grid.view.Grid} event.source The firing Grid instance
144974
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
144754
144975
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
144755
144976
  */
144756
- subGridExpand?: ((event: { source: Grid, subGrid: SubGrid }) => void)|string
144977
+ subGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
144757
144978
  /**
144758
144979
  * Fired when one or more groups are expanded or collapsed
144759
144980
  * @param {object} event Event object
@@ -145681,6 +145902,14 @@ type TreeGridConfig = {
145681
145902
  * @param {any} event.value The value being set
145682
145903
  */
145683
145904
  onBeforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
145905
+ /**
145906
+ * This event is triggered before a parent column is collapsed or expanded.
145907
+ * @param {object} event Event object
145908
+ * @param {Grid.view.GridBase} event.source The grid instance
145909
+ * @param {Grid.column.Column} event.column The column
145910
+ * @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
145911
+ */
145912
+ onBeforeColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
145684
145913
  /**
145685
145914
  * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
145686
145915
  * @param {object} event Event object
@@ -145775,24 +146004,24 @@ type TreeGridConfig = {
145775
146004
  /**
145776
146005
  * Fires on the owning Grid before export started. Return `false` to cancel the export.
145777
146006
  * @param {object} event Event object
145778
- * @param {object} event.config Export config
146007
+ * @param {PdfExportConfig} event.config Export config
145779
146008
  */
145780
- onBeforePdfExport?: ((event: { config: object }) => Promise<boolean>|boolean|void)|string
146009
+ onBeforePdfExport?: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
145781
146010
  /**
145782
146011
  * Fires before a row is rendered.
145783
146012
  * @param {object} event Event object
145784
- * @param {Grid.view.Grid} event.source The firing Grid instance.
145785
- * @param {Grid.row.Row} event.row The row about to be rendered.
145786
- * @param {Core.data.Model} event.record The record for the row.
145787
- * @param {number} event.recordIndex The zero-based index of the record.
146013
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
146014
+ * @param {Grid.row.Row} event.row The row about to be rendered
146015
+ * @param {Core.data.Model} event.record The record for the row
146016
+ * @param {number} event.recordIndex The zero-based index of the record
145788
146017
  */
145789
- onBeforeRenderRow?: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
146018
+ onBeforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
145790
146019
  /**
145791
146020
  * Grid rows are about to be rendered
145792
146021
  * @param {object} event Event object
145793
- * @param {Grid.view.Grid} event.source This grid.
146022
+ * @param {Grid.view.GridBase} event.source This grid.
145794
146023
  */
145795
- onBeforeRenderRows?: ((event: { source: Grid }) => void)|string
146024
+ onBeforeRenderRows?: ((event: { source: GridBase }) => void)|string
145796
146025
  /**
145797
146026
  * This event fires before row collapse is started.
145798
146027
  * ...
@@ -146023,6 +146252,14 @@ type TreeGridConfig = {
146023
146252
  * @param {Core.data.Model} event.record The record which has been collapsed.
146024
146253
  */
146025
146254
  onCollapseNode?: ((event: { source: Grid, record: Model }) => void)|string
146255
+ /**
146256
+ * This event is triggered after a parent column has been collapsed or expanded.
146257
+ * @param {object} event Event object
146258
+ * @param {Grid.view.GridBase} event.source The Grid instance
146259
+ * @param {Grid.column.Column} event.column The column being toggled
146260
+ * @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
146261
+ */
146262
+ onColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
146026
146263
  /**
146027
146264
  * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
146028
146265
  * to indicate whether the drop position is valid or not.
@@ -146104,14 +146341,14 @@ type TreeGridConfig = {
146104
146341
  * ...
146105
146342
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-dataChange)
146106
146343
  * @param {object} event Event object
146107
- * @param {Grid.view.Grid} event.source Owning grid
146344
+ * @param {Grid.view.GridBase} event.source Owning grid
146108
146345
  * @param {Core.data.Store} event.store The originating store
146109
146346
  * @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
146110
146347
  * @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
146111
146348
  * @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
146112
146349
  * @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
146113
146350
  */
146114
- onDataChange?: ((event: { source: Grid, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
146351
+ onDataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
146115
146352
  /**
146116
146353
  * Fires when an object is destroyed.
146117
146354
  * @param {object} event Event object
@@ -146419,18 +146656,18 @@ type TreeGridConfig = {
146419
146656
  /**
146420
146657
  * Fires after a row is rendered.
146421
146658
  * @param {object} event Event object
146422
- * @param {Grid.view.Grid} event.source The firing Grid instance.
146423
- * @param {Grid.row.Row} event.row The row that has been rendered.
146424
- * @param {Core.data.Model} event.record The record for the row.
146425
- * @param {number} event.recordIndex The zero-based index of the record.
146659
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
146660
+ * @param {Grid.row.Row} event.row The row that has been rendered
146661
+ * @param {Core.data.Model} event.record The record for the row
146662
+ * @param {number} event.recordIndex The zero-based index of the record
146426
146663
  */
146427
- onRenderRow?: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
146664
+ onRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
146428
146665
  /**
146429
146666
  * Grid rows have been rendered
146430
146667
  * @param {object} event Event object
146431
- * @param {Grid.view.Grid} event.source This grid.
146668
+ * @param {Grid.view.GridBase} event.source This grid.
146432
146669
  */
146433
- onRenderRows?: ((event: { source: Grid }) => void)|string
146670
+ onRenderRows?: ((event: { source: GridBase }) => void)|string
146434
146671
  /**
146435
146672
  * Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
146436
146673
  * @param {object} event Event object
@@ -146490,10 +146727,10 @@ type TreeGridConfig = {
146490
146727
  /**
146491
146728
  * Grid has scrolled vertically
146492
146729
  * @param {object} event Event object
146493
- * @param {Grid.view.Grid} event.source The firing Grid instance.
146730
+ * @param {Grid.view.GridBase} event.source The firing Grid instance.
146494
146731
  * @param {number} event.scrollTop The vertical scroll position.
146495
146732
  */
146496
- onScroll?: ((event: { source: Grid, scrollTop: number }) => void)|string
146733
+ onScroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
146497
146734
  /**
146498
146735
  * The selection has been changed.
146499
146736
  * @param {object} event Event object
@@ -146581,17 +146818,17 @@ type TreeGridConfig = {
146581
146818
  /**
146582
146819
  * Fires after a sub grid is collapsed.
146583
146820
  * @param {object} event Event object
146584
- * @param {Grid.view.Grid} event.source The firing Grid instance
146821
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
146585
146822
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
146586
146823
  */
146587
- onSubGridCollapse?: ((event: { source: Grid, subGrid: SubGrid }) => void)|string
146824
+ onSubGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
146588
146825
  /**
146589
146826
  * Fires after a sub grid is expanded.
146590
146827
  * @param {object} event Event object
146591
- * @param {Grid.view.Grid} event.source The firing Grid instance
146828
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
146592
146829
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
146593
146830
  */
146594
- onSubGridExpand?: ((event: { source: Grid, subGrid: SubGrid }) => void)|string
146831
+ onSubGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
146595
146832
  /**
146596
146833
  * Fired when one or more groups are expanded or collapsed
146597
146834
  * @param {object} event Event object