@bryntum/grid-trial 7.3.3 → 7.3.5

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 (53) hide show
  1. package/AGENTS.md +80 -0
  2. package/CLAUDE.md +80 -0
  3. package/grid.css +1 -1
  4. package/grid.d.ts +1232 -88
  5. package/grid.module.js +40 -40
  6. package/grid.thin.d.ts +199 -58
  7. package/grid.umd.js +48 -48
  8. package/locales/grid.locale.Ar.js +1 -1
  9. package/locales/grid.locale.Bg.js +1 -1
  10. package/locales/grid.locale.Ca.js +1 -1
  11. package/locales/grid.locale.Cs.js +1 -1
  12. package/locales/grid.locale.Da.js +1 -1
  13. package/locales/grid.locale.De.js +1 -1
  14. package/locales/grid.locale.El.js +1 -1
  15. package/locales/grid.locale.En.js +1 -1
  16. package/locales/grid.locale.EnGb.js +1 -1
  17. package/locales/grid.locale.Es.js +1 -1
  18. package/locales/grid.locale.Et.js +1 -1
  19. package/locales/grid.locale.Eu.js +1 -1
  20. package/locales/grid.locale.Fi.js +1 -1
  21. package/locales/grid.locale.FrFr.js +1 -1
  22. package/locales/grid.locale.Gl.js +1 -1
  23. package/locales/grid.locale.He.js +1 -1
  24. package/locales/grid.locale.Hi.js +1 -1
  25. package/locales/grid.locale.Hr.js +1 -1
  26. package/locales/grid.locale.Hu.js +1 -1
  27. package/locales/grid.locale.Id.js +1 -1
  28. package/locales/grid.locale.It.js +1 -1
  29. package/locales/grid.locale.Ja.js +1 -1
  30. package/locales/grid.locale.Kk.js +1 -1
  31. package/locales/grid.locale.Ko.js +1 -1
  32. package/locales/grid.locale.Lt.js +1 -1
  33. package/locales/grid.locale.Lv.js +1 -1
  34. package/locales/grid.locale.Ms.js +1 -1
  35. package/locales/grid.locale.Nl.js +1 -1
  36. package/locales/grid.locale.No.js +1 -1
  37. package/locales/grid.locale.Pl.js +1 -1
  38. package/locales/grid.locale.Pt.js +1 -1
  39. package/locales/grid.locale.PtBr.js +1 -1
  40. package/locales/grid.locale.Ro.js +1 -1
  41. package/locales/grid.locale.Ru.js +1 -1
  42. package/locales/grid.locale.Sk.js +1 -1
  43. package/locales/grid.locale.Sl.js +1 -1
  44. package/locales/grid.locale.Sr.js +1 -1
  45. package/locales/grid.locale.SrRs.js +1 -1
  46. package/locales/grid.locale.SvSE.js +1 -1
  47. package/locales/grid.locale.Th.js +1 -1
  48. package/locales/grid.locale.Tr.js +1 -1
  49. package/locales/grid.locale.Uk.js +1 -1
  50. package/locales/grid.locale.Vi.js +1 -1
  51. package/locales/grid.locale.ZhCn.js +1 -1
  52. package/locales/grid.locale.ZhTw.js +1 -1
  53. package/package.json +1 -1
