@bryntum/grid-vue-3-thin 7.2.4 → 7.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -4
- package/lib/chunks/{B5DiBj1m.js → BGeNcVH6.js} +5 -5
- package/lib/chunks/BGeNcVH6.js.map +1 -0
- package/lib/chunks/{v3MxzI7J.js → Ba35uKyP.js} +3 -3
- package/lib/chunks/Ba35uKyP.js.map +1 -0
- package/lib/chunks/{MAev_NTD.js → Bc2x_WPR.js} +8 -6
- package/lib/chunks/Bc2x_WPR.js.map +1 -0
- package/lib/chunks/{C3MmNeeF.js → Be7ZZzGW.js} +14 -12
- package/lib/chunks/Be7ZZzGW.js.map +1 -0
- package/lib/chunks/{CnbA4JoC.js → BeyOFZne.js} +6 -6
- package/lib/chunks/BeyOFZne.js.map +1 -0
- package/lib/chunks/{BQkqLHa6.js → BpNo5v3W.js} +9 -10
- package/lib/chunks/BpNo5v3W.js.map +1 -0
- package/lib/chunks/{Da4PP6A-.js → CAlh-Y8B.js} +3 -3
- package/lib/chunks/CAlh-Y8B.js.map +1 -0
- package/lib/chunks/{DkzTNiUv.js → CWYhi4DG.js} +8 -9
- package/lib/chunks/CWYhi4DG.js.map +1 -0
- package/lib/chunks/{D639wy1k.js → CcfDAcJD.js} +9 -9
- package/lib/chunks/CcfDAcJD.js.map +1 -0
- package/lib/chunks/{C8vFKx3Q.js → w2GDktIt.js} +8 -6
- package/lib/chunks/w2GDktIt.js.map +1 -0
- package/lib/components/BryntumAIFilterField.js +1 -1
- package/lib/components/BryntumChecklistFilterCombo.js +1 -1
- package/lib/components/BryntumGrid.js +1 -1
- package/lib/components/BryntumGridBase.js +1 -1
- package/lib/components/BryntumGridChartDesigner.js +1 -1
- package/lib/components/BryntumGridFieldFilterPicker.js +1 -1
- package/lib/components/BryntumGridFieldFilterPickerGroup.js +1 -1
- package/lib/components/BryntumGroupBar.js +1 -1
- package/lib/components/BryntumThemeCombo.js +57 -0
- package/lib/components/BryntumThemeCombo.js.map +1 -0
- package/lib/components/BryntumTreeCombo.js +1 -1
- package/lib/components/BryntumTreeGrid.js +1 -1
- package/lib/index.js +10 -10
- package/package.json +1 -1
- package/src/components/BryntumAIFilterField.vue +73 -118
- package/src/components/BryntumAIFilterFieldProps.ts +69 -110
- package/src/components/BryntumChecklistFilterCombo.vue +90 -149
- package/src/components/BryntumChecklistFilterComboProps.ts +86 -141
- package/src/components/BryntumGrid.vue +203 -290
- package/src/components/BryntumGridBase.vue +203 -290
- package/src/components/BryntumGridBaseProps.ts +186 -261
- package/src/components/BryntumGridChartDesigner.vue +58 -94
- package/src/components/BryntumGridChartDesignerProps.ts +55 -88
- package/src/components/BryntumGridFieldFilterPicker.vue +81 -131
- package/src/components/BryntumGridFieldFilterPickerGroup.vue +80 -129
- package/src/components/BryntumGridFieldFilterPickerGroupProps.ts +76 -120
- package/src/components/BryntumGridFieldFilterPickerProps.ts +77 -122
- package/src/components/BryntumGridProps.ts +186 -261
- package/src/components/BryntumGroupBar.vue +64 -104
- package/src/components/BryntumGroupBarProps.ts +61 -98
- package/src/components/BryntumThemeCombo.vue +60 -0
- package/src/components/BryntumTreeCombo.vue +91 -151
- package/src/components/BryntumTreeComboProps.ts +87 -143
- package/src/components/BryntumTreeGrid.vue +203 -290
- package/src/components/BryntumTreeGridProps.ts +186 -261
- package/lib/chunks/B5DiBj1m.js.map +0 -1
- package/lib/chunks/BQkqLHa6.js.map +0 -1
- package/lib/chunks/C3MmNeeF.js.map +0 -1
- package/lib/chunks/C8vFKx3Q.js.map +0 -1
- package/lib/chunks/CnbA4JoC.js.map +0 -1
- package/lib/chunks/D639wy1k.js.map +0 -1
- package/lib/chunks/Da4PP6A-.js.map +0 -1
- package/lib/chunks/DkzTNiUv.js.map +0 -1
- package/lib/chunks/MAev_NTD.js.map +0 -1
- package/lib/chunks/v3MxzI7J.js.map +0 -1
|
@@ -33,7 +33,7 @@
|
|
|
33
33
|
|
|
34
34
|
import { getCurrentInstance, onBeforeUnmount, onMounted, provide, ref, watch, toRaw } from 'vue';
|
|
35
35
|
|
|
36
|
-
import type { 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, Widget } from '@bryntum/core-thin';
|
|
36
|
+
import type { 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, Widget } from '@bryntum/core-thin';
|
|
37
37
|
import type { 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, TreeGridListeners, TreeGroup, TreeGroupConfig, XLSColumn } from '@bryntum/grid-thin';
|
|
38
38
|
import { TreeGrid } from '@bryntum/grid-thin';
|
|
39
39
|
|
|
@@ -44,8 +44,7 @@ defineProps<{
|
|
|
44
44
|
/**
|
|
45
45
|
* Element (or element id) to adopt as this Widget's encapsulating element. The widget's
|
|
46
46
|
* content will be placed inside this element.
|
|
47
|
-
* ...
|
|
48
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-adopt)
|
|
47
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-adopt)
|
|
49
48
|
*/
|
|
50
49
|
adopt ? : HTMLElement|string
|
|
51
50
|
/**
|
|
@@ -80,15 +79,13 @@ defineProps<{
|
|
|
80
79
|
/**
|
|
81
80
|
* A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject
|
|
82
81
|
* into an element which will be linked using the `aria-describedby` attribute.
|
|
83
|
-
* ...
|
|
84
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-ariaDescription)
|
|
82
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-ariaDescription)
|
|
85
83
|
*/
|
|
86
84
|
ariaDescription ? : string
|
|
87
85
|
/**
|
|
88
86
|
* A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject as
|
|
89
87
|
* the `aria-label` attribute.
|
|
90
|
-
* ...
|
|
91
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-ariaLabel)
|
|
88
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-ariaLabel)
|
|
92
89
|
*/
|
|
93
90
|
ariaLabel ? : string
|
|
94
91
|
/**
|
|
@@ -100,14 +97,12 @@ defineProps<{
|
|
|
100
97
|
/**
|
|
101
98
|
* A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/grid/docs/api/Core/widget/Toolbar),
|
|
102
99
|
* 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).
|
|
103
|
-
* ...
|
|
104
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-bbar)
|
|
100
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-bbar)
|
|
105
101
|
*/
|
|
106
102
|
bbar ? : (GridContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
|
|
107
103
|
/**
|
|
108
104
|
* Custom CSS classes to add to the panel's body element.
|
|
109
|
-
* ...
|
|
110
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-bodyCls)
|
|
105
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-bodyCls)
|
|
111
106
|
*/
|
|
112
107
|
bodyCls ? : string|object
|
|
113
108
|
/**
|
|
@@ -117,21 +112,18 @@ defineProps<{
|
|
|
117
112
|
/**
|
|
118
113
|
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
119
114
|
* hierarchy when triggered.
|
|
120
|
-
* ...
|
|
121
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-bubbleEvents)
|
|
115
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-bubbleEvents)
|
|
122
116
|
*/
|
|
123
117
|
bubbleEvents ? : object
|
|
124
118
|
/**
|
|
125
119
|
* Set to `false` to not call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
|
|
126
|
-
* ...
|
|
127
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-callOnFunctions)
|
|
120
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-callOnFunctions)
|
|
128
121
|
*/
|
|
129
122
|
callOnFunctions ? : Boolean
|
|
130
123
|
/**
|
|
131
124
|
* By default, if an event handler throws an exception, the error propagates up the stack and the
|
|
132
125
|
* application state is undefined. Code which follows the event handler will *not* be executed.
|
|
133
|
-
* ...
|
|
134
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-catchEventHandlerExceptions)
|
|
126
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-catchEventHandlerExceptions)
|
|
135
127
|
*/
|
|
136
128
|
catchEventHandlerExceptions ? : Boolean
|
|
137
129
|
/**
|
|
@@ -144,8 +136,7 @@ defineProps<{
|
|
|
144
136
|
* Custom CSS classes to add to element.
|
|
145
137
|
* May be specified as a space separated string, or as an object in which property names
|
|
146
138
|
* with truthy values are used as the class names:
|
|
147
|
-
* ...
|
|
148
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-cls)
|
|
139
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-cls)
|
|
149
140
|
*/
|
|
150
141
|
cls ? : string|object
|
|
151
142
|
/**
|
|
@@ -155,15 +146,13 @@ defineProps<{
|
|
|
155
146
|
collapsed ? : Boolean
|
|
156
147
|
/**
|
|
157
148
|
* This config enables collapsibility for the panel. See [collapsed](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-collapsed).
|
|
158
|
-
* ...
|
|
159
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-collapsible)
|
|
149
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-collapsible)
|
|
160
150
|
*/
|
|
161
151
|
collapsible ? : Boolean|PanelCollapserConfig|PanelCollapserOverlayConfig
|
|
162
152
|
/**
|
|
163
153
|
* Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
|
|
164
154
|
* `style` block.
|
|
165
|
-
* ...
|
|
166
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-color)
|
|
155
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-color)
|
|
167
156
|
*/
|
|
168
157
|
color ? : Color
|
|
169
158
|
/**
|
|
@@ -177,8 +166,7 @@ defineProps<{
|
|
|
177
166
|
/**
|
|
178
167
|
* Accepts column definitions for the grid during initialization. They will be used to create
|
|
179
168
|
* [Column](https://bryntum.com/products/grid/docs/api/Grid/column/Column) instances that are added to a [ColumnStore](#Grid/data/ColumnStore).
|
|
180
|
-
* ...
|
|
181
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-columns)
|
|
169
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-columns)
|
|
182
170
|
*/
|
|
183
171
|
columns ? : ColumnStore|GridColumnConfig[]|ColumnStoreConfig
|
|
184
172
|
config ? : object
|
|
@@ -186,8 +174,7 @@ defineProps<{
|
|
|
186
174
|
* Custom CSS classes to add to the [contentElement](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-contentElement).
|
|
187
175
|
* May be specified as a space separated string, or as an object in which property names
|
|
188
176
|
* with truthy values are used as the class names:
|
|
189
|
-
* ...
|
|
190
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-contentElementCls)
|
|
177
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-contentElementCls)
|
|
191
178
|
*/
|
|
192
179
|
contentElementCls ? : string|object
|
|
193
180
|
/**
|
|
@@ -199,8 +186,7 @@ defineProps<{
|
|
|
199
186
|
* Convenient shortcut to set data in grids store both during initialization and at runtime. Can also be
|
|
200
187
|
* used to retrieve data at runtime, although we do recommend interacting with Grids store instead using
|
|
201
188
|
* the [store](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#property-store) property.
|
|
202
|
-
* ...
|
|
203
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-data)
|
|
189
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-data)
|
|
204
190
|
*/
|
|
205
191
|
data ? : object[]|Model[]|ModelConfig[]
|
|
206
192
|
/**
|
|
@@ -221,16 +207,15 @@ defineProps<{
|
|
|
221
207
|
*/
|
|
222
208
|
destroyStore ? : Boolean
|
|
223
209
|
/**
|
|
224
|
-
* Check for CSS compatibility issues
|
|
225
|
-
*
|
|
226
|
-
* [
|
|
210
|
+
* Check for CSS compatibility and inclusion related issues and try to auto fix them. Performs the following
|
|
211
|
+
* checks:
|
|
212
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-detectCSSCompatibilityIssues)
|
|
227
213
|
*/
|
|
228
214
|
detectCSSCompatibilityIssues ? : Boolean
|
|
229
215
|
/**
|
|
230
216
|
* 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
|
|
231
217
|
* cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
|
|
232
|
-
* ...
|
|
233
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-disabled)
|
|
218
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-disabled)
|
|
234
219
|
*/
|
|
235
220
|
disabled ? : Boolean|'inert'
|
|
236
221
|
/**
|
|
@@ -250,43 +235,39 @@ defineProps<{
|
|
|
250
235
|
* [strips collection](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
|
|
251
236
|
* `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
|
|
252
237
|
* body. Such widgets are called "edge strips".
|
|
253
|
-
* ...
|
|
254
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-dock)
|
|
238
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-dock)
|
|
255
239
|
*/
|
|
256
240
|
dock ? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
257
241
|
/**
|
|
258
242
|
* Make this Panel a docked drawer which slides out from one side of the browser viewport by default.
|
|
259
|
-
* ...
|
|
260
|
-
* [
|
|
261
|
-
* @param {
|
|
262
|
-
* @param {
|
|
263
|
-
* @param {boolean}
|
|
264
|
-
* @param {boolean,
|
|
265
|
-
* @param {boolean,string} autoClose.
|
|
266
|
-
* @param {
|
|
267
|
-
* @param {
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
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}
|
|
243
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-drawer)
|
|
244
|
+
* @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.
|
|
245
|
+
* @param {string,number} [size] The size of the drawer in its collapsible axis.
|
|
246
|
+
* @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.
|
|
247
|
+
* @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.
|
|
248
|
+
* @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.
|
|
249
|
+
* @param {boolean,string} [autoClose.focusout] If focus moves outside of the drawer, the drawer will automatically be hidden.
|
|
250
|
+
* @param {string} [autoClose.mouseout] Hides the drawer when the mouse leaves the drawer after the `autoCloseDelay` period.
|
|
251
|
+
* @param {number} [autoCloseDelay] When using `mouseout`, this is the delay in milliseconds
|
|
252
|
+
*/
|
|
253
|
+
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 }
|
|
271
254
|
/**
|
|
272
255
|
* An object specifying attributes to assign to the root element of this widget.
|
|
273
256
|
* Set `null` value to attribute to remove it.
|
|
274
|
-
* ...
|
|
275
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-elementAttributes)
|
|
257
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-elementAttributes)
|
|
276
258
|
*/
|
|
277
259
|
elementAttributes ? : Record<string, string|null>
|
|
278
260
|
/**
|
|
279
261
|
* 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.
|
|
280
262
|
* When using multiple Grid regions, provide the `region` property to decide where the text is shown.
|
|
281
263
|
* By default, it is shown in the first region.
|
|
282
|
-
* ...
|
|
283
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-emptyText)
|
|
264
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-emptyText)
|
|
284
265
|
*/
|
|
285
266
|
emptyText ? : string|EmptyTextDomConfig
|
|
286
267
|
/**
|
|
287
|
-
*
|
|
288
|
-
*
|
|
289
|
-
*
|
|
268
|
+
* Set to `true` to enable the [StickyCells](https://bryntum.com/products/grid/docs/api/Grid/feature/StickyCells) feature, which pins cell
|
|
269
|
+
* content to the top of the grid while rows scroll off the top but remain visible.
|
|
270
|
+
* @deprecated 7.3.0 Use `features : { stickyCells : true }` instead
|
|
290
271
|
*/
|
|
291
272
|
enableSticky ? : Boolean
|
|
292
273
|
/**
|
|
@@ -310,8 +291,7 @@ defineProps<{
|
|
|
310
291
|
* Use fixed row height. Setting this to `true` will configure the underlying RowManager to use fixed row
|
|
311
292
|
* height, which sacrifices the ability to use rows with variable height to gain a fraction better
|
|
312
293
|
* performance.
|
|
313
|
-
* ...
|
|
314
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-fixedRowHeight)
|
|
294
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-fixedRowHeight)
|
|
315
295
|
*/
|
|
316
296
|
fixedRowHeight ? : Boolean
|
|
317
297
|
/**
|
|
@@ -325,41 +305,35 @@ defineProps<{
|
|
|
325
305
|
/**
|
|
326
306
|
* Config object of a footer. May contain a `dock`, `html` and a `cls` property. A footer is not a widget,
|
|
327
307
|
* 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).
|
|
328
|
-
* ...
|
|
329
|
-
*
|
|
308
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-footer)
|
|
309
|
+
* @property {'top','right','bottom','left','start','end'} dock Where to dock
|
|
310
|
+
* @property {string} html Html to populate the footer with
|
|
311
|
+
* @property {string} cls CSS class to add to the footer
|
|
330
312
|
*/
|
|
331
|
-
footer ? :
|
|
332
|
-
dock?: 'top'|'right'|'bottom'|'left'|'start'|'end'
|
|
333
|
-
html?: string
|
|
334
|
-
cls?: string
|
|
335
|
-
}|string
|
|
313
|
+
footer ? : object|string
|
|
336
314
|
/**
|
|
337
315
|
* An object which names formula prefixes which will be applied to all columns configured with
|
|
338
316
|
* `formula : true`.
|
|
339
|
-
* ...
|
|
340
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-formulaProviders)
|
|
317
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-formulaProviders)
|
|
341
318
|
*/
|
|
342
319
|
formulaProviders ? : Record<string, FormulaProviderConfig>
|
|
343
320
|
/**
|
|
344
321
|
* Refresh entire row when a record changes (`true`) or, if possible, only the cells affected (`false`).
|
|
345
|
-
* ...
|
|
346
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-fullRowRefresh)
|
|
322
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-fullRowRefresh)
|
|
347
323
|
*/
|
|
348
324
|
fullRowRefresh ? : Boolean
|
|
349
325
|
/**
|
|
350
326
|
* 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
|
|
351
327
|
* expected to return the desired height of that records row. If the function returns a falsy value, Grids
|
|
352
328
|
* configured [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-rowHeight) is used.
|
|
353
|
-
* ...
|
|
354
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-getRowHeight)
|
|
329
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-getRowHeight)
|
|
355
330
|
* @param {Core.data.Model} getRowHeight.record Record to determine row height for
|
|
356
331
|
* @returns {number} Desired row height
|
|
357
332
|
*/
|
|
358
|
-
getRowHeight ? : (
|
|
333
|
+
getRowHeight ? : () => number
|
|
359
334
|
/**
|
|
360
335
|
* 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`.
|
|
361
|
-
* ...
|
|
362
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-header)
|
|
336
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-header)
|
|
363
337
|
*/
|
|
364
338
|
header ? : string|Boolean|PanelHeader
|
|
365
339
|
/**
|
|
@@ -399,16 +373,14 @@ defineProps<{
|
|
|
399
373
|
id ? : string
|
|
400
374
|
/**
|
|
401
375
|
* Determines if the widgets read-only state should be controlled by its parent.
|
|
402
|
-
* ...
|
|
403
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-ignoreParentReadOnly)
|
|
376
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-ignoreParentReadOnly)
|
|
404
377
|
*/
|
|
405
378
|
ignoreParentReadOnly ? : Boolean
|
|
406
379
|
/**
|
|
407
380
|
* Convenience setting to align input fields of child widgets. By default, the Field input element is
|
|
408
381
|
* placed immediately following the `label`. If you prefer to have all input fields aligned to the
|
|
409
382
|
* right, set this config to `'end'`.
|
|
410
|
-
* ...
|
|
411
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-inputFieldAlign)
|
|
383
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-inputFieldAlign)
|
|
412
384
|
*/
|
|
413
385
|
inputFieldAlign ? : 'start'|'end'
|
|
414
386
|
/**
|
|
@@ -425,14 +397,17 @@ defineProps<{
|
|
|
425
397
|
keyMap ? : Record<string, KeyMapConfig>
|
|
426
398
|
/**
|
|
427
399
|
* Convenience setting to use same label placement on all child widgets.
|
|
428
|
-
* ...
|
|
429
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-labelPosition)
|
|
400
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-labelPosition)
|
|
430
401
|
*/
|
|
431
402
|
labelPosition ? : 'before'|'above'|'align-before'|'auto'|null
|
|
403
|
+
/**
|
|
404
|
+
* Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
|
|
405
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-labelWidth)
|
|
406
|
+
*/
|
|
407
|
+
labelWidth ? : number|null
|
|
432
408
|
/**
|
|
433
409
|
* The listener set for this object.
|
|
434
|
-
* ...
|
|
435
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-listeners)
|
|
410
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-listeners)
|
|
436
411
|
*/
|
|
437
412
|
listeners ? : TreeGridListeners
|
|
438
413
|
/**
|
|
@@ -445,15 +420,13 @@ defineProps<{
|
|
|
445
420
|
* when data is loading. The message and optional configuration from the
|
|
446
421
|
* [loadMask](https://bryntum.com/products/grid/docs/api/Core/mixin/LoadMaskable#config-loadMask) config take priority over these options, just as they do
|
|
447
422
|
* for `maskDefaults`, respectively.
|
|
448
|
-
* ...
|
|
449
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-loadMaskDefaults)
|
|
423
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-loadMaskDefaults)
|
|
450
424
|
*/
|
|
451
425
|
loadMaskDefaults ? : MaskConfig
|
|
452
426
|
/**
|
|
453
427
|
* A [Mask](https://bryntum.com/products/grid/docs/api/Core/widget/Mask) config object to adjust the [maskDefaults](#Core/widget/Widget#config-maskDefaults)
|
|
454
428
|
* when an error occurs loading data.
|
|
455
|
-
* ...
|
|
456
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-loadMaskError)
|
|
429
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-loadMaskError)
|
|
457
430
|
*/
|
|
458
431
|
loadMaskError ? : MaskConfig|Mask|Boolean
|
|
459
432
|
/**
|
|
@@ -491,8 +464,7 @@ defineProps<{
|
|
|
491
464
|
/**
|
|
492
465
|
* Grid's `min-height`. Defaults to `10em` to be sure that the Grid always has a height wherever it is
|
|
493
466
|
* inserted.
|
|
494
|
-
* ...
|
|
495
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-minHeight)
|
|
467
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-minHeight)
|
|
496
468
|
*/
|
|
497
469
|
minHeight ? : string|number
|
|
498
470
|
/**
|
|
@@ -507,7 +479,7 @@ defineProps<{
|
|
|
507
479
|
/**
|
|
508
480
|
* Specify plugins (an array of classes) in config
|
|
509
481
|
*/
|
|
510
|
-
plugins ? :
|
|
482
|
+
plugins ? : InstancePlugin[]|InstancePlugin
|
|
511
483
|
/**
|
|
512
484
|
* True to preserve focused cell after loading new data
|
|
513
485
|
*/
|
|
@@ -529,54 +501,61 @@ defineProps<{
|
|
|
529
501
|
preventTooltipOnTouch ? : Boolean
|
|
530
502
|
/**
|
|
531
503
|
* Set to `true` to make the grid read-only, by disabling any UIs for modifying data.
|
|
532
|
-
* ...
|
|
533
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-readOnly)
|
|
504
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-readOnly)
|
|
534
505
|
*/
|
|
535
506
|
readOnly ? : Boolean
|
|
536
507
|
relayStoreEvents ? : Boolean
|
|
537
508
|
/**
|
|
538
509
|
* Either a default `rendition` to apply to all child widgets, or a map of renditions keyed by child widget
|
|
539
510
|
* `type`.
|
|
540
|
-
* ...
|
|
541
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-rendition)
|
|
511
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-rendition)
|
|
542
512
|
*/
|
|
543
513
|
rendition ? : string|Record<string, string>|null
|
|
544
514
|
/**
|
|
545
515
|
* Configure this property to allow the widget/component to be resized. Pressing <kbd>Shift</kbd> while resizing will
|
|
546
516
|
* constrain the aspect ratio.
|
|
547
|
-
* ...
|
|
548
|
-
* [
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
517
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-resizable)
|
|
518
|
+
* @property {number} [resizable.minWidth] The minimum width of the element.
|
|
519
|
+
* @property {number} [resizable.maxWidth] The maximum width of the element.
|
|
520
|
+
* @property {number} [resizable.minHeight] The minimum height of the element.
|
|
521
|
+
* @property {number} [resizable.maxHeight] The maximum height of the element
|
|
522
|
+
* @property {object} [resizable.handles] An object controlling which edges/corners are resizable.
|
|
523
|
+
* @property {boolean} [resizable.handles.topStart] Resizable from top-start corner
|
|
524
|
+
* @property {boolean} [resizable.handles.top] Resizable from top edge
|
|
525
|
+
* @property {boolean} [resizable.handles.topEnd] Resizable from top-end corner
|
|
526
|
+
* @property {boolean} [resizable.handles.end] Resizable from end edge
|
|
527
|
+
* @property {boolean} [resizable.handles.bottomEnd] Resizable from bottom-end corner
|
|
528
|
+
* @property {boolean} [resizable.handles.bottom] Resizable from bottom edge
|
|
529
|
+
* @property {boolean} [resizable.handles.bottomStart] Resizable from bottom-start corner
|
|
530
|
+
* @property {boolean} [resizable.handles.start] Resizable from start edge
|
|
531
|
+
*/
|
|
532
|
+
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 } }
|
|
557
533
|
/**
|
|
558
534
|
* Set to `false` to only measure cell contents when double-clicking the edge between column headers.
|
|
559
535
|
*/
|
|
560
536
|
resizeToFitIncludesHeader ? : Boolean
|
|
561
537
|
/**
|
|
562
538
|
* "Break points" for which responsive config to use for columns and css.
|
|
563
|
-
* ...
|
|
564
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-responsiveLevels)
|
|
539
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-responsiveLevels)
|
|
565
540
|
*/
|
|
566
541
|
responsiveLevels ? : Record<string, number|string|ResponsiveLevelConfig>
|
|
567
542
|
/**
|
|
568
543
|
* Configure as `true` to have the component display a translucent ripple when its
|
|
569
544
|
* [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
|
|
570
545
|
* current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
|
|
571
|
-
* ...
|
|
572
|
-
* [
|
|
546
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-ripple)
|
|
547
|
+
* @property {string} [delegate] A CSS selector to filter which child elements trigger ripples. By default, the ripple is clipped to the triggering element.
|
|
548
|
+
* @property {string} [color] A CSS color name or specification.
|
|
549
|
+
* @property {number} [radius] The ending radius of the ripple. Note that it will be clipped by the target element by default.
|
|
550
|
+
* @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.
|
|
551
|
+
*/
|
|
552
|
+
ripple ? : Boolean|object
|
|
553
|
+
/**
|
|
554
|
+
* The ARIA role to apply to this widget's element. By default, this is set to `'presentation'` to avoid
|
|
555
|
+
* accidentally applying a role which may interfere with screen readers.
|
|
556
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-role)
|
|
573
557
|
*/
|
|
574
|
-
|
|
575
|
-
delegate?: string
|
|
576
|
-
color?: string
|
|
577
|
-
radius?: number
|
|
578
|
-
clip?: string
|
|
579
|
-
}
|
|
558
|
+
role ? : string
|
|
580
559
|
/**
|
|
581
560
|
* 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`
|
|
582
561
|
*/
|
|
@@ -585,8 +564,7 @@ defineProps<{
|
|
|
585
564
|
* Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
|
|
586
565
|
* overridden by specifying a [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
|
|
587
566
|
* a column [renderer](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-renderer).
|
|
588
|
-
* ...
|
|
589
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-rowHeight)
|
|
567
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-rowHeight)
|
|
590
568
|
*/
|
|
591
569
|
rowHeight ? : number
|
|
592
570
|
/**
|
|
@@ -595,15 +573,13 @@ defineProps<{
|
|
|
595
573
|
rowLines ? : Boolean
|
|
596
574
|
/**
|
|
597
575
|
* This may be configured as `true` to make the widget's element use the `direction:rtl` style.
|
|
598
|
-
* ...
|
|
599
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-rtl)
|
|
576
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-rtl)
|
|
600
577
|
*/
|
|
601
578
|
rtl ? : Boolean
|
|
602
579
|
/**
|
|
603
580
|
* 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).
|
|
604
581
|
* See the [scrollerClass](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-scrollerClass) config option.
|
|
605
|
-
* ...
|
|
606
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-scrollable)
|
|
582
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-scrollable)
|
|
607
583
|
*/
|
|
608
584
|
scrollable ? : Boolean|ScrollerConfig|Scroller
|
|
609
585
|
/**
|
|
@@ -618,141 +594,122 @@ defineProps<{
|
|
|
618
594
|
/**
|
|
619
595
|
* Selection configuration settings, change these properties to control how selection works and what can be
|
|
620
596
|
* selected.
|
|
621
|
-
* ...
|
|
622
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-selectionMode)
|
|
597
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-selectionMode)
|
|
623
598
|
*/
|
|
624
599
|
selectionMode ? : GridSelectionMode
|
|
625
600
|
/**
|
|
626
601
|
* Configure as `true` to have the grid show a red "changed" tag in cells whose
|
|
627
602
|
* field value has changed and not yet been committed.
|
|
628
|
-
* ...
|
|
629
|
-
*
|
|
603
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-showDirty)
|
|
604
|
+
* @property {boolean} showDirty.duringEdit Set to `true` to show the red tag while editing a cell
|
|
605
|
+
* @property {boolean} showDirty.newRecord Set to `true` to show the red tag for all the cells of the new record
|
|
630
606
|
*/
|
|
631
|
-
showDirty ? : Boolean|{
|
|
632
|
-
duringEdit?: Boolean
|
|
633
|
-
newRecord?: Boolean
|
|
634
|
-
}
|
|
607
|
+
showDirty ? : Boolean|{ duringEdit: Boolean, newRecord: Boolean }
|
|
635
608
|
/**
|
|
636
609
|
* Programmatic control over how many columns to span when used in a grid layout.
|
|
637
610
|
*/
|
|
638
611
|
span ? : number
|
|
639
612
|
/**
|
|
640
613
|
* This value can be one of the following:
|
|
641
|
-
* ...
|
|
642
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-stateful)
|
|
614
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-stateful)
|
|
643
615
|
*/
|
|
644
616
|
stateful ? : Boolean|object|string[]
|
|
645
617
|
/**
|
|
646
618
|
* The events that, when fired by this component, should trigger it to save its state by calling
|
|
647
619
|
* [saveState](https://bryntum.com/products/grid/docs/api/Core/mixin/State#function-saveState).
|
|
648
|
-
* ...
|
|
649
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-statefulEvents)
|
|
620
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-statefulEvents)
|
|
650
621
|
*/
|
|
651
622
|
statefulEvents ? : object|string[]
|
|
652
623
|
/**
|
|
653
624
|
* 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
|
|
654
625
|
* 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)
|
|
655
626
|
* (if explicitly specified) will be used as the `stateId`.
|
|
656
|
-
* ...
|
|
657
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-stateId)
|
|
627
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-stateId)
|
|
658
628
|
*/
|
|
659
629
|
stateId ? : string
|
|
660
630
|
/**
|
|
661
631
|
* 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`
|
|
662
632
|
* will be saved using the [default state provider](https://bryntum.com/products/grid/docs/api/Core/state/StateProvider#property-instance-static).
|
|
663
|
-
* ...
|
|
664
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-stateProvider)
|
|
633
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-stateProvider)
|
|
665
634
|
*/
|
|
666
635
|
stateProvider ? : StateProvider
|
|
667
636
|
/**
|
|
668
637
|
* The properties of this settings object controls how grid is restored from state data.
|
|
669
|
-
* ...
|
|
670
|
-
* [
|
|
638
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-stateSettings)
|
|
639
|
+
* @property {boolean} [restoreUnconfiguredColumns] Determines whether to restore columns from the state that are not explicitly defined in the grid configuration.
|
|
671
640
|
*/
|
|
672
|
-
stateSettings ? :
|
|
673
|
-
restoreUnconfiguredColumns?: Boolean
|
|
674
|
-
}
|
|
641
|
+
stateSettings ? : object
|
|
675
642
|
/**
|
|
676
643
|
* The store instance or config object that holds the records to be displayed by this TreeGrid. If assigning
|
|
677
644
|
* a store instance, it must be configured with `tree: true`.
|
|
678
|
-
* ...
|
|
679
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-store)
|
|
645
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-store)
|
|
680
646
|
*/
|
|
681
647
|
store ? : Store|StoreConfig
|
|
682
648
|
/**
|
|
683
649
|
* An object containing widgets keyed by name. By default (when no `type` is given), strips are
|
|
684
650
|
* [toolbars](https://bryntum.com/products/grid/docs/api/Core/widget/Toolbar). If you want to pass an array, you can use
|
|
685
651
|
* the toolbar's [items](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-items).
|
|
686
|
-
* ...
|
|
687
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-strips)
|
|
652
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-strips)
|
|
688
653
|
*/
|
|
689
654
|
strips ? : Record<string, GridContainerItemConfig>
|
|
690
655
|
/**
|
|
691
656
|
* An object containing sub grid configuration objects keyed by a `region` property.
|
|
692
657
|
* By default, grid has a 'locked' region (if configured with locked columns) and a 'normal' region.
|
|
693
658
|
* The 'normal' region defaults to use `flex: 1`.
|
|
694
|
-
* ...
|
|
695
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-subGridConfigs)
|
|
659
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-subGridConfigs)
|
|
696
660
|
*/
|
|
697
661
|
subGridConfigs ? : Record<string, SubGridConfig>
|
|
698
662
|
/**
|
|
699
663
|
* A [Mask](https://bryntum.com/products/grid/docs/api/Core/widget/Mask) config object, or a message to be shown when Crud Manager
|
|
700
664
|
* is persisting changes on the server. Set to `null` to disable default sync mask.
|
|
701
|
-
* ...
|
|
702
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-syncMask)
|
|
665
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-syncMask)
|
|
703
666
|
*/
|
|
704
667
|
syncMask ? : string|MaskConfig|null
|
|
705
668
|
/**
|
|
706
669
|
* 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
|
|
707
670
|
* [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
|
|
708
671
|
* this widget:
|
|
709
|
-
* ...
|
|
710
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-tab)
|
|
672
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-tab)
|
|
711
673
|
*/
|
|
712
674
|
tab ? : Boolean|TabConfig
|
|
713
675
|
/**
|
|
714
676
|
* When this container is used as a tab in a TabPanel, these items are added to the
|
|
715
677
|
* [TabBar](https://bryntum.com/products/grid/docs/api/Core/widget/TabBar) when this container is the active tab.
|
|
716
|
-
* ...
|
|
717
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-tabBarItems)
|
|
678
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-tabBarItems)
|
|
718
679
|
*/
|
|
719
680
|
tabBarItems ? : ToolbarItems[]|Widget[]
|
|
720
681
|
/**
|
|
721
682
|
* A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/grid/docs/api/Core/widget/Toolbar),
|
|
722
683
|
* or array of config objects representing the child items of a Toolbar.
|
|
723
684
|
* This creates a toolbar docked to the top of the panel immediately below the header.
|
|
724
|
-
* ...
|
|
725
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-tbar)
|
|
685
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-tbar)
|
|
726
686
|
*/
|
|
727
687
|
tbar ? : (GridContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
|
|
728
688
|
/**
|
|
729
689
|
* A title to display in the header or owning TabPanel. Causes creation and docking of a header
|
|
730
690
|
* to the top if no header is configured.
|
|
731
|
-
* ...
|
|
732
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-title)
|
|
691
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-title)
|
|
733
692
|
*/
|
|
734
693
|
title ? : string
|
|
735
694
|
/**
|
|
736
695
|
* 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
|
|
737
696
|
* property name is the reference by which an instantiated tool may be retrieved from the live
|
|
738
697
|
* `[tools](https://bryntum.com/products/grid/docs/api/Core/widget/mixin/Toolable#property-tools)` property.
|
|
739
|
-
* ...
|
|
740
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-tools)
|
|
698
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-tools)
|
|
741
699
|
*/
|
|
742
700
|
tools ? : Record<string, ToolConfig>|null
|
|
743
701
|
/**
|
|
744
702
|
* Configure UI transitions for various actions in the grid.
|
|
703
|
+
* @property {boolean} insertRecord Transition record insertions
|
|
704
|
+
* @property {boolean} removeRecord Transition record removals
|
|
705
|
+
* @property {boolean} toggleColumn Transition column visibility changes
|
|
706
|
+
* @property {boolean} expandCollapseColumn Transition parent/group column expand/collapse
|
|
707
|
+
* @property {boolean} toggleRegion Transition region expand/collapse
|
|
708
|
+
* @property {boolean} toggleTreeNode Transition tree node expand/collapse
|
|
709
|
+
* @property {boolean} toggleGroup Transition group expand/collapse
|
|
710
|
+
* @property {boolean} filterRemoval Transition row removals caused by filtering (under specific conditions)
|
|
745
711
|
*/
|
|
746
|
-
transition ? :
|
|
747
|
-
insertRecord?: Boolean
|
|
748
|
-
removeRecord?: Boolean
|
|
749
|
-
toggleColumn?: Boolean
|
|
750
|
-
expandCollapseColumn?: Boolean
|
|
751
|
-
toggleRegion?: Boolean
|
|
752
|
-
toggleTreeNode?: Boolean
|
|
753
|
-
toggleGroup?: Boolean
|
|
754
|
-
filterRemoval?: Boolean
|
|
755
|
-
}
|
|
712
|
+
transition ? : object
|
|
756
713
|
/**
|
|
757
714
|
* Animation transition duration in milliseconds.
|
|
758
715
|
*/
|
|
@@ -762,8 +719,7 @@ defineProps<{
|
|
|
762
719
|
* Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
|
|
763
720
|
* as a space separated string, an array of strings, or as an object in which property names with truthy
|
|
764
721
|
* values are used as the class names.
|
|
765
|
-
* ...
|
|
766
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-ui)
|
|
722
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-ui)
|
|
767
723
|
*/
|
|
768
724
|
ui ? : 'plain'|'toolbar'|string|object
|
|
769
725
|
/**
|
|
@@ -784,129 +740,117 @@ defineProps<{
|
|
|
784
740
|
* agent and see the responses. Which allows the user to use natural language to interact with the Grid in different
|
|
785
741
|
* ways. For example, the user can ask the agent to filter the data, sort it, or select specific records. The agent can
|
|
786
742
|
* also perform data manipulation operations such as adding, updating, deleting records.
|
|
787
|
-
* ...
|
|
788
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/AI)
|
|
743
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/AI)
|
|
789
744
|
*/
|
|
790
745
|
aiFeature ? : object|Boolean|string|AI|AIConfig
|
|
791
746
|
/**
|
|
792
747
|
* AI-powered filter feature for Grid. Allows users to type natural language queries to filter grid data.
|
|
793
|
-
* ...
|
|
794
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/ai/AIFilter)
|
|
748
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/ai/AIFilter)
|
|
795
749
|
*/
|
|
796
750
|
aiFilterFeature ? : object|Boolean|string|AIFilter|AIFilterConfig
|
|
797
751
|
/**
|
|
798
752
|
* Allows using `[Ctrl/CMD + C]`, `[Ctrl/CMD + X]` and `[Ctrl/CMD + V]` to cut, copy and paste cell or cell ranges. Also
|
|
799
753
|
* makes cut, copy and paste actions available via the cell context menu.
|
|
800
|
-
* ...
|
|
801
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellCopyPaste)
|
|
754
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellCopyPaste)
|
|
802
755
|
*/
|
|
803
756
|
cellCopyPasteFeature ? : object|Boolean|string|CellCopyPaste|CellCopyPasteConfig
|
|
804
757
|
/**
|
|
805
758
|
* Adding this feature to the grid and other Bryntum products which are based on the Grid (i.e. Scheduler, SchedulerPro, and Gantt)
|
|
806
759
|
* enables cell editing. Any subclass of [Field](https://bryntum.com/products/grid/docs/api/Core/widget/Field) can be used
|
|
807
760
|
* as editor for the [Column](https://bryntum.com/products/grid/docs/api/Grid/column/Column). The most popular are:
|
|
808
|
-
* ...
|
|
809
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit)
|
|
761
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit)
|
|
810
762
|
*/
|
|
811
763
|
cellEditFeature ? : object|Boolean|string|CellEdit|CellEditConfig
|
|
812
764
|
/**
|
|
813
765
|
* Right click to display context menu for cells. To invoke the cell menu in a keyboard-accessible manner, use the
|
|
814
766
|
* <kbd>Space</kbd> key when the cell is focused.
|
|
815
|
-
* ...
|
|
816
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellMenu)
|
|
767
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellMenu)
|
|
817
768
|
*/
|
|
818
769
|
cellMenuFeature ? : object|Boolean|string|CellMenu|CellMenuConfig
|
|
819
770
|
/**
|
|
820
771
|
* Displays a tooltip when hovering cells.
|
|
821
|
-
* ...
|
|
822
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellTooltip)
|
|
772
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellTooltip)
|
|
823
773
|
*/
|
|
824
774
|
cellTooltipFeature ? : object|Boolean|string|CellTooltip|CellTooltipConfig
|
|
825
775
|
/**
|
|
826
776
|
* 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
|
|
827
777
|
* and updated in realtime as data changes. Supports many common chart types with extensive styling and customization
|
|
828
778
|
* options.
|
|
829
|
-
* ...
|
|
830
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Charts)
|
|
779
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/Charts)
|
|
831
780
|
*/
|
|
832
781
|
chartsFeature ? : object|Boolean|string|Charts|ChartsConfig
|
|
833
782
|
/**
|
|
834
|
-
* Enables the [autoWidth](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-autoWidth) config for a grid's columns.
|
|
835
|
-
*
|
|
836
|
-
*
|
|
783
|
+
* Enables the [autoWidth](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-autoWidth) config for a grid's columns. When a column
|
|
784
|
+
* has `autoWidth` set, this feature measures the rendered content of all visible cells in that column
|
|
785
|
+
* and adjusts the column width to fit. The measurement is triggered automatically when data changes
|
|
786
|
+
* or rows are rendered.
|
|
787
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnAutoWidth)
|
|
837
788
|
*/
|
|
838
789
|
columnAutoWidthFeature ? : object|Boolean|string|ColumnAutoWidth|ColumnAutoWidthConfig
|
|
839
790
|
/**
|
|
840
791
|
* Displays a toolbar while dragging column headers. Drop on a button in the toolbar to activate a certain function,
|
|
841
792
|
* for example to group by that column. This feature simplifies certain operations on touch devices.
|
|
842
|
-
* ...
|
|
843
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnDragToolbar)
|
|
793
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnDragToolbar)
|
|
844
794
|
*/
|
|
845
795
|
columnDragToolbarFeature ? : object|Boolean|string|ColumnDragToolbar|ColumnDragToolbarConfig
|
|
846
796
|
/**
|
|
847
797
|
* Displays a column picker (to show/hide columns) in the header context menu. Columns can be displayed in sub menus
|
|
848
798
|
* by region or tag. Grouped headers are displayed as menu hierarchies.
|
|
849
|
-
* ...
|
|
850
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnPicker)
|
|
799
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnPicker)
|
|
851
800
|
*/
|
|
852
801
|
columnPickerFeature ? : object|Boolean|string|ColumnPicker|ColumnPickerConfig
|
|
853
802
|
/**
|
|
854
803
|
* Allows user to rename columns by either right-clicking column header or using keyboard shortcuts when column header
|
|
855
804
|
* is focused.
|
|
856
|
-
* ...
|
|
857
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnRename)
|
|
805
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnRename)
|
|
858
806
|
*/
|
|
859
807
|
columnRenameFeature ? : object|Boolean|string|ColumnRename|ColumnRenameConfig
|
|
860
808
|
/**
|
|
861
|
-
* Allows user to reorder columns by dragging headers.
|
|
862
|
-
*
|
|
863
|
-
*
|
|
864
|
-
* [
|
|
809
|
+
* Allows user to reorder columns by dragging headers. Click and drag a column header to move it to a new position.
|
|
810
|
+
* Visual feedback shows the drop target while dragging. To get notified about column reorder, listen to the
|
|
811
|
+
* `change` event on the [columns](https://bryntum.com/products/grid/docs/api/Grid/data/ColumnStore) store.
|
|
812
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnReorder)
|
|
865
813
|
*/
|
|
866
814
|
columnReorderFeature ? : object|Boolean|string|ColumnReorder|ColumnReorderConfig
|
|
867
815
|
/**
|
|
868
|
-
* Enables user to resize columns by dragging a handle on the right hand side of the header.
|
|
869
|
-
*
|
|
870
|
-
*
|
|
871
|
-
* [
|
|
816
|
+
* Enables user to resize columns by dragging a handle on the right hand side of the header. A drag handle
|
|
817
|
+
* appears when hovering near the right edge of a column header. Dragging it adjusts the column width, respecting
|
|
818
|
+
* any [minWidth](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-minWidth) or [maxWidth](#Grid/column/Column#config-maxWidth) constraints.
|
|
819
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnResize)
|
|
872
820
|
*/
|
|
873
821
|
columnResizeFeature ? : object|Boolean|string|ColumnResize|ColumnResizeConfig
|
|
874
822
|
/**
|
|
875
823
|
* A feature that allows exporting Grid data to Excel or CSV without involving the server. It uses
|
|
876
824
|
* [TableExporter](https://bryntum.com/products/grid/docs/api/Grid/util/TableExporter) class as data provider, 3rd party provider to generate XLS files, and
|
|
877
825
|
* [Microsoft XML specification](https://msdn.microsoft.com/en-us/library/office/documentformat.openxml.spreadsheet.aspx).
|
|
878
|
-
* ...
|
|
879
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/ExcelExporter)
|
|
826
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/ExcelExporter)
|
|
880
827
|
*/
|
|
881
828
|
excelExporterFeature ? : object|Boolean|string|ExcelExporter|ExcelExporterConfig
|
|
882
829
|
/**
|
|
883
|
-
* An experimental feature that lets users drop files on a Widget. The widget fires
|
|
884
|
-
* In the event, you get access to the raw
|
|
885
|
-
*
|
|
886
|
-
* [
|
|
830
|
+
* An experimental feature that lets users drop files on a Widget. The widget fires a
|
|
831
|
+
* [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
|
|
832
|
+
* files as strings, that were parsed by calling `readAsBinaryString`.
|
|
833
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/FileDrop)
|
|
887
834
|
*/
|
|
888
835
|
fileDropFeature ? : object|Boolean|string|FileDrop|FileDropConfig
|
|
889
836
|
/**
|
|
890
837
|
* This feature adds a fill handle to a Grid range selection, which when dragged, fills the cells being dragged over
|
|
891
838
|
* with values based on the values in the original selected range. This is similar to functionality normally seen in
|
|
892
839
|
* various spreadsheet applications.
|
|
893
|
-
* ...
|
|
894
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/FillHandle)
|
|
840
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/FillHandle)
|
|
895
841
|
*/
|
|
896
842
|
fillHandleFeature ? : object|Boolean|string|FillHandle|FillHandleConfig
|
|
897
843
|
/**
|
|
898
844
|
* Feature that allows filtering of the grid by settings filters on columns. The actual filtering is done by the store.
|
|
899
845
|
* For info on programmatically handling filters, see [StoreFilter](https://bryntum.com/products/grid/docs/api/Core/data/mixin/StoreFilter).
|
|
900
|
-
* ...
|
|
901
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Filter)
|
|
846
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/Filter)
|
|
902
847
|
*/
|
|
903
848
|
filterFeature ? : object|Boolean|string|Filter|FilterConfig
|
|
904
849
|
/**
|
|
905
850
|
* Feature that allows filtering of the grid by entering filters on column headers.
|
|
906
851
|
* The actual filtering is done by the store.
|
|
907
852
|
* For info on programmatically handling filters, see [StoreFilter](https://bryntum.com/products/grid/docs/api/Core/data/mixin/StoreFilter).
|
|
908
|
-
* ...
|
|
909
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/FilterBar)
|
|
853
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/FilterBar)
|
|
910
854
|
*/
|
|
911
855
|
filterBarFeature ? : object|Boolean|string|FilterBar|FilterBarConfig
|
|
912
856
|
/**
|
|
@@ -914,141 +858,124 @@ defineProps<{
|
|
|
914
858
|
* <kbd>Shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
|
|
915
859
|
* one anywhere on grid). Use <kbd>Shift</kbd> + <kbd>Alt</kbd> + click, or the context menu, to remove a column
|
|
916
860
|
* grouper.
|
|
917
|
-
* ...
|
|
918
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Group)
|
|
861
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/Group)
|
|
919
862
|
*/
|
|
920
863
|
groupFeature ? : object|Boolean|string|Group|GroupConfig
|
|
921
864
|
/**
|
|
922
865
|
* Displays a summary row as a group footer in a grouped grid. Uses the same configuration options on columns as
|
|
923
866
|
* [Summary](https://bryntum.com/products/grid/docs/api/Grid/feature/Summary).
|
|
924
|
-
* ...
|
|
925
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/GroupSummary)
|
|
867
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/GroupSummary)
|
|
926
868
|
*/
|
|
927
869
|
groupSummaryFeature ? : object|Boolean|string|GroupSummary|GroupSummaryConfig
|
|
928
870
|
/**
|
|
929
871
|
* Right click column header or focus it and press SPACE key to show the context menu for headers.
|
|
930
|
-
* ...
|
|
931
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/HeaderMenu)
|
|
872
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/HeaderMenu)
|
|
932
873
|
*/
|
|
933
874
|
headerMenuFeature ? : object|Boolean|string|HeaderMenu|HeaderMenuConfig
|
|
934
875
|
/**
|
|
935
876
|
* This feature allows records which satisfy a certain condition to be locked at the top of the grid.
|
|
936
|
-
* ...
|
|
937
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/LockRows)
|
|
877
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/LockRows)
|
|
938
878
|
*/
|
|
939
879
|
lockRowsFeature ? : object|Boolean|string|LockRows|LockRowsConfig
|
|
940
880
|
/**
|
|
941
881
|
* 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
|
|
942
882
|
* configured to [mergeCells](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-mergeCells).
|
|
943
|
-
* ...
|
|
944
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/MergeCells)
|
|
883
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/MergeCells)
|
|
945
884
|
*/
|
|
946
885
|
mergeCellsFeature ? : object|Boolean|string|MergeCells|MergeCellsConfig
|
|
947
886
|
/**
|
|
948
887
|
* Generates PDF/PNG files from the Grid component.
|
|
949
|
-
* ...
|
|
950
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/export/PdfExport)
|
|
888
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/export/PdfExport)
|
|
951
889
|
*/
|
|
952
890
|
pdfExportFeature ? : object|Boolean|string|PdfExport|PdfExportConfig
|
|
953
891
|
/**
|
|
954
892
|
* Allows pinning columns to the start or end region of the grid without any additional subGrid configurations.
|
|
955
893
|
* When pinning to a region that does not yet exist, the feature creates the required subGrid on the fly.
|
|
956
|
-
* ...
|
|
957
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/PinColumns)
|
|
894
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/PinColumns)
|
|
958
895
|
*/
|
|
959
896
|
pinColumnsFeature ? : object|Boolean|string|PinColumns|PinColumnsConfig
|
|
960
897
|
/**
|
|
961
898
|
* Allows printing Grid contents using browser print dialog.
|
|
962
|
-
* ...
|
|
963
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/export/Print)
|
|
899
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/export/Print)
|
|
964
900
|
*/
|
|
965
901
|
printFeature ? : object|Boolean|string|Print|PrintConfig
|
|
966
902
|
/**
|
|
967
903
|
* Feature that allows the user to search in a column by focusing a cell and typing. Navigate between hits using the
|
|
968
|
-
* keyboard,
|
|
969
|
-
*
|
|
970
|
-
* [
|
|
904
|
+
* keyboard, <kbd>f3</kbd> or <kbd>ctrl</kbd>/<kbd>cmd</kbd> + <kbd>g</kbd> moves to next, also pressing
|
|
905
|
+
* <kbd>shift</kbd> moves to previous.
|
|
906
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/QuickFind)
|
|
971
907
|
*/
|
|
972
908
|
quickFindFeature ? : object|Boolean|string|QuickFind|QuickFindConfig
|
|
973
909
|
/**
|
|
974
910
|
* Makes the splitter between grid [sections](https://bryntum.com/products/grid/docs/api/Grid/view/SubGrid) draggable, to let users resize, and
|
|
975
911
|
* collapse/expand the sections.
|
|
976
|
-
* ...
|
|
977
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/RegionResize)
|
|
912
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/RegionResize)
|
|
978
913
|
*/
|
|
979
914
|
regionResizeFeature ? : object|Boolean|string|RegionResize|RegionResizeConfig
|
|
980
915
|
/**
|
|
981
916
|
* Allow using [Ctrl/CMD + C/X] and [Ctrl/CMD + V] to copy/cut-and-paste rows. Also makes cut, copy and paste actions
|
|
982
917
|
* available via the cell context menu.
|
|
983
|
-
* ...
|
|
984
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowCopyPaste)
|
|
918
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowCopyPaste)
|
|
985
919
|
*/
|
|
986
920
|
rowCopyPasteFeature ? : object|Boolean|string|RowCopyPaste|RowCopyPasteConfig
|
|
987
921
|
/**
|
|
988
922
|
* This feature allows editing of entire rows in a grid in a docked panel which by default slides out from the right.
|
|
989
|
-
* ...
|
|
990
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowEdit)
|
|
923
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowEdit)
|
|
991
924
|
*/
|
|
992
925
|
rowEditFeature ? : object|Boolean|string|RowEdit|RowEditConfig
|
|
993
926
|
/**
|
|
994
927
|
* Enables expanding of Grid rows by either row click or double click, or by adding a separate Grid column which renders
|
|
995
928
|
* a button that expands or collapses the row.
|
|
996
|
-
* ...
|
|
997
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowExpander)
|
|
929
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowExpander)
|
|
998
930
|
*/
|
|
999
931
|
rowExpanderFeature ? : object|Boolean|string|RowExpander|RowExpanderConfig
|
|
1000
932
|
/**
|
|
1001
933
|
* Allows user to reorder rows by dragging them. To get notified about row reorder listen to `change` event
|
|
1002
934
|
* on the grid [store](https://bryntum.com/products/grid/docs/api/Core/data/Store).
|
|
1003
|
-
* ...
|
|
1004
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowReorder)
|
|
935
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowReorder)
|
|
1005
936
|
*/
|
|
1006
937
|
rowReorderFeature ? : object|Boolean|string|RowReorder|RowReorderConfig
|
|
1007
938
|
/**
|
|
1008
939
|
* 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)
|
|
1009
940
|
* field of the record is updated (when [applyToAllRows](https://bryntum.com/products/grid/docs/api/Grid/feature/RowResize#config-applyToAllRows) is `false`).
|
|
1010
|
-
* ...
|
|
1011
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowResize)
|
|
941
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowResize)
|
|
1012
942
|
*/
|
|
1013
943
|
rowResizeFeature ? : object|Boolean|string|RowResize|RowResizeConfig
|
|
1014
944
|
/**
|
|
1015
945
|
* <div class="external-example vertical" data-file="Grid/feature/Search.js"></div>
|
|
1016
|
-
* ...
|
|
1017
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Search)
|
|
946
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/Search)
|
|
1018
947
|
*/
|
|
1019
948
|
searchFeature ? : object|Boolean|string|Search|SearchConfig
|
|
1020
949
|
/**
|
|
1021
950
|
* Allows sorting of grid by clicking (or tapping) headers, also displays which columns grid is sorted by (numbered if
|
|
1022
951
|
* using multisort). Use modifier keys for multisorting: [Ctrl/CMD + click] to add sorter, [Ctrl/CMD + Alt + click] to remove sorter.
|
|
1023
952
|
* The actual sorting is done by the store, see [Store.sort()](https://bryntum.com/products/grid/docs/api/Core/data/mixin/StoreSort#function-sort).
|
|
1024
|
-
* ...
|
|
1025
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Sort)
|
|
953
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/Sort)
|
|
1026
954
|
*/
|
|
1027
955
|
sortFeature ? : object|Boolean|string|Sort|SortConfig
|
|
1028
956
|
/**
|
|
1029
957
|
* This feature allows splitting the Grid into multiple views, either by using the cell context menu, or
|
|
1030
958
|
* programmatically by calling [split()](https://bryntum.com/products/grid/docs/api/Grid/feature/Split#function-split).
|
|
1031
|
-
* ...
|
|
1032
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Split)
|
|
959
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/Split)
|
|
1033
960
|
*/
|
|
1034
961
|
splitFeature ? : object|Boolean|string|Split|SplitConfig
|
|
1035
962
|
/**
|
|
1036
|
-
* A feature which pins
|
|
1037
|
-
*
|
|
1038
|
-
*
|
|
1039
|
-
* [
|
|
963
|
+
* A feature which pins cell content to the top of the grid while the row scrolls off the top but is still visible. Very
|
|
964
|
+
* similar to native `position: sticky`, which because of Grid's multiple-region setup unfortunately cannot be used to
|
|
965
|
+
* achieve the same effect.
|
|
966
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/StickyCells)
|
|
1040
967
|
*/
|
|
1041
968
|
stickyCellsFeature ? : object|Boolean|string|StickyCells|StickyCellsConfig
|
|
1042
969
|
/**
|
|
1043
970
|
* Stripes rows by adding alternating CSS classes to all row elements (`b-even` and `b-odd`).
|
|
1044
|
-
*
|
|
1045
|
-
*
|
|
971
|
+
* This improves visual readability in data-heavy grids by giving adjacent rows different background colors.
|
|
972
|
+
* Style the striped rows using the `.b-even` and `.b-odd` CSS classes.
|
|
973
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/Stripe)
|
|
1046
974
|
*/
|
|
1047
975
|
stripeFeature ? : object|Boolean|string|Stripe|StripeConfig
|
|
1048
976
|
/**
|
|
1049
977
|
* Displays a summary row in the grid footer.
|
|
1050
|
-
* ...
|
|
1051
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Summary)
|
|
978
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/Summary)
|
|
1052
979
|
*/
|
|
1053
980
|
summaryFeature ? : object|Boolean|string|Summary|SummaryConfig
|
|
1054
981
|
/**
|
|
@@ -1056,15 +983,13 @@ defineProps<{
|
|
|
1056
983
|
* 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
|
|
1057
984
|
* tree renderer that adds padding and icon to give the appearance of a tree. The original renderer is preserved and
|
|
1058
985
|
* also called.
|
|
1059
|
-
* ...
|
|
1060
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Tree)
|
|
986
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/Tree)
|
|
1061
987
|
*/
|
|
1062
988
|
treeFeature ? : object|Boolean|string|Tree|TreeConfig
|
|
1063
989
|
/**
|
|
1064
990
|
* A feature that allows transforming a flat dataset (or the leaves of a hierarchical) into a tree by specifying a
|
|
1065
991
|
* record field per parent level. Parents are generated based on each leaf's value for those fields.
|
|
1066
|
-
* ...
|
|
1067
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/TreeGroup)
|
|
992
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/TreeGroup)
|
|
1068
993
|
*/
|
|
1069
994
|
treeGroupFeature ? : object|Boolean|string|TreeGroup|TreeGroupConfig
|
|
1070
995
|
|
|
@@ -1084,8 +1009,7 @@ const emit = defineEmits<{
|
|
|
1084
1009
|
(e: 'beforeCancelCellEdit', params: ((event: { source: Grid, editorContext: GridLocation }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
1085
1010
|
/**
|
|
1086
1011
|
* 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.
|
|
1087
|
-
* ...
|
|
1088
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-beforeCancelRowEdit)
|
|
1012
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-beforeCancelRowEdit)
|
|
1089
1013
|
* @param {string} e Event name
|
|
1090
1014
|
* @param {object} params Event parameters
|
|
1091
1015
|
* @param {string} params.e Event name
|
|
@@ -1256,8 +1180,7 @@ const emit = defineEmits<{
|
|
|
1256
1180
|
(e: 'beforeFinishCellEdit', params: ((event: { grid: Grid, editorContext: CellEditorContext }) => void)|string): void
|
|
1257
1181
|
/**
|
|
1258
1182
|
* 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.
|
|
1259
|
-
* ...
|
|
1260
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-beforeFinishRowEdit)
|
|
1183
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-beforeFinishRowEdit)
|
|
1261
1184
|
* @param {string} e Event name
|
|
1262
1185
|
* @param {object} params Event parameters
|
|
1263
1186
|
* @param {string} params.e Event name
|
|
@@ -1326,8 +1249,7 @@ const emit = defineEmits<{
|
|
|
1326
1249
|
(e: 'beforeRenderRows', params: ((event: { source: GridBase }) => void)|string): void
|
|
1327
1250
|
/**
|
|
1328
1251
|
* This event fires before row collapse is started.
|
|
1329
|
-
* ...
|
|
1330
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-beforeRowCollapse)
|
|
1252
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-beforeRowCollapse)
|
|
1331
1253
|
* @param {string} e Event name
|
|
1332
1254
|
* @param {object} params Event parameters
|
|
1333
1255
|
* @param {string} params.e Event name
|
|
@@ -1338,8 +1260,7 @@ const emit = defineEmits<{
|
|
|
1338
1260
|
(e: 'beforeRowCollapse', params: ((event: { record: Model }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
1339
1261
|
/**
|
|
1340
1262
|
* This event fires before row expand is started.
|
|
1341
|
-
* ...
|
|
1342
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-beforeRowExpand)
|
|
1263
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-beforeRowExpand)
|
|
1343
1264
|
* @param {string} e Event name
|
|
1344
1265
|
* @param {object} params Event parameters
|
|
1345
1266
|
* @param {string} params.e Event name
|
|
@@ -1459,8 +1380,7 @@ const emit = defineEmits<{
|
|
|
1459
1380
|
(e: 'cancelCellEdit', params: ((event: { source: Grid, editorContext: GridLocation, event: Event }) => void)|string): void
|
|
1460
1381
|
/**
|
|
1461
1382
|
* Fires when any other event is fired from the object.
|
|
1462
|
-
* ...
|
|
1463
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-catchAll)
|
|
1383
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-catchAll)
|
|
1464
1384
|
* @param {string} e Event name
|
|
1465
1385
|
* @param {object} params Event parameters
|
|
1466
1386
|
* @param {string} params.e Event name
|
|
@@ -1518,8 +1438,7 @@ const emit = defineEmits<{
|
|
|
1518
1438
|
/**
|
|
1519
1439
|
* This event fires on the owning grid before the context menu is shown for a cell.
|
|
1520
1440
|
* 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).
|
|
1521
|
-
* ...
|
|
1522
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-cellMenuBeforeShow)
|
|
1441
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-cellMenuBeforeShow)
|
|
1523
1442
|
* @param {string} e Event name
|
|
1524
1443
|
* @param {object} params Event parameters
|
|
1525
1444
|
* @param {string} params.e Event name
|
|
@@ -1776,8 +1695,7 @@ const emit = defineEmits<{
|
|
|
1776
1695
|
(e: 'copy', params: ((event: { source: Grid, cells: GridLocation[], copiedDataString: string, isCut: boolean, entityName: string }) => void)|string): void
|
|
1777
1696
|
/**
|
|
1778
1697
|
* Fired when data in the store changes.
|
|
1779
|
-
* ...
|
|
1780
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-dataChange)
|
|
1698
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-dataChange)
|
|
1781
1699
|
* @param {string} e Event name
|
|
1782
1700
|
* @param {object} params Event parameters
|
|
1783
1701
|
* @param {string} params.e Event name
|
|
@@ -1933,8 +1851,7 @@ const emit = defineEmits<{
|
|
|
1933
1851
|
(e: 'finishCellEdit', params: ((event: { grid: Grid, editorContext: CellEditorContext }) => void)|string): void
|
|
1934
1852
|
/**
|
|
1935
1853
|
* 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.
|
|
1936
|
-
* ...
|
|
1937
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-finishRowEdit)
|
|
1854
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-finishRowEdit)
|
|
1938
1855
|
* @param {string} e Event name
|
|
1939
1856
|
* @param {object} params Event parameters
|
|
1940
1857
|
* @param {string} params.e Event name
|
|
@@ -2070,8 +1987,7 @@ const emit = defineEmits<{
|
|
|
2070
1987
|
(e: 'gridRowDrop', params: ((event: { source: GridBase, context: { valid: boolean, insertBefore: Model, parent: Model, records: Model[], oldPositionContext: RecordPositionContext[] }, event: MouseEvent }) => void)|string): void
|
|
2071
1988
|
/**
|
|
2072
1989
|
* Fired when a grid header is clicked on.
|
|
2073
|
-
* ...
|
|
2074
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-headerClick)
|
|
1990
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-headerClick)
|
|
2075
1991
|
* @param {string} e Event name
|
|
2076
1992
|
* @param {object} params Event parameters
|
|
2077
1993
|
* @param {string} params.e Event name
|
|
@@ -2084,8 +2000,7 @@ const emit = defineEmits<{
|
|
|
2084
2000
|
/**
|
|
2085
2001
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
2086
2002
|
* 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).
|
|
2087
|
-
* ...
|
|
2088
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-headerMenuBeforeShow)
|
|
2003
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-headerMenuBeforeShow)
|
|
2089
2004
|
* @param {string} e Event name
|
|
2090
2005
|
* @param {object} params Event parameters
|
|
2091
2006
|
* @param {string} params.e Event name
|
|
@@ -2180,8 +2095,7 @@ const emit = defineEmits<{
|
|
|
2180
2095
|
/**
|
|
2181
2096
|
* Triggered when a widget which had been in a non-visible state for any reason
|
|
2182
2097
|
* achieves visibility.
|
|
2183
|
-
* ...
|
|
2184
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-paint)
|
|
2098
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-paint)
|
|
2185
2099
|
* @param {string} e Event name
|
|
2186
2100
|
* @param {object} params Event parameters
|
|
2187
2101
|
* @param {string} params.e Event name
|
|
@@ -2212,8 +2126,8 @@ const emit = defineEmits<{
|
|
|
2212
2126
|
* @param {string} params.e Event name
|
|
2213
2127
|
* @param {object} params.params Event parameters
|
|
2214
2128
|
* @param {object} params.params.event Event object
|
|
2215
|
-
* @param {Response} params.params.event.response Optional response, if received
|
|
2216
|
-
* @param {Error} params.params.event.error Optional error, if exception occurred
|
|
2129
|
+
* @param {Response} [params.params.event.response] Optional response, if received
|
|
2130
|
+
* @param {Error} [params.params.event.error] Optional error, if exception occurred
|
|
2217
2131
|
*/
|
|
2218
2132
|
(e: 'pdfExport', params: ((event: { response?: Response, error?: Error }) => void)|string): void
|
|
2219
2133
|
/**
|
|
@@ -2294,8 +2208,7 @@ const emit = defineEmits<{
|
|
|
2294
2208
|
(e: 'rowCollapse', params: ((event: { record: Model }) => void)|string): void
|
|
2295
2209
|
/**
|
|
2296
2210
|
* This event fires when a row expand has finished expanding.
|
|
2297
|
-
* ...
|
|
2298
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-rowExpand)
|
|
2211
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-rowExpand)
|
|
2299
2212
|
* @param {string} e Event name
|
|
2300
2213
|
* @param {object} params Event parameters
|
|
2301
2214
|
* @param {string} params.e Event name
|
|
@@ -2501,7 +2414,7 @@ const emit = defineEmits<{
|
|
|
2501
2414
|
* @param {Core.data.Model} params.params.event.groupRecord [DEPRECATED] Use `groupRecords` param instead
|
|
2502
2415
|
* @param {Core.data.Model[]} params.params.event.groupRecords The group records being toggled
|
|
2503
2416
|
* @param {boolean} params.params.event.collapse Collapsed (true) or expanded (false)
|
|
2504
|
-
* @param {boolean} params.params.event.allRecords True if this event is part of toggling all groups
|
|
2417
|
+
* @param {boolean} [params.params.event.allRecords] True if this event is part of toggling all groups
|
|
2505
2418
|
*/
|
|
2506
2419
|
(e: 'toggleGroup', params: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, allRecords?: boolean }) => void)|string): void
|
|
2507
2420
|
/**
|
|
@@ -2662,6 +2575,7 @@ const widgetData = {
|
|
|
2662
2575
|
'resizeToFitIncludesHeader',
|
|
2663
2576
|
'responsiveLevels',
|
|
2664
2577
|
'ripple',
|
|
2578
|
+
'role',
|
|
2665
2579
|
'rootElement',
|
|
2666
2580
|
'scrollerClass',
|
|
2667
2581
|
'scrollManager',
|
|
@@ -2709,6 +2623,7 @@ const widgetData = {
|
|
|
2709
2623
|
'insertFirst',
|
|
2710
2624
|
'keyMap',
|
|
2711
2625
|
'labelPosition',
|
|
2626
|
+
'labelWidth',
|
|
2712
2627
|
'longPressTime',
|
|
2713
2628
|
'margin',
|
|
2714
2629
|
'maxHeight',
|
|
@@ -2852,8 +2767,6 @@ const widgetData = {
|
|
|
2852
2767
|
'width'
|
|
2853
2768
|
],
|
|
2854
2769
|
propertyNames : [
|
|
2855
|
-
'focusVisible',
|
|
2856
|
-
'hasChanges',
|
|
2857
2770
|
'originalStore',
|
|
2858
2771
|
'parent',
|
|
2859
2772
|
'selectedCell',
|