@bryntum/grid-trial 7.2.0 → 7.2.2

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.0 (TRIAL VERSION)
3
+ * Bryntum Grid 7.2.2 (TRIAL VERSION)
4
4
  *
5
5
  * Copyright(c) 2026 Bryntum AB
6
6
  * https://bryntum.com/contact
@@ -1190,6 +1190,8 @@ type ActionColumnConfig = {
1190
1190
  headerMenuItems?: Record<string, MenuItemEntry>
1191
1191
  /**
1192
1192
  * Renderer function for the column header.
1193
+ * ...
1194
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/ActionColumn#config-headerRenderer)
1193
1195
  * @param {object} renderData
1194
1196
  * @param {Grid.column.Column} renderData.column This column
1195
1197
  * @param {HTMLElement} renderData.headerElement The header element
@@ -1235,7 +1237,7 @@ type ActionColumnConfig = {
1235
1237
  id?: string|number
1236
1238
  /**
1237
1239
  * 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
1238
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
1240
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
1239
1241
  */
1240
1242
  instantUpdate?: boolean
1241
1243
  /**
@@ -1403,7 +1405,7 @@ type ActionColumnConfig = {
1403
1405
  */
1404
1406
  responsiveLevels?: object
1405
1407
  /**
1406
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
1408
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
1407
1409
  * revert the field to the value it had when the edit began. If the value is *not* changed
1408
1410
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
1409
1411
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -1907,6 +1909,8 @@ type AggregateColumnConfig = {
1907
1909
  headerMenuItems?: Record<string, MenuItemEntry>
1908
1910
  /**
1909
1911
  * Renderer function for the column header.
1912
+ * ...
1913
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/AggregateColumn#config-headerRenderer)
1910
1914
  * @param {object} renderData
1911
1915
  * @param {Grid.column.Column} renderData.column This column
1912
1916
  * @param {HTMLElement} renderData.headerElement The header element
@@ -1965,7 +1969,7 @@ type AggregateColumnConfig = {
1965
1969
  includeParentInChangeSet?: boolean
1966
1970
  /**
1967
1971
  * 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
1968
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
1972
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
1969
1973
  */
1970
1974
  instantUpdate?: boolean
1971
1975
  /**
@@ -2150,7 +2154,7 @@ type AggregateColumnConfig = {
2150
2154
  */
2151
2155
  responsiveLevels?: object
2152
2156
  /**
2153
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
2157
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
2154
2158
  * revert the field to the value it had when the edit began. If the value is *not* changed
2155
2159
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
2156
2160
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -2675,6 +2679,8 @@ type ChartColumnConfig = {
2675
2679
  headerMenuItems?: Record<string, MenuItemEntry>
2676
2680
  /**
2677
2681
  * Renderer function for the column header.
2682
+ * ...
2683
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/ChartColumn#config-headerRenderer)
2678
2684
  * @param {object} renderData
2679
2685
  * @param {Grid.column.Column} renderData.column This column
2680
2686
  * @param {HTMLElement} renderData.headerElement The header element
@@ -2725,7 +2731,7 @@ type ChartColumnConfig = {
2725
2731
  id?: string|number
2726
2732
  /**
2727
2733
  * 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
2728
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
2734
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
2729
2735
  */
2730
2736
  instantUpdate?: boolean
2731
2737
  /**
@@ -2901,7 +2907,7 @@ type ChartColumnConfig = {
2901
2907
  */
2902
2908
  responsiveLevels?: object
2903
2909
  /**
2904
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
2910
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
2905
2911
  * revert the field to the value it had when the edit began. If the value is *not* changed
2906
2912
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
2907
2913
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -3448,6 +3454,8 @@ type CheckColumnConfig = {
3448
3454
  headerMenuItems?: Record<string, MenuItemEntry>
3449
3455
  /**
3450
3456
  * Renderer function for the column header.
3457
+ * ...
3458
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/CheckColumn#config-headerRenderer)
3451
3459
  * @param {object} renderData
3452
3460
  * @param {Grid.column.Column} renderData.column This column
3453
3461
  * @param {HTMLElement} renderData.headerElement The header element
@@ -3498,7 +3506,7 @@ type CheckColumnConfig = {
3498
3506
  id?: string|number
3499
3507
  /**
3500
3508
  * 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
3501
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
3509
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
3502
3510
  */
3503
3511
  instantUpdate?: boolean
3504
3512
  /**
@@ -3674,7 +3682,7 @@ type CheckColumnConfig = {
3674
3682
  */
3675
3683
  responsiveLevels?: object
3676
3684
  /**
3677
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
3685
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
3678
3686
  * revert the field to the value it had when the edit began. If the value is *not* changed
3679
3687
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
3680
3688
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -4236,6 +4244,8 @@ type ColorColumnConfig = {
4236
4244
  headerMenuItems?: Record<string, MenuItemEntry>
4237
4245
  /**
4238
4246
  * Renderer function for the column header.
4247
+ * ...
4248
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/ColorColumn#config-headerRenderer)
4239
4249
  * @param {object} renderData
4240
4250
  * @param {Grid.column.Column} renderData.column This column
4241
4251
  * @param {HTMLElement} renderData.headerElement The header element
@@ -4286,7 +4296,7 @@ type ColorColumnConfig = {
4286
4296
  id?: string|number
4287
4297
  /**
4288
4298
  * 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
4289
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
4299
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
4290
4300
  */
4291
4301
  instantUpdate?: boolean
4292
4302
  /**
@@ -4458,7 +4468,7 @@ type ColorColumnConfig = {
4458
4468
  */
4459
4469
  responsiveLevels?: object
4460
4470
  /**
4461
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
4471
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
4462
4472
  * revert the field to the value it had when the edit began. If the value is *not* changed
4463
4473
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
4464
4474
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -4969,6 +4979,8 @@ type ColumnConfig = {
4969
4979
  headerMenuItems?: Record<string, MenuItemEntry>
4970
4980
  /**
4971
4981
  * Renderer function for the column header.
4982
+ * ...
4983
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-headerRenderer)
4972
4984
  * @param {object} renderData
4973
4985
  * @param {Grid.column.Column} renderData.column This column
4974
4986
  * @param {HTMLElement} renderData.headerElement The header element
@@ -5019,7 +5031,7 @@ type ColumnConfig = {
5019
5031
  id?: string|number
5020
5032
  /**
5021
5033
  * 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
5022
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
5034
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
5023
5035
  */
5024
5036
  instantUpdate?: boolean
5025
5037
  /**
@@ -5191,7 +5203,7 @@ type ColumnConfig = {
5191
5203
  */
5192
5204
  responsiveLevels?: object
5193
5205
  /**
5194
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
5206
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
5195
5207
  * revert the field to the value it had when the edit began. If the value is *not* changed
5196
5208
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
5197
5209
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -5556,7 +5568,7 @@ export class Column extends Model {
5556
5568
  icon: string
5557
5569
  /**
5558
5570
  * 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
5559
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
5571
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
5560
5572
  */
5561
5573
  instantUpdate: boolean
5562
5574
  /**
@@ -5652,7 +5664,7 @@ export class Column extends Model {
5652
5664
  */
5653
5665
  responsiveLevels: object
5654
5666
  /**
5655
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
5667
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
5656
5668
  * revert the field to the value it had when the edit began. If the value is *not* changed
5657
5669
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
5658
5670
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -6264,6 +6276,8 @@ type CurrencyColumnConfig = {
6264
6276
  headerMenuItems?: Record<string, MenuItemEntry>
6265
6277
  /**
6266
6278
  * Renderer function for the column header.
6279
+ * ...
6280
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/CurrencyColumn#config-headerRenderer)
6267
6281
  * @param {object} renderData
6268
6282
  * @param {Grid.column.Column} renderData.column This column
6269
6283
  * @param {HTMLElement} renderData.headerElement The header element
@@ -6319,7 +6333,7 @@ type CurrencyColumnConfig = {
6319
6333
  id?: string|number
6320
6334
  /**
6321
6335
  * 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
6322
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
6336
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
6323
6337
  */
6324
6338
  instantUpdate?: boolean
6325
6339
  /**
@@ -6504,7 +6518,7 @@ type CurrencyColumnConfig = {
6504
6518
  */
6505
6519
  responsiveLevels?: object
6506
6520
  /**
6507
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
6521
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
6508
6522
  * revert the field to the value it had when the edit began. If the value is *not* changed
6509
6523
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
6510
6524
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -7014,6 +7028,8 @@ type DateColumnConfig = {
7014
7028
  headerMenuItems?: Record<string, MenuItemEntry>
7015
7029
  /**
7016
7030
  * Renderer function for the column header.
7031
+ * ...
7032
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/DateColumn#config-headerRenderer)
7017
7033
  * @param {object} renderData
7018
7034
  * @param {Grid.column.Column} renderData.column This column
7019
7035
  * @param {HTMLElement} renderData.headerElement The header element
@@ -7064,7 +7080,7 @@ type DateColumnConfig = {
7064
7080
  id?: string|number
7065
7081
  /**
7066
7082
  * 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
7067
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
7083
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
7068
7084
  */
7069
7085
  instantUpdate?: boolean
7070
7086
  /**
@@ -7244,7 +7260,7 @@ type DateColumnConfig = {
7244
7260
  */
7245
7261
  responsiveLevels?: object
7246
7262
  /**
7247
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
7263
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
7248
7264
  * revert the field to the value it had when the edit began. If the value is *not* changed
7249
7265
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
7250
7266
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -7775,6 +7791,8 @@ type NumberColumnConfig = {
7775
7791
  headerMenuItems?: Record<string, MenuItemEntry>
7776
7792
  /**
7777
7793
  * Renderer function for the column header.
7794
+ * ...
7795
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/NumberColumn#config-headerRenderer)
7778
7796
  * @param {object} renderData
7779
7797
  * @param {Grid.column.Column} renderData.column This column
7780
7798
  * @param {HTMLElement} renderData.headerElement The header element
@@ -7825,7 +7843,7 @@ type NumberColumnConfig = {
7825
7843
  id?: string|number
7826
7844
  /**
7827
7845
  * 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
7828
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
7846
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
7829
7847
  */
7830
7848
  instantUpdate?: boolean
7831
7849
  /**
@@ -8010,7 +8028,7 @@ type NumberColumnConfig = {
8010
8028
  */
8011
8029
  responsiveLevels?: object
8012
8030
  /**
8013
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
8031
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
8014
8032
  * revert the field to the value it had when the edit began. If the value is *not* changed
8015
8033
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
8016
8034
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -8552,6 +8570,8 @@ type PercentColumnConfig = {
8552
8570
  headerMenuItems?: Record<string, MenuItemEntry>
8553
8571
  /**
8554
8572
  * Renderer function for the column header.
8573
+ * ...
8574
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/PercentColumn#config-headerRenderer)
8555
8575
  * @param {object} renderData
8556
8576
  * @param {Grid.column.Column} renderData.column This column
8557
8577
  * @param {HTMLElement} renderData.headerElement The header element
@@ -8597,7 +8617,7 @@ type PercentColumnConfig = {
8597
8617
  id?: string|number
8598
8618
  /**
8599
8619
  * 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
8600
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
8620
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
8601
8621
  */
8602
8622
  instantUpdate?: boolean
8603
8623
  /**
@@ -8792,7 +8812,7 @@ type PercentColumnConfig = {
8792
8812
  */
8793
8813
  responsiveLevels?: object
8794
8814
  /**
8795
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
8815
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
8796
8816
  * revert the field to the value it had when the edit began. If the value is *not* changed
8797
8817
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
8798
8818
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -9328,6 +9348,8 @@ type RatingColumnConfig = {
9328
9348
  headerMenuItems?: Record<string, MenuItemEntry>
9329
9349
  /**
9330
9350
  * Renderer function for the column header.
9351
+ * ...
9352
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/RatingColumn#config-headerRenderer)
9331
9353
  * @param {object} renderData
9332
9354
  * @param {Grid.column.Column} renderData.column This column
9333
9355
  * @param {HTMLElement} renderData.headerElement The header element
@@ -9378,7 +9400,7 @@ type RatingColumnConfig = {
9378
9400
  id?: string|number
9379
9401
  /**
9380
9402
  * 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
9381
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
9403
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
9382
9404
  */
9383
9405
  instantUpdate?: boolean
9384
9406
  /**
@@ -9563,7 +9585,7 @@ type RatingColumnConfig = {
9563
9585
  */
9564
9586
  responsiveLevels?: object
9565
9587
  /**
9566
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
9588
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
9567
9589
  * revert the field to the value it had when the edit began. If the value is *not* changed
9568
9590
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
9569
9591
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -10006,6 +10028,8 @@ type RowNumberColumnConfig = {
10006
10028
  headerMenuItems?: Record<string, MenuItemEntry>
10007
10029
  /**
10008
10030
  * Renderer function for the column header.
10031
+ * ...
10032
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/RowNumberColumn#config-headerRenderer)
10009
10033
  * @param {object} renderData
10010
10034
  * @param {Grid.column.Column} renderData.column This column
10011
10035
  * @param {HTMLElement} renderData.headerElement The header element
@@ -10672,6 +10696,8 @@ type SparklineColumnConfig = {
10672
10696
  headerMenuItems?: Record<string, MenuItemEntry>
10673
10697
  /**
10674
10698
  * Renderer function for the column header.
10699
+ * ...
10700
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/SparklineColumn#config-headerRenderer)
10675
10701
  * @param {object} renderData
10676
10702
  * @param {Grid.column.Column} renderData.column This column
10677
10703
  * @param {HTMLElement} renderData.headerElement The header element
@@ -10732,7 +10758,7 @@ type SparklineColumnConfig = {
10732
10758
  id?: string|number
10733
10759
  /**
10734
10760
  * 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
10735
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
10761
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
10736
10762
  */
10737
10763
  instantUpdate?: boolean
10738
10764
  /**
@@ -10908,7 +10934,7 @@ type SparklineColumnConfig = {
10908
10934
  */
10909
10935
  responsiveLevels?: object
10910
10936
  /**
10911
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
10937
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
10912
10938
  * revert the field to the value it had when the edit began. If the value is *not* changed
10913
10939
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
10914
10940
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -11394,6 +11420,8 @@ type TemplateColumnConfig = {
11394
11420
  headerMenuItems?: Record<string, MenuItemEntry>
11395
11421
  /**
11396
11422
  * Renderer function for the column header.
11423
+ * ...
11424
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/TemplateColumn#config-headerRenderer)
11397
11425
  * @param {object} renderData
11398
11426
  * @param {Grid.column.Column} renderData.column This column
11399
11427
  * @param {HTMLElement} renderData.headerElement The header element
@@ -11444,7 +11472,7 @@ type TemplateColumnConfig = {
11444
11472
  id?: string|number
11445
11473
  /**
11446
11474
  * 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
11447
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
11475
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
11448
11476
  */
11449
11477
  instantUpdate?: boolean
11450
11478
  /**
@@ -11616,7 +11644,7 @@ type TemplateColumnConfig = {
11616
11644
  */
11617
11645
  responsiveLevels?: object
11618
11646
  /**
11619
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
11647
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
11620
11648
  * revert the field to the value it had when the edit began. If the value is *not* changed
11621
11649
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
11622
11650
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -12121,6 +12149,8 @@ type TimeColumnConfig = {
12121
12149
  headerMenuItems?: Record<string, MenuItemEntry>
12122
12150
  /**
12123
12151
  * Renderer function for the column header.
12152
+ * ...
12153
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/TimeColumn#config-headerRenderer)
12124
12154
  * @param {object} renderData
12125
12155
  * @param {Grid.column.Column} renderData.column This column
12126
12156
  * @param {HTMLElement} renderData.headerElement The header element
@@ -12171,7 +12201,7 @@ type TimeColumnConfig = {
12171
12201
  id?: string|number
12172
12202
  /**
12173
12203
  * 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
12174
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
12204
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
12175
12205
  */
12176
12206
  instantUpdate?: boolean
12177
12207
  /**
@@ -12343,7 +12373,7 @@ type TimeColumnConfig = {
12343
12373
  */
12344
12374
  responsiveLevels?: object
12345
12375
  /**
12346
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
12376
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
12347
12377
  * revert the field to the value it had when the edit began. If the value is *not* changed
12348
12378
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
12349
12379
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -12851,6 +12881,8 @@ type TreeColumnConfig = {
12851
12881
  headerMenuItems?: Record<string, MenuItemEntry>
12852
12882
  /**
12853
12883
  * Renderer function for the column header.
12884
+ * ...
12885
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/TreeColumn#config-headerRenderer)
12854
12886
  * @param {object} renderData
12855
12887
  * @param {Grid.column.Column} renderData.column This column
12856
12888
  * @param {HTMLElement} renderData.headerElement The header element
@@ -12907,7 +12939,7 @@ type TreeColumnConfig = {
12907
12939
  indentSize?: number
12908
12940
  /**
12909
12941
  * 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
12910
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
12942
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
12911
12943
  */
12912
12944
  instantUpdate?: boolean
12913
12945
  /**
@@ -13083,7 +13115,7 @@ type TreeColumnConfig = {
13083
13115
  */
13084
13116
  responsiveLevels?: object
13085
13117
  /**
13086
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
13118
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
13087
13119
  * revert the field to the value it had when the edit began. If the value is *not* changed
13088
13120
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
13089
13121
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -13608,6 +13640,8 @@ type WidgetColumnConfig = {
13608
13640
  headerMenuItems?: Record<string, MenuItemEntry>
13609
13641
  /**
13610
13642
  * Renderer function for the column header.
13643
+ * ...
13644
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/WidgetColumn#config-headerRenderer)
13611
13645
  * @param {object} renderData
13612
13646
  * @param {Grid.column.Column} renderData.column This column
13613
13647
  * @param {HTMLElement} renderData.headerElement The header element
@@ -13658,7 +13692,7 @@ type WidgetColumnConfig = {
13658
13692
  id?: string|number
13659
13693
  /**
13660
13694
  * 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
13661
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
13695
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
13662
13696
  */
13663
13697
  instantUpdate?: boolean
13664
13698
  /**
@@ -13834,7 +13868,7 @@ type WidgetColumnConfig = {
13834
13868
  */
13835
13869
  responsiveLevels?: object
13836
13870
  /**
13837
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
13871
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
13838
13872
  * revert the field to the value it had when the edit began. If the value is *not* changed
13839
13873
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
13840
13874
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -16527,7 +16561,7 @@ export class CellEdit extends GridEditBase {
16527
16561
  /**
16528
16562
  * Displays an OK / Cancel confirmation dialog box owned by the current Editor. This is intended to be
16529
16563
  * used by [finalizeCellEdit](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-finalizeCellEdit) implementations. The returned promise resolves passing
16530
- * `true` if the "OK" button is pressed, and `false` if the "Cancel" button is pressed. Typing `ESC` rejects.
16564
+ * `true` if the "OK" button is pressed, and `false` if the "Cancel" button is pressed. Typing <kbd>Escape</kbd> rejects.
16531
16565
  * @param {object} options An options object for what to show.
16532
16566
  */
16533
16567
  confirm(options: {
@@ -16791,7 +16825,7 @@ type CellMenuConfig = {
16791
16825
 
16792
16826
  /**
16793
16827
  * Right click to display context menu for cells. To invoke the cell menu in a keyboard-accessible manner, use the
16794
- * `SPACE` key when the cell is focused.
16828
+ * <kbd>Space</kbd> key when the cell is focused.
16795
16829
  * ...
16796
16830
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellMenu)
16797
16831
  */
@@ -17064,7 +17098,7 @@ type CellTooltipConfig = {
17064
17098
  */
17065
17099
  closeAction?: 'hide'|'destroy'
17066
17100
  /**
17067
- * Close popup when `ESC` key is pressed.
17101
+ * Close popup when <kbd>Escape</kbd> key is pressed.
17068
17102
  */
17069
17103
  closeOnEscape?: boolean
17070
17104
  /**
@@ -20676,8 +20710,8 @@ type GroupConfig = {
20676
20710
 
20677
20711
  /**
20678
20712
  * Enables rendering and handling of row groups. The actual grouping is done in the store, but triggered by
20679
- * <kbd>shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
20680
- * one anywhere on grid). Use <kbd>shift</kbd> + <kbd>alt</kbd> + click, or the context menu, to remove a column
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
20681
20715
  * grouper.
20682
20716
  * ...
20683
20717
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Group)
@@ -25959,10 +25993,10 @@ type TreeGroupConfig = {
25959
25993
  */
25960
25994
  parentCls?: string
25961
25995
  /**
25962
- * A function letting you format the text shown in the generated parent group levels. This method will be provided
25963
- * with the value produced by the column representing the grouped level. Each column's renderer method will be
25964
- * provided an extra `isTreeGroup` param to indicate that the value will be used for a generated parent. `cellElement`
25965
- * and other DOM specific args will be in the context of the tree column.
25996
+ * A function letting you format the text shown in the generated parent group levels. This method will be
25997
+ * provided with the value produced by the column representing the grouped level. Each column's renderer method
25998
+ * will be provided an extra `isTreeGroup` param to indicate that the value will be used for a generated parent.
25999
+ * `cellElement` and other DOM specific args will be in the context of the tree column.
25966
26000
  * ...
25967
26001
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/TreeGroup#config-parentRenderer)
25968
26002
  * @param {object} data The rendering data representing the generated tree parent record
@@ -27116,7 +27150,7 @@ type ExcelExporterConfig = {
27116
27150
  */
27117
27151
  localizableProperties?: string[]
27118
27152
  /**
27119
- * This hook allows to use 3rd party libraries to generate XLSX files.
27153
+ * This hook allows using 3rd party libraries to generate XLSX files.
27120
27154
  * ...
27121
27155
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/ExcelExporter#config-xlsProvider)
27122
27156
  */
@@ -29611,7 +29645,7 @@ type SinglePageUnscaledExporterConfig = {
29611
29645
 
29612
29646
  /**
29613
29647
  * 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
29614
- * is exported with dimensions required to fit all requested rows and columns. This allows to generate PDF page not
29648
+ * is exported with dimensions required to fit all requested rows and columns. This allows generating a PDF page not
29615
29649
  * constrained by the standard paper formats.
29616
29650
  * ...
29617
29651
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/export/exporter/SinglePageUnscaledExporter)
@@ -30021,7 +30055,7 @@ type GridListenersTypes = {
30021
30055
  */
30022
30056
  beforeCellEditStart: (event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void
30023
30057
  /**
30024
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
30058
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
30025
30059
  * buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
30026
30060
  * @param {object} event Event object
30027
30061
  * @param {Grid.view.Grid} event.source Owner grid
@@ -30986,6 +31020,14 @@ type GridListenersTypes = {
30986
31020
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
30987
31021
  */
30988
31022
  toolClick: (event: { source: Tool, tool: Tool }) => void
31023
+ /**
31024
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
31025
+ * @param {object} event Event object
31026
+ * @param {Grid.view.Grid} event.source The grid instance
31027
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
31028
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
31029
+ */
31030
+ treeGroup: (event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void
30989
31031
  /**
30990
31032
  * Fires when row locking is disabled.
30991
31033
  * @param {object} event Event object
@@ -31040,7 +31082,7 @@ type GridListeners = {
31040
31082
  */
31041
31083
  beforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
31042
31084
  /**
31043
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
31085
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
31044
31086
  * buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
31045
31087
  * @param {object} event Event object
31046
31088
  * @param {Grid.view.Grid} event.source Owner grid
@@ -32005,6 +32047,14 @@ type GridListeners = {
32005
32047
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
32006
32048
  */
32007
32049
  toolClick?: ((event: { source: Tool, tool: Tool }) => void)|string
32050
+ /**
32051
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
32052
+ * @param {object} event Event object
32053
+ * @param {Grid.view.Grid} event.source The grid instance
32054
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
32055
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
32056
+ */
32057
+ treeGroup?: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string
32008
32058
  /**
32009
32059
  * Fires when row locking is disabled.
32010
32060
  * @param {object} event Event object
@@ -32669,7 +32719,7 @@ type GridConfig = {
32669
32719
  rootElement?: ShadowRoot|HTMLElement
32670
32720
  /**
32671
32721
  * Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
32672
- * overriden by specifying a [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
32722
+ * overridden by specifying a [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
32673
32723
  * a column [renderer](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-renderer).
32674
32724
  * ...
32675
32725
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#config-rowHeight)
@@ -32900,7 +32950,7 @@ type GridConfig = {
32900
32950
  */
32901
32951
  onBeforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
32902
32952
  /**
32903
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
32953
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
32904
32954
  * buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
32905
32955
  * @param {object} event Event object
32906
32956
  * @param {Grid.view.Grid} event.source Owner grid
@@ -33865,6 +33915,14 @@ type GridConfig = {
33865
33915
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
33866
33916
  */
33867
33917
  onToolClick?: ((event: { source: Tool, tool: Tool }) => void)|string
33918
+ /**
33919
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
33920
+ * @param {object} event Event object
33921
+ * @param {Grid.view.Grid} event.source The grid instance
33922
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
33923
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
33924
+ */
33925
+ onTreeGroup?: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string
33868
33926
  /**
33869
33927
  * Fires when row locking is disabled.
33870
33928
  * @param {object} event Event object
@@ -34138,7 +34196,7 @@ type GridBaseListenersTypes = {
34138
34196
  */
34139
34197
  beforeCellEditStart: (event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void
34140
34198
  /**
34141
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
34199
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
34142
34200
  * buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
34143
34201
  * @param {object} event Event object
34144
34202
  * @param {Grid.view.Grid} event.source Owner grid
@@ -35103,6 +35161,14 @@ type GridBaseListenersTypes = {
35103
35161
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
35104
35162
  */
35105
35163
  toolClick: (event: { source: Tool, tool: Tool }) => void
35164
+ /**
35165
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
35166
+ * @param {object} event Event object
35167
+ * @param {Grid.view.Grid} event.source The grid instance
35168
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
35169
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
35170
+ */
35171
+ treeGroup: (event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void
35106
35172
  /**
35107
35173
  * Fires when row locking is disabled.
35108
35174
  * @param {object} event Event object
@@ -35157,7 +35223,7 @@ type GridBaseListeners = {
35157
35223
  */
35158
35224
  beforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
35159
35225
  /**
35160
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
35226
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
35161
35227
  * buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
35162
35228
  * @param {object} event Event object
35163
35229
  * @param {Grid.view.Grid} event.source Owner grid
@@ -36122,6 +36188,14 @@ type GridBaseListeners = {
36122
36188
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
36123
36189
  */
36124
36190
  toolClick?: ((event: { source: Tool, tool: Tool }) => void)|string
36191
+ /**
36192
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
36193
+ * @param {object} event Event object
36194
+ * @param {Grid.view.Grid} event.source The grid instance
36195
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
36196
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
36197
+ */
36198
+ treeGroup?: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string
36125
36199
  /**
36126
36200
  * Fires when row locking is disabled.
36127
36201
  * @param {object} event Event object
@@ -36785,7 +36859,7 @@ type GridBaseConfig = {
36785
36859
  rootElement?: ShadowRoot|HTMLElement
36786
36860
  /**
36787
36861
  * Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
36788
- * overriden by specifying a [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
36862
+ * overridden by specifying a [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
36789
36863
  * a column [renderer](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-renderer).
36790
36864
  * ...
36791
36865
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-rowHeight)
@@ -37016,7 +37090,7 @@ type GridBaseConfig = {
37016
37090
  */
37017
37091
  onBeforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
37018
37092
  /**
37019
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
37093
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
37020
37094
  * buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
37021
37095
  * @param {object} event Event object
37022
37096
  * @param {Grid.view.Grid} event.source Owner grid
@@ -37981,6 +38055,14 @@ type GridBaseConfig = {
37981
38055
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
37982
38056
  */
37983
38057
  onToolClick?: ((event: { source: Tool, tool: Tool }) => void)|string
38058
+ /**
38059
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
38060
+ * @param {object} event Event object
38061
+ * @param {Grid.view.Grid} event.source The grid instance
38062
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
38063
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
38064
+ */
38065
+ onTreeGroup?: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string
37984
38066
  /**
37985
38067
  * Fires when row locking is disabled.
37986
38068
  * @param {object} event Event object
@@ -38244,7 +38326,7 @@ export class GridBase extends Panel {
38244
38326
  readonly responsiveLevel: string
38245
38327
  /**
38246
38328
  * Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
38247
- * overriden by specifying a [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
38329
+ * overridden by specifying a [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
38248
38330
  * a column [renderer](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-renderer).
38249
38331
  */
38250
38332
  rowHeight: number
@@ -38364,7 +38446,7 @@ export class GridBase extends Panel {
38364
38446
  */
38365
38447
  onBeforeCellEditStart: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
38366
38448
  /**
38367
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
38449
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
38368
38450
  * buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
38369
38451
  * @param {object} event Event object
38370
38452
  * @param {Grid.view.Grid} event.source Owner grid
@@ -39193,6 +39275,14 @@ export class GridBase extends Panel {
39193
39275
  * @param {boolean} event.collapse `true` if the node is being collapsed.
39194
39276
  */
39195
39277
  onToggleNode: ((event: { record: Model, collapse: boolean }) => void)|string
39278
+ /**
39279
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
39280
+ * @param {object} event Event object
39281
+ * @param {Grid.view.Grid} event.source The grid instance
39282
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
39283
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
39284
+ */
39285
+ onTreeGroup: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string
39196
39286
  /**
39197
39287
  * Fires when row locking is disabled.
39198
39288
  * @param {object} event Event object
@@ -40683,7 +40773,7 @@ type TreeGridListenersTypes = {
40683
40773
  */
40684
40774
  beforeCellEditStart: (event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void
40685
40775
  /**
40686
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
40776
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
40687
40777
  * buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
40688
40778
  * @param {object} event Event object
40689
40779
  * @param {Grid.view.Grid} event.source Owner grid
@@ -41648,6 +41738,14 @@ type TreeGridListenersTypes = {
41648
41738
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
41649
41739
  */
41650
41740
  toolClick: (event: { source: Tool, tool: Tool }) => void
41741
+ /**
41742
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
41743
+ * @param {object} event Event object
41744
+ * @param {Grid.view.Grid} event.source The grid instance
41745
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
41746
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
41747
+ */
41748
+ treeGroup: (event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void
41651
41749
  /**
41652
41750
  * Fires when row locking is disabled.
41653
41751
  * @param {object} event Event object
@@ -41702,7 +41800,7 @@ type TreeGridListeners = {
41702
41800
  */
41703
41801
  beforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
41704
41802
  /**
41705
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
41803
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
41706
41804
  * buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
41707
41805
  * @param {object} event Event object
41708
41806
  * @param {Grid.view.Grid} event.source Owner grid
@@ -42667,6 +42765,14 @@ type TreeGridListeners = {
42667
42765
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
42668
42766
  */
42669
42767
  toolClick?: ((event: { source: Tool, tool: Tool }) => void)|string
42768
+ /**
42769
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
42770
+ * @param {object} event Event object
42771
+ * @param {Grid.view.Grid} event.source The grid instance
42772
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
42773
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
42774
+ */
42775
+ treeGroup?: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string
42670
42776
  /**
42671
42777
  * Fires when row locking is disabled.
42672
42778
  * @param {object} event Event object
@@ -43331,7 +43437,7 @@ type TreeGridConfig = {
43331
43437
  rootElement?: ShadowRoot|HTMLElement
43332
43438
  /**
43333
43439
  * Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
43334
- * overriden by specifying a [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
43440
+ * overridden by specifying a [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
43335
43441
  * a column [renderer](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-renderer).
43336
43442
  * ...
43337
43443
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-rowHeight)
@@ -43562,7 +43668,7 @@ type TreeGridConfig = {
43562
43668
  */
43563
43669
  onBeforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
43564
43670
  /**
43565
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
43671
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
43566
43672
  * buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
43567
43673
  * @param {object} event Event object
43568
43674
  * @param {Grid.view.Grid} event.source Owner grid
@@ -44527,6 +44633,14 @@ type TreeGridConfig = {
44527
44633
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
44528
44634
  */
44529
44635
  onToolClick?: ((event: { source: Tool, tool: Tool }) => void)|string
44636
+ /**
44637
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
44638
+ * @param {object} event Event object
44639
+ * @param {Grid.view.Grid} event.source The grid instance
44640
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
44641
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
44642
+ */
44643
+ onTreeGroup?: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string
44530
44644
  /**
44531
44645
  * Fires when row locking is disabled.
44532
44646
  * @param {object} event Event object
@@ -45272,7 +45386,7 @@ type ExportDialogConfig = {
45272
45386
  */
45273
45387
  closeAction?: 'hide'|'destroy'
45274
45388
  /**
45275
- * Close popup when `ESC` key is pressed.
45389
+ * Close popup when <kbd>Escape</kbd> key is pressed.
45276
45390
  */
45277
45391
  closeOnEscape?: boolean
45278
45392
  /**
@@ -47723,7 +47837,7 @@ type AIFilterFieldConfig = {
47723
47837
  required?: boolean
47724
47838
  /**
47725
47839
  * 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
47726
- * the `ESCAPE` key after editing the field will revert the field to the value it had when
47840
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
47727
47841
  * 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)
47728
47842
  * behaviour will be activated.
47729
47843
  */
@@ -48582,7 +48696,7 @@ type ChecklistFilterComboConfig = {
48582
48696
  contentElementCls?: string|object
48583
48697
  /**
48584
48698
  * If configured as `true`, this means that when an unmatched string is typed into the
48585
- * combo's input field, and `ENTER`, or the [multiValueSeparator](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-multiValueSeparator) is typed,
48699
+ * 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,
48586
48700
  * 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).
48587
48701
  * ...
48588
48702
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-createOnUnmatched)
@@ -49082,7 +49196,7 @@ type ChecklistFilterComboConfig = {
49082
49196
  required?: boolean
49083
49197
  /**
49084
49198
  * 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
49085
- * the `ESCAPE` key after editing the field will revert the field to the value it had when
49199
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
49086
49200
  * 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)
49087
49201
  * behaviour will be activated.
49088
49202
  */
@@ -53396,7 +53510,7 @@ type GroupBarConfig = {
53396
53510
  */
53397
53511
  title?: string
53398
53512
  /**
53399
- * Select/deselect all if `CMD`/`CTRL` is pressed when clicking
53513
+ * Select/deselect all if <kbd>Cmd</kbd>/<kbd>Ctrl</kbd> is pressed when clicking
53400
53514
  */
53401
53515
  toggleAllIfCtrlPressed?: boolean
53402
53516
  /**
@@ -54156,7 +54270,7 @@ type TreeComboConfig = {
54156
54270
  contentElementCls?: string|object
54157
54271
  /**
54158
54272
  * If configured as `true`, this means that when an unmatched string is typed into the
54159
- * combo's input field, and `ENTER`, or the [multiValueSeparator](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-multiValueSeparator) is typed,
54273
+ * 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,
54160
54274
  * 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).
54161
54275
  * ...
54162
54276
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-createOnUnmatched)
@@ -54656,7 +54770,7 @@ type TreeComboConfig = {
54656
54770
  required?: boolean
54657
54771
  /**
54658
54772
  * 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
54659
- * the `ESCAPE` key after editing the field will revert the field to the value it had when
54773
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
54660
54774
  * 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)
54661
54775
  * behaviour will be activated.
54662
54776
  */