@bryntum/grid-react-thin 7.2.4 → 7.3.1

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 (45) hide show
  1. package/README.md +5 -5
  2. package/lib/BryntumAIFilterField.d.ts +9 -16
  3. package/lib/BryntumAIFilterField.js +2 -2
  4. package/lib/BryntumAIFilterField.js.map +1 -1
  5. package/lib/BryntumChecklistFilterCombo.d.ts +12 -19
  6. package/lib/BryntumChecklistFilterCombo.js +2 -2
  7. package/lib/BryntumChecklistFilterCombo.js.map +1 -1
  8. package/lib/BryntumGrid.d.ts +47 -58
  9. package/lib/BryntumGrid.js +2 -2
  10. package/lib/BryntumGrid.js.map +1 -1
  11. package/lib/BryntumGridBase.d.ts +47 -58
  12. package/lib/BryntumGridBase.js +2 -2
  13. package/lib/BryntumGridBase.js.map +1 -1
  14. package/lib/BryntumGridChartDesigner.d.ts +7 -15
  15. package/lib/BryntumGridChartDesigner.js +1 -2
  16. package/lib/BryntumGridChartDesigner.js.map +1 -1
  17. package/lib/BryntumGridFieldFilterPicker.d.ts +8 -15
  18. package/lib/BryntumGridFieldFilterPicker.js +2 -5
  19. package/lib/BryntumGridFieldFilterPicker.js.map +1 -1
  20. package/lib/BryntumGridFieldFilterPickerGroup.d.ts +9 -16
  21. package/lib/BryntumGridFieldFilterPickerGroup.js +2 -5
  22. package/lib/BryntumGridFieldFilterPickerGroup.js.map +1 -1
  23. package/lib/BryntumGroupBar.d.ts +8 -16
  24. package/lib/BryntumGroupBar.js +1 -2
  25. package/lib/BryntumGroupBar.js.map +1 -1
  26. package/lib/BryntumTreeCombo.d.ts +12 -19
  27. package/lib/BryntumTreeCombo.js +2 -2
  28. package/lib/BryntumTreeCombo.js.map +1 -1
  29. package/lib/BryntumTreeGrid.d.ts +47 -58
  30. package/lib/BryntumTreeGrid.js +2 -2
  31. package/lib/BryntumTreeGrid.js.map +1 -1
  32. package/lib/WrapperHelper.js +2 -2
  33. package/lib/WrapperHelper.js.map +1 -1
  34. package/package.json +1 -1
  35. package/src/BryntumAIFilterField.tsx +85 -120
  36. package/src/BryntumChecklistFilterCombo.tsx +102 -151
  37. package/src/BryntumGrid.tsx +229 -316
  38. package/src/BryntumGridBase.tsx +229 -316
  39. package/src/BryntumGridChartDesigner.tsx +60 -96
  40. package/src/BryntumGridFieldFilterPicker.tsx +83 -133
  41. package/src/BryntumGridFieldFilterPickerGroup.tsx +83 -132
  42. package/src/BryntumGroupBar.tsx +67 -107
  43. package/src/BryntumTreeCombo.tsx +103 -153
  44. package/src/BryntumTreeGrid.tsx +229 -316
  45. package/src/WrapperHelper.tsx +2 -2
@@ -3,7 +3,7 @@
3
3
  */
4
4
  // eslint-disable-next-line @typescript-eslint/no-unused-vars
5
5
  import React, { RefObject } from 'react';
6
- import { AjaxStore, AjaxStoreConfig, Base, Color, Container, DomConfig, FormulaProviderConfig, KeyMapConfig, Mask, MaskConfig, Menu, MenuItem, MenuItemEntry, Model, ModelConfig, PagingToolbarConfig, Panel, PanelCollapserConfig, PanelCollapserOverlayConfig, PanelHeader, ScrollManager, ScrollManagerConfig, Scroller, ScrollerConfig, StateProvider, Store, StoreConfig, TabConfig, Tool, ToolConfig, ToolbarConfig, ToolbarItems, TooltipConfig, Widget } from '@bryntum/core-thin';
6
+ import { AjaxStore, AjaxStoreConfig, Base, Color, Container, DomConfig, FormulaProviderConfig, InstancePlugin, KeyMapConfig, Mask, MaskConfig, Menu, MenuItem, MenuItemEntry, Model, ModelConfig, PagingToolbarConfig, Panel, PanelCollapserConfig, PanelCollapserOverlayConfig, PanelHeader, ScrollManager, ScrollManagerConfig, Scroller, ScrollerConfig, StateProvider, Store, StoreConfig, TabConfig, Tool, ToolConfig, ToolbarConfig, ToolbarItems, TooltipConfig, Widget } from '@bryntum/core-thin';
7
7
  import { AI, AIConfig, AIFilter, AIFilterConfig, CellCopyPaste, CellCopyPasteConfig, CellEdit, CellEditConfig, CellEditorContext, CellMenu, CellMenuConfig, CellTooltip, CellTooltipConfig, Charts, ChartsConfig, Column, ColumnAutoWidth, ColumnAutoWidthConfig, ColumnDragToolbar, ColumnDragToolbarConfig, ColumnPicker, ColumnPickerConfig, ColumnRename, ColumnRenameConfig, ColumnReorder, ColumnReorderConfig, ColumnResize, ColumnResizeConfig, ColumnStore, ColumnStoreConfig, GridContainerItemConfig, EmptyTextDomConfig, ExcelExporter, ExcelExporterConfig, ExportConfig, FileDrop, FileDropConfig, FillHandle, FillHandleConfig, Filter, FilterBar, FilterBarConfig, FilterConfig, Grid, GridBase, GridColumnConfig, GridLocation, GridLocationConfig, GridSelectionMode, GridStateInfo, Group, GroupConfig, GroupSummary, GroupSummaryConfig, HeaderMenu, HeaderMenuConfig, LockRows, LockRowsConfig, MergeCells, MergeCellsConfig, PdfExport, PdfExportConfig, PinColumns, PinColumnsConfig, PreserveScrollOptions, Print, PrintConfig, QuickFind, QuickFindConfig, RecordPositionContext, RegionResize, RegionResizeConfig, ResponsiveLevelConfig, Row, RowCopyPaste, RowCopyPasteConfig, RowEdit, RowEditConfig, RowEditorContext, RowExpander, RowExpanderConfig, RowReorder, RowReorderConfig, RowResize, RowResizeConfig, Search, SearchConfig, Sort, SortConfig, Split, SplitConfig, StickyCells, StickyCellsConfig, Stripe, StripeConfig, SubGrid, SubGridConfig, Summary, SummaryConfig, Tree, TreeConfig, TreeGrid, TreeGridListeners, TreeGroup, TreeGroupConfig, XLSColumn } from '@bryntum/grid-thin';
8
8
 
9
9
  import { createWidget, shouldComponentUpdate, processWidgetContent } from './WrapperHelper.js';
