@bryntum/grid-thin-trial 7.1.2 → 7.2.0

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 (137) hide show
  1. package/README.md +6 -1
  2. package/entry.js +4 -0
  3. package/grid.css +5 -0
  4. package/grid.css.map +2 -2
  5. package/grid.d.ts +941 -250
  6. package/lib/column/CheckColumn.js +1 -1
  7. package/lib/column/Column.js +1 -1
  8. package/lib/column/DateColumn.js +1 -1
  9. package/lib/column/NumberColumn.js +1 -1
  10. package/lib/column/TreeColumn.js +1 -1
  11. package/lib/column/mixin/TreeColumnMixin.js +1 -0
  12. package/lib/data/ColumnStore.js +1 -1
  13. package/lib/feature/AI.js +1 -0
  14. package/lib/feature/CellCopyPaste.js +1 -1
  15. package/lib/feature/CellEdit.js +1 -1
  16. package/lib/feature/CellMenu.js +1 -1
  17. package/lib/feature/Charts.js +1 -1
  18. package/lib/feature/ColumnPicker.js +1 -1
  19. package/lib/feature/FillHandle.js +1 -1
  20. package/lib/feature/Filter.js +1 -1
  21. package/lib/feature/FilterBar.js +1 -1
  22. package/lib/feature/Group.js +1 -1
  23. package/lib/feature/GroupSummary.js +1 -1
  24. package/lib/feature/HeaderMenu.js +1 -1
  25. package/lib/feature/LockRows.js +1 -1
  26. package/lib/feature/MergeCells.js +1 -1
  27. package/lib/feature/PinColumns.js +1 -1
  28. package/lib/feature/QuickFind.js +1 -1
  29. package/lib/feature/RegionResize.js +1 -1
  30. package/lib/feature/RowCopyPaste.js +1 -1
  31. package/lib/feature/RowExpander.css +9 -0
  32. package/lib/feature/RowExpander.js +1 -1
  33. package/lib/feature/RowReorder.js +1 -1
  34. package/lib/feature/Search.js +1 -1
  35. package/lib/feature/Sort.js +1 -1
  36. package/lib/feature/Split.js +1 -1
  37. package/lib/feature/Stripe.js +1 -1
  38. package/lib/feature/Summary.js +1 -1
  39. package/lib/feature/Tree.js +1 -1
  40. package/lib/feature/TreeGroup.js +1 -1
  41. package/lib/feature/ai/AIFilter.js +1 -1
  42. package/lib/feature/ai/agents/DefaultGridAgent.js +3 -3
  43. package/lib/feature/base/GridEditBase.js +1 -1
  44. package/lib/localization/Ar.js +2 -1
  45. package/lib/localization/Bg.js +2 -1
  46. package/lib/localization/Ca.js +2 -1
  47. package/lib/localization/Cs.js +2 -1
  48. package/lib/localization/Da.js +2 -1
  49. package/lib/localization/De.js +2 -1
  50. package/lib/localization/El.js +2 -1
  51. package/lib/localization/En.js +2 -1
  52. package/lib/localization/EnGb.js +2 -1
  53. package/lib/localization/Es.js +2 -1
  54. package/lib/localization/Et.js +2 -1
  55. package/lib/localization/Eu.js +2 -1
  56. package/lib/localization/Fi.js +2 -1
  57. package/lib/localization/FrFr.js +2 -1
  58. package/lib/localization/Gl.js +2 -1
  59. package/lib/localization/He.js +2 -1
  60. package/lib/localization/Hi.js +2 -1
  61. package/lib/localization/Hr.js +2 -1
  62. package/lib/localization/Hu.js +2 -1
  63. package/lib/localization/Id.js +2 -1
  64. package/lib/localization/It.js +2 -1
  65. package/lib/localization/Ja.js +2 -1
  66. package/lib/localization/Kk.js +2 -1
  67. package/lib/localization/Ko.js +2 -1
  68. package/lib/localization/Lt.js +2 -1
  69. package/lib/localization/Lv.js +2 -1
  70. package/lib/localization/Ms.js +2 -1
  71. package/lib/localization/Nl.js +2 -1
  72. package/lib/localization/No.js +2 -1
  73. package/lib/localization/Pl.js +2 -1
  74. package/lib/localization/Pt.js +2 -1
  75. package/lib/localization/PtBr.js +2 -1
  76. package/lib/localization/Ro.js +2 -1
  77. package/lib/localization/Ru.js +2 -1
  78. package/lib/localization/Sk.js +2 -1
  79. package/lib/localization/Sl.js +2 -1
  80. package/lib/localization/Sr.js +2 -1
  81. package/lib/localization/SrRs.js +2 -1
  82. package/lib/localization/SvSE.js +2 -1
  83. package/lib/localization/Th.js +2 -1
  84. package/lib/localization/Tr.js +2 -1
  85. package/lib/localization/Uk.js +2 -1
  86. package/lib/localization/Vi.js +2 -1
  87. package/lib/localization/ZhCn.js +2 -1
  88. package/lib/localization/ZhTw.js +2 -1
  89. package/lib/row/RowManager.js +1 -1
  90. package/lib/view/GridBase.js +1 -1
  91. package/lib/view/SubGrid.js +1 -1
  92. package/locales/grid.locale.Ar.js +1 -1
  93. package/locales/grid.locale.Bg.js +1 -1
  94. package/locales/grid.locale.Ca.js +1 -1
  95. package/locales/grid.locale.Cs.js +1 -1
  96. package/locales/grid.locale.Da.js +1 -1
  97. package/locales/grid.locale.De.js +1 -1
  98. package/locales/grid.locale.El.js +1 -1
  99. package/locales/grid.locale.En.js +1 -1
  100. package/locales/grid.locale.EnGb.js +1 -1
  101. package/locales/grid.locale.Es.js +1 -1
  102. package/locales/grid.locale.Et.js +1 -1
  103. package/locales/grid.locale.Eu.js +1 -1
  104. package/locales/grid.locale.Fi.js +1 -1
  105. package/locales/grid.locale.FrFr.js +1 -1
  106. package/locales/grid.locale.Gl.js +1 -1
  107. package/locales/grid.locale.He.js +1 -1
  108. package/locales/grid.locale.Hi.js +1 -1
  109. package/locales/grid.locale.Hr.js +1 -1
  110. package/locales/grid.locale.Hu.js +1 -1
  111. package/locales/grid.locale.Id.js +1 -1
  112. package/locales/grid.locale.It.js +1 -1
  113. package/locales/grid.locale.Ja.js +1 -1
  114. package/locales/grid.locale.Kk.js +1 -1
  115. package/locales/grid.locale.Ko.js +1 -1
  116. package/locales/grid.locale.Lt.js +1 -1
  117. package/locales/grid.locale.Lv.js +1 -1
  118. package/locales/grid.locale.Ms.js +1 -1
  119. package/locales/grid.locale.Nl.js +1 -1
  120. package/locales/grid.locale.No.js +1 -1
  121. package/locales/grid.locale.Pl.js +1 -1
  122. package/locales/grid.locale.Pt.js +1 -1
  123. package/locales/grid.locale.PtBr.js +1 -1
  124. package/locales/grid.locale.Ro.js +1 -1
  125. package/locales/grid.locale.Ru.js +1 -1
  126. package/locales/grid.locale.Sk.js +1 -1
  127. package/locales/grid.locale.Sl.js +1 -1
  128. package/locales/grid.locale.Sr.js +1 -1
  129. package/locales/grid.locale.SrRs.js +1 -1
  130. package/locales/grid.locale.SvSE.js +1 -1
  131. package/locales/grid.locale.Th.js +1 -1
  132. package/locales/grid.locale.Tr.js +1 -1
  133. package/locales/grid.locale.Uk.js +1 -1
  134. package/locales/grid.locale.Vi.js +1 -1
  135. package/locales/grid.locale.ZhCn.js +1 -1
  136. package/locales/grid.locale.ZhTw.js +1 -1
  137. package/package.json +1 -1
