@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,4698 @@
1
+ /**
2
+ * React wrapper for Bryntum Gantt
3
+ */
4
+ // eslint-disable-next-line @typescript-eslint/no-unused-vars
5
+ import React, { RefObject } from 'react';
6
+ import { AjaxStore, AjaxStoreConfig, Base, BryntumScrollOptions, Container, DomClassList, DomConfig, DurationUnit, FormulaProviderConfig, KeyMapConfig, Mask, MaskConfig, Menu, MenuItem, MenuItemEntry, Model, ModelConfig, PagingToolbarConfig, Panel, PanelCollapserConfig, PanelCollapserOverlayConfig, PanelHeader, Popup, ScrollManager, ScrollManagerConfig, Scroller, ScrollerConfig, StateProvider, Store, StoreConfig, TabConfig, Tool, ToolConfig, ToolbarConfig, ToolbarItems, TooltipConfig, Widget } from '@bryntum/core-thin';
7
+ import { AIFilter, AIFilterConfig, CellCopyPaste, CellCopyPasteConfig, 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, PinColumns, PinColumnsConfig, PreserveScrollOptions, QuickFind, QuickFindConfig, RecordPositionContext, RegionResize, RegionResizeConfig, ResponsiveLevelConfig, Row, RowCopyPaste, RowCopyPasteConfig, RowEdit, RowEditConfig, RowEditorContext, RowExpander, RowExpanderConfig, RowResize as GridRowResize, RowResizeConfig as GridRowResizeConfig, Search, SearchConfig, Sort, SortConfig, Split as GridSplit, SplitConfig as GridSplitConfig, StickyCells, StickyCellsConfig, Stripe, StripeConfig, SubGrid, SubGridConfig, Tree, TreeConfig, XLSColumn } from '@bryntum/grid-thin';
8
+ import { AssignmentModel as SchedulerAssignmentModel, ColumnLines, ColumnLinesConfig, DateConstraint, DependencyBaseModel, DependencyEdit as SchedulerDependencyEdit, DependencyModel as SchedulerDependencyModel, EventColor, EventEdit, EventFilter, EventFilterConfig, EventModel as SchedulerEventModel, EventResizeData, HeaderZoom, HeaderZoomConfig, NonWorkingTime, NonWorkingTimeConfig, Pan, PanConfig, PresetStore, RecurrenceConfirmationPopup, RecurrenceConfirmationPopupConfig, ResourceModel as SchedulerResourceModel, RowReorder, RowReorderConfig, ScheduleMenu, ScheduleMenuConfig, ScheduleTooltip, ScheduleTooltipConfig, Scheduler, TimeAxis, TimeAxisColumn as SchedulerTimeAxisColumn, TimeAxisConfig, TimeAxisHeaderMenu, TimeAxisHeaderMenuConfig, TimeRanges, TimeRangesConfig, TimeSpan, TimeSpanConfig, TimelineBase, TimelineContext, TimelineStateInfo, VerticalTimeAxisColumn, ViewPreset, ViewPresetConfig, VisibleDate } from '@bryntum/scheduler-thin';
9
+ import { CycleResolutionPopup, DependencyEdit, DependencyEditConfig, EventModel, EventSegments, EventSegmentsConfig, PercentBar, PercentBarConfig, ResourceModel as SchedulerProResourceModel, SchedulerPro, SchedulingIssueResolutionPopup, TaskEdit as SchedulerProTaskEdit, TaskEditorBase, TimeSpanHighlight, TimeSpanHighlightConfig } from '@bryntum/schedulerpro-thin';
10
+ import { AssignmentModel, AssignmentModelConfig, Baselines, BaselinesConfig, CalendarManagerStore, CalendarModel, CalendarModelConfig, CellEdit, CellEditConfig, GanttContainerItemConfig, CriticalPaths, CriticalPathsConfig, Dependencies, DependenciesConfig, DependencyModel, DependencyModelConfig, Gantt, GanttListeners, GanttColumnConfig, Indicators, IndicatorsConfig, Labels, LabelsConfig, MspExport, MspExportConfig, ParentArea, ParentAreaConfig, PdfExport, PdfExportConfig, Print, PrintConfig, ProgressLine, ProgressLineConfig, ProjectEdit, ProjectEditConfig, ProjectEditor, ProjectLines, ProjectLinesConfig, ProjectModel, ProjectModelConfig, ResourceModel, ResourceModelConfig, Rollups, RollupsConfig, ScrollButtons, ScrollButtonsConfig, Summary, SummaryConfig, TaskCopyPaste, TaskCopyPasteConfig, TaskDrag, TaskDragConfig, TaskDragCreate, TaskDragCreateConfig, TaskEdit, TaskEditConfig, TaskMenu, TaskMenuConfig, TaskModel, TaskModelConfig, TaskNonWorkingTime, TaskNonWorkingTimeConfig, TaskResize, TaskResizeConfig, TaskResizeData, TaskSegmentDrag, TaskSegmentDragConfig, TaskSegmentResize, TaskSegmentResizeConfig, TaskStore, TaskStoreConfig, TaskTooltip, TaskTooltipConfig, TimelineChart, TimelineChartConfig, TreeGroup, TreeGroupConfig, Versions, VersionsConfig } from '@bryntum/gantt-thin';
11
+
12
+ import { createWidget, shouldComponentUpdate, processWidgetContent } from './WrapperHelper.js';
13
+
14
+ export type BryntumGanttProps = {
15
+ // Configs
16
+ /**
17
+ * Element (or element id) to adopt as this Widget's encapsulating element. The widget's
18
+ * content will be placed inside this element.
19
+ * ...
20
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-adopt)
21
+ */
22
+ adopt? : HTMLElement|string
23
+ /**
24
+ * 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
25
+ * flexbox layout. This config allows you to set this widget's
26
+ * [align-self](https://developer.mozilla.org/en-US/docs/Web/CSS/align-self) style.
27
+ */
28
+ alignSelf? : string
29
+ /**
30
+ * Set to `false` to not allow creating dependencies
31
+ */
32
+ allowCreate? : boolean
33
+ /**
34
+ * Set it to `true` to allow dependency creation only for parent events (only applies to Scheduler Pro using the `NestedEvents` feature). Normally the nested event container
35
+ * inside parent events cannot be scrolled when using dependencies, but by enabling this setting and limiting
36
+ * to where dependencies can be drawn scrolling will be enabled.
37
+ */
38
+ allowCreateOnlyParent? : boolean
39
+ /**
40
+ * `false` to require a drop on a target event bar side circle to define the dependency type.
41
+ * If dropped on the event bar, the `defaultValue` of the DependencyModel `type` field will be used to
42
+ * determine the target task side.
43
+ */
44
+ allowDropOnEventBar? : boolean
45
+ /**
46
+ * Set to `true` to animate row removals caused by filtering.
47
+ * @deprecated 7.0.0 Deprecated `animateFilterRemovals`. Use `transition.filterRemoval` instead
48
+ */
49
+ animateFilterRemovals? : boolean
50
+ /**
51
+ * Controls if removing and inserting rows should be animated. Set to `false` to prevent those animations,
52
+ * removing the related delays.
53
+ * @deprecated 7.0.0 Deprecated `animateRemovingRows`. Use `transition.removeRecord` instead
54
+ */
55
+ animateRemovingRows? : boolean
56
+ /**
57
+ * 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
58
+ * config may be set to `true` to visually animate branch node expand and collapse operations.
59
+ * *This is not supported in Scheduler and Gantt*
60
+ * @deprecated 7.0.0 Deprecated `animateTreeNodeToggle`. Use `transition.toggleTreeNode` instead
61
+ */
62
+ animateTreeNodeToggle? : boolean
63
+ /**
64
+ * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
65
+ * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/gantt/docs/api/Core/widget/Widget#property-element).
66
+ */
67
+ appendTo? : HTMLElement|string
68
+ /**
69
+ * A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject
70
+ * into an element which will be linked using the `aria-describedby` attribute.
71
+ * ...
72
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-ariaDescription)
73
+ */
74
+ ariaDescription? : string
75
+ /**
76
+ * A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject as
77
+ * the `aria-label` attribute.
78
+ * ...
79
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-ariaLabel)
80
+ */
81
+ ariaLabel? : string
82
+ /**
83
+ * Inline assignments, will be loaded into the backing project's AssignmentStore.
84
+ */
85
+ assignments? : AssignmentModel[]|AssignmentModelConfig[]
86
+ /**
87
+ * You can set this option to `false` to make the timeline panel start and end on the exact provided
88
+ * [startDate](https://bryntum.com/products/gantt/docs/api/Scheduler/view/TimelineBase#config-startDate)/[endDate](#Scheduler/view/TimelineBase#config-endDate) w/o adjusting them.
89
+ */
90
+ autoAdjustTimeAxis? : boolean
91
+ /**
92
+ * Automatically set grids height to fit all rows (no scrolling in the grid). In general you should avoid
93
+ * using `autoHeight: true`, since it will bypass Grids virtual rendering and render all rows at once, which
94
+ * in a larger grid is really bad for performance.
95
+ */
96
+ autoHeight? : boolean
97
+ /**
98
+ * Controls how much space to leave between stacked event bars in px.
99
+ * ...
100
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-barMargin)
101
+ */
102
+ barMargin? : number
103
+ /**
104
+ * A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/gantt/docs/api/Core/widget/Toolbar),
105
+ * 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).
106
+ * ...
107
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-bbar)
108
+ */
109
+ bbar? : (GanttContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
110
+ /**
111
+ * Custom CSS classes to add to the panel's body element.
112
+ * ...
113
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-bodyCls)
114
+ */
115
+ bodyCls? : string|object
116
+ /**
117
+ * An object where property names with a truthy value indicate which events should bubble up the ownership
118
+ * hierarchy when triggered.
119
+ * ...
120
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-bubbleEvents)
121
+ */
122
+ bubbleEvents? : object
123
+ /**
124
+ * This config defines the size of the start and end invisible parts of the timespan when [infiniteScroll](https://bryntum.com/products/gantt/docs/api/Scheduler/view/mixin/TimelineScroll#config-infiniteScroll) set to `true`.
125
+ * ...
126
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-bufferCoef)
127
+ */
128
+ bufferCoef? : number
129
+ /**
130
+ * This config defines the scroll limit, which, when exceeded will cause a timespan shift.
131
+ * The limit is calculated as the `panelWidth * [bufferCoef](https://bryntum.com/products/gantt/docs/api/Scheduler/view/mixin/TimelineScroll#config-bufferCoef) * bufferThreshold`. During scrolling, if the left or right side
132
+ * has less than that of the rendered content - a shift is triggered.
133
+ * ...
134
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-bufferThreshold)
135
+ */
136
+ bufferThreshold? : number
137
+ /**
138
+ * Inline calendars, will be loaded into the backing project's CalendarManagerStore.
139
+ */
140
+ calendars? : CalendarModel[]|CalendarModelConfig[]
141
+ /**
142
+ * Set to `false` to not call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
143
+ * ...
144
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-callOnFunctions)
145
+ */
146
+ callOnFunctions? : boolean
147
+ /**
148
+ * By default, if an event handler throws an exception, the error propagates up the stack and the
149
+ * application state is undefined. Code which follows the event handler will *not* be executed.
150
+ * ...
151
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-catchEventHandlerExceptions)
152
+ */
153
+ catchEventHandlerExceptions? : boolean
154
+ /**
155
+ * Set to `false` to crop text in grid cells without ellipsis (...). When enabled, cells containing pure
156
+ * use `display : block`, instead of `display : flex` to allow ellipsis to work.
157
+ * <strong>NOTE</strong> Only supported in browsers that support `:has()` CSS selector
158
+ */
159
+ cellEllipsis? : boolean
160
+ /**
161
+ * Custom CSS classes to add to element.
162
+ * May be specified as a space separated string, or as an object in which property names
163
+ * with truthy values are used as the class names:
164
+ * ...
165
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-cls)
166
+ */
167
+ cls? : string|object
168
+ /**
169
+ * Controls whether the panel is collapsed (the body of the panel is hidden while only the header is
170
+ * visible). Only valid if the panel is [collapsible](https://bryntum.com/products/gantt/docs/api/Core/widget/Panel#config-collapsible).
171
+ */
172
+ collapsed? : boolean
173
+ /**
174
+ * This config enables collapsibility for the panel. See [collapsed](https://bryntum.com/products/gantt/docs/api/Core/widget/Panel#config-collapsed).
175
+ * ...
176
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-collapsible)
177
+ */
178
+ collapsible? : boolean|PanelCollapserConfig|PanelCollapserOverlayConfig
179
+ /**
180
+ * Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
181
+ * `style` block.
182
+ * ...
183
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-color)
184
+ */
185
+ color? : string
186
+ /**
187
+ * Programmatic control over which column to start in when used in a grid layout.
188
+ */
189
+ column? : number
190
+ /**
191
+ * Set to `false` to not show column lines. End result might be overruled by/differ between themes.
192
+ */
193
+ columnLines? : boolean
194
+ /**
195
+ * Accepts column definitions for the grid during initialization. They will be used to create
196
+ * [Column](https://bryntum.com/products/gantt/docs/api/Grid/column/Column) instances that are added to a [ColumnStore](#Grid/data/ColumnStore).
197
+ * ...
198
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-columns)
199
+ */
200
+ columns? : ColumnStore|GanttColumnConfig[]|ColumnStoreConfig
201
+ config? : object
202
+ /**
203
+ * Custom CSS classes to add to the [contentElement](https://bryntum.com/products/gantt/docs/api/Core/widget/Widget#property-contentElement).
204
+ * May be specified as a space separated string, or as an object in which property names
205
+ * with truthy values are used as the class names:
206
+ * ...
207
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-contentElementCls)
208
+ */
209
+ contentElementCls? : string|object
210
+ /**
211
+ * Event which is used to show context menus.
212
+ * Available options are: 'contextmenu', 'click', 'dblclick'.
213
+ */
214
+ contextMenuTriggerEvent? : 'contextmenu'|'click'|'dblclick'
215
+ /**
216
+ * A tooltip config object that will be applied to the dependency creation [Tooltip](https://bryntum.com/products/gantt/docs/api/Core/widget/Tooltip)
217
+ */
218
+ creationTooltip? : TooltipConfig
219
+ /**
220
+ * A template function that will be called to generate the HTML contents of the dependency creation tooltip.
221
+ * You can return either an HTML string or a [DomConfig](https://bryntum.com/products/gantt/docs/api/Core/helper/DomHelper#typedef-DomConfig) object.
222
+ * @param {object} data Data about the dependency being created
223
+ * @param {Scheduler.model.TimeSpan} data.source The from event
224
+ * @param {Scheduler.model.TimeSpan} data.target The target event
225
+ * @param {string} data.fromSide The from side (start, end, top, bottom)
226
+ * @param {string} data.toSide The target side (start, end, top, bottom)
227
+ * @param {boolean} data.valid The validity of the dependency
228
+ * @returns {string,DomConfig}
229
+ */
230
+ creationTooltipTemplate? : (data: { source: TimeSpan, target: TimeSpan, fromSide: string, toSide: string, valid: boolean }) => string|DomConfig
231
+ /**
232
+ * Class implementing the popup resolving *scheduling cycles*.
233
+ * ...
234
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-cycleResolutionPopupClass)
235
+ */
236
+ cycleResolutionPopupClass? : typeof CycleResolutionPopup
237
+ /**
238
+ * Convenient shortcut to set data in grids store both during initialization and at runtime. Can also be
239
+ * used to retrieve data at runtime, although we do recommend interacting with Grids store instead using
240
+ * the [store](https://bryntum.com/products/gantt/docs/api/Grid/view/GridBase#property-store) property.
241
+ * ...
242
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-data)
243
+ */
244
+ data? : object[]|Model[]|ModelConfig[]
245
+ /**
246
+ * When this Widget configuration is used in the Grid's RowExpander feature's `widget` config, provide the
247
+ * field on the expanded record to use for populating this widget's store (if applicable)
248
+ */
249
+ dataField? : string
250
+ /**
251
+ * Object to apply to elements dataset (each key will be used as a data-attribute on the element)
252
+ */
253
+ dataset? : Record<string, string>
254
+ /**
255
+ * Region to which columns are added when they have none specified
256
+ */
257
+ defaultRegion? : string
258
+ /**
259
+ * The file name of an image file to use when a resource has no image, or its image cannot be loaded.
260
+ */
261
+ defaultResourceImageName? : string
262
+ /**
263
+ * Inline dependencies, will be loaded into the backing project's DependencyStore.
264
+ */
265
+ dependencies? : DependencyModel[]|DependencyModelConfig[]
266
+ /**
267
+ * A task field (id, wbsCode, sequenceNumber etc) that will be used when displaying and editing linked tasks.
268
+ */
269
+ dependencyIdField? : string
270
+ /**
271
+ * Set to `true` to destroy the store when the grid is destroyed.
272
+ */
273
+ destroyStore? : boolean
274
+ /**
275
+ * Check for CSS compatibility issues when upgrading to v7. Performs the following checks:
276
+ * ...
277
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-detectCSSCompatibilityIssues)
278
+ */
279
+ detectCSSCompatibilityIssues? : boolean
280
+ /**
281
+ * 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
282
+ * cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
283
+ * ...
284
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-disabled)
285
+ */
286
+ disabled? : boolean|'inert'
287
+ /**
288
+ * 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
289
+ * configured without an `id`. But the recommended action is to always configure columns with an `id` when
290
+ * using states.
291
+ */
292
+ disableGridColumnIdWarning? : boolean
293
+ /**
294
+ * Set to `true` to not get a warning when using another base class than GridRowModel for your grid data. If
295
+ * you do, and would like to use the full feature set of the grid then include the fields from GridRowModel
296
+ * in your model definition.
297
+ */
298
+ disableGridRowModelWarning? : boolean
299
+ /**
300
+ * Defines how dates will be formatted in tooltips etc. This config has priority over similar config on the
301
+ * view preset. For allowed values see [format](https://bryntum.com/products/gantt/docs/api/Core/helper/DateHelper#function-format-static).
302
+ * ...
303
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-displayDateFormat)
304
+ */
305
+ displayDateFormat? : string
306
+ /**
307
+ * Set to `true` to display special popups allowing user
308
+ * to resolve [scheduling conflicts](https://bryntum.com/products/gantt/docs/api/SchedulerPro/widget/SchedulingIssueResolutionPopup),
309
+ * [cycles](https://bryntum.com/products/gantt/docs/api/SchedulerPro/widget/CycleResolutionPopup) or calendar misconfigurations.
310
+ * The popup will suggest user ways to resolve the corresponding case.
311
+ */
312
+ displaySchedulingIssueResolutionPopup? : boolean
313
+ /**
314
+ * Controls the placement of this widget when it is added to a [panel's ](https://bryntum.com/products/gantt/docs/api/Core/widget/Panel)
315
+ * [strips collection](https://bryntum.com/products/gantt/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
316
+ * `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
317
+ * body. Such widgets are called "edge strips".
318
+ * ...
319
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-dock)
320
+ */
321
+ dock? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
322
+ /**
323
+ * Make this Panel a docked drawer which slides out from one side of the browser viewport by default.
324
+ * ...
325
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-drawer)
326
+ * @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.
327
+ * @param {string,number} size The size of the drawer in its collapsible axis.
328
+ * @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.
329
+ * @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.
330
+ * @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.
331
+ * @param {boolean,string} autoClose.focusout If focus moves outside of the drawer, the drawer will automatically be hidden.
332
+ * @param {string} autoClose.mouseout Hides the drawer when the mouse leaves the drawer after the `autoCloseDelay` period.
333
+ * @param {number} autoCloseDelay When using `mouseout`, this is the delay in milliseconds
334
+ */
335
+ 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}
336
+ /**
337
+ * Decimal precision used when displaying durations, used by tooltips and DurationColumn.
338
+ * Specify `false` to use raw value
339
+ */
340
+ durationDisplayPrecision? : number|boolean
341
+ /**
342
+ * An object specifying attributes to assign to the root element of this widget.
343
+ * Set `null` value to attribute to remove it.
344
+ * ...
345
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-elementAttributes)
346
+ */
347
+ elementAttributes? : Record<string, string|null>
348
+ /**
349
+ * 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.
350
+ * When using multiple Grid regions, provide the `region` property to decide where the text is shown.
351
+ * By default, it is shown in the first region.
352
+ * ...
353
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-emptyText)
354
+ */
355
+ emptyText? : string|EmptyTextDomConfig
356
+ /**
357
+ * Allow using [Delete] and [Backspace] to remove events/assignments
358
+ */
359
+ enableDeleteKey? : boolean
360
+ /**
361
+ * Set to `false` if you don't want event bar DOM updates to animate.
362
+ * @deprecated 7.0.0 Deprecated `enableEventAnimations`. Use `transition.changeEvent` instead
363
+ */
364
+ enableEventAnimations? : boolean
365
+ /**
366
+ * Enables showing occurrences of recurring events across the scheduler's time axis. If you want to disable
367
+ * the recurrence popup, you can choose set the `defaultAction` to `future` to affect all future
368
+ * occurrences, or `single` to just affect the currently selected event.
369
+ * ...
370
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-enableRecurringEvents)
371
+ */
372
+ enableRecurringEvents? : boolean|{
373
+ defaultAction?: 'single'|'future'
374
+ }
375
+ /**
376
+ * Configure this as `true` to allow elements within cells to be styled as `position: sticky`.
377
+ * ...
378
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-enableSticky)
379
+ */
380
+ enableSticky? : boolean
381
+ /**
382
+ * Set to `true` to allow text selection in the grid cells. Note, this cannot be used simultaneously with the
383
+ * `RowReorder` feature.
384
+ */
385
+ enableTextSelection? : boolean
386
+ /**
387
+ * When true, some features will start a project transaction, blocking the project queue, suspending
388
+ * store events and preventing UI from updates. It behaves similar to
389
+ * [instantUpdate](https://bryntum.com/products/gantt/docs/api/Grid/column/Column#config-instantUpdate) set to `false`.
390
+ * Set `false` to not use project queue.
391
+ */
392
+ enableTransactionalFeatures? : boolean
393
+ /**
394
+ * Set to `true` to listen for CTRL-Z (CMD-Z on Mac OS) keyboard event and trigger undo (redo when SHIFT is
395
+ * pressed). Only applicable when using a [StateTrackingManager](https://bryntum.com/products/gantt/docs/api/Core/data/stm/StateTrackingManager).
396
+ */
397
+ enableUndoRedoKeys? : boolean
398
+ /**
399
+ * The end date of the timeline (if not configure with [infiniteScroll](https://bryntum.com/products/gantt/docs/api/Scheduler/view/TimelineBase#config-infiniteScroll)).
400
+ * ...
401
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-endDate)
402
+ */
403
+ endDate? : Date|string
404
+ /**
405
+ * Task color used by default. Tasks can specify their own [eventColor](https://bryntum.com/products/gantt/docs/api/Gantt/model/TaskModel#field-eventColor),
406
+ * which will override this config.
407
+ * ...
408
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-eventColor)
409
+ */
410
+ eventColor? : EventColor
411
+ /**
412
+ * Event style used by default. Events and resources can specify their own style, with priority order being:
413
+ * Event -&gt; Resource -&gt; Scheduler default. Determines the appearance of the event by assigning a CSS class
414
+ * to it. Available styles are:
415
+ * ...
416
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-eventStyle)
417
+ */
418
+ eventStyle? : 'tonal'|'filled'|'bordered'|'traced'|'outlined'|'indented'|'line'|'dashed'|'minimal'|'rounded'|'calendar'|'interday'|'gantt'|null
419
+ extraData? : any
420
+ /**
421
+ * Set to `true` to stretch the last column in a grid with all fixed width columns
422
+ * to fill extra available space if the grid's width is wider than the sum of all
423
+ * configured column widths.
424
+ */
425
+ fillLastColumn? : boolean
426
+ /**
427
+ * Specify `true` to force rendered events/tasks to fill entire ticks. This only affects rendering, start
428
+ * and end dates retain their value on the data level.
429
+ * ...
430
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-fillTicks)
431
+ */
432
+ fillTicks? : boolean
433
+ /**
434
+ * Use fixed row height. Setting this to `true` will configure the underlying RowManager to use fixed row
435
+ * height, which sacrifices the ability to use rows with variable height to gain a fraction better
436
+ * performance.
437
+ * ...
438
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-fixedRowHeight)
439
+ */
440
+ fixedRowHeight? : boolean
441
+ /**
442
+ * 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
443
+ * flexbox layout. This config allows you to set this widget's
444
+ * [flex](https://developer.mozilla.org/en-US/docs/Web/CSS/flex) style.
445
+ * This may be configured as a single number or a `&lt;flex-grow&gt; &lt;flex-shrink&gt; &lt;flex-basis&gt;` format string.
446
+ * numeric-only values are interpreted as the `flex-grow` value.
447
+ */
448
+ flex? : number|string
449
+ /**
450
+ * Config object of a footer. May contain a `dock`, `html` and a `cls` property. A footer is not a widget,
451
+ * 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).
452
+ * ...
453
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-footer)
454
+ */
455
+ footer? : {
456
+ dock?: 'top'|'right'|'bottom'|'left'|'start'|'end'
457
+ html?: string
458
+ cls?: string
459
+ }|string
460
+ /**
461
+ * Set to `true` to force the time columns to fit to the available space (horizontal or vertical depends on mode).
462
+ * Note that setting [suppressFit](https://bryntum.com/products/gantt/docs/api/Scheduler/view/TimelineBase#config-suppressFit) to `true`, will disable `forceFit` functionality. Zooming
463
+ * cannot be used when `forceFit` is set.
464
+ */
465
+ forceFit? : boolean
466
+ /**
467
+ * An object which names formula prefixes which will be applied to all columns configured with
468
+ * `formula : true`.
469
+ * ...
470
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-formulaProviders)
471
+ */
472
+ formulaProviders? : Record<string, FormulaProviderConfig>
473
+ /**
474
+ * Refresh entire row when a record changes (`true`) or, if possible, only the cells affected (`false`).
475
+ * ...
476
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-fullRowRefresh)
477
+ */
478
+ fullRowRefresh? : boolean
479
+ /**
480
+ * Returns dates that will constrain resize and drag operations. The method will be called with the
481
+ * task being dragged.
482
+ * @param {Gantt.model.TaskModel} taskRecord The task record being moved or resized.
483
+ * @returns {DateConstraint} Constraining object containing `start` and `end` constraints. Omitting either will mean that end is not constrained. So you can prevent a resize or move from moving *before* a certain time while not constraining the end date.
484
+ */
485
+ getDateConstraints? : (taskRecord: TaskModel) => DateConstraint
486
+ /**
487
+ * 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
488
+ * expected to return the desired height of that records row. If the function returns a falsy value, Grids
489
+ * configured [rowHeight](https://bryntum.com/products/gantt/docs/api/Grid/view/GridBase#config-rowHeight) is used.
490
+ * ...
491
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-getRowHeight)
492
+ * @param {Core.data.Model} getRowHeight.record Record to determine row height for
493
+ * @returns {number} Desired row height
494
+ */
495
+ getRowHeight? : (getRowHeight: { record: Model }) => number
496
+ /**
497
+ * 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`.
498
+ * ...
499
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-header)
500
+ */
501
+ header? : string|boolean|PanelHeader
502
+ /**
503
+ * Widget's height, used to set element `style.height`. Either specify a valid height string or a number,
504
+ * which will get 'px' appended. We recommend using CSS as the primary way to control height, but in some
505
+ * cases this config is convenient.
506
+ */
507
+ height? : string|number
508
+ /**
509
+ * Configure with true to make widget initially hidden.
510
+ */
511
+ hidden? : boolean
512
+ /**
513
+ * Set to `true` to hide the footer elements
514
+ */
515
+ hideFooters? : boolean
516
+ /**
517
+ * Set to `true` to hide the column header elements
518
+ */
519
+ hideHeaders? : boolean
520
+ /**
521
+ * Set to `true` to hide the Grid's horizontal scrollbar(s)
522
+ */
523
+ hideHorizontalScrollbar? : boolean
524
+ /**
525
+ * By default the row hover effect is not visible in the Scheduler part of the grid.
526
+ * ...
527
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-hideRowHover)
528
+ */
529
+ hideRowHover? : boolean
530
+ /**
531
+ * A CSS class to add to hovered row elements
532
+ */
533
+ hoverCls? : string
534
+ /**
535
+ * 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
536
+ * [DomConfig](https://bryntum.com/products/gantt/docs/api/Core/helper/DomHelper#typedef-DomConfig) object describing an element to represent the icon.
537
+ */
538
+ icon? : string|DomConfig
539
+ /**
540
+ * Widget id, if not specified one will be generated. Also used for lookups through Widget.getById
541
+ */
542
+ id? : string
543
+ /**
544
+ * Set to `true` to ignore reacting to DOM events (mouseover/mouseout etc) while scrolling. Useful if you
545
+ * want to maximize scroll performance.
546
+ */
547
+ ignoreDomEventsWhileScrolling? : boolean
548
+ /**
549
+ * Determines if the widgets read-only state should be controlled by its parent.
550
+ * ...
551
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-ignoreParentReadOnly)
552
+ */
553
+ ignoreParentReadOnly? : boolean
554
+ /**
555
+ * Set to `true` to automatically adjust the panel timespan during scrolling in the time dimension,
556
+ * when the scroller comes close to the start/end edges.
557
+ * ...
558
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-infiniteScroll)
559
+ */
560
+ infiniteScroll? : boolean
561
+ /**
562
+ * Convenience setting to align input fields of child widgets. By default, the Field input element is
563
+ * placed immediately following the `label`. If you prefer to have all input fields aligned to the
564
+ * right, set this config to `'end'`.
565
+ * ...
566
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-inputFieldAlign)
567
+ */
568
+ inputFieldAlign? : 'start'|'end'
569
+ /**
570
+ * 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.
571
+ */
572
+ insertBefore? : HTMLElement|string
573
+ /**
574
+ * 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.
575
+ */
576
+ insertFirst? : HTMLElement|string
577
+ /**
578
+ * See [Keyboard shortcuts](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#keyboard-shortcuts) for details
579
+ */
580
+ keyMap? : Record<string, KeyMapConfig>
581
+ /**
582
+ * Convenience setting to use same label placement on all child widgets.
583
+ * ...
584
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-labelPosition)
585
+ */
586
+ labelPosition? : 'before'|'above'|'align-before'|'auto'|null
587
+ /**
588
+ * The listener set for this object.
589
+ * ...
590
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-listeners)
591
+ */
592
+ listeners? : GanttListeners
593
+ /**
594
+ * 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
595
+ * operation, or Crud Manager is loading data from the sever. Set to `null` to disable default load mask.
596
+ */
597
+ loadMask? : string|MaskConfig|null
598
+ /**
599
+ * A [Mask](https://bryntum.com/products/gantt/docs/api/Core/widget/Mask) config object to adjust the [maskDefaults](#Core/widget/Widget#config-maskDefaults)
600
+ * when data is loading. The message and optional configuration from the
601
+ * [loadMask](https://bryntum.com/products/gantt/docs/api/Core/mixin/LoadMaskable#config-loadMask) config take priority over these options, just as they do
602
+ * for `maskDefaults`, respectively.
603
+ * ...
604
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-loadMaskDefaults)
605
+ */
606
+ loadMaskDefaults? : MaskConfig
607
+ /**
608
+ * A [Mask](https://bryntum.com/products/gantt/docs/api/Core/widget/Mask) config object to adjust the [maskDefaults](#Core/widget/Widget#config-maskDefaults)
609
+ * when an error occurs loading data.
610
+ * ...
611
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-loadMaskError)
612
+ */
613
+ loadMaskError? : MaskConfig|Mask|boolean
614
+ /**
615
+ * Set to `false` to disable localization of this object.
616
+ */
617
+ localizable? : boolean
618
+ /**
619
+ * Time in ms until a longpress is triggered
620
+ */
621
+ longPressTime? : number
622
+ /**
623
+ * When `true`, events are sized and positioned based on rowHeight, resourceMargin and barMargin settings.
624
+ * Set this to `false` if you want to control height and vertical position using CSS instead.
625
+ * ...
626
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-managedEventSizing)
627
+ */
628
+ managedEventSizing? : boolean
629
+ /**
630
+ * Widget's margin. This may be configured as a single number or a `TRBL` format string.
631
+ * numeric-only values are interpreted as pixels.
632
+ */
633
+ margin? : number|string
634
+ /**
635
+ * Grids change the `maskDefaults` to cover only their `body` element.
636
+ */
637
+ maskDefaults? : MaskConfig
638
+ /**
639
+ * Set to `true` to apply the default mask to the widget. Alternatively, this can be the mask message or a
640
+ * [Mask](https://bryntum.com/products/gantt/docs/api/Core/widget/Mask) config object.
641
+ */
642
+ masked? : boolean|string|MaskConfig
643
+ /**
644
+ * Get/set end date limit of the timeline.
645
+ * Actions such as timeline scrolling, all types of timeline zooms and shifts
646
+ * will respect this limit.
647
+ */
648
+ maxDate? : Date|string
649
+ /**
650
+ * The element's maxHeight. Can be either a String or a Number (which will have 'px' appended). Note that
651
+ * like [height](https://bryntum.com/products/gantt/docs/api/Core/widget/Widget#config-height), *reading* the value will return the numeric value in pixels.
652
+ */
653
+ maxHeight? : string|number
654
+ /**
655
+ * The maximum time axis unit to display non-working ranges for ('hour' or 'day' etc).
656
+ * When zooming to a view with a larger unit, no non-working time elements will be rendered.
657
+ * ...
658
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-maxTimeAxisUnit)
659
+ */
660
+ maxTimeAxisUnit? : DurationUnit
661
+ /**
662
+ * The elements maxWidth. Can be either a String or a Number (which will have 'px' appended). Note that
663
+ * like [width](https://bryntum.com/products/gantt/docs/api/Core/widget/Widget#config-width), *reading* the value will return the numeric value in pixels.
664
+ */
665
+ maxWidth? : string|number
666
+ /**
667
+ * The maximum zoom level to which [zoomIn](https://bryntum.com/products/gantt/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomIn) will work. Defaults to the number of
668
+ * [ViewPresets](https://bryntum.com/products/gantt/docs/api/Scheduler/preset/ViewPreset) available, see [presets](#Scheduler/view/mixin/TimelineViewPresets#property-presets)
669
+ * for information. Unless you have modified the collection of available presets, the max zoom level is
670
+ * milliseconds.
671
+ */
672
+ maxZoomLevel? : number
673
+ /**
674
+ * Get/set start date limit of the timeline.
675
+ * Actions such as timeline scrolling, all types of timeline zooms and shifts
676
+ * will respect this limit.
677
+ */
678
+ minDate? : Date|string
679
+ /**
680
+ * Grid's `min-height`. Defaults to `10em` to be sure that the Grid always has a height wherever it is
681
+ * inserted.
682
+ * ...
683
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-minHeight)
684
+ */
685
+ minHeight? : string|number
686
+ /**
687
+ * The elements minWidth. Can be either a String or a Number (which will have 'px' appended). Note that
688
+ * like [width](https://bryntum.com/products/gantt/docs/api/Core/widget/Widget#config-width), *reading* the value will return the numeric value in pixels.
689
+ */
690
+ minWidth? : string|number
691
+ /**
692
+ * The minimum zoom level to which [zoomOut](https://bryntum.com/products/gantt/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomOut) will work. Defaults to 0 (year ticks)
693
+ */
694
+ minZoomLevel? : number
695
+ /**
696
+ * Grid monitors window resize by default.
697
+ */
698
+ monitorResize? : boolean
699
+ /**
700
+ * A callback function or a set of `name: value` properties to apply on tasks created using the task context menu.
701
+ * Be aware that `name` value will be ignored since it's auto generated and may be configured with localization.
702
+ * ...
703
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-newTaskDefaults)
704
+ * @returns {Gantt.model.TaskModelConfig,object} Set of properties to apply on tasks created using the task context menu
705
+ */
706
+ newTaskDefaults? : TaskModelConfig|object|(() => TaskModelConfig|object)
707
+ /**
708
+ * The owning Widget of this Widget. If this Widget is directly contained (that is, it is one of the
709
+ * [items](https://bryntum.com/products/gantt/docs/api/Core/widget/Container#property-items) of a Container), this config will be ignored. In this case
710
+ * the owner is <strong>always</strong> the encapsulating Container.
711
+ * ...
712
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-owner)
713
+ */
714
+ owner? : Widget|any
715
+ /**
716
+ * Partners this Timeline panel with another Timeline in order to sync their region sizes (sub-grids like locked, normal will get the same width),
717
+ * start and end dates, view preset, zoom level and scrolling position. All these values will be synced with the timeline defined as the `partner`.
718
+ * ...
719
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-partner)
720
+ */
721
+ partner? : TimelineBase
722
+ /**
723
+ * Specify plugins (an array of classes) in config
724
+ */
725
+ plugins? : Function[]
726
+ /**
727
+ * True to preserve focused cell after loading new data
728
+ */
729
+ preserveFocusOnDatasetChange? : boolean
730
+ /**
731
+ * Preserve the grid's vertical scroll position when changesets are applied, as in the case of remote
732
+ * changes, or when stores are configured with [syncDataOnLoad](https://bryntum.com/products/gantt/docs/api/Core/data/Store#config-syncDataOnLoad).
733
+ */
734
+ preserveScroll? : PreserveScrollOptions|boolean
735
+ /**
736
+ * Specify `true` to preserve vertical scroll position after store actions that trigger a `refresh` event,
737
+ * such as loading new data and filtering.
738
+ */
739
+ preserveScrollOnDatasetChange? : boolean
740
+ /**
741
+ * An array of [ViewPreset](https://bryntum.com/products/gantt/docs/api/Scheduler/preset/ViewPreset) config objects
742
+ * which describes the available timeline layouts for this scheduler.
743
+ * ...
744
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-presets)
745
+ */
746
+ presets? : ViewPresetConfig[]
747
+ /**
748
+ * Prevent tooltip from being displayed on touch devices. Useful for example for buttons that display a
749
+ * menu on click etc, since the tooltip would be displayed at the same time.
750
+ */
751
+ preventTooltipOnTouch? : boolean
752
+ /**
753
+ * A [ProjectModel](https://bryntum.com/products/gantt/docs/api/Gantt/model/ProjectModel) instance or a config object. The project holds all Gantt data.
754
+ */
755
+ project? : ProjectModel|ProjectModelConfig|RefObject<any>
756
+ /**
757
+ * Accepts the following values:
758
+ * ...
759
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-projectProgressReporting)
760
+ */
761
+ projectProgressReporting? : string|null
762
+ /**
763
+ * Configure as `true` to make the Gantt read-only, by disabling any UIs for modifying data.
764
+ * ...
765
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-readOnly)
766
+ */
767
+ readOnly? : boolean
768
+ /**
769
+ * The confirmation dialog shown when a recurring event is edited.
770
+ * ...
771
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-recurrenceConfirmationPopup)
772
+ */
773
+ recurrenceConfirmationPopup? : RecurrenceConfirmationPopupConfig|RecurrenceConfirmationPopup
774
+ relayStoreEvents? : boolean
775
+ /**
776
+ * Either a default `rendition` to apply to all child widgets, or a map of renditions keyed by child widget
777
+ * `type`.
778
+ * ...
779
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-rendition)
780
+ */
781
+ rendition? : string|Record<string, string>|null
782
+ /**
783
+ * Configure this property to allow the widget/component to be resized. Pressing <kbd>Shift</kbd> while resizing will
784
+ * constrain the aspect ratio.
785
+ * ...
786
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-resizable)
787
+ */
788
+ resizable? : boolean|{
789
+ minWidth?: number
790
+ maxWidth?: number
791
+ minHeight?: number
792
+ maxHeight?: number
793
+ handles?: object
794
+ }
795
+ /**
796
+ * Set to `false` to only measure cell contents when double-clicking the edge between column headers.
797
+ */
798
+ resizeToFitIncludesHeader? : boolean
799
+ /**
800
+ * The path for resource images, used by various widgets such as the resource assignment column.
801
+ * @deprecated 7.0 In favor of [resourceImagePath](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#config-resourceImagePath)
802
+ */
803
+ resourceImageFolderPath? : string
804
+ /**
805
+ * The path for resource images, used by various widgets such as the resource assignment column.
806
+ */
807
+ resourceImagePath? : string
808
+ /**
809
+ * Inline resources, will be loaded into the backing project's ResourceStore.
810
+ */
811
+ resources? : ResourceModel[]|ResourceModelConfig[]
812
+ /**
813
+ * "Break points" for which responsive config to use for columns and css.
814
+ * ...
815
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-responsiveLevels)
816
+ */
817
+ responsiveLevels? : Record<string, number|string|ResponsiveLevelConfig>
818
+ /**
819
+ * Configure as `true` to have the component display a translucent ripple when its
820
+ * [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
821
+ * current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
822
+ * ...
823
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-ripple)
824
+ */
825
+ ripple? : boolean|{
826
+ delegate?: string
827
+ color?: string
828
+ radius?: number
829
+ clip?: string
830
+ }
831
+ /**
832
+ * 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`
833
+ */
834
+ rootElement? : ShadowRoot|HTMLElement
835
+ /**
836
+ * Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
837
+ * overriden by specifying a [rowHeight](https://bryntum.com/products/gantt/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
838
+ * a column [renderer](https://bryntum.com/products/gantt/docs/api/Grid/column/Column#config-renderer).
839
+ * ...
840
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-rowHeight)
841
+ */
842
+ rowHeight? : number
843
+ /**
844
+ * Set to `false` to not show row lines. End result might be overruled by/differ between themes.
845
+ */
846
+ rowLines? : boolean
847
+ /**
848
+ * This may be configured as `true` to make the widget's element use the `direction:rtl` style.
849
+ * ...
850
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-rtl)
851
+ */
852
+ rtl? : boolean
853
+ /**
854
+ * Class implementing the popup resolving *scheduling conflicts* and *calendar misconfigurations*.
855
+ * ...
856
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-schedulingIssueResolutionPopupClass)
857
+ */
858
+ schedulingIssueResolutionPopupClass? : typeof SchedulingIssueResolutionPopup
859
+ /**
860
+ * 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).
861
+ * See the [scrollerClass](https://bryntum.com/products/gantt/docs/api/Grid/view/GridBase#config-scrollerClass) config option.
862
+ * ...
863
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-scrollable)
864
+ */
865
+ scrollable? : boolean|ScrollerConfig|Scroller
866
+ /**
867
+ * 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).
868
+ */
869
+ scrollerClass? : typeof Scroller
870
+ /**
871
+ * Configuration values for the [ScrollManager](https://bryntum.com/products/gantt/docs/api/Core/util/ScrollManager) class on initialization. Returns the
872
+ * [ScrollManager](https://bryntum.com/products/gantt/docs/api/Core/util/ScrollManager) at runtime.
873
+ */
874
+ scrollManager? : ScrollManagerConfig|ScrollManager
875
+ /**
876
+ * True to scroll the task bar into view when clicking a cell, you can also pass a
877
+ * [scroll config](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#function-scrollTaskIntoView) object.
878
+ */
879
+ scrollTaskIntoViewOnCellClick? : boolean|BryntumScrollOptions
880
+ /**
881
+ * Selection configuration settings, change these properties to control how selection works and what can be
882
+ * selected.
883
+ * ...
884
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-selectionMode)
885
+ */
886
+ selectionMode? : GridSelectionMode
887
+ /**
888
+ * If set to `true` this will:
889
+ * ...
890
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-showCostControls)
891
+ */
892
+ showCostControls? : boolean
893
+ /**
894
+ * `false` to not show a tooltip while creating a dependency
895
+ */
896
+ showCreationTooltip? : boolean
897
+ /**
898
+ * Configure as `true` to have the grid show a red "changed" tag in cells whose
899
+ * field value has changed and not yet been committed.
900
+ * ...
901
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-showDirty)
902
+ */
903
+ showDirty? : boolean|{
904
+ duringEdit?: boolean
905
+ newRecord?: boolean
906
+ }
907
+ /**
908
+ * Set to `true` to show the lag in the tooltip
909
+ */
910
+ showLagInTooltip? : boolean
911
+ /**
912
+ * Set to `false` to hide recurring fields in event editor, even if the
913
+ * [Recurring Events](https://bryntum.com/products/gantt/docs/api/Scheduler/view/mixin/RecurringEvents#config-enableRecurringEvents) is `true`
914
+ * and a recurring event is being edited.
915
+ */
916
+ showRecurringUI? : boolean
917
+ /**
918
+ * If set to `true` this will show a color field in the [TaskEdit](https://bryntum.com/products/gantt/docs/api/Gantt/feature/TaskEdit) editor and also a
919
+ * picker in the [TaskMenu](https://bryntum.com/products/gantt/docs/api/Gantt/feature/TaskMenu). Both enables the user to choose a color which will be
920
+ * applied to the task bar's background. See TaskModel's [eventColor](https://bryntum.com/products/gantt/docs/api/Gantt/model/TaskModel#field-eventColor)
921
+ * config.
922
+ */
923
+ showTaskColorPickers? : boolean
924
+ /**
925
+ * Set to `true` to show a tooltip when hovering a dependency line
926
+ */
927
+ showTooltip? : boolean
928
+ /**
929
+ * Specify as `false` to not show unscheduled tasks on the Gantt chart. Unscheduled tasks will be rendered as
930
+ * an icon
931
+ */
932
+ showUnscheduledTasks? : boolean
933
+ /**
934
+ * Set to `true` to snap to the current time resolution increment while interacting with scheduled events.
935
+ * ...
936
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-snap)
937
+ */
938
+ snap? : boolean
939
+ /**
940
+ * Affects drag drop and resizing of events when [snap](https://bryntum.com/products/gantt/docs/api/Scheduler/view/mixin/TimelineDateMapper#config-snap)
941
+ * is enabled.
942
+ * ...
943
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-snapRelativeToEventStartDate)
944
+ */
945
+ snapRelativeToEventStartDate? : boolean
946
+ /**
947
+ * Programmatic control over how many columns to span when used in a grid layout.
948
+ */
949
+ span? : number
950
+ /**
951
+ * The start date of the timeline (if not configure with [infiniteScroll](https://bryntum.com/products/gantt/docs/api/Scheduler/view/TimelineBase#config-infiniteScroll)).
952
+ * ...
953
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-startDate)
954
+ */
955
+ startDate? : Date|string
956
+ /**
957
+ * This value can be one of the following:
958
+ * ...
959
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-stateful)
960
+ */
961
+ stateful? : boolean|object|string[]
962
+ /**
963
+ * The events that, when fired by this component, should trigger it to save its state by calling
964
+ * [saveState](https://bryntum.com/products/gantt/docs/api/Core/mixin/State#function-saveState).
965
+ * ...
966
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-statefulEvents)
967
+ */
968
+ statefulEvents? : object|string[]
969
+ /**
970
+ * 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
971
+ * 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)
972
+ * (if explicitly specified) will be used as the `stateId`.
973
+ * ...
974
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-stateId)
975
+ */
976
+ stateId? : string
977
+ /**
978
+ * 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`
979
+ * will be saved using the [default state provider](https://bryntum.com/products/gantt/docs/api/Core/state/StateProvider#property-instance-static).
980
+ * ...
981
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-stateProvider)
982
+ */
983
+ stateProvider? : StateProvider
984
+ /**
985
+ * The properties of this settings object controls how grid is restored from state data.
986
+ * ...
987
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-stateSettings)
988
+ */
989
+ stateSettings? : {
990
+ restoreUnconfiguredColumns?: boolean
991
+ }
992
+ /**
993
+ * When set, the text in the major time axis header sticks in the scrolling viewport as long as possible.
994
+ */
995
+ stickyHeaders? : boolean
996
+ /**
997
+ * Store that holds records to display in the grid, or a store config object. If the configuration contains
998
+ * a `readUrl`, an `AjaxStore` will be created.
999
+ * ...
1000
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-store)
1001
+ */
1002
+ store? : Store|StoreConfig|AjaxStore|AjaxStoreConfig
1003
+ /**
1004
+ * An object containing widgets keyed by name. By default (when no `type` is given), strips are
1005
+ * [toolbars](https://bryntum.com/products/gantt/docs/api/Core/widget/Toolbar). If you want to pass an array, you can use
1006
+ * the toolbar's [items](https://bryntum.com/products/gantt/docs/api/Core/widget/Container#config-items).
1007
+ * ...
1008
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-strips)
1009
+ */
1010
+ strips? : Record<string, GanttContainerItemConfig>
1011
+ /**
1012
+ * An object containing sub grid configuration objects keyed by a `region` property.
1013
+ * By default, grid has a 'locked' region (if configured with locked columns) and a 'normal' region.
1014
+ * The 'normal' region defaults to use `flex: 1`.
1015
+ * ...
1016
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-subGridConfigs)
1017
+ */
1018
+ subGridConfigs? : Record<string, SubGridConfig>
1019
+ /**
1020
+ * Set to `true` to prevent auto calculating of a minimal [tickSize](https://bryntum.com/products/gantt/docs/api/Scheduler/view/mixin/TimelineEventRendering#property-tickSize)
1021
+ * to always fit the content to the screen size. Setting this property on `true` will disable [forceFit](https://bryntum.com/products/gantt/docs/api/Scheduler/view/TimelineBase#config-forceFit) behaviour.
1022
+ */
1023
+ suppressFit? : boolean
1024
+ /**
1025
+ * A [Mask](https://bryntum.com/products/gantt/docs/api/Core/widget/Mask) config object, or a message to be shown when Crud Manager
1026
+ * is persisting changes on the server. Set to `null` to disable default sync mask.
1027
+ * ...
1028
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-syncMask)
1029
+ */
1030
+ syncMask? : string|MaskConfig|null
1031
+ /**
1032
+ * 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
1033
+ * [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
1034
+ * this widget:
1035
+ * ...
1036
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-tab)
1037
+ */
1038
+ tab? : boolean|TabConfig
1039
+ /**
1040
+ * When this container is used as a tab in a TabPanel, these items are added to the
1041
+ * [TabBar](https://bryntum.com/products/gantt/docs/api/Core/widget/TabBar) when this container is the active tab.
1042
+ * ...
1043
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-tabBarItems)
1044
+ */
1045
+ tabBarItems? : ToolbarItems[]|Widget[]
1046
+ /**
1047
+ * An empty function by default, but provided so that you can override it. This function is called each time
1048
+ * a task is rendered into the gantt to render the contents of the task.
1049
+ * ...
1050
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-taskRenderer)
1051
+ * @param {object} detail An object containing the information needed to render a Task.
1052
+ * @param {Gantt.model.TaskModel} detail.taskRecord The task record.
1053
+ * @param {object} detail.renderData An object containing details about the task rendering.
1054
+ * @param {Core.helper.util.DomClassList,string} detail.renderData.cls An object whose property names represent the CSS class names to be added to the tasks's element. Set a property's value to truthy or falsy to add or remove the class name based on the property name. Using this technique, you do not have to know whether the class is already there, or deal with concatenation.
1055
+ * @param {string,Record<string, string>} detail.renderData.style Inline styles for the task bar DOM element. Use either 'border: 1px solid black' or { border: '1px solid black' }
1056
+ * @param {Core.helper.util.DomClassList,string} detail.renderData.wrapperCls An object whose property names represent the CSS class names to be added to the event wrapper element. Set a property's value to truthy or falsy to add or remove the class name based on the property name. Using this technique, you do not have to know whether the class is already there, or deal with concatenation.
1057
+ * @param {Core.helper.util.DomClassList,string} detail.renderData.iconCls An object whose property names represent the CSS class names to be added to a task icon element.
1058
+ * @param {Scheduler.model.TimeSpan[],TimeSpanConfig[]} indicators An array that can be populated with TimeSpan records or their config objects to have them rendered in the task row
1059
+ * @returns {string,DomConfig,DomConfig[]} A simple string, or a DomConfig object defining the actual HTML
1060
+ */
1061
+ taskRenderer? : (detail: { taskRecord: TaskModel, renderData: { cls: DomClassList|string, style: string|Record<string, string>, wrapperCls: DomClassList|string, iconCls: DomClassList|string } }, indicators: TimeSpan[]|TimeSpanConfig[]) => string|DomConfig|DomConfig[]
1062
+ /**
1063
+ * Inline tasks, will be loaded into an internally created TaskStore.
1064
+ */
1065
+ tasks? : TaskModel[]|TaskModelConfig[]
1066
+ /**
1067
+ * The [TaskStore](https://bryntum.com/products/gantt/docs/api/Gantt/data/TaskStore) holding the tasks to be rendered into the Gantt.
1068
+ */
1069
+ taskStore? : TaskStore|TaskStoreConfig
1070
+ /**
1071
+ * A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/gantt/docs/api/Core/widget/Toolbar),
1072
+ * or array of config objects representing the child items of a Toolbar.
1073
+ * This creates a toolbar docked to the top of the panel immediately below the header.
1074
+ * ...
1075
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-tbar)
1076
+ */
1077
+ tbar? : (GanttContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
1078
+ /**
1079
+ * CSS class used for terminals
1080
+ */
1081
+ terminalCls? : string
1082
+ /**
1083
+ * Delay in ms before hiding the terminals when the mouse leaves an event bar or terminal.
1084
+ * ...
1085
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-terminalHideDelay)
1086
+ */
1087
+ terminalHideDelay? : number
1088
+ /**
1089
+ * Terminal offset from their initial position, in px. Positive values move terminals further away from the
1090
+ * event bar, negative values inside the event bar.
1091
+ * ...
1092
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-terminalOffset)
1093
+ */
1094
+ terminalOffset? : number
1095
+ /**
1096
+ * Delay in ms before showing the terminals when hovering over an event bar.
1097
+ * ...
1098
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-terminalShowDelay)
1099
+ */
1100
+ terminalShowDelay? : number
1101
+ /**
1102
+ * Where (on event bar edges) to display terminals. The sides are `'start'`, `'top'`,
1103
+ * `'end'` and `'bottom'`
1104
+ */
1105
+ terminalSides? : string[]
1106
+ /**
1107
+ * Terminal diameter in px, overrides the default CSS value for it (which might depend on theme).
1108
+ * ...
1109
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-terminalSize)
1110
+ */
1111
+ terminalSize? : number|string
1112
+ /**
1113
+ * The width/height (depending on vertical / horizontal mode) of all the time columns.
1114
+ * ...
1115
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-tickSize)
1116
+ */
1117
+ tickSize? : number
1118
+ /**
1119
+ * A [TimeAxis](https://bryntum.com/products/gantt/docs/api/Scheduler/data/TimeAxis) config object or instance, used to create a backing data store of
1120
+ * 'ticks' providing the input date data for the time axis of timeline panel. Created automatically if none
1121
+ * supplied.
1122
+ */
1123
+ timeAxis? : TimeAxisConfig|TimeAxis
1124
+ /**
1125
+ * Inline time ranges, will be loaded into the backing project's time range store.
1126
+ */
1127
+ timeRanges? : TimeSpan[]|TimeSpanConfig[]
1128
+ /**
1129
+ * Gets/sets the current time resolution object, which contains a unit identifier and an increment count
1130
+ * `{ unit, increment }`. This value means minimal task duration you can create using UI.
1131
+ * ...
1132
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-timeResolution)
1133
+ */
1134
+ timeResolution? : {
1135
+ increment?: number
1136
+ unit?: DurationUnit
1137
+ }|number
1138
+ /**
1139
+ * Set to a time zone or a UTC offset. This will set the projects
1140
+ * [timeZone](https://bryntum.com/products/gantt/docs/api/Scheduler/model/ProjectModel#config-timeZone) config accordingly. As this config is only a referer,
1141
+ * please see project's config [documentation](https://bryntum.com/products/gantt/docs/api/Scheduler/model/ProjectModel#config-timeZone) for more
1142
+ * information.
1143
+ * ...
1144
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-timeZone)
1145
+ */
1146
+ timeZone? : string|number
1147
+ /**
1148
+ * A title to display in the header or owning TabPanel. Causes creation and docking of a header
1149
+ * to the top if no header is configured.
1150
+ * ...
1151
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-title)
1152
+ */
1153
+ title? : string
1154
+ /**
1155
+ * True to toggle the collapsed/expanded state when clicking a parent task bar.
1156
+ */
1157
+ toggleParentTasksOnClick? : boolean
1158
+ /**
1159
+ * 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
1160
+ * property name is the reference by which an instantiated tool may be retrieved from the live
1161
+ * `[tools](https://bryntum.com/products/gantt/docs/api/Core/widget/mixin/Toolable#property-tools)` property.
1162
+ * ...
1163
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-tools)
1164
+ */
1165
+ tools? : Record<string, ToolConfig>|null
1166
+ /**
1167
+ * A template function allowing you to configure the contents of the tooltip shown when hovering a
1168
+ * dependency line. You can return either an HTML string or a [DomConfig](https://bryntum.com/products/gantt/docs/api/Core/helper/DomHelper#typedef-DomConfig) object.
1169
+ * @param {Scheduler.model.DependencyBaseModel} dependency The dependency record
1170
+ * @returns {string,DomConfig}
1171
+ */
1172
+ tooltipTemplate? : (dependency: DependencyBaseModel) => string|DomConfig
1173
+ /**
1174
+ * Configure UI transitions for various actions in the grid.
1175
+ */
1176
+ transition? : {
1177
+ insertRecord?: boolean
1178
+ removeRecord?: boolean
1179
+ toggleColumn?: boolean
1180
+ expandCollapseColumn?: boolean
1181
+ toggleRegion?: boolean
1182
+ toggleTreeNode?: boolean
1183
+ toggleGroup?: boolean
1184
+ filterRemoval?: boolean
1185
+ removeEvent?: boolean
1186
+ changeEvent?: boolean
1187
+ }
1188
+ /**
1189
+ * Animation transition duration in milliseconds.
1190
+ */
1191
+ transitionDuration? : number
1192
+ type? : 'gantt'
1193
+ /**
1194
+ * Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
1195
+ * as a space separated string, an array of strings, or as an object in which property names with truthy
1196
+ * values are used as the class names.
1197
+ * ...
1198
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-ui)
1199
+ */
1200
+ ui? : 'plain'|'toolbar'|string|object
1201
+ /**
1202
+ * By default, the day of week and week of month of the event's start date are used to create
1203
+ * helpful contextual recurrence types when editing a non-recurring event record and choosing
1204
+ * an initial recurrence type.
1205
+ * ...
1206
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-useContextualRecurrenceRules)
1207
+ */
1208
+ useContextualRecurrenceRules? : boolean
1209
+ /**
1210
+ * A string key used to lookup a predefined [ViewPreset](https://bryntum.com/products/gantt/docs/api/Scheduler/preset/ViewPreset) (e.g. 'weekAndDay', 'hourAndDay'),
1211
+ * managed by [PresetManager](https://bryntum.com/products/gantt/docs/api/Scheduler/preset/PresetManager). See [PresetManager](#Scheduler/preset/PresetManager) for more information.
1212
+ * Or a config object for a viewPreset.
1213
+ * ...
1214
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-viewPreset)
1215
+ */
1216
+ viewPreset? : string|ViewPresetConfig
1217
+ /**
1218
+ * A date to bring into view initially on the scrollable timeline.
1219
+ * ...
1220
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-visibleDate)
1221
+ */
1222
+ visibleDate? : Date|VisibleDate
1223
+ /**
1224
+ * Integer number indicating the size of timespan during zooming. When zooming, the timespan is adjusted to make
1225
+ * the scrolling area `visibleZoomFactor` times wider than the timeline area itself. Used in
1226
+ * [zoomToSpan](https://bryntum.com/products/gantt/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomToSpan) and [zoomToLevel](#Scheduler/view/mixin/TimelineZoomable#function-zoomToLevel) functions.
1227
+ */
1228
+ visibleZoomFactor? : number
1229
+ /**
1230
+ * A valid JS day index between 0-6 (0: Sunday, 1: Monday etc.) to be considered the start day of the week.
1231
+ * When omitted, the week start day is retrieved from the active locale class.
1232
+ */
1233
+ weekStartDay? : number
1234
+ /**
1235
+ * A widgets weight determines its position among siblings when added to a [Container](https://bryntum.com/products/gantt/docs/api/Core/widget/Container).
1236
+ * Higher weights go further down.
1237
+ */
1238
+ weight? : number
1239
+ /**
1240
+ * Widget's width, used to set element `style.width`. Either specify a valid width string or a number, which
1241
+ * will get 'px' appended. We recommend using CSS as the primary way to control width, but in some cases
1242
+ * this config is convenient.
1243
+ */
1244
+ width? : string|number
1245
+ /**
1246
+ * An object with format `{ fromDay, toDay, fromHour, toHour }` that describes the working days and hours.
1247
+ * This object will be used to populate TimeAxis [include](https://bryntum.com/products/gantt/docs/api/Scheduler/data/TimeAxis#config-include) property.
1248
+ * ...
1249
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#config-workingTime)
1250
+ */
1251
+ workingTime? : {
1252
+ fromDay?: number
1253
+ toDay?: number
1254
+ fromHour?: number
1255
+ toHour?: number
1256
+ }
1257
+ /**
1258
+ * Whether the originally rendered timespan should be preserved while zooming. By default, it is set to `false`,
1259
+ * meaning the timeline panel will adjust the currently rendered timespan to limit the amount of HTML content to
1260
+ * render. When setting this option to `true`, be careful not to allow to zoom a big timespan in seconds
1261
+ * resolution for example. That will cause <strong>a lot</strong> of HTML content to be rendered and affect performance. You
1262
+ * can use [minZoomLevel](https://bryntum.com/products/gantt/docs/api/Scheduler/view/mixin/TimelineZoomable#config-minZoomLevel) and [maxZoomLevel](#Scheduler/view/mixin/TimelineZoomable#config-maxZoomLevel) config options for that.
1263
+ */
1264
+ zoomKeepsOriginalTimespan? : boolean
1265
+ /**
1266
+ * If true, you can zoom in and out on the time axis using CTRL-key + mouse wheel.
1267
+ */
1268
+ zoomOnMouseWheel? : boolean
1269
+ /**
1270
+ * True to zoom to time span when double-clicking a time axis cell.
1271
+ */
1272
+ zoomOnTimeAxisDoubleClick? : boolean
1273
+
1274
+ // Events
1275
+ /**
1276
+ * Fired on the owning Scheduler/Gantt after a dependency drag creation operation finished, no matter to outcome
1277
+ * @param {object} event Event object
1278
+ * @param {Scheduler.model.TimeSpan} event.source The source task
1279
+ * @param {Scheduler.model.TimeSpan} event.target The target task
1280
+ * @param {Scheduler.model.DependencyBaseModel} event.dependency The created dependency
1281
+ */
1282
+ onAfterDependencyCreateDrop? : ((event: { source: TimeSpan, target: TimeSpan, dependency: DependencyBaseModel }) => void)|string
1283
+ /**
1284
+ * Fires on the owning Scheduler or Gantt widget after a dependency is successfully saved using the
1285
+ * dependency edit popup
1286
+ * @param {object} event Event object
1287
+ * @param {Scheduler.view.Scheduler} event.source The scheduler instance or Gantt instance
1288
+ * @param {Scheduler.model.SchedulerDependencyModel} event.dependencyRecord The dependency about to be saved
1289
+ */
1290
+ onAfterDependencySave? : ((event: { source: Scheduler, dependencyRecord: SchedulerDependencyModel }) => void)|string
1291
+ /**
1292
+ * Fires on the owning Gantt at the end of the drag create gesture whether or not
1293
+ * a task was scheduled by the gesture.
1294
+ * @param {object} event Event object
1295
+ * @param {Gantt.view.Gantt} event.source
1296
+ * @param {HTMLElement} event.proxyElement The element showing the drag creation zone.
1297
+ */
1298
+ onAfterDragCreate? : ((event: { source: Gantt, proxyElement: HTMLElement }) => void)|string
1299
+ /**
1300
+ * Fires on the owning Scheduler after editor is closed by any action - save, delete or cancel
1301
+ * @param {object} event Event object
1302
+ * @param {Scheduler.view.Scheduler} event.source The scheduler
1303
+ * @param {'save','delete','cancel'} event.action The action that was taken to end the edit. One of 'save', 'delete' or 'cancel'
1304
+ * @param {Scheduler.feature.EventEdit} event.eventEdit The eventEdit feature
1305
+ * @param {Scheduler.model.SchedulerEventModel} event.eventRecord The record that has been edited.
1306
+ * @param {Scheduler.model.SchedulerResourceModel} event.resourceRecord The Resource record for the event. If the event is being created, it will not contain a resource, so this parameter specifies the resource the event is being created for.
1307
+ * @param {HTMLElement} event.eventElement The element which represents the event in the scheduler display.
1308
+ * @param {Core.widget.Popup} event.editor The editor
1309
+ */
1310
+ onAfterEventEdit? : ((event: { source: Scheduler, action: 'save'|'delete'|'cancel', eventEdit: EventEdit, eventRecord: SchedulerEventModel, resourceRecord: SchedulerResourceModel, eventElement: HTMLElement, editor: Popup }) => void)|string
1311
+ /**
1312
+ * Fires on the owning Scheduler or Gantt widget instance after an event record is saved
1313
+ * @param {object} event Event object
1314
+ * @param {SchedulerPro.view.SchedulerPro} event.source The Scheduler Pro instance
1315
+ * @param {SchedulerPro.model.EventModel} event.eventRecord The event record about to be saved
1316
+ * @param {SchedulerPro.widget.TaskEditorBase} event.editor The editor widget
1317
+ */
1318
+ onAfterEventSave? : ((event: { source: SchedulerPro, eventRecord: EventModel, editor: TaskEditorBase }) => void)|string
1319
+ /**
1320
+ * Fires on the owning Gantt widget instance after project editing is finished by applying changes or
1321
+ * cancelling them.
1322
+ * @param {object} event Event object
1323
+ * @param {Gantt.view.Gantt} event.source The Gantt instance
1324
+ * @param {Gantt.model.ProjectModel} event.projectRecord The edited project record
1325
+ * @param {Gantt.widget.ProjectEditor} event.editor The editor widget
1326
+ */
1327
+ onAfterProjectEdit? : ((event: { source: Gantt, projectRecord: ProjectModel, editor: ProjectEditor }) => void)|string
1328
+ /**
1329
+ * Fires on the owning Gantt widget instance after a project is saved
1330
+ * @param {object} event Event object
1331
+ * @param {Gantt.view.Gantt} event.source The Gantt instance
1332
+ * @param {Gantt.model.ProjectModel} event.projectRecord The project about to be saved
1333
+ * @param {Gantt.widget.ProjectEditor} event.editor The editor widget
1334
+ */
1335
+ onAfterProjectSave? : ((event: { source: Gantt, projectRecord: ProjectModel, editor: ProjectEditor }) => void)|string
1336
+ /**
1337
+ * Fires on the owning Gantt after a task drop, regardless if the drop validity
1338
+ * @param {object} event Event object
1339
+ * @param {Gantt.view.Gantt} event.source
1340
+ * @param {Gantt.model.TaskModel[]} event.taskRecords
1341
+ * @param {boolean} event.valid
1342
+ */
1343
+ onAfterTaskDrop? : ((event: { source: Gantt, taskRecords: TaskModel[], valid: boolean }) => void)|string
1344
+ /**
1345
+ * Fires on the owning Scheduler or Gantt widget instance after task editing is finished by applying changes, cancelling them
1346
+ * or deleting the task record.
1347
+ * @param {object} event Event object
1348
+ * @param {SchedulerPro.view.SchedulerPro} event.source The Scheduler Pro instance
1349
+ * @param {SchedulerPro.model.EventModel} event.taskRecord Task record used in the task editor
1350
+ * @param {SchedulerPro.widget.TaskEditorBase} event.editor The editor widget
1351
+ */
1352
+ onAfterTaskEdit? : ((event: { source: SchedulerPro, taskRecord: EventModel, editor: TaskEditorBase }) => void)|string
1353
+ /**
1354
+ * Fires on the owning Scheduler or Gantt widget instance after a task is saved
1355
+ * @param {object} event Event object
1356
+ * @param {SchedulerPro.view.SchedulerPro} event.source The Scheduler Pro instance
1357
+ * @param {SchedulerPro.model.EventModel} event.taskRecord The task about to be saved
1358
+ * @param {SchedulerPro.widget.TaskEditorBase} event.editor The editor widget
1359
+ */
1360
+ onAfterTaskSave? : ((event: { source: SchedulerPro, taskRecord: EventModel, editor: TaskEditorBase }) => void)|string
1361
+ /**
1362
+ * Fires on the owning Gantt after a task drop, regardless if the drop validity
1363
+ * @param {object} event Event object
1364
+ * @param {Gantt.view.Gantt} event.source
1365
+ * @param {Gantt.model.TaskModel[]} event.taskRecords Dropped segments
1366
+ * @param {boolean} event.valid
1367
+ */
1368
+ onAfterTaskSegmentDrop? : ((event: { source: Gantt, taskRecords: TaskModel[], valid: boolean }) => void)|string
1369
+ /**
1370
+ * Fires before an assignment is removed. Can be triggered by user pressing [DELETE] or [BACKSPACE] or
1371
+ * by the event editor. Can for example be used to display a custom dialog to confirm deletion, in which
1372
+ * case records should be "manually" removed after confirmation:
1373
+ * ...
1374
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#event-beforeAssignmentDelete)
1375
+ * @param {object} event Event object
1376
+ * @param {Scheduler.view.Scheduler} event.source The Scheduler instance
1377
+ * @param {Scheduler.model.SchedulerAssignmentModel[]} event.assignmentRecords The assignment records about to be deleted
1378
+ * @param {object} event.context Additional removal context:
1379
+ * @param {Function} event.context.finalize Function to call to finalize the removal. Used to asynchronously decide to remove the records or not. Provide `false` to the function to prevent the removal.
1380
+ * @param {boolean} event.context.finalize.removeRecords Provide `false` to the function to prevent the removal.
1381
+ */
1382
+ onBeforeAssignmentDelete? : ((event: { source: Scheduler, assignmentRecords: SchedulerAssignmentModel[], context: { finalize: { removeRecords?: boolean } } }) => Promise<boolean>|boolean|void)|string
1383
+ /**
1384
+ * Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
1385
+ * @param {object} event Event object
1386
+ * @param {Grid.view.Grid} event.source Owner grid
1387
+ * @param {Grid.util.GridLocation} event.editorContext Editing context
1388
+ */
1389
+ onBeforeCancelCellEdit? : ((event: { source: Grid, editorContext: GridLocation }) => Promise<boolean>|boolean|void)|string
1390
+ /**
1391
+ * 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.
1392
+ * ...
1393
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#event-beforeCancelRowEdit)
1394
+ * @param {object} event Event object
1395
+ * @param {Grid.view.Grid} event.grid Target grid
1396
+ * @param {RowEditorContext} event.editorContext Editing context
1397
+ */
1398
+ onBeforeCancelRowEdit? : ((event: { grid: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string
1399
+ /**
1400
+ * Fires on the owning Grid before editing starts, return `false` to prevent editing
1401
+ * @param {object} event Event object
1402
+ * @param {Grid.view.Grid} event.source Owner grid
1403
+ * @param {CellEditorContext} event.editorContext Editing context
1404
+ */
1405
+ onBeforeCellEditStart? : ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
1406
+ /**
1407
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
1408
+ * buttons while [autoEdit](https://bryntum.com/products/gantt/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
1409
+ * @param {object} event Event object
1410
+ * @param {Grid.view.Grid} event.source Owner grid
1411
+ * @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).
1412
+ */
1413
+ onBeforeCellRangeDelete? : ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => Promise<boolean>|boolean|void)|string
1414
+ /**
1415
+ * Fires for each selected record on the owning Grid before editing a range of selected cell values
1416
+ * @param {object} event Event object
1417
+ * @param {Core.data.Model} event.record Current selected record from the range
1418
+ * @param {string} event.field The field being changed
1419
+ * @param {any} event.value The value being set
1420
+ */
1421
+ onBeforeCellRangeEdit? : ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
1422
+ /**
1423
+ * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
1424
+ * @param {object} event Event object
1425
+ * @param {Grid.view.Grid} event.source The grid instance.
1426
+ * @param {Grid.column.Column} event.column The dragged column.
1427
+ * @param {Event} event.event The browser event.
1428
+ */
1429
+ onBeforeColumnDragStart? : ((event: { source: Grid, column: Column, event: Event }) => Promise<boolean>|boolean|void)|string
1430
+ /**
1431
+ * This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
1432
+ * @param {object} event Event object
1433
+ * @param {Grid.view.Grid} event.source The grid instance.
1434
+ * @param {Grid.column.Column} event.column The dragged column.
1435
+ * @param {Grid.column.Column} event.insertBefore The column before which the dragged column will be inserted.
1436
+ * @param {Grid.column.Column} event.newParent The new parent column.
1437
+ * @param {Event} event.event The browser event.
1438
+ * @param {string} event.region The region where the column was dropped.
1439
+ */
1440
+ onBeforeColumnDropFinalize? : ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => Promise<boolean>|boolean|void)|string
1441
+ /**
1442
+ * This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
1443
+ * `false`.
1444
+ * @param {object} event Event object
1445
+ * @param {Grid.view.Grid} event.source The grid instance
1446
+ * @param {Grid.column.Column} event.column The column
1447
+ * @param {Event} event.domEvent The browser event
1448
+ */
1449
+ onBeforeColumnResize? : ((event: { source: Grid, column: Column, domEvent: Event }) => Promise<boolean>|boolean|void)|string
1450
+ /**
1451
+ * Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
1452
+ * @param {object} event Event object
1453
+ * @param {Grid.view.Grid} event.source Owner grid
1454
+ * @param {Grid.util.GridLocation[]} event.cells The cells about to be copied or cut
1455
+ * @param {string} event.data The string data about to be copied or cut
1456
+ * @param {boolean} event.isCut `true` if this is a cut action
1457
+ * @param {string} event.entityName 'cell' to distinguish this event from other beforeCopy events
1458
+ */
1459
+ onBeforeCopy? : ((event: { source: Grid, cells: GridLocation[], data: string, isCut: boolean, entityName: string }) => Promise<boolean>|boolean|void)|string
1460
+ /**
1461
+ * Fires on the owning Grid before CSV export starts. Return `false` to cancel the export.
1462
+ * @param {object} event Event object
1463
+ * @param {ExportConfig} event.config Export config
1464
+ * @param {Grid.column.Column[]} event.columns An array of columns to export
1465
+ * @param {Core.data.Model[]} event.rows An array of records to export
1466
+ * @param {string} event.lineDelimiter The CSV delimiter to separate lines
1467
+ * @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
1468
+ */
1469
+ onBeforeCSVExport? : ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => Promise<boolean>|boolean|void)|string
1470
+ /**
1471
+ * Fires on the owning Scheduler or Gantt widget before a dependency is added from the dependency
1472
+ * edit popup
1473
+ * @param {object} event Event object
1474
+ * @param {Scheduler.view.Scheduler} event.source The scheduler or Gantt instance
1475
+ * @param {Scheduler.feature.SchedulerDependencyEdit} event.dependencyEdit The dependency edit feature
1476
+ * @param {Scheduler.model.SchedulerDependencyModel} event.dependencyRecord The dependency about to be added
1477
+ */
1478
+ onBeforeDependencyAdd? : ((event: { source: Scheduler, dependencyEdit: SchedulerDependencyEdit, dependencyRecord: SchedulerDependencyModel }) => Promise<boolean>|boolean|void)|string
1479
+ /**
1480
+ * Fired on the owning Scheduler/Gantt before a dependency creation drag operation starts. Return `false` to
1481
+ * prevent it
1482
+ * @param {object} event Event object
1483
+ * @param {Scheduler.model.TimeSpan} event.source The source task
1484
+ */
1485
+ onBeforeDependencyCreateDrag? : ((event: { source: TimeSpan }) => Promise<boolean>|boolean|void)|string
1486
+ /**
1487
+ * Fired on the owning Scheduler/Gantt when a dependency drag creation operation is about to finalize
1488
+ * @param {object} event Event object
1489
+ * @param {Scheduler.model.TimeSpan} event.source The source task
1490
+ * @param {Scheduler.model.TimeSpan} event.target The target task
1491
+ * @param {'start','end','top','bottom'} event.fromSide The from side (start / end / top / bottom)
1492
+ * @param {'start','end','top','bottom'} event.toSide The to side (start / end / top / bottom)
1493
+ */
1494
+ onBeforeDependencyCreateFinalize? : ((event: { source: TimeSpan, target: TimeSpan, fromSide: 'start'|'end'|'top'|'bottom', toSide: 'start'|'end'|'top'|'bottom' }) => Promise<boolean>|boolean|void)|string
1495
+ /**
1496
+ * Fires on the owning Scheduler or Gantt widget before a dependency is deleted from the dependency
1497
+ * edit popup, or when clicking the delete icon on a selected dependency line.
1498
+ * @param {object} event Event object
1499
+ * @param {Scheduler.view.Scheduler} event.source The scheduler instance
1500
+ * @param {Scheduler.model.SchedulerDependencyModel} event.dependencyRecord The dependency record about to be deleted
1501
+ */
1502
+ onBeforeDependencyDelete? : ((event: { source: Scheduler, dependencyRecord: SchedulerDependencyModel }) => Promise<boolean>|boolean|void)|string
1503
+ /**
1504
+ * Fires on the owning Scheduler or Gantt widget before an dependency is displayed in the editor.
1505
+ * This may be listened for to allow an application to take over dependency editing duties. Return `false` to
1506
+ * stop the default editing UI from being shown or a `Promise` yielding `true` or `false` for async vetoing.
1507
+ * @param {object} event Event object
1508
+ * @param {Scheduler.view.Scheduler} event.source The scheduler or Gantt instance
1509
+ * @param {Scheduler.feature.SchedulerDependencyEdit} event.dependencyEdit The dependencyEdit feature
1510
+ * @param {Scheduler.model.SchedulerDependencyModel} event.dependencyRecord The record about to be shown in the editor.
1511
+ */
1512
+ onBeforeDependencyEdit? : ((event: { source: Scheduler, dependencyEdit: SchedulerDependencyEdit, dependencyRecord: SchedulerDependencyModel }) => Promise<boolean>|boolean|void)|string
1513
+ /**
1514
+ * Fires on the owning Scheduler or Gantt widget when the editor for a dependency is available, but before it is shown. Allows
1515
+ * manipulating fields before the widget is shown.
1516
+ * @param {object} event Event object
1517
+ * @param {Scheduler.view.Scheduler} event.source The scheduler or Gantt instance
1518
+ * @param {Scheduler.feature.SchedulerDependencyEdit} event.dependencyEdit The dependencyEdit feature
1519
+ * @param {Scheduler.model.SchedulerDependencyModel} event.dependencyRecord The record about to be shown in the editor.
1520
+ * @param {Core.widget.Popup} event.editor The editor popup
1521
+ */
1522
+ onBeforeDependencyEditShow? : ((event: { source: Scheduler, dependencyEdit: SchedulerDependencyEdit, dependencyRecord: SchedulerDependencyModel, editor: Popup }) => void)|string
1523
+ /**
1524
+ * Fires on the owning Scheduler or Gantt widget before a dependency is saved using the dependency edit popup
1525
+ * @param {object} event Event object
1526
+ * @param {Scheduler.view.Scheduler} event.source The scheduler or Gantt instance
1527
+ * @param {Scheduler.model.SchedulerDependencyModel} event.dependencyRecord The dependency about to be saved
1528
+ * @param {object} event.values The new values
1529
+ */
1530
+ onBeforeDependencySave? : ((event: { source: Scheduler, dependencyRecord: SchedulerDependencyModel, values: object }) => Promise<boolean>|boolean|void)|string
1531
+ /**
1532
+ * Fires before an object is destroyed.
1533
+ * @param {object} event Event object
1534
+ * @param {Core.Base} event.source The Object that is being destroyed.
1535
+ */
1536
+ onBeforeDestroy? : ((event: { source: Base }) => void)|string
1537
+ /**
1538
+ * Fires on the owning Gantt at the beginning of the drag gesture
1539
+ * @param {object} event Event object
1540
+ * @param {Gantt.view.Gantt} event.source
1541
+ * @param {Gantt.model.TaskModel} event.taskRecord
1542
+ * @param {Date} event.date The datetime associated with the drag start point.
1543
+ */
1544
+ onBeforeDragCreate? : ((event: { source: Gantt, taskRecord: TaskModel, date: Date }) => void)|string
1545
+ /**
1546
+ * Fires on the owning Gantt to allow implementer to prevent immediate finalization by setting `data.context.async = true`
1547
+ * in the listener, to show a confirmation popup etc
1548
+ * ...
1549
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#event-beforeDragCreateFinalize)
1550
+ * @param {object} event Event object
1551
+ * @param {Gantt.view.Gantt} event.source Scheduler instance
1552
+ * @param {HTMLElement} event.proxyElement Proxy element, representing future event
1553
+ * @param {object} event.context
1554
+ * @param {boolean} event.context.async Set true to handle drag create asynchronously (e.g. to wait for user confirmation)
1555
+ * @param {Function} event.context.finalize Call this method to finalize drag create. This method accepts one argument: pass true to update records, or false, to ignore changes
1556
+ */
1557
+ onBeforeDragCreateFinalize? : ((event: { source: Gantt, proxyElement: HTMLElement, context: { async: boolean, finalize: Function } }) => void)|string
1558
+ /**
1559
+ * Fires before an event is removed. Can be triggered by user pressing [DELETE] or [BACKSPACE] or by the
1560
+ * event editor. Return `false` to immediately veto the removal (or a `Promise` yielding `true` or `false`
1561
+ * for async vetoing).
1562
+ * ...
1563
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#event-beforeEventDelete)
1564
+ * @param {object} event Event object
1565
+ * @param {Scheduler.view.Scheduler,any} event.source The Scheduler instance
1566
+ * @param {Scheduler.model.SchedulerEventModel[]} event.eventRecords The records about to be deleted
1567
+ * @param {object} event.context Additional removal context:
1568
+ * @param {Function} event.context.finalize Function to call to finalize the removal. Used to asynchronously decide to remove the records or not. Provide `false` to the function to prevent the removal.
1569
+ * @param {boolean} event.context.finalize.removeRecords Provide `false` to the function to prevent the removal.
1570
+ */
1571
+ onBeforeEventDelete? : ((event: { source: Scheduler|any, eventRecords: SchedulerEventModel[], context: { finalize: { removeRecords?: boolean } } }) => Promise<boolean>|boolean|void)|string
1572
+ /**
1573
+ * Fires on the owning Scheduler before an event is displayed in an editor.
1574
+ * This may be listened for to allow an application to take over event editing duties. Returning `false`
1575
+ * stops the default editing UI from being shown.
1576
+ * ...
1577
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#event-beforeEventEdit)
1578
+ * @param {object} event Event object
1579
+ * @param {Scheduler.view.Scheduler} event.source The scheduler
1580
+ * @param {Scheduler.feature.EventEdit} event.eventEdit The eventEdit feature
1581
+ * @param {Scheduler.model.SchedulerEventModel} event.eventRecord The record about to be shown in the event editor.
1582
+ * @param {Scheduler.model.SchedulerResourceModel} event.resourceRecord The Resource record for the event. If the event is being created, it will not contain a resource, so this parameter specifies the resource the event is being created for.
1583
+ * @param {HTMLElement} event.eventElement The element which represents the event in the scheduler display.
1584
+ */
1585
+ onBeforeEventEdit? : ((event: { source: Scheduler, eventEdit: EventEdit, eventRecord: SchedulerEventModel, resourceRecord: SchedulerResourceModel, eventElement: HTMLElement }) => Promise<boolean>|boolean|void)|string
1586
+ /**
1587
+ * Fires on the owning Scheduler when the editor for an event is available but before it is populated with
1588
+ * data and shown. Allows manipulating fields etc.
1589
+ * @param {object} event Event object
1590
+ * @param {Scheduler.view.Scheduler} event.source The scheduler
1591
+ * @param {Scheduler.feature.EventEdit} event.eventEdit The eventEdit feature
1592
+ * @param {Scheduler.model.SchedulerEventModel} event.eventRecord The record about to be shown in the event editor.
1593
+ * @param {Scheduler.model.SchedulerResourceModel} event.resourceRecord The Resource record for the event. If the event is being created, it will not contain a resource, so this parameter specifies the resource the event is being created for.
1594
+ * @param {HTMLElement} event.eventElement The element which represents the event in the scheduler display.
1595
+ * @param {Core.widget.Popup} event.editor The editor
1596
+ */
1597
+ onBeforeEventEditShow? : ((event: { source: Scheduler, eventEdit: EventEdit, eventRecord: SchedulerEventModel, resourceRecord: SchedulerResourceModel, eventElement: HTMLElement, editor: Popup }) => void)|string
1598
+ /**
1599
+ * Fired on the owning Scheduler before resizing starts. Return `false` to prevent the action.
1600
+ * @param {object} event Event object
1601
+ * @param {Scheduler.view.Scheduler} event.source Scheduler instance
1602
+ * @param {Scheduler.model.SchedulerEventModel} event.eventRecord Event record being resized
1603
+ * @param {Scheduler.model.SchedulerResourceModel} event.resourceRecord Resource record the resize starts within
1604
+ * @param {MouseEvent} event.event Browser event
1605
+ */
1606
+ onBeforeEventResize? : ((event: { source: Scheduler, eventRecord: SchedulerEventModel, resourceRecord: SchedulerResourceModel, event: MouseEvent }) => Promise<boolean>|boolean|void)|string
1607
+ /**
1608
+ * Fired on the owning Scheduler to allow implementer to prevent immediate finalization by returning a promise
1609
+ * in the listener, to show a confirmation popup etc
1610
+ * ...
1611
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#event-beforeEventResizeFinalize)
1612
+ * @param {object} event Event object
1613
+ * @param {Scheduler.view.Scheduler} event.source Scheduler instance
1614
+ * @param {object} event.context [DEPRECATED] de-nested to outer params object
1615
+ * @param {Scheduler.model.SchedulerEventModel} event.eventRecord Event record being resized
1616
+ * @param {Date} event.startDate New startDate (changed if resizing start side)
1617
+ * @param {Date} event.endDate New endDate (changed if resizing end side)
1618
+ * @param {Date} event.originalStartDate Start date before resize
1619
+ * @param {Date} event.originalEndDate End date before resize
1620
+ * @param {boolean} event.async Set true to handle resize asynchronously (e.g. to wait for user confirmation)
1621
+ * @param {Function} event.finalize Call this method to finalize resize. This method accepts one argument: pass `true` to update records, or `false`, to ignore changes
1622
+ * @param {Event} event.event Browser event
1623
+ * @param {EventResizeData[]} event.resizeData Data of all events that are being resized
1624
+ */
1625
+ onBeforeEventResizeFinalize? : ((event: { source: Scheduler, context: object, eventRecord: SchedulerEventModel, startDate: Date, endDate: Date, originalStartDate: Date, originalEndDate: Date, async: boolean, finalize: Function, event: Event, resizeData: EventResizeData[] }) => Promise<void>)|string
1626
+ /**
1627
+ * Fires on the owning Scheduler or Gantt widget instance before an event record is saved, return `false` to prevent it.
1628
+ * ...
1629
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#event-beforeEventSave)
1630
+ * @param {object} event Event object
1631
+ * @param {SchedulerPro.view.SchedulerPro} event.source The Scheduler Pro instance
1632
+ * @param {SchedulerPro.model.EventModel} event.eventRecord The event record about to be saved
1633
+ * @param {SchedulerPro.widget.TaskEditorBase} event.editor The editor widget
1634
+ */
1635
+ onBeforeEventSave? : ((event: { source: SchedulerPro, eventRecord: EventModel, editor: TaskEditorBase }) => Promise<boolean>|boolean|void)|string
1636
+ /**
1637
+ * Fired on the owning Scheduler Pro before resizing starts. Return `false` to prevent the action.
1638
+ * @param {object} event Event object
1639
+ * @param {SchedulerPro.view.SchedulerPro} event.source Scheduler Pro instance
1640
+ * @param {SchedulerPro.model.EventModel} event.eventRecord Segment being resized
1641
+ * @param {SchedulerPro.model.SchedulerProResourceModel} event.resourceRecord Resource record the resize starts within
1642
+ * @param {MouseEvent} event.event Browser event
1643
+ */
1644
+ onBeforeEventSegmentResize? : ((event: { source: SchedulerPro, eventRecord: EventModel, resourceRecord: SchedulerProResourceModel, event: MouseEvent }) => Promise<boolean>|boolean|void)|string
1645
+ /**
1646
+ * Fired on the owning Scheduler Pro to allow implementer to prevent immediate finalization by setting
1647
+ * `data.context.async = true` in the listener, to show a confirmation popup etc
1648
+ * ...
1649
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#event-beforeEventSegmentResizeFinalize)
1650
+ * @param {object} event Event object
1651
+ * @param {SchedulerPro.view.SchedulerPro} event.source Scheduler Pro instance
1652
+ * @param {object} event.context
1653
+ * @param {boolean} event.context.async Set true to handle resize asynchronously (e.g. to wait for user confirmation)
1654
+ * @param {Function} event.context.finalize Call this method to finalize resize. This method accepts one argument: pass `true` to update records, or `false`, to ignore changes
1655
+ */
1656
+ onBeforeEventSegmentResizeFinalize? : ((event: { source: SchedulerPro, context: { async: boolean, finalize: Function } }) => void)|string
1657
+ /**
1658
+ * Fires on the owning Grid before Excel export starts. Return `false` to cancel the export.
1659
+ * @param {object} event Event object
1660
+ * @param {ExportConfig} event.config Export config
1661
+ * @param {XLSColumn[]} event.columns An array of columns to export
1662
+ * @param {any[][]} event.rows An array of records to export
1663
+ */
1664
+ onBeforeExcelExport? : ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => Promise<boolean>|boolean|void)|string
1665
+ /**
1666
+ * Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
1667
+ * @param {object} event Event object
1668
+ * @param {Grid.util.GridLocation} event.cell Information about the column / record
1669
+ * @param {MouseEvent} event.domEvent The raw DOM event
1670
+ */
1671
+ onBeforeFillHandleDragStart? : ((event: { cell: GridLocation, domEvent: MouseEvent }) => Promise<boolean>|boolean|void)|string
1672
+ /**
1673
+ * 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.
1674
+ * @param {object} event Event object
1675
+ * @param {Grid.view.Grid} event.grid Target grid
1676
+ * @param {CellEditorContext} event.editorContext Editing context
1677
+ */
1678
+ onBeforeFinishCellEdit? : ((event: { grid: Grid, editorContext: CellEditorContext }) => void)|string
1679
+ /**
1680
+ * 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.
1681
+ * ...
1682
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#event-beforeFinishRowEdit)
1683
+ * @param {object} event Event object
1684
+ * @param {Grid.view.Grid} event.grid Target grid
1685
+ * @param {RowEditorContext} event.editorContext Editing context
1686
+ */
1687
+ onBeforeFinishRowEdit? : ((event: { grid: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string
1688
+ /**
1689
+ * Triggered before a widget is hidden. Return `false` to prevent the action.
1690
+ * @param {object} event Event object
1691
+ * @param {Core.widget.Widget} event.source The widget being hidden.
1692
+ */
1693
+ onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
1694
+ /**
1695
+ * Fires on the owning Gantt before export starts. Return `false` to cancel the export.
1696
+ * @param {object} event Event object
1697
+ * @param {object} event.config Export config
1698
+ */
1699
+ onBeforeMspExport? : ((event: { config: object }) => Promise<boolean>|boolean|void)|string
1700
+ /**
1701
+ * Fires on the owning Scheduler or Gantt widget before pan starts. Return `false` to prevent the operation.
1702
+ * @param {object} event Event object
1703
+ * @param {Event} event.event The native browser DOM event
1704
+ */
1705
+ onBeforePan? : ((event: { event: Event }) => Promise<boolean>|boolean|void)|string
1706
+ /**
1707
+ * Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
1708
+ * @param {object} event Event object
1709
+ * @param {Grid.view.Grid} event.source Owner grid
1710
+ * @param {string} event.clipboardData The clipboardData about to be pasted
1711
+ * @param {Grid.util.GridLocation} event.targetCell The cell from which the paste will be started
1712
+ * @param {string} event.entityName 'cell' to distinguish this event from other beforePaste events
1713
+ * @param {string} event.text The raw text from clipboard
1714
+ */
1715
+ onBeforePaste? : ((event: { source: Grid, clipboardData: string, targetCell: GridLocation, entityName: string, text: string }) => Promise<boolean>|boolean|void)|string
1716
+ /**
1717
+ * Fires on the owning Grid before export started. Return `false` to cancel the export.
1718
+ * @param {object} event Event object
1719
+ * @param {object} event.config Export config
1720
+ */
1721
+ onBeforePdfExport? : ((event: { config: object }) => Promise<boolean>|boolean|void)|string
1722
+ /**
1723
+ * Fired before the [viewPreset](https://bryntum.com/products/gantt/docs/api/Scheduler/view/mixin/TimelineViewPresets#config-viewPreset) is changed.
1724
+ * @param {object} event Event object
1725
+ * @param {Scheduler.view.Scheduler} event.source This Scheduler instance.
1726
+ * @param {Date} event.startDate The new start date of the timeline.
1727
+ * @param {Date} event.endDate The new end date of the timeline.
1728
+ * @param {Scheduler.preset.ViewPreset} event.from The outgoing ViewPreset.
1729
+ * @param {Scheduler.preset.ViewPreset} event.to The ViewPreset being switched to.
1730
+ */
1731
+ onBeforePresetChange? : ((event: { source: Scheduler, startDate: Date, endDate: Date, from: ViewPreset, to: ViewPreset }) => Promise<boolean>|boolean|void)|string
1732
+ /**
1733
+ * Fires on the owning Gantt widget instance before a project is displayed in the editor.
1734
+ * This may be listened to in order to take over the project editing flow. Returning `false`
1735
+ * stops the default editing UI from being shown.
1736
+ * ...
1737
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#event-beforeProjectEdit)
1738
+ * @param {object} event Event object
1739
+ * @param {Gantt.view.Gantt} event.source The Gantt instance
1740
+ * @param {Gantt.feature.ProjectEdit} event.projectEdit The projectEdit feature
1741
+ * @param {Gantt.model.ProjectModel} event.projectRecord The project about to be shown in the editor.
1742
+ */
1743
+ onBeforeProjectEdit? : ((event: { source: Gantt, projectEdit: ProjectEdit, projectRecord: ProjectModel }) => Promise<boolean>|boolean|void)|string
1744
+ /**
1745
+ * Fires on the owning Gantt widget when the editor for a project is available but
1746
+ * before it is shown. Allows manipulating fields etc.
1747
+ * @param {object} event Event object
1748
+ * @param {Gantt.view.Gantt} event.source The Gantt instance
1749
+ * @param {Gantt.feature.ProjectEdit} event.projectEdit The projectEdit feature
1750
+ * @param {Gantt.model.ProjectModel} event.projectRecord The project about to be shown in the editor.
1751
+ * @param {Gantt.widget.ProjectEditor} event.editor The editor
1752
+ */
1753
+ onBeforeProjectEditShow? : ((event: { source: Gantt, projectEdit: ProjectEdit, projectRecord: ProjectModel, editor: ProjectEditor }) => void)|string
1754
+ /**
1755
+ * Fires on the owning Gantt widget instance before a project is saved, return `false` to prevent it.
1756
+ * ...
1757
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#event-beforeProjectSave)
1758
+ * @param {object} event Event object
1759
+ * @param {Gantt.view.Gantt} event.source The Gantt instance
1760
+ * @param {Gantt.model.ProjectModel} event.projectRecord The project about to be saved
1761
+ * @param {Gantt.widget.ProjectEditor} event.editor The editor widget
1762
+ */
1763
+ onBeforeProjectSave? : ((event: { source: Gantt, projectRecord: ProjectModel, editor: ProjectEditor }) => Promise<boolean>|boolean|void)|string
1764
+ /**
1765
+ * Fires before a row is rendered.
1766
+ * @param {object} event Event object
1767
+ * @param {Grid.view.Grid} event.source The firing Grid instance.
1768
+ * @param {Grid.row.Row} event.row The row about to be rendered.
1769
+ * @param {Core.data.Model} event.record The record for the row.
1770
+ * @param {number} event.recordIndex The zero-based index of the record.
1771
+ */
1772
+ onBeforeRenderRow? : ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
1773
+ /**
1774
+ * Grid rows are about to be rendered
1775
+ * @param {object} event Event object
1776
+ * @param {Grid.view.Grid} event.source This grid.
1777
+ */
1778
+ onBeforeRenderRows? : ((event: { source: Grid }) => void)|string
1779
+ /**
1780
+ * This event fires before row collapse is started.
1781
+ * ...
1782
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#event-beforeRowCollapse)
1783
+ * @param {object} event Event object
1784
+ * @param {Core.data.Model} event.record Record
1785
+ */
1786
+ onBeforeRowCollapse? : ((event: { record: Model }) => Promise<boolean>|boolean|void)|string
1787
+ /**
1788
+ * This event fires before row expand is started.
1789
+ * ...
1790
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#event-beforeRowExpand)
1791
+ * @param {object} event Event object
1792
+ * @param {Core.data.Model} event.record Record
1793
+ */
1794
+ onBeforeRowExpand? : ((event: { record: Model }) => Promise<boolean>|boolean|void)|string
1795
+ /**
1796
+ * Fires before the selection changes. Returning `false` from a listener prevents the change
1797
+ * @param {object} event Event object
1798
+ * @param {string} event.action `'select'`/`'deselect'`
1799
+ * @param {'row','cell'} event.mode `'row'`/`'cell'`
1800
+ * @param {Grid.view.Grid} event.source
1801
+ * @param {Core.data.Model[]} event.deselected The records to be deselected in this operation.
1802
+ * @param {Core.data.Model[]} event.selected The records to be selected in this operation.
1803
+ * @param {Core.data.Model[]} event.selection The records in the current selection, before applying `selected` and `deselected`
1804
+ * @param {Grid.util.GridLocation[]} event.deselectedCells The cells to be deselected in this operation.
1805
+ * @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
1806
+ * @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
1807
+ */
1808
+ 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
1809
+ /**
1810
+ * Fired before this container will load record values into its child fields. This is useful if you
1811
+ * want to modify the UI before data is loaded (e.g. set some input field to be readonly)
1812
+ * @param {object} event Event object
1813
+ * @param {Core.widget.Container} event.source The container
1814
+ * @param {Core.data.Model} event.record The record
1815
+ */
1816
+ onBeforeSetRecord? : ((event: { source: Container, record: Model }) => void)|string
1817
+ /**
1818
+ * Triggered before a widget is shown. Return `false` to prevent the action.
1819
+ * @param {object} event Event object
1820
+ * @param {Core.widget.Widget,any} event.source The widget being shown
1821
+ */
1822
+ onBeforeShow? : ((event: { source: Widget|any }) => Promise<boolean>|boolean|void)|string
1823
+ /**
1824
+ * Fired on the owning Scheduler/Gantt before showing dependency terminals on a task or event. Return `false` to
1825
+ * prevent it
1826
+ * @param {object} event Event object
1827
+ * @param {Scheduler.model.TimeSpan} event.source The hovered task
1828
+ */
1829
+ onBeforeShowTerminals? : ((event: { source: TimeSpan }) => Promise<boolean>|boolean|void)|string
1830
+ /**
1831
+ * Fires on the owning Grid before editing starts, return `false` to prevent editing
1832
+ * @param {object} event Event object
1833
+ * @param {Grid.view.Grid} event.source Owner grid
1834
+ * @param {RowEditorContext} event.editorContext Editing context
1835
+ */
1836
+ onBeforeStartRowEdit? : ((event: { source: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string
1837
+ /**
1838
+ * Fired before state is applied to the source. Allows editing the state object or preventing the operation.
1839
+ * @param {object} event Event object
1840
+ * @param {GridStateInfo} event.state State object config
1841
+ */
1842
+ onBeforeStateApply? : ((event: { state: GridStateInfo }) => Promise<boolean>|boolean|void)|string
1843
+ /**
1844
+ * Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
1845
+ * @param {object} event Event object
1846
+ * @param {GridStateInfo} event.state State object config
1847
+ */
1848
+ onBeforeStateSave? : ((event: { state: GridStateInfo }) => Promise<boolean>|boolean|void)|string
1849
+ /**
1850
+ * Fires when adding a task from the UI to allow data mutation.
1851
+ * @param {object} event Event object
1852
+ * @param {Gantt.view.Gantt} event.source The Gantt instance
1853
+ * @param {Gantt.model.TaskModel} event.taskRecord The task
1854
+ */
1855
+ onBeforeTaskAdd? : ((event: { source: Gantt, taskRecord: TaskModel }) => void)|string
1856
+ /**
1857
+ * Fires on the owning Scheduler or Gantt widget before a task is deleted, return `false` to prevent it.
1858
+ * ...
1859
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#event-beforeTaskDelete)
1860
+ * @param {object} event Event object
1861
+ * @param {SchedulerPro.view.SchedulerPro} event.source The Scheduler Pro instance.
1862
+ * @param {SchedulerPro.model.EventModel} event.taskRecord The record about to be deleted
1863
+ * @param {SchedulerPro.widget.TaskEditorBase} event.editor The editor widget
1864
+ */
1865
+ onBeforeTaskDelete? : ((event: { source: SchedulerPro, taskRecord: EventModel, editor: TaskEditorBase }) => Promise<boolean>|boolean|void)|string
1866
+ /**
1867
+ * Fires on the owning Gantt before task dragging starts. Return false to prevent the action.
1868
+ * @param {object} event Event object
1869
+ * @param {Gantt.view.Gantt} event.source
1870
+ * @param {Gantt.model.TaskModel} event.taskRecord
1871
+ * @param {Event} event.event The native browser event
1872
+ */
1873
+ onBeforeTaskDrag? : ((event: { source: Gantt, taskRecord: TaskModel, event: Event }) => Promise<boolean>|boolean|void)|string
1874
+ /**
1875
+ * Fires on the owning Gantt to allow implementer to prevent immediate finalization by setting `data.context.async = true`
1876
+ * in the listener, to show a confirmation popup etc
1877
+ * ...
1878
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#event-beforeTaskDropFinalize)
1879
+ * @param {object} event Event object
1880
+ * @param {Gantt.view.Gantt} event.source Gantt instance
1881
+ * @param {object} event.context
1882
+ * @param {Gantt.model.TaskModel[]} event.context.taskRecords The dragged task records
1883
+ * @param {boolean} event.context.valid Set this to `false` to mark the drop as invalid
1884
+ * @param {boolean} event.context.async Set true to handle dragdrop asynchronously (e.g. to wait for user confirmation)
1885
+ * @param {Function} event.context.finalize Call this method to finalize dragdrop. This method accepts one argument: pass true to update records, or false, to ignore changes
1886
+ */
1887
+ onBeforeTaskDropFinalize? : ((event: { source: Gantt, context: { taskRecords: TaskModel[], valid: boolean, async: boolean, finalize: Function } }) => void)|string
1888
+ /**
1889
+ * Fires on the owning Scheduler or Gantt widget instance before a task is displayed in the editor.
1890
+ * This may be listened to in order to take over the task editing flow. Returning `false`
1891
+ * stops the default editing UI from being shown.
1892
+ * ...
1893
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#event-beforeTaskEdit)
1894
+ * @param {object} event Event object
1895
+ * @param {SchedulerPro.view.SchedulerPro} event.source The Scheduler Pro instance
1896
+ * @param {SchedulerPro.feature.SchedulerProTaskEdit} event.taskEdit The taskEdit feature
1897
+ * @param {SchedulerPro.model.EventModel} event.taskRecord The task about to be shown in the editor.
1898
+ * @param {HTMLElement} event.taskElement The element which represents the task
1899
+ */
1900
+ onBeforeTaskEdit? : ((event: { source: SchedulerPro, taskEdit: SchedulerProTaskEdit, taskRecord: EventModel, taskElement: HTMLElement }) => Promise<boolean>|boolean|void)|string
1901
+ /**
1902
+ * Fires on the owning Scheduler or Gantt widget when the editor for an event is available but before it is shown. Allows
1903
+ * manipulating fields etc.
1904
+ * @param {object} event Event object
1905
+ * @param {SchedulerPro.view.SchedulerPro} event.source The SchedulerPro instance
1906
+ * @param {SchedulerPro.feature.SchedulerProTaskEdit} event.taskEdit The taskEdit feature
1907
+ * @param {SchedulerPro.model.EventModel} event.taskRecord The task about to be shown in the editor.
1908
+ * @param {HTMLElement} event.eventElement The element which represents the task
1909
+ * @param {SchedulerPro.widget.TaskEditorBase} event.editor The editor
1910
+ */
1911
+ onBeforeTaskEditShow? : ((event: { source: SchedulerPro, taskEdit: SchedulerProTaskEdit, taskRecord: EventModel, eventElement: HTMLElement, editor: TaskEditorBase }) => void)|string
1912
+ /**
1913
+ * Fires on the owning Gantt before resizing starts. Return `false` to prevent the operation.
1914
+ * @param {object} event Event object
1915
+ * @param {Gantt.model.TaskModel} event.taskRecord
1916
+ * @param {Event} event.event
1917
+ */
1918
+ onBeforeTaskResize? : ((event: { taskRecord: TaskModel, event: Event }) => Promise<boolean>|boolean|void)|string
1919
+ /**
1920
+ * Fires on the owning Gantt to allow implementer to prevent immediate finalization by setting
1921
+ * `data.context.async = true` in the listener, to show a confirmation popup etc.
1922
+ * ...
1923
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#event-beforeTaskResizeFinalize)
1924
+ * @param {object} event Event object
1925
+ * @param {Gantt.model.TaskModel} event.taskRecord
1926
+ * @param {Gantt.view.Gantt} event.source Gantt instance
1927
+ * @param {object} event.context
1928
+ * @param {Date} event.context.endDate New endDate
1929
+ * @param {Date} event.context.originalEndDate End date before resize
1930
+ * @param {TaskResizeData[]} event.context.resizeData Resize data for selected tasks. Only available when [resizeSelected](https://bryntum.com/products/gantt/docs/api/Gantt/feature/TaskResize#config-resizeSelected) is `true`.
1931
+ * @param {Event} event.event Browser event
1932
+ * @param {boolean} event.context.async Set true to handle resize asynchronously (e.g. to wait for user confirmation)
1933
+ * @param {Function} event.context.finalize Call this method to finalize resize. This method accepts one argument: pass true to update records, or false, to ignore changes
1934
+ */
1935
+ onBeforeTaskResizeFinalize? : ((event: { taskRecord: TaskModel, source: Gantt, context: { endDate: Date, originalEndDate: Date, resizeData: TaskResizeData[], async: boolean, finalize: Function }, event: Event }) => void)|string
1936
+ /**
1937
+ * Fires on the owning Scheduler or Gantt widget instance before a task is saved, return `false` to prevent it.
1938
+ * ...
1939
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#event-beforeTaskSave)
1940
+ * @param {object} event Event object
1941
+ * @param {SchedulerPro.view.SchedulerPro} event.source The Scheduler Pro instance
1942
+ * @param {SchedulerPro.model.EventModel} event.taskRecord The task about to be saved
1943
+ * @param {SchedulerPro.widget.TaskEditorBase} event.editor The editor widget
1944
+ */
1945
+ onBeforeTaskSave? : ((event: { source: SchedulerPro, taskRecord: EventModel, editor: TaskEditorBase }) => Promise<boolean>|boolean|void)|string
1946
+ /**
1947
+ * Fires on the owning Gantt before segment dragging starts. Return `false` to prevent the action.
1948
+ * @param {object} event Event object
1949
+ * @param {Gantt.view.Gantt} event.source
1950
+ * @param {Gantt.model.TaskModel} event.taskRecord The segment about to be dragged
1951
+ * @param {Event} event.event The native browser event
1952
+ */
1953
+ onBeforeTaskSegmentDrag? : ((event: { source: Gantt, taskRecord: TaskModel, event: Event }) => Promise<boolean>|boolean|void)|string
1954
+ /**
1955
+ * Fires on the owning Gantt to allow implementer to prevent immediate finalization by setting `data.context.async = true`
1956
+ * in the listener, to show a confirmation popup etc
1957
+ * ...
1958
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#event-beforeTaskSegmentDropFinalize)
1959
+ * @param {object} event Event object
1960
+ * @param {Gantt.view.Gantt} event.source Gantt instance
1961
+ * @param {object} event.context
1962
+ * @param {Gantt.model.TaskModel[]} event.context.taskRecords Dragged segments
1963
+ * @param {boolean} event.context.valid Set this to `false` to mark the drop as invalid
1964
+ * @param {boolean} event.context.async Set true to handle dragdrop asynchronously (e.g. to wait for user confirmation)
1965
+ * @param {Function} event.context.finalize Call this method to finalize dragdrop. This method accepts one argument: pass true to update records, or false, to ignore changes
1966
+ */
1967
+ onBeforeTaskSegmentDropFinalize? : ((event: { source: Gantt, context: { taskRecords: TaskModel[], valid: boolean, async: boolean, finalize: Function } }) => void)|string
1968
+ /**
1969
+ * Fired on the owning Gantt before resizing starts. Return `false` to prevent the action.
1970
+ * @param {object} event Event object
1971
+ * @param {Gantt.view.Gantt} event.source Gantt instance
1972
+ * @param {Gantt.model.TaskModel} event.taskRecord Segment being resized
1973
+ * @param {Scheduler.model.SchedulerResourceModel} event.resourceRecord Resource record the resize starts within
1974
+ * @param {MouseEvent} event.event Browser event
1975
+ */
1976
+ onBeforeTaskSegmentResize? : ((event: { source: Gantt, taskRecord: TaskModel, resourceRecord: SchedulerResourceModel, event: MouseEvent }) => Promise<boolean>|boolean|void)|string
1977
+ /**
1978
+ * Fired on the owning Gantt to allow implementer to prevent immediate finalization by setting
1979
+ * `data.context.async = true` in the listener, to show a confirmation popup etc.
1980
+ * ...
1981
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#event-beforeTaskSegmentResizeFinalize)
1982
+ * @param {object} event Event object
1983
+ * @param {Gantt.view.Gantt} event.source Gantt instance
1984
+ * @param {object} event.context
1985
+ * @param {boolean} event.context.async Set true to handle resize asynchronously (e.g. to wait for user confirmation)
1986
+ * @param {Function} event.context.finalize Call this method to finalize resize. This method accepts one argument: pass `true` to update records, or `false`, to ignore changes
1987
+ */
1988
+ onBeforeTaskSegmentResizeFinalize? : ((event: { source: Gantt, context: { async: boolean, finalize: Function } }) => void)|string
1989
+ /**
1990
+ * Fired when a group is going to be expanded or collapsed using the UI.
1991
+ * Returning `false` from a listener prevents the operation
1992
+ * @param {object} event Event object
1993
+ * @param {Core.data.Model} event.groupRecord [DEPRECATED] Use `groupRecords` param instead
1994
+ * @param {Core.data.Model[]} event.groupRecords The group records being toggled
1995
+ * @param {boolean} event.collapse Collapsed (true) or expanded (false)
1996
+ * @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
1997
+ */
1998
+ onBeforeToggleGroup? : ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => Promise<boolean>|boolean|void)|string
1999
+ /**
2000
+ * Fired before a parent node record toggles its collapsed state.
2001
+ * @param {object} event Event object
2002
+ * @param {Grid.view.Grid} event.source The firing Grid instance.
2003
+ * @param {Core.data.Model} event.record The record being toggled.
2004
+ * @param {boolean} event.collapse `true` if the node is being collapsed.
2005
+ */
2006
+ onBeforeToggleNode? : ((event: { source: Grid, record: Model, collapse: boolean }) => void)|string
2007
+ /**
2008
+ * Fires on the owning Grid when editing is cancelled
2009
+ * @param {object} event Event object
2010
+ * @param {Grid.view.Grid} event.source Owner grid
2011
+ * @param {Grid.util.GridLocation} event.editorContext Editing context
2012
+ * @param {Event} event.event Included if the cancellation was triggered by a DOM event
2013
+ */
2014
+ onCancelCellEdit? : ((event: { source: Grid, editorContext: GridLocation, event: Event }) => void)|string
2015
+ /**
2016
+ * Fires when any other event is fired from the object.
2017
+ * ...
2018
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#event-catchAll)
2019
+ * @param {object} event Event object
2020
+ * @param {{[key: string]: any, type: string}} event.event The Object that contains event details
2021
+ * @param {string} event.event.type The type of the event which is caught by the listener
2022
+ */
2023
+ onCatchAll? : ((event: {[key: string]: any, type: string}) => void)|string
2024
+ /**
2025
+ * Fired when user clicks in a grid cell
2026
+ * @param {object} event Event object
2027
+ * @param {Grid.view.Grid} event.grid The grid instance
2028
+ * @param {Core.data.Model} event.record The record representing the row
2029
+ * @param {Grid.column.Column} event.column The column to which the cell belongs
2030
+ * @param {HTMLElement} event.cellElement The cell HTML element
2031
+ * @param {HTMLElement} event.target The target element
2032
+ * @param {MouseEvent} event.event The native DOM event
2033
+ */
2034
+ onCellClick? : ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string
2035
+ /**
2036
+ * Fired when user activates contextmenu in a grid cell
2037
+ * @param {object} event Event object
2038
+ * @param {Grid.view.Grid} event.grid The grid instance
2039
+ * @param {Core.data.Model} event.record The record representing the row
2040
+ * @param {Grid.column.Column} event.column The column to which the cell belongs
2041
+ * @param {HTMLElement} event.cellElement The cell HTML element
2042
+ * @param {HTMLElement} event.target The target element
2043
+ * @param {MouseEvent} event.event The native DOM event
2044
+ */
2045
+ onCellContextMenu? : ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string
2046
+ /**
2047
+ * Fired when user double clicks a grid cell
2048
+ * @param {object} event Event object
2049
+ * @param {Grid.view.Grid} event.grid The grid instance
2050
+ * @param {Core.data.Model} event.record The record representing the row
2051
+ * @param {Grid.column.Column} event.column The column to which the cell belongs
2052
+ * @param {HTMLElement} event.cellElement The cell HTML element
2053
+ * @param {HTMLElement} event.target The target element
2054
+ * @param {MouseEvent} event.event The native DOM event
2055
+ */
2056
+ onCellDblClick? : ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string
2057
+ /**
2058
+ * This event fires on the owning grid before the context menu is shown for a cell.
2059
+ * 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).
2060
+ * ...
2061
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#event-cellMenuBeforeShow)
2062
+ * @param {object} event Event object
2063
+ * @param {Grid.view.Grid} event.source The grid
2064
+ * @param {Core.widget.Menu} event.menu The menu
2065
+ * @param {Record<string, MenuItemEntry>} event.items Menu item configs
2066
+ * @param {Grid.column.Column} event.column Column
2067
+ * @param {Core.data.Model} event.record Record
2068
+ */
2069
+ onCellMenuBeforeShow? : ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => Promise<boolean>|boolean|void)|string
2070
+ /**
2071
+ * This event fires on the owning grid when an item is selected in the cell context menu.
2072
+ * @param {object} event Event object
2073
+ * @param {Grid.view.Grid} event.source The grid
2074
+ * @param {Core.widget.Menu} event.menu The menu
2075
+ * @param {Core.widget.MenuItem} event.item Selected menu item
2076
+ * @param {Grid.column.Column} event.column Column
2077
+ * @param {Core.data.Model} event.record Record
2078
+ */
2079
+ onCellMenuItem? : ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column, record: Model }) => void)|string
2080
+ /**
2081
+ * This event fires on the owning grid after the context menu is shown for a cell.
2082
+ * @param {object} event Event object
2083
+ * @param {Grid.view.Grid} event.source The grid
2084
+ * @param {Core.widget.Menu} event.menu The menu
2085
+ * @param {Record<string, MenuItemEntry>} event.items Menu item configs
2086
+ * @param {Grid.column.Column} event.column Column
2087
+ * @param {Core.data.Model} event.record Record
2088
+ */
2089
+ onCellMenuShow? : ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => void)|string
2090
+ /**
2091
+ * This event fires on the owning grid when a check item is toggled in the cell context menu.
2092
+ * @param {object} event Event object
2093
+ * @param {Grid.view.Grid} event.source The grid
2094
+ * @param {Core.widget.Menu} event.menu The menu
2095
+ * @param {Core.widget.MenuItem} event.item Selected menu item
2096
+ * @param {Grid.column.Column} event.column Column
2097
+ * @param {Core.data.Model} event.record Record
2098
+ * @param {boolean} event.checked Checked or not
2099
+ */
2100
+ onCellMenuToggleItem? : ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column, record: Model, checked: boolean }) => void)|string
2101
+ /**
2102
+ * Fired when the mouse enters a cell
2103
+ * @param {object} event Event object
2104
+ * @param {Grid.view.Grid} event.source The grid instance
2105
+ * @param {Core.data.Model} event.record The record representing the hovered cell
2106
+ * @param {Grid.column.Column} event.column The column currently hovered
2107
+ * @param {HTMLElement} event.cellElement The cell HTML element
2108
+ * @param {MouseEvent} event.event The native DOM event
2109
+ */
2110
+ onCellMouseEnter? : ((event: { source: Grid, record: Model, column: Column, cellElement: HTMLElement, event: MouseEvent }) => void)|string
2111
+ /**
2112
+ * Fired when the mouse leaves a cell
2113
+ * @param {object} event Event object
2114
+ * @param {Grid.view.Grid} event.source The grid instance
2115
+ * @param {Core.data.Model} event.record The record representing the cell that the mouse left
2116
+ * @param {Grid.column.Column} event.column The column representing the cell that the mouse left
2117
+ * @param {HTMLElement} event.cellElement The cell HTML element that the mouse left
2118
+ * @param {MouseEvent} event.event The native DOM event
2119
+ */
2120
+ onCellMouseLeave? : ((event: { source: Grid, record: Model, column: Column, cellElement: HTMLElement, event: MouseEvent }) => void)|string
2121
+ /**
2122
+ * Fired when a user moves the mouse out of a grid cell
2123
+ * @param {object} event Event object
2124
+ * @param {Grid.view.Grid} event.grid The grid instance
2125
+ * @param {Core.data.Model} event.record The record representing the row
2126
+ * @param {Grid.column.Column} event.column The column to which the cell belongs
2127
+ * @param {HTMLElement} event.cellElement The cell HTML element
2128
+ * @param {HTMLElement} event.target The target element
2129
+ * @param {MouseEvent} event.event The native DOM event
2130
+ */
2131
+ onCellMouseOut? : ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string
2132
+ /**
2133
+ * Fired when user moves the mouse over a grid cell
2134
+ * @param {object} event Event object
2135
+ * @param {Grid.view.Grid} event.grid The grid instance
2136
+ * @param {Core.data.Model} event.record The record representing the row
2137
+ * @param {Grid.column.Column} event.column The column to which the cell belongs
2138
+ * @param {HTMLElement} event.cellElement The cell HTML element
2139
+ * @param {HTMLElement} event.target The target element
2140
+ * @param {MouseEvent} event.event The native DOM event
2141
+ */
2142
+ onCellMouseOver? : ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string
2143
+ /**
2144
+ * Fires when a Panel is collapsed using the [collapsible](https://bryntum.com/products/gantt/docs/api/Core/widget/Panel#config-collapsible) setting.
2145
+ * @param {object} event Event object
2146
+ * @param {Core.widget.Panel} event.source This Panel.
2147
+ */
2148
+ onCollapse? : ((event: { source: Panel }) => void)|string
2149
+ /**
2150
+ * Fired before a parent node record is collapsed.
2151
+ * @param {object} event Event object
2152
+ * @param {Grid.view.Grid} event.source The firing Grid instance.
2153
+ * @param {Core.data.Model} event.record The record which has been collapsed.
2154
+ */
2155
+ onCollapseNode? : ((event: { source: Grid, record: Model }) => void)|string
2156
+ /**
2157
+ * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
2158
+ * to indicate whether the drop position is valid or not.
2159
+ * @param {object} event Event object
2160
+ * @param {Grid.view.Grid} event.source The grid instance.
2161
+ * @param {Grid.column.Column} event.column The dragged column.
2162
+ * @param {Grid.column.Column} event.insertBefore The column before which the dragged column will be inserted (if not last).
2163
+ * @param {Event} event.event The browser event.
2164
+ * @param {object} event.context
2165
+ * @param {boolean} event.context.valid Set this to `true` or `false` to indicate whether the drop position is valid.
2166
+ */
2167
+ onColumnDrag? : ((event: { source: Grid, column: Column, insertBefore: Column, event: Event, context: { valid: boolean } }) => void)|string
2168
+ /**
2169
+ * This event is fired when a column drag gesture has started.
2170
+ * @param {object} event Event object
2171
+ * @param {Grid.view.Grid} event.source The grid instance.
2172
+ * @param {Grid.column.Column} event.column The dragged column.
2173
+ * @param {Event} event.event The browser event.
2174
+ */
2175
+ onColumnDragStart? : ((event: { source: Grid, column: Column, event: Event }) => void)|string
2176
+ /**
2177
+ * This event is always fired after a column is dropped. The `valid` param is `true` if the operation was not
2178
+ * vetoed and the column was moved in the column store.
2179
+ * @param {object} event Event object
2180
+ * @param {Grid.view.Grid} event.source The grid instance.
2181
+ * @param {Grid.column.Column} event.column The dragged column.
2182
+ * @param {Grid.column.Column} event.insertBefore The column before which the dragged column will be inserted.
2183
+ * @param {Grid.column.Column} event.newParent The new parent column.
2184
+ * @param {boolean} event.valid `true` if the operation was not vetoed.
2185
+ * @param {Event} event.event The browser event.
2186
+ * @param {string} event.region The region where the column was dropped.
2187
+ */
2188
+ onColumnDrop? : ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => Promise<boolean>|boolean|void)|string
2189
+ /**
2190
+ * This event is fired after a resize gesture is completed.
2191
+ * @param {object} event Event object
2192
+ * @param {Grid.view.Grid} event.source The grid instance
2193
+ * @param {Grid.column.Column} event.column The resized column
2194
+ * @param {Event} event.domEvent The browser event
2195
+ */
2196
+ onColumnResize? : ((event: { source: Grid, column: Column, domEvent: Event }) => void)|string
2197
+ /**
2198
+ * This event is fired when a column resize gesture starts.
2199
+ * @param {object} event Event object
2200
+ * @param {Grid.view.Grid} event.source The grid instance
2201
+ * @param {Grid.column.Column} event.column The column
2202
+ * @param {Event} event.domEvent The browser event
2203
+ */
2204
+ onColumnResizeStart? : ((event: { source: Grid, column: Column, domEvent: Event }) => void)|string
2205
+ /**
2206
+ * This event fires on the owning widget when an item is selected in the context menu.
2207
+ * @param {object} event Event object
2208
+ * @param {Core.widget.Widget} event.source The owning widget
2209
+ * @param {Core.widget.Menu} event.menu The menu
2210
+ * @param {Core.widget.MenuItem} event.item Selected menu item
2211
+ */
2212
+ onContextMenuItem? : ((event: { source: Widget, menu: Menu, item: MenuItem }) => void)|string
2213
+ /**
2214
+ * This event fires on the owning widget when a check item is toggled in the context menu.
2215
+ * @param {object} event Event object
2216
+ * @param {Core.widget.Widget} event.source The owning widget
2217
+ * @param {Core.widget.Menu} event.menu The menu
2218
+ * @param {Core.widget.MenuItem} event.item Selected menu item
2219
+ * @param {boolean} event.checked Checked or not
2220
+ */
2221
+ onContextMenuToggleItem? : ((event: { source: Widget, menu: Menu, item: MenuItem, checked: boolean }) => void)|string
2222
+ /**
2223
+ * Fires on the owning Grid after a copy action is performed.
2224
+ * @param {object} event Event object
2225
+ * @param {Grid.view.Grid} event.source Owner grid
2226
+ * @param {Grid.util.GridLocation[]} event.cells The cells about to be copied or cut
2227
+ * @param {string} event.copiedDataString The concatenated data string that was copied or cut
2228
+ * @param {boolean} event.isCut `true` if this was a cut action
2229
+ * @param {string} event.entityName 'cell' to distinguish this event from other copy events
2230
+ */
2231
+ onCopy? : ((event: { source: Grid, cells: GridLocation[], copiedDataString: string, isCut: boolean, entityName: string }) => void)|string
2232
+ /**
2233
+ * Fired when critical paths get highlighted.
2234
+ * ...
2235
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#event-criticalPathsHighlighted)
2236
+ */
2237
+ onCriticalPathsHighlighted? : (() => void)|string
2238
+ /**
2239
+ * Fired when critical paths get hidden.
2240
+ * ...
2241
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#event-criticalPathsUnhighlighted)
2242
+ */
2243
+ onCriticalPathsUnhighlighted? : (() => void)|string
2244
+ /**
2245
+ * Fires on the owning Scheduler/Gantt when the line indicating the current time is updated (see [currentTimeLineUpdateInterval](https://bryntum.com/products/gantt/docs/api/Scheduler/feature/TimeRanges#config-currentTimeLineUpdateInterval)).
2246
+ * @param {object} event Event object
2247
+ * @param {Scheduler.view.Scheduler} event.source The scheduler
2248
+ * @param {Date} event.date The current date
2249
+ */
2250
+ onCurrentTimelineUpdate? : ((event: { source: Scheduler, date: Date }) => void)|string
2251
+ /**
2252
+ * Fired when data in the store changes.
2253
+ * ...
2254
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#event-dataChange)
2255
+ * @param {object} event Event object
2256
+ * @param {Grid.view.Grid} event.source Owning grid
2257
+ * @param {Core.data.Store} event.store The originating store
2258
+ * @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'`
2259
+ * @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
2260
+ * @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
2261
+ * @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
2262
+ */
2263
+ onDataChange? : ((event: { source: Grid, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
2264
+ /**
2265
+ * Fired when the range of dates encapsulated by the UI changes. This will be when
2266
+ * moving a view in time by reconfiguring its [timeAxis](https://bryntum.com/products/gantt/docs/api/Scheduler/view/TimelineBase#config-timeAxis). This will happen
2267
+ * when zooming, or changing [viewPreset](https://bryntum.com/products/gantt/docs/api/Scheduler/view/TimelineBase#config-viewPreset).
2268
+ * ...
2269
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#event-dateRangeChange)
2270
+ * @param {object} event Event object
2271
+ * @param {Scheduler.view.TimelineBase} event.source This Scheduler/Gantt instance.
2272
+ * @param {object} event.old The old date range
2273
+ * @param {Date} event.old.startDate the old start date.
2274
+ * @param {Date} event.old.endDate the old end date.
2275
+ * @param {object} event.new The new date range
2276
+ * @param {Date} event.new.startDate the new start date.
2277
+ * @param {Date} event.new.endDate the new end date.
2278
+ */
2279
+ onDateRangeChange? : ((event: { source: TimelineBase, old: { startDate: Date, endDate: Date }, new: { startDate: Date, endDate: Date } }) => void)|string
2280
+ /**
2281
+ * Fired when dependencies are rendered
2282
+ */
2283
+ onDependenciesDrawn? : (() => void)|string
2284
+ /**
2285
+ * Fires on the owning Scheduler/Gantt when a click is registered on a dependency line.
2286
+ * @param {object} event Event object
2287
+ * @param {Scheduler.view.Scheduler} event.source The scheduler
2288
+ * @param {Scheduler.model.SchedulerDependencyModel} event.dependency
2289
+ * @param {MouseEvent} event.event
2290
+ */
2291
+ onDependencyClick? : ((event: { source: Scheduler, dependency: SchedulerDependencyModel, event: MouseEvent }) => void)|string
2292
+ /**
2293
+ * Fires on the owning Scheduler/Gantt when a context menu event is registered on a dependency line.
2294
+ * @param {object} event Event object
2295
+ * @param {Scheduler.view.Scheduler} event.source The scheduler
2296
+ * @param {Scheduler.model.SchedulerDependencyModel} event.dependency
2297
+ * @param {MouseEvent} event.event
2298
+ */
2299
+ onDependencyContextMenu? : ((event: { source: Scheduler, dependency: SchedulerDependencyModel, event: MouseEvent }) => void)|string
2300
+ /**
2301
+ * Fired on the owning Scheduler/Gantt when a dependency creation drag operation starts
2302
+ * @param {object} event Event object
2303
+ * @param {Scheduler.model.TimeSpan} event.source The source task
2304
+ */
2305
+ onDependencyCreateDragStart? : ((event: { source: TimeSpan }) => void)|string
2306
+ /**
2307
+ * Fired on the owning Scheduler/Gantt when a dependency drag creation operation succeeds
2308
+ * @param {object} event Event object
2309
+ * @param {Scheduler.model.TimeSpan} event.source The source task
2310
+ * @param {Scheduler.model.TimeSpan} event.target The target task
2311
+ * @param {Scheduler.model.DependencyBaseModel} event.dependency The created dependency
2312
+ */
2313
+ onDependencyCreateDrop? : ((event: { source: TimeSpan, target: TimeSpan, dependency: DependencyBaseModel }) => void)|string
2314
+ /**
2315
+ * Fires on the owning Scheduler/Gantt when a double click is registered on a dependency line.
2316
+ * @param {object} event Event object
2317
+ * @param {Scheduler.view.Scheduler} event.source The scheduler
2318
+ * @param {Scheduler.model.SchedulerDependencyModel} event.dependency
2319
+ * @param {MouseEvent} event.event
2320
+ */
2321
+ onDependencyDblClick? : ((event: { source: Scheduler, dependency: SchedulerDependencyModel, event: MouseEvent }) => void)|string
2322
+ /**
2323
+ * Fires on the owning Scheduler/Gantt when the mouse moves out of a dependency line.
2324
+ * @param {object} event Event object
2325
+ * @param {Scheduler.view.Scheduler} event.source The scheduler
2326
+ * @param {Scheduler.model.SchedulerDependencyModel} event.dependency
2327
+ * @param {MouseEvent} event.event
2328
+ */
2329
+ onDependencyMouseOut? : ((event: { source: Scheduler, dependency: SchedulerDependencyModel, event: MouseEvent }) => void)|string
2330
+ /**
2331
+ * Fires on the owning Scheduler/Gantt when the mouse moves over a dependency line.
2332
+ * @param {object} event Event object
2333
+ * @param {Scheduler.view.Scheduler} event.source The scheduler
2334
+ * @param {Scheduler.model.SchedulerDependencyModel} event.dependency
2335
+ * @param {MouseEvent} event.event
2336
+ */
2337
+ onDependencyMouseOver? : ((event: { source: Scheduler, dependency: SchedulerDependencyModel, event: MouseEvent }) => void)|string
2338
+ /**
2339
+ * Fired on the owning Scheduler/Gantt when asynchronous dependency validation completes
2340
+ * @param {object} event Event object
2341
+ * @param {Scheduler.model.TimeSpan} event.source The source task
2342
+ * @param {Scheduler.model.TimeSpan} event.target The target task
2343
+ * @param {number} event.dependencyType The dependency type, see [Type](https://bryntum.com/products/gantt/docs/api/Scheduler/model/DependencyBaseModel#property-Type-static)
2344
+ */
2345
+ onDependencyValidationComplete? : ((event: { source: TimeSpan, target: TimeSpan, dependencyType: number }) => void)|string
2346
+ /**
2347
+ * Fired on the owning Scheduler/Gantt when asynchronous dependency validation starts
2348
+ * @param {object} event Event object
2349
+ * @param {Scheduler.model.TimeSpan} event.source The source task
2350
+ * @param {Scheduler.model.TimeSpan} event.target The target task
2351
+ * @param {number} event.dependencyType The dependency type, see [Type](https://bryntum.com/products/gantt/docs/api/Scheduler/model/DependencyBaseModel#property-Type-static)
2352
+ */
2353
+ onDependencyValidationStart? : ((event: { source: TimeSpan, target: TimeSpan, dependencyType: number }) => void)|string
2354
+ /**
2355
+ * Fires when an object is destroyed.
2356
+ * @param {object} event Event object
2357
+ * @param {Core.Base} event.source The Object that is being destroyed.
2358
+ */
2359
+ onDestroy? : ((event: { source: Base }) => void)|string
2360
+ /**
2361
+ * 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
2362
+ * @param {object} event Event object
2363
+ * @param {Core.widget.Container} event.source The container.
2364
+ * @param {boolean} event.dirty The dirty state of the Container - `true` if there are any fields which have been changed since initial load.
2365
+ */
2366
+ onDirtyStateChange? : ((event: { source: Container, dirty: boolean }) => void)|string
2367
+ /**
2368
+ * Fires on the owning Gantt after the task has been scheduled.
2369
+ * @param {object} event Event object
2370
+ * @param {Gantt.view.Gantt} event.source
2371
+ * @param {Gantt.model.TaskModel} event.taskRecord
2372
+ * @param {MouseEvent} event.event The ending mouseup event.
2373
+ * @param {HTMLElement} event.proxyElement The proxy element showing the drag creation zone.
2374
+ */
2375
+ onDragCreateEnd? : ((event: { source: Gantt, taskRecord: TaskModel, event: MouseEvent, proxyElement: HTMLElement }) => void)|string
2376
+ /**
2377
+ * Fires on the owning Gantt after the drag start has created a proxy element.
2378
+ * @param {object} event Event object
2379
+ * @param {Gantt.view.Gantt} event.source
2380
+ * @param {HTMLElement} event.proxyElement The proxy representing the new event.
2381
+ */
2382
+ onDragCreateStart? : ((event: { source: Gantt, proxyElement: HTMLElement }) => void)|string
2383
+ /**
2384
+ * Fires while drag selecting. UI will update with current range, but the cells will not be selected until
2385
+ * mouse up. This event can be listened for to perform actions while drag selecting.
2386
+ * @param {object} event Event object
2387
+ * @param {Grid.view.Grid} event.source
2388
+ * @param {GridLocationConfig[],Grid.util.GridLocation[]} event.selectedCells The cells that is currently being dragged over
2389
+ * @param {Core.data.Model[]} event.selectedRecords The records that is currently being dragged over
2390
+ */
2391
+ onDragSelecting? : ((event: { source: Grid, selectedCells: GridLocationConfig[]|GridLocation[], selectedRecords: Model[] }) => void)|string
2392
+ /**
2393
+ * Triggered when a widget's [element](https://bryntum.com/products/gantt/docs/api/Core/widget/Widget#property-element) is available.
2394
+ * @param {object} event Event object
2395
+ * @param {HTMLElement} event.element The Widget's element.
2396
+ */
2397
+ onElementCreated? : ((event: { element: HTMLElement }) => void)|string
2398
+ /**
2399
+ * Fired before the editor will load the event record data into its input fields. This is useful if you
2400
+ * want to modify the fields before data is loaded (e.g. set some input field to be readonly)
2401
+ * @param {object} event Event object
2402
+ * @param {Core.widget.Container} event.source The editor widget
2403
+ * @param {Scheduler.model.SchedulerEventModel} event.record The record
2404
+ */
2405
+ onEventEditBeforeSetRecord? : ((event: { source: Container, record: SchedulerEventModel }) => void)|string
2406
+ /**
2407
+ * This event fires on the owning Scheduler before the context menu is shown for an event. Allows manipulation of the items
2408
+ * to show in the same way as in `processItems`. Returning `false` from a listener prevents the menu from
2409
+ * being shown.
2410
+ * @param {object} event Event object
2411
+ * @param {Scheduler.view.Scheduler} event.source
2412
+ * @param {Record<string, MenuItemEntry>} event.items Menu item configs
2413
+ * @param {Scheduler.model.SchedulerEventModel} event.eventRecord Event record for which the menu was triggered
2414
+ * @param {Scheduler.model.SchedulerResourceModel} event.resourceRecord Resource record
2415
+ * @param {Scheduler.model.SchedulerAssignmentModel} event.assignmentRecord Assignment record, if assignments are used
2416
+ * @param {HTMLElement} event.eventElement
2417
+ * @param {MouseEvent} event.event Pointer event which triggered the context menu (if any)
2418
+ */
2419
+ onEventMenuBeforeShow? : ((event: { source: Scheduler, items: Record<string, MenuItemEntry>, eventRecord: SchedulerEventModel, resourceRecord: SchedulerResourceModel, assignmentRecord: SchedulerAssignmentModel, eventElement: HTMLElement, event?: MouseEvent }) => Promise<boolean>|boolean|void)|string
2420
+ /**
2421
+ * This event fires on the owning Scheduler when an item is selected in the context menu.
2422
+ * @param {object} event Event object
2423
+ * @param {Scheduler.view.Scheduler} event.source
2424
+ * @param {Core.widget.MenuItem} event.item
2425
+ * @param {Scheduler.model.SchedulerEventModel} event.eventRecord
2426
+ * @param {Scheduler.model.SchedulerResourceModel} event.resourceRecord
2427
+ * @param {Scheduler.model.SchedulerAssignmentModel} event.assignmentRecord Assignment record, if assignments are used
2428
+ * @param {HTMLElement} event.eventElement
2429
+ */
2430
+ onEventMenuItem? : ((event: { source: Scheduler, item: MenuItem, eventRecord: SchedulerEventModel, resourceRecord: SchedulerResourceModel, assignmentRecord: SchedulerAssignmentModel, eventElement: HTMLElement }) => void)|string
2431
+ /**
2432
+ * This event fires on the owning Scheduler after showing the context menu for an event
2433
+ * @param {object} event Event object
2434
+ * @param {Scheduler.view.Scheduler} event.source
2435
+ * @param {Core.widget.Menu} event.menu The menu
2436
+ * @param {Scheduler.model.SchedulerEventModel} event.eventRecord Event record for which the menu was triggered
2437
+ * @param {Scheduler.model.SchedulerResourceModel} event.resourceRecord Resource record
2438
+ * @param {Scheduler.model.SchedulerAssignmentModel} event.assignmentRecord Assignment record, if assignments are used
2439
+ * @param {HTMLElement} event.eventElement
2440
+ */
2441
+ onEventMenuShow? : ((event: { source: Scheduler, menu: Menu, eventRecord: SchedulerEventModel, resourceRecord: SchedulerResourceModel, assignmentRecord: SchedulerAssignmentModel, eventElement: HTMLElement }) => void)|string
2442
+ /**
2443
+ * Fires on the owning Scheduler on each resize move event
2444
+ * @param {object} event Event object
2445
+ * @param {Scheduler.view.Scheduler} event.source Scheduler instance
2446
+ * @param {Scheduler.model.SchedulerEventModel} event.eventRecord Event record being resized
2447
+ * @param {Date} event.startDate
2448
+ * @param {Date} event.endDate
2449
+ * @param {HTMLElement} event.element
2450
+ * @param {EventResizeData[]} event.resizeData Resize data for selected events
2451
+ */
2452
+ onEventPartialResize? : ((event: { source: Scheduler, eventRecord: SchedulerEventModel, startDate: Date, endDate: Date, element: HTMLElement, resizeData: EventResizeData[] }) => void)|string
2453
+ /**
2454
+ * Fires on the owning Scheduler after the resizing gesture has finished.
2455
+ * @param {object} event Event object
2456
+ * @param {Scheduler.view.Scheduler} event.source Scheduler instance
2457
+ * @param {boolean} event.changed Shows if the record has been changed by the resize action
2458
+ * @param {Scheduler.model.SchedulerEventModel} event.eventRecord Event record being resized
2459
+ * @param {EventResizeData[]} event.resizeData Resize data for selected events
2460
+ */
2461
+ onEventResizeEnd? : ((event: { source: Scheduler, changed: boolean, eventRecord: SchedulerEventModel, resizeData: EventResizeData[] }) => void)|string
2462
+ /**
2463
+ * Fires on the owning Scheduler when event resizing starts
2464
+ * @param {object} event Event object
2465
+ * @param {Scheduler.view.Scheduler} event.source Scheduler instance
2466
+ * @param {Scheduler.model.SchedulerEventModel} event.eventRecord Event record being resized
2467
+ * @param {Scheduler.model.SchedulerResourceModel} event.resourceRecord Resource record the resize starts within
2468
+ * @param {MouseEvent} event.event Browser event
2469
+ * @param {EventResizeData[]} event.resizeData Resize data for selected events. Only available when [resizeSelected](https://bryntum.com/products/gantt/docs/api/Scheduler/feature/EventResize#config-resizeSelected) is `true`
2470
+ */
2471
+ onEventResizeStart? : ((event: { source: Scheduler, eventRecord: SchedulerEventModel, resourceRecord: SchedulerResourceModel, event: MouseEvent, resizeData: EventResizeData[] }) => void)|string
2472
+ /**
2473
+ * Fires on the owning Scheduler Pro on each segment resize move event
2474
+ * @param {object} event Event object
2475
+ * @param {SchedulerPro.view.SchedulerPro} event.source Scheduler Pro instance
2476
+ * @param {SchedulerPro.model.EventModel} event.eventRecord Segment being resized
2477
+ * @param {Date} event.startDate
2478
+ * @param {Date} event.endDate
2479
+ * @param {HTMLElement} event.element
2480
+ */
2481
+ onEventSegmentPartialResize? : ((event: { source: SchedulerPro, eventRecord: EventModel, startDate: Date, endDate: Date, element: HTMLElement }) => void)|string
2482
+ /**
2483
+ * Fires on the owning Scheduler Pro after the resizing gesture has finished.
2484
+ * @param {object} event Event object
2485
+ * @param {SchedulerPro.view.SchedulerPro} event.source Scheduler Pro instance
2486
+ * @param {boolean} event.changed Shows if the record has been changed by the resize action
2487
+ * @param {SchedulerPro.model.EventModel} event.eventRecord Segment being resized
2488
+ */
2489
+ onEventSegmentResizeEnd? : ((event: { source: SchedulerPro, changed: boolean, eventRecord: EventModel }) => void)|string
2490
+ /**
2491
+ * Fires on the owning Scheduler Pro when segment resizing starts
2492
+ * @param {object} event Event object
2493
+ * @param {SchedulerPro.view.SchedulerPro} event.source Scheduler Pro instance
2494
+ * @param {SchedulerPro.model.EventModel} event.eventRecord Segment being resized
2495
+ * @param {SchedulerPro.model.SchedulerProResourceModel} event.resourceRecord Resource record the resize starts within
2496
+ * @param {MouseEvent} event.event Browser event
2497
+ */
2498
+ onEventSegmentResizeStart? : ((event: { source: SchedulerPro, eventRecord: EventModel, resourceRecord: SchedulerProResourceModel, event: MouseEvent }) => void)|string
2499
+ /**
2500
+ * Fires when a Panel is expanded using the [collapsible](https://bryntum.com/products/gantt/docs/api/Core/widget/Panel#config-collapsible) setting.
2501
+ * @param {object} event Event object
2502
+ * @param {Core.widget.Panel} event.source This Panel.
2503
+ */
2504
+ onExpand? : ((event: { source: Panel }) => void)|string
2505
+ /**
2506
+ * Fired after a parent node record is expanded.
2507
+ * @param {object} event Event object
2508
+ * @param {Grid.view.Grid} event.source The firing Grid instance.
2509
+ * @param {Core.data.Model} event.record The record which has been expanded.
2510
+ */
2511
+ onExpandNode? : ((event: { source: Grid, record: Model }) => void)|string
2512
+ /**
2513
+ * Fired when a file is dropped on the widget element
2514
+ * @param {object} event Event object
2515
+ * @param {Grid.view.Grid} event.source The owning Grid instance
2516
+ * @param {DataTransferItem} event.file The dropped file descriptor
2517
+ * @param {DragEvent} event.domEvent The native DragEvent
2518
+ */
2519
+ onFileDrop? : ((event: { source: Grid, file: DataTransferItem, domEvent: DragEvent }) => void)|string
2520
+ /**
2521
+ * Fired before the FillHandle dragging is finalized and values are applied to cells, return `false` to prevent the
2522
+ * drag operation from applying data changes.
2523
+ * @param {object} event Event object
2524
+ * @param {Grid.util.GridLocation} event.from The from cell
2525
+ * @param {Grid.util.GridLocation} event.to The to cell
2526
+ * @param {MouseEvent} event.domEvent The raw DOM event
2527
+ */
2528
+ onFillHandleBeforeDragFinalize? : ((event: { from: GridLocation, to: GridLocation, domEvent: MouseEvent }) => Promise<boolean>|boolean|void)|string
2529
+ /**
2530
+ * Fired while dragging the FillHandle.
2531
+ * @param {object} event Event object
2532
+ * @param {Grid.util.GridLocation} event.from The from cell
2533
+ * @param {Grid.util.GridLocation} event.to The to cell
2534
+ * @param {MouseEvent} event.domEvent The raw DOM event
2535
+ */
2536
+ onFillHandleDrag? : ((event: { from: GridLocation, to: GridLocation, domEvent: MouseEvent }) => void)|string
2537
+ /**
2538
+ * Fired when a FillHandle drag operation is aborted.
2539
+ */
2540
+ onFillHandleDragAbort? : (() => void)|string
2541
+ /**
2542
+ * Fired after a FillHandle drag operation.
2543
+ * @param {object} event Event object
2544
+ * @param {Grid.util.GridLocation} event.from The from cell
2545
+ * @param {Grid.util.GridLocation} event.to The to cell
2546
+ * @param {MouseEvent} event.domEvent The raw DOM event
2547
+ */
2548
+ onFillHandleDragEnd? : ((event: { from: GridLocation, to: GridLocation, domEvent: MouseEvent }) => void)|string
2549
+ /**
2550
+ * Fired when dragging of the FillHandle starts.
2551
+ * @param {object} event Event object
2552
+ * @param {Grid.util.GridLocation} event.cell Information about the column / record
2553
+ * @param {MouseEvent} event.domEvent The raw DOM event
2554
+ */
2555
+ onFillHandleDragStart? : ((event: { cell: GridLocation, domEvent: MouseEvent }) => Promise<boolean>|boolean|void)|string
2556
+ /**
2557
+ * Fires on the owning Grid when cell editing is finished
2558
+ * @param {object} event Event object
2559
+ * @param {Grid.view.Grid} event.grid Target grid
2560
+ * @param {CellEditorContext} event.editorContext Editing context
2561
+ */
2562
+ onFinishCellEdit? : ((event: { grid: Grid, editorContext: CellEditorContext }) => void)|string
2563
+ /**
2564
+ * 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.
2565
+ * ...
2566
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#event-finishRowEdit)
2567
+ * @param {object} event Event object
2568
+ * @param {Grid.view.Grid} event.grid Target grid
2569
+ * @param {RowEditorContext} event.editorContext Editing context
2570
+ */
2571
+ onFinishRowEdit? : ((event: { grid: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string
2572
+ /**
2573
+ * Fired when focus enters this Widget.
2574
+ * @param {object} event Event object
2575
+ * @param {Core.widget.Widget} event.source This Widget
2576
+ * @param {HTMLElement} event.fromElement The element which lost focus.
2577
+ * @param {HTMLElement} event.toElement The element which gained focus.
2578
+ * @param {Core.widget.Widget} event.fromWidget The widget which lost focus.
2579
+ * @param {Core.widget.Widget} event.toWidget The widget which gained focus.
2580
+ * @param {boolean} event.backwards `true` if the `toElement` is before the `fromElement` in document order.
2581
+ */
2582
+ onFocusIn? : ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string
2583
+ /**
2584
+ * Fired when focus exits this Widget's ownership tree. This is different from a `blur` event.
2585
+ * focus moving from within this Widget's ownership tree, even if there are floating widgets
2586
+ * will not trigger this event. This is when focus exits this widget completely.
2587
+ * @param {object} event Event object
2588
+ * @param {Core.widget.Widget} event.source This Widget
2589
+ * @param {HTMLElement} event.fromElement The element which lost focus.
2590
+ * @param {HTMLElement} event.toElement The element which gained focus.
2591
+ * @param {Core.widget.Widget} event.fromWidget The widget which lost focus.
2592
+ * @param {Core.widget.Widget} event.toWidget The widget which gained focus.
2593
+ * @param {boolean} event.backwards `true` if the `toElement` is before the `fromElement` in document order.
2594
+ */
2595
+ onFocusOut? : ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string
2596
+ /**
2597
+ * Fired before dragging starts, return false to prevent the drag operation.
2598
+ * @param {object} event Event object
2599
+ * @param {Grid.view.GridBase} event.source
2600
+ * @param {object} event.context
2601
+ * @param {Core.data.Model[]} event.context.records The dragged row records
2602
+ * @param {MouseEvent,TouchEvent} event.event
2603
+ */
2604
+ onGridRowBeforeDragStart? : ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => Promise<boolean>|boolean|void)|string
2605
+ /**
2606
+ * Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
2607
+ * Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
2608
+ * @param {object} event Event object
2609
+ * @param {Grid.view.GridBase} event.source
2610
+ * @param {object} event.context
2611
+ * @param {boolean} event.context.valid Set this to true or false to indicate whether the drop position is valid
2612
+ * @param {Core.data.Model} event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
2613
+ * @param {Core.data.Model} event.context.parent The parent record of the current drop position (only applicable for trees)
2614
+ * @param {Core.data.Model[]} event.context.records The dragged row records
2615
+ * @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
2616
+ * @param {MouseEvent} event.event
2617
+ */
2618
+ onGridRowBeforeDropFinalize? : ((event: { source: GridBase, context: { valid: boolean, insertBefore: Model, parent: Model, records: Model[], oldPositionContext: RecordPositionContext[] }, event: MouseEvent }) => Promise<boolean>|boolean|void)|string
2619
+ /**
2620
+ * Fired while the row is being dragged, in the listener function you have access to `context.insertBefore` a grid /
2621
+ * tree record, and additionally `context.parent` (a TreeNode) for trees. You can signal that the drop position is
2622
+ * valid or invalid by setting `context.valid = false;`
2623
+ * @param {object} event Event object
2624
+ * @param {Grid.view.GridBase} event.source
2625
+ * @param {object} event.context
2626
+ * @param {boolean} event.context.valid Set this to true or false to indicate whether the drop position is valid.
2627
+ * @param {Core.data.Model} event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
2628
+ * @param {Core.data.Model} event.context.parent The parent record of the current drop position (only applicable for trees)
2629
+ * @param {Core.data.Model[]} event.context.records The dragged row records
2630
+ * @param {MouseEvent} event.event
2631
+ */
2632
+ onGridRowDrag? : ((event: { source: GridBase, context: { valid: boolean, insertBefore: Model, parent: Model, records: Model[] }, event: MouseEvent }) => void)|string
2633
+ /**
2634
+ * Fired when a row drag operation is aborted
2635
+ * @param {object} event Event object
2636
+ * @param {Grid.view.GridBase} event.source
2637
+ * @param {object} event.context
2638
+ * @param {Core.data.Model[]} event.context.records The dragged row records
2639
+ * @param {MouseEvent} event.event
2640
+ */
2641
+ onGridRowDragAbort? : ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent }) => void)|string
2642
+ /**
2643
+ * Fired when dragging starts.
2644
+ * @param {object} event Event object
2645
+ * @param {Grid.view.GridBase} event.source
2646
+ * @param {object} event.context
2647
+ * @param {Core.data.Model[]} event.context.records The dragged row records
2648
+ * @param {MouseEvent,TouchEvent} event.event
2649
+ */
2650
+ onGridRowDragStart? : ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => void)|string
2651
+ /**
2652
+ * Fired after the row drop operation has completed, regardless of validity
2653
+ * @param {object} event Event object
2654
+ * @param {Grid.view.GridBase} event.source
2655
+ * @param {object} event.context
2656
+ * @param {boolean} event.context.valid true or false depending on whether the drop position was valid
2657
+ * @param {Core.data.Model} event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
2658
+ * @param {Core.data.Model} event.context.parent The parent record of the current drop position (only applicable for trees)
2659
+ * @param {Core.data.Model[]} event.context.records The dragged row records
2660
+ * @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
2661
+ * @param {MouseEvent} event.event
2662
+ */
2663
+ onGridRowDrop? : ((event: { source: GridBase, context: { valid: boolean, insertBefore: Model, parent: Model, records: Model[], oldPositionContext: RecordPositionContext[] }, event: MouseEvent }) => void)|string
2664
+ /**
2665
+ * Fired when a grid header is clicked on.
2666
+ * ...
2667
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#event-headerClick)
2668
+ * @param {object} event Event object
2669
+ * @param {Event} event.domEvent The triggering DOM event.
2670
+ * @param {Grid.column.Column} event.column The column clicked on.
2671
+ */
2672
+ onHeaderClick? : ((event: { domEvent: Event, column: Column }) => Promise<boolean>|boolean|void)|string
2673
+ /**
2674
+ * This event fires on the owning Grid before the context menu is shown for a header.
2675
+ * 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).
2676
+ * ...
2677
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#event-headerMenuBeforeShow)
2678
+ * @param {object} event Event object
2679
+ * @param {Grid.view.Grid} event.source The grid
2680
+ * @param {Core.widget.Menu} event.menu The menu
2681
+ * @param {Record<string, MenuItemEntry>} event.items Menu item configs
2682
+ * @param {Grid.column.Column} event.column Column
2683
+ */
2684
+ onHeaderMenuBeforeShow? : ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => Promise<boolean>|boolean|void)|string
2685
+ /**
2686
+ * This event fires on the owning Grid when an item is selected in the header context menu.
2687
+ * @param {object} event Event object
2688
+ * @param {Grid.view.Grid} event.source The grid
2689
+ * @param {Core.widget.Menu} event.menu The menu
2690
+ * @param {Core.widget.MenuItem} event.item Selected menu item
2691
+ * @param {Grid.column.Column} event.column Column
2692
+ */
2693
+ onHeaderMenuItem? : ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column }) => void)|string
2694
+ /**
2695
+ * This event fires on the owning Grid after the context menu is shown for a header
2696
+ * @param {object} event Event object
2697
+ * @param {Grid.view.Grid} event.source The grid
2698
+ * @param {Core.widget.Menu} event.menu The menu
2699
+ * @param {Record<string, MenuItemEntry>} event.items Menu item configs
2700
+ * @param {Grid.column.Column} event.column Column
2701
+ */
2702
+ onHeaderMenuShow? : ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => void)|string
2703
+ /**
2704
+ * This event fires on the owning Grid when a check item is toggled in the header context menu.
2705
+ * @param {object} event Event object
2706
+ * @param {Grid.view.Grid} event.source The grid
2707
+ * @param {Core.widget.Menu} event.menu The menu
2708
+ * @param {Core.widget.MenuItem} event.item Selected menu item
2709
+ * @param {Grid.column.Column} event.column Column
2710
+ * @param {boolean} event.checked Checked or not
2711
+ */
2712
+ onHeaderMenuToggleItem? : ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column, checked: boolean }) => void)|string
2713
+ /**
2714
+ * Triggered after a widget was hidden
2715
+ * @param {object} event Event object
2716
+ * @param {Core.widget.Widget} event.source The widget
2717
+ */
2718
+ onHide? : ((event: { source: Widget }) => void)|string
2719
+ /**
2720
+ * Fires when row locking is enabled.
2721
+ * @param {object} event Event object
2722
+ * @param {Grid.view.GridBase} event.clone The created clone
2723
+ */
2724
+ onLockRows? : ((event: { clone: GridBase }) => void)|string
2725
+ /**
2726
+ * Mouse moved out from element in grid
2727
+ * @param {object} event Event object
2728
+ * @param {MouseEvent} event.event The native browser event
2729
+ */
2730
+ onMouseOut? : ((event: { event: MouseEvent }) => void)|string
2731
+ /**
2732
+ * Mouse moved in over element in grid
2733
+ * @param {object} event Event object
2734
+ * @param {MouseEvent} event.event The native browser event
2735
+ */
2736
+ onMouseOver? : ((event: { event: MouseEvent }) => void)|string
2737
+ /**
2738
+ * Fires on the owning Gantt when project content is exported
2739
+ * to XML, before the XML is downloaded by the browser.
2740
+ * @param {object} event Event object
2741
+ * @param {object} event.config Export config
2742
+ * @param {string} event.fileContent Exported XML-file content
2743
+ */
2744
+ onMspExport? : ((event: { config: object, fileContent: string }) => void)|string
2745
+ /**
2746
+ * Fired when a user gesture causes the active item to change.
2747
+ * @param {object} event Event object
2748
+ * @param {Event} event.event The browser event which instigated navigation. May be a click or key or focus event.
2749
+ * @param {HTMLElement,null} event.item The newly active item, or `null` if focus moved out.
2750
+ * @param {HTMLElement,null} event.oldItem The previously active item, or `null` if focus is moving in.
2751
+ */
2752
+ onNavigate? : ((event: { event: Event, item: HTMLElement|null, oldItem: HTMLElement|null }) => void)|string
2753
+ /**
2754
+ * Fires when the requested date range cannot fit into any zoom level higher than the current level.
2755
+ * @param {object} event Event object
2756
+ * @param {number} event.currentZoomLevel The current zoom level
2757
+ * @param {Date} event.startDate The requested start date
2758
+ * @param {Date} event.endDate The requested end date
2759
+ */
2760
+ onNoZoomChange? : ((event: { currentZoomLevel: number, startDate: Date, endDate: Date }) => void)|string
2761
+ /**
2762
+ * Triggered when a widget which had been in a non-visible state for any reason
2763
+ * achieves visibility.
2764
+ * ...
2765
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#event-paint)
2766
+ * @param {object} event Event object
2767
+ * @param {Core.widget.Widget} event.source The widget being painted.
2768
+ * @param {boolean} event.firstPaint `true` if this is the first paint.
2769
+ */
2770
+ onPaint? : ((event: { source: Widget, firstPaint: boolean }) => void)|string
2771
+ /**
2772
+ * Fires on the owning Grid after a paste action is performed.
2773
+ * @param {object} event Event object
2774
+ * @param {Grid.view.Grid} event.source Owner grid
2775
+ * @param {string} event.clipboardData The clipboardData that was pasted
2776
+ * @param {Core.data.Model[]} event.modifiedRecords The records which have been modified due to the paste action
2777
+ * @param {Grid.util.GridLocation} event.targetCell The cell from which the paste will be started
2778
+ * @param {string} event.entityName 'cell' to distinguish this event from other paste events
2779
+ */
2780
+ onPaste? : ((event: { source: Grid, clipboardData: string, modifiedRecords: Model[], targetCell: GridLocation, entityName: string }) => void)|string
2781
+ /**
2782
+ * Fires on the owning Grid when export has finished
2783
+ * @param {object} event Event object
2784
+ * @param {Response} event.response Optional response, if received
2785
+ * @param {Error} event.error Optional error, if exception occurred
2786
+ */
2787
+ onPdfExport? : ((event: { response?: any, error?: Error }) => void)|string
2788
+ /**
2789
+ * Fired on the owning Scheduler or Gantt widget when dragging the percent bar
2790
+ * @param {object} event Event object
2791
+ * @param {Scheduler.view.TimelineBase} event.source SchedulerPro or Gantt instance
2792
+ * @param {Core.data.Model} event.taskRecord The task record
2793
+ * @param {MouseEvent} event.domEvent Browser event
2794
+ */
2795
+ onPercentBarDrag? : ((event: { source: TimelineBase, taskRecord: Model, domEvent: MouseEvent }) => void)|string
2796
+ /**
2797
+ * Fired on the owning Scheduler or Gantt widget if a percent bar drag-drop operation is aborted
2798
+ * @param {object} event Event object
2799
+ * @param {Scheduler.view.TimelineBase} event.source SchedulerPro instance
2800
+ * @param {Core.data.Model} event.taskRecord The task record
2801
+ * @param {MouseEvent} event.domEvent Browser event
2802
+ */
2803
+ onPercentBarDragAbort? : ((event: { source: TimelineBase, taskRecord: Model, domEvent: MouseEvent }) => void)|string
2804
+ /**
2805
+ * Fired on the owning Scheduler or Gantt widget when percent bar dragging starts
2806
+ * @param {object} event Event object
2807
+ * @param {Scheduler.view.TimelineBase} event.source SchedulerPro or Gantt instance
2808
+ * @param {Core.data.Model} event.taskRecord The task record
2809
+ * @param {MouseEvent} event.domEvent Browser event
2810
+ */
2811
+ onPercentBarDragStart? : ((event: { source: TimelineBase, taskRecord: Model, domEvent: MouseEvent }) => void)|string
2812
+ /**
2813
+ * Fired on the owning Scheduler or Gantt widget when dropping the percent bar
2814
+ * @param {object} event Event object
2815
+ * @param {Scheduler.view.TimelineBase} event.source SchedulerPro or Gantt instance
2816
+ * @param {Core.data.Model} event.taskRecord The task record
2817
+ * @param {MouseEvent} event.domEvent Browser event
2818
+ */
2819
+ onPercentBarDrop? : ((event: { source: TimelineBase, taskRecord: Model, domEvent: MouseEvent }) => void)|string
2820
+ /**
2821
+ * Fired after the [viewPreset](https://bryntum.com/products/gantt/docs/api/Scheduler/view/mixin/TimelineViewPresets#config-viewPreset) has changed.
2822
+ * @param {object} event Event object
2823
+ * @param {Scheduler.view.Scheduler} event.source This Scheduler instance.
2824
+ * @param {Date} event.startDate The new start date of the timeline.
2825
+ * @param {Date} event.centerDate The new center date of the timeline.
2826
+ * @param {Date} event.endDate The new end date of the timeline.
2827
+ * @param {Scheduler.preset.ViewPreset} event.from The outgoing ViewPreset.
2828
+ * @param {Scheduler.preset.ViewPreset} event.to The ViewPreset being switched to.
2829
+ */
2830
+ onPresetChange? : ((event: { source: Scheduler, startDate: Date, centerDate: Date, endDate: Date, from: ViewPreset, to: ViewPreset }) => Promise<boolean>|boolean|void)|string
2831
+ /**
2832
+ * Fires on the owning Gantt widget when the editor for a project is canceled.
2833
+ * @param {object} event Event object
2834
+ * @param {Gantt.view.Gantt} event.source The Gantt instance
2835
+ * @param {Gantt.model.ProjectModel} event.projectRecord The edited project
2836
+ * @param {Gantt.widget.ProjectEditor} event.editor The editor
2837
+ */
2838
+ onProjectEditCanceled? : ((event: { source: Gantt, projectRecord: ProjectModel, editor: ProjectEditor }) => void)|string
2839
+ /**
2840
+ * Fired when a Widget's read only state is toggled
2841
+ * @param {object} event Event object
2842
+ * @param {boolean} event.readOnly Read only or not
2843
+ */
2844
+ onReadOnly? : ((event: { readOnly: boolean }) => void)|string
2845
+ /**
2846
+ * This event is fired after a widget's elements have been synchronized due to a direct or indirect call
2847
+ * 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.
2848
+ */
2849
+ onRecompose? : (() => void)|string
2850
+ /**
2851
+ * Task is released, no longer in view/removed. A good spot for cleaning custom things added in a `renderTask`
2852
+ * listener up, if needed.
2853
+ * @param {object} event Event object
2854
+ * @param {Gantt.view.Gantt} event.source The Gantt instance
2855
+ * @param {object} event.renderData Task render data
2856
+ * @param {Gantt.model.TaskModel} event.taskRecord Rendered task
2857
+ * @param {HTMLElement} event.element Task element
2858
+ */
2859
+ onReleaseTask? : ((event: { source: Gantt, renderData: object, taskRecord: TaskModel, element: HTMLElement }) => void)|string
2860
+ /**
2861
+ * Fires after a row is rendered.
2862
+ * @param {object} event Event object
2863
+ * @param {Grid.view.Grid} event.source The firing Grid instance.
2864
+ * @param {Grid.row.Row} event.row The row that has been rendered.
2865
+ * @param {Core.data.Model} event.record The record for the row.
2866
+ * @param {number} event.recordIndex The zero-based index of the record.
2867
+ */
2868
+ onRenderRow? : ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
2869
+ /**
2870
+ * Grid rows have been rendered
2871
+ * @param {object} event Event object
2872
+ * @param {Grid.view.Grid} event.source This grid.
2873
+ */
2874
+ onRenderRows? : ((event: { source: Grid }) => void)|string
2875
+ /**
2876
+ * Task is rendered, its element is available in DOM.
2877
+ * @param {object} event Event object
2878
+ * @param {Gantt.view.Gantt} event.source The Gantt instance
2879
+ * @param {object} event.renderData Task render data
2880
+ * @param {Gantt.model.TaskModel} event.taskRecord Rendered task
2881
+ * @param {HTMLElement} event.element Task element
2882
+ */
2883
+ onRenderTask? : ((event: { source: Gantt, renderData: object, taskRecord: TaskModel, element: HTMLElement }) => void)|string
2884
+ /**
2885
+ * 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`*.
2886
+ * @param {object} event Event object
2887
+ * @param {Core.widget.Widget} event.source This Widget
2888
+ * @param {number} event.width The new width
2889
+ * @param {number} event.height The new height
2890
+ * @param {number} event.oldWidth The old width
2891
+ * @param {number} event.oldHeight The old height
2892
+ */
2893
+ onResize? : ((event: { source: Widget, width: number, height: number, oldWidth: number, oldHeight: number }) => void)|string
2894
+ /**
2895
+ * Triggered when clicking a resource avatar or chip in the cells of the [ResourceAssignmentColumn](https://bryntum.com/products/gantt/docs/api/Gantt/column/ResourceAssignmentColumn).
2896
+ * @param {object} event Event object
2897
+ * @param {Gantt.view.Gantt} event.source This Gantt
2898
+ * @param {Gantt.model.TaskModel} event.taskRecord Task record
2899
+ * @param {Gantt.model.ResourceModel} event.resourceRecord Resource record
2900
+ * @param {Event} event.event Browser event
2901
+ */
2902
+ onResourceAssignmentClick? : ((event: { source: Gantt, taskRecord: TaskModel, resourceRecord: ResourceModel, event: Event }) => void)|string
2903
+ /**
2904
+ * Grid resize lead to a new responsive level being applied
2905
+ * @param {object} event Event object
2906
+ * @param {Grid.view.Grid} event.grid Grid that was resized
2907
+ * @param {string} event.level New responsive level (small, large, etc)
2908
+ * @param {number} event.width New width in px
2909
+ * @param {string} event.oldLevel Old responsive level
2910
+ * @param {number} event.oldWidth Old width in px
2911
+ */
2912
+ onResponsive? : ((event: { grid: Grid, level: string, width: number, oldLevel: string, oldWidth: number }) => void)|string
2913
+ /**
2914
+ * This event fires when a row has finished collapsing.
2915
+ * @param {object} event Event object
2916
+ * @param {Core.data.Model} event.record Record
2917
+ */
2918
+ onRowCollapse? : ((event: { record: Model }) => void)|string
2919
+ /**
2920
+ * This event fires when a row expand has finished expanding.
2921
+ * ...
2922
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#event-rowExpand)
2923
+ * @param {object} event Event object
2924
+ * @param {Core.data.Model} event.record Record
2925
+ * @param {object} event.expandedElements An object with the Grid region name as property and the expanded body element as value
2926
+ * @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.
2927
+ * @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
2928
+ */
2929
+ onRowExpand? : ((event: { record: Model, expandedElements: object, widget: Widget, widgets: object }) => void)|string
2930
+ /**
2931
+ * Fired when the mouse enters a row
2932
+ * @param {object} event Event object
2933
+ * @param {Grid.view.Grid} event.source The grid instance
2934
+ * @param {Core.data.Model} event.record The record representing the hovered row
2935
+ * @param {Grid.column.Column} event.column The column currently hovered
2936
+ * @param {HTMLElement} event.cellElement The cell HTML element
2937
+ * @param {MouseEvent} event.event The native DOM event
2938
+ */
2939
+ onRowMouseEnter? : ((event: { source: Grid, record: Model, column: Column, cellElement: HTMLElement, event: MouseEvent }) => void)|string
2940
+ /**
2941
+ * Fired when the mouse leaves a row
2942
+ * @param {object} event Event object
2943
+ * @param {Grid.view.Grid} event.source The grid instance
2944
+ * @param {Core.data.Model} event.record The record representing the row that the mouse left
2945
+ * @param {HTMLElement} event.cellElement The cell HTML element that the mouse left
2946
+ * @param {MouseEvent} event.event The native DOM event
2947
+ */
2948
+ onRowMouseLeave? : ((event: { source: Grid, record: Model, cellElement: HTMLElement, event: MouseEvent }) => void)|string
2949
+ /**
2950
+ * This event fires on the owning Scheduler or Gantt widget before the context menu is shown for the schedule.
2951
+ * Allows manipulation of the items to show in the same way as in `processItems`. Returning `false` from a listener
2952
+ * prevents the menu from being shown.
2953
+ * @param {object} event Event object
2954
+ * @param {Scheduler.view.Scheduler} event.source
2955
+ * @param {Record<string, MenuItemEntry>} event.items Menu item configs
2956
+ * @param {Scheduler.model.SchedulerResourceModel} event.resourceRecord Resource record
2957
+ * @param {Date} event.date Clicked date, rounded according to viewPreset's settings
2958
+ * @param {Scheduler.model.SchedulerAssignmentModel} event.assignmentRecord Assignment record, if assignments are used
2959
+ * @param {HTMLElement} event.eventElement
2960
+ */
2961
+ onScheduleMenuBeforeShow? : ((event: { source: Scheduler, items: Record<string, MenuItemEntry>, resourceRecord: SchedulerResourceModel, date: Date, assignmentRecord: SchedulerAssignmentModel, eventElement: HTMLElement }) => Promise<boolean>|boolean|void)|string
2962
+ /**
2963
+ * This event fires on the owning Scheduler or Gantt widget when an item is selected in the context menu.
2964
+ * @param {object} event Event object
2965
+ * @param {Scheduler.view.Scheduler} event.source
2966
+ * @param {Core.widget.MenuItem} event.item
2967
+ * @param {Scheduler.model.SchedulerResourceModel} event.resourceRecord
2968
+ * @param {Date} event.date Clicked date, rounded according to viewPreset's settings
2969
+ * @param {HTMLElement} event.element
2970
+ */
2971
+ onScheduleMenuItem? : ((event: { source: Scheduler, item: MenuItem, resourceRecord: SchedulerResourceModel, date: Date, element: HTMLElement }) => void)|string
2972
+ /**
2973
+ * This event fires on the owning Scheduler or Gantt widget after showing the context menu for the schedule.
2974
+ * @param {object} event Event object
2975
+ * @param {Scheduler.view.Scheduler} event.source
2976
+ * @param {Record<string, MenuItemEntry>} event.items Menu item configs
2977
+ * @param {Core.widget.Menu} event.menu The menu
2978
+ * @param {Scheduler.model.SchedulerResourceModel} event.resourceRecord
2979
+ * @param {Date} event.date Clicked date, rounded according to viewPreset's settings
2980
+ * @param {HTMLElement} event.targetElement
2981
+ */
2982
+ onScheduleMenuShow? : ((event: { source: Scheduler, items: Record<string, MenuItemEntry>, menu: Menu, resourceRecord: SchedulerResourceModel, date: Date, targetElement: HTMLElement }) => void)|string
2983
+ /**
2984
+ * Grid has scrolled vertically
2985
+ * @param {object} event Event object
2986
+ * @param {Grid.view.Grid} event.source The firing Grid instance.
2987
+ * @param {number} event.scrollTop The vertical scroll position.
2988
+ */
2989
+ onScroll? : ((event: { source: Grid, scrollTop: number }) => void)|string
2990
+ /**
2991
+ * Fires on owner when the scroll button is clicked, return `false` to prevent default scroll behavior
2992
+ * @param {object} event Event object
2993
+ * @param {Event} event.domEvent DOM event
2994
+ * @param {Gantt.model.TaskModel} event.taskRecord The task record
2995
+ */
2996
+ onScrollButtonClick? : ((event: { domEvent: Event, taskRecord: TaskModel }) => Promise<boolean>|boolean|void)|string
2997
+ /**
2998
+ * The selection has been changed.
2999
+ * @param {object} event Event object
3000
+ * @param {'select','deselect'} event.action `'select'`/`'deselect'`
3001
+ * @param {'row','cell'} event.mode `'row'`/`'cell'`
3002
+ * @param {Grid.view.Grid} event.source
3003
+ * @param {Core.data.Model[]} event.deselected The records deselected in this operation.
3004
+ * @param {Core.data.Model[]} event.selected The records selected in this operation.
3005
+ * @param {Core.data.Model[]} event.selection The records in the new selection.
3006
+ * @param {Grid.util.GridLocation[]} event.deselectedCells The cells deselected in this operation.
3007
+ * @param {Grid.util.GridLocation[]} event.selectedCells The cells selected in this operation.
3008
+ * @param {Grid.util.GridLocation[]} event.cellSelection The cells in the new selection.
3009
+ */
3010
+ onSelectionChange? : ((event: { action: 'select'|'deselect', mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => void)|string
3011
+ /**
3012
+ * The selectionMode configuration has been changed.
3013
+ * @param {object} event Event object
3014
+ * @param {object} event.selectionMode The new [selectionMode](https://bryntum.com/products/gantt/docs/api/Grid/view/mixin/GridSelection#config-selectionMode)
3015
+ */
3016
+ onSelectionModeChange? : ((event: { selectionMode: object }) => void)|string
3017
+ /**
3018
+ * Triggered after a widget is shown.
3019
+ * @param {object} event Event object
3020
+ * @param {Core.widget.Widget} event.source The widget
3021
+ */
3022
+ onShow? : ((event: { source: Widget }) => void)|string
3023
+ /**
3024
+ * Fires when splitting the Grid.
3025
+ * @param {object} event Event object
3026
+ * @param {Grid.view.GridBase[]} event.subViews The sub views created by the split
3027
+ * @param {object} event.options The options passed to the split call
3028
+ * @param {'horizontal','vertical','both'} event.options.direction The direction of the split
3029
+ * @param {Grid.column.Column} event.options.atColumn The column to split at
3030
+ * @param {Core.data.Model} event.options.atRecord The record to split at
3031
+ */
3032
+ onSplit? : ((event: { subViews: GridBase[], options: { direction: 'horizontal'|'vertical'|'both', atColumn: Column, atRecord: Model } }) => void)|string
3033
+ /**
3034
+ * Fired by the Grid when the collapse icon is clicked. Return `false` to prevent the default collapse action,
3035
+ * if you want to implement your own behavior.
3036
+ * @param {object} event Event object
3037
+ * @param {Grid.view.Grid} event.source The Grid instance.
3038
+ * @param {Grid.view.SubGrid} event.subGrid The subgrid
3039
+ * @param {Event} event.domEvent The native DOM event
3040
+ */
3041
+ onSplitterCollapseClick? : ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => Promise<boolean>|boolean|void)|string
3042
+ /**
3043
+ * Fired by the Grid after a sub-grid has been resized using the splitter
3044
+ * @param {object} event Event object
3045
+ * @param {Grid.view.Grid} event.source The Grid instance.
3046
+ * @param {Grid.view.SubGrid} event.subGrid The resized subgrid
3047
+ * @param {Event} event.domEvent The native DOM event
3048
+ */
3049
+ onSplitterDragEnd? : ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => void)|string
3050
+ /**
3051
+ * Fired by the Grid when a sub-grid resize gesture starts
3052
+ * @param {object} event Event object
3053
+ * @param {Grid.view.Grid} event.source The Grid instance.
3054
+ * @param {Grid.view.SubGrid} event.subGrid The subgrid about to be resized
3055
+ * @param {Event} event.domEvent The native DOM event
3056
+ */
3057
+ onSplitterDragStart? : ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => void)|string
3058
+ /**
3059
+ * Fired by the Grid when the expand icon is clicked. Return `false` to prevent the default expand action,
3060
+ * if you want to implement your own behavior.
3061
+ * @param {object} event Event object
3062
+ * @param {Grid.view.Grid} event.source The Grid instance.
3063
+ * @param {Grid.view.SubGrid} event.subGrid The subgrid
3064
+ * @param {Event} event.domEvent The native DOM event
3065
+ */
3066
+ onSplitterExpandClick? : ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => Promise<boolean>|boolean|void)|string
3067
+ /**
3068
+ * Fires on the owning Grid when editing starts
3069
+ * @param {object} event Event object
3070
+ * @param {Grid.view.Grid} event.source Owner grid
3071
+ * @param {CellEditorContext} event.editorContext Editing context
3072
+ */
3073
+ onStartCellEdit? : ((event: { source: Grid, editorContext: CellEditorContext }) => void)|string
3074
+ /**
3075
+ * Fires on the owning Grid when editing starts
3076
+ * @param {object} event Event object
3077
+ * @param {Grid.view.Grid} event.source Owner grid
3078
+ * @param {RowEditorContext} event.editorContext Editing context
3079
+ */
3080
+ onStartRowEdit? : ((event: { source: Grid, editorContext: RowEditorContext }) => void)|string
3081
+ /**
3082
+ * Fires after a sub grid is collapsed.
3083
+ * @param {object} event Event object
3084
+ * @param {Grid.view.Grid} event.source The firing Grid instance
3085
+ * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
3086
+ */
3087
+ onSubGridCollapse? : ((event: { source: Grid, subGrid: SubGrid }) => void)|string
3088
+ /**
3089
+ * Fires after a sub grid is expanded.
3090
+ * @param {object} event Event object
3091
+ * @param {Grid.view.Grid} event.source The firing Grid instance
3092
+ * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
3093
+ */
3094
+ onSubGridExpand? : ((event: { source: Grid, subGrid: SubGrid }) => void)|string
3095
+ /**
3096
+ * Triggered after a click on a task bar.
3097
+ * @param {object} event Event object
3098
+ * @param {Gantt.view.Gantt} event.source The Gantt instance
3099
+ * @param {Gantt.model.TaskModel} event.taskRecord The Task record
3100
+ * @param {MouseEvent} event.event The native browser event
3101
+ */
3102
+ onTaskClick? : ((event: { source: Gantt, taskRecord: TaskModel, event: MouseEvent }) => void)|string
3103
+ /**
3104
+ * Triggered after a rightclick (or long press on a touch device) on a task.
3105
+ * @param {object} event Event object
3106
+ * @param {Gantt.view.Gantt} event.source The Gantt instance
3107
+ * @param {Gantt.model.TaskModel} event.taskRecord The Task record
3108
+ * @param {MouseEvent} event.event The native browser event
3109
+ */
3110
+ onTaskContextMenu? : ((event: { source: Gantt, taskRecord: TaskModel, event: MouseEvent }) => void)|string
3111
+ /**
3112
+ * Triggered after a doubleclick on a task.
3113
+ * @param {object} event Event object
3114
+ * @param {Gantt.view.Gantt} event.source The Gantt instance
3115
+ * @param {Gantt.model.TaskModel} event.taskRecord The Task record
3116
+ * @param {MouseEvent} event.event The native browser event
3117
+ */
3118
+ onTaskDblClick? : ((event: { source: Gantt, taskRecord: TaskModel, event: MouseEvent }) => void)|string
3119
+ /**
3120
+ * Fires on the owning Gantt while a task is being dragged
3121
+ * @param {object} event Event object
3122
+ * @param {Gantt.view.Gantt} event.source
3123
+ * @param {Gantt.model.TaskModel[]} event.taskRecords
3124
+ * @param {Date} event.startDate
3125
+ * @param {Date} event.endDate
3126
+ * @param {object} event.dragData
3127
+ * @param {boolean} event.changed `true` if startDate has changed.
3128
+ */
3129
+ onTaskDrag? : ((event: { source: Gantt, taskRecords: TaskModel[], startDate: Date, endDate: Date, dragData: object, changed: boolean }) => void)|string
3130
+ /**
3131
+ * Fires on the owning Gantt when task dragging starts
3132
+ * @param {object} event Event object
3133
+ * @param {Gantt.view.Gantt} event.source
3134
+ * @param {Gantt.model.TaskModel[]} event.taskRecords
3135
+ */
3136
+ onTaskDragStart? : ((event: { source: Gantt, taskRecords: TaskModel[] }) => void)|string
3137
+ /**
3138
+ * Fires on the owning Gantt after a valid task drop
3139
+ * @param {object} event Event object
3140
+ * @param {Gantt.view.Gantt} event.source
3141
+ * @param {Gantt.model.TaskModel[]} event.taskRecords
3142
+ * @param {boolean} event.isCopy
3143
+ */
3144
+ onTaskDrop? : ((event: { source: Gantt, taskRecords: TaskModel[], isCopy: boolean }) => void)|string
3145
+ /**
3146
+ * Fires on the owning Scheduler or Gantt widget when the editor for an event is canceled.
3147
+ * @param {object} event Event object
3148
+ * @param {SchedulerPro.view.SchedulerPro} event.source The Scheduler Pro instance
3149
+ * @param {SchedulerPro.model.EventModel} event.taskRecord the task about the shown in the editor
3150
+ * @param {SchedulerPro.widget.TaskEditorBase} event.editor The editor
3151
+ */
3152
+ onTaskEditCanceled? : ((event: { source: SchedulerPro, taskRecord: EventModel, editor: TaskEditorBase }) => void)|string
3153
+ /**
3154
+ * Triggered when a keydown event is observed if there are selected tasks.
3155
+ * @param {object} event Event object
3156
+ * @param {Gantt.view.Gantt} event.source This Gantt
3157
+ * @param {Gantt.model.TaskModel} event.taskRecord Task record
3158
+ * @param {KeyboardEvent} event.event Browser event
3159
+ */
3160
+ onTaskKeyDown? : ((event: { source: Gantt, taskRecord: TaskModel, event: KeyboardEvent }) => void)|string
3161
+ /**
3162
+ * Triggered when a keyup event is observed if there are selected tasks.
3163
+ * @param {object} event Event object
3164
+ * @param {Gantt.view.Gantt} event.source This Gantt
3165
+ * @param {Gantt.model.TaskModel} event.taskRecord Task record
3166
+ * @param {KeyboardEvent} event.event Browser event
3167
+ */
3168
+ onTaskKeyUp? : ((event: { source: Gantt, taskRecord: TaskModel, event: KeyboardEvent }) => void)|string
3169
+ /**
3170
+ * This event fires on the owning Gantt before the context menu is shown for a task. Allows manipulation of the items
3171
+ * to show in the same way as in `processItems`. Returning false from a listener prevents the menu from
3172
+ * being shown.
3173
+ * @param {object} event Event object
3174
+ * @param {Gantt.view.Gantt} event.source
3175
+ * @param {MenuItemEntry[]} event.items Menu item configs
3176
+ * @param {Gantt.model.TaskModel} event.taskRecord Event record for which the menu was triggered
3177
+ * @param {HTMLElement} event.taskElement
3178
+ */
3179
+ onTaskMenuBeforeShow? : ((event: { source: Gantt, items: MenuItemEntry[], taskRecord: TaskModel, taskElement: HTMLElement }) => Promise<boolean>|boolean|void)|string
3180
+ /**
3181
+ * This event fires on the owning Gantt when an item is selected in the context menu.
3182
+ * @param {object} event Event object
3183
+ * @param {Gantt.view.Gantt} event.source
3184
+ * @param {Core.widget.MenuItem} event.item
3185
+ * @param {Gantt.model.TaskModel} event.taskRecord
3186
+ * @param {HTMLElement} event.taskElement
3187
+ */
3188
+ onTaskMenuItem? : ((event: { source: Gantt, item: MenuItem, taskRecord: TaskModel, taskElement: HTMLElement }) => void)|string
3189
+ /**
3190
+ * This event fires on the owning Gantt after showing the context menu for an event
3191
+ * @param {object} event Event object
3192
+ * @param {Gantt.view.Gantt} event.source
3193
+ * @param {Core.widget.Menu} event.menu The menu
3194
+ * @param {Gantt.model.TaskModel} event.taskRecord Event record for which the menu was triggered
3195
+ * @param {HTMLElement} event.taskElement
3196
+ */
3197
+ onTaskMenuShow? : ((event: { source: Gantt, menu: Menu, taskRecord: TaskModel, taskElement: HTMLElement }) => void)|string
3198
+ /**
3199
+ * Triggered after a mousedown on a task bar.
3200
+ * @param {object} event Event object
3201
+ * @param {Gantt.view.Gantt} event.source The Gantt instance
3202
+ * @param {Gantt.model.TaskModel} event.taskRecord The Task record
3203
+ * @param {MouseEvent} event.event The native browser event
3204
+ */
3205
+ onTaskMouseDown? : ((event: { source: Gantt, taskRecord: TaskModel, event: MouseEvent }) => void)|string
3206
+ /**
3207
+ * Triggered for mouseout from a task.
3208
+ * @param {object} event Event object
3209
+ * @param {Gantt.view.Gantt} event.source The Gantt instance
3210
+ * @param {Gantt.model.TaskModel} event.taskRecord The Task record
3211
+ * @param {MouseEvent} event.event The native browser event
3212
+ */
3213
+ onTaskMouseOut? : ((event: { source: Gantt, taskRecord: TaskModel, event: MouseEvent }) => void)|string
3214
+ /**
3215
+ * Triggered after a mouseover on a task.
3216
+ * @param {object} event Event object
3217
+ * @param {Gantt.view.Gantt} event.source The Gantt instance
3218
+ * @param {Gantt.model.TaskModel} event.taskRecord The Task record
3219
+ * @param {MouseEvent} event.event The native browser event
3220
+ */
3221
+ onTaskMouseOver? : ((event: { source: Gantt, taskRecord: TaskModel, event: MouseEvent }) => void)|string
3222
+ /**
3223
+ * Triggered after a mouseup on a task bar.
3224
+ * @param {object} event Event object
3225
+ * @param {Gantt.view.Gantt} event.source The Gantt instance
3226
+ * @param {Gantt.model.TaskModel} event.taskRecord The Task record
3227
+ * @param {MouseEvent} event.event The native browser event
3228
+ */
3229
+ onTaskMouseUp? : ((event: { source: Gantt, taskRecord: TaskModel, event: MouseEvent }) => void)|string
3230
+ /**
3231
+ * Triggered when clicking a nonworking time element
3232
+ * @param {object} event Event object
3233
+ * @param {Gantt.view.Gantt} event.source The Gantt chart instance
3234
+ * @param {Gantt.model.TaskModel} event.taskRecord Task record
3235
+ * @param {object} event.interval The raw data describing the nonworking time interval
3236
+ * @param {string} event.interval.name The interval name (if any)
3237
+ * @param {Date} event.interval.startDate The interval start date
3238
+ * @param {Date} event.interval.endDate The interval end date
3239
+ * @param {MouseEvent} event.domEvent Browser event
3240
+ */
3241
+ onTaskNonWorkingTimeClick? : ((event: { source: Gantt, taskRecord: TaskModel, interval: { name: string, startDate: Date, endDate: Date }, domEvent: MouseEvent }) => void)|string
3242
+ /**
3243
+ * Triggered when right-clicking a nonworking time element
3244
+ * @param {object} event Event object
3245
+ * @param {Gantt.view.Gantt} event.source The Gantt chart instance
3246
+ * @param {Gantt.model.TaskModel} event.taskRecord Task record
3247
+ * @param {object} event.interval The raw data describing the nonworking time interval
3248
+ * @param {string} event.interval.name The interval name (if any)
3249
+ * @param {Date} event.interval.startDate The interval start date
3250
+ * @param {Date} event.interval.endDate The interval end date
3251
+ * @param {MouseEvent} event.domEvent Browser event
3252
+ */
3253
+ onTaskNonWorkingTimeContextMenu? : ((event: { source: Gantt, taskRecord: TaskModel, interval: { name: string, startDate: Date, endDate: Date }, domEvent: MouseEvent }) => void)|string
3254
+ /**
3255
+ * Triggered when double-clicking a nonworking time element
3256
+ * @param {object} event Event object
3257
+ * @param {Gantt.view.Gantt} event.source The Gantt chart instance
3258
+ * @param {Gantt.model.TaskModel} event.taskRecord Task record
3259
+ * @param {object} event.interval The raw data describing the nonworking time interval
3260
+ * @param {string} event.interval.name The interval name (if any)
3261
+ * @param {Date} event.interval.startDate The interval start date
3262
+ * @param {Date} event.interval.endDate The interval end date
3263
+ * @param {MouseEvent} event.domEvent Browser event
3264
+ */
3265
+ onTaskNonWorkingTimeDblClick? : ((event: { source: Gantt, taskRecord: TaskModel, interval: { name: string, startDate: Date, endDate: Date }, domEvent: MouseEvent }) => void)|string
3266
+ /**
3267
+ * Fires on the owning Gantt on each resize move event
3268
+ * @param {object} event Event object
3269
+ * @param {TaskResizeData[]} event.resizeData Data for the tasks that are being resized. Only available when [resizeSelected](https://bryntum.com/products/gantt/docs/api/Gantt/feature/TaskResize#config-resizeSelected) is `true`. The nested properties are same as `context`
3270
+ * @param {Gantt.model.TaskModel} event.taskRecord Task record being resized
3271
+ * @param {Date} event.startDate New startDate
3272
+ * @param {Date} event.endDate New endDate
3273
+ * @param {HTMLElement} event.element
3274
+ */
3275
+ onTaskPartialResize? : ((event: { resizeData: TaskResizeData[], taskRecord: TaskModel, startDate: Date, endDate: Date, element: HTMLElement }) => void)|string
3276
+ /**
3277
+ * Fires on the owning Gantt after the resizing gesture has finished.
3278
+ * @param {object} event Event object
3279
+ * @param {boolean} event.changed
3280
+ * @param {Gantt.model.TaskModel} event.taskRecord
3281
+ * @param {TaskResizeData[]} event.resizeData Resize data for selected tasks. Only available when [resizeSelected](https://bryntum.com/products/gantt/docs/api/Gantt/feature/TaskResize#config-resizeSelected) is `true`
3282
+ */
3283
+ onTaskResizeEnd? : ((event: { changed: boolean, taskRecord: TaskModel, resizeData: TaskResizeData[] }) => void)|string
3284
+ /**
3285
+ * Fires on the owning Gantt when task resizing starts
3286
+ * @param {object} event Event object
3287
+ * @param {Gantt.model.TaskModel} event.taskRecord
3288
+ * @param {Event} event.event
3289
+ * @param {TaskResizeData[]} event.resizeData Resize data for selected tasks. Only available when [resizeSelected](https://bryntum.com/products/gantt/docs/api/Gantt/feature/TaskResize#config-resizeSelected) is `true`
3290
+ */
3291
+ onTaskResizeStart? : ((event: { taskRecord: TaskModel, event: Event, resizeData: TaskResizeData[] }) => void)|string
3292
+ /**
3293
+ * Fires on the owning Gantt while a segment is being dragged
3294
+ * @param {object} event Event object
3295
+ * @param {Gantt.view.Gantt} event.source
3296
+ * @param {Gantt.model.TaskModel[]} event.taskRecords Dragged segments
3297
+ * @param {Date} event.startDate
3298
+ * @param {Date} event.endDate
3299
+ * @param {object} event.dragData
3300
+ * @param {boolean} event.changed `true` if startDate has changed.
3301
+ */
3302
+ onTaskSegmentDrag? : ((event: { source: Gantt, taskRecords: TaskModel[], startDate: Date, endDate: Date, dragData: object, changed: boolean }) => void)|string
3303
+ /**
3304
+ * Fires on the owning Gantt when segment dragging starts
3305
+ * @param {object} event Event object
3306
+ * @param {Gantt.view.Gantt} event.source
3307
+ * @param {Gantt.model.TaskModel[]} event.taskRecords Dragged segments
3308
+ */
3309
+ onTaskSegmentDragStart? : ((event: { source: Gantt, taskRecords: TaskModel[] }) => void)|string
3310
+ /**
3311
+ * Fires on the owning Gantt after a valid task drop
3312
+ * @param {object} event Event object
3313
+ * @param {Gantt.view.Gantt} event.source
3314
+ * @param {Gantt.model.TaskModel[]} event.taskRecords Dropped segments
3315
+ * @param {boolean} event.isCopy
3316
+ */
3317
+ onTaskSegmentDrop? : ((event: { source: Gantt, taskRecords: TaskModel[], isCopy: boolean }) => void)|string
3318
+ /**
3319
+ * Fires on the owning Gantt on each resize move event
3320
+ * @param {object} event Event object
3321
+ * @param {Gantt.view.Gantt} event.source Gantt instance
3322
+ * @param {Gantt.model.TaskModel} event.taskRecord Segment being resized
3323
+ * @param {Date} event.startDate
3324
+ * @param {Date} event.endDate
3325
+ * @param {HTMLElement} event.element
3326
+ */
3327
+ onTaskSegmentPartialResize? : ((event: { source: Gantt, taskRecord: TaskModel, startDate: Date, endDate: Date, element: HTMLElement }) => void)|string
3328
+ /**
3329
+ * Fires on the owning Gantt after the resizing gesture has finished.
3330
+ * @param {object} event Event object
3331
+ * @param {Gantt.view.Gantt} event.source Gantt instance
3332
+ * @param {boolean} event.changed Shows if the record has been changed by the resize action
3333
+ * @param {Gantt.model.TaskModel} event.taskRecord Segment being resized
3334
+ */
3335
+ onTaskSegmentResizeEnd? : ((event: { source: Gantt, changed: boolean, taskRecord: TaskModel }) => void)|string
3336
+ /**
3337
+ * Fires on the owning Gantt when event resizing starts
3338
+ * @param {object} event Event object
3339
+ * @param {Gantt.view.Gantt} event.source Gantt instance
3340
+ * @param {Gantt.model.TaskModel} event.taskRecord Segment being resized
3341
+ * @param {Scheduler.model.SchedulerResourceModel} event.resourceRecord Resource record the resize starts within
3342
+ * @param {MouseEvent} event.event Browser event
3343
+ */
3344
+ onTaskSegmentResizeStart? : ((event: { source: Gantt, taskRecord: TaskModel, resourceRecord: SchedulerResourceModel, event: MouseEvent }) => void)|string
3345
+ /**
3346
+ * Fired when the tick size changes.
3347
+ * ...
3348
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#event-tickSizeChange)
3349
+ * @param {object} event Event object
3350
+ * @param {Scheduler.view.Scheduler} event.source This Scheduler instance.
3351
+ * @param {number} event.tickSize The tick size in pixels
3352
+ */
3353
+ onTickSizeChange? : ((event: { source: Scheduler, tickSize: number }) => void)|string
3354
+ /**
3355
+ * Fired when the timeaxis has changed, for example by zooming or configuring a new time span.
3356
+ * @param {object} event Event object
3357
+ * @param {Scheduler.view.Scheduler} event.source This Scheduler
3358
+ * @param {object} event.config Config object used to reconfigure the time axis.
3359
+ * @param {Date} event.config.startDate New start date (if supplied)
3360
+ * @param {Date} event.config.endDate New end date (if supplied)
3361
+ */
3362
+ onTimeAxisChange? : ((event: { source: Scheduler, config: { startDate: Date, endDate: Date } }) => void)|string
3363
+ /**
3364
+ * Fires after a click on a time axis cell
3365
+ * @param {object} event Event object
3366
+ * @param {Scheduler.column.SchedulerTimeAxisColumn,Scheduler.column.VerticalTimeAxisColumn} event.source The column object
3367
+ * @param {Date} event.startDate The start date of the header cell
3368
+ * @param {Date} event.endDate The end date of the header cell
3369
+ * @param {Event} event.event The event object
3370
+ */
3371
+ onTimeAxisHeaderClick? : ((event: { source: SchedulerTimeAxisColumn|VerticalTimeAxisColumn, startDate: Date, endDate: Date, event: Event }) => void)|string
3372
+ /**
3373
+ * Fires after a right click on a time axis cell
3374
+ * @param {object} event Event object
3375
+ * @param {Scheduler.column.SchedulerTimeAxisColumn,Scheduler.column.VerticalTimeAxisColumn} event.source The column object
3376
+ * @param {Date} event.startDate The start date of the header cell
3377
+ * @param {Date} event.endDate The end date of the header cell
3378
+ * @param {Event} event.event The event object
3379
+ */
3380
+ onTimeAxisHeaderContextMenu? : ((event: { source: SchedulerTimeAxisColumn|VerticalTimeAxisColumn, startDate: Date, endDate: Date, event: Event }) => void)|string
3381
+ /**
3382
+ * Fires after a double click on a time axis cell
3383
+ * @param {object} event Event object
3384
+ * @param {Scheduler.column.SchedulerTimeAxisColumn,Scheduler.column.VerticalTimeAxisColumn} event.source The column object
3385
+ * @param {Date} event.startDate The start date of the header cell
3386
+ * @param {Date} event.endDate The end date of the header cell
3387
+ * @param {Event} event.event The event object
3388
+ */
3389
+ onTimeAxisHeaderDblClick? : ((event: { source: SchedulerTimeAxisColumn|VerticalTimeAxisColumn, startDate: Date, endDate: Date, event: Event }) => void)|string
3390
+ /**
3391
+ * This event fires on the owning Scheduler or Gantt widget before the context menu is shown for the time axis header.
3392
+ * Allows manipulation of the items to show in the same way as in the [processItems](https://bryntum.com/products/gantt/docs/api/Scheduler/feature/TimeAxisHeaderMenu#config-processItems).
3393
+ * ...
3394
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#event-timeAxisHeaderMenuBeforeShow)
3395
+ * @param {object} event Event object
3396
+ * @param {Scheduler.view.Scheduler} event.source The scheduler
3397
+ * @param {Core.widget.Menu} event.menu The menu
3398
+ * @param {Record<string, MenuItemEntry>} event.items Menu item configs
3399
+ * @param {Grid.column.Column} event.column Time axis column
3400
+ */
3401
+ onTimeAxisHeaderMenuBeforeShow? : ((event: { source: Scheduler, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => Promise<boolean>|boolean|void)|string
3402
+ /**
3403
+ * This event fires on the owning Scheduler or Gantt widget when an item is selected in the header context menu.
3404
+ * @param {object} event Event object
3405
+ * @param {Scheduler.view.Scheduler} event.source The scheduler
3406
+ * @param {Core.widget.Menu} event.menu The menu
3407
+ * @param {Core.widget.MenuItem} event.item Selected menu item
3408
+ * @param {Grid.column.Column} event.column Time axis column
3409
+ */
3410
+ onTimeAxisHeaderMenuItem? : ((event: { source: Scheduler, menu: Menu, item: MenuItem, column: Column }) => void)|string
3411
+ /**
3412
+ * This event fires on the owning Scheduler or Gantt widget after the context menu is shown for a header
3413
+ * @param {object} event Event object
3414
+ * @param {Scheduler.view.Scheduler} event.source The scheduler
3415
+ * @param {Core.widget.Menu} event.menu The menu
3416
+ * @param {Record<string, MenuItemEntry>} event.items Menu item configs
3417
+ * @param {Grid.column.Column} event.column Time axis column
3418
+ */
3419
+ onTimeAxisHeaderMenuShow? : ((event: { source: Scheduler, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => void)|string
3420
+ /**
3421
+ * Fired when the pointer-activated [timelineContext](https://bryntum.com/products/gantt/docs/api/Scheduler/view/mixin/TimelineDomEvents#property-timelineContext) has changed.
3422
+ * @param {object} event Event object
3423
+ * @param {Scheduler.util.TimelineContext} event.oldContext The tick/resource context being deactivated.
3424
+ * @param {Scheduler.util.TimelineContext} event.context The tick/resource context being activated.
3425
+ */
3426
+ onTimelineContextChange? : ((event: { oldContext: TimelineContext, context: TimelineContext }) => void)|string
3427
+ /**
3428
+ * Fired when the *scheduler* viewport (not the overall Scheduler element) changes size.
3429
+ * This happens when the grid changes height, or when the subgrid which encapsulates the
3430
+ * scheduler column changes width.
3431
+ * @param {object} event Event object
3432
+ * @param {Core.widget.Widget} event.source This Scheduler
3433
+ * @param {number} event.width The new width
3434
+ * @param {number} event.height The new height
3435
+ * @param {number} event.oldWidth The old width
3436
+ * @param {number} event.oldHeight The old height
3437
+ */
3438
+ onTimelineViewportResize? : ((event: { source: Widget, width: number, height: number, oldWidth: number, oldHeight: number }) => void)|string
3439
+ /**
3440
+ * Fired on the owning Scheduler or Gantt widget when a click happens on a time range header element
3441
+ * @param {object} event Event object
3442
+ * @param {Scheduler.view.Scheduler} event.source Scheduler instance
3443
+ * @param {Scheduler.model.TimeSpan} event.timeRangeRecord The record
3444
+ * @param {MouseEvent} event.domEvent Browser event
3445
+ */
3446
+ onTimeRangeHeaderClick? : ((event: { source: Scheduler, timeRangeRecord: TimeSpan, domEvent: MouseEvent }) => void)|string
3447
+ /**
3448
+ * Fired on the owning Scheduler or Gantt widget when a right click happens on a time range header element
3449
+ * @param {object} event Event object
3450
+ * @param {Scheduler.view.Scheduler} event.source Scheduler instance
3451
+ * @param {Scheduler.model.TimeSpan} event.timeRangeRecord The record
3452
+ * @param {MouseEvent} event.domEvent Browser event
3453
+ */
3454
+ onTimeRangeHeaderContextMenu? : ((event: { source: Scheduler, timeRangeRecord: TimeSpan, domEvent: MouseEvent }) => void)|string
3455
+ /**
3456
+ * Fired on the owning Scheduler or Gantt widget when a double click happens on a time range header element
3457
+ * @param {object} event Event object
3458
+ * @param {Scheduler.view.Scheduler} event.source Scheduler instance
3459
+ * @param {Scheduler.model.TimeSpan} event.timeRangeRecord The record
3460
+ * @param {MouseEvent} event.domEvent Browser event
3461
+ */
3462
+ onTimeRangeHeaderDblClick? : ((event: { source: Scheduler, timeRangeRecord: TimeSpan, domEvent: MouseEvent }) => void)|string
3463
+ /**
3464
+ * Fired when one or more groups are expanded or collapsed
3465
+ * @param {object} event Event object
3466
+ * @param {Core.data.Model} event.groupRecord [DEPRECATED] Use `groupRecords` param instead
3467
+ * @param {Core.data.Model[]} event.groupRecords The group records being toggled
3468
+ * @param {boolean} event.collapse Collapsed (true) or expanded (false)
3469
+ * @param {boolean} event.allRecords True if this event is part of toggling all groups
3470
+ */
3471
+ onToggleGroup? : ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, allRecords?: boolean }) => void)|string
3472
+ /**
3473
+ * Fired after a parent node record toggles its collapsed state.
3474
+ * @param {object} event Event object
3475
+ * @param {Core.data.Model} event.record The record being toggled.
3476
+ * @param {boolean} event.collapse `true` if the node is being collapsed.
3477
+ */
3478
+ onToggleNode? : ((event: { record: Model, collapse: boolean }) => void)|string
3479
+ /**
3480
+ * A header [tool](https://bryntum.com/products/gantt/docs/api/Core/widget/Panel#config-tools) has been clicked.
3481
+ * @param {object} event Event object
3482
+ * @param {Core.widget.Tool} event.source This Panel.
3483
+ * @param {Core.widget.Tool} event.tool The tool which is being clicked.
3484
+ */
3485
+ onToolClick? : ((event: { source: Tool, tool: Tool }) => void)|string
3486
+ /**
3487
+ * <strong>Note that this event fires on the owning [SchedulerPro](https://bryntum.com/products/gantt/docs/api/SchedulerPro/view/SchedulerPro).</strong>
3488
+ * ...
3489
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#event-transactionChange)
3490
+ * @param {object} event Event object
3491
+ * @param {boolean} event.hasChanges Whether any changes are recorded that are not yet attached to a version.
3492
+ */
3493
+ onTransactionChange? : ((event: { hasChanges: boolean }) => void)|string
3494
+ /**
3495
+ * Fires when row locking is disabled.
3496
+ * @param {object} event Event object
3497
+ * @param {Grid.view.GridBase} event.clone The locked clone that will be destroyed
3498
+ */
3499
+ onUnlockRows? : ((event: { clone: GridBase }) => void)|string
3500
+ /**
3501
+ * Fires when un-splitting the Grid.
3502
+ */
3503
+ onUnsplit? : (() => void)|string
3504
+ /**
3505
+ * Fired when the range of dates visible within the viewport changes. This will be when
3506
+ * scrolling along a time axis.
3507
+ * ...
3508
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#event-visibleDateRangeChange)
3509
+ * @param {object} event Event object
3510
+ * @param {Scheduler.view.Scheduler} event.source This Scheduler instance.
3511
+ * @param {object} event.old The old date range
3512
+ * @param {Date} event.old.startDate the old start date.
3513
+ * @param {Date} event.old.endDate the old end date.
3514
+ * @param {object} event.new The new date range
3515
+ * @param {Date} event.new.startDate the new start date.
3516
+ * @param {Date} event.new.endDate the new end date.
3517
+ */
3518
+ onVisibleDateRangeChange? : ((event: { source: Scheduler, old: { startDate: Date, endDate: Date }, new: { startDate: Date, endDate: Date } }) => void)|string
3519
+
3520
+ // Features
3521
+ /**
3522
+ * AI-powered filter feature for Grid. Allows users to type natural language queries to filter grid data.
3523
+ * ...
3524
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/ai/AIFilter)
3525
+ */
3526
+ aiFilterFeature? : object|boolean|string|AIFilter|AIFilterConfig
3527
+ /**
3528
+ * Displays a [task](https://bryntum.com/products/gantt/docs/api/Gantt/model/TaskModel)'s [baselines](#Gantt/model/TaskModel#field-baselines) below the tasks in the
3529
+ * timeline.
3530
+ * ...
3531
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/Baselines)
3532
+ */
3533
+ baselinesFeature? : object|boolean|string|Baselines|BaselinesConfig
3534
+ /**
3535
+ * Allows using `[Ctrl/CMD + C]`, `[Ctrl/CMD + X]` and `[Ctrl/CMD + V]` to cut, copy and paste cell or cell ranges. Also
3536
+ * makes cut, copy and paste actions available via the cell context menu.
3537
+ * ...
3538
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/CellCopyPaste)
3539
+ */
3540
+ cellCopyPasteFeature? : object|boolean|string|CellCopyPaste|CellCopyPasteConfig
3541
+ /**
3542
+ * Extends the [CellEdit](https://bryntum.com/products/gantt/docs/api/Grid/feature/CellEdit) to encapsulate Gantt functionality. This feature is enabled by <b>default</b>
3543
+ * ...
3544
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/CellEdit)
3545
+ */
3546
+ cellEditFeature? : object|boolean|string|CellEdit|CellEditConfig
3547
+ /**
3548
+ * Right click to display context menu for cells. To invoke the cell menu in a keyboard-accessible manner, use the
3549
+ * `SPACE` key when the cell is focused.
3550
+ * ...
3551
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/CellMenu)
3552
+ */
3553
+ cellMenuFeature? : object|boolean|string|CellMenu|CellMenuConfig
3554
+ /**
3555
+ * Displays a tooltip when hovering cells.
3556
+ * ...
3557
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/CellTooltip)
3558
+ */
3559
+ cellTooltipFeature? : object|boolean|string|CellTooltip|CellTooltipConfig
3560
+ /**
3561
+ * 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
3562
+ * and updated in realtime as data changes. Supports many common chart types with extensive styling and customization
3563
+ * options.
3564
+ * ...
3565
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/Charts)
3566
+ */
3567
+ chartsFeature? : object|boolean|string|Charts|ChartsConfig
3568
+ /**
3569
+ * Enables the [autoWidth](https://bryntum.com/products/gantt/docs/api/Grid/column/Column#config-autoWidth) config for a grid's columns.
3570
+ * ...
3571
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/ColumnAutoWidth)
3572
+ */
3573
+ columnAutoWidthFeature? : object|boolean|string|ColumnAutoWidth|ColumnAutoWidthConfig
3574
+ /**
3575
+ * Displays a toolbar while dragging column headers. Drop on a button in the toolbar to activate a certain function,
3576
+ * for example to group by that column. This feature simplifies certain operations on touch devices.
3577
+ * ...
3578
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/ColumnDragToolbar)
3579
+ */
3580
+ columnDragToolbarFeature? : object|boolean|string|ColumnDragToolbar|ColumnDragToolbarConfig
3581
+ /**
3582
+ * Displays column lines for ticks, with a different styling for major ticks (by default they are darker). If this
3583
+ * feature is disabled, no lines are shown. If it's enabled, line are shown for the tick level which is set in current
3584
+ * ViewPreset. Please see [columnLinesFor](https://bryntum.com/products/gantt/docs/api/Scheduler/preset/ViewPreset#field-columnLinesFor) config for details.
3585
+ * ...
3586
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Scheduler/feature/ColumnLines)
3587
+ */
3588
+ columnLinesFeature? : object|boolean|string|ColumnLines|ColumnLinesConfig
3589
+ /**
3590
+ * Displays a column picker (to show/hide columns) in the header context menu. Columns can be displayed in sub menus
3591
+ * by region or tag. Grouped headers are displayed as menu hierarchies.
3592
+ * ...
3593
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/ColumnPicker)
3594
+ */
3595
+ columnPickerFeature? : object|boolean|string|ColumnPicker|ColumnPickerConfig
3596
+ /**
3597
+ * Allows user to rename columns by either right-clicking column header or using keyboard shortcuts when column header
3598
+ * is focused.
3599
+ * ...
3600
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/ColumnRename)
3601
+ */
3602
+ columnRenameFeature? : object|boolean|string|ColumnRename|ColumnRenameConfig
3603
+ /**
3604
+ * Allows user to reorder columns by dragging headers. To get notified about column reorder listen to `change` event
3605
+ * on [columns](https://bryntum.com/products/gantt/docs/api/Grid/data/ColumnStore) store.
3606
+ * ...
3607
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/ColumnReorder)
3608
+ */
3609
+ columnReorderFeature? : object|boolean|string|ColumnReorder|ColumnReorderConfig
3610
+ /**
3611
+ * Enables user to resize columns by dragging a handle on the right hand side of the header. To get notified about column
3612
+ * resize listen to `change` event on [columns](https://bryntum.com/products/gantt/docs/api/Grid/data/ColumnStore) store.
3613
+ * ...
3614
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/ColumnResize)
3615
+ */
3616
+ columnResizeFeature? : object|boolean|string|ColumnResize|ColumnResizeConfig
3617
+ /**
3618
+ * This feature highlights the project *critical paths*.
3619
+ * Every task is important, but only some of them are critical.
3620
+ * The critical path is a chain of linked tasks that directly affects the project finish date.
3621
+ * If any task on the critical path is late, the whole project is late.
3622
+ * ...
3623
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/CriticalPaths)
3624
+ */
3625
+ criticalPathsFeature? : object|boolean|string|CriticalPaths|CriticalPathsConfig
3626
+ /**
3627
+ * This feature draws dependencies between tasks. Uses a dependency
3628
+ * [store](https://bryntum.com/products/gantt/docs/api/Gantt/model/ProjectModel#property-dependencyStore) to determine which dependencies to draw.
3629
+ * ...
3630
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/Dependencies)
3631
+ */
3632
+ dependenciesFeature? : object|boolean|string|Dependencies|DependenciesConfig
3633
+ /**
3634
+ * Feature that displays a popup containing fields for editing dependency data.
3635
+ * ...
3636
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/SchedulerPro/feature/DependencyEdit)
3637
+ */
3638
+ dependencyEditFeature? : object|boolean|string|DependencyEdit|DependencyEditConfig
3639
+ /**
3640
+ * Adds event filter menu items to the timeline header context menu.
3641
+ * ...
3642
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Scheduler/feature/EventFilter)
3643
+ */
3644
+ eventFilterFeature? : object|boolean|string|EventFilter|EventFilterConfig
3645
+ /**
3646
+ * This feature provides segmented events support. It implements rendering of such events and also adds a entries to the
3647
+ * event context menu allowing to split the selected event and rename segments.
3648
+ * ...
3649
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/SchedulerPro/feature/EventSegments)
3650
+ */
3651
+ eventSegmentsFeature? : object|boolean|string|EventSegments|EventSegmentsConfig
3652
+ /**
3653
+ * A feature that allows exporting Grid data to Excel or CSV without involving the server. It uses
3654
+ * [TableExporter](https://bryntum.com/products/gantt/docs/api/Grid/util/TableExporter) class as data provider, 3rd party provider to generate XLS files, and
3655
+ * [Microsoft XML specification](https://msdn.microsoft.com/en-us/library/office/documentformat.openxml.spreadsheet.aspx).
3656
+ * ...
3657
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/experimental/ExcelExporter)
3658
+ */
3659
+ excelExporterFeature? : object|boolean|string|GridExcelExporter|GridExcelExporterConfig
3660
+ /**
3661
+ * An experimental feature that lets users drop files on a Widget. The widget fires an event when a file is dropped onto it.
3662
+ * In the event, you get access to the raw files as strings, that were parsed by calling `readAsBinaryString`.
3663
+ * ...
3664
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/experimental/FileDrop)
3665
+ */
3666
+ fileDropFeature? : object|boolean|string|FileDrop|FileDropConfig
3667
+ /**
3668
+ * This feature adds a fill handle to a Grid range selection, which when dragged, fills the cells being dragged over
3669
+ * with values based on the values in the original selected range. This is similar to functionality normally seen in
3670
+ * various spreadsheet applications.
3671
+ * ...
3672
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/FillHandle)
3673
+ */
3674
+ fillHandleFeature? : object|boolean|string|FillHandle|FillHandleConfig
3675
+ /**
3676
+ * Feature that allows filtering of the grid by settings filters on columns. The actual filtering is done by the store.
3677
+ * For info on programmatically handling filters, see [StoreFilter](https://bryntum.com/products/gantt/docs/api/Core/data/mixin/StoreFilter).
3678
+ * ...
3679
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/Filter)
3680
+ */
3681
+ filterFeature? : object|boolean|string|Filter|FilterConfig
3682
+ /**
3683
+ * Feature that allows filtering of the grid by entering filters on column headers.
3684
+ * The actual filtering is done by the store.
3685
+ * For info on programmatically handling filters, see [StoreFilter](https://bryntum.com/products/gantt/docs/api/Core/data/mixin/StoreFilter).
3686
+ * ...
3687
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/FilterBar)
3688
+ */
3689
+ filterBarFeature? : object|boolean|string|FilterBar|FilterBarConfig
3690
+ /**
3691
+ * Enables rendering and handling of row groups. The actual grouping is done in the store, but triggered by
3692
+ * <kbd>shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
3693
+ * one anywhere on grid). Use <kbd>shift</kbd> + <kbd>alt</kbd> + click, or the context menu, to remove a column
3694
+ * grouper.
3695
+ * ...
3696
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/Group)
3697
+ */
3698
+ groupFeature? : object|boolean|string|Group|GroupConfig
3699
+ /**
3700
+ * Displays a summary row as a group footer in a grouped grid. Uses the same configuration options on columns as
3701
+ * [Summary](https://bryntum.com/products/gantt/docs/api/Grid/feature/Summary).
3702
+ * ...
3703
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/GroupSummary)
3704
+ */
3705
+ groupSummaryFeature? : object|boolean|string|GridGroupSummary|GridGroupSummaryConfig
3706
+ /**
3707
+ * Right click column header or focus it and press SPACE key to show the context menu for headers.
3708
+ * ...
3709
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/HeaderMenu)
3710
+ */
3711
+ headerMenuFeature? : object|boolean|string|HeaderMenu|HeaderMenuConfig
3712
+ /**
3713
+ * Enables users to click and drag to zoom to a date range in Scheduler's header time axis. Only supported in horizontal
3714
+ * mode.
3715
+ * ...
3716
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Scheduler/feature/HeaderZoom)
3717
+ */
3718
+ headerZoomFeature? : object|boolean|string|HeaderZoom|HeaderZoomConfig
3719
+ /**
3720
+ * The Indicators feature displays indicators (icons) for different dates related to a task in its row. Hovering an
3721
+ * indicator will show a tooltip with its name and date(s). The owning task `id` is embedded in the indicator element
3722
+ * dataset as `taskRecordId` which can be useful if you want to have custom actions when clicking (showing a menu for example).
3723
+ * ...
3724
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/Indicators)
3725
+ */
3726
+ indicatorsFeature? : object|boolean|string|Indicators|IndicatorsConfig
3727
+ /**
3728
+ * A feature that lets you display a label on each side of a Gantt task bar. See
3729
+ * [Labels](https://bryntum.com/products/gantt/docs/api/Scheduler/feature/Labels) for more information.
3730
+ * ...
3731
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/Labels)
3732
+ */
3733
+ labelsFeature? : object|boolean|string|Labels|LabelsConfig
3734
+ /**
3735
+ * This feature allows records which satisfy a certain condition to be locked at the top of the grid.
3736
+ * ...
3737
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/LockRows)
3738
+ */
3739
+ lockRowsFeature? : object|boolean|string|GridLockRows|GridLockRowsConfig
3740
+ /**
3741
+ * 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
3742
+ * configured to [mergeCells](https://bryntum.com/products/gantt/docs/api/Grid/column/Column#config-mergeCells).
3743
+ * ...
3744
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/MergeCells)
3745
+ */
3746
+ mergeCellsFeature? : object|boolean|string|MergeCells|MergeCellsConfig
3747
+ /**
3748
+ * A feature that allows exporting Gantt to Microsoft Project without involving a server.
3749
+ * ...
3750
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/export/MspExport)
3751
+ */
3752
+ mspExportFeature? : object|boolean|string|MspExport|MspExportConfig
3753
+ /**
3754
+ * Feature that allows styling of weekends (and other non-working time) by adding timeRanges for those days.
3755
+ * ...
3756
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Scheduler/feature/NonWorkingTime)
3757
+ */
3758
+ nonWorkingTimeFeature? : object|boolean|string|NonWorkingTime|NonWorkingTimeConfig
3759
+ /**
3760
+ * Makes the scheduler's timeline pannable by dragging with the mouse. Try it out in the demo below.
3761
+ * ...
3762
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Scheduler/feature/Pan)
3763
+ */
3764
+ panFeature? : object|boolean|string|Pan|PanConfig
3765
+ /**
3766
+ * Highlights the area encapsulating all child tasks of a parent task in a semi-transparent layer. You can style
3767
+ * these layer elements using the `b-parent-area` CSS class.
3768
+ * ...
3769
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/ParentArea)
3770
+ */
3771
+ parentAreaFeature? : object|boolean|string|ParentArea|ParentAreaConfig
3772
+ /**
3773
+ * Generates PDF/PNG files from the Gantt component.
3774
+ * ...
3775
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/export/PdfExport)
3776
+ */
3777
+ pdfExportFeature? : object|boolean|string|PdfExport|PdfExportConfig
3778
+ /**
3779
+ * This feature visualizes the [percentDone](https://bryntum.com/products/gantt/docs/api/SchedulerPro/model/mixin/PercentDoneMixin#field-percentDone) field as a
3780
+ * progress bar on the event elements. Each progress bar also optionally has a drag handle which users can drag can
3781
+ * change the value.
3782
+ * ...
3783
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/SchedulerPro/feature/PercentBar)
3784
+ */
3785
+ percentBarFeature? : object|boolean|string|PercentBar|PercentBarConfig
3786
+ /**
3787
+ * Allows pinning columns to the start or end region of the grid without any additional subGrid configurations.
3788
+ * When pinning to a region that does not yet exist, the feature creates the required subGrid on the fly.
3789
+ * ...
3790
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/PinColumns)
3791
+ */
3792
+ pinColumnsFeature? : object|boolean|string|PinColumns|PinColumnsConfig
3793
+ /**
3794
+ * Allows printing Gantt contents using browser print dialog.
3795
+ * ...
3796
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/export/Print)
3797
+ */
3798
+ printFeature? : object|boolean|string|Print|PrintConfig
3799
+ /**
3800
+ * This feature draws project progress line with SVG lines. Requires [PercentBar](https://bryntum.com/products/gantt/docs/api/SchedulerPro/feature/PercentBar) to be enabled (which
3801
+ * by default, it is)
3802
+ * ...
3803
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/ProgressLine)
3804
+ */
3805
+ progressLineFeature? : object|boolean|string|ProgressLine|ProgressLineConfig
3806
+ /**
3807
+ * Feature that displays the [project editor](https://bryntum.com/products/gantt/docs/api/Gantt/widget/ProjectEditor) allowing users to edit
3808
+ * the project settings.
3809
+ * ...
3810
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/ProjectEdit)
3811
+ */
3812
+ projectEditFeature? : object|boolean|string|ProjectEdit|ProjectEditConfig
3813
+ /**
3814
+ * This feature draws the vertical lines in the schedule area, indicating project start/end dates
3815
+ * and also its [status date](https://bryntum.com/products/gantt/docs/api/Gantt/model/ProjectModel#field-statusDate). The latter can be disabled
3816
+ * with the [showStatusDate](https://bryntum.com/products/gantt/docs/api/Gantt/feature/ProjectLines#config-showStatusDate) config.
3817
+ * ...
3818
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/ProjectLines)
3819
+ */
3820
+ projectLinesFeature? : object|boolean|string|ProjectLines|ProjectLinesConfig
3821
+ /**
3822
+ * Feature that allows the user to search in a column by focusing a cell and typing. Navigate between hits using the
3823
+ * keyboard, [f3] or [ctrl]/[cmd] + [g] moves to next, also pressing [shift] moves to previous.
3824
+ * ...
3825
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/QuickFind)
3826
+ */
3827
+ quickFindFeature? : object|boolean|string|QuickFind|QuickFindConfig
3828
+ /**
3829
+ * Makes the splitter between grid [sections](https://bryntum.com/products/gantt/docs/api/Grid/view/SubGrid) draggable, to let users resize, and
3830
+ * collapse/expand the sections.
3831
+ * ...
3832
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/RegionResize)
3833
+ */
3834
+ regionResizeFeature? : object|boolean|string|RegionResize|RegionResizeConfig
3835
+ /**
3836
+ * If the task's [rollup](https://bryntum.com/products/gantt/docs/api/Gantt/model/TaskModel#field-rollup) data field is set to `true`, it displays a small bar or diamond below its summary task in the timeline.
3837
+ * Each of the rollup elements show a tooltip when hovering it with details of the task.
3838
+ * The tooltip content is customizable, see [template](https://bryntum.com/products/gantt/docs/api/Gantt/feature/Rollups#config-template) config for details.
3839
+ * ...
3840
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/Rollups)
3841
+ */
3842
+ rollupsFeature? : object|boolean|string|Rollups|RollupsConfig
3843
+ /**
3844
+ * Allow using [Ctrl/CMD + C/X] and [Ctrl/CMD + V] to copy/cut-and-paste rows. Also makes cut, copy and paste actions
3845
+ * available via the cell context menu.
3846
+ * ...
3847
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/RowCopyPaste)
3848
+ */
3849
+ rowCopyPasteFeature? : object|boolean|string|RowCopyPaste|RowCopyPasteConfig
3850
+ /**
3851
+ * This feature allows editing of entire rows in a grid in a docked panel which by default slides out from the right.
3852
+ * ...
3853
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/RowEdit)
3854
+ */
3855
+ rowEditFeature? : object|boolean|string|RowEdit|RowEditConfig
3856
+ /**
3857
+ * Enables expanding of Grid rows by either row click or double click, or by adding a separate Grid column which renders
3858
+ * a button that expands or collapses the row.
3859
+ * ...
3860
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/RowExpander)
3861
+ */
3862
+ rowExpanderFeature? : object|boolean|string|RowExpander|RowExpanderConfig
3863
+ /**
3864
+ * This feature implements support for project transactions and used by default in Gantt. For general RowReorder feature
3865
+ * documentation see [RowReorder](https://bryntum.com/products/gantt/docs/api/Grid/feature/RowReorder).
3866
+ * ...
3867
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Scheduler/feature/RowReorder)
3868
+ */
3869
+ rowReorderFeature? : object|boolean|string|RowReorder|RowReorderConfig
3870
+ /**
3871
+ * 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)
3872
+ * field of the record is updated (when [applyToAllRows](https://bryntum.com/products/gantt/docs/api/Grid/feature/RowResize#config-applyToAllRows) is `false`).
3873
+ * ...
3874
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/RowResize)
3875
+ */
3876
+ rowResizeFeature? : object|boolean|string|GridRowResize|GridRowResizeConfig
3877
+ /**
3878
+ * Displays a context menu for empty parts of the schedule. Items are populated in the first place
3879
+ * by configurations of this Feature, then by other features and/or application code.
3880
+ * ...
3881
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Scheduler/feature/ScheduleMenu)
3882
+ */
3883
+ scheduleMenuFeature? : object|boolean|string|ScheduleMenu|ScheduleMenuConfig
3884
+ /**
3885
+ * Feature that displays a tooltip containing the time at the mouse position when hovering empty parts of the schedule.
3886
+ * ...
3887
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Scheduler/feature/ScheduleTooltip)
3888
+ */
3889
+ scheduleTooltipFeature? : object|boolean|string|ScheduleTooltip|ScheduleTooltipConfig
3890
+ /**
3891
+ * This feature injects buttons in each row that scrolls the task bar into view. It can optionally show a label along
3892
+ * with the button, using the [labelRenderer](https://bryntum.com/products/gantt/docs/api/Gantt/feature/ScrollButtons#config-labelRenderer).
3893
+ * ...
3894
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/ScrollButtons)
3895
+ */
3896
+ scrollButtonsFeature? : object|boolean|string|ScrollButtons|ScrollButtonsConfig
3897
+ /**
3898
+ * <div class="external-example vertical" data-file="Grid/feature/Search.js"></div>
3899
+ * ...
3900
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/Search)
3901
+ */
3902
+ searchFeature? : object|boolean|string|Search|SearchConfig
3903
+ /**
3904
+ * Allows sorting of grid by clicking (or tapping) headers, also displays which columns grid is sorted by (numbered if
3905
+ * using multisort). Use modifier keys for multisorting: [Ctrl/CMD + click] to add sorter, [Ctrl/CMD + Alt + click] to remove sorter.
3906
+ * The actual sorting is done by the store, see [Store.sort()](https://bryntum.com/products/gantt/docs/api/Core/data/mixin/StoreSort#function-sort).
3907
+ * ...
3908
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/Sort)
3909
+ */
3910
+ sortFeature? : object|boolean|string|Sort|SortConfig
3911
+ /**
3912
+ * This feature allows splitting the Grid into multiple views, either by using the cell context menu, or
3913
+ * programmatically by calling [split()](https://bryntum.com/products/gantt/docs/api/Grid/feature/Split#function-split).
3914
+ * ...
3915
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/Split)
3916
+ */
3917
+ splitFeature? : object|boolean|string|GridSplit|GridSplitConfig
3918
+ /**
3919
+ * A feature which pins configurable content from a grid row to the top of the grid
3920
+ * while the row scrolls off the top but is still visible.
3921
+ * ...
3922
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/StickyCells)
3923
+ */
3924
+ stickyCellsFeature? : object|boolean|string|StickyCells|StickyCellsConfig
3925
+ /**
3926
+ * Stripes rows by adding alternating CSS classes to all row elements (`b-even` and `b-odd`).
3927
+ * ...
3928
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/Stripe)
3929
+ */
3930
+ stripeFeature? : object|boolean|string|Stripe|StripeConfig
3931
+ /**
3932
+ * A feature displaying a summary bar in the grid footer.
3933
+ * ...
3934
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/Summary)
3935
+ */
3936
+ summaryFeature? : object|boolean|string|Summary|SummaryConfig
3937
+ /**
3938
+ * Allow using <kbd>Ctrl</kbd>/<kbd>CMD</kbd> + <kbd>C</kbd>/<kbd>X</kbd> and <kbd>Ctrl</kbd>/<kbd>CMD</kbd> +
3939
+ * <kbd>V</kbd> to copy/cut and paste tasks. You can configure how a newly pasted record is named using
3940
+ * [generateNewName](https://bryntum.com/products/gantt/docs/api/Gantt/feature/TaskCopyPaste#config-generateNewName)
3941
+ * ...
3942
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/TaskCopyPaste)
3943
+ */
3944
+ taskCopyPasteFeature? : object|boolean|string|TaskCopyPaste|TaskCopyPasteConfig
3945
+ /**
3946
+ * Allows user to drag and drop tasks within Gantt, to change their start date.
3947
+ * ...
3948
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/TaskDrag)
3949
+ */
3950
+ taskDragFeature? : object|boolean|string|TaskDrag|TaskDragConfig
3951
+ /**
3952
+ * A feature that allows the user to schedule tasks by dragging in the empty parts of the gantt timeline row. Note, this feature is only applicable for unscheduled tasks.
3953
+ * ...
3954
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/TaskDragCreate)
3955
+ */
3956
+ taskDragCreateFeature? : object|boolean|string|TaskDragCreate|TaskDragCreateConfig
3957
+ /**
3958
+ * Feature that allows editing tasks using a [TaskEditor](https://bryntum.com/products/gantt/docs/api/Gantt/widget/TaskEditor), a popup with fields for editing task data.
3959
+ * ...
3960
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/TaskEdit)
3961
+ */
3962
+ taskEditFeature? : object|boolean|string|TaskEdit|TaskEditConfig
3963
+ /**
3964
+ * Displays a context menu for tasks. Items are populated by other features and/or application code.
3965
+ * Configure it with `false` to disable it completely. If enabled, [CellMenu](https://bryntum.com/products/gantt/docs/api/Grid/feature/CellMenu) feature
3966
+ * is not available. Cell context menu items are handled by this feature.
3967
+ * ...
3968
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/TaskMenu)
3969
+ */
3970
+ taskMenuFeature? : object|boolean|string|TaskMenu|TaskMenuConfig
3971
+ /**
3972
+ * Feature highlighting the non-working time intervals for tasks, based on their [calendar](https://bryntum.com/products/gantt/docs/api/Gantt/model/TaskModel#field-calendar).
3973
+ * If a task has no calendar defined, the project's calendar will be used. The non-working time interval can also be
3974
+ * recurring. You can find a live example showing how to achieve this in the [Task Calendars Demo](../examples/calendars/).
3975
+ * ...
3976
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/TaskNonWorkingTime)
3977
+ */
3978
+ taskNonWorkingTimeFeature? : object|boolean|string|TaskNonWorkingTime|TaskNonWorkingTimeConfig
3979
+ /**
3980
+ * Feature that allows resizing a task by dragging its end date. Resizing a task by dragging its start date is not allowed.
3981
+ * ...
3982
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/TaskResize)
3983
+ */
3984
+ taskResizeFeature? : object|boolean|string|TaskResize|TaskResizeConfig
3985
+ /**
3986
+ * Allows user to drag and drop task segments, to change their start date.
3987
+ * ...
3988
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/TaskSegmentDrag)
3989
+ */
3990
+ taskSegmentDragFeature? : object|boolean|string|TaskSegmentDrag|TaskSegmentDragConfig
3991
+ /**
3992
+ * Feature that allows resizing a task segment by dragging its end.
3993
+ * ...
3994
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/TaskSegmentResize)
3995
+ */
3996
+ taskSegmentResizeFeature? : object|boolean|string|TaskSegmentResize|TaskSegmentResizeConfig
3997
+ /**
3998
+ * This feature displays a task tooltip on mouse hover. The template of the tooltip is customizable
3999
+ * with the [template](https://bryntum.com/products/gantt/docs/api/Gantt/feature/TaskTooltip#config-template) function.
4000
+ * ...
4001
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/TaskTooltip)
4002
+ */
4003
+ taskTooltipFeature? : object|boolean|string|TaskTooltip|TaskTooltipConfig
4004
+ /**
4005
+ * Adds scheduler specific menu items to the timeline header context menu.
4006
+ * ...
4007
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Scheduler/feature/TimeAxisHeaderMenu)
4008
+ */
4009
+ timeAxisHeaderMenuFeature? : object|boolean|string|TimeAxisHeaderMenu|TimeAxisHeaderMenuConfig
4010
+ /**
4011
+ * This feature allows drawing line charts on top of the timeline area. Feature consists of two parts: chart and
4012
+ * data providers. Chart provider is responsible for rendering the chart, while data provider is responsible
4013
+ * for providing data for the chart. Feature itself manages the interaction between them, and tracks lifecycle events
4014
+ * of the Gantt chart.
4015
+ * ...
4016
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/TimelineChart)
4017
+ */
4018
+ timelineChartFeature? : object|boolean|string|TimelineChart|TimelineChartConfig
4019
+ /**
4020
+ * Feature that renders global ranges of time in the timeline. Use this feature to visualize a `range` like a 1 hr lunch
4021
+ * or some important point in time (a `line`, i.e. a range with 0 duration). This feature can also show a current time
4022
+ * indicator if you set [showCurrentTimeLine](https://bryntum.com/products/gantt/docs/api/Scheduler/feature/TimeRanges#config-showCurrentTimeLine) to true. To style the rendered elements, use the
4023
+ * [cls](https://bryntum.com/products/gantt/docs/api/Scheduler/model/TimeSpan#field-cls) field of the `TimeSpan` class.
4024
+ * ...
4025
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Scheduler/feature/TimeRanges)
4026
+ */
4027
+ timeRangesFeature? : object|boolean|string|TimeRanges|TimeRangesConfig
4028
+ /**
4029
+ * This feature exposes methods on the owning Scheduler or Gantt widget which you can use to highlight one or multiple time spans
4030
+ * in the schedule. Please see [highlightTimeSpan](https://bryntum.com/products/gantt/docs/api/SchedulerPro/feature/TimeSpanHighlight#function-highlightTimeSpan) and [highlightTimeSpans](#SchedulerPro/feature/TimeSpanHighlight#function-highlightTimeSpans) to learn
4031
+ * more or try the demo below:
4032
+ * ...
4033
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/SchedulerPro/feature/TimeSpanHighlight)
4034
+ */
4035
+ timeSpanHighlightFeature? : object|boolean|string|TimeSpanHighlight|TimeSpanHighlightConfig
4036
+ /**
4037
+ * 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
4038
+ * 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
4039
+ * tree renderer that adds padding and icon to give the appearance of a tree. The original renderer is preserved and
4040
+ * also called.
4041
+ * ...
4042
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/Tree)
4043
+ */
4044
+ treeFeature? : object|boolean|string|Tree|TreeConfig
4045
+ /**
4046
+ * Extends Grid's [TreeGroup](https://bryntum.com/products/gantt/docs/api/Grid/feature/TreeGroup) (follow the link for more info) feature to enable using it with Gantt.
4047
+ * Allows generating a new task tree where parents are determined by the values of specified task fields/functions:
4048
+ * ...
4049
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/TreeGroup)
4050
+ */
4051
+ treeGroupFeature? : object|boolean|string|TreeGroup|TreeGroupConfig
4052
+ /**
4053
+ * Captures versions (snapshots) of the active project, including a detailed log of the changes new in each version.
4054
+ * ...
4055
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/Versions)
4056
+ */
4057
+ versionsFeature? : object|boolean|string|Versions|VersionsConfig
4058
+
4059
+ }
4060
+
4061
+ export class BryntumGantt extends React.Component<BryntumGanttProps> {
4062
+
4063
+ static instanceClass = Gantt;
4064
+
4065
+ static instanceName = 'Gantt';
4066
+
4067
+ processWidgetContent = processWidgetContent;
4068
+
4069
+ // Component is View class
4070
+ static isView = true;
4071
+
4072
+ // Hidden div to host unused portals DOM
4073
+ portalsCache? : HTMLElement;
4074
+
4075
+ // CSS class used for individual portal containers
4076
+ portalContainerClass = 'b-react-portal-container';
4077
+
4078
+ state = {
4079
+ // Holds React portals
4080
+ portals : new Map(),
4081
+
4082
+ // Needed to trigger refresh when portals change
4083
+ generation : 0
4084
+ };
4085
+
4086
+ static featureNames = [
4087
+ 'aiFilterFeature',
4088
+ 'baselinesFeature',
4089
+ 'cellCopyPasteFeature',
4090
+ 'cellEditFeature',
4091
+ 'cellMenuFeature',
4092
+ 'cellTooltipFeature',
4093
+ 'chartsFeature',
4094
+ 'columnAutoWidthFeature',
4095
+ 'columnDragToolbarFeature',
4096
+ 'columnLinesFeature',
4097
+ 'columnPickerFeature',
4098
+ 'columnRenameFeature',
4099
+ 'columnReorderFeature',
4100
+ 'columnResizeFeature',
4101
+ 'criticalPathsFeature',
4102
+ 'dependenciesFeature',
4103
+ 'dependencyEditFeature',
4104
+ 'eventFilterFeature',
4105
+ 'eventSegmentsFeature',
4106
+ 'excelExporterFeature',
4107
+ 'fileDropFeature',
4108
+ 'fillHandleFeature',
4109
+ 'filterFeature',
4110
+ 'filterBarFeature',
4111
+ 'groupFeature',
4112
+ 'groupSummaryFeature',
4113
+ 'headerMenuFeature',
4114
+ 'headerZoomFeature',
4115
+ 'indicatorsFeature',
4116
+ 'labelsFeature',
4117
+ 'lockRowsFeature',
4118
+ 'mergeCellsFeature',
4119
+ 'mspExportFeature',
4120
+ 'nonWorkingTimeFeature',
4121
+ 'panFeature',
4122
+ 'parentAreaFeature',
4123
+ 'pdfExportFeature',
4124
+ 'percentBarFeature',
4125
+ 'pinColumnsFeature',
4126
+ 'printFeature',
4127
+ 'progressLineFeature',
4128
+ 'projectEditFeature',
4129
+ 'projectLinesFeature',
4130
+ 'quickFindFeature',
4131
+ 'regionResizeFeature',
4132
+ 'rollupsFeature',
4133
+ 'rowCopyPasteFeature',
4134
+ 'rowEditFeature',
4135
+ 'rowExpanderFeature',
4136
+ 'rowReorderFeature',
4137
+ 'rowResizeFeature',
4138
+ 'scheduleMenuFeature',
4139
+ 'scheduleTooltipFeature',
4140
+ 'scrollButtonsFeature',
4141
+ 'searchFeature',
4142
+ 'sortFeature',
4143
+ 'splitFeature',
4144
+ 'stickyCellsFeature',
4145
+ 'stripeFeature',
4146
+ 'summaryFeature',
4147
+ 'taskCopyPasteFeature',
4148
+ 'taskDragFeature',
4149
+ 'taskDragCreateFeature',
4150
+ 'taskEditFeature',
4151
+ 'taskMenuFeature',
4152
+ 'taskNonWorkingTimeFeature',
4153
+ 'taskResizeFeature',
4154
+ 'taskSegmentDragFeature',
4155
+ 'taskSegmentResizeFeature',
4156
+ 'taskTooltipFeature',
4157
+ 'timeAxisHeaderMenuFeature',
4158
+ 'timelineChartFeature',
4159
+ 'timeRangesFeature',
4160
+ 'timeSpanHighlightFeature',
4161
+ 'treeFeature',
4162
+ 'treeGroupFeature',
4163
+ 'versionsFeature'
4164
+ ];
4165
+
4166
+ projectStores = true;
4167
+
4168
+ dataStores = {
4169
+ 'assignmentStore': 'assignments',
4170
+ 'calendarManagerStore': 'calendars',
4171
+ 'dependencyStore': 'dependencies',
4172
+ 'eventStore': 'events',
4173
+ 'resourceStore': 'resources',
4174
+ 'taskStore': 'tasks',
4175
+ 'timeRangeStore': 'timeRanges'
4176
+ };
4177
+
4178
+ static configNames = [
4179
+ 'adopt',
4180
+ 'allowCreate',
4181
+ 'allowCreateOnlyParent',
4182
+ 'animateFilterRemovals',
4183
+ 'animateRemovingRows',
4184
+ 'ariaDescription',
4185
+ 'ariaLabel',
4186
+ 'autoAdjustTimeAxis',
4187
+ 'autoHeight',
4188
+ 'bbar',
4189
+ 'bodyCls',
4190
+ 'bubbleEvents',
4191
+ 'bufferCoef',
4192
+ 'bufferThreshold',
4193
+ 'collapsible',
4194
+ 'color',
4195
+ 'config',
4196
+ 'contentElementCls',
4197
+ 'contextMenuTriggerEvent',
4198
+ 'creationTooltip',
4199
+ 'cycleResolutionPopupClass',
4200
+ 'dataField',
4201
+ 'defaultRegion',
4202
+ 'defaultResourceImageName',
4203
+ 'dependencyIdField',
4204
+ 'destroyStore',
4205
+ 'detectCSSCompatibilityIssues',
4206
+ 'disableGridColumnIdWarning',
4207
+ 'disableGridRowModelWarning',
4208
+ 'displaySchedulingIssueResolutionPopup',
4209
+ 'dock',
4210
+ 'drawer',
4211
+ 'durationDisplayPrecision',
4212
+ 'elementAttributes',
4213
+ 'enableDeleteKey',
4214
+ 'enableRecurringEvents',
4215
+ 'enableSticky',
4216
+ 'enableTextSelection',
4217
+ 'enableTransactionalFeatures',
4218
+ 'fillLastColumn',
4219
+ 'fixedRowHeight',
4220
+ 'footer',
4221
+ 'formulaProviders',
4222
+ 'fullRowRefresh',
4223
+ 'getDateConstraints',
4224
+ 'getRowHeight',
4225
+ 'header',
4226
+ 'hideHorizontalScrollbar',
4227
+ 'hoverCls',
4228
+ 'icon',
4229
+ 'ignoreDomEventsWhileScrolling',
4230
+ 'ignoreParentReadOnly',
4231
+ 'listeners',
4232
+ 'loadMask',
4233
+ 'loadMaskDefaults',
4234
+ 'loadMaskError',
4235
+ 'localizable',
4236
+ 'managedEventSizing',
4237
+ 'maskDefaults',
4238
+ 'masked',
4239
+ 'maxDate',
4240
+ 'maxTimeAxisUnit',
4241
+ 'minDate',
4242
+ 'monitorResize',
4243
+ 'newTaskDefaults',
4244
+ 'owner',
4245
+ 'partner',
4246
+ 'plugins',
4247
+ 'preserveFocusOnDatasetChange',
4248
+ 'preserveScrollOnDatasetChange',
4249
+ 'preventTooltipOnTouch',
4250
+ 'projectProgressReporting',
4251
+ 'relayStoreEvents',
4252
+ 'resizable',
4253
+ 'resizeToFitIncludesHeader',
4254
+ 'resourceImageFolderPath',
4255
+ 'resourceImagePath',
4256
+ 'responsiveLevels',
4257
+ 'ripple',
4258
+ 'rootElement',
4259
+ 'schedulingIssueResolutionPopupClass',
4260
+ 'scrollerClass',
4261
+ 'scrollManager',
4262
+ 'showCostControls',
4263
+ 'showCreationTooltip',
4264
+ 'showDirty',
4265
+ 'showLagInTooltip',
4266
+ 'showRecurringUI',
4267
+ 'showTaskColorPickers',
4268
+ 'snapRelativeToEventStartDate',
4269
+ 'stateful',
4270
+ 'statefulEvents',
4271
+ 'stateId',
4272
+ 'stateProvider',
4273
+ 'stickyHeaders',
4274
+ 'strips',
4275
+ 'subGridConfigs',
4276
+ 'syncMask',
4277
+ 'tab',
4278
+ 'tabBarItems',
4279
+ 'taskRenderer',
4280
+ 'tbar',
4281
+ 'terminalCls',
4282
+ 'terminalSides',
4283
+ 'timeAxis',
4284
+ 'type',
4285
+ 'ui',
4286
+ 'visibleZoomFactor',
4287
+ 'weekStartDay',
4288
+ 'weight',
4289
+ 'zoomKeepsOriginalTimespan',
4290
+ 'zoomOnMouseWheel',
4291
+ 'zoomOnTimeAxisDoubleClick'
4292
+ ];
4293
+
4294
+ static propertyConfigNames = [
4295
+ 'alignSelf',
4296
+ 'allowDropOnEventBar',
4297
+ 'animateTreeNodeToggle',
4298
+ 'appendTo',
4299
+ 'assignments',
4300
+ 'barMargin',
4301
+ 'calendars',
4302
+ 'callOnFunctions',
4303
+ 'catchEventHandlerExceptions',
4304
+ 'cellEllipsis',
4305
+ 'cls',
4306
+ 'collapsed',
4307
+ 'column',
4308
+ 'columnLines',
4309
+ 'columns',
4310
+ 'creationTooltipTemplate',
4311
+ 'data',
4312
+ 'dataset',
4313
+ 'dependencies',
4314
+ 'disabled',
4315
+ 'displayDateFormat',
4316
+ 'emptyText',
4317
+ 'enableEventAnimations',
4318
+ 'enableUndoRedoKeys',
4319
+ 'endDate',
4320
+ 'eventColor',
4321
+ 'eventStyle',
4322
+ 'extraData',
4323
+ 'fillTicks',
4324
+ 'flex',
4325
+ 'forceFit',
4326
+ 'height',
4327
+ 'hidden',
4328
+ 'hideFooters',
4329
+ 'hideHeaders',
4330
+ 'hideRowHover',
4331
+ 'id',
4332
+ 'infiniteScroll',
4333
+ 'inputFieldAlign',
4334
+ 'insertBefore',
4335
+ 'insertFirst',
4336
+ 'keyMap',
4337
+ 'labelPosition',
4338
+ 'longPressTime',
4339
+ 'margin',
4340
+ 'maxHeight',
4341
+ 'maxWidth',
4342
+ 'maxZoomLevel',
4343
+ 'minHeight',
4344
+ 'minWidth',
4345
+ 'minZoomLevel',
4346
+ 'onAfterDependencyCreateDrop',
4347
+ 'onAfterDependencySave',
4348
+ 'onAfterDragCreate',
4349
+ 'onAfterEventEdit',
4350
+ 'onAfterEventSave',
4351
+ 'onAfterProjectEdit',
4352
+ 'onAfterProjectSave',
4353
+ 'onAfterTaskDrop',
4354
+ 'onAfterTaskEdit',
4355
+ 'onAfterTaskSave',
4356
+ 'onAfterTaskSegmentDrop',
4357
+ 'onBeforeAssignmentDelete',
4358
+ 'onBeforeCancelCellEdit',
4359
+ 'onBeforeCancelRowEdit',
4360
+ 'onBeforeCellEditStart',
4361
+ 'onBeforeCellRangeDelete',
4362
+ 'onBeforeCellRangeEdit',
4363
+ 'onBeforeColumnDragStart',
4364
+ 'onBeforeColumnDropFinalize',
4365
+ 'onBeforeColumnResize',
4366
+ 'onBeforeCopy',
4367
+ 'onBeforeCSVExport',
4368
+ 'onBeforeDependencyAdd',
4369
+ 'onBeforeDependencyCreateDrag',
4370
+ 'onBeforeDependencyCreateFinalize',
4371
+ 'onBeforeDependencyDelete',
4372
+ 'onBeforeDependencyEdit',
4373
+ 'onBeforeDependencyEditShow',
4374
+ 'onBeforeDependencySave',
4375
+ 'onBeforeDestroy',
4376
+ 'onBeforeDragCreate',
4377
+ 'onBeforeDragCreateFinalize',
4378
+ 'onBeforeEventDelete',
4379
+ 'onBeforeEventEdit',
4380
+ 'onBeforeEventEditShow',
4381
+ 'onBeforeEventResize',
4382
+ 'onBeforeEventResizeFinalize',
4383
+ 'onBeforeEventSave',
4384
+ 'onBeforeEventSegmentResize',
4385
+ 'onBeforeEventSegmentResizeFinalize',
4386
+ 'onBeforeExcelExport',
4387
+ 'onBeforeFillHandleDragStart',
4388
+ 'onBeforeFinishCellEdit',
4389
+ 'onBeforeFinishRowEdit',
4390
+ 'onBeforeHide',
4391
+ 'onBeforeMspExport',
4392
+ 'onBeforePan',
4393
+ 'onBeforePaste',
4394
+ 'onBeforePdfExport',
4395
+ 'onBeforePresetChange',
4396
+ 'onBeforeProjectEdit',
4397
+ 'onBeforeProjectEditShow',
4398
+ 'onBeforeProjectSave',
4399
+ 'onBeforeRenderRow',
4400
+ 'onBeforeRenderRows',
4401
+ 'onBeforeRowCollapse',
4402
+ 'onBeforeRowExpand',
4403
+ 'onBeforeSelectionChange',
4404
+ 'onBeforeSetRecord',
4405
+ 'onBeforeShow',
4406
+ 'onBeforeShowTerminals',
4407
+ 'onBeforeStartRowEdit',
4408
+ 'onBeforeStateApply',
4409
+ 'onBeforeStateSave',
4410
+ 'onBeforeTaskAdd',
4411
+ 'onBeforeTaskDelete',
4412
+ 'onBeforeTaskDrag',
4413
+ 'onBeforeTaskDropFinalize',
4414
+ 'onBeforeTaskEdit',
4415
+ 'onBeforeTaskEditShow',
4416
+ 'onBeforeTaskResize',
4417
+ 'onBeforeTaskResizeFinalize',
4418
+ 'onBeforeTaskSave',
4419
+ 'onBeforeTaskSegmentDrag',
4420
+ 'onBeforeTaskSegmentDropFinalize',
4421
+ 'onBeforeTaskSegmentResize',
4422
+ 'onBeforeTaskSegmentResizeFinalize',
4423
+ 'onBeforeToggleGroup',
4424
+ 'onBeforeToggleNode',
4425
+ 'onCancelCellEdit',
4426
+ 'onCatchAll',
4427
+ 'onCellClick',
4428
+ 'onCellContextMenu',
4429
+ 'onCellDblClick',
4430
+ 'onCellMenuBeforeShow',
4431
+ 'onCellMenuItem',
4432
+ 'onCellMenuShow',
4433
+ 'onCellMenuToggleItem',
4434
+ 'onCellMouseEnter',
4435
+ 'onCellMouseLeave',
4436
+ 'onCellMouseOut',
4437
+ 'onCellMouseOver',
4438
+ 'onCollapse',
4439
+ 'onCollapseNode',
4440
+ 'onColumnDrag',
4441
+ 'onColumnDragStart',
4442
+ 'onColumnDrop',
4443
+ 'onColumnResize',
4444
+ 'onColumnResizeStart',
4445
+ 'onContextMenuItem',
4446
+ 'onContextMenuToggleItem',
4447
+ 'onCopy',
4448
+ 'onCriticalPathsHighlighted',
4449
+ 'onCriticalPathsUnhighlighted',
4450
+ 'onCurrentTimelineUpdate',
4451
+ 'onDataChange',
4452
+ 'onDateRangeChange',
4453
+ 'onDependenciesDrawn',
4454
+ 'onDependencyClick',
4455
+ 'onDependencyContextMenu',
4456
+ 'onDependencyCreateDragStart',
4457
+ 'onDependencyCreateDrop',
4458
+ 'onDependencyDblClick',
4459
+ 'onDependencyMouseOut',
4460
+ 'onDependencyMouseOver',
4461
+ 'onDependencyValidationComplete',
4462
+ 'onDependencyValidationStart',
4463
+ 'onDestroy',
4464
+ 'onDirtyStateChange',
4465
+ 'onDragCreateEnd',
4466
+ 'onDragCreateStart',
4467
+ 'onDragSelecting',
4468
+ 'onElementCreated',
4469
+ 'onEventEditBeforeSetRecord',
4470
+ 'onEventMenuBeforeShow',
4471
+ 'onEventMenuItem',
4472
+ 'onEventMenuShow',
4473
+ 'onEventPartialResize',
4474
+ 'onEventResizeEnd',
4475
+ 'onEventResizeStart',
4476
+ 'onEventSegmentPartialResize',
4477
+ 'onEventSegmentResizeEnd',
4478
+ 'onEventSegmentResizeStart',
4479
+ 'onExpand',
4480
+ 'onExpandNode',
4481
+ 'onFileDrop',
4482
+ 'onFillHandleBeforeDragFinalize',
4483
+ 'onFillHandleDrag',
4484
+ 'onFillHandleDragAbort',
4485
+ 'onFillHandleDragEnd',
4486
+ 'onFillHandleDragStart',
4487
+ 'onFinishCellEdit',
4488
+ 'onFinishRowEdit',
4489
+ 'onFocusIn',
4490
+ 'onFocusOut',
4491
+ 'onGridRowBeforeDragStart',
4492
+ 'onGridRowBeforeDropFinalize',
4493
+ 'onGridRowDrag',
4494
+ 'onGridRowDragAbort',
4495
+ 'onGridRowDragStart',
4496
+ 'onGridRowDrop',
4497
+ 'onHeaderClick',
4498
+ 'onHeaderMenuBeforeShow',
4499
+ 'onHeaderMenuItem',
4500
+ 'onHeaderMenuShow',
4501
+ 'onHeaderMenuToggleItem',
4502
+ 'onHide',
4503
+ 'onLockRows',
4504
+ 'onMouseOut',
4505
+ 'onMouseOver',
4506
+ 'onMspExport',
4507
+ 'onNavigate',
4508
+ 'onNoZoomChange',
4509
+ 'onPaint',
4510
+ 'onPaste',
4511
+ 'onPdfExport',
4512
+ 'onPercentBarDrag',
4513
+ 'onPercentBarDragAbort',
4514
+ 'onPercentBarDragStart',
4515
+ 'onPercentBarDrop',
4516
+ 'onPresetChange',
4517
+ 'onProjectEditCanceled',
4518
+ 'onReadOnly',
4519
+ 'onRecompose',
4520
+ 'onReleaseTask',
4521
+ 'onRenderRow',
4522
+ 'onRenderRows',
4523
+ 'onRenderTask',
4524
+ 'onResize',
4525
+ 'onResourceAssignmentClick',
4526
+ 'onResponsive',
4527
+ 'onRowCollapse',
4528
+ 'onRowExpand',
4529
+ 'onRowMouseEnter',
4530
+ 'onRowMouseLeave',
4531
+ 'onScheduleMenuBeforeShow',
4532
+ 'onScheduleMenuItem',
4533
+ 'onScheduleMenuShow',
4534
+ 'onScroll',
4535
+ 'onScrollButtonClick',
4536
+ 'onSelectionChange',
4537
+ 'onSelectionModeChange',
4538
+ 'onShow',
4539
+ 'onSplit',
4540
+ 'onSplitterCollapseClick',
4541
+ 'onSplitterDragEnd',
4542
+ 'onSplitterDragStart',
4543
+ 'onSplitterExpandClick',
4544
+ 'onStartCellEdit',
4545
+ 'onStartRowEdit',
4546
+ 'onSubGridCollapse',
4547
+ 'onSubGridExpand',
4548
+ 'onTaskClick',
4549
+ 'onTaskContextMenu',
4550
+ 'onTaskDblClick',
4551
+ 'onTaskDrag',
4552
+ 'onTaskDragStart',
4553
+ 'onTaskDrop',
4554
+ 'onTaskEditCanceled',
4555
+ 'onTaskKeyDown',
4556
+ 'onTaskKeyUp',
4557
+ 'onTaskMenuBeforeShow',
4558
+ 'onTaskMenuItem',
4559
+ 'onTaskMenuShow',
4560
+ 'onTaskMouseDown',
4561
+ 'onTaskMouseOut',
4562
+ 'onTaskMouseOver',
4563
+ 'onTaskMouseUp',
4564
+ 'onTaskNonWorkingTimeClick',
4565
+ 'onTaskNonWorkingTimeContextMenu',
4566
+ 'onTaskNonWorkingTimeDblClick',
4567
+ 'onTaskPartialResize',
4568
+ 'onTaskResizeEnd',
4569
+ 'onTaskResizeStart',
4570
+ 'onTaskSegmentDrag',
4571
+ 'onTaskSegmentDragStart',
4572
+ 'onTaskSegmentDrop',
4573
+ 'onTaskSegmentPartialResize',
4574
+ 'onTaskSegmentResizeEnd',
4575
+ 'onTaskSegmentResizeStart',
4576
+ 'onTickSizeChange',
4577
+ 'onTimeAxisChange',
4578
+ 'onTimeAxisHeaderClick',
4579
+ 'onTimeAxisHeaderContextMenu',
4580
+ 'onTimeAxisHeaderDblClick',
4581
+ 'onTimeAxisHeaderMenuBeforeShow',
4582
+ 'onTimeAxisHeaderMenuItem',
4583
+ 'onTimeAxisHeaderMenuShow',
4584
+ 'onTimelineContextChange',
4585
+ 'onTimelineViewportResize',
4586
+ 'onTimeRangeHeaderClick',
4587
+ 'onTimeRangeHeaderContextMenu',
4588
+ 'onTimeRangeHeaderDblClick',
4589
+ 'onToggleGroup',
4590
+ 'onToggleNode',
4591
+ 'onToolClick',
4592
+ 'onTransactionChange',
4593
+ 'onUnlockRows',
4594
+ 'onUnsplit',
4595
+ 'onVisibleDateRangeChange',
4596
+ 'preserveScroll',
4597
+ 'presets',
4598
+ 'project',
4599
+ 'readOnly',
4600
+ 'recurrenceConfirmationPopup',
4601
+ 'rendition',
4602
+ 'resources',
4603
+ 'rowHeight',
4604
+ 'rowLines',
4605
+ 'rtl',
4606
+ 'scrollable',
4607
+ 'scrollTaskIntoViewOnCellClick',
4608
+ 'selectionMode',
4609
+ 'showTooltip',
4610
+ 'showUnscheduledTasks',
4611
+ 'snap',
4612
+ 'span',
4613
+ 'startDate',
4614
+ 'stateSettings',
4615
+ 'store',
4616
+ 'suppressFit',
4617
+ 'tasks',
4618
+ 'taskStore',
4619
+ 'terminalHideDelay',
4620
+ 'terminalOffset',
4621
+ 'terminalShowDelay',
4622
+ 'terminalSize',
4623
+ 'tickSize',
4624
+ 'timeRanges',
4625
+ 'timeResolution',
4626
+ 'timeZone',
4627
+ 'title',
4628
+ 'toggleParentTasksOnClick',
4629
+ 'tools',
4630
+ 'tooltipTemplate',
4631
+ 'transition',
4632
+ 'transitionDuration',
4633
+ 'useContextualRecurrenceRules',
4634
+ 'viewPreset',
4635
+ 'visibleDate',
4636
+ 'width',
4637
+ 'workingTime'
4638
+ ];
4639
+
4640
+ static propertyNames = [
4641
+ 'calendarManagerStore',
4642
+ 'focusVisible',
4643
+ 'hasChanges',
4644
+ 'originalStore',
4645
+ 'parent',
4646
+ 'scrollLeft',
4647
+ 'scrollTop',
4648
+ 'scrollX',
4649
+ 'selectedCell',
4650
+ 'selectedCells',
4651
+ 'selectedRecord',
4652
+ 'selectedRecords',
4653
+ 'selectedRows',
4654
+ 'state',
4655
+ 'tooltip',
4656
+ 'zoomLevel'
4657
+ ];
4658
+
4659
+ // Component instance
4660
+ instance!: Gantt;
4661
+
4662
+ // Component element
4663
+ element! : HTMLElement;
4664
+
4665
+ componentDidMount(): void {
4666
+ this.instance = createWidget(this);
4667
+ }
4668
+
4669
+ componentWillUnmount(): void {
4670
+ // @ts-ignore
4671
+ this.instance?.destroy?.();
4672
+ }
4673
+
4674
+ /**
4675
+ * Component about to be updated, from changing a prop using state.
4676
+ * React to it depending on what changed and prevent react from re-rendering our component.
4677
+ * @param nextProps
4678
+ * @param nextState
4679
+ * @returns {boolean}
4680
+ */
4681
+ shouldComponentUpdate(nextProps: Readonly<BryntumGanttProps>, nextState: Readonly<{}>): boolean {
4682
+ return shouldComponentUpdate(this, nextProps, nextState);
4683
+ }
4684
+
4685
+ render(): React.ReactNode {
4686
+
4687
+ const className = `b-react-gantt-container`;
4688
+ return (
4689
+ <React.Fragment>
4690
+ <div className={className} ref={(element) => (this.element = element!)}>
4691
+ {Array.from(this.state.portals).map((item) => item[1])}
4692
+ </div>
4693
+ <div ref={el => (this.portalsCache = el!)} className="b-react-portals-cache" style={{ display : 'none' }}></div>
4694
+ </React.Fragment>
4695
+ );
4696
+
4697
+ }
4698
+ }