package/grid.thin.d.ts CHANGED
@@ -7,7 +7,7 @@ import { AIBase, AIModelConfiguration, AIModelSelector, AISettingsModel, AISetti
7
7
  Duration, DurationConfig, Editor, EditorConfig, EventsClass, FetchOptions, Field, FieldContainer, FieldContainerConfig,
8
8
  FieldFilterPicker, FieldFilterPickerConfig, FieldFilterPickerGroup, FieldOption, FieldTriggerConfig, FormulaProvider,
9
9
  FormulaProviderConfig, Grouper, InstancePlugin, KeyMap, KeyMapConfig, LazyLoadRequestParams, List, ListConfig, LocaleHelper,
10
- LocaleManager, Mask, MaskConfig, Menu, MenuConfig, MenuItem, MenuItemEntry, Model, NumberFormat, NumberFormatConfig,
10
+ LocaleManager, Mask, MaskConfig, Menu, MenuConfig, MenuItem, MenuItemEntry, Model, NumberFormat, NumberFormatConfig, OverflowTwinConfig,
11
11
  PagingRequestParams, PagingToolbar, PagingToolbarConfig, Panel, PanelCollapser, PanelCollapserConfig, PanelCollapserOverlay,
12
12
  PanelCollapserOverlayConfig, PanelConfig, PanelHeader, Popup, PopupConfig, ReactJSX, Rectangle, ScrollManager, ScrollManagerConfig,
13
13
  Scroller, ScrollerConfig, Sorter, StateProvider, StateTrackingManager, Store, StoreConfig, StoreSearchResult, SyncDataOnLoadOptions,
@@ -243,6 +243,16 @@ type ExportConfig = {
243
243
  * Set to true to output as a CSV file, or as an object where you can specify delimiters.
244
244
  */
245
245
  csv?: boolean|object
246
+ /**
247
+ * MIME type used when creating the CSV Blob. Defaults to `text/csv`. Use
248
+ * `application/octet-stream` in Salesforce LWS environments.
249
+ */
250
+ csvMimeType?: string
251
+ /**
252
+ * MIME type used when creating the XLSX download Blob. Use
253
+ * `application/octet-stream` in Salesforce LWS environments.
254
+ */
255
+ xlsxMimeType?: string
246
256
  }
247
257
 
248
258
  type XLSColumn = {
@@ -839,10 +849,10 @@ type ActionColumnConfig = {
839
849
  * @param {HTMLElement} renderData.cellElement Cell element, for adding CSS classes, styling etc.
840
850
  * @param {any} renderData.groupRowFor Current group value
841
851
  * @param {Core.data.Model} renderData.record Record for the row
842
- * @param {Core.data.Model[]} renderData.groupRecords Records in the group
852
+ * @param {Core.data.Model[]} renderData.groupRecords Records in the group. When the [GroupSummary](https://bryntum.com/products/grid/docs/api/Grid/feature/GroupSummary) feature is enabled with its default [target](https://bryntum.com/products/grid/docs/api/Grid/feature/GroupSummary#config-target) of `'footer'`, the last entry is the group footer record, so `groupRecords.length` is one more than `count`. Filter it out using its [isGroupFooter](https://bryntum.com/products/grid/docs/api/Core/data/Model#property-isGroupFooter) flag if needed
843
853
  * @param {Grid.column.Column} renderData.column Current rendering column
844
854
  * @param {Grid.column.Column} renderData.groupColumn Column that the grid is grouped by
845
- * @param {number} renderData.count Number of records in the group
855
+ * @param {number} renderData.count Number of records in the group, excluding the group footer record
846
856
  * @param {Grid.view.Grid} renderData.grid This grid
847
857
  * @returns {DomConfig,string,void} The header grouping text or DomConfig object representing the HTML markup
848
858
  */
@@ -1515,10 +1525,10 @@ type AggregateColumnConfig = {
1515
1525
  * @param {HTMLElement} renderData.cellElement Cell element, for adding CSS classes, styling etc.
1516
1526
  * @param {any} renderData.groupRowFor Current group value
1517
1527
  * @param {Core.data.Model} renderData.record Record for the row
1518
- * @param {Core.data.Model[]} renderData.groupRecords Records in the group
1528
+ * @param {Core.data.Model[]} renderData.groupRecords Records in the group. When the [GroupSummary](https://bryntum.com/products/grid/docs/api/Grid/feature/GroupSummary) feature is enabled with its default [target](https://bryntum.com/products/grid/docs/api/Grid/feature/GroupSummary#config-target) of `'footer'`, the last entry is the group footer record, so `groupRecords.length` is one more than `count`. Filter it out using its [isGroupFooter](https://bryntum.com/products/grid/docs/api/Core/data/Model#property-isGroupFooter) flag if needed
1519
1529
  * @param {Grid.column.Column} renderData.column Current rendering column
1520
1530
  * @param {Grid.column.Column} renderData.groupColumn Column that the grid is grouped by
1521
- * @param {number} renderData.count Number of records in the group
1531
+ * @param {number} renderData.count Number of records in the group, excluding the group footer record
1522
1532
  * @param {Grid.view.Grid} renderData.grid This grid
1523
1533
  * @returns {DomConfig,string,void} The header grouping text or DomConfig object representing the HTML markup
1524
1534
  */
@@ -2247,10 +2257,10 @@ type ChartColumnConfig = {
2247
2257
  * @param {HTMLElement} renderData.cellElement Cell element, for adding CSS classes, styling etc.
2248
2258
  * @param {any} renderData.groupRowFor Current group value
2249
2259
  * @param {Core.data.Model} renderData.record Record for the row
2250
- * @param {Core.data.Model[]} renderData.groupRecords Records in the group
2260
+ * @param {Core.data.Model[]} renderData.groupRecords Records in the group. When the [GroupSummary](https://bryntum.com/products/grid/docs/api/Grid/feature/GroupSummary) feature is enabled with its default [target](https://bryntum.com/products/grid/docs/api/Grid/feature/GroupSummary#config-target) of `'footer'`, the last entry is the group footer record, so `groupRecords.length` is one more than `count`. Filter it out using its [isGroupFooter](https://bryntum.com/products/grid/docs/api/Core/data/Model#property-isGroupFooter) flag if needed
2251
2261
  * @param {Grid.column.Column} renderData.column Current rendering column
2252
2262
  * @param {Grid.column.Column} renderData.groupColumn Column that the grid is grouped by
2253
- * @param {number} renderData.count Number of records in the group
2263
+ * @param {number} renderData.count Number of records in the group, excluding the group footer record
2254
2264
  * @param {Grid.view.Grid} renderData.grid This grid
2255
2265
  * @returns {DomConfig,string,void} The header grouping text or DomConfig object representing the HTML markup
2256
2266
  */
@@ -2984,10 +2994,10 @@ type CheckColumnConfig = {
2984
2994
  * @param {HTMLElement} renderData.cellElement Cell element, for adding CSS classes, styling etc.
2985
2995
  * @param {any} renderData.groupRowFor Current group value
2986
2996
  * @param {Core.data.Model} renderData.record Record for the row
2987
- * @param {Core.data.Model[]} renderData.groupRecords Records in the group
2997
+ * @param {Core.data.Model[]} renderData.groupRecords Records in the group. When the [GroupSummary](https://bryntum.com/products/grid/docs/api/Grid/feature/GroupSummary) feature is enabled with its default [target](https://bryntum.com/products/grid/docs/api/Grid/feature/GroupSummary#config-target) of `'footer'`, the last entry is the group footer record, so `groupRecords.length` is one more than `count`. Filter it out using its [isGroupFooter](https://bryntum.com/products/grid/docs/api/Core/data/Model#property-isGroupFooter) flag if needed
2988
2998
  * @param {Grid.column.Column} renderData.column Current rendering column
2989
2999
  * @param {Grid.column.Column} renderData.groupColumn Column that the grid is grouped by
2990
- * @param {number} renderData.count Number of records in the group
3000
+ * @param {number} renderData.count Number of records in the group, excluding the group footer record
2991
3001
  * @param {Grid.view.Grid} renderData.grid This grid
2992
3002
  * @returns {DomConfig,string,void} The header grouping text or DomConfig object representing the HTML markup
2993
3003
  */
@@ -3736,10 +3746,10 @@ type ColorColumnConfig = {
3736
3746
  * @param {HTMLElement} renderData.cellElement Cell element, for adding CSS classes, styling etc.
3737
3747
  * @param {any} renderData.groupRowFor Current group value
3738
3748
  * @param {Core.data.Model} renderData.record Record for the row
3739
- * @param {Core.data.Model[]} renderData.groupRecords Records in the group
3749
+ * @param {Core.data.Model[]} renderData.groupRecords Records in the group. When the [GroupSummary](https://bryntum.com/products/grid/docs/api/Grid/feature/GroupSummary) feature is enabled with its default [target](https://bryntum.com/products/grid/docs/api/Grid/feature/GroupSummary#config-target) of `'footer'`, the last entry is the group footer record, so `groupRecords.length` is one more than `count`. Filter it out using its [isGroupFooter](https://bryntum.com/products/grid/docs/api/Core/data/Model#property-isGroupFooter) flag if needed
3740
3750
  * @param {Grid.column.Column} renderData.column Current rendering column
3741
3751
  * @param {Grid.column.Column} renderData.groupColumn Column that the grid is grouped by
3742
- * @param {number} renderData.count Number of records in the group
3752
+ * @param {number} renderData.count Number of records in the group, excluding the group footer record
3743
3753
  * @param {Grid.view.Grid} renderData.grid This grid
3744
3754
  * @returns {DomConfig,string,void} The header grouping text or DomConfig object representing the HTML markup
3745
3755
  */
@@ -4433,10 +4443,10 @@ type ColumnConfig = {
4433
4443
  * @param {HTMLElement} renderData.cellElement Cell element, for adding CSS classes, styling etc.
4434
4444
  * @param {any} renderData.groupRowFor Current group value
4435
4445
  * @param {Core.data.Model} renderData.record Record for the row
4436
- * @param {Core.data.Model[]} renderData.groupRecords Records in the group
4446
+ * @param {Core.data.Model[]} renderData.groupRecords Records in the group. When the [GroupSummary](https://bryntum.com/products/grid/docs/api/Grid/feature/GroupSummary) feature is enabled with its default [target](https://bryntum.com/products/grid/docs/api/Grid/feature/GroupSummary#config-target) of `'footer'`, the last entry is the group footer record, so `groupRecords.length` is one more than `count`. Filter it out using its [isGroupFooter](https://bryntum.com/products/grid/docs/api/Core/data/Model#property-isGroupFooter) flag if needed
4437
4447
  * @param {Grid.column.Column} renderData.column Current rendering column
4438
4448
  * @param {Grid.column.Column} renderData.groupColumn Column that the grid is grouped by
4439
- * @param {number} renderData.count Number of records in the group
4449
+ * @param {number} renderData.count Number of records in the group, excluding the group footer record
4440
4450
  * @param {Grid.view.Grid} renderData.grid This grid
4441
4451
  * @returns {DomConfig,string,void} The header grouping text or DomConfig object representing the HTML markup
4442
4452
  */
@@ -5376,7 +5386,7 @@ export class Column extends Model {
5376
5386
  * behaviour can be configured by setting [resizeToFitIncludesHeader](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#config-resizeToFitIncludesHeader).
5377
5387
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/column/Column#function-resizeToFitContent)
5378
5388
  * @param {number,number[]} widthMin Minimum allowed width. If content width is less than this, this width is used instead. If this parameter is an array, the first element is `widthMin` and the seconds is `widthMax`.
5379
- * @param {number} widthMax Maximum allowed width. If the content width is greater than this number, this width is used instead.
5389
+ * @param {number} widthMax Maximum allowed width. If the content width is greater than this number, this width is used instead, unless the column's own [minWidth](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-minWidth) is larger.
5380
5390
  */
5381
5391
  resizeToFitContent(widthMin: number|number[], widthMax: number): Promise<void>;
5382
5392
  /**
@@ -5713,10 +5723,10 @@ type CurrencyColumnConfig = {
5713
5723
  * @param {HTMLElement} renderData.cellElement Cell element, for adding CSS classes, styling etc.
5714
5724
  * @param {any} renderData.groupRowFor Current group value
5715
5725
  * @param {Core.data.Model} renderData.record Record for the row
5716
- * @param {Core.data.Model[]} renderData.groupRecords Records in the group
5726
+ * @param {Core.data.Model[]} renderData.groupRecords Records in the group. When the [GroupSummary](https://bryntum.com/products/grid/docs/api/Grid/feature/GroupSummary) feature is enabled with its default [target](https://bryntum.com/products/grid/docs/api/Grid/feature/GroupSummary#config-target) of `'footer'`, the last entry is the group footer record, so `groupRecords.length` is one more than `count`. Filter it out using its [isGroupFooter](https://bryntum.com/products/grid/docs/api/Core/data/Model#property-isGroupFooter) flag if needed
5717
5727
  * @param {Grid.column.Column} renderData.column Current rendering column
5718
5728
  * @param {Grid.column.Column} renderData.groupColumn Column that the grid is grouped by
5719
- * @param {number} renderData.count Number of records in the group
5729
+ * @param {number} renderData.count Number of records in the group, excluding the group footer record
5720
5730
  * @param {Grid.view.Grid} renderData.grid This grid
5721
5731
  * @returns {DomConfig,string,void} The header grouping text or DomConfig object representing the HTML markup
5722
5732
  */
@@ -6427,10 +6437,10 @@ type DateColumnConfig = {
6427
6437
  * @param {HTMLElement} renderData.cellElement Cell element, for adding CSS classes, styling etc.
6428
6438
  * @param {any} renderData.groupRowFor Current group value
6429
6439
  * @param {Core.data.Model} renderData.record Record for the row
6430
- * @param {Core.data.Model[]} renderData.groupRecords Records in the group
6440
+ * @param {Core.data.Model[]} renderData.groupRecords Records in the group. When the [GroupSummary](https://bryntum.com/products/grid/docs/api/Grid/feature/GroupSummary) feature is enabled with its default [target](https://bryntum.com/products/grid/docs/api/Grid/feature/GroupSummary#config-target) of `'footer'`, the last entry is the group footer record, so `groupRecords.length` is one more than `count`. Filter it out using its [isGroupFooter](https://bryntum.com/products/grid/docs/api/Core/data/Model#property-isGroupFooter) flag if needed
6431
6441
  * @param {Grid.column.Column} renderData.column Current rendering column
6432
6442
  * @param {Grid.column.Column} renderData.groupColumn Column that the grid is grouped by
6433
- * @param {number} renderData.count Number of records in the group
6443
+ * @param {number} renderData.count Number of records in the group, excluding the group footer record
6434
6444
  * @param {Grid.view.Grid} renderData.grid This grid
6435
6445
  * @returns {DomConfig,string,void} The header grouping text or DomConfig object representing the HTML markup
6436
6446
  */
@@ -7151,10 +7161,10 @@ type NumberColumnConfig = {
7151
7161
  * @param {HTMLElement} renderData.cellElement Cell element, for adding CSS classes, styling etc.
7152
7162
  * @param {any} renderData.groupRowFor Current group value
7153
7163
  * @param {Core.data.Model} renderData.record Record for the row
7154
- * @param {Core.data.Model[]} renderData.groupRecords Records in the group
7164
+ * @param {Core.data.Model[]} renderData.groupRecords Records in the group. When the [GroupSummary](https://bryntum.com/products/grid/docs/api/Grid/feature/GroupSummary) feature is enabled with its default [target](https://bryntum.com/products/grid/docs/api/Grid/feature/GroupSummary#config-target) of `'footer'`, the last entry is the group footer record, so `groupRecords.length` is one more than `count`. Filter it out using its [isGroupFooter](https://bryntum.com/products/grid/docs/api/Core/data/Model#property-isGroupFooter) flag if needed
7155
7165
  * @param {Grid.column.Column} renderData.column Current rendering column
7156
7166
  * @param {Grid.column.Column} renderData.groupColumn Column that the grid is grouped by
7157
- * @param {number} renderData.count Number of records in the group
7167
+ * @param {number} renderData.count Number of records in the group, excluding the group footer record
7158
7168
  * @param {Grid.view.Grid} renderData.grid This grid
7159
7169
  * @returns {DomConfig,string,void} The header grouping text or DomConfig object representing the HTML markup
7160
7170
  */
@@ -7891,10 +7901,10 @@ type PercentColumnConfig = {
7891
7901
  * @param {HTMLElement} renderData.cellElement Cell element, for adding CSS classes, styling etc.
7892
7902
  * @param {any} renderData.groupRowFor Current group value
7893
7903
  * @param {Core.data.Model} renderData.record Record for the row
7894
- * @param {Core.data.Model[]} renderData.groupRecords Records in the group
7904
+ * @param {Core.data.Model[]} renderData.groupRecords Records in the group. When the [GroupSummary](https://bryntum.com/products/grid/docs/api/Grid/feature/GroupSummary) feature is enabled with its default [target](https://bryntum.com/products/grid/docs/api/Grid/feature/GroupSummary#config-target) of `'footer'`, the last entry is the group footer record, so `groupRecords.length` is one more than `count`. Filter it out using its [isGroupFooter](https://bryntum.com/products/grid/docs/api/Core/data/Model#property-isGroupFooter) flag if needed
7895
7905
  * @param {Grid.column.Column} renderData.column Current rendering column
7896
7906
  * @param {Grid.column.Column} renderData.groupColumn Column that the grid is grouped by
7897
- * @param {number} renderData.count Number of records in the group
7907
+ * @param {number} renderData.count Number of records in the group, excluding the group footer record
7898
7908
  * @param {Grid.view.Grid} renderData.grid This grid
7899
7909
  * @returns {DomConfig,string,void} The header grouping text or DomConfig object representing the HTML markup
7900
7910
  */
@@ -8629,10 +8639,10 @@ type RatingColumnConfig = {
8629
8639
  * @param {HTMLElement} renderData.cellElement Cell element, for adding CSS classes, styling etc.
8630
8640
  * @param {any} renderData.groupRowFor Current group value
8631
8641
  * @param {Core.data.Model} renderData.record Record for the row
8632
- * @param {Core.data.Model[]} renderData.groupRecords Records in the group
8642
+ * @param {Core.data.Model[]} renderData.groupRecords Records in the group. When the [GroupSummary](https://bryntum.com/products/grid/docs/api/Grid/feature/GroupSummary) feature is enabled with its default [target](https://bryntum.com/products/grid/docs/api/Grid/feature/GroupSummary#config-target) of `'footer'`, the last entry is the group footer record, so `groupRecords.length` is one more than `count`. Filter it out using its [isGroupFooter](https://bryntum.com/products/grid/docs/api/Core/data/Model#property-isGroupFooter) flag if needed
8633
8643
  * @param {Grid.column.Column} renderData.column Current rendering column
8634
8644
  * @param {Grid.column.Column} renderData.groupColumn Column that the grid is grouped by
8635
- * @param {number} renderData.count Number of records in the group
8645
+ * @param {number} renderData.count Number of records in the group, excluding the group footer record
8636
8646
  * @param {Grid.view.Grid} renderData.grid This grid
8637
8647
  * @returns {DomConfig,string,void} The header grouping text or DomConfig object representing the HTML markup
8638
8648
  */
@@ -9279,10 +9289,10 @@ type RowNumberColumnConfig = {
9279
9289
  * @param {HTMLElement} renderData.cellElement Cell element, for adding CSS classes, styling etc.
9280
9290
  * @param {any} renderData.groupRowFor Current group value
9281
9291
  * @param {Core.data.Model} renderData.record Record for the row
9282
- * @param {Core.data.Model[]} renderData.groupRecords Records in the group
9292
+ * @param {Core.data.Model[]} renderData.groupRecords Records in the group. When the [GroupSummary](https://bryntum.com/products/grid/docs/api/Grid/feature/GroupSummary) feature is enabled with its default [target](https://bryntum.com/products/grid/docs/api/Grid/feature/GroupSummary#config-target) of `'footer'`, the last entry is the group footer record, so `groupRecords.length` is one more than `count`. Filter it out using its [isGroupFooter](https://bryntum.com/products/grid/docs/api/Core/data/Model#property-isGroupFooter) flag if needed
9283
9293
  * @param {Grid.column.Column} renderData.column Current rendering column
9284
9294
  * @param {Grid.column.Column} renderData.groupColumn Column that the grid is grouped by
9285
- * @param {number} renderData.count Number of records in the group
9295
+ * @param {number} renderData.count Number of records in the group, excluding the group footer record
9286
9296
  * @param {Grid.view.Grid} renderData.grid This grid
9287
9297
  * @returns {DomConfig,string,void} The header grouping text or DomConfig object representing the HTML markup
9288
9298
  */
@@ -9909,10 +9919,10 @@ type SparklineColumnConfig = {
9909
9919
  * @param {HTMLElement} renderData.cellElement Cell element, for adding CSS classes, styling etc.
9910
9920
  * @param {any} renderData.groupRowFor Current group value
9911
9921
  * @param {Core.data.Model} renderData.record Record for the row
9912
- * @param {Core.data.Model[]} renderData.groupRecords Records in the group
9922
+ * @param {Core.data.Model[]} renderData.groupRecords Records in the group. When the [GroupSummary](https://bryntum.com/products/grid/docs/api/Grid/feature/GroupSummary) feature is enabled with its default [target](https://bryntum.com/products/grid/docs/api/Grid/feature/GroupSummary#config-target) of `'footer'`, the last entry is the group footer record, so `groupRecords.length` is one more than `count`. Filter it out using its [isGroupFooter](https://bryntum.com/products/grid/docs/api/Core/data/Model#property-isGroupFooter) flag if needed
9913
9923
  * @param {Grid.column.Column} renderData.column Current rendering column
9914
9924
  * @param {Grid.column.Column} renderData.groupColumn Column that the grid is grouped by
9915
- * @param {number} renderData.count Number of records in the group
9925
+ * @param {number} renderData.count Number of records in the group, excluding the group footer record
9916
9926
  * @param {Grid.view.Grid} renderData.grid This grid
9917
9927
  * @returns {DomConfig,string,void} The header grouping text or DomConfig object representing the HTML markup
9918
9928
  */
@@ -10595,10 +10605,10 @@ type TemplateColumnConfig = {
10595
10605
  * @param {HTMLElement} renderData.cellElement Cell element, for adding CSS classes, styling etc.
10596
10606
  * @param {any} renderData.groupRowFor Current group value
10597
10607
  * @param {Core.data.Model} renderData.record Record for the row
10598
- * @param {Core.data.Model[]} renderData.groupRecords Records in the group
10608
+ * @param {Core.data.Model[]} renderData.groupRecords Records in the group. When the [GroupSummary](https://bryntum.com/products/grid/docs/api/Grid/feature/GroupSummary) feature is enabled with its default [target](https://bryntum.com/products/grid/docs/api/Grid/feature/GroupSummary#config-target) of `'footer'`, the last entry is the group footer record, so `groupRecords.length` is one more than `count`. Filter it out using its [isGroupFooter](https://bryntum.com/products/grid/docs/api/Core/data/Model#property-isGroupFooter) flag if needed
10599
10609
  * @param {Grid.column.Column} renderData.column Current rendering column
10600
10610
  * @param {Grid.column.Column} renderData.groupColumn Column that the grid is grouped by
10601
- * @param {number} renderData.count Number of records in the group
10611
+ * @param {number} renderData.count Number of records in the group, excluding the group footer record
10602
10612
  * @param {Grid.view.Grid} renderData.grid This grid
10603
10613
  * @returns {DomConfig,string,void} The header grouping text or DomConfig object representing the HTML markup
10604
10614
  */
@@ -11286,10 +11296,10 @@ type TimeColumnConfig = {
11286
11296
  * @param {HTMLElement} renderData.cellElement Cell element, for adding CSS classes, styling etc.
11287
11297
  * @param {any} renderData.groupRowFor Current group value
11288
11298
  * @param {Core.data.Model} renderData.record Record for the row
11289
- * @param {Core.data.Model[]} renderData.groupRecords Records in the group
11299
+ * @param {Core.data.Model[]} renderData.groupRecords Records in the group. When the [GroupSummary](https://bryntum.com/products/grid/docs/api/Grid/feature/GroupSummary) feature is enabled with its default [target](https://bryntum.com/products/grid/docs/api/Grid/feature/GroupSummary#config-target) of `'footer'`, the last entry is the group footer record, so `groupRecords.length` is one more than `count`. Filter it out using its [isGroupFooter](https://bryntum.com/products/grid/docs/api/Core/data/Model#property-isGroupFooter) flag if needed
11290
11300
  * @param {Grid.column.Column} renderData.column Current rendering column
11291
11301
  * @param {Grid.column.Column} renderData.groupColumn Column that the grid is grouped by
11292
- * @param {number} renderData.count Number of records in the group
11302
+ * @param {number} renderData.count Number of records in the group, excluding the group footer record
11293
11303
  * @param {Grid.view.Grid} renderData.grid This grid
11294
11304
  * @returns {DomConfig,string,void} The header grouping text or DomConfig object representing the HTML markup
11295
11305
  */
@@ -11980,10 +11990,10 @@ type TreeColumnConfig = {
11980
11990
  * @param {HTMLElement} renderData.cellElement Cell element, for adding CSS classes, styling etc.
11981
11991
  * @param {any} renderData.groupRowFor Current group value
11982
11992
  * @param {Core.data.Model} renderData.record Record for the row
11983
- * @param {Core.data.Model[]} renderData.groupRecords Records in the group
11993
+ * @param {Core.data.Model[]} renderData.groupRecords Records in the group. When the [GroupSummary](https://bryntum.com/products/grid/docs/api/Grid/feature/GroupSummary) feature is enabled with its default [target](https://bryntum.com/products/grid/docs/api/Grid/feature/GroupSummary#config-target) of `'footer'`, the last entry is the group footer record, so `groupRecords.length` is one more than `count`. Filter it out using its [isGroupFooter](https://bryntum.com/products/grid/docs/api/Core/data/Model#property-isGroupFooter) flag if needed
11984
11994
  * @param {Grid.column.Column} renderData.column Current rendering column
11985
11995
  * @param {Grid.column.Column} renderData.groupColumn Column that the grid is grouped by
11986
- * @param {number} renderData.count Number of records in the group
11996
+ * @param {number} renderData.count Number of records in the group, excluding the group footer record
11987
11997
  * @param {Grid.view.Grid} renderData.grid This grid
11988
11998
  * @returns {DomConfig,string,void} The header grouping text or DomConfig object representing the HTML markup
11989
11999
  */
@@ -12700,10 +12710,10 @@ type WidgetColumnConfig = {
12700
12710
  * @param {HTMLElement} renderData.cellElement Cell element, for adding CSS classes, styling etc.
12701
12711
  * @param {any} renderData.groupRowFor Current group value
12702
12712
  * @param {Core.data.Model} renderData.record Record for the row
12703
- * @param {Core.data.Model[]} renderData.groupRecords Records in the group
12713
+ * @param {Core.data.Model[]} renderData.groupRecords Records in the group. When the [GroupSummary](https://bryntum.com/products/grid/docs/api/Grid/feature/GroupSummary) feature is enabled with its default [target](https://bryntum.com/products/grid/docs/api/Grid/feature/GroupSummary#config-target) of `'footer'`, the last entry is the group footer record, so `groupRecords.length` is one more than `count`. Filter it out using its [isGroupFooter](https://bryntum.com/products/grid/docs/api/Core/data/Model#property-isGroupFooter) flag if needed
12704
12714
  * @param {Grid.column.Column} renderData.column Current rendering column
12705
12715
  * @param {Grid.column.Column} renderData.groupColumn Column that the grid is grouped by
12706
- * @param {number} renderData.count Number of records in the group
12716
+ * @param {number} renderData.count Number of records in the group, excluding the group footer record
12707
12717
  * @param {Grid.view.Grid} renderData.grid This grid
12708
12718
  * @returns {DomConfig,string,void} The header grouping text or DomConfig object representing the HTML markup
12709
12719
  */
@@ -16537,6 +16547,12 @@ type CellTooltipConfig = {
16537
16547
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellTooltip#config-namedItems)
16538
16548
  */
16539
16549
  namedItems?: Record<string, GridContainerItemConfig>
16550
+ /**
16551
+ * Customizes the config object used to create this widget's clone in a [Toolbar](https://bryntum.com/products/grid/docs/api/Core/widget/Toolbar)'s
16552
+ * overflow menu (see [overflow](https://bryntum.com/products/grid/docs/api/Core/widget/Toolbar#config-overflow)).
16553
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellTooltip#config-overflowTwinConfig)
16554
+ */
16555
+ overflowTwinConfig?: OverflowTwinConfig|null
16540
16556
  /**
16541
16557
  * The owning Widget of this Widget. If this Widget is directly contained (that is, it is one of the
16542
16558
  * [items](https://bryntum.com/products/grid/docs/api/Core/widget/Container#property-items) of a Container), this config will be ignored. In this case
@@ -16664,7 +16680,7 @@ type CellTooltipConfig = {
16664
16680
  * (if explicitly specified) will be used as the `stateId`.
16665
16681
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellTooltip#config-stateId)
16666
16682
  */
16667
- stateId?: string
16683
+ stateId?: string|null
16668
16684
  /**
16669
16685
  * The `StateProvider` to use to save and restore this object's [state](https://bryntum.com/products/grid/docs/api/Core/mixin/State#property-state). By default, `state`
16670
16686
  * will be saved using the [default state provider](https://bryntum.com/products/grid/docs/api/Core/state/StateProvider#property-instance-static).
@@ -17233,6 +17249,7 @@ type ColumnAutoWidthConfig = {
17233
17249
  * The default `autoWidth` option for columns with `autoWidth: true`. This can
17234
17250
  * be a single number for the minimum column width, or an array of two numbers
17235
17251
  * for the `[minWidth, maxWidth]`.
17252
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnAutoWidth#config-default)
17236
17253
  */
17237
17254
  default?: number|number[]
17238
17255
  /**
@@ -18376,6 +18393,12 @@ type ColumnResizeConfig = {
18376
18393
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnResize#config-localizableProperties)
18377
18394
  */
18378
18395
  localizableProperties?: string[]
18396
+ /**
18397
+ * The [Popup](https://bryntum.com/products/grid/docs/api/Core/widget/Popup) shown by the "Resize column" header menu item, allowing the column width to be
18398
+ * set from the keyboard. Created lazily on first use and destroyed automatically with the feature.
18399
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnResize#config-resizeDialog)
18400
+ */
18401
+ resizeDialog?: PopupConfig
18379
18402
  /**
18380
18403
  * Fires before an object is destroyed.
18381
18404
  * @param {object} event Event object
@@ -18425,6 +18448,11 @@ export class ColumnResize extends InstancePlugin {
18425
18448
  * Identifies an object as an instance of [ColumnResize](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnResize) class, or subclass thereof.
18426
18449
  */
18427
18450
  readonly isColumnResize: boolean
18451
+ /**
18452
+ * The [Popup](https://bryntum.com/products/grid/docs/api/Core/widget/Popup) shown by the "Resize column" header menu item, allowing the column width to be
18453
+ * set from the keyboard. Created lazily on first use and destroyed automatically with the feature.
18454
+ */
18455
+ resizeDialog: PopupConfig|Popup
18428
18456
  /**
18429
18457
  * Fires before an object is destroyed.
18430
18458
  * @param {object} event Event object
@@ -18450,6 +18478,12 @@ export class ColumnResize extends InstancePlugin {
18450
18478
  * @param {PdfExportConfig} [config]
18451
18479
  */
18452
18480
  constructor(config?: ColumnResizeConfig);
18481
+ /**
18482
+ * Shows the [resize dialog](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnResize#config-resizeDialog) for the passed column, allowing its width to be set from
18483
+ * the keyboard.
18484
+ * @param {Grid.column.Column} column The column to resize
18485
+ */
18486
+ showResizeDialog(column: Column): Popup;
18453
18487
  }
18454
18488
 
18455
18489
  /**
@@ -19493,7 +19527,8 @@ type GroupConfig = {
19493
19527
  * @param {object} context Renderer context data
19494
19528
  * @param {any} context.groupRowFor The value of the `field` for the group. Type depends on `field` used for grouping
19495
19529
  * @param {Core.data.Model} context.record The group record representing the group
19496
- * @param {number} context.count Number of records in the group
19530
+ * @param {Core.data.Model[]} context.groupRecords Records in the group. When the [GroupSummary](https://bryntum.com/products/grid/docs/api/Grid/feature/GroupSummary) feature is enabled with its default [target](https://bryntum.com/products/grid/docs/api/Grid/feature/GroupSummary#config-target) of `'footer'`, the last entry may be the group footer record, making `groupRecords.length` one more than `count`. Filter it out using its [isGroupFooter](https://bryntum.com/products/grid/docs/api/Core/data/Model#property-isGroupFooter) flag if needed
19531
+ * @param {number} context.count Number of records in the group, excluding the group footer record
19497
19532
  * @param {Grid.column.Column} context.column The column the renderer runs for
19498
19533
  * @param {boolean} context.isFirstColumn True, if `column` is the first column. If `RowNumberColumn` is the real first column, it's not taken into account
19499
19534
  * @param {Grid.column.Column} context.groupColumn The column under which the `field` is shown
@@ -19503,7 +19538,7 @@ type GroupConfig = {
19503
19538
  * @param {HTMLElement} context.rowElement The owning row element
19504
19539
  * @returns {DomConfig,string,void}
19505
19540
  */
19506
- renderer?: (context: { groupRowFor: any, record: Model, count: number, column: Column, isFirstColumn: boolean, groupColumn: Column, size: { height: number }, grid: Grid, rowElement: HTMLElement }) => DomConfig|string|void
19541
+ renderer?: (context: { groupRowFor: any, record: Model, groupRecords: Model[], count: number, column: Column, isFirstColumn: boolean, groupColumn: Column, size: { height: number }, grid: Grid, rowElement: HTMLElement }) => DomConfig|string|void
19507
19542
  /**
19508
19543
  * Set to `true` to show the number of members of each group in the group header. Not applicable when using
19509
19544
  * Scheduler in vertical mode.
@@ -22437,6 +22472,7 @@ type RowReorderConfig = {
22437
22472
  /**
22438
22473
  * Set to `true` to preserve sorters after a drop operation, if that operation leads to the store still being
22439
22474
  * sorted.
22475
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowReorder#config-preserveSorters)
22440
22476
  */
22441
22477
  preserveSorters?: boolean
22442
22478
  /**
@@ -24706,9 +24742,9 @@ export class TreeGroup extends InstancePlugin {
24706
24742
  /**
24707
24743
  * Transforms the data according to the supplied levels.
24708
24744
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/TreeGroup#function-group)
24709
- * @param {(string|Grid.column.Column|Function)[]} levels Field names or functions use to generate parents in resulting tree
24710
- * @param {Core.data.Model} levels.record record
24711
- * @param {string} levels.returns Value to determine a parent
24745
+ * @param {(string|Grid.column.Column|Function)[]} levels Field names or functions use to generate parents in resulting tree. When a function is supplied it receives the leaf record and returns the grouping key.
24746
+ * @param {Core.data.Model} levels.record The leaf record. Stores that wrap originals (such as Scheduler Pro's `ResourceUtilizationStore`) attach the underlying record on the wrapper's `origin` field, so callbacks can destructure with `({ origin }) =&gt; ...`.
24747
+ * @param {string} levels.returns Value to determine a parent. Return a primitive grouping key (typically a `String`), another `Model` to group under, or the [StopBranch](https://bryntum.com/products/grid/docs/api/Core/data/Store#property-StopBranch-static) sentinel to stop further grouping for that branch.
24712
24748
  */
24713
24749
  group(levels: (string|Column|((record: Model) => string))[]): Promise<void>;
24714
24750
  }
@@ -25608,6 +25644,11 @@ type ExcelExporterConfig = {
25608
25644
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/ExcelExporter#config-convertEmptyValueToEmptyString)
25609
25645
  */
25610
25646
  convertEmptyValueToEmptyString?: boolean
25647
+ /**
25648
+ * MIME type used when creating the CSV Blob for download. Some environments (e.g. Salesforce Lightning Web
25649
+ * Security) block `text/csv` for `URL.createObjectURL`. Use `application/octet-stream` there instead.
25650
+ */
25651
+ csvMimeType?: string
25611
25652
  /**
25612
25653
  * Defines how dates in a cell will be formatted
25613
25654
  */
@@ -25663,6 +25704,12 @@ type ExcelExporterConfig = {
25663
25704
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/ExcelExporter#config-xlsProvider)
25664
25705
  */
25665
25706
  xlsProvider?: typeof XlsProviderBase
25707
+ /**
25708
+ * MIME type used when creating the XLSX download Blob. Some environments (e.g. Salesforce Lightning Web
25709
+ * Security) block the default XLSX MIME type for `URL.createObjectURL`. Use `application/octet-stream` in such case
25710
+ * instead.
25711
+ */
25712
+ xlsxMimeType?: string
25666
25713
  /**
25667
25714
  * Fires before an object is destroyed.
25668
25715
  * @param {object} event Event object
@@ -25745,10 +25792,12 @@ export class ExcelExporter extends InstancePlugin {
25745
25792
  * @param {boolean,object} [config.csv] Set to `true` to output as a CSV file, or as an object where you can specify delimiters.
25746
25793
  * @param {string} [config.csv.columnDelimiter] The CSV delimiter to separate values on one line, defaults to `,`.
25747
25794
  * @param {string} [config.csv.lineDelimiter] The CSV delimiter to separate lines, defaults to `\n`.
25795
+ * @param {string} [config.csvMimeType] MIME type used when creating the CSV Blob. Overrides [csvMimeType](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/ExcelExporter#config-csvMimeType).
25796
+ * @param {string} [config.xlsxMimeType] MIME type used when creating the XLSX download Blob. Overrides [xlsxMimeType](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/ExcelExporter#config-xlsxMimeType).
25748
25797
  * @param {string[],object[]} [config.columns] An array of column configuration objects
25749
25798
  * @param {Core.data.Model[]} [config.rows] An array of records to export
25750
25799
  */
25751
- export(config: { filename?: string, dateFormat?: string, csv?: boolean|{ columnDelimiter?: string, lineDelimiter?: string }, columns?: string[]|object[], rows?: Model[] }): Promise<any>;
25800
+ export(config: { filename?: string, dateFormat?: string, csv?: boolean|{ columnDelimiter?: string, lineDelimiter?: string }, csvMimeType?: string, xlsxMimeType?: string, columns?: string[]|object[], rows?: Model[] }): Promise<any>;
25752
25801
  }
25753
25802
 
25754
25803
  /**
@@ -25972,9 +26021,10 @@ export class WriteExcelFileProvider {
25972
26021
  * @param {object} config.sheet *deprecated, to be removed in 7.0* Object with columns and data
25973
26022
  * @param {any[][]} config.sheet.data Array of rows, each row is an array of cells
25974
26023
  * @param {XLSColumn[]} config.sheet.cols Array of columns
25975
- * @param {string} config.MIME File MIME type
26024
+ * @param {string} config.mimeType MIME type used when creating the download Blob, passed from [xlsxMimeType](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/ExcelExporter#config-xlsxMimeType).
26025
+ * @param {string} [config.MIME] *deprecated, use `mimeType` instead*
25976
26026
  */
25977
- static write(config: { filename: string, rows: any[], columns: XLSColumn[], sheet: { data: any[], cols: XLSColumn[] }, MIME: string }): void;
26027
+ static write(config: { filename: string, rows: any[], columns: XLSColumn[], sheet: { data: any[], cols: XLSColumn[] }, mimeType: string, MIME?: string }): Promise<any>;
25978
26028
  }
25979
26029
 
25980
26030
  /**
@@ -25983,17 +26033,18 @@ export class WriteExcelFileProvider {
25983
26033
  */
25984
26034
  export class XlsProviderBase {
25985
26035
  /**
25986
- * Implement this method to write data to an xls file
26036
+ * Implement this method to write data to an xls file. May return a Promise if the
26037
+ * implementation needs to perform asynchronous work (e.g. awaiting a 3rd-party library).
26038
+ * [ExcelExporter](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/ExcelExporter) awaits the return value, so both sync
26039
+ * and async implementations are supported.
25987
26040
  * @param {object} config
25988
26041
  * @param {string} config.filename Name of the exported file
25989
26042
  * @param {any[][]} config.rows Array of rows, each row is an array of cells
25990
26043
  * @param {XLSColumn[]} config.columns Array of columns
25991
- * @param {object} config.sheet *deprecated, to be removed in 7.0* Object with columns and data
25992
- * @param {any[][]} config.sheet.data Array of rows, each row is an array of cells
25993
- * @param {XLSColumn[]} config.sheet.cols Array of columns
25994
- * @param {string} config.MIME File MIME type
26044
+ * @param {string} config.mimeType MIME type to use when creating the download Blob. Configured via [xlsxMimeType](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/ExcelExporter#config-xlsxMimeType).
26045
+ * @param {string} [config.MIME] *deprecated, use `mimeType` instead*
25995
26046
  */
25996
- static write(config: { filename: string, rows: any[], columns: XLSColumn[], sheet: { data: any[], cols: XLSColumn[] }, MIME: string }): void;
26047
+ static write(config: { filename: string, rows: any[], columns: XLSColumn[], mimeType: string, MIME?: string }): Promise<void|any>;
25997
26048
  }
25998
26049
 
25999
26050
  /**
@@ -26365,6 +26416,10 @@ export class PdfExport extends InstancePlugin {
26365
26416
  * rows with an additional buffer.
26366
26417
  */
26367
26418
  rowReadyCondition: () => void
26419
+ /**
26420
+ * Set to `true` to receive binary file from the server instead of download link.
26421
+ */
26422
+ sendAsBinary: boolean
26368
26423
  /**
26369
26424
  * Determines whether to stream exported pages directly to the export server using WebSocket connection to
26370
26425
  * offload client application.
@@ -30972,6 +31027,12 @@ type GridConfig = {
30972
31027
  * Grid monitors window resize by default.
30973
31028
  */
30974
31029
  monitorResize?: boolean
31030
+ /**
31031
+ * Customizes the config object used to create this widget's clone in a [Toolbar](https://bryntum.com/products/grid/docs/api/Core/widget/Toolbar)'s
31032
+ * overflow menu (see [overflow](https://bryntum.com/products/grid/docs/api/Core/widget/Toolbar#config-overflow)).
31033
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#config-overflowTwinConfig)
31034
+ */
31035
+ overflowTwinConfig?: OverflowTwinConfig|null
30975
31036
  /**
30976
31037
  * The owning Widget of this Widget. If this Widget is directly contained (that is, it is one of the
30977
31038
  * [items](https://bryntum.com/products/grid/docs/api/Core/widget/Container#property-items) of a Container), this config will be ignored. In this case
@@ -31123,7 +31184,7 @@ type GridConfig = {
31123
31184
  * (if explicitly specified) will be used as the `stateId`.
31124
31185
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#config-stateId)
31125
31186
  */
31126
- stateId?: string
31187
+ stateId?: string|null
31127
31188
  /**
31128
31189
  * The `StateProvider` to use to save and restore this object's [state](https://bryntum.com/products/grid/docs/api/Core/mixin/State#property-state). By default, `state`
31129
31190
  * will be saved using the [default state provider](https://bryntum.com/products/grid/docs/api/Core/state/StateProvider#property-instance-static).
@@ -35033,6 +35094,12 @@ type GridBaseConfig = {
35033
35094
  * Grid monitors window resize by default.
35034
35095
  */
35035
35096
  monitorResize?: boolean
35097
+ /**
35098
+ * Customizes the config object used to create this widget's clone in a [Toolbar](https://bryntum.com/products/grid/docs/api/Core/widget/Toolbar)'s
35099
+ * overflow menu (see [overflow](https://bryntum.com/products/grid/docs/api/Core/widget/Toolbar#config-overflow)).
35100
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-overflowTwinConfig)
35101
+ */
35102
+ overflowTwinConfig?: OverflowTwinConfig|null
35036
35103
  /**
35037
35104
  * The owning Widget of this Widget. If this Widget is directly contained (that is, it is one of the
35038
35105
  * [items](https://bryntum.com/products/grid/docs/api/Core/widget/Container#property-items) of a Container), this config will be ignored. In this case
@@ -35184,7 +35251,7 @@ type GridBaseConfig = {
35184
35251
  * (if explicitly specified) will be used as the `stateId`.
35185
35252
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-stateId)
35186
35253
  */
35187
- stateId?: string
35254
+ stateId?: string|null
35188
35255
  /**
35189
35256
  * The `StateProvider` to use to save and restore this object's [state](https://bryntum.com/products/grid/docs/api/Core/mixin/State#property-state). By default, `state`
35190
35257
  * will be saved using the [default state provider](https://bryntum.com/products/grid/docs/api/Core/state/StateProvider#property-instance-static).
@@ -36612,6 +36679,12 @@ export class GridBase extends Panel {
36612
36679
  * Gets or sets grid's state. Check out [GridState](https://bryntum.com/products/grid/docs/api/Grid/view/mixin/GridState) mixin for details.
36613
36680
  */
36614
36681
  state: GridStateInfo
36682
+ /**
36683
+ * The key to use when saving this object's state in the [stateProvider](https://bryntum.com/products/grid/docs/api/Core/mixin/State#config-stateProvider). If this config is
36684
+ * not assigned, and [stateful](https://bryntum.com/products/grid/docs/api/Core/mixin/State#config-stateful) is not set to `false`, the [id](#Core/widget/Widget#config-id)
36685
+ * (if explicitly specified) will be used as the `stateId`.
36686
+ */
36687
+ stateId: string|null
36615
36688
  /**
36616
36689
  * The properties of this settings object controls how grid is restored from state data.
36617
36690
  */
@@ -37732,9 +37805,9 @@ export class GridBase extends Panel {
37732
37805
  /**
37733
37806
  * Transforms the data according to the supplied levels.
37734
37807
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#function-group)
37735
- * @param {(string|Grid.column.Column|Function)[]} levels Field names or functions use to generate parents in resulting tree
37736
- * @param {Core.data.Model} levels.record record
37737
- * @param {string} levels.returns Value to determine a parent
37808
+ * @param {(string|Grid.column.Column|Function)[]} levels Field names or functions use to generate parents in resulting tree. When a function is supplied it receives the leaf record and returns the grouping key.
37809
+ * @param {Core.data.Model} levels.record The leaf record. Stores that wrap originals (such as Scheduler Pro's `ResourceUtilizationStore`) attach the underlying record on the wrapper's `origin` field, so callbacks can destructure with `({ origin }) =&gt; ...`.
37810
+ * @param {string} levels.returns Value to determine a parent. Return a primitive grouping key (typically a `String`), another `Model` to group under, or the [StopBranch](https://bryntum.com/products/grid/docs/api/Core/data/Store#property-StopBranch-static) sentinel to stop further grouping for that branch.
37738
37811
  */
37739
37812
  group(levels: (string|Column|((record: Model) => string))[]): Promise<void>;
37740
37813
  /**
@@ -37877,6 +37950,11 @@ export class GridBase extends Panel {
37877
37950
  * Rerenders all grid rows, completely replacing all row elements with new ones
37878
37951
  */
37879
37952
  renderRows(): void;
37953
+ /**
37954
+ * Resets this object's [state](https://bryntum.com/products/grid/docs/api/Core/mixin/State#property-state) to the default state captured when the object was created,
37955
+ * undoing any state changes applied since then.
37956
+ */
37957
+ resetDefaultState(): void;
37880
37958
  /**
37881
37959
  * Restore scroll state. If state is not specified, restores the last stored state.
37882
37960
  * @param {object} [state] Scroll state, optional
@@ -38588,6 +38666,12 @@ type SubGridConfig = {
38588
38666
  * @property {boolean} immediate Set to `true` to receive resize notifications immediately.
38589
38667
  */
38590
38668
  monitorResize?: boolean|object
38669
+ /**
38670
+ * Customizes the config object used to create this widget's clone in a [Toolbar](https://bryntum.com/products/grid/docs/api/Core/widget/Toolbar)'s
38671
+ * overflow menu (see [overflow](https://bryntum.com/products/grid/docs/api/Core/widget/Toolbar#config-overflow)).
38672
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/SubGrid#config-overflowTwinConfig)
38673
+ */
38674
+ overflowTwinConfig?: OverflowTwinConfig|null
38591
38675
  /**
38592
38676
  * The owning Widget of this Widget. If this Widget is directly contained (that is, it is one of the
38593
38677
  * [items](https://bryntum.com/products/grid/docs/api/Core/widget/Container#property-items) of a Container), this config will be ignored. In this case
@@ -41512,6 +41596,12 @@ type TreeGridConfig = {
41512
41596
  * Grid monitors window resize by default.
41513
41597
  */
41514
41598
  monitorResize?: boolean
41599
+ /**
41600
+ * Customizes the config object used to create this widget's clone in a [Toolbar](https://bryntum.com/products/grid/docs/api/Core/widget/Toolbar)'s
41601
+ * overflow menu (see [overflow](https://bryntum.com/products/grid/docs/api/Core/widget/Toolbar#config-overflow)).
41602
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-overflowTwinConfig)
41603
+ */
41604
+ overflowTwinConfig?: OverflowTwinConfig|null
41515
41605
  /**
41516
41606
  * The owning Widget of this Widget. If this Widget is directly contained (that is, it is one of the
41517
41607
  * [items](https://bryntum.com/products/grid/docs/api/Core/widget/Container#property-items) of a Container), this config will be ignored. In this case
@@ -41663,7 +41753,7 @@ type TreeGridConfig = {
41663
41753
  * (if explicitly specified) will be used as the `stateId`.
41664
41754
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-stateId)
41665
41755
  */
41666
- stateId?: string
41756
+ stateId?: string|null
41667
41757
  /**
41668
41758
  * The `StateProvider` to use to save and restore this object's [state](https://bryntum.com/products/grid/docs/api/Core/mixin/State#property-state). By default, `state`
41669
41759
  * will be saved using the [default state provider](https://bryntum.com/products/grid/docs/api/Core/state/StateProvider#property-instance-static).
@@ -43871,6 +43961,12 @@ type ExportDialogConfig = {
43871
43961
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/export/ExportDialog#config-namedItems)
43872
43962
  */
43873
43963
  namedItems?: Record<string, GridContainerItemConfig>
43964
+ /**
43965
+ * Customizes the config object used to create this widget's clone in a [Toolbar](https://bryntum.com/products/grid/docs/api/Core/widget/Toolbar)'s
43966
+ * overflow menu (see [overflow](https://bryntum.com/products/grid/docs/api/Core/widget/Toolbar#config-overflow)).
43967
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/export/ExportDialog#config-overflowTwinConfig)
43968
+ */
43969
+ overflowTwinConfig?: OverflowTwinConfig|null
43874
43970
  /**
43875
43971
  * The owning Widget of this Widget. If this Widget is directly contained (that is, it is one of the
43876
43972
  * [items](https://bryntum.com/products/grid/docs/api/Core/widget/Container#property-items) of a Container), this config will be ignored. In this case
@@ -43995,7 +44091,7 @@ type ExportDialogConfig = {
43995
44091
  * (if explicitly specified) will be used as the `stateId`.
43996
44092
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/export/ExportDialog#config-stateId)
43997
44093
  */
43998
- stateId?: string
44094
+ stateId?: string|null
43999
44095
  /**
44000
44096
  * The `StateProvider` to use to save and restore this object's [state](https://bryntum.com/products/grid/docs/api/Core/mixin/State#property-state). By default, `state`
44001
44097
  * will be saved using the [default state provider](https://bryntum.com/products/grid/docs/api/Core/state/StateProvider#property-instance-static).
@@ -45489,6 +45585,7 @@ type AIFilterFieldConfig = {
45489
45585
  * Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
45490
45586
  * in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
45491
45587
  * configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
45588
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-clearable)
45492
45589
  */
45493
45590
  clearable?: boolean|FieldTriggerConfig
45494
45591
  /**
@@ -45828,6 +45925,12 @@ type AIFilterFieldConfig = {
45828
45925
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-name)
45829
45926
  */
45830
45927
  name?: string
45928
+ /**
45929
+ * Customizes the config object used to create this widget's clone in a [Toolbar](https://bryntum.com/products/grid/docs/api/Core/widget/Toolbar)'s
45930
+ * overflow menu (see [overflow](https://bryntum.com/products/grid/docs/api/Core/widget/Toolbar#config-overflow)).
45931
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-overflowTwinConfig)
45932
+ */
45933
+ overflowTwinConfig?: OverflowTwinConfig|null
45831
45934
  /**
45832
45935
  * The owning Widget of this Widget. If this Widget is directly contained (that is, it is one of the
45833
45936
  * [items](https://bryntum.com/products/grid/docs/api/Core/widget/Container#property-items) of a Container), this config will be ignored. In this case
@@ -46673,6 +46776,7 @@ type ChecklistFilterComboConfig = {
46673
46776
  * Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
46674
46777
  * in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
46675
46778
  * configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
46779
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-clearable)
46676
46780
  */
46677
46781
  clearable?: boolean|FieldTriggerConfig
46678
46782
  /**
@@ -47117,6 +47221,12 @@ type ChecklistFilterComboConfig = {
47117
47221
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-name)
47118
47222
  */
47119
47223
  name?: string
47224
+ /**
47225
+ * Customizes the config object used to create this widget's clone in a [Toolbar](https://bryntum.com/products/grid/docs/api/Core/widget/Toolbar)'s
47226
+ * overflow menu (see [overflow](https://bryntum.com/products/grid/docs/api/Core/widget/Toolbar#config-overflow)).
47227
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-overflowTwinConfig)
47228
+ */
47229
+ overflowTwinConfig?: OverflowTwinConfig|null
47120
47230
  /**
47121
47231
  * This implies that the picker will display an anchor pointer, but also means that the picker will align closer
47122
47232
  * to the input field so that the pointer pierces the [pickerAlignElement](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-pickerAlignElement)
@@ -48094,6 +48204,12 @@ type GridChartDesignerConfig = {
48094
48204
  * @property {boolean} immediate Set to `true` to receive resize notifications immediately.
48095
48205
  */
48096
48206
  monitorResize?: boolean|object
48207
+ /**
48208
+ * Customizes the config object used to create this widget's clone in a [Toolbar](https://bryntum.com/products/grid/docs/api/Core/widget/Toolbar)'s
48209
+ * overflow menu (see [overflow](https://bryntum.com/products/grid/docs/api/Core/widget/Toolbar#config-overflow)).
48210
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridChartDesigner#config-overflowTwinConfig)
48211
+ */
48212
+ overflowTwinConfig?: OverflowTwinConfig|null
48097
48213
  /**
48098
48214
  * The owning Widget of this Widget. If this Widget is directly contained (that is, it is one of the
48099
48215
  * [items](https://bryntum.com/products/grid/docs/api/Core/widget/Container#property-items) of a Container), this config will be ignored. In this case
@@ -49074,6 +49190,12 @@ type GridFieldFilterPickerConfig = {
49074
49190
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-operators)
49075
49191
  */
49076
49192
  operators?: object
49193
+ /**
49194
+ * Customizes the config object used to create this widget's clone in a [Toolbar](https://bryntum.com/products/grid/docs/api/Core/widget/Toolbar)'s
49195
+ * overflow menu (see [overflow](https://bryntum.com/products/grid/docs/api/Core/widget/Toolbar#config-overflow)).
49196
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-overflowTwinConfig)
49197
+ */
49198
+ overflowTwinConfig?: OverflowTwinConfig|null
49077
49199
  /**
49078
49200
  * The owning Widget of this Widget. If this Widget is directly contained (that is, it is one of the
49079
49201
  * [items](https://bryntum.com/products/grid/docs/api/Core/widget/Container#property-items) of a Container), this config will be ignored. In this case
@@ -50154,6 +50276,12 @@ type GridFieldFilterPickerGroupConfig = {
50154
50276
  * [operators](https://bryntum.com/products/grid/docs/api/Core/widget/FieldFilterPicker#config-operators).
50155
50277
  */
50156
50278
  operators?: object
50279
+ /**
50280
+ * Customizes the config object used to create this widget's clone in a [Toolbar](https://bryntum.com/products/grid/docs/api/Core/widget/Toolbar)'s
50281
+ * overflow menu (see [overflow](https://bryntum.com/products/grid/docs/api/Core/widget/Toolbar#config-overflow)).
50282
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-overflowTwinConfig)
50283
+ */
50284
+ overflowTwinConfig?: OverflowTwinConfig|null
50157
50285
  /**
50158
50286
  * The owning Widget of this Widget. If this Widget is directly contained (that is, it is one of the
50159
50287
  * [items](https://bryntum.com/products/grid/docs/api/Core/widget/Container#property-items) of a Container), this config will be ignored. In this case
@@ -51207,6 +51335,12 @@ type GroupBarConfig = {
51207
51335
  * Configure as `true` to allow multi select and allow clicking and key navigation to select multiple chips.
51208
51336
  */
51209
51337
  multiSelect?: boolean
51338
+ /**
51339
+ * Customizes the config object used to create this widget's clone in a [Toolbar](https://bryntum.com/products/grid/docs/api/Core/widget/Toolbar)'s
51340
+ * overflow menu (see [overflow](https://bryntum.com/products/grid/docs/api/Core/widget/Toolbar#config-overflow)).
51341
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-overflowTwinConfig)
51342
+ */
51343
+ overflowTwinConfig?: OverflowTwinConfig|null
51210
51344
  /**
51211
51345
  * The owning Widget of this Widget. If this Widget is directly contained (that is, it is one of the
51212
51346
  * [items](https://bryntum.com/products/grid/docs/api/Core/widget/Container#property-items) of a Container), this config will be ignored. In this case
@@ -52027,6 +52161,7 @@ type TreeComboConfig = {
52027
52161
  * Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
52028
52162
  * in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
52029
52163
  * configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
52164
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-clearable)
52030
52165
  */
52031
52166
  clearable?: boolean|FieldTriggerConfig
52032
52167
  /**
@@ -52470,6 +52605,12 @@ type TreeComboConfig = {
52470
52605
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-name)
52471
52606
  */
52472
52607
  name?: string
52608
+ /**
52609
+ * Customizes the config object used to create this widget's clone in a [Toolbar](https://bryntum.com/products/grid/docs/api/Core/widget/Toolbar)'s
52610
+ * overflow menu (see [overflow](https://bryntum.com/products/grid/docs/api/Core/widget/Toolbar#config-overflow)).
52611
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-overflowTwinConfig)
52612
+ */
52613
+ overflowTwinConfig?: OverflowTwinConfig|null
52473
52614
  /**
52474
52615
  * This implies that the picker will display an anchor pointer, but also means that the picker will align closer
52475
52616
  * to the input field so that the pointer pierces the [pickerAlignElement](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-pickerAlignElement)