@bryntum/grid-thin-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.
Files changed (54) hide show
  1. package/fluent2-dark.css +31 -31
  2. package/grid.css +9 -5
  3. package/grid.css.map +3 -3
  4. package/grid.d.ts +183 -91
  5. package/high-contrast-dark.css +32 -32
  6. package/lib/column/ActionColumn.js +1 -1
  7. package/lib/column/Column.js +1 -1
  8. package/lib/column/WidgetColumn.js +1 -1
  9. package/lib/data/ColumnStore.js +1 -1
  10. package/lib/feature/CellCopyPaste.js +1 -1
  11. package/lib/feature/CellEdit.js +1 -1
  12. package/lib/feature/CellMenu.js +1 -1
  13. package/lib/feature/ColumnRename.js +1 -1
  14. package/lib/feature/Filter.js +1 -1
  15. package/lib/feature/Group.js +1 -1
  16. package/lib/feature/HeaderMenu.js +1 -1
  17. package/lib/feature/LockRows.js +1 -1
  18. package/lib/feature/QuickFind.js +1 -1
  19. package/lib/feature/RegionResize.js +1 -1
  20. package/lib/feature/RowCopyPaste.css +3 -0
  21. package/lib/feature/RowCopyPaste.js +1 -1
  22. package/lib/feature/RowExpander.js +1 -1
  23. package/lib/feature/Search.js +1 -1
  24. package/lib/feature/Sort.js +1 -1
  25. package/lib/feature/Split.js +1 -1
  26. package/lib/feature/Tree.js +1 -1
  27. package/lib/feature/TreeGroup.js +1 -1
  28. package/lib/feature/base/CopyPasteBase.js +1 -1
  29. package/lib/feature/experimental/ExcelExporter.js +1 -1
  30. package/lib/feature/export/PdfExport.js +3 -3
  31. package/lib/feature/export/consumer/MemoryConsumer.js +1 -0
  32. package/lib/feature/export/exporter/ExporterBase.js +6 -6
  33. package/lib/feature/export/exporter/SinglePageUnscaledExporter.js +1 -1
  34. package/lib/override/salesforce/RowOverride.js +1 -1
  35. package/lib/row/RowManager.js +1 -1
  36. package/lib/util/TableExporter.js +1 -1
  37. package/lib/view/Grid.js +1 -1
  38. package/lib/view/GridBase.js +1 -1
  39. package/lib/view/Header.js +1 -1
  40. package/lib/view/SubGrid.css +3 -4
  41. package/lib/view/SubGrid.js +1 -1
  42. package/lib/view/mixin/GridElementEvents.js +1 -1
  43. package/lib/view/mixin/GridNavigation.js +1 -1
  44. package/lib/view/mixin/GridSelection.js +1 -1
  45. package/lib/view/mixin/GridState.js +1 -1
  46. package/lib/widget/GroupBar.js +1 -1
  47. package/locales/grid.locale.De.js +1 -1
  48. package/material3-dark.css +38 -33
  49. package/material3-light.css +7 -1
  50. package/package.json +1 -1
  51. package/stockholm-dark.css +32 -32
  52. package/svalbard-dark.css +32 -32
  53. package/visby-dark.css +33 -32
  54. package/visby-light.css +1 -0
