@bryntum/gantt-react-thin 7.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (40) hide show
  1. package/README.md +52 -0
  2. package/lib/BryntumAssignmentField.d.ts +272 -0
  3. package/lib/BryntumAssignmentField.js +204 -0
  4. package/lib/BryntumAssignmentField.js.map +1 -0
  5. package/lib/BryntumAssignmentGrid.d.ts +836 -0
  6. package/lib/BryntumAssignmentGrid.js +283 -0
  7. package/lib/BryntumAssignmentGrid.js.map +1 -0
  8. package/lib/BryntumCalendarPicker.d.ts +267 -0
  9. package/lib/BryntumCalendarPicker.js +202 -0
  10. package/lib/BryntumCalendarPicker.js.map +1 -0
  11. package/lib/BryntumDependencyField.d.ts +274 -0
  12. package/lib/BryntumDependencyField.js +209 -0
  13. package/lib/BryntumDependencyField.js.map +1 -0
  14. package/lib/BryntumGantt.d.ts +1776 -0
  15. package/lib/BryntumGantt.js +601 -0
  16. package/lib/BryntumGantt.js.map +1 -0
  17. package/lib/BryntumGanttBase.d.ts +1775 -0
  18. package/lib/BryntumGanttBase.js +600 -0
  19. package/lib/BryntumGanttBase.js.map +1 -0
  20. package/lib/BryntumGanttProjectModel.d.ts +306 -0
  21. package/lib/BryntumGanttProjectModel.js +188 -0
  22. package/lib/BryntumGanttProjectModel.js.map +1 -0
  23. package/lib/WrapperHelper.d.ts +26 -0
  24. package/lib/WrapperHelper.js +569 -0
  25. package/lib/WrapperHelper.js.map +1 -0
  26. package/lib/index.d.ts +7 -0
  27. package/lib/index.js +8 -0
  28. package/lib/index.js.map +1 -0
  29. package/license.pdf +0 -0
  30. package/licenses.md +310 -0
  31. package/package.json +25 -0
  32. package/src/BryntumAssignmentField.tsx +1250 -0
  33. package/src/BryntumAssignmentGrid.tsx +2349 -0
  34. package/src/BryntumCalendarPicker.tsx +1231 -0
  35. package/src/BryntumDependencyField.tsx +1272 -0
  36. package/src/BryntumGantt.tsx +4698 -0
  37. package/src/BryntumGanttBase.tsx +4696 -0
  38. package/src/BryntumGanttProjectModel.tsx +1147 -0
  39. package/src/WrapperHelper.tsx +1125 -0
  40. package/src/index.ts +11 -0