@@ -13,8 +13,7 @@ export type BryntumTreeGridProps = {
13
13
  /**
14
14
  * Element (or element id) to adopt as this Widget's encapsulating element. The widget's
15
15
  * content will be placed inside this element.
16
- * ...
17
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-adopt)
16
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-adopt)
18
17
  */
19
18
  adopt? : HTMLElement|string
20
19
  /**
@@ -49,15 +48,13 @@ export type BryntumTreeGridProps = {
49
48
  /**
50
49
  * A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject
51
50
  * into an element which will be linked using the `aria-describedby` attribute.
52
- * ...
53
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-ariaDescription)
51
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-ariaDescription)
54
52
  */
55
53
  ariaDescription? : string
56
54
  /**
57
55
  * A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject as
58
56
  * the `aria-label` attribute.
59
- * ...
60
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-ariaLabel)
57
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-ariaLabel)
61
58
  */
62
59
  ariaLabel? : string
63
60
  /**
@@ -69,14 +66,12 @@ export type BryntumTreeGridProps = {
69
66
  /**
70
67
  * A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/grid/docs/api/Core/widget/Toolbar),
71
68
  * or array of config objects representing the child items of a Toolbar. Another way to add a bbar is to use [strips](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-strips).
72
- * ...
73
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-bbar)
69
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-bbar)
74
70
  */
75
71
  bbar? : (GridContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
76
72
  /**
77
73
  * Custom CSS classes to add to the panel's body element.
78
- * ...
79
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-bodyCls)
74
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-bodyCls)
80
75
  */
81
76
  bodyCls? : string|object
82
77
  /**
@@ -86,21 +81,18 @@ export type BryntumTreeGridProps = {
86
81
  /**
87
82
  * An object where property names with a truthy value indicate which events should bubble up the ownership
88
83
  * hierarchy when triggered.
89
- * ...
90
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-bubbleEvents)
84
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-bubbleEvents)
91
85
  */
92
86
  bubbleEvents? : object
93
87
  /**
94
88
  * Set to `false` to not call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
95
- * ...
96
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-callOnFunctions)
89
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-callOnFunctions)
97
90
  */
98
91
  callOnFunctions? : boolean
99
92
  /**
100
93
  * By default, if an event handler throws an exception, the error propagates up the stack and the
101
94
  * application state is undefined. Code which follows the event handler will *not* be executed.
102
- * ...
103
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-catchEventHandlerExceptions)
95
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-catchEventHandlerExceptions)
104
96
  */
105
97
  catchEventHandlerExceptions? : boolean
106
98
  /**
@@ -113,8 +105,7 @@ export type BryntumTreeGridProps = {
113
105
  * Custom CSS classes to add to element.
114
106
  * May be specified as a space separated string, or as an object in which property names
115
107
  * with truthy values are used as the class names:
116
- * ...
117
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-cls)
108
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-cls)
118
109
  */
119
110
  cls? : string|object
120
111
  /**
@@ -124,15 +115,13 @@ export type BryntumTreeGridProps = {
124
115
  collapsed? : boolean
125
116
  /**
126
117
  * This config enables collapsibility for the panel. See [collapsed](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-collapsed).
127
- * ...
128
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-collapsible)
118
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-collapsible)
129
119
  */
130
120
  collapsible? : boolean|PanelCollapserConfig|PanelCollapserOverlayConfig
131
121
  /**
132
122
  * Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
133
123
  * `style` block.
134
- * ...
135
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-color)
124
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-color)
136
125
  */
137
126
  color? : Color
138
127
  /**
@@ -146,8 +135,7 @@ export type BryntumTreeGridProps = {
146
135
  /**
147
136
  * Accepts column definitions for the grid during initialization. They will be used to create
148
137
  * [Column](https://bryntum.com/products/grid/docs/api/Grid/column/Column) instances that are added to a [ColumnStore](#Grid/data/ColumnStore).
149
- * ...
150
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-columns)
138
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-columns)
151
139
  */
152
140
  columns? : ColumnStore|GridColumnConfig[]|ColumnStoreConfig
153
141
  config? : object
@@ -155,8 +143,7 @@ export type BryntumTreeGridProps = {
155
143
  * Custom CSS classes to add to the [contentElement](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-contentElement).
156
144
  * May be specified as a space separated string, or as an object in which property names
157
145
  * with truthy values are used as the class names:
158
- * ...
159
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-contentElementCls)
146
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-contentElementCls)
160
147
  */
161
148
  contentElementCls? : string|object
162
149
  /**
@@ -168,8 +155,7 @@ export type BryntumTreeGridProps = {
168
155
  * Convenient shortcut to set data in grids store both during initialization and at runtime. Can also be
169
156
  * used to retrieve data at runtime, although we do recommend interacting with Grids store instead using
170
157
  * the [store](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#property-store) property.
171
- * ...
172
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-data)
158
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-data)
173
159
  */
174
160
  data? : object[]|Model[]|ModelConfig[]
175
161
  /**
@@ -190,16 +176,15 @@ export type BryntumTreeGridProps = {
190
176
  */
191
177
  destroyStore? : boolean
192
178
  /**
193
- * Check for CSS compatibility issues when upgrading to v7. Performs the following checks:
194
- * ...
195
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-detectCSSCompatibilityIssues)
179
+ * Check for CSS compatibility and inclusion related issues and try to auto fix them. Performs the following
180
+ * checks:
181
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-detectCSSCompatibilityIssues)
196
182
  */
197
183
  detectCSSCompatibilityIssues? : boolean
198
184
  /**
199
185
  * Disable or enable the widget. It is similar to [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-readOnly) except a disabled widget
200
186
  * cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
201
- * ...
202
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-disabled)
187
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-disabled)
203
188
  */
204
189
  disabled? : boolean|'inert'
205
190
  /**
@@ -219,43 +204,39 @@ export type BryntumTreeGridProps = {
219
204
  * [strips collection](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
220
205
  * `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
221
206
  * body. Such widgets are called "edge strips".
222
- * ...
223
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-dock)
207
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-dock)
224
208
  */
225
209
  dock? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
226
210
  /**
227
211
  * Make this Panel a docked drawer which slides out from one side of the browser viewport by default.
228
- * ...
229
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-drawer)
230
- * @param {'start','left','end','right','top','bottom'} side The side of the viewport to dock the drawer to. * `'start'` means the `inline-start` side. * `'end'` means the `inline-end` side.
231
- * @param {string,number} size The size of the drawer in its collapsible axis.
232
- * @param {boolean} inline If using the [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-appendTo) config to place the drawer inside a host widget, this may be set to `true` to make the drawer inline within that host. Note that, if using this, the layout of the host element must have `flex-direction` set appropriately.
233
- * @param {boolean,object} autoClose Specifies what user actions should automatically close the drawer. Defaults to closing when the user clicks outside of the drawer or when focus moves outside of the drawer.
234
- * @param {boolean,string} autoClose.mousedown If the user clicks outside of the drawer, the drawer will automatically be hidden. If the value is a string, it is used as a CSS selector to filter clicks which should close the drawer.
235
- * @param {boolean,string} autoClose.focusout If focus moves outside of the drawer, the drawer will automatically be hidden.
236
- * @param {string} autoClose.mouseout Hides the drawer when the mouse leaves the drawer after the `autoCloseDelay` period.
237
- * @param {number} autoCloseDelay When using `mouseout`, this is the delay in milliseconds
238
- */
239
- drawer? : boolean|{side?: 'start'|'left'|'end'|'right'|'top'|'bottom', size?: string|number, inline?: boolean, autoClose: { mousedown?: boolean|string, focusout?: boolean|string, mouseout?: string }, autoCloseDelay?: number}
212
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-drawer)
213
+ * @param {'start','left','end','right','top','bottom'} [side] The side of the viewport to dock the drawer to. * `'start'` means the `inline-start` side. * `'end'` means the `inline-end` side.
214
+ * @param {string,number} [size] The size of the drawer in its collapsible axis.
215
+ * @param {boolean} [inline] If using the [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-appendTo) config to place the drawer inside a host widget, this may be set to `true` to make the drawer inline within that host. Note that, if using this, the layout of the host element must have `flex-direction` set appropriately.
216
+ * @param {boolean,object} [autoClose] Specifies what user actions should automatically close the drawer. Defaults to closing when the user clicks outside of the drawer or when focus moves outside of the drawer.
217
+ * @param {boolean,string} [autoClose.mousedown] If the user clicks outside of the drawer, the drawer will automatically be hidden. If the value is a string, it is used as a CSS selector to filter clicks which should close the drawer.
218
+ * @param {boolean,string} [autoClose.focusout] If focus moves outside of the drawer, the drawer will automatically be hidden.
219
+ * @param {string} [autoClose.mouseout] Hides the drawer when the mouse leaves the drawer after the `autoCloseDelay` period.
220
+ * @param {number} [autoCloseDelay] When using `mouseout`, this is the delay in milliseconds
221
+ */
222
+ drawer? : boolean|{ side?: 'start'|'left'|'end'|'right'|'top'|'bottom', size?: string|number, inline?: boolean, autoClose?: boolean|{ mousedown?: boolean|string, focusout?: boolean|string, mouseout?: string }, autoCloseDelay?: number }
240
223
  /**
241
224
  * An object specifying attributes to assign to the root element of this widget.
242
225
  * Set `null` value to attribute to remove it.
243
- * ...
244
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-elementAttributes)
226
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-elementAttributes)
245
227
  */
246
228
  elementAttributes? : Record<string, string|null>
247
229
  /**
248
230
  * Text or HTML, or a [EmptyTextDomConfig](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#typedef-EmptyTextDomConfig) block to display when there is no data to display in the grid.
249
231
  * When using multiple Grid regions, provide the `region` property to decide where the text is shown.
250
232
  * By default, it is shown in the first region.
251
- * ...
252
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-emptyText)
233
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-emptyText)
253
234
  */
254
235
  emptyText? : string|EmptyTextDomConfig
255
236
  /**
256
- * Configure this as `true` to allow elements within cells to be styled as `position: sticky`.
257
- * ...
258
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-enableSticky)
237
+ * Set to `true` to enable the [StickyCells](https://bryntum.com/products/grid/docs/api/Grid/feature/StickyCells) feature, which pins cell
238
+ * content to the top of the grid while rows scroll off the top but remain visible.
239
+ * @deprecated 7.3.0 Use `features : { stickyCells : true }` instead
259
240
  */
260
241
  enableSticky? : boolean
261
242
  /**
@@ -279,8 +260,7 @@ export type BryntumTreeGridProps = {
279
260
  * Use fixed row height. Setting this to `true` will configure the underlying RowManager to use fixed row
280
261
  * height, which sacrifices the ability to use rows with variable height to gain a fraction better
281
262
  * performance.
282
- * ...
283
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-fixedRowHeight)
263
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-fixedRowHeight)
284
264
  */
285
265
  fixedRowHeight? : boolean
286
266
  /**
@@ -294,41 +274,35 @@ export type BryntumTreeGridProps = {
294
274
  /**
295
275
  * Config object of a footer. May contain a `dock`, `html` and a `cls` property. A footer is not a widget,
296
276
  * but rather plain HTML that follows the last element of the panel's body and [strips](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-strips).
297
- * ...
298
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-footer)
277
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-footer)
278
+ * @property {'top','right','bottom','left','start','end'} dock Where to dock
279
+ * @property {string} html Html to populate the footer with
280
+ * @property {string} cls CSS class to add to the footer
299
281
  */
300
- footer? : {
301
- dock?: 'top'|'right'|'bottom'|'left'|'start'|'end'
302
- html?: string
303
- cls?: string
304
- }|string
282
+ footer? : object|string
305
283
  /**
306
284
  * An object which names formula prefixes which will be applied to all columns configured with
307
285
  * `formula : true`.
308
- * ...
309
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-formulaProviders)
286
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-formulaProviders)
310
287
  */
311
288
  formulaProviders? : Record<string, FormulaProviderConfig>
312
289
  /**
313
290
  * Refresh entire row when a record changes (`true`) or, if possible, only the cells affected (`false`).
314
- * ...
315
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-fullRowRefresh)
291
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-fullRowRefresh)
316
292
  */
317
293
  fullRowRefresh? : boolean
318
294
  /**
319
295
  * A function called for each row to determine its height. It is passed a [record](https://bryntum.com/products/grid/docs/api/Core/data/Model) and
320
296
  * expected to return the desired height of that records row. If the function returns a falsy value, Grids
321
297
  * configured [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-rowHeight) is used.
322
- * ...
323
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-getRowHeight)
298
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-getRowHeight)
324
299
  * @param {Core.data.Model} getRowHeight.record Record to determine row height for
325
300
  * @returns {number} Desired row height
326
301
  */
