@bryntum/grid-trial 7.2.1 → 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.1 (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
  /**
@@ -107666,7 +107679,7 @@ type ActionColumnConfig = {
107666
107679
  id?: string|number
107667
107680
  /**
107668
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
107669
- * 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>
107670
107683
  */
107671
107684
  instantUpdate?: boolean
107672
107685
  /**
@@ -107834,7 +107847,7 @@ type ActionColumnConfig = {
107834
107847
  */
107835
107848
  responsiveLevels?: object
107836
107849
  /**
107837
- * 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
107838
107851
  * revert the field to the value it had when the edit began. If the value is *not* changed
107839
107852
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
107840
107853
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -108398,7 +108411,7 @@ type AggregateColumnConfig = {
108398
108411
  includeParentInChangeSet?: boolean
108399
108412
  /**
108400
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
108401
- * 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>
108402
108415
  */
108403
108416
  instantUpdate?: boolean
108404
108417
  /**
@@ -108583,7 +108596,7 @@ type AggregateColumnConfig = {
108583
108596
  */
108584
108597
  responsiveLevels?: object
108585
108598
  /**
108586
- * 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
108587
108600
  * revert the field to the value it had when the edit began. If the value is *not* changed
108588
108601
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
108589
108602
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -109160,7 +109173,7 @@ type ChartColumnConfig = {
109160
109173
  id?: string|number
109161
109174
  /**
109162
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
109163
- * 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>
109164
109177
  */
109165
109178
  instantUpdate?: boolean
109166
109179
  /**
@@ -109336,7 +109349,7 @@ type ChartColumnConfig = {
109336
109349
  */
109337
109350
  responsiveLevels?: object
109338
109351
  /**
109339
- * 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
109340
109353
  * revert the field to the value it had when the edit began. If the value is *not* changed
109341
109354
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
109342
109355
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -109935,7 +109948,7 @@ type CheckColumnConfig = {
109935
109948
  id?: string|number
109936
109949
  /**
109937
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
109938
- * 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>
109939
109952
  */
109940
109953
  instantUpdate?: boolean
109941
109954
  /**
@@ -110111,7 +110124,7 @@ type CheckColumnConfig = {
110111
110124
  */
110112
110125
  responsiveLevels?: object
110113
110126
  /**
110114
- * 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
110115
110128
  * revert the field to the value it had when the edit began. If the value is *not* changed
110116
110129
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
110117
110130
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -110725,7 +110738,7 @@ type ColorColumnConfig = {
110725
110738
  id?: string|number
110726
110739
  /**
110727
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
110728
- * 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>
110729
110742
  */
110730
110743
  instantUpdate?: boolean
110731
110744
  /**
@@ -110897,7 +110910,7 @@ type ColorColumnConfig = {
110897
110910
  */
110898
110911
  responsiveLevels?: object
110899
110912
  /**
110900
- * 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
110901
110914
  * revert the field to the value it had when the edit began. If the value is *not* changed
110902
110915
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
110903
110916
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -111460,7 +111473,7 @@ type ColumnConfig = {
111460
111473
  id?: string|number
111461
111474
  /**
111462
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
111463
- * 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>
111464
111477
  */
111465
111478
  instantUpdate?: boolean
111466
111479
  /**
@@ -111632,7 +111645,7 @@ type ColumnConfig = {
111632
111645
  */
111633
111646
  responsiveLevels?: object
111634
111647
  /**
111635
- * 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
111636
111649
  * revert the field to the value it had when the edit began. If the value is *not* changed
111637
111650
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
111638
111651
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -111997,7 +112010,7 @@ export class Column extends Model {
111997
112010
  icon: string
111998
112011
  /**
111999
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
112000
- * 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>
112001
112014
  */
112002
112015
  instantUpdate: boolean
112003
112016
  /**
@@ -112093,7 +112106,7 @@ export class Column extends Model {
112093
112106
  */
112094
112107
  responsiveLevels: object
112095
112108
  /**
112096
- * 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
112097
112110
  * revert the field to the value it had when the edit began. If the value is *not* changed
112098
112111
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
112099
112112
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -112762,7 +112775,7 @@ type CurrencyColumnConfig = {
112762
112775
  id?: string|number
112763
112776
  /**
112764
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
112765
- * 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>
112766
112779
  */
112767
112780
  instantUpdate?: boolean
112768
112781
  /**
@@ -112947,7 +112960,7 @@ type CurrencyColumnConfig = {
112947
112960
  */
112948
112961
  responsiveLevels?: object
112949
112962
  /**
112950
- * 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
112951
112964
  * revert the field to the value it had when the edit began. If the value is *not* changed
112952
112965
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
112953
112966
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -113509,7 +113522,7 @@ type DateColumnConfig = {
113509
113522
  id?: string|number
113510
113523
  /**
113511
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
113512
- * 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>
113513
113526
  */
113514
113527
  instantUpdate?: boolean
113515
113528
  /**
@@ -113689,7 +113702,7 @@ type DateColumnConfig = {
113689
113702
  */
113690
113703
  responsiveLevels?: object
113691
113704
  /**
113692
- * 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
113693
113706
  * revert the field to the value it had when the edit began. If the value is *not* changed
113694
113707
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
113695
113708
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -114272,7 +114285,7 @@ type NumberColumnConfig = {
114272
114285
  id?: string|number
114273
114286
  /**
114274
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
114275
- * 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>
114276
114289
  */
114277
114290
  instantUpdate?: boolean
114278
114291
  /**
@@ -114457,7 +114470,7 @@ type NumberColumnConfig = {
114457
114470
  */
114458
114471
  responsiveLevels?: object
114459
114472
  /**
114460
- * 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
114461
114474
  * revert the field to the value it had when the edit began. If the value is *not* changed
114462
114475
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
114463
114476
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -115046,7 +115059,7 @@ type PercentColumnConfig = {
115046
115059
  id?: string|number
115047
115060
  /**
115048
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
115049
- * 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>
115050
115063
  */
115051
115064
  instantUpdate?: boolean
115052
115065
  /**
@@ -115241,7 +115254,7 @@ type PercentColumnConfig = {
115241
115254
  */
115242
115255
  responsiveLevels?: object
115243
115256
  /**
115244
- * 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
115245
115258
  * revert the field to the value it had when the edit began. If the value is *not* changed
115246
115259
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
115247
115260
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -115829,7 +115842,7 @@ type RatingColumnConfig = {
115829
115842
  id?: string|number
115830
115843
  /**
115831
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
115832
- * 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>
115833
115846
  */
115834
115847
  instantUpdate?: boolean
115835
115848
  /**
@@ -116014,7 +116027,7 @@ type RatingColumnConfig = {
116014
116027
  */
116015
116028
  responsiveLevels?: object
116016
116029
  /**
116017
- * 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
116018
116031
  * revert the field to the value it had when the edit began. If the value is *not* changed
116019
116032
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
116020
116033
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -117187,7 +117200,7 @@ type SparklineColumnConfig = {
117187
117200
  id?: string|number
117188
117201
  /**
117189
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
117190
- * 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>
117191
117204
  */
117192
117205
  instantUpdate?: boolean
117193
117206
  /**
@@ -117363,7 +117376,7 @@ type SparklineColumnConfig = {
117363
117376
  */
117364
117377
  responsiveLevels?: object
117365
117378
  /**
117366
- * 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
117367
117380
  * revert the field to the value it had when the edit began. If the value is *not* changed
117368
117381
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
117369
117382
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -117901,7 +117914,7 @@ type TemplateColumnConfig = {
117901
117914
  id?: string|number
117902
117915
  /**
117903
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
117904
- * 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>
117905
117918
  */
117906
117919
  instantUpdate?: boolean
117907
117920
  /**
@@ -118073,7 +118086,7 @@ type TemplateColumnConfig = {
118073
118086
  */
118074
118087
  responsiveLevels?: object
118075
118088
  /**
118076
- * 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
118077
118090
  * revert the field to the value it had when the edit began. If the value is *not* changed
118078
118091
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
118079
118092
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -118630,7 +118643,7 @@ type TimeColumnConfig = {
118630
118643
  id?: string|number
118631
118644
  /**
118632
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
118633
- * 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>
118634
118647
  */
118635
118648
  instantUpdate?: boolean
118636
118649
  /**
@@ -118802,7 +118815,7 @@ type TimeColumnConfig = {
118802
118815
  */
118803
118816
  responsiveLevels?: object
118804
118817
  /**
118805
- * 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
118806
118819
  * revert the field to the value it had when the edit began. If the value is *not* changed
118807
118820
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
118808
118821
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -119368,7 +119381,7 @@ type TreeColumnConfig = {
119368
119381
  indentSize?: number
119369
119382
  /**
119370
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
119371
- * 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>
119372
119385
  */
119373
119386
  instantUpdate?: boolean
119374
119387
  /**
@@ -119544,7 +119557,7 @@ type TreeColumnConfig = {
119544
119557
  */
119545
119558
  responsiveLevels?: object
119546
119559
  /**
119547
- * 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
119548
119561
  * revert the field to the value it had when the edit began. If the value is *not* changed
119549
119562
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
119550
119563
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -120121,7 +120134,7 @@ type WidgetColumnConfig = {
120121
120134
  id?: string|number
120122
120135
  /**
120123
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
120124
- * 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>
120125
120138
  */
120126
120139
  instantUpdate?: boolean
120127
120140
  /**
@@ -120297,7 +120310,7 @@ type WidgetColumnConfig = {
120297
120310
  */
120298
120311
  responsiveLevels?: object
120299
120312
  /**
120300
- * 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
120301
120314
  * revert the field to the value it had when the edit began. If the value is *not* changed
120302
120315
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
120303
120316
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -123022,7 +123035,7 @@ export class CellEdit extends GridEditBase {
123022
123035
  /**
123023
123036
  * Displays an OK / Cancel confirmation dialog box owned by the current Editor. This is intended to be
123024
123037
  * used by [finalizeCellEdit](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-finalizeCellEdit) implementations. The returned promise resolves passing
123025
- * `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.
123026
123039
  * @param {object} options An options object for what to show.
123027
123040
  */
123028
123041
  confirm(options: {
@@ -123286,7 +123299,7 @@ type CellMenuConfig = {
123286
123299
 
123287
123300
  /**
123288
123301
  * Right click to display context menu for cells. To invoke the cell menu in a keyboard-accessible manner, use the
123289
- * `SPACE` key when the cell is focused.
123302
+ * <kbd>Space</kbd> key when the cell is focused.
123290
123303
  * ...
123291
123304
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellMenu)
123292
123305
  */
@@ -123559,7 +123572,7 @@ type CellTooltipConfig = {
123559
123572
  */
123560
123573
  closeAction?: 'hide'|'destroy'
123561
123574
  /**
123562
- * Close popup when `ESC` key is pressed.
123575
+ * Close popup when <kbd>Escape</kbd> key is pressed.
123563
123576
  */
123564
123577
  closeOnEscape?: boolean
123565
123578
  /**
@@ -127171,8 +127184,8 @@ type GroupConfig = {
127171
127184
 
127172
127185
  /**
127173
127186
  * Enables rendering and handling of row groups. The actual grouping is done in the store, but triggered by
127174
- * <kbd>shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
127175
- * 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
127176
127189
  * grouper.
127177
127190
  * ...
127178
127191
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Group)
@@ -132454,10 +132467,10 @@ type TreeGroupConfig = {
132454
132467
  */
132455
132468
  parentCls?: string
132456
132469
  /**
132457
- * A function letting you format the text shown in the generated parent group levels. This method will be provided
132458
- * with the value produced by the column representing the grouped level. Each column's renderer method will be
132459
- * provided an extra `isTreeGroup` param to indicate that the value will be used for a generated parent. `cellElement`
132460
- * 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.
132461
132474
  * ...
132462
132475
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/TreeGroup#config-parentRenderer)
132463
132476
  * @param {object} data The rendering data representing the generated tree parent record
@@ -133611,7 +133624,7 @@ type ExcelExporterConfig = {
133611
133624
  */
133612
133625
  localizableProperties?: string[]
133613
133626
  /**
133614
- * This hook allows to use 3rd party libraries to generate XLSX files.
133627
+ * This hook allows using 3rd party libraries to generate XLSX files.
133615
133628
  * ...
133616
133629
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/ExcelExporter#config-xlsProvider)
133617
133630
  */
@@ -136106,7 +136119,7 @@ type SinglePageUnscaledExporterConfig = {
136106
136119
 
136107
136120
  /**
136108
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
136109
- * 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
136110
136123
  * constrained by the standard paper formats.
136111
136124
  * ...
136112
136125
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/export/exporter/SinglePageUnscaledExporter)
@@ -136516,7 +136529,7 @@ type GridListenersTypes = {
136516
136529
  */
136517
136530
  beforeCellEditStart: (event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void
136518
136531
  /**
136519
- * 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>
136520
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.
136521
136534
  * @param {object} event Event object
136522
136535
  * @param {Grid.view.Grid} event.source Owner grid
@@ -137481,6 +137494,14 @@ type GridListenersTypes = {
137481
137494
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
137482
137495
  */
137483
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
137484
137505
  /**
137485
137506
  * Fires when row locking is disabled.
137486
137507
  * @param {object} event Event object
@@ -137535,7 +137556,7 @@ type GridListeners = {
137535
137556
  */
137536
137557
  beforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
137537
137558
  /**
137538
- * 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>
137539
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.
137540
137561
  * @param {object} event Event object
137541
137562
  * @param {Grid.view.Grid} event.source Owner grid
@@ -138500,6 +138521,14 @@ type GridListeners = {
138500
138521
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
138501
138522
  */
138502
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
138503
138532
  /**
138504
138533
  * Fires when row locking is disabled.
138505
138534
  * @param {object} event Event object
@@ -139164,7 +139193,7 @@ type GridConfig = {
139164
139193
  rootElement?: ShadowRoot|HTMLElement
139165
139194
  /**
139166
139195
  * Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
139167
- * 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
139168
139197
  * a column [renderer](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-renderer).
139169
139198
  * ...
139170
139199
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#config-rowHeight)
@@ -139395,7 +139424,7 @@ type GridConfig = {
139395
139424
  */
139396
139425
  onBeforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
139397
139426
  /**
139398
- * 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>
139399
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.
139400
139429
  * @param {object} event Event object
139401
139430
  * @param {Grid.view.Grid} event.source Owner grid
@@ -140360,6 +140389,14 @@ type GridConfig = {
140360
140389
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
140361
140390
  */
140362
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
140363
140400
  /**
140364
140401
  * Fires when row locking is disabled.
140365
140402
  * @param {object} event Event object
@@ -140633,7 +140670,7 @@ type GridBaseListenersTypes = {
140633
140670
  */
140634
140671
  beforeCellEditStart: (event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void
140635
140672
  /**
140636
- * 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>
140637
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.
140638
140675
  * @param {object} event Event object
140639
140676
  * @param {Grid.view.Grid} event.source Owner grid
@@ -141598,6 +141635,14 @@ type GridBaseListenersTypes = {
141598
141635
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
141599
141636
  */
141600
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
141601
141646
  /**
141602
141647
  * Fires when row locking is disabled.
141603
141648
  * @param {object} event Event object
@@ -141652,7 +141697,7 @@ type GridBaseListeners = {
141652
141697
  */
141653
141698
  beforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
141654
141699
  /**
141655
- * 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>
141656
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.
141657
141702
  * @param {object} event Event object
141658
141703
  * @param {Grid.view.Grid} event.source Owner grid
@@ -142617,6 +142662,14 @@ type GridBaseListeners = {
142617
142662
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
142618
142663
  */
142619
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
142620
142673
  /**
142621
142674
  * Fires when row locking is disabled.
142622
142675
  * @param {object} event Event object
@@ -143280,7 +143333,7 @@ type GridBaseConfig = {
143280
143333
  rootElement?: ShadowRoot|HTMLElement
143281
143334
  /**
143282
143335
  * Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
143283
- * 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
143284
143337
  * a column [renderer](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-renderer).
143285
143338
  * ...
143286
143339
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-rowHeight)
@@ -143511,7 +143564,7 @@ type GridBaseConfig = {
143511
143564
  */
143512
143565
  onBeforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
143513
143566
  /**
143514
- * 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>
143515
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.
143516
143569
  * @param {object} event Event object
143517
143570
  * @param {Grid.view.Grid} event.source Owner grid
@@ -144476,6 +144529,14 @@ type GridBaseConfig = {
144476
144529
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
144477
144530
  */
144478
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
144479
144540
  /**
144480
144541
  * Fires when row locking is disabled.
144481
144542
  * @param {object} event Event object
@@ -144739,7 +144800,7 @@ export class GridBase extends Panel {
144739
144800
  readonly responsiveLevel: string
144740
144801
  /**
144741
144802
  * Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
144742
- * 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
144743
144804
  * a column [renderer](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-renderer).
144744
144805
  */
144745
144806
  rowHeight: number
@@ -144859,7 +144920,7 @@ export class GridBase extends Panel {
144859
144920
  */
144860
144921
  onBeforeCellEditStart: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
144861
144922
  /**
144862
- * 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>
144863
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.
144864
144925
  * @param {object} event Event object
144865
144926
  * @param {Grid.view.Grid} event.source Owner grid
@@ -145688,6 +145749,14 @@ export class GridBase extends Panel {
145688
145749
  * @param {boolean} event.collapse `true` if the node is being collapsed.
145689
145750
  */
145690
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
145691
145760
  /**
145692
145761
  * Fires when row locking is disabled.
145693
145762
  * @param {object} event Event object
@@ -147178,7 +147247,7 @@ type TreeGridListenersTypes = {
147178
147247
  */
147179
147248
  beforeCellEditStart: (event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void
147180
147249
  /**
147181
- * 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>
147182
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.
147183
147252
  * @param {object} event Event object
147184
147253
  * @param {Grid.view.Grid} event.source Owner grid
@@ -148143,6 +148212,14 @@ type TreeGridListenersTypes = {
148143
148212
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
148144
148213
  */
148145
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
148146
148223
  /**
148147
148224
  * Fires when row locking is disabled.
148148
148225
  * @param {object} event Event object
@@ -148197,7 +148274,7 @@ type TreeGridListeners = {
148197
148274
  */
148198
148275
  beforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
148199
148276
  /**
148200
- * 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>
148201
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.
148202
148279
  * @param {object} event Event object
148203
148280
  * @param {Grid.view.Grid} event.source Owner grid
@@ -149162,6 +149239,14 @@ type TreeGridListeners = {
149162
149239
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
149163
149240
  */
149164
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
149165
149250
  /**
149166
149251
  * Fires when row locking is disabled.
149167
149252
  * @param {object} event Event object
@@ -149826,7 +149911,7 @@ type TreeGridConfig = {
149826
149911
  rootElement?: ShadowRoot|HTMLElement
149827
149912
  /**
149828
149913
  * Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
149829
- * 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
149830
149915
  * a column [renderer](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-renderer).
149831
149916
  * ...
149832
149917
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-rowHeight)
@@ -150057,7 +150142,7 @@ type TreeGridConfig = {
150057
150142
  */
150058
150143
  onBeforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
150059
150144
  /**
150060
- * 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>
150061
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.
150062
150147
  * @param {object} event Event object
150063
150148
  * @param {Grid.view.Grid} event.source Owner grid
@@ -151022,6 +151107,14 @@ type TreeGridConfig = {
151022
151107
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
151023
151108
  */
151024
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
151025
151118
  /**
151026
151119
  * Fires when row locking is disabled.
151027
151120
  * @param {object} event Event object
@@ -151767,7 +151860,7 @@ type ExportDialogConfig = {
151767
151860
  */
151768
151861
  closeAction?: 'hide'|'destroy'
151769
151862
  /**
151770
- * Close popup when `ESC` key is pressed.
151863
+ * Close popup when <kbd>Escape</kbd> key is pressed.
151771
151864
  */
151772
151865
  closeOnEscape?: boolean
151773
151866
  /**
@@ -154218,7 +154311,7 @@ type AIFilterFieldConfig = {
154218
154311
  required?: boolean
154219
154312
  /**
154220
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
154221
- * 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
154222
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)
154223
154316
  * behaviour will be activated.
154224
154317
  */
@@ -155077,7 +155170,7 @@ type ChecklistFilterComboConfig = {
155077
155170
  contentElementCls?: string|object
155078
155171
  /**
155079
155172
  * If configured as `true`, this means that when an unmatched string is typed into the
155080
- * 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,
155081
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).
155082
155175
  * ...
155083
155176
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-createOnUnmatched)
@@ -155577,7 +155670,7 @@ type ChecklistFilterComboConfig = {
155577
155670
  required?: boolean
155578
155671
  /**
155579
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
155580
- * 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
155581
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)
155582
155675
  * behaviour will be activated.
155583
155676
  */
@@ -159891,7 +159984,7 @@ type GroupBarConfig = {
159891
159984
  */
159892
159985
  title?: string
159893
159986
  /**
159894
- * 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
159895
159988
  */
159896
159989
  toggleAllIfCtrlPressed?: boolean
159897
159990
  /**
@@ -160651,7 +160744,7 @@ type TreeComboConfig = {
160651
160744
  contentElementCls?: string|object
160652
160745
  /**
160653
160746
  * If configured as `true`, this means that when an unmatched string is typed into the
160654
- * 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,
160655
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).
160656
160749
  * ...
160657
160750
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-createOnUnmatched)
@@ -161151,7 +161244,7 @@ type TreeComboConfig = {
161151
161244
  required?: boolean
161152
161245
  /**
161153
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
161154
- * 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
161155
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)
161156
161249
  * behaviour will be activated.
161157
161250
  */