@@ -0,0 +1,2349 @@
1
+ /**
2
+ * React wrapper for Bryntum AssignmentGrid
3
+ */
4
+ // eslint-disable-next-line @typescript-eslint/no-unused-vars
5
+ import React, { RefObject } from 'react';
6
+ import { AjaxStore, AjaxStoreConfig, Base, Container, DomConfig, FormulaProviderConfig, KeyMapConfig, Mask, MaskConfig, Menu, MenuItem, MenuItemEntry, Model, ModelConfig, PagingToolbarConfig, Panel, PanelCollapserConfig, PanelCollapserOverlayConfig, PanelHeader, ScrollManager, ScrollManagerConfig, Scroller, ScrollerConfig, StateProvider, Store, StoreConfig, TabConfig, Tool, ToolConfig, ToolbarConfig, ToolbarItems, TooltipConfig, Widget } from '@bryntum/core-thin';
7
+ import { AIFilter, AIFilterConfig, CellCopyPaste, CellCopyPasteConfig, CellEdit as GridCellEdit, CellEditConfig as GridCellEditConfig, CellEditorContext, CellMenu, CellMenuConfig, CellTooltip, CellTooltipConfig, Charts, ChartsConfig, Column, ColumnAutoWidth, ColumnAutoWidthConfig, ColumnDragToolbar, ColumnDragToolbarConfig, ColumnPicker, ColumnPickerConfig, ColumnRename, ColumnRenameConfig, ColumnReorder, ColumnReorderConfig, ColumnResize, ColumnResizeConfig, ColumnStore, ColumnStoreConfig, EmptyTextDomConfig, ExcelExporter as GridExcelExporter, ExcelExporterConfig as GridExcelExporterConfig, ExportConfig, FileDrop, FileDropConfig, FillHandle, FillHandleConfig, Filter, FilterBar, FilterBarConfig, FilterConfig, Grid, GridBase, GridLocation, GridLocationConfig, GridSelectionMode, GridStateInfo, Group, GroupConfig, GroupSummary as GridGroupSummary, GroupSummaryConfig as GridGroupSummaryConfig, HeaderMenu, HeaderMenuConfig, LockRows as GridLockRows, LockRowsConfig as GridLockRowsConfig, MergeCells, MergeCellsConfig, NumberColumnConfig, PdfExport as GridPdfExport, PdfExportConfig as GridPdfExportConfig, PinColumns, PinColumnsConfig, PreserveScrollOptions, Print as GridPrint, PrintConfig as GridPrintConfig, QuickFind, QuickFindConfig, RecordPositionContext, RegionResize, RegionResizeConfig, ResponsiveLevelConfig, Row, RowCopyPaste, RowCopyPasteConfig, RowEdit, RowEditConfig, RowEditorContext, RowExpander, RowExpanderConfig, RowReorder as GridRowReorder, RowReorderConfig as GridRowReorderConfig, RowResize as GridRowResize, RowResizeConfig as GridRowResizeConfig, Search, SearchConfig, Sort, SortConfig, Split as GridSplit, SplitConfig as GridSplitConfig, StickyCells, StickyCellsConfig, Stripe, StripeConfig, SubGrid, SubGridConfig, Summary as GridSummary, SummaryConfig as GridSummaryConfig, Tree, TreeConfig, TreeGroup as GridTreeGroup, TreeGroupConfig as GridTreeGroupConfig, XLSColumn } from '@bryntum/grid-thin';
8
+ import { AssignmentGrid, AssignmentGridListeners, GanttContainerItemConfig, GanttColumnConfig, ResourceAssignmentColumnConfig, TaskModel } from '@bryntum/gantt-thin';
9
+
10
+ import { createWidget, shouldComponentUpdate, processWidgetContent } from './WrapperHelper.js';
11
+
12
+ export type BryntumAssignmentGridProps = {
13
+ // Configs
14
+ /**
15
+ * Element (or element id) to adopt as this Widget's encapsulating element. The widget's
16
+ * content will be placed inside this element.
17
+ * ...
18
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-adopt)
19
+ */
20
+ adopt? : HTMLElement|string
21
+ /**
22
+ * When this widget is a child of a [Container](https://bryntum.com/products/gantt/docs/api/Core/widget/Container), it will by default be participating in a
23
+ * flexbox layout. This config allows you to set this widget's
24
+ * [align-self](https://developer.mozilla.org/en-US/docs/Web/CSS/align-self) style.
25
+ */
26
+ alignSelf? : string
27
+ /**
28
+ * Set to `true` to animate row removals caused by filtering.
29
+ * @deprecated 7.0.0 Deprecated `animateFilterRemovals`. Use `transition.filterRemoval` instead
30
+ */
31
+ animateFilterRemovals? : boolean
32
+ /**
33
+ * Controls if removing and inserting rows should be animated. Set to `false` to prevent those animations,
34
+ * removing the related delays.
35
+ * @deprecated 7.0.0 Deprecated `animateRemovingRows`. Use `transition.removeRecord` instead
36
+ */
37
+ animateRemovingRows? : boolean
38
+ /**
39
+ * When the [Tree](https://bryntum.com/products/gantt/docs/api/Grid/feature/Tree) feature is in use and the Store is a tree store, this
40
+ * config may be set to `true` to visually animate branch node expand and collapse operations.
41
+ * *This is not supported in Scheduler and Gantt*
42
+ * @deprecated 7.0.0 Deprecated `animateTreeNodeToggle`. Use `transition.toggleTreeNode` instead
43
+ */
44
+ animateTreeNodeToggle? : boolean
45
+ /**
46
+ * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
47
+ * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/gantt/docs/api/Core/widget/Widget#property-element).
48
+ */
49
+ appendTo? : HTMLElement|string
50
+ /**
51
+ * A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject
52
+ * into an element which will be linked using the `aria-describedby` attribute.
53
+ * ...
54
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-ariaDescription)
55
+ */
56
+ ariaDescription? : string
57
+ /**
58
+ * A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject as
59
+ * the `aria-label` attribute.
60
+ * ...
61
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-ariaLabel)
62
+ */
63
+ ariaLabel? : string
64
+ /**
65
+ * Automatically set grids height to fit all rows (no scrolling in the grid). In general you should avoid
66
+ * using `autoHeight: true`, since it will bypass Grids virtual rendering and render all rows at once, which
67
+ * in a larger grid is really bad for performance.
68
+ */
69
+ autoHeight? : boolean
70
+ /**
71
+ * A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/gantt/docs/api/Core/widget/Toolbar),
72
+ * 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/gantt/docs/api/Core/widget/Panel#config-strips).
73
+ * ...
74
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-bbar)
75
+ */
76
+ bbar? : (GanttContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
77
+ /**
78
+ * Custom CSS classes to add to the panel's body element.
79
+ * ...
80
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-bodyCls)
81
+ */
82
+ bodyCls? : string|object
83
+ /**
84
+ * An object where property names with a truthy value indicate which events should bubble up the ownership
85
+ * hierarchy when triggered.
86
+ * ...
87
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-bubbleEvents)
88
+ */
89
+ bubbleEvents? : object
90
+ /**
91
+ * Set to `false` to not call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
92
+ * ...
93
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-callOnFunctions)
94
+ */
95
+ callOnFunctions? : boolean
96
+ /**
97
+ * By default, if an event handler throws an exception, the error propagates up the stack and the
98
+ * application state is undefined. Code which follows the event handler will *not* be executed.
99
+ * ...
100
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-catchEventHandlerExceptions)
101
+ */
102
+ catchEventHandlerExceptions? : boolean
103
+ /**
104
+ * Set to `false` to crop text in grid cells without ellipsis (...). When enabled, cells containing pure
105
+ * use `display : block`, instead of `display : flex` to allow ellipsis to work.
106
+ * <strong>NOTE</strong> Only supported in browsers that support `:has()` CSS selector
107
+ */
108
+ cellEllipsis? : boolean
109
+ /**
110
+ * Custom CSS classes to add to element.
111
+ * May be specified as a space separated string, or as an object in which property names
112
+ * with truthy values are used as the class names:
113
+ * ...
114
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-cls)
115
+ */
116
+ cls? : string|object
117
+ /**
118
+ * Controls whether the panel is collapsed (the body of the panel is hidden while only the header is
119
+ * visible). Only valid if the panel is [collapsible](https://bryntum.com/products/gantt/docs/api/Core/widget/Panel#config-collapsible).
120
+ */
121
+ collapsed? : boolean
122
+ /**
123
+ * This config enables collapsibility for the panel. See [collapsed](https://bryntum.com/products/gantt/docs/api/Core/widget/Panel#config-collapsed).
124
+ * ...
125
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-collapsible)
126
+ */
127
+ collapsible? : boolean|PanelCollapserConfig|PanelCollapserOverlayConfig
128
+ /**
129
+ * Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
130
+ * `style` block.
131
+ * ...
132
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-color)
133
+ */
134
+ color? : string
135
+ /**
136
+ * Programmatic control over which column to start in when used in a grid layout.
137
+ */
138
+ column? : number
139
+ /**
140
+ * Set to `false` to not show column lines. End result might be overruled by/differ between themes.
141
+ */
142
+ columnLines? : boolean
143
+ /**
144
+ * Accepts column definitions for the grid during initialization. They will be used to create
145
+ * [Column](https://bryntum.com/products/gantt/docs/api/Grid/column/Column) instances that are added to a [ColumnStore](#Grid/data/ColumnStore).
146
+ * ...
147
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-columns)
148
+ */
149
+ columns? : ColumnStore|GanttColumnConfig[]|ColumnStoreConfig
150
+ config? : object
151
+ /**
152
+ * Custom CSS classes to add to the [contentElement](https://bryntum.com/products/gantt/docs/api/Core/widget/Widget#property-contentElement).
153
+ * May be specified as a space separated string, or as an object in which property names
154
+ * with truthy values are used as the class names:
155
+ * ...
156
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-contentElementCls)
157
+ */
158
+ contentElementCls? : string|object
159
+ /**
160
+ * Event which is used to show context menus.
161
+ * Available options are: 'contextmenu', 'click', 'dblclick'.
162
+ */
163
+ contextMenuTriggerEvent? : 'contextmenu'|'click'|'dblclick'
164
+ /**
165
+ * Convenient shortcut to set data in grids store both during initialization and at runtime. Can also be
166
+ * used to retrieve data at runtime, although we do recommend interacting with Grids store instead using
167
+ * the [store](https://bryntum.com/products/gantt/docs/api/Grid/view/GridBase#property-store) property.
168
+ * ...
169
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-data)
170
+ */
171
+ data? : object[]|Model[]|ModelConfig[]
172
+ /**
173
+ * When this Widget configuration is used in the Grid's RowExpander feature's `widget` config, provide the
174
+ * field on the expanded record to use for populating this widget's store (if applicable)
175
+ */
176
+ dataField? : string
177
+ /**
178
+ * Object to apply to elements dataset (each key will be used as a data-attribute on the element)
179
+ */
180
+ dataset? : Record<string, string>
181
+ /**
182
+ * Region to which columns are added when they have none specified
183
+ */
184
+ defaultRegion? : string
185
+ /**
186
+ * Set to `true` to destroy the store when the grid is destroyed.
187
+ */
188
+ destroyStore? : boolean
189
+ /**
190
+ * Check for CSS compatibility issues when upgrading to v7. Performs the following checks:
191
+ * ...
192
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-detectCSSCompatibilityIssues)
193
+ */
194
+ detectCSSCompatibilityIssues? : boolean
195
+ /**
196
+ * Disable or enable the widget. It is similar to [readOnly](https://bryntum.com/products/gantt/docs/api/Core/widget/Widget#config-readOnly) except a disabled widget
197
+ * cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
198
+ * ...
199
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-disabled)
200
+ */
201
+ disabled? : boolean|'inert'
202
+ /**
203
+ * Set to `true` to not get a warning when calling [getState](https://bryntum.com/products/gantt/docs/api/Grid/view/GridBase#function-getState) when there is a column
204
+ * configured without an `id`. But the recommended action is to always configure columns with an `id` when
205
+ * using states.
206
+ */
207
+ disableGridColumnIdWarning? : boolean
208
+ /**
209
+ * Set to `true` to not get a warning when using another base class than GridRowModel for your grid data. If
210
+ * you do, and would like to use the full feature set of the grid then include the fields from GridRowModel
211
+ * in your model definition.
212
+ */
213
+ disableGridRowModelWarning? : boolean
214
+ /**
215
+ * Controls the placement of this widget when it is added to a [panel's ](https://bryntum.com/products/gantt/docs/api/Core/widget/Panel)
216
+ * [strips collection](https://bryntum.com/products/gantt/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
217
+ * `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
218
+ * body. Such widgets are called "edge strips".
219
+ * ...
220
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-dock)
221
+ */
222
+ dock? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
223
+ /**
224
+ * Make this Panel a docked drawer which slides out from one side of the browser viewport by default.
225
+ * ...
226
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-drawer)
227
+ * @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.
228
+ * @param {string,number} size The size of the drawer in its collapsible axis.
229
+ * @param {boolean} inline If using the [appendTo](https://bryntum.com/products/gantt/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.
230
+ * @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.
231
+ * @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.
232
+ * @param {boolean,string} autoClose.focusout If focus moves outside of the drawer, the drawer will automatically be hidden.
233
+ * @param {string} autoClose.mouseout Hides the drawer when the mouse leaves the drawer after the `autoCloseDelay` period.
234
+ * @param {number} autoCloseDelay When using `mouseout`, this is the delay in milliseconds
235
+ */
236
+ 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}
237
+ /**
238
+ * An object specifying attributes to assign to the root element of this widget.
239
+ * Set `null` value to attribute to remove it.
240
+ * ...
241
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-elementAttributes)
242
+ */
243
+ elementAttributes? : Record<string, string|null>
244
+ /**
245
+ * Text or HTML, or a [EmptyTextDomConfig](https://bryntum.com/products/gantt/docs/api/Grid/view/GridBase#typedef-EmptyTextDomConfig) block to display when there is no data to display in the grid.
246
+ * When using multiple Grid regions, provide the `region` property to decide where the text is shown.
247
+ * By default, it is shown in the first region.
248
+ * ...
249
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-emptyText)
250
+ */
251
+ emptyText? : string|EmptyTextDomConfig
252
+ /**
253
+ * Configure this as `true` to allow elements within cells to be styled as `position: sticky`.
254
+ * ...
255
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-enableSticky)
256
+ */
257
+ enableSticky? : boolean
258
+ /**
259
+ * Set to `true` to allow text selection in the grid cells. Note, this cannot be used simultaneously with the
260
+ * `RowReorder` feature.
261
+ */
262
+ enableTextSelection? : boolean
263
+ /**
264
+ * Set to `true` to listen for CTRL-Z (CMD-Z on Mac OS) keyboard event and trigger undo (redo when SHIFT is
265
+ * pressed). Only applicable when using a [StateTrackingManager](https://bryntum.com/products/gantt/docs/api/Core/data/stm/StateTrackingManager).
266
+ */
267
+ enableUndoRedoKeys? : boolean
268
+ extraData? : any
269
+ /**
270
+ * Set to `true` to stretch the last column in a grid with all fixed width columns
271
+ * to fill extra available space if the grid's width is wider than the sum of all
272
+ * configured column widths.
273
+ */
274
+ fillLastColumn? : boolean
275
+ /**
276
+ * Use fixed row height. Setting this to `true` will configure the underlying RowManager to use fixed row
277
+ * height, which sacrifices the ability to use rows with variable height to gain a fraction better
278
+ * performance.
279
+ * ...
280
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-fixedRowHeight)
281
+ */
282
+ fixedRowHeight? : boolean
283
+ /**
284
+ * When this widget is a child of a [Container](https://bryntum.com/products/gantt/docs/api/Core/widget/Container), it will by default be participating in a
285
+ * flexbox layout. This config allows you to set this widget's
286
+ * [flex](https://developer.mozilla.org/en-US/docs/Web/CSS/flex) style.
287
+ * This may be configured as a single number or a `&lt;flex-grow&gt; &lt;flex-shrink&gt; &lt;flex-basis&gt;` format string.
288
+ * numeric-only values are interpreted as the `flex-grow` value.
289
+ */
290
+ flex? : number|string
291
+ /**
292
+ * Config object of a footer. May contain a `dock`, `html` and a `cls` property. A footer is not a widget,
293
+ * but rather plain HTML that follows the last element of the panel's body and [strips](https://bryntum.com/products/gantt/docs/api/Core/widget/Panel#config-strips).
294
+ * ...
295
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-footer)
296
+ */
297
+ footer? : {
298
+ dock?: 'top'|'right'|'bottom'|'left'|'start'|'end'
299
+ html?: string
300
+ cls?: string
301
+ }|string
302
+ /**
303
+ * An object which names formula prefixes which will be applied to all columns configured with
304
+ * `formula : true`.
305
+ * ...
306
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-formulaProviders)
307
+ */
308
+ formulaProviders? : Record<string, FormulaProviderConfig>
309
+ /**
310
+ * Refresh entire row when a record changes (`true`) or, if possible, only the cells affected (`false`).
311
+ * ...
312
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-fullRowRefresh)
313
+ */
314
+ fullRowRefresh? : boolean
315
+ /**
316
+ * A function called for each row to determine its height. It is passed a [record](https://bryntum.com/products/gantt/docs/api/Core/data/Model) and
317
+ * expected to return the desired height of that records row. If the function returns a falsy value, Grids
318
+ * configured [rowHeight](https://bryntum.com/products/gantt/docs/api/Grid/view/GridBase#config-rowHeight) is used.
319
+ * ...
320
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-getRowHeight)
321
+ * @param {Core.data.Model} getRowHeight.record Record to determine row height for
322
+ * @returns {number} Desired row height
323
+ */
324
+ getRowHeight? : (getRowHeight: { record: Model }) => number
325
+ /**
326
+ * A config [object](https://bryntum.com/products/gantt/docs/api/Core/widget/Panel#typedef-PanelHeader) for the panel's header or a string in place of a `title`.
327
+ * ...
328
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-header)
329
+ */
330
+ header? : string|boolean|PanelHeader
331
+ /**
332
+ * Widget's height, used to set element `style.height`. Either specify a valid height string or a number,
333
+ * which will get 'px' appended. We recommend using CSS as the primary way to control height, but in some
334
+ * cases this config is convenient.
335
+ */
336
+ height? : string|number
337
+ /**
338
+ * Configure with true to make widget initially hidden.
339
+ */
340
+ hidden? : boolean
341
+ /**
342
+ * Set to `true` to hide the footer elements
343
+ */
344
+ hideFooters? : boolean
345
+ /**
346
+ * Set to `true` to hide the column header elements
347
+ */
348
+ hideHeaders? : boolean
349
+ /**
350
+ * Set to `true` to hide the Grid's horizontal scrollbar(s)
351
+ */
352
+ hideHorizontalScrollbar? : boolean
353
+ /**
354
+ * A CSS class to add to hovered row elements
355
+ */
356
+ hoverCls? : string
357
+ /**
358
+ * An icon to show before the [title](https://bryntum.com/products/gantt/docs/api/Core/widget/Panel#config-title). Either pass a CSS class as a string, or pass a
359
+ * [DomConfig](https://bryntum.com/products/gantt/docs/api/Core/helper/DomHelper#typedef-DomConfig) object describing an element to represent the icon.
360
+ */
361
+ icon? : string|DomConfig
362
+ /**
363
+ * Widget id, if not specified one will be generated. Also used for lookups through Widget.getById
364
+ */
365
+ id? : string
366
+ /**
367
+ * Determines if the widgets read-only state should be controlled by its parent.
368
+ * ...
369
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-ignoreParentReadOnly)
370
+ */
371
+ ignoreParentReadOnly? : boolean
372
+ /**
373
+ * Convenience setting to align input fields of child widgets. By default, the Field input element is
374
+ * placed immediately following the `label`. If you prefer to have all input fields aligned to the
375
+ * right, set this config to `'end'`.
376
+ * ...
377
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-inputFieldAlign)
378
+ */
379
+ inputFieldAlign? : 'start'|'end'
380
+ /**
381
+ * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/gantt/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
382
+ */
383
+ insertBefore? : HTMLElement|string
384
+ /**
385
+ * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/gantt/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
386
+ */
387
+ insertFirst? : HTMLElement|string
388
+ /**
389
+ * See [Keyboard shortcuts](https://bryntum.com/products/gantt/docs/api/Grid/view/Grid#keyboard-shortcuts) for details
390
+ */
391
+ keyMap? : Record<string, KeyMapConfig>
392
+ /**
393
+ * Convenience setting to use same label placement on all child widgets.
394
+ * ...
395
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-labelPosition)
396
+ */
397
+ labelPosition? : 'before'|'above'|'align-before'|'auto'|null
398
+ /**
399
+ * The listener set for this object.
400
+ * ...
401
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-listeners)
402
+ */
403
+ listeners? : AssignmentGridListeners
404
+ /**
405
+ * A [Mask](https://bryntum.com/products/gantt/docs/api/Core/widget/Mask) config object, or a message to be shown when a store is performing a remote
406
+ * operation, or Crud Manager is loading data from the sever. Set to `null` to disable default load mask.
407
+ */
408
+ loadMask? : string|MaskConfig|null
409
+ /**
410
+ * A [Mask](https://bryntum.com/products/gantt/docs/api/Core/widget/Mask) config object to adjust the [maskDefaults](#Core/widget/Widget#config-maskDefaults)
411
+ * when data is loading. The message and optional configuration from the
412
+ * [loadMask](https://bryntum.com/products/gantt/docs/api/Core/mixin/LoadMaskable#config-loadMask) config take priority over these options, just as they do
413
+ * for `maskDefaults`, respectively.
414
+ * ...
415
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-loadMaskDefaults)
416
+ */
417
+ loadMaskDefaults? : MaskConfig
418
+ /**
419
+ * A [Mask](https://bryntum.com/products/gantt/docs/api/Core/widget/Mask) config object to adjust the [maskDefaults](#Core/widget/Widget#config-maskDefaults)
420
+ * when an error occurs loading data.
421
+ * ...
422
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-loadMaskError)
423
+ */
424
+ loadMaskError? : MaskConfig|Mask|boolean
425
+ /**
426
+ * Set to `false` to disable localization of this object.
427
+ */
428
+ localizable? : boolean
429
+ /**
430
+ * Time in ms until a longpress is triggered
431
+ */
432
+ longPressTime? : number
433
+ /**
434
+ * Widget's margin. This may be configured as a single number or a `TRBL` format string.
435
+ * numeric-only values are interpreted as pixels.
436
+ */
437
+ margin? : number|string
438
+ /**
439
+ * Grids change the `maskDefaults` to cover only their `body` element.
440
+ */
441
+ maskDefaults? : MaskConfig
442
+ /**
443
+ * Set to `true` to apply the default mask to the widget. Alternatively, this can be the mask message or a
444
+ * [Mask](https://bryntum.com/products/gantt/docs/api/Core/widget/Mask) config object.
445
+ */
446
+ masked? : boolean|string|MaskConfig
447
+ /**
448
+ * The element's maxHeight. Can be either a String or a Number (which will have 'px' appended). Note that
449
+ * like [height](https://bryntum.com/products/gantt/docs/api/Core/widget/Widget#config-height), *reading* the value will return the numeric value in pixels.
450
+ */
451
+ maxHeight? : string|number
452
+ /**
453
+ * The elements maxWidth. Can be either a String or a Number (which will have 'px' appended). Note that
454
+ * like [width](https://bryntum.com/products/gantt/docs/api/Core/widget/Widget#config-width), *reading* the value will return the numeric value in pixels.
455
+ */
456
+ maxWidth? : string|number
457
+ /**
458
+ * Grid's `min-height`. Defaults to `10em` to be sure that the Grid always has a height wherever it is
459
+ * inserted.
460
+ * ...
461
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-minHeight)
462
+ */
463
+ minHeight? : string|number
464
+ /**
465
+ * The elements minWidth. Can be either a String or a Number (which will have 'px' appended). Note that
466
+ * like [width](https://bryntum.com/products/gantt/docs/api/Core/widget/Widget#config-width), *reading* the value will return the numeric value in pixels.
467
+ */
468
+ minWidth? : string|number
469
+ /**
470
+ * Grid monitors window resize by default.
471
+ */
472
+ monitorResize? : boolean
473
+ /**
474
+ * The owning Widget of this Widget. If this Widget is directly contained (that is, it is one of the
475
+ * [items](https://bryntum.com/products/gantt/docs/api/Core/widget/Container#property-items) of a Container), this config will be ignored. In this case
476
+ * the owner is <strong>always</strong> the encapsulating Container.
477
+ * ...
478
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-owner)
479
+ */
480
+ owner? : Widget|any
481
+ /**
482
+ * Specify plugins (an array of classes) in config
483
+ */
484
+ plugins? : Function[]
485
+ /**
486
+ * True to preserve focused cell after loading new data
487
+ */
488
+ preserveFocusOnDatasetChange? : boolean
489
+ /**
490
+ * Preserve the grid's vertical scroll position when changesets are applied, as in the case of remote
491
+ * changes, or when stores are configured with [syncDataOnLoad](https://bryntum.com/products/gantt/docs/api/Core/data/Store#config-syncDataOnLoad).
492
+ */
493
+ preserveScroll? : PreserveScrollOptions|boolean
494
+ /**
495
+ * Specify `true` to preserve vertical scroll position after store actions that trigger a `refresh` event,
496
+ * such as loading new data and filtering.
497
+ */
498
+ preserveScrollOnDatasetChange? : boolean
499
+ /**
500
+ * Prevent tooltip from being displayed on touch devices. Useful for example for buttons that display a
501
+ * menu on click etc, since the tooltip would be displayed at the same time.
502
+ */
503
+ preventTooltipOnTouch? : boolean
504
+ /**
505
+ * Event model to manipulate assignments of, the task should be part of a task store.
506
+ * Either task or [store](https://bryntum.com/products/gantt/docs/api/Grid/view/Grid#config-store) should be given.
507
+ */
508
+ projectEvent? : TaskModel
509
+ /**
510
+ * Set to `true` to make the grid read-only, by disabling any UIs for modifying data.
511
+ * ...
512
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-readOnly)
513
+ */
514
+ readOnly? : boolean
515
+ relayStoreEvents? : boolean
516
+ /**
517
+ * Either a default `rendition` to apply to all child widgets, or a map of renditions keyed by child widget
518
+ * `type`.
519
+ * ...
520
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-rendition)
521
+ */
522
+ rendition? : string|Record<string, string>|null
523
+ /**
524
+ * Configure this property to allow the widget/component to be resized. Pressing <kbd>Shift</kbd> while resizing will
525
+ * constrain the aspect ratio.
526
+ * ...
527
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-resizable)
528
+ */
529
+ resizable? : boolean|{
530
+ minWidth?: number
531
+ maxWidth?: number
532
+ minHeight?: number
533
+ maxHeight?: number
534
+ handles?: object
535
+ }
536
+ /**
537
+ * Set to `false` to only measure cell contents when double-clicking the edge between column headers.
538
+ */
539
+ resizeToFitIncludesHeader? : boolean
540
+ /**
541
+ * A [Column](https://bryntum.com/products/gantt/docs/api/Grid/column/Column) config object for the resource column. You can pass a `renderer` which
542
+ * gives you access to the `resource` record.
543
+ */
544
+ resourceColumn? : ResourceAssignmentColumnConfig
545
+ /**
546
+ * "Break points" for which responsive config to use for columns and css.
547
+ * ...
548
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-responsiveLevels)
549
+ */
550
+ responsiveLevels? : Record<string, number|string|ResponsiveLevelConfig>
551
+ /**
552
+ * Configure as `true` to have the component display a translucent ripple when its
553
+ * [focusElement](https://bryntum.com/products/gantt/docs/api/Core/widget/Widget#property-focusElement), or [element](#Core/widget/Widget#property-element) is tapped <em>if the
554
+ * current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
555
+ * ...
556
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-ripple)
557
+ */
558
+ ripple? : boolean|{
559
+ delegate?: string
560
+ color?: string
561
+ radius?: number
562
+ clip?: string
563
+ }
564
+ /**
565
+ * 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`
566
+ */
567
+ rootElement? : ShadowRoot|HTMLElement
568
+ /**
569
+ * Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
570
+ * overriden by specifying a [rowHeight](https://bryntum.com/products/gantt/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
571
+ * a column [renderer](https://bryntum.com/products/gantt/docs/api/Grid/column/Column#config-renderer).
572
+ * ...
573
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-rowHeight)
574
+ */
575
+ rowHeight? : number
576
+ /**
577
+ * Set to `false` to not show row lines. End result might be overruled by/differ between themes.
578
+ */
579
+ rowLines? : boolean
580
+ /**
581
+ * This may be configured as `true` to make the widget's element use the `direction:rtl` style.
582
+ * ...
583
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-rtl)
584
+ */
585
+ rtl? : boolean
586
+ /**
587
+ * Configures whether the grid is scrollable in the `Y` axis. This is used to configure a [Scroller](https://bryntum.com/products/gantt/docs/api/Core/helper/util/Scroller).
588
+ * See the [scrollerClass](https://bryntum.com/products/gantt/docs/api/Grid/view/GridBase#config-scrollerClass) config option.
589
+ * ...
590
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-scrollable)
591
+ */
592
+ scrollable? : boolean|ScrollerConfig|Scroller
593
+ /**
594
+ * The class to instantiate to use as the [scrollable](https://bryntum.com/products/gantt/docs/api/Grid/view/GridBase#config-scrollable). Defaults to [Scroller](#Core/helper/util/Scroller).
595
+ */
596
+ scrollerClass? : typeof Scroller
597
+ /**
598
+ * Configuration values for the [ScrollManager](https://bryntum.com/products/gantt/docs/api/Core/util/ScrollManager) class on initialization. Returns the
599
+ * [ScrollManager](https://bryntum.com/products/gantt/docs/api/Core/util/ScrollManager) at runtime.
600
+ */
601
+ scrollManager? : ScrollManagerConfig|ScrollManager
602
+ /**
603
+ * Selection configuration settings, change these properties to control how selection works and what can be
604
+ * selected.
605
+ * ...
606
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-selectionMode)
607
+ */
608
+ selectionMode? : GridSelectionMode
609
+ /**
610
+ * Configure as `true` to have the grid show a red "changed" tag in cells whose
611
+ * field value has changed and not yet been committed.
612
+ * ...
613
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-showDirty)
614
+ */
615
+ showDirty? : boolean|{
616
+ duringEdit?: boolean
617
+ newRecord?: boolean
618
+ }
619
+ /**
620
+ * Programmatic control over how many columns to span when used in a grid layout.
621
+ */
622
+ span? : number
623
+ /**
624
+ * This value can be one of the following:
625
+ * ...
626
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-stateful)
627
+ */
628
+ stateful? : boolean|object|string[]
629
+ /**
630
+ * The events that, when fired by this component, should trigger it to save its state by calling
631
+ * [saveState](https://bryntum.com/products/gantt/docs/api/Core/mixin/State#function-saveState).
632
+ * ...
633
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-statefulEvents)
634
+ */
635
+ statefulEvents? : object|string[]
636
+ /**
637
+ * The key to use when saving this object's state in the [stateProvider](https://bryntum.com/products/gantt/docs/api/Core/mixin/State#config-stateProvider). If this config is
638
+ * not assigned, and [stateful](https://bryntum.com/products/gantt/docs/api/Core/mixin/State#config-stateful) is not set to `false`, the [id](#Core/widget/Widget#config-id)
639
+ * (if explicitly specified) will be used as the `stateId`.
640
+ * ...
641
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-stateId)
642
+ */
643
+ stateId? : string
644
+ /**
645
+ * The `StateProvider` to use to save and restore this object's [state](https://bryntum.com/products/gantt/docs/api/Core/mixin/State#property-state). By default, `state`
646
+ * will be saved using the [default state provider](https://bryntum.com/products/gantt/docs/api/Core/state/StateProvider#property-instance-static).
647
+ * ...
648
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-stateProvider)
649
+ */
650
+ stateProvider? : StateProvider
651
+ /**
652
+ * The properties of this settings object controls how grid is restored from state data.
653
+ * ...
654
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-stateSettings)
655
+ */
656
+ stateSettings? : {
657
+ restoreUnconfiguredColumns?: boolean
658
+ }
659
+ /**
660
+ * Store that holds records to display in the grid, or a store config object. If the configuration contains
661
+ * a `readUrl`, an `AjaxStore` will be created.
662
+ * ...
663
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-store)
664
+ */
665
+ store? : Store|StoreConfig|AjaxStore|AjaxStoreConfig
666
+ /**
667
+ * An object containing widgets keyed by name. By default (when no `type` is given), strips are
668
+ * [toolbars](https://bryntum.com/products/gantt/docs/api/Core/widget/Toolbar). If you want to pass an array, you can use
669
+ * the toolbar's [items](https://bryntum.com/products/gantt/docs/api/Core/widget/Container#config-items).
670
+ * ...
671
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-strips)
672
+ */
673
+ strips? : Record<string, GanttContainerItemConfig>
674
+ /**
675
+ * An object containing sub grid configuration objects keyed by a `region` property.
676
+ * By default, grid has a 'locked' region (if configured with locked columns) and a 'normal' region.
677
+ * The 'normal' region defaults to use `flex: 1`.
678
+ * ...
679
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-subGridConfigs)
680
+ */
681
+ subGridConfigs? : Record<string, SubGridConfig>
682
+ /**
683
+ * A [Mask](https://bryntum.com/products/gantt/docs/api/Core/widget/Mask) config object, or a message to be shown when Crud Manager
684
+ * is persisting changes on the server. Set to `null` to disable default sync mask.
685
+ * ...
686
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-syncMask)
687
+ */
688
+ syncMask? : string|MaskConfig|null
689
+ /**
690
+ * A configuration for the [tab](https://bryntum.com/products/gantt/docs/api/Core/widget/Tab) created for this widget when it is placed in a
691
+ * [TabPanel](https://bryntum.com/products/gantt/docs/api/Core/widget/TabPanel). For example, this config can be used to control the icon of the `tab` for
692
+ * this widget:
693
+ * ...
694
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-tab)
695
+ */
696
+ tab? : boolean|TabConfig
697
+ /**
698
+ * When this container is used as a tab in a TabPanel, these items are added to the
699
+ * [TabBar](https://bryntum.com/products/gantt/docs/api/Core/widget/TabBar) when this container is the active tab.
700
+ * ...
701
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-tabBarItems)
702
+ */
703
+ tabBarItems? : ToolbarItems[]|Widget[]
704
+ /**
705
+ * A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/gantt/docs/api/Core/widget/Toolbar),
706
+ * or array of config objects representing the child items of a Toolbar.
707
+ * This creates a toolbar docked to the top of the panel immediately below the header.
708
+ * ...
709
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-tbar)
710
+ */
711
+ tbar? : (GanttContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
712
+ /**
713
+ * A title to display in the header or owning TabPanel. Causes creation and docking of a header
714
+ * to the top if no header is configured.
715
+ * ...
716
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-title)
717
+ */
718
+ title? : string
719
+ /**
720
+ * The [tools](https://bryntum.com/products/gantt/docs/api/Core/widget/Tool) to add either before or after the `title` in the Panel header. Each
721
+ * property name is the reference by which an instantiated tool may be retrieved from the live
722
+ * `[tools](https://bryntum.com/products/gantt/docs/api/Core/widget/mixin/Toolable#property-tools)` property.
723
+ * ...
724
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-tools)
725
+ */
726
+ tools? : Record<string, ToolConfig>|null
727
+ /**
728
+ * Configure UI transitions for various actions in the grid.
729
+ */
730
+ transition? : {
731
+ insertRecord?: boolean
732
+ removeRecord?: boolean
733
+ toggleColumn?: boolean
734
+ expandCollapseColumn?: boolean
735
+ toggleRegion?: boolean
736
+ toggleTreeNode?: boolean
737
+ toggleGroup?: boolean
738
+ filterRemoval?: boolean
739
+ }
740
+ /**
741
+ * Animation transition duration in milliseconds.
742
+ */
743
+ transitionDuration? : number
744
+ type? : 'assignmentgrid'
745
+ /**
746
+ * Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
747
+ * as a space separated string, an array of strings, or as an object in which property names with truthy
748
+ * values are used as the class names.
749
+ * ...
750
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#config-ui)
751
+ */
752
+ ui? : 'plain'|'toolbar'|string|object
753
+ /**
754
+ * A config object for the units column
755
+ */
756
+ unitsColumn? : NumberColumnConfig
757
+ /**
758
+ * A widgets weight determines its position among siblings when added to a [Container](https://bryntum.com/products/gantt/docs/api/Core/widget/Container).
759
+ * Higher weights go further down.
760
+ */
761
+ weight? : number
762
+ /**
763
+ * Widget's width, used to set element `style.width`. Either specify a valid width string or a number, which
764
+ * will get 'px' appended. We recommend using CSS as the primary way to control width, but in some cases
765
+ * this config is convenient.
766
+ */
767
+ width? : string|number
768
+
769
+ // Events
770
+ /**
771
+ * Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
772
+ * @param {object} event Event object
773
+ * @param {Grid.view.Grid} event.source Owner grid
774
+ * @param {Grid.util.GridLocation} event.editorContext Editing context
775
+ */
776
+ onBeforeCancelCellEdit? : ((event: { source: Grid, editorContext: GridLocation }) => Promise<boolean>|boolean|void)|string
777
+ /**
778
+ * 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.
779
+ * ...
780
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#event-beforeCancelRowEdit)
781
+ * @param {object} event Event object
782
+ * @param {Grid.view.Grid} event.grid Target grid
783
+ * @param {RowEditorContext} event.editorContext Editing context
784
+ */
785
+ onBeforeCancelRowEdit? : ((event: { grid: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string
786
+ /**
787
+ * Fires on the owning Grid before editing starts, return `false` to prevent editing
788
+ * @param {object} event Event object
789
+ * @param {Grid.view.Grid} event.source Owner grid
790
+ * @param {CellEditorContext} event.editorContext Editing context
791
+ */
792
+ onBeforeCellEditStart? : ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
793
+ /**
794
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
795
+ * buttons while [autoEdit](https://bryntum.com/products/gantt/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
796
+ * @param {object} event Event object
797
+ * @param {Grid.view.Grid} event.source Owner grid
798
+ * @param {(Grid.util.GridLocation|Core.data.Model)[]} event.gridSelection An array of cell selectors or records that will have their values deleted (the records themselves will not get deleted, only visible column values).
799
+ */
800
+ onBeforeCellRangeDelete? : ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => Promise<boolean>|boolean|void)|string
801
+ /**
802
+ * Fires for each selected record on the owning Grid before editing a range of selected cell values
803
+ * @param {object} event Event object
804
+ * @param {Core.data.Model} event.record Current selected record from the range
805
+ * @param {string} event.field The field being changed
806
+ * @param {any} event.value The value being set
807
+ */
808
+ onBeforeCellRangeEdit? : ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
809
+ /**
810
+ * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
811
+ * @param {object} event Event object
812
+ * @param {Grid.view.Grid} event.source The grid instance.
813
+ * @param {Grid.column.Column} event.column The dragged column.
814
+ * @param {Event} event.event The browser event.
815
+ */
816
+ onBeforeColumnDragStart? : ((event: { source: Grid, column: Column, event: Event }) => Promise<boolean>|boolean|void)|string
817
+ /**
818
+ * This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
819
+ * @param {object} event Event object
820
+ * @param {Grid.view.Grid} event.source The grid instance.
821
+ * @param {Grid.column.Column} event.column The dragged column.
822
+ * @param {Grid.column.Column} event.insertBefore The column before which the dragged column will be inserted.
823
+ * @param {Grid.column.Column} event.newParent The new parent column.
824
+ * @param {Event} event.event The browser event.
825
+ * @param {string} event.region The region where the column was dropped.
826
+ */
827
+ onBeforeColumnDropFinalize? : ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => Promise<boolean>|boolean|void)|string
828
+ /**
829
+ * This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
830
+ * `false`.
831
+ * @param {object} event Event object
832
+ * @param {Grid.view.Grid} event.source The grid instance
833
+ * @param {Grid.column.Column} event.column The column
834
+ * @param {Event} event.domEvent The browser event
835
+ */
836
+ onBeforeColumnResize? : ((event: { source: Grid, column: Column, domEvent: Event }) => Promise<boolean>|boolean|void)|string
837
+ /**
838
+ * Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
839
+ * @param {object} event Event object
840
+ * @param {Grid.view.Grid} event.source Owner grid
841
+ * @param {Grid.util.GridLocation[]} event.cells The cells about to be copied or cut
842
+ * @param {string} event.data The string data about to be copied or cut
843
+ * @param {boolean} event.isCut `true` if this is a cut action
844
+ * @param {string} event.entityName 'cell' to distinguish this event from other beforeCopy events
845
+ */
846
+ onBeforeCopy? : ((event: { source: Grid, cells: GridLocation[], data: string, isCut: boolean, entityName: string }) => Promise<boolean>|boolean|void)|string
847
+ /**
848
+ * Fires on the owning Grid before CSV export starts. Return `false` to cancel the export.
849
+ * @param {object} event Event object
850
+ * @param {ExportConfig} event.config Export config
851
+ * @param {Grid.column.Column[]} event.columns An array of columns to export
852
+ * @param {Core.data.Model[]} event.rows An array of records to export
853
+ * @param {string} event.lineDelimiter The CSV delimiter to separate lines
854
+ * @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
855
+ */
856
+ onBeforeCSVExport? : ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => Promise<boolean>|boolean|void)|string
857
+ /**
858
+ * Fires before an object is destroyed.
859
+ * @param {object} event Event object
860
+ * @param {Core.Base} event.source The Object that is being destroyed.
861
+ */
862
+ onBeforeDestroy? : ((event: { source: Base }) => void)|string
863
+ /**
864
+ * Fires on the owning Grid before Excel export starts. Return `false` to cancel the export.
865
+ * @param {object} event Event object
866
+ * @param {ExportConfig} event.config Export config
867
+ * @param {XLSColumn[]} event.columns An array of columns to export
868
+ * @param {any[][]} event.rows An array of records to export
869
+ */
870
+ onBeforeExcelExport? : ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => Promise<boolean>|boolean|void)|string
871
+ /**
872
+ * Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
873
+ * @param {object} event Event object
874
+ * @param {Grid.util.GridLocation} event.cell Information about the column / record
875
+ * @param {MouseEvent} event.domEvent The raw DOM event
876
+ */
877
+ onBeforeFillHandleDragStart? : ((event: { cell: GridLocation, domEvent: MouseEvent }) => Promise<boolean>|boolean|void)|string
878
+ /**
879
+ * 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.
880
+ * @param {object} event Event object
881
+ * @param {Grid.view.Grid} event.grid Target grid
882
+ * @param {CellEditorContext} event.editorContext Editing context
883
+ */
884
+ onBeforeFinishCellEdit? : ((event: { grid: Grid, editorContext: CellEditorContext }) => void)|string
885
+ /**
886
+ * 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.
887
+ * ...
888
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#event-beforeFinishRowEdit)
889
+ * @param {object} event Event object
890
+ * @param {Grid.view.Grid} event.grid Target grid
891
+ * @param {RowEditorContext} event.editorContext Editing context
892
+ */
893
+ onBeforeFinishRowEdit? : ((event: { grid: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string
894
+ /**
895
+ * Triggered before a widget is hidden. Return `false` to prevent the action.
896
+ * @param {object} event Event object
897
+ * @param {Core.widget.Widget} event.source The widget being hidden.
898
+ */
899
+ onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
900
+ /**
901
+ * Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
902
+ * @param {object} event Event object
903
+ * @param {Grid.view.Grid} event.source Owner grid
904
+ * @param {string} event.clipboardData The clipboardData about to be pasted
905
+ * @param {Grid.util.GridLocation} event.targetCell The cell from which the paste will be started
906
+ * @param {string} event.entityName 'cell' to distinguish this event from other beforePaste events
907
+ * @param {string} event.text The raw text from clipboard
908
+ */
909
+ onBeforePaste? : ((event: { source: Grid, clipboardData: string, targetCell: GridLocation, entityName: string, text: string }) => Promise<boolean>|boolean|void)|string
910
+ /**
911
+ * Fires on the owning Grid before export started. Return `false` to cancel the export.
912
+ * @param {object} event Event object
913
+ * @param {object} event.config Export config
914
+ */
915
+ onBeforePdfExport? : ((event: { config: object }) => Promise<boolean>|boolean|void)|string
916
+ /**
917
+ * Fires before a row is rendered.
918
+ * @param {object} event Event object
919
+ * @param {Grid.view.Grid} event.source The firing Grid instance.
920
+ * @param {Grid.row.Row} event.row The row about to be rendered.
921
+ * @param {Core.data.Model} event.record The record for the row.
922
+ * @param {number} event.recordIndex The zero-based index of the record.
923
+ */
924
+ onBeforeRenderRow? : ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
925
+ /**
926
+ * Grid rows are about to be rendered
927
+ * @param {object} event Event object
928
+ * @param {Grid.view.Grid} event.source This grid.
929
+ */
930
+ onBeforeRenderRows? : ((event: { source: Grid }) => void)|string
931
+ /**
932
+ * This event fires before row collapse is started.
933
+ * ...
934
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#event-beforeRowCollapse)
935
+ * @param {object} event Event object
936
+ * @param {Core.data.Model} event.record Record
937
+ */
938
+ onBeforeRowCollapse? : ((event: { record: Model }) => Promise<boolean>|boolean|void)|string
939
+ /**
940
+ * This event fires before row expand is started.
941
+ * ...
942
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#event-beforeRowExpand)
943
+ * @param {object} event Event object
944
+ * @param {Core.data.Model} event.record Record
945
+ */
946
+ onBeforeRowExpand? : ((event: { record: Model }) => Promise<boolean>|boolean|void)|string
947
+ /**
948
+ * Fires before the selection changes. Returning `false` from a listener prevents the change
949
+ * @param {object} event Event object
950
+ * @param {string} event.action `'select'`/`'deselect'`
951
+ * @param {'row','cell'} event.mode `'row'`/`'cell'`
952
+ * @param {Grid.view.Grid} event.source
953
+ * @param {Core.data.Model[]} event.deselected The records to be deselected in this operation.
954
+ * @param {Core.data.Model[]} event.selected The records to be selected in this operation.
955
+ * @param {Core.data.Model[]} event.selection The records in the current selection, before applying `selected` and `deselected`
956
+ * @param {Grid.util.GridLocation[]} event.deselectedCells The cells to be deselected in this operation.
957
+ * @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
958
+ * @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
959
+ */
960
+ onBeforeSelectionChange? : ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => Promise<boolean>|boolean|void)|string
961
+ /**
962
+ * Fired before this container will load record values into its child fields. This is useful if you
963
+ * want to modify the UI before data is loaded (e.g. set some input field to be readonly)
964
+ * @param {object} event Event object
965
+ * @param {Core.widget.Container} event.source The container
966
+ * @param {Core.data.Model} event.record The record
967
+ */
968
+ onBeforeSetRecord? : ((event: { source: Container, record: Model }) => void)|string
969
+ /**
970
+ * Triggered before a widget is shown. Return `false` to prevent the action.
971
+ * @param {object} event Event object
972
+ * @param {Core.widget.Widget,any} event.source The widget being shown
973
+ */
974
+ onBeforeShow? : ((event: { source: Widget|any }) => Promise<boolean>|boolean|void)|string
975
+ /**
976
+ * Fires on the owning Grid before editing starts, return `false` to prevent editing
977
+ * @param {object} event Event object
978
+ * @param {Grid.view.Grid} event.source Owner grid
979
+ * @param {RowEditorContext} event.editorContext Editing context
980
+ */
981
+ onBeforeStartRowEdit? : ((event: { source: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string
982
+ /**
983
+ * Fired before state is applied to the source. Allows editing the state object or preventing the operation.
984
+ * @param {object} event Event object
985
+ * @param {GridStateInfo} event.state State object config
986
+ */
987
+ onBeforeStateApply? : ((event: { state: GridStateInfo }) => Promise<boolean>|boolean|void)|string
988
+ /**
989
+ * Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
990
+ * @param {object} event Event object
991
+ * @param {GridStateInfo} event.state State object config
992
+ */
993
+ onBeforeStateSave? : ((event: { state: GridStateInfo }) => Promise<boolean>|boolean|void)|string
994
+ /**
995
+ * Fired when a group is going to be expanded or collapsed using the UI.
996
+ * Returning `false` from a listener prevents the operation
997
+ * @param {object} event Event object
998
+ * @param {Core.data.Model} event.groupRecord [DEPRECATED] Use `groupRecords` param instead
999
+ * @param {Core.data.Model[]} event.groupRecords The group records being toggled
1000
+ * @param {boolean} event.collapse Collapsed (true) or expanded (false)
1001
+ * @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
1002
+ */
1003
+ onBeforeToggleGroup? : ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => Promise<boolean>|boolean|void)|string
1004
+ /**
1005
+ * Fired before a parent node record toggles its collapsed state.
1006
+ * @param {object} event Event object
1007
+ * @param {Grid.view.Grid} event.source The firing Grid instance.
1008
+ * @param {Core.data.Model} event.record The record being toggled.
1009
+ * @param {boolean} event.collapse `true` if the node is being collapsed.
1010
+ */
1011
+ onBeforeToggleNode? : ((event: { source: Grid, record: Model, collapse: boolean }) => void)|string
1012
+ /**
1013
+ * Fires on the owning Grid when editing is cancelled
1014
+ * @param {object} event Event object
1015
+ * @param {Grid.view.Grid} event.source Owner grid
1016
+ * @param {Grid.util.GridLocation} event.editorContext Editing context
1017
+ * @param {Event} event.event Included if the cancellation was triggered by a DOM event
1018
+ */
1019
+ onCancelCellEdit? : ((event: { source: Grid, editorContext: GridLocation, event: Event }) => void)|string
1020
+ /**
1021
+ * Fires when any other event is fired from the object.
1022
+ * ...
1023
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#event-catchAll)
1024
+ * @param {object} event Event object
1025
+ * @param {{[key: string]: any, type: string}} event.event The Object that contains event details
1026
+ * @param {string} event.event.type The type of the event which is caught by the listener
1027
+ */
1028
+ onCatchAll? : ((event: {[key: string]: any, type: string}) => void)|string
1029
+ /**
1030
+ * Fired when user clicks in a grid cell
1031
+ * @param {object} event Event object
1032
+ * @param {Grid.view.Grid} event.grid The grid instance
1033
+ * @param {Core.data.Model} event.record The record representing the row
1034
+ * @param {Grid.column.Column} event.column The column to which the cell belongs
1035
+ * @param {HTMLElement} event.cellElement The cell HTML element
1036
+ * @param {HTMLElement} event.target The target element
1037
+ * @param {MouseEvent} event.event The native DOM event
1038
+ */
1039
+ onCellClick? : ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string
1040
+ /**
1041
+ * Fired when user activates contextmenu in a grid cell
1042
+ * @param {object} event Event object
1043
+ * @param {Grid.view.Grid} event.grid The grid instance
1044
+ * @param {Core.data.Model} event.record The record representing the row
1045
+ * @param {Grid.column.Column} event.column The column to which the cell belongs
1046
+ * @param {HTMLElement} event.cellElement The cell HTML element
1047
+ * @param {HTMLElement} event.target The target element
1048
+ * @param {MouseEvent} event.event The native DOM event
1049
+ */
1050
+ onCellContextMenu? : ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string
1051
+ /**
1052
+ * Fired when user double clicks a grid cell
1053
+ * @param {object} event Event object
1054
+ * @param {Grid.view.Grid} event.grid The grid instance
1055
+ * @param {Core.data.Model} event.record The record representing the row
1056
+ * @param {Grid.column.Column} event.column The column to which the cell belongs
1057
+ * @param {HTMLElement} event.cellElement The cell HTML element
1058
+ * @param {HTMLElement} event.target The target element
1059
+ * @param {MouseEvent} event.event The native DOM event
1060
+ */
1061
+ onCellDblClick? : ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string
1062
+ /**
1063
+ * This event fires on the owning grid before the context menu is shown for a cell.
1064
+ * Allows manipulation of the items to show in the same way as in the [processItems](https://bryntum.com/products/gantt/docs/api/Grid/feature/CellMenu#config-processItems).
1065
+ * ...
1066
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#event-cellMenuBeforeShow)
1067
+ * @param {object} event Event object
1068
+ * @param {Grid.view.Grid} event.source The grid
1069
+ * @param {Core.widget.Menu} event.menu The menu
1070
+ * @param {Record<string, MenuItemEntry>} event.items Menu item configs
1071
+ * @param {Grid.column.Column} event.column Column
1072
+ * @param {Core.data.Model} event.record Record
1073
+ */
1074
+ onCellMenuBeforeShow? : ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => Promise<boolean>|boolean|void)|string
1075
+ /**
1076
+ * This event fires on the owning grid when an item is selected in the cell context menu.
1077
+ * @param {object} event Event object
1078
+ * @param {Grid.view.Grid} event.source The grid
1079
+ * @param {Core.widget.Menu} event.menu The menu
1080
+ * @param {Core.widget.MenuItem} event.item Selected menu item
1081
+ * @param {Grid.column.Column} event.column Column
1082
+ * @param {Core.data.Model} event.record Record
1083
+ */
1084
+ onCellMenuItem? : ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column, record: Model }) => void)|string
1085
+ /**
1086
+ * This event fires on the owning grid after the context menu is shown for a cell.
1087
+ * @param {object} event Event object
1088
+ * @param {Grid.view.Grid} event.source The grid
1089
+ * @param {Core.widget.Menu} event.menu The menu
1090
+ * @param {Record<string, MenuItemEntry>} event.items Menu item configs
1091
+ * @param {Grid.column.Column} event.column Column
1092
+ * @param {Core.data.Model} event.record Record
1093
+ */
1094
+ onCellMenuShow? : ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => void)|string
1095
+ /**
1096
+ * This event fires on the owning grid when a check item is toggled in the cell context menu.
1097
+ * @param {object} event Event object
1098
+ * @param {Grid.view.Grid} event.source The grid
1099
+ * @param {Core.widget.Menu} event.menu The menu
1100
+ * @param {Core.widget.MenuItem} event.item Selected menu item
1101
+ * @param {Grid.column.Column} event.column Column
1102
+ * @param {Core.data.Model} event.record Record
1103
+ * @param {boolean} event.checked Checked or not
1104
+ */
1105
+ onCellMenuToggleItem? : ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column, record: Model, checked: boolean }) => void)|string
1106
+ /**
1107
+ * Fired when the mouse enters a cell
1108
+ * @param {object} event Event object
1109
+ * @param {Grid.view.Grid} event.source The grid instance
1110
+ * @param {Core.data.Model} event.record The record representing the hovered cell
1111
+ * @param {Grid.column.Column} event.column The column currently hovered
1112
+ * @param {HTMLElement} event.cellElement The cell HTML element
1113
+ * @param {MouseEvent} event.event The native DOM event
1114
+ */
1115
+ onCellMouseEnter? : ((event: { source: Grid, record: Model, column: Column, cellElement: HTMLElement, event: MouseEvent }) => void)|string
1116
+ /**
1117
+ * Fired when the mouse leaves a cell
1118
+ * @param {object} event Event object
1119
+ * @param {Grid.view.Grid} event.source The grid instance
1120
+ * @param {Core.data.Model} event.record The record representing the cell that the mouse left
1121
+ * @param {Grid.column.Column} event.column The column representing the cell that the mouse left
1122
+ * @param {HTMLElement} event.cellElement The cell HTML element that the mouse left
1123
+ * @param {MouseEvent} event.event The native DOM event
1124
+ */
1125
+ onCellMouseLeave? : ((event: { source: Grid, record: Model, column: Column, cellElement: HTMLElement, event: MouseEvent }) => void)|string
1126
+ /**
1127
+ * Fired when a user moves the mouse out of a grid cell
1128
+ * @param {object} event Event object
1129
+ * @param {Grid.view.Grid} event.grid The grid instance
1130
+ * @param {Core.data.Model} event.record The record representing the row
1131
+ * @param {Grid.column.Column} event.column The column to which the cell belongs
1132
+ * @param {HTMLElement} event.cellElement The cell HTML element
1133
+ * @param {HTMLElement} event.target The target element
1134
+ * @param {MouseEvent} event.event The native DOM event
1135
+ */
1136
+ onCellMouseOut? : ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string
1137
+ /**
1138
+ * Fired when user moves the mouse over a grid cell
1139
+ * @param {object} event Event object
1140
+ * @param {Grid.view.Grid} event.grid The grid instance
1141
+ * @param {Core.data.Model} event.record The record representing the row
1142
+ * @param {Grid.column.Column} event.column The column to which the cell belongs
1143
+ * @param {HTMLElement} event.cellElement The cell HTML element
1144
+ * @param {HTMLElement} event.target The target element
1145
+ * @param {MouseEvent} event.event The native DOM event
1146
+ */
1147
+ onCellMouseOver? : ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string
1148
+ /**
1149
+ * Fires when a Panel is collapsed using the [collapsible](https://bryntum.com/products/gantt/docs/api/Core/widget/Panel#config-collapsible) setting.
1150
+ * @param {object} event Event object
1151
+ * @param {Core.widget.Panel} event.source This Panel.
1152
+ */
1153
+ onCollapse? : ((event: { source: Panel }) => void)|string
1154
+ /**
1155
+ * Fired before a parent node record is collapsed.
1156
+ * @param {object} event Event object
1157
+ * @param {Grid.view.Grid} event.source The firing Grid instance.
1158
+ * @param {Core.data.Model} event.record The record which has been collapsed.
1159
+ */
1160
+ onCollapseNode? : ((event: { source: Grid, record: Model }) => void)|string
1161
+ /**
1162
+ * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
1163
+ * to indicate whether the drop position is valid or not.
1164
+ * @param {object} event Event object
1165
+ * @param {Grid.view.Grid} event.source The grid instance.
1166
+ * @param {Grid.column.Column} event.column The dragged column.
1167
+ * @param {Grid.column.Column} event.insertBefore The column before which the dragged column will be inserted (if not last).
1168
+ * @param {Event} event.event The browser event.
1169
+ * @param {object} event.context
1170
+ * @param {boolean} event.context.valid Set this to `true` or `false` to indicate whether the drop position is valid.
1171
+ */
1172
+ onColumnDrag? : ((event: { source: Grid, column: Column, insertBefore: Column, event: Event, context: { valid: boolean } }) => void)|string
1173
+ /**
1174
+ * This event is fired when a column drag gesture has started.
1175
+ * @param {object} event Event object
1176
+ * @param {Grid.view.Grid} event.source The grid instance.
1177
+ * @param {Grid.column.Column} event.column The dragged column.
1178
+ * @param {Event} event.event The browser event.
1179
+ */
1180
+ onColumnDragStart? : ((event: { source: Grid, column: Column, event: Event }) => void)|string
1181
+ /**
1182
+ * This event is always fired after a column is dropped. The `valid` param is `true` if the operation was not
1183
+ * vetoed and the column was moved in the column store.
1184
+ * @param {object} event Event object
1185
+ * @param {Grid.view.Grid} event.source The grid instance.
1186
+ * @param {Grid.column.Column} event.column The dragged column.
1187
+ * @param {Grid.column.Column} event.insertBefore The column before which the dragged column will be inserted.
1188
+ * @param {Grid.column.Column} event.newParent The new parent column.
1189
+ * @param {boolean} event.valid `true` if the operation was not vetoed.
1190
+ * @param {Event} event.event The browser event.
1191
+ * @param {string} event.region The region where the column was dropped.
1192
+ */
1193
+ onColumnDrop? : ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => Promise<boolean>|boolean|void)|string
1194
+ /**
1195
+ * This event is fired after a resize gesture is completed.
1196
+ * @param {object} event Event object
1197
+ * @param {Grid.view.Grid} event.source The grid instance
1198
+ * @param {Grid.column.Column} event.column The resized column
1199
+ * @param {Event} event.domEvent The browser event
1200
+ */
1201
+ onColumnResize? : ((event: { source: Grid, column: Column, domEvent: Event }) => void)|string
1202
+ /**
1203
+ * This event is fired when a column resize gesture starts.
1204
+ * @param {object} event Event object
1205
+ * @param {Grid.view.Grid} event.source The grid instance
1206
+ * @param {Grid.column.Column} event.column The column
1207
+ * @param {Event} event.domEvent The browser event
1208
+ */
1209
+ onColumnResizeStart? : ((event: { source: Grid, column: Column, domEvent: Event }) => void)|string
1210
+ /**
1211
+ * This event fires on the owning widget when an item is selected in the context menu.
1212
+ * @param {object} event Event object
1213
+ * @param {Core.widget.Widget} event.source The owning widget
1214
+ * @param {Core.widget.Menu} event.menu The menu
1215
+ * @param {Core.widget.MenuItem} event.item Selected menu item
1216
+ */
1217
+ onContextMenuItem? : ((event: { source: Widget, menu: Menu, item: MenuItem }) => void)|string
1218
+ /**
1219
+ * This event fires on the owning widget when a check item is toggled in the context menu.
1220
+ * @param {object} event Event object
1221
+ * @param {Core.widget.Widget} event.source The owning widget
1222
+ * @param {Core.widget.Menu} event.menu The menu
1223
+ * @param {Core.widget.MenuItem} event.item Selected menu item
1224
+ * @param {boolean} event.checked Checked or not
1225
+ */
1226
+ onContextMenuToggleItem? : ((event: { source: Widget, menu: Menu, item: MenuItem, checked: boolean }) => void)|string
1227
+ /**
1228
+ * Fires on the owning Grid after a copy action is performed.
1229
+ * @param {object} event Event object
1230
+ * @param {Grid.view.Grid} event.source Owner grid
1231
+ * @param {Grid.util.GridLocation[]} event.cells The cells about to be copied or cut
1232
+ * @param {string} event.copiedDataString The concatenated data string that was copied or cut
1233
+ * @param {boolean} event.isCut `true` if this was a cut action
1234
+ * @param {string} event.entityName 'cell' to distinguish this event from other copy events
1235
+ */
1236
+ onCopy? : ((event: { source: Grid, cells: GridLocation[], copiedDataString: string, isCut: boolean, entityName: string }) => void)|string
1237
+ /**
1238
+ * Fired when data in the store changes.
1239
+ * ...
1240
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#event-dataChange)
1241
+ * @param {object} event Event object
1242
+ * @param {Grid.view.Grid} event.source Owning grid
1243
+ * @param {Core.data.Store} event.store The originating store
1244
+ * @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
1245
+ * @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
1246
+ * @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
1247
+ * @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
1248
+ */
1249
+ onDataChange? : ((event: { source: Grid, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
1250
+ /**
1251
+ * Fires when an object is destroyed.
1252
+ * @param {object} event Event object
1253
+ * @param {Core.Base} event.source The Object that is being destroyed.
1254
+ */
1255
+ onDestroy? : ((event: { source: Base }) => void)|string
1256
+ /**
1257
+ * Fires when a field is mutated and the state of the [hasChanges](https://bryntum.com/products/gantt/docs/api/Core/widget/Container#property-hasChanges) property changes
1258
+ * @param {object} event Event object
1259
+ * @param {Core.widget.Container} event.source The container.
1260
+ * @param {boolean} event.dirty The dirty state of the Container - `true` if there are any fields which have been changed since initial load.
1261
+ */
1262
+ onDirtyStateChange? : ((event: { source: Container, dirty: boolean }) => void)|string
1263
+ /**
1264
+ * Fires while drag selecting. UI will update with current range, but the cells will not be selected until
1265
+ * mouse up. This event can be listened for to perform actions while drag selecting.
1266
+ * @param {object} event Event object
1267
+ * @param {Grid.view.Grid} event.source
1268
+ * @param {GridLocationConfig[],Grid.util.GridLocation[]} event.selectedCells The cells that is currently being dragged over
1269
+ * @param {Core.data.Model[]} event.selectedRecords The records that is currently being dragged over
1270
+ */
1271
+ onDragSelecting? : ((event: { source: Grid, selectedCells: GridLocationConfig[]|GridLocation[], selectedRecords: Model[] }) => void)|string
1272
+ /**
1273
+ * Triggered when a widget's [element](https://bryntum.com/products/gantt/docs/api/Core/widget/Widget#property-element) is available.
1274
+ * @param {object} event Event object
1275
+ * @param {HTMLElement} event.element The Widget's element.
1276
+ */
1277
+ onElementCreated? : ((event: { element: HTMLElement }) => void)|string
1278
+ /**
1279
+ * Fires when a Panel is expanded using the [collapsible](https://bryntum.com/products/gantt/docs/api/Core/widget/Panel#config-collapsible) setting.
1280
+ * @param {object} event Event object
1281
+ * @param {Core.widget.Panel} event.source This Panel.
1282
+ */
1283
+ onExpand? : ((event: { source: Panel }) => void)|string
1284
+ /**
1285
+ * Fired after a parent node record is expanded.
1286
+ * @param {object} event Event object
1287
+ * @param {Grid.view.Grid} event.source The firing Grid instance.
1288
+ * @param {Core.data.Model} event.record The record which has been expanded.
1289
+ */
1290
+ onExpandNode? : ((event: { source: Grid, record: Model }) => void)|string
1291
+ /**
1292
+ * Fired when a file is dropped on the widget element
1293
+ * @param {object} event Event object
1294
+ * @param {Grid.view.Grid} event.source The owning Grid instance
1295
+ * @param {DataTransferItem} event.file The dropped file descriptor
1296
+ * @param {DragEvent} event.domEvent The native DragEvent
1297
+ */
1298
+ onFileDrop? : ((event: { source: Grid, file: DataTransferItem, domEvent: DragEvent }) => void)|string
1299
+ /**
1300
+ * Fired before the FillHandle dragging is finalized and values are applied to cells, return `false` to prevent the
1301
+ * drag operation from applying data changes.
1302
+ * @param {object} event Event object
1303
+ * @param {Grid.util.GridLocation} event.from The from cell
1304
+ * @param {Grid.util.GridLocation} event.to The to cell
1305
+ * @param {MouseEvent} event.domEvent The raw DOM event
1306
+ */
1307
+ onFillHandleBeforeDragFinalize? : ((event: { from: GridLocation, to: GridLocation, domEvent: MouseEvent }) => Promise<boolean>|boolean|void)|string
1308
+ /**
1309
+ * Fired while dragging the FillHandle.
1310
+ * @param {object} event Event object
1311
+ * @param {Grid.util.GridLocation} event.from The from cell
1312
+ * @param {Grid.util.GridLocation} event.to The to cell
1313
+ * @param {MouseEvent} event.domEvent The raw DOM event
1314
+ */
1315
+ onFillHandleDrag? : ((event: { from: GridLocation, to: GridLocation, domEvent: MouseEvent }) => void)|string
1316
+ /**
1317
+ * Fired when a FillHandle drag operation is aborted.
1318
+ */
1319
+ onFillHandleDragAbort? : (() => void)|string
1320
+ /**
1321
+ * Fired after a FillHandle drag operation.
1322
+ * @param {object} event Event object
1323
+ * @param {Grid.util.GridLocation} event.from The from cell
1324
+ * @param {Grid.util.GridLocation} event.to The to cell
1325
+ * @param {MouseEvent} event.domEvent The raw DOM event
1326
+ */
1327
+ onFillHandleDragEnd? : ((event: { from: GridLocation, to: GridLocation, domEvent: MouseEvent }) => void)|string
1328
+ /**
1329
+ * Fired when dragging of the FillHandle starts.
1330
+ * @param {object} event Event object
1331
+ * @param {Grid.util.GridLocation} event.cell Information about the column / record
1332
+ * @param {MouseEvent} event.domEvent The raw DOM event
1333
+ */
1334
+ onFillHandleDragStart? : ((event: { cell: GridLocation, domEvent: MouseEvent }) => Promise<boolean>|boolean|void)|string
1335
+ /**
1336
+ * Fires on the owning Grid when cell editing is finished
1337
+ * @param {object} event Event object
1338
+ * @param {Grid.view.Grid} event.grid Target grid
1339
+ * @param {CellEditorContext} event.editorContext Editing context
1340
+ */
1341
+ onFinishCellEdit? : ((event: { grid: Grid, editorContext: CellEditorContext }) => void)|string
1342
+ /**
1343
+ * 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.
1344
+ * ...
1345
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#event-finishRowEdit)
1346
+ * @param {object} event Event object
1347
+ * @param {Grid.view.Grid} event.grid Target grid
1348
+ * @param {RowEditorContext} event.editorContext Editing context
1349
+ */
1350
+ onFinishRowEdit? : ((event: { grid: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string
1351
+ /**
1352
+ * Fired when focus enters this Widget.
1353
+ * @param {object} event Event object
1354
+ * @param {Core.widget.Widget} event.source This Widget
1355
+ * @param {HTMLElement} event.fromElement The element which lost focus.
1356
+ * @param {HTMLElement} event.toElement The element which gained focus.
1357
+ * @param {Core.widget.Widget} event.fromWidget The widget which lost focus.
1358
+ * @param {Core.widget.Widget} event.toWidget The widget which gained focus.
1359
+ * @param {boolean} event.backwards `true` if the `toElement` is before the `fromElement` in document order.
1360
+ */
1361
+ onFocusIn? : ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string
1362
+ /**
1363
+ * Fired when focus exits this Widget's ownership tree. This is different from a `blur` event.
1364
+ * focus moving from within this Widget's ownership tree, even if there are floating widgets
1365
+ * will not trigger this event. This is when focus exits this widget completely.
1366
+ * @param {object} event Event object
1367
+ * @param {Core.widget.Widget} event.source This Widget
1368
+ * @param {HTMLElement} event.fromElement The element which lost focus.
1369
+ * @param {HTMLElement} event.toElement The element which gained focus.
1370
+ * @param {Core.widget.Widget} event.fromWidget The widget which lost focus.
1371
+ * @param {Core.widget.Widget} event.toWidget The widget which gained focus.
1372
+ * @param {boolean} event.backwards `true` if the `toElement` is before the `fromElement` in document order.
1373
+ */
1374
+ onFocusOut? : ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string
1375
+ /**
1376
+ * Fired before dragging starts, return false to prevent the drag operation.
1377
+ * @param {object} event Event object
1378
+ * @param {Grid.view.GridBase} event.source
1379
+ * @param {object} event.context
1380
+ * @param {Core.data.Model[]} event.context.records The dragged row records
1381
+ * @param {MouseEvent,TouchEvent} event.event
1382
+ */
1383
+ onGridRowBeforeDragStart? : ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => Promise<boolean>|boolean|void)|string
1384
+ /**
1385
+ * Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
1386
+ * Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
1387
+ * @param {object} event Event object
1388
+ * @param {Grid.view.GridBase} event.source
1389
+ * @param {object} event.context
1390
+ * @param {boolean} event.context.valid Set this to true or false to indicate whether the drop position is valid
1391
+ * @param {Core.data.Model} event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
1392
+ * @param {Core.data.Model} event.context.parent The parent record of the current drop position (only applicable for trees)
1393
+ * @param {Core.data.Model[]} event.context.records The dragged row records
1394
+ * @param {RecordPositionContext[]} 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
1395
+ * @param {MouseEvent} event.event
1396
+ */
1397
+ onGridRowBeforeDropFinalize? : ((event: { source: GridBase, context: { valid: boolean, insertBefore: Model, parent: Model, records: Model[], oldPositionContext: RecordPositionContext[] }, event: MouseEvent }) => Promise<boolean>|boolean|void)|string
1398
+ /**
1399
+ * Fired while the row is being dragged, in the listener function you have access to `context.insertBefore` a grid /
1400
+ * tree record, and additionally `context.parent` (a TreeNode) for trees. You can signal that the drop position is
1401
+ * valid or invalid by setting `context.valid = false;`
1402
+ * @param {object} event Event object
1403
+ * @param {Grid.view.GridBase} event.source
1404
+ * @param {object} event.context
1405
+ * @param {boolean} event.context.valid Set this to true or false to indicate whether the drop position is valid.
1406
+ * @param {Core.data.Model} event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
1407
+ * @param {Core.data.Model} event.context.parent The parent record of the current drop position (only applicable for trees)
1408
+ * @param {Core.data.Model[]} event.context.records The dragged row records
1409
+ * @param {MouseEvent} event.event
1410
+ */
1411
+ onGridRowDrag? : ((event: { source: GridBase, context: { valid: boolean, insertBefore: Model, parent: Model, records: Model[] }, event: MouseEvent }) => void)|string
1412
+ /**
1413
+ * Fired when a row drag operation is aborted
1414
+ * @param {object} event Event object
1415
+ * @param {Grid.view.GridBase} event.source
1416
+ * @param {object} event.context
1417
+ * @param {Core.data.Model[]} event.context.records The dragged row records
1418
+ * @param {MouseEvent} event.event
1419
+ */
1420
+ onGridRowDragAbort? : ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent }) => void)|string
1421
+ /**
1422
+ * Fired when dragging starts.
1423
+ * @param {object} event Event object
1424
+ * @param {Grid.view.GridBase} event.source
1425
+ * @param {object} event.context
1426
+ * @param {Core.data.Model[]} event.context.records The dragged row records
1427
+ * @param {MouseEvent,TouchEvent} event.event
1428
+ */
1429
+ onGridRowDragStart? : ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => void)|string
1430
+ /**
1431
+ * Fired after the row drop operation has completed, regardless of validity
1432
+ * @param {object} event Event object
1433
+ * @param {Grid.view.GridBase} event.source
1434
+ * @param {object} event.context
1435
+ * @param {boolean} event.context.valid true or false depending on whether the drop position was valid
1436
+ * @param {Core.data.Model} event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
1437
+ * @param {Core.data.Model} event.context.parent The parent record of the current drop position (only applicable for trees)
1438
+ * @param {Core.data.Model[]} event.context.records The dragged row records
1439
+ * @param {RecordPositionContext[]} 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
1440
+ * @param {MouseEvent} event.event
1441
+ */
1442
+ onGridRowDrop? : ((event: { source: GridBase, context: { valid: boolean, insertBefore: Model, parent: Model, records: Model[], oldPositionContext: RecordPositionContext[] }, event: MouseEvent }) => void)|string
1443
+ /**
1444
+ * Fired when a grid header is clicked on.
1445
+ * ...
1446
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#event-headerClick)
1447
+ * @param {object} event Event object
1448
+ * @param {Event} event.domEvent The triggering DOM event.
1449
+ * @param {Grid.column.Column} event.column The column clicked on.
1450
+ */
1451
+ onHeaderClick? : ((event: { domEvent: Event, column: Column }) => Promise<boolean>|boolean|void)|string
1452
+ /**
1453
+ * This event fires on the owning Grid before the context menu is shown for a header.
1454
+ * Allows manipulation of the items to show in the same way as in the [processItems](https://bryntum.com/products/gantt/docs/api/Grid/feature/HeaderMenu#config-processItems).
1455
+ * ...
1456
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#event-headerMenuBeforeShow)
1457
+ * @param {object} event Event object
1458
+ * @param {Grid.view.Grid} event.source The grid
1459
+ * @param {Core.widget.Menu} event.menu The menu
1460
+ * @param {Record<string, MenuItemEntry>} event.items Menu item configs
1461
+ * @param {Grid.column.Column} event.column Column
1462
+ */
1463
+ onHeaderMenuBeforeShow? : ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => Promise<boolean>|boolean|void)|string
1464
+ /**
1465
+ * This event fires on the owning Grid when an item is selected in the header context menu.
1466
+ * @param {object} event Event object
1467
+ * @param {Grid.view.Grid} event.source The grid
1468
+ * @param {Core.widget.Menu} event.menu The menu
1469
+ * @param {Core.widget.MenuItem} event.item Selected menu item
1470
+ * @param {Grid.column.Column} event.column Column
1471
+ */
1472
+ onHeaderMenuItem? : ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column }) => void)|string
1473
+ /**
1474
+ * This event fires on the owning Grid after the context menu is shown for a header
1475
+ * @param {object} event Event object
1476
+ * @param {Grid.view.Grid} event.source The grid
1477
+ * @param {Core.widget.Menu} event.menu The menu
1478
+ * @param {Record<string, MenuItemEntry>} event.items Menu item configs
1479
+ * @param {Grid.column.Column} event.column Column
1480
+ */
1481
+ onHeaderMenuShow? : ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => void)|string
1482
+ /**
1483
+ * This event fires on the owning Grid when a check item is toggled in the header context menu.
1484
+ * @param {object} event Event object
1485
+ * @param {Grid.view.Grid} event.source The grid
1486
+ * @param {Core.widget.Menu} event.menu The menu
1487
+ * @param {Core.widget.MenuItem} event.item Selected menu item
1488
+ * @param {Grid.column.Column} event.column Column
1489
+ * @param {boolean} event.checked Checked or not
1490
+ */
1491
+ onHeaderMenuToggleItem? : ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column, checked: boolean }) => void)|string
1492
+ /**
1493
+ * Triggered after a widget was hidden
1494
+ * @param {object} event Event object
1495
+ * @param {Core.widget.Widget} event.source The widget
1496
+ */
1497
+ onHide? : ((event: { source: Widget }) => void)|string
1498
+ /**
1499
+ * Fires when row locking is enabled.
1500
+ * @param {object} event Event object
1501
+ * @param {Grid.view.GridBase} event.clone The created clone
1502
+ */
1503
+ onLockRows? : ((event: { clone: GridBase }) => void)|string
1504
+ /**
1505
+ * Mouse moved out from element in grid
1506
+ * @param {object} event Event object
1507
+ * @param {MouseEvent} event.event The native browser event
1508
+ */
1509
+ onMouseOut? : ((event: { event: MouseEvent }) => void)|string
1510
+ /**
1511
+ * Mouse moved in over element in grid
1512
+ * @param {object} event Event object
1513
+ * @param {MouseEvent} event.event The native browser event
1514
+ */
1515
+ onMouseOver? : ((event: { event: MouseEvent }) => void)|string
1516
+ /**
1517
+ * Triggered when a widget which had been in a non-visible state for any reason
1518
+ * achieves visibility.
1519
+ * ...
1520
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#event-paint)
1521
+ * @param {object} event Event object
1522
+ * @param {Core.widget.Widget} event.source The widget being painted.
1523
+ * @param {boolean} event.firstPaint `true` if this is the first paint.
1524
+ */
1525
+ onPaint? : ((event: { source: Widget, firstPaint: boolean }) => void)|string
1526
+ /**
1527
+ * Fires on the owning Grid after a paste action is performed.
1528
+ * @param {object} event Event object
1529
+ * @param {Grid.view.Grid} event.source Owner grid
1530
+ * @param {string} event.clipboardData The clipboardData that was pasted
1531
+ * @param {Core.data.Model[]} event.modifiedRecords The records which have been modified due to the paste action
1532
+ * @param {Grid.util.GridLocation} event.targetCell The cell from which the paste will be started
1533
+ * @param {string} event.entityName 'cell' to distinguish this event from other paste events
1534
+ */
1535
+ onPaste? : ((event: { source: Grid, clipboardData: string, modifiedRecords: Model[], targetCell: GridLocation, entityName: string }) => void)|string
1536
+ /**
1537
+ * Fires on the owning Grid when export has finished
1538
+ * @param {object} event Event object
1539
+ * @param {Response} event.response Optional response, if received
1540
+ * @param {Error} event.error Optional error, if exception occurred
1541
+ */
1542
+ onPdfExport? : ((event: { response?: any, error?: Error }) => void)|string
1543
+ /**
1544
+ * Fired when a Widget's read only state is toggled
1545
+ * @param {object} event Event object
1546
+ * @param {boolean} event.readOnly Read only or not
1547
+ */
1548
+ onReadOnly? : ((event: { readOnly: boolean }) => void)|string
1549
+ /**
1550
+ * This event is fired after a widget's elements have been synchronized due to a direct or indirect call
1551
+ * to [recompose](https://bryntum.com/products/gantt/docs/api/Core/widget/Widget#function-recompose), if this results in some change to the widget's rendered DOM elements.
1552
+ */
1553
+ onRecompose? : (() => void)|string
1554
+ /**
1555
+ * Fires after a row is rendered.
1556
+ * @param {object} event Event object
1557
+ * @param {Grid.view.Grid} event.source The firing Grid instance.
1558
+ * @param {Grid.row.Row} event.row The row that has been rendered.
1559
+ * @param {Core.data.Model} event.record The record for the row.
1560
+ * @param {number} event.recordIndex The zero-based index of the record.
1561
+ */
1562
+ onRenderRow? : ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
1563
+ /**
1564
+ * Grid rows have been rendered
1565
+ * @param {object} event Event object
1566
+ * @param {Grid.view.Grid} event.source This grid.
1567
+ */
1568
+ onRenderRows? : ((event: { source: Grid }) => void)|string
1569
+ /**
1570
+ * Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/gantt/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
1571
+ * @param {object} event Event object
1572
+ * @param {Core.widget.Widget} event.source This Widget
1573
+ * @param {number} event.width The new width
1574
+ * @param {number} event.height The new height
1575
+ * @param {number} event.oldWidth The old width
1576
+ * @param {number} event.oldHeight The old height
1577
+ */
1578
+ onResize? : ((event: { source: Widget, width: number, height: number, oldWidth: number, oldHeight: number }) => void)|string
1579
+ /**
1580
+ * Grid resize lead to a new responsive level being applied
1581
+ * @param {object} event Event object
1582
+ * @param {Grid.view.Grid} event.grid Grid that was resized
1583
+ * @param {string} event.level New responsive level (small, large, etc)
1584
+ * @param {number} event.width New width in px
1585
+ * @param {string} event.oldLevel Old responsive level
1586
+ * @param {number} event.oldWidth Old width in px
1587
+ */
1588
+ onResponsive? : ((event: { grid: Grid, level: string, width: number, oldLevel: string, oldWidth: number }) => void)|string
1589
+ /**
1590
+ * This event fires when a row has finished collapsing.
1591
+ * @param {object} event Event object
1592
+ * @param {Core.data.Model} event.record Record
1593
+ */
1594
+ onRowCollapse? : ((event: { record: Model }) => void)|string
1595
+ /**
1596
+ * This event fires when a row expand has finished expanding.
1597
+ * ...
1598
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/widget/AssignmentGrid#event-rowExpand)
1599
+ * @param {object} event Event object
1600
+ * @param {Core.data.Model} event.record Record
1601
+ * @param {object} event.expandedElements An object with the Grid region name as property and the expanded body element as value
1602
+ * @param {Core.widget.Widget} 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.
1603
+ * @param {object} 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
1604
+ */
1605
+ onRowExpand? : ((event: { record: Model, expandedElements: object, widget: Widget, widgets: object }) => void)|string
1606
+ /**
1607
+ * Fired when the mouse enters a row
1608
+ * @param {object} event Event object
1609
+ * @param {Grid.view.Grid} event.source The grid instance
1610
+ * @param {Core.data.Model} event.record The record representing the hovered row
1611
+ * @param {Grid.column.Column} event.column The column currently hovered
1612
+ * @param {HTMLElement} event.cellElement The cell HTML element
1613
+ * @param {MouseEvent} event.event The native DOM event
1614
+ */
1615
+ onRowMouseEnter? : ((event: { source: Grid, record: Model, column: Column, cellElement: HTMLElement, event: MouseEvent }) => void)|string
1616
+ /**
1617
+ * Fired when the mouse leaves a row
1618
+ * @param {object} event Event object
1619
+ * @param {Grid.view.Grid} event.source The grid instance
1620
+ * @param {Core.data.Model} event.record The record representing the row that the mouse left
1621
+ * @param {HTMLElement} event.cellElement The cell HTML element that the mouse left
1622
+ * @param {MouseEvent} event.event The native DOM event
1623
+ */
1624
+ onRowMouseLeave? : ((event: { source: Grid, record: Model, cellElement: HTMLElement, event: MouseEvent }) => void)|string
1625
+ /**
1626
+ * Grid has scrolled vertically
1627
+ * @param {object} event Event object
1628
+ * @param {Grid.view.Grid} event.source The firing Grid instance.
1629
+ * @param {number} event.scrollTop The vertical scroll position.
1630
+ */
1631
+ onScroll? : ((event: { source: Grid, scrollTop: number }) => void)|string
1632
+ /**
1633
+ * The selection has been changed.
1634
+ * @param {object} event Event object
1635
+ * @param {'select','deselect'} event.action `'select'`/`'deselect'`
1636
+ * @param {'row','cell'} event.mode `'row'`/`'cell'`
1637
+ * @param {Grid.view.Grid} event.source
1638
+ * @param {Core.data.Model[]} event.deselected The records deselected in this operation.
1639
+ * @param {Core.data.Model[]} event.selected The records selected in this operation.
1640
+ * @param {Core.data.Model[]} event.selection The records in the new selection.
1641
+ * @param {Grid.util.GridLocation[]} event.deselectedCells The cells deselected in this operation.
1642
+ * @param {Grid.util.GridLocation[]} event.selectedCells The cells selected in this operation.
1643
+ * @param {Grid.util.GridLocation[]} event.cellSelection The cells in the new selection.
1644
+ */
1645
+ onSelectionChange? : ((event: { action: 'select'|'deselect', mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => void)|string
1646
+ /**
1647
+ * The selectionMode configuration has been changed.
1648
+ * @param {object} event Event object
1649
+ * @param {object} event.selectionMode The new [selectionMode](https://bryntum.com/products/gantt/docs/api/Grid/view/mixin/GridSelection#config-selectionMode)
1650
+ */
1651
+ onSelectionModeChange? : ((event: { selectionMode: object }) => void)|string
1652
+ /**
1653
+ * Triggered after a widget is shown.
1654
+ * @param {object} event Event object
1655
+ * @param {Core.widget.Widget} event.source The widget
1656
+ */
1657
+ onShow? : ((event: { source: Widget }) => void)|string
1658
+ /**
1659
+ * Fires when splitting the Grid.
1660
+ * @param {object} event Event object
1661
+ * @param {Grid.view.GridBase[]} event.subViews The sub views created by the split
1662
+ * @param {object} event.options The options passed to the split call
1663
+ * @param {'horizontal','vertical','both'} event.options.direction The direction of the split
1664
+ * @param {Grid.column.Column} event.options.atColumn The column to split at
1665
+ * @param {Core.data.Model} event.options.atRecord The record to split at
1666
+ */
1667
+ onSplit? : ((event: { subViews: GridBase[], options: { direction: 'horizontal'|'vertical'|'both', atColumn: Column, atRecord: Model } }) => void)|string
1668
+ /**
1669
+ * Fired by the Grid when the collapse icon is clicked. Return `false` to prevent the default collapse action,
1670
+ * if you want to implement your own behavior.
1671
+ * @param {object} event Event object
1672
+ * @param {Grid.view.Grid} event.source The Grid instance.
1673
+ * @param {Grid.view.SubGrid} event.subGrid The subgrid
1674
+ * @param {Event} event.domEvent The native DOM event
1675
+ */
1676
+ onSplitterCollapseClick? : ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => Promise<boolean>|boolean|void)|string
1677
+ /**
1678
+ * Fired by the Grid after a sub-grid has been resized using the splitter
1679
+ * @param {object} event Event object
1680
+ * @param {Grid.view.Grid} event.source The Grid instance.
1681
+ * @param {Grid.view.SubGrid} event.subGrid The resized subgrid
1682
+ * @param {Event} event.domEvent The native DOM event
1683
+ */
1684
+ onSplitterDragEnd? : ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => void)|string
1685
+ /**
1686
+ * Fired by the Grid when a sub-grid resize gesture starts
1687
+ * @param {object} event Event object
1688
+ * @param {Grid.view.Grid} event.source The Grid instance.
1689
+ * @param {Grid.view.SubGrid} event.subGrid The subgrid about to be resized
1690
+ * @param {Event} event.domEvent The native DOM event
1691
+ */
1692
+ onSplitterDragStart? : ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => void)|string
1693
+ /**
1694
+ * Fired by the Grid when the expand icon is clicked. Return `false` to prevent the default expand action,
1695
+ * if you want to implement your own behavior.
1696
+ * @param {object} event Event object
1697
+ * @param {Grid.view.Grid} event.source The Grid instance.
1698
+ * @param {Grid.view.SubGrid} event.subGrid The subgrid
1699
+ * @param {Event} event.domEvent The native DOM event
1700
+ */
1701
+ onSplitterExpandClick? : ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => Promise<boolean>|boolean|void)|string
1702
+ /**
1703
+ * Fires on the owning Grid when editing starts
1704
+ * @param {object} event Event object
1705
+ * @param {Grid.view.Grid} event.source Owner grid
1706
+ * @param {CellEditorContext} event.editorContext Editing context
1707
+ */
1708
+ onStartCellEdit? : ((event: { source: Grid, editorContext: CellEditorContext }) => void)|string
1709
+ /**
1710
+ * Fires on the owning Grid when editing starts
1711
+ * @param {object} event Event object
1712
+ * @param {Grid.view.Grid} event.source Owner grid
1713
+ * @param {RowEditorContext} event.editorContext Editing context
1714
+ */
1715
+ onStartRowEdit? : ((event: { source: Grid, editorContext: RowEditorContext }) => void)|string
1716
+ /**
1717
+ * Fires after a sub grid is collapsed.
1718
+ * @param {object} event Event object
1719
+ * @param {Grid.view.Grid} event.source The firing Grid instance
1720
+ * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
1721
+ */
1722
+ onSubGridCollapse? : ((event: { source: Grid, subGrid: SubGrid }) => void)|string
1723
+ /**
1724
+ * Fires after a sub grid is expanded.
1725
+ * @param {object} event Event object
1726
+ * @param {Grid.view.Grid} event.source The firing Grid instance
1727
+ * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
1728
+ */
1729
+ onSubGridExpand? : ((event: { source: Grid, subGrid: SubGrid }) => void)|string
1730
+ /**
1731
+ * Fired when one or more groups are expanded or collapsed
1732
+ * @param {object} event Event object
1733
+ * @param {Core.data.Model} event.groupRecord [DEPRECATED] Use `groupRecords` param instead
1734
+ * @param {Core.data.Model[]} event.groupRecords The group records being toggled
1735
+ * @param {boolean} event.collapse Collapsed (true) or expanded (false)
1736
+ * @param {boolean} event.allRecords True if this event is part of toggling all groups
1737
+ */
1738
+ onToggleGroup? : ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, allRecords?: boolean }) => void)|string
1739
+ /**
1740
+ * Fired after a parent node record toggles its collapsed state.
1741
+ * @param {object} event Event object
1742
+ * @param {Core.data.Model} event.record The record being toggled.
1743
+ * @param {boolean} event.collapse `true` if the node is being collapsed.
1744
+ */
1745
+ onToggleNode? : ((event: { record: Model, collapse: boolean }) => void)|string
1746
+ /**
1747
+ * A header [tool](https://bryntum.com/products/gantt/docs/api/Core/widget/Panel#config-tools) has been clicked.
1748
+ * @param {object} event Event object
1749
+ * @param {Core.widget.Tool} event.source This Panel.
1750
+ * @param {Core.widget.Tool} event.tool The tool which is being clicked.
1751
+ */
1752
+ onToolClick? : ((event: { source: Tool, tool: Tool }) => void)|string
1753
+ /**
1754
+ * Fires when row locking is disabled.
1755
+ * @param {object} event Event object
1756
+ * @param {Grid.view.GridBase} event.clone The locked clone that will be destroyed
1757
+ */
1758
+ onUnlockRows? : ((event: { clone: GridBase }) => void)|string
1759
+ /**
1760
+ * Fires when un-splitting the Grid.
1761
+ */
1762
+ onUnsplit? : (() => void)|string
1763
+
1764
+ // Features
1765
+ /**
1766
+ * AI-powered filter feature for Grid. Allows users to type natural language queries to filter grid data.
1767
+ * ...
1768
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/ai/AIFilter)
1769
+ */
1770
+ aiFilterFeature? : object|boolean|string|AIFilter|AIFilterConfig
1771
+ /**
1772
+ * Allows using `[Ctrl/CMD + C]`, `[Ctrl/CMD + X]` and `[Ctrl/CMD + V]` to cut, copy and paste cell or cell ranges. Also
1773
+ * makes cut, copy and paste actions available via the cell context menu.
1774
+ * ...
1775
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/CellCopyPaste)
1776
+ */
1777
+ cellCopyPasteFeature? : object|boolean|string|CellCopyPaste|CellCopyPasteConfig
1778
+ /**
1779
+ * Adding this feature to the grid and other Bryntum products which are based on the Grid (i.e. Scheduler, SchedulerPro, and Gantt)
1780
+ * enables cell editing. Any subclass of [Field](https://bryntum.com/products/gantt/docs/api/Core/widget/Field) can be used
1781
+ * as editor for the [Column](https://bryntum.com/products/gantt/docs/api/Grid/column/Column). The most popular are:
1782
+ * ...
1783
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/CellEdit)
1784
+ */
1785
+ cellEditFeature? : object|boolean|string|GridCellEdit|GridCellEditConfig
1786
+ /**
1787
+ * Right click to display context menu for cells. To invoke the cell menu in a keyboard-accessible manner, use the
1788
+ * `SPACE` key when the cell is focused.
1789
+ * ...
1790
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/CellMenu)
1791
+ */
1792
+ cellMenuFeature? : object|boolean|string|CellMenu|CellMenuConfig
1793
+ /**
1794
+ * Displays a tooltip when hovering cells.
1795
+ * ...
1796
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/CellTooltip)
1797
+ */
1798
+ cellTooltipFeature? : object|boolean|string|CellTooltip|CellTooltipConfig
1799
+ /**
1800
+ * Adds interactive charting to a Grid. [Charts](https://bryntum.com/products/gantt/docs/api/Chart/widget/Chart) can be created from a selection of Grid data
1801
+ * and updated in realtime as data changes. Supports many common chart types with extensive styling and customization
1802
+ * options.
1803
+ * ...
1804
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/Charts)
1805
+ */
1806
+ chartsFeature? : object|boolean|string|Charts|ChartsConfig
1807
+ /**
1808
+ * Enables the [autoWidth](https://bryntum.com/products/gantt/docs/api/Grid/column/Column#config-autoWidth) config for a grid's columns.
1809
+ * ...
1810
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/ColumnAutoWidth)
1811
+ */
1812
+ columnAutoWidthFeature? : object|boolean|string|ColumnAutoWidth|ColumnAutoWidthConfig
1813
+ /**
1814
+ * Displays a toolbar while dragging column headers. Drop on a button in the toolbar to activate a certain function,
1815
+ * for example to group by that column. This feature simplifies certain operations on touch devices.
1816
+ * ...
1817
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/ColumnDragToolbar)
1818
+ */
1819
+ columnDragToolbarFeature? : object|boolean|string|ColumnDragToolbar|ColumnDragToolbarConfig
1820
+ /**
1821
+ * Displays a column picker (to show/hide columns) in the header context menu. Columns can be displayed in sub menus
1822
+ * by region or tag. Grouped headers are displayed as menu hierarchies.
1823
+ * ...
1824
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/ColumnPicker)
1825
+ */
1826
+ columnPickerFeature? : object|boolean|string|ColumnPicker|ColumnPickerConfig
1827
+ /**
1828
+ * Allows user to rename columns by either right-clicking column header or using keyboard shortcuts when column header
1829
+ * is focused.
1830
+ * ...
1831
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/ColumnRename)
1832
+ */
1833
+ columnRenameFeature? : object|boolean|string|ColumnRename|ColumnRenameConfig
1834
+ /**
1835
+ * Allows user to reorder columns by dragging headers. To get notified about column reorder listen to `change` event
1836
+ * on [columns](https://bryntum.com/products/gantt/docs/api/Grid/data/ColumnStore) store.
1837
+ * ...
1838
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/ColumnReorder)
1839
+ */
1840
+ columnReorderFeature? : object|boolean|string|ColumnReorder|ColumnReorderConfig
1841
+ /**
1842
+ * Enables user to resize columns by dragging a handle on the right hand side of the header. To get notified about column
1843
+ * resize listen to `change` event on [columns](https://bryntum.com/products/gantt/docs/api/Grid/data/ColumnStore) store.
1844
+ * ...
1845
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/ColumnResize)
1846
+ */
1847
+ columnResizeFeature? : object|boolean|string|ColumnResize|ColumnResizeConfig
1848
+ /**
1849
+ * A feature that allows exporting Grid data to Excel or CSV without involving the server. It uses
1850
+ * [TableExporter](https://bryntum.com/products/gantt/docs/api/Grid/util/TableExporter) class as data provider, 3rd party provider to generate XLS files, and
1851
+ * [Microsoft XML specification](https://msdn.microsoft.com/en-us/library/office/documentformat.openxml.spreadsheet.aspx).
1852
+ * ...
1853
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/experimental/ExcelExporter)
1854
+ */
1855
+ excelExporterFeature? : object|boolean|string|GridExcelExporter|GridExcelExporterConfig
1856
+ /**
1857
+ * An experimental feature that lets users drop files on a Widget. The widget fires an event when a file is dropped onto it.
1858
+ * In the event, you get access to the raw files as strings, that were parsed by calling `readAsBinaryString`.
1859
+ * ...
1860
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/experimental/FileDrop)
1861
+ */
1862
+ fileDropFeature? : object|boolean|string|FileDrop|FileDropConfig
1863
+ /**
1864
+ * This feature adds a fill handle to a Grid range selection, which when dragged, fills the cells being dragged over
1865
+ * with values based on the values in the original selected range. This is similar to functionality normally seen in
1866
+ * various spreadsheet applications.
1867
+ * ...
1868
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/FillHandle)
1869
+ */
1870
+ fillHandleFeature? : object|boolean|string|FillHandle|FillHandleConfig
1871
+ /**
1872
+ * Feature that allows filtering of the grid by settings filters on columns. The actual filtering is done by the store.
1873
+ * For info on programmatically handling filters, see [StoreFilter](https://bryntum.com/products/gantt/docs/api/Core/data/mixin/StoreFilter).
1874
+ * ...
1875
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/Filter)
1876
+ */
1877
+ filterFeature? : object|boolean|string|Filter|FilterConfig
1878
+ /**
1879
+ * Feature that allows filtering of the grid by entering filters on column headers.
1880
+ * The actual filtering is done by the store.
1881
+ * For info on programmatically handling filters, see [StoreFilter](https://bryntum.com/products/gantt/docs/api/Core/data/mixin/StoreFilter).
1882
+ * ...
1883
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/FilterBar)
1884
+ */
1885
+ filterBarFeature? : object|boolean|string|FilterBar|FilterBarConfig
1886
+ /**
1887
+ * Enables rendering and handling of row groups. The actual grouping is done in the store, but triggered by
1888
+ * <kbd>shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
1889
+ * one anywhere on grid). Use <kbd>shift</kbd> + <kbd>alt</kbd> + click, or the context menu, to remove a column
1890
+ * grouper.
1891
+ * ...
1892
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/Group)
1893
+ */
1894
+ groupFeature? : object|boolean|string|Group|GroupConfig
1895
+ /**
1896
+ * Displays a summary row as a group footer in a grouped grid. Uses the same configuration options on columns as
1897
+ * [Summary](https://bryntum.com/products/gantt/docs/api/Grid/feature/Summary).
1898
+ * ...
1899
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/GroupSummary)
1900
+ */
1901
+ groupSummaryFeature? : object|boolean|string|GridGroupSummary|GridGroupSummaryConfig
1902
+ /**
1903
+ * Right click column header or focus it and press SPACE key to show the context menu for headers.
1904
+ * ...
1905
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/HeaderMenu)
1906
+ */
1907
+ headerMenuFeature? : object|boolean|string|HeaderMenu|HeaderMenuConfig
1908
+ /**
1909
+ * This feature allows records which satisfy a certain condition to be locked at the top of the grid.
1910
+ * ...
1911
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/LockRows)
1912
+ */
1913
+ lockRowsFeature? : object|boolean|string|GridLockRows|GridLockRowsConfig
1914
+ /**
1915
+ * This feature merges cells that have the same value in sorted (or [optionally](https://bryntum.com/products/gantt/docs/api/Grid/feature/MergeCells#config-sortedOnly) any) columns
1916
+ * configured to [mergeCells](https://bryntum.com/products/gantt/docs/api/Grid/column/Column#config-mergeCells).
1917
+ * ...
1918
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/MergeCells)
1919
+ */
1920
+ mergeCellsFeature? : object|boolean|string|MergeCells|MergeCellsConfig
1921
+ /**
1922
+ * Generates PDF/PNG files from the Grid component.
1923
+ * ...
1924
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/export/PdfExport)
1925
+ */
1926
+ pdfExportFeature? : object|boolean|string|GridPdfExport|GridPdfExportConfig
1927
+ /**
1928
+ * Allows pinning columns to the start or end region of the grid without any additional subGrid configurations.
1929
+ * When pinning to a region that does not yet exist, the feature creates the required subGrid on the fly.
1930
+ * ...
1931
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/PinColumns)
1932
+ */
1933
+ pinColumnsFeature? : object|boolean|string|PinColumns|PinColumnsConfig
1934
+ /**
1935
+ * Allows printing Grid contents using browser print dialog.
1936
+ * ...
1937
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/export/Print)
1938
+ */
1939
+ printFeature? : object|boolean|string|GridPrint|GridPrintConfig
1940
+ /**
1941
+ * Feature that allows the user to search in a column by focusing a cell and typing. Navigate between hits using the
1942
+ * keyboard, [f3] or [ctrl]/[cmd] + [g] moves to next, also pressing [shift] moves to previous.
1943
+ * ...
1944
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/QuickFind)
1945
+ */
1946
+ quickFindFeature? : object|boolean|string|QuickFind|QuickFindConfig
1947
+ /**
1948
+ * Makes the splitter between grid [sections](https://bryntum.com/products/gantt/docs/api/Grid/view/SubGrid) draggable, to let users resize, and
1949
+ * collapse/expand the sections.
1950
+ * ...
1951
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/RegionResize)
1952
+ */
1953
+ regionResizeFeature? : object|boolean|string|RegionResize|RegionResizeConfig
1954
+ /**
1955
+ * Allow using [Ctrl/CMD + C/X] and [Ctrl/CMD + V] to copy/cut-and-paste rows. Also makes cut, copy and paste actions
1956
+ * available via the cell context menu.
1957
+ * ...
1958
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/RowCopyPaste)
1959
+ */
1960
+ rowCopyPasteFeature? : object|boolean|string|RowCopyPaste|RowCopyPasteConfig
1961
+ /**
1962
+ * This feature allows editing of entire rows in a grid in a docked panel which by default slides out from the right.
1963
+ * ...
1964
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/RowEdit)
1965
+ */
1966
+ rowEditFeature? : object|boolean|string|RowEdit|RowEditConfig
1967
+ /**
1968
+ * Enables expanding of Grid rows by either row click or double click, or by adding a separate Grid column which renders
1969
+ * a button that expands or collapses the row.
1970
+ * ...
1971
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/RowExpander)
1972
+ */
1973
+ rowExpanderFeature? : object|boolean|string|RowExpander|RowExpanderConfig
1974
+ /**
1975
+ * Allows user to reorder rows by dragging them. To get notified about row reorder listen to `change` event
1976
+ * on the grid [store](https://bryntum.com/products/gantt/docs/api/Core/data/Store).
1977
+ * ...
1978
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/RowReorder)
1979
+ */
1980
+ rowReorderFeature? : object|boolean|string|GridRowReorder|GridRowReorderConfig
1981
+ /**
1982
+ * Enables user to change row height by dragging the bottom row border. After a resize operation, the [rowHeight](https://bryntum.com/products/gantt/docs/api/Grid/data/GridRowModel#field-rowHeight)
1983
+ * field of the record is updated (when [applyToAllRows](https://bryntum.com/products/gantt/docs/api/Grid/feature/RowResize#config-applyToAllRows) is `false`).
1984
+ * ...
1985
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/RowResize)
1986
+ */
1987
+ rowResizeFeature? : object|boolean|string|GridRowResize|GridRowResizeConfig
1988
+ /**
1989
+ * <div class="external-example vertical" data-file="Grid/feature/Search.js"></div>
1990
+ * ...
1991
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/Search)
1992
+ */
1993
+ searchFeature? : object|boolean|string|Search|SearchConfig
1994
+ /**
1995
+ * Allows sorting of grid by clicking (or tapping) headers, also displays which columns grid is sorted by (numbered if
1996
+ * using multisort). Use modifier keys for multisorting: [Ctrl/CMD + click] to add sorter, [Ctrl/CMD + Alt + click] to remove sorter.
1997
+ * The actual sorting is done by the store, see [Store.sort()](https://bryntum.com/products/gantt/docs/api/Core/data/mixin/StoreSort#function-sort).
1998
+ * ...
1999
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/Sort)
2000
+ */
2001
+ sortFeature? : object|boolean|string|Sort|SortConfig
2002
+ /**
2003
+ * This feature allows splitting the Grid into multiple views, either by using the cell context menu, or
2004
+ * programmatically by calling [split()](https://bryntum.com/products/gantt/docs/api/Grid/feature/Split#function-split).
2005
+ * ...
2006
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/Split)
2007
+ */
2008
+ splitFeature? : object|boolean|string|GridSplit|GridSplitConfig
2009
+ /**
2010
+ * A feature which pins configurable content from a grid row to the top of the grid
2011
+ * while the row scrolls off the top but is still visible.
2012
+ * ...
2013
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/StickyCells)
2014
+ */
2015
+ stickyCellsFeature? : object|boolean|string|StickyCells|StickyCellsConfig
2016
+ /**
2017
+ * Stripes rows by adding alternating CSS classes to all row elements (`b-even` and `b-odd`).
2018
+ * ...
2019
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/Stripe)
2020
+ */
2021
+ stripeFeature? : object|boolean|string|Stripe|StripeConfig
2022
+ /**
2023
+ * Displays a summary row in the grid footer.
2024
+ * ...
2025
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/GridSummary)
2026
+ */
2027
+ summaryFeature? : object|boolean|string|GridSummary|GridSummaryConfig
2028
+ /**
2029
+ * Feature that makes the grid work more like a tree. Included by default in [TreeGrid](https://bryntum.com/products/gantt/docs/api/Grid/view/TreeGrid). Requires
2030
+ * exactly one [TreeColumn](https://bryntum.com/products/gantt/docs/api/Grid/column/TreeColumn) among grids columns. That column will have its renderer replaced with a
2031
+ * tree renderer that adds padding and icon to give the appearance of a tree. The original renderer is preserved and
2032
+ * also called.
2033
+ * ...
2034
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/Tree)
2035
+ */
2036
+ treeFeature? : object|boolean|string|Tree|TreeConfig
2037
+ /**
2038
+ * A feature that allows transforming a flat dataset (or the leaves of a hierarchical) into a tree by specifying a
2039
+ * record field per parent level. Parents are generated based on each leaf's value for those fields.
2040
+ * ...
2041
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/TreeGroup)
2042
+ */
2043
+ treeGroupFeature? : object|boolean|string|GridTreeGroup|GridTreeGroupConfig
2044
+
2045
+ }
2046
+
2047
+ export class BryntumAssignmentGrid extends React.Component<BryntumAssignmentGridProps> {
2048
+
2049
+ static instanceClass = AssignmentGrid;
2050
+
2051
+ static instanceName = 'AssignmentGrid';
2052
+
2053
+ processWidgetContent = processWidgetContent;
2054
+
2055
+ static configNames = [
2056
+ 'adopt',
2057
+ 'animateFilterRemovals',
2058
+ 'animateRemovingRows',
2059
+ 'ariaDescription',
2060
+ 'ariaLabel',
2061
+ 'autoHeight',
2062
+ 'bbar',
2063
+ 'bodyCls',
2064
+ 'bubbleEvents',
2065
+ 'collapsible',
2066
+ 'color',
2067
+ 'config',
2068
+ 'contentElementCls',
2069
+ 'contextMenuTriggerEvent',
2070
+ 'dataField',
2071
+ 'defaultRegion',
2072
+ 'destroyStore',
2073
+ 'detectCSSCompatibilityIssues',
2074
+ 'disableGridColumnIdWarning',
2075
+ 'disableGridRowModelWarning',
2076
+ 'dock',
2077
+ 'drawer',
2078
+ 'elementAttributes',
2079
+ 'enableSticky',
2080
+ 'enableTextSelection',
2081
+ 'fillLastColumn',
2082
+ 'fixedRowHeight',
2083
+ 'footer',
2084
+ 'formulaProviders',
2085
+ 'fullRowRefresh',
2086
+ 'getRowHeight',
2087
+ 'header',
2088
+ 'hideHorizontalScrollbar',
2089
+ 'hoverCls',
2090
+ 'icon',
2091
+ 'ignoreParentReadOnly',
2092
+ 'listeners',
2093
+ 'loadMask',
2094
+ 'loadMaskDefaults',
2095
+ 'loadMaskError',
2096
+ 'localizable',
2097
+ 'maskDefaults',
2098
+ 'masked',
2099
+ 'monitorResize',
2100
+ 'owner',
2101
+ 'plugins',
2102
+ 'preserveFocusOnDatasetChange',
2103
+ 'preserveScrollOnDatasetChange',
2104
+ 'preventTooltipOnTouch',
2105
+ 'projectEvent',
2106
+ 'relayStoreEvents',
2107
+ 'resizable',
2108
+ 'resizeToFitIncludesHeader',
2109
+ 'resourceColumn',
2110
+ 'responsiveLevels',
2111
+ 'ripple',
2112
+ 'rootElement',
2113
+ 'scrollerClass',
2114
+ 'scrollManager',
2115
+ 'showDirty',
2116
+ 'stateful',
2117
+ 'statefulEvents',
2118
+ 'stateId',
2119
+ 'stateProvider',
2120
+ 'strips',
2121
+ 'subGridConfigs',
2122
+ 'syncMask',
2123
+ 'tab',
2124
+ 'tabBarItems',
2125
+ 'tbar',
2126
+ 'type',
2127
+ 'ui',
2128
+ 'unitsColumn',
2129
+ 'weight'
2130
+ ];
2131
+
2132
+ static propertyConfigNames = [
2133
+ 'alignSelf',
2134
+ 'animateTreeNodeToggle',
2135
+ 'appendTo',
2136
+ 'callOnFunctions',
2137
+ 'catchEventHandlerExceptions',
2138
+ 'cellEllipsis',
2139
+ 'cls',
2140
+ 'collapsed',
2141
+ 'column',
2142
+ 'columnLines',
2143
+ 'columns',
2144
+ 'data',
2145
+ 'dataset',
2146
+ 'disabled',
2147
+ 'emptyText',
2148
+ 'enableUndoRedoKeys',
2149
+ 'extraData',
2150
+ 'flex',
2151
+ 'height',
2152
+ 'hidden',
2153
+ 'hideFooters',
2154
+ 'hideHeaders',
2155
+ 'id',
2156
+ 'inputFieldAlign',
2157
+ 'insertBefore',
2158
+ 'insertFirst',
2159
+ 'keyMap',
2160
+ 'labelPosition',
2161
+ 'longPressTime',
2162
+ 'margin',
2163
+ 'maxHeight',
2164
+ 'maxWidth',
2165
+ 'minHeight',
2166
+ 'minWidth',
2167
+ 'onBeforeCancelCellEdit',
2168
+ 'onBeforeCancelRowEdit',
2169
+ 'onBeforeCellEditStart',
2170
+ 'onBeforeCellRangeDelete',
2171
+ 'onBeforeCellRangeEdit',
2172
+ 'onBeforeColumnDragStart',
2173
+ 'onBeforeColumnDropFinalize',
2174
+ 'onBeforeColumnResize',
2175
+ 'onBeforeCopy',
2176
+ 'onBeforeCSVExport',
2177
+ 'onBeforeDestroy',
2178
+ 'onBeforeExcelExport',
2179
+ 'onBeforeFillHandleDragStart',
2180
+ 'onBeforeFinishCellEdit',
2181
+ 'onBeforeFinishRowEdit',
2182
+ 'onBeforeHide',
2183
+ 'onBeforePaste',
2184
+ 'onBeforePdfExport',
2185
+ 'onBeforeRenderRow',
2186
+ 'onBeforeRenderRows',
2187
+ 'onBeforeRowCollapse',
2188
+ 'onBeforeRowExpand',
2189
+ 'onBeforeSelectionChange',
2190
+ 'onBeforeSetRecord',
2191
+ 'onBeforeShow',
2192
+ 'onBeforeStartRowEdit',
2193
+ 'onBeforeStateApply',
2194
+ 'onBeforeStateSave',
2195
+ 'onBeforeToggleGroup',
2196
+ 'onBeforeToggleNode',
2197
+ 'onCancelCellEdit',
2198
+ 'onCatchAll',
2199
+ 'onCellClick',
2200
+ 'onCellContextMenu',
2201
+ 'onCellDblClick',
2202
+ 'onCellMenuBeforeShow',
2203
+ 'onCellMenuItem',
2204
+ 'onCellMenuShow',
2205
+ 'onCellMenuToggleItem',
2206
+ 'onCellMouseEnter',
2207
+ 'onCellMouseLeave',
2208
+ 'onCellMouseOut',
2209
+ 'onCellMouseOver',
2210
+ 'onCollapse',
2211
+ 'onCollapseNode',
2212
+ 'onColumnDrag',
2213
+ 'onColumnDragStart',
2214
+ 'onColumnDrop',
2215
+ 'onColumnResize',
2216
+ 'onColumnResizeStart',
2217
+ 'onContextMenuItem',
2218
+ 'onContextMenuToggleItem',
2219
+ 'onCopy',
2220
+ 'onDataChange',
2221
+ 'onDestroy',
2222
+ 'onDirtyStateChange',
2223
+ 'onDragSelecting',
2224
+ 'onElementCreated',
2225
+ 'onExpand',
2226
+ 'onExpandNode',
2227
+ 'onFileDrop',
2228
+ 'onFillHandleBeforeDragFinalize',
2229
+ 'onFillHandleDrag',
2230
+ 'onFillHandleDragAbort',
2231
+ 'onFillHandleDragEnd',
2232
+ 'onFillHandleDragStart',
2233
+ 'onFinishCellEdit',
2234
+ 'onFinishRowEdit',
2235
+ 'onFocusIn',
2236
+ 'onFocusOut',
2237
+ 'onGridRowBeforeDragStart',
2238
+ 'onGridRowBeforeDropFinalize',
2239
+ 'onGridRowDrag',
2240
+ 'onGridRowDragAbort',
2241
+ 'onGridRowDragStart',
2242
+ 'onGridRowDrop',
2243
+ 'onHeaderClick',
2244
+ 'onHeaderMenuBeforeShow',
2245
+ 'onHeaderMenuItem',
2246
+ 'onHeaderMenuShow',
2247
+ 'onHeaderMenuToggleItem',
2248
+ 'onHide',
2249
+ 'onLockRows',
2250
+ 'onMouseOut',
2251
+ 'onMouseOver',
2252
+ 'onPaint',
2253
+ 'onPaste',
2254
+ 'onPdfExport',
2255
+ 'onReadOnly',
2256
+ 'onRecompose',
2257
+ 'onRenderRow',
2258
+ 'onRenderRows',
2259
+ 'onResize',
2260
+ 'onResponsive',
2261
+ 'onRowCollapse',
2262
+ 'onRowExpand',
2263
+ 'onRowMouseEnter',
2264
+ 'onRowMouseLeave',
2265
+ 'onScroll',
2266
+ 'onSelectionChange',
2267
+ 'onSelectionModeChange',
2268
+ 'onShow',
2269
+ 'onSplit',
2270
+ 'onSplitterCollapseClick',
2271
+ 'onSplitterDragEnd',
2272
+ 'onSplitterDragStart',
2273
+ 'onSplitterExpandClick',
2274
+ 'onStartCellEdit',
2275
+ 'onStartRowEdit',
2276
+ 'onSubGridCollapse',
2277
+ 'onSubGridExpand',
2278
+ 'onToggleGroup',
2279
+ 'onToggleNode',
2280
+ 'onToolClick',
2281
+ 'onUnlockRows',
2282
+ 'onUnsplit',
2283
+ 'preserveScroll',
2284
+ 'readOnly',
2285
+ 'rendition',
2286
+ 'rowHeight',
2287
+ 'rowLines',
2288
+ 'rtl',
2289
+ 'scrollable',
2290
+ 'selectionMode',
2291
+ 'span',
2292
+ 'stateSettings',
2293
+ 'store',
2294
+ 'title',
2295
+ 'tools',
2296
+ 'transition',
2297
+ 'transitionDuration',
2298
+ 'width'
2299
+ ];
2300
+
2301
+ static propertyNames = [
2302
+ 'focusVisible',
2303
+ 'hasChanges',
2304
+ 'originalStore',
2305
+ 'parent',
2306
+ 'selectedCell',
2307
+ 'selectedCells',
2308
+ 'selectedRecord',
2309
+ 'selectedRecords',
2310
+ 'selectedRows',
2311
+ 'state',
2312
+ 'tooltip'
2313
+ ];
2314
+
2315
+ // Component instance
2316
+ instance!: AssignmentGrid;
2317
+
2318
+ // Component element
2319
+ element! : HTMLElement;
2320
+
2321
+ componentDidMount(): void {
2322
+ this.instance = createWidget(this);
2323
+ }
2324
+
2325
+ componentWillUnmount(): void {
2326
+ // @ts-ignore
2327
+ this.instance?.destroy?.();
2328
+ }
2329
+
2330
+ /**
2331
+ * Component about to be updated, from changing a prop using state.
2332
+ * React to it depending on what changed and prevent react from re-rendering our component.
2333
+ * @param nextProps
2334
+ * @param nextState
2335
+ * @returns {boolean}
2336
+ */
2337
+ shouldComponentUpdate(nextProps: Readonly<BryntumAssignmentGridProps>, nextState: Readonly<{}>): boolean {
2338
+ return shouldComponentUpdate(this, nextProps, nextState);
2339
+ }
2340
+
2341
+ render(): React.ReactNode {
2342
+
2343
+ const className = `b-react-assignment-grid-container`;
2344
+ return (
2345
+ <div className={className} ref={(element) => (this.element = element!)}></div>
2346
+ );
2347
+
2348
+ }
2349
+ }