@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,4696 @@
1
+ /**
2
+ * React wrapper for Bryntum GanttBase
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, GanttBase, GanttBaseListeners, 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 BryntumGanttBaseProps = {
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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#config-listeners)
591
+ */
592
+ listeners? : GanttBaseListeners
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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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
+ /**
1193
+ * Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
1194
+ * as a space separated string, an array of strings, or as an object in which property names with truthy
1195
+ * values are used as the class names.
1196
+ * ...
1197
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#config-ui)
1198
+ */
1199
+ ui? : 'plain'|'toolbar'|string|object
1200
+ /**
1201
+ * By default, the day of week and week of month of the event's start date are used to create
1202
+ * helpful contextual recurrence types when editing a non-recurring event record and choosing
1203
+ * an initial recurrence type.
1204
+ * ...
1205
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#config-useContextualRecurrenceRules)
1206
+ */
1207
+ useContextualRecurrenceRules? : boolean
1208
+ /**
1209
+ * A string key used to lookup a predefined [ViewPreset](https://bryntum.com/products/gantt/docs/api/Scheduler/preset/ViewPreset) (e.g. 'weekAndDay', 'hourAndDay'),
1210
+ * managed by [PresetManager](https://bryntum.com/products/gantt/docs/api/Scheduler/preset/PresetManager). See [PresetManager](#Scheduler/preset/PresetManager) for more information.
1211
+ * Or a config object for a viewPreset.
1212
+ * ...
1213
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#config-viewPreset)
1214
+ */
1215
+ viewPreset? : string|ViewPresetConfig
1216
+ /**
1217
+ * A date to bring into view initially on the scrollable timeline.
1218
+ * ...
1219
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#config-visibleDate)
1220
+ */
1221
+ visibleDate? : Date|VisibleDate
1222
+ /**
1223
+ * Integer number indicating the size of timespan during zooming. When zooming, the timespan is adjusted to make
1224
+ * the scrolling area `visibleZoomFactor` times wider than the timeline area itself. Used in
1225
+ * [zoomToSpan](https://bryntum.com/products/gantt/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomToSpan) and [zoomToLevel](#Scheduler/view/mixin/TimelineZoomable#function-zoomToLevel) functions.
1226
+ */
1227
+ visibleZoomFactor? : number
1228
+ /**
1229
+ * A valid JS day index between 0-6 (0: Sunday, 1: Monday etc.) to be considered the start day of the week.
1230
+ * When omitted, the week start day is retrieved from the active locale class.
1231
+ */
1232
+ weekStartDay? : number
1233
+ /**
1234
+ * A widgets weight determines its position among siblings when added to a [Container](https://bryntum.com/products/gantt/docs/api/Core/widget/Container).
1235
+ * Higher weights go further down.
1236
+ */
1237
+ weight? : number
1238
+ /**
1239
+ * Widget's width, used to set element `style.width`. Either specify a valid width string or a number, which
1240
+ * will get 'px' appended. We recommend using CSS as the primary way to control width, but in some cases
1241
+ * this config is convenient.
1242
+ */
1243
+ width? : string|number
1244
+ /**
1245
+ * An object with format `{ fromDay, toDay, fromHour, toHour }` that describes the working days and hours.
1246
+ * This object will be used to populate TimeAxis [include](https://bryntum.com/products/gantt/docs/api/Scheduler/data/TimeAxis#config-include) property.
1247
+ * ...
1248
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#config-workingTime)
1249
+ */
1250
+ workingTime? : {
1251
+ fromDay?: number
1252
+ toDay?: number
1253
+ fromHour?: number
1254
+ toHour?: number
1255
+ }
1256
+ /**
1257
+ * Whether the originally rendered timespan should be preserved while zooming. By default, it is set to `false`,
1258
+ * meaning the timeline panel will adjust the currently rendered timespan to limit the amount of HTML content to
1259
+ * render. When setting this option to `true`, be careful not to allow to zoom a big timespan in seconds
1260
+ * resolution for example. That will cause <strong>a lot</strong> of HTML content to be rendered and affect performance. You
1261
+ * 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.
1262
+ */
1263
+ zoomKeepsOriginalTimespan? : boolean
1264
+ /**
1265
+ * If true, you can zoom in and out on the time axis using CTRL-key + mouse wheel.
1266
+ */
1267
+ zoomOnMouseWheel? : boolean
1268
+ /**
1269
+ * True to zoom to time span when double-clicking a time axis cell.
1270
+ */
1271
+ zoomOnTimeAxisDoubleClick? : boolean
1272
+
1273
+ // Events
1274
+ /**
1275
+ * Fired on the owning Scheduler/Gantt after a dependency drag creation operation finished, no matter to outcome
1276
+ * @param {object} event Event object
1277
+ * @param {Scheduler.model.TimeSpan} event.source The source task
1278
+ * @param {Scheduler.model.TimeSpan} event.target The target task
1279
+ * @param {Scheduler.model.DependencyBaseModel} event.dependency The created dependency
1280
+ */
1281
+ onAfterDependencyCreateDrop? : ((event: { source: TimeSpan, target: TimeSpan, dependency: DependencyBaseModel }) => void)|string
1282
+ /**
1283
+ * Fires on the owning Scheduler or Gantt widget after a dependency is successfully saved using the
1284
+ * dependency edit popup
1285
+ * @param {object} event Event object
1286
+ * @param {Scheduler.view.Scheduler} event.source The scheduler instance or Gantt instance
1287
+ * @param {Scheduler.model.SchedulerDependencyModel} event.dependencyRecord The dependency about to be saved
1288
+ */
1289
+ onAfterDependencySave? : ((event: { source: Scheduler, dependencyRecord: SchedulerDependencyModel }) => void)|string
1290
+ /**
1291
+ * Fires on the owning Gantt at the end of the drag create gesture whether or not
1292
+ * a task was scheduled by the gesture.
1293
+ * @param {object} event Event object
1294
+ * @param {Gantt.view.Gantt} event.source
1295
+ * @param {HTMLElement} event.proxyElement The element showing the drag creation zone.
1296
+ */
1297
+ onAfterDragCreate? : ((event: { source: Gantt, proxyElement: HTMLElement }) => void)|string
1298
+ /**
1299
+ * Fires on the owning Scheduler after editor is closed by any action - save, delete or cancel
1300
+ * @param {object} event Event object
1301
+ * @param {Scheduler.view.Scheduler} event.source The scheduler
1302
+ * @param {'save','delete','cancel'} event.action The action that was taken to end the edit. One of 'save', 'delete' or 'cancel'
1303
+ * @param {Scheduler.feature.EventEdit} event.eventEdit The eventEdit feature
1304
+ * @param {Scheduler.model.SchedulerEventModel} event.eventRecord The record that has been edited.
1305
+ * @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.
1306
+ * @param {HTMLElement} event.eventElement The element which represents the event in the scheduler display.
1307
+ * @param {Core.widget.Popup} event.editor The editor
1308
+ */
1309
+ onAfterEventEdit? : ((event: { source: Scheduler, action: 'save'|'delete'|'cancel', eventEdit: EventEdit, eventRecord: SchedulerEventModel, resourceRecord: SchedulerResourceModel, eventElement: HTMLElement, editor: Popup }) => void)|string
1310
+ /**
1311
+ * Fires on the owning Scheduler or Gantt widget instance after an event record is saved
1312
+ * @param {object} event Event object
1313
+ * @param {SchedulerPro.view.SchedulerPro} event.source The Scheduler Pro instance
1314
+ * @param {SchedulerPro.model.EventModel} event.eventRecord The event record about to be saved
1315
+ * @param {SchedulerPro.widget.TaskEditorBase} event.editor The editor widget
1316
+ */
1317
+ onAfterEventSave? : ((event: { source: SchedulerPro, eventRecord: EventModel, editor: TaskEditorBase }) => void)|string
1318
+ /**
1319
+ * Fires on the owning Gantt widget instance after project editing is finished by applying changes or
1320
+ * cancelling them.
1321
+ * @param {object} event Event object
1322
+ * @param {Gantt.view.Gantt} event.source The Gantt instance
1323
+ * @param {Gantt.model.ProjectModel} event.projectRecord The edited project record
1324
+ * @param {Gantt.widget.ProjectEditor} event.editor The editor widget
1325
+ */
1326
+ onAfterProjectEdit? : ((event: { source: Gantt, projectRecord: ProjectModel, editor: ProjectEditor }) => void)|string
1327
+ /**
1328
+ * Fires on the owning Gantt widget instance after a project is saved
1329
+ * @param {object} event Event object
1330
+ * @param {Gantt.view.Gantt} event.source The Gantt instance
1331
+ * @param {Gantt.model.ProjectModel} event.projectRecord The project about to be saved
1332
+ * @param {Gantt.widget.ProjectEditor} event.editor The editor widget
1333
+ */
1334
+ onAfterProjectSave? : ((event: { source: Gantt, projectRecord: ProjectModel, editor: ProjectEditor }) => void)|string
1335
+ /**
1336
+ * Fires on the owning Gantt after a task drop, regardless if the drop validity
1337
+ * @param {object} event Event object
1338
+ * @param {Gantt.view.Gantt} event.source
1339
+ * @param {Gantt.model.TaskModel[]} event.taskRecords
1340
+ * @param {boolean} event.valid
1341
+ */
1342
+ onAfterTaskDrop? : ((event: { source: Gantt, taskRecords: TaskModel[], valid: boolean }) => void)|string
1343
+ /**
1344
+ * Fires on the owning Scheduler or Gantt widget instance after task editing is finished by applying changes, cancelling them
1345
+ * or deleting the task record.
1346
+ * @param {object} event Event object
1347
+ * @param {SchedulerPro.view.SchedulerPro} event.source The Scheduler Pro instance
1348
+ * @param {SchedulerPro.model.EventModel} event.taskRecord Task record used in the task editor
1349
+ * @param {SchedulerPro.widget.TaskEditorBase} event.editor The editor widget
1350
+ */
1351
+ onAfterTaskEdit? : ((event: { source: SchedulerPro, taskRecord: EventModel, editor: TaskEditorBase }) => void)|string
1352
+ /**
1353
+ * Fires on the owning Scheduler or Gantt widget instance after a task is saved
1354
+ * @param {object} event Event object
1355
+ * @param {SchedulerPro.view.SchedulerPro} event.source The Scheduler Pro instance
1356
+ * @param {SchedulerPro.model.EventModel} event.taskRecord The task about to be saved
1357
+ * @param {SchedulerPro.widget.TaskEditorBase} event.editor The editor widget
1358
+ */
1359
+ onAfterTaskSave? : ((event: { source: SchedulerPro, taskRecord: EventModel, editor: TaskEditorBase }) => void)|string
1360
+ /**
1361
+ * Fires on the owning Gantt after a task drop, regardless if the drop validity
1362
+ * @param {object} event Event object
1363
+ * @param {Gantt.view.Gantt} event.source
1364
+ * @param {Gantt.model.TaskModel[]} event.taskRecords Dropped segments
1365
+ * @param {boolean} event.valid
1366
+ */
1367
+ onAfterTaskSegmentDrop? : ((event: { source: Gantt, taskRecords: TaskModel[], valid: boolean }) => void)|string
1368
+ /**
1369
+ * Fires before an assignment is removed. Can be triggered by user pressing [DELETE] or [BACKSPACE] or
1370
+ * by the event editor. Can for example be used to display a custom dialog to confirm deletion, in which
1371
+ * case records should be "manually" removed after confirmation:
1372
+ * ...
1373
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-beforeAssignmentDelete)
1374
+ * @param {object} event Event object
1375
+ * @param {Scheduler.view.Scheduler} event.source The Scheduler instance
1376
+ * @param {Scheduler.model.SchedulerAssignmentModel[]} event.assignmentRecords The assignment records about to be deleted
1377
+ * @param {object} event.context Additional removal context:
1378
+ * @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.
1379
+ * @param {boolean} event.context.finalize.removeRecords Provide `false` to the function to prevent the removal.
1380
+ */
1381
+ onBeforeAssignmentDelete? : ((event: { source: Scheduler, assignmentRecords: SchedulerAssignmentModel[], context: { finalize: { removeRecords?: boolean } } }) => Promise<boolean>|boolean|void)|string
1382
+ /**
1383
+ * Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
1384
+ * @param {object} event Event object
1385
+ * @param {Grid.view.Grid} event.source Owner grid
1386
+ * @param {Grid.util.GridLocation} event.editorContext Editing context
1387
+ */
1388
+ onBeforeCancelCellEdit? : ((event: { source: Grid, editorContext: GridLocation }) => Promise<boolean>|boolean|void)|string
1389
+ /**
1390
+ * 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.
1391
+ * ...
1392
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-beforeCancelRowEdit)
1393
+ * @param {object} event Event object
1394
+ * @param {Grid.view.Grid} event.grid Target grid
1395
+ * @param {RowEditorContext} event.editorContext Editing context
1396
+ */
1397
+ onBeforeCancelRowEdit? : ((event: { grid: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string
1398
+ /**
1399
+ * Fires on the owning Grid before editing starts, return `false` to prevent editing
1400
+ * @param {object} event Event object
1401
+ * @param {Grid.view.Grid} event.source Owner grid
1402
+ * @param {CellEditorContext} event.editorContext Editing context
1403
+ */
1404
+ onBeforeCellEditStart? : ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
1405
+ /**
1406
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
1407
+ * buttons while [autoEdit](https://bryntum.com/products/gantt/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
1408
+ * @param {object} event Event object
1409
+ * @param {Grid.view.Grid} event.source Owner grid
1410
+ * @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).
1411
+ */
1412
+ onBeforeCellRangeDelete? : ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => Promise<boolean>|boolean|void)|string
1413
+ /**
1414
+ * Fires for each selected record on the owning Grid before editing a range of selected cell values
1415
+ * @param {object} event Event object
1416
+ * @param {Core.data.Model} event.record Current selected record from the range
1417
+ * @param {string} event.field The field being changed
1418
+ * @param {any} event.value The value being set
1419
+ */
1420
+ onBeforeCellRangeEdit? : ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
1421
+ /**
1422
+ * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
1423
+ * @param {object} event Event object
1424
+ * @param {Grid.view.Grid} event.source The grid instance.
1425
+ * @param {Grid.column.Column} event.column The dragged column.
1426
+ * @param {Event} event.event The browser event.
1427
+ */
1428
+ onBeforeColumnDragStart? : ((event: { source: Grid, column: Column, event: Event }) => Promise<boolean>|boolean|void)|string
1429
+ /**
1430
+ * This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
1431
+ * @param {object} event Event object
1432
+ * @param {Grid.view.Grid} event.source The grid instance.
1433
+ * @param {Grid.column.Column} event.column The dragged column.
1434
+ * @param {Grid.column.Column} event.insertBefore The column before which the dragged column will be inserted.
1435
+ * @param {Grid.column.Column} event.newParent The new parent column.
1436
+ * @param {Event} event.event The browser event.
1437
+ * @param {string} event.region The region where the column was dropped.
1438
+ */
1439
+ onBeforeColumnDropFinalize? : ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => Promise<boolean>|boolean|void)|string
1440
+ /**
1441
+ * This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
1442
+ * `false`.
1443
+ * @param {object} event Event object
1444
+ * @param {Grid.view.Grid} event.source The grid instance
1445
+ * @param {Grid.column.Column} event.column The column
1446
+ * @param {Event} event.domEvent The browser event
1447
+ */
1448
+ onBeforeColumnResize? : ((event: { source: Grid, column: Column, domEvent: Event }) => Promise<boolean>|boolean|void)|string
1449
+ /**
1450
+ * Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
1451
+ * @param {object} event Event object
1452
+ * @param {Grid.view.Grid} event.source Owner grid
1453
+ * @param {Grid.util.GridLocation[]} event.cells The cells about to be copied or cut
1454
+ * @param {string} event.data The string data about to be copied or cut
1455
+ * @param {boolean} event.isCut `true` if this is a cut action
1456
+ * @param {string} event.entityName 'cell' to distinguish this event from other beforeCopy events
1457
+ */
1458
+ onBeforeCopy? : ((event: { source: Grid, cells: GridLocation[], data: string, isCut: boolean, entityName: string }) => Promise<boolean>|boolean|void)|string
1459
+ /**
1460
+ * Fires on the owning Grid before CSV export starts. Return `false` to cancel the export.
1461
+ * @param {object} event Event object
1462
+ * @param {ExportConfig} event.config Export config
1463
+ * @param {Grid.column.Column[]} event.columns An array of columns to export
1464
+ * @param {Core.data.Model[]} event.rows An array of records to export
1465
+ * @param {string} event.lineDelimiter The CSV delimiter to separate lines
1466
+ * @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
1467
+ */
1468
+ onBeforeCSVExport? : ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => Promise<boolean>|boolean|void)|string
1469
+ /**
1470
+ * Fires on the owning Scheduler or Gantt widget before a dependency is added from the dependency
1471
+ * edit popup
1472
+ * @param {object} event Event object
1473
+ * @param {Scheduler.view.Scheduler} event.source The scheduler or Gantt instance
1474
+ * @param {Scheduler.feature.SchedulerDependencyEdit} event.dependencyEdit The dependency edit feature
1475
+ * @param {Scheduler.model.SchedulerDependencyModel} event.dependencyRecord The dependency about to be added
1476
+ */
1477
+ onBeforeDependencyAdd? : ((event: { source: Scheduler, dependencyEdit: SchedulerDependencyEdit, dependencyRecord: SchedulerDependencyModel }) => Promise<boolean>|boolean|void)|string
1478
+ /**
1479
+ * Fired on the owning Scheduler/Gantt before a dependency creation drag operation starts. Return `false` to
1480
+ * prevent it
1481
+ * @param {object} event Event object
1482
+ * @param {Scheduler.model.TimeSpan} event.source The source task
1483
+ */
1484
+ onBeforeDependencyCreateDrag? : ((event: { source: TimeSpan }) => Promise<boolean>|boolean|void)|string
1485
+ /**
1486
+ * Fired on the owning Scheduler/Gantt when a dependency drag creation operation is about to finalize
1487
+ * @param {object} event Event object
1488
+ * @param {Scheduler.model.TimeSpan} event.source The source task
1489
+ * @param {Scheduler.model.TimeSpan} event.target The target task
1490
+ * @param {'start','end','top','bottom'} event.fromSide The from side (start / end / top / bottom)
1491
+ * @param {'start','end','top','bottom'} event.toSide The to side (start / end / top / bottom)
1492
+ */
1493
+ onBeforeDependencyCreateFinalize? : ((event: { source: TimeSpan, target: TimeSpan, fromSide: 'start'|'end'|'top'|'bottom', toSide: 'start'|'end'|'top'|'bottom' }) => Promise<boolean>|boolean|void)|string
1494
+ /**
1495
+ * Fires on the owning Scheduler or Gantt widget before a dependency is deleted from the dependency
1496
+ * edit popup, or when clicking the delete icon on a selected dependency line.
1497
+ * @param {object} event Event object
1498
+ * @param {Scheduler.view.Scheduler} event.source The scheduler instance
1499
+ * @param {Scheduler.model.SchedulerDependencyModel} event.dependencyRecord The dependency record about to be deleted
1500
+ */
1501
+ onBeforeDependencyDelete? : ((event: { source: Scheduler, dependencyRecord: SchedulerDependencyModel }) => Promise<boolean>|boolean|void)|string
1502
+ /**
1503
+ * Fires on the owning Scheduler or Gantt widget before an dependency is displayed in the editor.
1504
+ * This may be listened for to allow an application to take over dependency editing duties. Return `false` to
1505
+ * stop the default editing UI from being shown or a `Promise` yielding `true` or `false` for async vetoing.
1506
+ * @param {object} event Event object
1507
+ * @param {Scheduler.view.Scheduler} event.source The scheduler or Gantt instance
1508
+ * @param {Scheduler.feature.SchedulerDependencyEdit} event.dependencyEdit The dependencyEdit feature
1509
+ * @param {Scheduler.model.SchedulerDependencyModel} event.dependencyRecord The record about to be shown in the editor.
1510
+ */
1511
+ onBeforeDependencyEdit? : ((event: { source: Scheduler, dependencyEdit: SchedulerDependencyEdit, dependencyRecord: SchedulerDependencyModel }) => Promise<boolean>|boolean|void)|string
1512
+ /**
1513
+ * Fires on the owning Scheduler or Gantt widget when the editor for a dependency is available, but before it is shown. Allows
1514
+ * manipulating fields before the widget is shown.
1515
+ * @param {object} event Event object
1516
+ * @param {Scheduler.view.Scheduler} event.source The scheduler or Gantt instance
1517
+ * @param {Scheduler.feature.SchedulerDependencyEdit} event.dependencyEdit The dependencyEdit feature
1518
+ * @param {Scheduler.model.SchedulerDependencyModel} event.dependencyRecord The record about to be shown in the editor.
1519
+ * @param {Core.widget.Popup} event.editor The editor popup
1520
+ */
1521
+ onBeforeDependencyEditShow? : ((event: { source: Scheduler, dependencyEdit: SchedulerDependencyEdit, dependencyRecord: SchedulerDependencyModel, editor: Popup }) => void)|string
1522
+ /**
1523
+ * Fires on the owning Scheduler or Gantt widget before a dependency is saved using the dependency edit popup
1524
+ * @param {object} event Event object
1525
+ * @param {Scheduler.view.Scheduler} event.source The scheduler or Gantt instance
1526
+ * @param {Scheduler.model.SchedulerDependencyModel} event.dependencyRecord The dependency about to be saved
1527
+ * @param {object} event.values The new values
1528
+ */
1529
+ onBeforeDependencySave? : ((event: { source: Scheduler, dependencyRecord: SchedulerDependencyModel, values: object }) => Promise<boolean>|boolean|void)|string
1530
+ /**
1531
+ * Fires before an object is destroyed.
1532
+ * @param {object} event Event object
1533
+ * @param {Core.Base} event.source The Object that is being destroyed.
1534
+ */
1535
+ onBeforeDestroy? : ((event: { source: Base }) => void)|string
1536
+ /**
1537
+ * Fires on the owning Gantt at the beginning of the drag gesture
1538
+ * @param {object} event Event object
1539
+ * @param {Gantt.view.Gantt} event.source
1540
+ * @param {Gantt.model.TaskModel} event.taskRecord
1541
+ * @param {Date} event.date The datetime associated with the drag start point.
1542
+ */
1543
+ onBeforeDragCreate? : ((event: { source: Gantt, taskRecord: TaskModel, date: Date }) => void)|string
1544
+ /**
1545
+ * Fires on the owning Gantt to allow implementer to prevent immediate finalization by setting `data.context.async = true`
1546
+ * in the listener, to show a confirmation popup etc
1547
+ * ...
1548
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-beforeDragCreateFinalize)
1549
+ * @param {object} event Event object
1550
+ * @param {Gantt.view.Gantt} event.source Scheduler instance
1551
+ * @param {HTMLElement} event.proxyElement Proxy element, representing future event
1552
+ * @param {object} event.context
1553
+ * @param {boolean} event.context.async Set true to handle drag create asynchronously (e.g. to wait for user confirmation)
1554
+ * @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
1555
+ */
1556
+ onBeforeDragCreateFinalize? : ((event: { source: Gantt, proxyElement: HTMLElement, context: { async: boolean, finalize: Function } }) => void)|string
1557
+ /**
1558
+ * Fires before an event is removed. Can be triggered by user pressing [DELETE] or [BACKSPACE] or by the
1559
+ * event editor. Return `false` to immediately veto the removal (or a `Promise` yielding `true` or `false`
1560
+ * for async vetoing).
1561
+ * ...
1562
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-beforeEventDelete)
1563
+ * @param {object} event Event object
1564
+ * @param {Scheduler.view.Scheduler,any} event.source The Scheduler instance
1565
+ * @param {Scheduler.model.SchedulerEventModel[]} event.eventRecords The records about to be deleted
1566
+ * @param {object} event.context Additional removal context:
1567
+ * @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.
1568
+ * @param {boolean} event.context.finalize.removeRecords Provide `false` to the function to prevent the removal.
1569
+ */
1570
+ onBeforeEventDelete? : ((event: { source: Scheduler|any, eventRecords: SchedulerEventModel[], context: { finalize: { removeRecords?: boolean } } }) => Promise<boolean>|boolean|void)|string
1571
+ /**
1572
+ * Fires on the owning Scheduler before an event is displayed in an editor.
1573
+ * This may be listened for to allow an application to take over event editing duties. Returning `false`
1574
+ * stops the default editing UI from being shown.
1575
+ * ...
1576
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-beforeEventEdit)
1577
+ * @param {object} event Event object
1578
+ * @param {Scheduler.view.Scheduler} event.source The scheduler
1579
+ * @param {Scheduler.feature.EventEdit} event.eventEdit The eventEdit feature
1580
+ * @param {Scheduler.model.SchedulerEventModel} event.eventRecord The record about to be shown in the event editor.
1581
+ * @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.
1582
+ * @param {HTMLElement} event.eventElement The element which represents the event in the scheduler display.
1583
+ */
1584
+ onBeforeEventEdit? : ((event: { source: Scheduler, eventEdit: EventEdit, eventRecord: SchedulerEventModel, resourceRecord: SchedulerResourceModel, eventElement: HTMLElement }) => Promise<boolean>|boolean|void)|string
1585
+ /**
1586
+ * Fires on the owning Scheduler when the editor for an event is available but before it is populated with
1587
+ * data and shown. Allows manipulating fields etc.
1588
+ * @param {object} event Event object
1589
+ * @param {Scheduler.view.Scheduler} event.source The scheduler
1590
+ * @param {Scheduler.feature.EventEdit} event.eventEdit The eventEdit feature
1591
+ * @param {Scheduler.model.SchedulerEventModel} event.eventRecord The record about to be shown in the event editor.
1592
+ * @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.
1593
+ * @param {HTMLElement} event.eventElement The element which represents the event in the scheduler display.
1594
+ * @param {Core.widget.Popup} event.editor The editor
1595
+ */
1596
+ onBeforeEventEditShow? : ((event: { source: Scheduler, eventEdit: EventEdit, eventRecord: SchedulerEventModel, resourceRecord: SchedulerResourceModel, eventElement: HTMLElement, editor: Popup }) => void)|string
1597
+ /**
1598
+ * Fired on the owning Scheduler before resizing starts. Return `false` to prevent the action.
1599
+ * @param {object} event Event object
1600
+ * @param {Scheduler.view.Scheduler} event.source Scheduler instance
1601
+ * @param {Scheduler.model.SchedulerEventModel} event.eventRecord Event record being resized
1602
+ * @param {Scheduler.model.SchedulerResourceModel} event.resourceRecord Resource record the resize starts within
1603
+ * @param {MouseEvent} event.event Browser event
1604
+ */
1605
+ onBeforeEventResize? : ((event: { source: Scheduler, eventRecord: SchedulerEventModel, resourceRecord: SchedulerResourceModel, event: MouseEvent }) => Promise<boolean>|boolean|void)|string
1606
+ /**
1607
+ * Fired on the owning Scheduler to allow implementer to prevent immediate finalization by returning a promise
1608
+ * in the listener, to show a confirmation popup etc
1609
+ * ...
1610
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-beforeEventResizeFinalize)
1611
+ * @param {object} event Event object
1612
+ * @param {Scheduler.view.Scheduler} event.source Scheduler instance
1613
+ * @param {object} event.context [DEPRECATED] de-nested to outer params object
1614
+ * @param {Scheduler.model.SchedulerEventModel} event.eventRecord Event record being resized
1615
+ * @param {Date} event.startDate New startDate (changed if resizing start side)
1616
+ * @param {Date} event.endDate New endDate (changed if resizing end side)
1617
+ * @param {Date} event.originalStartDate Start date before resize
1618
+ * @param {Date} event.originalEndDate End date before resize
1619
+ * @param {boolean} event.async Set true to handle resize asynchronously (e.g. to wait for user confirmation)
1620
+ * @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
1621
+ * @param {Event} event.event Browser event
1622
+ * @param {EventResizeData[]} event.resizeData Data of all events that are being resized
1623
+ */
1624
+ 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
1625
+ /**
1626
+ * Fires on the owning Scheduler or Gantt widget instance before an event record is saved, return `false` to prevent it.
1627
+ * ...
1628
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-beforeEventSave)
1629
+ * @param {object} event Event object
1630
+ * @param {SchedulerPro.view.SchedulerPro} event.source The Scheduler Pro instance
1631
+ * @param {SchedulerPro.model.EventModel} event.eventRecord The event record about to be saved
1632
+ * @param {SchedulerPro.widget.TaskEditorBase} event.editor The editor widget
1633
+ */
1634
+ onBeforeEventSave? : ((event: { source: SchedulerPro, eventRecord: EventModel, editor: TaskEditorBase }) => Promise<boolean>|boolean|void)|string
1635
+ /**
1636
+ * Fired on the owning Scheduler Pro before resizing starts. Return `false` to prevent the action.
1637
+ * @param {object} event Event object
1638
+ * @param {SchedulerPro.view.SchedulerPro} event.source Scheduler Pro instance
1639
+ * @param {SchedulerPro.model.EventModel} event.eventRecord Segment being resized
1640
+ * @param {SchedulerPro.model.SchedulerProResourceModel} event.resourceRecord Resource record the resize starts within
1641
+ * @param {MouseEvent} event.event Browser event
1642
+ */
1643
+ onBeforeEventSegmentResize? : ((event: { source: SchedulerPro, eventRecord: EventModel, resourceRecord: SchedulerProResourceModel, event: MouseEvent }) => Promise<boolean>|boolean|void)|string
1644
+ /**
1645
+ * Fired on the owning Scheduler Pro to allow implementer to prevent immediate finalization by setting
1646
+ * `data.context.async = true` in the listener, to show a confirmation popup etc
1647
+ * ...
1648
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-beforeEventSegmentResizeFinalize)
1649
+ * @param {object} event Event object
1650
+ * @param {SchedulerPro.view.SchedulerPro} event.source Scheduler Pro instance
1651
+ * @param {object} event.context
1652
+ * @param {boolean} event.context.async Set true to handle resize asynchronously (e.g. to wait for user confirmation)
1653
+ * @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
1654
+ */
1655
+ onBeforeEventSegmentResizeFinalize? : ((event: { source: SchedulerPro, context: { async: boolean, finalize: Function } }) => void)|string
1656
+ /**
1657
+ * Fires on the owning Grid before Excel export starts. Return `false` to cancel the export.
1658
+ * @param {object} event Event object
1659
+ * @param {ExportConfig} event.config Export config
1660
+ * @param {XLSColumn[]} event.columns An array of columns to export
1661
+ * @param {any[][]} event.rows An array of records to export
1662
+ */
1663
+ onBeforeExcelExport? : ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => Promise<boolean>|boolean|void)|string
1664
+ /**
1665
+ * Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
1666
+ * @param {object} event Event object
1667
+ * @param {Grid.util.GridLocation} event.cell Information about the column / record
1668
+ * @param {MouseEvent} event.domEvent The raw DOM event
1669
+ */
1670
+ onBeforeFillHandleDragStart? : ((event: { cell: GridLocation, domEvent: MouseEvent }) => Promise<boolean>|boolean|void)|string
1671
+ /**
1672
+ * 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.
1673
+ * @param {object} event Event object
1674
+ * @param {Grid.view.Grid} event.grid Target grid
1675
+ * @param {CellEditorContext} event.editorContext Editing context
1676
+ */
1677
+ onBeforeFinishCellEdit? : ((event: { grid: Grid, editorContext: CellEditorContext }) => void)|string
1678
+ /**
1679
+ * 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.
1680
+ * ...
1681
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-beforeFinishRowEdit)
1682
+ * @param {object} event Event object
1683
+ * @param {Grid.view.Grid} event.grid Target grid
1684
+ * @param {RowEditorContext} event.editorContext Editing context
1685
+ */
1686
+ onBeforeFinishRowEdit? : ((event: { grid: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string
1687
+ /**
1688
+ * Triggered before a widget is hidden. Return `false` to prevent the action.
1689
+ * @param {object} event Event object
1690
+ * @param {Core.widget.Widget} event.source The widget being hidden.
1691
+ */
1692
+ onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
1693
+ /**
1694
+ * Fires on the owning Gantt before export starts. Return `false` to cancel the export.
1695
+ * @param {object} event Event object
1696
+ * @param {object} event.config Export config
1697
+ */
1698
+ onBeforeMspExport? : ((event: { config: object }) => Promise<boolean>|boolean|void)|string
1699
+ /**
1700
+ * Fires on the owning Scheduler or Gantt widget before pan starts. Return `false` to prevent the operation.
1701
+ * @param {object} event Event object
1702
+ * @param {Event} event.event The native browser DOM event
1703
+ */
1704
+ onBeforePan? : ((event: { event: Event }) => Promise<boolean>|boolean|void)|string
1705
+ /**
1706
+ * Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
1707
+ * @param {object} event Event object
1708
+ * @param {Grid.view.Grid} event.source Owner grid
1709
+ * @param {string} event.clipboardData The clipboardData about to be pasted
1710
+ * @param {Grid.util.GridLocation} event.targetCell The cell from which the paste will be started
1711
+ * @param {string} event.entityName 'cell' to distinguish this event from other beforePaste events
1712
+ * @param {string} event.text The raw text from clipboard
1713
+ */
1714
+ onBeforePaste? : ((event: { source: Grid, clipboardData: string, targetCell: GridLocation, entityName: string, text: string }) => Promise<boolean>|boolean|void)|string
1715
+ /**
1716
+ * Fires on the owning Grid before export started. Return `false` to cancel the export.
1717
+ * @param {object} event Event object
1718
+ * @param {object} event.config Export config
1719
+ */
1720
+ onBeforePdfExport? : ((event: { config: object }) => Promise<boolean>|boolean|void)|string
1721
+ /**
1722
+ * Fired before the [viewPreset](https://bryntum.com/products/gantt/docs/api/Scheduler/view/mixin/TimelineViewPresets#config-viewPreset) is changed.
1723
+ * @param {object} event Event object
1724
+ * @param {Scheduler.view.Scheduler} event.source This Scheduler instance.
1725
+ * @param {Date} event.startDate The new start date of the timeline.
1726
+ * @param {Date} event.endDate The new end date of the timeline.
1727
+ * @param {Scheduler.preset.ViewPreset} event.from The outgoing ViewPreset.
1728
+ * @param {Scheduler.preset.ViewPreset} event.to The ViewPreset being switched to.
1729
+ */
1730
+ onBeforePresetChange? : ((event: { source: Scheduler, startDate: Date, endDate: Date, from: ViewPreset, to: ViewPreset }) => Promise<boolean>|boolean|void)|string
1731
+ /**
1732
+ * Fires on the owning Gantt widget instance before a project is displayed in the editor.
1733
+ * This may be listened to in order to take over the project editing flow. Returning `false`
1734
+ * stops the default editing UI from being shown.
1735
+ * ...
1736
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-beforeProjectEdit)
1737
+ * @param {object} event Event object
1738
+ * @param {Gantt.view.Gantt} event.source The Gantt instance
1739
+ * @param {Gantt.feature.ProjectEdit} event.projectEdit The projectEdit feature
1740
+ * @param {Gantt.model.ProjectModel} event.projectRecord The project about to be shown in the editor.
1741
+ */
1742
+ onBeforeProjectEdit? : ((event: { source: Gantt, projectEdit: ProjectEdit, projectRecord: ProjectModel }) => Promise<boolean>|boolean|void)|string
1743
+ /**
1744
+ * Fires on the owning Gantt widget when the editor for a project is available but
1745
+ * before it is shown. Allows manipulating fields etc.
1746
+ * @param {object} event Event object
1747
+ * @param {Gantt.view.Gantt} event.source The Gantt instance
1748
+ * @param {Gantt.feature.ProjectEdit} event.projectEdit The projectEdit feature
1749
+ * @param {Gantt.model.ProjectModel} event.projectRecord The project about to be shown in the editor.
1750
+ * @param {Gantt.widget.ProjectEditor} event.editor The editor
1751
+ */
1752
+ onBeforeProjectEditShow? : ((event: { source: Gantt, projectEdit: ProjectEdit, projectRecord: ProjectModel, editor: ProjectEditor }) => void)|string
1753
+ /**
1754
+ * Fires on the owning Gantt widget instance before a project is saved, return `false` to prevent it.
1755
+ * ...
1756
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-beforeProjectSave)
1757
+ * @param {object} event Event object
1758
+ * @param {Gantt.view.Gantt} event.source The Gantt instance
1759
+ * @param {Gantt.model.ProjectModel} event.projectRecord The project about to be saved
1760
+ * @param {Gantt.widget.ProjectEditor} event.editor The editor widget
1761
+ */
1762
+ onBeforeProjectSave? : ((event: { source: Gantt, projectRecord: ProjectModel, editor: ProjectEditor }) => Promise<boolean>|boolean|void)|string
1763
+ /**
1764
+ * Fires before a row is rendered.
1765
+ * @param {object} event Event object
1766
+ * @param {Grid.view.Grid} event.source The firing Grid instance.
1767
+ * @param {Grid.row.Row} event.row The row about to be rendered.
1768
+ * @param {Core.data.Model} event.record The record for the row.
1769
+ * @param {number} event.recordIndex The zero-based index of the record.
1770
+ */
1771
+ onBeforeRenderRow? : ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
1772
+ /**
1773
+ * Grid rows are about to be rendered
1774
+ * @param {object} event Event object
1775
+ * @param {Grid.view.Grid} event.source This grid.
1776
+ */
1777
+ onBeforeRenderRows? : ((event: { source: Grid }) => void)|string
1778
+ /**
1779
+ * This event fires before row collapse is started.
1780
+ * ...
1781
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-beforeRowCollapse)
1782
+ * @param {object} event Event object
1783
+ * @param {Core.data.Model} event.record Record
1784
+ */
1785
+ onBeforeRowCollapse? : ((event: { record: Model }) => Promise<boolean>|boolean|void)|string
1786
+ /**
1787
+ * This event fires before row expand is started.
1788
+ * ...
1789
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-beforeRowExpand)
1790
+ * @param {object} event Event object
1791
+ * @param {Core.data.Model} event.record Record
1792
+ */
1793
+ onBeforeRowExpand? : ((event: { record: Model }) => Promise<boolean>|boolean|void)|string
1794
+ /**
1795
+ * Fires before the selection changes. Returning `false` from a listener prevents the change
1796
+ * @param {object} event Event object
1797
+ * @param {string} event.action `'select'`/`'deselect'`
1798
+ * @param {'row','cell'} event.mode `'row'`/`'cell'`
1799
+ * @param {Grid.view.Grid} event.source
1800
+ * @param {Core.data.Model[]} event.deselected The records to be deselected in this operation.
1801
+ * @param {Core.data.Model[]} event.selected The records to be selected in this operation.
1802
+ * @param {Core.data.Model[]} event.selection The records in the current selection, before applying `selected` and `deselected`
1803
+ * @param {Grid.util.GridLocation[]} event.deselectedCells The cells to be deselected in this operation.
1804
+ * @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
1805
+ * @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
1806
+ */
1807
+ 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
1808
+ /**
1809
+ * Fired before this container will load record values into its child fields. This is useful if you
1810
+ * want to modify the UI before data is loaded (e.g. set some input field to be readonly)
1811
+ * @param {object} event Event object
1812
+ * @param {Core.widget.Container} event.source The container
1813
+ * @param {Core.data.Model} event.record The record
1814
+ */
1815
+ onBeforeSetRecord? : ((event: { source: Container, record: Model }) => void)|string
1816
+ /**
1817
+ * Triggered before a widget is shown. Return `false` to prevent the action.
1818
+ * @param {object} event Event object
1819
+ * @param {Core.widget.Widget,any} event.source The widget being shown
1820
+ */
1821
+ onBeforeShow? : ((event: { source: Widget|any }) => Promise<boolean>|boolean|void)|string
1822
+ /**
1823
+ * Fired on the owning Scheduler/Gantt before showing dependency terminals on a task or event. Return `false` to
1824
+ * prevent it
1825
+ * @param {object} event Event object
1826
+ * @param {Scheduler.model.TimeSpan} event.source The hovered task
1827
+ */
1828
+ onBeforeShowTerminals? : ((event: { source: TimeSpan }) => Promise<boolean>|boolean|void)|string
1829
+ /**
1830
+ * Fires on the owning Grid before editing starts, return `false` to prevent editing
1831
+ * @param {object} event Event object
1832
+ * @param {Grid.view.Grid} event.source Owner grid
1833
+ * @param {RowEditorContext} event.editorContext Editing context
1834
+ */
1835
+ onBeforeStartRowEdit? : ((event: { source: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string
1836
+ /**
1837
+ * Fired before state is applied to the source. Allows editing the state object or preventing the operation.
1838
+ * @param {object} event Event object
1839
+ * @param {GridStateInfo} event.state State object config
1840
+ */
1841
+ onBeforeStateApply? : ((event: { state: GridStateInfo }) => Promise<boolean>|boolean|void)|string
1842
+ /**
1843
+ * Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
1844
+ * @param {object} event Event object
1845
+ * @param {GridStateInfo} event.state State object config
1846
+ */
1847
+ onBeforeStateSave? : ((event: { state: GridStateInfo }) => Promise<boolean>|boolean|void)|string
1848
+ /**
1849
+ * Fires when adding a task from the UI to allow data mutation.
1850
+ * @param {object} event Event object
1851
+ * @param {Gantt.view.Gantt} event.source The Gantt instance
1852
+ * @param {Gantt.model.TaskModel} event.taskRecord The task
1853
+ */
1854
+ onBeforeTaskAdd? : ((event: { source: Gantt, taskRecord: TaskModel }) => void)|string
1855
+ /**
1856
+ * Fires on the owning Scheduler or Gantt widget before a task is deleted, return `false` to prevent it.
1857
+ * ...
1858
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-beforeTaskDelete)
1859
+ * @param {object} event Event object
1860
+ * @param {SchedulerPro.view.SchedulerPro} event.source The Scheduler Pro instance.
1861
+ * @param {SchedulerPro.model.EventModel} event.taskRecord The record about to be deleted
1862
+ * @param {SchedulerPro.widget.TaskEditorBase} event.editor The editor widget
1863
+ */
1864
+ onBeforeTaskDelete? : ((event: { source: SchedulerPro, taskRecord: EventModel, editor: TaskEditorBase }) => Promise<boolean>|boolean|void)|string
1865
+ /**
1866
+ * Fires on the owning Gantt before task dragging starts. Return false to prevent the action.
1867
+ * @param {object} event Event object
1868
+ * @param {Gantt.view.Gantt} event.source
1869
+ * @param {Gantt.model.TaskModel} event.taskRecord
1870
+ * @param {Event} event.event The native browser event
1871
+ */
1872
+ onBeforeTaskDrag? : ((event: { source: Gantt, taskRecord: TaskModel, event: Event }) => Promise<boolean>|boolean|void)|string
1873
+ /**
1874
+ * Fires on the owning Gantt to allow implementer to prevent immediate finalization by setting `data.context.async = true`
1875
+ * in the listener, to show a confirmation popup etc
1876
+ * ...
1877
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-beforeTaskDropFinalize)
1878
+ * @param {object} event Event object
1879
+ * @param {Gantt.view.Gantt} event.source Gantt instance
1880
+ * @param {object} event.context
1881
+ * @param {Gantt.model.TaskModel[]} event.context.taskRecords The dragged task records
1882
+ * @param {boolean} event.context.valid Set this to `false` to mark the drop as invalid
1883
+ * @param {boolean} event.context.async Set true to handle dragdrop asynchronously (e.g. to wait for user confirmation)
1884
+ * @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
1885
+ */
1886
+ onBeforeTaskDropFinalize? : ((event: { source: Gantt, context: { taskRecords: TaskModel[], valid: boolean, async: boolean, finalize: Function } }) => void)|string
1887
+ /**
1888
+ * Fires on the owning Scheduler or Gantt widget instance before a task is displayed in the editor.
1889
+ * This may be listened to in order to take over the task editing flow. Returning `false`
1890
+ * stops the default editing UI from being shown.
1891
+ * ...
1892
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-beforeTaskEdit)
1893
+ * @param {object} event Event object
1894
+ * @param {SchedulerPro.view.SchedulerPro} event.source The Scheduler Pro instance
1895
+ * @param {SchedulerPro.feature.SchedulerProTaskEdit} event.taskEdit The taskEdit feature
1896
+ * @param {SchedulerPro.model.EventModel} event.taskRecord The task about to be shown in the editor.
1897
+ * @param {HTMLElement} event.taskElement The element which represents the task
1898
+ */
1899
+ onBeforeTaskEdit? : ((event: { source: SchedulerPro, taskEdit: SchedulerProTaskEdit, taskRecord: EventModel, taskElement: HTMLElement }) => Promise<boolean>|boolean|void)|string
1900
+ /**
1901
+ * Fires on the owning Scheduler or Gantt widget when the editor for an event is available but before it is shown. Allows
1902
+ * manipulating fields etc.
1903
+ * @param {object} event Event object
1904
+ * @param {SchedulerPro.view.SchedulerPro} event.source The SchedulerPro instance
1905
+ * @param {SchedulerPro.feature.SchedulerProTaskEdit} event.taskEdit The taskEdit feature
1906
+ * @param {SchedulerPro.model.EventModel} event.taskRecord The task about to be shown in the editor.
1907
+ * @param {HTMLElement} event.eventElement The element which represents the task
1908
+ * @param {SchedulerPro.widget.TaskEditorBase} event.editor The editor
1909
+ */
1910
+ onBeforeTaskEditShow? : ((event: { source: SchedulerPro, taskEdit: SchedulerProTaskEdit, taskRecord: EventModel, eventElement: HTMLElement, editor: TaskEditorBase }) => void)|string
1911
+ /**
1912
+ * Fires on the owning Gantt before resizing starts. Return `false` to prevent the operation.
1913
+ * @param {object} event Event object
1914
+ * @param {Gantt.model.TaskModel} event.taskRecord
1915
+ * @param {Event} event.event
1916
+ */
1917
+ onBeforeTaskResize? : ((event: { taskRecord: TaskModel, event: Event }) => Promise<boolean>|boolean|void)|string
1918
+ /**
1919
+ * Fires on the owning Gantt to allow implementer to prevent immediate finalization by setting
1920
+ * `data.context.async = true` in the listener, to show a confirmation popup etc.
1921
+ * ...
1922
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-beforeTaskResizeFinalize)
1923
+ * @param {object} event Event object
1924
+ * @param {Gantt.model.TaskModel} event.taskRecord
1925
+ * @param {Gantt.view.Gantt} event.source Gantt instance
1926
+ * @param {object} event.context
1927
+ * @param {Date} event.context.endDate New endDate
1928
+ * @param {Date} event.context.originalEndDate End date before resize
1929
+ * @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`.
1930
+ * @param {Event} event.event Browser event
1931
+ * @param {boolean} event.context.async Set true to handle resize asynchronously (e.g. to wait for user confirmation)
1932
+ * @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
1933
+ */
1934
+ onBeforeTaskResizeFinalize? : ((event: { taskRecord: TaskModel, source: Gantt, context: { endDate: Date, originalEndDate: Date, resizeData: TaskResizeData[], async: boolean, finalize: Function }, event: Event }) => void)|string
1935
+ /**
1936
+ * Fires on the owning Scheduler or Gantt widget instance before a task is saved, return `false` to prevent it.
1937
+ * ...
1938
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-beforeTaskSave)
1939
+ * @param {object} event Event object
1940
+ * @param {SchedulerPro.view.SchedulerPro} event.source The Scheduler Pro instance
1941
+ * @param {SchedulerPro.model.EventModel} event.taskRecord The task about to be saved
1942
+ * @param {SchedulerPro.widget.TaskEditorBase} event.editor The editor widget
1943
+ */
1944
+ onBeforeTaskSave? : ((event: { source: SchedulerPro, taskRecord: EventModel, editor: TaskEditorBase }) => Promise<boolean>|boolean|void)|string
1945
+ /**
1946
+ * Fires on the owning Gantt before segment dragging starts. Return `false` to prevent the action.
1947
+ * @param {object} event Event object
1948
+ * @param {Gantt.view.Gantt} event.source
1949
+ * @param {Gantt.model.TaskModel} event.taskRecord The segment about to be dragged
1950
+ * @param {Event} event.event The native browser event
1951
+ */
1952
+ onBeforeTaskSegmentDrag? : ((event: { source: Gantt, taskRecord: TaskModel, event: Event }) => Promise<boolean>|boolean|void)|string
1953
+ /**
1954
+ * Fires on the owning Gantt to allow implementer to prevent immediate finalization by setting `data.context.async = true`
1955
+ * in the listener, to show a confirmation popup etc
1956
+ * ...
1957
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-beforeTaskSegmentDropFinalize)
1958
+ * @param {object} event Event object
1959
+ * @param {Gantt.view.Gantt} event.source Gantt instance
1960
+ * @param {object} event.context
1961
+ * @param {Gantt.model.TaskModel[]} event.context.taskRecords Dragged segments
1962
+ * @param {boolean} event.context.valid Set this to `false` to mark the drop as invalid
1963
+ * @param {boolean} event.context.async Set true to handle dragdrop asynchronously (e.g. to wait for user confirmation)
1964
+ * @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
1965
+ */
1966
+ onBeforeTaskSegmentDropFinalize? : ((event: { source: Gantt, context: { taskRecords: TaskModel[], valid: boolean, async: boolean, finalize: Function } }) => void)|string
1967
+ /**
1968
+ * Fired on the owning Gantt before resizing starts. Return `false` to prevent the action.
1969
+ * @param {object} event Event object
1970
+ * @param {Gantt.view.Gantt} event.source Gantt instance
1971
+ * @param {Gantt.model.TaskModel} event.taskRecord Segment being resized
1972
+ * @param {Scheduler.model.SchedulerResourceModel} event.resourceRecord Resource record the resize starts within
1973
+ * @param {MouseEvent} event.event Browser event
1974
+ */
1975
+ onBeforeTaskSegmentResize? : ((event: { source: Gantt, taskRecord: TaskModel, resourceRecord: SchedulerResourceModel, event: MouseEvent }) => Promise<boolean>|boolean|void)|string
1976
+ /**
1977
+ * Fired on the owning Gantt to allow implementer to prevent immediate finalization by setting
1978
+ * `data.context.async = true` in the listener, to show a confirmation popup etc.
1979
+ * ...
1980
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-beforeTaskSegmentResizeFinalize)
1981
+ * @param {object} event Event object
1982
+ * @param {Gantt.view.Gantt} event.source Gantt instance
1983
+ * @param {object} event.context
1984
+ * @param {boolean} event.context.async Set true to handle resize asynchronously (e.g. to wait for user confirmation)
1985
+ * @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
1986
+ */
1987
+ onBeforeTaskSegmentResizeFinalize? : ((event: { source: Gantt, context: { async: boolean, finalize: Function } }) => void)|string
1988
+ /**
1989
+ * Fired when a group is going to be expanded or collapsed using the UI.
1990
+ * Returning `false` from a listener prevents the operation
1991
+ * @param {object} event Event object
1992
+ * @param {Core.data.Model} event.groupRecord [DEPRECATED] Use `groupRecords` param instead
1993
+ * @param {Core.data.Model[]} event.groupRecords The group records being toggled
1994
+ * @param {boolean} event.collapse Collapsed (true) or expanded (false)
1995
+ * @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
1996
+ */
1997
+ onBeforeToggleGroup? : ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => Promise<boolean>|boolean|void)|string
1998
+ /**
1999
+ * Fired before a parent node record toggles its collapsed state.
2000
+ * @param {object} event Event object
2001
+ * @param {Grid.view.Grid} event.source The firing Grid instance.
2002
+ * @param {Core.data.Model} event.record The record being toggled.
2003
+ * @param {boolean} event.collapse `true` if the node is being collapsed.
2004
+ */
2005
+ onBeforeToggleNode? : ((event: { source: Grid, record: Model, collapse: boolean }) => void)|string
2006
+ /**
2007
+ * Fires on the owning Grid when editing is cancelled
2008
+ * @param {object} event Event object
2009
+ * @param {Grid.view.Grid} event.source Owner grid
2010
+ * @param {Grid.util.GridLocation} event.editorContext Editing context
2011
+ * @param {Event} event.event Included if the cancellation was triggered by a DOM event
2012
+ */
2013
+ onCancelCellEdit? : ((event: { source: Grid, editorContext: GridLocation, event: Event }) => void)|string
2014
+ /**
2015
+ * Fires when any other event is fired from the object.
2016
+ * ...
2017
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-catchAll)
2018
+ * @param {object} event Event object
2019
+ * @param {{[key: string]: any, type: string}} event.event The Object that contains event details
2020
+ * @param {string} event.event.type The type of the event which is caught by the listener
2021
+ */
2022
+ onCatchAll? : ((event: {[key: string]: any, type: string}) => void)|string
2023
+ /**
2024
+ * Fired when user clicks in a grid cell
2025
+ * @param {object} event Event object
2026
+ * @param {Grid.view.Grid} event.grid The grid instance
2027
+ * @param {Core.data.Model} event.record The record representing the row
2028
+ * @param {Grid.column.Column} event.column The column to which the cell belongs
2029
+ * @param {HTMLElement} event.cellElement The cell HTML element
2030
+ * @param {HTMLElement} event.target The target element
2031
+ * @param {MouseEvent} event.event The native DOM event
2032
+ */
2033
+ onCellClick? : ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string
2034
+ /**
2035
+ * Fired when user activates contextmenu in a grid cell
2036
+ * @param {object} event Event object
2037
+ * @param {Grid.view.Grid} event.grid The grid instance
2038
+ * @param {Core.data.Model} event.record The record representing the row
2039
+ * @param {Grid.column.Column} event.column The column to which the cell belongs
2040
+ * @param {HTMLElement} event.cellElement The cell HTML element
2041
+ * @param {HTMLElement} event.target The target element
2042
+ * @param {MouseEvent} event.event The native DOM event
2043
+ */
2044
+ onCellContextMenu? : ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string
2045
+ /**
2046
+ * Fired when user double clicks a grid cell
2047
+ * @param {object} event Event object
2048
+ * @param {Grid.view.Grid} event.grid The grid instance
2049
+ * @param {Core.data.Model} event.record The record representing the row
2050
+ * @param {Grid.column.Column} event.column The column to which the cell belongs
2051
+ * @param {HTMLElement} event.cellElement The cell HTML element
2052
+ * @param {HTMLElement} event.target The target element
2053
+ * @param {MouseEvent} event.event The native DOM event
2054
+ */
2055
+ onCellDblClick? : ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string
2056
+ /**
2057
+ * This event fires on the owning grid before the context menu is shown for a cell.
2058
+ * 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).
2059
+ * ...
2060
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-cellMenuBeforeShow)
2061
+ * @param {object} event Event object
2062
+ * @param {Grid.view.Grid} event.source The grid
2063
+ * @param {Core.widget.Menu} event.menu The menu
2064
+ * @param {Record<string, MenuItemEntry>} event.items Menu item configs
2065
+ * @param {Grid.column.Column} event.column Column
2066
+ * @param {Core.data.Model} event.record Record
2067
+ */
2068
+ onCellMenuBeforeShow? : ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => Promise<boolean>|boolean|void)|string
2069
+ /**
2070
+ * This event fires on the owning grid when an item is selected in the cell context menu.
2071
+ * @param {object} event Event object
2072
+ * @param {Grid.view.Grid} event.source The grid
2073
+ * @param {Core.widget.Menu} event.menu The menu
2074
+ * @param {Core.widget.MenuItem} event.item Selected menu item
2075
+ * @param {Grid.column.Column} event.column Column
2076
+ * @param {Core.data.Model} event.record Record
2077
+ */
2078
+ onCellMenuItem? : ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column, record: Model }) => void)|string
2079
+ /**
2080
+ * This event fires on the owning grid after the context menu is shown for a cell.
2081
+ * @param {object} event Event object
2082
+ * @param {Grid.view.Grid} event.source The grid
2083
+ * @param {Core.widget.Menu} event.menu The menu
2084
+ * @param {Record<string, MenuItemEntry>} event.items Menu item configs
2085
+ * @param {Grid.column.Column} event.column Column
2086
+ * @param {Core.data.Model} event.record Record
2087
+ */
2088
+ onCellMenuShow? : ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => void)|string
2089
+ /**
2090
+ * This event fires on the owning grid when a check item is toggled in the cell context menu.
2091
+ * @param {object} event Event object
2092
+ * @param {Grid.view.Grid} event.source The grid
2093
+ * @param {Core.widget.Menu} event.menu The menu
2094
+ * @param {Core.widget.MenuItem} event.item Selected menu item
2095
+ * @param {Grid.column.Column} event.column Column
2096
+ * @param {Core.data.Model} event.record Record
2097
+ * @param {boolean} event.checked Checked or not
2098
+ */
2099
+ onCellMenuToggleItem? : ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column, record: Model, checked: boolean }) => void)|string
2100
+ /**
2101
+ * Fired when the mouse enters a cell
2102
+ * @param {object} event Event object
2103
+ * @param {Grid.view.Grid} event.source The grid instance
2104
+ * @param {Core.data.Model} event.record The record representing the hovered cell
2105
+ * @param {Grid.column.Column} event.column The column currently hovered
2106
+ * @param {HTMLElement} event.cellElement The cell HTML element
2107
+ * @param {MouseEvent} event.event The native DOM event
2108
+ */
2109
+ onCellMouseEnter? : ((event: { source: Grid, record: Model, column: Column, cellElement: HTMLElement, event: MouseEvent }) => void)|string
2110
+ /**
2111
+ * Fired when the mouse leaves a cell
2112
+ * @param {object} event Event object
2113
+ * @param {Grid.view.Grid} event.source The grid instance
2114
+ * @param {Core.data.Model} event.record The record representing the cell that the mouse left
2115
+ * @param {Grid.column.Column} event.column The column representing the cell that the mouse left
2116
+ * @param {HTMLElement} event.cellElement The cell HTML element that the mouse left
2117
+ * @param {MouseEvent} event.event The native DOM event
2118
+ */
2119
+ onCellMouseLeave? : ((event: { source: Grid, record: Model, column: Column, cellElement: HTMLElement, event: MouseEvent }) => void)|string
2120
+ /**
2121
+ * Fired when a user moves the mouse out of a grid cell
2122
+ * @param {object} event Event object
2123
+ * @param {Grid.view.Grid} event.grid The grid instance
2124
+ * @param {Core.data.Model} event.record The record representing the row
2125
+ * @param {Grid.column.Column} event.column The column to which the cell belongs
2126
+ * @param {HTMLElement} event.cellElement The cell HTML element
2127
+ * @param {HTMLElement} event.target The target element
2128
+ * @param {MouseEvent} event.event The native DOM event
2129
+ */
2130
+ onCellMouseOut? : ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string
2131
+ /**
2132
+ * Fired when user moves the mouse over a grid cell
2133
+ * @param {object} event Event object
2134
+ * @param {Grid.view.Grid} event.grid The grid instance
2135
+ * @param {Core.data.Model} event.record The record representing the row
2136
+ * @param {Grid.column.Column} event.column The column to which the cell belongs
2137
+ * @param {HTMLElement} event.cellElement The cell HTML element
2138
+ * @param {HTMLElement} event.target The target element
2139
+ * @param {MouseEvent} event.event The native DOM event
2140
+ */
2141
+ onCellMouseOver? : ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string
2142
+ /**
2143
+ * Fires when a Panel is collapsed using the [collapsible](https://bryntum.com/products/gantt/docs/api/Core/widget/Panel#config-collapsible) setting.
2144
+ * @param {object} event Event object
2145
+ * @param {Core.widget.Panel} event.source This Panel.
2146
+ */
2147
+ onCollapse? : ((event: { source: Panel }) => void)|string
2148
+ /**
2149
+ * Fired before a parent node record is collapsed.
2150
+ * @param {object} event Event object
2151
+ * @param {Grid.view.Grid} event.source The firing Grid instance.
2152
+ * @param {Core.data.Model} event.record The record which has been collapsed.
2153
+ */
2154
+ onCollapseNode? : ((event: { source: Grid, record: Model }) => void)|string
2155
+ /**
2156
+ * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
2157
+ * to indicate whether the drop position is valid or not.
2158
+ * @param {object} event Event object
2159
+ * @param {Grid.view.Grid} event.source The grid instance.
2160
+ * @param {Grid.column.Column} event.column The dragged column.
2161
+ * @param {Grid.column.Column} event.insertBefore The column before which the dragged column will be inserted (if not last).
2162
+ * @param {Event} event.event The browser event.
2163
+ * @param {object} event.context
2164
+ * @param {boolean} event.context.valid Set this to `true` or `false` to indicate whether the drop position is valid.
2165
+ */
2166
+ onColumnDrag? : ((event: { source: Grid, column: Column, insertBefore: Column, event: Event, context: { valid: boolean } }) => void)|string
2167
+ /**
2168
+ * This event is fired when a column drag gesture has started.
2169
+ * @param {object} event Event object
2170
+ * @param {Grid.view.Grid} event.source The grid instance.
2171
+ * @param {Grid.column.Column} event.column The dragged column.
2172
+ * @param {Event} event.event The browser event.
2173
+ */
2174
+ onColumnDragStart? : ((event: { source: Grid, column: Column, event: Event }) => void)|string
2175
+ /**
2176
+ * This event is always fired after a column is dropped. The `valid` param is `true` if the operation was not
2177
+ * vetoed and the column was moved in the column store.
2178
+ * @param {object} event Event object
2179
+ * @param {Grid.view.Grid} event.source The grid instance.
2180
+ * @param {Grid.column.Column} event.column The dragged column.
2181
+ * @param {Grid.column.Column} event.insertBefore The column before which the dragged column will be inserted.
2182
+ * @param {Grid.column.Column} event.newParent The new parent column.
2183
+ * @param {boolean} event.valid `true` if the operation was not vetoed.
2184
+ * @param {Event} event.event The browser event.
2185
+ * @param {string} event.region The region where the column was dropped.
2186
+ */
2187
+ onColumnDrop? : ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => Promise<boolean>|boolean|void)|string
2188
+ /**
2189
+ * This event is fired after a resize gesture is completed.
2190
+ * @param {object} event Event object
2191
+ * @param {Grid.view.Grid} event.source The grid instance
2192
+ * @param {Grid.column.Column} event.column The resized column
2193
+ * @param {Event} event.domEvent The browser event
2194
+ */
2195
+ onColumnResize? : ((event: { source: Grid, column: Column, domEvent: Event }) => void)|string
2196
+ /**
2197
+ * This event is fired when a column resize gesture starts.
2198
+ * @param {object} event Event object
2199
+ * @param {Grid.view.Grid} event.source The grid instance
2200
+ * @param {Grid.column.Column} event.column The column
2201
+ * @param {Event} event.domEvent The browser event
2202
+ */
2203
+ onColumnResizeStart? : ((event: { source: Grid, column: Column, domEvent: Event }) => void)|string
2204
+ /**
2205
+ * This event fires on the owning widget when an item is selected in the context menu.
2206
+ * @param {object} event Event object
2207
+ * @param {Core.widget.Widget} event.source The owning widget
2208
+ * @param {Core.widget.Menu} event.menu The menu
2209
+ * @param {Core.widget.MenuItem} event.item Selected menu item
2210
+ */
2211
+ onContextMenuItem? : ((event: { source: Widget, menu: Menu, item: MenuItem }) => void)|string
2212
+ /**
2213
+ * This event fires on the owning widget when a check item is toggled in the context menu.
2214
+ * @param {object} event Event object
2215
+ * @param {Core.widget.Widget} event.source The owning widget
2216
+ * @param {Core.widget.Menu} event.menu The menu
2217
+ * @param {Core.widget.MenuItem} event.item Selected menu item
2218
+ * @param {boolean} event.checked Checked or not
2219
+ */
2220
+ onContextMenuToggleItem? : ((event: { source: Widget, menu: Menu, item: MenuItem, checked: boolean }) => void)|string
2221
+ /**
2222
+ * Fires on the owning Grid after a copy action is performed.
2223
+ * @param {object} event Event object
2224
+ * @param {Grid.view.Grid} event.source Owner grid
2225
+ * @param {Grid.util.GridLocation[]} event.cells The cells about to be copied or cut
2226
+ * @param {string} event.copiedDataString The concatenated data string that was copied or cut
2227
+ * @param {boolean} event.isCut `true` if this was a cut action
2228
+ * @param {string} event.entityName 'cell' to distinguish this event from other copy events
2229
+ */
2230
+ onCopy? : ((event: { source: Grid, cells: GridLocation[], copiedDataString: string, isCut: boolean, entityName: string }) => void)|string
2231
+ /**
2232
+ * Fired when critical paths get highlighted.
2233
+ * ...
2234
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-criticalPathsHighlighted)
2235
+ */
2236
+ onCriticalPathsHighlighted? : (() => void)|string
2237
+ /**
2238
+ * Fired when critical paths get hidden.
2239
+ * ...
2240
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-criticalPathsUnhighlighted)
2241
+ */
2242
+ onCriticalPathsUnhighlighted? : (() => void)|string
2243
+ /**
2244
+ * 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)).
2245
+ * @param {object} event Event object
2246
+ * @param {Scheduler.view.Scheduler} event.source The scheduler
2247
+ * @param {Date} event.date The current date
2248
+ */
2249
+ onCurrentTimelineUpdate? : ((event: { source: Scheduler, date: Date }) => void)|string
2250
+ /**
2251
+ * Fired when data in the store changes.
2252
+ * ...
2253
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-dataChange)
2254
+ * @param {object} event Event object
2255
+ * @param {Grid.view.Grid} event.source Owning grid
2256
+ * @param {Core.data.Store} event.store The originating store
2257
+ * @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'`
2258
+ * @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
2259
+ * @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
2260
+ * @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
2261
+ */
2262
+ onDataChange? : ((event: { source: Grid, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
2263
+ /**
2264
+ * Fired when the range of dates encapsulated by the UI changes. This will be when
2265
+ * moving a view in time by reconfiguring its [timeAxis](https://bryntum.com/products/gantt/docs/api/Scheduler/view/TimelineBase#config-timeAxis). This will happen
2266
+ * when zooming, or changing [viewPreset](https://bryntum.com/products/gantt/docs/api/Scheduler/view/TimelineBase#config-viewPreset).
2267
+ * ...
2268
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-dateRangeChange)
2269
+ * @param {object} event Event object
2270
+ * @param {Scheduler.view.TimelineBase} event.source This Scheduler/Gantt instance.
2271
+ * @param {object} event.old The old date range
2272
+ * @param {Date} event.old.startDate the old start date.
2273
+ * @param {Date} event.old.endDate the old end date.
2274
+ * @param {object} event.new The new date range
2275
+ * @param {Date} event.new.startDate the new start date.
2276
+ * @param {Date} event.new.endDate the new end date.
2277
+ */
2278
+ onDateRangeChange? : ((event: { source: TimelineBase, old: { startDate: Date, endDate: Date }, new: { startDate: Date, endDate: Date } }) => void)|string
2279
+ /**
2280
+ * Fired when dependencies are rendered
2281
+ */
2282
+ onDependenciesDrawn? : (() => void)|string
2283
+ /**
2284
+ * Fires on the owning Scheduler/Gantt when a click is registered on a dependency line.
2285
+ * @param {object} event Event object
2286
+ * @param {Scheduler.view.Scheduler} event.source The scheduler
2287
+ * @param {Scheduler.model.SchedulerDependencyModel} event.dependency
2288
+ * @param {MouseEvent} event.event
2289
+ */
2290
+ onDependencyClick? : ((event: { source: Scheduler, dependency: SchedulerDependencyModel, event: MouseEvent }) => void)|string
2291
+ /**
2292
+ * Fires on the owning Scheduler/Gantt when a context menu event is registered on a dependency line.
2293
+ * @param {object} event Event object
2294
+ * @param {Scheduler.view.Scheduler} event.source The scheduler
2295
+ * @param {Scheduler.model.SchedulerDependencyModel} event.dependency
2296
+ * @param {MouseEvent} event.event
2297
+ */
2298
+ onDependencyContextMenu? : ((event: { source: Scheduler, dependency: SchedulerDependencyModel, event: MouseEvent }) => void)|string
2299
+ /**
2300
+ * Fired on the owning Scheduler/Gantt when a dependency creation drag operation starts
2301
+ * @param {object} event Event object
2302
+ * @param {Scheduler.model.TimeSpan} event.source The source task
2303
+ */
2304
+ onDependencyCreateDragStart? : ((event: { source: TimeSpan }) => void)|string
2305
+ /**
2306
+ * Fired on the owning Scheduler/Gantt when a dependency drag creation operation succeeds
2307
+ * @param {object} event Event object
2308
+ * @param {Scheduler.model.TimeSpan} event.source The source task
2309
+ * @param {Scheduler.model.TimeSpan} event.target The target task
2310
+ * @param {Scheduler.model.DependencyBaseModel} event.dependency The created dependency
2311
+ */
2312
+ onDependencyCreateDrop? : ((event: { source: TimeSpan, target: TimeSpan, dependency: DependencyBaseModel }) => void)|string
2313
+ /**
2314
+ * Fires on the owning Scheduler/Gantt when a double click is registered on a dependency line.
2315
+ * @param {object} event Event object
2316
+ * @param {Scheduler.view.Scheduler} event.source The scheduler
2317
+ * @param {Scheduler.model.SchedulerDependencyModel} event.dependency
2318
+ * @param {MouseEvent} event.event
2319
+ */
2320
+ onDependencyDblClick? : ((event: { source: Scheduler, dependency: SchedulerDependencyModel, event: MouseEvent }) => void)|string
2321
+ /**
2322
+ * Fires on the owning Scheduler/Gantt when the mouse moves out of a dependency line.
2323
+ * @param {object} event Event object
2324
+ * @param {Scheduler.view.Scheduler} event.source The scheduler
2325
+ * @param {Scheduler.model.SchedulerDependencyModel} event.dependency
2326
+ * @param {MouseEvent} event.event
2327
+ */
2328
+ onDependencyMouseOut? : ((event: { source: Scheduler, dependency: SchedulerDependencyModel, event: MouseEvent }) => void)|string
2329
+ /**
2330
+ * Fires on the owning Scheduler/Gantt when the mouse moves over a dependency line.
2331
+ * @param {object} event Event object
2332
+ * @param {Scheduler.view.Scheduler} event.source The scheduler
2333
+ * @param {Scheduler.model.SchedulerDependencyModel} event.dependency
2334
+ * @param {MouseEvent} event.event
2335
+ */
2336
+ onDependencyMouseOver? : ((event: { source: Scheduler, dependency: SchedulerDependencyModel, event: MouseEvent }) => void)|string
2337
+ /**
2338
+ * Fired on the owning Scheduler/Gantt when asynchronous dependency validation completes
2339
+ * @param {object} event Event object
2340
+ * @param {Scheduler.model.TimeSpan} event.source The source task
2341
+ * @param {Scheduler.model.TimeSpan} event.target The target task
2342
+ * @param {number} event.dependencyType The dependency type, see [Type](https://bryntum.com/products/gantt/docs/api/Scheduler/model/DependencyBaseModel#property-Type-static)
2343
+ */
2344
+ onDependencyValidationComplete? : ((event: { source: TimeSpan, target: TimeSpan, dependencyType: number }) => void)|string
2345
+ /**
2346
+ * Fired on the owning Scheduler/Gantt when asynchronous dependency validation starts
2347
+ * @param {object} event Event object
2348
+ * @param {Scheduler.model.TimeSpan} event.source The source task
2349
+ * @param {Scheduler.model.TimeSpan} event.target The target task
2350
+ * @param {number} event.dependencyType The dependency type, see [Type](https://bryntum.com/products/gantt/docs/api/Scheduler/model/DependencyBaseModel#property-Type-static)
2351
+ */
2352
+ onDependencyValidationStart? : ((event: { source: TimeSpan, target: TimeSpan, dependencyType: number }) => void)|string
2353
+ /**
2354
+ * Fires when an object is destroyed.
2355
+ * @param {object} event Event object
2356
+ * @param {Core.Base} event.source The Object that is being destroyed.
2357
+ */
2358
+ onDestroy? : ((event: { source: Base }) => void)|string
2359
+ /**
2360
+ * 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
2361
+ * @param {object} event Event object
2362
+ * @param {Core.widget.Container} event.source The container.
2363
+ * @param {boolean} event.dirty The dirty state of the Container - `true` if there are any fields which have been changed since initial load.
2364
+ */
2365
+ onDirtyStateChange? : ((event: { source: Container, dirty: boolean }) => void)|string
2366
+ /**
2367
+ * Fires on the owning Gantt after the task has been scheduled.
2368
+ * @param {object} event Event object
2369
+ * @param {Gantt.view.Gantt} event.source
2370
+ * @param {Gantt.model.TaskModel} event.taskRecord
2371
+ * @param {MouseEvent} event.event The ending mouseup event.
2372
+ * @param {HTMLElement} event.proxyElement The proxy element showing the drag creation zone.
2373
+ */
2374
+ onDragCreateEnd? : ((event: { source: Gantt, taskRecord: TaskModel, event: MouseEvent, proxyElement: HTMLElement }) => void)|string
2375
+ /**
2376
+ * Fires on the owning Gantt after the drag start has created a proxy element.
2377
+ * @param {object} event Event object
2378
+ * @param {Gantt.view.Gantt} event.source
2379
+ * @param {HTMLElement} event.proxyElement The proxy representing the new event.
2380
+ */
2381
+ onDragCreateStart? : ((event: { source: Gantt, proxyElement: HTMLElement }) => void)|string
2382
+ /**
2383
+ * Fires while drag selecting. UI will update with current range, but the cells will not be selected until
2384
+ * mouse up. This event can be listened for to perform actions while drag selecting.
2385
+ * @param {object} event Event object
2386
+ * @param {Grid.view.Grid} event.source
2387
+ * @param {GridLocationConfig[],Grid.util.GridLocation[]} event.selectedCells The cells that is currently being dragged over
2388
+ * @param {Core.data.Model[]} event.selectedRecords The records that is currently being dragged over
2389
+ */
2390
+ onDragSelecting? : ((event: { source: Grid, selectedCells: GridLocationConfig[]|GridLocation[], selectedRecords: Model[] }) => void)|string
2391
+ /**
2392
+ * Triggered when a widget's [element](https://bryntum.com/products/gantt/docs/api/Core/widget/Widget#property-element) is available.
2393
+ * @param {object} event Event object
2394
+ * @param {HTMLElement} event.element The Widget's element.
2395
+ */
2396
+ onElementCreated? : ((event: { element: HTMLElement }) => void)|string
2397
+ /**
2398
+ * Fired before the editor will load the event record data into its input fields. This is useful if you
2399
+ * want to modify the fields before data is loaded (e.g. set some input field to be readonly)
2400
+ * @param {object} event Event object
2401
+ * @param {Core.widget.Container} event.source The editor widget
2402
+ * @param {Scheduler.model.SchedulerEventModel} event.record The record
2403
+ */
2404
+ onEventEditBeforeSetRecord? : ((event: { source: Container, record: SchedulerEventModel }) => void)|string
2405
+ /**
2406
+ * This event fires on the owning Scheduler before the context menu is shown for an event. Allows manipulation of the items
2407
+ * to show in the same way as in `processItems`. Returning `false` from a listener prevents the menu from
2408
+ * being shown.
2409
+ * @param {object} event Event object
2410
+ * @param {Scheduler.view.Scheduler} event.source
2411
+ * @param {Record<string, MenuItemEntry>} event.items Menu item configs
2412
+ * @param {Scheduler.model.SchedulerEventModel} event.eventRecord Event record for which the menu was triggered
2413
+ * @param {Scheduler.model.SchedulerResourceModel} event.resourceRecord Resource record
2414
+ * @param {Scheduler.model.SchedulerAssignmentModel} event.assignmentRecord Assignment record, if assignments are used
2415
+ * @param {HTMLElement} event.eventElement
2416
+ * @param {MouseEvent} event.event Pointer event which triggered the context menu (if any)
2417
+ */
2418
+ onEventMenuBeforeShow? : ((event: { source: Scheduler, items: Record<string, MenuItemEntry>, eventRecord: SchedulerEventModel, resourceRecord: SchedulerResourceModel, assignmentRecord: SchedulerAssignmentModel, eventElement: HTMLElement, event?: MouseEvent }) => Promise<boolean>|boolean|void)|string
2419
+ /**
2420
+ * This event fires on the owning Scheduler when an item is selected in the context menu.
2421
+ * @param {object} event Event object
2422
+ * @param {Scheduler.view.Scheduler} event.source
2423
+ * @param {Core.widget.MenuItem} event.item
2424
+ * @param {Scheduler.model.SchedulerEventModel} event.eventRecord
2425
+ * @param {Scheduler.model.SchedulerResourceModel} event.resourceRecord
2426
+ * @param {Scheduler.model.SchedulerAssignmentModel} event.assignmentRecord Assignment record, if assignments are used
2427
+ * @param {HTMLElement} event.eventElement
2428
+ */
2429
+ onEventMenuItem? : ((event: { source: Scheduler, item: MenuItem, eventRecord: SchedulerEventModel, resourceRecord: SchedulerResourceModel, assignmentRecord: SchedulerAssignmentModel, eventElement: HTMLElement }) => void)|string
2430
+ /**
2431
+ * This event fires on the owning Scheduler after showing the context menu for an event
2432
+ * @param {object} event Event object
2433
+ * @param {Scheduler.view.Scheduler} event.source
2434
+ * @param {Core.widget.Menu} event.menu The menu
2435
+ * @param {Scheduler.model.SchedulerEventModel} event.eventRecord Event record for which the menu was triggered
2436
+ * @param {Scheduler.model.SchedulerResourceModel} event.resourceRecord Resource record
2437
+ * @param {Scheduler.model.SchedulerAssignmentModel} event.assignmentRecord Assignment record, if assignments are used
2438
+ * @param {HTMLElement} event.eventElement
2439
+ */
2440
+ onEventMenuShow? : ((event: { source: Scheduler, menu: Menu, eventRecord: SchedulerEventModel, resourceRecord: SchedulerResourceModel, assignmentRecord: SchedulerAssignmentModel, eventElement: HTMLElement }) => void)|string
2441
+ /**
2442
+ * Fires on the owning Scheduler on each resize move event
2443
+ * @param {object} event Event object
2444
+ * @param {Scheduler.view.Scheduler} event.source Scheduler instance
2445
+ * @param {Scheduler.model.SchedulerEventModel} event.eventRecord Event record being resized
2446
+ * @param {Date} event.startDate
2447
+ * @param {Date} event.endDate
2448
+ * @param {HTMLElement} event.element
2449
+ * @param {EventResizeData[]} event.resizeData Resize data for selected events
2450
+ */
2451
+ onEventPartialResize? : ((event: { source: Scheduler, eventRecord: SchedulerEventModel, startDate: Date, endDate: Date, element: HTMLElement, resizeData: EventResizeData[] }) => void)|string
2452
+ /**
2453
+ * Fires on the owning Scheduler after the resizing gesture has finished.
2454
+ * @param {object} event Event object
2455
+ * @param {Scheduler.view.Scheduler} event.source Scheduler instance
2456
+ * @param {boolean} event.changed Shows if the record has been changed by the resize action
2457
+ * @param {Scheduler.model.SchedulerEventModel} event.eventRecord Event record being resized
2458
+ * @param {EventResizeData[]} event.resizeData Resize data for selected events
2459
+ */
2460
+ onEventResizeEnd? : ((event: { source: Scheduler, changed: boolean, eventRecord: SchedulerEventModel, resizeData: EventResizeData[] }) => void)|string
2461
+ /**
2462
+ * Fires on the owning Scheduler when event resizing starts
2463
+ * @param {object} event Event object
2464
+ * @param {Scheduler.view.Scheduler} event.source Scheduler instance
2465
+ * @param {Scheduler.model.SchedulerEventModel} event.eventRecord Event record being resized
2466
+ * @param {Scheduler.model.SchedulerResourceModel} event.resourceRecord Resource record the resize starts within
2467
+ * @param {MouseEvent} event.event Browser event
2468
+ * @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`
2469
+ */
2470
+ onEventResizeStart? : ((event: { source: Scheduler, eventRecord: SchedulerEventModel, resourceRecord: SchedulerResourceModel, event: MouseEvent, resizeData: EventResizeData[] }) => void)|string
2471
+ /**
2472
+ * Fires on the owning Scheduler Pro on each segment resize move event
2473
+ * @param {object} event Event object
2474
+ * @param {SchedulerPro.view.SchedulerPro} event.source Scheduler Pro instance
2475
+ * @param {SchedulerPro.model.EventModel} event.eventRecord Segment being resized
2476
+ * @param {Date} event.startDate
2477
+ * @param {Date} event.endDate
2478
+ * @param {HTMLElement} event.element
2479
+ */
2480
+ onEventSegmentPartialResize? : ((event: { source: SchedulerPro, eventRecord: EventModel, startDate: Date, endDate: Date, element: HTMLElement }) => void)|string
2481
+ /**
2482
+ * Fires on the owning Scheduler Pro after the resizing gesture has finished.
2483
+ * @param {object} event Event object
2484
+ * @param {SchedulerPro.view.SchedulerPro} event.source Scheduler Pro instance
2485
+ * @param {boolean} event.changed Shows if the record has been changed by the resize action
2486
+ * @param {SchedulerPro.model.EventModel} event.eventRecord Segment being resized
2487
+ */
2488
+ onEventSegmentResizeEnd? : ((event: { source: SchedulerPro, changed: boolean, eventRecord: EventModel }) => void)|string
2489
+ /**
2490
+ * Fires on the owning Scheduler Pro when segment resizing starts
2491
+ * @param {object} event Event object
2492
+ * @param {SchedulerPro.view.SchedulerPro} event.source Scheduler Pro instance
2493
+ * @param {SchedulerPro.model.EventModel} event.eventRecord Segment being resized
2494
+ * @param {SchedulerPro.model.SchedulerProResourceModel} event.resourceRecord Resource record the resize starts within
2495
+ * @param {MouseEvent} event.event Browser event
2496
+ */
2497
+ onEventSegmentResizeStart? : ((event: { source: SchedulerPro, eventRecord: EventModel, resourceRecord: SchedulerProResourceModel, event: MouseEvent }) => void)|string
2498
+ /**
2499
+ * Fires when a Panel is expanded using the [collapsible](https://bryntum.com/products/gantt/docs/api/Core/widget/Panel#config-collapsible) setting.
2500
+ * @param {object} event Event object
2501
+ * @param {Core.widget.Panel} event.source This Panel.
2502
+ */
2503
+ onExpand? : ((event: { source: Panel }) => void)|string
2504
+ /**
2505
+ * Fired after a parent node record is expanded.
2506
+ * @param {object} event Event object
2507
+ * @param {Grid.view.Grid} event.source The firing Grid instance.
2508
+ * @param {Core.data.Model} event.record The record which has been expanded.
2509
+ */
2510
+ onExpandNode? : ((event: { source: Grid, record: Model }) => void)|string
2511
+ /**
2512
+ * Fired when a file is dropped on the widget element
2513
+ * @param {object} event Event object
2514
+ * @param {Grid.view.Grid} event.source The owning Grid instance
2515
+ * @param {DataTransferItem} event.file The dropped file descriptor
2516
+ * @param {DragEvent} event.domEvent The native DragEvent
2517
+ */
2518
+ onFileDrop? : ((event: { source: Grid, file: DataTransferItem, domEvent: DragEvent }) => void)|string
2519
+ /**
2520
+ * Fired before the FillHandle dragging is finalized and values are applied to cells, return `false` to prevent the
2521
+ * drag operation from applying data changes.
2522
+ * @param {object} event Event object
2523
+ * @param {Grid.util.GridLocation} event.from The from cell
2524
+ * @param {Grid.util.GridLocation} event.to The to cell
2525
+ * @param {MouseEvent} event.domEvent The raw DOM event
2526
+ */
2527
+ onFillHandleBeforeDragFinalize? : ((event: { from: GridLocation, to: GridLocation, domEvent: MouseEvent }) => Promise<boolean>|boolean|void)|string
2528
+ /**
2529
+ * Fired while dragging the FillHandle.
2530
+ * @param {object} event Event object
2531
+ * @param {Grid.util.GridLocation} event.from The from cell
2532
+ * @param {Grid.util.GridLocation} event.to The to cell
2533
+ * @param {MouseEvent} event.domEvent The raw DOM event
2534
+ */
2535
+ onFillHandleDrag? : ((event: { from: GridLocation, to: GridLocation, domEvent: MouseEvent }) => void)|string
2536
+ /**
2537
+ * Fired when a FillHandle drag operation is aborted.
2538
+ */
2539
+ onFillHandleDragAbort? : (() => void)|string
2540
+ /**
2541
+ * Fired after a FillHandle drag operation.
2542
+ * @param {object} event Event object
2543
+ * @param {Grid.util.GridLocation} event.from The from cell
2544
+ * @param {Grid.util.GridLocation} event.to The to cell
2545
+ * @param {MouseEvent} event.domEvent The raw DOM event
2546
+ */
2547
+ onFillHandleDragEnd? : ((event: { from: GridLocation, to: GridLocation, domEvent: MouseEvent }) => void)|string
2548
+ /**
2549
+ * Fired when dragging of the FillHandle starts.
2550
+ * @param {object} event Event object
2551
+ * @param {Grid.util.GridLocation} event.cell Information about the column / record
2552
+ * @param {MouseEvent} event.domEvent The raw DOM event
2553
+ */
2554
+ onFillHandleDragStart? : ((event: { cell: GridLocation, domEvent: MouseEvent }) => Promise<boolean>|boolean|void)|string
2555
+ /**
2556
+ * Fires on the owning Grid when cell editing is finished
2557
+ * @param {object} event Event object
2558
+ * @param {Grid.view.Grid} event.grid Target grid
2559
+ * @param {CellEditorContext} event.editorContext Editing context
2560
+ */
2561
+ onFinishCellEdit? : ((event: { grid: Grid, editorContext: CellEditorContext }) => void)|string
2562
+ /**
2563
+ * 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.
2564
+ * ...
2565
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-finishRowEdit)
2566
+ * @param {object} event Event object
2567
+ * @param {Grid.view.Grid} event.grid Target grid
2568
+ * @param {RowEditorContext} event.editorContext Editing context
2569
+ */
2570
+ onFinishRowEdit? : ((event: { grid: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string
2571
+ /**
2572
+ * Fired when focus enters this Widget.
2573
+ * @param {object} event Event object
2574
+ * @param {Core.widget.Widget} event.source This Widget
2575
+ * @param {HTMLElement} event.fromElement The element which lost focus.
2576
+ * @param {HTMLElement} event.toElement The element which gained focus.
2577
+ * @param {Core.widget.Widget} event.fromWidget The widget which lost focus.
2578
+ * @param {Core.widget.Widget} event.toWidget The widget which gained focus.
2579
+ * @param {boolean} event.backwards `true` if the `toElement` is before the `fromElement` in document order.
2580
+ */
2581
+ onFocusIn? : ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string
2582
+ /**
2583
+ * Fired when focus exits this Widget's ownership tree. This is different from a `blur` event.
2584
+ * focus moving from within this Widget's ownership tree, even if there are floating widgets
2585
+ * will not trigger this event. This is when focus exits this widget completely.
2586
+ * @param {object} event Event object
2587
+ * @param {Core.widget.Widget} event.source This Widget
2588
+ * @param {HTMLElement} event.fromElement The element which lost focus.
2589
+ * @param {HTMLElement} event.toElement The element which gained focus.
2590
+ * @param {Core.widget.Widget} event.fromWidget The widget which lost focus.
2591
+ * @param {Core.widget.Widget} event.toWidget The widget which gained focus.
2592
+ * @param {boolean} event.backwards `true` if the `toElement` is before the `fromElement` in document order.
2593
+ */
2594
+ onFocusOut? : ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string
2595
+ /**
2596
+ * Fired before dragging starts, return false to prevent the drag operation.
2597
+ * @param {object} event Event object
2598
+ * @param {Grid.view.GridBase} event.source
2599
+ * @param {object} event.context
2600
+ * @param {Core.data.Model[]} event.context.records The dragged row records
2601
+ * @param {MouseEvent,TouchEvent} event.event
2602
+ */
2603
+ onGridRowBeforeDragStart? : ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => Promise<boolean>|boolean|void)|string
2604
+ /**
2605
+ * Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
2606
+ * Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
2607
+ * @param {object} event Event object
2608
+ * @param {Grid.view.GridBase} event.source
2609
+ * @param {object} event.context
2610
+ * @param {boolean} event.context.valid Set this to true or false to indicate whether the drop position is valid
2611
+ * @param {Core.data.Model} event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
2612
+ * @param {Core.data.Model} event.context.parent The parent record of the current drop position (only applicable for trees)
2613
+ * @param {Core.data.Model[]} event.context.records The dragged row records
2614
+ * @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
2615
+ * @param {MouseEvent} event.event
2616
+ */
2617
+ onGridRowBeforeDropFinalize? : ((event: { source: GridBase, context: { valid: boolean, insertBefore: Model, parent: Model, records: Model[], oldPositionContext: RecordPositionContext[] }, event: MouseEvent }) => Promise<boolean>|boolean|void)|string
2618
+ /**
2619
+ * Fired while the row is being dragged, in the listener function you have access to `context.insertBefore` a grid /
2620
+ * tree record, and additionally `context.parent` (a TreeNode) for trees. You can signal that the drop position is
2621
+ * valid or invalid by setting `context.valid = false;`
2622
+ * @param {object} event Event object
2623
+ * @param {Grid.view.GridBase} event.source
2624
+ * @param {object} event.context
2625
+ * @param {boolean} event.context.valid Set this to true or false to indicate whether the drop position is valid.
2626
+ * @param {Core.data.Model} event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
2627
+ * @param {Core.data.Model} event.context.parent The parent record of the current drop position (only applicable for trees)
2628
+ * @param {Core.data.Model[]} event.context.records The dragged row records
2629
+ * @param {MouseEvent} event.event
2630
+ */
2631
+ onGridRowDrag? : ((event: { source: GridBase, context: { valid: boolean, insertBefore: Model, parent: Model, records: Model[] }, event: MouseEvent }) => void)|string
2632
+ /**
2633
+ * Fired when a row drag operation is aborted
2634
+ * @param {object} event Event object
2635
+ * @param {Grid.view.GridBase} event.source
2636
+ * @param {object} event.context
2637
+ * @param {Core.data.Model[]} event.context.records The dragged row records
2638
+ * @param {MouseEvent} event.event
2639
+ */
2640
+ onGridRowDragAbort? : ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent }) => void)|string
2641
+ /**
2642
+ * Fired when dragging starts.
2643
+ * @param {object} event Event object
2644
+ * @param {Grid.view.GridBase} event.source
2645
+ * @param {object} event.context
2646
+ * @param {Core.data.Model[]} event.context.records The dragged row records
2647
+ * @param {MouseEvent,TouchEvent} event.event
2648
+ */
2649
+ onGridRowDragStart? : ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => void)|string
2650
+ /**
2651
+ * Fired after the row drop operation has completed, regardless of validity
2652
+ * @param {object} event Event object
2653
+ * @param {Grid.view.GridBase} event.source
2654
+ * @param {object} event.context
2655
+ * @param {boolean} event.context.valid true or false depending on whether the drop position was valid
2656
+ * @param {Core.data.Model} event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
2657
+ * @param {Core.data.Model} event.context.parent The parent record of the current drop position (only applicable for trees)
2658
+ * @param {Core.data.Model[]} event.context.records The dragged row records
2659
+ * @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
2660
+ * @param {MouseEvent} event.event
2661
+ */
2662
+ onGridRowDrop? : ((event: { source: GridBase, context: { valid: boolean, insertBefore: Model, parent: Model, records: Model[], oldPositionContext: RecordPositionContext[] }, event: MouseEvent }) => void)|string
2663
+ /**
2664
+ * Fired when a grid header is clicked on.
2665
+ * ...
2666
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-headerClick)
2667
+ * @param {object} event Event object
2668
+ * @param {Event} event.domEvent The triggering DOM event.
2669
+ * @param {Grid.column.Column} event.column The column clicked on.
2670
+ */
2671
+ onHeaderClick? : ((event: { domEvent: Event, column: Column }) => Promise<boolean>|boolean|void)|string
2672
+ /**
2673
+ * This event fires on the owning Grid before the context menu is shown for a header.
2674
+ * 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).
2675
+ * ...
2676
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-headerMenuBeforeShow)
2677
+ * @param {object} event Event object
2678
+ * @param {Grid.view.Grid} event.source The grid
2679
+ * @param {Core.widget.Menu} event.menu The menu
2680
+ * @param {Record<string, MenuItemEntry>} event.items Menu item configs
2681
+ * @param {Grid.column.Column} event.column Column
2682
+ */
2683
+ onHeaderMenuBeforeShow? : ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => Promise<boolean>|boolean|void)|string
2684
+ /**
2685
+ * This event fires on the owning Grid when an item is selected in the header context menu.
2686
+ * @param {object} event Event object
2687
+ * @param {Grid.view.Grid} event.source The grid
2688
+ * @param {Core.widget.Menu} event.menu The menu
2689
+ * @param {Core.widget.MenuItem} event.item Selected menu item
2690
+ * @param {Grid.column.Column} event.column Column
2691
+ */
2692
+ onHeaderMenuItem? : ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column }) => void)|string
2693
+ /**
2694
+ * This event fires on the owning Grid after the context menu is shown for a header
2695
+ * @param {object} event Event object
2696
+ * @param {Grid.view.Grid} event.source The grid
2697
+ * @param {Core.widget.Menu} event.menu The menu
2698
+ * @param {Record<string, MenuItemEntry>} event.items Menu item configs
2699
+ * @param {Grid.column.Column} event.column Column
2700
+ */
2701
+ onHeaderMenuShow? : ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => void)|string
2702
+ /**
2703
+ * This event fires on the owning Grid when a check item is toggled in the header context menu.
2704
+ * @param {object} event Event object
2705
+ * @param {Grid.view.Grid} event.source The grid
2706
+ * @param {Core.widget.Menu} event.menu The menu
2707
+ * @param {Core.widget.MenuItem} event.item Selected menu item
2708
+ * @param {Grid.column.Column} event.column Column
2709
+ * @param {boolean} event.checked Checked or not
2710
+ */
2711
+ onHeaderMenuToggleItem? : ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column, checked: boolean }) => void)|string
2712
+ /**
2713
+ * Triggered after a widget was hidden
2714
+ * @param {object} event Event object
2715
+ * @param {Core.widget.Widget} event.source The widget
2716
+ */
2717
+ onHide? : ((event: { source: Widget }) => void)|string
2718
+ /**
2719
+ * Fires when row locking is enabled.
2720
+ * @param {object} event Event object
2721
+ * @param {Grid.view.GridBase} event.clone The created clone
2722
+ */
2723
+ onLockRows? : ((event: { clone: GridBase }) => void)|string
2724
+ /**
2725
+ * Mouse moved out from element in grid
2726
+ * @param {object} event Event object
2727
+ * @param {MouseEvent} event.event The native browser event
2728
+ */
2729
+ onMouseOut? : ((event: { event: MouseEvent }) => void)|string
2730
+ /**
2731
+ * Mouse moved in over element in grid
2732
+ * @param {object} event Event object
2733
+ * @param {MouseEvent} event.event The native browser event
2734
+ */
2735
+ onMouseOver? : ((event: { event: MouseEvent }) => void)|string
2736
+ /**
2737
+ * Fires on the owning Gantt when project content is exported
2738
+ * to XML, before the XML is downloaded by the browser.
2739
+ * @param {object} event Event object
2740
+ * @param {object} event.config Export config
2741
+ * @param {string} event.fileContent Exported XML-file content
2742
+ */
2743
+ onMspExport? : ((event: { config: object, fileContent: string }) => void)|string
2744
+ /**
2745
+ * Fired when a user gesture causes the active item to change.
2746
+ * @param {object} event Event object
2747
+ * @param {Event} event.event The browser event which instigated navigation. May be a click or key or focus event.
2748
+ * @param {HTMLElement,null} event.item The newly active item, or `null` if focus moved out.
2749
+ * @param {HTMLElement,null} event.oldItem The previously active item, or `null` if focus is moving in.
2750
+ */
2751
+ onNavigate? : ((event: { event: Event, item: HTMLElement|null, oldItem: HTMLElement|null }) => void)|string
2752
+ /**
2753
+ * Fires when the requested date range cannot fit into any zoom level higher than the current level.
2754
+ * @param {object} event Event object
2755
+ * @param {number} event.currentZoomLevel The current zoom level
2756
+ * @param {Date} event.startDate The requested start date
2757
+ * @param {Date} event.endDate The requested end date
2758
+ */
2759
+ onNoZoomChange? : ((event: { currentZoomLevel: number, startDate: Date, endDate: Date }) => void)|string
2760
+ /**
2761
+ * Triggered when a widget which had been in a non-visible state for any reason
2762
+ * achieves visibility.
2763
+ * ...
2764
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-paint)
2765
+ * @param {object} event Event object
2766
+ * @param {Core.widget.Widget} event.source The widget being painted.
2767
+ * @param {boolean} event.firstPaint `true` if this is the first paint.
2768
+ */
2769
+ onPaint? : ((event: { source: Widget, firstPaint: boolean }) => void)|string
2770
+ /**
2771
+ * Fires on the owning Grid after a paste action is performed.
2772
+ * @param {object} event Event object
2773
+ * @param {Grid.view.Grid} event.source Owner grid
2774
+ * @param {string} event.clipboardData The clipboardData that was pasted
2775
+ * @param {Core.data.Model[]} event.modifiedRecords The records which have been modified due to the paste action
2776
+ * @param {Grid.util.GridLocation} event.targetCell The cell from which the paste will be started
2777
+ * @param {string} event.entityName 'cell' to distinguish this event from other paste events
2778
+ */
2779
+ onPaste? : ((event: { source: Grid, clipboardData: string, modifiedRecords: Model[], targetCell: GridLocation, entityName: string }) => void)|string
2780
+ /**
2781
+ * Fires on the owning Grid when export has finished
2782
+ * @param {object} event Event object
2783
+ * @param {Response} event.response Optional response, if received
2784
+ * @param {Error} event.error Optional error, if exception occurred
2785
+ */
2786
+ onPdfExport? : ((event: { response?: any, error?: Error }) => void)|string
2787
+ /**
2788
+ * Fired on the owning Scheduler or Gantt widget when dragging the percent bar
2789
+ * @param {object} event Event object
2790
+ * @param {Scheduler.view.TimelineBase} event.source SchedulerPro or Gantt instance
2791
+ * @param {Core.data.Model} event.taskRecord The task record
2792
+ * @param {MouseEvent} event.domEvent Browser event
2793
+ */
2794
+ onPercentBarDrag? : ((event: { source: TimelineBase, taskRecord: Model, domEvent: MouseEvent }) => void)|string
2795
+ /**
2796
+ * Fired on the owning Scheduler or Gantt widget if a percent bar drag-drop operation is aborted
2797
+ * @param {object} event Event object
2798
+ * @param {Scheduler.view.TimelineBase} event.source SchedulerPro instance
2799
+ * @param {Core.data.Model} event.taskRecord The task record
2800
+ * @param {MouseEvent} event.domEvent Browser event
2801
+ */
2802
+ onPercentBarDragAbort? : ((event: { source: TimelineBase, taskRecord: Model, domEvent: MouseEvent }) => void)|string
2803
+ /**
2804
+ * Fired on the owning Scheduler or Gantt widget when percent bar dragging starts
2805
+ * @param {object} event Event object
2806
+ * @param {Scheduler.view.TimelineBase} event.source SchedulerPro or Gantt instance
2807
+ * @param {Core.data.Model} event.taskRecord The task record
2808
+ * @param {MouseEvent} event.domEvent Browser event
2809
+ */
2810
+ onPercentBarDragStart? : ((event: { source: TimelineBase, taskRecord: Model, domEvent: MouseEvent }) => void)|string
2811
+ /**
2812
+ * Fired on the owning Scheduler or Gantt widget when dropping the percent bar
2813
+ * @param {object} event Event object
2814
+ * @param {Scheduler.view.TimelineBase} event.source SchedulerPro or Gantt instance
2815
+ * @param {Core.data.Model} event.taskRecord The task record
2816
+ * @param {MouseEvent} event.domEvent Browser event
2817
+ */
2818
+ onPercentBarDrop? : ((event: { source: TimelineBase, taskRecord: Model, domEvent: MouseEvent }) => void)|string
2819
+ /**
2820
+ * Fired after the [viewPreset](https://bryntum.com/products/gantt/docs/api/Scheduler/view/mixin/TimelineViewPresets#config-viewPreset) has changed.
2821
+ * @param {object} event Event object
2822
+ * @param {Scheduler.view.Scheduler} event.source This Scheduler instance.
2823
+ * @param {Date} event.startDate The new start date of the timeline.
2824
+ * @param {Date} event.centerDate The new center date of the timeline.
2825
+ * @param {Date} event.endDate The new end date of the timeline.
2826
+ * @param {Scheduler.preset.ViewPreset} event.from The outgoing ViewPreset.
2827
+ * @param {Scheduler.preset.ViewPreset} event.to The ViewPreset being switched to.
2828
+ */
2829
+ onPresetChange? : ((event: { source: Scheduler, startDate: Date, centerDate: Date, endDate: Date, from: ViewPreset, to: ViewPreset }) => Promise<boolean>|boolean|void)|string
2830
+ /**
2831
+ * Fires on the owning Gantt widget when the editor for a project is canceled.
2832
+ * @param {object} event Event object
2833
+ * @param {Gantt.view.Gantt} event.source The Gantt instance
2834
+ * @param {Gantt.model.ProjectModel} event.projectRecord The edited project
2835
+ * @param {Gantt.widget.ProjectEditor} event.editor The editor
2836
+ */
2837
+ onProjectEditCanceled? : ((event: { source: Gantt, projectRecord: ProjectModel, editor: ProjectEditor }) => void)|string
2838
+ /**
2839
+ * Fired when a Widget's read only state is toggled
2840
+ * @param {object} event Event object
2841
+ * @param {boolean} event.readOnly Read only or not
2842
+ */
2843
+ onReadOnly? : ((event: { readOnly: boolean }) => void)|string
2844
+ /**
2845
+ * This event is fired after a widget's elements have been synchronized due to a direct or indirect call
2846
+ * 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.
2847
+ */
2848
+ onRecompose? : (() => void)|string
2849
+ /**
2850
+ * Task is released, no longer in view/removed. A good spot for cleaning custom things added in a `renderTask`
2851
+ * listener up, if needed.
2852
+ * @param {object} event Event object
2853
+ * @param {Gantt.view.Gantt} event.source The Gantt instance
2854
+ * @param {object} event.renderData Task render data
2855
+ * @param {Gantt.model.TaskModel} event.taskRecord Rendered task
2856
+ * @param {HTMLElement} event.element Task element
2857
+ */
2858
+ onReleaseTask? : ((event: { source: Gantt, renderData: object, taskRecord: TaskModel, element: HTMLElement }) => void)|string
2859
+ /**
2860
+ * Fires after a row is rendered.
2861
+ * @param {object} event Event object
2862
+ * @param {Grid.view.Grid} event.source The firing Grid instance.
2863
+ * @param {Grid.row.Row} event.row The row that has been rendered.
2864
+ * @param {Core.data.Model} event.record The record for the row.
2865
+ * @param {number} event.recordIndex The zero-based index of the record.
2866
+ */
2867
+ onRenderRow? : ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
2868
+ /**
2869
+ * Grid rows have been rendered
2870
+ * @param {object} event Event object
2871
+ * @param {Grid.view.Grid} event.source This grid.
2872
+ */
2873
+ onRenderRows? : ((event: { source: Grid }) => void)|string
2874
+ /**
2875
+ * Task is rendered, its element is available in DOM.
2876
+ * @param {object} event Event object
2877
+ * @param {Gantt.view.Gantt} event.source The Gantt instance
2878
+ * @param {object} event.renderData Task render data
2879
+ * @param {Gantt.model.TaskModel} event.taskRecord Rendered task
2880
+ * @param {HTMLElement} event.element Task element
2881
+ */
2882
+ onRenderTask? : ((event: { source: Gantt, renderData: object, taskRecord: TaskModel, element: HTMLElement }) => void)|string
2883
+ /**
2884
+ * 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`*.
2885
+ * @param {object} event Event object
2886
+ * @param {Core.widget.Widget} event.source This Widget
2887
+ * @param {number} event.width The new width
2888
+ * @param {number} event.height The new height
2889
+ * @param {number} event.oldWidth The old width
2890
+ * @param {number} event.oldHeight The old height
2891
+ */
2892
+ onResize? : ((event: { source: Widget, width: number, height: number, oldWidth: number, oldHeight: number }) => void)|string
2893
+ /**
2894
+ * Triggered when clicking a resource avatar or chip in the cells of the [ResourceAssignmentColumn](https://bryntum.com/products/gantt/docs/api/Gantt/column/ResourceAssignmentColumn).
2895
+ * @param {object} event Event object
2896
+ * @param {Gantt.view.Gantt} event.source This Gantt
2897
+ * @param {Gantt.model.TaskModel} event.taskRecord Task record
2898
+ * @param {Gantt.model.ResourceModel} event.resourceRecord Resource record
2899
+ * @param {Event} event.event Browser event
2900
+ */
2901
+ onResourceAssignmentClick? : ((event: { source: Gantt, taskRecord: TaskModel, resourceRecord: ResourceModel, event: Event }) => void)|string
2902
+ /**
2903
+ * Grid resize lead to a new responsive level being applied
2904
+ * @param {object} event Event object
2905
+ * @param {Grid.view.Grid} event.grid Grid that was resized
2906
+ * @param {string} event.level New responsive level (small, large, etc)
2907
+ * @param {number} event.width New width in px
2908
+ * @param {string} event.oldLevel Old responsive level
2909
+ * @param {number} event.oldWidth Old width in px
2910
+ */
2911
+ onResponsive? : ((event: { grid: Grid, level: string, width: number, oldLevel: string, oldWidth: number }) => void)|string
2912
+ /**
2913
+ * This event fires when a row has finished collapsing.
2914
+ * @param {object} event Event object
2915
+ * @param {Core.data.Model} event.record Record
2916
+ */
2917
+ onRowCollapse? : ((event: { record: Model }) => void)|string
2918
+ /**
2919
+ * This event fires when a row expand has finished expanding.
2920
+ * ...
2921
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-rowExpand)
2922
+ * @param {object} event Event object
2923
+ * @param {Core.data.Model} event.record Record
2924
+ * @param {object} event.expandedElements An object with the Grid region name as property and the expanded body element as value
2925
+ * @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.
2926
+ * @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
2927
+ */
2928
+ onRowExpand? : ((event: { record: Model, expandedElements: object, widget: Widget, widgets: object }) => void)|string
2929
+ /**
2930
+ * Fired when the mouse enters a row
2931
+ * @param {object} event Event object
2932
+ * @param {Grid.view.Grid} event.source The grid instance
2933
+ * @param {Core.data.Model} event.record The record representing the hovered row
2934
+ * @param {Grid.column.Column} event.column The column currently hovered
2935
+ * @param {HTMLElement} event.cellElement The cell HTML element
2936
+ * @param {MouseEvent} event.event The native DOM event
2937
+ */
2938
+ onRowMouseEnter? : ((event: { source: Grid, record: Model, column: Column, cellElement: HTMLElement, event: MouseEvent }) => void)|string
2939
+ /**
2940
+ * Fired when the mouse leaves a row
2941
+ * @param {object} event Event object
2942
+ * @param {Grid.view.Grid} event.source The grid instance
2943
+ * @param {Core.data.Model} event.record The record representing the row that the mouse left
2944
+ * @param {HTMLElement} event.cellElement The cell HTML element that the mouse left
2945
+ * @param {MouseEvent} event.event The native DOM event
2946
+ */
2947
+ onRowMouseLeave? : ((event: { source: Grid, record: Model, cellElement: HTMLElement, event: MouseEvent }) => void)|string
2948
+ /**
2949
+ * This event fires on the owning Scheduler or Gantt widget before the context menu is shown for the schedule.
2950
+ * Allows manipulation of the items to show in the same way as in `processItems`. Returning `false` from a listener
2951
+ * prevents the menu from being shown.
2952
+ * @param {object} event Event object
2953
+ * @param {Scheduler.view.Scheduler} event.source
2954
+ * @param {Record<string, MenuItemEntry>} event.items Menu item configs
2955
+ * @param {Scheduler.model.SchedulerResourceModel} event.resourceRecord Resource record
2956
+ * @param {Date} event.date Clicked date, rounded according to viewPreset's settings
2957
+ * @param {Scheduler.model.SchedulerAssignmentModel} event.assignmentRecord Assignment record, if assignments are used
2958
+ * @param {HTMLElement} event.eventElement
2959
+ */
2960
+ onScheduleMenuBeforeShow? : ((event: { source: Scheduler, items: Record<string, MenuItemEntry>, resourceRecord: SchedulerResourceModel, date: Date, assignmentRecord: SchedulerAssignmentModel, eventElement: HTMLElement }) => Promise<boolean>|boolean|void)|string
2961
+ /**
2962
+ * This event fires on the owning Scheduler or Gantt widget when an item is selected in the context menu.
2963
+ * @param {object} event Event object
2964
+ * @param {Scheduler.view.Scheduler} event.source
2965
+ * @param {Core.widget.MenuItem} event.item
2966
+ * @param {Scheduler.model.SchedulerResourceModel} event.resourceRecord
2967
+ * @param {Date} event.date Clicked date, rounded according to viewPreset's settings
2968
+ * @param {HTMLElement} event.element
2969
+ */
2970
+ onScheduleMenuItem? : ((event: { source: Scheduler, item: MenuItem, resourceRecord: SchedulerResourceModel, date: Date, element: HTMLElement }) => void)|string
2971
+ /**
2972
+ * This event fires on the owning Scheduler or Gantt widget after showing the context menu for the schedule.
2973
+ * @param {object} event Event object
2974
+ * @param {Scheduler.view.Scheduler} event.source
2975
+ * @param {Record<string, MenuItemEntry>} event.items Menu item configs
2976
+ * @param {Core.widget.Menu} event.menu The menu
2977
+ * @param {Scheduler.model.SchedulerResourceModel} event.resourceRecord
2978
+ * @param {Date} event.date Clicked date, rounded according to viewPreset's settings
2979
+ * @param {HTMLElement} event.targetElement
2980
+ */
2981
+ onScheduleMenuShow? : ((event: { source: Scheduler, items: Record<string, MenuItemEntry>, menu: Menu, resourceRecord: SchedulerResourceModel, date: Date, targetElement: HTMLElement }) => void)|string
2982
+ /**
2983
+ * Grid has scrolled vertically
2984
+ * @param {object} event Event object
2985
+ * @param {Grid.view.Grid} event.source The firing Grid instance.
2986
+ * @param {number} event.scrollTop The vertical scroll position.
2987
+ */
2988
+ onScroll? : ((event: { source: Grid, scrollTop: number }) => void)|string
2989
+ /**
2990
+ * Fires on owner when the scroll button is clicked, return `false` to prevent default scroll behavior
2991
+ * @param {object} event Event object
2992
+ * @param {Event} event.domEvent DOM event
2993
+ * @param {Gantt.model.TaskModel} event.taskRecord The task record
2994
+ */
2995
+ onScrollButtonClick? : ((event: { domEvent: Event, taskRecord: TaskModel }) => Promise<boolean>|boolean|void)|string
2996
+ /**
2997
+ * The selection has been changed.
2998
+ * @param {object} event Event object
2999
+ * @param {'select','deselect'} event.action `'select'`/`'deselect'`
3000
+ * @param {'row','cell'} event.mode `'row'`/`'cell'`
3001
+ * @param {Grid.view.Grid} event.source
3002
+ * @param {Core.data.Model[]} event.deselected The records deselected in this operation.
3003
+ * @param {Core.data.Model[]} event.selected The records selected in this operation.
3004
+ * @param {Core.data.Model[]} event.selection The records in the new selection.
3005
+ * @param {Grid.util.GridLocation[]} event.deselectedCells The cells deselected in this operation.
3006
+ * @param {Grid.util.GridLocation[]} event.selectedCells The cells selected in this operation.
3007
+ * @param {Grid.util.GridLocation[]} event.cellSelection The cells in the new selection.
3008
+ */
3009
+ onSelectionChange? : ((event: { action: 'select'|'deselect', mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => void)|string
3010
+ /**
3011
+ * The selectionMode configuration has been changed.
3012
+ * @param {object} event Event object
3013
+ * @param {object} event.selectionMode The new [selectionMode](https://bryntum.com/products/gantt/docs/api/Grid/view/mixin/GridSelection#config-selectionMode)
3014
+ */
3015
+ onSelectionModeChange? : ((event: { selectionMode: object }) => void)|string
3016
+ /**
3017
+ * Triggered after a widget is shown.
3018
+ * @param {object} event Event object
3019
+ * @param {Core.widget.Widget} event.source The widget
3020
+ */
3021
+ onShow? : ((event: { source: Widget }) => void)|string
3022
+ /**
3023
+ * Fires when splitting the Grid.
3024
+ * @param {object} event Event object
3025
+ * @param {Grid.view.GridBase[]} event.subViews The sub views created by the split
3026
+ * @param {object} event.options The options passed to the split call
3027
+ * @param {'horizontal','vertical','both'} event.options.direction The direction of the split
3028
+ * @param {Grid.column.Column} event.options.atColumn The column to split at
3029
+ * @param {Core.data.Model} event.options.atRecord The record to split at
3030
+ */
3031
+ onSplit? : ((event: { subViews: GridBase[], options: { direction: 'horizontal'|'vertical'|'both', atColumn: Column, atRecord: Model } }) => void)|string
3032
+ /**
3033
+ * Fired by the Grid when the collapse icon is clicked. Return `false` to prevent the default collapse action,
3034
+ * if you want to implement your own behavior.
3035
+ * @param {object} event Event object
3036
+ * @param {Grid.view.Grid} event.source The Grid instance.
3037
+ * @param {Grid.view.SubGrid} event.subGrid The subgrid
3038
+ * @param {Event} event.domEvent The native DOM event
3039
+ */
3040
+ onSplitterCollapseClick? : ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => Promise<boolean>|boolean|void)|string
3041
+ /**
3042
+ * Fired by the Grid after a sub-grid has been resized using the splitter
3043
+ * @param {object} event Event object
3044
+ * @param {Grid.view.Grid} event.source The Grid instance.
3045
+ * @param {Grid.view.SubGrid} event.subGrid The resized subgrid
3046
+ * @param {Event} event.domEvent The native DOM event
3047
+ */
3048
+ onSplitterDragEnd? : ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => void)|string
3049
+ /**
3050
+ * Fired by the Grid when a sub-grid resize gesture starts
3051
+ * @param {object} event Event object
3052
+ * @param {Grid.view.Grid} event.source The Grid instance.
3053
+ * @param {Grid.view.SubGrid} event.subGrid The subgrid about to be resized
3054
+ * @param {Event} event.domEvent The native DOM event
3055
+ */
3056
+ onSplitterDragStart? : ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => void)|string
3057
+ /**
3058
+ * Fired by the Grid when the expand icon is clicked. Return `false` to prevent the default expand action,
3059
+ * if you want to implement your own behavior.
3060
+ * @param {object} event Event object
3061
+ * @param {Grid.view.Grid} event.source The Grid instance.
3062
+ * @param {Grid.view.SubGrid} event.subGrid The subgrid
3063
+ * @param {Event} event.domEvent The native DOM event
3064
+ */
3065
+ onSplitterExpandClick? : ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => Promise<boolean>|boolean|void)|string
3066
+ /**
3067
+ * Fires on the owning Grid when editing starts
3068
+ * @param {object} event Event object
3069
+ * @param {Grid.view.Grid} event.source Owner grid
3070
+ * @param {CellEditorContext} event.editorContext Editing context
3071
+ */
3072
+ onStartCellEdit? : ((event: { source: Grid, editorContext: CellEditorContext }) => void)|string
3073
+ /**
3074
+ * Fires on the owning Grid when editing starts
3075
+ * @param {object} event Event object
3076
+ * @param {Grid.view.Grid} event.source Owner grid
3077
+ * @param {RowEditorContext} event.editorContext Editing context
3078
+ */
3079
+ onStartRowEdit? : ((event: { source: Grid, editorContext: RowEditorContext }) => void)|string
3080
+ /**
3081
+ * Fires after a sub grid is collapsed.
3082
+ * @param {object} event Event object
3083
+ * @param {Grid.view.Grid} event.source The firing Grid instance
3084
+ * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
3085
+ */
3086
+ onSubGridCollapse? : ((event: { source: Grid, subGrid: SubGrid }) => void)|string
3087
+ /**
3088
+ * Fires after a sub grid is expanded.
3089
+ * @param {object} event Event object
3090
+ * @param {Grid.view.Grid} event.source The firing Grid instance
3091
+ * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
3092
+ */
3093
+ onSubGridExpand? : ((event: { source: Grid, subGrid: SubGrid }) => void)|string
3094
+ /**
3095
+ * Triggered after a click on a task bar.
3096
+ * @param {object} event Event object
3097
+ * @param {Gantt.view.Gantt} event.source The Gantt instance
3098
+ * @param {Gantt.model.TaskModel} event.taskRecord The Task record
3099
+ * @param {MouseEvent} event.event The native browser event
3100
+ */
3101
+ onTaskClick? : ((event: { source: Gantt, taskRecord: TaskModel, event: MouseEvent }) => void)|string
3102
+ /**
3103
+ * Triggered after a rightclick (or long press on a touch device) on a task.
3104
+ * @param {object} event Event object
3105
+ * @param {Gantt.view.Gantt} event.source The Gantt instance
3106
+ * @param {Gantt.model.TaskModel} event.taskRecord The Task record
3107
+ * @param {MouseEvent} event.event The native browser event
3108
+ */
3109
+ onTaskContextMenu? : ((event: { source: Gantt, taskRecord: TaskModel, event: MouseEvent }) => void)|string
3110
+ /**
3111
+ * Triggered after a doubleclick on a task.
3112
+ * @param {object} event Event object
3113
+ * @param {Gantt.view.Gantt} event.source The Gantt instance
3114
+ * @param {Gantt.model.TaskModel} event.taskRecord The Task record
3115
+ * @param {MouseEvent} event.event The native browser event
3116
+ */
3117
+ onTaskDblClick? : ((event: { source: Gantt, taskRecord: TaskModel, event: MouseEvent }) => void)|string
3118
+ /**
3119
+ * Fires on the owning Gantt while a task is being dragged
3120
+ * @param {object} event Event object
3121
+ * @param {Gantt.view.Gantt} event.source
3122
+ * @param {Gantt.model.TaskModel[]} event.taskRecords
3123
+ * @param {Date} event.startDate
3124
+ * @param {Date} event.endDate
3125
+ * @param {object} event.dragData
3126
+ * @param {boolean} event.changed `true` if startDate has changed.
3127
+ */
3128
+ onTaskDrag? : ((event: { source: Gantt, taskRecords: TaskModel[], startDate: Date, endDate: Date, dragData: object, changed: boolean }) => void)|string
3129
+ /**
3130
+ * Fires on the owning Gantt when task dragging starts
3131
+ * @param {object} event Event object
3132
+ * @param {Gantt.view.Gantt} event.source
3133
+ * @param {Gantt.model.TaskModel[]} event.taskRecords
3134
+ */
3135
+ onTaskDragStart? : ((event: { source: Gantt, taskRecords: TaskModel[] }) => void)|string
3136
+ /**
3137
+ * Fires on the owning Gantt after a valid task drop
3138
+ * @param {object} event Event object
3139
+ * @param {Gantt.view.Gantt} event.source
3140
+ * @param {Gantt.model.TaskModel[]} event.taskRecords
3141
+ * @param {boolean} event.isCopy
3142
+ */
3143
+ onTaskDrop? : ((event: { source: Gantt, taskRecords: TaskModel[], isCopy: boolean }) => void)|string
3144
+ /**
3145
+ * Fires on the owning Scheduler or Gantt widget when the editor for an event is canceled.
3146
+ * @param {object} event Event object
3147
+ * @param {SchedulerPro.view.SchedulerPro} event.source The Scheduler Pro instance
3148
+ * @param {SchedulerPro.model.EventModel} event.taskRecord the task about the shown in the editor
3149
+ * @param {SchedulerPro.widget.TaskEditorBase} event.editor The editor
3150
+ */
3151
+ onTaskEditCanceled? : ((event: { source: SchedulerPro, taskRecord: EventModel, editor: TaskEditorBase }) => void)|string
3152
+ /**
3153
+ * Triggered when a keydown event is observed if there are selected tasks.
3154
+ * @param {object} event Event object
3155
+ * @param {Gantt.view.Gantt} event.source This Gantt
3156
+ * @param {Gantt.model.TaskModel} event.taskRecord Task record
3157
+ * @param {KeyboardEvent} event.event Browser event
3158
+ */
3159
+ onTaskKeyDown? : ((event: { source: Gantt, taskRecord: TaskModel, event: KeyboardEvent }) => void)|string
3160
+ /**
3161
+ * Triggered when a keyup event is observed if there are selected tasks.
3162
+ * @param {object} event Event object
3163
+ * @param {Gantt.view.Gantt} event.source This Gantt
3164
+ * @param {Gantt.model.TaskModel} event.taskRecord Task record
3165
+ * @param {KeyboardEvent} event.event Browser event
3166
+ */
3167
+ onTaskKeyUp? : ((event: { source: Gantt, taskRecord: TaskModel, event: KeyboardEvent }) => void)|string
3168
+ /**
3169
+ * This event fires on the owning Gantt before the context menu is shown for a task. Allows manipulation of the items
3170
+ * to show in the same way as in `processItems`. Returning false from a listener prevents the menu from
3171
+ * being shown.
3172
+ * @param {object} event Event object
3173
+ * @param {Gantt.view.Gantt} event.source
3174
+ * @param {MenuItemEntry[]} event.items Menu item configs
3175
+ * @param {Gantt.model.TaskModel} event.taskRecord Event record for which the menu was triggered
3176
+ * @param {HTMLElement} event.taskElement
3177
+ */
3178
+ onTaskMenuBeforeShow? : ((event: { source: Gantt, items: MenuItemEntry[], taskRecord: TaskModel, taskElement: HTMLElement }) => Promise<boolean>|boolean|void)|string
3179
+ /**
3180
+ * This event fires on the owning Gantt when an item is selected in the context menu.
3181
+ * @param {object} event Event object
3182
+ * @param {Gantt.view.Gantt} event.source
3183
+ * @param {Core.widget.MenuItem} event.item
3184
+ * @param {Gantt.model.TaskModel} event.taskRecord
3185
+ * @param {HTMLElement} event.taskElement
3186
+ */
3187
+ onTaskMenuItem? : ((event: { source: Gantt, item: MenuItem, taskRecord: TaskModel, taskElement: HTMLElement }) => void)|string
3188
+ /**
3189
+ * This event fires on the owning Gantt after showing the context menu for an event
3190
+ * @param {object} event Event object
3191
+ * @param {Gantt.view.Gantt} event.source
3192
+ * @param {Core.widget.Menu} event.menu The menu
3193
+ * @param {Gantt.model.TaskModel} event.taskRecord Event record for which the menu was triggered
3194
+ * @param {HTMLElement} event.taskElement
3195
+ */
3196
+ onTaskMenuShow? : ((event: { source: Gantt, menu: Menu, taskRecord: TaskModel, taskElement: HTMLElement }) => void)|string
3197
+ /**
3198
+ * Triggered after a mousedown on a task bar.
3199
+ * @param {object} event Event object
3200
+ * @param {Gantt.view.Gantt} event.source The Gantt instance
3201
+ * @param {Gantt.model.TaskModel} event.taskRecord The Task record
3202
+ * @param {MouseEvent} event.event The native browser event
3203
+ */
3204
+ onTaskMouseDown? : ((event: { source: Gantt, taskRecord: TaskModel, event: MouseEvent }) => void)|string
3205
+ /**
3206
+ * Triggered for mouseout from a task.
3207
+ * @param {object} event Event object
3208
+ * @param {Gantt.view.Gantt} event.source The Gantt instance
3209
+ * @param {Gantt.model.TaskModel} event.taskRecord The Task record
3210
+ * @param {MouseEvent} event.event The native browser event
3211
+ */
3212
+ onTaskMouseOut? : ((event: { source: Gantt, taskRecord: TaskModel, event: MouseEvent }) => void)|string
3213
+ /**
3214
+ * Triggered after a mouseover on a task.
3215
+ * @param {object} event Event object
3216
+ * @param {Gantt.view.Gantt} event.source The Gantt instance
3217
+ * @param {Gantt.model.TaskModel} event.taskRecord The Task record
3218
+ * @param {MouseEvent} event.event The native browser event
3219
+ */
3220
+ onTaskMouseOver? : ((event: { source: Gantt, taskRecord: TaskModel, event: MouseEvent }) => void)|string
3221
+ /**
3222
+ * Triggered after a mouseup on a task bar.
3223
+ * @param {object} event Event object
3224
+ * @param {Gantt.view.Gantt} event.source The Gantt instance
3225
+ * @param {Gantt.model.TaskModel} event.taskRecord The Task record
3226
+ * @param {MouseEvent} event.event The native browser event
3227
+ */
3228
+ onTaskMouseUp? : ((event: { source: Gantt, taskRecord: TaskModel, event: MouseEvent }) => void)|string
3229
+ /**
3230
+ * Triggered when clicking a nonworking time element
3231
+ * @param {object} event Event object
3232
+ * @param {Gantt.view.Gantt} event.source The Gantt chart instance
3233
+ * @param {Gantt.model.TaskModel} event.taskRecord Task record
3234
+ * @param {object} event.interval The raw data describing the nonworking time interval
3235
+ * @param {string} event.interval.name The interval name (if any)
3236
+ * @param {Date} event.interval.startDate The interval start date
3237
+ * @param {Date} event.interval.endDate The interval end date
3238
+ * @param {MouseEvent} event.domEvent Browser event
3239
+ */
3240
+ onTaskNonWorkingTimeClick? : ((event: { source: Gantt, taskRecord: TaskModel, interval: { name: string, startDate: Date, endDate: Date }, domEvent: MouseEvent }) => void)|string
3241
+ /**
3242
+ * Triggered when right-clicking a nonworking time element
3243
+ * @param {object} event Event object
3244
+ * @param {Gantt.view.Gantt} event.source The Gantt chart instance
3245
+ * @param {Gantt.model.TaskModel} event.taskRecord Task record
3246
+ * @param {object} event.interval The raw data describing the nonworking time interval
3247
+ * @param {string} event.interval.name The interval name (if any)
3248
+ * @param {Date} event.interval.startDate The interval start date
3249
+ * @param {Date} event.interval.endDate The interval end date
3250
+ * @param {MouseEvent} event.domEvent Browser event
3251
+ */
3252
+ onTaskNonWorkingTimeContextMenu? : ((event: { source: Gantt, taskRecord: TaskModel, interval: { name: string, startDate: Date, endDate: Date }, domEvent: MouseEvent }) => void)|string
3253
+ /**
3254
+ * Triggered when double-clicking a nonworking time element
3255
+ * @param {object} event Event object
3256
+ * @param {Gantt.view.Gantt} event.source The Gantt chart instance
3257
+ * @param {Gantt.model.TaskModel} event.taskRecord Task record
3258
+ * @param {object} event.interval The raw data describing the nonworking time interval
3259
+ * @param {string} event.interval.name The interval name (if any)
3260
+ * @param {Date} event.interval.startDate The interval start date
3261
+ * @param {Date} event.interval.endDate The interval end date
3262
+ * @param {MouseEvent} event.domEvent Browser event
3263
+ */
3264
+ onTaskNonWorkingTimeDblClick? : ((event: { source: Gantt, taskRecord: TaskModel, interval: { name: string, startDate: Date, endDate: Date }, domEvent: MouseEvent }) => void)|string
3265
+ /**
3266
+ * Fires on the owning Gantt on each resize move event
3267
+ * @param {object} event Event object
3268
+ * @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`
3269
+ * @param {Gantt.model.TaskModel} event.taskRecord Task record being resized
3270
+ * @param {Date} event.startDate New startDate
3271
+ * @param {Date} event.endDate New endDate
3272
+ * @param {HTMLElement} event.element
3273
+ */
3274
+ onTaskPartialResize? : ((event: { resizeData: TaskResizeData[], taskRecord: TaskModel, startDate: Date, endDate: Date, element: HTMLElement }) => void)|string
3275
+ /**
3276
+ * Fires on the owning Gantt after the resizing gesture has finished.
3277
+ * @param {object} event Event object
3278
+ * @param {boolean} event.changed
3279
+ * @param {Gantt.model.TaskModel} event.taskRecord
3280
+ * @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`
3281
+ */
3282
+ onTaskResizeEnd? : ((event: { changed: boolean, taskRecord: TaskModel, resizeData: TaskResizeData[] }) => void)|string
3283
+ /**
3284
+ * Fires on the owning Gantt when task resizing starts
3285
+ * @param {object} event Event object
3286
+ * @param {Gantt.model.TaskModel} event.taskRecord
3287
+ * @param {Event} event.event
3288
+ * @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`
3289
+ */
3290
+ onTaskResizeStart? : ((event: { taskRecord: TaskModel, event: Event, resizeData: TaskResizeData[] }) => void)|string
3291
+ /**
3292
+ * Fires on the owning Gantt while a segment is being dragged
3293
+ * @param {object} event Event object
3294
+ * @param {Gantt.view.Gantt} event.source
3295
+ * @param {Gantt.model.TaskModel[]} event.taskRecords Dragged segments
3296
+ * @param {Date} event.startDate
3297
+ * @param {Date} event.endDate
3298
+ * @param {object} event.dragData
3299
+ * @param {boolean} event.changed `true` if startDate has changed.
3300
+ */
3301
+ onTaskSegmentDrag? : ((event: { source: Gantt, taskRecords: TaskModel[], startDate: Date, endDate: Date, dragData: object, changed: boolean }) => void)|string
3302
+ /**
3303
+ * Fires on the owning Gantt when segment dragging starts
3304
+ * @param {object} event Event object
3305
+ * @param {Gantt.view.Gantt} event.source
3306
+ * @param {Gantt.model.TaskModel[]} event.taskRecords Dragged segments
3307
+ */
3308
+ onTaskSegmentDragStart? : ((event: { source: Gantt, taskRecords: TaskModel[] }) => void)|string
3309
+ /**
3310
+ * Fires on the owning Gantt after a valid task drop
3311
+ * @param {object} event Event object
3312
+ * @param {Gantt.view.Gantt} event.source
3313
+ * @param {Gantt.model.TaskModel[]} event.taskRecords Dropped segments
3314
+ * @param {boolean} event.isCopy
3315
+ */
3316
+ onTaskSegmentDrop? : ((event: { source: Gantt, taskRecords: TaskModel[], isCopy: boolean }) => void)|string
3317
+ /**
3318
+ * Fires on the owning Gantt on each resize move event
3319
+ * @param {object} event Event object
3320
+ * @param {Gantt.view.Gantt} event.source Gantt instance
3321
+ * @param {Gantt.model.TaskModel} event.taskRecord Segment being resized
3322
+ * @param {Date} event.startDate
3323
+ * @param {Date} event.endDate
3324
+ * @param {HTMLElement} event.element
3325
+ */
3326
+ onTaskSegmentPartialResize? : ((event: { source: Gantt, taskRecord: TaskModel, startDate: Date, endDate: Date, element: HTMLElement }) => void)|string
3327
+ /**
3328
+ * Fires on the owning Gantt after the resizing gesture has finished.
3329
+ * @param {object} event Event object
3330
+ * @param {Gantt.view.Gantt} event.source Gantt instance
3331
+ * @param {boolean} event.changed Shows if the record has been changed by the resize action
3332
+ * @param {Gantt.model.TaskModel} event.taskRecord Segment being resized
3333
+ */
3334
+ onTaskSegmentResizeEnd? : ((event: { source: Gantt, changed: boolean, taskRecord: TaskModel }) => void)|string
3335
+ /**
3336
+ * Fires on the owning Gantt when event resizing starts
3337
+ * @param {object} event Event object
3338
+ * @param {Gantt.view.Gantt} event.source Gantt instance
3339
+ * @param {Gantt.model.TaskModel} event.taskRecord Segment being resized
3340
+ * @param {Scheduler.model.SchedulerResourceModel} event.resourceRecord Resource record the resize starts within
3341
+ * @param {MouseEvent} event.event Browser event
3342
+ */
3343
+ onTaskSegmentResizeStart? : ((event: { source: Gantt, taskRecord: TaskModel, resourceRecord: SchedulerResourceModel, event: MouseEvent }) => void)|string
3344
+ /**
3345
+ * Fired when the tick size changes.
3346
+ * ...
3347
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-tickSizeChange)
3348
+ * @param {object} event Event object
3349
+ * @param {Scheduler.view.Scheduler} event.source This Scheduler instance.
3350
+ * @param {number} event.tickSize The tick size in pixels
3351
+ */
3352
+ onTickSizeChange? : ((event: { source: Scheduler, tickSize: number }) => void)|string
3353
+ /**
3354
+ * Fired when the timeaxis has changed, for example by zooming or configuring a new time span.
3355
+ * @param {object} event Event object
3356
+ * @param {Scheduler.view.Scheduler} event.source This Scheduler
3357
+ * @param {object} event.config Config object used to reconfigure the time axis.
3358
+ * @param {Date} event.config.startDate New start date (if supplied)
3359
+ * @param {Date} event.config.endDate New end date (if supplied)
3360
+ */
3361
+ onTimeAxisChange? : ((event: { source: Scheduler, config: { startDate: Date, endDate: Date } }) => void)|string
3362
+ /**
3363
+ * Fires after a click on a time axis cell
3364
+ * @param {object} event Event object
3365
+ * @param {Scheduler.column.SchedulerTimeAxisColumn,Scheduler.column.VerticalTimeAxisColumn} event.source The column object
3366
+ * @param {Date} event.startDate The start date of the header cell
3367
+ * @param {Date} event.endDate The end date of the header cell
3368
+ * @param {Event} event.event The event object
3369
+ */
3370
+ onTimeAxisHeaderClick? : ((event: { source: SchedulerTimeAxisColumn|VerticalTimeAxisColumn, startDate: Date, endDate: Date, event: Event }) => void)|string
3371
+ /**
3372
+ * Fires after a right click on a time axis cell
3373
+ * @param {object} event Event object
3374
+ * @param {Scheduler.column.SchedulerTimeAxisColumn,Scheduler.column.VerticalTimeAxisColumn} event.source The column object
3375
+ * @param {Date} event.startDate The start date of the header cell
3376
+ * @param {Date} event.endDate The end date of the header cell
3377
+ * @param {Event} event.event The event object
3378
+ */
3379
+ onTimeAxisHeaderContextMenu? : ((event: { source: SchedulerTimeAxisColumn|VerticalTimeAxisColumn, startDate: Date, endDate: Date, event: Event }) => void)|string
3380
+ /**
3381
+ * Fires after a double click on a time axis cell
3382
+ * @param {object} event Event object
3383
+ * @param {Scheduler.column.SchedulerTimeAxisColumn,Scheduler.column.VerticalTimeAxisColumn} event.source The column object
3384
+ * @param {Date} event.startDate The start date of the header cell
3385
+ * @param {Date} event.endDate The end date of the header cell
3386
+ * @param {Event} event.event The event object
3387
+ */
3388
+ onTimeAxisHeaderDblClick? : ((event: { source: SchedulerTimeAxisColumn|VerticalTimeAxisColumn, startDate: Date, endDate: Date, event: Event }) => void)|string
3389
+ /**
3390
+ * This event fires on the owning Scheduler or Gantt widget before the context menu is shown for the time axis header.
3391
+ * 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).
3392
+ * ...
3393
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-timeAxisHeaderMenuBeforeShow)
3394
+ * @param {object} event Event object
3395
+ * @param {Scheduler.view.Scheduler} event.source The scheduler
3396
+ * @param {Core.widget.Menu} event.menu The menu
3397
+ * @param {Record<string, MenuItemEntry>} event.items Menu item configs
3398
+ * @param {Grid.column.Column} event.column Time axis column
3399
+ */
3400
+ onTimeAxisHeaderMenuBeforeShow? : ((event: { source: Scheduler, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => Promise<boolean>|boolean|void)|string
3401
+ /**
3402
+ * This event fires on the owning Scheduler or Gantt widget when an item is selected in the header context menu.
3403
+ * @param {object} event Event object
3404
+ * @param {Scheduler.view.Scheduler} event.source The scheduler
3405
+ * @param {Core.widget.Menu} event.menu The menu
3406
+ * @param {Core.widget.MenuItem} event.item Selected menu item
3407
+ * @param {Grid.column.Column} event.column Time axis column
3408
+ */
3409
+ onTimeAxisHeaderMenuItem? : ((event: { source: Scheduler, menu: Menu, item: MenuItem, column: Column }) => void)|string
3410
+ /**
3411
+ * This event fires on the owning Scheduler or Gantt widget after the context menu is shown for a header
3412
+ * @param {object} event Event object
3413
+ * @param {Scheduler.view.Scheduler} event.source The scheduler
3414
+ * @param {Core.widget.Menu} event.menu The menu
3415
+ * @param {Record<string, MenuItemEntry>} event.items Menu item configs
3416
+ * @param {Grid.column.Column} event.column Time axis column
3417
+ */
3418
+ onTimeAxisHeaderMenuShow? : ((event: { source: Scheduler, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => void)|string
3419
+ /**
3420
+ * Fired when the pointer-activated [timelineContext](https://bryntum.com/products/gantt/docs/api/Scheduler/view/mixin/TimelineDomEvents#property-timelineContext) has changed.
3421
+ * @param {object} event Event object
3422
+ * @param {Scheduler.util.TimelineContext} event.oldContext The tick/resource context being deactivated.
3423
+ * @param {Scheduler.util.TimelineContext} event.context The tick/resource context being activated.
3424
+ */
3425
+ onTimelineContextChange? : ((event: { oldContext: TimelineContext, context: TimelineContext }) => void)|string
3426
+ /**
3427
+ * Fired when the *scheduler* viewport (not the overall Scheduler element) changes size.
3428
+ * This happens when the grid changes height, or when the subgrid which encapsulates the
3429
+ * scheduler column changes width.
3430
+ * @param {object} event Event object
3431
+ * @param {Core.widget.Widget} event.source This Scheduler
3432
+ * @param {number} event.width The new width
3433
+ * @param {number} event.height The new height
3434
+ * @param {number} event.oldWidth The old width
3435
+ * @param {number} event.oldHeight The old height
3436
+ */
3437
+ onTimelineViewportResize? : ((event: { source: Widget, width: number, height: number, oldWidth: number, oldHeight: number }) => void)|string
3438
+ /**
3439
+ * Fired on the owning Scheduler or Gantt widget when a click happens on a time range header element
3440
+ * @param {object} event Event object
3441
+ * @param {Scheduler.view.Scheduler} event.source Scheduler instance
3442
+ * @param {Scheduler.model.TimeSpan} event.timeRangeRecord The record
3443
+ * @param {MouseEvent} event.domEvent Browser event
3444
+ */
3445
+ onTimeRangeHeaderClick? : ((event: { source: Scheduler, timeRangeRecord: TimeSpan, domEvent: MouseEvent }) => void)|string
3446
+ /**
3447
+ * Fired on the owning Scheduler or Gantt widget when a right click happens on a time range header element
3448
+ * @param {object} event Event object
3449
+ * @param {Scheduler.view.Scheduler} event.source Scheduler instance
3450
+ * @param {Scheduler.model.TimeSpan} event.timeRangeRecord The record
3451
+ * @param {MouseEvent} event.domEvent Browser event
3452
+ */
3453
+ onTimeRangeHeaderContextMenu? : ((event: { source: Scheduler, timeRangeRecord: TimeSpan, domEvent: MouseEvent }) => void)|string
3454
+ /**
3455
+ * Fired on the owning Scheduler or Gantt widget when a double click happens on a time range header element
3456
+ * @param {object} event Event object
3457
+ * @param {Scheduler.view.Scheduler} event.source Scheduler instance
3458
+ * @param {Scheduler.model.TimeSpan} event.timeRangeRecord The record
3459
+ * @param {MouseEvent} event.domEvent Browser event
3460
+ */
3461
+ onTimeRangeHeaderDblClick? : ((event: { source: Scheduler, timeRangeRecord: TimeSpan, domEvent: MouseEvent }) => void)|string
3462
+ /**
3463
+ * Fired when one or more groups are expanded or collapsed
3464
+ * @param {object} event Event object
3465
+ * @param {Core.data.Model} event.groupRecord [DEPRECATED] Use `groupRecords` param instead
3466
+ * @param {Core.data.Model[]} event.groupRecords The group records being toggled
3467
+ * @param {boolean} event.collapse Collapsed (true) or expanded (false)
3468
+ * @param {boolean} event.allRecords True if this event is part of toggling all groups
3469
+ */
3470
+ onToggleGroup? : ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, allRecords?: boolean }) => void)|string
3471
+ /**
3472
+ * Fired after a parent node record toggles its collapsed state.
3473
+ * @param {object} event Event object
3474
+ * @param {Core.data.Model} event.record The record being toggled.
3475
+ * @param {boolean} event.collapse `true` if the node is being collapsed.
3476
+ */
3477
+ onToggleNode? : ((event: { record: Model, collapse: boolean }) => void)|string
3478
+ /**
3479
+ * A header [tool](https://bryntum.com/products/gantt/docs/api/Core/widget/Panel#config-tools) has been clicked.
3480
+ * @param {object} event Event object
3481
+ * @param {Core.widget.Tool} event.source This Panel.
3482
+ * @param {Core.widget.Tool} event.tool The tool which is being clicked.
3483
+ */
3484
+ onToolClick? : ((event: { source: Tool, tool: Tool }) => void)|string
3485
+ /**
3486
+ * <strong>Note that this event fires on the owning [SchedulerPro](https://bryntum.com/products/gantt/docs/api/SchedulerPro/view/SchedulerPro).</strong>
3487
+ * ...
3488
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-transactionChange)
3489
+ * @param {object} event Event object
3490
+ * @param {boolean} event.hasChanges Whether any changes are recorded that are not yet attached to a version.
3491
+ */
3492
+ onTransactionChange? : ((event: { hasChanges: boolean }) => void)|string
3493
+ /**
3494
+ * Fires when row locking is disabled.
3495
+ * @param {object} event Event object
3496
+ * @param {Grid.view.GridBase} event.clone The locked clone that will be destroyed
3497
+ */
3498
+ onUnlockRows? : ((event: { clone: GridBase }) => void)|string
3499
+ /**
3500
+ * Fires when un-splitting the Grid.
3501
+ */
3502
+ onUnsplit? : (() => void)|string
3503
+ /**
3504
+ * Fired when the range of dates visible within the viewport changes. This will be when
3505
+ * scrolling along a time axis.
3506
+ * ...
3507
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-visibleDateRangeChange)
3508
+ * @param {object} event Event object
3509
+ * @param {Scheduler.view.Scheduler} event.source This Scheduler instance.
3510
+ * @param {object} event.old The old date range
3511
+ * @param {Date} event.old.startDate the old start date.
3512
+ * @param {Date} event.old.endDate the old end date.
3513
+ * @param {object} event.new The new date range
3514
+ * @param {Date} event.new.startDate the new start date.
3515
+ * @param {Date} event.new.endDate the new end date.
3516
+ */
3517
+ onVisibleDateRangeChange? : ((event: { source: Scheduler, old: { startDate: Date, endDate: Date }, new: { startDate: Date, endDate: Date } }) => void)|string
3518
+
3519
+ // Features
3520
+ /**
3521
+ * AI-powered filter feature for Grid. Allows users to type natural language queries to filter grid data.
3522
+ * ...
3523
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/ai/AIFilter)
3524
+ */
3525
+ aiFilterFeature? : object|boolean|string|AIFilter|AIFilterConfig
3526
+ /**
3527
+ * 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
3528
+ * timeline.
3529
+ * ...
3530
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/Baselines)
3531
+ */
3532
+ baselinesFeature? : object|boolean|string|Baselines|BaselinesConfig
3533
+ /**
3534
+ * Allows using `[Ctrl/CMD + C]`, `[Ctrl/CMD + X]` and `[Ctrl/CMD + V]` to cut, copy and paste cell or cell ranges. Also
3535
+ * makes cut, copy and paste actions available via the cell context menu.
3536
+ * ...
3537
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/CellCopyPaste)
3538
+ */
3539
+ cellCopyPasteFeature? : object|boolean|string|CellCopyPaste|CellCopyPasteConfig
3540
+ /**
3541
+ * 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>
3542
+ * ...
3543
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/CellEdit)
3544
+ */
3545
+ cellEditFeature? : object|boolean|string|CellEdit|CellEditConfig
3546
+ /**
3547
+ * Right click to display context menu for cells. To invoke the cell menu in a keyboard-accessible manner, use the
3548
+ * `SPACE` key when the cell is focused.
3549
+ * ...
3550
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/CellMenu)
3551
+ */
3552
+ cellMenuFeature? : object|boolean|string|CellMenu|CellMenuConfig
3553
+ /**
3554
+ * Displays a tooltip when hovering cells.
3555
+ * ...
3556
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/CellTooltip)
3557
+ */
3558
+ cellTooltipFeature? : object|boolean|string|CellTooltip|CellTooltipConfig
3559
+ /**
3560
+ * 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
3561
+ * and updated in realtime as data changes. Supports many common chart types with extensive styling and customization
3562
+ * options.
3563
+ * ...
3564
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/Charts)
3565
+ */
3566
+ chartsFeature? : object|boolean|string|Charts|ChartsConfig
3567
+ /**
3568
+ * Enables the [autoWidth](https://bryntum.com/products/gantt/docs/api/Grid/column/Column#config-autoWidth) config for a grid's columns.
3569
+ * ...
3570
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/ColumnAutoWidth)
3571
+ */
3572
+ columnAutoWidthFeature? : object|boolean|string|ColumnAutoWidth|ColumnAutoWidthConfig
3573
+ /**
3574
+ * Displays a toolbar while dragging column headers. Drop on a button in the toolbar to activate a certain function,
3575
+ * for example to group by that column. This feature simplifies certain operations on touch devices.
3576
+ * ...
3577
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/ColumnDragToolbar)
3578
+ */
3579
+ columnDragToolbarFeature? : object|boolean|string|ColumnDragToolbar|ColumnDragToolbarConfig
3580
+ /**
3581
+ * Displays column lines for ticks, with a different styling for major ticks (by default they are darker). If this
3582
+ * feature is disabled, no lines are shown. If it's enabled, line are shown for the tick level which is set in current
3583
+ * ViewPreset. Please see [columnLinesFor](https://bryntum.com/products/gantt/docs/api/Scheduler/preset/ViewPreset#field-columnLinesFor) config for details.
3584
+ * ...
3585
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Scheduler/feature/ColumnLines)
3586
+ */
3587
+ columnLinesFeature? : object|boolean|string|ColumnLines|ColumnLinesConfig
3588
+ /**
3589
+ * Displays a column picker (to show/hide columns) in the header context menu. Columns can be displayed in sub menus
3590
+ * by region or tag. Grouped headers are displayed as menu hierarchies.
3591
+ * ...
3592
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/ColumnPicker)
3593
+ */
3594
+ columnPickerFeature? : object|boolean|string|ColumnPicker|ColumnPickerConfig
3595
+ /**
3596
+ * Allows user to rename columns by either right-clicking column header or using keyboard shortcuts when column header
3597
+ * is focused.
3598
+ * ...
3599
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/ColumnRename)
3600
+ */
3601
+ columnRenameFeature? : object|boolean|string|ColumnRename|ColumnRenameConfig
3602
+ /**
3603
+ * Allows user to reorder columns by dragging headers. To get notified about column reorder listen to `change` event
3604
+ * on [columns](https://bryntum.com/products/gantt/docs/api/Grid/data/ColumnStore) store.
3605
+ * ...
3606
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/ColumnReorder)
3607
+ */
3608
+ columnReorderFeature? : object|boolean|string|ColumnReorder|ColumnReorderConfig
3609
+ /**
3610
+ * Enables user to resize columns by dragging a handle on the right hand side of the header. To get notified about column
3611
+ * resize listen to `change` event on [columns](https://bryntum.com/products/gantt/docs/api/Grid/data/ColumnStore) store.
3612
+ * ...
3613
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/ColumnResize)
3614
+ */
3615
+ columnResizeFeature? : object|boolean|string|ColumnResize|ColumnResizeConfig
3616
+ /**
3617
+ * This feature highlights the project *critical paths*.
3618
+ * Every task is important, but only some of them are critical.
3619
+ * The critical path is a chain of linked tasks that directly affects the project finish date.
3620
+ * If any task on the critical path is late, the whole project is late.
3621
+ * ...
3622
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/CriticalPaths)
3623
+ */
3624
+ criticalPathsFeature? : object|boolean|string|CriticalPaths|CriticalPathsConfig
3625
+ /**
3626
+ * This feature draws dependencies between tasks. Uses a dependency
3627
+ * [store](https://bryntum.com/products/gantt/docs/api/Gantt/model/ProjectModel#property-dependencyStore) to determine which dependencies to draw.
3628
+ * ...
3629
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/Dependencies)
3630
+ */
3631
+ dependenciesFeature? : object|boolean|string|Dependencies|DependenciesConfig
3632
+ /**
3633
+ * Feature that displays a popup containing fields for editing dependency data.
3634
+ * ...
3635
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/SchedulerPro/feature/DependencyEdit)
3636
+ */
3637
+ dependencyEditFeature? : object|boolean|string|DependencyEdit|DependencyEditConfig
3638
+ /**
3639
+ * Adds event filter menu items to the timeline header context menu.
3640
+ * ...
3641
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Scheduler/feature/EventFilter)
3642
+ */
3643
+ eventFilterFeature? : object|boolean|string|EventFilter|EventFilterConfig
3644
+ /**
3645
+ * This feature provides segmented events support. It implements rendering of such events and also adds a entries to the
3646
+ * event context menu allowing to split the selected event and rename segments.
3647
+ * ...
3648
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/SchedulerPro/feature/EventSegments)
3649
+ */
3650
+ eventSegmentsFeature? : object|boolean|string|EventSegments|EventSegmentsConfig
3651
+ /**
3652
+ * A feature that allows exporting Grid data to Excel or CSV without involving the server. It uses
3653
+ * [TableExporter](https://bryntum.com/products/gantt/docs/api/Grid/util/TableExporter) class as data provider, 3rd party provider to generate XLS files, and
3654
+ * [Microsoft XML specification](https://msdn.microsoft.com/en-us/library/office/documentformat.openxml.spreadsheet.aspx).
3655
+ * ...
3656
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/experimental/ExcelExporter)
3657
+ */
3658
+ excelExporterFeature? : object|boolean|string|GridExcelExporter|GridExcelExporterConfig
3659
+ /**
3660
+ * An experimental feature that lets users drop files on a Widget. The widget fires an event when a file is dropped onto it.
3661
+ * In the event, you get access to the raw files as strings, that were parsed by calling `readAsBinaryString`.
3662
+ * ...
3663
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/experimental/FileDrop)
3664
+ */
3665
+ fileDropFeature? : object|boolean|string|FileDrop|FileDropConfig
3666
+ /**
3667
+ * This feature adds a fill handle to a Grid range selection, which when dragged, fills the cells being dragged over
3668
+ * with values based on the values in the original selected range. This is similar to functionality normally seen in
3669
+ * various spreadsheet applications.
3670
+ * ...
3671
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/FillHandle)
3672
+ */
3673
+ fillHandleFeature? : object|boolean|string|FillHandle|FillHandleConfig
3674
+ /**
3675
+ * Feature that allows filtering of the grid by settings filters on columns. The actual filtering is done by the store.
3676
+ * For info on programmatically handling filters, see [StoreFilter](https://bryntum.com/products/gantt/docs/api/Core/data/mixin/StoreFilter).
3677
+ * ...
3678
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/Filter)
3679
+ */
3680
+ filterFeature? : object|boolean|string|Filter|FilterConfig
3681
+ /**
3682
+ * Feature that allows filtering of the grid by entering filters on column headers.
3683
+ * The actual filtering is done by the store.
3684
+ * For info on programmatically handling filters, see [StoreFilter](https://bryntum.com/products/gantt/docs/api/Core/data/mixin/StoreFilter).
3685
+ * ...
3686
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/FilterBar)
3687
+ */
3688
+ filterBarFeature? : object|boolean|string|FilterBar|FilterBarConfig
3689
+ /**
3690
+ * Enables rendering and handling of row groups. The actual grouping is done in the store, but triggered by
3691
+ * <kbd>shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
3692
+ * one anywhere on grid). Use <kbd>shift</kbd> + <kbd>alt</kbd> + click, or the context menu, to remove a column
3693
+ * grouper.
3694
+ * ...
3695
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/Group)
3696
+ */
3697
+ groupFeature? : object|boolean|string|Group|GroupConfig
3698
+ /**
3699
+ * Displays a summary row as a group footer in a grouped grid. Uses the same configuration options on columns as
3700
+ * [Summary](https://bryntum.com/products/gantt/docs/api/Grid/feature/Summary).
3701
+ * ...
3702
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/GroupSummary)
3703
+ */
3704
+ groupSummaryFeature? : object|boolean|string|GridGroupSummary|GridGroupSummaryConfig
3705
+ /**
3706
+ * Right click column header or focus it and press SPACE key to show the context menu for headers.
3707
+ * ...
3708
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/HeaderMenu)
3709
+ */
3710
+ headerMenuFeature? : object|boolean|string|HeaderMenu|HeaderMenuConfig
3711
+ /**
3712
+ * Enables users to click and drag to zoom to a date range in Scheduler's header time axis. Only supported in horizontal
3713
+ * mode.
3714
+ * ...
3715
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Scheduler/feature/HeaderZoom)
3716
+ */
3717
+ headerZoomFeature? : object|boolean|string|HeaderZoom|HeaderZoomConfig
3718
+ /**
3719
+ * The Indicators feature displays indicators (icons) for different dates related to a task in its row. Hovering an
3720
+ * indicator will show a tooltip with its name and date(s). The owning task `id` is embedded in the indicator element
3721
+ * dataset as `taskRecordId` which can be useful if you want to have custom actions when clicking (showing a menu for example).
3722
+ * ...
3723
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/Indicators)
3724
+ */
3725
+ indicatorsFeature? : object|boolean|string|Indicators|IndicatorsConfig
3726
+ /**
3727
+ * A feature that lets you display a label on each side of a Gantt task bar. See
3728
+ * [Labels](https://bryntum.com/products/gantt/docs/api/Scheduler/feature/Labels) for more information.
3729
+ * ...
3730
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/Labels)
3731
+ */
3732
+ labelsFeature? : object|boolean|string|Labels|LabelsConfig
3733
+ /**
3734
+ * This feature allows records which satisfy a certain condition to be locked at the top of the grid.
3735
+ * ...
3736
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/LockRows)
3737
+ */
3738
+ lockRowsFeature? : object|boolean|string|GridLockRows|GridLockRowsConfig
3739
+ /**
3740
+ * 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
3741
+ * configured to [mergeCells](https://bryntum.com/products/gantt/docs/api/Grid/column/Column#config-mergeCells).
3742
+ * ...
3743
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/MergeCells)
3744
+ */
3745
+ mergeCellsFeature? : object|boolean|string|MergeCells|MergeCellsConfig
3746
+ /**
3747
+ * A feature that allows exporting Gantt to Microsoft Project without involving a server.
3748
+ * ...
3749
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/export/MspExport)
3750
+ */
3751
+ mspExportFeature? : object|boolean|string|MspExport|MspExportConfig
3752
+ /**
3753
+ * Feature that allows styling of weekends (and other non-working time) by adding timeRanges for those days.
3754
+ * ...
3755
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Scheduler/feature/NonWorkingTime)
3756
+ */
3757
+ nonWorkingTimeFeature? : object|boolean|string|NonWorkingTime|NonWorkingTimeConfig
3758
+ /**
3759
+ * Makes the scheduler's timeline pannable by dragging with the mouse. Try it out in the demo below.
3760
+ * ...
3761
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Scheduler/feature/Pan)
3762
+ */
3763
+ panFeature? : object|boolean|string|Pan|PanConfig
3764
+ /**
3765
+ * Highlights the area encapsulating all child tasks of a parent task in a semi-transparent layer. You can style
3766
+ * these layer elements using the `b-parent-area` CSS class.
3767
+ * ...
3768
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/ParentArea)
3769
+ */
3770
+ parentAreaFeature? : object|boolean|string|ParentArea|ParentAreaConfig
3771
+ /**
3772
+ * Generates PDF/PNG files from the Gantt component.
3773
+ * ...
3774
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/export/PdfExport)
3775
+ */
3776
+ pdfExportFeature? : object|boolean|string|PdfExport|PdfExportConfig
3777
+ /**
3778
+ * This feature visualizes the [percentDone](https://bryntum.com/products/gantt/docs/api/SchedulerPro/model/mixin/PercentDoneMixin#field-percentDone) field as a
3779
+ * progress bar on the event elements. Each progress bar also optionally has a drag handle which users can drag can
3780
+ * change the value.
3781
+ * ...
3782
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/SchedulerPro/feature/PercentBar)
3783
+ */
3784
+ percentBarFeature? : object|boolean|string|PercentBar|PercentBarConfig
3785
+ /**
3786
+ * Allows pinning columns to the start or end region of the grid without any additional subGrid configurations.
3787
+ * When pinning to a region that does not yet exist, the feature creates the required subGrid on the fly.
3788
+ * ...
3789
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/PinColumns)
3790
+ */
3791
+ pinColumnsFeature? : object|boolean|string|PinColumns|PinColumnsConfig
3792
+ /**
3793
+ * Allows printing Gantt contents using browser print dialog.
3794
+ * ...
3795
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/export/Print)
3796
+ */
3797
+ printFeature? : object|boolean|string|Print|PrintConfig
3798
+ /**
3799
+ * 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
3800
+ * by default, it is)
3801
+ * ...
3802
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/ProgressLine)
3803
+ */
3804
+ progressLineFeature? : object|boolean|string|ProgressLine|ProgressLineConfig
3805
+ /**
3806
+ * Feature that displays the [project editor](https://bryntum.com/products/gantt/docs/api/Gantt/widget/ProjectEditor) allowing users to edit
3807
+ * the project settings.
3808
+ * ...
3809
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/ProjectEdit)
3810
+ */
3811
+ projectEditFeature? : object|boolean|string|ProjectEdit|ProjectEditConfig
3812
+ /**
3813
+ * This feature draws the vertical lines in the schedule area, indicating project start/end dates
3814
+ * and also its [status date](https://bryntum.com/products/gantt/docs/api/Gantt/model/ProjectModel#field-statusDate). The latter can be disabled
3815
+ * with the [showStatusDate](https://bryntum.com/products/gantt/docs/api/Gantt/feature/ProjectLines#config-showStatusDate) config.
3816
+ * ...
3817
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/ProjectLines)
3818
+ */
3819
+ projectLinesFeature? : object|boolean|string|ProjectLines|ProjectLinesConfig
3820
+ /**
3821
+ * Feature that allows the user to search in a column by focusing a cell and typing. Navigate between hits using the
3822
+ * keyboard, [f3] or [ctrl]/[cmd] + [g] moves to next, also pressing [shift] moves to previous.
3823
+ * ...
3824
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/QuickFind)
3825
+ */
3826
+ quickFindFeature? : object|boolean|string|QuickFind|QuickFindConfig
3827
+ /**
3828
+ * Makes the splitter between grid [sections](https://bryntum.com/products/gantt/docs/api/Grid/view/SubGrid) draggable, to let users resize, and
3829
+ * collapse/expand the sections.
3830
+ * ...
3831
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/RegionResize)
3832
+ */
3833
+ regionResizeFeature? : object|boolean|string|RegionResize|RegionResizeConfig
3834
+ /**
3835
+ * 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.
3836
+ * Each of the rollup elements show a tooltip when hovering it with details of the task.
3837
+ * The tooltip content is customizable, see [template](https://bryntum.com/products/gantt/docs/api/Gantt/feature/Rollups#config-template) config for details.
3838
+ * ...
3839
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/Rollups)
3840
+ */
3841
+ rollupsFeature? : object|boolean|string|Rollups|RollupsConfig
3842
+ /**
3843
+ * Allow using [Ctrl/CMD + C/X] and [Ctrl/CMD + V] to copy/cut-and-paste rows. Also makes cut, copy and paste actions
3844
+ * available via the cell context menu.
3845
+ * ...
3846
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/RowCopyPaste)
3847
+ */
3848
+ rowCopyPasteFeature? : object|boolean|string|RowCopyPaste|RowCopyPasteConfig
3849
+ /**
3850
+ * This feature allows editing of entire rows in a grid in a docked panel which by default slides out from the right.
3851
+ * ...
3852
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/RowEdit)
3853
+ */
3854
+ rowEditFeature? : object|boolean|string|RowEdit|RowEditConfig
3855
+ /**
3856
+ * Enables expanding of Grid rows by either row click or double click, or by adding a separate Grid column which renders
3857
+ * a button that expands or collapses the row.
3858
+ * ...
3859
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/RowExpander)
3860
+ */
3861
+ rowExpanderFeature? : object|boolean|string|RowExpander|RowExpanderConfig
3862
+ /**
3863
+ * This feature implements support for project transactions and used by default in Gantt. For general RowReorder feature
3864
+ * documentation see [RowReorder](https://bryntum.com/products/gantt/docs/api/Grid/feature/RowReorder).
3865
+ * ...
3866
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Scheduler/feature/RowReorder)
3867
+ */
3868
+ rowReorderFeature? : object|boolean|string|RowReorder|RowReorderConfig
3869
+ /**
3870
+ * 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)
3871
+ * field of the record is updated (when [applyToAllRows](https://bryntum.com/products/gantt/docs/api/Grid/feature/RowResize#config-applyToAllRows) is `false`).
3872
+ * ...
3873
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/RowResize)
3874
+ */
3875
+ rowResizeFeature? : object|boolean|string|GridRowResize|GridRowResizeConfig
3876
+ /**
3877
+ * Displays a context menu for empty parts of the schedule. Items are populated in the first place
3878
+ * by configurations of this Feature, then by other features and/or application code.
3879
+ * ...
3880
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Scheduler/feature/ScheduleMenu)
3881
+ */
3882
+ scheduleMenuFeature? : object|boolean|string|ScheduleMenu|ScheduleMenuConfig
3883
+ /**
3884
+ * Feature that displays a tooltip containing the time at the mouse position when hovering empty parts of the schedule.
3885
+ * ...
3886
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Scheduler/feature/ScheduleTooltip)
3887
+ */
3888
+ scheduleTooltipFeature? : object|boolean|string|ScheduleTooltip|ScheduleTooltipConfig
3889
+ /**
3890
+ * This feature injects buttons in each row that scrolls the task bar into view. It can optionally show a label along
3891
+ * with the button, using the [labelRenderer](https://bryntum.com/products/gantt/docs/api/Gantt/feature/ScrollButtons#config-labelRenderer).
3892
+ * ...
3893
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/ScrollButtons)
3894
+ */
3895
+ scrollButtonsFeature? : object|boolean|string|ScrollButtons|ScrollButtonsConfig
3896
+ /**
3897
+ * <div class="external-example vertical" data-file="Grid/feature/Search.js"></div>
3898
+ * ...
3899
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/Search)
3900
+ */
3901
+ searchFeature? : object|boolean|string|Search|SearchConfig
3902
+ /**
3903
+ * Allows sorting of grid by clicking (or tapping) headers, also displays which columns grid is sorted by (numbered if
3904
+ * using multisort). Use modifier keys for multisorting: [Ctrl/CMD + click] to add sorter, [Ctrl/CMD + Alt + click] to remove sorter.
3905
+ * The actual sorting is done by the store, see [Store.sort()](https://bryntum.com/products/gantt/docs/api/Core/data/mixin/StoreSort#function-sort).
3906
+ * ...
3907
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/Sort)
3908
+ */
3909
+ sortFeature? : object|boolean|string|Sort|SortConfig
3910
+ /**
3911
+ * This feature allows splitting the Grid into multiple views, either by using the cell context menu, or
3912
+ * programmatically by calling [split()](https://bryntum.com/products/gantt/docs/api/Grid/feature/Split#function-split).
3913
+ * ...
3914
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/Split)
3915
+ */
3916
+ splitFeature? : object|boolean|string|GridSplit|GridSplitConfig
3917
+ /**
3918
+ * A feature which pins configurable content from a grid row to the top of the grid
3919
+ * while the row scrolls off the top but is still visible.
3920
+ * ...
3921
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/StickyCells)
3922
+ */
3923
+ stickyCellsFeature? : object|boolean|string|StickyCells|StickyCellsConfig
3924
+ /**
3925
+ * Stripes rows by adding alternating CSS classes to all row elements (`b-even` and `b-odd`).
3926
+ * ...
3927
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/Stripe)
3928
+ */
3929
+ stripeFeature? : object|boolean|string|Stripe|StripeConfig
3930
+ /**
3931
+ * A feature displaying a summary bar in the grid footer.
3932
+ * ...
3933
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/Summary)
3934
+ */
3935
+ summaryFeature? : object|boolean|string|Summary|SummaryConfig
3936
+ /**
3937
+ * Allow using <kbd>Ctrl</kbd>/<kbd>CMD</kbd> + <kbd>C</kbd>/<kbd>X</kbd> and <kbd>Ctrl</kbd>/<kbd>CMD</kbd> +
3938
+ * <kbd>V</kbd> to copy/cut and paste tasks. You can configure how a newly pasted record is named using
3939
+ * [generateNewName](https://bryntum.com/products/gantt/docs/api/Gantt/feature/TaskCopyPaste#config-generateNewName)
3940
+ * ...
3941
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/TaskCopyPaste)
3942
+ */
3943
+ taskCopyPasteFeature? : object|boolean|string|TaskCopyPaste|TaskCopyPasteConfig
3944
+ /**
3945
+ * Allows user to drag and drop tasks within Gantt, to change their start date.
3946
+ * ...
3947
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/TaskDrag)
3948
+ */
3949
+ taskDragFeature? : object|boolean|string|TaskDrag|TaskDragConfig
3950
+ /**
3951
+ * 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.
3952
+ * ...
3953
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/TaskDragCreate)
3954
+ */
3955
+ taskDragCreateFeature? : object|boolean|string|TaskDragCreate|TaskDragCreateConfig
3956
+ /**
3957
+ * 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.
3958
+ * ...
3959
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/TaskEdit)
3960
+ */
3961
+ taskEditFeature? : object|boolean|string|TaskEdit|TaskEditConfig
3962
+ /**
3963
+ * Displays a context menu for tasks. Items are populated by other features and/or application code.
3964
+ * Configure it with `false` to disable it completely. If enabled, [CellMenu](https://bryntum.com/products/gantt/docs/api/Grid/feature/CellMenu) feature
3965
+ * is not available. Cell context menu items are handled by this feature.
3966
+ * ...
3967
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/TaskMenu)
3968
+ */
3969
+ taskMenuFeature? : object|boolean|string|TaskMenu|TaskMenuConfig
3970
+ /**
3971
+ * 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).
3972
+ * If a task has no calendar defined, the project's calendar will be used. The non-working time interval can also be
3973
+ * recurring. You can find a live example showing how to achieve this in the [Task Calendars Demo](../examples/calendars/).
3974
+ * ...
3975
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/TaskNonWorkingTime)
3976
+ */
3977
+ taskNonWorkingTimeFeature? : object|boolean|string|TaskNonWorkingTime|TaskNonWorkingTimeConfig
3978
+ /**
3979
+ * Feature that allows resizing a task by dragging its end date. Resizing a task by dragging its start date is not allowed.
3980
+ * ...
3981
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/TaskResize)
3982
+ */
3983
+ taskResizeFeature? : object|boolean|string|TaskResize|TaskResizeConfig
3984
+ /**
3985
+ * Allows user to drag and drop task segments, to change their start date.
3986
+ * ...
3987
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/TaskSegmentDrag)
3988
+ */
3989
+ taskSegmentDragFeature? : object|boolean|string|TaskSegmentDrag|TaskSegmentDragConfig
3990
+ /**
3991
+ * Feature that allows resizing a task segment by dragging its end.
3992
+ * ...
3993
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/TaskSegmentResize)
3994
+ */
3995
+ taskSegmentResizeFeature? : object|boolean|string|TaskSegmentResize|TaskSegmentResizeConfig
3996
+ /**
3997
+ * This feature displays a task tooltip on mouse hover. The template of the tooltip is customizable
3998
+ * with the [template](https://bryntum.com/products/gantt/docs/api/Gantt/feature/TaskTooltip#config-template) function.
3999
+ * ...
4000
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/TaskTooltip)
4001
+ */
4002
+ taskTooltipFeature? : object|boolean|string|TaskTooltip|TaskTooltipConfig
4003
+ /**
4004
+ * Adds scheduler specific menu items to the timeline header context menu.
4005
+ * ...
4006
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Scheduler/feature/TimeAxisHeaderMenu)
4007
+ */
4008
+ timeAxisHeaderMenuFeature? : object|boolean|string|TimeAxisHeaderMenu|TimeAxisHeaderMenuConfig
4009
+ /**
4010
+ * This feature allows drawing line charts on top of the timeline area. Feature consists of two parts: chart and
4011
+ * data providers. Chart provider is responsible for rendering the chart, while data provider is responsible
4012
+ * for providing data for the chart. Feature itself manages the interaction between them, and tracks lifecycle events
4013
+ * of the Gantt chart.
4014
+ * ...
4015
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/TimelineChart)
4016
+ */
4017
+ timelineChartFeature? : object|boolean|string|TimelineChart|TimelineChartConfig
4018
+ /**
4019
+ * Feature that renders global ranges of time in the timeline. Use this feature to visualize a `range` like a 1 hr lunch
4020
+ * or some important point in time (a `line`, i.e. a range with 0 duration). This feature can also show a current time
4021
+ * 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
4022
+ * [cls](https://bryntum.com/products/gantt/docs/api/Scheduler/model/TimeSpan#field-cls) field of the `TimeSpan` class.
4023
+ * ...
4024
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Scheduler/feature/TimeRanges)
4025
+ */
4026
+ timeRangesFeature? : object|boolean|string|TimeRanges|TimeRangesConfig
4027
+ /**
4028
+ * This feature exposes methods on the owning Scheduler or Gantt widget which you can use to highlight one or multiple time spans
4029
+ * 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
4030
+ * more or try the demo below:
4031
+ * ...
4032
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/SchedulerPro/feature/TimeSpanHighlight)
4033
+ */
4034
+ timeSpanHighlightFeature? : object|boolean|string|TimeSpanHighlight|TimeSpanHighlightConfig
4035
+ /**
4036
+ * 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
4037
+ * 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
4038
+ * tree renderer that adds padding and icon to give the appearance of a tree. The original renderer is preserved and
4039
+ * also called.
4040
+ * ...
4041
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/Tree)
4042
+ */
4043
+ treeFeature? : object|boolean|string|Tree|TreeConfig
4044
+ /**
4045
+ * 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.
4046
+ * Allows generating a new task tree where parents are determined by the values of specified task fields/functions:
4047
+ * ...
4048
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/TreeGroup)
4049
+ */
4050
+ treeGroupFeature? : object|boolean|string|TreeGroup|TreeGroupConfig
4051
+ /**
4052
+ * Captures versions (snapshots) of the active project, including a detailed log of the changes new in each version.
4053
+ * ...
4054
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/Versions)
4055
+ */
4056
+ versionsFeature? : object|boolean|string|Versions|VersionsConfig
4057
+
4058
+ }
4059
+
4060
+ export class BryntumGanttBase extends React.Component<BryntumGanttBaseProps> {
4061
+
4062
+ static instanceClass = GanttBase;
4063
+
4064
+ static instanceName = 'GanttBase';
4065
+
4066
+ processWidgetContent = processWidgetContent;
4067
+
4068
+ // Component is View class
4069
+ static isView = true;
4070
+
4071
+ // Hidden div to host unused portals DOM
4072
+ portalsCache? : HTMLElement;
4073
+
4074
+ // CSS class used for individual portal containers
4075
+ portalContainerClass = 'b-react-portal-container';
4076
+
4077
+ state = {
4078
+ // Holds React portals
4079
+ portals : new Map(),
4080
+
4081
+ // Needed to trigger refresh when portals change
4082
+ generation : 0
4083
+ };
4084
+
4085
+ static featureNames = [
4086
+ 'aiFilterFeature',
4087
+ 'baselinesFeature',
4088
+ 'cellCopyPasteFeature',
4089
+ 'cellEditFeature',
4090
+ 'cellMenuFeature',
4091
+ 'cellTooltipFeature',
4092
+ 'chartsFeature',
4093
+ 'columnAutoWidthFeature',
4094
+ 'columnDragToolbarFeature',
4095
+ 'columnLinesFeature',
4096
+ 'columnPickerFeature',
4097
+ 'columnRenameFeature',
4098
+ 'columnReorderFeature',
4099
+ 'columnResizeFeature',
4100
+ 'criticalPathsFeature',
4101
+ 'dependenciesFeature',
4102
+ 'dependencyEditFeature',
4103
+ 'eventFilterFeature',
4104
+ 'eventSegmentsFeature',
4105
+ 'excelExporterFeature',
4106
+ 'fileDropFeature',
4107
+ 'fillHandleFeature',
4108
+ 'filterFeature',
4109
+ 'filterBarFeature',
4110
+ 'groupFeature',
4111
+ 'groupSummaryFeature',
4112
+ 'headerMenuFeature',
4113
+ 'headerZoomFeature',
4114
+ 'indicatorsFeature',
4115
+ 'labelsFeature',
4116
+ 'lockRowsFeature',
4117
+ 'mergeCellsFeature',
4118
+ 'mspExportFeature',
4119
+ 'nonWorkingTimeFeature',
4120
+ 'panFeature',
4121
+ 'parentAreaFeature',
4122
+ 'pdfExportFeature',
4123
+ 'percentBarFeature',
4124
+ 'pinColumnsFeature',
4125
+ 'printFeature',
4126
+ 'progressLineFeature',
4127
+ 'projectEditFeature',
4128
+ 'projectLinesFeature',
4129
+ 'quickFindFeature',
4130
+ 'regionResizeFeature',
4131
+ 'rollupsFeature',
4132
+ 'rowCopyPasteFeature',
4133
+ 'rowEditFeature',
4134
+ 'rowExpanderFeature',
4135
+ 'rowReorderFeature',
4136
+ 'rowResizeFeature',
4137
+ 'scheduleMenuFeature',
4138
+ 'scheduleTooltipFeature',
4139
+ 'scrollButtonsFeature',
4140
+ 'searchFeature',
4141
+ 'sortFeature',
4142
+ 'splitFeature',
4143
+ 'stickyCellsFeature',
4144
+ 'stripeFeature',
4145
+ 'summaryFeature',
4146
+ 'taskCopyPasteFeature',
4147
+ 'taskDragFeature',
4148
+ 'taskDragCreateFeature',
4149
+ 'taskEditFeature',
4150
+ 'taskMenuFeature',
4151
+ 'taskNonWorkingTimeFeature',
4152
+ 'taskResizeFeature',
4153
+ 'taskSegmentDragFeature',
4154
+ 'taskSegmentResizeFeature',
4155
+ 'taskTooltipFeature',
4156
+ 'timeAxisHeaderMenuFeature',
4157
+ 'timelineChartFeature',
4158
+ 'timeRangesFeature',
4159
+ 'timeSpanHighlightFeature',
4160
+ 'treeFeature',
4161
+ 'treeGroupFeature',
4162
+ 'versionsFeature'
4163
+ ];
4164
+
4165
+ projectStores = true;
4166
+
4167
+ dataStores = {
4168
+ 'assignmentStore': 'assignments',
4169
+ 'calendarManagerStore': 'calendars',
4170
+ 'dependencyStore': 'dependencies',
4171
+ 'eventStore': 'events',
4172
+ 'resourceStore': 'resources',
4173
+ 'taskStore': 'tasks',
4174
+ 'timeRangeStore': 'timeRanges'
4175
+ };
4176
+
4177
+ static configNames = [
4178
+ 'adopt',
4179
+ 'allowCreate',
4180
+ 'allowCreateOnlyParent',
4181
+ 'animateFilterRemovals',
4182
+ 'animateRemovingRows',
4183
+ 'ariaDescription',
4184
+ 'ariaLabel',
4185
+ 'autoAdjustTimeAxis',
4186
+ 'autoHeight',
4187
+ 'bbar',
4188
+ 'bodyCls',
4189
+ 'bubbleEvents',
4190
+ 'bufferCoef',
4191
+ 'bufferThreshold',
4192
+ 'collapsible',
4193
+ 'color',
4194
+ 'config',
4195
+ 'contentElementCls',
4196
+ 'contextMenuTriggerEvent',
4197
+ 'creationTooltip',
4198
+ 'cycleResolutionPopupClass',
4199
+ 'dataField',
4200
+ 'defaultRegion',
4201
+ 'defaultResourceImageName',
4202
+ 'dependencyIdField',
4203
+ 'destroyStore',
4204
+ 'detectCSSCompatibilityIssues',
4205
+ 'disableGridColumnIdWarning',
4206
+ 'disableGridRowModelWarning',
4207
+ 'displaySchedulingIssueResolutionPopup',
4208
+ 'dock',
4209
+ 'drawer',
4210
+ 'durationDisplayPrecision',
4211
+ 'elementAttributes',
4212
+ 'enableDeleteKey',
4213
+ 'enableRecurringEvents',
4214
+ 'enableSticky',
4215
+ 'enableTextSelection',
4216
+ 'enableTransactionalFeatures',
4217
+ 'fillLastColumn',
4218
+ 'fixedRowHeight',
4219
+ 'footer',
4220
+ 'formulaProviders',
4221
+ 'fullRowRefresh',
4222
+ 'getDateConstraints',
4223
+ 'getRowHeight',
4224
+ 'header',
4225
+ 'hideHorizontalScrollbar',
4226
+ 'hoverCls',
4227
+ 'icon',
4228
+ 'ignoreDomEventsWhileScrolling',
4229
+ 'ignoreParentReadOnly',
4230
+ 'listeners',
4231
+ 'loadMask',
4232
+ 'loadMaskDefaults',
4233
+ 'loadMaskError',
4234
+ 'localizable',
4235
+ 'managedEventSizing',
4236
+ 'maskDefaults',
4237
+ 'masked',
4238
+ 'maxDate',
4239
+ 'maxTimeAxisUnit',
4240
+ 'minDate',
4241
+ 'monitorResize',
4242
+ 'newTaskDefaults',
4243
+ 'owner',
4244
+ 'partner',
4245
+ 'plugins',
4246
+ 'preserveFocusOnDatasetChange',
4247
+ 'preserveScrollOnDatasetChange',
4248
+ 'preventTooltipOnTouch',
4249
+ 'projectProgressReporting',
4250
+ 'relayStoreEvents',
4251
+ 'resizable',
4252
+ 'resizeToFitIncludesHeader',
4253
+ 'resourceImageFolderPath',
4254
+ 'resourceImagePath',
4255
+ 'responsiveLevels',
4256
+ 'ripple',
4257
+ 'rootElement',
4258
+ 'schedulingIssueResolutionPopupClass',
4259
+ 'scrollerClass',
4260
+ 'scrollManager',
4261
+ 'showCostControls',
4262
+ 'showCreationTooltip',
4263
+ 'showDirty',
4264
+ 'showLagInTooltip',
4265
+ 'showRecurringUI',
4266
+ 'showTaskColorPickers',
4267
+ 'snapRelativeToEventStartDate',
4268
+ 'stateful',
4269
+ 'statefulEvents',
4270
+ 'stateId',
4271
+ 'stateProvider',
4272
+ 'stickyHeaders',
4273
+ 'strips',
4274
+ 'subGridConfigs',
4275
+ 'syncMask',
4276
+ 'tab',
4277
+ 'tabBarItems',
4278
+ 'taskRenderer',
4279
+ 'tbar',
4280
+ 'terminalCls',
4281
+ 'terminalSides',
4282
+ 'timeAxis',
4283
+ 'ui',
4284
+ 'visibleZoomFactor',
4285
+ 'weekStartDay',
4286
+ 'weight',
4287
+ 'zoomKeepsOriginalTimespan',
4288
+ 'zoomOnMouseWheel',
4289
+ 'zoomOnTimeAxisDoubleClick'
4290
+ ];
4291
+
4292
+ static propertyConfigNames = [
4293
+ 'alignSelf',
4294
+ 'allowDropOnEventBar',
4295
+ 'animateTreeNodeToggle',
4296
+ 'appendTo',
4297
+ 'assignments',
4298
+ 'barMargin',
4299
+ 'calendars',
4300
+ 'callOnFunctions',
4301
+ 'catchEventHandlerExceptions',
4302
+ 'cellEllipsis',
4303
+ 'cls',
4304
+ 'collapsed',
4305
+ 'column',
4306
+ 'columnLines',
4307
+ 'columns',
4308
+ 'creationTooltipTemplate',
4309
+ 'data',
4310
+ 'dataset',
4311
+ 'dependencies',
4312
+ 'disabled',
4313
+ 'displayDateFormat',
4314
+ 'emptyText',
4315
+ 'enableEventAnimations',
4316
+ 'enableUndoRedoKeys',
4317
+ 'endDate',
4318
+ 'eventColor',
4319
+ 'eventStyle',
4320
+ 'extraData',
4321
+ 'fillTicks',
4322
+ 'flex',
4323
+ 'forceFit',
4324
+ 'height',
4325
+ 'hidden',
4326
+ 'hideFooters',
4327
+ 'hideHeaders',
4328
+ 'hideRowHover',
4329
+ 'id',
4330
+ 'infiniteScroll',
4331
+ 'inputFieldAlign',
4332
+ 'insertBefore',
4333
+ 'insertFirst',
4334
+ 'keyMap',
4335
+ 'labelPosition',
4336
+ 'longPressTime',
4337
+ 'margin',
4338
+ 'maxHeight',
4339
+ 'maxWidth',
4340
+ 'maxZoomLevel',
4341
+ 'minHeight',
4342
+ 'minWidth',
4343
+ 'minZoomLevel',
4344
+ 'onAfterDependencyCreateDrop',
4345
+ 'onAfterDependencySave',
4346
+ 'onAfterDragCreate',
4347
+ 'onAfterEventEdit',
4348
+ 'onAfterEventSave',
4349
+ 'onAfterProjectEdit',
4350
+ 'onAfterProjectSave',
4351
+ 'onAfterTaskDrop',
4352
+ 'onAfterTaskEdit',
4353
+ 'onAfterTaskSave',
4354
+ 'onAfterTaskSegmentDrop',
4355
+ 'onBeforeAssignmentDelete',
4356
+ 'onBeforeCancelCellEdit',
4357
+ 'onBeforeCancelRowEdit',
4358
+ 'onBeforeCellEditStart',
4359
+ 'onBeforeCellRangeDelete',
4360
+ 'onBeforeCellRangeEdit',
4361
+ 'onBeforeColumnDragStart',
4362
+ 'onBeforeColumnDropFinalize',
4363
+ 'onBeforeColumnResize',
4364
+ 'onBeforeCopy',
4365
+ 'onBeforeCSVExport',
4366
+ 'onBeforeDependencyAdd',
4367
+ 'onBeforeDependencyCreateDrag',
4368
+ 'onBeforeDependencyCreateFinalize',
4369
+ 'onBeforeDependencyDelete',
4370
+ 'onBeforeDependencyEdit',
4371
+ 'onBeforeDependencyEditShow',
4372
+ 'onBeforeDependencySave',
4373
+ 'onBeforeDestroy',
4374
+ 'onBeforeDragCreate',
4375
+ 'onBeforeDragCreateFinalize',
4376
+ 'onBeforeEventDelete',
4377
+ 'onBeforeEventEdit',
4378
+ 'onBeforeEventEditShow',
4379
+ 'onBeforeEventResize',
4380
+ 'onBeforeEventResizeFinalize',
4381
+ 'onBeforeEventSave',
4382
+ 'onBeforeEventSegmentResize',
4383
+ 'onBeforeEventSegmentResizeFinalize',
4384
+ 'onBeforeExcelExport',
4385
+ 'onBeforeFillHandleDragStart',
4386
+ 'onBeforeFinishCellEdit',
4387
+ 'onBeforeFinishRowEdit',
4388
+ 'onBeforeHide',
4389
+ 'onBeforeMspExport',
4390
+ 'onBeforePan',
4391
+ 'onBeforePaste',
4392
+ 'onBeforePdfExport',
4393
+ 'onBeforePresetChange',
4394
+ 'onBeforeProjectEdit',
4395
+ 'onBeforeProjectEditShow',
4396
+ 'onBeforeProjectSave',
4397
+ 'onBeforeRenderRow',
4398
+ 'onBeforeRenderRows',
4399
+ 'onBeforeRowCollapse',
4400
+ 'onBeforeRowExpand',
4401
+ 'onBeforeSelectionChange',
4402
+ 'onBeforeSetRecord',
4403
+ 'onBeforeShow',
4404
+ 'onBeforeShowTerminals',
4405
+ 'onBeforeStartRowEdit',
4406
+ 'onBeforeStateApply',
4407
+ 'onBeforeStateSave',
4408
+ 'onBeforeTaskAdd',
4409
+ 'onBeforeTaskDelete',
4410
+ 'onBeforeTaskDrag',
4411
+ 'onBeforeTaskDropFinalize',
4412
+ 'onBeforeTaskEdit',
4413
+ 'onBeforeTaskEditShow',
4414
+ 'onBeforeTaskResize',
4415
+ 'onBeforeTaskResizeFinalize',
4416
+ 'onBeforeTaskSave',
4417
+ 'onBeforeTaskSegmentDrag',
4418
+ 'onBeforeTaskSegmentDropFinalize',
4419
+ 'onBeforeTaskSegmentResize',
4420
+ 'onBeforeTaskSegmentResizeFinalize',
4421
+ 'onBeforeToggleGroup',
4422
+ 'onBeforeToggleNode',
4423
+ 'onCancelCellEdit',
4424
+ 'onCatchAll',
4425
+ 'onCellClick',
4426
+ 'onCellContextMenu',
4427
+ 'onCellDblClick',
4428
+ 'onCellMenuBeforeShow',
4429
+ 'onCellMenuItem',
4430
+ 'onCellMenuShow',
4431
+ 'onCellMenuToggleItem',
4432
+ 'onCellMouseEnter',
4433
+ 'onCellMouseLeave',
4434
+ 'onCellMouseOut',
4435
+ 'onCellMouseOver',
4436
+ 'onCollapse',
4437
+ 'onCollapseNode',
4438
+ 'onColumnDrag',
4439
+ 'onColumnDragStart',
4440
+ 'onColumnDrop',
4441
+ 'onColumnResize',
4442
+ 'onColumnResizeStart',
4443
+ 'onContextMenuItem',
4444
+ 'onContextMenuToggleItem',
4445
+ 'onCopy',
4446
+ 'onCriticalPathsHighlighted',
4447
+ 'onCriticalPathsUnhighlighted',
4448
+ 'onCurrentTimelineUpdate',
4449
+ 'onDataChange',
4450
+ 'onDateRangeChange',
4451
+ 'onDependenciesDrawn',
4452
+ 'onDependencyClick',
4453
+ 'onDependencyContextMenu',
4454
+ 'onDependencyCreateDragStart',
4455
+ 'onDependencyCreateDrop',
4456
+ 'onDependencyDblClick',
4457
+ 'onDependencyMouseOut',
4458
+ 'onDependencyMouseOver',
4459
+ 'onDependencyValidationComplete',
4460
+ 'onDependencyValidationStart',
4461
+ 'onDestroy',
4462
+ 'onDirtyStateChange',
4463
+ 'onDragCreateEnd',
4464
+ 'onDragCreateStart',
4465
+ 'onDragSelecting',
4466
+ 'onElementCreated',
4467
+ 'onEventEditBeforeSetRecord',
4468
+ 'onEventMenuBeforeShow',
4469
+ 'onEventMenuItem',
4470
+ 'onEventMenuShow',
4471
+ 'onEventPartialResize',
4472
+ 'onEventResizeEnd',
4473
+ 'onEventResizeStart',
4474
+ 'onEventSegmentPartialResize',
4475
+ 'onEventSegmentResizeEnd',
4476
+ 'onEventSegmentResizeStart',
4477
+ 'onExpand',
4478
+ 'onExpandNode',
4479
+ 'onFileDrop',
4480
+ 'onFillHandleBeforeDragFinalize',
4481
+ 'onFillHandleDrag',
4482
+ 'onFillHandleDragAbort',
4483
+ 'onFillHandleDragEnd',
4484
+ 'onFillHandleDragStart',
4485
+ 'onFinishCellEdit',
4486
+ 'onFinishRowEdit',
4487
+ 'onFocusIn',
4488
+ 'onFocusOut',
4489
+ 'onGridRowBeforeDragStart',
4490
+ 'onGridRowBeforeDropFinalize',
4491
+ 'onGridRowDrag',
4492
+ 'onGridRowDragAbort',
4493
+ 'onGridRowDragStart',
4494
+ 'onGridRowDrop',
4495
+ 'onHeaderClick',
4496
+ 'onHeaderMenuBeforeShow',
4497
+ 'onHeaderMenuItem',
4498
+ 'onHeaderMenuShow',
4499
+ 'onHeaderMenuToggleItem',
4500
+ 'onHide',
4501
+ 'onLockRows',
4502
+ 'onMouseOut',
4503
+ 'onMouseOver',
4504
+ 'onMspExport',
4505
+ 'onNavigate',
4506
+ 'onNoZoomChange',
4507
+ 'onPaint',
4508
+ 'onPaste',
4509
+ 'onPdfExport',
4510
+ 'onPercentBarDrag',
4511
+ 'onPercentBarDragAbort',
4512
+ 'onPercentBarDragStart',
4513
+ 'onPercentBarDrop',
4514
+ 'onPresetChange',
4515
+ 'onProjectEditCanceled',
4516
+ 'onReadOnly',
4517
+ 'onRecompose',
4518
+ 'onReleaseTask',
4519
+ 'onRenderRow',
4520
+ 'onRenderRows',
4521
+ 'onRenderTask',
4522
+ 'onResize',
4523
+ 'onResourceAssignmentClick',
4524
+ 'onResponsive',
4525
+ 'onRowCollapse',
4526
+ 'onRowExpand',
4527
+ 'onRowMouseEnter',
4528
+ 'onRowMouseLeave',
4529
+ 'onScheduleMenuBeforeShow',
4530
+ 'onScheduleMenuItem',
4531
+ 'onScheduleMenuShow',
4532
+ 'onScroll',
4533
+ 'onScrollButtonClick',
4534
+ 'onSelectionChange',
4535
+ 'onSelectionModeChange',
4536
+ 'onShow',
4537
+ 'onSplit',
4538
+ 'onSplitterCollapseClick',
4539
+ 'onSplitterDragEnd',
4540
+ 'onSplitterDragStart',
4541
+ 'onSplitterExpandClick',
4542
+ 'onStartCellEdit',
4543
+ 'onStartRowEdit',
4544
+ 'onSubGridCollapse',
4545
+ 'onSubGridExpand',
4546
+ 'onTaskClick',
4547
+ 'onTaskContextMenu',
4548
+ 'onTaskDblClick',
4549
+ 'onTaskDrag',
4550
+ 'onTaskDragStart',
4551
+ 'onTaskDrop',
4552
+ 'onTaskEditCanceled',
4553
+ 'onTaskKeyDown',
4554
+ 'onTaskKeyUp',
4555
+ 'onTaskMenuBeforeShow',
4556
+ 'onTaskMenuItem',
4557
+ 'onTaskMenuShow',
4558
+ 'onTaskMouseDown',
4559
+ 'onTaskMouseOut',
4560
+ 'onTaskMouseOver',
4561
+ 'onTaskMouseUp',
4562
+ 'onTaskNonWorkingTimeClick',
4563
+ 'onTaskNonWorkingTimeContextMenu',
4564
+ 'onTaskNonWorkingTimeDblClick',
4565
+ 'onTaskPartialResize',
4566
+ 'onTaskResizeEnd',
4567
+ 'onTaskResizeStart',
4568
+ 'onTaskSegmentDrag',
4569
+ 'onTaskSegmentDragStart',
4570
+ 'onTaskSegmentDrop',
4571
+ 'onTaskSegmentPartialResize',
4572
+ 'onTaskSegmentResizeEnd',
4573
+ 'onTaskSegmentResizeStart',
4574
+ 'onTickSizeChange',
4575
+ 'onTimeAxisChange',
4576
+ 'onTimeAxisHeaderClick',
4577
+ 'onTimeAxisHeaderContextMenu',
4578
+ 'onTimeAxisHeaderDblClick',
4579
+ 'onTimeAxisHeaderMenuBeforeShow',
4580
+ 'onTimeAxisHeaderMenuItem',
4581
+ 'onTimeAxisHeaderMenuShow',
4582
+ 'onTimelineContextChange',
4583
+ 'onTimelineViewportResize',
4584
+ 'onTimeRangeHeaderClick',
4585
+ 'onTimeRangeHeaderContextMenu',
4586
+ 'onTimeRangeHeaderDblClick',
4587
+ 'onToggleGroup',
4588
+ 'onToggleNode',
4589
+ 'onToolClick',
4590
+ 'onTransactionChange',
4591
+ 'onUnlockRows',
4592
+ 'onUnsplit',
4593
+ 'onVisibleDateRangeChange',
4594
+ 'preserveScroll',
4595
+ 'presets',
4596
+ 'project',
4597
+ 'readOnly',
4598
+ 'recurrenceConfirmationPopup',
4599
+ 'rendition',
4600
+ 'resources',
4601
+ 'rowHeight',
4602
+ 'rowLines',
4603
+ 'rtl',
4604
+ 'scrollable',
4605
+ 'scrollTaskIntoViewOnCellClick',
4606
+ 'selectionMode',
4607
+ 'showTooltip',
4608
+ 'showUnscheduledTasks',
4609
+ 'snap',
4610
+ 'span',
4611
+ 'startDate',
4612
+ 'stateSettings',
4613
+ 'store',
4614
+ 'suppressFit',
4615
+ 'tasks',
4616
+ 'taskStore',
4617
+ 'terminalHideDelay',
4618
+ 'terminalOffset',
4619
+ 'terminalShowDelay',
4620
+ 'terminalSize',
4621
+ 'tickSize',
4622
+ 'timeRanges',
4623
+ 'timeResolution',
4624
+ 'timeZone',
4625
+ 'title',
4626
+ 'toggleParentTasksOnClick',
4627
+ 'tools',
4628
+ 'tooltipTemplate',
4629
+ 'transition',
4630
+ 'transitionDuration',
4631
+ 'useContextualRecurrenceRules',
4632
+ 'viewPreset',
4633
+ 'visibleDate',
4634
+ 'width',
4635
+ 'workingTime'
4636
+ ];
4637
+
4638
+ static propertyNames = [
4639
+ 'calendarManagerStore',
4640
+ 'focusVisible',
4641
+ 'hasChanges',
4642
+ 'originalStore',
4643
+ 'parent',
4644
+ 'scrollLeft',
4645
+ 'scrollTop',
4646
+ 'scrollX',
4647
+ 'selectedCell',
4648
+ 'selectedCells',
4649
+ 'selectedRecord',
4650
+ 'selectedRecords',
4651
+ 'selectedRows',
4652
+ 'state',
4653
+ 'tooltip',
4654
+ 'zoomLevel'
4655
+ ];
4656
+
4657
+ // Component instance
4658
+ instance!: GanttBase;
4659
+
4660
+ // Component element
4661
+ element! : HTMLElement;
4662
+
4663
+ componentDidMount(): void {
4664
+ this.instance = createWidget(this);
4665
+ }
4666
+
4667
+ componentWillUnmount(): void {
4668
+ // @ts-ignore
4669
+ this.instance?.destroy?.();
4670
+ }
4671
+
4672
+ /**
4673
+ * Component about to be updated, from changing a prop using state.
4674
+ * React to it depending on what changed and prevent react from re-rendering our component.
4675
+ * @param nextProps
4676
+ * @param nextState
4677
+ * @returns {boolean}
4678
+ */
4679
+ shouldComponentUpdate(nextProps: Readonly<BryntumGanttBaseProps>, nextState: Readonly<{}>): boolean {
4680
+ return shouldComponentUpdate(this, nextProps, nextState);
4681
+ }
4682
+
4683
+ render(): React.ReactNode {
4684
+
4685
+ const className = `b-react-gantt-base-container`;
4686
+ return (
4687
+ <React.Fragment>
4688
+ <div className={className} ref={(element) => (this.element = element!)}>
4689
+ {Array.from(this.state.portals).map((item) => item[1])}
4690
+ </div>
4691
+ <div ref={el => (this.portalsCache = el!)} className="b-react-portals-cache" style={{ display : 'none' }}></div>
4692
+ </React.Fragment>
4693
+ );
4694
+
4695
+ }
4696
+ }