@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.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
@@ -1148,9 +1148,13 @@ type AnimateScrollOptions = {
1148
1148
  */
1149
1149
  type BryntumScrollOptions = {
1150
1150
  /**
1151
- * How far to scroll the element.
1151
+ * How far to scroll the element in the block (`Y`) axis.
1152
1152
  */
1153
1153
  block?: 'start'|'end'|'center'|'nearest'
1154
+ /**
1155
+ * How far to scroll the element in the inline (`X`) axis.
1156
+ */
1157
+ inline?: 'start'|'end'|'center'|'nearest'
1154
1158
  /**
1155
1159
  * edgeOffset A margin around the element or rectangle to bring into view.
1156
1160
  */
@@ -5417,7 +5421,8 @@ export class Model extends Base {
5417
5421
  readonly lastChild: Model
5418
5422
  /**
5419
5423
  * Get a map of the modified fields in form of an object. The field´s [dataSource](https://bryntum.com/products/grid/docs/api/Core/data/field/DataField#config-dataSource)
5420
- * is used as the property name in the returned object. The record´s id is always included.
5424
+ * is used as the property name in the returned object. The record's id is included unless its
5425
+ * [persist](https://bryntum.com/products/grid/docs/api/Core/data/field/DataField#config-persist) config is `false`.
5421
5426
  */
5422
5427
  readonly modificationData: object
5423
5428
  /**
@@ -14429,7 +14434,7 @@ export class DateHelper {
14429
14434
  */
14430
14435
  static isBefore(first: Date, second: Date): boolean;
14431
14436
  /**
14432
- * Checks if value is a date object. Allows to recognize date object even from another context,
14437
+ * Checks if value is a date object. Allows recognizing date object even from another context,
14433
14438
  * like the top frame when used in an iframe.
14434
14439
  * @param {any} value Value to check
14435
14440
  */
@@ -15000,11 +15005,19 @@ export class DomSync {
15000
15005
  * @param {string} path Dot '.' separated path of syncIdMap entries
15001
15006
  */
15002
15007
  static getChild(element: HTMLElement, path: string): HTMLElement;
15008
+ /**
15009
+ * Remove an element without syncing, cleaning up its parent's syncIdMap.
15010
+ * Unlike [removeChild](https://bryntum.com/products/grid/docs/api/Core/helper/DomSync#function-removeChild-static), this works correctly for descendant elements
15011
+ * (not just direct children).
15012
+ * @param {HTMLElement} childElement The element to remove
15013
+ */
15014
+ static remove(childElement: HTMLElement): void;
15003
15015
  /**
15004
15016
  * Remove a child element without syncing, for example when dragging an element to some other parent.
15005
15017
  * Removes it both from DOM and the parent elements syncMap
15006
15018
  * @param {HTMLElement} parentElement
15007
15019
  * @param {HTMLElement} childElement
15020
+ * @deprecated Since 7.2.1. Use [remove](https://bryntum.com/products/grid/docs/api/Core/helper/DomSync#function-remove-static) instead.
15008
15021
  */
15009
15022
  static removeChild(parentElement: HTMLElement, childElement: HTMLElement): void;
15010
15023
  /**
@@ -16672,7 +16685,7 @@ export class Rectangle {
16672
16685
  */
16673
16686
  contains(other: Rectangle): boolean;
16674
16687
  /**
16675
- * Clips off the area of the "other" Rectangle(s) from this Rectangle if any of the the other rectangles occlude
16688
+ * Clips off the area of the "other" Rectangle(s) from this Rectangle if any of the other rectangles occlude
16676
16689
  * a whole edge of this Rectangle.
16677
16690
  * @param {Core.helper.util.Rectangle} other The potentially occluding Rectangle(s).
16678
16691
  */
@@ -26107,7 +26120,7 @@ type CheckboxConfig = {
26107
26120
  required?: boolean
26108
26121
  /**
26109
26122
  * 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
26110
- * the `ESCAPE` key after editing the field will revert the field to the value it had when
26123
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
26111
26124
  * 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)
26112
26125
  * behaviour will be activated.
26113
26126
  */
@@ -28749,7 +28762,7 @@ type ChipViewConfig = {
28749
28762
  */
28750
28763
  title?: string
28751
28764
  /**
28752
- * Select/deselect all if `CMD`/`CTRL` is pressed when clicking
28765
+ * Select/deselect all if <kbd>Cmd</kbd>/<kbd>Ctrl</kbd> is pressed when clicking
28753
28766
  */
28754
28767
  toggleAllIfCtrlPressed?: boolean
28755
28768
  /**
@@ -31127,7 +31140,7 @@ type ColorFieldConfig = {
31127
31140
  required?: boolean
31128
31141
  /**
31129
31142
  * 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
31130
- * the `ESCAPE` key after editing the field will revert the field to the value it had when
31143
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
31131
31144
  * 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)
31132
31145
  * behaviour will be activated.
31133
31146
  */
@@ -32337,7 +32350,7 @@ type ColorPickerConfig = {
32337
32350
  */
32338
32351
  title?: string
32339
32352
  /**
32340
- * Select/deselect all if `CMD`/`CTRL` is pressed when clicking
32353
+ * Select/deselect all if <kbd>Cmd</kbd>/<kbd>Ctrl</kbd> is pressed when clicking
32341
32354
  */
32342
32355
  toggleAllIfCtrlPressed?: boolean
32343
32356
  /**
@@ -33114,7 +33127,7 @@ type ComboConfig = {
33114
33127
  contentElementCls?: string|object
33115
33128
  /**
33116
33129
  * If configured as `true`, this means that when an unmatched string is typed into the
33117
- * combo's input field, and `ENTER`, or the [multiValueSeparator](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-multiValueSeparator) is typed,
33130
+ * 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,
33118
33131
  * 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).
33119
33132
  * ...
33120
33133
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-createOnUnmatched)
@@ -33614,7 +33627,7 @@ type ComboConfig = {
33614
33627
  required?: boolean
33615
33628
  /**
33616
33629
  * 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
33617
- * the `ESCAPE` key after editing the field will revert the field to the value it had when
33630
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
33618
33631
  * 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)
33619
33632
  * behaviour will be activated.
33620
33633
  */
@@ -33967,7 +33980,7 @@ export class Combo extends PickerField {
33967
33980
  filterOperator: CollectionCompareOperator
33968
33981
  /**
33969
33982
  * Returns array of the Combo's inner HTML elements.
33970
- * This getter can be overriden.
33983
+ * This getter can be overridden.
33971
33984
  */
33972
33985
  get innerElements(): (HTMLElement|DomConfig)[]
33973
33986
  /**
@@ -34674,7 +34687,7 @@ type ConfirmationBarConfig = {
34674
34687
  */
34675
34688
  items?: string|Record<string, ContainerItemConfig|MenuItemEntry>|(ContainerItemConfig|MenuItemEntry|Widget)[]
34676
34689
  /**
34677
- * Maps `Enter` and `Escape` to [doDefault](https://bryntum.com/products/grid/docs/api/Core/widget/ConfirmationBar#function-doDefault) and [doCancel](#Core/widget/ConfirmationBar#function-doCancel), respectively.
34690
+ * Maps <kbd>Enter</kbd> and <kbd>Escape</kbd> to [doDefault](https://bryntum.com/products/grid/docs/api/Core/widget/ConfirmationBar#function-doDefault) and [doCancel](#Core/widget/ConfirmationBar#function-doCancel), respectively.
34678
34691
  */
34679
34692
  keyMap?: Record<string, KeyMapConfig>
34680
34693
  /**
@@ -37226,7 +37239,7 @@ type DateFieldConfig = {
37226
37239
  required?: boolean
37227
37240
  /**
37228
37241
  * 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
37229
- * the `ESCAPE` key after editing the field will revert the field to the value it had when
37242
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
37230
37243
  * 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)
37231
37244
  * behaviour will be activated.
37232
37245
  */
@@ -40128,7 +40141,7 @@ type DateRangeFieldConfig = {
40128
40141
  required?: boolean
40129
40142
  /**
40130
40143
  * 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
40131
- * the `ESCAPE` key after editing the field will revert the field to the value it had when
40144
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
40132
40145
  * 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)
40133
40146
  * behaviour will be activated.
40134
40147
  */
@@ -42767,7 +42780,7 @@ type DateTimeFieldConfig = {
42767
42780
  required?: boolean
42768
42781
  /**
42769
42782
  * 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
42770
- * the `ESCAPE` key after editing the field will revert the field to the value it had when
42783
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
42771
42784
  * 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)
42772
42785
  * behaviour will be activated.
42773
42786
  */
@@ -46193,7 +46206,7 @@ type DisplayFieldConfig = {
46193
46206
  required?: boolean
46194
46207
  /**
46195
46208
  * 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
46196
- * the `ESCAPE` key after editing the field will revert the field to the value it had when
46209
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
46197
46210
  * 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)
46198
46211
  * behaviour will be activated.
46199
46212
  */
@@ -47389,7 +47402,7 @@ type DurationFieldConfig = {
47389
47402
  required?: boolean
47390
47403
  /**
47391
47404
  * 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
47392
- * the `ESCAPE` key after editing the field will revert the field to the value it had when
47405
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
47393
47406
  * 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)
47394
47407
  * behaviour will be activated.
47395
47408
  */
@@ -47820,7 +47833,7 @@ type EditorListenersTypes = {
47820
47833
  */
47821
47834
  afterEdit: (event: { source: Editor, record?: Model }) => void
47822
47835
  /**
47823
- * Fired when cancellation has been requested, either by `ESC`, or focus loss (if configured to cancel on blur).
47836
+ * Fired when cancellation has been requested, either by <kbd>Escape</kbd>, or focus loss (if configured to cancel on blur).
47824
47837
  * The cancellation may be vetoed, in which case, focus is moved back into the editor.
47825
47838
  * @param {object} event Event object
47826
47839
  * @param {object} event.oldValue The original value.
@@ -47830,7 +47843,7 @@ type EditorListenersTypes = {
47830
47843
  */
47831
47844
  beforeCancel: (event: { oldValue: object, value: object, event: Event, source: Editor }) => Promise<boolean>|boolean|void
47832
47845
  /**
47833
- * Fired when an edit completion has been requested, either by `ENTER`, or focus loss (if configured to complete on blur).
47846
+ * Fired when an edit completion has been requested, either by <kbd>Enter</kbd>, or focus loss (if configured to complete on blur).
47834
47847
  * The completion may be vetoed, in which case, focus is moved back into the editor.
47835
47848
  * @param {object} event Event object
47836
47849
  * @param {object} event.oldValue The original value.
@@ -48025,7 +48038,7 @@ type EditorListeners = {
48025
48038
  */
48026
48039
  afterEdit?: ((event: { source: Editor, record?: Model }) => void)|string
48027
48040
  /**
48028
- * Fired when cancellation has been requested, either by `ESC`, or focus loss (if configured to cancel on blur).
48041
+ * Fired when cancellation has been requested, either by <kbd>Escape</kbd>, or focus loss (if configured to cancel on blur).
48029
48042
  * The cancellation may be vetoed, in which case, focus is moved back into the editor.
48030
48043
  * @param {object} event Event object
48031
48044
  * @param {object} event.oldValue The original value.
@@ -48035,7 +48048,7 @@ type EditorListeners = {
48035
48048
  */
48036
48049
  beforeCancel?: ((event: { oldValue: object, value: object, event: Event, source: Editor }) => Promise<boolean>|boolean|void)|string
48037
48050
  /**
48038
- * Fired when an edit completion has been requested, either by `ENTER`, or focus loss (if configured to complete on blur).
48051
+ * Fired when an edit completion has been requested, either by <kbd>Enter</kbd>, or focus loss (if configured to complete on blur).
48039
48052
  * The completion may be vetoed, in which case, focus is moved back into the editor.
48040
48053
  * @param {object} event Event object
48041
48054
  * @param {object} event.oldValue The original value.
@@ -48269,7 +48282,7 @@ type EditorConfig = {
48269
48282
  */
48270
48283
  autoUpdateRecord?: boolean
48271
48284
  /**
48272
- * What action should be taken when focus moves out of the editor, either by `TAB` or clicking outside.
48285
+ * What action should be taken when focus moves out of the editor, either by <kbd>Tab</kbd> or clicking outside.
48273
48286
  * May be `'complete'` or `'cancel`'. Any other value results in no action being taken upon focus leaving the editor
48274
48287
  * leaving the application to listen for the [focusOut](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#event-focusOut) event.
48275
48288
  */
@@ -48853,7 +48866,7 @@ type EditorConfig = {
48853
48866
  */
48854
48867
  onAfterEdit?: ((event: { source: Editor, record?: Model }) => void)|string
48855
48868
  /**
48856
- * Fired when cancellation has been requested, either by `ESC`, or focus loss (if configured to cancel on blur).
48869
+ * Fired when cancellation has been requested, either by <kbd>Escape</kbd>, or focus loss (if configured to cancel on blur).
48857
48870
  * The cancellation may be vetoed, in which case, focus is moved back into the editor.
48858
48871
  * @param {object} event Event object
48859
48872
  * @param {object} event.oldValue The original value.
@@ -48863,7 +48876,7 @@ type EditorConfig = {
48863
48876
  */
48864
48877
  onBeforeCancel?: ((event: { oldValue: object, value: object, event: Event, source: Editor }) => Promise<boolean>|boolean|void)|string
48865
48878
  /**
48866
- * Fired when an edit completion has been requested, either by `ENTER`, or focus loss (if configured to complete on blur).
48879
+ * Fired when an edit completion has been requested, either by <kbd>Enter</kbd>, or focus loss (if configured to complete on blur).
48867
48880
  * The completion may be vetoed, in which case, focus is moved back into the editor.
48868
48881
  * @param {object} event Event object
48869
48882
  * @param {object} event.oldValue The original value.
@@ -49069,7 +49082,7 @@ export class Editor extends Container {
49069
49082
  */
49070
49083
  onAfterEdit: ((event: { source: Editor, record?: Model }) => void)|string
49071
49084
  /**
49072
- * Fired when cancellation has been requested, either by `ESC`, or focus loss (if configured to cancel on blur).
49085
+ * Fired when cancellation has been requested, either by <kbd>Escape</kbd>, or focus loss (if configured to cancel on blur).
49073
49086
  * The cancellation may be vetoed, in which case, focus is moved back into the editor.
49074
49087
  * @param {object} event Event object
49075
49088
  * @param {object} event.oldValue The original value.
@@ -49079,7 +49092,7 @@ export class Editor extends Container {
49079
49092
  */
49080
49093
  onBeforeCancel: ((event: { oldValue: object, value: object, event: Event, source: Editor }) => Promise<boolean>|boolean|void)|string
49081
49094
  /**
49082
- * Fired when an edit completion has been requested, either by `ENTER`, or focus loss (if configured to complete on blur).
49095
+ * Fired when an edit completion has been requested, either by <kbd>Enter</kbd>, or focus loss (if configured to complete on blur).
49083
49096
  * The completion may be vetoed, in which case, focus is moved back into the editor.
49084
49097
  * @param {object} event Event object
49085
49098
  * @param {object} event.oldValue The original value.
@@ -49996,7 +50009,7 @@ type FieldConfig = {
49996
50009
  required?: boolean
49997
50010
  /**
49998
50011
  * 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
49999
- * the `ESCAPE` key after editing the field will revert the field to the value it had when
50012
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
50000
50013
  * 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)
50001
50014
  * behaviour will be activated.
50002
50015
  */
@@ -55883,7 +55896,7 @@ type FileFieldConfig = {
55883
55896
  required?: boolean
55884
55897
  /**
55885
55898
  * 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
55886
- * the `ESCAPE` key after editing the field will revert the field to the value it had when
55899
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
55887
55900
  * 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)
55888
55901
  * behaviour will be activated.
55889
55902
  */
@@ -58147,7 +58160,7 @@ type FilterFieldConfig = {
58147
58160
  required?: boolean
58148
58161
  /**
58149
58162
  * 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
58150
- * the `ESCAPE` key after editing the field will revert the field to the value it had when
58163
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
58151
58164
  * 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)
58152
58165
  * behaviour will be activated.
58153
58166
  */
@@ -58931,7 +58944,7 @@ type HintConfig = {
58931
58944
  */
58932
58945
  catchEventHandlerExceptions?: boolean
58933
58946
  /**
58934
- * Close popup when `ESC` key is pressed.
58947
+ * Close popup when <kbd>Escape</kbd> key is pressed.
58935
58948
  */
58936
58949
  closeOnEscape?: boolean
58937
58950
  /**
@@ -61486,7 +61499,7 @@ type ListConfig = {
61486
61499
  */
61487
61500
  title?: string
61488
61501
  /**
61489
- * Select/deselect all if `CMD`/`CTRL` is pressed when clicking
61502
+ * Select/deselect all if <kbd>Cmd</kbd>/<kbd>Ctrl</kbd> is pressed when clicking
61490
61503
  */
61491
61504
  toggleAllIfCtrlPressed?: boolean
61492
61505
  /**
@@ -61755,7 +61768,7 @@ export class List extends Widget {
61755
61768
  */
61756
61769
  title: string
61757
61770
  /**
61758
- * Select/deselect all if `CMD`/`CTRL` is pressed when clicking
61771
+ * Select/deselect all if <kbd>Cmd</kbd>/<kbd>Ctrl</kbd> is pressed when clicking
61759
61772
  */
61760
61773
  toggleAllIfCtrlPressed: boolean
61761
61774
  /**
@@ -63262,7 +63275,7 @@ type MenuConfig = {
63262
63275
  */
63263
63276
  closeAction?: 'hide'|'destroy'
63264
63277
  /**
63265
- * Close popup when `ESC` key is pressed.
63278
+ * Close popup when <kbd>Escape</kbd> key is pressed.
63266
63279
  */
63267
63280
  closeOnEscape?: boolean
63268
63281
  /**
@@ -64536,7 +64549,7 @@ type MenuItemConfig = {
64536
64549
  * If configured with a `Boolean` value, a checkbox is displayed
64537
64550
  * as the start icon, and the [toggle](https://bryntum.com/products/grid/docs/api/Core/widget/MenuItem#event-toggle) event is fired
64538
64551
  * when the checked state changes.
64539
- * `String` value allows to link value by reference name.
64552
+ * `String` value allows linking value by reference name.
64540
64553
  * ...
64541
64554
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/MenuItem#config-checked)
64542
64555
  */
@@ -69184,7 +69197,7 @@ type NumberFieldConfig = {
69184
69197
  required?: boolean
69185
69198
  /**
69186
69199
  * 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
69187
- * the `ESCAPE` key after editing the field will revert the field to the value it had when
69200
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
69188
69201
  * 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)
69189
69202
  * behaviour will be activated.
69190
69203
  */
@@ -72804,7 +72817,7 @@ type PasswordFieldConfig = {
72804
72817
  required?: boolean
72805
72818
  /**
72806
72819
  * 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
72807
- * the `ESCAPE` key after editing the field will revert the field to the value it had when
72820
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
72808
72821
  * 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)
72809
72822
  * behaviour will be activated.
72810
72823
  */
@@ -73977,7 +73990,7 @@ type PickerFieldConfig = {
73977
73990
  required?: boolean
73978
73991
  /**
73979
73992
  * 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
73980
- * the `ESCAPE` key after editing the field will revert the field to the value it had when
73993
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
73981
73994
  * 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)
73982
73995
  * behaviour will be activated.
73983
73996
  */
@@ -74801,7 +74814,7 @@ type PopupConfig = {
74801
74814
  */
74802
74815
  closeAction?: 'hide'|'destroy'
74803
74816
  /**
74804
- * Close popup when `ESC` key is pressed.
74817
+ * Close popup when <kbd>Escape</kbd> key is pressed.
74805
74818
  */
74806
74819
  closeOnEscape?: boolean
74807
74820
  /**
@@ -77423,7 +77436,7 @@ type RadioConfig = {
77423
77436
  required?: boolean
77424
77437
  /**
77425
77438
  * 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
77426
- * the `ESCAPE` key after editing the field will revert the field to the value it had when
77439
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
77427
77440
  * 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)
77428
77441
  * behaviour will be activated.
77429
77442
  */
@@ -79877,7 +79890,7 @@ type RichTextFieldConfig = {
79877
79890
  required?: boolean
79878
79891
  /**
79879
79892
  * 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
79880
- * the `ESCAPE` key after editing the field will revert the field to the value it had when
79893
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
79881
79894
  * 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)
79882
79895
  * behaviour will be activated.
79883
79896
  */
@@ -81062,7 +81075,7 @@ type SlideToggleConfig = {
81062
81075
  required?: boolean
81063
81076
  /**
81064
81077
  * 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
81065
- * the `ESCAPE` key after editing the field will revert the field to the value it had when
81078
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
81066
81079
  * 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)
81067
81080
  * behaviour will be activated.
81068
81081
  */
@@ -82185,7 +82198,7 @@ type SliderConfig = {
82185
82198
  unit?: string
82186
82199
  /**
82187
82200
  * Initial value.
82188
- * `String` value allows to link value by reference name.
82201
+ * `String` value allows linking value by reference name.
82189
82202
  * ...
82190
82203
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Slider#config-value)
82191
82204
  */
@@ -82400,7 +82413,7 @@ export class Slider extends Widget {
82400
82413
  unit: string
82401
82414
  /**
82402
82415
  * Initial value.
82403
- * `String` value allows to link value by reference name.
82416
+ * `String` value allows linking value by reference name.
82404
82417
  */
82405
82418
  value: number|string
82406
82419
  /**
@@ -87748,7 +87761,7 @@ type TextAreaFieldConfig = {
87748
87761
  resize?: 'none'|'both'|'horizontal'|'vertical'
87749
87762
  /**
87750
87763
  * 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
87751
- * the `ESCAPE` key after editing the field will revert the field to the value it had when
87764
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
87752
87765
  * 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)
87753
87766
  * behaviour will be activated.
87754
87767
  */
@@ -88931,7 +88944,7 @@ type TextAreaPickerFieldConfig = {
88931
88944
  resize?: 'none'|'both'|'horizontal'|'vertical'
88932
88945
  /**
88933
88946
  * 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
88934
- * the `ESCAPE` key after editing the field will revert the field to the value it had when
88947
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
88935
88948
  * 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)
88936
88949
  * behaviour will be activated.
88937
88950
  */
@@ -90100,7 +90113,7 @@ type TextFieldConfig = {
90100
90113
  required?: boolean
90101
90114
  /**
90102
90115
  * 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
90103
- * the `ESCAPE` key after editing the field will revert the field to the value it had when
90116
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
90104
90117
  * 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)
90105
90118
  * behaviour will be activated.
90106
90119
  */
@@ -91323,7 +91336,7 @@ type TimeFieldConfig = {
91323
91336
  required?: boolean
91324
91337
  /**
91325
91338
  * 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
91326
- * the `ESCAPE` key after editing the field will revert the field to the value it had when
91339
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
91327
91340
  * 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)
91328
91341
  * behaviour will be activated.
91329
91342
  */
@@ -96208,7 +96221,7 @@ type TooltipConfig = {
96208
96221
  */
96209
96222
  closeAction?: 'hide'|'destroy'
96210
96223
  /**
96211
- * Close popup when `ESC` key is pressed.
96224
+ * Close popup when <kbd>Escape</kbd> key is pressed.
96212
96225
  */
96213
96226
  closeOnEscape?: boolean
96214
96227
  /**
@@ -103884,7 +103897,7 @@ type ConfirmationDialogConfig = {
103884
103897
  */
103885
103898
  closable?: boolean
103886
103899
  /**
103887
- * Close popup when `ESC` key is pressed.
103900
+ * Close popup when <kbd>Escape</kbd> key is pressed.
103888
103901
  */
103889
103902
  closeOnEscape?: boolean
103890
103903
  /**
@@ -107619,6 +107632,8 @@ type ActionColumnConfig = {
107619
107632
  headerMenuItems?: Record<string, MenuItemEntry>
107620
107633
  /**
107621
107634
  * Renderer function for the column header.
107635
+ * ...
107636
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/ActionColumn#config-headerRenderer)
107622
107637
  * @param {object} renderData
107623
107638
  * @param {Grid.column.Column} renderData.column This column
107624
107639
  * @param {HTMLElement} renderData.headerElement The header element
@@ -107664,7 +107679,7 @@ type ActionColumnConfig = {
107664
107679
  id?: string|number
107665
107680
  /**
107666
107681
  * 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
107667
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
107682
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
107668
107683
  */
107669
107684
  instantUpdate?: boolean
107670
107685
  /**
@@ -107832,7 +107847,7 @@ type ActionColumnConfig = {
107832
107847
  */
107833
107848
  responsiveLevels?: object
107834
107849
  /**
107835
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
107850
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
107836
107851
  * revert the field to the value it had when the edit began. If the value is *not* changed
107837
107852
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
107838
107853
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -108336,6 +108351,8 @@ type AggregateColumnConfig = {
108336
108351
  headerMenuItems?: Record<string, MenuItemEntry>
108337
108352
  /**
108338
108353
  * Renderer function for the column header.
108354
+ * ...
108355
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/AggregateColumn#config-headerRenderer)
108339
108356
  * @param {object} renderData
108340
108357
  * @param {Grid.column.Column} renderData.column This column
108341
108358
  * @param {HTMLElement} renderData.headerElement The header element
@@ -108394,7 +108411,7 @@ type AggregateColumnConfig = {
108394
108411
  includeParentInChangeSet?: boolean
108395
108412
  /**
108396
108413
  * 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
108397
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
108414
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
108398
108415
  */
108399
108416
  instantUpdate?: boolean
108400
108417
  /**
@@ -108579,7 +108596,7 @@ type AggregateColumnConfig = {
108579
108596
  */
108580
108597
  responsiveLevels?: object
108581
108598
  /**
108582
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
108599
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
108583
108600
  * revert the field to the value it had when the edit began. If the value is *not* changed
108584
108601
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
108585
108602
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -109104,6 +109121,8 @@ type ChartColumnConfig = {
109104
109121
  headerMenuItems?: Record<string, MenuItemEntry>
109105
109122
  /**
109106
109123
  * Renderer function for the column header.
109124
+ * ...
109125
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/ChartColumn#config-headerRenderer)
109107
109126
  * @param {object} renderData
109108
109127
  * @param {Grid.column.Column} renderData.column This column
109109
109128
  * @param {HTMLElement} renderData.headerElement The header element
@@ -109154,7 +109173,7 @@ type ChartColumnConfig = {
109154
109173
  id?: string|number
109155
109174
  /**
109156
109175
  * 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
109157
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
109176
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
109158
109177
  */
109159
109178
  instantUpdate?: boolean
109160
109179
  /**
@@ -109330,7 +109349,7 @@ type ChartColumnConfig = {
109330
109349
  */
109331
109350
  responsiveLevels?: object
109332
109351
  /**
109333
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
109352
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
109334
109353
  * revert the field to the value it had when the edit began. If the value is *not* changed
109335
109354
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
109336
109355
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -109877,6 +109896,8 @@ type CheckColumnConfig = {
109877
109896
  headerMenuItems?: Record<string, MenuItemEntry>
109878
109897
  /**
109879
109898
  * Renderer function for the column header.
109899
+ * ...
109900
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/CheckColumn#config-headerRenderer)
109880
109901
  * @param {object} renderData
109881
109902
  * @param {Grid.column.Column} renderData.column This column
109882
109903
  * @param {HTMLElement} renderData.headerElement The header element
@@ -109927,7 +109948,7 @@ type CheckColumnConfig = {
109927
109948
  id?: string|number
109928
109949
  /**
109929
109950
  * 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
109930
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
109951
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
109931
109952
  */
109932
109953
  instantUpdate?: boolean
109933
109954
  /**
@@ -110103,7 +110124,7 @@ type CheckColumnConfig = {
110103
110124
  */
110104
110125
  responsiveLevels?: object
110105
110126
  /**
110106
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
110127
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
110107
110128
  * revert the field to the value it had when the edit began. If the value is *not* changed
110108
110129
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
110109
110130
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -110665,6 +110686,8 @@ type ColorColumnConfig = {
110665
110686
  headerMenuItems?: Record<string, MenuItemEntry>
110666
110687
  /**
110667
110688
  * Renderer function for the column header.
110689
+ * ...
110690
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/ColorColumn#config-headerRenderer)
110668
110691
  * @param {object} renderData
110669
110692
  * @param {Grid.column.Column} renderData.column This column
110670
110693
  * @param {HTMLElement} renderData.headerElement The header element
@@ -110715,7 +110738,7 @@ type ColorColumnConfig = {
110715
110738
  id?: string|number
110716
110739
  /**
110717
110740
  * 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
110718
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
110741
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
110719
110742
  */
110720
110743
  instantUpdate?: boolean
110721
110744
  /**
@@ -110887,7 +110910,7 @@ type ColorColumnConfig = {
110887
110910
  */
110888
110911
  responsiveLevels?: object
110889
110912
  /**
110890
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
110913
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
110891
110914
  * revert the field to the value it had when the edit began. If the value is *not* changed
110892
110915
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
110893
110916
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -111398,6 +111421,8 @@ type ColumnConfig = {
111398
111421
  headerMenuItems?: Record<string, MenuItemEntry>
111399
111422
  /**
111400
111423
  * Renderer function for the column header.
111424
+ * ...
111425
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-headerRenderer)
111401
111426
  * @param {object} renderData
111402
111427
  * @param {Grid.column.Column} renderData.column This column
111403
111428
  * @param {HTMLElement} renderData.headerElement The header element
@@ -111448,7 +111473,7 @@ type ColumnConfig = {
111448
111473
  id?: string|number
111449
111474
  /**
111450
111475
  * 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
111451
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
111476
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
111452
111477
  */
111453
111478
  instantUpdate?: boolean
111454
111479
  /**
@@ -111620,7 +111645,7 @@ type ColumnConfig = {
111620
111645
  */
111621
111646
  responsiveLevels?: object
111622
111647
  /**
111623
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
111648
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
111624
111649
  * revert the field to the value it had when the edit began. If the value is *not* changed
111625
111650
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
111626
111651
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -111985,7 +112010,7 @@ export class Column extends Model {
111985
112010
  icon: string
111986
112011
  /**
111987
112012
  * 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
111988
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
112013
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
111989
112014
  */
111990
112015
  instantUpdate: boolean
111991
112016
  /**
@@ -112081,7 +112106,7 @@ export class Column extends Model {
112081
112106
  */
112082
112107
  responsiveLevels: object
112083
112108
  /**
112084
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
112109
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
112085
112110
  * revert the field to the value it had when the edit began. If the value is *not* changed
112086
112111
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
112087
112112
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -112693,6 +112718,8 @@ type CurrencyColumnConfig = {
112693
112718
  headerMenuItems?: Record<string, MenuItemEntry>
112694
112719
  /**
112695
112720
  * Renderer function for the column header.
112721
+ * ...
112722
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/CurrencyColumn#config-headerRenderer)
112696
112723
  * @param {object} renderData
112697
112724
  * @param {Grid.column.Column} renderData.column This column
112698
112725
  * @param {HTMLElement} renderData.headerElement The header element
@@ -112748,7 +112775,7 @@ type CurrencyColumnConfig = {
112748
112775
  id?: string|number
112749
112776
  /**
112750
112777
  * 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
112751
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
112778
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
112752
112779
  */
112753
112780
  instantUpdate?: boolean
112754
112781
  /**
@@ -112933,7 +112960,7 @@ type CurrencyColumnConfig = {
112933
112960
  */
112934
112961
  responsiveLevels?: object
112935
112962
  /**
112936
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
112963
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
112937
112964
  * revert the field to the value it had when the edit began. If the value is *not* changed
112938
112965
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
112939
112966
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -113443,6 +113470,8 @@ type DateColumnConfig = {
113443
113470
  headerMenuItems?: Record<string, MenuItemEntry>
113444
113471
  /**
113445
113472
  * Renderer function for the column header.
113473
+ * ...
113474
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/DateColumn#config-headerRenderer)
113446
113475
  * @param {object} renderData
113447
113476
  * @param {Grid.column.Column} renderData.column This column
113448
113477
  * @param {HTMLElement} renderData.headerElement The header element
@@ -113493,7 +113522,7 @@ type DateColumnConfig = {
113493
113522
  id?: string|number
113494
113523
  /**
113495
113524
  * 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
113496
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
113525
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
113497
113526
  */
113498
113527
  instantUpdate?: boolean
113499
113528
  /**
@@ -113673,7 +113702,7 @@ type DateColumnConfig = {
113673
113702
  */
113674
113703
  responsiveLevels?: object
113675
113704
  /**
113676
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
113705
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
113677
113706
  * revert the field to the value it had when the edit began. If the value is *not* changed
113678
113707
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
113679
113708
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -114204,6 +114233,8 @@ type NumberColumnConfig = {
114204
114233
  headerMenuItems?: Record<string, MenuItemEntry>
114205
114234
  /**
114206
114235
  * Renderer function for the column header.
114236
+ * ...
114237
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/NumberColumn#config-headerRenderer)
114207
114238
  * @param {object} renderData
114208
114239
  * @param {Grid.column.Column} renderData.column This column
114209
114240
  * @param {HTMLElement} renderData.headerElement The header element
@@ -114254,7 +114285,7 @@ type NumberColumnConfig = {
114254
114285
  id?: string|number
114255
114286
  /**
114256
114287
  * 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
114257
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
114288
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
114258
114289
  */
114259
114290
  instantUpdate?: boolean
114260
114291
  /**
@@ -114439,7 +114470,7 @@ type NumberColumnConfig = {
114439
114470
  */
114440
114471
  responsiveLevels?: object
114441
114472
  /**
114442
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
114473
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
114443
114474
  * revert the field to the value it had when the edit began. If the value is *not* changed
114444
114475
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
114445
114476
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -114981,6 +115012,8 @@ type PercentColumnConfig = {
114981
115012
  headerMenuItems?: Record<string, MenuItemEntry>
114982
115013
  /**
114983
115014
  * Renderer function for the column header.
115015
+ * ...
115016
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/PercentColumn#config-headerRenderer)
114984
115017
  * @param {object} renderData
114985
115018
  * @param {Grid.column.Column} renderData.column This column
114986
115019
  * @param {HTMLElement} renderData.headerElement The header element
@@ -115026,7 +115059,7 @@ type PercentColumnConfig = {
115026
115059
  id?: string|number
115027
115060
  /**
115028
115061
  * 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
115029
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
115062
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
115030
115063
  */
115031
115064
  instantUpdate?: boolean
115032
115065
  /**
@@ -115221,7 +115254,7 @@ type PercentColumnConfig = {
115221
115254
  */
115222
115255
  responsiveLevels?: object
115223
115256
  /**
115224
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
115257
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
115225
115258
  * revert the field to the value it had when the edit began. If the value is *not* changed
115226
115259
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
115227
115260
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -115757,6 +115790,8 @@ type RatingColumnConfig = {
115757
115790
  headerMenuItems?: Record<string, MenuItemEntry>
115758
115791
  /**
115759
115792
  * Renderer function for the column header.
115793
+ * ...
115794
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/RatingColumn#config-headerRenderer)
115760
115795
  * @param {object} renderData
115761
115796
  * @param {Grid.column.Column} renderData.column This column
115762
115797
  * @param {HTMLElement} renderData.headerElement The header element
@@ -115807,7 +115842,7 @@ type RatingColumnConfig = {
115807
115842
  id?: string|number
115808
115843
  /**
115809
115844
  * 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
115810
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
115845
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
115811
115846
  */
115812
115847
  instantUpdate?: boolean
115813
115848
  /**
@@ -115992,7 +116027,7 @@ type RatingColumnConfig = {
115992
116027
  */
115993
116028
  responsiveLevels?: object
115994
116029
  /**
115995
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
116030
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
115996
116031
  * revert the field to the value it had when the edit began. If the value is *not* changed
115997
116032
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
115998
116033
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -116435,6 +116470,8 @@ type RowNumberColumnConfig = {
116435
116470
  headerMenuItems?: Record<string, MenuItemEntry>
116436
116471
  /**
116437
116472
  * Renderer function for the column header.
116473
+ * ...
116474
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/RowNumberColumn#config-headerRenderer)
116438
116475
  * @param {object} renderData
116439
116476
  * @param {Grid.column.Column} renderData.column This column
116440
116477
  * @param {HTMLElement} renderData.headerElement The header element
@@ -117101,6 +117138,8 @@ type SparklineColumnConfig = {
117101
117138
  headerMenuItems?: Record<string, MenuItemEntry>
117102
117139
  /**
117103
117140
  * Renderer function for the column header.
117141
+ * ...
117142
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/SparklineColumn#config-headerRenderer)
117104
117143
  * @param {object} renderData
117105
117144
  * @param {Grid.column.Column} renderData.column This column
117106
117145
  * @param {HTMLElement} renderData.headerElement The header element
@@ -117161,7 +117200,7 @@ type SparklineColumnConfig = {
117161
117200
  id?: string|number
117162
117201
  /**
117163
117202
  * 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
117164
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
117203
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
117165
117204
  */
117166
117205
  instantUpdate?: boolean
117167
117206
  /**
@@ -117337,7 +117376,7 @@ type SparklineColumnConfig = {
117337
117376
  */
117338
117377
  responsiveLevels?: object
117339
117378
  /**
117340
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
117379
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
117341
117380
  * revert the field to the value it had when the edit began. If the value is *not* changed
117342
117381
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
117343
117382
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -117823,6 +117862,8 @@ type TemplateColumnConfig = {
117823
117862
  headerMenuItems?: Record<string, MenuItemEntry>
117824
117863
  /**
117825
117864
  * Renderer function for the column header.
117865
+ * ...
117866
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/TemplateColumn#config-headerRenderer)
117826
117867
  * @param {object} renderData
117827
117868
  * @param {Grid.column.Column} renderData.column This column
117828
117869
  * @param {HTMLElement} renderData.headerElement The header element
@@ -117873,7 +117914,7 @@ type TemplateColumnConfig = {
117873
117914
  id?: string|number
117874
117915
  /**
117875
117916
  * 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
117876
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
117917
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
117877
117918
  */
117878
117919
  instantUpdate?: boolean
117879
117920
  /**
@@ -118045,7 +118086,7 @@ type TemplateColumnConfig = {
118045
118086
  */
118046
118087
  responsiveLevels?: object
118047
118088
  /**
118048
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
118089
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
118049
118090
  * revert the field to the value it had when the edit began. If the value is *not* changed
118050
118091
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
118051
118092
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -118550,6 +118591,8 @@ type TimeColumnConfig = {
118550
118591
  headerMenuItems?: Record<string, MenuItemEntry>
118551
118592
  /**
118552
118593
  * Renderer function for the column header.
118594
+ * ...
118595
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/TimeColumn#config-headerRenderer)
118553
118596
  * @param {object} renderData
118554
118597
  * @param {Grid.column.Column} renderData.column This column
118555
118598
  * @param {HTMLElement} renderData.headerElement The header element
@@ -118600,7 +118643,7 @@ type TimeColumnConfig = {
118600
118643
  id?: string|number
118601
118644
  /**
118602
118645
  * 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
118603
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
118646
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
118604
118647
  */
118605
118648
  instantUpdate?: boolean
118606
118649
  /**
@@ -118772,7 +118815,7 @@ type TimeColumnConfig = {
118772
118815
  */
118773
118816
  responsiveLevels?: object
118774
118817
  /**
118775
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
118818
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
118776
118819
  * revert the field to the value it had when the edit began. If the value is *not* changed
118777
118820
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
118778
118821
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -119280,6 +119323,8 @@ type TreeColumnConfig = {
119280
119323
  headerMenuItems?: Record<string, MenuItemEntry>
119281
119324
  /**
119282
119325
  * Renderer function for the column header.
119326
+ * ...
119327
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/TreeColumn#config-headerRenderer)
119283
119328
  * @param {object} renderData
119284
119329
  * @param {Grid.column.Column} renderData.column This column
119285
119330
  * @param {HTMLElement} renderData.headerElement The header element
@@ -119336,7 +119381,7 @@ type TreeColumnConfig = {
119336
119381
  indentSize?: number
119337
119382
  /**
119338
119383
  * 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
119339
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
119384
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
119340
119385
  */
119341
119386
  instantUpdate?: boolean
119342
119387
  /**
@@ -119512,7 +119557,7 @@ type TreeColumnConfig = {
119512
119557
  */
119513
119558
  responsiveLevels?: object
119514
119559
  /**
119515
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
119560
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
119516
119561
  * revert the field to the value it had when the edit began. If the value is *not* changed
119517
119562
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
119518
119563
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -120037,6 +120082,8 @@ type WidgetColumnConfig = {
120037
120082
  headerMenuItems?: Record<string, MenuItemEntry>
120038
120083
  /**
120039
120084
  * Renderer function for the column header.
120085
+ * ...
120086
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/WidgetColumn#config-headerRenderer)
120040
120087
  * @param {object} renderData
120041
120088
  * @param {Grid.column.Column} renderData.column This column
120042
120089
  * @param {HTMLElement} renderData.headerElement The header element
@@ -120087,7 +120134,7 @@ type WidgetColumnConfig = {
120087
120134
  id?: string|number
120088
120135
  /**
120089
120136
  * 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
120090
- * field edit instead of when editing is finished by using `TAB` or `ENTER`
120137
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
120091
120138
  */
120092
120139
  instantUpdate?: boolean
120093
120140
  /**
@@ -120263,7 +120310,7 @@ type WidgetColumnConfig = {
120263
120310
  */
120264
120311
  responsiveLevels?: object
120265
120312
  /**
120266
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
120313
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
120267
120314
  * revert the field to the value it had when the edit began. If the value is *not* changed
120268
120315
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
120269
120316
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -122988,7 +123035,7 @@ export class CellEdit extends GridEditBase {
122988
123035
  /**
122989
123036
  * Displays an OK / Cancel confirmation dialog box owned by the current Editor. This is intended to be
122990
123037
  * used by [finalizeCellEdit](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-finalizeCellEdit) implementations. The returned promise resolves passing
122991
- * `true` if the "OK" button is pressed, and `false` if the "Cancel" button is pressed. Typing `ESC` rejects.
123038
+ * `true` if the "OK" button is pressed, and `false` if the "Cancel" button is pressed. Typing <kbd>Escape</kbd> rejects.
122992
123039
  * @param {object} options An options object for what to show.
122993
123040
  */
122994
123041
  confirm(options: {
@@ -123252,7 +123299,7 @@ type CellMenuConfig = {
123252
123299
 
123253
123300
  /**
123254
123301
  * Right click to display context menu for cells. To invoke the cell menu in a keyboard-accessible manner, use the
123255
- * `SPACE` key when the cell is focused.
123302
+ * <kbd>Space</kbd> key when the cell is focused.
123256
123303
  * ...
123257
123304
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellMenu)
123258
123305
  */
@@ -123525,7 +123572,7 @@ type CellTooltipConfig = {
123525
123572
  */
123526
123573
  closeAction?: 'hide'|'destroy'
123527
123574
  /**
123528
- * Close popup when `ESC` key is pressed.
123575
+ * Close popup when <kbd>Escape</kbd> key is pressed.
123529
123576
  */
123530
123577
  closeOnEscape?: boolean
123531
123578
  /**
@@ -127137,8 +127184,8 @@ type GroupConfig = {
127137
127184
 
127138
127185
  /**
127139
127186
  * Enables rendering and handling of row groups. The actual grouping is done in the store, but triggered by
127140
- * <kbd>shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
127141
- * one anywhere on grid). Use <kbd>shift</kbd> + <kbd>alt</kbd> + click, or the context menu, to remove a column
127187
+ * <kbd>Shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
127188
+ * one anywhere on grid). Use <kbd>Shift</kbd> + <kbd>Alt</kbd> + click, or the context menu, to remove a column
127142
127189
  * grouper.
127143
127190
  * ...
127144
127191
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Group)
@@ -132420,10 +132467,10 @@ type TreeGroupConfig = {
132420
132467
  */
132421
132468
  parentCls?: string
132422
132469
  /**
132423
- * A function letting you format the text shown in the generated parent group levels. This method will be provided
132424
- * with the value produced by the column representing the grouped level. Each column's renderer method will be
132425
- * provided an extra `isTreeGroup` param to indicate that the value will be used for a generated parent. `cellElement`
132426
- * and other DOM specific args will be in the context of the tree column.
132470
+ * A function letting you format the text shown in the generated parent group levels. This method will be
132471
+ * provided with the value produced by the column representing the grouped level. Each column's renderer method
132472
+ * will be provided an extra `isTreeGroup` param to indicate that the value will be used for a generated parent.
132473
+ * `cellElement` and other DOM specific args will be in the context of the tree column.
132427
132474
  * ...
132428
132475
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/TreeGroup#config-parentRenderer)
132429
132476
  * @param {object} data The rendering data representing the generated tree parent record
@@ -133577,7 +133624,7 @@ type ExcelExporterConfig = {
133577
133624
  */
133578
133625
  localizableProperties?: string[]
133579
133626
  /**
133580
- * This hook allows to use 3rd party libraries to generate XLSX files.
133627
+ * This hook allows using 3rd party libraries to generate XLSX files.
133581
133628
  * ...
133582
133629
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/ExcelExporter#config-xlsProvider)
133583
133630
  */
@@ -136072,7 +136119,7 @@ type SinglePageUnscaledExporterConfig = {
136072
136119
 
136073
136120
  /**
136074
136121
  * 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
136075
- * is exported with dimensions required to fit all requested rows and columns. This allows to generate PDF page not
136122
+ * is exported with dimensions required to fit all requested rows and columns. This allows generating a PDF page not
136076
136123
  * constrained by the standard paper formats.
136077
136124
  * ...
136078
136125
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/export/exporter/SinglePageUnscaledExporter)
@@ -136482,7 +136529,7 @@ type GridListenersTypes = {
136482
136529
  */
136483
136530
  beforeCellEditStart: (event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void
136484
136531
  /**
136485
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
136532
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
136486
136533
  * buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
136487
136534
  * @param {object} event Event object
136488
136535
  * @param {Grid.view.Grid} event.source Owner grid
@@ -137447,6 +137494,14 @@ type GridListenersTypes = {
137447
137494
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
137448
137495
  */
137449
137496
  toolClick: (event: { source: Tool, tool: Tool }) => void
137497
+ /**
137498
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
137499
+ * @param {object} event Event object
137500
+ * @param {Grid.view.Grid} event.source The grid instance
137501
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
137502
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
137503
+ */
137504
+ treeGroup: (event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void
137450
137505
  /**
137451
137506
  * Fires when row locking is disabled.
137452
137507
  * @param {object} event Event object
@@ -137501,7 +137556,7 @@ type GridListeners = {
137501
137556
  */
137502
137557
  beforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
137503
137558
  /**
137504
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
137559
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
137505
137560
  * buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
137506
137561
  * @param {object} event Event object
137507
137562
  * @param {Grid.view.Grid} event.source Owner grid
@@ -138466,6 +138521,14 @@ type GridListeners = {
138466
138521
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
138467
138522
  */
138468
138523
  toolClick?: ((event: { source: Tool, tool: Tool }) => void)|string
138524
+ /**
138525
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
138526
+ * @param {object} event Event object
138527
+ * @param {Grid.view.Grid} event.source The grid instance
138528
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
138529
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
138530
+ */
138531
+ treeGroup?: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string
138469
138532
  /**
138470
138533
  * Fires when row locking is disabled.
138471
138534
  * @param {object} event Event object
@@ -139130,7 +139193,7 @@ type GridConfig = {
139130
139193
  rootElement?: ShadowRoot|HTMLElement
139131
139194
  /**
139132
139195
  * Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
139133
- * overriden by specifying a [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
139196
+ * overridden by specifying a [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
139134
139197
  * a column [renderer](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-renderer).
139135
139198
  * ...
139136
139199
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#config-rowHeight)
@@ -139361,7 +139424,7 @@ type GridConfig = {
139361
139424
  */
139362
139425
  onBeforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
139363
139426
  /**
139364
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
139427
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
139365
139428
  * buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
139366
139429
  * @param {object} event Event object
139367
139430
  * @param {Grid.view.Grid} event.source Owner grid
@@ -140326,6 +140389,14 @@ type GridConfig = {
140326
140389
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
140327
140390
  */
140328
140391
  onToolClick?: ((event: { source: Tool, tool: Tool }) => void)|string
140392
+ /**
140393
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
140394
+ * @param {object} event Event object
140395
+ * @param {Grid.view.Grid} event.source The grid instance
140396
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
140397
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
140398
+ */
140399
+ onTreeGroup?: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string
140329
140400
  /**
140330
140401
  * Fires when row locking is disabled.
140331
140402
  * @param {object} event Event object
@@ -140599,7 +140670,7 @@ type GridBaseListenersTypes = {
140599
140670
  */
140600
140671
  beforeCellEditStart: (event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void
140601
140672
  /**
140602
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
140673
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
140603
140674
  * buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
140604
140675
  * @param {object} event Event object
140605
140676
  * @param {Grid.view.Grid} event.source Owner grid
@@ -141564,6 +141635,14 @@ type GridBaseListenersTypes = {
141564
141635
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
141565
141636
  */
141566
141637
  toolClick: (event: { source: Tool, tool: Tool }) => void
141638
+ /**
141639
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
141640
+ * @param {object} event Event object
141641
+ * @param {Grid.view.Grid} event.source The grid instance
141642
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
141643
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
141644
+ */
141645
+ treeGroup: (event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void
141567
141646
  /**
141568
141647
  * Fires when row locking is disabled.
141569
141648
  * @param {object} event Event object
@@ -141618,7 +141697,7 @@ type GridBaseListeners = {
141618
141697
  */
141619
141698
  beforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
141620
141699
  /**
141621
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
141700
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
141622
141701
  * buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
141623
141702
  * @param {object} event Event object
141624
141703
  * @param {Grid.view.Grid} event.source Owner grid
@@ -142583,6 +142662,14 @@ type GridBaseListeners = {
142583
142662
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
142584
142663
  */
142585
142664
  toolClick?: ((event: { source: Tool, tool: Tool }) => void)|string
142665
+ /**
142666
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
142667
+ * @param {object} event Event object
142668
+ * @param {Grid.view.Grid} event.source The grid instance
142669
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
142670
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
142671
+ */
142672
+ treeGroup?: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string
142586
142673
  /**
142587
142674
  * Fires when row locking is disabled.
142588
142675
  * @param {object} event Event object
@@ -143246,7 +143333,7 @@ type GridBaseConfig = {
143246
143333
  rootElement?: ShadowRoot|HTMLElement
143247
143334
  /**
143248
143335
  * Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
143249
- * overriden by specifying a [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
143336
+ * overridden by specifying a [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
143250
143337
  * a column [renderer](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-renderer).
143251
143338
  * ...
143252
143339
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-rowHeight)
@@ -143477,7 +143564,7 @@ type GridBaseConfig = {
143477
143564
  */
143478
143565
  onBeforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
143479
143566
  /**
143480
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
143567
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
143481
143568
  * buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
143482
143569
  * @param {object} event Event object
143483
143570
  * @param {Grid.view.Grid} event.source Owner grid
@@ -144442,6 +144529,14 @@ type GridBaseConfig = {
144442
144529
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
144443
144530
  */
144444
144531
  onToolClick?: ((event: { source: Tool, tool: Tool }) => void)|string
144532
+ /**
144533
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
144534
+ * @param {object} event Event object
144535
+ * @param {Grid.view.Grid} event.source The grid instance
144536
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
144537
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
144538
+ */
144539
+ onTreeGroup?: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string
144445
144540
  /**
144446
144541
  * Fires when row locking is disabled.
144447
144542
  * @param {object} event Event object
@@ -144705,7 +144800,7 @@ export class GridBase extends Panel {
144705
144800
  readonly responsiveLevel: string
144706
144801
  /**
144707
144802
  * Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
144708
- * overriden by specifying a [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
144803
+ * overridden by specifying a [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
144709
144804
  * a column [renderer](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-renderer).
144710
144805
  */
144711
144806
  rowHeight: number
@@ -144825,7 +144920,7 @@ export class GridBase extends Panel {
144825
144920
  */
144826
144921
  onBeforeCellEditStart: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
144827
144922
  /**
144828
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
144923
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
144829
144924
  * buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
144830
144925
  * @param {object} event Event object
144831
144926
  * @param {Grid.view.Grid} event.source Owner grid
@@ -145654,6 +145749,14 @@ export class GridBase extends Panel {
145654
145749
  * @param {boolean} event.collapse `true` if the node is being collapsed.
145655
145750
  */
145656
145751
  onToggleNode: ((event: { record: Model, collapse: boolean }) => void)|string
145752
+ /**
145753
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
145754
+ * @param {object} event Event object
145755
+ * @param {Grid.view.Grid} event.source The grid instance
145756
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
145757
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
145758
+ */
145759
+ onTreeGroup: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string
145657
145760
  /**
145658
145761
  * Fires when row locking is disabled.
145659
145762
  * @param {object} event Event object
@@ -147144,7 +147247,7 @@ type TreeGridListenersTypes = {
147144
147247
  */
147145
147248
  beforeCellEditStart: (event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void
147146
147249
  /**
147147
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
147250
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
147148
147251
  * buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
147149
147252
  * @param {object} event Event object
147150
147253
  * @param {Grid.view.Grid} event.source Owner grid
@@ -148109,6 +148212,14 @@ type TreeGridListenersTypes = {
148109
148212
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
148110
148213
  */
148111
148214
  toolClick: (event: { source: Tool, tool: Tool }) => void
148215
+ /**
148216
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
148217
+ * @param {object} event Event object
148218
+ * @param {Grid.view.Grid} event.source The grid instance
148219
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
148220
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
148221
+ */
148222
+ treeGroup: (event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void
148112
148223
  /**
148113
148224
  * Fires when row locking is disabled.
148114
148225
  * @param {object} event Event object
@@ -148163,7 +148274,7 @@ type TreeGridListeners = {
148163
148274
  */
148164
148275
  beforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
148165
148276
  /**
148166
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
148277
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
148167
148278
  * buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
148168
148279
  * @param {object} event Event object
148169
148280
  * @param {Grid.view.Grid} event.source Owner grid
@@ -149128,6 +149239,14 @@ type TreeGridListeners = {
149128
149239
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
149129
149240
  */
149130
149241
  toolClick?: ((event: { source: Tool, tool: Tool }) => void)|string
149242
+ /**
149243
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
149244
+ * @param {object} event Event object
149245
+ * @param {Grid.view.Grid} event.source The grid instance
149246
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
149247
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
149248
+ */
149249
+ treeGroup?: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string
149131
149250
  /**
149132
149251
  * Fires when row locking is disabled.
149133
149252
  * @param {object} event Event object
@@ -149792,7 +149911,7 @@ type TreeGridConfig = {
149792
149911
  rootElement?: ShadowRoot|HTMLElement
149793
149912
  /**
149794
149913
  * Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
149795
- * overriden by specifying a [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
149914
+ * overridden by specifying a [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
149796
149915
  * a column [renderer](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-renderer).
149797
149916
  * ...
149798
149917
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-rowHeight)
@@ -150023,7 +150142,7 @@ type TreeGridConfig = {
150023
150142
  */
150024
150143
  onBeforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
150025
150144
  /**
150026
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
150145
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
150027
150146
  * buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
150028
150147
  * @param {object} event Event object
150029
150148
  * @param {Grid.view.Grid} event.source Owner grid
@@ -150988,6 +151107,14 @@ type TreeGridConfig = {
150988
151107
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
150989
151108
  */
150990
151109
  onToolClick?: ((event: { source: Tool, tool: Tool }) => void)|string
151110
+ /**
151111
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
151112
+ * @param {object} event Event object
151113
+ * @param {Grid.view.Grid} event.source The grid instance
151114
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
151115
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
151116
+ */
151117
+ onTreeGroup?: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string
150991
151118
  /**
150992
151119
  * Fires when row locking is disabled.
150993
151120
  * @param {object} event Event object
@@ -151733,7 +151860,7 @@ type ExportDialogConfig = {
151733
151860
  */
151734
151861
  closeAction?: 'hide'|'destroy'
151735
151862
  /**
151736
- * Close popup when `ESC` key is pressed.
151863
+ * Close popup when <kbd>Escape</kbd> key is pressed.
151737
151864
  */
151738
151865
  closeOnEscape?: boolean
151739
151866
  /**
@@ -154184,7 +154311,7 @@ type AIFilterFieldConfig = {
154184
154311
  required?: boolean
154185
154312
  /**
154186
154313
  * 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
154187
- * the `ESCAPE` key after editing the field will revert the field to the value it had when
154314
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
154188
154315
  * 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)
154189
154316
  * behaviour will be activated.
154190
154317
  */
@@ -155043,7 +155170,7 @@ type ChecklistFilterComboConfig = {
155043
155170
  contentElementCls?: string|object
155044
155171
  /**
155045
155172
  * If configured as `true`, this means that when an unmatched string is typed into the
155046
- * combo's input field, and `ENTER`, or the [multiValueSeparator](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-multiValueSeparator) is typed,
155173
+ * 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,
155047
155174
  * 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).
155048
155175
  * ...
155049
155176
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-createOnUnmatched)
@@ -155543,7 +155670,7 @@ type ChecklistFilterComboConfig = {
155543
155670
  required?: boolean
155544
155671
  /**
155545
155672
  * 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
155546
- * the `ESCAPE` key after editing the field will revert the field to the value it had when
155673
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
155547
155674
  * 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)
155548
155675
  * behaviour will be activated.
155549
155676
  */
@@ -159857,7 +159984,7 @@ type GroupBarConfig = {
159857
159984
  */
159858
159985
  title?: string
159859
159986
  /**
159860
- * Select/deselect all if `CMD`/`CTRL` is pressed when clicking
159987
+ * Select/deselect all if <kbd>Cmd</kbd>/<kbd>Ctrl</kbd> is pressed when clicking
159861
159988
  */
159862
159989
  toggleAllIfCtrlPressed?: boolean
159863
159990
  /**
@@ -160617,7 +160744,7 @@ type TreeComboConfig = {
160617
160744
  contentElementCls?: string|object
160618
160745
  /**
160619
160746
  * If configured as `true`, this means that when an unmatched string is typed into the
160620
- * combo's input field, and `ENTER`, or the [multiValueSeparator](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-multiValueSeparator) is typed,
160747
+ * 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,
160621
160748
  * 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).
160622
160749
  * ...
160623
160750
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-createOnUnmatched)
@@ -161117,7 +161244,7 @@ type TreeComboConfig = {
161117
161244
  required?: boolean
161118
161245
  /**
161119
161246
  * 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
161120
- * the `ESCAPE` key after editing the field will revert the field to the value it had when
161247
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
161121
161248
  * 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)
161122
161249
  * behaviour will be activated.
161123
161250
  */