@bryntum/grid-trial 7.2.1 → 7.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/grid.thin.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  /*!
2
2
  *
3
- * Bryntum Grid 7.2.1 (TRIAL VERSION)
3
+ * Bryntum Grid 7.2.3 (TRIAL VERSION)
4
4
  *
5
5
  * Copyright(c) 2026 Bryntum AB
6
6
  * https://bryntum.com/contact
@@ -1195,8 +1195,9 @@ type ActionColumnConfig = {
1195
1195
  * @param {object} renderData
1196
1196
  * @param {Grid.column.Column} renderData.column This column
1197
1197
  * @param {HTMLElement} renderData.headerElement The header element
1198
+ * @returns {string,object,void,void} The text or markup to show in the column header
1198
1199
  */
1199
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
1200
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
1200
1201
  /**
1201
1202
  * An array of the widgets to append to the column header. These widgets have this Column instance
1202
1203
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -1237,7 +1238,7 @@ type ActionColumnConfig = {
1237
1238
  id?: string|number
1238
1239
  /**
1239
1240
  * Set to `true` to have the [CellEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit) feature update the record being edited live upon
1240
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
1241
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
1241
1242
  */
1242
1243
  instantUpdate?: boolean
1243
1244
  /**
@@ -1405,7 +1406,7 @@ type ActionColumnConfig = {
1405
1406
  */
1406
1407
  responsiveLevels?: object
1407
1408
  /**
1408
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
1409
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
1409
1410
  * revert the field to the value it had when the edit began. If the value is *not* changed
1410
1411
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
1411
1412
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -1914,8 +1915,9 @@ type AggregateColumnConfig = {
1914
1915
  * @param {object} renderData
1915
1916
  * @param {Grid.column.Column} renderData.column This column
1916
1917
  * @param {HTMLElement} renderData.headerElement The header element
1918
+ * @returns {string,object,void,void} The text or markup to show in the column header
1917
1919
  */
1918
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
1920
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
1919
1921
  /**
1920
1922
  * An array of the widgets to append to the column header. These widgets have this Column instance
1921
1923
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -1969,7 +1971,7 @@ type AggregateColumnConfig = {
1969
1971
  includeParentInChangeSet?: boolean
1970
1972
  /**
1971
1973
  * Set to `true` to have the [CellEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit) feature update the record being edited live upon
1972
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
1974
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
1973
1975
  */
1974
1976
  instantUpdate?: boolean
1975
1977
  /**
@@ -2154,7 +2156,7 @@ type AggregateColumnConfig = {
2154
2156
  */
2155
2157
  responsiveLevels?: object
2156
2158
  /**
2157
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
2159
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
2158
2160
  * revert the field to the value it had when the edit began. If the value is *not* changed
2159
2161
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
2160
2162
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -2684,8 +2686,9 @@ type ChartColumnConfig = {
2684
2686
  * @param {object} renderData
2685
2687
  * @param {Grid.column.Column} renderData.column This column
2686
2688
  * @param {HTMLElement} renderData.headerElement The header element
2689
+ * @returns {string,object,void,void} The text or markup to show in the column header
2687
2690
  */
2688
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
2691
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
2689
2692
  /**
2690
2693
  * An array of the widgets to append to the column header. These widgets have this Column instance
2691
2694
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -2731,7 +2734,7 @@ type ChartColumnConfig = {
2731
2734
  id?: string|number
2732
2735
  /**
2733
2736
  * Set to `true` to have the [CellEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit) feature update the record being edited live upon
2734
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
2737
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
2735
2738
  */
2736
2739
  instantUpdate?: boolean
2737
2740
  /**
@@ -2907,7 +2910,7 @@ type ChartColumnConfig = {
2907
2910
  */
2908
2911
  responsiveLevels?: object
2909
2912
  /**
2910
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
2913
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
2911
2914
  * revert the field to the value it had when the edit began. If the value is *not* changed
2912
2915
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
2913
2916
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -3459,8 +3462,9 @@ type CheckColumnConfig = {
3459
3462
  * @param {object} renderData
3460
3463
  * @param {Grid.column.Column} renderData.column This column
3461
3464
  * @param {HTMLElement} renderData.headerElement The header element
3465
+ * @returns {string,object,void,void} The text or markup to show in the column header
3462
3466
  */
3463
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
3467
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
3464
3468
  /**
3465
3469
  * An array of the widgets to append to the column header. These widgets have this Column instance
3466
3470
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -3506,7 +3510,7 @@ type CheckColumnConfig = {
3506
3510
  id?: string|number
3507
3511
  /**
3508
3512
  * Set to `true` to have the [CellEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit) feature update the record being edited live upon
3509
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
3513
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
3510
3514
  */
3511
3515
  instantUpdate?: boolean
3512
3516
  /**
@@ -3682,7 +3686,7 @@ type CheckColumnConfig = {
3682
3686
  */
3683
3687
  responsiveLevels?: object
