@bryntum/scheduler-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 (56) hide show
  1. package/README.md +52 -0
  2. package/lib/BryntumEventColorField.d.ts +232 -0
  3. package/lib/BryntumEventColorField.js +169 -0
  4. package/lib/BryntumEventColorField.js.map +1 -0
  5. package/lib/BryntumProjectCombo.d.ts +268 -0
  6. package/lib/BryntumProjectCombo.js +203 -0
  7. package/lib/BryntumProjectCombo.js.map +1 -0
  8. package/lib/BryntumResourceCombo.d.ts +268 -0
  9. package/lib/BryntumResourceCombo.js +203 -0
  10. package/lib/BryntumResourceCombo.js.map +1 -0
  11. package/lib/BryntumResourceFilter.d.ts +215 -0
  12. package/lib/BryntumResourceFilter.js +154 -0
  13. package/lib/BryntumResourceFilter.js.map +1 -0
  14. package/lib/BryntumScheduler.d.ts +2039 -0
  15. package/lib/BryntumScheduler.js +642 -0
  16. package/lib/BryntumScheduler.js.map +1 -0
  17. package/lib/BryntumSchedulerBase.d.ts +2038 -0
  18. package/lib/BryntumSchedulerBase.js +641 -0
  19. package/lib/BryntumSchedulerBase.js.map +1 -0
  20. package/lib/BryntumSchedulerDatePicker.d.ts +314 -0
  21. package/lib/BryntumSchedulerDatePicker.js +216 -0
  22. package/lib/BryntumSchedulerDatePicker.js.map +1 -0
  23. package/lib/BryntumSchedulerProjectModel.d.ts +91 -0
  24. package/lib/BryntumSchedulerProjectModel.js +98 -0
  25. package/lib/BryntumSchedulerProjectModel.js.map +1 -0
  26. package/lib/BryntumTimelineHistogram.d.ts +1185 -0
  27. package/lib/BryntumTimelineHistogram.js +448 -0
  28. package/lib/BryntumTimelineHistogram.js.map +1 -0
  29. package/lib/BryntumUndoRedo.d.ts +190 -0
  30. package/lib/BryntumUndoRedo.js +152 -0
  31. package/lib/BryntumUndoRedo.js.map +1 -0
  32. package/lib/BryntumViewPresetCombo.d.ts +216 -0
  33. package/lib/BryntumViewPresetCombo.js +158 -0
  34. package/lib/BryntumViewPresetCombo.js.map +1 -0
  35. package/lib/WrapperHelper.d.ts +26 -0
  36. package/lib/WrapperHelper.js +569 -0
  37. package/lib/WrapperHelper.js.map +1 -0
  38. package/lib/index.d.ts +11 -0
  39. package/lib/index.js +12 -0
  40. package/lib/index.js.map +1 -0
  41. package/license.pdf +0 -0
  42. package/licenses.md +310 -0
  43. package/package.json +25 -0
  44. package/src/BryntumEventColorField.tsx +996 -0
  45. package/src/BryntumProjectCombo.tsx +1233 -0
  46. package/src/BryntumResourceCombo.tsx +1236 -0
  47. package/src/BryntumResourceFilter.tsx +931 -0
  48. package/src/BryntumScheduler.tsx +5184 -0
  49. package/src/BryntumSchedulerBase.tsx +5182 -0
  50. package/src/BryntumSchedulerDatePicker.tsx +1365 -0
  51. package/src/BryntumSchedulerProjectModel.tsx +424 -0
  52. package/src/BryntumTimelineHistogram.tsx +3427 -0
  53. package/src/BryntumUndoRedo.tsx +886 -0
  54. package/src/BryntumViewPresetCombo.tsx +915 -0
  55. package/src/WrapperHelper.tsx +1125 -0
  56. package/src/index.ts +15 -0