327
- getRowHeight? : (getRowHeight: { record: Model }) => number
302
+ getRowHeight? : () => number
328
303
  /**
329
304
  * A config [object](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#typedef-PanelHeader) for the panel's header or a string in place of a `title`.
330
- * ...
331
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-header)
305
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-header)
332
306
  */
333
307
  header? : string|boolean|PanelHeader
334
308
  /**
@@ -368,16 +342,14 @@ export type BryntumTreeGridProps = {
368
342
  id? : string
369
343
  /**
370
344
  * Determines if the widgets read-only state should be controlled by its parent.
371
- * ...
372
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-ignoreParentReadOnly)
345
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-ignoreParentReadOnly)
373
346
  */
374
347
  ignoreParentReadOnly? : boolean
375
348
  /**
376
349
  * Convenience setting to align input fields of child widgets. By default, the Field input element is
377
350
  * placed immediately following the `label`. If you prefer to have all input fields aligned to the
378
351
  * right, set this config to `'end'`.
379
- * ...
380
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-inputFieldAlign)
352
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-inputFieldAlign)
381
353
  */
382
354
  inputFieldAlign? : 'start'|'end'
383
355
  /**
@@ -394,14 +366,17 @@ export type BryntumTreeGridProps = {
394
366
  keyMap? : Record<string, KeyMapConfig>
395
367
  /**
396
368
  * Convenience setting to use same label placement on all child widgets.
397
- * ...
398
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-labelPosition)
369
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-labelPosition)
399
370
  */
400
371
  labelPosition? : 'before'|'above'|'align-before'|'auto'|null
372
+ /**
373
+ * Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
374
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-labelWidth)
375
+ */
376
+ labelWidth? : number|null
401
377
  /**
402
378
  * The listener set for this object.
403
- * ...
404
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-listeners)
379
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-listeners)
405
380
  */
406
381
  listeners? : TreeGridListeners
407
382
  /**
@@ -414,15 +389,13 @@ export type BryntumTreeGridProps = {
414
389
  * when data is loading. The message and optional configuration from the
415
390
  * [loadMask](https://bryntum.com/products/grid/docs/api/Core/mixin/LoadMaskable#config-loadMask) config take priority over these options, just as they do
416
391
  * for `maskDefaults`, respectively.
417
- * ...
418
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-loadMaskDefaults)
392
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-loadMaskDefaults)
419
393
  */
420
394
  loadMaskDefaults? : MaskConfig
421
395
  /**
422
396
  * A [Mask](https://bryntum.com/products/grid/docs/api/Core/widget/Mask) config object to adjust the [maskDefaults](#Core/widget/Widget#config-maskDefaults)
423
397
  * when an error occurs loading data.
424
- * ...
425
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-loadMaskError)
398
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-loadMaskError)
426
399
  */
427
400
  loadMaskError? : MaskConfig|Mask|boolean
428
401
  /**
@@ -460,8 +433,7 @@ export type BryntumTreeGridProps = {
460
433
  /**
461
434
  * Grid's `min-height`. Defaults to `10em` to be sure that the Grid always has a height wherever it is
462
435
  * inserted.
463
- * ...
464
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-minHeight)
436
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-minHeight)
465
437
  */
466
438
  minHeight? : string|number
467
439
  /**
@@ -476,7 +448,7 @@ export type BryntumTreeGridProps = {
476
448
  /**
477
449
  * Specify plugins (an array of classes) in config
478
450
  */
479
- plugins? : Function[]
451
+ plugins? : InstancePlugin[]|InstancePlugin
480
452
  /**
481
453
  * True to preserve focused cell after loading new data
482
454
  */
@@ -498,54 +470,61 @@ export type BryntumTreeGridProps = {
498
470
  preventTooltipOnTouch? : boolean
499
471
  /**
500
472
  * Set to `true` to make the grid read-only, by disabling any UIs for modifying data.
501
- * ...
502
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-readOnly)
473
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-readOnly)
503
474
  */
504
475
  readOnly? : boolean
505
476
  relayStoreEvents? : boolean
506
477
  /**
507
478
  * Either a default `rendition` to apply to all child widgets, or a map of renditions keyed by child widget
508
479
  * `type`.
509
- * ...
510
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-rendition)
480
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-rendition)
511
481
  */
512
482
  rendition? : string|Record<string, string>|null
513
483
  /**
514
484
  * Configure this property to allow the widget/component to be resized. Pressing <kbd>Shift</kbd> while resizing will
515
485
  * constrain the aspect ratio.
516
- * ...
517
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-resizable)
518
- */
519
- resizable? : boolean|{
520
- minWidth?: number
521
- maxWidth?: number
522
- minHeight?: number
523
- maxHeight?: number
524
- handles?: object
525
- }
486
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-resizable)
487
+ * @property {number} [resizable.minWidth] The minimum width of the element.
488
+ * @property {number} [resizable.maxWidth] The maximum width of the element.
489
+ * @property {number} [resizable.minHeight] The minimum height of the element.
490
+ * @property {number} [resizable.maxHeight] The maximum height of the element
491
+ * @property {object} [resizable.handles] An object controlling which edges/corners are resizable.
492
+ * @property {boolean} [resizable.handles.topStart] Resizable from top-start corner
493
+ * @property {boolean} [resizable.handles.top] Resizable from top edge
494
+ * @property {boolean} [resizable.handles.topEnd] Resizable from top-end corner
495
+ * @property {boolean} [resizable.handles.end] Resizable from end edge
496
+ * @property {boolean} [resizable.handles.bottomEnd] Resizable from bottom-end corner
497
+ * @property {boolean} [resizable.handles.bottom] Resizable from bottom edge
498
+ * @property {boolean} [resizable.handles.bottomStart] Resizable from bottom-start corner
499
+ * @property {boolean} [resizable.handles.start] Resizable from start edge
500
+ */
501
+ resizable? : boolean|{ minWidth?: number, maxWidth?: number, minHeight?: number, maxHeight?: number, handles?: { topStart?: boolean, top?: boolean, topEnd?: boolean, end?: boolean, bottomEnd?: boolean, bottom?: boolean, bottomStart?: boolean, start?: boolean } }
526
502
  /**
527
503
  * Set to `false` to only measure cell contents when double-clicking the edge between column headers.
528
504
  */
529
505
  resizeToFitIncludesHeader? : boolean
530
506
  /**
531
507
  * "Break points" for which responsive config to use for columns and css.
532
- * ...
533
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-responsiveLevels)
508
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-responsiveLevels)
534
509
  */
535
510
  responsiveLevels? : Record<string, number|string|ResponsiveLevelConfig>
536
511
  /**
537
512
  * Configure as `true` to have the component display a translucent ripple when its
538
513
  * [focusElement](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-focusElement), or [element](#Core/widget/Widget#property-element) is tapped <em>if the
539
514
  * current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
540
- * ...
541
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-ripple)
542
- */
543
- ripple? : boolean|{
544
- delegate?: string
545
- color?: string
546
- radius?: number
547
- clip?: string
548
- }
515
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-ripple)
516
+ * @property {string} [delegate] A CSS selector to filter which child elements trigger ripples. By default, the ripple is clipped to the triggering element.
517
+ * @property {string} [color] A CSS color name or specification.
518
+ * @property {number} [radius] The ending radius of the ripple. Note that it will be clipped by the target element by default.
519
+ * @property {string} [clip] A string which describes how to clip the ripple if it is not to be clipped to the default element. Either the property of the widget to use as the clipping element, or a selector to allow clipping to the closest matching ancestor to the target element.
520
+ */
521
+ ripple? : boolean|object
522
+ /**
523
+ * The ARIA role to apply to this widget's element. By default, this is set to `'presentation'` to avoid
524
+ * accidentally applying a role which may interfere with screen readers.
525
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-role)
526
+ */
527
+ role? : string
549
528
  /**
550
529
  * If you are rendering this widget to a shadow root inside a web component, set this config to the shadowRoot. If not inside a web component, set it to `document.body`
551
530
  */
@@ -554,8 +533,7 @@ export type BryntumTreeGridProps = {
554
533
  * Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
555
534
  * overridden by specifying a [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
556
535
  * a column [renderer](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-renderer).
557
- * ...
558
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-rowHeight)
536
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-rowHeight)
559
537
  */
560
538
  rowHeight? : number
561
539
  /**
@@ -564,15 +542,13 @@ export type BryntumTreeGridProps = {
564
542
  rowLines? : boolean
565
543
  /**
566
544
  * This may be configured as `true` to make the widget's element use the `direction:rtl` style.
567
- * ...
568
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-rtl)
545
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-rtl)
569
546
  */
570
547
  rtl? : boolean
571
548
  /**
572
549
  * Configures whether the grid is scrollable in the `Y` axis. This is used to configure a [Scroller](https://bryntum.com/products/grid/docs/api/Core/helper/util/Scroller).
573
550
  * See the [scrollerClass](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-scrollerClass) config option.
574
- * ...
575
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-scrollable)
551
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-scrollable)
576
552
  */
577
553
  scrollable? : boolean|ScrollerConfig|Scroller
578
554
  /**
@@ -587,141 +563,122 @@ export type BryntumTreeGridProps = {
587
563
  /**
588
564
  * Selection configuration settings, change these properties to control how selection works and what can be
589
565
  * selected.
590
- * ...
591
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-selectionMode)
566
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-selectionMode)
592
567
  */
593
568
  selectionMode? : GridSelectionMode