3684
3688
  /**
3685
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
3689
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
3686
3690
  * revert the field to the value it had when the edit began. If the value is *not* changed
3687
3691
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
3688
3692
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -4249,8 +4253,9 @@ type ColorColumnConfig = {
4249
4253
  * @param {object} renderData
4250
4254
  * @param {Grid.column.Column} renderData.column This column
4251
4255
  * @param {HTMLElement} renderData.headerElement The header element
4256
+ * @returns {string,object,void,void} The text or markup to show in the column header
4252
4257
  */
4253
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
4258
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
4254
4259
  /**
4255
4260
  * An array of the widgets to append to the column header. These widgets have this Column instance
4256
4261
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -4296,7 +4301,7 @@ type ColorColumnConfig = {
4296
4301
  id?: string|number
4297
4302
  /**
4298
4303
  * Set to `true` to have the [CellEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit) feature update the record being edited live upon
4299
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
4304
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
4300
4305
  */
4301
4306
  instantUpdate?: boolean
4302
4307
  /**
@@ -4468,7 +4473,7 @@ type ColorColumnConfig = {
4468
4473
  */
4469
4474
  responsiveLevels?: object
4470
4475
  /**
4471
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
4476
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
4472
4477
  * revert the field to the value it had when the edit began. If the value is *not* changed
4473
4478
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
4474
4479
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -4984,8 +4989,9 @@ type ColumnConfig = {
4984
4989
  * @param {object} renderData
4985
4990
  * @param {Grid.column.Column} renderData.column This column
4986
4991
  * @param {HTMLElement} renderData.headerElement The header element
4992
+ * @returns {string,object,void,void} The text or markup to show in the column header
4987
4993
  */
4988
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
4994
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
4989
4995
  /**
4990
4996
  * An array of the widgets to append to the column header. These widgets have this Column instance
4991
4997
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -5031,7 +5037,7 @@ type ColumnConfig = {
5031
5037
  id?: string|number
5032
5038
  /**
5033
5039
  * Set to `true` to have the [CellEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit) feature update the record being edited live upon
5034
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
5040
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
5035
5041
  */
5036
5042
  instantUpdate?: boolean
5037
5043
  /**
@@ -5203,7 +5209,7 @@ type ColumnConfig = {
5203
5209
  */
5204
5210
  responsiveLevels?: object
5205
5211
  /**
5206
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
5212
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
5207
5213
  * revert the field to the value it had when the edit began. If the value is *not* changed
5208
5214
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
5209
5215
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -5533,7 +5539,7 @@ export class Column extends Model {
5533
5539
  /**
5534
5540
  * Renderer function for the column header.
5535
5541
  */
5536
- headerRenderer: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
5542
+ headerRenderer: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
5537
5543
  /**
5538
5544
  * An array of the widgets to append to the column header. These widgets have this Column instance
5539
5545
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -5568,7 +5574,7 @@ export class Column extends Model {
5568
5574
  icon: string
5569
5575
  /**
5570
5576
  * Set to `true` to have the [CellEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit) feature update the record being edited live upon
5571
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
5577
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
5572
5578
  */
5573
5579
  instantUpdate: boolean
5574
5580
  /**
@@ -5664,7 +5670,7 @@ export class Column extends Model {
5664
5670
  */
5665
5671
  responsiveLevels: object
5666
5672
  /**
5667
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
5673
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
5668
5674
  * revert the field to the value it had when the edit began. If the value is *not* changed
5669
5675
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
5670
5676
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -6281,8 +6287,9 @@ type CurrencyColumnConfig = {
6281
6287
  * @param {object} renderData
6282
6288
  * @param {Grid.column.Column} renderData.column This column
6283
6289
  * @param {HTMLElement} renderData.headerElement The header element
6290
+ * @returns {string,object,void,void} The text or markup to show in the column header
6284
6291
  */
6285
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
6292
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
6286
6293
  /**
6287
6294
  * An array of the widgets to append to the column header. These widgets have this Column instance
6288
6295
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -6333,7 +6340,7 @@ type CurrencyColumnConfig = {
6333
6340
  id?: string|number
6334
6341
  /**
6335
6342
  * Set to `true` to have the [CellEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit) feature update the record being edited live upon
6336
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
6343
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
6337
6344
  */
6338
6345
  instantUpdate?: boolean
6339
6346
  /**
@@ -6518,7 +6525,7 @@ type CurrencyColumnConfig = {
6518
6525
  */
6519
6526
  responsiveLevels?: object
6520
6527
  /**
6521
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
6528
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
6522
6529
  * revert the field to the value it had when the edit began. If the value is *not* changed
6523
6530
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
6524
6531
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -7033,8 +7040,9 @@ type DateColumnConfig = {
7033
7040
  * @param {object} renderData
7034
7041
  * @param {Grid.column.Column} renderData.column This column
7035
7042
  * @param {HTMLElement} renderData.headerElement The header element
7043
+ * @returns {string,object,void,void} The text or markup to show in the column header
7036
7044
  */
