@bryntum/grid-trial 7.2.2 → 7.2.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (69) hide show
  1. package/fluent2-dark.css +1 -1
  2. package/fluent2-light.css +1 -1
  3. package/grid.css +2 -2
  4. package/grid.d.ts +172 -118
  5. package/grid.lwc.module.d.ts +1 -1
  6. package/grid.lwc.module.js +2 -2
  7. package/grid.module.d.ts +1 -1
  8. package/grid.module.js +41 -41
  9. package/grid.thin.d.ts +87 -113
  10. package/grid.umd.d.ts +1 -1
  11. package/grid.umd.js +48 -48
  12. package/grid.wc.module.d.ts +1 -1
  13. package/grid.wc.module.js +40 -40
  14. package/high-contrast-dark.css +2 -2
  15. package/high-contrast-light.css +2 -2
  16. package/locales/grid.locale.Ar.js +1 -1
  17. package/locales/grid.locale.Bg.js +1 -1
  18. package/locales/grid.locale.Ca.js +1 -1
  19. package/locales/grid.locale.Cs.js +1 -1
  20. package/locales/grid.locale.Da.js +1 -1
  21. package/locales/grid.locale.De.js +1 -1
  22. package/locales/grid.locale.El.js +1 -1
  23. package/locales/grid.locale.En.js +1 -1
  24. package/locales/grid.locale.EnGb.js +1 -1
  25. package/locales/grid.locale.Es.js +1 -1
  26. package/locales/grid.locale.Et.js +1 -1
  27. package/locales/grid.locale.Eu.js +1 -1
  28. package/locales/grid.locale.Fi.js +1 -1
  29. package/locales/grid.locale.FrFr.js +1 -1
  30. package/locales/grid.locale.Gl.js +1 -1
  31. package/locales/grid.locale.He.js +1 -1
  32. package/locales/grid.locale.Hi.js +1 -1
  33. package/locales/grid.locale.Hr.js +1 -1
  34. package/locales/grid.locale.Hu.js +1 -1
  35. package/locales/grid.locale.Id.js +1 -1
  36. package/locales/grid.locale.It.js +1 -1
  37. package/locales/grid.locale.Ja.js +1 -1
  38. package/locales/grid.locale.Kk.js +1 -1
  39. package/locales/grid.locale.Ko.js +1 -1
  40. package/locales/grid.locale.Lt.js +1 -1
  41. package/locales/grid.locale.Lv.js +1 -1
  42. package/locales/grid.locale.Ms.js +1 -1
  43. package/locales/grid.locale.Nl.js +1 -1
  44. package/locales/grid.locale.No.js +1 -1
  45. package/locales/grid.locale.Pl.js +1 -1
  46. package/locales/grid.locale.Pt.js +1 -1
  47. package/locales/grid.locale.PtBr.js +1 -1
  48. package/locales/grid.locale.Ro.js +1 -1
  49. package/locales/grid.locale.Ru.js +1 -1
  50. package/locales/grid.locale.Sk.js +1 -1
  51. package/locales/grid.locale.Sl.js +1 -1
  52. package/locales/grid.locale.Sr.js +1 -1
  53. package/locales/grid.locale.SrRs.js +1 -1
  54. package/locales/grid.locale.SvSE.js +1 -1
  55. package/locales/grid.locale.Th.js +1 -1
  56. package/locales/grid.locale.Tr.js +1 -1
  57. package/locales/grid.locale.Uk.js +1 -1
  58. package/locales/grid.locale.Vi.js +1 -1
  59. package/locales/grid.locale.ZhCn.js +1 -1
  60. package/locales/grid.locale.ZhTw.js +1 -1
  61. package/material3-dark.css +2 -2
  62. package/material3-light.css +2 -2
  63. package/package.json +1 -1
  64. package/stockholm-dark.css +1 -1
  65. package/stockholm-light.css +1 -1
  66. package/svalbard-dark.css +1 -1
  67. package/svalbard-light.css +1 -1
  68. package/visby-dark.css +2 -2
  69. package/visby-light.css +2 -2
package/grid.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  /*!
2
2
  *
3
- * Bryntum Grid 7.2.2 (TRIAL VERSION)
3
+ * Bryntum Grid 7.2.4 (TRIAL VERSION)
4
4
  *
5
5
  * Copyright(c) 2026 Bryntum AB
6
6
  * https://bryntum.com/contact
@@ -1312,6 +1312,25 @@ type BryntumListenerConfig = Record<string, Function|boolean|object|object[]|num
1312
1312
  asap?: boolean
1313
1313
  }
1314
1314
 
1315
+ type PluginConfigObject = {
1316
+ /**
1317
+ * Method names to add to the client (when they don't already exist)
1318
+ */
1319
+ assign?: string[]
1320
+ /**
1321
+ * Methods called <strong>before</strong> the client's original method
1322
+ */
1323
+ before?: string[]
1324
+ /**
1325
+ * Methods called <strong>after</strong> the client's original method
1326
+ */
1327
+ after?: string[]|object
1328
+ /**
1329
+ * Methods that replace the client's method (original accessible via `this.overridden`)
1330
+ */
1331
+ override?: string[]
1332
+ }
1333
+
1315
1334
  /**
1316
1335
  * The operator to use when comparing a collection object.
1317
1336
  * ...
@@ -2420,6 +2439,12 @@ type GlobalEventsListenersTypes = {
2420
2439
  * @param {string} event.theme The new theme name
2421
2440
  */