594
569
  /**
595
570
  * Configure as `true` to have the grid show a red "changed" tag in cells whose
596
571
  * field value has changed and not yet been committed.
597
- * ...
598
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-showDirty)
572
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-showDirty)
573
+ * @property {boolean} showDirty.duringEdit Set to `true` to show the red tag while editing a cell
574
+ * @property {boolean} showDirty.newRecord Set to `true` to show the red tag for all the cells of the new record
599
575
  */
600
- showDirty? : boolean|{
601
- duringEdit?: boolean
602
- newRecord?: boolean
603
- }
576
+ showDirty? : boolean|{ duringEdit: boolean, newRecord: boolean }
604
577
  /**
605
578
  * Programmatic control over how many columns to span when used in a grid layout.
606
579
  */
607
580
  span? : number
608
581
  /**
609
582
  * This value can be one of the following:
610
- * ...
611
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-stateful)
583
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-stateful)
612
584
  */
613
585
  stateful? : boolean|object|string[]
614
586
  /**
615
587
  * The events that, when fired by this component, should trigger it to save its state by calling
616
588
  * [saveState](https://bryntum.com/products/grid/docs/api/Core/mixin/State#function-saveState).
617
- * ...
618
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-statefulEvents)
589
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-statefulEvents)
619
590
  */
620
591
  statefulEvents? : object|string[]
621
592
  /**
622
593
  * The key to use when saving this object's state in the [stateProvider](https://bryntum.com/products/grid/docs/api/Core/mixin/State#config-stateProvider). If this config is
623
594
  * not assigned, and [stateful](https://bryntum.com/products/grid/docs/api/Core/mixin/State#config-stateful) is not set to `false`, the [id](#Core/widget/Widget#config-id)
624
595
  * (if explicitly specified) will be used as the `stateId`.
625
- * ...
626
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-stateId)
596
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-stateId)
627
597
  */
628
598
  stateId? : string
629
599
  /**
630
600
  * The `StateProvider` to use to save and restore this object's [state](https://bryntum.com/products/grid/docs/api/Core/mixin/State#property-state). By default, `state`
631
601
  * will be saved using the [default state provider](https://bryntum.com/products/grid/docs/api/Core/state/StateProvider#property-instance-static).
632
- * ...
633
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-stateProvider)
602
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-stateProvider)
634
603
  */
635
604
  stateProvider? : StateProvider
636
605
  /**
637
606
  * The properties of this settings object controls how grid is restored from state data.
638
- * ...
639
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-stateSettings)
607
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-stateSettings)
608
+ * @property {boolean} [restoreUnconfiguredColumns] Determines whether to restore columns from the state that are not explicitly defined in the grid configuration.
640
609
  */
641
- stateSettings? : {
642
- restoreUnconfiguredColumns?: boolean
643
- }
610
+ stateSettings? : object
644
611
  /**
645
612
  * The store instance or config object that holds the records to be displayed by this TreeGrid. If assigning
646
613
  * a store instance, it must be configured with `tree: true`.
647
- * ...
648
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-store)
614
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-store)
649
615
  */
650
616
  store? : Store|StoreConfig
651
617
  /**
652
618
  * An object containing widgets keyed by name. By default (when no `type` is given), strips are
653
619
  * [toolbars](https://bryntum.com/products/grid/docs/api/Core/widget/Toolbar). If you want to pass an array, you can use
654
620
  * the toolbar's [items](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-items).
655
- * ...
656
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-strips)
621
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-strips)
657
622
  */
658
623
  strips? : Record<string, GridContainerItemConfig>
659
624
  /**
660
625
  * An object containing sub grid configuration objects keyed by a `region` property.
661
626
  * By default, grid has a 'locked' region (if configured with locked columns) and a 'normal' region.
662
627
  * The 'normal' region defaults to use `flex: 1`.
663
- * ...
664
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-subGridConfigs)
628
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-subGridConfigs)
665
629
  */
666
630
  subGridConfigs? : Record<string, SubGridConfig>
667
631
  /**
668
632
  * A [Mask](https://bryntum.com/products/grid/docs/api/Core/widget/Mask) config object, or a message to be shown when Crud Manager
669
633
  * is persisting changes on the server. Set to `null` to disable default sync mask.
670
- * ...
671
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-syncMask)
634
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-syncMask)
672
635
  */
673
636
  syncMask? : string|MaskConfig|null
674
637
  /**
675
638
  * A configuration for the [tab](https://bryntum.com/products/grid/docs/api/Core/widget/Tab) created for this widget when it is placed in a
676
639
  * [TabPanel](https://bryntum.com/products/grid/docs/api/Core/widget/TabPanel). For example, this config can be used to control the icon of the `tab` for
677
640
  * this widget:
678
- * ...
679
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-tab)
641
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-tab)
680
642
  */
681
643
  tab? : boolean|TabConfig
682
644
  /**
683
645
  * When this container is used as a tab in a TabPanel, these items are added to the
684
646
  * [TabBar](https://bryntum.com/products/grid/docs/api/Core/widget/TabBar) when this container is the active tab.
685
- * ...
686
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-tabBarItems)
647
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-tabBarItems)
687
648
  */
688
649
  tabBarItems? : ToolbarItems[]|Widget[]
689
650
  /**
690
651
  * A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/grid/docs/api/Core/widget/Toolbar),
691
652
  * or array of config objects representing the child items of a Toolbar.
692
653
  * This creates a toolbar docked to the top of the panel immediately below the header.
693
- * ...
694
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-tbar)
654
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-tbar)
695
655
  */
696
656
  tbar? : (GridContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
697
657
  /**
698
658
  * A title to display in the header or owning TabPanel. Causes creation and docking of a header
699
659
  * to the top if no header is configured.
700
- * ...
701
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-title)
660
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-title)
702
661
  */
703
662
  title? : string
704
663
  /**
705
664
  * The [tools](https://bryntum.com/products/grid/docs/api/Core/widget/Tool) to add either before or after the `title` in the Panel header. Each
706
665
  * property name is the reference by which an instantiated tool may be retrieved from the live
707
666
  * `[tools](https://bryntum.com/products/grid/docs/api/Core/widget/mixin/Toolable#property-tools)` property.
708
- * ...
709
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-tools)
667
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-tools)
710
668
  */
711
669
  tools? : Record<string, ToolConfig>|null
712
670
  /**
713
671
  * Configure UI transitions for various actions in the grid.
672
+ * @property {boolean} insertRecord Transition record insertions
673
+ * @property {boolean} removeRecord Transition record removals
674
+ * @property {boolean} toggleColumn Transition column visibility changes
675
+ * @property {boolean} expandCollapseColumn Transition parent/group column expand/collapse
676
+ * @property {boolean} toggleRegion Transition region expand/collapse
677
+ * @property {boolean} toggleTreeNode Transition tree node expand/collapse
678
+ * @property {boolean} toggleGroup Transition group expand/collapse
679
+ * @property {boolean} filterRemoval Transition row removals caused by filtering (under specific conditions)
714
680
  */
715
- transition? : {
716
- insertRecord?: boolean
717
- removeRecord?: boolean
718
- toggleColumn?: boolean
719
- expandCollapseColumn?: boolean
720
- toggleRegion?: boolean
721
- toggleTreeNode?: boolean
722
- toggleGroup?: boolean
723
- filterRemoval?: boolean
724
- }
681
+ transition? : object
725
682
  /**
726
683
  * Animation transition duration in milliseconds.
727
684
  */
@@ -731,8 +688,7 @@ export type BryntumTreeGridProps = {
731
688
  * Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
732
689
  * as a space separated string, an array of strings, or as an object in which property names with truthy
733
690
  * values are used as the class names.
734
- * ...
735
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-ui)
691
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-ui)
736
692
  */
737
693
  ui? : 'plain'|'toolbar'|string|object
738
694
  /**
@@ -754,11 +710,10 @@ export type BryntumTreeGridProps = {
754
710
  * @param {Grid.view.Grid} event.source Owner grid
755
711
  * @param {Grid.util.GridLocation} event.editorContext Editing context
756
712
  */
757
- onBeforeCancelCellEdit? : ((event: { source: Grid, editorContext: GridLocation }) => Promise<boolean>|boolean|void)|string
713
+ onBeforeCancelCellEdit? : ((event: { source: Grid, editorContext: GridLocation }) => boolean|void)|string
758
714
  /**
759
715
  * Fires on the owning Grid before the row editing is canceled, return false to signal that the value is invalid and editing should not be finalized.
760
- * ...
761
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-beforeCancelRowEdit)
716
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-beforeCancelRowEdit)
762
717
  * @param {object} event Event object
763
718
  * @param {Grid.view.Grid} event.grid Target grid
764
719
  * @param {RowEditorContext} event.editorContext Editing context
@@ -770,7 +725,7 @@ export type BryntumTreeGridProps = {
770
725
  * @param {Grid.view.Grid} event.source Owner grid
771
726
  * @param {CellEditorContext} event.editorContext Editing context
772
727
  */
773
- onBeforeCellEditStart? : ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
728
+ onBeforeCellEditStart? : ((event: { source: Grid, editorContext: CellEditorContext }) => boolean|void)|string
774
729
  /**
775
730
  * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
776
731
  * buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
@@ -778,7 +733,7 @@ export type BryntumTreeGridProps = {
778
733
  * @param {Grid.view.Grid} event.source Owner grid
779
734
  * @param {(Grid.util.GridLocation|Core.data.Model)[]} event.gridSelection An array of cell selectors or records that will have their values deleted (the records themselves will not get deleted, only visible column values).
780
735
  */