7037
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
7045
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
7038
7046
  /**
7039
7047
  * An array of the widgets to append to the column header. These widgets have this Column instance
7040
7048
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -7080,7 +7088,7 @@ type DateColumnConfig = {
7080
7088
  id?: string|number
7081
7089
  /**
7082
7090
  * Set to `true` to have the [CellEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit) feature update the record being edited live upon
7083
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
7091
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
7084
7092
  */
7085
7093
  instantUpdate?: boolean
7086
7094
  /**
@@ -7260,7 +7268,7 @@ type DateColumnConfig = {
7260
7268
  */
7261
7269
  responsiveLevels?: object
7262
7270
  /**
7263
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
7271
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
7264
7272
  * revert the field to the value it had when the edit began. If the value is *not* changed
7265
7273
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
7266
7274
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -7796,8 +7804,9 @@ type NumberColumnConfig = {
7796
7804
  * @param {object} renderData
7797
7805
  * @param {Grid.column.Column} renderData.column This column
7798
7806
  * @param {HTMLElement} renderData.headerElement The header element
7807
+ * @returns {string,object,void,void} The text or markup to show in the column header
7799
7808
  */
7800
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
7809
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
7801
7810
  /**
7802
7811
  * An array of the widgets to append to the column header. These widgets have this Column instance
7803
7812
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -7843,7 +7852,7 @@ type NumberColumnConfig = {
7843
7852
  id?: string|number
7844
7853
  /**
7845
7854
  * Set to `true` to have the [CellEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit) feature update the record being edited live upon
7846
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
7855
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
7847
7856
  */
7848
7857
  instantUpdate?: boolean
7849
7858
  /**
@@ -8028,7 +8037,7 @@ type NumberColumnConfig = {
8028
8037
  */
8029
8038
  responsiveLevels?: object
8030
8039
  /**
8031
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
8040
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
8032
8041
  * revert the field to the value it had when the edit began. If the value is *not* changed
8033
8042
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
8034
8043
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -8575,8 +8584,9 @@ type PercentColumnConfig = {
8575
8584
  * @param {object} renderData
8576
8585
  * @param {Grid.column.Column} renderData.column This column
8577
8586
  * @param {HTMLElement} renderData.headerElement The header element
8587
+ * @returns {string,object,void,void} The text or markup to show in the column header
8578
8588
  */
8579
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
8589
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
8580
8590
  /**
8581
8591
  * An array of the widgets to append to the column header. These widgets have this Column instance
8582
8592
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -8617,7 +8627,7 @@ type PercentColumnConfig = {
8617
8627
  id?: string|number
8618
8628
  /**
8619
8629
  * Set to `true` to have the [CellEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit) feature update the record being edited live upon
8620
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
8630
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
8621
8631
  */
8622
8632
  instantUpdate?: boolean
8623
8633
  /**
@@ -8812,7 +8822,7 @@ type PercentColumnConfig = {
8812
8822
  */
8813
8823
  responsiveLevels?: object
8814
8824
  /**
8815
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
8825
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
8816
8826
  * revert the field to the value it had when the edit began. If the value is *not* changed
8817
8827
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
8818
8828
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -9353,8 +9363,9 @@ type RatingColumnConfig = {
9353
9363
  * @param {object} renderData
9354
9364
  * @param {Grid.column.Column} renderData.column This column
9355
9365
  * @param {HTMLElement} renderData.headerElement The header element
9366
+ * @returns {string,object,void,void} The text or markup to show in the column header
9356
9367
  */
9357
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
9368
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
9358
9369
  /**
9359
9370
  * An array of the widgets to append to the column header. These widgets have this Column instance
9360
9371
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -9400,7 +9411,7 @@ type RatingColumnConfig = {
9400
9411
  id?: string|number
9401
9412
  /**
9402
9413
  * Set to `true` to have the [CellEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit) feature update the record being edited live upon
9403
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
9414
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
9404
9415
  */
9405
9416
  instantUpdate?: boolean
9406
9417
  /**
@@ -9585,7 +9596,7 @@ type RatingColumnConfig = {
9585
9596
  */
9586
9597
  responsiveLevels?: object
9587
9598
  /**
9588
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
9599
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
9589
9600
  * revert the field to the value it had when the edit began. If the value is *not* changed
9590
9601
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
9591
9602
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -10033,8 +10044,9 @@ type RowNumberColumnConfig = {
10033
10044
  * @param {object} renderData
10034
10045
  * @param {Grid.column.Column} renderData.column This column
10035
10046
  * @param {HTMLElement} renderData.headerElement The header element
10047
+ * @returns {string,object,void,void} The text or markup to show in the column header
10036
10048
  */
10037
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
10049
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
10038
10050
  /**
10039
10051
  * An array of the widgets to append to the column header. These widgets have this Column instance
10040
10052
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -10701,8 +10713,9 @@ type SparklineColumnConfig = {
10701
10713
  * @param {object} renderData
10702
10714
  * @param {Grid.column.Column} renderData.column This column
10703
10715
  * @param {HTMLElement} renderData.headerElement The header element
10716
+ * @returns {string,object,void,void} The text or markup to show in the column header
10704
10717
  */