package/grid.d.ts CHANGED
@@ -1,12 +1,13 @@
1
- import { AIBase, AIModelConfiguration, AbstractApiPlugin, AjaxStore, AjaxStoreConfig, AlignSpec, AnimateScrollOptions, Base,
2
- BryntumListenerConfig, BryntumScrollOptions, ChipView, ChipViewConfig, Collection, CollectionCompareOperator, CollectionConfig,
3
- CollectionFilter, CollectionFilterConfig, CollectionSorter, CollectionSorterConfig, ColorDescriptor, Combo, ComboConfig, ComboModel,
4
- Container, ContextMenuBase, CoreColumn, CoreColumnConfig, CoreContainerItem, CoreContainerItemConfig, CoreContainerLayoutConfig,
5
- CoreInputFieldConfig, CoreModelFieldConfig, DataField, DataLoadRequestResponse, DomClassList, DomConfig, DragHelper, DragHelperConfig,
6
- Duration, DurationConfig, Editor, EditorConfig, EventsClass, FetchOptions, Field, FieldContainer, FieldContainerConfig,
7
- FieldFilterPicker, FieldFilterPickerConfig, FieldFilterPickerGroup, FieldOption, FieldTriggerConfig, FormulaProvider,
8
- FormulaProviderConfig, Grouper, InstancePlugin, KeyMap, KeyMapConfig, LazyLoadRequestParams, List, ListConfig, LocaleHelper,
9
- LocaleManager, Mask, MaskConfig, Menu, MenuConfig, MenuItem, MenuItemEntry, Model, NumberFormat, NumberFormatConfig,
1
+ import { AIBase, AIModelConfiguration, AIModelSelector, AISettingsModel, AISettingsModelConfig, AITool, AIToolConfig,
2
+ AIVoiceActivationConfig, AbstractApiPlugin, AjaxStore, AjaxStoreConfig, AlignSpec, AnimateScrollOptions, Base, BryntumListenerConfig,
3
+ BryntumScrollOptions, ChatButton, ChatButtonConfig, ChipView, ChipViewConfig, Collection, CollectionCompareOperator, CollectionConfig,
4
+ CollectionFilter, CollectionFilterConfig, CollectionSorter, CollectionSorterConfig, Color, ColorDescriptor, Combo, ComboConfig,
5
+ ComboModel, Container, ContextMenuBase, CoreColumn, CoreColumnConfig, CoreContainerItem, CoreContainerItemConfig,
6
+ CoreContainerLayoutConfig, CoreInputFieldConfig, CoreModelFieldConfig, DataField, DataLoadRequestResponse, DomClassList, DomConfig,
7
+ DragHelper, DragHelperConfig, Duration, DurationConfig, Editor, EditorConfig, EventsClass, FetchOptions, Field, FieldContainer,
8
+ FieldContainerConfig, FieldFilterPicker, FieldFilterPickerConfig, FieldFilterPickerGroup, FieldOption, FieldTriggerConfig,
9
+ FormulaProvider, FormulaProviderConfig, Grouper, InstancePlugin, KeyMap, KeyMapConfig, LazyLoadRequestParams, List, ListConfig,
10
+ LocaleHelper, LocaleManager, Mask, MaskConfig, Menu, MenuConfig, MenuItem, MenuItemEntry, Model, NumberFormat, NumberFormatConfig,
10
11
  PagingRequestParams, PagingToolbar, PagingToolbarConfig, Panel, PanelCollapser, PanelCollapserConfig, PanelCollapserOverlay,
11
12
  PanelCollapserOverlayConfig, PanelConfig, PanelHeader, Popup, PopupConfig, Rectangle, ScrollManager, ScrollManagerConfig, Scroller,
12
13
  ScrollerConfig, Sorter, StateProvider, StateTrackingManager, Store, StoreConfig, StoreSearchResult, SyncDataOnLoadOptions, Tab,
@@ -6892,8 +6893,8 @@ type DateColumnConfig = {
6892
6893
  */
6893
6894
  remoteChildCount?: number
6894
6895
  /**
6895
- * Renderer function, used to style the date displayed in the cell. Can also affect other aspects of
6896
- * the cell, such as styling.
6896
+ * Renderer function, used to style the date displayed in the cell. Can also affect other aspects of the cell,
6897
+ * such as styling.
6897
6898
  * ...
6898
6899
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/DateColumn#config-renderer)
6899
6900
  * @param {object} renderData Object containing renderer parameters
@@ -7054,9 +7055,9 @@ type DateColumnConfig = {
7054
7055
  }
7055
7056
 
7056
7057
  /**
7057
- * A column that displays a date in the specified [format](https://bryntum.com/products/grid/docs/api/Grid/column/DateColumn#config-format). By default `L` format is used, which
7058
- * contains the following info: full year, 2-digit month, and 2-digit day. Depending on the browser locale,
7059
- * the formatted date might look different. [Intl.DateTimeFormat API](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat)
7058
+ * A column that displays a date in the specified [format](https://bryntum.com/products/grid/docs/api/Grid/column/DateColumn#config-format). By default `L` format is used, which contains
7059
+ * the following info: full year, 2-digit month, and 2-digit day. Depending on the browser locale, the formatted date
7060
+ * might look different. [Intl.DateTimeFormat API](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat)
7060
7061
  * is used to format the date. Here is an example of possible outputs depending on the browser locale:
7061
7062
  * ...
7062
7063
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/DateColumn)
@@ -7090,8 +7091,8 @@ export class DateColumn extends Column {
7090
7091
  */
7091
7092
  min: string|Date
7092
7093
  /**
7093
- * Renderer function, used to style the date displayed in the cell. Can also affect other aspects of
7094
- * the cell, such as styling.
7094
+ * Renderer function, used to style the date displayed in the cell. Can also affect other aspects of the cell,
7095
+ * such as styling.
7095
7096
  */
7096
7097
  renderer: (renderData: { cellElement: HTMLElement, value: Date|null|undefined, record: Model, column: Column, grid: Grid, row: Row, size: { height: number, configuredHeight: number }, isExport: boolean, isMeasuring: boolean }) => string|DomConfig|DomConfig[]|void
7097
7098
  /**
@@ -12896,6 +12897,10 @@ export class TreeColumn extends Column {
12896
12897
  * Identifies an object as an instance of [TreeColumn](https://bryntum.com/products/grid/docs/api/Grid/column/TreeColumn) class, or subclass thereof.
12897
12898
  */
12898
12899
  static readonly isTreeColumn: boolean
12900
+ /**
12901
+ * Identifies an object as an instance of [TreeColumnMixin](https://bryntum.com/products/grid/docs/api/Grid/column/mixin/TreeColumnMixin) class, or subclass thereof.
12902
+ */
12903
+ static readonly isTreeColumnMixin: boolean
12899
12904
  /**
12900
12905
  * The icon to use for the expand / collapse button in expanded state
12901
12906
  */
@@ -12920,6 +12925,10 @@ export class TreeColumn extends Column {
12920
12925
  * Identifies an object as an instance of [TreeColumn](https://bryntum.com/products/grid/docs/api/Grid/column/TreeColumn) class, or subclass thereof.
12921
12926
  */
12922
12927
  readonly isTreeColumn: boolean
12928
+ /**
12929
+ * Identifies an object as an instance of [TreeColumnMixin](https://bryntum.com/products/grid/docs/api/Grid/column/mixin/TreeColumnMixin) class, or subclass thereof.
12930
+ */
12931
+ readonly isTreeColumnMixin: boolean
12923
12932
  /**
12924
12933
  * The icon to use for the leaf nodes in the tree
12925
12934
  */
@@ -13712,6 +13721,88 @@ export class WidgetColumn extends Column {
13712
13721
  }): void;
13713
13722
  }
13714
13723
 
13724
+ /**
13725
+ * Type with configuration options for [TreeColumnMixin](https://bryntum.com/products/grid/docs/api/Grid/column/mixin/TreeColumnMixin) class.
13726
+ */
13727
+ type TreeColumnMixinClassConfig = {
13728
+ /**
13729
+ * The icon to use for the expand / collapse button in expanded state
13730
+ */
13731
+ collapseIconCls?: string|null
13732
+ /**
13733
+ * The icon to use for a parent node in collapsed state
13734
+ */
13735
+ collapsedFolderIconCls?: string|null
13736
+ /**
13737
+ * The icon to use for the expand / collapse button icon in collapsed state
13738
+ */
13739
+ expandIconCls?: string|null
13740
+ /**
13741
+ * The icon to use for a parent node in expanded state
13742
+ */
13743
+ expandedFolderIconCls?: string|null
13744
+ /**
13745
+ * Size of the child indent in em. Resulting indent is indentSize multiplied by child level.
13746
+ * ...
13747
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/mixin/TreeColumnMixin#config-indentSize)
13748
+ */
13749
+ indentSize?: number
13750
+ /**
13751
+ * The icon to use for the leaf nodes in the tree
13752
+ */
13753
+ leafIconCls?: string|null
13754
+ }
13755
+
13756
+ export class TreeColumnMixinClass {
13757
+ /**
13758
+ * Identifies this column as a tree column
13759
+ */
13760
+ static readonly isTreeColumn: boolean
13761
+ /**
13762
+ * Identifies an object as an instance of [TreeColumnMixin](https://bryntum.com/products/grid/docs/api/Grid/column/mixin/TreeColumnMixin) class, or subclass thereof.
13763
+ */
13764
+ static readonly isTreeColumnMixin: boolean
13765
+ /**
13766
+ * The icon to use for the expand / collapse button in expanded state
13767
+ */
13768
+ collapseIconCls: string|null
13769
+ /**
13770
+ * The icon to use for a parent node in collapsed state
13771
+ */
13772
+ collapsedFolderIconCls: string|null
13773
+ /**
13774
+ * The icon to use for the expand / collapse button icon in collapsed state
13775
+ */
13776
+ expandIconCls: string|null
13777
+ /**
13778
+ * The icon to use for a parent node in expanded state
13779
+ */
13780
+ expandedFolderIconCls: string|null
13781
+ /**
13782
+ * Size of the child indent in em. Resulting indent is indentSize multiplied by child level.
13783
+ */
13784
+ indentSize: number
13785
+ /**
13786
+ * Identifies this column as a tree column
13787
+ */
13788
+ readonly isTreeColumn: boolean
13789
+ /**
13790
+ * Identifies an object as an instance of [TreeColumnMixin](https://bryntum.com/products/grid/docs/api/Grid/column/mixin/TreeColumnMixin) class, or subclass thereof.
13791
+ */
13792
+ readonly isTreeColumnMixin: boolean
13793
+ /**
13794
+ * The icon to use for the leaf nodes in the tree
13795
+ */
13796
+ leafIconCls: string|null
13797
+ /**
13798
+ * Creates an instance of the class using the supplied configuration
13799
+ * @param {TreeColumnMixinClassConfig} config
13800
+ */
13801
+ constructor(config?: TreeColumnMixinClassConfig);
13802
+ }
13803
+
13804
+ export const TreeColumnMixin : <T extends AnyConstructor<Base>>(base : T) => AnyConstructor<InstanceType<T> & TreeColumnMixinClass>
13805
+
13715
13806
  /**
13716
13807
  * Type with available listeners functions for [ColumnStore](https://bryntum.com/products/grid/docs/api/Grid/data/ColumnStore) class.
13717
13808
  * Could be used for callbacks typings in TypeScript application.
@@ -15166,6 +15257,339 @@ export class GridRowModel extends Model {
15166
15257
  target: '_self'|'_blank'|'_parent'|'_top'|null
15167
15258
  }
15168
15259
 
15260
+ /**
15261
+ * Type with available listeners functions for [AI](https://bryntum.com/products/grid/docs/api/Grid/feature/AI) class.
15262
+ * Could be used for callbacks typings in TypeScript application.
15263
+ */
15264
+ type AIListenersTypes = {
15265
+ /**
15266
+ * Fires before an object is destroyed.
15267
+ * @param {object} event Event object
15268
+ * @param {Core.Base} event.source The Object that is being destroyed.
15269
+ */
15270
+ beforeDestroy: (event: { source: Base }) => void
15271
+ /**
15272
+ * Fires when any other event is fired from the object.
15273
+ * ...
15274
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/AI#event-catchAll)
15275
+ * @param {object} event Event object
15276
+ * @param {{[key: string]: any, type: string}} event.event The Object that contains event details
15277
+ * @param {string} event.event.type The type of the event which is caught by the listener
15278
+ */
15279
+ catchAll: (event: {[key: string]: any, type: string}) => void
15280
+ /**
15281
+ * Fires when an object is destroyed.
15282
+ * @param {object} event Event object
15283
+ * @param {Core.Base} event.source The Object that is being destroyed.
15284
+ */
15285
+ destroy: (event: { source: Base }) => void
15286
+ /**
15287
+ * Fired when the plugin/feature is disabled.
15288
+ * @param {object} event Event object
15289
+ * @param {Core.mixin.InstancePlugin} event.source
15290
+ */
15291
+ disable: (event: { source: InstancePlugin }) => void
15292
+ /**
15293
+ * Fired when the plugin/feature is enabled.
15294
+ * @param {object} event Event object
15295
+ * @param {Core.mixin.InstancePlugin} event.source
15296
+ */
15297
+ enable: (event: { source: InstancePlugin }) => void
15298
+ /**
15299
+ * Fired when the user changes it's settings via the settings panel
15300
+ * @param {object} event Event object
15301
+ * @param {Core.data.AISettingsModel} event.userSettings The user settings record
15302
+ * @param {object} event.changes The changed properties and the new value
15303
+ */
15304
+ userSettingsUpdate: (event: { userSettings: AISettingsModel, changes: object }) => void
15305
+ }
15306
+
15307
+ /**
15308
+ * Type with listeners options for [AI](https://bryntum.com/products/grid/docs/api/Grid/feature/AI) class.
15309
+ */
15310
+ type AIListeners = {
15311
+ /**
15312
+ * The `this` object for listener methods
15313
+ */
15314
+ thisObj?: object
15315
+ /**
15316
+ * Fires before an object is destroyed.
15317
+ * @param {object} event Event object
15318
+ * @param {Core.Base} event.source The Object that is being destroyed.
15319
+ */
15320
+ beforeDestroy?: ((event: { source: Base }) => void)|string
15321
+ /**
15322
+ * Fires when any other event is fired from the object.
15323
+ * ...
15324
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/AI#event-catchAll)
15325
+ * @param {object} event Event object
15326
+ * @param {{[key: string]: any, type: string}} event.event The Object that contains event details
15327
+ * @param {string} event.event.type The type of the event which is caught by the listener
15328
+ */
15329
+ catchAll?: ((event: {[key: string]: any, type: string}) => void)|string
15330
+ /**
15331
+ * Fires when an object is destroyed.
15332
+ * @param {object} event Event object
15333
+ * @param {Core.Base} event.source The Object that is being destroyed.
15334
+ */
15335
+ destroy?: ((event: { source: Base }) => void)|string
15336
+ /**
15337
+ * Fired when the plugin/feature is disabled.
15338
+ * @param {object} event Event object
15339
+ * @param {Core.mixin.InstancePlugin} event.source
15340
+ */
15341
+ disable?: ((event: { source: InstancePlugin }) => void)|string
15342
+ /**
15343
+ * Fired when the plugin/feature is enabled.
15344
+ * @param {object} event Event object
15345
+ * @param {Core.mixin.InstancePlugin} event.source
15346
+ */
15347
+ enable?: ((event: { source: InstancePlugin }) => void)|string
15348
+ /**
15349
+ * Fired when the user changes it's settings via the settings panel
15350
+ * @param {object} event Event object
15351
+ * @param {Core.data.AISettingsModel} event.userSettings The user settings record
15352
+ * @param {object} event.changes The changed properties and the new value
15353
+ */
15354
+ userSettingsUpdate?: ((event: { userSettings: AISettingsModel, changes: object }) => void)|string
15355
+ }
15356
+
15357
+ /**
15358
+ * Type with configuration options for [AI](https://bryntum.com/products/grid/docs/api/Grid/feature/AI) class.
15359
+ */
15360
+ type AIConfig = {
15361
+ type?: 'ai'
15362
+ /**
15363
+ * AI plugin to use. Provide the class here. Available plugins are:
15364
+ * ...
15365
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/AI#config-apiPlugin)
15366
+ */
15367
+ apiPlugin?: typeof AbstractApiPlugin
15368
+ /**
15369
+ * Shows an AI model selector in the SettingsPanel where the user can select between the available API:s
15370
+ */
15371
+ availableApis?: AIModelSelector[]
15372
+ /**
15373
+ * Set this to `true` or a config object to add a [ChatButton](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatButton)
15374
+ */
15375
+ chatButton?: boolean|ChatButtonConfig
15376
+ /**
15377
+ * Set to `true` to automatically console.log things that happen internally. AI responses and audio processing
15378
+ * for example.
15379
+ */
15380
+ debugMode?: boolean
15381
+ /**
15382
+ * An array of strings which will be circulated as waiting status texts when awaiting long AI responses
15383
+ * Defaults to `['Waiting', 'Waiting ...', 'Still waiting', 'Still waiting ...']`
15384
+ */
15385
+ delayStatusTexts?: string[]
15386
+ /**
15387
+ * The plugin/feature `disabled` state.
15388
+ * ...
15389
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/AI#config-disabled)
15390
+ */
15391
+ disabled?: boolean|'inert'
15392
+ /**
15393
+ * The URL to send feedback (thumbs up/thumbs down) to
15394
+ */
15395
+ feedbackUrl?: string
15396
+ /**
15397
+ * Additional options to pass to fetch requests
15398
+ */
15399
+ fetchOptions?: object
15400
+ /**
15401
+ * By default, data item which are targeted in an AI action will be highlighted in the UI. Set this to `false`
15402
+ * to prevent this behavior.
15403
+ */
15404
+ highlightRelatedItems?: boolean
15405
+ /**
15406
+ * The listener set for this object.
15407
+ * ...
15408
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/AI#config-listeners)
15409
+ */
15410
+ listeners?: AIListeners
15411
+ /**
15412
+ * Set to `false` to not manage chat history on the client
15413
+ */
15414
+ manageChatHistory?: boolean
15415
+ /**
15416
+ * Max tokens setting (if applicable)
15417
+ */
15418
+ max_tokens?: number
15419
+ /**
15420
+ * AI model name (if applicable)
15421
+ */
15422
+ model?: string
15423
+ /**
15424
+ * Use this to provide more details of data models currently available for the AI agent to work with. Provide
15425
+ * an object with model class names as keys and configuration objects as values.
15426
+ * ...
15427
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/AI#config-models)
15428
+ */
15429
+ models?: Record<string, AIModelConfiguration>
15430
+ /**
15431
+ * The URL to send text prompts to
15432
+ */
15433
+ promptUrl?: string
15434
+ /**
15435
+ * Enables support for redoing data modifying actions performed by the AI. Shows a redo icon under the last
15436
+ * redoable message in the ChatPanel. Requires undo to be enabled.
15437
+ */
15438
+ redo?: boolean
15439
+ /**
15440
+ * Set to `true` to always prompt the user for confirmation before allowing the AI to add records
15441
+ */
15442
+ requireConfirmationOnAdds?: boolean
15443
+ /**
15444
+ * Set to `true` to always prompt the user for confirmation before allowing the AI to remove records
15445
+ */
15446
+ requireConfirmationOnRemovals?: boolean
15447
+ /**
15448
+ * Set to `true` to always prompt the user for confirmation before allowing the AI to update records
15449
+ */
15450
+ requireConfirmationOnUpdates?: boolean
15451
+ /**
15452
+ * Set to `true` to upon creation, send a test prompt to verify the connection to the AI backend. If the test
15453
+ * fails, a warning icon will be shown on the chat panel.
15454
+ */
15455
+ showNoConnectionIcon?: boolean
15456
+ /**
15457
+ * Temperature setting (if applicable). Overrides the default temperature set by the apiPlugin.
15458
+ */
15459
+ temperature?: number
15460
+ /**
15461
+ * The URL to send text for speech synthesizing
15462
+ */
15463
+ textToSpeechUrl?: string
15464
+ /**
15465
+ * A number of milliseconds a prompt is allowed to take before being aborted. Defaults to `60000` (1 minute).
15466
+ */
15467
+ timeout?: number
15468
+ /**
15469
+ * Use this to add custom tools to the AI model's tool list or to remove existing tools. Provide an object
15470
+ * with the tool names as keys and configuration objects as values. Please note that modifying existing tools is
15471
+ * not supported, only removing them.
15472
+ * ...
15473
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/AI#config-tools)
15474
+ */
15475
+ tools?: Record<string, AIToolConfig>
15476
+ /**
15477
+ * Use this to provide example prompt scenarios to "teach" the AI of more complex tasks. Must be configured as
15478
+ * an array containing arrays which contains the AI messages for the complete conversation.
15479
+ * ...
15480
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/AI#config-trainingData)
15481
+ */
15482
+ trainingData?: any[]
15483
+ /**
15484
+ * The URL to send audio for transcribing
15485
+ */
15486
+ transcribeUrl?: string
15487
+ /**
15488
+ * Enables support for undoing data modifying actions performed by the AI. Shows an undo icon under the last
15489
+ * undoable message in the ChatPanel.
15490
+ */
15491
+ undo?: boolean
15492
+ /**
15493
+ * A configuration object containing the user's preferred AI feature settings. If there is a matching AI feature
15494
+ * class config, the user setting will take precedence
15495
+ * JSON.
15496
+ */
15497
+ userSettings?: AISettingsModelConfig|AISettingsModel
15498
+ /**
15499
+ * Experimental configuration of the AI verbosity. Valid values are `"1"`, `"2"` and `"3"`, where `"1"` is
15500
+ * lowest.
15501
+ */
15502
+ verbosityLevel?: string
15503
+ /**
15504
+ * Configuration settings for voice activation
15505
+ */
15506
+ voiceActivation?: AIVoiceActivationConfig
15507
+ /**
15508
+ * Forces voice only mode, which hides the chat panel and only shows a record chat button.
15509
+ */
15510
+ voiceOnly?: boolean
15511
+ /**
15512
+ * Fires before an object is destroyed.
15513
+ * @param {object} event Event object
15514
+ * @param {Core.Base} event.source The Object that is being destroyed.
15515
+ */
15516
+ onBeforeDestroy?: ((event: { source: Base }) => void)|string
15517
+ /**
15518
+ * Fires when any other event is fired from the object.
15519
+ * ...
15520
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/AI#event-catchAll)
15521
+ * @param {object} event Event object
15522
+ * @param {{[key: string]: any, type: string}} event.event The Object that contains event details
15523
+ * @param {string} event.event.type The type of the event which is caught by the listener
15524
+ */
15525
+ onCatchAll?: ((event: {[key: string]: any, type: string}) => void)|string
15526
+ /**
15527
+ * Fires when an object is destroyed.
15528
+ * @param {object} event Event object
15529
+ * @param {Core.Base} event.source The Object that is being destroyed.
15530
+ */
15531
+ onDestroy?: ((event: { source: Base }) => void)|string
15532
+ /**
15533
+ * Fired when the plugin/feature is disabled.
15534
+ * @param {object} event Event object
15535
+ * @param {Core.mixin.InstancePlugin} event.source
15536
+ */
15537
+ onDisable?: ((event: { source: InstancePlugin }) => void)|string
15538
+ /**
15539
+ * Fired when the plugin/feature is enabled.
15540
+ * @param {object} event Event object
15541
+ * @param {Core.mixin.InstancePlugin} event.source
15542
+ */
15543
+ onEnable?: ((event: { source: InstancePlugin }) => void)|string
15544
+ /**
15545
+ * Fired when the user changes it's settings via the settings panel
15546
+ * @param {object} event Event object
15547
+ * @param {Core.data.AISettingsModel} event.userSettings The user settings record
15548
+ * @param {object} event.changes The changed properties and the new value
15549
+ */
15550
+ onUserSettingsUpdate?: ((event: { userSettings: AISettingsModel, changes: object }) => void)|string
15551
+ }
15552
+
15553
+ /**
15554
+ * This feature provides an AI agent for Grid. It provides a chat panel that allows the user to send messages to the
15555
+ * agent and see the responses. Which allows the user to use natural language to interact with the Grid in different
15556
+ * ways. For example, the user can ask the agent to filter the data, sort it, or select specific records. The agent can
15557
+ * also perform data manipulation operations such as adding, updating, deleting records.
15558
+ * ...
15559
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/AI)
15560
+ */
15561
+ export class AI extends AIBase {
15562
+ /**
15563
+ * Identifies an object as an instance of [AI](https://bryntum.com/products/grid/docs/api/Grid/feature/AI) class, or subclass thereof.
15564
+ */
15565
+ static readonly isAI: boolean
15566
+ /**
15567
+ * Identifies an object as an instance of [AI](https://bryntum.com/products/grid/docs/api/Grid/feature/AI) class, or subclass thereof.
15568
+ */
15569
+ readonly isAI: boolean
15570
+ /**
15571
+ * Fires before an object is destroyed.
15572
+ * @param {object} event Event object
15573
+ * @param {Core.Base} event.source The Object that is being destroyed.
15574
+ */
15575
+ onBeforeDestroy: ((event: { source: Base }) => void)|string
15576
+ /**
15577
+ * Fires when any other event is fired from the object.
15578
+ * ...
15579
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/AI#event-catchAll)
15580
+ * @param {object} event Event object
15581
+ * @param {{[key: string]: any, type: string}} event.event The Object that contains event details
15582
+ * @param {string} event.event.type The type of the event which is caught by the listener
15583
+ */
15584
+ onCatchAll: ((event: {[key: string]: any, type: string}) => void)|string
15585
+ /**
15586
+ * Fires when an object is destroyed.
15587
+ * @param {object} event Event object
15588
+ * @param {Core.Base} event.source The Object that is being destroyed.
15589
+ */
15590
+ onDestroy: ((event: { source: Base }) => void)|string
15591
+ }
15592
+
15169
15593
  /**
15170
15594
  * Type with available listeners functions for [CellCopyPaste](https://bryntum.com/products/grid/docs/api/Grid/feature/CellCopyPaste) class.
15171
15595
  * Could be used for callbacks typings in TypeScript application.
@@ -16269,6 +16693,10 @@ type CellTooltipConfig = {
16269
16693
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellTooltip#config-bodyCls)
16270
16694
  */
16271
16695
  bodyCls?: string|object
16696
+ /**
16697
+ * Set `true` to add a border to this container's element.
16698
+ */
16699
+ border?: boolean
16272
16700
  /**
16273
16701
  * An object where property names with a truthy value indicate which events should bubble up the ownership
16274
16702
  * hierarchy when triggered.
@@ -16341,7 +16769,7 @@ type CellTooltipConfig = {
16341
16769
  * ...
16342
16770
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellTooltip#config-color)
16343
16771
  */
16344
- color?: string
16772
+ color?: Color
16345
16773
  /**
16346
16774
  * Programmatic control over which column to start in when used in a grid layout.
16347
16775
  */
@@ -25375,6 +25803,13 @@ type AIFilterListenersTypes = {
25375
25803
  * @param {Core.mixin.InstancePlugin} event.source
25376
25804
  */
25377
25805
  enable: (event: { source: InstancePlugin }) => void
25806
+ /**
25807
+ * Fired when the user changes it's settings via the settings panel
25808
+ * @param {object} event Event object
25809
+ * @param {Core.data.AISettingsModel} event.userSettings The user settings record
25810
+ * @param {object} event.changes The changed properties and the new value
25811
+ */
25812
+ userSettingsUpdate: (event: { userSettings: AISettingsModel, changes: object }) => void
25378
25813
  }
25379
25814
 
25380
25815
  /**
@@ -25418,6 +25853,13 @@ type AIFilterListeners = {
25418
25853
  * @param {Core.mixin.InstancePlugin} event.source
25419
25854
  */
25420
25855
  enable?: ((event: { source: InstancePlugin }) => void)|string
25856
+ /**
25857
+ * Fired when the user changes it's settings via the settings panel
25858
+ * @param {object} event Event object
25859
+ * @param {Core.data.AISettingsModel} event.userSettings The user settings record
25860
+ * @param {object} event.changes The changed properties and the new value
25861
+ */
25862
+ userSettingsUpdate?: ((event: { userSettings: AISettingsModel, changes: object }) => void)|string
25421
25863
  }
25422
25864
 
25423
25865
  /**
@@ -25431,11 +25873,20 @@ type AIFilterConfig = {
25431
25873
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/ai/AIFilter#config-apiPlugin)
25432
25874
  */
25433
25875
  apiPlugin?: typeof AbstractApiPlugin
25876
+ /**
25877
+ * Shows an AI model selector in the SettingsPanel where the user can select between the available API:s
25878
+ */
25879
+ availableApis?: AIModelSelector[]
25434
25880
  /**
25435
25881
  * Set to `true` to automatically console.log things that happen internally. AI responses and audio processing
25436
25882
  * for example.
25437
25883
  */
25438
25884
  debugMode?: boolean
25885
+ /**
25886
+ * An array of strings which will be circulated as waiting status texts when awaiting long AI responses
25887
+ * Defaults to `['Waiting', 'Waiting ...', 'Still waiting', 'Still waiting ...']`
25888
+ */
25889
+ delayStatusTexts?: string[]
25439
25890
  /**
25440
25891
  * The plugin/feature `disabled` state.
25441
25892
  * ...
@@ -25446,6 +25897,11 @@ type AIFilterConfig = {
25446
25897
  * Additional options to pass to fetch requests
25447
25898
  */
25448
25899
  fetchOptions?: object
25900
+ /**
25901
+ * By default, data item which are targeted in an AI action will be highlighted in the UI. Set this to `false`
25902
+ * to prevent this behavior.
25903
+ */
25904
+ highlightRelatedItems?: boolean
25449
25905
  /**
25450
25906
  * The listener set for this object.
25451
25907
  * ...
@@ -25472,13 +25928,51 @@ type AIFilterConfig = {
25472
25928
  */
25473
25929
  promptUrl?: string
25474
25930
  /**
25475
- * Temperature setting (if applicable)
25931
+ * Set to `true` to always prompt the user for confirmation before allowing the AI to add records
25932
+ */
25933
+ requireConfirmationOnAdds?: boolean
25934
+ /**
25935
+ * Set to `true` to always prompt the user for confirmation before allowing the AI to remove records
25936
+ */
25937
+ requireConfirmationOnRemovals?: boolean
25938
+ /**
25939
+ * Set to `true` to always prompt the user for confirmation before allowing the AI to update records
25940
+ */
25941
+ requireConfirmationOnUpdates?: boolean
25942
+ /**
25943
+ * Temperature setting (if applicable). Overrides the default temperature set by the apiPlugin.
25476
25944
  */
25477
25945
  temperature?: number
25946
+ /**
25947
+ * A number of milliseconds a prompt is allowed to take before being aborted. Defaults to `60000` (1 minute).
25948
+ */
25949
+ timeout?: number
25950
+ /**
25951
+ * Use this to provide example prompt scenarios to "teach" the AI of more complex tasks. Must be configured as
25952
+ * an array containing arrays which contains the AI messages for the complete conversation.
25953
+ * ...
25954
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/ai/AIFilter#config-trainingData)
25955
+ */
25956
+ trainingData?: any[]
25478
25957
  /**
25479
25958
  * The text to show in the toast when the text input did not result in any filter being applied
25480
25959
  */
25481
25960
  unsuccessfulFilterMessage?: string
25961
+ /**
25962
+ * A configuration object containing the user's preferred AI feature settings. If there is a matching AI feature
25963
+ * class config, the user setting will take precedence
25964
+ * JSON.
25965
+ */
25966
+ userSettings?: AISettingsModelConfig|AISettingsModel
25967
+ /**
25968
+ * Experimental configuration of the AI verbosity. Valid values are `"1"`, `"2"` and `"3"`, where `"1"` is
25969
+ * lowest.
25970
+ */
25971
+ verbosityLevel?: string
25972
+ /**
25973
+ * Configuration settings for voice activation
25974
+ */
25975
+ voiceActivation?: AIVoiceActivationConfig
25482
25976
  /**
25483
25977
  * Fires before an object is destroyed.
25484
25978
  * @param {object} event Event object
@@ -25512,6 +26006,13 @@ type AIFilterConfig = {
25512
26006
  * @param {Core.mixin.InstancePlugin} event.source
25513
26007
  */
25514
26008
  onEnable?: ((event: { source: InstancePlugin }) => void)|string
26009
+ /**
26010
+ * Fired when the user changes it's settings via the settings panel
26011
+ * @param {object} event Event object
26012
+ * @param {Core.data.AISettingsModel} event.userSettings The user settings record
26013
+ * @param {object} event.changes The changed properties and the new value
26014
+ */
26015
+ onUserSettingsUpdate?: ((event: { userSettings: AISettingsModel, changes: object }) => void)|string
25515
26016
  }
25516
26017
 
25517
26018
  /**
@@ -29212,6 +29713,14 @@ type GridListenersTypes = {
29212
29713
  * @param {any} event.value The value being set
29213
29714
  */
29214
29715
  beforeCellRangeEdit: (event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void
29716
+ /**
29717
+ * This event is triggered before a parent column is collapsed or expanded.
29718
+ * @param {object} event Event object
29719
+ * @param {Grid.view.GridBase} event.source The grid instance
29720
+ * @param {Grid.column.Column} event.column The column
29721
+ * @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
29722
+ */
29723
+ beforeColumnCollapseToggle: (event: { source: GridBase, column: Column, collapsed: boolean }) => void
29215
29724
  /**
29216
29725
  * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
29217
29726
  * @param {object} event Event object
@@ -29312,18 +29821,18 @@ type GridListenersTypes = {
29312
29821
  /**
29313
29822
  * Fires before a row is rendered.
29314
29823
  * @param {object} event Event object
29315
- * @param {Grid.view.Grid} event.source The firing Grid instance.
29316
- * @param {Grid.row.Row} event.row The row about to be rendered.
29317
- * @param {Core.data.Model} event.record The record for the row.
29318
- * @param {number} event.recordIndex The zero-based index of the record.
29824
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
29825
+ * @param {Grid.row.Row} event.row The row about to be rendered
29826
+ * @param {Core.data.Model} event.record The record for the row
29827
+ * @param {number} event.recordIndex The zero-based index of the record
29319
29828
  */
29320
- beforeRenderRow: (event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void
29829
+ beforeRenderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
29321
29830
  /**
29322
29831
  * Grid rows are about to be rendered
29323
29832
  * @param {object} event Event object
29324
- * @param {Grid.view.Grid} event.source This grid.
29833
+ * @param {Grid.view.GridBase} event.source This grid.
29325
29834
  */
29326
- beforeRenderRows: (event: { source: Grid }) => void
29835
+ beforeRenderRows: (event: { source: GridBase }) => void
29327
29836
  /**
29328
29837
  * This event fires before row collapse is started.
29329
29838
  * ...
@@ -29554,6 +30063,14 @@ type GridListenersTypes = {
29554
30063
  * @param {Core.data.Model} event.record The record which has been collapsed.
29555
30064
  */
29556
30065
  collapseNode: (event: { source: Grid, record: Model }) => void
30066
+ /**
30067
+ * This event is triggered after a parent column has been collapsed or expanded.
30068
+ * @param {object} event Event object
30069
+ * @param {Grid.view.GridBase} event.source The Grid instance
30070
+ * @param {Grid.column.Column} event.column The column being toggled
30071
+ * @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
30072
+ */
30073
+ columnCollapseToggle: (event: { source: GridBase, column: Column, collapsed: boolean }) => void
29557
30074
  /**
29558
30075
  * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
29559
30076
  * to indicate whether the drop position is valid or not.
@@ -29635,14 +30152,14 @@ type GridListenersTypes = {
29635
30152
  * ...
29636
30153
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-dataChange)
29637
30154
  * @param {object} event Event object
29638
- * @param {Grid.view.Grid} event.source Owning grid
30155
+ * @param {Grid.view.GridBase} event.source Owning grid
29639
30156
  * @param {Core.data.Store} event.store The originating store
29640
30157
  * @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
29641
30158
  * @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
29642
30159
  * @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
29643
30160
  * @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
29644
30161
  */
29645
- dataChange: (event: { source: Grid, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void
30162
+ dataChange: (event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void
29646
30163
  /**
29647
30164
  * Fires when an object is destroyed.
29648
30165
  * @param {object} event Event object
@@ -29950,18 +30467,18 @@ type GridListenersTypes = {
29950
30467
  /**
29951
30468
  * Fires after a row is rendered.
29952
30469
  * @param {object} event Event object
29953
- * @param {Grid.view.Grid} event.source The firing Grid instance.
29954
- * @param {Grid.row.Row} event.row The row that has been rendered.
29955
- * @param {Core.data.Model} event.record The record for the row.
29956
- * @param {number} event.recordIndex The zero-based index of the record.
30470
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
30471
+ * @param {Grid.row.Row} event.row The row that has been rendered
30472
+ * @param {Core.data.Model} event.record The record for the row
30473
+ * @param {number} event.recordIndex The zero-based index of the record
29957
30474
  */
29958
- renderRow: (event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void
30475
+ renderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
29959
30476
  /**
29960
30477
  * Grid rows have been rendered
29961
30478
  * @param {object} event Event object
29962
- * @param {Grid.view.Grid} event.source This grid.
30479
+ * @param {Grid.view.GridBase} event.source This grid.
29963
30480
  */
29964
- renderRows: (event: { source: Grid }) => void
30481
+ renderRows: (event: { source: GridBase }) => void
29965
30482
  /**
29966
30483
  * Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
29967
30484
  * @param {object} event Event object
@@ -30021,10 +30538,10 @@ type GridListenersTypes = {
30021
30538
  /**
30022
30539
  * Grid has scrolled vertically
30023
30540
  * @param {object} event Event object
30024
- * @param {Grid.view.Grid} event.source The firing Grid instance.
30541
+ * @param {Grid.view.GridBase} event.source The firing Grid instance.
30025
30542
  * @param {number} event.scrollTop The vertical scroll position.
30026
30543
  */
30027
- scroll: (event: { source: Grid, scrollTop: number }) => void
30544
+ scroll: (event: { source: GridBase, scrollTop: number }) => void
30028
30545
  /**
30029
30546
  * The selection has been changed.
30030
30547
  * @param {object} event Event object
@@ -30112,17 +30629,17 @@ type GridListenersTypes = {
30112
30629
  /**
30113
30630
  * Fires after a sub grid is collapsed.
30114
30631
  * @param {object} event Event object
30115
- * @param {Grid.view.Grid} event.source The firing Grid instance
30632
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
30116
30633
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
30117
30634
  */
30118
- subGridCollapse: (event: { source: Grid, subGrid: SubGrid }) => void
30635
+ subGridCollapse: (event: { source: GridBase, subGrid: SubGrid }) => void
30119
30636
  /**
30120
30637
  * Fires after a sub grid is expanded.
30121
30638
  * @param {object} event Event object
30122
- * @param {Grid.view.Grid} event.source The firing Grid instance
30639
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
30123
30640
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
30124
30641
  */
30125
- subGridExpand: (event: { source: Grid, subGrid: SubGrid }) => void
30642
+ subGridExpand: (event: { source: GridBase, subGrid: SubGrid }) => void
30126
30643
  /**
30127
30644
  * Fired when one or more groups are expanded or collapsed
30128
30645
  * @param {object} event Event object
@@ -30215,6 +30732,14 @@ type GridListeners = {
30215
30732
  * @param {any} event.value The value being set
30216
30733
  */
30217
30734
  beforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
30735
+ /**
30736
+ * This event is triggered before a parent column is collapsed or expanded.
30737
+ * @param {object} event Event object
30738
+ * @param {Grid.view.GridBase} event.source The grid instance
30739
+ * @param {Grid.column.Column} event.column The column
30740
+ * @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
30741
+ */
30742
+ beforeColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
30218
30743
  /**
30219
30744
  * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
30220
30745
  * @param {object} event Event object
@@ -30315,18 +30840,18 @@ type GridListeners = {
30315
30840
  /**
30316
30841
  * Fires before a row is rendered.
30317
30842
  * @param {object} event Event object
30318
- * @param {Grid.view.Grid} event.source The firing Grid instance.
30319
- * @param {Grid.row.Row} event.row The row about to be rendered.
30320
- * @param {Core.data.Model} event.record The record for the row.
30321
- * @param {number} event.recordIndex The zero-based index of the record.
30843
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
30844
+ * @param {Grid.row.Row} event.row The row about to be rendered
30845
+ * @param {Core.data.Model} event.record The record for the row
30846
+ * @param {number} event.recordIndex The zero-based index of the record
30322
30847
  */
30323
- beforeRenderRow?: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
30848
+ beforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
30324
30849
  /**
30325
30850
  * Grid rows are about to be rendered
30326
30851
  * @param {object} event Event object
30327
- * @param {Grid.view.Grid} event.source This grid.
30852
+ * @param {Grid.view.GridBase} event.source This grid.
30328
30853
  */
30329
- beforeRenderRows?: ((event: { source: Grid }) => void)|string
30854
+ beforeRenderRows?: ((event: { source: GridBase }) => void)|string
30330
30855
  /**
30331
30856
  * This event fires before row collapse is started.
30332
30857
  * ...
@@ -30557,6 +31082,14 @@ type GridListeners = {
30557
31082
  * @param {Core.data.Model} event.record The record which has been collapsed.
30558
31083
  */
30559
31084
  collapseNode?: ((event: { source: Grid, record: Model }) => void)|string
31085
+ /**
31086
+ * This event is triggered after a parent column has been collapsed or expanded.
31087
+ * @param {object} event Event object
31088
+ * @param {Grid.view.GridBase} event.source The Grid instance
31089
+ * @param {Grid.column.Column} event.column The column being toggled
31090
+ * @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
31091
+ */
31092
+ columnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
30560
31093
  /**
30561
31094
  * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
30562
31095
  * to indicate whether the drop position is valid or not.
@@ -30638,14 +31171,14 @@ type GridListeners = {
30638
31171
  * ...
30639
31172
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-dataChange)
30640
31173
  * @param {object} event Event object
30641
- * @param {Grid.view.Grid} event.source Owning grid
31174
+ * @param {Grid.view.GridBase} event.source Owning grid
30642
31175
  * @param {Core.data.Store} event.store The originating store
30643
31176
  * @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
30644
31177
  * @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
30645
31178
  * @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
30646
31179
  * @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
30647
31180
  */
30648
- dataChange?: ((event: { source: Grid, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
31181
+ dataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
30649
31182
  /**
30650
31183
  * Fires when an object is destroyed.
30651
31184
  * @param {object} event Event object
@@ -30953,18 +31486,18 @@ type GridListeners = {
30953
31486
  /**
30954
31487
  * Fires after a row is rendered.
30955
31488
  * @param {object} event Event object
30956
- * @param {Grid.view.Grid} event.source The firing Grid instance.
30957
- * @param {Grid.row.Row} event.row The row that has been rendered.
30958
- * @param {Core.data.Model} event.record The record for the row.
30959
- * @param {number} event.recordIndex The zero-based index of the record.
31489
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
31490
+ * @param {Grid.row.Row} event.row The row that has been rendered
31491
+ * @param {Core.data.Model} event.record The record for the row
31492
+ * @param {number} event.recordIndex The zero-based index of the record
30960
31493
  */
30961
- renderRow?: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
31494
+ renderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
30962
31495
  /**
30963
31496
  * Grid rows have been rendered
30964
31497
  * @param {object} event Event object
30965
- * @param {Grid.view.Grid} event.source This grid.
31498
+ * @param {Grid.view.GridBase} event.source This grid.
30966
31499
  */
30967
- renderRows?: ((event: { source: Grid }) => void)|string
31500
+ renderRows?: ((event: { source: GridBase }) => void)|string
30968
31501
  /**
30969
31502
  * Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
30970
31503
  * @param {object} event Event object
@@ -31024,10 +31557,10 @@ type GridListeners = {
31024
31557
  /**
31025
31558
  * Grid has scrolled vertically
31026
31559
  * @param {object} event Event object
31027
- * @param {Grid.view.Grid} event.source The firing Grid instance.
31560
+ * @param {Grid.view.GridBase} event.source The firing Grid instance.
31028
31561
  * @param {number} event.scrollTop The vertical scroll position.
31029
31562
  */
31030
- scroll?: ((event: { source: Grid, scrollTop: number }) => void)|string
31563
+ scroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
31031
31564
  /**
31032
31565
  * The selection has been changed.
31033
31566
  * @param {object} event Event object
@@ -31115,17 +31648,17 @@ type GridListeners = {
31115
31648
  /**
31116
31649
  * Fires after a sub grid is collapsed.
31117
31650
  * @param {object} event Event object
31118
- * @param {Grid.view.Grid} event.source The firing Grid instance
31651
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
31119
31652
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
31120
31653
  */
31121
- subGridCollapse?: ((event: { source: Grid, subGrid: SubGrid }) => void)|string
31654
+ subGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
31122
31655
  /**
31123
31656
  * Fires after a sub grid is expanded.
31124
31657
  * @param {object} event Event object
31125
- * @param {Grid.view.Grid} event.source The firing Grid instance
31658
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
31126
31659
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
31127
31660
  */
31128
- subGridExpand?: ((event: { source: Grid, subGrid: SubGrid }) => void)|string
31661
+ subGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
31129
31662
  /**
31130
31663
  * Fired when one or more groups are expanded or collapsed
31131
31664
  * @param {object} event Event object
@@ -31162,6 +31695,7 @@ type GridListeners = {
31162
31695
  }
31163
31696
 
31164
31697
  type GridFeaturesType = {
31698
+ ai: AI
31165
31699
  aiFilter: AIFilter
31166
31700
  cellCopyPaste: CellCopyPaste
31167
31701
  cellEdit: CellEdit
@@ -31205,6 +31739,7 @@ type GridFeaturesType = {
31205
31739
  }
31206
31740
 
31207
31741
  type GridFeaturesConfigType = {
31742
+ ai?: string|boolean|AIConfig
31208
31743
  aiFilter?: string|boolean|AIFilterConfig
31209
31744
  cellCopyPaste?: string|boolean|CellCopyPasteConfig
31210
31745
  cellEdit?: string|boolean|CellEditConfig
@@ -31321,6 +31856,10 @@ type GridConfig = {
31321
31856
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#config-bodyCls)
31322
31857
  */
31323
31858
  bodyCls?: string|object
31859
+ /**
31860
+ * Set `true` to add a border to this container's element.
31861
+ */
31862
+ border?: boolean
31324
31863
  /**
31325
31864
  * An object where property names with a truthy value indicate which events should bubble up the ownership
31326
31865
  * hierarchy when triggered.
@@ -31372,7 +31911,7 @@ type GridConfig = {
31372
31911
  * ...
31373
31912
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#config-color)
31374
31913
  */
31375
- color?: string
31914
+ color?: Color
31376
31915
  /**
31377
31916
  * Programmatic control over which column to start in when used in a grid layout.
31378
31917
  */
@@ -32053,6 +32592,14 @@ type GridConfig = {
32053
32592
  * @param {any} event.value The value being set
32054
32593
  */
32055
32594
  onBeforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
32595
+ /**
32596
+ * This event is triggered before a parent column is collapsed or expanded.
32597
+ * @param {object} event Event object
32598
+ * @param {Grid.view.GridBase} event.source The grid instance
32599
+ * @param {Grid.column.Column} event.column The column
32600
+ * @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
32601
+ */
32602
+ onBeforeColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
32056
32603
  /**
32057
32604
  * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
32058
32605
  * @param {object} event Event object
@@ -32153,18 +32700,18 @@ type GridConfig = {
32153
32700
  /**
32154
32701
  * Fires before a row is rendered.
32155
32702
  * @param {object} event Event object
32156
- * @param {Grid.view.Grid} event.source The firing Grid instance.
32157
- * @param {Grid.row.Row} event.row The row about to be rendered.
32158
- * @param {Core.data.Model} event.record The record for the row.
32159
- * @param {number} event.recordIndex The zero-based index of the record.
32703
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
32704
+ * @param {Grid.row.Row} event.row The row about to be rendered
32705
+ * @param {Core.data.Model} event.record The record for the row
32706
+ * @param {number} event.recordIndex The zero-based index of the record
32160
32707
  */
32161
- onBeforeRenderRow?: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
32708
+ onBeforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
32162
32709
  /**
32163
32710
  * Grid rows are about to be rendered
32164
32711
  * @param {object} event Event object
32165
- * @param {Grid.view.Grid} event.source This grid.
32712
+ * @param {Grid.view.GridBase} event.source This grid.
32166
32713
  */
32167
- onBeforeRenderRows?: ((event: { source: Grid }) => void)|string
32714
+ onBeforeRenderRows?: ((event: { source: GridBase }) => void)|string
32168
32715
  /**
32169
32716
  * This event fires before row collapse is started.
32170
32717
  * ...
@@ -32395,6 +32942,14 @@ type GridConfig = {
32395
32942
  * @param {Core.data.Model} event.record The record which has been collapsed.
32396
32943
  */
32397
32944
  onCollapseNode?: ((event: { source: Grid, record: Model }) => void)|string
32945
+ /**
32946
+ * This event is triggered after a parent column has been collapsed or expanded.
32947
+ * @param {object} event Event object
32948
+ * @param {Grid.view.GridBase} event.source The Grid instance
32949
+ * @param {Grid.column.Column} event.column The column being toggled
32950
+ * @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
32951
+ */
32952
+ onColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
32398
32953
  /**
32399
32954
  * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
32400
32955
  * to indicate whether the drop position is valid or not.
@@ -32476,14 +33031,14 @@ type GridConfig = {
32476
33031
  * ...
32477
33032
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-dataChange)
32478
33033
  * @param {object} event Event object
32479
- * @param {Grid.view.Grid} event.source Owning grid
33034
+ * @param {Grid.view.GridBase} event.source Owning grid
32480
33035
  * @param {Core.data.Store} event.store The originating store
32481
33036
  * @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
32482
33037
  * @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
32483
33038
  * @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
32484
33039
  * @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
32485
33040
  */
32486
- onDataChange?: ((event: { source: Grid, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
33041
+ onDataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
32487
33042
  /**
32488
33043
  * Fires when an object is destroyed.
32489
33044
  * @param {object} event Event object
@@ -32791,18 +33346,18 @@ type GridConfig = {
32791
33346
  /**
32792
33347
  * Fires after a row is rendered.
32793
33348
  * @param {object} event Event object
32794
- * @param {Grid.view.Grid} event.source The firing Grid instance.
32795
- * @param {Grid.row.Row} event.row The row that has been rendered.
32796
- * @param {Core.data.Model} event.record The record for the row.
32797
- * @param {number} event.recordIndex The zero-based index of the record.
33349
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
33350
+ * @param {Grid.row.Row} event.row The row that has been rendered
33351
+ * @param {Core.data.Model} event.record The record for the row
33352
+ * @param {number} event.recordIndex The zero-based index of the record
32798
33353
  */
32799
- onRenderRow?: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
33354
+ onRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
32800
33355
  /**
32801
33356
  * Grid rows have been rendered
32802
33357
  * @param {object} event Event object
32803
- * @param {Grid.view.Grid} event.source This grid.
33358
+ * @param {Grid.view.GridBase} event.source This grid.
32804
33359
  */
32805
- onRenderRows?: ((event: { source: Grid }) => void)|string
33360
+ onRenderRows?: ((event: { source: GridBase }) => void)|string
32806
33361
  /**
32807
33362
  * Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
32808
33363
  * @param {object} event Event object
@@ -32862,10 +33417,10 @@ type GridConfig = {
32862
33417
  /**
32863
33418
  * Grid has scrolled vertically
32864
33419
  * @param {object} event Event object
32865
- * @param {Grid.view.Grid} event.source The firing Grid instance.
33420
+ * @param {Grid.view.GridBase} event.source The firing Grid instance.
32866
33421
  * @param {number} event.scrollTop The vertical scroll position.
32867
33422
  */
32868
- onScroll?: ((event: { source: Grid, scrollTop: number }) => void)|string
33423
+ onScroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
32869
33424
  /**
32870
33425
  * The selection has been changed.
32871
33426
  * @param {object} event Event object
@@ -32953,17 +33508,17 @@ type GridConfig = {
32953
33508
  /**
32954
33509
  * Fires after a sub grid is collapsed.
32955
33510
  * @param {object} event Event object
32956
- * @param {Grid.view.Grid} event.source The firing Grid instance
33511
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
32957
33512
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
32958
33513
  */
32959
- onSubGridCollapse?: ((event: { source: Grid, subGrid: SubGrid }) => void)|string
33514
+ onSubGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
32960
33515
  /**
32961
33516
  * Fires after a sub grid is expanded.
32962
33517
  * @param {object} event Event object
32963
- * @param {Grid.view.Grid} event.source The firing Grid instance
33518
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
32964
33519
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
32965
33520
  */
32966
- onSubGridExpand?: ((event: { source: Grid, subGrid: SubGrid }) => void)|string
33521
+ onSubGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
32967
33522
  /**
32968
33523
  * Fired when one or more groups are expanded or collapsed
32969
33524
  * @param {object} event Event object
@@ -33275,6 +33830,14 @@ type GridBaseListenersTypes = {
33275
33830
  * @param {any} event.value The value being set
33276
33831
  */
33277
33832
  beforeCellRangeEdit: (event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void
33833
+ /**
33834
+ * This event is triggered before a parent column is collapsed or expanded.
33835
+ * @param {object} event Event object
33836
+ * @param {Grid.view.GridBase} event.source The grid instance
33837
+ * @param {Grid.column.Column} event.column The column
33838
+ * @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
33839
+ */
33840
+ beforeColumnCollapseToggle: (event: { source: GridBase, column: Column, collapsed: boolean }) => void
33278
33841
  /**
33279
33842
  * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
33280
33843
  * @param {object} event Event object
@@ -33375,18 +33938,18 @@ type GridBaseListenersTypes = {
33375
33938
  /**
33376
33939
  * Fires before a row is rendered.
33377
33940
  * @param {object} event Event object
33378
- * @param {Grid.view.Grid} event.source The firing Grid instance.
33379
- * @param {Grid.row.Row} event.row The row about to be rendered.
33380
- * @param {Core.data.Model} event.record The record for the row.
33381
- * @param {number} event.recordIndex The zero-based index of the record.
33941
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
33942
+ * @param {Grid.row.Row} event.row The row about to be rendered
33943
+ * @param {Core.data.Model} event.record The record for the row
33944
+ * @param {number} event.recordIndex The zero-based index of the record
33382
33945
  */
33383
- beforeRenderRow: (event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void
33946
+ beforeRenderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
33384
33947
  /**
33385
33948
  * Grid rows are about to be rendered
33386
33949
  * @param {object} event Event object
33387
- * @param {Grid.view.Grid} event.source This grid.
33950
+ * @param {Grid.view.GridBase} event.source This grid.
33388
33951
  */
33389
- beforeRenderRows: (event: { source: Grid }) => void
33952
+ beforeRenderRows: (event: { source: GridBase }) => void
33390
33953
  /**
33391
33954
  * This event fires before row collapse is started.
33392
33955
  * ...
@@ -33617,6 +34180,14 @@ type GridBaseListenersTypes = {
33617
34180
  * @param {Core.data.Model} event.record The record which has been collapsed.
33618
34181
  */
33619
34182
  collapseNode: (event: { source: Grid, record: Model }) => void
34183
+ /**
34184
+ * This event is triggered after a parent column has been collapsed or expanded.
34185
+ * @param {object} event Event object
34186
+ * @param {Grid.view.GridBase} event.source The Grid instance
34187
+ * @param {Grid.column.Column} event.column The column being toggled
34188
+ * @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
34189
+ */
34190
+ columnCollapseToggle: (event: { source: GridBase, column: Column, collapsed: boolean }) => void
33620
34191
  /**
33621
34192
  * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
33622
34193
  * to indicate whether the drop position is valid or not.
@@ -33698,14 +34269,14 @@ type GridBaseListenersTypes = {
33698
34269
  * ...
33699
34270
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-dataChange)
33700
34271
  * @param {object} event Event object
33701
- * @param {Grid.view.Grid} event.source Owning grid
34272
+ * @param {Grid.view.GridBase} event.source Owning grid
33702
34273
  * @param {Core.data.Store} event.store The originating store
33703
34274
  * @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
33704
34275
  * @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
33705
34276
  * @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
33706
34277
  * @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
33707
34278
  */
33708
- dataChange: (event: { source: Grid, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void
34279
+ dataChange: (event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void
33709
34280
  /**
33710
34281
  * Fires when an object is destroyed.
33711
34282
  * @param {object} event Event object
@@ -34013,18 +34584,18 @@ type GridBaseListenersTypes = {
34013
34584
  /**
34014
34585
  * Fires after a row is rendered.
34015
34586
  * @param {object} event Event object
34016
- * @param {Grid.view.Grid} event.source The firing Grid instance.
34017
- * @param {Grid.row.Row} event.row The row that has been rendered.
34018
- * @param {Core.data.Model} event.record The record for the row.
34019
- * @param {number} event.recordIndex The zero-based index of the record.
34587
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
34588
+ * @param {Grid.row.Row} event.row The row that has been rendered
34589
+ * @param {Core.data.Model} event.record The record for the row
34590
+ * @param {number} event.recordIndex The zero-based index of the record
34020
34591
  */
34021
- renderRow: (event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void
34592
+ renderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
34022
34593
  /**
34023
34594
  * Grid rows have been rendered
34024
34595
  * @param {object} event Event object
34025
- * @param {Grid.view.Grid} event.source This grid.
34596
+ * @param {Grid.view.GridBase} event.source This grid.
34026
34597
  */
34027
- renderRows: (event: { source: Grid }) => void
34598
+ renderRows: (event: { source: GridBase }) => void
34028
34599
  /**
34029
34600
  * Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
34030
34601
  * @param {object} event Event object
@@ -34084,10 +34655,10 @@ type GridBaseListenersTypes = {
34084
34655
  /**
34085
34656
  * Grid has scrolled vertically
34086
34657
  * @param {object} event Event object
34087
- * @param {Grid.view.Grid} event.source The firing Grid instance.
34658
+ * @param {Grid.view.GridBase} event.source The firing Grid instance.
34088
34659
  * @param {number} event.scrollTop The vertical scroll position.
34089
34660
  */
34090
- scroll: (event: { source: Grid, scrollTop: number }) => void
34661
+ scroll: (event: { source: GridBase, scrollTop: number }) => void
34091
34662
  /**
34092
34663
  * The selection has been changed.
34093
34664
  * @param {object} event Event object
@@ -34175,17 +34746,17 @@ type GridBaseListenersTypes = {
34175
34746
  /**
34176
34747
  * Fires after a sub grid is collapsed.
34177
34748
  * @param {object} event Event object
34178
- * @param {Grid.view.Grid} event.source The firing Grid instance
34749
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
34179
34750
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
34180
34751
  */
34181
- subGridCollapse: (event: { source: Grid, subGrid: SubGrid }) => void
34752
+ subGridCollapse: (event: { source: GridBase, subGrid: SubGrid }) => void
34182
34753
  /**
34183
34754
  * Fires after a sub grid is expanded.
34184
34755
  * @param {object} event Event object
34185
- * @param {Grid.view.Grid} event.source The firing Grid instance
34756
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
34186
34757
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
34187
34758
  */
34188
- subGridExpand: (event: { source: Grid, subGrid: SubGrid }) => void
34759
+ subGridExpand: (event: { source: GridBase, subGrid: SubGrid }) => void
34189
34760
  /**
34190
34761
  * Fired when one or more groups are expanded or collapsed
34191
34762
  * @param {object} event Event object
@@ -34278,6 +34849,14 @@ type GridBaseListeners = {
34278
34849
  * @param {any} event.value The value being set
34279
34850
  */
34280
34851
  beforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
34852
+ /**
34853
+ * This event is triggered before a parent column is collapsed or expanded.
34854
+ * @param {object} event Event object
34855
+ * @param {Grid.view.GridBase} event.source The grid instance
34856
+ * @param {Grid.column.Column} event.column The column
34857
+ * @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
34858
+ */
34859
+ beforeColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
34281
34860
  /**
34282
34861
  * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
34283
34862
  * @param {object} event Event object
@@ -34378,18 +34957,18 @@ type GridBaseListeners = {
34378
34957
  /**
34379
34958
  * Fires before a row is rendered.
34380
34959
  * @param {object} event Event object
34381
- * @param {Grid.view.Grid} event.source The firing Grid instance.
34382
- * @param {Grid.row.Row} event.row The row about to be rendered.
34383
- * @param {Core.data.Model} event.record The record for the row.
34384
- * @param {number} event.recordIndex The zero-based index of the record.
34960
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
34961
+ * @param {Grid.row.Row} event.row The row about to be rendered
34962
+ * @param {Core.data.Model} event.record The record for the row
34963
+ * @param {number} event.recordIndex The zero-based index of the record
34385
34964
  */
34386
- beforeRenderRow?: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
34965
+ beforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
34387
34966
  /**
34388
34967
  * Grid rows are about to be rendered
34389
34968
  * @param {object} event Event object
34390
- * @param {Grid.view.Grid} event.source This grid.
34969
+ * @param {Grid.view.GridBase} event.source This grid.
34391
34970
  */
34392
- beforeRenderRows?: ((event: { source: Grid }) => void)|string
34971
+ beforeRenderRows?: ((event: { source: GridBase }) => void)|string
34393
34972
  /**
34394
34973
  * This event fires before row collapse is started.
34395
34974
  * ...
@@ -34620,6 +35199,14 @@ type GridBaseListeners = {
34620
35199
  * @param {Core.data.Model} event.record The record which has been collapsed.
34621
35200
  */
34622
35201
  collapseNode?: ((event: { source: Grid, record: Model }) => void)|string
35202
+ /**
35203
+ * This event is triggered after a parent column has been collapsed or expanded.
35204
+ * @param {object} event Event object
35205
+ * @param {Grid.view.GridBase} event.source The Grid instance
35206
+ * @param {Grid.column.Column} event.column The column being toggled
35207
+ * @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
35208
+ */
35209
+ columnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
34623
35210
  /**
34624
35211
  * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
34625
35212
  * to indicate whether the drop position is valid or not.
@@ -34701,14 +35288,14 @@ type GridBaseListeners = {
34701
35288
  * ...
34702
35289
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-dataChange)
34703
35290
  * @param {object} event Event object
34704
- * @param {Grid.view.Grid} event.source Owning grid
35291
+ * @param {Grid.view.GridBase} event.source Owning grid
34705
35292
  * @param {Core.data.Store} event.store The originating store
34706
35293
  * @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
34707
35294
  * @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
34708
35295
  * @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
34709
35296
  * @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
34710
35297
  */
34711
- dataChange?: ((event: { source: Grid, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
35298
+ dataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
34712
35299
  /**
34713
35300
  * Fires when an object is destroyed.
34714
35301
  * @param {object} event Event object
@@ -35016,18 +35603,18 @@ type GridBaseListeners = {
35016
35603
  /**
35017
35604
  * Fires after a row is rendered.
35018
35605
  * @param {object} event Event object
35019
- * @param {Grid.view.Grid} event.source The firing Grid instance.
35020
- * @param {Grid.row.Row} event.row The row that has been rendered.
35021
- * @param {Core.data.Model} event.record The record for the row.
35022
- * @param {number} event.recordIndex The zero-based index of the record.
35606
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
35607
+ * @param {Grid.row.Row} event.row The row that has been rendered
35608
+ * @param {Core.data.Model} event.record The record for the row
35609
+ * @param {number} event.recordIndex The zero-based index of the record
35023
35610
  */
35024
- renderRow?: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
35611
+ renderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
35025
35612
  /**
35026
35613
  * Grid rows have been rendered
35027
35614
  * @param {object} event Event object
35028
- * @param {Grid.view.Grid} event.source This grid.
35615
+ * @param {Grid.view.GridBase} event.source This grid.
35029
35616
  */
35030
- renderRows?: ((event: { source: Grid }) => void)|string
35617
+ renderRows?: ((event: { source: GridBase }) => void)|string
35031
35618
  /**
35032
35619
  * Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
35033
35620
  * @param {object} event Event object
@@ -35087,10 +35674,10 @@ type GridBaseListeners = {
35087
35674
  /**
35088
35675
  * Grid has scrolled vertically
35089
35676
  * @param {object} event Event object
35090
- * @param {Grid.view.Grid} event.source The firing Grid instance.
35677
+ * @param {Grid.view.GridBase} event.source The firing Grid instance.
35091
35678
  * @param {number} event.scrollTop The vertical scroll position.
35092
35679
  */
35093
- scroll?: ((event: { source: Grid, scrollTop: number }) => void)|string
35680
+ scroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
35094
35681
  /**
35095
35682
  * The selection has been changed.
35096
35683
  * @param {object} event Event object
@@ -35178,17 +35765,17 @@ type GridBaseListeners = {
35178
35765
  /**
35179
35766
  * Fires after a sub grid is collapsed.
35180
35767
  * @param {object} event Event object
35181
- * @param {Grid.view.Grid} event.source The firing Grid instance
35768
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
35182
35769
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
35183
35770
  */
35184
- subGridCollapse?: ((event: { source: Grid, subGrid: SubGrid }) => void)|string
35771
+ subGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
35185
35772
  /**
35186
35773
  * Fires after a sub grid is expanded.
35187
35774
  * @param {object} event Event object
35188
- * @param {Grid.view.Grid} event.source The firing Grid instance
35775
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
35189
35776
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
35190
35777
  */
35191
- subGridExpand?: ((event: { source: Grid, subGrid: SubGrid }) => void)|string
35778
+ subGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
35192
35779
  /**
35193
35780
  * Fired when one or more groups are expanded or collapsed
35194
35781
  * @param {object} event Event object
@@ -35225,6 +35812,7 @@ type GridBaseListeners = {
35225
35812
  }
35226
35813
 
35227
35814
  type GridBaseFeaturesType = {
35815
+ ai: AI
35228
35816
  aiFilter: AIFilter
35229
35817
  cellCopyPaste: CellCopyPaste
35230
35818
  cellEdit: CellEdit
@@ -35268,6 +35856,7 @@ type GridBaseFeaturesType = {
35268
35856
  }
35269
35857
 
35270
35858
  type GridBaseFeaturesConfigType = {
35859
+ ai?: string|boolean|AIConfig
35271
35860
  aiFilter?: string|boolean|AIFilterConfig
35272
35861
  cellCopyPaste?: string|boolean|CellCopyPasteConfig
35273
35862
  cellEdit?: string|boolean|CellEditConfig
@@ -35383,6 +35972,10 @@ type GridBaseConfig = {
35383
35972
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-bodyCls)
35384
35973
  */
35385
35974
  bodyCls?: string|object
35975
+ /**
35976
+ * Set `true` to add a border to this container's element.
35977
+ */
35978
+ border?: boolean
35386
35979
  /**
35387
35980
  * An object where property names with a truthy value indicate which events should bubble up the ownership
35388
35981
  * hierarchy when triggered.
@@ -35434,7 +36027,7 @@ type GridBaseConfig = {
35434
36027
  * ...
35435
36028
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-color)
35436
36029
  */
35437
- color?: string
36030
+ color?: Color
35438
36031
  /**
35439
36032
  * Programmatic control over which column to start in when used in a grid layout.
35440
36033
  */
@@ -36115,6 +36708,14 @@ type GridBaseConfig = {
36115
36708
  * @param {any} event.value The value being set
36116
36709
  */
36117
36710
  onBeforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
36711
+ /**
36712
+ * This event is triggered before a parent column is collapsed or expanded.
36713
+ * @param {object} event Event object
36714
+ * @param {Grid.view.GridBase} event.source The grid instance
36715
+ * @param {Grid.column.Column} event.column The column
36716
+ * @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
36717
+ */
36718
+ onBeforeColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
36118
36719
  /**
36119
36720
  * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
36120
36721
  * @param {object} event Event object
@@ -36215,18 +36816,18 @@ type GridBaseConfig = {
36215
36816
  /**
36216
36817
  * Fires before a row is rendered.
36217
36818
  * @param {object} event Event object
36218
- * @param {Grid.view.Grid} event.source The firing Grid instance.
36219
- * @param {Grid.row.Row} event.row The row about to be rendered.
36220
- * @param {Core.data.Model} event.record The record for the row.
36221
- * @param {number} event.recordIndex The zero-based index of the record.
36819
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
36820
+ * @param {Grid.row.Row} event.row The row about to be rendered
36821
+ * @param {Core.data.Model} event.record The record for the row
36822
+ * @param {number} event.recordIndex The zero-based index of the record
36222
36823
  */
36223
- onBeforeRenderRow?: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
36824
+ onBeforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
36224
36825
  /**
36225
36826
  * Grid rows are about to be rendered
36226
36827
  * @param {object} event Event object
36227
- * @param {Grid.view.Grid} event.source This grid.
36828
+ * @param {Grid.view.GridBase} event.source This grid.
36228
36829
  */
36229
- onBeforeRenderRows?: ((event: { source: Grid }) => void)|string
36830
+ onBeforeRenderRows?: ((event: { source: GridBase }) => void)|string
36230
36831
  /**
36231
36832
  * This event fires before row collapse is started.
36232
36833
  * ...
@@ -36457,6 +37058,14 @@ type GridBaseConfig = {
36457
37058
  * @param {Core.data.Model} event.record The record which has been collapsed.
36458
37059
  */
36459
37060
  onCollapseNode?: ((event: { source: Grid, record: Model }) => void)|string
37061
+ /**
37062
+ * This event is triggered after a parent column has been collapsed or expanded.
37063
+ * @param {object} event Event object
37064
+ * @param {Grid.view.GridBase} event.source The Grid instance
37065
+ * @param {Grid.column.Column} event.column The column being toggled
37066
+ * @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
37067
+ */
37068
+ onColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
36460
37069
  /**
36461
37070
  * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
36462
37071
  * to indicate whether the drop position is valid or not.
@@ -36538,14 +37147,14 @@ type GridBaseConfig = {
36538
37147
  * ...
36539
37148
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-dataChange)
36540
37149
  * @param {object} event Event object
36541
- * @param {Grid.view.Grid} event.source Owning grid
37150
+ * @param {Grid.view.GridBase} event.source Owning grid
36542
37151
  * @param {Core.data.Store} event.store The originating store
36543
37152
  * @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
36544
37153
  * @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
36545
37154
  * @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
36546
37155
  * @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
36547
37156
  */
36548
- onDataChange?: ((event: { source: Grid, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
37157
+ onDataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
36549
37158
  /**
36550
37159
  * Fires when an object is destroyed.
36551
37160
  * @param {object} event Event object
@@ -36853,18 +37462,18 @@ type GridBaseConfig = {
36853
37462
  /**
36854
37463
  * Fires after a row is rendered.
36855
37464
  * @param {object} event Event object
36856
- * @param {Grid.view.Grid} event.source The firing Grid instance.
36857
- * @param {Grid.row.Row} event.row The row that has been rendered.
36858
- * @param {Core.data.Model} event.record The record for the row.
36859
- * @param {number} event.recordIndex The zero-based index of the record.
37465
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
37466
+ * @param {Grid.row.Row} event.row The row that has been rendered
37467
+ * @param {Core.data.Model} event.record The record for the row
37468
+ * @param {number} event.recordIndex The zero-based index of the record
36860
37469
  */
36861
- onRenderRow?: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
37470
+ onRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
36862
37471
  /**
36863
37472
  * Grid rows have been rendered
36864
37473
  * @param {object} event Event object
36865
- * @param {Grid.view.Grid} event.source This grid.
37474
+ * @param {Grid.view.GridBase} event.source This grid.
36866
37475
  */
36867
- onRenderRows?: ((event: { source: Grid }) => void)|string
37476
+ onRenderRows?: ((event: { source: GridBase }) => void)|string
36868
37477
  /**
36869
37478
  * Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
36870
37479
  * @param {object} event Event object
@@ -36924,10 +37533,10 @@ type GridBaseConfig = {
36924
37533
  /**
36925
37534
  * Grid has scrolled vertically
36926
37535
  * @param {object} event Event object
36927
- * @param {Grid.view.Grid} event.source The firing Grid instance.
37536
+ * @param {Grid.view.GridBase} event.source The firing Grid instance.
36928
37537
  * @param {number} event.scrollTop The vertical scroll position.
36929
37538
  */
36930
- onScroll?: ((event: { source: Grid, scrollTop: number }) => void)|string
37539
+ onScroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
36931
37540
  /**
36932
37541
  * The selection has been changed.
36933
37542
  * @param {object} event Event object
@@ -37015,17 +37624,17 @@ type GridBaseConfig = {
37015
37624
  /**
37016
37625
  * Fires after a sub grid is collapsed.
37017
37626
  * @param {object} event Event object
37018
- * @param {Grid.view.Grid} event.source The firing Grid instance
37627
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
37019
37628
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
37020
37629
  */
37021
- onSubGridCollapse?: ((event: { source: Grid, subGrid: SubGrid }) => void)|string
37630
+ onSubGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
37022
37631
  /**
37023
37632
  * Fires after a sub grid is expanded.
37024
37633
  * @param {object} event Event object
37025
- * @param {Grid.view.Grid} event.source The firing Grid instance
37634
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
37026
37635
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
37027
37636
  */
37028
- onSubGridExpand?: ((event: { source: Grid, subGrid: SubGrid }) => void)|string
37637
+ onSubGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
37029
37638
  /**
37030
37639
  * Fired when one or more groups are expanded or collapsed
37031
37640
  * @param {object} event Event object
@@ -37447,6 +38056,14 @@ export class GridBase extends Panel {
37447
38056
  * @param {any} event.value The value being set
37448
38057
  */
37449
38058
  onBeforeCellRangeEdit: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
38059
+ /**
38060
+ * This event is triggered before a parent column is collapsed or expanded.
38061
+ * @param {object} event Event object
38062
+ * @param {Grid.view.GridBase} event.source The grid instance
38063
+ * @param {Grid.column.Column} event.column The column
38064
+ * @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
38065
+ */
38066
+ onBeforeColumnCollapseToggle: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
37450
38067
  /**
37451
38068
  * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
37452
38069
  * @param {object} event Event object
@@ -37541,18 +38158,18 @@ export class GridBase extends Panel {
37541
38158
  /**
37542
38159
  * Fires before a row is rendered.
37543
38160
  * @param {object} event Event object
37544
- * @param {Grid.view.Grid} event.source The firing Grid instance.
37545
- * @param {Grid.row.Row} event.row The row about to be rendered.
37546
- * @param {Core.data.Model} event.record The record for the row.
37547
- * @param {number} event.recordIndex The zero-based index of the record.
38161
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
38162
+ * @param {Grid.row.Row} event.row The row about to be rendered
38163
+ * @param {Core.data.Model} event.record The record for the row
38164
+ * @param {number} event.recordIndex The zero-based index of the record
37548
38165
  */
37549
- onBeforeRenderRow: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
38166
+ onBeforeRenderRow: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
37550
38167
  /**
37551
38168
  * Grid rows are about to be rendered
37552
38169
  * @param {object} event Event object
37553
- * @param {Grid.view.Grid} event.source This grid.
38170
+ * @param {Grid.view.GridBase} event.source This grid.
37554
38171
  */
37555
- onBeforeRenderRows: ((event: { source: Grid }) => void)|string
38172
+ onBeforeRenderRows: ((event: { source: GridBase }) => void)|string
37556
38173
  /**
37557
38174
  * This event fires before row collapse is started.
37558
38175
  * ...
@@ -37763,6 +38380,14 @@ export class GridBase extends Panel {
37763
38380
  * @param {Core.data.Model} event.record The record which has been collapsed.
37764
38381
  */
37765
38382
  onCollapseNode: ((event: { source: Grid, record: Model }) => void)|string
38383
+ /**
38384
+ * This event is triggered after a parent column has been collapsed or expanded.
38385
+ * @param {object} event Event object
38386
+ * @param {Grid.view.GridBase} event.source The Grid instance
38387
+ * @param {Grid.column.Column} event.column The column being toggled
38388
+ * @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
38389
+ */
38390
+ onColumnCollapseToggle: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
37766
38391
  /**
37767
38392
  * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
37768
38393
  * to indicate whether the drop position is valid or not.
@@ -37827,14 +38452,14 @@ export class GridBase extends Panel {
37827
38452
  * ...
37828
38453
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-dataChange)
37829
38454
  * @param {object} event Event object
37830
- * @param {Grid.view.Grid} event.source Owning grid
38455
+ * @param {Grid.view.GridBase} event.source Owning grid
37831
38456
  * @param {Core.data.Store} event.store The originating store
37832
38457
  * @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
37833
38458
  * @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
37834
38459
  * @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
37835
38460
  * @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
37836
38461
  */
37837
- onDataChange: ((event: { source: Grid, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
38462
+ onDataChange: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
37838
38463
  /**
37839
38464
  * Fires when an object is destroyed.
37840
38465
  * @param {object} event Event object
@@ -38072,18 +38697,18 @@ export class GridBase extends Panel {
38072
38697
  /**
38073
38698
  * Fires after a row is rendered.
38074
38699
  * @param {object} event Event object
38075
- * @param {Grid.view.Grid} event.source The firing Grid instance.
38076
- * @param {Grid.row.Row} event.row The row that has been rendered.
38077
- * @param {Core.data.Model} event.record The record for the row.
38078
- * @param {number} event.recordIndex The zero-based index of the record.
38700
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
38701
+ * @param {Grid.row.Row} event.row The row that has been rendered
38702
+ * @param {Core.data.Model} event.record The record for the row
38703
+ * @param {number} event.recordIndex The zero-based index of the record
38079
38704
  */
38080
- onRenderRow: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
38705
+ onRenderRow: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
38081
38706
  /**
38082
38707
  * Grid rows have been rendered
38083
38708
  * @param {object} event Event object
38084
- * @param {Grid.view.Grid} event.source This grid.
38709
+ * @param {Grid.view.GridBase} event.source This grid.
38085
38710
  */
38086
- onRenderRows: ((event: { source: Grid }) => void)|string
38711
+ onRenderRows: ((event: { source: GridBase }) => void)|string
38087
38712
  /**
38088
38713
  * Grid resize lead to a new responsive level being applied
38089
38714
  * @param {object} event Event object
@@ -38133,10 +38758,10 @@ export class GridBase extends Panel {
38133
38758
  /**
38134
38759
  * Grid has scrolled vertically
38135
38760
  * @param {object} event Event object
38136
- * @param {Grid.view.Grid} event.source The firing Grid instance.
38761
+ * @param {Grid.view.GridBase} event.source The firing Grid instance.
38137
38762
  * @param {number} event.scrollTop The vertical scroll position.
38138
38763
  */
38139
- onScroll: ((event: { source: Grid, scrollTop: number }) => void)|string
38764
+ onScroll: ((event: { source: GridBase, scrollTop: number }) => void)|string
38140
38765
  /**
38141
38766
  * The selection has been changed.
38142
38767
  * @param {object} event Event object
@@ -38218,17 +38843,17 @@ export class GridBase extends Panel {
38218
38843
  /**
38219
38844
  * Fires after a sub grid is collapsed.
38220
38845
  * @param {object} event Event object
38221
- * @param {Grid.view.Grid} event.source The firing Grid instance
38846
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
38222
38847
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
38223
38848
  */
38224
- onSubGridCollapse: ((event: { source: Grid, subGrid: SubGrid }) => void)|string
38849
+ onSubGridCollapse: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
38225
38850
  /**
38226
38851
  * Fires after a sub grid is expanded.
38227
38852
  * @param {object} event Event object
38228
- * @param {Grid.view.Grid} event.source The firing Grid instance
38853
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
38229
38854
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
38230
38855
  */
38231
- onSubGridExpand: ((event: { source: Grid, subGrid: SubGrid }) => void)|string
38856
+ onSubGridExpand: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
38232
38857
  /**
38233
38858
  * Fired when one or more groups are expanded or collapsed
38234
38859
  * @param {object} event Event object
@@ -39148,7 +39773,7 @@ type SubGridConfig = {
39148
39773
  * ...
39149
39774
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/SubGrid#config-color)
39150
39775
  */
39151
- color?: string
39776
+ color?: Color
39152
39777
  /**
39153
39778
  * Programmatic control over which column to start in when used in a grid layout.
39154
39779
  */
@@ -39750,6 +40375,14 @@ type TreeGridListenersTypes = {
39750
40375
  * @param {any} event.value The value being set
39751
40376
  */
39752
40377
  beforeCellRangeEdit: (event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void
40378
+ /**
40379
+ * This event is triggered before a parent column is collapsed or expanded.
40380
+ * @param {object} event Event object
40381
+ * @param {Grid.view.GridBase} event.source The grid instance
40382
+ * @param {Grid.column.Column} event.column The column
40383
+ * @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
40384
+ */
40385
+ beforeColumnCollapseToggle: (event: { source: GridBase, column: Column, collapsed: boolean }) => void
39753
40386
  /**
39754
40387
  * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
39755
40388
  * @param {object} event Event object
@@ -39850,18 +40483,18 @@ type TreeGridListenersTypes = {
39850
40483
  /**
39851
40484
  * Fires before a row is rendered.
39852
40485
  * @param {object} event Event object
39853
- * @param {Grid.view.Grid} event.source The firing Grid instance.
39854
- * @param {Grid.row.Row} event.row The row about to be rendered.
39855
- * @param {Core.data.Model} event.record The record for the row.
39856
- * @param {number} event.recordIndex The zero-based index of the record.
40486
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
40487
+ * @param {Grid.row.Row} event.row The row about to be rendered
40488
+ * @param {Core.data.Model} event.record The record for the row
40489
+ * @param {number} event.recordIndex The zero-based index of the record
39857
40490
  */
39858
- beforeRenderRow: (event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void
40491
+ beforeRenderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
39859
40492
  /**
39860
40493
  * Grid rows are about to be rendered
39861
40494
  * @param {object} event Event object
39862
- * @param {Grid.view.Grid} event.source This grid.
40495
+ * @param {Grid.view.GridBase} event.source This grid.
39863
40496
  */
39864
- beforeRenderRows: (event: { source: Grid }) => void
40497
+ beforeRenderRows: (event: { source: GridBase }) => void
39865
40498
  /**
39866
40499
  * This event fires before row collapse is started.
39867
40500
  * ...
@@ -40092,6 +40725,14 @@ type TreeGridListenersTypes = {
40092
40725
  * @param {Core.data.Model} event.record The record which has been collapsed.
40093
40726
  */
40094
40727
  collapseNode: (event: { source: Grid, record: Model }) => void
40728
+ /**
40729
+ * This event is triggered after a parent column has been collapsed or expanded.
40730
+ * @param {object} event Event object
40731
+ * @param {Grid.view.GridBase} event.source The Grid instance
40732
+ * @param {Grid.column.Column} event.column The column being toggled
40733
+ * @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
40734
+ */
40735
+ columnCollapseToggle: (event: { source: GridBase, column: Column, collapsed: boolean }) => void
40095
40736
  /**
40096
40737
  * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
40097
40738
  * to indicate whether the drop position is valid or not.
@@ -40173,14 +40814,14 @@ type TreeGridListenersTypes = {
40173
40814
  * ...
40174
40815
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-dataChange)
40175
40816
  * @param {object} event Event object
40176
- * @param {Grid.view.Grid} event.source Owning grid
40817
+ * @param {Grid.view.GridBase} event.source Owning grid
40177
40818
  * @param {Core.data.Store} event.store The originating store
40178
40819
  * @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
40179
40820
  * @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
40180
40821
  * @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
40181
40822
  * @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
40182
40823
  */
40183
- dataChange: (event: { source: Grid, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void
40824
+ dataChange: (event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void
40184
40825
  /**
40185
40826
  * Fires when an object is destroyed.
40186
40827
  * @param {object} event Event object
@@ -40488,18 +41129,18 @@ type TreeGridListenersTypes = {
40488
41129
  /**
40489
41130
  * Fires after a row is rendered.
40490
41131
  * @param {object} event Event object
40491
- * @param {Grid.view.Grid} event.source The firing Grid instance.
40492
- * @param {Grid.row.Row} event.row The row that has been rendered.
40493
- * @param {Core.data.Model} event.record The record for the row.
40494
- * @param {number} event.recordIndex The zero-based index of the record.
41132
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
41133
+ * @param {Grid.row.Row} event.row The row that has been rendered
41134
+ * @param {Core.data.Model} event.record The record for the row
41135
+ * @param {number} event.recordIndex The zero-based index of the record
40495
41136
  */
40496
- renderRow: (event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void
41137
+ renderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
40497
41138
  /**
40498
41139
  * Grid rows have been rendered
40499
41140
  * @param {object} event Event object
40500
- * @param {Grid.view.Grid} event.source This grid.
41141
+ * @param {Grid.view.GridBase} event.source This grid.
40501
41142
  */
40502
- renderRows: (event: { source: Grid }) => void
41143
+ renderRows: (event: { source: GridBase }) => void
40503
41144
  /**
40504
41145
  * Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
40505
41146
  * @param {object} event Event object
@@ -40559,10 +41200,10 @@ type TreeGridListenersTypes = {
40559
41200
  /**
40560
41201
  * Grid has scrolled vertically
40561
41202
  * @param {object} event Event object
40562
- * @param {Grid.view.Grid} event.source The firing Grid instance.
41203
+ * @param {Grid.view.GridBase} event.source The firing Grid instance.
40563
41204
  * @param {number} event.scrollTop The vertical scroll position.
40564
41205
  */
40565
- scroll: (event: { source: Grid, scrollTop: number }) => void
41206
+ scroll: (event: { source: GridBase, scrollTop: number }) => void
40566
41207
  /**
40567
41208
  * The selection has been changed.
40568
41209
  * @param {object} event Event object
@@ -40650,17 +41291,17 @@ type TreeGridListenersTypes = {
40650
41291
  /**
40651
41292
  * Fires after a sub grid is collapsed.
40652
41293
  * @param {object} event Event object
40653
- * @param {Grid.view.Grid} event.source The firing Grid instance
41294
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
40654
41295
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
40655
41296
  */
40656
- subGridCollapse: (event: { source: Grid, subGrid: SubGrid }) => void
41297
+ subGridCollapse: (event: { source: GridBase, subGrid: SubGrid }) => void
40657
41298
  /**
40658
41299
  * Fires after a sub grid is expanded.
40659
41300
  * @param {object} event Event object
40660
- * @param {Grid.view.Grid} event.source The firing Grid instance
41301
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
40661
41302
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
40662
41303
  */
40663
- subGridExpand: (event: { source: Grid, subGrid: SubGrid }) => void
41304
+ subGridExpand: (event: { source: GridBase, subGrid: SubGrid }) => void
40664
41305
  /**
40665
41306
  * Fired when one or more groups are expanded or collapsed
40666
41307
  * @param {object} event Event object
@@ -40753,6 +41394,14 @@ type TreeGridListeners = {
40753
41394
  * @param {any} event.value The value being set
40754
41395
  */
40755
41396
  beforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
41397
+ /**
41398
+ * This event is triggered before a parent column is collapsed or expanded.
41399
+ * @param {object} event Event object
41400
+ * @param {Grid.view.GridBase} event.source The grid instance
41401
+ * @param {Grid.column.Column} event.column The column
41402
+ * @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
41403
+ */
41404
+ beforeColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
40756
41405
  /**
40757
41406
  * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
40758
41407
  * @param {object} event Event object
@@ -40853,18 +41502,18 @@ type TreeGridListeners = {
40853
41502
  /**
40854
41503
  * Fires before a row is rendered.
40855
41504
  * @param {object} event Event object
40856
- * @param {Grid.view.Grid} event.source The firing Grid instance.
40857
- * @param {Grid.row.Row} event.row The row about to be rendered.
40858
- * @param {Core.data.Model} event.record The record for the row.
40859
- * @param {number} event.recordIndex The zero-based index of the record.
41505
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
41506
+ * @param {Grid.row.Row} event.row The row about to be rendered
41507
+ * @param {Core.data.Model} event.record The record for the row
41508
+ * @param {number} event.recordIndex The zero-based index of the record
40860
41509
  */
40861
- beforeRenderRow?: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
41510
+ beforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
40862
41511
  /**
40863
41512
  * Grid rows are about to be rendered
40864
41513
  * @param {object} event Event object
40865
- * @param {Grid.view.Grid} event.source This grid.
41514
+ * @param {Grid.view.GridBase} event.source This grid.
40866
41515
  */
40867
- beforeRenderRows?: ((event: { source: Grid }) => void)|string
41516
+ beforeRenderRows?: ((event: { source: GridBase }) => void)|string
40868
41517
  /**
40869
41518
  * This event fires before row collapse is started.
40870
41519
  * ...
@@ -41095,6 +41744,14 @@ type TreeGridListeners = {
41095
41744
  * @param {Core.data.Model} event.record The record which has been collapsed.
41096
41745
  */
41097
41746
  collapseNode?: ((event: { source: Grid, record: Model }) => void)|string
41747
+ /**
41748
+ * This event is triggered after a parent column has been collapsed or expanded.
41749
+ * @param {object} event Event object
41750
+ * @param {Grid.view.GridBase} event.source The Grid instance
41751
+ * @param {Grid.column.Column} event.column The column being toggled
41752
+ * @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
41753
+ */
41754
+ columnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
41098
41755
  /**
41099
41756
  * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
41100
41757
  * to indicate whether the drop position is valid or not.
@@ -41176,14 +41833,14 @@ type TreeGridListeners = {
41176
41833
  * ...
41177
41834
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-dataChange)
41178
41835
  * @param {object} event Event object
41179
- * @param {Grid.view.Grid} event.source Owning grid
41836
+ * @param {Grid.view.GridBase} event.source Owning grid
41180
41837
  * @param {Core.data.Store} event.store The originating store
41181
41838
  * @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
41182
41839
  * @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
41183
41840
  * @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
41184
41841
  * @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
41185
41842
  */
41186
- dataChange?: ((event: { source: Grid, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
41843
+ dataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
41187
41844
  /**
41188
41845
  * Fires when an object is destroyed.
41189
41846
  * @param {object} event Event object
@@ -41491,18 +42148,18 @@ type TreeGridListeners = {
41491
42148
  /**
41492
42149
  * Fires after a row is rendered.
41493
42150
  * @param {object} event Event object
41494
- * @param {Grid.view.Grid} event.source The firing Grid instance.
41495
- * @param {Grid.row.Row} event.row The row that has been rendered.
41496
- * @param {Core.data.Model} event.record The record for the row.
41497
- * @param {number} event.recordIndex The zero-based index of the record.
42151
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
42152
+ * @param {Grid.row.Row} event.row The row that has been rendered
42153
+ * @param {Core.data.Model} event.record The record for the row
42154
+ * @param {number} event.recordIndex The zero-based index of the record
41498
42155
  */
41499
- renderRow?: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
42156
+ renderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
41500
42157
  /**
41501
42158
  * Grid rows have been rendered
41502
42159
  * @param {object} event Event object
41503
- * @param {Grid.view.Grid} event.source This grid.
42160
+ * @param {Grid.view.GridBase} event.source This grid.
41504
42161
  */
41505
- renderRows?: ((event: { source: Grid }) => void)|string
42162
+ renderRows?: ((event: { source: GridBase }) => void)|string
41506
42163
  /**
41507
42164
  * Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
41508
42165
  * @param {object} event Event object
@@ -41562,10 +42219,10 @@ type TreeGridListeners = {
41562
42219
  /**
41563
42220
  * Grid has scrolled vertically
41564
42221
  * @param {object} event Event object
41565
- * @param {Grid.view.Grid} event.source The firing Grid instance.
42222
+ * @param {Grid.view.GridBase} event.source The firing Grid instance.
41566
42223
  * @param {number} event.scrollTop The vertical scroll position.
41567
42224
  */
41568
- scroll?: ((event: { source: Grid, scrollTop: number }) => void)|string
42225
+ scroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
41569
42226
  /**
41570
42227
  * The selection has been changed.
41571
42228
  * @param {object} event Event object
@@ -41653,17 +42310,17 @@ type TreeGridListeners = {
41653
42310
  /**
41654
42311
  * Fires after a sub grid is collapsed.
41655
42312
  * @param {object} event Event object
41656
- * @param {Grid.view.Grid} event.source The firing Grid instance
42313
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
41657
42314
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
41658
42315
  */
41659
- subGridCollapse?: ((event: { source: Grid, subGrid: SubGrid }) => void)|string
42316
+ subGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
41660
42317
  /**
41661
42318
  * Fires after a sub grid is expanded.
41662
42319
  * @param {object} event Event object
41663
- * @param {Grid.view.Grid} event.source The firing Grid instance
42320
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
41664
42321
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
41665
42322
  */
41666
- subGridExpand?: ((event: { source: Grid, subGrid: SubGrid }) => void)|string
42323
+ subGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
41667
42324
  /**
41668
42325
  * Fired when one or more groups are expanded or collapsed
41669
42326
  * @param {object} event Event object
@@ -41700,6 +42357,7 @@ type TreeGridListeners = {
41700
42357
  }
41701
42358
 
41702
42359
  type TreeGridFeaturesType = {
42360
+ ai: AI
41703
42361
  aiFilter: AIFilter
41704
42362
  cellCopyPaste: CellCopyPaste
41705
42363
  cellEdit: CellEdit
@@ -41743,6 +42401,7 @@ type TreeGridFeaturesType = {
41743
42401
  }
41744
42402
 
41745
42403
  type TreeGridFeaturesConfigType = {
42404
+ ai?: string|boolean|AIConfig
41746
42405
  aiFilter?: string|boolean|AIFilterConfig
41747
42406
  cellCopyPaste?: string|boolean|CellCopyPasteConfig
41748
42407
  cellEdit?: string|boolean|CellEditConfig
@@ -41859,6 +42518,10 @@ type TreeGridConfig = {
41859
42518
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-bodyCls)
41860
42519
  */
41861
42520
  bodyCls?: string|object
42521
+ /**
42522
+ * Set `true` to add a border to this container's element.
42523
+ */
42524
+ border?: boolean
41862
42525
  /**
41863
42526
  * An object where property names with a truthy value indicate which events should bubble up the ownership
41864
42527
  * hierarchy when triggered.
@@ -41910,7 +42573,7 @@ type TreeGridConfig = {
41910
42573
  * ...
41911
42574
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-color)
41912
42575
  */
41913
- color?: string
42576
+ color?: Color
41914
42577
  /**
41915
42578
  * Programmatic control over which column to start in when used in a grid layout.
41916
42579
  */
@@ -42591,6 +43254,14 @@ type TreeGridConfig = {
42591
43254
  * @param {any} event.value The value being set
42592
43255
  */
42593
43256
  onBeforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
43257
+ /**
43258
+ * This event is triggered before a parent column is collapsed or expanded.
43259
+ * @param {object} event Event object
43260
+ * @param {Grid.view.GridBase} event.source The grid instance
43261
+ * @param {Grid.column.Column} event.column The column
43262
+ * @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
43263
+ */
43264
+ onBeforeColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
42594
43265
  /**
42595
43266
  * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
42596
43267
  * @param {object} event Event object
@@ -42691,18 +43362,18 @@ type TreeGridConfig = {
42691
43362
  /**
42692
43363
  * Fires before a row is rendered.
42693
43364
  * @param {object} event Event object
42694
- * @param {Grid.view.Grid} event.source The firing Grid instance.
42695
- * @param {Grid.row.Row} event.row The row about to be rendered.
42696
- * @param {Core.data.Model} event.record The record for the row.
42697
- * @param {number} event.recordIndex The zero-based index of the record.
43365
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
43366
+ * @param {Grid.row.Row} event.row The row about to be rendered
43367
+ * @param {Core.data.Model} event.record The record for the row
43368
+ * @param {number} event.recordIndex The zero-based index of the record
42698
43369
  */
42699
- onBeforeRenderRow?: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
43370
+ onBeforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
42700
43371
  /**
42701
43372
  * Grid rows are about to be rendered
42702
43373
  * @param {object} event Event object
42703
- * @param {Grid.view.Grid} event.source This grid.
43374
+ * @param {Grid.view.GridBase} event.source This grid.
42704
43375
  */
42705
- onBeforeRenderRows?: ((event: { source: Grid }) => void)|string
43376
+ onBeforeRenderRows?: ((event: { source: GridBase }) => void)|string
42706
43377
  /**
42707
43378
  * This event fires before row collapse is started.
42708
43379
  * ...
@@ -42933,6 +43604,14 @@ type TreeGridConfig = {
42933
43604
  * @param {Core.data.Model} event.record The record which has been collapsed.
42934
43605
  */
42935
43606
  onCollapseNode?: ((event: { source: Grid, record: Model }) => void)|string
43607
+ /**
43608
+ * This event is triggered after a parent column has been collapsed or expanded.
43609
+ * @param {object} event Event object
43610
+ * @param {Grid.view.GridBase} event.source The Grid instance
43611
+ * @param {Grid.column.Column} event.column The column being toggled
43612
+ * @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
43613
+ */
43614
+ onColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
42936
43615
  /**
42937
43616
  * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
42938
43617
  * to indicate whether the drop position is valid or not.
@@ -43014,14 +43693,14 @@ type TreeGridConfig = {
43014
43693
  * ...
43015
43694
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-dataChange)
43016
43695
  * @param {object} event Event object
43017
- * @param {Grid.view.Grid} event.source Owning grid
43696
+ * @param {Grid.view.GridBase} event.source Owning grid
43018
43697
  * @param {Core.data.Store} event.store The originating store
43019
43698
  * @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
43020
43699
  * @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
43021
43700
  * @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
43022
43701
  * @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
43023
43702
  */
43024
- onDataChange?: ((event: { source: Grid, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
43703
+ onDataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
43025
43704
  /**
43026
43705
  * Fires when an object is destroyed.
43027
43706
  * @param {object} event Event object
@@ -43329,18 +44008,18 @@ type TreeGridConfig = {
43329
44008
  /**
43330
44009
  * Fires after a row is rendered.
43331
44010
  * @param {object} event Event object
43332
- * @param {Grid.view.Grid} event.source The firing Grid instance.
43333
- * @param {Grid.row.Row} event.row The row that has been rendered.
43334
- * @param {Core.data.Model} event.record The record for the row.
43335
- * @param {number} event.recordIndex The zero-based index of the record.
44011
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
44012
+ * @param {Grid.row.Row} event.row The row that has been rendered
44013
+ * @param {Core.data.Model} event.record The record for the row
44014
+ * @param {number} event.recordIndex The zero-based index of the record
43336
44015
  */
43337
- onRenderRow?: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
44016
+ onRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
43338
44017
  /**
43339
44018
  * Grid rows have been rendered
43340
44019
  * @param {object} event Event object
43341
- * @param {Grid.view.Grid} event.source This grid.
44020
+ * @param {Grid.view.GridBase} event.source This grid.
43342
44021
  */
43343
- onRenderRows?: ((event: { source: Grid }) => void)|string
44022
+ onRenderRows?: ((event: { source: GridBase }) => void)|string
43344
44023
  /**
43345
44024
  * Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
43346
44025
  * @param {object} event Event object
@@ -43400,10 +44079,10 @@ type TreeGridConfig = {
43400
44079
  /**
43401
44080
  * Grid has scrolled vertically
43402
44081
  * @param {object} event Event object
43403
- * @param {Grid.view.Grid} event.source The firing Grid instance.
44082
+ * @param {Grid.view.GridBase} event.source The firing Grid instance.
43404
44083
  * @param {number} event.scrollTop The vertical scroll position.
43405
44084
  */
43406
- onScroll?: ((event: { source: Grid, scrollTop: number }) => void)|string
44085
+ onScroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
43407
44086
  /**
43408
44087
  * The selection has been changed.
43409
44088
  * @param {object} event Event object
@@ -43491,17 +44170,17 @@ type TreeGridConfig = {
43491
44170
  /**
43492
44171
  * Fires after a sub grid is collapsed.
43493
44172
  * @param {object} event Event object
43494
- * @param {Grid.view.Grid} event.source The firing Grid instance
44173
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
43495
44174
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
43496
44175
  */
43497
- onSubGridCollapse?: ((event: { source: Grid, subGrid: SubGrid }) => void)|string
44176
+ onSubGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
43498
44177
  /**
43499
44178
  * Fires after a sub grid is expanded.
43500
44179
  * @param {object} event Event object
43501
- * @param {Grid.view.Grid} event.source The firing Grid instance
44180
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
43502
44181
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
43503
44182
  */
43504
- onSubGridExpand?: ((event: { source: Grid, subGrid: SubGrid }) => void)|string
44183
+ onSubGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
43505
44184
  /**
43506
44185
  * Fired when one or more groups are expanded or collapsed
43507
44186
  * @param {object} event Event object
@@ -44222,6 +44901,10 @@ type ExportDialogConfig = {
44222
44901
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/export/ExportDialog#config-bodyCls)
44223
44902
  */
44224
44903
  bodyCls?: string|object
44904
+ /**
44905
+ * Set `true` to add a border to this container's element.
44906
+ */
44907
+ border?: boolean
44225
44908
  /**
44226
44909
  * An object where property names with a truthy value indicate which events should bubble up the ownership
44227
44910
  * hierarchy when triggered.
@@ -44294,7 +44977,7 @@ type ExportDialogConfig = {
44294
44977
  * ...
44295
44978
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/export/ExportDialog#config-color)
44296
44979
  */
44297
- color?: string
44980
+ color?: Color
44298
44981
  /**
44299
44982
  * Programmatic control over which column to start in when used in a grid layout.
44300
44983
  */
@@ -46322,7 +47005,7 @@ type AIFilterFieldConfig = {
46322
47005
  * ...
46323
47006
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-color)
46324
47007
  */
46325
- color?: string
47008
+ color?: Color
46326
47009
  /**
46327
47010
  * Programmatic control over which column to start in when used in a grid layout.
46328
47011
  */
@@ -47539,7 +48222,7 @@ type ChecklistFilterComboConfig = {
47539
48222
  * ...
47540
48223
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-color)
47541
48224
  */
47542
- color?: string
48225
+ color?: Color
47543
48226
  /**
47544
48227
  * Programmatic control over which column to start in when used in a grid layout.
47545
48228
  */
@@ -48786,7 +49469,7 @@ type GridChartDesignerConfig = {
48786
49469
  * ...
48787
49470
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridChartDesigner#config-color)
48788
49471
  */
48789
- color?: string
49472
+ color?: Color
48790
49473
  /**
48791
49474
  * Programmatic control over which column to start in when used in a grid layout.
48792
49475
  */
@@ -49656,6 +50339,10 @@ type GridFieldFilterPickerConfig = {
49656
50339
  * Update assigned [record](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-record) automatically on field changes
49657
50340
  */
49658
50341
  autoUpdateRecord?: boolean
50342
+ /**
50343
+ * Set `true` to add a border to this container's element.
50344
+ */
50345
+ border?: boolean
49659
50346
  /**
49660
50347
  * An object where property names with a truthy value indicate which events should bubble up the ownership
49661
50348
  * hierarchy when triggered.
@@ -49695,7 +50382,7 @@ type GridFieldFilterPickerConfig = {
49695
50382
  * ...
49696
50383
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-color)
49697
50384
  */
49698
- color?: string
50385
+ color?: Color
49699
50386
  /**
49700
50387
  * Programmatic control over which column to start in when used in a grid layout.
49701
50388
  */
@@ -50764,6 +51451,10 @@ type GridFieldFilterPickerGroupConfig = {
50764
51451
  * Update assigned [record](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-record) automatically on field changes
50765
51452
  */
50766
51453
  autoUpdateRecord?: boolean
51454
+ /**
51455
+ * Set `true` to add a border to this container's element.
51456
+ */
51457
+ border?: boolean
50767
51458
  /**
50768
51459
  * An object where property names with a truthy value indicate which events should bubble up the ownership
50769
51460
  * hierarchy when triggered.
@@ -50819,7 +51510,7 @@ type GridFieldFilterPickerGroupConfig = {
50819
51510
  * ...
50820
51511
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-color)
50821
51512
  */
50822
- color?: string
51513
+ color?: Color
50823
51514
  /**
50824
51515
  * Programmatic control over which column to start in when used in a grid layout.
50825
51516
  */
@@ -51966,7 +52657,7 @@ type GroupBarConfig = {
51966
52657
  * ...
51967
52658
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-color)
51968
52659
  */
51969
- color?: string
52660
+ color?: Color
51970
52661
  /**
51971
52662
  * Programmatic control over which column to start in when used in a grid layout.
51972
52663
  */
@@ -53105,7 +53796,7 @@ type TreeComboConfig = {
53105
53796
  * ...
53106
53797
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-color)
53107
53798
  */
53108
- color?: string
53799
+ color?: Color
53109
53800
  /**
53110
53801
  * Programmatic control over which column to start in when used in a grid layout.
53111
53802
  */