781
- onBeforeCellRangeDelete? : ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => Promise<boolean>|boolean|void)|string
736
+ onBeforeCellRangeDelete? : ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void)|string
782
737
  /**
783
738
  * Fires for each selected record on the owning Grid before editing a range of selected cell values
784
739
  * @param {object} event Event object
@@ -786,7 +741,7 @@ export type BryntumTreeGridProps = {
786
741
  * @param {string} event.field The field being changed
787
742
  * @param {any} event.value The value being set
788
743
  */
789
- onBeforeCellRangeEdit? : ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
744
+ onBeforeCellRangeEdit? : ((event: { record: Model, field: string, value: any }) => boolean|void)|string
790
745
  /**
791
746
  * This event is triggered before a parent column is collapsed or expanded.
792
747
  * @param {object} event Event object
@@ -802,7 +757,7 @@ export type BryntumTreeGridProps = {
802
757
  * @param {Grid.column.Column} event.column The dragged column.
803
758
  * @param {Event} event.event The browser event.
804
759
  */
805
- onBeforeColumnDragStart? : ((event: { source: Grid, column: Column, event: Event }) => Promise<boolean>|boolean|void)|string
760
+ onBeforeColumnDragStart? : ((event: { source: Grid, column: Column, event: Event }) => boolean|void)|string
806
761
  /**
807
762
  * This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
808
763
  * @param {object} event Event object
@@ -813,7 +768,7 @@ export type BryntumTreeGridProps = {
813
768
  * @param {Event} event.event The browser event.
814
769
  * @param {string} event.region The region where the column was dropped.
815
770
  */
816
- onBeforeColumnDropFinalize? : ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => Promise<boolean>|boolean|void)|string
771
+ onBeforeColumnDropFinalize? : ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void)|string
817
772
  /**
818
773
  * This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
819
774
  * `false`.
@@ -822,7 +777,7 @@ export type BryntumTreeGridProps = {
822
777
  * @param {Grid.column.Column} event.column The column
823
778
  * @param {Event} event.domEvent The browser event
824
779
  */
825
- onBeforeColumnResize? : ((event: { source: Grid, column: Column, domEvent: Event }) => Promise<boolean>|boolean|void)|string
780
+ onBeforeColumnResize? : ((event: { source: Grid, column: Column, domEvent: Event }) => boolean|void)|string
826
781
  /**
827
782
  * Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
828
783
  * @param {object} event Event object
@@ -842,7 +797,7 @@ export type BryntumTreeGridProps = {
842
797
  * @param {string} event.lineDelimiter The CSV delimiter to separate lines
843
798
  * @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
844
799
  */
845
- onBeforeCSVExport? : ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => Promise<boolean>|boolean|void)|string
800
+ onBeforeCSVExport? : ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void)|string
846
801
  /**
847
802
  * Fires before an object is destroyed.
848
803
  * @param {object} event Event object
@@ -856,14 +811,14 @@ export type BryntumTreeGridProps = {
856
811
  * @param {XLSColumn[]} event.columns An array of columns to export
857
812
  * @param {any[][]} event.rows An array of records to export
858
813
  */
859
- onBeforeExcelExport? : ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => Promise<boolean>|boolean|void)|string
814
+ onBeforeExcelExport? : ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void)|string
860
815
  /**
861
816
  * Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
862
817
  * @param {object} event Event object
863
818
  * @param {Grid.util.GridLocation} event.cell Information about the column / record
864
819
  * @param {MouseEvent} event.domEvent The raw DOM event
865
820
  */
866
- onBeforeFillHandleDragStart? : ((event: { cell: GridLocation, domEvent: MouseEvent }) => Promise<boolean>|boolean|void)|string
821
+ onBeforeFillHandleDragStart? : ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
867
822
  /**
868
823
  * Fires on the owning Grid before the cell editing is finished, return false to signal that the value is invalid and editing should not be finalized.
869
824
  * @param {object} event Event object
@@ -873,8 +828,7 @@ export type BryntumTreeGridProps = {
873
828
  onBeforeFinishCellEdit? : ((event: { grid: Grid, editorContext: CellEditorContext }) => void)|string
874
829
  /**
875
830
  * Fires on the owning Grid before the row editing is finished, return false to signal that the value is invalid and editing should not be finalized.
876
- * ...
877
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-beforeFinishRowEdit)
831
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-beforeFinishRowEdit)
878
832
  * @param {object} event Event object
879
833
  * @param {Grid.view.Grid} event.grid Target grid
880
834
  * @param {RowEditorContext} event.editorContext Editing context
@@ -885,7 +839,7 @@ export type BryntumTreeGridProps = {
885
839
  * @param {object} event Event object
886
840
  * @param {Core.widget.Widget} event.source The widget being hidden.
887
841
  */
888
- onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
842
+ onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
889
843
  /**
890
844
  * Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
891
845
  * @param {object} event Event object
@@ -901,7 +855,7 @@ export type BryntumTreeGridProps = {
901
855
  * @param {object} event Event object
902
856
  * @param {PdfExportConfig} event.config Export config
903
857
  */
904
- onBeforePdfExport? : ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
858
+ onBeforePdfExport? : ((event: { config: PdfExportConfig }) => boolean|void)|string
905
859
  /**
906
860
  * Fires before a row is rendered.
907
861
  * @param {object} event Event object
@@ -919,16 +873,14 @@ export type BryntumTreeGridProps = {
919
873
  onBeforeRenderRows? : ((event: { source: GridBase }) => void)|string
920
874
  /**
921
875
  * This event fires before row collapse is started.
922
- * ...
923
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-beforeRowCollapse)
876
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-beforeRowCollapse)
924
877
  * @param {object} event Event object
925
878
  * @param {Core.data.Model} event.record Record
926
879
  */
927
880
  onBeforeRowCollapse? : ((event: { record: Model }) => Promise<boolean>|boolean|void)|string
928
881
  /**
929
882
  * This event fires before row expand is started.
930
- * ...
931
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-beforeRowExpand)
883
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-beforeRowExpand)
932
884
  * @param {object} event Event object
933
885
  * @param {Core.data.Model} event.record Record
934
886
  */
@@ -946,7 +898,7 @@ export type BryntumTreeGridProps = {
946
898
  * @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
947
899
  * @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
948
900
  */
949
- onBeforeSelectionChange? : ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => Promise<boolean>|boolean|void)|string
901
+ onBeforeSelectionChange? : ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => boolean|void)|string
950
902
  /**
951
903
  * Fired before this container will load record values into its child fields. This is useful if you
952
904
  * want to modify the UI before data is loaded (e.g. set some input field to be readonly)
@@ -967,19 +919,19 @@ export type BryntumTreeGridProps = {
967
919
  * @param {Grid.view.Grid} event.source Owner grid
968
920
  * @param {RowEditorContext} event.editorContext Editing context
969
921
  */
970
- onBeforeStartRowEdit? : ((event: { source: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string
922
+ onBeforeStartRowEdit? : ((event: { source: Grid, editorContext: RowEditorContext }) => boolean|void)|string
971
923
  /**
972
924
  * Fired before state is applied to the source. Allows editing the state object or preventing the operation.
973
925
  * @param {object} event Event object
974
926
  * @param {GridStateInfo} event.state State object config
975
927
  */
976
- onBeforeStateApply? : ((event: { state: GridStateInfo }) => Promise<boolean>|boolean|void)|string
928
+ onBeforeStateApply? : ((event: { state: GridStateInfo }) => boolean|void)|string
977
929
  /**
978
930
  * Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
979
931
  * @param {object} event Event object
980
932
  * @param {GridStateInfo} event.state State object config
981
933
  */
982
- onBeforeStateSave? : ((event: { state: GridStateInfo }) => Promise<boolean>|boolean|void)|string
934
+ onBeforeStateSave? : ((event: { state: GridStateInfo }) => boolean|void)|string
983
935
  /**
984
936
  * Fired when a group is going to be expanded or collapsed using the UI.
985
937
  * Returning `false` from a listener prevents the operation
@@ -989,7 +941,7 @@ export type BryntumTreeGridProps = {
989
941
  * @param {boolean} event.collapse Collapsed (true) or expanded (false)
990
942
  * @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
991
943
  */
992
- onBeforeToggleGroup? : ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => Promise<boolean>|boolean|void)|string
944
+ onBeforeToggleGroup? : ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void)|string
993
945
  /**
994
946
  * Fired before a parent node record toggles its collapsed state.
995
947
  * @param {object} event Event object
@@ -1008,8 +960,7 @@ export type BryntumTreeGridProps = {
1008
960
  onCancelCellEdit? : ((event: { source: Grid, editorContext: GridLocation, event: Event }) => void)|string
1009
961
  /**
1010
962
  * Fires when any other event is fired from the object.
1011
- * ...
1012
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-catchAll)
963
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-catchAll)
1013
964
  * @param {object} event Event object
1014
965
  * @param {{[key: string]: any, type: string}} event.event The Object that contains event details
1015
966
  * @param {string} event.event.type The type of the event which is caught by the listener
@@ -1051,8 +1002,7 @@ export type BryntumTreeGridProps = {
1051
1002
  /**
1052
1003
  * This event fires on the owning grid before the context menu is shown for a cell.
1053
1004
  * Allows manipulation of the items to show in the same way as in the [processItems](https://bryntum.com/products/grid/docs/api/Grid/feature/CellMenu#config-processItems).
1054
- * ...
1055
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-cellMenuBeforeShow)
1005
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-cellMenuBeforeShow)
1056
1006
  * @param {object} event Event object
1057
1007
  * @param {Grid.view.Grid} event.source The grid
1058
1008
  * @param {Core.widget.Menu} event.menu The menu
@@ -1060,7 +1010,7 @@ export type BryntumTreeGridProps = {
1060
1010
  * @param {Grid.column.Column} event.column Column
1061
1011
  * @param {Core.data.Model} event.record Record
1062
1012
  */
1063
- onCellMenuBeforeShow? : ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => Promise<boolean>|boolean|void)|string
1013
+ onCellMenuBeforeShow? : ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void)|string
1064
1014
  /**
1065
1015
  * This event fires on the owning grid when an item is selected in the cell context menu.
1066
1016
  * @param {object} event Event object
@@ -1187,7 +1137,7 @@ export type BryntumTreeGridProps = {
1187
1137
  * @param {Event} event.event The browser event.
1188
1138
  * @param {string} event.region The region where the column was dropped.
1189
1139
  */