10705
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
10718
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
10706
10719
  /**
10707
10720
  * An array of the widgets to append to the column header. These widgets have this Column instance
10708
10721
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -10758,7 +10771,7 @@ type SparklineColumnConfig = {
10758
10771
  id?: string|number
10759
10772
  /**
10760
10773
  * Set to `true` to have the [CellEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit) feature update the record being edited live upon
10761
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
10774
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
10762
10775
  */
10763
10776
  instantUpdate?: boolean
10764
10777
  /**
@@ -10934,7 +10947,7 @@ type SparklineColumnConfig = {
10934
10947
  */
10935
10948
  responsiveLevels?: object
10936
10949
  /**
10937
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
10950
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
10938
10951
  * revert the field to the value it had when the edit began. If the value is *not* changed
10939
10952
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
10940
10953
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -11425,8 +11438,9 @@ type TemplateColumnConfig = {
11425
11438
  * @param {object} renderData
11426
11439
  * @param {Grid.column.Column} renderData.column This column
11427
11440
  * @param {HTMLElement} renderData.headerElement The header element
11441
+ * @returns {string,object,void,void} The text or markup to show in the column header
11428
11442
  */
11429
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
11443
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
11430
11444
  /**
11431
11445
  * An array of the widgets to append to the column header. These widgets have this Column instance
11432
11446
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -11472,7 +11486,7 @@ type TemplateColumnConfig = {
11472
11486
  id?: string|number
11473
11487
  /**
11474
11488
  * Set to `true` to have the [CellEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit) feature update the record being edited live upon
11475
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
11489
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
11476
11490
  */
11477
11491
  instantUpdate?: boolean
11478
11492
  /**
@@ -11644,7 +11658,7 @@ type TemplateColumnConfig = {
11644
11658
  */
11645
11659
  responsiveLevels?: object
11646
11660
  /**
11647
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
11661
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
11648
11662
  * revert the field to the value it had when the edit began. If the value is *not* changed
11649
11663
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
11650
11664
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -12154,8 +12168,9 @@ type TimeColumnConfig = {
12154
12168
  * @param {object} renderData
12155
12169
  * @param {Grid.column.Column} renderData.column This column
12156
12170
  * @param {HTMLElement} renderData.headerElement The header element
12171
+ * @returns {string,object,void,void} The text or markup to show in the column header
12157
12172
  */
12158
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
12173
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
12159
12174
  /**
12160
12175
  * An array of the widgets to append to the column header. These widgets have this Column instance
12161
12176
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -12201,7 +12216,7 @@ type TimeColumnConfig = {
12201
12216
  id?: string|number
12202
12217
  /**
12203
12218
  * Set to `true` to have the [CellEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit) feature update the record being edited live upon
12204
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
12219
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
12205
12220
  */
12206
12221
  instantUpdate?: boolean
12207
12222
  /**
@@ -12373,7 +12388,7 @@ type TimeColumnConfig = {
12373
12388
  */
12374
12389
  responsiveLevels?: object
12375
12390
  /**
12376
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
12391
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
12377
12392
  * revert the field to the value it had when the edit began. If the value is *not* changed
12378
12393
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
12379
12394
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -12886,8 +12901,9 @@ type TreeColumnConfig = {
12886
12901
  * @param {object} renderData
12887
12902
  * @param {Grid.column.Column} renderData.column This column
12888
12903
  * @param {HTMLElement} renderData.headerElement The header element
12904
+ * @returns {string,object,void,void} The text or markup to show in the column header
12889
12905
  */
12890
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
12906
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
12891
12907
  /**
12892
12908
  * An array of the widgets to append to the column header. These widgets have this Column instance
12893
12909
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -12939,7 +12955,7 @@ type TreeColumnConfig = {
12939
12955
  indentSize?: number
12940
12956
  /**
12941
12957
  * Set to `true` to have the [CellEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit) feature update the record being edited live upon
12942
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
12958
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
12943
12959
  */
12944
12960
  instantUpdate?: boolean
12945
12961
  /**
@@ -13115,7 +13131,7 @@ type TreeColumnConfig = {
13115
13131
  */
13116
13132
  responsiveLevels?: object
13117
13133
  /**
13118
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
13134
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
13119
13135
  * revert the field to the value it had when the edit began. If the value is *not* changed
13120
13136
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
13121
13137
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -13645,8 +13661,9 @@ type WidgetColumnConfig = {
13645
13661
  * @param {object} renderData
13646
13662
  * @param {Grid.column.Column} renderData.column This column
13647
13663
  * @param {HTMLElement} renderData.headerElement The header element
13664
+ * @returns {string,object,void,void} The text or markup to show in the column header
13648
13665
  */
13649
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
13666
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
13650
13667
  /**
13651
13668
  * An array of the widgets to append to the column header. These widgets have this Column instance
13652
13669
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -13692,7 +13709,7 @@ type WidgetColumnConfig = {
13692
13709
  id?: string|number
13693
13710
  /**
13694
13711
  * Set to `true` to have the [CellEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit) feature update the record being edited live upon
13695
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
13712
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
13696
13713
  */