package/grid.d.ts CHANGED
@@ -872,8 +872,9 @@ type ActionColumnConfig = {
872
872
  * @param {object} renderData
873
873
  * @param {Grid.column.Column} renderData.column This column
874
874
  * @param {HTMLElement} renderData.headerElement The header element
875
+ * @returns {string,object,void,void} The text or markup to show in the column header
875
876
  */
876
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
877
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
877
878
  /**
878
879
  * An array of the widgets to append to the column header. These widgets have this Column instance
879
880
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -914,7 +915,7 @@ type ActionColumnConfig = {
914
915
  id?: string|number
915
916
  /**
916
917
  * 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
917
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
918
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
918
919
  */
919
920
  instantUpdate?: boolean
920
921
  /**
@@ -1082,7 +1083,7 @@ type ActionColumnConfig = {
1082
1083
  */
1083
1084
  responsiveLevels?: object
1084
1085
  /**
1085
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
1086
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
1086
1087
  * revert the field to the value it had when the edit began. If the value is *not* changed
1087
1088
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
1088
1089
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -1591,8 +1592,9 @@ type AggregateColumnConfig = {
1591
1592
  * @param {object} renderData
1592
1593
  * @param {Grid.column.Column} renderData.column This column
1593
1594
  * @param {HTMLElement} renderData.headerElement The header element
1595
+ * @returns {string,object,void,void} The text or markup to show in the column header
1594
1596
  */
1595
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
1597
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
1596
1598
  /**
1597
1599
  * An array of the widgets to append to the column header. These widgets have this Column instance
1598
1600
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -1646,7 +1648,7 @@ type AggregateColumnConfig = {
1646
1648
  includeParentInChangeSet?: boolean
1647
1649
  /**
1648
1650
  * 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
1649
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
1651
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
1650
1652
  */
1651
1653
  instantUpdate?: boolean
1652
1654
  /**
@@ -1831,7 +1833,7 @@ type AggregateColumnConfig = {
1831
1833
  */
1832
1834
  responsiveLevels?: object
1833
1835
  /**
1834
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
1836
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
1835
1837
  * revert the field to the value it had when the edit began. If the value is *not* changed
1836
1838
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
1837
1839
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -2361,8 +2363,9 @@ type ChartColumnConfig = {
2361
2363
  * @param {object} renderData
2362
2364
  * @param {Grid.column.Column} renderData.column This column
2363
2365
  * @param {HTMLElement} renderData.headerElement The header element
2366
+ * @returns {string,object,void,void} The text or markup to show in the column header
2364
2367
  */
2365
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
2368
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
2366
2369
  /**
2367
2370
  * An array of the widgets to append to the column header. These widgets have this Column instance
2368
2371
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -2408,7 +2411,7 @@ type ChartColumnConfig = {
2408
2411
  id?: string|number
2409
2412
  /**
2410
2413
  * 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
2411
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
2414
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
2412
2415
  */
2413
2416
  instantUpdate?: boolean
2414
2417
  /**
@@ -2584,7 +2587,7 @@ type ChartColumnConfig = {
2584
2587
  */
2585
2588
  responsiveLevels?: object
2586
2589
  /**
2587
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
2590
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
2588
2591
  * revert the field to the value it had when the edit began. If the value is *not* changed
2589
2592
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
2590
2593
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -3136,8 +3139,9 @@ type CheckColumnConfig = {
3136
3139
  * @param {object} renderData
3137
3140
  * @param {Grid.column.Column} renderData.column This column
3138
3141
  * @param {HTMLElement} renderData.headerElement The header element
3142
+ * @returns {string,object,void,void} The text or markup to show in the column header
3139
3143
  */
3140
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
3144
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
3141
3145
  /**
3142
3146
  * An array of the widgets to append to the column header. These widgets have this Column instance
3143
3147
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -3183,7 +3187,7 @@ type CheckColumnConfig = {
3183
3187
  id?: string|number
3184
3188
  /**
3185
3189
  * 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
3186
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
3190
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
3187
3191
  */
3188
3192
  instantUpdate?: boolean
3189
3193
  /**
@@ -3359,7 +3363,7 @@ type CheckColumnConfig = {
3359
3363
  */
3360
3364
  responsiveLevels?: object
3361
3365
  /**
3362
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
3366
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
3363
3367
  * revert the field to the value it had when the edit began. If the value is *not* changed
3364
3368
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
3365
3369
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -3926,8 +3930,9 @@ type ColorColumnConfig = {
3926
3930
  * @param {object} renderData
3927
3931
  * @param {Grid.column.Column} renderData.column This column
3928
3932
  * @param {HTMLElement} renderData.headerElement The header element
3933
+ * @returns {string,object,void,void} The text or markup to show in the column header
3929
3934
  */
3930
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
3935
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
3931
3936
  /**
3932
3937
  * An array of the widgets to append to the column header. These widgets have this Column instance
3933
3938
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -3973,7 +3978,7 @@ type ColorColumnConfig = {
3973
3978
  id?: string|number
3974
3979
  /**
3975
3980
  * 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
3976
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
3981
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
3977
3982
  */
3978
3983
  instantUpdate?: boolean
3979
3984
  /**
@@ -4145,7 +4150,7 @@ type ColorColumnConfig = {
4145
4150
  */
4146
4151
  responsiveLevels?: object
4147
4152
  /**
4148
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
4153
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
4149
4154
  * revert the field to the value it had when the edit began. If the value is *not* changed
4150
4155
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
4151
4156
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -4661,8 +4666,9 @@ type ColumnConfig = {
4661
4666
  * @param {object} renderData
4662
4667
  * @param {Grid.column.Column} renderData.column This column
4663
4668
  * @param {HTMLElement} renderData.headerElement The header element
4669
+ * @returns {string,object,void,void} The text or markup to show in the column header
4664
4670
  */
4665
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
4671
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
4666
4672
  /**
4667
4673
  * An array of the widgets to append to the column header. These widgets have this Column instance
4668
4674
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -4708,7 +4714,7 @@ type ColumnConfig = {
4708
4714
  id?: string|number
4709
4715
  /**
4710
4716
  * 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
4711
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
4717
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
4712
4718
  */
4713
4719
  instantUpdate?: boolean
4714
4720
  /**
@@ -4880,7 +4886,7 @@ type ColumnConfig = {
4880
4886
  */
4881
4887
  responsiveLevels?: object
4882
4888
  /**
4883
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
4889
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
4884
4890
  * revert the field to the value it had when the edit began. If the value is *not* changed
4885
4891
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
4886
4892
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -5210,7 +5216,7 @@ export class Column extends Model {
5210
5216
  /**
5211
5217
  * Renderer function for the column header.
5212
5218
  */
5213
- headerRenderer: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
5219
+ headerRenderer: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
5214
5220
  /**
5215
5221
  * An array of the widgets to append to the column header. These widgets have this Column instance
5216
5222
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -5245,7 +5251,7 @@ export class Column extends Model {
5245
5251
  icon: string
5246
5252
  /**
5247
5253
  * 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
5248
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
5254
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
5249
5255
  */
5250
5256
  instantUpdate: boolean
5251
5257
  /**
@@ -5341,7 +5347,7 @@ export class Column extends Model {
5341
5347
  */
5342
5348
  responsiveLevels: object
5343
5349
  /**
5344
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
5350
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
5345
5351
  * revert the field to the value it had when the edit began. If the value is *not* changed
5346
5352
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
5347
5353
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -5958,8 +5964,9 @@ type CurrencyColumnConfig = {
5958
5964
  * @param {object} renderData
5959
5965
  * @param {Grid.column.Column} renderData.column This column
5960
5966
  * @param {HTMLElement} renderData.headerElement The header element
5967
+ * @returns {string,object,void,void} The text or markup to show in the column header
5961
5968
  */
5962
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
5969
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
5963
5970
  /**
5964
5971
  * An array of the widgets to append to the column header. These widgets have this Column instance
5965
5972
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -6010,7 +6017,7 @@ type CurrencyColumnConfig = {
6010
6017
  id?: string|number
6011
6018
  /**
6012
6019
  * 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
6013
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
6020
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
6014
6021
  */
6015
6022
  instantUpdate?: boolean
6016
6023
  /**
@@ -6195,7 +6202,7 @@ type CurrencyColumnConfig = {
6195
6202
  */
6196
6203
  responsiveLevels?: object
6197
6204
  /**
6198
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
6205
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
6199
6206
  * revert the field to the value it had when the edit began. If the value is *not* changed
6200
6207
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
6201
6208
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -6710,8 +6717,9 @@ type DateColumnConfig = {
6710
6717
  * @param {object} renderData
6711
6718
  * @param {Grid.column.Column} renderData.column This column
6712
6719
  * @param {HTMLElement} renderData.headerElement The header element
6720
+ * @returns {string,object,void,void} The text or markup to show in the column header
6713
6721
  */
6714
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
6722
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
6715
6723
  /**
6716
6724
  * An array of the widgets to append to the column header. These widgets have this Column instance
6717
6725
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -6757,7 +6765,7 @@ type DateColumnConfig = {
6757
6765
  id?: string|number
6758
6766
  /**
6759
6767
  * 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
6760
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
6768
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
6761
6769
  */
6762
6770
  instantUpdate?: boolean
6763
6771
  /**
@@ -6937,7 +6945,7 @@ type DateColumnConfig = {
6937
6945
  */
6938
6946
  responsiveLevels?: object
6939
6947
  /**
6940
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
6948
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
6941
6949
  * revert the field to the value it had when the edit began. If the value is *not* changed
6942
6950
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
6943
6951
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -7473,8 +7481,9 @@ type NumberColumnConfig = {
7473
7481
  * @param {object} renderData
7474
7482
  * @param {Grid.column.Column} renderData.column This column
7475
7483
  * @param {HTMLElement} renderData.headerElement The header element
7484
+ * @returns {string,object,void,void} The text or markup to show in the column header
7476
7485
  */
7477
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
7486
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
7478
7487
  /**
7479
7488
  * An array of the widgets to append to the column header. These widgets have this Column instance
7480
7489
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -7520,7 +7529,7 @@ type NumberColumnConfig = {
7520
7529
  id?: string|number
7521
7530
  /**
7522
7531
  * 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
7523
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
7532
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
7524
7533
  */
7525
7534
  instantUpdate?: boolean
7526
7535
  /**
@@ -7705,7 +7714,7 @@ type NumberColumnConfig = {
7705
7714
  */
7706
7715
  responsiveLevels?: object
7707
7716
  /**
7708
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
7717
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
7709
7718
  * revert the field to the value it had when the edit began. If the value is *not* changed
7710
7719
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
7711
7720
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -8252,8 +8261,9 @@ type PercentColumnConfig = {
8252
8261
  * @param {object} renderData
8253
8262
  * @param {Grid.column.Column} renderData.column This column
8254
8263
  * @param {HTMLElement} renderData.headerElement The header element
8264
+ * @returns {string,object,void,void} The text or markup to show in the column header
8255
8265
  */
8256
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
8266
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
8257
8267
  /**
8258
8268
  * An array of the widgets to append to the column header. These widgets have this Column instance
8259
8269
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -8294,7 +8304,7 @@ type PercentColumnConfig = {
8294
8304
  id?: string|number
8295
8305
  /**
8296
8306
  * 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
8297
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
8307
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
8298
8308
  */
8299
8309
  instantUpdate?: boolean
8300
8310
  /**
@@ -8489,7 +8499,7 @@ type PercentColumnConfig = {
8489
8499
  */
8490
8500
  responsiveLevels?: object
8491
8501
  /**
8492
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
8502
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
8493
8503
  * revert the field to the value it had when the edit began. If the value is *not* changed
8494
8504
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
8495
8505
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -9030,8 +9040,9 @@ type RatingColumnConfig = {
9030
9040
  * @param {object} renderData
9031
9041
  * @param {Grid.column.Column} renderData.column This column
9032
9042
  * @param {HTMLElement} renderData.headerElement The header element
9043
+ * @returns {string,object,void,void} The text or markup to show in the column header
9033
9044
  */
9034
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
9045
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
9035
9046
  /**
9036
9047
  * An array of the widgets to append to the column header. These widgets have this Column instance
9037
9048
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -9077,7 +9088,7 @@ type RatingColumnConfig = {
9077
9088
  id?: string|number
9078
9089
  /**
9079
9090
  * 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
9080
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
9091
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
9081
9092
  */
9082
9093
  instantUpdate?: boolean
9083
9094
  /**
@@ -9262,7 +9273,7 @@ type RatingColumnConfig = {
9262
9273
  */
9263
9274
  responsiveLevels?: object
9264
9275
  /**
9265
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
9276
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
9266
9277
  * revert the field to the value it had when the edit began. If the value is *not* changed
9267
9278
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
9268
9279
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -9710,8 +9721,9 @@ type RowNumberColumnConfig = {
9710
9721
  * @param {object} renderData
9711
9722
  * @param {Grid.column.Column} renderData.column This column
9712
9723
  * @param {HTMLElement} renderData.headerElement The header element
9724
+ * @returns {string,object,void,void} The text or markup to show in the column header
9713
9725
  */
9714
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
9726
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
9715
9727
  /**
9716
9728
  * An array of the widgets to append to the column header. These widgets have this Column instance
9717
9729
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -10378,8 +10390,9 @@ type SparklineColumnConfig = {
10378
10390
  * @param {object} renderData
10379
10391
  * @param {Grid.column.Column} renderData.column This column
10380
10392
  * @param {HTMLElement} renderData.headerElement The header element
10393
+ * @returns {string,object,void,void} The text or markup to show in the column header
10381
10394
  */
10382
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
10395
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
10383
10396
  /**
10384
10397
  * An array of the widgets to append to the column header. These widgets have this Column instance
10385
10398
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -10435,7 +10448,7 @@ type SparklineColumnConfig = {
10435
10448
  id?: string|number
10436
10449
  /**
10437
10450
  * 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
10438
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
10451
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
10439
10452
  */
10440
10453
  instantUpdate?: boolean
10441
10454
  /**
@@ -10611,7 +10624,7 @@ type SparklineColumnConfig = {
10611
10624
  */
10612
10625
  responsiveLevels?: object
10613
10626
  /**
10614
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
10627
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
10615
10628
  * revert the field to the value it had when the edit began. If the value is *not* changed
10616
10629
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
10617
10630
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -11102,8 +11115,9 @@ type TemplateColumnConfig = {
11102
11115
  * @param {object} renderData
11103
11116
  * @param {Grid.column.Column} renderData.column This column
11104
11117
  * @param {HTMLElement} renderData.headerElement The header element
11118
+ * @returns {string,object,void,void} The text or markup to show in the column header
11105
11119
  */
11106
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
11120
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
11107
11121
  /**
11108
11122
  * An array of the widgets to append to the column header. These widgets have this Column instance
11109
11123
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -11149,7 +11163,7 @@ type TemplateColumnConfig = {
11149
11163
  id?: string|number
11150
11164
  /**
11151
11165
  * 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
11152
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
11166
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
11153
11167
  */
11154
11168
  instantUpdate?: boolean
11155
11169
  /**
@@ -11321,7 +11335,7 @@ type TemplateColumnConfig = {
11321
11335
  */
11322
11336
  responsiveLevels?: object
11323
11337
  /**
11324
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
11338
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
11325
11339
  * revert the field to the value it had when the edit began. If the value is *not* changed
11326
11340
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
11327
11341
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -11831,8 +11845,9 @@ type TimeColumnConfig = {
11831
11845
  * @param {object} renderData
11832
11846
  * @param {Grid.column.Column} renderData.column This column
11833
11847
  * @param {HTMLElement} renderData.headerElement The header element
11848
+ * @returns {string,object,void,void} The text or markup to show in the column header
11834
11849
  */
11835
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
11850
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
11836
11851
  /**
11837
11852
  * An array of the widgets to append to the column header. These widgets have this Column instance
11838
11853
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -11878,7 +11893,7 @@ type TimeColumnConfig = {
11878
11893
  id?: string|number
11879
11894
  /**
11880
11895
  * 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
11881
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
11896
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
11882
11897
  */
11883
11898
  instantUpdate?: boolean
11884
11899
  /**
@@ -12050,7 +12065,7 @@ type TimeColumnConfig = {
12050
12065
  */
12051
12066
  responsiveLevels?: object
12052
12067
  /**
12053
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
12068
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
12054
12069
  * revert the field to the value it had when the edit began. If the value is *not* changed
12055
12070
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
12056
12071
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -12563,8 +12578,9 @@ type TreeColumnConfig = {
12563
12578
  * @param {object} renderData
12564
12579
  * @param {Grid.column.Column} renderData.column This column
12565
12580
  * @param {HTMLElement} renderData.headerElement The header element
12581
+ * @returns {string,object,void,void} The text or markup to show in the column header
12566
12582
  */
12567
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
12583
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
12568
12584
  /**
12569
12585
  * An array of the widgets to append to the column header. These widgets have this Column instance
12570
12586
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -12616,7 +12632,7 @@ type TreeColumnConfig = {
12616
12632
  indentSize?: number
12617
12633
  /**
12618
12634
  * 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
12619
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
12635
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
12620
12636
  */
12621
12637
  instantUpdate?: boolean
12622
12638
  /**
@@ -12792,7 +12808,7 @@ type TreeColumnConfig = {
12792
12808
  */
12793
12809
  responsiveLevels?: object
12794
12810
  /**
12795
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
12811
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
12796
12812
  * revert the field to the value it had when the edit began. If the value is *not* changed
12797
12813
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
12798
12814
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -13322,8 +13338,9 @@ type WidgetColumnConfig = {
13322
13338
  * @param {object} renderData
13323
13339
  * @param {Grid.column.Column} renderData.column This column
13324
13340
  * @param {HTMLElement} renderData.headerElement The header element
13341
+ * @returns {string,object,void,void} The text or markup to show in the column header
13325
13342
  */
13326
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
13343
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
13327
13344
  /**
13328
13345
  * An array of the widgets to append to the column header. These widgets have this Column instance
13329
13346
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -13369,7 +13386,7 @@ type WidgetColumnConfig = {
13369
13386
  id?: string|number
13370
13387
  /**
13371
13388
  * 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
13372
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
13389
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
13373
13390
  */
13374
13391
  instantUpdate?: boolean
13375
13392
  /**
@@ -13545,7 +13562,7 @@ type WidgetColumnConfig = {
13545
13562
  */
13546
13563
  responsiveLevels?: object
13547
13564
  /**
13548
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
13565
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
13549
13566
  * revert the field to the value it had when the edit began. If the value is *not* changed
13550
13567
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
13551
13568
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -15135,16 +15152,11 @@ export class ColumnStore extends Store {
15135
15152
  */
15136
15153
  static registerColumnType(columnClass: Function, simpleRenderer?: boolean): void;
15137
15154
  /**
15138
- * 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
15139
- * columns id instead.
15155
+ * Get column by field. To be sure that you are getting exactly the intended column, use
15156
+ * [getById](https://bryntum.com/products/grid/docs/api/Core/data/Store#function-getById) with the columns id instead.
15140
15157
  * @param {string} field Field name
15141
15158
  */
15142
15159
  get(field: string): Column;
15143
- /**
15144
- * Get column by id.
15145
- * @param {string,number} id
15146
- */
15147
- getById(id: string|number): Column;
15148
15160
  /**
15149
15161
  * indexOf extended to also accept a columns field, for backward compatibility.
15150
15162
  * @param {Core.data.Model,string} recordOrId
@@ -16238,7 +16250,7 @@ export class CellEdit extends GridEditBase {
16238
16250
  /**
16239
16251
  * Displays an OK / Cancel confirmation dialog box owned by the current Editor. This is intended to be
16240
16252
  * used by [finalizeCellEdit](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-finalizeCellEdit) implementations. The returned promise resolves passing
16241
- * `true` if the "OK" button is pressed, and `false` if the "Cancel" button is pressed. Typing `ESC` rejects.
16253
+ * `true` if the "OK" button is pressed, and `false` if the "Cancel" button is pressed. Typing <kbd>Escape</kbd> rejects.
16242
16254
  * @param {object} options An options object for what to show.
16243
16255
  */
16244
16256
  confirm(options: {
@@ -16502,7 +16514,7 @@ type CellMenuConfig = {
16502
16514
 
16503
16515
  /**
16504
16516
  * Right click to display context menu for cells. To invoke the cell menu in a keyboard-accessible manner, use the
16505
- * `SPACE` key when the cell is focused.
16517
+ * <kbd>Space</kbd> key when the cell is focused.
16506
16518
  * ...
16507
16519
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellMenu)
16508
16520
  */
@@ -16775,7 +16787,7 @@ type CellTooltipConfig = {
16775
16787
  */
16776
16788
  closeAction?: 'hide'|'destroy'
16777
16789
  /**
16778
- * Close popup when `ESC` key is pressed.
16790
+ * Close popup when <kbd>Escape</kbd> key is pressed.
16779
16791
  */
16780
16792
  closeOnEscape?: boolean
16781
16793
  /**
@@ -20387,8 +20399,8 @@ type GroupConfig = {
20387
20399
 
20388
20400
  /**
20389
20401
  * Enables rendering and handling of row groups. The actual grouping is done in the store, but triggered by
20390
- * <kbd>shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
20391
- * one anywhere on grid). Use <kbd>shift</kbd> + <kbd>alt</kbd> + click, or the context menu, to remove a column
20402
+ * <kbd>Shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
20403
+ * one anywhere on grid). Use <kbd>Shift</kbd> + <kbd>Alt</kbd> + click, or the context menu, to remove a column
20392
20404
  * grouper.
20393
20405
  * ...
20394
20406
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Group)
@@ -25670,10 +25682,10 @@ type TreeGroupConfig = {
25670
25682
  */
25671
25683
  parentCls?: string
25672
25684
  /**
25673
- * A function letting you format the text shown in the generated parent group levels. This method will be provided
25674
- * with the value produced by the column representing the grouped level. Each column's renderer method will be
25675
- * provided an extra `isTreeGroup` param to indicate that the value will be used for a generated parent. `cellElement`
25676
- * and other DOM specific args will be in the context of the tree column.
25685
+ * A function letting you format the text shown in the generated parent group levels. This method will be
25686
+ * provided with the value produced by the column representing the grouped level. Each column's renderer method
25687
+ * will be provided an extra `isTreeGroup` param to indicate that the value will be used for a generated parent.
25688
+ * `cellElement` and other DOM specific args will be in the context of the tree column.
25677
25689
  * ...
25678
25690
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/TreeGroup#config-parentRenderer)
25679
25691
  * @param {object} data The rendering data representing the generated tree parent record
@@ -26827,7 +26839,7 @@ type ExcelExporterConfig = {
26827
26839
  */
26828
26840
  localizableProperties?: string[]
26829
26841
  /**
26830
- * This hook allows to use 3rd party libraries to generate XLSX files.
26842
+ * This hook allows using 3rd party libraries to generate XLSX files.
26831
26843
  * ...
26832
26844
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/ExcelExporter#config-xlsProvider)
26833
26845
  */
@@ -29322,7 +29334,7 @@ type SinglePageUnscaledExporterConfig = {
29322
29334
 
29323
29335
  /**
29324
29336
  * 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
29325
- * is exported with dimensions required to fit all requested rows and columns. This allows to generate PDF page not
29337
+ * is exported with dimensions required to fit all requested rows and columns. This allows generating a PDF page not
29326
29338
  * constrained by the standard paper formats.
29327
29339
  * ...
29328
29340
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/export/exporter/SinglePageUnscaledExporter)
@@ -29732,7 +29744,7 @@ type GridListenersTypes = {
29732
29744
  */
29733
29745
  beforeCellEditStart: (event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void
29734
29746
  /**
29735
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
29747
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
29736
29748
  * buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
29737
29749
  * @param {object} event Event object
29738
29750
  * @param {Grid.view.Grid} event.source Owner grid
@@ -30697,6 +30709,14 @@ type GridListenersTypes = {
30697
30709
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
30698
30710
  */
30699
30711
  toolClick: (event: { source: Tool, tool: Tool }) => void
30712
+ /**
30713
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
30714
+ * @param {object} event Event object
30715
+ * @param {Grid.view.Grid} event.source The grid instance
30716
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
30717
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
30718
+ */
30719
+ treeGroup: (event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void
30700
30720
  /**
30701
30721
  * Fires when row locking is disabled.
30702
30722
  * @param {object} event Event object
@@ -30751,7 +30771,7 @@ type GridListeners = {
30751
30771
  */
30752
30772
  beforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
30753
30773
  /**
30754
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
30774
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
30755
30775
  * buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
30756
30776
  * @param {object} event Event object
30757
30777
  * @param {Grid.view.Grid} event.source Owner grid
@@ -31716,6 +31736,14 @@ type GridListeners = {
31716
31736
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
31717
31737
  */
31718
31738
  toolClick?: ((event: { source: Tool, tool: Tool }) => void)|string
31739
+ /**
31740
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
31741
+ * @param {object} event Event object
31742
+ * @param {Grid.view.Grid} event.source The grid instance
31743
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
31744
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
31745
+ */
31746
+ treeGroup?: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string
31719
31747
  /**
31720
31748
  * Fires when row locking is disabled.
31721
31749
  * @param {object} event Event object
@@ -32380,7 +32408,7 @@ type GridConfig = {
32380
32408
  rootElement?: ShadowRoot|HTMLElement
32381
32409
  /**
32382
32410
  * Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
32383
- * overriden by specifying a [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
32411
+ * overridden by specifying a [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
32384
32412
  * a column [renderer](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-renderer).
32385
32413
  * ...
32386
32414
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#config-rowHeight)
@@ -32611,7 +32639,7 @@ type GridConfig = {
32611
32639
  */
32612
32640
  onBeforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
32613
32641
  /**
32614
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
32642
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
32615
32643
  * buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
32616
32644
  * @param {object} event Event object
32617
32645
  * @param {Grid.view.Grid} event.source Owner grid
@@ -33576,6 +33604,14 @@ type GridConfig = {
33576
33604
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
33577
33605
  */
33578
33606
  onToolClick?: ((event: { source: Tool, tool: Tool }) => void)|string
33607
+ /**
33608
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
33609
+ * @param {object} event Event object
33610
+ * @param {Grid.view.Grid} event.source The grid instance
33611
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
33612
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
33613
+ */
33614
+ onTreeGroup?: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string
33579
33615
  /**
33580
33616
  * Fires when row locking is disabled.
33581
33617
  * @param {object} event Event object
@@ -33849,7 +33885,7 @@ type GridBaseListenersTypes = {
33849
33885
  */
33850
33886
  beforeCellEditStart: (event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void
33851
33887
  /**
33852
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
33888
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
33853
33889
  * buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
33854
33890
  * @param {object} event Event object
33855
33891
  * @param {Grid.view.Grid} event.source Owner grid
@@ -34814,6 +34850,14 @@ type GridBaseListenersTypes = {
34814
34850
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
34815
34851
  */
34816
34852
  toolClick: (event: { source: Tool, tool: Tool }) => void
34853
+ /**
34854
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
34855
+ * @param {object} event Event object
34856
+ * @param {Grid.view.Grid} event.source The grid instance
34857
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
34858
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
34859
+ */
34860
+ treeGroup: (event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void
34817
34861
  /**
34818
34862
  * Fires when row locking is disabled.
34819
34863
  * @param {object} event Event object
@@ -34868,7 +34912,7 @@ type GridBaseListeners = {
34868
34912
  */
34869
34913
  beforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
34870
34914
  /**
34871
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
34915
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
34872
34916
  * buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
34873
34917
  * @param {object} event Event object
34874
34918
  * @param {Grid.view.Grid} event.source Owner grid
@@ -35833,6 +35877,14 @@ type GridBaseListeners = {
35833
35877
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
35834
35878
  */
35835
35879
  toolClick?: ((event: { source: Tool, tool: Tool }) => void)|string
35880
+ /**
35881
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
35882
+ * @param {object} event Event object
35883
+ * @param {Grid.view.Grid} event.source The grid instance
35884
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
35885
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
35886
+ */
35887
+ treeGroup?: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string
35836
35888
  /**
35837
35889
  * Fires when row locking is disabled.
35838
35890
  * @param {object} event Event object
@@ -36496,7 +36548,7 @@ type GridBaseConfig = {
36496
36548
  rootElement?: ShadowRoot|HTMLElement
36497
36549
  /**
36498
36550
  * Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
36499
- * overriden by specifying a [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
36551
+ * overridden by specifying a [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
36500
36552
  * a column [renderer](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-renderer).
36501
36553
  * ...
36502
36554
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-rowHeight)
@@ -36727,7 +36779,7 @@ type GridBaseConfig = {
36727
36779
  */
36728
36780
  onBeforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
36729
36781
  /**
36730
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
36782
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
36731
36783
  * buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
36732
36784
  * @param {object} event Event object
36733
36785
  * @param {Grid.view.Grid} event.source Owner grid
@@ -37692,6 +37744,14 @@ type GridBaseConfig = {
37692
37744
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
37693
37745
  */
37694
37746
  onToolClick?: ((event: { source: Tool, tool: Tool }) => void)|string
37747
+ /**
37748
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
37749
+ * @param {object} event Event object
37750
+ * @param {Grid.view.Grid} event.source The grid instance
37751
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
37752
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
37753
+ */
37754
+ onTreeGroup?: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string
37695
37755
  /**
37696
37756
  * Fires when row locking is disabled.
37697
37757
  * @param {object} event Event object
@@ -37955,7 +38015,7 @@ export class GridBase extends Panel {
37955
38015
  readonly responsiveLevel: string
37956
38016
  /**
37957
38017
  * Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
37958
- * overriden by specifying a [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
38018
+ * overridden by specifying a [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
37959
38019
  * a column [renderer](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-renderer).
37960
38020
  */
37961
38021
  rowHeight: number
@@ -38075,7 +38135,7 @@ export class GridBase extends Panel {
38075
38135
  */
38076
38136
  onBeforeCellEditStart: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
38077
38137
  /**
38078
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
38138
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
38079
38139
  * buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
38080
38140
  * @param {object} event Event object
38081
38141
  * @param {Grid.view.Grid} event.source Owner grid
@@ -38904,6 +38964,14 @@ export class GridBase extends Panel {
38904
38964
  * @param {boolean} event.collapse `true` if the node is being collapsed.
38905
38965
  */
38906
38966
  onToggleNode: ((event: { record: Model, collapse: boolean }) => void)|string
38967
+ /**
38968
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
38969
+ * @param {object} event Event object
38970
+ * @param {Grid.view.Grid} event.source The grid instance
38971
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
38972
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
38973
+ */
38974
+ onTreeGroup: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string
38907
38975
  /**
38908
38976
  * Fires when row locking is disabled.
38909
38977
  * @param {object} event Event object
@@ -40394,7 +40462,7 @@ type TreeGridListenersTypes = {
40394
40462
  */
40395
40463
  beforeCellEditStart: (event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void
40396
40464
  /**
40397
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
40465
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
40398
40466
  * buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
40399
40467
  * @param {object} event Event object
40400
40468
  * @param {Grid.view.Grid} event.source Owner grid
@@ -41359,6 +41427,14 @@ type TreeGridListenersTypes = {
41359
41427
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
41360
41428
  */
41361
41429
  toolClick: (event: { source: Tool, tool: Tool }) => void
41430
+ /**
41431
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
41432
+ * @param {object} event Event object
41433
+ * @param {Grid.view.Grid} event.source The grid instance
41434
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
41435
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
41436
+ */
41437
+ treeGroup: (event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void
41362
41438
  /**
41363
41439
  * Fires when row locking is disabled.
41364
41440
  * @param {object} event Event object
@@ -41413,7 +41489,7 @@ type TreeGridListeners = {
41413
41489
  */
41414
41490
  beforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
41415
41491
  /**
41416
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
41492
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
41417
41493
  * buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
41418
41494
  * @param {object} event Event object
41419
41495
  * @param {Grid.view.Grid} event.source Owner grid
@@ -42378,6 +42454,14 @@ type TreeGridListeners = {
42378
42454
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
42379
42455
  */
42380
42456
  toolClick?: ((event: { source: Tool, tool: Tool }) => void)|string
42457
+ /**
42458
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
42459
+ * @param {object} event Event object
42460
+ * @param {Grid.view.Grid} event.source The grid instance
42461
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
42462
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
42463
+ */
42464
+ treeGroup?: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string
42381
42465
  /**
42382
42466
  * Fires when row locking is disabled.
42383
42467
  * @param {object} event Event object
@@ -43042,7 +43126,7 @@ type TreeGridConfig = {
43042
43126
  rootElement?: ShadowRoot|HTMLElement
43043
43127
  /**
43044
43128
  * Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
43045
- * overriden by specifying a [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
43129
+ * overridden by specifying a [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
43046
43130
  * a column [renderer](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-renderer).
43047
43131
  * ...
43048
43132
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-rowHeight)
@@ -43273,7 +43357,7 @@ type TreeGridConfig = {
43273
43357
  */
43274
43358
  onBeforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
43275
43359
  /**
43276
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
43360
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
43277
43361
  * buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
43278
43362
  * @param {object} event Event object
43279
43363
  * @param {Grid.view.Grid} event.source Owner grid
@@ -44238,6 +44322,14 @@ type TreeGridConfig = {
44238
44322
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
44239
44323
  */
44240
44324
  onToolClick?: ((event: { source: Tool, tool: Tool }) => void)|string
44325
+ /**
44326
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
44327
+ * @param {object} event Event object
44328
+ * @param {Grid.view.Grid} event.source The grid instance
44329
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
44330
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
44331
+ */
44332
+ onTreeGroup?: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string
44241
44333
  /**
44242
44334
  * Fires when row locking is disabled.
44243
44335
  * @param {object} event Event object
@@ -44983,7 +45075,7 @@ type ExportDialogConfig = {
44983
45075
  */
44984
45076
  closeAction?: 'hide'|'destroy'
44985
45077
  /**
44986
- * Close popup when `ESC` key is pressed.
45078
+ * Close popup when <kbd>Escape</kbd> key is pressed.
44987
45079
  */
44988
45080
  closeOnEscape?: boolean
44989
45081
  /**
@@ -47434,7 +47526,7 @@ type AIFilterFieldConfig = {
47434
47526
  required?: boolean
47435
47527
  /**
47436
47528
  * 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
47437
- * the `ESCAPE` key after editing the field will revert the field to the value it had when
47529
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
47438
47530
  * 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)
47439
47531
  * behaviour will be activated.
47440
47532
  */
@@ -48293,7 +48385,7 @@ type ChecklistFilterComboConfig = {
48293
48385
  contentElementCls?: string|object
48294
48386
  /**
48295
48387
  * If configured as `true`, this means that when an unmatched string is typed into the
48296
- * combo's input field, and `ENTER`, or the [multiValueSeparator](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-multiValueSeparator) is typed,
48388
+ * 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,
48297
48389
  * 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).
48298
48390
  * ...
48299
48391
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-createOnUnmatched)
@@ -48793,7 +48885,7 @@ type ChecklistFilterComboConfig = {
48793
48885
  required?: boolean
48794
48886
  /**
48795
48887
  * 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
48796
- * the `ESCAPE` key after editing the field will revert the field to the value it had when
48888
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
48797
48889
  * 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)
48798
48890
  * behaviour will be activated.
48799
48891
  */
@@ -53107,7 +53199,7 @@ type GroupBarConfig = {
53107
53199
  */
53108
53200
  title?: string
53109
53201
  /**
53110
- * Select/deselect all if `CMD`/`CTRL` is pressed when clicking
53202
+ * Select/deselect all if <kbd>Cmd</kbd>/<kbd>Ctrl</kbd> is pressed when clicking
53111
53203
  */
53112
53204
  toggleAllIfCtrlPressed?: boolean
53113
53205
  /**
@@ -53867,7 +53959,7 @@ type TreeComboConfig = {
53867
53959
  contentElementCls?: string|object
53868
53960
  /**
53869
53961
  * If configured as `true`, this means that when an unmatched string is typed into the
53870
- * combo's input field, and `ENTER`, or the [multiValueSeparator](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-multiValueSeparator) is typed,
53962
+ * 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,
53871
53963
  * 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).
53872
53964
  * ...
53873
53965
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-createOnUnmatched)
@@ -54367,7 +54459,7 @@ type TreeComboConfig = {
54367
54459
  required?: boolean
54368
54460
  /**
54369
54461
  * 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
54370
- * the `ESCAPE` key after editing the field will revert the field to the value it had when
54462
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
54371
54463
  * 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)
54372
54464
  * behaviour will be activated.
54373
54465
  */