@bryntum/grid-trial 7.2.1 → 7.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/grid.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  /*!
2
2
  *
3
- * Bryntum Grid 7.2.1 (TRIAL VERSION)
3
+ * Bryntum Grid 7.2.3 (TRIAL VERSION)
4
4
  *
5
5
  * Copyright(c) 2026 Bryntum AB
6
6
  * https://bryntum.com/contact
@@ -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
  */
@@ -2416,6 +2420,12 @@ type GlobalEventsListenersTypes = {
2416
2420
  * @param {string} event.theme The new theme name
2417
2421
  */
2418
2422
  theme: (event: { source: typeof GlobalEvents, theme: string }) => void
2423
+ /**
2424
+ * Fired when the browser zoom level is changed by the user
2425
+ * @param {object} event Event object
2426
+ * @param {typeof GlobalEvents} event.source
2427
+ */
2428
+ zoomChange: (event: { source: typeof GlobalEvents }) => void
2419
2429
  }
2420
2430
 
2421
2431
  /**
@@ -2454,6 +2464,12 @@ type GlobalEventsListeners = {
2454
2464
  * @param {string} event.theme The new theme name
2455
2465
  */
2456
2466
  theme?: ((event: { source: typeof GlobalEvents, theme: string }) => void)|string
2467
+ /**
2468
+ * Fired when the browser zoom level is changed by the user
2469
+ * @param {object} event Event object
2470
+ * @param {typeof GlobalEvents} event.source
2471
+ */
2472
+ zoomChange?: ((event: { source: typeof GlobalEvents }) => void)|string
2457
2473
  }
2458
2474
 