13697
13714
  instantUpdate?: boolean
13698
13715
  /**
@@ -13868,7 +13885,7 @@ type WidgetColumnConfig = {
13868
13885
  */
13869
13886
  responsiveLevels?: object
13870
13887
  /**
13871
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
13888
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
13872
13889
  * revert the field to the value it had when the edit began. If the value is *not* changed
13873
13890
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
13874
13891
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -15458,16 +15475,11 @@ export class ColumnStore extends Store {
15458
15475
  */
15459
15476
  static registerColumnType(columnClass: Function, simpleRenderer?: boolean): void;
15460
15477
  /**
15461
- * Get column by field. To be sure that you are getting exactly the intended column, use [Store#getById()](https://bryntum.com/products/grid/docs/api/Core/data/Store#function-getById) with the
15462
- * columns id instead.
15478
+ * Get column by field. To be sure that you are getting exactly the intended column, use
15479
+ * [getById](https://bryntum.com/products/grid/docs/api/Core/data/Store#function-getById) with the columns id instead.
15463
15480
  * @param {string} field Field name
15464
15481
  */
15465
15482
  get(field: string): Column;
15466
- /**
15467
- * Get column by id.
15468
- * @param {string,number} id
15469
- */
15470
- getById(id: string|number): Column;
15471
15483
  /**
15472
15484
  * indexOf extended to also accept a columns field, for backward compatibility.
15473
15485
  * @param {Core.data.Model,string} recordOrId
@@ -16561,7 +16573,7 @@ export class CellEdit extends GridEditBase {
16561
16573
  /**
16562
16574
  * Displays an OK / Cancel confirmation dialog box owned by the current Editor. This is intended to be
16563
16575
  * used by [finalizeCellEdit](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-finalizeCellEdit) implementations. The returned promise resolves passing
16564
- * `true` if the "OK" button is pressed, and `false` if the "Cancel" button is pressed. Typing `ESC` rejects.
16576
+ * `true` if the "OK" button is pressed, and `false` if the "Cancel" button is pressed. Typing <kbd>Escape</kbd> rejects.
16565
16577
  * @param {object} options An options object for what to show.
16566
16578
  */
