@bryntum/grid-vue-3-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.
- package/README.md +4 -4
- 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/{BQkqLHa6.js → BpNo5v3W.js} +9 -10
- package/lib/chunks/BpNo5v3W.js.map +1 -0
- package/lib/chunks/{CnbA4JoC.js → C87PnYXS.js} +12 -10
- package/lib/chunks/C87PnYXS.js.map +1 -0
- package/lib/chunks/{v3MxzI7J.js → C9RmZYoQ.js} +9 -7
- package/lib/chunks/C9RmZYoQ.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/{B5DiBj1m.js → DZ2V6NNc.js} +16 -14
- package/lib/chunks/DZ2V6NNc.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 +153 -224
- package/src/components/BryntumAIFilterFieldProps.ts +78 -110
- package/src/components/BryntumChecklistFilterCombo.vue +171 -258
- package/src/components/BryntumChecklistFilterComboProps.ts +95 -141
- package/src/components/BryntumGrid.vue +723 -1042
- package/src/components/BryntumGridBase.vue +723 -1042
- package/src/components/BryntumGridBaseProps.ts +186 -261
- package/src/components/BryntumGridChartDesigner.vue +101 -163
- package/src/components/BryntumGridChartDesignerProps.ts +55 -88
- package/src/components/BryntumGridFieldFilterPicker.vue +134 -216
- package/src/components/BryntumGridFieldFilterPickerGroup.vue +137 -220
- 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 +129 -205
- package/src/components/BryntumGroupBarProps.ts +61 -98
- package/src/components/BryntumThemeCombo.vue +60 -0
- package/src/components/BryntumTreeCombo.vue +172 -260
- package/src/components/BryntumTreeComboProps.ts +96 -143
- package/src/components/BryntumTreeGrid.vue +723 -1042
- 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
|
|
|
@@ -1075,595 +1000,495 @@ const emit = defineEmits<{
|
|
|
1075
1000
|
* Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
|
|
1076
1001
|
* @param {string} e Event name
|
|
1077
1002
|
* @param {object} params Event parameters
|
|
1078
|
-
* @param {
|
|
1079
|
-
* @param {
|
|
1080
|
-
* @param {
|
|
1081
|
-
* @param {Grid.view.Grid} params.params.event.source Owner grid
|
|
1082
|
-
* @param {Grid.util.GridLocation} params.params.event.editorContext Editing context
|
|
1003
|
+
* @param {object} params.event Event object
|
|
1004
|
+
* @param {Grid.view.Grid} params.event.source Owner grid
|
|
1005
|
+
* @param {Grid.util.GridLocation} params.event.editorContext Editing context
|
|
1083
1006
|
*/
|
|
1084
|
-
(e: 'beforeCancelCellEdit', params: ((event: { source: Grid, editorContext: GridLocation }) =>
|
|
1007
|
+
(e: 'beforeCancelCellEdit', params: ((event: { source: Grid, editorContext: GridLocation }) => boolean|void)|string): boolean|void
|
|
1085
1008
|
/**
|
|
1086
1009
|
* 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)
|
|
1010
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-beforeCancelRowEdit)
|
|
1089
1011
|
* @param {string} e Event name
|
|
1090
1012
|
* @param {object} params Event parameters
|
|
1091
|
-
* @param {
|
|
1092
|
-
* @param {
|
|
1093
|
-
* @param {
|
|
1094
|
-
* @param {Grid.view.Grid} params.params.event.grid Target grid
|
|
1095
|
-
* @param {RowEditorContext} params.params.event.editorContext Editing context
|
|
1013
|
+
* @param {object} params.event Event object
|
|
1014
|
+
* @param {Grid.view.Grid} params.event.grid Target grid
|
|
1015
|
+
* @param {RowEditorContext} params.event.editorContext Editing context
|
|
1096
1016
|
*/
|
|
1097
1017
|
(e: 'beforeCancelRowEdit', params: ((event: { grid: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
1098
1018
|
/**
|
|
1099
1019
|
* Fires on the owning Grid before editing starts, return `false` to prevent editing
|
|
1100
1020
|
* @param {string} e Event name
|
|
1101
1021
|
* @param {object} params Event parameters
|
|
1102
|
-
* @param {
|
|
1103
|
-
* @param {
|
|
1104
|
-
* @param {
|
|
1105
|
-
* @param {Grid.view.Grid} params.params.event.source Owner grid
|
|
1106
|
-
* @param {CellEditorContext} params.params.event.editorContext Editing context
|
|
1022
|
+
* @param {object} params.event Event object
|
|
1023
|
+
* @param {Grid.view.Grid} params.event.source Owner grid
|
|
1024
|
+
* @param {CellEditorContext} params.event.editorContext Editing context
|
|
1107
1025
|
*/
|
|
1108
|
-
(e: 'beforeCellEditStart', params: ((event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
1026
|
+
(e: 'beforeCellEditStart', params: ((event: { source: Grid, editorContext: CellEditorContext }) => boolean|void)|string): boolean|void
|
|
1109
1027
|
/**
|
|
1110
1028
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
1111
1029
|
* buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
|
|
1112
1030
|
* @param {string} e Event name
|
|
1113
1031
|
* @param {object} params Event parameters
|
|
1114
|
-
* @param {
|
|
1115
|
-
* @param {
|
|
1116
|
-
* @param {
|
|
1117
|
-
* @param {Grid.view.Grid} params.params.event.source Owner grid
|
|
1118
|
-
* @param {(Grid.util.GridLocation|Core.data.Model)[]} params.params.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).
|
|
1032
|
+
* @param {object} params.event Event object
|
|
1033
|
+
* @param {Grid.view.Grid} params.event.source Owner grid
|
|
1034
|
+
* @param {(Grid.util.GridLocation|Core.data.Model)[]} params.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).
|
|
1119
1035
|
*/
|
|
1120
|
-
(e: 'beforeCellRangeDelete', params: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
1036
|
+
(e: 'beforeCellRangeDelete', params: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void)|string): boolean|void
|
|
1121
1037
|
/**
|
|
1122
1038
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
1123
1039
|
* @param {string} e Event name
|
|
1124
1040
|
* @param {object} params Event parameters
|
|
1125
|
-
* @param {
|
|
1126
|
-
* @param {
|
|
1127
|
-
* @param {
|
|
1128
|
-
* @param {
|
|
1129
|
-
* @param {string} params.params.event.field The field being changed
|
|
1130
|
-
* @param {any} params.params.event.value The value being set
|
|
1041
|
+
* @param {object} params.event Event object
|
|
1042
|
+
* @param {Core.data.Model} params.event.record Current selected record from the range
|
|
1043
|
+
* @param {string} params.event.field The field being changed
|
|
1044
|
+
* @param {any} params.event.value The value being set
|
|
1131
1045
|
*/
|
|
1132
|
-
(e: 'beforeCellRangeEdit', params: ((event: { record: Model, field: string, value: any }) =>
|
|
1046
|
+
(e: 'beforeCellRangeEdit', params: ((event: { record: Model, field: string, value: any }) => boolean|void)|string): boolean|void
|
|
1133
1047
|
/**
|
|
1134
1048
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
1135
1049
|
* @param {string} e Event name
|
|
1136
1050
|
* @param {object} params Event parameters
|
|
1137
|
-
* @param {
|
|
1138
|
-
* @param {
|
|
1139
|
-
* @param {
|
|
1140
|
-
* @param {
|
|
1141
|
-
* @param {Grid.column.Column} params.params.event.column The column
|
|
1142
|
-
* @param {boolean} params.params.event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
1051
|
+
* @param {object} params.event Event object
|
|
1052
|
+
* @param {Grid.view.GridBase} params.event.source The grid instance
|
|
1053
|
+
* @param {Grid.column.Column} params.event.column The column
|
|
1054
|
+
* @param {boolean} params.event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
1143
1055
|
*/
|
|
1144
1056
|
(e: 'beforeColumnCollapseToggle', params: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string): void
|
|
1145
1057
|
/**
|
|
1146
1058
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
1147
1059
|
* @param {string} e Event name
|
|
1148
1060
|
* @param {object} params Event parameters
|
|
1149
|
-
* @param {
|
|
1150
|
-
* @param {
|
|
1151
|
-
* @param {
|
|
1152
|
-
* @param {
|
|
1153
|
-
* @param {Grid.column.Column} params.params.event.column The dragged column.
|
|
1154
|
-
* @param {Event} params.params.event.event The browser event.
|
|
1061
|
+
* @param {object} params.event Event object
|
|
1062
|
+
* @param {Grid.view.Grid} params.event.source The grid instance.
|
|
1063
|
+
* @param {Grid.column.Column} params.event.column The dragged column.
|
|
1064
|
+
* @param {Event} params.event.event The browser event.
|
|
1155
1065
|
*/
|
|
1156
|
-
(e: 'beforeColumnDragStart', params: ((event: { source: Grid, column: Column, event: Event }) =>
|
|
1066
|
+
(e: 'beforeColumnDragStart', params: ((event: { source: Grid, column: Column, event: Event }) => boolean|void)|string): boolean|void
|
|
1157
1067
|
/**
|
|
1158
1068
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
1159
1069
|
* @param {string} e Event name
|
|
1160
1070
|
* @param {object} params Event parameters
|
|
1161
|
-
* @param {
|
|
1162
|
-
* @param {
|
|
1163
|
-
* @param {
|
|
1164
|
-
* @param {Grid.
|
|
1165
|
-
* @param {Grid.column.Column} params.
|
|
1166
|
-
* @param {
|
|
1167
|
-
* @param {
|
|
1168
|
-
* @param {Event} params.params.event.event The browser event.
|
|
1169
|
-
* @param {string} params.params.event.region The region where the column was dropped.
|
|
1071
|
+
* @param {object} params.event Event object
|
|
1072
|
+
* @param {Grid.view.Grid} params.event.source The grid instance.
|
|
1073
|
+
* @param {Grid.column.Column} params.event.column The dragged column.
|
|
1074
|
+
* @param {Grid.column.Column} params.event.insertBefore The column before which the dragged column will be inserted.
|
|
1075
|
+
* @param {Grid.column.Column} params.event.newParent The new parent column.
|
|
1076
|
+
* @param {Event} params.event.event The browser event.
|
|
1077
|
+
* @param {string} params.event.region The region where the column was dropped.
|
|
1170
1078
|
*/
|
|
1171
|
-
(e: 'beforeColumnDropFinalize', params: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
1079
|
+
(e: 'beforeColumnDropFinalize', params: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void)|string): boolean|void
|
|
1172
1080
|
/**
|
|
1173
1081
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
1174
1082
|
* `false`.
|
|
1175
1083
|
* @param {string} e Event name
|
|
1176
1084
|
* @param {object} params Event parameters
|
|
1177
|
-
* @param {
|
|
1178
|
-
* @param {
|
|
1179
|
-
* @param {
|
|
1180
|
-
* @param {
|
|
1181
|
-
* @param {Grid.column.Column} params.params.event.column The column
|
|
1182
|
-
* @param {Event} params.params.event.domEvent The browser event
|
|
1085
|
+
* @param {object} params.event Event object
|
|
1086
|
+
* @param {Grid.view.Grid} params.event.source The grid instance
|
|
1087
|
+
* @param {Grid.column.Column} params.event.column The column
|
|
1088
|
+
* @param {Event} params.event.domEvent The browser event
|
|
1183
1089
|
*/
|
|
1184
|
-
(e: 'beforeColumnResize', params: ((event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
1090
|
+
(e: 'beforeColumnResize', params: ((event: { source: Grid, column: Column, domEvent: Event }) => boolean|void)|string): boolean|void
|
|
1185
1091
|
/**
|
|
1186
1092
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
1187
1093
|
* @param {string} e Event name
|
|
1188
1094
|
* @param {object} params Event parameters
|
|
1189
|
-
* @param {
|
|
1190
|
-
* @param {
|
|
1191
|
-
* @param {
|
|
1192
|
-
* @param {
|
|
1193
|
-
* @param {
|
|
1194
|
-
* @param {string} params.
|
|
1195
|
-
* @param {boolean} params.params.event.isCut `true` if this is a cut action
|
|
1196
|
-
* @param {string} params.params.event.entityName 'cell' to distinguish this event from other beforeCopy events
|
|
1095
|
+
* @param {object} params.event Event object
|
|
1096
|
+
* @param {Grid.view.Grid} params.event.source Owner grid
|
|
1097
|
+
* @param {Grid.util.GridLocation[]} params.event.cells The cells about to be copied or cut
|
|
1098
|
+
* @param {string} params.event.data The string data about to be copied or cut
|
|
1099
|
+
* @param {boolean} params.event.isCut `true` if this is a cut action
|
|
1100
|
+
* @param {string} params.event.entityName 'cell' to distinguish this event from other beforeCopy events
|
|
1197
1101
|
*/
|
|
1198
1102
|
(e: 'beforeCopy', params: ((event: { source: Grid, cells: GridLocation[], data: string, isCut: boolean, entityName: string }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
1199
1103
|
/**
|
|
1200
1104
|
* Fires on the owning Grid before CSV export starts. Return `false` to cancel the export.
|
|
1201
1105
|
* @param {string} e Event name
|
|
1202
1106
|
* @param {object} params Event parameters
|
|
1203
|
-
* @param {
|
|
1204
|
-
* @param {
|
|
1205
|
-
* @param {
|
|
1206
|
-
* @param {
|
|
1207
|
-
* @param {
|
|
1208
|
-
* @param {
|
|
1209
|
-
* @param {string} params.params.event.lineDelimiter The CSV delimiter to separate lines
|
|
1210
|
-
* @param {string} params.params.event.columnDelimiter The CSV delimiter to separate values on one line
|
|
1107
|
+
* @param {object} params.event Event object
|
|
1108
|
+
* @param {ExportConfig} params.event.config Export config
|
|
1109
|
+
* @param {Grid.column.Column[]} params.event.columns An array of columns to export
|
|
1110
|
+
* @param {Core.data.Model[]} params.event.rows An array of records to export
|
|
1111
|
+
* @param {string} params.event.lineDelimiter The CSV delimiter to separate lines
|
|
1112
|
+
* @param {string} params.event.columnDelimiter The CSV delimiter to separate values on one line
|
|
1211
1113
|
*/
|
|
1212
|
-
(e: 'beforeCSVExport', params: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
1114
|
+
(e: 'beforeCSVExport', params: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void)|string): boolean|void
|
|
1213
1115
|
/**
|
|
1214
1116
|
* Fires before an object is destroyed.
|
|
1215
1117
|
* @param {string} e Event name
|
|
1216
1118
|
* @param {object} params Event parameters
|
|
1217
|
-
* @param {
|
|
1218
|
-
* @param {
|
|
1219
|
-
* @param {object} params.params.event Event object
|
|
1220
|
-
* @param {Core.Base} params.params.event.source The Object that is being destroyed.
|
|
1119
|
+
* @param {object} params.event Event object
|
|
1120
|
+
* @param {Core.Base} params.event.source The Object that is being destroyed.
|
|
1221
1121
|
*/
|
|
1222
1122
|
(e: 'beforeDestroy', params: ((event: { source: Base }) => void)|string): void
|
|
1223
1123
|
/**
|
|
1224
1124
|
* Fires on the owning Grid before Excel export starts. Return `false` to cancel the export.
|
|
1225
1125
|
* @param {string} e Event name
|
|
1226
1126
|
* @param {object} params Event parameters
|
|
1227
|
-
* @param {
|
|
1228
|
-
* @param {
|
|
1229
|
-
* @param {
|
|
1230
|
-
* @param {
|
|
1231
|
-
* @param {XLSColumn[]} params.params.event.columns An array of columns to export
|
|
1232
|
-
* @param {any[][]} params.params.event.rows An array of records to export
|
|
1127
|
+
* @param {object} params.event Event object
|
|
1128
|
+
* @param {ExportConfig} params.event.config Export config
|
|
1129
|
+
* @param {XLSColumn[]} params.event.columns An array of columns to export
|
|
1130
|
+
* @param {any[][]} params.event.rows An array of records to export
|
|
1233
1131
|
*/
|
|
1234
|
-
(e: 'beforeExcelExport', params: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
1132
|
+
(e: 'beforeExcelExport', params: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void)|string): boolean|void
|
|
1235
1133
|
/**
|
|
1236
1134
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
1237
1135
|
* @param {string} e Event name
|
|
1238
1136
|
* @param {object} params Event parameters
|
|
1239
|
-
* @param {
|
|
1240
|
-
* @param {
|
|
1241
|
-
* @param {
|
|
1242
|
-
* @param {Grid.util.GridLocation} params.params.event.cell Information about the column / record
|
|
1243
|
-
* @param {MouseEvent} params.params.event.domEvent The raw DOM event
|
|
1137
|
+
* @param {object} params.event Event object
|
|
1138
|
+
* @param {Grid.util.GridLocation} params.event.cell Information about the column / record
|
|
1139
|
+
* @param {MouseEvent} params.event.domEvent The raw DOM event
|
|
1244
1140
|
*/
|
|
1245
|
-
(e: 'beforeFillHandleDragStart', params: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
1141
|
+
(e: 'beforeFillHandleDragStart', params: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string): boolean|void
|
|
1246
1142
|
/**
|
|
1247
1143
|
* 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.
|
|
1248
1144
|
* @param {string} e Event name
|
|
1249
1145
|
* @param {object} params Event parameters
|
|
1250
|
-
* @param {
|
|
1251
|
-
* @param {
|
|
1252
|
-
* @param {
|
|
1253
|
-
* @param {Grid.view.Grid} params.params.event.grid Target grid
|
|
1254
|
-
* @param {CellEditorContext} params.params.event.editorContext Editing context
|
|
1146
|
+
* @param {object} params.event Event object
|
|
1147
|
+
* @param {Grid.view.Grid} params.event.grid Target grid
|
|
1148
|
+
* @param {CellEditorContext} params.event.editorContext Editing context
|
|
1255
1149
|
*/
|
|
1256
1150
|
(e: 'beforeFinishCellEdit', params: ((event: { grid: Grid, editorContext: CellEditorContext }) => void)|string): void
|
|
1257
1151
|
/**
|
|
1258
1152
|
* 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)
|
|
1153
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-beforeFinishRowEdit)
|
|
1261
1154
|
* @param {string} e Event name
|
|
1262
1155
|
* @param {object} params Event parameters
|
|
1263
|
-
* @param {
|
|
1264
|
-
* @param {
|
|
1265
|
-
* @param {
|
|
1266
|
-
* @param {Grid.view.Grid} params.params.event.grid Target grid
|
|
1267
|
-
* @param {RowEditorContext} params.params.event.editorContext Editing context
|
|
1156
|
+
* @param {object} params.event Event object
|
|
1157
|
+
* @param {Grid.view.Grid} params.event.grid Target grid
|
|
1158
|
+
* @param {RowEditorContext} params.event.editorContext Editing context
|
|
1268
1159
|
*/
|
|
1269
1160
|
(e: 'beforeFinishRowEdit', params: ((event: { grid: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
1270
1161
|
/**
|
|
1271
1162
|
* Triggered before a widget is hidden. Return `false` to prevent the action.
|
|
1272
1163
|
* @param {string} e Event name
|
|
1273
1164
|
* @param {object} params Event parameters
|
|
1274
|
-
* @param {
|
|
1275
|
-
* @param {
|
|
1276
|
-
* @param {object} params.params.event Event object
|
|
1277
|
-
* @param {Core.widget.Widget} params.params.event.source The widget being hidden.
|
|
1165
|
+
* @param {object} params.event Event object
|
|
1166
|
+
* @param {Core.widget.Widget} params.event.source The widget being hidden.
|
|
1278
1167
|
*/
|
|
1279
|
-
(e: 'beforeHide', params: ((event: { source: Widget }) =>
|
|
1168
|
+
(e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
|
|
1280
1169
|
/**
|
|
1281
1170
|
* Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
|
|
1282
1171
|
* @param {string} e Event name
|
|
1283
1172
|
* @param {object} params Event parameters
|
|
1284
|
-
* @param {
|
|
1285
|
-
* @param {
|
|
1286
|
-
* @param {
|
|
1287
|
-
* @param {Grid.
|
|
1288
|
-
* @param {string} params.
|
|
1289
|
-
* @param {
|
|
1290
|
-
* @param {string} params.params.event.entityName 'cell' to distinguish this event from other beforePaste events
|
|
1291
|
-
* @param {string} params.params.event.text The raw text from clipboard
|
|
1173
|
+
* @param {object} params.event Event object
|
|
1174
|
+
* @param {Grid.view.Grid} params.event.source Owner grid
|
|
1175
|
+
* @param {string} params.event.clipboardData The clipboardData about to be pasted
|
|
1176
|
+
* @param {Grid.util.GridLocation} params.event.targetCell The cell from which the paste will be started
|
|
1177
|
+
* @param {string} params.event.entityName 'cell' to distinguish this event from other beforePaste events
|
|
1178
|
+
* @param {string} params.event.text The raw text from clipboard
|
|
1292
1179
|
*/
|
|
1293
1180
|
(e: 'beforePaste', params: ((event: { source: Grid, clipboardData: string, targetCell: GridLocation, entityName: string, text: string }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
1294
1181
|
/**
|
|
1295
1182
|
* Fires on the owning Grid before export started. Return `false` to cancel the export.
|
|
1296
1183
|
* @param {string} e Event name
|
|
1297
1184
|
* @param {object} params Event parameters
|
|
1298
|
-
* @param {
|
|
1299
|
-
* @param {
|
|
1300
|
-
* @param {object} params.params.event Event object
|
|
1301
|
-
* @param {PdfExportConfig} params.params.event.config Export config
|
|
1185
|
+
* @param {object} params.event Event object
|
|
1186
|
+
* @param {PdfExportConfig} params.event.config Export config
|
|
1302
1187
|
*/
|
|
1303
|
-
(e: 'beforePdfExport', params: ((event: { config: PdfExportConfig }) =>
|
|
1188
|
+
(e: 'beforePdfExport', params: ((event: { config: PdfExportConfig }) => boolean|void)|string): boolean|void
|
|
1304
1189
|
/**
|
|
1305
1190
|
* Fires before a row is rendered.
|
|
1306
1191
|
* @param {string} e Event name
|
|
1307
1192
|
* @param {object} params Event parameters
|
|
1308
|
-
* @param {
|
|
1309
|
-
* @param {
|
|
1310
|
-
* @param {
|
|
1311
|
-
* @param {
|
|
1312
|
-
* @param {
|
|
1313
|
-
* @param {Core.data.Model} params.params.event.record The record for the row
|
|
1314
|
-
* @param {number} params.params.event.recordIndex The zero-based index of the record
|
|
1193
|
+
* @param {object} params.event Event object
|
|
1194
|
+
* @param {Grid.view.GridBase} params.event.source The firing Grid instance
|
|
1195
|
+
* @param {Grid.row.Row} params.event.row The row about to be rendered
|
|
1196
|
+
* @param {Core.data.Model} params.event.record The record for the row
|
|
1197
|
+
* @param {number} params.event.recordIndex The zero-based index of the record
|
|
1315
1198
|
*/
|
|
1316
1199
|
(e: 'beforeRenderRow', params: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string): void
|
|
1317
1200
|
/**
|
|
1318
1201
|
* Grid rows are about to be rendered
|
|
1319
1202
|
* @param {string} e Event name
|
|
1320
1203
|
* @param {object} params Event parameters
|
|
1321
|
-
* @param {
|
|
1322
|
-
* @param {
|
|
1323
|
-
* @param {object} params.params.event Event object
|
|
1324
|
-
* @param {Grid.view.GridBase} params.params.event.source This grid.
|
|
1204
|
+
* @param {object} params.event Event object
|
|
1205
|
+
* @param {Grid.view.GridBase} params.event.source This grid.
|
|
1325
1206
|
*/
|
|
1326
1207
|
(e: 'beforeRenderRows', params: ((event: { source: GridBase }) => void)|string): void
|
|
1327
1208
|
/**
|
|
1328
1209
|
* 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)
|
|
1210
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-beforeRowCollapse)
|
|
1331
1211
|
* @param {string} e Event name
|
|
1332
1212
|
* @param {object} params Event parameters
|
|
1333
|
-
* @param {
|
|
1334
|
-
* @param {
|
|
1335
|
-
* @param {object} params.params.event Event object
|
|
1336
|
-
* @param {Core.data.Model} params.params.event.record Record
|
|
1213
|
+
* @param {object} params.event Event object
|
|
1214
|
+
* @param {Core.data.Model} params.event.record Record
|
|
1337
1215
|
*/
|
|
1338
1216
|
(e: 'beforeRowCollapse', params: ((event: { record: Model }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
1339
1217
|
/**
|
|
1340
1218
|
* 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)
|
|
1219
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-beforeRowExpand)
|
|
1343
1220
|
* @param {string} e Event name
|
|
1344
1221
|
* @param {object} params Event parameters
|
|
1345
|
-
* @param {
|
|
1346
|
-
* @param {
|
|
1347
|
-
* @param {object} params.params.event Event object
|
|
1348
|
-
* @param {Core.data.Model} params.params.event.record Record
|
|
1222
|
+
* @param {object} params.event Event object
|
|
1223
|
+
* @param {Core.data.Model} params.event.record Record
|
|
1349
1224
|
*/
|
|
1350
1225
|
(e: 'beforeRowExpand', params: ((event: { record: Model }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
1351
1226
|
/**
|
|
1352
1227
|
* Fires before the selection changes. Returning `false` from a listener prevents the change
|
|
1353
1228
|
* @param {string} e Event name
|
|
1354
1229
|
* @param {object} params Event parameters
|
|
1355
|
-
* @param {
|
|
1356
|
-
* @param {
|
|
1357
|
-
* @param {
|
|
1358
|
-
* @param {
|
|
1359
|
-
* @param {
|
|
1360
|
-
* @param {
|
|
1361
|
-
* @param {Core.data.Model[]} params.
|
|
1362
|
-
* @param {
|
|
1363
|
-
* @param {
|
|
1364
|
-
* @param {Grid.util.GridLocation[]} params.
|
|
1365
|
-
* @param {Grid.util.GridLocation[]} params.params.event.selectedCells The cells to be selected in this operation.
|
|
1366
|
-
* @param {Grid.util.GridLocation[]} params.params.event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
1230
|
+
* @param {object} params.event Event object
|
|
1231
|
+
* @param {string} params.event.action `'select'`/`'deselect'`
|
|
1232
|
+
* @param {'row','cell'} params.event.mode `'row'`/`'cell'`
|
|
1233
|
+
* @param {Grid.view.Grid} params.event.source
|
|
1234
|
+
* @param {Core.data.Model[]} params.event.deselected The records to be deselected in this operation.
|
|
1235
|
+
* @param {Core.data.Model[]} params.event.selected The records to be selected in this operation.
|
|
1236
|
+
* @param {Core.data.Model[]} params.event.selection The records in the current selection, before applying `selected` and `deselected`
|
|
1237
|
+
* @param {Grid.util.GridLocation[]} params.event.deselectedCells The cells to be deselected in this operation.
|
|
1238
|
+
* @param {Grid.util.GridLocation[]} params.event.selectedCells The cells to be selected in this operation.
|
|
1239
|
+
* @param {Grid.util.GridLocation[]} params.event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
1367
1240
|
*/
|
|
1368
|
-
(e: 'beforeSelectionChange', params: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
1241
|
+
(e: 'beforeSelectionChange', params: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => boolean|void)|string): boolean|void
|
|
1369
1242
|
/**
|
|
1370
1243
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
1371
1244
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
1372
1245
|
* @param {string} e Event name
|
|
1373
1246
|
* @param {object} params Event parameters
|
|
1374
|
-
* @param {
|
|
1375
|
-
* @param {
|
|
1376
|
-
* @param {
|
|
1377
|
-
* @param {Core.widget.Container} params.params.event.source The container
|
|
1378
|
-
* @param {Core.data.Model} params.params.event.record The record
|
|
1247
|
+
* @param {object} params.event Event object
|
|
1248
|
+
* @param {Core.widget.Container} params.event.source The container
|
|
1249
|
+
* @param {Core.data.Model} params.event.record The record
|
|
1379
1250
|
*/
|
|
1380
1251
|
(e: 'beforeSetRecord', params: ((event: { source: Container, record: Model }) => void)|string): void
|
|
1381
1252
|
/**
|
|
1382
1253
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
1383
1254
|
* @param {string} e Event name
|
|
1384
1255
|
* @param {object} params Event parameters
|
|
1385
|
-
* @param {
|
|
1386
|
-
* @param {
|
|
1387
|
-
* @param {object} params.params.event Event object
|
|
1388
|
-
* @param {Core.widget.Widget,any} params.params.event.source The widget being shown
|
|
1256
|
+
* @param {object} params.event Event object
|
|
1257
|
+
* @param {Core.widget.Widget,any} params.event.source The widget being shown
|
|
1389
1258
|
*/
|
|
1390
1259
|
(e: 'beforeShow', params: ((event: { source: Widget|any }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
1391
1260
|
/**
|
|
1392
1261
|
* Fires on the owning Grid before editing starts, return `false` to prevent editing
|
|
1393
1262
|
* @param {string} e Event name
|
|
1394
1263
|
* @param {object} params Event parameters
|
|
1395
|
-
* @param {
|
|
1396
|
-
* @param {
|
|
1397
|
-
* @param {
|
|
1398
|
-
* @param {Grid.view.Grid} params.params.event.source Owner grid
|
|
1399
|
-
* @param {RowEditorContext} params.params.event.editorContext Editing context
|
|
1264
|
+
* @param {object} params.event Event object
|
|
1265
|
+
* @param {Grid.view.Grid} params.event.source Owner grid
|
|
1266
|
+
* @param {RowEditorContext} params.event.editorContext Editing context
|
|
1400
1267
|
*/
|
|
1401
|
-
(e: 'beforeStartRowEdit', params: ((event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
1268
|
+
(e: 'beforeStartRowEdit', params: ((event: { source: Grid, editorContext: RowEditorContext }) => boolean|void)|string): boolean|void
|
|
1402
1269
|
/**
|
|
1403
1270
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
1404
1271
|
* @param {string} e Event name
|
|
1405
1272
|
* @param {object} params Event parameters
|
|
1406
|
-
* @param {
|
|
1407
|
-
* @param {
|
|
1408
|
-
* @param {object} params.params.event Event object
|
|
1409
|
-
* @param {GridStateInfo} params.params.event.state State object config
|
|
1273
|
+
* @param {object} params.event Event object
|
|
1274
|
+
* @param {GridStateInfo} params.event.state State object config
|
|
1410
1275
|
*/
|
|
1411
|
-
(e: 'beforeStateApply', params: ((event: { state: GridStateInfo }) =>
|
|
1276
|
+
(e: 'beforeStateApply', params: ((event: { state: GridStateInfo }) => boolean|void)|string): boolean|void
|
|
1412
1277
|
/**
|
|
1413
1278
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
1414
1279
|
* @param {string} e Event name
|
|
1415
1280
|
* @param {object} params Event parameters
|
|
1416
|
-
* @param {
|
|
1417
|
-
* @param {
|
|
1418
|
-
* @param {object} params.params.event Event object
|
|
1419
|
-
* @param {GridStateInfo} params.params.event.state State object config
|
|
1281
|
+
* @param {object} params.event Event object
|
|
1282
|
+
* @param {GridStateInfo} params.event.state State object config
|
|
1420
1283
|
*/
|
|
1421
|
-
(e: 'beforeStateSave', params: ((event: { state: GridStateInfo }) =>
|
|
1284
|
+
(e: 'beforeStateSave', params: ((event: { state: GridStateInfo }) => boolean|void)|string): boolean|void
|
|
1422
1285
|
/**
|
|
1423
1286
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
1424
1287
|
* Returning `false` from a listener prevents the operation
|
|
1425
1288
|
* @param {string} e Event name
|
|
1426
1289
|
* @param {object} params Event parameters
|
|
1427
|
-
* @param {
|
|
1428
|
-
* @param {
|
|
1429
|
-
* @param {
|
|
1430
|
-
* @param {
|
|
1431
|
-
* @param {
|
|
1432
|
-
* @param {boolean} params.params.event.collapse Collapsed (true) or expanded (false)
|
|
1433
|
-
* @param {Event} params.params.event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
1290
|
+
* @param {object} params.event Event object
|
|
1291
|
+
* @param {Core.data.Model} params.event.groupRecord [DEPRECATED] Use `groupRecords` param instead
|
|
1292
|
+
* @param {Core.data.Model[]} params.event.groupRecords The group records being toggled
|
|
1293
|
+
* @param {boolean} params.event.collapse Collapsed (true) or expanded (false)
|
|
1294
|
+
* @param {Event} params.event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
1434
1295
|
*/
|
|
1435
|
-
(e: 'beforeToggleGroup', params: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
1296
|
+
(e: 'beforeToggleGroup', params: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void)|string): boolean|void
|
|
1436
1297
|
/**
|
|
1437
1298
|
* Fired before a parent node record toggles its collapsed state.
|
|
1438
1299
|
* @param {string} e Event name
|
|
1439
1300
|
* @param {object} params Event parameters
|
|
1440
|
-
* @param {
|
|
1441
|
-
* @param {
|
|
1442
|
-
* @param {
|
|
1443
|
-
* @param {
|
|
1444
|
-
* @param {Core.data.Model} params.params.event.record The record being toggled.
|
|
1445
|
-
* @param {boolean} params.params.event.collapse `true` if the node is being collapsed.
|
|
1301
|
+
* @param {object} params.event Event object
|
|
1302
|
+
* @param {Grid.view.Grid} params.event.source The firing Grid instance.
|
|
1303
|
+
* @param {Core.data.Model} params.event.record The record being toggled.
|
|
1304
|
+
* @param {boolean} params.event.collapse `true` if the node is being collapsed.
|
|
1446
1305
|
*/
|
|
1447
1306
|
(e: 'beforeToggleNode', params: ((event: { source: Grid, record: Model, collapse: boolean }) => void)|string): void
|
|
1448
1307
|
/**
|
|
1449
1308
|
* Fires on the owning Grid when editing is cancelled
|
|
1450
1309
|
* @param {string} e Event name
|
|
1451
1310
|
* @param {object} params Event parameters
|
|
1452
|
-
* @param {
|
|
1453
|
-
* @param {
|
|
1454
|
-
* @param {
|
|
1455
|
-
* @param {
|
|
1456
|
-
* @param {Grid.util.GridLocation} params.params.event.editorContext Editing context
|
|
1457
|
-
* @param {Event} params.params.event.event Included if the cancellation was triggered by a DOM event
|
|
1311
|
+
* @param {object} params.event Event object
|
|
1312
|
+
* @param {Grid.view.Grid} params.event.source Owner grid
|
|
1313
|
+
* @param {Grid.util.GridLocation} params.event.editorContext Editing context
|
|
1314
|
+
* @param {Event} params.event.event Included if the cancellation was triggered by a DOM event
|
|
1458
1315
|
*/
|
|
1459
1316
|
(e: 'cancelCellEdit', params: ((event: { source: Grid, editorContext: GridLocation, event: Event }) => void)|string): void
|
|
1460
1317
|
/**
|
|
1461
1318
|
* 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)
|
|
1319
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-catchAll)
|
|
1464
1320
|
* @param {string} e Event name
|
|
1465
1321
|
* @param {object} params Event parameters
|
|
1466
|
-
* @param {
|
|
1467
|
-
* @param {
|
|
1468
|
-
* @param {
|
|
1469
|
-
* @param {{[key: string]: any, type: string}} params.params.event.event The Object that contains event details
|
|
1470
|
-
* @param {string} params.params.event.event.type The type of the event which is caught by the listener
|
|
1322
|
+
* @param {object} params.event Event object
|
|
1323
|
+
* @param {{[key: string]: any, type: string}} params.event.event The Object that contains event details
|
|
1324
|
+
* @param {string} params.event.event.type The type of the event which is caught by the listener
|
|
1471
1325
|
*/
|
|
1472
1326
|
(e: 'catchAll', params: ((event: {[key: string]: any, type: string}) => void)|string): void
|
|
1473
1327
|
/**
|
|
1474
1328
|
* Fired when user clicks in a grid cell
|
|
1475
1329
|
* @param {string} e Event name
|
|
1476
1330
|
* @param {object} params Event parameters
|
|
1477
|
-
* @param {
|
|
1478
|
-
* @param {
|
|
1479
|
-
* @param {
|
|
1480
|
-
* @param {Grid.
|
|
1481
|
-
* @param {
|
|
1482
|
-
* @param {
|
|
1483
|
-
* @param {
|
|
1484
|
-
* @param {HTMLElement} params.params.event.target The target element
|
|
1485
|
-
* @param {MouseEvent} params.params.event.event The native DOM event
|
|
1331
|
+
* @param {object} params.event Event object
|
|
1332
|
+
* @param {Grid.view.Grid} params.event.grid The grid instance
|
|
1333
|
+
* @param {Core.data.Model} params.event.record The record representing the row
|
|
1334
|
+
* @param {Grid.column.Column} params.event.column The column to which the cell belongs
|
|
1335
|
+
* @param {HTMLElement} params.event.cellElement The cell HTML element
|
|
1336
|
+
* @param {HTMLElement} params.event.target The target element
|
|
1337
|
+
* @param {MouseEvent} params.event.event The native DOM event
|
|
1486
1338
|
*/
|
|
1487
1339
|
(e: 'cellClick', params: ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string): void
|
|
1488
1340
|
/**
|
|
1489
1341
|
* Fired when user activates contextmenu in a grid cell
|
|
1490
1342
|
* @param {string} e Event name
|
|
1491
1343
|
* @param {object} params Event parameters
|
|
1492
|
-
* @param {
|
|
1493
|
-
* @param {
|
|
1494
|
-
* @param {
|
|
1495
|
-
* @param {Grid.
|
|
1496
|
-
* @param {
|
|
1497
|
-
* @param {
|
|
1498
|
-
* @param {
|
|
1499
|
-
* @param {HTMLElement} params.params.event.target The target element
|
|
1500
|
-
* @param {MouseEvent} params.params.event.event The native DOM event
|
|
1344
|
+
* @param {object} params.event Event object
|
|
1345
|
+
* @param {Grid.view.Grid} params.event.grid The grid instance
|
|
1346
|
+
* @param {Core.data.Model} params.event.record The record representing the row
|
|
1347
|
+
* @param {Grid.column.Column} params.event.column The column to which the cell belongs
|
|
1348
|
+
* @param {HTMLElement} params.event.cellElement The cell HTML element
|
|
1349
|
+
* @param {HTMLElement} params.event.target The target element
|
|
1350
|
+
* @param {MouseEvent} params.event.event The native DOM event
|
|
1501
1351
|
*/
|
|
1502
1352
|
(e: 'cellContextMenu', params: ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string): void
|
|
1503
1353
|
/**
|
|
1504
1354
|
* Fired when user double clicks a grid cell
|
|
1505
1355
|
* @param {string} e Event name
|
|
1506
1356
|
* @param {object} params Event parameters
|
|
1507
|
-
* @param {
|
|
1508
|
-
* @param {
|
|
1509
|
-
* @param {
|
|
1510
|
-
* @param {Grid.
|
|
1511
|
-
* @param {
|
|
1512
|
-
* @param {
|
|
1513
|
-
* @param {
|
|
1514
|
-
* @param {HTMLElement} params.params.event.target The target element
|
|
1515
|
-
* @param {MouseEvent} params.params.event.event The native DOM event
|
|
1357
|
+
* @param {object} params.event Event object
|
|
1358
|
+
* @param {Grid.view.Grid} params.event.grid The grid instance
|
|
1359
|
+
* @param {Core.data.Model} params.event.record The record representing the row
|
|
1360
|
+
* @param {Grid.column.Column} params.event.column The column to which the cell belongs
|
|
1361
|
+
* @param {HTMLElement} params.event.cellElement The cell HTML element
|
|
1362
|
+
* @param {HTMLElement} params.event.target The target element
|
|
1363
|
+
* @param {MouseEvent} params.event.event The native DOM event
|
|
1516
1364
|
*/
|
|
1517
1365
|
(e: 'cellDblClick', params: ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string): void
|
|
1518
1366
|
/**
|
|
1519
1367
|
* This event fires on the owning grid before the context menu is shown for a cell.
|
|
1520
1368
|
* 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)
|
|
1369
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-cellMenuBeforeShow)
|
|
1523
1370
|
* @param {string} e Event name
|
|
1524
1371
|
* @param {object} params Event parameters
|
|
1525
|
-
* @param {
|
|
1526
|
-
* @param {
|
|
1527
|
-
* @param {
|
|
1528
|
-
* @param {
|
|
1529
|
-
* @param {
|
|
1530
|
-
* @param {
|
|
1531
|
-
* @param {Grid.column.Column} params.params.event.column Column
|
|
1532
|
-
* @param {Core.data.Model} params.params.event.record Record
|
|
1372
|
+
* @param {object} params.event Event object
|
|
1373
|
+
* @param {Grid.view.Grid} params.event.source The grid
|
|
1374
|
+
* @param {Core.widget.Menu} params.event.menu The menu
|
|
1375
|
+
* @param {Record<string, MenuItemEntry>} params.event.items Menu item configs
|
|
1376
|
+
* @param {Grid.column.Column} params.event.column Column
|
|
1377
|
+
* @param {Core.data.Model} params.event.record Record
|
|
1533
1378
|
*/
|
|
1534
|
-
(e: 'cellMenuBeforeShow', params: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
1379
|
+
(e: 'cellMenuBeforeShow', params: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void)|string): boolean|void
|
|
1535
1380
|
/**
|
|
1536
1381
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
1537
1382
|
* @param {string} e Event name
|
|
1538
1383
|
* @param {object} params Event parameters
|
|
1539
|
-
* @param {
|
|
1540
|
-
* @param {
|
|
1541
|
-
* @param {
|
|
1542
|
-
* @param {
|
|
1543
|
-
* @param {
|
|
1544
|
-
* @param {Core.
|
|
1545
|
-
* @param {Grid.column.Column} params.params.event.column Column
|
|
1546
|
-
* @param {Core.data.Model} params.params.event.record Record
|
|
1384
|
+
* @param {object} params.event Event object
|
|
1385
|
+
* @param {Grid.view.Grid} params.event.source The grid
|
|
1386
|
+
* @param {Core.widget.Menu} params.event.menu The menu
|
|
1387
|
+
* @param {Core.widget.MenuItem} params.event.item Selected menu item
|
|
1388
|
+
* @param {Grid.column.Column} params.event.column Column
|
|
1389
|
+
* @param {Core.data.Model} params.event.record Record
|
|
1547
1390
|
*/
|
|
1548
1391
|
(e: 'cellMenuItem', params: ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column, record: Model }) => void)|string): void
|
|
1549
1392
|
/**
|
|
1550
1393
|
* This event fires on the owning grid after the context menu is shown for a cell.
|
|
1551
1394
|
* @param {string} e Event name
|
|
1552
1395
|
* @param {object} params Event parameters
|
|
1553
|
-
* @param {
|
|
1554
|
-
* @param {
|
|
1555
|
-
* @param {
|
|
1556
|
-
* @param {
|
|
1557
|
-
* @param {
|
|
1558
|
-
* @param {
|
|
1559
|
-
* @param {Grid.column.Column} params.params.event.column Column
|
|
1560
|
-
* @param {Core.data.Model} params.params.event.record Record
|
|
1396
|
+
* @param {object} params.event Event object
|
|
1397
|
+
* @param {Grid.view.Grid} params.event.source The grid
|
|
1398
|
+
* @param {Core.widget.Menu} params.event.menu The menu
|
|
1399
|
+
* @param {Record<string, MenuItemEntry>} params.event.items Menu item configs
|
|
1400
|
+
* @param {Grid.column.Column} params.event.column Column
|
|
1401
|
+
* @param {Core.data.Model} params.event.record Record
|
|
1561
1402
|
*/
|
|
1562
1403
|
(e: 'cellMenuShow', params: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => void)|string): void
|
|
1563
1404
|
/**
|
|
1564
1405
|
* This event fires on the owning grid when a check item is toggled in the cell context menu.
|
|
1565
1406
|
* @param {string} e Event name
|
|
1566
1407
|
* @param {object} params Event parameters
|
|
1567
|
-
* @param {
|
|
1568
|
-
* @param {
|
|
1569
|
-
* @param {
|
|
1570
|
-
* @param {
|
|
1571
|
-
* @param {
|
|
1572
|
-
* @param {Core.
|
|
1573
|
-
* @param {
|
|
1574
|
-
* @param {Core.data.Model} params.params.event.record Record
|
|
1575
|
-
* @param {boolean} params.params.event.checked Checked or not
|
|
1408
|
+
* @param {object} params.event Event object
|
|
1409
|
+
* @param {Grid.view.Grid} params.event.source The grid
|
|
1410
|
+
* @param {Core.widget.Menu} params.event.menu The menu
|
|
1411
|
+
* @param {Core.widget.MenuItem} params.event.item Selected menu item
|
|
1412
|
+
* @param {Grid.column.Column} params.event.column Column
|
|
1413
|
+
* @param {Core.data.Model} params.event.record Record
|
|
1414
|
+
* @param {boolean} params.event.checked Checked or not
|
|
1576
1415
|
*/
|
|
1577
1416
|
(e: 'cellMenuToggleItem', params: ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column, record: Model, checked: boolean }) => void)|string): void
|
|
1578
1417
|
/**
|
|
1579
1418
|
* Fired when the mouse enters a cell
|
|
1580
1419
|
* @param {string} e Event name
|
|
1581
1420
|
* @param {object} params Event parameters
|
|
1582
|
-
* @param {
|
|
1583
|
-
* @param {
|
|
1584
|
-
* @param {
|
|
1585
|
-
* @param {Grid.
|
|
1586
|
-
* @param {
|
|
1587
|
-
* @param {
|
|
1588
|
-
* @param {HTMLElement} params.params.event.cellElement The cell HTML element
|
|
1589
|
-
* @param {MouseEvent} params.params.event.event The native DOM event
|
|
1421
|
+
* @param {object} params.event Event object
|
|
1422
|
+
* @param {Grid.view.Grid} params.event.source The grid instance
|
|
1423
|
+
* @param {Core.data.Model} params.event.record The record representing the hovered cell
|
|
1424
|
+
* @param {Grid.column.Column} params.event.column The column currently hovered
|
|
1425
|
+
* @param {HTMLElement} params.event.cellElement The cell HTML element
|
|
1426
|
+
* @param {MouseEvent} params.event.event The native DOM event
|
|
1590
1427
|
*/
|
|
1591
1428
|
(e: 'cellMouseEnter', params: ((event: { source: Grid, record: Model, column: Column, cellElement: HTMLElement, event: MouseEvent }) => void)|string): void
|
|
1592
1429
|
/**
|
|
1593
1430
|
* Fired when the mouse leaves a cell
|
|
1594
1431
|
* @param {string} e Event name
|
|
1595
1432
|
* @param {object} params Event parameters
|
|
1596
|
-
* @param {
|
|
1597
|
-
* @param {
|
|
1598
|
-
* @param {
|
|
1599
|
-
* @param {Grid.
|
|
1600
|
-
* @param {
|
|
1601
|
-
* @param {
|
|
1602
|
-
* @param {HTMLElement} params.params.event.cellElement The cell HTML element that the mouse left
|
|
1603
|
-
* @param {MouseEvent} params.params.event.event The native DOM event
|
|
1433
|
+
* @param {object} params.event Event object
|
|
1434
|
+
* @param {Grid.view.Grid} params.event.source The grid instance
|
|
1435
|
+
* @param {Core.data.Model} params.event.record The record representing the cell that the mouse left
|
|
1436
|
+
* @param {Grid.column.Column} params.event.column The column representing the cell that the mouse left
|
|
1437
|
+
* @param {HTMLElement} params.event.cellElement The cell HTML element that the mouse left
|
|
1438
|
+
* @param {MouseEvent} params.event.event The native DOM event
|
|
1604
1439
|
*/
|
|
1605
1440
|
(e: 'cellMouseLeave', params: ((event: { source: Grid, record: Model, column: Column, cellElement: HTMLElement, event: MouseEvent }) => void)|string): void
|
|
1606
1441
|
/**
|
|
1607
1442
|
* Fired when a user moves the mouse out of a grid cell
|
|
1608
1443
|
* @param {string} e Event name
|
|
1609
1444
|
* @param {object} params Event parameters
|
|
1610
|
-
* @param {
|
|
1611
|
-
* @param {
|
|
1612
|
-
* @param {
|
|
1613
|
-
* @param {Grid.
|
|
1614
|
-
* @param {
|
|
1615
|
-
* @param {
|
|
1616
|
-
* @param {
|
|
1617
|
-
* @param {HTMLElement} params.params.event.target The target element
|
|
1618
|
-
* @param {MouseEvent} params.params.event.event The native DOM event
|
|
1445
|
+
* @param {object} params.event Event object
|
|
1446
|
+
* @param {Grid.view.Grid} params.event.grid The grid instance
|
|
1447
|
+
* @param {Core.data.Model} params.event.record The record representing the row
|
|
1448
|
+
* @param {Grid.column.Column} params.event.column The column to which the cell belongs
|
|
1449
|
+
* @param {HTMLElement} params.event.cellElement The cell HTML element
|
|
1450
|
+
* @param {HTMLElement} params.event.target The target element
|
|
1451
|
+
* @param {MouseEvent} params.event.event The native DOM event
|
|
1619
1452
|
*/
|
|
1620
1453
|
(e: 'cellMouseOut', params: ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string): void
|
|
1621
1454
|
/**
|
|
1622
1455
|
* Fired when user moves the mouse over a grid cell
|
|
1623
1456
|
* @param {string} e Event name
|
|
1624
1457
|
* @param {object} params Event parameters
|
|
1625
|
-
* @param {
|
|
1626
|
-
* @param {
|
|
1627
|
-
* @param {
|
|
1628
|
-
* @param {Grid.
|
|
1629
|
-
* @param {
|
|
1630
|
-
* @param {
|
|
1631
|
-
* @param {
|
|
1632
|
-
* @param {HTMLElement} params.params.event.target The target element
|
|
1633
|
-
* @param {MouseEvent} params.params.event.event The native DOM event
|
|
1458
|
+
* @param {object} params.event Event object
|
|
1459
|
+
* @param {Grid.view.Grid} params.event.grid The grid instance
|
|
1460
|
+
* @param {Core.data.Model} params.event.record The record representing the row
|
|
1461
|
+
* @param {Grid.column.Column} params.event.column The column to which the cell belongs
|
|
1462
|
+
* @param {HTMLElement} params.event.cellElement The cell HTML element
|
|
1463
|
+
* @param {HTMLElement} params.event.target The target element
|
|
1464
|
+
* @param {MouseEvent} params.event.event The native DOM event
|
|
1634
1465
|
*/
|
|
1635
1466
|
(e: 'cellMouseOver', params: ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string): void
|
|
1636
1467
|
/**
|
|
1637
1468
|
* Fires when a Panel is collapsed using the [collapsible](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-collapsible) setting.
|
|
1638
1469
|
* @param {string} e Event name
|
|
1639
1470
|
* @param {object} params Event parameters
|
|
1640
|
-
* @param {
|
|
1641
|
-
* @param {
|
|
1642
|
-
* @param {object} params.params.event Event object
|
|
1643
|
-
* @param {Core.widget.Panel} params.params.event.source This Panel.
|
|
1471
|
+
* @param {object} params.event Event object
|
|
1472
|
+
* @param {Core.widget.Panel} params.event.source This Panel.
|
|
1644
1473
|
*/
|
|
1645
1474
|
(e: 'collapse', params: ((event: { source: Panel }) => void)|string): void
|
|
1646
1475
|
/**
|
|
1647
1476
|
* Fired before a parent node record is collapsed.
|
|
1648
1477
|
* @param {string} e Event name
|
|
1649
1478
|
* @param {object} params Event parameters
|
|
1650
|
-
* @param {
|
|
1651
|
-
* @param {
|
|
1652
|
-
* @param {
|
|
1653
|
-
* @param {Grid.view.Grid} params.params.event.source The firing Grid instance.
|
|
1654
|
-
* @param {Core.data.Model} params.params.event.record The record which has been collapsed.
|
|
1479
|
+
* @param {object} params.event Event object
|
|
1480
|
+
* @param {Grid.view.Grid} params.event.source The firing Grid instance.
|
|
1481
|
+
* @param {Core.data.Model} params.event.record The record which has been collapsed.
|
|
1655
1482
|
*/
|
|
1656
1483
|
(e: 'collapseNode', params: ((event: { source: Grid, record: Model }) => void)|string): void
|
|
1657
1484
|
/**
|
|
1658
1485
|
* This event is triggered after a parent column has been collapsed or expanded.
|
|
1659
1486
|
* @param {string} e Event name
|
|
1660
1487
|
* @param {object} params Event parameters
|
|
1661
|
-
* @param {
|
|
1662
|
-
* @param {
|
|
1663
|
-
* @param {
|
|
1664
|
-
* @param {
|
|
1665
|
-
* @param {Grid.column.Column} params.params.event.column The column being toggled
|
|
1666
|
-
* @param {boolean} params.params.event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
1488
|
+
* @param {object} params.event Event object
|
|
1489
|
+
* @param {Grid.view.GridBase} params.event.source The Grid instance
|
|
1490
|
+
* @param {Grid.column.Column} params.event.column The column being toggled
|
|
1491
|
+
* @param {boolean} params.event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
1667
1492
|
*/
|
|
1668
1493
|
(e: 'columnCollapseToggle', params: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string): void
|
|
1669
1494
|
/**
|
|
@@ -1671,27 +1496,23 @@ const emit = defineEmits<{
|
|
|
1671
1496
|
* to indicate whether the drop position is valid or not.
|
|
1672
1497
|
* @param {string} e Event name
|
|
1673
1498
|
* @param {object} params Event parameters
|
|
1674
|
-
* @param {
|
|
1675
|
-
* @param {
|
|
1676
|
-
* @param {
|
|
1677
|
-
* @param {Grid.
|
|
1678
|
-
* @param {
|
|
1679
|
-
* @param {
|
|
1680
|
-
* @param {
|
|
1681
|
-
* @param {object} params.params.event.context
|
|
1682
|
-
* @param {boolean} params.params.event.context.valid Set this to `true` or `false` to indicate whether the drop position is valid.
|
|
1499
|
+
* @param {object} params.event Event object
|
|
1500
|
+
* @param {Grid.view.Grid} params.event.source The grid instance.
|
|
1501
|
+
* @param {Grid.column.Column} params.event.column The dragged column.
|
|
1502
|
+
* @param {Grid.column.Column} params.event.insertBefore The column before which the dragged column will be inserted (if not last).
|
|
1503
|
+
* @param {Event} params.event.event The browser event.
|
|
1504
|
+
* @param {object} params.event.context
|
|
1505
|
+
* @param {boolean} params.event.context.valid Set this to `true` or `false` to indicate whether the drop position is valid.
|
|
1683
1506
|
*/
|
|
1684
1507
|
(e: 'columnDrag', params: ((event: { source: Grid, column: Column, insertBefore: Column, event: Event, context: { valid: boolean } }) => void)|string): void
|
|
1685
1508
|
/**
|
|
1686
1509
|
* This event is fired when a column drag gesture has started.
|
|
1687
1510
|
* @param {string} e Event name
|
|
1688
1511
|
* @param {object} params Event parameters
|
|
1689
|
-
* @param {
|
|
1690
|
-
* @param {
|
|
1691
|
-
* @param {
|
|
1692
|
-
* @param {
|
|
1693
|
-
* @param {Grid.column.Column} params.params.event.column The dragged column.
|
|
1694
|
-
* @param {Event} params.params.event.event The browser event.
|
|
1512
|
+
* @param {object} params.event Event object
|
|
1513
|
+
* @param {Grid.view.Grid} params.event.source The grid instance.
|
|
1514
|
+
* @param {Grid.column.Column} params.event.column The dragged column.
|
|
1515
|
+
* @param {Event} params.event.event The browser event.
|
|
1695
1516
|
*/
|
|
1696
1517
|
(e: 'columnDragStart', params: ((event: { source: Grid, column: Column, event: Event }) => void)|string): void
|
|
1697
1518
|
/**
|
|
@@ -1699,117 +1520,98 @@ const emit = defineEmits<{
|
|
|
1699
1520
|
* vetoed and the column was moved in the column store.
|
|
1700
1521
|
* @param {string} e Event name
|
|
1701
1522
|
* @param {object} params Event parameters
|
|
1702
|
-
* @param {
|
|
1703
|
-
* @param {
|
|
1704
|
-
* @param {
|
|
1705
|
-
* @param {Grid.
|
|
1706
|
-
* @param {Grid.column.Column} params.
|
|
1707
|
-
* @param {
|
|
1708
|
-
* @param {
|
|
1709
|
-
* @param {
|
|
1710
|
-
* @param {Event} params.params.event.event The browser event.
|
|
1711
|
-
* @param {string} params.params.event.region The region where the column was dropped.
|
|
1523
|
+
* @param {object} params.event Event object
|
|
1524
|
+
* @param {Grid.view.Grid} params.event.source The grid instance.
|
|
1525
|
+
* @param {Grid.column.Column} params.event.column The dragged column.
|
|
1526
|
+
* @param {Grid.column.Column} params.event.insertBefore The column before which the dragged column will be inserted.
|
|
1527
|
+
* @param {Grid.column.Column} params.event.newParent The new parent column.
|
|
1528
|
+
* @param {boolean} params.event.valid `true` if the operation was not vetoed.
|
|
1529
|
+
* @param {Event} params.event.event The browser event.
|
|
1530
|
+
* @param {string} params.event.region The region where the column was dropped.
|
|
1712
1531
|
*/
|
|
1713
|
-
(e: 'columnDrop', params: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
1532
|
+
(e: 'columnDrop', params: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void)|string): boolean|void
|
|
1714
1533
|
/**
|
|
1715
1534
|
* This event is fired after a resize gesture is completed.
|
|
1716
1535
|
* @param {string} e Event name
|
|
1717
1536
|
* @param {object} params Event parameters
|
|
1718
|
-
* @param {
|
|
1719
|
-
* @param {
|
|
1720
|
-
* @param {
|
|
1721
|
-
* @param {
|
|
1722
|
-
* @param {Grid.column.Column} params.params.event.column The resized column
|
|
1723
|
-
* @param {Event} params.params.event.domEvent The browser event
|
|
1537
|
+
* @param {object} params.event Event object
|
|
1538
|
+
* @param {Grid.view.Grid} params.event.source The grid instance
|
|
1539
|
+
* @param {Grid.column.Column} params.event.column The resized column
|
|
1540
|
+
* @param {Event} params.event.domEvent The browser event
|
|
1724
1541
|
*/
|
|
1725
1542
|
(e: 'columnResize', params: ((event: { source: Grid, column: Column, domEvent: Event }) => void)|string): void
|
|
1726
1543
|
/**
|
|
1727
1544
|
* This event is fired when a column resize gesture starts.
|
|
1728
1545
|
* @param {string} e Event name
|
|
1729
1546
|
* @param {object} params Event parameters
|
|
1730
|
-
* @param {
|
|
1731
|
-
* @param {
|
|
1732
|
-
* @param {
|
|
1733
|
-
* @param {
|
|
1734
|
-
* @param {Grid.column.Column} params.params.event.column The column
|
|
1735
|
-
* @param {Event} params.params.event.domEvent The browser event
|
|
1547
|
+
* @param {object} params.event Event object
|
|
1548
|
+
* @param {Grid.view.Grid} params.event.source The grid instance
|
|
1549
|
+
* @param {Grid.column.Column} params.event.column The column
|
|
1550
|
+
* @param {Event} params.event.domEvent The browser event
|
|
1736
1551
|
*/
|
|
1737
1552
|
(e: 'columnResizeStart', params: ((event: { source: Grid, column: Column, domEvent: Event }) => void)|string): void
|
|
1738
1553
|
/**
|
|
1739
1554
|
* This event fires on the owning widget when an item is selected in the context menu.
|
|
1740
1555
|
* @param {string} e Event name
|
|
1741
1556
|
* @param {object} params Event parameters
|
|
1742
|
-
* @param {
|
|
1743
|
-
* @param {
|
|
1744
|
-
* @param {
|
|
1745
|
-
* @param {Core.widget.
|
|
1746
|
-
* @param {Core.widget.Menu} params.params.event.menu The menu
|
|
1747
|
-
* @param {Core.widget.MenuItem} params.params.event.item Selected menu item
|
|
1557
|
+
* @param {object} params.event Event object
|
|
1558
|
+
* @param {Core.widget.Widget} params.event.source The owning widget
|
|
1559
|
+
* @param {Core.widget.Menu} params.event.menu The menu
|
|
1560
|
+
* @param {Core.widget.MenuItem} params.event.item Selected menu item
|
|
1748
1561
|
*/
|
|
1749
1562
|
(e: 'contextMenuItem', params: ((event: { source: Widget, menu: Menu, item: MenuItem }) => void)|string): void
|
|
1750
1563
|
/**
|
|
1751
1564
|
* This event fires on the owning widget when a check item is toggled in the context menu.
|
|
1752
1565
|
* @param {string} e Event name
|
|
1753
1566
|
* @param {object} params Event parameters
|
|
1754
|
-
* @param {
|
|
1755
|
-
* @param {
|
|
1756
|
-
* @param {
|
|
1757
|
-
* @param {Core.widget.
|
|
1758
|
-
* @param {
|
|
1759
|
-
* @param {Core.widget.MenuItem} params.params.event.item Selected menu item
|
|
1760
|
-
* @param {boolean} params.params.event.checked Checked or not
|
|
1567
|
+
* @param {object} params.event Event object
|
|
1568
|
+
* @param {Core.widget.Widget} params.event.source The owning widget
|
|
1569
|
+
* @param {Core.widget.Menu} params.event.menu The menu
|
|
1570
|
+
* @param {Core.widget.MenuItem} params.event.item Selected menu item
|
|
1571
|
+
* @param {boolean} params.event.checked Checked or not
|
|
1761
1572
|
*/
|
|
1762
1573
|
(e: 'contextMenuToggleItem', params: ((event: { source: Widget, menu: Menu, item: MenuItem, checked: boolean }) => void)|string): void
|
|
1763
1574
|
/**
|
|
1764
1575
|
* Fires on the owning Grid after a copy action is performed.
|
|
1765
1576
|
* @param {string} e Event name
|
|
1766
1577
|
* @param {object} params Event parameters
|
|
1767
|
-
* @param {
|
|
1768
|
-
* @param {
|
|
1769
|
-
* @param {
|
|
1770
|
-
* @param {
|
|
1771
|
-
* @param {
|
|
1772
|
-
* @param {string} params.
|
|
1773
|
-
* @param {boolean} params.params.event.isCut `true` if this was a cut action
|
|
1774
|
-
* @param {string} params.params.event.entityName 'cell' to distinguish this event from other copy events
|
|
1578
|
+
* @param {object} params.event Event object
|
|
1579
|
+
* @param {Grid.view.Grid} params.event.source Owner grid
|
|
1580
|
+
* @param {Grid.util.GridLocation[]} params.event.cells The cells about to be copied or cut
|
|
1581
|
+
* @param {string} params.event.copiedDataString The concatenated data string that was copied or cut
|
|
1582
|
+
* @param {boolean} params.event.isCut `true` if this was a cut action
|
|
1583
|
+
* @param {string} params.event.entityName 'cell' to distinguish this event from other copy events
|
|
1775
1584
|
*/
|
|
1776
1585
|
(e: 'copy', params: ((event: { source: Grid, cells: GridLocation[], copiedDataString: string, isCut: boolean, entityName: string }) => void)|string): void
|
|
1777
1586
|
/**
|
|
1778
1587
|
* Fired when data in the store changes.
|
|
1779
|
-
* ...
|
|
1780
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-dataChange)
|
|
1588
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-dataChange)
|
|
1781
1589
|
* @param {string} e Event name
|
|
1782
1590
|
* @param {object} params Event parameters
|
|
1783
|
-
* @param {
|
|
1784
|
-
* @param {
|
|
1785
|
-
* @param {
|
|
1786
|
-
* @param {
|
|
1787
|
-
* @param {Core.data.
|
|
1788
|
-
* @param {
|
|
1789
|
-
* @param {
|
|
1790
|
-
* @param {Core.data.Model[]} params.params.event.records Changed records, passed for all actions except `'removeAll'`
|
|
1791
|
-
* @param {object} params.params.event.changes Passed for the `'update'` action, info on which record fields changed
|
|
1591
|
+
* @param {object} params.event Event object
|
|
1592
|
+
* @param {Grid.view.GridBase} params.event.source Owning grid
|
|
1593
|
+
* @param {Core.data.Store} params.event.store The originating store
|
|
1594
|
+
* @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} params.event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
|
|
1595
|
+
* @param {Core.data.Model} params.event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
1596
|
+
* @param {Core.data.Model[]} params.event.records Changed records, passed for all actions except `'removeAll'`
|
|
1597
|
+
* @param {object} params.event.changes Passed for the `'update'` action, info on which record fields changed
|
|
1792
1598
|
*/
|
|
1793
1599
|
(e: 'dataChange', params: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string): void
|
|
1794
1600
|
/**
|
|
1795
1601
|
* Fires when an object is destroyed.
|
|
1796
1602
|
* @param {string} e Event name
|
|
1797
1603
|
* @param {object} params Event parameters
|
|
1798
|
-
* @param {
|
|
1799
|
-
* @param {
|
|
1800
|
-
* @param {object} params.params.event Event object
|
|
1801
|
-
* @param {Core.Base} params.params.event.source The Object that is being destroyed.
|
|
1604
|
+
* @param {object} params.event Event object
|
|
1605
|
+
* @param {Core.Base} params.event.source The Object that is being destroyed.
|
|
1802
1606
|
*/
|
|
1803
1607
|
(e: 'destroy', params: ((event: { source: Base }) => void)|string): void
|
|
1804
1608
|
/**
|
|
1805
1609
|
* Fires when a field is mutated and the state of the [hasChanges](https://bryntum.com/products/grid/docs/api/Core/widget/Container#property-hasChanges) property changes
|
|
1806
1610
|
* @param {string} e Event name
|
|
1807
1611
|
* @param {object} params Event parameters
|
|
1808
|
-
* @param {
|
|
1809
|
-
* @param {
|
|
1810
|
-
* @param {
|
|
1811
|
-
* @param {Core.widget.Container} params.params.event.source The container.
|
|
1812
|
-
* @param {boolean} params.params.event.dirty The dirty state of the Container - `true` if there are any fields which have been changed since initial load.
|
|
1612
|
+
* @param {object} params.event Event object
|
|
1613
|
+
* @param {Core.widget.Container} params.event.source The container.
|
|
1614
|
+
* @param {boolean} params.event.dirty The dirty state of the Container - `true` if there are any fields which have been changed since initial load.
|
|
1813
1615
|
*/
|
|
1814
1616
|
(e: 'dirtyStateChange', params: ((event: { source: Container, dirty: boolean }) => void)|string): void
|
|
1815
1617
|
/**
|
|
@@ -1817,55 +1619,45 @@ const emit = defineEmits<{
|
|
|
1817
1619
|
* mouse up. This event can be listened for to perform actions while drag selecting.
|
|
1818
1620
|
* @param {string} e Event name
|
|
1819
1621
|
* @param {object} params Event parameters
|
|
1820
|
-
* @param {
|
|
1821
|
-
* @param {
|
|
1822
|
-
* @param {
|
|
1823
|
-
* @param {
|
|
1824
|
-
* @param {GridLocationConfig[],Grid.util.GridLocation[]} params.params.event.selectedCells The cells that is currently being dragged over
|
|
1825
|
-
* @param {Core.data.Model[]} params.params.event.selectedRecords The records that is currently being dragged over
|
|
1622
|
+
* @param {object} params.event Event object
|
|
1623
|
+
* @param {Grid.view.Grid} params.event.source
|
|
1624
|
+
* @param {GridLocationConfig[],Grid.util.GridLocation[]} params.event.selectedCells The cells that is currently being dragged over
|
|
1625
|
+
* @param {Core.data.Model[]} params.event.selectedRecords The records that is currently being dragged over
|
|
1826
1626
|
*/
|
|
1827
1627
|
(e: 'dragSelecting', params: ((event: { source: Grid, selectedCells: GridLocationConfig[]|GridLocation[], selectedRecords: Model[] }) => void)|string): void
|
|
1828
1628
|
/**
|
|
1829
1629
|
* Triggered when a widget's [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element) is available.
|
|
1830
1630
|
* @param {string} e Event name
|
|
1831
1631
|
* @param {object} params Event parameters
|
|
1832
|
-
* @param {
|
|
1833
|
-
* @param {
|
|
1834
|
-
* @param {object} params.params.event Event object
|
|
1835
|
-
* @param {HTMLElement} params.params.event.element The Widget's element.
|
|
1632
|
+
* @param {object} params.event Event object
|
|
1633
|
+
* @param {HTMLElement} params.event.element The Widget's element.
|
|
1836
1634
|
*/
|
|
1837
1635
|
(e: 'elementCreated', params: ((event: { element: HTMLElement }) => void)|string): void
|
|
1838
1636
|
/**
|
|
1839
1637
|
* Fires when a Panel is expanded using the [collapsible](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-collapsible) setting.
|
|
1840
1638
|
* @param {string} e Event name
|
|
1841
1639
|
* @param {object} params Event parameters
|
|
1842
|
-
* @param {
|
|
1843
|
-
* @param {
|
|
1844
|
-
* @param {object} params.params.event Event object
|
|
1845
|
-
* @param {Core.widget.Panel} params.params.event.source This Panel.
|
|
1640
|
+
* @param {object} params.event Event object
|
|
1641
|
+
* @param {Core.widget.Panel} params.event.source This Panel.
|
|
1846
1642
|
*/
|
|
1847
1643
|
(e: 'expand', params: ((event: { source: Panel }) => void)|string): void
|
|
1848
1644
|
/**
|
|
1849
1645
|
* Fired after a parent node record is expanded.
|
|
1850
1646
|
* @param {string} e Event name
|
|
1851
1647
|
* @param {object} params Event parameters
|
|
1852
|
-
* @param {
|
|
1853
|
-
* @param {
|
|
1854
|
-
* @param {
|
|
1855
|
-
* @param {Grid.view.Grid} params.params.event.source The firing Grid instance.
|
|
1856
|
-
* @param {Core.data.Model} params.params.event.record The record which has been expanded.
|
|
1648
|
+
* @param {object} params.event Event object
|
|
1649
|
+
* @param {Grid.view.Grid} params.event.source The firing Grid instance.
|
|
1650
|
+
* @param {Core.data.Model} params.event.record The record which has been expanded.
|
|
1857
1651
|
*/
|
|
1858
1652
|
(e: 'expandNode', params: ((event: { source: Grid, record: Model }) => void)|string): void
|
|
1859
1653
|
/**
|
|
1860
1654
|
* Fired when a file is dropped on the widget element
|
|
1861
1655
|
* @param {string} e Event name
|
|
1862
1656
|
* @param {object} params Event parameters
|
|
1863
|
-
* @param {
|
|
1864
|
-
* @param {
|
|
1865
|
-
* @param {
|
|
1866
|
-
* @param {
|
|
1867
|
-
* @param {DataTransferItem} params.params.event.file The dropped file descriptor
|
|
1868
|
-
* @param {DragEvent} params.params.event.domEvent The native DragEvent
|
|
1657
|
+
* @param {object} params.event Event object
|
|
1658
|
+
* @param {Grid.view.Grid} params.event.source The owning Grid instance
|
|
1659
|
+
* @param {DataTransferItem} params.event.file The dropped file descriptor
|
|
1660
|
+
* @param {DragEvent} params.event.domEvent The native DragEvent
|
|
1869
1661
|
*/
|
|
1870
1662
|
(e: 'fileDrop', params: ((event: { source: Grid, file: DataTransferItem, domEvent: DragEvent }) => void)|string): void
|
|
1871
1663
|
/**
|
|
@@ -1873,24 +1665,20 @@ const emit = defineEmits<{
|
|
|
1873
1665
|
* drag operation from applying data changes.
|
|
1874
1666
|
* @param {string} e Event name
|
|
1875
1667
|
* @param {object} params Event parameters
|
|
1876
|
-
* @param {
|
|
1877
|
-
* @param {
|
|
1878
|
-
* @param {
|
|
1879
|
-
* @param {
|
|
1880
|
-
* @param {Grid.util.GridLocation} params.params.event.to The to cell
|
|
1881
|
-
* @param {MouseEvent} params.params.event.domEvent The raw DOM event
|
|
1668
|
+
* @param {object} params.event Event object
|
|
1669
|
+
* @param {Grid.util.GridLocation} params.event.from The from cell
|
|
1670
|
+
* @param {Grid.util.GridLocation} params.event.to The to cell
|
|
1671
|
+
* @param {MouseEvent} params.event.domEvent The raw DOM event
|
|
1882
1672
|
*/
|
|
1883
1673
|
(e: 'fillHandleBeforeDragFinalize', params: ((event: { from: GridLocation, to: GridLocation, domEvent: MouseEvent }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
1884
1674
|
/**
|
|
1885
1675
|
* Fired while dragging the FillHandle.
|
|
1886
1676
|
* @param {string} e Event name
|
|
1887
1677
|
* @param {object} params Event parameters
|
|
1888
|
-
* @param {
|
|
1889
|
-
* @param {
|
|
1890
|
-
* @param {
|
|
1891
|
-
* @param {
|
|
1892
|
-
* @param {Grid.util.GridLocation} params.params.event.to The to cell
|
|
1893
|
-
* @param {MouseEvent} params.params.event.domEvent The raw DOM event
|
|
1678
|
+
* @param {object} params.event Event object
|
|
1679
|
+
* @param {Grid.util.GridLocation} params.event.from The from cell
|
|
1680
|
+
* @param {Grid.util.GridLocation} params.event.to The to cell
|
|
1681
|
+
* @param {MouseEvent} params.event.domEvent The raw DOM event
|
|
1894
1682
|
*/
|
|
1895
1683
|
(e: 'fillHandleDrag', params: ((event: { from: GridLocation, to: GridLocation, domEvent: MouseEvent }) => void)|string): void
|
|
1896
1684
|
/**
|
|
@@ -1901,62 +1689,51 @@ const emit = defineEmits<{
|
|
|
1901
1689
|
* Fired after a FillHandle drag operation.
|
|
1902
1690
|
* @param {string} e Event name
|
|
1903
1691
|
* @param {object} params Event parameters
|
|
1904
|
-
* @param {
|
|
1905
|
-
* @param {
|
|
1906
|
-
* @param {
|
|
1907
|
-
* @param {
|
|
1908
|
-
* @param {Grid.util.GridLocation} params.params.event.to The to cell
|
|
1909
|
-
* @param {MouseEvent} params.params.event.domEvent The raw DOM event
|
|
1692
|
+
* @param {object} params.event Event object
|
|
1693
|
+
* @param {Grid.util.GridLocation} params.event.from The from cell
|
|
1694
|
+
* @param {Grid.util.GridLocation} params.event.to The to cell
|
|
1695
|
+
* @param {MouseEvent} params.event.domEvent The raw DOM event
|
|
1910
1696
|
*/
|
|
1911
1697
|
(e: 'fillHandleDragEnd', params: ((event: { from: GridLocation, to: GridLocation, domEvent: MouseEvent }) => void)|string): void
|
|
1912
1698
|
/**
|
|
1913
1699
|
* Fired when dragging of the FillHandle starts.
|
|
1914
1700
|
* @param {string} e Event name
|
|
1915
1701
|
* @param {object} params Event parameters
|
|
1916
|
-
* @param {
|
|
1917
|
-
* @param {
|
|
1918
|
-
* @param {
|
|
1919
|
-
* @param {Grid.util.GridLocation} params.params.event.cell Information about the column / record
|
|
1920
|
-
* @param {MouseEvent} params.params.event.domEvent The raw DOM event
|
|
1702
|
+
* @param {object} params.event Event object
|
|
1703
|
+
* @param {Grid.util.GridLocation} params.event.cell Information about the column / record
|
|
1704
|
+
* @param {MouseEvent} params.event.domEvent The raw DOM event
|
|
1921
1705
|
*/
|
|
1922
|
-
(e: 'fillHandleDragStart', params: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
1706
|
+
(e: 'fillHandleDragStart', params: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string): boolean|void
|
|
1923
1707
|
/**
|
|
1924
1708
|
* Fires on the owning Grid when cell editing is finished
|
|
1925
1709
|
* @param {string} e Event name
|
|
1926
1710
|
* @param {object} params Event parameters
|
|
1927
|
-
* @param {
|
|
1928
|
-
* @param {
|
|
1929
|
-
* @param {
|
|
1930
|
-
* @param {Grid.view.Grid} params.params.event.grid Target grid
|
|
1931
|
-
* @param {CellEditorContext} params.params.event.editorContext Editing context
|
|
1711
|
+
* @param {object} params.event Event object
|
|
1712
|
+
* @param {Grid.view.Grid} params.event.grid Target grid
|
|
1713
|
+
* @param {CellEditorContext} params.event.editorContext Editing context
|
|
1932
1714
|
*/
|
|
1933
1715
|
(e: 'finishCellEdit', params: ((event: { grid: Grid, editorContext: CellEditorContext }) => void)|string): void
|
|
1934
1716
|
/**
|
|
1935
1717
|
* 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)
|
|
1718
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-finishRowEdit)
|
|
1938
1719
|
* @param {string} e Event name
|
|
1939
1720
|
* @param {object} params Event parameters
|
|
1940
|
-
* @param {
|
|
1941
|
-
* @param {
|
|
1942
|
-
* @param {
|
|
1943
|
-
* @param {Grid.view.Grid} params.params.event.grid Target grid
|
|
1944
|
-
* @param {RowEditorContext} params.params.event.editorContext Editing context
|
|
1721
|
+
* @param {object} params.event Event object
|
|
1722
|
+
* @param {Grid.view.Grid} params.event.grid Target grid
|
|
1723
|
+
* @param {RowEditorContext} params.event.editorContext Editing context
|
|
1945
1724
|
*/
|
|
1946
1725
|
(e: 'finishRowEdit', params: ((event: { grid: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
1947
1726
|
/**
|
|
1948
1727
|
* Fired when focus enters this Widget.
|
|
1949
1728
|
* @param {string} e Event name
|
|
1950
1729
|
* @param {object} params Event parameters
|
|
1951
|
-
* @param {
|
|
1952
|
-
* @param {
|
|
1953
|
-
* @param {
|
|
1954
|
-
* @param {
|
|
1955
|
-
* @param {
|
|
1956
|
-
* @param {
|
|
1957
|
-
* @param {
|
|
1958
|
-
* @param {Core.widget.Widget} params.params.event.toWidget The widget which gained focus.
|
|
1959
|
-
* @param {boolean} params.params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
|
|
1730
|
+
* @param {object} params.event Event object
|
|
1731
|
+
* @param {Core.widget.Widget} params.event.source This Widget
|
|
1732
|
+
* @param {HTMLElement} params.event.fromElement The element which lost focus.
|
|
1733
|
+
* @param {HTMLElement} params.event.toElement The element which gained focus.
|
|
1734
|
+
* @param {Core.widget.Widget} params.event.fromWidget The widget which lost focus.
|
|
1735
|
+
* @param {Core.widget.Widget} params.event.toWidget The widget which gained focus.
|
|
1736
|
+
* @param {boolean} params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
|
|
1960
1737
|
*/
|
|
1961
1738
|
(e: 'focusIn', params: ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string): void
|
|
1962
1739
|
/**
|
|
@@ -1965,46 +1742,40 @@ const emit = defineEmits<{
|
|
|
1965
1742
|
* will not trigger this event. This is when focus exits this widget completely.
|
|
1966
1743
|
* @param {string} e Event name
|
|
1967
1744
|
* @param {object} params Event parameters
|
|
1968
|
-
* @param {
|
|
1969
|
-
* @param {
|
|
1970
|
-
* @param {
|
|
1971
|
-
* @param {
|
|
1972
|
-
* @param {
|
|
1973
|
-
* @param {
|
|
1974
|
-
* @param {
|
|
1975
|
-
* @param {Core.widget.Widget} params.params.event.toWidget The widget which gained focus.
|
|
1976
|
-
* @param {boolean} params.params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
|
|
1745
|
+
* @param {object} params.event Event object
|
|
1746
|
+
* @param {Core.widget.Widget} params.event.source This Widget
|
|
1747
|
+
* @param {HTMLElement} params.event.fromElement The element which lost focus.
|
|
1748
|
+
* @param {HTMLElement} params.event.toElement The element which gained focus.
|
|
1749
|
+
* @param {Core.widget.Widget} params.event.fromWidget The widget which lost focus.
|
|
1750
|
+
* @param {Core.widget.Widget} params.event.toWidget The widget which gained focus.
|
|
1751
|
+
* @param {boolean} params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
|
|
1977
1752
|
*/
|
|
1978
1753
|
(e: 'focusOut', params: ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string): void
|
|
1979
1754
|
/**
|
|
1980
1755
|
* Fired before dragging starts, return false to prevent the drag operation.
|
|
1981
1756
|
* @param {string} e Event name
|
|
1982
1757
|
* @param {object} params Event parameters
|
|
1983
|
-
* @param {
|
|
1984
|
-
* @param {
|
|
1985
|
-
* @param {object} params.
|
|
1986
|
-
* @param {
|
|
1987
|
-
* @param {
|
|
1988
|
-
* @param {Core.data.Model[]} params.params.event.context.records The dragged row records
|
|
1989
|
-
* @param {MouseEvent,TouchEvent} params.params.event.event
|
|
1758
|
+
* @param {object} params.event Event object
|
|
1759
|
+
* @param {Grid.view.GridBase} params.event.source
|
|
1760
|
+
* @param {object} params.event.context
|
|
1761
|
+
* @param {Core.data.Model[]} params.event.context.records The dragged row records
|
|
1762
|
+
* @param {MouseEvent,TouchEvent} params.event.event
|
|
1990
1763
|
*/
|
|
1991
|
-
(e: 'gridRowBeforeDragStart', params: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
1764
|
+
(e: 'gridRowBeforeDragStart', params: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void)|string): boolean|void
|
|
1992
1765
|
/**
|
|
1993
1766
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
1994
1767
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
1995
1768
|
* @param {string} e Event name
|
|
1996
1769
|
* @param {object} params Event parameters
|
|
1997
|
-
* @param {
|
|
1998
|
-
* @param {
|
|
1999
|
-
* @param {object} params.
|
|
2000
|
-
* @param {
|
|
2001
|
-
* @param {
|
|
2002
|
-
* @param {
|
|
2003
|
-
* @param {Core.data.Model} params.
|
|
2004
|
-
* @param {
|
|
2005
|
-
* @param {
|
|
2006
|
-
* @param {RecordPositionContext[]} params.params.event.context.oldPositionContext An array of objects with information about the previous tree position. Objects contain the `record`, and its original `parentIndex` and `parentId` values
|
|
2007
|
-
* @param {MouseEvent} params.params.event.event
|
|
1770
|
+
* @param {object} params.event Event object
|
|
1771
|
+
* @param {Grid.view.GridBase} params.event.source
|
|
1772
|
+
* @param {object} params.event.context
|
|
1773
|
+
* @param {boolean} params.event.context.valid Set this to true or false to indicate whether the drop position is valid
|
|
1774
|
+
* @param {Core.data.Model} params.event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
|
|
1775
|
+
* @param {Core.data.Model} params.event.context.parent The parent record of the current drop position (only applicable for trees)
|
|
1776
|
+
* @param {Core.data.Model[]} params.event.context.records The dragged row records
|
|
1777
|
+
* @param {RecordPositionContext[]} params.event.context.oldPositionContext An array of objects with information about the previous tree position. Objects contain the `record`, and its original `parentIndex` and `parentId` values
|
|
1778
|
+
* @param {MouseEvent} params.event.event
|
|
2008
1779
|
*/
|
|
2009
1780
|
(e: 'gridRowBeforeDropFinalize', params: ((event: { source: GridBase, context: { valid: boolean, insertBefore: Model, parent: Model, records: Model[], oldPositionContext: RecordPositionContext[] }, event: MouseEvent }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
2010
1781
|
/**
|
|
@@ -2013,217 +1784,180 @@ const emit = defineEmits<{
|
|
|
2013
1784
|
* valid or invalid by setting `context.valid = false;`
|
|
2014
1785
|
* @param {string} e Event name
|
|
2015
1786
|
* @param {object} params Event parameters
|
|
2016
|
-
* @param {
|
|
2017
|
-
* @param {
|
|
2018
|
-
* @param {object} params.
|
|
2019
|
-
* @param {
|
|
2020
|
-
* @param {
|
|
2021
|
-
* @param {
|
|
2022
|
-
* @param {Core.data.Model} params.
|
|
2023
|
-
* @param {
|
|
2024
|
-
* @param {Core.data.Model[]} params.params.event.context.records The dragged row records
|
|
2025
|
-
* @param {MouseEvent} params.params.event.event
|
|
1787
|
+
* @param {object} params.event Event object
|
|
1788
|
+
* @param {Grid.view.GridBase} params.event.source
|
|
1789
|
+
* @param {object} params.event.context
|
|
1790
|
+
* @param {boolean} params.event.context.valid Set this to true or false to indicate whether the drop position is valid.
|
|
1791
|
+
* @param {Core.data.Model} params.event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
|
|
1792
|
+
* @param {Core.data.Model} params.event.context.parent The parent record of the current drop position (only applicable for trees)
|
|
1793
|
+
* @param {Core.data.Model[]} params.event.context.records The dragged row records
|
|
1794
|
+
* @param {MouseEvent} params.event.event
|
|
2026
1795
|
*/
|
|
2027
1796
|
(e: 'gridRowDrag', params: ((event: { source: GridBase, context: { valid: boolean, insertBefore: Model, parent: Model, records: Model[] }, event: MouseEvent }) => void)|string): void
|
|
2028
1797
|
/**
|
|
2029
1798
|
* Fired when a row drag operation is aborted
|
|
2030
1799
|
* @param {string} e Event name
|
|
2031
1800
|
* @param {object} params Event parameters
|
|
2032
|
-
* @param {
|
|
2033
|
-
* @param {
|
|
2034
|
-
* @param {object} params.
|
|
2035
|
-
* @param {
|
|
2036
|
-
* @param {
|
|
2037
|
-
* @param {Core.data.Model[]} params.params.event.context.records The dragged row records
|
|
2038
|
-
* @param {MouseEvent} params.params.event.event
|
|
1801
|
+
* @param {object} params.event Event object
|
|
1802
|
+
* @param {Grid.view.GridBase} params.event.source
|
|
1803
|
+
* @param {object} params.event.context
|
|
1804
|
+
* @param {Core.data.Model[]} params.event.context.records The dragged row records
|
|
1805
|
+
* @param {MouseEvent} params.event.event
|
|
2039
1806
|
*/
|
|
2040
1807
|
(e: 'gridRowDragAbort', params: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent }) => void)|string): void
|
|
2041
1808
|
/**
|
|
2042
1809
|
* Fired when dragging starts.
|
|
2043
1810
|
* @param {string} e Event name
|
|
2044
1811
|
* @param {object} params Event parameters
|
|
2045
|
-
* @param {
|
|
2046
|
-
* @param {
|
|
2047
|
-
* @param {object} params.
|
|
2048
|
-
* @param {
|
|
2049
|
-
* @param {
|
|
2050
|
-
* @param {Core.data.Model[]} params.params.event.context.records The dragged row records
|
|
2051
|
-
* @param {MouseEvent,TouchEvent} params.params.event.event
|
|
1812
|
+
* @param {object} params.event Event object
|
|
1813
|
+
* @param {Grid.view.GridBase} params.event.source
|
|
1814
|
+
* @param {object} params.event.context
|
|
1815
|
+
* @param {Core.data.Model[]} params.event.context.records The dragged row records
|
|
1816
|
+
* @param {MouseEvent,TouchEvent} params.event.event
|
|
2052
1817
|
*/
|
|
2053
1818
|
(e: 'gridRowDragStart', params: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => void)|string): void
|
|
2054
1819
|
/**
|
|
2055
1820
|
* Fired after the row drop operation has completed, regardless of validity
|
|
2056
1821
|
* @param {string} e Event name
|
|
2057
1822
|
* @param {object} params Event parameters
|
|
2058
|
-
* @param {
|
|
2059
|
-
* @param {
|
|
2060
|
-
* @param {object} params.
|
|
2061
|
-
* @param {
|
|
2062
|
-
* @param {
|
|
2063
|
-
* @param {
|
|
2064
|
-
* @param {Core.data.Model} params.
|
|
2065
|
-
* @param {
|
|
2066
|
-
* @param {
|
|
2067
|
-
* @param {RecordPositionContext[]} params.params.event.context.oldPositionContext An array of objects with information about the previous tree position. Objects contain the record, and its original `parentIndex` and `parentId` values
|
|
2068
|
-
* @param {MouseEvent} params.params.event.event
|
|
1823
|
+
* @param {object} params.event Event object
|
|
1824
|
+
* @param {Grid.view.GridBase} params.event.source
|
|
1825
|
+
* @param {object} params.event.context
|
|
1826
|
+
* @param {boolean} params.event.context.valid true or false depending on whether the drop position was valid
|
|
1827
|
+
* @param {Core.data.Model} params.event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
|
|
1828
|
+
* @param {Core.data.Model} params.event.context.parent The parent record of the current drop position (only applicable for trees)
|
|
1829
|
+
* @param {Core.data.Model[]} params.event.context.records The dragged row records
|
|
1830
|
+
* @param {RecordPositionContext[]} params.event.context.oldPositionContext An array of objects with information about the previous tree position. Objects contain the record, and its original `parentIndex` and `parentId` values
|
|
1831
|
+
* @param {MouseEvent} params.event.event
|
|
2069
1832
|
*/
|
|
2070
1833
|
(e: 'gridRowDrop', params: ((event: { source: GridBase, context: { valid: boolean, insertBefore: Model, parent: Model, records: Model[], oldPositionContext: RecordPositionContext[] }, event: MouseEvent }) => void)|string): void
|
|
2071
1834
|
/**
|
|
2072
1835
|
* 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)
|
|
1836
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-headerClick)
|
|
2075
1837
|
* @param {string} e Event name
|
|
2076
1838
|
* @param {object} params Event parameters
|
|
2077
|
-
* @param {
|
|
2078
|
-
* @param {
|
|
2079
|
-
* @param {
|
|
2080
|
-
* @param {Event} params.params.event.domEvent The triggering DOM event.
|
|
2081
|
-
* @param {Grid.column.Column} params.params.event.column The column clicked on.
|
|
1839
|
+
* @param {object} params.event Event object
|
|
1840
|
+
* @param {Event} params.event.domEvent The triggering DOM event.
|
|
1841
|
+
* @param {Grid.column.Column} params.event.column The column clicked on.
|
|
2082
1842
|
*/
|
|
2083
|
-
(e: 'headerClick', params: ((event: { domEvent: Event, column: Column }) =>
|
|
1843
|
+
(e: 'headerClick', params: ((event: { domEvent: Event, column: Column }) => boolean|void)|string): boolean|void
|
|
2084
1844
|
/**
|
|
2085
1845
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
2086
1846
|
* 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)
|
|
1847
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-headerMenuBeforeShow)
|
|
2089
1848
|
* @param {string} e Event name
|
|
2090
1849
|
* @param {object} params Event parameters
|
|
2091
|
-
* @param {
|
|
2092
|
-
* @param {
|
|
2093
|
-
* @param {
|
|
2094
|
-
* @param {
|
|
2095
|
-
* @param {
|
|
2096
|
-
* @param {Record<string, MenuItemEntry>} params.params.event.items Menu item configs
|
|
2097
|
-
* @param {Grid.column.Column} params.params.event.column Column
|
|
1850
|
+
* @param {object} params.event Event object
|
|
1851
|
+
* @param {Grid.view.Grid} params.event.source The grid
|
|
1852
|
+
* @param {Core.widget.Menu} params.event.menu The menu
|
|
1853
|
+
* @param {Record<string, MenuItemEntry>} params.event.items Menu item configs
|
|
1854
|
+
* @param {Grid.column.Column} params.event.column Column
|
|
2098
1855
|
*/
|
|
2099
|
-
(e: 'headerMenuBeforeShow', params: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
1856
|
+
(e: 'headerMenuBeforeShow', params: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void)|string): boolean|void
|
|
2100
1857
|
/**
|
|
2101
1858
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
2102
1859
|
* @param {string} e Event name
|
|
2103
1860
|
* @param {object} params Event parameters
|
|
2104
|
-
* @param {
|
|
2105
|
-
* @param {
|
|
2106
|
-
* @param {
|
|
2107
|
-
* @param {
|
|
2108
|
-
* @param {
|
|
2109
|
-
* @param {Core.widget.MenuItem} params.params.event.item Selected menu item
|
|
2110
|
-
* @param {Grid.column.Column} params.params.event.column Column
|
|
1861
|
+
* @param {object} params.event Event object
|
|
1862
|
+
* @param {Grid.view.Grid} params.event.source The grid
|
|
1863
|
+
* @param {Core.widget.Menu} params.event.menu The menu
|
|
1864
|
+
* @param {Core.widget.MenuItem} params.event.item Selected menu item
|
|
1865
|
+
* @param {Grid.column.Column} params.event.column Column
|
|
2111
1866
|
*/
|
|
2112
1867
|
(e: 'headerMenuItem', params: ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column }) => void)|string): void
|
|
2113
1868
|
/**
|
|
2114
1869
|
* This event fires on the owning Grid after the context menu is shown for a header
|
|
2115
1870
|
* @param {string} e Event name
|
|
2116
1871
|
* @param {object} params Event parameters
|
|
2117
|
-
* @param {
|
|
2118
|
-
* @param {
|
|
2119
|
-
* @param {
|
|
2120
|
-
* @param {
|
|
2121
|
-
* @param {
|
|
2122
|
-
* @param {Record<string, MenuItemEntry>} params.params.event.items Menu item configs
|
|
2123
|
-
* @param {Grid.column.Column} params.params.event.column Column
|
|
1872
|
+
* @param {object} params.event Event object
|
|
1873
|
+
* @param {Grid.view.Grid} params.event.source The grid
|
|
1874
|
+
* @param {Core.widget.Menu} params.event.menu The menu
|
|
1875
|
+
* @param {Record<string, MenuItemEntry>} params.event.items Menu item configs
|
|
1876
|
+
* @param {Grid.column.Column} params.event.column Column
|
|
2124
1877
|
*/
|
|
2125
1878
|
(e: 'headerMenuShow', params: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => void)|string): void
|
|
2126
1879
|
/**
|
|
2127
1880
|
* This event fires on the owning Grid when a check item is toggled in the header context menu.
|
|
2128
1881
|
* @param {string} e Event name
|
|
2129
1882
|
* @param {object} params Event parameters
|
|
2130
|
-
* @param {
|
|
2131
|
-
* @param {
|
|
2132
|
-
* @param {
|
|
2133
|
-
* @param {
|
|
2134
|
-
* @param {
|
|
2135
|
-
* @param {
|
|
2136
|
-
* @param {Grid.column.Column} params.params.event.column Column
|
|
2137
|
-
* @param {boolean} params.params.event.checked Checked or not
|
|
1883
|
+
* @param {object} params.event Event object
|
|
1884
|
+
* @param {Grid.view.Grid} params.event.source The grid
|
|
1885
|
+
* @param {Core.widget.Menu} params.event.menu The menu
|
|
1886
|
+
* @param {Core.widget.MenuItem} params.event.item Selected menu item
|
|
1887
|
+
* @param {Grid.column.Column} params.event.column Column
|
|
1888
|
+
* @param {boolean} params.event.checked Checked or not
|
|
2138
1889
|
*/
|
|
2139
1890
|
(e: 'headerMenuToggleItem', params: ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column, checked: boolean }) => void)|string): void
|
|
2140
1891
|
/**
|
|
2141
1892
|
* Triggered after a widget was hidden
|
|
2142
1893
|
* @param {string} e Event name
|
|
2143
1894
|
* @param {object} params Event parameters
|
|
2144
|
-
* @param {
|
|
2145
|
-
* @param {
|
|
2146
|
-
* @param {object} params.params.event Event object
|
|
2147
|
-
* @param {Core.widget.Widget} params.params.event.source The widget
|
|
1895
|
+
* @param {object} params.event Event object
|
|
1896
|
+
* @param {Core.widget.Widget} params.event.source The widget
|
|
2148
1897
|
*/
|
|
2149
1898
|
(e: 'hide', params: ((event: { source: Widget }) => void)|string): void
|
|
2150
1899
|
/**
|
|
2151
1900
|
* Fires when row locking is enabled.
|
|
2152
1901
|
* @param {string} e Event name
|
|
2153
1902
|
* @param {object} params Event parameters
|
|
2154
|
-
* @param {
|
|
2155
|
-
* @param {
|
|
2156
|
-
* @param {object} params.params.event Event object
|
|
2157
|
-
* @param {Grid.view.GridBase} params.params.event.clone The created clone
|
|
1903
|
+
* @param {object} params.event Event object
|
|
1904
|
+
* @param {Grid.view.GridBase} params.event.clone The created clone
|
|
2158
1905
|
*/
|
|
2159
1906
|
(e: 'lockRows', params: ((event: { clone: GridBase }) => void)|string): void
|
|
2160
1907
|
/**
|
|
2161
1908
|
* Mouse moved out from element in grid
|
|
2162
1909
|
* @param {string} e Event name
|
|
2163
1910
|
* @param {object} params Event parameters
|
|
2164
|
-
* @param {
|
|
2165
|
-
* @param {
|
|
2166
|
-
* @param {object} params.params.event Event object
|
|
2167
|
-
* @param {MouseEvent} params.params.event.event The native browser event
|
|
1911
|
+
* @param {object} params.event Event object
|
|
1912
|
+
* @param {MouseEvent} params.event.event The native browser event
|
|
2168
1913
|
*/
|
|
2169
1914
|
(e: 'mouseOut', params: ((event: { event: MouseEvent }) => void)|string): void
|
|
2170
1915
|
/**
|
|
2171
1916
|
* Mouse moved in over element in grid
|
|
2172
1917
|
* @param {string} e Event name
|
|
2173
1918
|
* @param {object} params Event parameters
|
|
2174
|
-
* @param {
|
|
2175
|
-
* @param {
|
|
2176
|
-
* @param {object} params.params.event Event object
|
|
2177
|
-
* @param {MouseEvent} params.params.event.event The native browser event
|
|
1919
|
+
* @param {object} params.event Event object
|
|
1920
|
+
* @param {MouseEvent} params.event.event The native browser event
|
|
2178
1921
|
*/
|
|
2179
1922
|
(e: 'mouseOver', params: ((event: { event: MouseEvent }) => void)|string): void
|
|
2180
1923
|
/**
|
|
2181
1924
|
* Triggered when a widget which had been in a non-visible state for any reason
|
|
2182
1925
|
* achieves visibility.
|
|
2183
|
-
* ...
|
|
2184
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-paint)
|
|
1926
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-paint)
|
|
2185
1927
|
* @param {string} e Event name
|
|
2186
1928
|
* @param {object} params Event parameters
|
|
2187
|
-
* @param {
|
|
2188
|
-
* @param {
|
|
2189
|
-
* @param {
|
|
2190
|
-
* @param {Core.widget.Widget} params.params.event.source The widget being painted.
|
|
2191
|
-
* @param {boolean} params.params.event.firstPaint `true` if this is the first paint.
|
|
1929
|
+
* @param {object} params.event Event object
|
|
1930
|
+
* @param {Core.widget.Widget} params.event.source The widget being painted.
|
|
1931
|
+
* @param {boolean} params.event.firstPaint `true` if this is the first paint.
|
|
2192
1932
|
*/
|
|
2193
1933
|
(e: 'paint', params: ((event: { source: Widget, firstPaint: boolean }) => void)|string): void
|
|
2194
1934
|
/**
|
|
2195
1935
|
* Fires on the owning Grid after a paste action is performed.
|
|
2196
1936
|
* @param {string} e Event name
|
|
2197
1937
|
* @param {object} params Event parameters
|
|
2198
|
-
* @param {
|
|
2199
|
-
* @param {
|
|
2200
|
-
* @param {
|
|
2201
|
-
* @param {
|
|
2202
|
-
* @param {
|
|
2203
|
-
* @param {
|
|
2204
|
-
* @param {Grid.util.GridLocation} params.params.event.targetCell The cell from which the paste will be started
|
|
2205
|
-
* @param {string} params.params.event.entityName 'cell' to distinguish this event from other paste events
|
|
1938
|
+
* @param {object} params.event Event object
|
|
1939
|
+
* @param {Grid.view.Grid} params.event.source Owner grid
|
|
1940
|
+
* @param {string} params.event.clipboardData The clipboardData that was pasted
|
|
1941
|
+
* @param {Core.data.Model[]} params.event.modifiedRecords The records which have been modified due to the paste action
|
|
1942
|
+
* @param {Grid.util.GridLocation} params.event.targetCell The cell from which the paste will be started
|
|
1943
|
+
* @param {string} params.event.entityName 'cell' to distinguish this event from other paste events
|
|
2206
1944
|
*/
|
|
2207
1945
|
(e: 'paste', params: ((event: { source: Grid, clipboardData: string, modifiedRecords: Model[], targetCell: GridLocation, entityName: string }) => void)|string): void
|
|
2208
1946
|
/**
|
|
2209
1947
|
* Fires on the owning Grid when export has finished
|
|
2210
1948
|
* @param {string} e Event name
|
|
2211
1949
|
* @param {object} params Event parameters
|
|
2212
|
-
* @param {
|
|
2213
|
-
* @param {
|
|
2214
|
-
* @param {
|
|
2215
|
-
* @param {Response} params.params.event.response Optional response, if received
|
|
2216
|
-
* @param {Error} params.params.event.error Optional error, if exception occurred
|
|
1950
|
+
* @param {object} params.event Event object
|
|
1951
|
+
* @param {Response} [params.event.response] Optional response, if received
|
|
1952
|
+
* @param {Error} [params.event.error] Optional error, if exception occurred
|
|
2217
1953
|
*/
|
|
2218
1954
|
(e: 'pdfExport', params: ((event: { response?: Response, error?: Error }) => void)|string): void
|
|
2219
1955
|
/**
|
|
2220
1956
|
* Fired when a Widget's read only state is toggled
|
|
2221
1957
|
* @param {string} e Event name
|
|
2222
1958
|
* @param {object} params Event parameters
|
|
2223
|
-
* @param {
|
|
2224
|
-
* @param {
|
|
2225
|
-
* @param {object} params.params.event Event object
|
|
2226
|
-
* @param {boolean} params.params.event.readOnly Read only or not
|
|
1959
|
+
* @param {object} params.event Event object
|
|
1960
|
+
* @param {boolean} params.event.readOnly Read only or not
|
|
2227
1961
|
*/
|
|
2228
1962
|
(e: 'readOnly', params: ((event: { readOnly: boolean }) => void)|string): void
|
|
2229
1963
|
/**
|
|
@@ -2235,166 +1969,139 @@ const emit = defineEmits<{
|
|
|
2235
1969
|
* Fires after a row is rendered.
|
|
2236
1970
|
* @param {string} e Event name
|
|
2237
1971
|
* @param {object} params Event parameters
|
|
2238
|
-
* @param {
|
|
2239
|
-
* @param {
|
|
2240
|
-
* @param {
|
|
2241
|
-
* @param {
|
|
2242
|
-
* @param {
|
|
2243
|
-
* @param {Core.data.Model} params.params.event.record The record for the row
|
|
2244
|
-
* @param {number} params.params.event.recordIndex The zero-based index of the record
|
|
1972
|
+
* @param {object} params.event Event object
|
|
1973
|
+
* @param {Grid.view.GridBase} params.event.source The firing Grid instance
|
|
1974
|
+
* @param {Grid.row.Row} params.event.row The row that has been rendered
|
|
1975
|
+
* @param {Core.data.Model} params.event.record The record for the row
|
|
1976
|
+
* @param {number} params.event.recordIndex The zero-based index of the record
|
|
2245
1977
|
*/
|
|
2246
1978
|
(e: 'renderRow', params: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string): void
|
|
2247
1979
|
/**
|
|
2248
1980
|
* Grid rows have been rendered
|
|
2249
1981
|
* @param {string} e Event name
|
|
2250
1982
|
* @param {object} params Event parameters
|
|
2251
|
-
* @param {
|
|
2252
|
-
* @param {
|
|
2253
|
-
* @param {object} params.params.event Event object
|
|
2254
|
-
* @param {Grid.view.GridBase} params.params.event.source This grid.
|
|
1983
|
+
* @param {object} params.event Event object
|
|
1984
|
+
* @param {Grid.view.GridBase} params.event.source This grid.
|
|
2255
1985
|
*/
|
|
2256
1986
|
(e: 'renderRows', params: ((event: { source: GridBase }) => void)|string): void
|
|
2257
1987
|
/**
|
|
2258
1988
|
* Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
|
|
2259
1989
|
* @param {string} e Event name
|
|
2260
1990
|
* @param {object} params Event parameters
|
|
2261
|
-
* @param {
|
|
2262
|
-
* @param {
|
|
2263
|
-
* @param {
|
|
2264
|
-
* @param {
|
|
2265
|
-
* @param {number} params.
|
|
2266
|
-
* @param {number} params.
|
|
2267
|
-
* @param {number} params.params.event.oldWidth The old width
|
|
2268
|
-
* @param {number} params.params.event.oldHeight The old height
|
|
1991
|
+
* @param {object} params.event Event object
|
|
1992
|
+
* @param {Core.widget.Widget} params.event.source This Widget
|
|
1993
|
+
* @param {number} params.event.width The new width
|
|
1994
|
+
* @param {number} params.event.height The new height
|
|
1995
|
+
* @param {number} params.event.oldWidth The old width
|
|
1996
|
+
* @param {number} params.event.oldHeight The old height
|
|
2269
1997
|
*/
|
|
2270
1998
|
(e: 'resize', params: ((event: { source: Widget, width: number, height: number, oldWidth: number, oldHeight: number }) => void)|string): void
|
|
2271
1999
|
/**
|
|
2272
2000
|
* Grid resize lead to a new responsive level being applied
|
|
2273
2001
|
* @param {string} e Event name
|
|
2274
2002
|
* @param {object} params Event parameters
|
|
2275
|
-
* @param {
|
|
2276
|
-
* @param {
|
|
2277
|
-
* @param {
|
|
2278
|
-
* @param {
|
|
2279
|
-
* @param {string} params.
|
|
2280
|
-
* @param {number} params.
|
|
2281
|
-
* @param {string} params.params.event.oldLevel Old responsive level
|
|
2282
|
-
* @param {number} params.params.event.oldWidth Old width in px
|
|
2003
|
+
* @param {object} params.event Event object
|
|
2004
|
+
* @param {Grid.view.Grid} params.event.grid Grid that was resized
|
|
2005
|
+
* @param {string} params.event.level New responsive level (small, large, etc)
|
|
2006
|
+
* @param {number} params.event.width New width in px
|
|
2007
|
+
* @param {string} params.event.oldLevel Old responsive level
|
|
2008
|
+
* @param {number} params.event.oldWidth Old width in px
|
|
2283
2009
|
*/
|
|
2284
2010
|
(e: 'responsive', params: ((event: { grid: Grid, level: string, width: number, oldLevel: string, oldWidth: number }) => void)|string): void
|
|
2285
2011
|
/**
|
|
2286
2012
|
* This event fires when a row has finished collapsing.
|
|
2287
2013
|
* @param {string} e Event name
|
|
2288
2014
|
* @param {object} params Event parameters
|
|
2289
|
-
* @param {
|
|
2290
|
-
* @param {
|
|
2291
|
-
* @param {object} params.params.event Event object
|
|
2292
|
-
* @param {Core.data.Model} params.params.event.record Record
|
|
2015
|
+
* @param {object} params.event Event object
|
|
2016
|
+
* @param {Core.data.Model} params.event.record Record
|
|
2293
2017
|
*/
|
|
2294
2018
|
(e: 'rowCollapse', params: ((event: { record: Model }) => void)|string): void
|
|
2295
2019
|
/**
|
|
2296
2020
|
* 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)
|
|
2021
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-rowExpand)
|
|
2299
2022
|
* @param {string} e Event name
|
|
2300
2023
|
* @param {object} params Event parameters
|
|
2301
|
-
* @param {
|
|
2302
|
-
* @param {
|
|
2303
|
-
* @param {object} params.
|
|
2304
|
-
* @param {Core.
|
|
2305
|
-
* @param {object} params.
|
|
2306
|
-
* @param {Core.widget.Widget} params.params.event.widget In case of expanding a Widget, this will be a reference to the instance created by the actual expansion. If there is multiple Grid regions, use the `widgets` param instead.
|
|
2307
|
-
* @param {object} params.params.event.widgets In case of expanding a Widget, this will be an object with the Grid region name as property and the reference to the widget instance created by the actual expansion
|
|
2024
|
+
* @param {object} params.event Event object
|
|
2025
|
+
* @param {Core.data.Model} params.event.record Record
|
|
2026
|
+
* @param {object} params.event.expandedElements An object with the Grid region name as property and the expanded body element as value
|
|
2027
|
+
* @param {Core.widget.Widget} params.event.widget In case of expanding a Widget, this will be a reference to the instance created by the actual expansion. If there is multiple Grid regions, use the `widgets` param instead.
|
|
2028
|
+
* @param {object} params.event.widgets In case of expanding a Widget, this will be an object with the Grid region name as property and the reference to the widget instance created by the actual expansion
|
|
2308
2029
|
*/
|
|
2309
2030
|
(e: 'rowExpand', params: ((event: { record: Model, expandedElements: object, widget: Widget, widgets: object }) => void)|string): void
|
|
2310
2031
|
/**
|
|
2311
2032
|
* Fired when the mouse enters a row
|
|
2312
2033
|
* @param {string} e Event name
|
|
2313
2034
|
* @param {object} params Event parameters
|
|
2314
|
-
* @param {
|
|
2315
|
-
* @param {
|
|
2316
|
-
* @param {
|
|
2317
|
-
* @param {Grid.
|
|
2318
|
-
* @param {
|
|
2319
|
-
* @param {
|
|
2320
|
-
* @param {HTMLElement} params.params.event.cellElement The cell HTML element
|
|
2321
|
-
* @param {MouseEvent} params.params.event.event The native DOM event
|
|
2035
|
+
* @param {object} params.event Event object
|
|
2036
|
+
* @param {Grid.view.Grid} params.event.source The grid instance
|
|
2037
|
+
* @param {Core.data.Model} params.event.record The record representing the hovered row
|
|
2038
|
+
* @param {Grid.column.Column} params.event.column The column currently hovered
|
|
2039
|
+
* @param {HTMLElement} params.event.cellElement The cell HTML element
|
|
2040
|
+
* @param {MouseEvent} params.event.event The native DOM event
|
|
2322
2041
|
*/
|
|
2323
2042
|
(e: 'rowMouseEnter', params: ((event: { source: Grid, record: Model, column: Column, cellElement: HTMLElement, event: MouseEvent }) => void)|string): void
|
|
2324
2043
|
/**
|
|
2325
2044
|
* Fired when the mouse leaves a row
|
|
2326
2045
|
* @param {string} e Event name
|
|
2327
2046
|
* @param {object} params Event parameters
|
|
2328
|
-
* @param {
|
|
2329
|
-
* @param {
|
|
2330
|
-
* @param {
|
|
2331
|
-
* @param {
|
|
2332
|
-
* @param {
|
|
2333
|
-
* @param {HTMLElement} params.params.event.cellElement The cell HTML element that the mouse left
|
|
2334
|
-
* @param {MouseEvent} params.params.event.event The native DOM event
|
|
2047
|
+
* @param {object} params.event Event object
|
|
2048
|
+
* @param {Grid.view.Grid} params.event.source The grid instance
|
|
2049
|
+
* @param {Core.data.Model} params.event.record The record representing the row that the mouse left
|
|
2050
|
+
* @param {HTMLElement} params.event.cellElement The cell HTML element that the mouse left
|
|
2051
|
+
* @param {MouseEvent} params.event.event The native DOM event
|
|
2335
2052
|
*/
|
|
2336
2053
|
(e: 'rowMouseLeave', params: ((event: { source: Grid, record: Model, cellElement: HTMLElement, event: MouseEvent }) => void)|string): void
|
|
2337
2054
|
/**
|
|
2338
2055
|
* Grid has scrolled vertically
|
|
2339
2056
|
* @param {string} e Event name
|
|
2340
2057
|
* @param {object} params Event parameters
|
|
2341
|
-
* @param {
|
|
2342
|
-
* @param {
|
|
2343
|
-
* @param {
|
|
2344
|
-
* @param {Grid.view.GridBase} params.params.event.source The firing Grid instance.
|
|
2345
|
-
* @param {number} params.params.event.scrollTop The vertical scroll position.
|
|
2058
|
+
* @param {object} params.event Event object
|
|
2059
|
+
* @param {Grid.view.GridBase} params.event.source The firing Grid instance.
|
|
2060
|
+
* @param {number} params.event.scrollTop The vertical scroll position.
|
|
2346
2061
|
*/
|
|
2347
2062
|
(e: 'scroll', params: ((event: { source: GridBase, scrollTop: number }) => void)|string): void
|
|
2348
2063
|
/**
|
|
2349
2064
|
* The selection has been changed.
|
|
2350
2065
|
* @param {string} e Event name
|
|
2351
2066
|
* @param {object} params Event parameters
|
|
2352
|
-
* @param {
|
|
2353
|
-
* @param {
|
|
2354
|
-
* @param {
|
|
2355
|
-
* @param {
|
|
2356
|
-
* @param {
|
|
2357
|
-
* @param {
|
|
2358
|
-
* @param {Core.data.Model[]} params.
|
|
2359
|
-
* @param {
|
|
2360
|
-
* @param {
|
|
2361
|
-
* @param {Grid.util.GridLocation[]} params.
|
|
2362
|
-
* @param {Grid.util.GridLocation[]} params.params.event.selectedCells The cells selected in this operation.
|
|
2363
|
-
* @param {Grid.util.GridLocation[]} params.params.event.cellSelection The cells in the new selection.
|
|
2067
|
+
* @param {object} params.event Event object
|
|
2068
|
+
* @param {'select','deselect'} params.event.action `'select'`/`'deselect'`
|
|
2069
|
+
* @param {'row','cell'} params.event.mode `'row'`/`'cell'`
|
|
2070
|
+
* @param {Grid.view.Grid} params.event.source
|
|
2071
|
+
* @param {Core.data.Model[]} params.event.deselected The records deselected in this operation.
|
|
2072
|
+
* @param {Core.data.Model[]} params.event.selected The records selected in this operation.
|
|
2073
|
+
* @param {Core.data.Model[]} params.event.selection The records in the new selection.
|
|
2074
|
+
* @param {Grid.util.GridLocation[]} params.event.deselectedCells The cells deselected in this operation.
|
|
2075
|
+
* @param {Grid.util.GridLocation[]} params.event.selectedCells The cells selected in this operation.
|
|
2076
|
+
* @param {Grid.util.GridLocation[]} params.event.cellSelection The cells in the new selection.
|
|
2364
2077
|
*/
|
|
2365
2078
|
(e: 'selectionChange', params: ((event: { action: 'select'|'deselect', mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => void)|string): void
|
|
2366
2079
|
/**
|
|
2367
2080
|
* The selectionMode configuration has been changed.
|
|
2368
2081
|
* @param {string} e Event name
|
|
2369
2082
|
* @param {object} params Event parameters
|
|
2370
|
-
* @param {
|
|
2371
|
-
* @param {object} params.
|
|
2372
|
-
* @param {object} params.params.event Event object
|
|
2373
|
-
* @param {object} params.params.event.selectionMode The new [selectionMode](https://bryntum.com/products/grid/docs/api/Grid/view/mixin/GridSelection#config-selectionMode)
|
|
2083
|
+
* @param {object} params.event Event object
|
|
2084
|
+
* @param {object} params.event.selectionMode The new [selectionMode](https://bryntum.com/products/grid/docs/api/Grid/view/mixin/GridSelection#config-selectionMode)
|
|
2374
2085
|
*/
|
|
2375
2086
|
(e: 'selectionModeChange', params: ((event: { selectionMode: object }) => void)|string): void
|
|
2376
2087
|
/**
|
|
2377
2088
|
* Triggered after a widget is shown.
|
|
2378
2089
|
* @param {string} e Event name
|
|
2379
2090
|
* @param {object} params Event parameters
|
|
2380
|
-
* @param {
|
|
2381
|
-
* @param {
|
|
2382
|
-
* @param {object} params.params.event Event object
|
|
2383
|
-
* @param {Core.widget.Widget} params.params.event.source The widget
|
|
2091
|
+
* @param {object} params.event Event object
|
|
2092
|
+
* @param {Core.widget.Widget} params.event.source The widget
|
|
2384
2093
|
*/
|
|
2385
2094
|
(e: 'show', params: ((event: { source: Widget }) => void)|string): void
|
|
2386
2095
|
/**
|
|
2387
2096
|
* Fires when splitting the Grid.
|
|
2388
2097
|
* @param {string} e Event name
|
|
2389
2098
|
* @param {object} params Event parameters
|
|
2390
|
-
* @param {
|
|
2391
|
-
* @param {
|
|
2392
|
-
* @param {object} params.
|
|
2393
|
-
* @param {
|
|
2394
|
-
* @param {
|
|
2395
|
-
* @param {
|
|
2396
|
-
* @param {Grid.column.Column} params.params.event.options.atColumn The column to split at
|
|
2397
|
-
* @param {Core.data.Model} params.params.event.options.atRecord The record to split at
|
|
2099
|
+
* @param {object} params.event Event object
|
|
2100
|
+
* @param {Grid.view.GridBase[]} params.event.subViews The sub views created by the split
|
|
2101
|
+
* @param {object} params.event.options The options passed to the split call
|
|
2102
|
+
* @param {'horizontal','vertical','both'} params.event.options.direction The direction of the split
|
|
2103
|
+
* @param {Grid.column.Column} params.event.options.atColumn The column to split at
|
|
2104
|
+
* @param {Core.data.Model} params.event.options.atRecord The record to split at
|
|
2398
2105
|
*/
|
|
2399
2106
|
(e: 'split', params: ((event: { subViews: GridBase[], options: { direction: 'horizontal'|'vertical'|'both', atColumn: Column, atRecord: Model } }) => void)|string): void
|
|
2400
2107
|
/**
|
|
@@ -2402,36 +2109,30 @@ const emit = defineEmits<{
|
|
|
2402
2109
|
* if you want to implement your own behavior.
|
|
2403
2110
|
* @param {string} e Event name
|
|
2404
2111
|
* @param {object} params Event parameters
|
|
2405
|
-
* @param {
|
|
2406
|
-
* @param {
|
|
2407
|
-
* @param {
|
|
2408
|
-
* @param {
|
|
2409
|
-
* @param {Grid.view.SubGrid} params.params.event.subGrid The subgrid
|
|
2410
|
-
* @param {Event} params.params.event.domEvent The native DOM event
|
|
2112
|
+
* @param {object} params.event Event object
|
|
2113
|
+
* @param {Grid.view.Grid} params.event.source The Grid instance.
|
|
2114
|
+
* @param {Grid.view.SubGrid} params.event.subGrid The subgrid
|
|
2115
|
+
* @param {Event} params.event.domEvent The native DOM event
|
|
2411
2116
|
*/
|
|
2412
|
-
(e: 'splitterCollapseClick', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
2117
|
+
(e: 'splitterCollapseClick', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string): boolean|void
|
|
2413
2118
|
/**
|
|
2414
2119
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
2415
2120
|
* @param {string} e Event name
|
|
2416
2121
|
* @param {object} params Event parameters
|
|
2417
|
-
* @param {
|
|
2418
|
-
* @param {
|
|
2419
|
-
* @param {
|
|
2420
|
-
* @param {
|
|
2421
|
-
* @param {Grid.view.SubGrid} params.params.event.subGrid The resized subgrid
|
|
2422
|
-
* @param {Event} params.params.event.domEvent The native DOM event
|
|
2122
|
+
* @param {object} params.event Event object
|
|
2123
|
+
* @param {Grid.view.Grid} params.event.source The Grid instance.
|
|
2124
|
+
* @param {Grid.view.SubGrid} params.event.subGrid The resized subgrid
|
|
2125
|
+
* @param {Event} params.event.domEvent The native DOM event
|
|
2423
2126
|
*/
|
|
2424
2127
|
(e: 'splitterDragEnd', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => void)|string): void
|
|
2425
2128
|
/**
|
|
2426
2129
|
* Fired by the Grid when a sub-grid resize gesture starts
|
|
2427
2130
|
* @param {string} e Event name
|
|
2428
2131
|
* @param {object} params Event parameters
|
|
2429
|
-
* @param {
|
|
2430
|
-
* @param {
|
|
2431
|
-
* @param {
|
|
2432
|
-
* @param {
|
|
2433
|
-
* @param {Grid.view.SubGrid} params.params.event.subGrid The subgrid about to be resized
|
|
2434
|
-
* @param {Event} params.params.event.domEvent The native DOM event
|
|
2132
|
+
* @param {object} params.event Event object
|
|
2133
|
+
* @param {Grid.view.Grid} params.event.source The Grid instance.
|
|
2134
|
+
* @param {Grid.view.SubGrid} params.event.subGrid The subgrid about to be resized
|
|
2135
|
+
* @param {Event} params.event.domEvent The native DOM event
|
|
2435
2136
|
*/
|
|
2436
2137
|
(e: 'splitterDragStart', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => void)|string): void
|
|
2437
2138
|
/**
|
|
@@ -2439,113 +2140,93 @@ const emit = defineEmits<{
|
|
|
2439
2140
|
* if you want to implement your own behavior.
|
|
2440
2141
|
* @param {string} e Event name
|
|
2441
2142
|
* @param {object} params Event parameters
|
|
2442
|
-
* @param {
|
|
2443
|
-
* @param {
|
|
2444
|
-
* @param {
|
|
2445
|
-
* @param {
|
|
2446
|
-
* @param {Grid.view.SubGrid} params.params.event.subGrid The subgrid
|
|
2447
|
-
* @param {Event} params.params.event.domEvent The native DOM event
|
|
2143
|
+
* @param {object} params.event Event object
|
|
2144
|
+
* @param {Grid.view.Grid} params.event.source The Grid instance.
|
|
2145
|
+
* @param {Grid.view.SubGrid} params.event.subGrid The subgrid
|
|
2146
|
+
* @param {Event} params.event.domEvent The native DOM event
|
|
2448
2147
|
*/
|
|
2449
|
-
(e: 'splitterExpandClick', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
2148
|
+
(e: 'splitterExpandClick', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string): boolean|void
|
|
2450
2149
|
/**
|
|
2451
2150
|
* Fires on the owning Grid when editing starts
|
|
2452
2151
|
* @param {string} e Event name
|
|
2453
2152
|
* @param {object} params Event parameters
|
|
2454
|
-
* @param {
|
|
2455
|
-
* @param {
|
|
2456
|
-
* @param {
|
|
2457
|
-
* @param {Grid.view.Grid} params.params.event.source Owner grid
|
|
2458
|
-
* @param {CellEditorContext} params.params.event.editorContext Editing context
|
|
2153
|
+
* @param {object} params.event Event object
|
|
2154
|
+
* @param {Grid.view.Grid} params.event.source Owner grid
|
|
2155
|
+
* @param {CellEditorContext} params.event.editorContext Editing context
|
|
2459
2156
|
*/
|
|
2460
2157
|
(e: 'startCellEdit', params: ((event: { source: Grid, editorContext: CellEditorContext }) => void)|string): void
|
|
2461
2158
|
/**
|
|
2462
2159
|
* Fires on the owning Grid when editing starts
|
|
2463
2160
|
* @param {string} e Event name
|
|
2464
2161
|
* @param {object} params Event parameters
|
|
2465
|
-
* @param {
|
|
2466
|
-
* @param {
|
|
2467
|
-
* @param {
|
|
2468
|
-
* @param {Grid.view.Grid} params.params.event.source Owner grid
|
|
2469
|
-
* @param {RowEditorContext} params.params.event.editorContext Editing context
|
|
2162
|
+
* @param {object} params.event Event object
|
|
2163
|
+
* @param {Grid.view.Grid} params.event.source Owner grid
|
|
2164
|
+
* @param {RowEditorContext} params.event.editorContext Editing context
|
|
2470
2165
|
*/
|
|
2471
2166
|
(e: 'startRowEdit', params: ((event: { source: Grid, editorContext: RowEditorContext }) => void)|string): void
|
|
2472
2167
|
/**
|
|
2473
2168
|
* Fires after a sub grid is collapsed.
|
|
2474
2169
|
* @param {string} e Event name
|
|
2475
2170
|
* @param {object} params Event parameters
|
|
2476
|
-
* @param {
|
|
2477
|
-
* @param {
|
|
2478
|
-
* @param {
|
|
2479
|
-
* @param {Grid.view.GridBase} params.params.event.source The firing Grid instance
|
|
2480
|
-
* @param {Grid.view.SubGrid} params.params.event.subGrid The sub grid instance
|
|
2171
|
+
* @param {object} params.event Event object
|
|
2172
|
+
* @param {Grid.view.GridBase} params.event.source The firing Grid instance
|
|
2173
|
+
* @param {Grid.view.SubGrid} params.event.subGrid The sub grid instance
|
|
2481
2174
|
*/
|
|
2482
2175
|
(e: 'subGridCollapse', params: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string): void
|
|
2483
2176
|
/**
|
|
2484
2177
|
* Fires after a sub grid is expanded.
|
|
2485
2178
|
* @param {string} e Event name
|
|
2486
2179
|
* @param {object} params Event parameters
|
|
2487
|
-
* @param {
|
|
2488
|
-
* @param {
|
|
2489
|
-
* @param {
|
|
2490
|
-
* @param {Grid.view.GridBase} params.params.event.source The firing Grid instance
|
|
2491
|
-
* @param {Grid.view.SubGrid} params.params.event.subGrid The sub grid instance
|
|
2180
|
+
* @param {object} params.event Event object
|
|
2181
|
+
* @param {Grid.view.GridBase} params.event.source The firing Grid instance
|
|
2182
|
+
* @param {Grid.view.SubGrid} params.event.subGrid The sub grid instance
|
|
2492
2183
|
*/
|
|
2493
2184
|
(e: 'subGridExpand', params: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string): void
|
|
2494
2185
|
/**
|
|
2495
2186
|
* Fired when one or more groups are expanded or collapsed
|
|
2496
2187
|
* @param {string} e Event name
|
|
2497
2188
|
* @param {object} params Event parameters
|
|
2498
|
-
* @param {
|
|
2499
|
-
* @param {
|
|
2500
|
-
* @param {
|
|
2501
|
-
* @param {
|
|
2502
|
-
* @param {
|
|
2503
|
-
* @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
|
|
2189
|
+
* @param {object} params.event Event object
|
|
2190
|
+
* @param {Core.data.Model} params.event.groupRecord [DEPRECATED] Use `groupRecords` param instead
|
|
2191
|
+
* @param {Core.data.Model[]} params.event.groupRecords The group records being toggled
|
|
2192
|
+
* @param {boolean} params.event.collapse Collapsed (true) or expanded (false)
|
|
2193
|
+
* @param {boolean} [params.event.allRecords] True if this event is part of toggling all groups
|
|
2505
2194
|
*/
|
|
2506
2195
|
(e: 'toggleGroup', params: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, allRecords?: boolean }) => void)|string): void
|
|
2507
2196
|
/**
|
|
2508
2197
|
* Fired after a parent node record toggles its collapsed state.
|
|
2509
2198
|
* @param {string} e Event name
|
|
2510
2199
|
* @param {object} params Event parameters
|
|
2511
|
-
* @param {
|
|
2512
|
-
* @param {
|
|
2513
|
-
* @param {
|
|
2514
|
-
* @param {Core.data.Model} params.params.event.record The record being toggled.
|
|
2515
|
-
* @param {boolean} params.params.event.collapse `true` if the node is being collapsed.
|
|
2200
|
+
* @param {object} params.event Event object
|
|
2201
|
+
* @param {Core.data.Model} params.event.record The record being toggled.
|
|
2202
|
+
* @param {boolean} params.event.collapse `true` if the node is being collapsed.
|
|
2516
2203
|
*/
|
|
2517
2204
|
(e: 'toggleNode', params: ((event: { record: Model, collapse: boolean }) => void)|string): void
|
|
2518
2205
|
/**
|
|
2519
2206
|
* A header [tool](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-tools) has been clicked.
|
|
2520
2207
|
* @param {string} e Event name
|
|
2521
2208
|
* @param {object} params Event parameters
|
|
2522
|
-
* @param {
|
|
2523
|
-
* @param {
|
|
2524
|
-
* @param {
|
|
2525
|
-
* @param {Core.widget.Tool} params.params.event.source This Panel.
|
|
2526
|
-
* @param {Core.widget.Tool} params.params.event.tool The tool which is being clicked.
|
|
2209
|
+
* @param {object} params.event Event object
|
|
2210
|
+
* @param {Core.widget.Tool} params.event.source This Panel.
|
|
2211
|
+
* @param {Core.widget.Tool} params.event.tool The tool which is being clicked.
|
|
2527
2212
|
*/
|
|
2528
2213
|
(e: 'toolClick', params: ((event: { source: Tool, tool: Tool }) => void)|string): void
|
|
2529
2214
|
/**
|
|
2530
2215
|
* Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
|
|
2531
2216
|
* @param {string} e Event name
|
|
2532
2217
|
* @param {object} params Event parameters
|
|
2533
|
-
* @param {
|
|
2534
|
-
* @param {
|
|
2535
|
-
* @param {
|
|
2536
|
-
* @param {
|
|
2537
|
-
* @param {(string|Function)[]} params.params.event.groupers Array of field names or functions representing the current grouping levels
|
|
2538
|
-
* @param {(string|Function)[]} params.params.event.oldGroupers Array of field names or functions representing the previous grouping levels
|
|
2218
|
+
* @param {object} params.event Event object
|
|
2219
|
+
* @param {Grid.view.Grid} params.event.source The grid instance
|
|
2220
|
+
* @param {(string|Function)[]} params.event.groupers Array of field names or functions representing the current grouping levels
|
|
2221
|
+
* @param {(string|Function)[]} params.event.oldGroupers Array of field names or functions representing the previous grouping levels
|
|
2539
2222
|
*/
|
|
2540
2223
|
(e: 'treeGroup', params: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string): void
|
|
2541
2224
|
/**
|
|
2542
2225
|
* Fires when row locking is disabled.
|
|
2543
2226
|
* @param {string} e Event name
|
|
2544
2227
|
* @param {object} params Event parameters
|
|
2545
|
-
* @param {
|
|
2546
|
-
* @param {
|
|
2547
|
-
* @param {object} params.params.event Event object
|
|
2548
|
-
* @param {Grid.view.GridBase} params.params.event.clone The locked clone that will be destroyed
|
|
2228
|
+
* @param {object} params.event Event object
|
|
2229
|
+
* @param {Grid.view.GridBase} params.event.clone The locked clone that will be destroyed
|
|
2549
2230
|
*/
|
|
2550
2231
|
(e: 'unlockRows', params: ((event: { clone: GridBase }) => void)|string): void
|
|
2551
2232
|
/**
|
|
@@ -2662,6 +2343,7 @@ const widgetData = {
|
|
|
2662
2343
|
'resizeToFitIncludesHeader',
|
|
2663
2344
|
'responsiveLevels',
|
|
2664
2345
|
'ripple',
|
|
2346
|
+
'role',
|
|
2665
2347
|
'rootElement',
|
|
2666
2348
|
'scrollerClass',
|
|
2667
2349
|
'scrollManager',
|
|
@@ -2709,6 +2391,7 @@ const widgetData = {
|
|
|
2709
2391
|
'insertFirst',
|
|
2710
2392
|
'keyMap',
|
|
2711
2393
|
'labelPosition',
|
|
2394
|
+
'labelWidth',
|
|
2712
2395
|
'longPressTime',
|
|
2713
2396
|
'margin',
|
|
2714
2397
|
'maxHeight',
|
|
@@ -2852,8 +2535,6 @@ const widgetData = {
|
|
|
2852
2535
|
'width'
|
|
2853
2536
|
],
|
|
2854
2537
|
propertyNames : [
|
|
2855
|
-
'focusVisible',
|
|
2856
|
-
'hasChanges',
|
|
2857
2538
|
'originalStore',
|
|
2858
2539
|
'parent',
|
|
2859
2540
|
'selectedCell',
|