1190
- onColumnDrop? : ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => Promise<boolean>|boolean|void)|string
1140
+ onColumnDrop? : ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void)|string
1191
1141
  /**
1192
1142
  * This event is fired after a resize gesture is completed.
1193
1143
  * @param {object} event Event object
@@ -1233,8 +1183,7 @@ export type BryntumTreeGridProps = {
1233
1183
  onCopy? : ((event: { source: Grid, cells: GridLocation[], copiedDataString: string, isCut: boolean, entityName: string }) => void)|string
1234
1184
  /**
1235
1185
  * Fired when data in the store changes.
1236
- * ...
1237
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-dataChange)
1186
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-dataChange)
1238
1187
  * @param {object} event Event object
1239
1188
  * @param {Grid.view.GridBase} event.source Owning grid
1240
1189
  * @param {Core.data.Store} event.store The originating store
@@ -1328,7 +1277,7 @@ export type BryntumTreeGridProps = {
1328
1277
  * @param {Grid.util.GridLocation} event.cell Information about the column / record
1329
1278
  * @param {MouseEvent} event.domEvent The raw DOM event
1330
1279
  */
1331
- onFillHandleDragStart? : ((event: { cell: GridLocation, domEvent: MouseEvent }) => Promise<boolean>|boolean|void)|string
1280
+ onFillHandleDragStart? : ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
1332
1281
  /**
1333
1282
  * Fires on the owning Grid when cell editing is finished
1334
1283
  * @param {object} event Event object
@@ -1338,8 +1287,7 @@ export type BryntumTreeGridProps = {
1338
1287
  onFinishCellEdit? : ((event: { grid: Grid, editorContext: CellEditorContext }) => void)|string
1339
1288
  /**
1340
1289
  * Fires on the owning Grid before the row editing is finished, return false to signal that the value is invalid and editing should not be finalized.
1341
- * ...
1342
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-finishRowEdit)
1290
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-finishRowEdit)
1343
1291
  * @param {object} event Event object
1344
1292
  * @param {Grid.view.Grid} event.grid Target grid
1345
1293
  * @param {RowEditorContext} event.editorContext Editing context
@@ -1377,7 +1325,7 @@ export type BryntumTreeGridProps = {
1377
1325
  * @param {Core.data.Model[]} event.context.records The dragged row records
1378
1326
  * @param {MouseEvent,TouchEvent} event.event
1379
1327
  */
1380
- onGridRowBeforeDragStart? : ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => Promise<boolean>|boolean|void)|string
1328
+ onGridRowBeforeDragStart? : ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void)|string
1381
1329
  /**
1382
1330
  * Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
1383
1331
  * Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
@@ -1439,25 +1387,23 @@ export type BryntumTreeGridProps = {
1439
1387
  onGridRowDrop? : ((event: { source: GridBase, context: { valid: boolean, insertBefore: Model, parent: Model, records: Model[], oldPositionContext: RecordPositionContext[] }, event: MouseEvent }) => void)|string
1440
1388
  /**
1441
1389
  * Fired when a grid header is clicked on.
1442
- * ...
1443
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-headerClick)
1390
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-headerClick)
1444
1391
  * @param {object} event Event object
1445
1392
  * @param {Event} event.domEvent The triggering DOM event.
1446
1393
  * @param {Grid.column.Column} event.column The column clicked on.
1447
1394
  */
1448
- onHeaderClick? : ((event: { domEvent: Event, column: Column }) => Promise<boolean>|boolean|void)|string
1395
+ onHeaderClick? : ((event: { domEvent: Event, column: Column }) => boolean|void)|string
1449
1396
  /**
1450
1397
  * This event fires on the owning Grid before the context menu is shown for a header.
1451
1398
  * Allows manipulation of the items to show in the same way as in the [processItems](https://bryntum.com/products/grid/docs/api/Grid/feature/HeaderMenu#config-processItems).
1452
- * ...
1453
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-headerMenuBeforeShow)
1399
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-headerMenuBeforeShow)
1454
1400
  * @param {object} event Event object
1455
1401
  * @param {Grid.view.Grid} event.source The grid
1456
1402
  * @param {Core.widget.Menu} event.menu The menu
1457
1403
  * @param {Record<string, MenuItemEntry>} event.items Menu item configs
1458
1404
  * @param {Grid.column.Column} event.column Column
1459
1405
  */
1460
- onHeaderMenuBeforeShow? : ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => Promise<boolean>|boolean|void)|string
1406
+ onHeaderMenuBeforeShow? : ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void)|string
1461
1407
  /**
1462
1408
  * This event fires on the owning Grid when an item is selected in the header context menu.
1463
1409
  * @param {object} event Event object
@@ -1513,8 +1459,7 @@ export type BryntumTreeGridProps = {
1513
1459
  /**
1514
1460
  * Triggered when a widget which had been in a non-visible state for any reason
1515
1461
  * achieves visibility.
1516
- * ...
1517
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-paint)
1462
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-paint)
1518
1463
  * @param {object} event Event object
1519
1464
  * @param {Core.widget.Widget} event.source The widget being painted.
1520
1465
  * @param {boolean} event.firstPaint `true` if this is the first paint.
@@ -1533,8 +1478,8 @@ export type BryntumTreeGridProps = {
1533
1478
  /**
1534
1479
  * Fires on the owning Grid when export has finished
1535
1480
  * @param {object} event Event object
1536
- * @param {Response} event.response Optional response, if received
1537
- * @param {Error} event.error Optional error, if exception occurred
1481
+ * @param {Response} [event.response] Optional response, if received
1482
+ * @param {Error} [event.error] Optional error, if exception occurred
1538
1483
  */
1539
1484
  onPdfExport? : ((event: { response?: Response, error?: Error }) => void)|string
1540
1485
  /**
@@ -1591,8 +1536,7 @@ export type BryntumTreeGridProps = {
1591
1536
  onRowCollapse? : ((event: { record: Model }) => void)|string
1592
1537
  /**
1593
1538
  * This event fires when a row expand has finished expanding.
1594
- * ...
1595
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-rowExpand)
1539
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-rowExpand)
1596
1540
  * @param {object} event Event object
1597
1541
  * @param {Core.data.Model} event.record Record
1598
1542
  * @param {object} event.expandedElements An object with the Grid region name as property and the expanded body element as value
@@ -1670,7 +1614,7 @@ export type BryntumTreeGridProps = {
1670
1614
  * @param {Grid.view.SubGrid} event.subGrid The subgrid
1671
1615
  * @param {Event} event.domEvent The native DOM event
1672
1616
  */
1673
- onSplitterCollapseClick? : ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => Promise<boolean>|boolean|void)|string
1617
+ onSplitterCollapseClick? : ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
1674
1618
  /**
1675
1619
  * Fired by the Grid after a sub-grid has been resized using the splitter
1676
1620
  * @param {object} event Event object
@@ -1695,7 +1639,7 @@ export type BryntumTreeGridProps = {
1695
1639
  * @param {Grid.view.SubGrid} event.subGrid The subgrid
1696
1640
  * @param {Event} event.domEvent The native DOM event
1697
1641
  */
1698
- onSplitterExpandClick? : ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => Promise<boolean>|boolean|void)|string
1642
+ onSplitterExpandClick? : ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
1699
1643
  /**
1700
1644
  * Fires on the owning Grid when editing starts
1701
1645
  * @param {object} event Event object
@@ -1730,7 +1674,7 @@ export type BryntumTreeGridProps = {
1730
1674
  * @param {Core.data.Model} event.groupRecord [DEPRECATED] Use `groupRecords` param instead
1731
1675
  * @param {Core.data.Model[]} event.groupRecords The group records being toggled
1732
1676
  * @param {boolean} event.collapse Collapsed (true) or expanded (false)
1733
- * @param {boolean} event.allRecords True if this event is part of toggling all groups
1677
+ * @param {boolean} [event.allRecords] True if this event is part of toggling all groups
1734
1678
  */
1735
1679
  onToggleGroup? : ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, allRecords?: boolean }) => void)|string
1736
1680
  /**
@@ -1772,129 +1716,117 @@ export type BryntumTreeGridProps = {
1772
1716
  * agent and see the responses. Which allows the user to use natural language to interact with the Grid in different
1773
1717
  * ways. For example, the user can ask the agent to filter the data, sort it, or select specific records. The agent can
1774
1718
  * also perform data manipulation operations such as adding, updating, deleting records.
1775
- * ...
1776
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/AI)
1719
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/AI)
1777
1720
  */
1778
1721
  aiFeature? : object|boolean|string|AI|AIConfig
1779
1722
  /**
1780
1723
  * AI-powered filter feature for Grid. Allows users to type natural language queries to filter grid data.
1781
- * ...
1782
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/ai/AIFilter)
1724
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/ai/AIFilter)
1783
1725
  */
1784
1726
  aiFilterFeature? : object|boolean|string|AIFilter|AIFilterConfig
1785
1727
  /**
1786
1728
  * Allows using `[Ctrl/CMD + C]`, `[Ctrl/CMD + X]` and `[Ctrl/CMD + V]` to cut, copy and paste cell or cell ranges. Also
1787
1729
  * makes cut, copy and paste actions available via the cell context menu.
1788
- * ...
1789
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellCopyPaste)
1730
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellCopyPaste)
1790
1731
  */