16567
16579
  confirm(options: {
@@ -16825,7 +16837,7 @@ type CellMenuConfig = {
16825
16837
 
16826
16838
  /**
16827
16839
  * Right click to display context menu for cells. To invoke the cell menu in a keyboard-accessible manner, use the
16828
- * `SPACE` key when the cell is focused.
16840
+ * <kbd>Space</kbd> key when the cell is focused.
16829
16841
  * ...
16830
16842
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellMenu)
16831
16843
  */
@@ -17098,7 +17110,7 @@ type CellTooltipConfig = {
17098
17110
  */
17099
17111
  closeAction?: 'hide'|'destroy'
17100
17112
  /**
17101
- * Close popup when `ESC` key is pressed.
17113
+ * Close popup when <kbd>Escape</kbd> key is pressed.
17102
17114
  */
17103
17115
  closeOnEscape?: boolean
17104
17116
  /**
@@ -20710,8 +20722,8 @@ type GroupConfig = {
20710
20722
 
20711
20723
  /**
20712
20724
  * Enables rendering and handling of row groups. The actual grouping is done in the store, but triggered by
20713
- * <kbd>shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
20714
- * one anywhere on grid). Use <kbd>shift</kbd> + <kbd>alt</kbd> + click, or the context menu, to remove a column
20725
+ * <kbd>Shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
20726
+ * one anywhere on grid). Use <kbd>Shift</kbd> + <kbd>Alt</kbd> + click, or the context menu, to remove a column
20715
20727
  * grouper.
20716
20728
  * ...
20717
20729
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Group)
@@ -25993,10 +26005,10 @@ type TreeGroupConfig = {
25993
26005
  */
25994
26006
  parentCls?: string
25995
26007
  /**
25996
- * A function letting you format the text shown in the generated parent group levels. This method will be provided
25997
- * with the value produced by the column representing the grouped level. Each column's renderer method will be
25998
- * provided an extra `isTreeGroup` param to indicate that the value will be used for a generated parent. `cellElement`
25999
- * and other DOM specific args will be in the context of the tree column.
26008
+ * A function letting you format the text shown in the generated parent group levels. This method will be
26009
+ * provided with the value produced by the column representing the grouped level. Each column's renderer method
26010
+ * will be provided an extra `isTreeGroup` param to indicate that the value will be used for a generated parent.
26011
+ * `cellElement` and other DOM specific args will be in the context of the tree column.
26000
26012
  * ...
26001
26013
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/TreeGroup#config-parentRenderer)
26002
26014
  * @param {object} data The rendering data representing the generated tree parent record
@@ -27150,7 +27162,7 @@ type ExcelExporterConfig = {
27150
27162
  */
27151
27163
  localizableProperties?: string[]
27152
27164
  /**
27153
- * This hook allows to use 3rd party libraries to generate XLSX files.
27165
+ * This hook allows using 3rd party libraries to generate XLSX files.
27154
27166
  * ...
27155
27167
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/ExcelExporter#config-xlsProvider)
27156
27168
  */
@@ -29645,7 +29657,7 @@ type SinglePageUnscaledExporterConfig = {
29645
29657
 
29646
29658
  /**
29647
29659
  * A single page exporter. Used by the [PdfExport](https://bryntum.com/products/grid/docs/api/Grid/feature/export/PdfExport) feature to export to single page. Content
29648
- * is exported with dimensions required to fit all requested rows and columns. This allows to generate PDF page not
29660
+ * is exported with dimensions required to fit all requested rows and columns. This allows generating a PDF page not
29649
29661
  * constrained by the standard paper formats.
29650
29662
  * ...
29651
29663
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/export/exporter/SinglePageUnscaledExporter)
@@ -30055,7 +30067,7 @@ type GridListenersTypes = {
30055
30067
  */
30056
30068
  beforeCellEditStart: (event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void
30057
30069
  /**
30058
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
30070
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
30059
30071
  * buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
30060
30072
  * @param {object} event Event object
30061
30073
  * @param {Grid.view.Grid} event.source Owner grid
@@ -31020,6 +31032,14 @@ type GridListenersTypes = {
31020
31032
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
31021
31033
  */
31022
31034
  toolClick: (event: { source: Tool, tool: Tool }) => void
31035
+ /**
31036
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
31037
+ * @param {object} event Event object
31038
+ * @param {Grid.view.Grid} event.source The grid instance
31039
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
31040
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
31041
+ */
31042
+ treeGroup: (event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void
31023
31043
  /**
31024
31044
  * Fires when row locking is disabled.
31025
31045
  * @param {object} event Event object
@@ -31074,7 +31094,7 @@ type GridListeners = {
31074
31094
  */
31075
31095
  beforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
31076
31096
  /**
31077
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
31097
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
31078
31098
  * buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
31079
31099
  * @param {object} event Event object
31080
31100
  * @param {Grid.view.Grid} event.source Owner grid
@@ -32039,6 +32059,14 @@ type GridListeners = {
32039
32059
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
32040
32060
  */
32041
32061
  toolClick?: ((event: { source: Tool, tool: Tool }) => void)|string
32062
+ /**
32063
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
32064
+ * @param {object} event Event object
32065
+ * @param {Grid.view.Grid} event.source The grid instance
32066
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
32067
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
32068
+ */
32069
+ treeGroup?: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string
32042
32070
  /**
32043
32071
  * Fires when row locking is disabled.
32044
32072
  * @param {object} event Event object
@@ -32703,7 +32731,7 @@ type GridConfig = {
32703
32731
  rootElement?: ShadowRoot|HTMLElement
32704
32732
  /**
32705
32733
  * Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
32706
- * overriden by specifying a [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
32734
+ * overridden by specifying a [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
32707
32735
  * a column [renderer](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-renderer).
32708
32736
  * ...
32709
32737
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#config-rowHeight)
@@ -32934,7 +32962,7 @@ type GridConfig = {
32934
32962
  */
32935
32963
  onBeforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
32936
32964
  /**
32937
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
32965
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
32938
32966
  * buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
32939
32967
  * @param {object} event Event object
32940
32968
  * @param {Grid.view.Grid} event.source Owner grid
@@ -33899,6 +33927,14 @@ type GridConfig = {
33899
33927
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
33900
33928
  */
33901
33929
  onToolClick?: ((event: { source: Tool, tool: Tool }) => void)|string
33930
+ /**
33931
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
33932
+ * @param {object} event Event object
33933
+ * @param {Grid.view.Grid} event.source The grid instance
33934
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
33935
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
33936
+ */
33937
+ onTreeGroup?: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string
33902
33938
  /**
33903
33939
  * Fires when row locking is disabled.
33904
33940
  * @param {object} event Event object
@@ -34172,7 +34208,7 @@ type GridBaseListenersTypes = {
34172
34208
  */
34173
34209
  beforeCellEditStart: (event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void
34174
34210
  /**
34175
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
34211
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
34176
34212
  * buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
34177
34213
  * @param {object} event Event object
34178
34214
  * @param {Grid.view.Grid} event.source Owner grid
@@ -35137,6 +35173,14 @@ type GridBaseListenersTypes = {
35137
35173
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
35138
35174
  */
35139
35175
  toolClick: (event: { source: Tool, tool: Tool }) => void
35176
+ /**
35177
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
35178
+ * @param {object} event Event object
35179
+ * @param {Grid.view.Grid} event.source The grid instance
35180
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
35181
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
35182
+ */
35183
+ treeGroup: (event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void
35140
35184
  /**
35141
35185
  * Fires when row locking is disabled.
35142
35186
  * @param {object} event Event object
@@ -35191,7 +35235,7 @@ type GridBaseListeners = {
35191
35235
  */
35192
35236
  beforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
35193
35237
  /**
35194
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
35238
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
35195
35239
  * buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
35196
35240
  * @param {object} event Event object
35197
35241
  * @param {Grid.view.Grid} event.source Owner grid
@@ -36156,6 +36200,14 @@ type GridBaseListeners = {
36156
36200
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
36157
36201
  */
36158
36202
  toolClick?: ((event: { source: Tool, tool: Tool }) => void)|string
36203
+ /**
36204
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
36205
+ * @param {object} event Event object
36206
+ * @param {Grid.view.Grid} event.source The grid instance
36207
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
36208
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
36209
+ */
36210
+ treeGroup?: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string
36159
36211
  /**
36160
36212
  * Fires when row locking is disabled.
36161
36213
  * @param {object} event Event object
@@ -36819,7 +36871,7 @@ type GridBaseConfig = {
36819
36871
  rootElement?: ShadowRoot|HTMLElement
36820
36872
  /**
36821
36873
  * Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
36822
- * overriden by specifying a [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
36874
+ * overridden by specifying a [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
36823
36875
  * a column [renderer](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-renderer).
36824
36876
  * ...
36825
36877
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-rowHeight)
@@ -37050,7 +37102,7 @@ type GridBaseConfig = {
37050
37102
  */
37051
37103
  onBeforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
37052
37104
  /**
37053
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
37105
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
37054
37106
  * buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
37055
37107
  * @param {object} event Event object
37056
37108
  * @param {Grid.view.Grid} event.source Owner grid
@@ -38015,6 +38067,14 @@ type GridBaseConfig = {
38015
38067
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
38016
38068
  */
38017
38069
  onToolClick?: ((event: { source: Tool, tool: Tool }) => void)|string
38070
+ /**
38071
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
38072
+ * @param {object} event Event object
38073
+ * @param {Grid.view.Grid} event.source The grid instance
38074
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
38075
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
38076
+ */
38077
+ onTreeGroup?: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string
38018
38078
  /**
38019
38079
  * Fires when row locking is disabled.
38020
38080
  * @param {object} event Event object
@@ -38278,7 +38338,7 @@ export class GridBase extends Panel {
38278
38338
  readonly responsiveLevel: string
38279
38339
  /**
38280
38340
  * Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
38281
- * overriden by specifying a [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
38341
+ * overridden by specifying a [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
38282
38342
  * a column [renderer](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-renderer).
38283
38343
  */
38284
38344
  rowHeight: number
@@ -38398,7 +38458,7 @@ export class GridBase extends Panel {
38398
38458
  */
38399
38459
  onBeforeCellEditStart: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
38400
38460
  /**
38401
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
38461
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
38402
38462
  * buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
38403
38463
  * @param {object} event Event object
38404
38464
  * @param {Grid.view.Grid} event.source Owner grid
@@ -39227,6 +39287,14 @@ export class GridBase extends Panel {
39227
39287
  * @param {boolean} event.collapse `true` if the node is being collapsed.
39228
39288
  */
39229
39289
  onToggleNode: ((event: { record: Model, collapse: boolean }) => void)|string
39290
+ /**
39291
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
39292
+ * @param {object} event Event object
39293
+ * @param {Grid.view.Grid} event.source The grid instance
39294
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
39295
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
39296
+ */
39297
+ onTreeGroup: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string
39230
39298
  /**
39231
39299
  * Fires when row locking is disabled.
39232
39300
  * @param {object} event Event object
@@ -40717,7 +40785,7 @@ type TreeGridListenersTypes = {
40717
40785
  */
40718
40786
  beforeCellEditStart: (event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void
40719
40787
  /**
40720
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
40788
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
40721
40789
  * buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
40722
40790
  * @param {object} event Event object
40723
40791
  * @param {Grid.view.Grid} event.source Owner grid
@@ -41682,6 +41750,14 @@ type TreeGridListenersTypes = {
41682
41750
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
41683
41751
  */
41684
41752
  toolClick: (event: { source: Tool, tool: Tool }) => void
41753
+ /**
41754
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
41755
+ * @param {object} event Event object
41756
+ * @param {Grid.view.Grid} event.source The grid instance
41757
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
41758
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
41759
+ */
41760
+ treeGroup: (event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void
41685
41761
  /**
41686
41762
  * Fires when row locking is disabled.
41687
41763
  * @param {object} event Event object
@@ -41736,7 +41812,7 @@ type TreeGridListeners = {
41736
41812
  */
41737
41813
  beforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
41738
41814
  /**
41739
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
41815
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
41740
41816
  * buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
41741
41817
  * @param {object} event Event object
41742
41818
  * @param {Grid.view.Grid} event.source Owner grid
@@ -42701,6 +42777,14 @@ type TreeGridListeners = {
42701
42777
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
42702
42778
  */
42703
42779
  toolClick?: ((event: { source: Tool, tool: Tool }) => void)|string
42780
+ /**
42781
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
42782
+ * @param {object} event Event object
42783
+ * @param {Grid.view.Grid} event.source The grid instance
42784
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
42785
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
42786
+ */
42787
+ treeGroup?: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string
42704
42788
  /**
42705
42789
  * Fires when row locking is disabled.
42706
42790
  * @param {object} event Event object
@@ -43365,7 +43449,7 @@ type TreeGridConfig = {
43365
43449
  rootElement?: ShadowRoot|HTMLElement
43366
43450
  /**
43367
43451
  * Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
43368
- * overriden by specifying a [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
43452
+ * overridden by specifying a [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
43369
43453
  * a column [renderer](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-renderer).
43370
43454
  * ...
43371
43455
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-rowHeight)
@@ -43596,7 +43680,7 @@ type TreeGridConfig = {
43596
43680
  */
43597
43681
  onBeforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
43598
43682
  /**
43599
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
43683
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
43600
43684
  * buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
43601
43685
  * @param {object} event Event object
43602
43686
  * @param {Grid.view.Grid} event.source Owner grid
@@ -44561,6 +44645,14 @@ type TreeGridConfig = {
44561
44645
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
44562
44646
  */
44563
44647
  onToolClick?: ((event: { source: Tool, tool: Tool }) => void)|string
44648
+ /**
44649
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
44650
+ * @param {object} event Event object
44651
+ * @param {Grid.view.Grid} event.source The grid instance
44652
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
44653
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
44654
+ */
44655
+ onTreeGroup?: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string
44564
44656
  /**
44565
44657
  * Fires when row locking is disabled.
44566
44658
  * @param {object} event Event object
@@ -45306,7 +45398,7 @@ type ExportDialogConfig = {
45306
45398
  */
45307
45399
  closeAction?: 'hide'|'destroy'
45308
45400
  /**
45309
- * Close popup when `ESC` key is pressed.
45401
+ * Close popup when <kbd>Escape</kbd> key is pressed.
45310
45402
  */
45311
45403
  closeOnEscape?: boolean
45312
45404
  /**
@@ -47757,7 +47849,7 @@ type AIFilterFieldConfig = {
47757
47849
  required?: boolean
47758
47850
  /**
47759
47851
  * If this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly), then setting this option means that pressing
47760
- * the `ESCAPE` key after editing the field will revert the field to the value it had when
47852
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
47761
47853
  * the user focused the field. If the field is *not* changed from when focused, the [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
47762
47854
  * behaviour will be activated.
47763
47855
  */
@@ -48616,7 +48708,7 @@ type ChecklistFilterComboConfig = {
48616
48708
  contentElementCls?: string|object
48617
48709
  /**
48618
48710
  * If configured as `true`, this means that when an unmatched string is typed into the
48619
- * combo's input field, and `ENTER`, or the [multiValueSeparator](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-multiValueSeparator) is typed,
48711
+ * combo's input field, and <kbd>Enter</kbd>, or the [multiValueSeparator](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-multiValueSeparator) is typed,
48620
48712
  * a new record will be created using the typed string as the [displayField](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-displayField).
48621
48713
  * ...
48622
48714
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-createOnUnmatched)
@@ -49116,7 +49208,7 @@ type ChecklistFilterComboConfig = {
49116
49208
  required?: boolean
49117
49209
  /**
49118
49210
  * If this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly), then setting this option means that pressing
49119
- * the `ESCAPE` key after editing the field will revert the field to the value it had when
49211
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
49120
49212
  * the user focused the field. If the field is *not* changed from when focused, the [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
49121
49213
  * behaviour will be activated.
49122
49214
  */
@@ -53430,7 +53522,7 @@ type GroupBarConfig = {
53430
53522
  */
53431
53523
  title?: string
53432
53524
  /**
53433
- * Select/deselect all if `CMD`/`CTRL` is pressed when clicking
53525
+ * Select/deselect all if <kbd>Cmd</kbd>/<kbd>Ctrl</kbd> is pressed when clicking
53434
53526
  */
53435
53527
  toggleAllIfCtrlPressed?: boolean
53436
53528
  /**
@@ -54190,7 +54282,7 @@ type TreeComboConfig = {
54190
54282
  contentElementCls?: string|object
54191
54283
  /**
54192
54284
  * If configured as `true`, this means that when an unmatched string is typed into the
54193
- * combo's input field, and `ENTER`, or the [multiValueSeparator](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-multiValueSeparator) is typed,
54285
+ * combo's input field, and <kbd>Enter</kbd>, or the [multiValueSeparator](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-multiValueSeparator) is typed,
54194
54286
  * a new record will be created using the typed string as the [displayField](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-displayField).
54195
54287
  * ...
54196
54288
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-createOnUnmatched)
@@ -54690,7 +54782,7 @@ type TreeComboConfig = {
54690
54782
  required?: boolean
54691
54783
  /**
54692
54784
  * If this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly), then setting this option means that pressing
54693
- * the `ESCAPE` key after editing the field will revert the field to the value it had when
54785
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
54694
54786
  * the user focused the field. If the field is *not* changed from when focused, the [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
54695
54787
  * behaviour will be activated.
54696
54788
  */