2459
2475
  export class GlobalEventsSingleton {
@@ -2502,6 +2518,12 @@ export class GlobalEventsSingleton {
2502
2518
  * @param {string} event.theme The new theme name
2503
2519
  */
2504
2520
  onTheme: ((event: { source: typeof GlobalEvents, theme: string }) => void)|string
2521
+ /**
2522
+ * Fired when the browser zoom level is changed by the user
2523
+ * @param {object} event Event object
2524
+ * @param {typeof GlobalEvents} event.source
2525
+ */
2526
+ onZoomChange: ((event: { source: typeof GlobalEvents }) => void)|string
2505
2527
  /**
2506
2528
  * Adds an event listener. This method accepts parameters in the following format:
2507
2529
  * @param {BryntumListenerConfig,string} config An object containing listener definitions, or the event name to listen for
@@ -5417,7 +5439,8 @@ export class Model extends Base {
5417
5439
  readonly lastChild: Model
5418
5440
  /**
5419
5441
  * 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.
5442
+ * is used as the property name in the returned object. The record's id is included unless its
5443
+ * [persist](https://bryntum.com/products/grid/docs/api/Core/data/field/DataField#config-persist) config is `false`.
5421
5444
  */
5422
5445
  readonly modificationData: object
5423
5446
  /**
@@ -7106,6 +7129,11 @@ export class Store extends Base {
7106
7129
  * Setting `autoCommit` to `true` automatically commits changes to records.
7107
7130
  */
7108
7131
  autoCommit: boolean
7132
+ /**
7133
+ * Returns the root store in the chain — the store that is not itself chained. For a store chained
7134
+ * off another chained store, this walks up the full chain. Returns `this` if the store is not chained.
7135
+ */
7136
+ readonly baseStore: Store
7109
7137
  /**
7110
7138
  * Set to `true` to call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
7111
7139
  */
@@ -7193,6 +7221,11 @@ export class Store extends Base {
7193
7221
  * Yields `true` if this Store is loaded page by page. See the [remotePaging](https://bryntum.com/products/grid/docs/api/Core/data/mixin/StorePaging#config-remotePaging) config.
7194
7222
  */
7195
7223
  readonly isPaged: boolean
7224
+ /**
7225
+ * Returns `true` if the data in this store depends on a remote data source. That is this
7226
+ * Store is an AjaxStore, or uses [requestData](https://bryntum.com/products/grid/docs/api/Core/data/Store#config-requestData), or is chained off an AjaxStore.
7227
+ */
7228
+ readonly isRemoteLoad: boolean
7196
7229
  /**
7197
7230
  * Is store sorted?
7198
7231
  */
@@ -10027,6 +10060,11 @@ export class StoreChainedClass {
10027
10060
  * Identifies an object as an instance of [StoreChained](https://bryntum.com/products/grid/docs/api/Core/data/mixin/StoreChained) class, or subclass thereof.
10028
10061
  */
10029
10062
  static readonly isStoreChained: boolean
10063
+ /**
10064
+ * Returns the root store in the chain — the store that is not itself chained. For a store chained
10065
+ * off another chained store, this walks up the full chain. Returns `this` if the store is not chained.
10066
+ */
10067
+ readonly baseStore: Store
10030
10068
  /**
10031
10069
  * Is this a chained store?
10032
10070
  */
@@ -14429,7 +14467,7 @@ export class DateHelper {
14429
14467
  */
14430
14468
  static isBefore(first: Date, second: Date): boolean;
14431
14469
  /**
14432
- * Checks if value is a date object. Allows to recognize date object even from another context,
14470
+ * Checks if value is a date object. Allows recognizing date object even from another context,
14433
14471
  * like the top frame when used in an iframe.
14434
14472
  * @param {any} value Value to check
14435
14473
  */
@@ -15000,11 +15038,19 @@ export class DomSync {
15000
15038
  * @param {string} path Dot '.' separated path of syncIdMap entries
15001
15039
  */
15002
15040
  static getChild(element: HTMLElement, path: string): HTMLElement;
15041
+ /**
15042
+ * Remove an element without syncing, cleaning up its parent's syncIdMap.
15043
+ * Unlike [removeChild](https://bryntum.com/products/grid/docs/api/Core/helper/DomSync#function-removeChild-static), this works correctly for descendant elements
15044
+ * (not just direct children).
15045
+ * @param {HTMLElement} childElement The element to remove
15046
+ */
15047
+ static remove(childElement: HTMLElement): void;
15003
15048
  /**
15004
15049
  * Remove a child element without syncing, for example when dragging an element to some other parent.
15005
15050
  * Removes it both from DOM and the parent elements syncMap
15006
15051
  * @param {HTMLElement} parentElement
15007
15052
  * @param {HTMLElement} childElement
15053
+ * @deprecated Since 7.2.1. Use [remove](https://bryntum.com/products/grid/docs/api/Core/helper/DomSync#function-remove-static) instead.
15008
15054
  */
15009
15055
  static removeChild(parentElement: HTMLElement, childElement: HTMLElement): void;
15010
15056
  /**
@@ -16025,7 +16071,8 @@ export class ObjectHelper {
16025
16071
  }
16026
16072
 
16027
16073
  /**
16028
- * Helper for string manipulation.
16074
+ * A static utility class providing common string manipulation methods such as HTML encoding, camelCase
16075
+ * conversion, regular expression escaping, and markdown-to-HTML processing.
16029
16076
  * ...
16030
16077
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/helper/StringHelper)
16031
16078
  */
@@ -16609,8 +16656,9 @@ export class Rectangle {
16609
16656
  * @param {HTMLElement,Core.widget.Widget,Core.widget.Mask,string} element The element (or selector) to calculate the Rectangle for.
16610
16657
  * @param {HTMLElement,string} relativeTo Optionally, a parent element (or selector) in whose space to calculate the Rectangle.
16611
16658
  * @param {boolean} ignorePageScroll Use browser viewport based coordinates.
16659
+ * @param {boolean} rtl Pass `true` when the `relativeTo` element uses RTL direction. Normalizes the negative `scrollLeft` values that browsers use in RTL mode so that content-space coordinates are correct.
16612
16660
  */
16613
- static from(element: HTMLElement|Widget|Mask|string, relativeTo?: HTMLElement|string, ignorePageScroll?: boolean): Rectangle;
16661
+ static from(element: HTMLElement|Widget|Mask|string, relativeTo?: HTMLElement|string, ignorePageScroll?: boolean, rtl?: boolean): Rectangle;
16614
16662
  /**
16615
16663
  * Returns the Rectangle in viewport coordinates of the passed element.
16616
16664
  * @param {HTMLElement} element The element to calculate the Rectangle for.
@@ -16672,7 +16720,7 @@ export class Rectangle {
16672
16720
  */
16673
16721
  contains(other: Rectangle): boolean;
16674
16722
  /**
16675
- * Clips off the area of the "other" Rectangle(s) from this Rectangle if any of the the other rectangles occlude
16723
+ * Clips off the area of the "other" Rectangle(s) from this Rectangle if any of the other rectangles occlude
16676
16724
  * a whole edge of this Rectangle.
16677
16725
  * @param {Core.helper.util.Rectangle} other The potentially occluding Rectangle(s).
16678
16726
  */
@@ -17144,8 +17192,8 @@ export class Scroller extends Base {
17144
17192
  resumeEvents(): boolean;
17145
17193
  /**
17146
17194
  * Scrolls by the passed deltas according to the passed options.
17147
- * @param {number} xDelta How far to scroll in the X axis.
17148
- * @param {number} yDelta How far to scroll in the Y axis.
17195
+ * @param {number} xDelta How far to scroll along the X axis.
17196
+ * @param {number} yDelta How far to scroll along the Y axis.
17149
17197
  * @param {object,boolean} options How to scroll. May be passed as `true` to animate.
17150
17198
  */
17151
17199
  scrollBy(xDelta?: number, yDelta?: number, options?: {
@@ -26107,7 +26155,7 @@ type CheckboxConfig = {
26107
26155
  required?: boolean
26108
26156
  /**
26109
26157
  * 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
26158
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
26111
26159
  * 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
26160
  * behaviour will be activated.
26113
26161
  */
@@ -28749,7 +28797,7 @@ type ChipViewConfig = {
28749
28797
  */
28750
28798
  title?: string
28751
28799
  /**
28752
- * Select/deselect all if `CMD`/`CTRL` is pressed when clicking
28800
+ * Select/deselect all if <kbd>Cmd</kbd>/<kbd>Ctrl</kbd> is pressed when clicking
28753
28801
  */
28754
28802
  toggleAllIfCtrlPressed?: boolean
28755
28803
  /**
@@ -31127,7 +31175,7 @@ type ColorFieldConfig = {
31127
31175
  required?: boolean
31128
31176
  /**
31129
31177
  * 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
31178
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
31131
31179
  * 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
31180
  * behaviour will be activated.
31133
31181
  */
@@ -32337,7 +32385,7 @@ type ColorPickerConfig = {
32337
32385
  */
32338
32386
  title?: string
32339
32387
  /**
32340
- * Select/deselect all if `CMD`/`CTRL` is pressed when clicking
32388
+ * Select/deselect all if <kbd>Cmd</kbd>/<kbd>Ctrl</kbd> is pressed when clicking
32341
32389
  */
32342
32390
  toggleAllIfCtrlPressed?: boolean
32343
32391
  /**
@@ -33114,7 +33162,7 @@ type ComboConfig = {
33114
33162
  contentElementCls?: string|object
33115
33163
  /**
33116
33164
  * 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,
33165
+ * 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
33166
  * 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
33167
  * ...
33120
33168
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-createOnUnmatched)
@@ -33614,7 +33662,7 @@ type ComboConfig = {
33614
33662
  required?: boolean
33615
33663
  /**
33616
33664
  * 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
33665
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
33618
33666
  * 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
33667
  * behaviour will be activated.
33620
33668
  */
@@ -33967,7 +34015,7 @@ export class Combo extends PickerField {
33967
34015
  filterOperator: CollectionCompareOperator
33968
34016
  /**
33969
34017
  * Returns array of the Combo's inner HTML elements.
33970
- * This getter can be overriden.
34018
+ * This getter can be overridden.
33971
34019
  */
33972
34020
  get innerElements(): (HTMLElement|DomConfig)[]
33973
34021
  /**
@@ -34674,7 +34722,7 @@ type ConfirmationBarConfig = {
34674
34722
  */
34675
34723
  items?: string|Record<string, ContainerItemConfig|MenuItemEntry>|(ContainerItemConfig|MenuItemEntry|Widget)[]
34676
34724
  /**
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.
34725
+ * 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
34726
  */
34679
34727
  keyMap?: Record<string, KeyMapConfig>
34680
34728
  /**
@@ -37226,7 +37274,7 @@ type DateFieldConfig = {
37226
37274
  required?: boolean
37227
37275
  /**
37228
37276
  * 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
37277
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
37230
37278
  * 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
37279
  * behaviour will be activated.
37232
37280
  */
@@ -40128,7 +40176,7 @@ type DateRangeFieldConfig = {
40128
40176
  required?: boolean
40129
40177
  /**
40130
40178
  * 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
40179
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
40132
40180
  * 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
40181
  * behaviour will be activated.
40134
40182
  */
@@ -42767,7 +42815,7 @@ type DateTimeFieldConfig = {
42767
42815
  required?: boolean
42768
42816
  /**
42769
42817
  * 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
42818
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
42771
42819
  * 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
42820
  * behaviour will be activated.
42773
42821
  */
@@ -42876,7 +42924,7 @@ type DateTimeFieldConfig = {
42876
42924
  value?: string
42877
42925
  /**
42878
42926
  * The week start day in the [picker](https://bryntum.com/products/grid/docs/api/Core/widget/DateField#config-picker), 0 meaning Sunday, 6 meaning Saturday.
42879
- * Uses localized value per default.
42927
+ * Uses a localized value by default.
42880
42928
  */
42881
42929
  weekStartDay?: number
42882
42930
  /**
@@ -46193,7 +46241,7 @@ type DisplayFieldConfig = {
46193
46241
  required?: boolean
46194
46242
  /**
46195
46243
  * 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
46244
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
46197
46245
  * 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
46246
  * behaviour will be activated.
46199
46247
  */
@@ -47389,7 +47437,7 @@ type DurationFieldConfig = {
47389
47437
  required?: boolean
47390
47438
  /**
47391
47439
  * 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
47440
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
47393
47441
  * 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
47442
  * behaviour will be activated.
47395
47443
  */
@@ -47820,7 +47868,7 @@ type EditorListenersTypes = {
47820
47868
  */
47821
47869
  afterEdit: (event: { source: Editor, record?: Model }) => void
47822
47870
  /**
47823
- * Fired when cancellation has been requested, either by `ESC`, or focus loss (if configured to cancel on blur).
47871
+ * Fired when cancellation has been requested, either by <kbd>Escape</kbd>, or focus loss (if configured to cancel on blur).
47824
47872
  * The cancellation may be vetoed, in which case, focus is moved back into the editor.
47825
47873
  * @param {object} event Event object
47826
47874
  * @param {object} event.oldValue The original value.
@@ -47830,7 +47878,7 @@ type EditorListenersTypes = {
47830
47878
  */
47831
47879
  beforeCancel: (event: { oldValue: object, value: object, event: Event, source: Editor }) => Promise<boolean>|boolean|void
47832
47880
  /**
47833
- * Fired when an edit completion has been requested, either by `ENTER`, or focus loss (if configured to complete on blur).
47881
+ * Fired when an edit completion has been requested, either by <kbd>Enter</kbd>, or focus loss (if configured to complete on blur).
47834
47882
  * The completion may be vetoed, in which case, focus is moved back into the editor.
47835
47883
  * @param {object} event Event object
47836
47884
  * @param {object} event.oldValue The original value.
@@ -48025,7 +48073,7 @@ type EditorListeners = {
48025
48073
  */
48026
48074
  afterEdit?: ((event: { source: Editor, record?: Model }) => void)|string
48027
48075
  /**
48028
- * Fired when cancellation has been requested, either by `ESC`, or focus loss (if configured to cancel on blur).
48076
+ * Fired when cancellation has been requested, either by <kbd>Escape</kbd>, or focus loss (if configured to cancel on blur).
48029
48077
  * The cancellation may be vetoed, in which case, focus is moved back into the editor.
48030
48078
  * @param {object} event Event object
48031
48079
  * @param {object} event.oldValue The original value.
@@ -48035,7 +48083,7 @@ type EditorListeners = {
48035
48083
  */
48036
48084
  beforeCancel?: ((event: { oldValue: object, value: object, event: Event, source: Editor }) => Promise<boolean>|boolean|void)|string
48037
48085
  /**
48038
- * Fired when an edit completion has been requested, either by `ENTER`, or focus loss (if configured to complete on blur).
48086
+ * Fired when an edit completion has been requested, either by <kbd>Enter</kbd>, or focus loss (if configured to complete on blur).
48039
48087
  * The completion may be vetoed, in which case, focus is moved back into the editor.
48040
48088
  * @param {object} event Event object
48041
48089
  * @param {object} event.oldValue The original value.
@@ -48269,7 +48317,7 @@ type EditorConfig = {
48269
48317
  */
48270
48318
  autoUpdateRecord?: boolean
48271
48319
  /**
48272
- * What action should be taken when focus moves out of the editor, either by `TAB` or clicking outside.
48320
+ * What action should be taken when focus moves out of the editor, either by <kbd>Tab</kbd> or clicking outside.
48273
48321
  * May be `'complete'` or `'cancel`'. Any other value results in no action being taken upon focus leaving the editor
48274
48322
  * leaving the application to listen for the [focusOut](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#event-focusOut) event.
48275
48323
  */
@@ -48853,7 +48901,7 @@ type EditorConfig = {
48853
48901
  */
48854
48902
  onAfterEdit?: ((event: { source: Editor, record?: Model }) => void)|string
48855
48903
  /**
48856
- * Fired when cancellation has been requested, either by `ESC`, or focus loss (if configured to cancel on blur).
48904
+ * Fired when cancellation has been requested, either by <kbd>Escape</kbd>, or focus loss (if configured to cancel on blur).
48857
48905
  * The cancellation may be vetoed, in which case, focus is moved back into the editor.
48858
48906
  * @param {object} event Event object
48859
48907
  * @param {object} event.oldValue The original value.
@@ -48863,7 +48911,7 @@ type EditorConfig = {
48863
48911
  */
48864
48912
  onBeforeCancel?: ((event: { oldValue: object, value: object, event: Event, source: Editor }) => Promise<boolean>|boolean|void)|string
48865
48913
  /**
48866
- * Fired when an edit completion has been requested, either by `ENTER`, or focus loss (if configured to complete on blur).
48914
+ * Fired when an edit completion has been requested, either by <kbd>Enter</kbd>, or focus loss (if configured to complete on blur).
48867
48915
  * The completion may be vetoed, in which case, focus is moved back into the editor.
48868
48916
  * @param {object} event Event object
48869
48917
  * @param {object} event.oldValue The original value.
@@ -49069,7 +49117,7 @@ export class Editor extends Container {
49069
49117
  */
49070
49118
  onAfterEdit: ((event: { source: Editor, record?: Model }) => void)|string
49071
49119
  /**
49072
- * Fired when cancellation has been requested, either by `ESC`, or focus loss (if configured to cancel on blur).
49120
+ * Fired when cancellation has been requested, either by <kbd>Escape</kbd>, or focus loss (if configured to cancel on blur).
49073
49121
  * The cancellation may be vetoed, in which case, focus is moved back into the editor.
49074
49122
  * @param {object} event Event object
49075
49123
  * @param {object} event.oldValue The original value.
@@ -49079,7 +49127,7 @@ export class Editor extends Container {
49079
49127
  */
49080
49128
  onBeforeCancel: ((event: { oldValue: object, value: object, event: Event, source: Editor }) => Promise<boolean>|boolean|void)|string
49081
49129
  /**
49082
- * Fired when an edit completion has been requested, either by `ENTER`, or focus loss (if configured to complete on blur).
49130
+ * Fired when an edit completion has been requested, either by <kbd>Enter</kbd>, or focus loss (if configured to complete on blur).
49083
49131
  * The completion may be vetoed, in which case, focus is moved back into the editor.
49084
49132
  * @param {object} event Event object
49085
49133
  * @param {object} event.oldValue The original value.
@@ -49996,7 +50044,7 @@ type FieldConfig = {
49996
50044
  required?: boolean
49997
50045
  /**
49998
50046
  * 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
50047
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
50000
50048
  * 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
50049
  * behaviour will be activated.
50002
50050
  */
@@ -55883,7 +55931,7 @@ type FileFieldConfig = {
55883
55931
  required?: boolean
55884
55932
  /**
55885
55933
  * 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
55934
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
55887
55935
  * 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
55936
  * behaviour will be activated.
55889
55937
  */
@@ -58147,7 +58195,7 @@ type FilterFieldConfig = {
58147
58195
  required?: boolean
58148
58196
  /**
58149
58197
  * 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
58198
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
58151
58199
  * 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
58200
  * behaviour will be activated.
58153
58201
  */
@@ -58931,7 +58979,7 @@ type HintConfig = {
58931
58979
  */
58932
58980
  catchEventHandlerExceptions?: boolean
58933
58981
  /**
58934
- * Close popup when `ESC` key is pressed.
58982
+ * Close popup when <kbd>Escape</kbd> key is pressed.
58935
58983
  */
58936
58984
  closeOnEscape?: boolean
58937
58985
  /**
@@ -61486,7 +61534,7 @@ type ListConfig = {
61486
61534
  */
61487
61535
  title?: string
61488
61536
  /**
61489
- * Select/deselect all if `CMD`/`CTRL` is pressed when clicking
61537
+ * Select/deselect all if <kbd>Cmd</kbd>/<kbd>Ctrl</kbd> is pressed when clicking
61490
61538
  */
61491
61539
  toggleAllIfCtrlPressed?: boolean
61492
61540
  /**
@@ -61755,7 +61803,7 @@ export class List extends Widget {
61755
61803
  */
61756
61804
  title: string
61757
61805
  /**
61758
- * Select/deselect all if `CMD`/`CTRL` is pressed when clicking
61806
+ * Select/deselect all if <kbd>Cmd</kbd>/<kbd>Ctrl</kbd> is pressed when clicking
61759
61807
  */
61760
61808
  toggleAllIfCtrlPressed: boolean
61761
61809
  /**
@@ -63262,7 +63310,7 @@ type MenuConfig = {
63262
63310
  */
63263
63311
  closeAction?: 'hide'|'destroy'
63264
63312
  /**
63265
- * Close popup when `ESC` key is pressed.
63313
+ * Close popup when <kbd>Escape</kbd> key is pressed.
63266
63314
  */
63267
63315
  closeOnEscape?: boolean
63268
63316
  /**
@@ -64536,7 +64584,7 @@ type MenuItemConfig = {
64536
64584
  * If configured with a `Boolean` value, a checkbox is displayed
64537
64585
  * as the start icon, and the [toggle](https://bryntum.com/products/grid/docs/api/Core/widget/MenuItem#event-toggle) event is fired
64538
64586
  * when the checked state changes.
64539
- * `String` value allows to link value by reference name.
64587
+ * `String` value allows linking value by reference name.
64540
64588
  * ...
64541
64589
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/MenuItem#config-checked)
64542
64590
  */
@@ -69184,7 +69232,7 @@ type NumberFieldConfig = {
69184
69232
  required?: boolean
69185
69233
  /**
69186
69234
  * 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
69235
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
69188
69236
  * 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
69237
  * behaviour will be activated.
69190
69238
  */
@@ -72804,7 +72852,7 @@ type PasswordFieldConfig = {
72804
72852
  required?: boolean
72805
72853
  /**
72806
72854
  * 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
72855
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
72808
72856
  * 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
72857
  * behaviour will be activated.
72810
72858
  */
@@ -73977,7 +74025,7 @@ type PickerFieldConfig = {
73977
74025
  required?: boolean
73978
74026
  /**
73979
74027
  * 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
74028
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
73981
74029
  * 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
74030
  * behaviour will be activated.
73983
74031
  */
@@ -74801,7 +74849,7 @@ type PopupConfig = {
74801
74849
  */
74802
74850
  closeAction?: 'hide'|'destroy'
74803
74851
  /**
74804
- * Close popup when `ESC` key is pressed.
74852
+ * Close popup when <kbd>Escape</kbd> key is pressed.
74805
74853
  */
74806
74854
  closeOnEscape?: boolean
74807
74855
  /**
@@ -77423,7 +77471,7 @@ type RadioConfig = {
77423
77471
  required?: boolean
77424
77472
  /**
77425
77473
  * 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
77474
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
77427
77475
  * 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
77476
  * behaviour will be activated.
77429
77477
  */
@@ -79877,7 +79925,7 @@ type RichTextFieldConfig = {
79877
79925
  required?: boolean
79878
79926
  /**
79879
79927
  * 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
79928
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
79881
79929
  * 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
79930
  * behaviour will be activated.
79883
79931
  */
@@ -81062,7 +81110,7 @@ type SlideToggleConfig = {
81062
81110
  required?: boolean
81063
81111
  /**
81064
81112
  * 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
81113
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
81066
81114
  * 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
81115
  * behaviour will be activated.
81068
81116
  */
@@ -82185,7 +82233,7 @@ type SliderConfig = {
82185
82233
  unit?: string
82186
82234
  /**
82187
82235
  * Initial value.
82188
- * `String` value allows to link value by reference name.
82236
+ * `String` value allows linking value by reference name.
82189
82237
  * ...
82190
82238
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Slider#config-value)
82191
82239
  */
@@ -82400,7 +82448,7 @@ export class Slider extends Widget {
82400
82448
  unit: string
82401
82449
  /**
82402
82450
  * Initial value.
82403
- * `String` value allows to link value by reference name.
82451
+ * `String` value allows linking value by reference name.
82404
82452
  */
82405
82453
  value: number|string
82406
82454
  /**
@@ -87748,7 +87796,7 @@ type TextAreaFieldConfig = {
87748
87796
  resize?: 'none'|'both'|'horizontal'|'vertical'
87749
87797
  /**
87750
87798
  * 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
87799
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
87752
87800
  * 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
87801
  * behaviour will be activated.
87754
87802
  */
@@ -88931,7 +88979,7 @@ type TextAreaPickerFieldConfig = {
88931
88979
  resize?: 'none'|'both'|'horizontal'|'vertical'
88932
88980
  /**
88933
88981
  * 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
88982
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
88935
88983
  * 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
88984
  * behaviour will be activated.
88937
88985
  */
@@ -90100,7 +90148,7 @@ type TextFieldConfig = {
90100
90148
  required?: boolean
90101
90149
  /**
90102
90150
  * 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
90151
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
90104
90152
  * 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
90153
  * behaviour will be activated.
90106
90154
  */
@@ -91323,7 +91371,7 @@ type TimeFieldConfig = {
91323
91371
  required?: boolean
91324
91372
  /**
91325
91373
  * 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
91374
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
91327
91375
  * 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
91376
  * behaviour will be activated.
91329
91377
  */
@@ -96208,7 +96256,7 @@ type TooltipConfig = {
96208
96256
  */
96209
96257
  closeAction?: 'hide'|'destroy'
96210
96258
  /**
96211
- * Close popup when `ESC` key is pressed.
96259
+ * Close popup when <kbd>Escape</kbd> key is pressed.
96212
96260
  */
96213
96261
  closeOnEscape?: boolean
96214
96262
  /**
@@ -103884,7 +103932,7 @@ type ConfirmationDialogConfig = {
103884
103932
  */
103885
103933
  closable?: boolean
103886
103934
  /**
103887
- * Close popup when `ESC` key is pressed.
103935
+ * Close popup when <kbd>Escape</kbd> key is pressed.
103888
103936
  */
103889
103937
  closeOnEscape?: boolean
103890
103938
  /**
@@ -107624,8 +107672,9 @@ type ActionColumnConfig = {
107624
107672
  * @param {object} renderData
107625
107673
  * @param {Grid.column.Column} renderData.column This column
107626
107674
  * @param {HTMLElement} renderData.headerElement The header element
107675
+ * @returns {string,object,void,void} The text or markup to show in the column header
107627
107676
  */
107628
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
107677
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
107629
107678
  /**
107630
107679
  * An array of the widgets to append to the column header. These widgets have this Column instance
107631
107680
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -107666,7 +107715,7 @@ type ActionColumnConfig = {
107666
107715
  id?: string|number
107667
107716
  /**
107668
107717
  * 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`
107718
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
107670
107719
  */
107671
107720
  instantUpdate?: boolean
107672
107721
  /**
@@ -107834,7 +107883,7 @@ type ActionColumnConfig = {
107834
107883
  */
107835
107884
  responsiveLevels?: object
107836
107885
  /**
107837
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
107886
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
107838
107887
  * revert the field to the value it had when the edit began. If the value is *not* changed
107839
107888
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
107840
107889
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -108343,8 +108392,9 @@ type AggregateColumnConfig = {
108343
108392
  * @param {object} renderData
108344
108393
  * @param {Grid.column.Column} renderData.column This column
108345
108394
  * @param {HTMLElement} renderData.headerElement The header element
108395
+ * @returns {string,object,void,void} The text or markup to show in the column header
108346
108396
  */
108347
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
108397
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
108348
108398
  /**
108349
108399
  * An array of the widgets to append to the column header. These widgets have this Column instance
108350
108400
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -108398,7 +108448,7 @@ type AggregateColumnConfig = {
108398
108448
  includeParentInChangeSet?: boolean
108399
108449
  /**
108400
108450
  * 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`
108451
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
108402
108452
  */
108403
108453
  instantUpdate?: boolean
108404
108454
  /**
@@ -108583,7 +108633,7 @@ type AggregateColumnConfig = {
108583
108633
  */
108584
108634
  responsiveLevels?: object
108585
108635
  /**
108586
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
108636
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
108587
108637
  * revert the field to the value it had when the edit began. If the value is *not* changed
108588
108638
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
108589
108639
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -109113,8 +109163,9 @@ type ChartColumnConfig = {
109113
109163
  * @param {object} renderData
109114
109164
  * @param {Grid.column.Column} renderData.column This column
109115
109165
  * @param {HTMLElement} renderData.headerElement The header element
109166
+ * @returns {string,object,void,void} The text or markup to show in the column header
109116
109167
  */
109117
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
109168
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
109118
109169
  /**
109119
109170
  * An array of the widgets to append to the column header. These widgets have this Column instance
109120
109171
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -109160,7 +109211,7 @@ type ChartColumnConfig = {
109160
109211
  id?: string|number
109161
109212
  /**
109162
109213
  * 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`
109214
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
109164
109215
  */
109165
109216
  instantUpdate?: boolean
109166
109217
  /**
@@ -109336,7 +109387,7 @@ type ChartColumnConfig = {
109336
109387
  */
109337
109388
  responsiveLevels?: object
109338
109389
  /**
109339
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
109390
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
109340
109391
  * revert the field to the value it had when the edit began. If the value is *not* changed
109341
109392
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
109342
109393
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -109888,8 +109939,9 @@ type CheckColumnConfig = {
109888
109939
  * @param {object} renderData
109889
109940
  * @param {Grid.column.Column} renderData.column This column
109890
109941
  * @param {HTMLElement} renderData.headerElement The header element
109942
+ * @returns {string,object,void,void} The text or markup to show in the column header
109891
109943
  */
109892
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
109944
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
109893
109945
  /**
109894
109946
  * An array of the widgets to append to the column header. These widgets have this Column instance
109895
109947
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -109935,7 +109987,7 @@ type CheckColumnConfig = {
109935
109987
  id?: string|number
109936
109988
  /**
109937
109989
  * 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`
109990
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
109939
109991
  */
109940
109992
  instantUpdate?: boolean
109941
109993
  /**
@@ -110111,7 +110163,7 @@ type CheckColumnConfig = {
110111
110163
  */
110112
110164
  responsiveLevels?: object
110113
110165
  /**
110114
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
110166
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
110115
110167
  * revert the field to the value it had when the edit began. If the value is *not* changed
110116
110168
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
110117
110169
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -110678,8 +110730,9 @@ type ColorColumnConfig = {
110678
110730
  * @param {object} renderData
110679
110731
  * @param {Grid.column.Column} renderData.column This column
110680
110732
  * @param {HTMLElement} renderData.headerElement The header element
110733
+ * @returns {string,object,void,void} The text or markup to show in the column header
110681
110734
  */
110682
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
110735
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
110683
110736
  /**
110684
110737
  * An array of the widgets to append to the column header. These widgets have this Column instance
110685
110738
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -110725,7 +110778,7 @@ type ColorColumnConfig = {
110725
110778
  id?: string|number
110726
110779
  /**
110727
110780
  * 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`
110781
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
110729
110782
  */
110730
110783
  instantUpdate?: boolean
110731
110784
  /**
@@ -110897,7 +110950,7 @@ type ColorColumnConfig = {
110897
110950
  */
110898
110951
  responsiveLevels?: object
110899
110952
  /**
110900
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
110953
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
110901
110954
  * revert the field to the value it had when the edit began. If the value is *not* changed
110902
110955
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
110903
110956
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -111413,8 +111466,9 @@ type ColumnConfig = {
111413
111466
  * @param {object} renderData
111414
111467
  * @param {Grid.column.Column} renderData.column This column
111415
111468
  * @param {HTMLElement} renderData.headerElement The header element
111469
+ * @returns {string,object,void,void} The text or markup to show in the column header
111416
111470
  */
111417
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
111471
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
111418
111472
  /**
111419
111473
  * An array of the widgets to append to the column header. These widgets have this Column instance
111420
111474
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -111460,7 +111514,7 @@ type ColumnConfig = {
111460
111514
  id?: string|number
111461
111515
  /**
111462
111516
  * 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`
111517
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
111464
111518
  */
111465
111519
  instantUpdate?: boolean
111466
111520
  /**
@@ -111632,7 +111686,7 @@ type ColumnConfig = {
111632
111686
  */
111633
111687
  responsiveLevels?: object
111634
111688
  /**
111635
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
111689
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
111636
111690
  * revert the field to the value it had when the edit began. If the value is *not* changed
111637
111691
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
111638
111692
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -111962,7 +112016,7 @@ export class Column extends Model {
111962
112016
  /**
111963
112017
  * Renderer function for the column header.
111964
112018
  */
111965
- headerRenderer: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
112019
+ headerRenderer: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
111966
112020
  /**
111967
112021
  * An array of the widgets to append to the column header. These widgets have this Column instance
111968
112022
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -111997,7 +112051,7 @@ export class Column extends Model {
111997
112051
  icon: string
111998
112052
  /**
111999
112053
  * 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`
112054
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
112001
112055
  */
112002
112056
  instantUpdate: boolean
112003
112057
  /**
@@ -112093,7 +112147,7 @@ export class Column extends Model {
112093
112147
  */
112094
112148
  responsiveLevels: object
112095
112149
  /**
112096
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
112150
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
112097
112151
  * revert the field to the value it had when the edit began. If the value is *not* changed
112098
112152
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
112099
112153
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -112710,8 +112764,9 @@ type CurrencyColumnConfig = {
112710
112764
  * @param {object} renderData
112711
112765
  * @param {Grid.column.Column} renderData.column This column
112712
112766
  * @param {HTMLElement} renderData.headerElement The header element
112767
+ * @returns {string,object,void,void} The text or markup to show in the column header
112713
112768
  */
112714
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
112769
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
112715
112770
  /**
112716
112771
  * An array of the widgets to append to the column header. These widgets have this Column instance
112717
112772
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -112762,7 +112817,7 @@ type CurrencyColumnConfig = {
112762
112817
  id?: string|number
112763
112818
  /**
112764
112819
  * 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`
112820
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
112766
112821
  */
112767
112822
  instantUpdate?: boolean
112768
112823
  /**
@@ -112947,7 +113002,7 @@ type CurrencyColumnConfig = {
112947
113002
  */
112948
113003
  responsiveLevels?: object
112949
113004
  /**
112950
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
113005
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
112951
113006
  * revert the field to the value it had when the edit began. If the value is *not* changed
112952
113007
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
112953
113008
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -113462,8 +113517,9 @@ type DateColumnConfig = {
113462
113517
  * @param {object} renderData
113463
113518
  * @param {Grid.column.Column} renderData.column This column
113464
113519
  * @param {HTMLElement} renderData.headerElement The header element
113520
+ * @returns {string,object,void,void} The text or markup to show in the column header
113465
113521
  */
113466
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
113522
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
113467
113523
  /**
113468
113524
  * An array of the widgets to append to the column header. These widgets have this Column instance
113469
113525
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -113509,7 +113565,7 @@ type DateColumnConfig = {
113509
113565
  id?: string|number
113510
113566
  /**
113511
113567
  * 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`
113568
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
113513
113569
  */
113514
113570
  instantUpdate?: boolean
113515
113571
  /**
@@ -113689,7 +113745,7 @@ type DateColumnConfig = {
113689
113745
  */
113690
113746
  responsiveLevels?: object
113691
113747
  /**
113692
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
113748
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
113693
113749
  * revert the field to the value it had when the edit began. If the value is *not* changed
113694
113750
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
113695
113751
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -114225,8 +114281,9 @@ type NumberColumnConfig = {
114225
114281
  * @param {object} renderData
114226
114282
  * @param {Grid.column.Column} renderData.column This column
114227
114283
  * @param {HTMLElement} renderData.headerElement The header element
114284
+ * @returns {string,object,void,void} The text or markup to show in the column header
114228
114285
  */
114229
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
114286
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
114230
114287
  /**
114231
114288
  * An array of the widgets to append to the column header. These widgets have this Column instance
114232
114289
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -114272,7 +114329,7 @@ type NumberColumnConfig = {
114272
114329
  id?: string|number
114273
114330
  /**
114274
114331
  * 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`
114332
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
114276
114333
  */
114277
114334
  instantUpdate?: boolean
114278
114335
  /**
@@ -114457,7 +114514,7 @@ type NumberColumnConfig = {
114457
114514
  */
114458
114515
  responsiveLevels?: object
114459
114516
  /**
114460
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
114517
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
114461
114518
  * revert the field to the value it had when the edit began. If the value is *not* changed
114462
114519
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
114463
114520
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -115004,8 +115061,9 @@ type PercentColumnConfig = {
115004
115061
  * @param {object} renderData
115005
115062
  * @param {Grid.column.Column} renderData.column This column
115006
115063
  * @param {HTMLElement} renderData.headerElement The header element
115064
+ * @returns {string,object,void,void} The text or markup to show in the column header
115007
115065
  */
115008
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
115066
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
115009
115067
  /**
115010
115068
  * An array of the widgets to append to the column header. These widgets have this Column instance
115011
115069
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -115046,7 +115104,7 @@ type PercentColumnConfig = {
115046
115104
  id?: string|number
115047
115105
  /**
115048
115106
  * 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`
115107
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
115050
115108
  */
115051
115109
  instantUpdate?: boolean
115052
115110
  /**
@@ -115241,7 +115299,7 @@ type PercentColumnConfig = {
115241
115299
  */
115242
115300
  responsiveLevels?: object
115243
115301
  /**
115244
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
115302
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
115245
115303
  * revert the field to the value it had when the edit began. If the value is *not* changed
115246
115304
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
115247
115305
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -115782,8 +115840,9 @@ type RatingColumnConfig = {
115782
115840
  * @param {object} renderData
115783
115841
  * @param {Grid.column.Column} renderData.column This column
115784
115842
  * @param {HTMLElement} renderData.headerElement The header element
115843
+ * @returns {string,object,void,void} The text or markup to show in the column header
115785
115844
  */
115786
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
115845
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
115787
115846
  /**
115788
115847
  * An array of the widgets to append to the column header. These widgets have this Column instance
115789
115848
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -115829,7 +115888,7 @@ type RatingColumnConfig = {
115829
115888
  id?: string|number
115830
115889
  /**
115831
115890
  * 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`
115891
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
115833
115892
  */
115834
115893
  instantUpdate?: boolean
115835
115894
  /**
@@ -116014,7 +116073,7 @@ type RatingColumnConfig = {
116014
116073
  */
116015
116074
  responsiveLevels?: object
116016
116075
  /**
116017
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
116076
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
116018
116077
  * revert the field to the value it had when the edit began. If the value is *not* changed
116019
116078
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
116020
116079
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -116462,8 +116521,9 @@ type RowNumberColumnConfig = {
116462
116521
  * @param {object} renderData
116463
116522
  * @param {Grid.column.Column} renderData.column This column
116464
116523
  * @param {HTMLElement} renderData.headerElement The header element
116524
+ * @returns {string,object,void,void} The text or markup to show in the column header
116465
116525
  */
116466
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
116526
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
116467
116527
  /**
116468
116528
  * An array of the widgets to append to the column header. These widgets have this Column instance
116469
116529
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -117130,8 +117190,9 @@ type SparklineColumnConfig = {
117130
117190
  * @param {object} renderData
117131
117191
  * @param {Grid.column.Column} renderData.column This column
117132
117192
  * @param {HTMLElement} renderData.headerElement The header element
117193
+ * @returns {string,object,void,void} The text or markup to show in the column header
117133
117194
  */
117134
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
117195
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
117135
117196
  /**
117136
117197
  * An array of the widgets to append to the column header. These widgets have this Column instance
117137
117198
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -117187,7 +117248,7 @@ type SparklineColumnConfig = {
117187
117248
  id?: string|number
117188
117249
  /**
117189
117250
  * 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`
117251
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
117191
117252
  */
117192
117253
  instantUpdate?: boolean
117193
117254
  /**
@@ -117363,7 +117424,7 @@ type SparklineColumnConfig = {
117363
117424
  */
117364
117425
  responsiveLevels?: object
117365
117426
  /**
117366
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
117427
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
117367
117428
  * revert the field to the value it had when the edit began. If the value is *not* changed
117368
117429
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
117369
117430
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -117854,8 +117915,9 @@ type TemplateColumnConfig = {
117854
117915
  * @param {object} renderData
117855
117916
  * @param {Grid.column.Column} renderData.column This column
117856
117917
  * @param {HTMLElement} renderData.headerElement The header element
117918
+ * @returns {string,object,void,void} The text or markup to show in the column header
117857
117919
  */
117858
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
117920
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
117859
117921
  /**
117860
117922
  * An array of the widgets to append to the column header. These widgets have this Column instance
117861
117923
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -117901,7 +117963,7 @@ type TemplateColumnConfig = {
117901
117963
  id?: string|number
117902
117964
  /**
117903
117965
  * 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`
117966
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
117905
117967
  */
117906
117968
  instantUpdate?: boolean
117907
117969
  /**
@@ -118073,7 +118135,7 @@ type TemplateColumnConfig = {
118073
118135
  */
118074
118136
  responsiveLevels?: object
118075
118137
  /**
118076
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
118138
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
118077
118139
  * revert the field to the value it had when the edit began. If the value is *not* changed
118078
118140
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
118079
118141
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -118583,8 +118645,9 @@ type TimeColumnConfig = {
118583
118645
  * @param {object} renderData
118584
118646
  * @param {Grid.column.Column} renderData.column This column
118585
118647
  * @param {HTMLElement} renderData.headerElement The header element
118648
+ * @returns {string,object,void,void} The text or markup to show in the column header
118586
118649
  */
118587
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
118650
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
118588
118651
  /**
118589
118652
  * An array of the widgets to append to the column header. These widgets have this Column instance
118590
118653
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -118630,7 +118693,7 @@ type TimeColumnConfig = {
118630
118693
  id?: string|number
118631
118694
  /**
118632
118695
  * 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`
118696
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
118634
118697
  */
118635
118698
  instantUpdate?: boolean
118636
118699
  /**
@@ -118802,7 +118865,7 @@ type TimeColumnConfig = {
118802
118865
  */
118803
118866
  responsiveLevels?: object
118804
118867
  /**
118805
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
118868
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
118806
118869
  * revert the field to the value it had when the edit began. If the value is *not* changed
118807
118870
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
118808
118871
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -119315,8 +119378,9 @@ type TreeColumnConfig = {
119315
119378
  * @param {object} renderData
119316
119379
  * @param {Grid.column.Column} renderData.column This column
119317
119380
  * @param {HTMLElement} renderData.headerElement The header element
119381
+ * @returns {string,object,void,void} The text or markup to show in the column header
119318
119382
  */
119319
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
119383
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
119320
119384
  /**
119321
119385
  * An array of the widgets to append to the column header. These widgets have this Column instance
119322
119386
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -119368,7 +119432,7 @@ type TreeColumnConfig = {
119368
119432
  indentSize?: number
119369
119433
  /**
119370
119434
  * 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`
119435
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
119372
119436
  */
119373
119437
  instantUpdate?: boolean
119374
119438
  /**
@@ -119544,7 +119608,7 @@ type TreeColumnConfig = {
119544
119608
  */
119545
119609
  responsiveLevels?: object
119546
119610
  /**
119547
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
119611
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
119548
119612
  * revert the field to the value it had when the edit began. If the value is *not* changed
119549
119613
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
119550
119614
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -120074,8 +120138,9 @@ type WidgetColumnConfig = {
120074
120138
  * @param {object} renderData
120075
120139
  * @param {Grid.column.Column} renderData.column This column
120076
120140
  * @param {HTMLElement} renderData.headerElement The header element
120141
+ * @returns {string,object,void,void} The text or markup to show in the column header
120077
120142
  */
120078
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
120143
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
120079
120144
  /**
120080
120145
  * An array of the widgets to append to the column header. These widgets have this Column instance
120081
120146
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -120121,7 +120186,7 @@ type WidgetColumnConfig = {
120121
120186
  id?: string|number
120122
120187
  /**
120123
120188
  * 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`
120189
+ * field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
120125
120190
  */
120126
120191
  instantUpdate?: boolean
120127
120192
  /**
@@ -120297,7 +120362,7 @@ type WidgetColumnConfig = {
120297
120362
  */
120298
120363
  responsiveLevels?: object
120299
120364
  /**
120300
- * Setting this option means that pressing the `ESCAPE` key after editing the field will
120365
+ * Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
120301
120366
  * revert the field to the value it had when the edit began. If the value is *not* changed
120302
120367
  * from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
120303
120368
  * behaviour will be activated. Finally, the edit will be canceled.
@@ -121919,16 +121984,11 @@ export class ColumnStore extends Store {
121919
121984
  */
121920
121985
  static registerColumnType(columnClass: Function, simpleRenderer?: boolean): void;
121921
121986
  /**
121922
- * Get column by field. To be sure that you are getting exactly the intended column, use [Store#getById()](https://bryntum.com/products/grid/docs/api/Core/data/Store#function-getById) with the
121923
- * columns id instead.
121987
+ * Get column by field. To be sure that you are getting exactly the intended column, use
121988
+ * [getById](https://bryntum.com/products/grid/docs/api/Core/data/Store#function-getById) with the columns id instead.
121924
121989
  * @param {string} field Field name
121925
121990
  */
121926
121991
  get(field: string): Column;
121927
- /**
121928
- * Get column by id.
121929
- * @param {string,number} id
121930
- */
121931
- getById(id: string|number): Column;
121932
121992
  /**
121933
121993
  * indexOf extended to also accept a columns field, for backward compatibility.
121934
121994
  * @param {Core.data.Model,string} recordOrId
@@ -123022,7 +123082,7 @@ export class CellEdit extends GridEditBase {
123022
123082
  /**
123023
123083
  * Displays an OK / Cancel confirmation dialog box owned by the current Editor. This is intended to be
123024
123084
  * 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.
123085
+ * `true` if the "OK" button is pressed, and `false` if the "Cancel" button is pressed. Typing <kbd>Escape</kbd> rejects.
123026
123086
  * @param {object} options An options object for what to show.
123027
123087
  */
123028
123088
  confirm(options: {
@@ -123286,7 +123346,7 @@ type CellMenuConfig = {
123286
123346
 
123287
123347
  /**
123288
123348
  * 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.
123349
+ * <kbd>Space</kbd> key when the cell is focused.
123290
123350
  * ...
123291
123351
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellMenu)
123292
123352
  */
@@ -123559,7 +123619,7 @@ type CellTooltipConfig = {
123559
123619
  */
123560
123620
  closeAction?: 'hide'|'destroy'
123561
123621
  /**
123562
- * Close popup when `ESC` key is pressed.
123622
+ * Close popup when <kbd>Escape</kbd> key is pressed.
123563
123623
  */
123564
123624
  closeOnEscape?: boolean
123565
123625
  /**
@@ -127171,8 +127231,8 @@ type GroupConfig = {
127171
127231
 
127172
127232
  /**
127173
127233
  * 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
127234
+ * <kbd>Shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
127235
+ * one anywhere on grid). Use <kbd>Shift</kbd> + <kbd>Alt</kbd> + click, or the context menu, to remove a column
127176
127236
  * grouper.
127177
127237
  * ...
127178
127238
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Group)
@@ -132454,10 +132514,10 @@ type TreeGroupConfig = {
132454
132514
  */
132455
132515
  parentCls?: string
132456
132516
  /**
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.
132517
+ * A function letting you format the text shown in the generated parent group levels. This method will be
132518
+ * provided with the value produced by the column representing the grouped level. Each column's renderer method
132519
+ * will be provided an extra `isTreeGroup` param to indicate that the value will be used for a generated parent.
132520
+ * `cellElement` and other DOM specific args will be in the context of the tree column.
132461
132521
  * ...
132462
132522
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/TreeGroup#config-parentRenderer)
132463
132523
  * @param {object} data The rendering data representing the generated tree parent record
@@ -133611,7 +133671,7 @@ type ExcelExporterConfig = {
133611
133671
  */
133612
133672
  localizableProperties?: string[]
133613
133673
  /**
133614
- * This hook allows to use 3rd party libraries to generate XLSX files.
133674
+ * This hook allows using 3rd party libraries to generate XLSX files.
133615
133675
  * ...
133616
133676
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/ExcelExporter#config-xlsProvider)
133617
133677
  */
@@ -136106,7 +136166,7 @@ type SinglePageUnscaledExporterConfig = {
136106
136166
 
136107
136167
  /**
136108
136168
  * 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
136169
+ * is exported with dimensions required to fit all requested rows and columns. This allows generating a PDF page not
136110
136170
  * constrained by the standard paper formats.
136111
136171
  * ...
136112
136172
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/export/exporter/SinglePageUnscaledExporter)
@@ -136516,7 +136576,7 @@ type GridListenersTypes = {
136516
136576
  */
136517
136577
  beforeCellEditStart: (event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void
136518
136578
  /**
136519
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
136579
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
136520
136580
  * 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
136581
  * @param {object} event Event object
136522
136582
  * @param {Grid.view.Grid} event.source Owner grid
@@ -137481,6 +137541,14 @@ type GridListenersTypes = {
137481
137541
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
137482
137542
  */
137483
137543
  toolClick: (event: { source: Tool, tool: Tool }) => void
137544
+ /**
137545
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
137546
+ * @param {object} event Event object
137547
+ * @param {Grid.view.Grid} event.source The grid instance
137548
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
137549
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
137550
+ */
137551
+ treeGroup: (event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void
137484
137552
  /**
137485
137553
  * Fires when row locking is disabled.
137486
137554
  * @param {object} event Event object
@@ -137535,7 +137603,7 @@ type GridListeners = {
137535
137603
  */
137536
137604
  beforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
137537
137605
  /**
137538
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
137606
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
137539
137607
  * 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
137608
  * @param {object} event Event object
137541
137609
  * @param {Grid.view.Grid} event.source Owner grid
@@ -138500,6 +138568,14 @@ type GridListeners = {
138500
138568
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
138501
138569
  */
138502
138570
  toolClick?: ((event: { source: Tool, tool: Tool }) => void)|string
138571
+ /**
138572
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
138573
+ * @param {object} event Event object
138574
+ * @param {Grid.view.Grid} event.source The grid instance
138575
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
138576
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
138577
+ */
138578
+ treeGroup?: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string
138503
138579
  /**
138504
138580
  * Fires when row locking is disabled.
138505
138581
  * @param {object} event Event object
@@ -139164,7 +139240,7 @@ type GridConfig = {
139164
139240
  rootElement?: ShadowRoot|HTMLElement
139165
139241
  /**
139166
139242
  * 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
139243
+ * 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
139244
  * a column [renderer](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-renderer).
139169
139245
  * ...
139170
139246
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#config-rowHeight)
@@ -139395,7 +139471,7 @@ type GridConfig = {
139395
139471
  */
139396
139472
  onBeforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
139397
139473
  /**
139398
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
139474
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
139399
139475
  * 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
139476
  * @param {object} event Event object
139401
139477
  * @param {Grid.view.Grid} event.source Owner grid
@@ -140360,6 +140436,14 @@ type GridConfig = {
140360
140436
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
140361
140437
  */
140362
140438
  onToolClick?: ((event: { source: Tool, tool: Tool }) => void)|string
140439
+ /**
140440
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
140441
+ * @param {object} event Event object
140442
+ * @param {Grid.view.Grid} event.source The grid instance
140443
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
140444
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
140445
+ */
140446
+ onTreeGroup?: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string
140363
140447
  /**
140364
140448
  * Fires when row locking is disabled.
140365
140449
  * @param {object} event Event object
@@ -140633,7 +140717,7 @@ type GridBaseListenersTypes = {
140633
140717
  */
140634
140718
  beforeCellEditStart: (event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void
140635
140719
  /**
140636
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
140720
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
140637
140721
  * 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
140722
  * @param {object} event Event object
140639
140723
  * @param {Grid.view.Grid} event.source Owner grid
@@ -141598,6 +141682,14 @@ type GridBaseListenersTypes = {
141598
141682
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
141599
141683
  */
141600
141684
  toolClick: (event: { source: Tool, tool: Tool }) => void
141685
+ /**
141686
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
141687
+ * @param {object} event Event object
141688
+ * @param {Grid.view.Grid} event.source The grid instance
141689
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
141690
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
141691
+ */
141692
+ treeGroup: (event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void
141601
141693
  /**
141602
141694
  * Fires when row locking is disabled.
141603
141695
  * @param {object} event Event object
@@ -141652,7 +141744,7 @@ type GridBaseListeners = {
141652
141744
  */
141653
141745
  beforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
141654
141746
  /**
141655
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
141747
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
141656
141748
  * 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
141749
  * @param {object} event Event object
141658
141750
  * @param {Grid.view.Grid} event.source Owner grid
@@ -142617,6 +142709,14 @@ type GridBaseListeners = {
142617
142709
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
142618
142710
  */
142619
142711
  toolClick?: ((event: { source: Tool, tool: Tool }) => void)|string
142712
+ /**
142713
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
142714
+ * @param {object} event Event object
142715
+ * @param {Grid.view.Grid} event.source The grid instance
142716
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
142717
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
142718
+ */
142719
+ treeGroup?: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string
142620
142720
  /**
142621
142721
  * Fires when row locking is disabled.
142622
142722
  * @param {object} event Event object
@@ -143280,7 +143380,7 @@ type GridBaseConfig = {
143280
143380
  rootElement?: ShadowRoot|HTMLElement
143281
143381
  /**
143282
143382
  * 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
143383
+ * 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
143384
  * a column [renderer](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-renderer).
143285
143385
  * ...
143286
143386
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-rowHeight)
@@ -143511,7 +143611,7 @@ type GridBaseConfig = {
143511
143611
  */
143512
143612
  onBeforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
143513
143613
  /**
143514
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
143614
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
143515
143615
  * 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
143616
  * @param {object} event Event object
143517
143617
  * @param {Grid.view.Grid} event.source Owner grid
@@ -144476,6 +144576,14 @@ type GridBaseConfig = {
144476
144576
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
144477
144577
  */
144478
144578
  onToolClick?: ((event: { source: Tool, tool: Tool }) => void)|string
144579
+ /**
144580
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
144581
+ * @param {object} event Event object
144582
+ * @param {Grid.view.Grid} event.source The grid instance
144583
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
144584
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
144585
+ */
144586
+ onTreeGroup?: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string
144479
144587
  /**
144480
144588
  * Fires when row locking is disabled.
144481
144589
  * @param {object} event Event object
@@ -144739,7 +144847,7 @@ export class GridBase extends Panel {
144739
144847
  readonly responsiveLevel: string
144740
144848
  /**
144741
144849
  * 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
144850
+ * 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
144851
  * a column [renderer](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-renderer).
144744
144852
  */
144745
144853
  rowHeight: number
@@ -144859,7 +144967,7 @@ export class GridBase extends Panel {
144859
144967
  */
144860
144968
  onBeforeCellEditStart: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
144861
144969
  /**
144862
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
144970
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
144863
144971
  * 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
144972
  * @param {object} event Event object
144865
144973
  * @param {Grid.view.Grid} event.source Owner grid
@@ -145688,6 +145796,14 @@ export class GridBase extends Panel {
145688
145796
  * @param {boolean} event.collapse `true` if the node is being collapsed.
145689
145797
  */
145690
145798
  onToggleNode: ((event: { record: Model, collapse: boolean }) => void)|string
145799
+ /**
145800
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
145801
+ * @param {object} event Event object
145802
+ * @param {Grid.view.Grid} event.source The grid instance
145803
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
145804
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
145805
+ */
145806
+ onTreeGroup: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string
145691
145807
  /**
145692
145808
  * Fires when row locking is disabled.
145693
145809
  * @param {object} event Event object
@@ -147178,7 +147294,7 @@ type TreeGridListenersTypes = {
147178
147294
  */
147179
147295
  beforeCellEditStart: (event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void
147180
147296
  /**
147181
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
147297
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
147182
147298
  * 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
147299
  * @param {object} event Event object
147184
147300
  * @param {Grid.view.Grid} event.source Owner grid
@@ -148143,6 +148259,14 @@ type TreeGridListenersTypes = {
148143
148259
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
148144
148260
  */
148145
148261
  toolClick: (event: { source: Tool, tool: Tool }) => void
148262
+ /**
148263
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
148264
+ * @param {object} event Event object
148265
+ * @param {Grid.view.Grid} event.source The grid instance
148266
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
148267
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
148268
+ */
148269
+ treeGroup: (event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void
148146
148270
  /**
148147
148271
  * Fires when row locking is disabled.
148148
148272
  * @param {object} event Event object
@@ -148197,7 +148321,7 @@ type TreeGridListeners = {
148197
148321
  */
148198
148322
  beforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
148199
148323
  /**
148200
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
148324
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
148201
148325
  * 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
148326
  * @param {object} event Event object
148203
148327
  * @param {Grid.view.Grid} event.source Owner grid
@@ -149162,6 +149286,14 @@ type TreeGridListeners = {
149162
149286
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
149163
149287
  */
149164
149288
  toolClick?: ((event: { source: Tool, tool: Tool }) => void)|string
149289
+ /**
149290
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
149291
+ * @param {object} event Event object
149292
+ * @param {Grid.view.Grid} event.source The grid instance
149293
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
149294
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
149295
+ */
149296
+ treeGroup?: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string
149165
149297
  /**
149166
149298
  * Fires when row locking is disabled.
149167
149299
  * @param {object} event Event object
@@ -149826,7 +149958,7 @@ type TreeGridConfig = {
149826
149958
  rootElement?: ShadowRoot|HTMLElement
149827
149959
  /**
149828
149960
  * 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
149961
+ * 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
149962
  * a column [renderer](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-renderer).
149831
149963
  * ...
149832
149964
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-rowHeight)
@@ -150057,7 +150189,7 @@ type TreeGridConfig = {
150057
150189
  */
150058
150190
  onBeforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
150059
150191
  /**
150060
- * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
150192
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
150061
150193
  * 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
150194
  * @param {object} event Event object
150063
150195
  * @param {Grid.view.Grid} event.source Owner grid
@@ -151022,6 +151154,14 @@ type TreeGridConfig = {
151022
151154
  * @param {Core.widget.Tool} event.tool The tool which is being clicked.
151023
151155
  */
151024
151156
  onToolClick?: ((event: { source: Tool, tool: Tool }) => void)|string
151157
+ /**
151158
+ * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
151159
+ * @param {object} event Event object
151160
+ * @param {Grid.view.Grid} event.source The grid instance
151161
+ * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
151162
+ * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
151163
+ */
151164
+ onTreeGroup?: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string
151025
151165
  /**
151026
151166
  * Fires when row locking is disabled.
151027
151167
  * @param {object} event Event object
@@ -151767,7 +151907,7 @@ type ExportDialogConfig = {
151767
151907
  */
151768
151908
  closeAction?: 'hide'|'destroy'
151769
151909
  /**
151770
- * Close popup when `ESC` key is pressed.
151910
+ * Close popup when <kbd>Escape</kbd> key is pressed.
151771
151911
  */
151772
151912
  closeOnEscape?: boolean
151773
151913
  /**
@@ -154218,7 +154358,7 @@ type AIFilterFieldConfig = {
154218
154358
  required?: boolean
154219
154359
  /**
154220
154360
  * 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
154361
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
154222
154362
  * 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
154363
  * behaviour will be activated.
154224
154364
  */
@@ -155077,7 +155217,7 @@ type ChecklistFilterComboConfig = {
155077
155217
  contentElementCls?: string|object
155078
155218
  /**
155079
155219
  * 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,
155220
+ * 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
155221
  * 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
155222
  * ...
155083
155223
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-createOnUnmatched)
@@ -155577,7 +155717,7 @@ type ChecklistFilterComboConfig = {
155577
155717
  required?: boolean
155578
155718
  /**
155579
155719
  * 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
155720
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
155581
155721
  * 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
155722
  * behaviour will be activated.
155583
155723
  */
@@ -159891,7 +160031,7 @@ type GroupBarConfig = {
159891
160031
  */
159892
160032
  title?: string
159893
160033
  /**
159894
- * Select/deselect all if `CMD`/`CTRL` is pressed when clicking
160034
+ * Select/deselect all if <kbd>Cmd</kbd>/<kbd>Ctrl</kbd> is pressed when clicking
159895
160035
  */
159896
160036
  toggleAllIfCtrlPressed?: boolean
159897
160037
  /**
@@ -160651,7 +160791,7 @@ type TreeComboConfig = {
160651
160791
  contentElementCls?: string|object
160652
160792
  /**
160653
160793
  * 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,
160794
+ * 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
160795
  * 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
160796
  * ...
160657
160797
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-createOnUnmatched)
@@ -161151,7 +161291,7 @@ type TreeComboConfig = {
161151
161291
  required?: boolean
161152
161292
  /**
161153
161293
  * 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
161294
+ * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
161155
161295
  * 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
161296
  * behaviour will be activated.
161157
161297
  */