1791
1732
  cellCopyPasteFeature? : object|boolean|string|CellCopyPaste|CellCopyPasteConfig
1792
1733
  /**
1793
1734
  * Adding this feature to the grid and other Bryntum products which are based on the Grid (i.e. Scheduler, SchedulerPro, and Gantt)
1794
1735
  * enables cell editing. Any subclass of [Field](https://bryntum.com/products/grid/docs/api/Core/widget/Field) can be used
1795
1736
  * as editor for the [Column](https://bryntum.com/products/grid/docs/api/Grid/column/Column). The most popular are:
1796
- * ...
1797
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit)
1737
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit)
1798
1738
  */
1799
1739
  cellEditFeature? : object|boolean|string|CellEdit|CellEditConfig
1800
1740
  /**
1801
1741
  * Right click to display context menu for cells. To invoke the cell menu in a keyboard-accessible manner, use the
1802
1742
  * <kbd>Space</kbd> key when the cell is focused.
1803
- * ...
1804
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellMenu)
1743
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellMenu)
1805
1744
  */
1806
1745
  cellMenuFeature? : object|boolean|string|CellMenu|CellMenuConfig
1807
1746
  /**
1808
1747
  * Displays a tooltip when hovering cells.
1809
- * ...
1810
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellTooltip)
1748
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellTooltip)
1811
1749
  */
1812
1750
  cellTooltipFeature? : object|boolean|string|CellTooltip|CellTooltipConfig
1813
1751
  /**
1814
1752
  * Adds interactive charting to a Grid. [Charts](https://bryntum.com/products/grid/docs/api/Chart/widget/Chart) can be created from a selection of Grid data
1815
1753
  * and updated in realtime as data changes. Supports many common chart types with extensive styling and customization
1816
1754
  * options.
1817
- * ...
1818
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Charts)
1755
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/Charts)
1819
1756
  */
1820
1757
  chartsFeature? : object|boolean|string|Charts|ChartsConfig
1821
1758
  /**
1822
- * Enables the [autoWidth](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-autoWidth) config for a grid's columns.
1823
- * ...
1824
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnAutoWidth)
1759
+ * Enables the [autoWidth](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-autoWidth) config for a grid's columns. When a column
1760
+ * has `autoWidth` set, this feature measures the rendered content of all visible cells in that column
1761
+ * and adjusts the column width to fit. The measurement is triggered automatically when data changes
1762
+ * or rows are rendered.
1763
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnAutoWidth)
1825
1764
  */
1826
1765
  columnAutoWidthFeature? : object|boolean|string|ColumnAutoWidth|ColumnAutoWidthConfig
1827
1766
  /**
1828
1767
  * Displays a toolbar while dragging column headers. Drop on a button in the toolbar to activate a certain function,
1829
1768
  * for example to group by that column. This feature simplifies certain operations on touch devices.
1830
- * ...
1831
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnDragToolbar)
1769
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnDragToolbar)
1832
1770
  */
1833
1771
  columnDragToolbarFeature? : object|boolean|string|ColumnDragToolbar|ColumnDragToolbarConfig
1834
1772
  /**
1835
1773
  * Displays a column picker (to show/hide columns) in the header context menu. Columns can be displayed in sub menus
1836
1774
  * by region or tag. Grouped headers are displayed as menu hierarchies.
1837
- * ...
1838
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnPicker)
1775
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnPicker)
1839
1776
  */
1840
1777
  columnPickerFeature? : object|boolean|string|ColumnPicker|ColumnPickerConfig
1841
1778
  /**
1842
1779
  * Allows user to rename columns by either right-clicking column header or using keyboard shortcuts when column header
1843
1780
  * is focused.
1844
- * ...
1845
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnRename)
1781
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnRename)
1846
1782
  */
1847
1783
  columnRenameFeature? : object|boolean|string|ColumnRename|ColumnRenameConfig
1848
1784
  /**
1849
- * Allows user to reorder columns by dragging headers. To get notified about column reorder listen to `change` event
1850
- * on [columns](https://bryntum.com/products/grid/docs/api/Grid/data/ColumnStore) store.
1851
- * ...
1852
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnReorder)
1785
+ * Allows user to reorder columns by dragging headers. Click and drag a column header to move it to a new position.
1786
+ * Visual feedback shows the drop target while dragging. To get notified about column reorder, listen to the
1787
+ * `change` event on the [columns](https://bryntum.com/products/grid/docs/api/Grid/data/ColumnStore) store.
1788
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnReorder)
1853
1789
  */
1854
1790
  columnReorderFeature? : object|boolean|string|ColumnReorder|ColumnReorderConfig
1855
1791
  /**
1856
- * Enables user to resize columns by dragging a handle on the right hand side of the header. To get notified about column
1857
- * resize listen to `change` event on [columns](https://bryntum.com/products/grid/docs/api/Grid/data/ColumnStore) store.
1858
- * ...
1859
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnResize)
1792
+ * Enables user to resize columns by dragging a handle on the right hand side of the header. A drag handle
1793
+ * appears when hovering near the right edge of a column header. Dragging it adjusts the column width, respecting
1794
+ * any [minWidth](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-minWidth) or [maxWidth](#Grid/column/Column#config-maxWidth) constraints.
1795
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnResize)
1860
1796
  */
1861
1797
  columnResizeFeature? : object|boolean|string|ColumnResize|ColumnResizeConfig
1862
1798
  /**
1863
1799
  * A feature that allows exporting Grid data to Excel or CSV without involving the server. It uses
1864
1800
  * [TableExporter](https://bryntum.com/products/grid/docs/api/Grid/util/TableExporter) class as data provider, 3rd party provider to generate XLS files, and
1865
1801
  * [Microsoft XML specification](https://msdn.microsoft.com/en-us/library/office/documentformat.openxml.spreadsheet.aspx).
1866
- * ...
1867
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/ExcelExporter)
1802
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/ExcelExporter)
1868
1803
  */
1869
1804
  excelExporterFeature? : object|boolean|string|ExcelExporter|ExcelExporterConfig
1870
1805
  /**
1871
- * An experimental feature that lets users drop files on a Widget. The widget fires an event when a file is dropped onto it.
1872
- * In the event, you get access to the raw files as strings, that were parsed by calling `readAsBinaryString`.
1873
- * ...
1874
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/FileDrop)
1806
+ * An experimental feature that lets users drop files on a Widget. The widget fires a
1807
+ * [fileDrop](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/FileDrop#event-fileDrop) event when a file is dropped onto it. In the event, you get access to the raw
1808
+ * files as strings, that were parsed by calling `readAsBinaryString`.
1809
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/FileDrop)
1875
1810
  */
1876
1811
  fileDropFeature? : object|boolean|string|FileDrop|FileDropConfig
1877
1812
  /**
1878
1813
  * This feature adds a fill handle to a Grid range selection, which when dragged, fills the cells being dragged over
1879
1814
  * with values based on the values in the original selected range. This is similar to functionality normally seen in
1880
1815
  * various spreadsheet applications.
1881
- * ...
1882
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/FillHandle)
1816
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/FillHandle)
1883
1817
  */
1884
1818
  fillHandleFeature? : object|boolean|string|FillHandle|FillHandleConfig
1885
1819
  /**
1886
1820
  * Feature that allows filtering of the grid by settings filters on columns. The actual filtering is done by the store.
1887
1821
  * For info on programmatically handling filters, see [StoreFilter](https://bryntum.com/products/grid/docs/api/Core/data/mixin/StoreFilter).
1888
- * ...
1889
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Filter)
1822
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/Filter)
1890
1823
  */
1891
1824
  filterFeature? : object|boolean|string|Filter|FilterConfig
1892
1825
  /**
1893
1826
  * Feature that allows filtering of the grid by entering filters on column headers.
1894
1827
  * The actual filtering is done by the store.
1895
1828
  * For info on programmatically handling filters, see [StoreFilter](https://bryntum.com/products/grid/docs/api/Core/data/mixin/StoreFilter).
1896
- * ...
1897
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/FilterBar)
1829
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/FilterBar)
1898
1830
  */
1899
1831
  filterBarFeature? : object|boolean|string|FilterBar|FilterBarConfig
1900
1832
  /**
@@ -1902,141 +1834,124 @@ export type BryntumTreeGridProps = {
1902
1834
  * <kbd>Shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
1903
1835
  * one anywhere on grid). Use <kbd>Shift</kbd> + <kbd>Alt</kbd> + click, or the context menu, to remove a column
1904
1836
  * grouper.
1905
- * ...
1906
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Group)
1837
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/Group)
1907
1838
  */
1908
1839
  groupFeature? : object|boolean|string|Group|GroupConfig
1909
1840
  /**
1910
1841
  * Displays a summary row as a group footer in a grouped grid. Uses the same configuration options on columns as
1911
1842
  * [Summary](https://bryntum.com/products/grid/docs/api/Grid/feature/Summary).
1912
- * ...
1913
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/GroupSummary)
1843
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/GroupSummary)
1914
1844
  */
1915
1845
  groupSummaryFeature? : object|boolean|string|GroupSummary|GroupSummaryConfig
1916
1846
  /**
1917
1847
  * Right click column header or focus it and press SPACE key to show the context menu for headers.
1918
- * ...
1919
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/HeaderMenu)
1848
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/HeaderMenu)
1920
1849
  */
1921
1850
  headerMenuFeature? : object|boolean|string|HeaderMenu|HeaderMenuConfig
1922
1851
  /**
1923
1852
  * This feature allows records which satisfy a certain condition to be locked at the top of the grid.
1924
- * ...
1925
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/LockRows)
1853
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/LockRows)
1926
1854
  */
