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