2422
2441
  theme: (event: { source: typeof GlobalEvents, theme: string }) => void
2442
+ /**
2443
+ * Fired when the browser zoom level is changed by the user
2444
+ * @param {object} event Event object
2445
+ * @param {typeof GlobalEvents} event.source
2446
+ */
2447
+ zoomChange: (event: { source: typeof GlobalEvents }) => void
2423
2448
  }
2424
2449
 
2425
2450
  /**
@@ -2458,6 +2483,12 @@ type GlobalEventsListeners = {
2458
2483
  * @param {string} event.theme The new theme name
2459
2484
  */
2460
2485
  theme?: ((event: { source: typeof GlobalEvents, theme: string }) => void)|string
2486
+ /**
2487
+ * Fired when the browser zoom level is changed by the user
2488
+ * @param {object} event Event object
2489
+ * @param {typeof GlobalEvents} event.source
2490
+ */
2491
+ zoomChange?: ((event: { source: typeof GlobalEvents }) => void)|string
2461
2492
  }
2462
2493
 
2463
2494
  export class GlobalEventsSingleton {
@@ -2506,6 +2537,12 @@ export class GlobalEventsSingleton {
2506
2537
  * @param {string} event.theme The new theme name
2507
2538
  */
2508
2539
  onTheme: ((event: { source: typeof GlobalEvents, theme: string }) => void)|string
2540
+ /**
2541
+ * Fired when the browser zoom level is changed by the user
2542
+ * @param {object} event Event object
2543
+ * @param {typeof GlobalEvents} event.source
2544
+ */
2545
+ onZoomChange: ((event: { source: typeof GlobalEvents }) => void)|string
2509
2546
  /**
2510
2547
  * Adds an event listener. This method accepts parameters in the following format:
2511
2548
  * @param {BryntumListenerConfig,string} config An object containing listener definitions, or the event name to listen for
@@ -3612,6 +3649,13 @@ type AjaxStoreConfig = {
3612
3649
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/data/AjaxStore#config-catchEventHandlerExceptions)
3613
3650
  */
3614
3651
  catchEventHandlerExceptions?: boolean
3652
+ /**
3653
+ * Set to `true` to have the chained store react to expand/collapse changes in the master store.
3654
+ * By default, expand/collapse in the master store does not trigger a refill of the chained store.
3655
+ * ...
3656
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/data/AjaxStore#config-chainExpandCollapse)
3657
+ */
3658
+ chainExpandCollapse?: boolean
3615
3659
  /**
3616
3660
  * If `true`, chained stores will apply filters from the master store. Filters flagged with `ignoreForChain`
3617
3661
  * will be ignored.
@@ -6413,6 +6457,13 @@ type StoreConfig = {
6413
6457
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/data/Store#config-catchEventHandlerExceptions)
6414
6458
  */
6415
6459
  catchEventHandlerExceptions?: boolean
6460
+ /**
6461
+ * Set to `true` to have the chained store react to expand/collapse changes in the master store.
6462
+ * By default, expand/collapse in the master store does not trigger a refill of the chained store.
6463
+ * ...
6464
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/data/Store#config-chainExpandCollapse)
6465
+ */
6466
+ chainExpandCollapse?: boolean
6416
6467
  /**
6417
6468
  * If `true`, chained stores will apply filters from the master store. Filters flagged with `ignoreForChain`
6418
6469
  * will be ignored.
@@ -7111,6 +7162,11 @@ export class Store extends Base {
7111
7162
  * Setting `autoCommit` to `true` automatically commits changes to records.
7112
7163
  */
7113
7164
  autoCommit: boolean
7165
+ /**
7166
+ * Returns the root store in the chain — the store that is not itself chained. For a store chained
7167
+ * off another chained store, this walks up the full chain. Returns `this` if the store is not chained.
7168
+ */
7169
+ readonly baseStore: Store
7114
7170
  /**
7115
7171
  * Set to `true` to call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
7116
7172
  */
@@ -7198,6 +7254,11 @@ export class Store extends Base {
7198
7254
  * 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.
7199
7255
  */
7200
7256
  readonly isPaged: boolean
7257
+ /**
7258
+ * Returns `true` if the data in this store depends on a remote data source. That is this
7259
+ * 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.
7260
+ */
7261
+ readonly isRemoteLoad: boolean
7201
7262
  /**
7202
7263
  * Is store sorted?
7203
7264
  */
@@ -9958,6 +10019,13 @@ export const StoreCRUD : <T extends AnyConstructor<Base>>(base : T) => AnyConstr
9958
10019
  * Type with configuration options for [StoreChained](https://bryntum.com/products/grid/docs/api/Core/data/mixin/StoreChained) class.
9959
10020
  */
9960
10021
  type StoreChainedClassConfig = {
10022
+ /**
10023
+ * Set to `true` to have the chained store react to expand/collapse changes in the master store.
10024
+ * By default, expand/collapse in the master store does not trigger a refill of the chained store.
10025
+ * ...
10026
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/data/mixin/StoreChained#config-chainExpandCollapse)
10027
+ */
10028
+ chainExpandCollapse?: boolean
9961
10029
  /**
9962
10030
  * If `true`, chained stores will apply filters from the master store. Filters flagged with `ignoreForChain`
9963
10031
  * will be ignored.
@@ -10032,6 +10100,11 @@ export class StoreChainedClass {
10032
10100
  * Identifies an object as an instance of [StoreChained](https://bryntum.com/products/grid/docs/api/Core/data/mixin/StoreChained) class, or subclass thereof.
10033
10101
  */
10034
10102
  static readonly isStoreChained: boolean
10103
+ /**
10104
+ * Returns the root store in the chain — the store that is not itself chained. For a store chained
10105
+ * off another chained store, this walks up the full chain. Returns `this` if the store is not chained.
10106
+ */
10107
+ readonly baseStore: Store
10035
10108
  /**
10036
10109
  * Is this a chained store?
10037
10110
  */
@@ -16038,7 +16111,8 @@ export class ObjectHelper {
16038
16111
  }
16039
16112
 
16040
16113
  /**
16041
- * Helper for string manipulation.
16114
+ * A static utility class providing common string manipulation methods such as HTML encoding, camelCase
16115
+ * conversion, regular expression escaping, and markdown-to-HTML processing.
16042
16116
  * ...
16043
16117
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/helper/StringHelper)
16044
16118
  */
@@ -16622,8 +16696,9 @@ export class Rectangle {
16622
16696
  * @param {HTMLElement,Core.widget.Widget,Core.widget.Mask,string} element The element (or selector) to calculate the Rectangle for.
16623
16697
  * @param {HTMLElement,string} relativeTo Optionally, a parent element (or selector) in whose space to calculate the Rectangle.
16624
16698
  * @param {boolean} ignorePageScroll Use browser viewport based coordinates.
16699
+ * @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.
16625
16700
  */
16626
- static from(element: HTMLElement|Widget|Mask|string, relativeTo?: HTMLElement|string, ignorePageScroll?: boolean): Rectangle;
16701
+ static from(element: HTMLElement|Widget|Mask|string, relativeTo?: HTMLElement|string, ignorePageScroll?: boolean, rtl?: boolean): Rectangle;
16627
16702
  /**
16628
16703
  * Returns the Rectangle in viewport coordinates of the passed element.
16629
16704
  * @param {HTMLElement} element The element to calculate the Rectangle for.
@@ -17157,8 +17232,8 @@ export class Scroller extends Base {
17157
17232
  resumeEvents(): boolean;
17158
17233
  /**
17159
17234
  * Scrolls by the passed deltas according to the passed options.
17160
- * @param {number} xDelta How far to scroll in the X axis.
17161
- * @param {number} yDelta How far to scroll in the Y axis.
17235
+ * @param {number} xDelta How far to scroll along the X axis.
17236
+ * @param {number} yDelta How far to scroll along the Y axis.
17162
17237
  * @param {object,boolean} options How to scroll. May be passed as `true` to animate.
17163
17238
  */
17164
17239
  scrollBy(xDelta?: number, yDelta?: number, options?: {
@@ -17818,6 +17893,11 @@ export class InstancePlugin extends Base {
17818
17893
  * Identifies an object as an instance of [Localizable](https://bryntum.com/products/grid/docs/api/Core/localization/Localizable) class, or subclass thereof.
17819
17894
  */
17820
17895
  static readonly isLocalizable: boolean
17896
+ /**
17897
+ * Defines how the plugin's methods integrate with its client (the widget it is attached to).
17898
+ * Override this static getter in subclasses.
17899
+ */
17900
+ static readonly pluginConfig: PluginConfigObject
17821
17901
  /**
17822
17902
  * Set to `true` to call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
17823
17903
  */
@@ -42889,7 +42969,7 @@ type DateTimeFieldConfig = {
42889
42969
  value?: string
42890
42970
  /**
42891
42971
  * 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.
42892
- * Uses localized value per default.
42972
+ * Uses a localized value by default.
42893
42973
  */
42894
42974
  weekStartDay?: number
42895
42975
  /**
@@ -107501,12 +107581,9 @@ type ActionColumnConfig = {
107501
107581
  */
107502
107582
  cellMenuItems?: Record<string, MenuItemEntry>
107503
107583
  /**
107504
- * Child nodes. To allow loading children on demand, specify `children : true` in your data. Omit the field for leaf
107505
- * tasks.
107506
- * ...
107507
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/ActionColumn#config-children)
107584
+ * Child columns. To create grouped headers, specify an array of column configs as children of a parent column.
107508
107585
  */
107509
- children?: boolean|object[]|Model[]|ModelConfig[]
107586
+ children?: GridColumnConfig[]|Column[]
107510
107587
  /**
107511
107588
  * CSS class added to the header of this column
107512
107589
  */
@@ -107637,8 +107714,9 @@ type ActionColumnConfig = {
107637
107714
  * @param {object} renderData
107638
107715
  * @param {Grid.column.Column} renderData.column This column
107639
107716
  * @param {HTMLElement} renderData.headerElement The header element
107717
+ * @returns {string,object,void,void} The text or markup to show in the column header
107640
107718
  */
107641
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
107719
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
107642
107720
  /**
107643
107721
  * An array of the widgets to append to the column header. These widgets have this Column instance
107644
107722
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -108179,12 +108257,9 @@ type AggregateColumnConfig = {
108179
108257
  */
108180
108258
  cellMenuItems?: Record<string, MenuItemEntry>
108181
108259
  /**
108182
- * Child nodes. To allow loading children on demand, specify `children : true` in your data. Omit the field for leaf
108183
- * tasks.
108184
- * ...
108185
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/AggregateColumn#config-children)
108260
+ * Child columns. To create grouped headers, specify an array of column configs as children of a parent column.
108186
108261
  */
108187
- children?: boolean|object[]|Model[]|ModelConfig[]
108262
+ children?: GridColumnConfig[]|Column[]
108188
108263
  /**
108189
108264
  * CSS class added to the header of this column
108190
108265
  */
@@ -108356,8 +108431,9 @@ type AggregateColumnConfig = {
108356
108431
  * @param {object} renderData
108357
108432
  * @param {Grid.column.Column} renderData.column This column
108358
108433
  * @param {HTMLElement} renderData.headerElement The header element
108434
+ * @returns {string,object,void,void} The text or markup to show in the column header
108359
108435
  */
108360
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
108436
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
108361
108437
  /**
108362
108438
  * An array of the widgets to append to the column header. These widgets have this Column instance
108363
108439
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -108969,12 +109045,9 @@ type ChartColumnConfig = {
108969
109045
  */
108970
109046
  chartCls?: string
108971
109047
  /**
108972
- * Child nodes. To allow loading children on demand, specify `children : true` in your data. Omit the field for leaf
108973
- * tasks.
108974
- * ...
108975
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/ChartColumn#config-children)
109048
+ * Child columns. To create grouped headers, specify an array of column configs as children of a parent column.
108976
109049
  */
108977
- children?: boolean|object[]|Model[]|ModelConfig[]
109050
+ children?: GridColumnConfig[]|Column[]
108978
109051
  /**
108979
109052
  * CSS class added to the header of this column
108980
109053
  */
@@ -109126,8 +109199,9 @@ type ChartColumnConfig = {
109126
109199
  * @param {object} renderData
109127
109200
  * @param {Grid.column.Column} renderData.column This column
109128
109201
  * @param {HTMLElement} renderData.headerElement The header element
109202
+ * @returns {string,object,void,void} The text or markup to show in the column header
109129
109203
  */
109130
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
109204
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
109131
109205
  /**
109132
109206
  * An array of the widgets to append to the column header. These widgets have this Column instance
109133
109207
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -109744,12 +109818,9 @@ type CheckColumnConfig = {
109744
109818
  */
109745
109819
  checkCls?: string
109746
109820
  /**
109747
- * Child nodes. To allow loading children on demand, specify `children : true` in your data. Omit the field for leaf
109748
- * tasks.
109749
- * ...
109750
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/CheckColumn#config-children)
109821
+ * Child columns. To create grouped headers, specify an array of column configs as children of a parent column.
109751
109822
  */
109752
- children?: boolean|object[]|Model[]|ModelConfig[]
109823
+ children?: GridColumnConfig[]|Column[]
109753
109824
  /**
109754
109825
  * CSS class added to the header of this column
109755
109826
  */
@@ -109901,8 +109972,9 @@ type CheckColumnConfig = {
109901
109972
  * @param {object} renderData
109902
109973
  * @param {Grid.column.Column} renderData.column This column
109903
109974
  * @param {HTMLElement} renderData.headerElement The header element
109975
+ * @returns {string,object,void,void} The text or markup to show in the column header
109904
109976
  */
109905
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
109977
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
109906
109978
  /**
109907
109979
  * An array of the widgets to append to the column header. These widgets have this Column instance
109908
109980
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -110531,12 +110603,9 @@ type ColorColumnConfig = {
110531
110603
  */
110532
110604
  cellMenuItems?: Record<string, MenuItemEntry>
110533
110605
  /**
110534
- * Child nodes. To allow loading children on demand, specify `children : true` in your data. Omit the field for leaf
110535
- * tasks.
110536
- * ...
110537
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/ColorColumn#config-children)
110606
+ * Child columns. To create grouped headers, specify an array of column configs as children of a parent column.
110538
110607
  */
110539
- children?: boolean|object[]|Model[]|ModelConfig[]
110608
+ children?: GridColumnConfig[]|Column[]
110540
110609
  /**
110541
110610
  * CSS class added to the header of this column
110542
110611
  */
@@ -110691,8 +110760,9 @@ type ColorColumnConfig = {
110691
110760
  * @param {object} renderData
110692
110761
  * @param {Grid.column.Column} renderData.column This column
110693
110762
  * @param {HTMLElement} renderData.headerElement The header element
110763
+ * @returns {string,object,void,void} The text or markup to show in the column header
110694
110764
  */
110695
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
110765
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
110696
110766
  /**
110697
110767
  * An array of the widgets to append to the column header. These widgets have this Column instance
110698
110768
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -111269,12 +111339,9 @@ type ColumnConfig = {
111269
111339
  */
111270
111340
  cellMenuItems?: Record<string, MenuItemEntry>
111271
111341
  /**
111272
- * Child nodes. To allow loading children on demand, specify `children : true` in your data. Omit the field for leaf
111273
- * tasks.
111274
- * ...
111275
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-children)
111342
+ * Child columns. To create grouped headers, specify an array of column configs as children of a parent column.
111276
111343
  */
111277
- children?: boolean|object[]|Model[]|ModelConfig[]
111344
+ children?: GridColumnConfig[]|Column[]
111278
111345
  /**
111279
111346
  * CSS class added to the header of this column
111280
111347
  */
@@ -111426,8 +111493,9 @@ type ColumnConfig = {
111426
111493
  * @param {object} renderData
111427
111494
  * @param {Grid.column.Column} renderData.column This column
111428
111495
  * @param {HTMLElement} renderData.headerElement The header element
111496
+ * @returns {string,object,void,void} The text or markup to show in the column header
111429
111497
  */
111430
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
111498
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
111431
111499
  /**
111432
111500
  * An array of the widgets to append to the column header. These widgets have this Column instance
111433
111501
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -111835,6 +111903,12 @@ export class Column extends Model {
111835
111903
  * Set to `true` to call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
111836
111904
  */
111837
111905
  callOnFunctions: boolean
111906
+ /**
111907
+ * Returns `true` if this column can currently be sorted by the user.
111908
+ * Checks both the column's own [sortable](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-sortable) config and whether the
111909
+ * [Sort](https://bryntum.com/products/grid/docs/api/Grid/feature/Sort) feature is enabled on the grid.
111910
+ */
111911
+ readonly canSort: boolean
111838
111912
  /**
111839
111913
  * By default, if an event handler throws an exception, the error propagates up the stack and the
111840
111914
  * application state is undefined. Code which follows the event handler will *not* be executed.
@@ -111975,7 +112049,7 @@ export class Column extends Model {
111975
112049
  /**
111976
112050
  * Renderer function for the column header.
111977
112051
  */
111978
- headerRenderer: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
112052
+ headerRenderer: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
111979
112053
  /**
111980
112054
  * An array of the widgets to append to the column header. These widgets have this Column instance
111981
112055
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -112555,12 +112629,9 @@ type CurrencyColumnConfig = {
112555
112629
  */
112556
112630
  cellMenuItems?: Record<string, MenuItemEntry>
112557
112631
  /**
112558
- * Child nodes. To allow loading children on demand, specify `children : true` in your data. Omit the field for leaf
112559
- * tasks.
112560
- * ...
112561
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/CurrencyColumn#config-children)
112632
+ * Child columns. To create grouped headers, specify an array of column configs as children of a parent column.
112562
112633
  */
112563
- children?: boolean|object[]|Model[]|ModelConfig[]
112634
+ children?: GridColumnConfig[]|Column[]
112564
112635
  /**
112565
112636
  * CSS class added to the header of this column
112566
112637
  */
@@ -112723,8 +112794,9 @@ type CurrencyColumnConfig = {
112723
112794
  * @param {object} renderData
112724
112795
  * @param {Grid.column.Column} renderData.column This column
112725
112796
  * @param {HTMLElement} renderData.headerElement The header element
112797
+ * @returns {string,object,void,void} The text or markup to show in the column header
112726
112798
  */
112727
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
112799
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
112728
112800
  /**
112729
112801
  * An array of the widgets to append to the column header. These widgets have this Column instance
112730
112802
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -113312,12 +113384,9 @@ type DateColumnConfig = {
113312
113384
  */
113313
113385
  cellMenuItems?: Record<string, MenuItemEntry>
113314
113386
  /**
113315
- * Child nodes. To allow loading children on demand, specify `children : true` in your data. Omit the field for leaf
113316
- * tasks.
113317
- * ...
113318
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/DateColumn#config-children)
113387
+ * Child columns. To create grouped headers, specify an array of column configs as children of a parent column.
113319
113388
  */
113320
- children?: boolean|object[]|Model[]|ModelConfig[]
113389
+ children?: GridColumnConfig[]|Column[]
113321
113390
  /**
113322
113391
  * CSS class added to the header of this column
113323
113392
  */
@@ -113475,8 +113544,9 @@ type DateColumnConfig = {
113475
113544
  * @param {object} renderData
113476
113545
  * @param {Grid.column.Column} renderData.column This column
113477
113546
  * @param {HTMLElement} renderData.headerElement The header element
113547
+ * @returns {string,object,void,void} The text or markup to show in the column header
113478
113548
  */
113479
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
113549
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
113480
113550
  /**
113481
113551
  * An array of the widgets to append to the column header. These widgets have this Column instance
113482
113552
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -114075,12 +114145,9 @@ type NumberColumnConfig = {
114075
114145
  */
114076
114146
  cellMenuItems?: Record<string, MenuItemEntry>
114077
114147
  /**
114078
- * Child nodes. To allow loading children on demand, specify `children : true` in your data. Omit the field for leaf
114079
- * tasks.
114080
- * ...
114081
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/NumberColumn#config-children)
114148
+ * Child columns. To create grouped headers, specify an array of column configs as children of a parent column.
114082
114149
  */
114083
- children?: boolean|object[]|Model[]|ModelConfig[]
114150
+ children?: GridColumnConfig[]|Column[]
114084
114151
  /**
114085
114152
  * CSS class added to the header of this column
114086
114153
  */
@@ -114238,8 +114305,9 @@ type NumberColumnConfig = {
114238
114305
  * @param {object} renderData
114239
114306
  * @param {Grid.column.Column} renderData.column This column
114240
114307
  * @param {HTMLElement} renderData.headerElement The header element
114308
+ * @returns {string,object,void,void} The text or markup to show in the column header
114241
114309
  */
114242
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
114310
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
114243
114311
  /**
114244
114312
  * An array of the widgets to append to the column header. These widgets have this Column instance
114245
114313
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -114854,12 +114922,9 @@ type PercentColumnConfig = {
114854
114922
  */
114855
114923
  cellMenuItems?: Record<string, MenuItemEntry>
114856
114924
  /**
114857
- * Child nodes. To allow loading children on demand, specify `children : true` in your data. Omit the field for leaf
114858
- * tasks.
114859
- * ...
114860
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/PercentColumn#config-children)
114925
+ * Child columns. To create grouped headers, specify an array of column configs as children of a parent column.
114861
114926
  */
114862
- children?: boolean|object[]|Model[]|ModelConfig[]
114927
+ children?: GridColumnConfig[]|Column[]
114863
114928
  /**
114864
114929
  * CSS class added to the header of this column
114865
114930
  */
@@ -115017,8 +115082,9 @@ type PercentColumnConfig = {
115017
115082
  * @param {object} renderData
115018
115083
  * @param {Grid.column.Column} renderData.column This column
115019
115084
  * @param {HTMLElement} renderData.headerElement The header element
115085
+ * @returns {string,object,void,void} The text or markup to show in the column header
115020
115086
  */
115021
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
115087
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
115022
115088
  /**
115023
115089
  * An array of the widgets to append to the column header. These widgets have this Column instance
115024
115090
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -115620,12 +115686,9 @@ type RatingColumnConfig = {
115620
115686
  */
115621
115687
  cellMenuItems?: Record<string, MenuItemEntry>
115622
115688
  /**
115623
- * Child nodes. To allow loading children on demand, specify `children : true` in your data. Omit the field for leaf
115624
- * tasks.
115625
- * ...
115626
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/RatingColumn#config-children)
115689
+ * Child columns. To create grouped headers, specify an array of column configs as children of a parent column.
115627
115690
  */
115628
- children?: boolean|object[]|Model[]|ModelConfig[]
115691
+ children?: GridColumnConfig[]|Column[]
115629
115692
  /**
115630
115693
  * CSS class added to the header of this column
115631
115694
  */
@@ -115795,8 +115858,9 @@ type RatingColumnConfig = {
115795
115858
  * @param {object} renderData
115796
115859
  * @param {Grid.column.Column} renderData.column This column
115797
115860
  * @param {HTMLElement} renderData.headerElement The header element
115861
+ * @returns {string,object,void,void} The text or markup to show in the column header
115798
115862
  */
115799
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
115863
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
115800
115864
  /**
115801
115865
  * An array of the widgets to append to the column header. These widgets have this Column instance
115802
115866
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -116377,12 +116441,9 @@ type RowNumberColumnConfig = {
116377
116441
  */
116378
116442
  cellMenuItems?: Record<string, MenuItemEntry>
116379
116443
  /**
116380
- * Child nodes. To allow loading children on demand, specify `children : true` in your data. Omit the field for leaf
116381
- * tasks.
116382
- * ...
116383
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/RowNumberColumn#config-children)
116444
+ * Child columns. To create grouped headers, specify an array of column configs as children of a parent column.
116384
116445
  */
116385
- children?: boolean|object[]|Model[]|ModelConfig[]
116446
+ children?: GridColumnConfig[]|Column[]
116386
116447
  /**
116387
116448
  * CSS class added to the header of this column
116388
116449
  */
@@ -116475,8 +116536,9 @@ type RowNumberColumnConfig = {
116475
116536
  * @param {object} renderData
116476
116537
  * @param {Grid.column.Column} renderData.column This column
116477
116538
  * @param {HTMLElement} renderData.headerElement The header element
116539
+ * @returns {string,object,void,void} The text or markup to show in the column header
116478
116540
  */
116479
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
116541
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
116480
116542
  /**
116481
116543
  * An array of the widgets to append to the column header. These widgets have this Column instance
116482
116544
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -116986,12 +117048,9 @@ type SparklineColumnConfig = {
116986
117048
  */
116987
117049
  chartType?: 'line'|'bar'|'pie'
116988
117050
  /**
116989
- * Child nodes. To allow loading children on demand, specify `children : true` in your data. Omit the field for leaf
116990
- * tasks.
116991
- * ...
116992
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/SparklineColumn#config-children)
117051
+ * Child columns. To create grouped headers, specify an array of column configs as children of a parent column.
116993
117052
  */
116994
- children?: boolean|object[]|Model[]|ModelConfig[]
117053
+ children?: GridColumnConfig[]|Column[]
116995
117054
  /**
116996
117055
  * CSS class added to the header of this column
116997
117056
  */
@@ -117143,8 +117202,9 @@ type SparklineColumnConfig = {
117143
117202
  * @param {object} renderData
117144
117203
  * @param {Grid.column.Column} renderData.column This column
117145
117204
  * @param {HTMLElement} renderData.headerElement The header element
117205
+ * @returns {string,object,void,void} The text or markup to show in the column header
117146
117206
  */
117147
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
117207
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
117148
117208
  /**
117149
117209
  * An array of the widgets to append to the column header. These widgets have this Column instance
117150
117210
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -117710,12 +117770,9 @@ type TemplateColumnConfig = {
117710
117770
  */
117711
117771
  cellMenuItems?: Record<string, MenuItemEntry>
117712
117772
  /**
117713
- * Child nodes. To allow loading children on demand, specify `children : true` in your data. Omit the field for leaf
117714
- * tasks.
117715
- * ...
117716
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/TemplateColumn#config-children)
117773
+ * Child columns. To create grouped headers, specify an array of column configs as children of a parent column.
117717
117774
  */
117718
- children?: boolean|object[]|Model[]|ModelConfig[]
117775
+ children?: GridColumnConfig[]|Column[]
117719
117776
  /**
117720
117777
  * CSS class added to the header of this column
117721
117778
  */
@@ -117867,8 +117924,9 @@ type TemplateColumnConfig = {
117867
117924
  * @param {object} renderData
117868
117925
  * @param {Grid.column.Column} renderData.column This column
117869
117926
  * @param {HTMLElement} renderData.headerElement The header element
117927
+ * @returns {string,object,void,void} The text or markup to show in the column header
117870
117928
  */
117871
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
117929
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
117872
117930
  /**
117873
117931
  * An array of the widgets to append to the column header. These widgets have this Column instance
117874
117932
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -118434,12 +118492,9 @@ type TimeColumnConfig = {
118434
118492
  */
118435
118493
  cellMenuItems?: Record<string, MenuItemEntry>
118436
118494
  /**
118437
- * Child nodes. To allow loading children on demand, specify `children : true` in your data. Omit the field for leaf
118438
- * tasks.
118439
- * ...
118440
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/TimeColumn#config-children)
118495
+ * Child columns. To create grouped headers, specify an array of column configs as children of a parent column.
118441
118496
  */
118442
- children?: boolean|object[]|Model[]|ModelConfig[]
118497
+ children?: GridColumnConfig[]|Column[]
118443
118498
  /**
118444
118499
  * CSS class added to the header of this column
118445
118500
  */
@@ -118596,8 +118651,9 @@ type TimeColumnConfig = {
118596
118651
  * @param {object} renderData
118597
118652
  * @param {Grid.column.Column} renderData.column This column
118598
118653
  * @param {HTMLElement} renderData.headerElement The header element
118654
+ * @returns {string,object,void,void} The text or markup to show in the column header
118599
118655
  */
118600
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
118656
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
118601
118657
  /**
118602
118658
  * An array of the widgets to append to the column header. These widgets have this Column instance
118603
118659
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -119155,12 +119211,9 @@ type TreeColumnConfig = {
119155
119211
  */
119156
119212
  cellMenuItems?: Record<string, MenuItemEntry>
119157
119213
  /**
119158
- * Child nodes. To allow loading children on demand, specify `children : true` in your data. Omit the field for leaf
119159
- * tasks.
119160
- * ...
119161
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/TreeColumn#config-children)
119214
+ * Child columns. To create grouped headers, specify an array of column configs as children of a parent column.
119162
119215
  */
119163
- children?: boolean|object[]|Model[]|ModelConfig[]
119216
+ children?: GridColumnConfig[]|Column[]
119164
119217
  /**
119165
119218
  * CSS class added to the header of this column
119166
119219
  */
@@ -119328,8 +119381,9 @@ type TreeColumnConfig = {
119328
119381
  * @param {object} renderData
119329
119382
  * @param {Grid.column.Column} renderData.column This column
119330
119383
  * @param {HTMLElement} renderData.headerElement The header element
119384
+ * @returns {string,object,void,void} The text or markup to show in the column header
119331
119385
  */
119332
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
119386
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
119333
119387
  /**
119334
119388
  * An array of the widgets to append to the column header. These widgets have this Column instance
119335
119389
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -119930,12 +119984,9 @@ type WidgetColumnConfig = {
119930
119984
  */
119931
119985
  cellMenuItems?: Record<string, MenuItemEntry>
119932
119986
  /**
119933
- * Child nodes. To allow loading children on demand, specify `children : true` in your data. Omit the field for leaf
119934
- * tasks.
119935
- * ...
119936
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/WidgetColumn#config-children)
119987
+ * Child columns. To create grouped headers, specify an array of column configs as children of a parent column.
119937
119988
  */
119938
- children?: boolean|object[]|Model[]|ModelConfig[]
119989
+ children?: GridColumnConfig[]|Column[]
119939
119990
  /**
119940
119991
  * CSS class added to the header of this column
119941
119992
  */
@@ -120087,8 +120138,9 @@ type WidgetColumnConfig = {
120087
120138
  * @param {object} renderData
120088
120139
  * @param {Grid.column.Column} renderData.column This column
120089
120140
  * @param {HTMLElement} renderData.headerElement The header element
120141
+ * @returns {string,object,void,void} The text or markup to show in the column header
120090
120142
  */
120091
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
120143
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
120092
120144
  /**
120093
120145
  * An array of the widgets to append to the column header. These widgets have this Column instance
120094
120146
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -121204,6 +121256,13 @@ type ColumnStoreConfig = {
121204
121256
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/data/ColumnStore#config-catchEventHandlerExceptions)
121205
121257
  */
121206
121258
  catchEventHandlerExceptions?: boolean
121259
+ /**
121260
+ * Set to `true` to have the chained store react to expand/collapse changes in the master store.
121261
+ * By default, expand/collapse in the master store does not trigger a refill of the chained store.
121262
+ * ...
121263
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/data/ColumnStore#config-chainExpandCollapse)
121264
+ */
121265
+ chainExpandCollapse?: boolean
121207
121266
  /**
121208
121267
  * If `true`, chained stores will apply filters from the master store. Filters flagged with `ignoreForChain`
121209
121268
  * will be ignored.
@@ -121932,16 +121991,11 @@ export class ColumnStore extends Store {
121932
121991
  */
121933
121992
  static registerColumnType(columnClass: Function, simpleRenderer?: boolean): void;
121934
121993
  /**
121935
- * 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
121936
- * columns id instead.
121994
+ * Get column by field. To be sure that you are getting exactly the intended column, use
121995
+ * [getById](https://bryntum.com/products/grid/docs/api/Core/data/Store#function-getById) with the columns id instead.
121937
121996
  * @param {string} field Field name
121938
121997
  */
121939
121998
  get(field: string): Column;
121940
- /**
121941
- * Get column by id.
121942
- * @param {string,number} id
121943
- */
121944
- getById(id: string|number): Column;
121945
121999
  /**
121946
122000
  * indexOf extended to also accept a columns field, for backward compatibility.
121947
122001
  * @param {Core.data.Model,string} recordOrId
@@ -128023,7 +128077,7 @@ export class LockRows extends Split {
128023
128077
  */
128024
128078
  readonly isLockRows: boolean
128025
128079
  /**
128026
- * Locking rows leads to two chained stores that holds a subset of the records, one for the locked records and one
128080
+ * Locking rows results in two chained stores that holds a subset of the records, one for the locked records and one
128027
128081
  * for the rest. This property holds the original store, if you need to access it.
128028
128082
  */
128029
128083
  originalStore: Store
@@ -144777,7 +144831,7 @@ export class GridBase extends Panel {
144777
144831
  */
144778
144832
  longPressTime: number
144779
144833
  /**
144780
- * Locking rows leads to two chained stores that holds a subset of the records, one for the locked records and one
144834
+ * Locking rows results in two chained stores that holds a subset of the records, one for the locked records and one
144781
144835
  * for the rest. This property holds the original store, if you need to access it.
144782
144836
  */
144783
144837
  originalStore: Store