@@ -0,0 +1,3427 @@
1
+ /**
2
+ * React wrapper for Bryntum TimelineHistogram
3
+ */
4
+ // eslint-disable-next-line @typescript-eslint/no-unused-vars
5
+ import React, { RefObject } from 'react';
6
+ import { AjaxStore, AjaxStoreConfig, Base, Container, DomConfig, DurationUnit, FormulaProviderConfig, Histogram, HistogramConfig, HistogramSeries, KeyMapConfig, Mask, MaskConfig, Menu, MenuItem, MenuItemEntry, Model, ModelConfig, PagingToolbarConfig, Panel, PanelCollapserConfig, PanelCollapserOverlayConfig, PanelHeader, ScrollManager, ScrollManagerConfig, Scroller, ScrollerConfig, StateProvider, Store, StoreConfig, TabConfig, Tool, ToolConfig, ToolbarConfig, ToolbarItems, Tooltip, TooltipConfig, Widget } from '@bryntum/core-thin';
7
+ import { AIFilter, AIFilterConfig, CellCopyPaste, CellCopyPasteConfig, CellEdit, CellEditConfig, CellEditorContext, CellMenu, CellMenuConfig, CellTooltip, CellTooltipConfig, Charts, ChartsConfig, Column, ColumnAutoWidth, ColumnAutoWidthConfig, ColumnDragToolbar, ColumnDragToolbarConfig, ColumnPicker, ColumnPickerConfig, ColumnRename, ColumnRenameConfig, ColumnReorder, ColumnReorderConfig, ColumnResize, ColumnResizeConfig, ColumnStore, ColumnStoreConfig, EmptyTextDomConfig, ExcelExporter as GridExcelExporter, ExcelExporterConfig as GridExcelExporterConfig, ExportConfig, FileDrop, FileDropConfig, FillHandle, FillHandleConfig, Filter, FilterBar, FilterBarConfig, FilterConfig, Grid, GridBase, GridLocation, GridLocationConfig, GridSelectionMode, GridStateInfo, Group, GroupConfig, HeaderMenu, HeaderMenuConfig, LockRows as GridLockRows, LockRowsConfig as GridLockRowsConfig, MergeCells, MergeCellsConfig, PdfExport as GridPdfExport, PdfExportConfig as GridPdfExportConfig, PinColumns, PinColumnsConfig, PreserveScrollOptions, Print as GridPrint, PrintConfig as GridPrintConfig, QuickFind, QuickFindConfig, RecordPositionContext, RegionResize, RegionResizeConfig, ResponsiveLevelConfig, Row, RowCopyPaste, RowCopyPasteConfig, RowEdit, RowEditConfig, RowEditorContext, RowExpander, RowExpanderConfig, RowResize as GridRowResize, RowResizeConfig as GridRowResizeConfig, Search, SearchConfig, Sort, SortConfig, StickyCells, StickyCellsConfig, Stripe, StripeConfig, SubGrid, SubGridConfig, Tree, TreeConfig, TreeGroup, TreeGroupConfig, XLSColumn } from '@bryntum/grid-thin';
8
+ import { AssignmentModel, ColumnLines, ColumnLinesConfig, SchedulerContainerItemConfig, EventColor, EventModel, SchedulerColumnConfig, GroupSummary, GroupSummaryConfig, HeaderZoom, HeaderZoomConfig, HistogramRenderData, NonWorkingTime, NonWorkingTimeConfig, Pan, PanConfig, PresetStore, RecurrenceConfirmationPopup, RecurrenceConfirmationPopupConfig, ResourceMenu, ResourceMenuConfig, ResourceModel, ResourceTimeRangeModel, ResourceTimeRanges, ResourceTimeRangesConfig, RowReorder, RowReorderConfig, ScaleColumnConfig, ScalePoint, ScheduleTooltip, ScheduleTooltipConfig, Scheduler, Split, SplitConfig, Summary, SummaryConfig, TimeAxis, TimeAxisColumn, TimeAxisConfig, TimeAxisHeaderMenu, TimeAxisHeaderMenuConfig, TimeRanges, TimeRangesConfig, TimeSpan, TimelineBase, TimelineContext, TimelineHistogram, TimelineHistogramListeners, TimelineStateInfo, VerticalTimeAxisColumn, ViewPreset, ViewPresetConfig, VisibleDate } from '@bryntum/scheduler-thin';
9
+
10
+ import { createWidget, shouldComponentUpdate, processWidgetContent } from './WrapperHelper.js';
11
+
12
+ export type BryntumTimelineHistogramProps = {
13
+ // Configs
14
+ /**
15
+ * Element (or element id) to adopt as this Widget's encapsulating element. The widget's
16
+ * content will be placed inside this element.
17
+ * ...
18
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-adopt)
19
+ */
20
+ adopt? : HTMLElement|string
21
+ /**
22
+ * A function used for aggregating child records histogram data entries to their parent entry.
23
+ * ...
24
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-aggregateDataEntry)
25
+ * @param {object} aggregateDataEntry.aggregated Target parent data entry to aggregate the entry into.
26
+ * @param {object} aggregateDataEntry.entry Current entry to aggregate into `aggregated`.
27
+ * @param {number} aggregateDataEntry.arrayIndex Index of current array (index of the record among other records being aggregated).
28
+ * @param {object[]} aggregateDataEntry.entryIndex Index of `entry` in the current array.
29
+ * @returns {object} Return value becomes the value of the `aggregated` parameter on the next invocation of this function.
30
+ */
31
+ aggregateDataEntry? : ((aggregateDataEntry: { aggregated: object, entry: object, arrayIndex: number, entryIndex: object[] }) => object)|string
32
+ /**
33
+ * When `true` the component will automatically calculate data for group records
34
+ * based on the groups members data by calling [getGroupRecordHistogramData](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineHistogramGrouping#function-getGroupRecordHistogramData) method.
35
+ */
36
+ aggregateHistogramDataForGroups? : boolean
37
+ /**
38
+ * When this widget is a child of a [Container](https://bryntum.com/products/scheduler/docs/api/Core/widget/Container), it will by default be participating in a
39
+ * flexbox layout. This config allows you to set this widget's
40
+ * [align-self](https://developer.mozilla.org/en-US/docs/Web/CSS/align-self) style.
41
+ */
42
+ alignSelf? : string
43
+ /**
44
+ * Set to `true` to animate row removals caused by filtering.
45
+ * @deprecated 7.0.0 Deprecated `animateFilterRemovals`. Use `transition.filterRemoval` instead
46
+ */
47
+ animateFilterRemovals? : boolean
48
+ /**
49
+ * Controls if removing and inserting rows should be animated. Set to `false` to prevent those animations,
50
+ * removing the related delays.
51
+ * @deprecated 7.0.0 Deprecated `animateRemovingRows`. Use `transition.removeRecord` instead
52
+ */
53
+ animateRemovingRows? : boolean
54
+ /**
55
+ * When the [Tree](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Tree) feature is in use and the Store is a tree store, this
56
+ * config may be set to `true` to visually animate branch node expand and collapse operations.
57
+ * *This is not supported in Scheduler and Gantt*
58
+ * @deprecated 7.0.0 Deprecated `animateTreeNodeToggle`. Use `transition.toggleTreeNode` instead
59
+ */
60
+ animateTreeNodeToggle? : boolean
61
+ /**
62
+ * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
63
+ * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-element).
64
+ */
65
+ appendTo? : HTMLElement|string
66
+ /**
67
+ * A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject
68
+ * into an element which will be linked using the `aria-describedby` attribute.
69
+ * ...
70
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-ariaDescription)
71
+ */
72
+ ariaDescription? : string
73
+ /**
74
+ * A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject as
75
+ * the `aria-label` attribute.
76
+ * ...
77
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-ariaLabel)
78
+ */
79
+ ariaLabel? : string
80
+ /**
81
+ * You can set this option to `false` to make the timeline panel start and end on the exact provided
82
+ * [startDate](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineBase#config-startDate)/[endDate](#Scheduler/view/TimelineBase#config-endDate) w/o adjusting them.
83
+ */
84
+ autoAdjustTimeAxis? : boolean
85
+ /**
86
+ * Automatically set grids height to fit all rows (no scrolling in the grid). In general you should avoid
87
+ * using `autoHeight: true`, since it will bypass Grids virtual rendering and render all rows at once, which
88
+ * in a larger grid is really bad for performance.
89
+ */
90
+ autoHeight? : boolean
91
+ /**
92
+ * Controls how much space to leave between stacked event bars in px.
93
+ * ...
94
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-barMargin)
95
+ */
96
+ barMargin? : number
97
+ /**
98
+ * A Function which returns the tooltip text to display when hovering a bar.
99
+ * The following parameters are passed:
100
+ * @param {object} context The tooltip context info
101
+ * @param {object} context.datum The histogram bar being hovered info
102
+ * @param {Core.widget.Tooltip} context.tip The tooltip instance
103
+ * @param {HTMLElement} context.element The Element for which the Tooltip is monitoring mouse movement
104
+ * @param {HTMLElement} context.activeTarget The target element that triggered the show
105
+ * @param {Event} context.event The raw DOM event
106
+ * @param {Core.data.Model} context.record The record which value the hovered bar displays.
107
+ * @returns {string} Tooltip HTML content
108
+ */
109
+ barTooltipTemplate? : (context: { datum: object, tip: Tooltip, element: HTMLElement, activeTarget: HTMLElement, event: Event, record: Model }) => string
110
+ /**
111
+ * A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/scheduler/docs/api/Core/widget/Toolbar),
112
+ * 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/scheduler/docs/api/Core/widget/Panel#config-strips).
113
+ * ...
114
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-bbar)
115
+ */
116
+ bbar? : (SchedulerContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
117
+ /**
118
+ * Custom CSS classes to add to the panel's body element.
119
+ * ...
120
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-bodyCls)
121
+ */
122
+ bodyCls? : string|object
123
+ /**
124
+ * An object where property names with a truthy value indicate which events should bubble up the ownership
125
+ * hierarchy when triggered.
126
+ * ...
127
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-bubbleEvents)
128
+ */
129
+ bubbleEvents? : object
130
+ /**
131
+ * This config defines the size of the start and end invisible parts of the timespan when [infiniteScroll](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineScroll#config-infiniteScroll) set to `true`.
132
+ * ...
133
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-bufferCoef)
134
+ */
135
+ bufferCoef? : number
136
+ /**
137
+ * This config defines the scroll limit, which, when exceeded will cause a timespan shift.
138
+ * The limit is calculated as the `panelWidth * [bufferCoef](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineScroll#config-bufferCoef) * bufferThreshold`. During scrolling, if the left or right side
139
+ * has less than that of the rendered content - a shift is triggered.
140
+ * ...
141
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-bufferThreshold)
142
+ */
143
+ bufferThreshold? : number
144
+ /**
145
+ * Set to `false` to not call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
146
+ * ...
147
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-callOnFunctions)
148
+ */
149
+ callOnFunctions? : boolean
150
+ /**
151
+ * By default, if an event handler throws an exception, the error propagates up the stack and the
152
+ * application state is undefined. Code which follows the event handler will *not* be executed.
153
+ * ...
154
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-catchEventHandlerExceptions)
155
+ */
156
+ catchEventHandlerExceptions? : boolean
157
+ /**
158
+ * Set to `false` to crop text in grid cells without ellipsis (...). When enabled, cells containing pure
159
+ * use `display : block`, instead of `display : flex` to allow ellipsis to work.
160
+ * <strong>NOTE</strong> Only supported in browsers that support `:has()` CSS selector
161
+ */
162
+ cellEllipsis? : boolean
163
+ /**
164
+ * Custom CSS classes to add to element.
165
+ * May be specified as a space separated string, or as an object in which property names
166
+ * with truthy values are used as the class names:
167
+ * ...
168
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-cls)
169
+ */
170
+ cls? : string|object
171
+ /**
172
+ * Controls whether the panel is collapsed (the body of the panel is hidden while only the header is
173
+ * visible). Only valid if the panel is [collapsible](https://bryntum.com/products/scheduler/docs/api/Core/widget/Panel#config-collapsible).
174
+ */
175
+ collapsed? : boolean
176
+ /**
177
+ * This config enables collapsibility for the panel. See [collapsed](https://bryntum.com/products/scheduler/docs/api/Core/widget/Panel#config-collapsed).
178
+ * ...
179
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-collapsible)
180
+ */
181
+ collapsible? : boolean|PanelCollapserConfig|PanelCollapserOverlayConfig
182
+ /**
183
+ * Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
184
+ * `style` block.
185
+ * ...
186
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-color)
187
+ */
188
+ color? : string
189
+ /**
190
+ * Programmatic control over which column to start in when used in a grid layout.
191
+ */
192
+ column? : number
193
+ /**
194
+ * Set to `false` to not show column lines. End result might be overruled by/differ between themes.
195
+ */
196
+ columnLines? : boolean
197
+ /**
198
+ * Accepts column definitions for the grid during initialization. They will be used to create
199
+ * [Column](https://bryntum.com/products/scheduler/docs/api/Grid/column/Column) instances that are added to a [ColumnStore](#Grid/data/ColumnStore).
200
+ * ...
201
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-columns)
202
+ */
203
+ columns? : ColumnStore|SchedulerColumnConfig[]|ColumnStoreConfig
204
+ config? : object
205
+ /**
206
+ * Custom CSS classes to add to the [contentElement](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-contentElement).
207
+ * May be specified as a space separated string, or as an object in which property names
208
+ * with truthy values are used as the class names:
209
+ * ...
210
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-contentElementCls)
211
+ */
212
+ contentElementCls? : string|object
213
+ /**
214
+ * Event which is used to show context menus.
215
+ * Available options are: 'contextmenu', 'click', 'dblclick'.
216
+ */
217
+ contextMenuTriggerEvent? : 'contextmenu'|'click'|'dblclick'
218
+ /**
219
+ * Convenient shortcut to set data in grids store both during initialization and at runtime. Can also be
220
+ * used to retrieve data at runtime, although we do recommend interacting with Grids store instead using
221
+ * the [store](https://bryntum.com/products/scheduler/docs/api/Grid/view/GridBase#property-store) property.
222
+ * ...
223
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-data)
224
+ */
225
+ data? : object[]|Model[]|ModelConfig[]
226
+ /**
227
+ * When this Widget configuration is used in the Grid's RowExpander feature's `widget` config, provide the
228
+ * field on the expanded record to use for populating this widget's store (if applicable)
229
+ */
230
+ dataField? : string
231
+ /**
232
+ * Record field from which the histogram data will be collected.
233
+ * ...
234
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-dataModelField)
235
+ */
236
+ dataModelField? : string
237
+ /**
238
+ * Object to apply to elements dataset (each key will be used as a data-attribute on the element)
239
+ */
240
+ dataset? : Record<string, string>
241
+ /**
242
+ * Region to which columns are added when they have none specified
243
+ */
244
+ defaultRegion? : string
245
+ /**
246
+ * Set to `true` to destroy the store when the grid is destroyed.
247
+ */
248
+ destroyStore? : boolean
249
+ /**
250
+ * Check for CSS compatibility issues when upgrading to v7. Performs the following checks:
251
+ * ...
252
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-detectCSSCompatibilityIssues)
253
+ */
254
+ detectCSSCompatibilityIssues? : boolean
255
+ /**
256
+ * Disable or enable the widget. It is similar to [readOnly](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-readOnly) except a disabled widget
257
+ * cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
258
+ * ...
259
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-disabled)
260
+ */
261
+ disabled? : boolean|'inert'
262
+ /**
263
+ * Set to `true` to not get a warning when calling [getState](https://bryntum.com/products/scheduler/docs/api/Grid/view/GridBase#function-getState) when there is a column
264
+ * configured without an `id`. But the recommended action is to always configure columns with an `id` when
265
+ * using states.
266
+ */
267
+ disableGridColumnIdWarning? : boolean
268
+ /**
269
+ * Set to `true` to not get a warning when using another base class than GridRowModel for your grid data. If
270
+ * you do, and would like to use the full feature set of the grid then include the fields from GridRowModel
271
+ * in your model definition.
272
+ */
273
+ disableGridRowModelWarning? : boolean
274
+ /**
275
+ * Defines how dates will be formatted in tooltips etc. This config has priority over similar config on the
276
+ * view preset. For allowed values see [format](https://bryntum.com/products/scheduler/docs/api/Core/helper/DateHelper#function-format-static).
277
+ * ...
278
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-displayDateFormat)
279
+ */
280
+ displayDateFormat? : string
281
+ /**
282
+ * Controls the placement of this widget when it is added to a [panel's ](https://bryntum.com/products/scheduler/docs/api/Core/widget/Panel)
283
+ * [strips collection](https://bryntum.com/products/scheduler/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
284
+ * `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
285
+ * body. Such widgets are called "edge strips".
286
+ * ...
287
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-dock)
288
+ */
289
+ dock? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
290
+ /**
291
+ * Make this Panel a docked drawer which slides out from one side of the browser viewport by default.
292
+ * ...
293
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-drawer)
294
+ * @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.
295
+ * @param {string,number} size The size of the drawer in its collapsible axis.
296
+ * @param {boolean} inline If using the [appendTo](https://bryntum.com/products/scheduler/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.
297
+ * @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.
298
+ * @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.
299
+ * @param {boolean,string} autoClose.focusout If focus moves outside of the drawer, the drawer will automatically be hidden.
300
+ * @param {string} autoClose.mouseout Hides the drawer when the mouse leaves the drawer after the `autoCloseDelay` period.
301
+ * @param {number} autoCloseDelay When using `mouseout`, this is the delay in milliseconds
302
+ */
303
+ 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}
304
+ /**
305
+ * Decimal precision used when displaying durations, used by tooltips and DurationColumn.
306
+ * Specify `false` to use raw value
307
+ */
308
+ durationDisplayPrecision? : number|boolean
309
+ /**
310
+ * An object specifying attributes to assign to the root element of this widget.
311
+ * Set `null` value to attribute to remove it.
312
+ * ...
313
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-elementAttributes)
314
+ */
315
+ elementAttributes? : Record<string, string|null>
316
+ /**
317
+ * Text or HTML, or a [EmptyTextDomConfig](https://bryntum.com/products/scheduler/docs/api/Grid/view/GridBase#typedef-EmptyTextDomConfig) block to display when there is no data to display in the grid.
318
+ * When using multiple Grid regions, provide the `region` property to decide where the text is shown.
319
+ * By default, it is shown in the first region.
320
+ * ...
321
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-emptyText)
322
+ */
323
+ emptyText? : string|EmptyTextDomConfig
324
+ /**
325
+ * Set to `false` if you don't want event bar DOM updates to animate.
326
+ * @deprecated 7.0.0 Deprecated `enableEventAnimations`. Use `transition.changeEvent` instead
327
+ */
328
+ enableEventAnimations? : boolean
329
+ /**
330
+ * Enables showing occurrences of recurring events across the scheduler's time axis. If you want to disable
331
+ * the recurrence popup, you can choose set the `defaultAction` to `future` to affect all future
332
+ * occurrences, or `single` to just affect the currently selected event.
333
+ * ...
334
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-enableRecurringEvents)
335
+ */
336
+ enableRecurringEvents? : boolean|{
337
+ defaultAction?: 'single'|'future'
338
+ }
339
+ /**
340
+ * Configure this as `true` to allow elements within cells to be styled as `position: sticky`.
341
+ * ...
342
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-enableSticky)
343
+ */
344
+ enableSticky? : boolean
345
+ /**
346
+ * Set to `true` to allow text selection in the grid cells. Note, this cannot be used simultaneously with the
347
+ * `RowReorder` feature.
348
+ */
349
+ enableTextSelection? : boolean
350
+ /**
351
+ * Set to `true` to listen for CTRL-Z (CMD-Z on Mac OS) keyboard event and trigger undo (redo when SHIFT is
352
+ * pressed). Only applicable when using a [StateTrackingManager](https://bryntum.com/products/scheduler/docs/api/Core/data/stm/StateTrackingManager).
353
+ */
354
+ enableUndoRedoKeys? : boolean
355
+ /**
356
+ * The end date of the timeline (if not configure with [infiniteScroll](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineBase#config-infiniteScroll)).
357
+ * ...
358
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-endDate)
359
+ */
360
+ endDate? : Date|string
361
+ /**
362
+ * Event color used by default. Events and resources can specify their own color, with priority order being:
363
+ * Event -&gt; Resource -&gt; Scheduler default.
364
+ * ...
365
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-eventColor)
366
+ */
367
+ eventColor? : EventColor
368
+ /**
369
+ * Event style used by default. Events and resources can specify their own style, with priority order being:
370
+ * Event -&gt; Resource -&gt; Scheduler default. Determines the appearance of the event by assigning a CSS class
371
+ * to it. Available styles are:
372
+ * ...
373
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-eventStyle)
374
+ */
375
+ eventStyle? : 'tonal'|'filled'|'bordered'|'traced'|'outlined'|'indented'|'line'|'dashed'|'minimal'|'rounded'|'calendar'|'interday'|'gantt'|null
376
+ extraData? : any
377
+ /**
378
+ * Set to `true` to stretch the last column in a grid with all fixed width columns
379
+ * to fill extra available space if the grid's width is wider than the sum of all
380
+ * configured column widths.
381
+ */
382
+ fillLastColumn? : boolean
383
+ /**
384
+ * Specify `true` to force rendered events/tasks to fill entire ticks. This only affects rendering, start
385
+ * and end dates retain their value on the data level.
386
+ * ...
387
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-fillTicks)
388
+ */
389
+ fillTicks? : boolean
390
+ /**
391
+ * Use fixed row height. Setting this to `true` will configure the underlying RowManager to use fixed row
392
+ * height, which sacrifices the ability to use rows with variable height to gain a fraction better
393
+ * performance.
394
+ * ...
395
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-fixedRowHeight)
396
+ */
397
+ fixedRowHeight? : boolean
398
+ /**
399
+ * When this widget is a child of a [Container](https://bryntum.com/products/scheduler/docs/api/Core/widget/Container), it will by default be participating in a
400
+ * flexbox layout. This config allows you to set this widget's
401
+ * [flex](https://developer.mozilla.org/en-US/docs/Web/CSS/flex) style.
402
+ * This may be configured as a single number or a `&lt;flex-grow&gt; &lt;flex-shrink&gt; &lt;flex-basis&gt;` format string.
403
+ * numeric-only values are interpreted as the `flex-grow` value.
404
+ */
405
+ flex? : number|string
406
+ /**
407
+ * Config object of a footer. May contain a `dock`, `html` and a `cls` property. A footer is not a widget,
408
+ * but rather plain HTML that follows the last element of the panel's body and [strips](https://bryntum.com/products/scheduler/docs/api/Core/widget/Panel#config-strips).
409
+ * ...
410
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-footer)
411
+ */
412
+ footer? : {
413
+ dock?: 'top'|'right'|'bottom'|'left'|'start'|'end'
414
+ html?: string
415
+ cls?: string
416
+ }|string
417
+ /**
418
+ * Set to `true` to force the time columns to fit to the available space (horizontal or vertical depends on mode).
419
+ * Note that setting [suppressFit](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineBase#config-suppressFit) to `true`, will disable `forceFit` functionality. Zooming
420
+ * cannot be used when `forceFit` is set.
421
+ */
422
+ forceFit? : boolean
423
+ /**
424
+ * An object which names formula prefixes which will be applied to all columns configured with
425
+ * `formula : true`.
426
+ * ...
427
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-formulaProviders)
428
+ */
429
+ formulaProviders? : Record<string, FormulaProviderConfig>
430
+ /**
431
+ * Refresh entire row when a record changes (`true`) or, if possible, only the cells affected (`false`).
432
+ * ...
433
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-fullRowRefresh)
434
+ */
435
+ fullRowRefresh? : boolean
436
+ /**
437
+ * A Function which returns a CSS class name to add to a rectangle element.
438
+ * The following parameters are passed:
439
+ * @param {HistogramSeries} series The series being rendered
440
+ * @param {DomConfig} domConfig The rectangle configuration object
441
+ * @param {object} datum The datum being rendered
442
+ * @param {number} index The index of the datum being rendered
443
+ * @param {HistogramRenderData} renderData Current render data giving access to the record, row and cell being rendered.
444
+ * @returns {string} CSS classes of the rectangle element
445
+ */
446
+ getBarClass? : (series: HistogramSeries, domConfig: DomConfig, datum: object, index: number, renderData: HistogramRenderData) => string
447
+ /**
448
+ * A Function which if provided should return a DOM configuration object for a bar
449
+ * (a `RECT` element representing a single "bar"-type value).
450
+ * The function is passed a default prepared DOM configuration
451
+ * in an argument which then can be processed and returned.
452
+ * ...
453
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-getBarDOMConfig)
454
+ * @param {HistogramSeries} series The series being rendered
455
+ * @param {DomConfig} domConfig The rectangle DOM configuration object
456
+ * @param {object} datum The datum being rendered
457
+ * @param {number} index The index of the datum being rendered
458
+ * @param {HistogramRenderData} renderData Current render data giving access to the record, row and cell being rendered.
459
+ * @returns {object} Resulting DOM configuration object. If no value returned the bar is not displayed.
460
+ */
461
+ getBarDOMConfig? : (series: HistogramSeries, domConfig: DomConfig, datum: object, index: number, renderData: HistogramRenderData) => object
462
+ /**
463
+ * A Function which returns the text to render inside a bar.
464
+ * ...
465
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-getBarText)
466
+ * @param {object} datum The datum being rendered
467
+ * @param {number} index The index of the datum being rendered
468
+ * @param {HistogramSeries} series The series (provided if histogram widget [singleTextForAllBars](https://bryntum.com/products/scheduler/docs/api/Core/widget/graph/Histogram#config-singleTextForAllBars) is `false`)
469
+ * @param {HistogramRenderData} renderData Current render data giving access to the record, row and cell being rendered.
470
+ * @returns {string} Text to render inside the bar
471
+ */
472
+ getBarText? : (datum: object, index: number, series: HistogramSeries, renderData: HistogramRenderData) => string
473
+ /**
474
+ * A Function which returns a DOM configuration object for text elements.
475
+ * ...
476
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-getBarTextDOMConfig)
477
+ * @param {DomConfig} domConfig The `TEXT` element DOM configuration object
478
+ * @param {object} datum The datum being rendered
479
+ * @param {number} index The index of the datum being rendered
480
+ * @param {HistogramSeries} series The series (provided if histogram widget [singleTextForAllBars](https://bryntum.com/products/scheduler/docs/api/Core/widget/graph/Histogram#config-singleTextForAllBars) is `false`)
481
+ * @param {HistogramRenderData} renderData Current render data giving access to the record, row and cell being rendered.
482
+ * @returns {object} The `TEXT` element DOM configuration object. If no value returned the text element is not displayed.
483
+ */
484
+ getBarTextDOMConfig? : (domConfig: DomConfig, datum: object, index: number, series: HistogramSeries, renderData: HistogramRenderData) => object
485
+ /**
486
+ * Function that extracts a record histogram data entry for aggregating.
487
+ * By default it returns the entry as is. Override the function if you need a more complex way
488
+ * to retrieve the value for aggregating.
489
+ * ...
490
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-getDataEntryForAggregating)
491
+ * @param {object} getDataEntryForAggregating.entry Current data entry.
492
+ * @returns {object} Entry to aggregate
493
+ */
494
+ getDataEntryForAggregating? : ((getDataEntryForAggregating: { entry: object }) => object)|string
495
+ /**
496
+ * A Function which returns a CSS class name to add to a path element
497
+ * built for an `outline` type series.
498
+ * The following parameters are passed:
499
+ * @param {HistogramSeries} series The series being rendered
500
+ * @param {object[]} data The series data
501
+ * @param {HistogramRenderData} renderData Current render data giving access to the record, row and cell being rendered.
502
+ * @returns {string} CSS class name of the path element
503
+ */
504
+ getOutlineClass? : (series: HistogramSeries, data: object[], renderData: HistogramRenderData) => string
505
+ /**
506
+ * A Function which if provided should return a DOM configuration object for
507
+ * a `path` element built for an `outline` type series.
508
+ * The function accepts a default prepared DOM configuration
509
+ * in an argument which then can be processed and returned.
510
+ * ...
511
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-getOutlineDOMConfig)
512
+ * @param {HistogramSeries} series The series being rendered
513
+ * @param {DomConfig} domConfig The `path` element DOM configuration object
514
+ * @param {object[]} data The series data
515
+ * @returns {object} Resulting DOM configuration object. If no value returned the path is not displayed.
516
+ */
517
+ getOutlineDOMConfig? : (series: HistogramSeries, domConfig: DomConfig, data: object[]) => object
518
+ /**
519
+ * A function, or name of a function which builds histogram data for the provided record.
520
+ * ...
521
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-getRecordData)
522
+ * @param {Core.data.Model} getRecordData.record Record to get histogram data for.
523
+ * @param {object} aggregationContext Context object passed in case the data is being retrieved as a part of some parent record data collecting.
524
+ * @returns {object} Histogram data.
525
+ */
526
+ getRecordData? : ((getRecordData: { record: Model }, aggregationContext?: object) => object)|string
527
+ /**
528
+ * A function called for each row to determine its height. It is passed a [record](https://bryntum.com/products/scheduler/docs/api/Core/data/Model) and
529
+ * expected to return the desired height of that records row. If the function returns a falsy value, Grids
530
+ * configured [rowHeight](https://bryntum.com/products/scheduler/docs/api/Grid/view/GridBase#config-rowHeight) is used.
531
+ * ...
532
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-getRowHeight)
533
+ * @param {Core.data.Model} getRowHeight.record Record to determine row height for
534
+ * @returns {number} Desired row height
535
+ */
536
+ getRowHeight? : (getRowHeight: { record: Model }) => number
537
+ /**
538
+ * When set to `true` (default) the component reacts on time axis changes
539
+ * (zooming or changing the displayed time span), clears the histogram data cache of the records
540
+ * and then refreshes the view.
541
+ */
542
+ hardRefreshOnTimeAxisReconfigure? : boolean
543
+ /**
544
+ * A config [object](https://bryntum.com/products/scheduler/docs/api/Core/widget/Panel#typedef-PanelHeader) for the panel's header or a string in place of a `title`.
545
+ * ...
546
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-header)
547
+ */
548
+ header? : string|boolean|PanelHeader
549
+ /**
550
+ * Widget's height, used to set element `style.height`. Either specify a valid height string or a number,
551
+ * which will get 'px' appended. We recommend using CSS as the primary way to control height, but in some
552
+ * cases this config is convenient.
553
+ */
554
+ height? : string|number
555
+ /**
556
+ * Configure with true to make widget initially hidden.
557
+ */
558
+ hidden? : boolean
559
+ /**
560
+ * Set to `true` to hide the footer elements
561
+ */
562
+ hideFooters? : boolean
563
+ /**
564
+ * Set to `true` to hide the column header elements
565
+ */
566
+ hideHeaders? : boolean
567
+ /**
568
+ * Set to `true` to hide the Grid's horizontal scrollbar(s)
569
+ */
570
+ hideHorizontalScrollbar? : boolean
571
+ /**
572
+ * By default the row hover effect is not visible in the Scheduler part of the grid.
573
+ * ...
574
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-hideRowHover)
575
+ */
576
+ hideRowHover? : boolean
577
+ /**
578
+ * An instance or a configuration object of the underlying [Histogram](https://bryntum.com/products/scheduler/docs/api/Core/widget/graph/Histogram)
579
+ * component that is used under the hood to render actual charts.
580
+ * In case a configuration object is provided the built class is defined with
581
+ * [histogramWidgetClass](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogramBase#config-histogramWidgetClass) config.
582
+ */
583
+ histogramWidget? : Histogram|HistogramConfig
584
+ /**
585
+ * The class used for building the [histogram widget](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogramBase#property-histogramWidget)
586
+ */
587
+ histogramWidgetClass? : Histogram
588
+ /**
589
+ * A CSS class to add to hovered row elements
590
+ */
591
+ hoverCls? : string
592
+ /**
593
+ * An icon to show before the [title](https://bryntum.com/products/scheduler/docs/api/Core/widget/Panel#config-title). Either pass a CSS class as a string, or pass a
594
+ * [DomConfig](https://bryntum.com/products/scheduler/docs/api/Core/helper/DomHelper#typedef-DomConfig) object describing an element to represent the icon.
595
+ */
596
+ icon? : string|DomConfig
597
+ /**
598
+ * Widget id, if not specified one will be generated. Also used for lookups through Widget.getById
599
+ */
600
+ id? : string
601
+ /**
602
+ * Set to `true` to ignore reacting to DOM events (mouseover/mouseout etc) while scrolling. Useful if you
603
+ * want to maximize scroll performance.
604
+ */
605
+ ignoreDomEventsWhileScrolling? : boolean
606
+ /**
607
+ * Determines if the widgets read-only state should be controlled by its parent.
608
+ * ...
609
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-ignoreParentReadOnly)
610
+ */
611
+ ignoreParentReadOnly? : boolean
612
+ /**
613
+ * Set to `true` to automatically adjust the panel timespan during scrolling in the time dimension,
614
+ * when the scroller comes close to the start/end edges.
615
+ * ...
616
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-infiniteScroll)
617
+ */
618
+ infiniteScroll? : boolean
619
+ /**
620
+ * A function that initializes a target group record entry.
621
+ * ...
622
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-initAggregatedDataEntry)
623
+ * @returns {object} Target aggregated entry
624
+ */
625
+ initAggregatedDataEntry? : (() => object)|string
626
+ /**
627
+ * Convenience setting to align input fields of child widgets. By default, the Field input element is
628
+ * placed immediately following the `label`. If you prefer to have all input fields aligned to the
629
+ * right, set this config to `'end'`.
630
+ * ...
631
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-inputFieldAlign)
632
+ */
633
+ inputFieldAlign? : 'start'|'end'
634
+ /**
635
+ * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
636
+ */
637
+ insertBefore? : HTMLElement|string
638
+ /**
639
+ * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
640
+ */
641
+ insertFirst? : HTMLElement|string
642
+ /**
643
+ * See [Keyboard shortcuts](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#keyboard-shortcuts) for details
644
+ */
645
+ keyMap? : Record<string, KeyMapConfig>
646
+ /**
647
+ * Convenience setting to use same label placement on all child widgets.
648
+ * ...
649
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-labelPosition)
650
+ */
651
+ labelPosition? : 'before'|'above'|'align-before'|'auto'|null
652
+ /**
653
+ * The listener set for this object.
654
+ * ...
655
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-listeners)
656
+ */
657
+ listeners? : TimelineHistogramListeners
658
+ /**
659
+ * A [Mask](https://bryntum.com/products/scheduler/docs/api/Core/widget/Mask) config object, or a message to be shown when a store is performing a remote
660
+ * operation, or Crud Manager is loading data from the sever. Set to `null` to disable default load mask.
661
+ */
662
+ loadMask? : string|MaskConfig|null
663
+ /**
664
+ * A [Mask](https://bryntum.com/products/scheduler/docs/api/Core/widget/Mask) config object to adjust the [maskDefaults](#Core/widget/Widget#config-maskDefaults)
665
+ * when data is loading. The message and optional configuration from the
666
+ * [loadMask](https://bryntum.com/products/scheduler/docs/api/Core/mixin/LoadMaskable#config-loadMask) config take priority over these options, just as they do
667
+ * for `maskDefaults`, respectively.
668
+ * ...
669
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-loadMaskDefaults)
670
+ */
671
+ loadMaskDefaults? : MaskConfig
672
+ /**
673
+ * A [Mask](https://bryntum.com/products/scheduler/docs/api/Core/widget/Mask) config object to adjust the [maskDefaults](#Core/widget/Widget#config-maskDefaults)
674
+ * when an error occurs loading data.
675
+ * ...
676
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-loadMaskError)
677
+ */
678
+ loadMaskError? : MaskConfig|Mask|boolean
679
+ /**
680
+ * Set to `false` to disable localization of this object.
681
+ */
682
+ localizable? : boolean
683
+ /**
684
+ * Time in ms until a longpress is triggered
685
+ */
686
+ longPressTime? : number
687
+ /**
688
+ * When `true`, events are sized and positioned based on rowHeight, resourceMargin and barMargin settings.
689
+ * Set this to `false` if you want to control height and vertical position using CSS instead.
690
+ * ...
691
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-managedEventSizing)
692
+ */
693
+ managedEventSizing? : boolean
694
+ /**
695
+ * Widget's margin. This may be configured as a single number or a `TRBL` format string.
696
+ * numeric-only values are interpreted as pixels.
697
+ */
698
+ margin? : number|string
699
+ /**
700
+ * Grids change the `maskDefaults` to cover only their `body` element.
701
+ */
702
+ maskDefaults? : MaskConfig
703
+ /**
704
+ * Set to `true` to apply the default mask to the widget. Alternatively, this can be the mask message or a
705
+ * [Mask](https://bryntum.com/products/scheduler/docs/api/Core/widget/Mask) config object.
706
+ */
707
+ masked? : boolean|string|MaskConfig
708
+ /**
709
+ * Get/set end date limit of the timeline.
710
+ * Actions such as timeline scrolling, all types of timeline zooms and shifts
711
+ * will respect this limit.
712
+ */
713
+ maxDate? : Date|string
714
+ /**
715
+ * The element's maxHeight. Can be either a String or a Number (which will have 'px' appended). Note that
716
+ * like [height](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-height), *reading* the value will return the numeric value in pixels.
717
+ */
718
+ maxHeight? : string|number
719
+ /**
720
+ * The maximum time axis unit to display non-working ranges for ('hour' or 'day' etc).
721
+ * When zooming to a view with a larger unit, no non-working time elements will be rendered.
722
+ * ...
723
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-maxTimeAxisUnit)
724
+ */
725
+ maxTimeAxisUnit? : DurationUnit
726
+ /**
727
+ * The elements maxWidth. Can be either a String or a Number (which will have 'px' appended). Note that
728
+ * like [width](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-width), *reading* the value will return the numeric value in pixels.
729
+ */
730
+ maxWidth? : string|number
731
+ /**
732
+ * The maximum zoom level to which [zoomIn](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomIn) will work. Defaults to the number of
733
+ * [ViewPresets](https://bryntum.com/products/scheduler/docs/api/Scheduler/preset/ViewPreset) available, see [presets](#Scheduler/view/mixin/TimelineViewPresets#property-presets)
734
+ * for information. Unless you have modified the collection of available presets, the max zoom level is
735
+ * milliseconds.
736
+ */
737
+ maxZoomLevel? : number
738
+ /**
739
+ * Get/set start date limit of the timeline.
740
+ * Actions such as timeline scrolling, all types of timeline zooms and shifts
741
+ * will respect this limit.
742
+ */
743
+ minDate? : Date|string
744
+ /**
745
+ * Grid's `min-height`. Defaults to `10em` to be sure that the Grid always has a height wherever it is
746
+ * inserted.
747
+ * ...
748
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-minHeight)
749
+ */
750
+ minHeight? : string|number
751
+ /**
752
+ * The elements minWidth. Can be either a String or a Number (which will have 'px' appended). Note that
753
+ * like [width](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-width), *reading* the value will return the numeric value in pixels.
754
+ */
755
+ minWidth? : string|number
756
+ /**
757
+ * The minimum zoom level to which [zoomOut](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomOut) will work. Defaults to 0 (year ticks)
758
+ */
759
+ minZoomLevel? : number
760
+ /**
761
+ * Grid monitors window resize by default.
762
+ */
763
+ monitorResize? : boolean
764
+ /**
765
+ * The owning Widget of this Widget. If this Widget is directly contained (that is, it is one of the
766
+ * [items](https://bryntum.com/products/scheduler/docs/api/Core/widget/Container#property-items) of a Container), this config will be ignored. In this case
767
+ * the owner is <strong>always</strong> the encapsulating Container.
768
+ * ...
769
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-owner)
770
+ */
771
+ owner? : Widget|any
772
+ /**
773
+ * Partners this Timeline panel with another Timeline in order to sync their region sizes (sub-grids like locked, normal will get the same width),
774
+ * start and end dates, view preset, zoom level and scrolling position. All these values will be synced with the timeline defined as the `partner`.
775
+ * ...
776
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-partner)
777
+ */
778
+ partner? : TimelineBase
779
+ /**
780
+ * Specify plugins (an array of classes) in config
781
+ */
782
+ plugins? : Function[]
783
+ /**
784
+ * True to preserve focused cell after loading new data
785
+ */
786
+ preserveFocusOnDatasetChange? : boolean
787
+ /**
788
+ * Preserve the grid's vertical scroll position when changesets are applied, as in the case of remote
789
+ * changes, or when stores are configured with [syncDataOnLoad](https://bryntum.com/products/scheduler/docs/api/Core/data/Store#config-syncDataOnLoad).
790
+ */
791
+ preserveScroll? : PreserveScrollOptions|boolean
792
+ /**
793
+ * Specify `true` to preserve vertical scroll position after store actions that trigger a `refresh` event,
794
+ * such as loading new data and filtering.
795
+ */
796
+ preserveScrollOnDatasetChange? : boolean
797
+ /**
798
+ * An array of [ViewPreset](https://bryntum.com/products/scheduler/docs/api/Scheduler/preset/ViewPreset) config objects
799
+ * which describes the available timeline layouts for this scheduler.
800
+ * ...
801
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-presets)
802
+ */
803
+ presets? : ViewPresetConfig[]
804
+ /**
805
+ * Prevent tooltip from being displayed on touch devices. Useful for example for buttons that display a
806
+ * menu on click etc, since the tooltip would be displayed at the same time.
807
+ */
808
+ preventTooltipOnTouch? : boolean
809
+ /**
810
+ * Set to `true` to make the grid read-only, by disabling any UIs for modifying data.
811
+ * ...
812
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-readOnly)
813
+ */
814
+ readOnly? : boolean
815
+ /**
816
+ * The confirmation dialog shown when a recurring event is edited.
817
+ * ...
818
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-recurrenceConfirmationPopup)
819
+ */
820
+ recurrenceConfirmationPopup? : RecurrenceConfirmationPopupConfig|RecurrenceConfirmationPopup
821
+ relayStoreEvents? : boolean
822
+ /**
823
+ * Either a default `rendition` to apply to all child widgets, or a map of renditions keyed by child widget
824
+ * `type`.
825
+ * ...
826
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-rendition)
827
+ */
828
+ rendition? : string|Record<string, string>|null
829
+ /**
830
+ * Configure this property to allow the widget/component to be resized. Pressing <kbd>Shift</kbd> while resizing will
831
+ * constrain the aspect ratio.
832
+ * ...
833
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-resizable)
834
+ */
835
+ resizable? : boolean|{
836
+ minWidth?: number
837
+ maxWidth?: number
838
+ minHeight?: number
839
+ maxHeight?: number
840
+ handles?: object
841
+ }
842
+ /**
843
+ * Set to `false` to only measure cell contents when double-clicking the edge between column headers.
844
+ */
845
+ resizeToFitIncludesHeader? : boolean
846
+ /**
847
+ * An empty function by default, but provided so that you can override it. This function is called each time
848
+ * a resource time range is rendered into the schedule. It's called with `resourceTimeRangeRecord`, `resourceRecord`,
849
+ * and `renderData` params.
850
+ * ...
851
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-resourceTimeRangeRenderer)
852
+ * @param {object} detail An object containing the information needed to render a ResourceTimeRangeModel.
853
+ * @param {Scheduler.model.ResourceTimeRangeModel} detail.resourceTimeRangeRecord The resource time range record.
854
+ * @param {Scheduler.model.ResourceModel} detail.resourceRecord The resource record.
855
+ * @param {object} detail.renderData An object containing details about the event rendering.
856
+ * @returns {string,DomConfig,DomConfig[]} A simple string, or a DomConfig object describing the markup
857
+ */
858
+ resourceTimeRangeRenderer? : (detail: { resourceTimeRangeRecord: ResourceTimeRangeModel, resourceRecord: ResourceModel, renderData: object }) => string|DomConfig|DomConfig[]
859
+ /**
860
+ * "Break points" for which responsive config to use for columns and css.
861
+ * ...
862
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-responsiveLevels)
863
+ */
864
+ responsiveLevels? : Record<string, number|string|ResponsiveLevelConfig>
865
+ /**
866
+ * Configure as `true` to have the component display a translucent ripple when its
867
+ * [focusElement](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-focusElement), or [element](#Core/widget/Widget#property-element) is tapped <em>if the
868
+ * current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
869
+ * ...
870
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-ripple)
871
+ */
872
+ ripple? : boolean|{
873
+ delegate?: string
874
+ color?: string
875
+ radius?: number
876
+ clip?: string
877
+ }
878
+ /**
879
+ * 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`
880
+ */
881
+ rootElement? : ShadowRoot|HTMLElement
882
+ /**
883
+ * Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
884
+ * overriden by specifying a [rowHeight](https://bryntum.com/products/scheduler/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
885
+ * a column [renderer](https://bryntum.com/products/scheduler/docs/api/Grid/column/Column#config-renderer).
886
+ * ...
887
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-rowHeight)
888
+ */
889
+ rowHeight? : number
890
+ /**
891
+ * Set to `false` to not show row lines. End result might be overruled by/differ between themes.
892
+ */
893
+ rowLines? : boolean
894
+ /**
895
+ * This may be configured as `true` to make the widget's element use the `direction:rtl` style.
896
+ * ...
897
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-rtl)
898
+ */
899
+ rtl? : boolean
900
+ /**
901
+ * An object with configuration for the [ScaleColumn](https://bryntum.com/products/scheduler/docs/api/Scheduler/column/ScaleColumn).
902
+ * ...
903
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-scaleColumn)
904
+ */
905
+ scaleColumn? : ScaleColumnConfig
906
+ /**
907
+ * Array of objects representing the [scale column](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineHistogramScaleColumn#config-scaleColumn) scale points.
908
+ * The config basically is a mapping to the column [scalePoints](https://bryntum.com/products/scheduler/docs/api/Scheduler/column/ScaleColumn#config-scalePoints)
909
+ * config.
910
+ * ...
911
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-scalePoints)
912
+ */
913
+ scalePoints? : ScalePoint[]
914
+ /**
915
+ * Configures whether the grid is scrollable in the `Y` axis. This is used to configure a [Scroller](https://bryntum.com/products/scheduler/docs/api/Core/helper/util/Scroller).
916
+ * See the [scrollerClass](https://bryntum.com/products/scheduler/docs/api/Grid/view/GridBase#config-scrollerClass) config option.
917
+ * ...
918
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-scrollable)
919
+ */
920
+ scrollable? : boolean|ScrollerConfig|Scroller
921
+ /**
922
+ * The class to instantiate to use as the [scrollable](https://bryntum.com/products/scheduler/docs/api/Grid/view/GridBase#config-scrollable). Defaults to [Scroller](#Core/helper/util/Scroller).
923
+ */
924
+ scrollerClass? : typeof Scroller
925
+ /**
926
+ * Configuration values for the [ScrollManager](https://bryntum.com/products/scheduler/docs/api/Core/util/ScrollManager) class on initialization. Returns the
927
+ * [ScrollManager](https://bryntum.com/products/scheduler/docs/api/Core/util/ScrollManager) at runtime.
928
+ */
929
+ scrollManager? : ScrollManagerConfig|ScrollManager
930
+ /**
931
+ * Selection configuration settings, change these properties to control how selection works and what can be
932
+ * selected.
933
+ * ...
934
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-selectionMode)
935
+ */
936
+ selectionMode? : GridSelectionMode
937
+ /**
938
+ * Object enumerating data series for the histogram.
939
+ * The object keys are treated as the series identifiers and values are objects that
940
+ * must contain two properties:
941
+ * ...
942
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-series)
943
+ */
944
+ series? : Record<string, HistogramSeries>
945
+ /**
946
+ * Set to `true` if you want to display a tooltip when hovering an allocation bar. You can also pass a
947
+ * [Tooltip#configs](https://bryntum.com/products/scheduler/docs/api/Core/widget/Tooltip#configs) config object.
948
+ * Please use [barTooltipTemplate](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogramBase#config-barTooltipTemplate) function to customize the tooltip contents.
949
+ */
950
+ showBarTip? : boolean|TooltipConfig
951
+ /**
952
+ * Set to `true` to display the [bar tooltip](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogramBase#config-showBarTip) when navigating the timeaxis cells
953
+ * using [ScheduleContext](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ScheduleContext) feature.
954
+ * The tooltip is disabled by default when navigating to make the navigation easier.
955
+ */
956
+ showBarTipWhenNavigatingTimeAxis? : boolean
957
+ /**
958
+ * Configure as `true` to have the grid show a red "changed" tag in cells whose
959
+ * field value has changed and not yet been committed.
960
+ * ...
961
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-showDirty)
962
+ */
963
+ showDirty? : boolean|{
964
+ duringEdit?: boolean
965
+ newRecord?: boolean
966
+ }
967
+ /**
968
+ * Set to `true` to snap to the current time resolution increment while interacting with scheduled events.
969
+ * ...
970
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-snap)
971
+ */
972
+ snap? : boolean
973
+ /**
974
+ * Affects drag drop and resizing of events when [snap](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineDateMapper#config-snap)
975
+ * is enabled.
976
+ * ...
977
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-snapRelativeToEventStartDate)
978
+ */
979
+ snapRelativeToEventStartDate? : boolean
980
+ /**
981
+ * Programmatic control over how many columns to span when used in a grid layout.
982
+ */
983
+ span? : number
984
+ /**
985
+ * The start date of the timeline (if not configure with [infiniteScroll](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineBase#config-infiniteScroll)).
986
+ * ...
987
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-startDate)
988
+ */
989
+ startDate? : Date|string
990
+ /**
991
+ * This value can be one of the following:
992
+ * ...
993
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-stateful)
994
+ */
995
+ stateful? : boolean|object|string[]
996
+ /**
997
+ * The events that, when fired by this component, should trigger it to save its state by calling
998
+ * [saveState](https://bryntum.com/products/scheduler/docs/api/Core/mixin/State#function-saveState).
999
+ * ...
1000
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-statefulEvents)
1001
+ */
1002
+ statefulEvents? : object|string[]
1003
+ /**
1004
+ * The key to use when saving this object's state in the [stateProvider](https://bryntum.com/products/scheduler/docs/api/Core/mixin/State#config-stateProvider). If this config is
1005
+ * not assigned, and [stateful](https://bryntum.com/products/scheduler/docs/api/Core/mixin/State#config-stateful) is not set to `false`, the [id](#Core/widget/Widget#config-id)
1006
+ * (if explicitly specified) will be used as the `stateId`.
1007
+ * ...
1008
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-stateId)
1009
+ */
1010
+ stateId? : string
1011
+ /**
1012
+ * The `StateProvider` to use to save and restore this object's [state](https://bryntum.com/products/scheduler/docs/api/Core/mixin/State#property-state). By default, `state`
1013
+ * will be saved using the [default state provider](https://bryntum.com/products/scheduler/docs/api/Core/state/StateProvider#property-instance-static).
1014
+ * ...
1015
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-stateProvider)
1016
+ */
1017
+ stateProvider? : StateProvider
1018
+ /**
1019
+ * The properties of this settings object controls how grid is restored from state data.
1020
+ * ...
1021
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-stateSettings)
1022
+ */
1023
+ stateSettings? : {
1024
+ restoreUnconfiguredColumns?: boolean
1025
+ }
1026
+ /**
1027
+ * When set, the text in the major time axis header sticks in the scrolling viewport as long as possible.
1028
+ */
1029
+ stickyHeaders? : boolean
1030
+ /**
1031
+ * Store that holds records to display in the grid, or a store config object. If the configuration contains
1032
+ * a `readUrl`, an `AjaxStore` will be created.
1033
+ * ...
1034
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-store)
1035
+ */
1036
+ store? : Store|StoreConfig|AjaxStore|AjaxStoreConfig
1037
+ /**
1038
+ * An object containing widgets keyed by name. By default (when no `type` is given), strips are
1039
+ * [toolbars](https://bryntum.com/products/scheduler/docs/api/Core/widget/Toolbar). If you want to pass an array, you can use
1040
+ * the toolbar's [items](https://bryntum.com/products/scheduler/docs/api/Core/widget/Container#config-items).
1041
+ * ...
1042
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-strips)
1043
+ */
1044
+ strips? : Record<string, SchedulerContainerItemConfig>
1045
+ /**
1046
+ * An object containing sub grid configuration objects keyed by a `region` property.
1047
+ * By default, grid has a 'locked' region (if configured with locked columns) and a 'normal' region.
1048
+ * The 'normal' region defaults to use `flex: 1`.
1049
+ * ...
1050
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-subGridConfigs)
1051
+ */
1052
+ subGridConfigs? : Record<string, SubGridConfig>
1053
+ /**
1054
+ * Set to `true` to prevent auto calculating of a minimal [tickSize](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineEventRendering#property-tickSize)
1055
+ * to always fit the content to the screen size. Setting this property on `true` will disable [forceFit](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineBase#config-forceFit) behaviour.
1056
+ */
1057
+ suppressFit? : boolean
1058
+ /**
1059
+ * A [Mask](https://bryntum.com/products/scheduler/docs/api/Core/widget/Mask) config object, or a message to be shown when Crud Manager
1060
+ * is persisting changes on the server. Set to `null` to disable default sync mask.
1061
+ * ...
1062
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-syncMask)
1063
+ */
1064
+ syncMask? : string|MaskConfig|null
1065
+ /**
1066
+ * A configuration for the [tab](https://bryntum.com/products/scheduler/docs/api/Core/widget/Tab) created for this widget when it is placed in a
1067
+ * [TabPanel](https://bryntum.com/products/scheduler/docs/api/Core/widget/TabPanel). For example, this config can be used to control the icon of the `tab` for
1068
+ * this widget:
1069
+ * ...
1070
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-tab)
1071
+ */
1072
+ tab? : boolean|TabConfig
1073
+ /**
1074
+ * When this container is used as a tab in a TabPanel, these items are added to the
1075
+ * [TabBar](https://bryntum.com/products/scheduler/docs/api/Core/widget/TabBar) when this container is the active tab.
1076
+ * ...
1077
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-tabBarItems)
1078
+ */
1079
+ tabBarItems? : ToolbarItems[]|Widget[]
1080
+ /**
1081
+ * A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/scheduler/docs/api/Core/widget/Toolbar),
1082
+ * or array of config objects representing the child items of a Toolbar.
1083
+ * This creates a toolbar docked to the top of the panel immediately below the header.
1084
+ * ...
1085
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-tbar)
1086
+ */
1087
+ tbar? : (SchedulerContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
1088
+ /**
1089
+ * The width/height (depending on vertical / horizontal mode) of all the time columns.
1090
+ * ...
1091
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-tickSize)
1092
+ */
1093
+ tickSize? : number
1094
+ /**
1095
+ * A [TimeAxis](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/TimeAxis) config object or instance, used to create a backing data store of
1096
+ * 'ticks' providing the input date data for the time axis of timeline panel. Created automatically if none
1097
+ * supplied.
1098
+ */
1099
+ timeAxis? : TimeAxisConfig|TimeAxis
1100
+ /**
1101
+ * Gets/sets the current time resolution object, which contains a unit identifier and an increment count
1102
+ * `{ unit, increment }`. This value means minimal task duration you can create using UI.
1103
+ * ...
1104
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-timeResolution)
1105
+ */
1106
+ timeResolution? : {
1107
+ increment?: number
1108
+ unit?: DurationUnit
1109
+ }|number
1110
+ /**
1111
+ * Set to a time zone or a UTC offset. This will set the projects
1112
+ * [timeZone](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/ProjectModel#config-timeZone) config accordingly. As this config is only a referer,
1113
+ * please see project's config [documentation](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/ProjectModel#config-timeZone) for more
1114
+ * information.
1115
+ * ...
1116
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-timeZone)
1117
+ */
1118
+ timeZone? : string|number
1119
+ /**
1120
+ * A title to display in the header or owning TabPanel. Causes creation and docking of a header
1121
+ * to the top if no header is configured.
1122
+ * ...
1123
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-title)
1124
+ */
1125
+ title? : string
1126
+ /**
1127
+ * The [tools](https://bryntum.com/products/scheduler/docs/api/Core/widget/Tool) to add either before or after the `title` in the Panel header. Each
1128
+ * property name is the reference by which an instantiated tool may be retrieved from the live
1129
+ * `[tools](https://bryntum.com/products/scheduler/docs/api/Core/widget/mixin/Toolable#property-tools)` property.
1130
+ * ...
1131
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-tools)
1132
+ */
1133
+ tools? : Record<string, ToolConfig>|null
1134
+ /**
1135
+ * Configure UI transitions for various actions in the grid.
1136
+ */
1137
+ transition? : {
1138
+ insertRecord?: boolean
1139
+ removeRecord?: boolean
1140
+ toggleColumn?: boolean
1141
+ expandCollapseColumn?: boolean
1142
+ toggleRegion?: boolean
1143
+ toggleTreeNode?: boolean
1144
+ toggleGroup?: boolean
1145
+ filterRemoval?: boolean
1146
+ }
1147
+ /**
1148
+ * Animation transition duration in milliseconds.
1149
+ */
1150
+ transitionDuration? : number
1151
+ type? : 'timelinehistogram'
1152
+ /**
1153
+ * Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
1154
+ * as a space separated string, an array of strings, or as an object in which property names with truthy
1155
+ * values are used as the class names.
1156
+ * ...
1157
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-ui)
1158
+ */
1159
+ ui? : 'plain'|'toolbar'|string|object
1160
+ /**
1161
+ * A string key used to lookup a predefined [ViewPreset](https://bryntum.com/products/scheduler/docs/api/Scheduler/preset/ViewPreset) (e.g. 'weekAndDay', 'hourAndDay'),
1162
+ * managed by [PresetManager](https://bryntum.com/products/scheduler/docs/api/Scheduler/preset/PresetManager). See [PresetManager](#Scheduler/preset/PresetManager) for more information.
1163
+ * Or a config object for a viewPreset.
1164
+ * ...
1165
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-viewPreset)
1166
+ */
1167
+ viewPreset? : string|ViewPresetConfig
1168
+ /**
1169
+ * A date to bring into view initially on the scrollable timeline.
1170
+ * ...
1171
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-visibleDate)
1172
+ */
1173
+ visibleDate? : Date|VisibleDate
1174
+ /**
1175
+ * Integer number indicating the size of timespan during zooming. When zooming, the timespan is adjusted to make
1176
+ * the scrolling area `visibleZoomFactor` times wider than the timeline area itself. Used in
1177
+ * [zoomToSpan](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomToSpan) and [zoomToLevel](#Scheduler/view/mixin/TimelineZoomable#function-zoomToLevel) functions.
1178
+ */
1179
+ visibleZoomFactor? : number
1180
+ /**
1181
+ * A valid JS day index between 0-6 (0: Sunday, 1: Monday etc.) to be considered the start day of the week.
1182
+ * When omitted, the week start day is retrieved from the active locale class.
1183
+ */
1184
+ weekStartDay? : number
1185
+ /**
1186
+ * A widgets weight determines its position among siblings when added to a [Container](https://bryntum.com/products/scheduler/docs/api/Core/widget/Container).
1187
+ * Higher weights go further down.
1188
+ */
1189
+ weight? : number
1190
+ /**
1191
+ * Widget's width, used to set element `style.width`. Either specify a valid width string or a number, which
1192
+ * will get 'px' appended. We recommend using CSS as the primary way to control width, but in some cases
1193
+ * this config is convenient.
1194
+ */
1195
+ width? : string|number
1196
+ /**
1197
+ * An object with format `{ fromDay, toDay, fromHour, toHour }` that describes the working days and hours.
1198
+ * This object will be used to populate TimeAxis [include](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/TimeAxis#config-include) property.
1199
+ * ...
1200
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-workingTime)
1201
+ */
1202
+ workingTime? : {
1203
+ fromDay?: number
1204
+ toDay?: number
1205
+ fromHour?: number
1206
+ toHour?: number
1207
+ }
1208
+ /**
1209
+ * Whether the originally rendered timespan should be preserved while zooming. By default, it is set to `false`,
1210
+ * meaning the timeline panel will adjust the currently rendered timespan to limit the amount of HTML content to
1211
+ * render. When setting this option to `true`, be careful not to allow to zoom a big timespan in seconds
1212
+ * resolution for example. That will cause <strong>a lot</strong> of HTML content to be rendered and affect performance. You
1213
+ * can use [minZoomLevel](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineZoomable#config-minZoomLevel) and [maxZoomLevel](#Scheduler/view/mixin/TimelineZoomable#config-maxZoomLevel) config options for that.
1214
+ */
1215
+ zoomKeepsOriginalTimespan? : boolean
1216
+ /**
1217
+ * If true, you can zoom in and out on the time axis using CTRL-key + mouse wheel.
1218
+ */
1219
+ zoomOnMouseWheel? : boolean
1220
+ /**
1221
+ * True to zoom to time span when double-clicking a time axis cell.
1222
+ */
1223
+ zoomOnTimeAxisDoubleClick? : boolean
1224
+
1225
+ // Events
1226
+ /**
1227
+ * Fires before an assignment is removed. Can be triggered by user pressing [DELETE] or [BACKSPACE] or
1228
+ * by the event editor. Can for example be used to display a custom dialog to confirm deletion, in which
1229
+ * case records should be "manually" removed after confirmation:
1230
+ * ...
1231
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-beforeAssignmentDelete)
1232
+ * @param {object} event Event object
1233
+ * @param {Scheduler.view.Scheduler} event.source The Scheduler instance
1234
+ * @param {Scheduler.model.AssignmentModel[]} event.assignmentRecords The assignment records about to be deleted
1235
+ * @param {object} event.context Additional removal context:
1236
+ * @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.
1237
+ * @param {boolean} event.context.finalize.removeRecords Provide `false` to the function to prevent the removal.
1238
+ */
1239
+ onBeforeAssignmentDelete? : ((event: { source: Scheduler, assignmentRecords: AssignmentModel[], context: { finalize: { removeRecords?: boolean } } }) => Promise<boolean>|boolean|void)|string
1240
+ /**
1241
+ * Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
1242
+ * @param {object} event Event object
1243
+ * @param {Grid.view.Grid} event.source Owner grid
1244
+ * @param {Grid.util.GridLocation} event.editorContext Editing context
1245
+ */
1246
+ onBeforeCancelCellEdit? : ((event: { source: Grid, editorContext: GridLocation }) => Promise<boolean>|boolean|void)|string
1247
+ /**
1248
+ * 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.
1249
+ * ...
1250
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-beforeCancelRowEdit)
1251
+ * @param {object} event Event object
1252
+ * @param {Grid.view.Grid} event.grid Target grid
1253
+ * @param {RowEditorContext} event.editorContext Editing context
1254
+ */
1255
+ onBeforeCancelRowEdit? : ((event: { grid: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string
1256
+ /**
1257
+ * Fires on the owning Grid before editing starts, return `false` to prevent editing
1258
+ * @param {object} event Event object
1259
+ * @param {Grid.view.Grid} event.source Owner grid
1260
+ * @param {CellEditorContext} event.editorContext Editing context
1261
+ */
1262
+ onBeforeCellEditStart? : ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
1263
+ /**
1264
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
1265
+ * buttons while [autoEdit](https://bryntum.com/products/scheduler/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
1266
+ * @param {object} event Event object
1267
+ * @param {Grid.view.Grid} event.source Owner grid
1268
+ * @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).
1269
+ */
1270
+ onBeforeCellRangeDelete? : ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => Promise<boolean>|boolean|void)|string
1271
+ /**
1272
+ * Fires for each selected record on the owning Grid before editing a range of selected cell values
1273
+ * @param {object} event Event object
1274
+ * @param {Core.data.Model} event.record Current selected record from the range
1275
+ * @param {string} event.field The field being changed
1276
+ * @param {any} event.value The value being set
1277
+ */
1278
+ onBeforeCellRangeEdit? : ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
1279
+ /**
1280
+ * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
1281
+ * @param {object} event Event object
1282
+ * @param {Grid.view.Grid} event.source The grid instance.
1283
+ * @param {Grid.column.Column} event.column The dragged column.
1284
+ * @param {Event} event.event The browser event.
1285
+ */
1286
+ onBeforeColumnDragStart? : ((event: { source: Grid, column: Column, event: Event }) => Promise<boolean>|boolean|void)|string
1287
+ /**
1288
+ * This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
1289
+ * @param {object} event Event object
1290
+ * @param {Grid.view.Grid} event.source The grid instance.
1291
+ * @param {Grid.column.Column} event.column The dragged column.
1292
+ * @param {Grid.column.Column} event.insertBefore The column before which the dragged column will be inserted.
1293
+ * @param {Grid.column.Column} event.newParent The new parent column.
1294
+ * @param {Event} event.event The browser event.
1295
+ * @param {string} event.region The region where the column was dropped.
1296
+ */
1297
+ onBeforeColumnDropFinalize? : ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => Promise<boolean>|boolean|void)|string
1298
+ /**
1299
+ * This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
1300
+ * `false`.
1301
+ * @param {object} event Event object
1302
+ * @param {Grid.view.Grid} event.source The grid instance
1303
+ * @param {Grid.column.Column} event.column The column
1304
+ * @param {Event} event.domEvent The browser event
1305
+ */
1306
+ onBeforeColumnResize? : ((event: { source: Grid, column: Column, domEvent: Event }) => Promise<boolean>|boolean|void)|string
1307
+ /**
1308
+ * Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
1309
+ * @param {object} event Event object
1310
+ * @param {Grid.view.Grid} event.source Owner grid
1311
+ * @param {Grid.util.GridLocation[]} event.cells The cells about to be copied or cut
1312
+ * @param {string} event.data The string data about to be copied or cut
1313
+ * @param {boolean} event.isCut `true` if this is a cut action
1314
+ * @param {string} event.entityName 'cell' to distinguish this event from other beforeCopy events
1315
+ */
1316
+ onBeforeCopy? : ((event: { source: Grid, cells: GridLocation[], data: string, isCut: boolean, entityName: string }) => Promise<boolean>|boolean|void)|string
1317
+ /**
1318
+ * Fires on the owning Grid before CSV export starts. Return `false` to cancel the export.
1319
+ * @param {object} event Event object
1320
+ * @param {ExportConfig} event.config Export config
1321
+ * @param {Grid.column.Column[]} event.columns An array of columns to export
1322
+ * @param {Core.data.Model[]} event.rows An array of records to export
1323
+ * @param {string} event.lineDelimiter The CSV delimiter to separate lines
1324
+ * @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
1325
+ */
1326
+ onBeforeCSVExport? : ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => Promise<boolean>|boolean|void)|string
1327
+ /**
1328
+ * Fires before an object is destroyed.
1329
+ * @param {object} event Event object
1330
+ * @param {Core.Base} event.source The Object that is being destroyed.
1331
+ */
1332
+ onBeforeDestroy? : ((event: { source: Base }) => void)|string
1333
+ /**
1334
+ * Fires before an event is removed. Can be triggered by user pressing [DELETE] or [BACKSPACE] or by the
1335
+ * event editor. Return `false` to immediately veto the removal (or a `Promise` yielding `true` or `false`
1336
+ * for async vetoing).
1337
+ * ...
1338
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-beforeEventDelete)
1339
+ * @param {object} event Event object
1340
+ * @param {Scheduler.view.Scheduler,any} event.source The Scheduler instance
1341
+ * @param {Scheduler.model.EventModel[]} event.eventRecords The records about to be deleted
1342
+ * @param {object} event.context Additional removal context:
1343
+ * @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.
1344
+ * @param {boolean} event.context.finalize.removeRecords Provide `false` to the function to prevent the removal.
1345
+ */
1346
+ onBeforeEventDelete? : ((event: { source: Scheduler|any, eventRecords: EventModel[], context: { finalize: { removeRecords?: boolean } } }) => Promise<boolean>|boolean|void)|string
1347
+ /**
1348
+ * Fires on the owning Grid before Excel export starts. Return `false` to cancel the export.
1349
+ * @param {object} event Event object
1350
+ * @param {ExportConfig} event.config Export config
1351
+ * @param {XLSColumn[]} event.columns An array of columns to export
1352
+ * @param {any[][]} event.rows An array of records to export
1353
+ */
1354
+ onBeforeExcelExport? : ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => Promise<boolean>|boolean|void)|string
1355
+ /**
1356
+ * Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
1357
+ * @param {object} event Event object
1358
+ * @param {Grid.util.GridLocation} event.cell Information about the column / record
1359
+ * @param {MouseEvent} event.domEvent The raw DOM event
1360
+ */
1361
+ onBeforeFillHandleDragStart? : ((event: { cell: GridLocation, domEvent: MouseEvent }) => Promise<boolean>|boolean|void)|string
1362
+ /**
1363
+ * 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.
1364
+ * @param {object} event Event object
1365
+ * @param {Grid.view.Grid} event.grid Target grid
1366
+ * @param {CellEditorContext} event.editorContext Editing context
1367
+ */
1368
+ onBeforeFinishCellEdit? : ((event: { grid: Grid, editorContext: CellEditorContext }) => void)|string
1369
+ /**
1370
+ * 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.
1371
+ * ...
1372
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-beforeFinishRowEdit)
1373
+ * @param {object} event Event object
1374
+ * @param {Grid.view.Grid} event.grid Target grid
1375
+ * @param {RowEditorContext} event.editorContext Editing context
1376
+ */
1377
+ onBeforeFinishRowEdit? : ((event: { grid: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string
1378
+ /**
1379
+ * Triggered before a widget is hidden. Return `false` to prevent the action.
1380
+ * @param {object} event Event object
1381
+ * @param {Core.widget.Widget} event.source The widget being hidden.
1382
+ */
1383
+ onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
1384
+ /**
1385
+ * Fires before the component stores a record's histogram data into the cache.
1386
+ * ...
1387
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-beforeHistogramDataCacheSet)
1388
+ * @param {object} event Event object
1389
+ * @param {Scheduler.view.TimelineHistogram} event.source The component instance
1390
+ * @param {Core.data.Model} event.record Record the histogram data of which is ready.
1391
+ * @param {object} event.data The record histogram data.
1392
+ */
1393
+ onBeforeHistogramDataCacheSet? : ((event: { source: TimelineHistogram, record: Model, data: object }) => void)|string
1394
+ /**
1395
+ * Fires on the owning Scheduler or Gantt widget before pan starts. Return `false` to prevent the operation.
1396
+ * @param {object} event Event object
1397
+ * @param {Event} event.event The native browser DOM event
1398
+ */
1399
+ onBeforePan? : ((event: { event: Event }) => Promise<boolean>|boolean|void)|string
1400
+ /**
1401
+ * Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
1402
+ * @param {object} event Event object
1403
+ * @param {Grid.view.Grid} event.source Owner grid
1404
+ * @param {string} event.clipboardData The clipboardData about to be pasted
1405
+ * @param {Grid.util.GridLocation} event.targetCell The cell from which the paste will be started
1406
+ * @param {string} event.entityName 'cell' to distinguish this event from other beforePaste events
1407
+ * @param {string} event.text The raw text from clipboard
1408
+ */
1409
+ onBeforePaste? : ((event: { source: Grid, clipboardData: string, targetCell: GridLocation, entityName: string, text: string }) => Promise<boolean>|boolean|void)|string
1410
+ /**
1411
+ * Fires on the owning Grid before export started. Return `false` to cancel the export.
1412
+ * @param {object} event Event object
1413
+ * @param {object} event.config Export config
1414
+ */
1415
+ onBeforePdfExport? : ((event: { config: object }) => Promise<boolean>|boolean|void)|string
1416
+ /**
1417
+ * Fired before the [viewPreset](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineViewPresets#config-viewPreset) is changed.
1418
+ * @param {object} event Event object
1419
+ * @param {Scheduler.view.Scheduler} event.source This Scheduler instance.
1420
+ * @param {Date} event.startDate The new start date of the timeline.
1421
+ * @param {Date} event.endDate The new end date of the timeline.
1422
+ * @param {Scheduler.preset.ViewPreset} event.from The outgoing ViewPreset.
1423
+ * @param {Scheduler.preset.ViewPreset} event.to The ViewPreset being switched to.
1424
+ */
1425
+ onBeforePresetChange? : ((event: { source: Scheduler, startDate: Date, endDate: Date, from: ViewPreset, to: ViewPreset }) => Promise<boolean>|boolean|void)|string
1426
+ /**
1427
+ * Fires before the component renders a row.
1428
+ * ...
1429
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-beforeRenderHistogramRow)
1430
+ * @param {object} event Event object
1431
+ * @param {Scheduler.view.TimelineHistogram} event.source The component instance
1432
+ * @param {Core.data.Model} event.record Record the histogram data of which is ready.
1433
+ * @param {HistogramConfig} event.histogramConfig Configuration object that will be applied to `histogramWidget`.
1434
+ * @param {Core.widget.graph.Histogram} event.histogramWidget The underlying widget that is used to render a chart.
1435
+ */
1436
+ onBeforeRenderHistogramRow? : ((event: { source: TimelineHistogram, record: Model, histogramConfig: HistogramConfig, histogramWidget: Histogram }) => void)|string
1437
+ /**
1438
+ * Fires before the component renders a histogram in a cell.
1439
+ * @param {object} event Event object
1440
+ * @param {Scheduler.view.TimelineHistogram} event.source The component instance
1441
+ * @param {Core.data.Model} event.record Record the histogram data of which is ready.
1442
+ * @param {HistogramConfig} event.histogramConfig Configuration object that will be applied to `histogramWidget`.
1443
+ * @param {Core.widget.graph.Histogram} event.histogramWidget The underlying widget that is used to render a chart.
1444
+ */
1445
+ onBeforeRenderRecordHistogram? : ((event: { source: TimelineHistogram, record: Model, histogramConfig: HistogramConfig, histogramWidget: Histogram }) => void)|string
1446
+ /**
1447
+ * Fires before a row is rendered.
1448
+ * @param {object} event Event object
1449
+ * @param {Grid.view.Grid} event.source The firing Grid instance.
1450
+ * @param {Grid.row.Row} event.row The row about to be rendered.
1451
+ * @param {Core.data.Model} event.record The record for the row.
1452
+ * @param {number} event.recordIndex The zero-based index of the record.
1453
+ */
1454
+ onBeforeRenderRow? : ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
1455
+ /**
1456
+ * Grid rows are about to be rendered
1457
+ * @param {object} event Event object
1458
+ * @param {Grid.view.Grid} event.source This grid.
1459
+ */
1460
+ onBeforeRenderRows? : ((event: { source: Grid }) => void)|string
1461
+ /**
1462
+ * This event fires before row collapse is started.
1463
+ * ...
1464
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-beforeRowCollapse)
1465
+ * @param {object} event Event object
1466
+ * @param {Core.data.Model} event.record Record
1467
+ */
1468
+ onBeforeRowCollapse? : ((event: { record: Model }) => Promise<boolean>|boolean|void)|string
1469
+ /**
1470
+ * This event fires before row expand is started.
1471
+ * ...
1472
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-beforeRowExpand)
1473
+ * @param {object} event Event object
1474
+ * @param {Core.data.Model} event.record Record
1475
+ */
1476
+ onBeforeRowExpand? : ((event: { record: Model }) => Promise<boolean>|boolean|void)|string
1477
+ /**
1478
+ * Fires before the selection changes. Returning `false` from a listener prevents the change
1479
+ * @param {object} event Event object
1480
+ * @param {string} event.action `'select'`/`'deselect'`
1481
+ * @param {'row','cell'} event.mode `'row'`/`'cell'`
1482
+ * @param {Grid.view.Grid} event.source
1483
+ * @param {Core.data.Model[]} event.deselected The records to be deselected in this operation.
1484
+ * @param {Core.data.Model[]} event.selected The records to be selected in this operation.
1485
+ * @param {Core.data.Model[]} event.selection The records in the current selection, before applying `selected` and `deselected`
1486
+ * @param {Grid.util.GridLocation[]} event.deselectedCells The cells to be deselected in this operation.
1487
+ * @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
1488
+ * @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
1489
+ */
1490
+ 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
1491
+ /**
1492
+ * Fired before this container will load record values into its child fields. This is useful if you
1493
+ * want to modify the UI before data is loaded (e.g. set some input field to be readonly)
1494
+ * @param {object} event Event object
1495
+ * @param {Core.widget.Container} event.source The container
1496
+ * @param {Core.data.Model} event.record The record
1497
+ */
1498
+ onBeforeSetRecord? : ((event: { source: Container, record: Model }) => void)|string
1499
+ /**
1500
+ * Triggered before a widget is shown. Return `false` to prevent the action.
1501
+ * @param {object} event Event object
1502
+ * @param {Core.widget.Widget,any} event.source The widget being shown
1503
+ */
1504
+ onBeforeShow? : ((event: { source: Widget|any }) => Promise<boolean>|boolean|void)|string
1505
+ /**
1506
+ * Fires on the owning Grid before editing starts, return `false` to prevent editing
1507
+ * @param {object} event Event object
1508
+ * @param {Grid.view.Grid} event.source Owner grid
1509
+ * @param {RowEditorContext} event.editorContext Editing context
1510
+ */
1511
+ onBeforeStartRowEdit? : ((event: { source: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string
1512
+ /**
1513
+ * Fired before state is applied to the source. Allows editing the state object or preventing the operation.
1514
+ * @param {object} event Event object
1515
+ * @param {GridStateInfo} event.state State object config
1516
+ */
1517
+ onBeforeStateApply? : ((event: { state: GridStateInfo }) => Promise<boolean>|boolean|void)|string
1518
+ /**
1519
+ * Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
1520
+ * @param {object} event Event object
1521
+ * @param {GridStateInfo} event.state State object config
1522
+ */
1523
+ onBeforeStateSave? : ((event: { state: GridStateInfo }) => Promise<boolean>|boolean|void)|string
1524
+ /**
1525
+ * Fired when a group is going to be expanded or collapsed using the UI.
1526
+ * Returning `false` from a listener prevents the operation
1527
+ * @param {object} event Event object
1528
+ * @param {Core.data.Model} event.groupRecord [DEPRECATED] Use `groupRecords` param instead
1529
+ * @param {Core.data.Model[]} event.groupRecords The group records being toggled
1530
+ * @param {boolean} event.collapse Collapsed (true) or expanded (false)
1531
+ * @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
1532
+ */
1533
+ onBeforeToggleGroup? : ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => Promise<boolean>|boolean|void)|string
1534
+ /**
1535
+ * Fired before a parent node record toggles its collapsed state.
1536
+ * @param {object} event Event object
1537
+ * @param {Grid.view.Grid} event.source The firing Grid instance.
1538
+ * @param {Core.data.Model} event.record The record being toggled.
1539
+ * @param {boolean} event.collapse `true` if the node is being collapsed.
1540
+ */
1541
+ onBeforeToggleNode? : ((event: { source: Grid, record: Model, collapse: boolean }) => void)|string
1542
+ /**
1543
+ * Fires on the owning Grid when editing is cancelled
1544
+ * @param {object} event Event object
1545
+ * @param {Grid.view.Grid} event.source Owner grid
1546
+ * @param {Grid.util.GridLocation} event.editorContext Editing context
1547
+ * @param {Event} event.event Included if the cancellation was triggered by a DOM event
1548
+ */
1549
+ onCancelCellEdit? : ((event: { source: Grid, editorContext: GridLocation, event: Event }) => void)|string
1550
+ /**
1551
+ * Fires when any other event is fired from the object.
1552
+ * ...
1553
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-catchAll)
1554
+ * @param {object} event Event object
1555
+ * @param {{[key: string]: any, type: string}} event.event The Object that contains event details
1556
+ * @param {string} event.event.type The type of the event which is caught by the listener
1557
+ */
1558
+ onCatchAll? : ((event: {[key: string]: any, type: string}) => void)|string
1559
+ /**
1560
+ * Fired when user clicks in a grid cell
1561
+ * @param {object} event Event object
1562
+ * @param {Grid.view.Grid} event.grid The grid instance
1563
+ * @param {Core.data.Model} event.record The record representing the row
1564
+ * @param {Grid.column.Column} event.column The column to which the cell belongs
1565
+ * @param {HTMLElement} event.cellElement The cell HTML element
1566
+ * @param {HTMLElement} event.target The target element
1567
+ * @param {MouseEvent} event.event The native DOM event
1568
+ */
1569
+ onCellClick? : ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string
1570
+ /**
1571
+ * Fired when user activates contextmenu in a grid cell
1572
+ * @param {object} event Event object
1573
+ * @param {Grid.view.Grid} event.grid The grid instance
1574
+ * @param {Core.data.Model} event.record The record representing the row
1575
+ * @param {Grid.column.Column} event.column The column to which the cell belongs
1576
+ * @param {HTMLElement} event.cellElement The cell HTML element
1577
+ * @param {HTMLElement} event.target The target element
1578
+ * @param {MouseEvent} event.event The native DOM event
1579
+ */
1580
+ onCellContextMenu? : ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string
1581
+ /**
1582
+ * Fired when user double clicks a grid cell
1583
+ * @param {object} event Event object
1584
+ * @param {Grid.view.Grid} event.grid The grid instance
1585
+ * @param {Core.data.Model} event.record The record representing the row
1586
+ * @param {Grid.column.Column} event.column The column to which the cell belongs
1587
+ * @param {HTMLElement} event.cellElement The cell HTML element
1588
+ * @param {HTMLElement} event.target The target element
1589
+ * @param {MouseEvent} event.event The native DOM event
1590
+ */
1591
+ onCellDblClick? : ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string
1592
+ /**
1593
+ * This event fires on the owning grid before the context menu is shown for a cell.
1594
+ * Allows manipulation of the items to show in the same way as in the [processItems](https://bryntum.com/products/scheduler/docs/api/Grid/feature/CellMenu#config-processItems).
1595
+ * ...
1596
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-cellMenuBeforeShow)
1597
+ * @param {object} event Event object
1598
+ * @param {Grid.view.Grid} event.source The grid
1599
+ * @param {Core.widget.Menu} event.menu The menu
1600
+ * @param {Record<string, MenuItemEntry>} event.items Menu item configs
1601
+ * @param {Grid.column.Column} event.column Column
1602
+ * @param {Core.data.Model} event.record Record
1603
+ */
1604
+ onCellMenuBeforeShow? : ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => Promise<boolean>|boolean|void)|string
1605
+ /**
1606
+ * This event fires on the owning grid when an item is selected in the cell context menu.
1607
+ * @param {object} event Event object
1608
+ * @param {Grid.view.Grid} event.source The grid
1609
+ * @param {Core.widget.Menu} event.menu The menu
1610
+ * @param {Core.widget.MenuItem} event.item Selected menu item
1611
+ * @param {Grid.column.Column} event.column Column
1612
+ * @param {Core.data.Model} event.record Record
1613
+ */
1614
+ onCellMenuItem? : ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column, record: Model }) => void)|string
1615
+ /**
1616
+ * This event fires on the owning grid after the context menu is shown for a cell.
1617
+ * @param {object} event Event object
1618
+ * @param {Grid.view.Grid} event.source The grid
1619
+ * @param {Core.widget.Menu} event.menu The menu
1620
+ * @param {Record<string, MenuItemEntry>} event.items Menu item configs
1621
+ * @param {Grid.column.Column} event.column Column
1622
+ * @param {Core.data.Model} event.record Record
1623
+ */
1624
+ onCellMenuShow? : ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => void)|string
1625
+ /**
1626
+ * This event fires on the owning grid when a check item is toggled in the cell context menu.
1627
+ * @param {object} event Event object
1628
+ * @param {Grid.view.Grid} event.source The grid
1629
+ * @param {Core.widget.Menu} event.menu The menu
1630
+ * @param {Core.widget.MenuItem} event.item Selected menu item
1631
+ * @param {Grid.column.Column} event.column Column
1632
+ * @param {Core.data.Model} event.record Record
1633
+ * @param {boolean} event.checked Checked or not
1634
+ */
1635
+ onCellMenuToggleItem? : ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column, record: Model, checked: boolean }) => void)|string
1636
+ /**
1637
+ * Fired when the mouse enters a cell
1638
+ * @param {object} event Event object
1639
+ * @param {Grid.view.Grid} event.source The grid instance
1640
+ * @param {Core.data.Model} event.record The record representing the hovered cell
1641
+ * @param {Grid.column.Column} event.column The column currently hovered
1642
+ * @param {HTMLElement} event.cellElement The cell HTML element
1643
+ * @param {MouseEvent} event.event The native DOM event
1644
+ */
1645
+ onCellMouseEnter? : ((event: { source: Grid, record: Model, column: Column, cellElement: HTMLElement, event: MouseEvent }) => void)|string
1646
+ /**
1647
+ * Fired when the mouse leaves a cell
1648
+ * @param {object} event Event object
1649
+ * @param {Grid.view.Grid} event.source The grid instance
1650
+ * @param {Core.data.Model} event.record The record representing the cell that the mouse left
1651
+ * @param {Grid.column.Column} event.column The column representing the cell that the mouse left
1652
+ * @param {HTMLElement} event.cellElement The cell HTML element that the mouse left
1653
+ * @param {MouseEvent} event.event The native DOM event
1654
+ */
1655
+ onCellMouseLeave? : ((event: { source: Grid, record: Model, column: Column, cellElement: HTMLElement, event: MouseEvent }) => void)|string
1656
+ /**
1657
+ * Fired when a user moves the mouse out of a grid cell
1658
+ * @param {object} event Event object
1659
+ * @param {Grid.view.Grid} event.grid The grid instance
1660
+ * @param {Core.data.Model} event.record The record representing the row
1661
+ * @param {Grid.column.Column} event.column The column to which the cell belongs
1662
+ * @param {HTMLElement} event.cellElement The cell HTML element
1663
+ * @param {HTMLElement} event.target The target element
1664
+ * @param {MouseEvent} event.event The native DOM event
1665
+ */
1666
+ onCellMouseOut? : ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string
1667
+ /**
1668
+ * Fired when user moves the mouse over a grid cell
1669
+ * @param {object} event Event object
1670
+ * @param {Grid.view.Grid} event.grid The grid instance
1671
+ * @param {Core.data.Model} event.record The record representing the row
1672
+ * @param {Grid.column.Column} event.column The column to which the cell belongs
1673
+ * @param {HTMLElement} event.cellElement The cell HTML element
1674
+ * @param {HTMLElement} event.target The target element
1675
+ * @param {MouseEvent} event.event The native DOM event
1676
+ */
1677
+ onCellMouseOver? : ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string
1678
+ /**
1679
+ * Fires when a Panel is collapsed using the [collapsible](https://bryntum.com/products/scheduler/docs/api/Core/widget/Panel#config-collapsible) setting.
1680
+ * @param {object} event Event object
1681
+ * @param {Core.widget.Panel} event.source This Panel.
1682
+ */
1683
+ onCollapse? : ((event: { source: Panel }) => void)|string
1684
+ /**
1685
+ * Fired before a parent node record is collapsed.
1686
+ * @param {object} event Event object
1687
+ * @param {Grid.view.Grid} event.source The firing Grid instance.
1688
+ * @param {Core.data.Model} event.record The record which has been collapsed.
1689
+ */
1690
+ onCollapseNode? : ((event: { source: Grid, record: Model }) => void)|string
1691
+ /**
1692
+ * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
1693
+ * to indicate whether the drop position is valid or not.
1694
+ * @param {object} event Event object
1695
+ * @param {Grid.view.Grid} event.source The grid instance.
1696
+ * @param {Grid.column.Column} event.column The dragged column.
1697
+ * @param {Grid.column.Column} event.insertBefore The column before which the dragged column will be inserted (if not last).
1698
+ * @param {Event} event.event The browser event.
1699
+ * @param {object} event.context
1700
+ * @param {boolean} event.context.valid Set this to `true` or `false` to indicate whether the drop position is valid.
1701
+ */
1702
+ onColumnDrag? : ((event: { source: Grid, column: Column, insertBefore: Column, event: Event, context: { valid: boolean } }) => void)|string
1703
+ /**
1704
+ * This event is fired when a column drag gesture has started.
1705
+ * @param {object} event Event object
1706
+ * @param {Grid.view.Grid} event.source The grid instance.
1707
+ * @param {Grid.column.Column} event.column The dragged column.
1708
+ * @param {Event} event.event The browser event.
1709
+ */
1710
+ onColumnDragStart? : ((event: { source: Grid, column: Column, event: Event }) => void)|string
1711
+ /**
1712
+ * This event is always fired after a column is dropped. The `valid` param is `true` if the operation was not
1713
+ * vetoed and the column was moved in the column store.
1714
+ * @param {object} event Event object
1715
+ * @param {Grid.view.Grid} event.source The grid instance.
1716
+ * @param {Grid.column.Column} event.column The dragged column.
1717
+ * @param {Grid.column.Column} event.insertBefore The column before which the dragged column will be inserted.
1718
+ * @param {Grid.column.Column} event.newParent The new parent column.
1719
+ * @param {boolean} event.valid `true` if the operation was not vetoed.
1720
+ * @param {Event} event.event The browser event.
1721
+ * @param {string} event.region The region where the column was dropped.
1722
+ */
1723
+ onColumnDrop? : ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => Promise<boolean>|boolean|void)|string
1724
+ /**
1725
+ * This event is fired after a resize gesture is completed.
1726
+ * @param {object} event Event object
1727
+ * @param {Grid.view.Grid} event.source The grid instance
1728
+ * @param {Grid.column.Column} event.column The resized column
1729
+ * @param {Event} event.domEvent The browser event
1730
+ */
1731
+ onColumnResize? : ((event: { source: Grid, column: Column, domEvent: Event }) => void)|string
1732
+ /**
1733
+ * This event is fired when a column resize gesture starts.
1734
+ * @param {object} event Event object
1735
+ * @param {Grid.view.Grid} event.source The grid instance
1736
+ * @param {Grid.column.Column} event.column The column
1737
+ * @param {Event} event.domEvent The browser event
1738
+ */
1739
+ onColumnResizeStart? : ((event: { source: Grid, column: Column, domEvent: Event }) => void)|string
1740
+ /**
1741
+ * This event fires on the owning widget when an item is selected in the context menu.
1742
+ * @param {object} event Event object
1743
+ * @param {Core.widget.Widget} event.source The owning widget
1744
+ * @param {Core.widget.Menu} event.menu The menu
1745
+ * @param {Core.widget.MenuItem} event.item Selected menu item
1746
+ */
1747
+ onContextMenuItem? : ((event: { source: Widget, menu: Menu, item: MenuItem }) => void)|string
1748
+ /**
1749
+ * This event fires on the owning widget when a check item is toggled in the context menu.
1750
+ * @param {object} event Event object
1751
+ * @param {Core.widget.Widget} event.source The owning widget
1752
+ * @param {Core.widget.Menu} event.menu The menu
1753
+ * @param {Core.widget.MenuItem} event.item Selected menu item
1754
+ * @param {boolean} event.checked Checked or not
1755
+ */
1756
+ onContextMenuToggleItem? : ((event: { source: Widget, menu: Menu, item: MenuItem, checked: boolean }) => void)|string
1757
+ /**
1758
+ * Fires on the owning Grid after a copy action is performed.
1759
+ * @param {object} event Event object
1760
+ * @param {Grid.view.Grid} event.source Owner grid
1761
+ * @param {Grid.util.GridLocation[]} event.cells The cells about to be copied or cut
1762
+ * @param {string} event.copiedDataString The concatenated data string that was copied or cut
1763
+ * @param {boolean} event.isCut `true` if this was a cut action
1764
+ * @param {string} event.entityName 'cell' to distinguish this event from other copy events
1765
+ */
1766
+ onCopy? : ((event: { source: Grid, cells: GridLocation[], copiedDataString: string, isCut: boolean, entityName: string }) => void)|string
1767
+ /**
1768
+ * Fires on the owning Scheduler/Gantt when the line indicating the current time is updated (see [currentTimeLineUpdateInterval](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/TimeRanges#config-currentTimeLineUpdateInterval)).
1769
+ * @param {object} event Event object
1770
+ * @param {Scheduler.view.Scheduler} event.source The scheduler
1771
+ * @param {Date} event.date The current date
1772
+ */
1773
+ onCurrentTimelineUpdate? : ((event: { source: Scheduler, date: Date }) => void)|string
1774
+ /**
1775
+ * Fired when data in the store changes.
1776
+ * ...
1777
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-dataChange)
1778
+ * @param {object} event Event object
1779
+ * @param {Grid.view.Grid} event.source Owning grid
1780
+ * @param {Core.data.Store} event.store The originating store
1781
+ * @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'`
1782
+ * @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
1783
+ * @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
1784
+ * @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
1785
+ */
1786
+ onDataChange? : ((event: { source: Grid, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
1787
+ /**
1788
+ * Fired when the range of dates encapsulated by the UI changes. This will be when
1789
+ * moving a view in time by reconfiguring its [timeAxis](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineBase#config-timeAxis). This will happen
1790
+ * when zooming, or changing [viewPreset](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineBase#config-viewPreset).
1791
+ * ...
1792
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-dateRangeChange)
1793
+ * @param {object} event Event object
1794
+ * @param {Scheduler.view.TimelineBase} event.source This Scheduler/Gantt instance.
1795
+ * @param {object} event.old The old date range
1796
+ * @param {Date} event.old.startDate the old start date.
1797
+ * @param {Date} event.old.endDate the old end date.
1798
+ * @param {object} event.new The new date range
1799
+ * @param {Date} event.new.startDate the new start date.
1800
+ * @param {Date} event.new.endDate the new end date.
1801
+ */
1802
+ onDateRangeChange? : ((event: { source: TimelineBase, old: { startDate: Date, endDate: Date }, new: { startDate: Date, endDate: Date } }) => void)|string
1803
+ /**
1804
+ * Fires when an object is destroyed.
1805
+ * @param {object} event Event object
1806
+ * @param {Core.Base} event.source The Object that is being destroyed.
1807
+ */
1808
+ onDestroy? : ((event: { source: Base }) => void)|string
1809
+ /**
1810
+ * Fires when a field is mutated and the state of the [hasChanges](https://bryntum.com/products/scheduler/docs/api/Core/widget/Container#property-hasChanges) property changes
1811
+ * @param {object} event Event object
1812
+ * @param {Core.widget.Container} event.source The container.
1813
+ * @param {boolean} event.dirty The dirty state of the Container - `true` if there are any fields which have been changed since initial load.
1814
+ */
1815
+ onDirtyStateChange? : ((event: { source: Container, dirty: boolean }) => void)|string
1816
+ /**
1817
+ * Fires while drag selecting. UI will update with current range, but the cells will not be selected until
1818
+ * mouse up. This event can be listened for to perform actions while drag selecting.
1819
+ * @param {object} event Event object
1820
+ * @param {Grid.view.Grid} event.source
1821
+ * @param {GridLocationConfig[],Grid.util.GridLocation[]} event.selectedCells The cells that is currently being dragged over
1822
+ * @param {Core.data.Model[]} event.selectedRecords The records that is currently being dragged over
1823
+ */
1824
+ onDragSelecting? : ((event: { source: Grid, selectedCells: GridLocationConfig[]|GridLocation[], selectedRecords: Model[] }) => void)|string
1825
+ /**
1826
+ * Triggered when a widget's [element](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-element) is available.
1827
+ * @param {object} event Event object
1828
+ * @param {HTMLElement} event.element The Widget's element.
1829
+ */
1830
+ onElementCreated? : ((event: { element: HTMLElement }) => void)|string
1831
+ /**
1832
+ * Fires when a Panel is expanded using the [collapsible](https://bryntum.com/products/scheduler/docs/api/Core/widget/Panel#config-collapsible) setting.
1833
+ * @param {object} event Event object
1834
+ * @param {Core.widget.Panel} event.source This Panel.
1835
+ */
1836
+ onExpand? : ((event: { source: Panel }) => void)|string
1837
+ /**
1838
+ * Fired after a parent node record is expanded.
1839
+ * @param {object} event Event object
1840
+ * @param {Grid.view.Grid} event.source The firing Grid instance.
1841
+ * @param {Core.data.Model} event.record The record which has been expanded.
1842
+ */
1843
+ onExpandNode? : ((event: { source: Grid, record: Model }) => void)|string
1844
+ /**
1845
+ * Fired when a file is dropped on the widget element
1846
+ * @param {object} event Event object
1847
+ * @param {Grid.view.Grid} event.source The owning Grid instance
1848
+ * @param {DataTransferItem} event.file The dropped file descriptor
1849
+ * @param {DragEvent} event.domEvent The native DragEvent
1850
+ */
1851
+ onFileDrop? : ((event: { source: Grid, file: DataTransferItem, domEvent: DragEvent }) => void)|string
1852
+ /**
1853
+ * Fired before the FillHandle dragging is finalized and values are applied to cells, return `false` to prevent the
1854
+ * drag operation from applying data changes.
1855
+ * @param {object} event Event object
1856
+ * @param {Grid.util.GridLocation} event.from The from cell
1857
+ * @param {Grid.util.GridLocation} event.to The to cell
1858
+ * @param {MouseEvent} event.domEvent The raw DOM event
1859
+ */
1860
+ onFillHandleBeforeDragFinalize? : ((event: { from: GridLocation, to: GridLocation, domEvent: MouseEvent }) => Promise<boolean>|boolean|void)|string
1861
+ /**
1862
+ * Fired while dragging the FillHandle.
1863
+ * @param {object} event Event object
1864
+ * @param {Grid.util.GridLocation} event.from The from cell
1865
+ * @param {Grid.util.GridLocation} event.to The to cell
1866
+ * @param {MouseEvent} event.domEvent The raw DOM event
1867
+ */
1868
+ onFillHandleDrag? : ((event: { from: GridLocation, to: GridLocation, domEvent: MouseEvent }) => void)|string
1869
+ /**
1870
+ * Fired when a FillHandle drag operation is aborted.
1871
+ */
1872
+ onFillHandleDragAbort? : (() => void)|string
1873
+ /**
1874
+ * Fired after a FillHandle drag operation.
1875
+ * @param {object} event Event object
1876
+ * @param {Grid.util.GridLocation} event.from The from cell
1877
+ * @param {Grid.util.GridLocation} event.to The to cell
1878
+ * @param {MouseEvent} event.domEvent The raw DOM event
1879
+ */
1880
+ onFillHandleDragEnd? : ((event: { from: GridLocation, to: GridLocation, domEvent: MouseEvent }) => void)|string
1881
+ /**
1882
+ * Fired when dragging of the FillHandle starts.
1883
+ * @param {object} event Event object
1884
+ * @param {Grid.util.GridLocation} event.cell Information about the column / record
1885
+ * @param {MouseEvent} event.domEvent The raw DOM event
1886
+ */
1887
+ onFillHandleDragStart? : ((event: { cell: GridLocation, domEvent: MouseEvent }) => Promise<boolean>|boolean|void)|string
1888
+ /**
1889
+ * Fires on the owning Grid when cell editing is finished
1890
+ * @param {object} event Event object
1891
+ * @param {Grid.view.Grid} event.grid Target grid
1892
+ * @param {CellEditorContext} event.editorContext Editing context
1893
+ */
1894
+ onFinishCellEdit? : ((event: { grid: Grid, editorContext: CellEditorContext }) => void)|string
1895
+ /**
1896
+ * 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.
1897
+ * ...
1898
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-finishRowEdit)
1899
+ * @param {object} event Event object
1900
+ * @param {Grid.view.Grid} event.grid Target grid
1901
+ * @param {RowEditorContext} event.editorContext Editing context
1902
+ */
1903
+ onFinishRowEdit? : ((event: { grid: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string
1904
+ /**
1905
+ * Fired when focus enters this Widget.
1906
+ * @param {object} event Event object
1907
+ * @param {Core.widget.Widget} event.source This Widget
1908
+ * @param {HTMLElement} event.fromElement The element which lost focus.
1909
+ * @param {HTMLElement} event.toElement The element which gained focus.
1910
+ * @param {Core.widget.Widget} event.fromWidget The widget which lost focus.
1911
+ * @param {Core.widget.Widget} event.toWidget The widget which gained focus.
1912
+ * @param {boolean} event.backwards `true` if the `toElement` is before the `fromElement` in document order.
1913
+ */
1914
+ onFocusIn? : ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string
1915
+ /**
1916
+ * Fired when focus exits this Widget's ownership tree. This is different from a `blur` event.
1917
+ * focus moving from within this Widget's ownership tree, even if there are floating widgets
1918
+ * will not trigger this event. This is when focus exits this widget completely.
1919
+ * @param {object} event Event object
1920
+ * @param {Core.widget.Widget} event.source This Widget
1921
+ * @param {HTMLElement} event.fromElement The element which lost focus.
1922
+ * @param {HTMLElement} event.toElement The element which gained focus.
1923
+ * @param {Core.widget.Widget} event.fromWidget The widget which lost focus.
1924
+ * @param {Core.widget.Widget} event.toWidget The widget which gained focus.
1925
+ * @param {boolean} event.backwards `true` if the `toElement` is before the `fromElement` in document order.
1926
+ */
1927
+ onFocusOut? : ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string
1928
+ /**
1929
+ * Fired before dragging starts, return false to prevent the drag operation.
1930
+ * @param {object} event Event object
1931
+ * @param {Grid.view.GridBase} event.source
1932
+ * @param {object} event.context
1933
+ * @param {Core.data.Model[]} event.context.records The dragged row records
1934
+ * @param {MouseEvent,TouchEvent} event.event
1935
+ */
1936
+ onGridRowBeforeDragStart? : ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => Promise<boolean>|boolean|void)|string
1937
+ /**
1938
+ * Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
1939
+ * Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
1940
+ * @param {object} event Event object
1941
+ * @param {Grid.view.GridBase} event.source
1942
+ * @param {object} event.context
1943
+ * @param {boolean} event.context.valid Set this to true or false to indicate whether the drop position is valid
1944
+ * @param {Core.data.Model} event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
1945
+ * @param {Core.data.Model} event.context.parent The parent record of the current drop position (only applicable for trees)
1946
+ * @param {Core.data.Model[]} event.context.records The dragged row records
1947
+ * @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
1948
+ * @param {MouseEvent} event.event
1949
+ */
1950
+ onGridRowBeforeDropFinalize? : ((event: { source: GridBase, context: { valid: boolean, insertBefore: Model, parent: Model, records: Model[], oldPositionContext: RecordPositionContext[] }, event: MouseEvent }) => Promise<boolean>|boolean|void)|string
1951
+ /**
1952
+ * Fired while the row is being dragged, in the listener function you have access to `context.insertBefore` a grid /
1953
+ * tree record, and additionally `context.parent` (a TreeNode) for trees. You can signal that the drop position is
1954
+ * valid or invalid by setting `context.valid = false;`
1955
+ * @param {object} event Event object
1956
+ * @param {Grid.view.GridBase} event.source
1957
+ * @param {object} event.context
1958
+ * @param {boolean} event.context.valid Set this to true or false to indicate whether the drop position is valid.
1959
+ * @param {Core.data.Model} event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
1960
+ * @param {Core.data.Model} event.context.parent The parent record of the current drop position (only applicable for trees)
1961
+ * @param {Core.data.Model[]} event.context.records The dragged row records
1962
+ * @param {MouseEvent} event.event
1963
+ */
1964
+ onGridRowDrag? : ((event: { source: GridBase, context: { valid: boolean, insertBefore: Model, parent: Model, records: Model[] }, event: MouseEvent }) => void)|string
1965
+ /**
1966
+ * Fired when a row drag operation is aborted
1967
+ * @param {object} event Event object
1968
+ * @param {Grid.view.GridBase} event.source
1969
+ * @param {object} event.context
1970
+ * @param {Core.data.Model[]} event.context.records The dragged row records
1971
+ * @param {MouseEvent} event.event
1972
+ */
1973
+ onGridRowDragAbort? : ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent }) => void)|string
1974
+ /**
1975
+ * Fired when dragging starts.
1976
+ * @param {object} event Event object
1977
+ * @param {Grid.view.GridBase} event.source
1978
+ * @param {object} event.context
1979
+ * @param {Core.data.Model[]} event.context.records The dragged row records
1980
+ * @param {MouseEvent,TouchEvent} event.event
1981
+ */
1982
+ onGridRowDragStart? : ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => void)|string
1983
+ /**
1984
+ * Fired after the row drop operation has completed, regardless of validity
1985
+ * @param {object} event Event object
1986
+ * @param {Grid.view.GridBase} event.source
1987
+ * @param {object} event.context
1988
+ * @param {boolean} event.context.valid true or false depending on whether the drop position was valid
1989
+ * @param {Core.data.Model} event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
1990
+ * @param {Core.data.Model} event.context.parent The parent record of the current drop position (only applicable for trees)
1991
+ * @param {Core.data.Model[]} event.context.records The dragged row records
1992
+ * @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
1993
+ * @param {MouseEvent} event.event
1994
+ */
1995
+ onGridRowDrop? : ((event: { source: GridBase, context: { valid: boolean, insertBefore: Model, parent: Model, records: Model[], oldPositionContext: RecordPositionContext[] }, event: MouseEvent }) => void)|string
1996
+ /**
1997
+ * Fired when a grid header is clicked on.
1998
+ * ...
1999
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-headerClick)
2000
+ * @param {object} event Event object
2001
+ * @param {Event} event.domEvent The triggering DOM event.
2002
+ * @param {Grid.column.Column} event.column The column clicked on.
2003
+ */
2004
+ onHeaderClick? : ((event: { domEvent: Event, column: Column }) => Promise<boolean>|boolean|void)|string
2005
+ /**
2006
+ * This event fires on the owning Grid before the context menu is shown for a header.
2007
+ * Allows manipulation of the items to show in the same way as in the [processItems](https://bryntum.com/products/scheduler/docs/api/Grid/feature/HeaderMenu#config-processItems).
2008
+ * ...
2009
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-headerMenuBeforeShow)
2010
+ * @param {object} event Event object
2011
+ * @param {Grid.view.Grid} event.source The grid
2012
+ * @param {Core.widget.Menu} event.menu The menu
2013
+ * @param {Record<string, MenuItemEntry>} event.items Menu item configs
2014
+ * @param {Grid.column.Column} event.column Column
2015
+ */
2016
+ onHeaderMenuBeforeShow? : ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => Promise<boolean>|boolean|void)|string
2017
+ /**
2018
+ * This event fires on the owning Grid when an item is selected in the header context menu.
2019
+ * @param {object} event Event object
2020
+ * @param {Grid.view.Grid} event.source The grid
2021
+ * @param {Core.widget.Menu} event.menu The menu
2022
+ * @param {Core.widget.MenuItem} event.item Selected menu item
2023
+ * @param {Grid.column.Column} event.column Column
2024
+ */
2025
+ onHeaderMenuItem? : ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column }) => void)|string
2026
+ /**
2027
+ * This event fires on the owning Grid after the context menu is shown for a header
2028
+ * @param {object} event Event object
2029
+ * @param {Grid.view.Grid} event.source The grid
2030
+ * @param {Core.widget.Menu} event.menu The menu
2031
+ * @param {Record<string, MenuItemEntry>} event.items Menu item configs
2032
+ * @param {Grid.column.Column} event.column Column
2033
+ */
2034
+ onHeaderMenuShow? : ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => void)|string
2035
+ /**
2036
+ * This event fires on the owning Grid when a check item is toggled in the header context menu.
2037
+ * @param {object} event Event object
2038
+ * @param {Grid.view.Grid} event.source The grid
2039
+ * @param {Core.widget.Menu} event.menu The menu
2040
+ * @param {Core.widget.MenuItem} event.item Selected menu item
2041
+ * @param {Grid.column.Column} event.column Column
2042
+ * @param {boolean} event.checked Checked or not
2043
+ */
2044
+ onHeaderMenuToggleItem? : ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column, checked: boolean }) => void)|string
2045
+ /**
2046
+ * Triggered after a widget was hidden
2047
+ * @param {object} event Event object
2048
+ * @param {Core.widget.Widget} event.source The widget
2049
+ */
2050
+ onHide? : ((event: { source: Widget }) => void)|string
2051
+ /**
2052
+ * Fires after the component retrieves a record's histogram data and stores
2053
+ * it into the cache.
2054
+ * ...
2055
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-histogramDataCacheSet)
2056
+ * @param {object} event Event object
2057
+ * @param {Scheduler.view.TimelineHistogram} event.source The component instance
2058
+ * @param {Core.data.Model} event.record Record the histogram data of which is ready.
2059
+ * @param {object} event.data The record histogram data.
2060
+ */
2061
+ onHistogramDataCacheSet? : ((event: { source: TimelineHistogram, record: Model, data: object }) => void)|string
2062
+ /**
2063
+ * Fires when row locking is enabled.
2064
+ * @param {object} event Event object
2065
+ * @param {Grid.view.GridBase} event.clone The created clone
2066
+ */
2067
+ onLockRows? : ((event: { clone: GridBase }) => void)|string
2068
+ /**
2069
+ * Mouse moved out from element in grid
2070
+ * @param {object} event Event object
2071
+ * @param {MouseEvent} event.event The native browser event
2072
+ */
2073
+ onMouseOut? : ((event: { event: MouseEvent }) => void)|string
2074
+ /**
2075
+ * Mouse moved in over element in grid
2076
+ * @param {object} event Event object
2077
+ * @param {MouseEvent} event.event The native browser event
2078
+ */
2079
+ onMouseOver? : ((event: { event: MouseEvent }) => void)|string
2080
+ /**
2081
+ * Fires when the requested date range cannot fit into any zoom level higher than the current level.
2082
+ * @param {object} event Event object
2083
+ * @param {number} event.currentZoomLevel The current zoom level
2084
+ * @param {Date} event.startDate The requested start date
2085
+ * @param {Date} event.endDate The requested end date
2086
+ */
2087
+ onNoZoomChange? : ((event: { currentZoomLevel: number, startDate: Date, endDate: Date }) => void)|string
2088
+ /**
2089
+ * Triggered when a widget which had been in a non-visible state for any reason
2090
+ * achieves visibility.
2091
+ * ...
2092
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-paint)
2093
+ * @param {object} event Event object
2094
+ * @param {Core.widget.Widget} event.source The widget being painted.
2095
+ * @param {boolean} event.firstPaint `true` if this is the first paint.
2096
+ */
2097
+ onPaint? : ((event: { source: Widget, firstPaint: boolean }) => void)|string
2098
+ /**
2099
+ * Fires on the owning Grid after a paste action is performed.
2100
+ * @param {object} event Event object
2101
+ * @param {Grid.view.Grid} event.source Owner grid
2102
+ * @param {string} event.clipboardData The clipboardData that was pasted
2103
+ * @param {Core.data.Model[]} event.modifiedRecords The records which have been modified due to the paste action
2104
+ * @param {Grid.util.GridLocation} event.targetCell The cell from which the paste will be started
2105
+ * @param {string} event.entityName 'cell' to distinguish this event from other paste events
2106
+ */
2107
+ onPaste? : ((event: { source: Grid, clipboardData: string, modifiedRecords: Model[], targetCell: GridLocation, entityName: string }) => void)|string
2108
+ /**
2109
+ * Fires on the owning Grid when export has finished
2110
+ * @param {object} event Event object
2111
+ * @param {Response} event.response Optional response, if received
2112
+ * @param {Error} event.error Optional error, if exception occurred
2113
+ */
2114
+ onPdfExport? : ((event: { response?: any, error?: Error }) => void)|string
2115
+ /**
2116
+ * Fired after the [viewPreset](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineViewPresets#config-viewPreset) has changed.
2117
+ * @param {object} event Event object
2118
+ * @param {Scheduler.view.Scheduler} event.source This Scheduler instance.
2119
+ * @param {Date} event.startDate The new start date of the timeline.
2120
+ * @param {Date} event.centerDate The new center date of the timeline.
2121
+ * @param {Date} event.endDate The new end date of the timeline.
2122
+ * @param {Scheduler.preset.ViewPreset} event.from The outgoing ViewPreset.
2123
+ * @param {Scheduler.preset.ViewPreset} event.to The ViewPreset being switched to.
2124
+ */
2125
+ onPresetChange? : ((event: { source: Scheduler, startDate: Date, centerDate: Date, endDate: Date, from: ViewPreset, to: ViewPreset }) => Promise<boolean>|boolean|void)|string
2126
+ /**
2127
+ * Fired when a Widget's read only state is toggled
2128
+ * @param {object} event Event object
2129
+ * @param {boolean} event.readOnly Read only or not
2130
+ */
2131
+ onReadOnly? : ((event: { readOnly: boolean }) => void)|string
2132
+ /**
2133
+ * This event is fired after a widget's elements have been synchronized due to a direct or indirect call
2134
+ * to [recompose](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#function-recompose), if this results in some change to the widget's rendered DOM elements.
2135
+ */
2136
+ onRecompose? : (() => void)|string
2137
+ /**
2138
+ * Fires after a row is rendered.
2139
+ * @param {object} event Event object
2140
+ * @param {Grid.view.Grid} event.source The firing Grid instance.
2141
+ * @param {Grid.row.Row} event.row The row that has been rendered.
2142
+ * @param {Core.data.Model} event.record The record for the row.
2143
+ * @param {number} event.recordIndex The zero-based index of the record.
2144
+ */
2145
+ onRenderRow? : ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
2146
+ /**
2147
+ * Grid rows have been rendered
2148
+ * @param {object} event Event object
2149
+ * @param {Grid.view.Grid} event.source This grid.
2150
+ */
2151
+ onRenderRows? : ((event: { source: Grid }) => void)|string
2152
+ /**
2153
+ * Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
2154
+ * @param {object} event Event object
2155
+ * @param {Core.widget.Widget} event.source This Widget
2156
+ * @param {number} event.width The new width
2157
+ * @param {number} event.height The new height
2158
+ * @param {number} event.oldWidth The old width
2159
+ * @param {number} event.oldHeight The old height
2160
+ */
2161
+ onResize? : ((event: { source: Widget, width: number, height: number, oldWidth: number, oldHeight: number }) => void)|string
2162
+ /**
2163
+ * This event fires on the owning scheduler before the context menu is shown for a resource.
2164
+ * Allows manipulation of the items to show in the same way as in the [processItems](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ResourceMenu#config-processItems).
2165
+ * ...
2166
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-resourceMenuBeforeShow)
2167
+ * @param {object} event Event object
2168
+ * @param {Scheduler.view.Scheduler} event.source The grid
2169
+ * @param {Core.widget.Menu} event.menu The menu
2170
+ * @param {Record<string, MenuItemEntry>} event.items Menu item configs
2171
+ * @param {Grid.column.Column} event.column Column
2172
+ * @param {Scheduler.model.ResourceModel} event.resourceRecord Record
2173
+ */
2174
+ onResourceMenuBeforeShow? : ((event: { source: Scheduler, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, resourceRecord: ResourceModel }) => Promise<boolean>|boolean|void)|string
2175
+ /**
2176
+ * This event fires on the owning scheduler when an item is selected in the context menu.
2177
+ * @param {object} event Event object
2178
+ * @param {Scheduler.view.Scheduler} event.source The grid
2179
+ * @param {Core.widget.Menu} event.menu The menu
2180
+ * @param {Core.widget.MenuItem} event.item Selected menu item
2181
+ * @param {Scheduler.model.ResourceModel} event.record Record
2182
+ */
2183
+ onResourceMenuItem? : ((event: { source: Scheduler, menu: Menu, item: MenuItem, record: ResourceModel }) => void)|string
2184
+ /**
2185
+ * This event fires on the owning scheduler after the context menu is shown for a resource.
2186
+ * @param {object} event Event object
2187
+ * @param {Scheduler.view.Scheduler} event.source The grid
2188
+ * @param {Core.widget.Menu} event.menu The menu
2189
+ * @param {Record<string, MenuItemEntry>} event.items Menu item configs
2190
+ * @param {Scheduler.model.ResourceModel} event.record Record
2191
+ */
2192
+ onResourceMenuShow? : ((event: { source: Scheduler, menu: Menu, items: Record<string, MenuItemEntry>, record: ResourceModel }) => void)|string
2193
+ /**
2194
+ * This event fires on the owning grid when a check item is toggled in the context menu.
2195
+ * @param {object} event Event object
2196
+ * @param {Scheduler.view.Scheduler} event.source The grid
2197
+ * @param {Core.widget.Menu} event.menu The menu
2198
+ * @param {Core.widget.MenuItem} event.item Selected menu item
2199
+ * @param {Scheduler.model.ResourceModel} event.resourceRecord Record
2200
+ * @param {boolean} event.checked Checked or not
2201
+ */
2202
+ onResourceMenuToggleItem? : ((event: { source: Scheduler, menu: Menu, item: MenuItem, resourceRecord: ResourceModel, checked: boolean }) => void)|string
2203
+ /**
2204
+ * Triggered for click on a resource time range. Only triggered if the ResourceTimeRange feature is configured with
2205
+ * `enableMouseEvents: true`.
2206
+ * @param {object} event Event object
2207
+ * @param {Scheduler.view.Scheduler} event.source This Scheduler
2208
+ * @param {Scheduler.feature.ResourceTimeRanges} event.feature The ResourceTimeRange feature
2209
+ * @param {Scheduler.model.ResourceTimeRangeModel} event.resourceTimeRangeRecord Resource time range record
2210
+ * @param {Scheduler.model.ResourceModel} event.resourceRecord Resource record
2211
+ * @param {MouseEvent} event.domEvent Browser event
2212
+ */
2213
+ onResourceTimeRangeClick? : ((event: { source: Scheduler, feature: ResourceTimeRanges, resourceTimeRangeRecord: ResourceTimeRangeModel, resourceRecord: ResourceModel, domEvent: MouseEvent }) => void)|string
2214
+ /**
2215
+ * Triggered for right-click on a resource time range. Only triggered if the ResourceTimeRange feature is configured
2216
+ * with `enableMouseEvents: true`.
2217
+ * @param {object} event Event object
2218
+ * @param {Scheduler.view.Scheduler} event.source This Scheduler
2219
+ * @param {Scheduler.feature.ResourceTimeRanges} event.feature The ResourceTimeRange feature
2220
+ * @param {Scheduler.model.ResourceTimeRangeModel} event.resourceTimeRangeRecord Resource time range record
2221
+ * @param {Scheduler.model.ResourceModel} event.resourceRecord Resource record
2222
+ * @param {MouseEvent} event.domEvent Browser event
2223
+ */
2224
+ onResourceTimeRangeContextMenu? : ((event: { source: Scheduler, feature: ResourceTimeRanges, resourceTimeRangeRecord: ResourceTimeRangeModel, resourceRecord: ResourceModel, domEvent: MouseEvent }) => void)|string
2225
+ /**
2226
+ * Triggered for double-click on a resource time range. Only triggered if the ResourceTimeRange feature is configured
2227
+ * with `enableMouseEvents: true`.
2228
+ * @param {object} event Event object
2229
+ * @param {Scheduler.view.Scheduler} event.source This Scheduler
2230
+ * @param {Scheduler.feature.ResourceTimeRanges} event.feature The ResourceTimeRange feature
2231
+ * @param {Scheduler.model.ResourceTimeRangeModel} event.resourceTimeRangeRecord Resource time range record
2232
+ * @param {Scheduler.model.ResourceModel} event.resourceRecord Resource record
2233
+ * @param {MouseEvent} event.domEvent Browser event
2234
+ */
2235
+ onResourceTimeRangeDblClick? : ((event: { source: Scheduler, feature: ResourceTimeRanges, resourceTimeRangeRecord: ResourceTimeRangeModel, resourceRecord: ResourceModel, domEvent: MouseEvent }) => void)|string
2236
+ /**
2237
+ * Triggered for mouse down ona resource time range. Only triggered if the ResourceTimeRange feature is configured
2238
+ * with `enableMouseEvents: true`.
2239
+ * @param {object} event Event object
2240
+ * @param {Scheduler.view.Scheduler} event.source This Scheduler
2241
+ * @param {Scheduler.feature.ResourceTimeRanges} event.feature The ResourceTimeRange feature
2242
+ * @param {Scheduler.model.ResourceTimeRangeModel} event.resourceTimeRangeRecord Resource time range record
2243
+ * @param {Scheduler.model.ResourceModel} event.resourceRecord Resource record
2244
+ * @param {MouseEvent} event.domEvent Browser event
2245
+ */
2246
+ onResourceTimeRangeMouseDown? : ((event: { source: Scheduler, feature: ResourceTimeRanges, resourceTimeRangeRecord: ResourceTimeRangeModel, resourceRecord: ResourceModel, domEvent: MouseEvent }) => void)|string
2247
+ /**
2248
+ * Triggered for mouse out of a resource time range. Only triggered if the ResourceTimeRange feature is configured
2249
+ * with `enableMouseEvents: true`.
2250
+ * @param {object} event Event object
2251
+ * @param {Scheduler.view.Scheduler} event.source This Scheduler
2252
+ * @param {Scheduler.feature.ResourceTimeRanges} event.feature The ResourceTimeRange feature
2253
+ * @param {Scheduler.model.ResourceTimeRangeModel} event.resourceTimeRangeRecord Resource time range record
2254
+ * @param {Scheduler.model.ResourceModel} event.resourceRecord Resource record
2255
+ * @param {MouseEvent} event.domEvent Browser event
2256
+ */
2257
+ onResourceTimeRangeMouseOut? : ((event: { source: Scheduler, feature: ResourceTimeRanges, resourceTimeRangeRecord: ResourceTimeRangeModel, resourceRecord: ResourceModel, domEvent: MouseEvent }) => void)|string
2258
+ /**
2259
+ * Triggered for mouse over on a resource time range. Only triggered if the ResourceTimeRange feature is configured
2260
+ * with `enableMouseEvents: true`.
2261
+ * @param {object} event Event object
2262
+ * @param {Scheduler.view.Scheduler} event.source This Scheduler
2263
+ * @param {Scheduler.feature.ResourceTimeRanges} event.feature The ResourceTimeRange feature
2264
+ * @param {Scheduler.model.ResourceTimeRangeModel} event.resourceTimeRangeRecord Resource time range record
2265
+ * @param {Scheduler.model.ResourceModel} event.resourceRecord Resource record
2266
+ * @param {MouseEvent} event.domEvent Browser event
2267
+ */
2268
+ onResourceTimeRangeMouseOver? : ((event: { source: Scheduler, feature: ResourceTimeRanges, resourceTimeRangeRecord: ResourceTimeRangeModel, resourceRecord: ResourceModel, domEvent: MouseEvent }) => void)|string
2269
+ /**
2270
+ * Triggered for mouse up ona resource time range. Only triggered if the ResourceTimeRange feature is configured
2271
+ * with `enableMouseEvents: true`.
2272
+ * @param {object} event Event object
2273
+ * @param {Scheduler.view.Scheduler} event.source This Scheduler
2274
+ * @param {Scheduler.feature.ResourceTimeRanges} event.feature The ResourceTimeRange feature
2275
+ * @param {Scheduler.model.ResourceTimeRangeModel} event.resourceTimeRangeRecord Resource time range record
2276
+ * @param {Scheduler.model.ResourceModel} event.resourceRecord Resource record
2277
+ * @param {MouseEvent} event.domEvent Browser event
2278
+ */
2279
+ onResourceTimeRangeMouseUp? : ((event: { source: Scheduler, feature: ResourceTimeRanges, resourceTimeRangeRecord: ResourceTimeRangeModel, resourceRecord: ResourceModel, domEvent: MouseEvent }) => void)|string
2280
+ /**
2281
+ * Grid resize lead to a new responsive level being applied
2282
+ * @param {object} event Event object
2283
+ * @param {Grid.view.Grid} event.grid Grid that was resized
2284
+ * @param {string} event.level New responsive level (small, large, etc)
2285
+ * @param {number} event.width New width in px
2286
+ * @param {string} event.oldLevel Old responsive level
2287
+ * @param {number} event.oldWidth Old width in px
2288
+ */
2289
+ onResponsive? : ((event: { grid: Grid, level: string, width: number, oldLevel: string, oldWidth: number }) => void)|string
2290
+ /**
2291
+ * This event fires when a row has finished collapsing.
2292
+ * @param {object} event Event object
2293
+ * @param {Core.data.Model} event.record Record
2294
+ */
2295
+ onRowCollapse? : ((event: { record: Model }) => void)|string
2296
+ /**
2297
+ * This event fires when a row expand has finished expanding.
2298
+ * ...
2299
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-rowExpand)
2300
+ * @param {object} event Event object
2301
+ * @param {Core.data.Model} event.record Record
2302
+ * @param {object} event.expandedElements An object with the Grid region name as property and the expanded body element as value
2303
+ * @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.
2304
+ * @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
2305
+ */
2306
+ onRowExpand? : ((event: { record: Model, expandedElements: object, widget: Widget, widgets: object }) => void)|string
2307
+ /**
2308
+ * Fired when the mouse enters a row
2309
+ * @param {object} event Event object
2310
+ * @param {Grid.view.Grid} event.source The grid instance
2311
+ * @param {Core.data.Model} event.record The record representing the hovered row
2312
+ * @param {Grid.column.Column} event.column The column currently hovered
2313
+ * @param {HTMLElement} event.cellElement The cell HTML element
2314
+ * @param {MouseEvent} event.event The native DOM event
2315
+ */
2316
+ onRowMouseEnter? : ((event: { source: Grid, record: Model, column: Column, cellElement: HTMLElement, event: MouseEvent }) => void)|string
2317
+ /**
2318
+ * Fired when the mouse leaves a row
2319
+ * @param {object} event Event object
2320
+ * @param {Grid.view.Grid} event.source The grid instance
2321
+ * @param {Core.data.Model} event.record The record representing the row that the mouse left
2322
+ * @param {HTMLElement} event.cellElement The cell HTML element that the mouse left
2323
+ * @param {MouseEvent} event.event The native DOM event
2324
+ */
2325
+ onRowMouseLeave? : ((event: { source: Grid, record: Model, cellElement: HTMLElement, event: MouseEvent }) => void)|string
2326
+ /**
2327
+ * Grid has scrolled vertically
2328
+ * @param {object} event Event object
2329
+ * @param {Grid.view.Grid} event.source The firing Grid instance.
2330
+ * @param {number} event.scrollTop The vertical scroll position.
2331
+ */
2332
+ onScroll? : ((event: { source: Grid, scrollTop: number }) => void)|string
2333
+ /**
2334
+ * The selection has been changed.
2335
+ * @param {object} event Event object
2336
+ * @param {'select','deselect'} event.action `'select'`/`'deselect'`
2337
+ * @param {'row','cell'} event.mode `'row'`/`'cell'`
2338
+ * @param {Grid.view.Grid} event.source
2339
+ * @param {Core.data.Model[]} event.deselected The records deselected in this operation.
2340
+ * @param {Core.data.Model[]} event.selected The records selected in this operation.
2341
+ * @param {Core.data.Model[]} event.selection The records in the new selection.
2342
+ * @param {Grid.util.GridLocation[]} event.deselectedCells The cells deselected in this operation.
2343
+ * @param {Grid.util.GridLocation[]} event.selectedCells The cells selected in this operation.
2344
+ * @param {Grid.util.GridLocation[]} event.cellSelection The cells in the new selection.
2345
+ */
2346
+ onSelectionChange? : ((event: { action: 'select'|'deselect', mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => void)|string
2347
+ /**
2348
+ * The selectionMode configuration has been changed.
2349
+ * @param {object} event Event object
2350
+ * @param {object} event.selectionMode The new [selectionMode](https://bryntum.com/products/scheduler/docs/api/Grid/view/mixin/GridSelection#config-selectionMode)
2351
+ */
2352
+ onSelectionModeChange? : ((event: { selectionMode: object }) => void)|string
2353
+ /**
2354
+ * Triggered after a widget is shown.
2355
+ * @param {object} event Event object
2356
+ * @param {Core.widget.Widget} event.source The widget
2357
+ */
2358
+ onShow? : ((event: { source: Widget }) => void)|string
2359
+ /**
2360
+ * Fires when splitting the Grid.
2361
+ * @param {object} event Event object
2362
+ * @param {Grid.view.GridBase[]} event.subViews The sub views created by the split
2363
+ * @param {object} event.options The options passed to the split call
2364
+ * @param {'horizontal','vertical','both'} event.options.direction The direction of the split
2365
+ * @param {Grid.column.Column} event.options.atColumn The column to split at
2366
+ * @param {Core.data.Model} event.options.atRecord The record to split at
2367
+ */
2368
+ onSplit? : ((event: { subViews: GridBase[], options: { direction: 'horizontal'|'vertical'|'both', atColumn: Column, atRecord: Model } }) => void)|string
2369
+ /**
2370
+ * Fired by the Grid when the collapse icon is clicked. Return `false` to prevent the default collapse action,
2371
+ * if you want to implement your own behavior.
2372
+ * @param {object} event Event object
2373
+ * @param {Grid.view.Grid} event.source The Grid instance.
2374
+ * @param {Grid.view.SubGrid} event.subGrid The subgrid
2375
+ * @param {Event} event.domEvent The native DOM event
2376
+ */
2377
+ onSplitterCollapseClick? : ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => Promise<boolean>|boolean|void)|string
2378
+ /**
2379
+ * Fired by the Grid after a sub-grid has been resized using the splitter
2380
+ * @param {object} event Event object
2381
+ * @param {Grid.view.Grid} event.source The Grid instance.
2382
+ * @param {Grid.view.SubGrid} event.subGrid The resized subgrid
2383
+ * @param {Event} event.domEvent The native DOM event
2384
+ */
2385
+ onSplitterDragEnd? : ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => void)|string
2386
+ /**
2387
+ * Fired by the Grid when a sub-grid resize gesture starts
2388
+ * @param {object} event Event object
2389
+ * @param {Grid.view.Grid} event.source The Grid instance.
2390
+ * @param {Grid.view.SubGrid} event.subGrid The subgrid about to be resized
2391
+ * @param {Event} event.domEvent The native DOM event
2392
+ */
2393
+ onSplitterDragStart? : ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => void)|string
2394
+ /**
2395
+ * Fired by the Grid when the expand icon is clicked. Return `false` to prevent the default expand action,
2396
+ * if you want to implement your own behavior.
2397
+ * @param {object} event Event object
2398
+ * @param {Grid.view.Grid} event.source The Grid instance.
2399
+ * @param {Grid.view.SubGrid} event.subGrid The subgrid
2400
+ * @param {Event} event.domEvent The native DOM event
2401
+ */
2402
+ onSplitterExpandClick? : ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => Promise<boolean>|boolean|void)|string
2403
+ /**
2404
+ * Fires on the owning Grid when editing starts
2405
+ * @param {object} event Event object
2406
+ * @param {Grid.view.Grid} event.source Owner grid
2407
+ * @param {CellEditorContext} event.editorContext Editing context
2408
+ */
2409
+ onStartCellEdit? : ((event: { source: Grid, editorContext: CellEditorContext }) => void)|string
2410
+ /**
2411
+ * Fires on the owning Grid when editing starts
2412
+ * @param {object} event Event object
2413
+ * @param {Grid.view.Grid} event.source Owner grid
2414
+ * @param {RowEditorContext} event.editorContext Editing context
2415
+ */
2416
+ onStartRowEdit? : ((event: { source: Grid, editorContext: RowEditorContext }) => void)|string
2417
+ /**
2418
+ * Fires after a sub grid is collapsed.
2419
+ * @param {object} event Event object
2420
+ * @param {Grid.view.Grid} event.source The firing Grid instance
2421
+ * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
2422
+ */
2423
+ onSubGridCollapse? : ((event: { source: Grid, subGrid: SubGrid }) => void)|string
2424
+ /**
2425
+ * Fires after a sub grid is expanded.
2426
+ * @param {object} event Event object
2427
+ * @param {Grid.view.Grid} event.source The firing Grid instance
2428
+ * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
2429
+ */
2430
+ onSubGridExpand? : ((event: { source: Grid, subGrid: SubGrid }) => void)|string
2431
+ /**
2432
+ * Fired when the tick size changes.
2433
+ * ...
2434
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-tickSizeChange)
2435
+ * @param {object} event Event object
2436
+ * @param {Scheduler.view.Scheduler} event.source This Scheduler instance.
2437
+ * @param {number} event.tickSize The tick size in pixels
2438
+ */
2439
+ onTickSizeChange? : ((event: { source: Scheduler, tickSize: number }) => void)|string
2440
+ /**
2441
+ * Fired when the timeaxis has changed, for example by zooming or configuring a new time span.
2442
+ * @param {object} event Event object
2443
+ * @param {Scheduler.view.Scheduler} event.source This Scheduler
2444
+ * @param {object} event.config Config object used to reconfigure the time axis.
2445
+ * @param {Date} event.config.startDate New start date (if supplied)
2446
+ * @param {Date} event.config.endDate New end date (if supplied)
2447
+ */
2448
+ onTimeAxisChange? : ((event: { source: Scheduler, config: { startDate: Date, endDate: Date } }) => void)|string
2449
+ /**
2450
+ * Fires after a click on a time axis cell
2451
+ * @param {object} event Event object
2452
+ * @param {Scheduler.column.TimeAxisColumn,Scheduler.column.VerticalTimeAxisColumn} event.source The column object
2453
+ * @param {Date} event.startDate The start date of the header cell
2454
+ * @param {Date} event.endDate The end date of the header cell
2455
+ * @param {Event} event.event The event object
2456
+ */
2457
+ onTimeAxisHeaderClick? : ((event: { source: TimeAxisColumn|VerticalTimeAxisColumn, startDate: Date, endDate: Date, event: Event }) => void)|string
2458
+ /**
2459
+ * Fires after a right click on a time axis cell
2460
+ * @param {object} event Event object
2461
+ * @param {Scheduler.column.TimeAxisColumn,Scheduler.column.VerticalTimeAxisColumn} event.source The column object
2462
+ * @param {Date} event.startDate The start date of the header cell
2463
+ * @param {Date} event.endDate The end date of the header cell
2464
+ * @param {Event} event.event The event object
2465
+ */
2466
+ onTimeAxisHeaderContextMenu? : ((event: { source: TimeAxisColumn|VerticalTimeAxisColumn, startDate: Date, endDate: Date, event: Event }) => void)|string
2467
+ /**
2468
+ * Fires after a double click on a time axis cell
2469
+ * @param {object} event Event object
2470
+ * @param {Scheduler.column.TimeAxisColumn,Scheduler.column.VerticalTimeAxisColumn} event.source The column object
2471
+ * @param {Date} event.startDate The start date of the header cell
2472
+ * @param {Date} event.endDate The end date of the header cell
2473
+ * @param {Event} event.event The event object
2474
+ */
2475
+ onTimeAxisHeaderDblClick? : ((event: { source: TimeAxisColumn|VerticalTimeAxisColumn, startDate: Date, endDate: Date, event: Event }) => void)|string
2476
+ /**
2477
+ * This event fires on the owning Scheduler or Gantt widget before the context menu is shown for the time axis header.
2478
+ * Allows manipulation of the items to show in the same way as in the [processItems](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/TimeAxisHeaderMenu#config-processItems).
2479
+ * ...
2480
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-timeAxisHeaderMenuBeforeShow)
2481
+ * @param {object} event Event object
2482
+ * @param {Scheduler.view.Scheduler} event.source The scheduler
2483
+ * @param {Core.widget.Menu} event.menu The menu
2484
+ * @param {Record<string, MenuItemEntry>} event.items Menu item configs
2485
+ * @param {Grid.column.Column} event.column Time axis column
2486
+ */
2487
+ onTimeAxisHeaderMenuBeforeShow? : ((event: { source: Scheduler, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => Promise<boolean>|boolean|void)|string
2488
+ /**
2489
+ * This event fires on the owning Scheduler or Gantt widget when an item is selected in the header context menu.
2490
+ * @param {object} event Event object
2491
+ * @param {Scheduler.view.Scheduler} event.source The scheduler
2492
+ * @param {Core.widget.Menu} event.menu The menu
2493
+ * @param {Core.widget.MenuItem} event.item Selected menu item
2494
+ * @param {Grid.column.Column} event.column Time axis column
2495
+ */
2496
+ onTimeAxisHeaderMenuItem? : ((event: { source: Scheduler, menu: Menu, item: MenuItem, column: Column }) => void)|string
2497
+ /**
2498
+ * This event fires on the owning Scheduler or Gantt widget after the context menu is shown for a header
2499
+ * @param {object} event Event object
2500
+ * @param {Scheduler.view.Scheduler} event.source The scheduler
2501
+ * @param {Core.widget.Menu} event.menu The menu
2502
+ * @param {Record<string, MenuItemEntry>} event.items Menu item configs
2503
+ * @param {Grid.column.Column} event.column Time axis column
2504
+ */
2505
+ onTimeAxisHeaderMenuShow? : ((event: { source: Scheduler, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => void)|string
2506
+ /**
2507
+ * Fired when the pointer-activated [timelineContext](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineDomEvents#property-timelineContext) has changed.
2508
+ * @param {object} event Event object
2509
+ * @param {Scheduler.util.TimelineContext} event.oldContext The tick/resource context being deactivated.
2510
+ * @param {Scheduler.util.TimelineContext} event.context The tick/resource context being activated.
2511
+ */
2512
+ onTimelineContextChange? : ((event: { oldContext: TimelineContext, context: TimelineContext }) => void)|string
2513
+ /**
2514
+ * Fired when the *scheduler* viewport (not the overall Scheduler element) changes size.
2515
+ * This happens when the grid changes height, or when the subgrid which encapsulates the
2516
+ * scheduler column changes width.
2517
+ * @param {object} event Event object
2518
+ * @param {Core.widget.Widget} event.source This Scheduler
2519
+ * @param {number} event.width The new width
2520
+ * @param {number} event.height The new height
2521
+ * @param {number} event.oldWidth The old width
2522
+ * @param {number} event.oldHeight The old height
2523
+ */
2524
+ onTimelineViewportResize? : ((event: { source: Widget, width: number, height: number, oldWidth: number, oldHeight: number }) => void)|string
2525
+ /**
2526
+ * Fired on the owning Scheduler or Gantt widget when a click happens on a time range header element
2527
+ * @param {object} event Event object
2528
+ * @param {Scheduler.view.Scheduler} event.source Scheduler instance
2529
+ * @param {Scheduler.model.TimeSpan} event.timeRangeRecord The record
2530
+ * @param {MouseEvent} event.domEvent Browser event
2531
+ */
2532
+ onTimeRangeHeaderClick? : ((event: { source: Scheduler, timeRangeRecord: TimeSpan, domEvent: MouseEvent }) => void)|string
2533
+ /**
2534
+ * Fired on the owning Scheduler or Gantt widget when a right click happens on a time range header element
2535
+ * @param {object} event Event object
2536
+ * @param {Scheduler.view.Scheduler} event.source Scheduler instance
2537
+ * @param {Scheduler.model.TimeSpan} event.timeRangeRecord The record
2538
+ * @param {MouseEvent} event.domEvent Browser event
2539
+ */
2540
+ onTimeRangeHeaderContextMenu? : ((event: { source: Scheduler, timeRangeRecord: TimeSpan, domEvent: MouseEvent }) => void)|string
2541
+ /**
2542
+ * Fired on the owning Scheduler or Gantt widget when a double click happens on a time range header element
2543
+ * @param {object} event Event object
2544
+ * @param {Scheduler.view.Scheduler} event.source Scheduler instance
2545
+ * @param {Scheduler.model.TimeSpan} event.timeRangeRecord The record
2546
+ * @param {MouseEvent} event.domEvent Browser event
2547
+ */
2548
+ onTimeRangeHeaderDblClick? : ((event: { source: Scheduler, timeRangeRecord: TimeSpan, domEvent: MouseEvent }) => void)|string
2549
+ /**
2550
+ * Fired when one or more groups are expanded or collapsed
2551
+ * @param {object} event Event object
2552
+ * @param {Core.data.Model} event.groupRecord [DEPRECATED] Use `groupRecords` param instead
2553
+ * @param {Core.data.Model[]} event.groupRecords The group records being toggled
2554
+ * @param {boolean} event.collapse Collapsed (true) or expanded (false)
2555
+ * @param {boolean} event.allRecords True if this event is part of toggling all groups
2556
+ */
2557
+ onToggleGroup? : ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, allRecords?: boolean }) => void)|string
2558
+ /**
2559
+ * Fired after a parent node record toggles its collapsed state.
2560
+ * @param {object} event Event object
2561
+ * @param {Core.data.Model} event.record The record being toggled.
2562
+ * @param {boolean} event.collapse `true` if the node is being collapsed.
2563
+ */
2564
+ onToggleNode? : ((event: { record: Model, collapse: boolean }) => void)|string
2565
+ /**
2566
+ * A header [tool](https://bryntum.com/products/scheduler/docs/api/Core/widget/Panel#config-tools) has been clicked.
2567
+ * @param {object} event Event object
2568
+ * @param {Core.widget.Tool} event.source This Panel.
2569
+ * @param {Core.widget.Tool} event.tool The tool which is being clicked.
2570
+ */
2571
+ onToolClick? : ((event: { source: Tool, tool: Tool }) => void)|string
2572
+ /**
2573
+ * Fires when row locking is disabled.
2574
+ * @param {object} event Event object
2575
+ * @param {Grid.view.GridBase} event.clone The locked clone that will be destroyed
2576
+ */
2577
+ onUnlockRows? : ((event: { clone: GridBase }) => void)|string
2578
+ /**
2579
+ * Fires when un-splitting the Grid.
2580
+ */
2581
+ onUnsplit? : (() => void)|string
2582
+ /**
2583
+ * Fired when the range of dates visible within the viewport changes. This will be when
2584
+ * scrolling along a time axis.
2585
+ * ...
2586
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-visibleDateRangeChange)
2587
+ * @param {object} event Event object
2588
+ * @param {Scheduler.view.Scheduler} event.source This Scheduler instance.
2589
+ * @param {object} event.old The old date range
2590
+ * @param {Date} event.old.startDate the old start date.
2591
+ * @param {Date} event.old.endDate the old end date.
2592
+ * @param {object} event.new The new date range
2593
+ * @param {Date} event.new.startDate the new start date.
2594
+ * @param {Date} event.new.endDate the new end date.
2595
+ */
2596
+ onVisibleDateRangeChange? : ((event: { source: Scheduler, old: { startDate: Date, endDate: Date }, new: { startDate: Date, endDate: Date } }) => void)|string
2597
+
2598
+ // Features
2599
+ /**
2600
+ * AI-powered filter feature for Grid. Allows users to type natural language queries to filter grid data.
2601
+ * ...
2602
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/ai/AIFilter)
2603
+ */
2604
+ aiFilterFeature? : object|boolean|string|AIFilter|AIFilterConfig
2605
+ /**
2606
+ * Allows using `[Ctrl/CMD + C]`, `[Ctrl/CMD + X]` and `[Ctrl/CMD + V]` to cut, copy and paste cell or cell ranges. Also
2607
+ * makes cut, copy and paste actions available via the cell context menu.
2608
+ * ...
2609
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/CellCopyPaste)
2610
+ */
2611
+ cellCopyPasteFeature? : object|boolean|string|CellCopyPaste|CellCopyPasteConfig
2612
+ /**
2613
+ * Adding this feature to the grid and other Bryntum products which are based on the Grid (i.e. Scheduler, SchedulerPro, and Gantt)
2614
+ * enables cell editing. Any subclass of [Field](https://bryntum.com/products/scheduler/docs/api/Core/widget/Field) can be used
2615
+ * as editor for the [Column](https://bryntum.com/products/scheduler/docs/api/Grid/column/Column). The most popular are:
2616
+ * ...
2617
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/CellEdit)
2618
+ */
2619
+ cellEditFeature? : object|boolean|string|CellEdit|CellEditConfig
2620
+ /**
2621
+ * Right click to display context menu for cells. To invoke the cell menu in a keyboard-accessible manner, use the
2622
+ * `SPACE` key when the cell is focused.
2623
+ * ...
2624
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/CellMenu)
2625
+ */
2626
+ cellMenuFeature? : object|boolean|string|CellMenu|CellMenuConfig
2627
+ /**
2628
+ * Displays a tooltip when hovering cells.
2629
+ * ...
2630
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/CellTooltip)
2631
+ */
2632
+ cellTooltipFeature? : object|boolean|string|CellTooltip|CellTooltipConfig
2633
+ /**
2634
+ * Adds interactive charting to a Grid. [Charts](https://bryntum.com/products/scheduler/docs/api/Chart/widget/Chart) can be created from a selection of Grid data
2635
+ * and updated in realtime as data changes. Supports many common chart types with extensive styling and customization
2636
+ * options.
2637
+ * ...
2638
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Charts)
2639
+ */
2640
+ chartsFeature? : object|boolean|string|Charts|ChartsConfig
2641
+ /**
2642
+ * Enables the [autoWidth](https://bryntum.com/products/scheduler/docs/api/Grid/column/Column#config-autoWidth) config for a grid's columns.
2643
+ * ...
2644
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/ColumnAutoWidth)
2645
+ */
2646
+ columnAutoWidthFeature? : object|boolean|string|ColumnAutoWidth|ColumnAutoWidthConfig
2647
+ /**
2648
+ * Displays a toolbar while dragging column headers. Drop on a button in the toolbar to activate a certain function,
2649
+ * for example to group by that column. This feature simplifies certain operations on touch devices.
2650
+ * ...
2651
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/ColumnDragToolbar)
2652
+ */
2653
+ columnDragToolbarFeature? : object|boolean|string|ColumnDragToolbar|ColumnDragToolbarConfig
2654
+ /**
2655
+ * Displays column lines for ticks, with a different styling for major ticks (by default they are darker). If this
2656
+ * feature is disabled, no lines are shown. If it's enabled, line are shown for the tick level which is set in current
2657
+ * ViewPreset. Please see [columnLinesFor](https://bryntum.com/products/scheduler/docs/api/Scheduler/preset/ViewPreset#field-columnLinesFor) config for details.
2658
+ * ...
2659
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ColumnLines)
2660
+ */
2661
+ columnLinesFeature? : object|boolean|string|ColumnLines|ColumnLinesConfig
2662
+ /**
2663
+ * Displays a column picker (to show/hide columns) in the header context menu. Columns can be displayed in sub menus
2664
+ * by region or tag. Grouped headers are displayed as menu hierarchies.
2665
+ * ...
2666
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/ColumnPicker)
2667
+ */
2668
+ columnPickerFeature? : object|boolean|string|ColumnPicker|ColumnPickerConfig
2669
+ /**
2670
+ * Allows user to rename columns by either right-clicking column header or using keyboard shortcuts when column header
2671
+ * is focused.
2672
+ * ...
2673
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/ColumnRename)
2674
+ */
2675
+ columnRenameFeature? : object|boolean|string|ColumnRename|ColumnRenameConfig
2676
+ /**
2677
+ * Allows user to reorder columns by dragging headers. To get notified about column reorder listen to `change` event
2678
+ * on [columns](https://bryntum.com/products/scheduler/docs/api/Grid/data/ColumnStore) store.
2679
+ * ...
2680
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/ColumnReorder)
2681
+ */
2682
+ columnReorderFeature? : object|boolean|string|ColumnReorder|ColumnReorderConfig
2683
+ /**
2684
+ * Enables user to resize columns by dragging a handle on the right hand side of the header. To get notified about column
2685
+ * resize listen to `change` event on [columns](https://bryntum.com/products/scheduler/docs/api/Grid/data/ColumnStore) store.
2686
+ * ...
2687
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/ColumnResize)
2688
+ */
2689
+ columnResizeFeature? : object|boolean|string|ColumnResize|ColumnResizeConfig
2690
+ /**
2691
+ * A feature that allows exporting Grid data to Excel or CSV without involving the server. It uses
2692
+ * [TableExporter](https://bryntum.com/products/scheduler/docs/api/Grid/util/TableExporter) class as data provider, 3rd party provider to generate XLS files, and
2693
+ * [Microsoft XML specification](https://msdn.microsoft.com/en-us/library/office/documentformat.openxml.spreadsheet.aspx).
2694
+ * ...
2695
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/experimental/ExcelExporter)
2696
+ */
2697
+ excelExporterFeature? : object|boolean|string|GridExcelExporter|GridExcelExporterConfig
2698
+ /**
2699
+ * An experimental feature that lets users drop files on a Widget. The widget fires an event when a file is dropped onto it.
2700
+ * In the event, you get access to the raw files as strings, that were parsed by calling `readAsBinaryString`.
2701
+ * ...
2702
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/experimental/FileDrop)
2703
+ */
2704
+ fileDropFeature? : object|boolean|string|FileDrop|FileDropConfig
2705
+ /**
2706
+ * This feature adds a fill handle to a Grid range selection, which when dragged, fills the cells being dragged over
2707
+ * with values based on the values in the original selected range. This is similar to functionality normally seen in
2708
+ * various spreadsheet applications.
2709
+ * ...
2710
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/FillHandle)
2711
+ */
2712
+ fillHandleFeature? : object|boolean|string|FillHandle|FillHandleConfig
2713
+ /**
2714
+ * Feature that allows filtering of the grid by settings filters on columns. The actual filtering is done by the store.
2715
+ * For info on programmatically handling filters, see [StoreFilter](https://bryntum.com/products/scheduler/docs/api/Core/data/mixin/StoreFilter).
2716
+ * ...
2717
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Filter)
2718
+ */
2719
+ filterFeature? : object|boolean|string|Filter|FilterConfig
2720
+ /**
2721
+ * Feature that allows filtering of the grid by entering filters on column headers.
2722
+ * The actual filtering is done by the store.
2723
+ * For info on programmatically handling filters, see [StoreFilter](https://bryntum.com/products/scheduler/docs/api/Core/data/mixin/StoreFilter).
2724
+ * ...
2725
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/FilterBar)
2726
+ */
2727
+ filterBarFeature? : object|boolean|string|FilterBar|FilterBarConfig
2728
+ /**
2729
+ * Enables rendering and handling of row groups. The actual grouping is done in the store, but triggered by
2730
+ * <kbd>shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
2731
+ * one anywhere on grid). Use <kbd>shift</kbd> + <kbd>alt</kbd> + click, or the context menu, to remove a column
2732
+ * grouper.
2733
+ * ...
2734
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Group)
2735
+ */
2736
+ groupFeature? : object|boolean|string|Group|GroupConfig
2737
+ /**
2738
+ * A special version of the Grid GroupSummary feature that enables summaries within scheduler. To use a single summary
2739
+ * it is easiest to configure [renderer](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/GroupSummary#config-renderer), for multiple summaries see [summaries](#Scheduler/feature/GroupSummary#config-summaries).
2740
+ * ...
2741
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/GroupSummary)
2742
+ */
2743
+ groupSummaryFeature? : object|boolean|string|GroupSummary|GroupSummaryConfig
2744
+ /**
2745
+ * Right click column header or focus it and press SPACE key to show the context menu for headers.
2746
+ * ...
2747
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/HeaderMenu)
2748
+ */
2749
+ headerMenuFeature? : object|boolean|string|HeaderMenu|HeaderMenuConfig
2750
+ /**
2751
+ * Enables users to click and drag to zoom to a date range in Scheduler's header time axis. Only supported in horizontal
2752
+ * mode.
2753
+ * ...
2754
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/HeaderZoom)
2755
+ */
2756
+ headerZoomFeature? : object|boolean|string|HeaderZoom|HeaderZoomConfig
2757
+ /**
2758
+ * This feature allows records which satisfy a certain condition to be locked at the top of the grid.
2759
+ * ...
2760
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/LockRows)
2761
+ */
2762
+ lockRowsFeature? : object|boolean|string|GridLockRows|GridLockRowsConfig
2763
+ /**
2764
+ * This feature merges cells that have the same value in sorted (or [optionally](https://bryntum.com/products/scheduler/docs/api/Grid/feature/MergeCells#config-sortedOnly) any) columns
2765
+ * configured to [mergeCells](https://bryntum.com/products/scheduler/docs/api/Grid/column/Column#config-mergeCells).
2766
+ * ...
2767
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/MergeCells)
2768
+ */
2769
+ mergeCellsFeature? : object|boolean|string|MergeCells|MergeCellsConfig
2770
+ /**
2771
+ * Feature that allows styling of weekends (and other non-working time) by adding timeRanges for those days.
2772
+ * ...
2773
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/NonWorkingTime)
2774
+ */
2775
+ nonWorkingTimeFeature? : object|boolean|string|NonWorkingTime|NonWorkingTimeConfig
2776
+ /**
2777
+ * Makes the scheduler's timeline pannable by dragging with the mouse. Try it out in the demo below.
2778
+ * ...
2779
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Pan)
2780
+ */
2781
+ panFeature? : object|boolean|string|Pan|PanConfig
2782
+ /**
2783
+ * Generates PDF/PNG files from the Grid component.
2784
+ * ...
2785
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/export/PdfExport)
2786
+ */
2787
+ pdfExportFeature? : object|boolean|string|GridPdfExport|GridPdfExportConfig
2788
+ /**
2789
+ * Allows pinning columns to the start or end region of the grid without any additional subGrid configurations.
2790
+ * When pinning to a region that does not yet exist, the feature creates the required subGrid on the fly.
2791
+ * ...
2792
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/PinColumns)
2793
+ */
2794
+ pinColumnsFeature? : object|boolean|string|PinColumns|PinColumnsConfig
2795
+ /**
2796
+ * Allows printing Grid contents using browser print dialog.
2797
+ * ...
2798
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/export/Print)
2799
+ */
2800
+ printFeature? : object|boolean|string|GridPrint|GridPrintConfig
2801
+ /**
2802
+ * Feature that allows the user to search in a column by focusing a cell and typing. Navigate between hits using the
2803
+ * keyboard, [f3] or [ctrl]/[cmd] + [g] moves to next, also pressing [shift] moves to previous.
2804
+ * ...
2805
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/QuickFind)
2806
+ */
2807
+ quickFindFeature? : object|boolean|string|QuickFind|QuickFindConfig
2808
+ /**
2809
+ * Makes the splitter between grid [sections](https://bryntum.com/products/scheduler/docs/api/Grid/view/SubGrid) draggable, to let users resize, and
2810
+ * collapse/expand the sections.
2811
+ * ...
2812
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/RegionResize)
2813
+ */
2814
+ regionResizeFeature? : object|boolean|string|RegionResize|RegionResizeConfig
2815
+ /**
2816
+ * Applicable only for Scheduler in `vertical` mode. Right click resource header cells to display a context menu.
2817
+ * ...
2818
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ResourceMenu)
2819
+ */
2820
+ resourceMenuFeature? : object|boolean|string|ResourceMenu|ResourceMenuConfig
2821
+ /**
2822
+ * Feature that draws resource time ranges, shaded areas displayed behind events. These zones are similar to events in
2823
+ * that they have a start and end date but different in that they do not take part in the event layout, and they always
2824
+ * occupy full row height.
2825
+ * ...
2826
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ResourceTimeRanges)
2827
+ */
2828
+ resourceTimeRangesFeature? : object|boolean|string|ResourceTimeRanges|ResourceTimeRangesConfig
2829
+ /**
2830
+ * Allow using [Ctrl/CMD + C/X] and [Ctrl/CMD + V] to copy/cut-and-paste rows. Also makes cut, copy and paste actions
2831
+ * available via the cell context menu.
2832
+ * ...
2833
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/RowCopyPaste)
2834
+ */
2835
+ rowCopyPasteFeature? : object|boolean|string|RowCopyPaste|RowCopyPasteConfig
2836
+ /**
2837
+ * This feature allows editing of entire rows in a grid in a docked panel which by default slides out from the right.
2838
+ * ...
2839
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/RowEdit)
2840
+ */
2841
+ rowEditFeature? : object|boolean|string|RowEdit|RowEditConfig
2842
+ /**
2843
+ * Enables expanding of Grid rows by either row click or double click, or by adding a separate Grid column which renders
2844
+ * a button that expands or collapses the row.
2845
+ * ...
2846
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/RowExpander)
2847
+ */
2848
+ rowExpanderFeature? : object|boolean|string|RowExpander|RowExpanderConfig
2849
+ /**
2850
+ * This feature implements support for project transactions and used by default in Gantt. For general RowReorder feature
2851
+ * documentation see [RowReorder](https://bryntum.com/products/scheduler/docs/api/Grid/feature/RowReorder).
2852
+ * ...
2853
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/RowReorder)
2854
+ */
2855
+ rowReorderFeature? : object|boolean|string|RowReorder|RowReorderConfig
2856
+ /**
2857
+ * Enables user to change row height by dragging the bottom row border. After a resize operation, the [rowHeight](https://bryntum.com/products/scheduler/docs/api/Grid/data/GridRowModel#field-rowHeight)
2858
+ * field of the record is updated (when [applyToAllRows](https://bryntum.com/products/scheduler/docs/api/Grid/feature/RowResize#config-applyToAllRows) is `false`).
2859
+ * ...
2860
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/RowResize)
2861
+ */
2862
+ rowResizeFeature? : object|boolean|string|GridRowResize|GridRowResizeConfig
2863
+ /**
2864
+ * Feature that displays a tooltip containing the time at the mouse position when hovering empty parts of the schedule.
2865
+ * ...
2866
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ScheduleTooltip)
2867
+ */
2868
+ scheduleTooltipFeature? : object|boolean|string|ScheduleTooltip|ScheduleTooltipConfig
2869
+ /**
2870
+ * <div class="external-example vertical" data-file="Grid/feature/Search.js"></div>
2871
+ * ...
2872
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Search)
2873
+ */
2874
+ searchFeature? : object|boolean|string|Search|SearchConfig
2875
+ /**
2876
+ * Allows sorting of grid by clicking (or tapping) headers, also displays which columns grid is sorted by (numbered if
2877
+ * using multisort). Use modifier keys for multisorting: [Ctrl/CMD + click] to add sorter, [Ctrl/CMD + Alt + click] to remove sorter.
2878
+ * The actual sorting is done by the store, see [Store.sort()](https://bryntum.com/products/scheduler/docs/api/Core/data/mixin/StoreSort#function-sort).
2879
+ * ...
2880
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Sort)
2881
+ */
2882
+ sortFeature? : object|boolean|string|Sort|SortConfig
2883
+ /**
2884
+ * This feature allows splitting the Scheduler into multiple views, either by using the cell context menu, or
2885
+ * programmatically by calling [split()](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Split#function-split).
2886
+ * ...
2887
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Split)
2888
+ */
2889
+ splitFeature? : object|boolean|string|Split|SplitConfig
2890
+ /**
2891
+ * A feature which pins configurable content from a grid row to the top of the grid
2892
+ * while the row scrolls off the top but is still visible.
2893
+ * ...
2894
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/StickyCells)
2895
+ */
2896
+ stickyCellsFeature? : object|boolean|string|StickyCells|StickyCellsConfig
2897
+ /**
2898
+ * Stripes rows by adding alternating CSS classes to all row elements (`b-even` and `b-odd`).
2899
+ * ...
2900
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Stripe)
2901
+ */
2902
+ stripeFeature? : object|boolean|string|Stripe|StripeConfig
2903
+ /**
2904
+ * A special version of the Grid Summary feature. This feature displays a summary row in the grid footer.
2905
+ * ...
2906
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Summary)
2907
+ */
2908
+ summaryFeature? : object|boolean|string|Summary|SummaryConfig
2909
+ /**
2910
+ * Adds scheduler specific menu items to the timeline header context menu.
2911
+ * ...
2912
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/TimeAxisHeaderMenu)
2913
+ */
2914
+ timeAxisHeaderMenuFeature? : object|boolean|string|TimeAxisHeaderMenu|TimeAxisHeaderMenuConfig
2915
+ /**
2916
+ * Feature that renders global ranges of time in the timeline. Use this feature to visualize a `range` like a 1 hr lunch
2917
+ * or some important point in time (a `line`, i.e. a range with 0 duration). This feature can also show a current time
2918
+ * indicator if you set [showCurrentTimeLine](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/TimeRanges#config-showCurrentTimeLine) to true. To style the rendered elements, use the
2919
+ * [cls](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/TimeSpan#field-cls) field of the `TimeSpan` class.
2920
+ * ...
2921
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/TimeRanges)
2922
+ */
2923
+ timeRangesFeature? : object|boolean|string|TimeRanges|TimeRangesConfig
2924
+ /**
2925
+ * Feature that makes the grid work more like a tree. Included by default in [TreeGrid](https://bryntum.com/products/scheduler/docs/api/Grid/view/TreeGrid). Requires
2926
+ * exactly one [TreeColumn](https://bryntum.com/products/scheduler/docs/api/Grid/column/TreeColumn) among grids columns. That column will have its renderer replaced with a
2927
+ * tree renderer that adds padding and icon to give the appearance of a tree. The original renderer is preserved and
2928
+ * also called.
2929
+ * ...
2930
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Tree)
2931
+ */
2932
+ treeFeature? : object|boolean|string|Tree|TreeConfig
2933
+ /**
2934
+ * A feature that allows transforming a flat dataset (or the leaves of a hierarchical) into a tree by specifying a
2935
+ * record field per parent level. Parents are generated based on each leaf's value for those fields.
2936
+ * ...
2937
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/TreeGroup)
2938
+ */
2939
+ treeGroupFeature? : object|boolean|string|TreeGroup|TreeGroupConfig
2940
+
2941
+ }
2942
+
2943
+ export class BryntumTimelineHistogram extends React.Component<BryntumTimelineHistogramProps> {
2944
+
2945
+ static instanceClass = TimelineHistogram;
2946
+
2947
+ static instanceName = 'TimelineHistogram';
2948
+
2949
+ processWidgetContent = processWidgetContent;
2950
+
2951
+ // Component is View class
2952
+ static isView = true;
2953
+
2954
+ // Hidden div to host unused portals DOM
2955
+ portalsCache? : HTMLElement;
2956
+
2957
+ // CSS class used for individual portal containers
2958
+ portalContainerClass = 'b-react-portal-container';
2959
+
2960
+ state = {
2961
+ // Holds React portals
2962
+ portals : new Map(),
2963
+
2964
+ // Needed to trigger refresh when portals change
2965
+ generation : 0
2966
+ };
2967
+
2968
+ static featureNames = [
2969
+ 'aiFilterFeature',
2970
+ 'cellCopyPasteFeature',
2971
+ 'cellEditFeature',
2972
+ 'cellMenuFeature',
2973
+ 'cellTooltipFeature',
2974
+ 'chartsFeature',
2975
+ 'columnAutoWidthFeature',
2976
+ 'columnDragToolbarFeature',
2977
+ 'columnLinesFeature',
2978
+ 'columnPickerFeature',
2979
+ 'columnRenameFeature',
2980
+ 'columnReorderFeature',
2981
+ 'columnResizeFeature',
2982
+ 'excelExporterFeature',
2983
+ 'fileDropFeature',
2984
+ 'fillHandleFeature',
2985
+ 'filterFeature',
2986
+ 'filterBarFeature',
2987
+ 'groupFeature',
2988
+ 'groupSummaryFeature',
2989
+ 'headerMenuFeature',
2990
+ 'headerZoomFeature',
2991
+ 'lockRowsFeature',
2992
+ 'mergeCellsFeature',
2993
+ 'nonWorkingTimeFeature',
2994
+ 'panFeature',
2995
+ 'pdfExportFeature',
2996
+ 'pinColumnsFeature',
2997
+ 'printFeature',
2998
+ 'quickFindFeature',
2999
+ 'regionResizeFeature',
3000
+ 'resourceMenuFeature',
3001
+ 'resourceTimeRangesFeature',
3002
+ 'rowCopyPasteFeature',
3003
+ 'rowEditFeature',
3004
+ 'rowExpanderFeature',
3005
+ 'rowReorderFeature',
3006
+ 'rowResizeFeature',
3007
+ 'scheduleTooltipFeature',
3008
+ 'searchFeature',
3009
+ 'sortFeature',
3010
+ 'splitFeature',
3011
+ 'stickyCellsFeature',
3012
+ 'stripeFeature',
3013
+ 'summaryFeature',
3014
+ 'timeAxisHeaderMenuFeature',
3015
+ 'timeRangesFeature',
3016
+ 'treeFeature',
3017
+ 'treeGroupFeature'
3018
+ ];
3019
+
3020
+ projectStores = false;
3021
+
3022
+ dataStores = {
3023
+ 'originalStore': 'originals'
3024
+ };
3025
+
3026
+ static configNames = [
3027
+ 'adopt',
3028
+ 'aggregateDataEntry',
3029
+ 'aggregateHistogramDataForGroups',
3030
+ 'animateFilterRemovals',
3031
+ 'animateRemovingRows',
3032
+ 'ariaDescription',
3033
+ 'ariaLabel',
3034
+ 'autoAdjustTimeAxis',
3035
+ 'autoHeight',
3036
+ 'barTooltipTemplate',
3037
+ 'bbar',
3038
+ 'bodyCls',
3039
+ 'bubbleEvents',
3040
+ 'bufferCoef',
3041
+ 'bufferThreshold',
3042
+ 'collapsible',
3043
+ 'color',
3044
+ 'config',
3045
+ 'contentElementCls',
3046
+ 'contextMenuTriggerEvent',
3047
+ 'dataField',
3048
+ 'dataModelField',
3049
+ 'defaultRegion',
3050
+ 'destroyStore',
3051
+ 'detectCSSCompatibilityIssues',
3052
+ 'disableGridColumnIdWarning',
3053
+ 'disableGridRowModelWarning',
3054
+ 'dock',
3055
+ 'drawer',
3056
+ 'durationDisplayPrecision',
3057
+ 'elementAttributes',
3058
+ 'enableRecurringEvents',
3059
+ 'enableSticky',
3060
+ 'enableTextSelection',
3061
+ 'fillLastColumn',
3062
+ 'fixedRowHeight',
3063
+ 'footer',
3064
+ 'formulaProviders',
3065
+ 'fullRowRefresh',
3066
+ 'getBarClass',
3067
+ 'getBarDOMConfig',
3068
+ 'getBarText',
3069
+ 'getBarTextDOMConfig',
3070
+ 'getDataEntryForAggregating',
3071
+ 'getOutlineClass',
3072
+ 'getOutlineDOMConfig',
3073
+ 'getRecordData',
3074
+ 'getRowHeight',
3075
+ 'hardRefreshOnTimeAxisReconfigure',
3076
+ 'header',
3077
+ 'hideHorizontalScrollbar',
3078
+ 'histogramWidgetClass',
3079
+ 'hoverCls',
3080
+ 'icon',
3081
+ 'ignoreDomEventsWhileScrolling',
3082
+ 'ignoreParentReadOnly',
3083
+ 'initAggregatedDataEntry',
3084
+ 'listeners',
3085
+ 'loadMask',
3086
+ 'loadMaskDefaults',
3087
+ 'loadMaskError',
3088
+ 'localizable',
3089
+ 'managedEventSizing',
3090
+ 'maskDefaults',
3091
+ 'masked',
3092
+ 'maxDate',
3093
+ 'maxTimeAxisUnit',
3094
+ 'minDate',
3095
+ 'monitorResize',
3096
+ 'owner',
3097
+ 'partner',
3098
+ 'plugins',
3099
+ 'preserveFocusOnDatasetChange',
3100
+ 'preserveScrollOnDatasetChange',
3101
+ 'preventTooltipOnTouch',
3102
+ 'relayStoreEvents',
3103
+ 'resizable',
3104
+ 'resizeToFitIncludesHeader',
3105
+ 'resourceTimeRangeRenderer',
3106
+ 'responsiveLevels',
3107
+ 'ripple',
3108
+ 'rootElement',
3109
+ 'scaleColumn',
3110
+ 'scrollerClass',
3111
+ 'scrollManager',
3112
+ 'series',
3113
+ 'showBarTipWhenNavigatingTimeAxis',
3114
+ 'showDirty',
3115
+ 'snapRelativeToEventStartDate',
3116
+ 'stateful',
3117
+ 'statefulEvents',
3118
+ 'stateId',
3119
+ 'stateProvider',
3120
+ 'stickyHeaders',
3121
+ 'strips',
3122
+ 'subGridConfigs',
3123
+ 'syncMask',
3124
+ 'tab',
3125
+ 'tabBarItems',
3126
+ 'tbar',
3127
+ 'timeAxis',
3128
+ 'type',
3129
+ 'ui',
3130
+ 'visibleZoomFactor',
3131
+ 'weekStartDay',
3132
+ 'weight',
3133
+ 'zoomKeepsOriginalTimespan',
3134
+ 'zoomOnMouseWheel',
3135
+ 'zoomOnTimeAxisDoubleClick'
3136
+ ];
3137
+
3138
+ static propertyConfigNames = [
3139
+ 'alignSelf',
3140
+ 'animateTreeNodeToggle',
3141
+ 'appendTo',
3142
+ 'barMargin',
3143
+ 'callOnFunctions',
3144
+ 'catchEventHandlerExceptions',
3145
+ 'cellEllipsis',
3146
+ 'cls',
3147
+ 'collapsed',
3148
+ 'column',
3149
+ 'columnLines',
3150
+ 'columns',
3151
+ 'data',
3152
+ 'dataset',
3153
+ 'disabled',
3154
+ 'displayDateFormat',
3155
+ 'emptyText',
3156
+ 'enableEventAnimations',
3157
+ 'enableUndoRedoKeys',
3158
+ 'endDate',
3159
+ 'eventColor',
3160
+ 'eventStyle',
3161
+ 'extraData',
3162
+ 'fillTicks',
3163
+ 'flex',
3164
+ 'forceFit',
3165
+ 'height',
3166
+ 'hidden',
3167
+ 'hideFooters',
3168
+ 'hideHeaders',
3169
+ 'hideRowHover',
3170
+ 'histogramWidget',
3171
+ 'id',
3172
+ 'infiniteScroll',
3173
+ 'inputFieldAlign',
3174
+ 'insertBefore',
3175
+ 'insertFirst',
3176
+ 'keyMap',
3177
+ 'labelPosition',
3178
+ 'longPressTime',
3179
+ 'margin',
3180
+ 'maxHeight',
3181
+ 'maxWidth',
3182
+ 'maxZoomLevel',
3183
+ 'minHeight',
3184
+ 'minWidth',
3185
+ 'minZoomLevel',
3186
+ 'onBeforeAssignmentDelete',
3187
+ 'onBeforeCancelCellEdit',
3188
+ 'onBeforeCancelRowEdit',
3189
+ 'onBeforeCellEditStart',
3190
+ 'onBeforeCellRangeDelete',
3191
+ 'onBeforeCellRangeEdit',
3192
+ 'onBeforeColumnDragStart',
3193
+ 'onBeforeColumnDropFinalize',
3194
+ 'onBeforeColumnResize',
3195
+ 'onBeforeCopy',
3196
+ 'onBeforeCSVExport',
3197
+ 'onBeforeDestroy',
3198
+ 'onBeforeEventDelete',
3199
+ 'onBeforeExcelExport',
3200
+ 'onBeforeFillHandleDragStart',
3201
+ 'onBeforeFinishCellEdit',
3202
+ 'onBeforeFinishRowEdit',
3203
+ 'onBeforeHide',
3204
+ 'onBeforeHistogramDataCacheSet',
3205
+ 'onBeforePan',
3206
+ 'onBeforePaste',
3207
+ 'onBeforePdfExport',
3208
+ 'onBeforePresetChange',
3209
+ 'onBeforeRenderHistogramRow',
3210
+ 'onBeforeRenderRecordHistogram',
3211
+ 'onBeforeRenderRow',
3212
+ 'onBeforeRenderRows',
3213
+ 'onBeforeRowCollapse',
3214
+ 'onBeforeRowExpand',
3215
+ 'onBeforeSelectionChange',
3216
+ 'onBeforeSetRecord',
3217
+ 'onBeforeShow',
3218
+ 'onBeforeStartRowEdit',
3219
+ 'onBeforeStateApply',
3220
+ 'onBeforeStateSave',
3221
+ 'onBeforeToggleGroup',
3222
+ 'onBeforeToggleNode',
3223
+ 'onCancelCellEdit',
3224
+ 'onCatchAll',
3225
+ 'onCellClick',
3226
+ 'onCellContextMenu',
3227
+ 'onCellDblClick',
3228
+ 'onCellMenuBeforeShow',
3229
+ 'onCellMenuItem',
3230
+ 'onCellMenuShow',
3231
+ 'onCellMenuToggleItem',
3232
+ 'onCellMouseEnter',
3233
+ 'onCellMouseLeave',
3234
+ 'onCellMouseOut',
3235
+ 'onCellMouseOver',
3236
+ 'onCollapse',
3237
+ 'onCollapseNode',
3238
+ 'onColumnDrag',
3239
+ 'onColumnDragStart',
3240
+ 'onColumnDrop',
3241
+ 'onColumnResize',
3242
+ 'onColumnResizeStart',
3243
+ 'onContextMenuItem',
3244
+ 'onContextMenuToggleItem',
3245
+ 'onCopy',
3246
+ 'onCurrentTimelineUpdate',
3247
+ 'onDataChange',
3248
+ 'onDateRangeChange',
3249
+ 'onDestroy',
3250
+ 'onDirtyStateChange',
3251
+ 'onDragSelecting',
3252
+ 'onElementCreated',
3253
+ 'onExpand',
3254
+ 'onExpandNode',
3255
+ 'onFileDrop',
3256
+ 'onFillHandleBeforeDragFinalize',
3257
+ 'onFillHandleDrag',
3258
+ 'onFillHandleDragAbort',
3259
+ 'onFillHandleDragEnd',
3260
+ 'onFillHandleDragStart',
3261
+ 'onFinishCellEdit',
3262
+ 'onFinishRowEdit',
3263
+ 'onFocusIn',
3264
+ 'onFocusOut',
3265
+ 'onGridRowBeforeDragStart',
3266
+ 'onGridRowBeforeDropFinalize',
3267
+ 'onGridRowDrag',
3268
+ 'onGridRowDragAbort',
3269
+ 'onGridRowDragStart',
3270
+ 'onGridRowDrop',
3271
+ 'onHeaderClick',
3272
+ 'onHeaderMenuBeforeShow',
3273
+ 'onHeaderMenuItem',
3274
+ 'onHeaderMenuShow',
3275
+ 'onHeaderMenuToggleItem',
3276
+ 'onHide',
3277
+ 'onHistogramDataCacheSet',
3278
+ 'onLockRows',
3279
+ 'onMouseOut',
3280
+ 'onMouseOver',
3281
+ 'onNoZoomChange',
3282
+ 'onPaint',
3283
+ 'onPaste',
3284
+ 'onPdfExport',
3285
+ 'onPresetChange',
3286
+ 'onReadOnly',
3287
+ 'onRecompose',
3288
+ 'onRenderRow',
3289
+ 'onRenderRows',
3290
+ 'onResize',
3291
+ 'onResourceMenuBeforeShow',
3292
+ 'onResourceMenuItem',
3293
+ 'onResourceMenuShow',
3294
+ 'onResourceMenuToggleItem',
3295
+ 'onResourceTimeRangeClick',
3296
+ 'onResourceTimeRangeContextMenu',
3297
+ 'onResourceTimeRangeDblClick',
3298
+ 'onResourceTimeRangeMouseDown',
3299
+ 'onResourceTimeRangeMouseOut',
3300
+ 'onResourceTimeRangeMouseOver',
3301
+ 'onResourceTimeRangeMouseUp',
3302
+ 'onResponsive',
3303
+ 'onRowCollapse',
3304
+ 'onRowExpand',
3305
+ 'onRowMouseEnter',
3306
+ 'onRowMouseLeave',
3307
+ 'onScroll',
3308
+ 'onSelectionChange',
3309
+ 'onSelectionModeChange',
3310
+ 'onShow',
3311
+ 'onSplit',
3312
+ 'onSplitterCollapseClick',
3313
+ 'onSplitterDragEnd',
3314
+ 'onSplitterDragStart',
3315
+ 'onSplitterExpandClick',
3316
+ 'onStartCellEdit',
3317
+ 'onStartRowEdit',
3318
+ 'onSubGridCollapse',
3319
+ 'onSubGridExpand',
3320
+ 'onTickSizeChange',
3321
+ 'onTimeAxisChange',
3322
+ 'onTimeAxisHeaderClick',
3323
+ 'onTimeAxisHeaderContextMenu',
3324
+ 'onTimeAxisHeaderDblClick',
3325
+ 'onTimeAxisHeaderMenuBeforeShow',
3326
+ 'onTimeAxisHeaderMenuItem',
3327
+ 'onTimeAxisHeaderMenuShow',
3328
+ 'onTimelineContextChange',
3329
+ 'onTimelineViewportResize',
3330
+ 'onTimeRangeHeaderClick',
3331
+ 'onTimeRangeHeaderContextMenu',
3332
+ 'onTimeRangeHeaderDblClick',
3333
+ 'onToggleGroup',
3334
+ 'onToggleNode',
3335
+ 'onToolClick',
3336
+ 'onUnlockRows',
3337
+ 'onUnsplit',
3338
+ 'onVisibleDateRangeChange',
3339
+ 'preserveScroll',
3340
+ 'presets',
3341
+ 'readOnly',
3342
+ 'recurrenceConfirmationPopup',
3343
+ 'rendition',
3344
+ 'rowHeight',
3345
+ 'rowLines',
3346
+ 'rtl',
3347
+ 'scalePoints',
3348
+ 'scrollable',
3349
+ 'selectionMode',
3350
+ 'showBarTip',
3351
+ 'snap',
3352
+ 'span',
3353
+ 'startDate',
3354
+ 'stateSettings',
3355
+ 'store',
3356
+ 'suppressFit',
3357
+ 'tickSize',
3358
+ 'timeResolution',
3359
+ 'timeZone',
3360
+ 'title',
3361
+ 'tools',
3362
+ 'transition',
3363
+ 'transitionDuration',
3364
+ 'viewPreset',
3365
+ 'visibleDate',
3366
+ 'width',
3367
+ 'workingTime'
3368
+ ];
3369
+
3370
+ static propertyNames = [
3371
+ 'focusVisible',
3372
+ 'hasChanges',
3373
+ 'originalStore',
3374
+ 'parent',
3375
+ 'scrollLeft',
3376
+ 'scrollTop',
3377
+ 'scrollX',
3378
+ 'selectedCell',
3379
+ 'selectedCells',
3380
+ 'selectedRecord',
3381
+ 'selectedRecords',
3382
+ 'selectedRows',
3383
+ 'state',
3384
+ 'tooltip',
3385
+ 'zoomLevel'
3386
+ ];
3387
+
3388
+ // Component instance
3389
+ instance!: TimelineHistogram;
3390
+
3391
+ // Component element
3392
+ element! : HTMLElement;
3393
+
3394
+ componentDidMount(): void {
3395
+ this.instance = createWidget(this);
3396
+ }
3397
+
3398
+ componentWillUnmount(): void {
3399
+ // @ts-ignore
3400
+ this.instance?.destroy?.();
3401
+ }
3402
+
3403
+ /**
3404
+ * Component about to be updated, from changing a prop using state.
3405
+ * React to it depending on what changed and prevent react from re-rendering our component.
3406
+ * @param nextProps
3407
+ * @param nextState
3408
+ * @returns {boolean}
3409
+ */
3410
+ shouldComponentUpdate(nextProps: Readonly<BryntumTimelineHistogramProps>, nextState: Readonly<{}>): boolean {
3411
+ return shouldComponentUpdate(this, nextProps, nextState);
3412
+ }
3413
+
3414
+ render(): React.ReactNode {
3415
+
3416
+ const className = `b-react-timeline-histogram-container`;
3417
+ return (
3418
+ <React.Fragment>
3419
+ <div className={className} ref={(element) => (this.element = element!)}>
3420
+ {Array.from(this.state.portals).map((item) => item[1])}
3421
+ </div>
3422
+ <div ref={el => (this.portalsCache = el!)} className="b-react-portals-cache" style={{ display : 'none' }}></div>
3423
+ </React.Fragment>
3424
+ );
3425
+
3426
+ }
3427
+ }