1927
1855
  lockRowsFeature? : object|boolean|string|LockRows|LockRowsConfig
1928
1856
  /**
1929
1857
  * This feature merges cells that have the same value in sorted (or [optionally](https://bryntum.com/products/grid/docs/api/Grid/feature/MergeCells#config-sortedOnly) any) columns
1930
1858
  * configured to [mergeCells](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-mergeCells).
1931
- * ...
1932
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/MergeCells)
1859
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/MergeCells)
1933
1860
  */
1934
1861
  mergeCellsFeature? : object|boolean|string|MergeCells|MergeCellsConfig
1935
1862
  /**
1936
1863
  * Generates PDF/PNG files from the Grid component.
1937
- * ...
1938
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/export/PdfExport)
1864
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/export/PdfExport)
1939
1865
  */
1940
1866
  pdfExportFeature? : object|boolean|string|PdfExport|PdfExportConfig
1941
1867
  /**
1942
1868
  * Allows pinning columns to the start or end region of the grid without any additional subGrid configurations.
1943
1869
  * When pinning to a region that does not yet exist, the feature creates the required subGrid on the fly.
1944
- * ...
1945
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/PinColumns)
1870
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/PinColumns)
1946
1871
  */
1947
1872
  pinColumnsFeature? : object|boolean|string|PinColumns|PinColumnsConfig
1948
1873
  /**
1949
1874
  * Allows printing Grid contents using browser print dialog.
1950
- * ...
1951
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/export/Print)
1875
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/export/Print)
1952
1876
  */
1953
1877
  printFeature? : object|boolean|string|Print|PrintConfig
1954
1878
  /**
1955
1879
  * Feature that allows the user to search in a column by focusing a cell and typing. Navigate between hits using the
1956
- * keyboard, [f3] or [ctrl]/[cmd] + [g] moves to next, also pressing [shift] moves to previous.
1957
- * ...
1958
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/QuickFind)
1880
+ * keyboard, <kbd>f3</kbd> or <kbd>ctrl</kbd>/<kbd>cmd</kbd> + <kbd>g</kbd> moves to next, also pressing
1881
+ * <kbd>shift</kbd> moves to previous.
1882
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/QuickFind)
1959
1883
  */
1960
1884
  quickFindFeature? : object|boolean|string|QuickFind|QuickFindConfig
1961
1885
  /**
1962
1886
  * Makes the splitter between grid [sections](https://bryntum.com/products/grid/docs/api/Grid/view/SubGrid) draggable, to let users resize, and
1963
1887
  * collapse/expand the sections.
1964
- * ...
1965
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/RegionResize)
1888
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/RegionResize)
1966
1889
  */
1967
1890
  regionResizeFeature? : object|boolean|string|RegionResize|RegionResizeConfig
1968
1891
  /**
1969
1892
  * Allow using [Ctrl/CMD + C/X] and [Ctrl/CMD + V] to copy/cut-and-paste rows. Also makes cut, copy and paste actions
1970
1893
  * available via the cell context menu.
1971
- * ...
1972
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowCopyPaste)
1894
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowCopyPaste)
1973
1895
  */
1974
1896
  rowCopyPasteFeature? : object|boolean|string|RowCopyPaste|RowCopyPasteConfig
1975
1897
  /**
1976
1898
  * This feature allows editing of entire rows in a grid in a docked panel which by default slides out from the right.
1977
- * ...
1978
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowEdit)
1899
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowEdit)
1979
1900
  */
1980
1901
  rowEditFeature? : object|boolean|string|RowEdit|RowEditConfig
1981
1902
  /**
1982
1903
  * Enables expanding of Grid rows by either row click or double click, or by adding a separate Grid column which renders
1983
1904
  * a button that expands or collapses the row.
1984
- * ...
1985
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowExpander)
1905
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowExpander)
1986
1906
  */
1987
1907
  rowExpanderFeature? : object|boolean|string|RowExpander|RowExpanderConfig
1988
1908
  /**
1989
1909
  * Allows user to reorder rows by dragging them. To get notified about row reorder listen to `change` event
1990
1910
  * on the grid [store](https://bryntum.com/products/grid/docs/api/Core/data/Store).
1991
- * ...
1992
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowReorder)
1911
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowReorder)
1993
1912
  */
1994
1913
  rowReorderFeature? : object|boolean|string|RowReorder|RowReorderConfig
1995
1914
  /**
1996
1915
  * Enables user to change row height by dragging the bottom row border. After a resize operation, the [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/data/GridRowModel#field-rowHeight)
1997
1916
  * field of the record is updated (when [applyToAllRows](https://bryntum.com/products/grid/docs/api/Grid/feature/RowResize#config-applyToAllRows) is `false`).
1998
- * ...
1999
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowResize)
1917
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowResize)
2000
1918
  */
2001
1919
  rowResizeFeature? : object|boolean|string|RowResize|RowResizeConfig
2002
1920
  /**
2003
1921
  * <div class="external-example vertical" data-file="Grid/feature/Search.js"></div>
2004
- * ...
2005
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Search)
1922
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/Search)
2006
1923
  */
2007
1924
  searchFeature? : object|boolean|string|Search|SearchConfig
2008
1925
  /**
2009
1926
  * Allows sorting of grid by clicking (or tapping) headers, also displays which columns grid is sorted by (numbered if
2010
1927
  * using multisort). Use modifier keys for multisorting: [Ctrl/CMD + click] to add sorter, [Ctrl/CMD + Alt + click] to remove sorter.
2011
1928
  * The actual sorting is done by the store, see [Store.sort()](https://bryntum.com/products/grid/docs/api/Core/data/mixin/StoreSort#function-sort).
2012
- * ...
2013
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Sort)
1929
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/Sort)
2014
1930
  */
2015
1931
  sortFeature? : object|boolean|string|Sort|SortConfig
2016
1932
  /**
2017
1933
  * This feature allows splitting the Grid into multiple views, either by using the cell context menu, or
2018
1934
  * programmatically by calling [split()](https://bryntum.com/products/grid/docs/api/Grid/feature/Split#function-split).
2019
- * ...
2020
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Split)
1935
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/Split)
2021
1936
  */
2022
1937
  splitFeature? : object|boolean|string|Split|SplitConfig
2023
1938
  /**
2024
- * A feature which pins configurable content from a grid row to the top of the grid
2025
- * while the row scrolls off the top but is still visible.
2026
- * ...
2027
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/StickyCells)
1939
+ * A feature which pins cell content to the top of the grid while the row scrolls off the top but is still visible. Very
1940
+ * similar to native `position: sticky`, which because of Grid's multiple-region setup unfortunately cannot be used to
1941
+ * achieve the same effect.
1942
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/StickyCells)
2028
1943
  */
2029
1944
  stickyCellsFeature? : object|boolean|string|StickyCells|StickyCellsConfig
2030
1945
  /**
2031
1946
  * Stripes rows by adding alternating CSS classes to all row elements (`b-even` and `b-odd`).
2032
- * ...
2033
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Stripe)
1947
+ * This improves visual readability in data-heavy grids by giving adjacent rows different background colors.
1948
+ * Style the striped rows using the `.b-even` and `.b-odd` CSS classes.
1949
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/Stripe)
2034
1950
  */
2035
1951
  stripeFeature? : object|boolean|string|Stripe|StripeConfig
2036
1952
  /**
2037
1953
  * Displays a summary row in the grid footer.
2038
- * ...
2039
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Summary)
1954
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/Summary)
2040
1955
  */
2041
1956
  summaryFeature? : object|boolean|string|Summary|SummaryConfig
2042
1957
  /**
@@ -2044,15 +1959,13 @@ export type BryntumTreeGridProps = {
2044
1959
  * exactly one [TreeColumn](https://bryntum.com/products/grid/docs/api/Grid/column/TreeColumn) among grids columns. That column will have its renderer replaced with a
2045
1960
  * tree renderer that adds padding and icon to give the appearance of a tree. The original renderer is preserved and
2046
1961
  * also called.
2047
- * ...
2048
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Tree)
1962
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/Tree)
2049
1963
  */
2050
1964
  treeFeature? : object|boolean|string|Tree|TreeConfig
2051
1965
  /**
2052
1966
  * A feature that allows transforming a flat dataset (or the leaves of a hierarchical) into a tree by specifying a
2053
1967
  * record field per parent level. Parents are generated based on each leaf's value for those fields.
2054
- * ...
2055
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/TreeGroup)
1968
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/TreeGroup)
2056
1969
  */
2057
1970
  treeGroupFeature? : object|boolean|string|TreeGroup|TreeGroupConfig
2058
1971
 
@@ -2188,6 +2101,7 @@ export class BryntumTreeGrid extends React.Component<BryntumTreeGridProps> {
2188
2101
  'resizeToFitIncludesHeader',
2189
2102
  'responsiveLevels',
2190
2103
  'ripple',
2104
+ 'role',
2191
2105
  'rootElement',
2192
2106
  'scrollerClass',
2193
2107
  'scrollManager',
@@ -2236,6 +2150,7 @@ export class BryntumTreeGrid extends React.Component<BryntumTreeGridProps> {
2236
2150
  'insertFirst',
2237
2151
  'keyMap',
2238
2152
  'labelPosition',
2153
+ 'labelWidth',
2239
2154
  'longPressTime',
2240
2155
  'margin',
2241
2156
  'maxHeight',
@@ -2380,8 +2295,6 @@ export class BryntumTreeGrid extends React.Component<BryntumTreeGridProps> {
2380
2295
  ];
2381
2296
 
2382
2297
  static propertyNames = [
2383
- 'focusVisible',
2384
- 'hasChanges',
2385
2298
  'originalStore',
2386
2299
  'parent',
2387
2300
  'selectedCell',