@bryntum/calendar-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 (46) hide show
  1. package/README.md +44 -0
  2. package/bryntum-calendar-angular-thin.d.ts +5 -0
  3. package/bundles/bryntum-calendar-angular-thin.umd.js +22195 -0
  4. package/bundles/bryntum-calendar-angular-thin.umd.js.map +1 -0
  5. package/esm2015/bryntum-calendar-angular-thin.js +5 -0
  6. package/esm2015/lib/bryntum-agenda-view.component.js +2503 -0
  7. package/esm2015/lib/bryntum-calendar-date-picker.component.js +1045 -0
  8. package/esm2015/lib/bryntum-calendar-project-model.component.js +369 -0
  9. package/esm2015/lib/bryntum-calendar.component.js +2355 -0
  10. package/esm2015/lib/bryntum-day-agenda-view.component.js +1338 -0
  11. package/esm2015/lib/bryntum-day-resource-view.component.js +1347 -0
  12. package/esm2015/lib/bryntum-day-view.component.js +1323 -0
  13. package/esm2015/lib/bryntum-event-list.component.js +2453 -0
  14. package/esm2015/lib/bryntum-mode-selector.component.js +702 -0
  15. package/esm2015/lib/bryntum-month-agenda-view.component.js +1201 -0
  16. package/esm2015/lib/bryntum-month-grid.component.js +1262 -0
  17. package/esm2015/lib/bryntum-month-view.component.js +1337 -0
  18. package/esm2015/lib/bryntum-range-menu.component.js +884 -0
  19. package/esm2015/lib/bryntum-resource-view.component.js +1068 -0
  20. package/esm2015/lib/bryntum-week-view.component.js +1323 -0
  21. package/esm2015/lib/bryntum-year-view.component.js +1163 -0
  22. package/esm2015/lib/calendar.module.js +99 -0
  23. package/esm2015/lib/wrapper.helper.js +74 -0
  24. package/esm2015/public-api.js +21 -0
  25. package/fesm2015/bryntum-calendar-angular-thin.js +21714 -0
  26. package/fesm2015/bryntum-calendar-angular-thin.js.map +1 -0
  27. package/lib/bryntum-agenda-view.component.d.ts +2953 -0
  28. package/lib/bryntum-calendar-date-picker.component.d.ts +1525 -0
  29. package/lib/bryntum-calendar-project-model.component.d.ts +399 -0
  30. package/lib/bryntum-calendar.component.d.ts +2577 -0
  31. package/lib/bryntum-day-agenda-view.component.d.ts +1960 -0
  32. package/lib/bryntum-day-resource-view.component.d.ts +2025 -0
  33. package/lib/bryntum-day-view.component.d.ts +1980 -0
  34. package/lib/bryntum-event-list.component.d.ts +2888 -0
  35. package/lib/bryntum-mode-selector.component.d.ts +851 -0
  36. package/lib/bryntum-month-agenda-view.component.d.ts +1765 -0
  37. package/lib/bryntum-month-grid.component.d.ts +1731 -0
  38. package/lib/bryntum-month-view.component.d.ts +1897 -0
  39. package/lib/bryntum-range-menu.component.d.ts +1130 -0
  40. package/lib/bryntum-resource-view.component.d.ts +1512 -0
  41. package/lib/bryntum-week-view.component.d.ts +1980 -0
  42. package/lib/bryntum-year-view.component.d.ts +1661 -0
  43. package/lib/calendar.module.d.ts +22 -0
  44. package/lib/wrapper.helper.d.ts +26 -0
  45. package/package.json +33 -0
  46. package/public-api.d.ts +17 -0
@@ -0,0 +1,2953 @@
1
+ /**
2
+ * Angular wrapper for Bryntum AgendaView
3
+ */
4
+ import { ElementRef, SimpleChanges, OnDestroy, OnInit } from '@angular/core';
5
+ import { AjaxStore, AjaxStoreConfig, BryntumScrollOptions, Button, ButtonConfig, DomConfig, DurationConfig, FormulaProviderConfig, KeyMapConfig, Mask, MaskConfig, MenuItemConfig, Model, ModelConfig, PagingToolbarConfig, PanelCollapserConfig, PanelCollapserOverlayConfig, PanelHeader, ScrollManager, ScrollManagerConfig, Scroller, ScrollerConfig, StateProvider, Store, StoreConfig, TabConfig, Tool, ToolConfig, ToolbarConfig, ToolbarItems, 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, GridStateInfo, Group, GroupConfig, GroupSummary as GridGroupSummary, GroupSummaryConfig as GridGroupSummaryConfig, 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, RowReorder as GridRowReorder, RowReorderConfig as GridRowReorderConfig, RowResize as GridRowResize, RowResizeConfig as GridRowResizeConfig, Search, SearchConfig, Sort, SortConfig, Split as GridSplit, SplitConfig as GridSplitConfig, StickyCells, StickyCellsConfig, Stripe, StripeConfig, SubGridConfig, Summary as GridSummary, SummaryConfig as GridSummaryConfig, Tree, TreeConfig, TreeGroup, TreeGroupConfig } from '@bryntum/grid-thin';
7
+ import { EventModel, ResourceModel } from '@bryntum/scheduler-thin';
8
+ import { AgendaView, AgendaViewListeners, CalendarView, CalendarContainerItemConfig, DayCell, EventBar, CalendarColumnConfig, RangeMenuConfig } from '@bryntum/calendar-thin';
9
+ import * as i0 from "@angular/core";
10
+ export declare type BryntumAgendaViewProps = {
11
+ /**
12
+ * A key to use to activate this view.
13
+ * ...
14
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-activationKey)
15
+ */
16
+ activationKey?: string;
17
+ /**
18
+ * Element (or element id) to adopt as this Widget's encapsulating element. The widget's
19
+ * content will be placed inside this element.
20
+ * ...
21
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-adopt)
22
+ */
23
+ adopt?: HTMLElement | string;
24
+ /**
25
+ * When this widget is a child of a [Container](https://bryntum.com/products/calendar/docs/api/Core/widget/Container), it will by default be participating in a
26
+ * flexbox layout. This config allows you to set this widget's
27
+ * [align-self](https://developer.mozilla.org/en-US/docs/Web/CSS/align-self) style.
28
+ */
29
+ alignSelf?: string;
30
+ /**
31
+ * Configure this as `false` to disable drag-creating events in this view.
32
+ */
33
+ allowDragCreate?: boolean;
34
+ /**
35
+ * Configure this as `false` to disable drag-moving events in this view.
36
+ */
37
+ allowDragMove?: boolean;
38
+ /**
39
+ * Configure this as `false` to disable drag-resizing events in this view.
40
+ */
41
+ allowDragResize?: boolean;
42
+ /**
43
+ * If no dates in the view's configured date range contain events, then by default, no date cells are rendered.
44
+ * ...
45
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-alwaysShowCurrentDate)
46
+ */
47
+ alwaysShowCurrentDate?: boolean;
48
+ /**
49
+ * Set to `true` to animate row removals caused by filtering.
50
+ * @deprecated 7.0.0 Deprecated `animateFilterRemovals`. Use `transition.filterRemoval` instead
51
+ */
52
+ animateFilterRemovals?: boolean;
53
+ /**
54
+ * Controls if removing and inserting rows should be animated. Set to `false` to prevent those animations,
55
+ * removing the related delays.
56
+ * @deprecated 7.0.0 Deprecated `animateRemovingRows`. Use `transition.removeRecord` instead
57
+ */
58
+ animateRemovingRows?: boolean;
59
+ /**
60
+ * By default, when navigating through time, the next time
61
+ * block will be animated in from the appropriate direction.
62
+ * ...
63
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-animateTimeShift)
64
+ */
65
+ animateTimeShift?: boolean;
66
+ /**
67
+ * When the [Tree](https://bryntum.com/products/calendar/docs/api/Grid/feature/Tree) feature is in use and the Store is a tree store, this
68
+ * config may be set to `true` to visually animate branch node expand and collapse operations.
69
+ * *This is not supported in Scheduler and Gantt*
70
+ * @deprecated 7.0.0 Deprecated `animateTreeNodeToggle`. Use `transition.toggleTreeNode` instead
71
+ */
72
+ animateTreeNodeToggle?: boolean;
73
+ /**
74
+ * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
75
+ * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#property-element).
76
+ */
77
+ appendTo?: HTMLElement | string;
78
+ /**
79
+ * A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject
80
+ * into an element which will be linked using the `aria-describedby` attribute.
81
+ * ...
82
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-ariaDescription)
83
+ */
84
+ ariaDescription?: string;
85
+ /**
86
+ * A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject as
87
+ * the `aria-label` attribute.
88
+ * ...
89
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-ariaLabel)
90
+ */
91
+ ariaLabel?: string;
92
+ /**
93
+ * If this config is set, then the `gesture` configured (which defaults to `dblclick`) creates a
94
+ * new event at the mouse or touch event's time point.
95
+ * ...
96
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-autoCreate)
97
+ */
98
+ autoCreate?: {
99
+ gesture?: string;
100
+ newName?: Function | string;
101
+ step?: string;
102
+ snapType?: 'round' | 'ceil' | 'floor';
103
+ duration?: string;
104
+ startHour?: number;
105
+ } | string | boolean;
106
+ /**
107
+ * Automatically set grids height to fit all rows (no scrolling in the grid). In general you should avoid
108
+ * using `autoHeight: true`, since it will bypass Grids virtual rendering and render all rows at once, which
109
+ * in a larger grid is really bad for performance.
110
+ */
111
+ autoHeight?: boolean;
112
+ /**
113
+ * A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/calendar/docs/api/Core/widget/Toolbar),
114
+ * 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/calendar/docs/api/Core/widget/Panel#config-strips).
115
+ * ...
116
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-bbar)
117
+ */
118
+ bbar?: (CalendarContainerItemConfig | string)[] | ToolbarConfig | PagingToolbarConfig | null;
119
+ /**
120
+ * Custom CSS classes to add to the panel's body element.
121
+ * ...
122
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-bodyCls)
123
+ */
124
+ bodyCls?: string | object;
125
+ /**
126
+ * An object where property names with a truthy value indicate which events should bubble up the ownership
127
+ * hierarchy when triggered.
128
+ * ...
129
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-bubbleEvents)
130
+ */
131
+ bubbleEvents?: object;
132
+ /**
133
+ * Set to `false` to not call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
134
+ * ...
135
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-callOnFunctions)
136
+ */
137
+ callOnFunctions?: boolean;
138
+ /**
139
+ * By default, if an event handler throws an exception, the error propagates up the stack and the
140
+ * application state is undefined. Code which follows the event handler will *not* be executed.
141
+ * ...
142
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-catchEventHandlerExceptions)
143
+ */
144
+ catchEventHandlerExceptions?: boolean;
145
+ /**
146
+ * Set to `false` to crop text in grid cells without ellipsis (...). When enabled, cells containing pure
147
+ * use `display : block`, instead of `display : flex` to allow ellipsis to work.
148
+ * <strong>NOTE</strong> Only supported in browsers that support `:has()` CSS selector
149
+ */
150
+ cellEllipsis?: boolean;
151
+ /**
152
+ * Custom CSS classes to add to element.
153
+ * May be specified as a space separated string, or as an object in which property names
154
+ * with truthy values are used as the class names:
155
+ * ...
156
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-cls)
157
+ */
158
+ cls?: string | object;
159
+ /**
160
+ * Controls whether the panel is collapsed (the body of the panel is hidden while only the header is
161
+ * visible). Only valid if the panel is [collapsible](https://bryntum.com/products/calendar/docs/api/Core/widget/Panel#config-collapsible).
162
+ */
163
+ collapsed?: boolean;
164
+ /**
165
+ * This config enables collapsibility for the panel. See [collapsed](https://bryntum.com/products/calendar/docs/api/Core/widget/Panel#config-collapsed).
166
+ * ...
167
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-collapsible)
168
+ */
169
+ collapsible?: boolean | PanelCollapserConfig | PanelCollapserOverlayConfig;
170
+ /**
171
+ * Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
172
+ * `style` block.
173
+ * ...
174
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-color)
175
+ */
176
+ color?: string;
177
+ /**
178
+ * Programmatic control over which column to start in when used in a grid layout.
179
+ */
180
+ column?: number;
181
+ /**
182
+ * Set to `false` to not show column lines. End result might be overruled by/differ between themes.
183
+ */
184
+ columnLines?: boolean;
185
+ /**
186
+ * Column definitions.
187
+ * ...
188
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-columns)
189
+ */
190
+ columns?: object | object[];
191
+ config?: object;
192
+ /**
193
+ * Custom CSS classes to add to the [contentElement](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#property-contentElement).
194
+ * May be specified as a space separated string, or as an object in which property names
195
+ * with truthy values are used as the class names:
196
+ * ...
197
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-contentElementCls)
198
+ */
199
+ contentElementCls?: string | object;
200
+ /**
201
+ * Event which is used to show context menus.
202
+ * Available options are: 'contextmenu', 'click', 'dblclick'.
203
+ */
204
+ contextMenuTriggerEvent?: 'contextmenu' | 'click' | 'dblclick';
205
+ /**
206
+ * Convenient shortcut to set data in grids store both during initialization and at runtime. Can also be
207
+ * used to retrieve data at runtime, although we do recommend interacting with Grids store instead using
208
+ * the [store](https://bryntum.com/products/calendar/docs/api/Grid/view/GridBase#property-store) property.
209
+ * ...
210
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-data)
211
+ */
212
+ data?: object[] | Model[] | ModelConfig[];
213
+ /**
214
+ * When this Widget configuration is used in the Grid's RowExpander feature's `widget` config, provide the
215
+ * field on the expanded record to use for populating this widget's store (if applicable)
216
+ */
217
+ dataField?: string;
218
+ /**
219
+ * Object to apply to elements dataset (each key will be used as a data-attribute on the element)
220
+ */
221
+ dataset?: Record<string, string>;
222
+ /**
223
+ * The date to orient this view's [range](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/DateRangeOwner#config-range) around.
224
+ * ...
225
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-date)
226
+ */
227
+ date?: Date;
228
+ /**
229
+ * A callback function, or the name of a function in the ownership hierarchy which an
230
+ * application may provide to filter out agenda rows for individual dates.
231
+ * @param {DayCell} context Information about the day rows to be created.
232
+ * @returns {boolean} Return `false` to not display a rows for the passed date.
233
+ */
234
+ dateFilter?: ((context: DayCell) => boolean) | string;
235
+ /**
236
+ * A [DateHelper](https://bryntum.com/products/calendar/docs/api/Core/helper/DateHelper) format string/function to use to create date output for view descriptions.
237
+ * @param {Date} date The date to format.
238
+ * @returns {string} The formatted date.
239
+ */
240
+ dateFormat?: string | ((date: Date) => string);
241
+ /**
242
+ * A string used to separate start and end dates in the [descriptionFormat](https://bryntum.com/products/calendar/docs/api/Scheduler/view/mixin/Describable#config-descriptionFormat).
243
+ */
244
+ dateSeparator?: string;
245
+ /**
246
+ * Region to which columns are added when they have none specified
247
+ */
248
+ defaultRegion?: string;
249
+ /**
250
+ * Options to add into scroll options when the [scrollTo](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/CalendarMixin#function-scrollTo) method is called.
251
+ * ...
252
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-defaultScrollOptions)
253
+ */
254
+ defaultScrollOptions?: BryntumScrollOptions;
255
+ /**
256
+ * The date format used by the default [descriptionRenderer](https://bryntum.com/products/calendar/docs/api/Scheduler/view/mixin/Describable#config-descriptionRenderer) for rendering the view's description.
257
+ * If this value is `null`, the [dateFormat](https://bryntum.com/products/calendar/docs/api/Scheduler/view/mixin/Describable#config-dateFormat) (and potentially [dateSeparator](#Scheduler/view/mixin/Describable#config-dateSeparator)) will
258
+ * be used.
259
+ * ...
260
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-descriptionFormat)
261
+ * @param {Date} date The date to format.
262
+ * @returns {string} The formatted date.
263
+ */
264
+ descriptionFormat?: string | string[] | boolean[] | ((date: Date) => string) | Function[];
265
+ /**
266
+ * A function that provides the textual description for this view. If provided, this function overrides the
267
+ * [descriptionFormat](https://bryntum.com/products/calendar/docs/api/Scheduler/view/mixin/Describable#config-descriptionFormat).
268
+ * ...
269
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-descriptionRenderer)
270
+ * @param {Core.widget.Widget} view The active view in case the function is in another scope.
271
+ * @returns {string} Description string
272
+ */
273
+ descriptionRenderer?: (view: Widget) => string;
274
+ /**
275
+ * Set to `true` to destroy the store when the grid is destroyed.
276
+ */
277
+ destroyStore?: boolean;
278
+ /**
279
+ * Check for CSS compatibility issues when upgrading to v7. Performs the following checks:
280
+ * ...
281
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-detectCSSCompatibilityIssues)
282
+ */
283
+ detectCSSCompatibilityIssues?: boolean;
284
+ /**
285
+ * Disable or enable the widget. It is similar to [readOnly](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-readOnly) except a disabled widget
286
+ * cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
287
+ * ...
288
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-disabled)
289
+ */
290
+ disabled?: boolean | 'inert';
291
+ /**
292
+ * Set to `true` to not get a warning when calling [getState](https://bryntum.com/products/calendar/docs/api/Grid/view/GridBase#function-getState) when there is a column
293
+ * configured without an `id`. But the recommended action is to always configure columns with an `id` when
294
+ * using states.
295
+ */
296
+ disableGridColumnIdWarning?: boolean;
297
+ /**
298
+ * Set to `true` to not get a warning when using another base class than GridRowModel for your grid data. If
299
+ * you do, and would like to use the full feature set of the grid then include the fields from GridRowModel
300
+ * in your model definition.
301
+ */
302
+ disableGridRowModelWarning?: boolean;
303
+ /**
304
+ * Controls the placement of this widget when it is added to a [panel's ](https://bryntum.com/products/calendar/docs/api/Core/widget/Panel)
305
+ * [strips collection](https://bryntum.com/products/calendar/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
306
+ * `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
307
+ * body. Such widgets are called "edge strips".
308
+ * ...
309
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-dock)
310
+ */
311
+ dock?: 'top' | 'bottom' | 'left' | 'right' | 'start' | 'end' | 'header' | 'pre-header' | object;
312
+ /**
313
+ * The [durationUnit](https://bryntum.com/products/calendar/docs/api/Scheduler/model/EventModel#field-durationUnit) to use when drag-creating events
314
+ * in this view.
315
+ * ...
316
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-dragUnit)
317
+ */
318
+ dragUnit?: string;
319
+ /**
320
+ * Make this Panel a docked drawer which slides out from one side of the browser viewport by default.
321
+ * ...
322
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-drawer)
323
+ * @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.
324
+ * @param {string,number} size The size of the drawer in its collapsible axis.
325
+ * @param {boolean} inline If using the [appendTo](https://bryntum.com/products/calendar/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.
326
+ * @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.
327
+ * @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.
328
+ * @param {boolean,string} autoClose.focusout If focus moves outside of the drawer, the drawer will automatically be hidden.
329
+ * @param {string} autoClose.mouseout Hides the drawer when the mouse leaves the drawer after the `autoCloseDelay` period.
330
+ * @param {number} autoCloseDelay When using `mouseout`, this is the delay in milliseconds
331
+ */
332
+ drawer?: boolean | {
333
+ side?: 'start' | 'left' | 'end' | 'right' | 'top' | 'bottom';
334
+ size?: string | number;
335
+ inline?: boolean;
336
+ autoClose: {
337
+ mousedown?: boolean | string;
338
+ focusout?: boolean | string;
339
+ mouseout?: string;
340
+ };
341
+ autoCloseDelay?: number;
342
+ };
343
+ /**
344
+ * An object specifying attributes to assign to the root element of this widget.
345
+ * Set `null` value to attribute to remove it.
346
+ * ...
347
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-elementAttributes)
348
+ */
349
+ elementAttributes?: Record<string, string | null>;
350
+ /**
351
+ * Text or HTML, or a [EmptyTextDomConfig](https://bryntum.com/products/calendar/docs/api/Grid/view/GridBase#typedef-EmptyTextDomConfig) block to display when there is no data to display in the grid.
352
+ * When using multiple Grid regions, provide the `region` property to decide where the text is shown.
353
+ * By default, it is shown in the first region.
354
+ * ...
355
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-emptyText)
356
+ */
357
+ emptyText?: string | EmptyTextDomConfig;
358
+ /**
359
+ * Configure this as `true` to allow elements within cells to be styled as `position: sticky`.
360
+ * ...
361
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-enableSticky)
362
+ */
363
+ enableSticky?: boolean;
364
+ /**
365
+ * Set to `true` to allow text selection in the grid cells. Note, this cannot be used simultaneously with the
366
+ * `RowReorder` feature.
367
+ */
368
+ enableTextSelection?: boolean;
369
+ /**
370
+ * Set to `true` to listen for CTRL-Z (CMD-Z on Mac OS) keyboard event and trigger undo (redo when SHIFT is
371
+ * pressed). Only applicable when using a [StateTrackingManager](https://bryntum.com/products/calendar/docs/api/Core/data/stm/StateTrackingManager).
372
+ */
373
+ enableUndoRedoKeys?: boolean;
374
+ /**
375
+ * The end date (Time component is zeroed) of this view. Note that in terms of full days,
376
+ * this is exclusive, ie: 2020-01-012 to 2020-01-08 is *seven* days. The end is 00:00:00 on
377
+ * the 8th.
378
+ * ...
379
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-endDate)
380
+ */
381
+ endDate?: Date;
382
+ /**
383
+ * A function, or the name of a function in the ownership hierarchy to filter which events
384
+ * are collected into the day cell data blocks.
385
+ * Return `true` to include the passed event, or a *falsy* value to exclude the event.
386
+ * @param {Scheduler.model.EventModel} event the passed event
387
+ * @returns {boolean}
388
+ */
389
+ eventFilter?: ((event: EventModel) => boolean) | string;
390
+ /**
391
+ * A function, or the name of a function in the ownership hierarchy which you
392
+ * can specify to customize event DOM content.
393
+ * ...
394
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-eventHeaderRenderer)
395
+ * @param {object} detail An object that contains data about the event being rendered
396
+ * @param {CalendarView} detail.view The view rendering the event
397
+ * @param {Scheduler.model.EventModel} detail.eventRecord The event record
398
+ * @param {Scheduler.model.ResourceModel} detail.resourceRecord The resource record
399
+ * @param {object} detail.renderData A data object containing properties that will be used to create the event element
400
+ * @param {object} detail.renderData.style The style property is an object containing style properties for the event element
401
+ * @param {object} detail.renderData.cls The cls property is an object whose property names will be added to the event element if the property value is truthy
402
+ * @param {object} detail.renderData.iconStyle The iconStyle property is an object containing style properties for the icon element if an icon element is to be used
403
+ * @param {object} detail.renderData.iconCls The iconCls property is an object whose property names will be added to the icon element. Initially set from the event record's [iconCls](https://bryntum.com/products/calendar/docs/api/Scheduler/model/EventModel#field-iconCls). Can be mutated by the renderer. If null, or no properties are set, no icon will be rendered
404
+ * @param {string} detail.renderData.eventColor Color to be applied to the event
405
+ * @param {object} detail.renderData.dataset An object which produces the `dataset` of the resulting event bar
406
+ * @param {boolean} detail.renderData.solidBar This is valid for views which create event bars. This is set to `true` by default for all day and interday events so that these appear as a solid block of background color. An eventRenderer may mutate this flag to change in what manner the event bar is colored - as a solid bar of color, or using the foreground color (text and icons) such as the MonthView, the CalendarRow (all day events in a DayView), and OverflowPopups
407
+ * @param {string} detail.renderData.bodyColor When used in a [DayView](https://bryntum.com/products/calendar/docs/api/Calendar/widget/DayView), this color is applied to the body of the event element. Note that this must be light enough that the text color (From the SASS variable `$dayview-event-color`) is visible
408
+ * @param {boolean} detail.showBullet If there is no `iconCls`, and the event is not recurring, then by default a "bullet" circular icon is shown if the view's [showBullet](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/CalendarMixin#config-showBullet) if set. Setting this property in an event renderer overrides this behaviour.
409
+ * @returns {DomConfig,DomConfig[],string,void}
410
+ */
411
+ eventHeaderRenderer?: ((detail: {
412
+ view: CalendarView;
413
+ eventRecord: EventModel;
414
+ resourceRecord: ResourceModel;
415
+ renderData: {
416
+ style: object;
417
+ cls: object;
418
+ iconStyle: object;
419
+ iconCls: object;
420
+ eventColor: string;
421
+ dataset: object;
422
+ solidBar: boolean;
423
+ bodyColor: string;
424
+ };
425
+ showBullet: boolean;
426
+ }) => DomConfig | DomConfig[] | string | void) | string;
427
+ /**
428
+ * The height of event bars if this view creates event bars.
429
+ * ...
430
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-eventHeight)
431
+ */
432
+ eventHeight?: number | string;
433
+ /**
434
+ * A [DateHelper](https://bryntum.com/products/calendar/docs/api/Core/helper/DateHelper) format string/function used to format the time displayed
435
+ * next to event bars in the custom columns which [EventList](https://bryntum.com/products/calendar/docs/api/Calendar/widget/EventList)
436
+ * based views use - [EventList](https://bryntum.com/products/calendar/docs/api/Calendar/widget/EventList) and [AgendaView](#Calendar/widget/AgendaView).
437
+ * @param {Date} date The date to format.
438
+ * @returns {string} The formatted date.
439
+ */
440
+ eventListTimeFormat?: string | ((date: Date) => string);
441
+ /**
442
+ * A function, or the name of a function in the ownership hierarchy which you
443
+ * can specify to customize event DOM content.
444
+ * ...
445
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-eventRenderer)
446
+ * @param {object} detail An object that contains data about the event being rendered
447
+ * @param {CalendarView} detail.view The view rendering the event
448
+ * @param {Scheduler.model.EventModel} detail.eventRecord The event record
449
+ * @param {Scheduler.model.ResourceModel} detail.resourceRecord The Resource record
450
+ * @param {object} detail.renderData A data object containing properties that will be used to create the event element
451
+ * @param {object} detail.renderData.style The style property is an object containing style properties for the event element
452
+ * @param {object} detail.renderData.cls The cls property is an object whose property names will be added to the event element if the property value is truthy
453
+ * @param {object} detail.renderData.iconStyle The iconStyle property is an object containing style properties for the icon element if an icon element is to be used
454
+ * @param {object} detail.renderData.iconCls The iconCls property is an object whose property names will be added to the icon element. Initially set from the event record's [iconCls](https://bryntum.com/products/calendar/docs/api/Scheduler/model/EventModel#field-iconCls). Can be mutated by the renderer. If null, or no properties are set, no icon will be rendered
455
+ * @param {string} detail.renderData.eventColor Color to be applied to the event. This may be a CSS color name or a CSS color value in any of the supported CSS color formats such as `#RRGGBB`, `rgb(255, 0, 0)`, or `rgba(255, 0, 0, 0.5)`.
456
+ * @param {string} detail.renderData.eventBackground A CSS background style to be applied to the event. This is not set by default, but can be set by the renderer to provide a background image or gradient for the event bar. This overrides the `eventColor` property if present.
457
+ * @param {string} detail.renderData.textColor A CSS color to be applied to the event text. This is not set by default, but can be set by the renderer to provide a custom color for the event name text in the event bar. This may be a CSS color name or a CSS color value in any of the supported CSS color formats such as `#RRGGBB`, `rgb(255, 0, 0)`, or `rgba(255, 0, 0, 0.5)`.
458
+ * @param {object} detail.renderData.eventInnerStyle The eventInnerStyle property is an object containing style properties for the inner part of the event element, the `.b-cal-event` element.
459
+ * @param {object} detail.renderData.dataset An object which produces the `dataset` of the resulting event bar
460
+ * @param {boolean} detail.renderData.solidBar This is valid for views which create event bars. This is set to `true` by default for all day and interday events so that these appear as a solid block of background color. An eventRenderer may mutate this flag to change in what manner the event bar is colored - as a solid bar of color, or using the foreground color (text and icons) such as the MonthView, the CalendarRow (all day events in a DayView), and OverflowPopups
461
+ * @param {string} detail.renderData.bodyColor When used in a [DayView](https://bryntum.com/products/calendar/docs/api/Calendar/widget/DayView), this color is applied to the body of the event element. Note that this must be light enough that the text color (From the SASS variable `$dayview-event-color`) is visible
462
+ * @param {boolean} detail.renderData.showBullet If there is no `iconCls`, and the event is not recurring, then by default a "bullet" circular icon is shown if the view's [showBullet](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/CalendarMixin#config-showBullet) if set. Setting this property in an event renderer overrides this behaviour.
463
+ * @returns {DomConfig,DomConfig[],string,void} The content to be used as the event body.
464
+ */
465
+ eventRenderer?: ((detail: {
466
+ view: CalendarView;
467
+ eventRecord: EventModel;
468
+ resourceRecord: ResourceModel;
469
+ renderData: {
470
+ style: object;
471
+ cls: object;
472
+ iconStyle: object;
473
+ iconCls: object;
474
+ eventColor: string;
475
+ eventBackground: string;
476
+ textColor: string;
477
+ eventInnerStyle: object;
478
+ dataset: object;
479
+ solidBar: boolean;
480
+ bodyColor: string;
481
+ showBullet: boolean;
482
+ };
483
+ }) => DomConfig | DomConfig[] | string | void) | string;
484
+ /**
485
+ * The spacing between event bars in the default rendering of a day cell.
486
+ */
487
+ eventRowSpacing?: number | string;
488
+ /**
489
+ * A function which compares events which some views use to decide upon rendering order.
490
+ * ...
491
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-eventSorter)
492
+ * @param {Scheduler.model.EventModel,EventBar} lhs The left side value to conpare
493
+ * @param {Scheduler.model.EventModel,EventBar} rhs The right side value to conpare
494
+ * @returns {number}
495
+ */
496
+ eventSorter?: (lhs: EventModel | EventBar, rhs: EventModel | EventBar) => number;
497
+ /**
498
+ * A function, or name of a function in the ownership hierarchy which is used to create
499
+ * the time output next to event bars in an agenda cell.
500
+ * ...
501
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-eventTimeRenderer)
502
+ * @param {Scheduler.model.EventModel} eventRecord The event record for which to create a time string.
503
+ * @param {Date} date The date of the cell in which the event is being rendered.
504
+ * @returns {string,DomConfig,DomConfig[]}
505
+ */
506
+ eventTimeRenderer?: ((eventRecord: EventModel, date: Date) => string | DomConfig | DomConfig[]) | string;
507
+ /**
508
+ * By default, the end date of an all day event is displayed in the UI as
509
+ * the last calendar date on which the event falls. For most end users, this is the
510
+ * expected value.
511
+ * ...
512
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-extendAllDayEndDay)
513
+ */
514
+ extendAllDayEndDay?: boolean;
515
+ extraData?: any;
516
+ /**
517
+ * Set to `true` to stretch the last column in a grid with all fixed width columns
518
+ * to fill extra available space if the grid's width is wider than the sum of all
519
+ * configured column widths.
520
+ */
521
+ fillLastColumn?: boolean;
522
+ /**
523
+ * If this is set to `true`, then when determining which assigned resource of a multi assigned event
524
+ * to use to create the event UI, the first resource which is still selected in the
525
+ * [resourceFilter](https://bryntum.com/products/calendar/docs/api/Calendar/widget/Sidebar#property-resourceFilter) is used.
526
+ * ...
527
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-filterEventResources)
528
+ */
529
+ filterEventResources?: boolean;
530
+ /**
531
+ * When using the [Calendar's date picker](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-datePicker) with the
532
+ * [multiSelect](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-multiSelect) property `true`, the selected range is usually
533
+ * applied to views of this type.
534
+ * ...
535
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-fixedDuration)
536
+ */
537
+ fixedDuration?: boolean;
538
+ /**
539
+ * Use fixed row height. Setting this to `true` will configure the underlying RowManager to use fixed row
540
+ * height, which sacrifices the ability to use rows with variable height to gain a fraction better
541
+ * performance.
542
+ * ...
543
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-fixedRowHeight)
544
+ */
545
+ fixedRowHeight?: boolean;
546
+ /**
547
+ * When this widget is a child of a [Container](https://bryntum.com/products/calendar/docs/api/Core/widget/Container), it will by default be participating in a
548
+ * flexbox layout. This config allows you to set this widget's
549
+ * [flex](https://developer.mozilla.org/en-US/docs/Web/CSS/flex) style.
550
+ * This may be configured as a single number or a `&lt;flex-grow&gt; &lt;flex-shrink&gt; &lt;flex-basis&gt;` format string.
551
+ * numeric-only values are interpreted as the `flex-grow` value.
552
+ */
553
+ flex?: number | string;
554
+ /**
555
+ * Config object of a footer. May contain a `dock`, `html` and a `cls` property. A footer is not a widget,
556
+ * but rather plain HTML that follows the last element of the panel's body and [strips](https://bryntum.com/products/calendar/docs/api/Core/widget/Panel#config-strips).
557
+ * ...
558
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-footer)
559
+ */
560
+ footer?: {
561
+ dock?: 'top' | 'right' | 'bottom' | 'left' | 'start' | 'end';
562
+ html?: string;
563
+ cls?: string;
564
+ } | string;
565
+ /**
566
+ * An object which names formula prefixes which will be applied to all columns configured with
567
+ * `formula : true`.
568
+ * ...
569
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-formulaProviders)
570
+ */
571
+ formulaProviders?: Record<string, FormulaProviderConfig>;
572
+ /**
573
+ * Refresh entire row when a record changes (`true`) or, if possible, only the cells affected (`false`).
574
+ * ...
575
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-fullRowRefresh)
576
+ */
577
+ fullRowRefresh?: boolean;
578
+ /**
579
+ * A Function (or name of a function in the ownership hierarchy) which returns the
580
+ * [resource record](https://bryntum.com/products/calendar/docs/api/Scheduler/model/ResourceModel) to use to create the UI for an event.
581
+ * ...
582
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-getPrimaryResource)
583
+ * @param {Scheduler.model.EventModel} eventRecord The event from which to extract the primary resource.
584
+ * @returns {Scheduler.model.ResourceModel} The resource to be used to render the event.
585
+ */
586
+ getPrimaryResource?: ((eventRecord: EventModel) => ResourceModel) | string;
587
+ /**
588
+ * A function called for each row to determine its height. It is passed a [record](https://bryntum.com/products/calendar/docs/api/Core/data/Model) and
589
+ * expected to return the desired height of that records row. If the function returns a falsy value, Grids
590
+ * configured [rowHeight](https://bryntum.com/products/calendar/docs/api/Grid/view/GridBase#config-rowHeight) is used.
591
+ * ...
592
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-getRowHeight)
593
+ * @param {Core.data.Model} getRowHeight.record Record to determine row height for
594
+ * @returns {number} Desired row height
595
+ */
596
+ getRowHeight?: (getRowHeight: {
597
+ record: Model;
598
+ }) => number;
599
+ /**
600
+ * A config [object](https://bryntum.com/products/calendar/docs/api/Core/widget/Panel#typedef-PanelHeader) for the panel's header or a string in place of a `title`.
601
+ * ...
602
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-header)
603
+ */
604
+ header?: string | boolean | PanelHeader;
605
+ /**
606
+ * Widget's height, used to set element `style.height`. Either specify a valid height string or a number,
607
+ * which will get 'px' appended. We recommend using CSS as the primary way to control height, but in some
608
+ * cases this config is convenient.
609
+ */
610
+ height?: string | number;
611
+ /**
612
+ * Configure with true to make widget initially hidden.
613
+ */
614
+ hidden?: boolean;
615
+ /**
616
+ * By default, long running events are repeated in all rows that the event covers.
617
+ * ...
618
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-hideEventOverflow)
619
+ */
620
+ hideEventOverflow?: boolean;
621
+ /**
622
+ * Set to `true` to hide the footer elements
623
+ */
624
+ hideFooters?: boolean;
625
+ /**
626
+ * Specify `false` to display column headers
627
+ */
628
+ hideHeaders?: boolean;
629
+ /**
630
+ * Set to `true` to hide the Grid's horizontal scrollbar(s)
631
+ */
632
+ hideHorizontalScrollbar?: boolean;
633
+ /**
634
+ * Configure as `true` to hide [nonWorkingDays](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/CalendarMixin#config-nonWorkingDays)
635
+ */
636
+ hideNonWorkingDays?: boolean;
637
+ /**
638
+ * A CSS class to add to hovered row elements
639
+ */
640
+ hoverCls?: string;
641
+ /**
642
+ * An icon to show before the [title](https://bryntum.com/products/calendar/docs/api/Core/widget/Panel#config-title). Either pass a CSS class as a string, or pass a
643
+ * [DomConfig](https://bryntum.com/products/calendar/docs/api/Core/helper/DomHelper#typedef-DomConfig) object describing an element to represent the icon.
644
+ */
645
+ icon?: string | DomConfig;
646
+ /**
647
+ * Widget id, if not specified one will be generated. Also used for lookups through Widget.getById
648
+ */
649
+ id?: string;
650
+ /**
651
+ * Determines if the widgets read-only state should be controlled by its parent.
652
+ * ...
653
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-ignoreParentReadOnly)
654
+ */
655
+ ignoreParentReadOnly?: boolean;
656
+ /**
657
+ * Convenience setting to align input fields of child widgets. By default, the Field input element is
658
+ * placed immediately following the `label`. If you prefer to have all input fields aligned to the
659
+ * right, set this config to `'end'`.
660
+ * ...
661
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-inputFieldAlign)
662
+ */
663
+ inputFieldAlign?: 'start' | 'end';
664
+ /**
665
+ * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
666
+ */
667
+ insertBefore?: HTMLElement | string;
668
+ /**
669
+ * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
670
+ */
671
+ insertFirst?: HTMLElement | string;
672
+ /**
673
+ * See [Keyboard shortcuts](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#keyboard-shortcuts) for details
674
+ */
675
+ keyMap?: Record<string, KeyMapConfig>;
676
+ /**
677
+ * Convenience setting to use same label placement on all child widgets.
678
+ * ...
679
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-labelPosition)
680
+ */
681
+ labelPosition?: 'before' | 'above' | 'align-before' | 'auto' | null;
682
+ /**
683
+ * The listener set for this object.
684
+ * ...
685
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-listeners)
686
+ */
687
+ listeners?: AgendaViewListeners;
688
+ /**
689
+ * A [RangeMenu](https://bryntum.com/products/calendar/docs/api/Calendar/widget/RangeMenu) configuration block which configures the range choosing menu provided which
690
+ * by default selects one of the following:
691
+ * ...
692
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-listRangeMenu)
693
+ */
694
+ listRangeMenu?: RangeMenuConfig | null;
695
+ /**
696
+ * A [Mask](https://bryntum.com/products/calendar/docs/api/Core/widget/Mask) config object, or a message to be shown when a store is performing a remote
697
+ * operation, or Crud Manager is loading data from the sever. Set to `null` to disable default load mask.
698
+ */
699
+ loadMask?: string | MaskConfig | null;
700
+ /**
701
+ * A [Mask](https://bryntum.com/products/calendar/docs/api/Core/widget/Mask) config object to adjust the [maskDefaults](#Core/widget/Widget#config-maskDefaults)
702
+ * when data is loading. The message and optional configuration from the
703
+ * [loadMask](https://bryntum.com/products/calendar/docs/api/Core/mixin/LoadMaskable#config-loadMask) config take priority over these options, just as they do
704
+ * for `maskDefaults`, respectively.
705
+ * ...
706
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-loadMaskDefaults)
707
+ */
708
+ loadMaskDefaults?: MaskConfig;
709
+ /**
710
+ * A [Mask](https://bryntum.com/products/calendar/docs/api/Core/widget/Mask) config object to adjust the [maskDefaults](#Core/widget/Widget#config-maskDefaults)
711
+ * when an error occurs loading data.
712
+ * ...
713
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-loadMaskError)
714
+ */
715
+ loadMaskError?: MaskConfig | Mask | boolean;
716
+ /**
717
+ * Set to `false` to disable localization of this object.
718
+ */
719
+ localizable?: boolean;
720
+ /**
721
+ * Time in ms until a longpress is triggered
722
+ */
723
+ longPressTime?: number;
724
+ /**
725
+ * Widget's margin. This may be configured as a single number or a `TRBL` format string.
726
+ * numeric-only values are interpreted as pixels.
727
+ */
728
+ margin?: number | string;
729
+ /**
730
+ * Grids change the `maskDefaults` to cover only their `body` element.
731
+ */
732
+ maskDefaults?: MaskConfig;
733
+ /**
734
+ * Set to `true` to apply the default mask to the widget. Alternatively, this can be the mask message or a
735
+ * [Mask](https://bryntum.com/products/calendar/docs/api/Core/widget/Mask) config object.
736
+ */
737
+ masked?: boolean | string | MaskConfig;
738
+ /**
739
+ * The maximum date to which the `endDate` of this view may be navigated.
740
+ */
741
+ maxDate?: Date | string;
742
+ /**
743
+ * The element's maxHeight. Can be either a String or a Number (which will have 'px' appended). Note that
744
+ * like [height](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-height), *reading* the value will return the numeric value in pixels.
745
+ */
746
+ maxHeight?: string | number;
747
+ /**
748
+ * The elements maxWidth. Can be either a String or a Number (which will have 'px' appended). Note that
749
+ * like [width](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-width), *reading* the value will return the numeric value in pixels.
750
+ */
751
+ maxWidth?: string | number;
752
+ /**
753
+ * The minimum date to which the `startDate` of this view may be navigated.
754
+ */
755
+ minDate?: Date | string;
756
+ /**
757
+ * Grid's `min-height`. Defaults to `10em` to be sure that the Grid always has a height wherever it is
758
+ * inserted.
759
+ * ...
760
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-minHeight)
761
+ */
762
+ minHeight?: string | number;
763
+ /**
764
+ * The elements minWidth. Can be either a String or a Number (which will have 'px' appended). Note that
765
+ * like [width](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-width), *reading* the value will return the numeric value in pixels.
766
+ */
767
+ minWidth?: string | number;
768
+ /**
769
+ * Grid monitors window resize by default.
770
+ */
771
+ monitorResize?: boolean;
772
+ /**
773
+ * Non-working days as an object where keys are day indices, 0-6 (Sunday-Saturday), and the value is `true`.
774
+ * Defaults to [nonWorkingDays](https://bryntum.com/products/calendar/docs/api/Core/helper/DateHelper#property-nonWorkingDays-static).
775
+ */
776
+ nonWorkingDays?: Record<number, boolean>;
777
+ /**
778
+ * This view lines up the textual content of event bars by shifting event bars of
779
+ * events which start before the bar's cell leftwards by the arrow width.
780
+ * ...
781
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-offsetStartsBeforeEvents)
782
+ */
783
+ offsetStartsBeforeEvents?: boolean;
784
+ /**
785
+ * The owning Widget of this Widget. If this Widget is directly contained (that is, it is one of the
786
+ * [items](https://bryntum.com/products/calendar/docs/api/Core/widget/Container#property-items) of a Container), this config will be ignored. In this case
787
+ * the owner is <strong>always</strong> the encapsulating Container.
788
+ * ...
789
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-owner)
790
+ */
791
+ owner?: Widget | any;
792
+ /**
793
+ * The class name to add to events which have an end date in the past. Defaults to `'b-past-event'`.
794
+ * ...
795
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-pastEventCls)
796
+ */
797
+ pastEventCls?: string;
798
+ /**
799
+ * Specify plugins (an array of classes) in config
800
+ */
801
+ plugins?: Function[];
802
+ /**
803
+ * True to preserve focused cell after loading new data
804
+ */
805
+ preserveFocusOnDatasetChange?: boolean;
806
+ /**
807
+ * Preserve the grid's vertical scroll position when changesets are applied, as in the case of remote
808
+ * changes, or when stores are configured with [syncDataOnLoad](https://bryntum.com/products/calendar/docs/api/Core/data/Store#config-syncDataOnLoad).
809
+ */
810
+ preserveScroll?: PreserveScrollOptions | boolean;
811
+ /**
812
+ * Specify `true` to preserve vertical scroll position after store actions that trigger a `refresh` event,
813
+ * such as loading new data and filtering.
814
+ */
815
+ preserveScrollOnDatasetChange?: boolean;
816
+ /**
817
+ * Prevent tooltip from being displayed on touch devices. Useful for example for buttons that display a
818
+ * menu on click etc, since the tooltip would be displayed at the same time.
819
+ */
820
+ preventTooltipOnTouch?: boolean;
821
+ /**
822
+ * The time range around the [date](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/DateRangeOwner#config-date) to display events for.
823
+ * ...
824
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-range)
825
+ */
826
+ range?: string | DurationConfig;
827
+ /**
828
+ * Set to `true` to make the grid read-only, by disabling any UIs for modifying data.
829
+ * ...
830
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-readOnly)
831
+ */
832
+ readOnly?: boolean;
833
+ relayStoreEvents?: boolean;
834
+ /**
835
+ * Either a default `rendition` to apply to all child widgets, or a map of renditions keyed by child widget
836
+ * `type`.
837
+ * ...
838
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-rendition)
839
+ */
840
+ rendition?: string | Record<string, string> | null;
841
+ /**
842
+ * Configure this property to allow the widget/component to be resized. Pressing <kbd>Shift</kbd> while resizing will
843
+ * constrain the aspect ratio.
844
+ * ...
845
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-resizable)
846
+ */
847
+ resizable?: boolean | {
848
+ minWidth?: number;
849
+ maxWidth?: number;
850
+ minHeight?: number;
851
+ maxHeight?: number;
852
+ handles?: object;
853
+ };
854
+ /**
855
+ * Set to `false` to only measure cell contents when double-clicking the edge between column headers.
856
+ */
857
+ resizeToFitIncludesHeader?: boolean;
858
+ /**
859
+ * Path to load resource images from. Used by the [showResourceAvatars](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/CalendarMixin#config-showResourceAvatars) config
860
+ * to create URLs using the resource's
861
+ * [image](https://bryntum.com/products/calendar/docs/api/Scheduler/model/ResourceModel#field-image) or
862
+ * [imageUrl](https://bryntum.com/products/calendar/docs/api/Scheduler/model/ResourceModel#field-imageUrl) fields:
863
+ * ...
864
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-resourceImagePath)
865
+ */
866
+ resourceImagePath?: string;
867
+ /**
868
+ * Specifies the various responsive state objects keyed by their name. Each key (except `'*'`, see below) in
869
+ * this object is a state name (see [responsiveState](https://bryntum.com/products/calendar/docs/api/Core/widget/mixin/Responsive#config-responsiveState)) and its corresponding value is the
870
+ * associated [ResponsiveState](https://bryntum.com/products/calendar/docs/api/Core/widget/mixin/Responsive#typedef-ResponsiveState) object.
871
+ * ...
872
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-responsive)
873
+ */
874
+ responsive?: object;
875
+ /**
876
+ * "Break points" for which responsive config to use for columns and css.
877
+ * ...
878
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-responsiveLevels)
879
+ */
880
+ responsiveLevels?: Record<string, number | string | ResponsiveLevelConfig>;
881
+ /**
882
+ * Set to `true` to mark this instance as the default [responsiveTarget](https://bryntum.com/products/calendar/docs/api/Core/widget/mixin/Responsive#config-responsiveTarget) for descendants that do
883
+ * not specify an explicit [responsiveTarget](https://bryntum.com/products/calendar/docs/api/Core/widget/mixin/Responsive#config-responsiveTarget) of their own.
884
+ */
885
+ responsiveRoot?: boolean;
886
+ /**
887
+ * The name of the active state of the [responsive](https://bryntum.com/products/calendar/docs/api/Core/widget/mixin/Responsive#config-responsive) config. This is assigned internally
888
+ * and should not be assigned directly.
889
+ */
890
+ responsiveState?: string;
891
+ /**
892
+ * The widget whose size and other properties drive this object's responsive behavior. If this config is not
893
+ * specified, the closest ancestor that specified [responsiveRoot=true](https://bryntum.com/products/calendar/docs/api/Core/widget/mixin/Responsive#config-responsiveRoot) will be
894
+ * used. If there is no such ancestor, then the instance using this mixin is used.
895
+ * ...
896
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-responsiveTarget)
897
+ */
898
+ responsiveTarget?: string | Widget;
899
+ /**
900
+ * Configure as `true` to have the component display a translucent ripple when its
901
+ * [focusElement](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#property-focusElement), or [element](#Core/widget/Widget#property-element) is tapped <em>if the
902
+ * current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
903
+ * ...
904
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-ripple)
905
+ */
906
+ ripple?: boolean | {
907
+ delegate?: string;
908
+ color?: string;
909
+ radius?: number;
910
+ clip?: string;
911
+ };
912
+ /**
913
+ * 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`
914
+ */
915
+ rootElement?: ShadowRoot | HTMLElement;
916
+ /**
917
+ * Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
918
+ * overriden by specifying a [rowHeight](https://bryntum.com/products/calendar/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
919
+ * a column [renderer](https://bryntum.com/products/calendar/docs/api/Grid/column/Column#config-renderer).
920
+ * ...
921
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-rowHeight)
922
+ */
923
+ rowHeight?: number;
924
+ /**
925
+ * Set to `false` to not show row lines. End result might be overruled by/differ between themes.
926
+ */
927
+ rowLines?: boolean;
928
+ /**
929
+ * This may be configured as `true` to make the widget's element use the `direction:rtl` style.
930
+ * ...
931
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-rtl)
932
+ */
933
+ rtl?: boolean;
934
+ /**
935
+ * Configures whether the grid is scrollable in the `Y` axis. This is used to configure a [Scroller](https://bryntum.com/products/calendar/docs/api/Core/helper/util/Scroller).
936
+ * See the [scrollerClass](https://bryntum.com/products/calendar/docs/api/Grid/view/GridBase#config-scrollerClass) config option.
937
+ * ...
938
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-scrollable)
939
+ */
940
+ scrollable?: boolean | ScrollerConfig | Scroller;
941
+ /**
942
+ * The class to instantiate to use as the [scrollable](https://bryntum.com/products/calendar/docs/api/Grid/view/GridBase#config-scrollable). Defaults to [Scroller](#Core/helper/util/Scroller).
943
+ */
944
+ scrollerClass?: typeof Scroller;
945
+ /**
946
+ * Configuration values for the [ScrollManager](https://bryntum.com/products/calendar/docs/api/Core/util/ScrollManager) class on initialization. Returns the
947
+ * [ScrollManager](https://bryntum.com/products/calendar/docs/api/Core/util/ScrollManager) at runtime.
948
+ */
949
+ scrollManager?: ScrollManagerConfig | ScrollManager;
950
+ /**
951
+ * Selection configuration settings, change these properties to control how selection works and what can be
952
+ * selected.
953
+ * ...
954
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-selectionMode)
955
+ */
956
+ selectionMode?: GridSelectionMode;
957
+ /**
958
+ * A button configuration object to use for the automatically created mode selector button for this mode.
959
+ */
960
+ selectorButton?: ButtonConfig;
961
+ /**
962
+ * A menu item configuration object to use for the automatically created mode selector menu item for this mode.
963
+ */
964
+ selectorMenuItem?: MenuItemConfig;
965
+ /**
966
+ * The "Settings" button which is a floating button which offers the Agenda [range selection menu](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#property-listRangeMenu)
967
+ */
968
+ settingsButton?: ButtonConfig | Button;
969
+ /**
970
+ * The time range to move by when [next](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/DateRangeOwner#function-next) or [previous](#Calendar/widget/mixin/DateRangeOwner#function-previous) is called.
971
+ * ...
972
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-shiftIncrement)
973
+ */
974
+ shiftIncrement?: string | DurationConfig;
975
+ /**
976
+ * A [DateHelper](https://bryntum.com/products/calendar/docs/api/Core/helper/DateHelper) format string/function to use to create date output for
977
+ * abbreviated view descriptions.
978
+ * @param {Date} date The date to format.
979
+ * @returns {string} The formatted date.
980
+ */
981
+ shortDateFormat?: string | ((date: Date) => string);
982
+ /**
983
+ * A [DateHelper](https://bryntum.com/products/calendar/docs/api/Core/helper/DateHelper) format string/function to use to create date and time output for
984
+ * abbreviated view descriptions.
985
+ * @param {Date} date The date to format.
986
+ * @returns {string} The formatted date.
987
+ */
988
+ shortDateTimeFormat?: string | ((date: Date) => string);
989
+ /**
990
+ * The class name to add to events which have duration less than or equal to
991
+ * [shortEventDuration](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/CalendarMixin#config-shortEventDuration).
992
+ */
993
+ shortEventCls?: string;
994
+ /**
995
+ * The duration at which below and equal to this value, an event's encapsulating element gets
996
+ * the [shortEventCls](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/CalendarMixin#config-shortEventCls) added to it so that small event bars can have style rearrangements.
997
+ * ...
998
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-shortEventDuration)
999
+ */
1000
+ shortEventDuration?: string | number;
1001
+ /**
1002
+ * By default, only dates which contain events are shown.
1003
+ * ...
1004
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-showAllDates)
1005
+ */
1006
+ showAllDates?: boolean;
1007
+ /**
1008
+ * <strong>Not applicable in a `DayView`</strong>
1009
+ * ...
1010
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-showBullet)
1011
+ * @param {boolean} bar This is `false` by default. Set this to `true` in modes where a solid event bar should show a bullet icon
1012
+ * @param {boolean} noBar This is `true` by default. Events with no background colour, use this to show the event's defined `eventColor`
1013
+ */
1014
+ showBullet?: boolean | {
1015
+ bar?: boolean;
1016
+ noBar?: boolean;
1017
+ };
1018
+ /**
1019
+ * Configure as `true` to have the grid show a red "changed" tag in cells whose
1020
+ * field value has changed and not yet been committed.
1021
+ * ...
1022
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-showDirty)
1023
+ */
1024
+ showDirty?: boolean | {
1025
+ duringEdit?: boolean;
1026
+ newRecord?: boolean;
1027
+ };
1028
+ /**
1029
+ * By default, only cells for days which contain events are shown.
1030
+ * ...
1031
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-showEmptyDates)
1032
+ */
1033
+ showEmptyDates?: boolean;
1034
+ /**
1035
+ * Configure as `true` to show avatars of the assigned resources (calendars) at the
1036
+ * start of the event bar.
1037
+ * ...
1038
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-showResourceAvatars)
1039
+ */
1040
+ showResourceAvatars?: boolean | string;
1041
+ /**
1042
+ * Programmatic control over how many columns to span when used in a grid layout.
1043
+ */
1044
+ span?: number;
1045
+ /**
1046
+ * Set to `true` to stack multi-day events within each cell in the order of their start time.
1047
+ * ...
1048
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-stackMultiDayEvents)
1049
+ */
1050
+ stackMultiDayEvents?: boolean;
1051
+ /**
1052
+ * The start date (Time component is zeroed) of this view.
1053
+ */
1054
+ startDate?: Date;
1055
+ /**
1056
+ * This value can be one of the following:
1057
+ * ...
1058
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-stateful)
1059
+ */
1060
+ stateful?: boolean | object | string[];
1061
+ /**
1062
+ * The events that, when fired by this component, should trigger it to save its state by calling
1063
+ * [saveState](https://bryntum.com/products/calendar/docs/api/Core/mixin/State#function-saveState).
1064
+ * ...
1065
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-statefulEvents)
1066
+ */
1067
+ statefulEvents?: object | string[];
1068
+ /**
1069
+ * The key to use when saving this object's state in the [stateProvider](https://bryntum.com/products/calendar/docs/api/Core/mixin/State#config-stateProvider). If this config is
1070
+ * not assigned, and [stateful](https://bryntum.com/products/calendar/docs/api/Core/mixin/State#config-stateful) is not set to `false`, the [id](#Core/widget/Widget#config-id)
1071
+ * (if explicitly specified) will be used as the `stateId`.
1072
+ * ...
1073
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-stateId)
1074
+ */
1075
+ stateId?: string;
1076
+ /**
1077
+ * The `StateProvider` to use to save and restore this object's [state](https://bryntum.com/products/calendar/docs/api/Core/mixin/State#property-state). By default, `state`
1078
+ * will be saved using the [default state provider](https://bryntum.com/products/calendar/docs/api/Core/state/StateProvider#property-instance-static).
1079
+ * ...
1080
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-stateProvider)
1081
+ */
1082
+ stateProvider?: StateProvider;
1083
+ /**
1084
+ * The properties of this settings object controls how grid is restored from state data.
1085
+ * ...
1086
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-stateSettings)
1087
+ */
1088
+ stateSettings?: {
1089
+ restoreUnconfiguredColumns?: boolean;
1090
+ };
1091
+ /**
1092
+ * Store that holds records to display in the grid, or a store config object. If the configuration contains
1093
+ * a `readUrl`, an `AjaxStore` will be created.
1094
+ * ...
1095
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-store)
1096
+ */
1097
+ store?: Store | StoreConfig | AjaxStore | AjaxStoreConfig;
1098
+ /**
1099
+ * An object containing widgets keyed by name. By default (when no `type` is given), strips are
1100
+ * [toolbars](https://bryntum.com/products/calendar/docs/api/Core/widget/Toolbar). If you want to pass an array, you can use
1101
+ * the toolbar's [items](https://bryntum.com/products/calendar/docs/api/Core/widget/Container#config-items).
1102
+ * ...
1103
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-strips)
1104
+ */
1105
+ strips?: Record<string, CalendarContainerItemConfig>;
1106
+ /**
1107
+ * An object containing sub grid configuration objects keyed by a `region` property.
1108
+ * By default, grid has a 'locked' region (if configured with locked columns) and a 'normal' region.
1109
+ * The 'normal' region defaults to use `flex: 1`.
1110
+ * ...
1111
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-subGridConfigs)
1112
+ */
1113
+ subGridConfigs?: Record<string, SubGridConfig>;
1114
+ /**
1115
+ * The converse of [syncViewDate](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/CalendarMixin#property-syncViewDate)
1116
+ * ...
1117
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-syncCalendarDate)
1118
+ */
1119
+ syncCalendarDate?: boolean;
1120
+ /**
1121
+ * A [Mask](https://bryntum.com/products/calendar/docs/api/Core/widget/Mask) config object, or a message to be shown when Crud Manager
1122
+ * is persisting changes on the server. Set to `null` to disable default sync mask.
1123
+ * ...
1124
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-syncMask)
1125
+ */
1126
+ syncMask?: string | MaskConfig | null;
1127
+ /**
1128
+ * The converse of [syncCalendarDate](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/CalendarMixin#property-syncCalendarDate)
1129
+ * ...
1130
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-syncViewDate)
1131
+ */
1132
+ syncViewDate?: boolean;
1133
+ /**
1134
+ * A configuration for the [tab](https://bryntum.com/products/calendar/docs/api/Core/widget/Tab) created for this widget when it is placed in a
1135
+ * [TabPanel](https://bryntum.com/products/calendar/docs/api/Core/widget/TabPanel). For example, this config can be used to control the icon of the `tab` for
1136
+ * this widget:
1137
+ * ...
1138
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-tab)
1139
+ */
1140
+ tab?: boolean | TabConfig;
1141
+ /**
1142
+ * When this container is used as a tab in a TabPanel, these items are added to the
1143
+ * [TabBar](https://bryntum.com/products/calendar/docs/api/Core/widget/TabBar) when this container is the active tab.
1144
+ * ...
1145
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-tabBarItems)
1146
+ */
1147
+ tabBarItems?: ToolbarItems[] | Widget[];
1148
+ /**
1149
+ * A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/calendar/docs/api/Core/widget/Toolbar),
1150
+ * or array of config objects representing the child items of a Toolbar.
1151
+ * This creates a toolbar docked to the top of the panel immediately below the header.
1152
+ * ...
1153
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-tbar)
1154
+ */
1155
+ tbar?: (CalendarContainerItemConfig | string)[] | ToolbarConfig | PagingToolbarConfig | null;
1156
+ /**
1157
+ * A [DateHelper](https://bryntum.com/products/calendar/docs/api/Core/helper/DateHelper) format string/function used to format the time displayed in events
1158
+ * @param {Date} date The date to format.
1159
+ * @returns {string} The formatted date.
1160
+ */
1161
+ timeFormat?: string | ((date: Date) => string);
1162
+ /**
1163
+ * A title to display in the header or owning TabPanel. Causes creation and docking of a header
1164
+ * to the top if no header is configured.
1165
+ * ...
1166
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-title)
1167
+ */
1168
+ title?: string;
1169
+ /**
1170
+ * The [tools](https://bryntum.com/products/calendar/docs/api/Core/widget/Tool) to add either before or after the `title` in the Panel header. Each
1171
+ * property name is the reference by which an instantiated tool may be retrieved from the live
1172
+ * `[tools](https://bryntum.com/products/calendar/docs/api/Core/widget/mixin/Toolable#property-tools)` property.
1173
+ * ...
1174
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-tools)
1175
+ */
1176
+ tools?: Record<string, ToolConfig> | null;
1177
+ /**
1178
+ * Configure UI transitions for various actions in the grid.
1179
+ */
1180
+ transition?: {
1181
+ insertRecord?: boolean;
1182
+ removeRecord?: boolean;
1183
+ toggleColumn?: boolean;
1184
+ expandCollapseColumn?: boolean;
1185
+ toggleRegion?: boolean;
1186
+ toggleTreeNode?: boolean;
1187
+ toggleGroup?: boolean;
1188
+ filterRemoval?: boolean;
1189
+ };
1190
+ /**
1191
+ * Animation transition duration in milliseconds.
1192
+ */
1193
+ transitionDuration?: number;
1194
+ type?: 'agendaview' | 'agenda';
1195
+ /**
1196
+ * Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
1197
+ * as a space separated string, an array of strings, or as an object in which property names with truthy
1198
+ * values are used as the class names.
1199
+ * ...
1200
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#config-ui)
1201
+ */
1202
+ ui?: 'plain' | 'toolbar' | string | object;
1203
+ /**
1204
+ * The week start day, 0 meaning Sunday, 6 meaning Saturday.
1205
+ * Defaults to [weekStartDay](https://bryntum.com/products/calendar/docs/api/Core/helper/DateHelper#property-weekStartDay-static).
1206
+ */
1207
+ weekStartDay?: number;
1208
+ /**
1209
+ * A widgets weight determines its position among siblings when added to a [Container](https://bryntum.com/products/calendar/docs/api/Core/widget/Container).
1210
+ * Higher weights go further down.
1211
+ */
1212
+ weight?: number;
1213
+ /**
1214
+ * Widget's width, used to set element `style.width`. Either specify a valid width string or a number, which
1215
+ * will get 'px' appended. We recommend using CSS as the primary way to control width, but in some cases
1216
+ * this config is convenient.
1217
+ */
1218
+ width?: string | number;
1219
+ /**
1220
+ * AI-powered filter feature for Grid. Allows users to type natural language queries to filter grid data.
1221
+ * ...
1222
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/ai/AIFilter)
1223
+ */
1224
+ aiFilterFeature?: object | boolean | string | AIFilter | AIFilterConfig;
1225
+ /**
1226
+ * Allows using `[Ctrl/CMD + C]`, `[Ctrl/CMD + X]` and `[Ctrl/CMD + V]` to cut, copy and paste cell or cell ranges. Also
1227
+ * makes cut, copy and paste actions available via the cell context menu.
1228
+ * ...
1229
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/CellCopyPaste)
1230
+ */
1231
+ cellCopyPasteFeature?: object | boolean | string | CellCopyPaste | CellCopyPasteConfig;
1232
+ /**
1233
+ * Adding this feature to the grid and other Bryntum products which are based on the Grid (i.e. Scheduler, SchedulerPro, and Gantt)
1234
+ * enables cell editing. Any subclass of [Field](https://bryntum.com/products/calendar/docs/api/Core/widget/Field) can be used
1235
+ * as editor for the [Column](https://bryntum.com/products/calendar/docs/api/Grid/column/Column). The most popular are:
1236
+ * ...
1237
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/CellEdit)
1238
+ */
1239
+ cellEditFeature?: object | boolean | string | CellEdit | CellEditConfig;
1240
+ /**
1241
+ * Right click to display context menu for cells. To invoke the cell menu in a keyboard-accessible manner, use the
1242
+ * `SPACE` key when the cell is focused.
1243
+ * ...
1244
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/CellMenu)
1245
+ */
1246
+ cellMenuFeature?: object | boolean | string | CellMenu | CellMenuConfig;
1247
+ /**
1248
+ * Displays a tooltip when hovering cells.
1249
+ * ...
1250
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/CellTooltip)
1251
+ */
1252
+ cellTooltipFeature?: object | boolean | string | CellTooltip | CellTooltipConfig;
1253
+ /**
1254
+ * Adds interactive charting to a Grid. [Charts](https://bryntum.com/products/calendar/docs/api/Chart/widget/Chart) can be created from a selection of Grid data
1255
+ * and updated in realtime as data changes. Supports many common chart types with extensive styling and customization
1256
+ * options.
1257
+ * ...
1258
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/Charts)
1259
+ */
1260
+ chartsFeature?: object | boolean | string | Charts | ChartsConfig;
1261
+ /**
1262
+ * Enables the [autoWidth](https://bryntum.com/products/calendar/docs/api/Grid/column/Column#config-autoWidth) config for a grid's columns.
1263
+ * ...
1264
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/ColumnAutoWidth)
1265
+ */
1266
+ columnAutoWidthFeature?: object | boolean | string | ColumnAutoWidth | ColumnAutoWidthConfig;
1267
+ /**
1268
+ * Displays a toolbar while dragging column headers. Drop on a button in the toolbar to activate a certain function,
1269
+ * for example to group by that column. This feature simplifies certain operations on touch devices.
1270
+ * ...
1271
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/ColumnDragToolbar)
1272
+ */
1273
+ columnDragToolbarFeature?: object | boolean | string | ColumnDragToolbar | ColumnDragToolbarConfig;
1274
+ /**
1275
+ * Displays a column picker (to show/hide columns) in the header context menu. Columns can be displayed in sub menus
1276
+ * by region or tag. Grouped headers are displayed as menu hierarchies.
1277
+ * ...
1278
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/ColumnPicker)
1279
+ */
1280
+ columnPickerFeature?: object | boolean | string | ColumnPicker | ColumnPickerConfig;
1281
+ /**
1282
+ * Allows user to rename columns by either right-clicking column header or using keyboard shortcuts when column header
1283
+ * is focused.
1284
+ * ...
1285
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/ColumnRename)
1286
+ */
1287
+ columnRenameFeature?: object | boolean | string | ColumnRename | ColumnRenameConfig;
1288
+ /**
1289
+ * Allows user to reorder columns by dragging headers. To get notified about column reorder listen to `change` event
1290
+ * on [columns](https://bryntum.com/products/calendar/docs/api/Grid/data/ColumnStore) store.
1291
+ * ...
1292
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/ColumnReorder)
1293
+ */
1294
+ columnReorderFeature?: object | boolean | string | ColumnReorder | ColumnReorderConfig;
1295
+ /**
1296
+ * Enables user to resize columns by dragging a handle on the right hand side of the header. To get notified about column
1297
+ * resize listen to `change` event on [columns](https://bryntum.com/products/calendar/docs/api/Grid/data/ColumnStore) store.
1298
+ * ...
1299
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/ColumnResize)
1300
+ */
1301
+ columnResizeFeature?: object | boolean | string | ColumnResize | ColumnResizeConfig;
1302
+ /**
1303
+ * A feature that allows exporting Grid data to Excel or CSV without involving the server. It uses
1304
+ * [TableExporter](https://bryntum.com/products/calendar/docs/api/Grid/util/TableExporter) class as data provider, 3rd party provider to generate XLS files, and
1305
+ * [Microsoft XML specification](https://msdn.microsoft.com/en-us/library/office/documentformat.openxml.spreadsheet.aspx).
1306
+ * ...
1307
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/experimental/ExcelExporter)
1308
+ */
1309
+ excelExporterFeature?: object | boolean | string | GridExcelExporter | GridExcelExporterConfig;
1310
+ /**
1311
+ * An experimental feature that lets users drop files on a Widget. The widget fires an event when a file is dropped onto it.
1312
+ * In the event, you get access to the raw files as strings, that were parsed by calling `readAsBinaryString`.
1313
+ * ...
1314
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/experimental/FileDrop)
1315
+ */
1316
+ fileDropFeature?: object | boolean | string | FileDrop | FileDropConfig;
1317
+ /**
1318
+ * This feature adds a fill handle to a Grid range selection, which when dragged, fills the cells being dragged over
1319
+ * with values based on the values in the original selected range. This is similar to functionality normally seen in
1320
+ * various spreadsheet applications.
1321
+ * ...
1322
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/FillHandle)
1323
+ */
1324
+ fillHandleFeature?: object | boolean | string | FillHandle | FillHandleConfig;
1325
+ /**
1326
+ * Feature that allows filtering of the grid by settings filters on columns. The actual filtering is done by the store.
1327
+ * For info on programmatically handling filters, see [StoreFilter](https://bryntum.com/products/calendar/docs/api/Core/data/mixin/StoreFilter).
1328
+ * ...
1329
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/Filter)
1330
+ */
1331
+ filterFeature?: object | boolean | string | Filter | FilterConfig;
1332
+ /**
1333
+ * Feature that allows filtering of the grid by entering filters on column headers.
1334
+ * The actual filtering is done by the store.
1335
+ * For info on programmatically handling filters, see [StoreFilter](https://bryntum.com/products/calendar/docs/api/Core/data/mixin/StoreFilter).
1336
+ * ...
1337
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/FilterBar)
1338
+ */
1339
+ filterBarFeature?: object | boolean | string | FilterBar | FilterBarConfig;
1340
+ /**
1341
+ * Enables rendering and handling of row groups. The actual grouping is done in the store, but triggered by
1342
+ * <kbd>shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
1343
+ * one anywhere on grid). Use <kbd>shift</kbd> + <kbd>alt</kbd> + click, or the context menu, to remove a column
1344
+ * grouper.
1345
+ * ...
1346
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/Group)
1347
+ */
1348
+ groupFeature?: object | boolean | string | Group | GroupConfig;
1349
+ /**
1350
+ * Displays a summary row as a group footer in a grouped grid. Uses the same configuration options on columns as
1351
+ * [Summary](https://bryntum.com/products/calendar/docs/api/Grid/feature/Summary).
1352
+ * ...
1353
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/GroupSummary)
1354
+ */
1355
+ groupSummaryFeature?: object | boolean | string | GridGroupSummary | GridGroupSummaryConfig;
1356
+ /**
1357
+ * Right click column header or focus it and press SPACE key to show the context menu for headers.
1358
+ * ...
1359
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/HeaderMenu)
1360
+ */
1361
+ headerMenuFeature?: object | boolean | string | HeaderMenu | HeaderMenuConfig;
1362
+ /**
1363
+ * This feature allows records which satisfy a certain condition to be locked at the top of the grid.
1364
+ * ...
1365
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/LockRows)
1366
+ */
1367
+ lockRowsFeature?: object | boolean | string | GridLockRows | GridLockRowsConfig;
1368
+ /**
1369
+ * This feature merges cells that have the same value in sorted (or [optionally](https://bryntum.com/products/calendar/docs/api/Grid/feature/MergeCells#config-sortedOnly) any) columns
1370
+ * configured to [mergeCells](https://bryntum.com/products/calendar/docs/api/Grid/column/Column#config-mergeCells).
1371
+ * ...
1372
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/MergeCells)
1373
+ */
1374
+ mergeCellsFeature?: object | boolean | string | MergeCells | MergeCellsConfig;
1375
+ /**
1376
+ * Generates PDF/PNG files from the Grid component.
1377
+ * ...
1378
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/export/PdfExport)
1379
+ */
1380
+ pdfExportFeature?: object | boolean | string | GridPdfExport | GridPdfExportConfig;
1381
+ /**
1382
+ * Allows pinning columns to the start or end region of the grid without any additional subGrid configurations.
1383
+ * When pinning to a region that does not yet exist, the feature creates the required subGrid on the fly.
1384
+ * ...
1385
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/PinColumns)
1386
+ */
1387
+ pinColumnsFeature?: object | boolean | string | PinColumns | PinColumnsConfig;
1388
+ /**
1389
+ * Allows printing Grid contents using browser print dialog.
1390
+ * ...
1391
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/export/GridPrint)
1392
+ */
1393
+ printFeature?: object | boolean | string | GridPrint | GridPrintConfig;
1394
+ /**
1395
+ * Feature that allows the user to search in a column by focusing a cell and typing. Navigate between hits using the
1396
+ * keyboard, [f3] or [ctrl]/[cmd] + [g] moves to next, also pressing [shift] moves to previous.
1397
+ * ...
1398
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/QuickFind)
1399
+ */
1400
+ quickFindFeature?: object | boolean | string | QuickFind | QuickFindConfig;
1401
+ /**
1402
+ * Makes the splitter between grid [sections](https://bryntum.com/products/calendar/docs/api/Grid/view/SubGrid) draggable, to let users resize, and
1403
+ * collapse/expand the sections.
1404
+ * ...
1405
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/RegionResize)
1406
+ */
1407
+ regionResizeFeature?: object | boolean | string | RegionResize | RegionResizeConfig;
1408
+ /**
1409
+ * Allow using [Ctrl/CMD + C/X] and [Ctrl/CMD + V] to copy/cut-and-paste rows. Also makes cut, copy and paste actions
1410
+ * available via the cell context menu.
1411
+ * ...
1412
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/RowCopyPaste)
1413
+ */
1414
+ rowCopyPasteFeature?: object | boolean | string | RowCopyPaste | RowCopyPasteConfig;
1415
+ /**
1416
+ * This feature allows editing of entire rows in a grid in a docked panel which by default slides out from the right.
1417
+ * ...
1418
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/RowEdit)
1419
+ */
1420
+ rowEditFeature?: object | boolean | string | RowEdit | RowEditConfig;
1421
+ /**
1422
+ * Enables expanding of Grid rows by either row click or double click, or by adding a separate Grid column which renders
1423
+ * a button that expands or collapses the row.
1424
+ * ...
1425
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/RowExpander)
1426
+ */
1427
+ rowExpanderFeature?: object | boolean | string | RowExpander | RowExpanderConfig;
1428
+ /**
1429
+ * Allows user to reorder rows by dragging them. To get notified about row reorder listen to `change` event
1430
+ * on the grid [store](https://bryntum.com/products/calendar/docs/api/Core/data/Store).
1431
+ * ...
1432
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/RowReorder)
1433
+ */
1434
+ rowReorderFeature?: object | boolean | string | GridRowReorder | GridRowReorderConfig;
1435
+ /**
1436
+ * Enables user to change row height by dragging the bottom row border. After a resize operation, the [rowHeight](https://bryntum.com/products/calendar/docs/api/Grid/data/GridRowModel#field-rowHeight)
1437
+ * field of the record is updated (when [applyToAllRows](https://bryntum.com/products/calendar/docs/api/Grid/feature/RowResize#config-applyToAllRows) is `false`).
1438
+ * ...
1439
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/RowResize)
1440
+ */
1441
+ rowResizeFeature?: object | boolean | string | GridRowResize | GridRowResizeConfig;
1442
+ /**
1443
+ * <div class="external-example vertical" data-file="Grid/feature/Search.js"></div>
1444
+ * ...
1445
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/Search)
1446
+ */
1447
+ searchFeature?: object | boolean | string | Search | SearchConfig;
1448
+ /**
1449
+ * Allows sorting of grid by clicking (or tapping) headers, also displays which columns grid is sorted by (numbered if
1450
+ * using multisort). Use modifier keys for multisorting: [Ctrl/CMD + click] to add sorter, [Ctrl/CMD + Alt + click] to remove sorter.
1451
+ * The actual sorting is done by the store, see [Store.sort()](https://bryntum.com/products/calendar/docs/api/Core/data/mixin/StoreSort#function-sort).
1452
+ * ...
1453
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/Sort)
1454
+ */
1455
+ sortFeature?: object | boolean | string | Sort | SortConfig;
1456
+ /**
1457
+ * This feature allows splitting the Grid into multiple views, either by using the cell context menu, or
1458
+ * programmatically by calling [split()](https://bryntum.com/products/calendar/docs/api/Grid/feature/Split#function-split).
1459
+ * ...
1460
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/Split)
1461
+ */
1462
+ splitFeature?: object | boolean | string | GridSplit | GridSplitConfig;
1463
+ /**
1464
+ * A feature which pins configurable content from a grid row to the top of the grid
1465
+ * while the row scrolls off the top but is still visible.
1466
+ * ...
1467
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/StickyCells)
1468
+ */
1469
+ stickyCellsFeature?: object | boolean | string | StickyCells | StickyCellsConfig;
1470
+ /**
1471
+ * Stripes rows by adding alternating CSS classes to all row elements (`b-even` and `b-odd`).
1472
+ * ...
1473
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/Stripe)
1474
+ */
1475
+ stripeFeature?: object | boolean | string | Stripe | StripeConfig;
1476
+ /**
1477
+ * Displays a summary row in the grid footer.
1478
+ * ...
1479
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/Summary)
1480
+ */
1481
+ summaryFeature?: object | boolean | string | GridSummary | GridSummaryConfig;
1482
+ /**
1483
+ * Feature that makes the grid work more like a tree. Included by default in [TreeGrid](https://bryntum.com/products/calendar/docs/api/Grid/view/TreeGrid). Requires
1484
+ * exactly one [TreeColumn](https://bryntum.com/products/calendar/docs/api/Grid/column/TreeColumn) among grids columns. That column will have its renderer replaced with a
1485
+ * tree renderer that adds padding and icon to give the appearance of a tree. The original renderer is preserved and
1486
+ * also called.
1487
+ * ...
1488
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/Tree)
1489
+ */
1490
+ treeFeature?: object | boolean | string | Tree | TreeConfig;
1491
+ /**
1492
+ * A feature that allows transforming a flat dataset (or the leaves of a hierarchical) into a tree by specifying a
1493
+ * record field per parent level. Parents are generated based on each leaf's value for those fields.
1494
+ * ...
1495
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/TreeGroup)
1496
+ */
1497
+ treeGroupFeature?: object | boolean | string | TreeGroup | TreeGroupConfig;
1498
+ };
1499
+ export declare class BryntumAgendaViewComponent implements OnInit, OnDestroy {
1500
+ static instanceClass: typeof AgendaView;
1501
+ static instanceName: string;
1502
+ private static bryntumEvents;
1503
+ private static bryntumFeatureNames;
1504
+ private static bryntumConfigs;
1505
+ private static bryntumConfigsOnly;
1506
+ private static bryntumProps;
1507
+ private elementRef;
1508
+ instance: AgendaView;
1509
+ private bryntumConfig;
1510
+ constructor(element: ElementRef);
1511
+ activationKey: string;
1512
+ adopt: HTMLElement | string;
1513
+ animateFilterRemovals: boolean;
1514
+ animateRemovingRows: boolean;
1515
+ ariaDescription: string;
1516
+ ariaLabel: string;
1517
+ autoHeight: boolean;
1518
+ bbar: (CalendarContainerItemConfig | string)[] | ToolbarConfig | PagingToolbarConfig | null;
1519
+ bodyCls: string | object;
1520
+ bubbleEvents: object;
1521
+ collapsible: boolean | PanelCollapserConfig | PanelCollapserOverlayConfig;
1522
+ color: string;
1523
+ config: object;
1524
+ contentElementCls: string | object;
1525
+ contextMenuTriggerEvent: 'contextmenu' | 'click' | 'dblclick';
1526
+ dataField: string;
1527
+ defaultRegion: string;
1528
+ descriptionRenderer: (view: Widget) => string;
1529
+ destroyStore: boolean;
1530
+ detectCSSCompatibilityIssues: boolean;
1531
+ disableGridColumnIdWarning: boolean;
1532
+ disableGridRowModelWarning: boolean;
1533
+ dock: 'top' | 'bottom' | 'left' | 'right' | 'start' | 'end' | 'header' | 'pre-header' | object;
1534
+ drawer: boolean | {
1535
+ side?: 'start' | 'left' | 'end' | 'right' | 'top' | 'bottom';
1536
+ size?: string | number;
1537
+ inline?: boolean;
1538
+ autoClose: {
1539
+ mousedown?: boolean | string;
1540
+ focusout?: boolean | string;
1541
+ mouseout?: string;
1542
+ };
1543
+ autoCloseDelay?: number;
1544
+ };
1545
+ elementAttributes: Record<string, string | null>;
1546
+ enableSticky: boolean;
1547
+ enableTextSelection: boolean;
1548
+ endDate: Date;
1549
+ eventFilter: ((event: EventModel) => boolean) | string;
1550
+ eventHeaderRenderer: ((detail: {
1551
+ view: CalendarView;
1552
+ eventRecord: EventModel;
1553
+ resourceRecord: ResourceModel;
1554
+ renderData: {
1555
+ style: object;
1556
+ cls: object;
1557
+ iconStyle: object;
1558
+ iconCls: object;
1559
+ eventColor: string;
1560
+ dataset: object;
1561
+ solidBar: boolean;
1562
+ bodyColor: string;
1563
+ };
1564
+ showBullet: boolean;
1565
+ }) => DomConfig | DomConfig[] | string | void) | string;
1566
+ eventHeight: number | string;
1567
+ eventListTimeFormat: string | ((date: Date) => string);
1568
+ eventRenderer: ((detail: {
1569
+ view: CalendarView;
1570
+ eventRecord: EventModel;
1571
+ resourceRecord: ResourceModel;
1572
+ renderData: {
1573
+ style: object;
1574
+ cls: object;
1575
+ iconStyle: object;
1576
+ iconCls: object;
1577
+ eventColor: string;
1578
+ eventBackground: string;
1579
+ textColor: string;
1580
+ eventInnerStyle: object;
1581
+ dataset: object;
1582
+ solidBar: boolean;
1583
+ bodyColor: string;
1584
+ showBullet: boolean;
1585
+ };
1586
+ }) => DomConfig | DomConfig[] | string | void) | string;
1587
+ eventRowSpacing: number | string;
1588
+ eventSorter: (lhs: EventModel | EventBar, rhs: EventModel | EventBar) => number;
1589
+ fillLastColumn: boolean;
1590
+ fixedRowHeight: boolean;
1591
+ footer: {
1592
+ dock?: 'top' | 'right' | 'bottom' | 'left' | 'start' | 'end';
1593
+ html?: string;
1594
+ cls?: string;
1595
+ } | string;
1596
+ formulaProviders: Record<string, FormulaProviderConfig>;
1597
+ fullRowRefresh: boolean;
1598
+ getPrimaryResource: ((eventRecord: EventModel) => ResourceModel) | string;
1599
+ getRowHeight: (getRowHeight: {
1600
+ record: Model;
1601
+ }) => number;
1602
+ header: string | boolean | PanelHeader;
1603
+ hideEventOverflow: boolean;
1604
+ hideHorizontalScrollbar: boolean;
1605
+ hoverCls: string;
1606
+ icon: string | DomConfig;
1607
+ ignoreParentReadOnly: boolean;
1608
+ listeners: AgendaViewListeners;
1609
+ listRangeMenu: RangeMenuConfig | null;
1610
+ loadMask: string | MaskConfig | null;
1611
+ loadMaskDefaults: MaskConfig;
1612
+ loadMaskError: MaskConfig | Mask | boolean;
1613
+ localizable: boolean;
1614
+ maskDefaults: MaskConfig;
1615
+ masked: boolean | string | MaskConfig;
1616
+ monitorResize: boolean;
1617
+ owner: Widget | any;
1618
+ plugins: Function[];
1619
+ preserveFocusOnDatasetChange: boolean;
1620
+ preserveScrollOnDatasetChange: boolean;
1621
+ preventTooltipOnTouch: boolean;
1622
+ relayStoreEvents: boolean;
1623
+ resizable: boolean | {
1624
+ minWidth?: number;
1625
+ maxWidth?: number;
1626
+ minHeight?: number;
1627
+ maxHeight?: number;
1628
+ handles?: object;
1629
+ };
1630
+ resizeToFitIncludesHeader: boolean;
1631
+ resourceImagePath: string;
1632
+ responsive: object;
1633
+ responsiveLevels: Record<string, number | string | ResponsiveLevelConfig>;
1634
+ responsiveRoot: boolean;
1635
+ responsiveState: string;
1636
+ responsiveTarget: string | Widget;
1637
+ ripple: boolean | {
1638
+ delegate?: string;
1639
+ color?: string;
1640
+ radius?: number;
1641
+ clip?: string;
1642
+ };
1643
+ rootElement: ShadowRoot | HTMLElement;
1644
+ scrollerClass: typeof Scroller;
1645
+ scrollManager: ScrollManagerConfig | ScrollManager;
1646
+ selectorButton: ButtonConfig;
1647
+ selectorMenuItem: MenuItemConfig;
1648
+ shortEventCls: string;
1649
+ shortEventDuration: string | number;
1650
+ showBullet: boolean | {
1651
+ bar?: boolean;
1652
+ noBar?: boolean;
1653
+ };
1654
+ showDirty: boolean | {
1655
+ duringEdit?: boolean;
1656
+ newRecord?: boolean;
1657
+ };
1658
+ showResourceAvatars: boolean | string;
1659
+ startDate: Date;
1660
+ stateful: boolean | object | string[];
1661
+ statefulEvents: object | string[];
1662
+ stateId: string;
1663
+ stateProvider: StateProvider;
1664
+ strips: Record<string, CalendarContainerItemConfig>;
1665
+ subGridConfigs: Record<string, SubGridConfig>;
1666
+ syncMask: string | MaskConfig | null;
1667
+ tab: boolean | TabConfig;
1668
+ tabBarItems: ToolbarItems[] | Widget[];
1669
+ tbar: (CalendarContainerItemConfig | string)[] | ToolbarConfig | PagingToolbarConfig | null;
1670
+ timeFormat: string | ((date: Date) => string);
1671
+ type: 'agendaview' | 'agenda';
1672
+ ui: 'plain' | 'toolbar' | string | object;
1673
+ weekStartDay: number;
1674
+ weight: number;
1675
+ alignSelf: string;
1676
+ allowDragCreate: boolean;
1677
+ allowDragMove: boolean;
1678
+ allowDragResize: boolean;
1679
+ alwaysShowCurrentDate: boolean;
1680
+ animateTimeShift: boolean;
1681
+ animateTreeNodeToggle: boolean;
1682
+ appendTo: HTMLElement | string;
1683
+ autoCreate: {
1684
+ gesture?: string;
1685
+ newName?: Function | string;
1686
+ step?: string;
1687
+ snapType?: 'round' | 'ceil' | 'floor';
1688
+ duration?: string;
1689
+ startHour?: number;
1690
+ } | string | boolean;
1691
+ callOnFunctions: boolean;
1692
+ catchEventHandlerExceptions: boolean;
1693
+ cellEllipsis: boolean;
1694
+ cls: string | object;
1695
+ collapsed: boolean;
1696
+ column: number;
1697
+ columnLines: boolean;
1698
+ columns: ColumnStore | CalendarColumnConfig[] | ColumnStoreConfig | object | object[] | ColumnStoreConfig[];
1699
+ data: object[] | Model[] | ModelConfig[];
1700
+ dataset: object | Record<string, string>;
1701
+ date: Date;
1702
+ dateFilter: ((context: DayCell) => boolean) | string;
1703
+ dateFormat: string | ((date: Date) => string);
1704
+ dateSeparator: string;
1705
+ defaultScrollOptions: BryntumScrollOptions;
1706
+ descriptionFormat: string | string[] | boolean[] | ((date: Date) => string) | Function[];
1707
+ disabled: boolean | 'inert';
1708
+ dragUnit: string;
1709
+ emptyText: string | EmptyTextDomConfig;
1710
+ enableUndoRedoKeys: boolean;
1711
+ eventTimeRenderer: ((eventRecord: EventModel, date: Date) => string | DomConfig | DomConfig[]) | string;
1712
+ extendAllDayEndDay: boolean;
1713
+ extraData: any;
1714
+ filterEventResources: boolean;
1715
+ fixedDuration: boolean;
1716
+ flex: number | string;
1717
+ height: number | string;
1718
+ hidden: boolean;
1719
+ hideFooters: boolean;
1720
+ hideHeaders: boolean;
1721
+ hideNonWorkingDays: boolean;
1722
+ id: string;
1723
+ inputFieldAlign: 'start' | 'end';
1724
+ insertBefore: HTMLElement | string;
1725
+ insertFirst: HTMLElement | string;
1726
+ keyMap: Record<string, KeyMapConfig>;
1727
+ labelPosition: 'before' | 'above' | 'align-before' | 'auto' | null;
1728
+ longPressTime: number;
1729
+ margin: number | string;
1730
+ maxDate: Date | string;
1731
+ maxHeight: string | number;
1732
+ maxWidth: string | number;
1733
+ minDate: Date | string;
1734
+ minHeight: string | number;
1735
+ minWidth: string | number;
1736
+ nonWorkingDays: Record<number, boolean>;
1737
+ offsetStartsBeforeEvents: boolean;
1738
+ pastEventCls: string;
1739
+ preserveScroll: PreserveScrollOptions | boolean;
1740
+ range: string | DurationConfig;
1741
+ readOnly: boolean;
1742
+ rendition: string | Record<string, string> | null;
1743
+ rowHeight: number;
1744
+ rowLines: boolean;
1745
+ rtl: boolean;
1746
+ scrollable: Scroller | boolean | ScrollerConfig;
1747
+ selectionMode: GridSelectionMode;
1748
+ settingsButton: ButtonConfig | Button;
1749
+ shiftIncrement: string | DurationConfig;
1750
+ shortDateFormat: string | ((date: Date) => string);
1751
+ shortDateTimeFormat: string | ((date: Date) => string);
1752
+ showAllDates: boolean;
1753
+ showEmptyDates: boolean;
1754
+ span: number;
1755
+ stackMultiDayEvents: boolean;
1756
+ stateSettings: {
1757
+ restoreUnconfiguredColumns?: boolean;
1758
+ };
1759
+ store: Store | StoreConfig | AjaxStore | AjaxStoreConfig;
1760
+ syncCalendarDate: boolean;
1761
+ syncViewDate: boolean;
1762
+ title: string;
1763
+ tools: Record<string, Tool | ToolConfig> | null | Record<string, Tool> | Record<string, ToolConfig>;
1764
+ transition: {
1765
+ insertRecord?: boolean;
1766
+ removeRecord?: boolean;
1767
+ toggleColumn?: boolean;
1768
+ expandCollapseColumn?: boolean;
1769
+ toggleRegion?: boolean;
1770
+ toggleTreeNode?: boolean;
1771
+ toggleGroup?: boolean;
1772
+ filterRemoval?: boolean;
1773
+ };
1774
+ transitionDuration: number;
1775
+ width: number | string;
1776
+ dayCellCls: string;
1777
+ firstVisibleCell: HTMLElement;
1778
+ firstVisibleDate: Date;
1779
+ focusVisible: boolean;
1780
+ hasChanges: boolean;
1781
+ lastVisibleCell: HTMLElement;
1782
+ lastVisibleDate: Date;
1783
+ originalStore: Store;
1784
+ parent: Widget;
1785
+ selectedCell: GridLocation | GridLocationConfig;
1786
+ selectedCells: GridLocation[] | GridLocationConfig[];
1787
+ selectedRecord: Model;
1788
+ selectedRecords: Model[] | number[];
1789
+ selectedRows: Model[] | number[];
1790
+ state: GridStateInfo;
1791
+ tooltip: string | TooltipConfig;
1792
+ aiFilterFeature: object | boolean | string | AIFilter | AIFilterConfig;
1793
+ cellCopyPasteFeature: object | boolean | string | CellCopyPaste | CellCopyPasteConfig;
1794
+ cellEditFeature: object | boolean | string | CellEdit | CellEditConfig;
1795
+ cellMenuFeature: object | boolean | string | CellMenu | CellMenuConfig;
1796
+ cellTooltipFeature: object | boolean | string | CellTooltip | CellTooltipConfig;
1797
+ chartsFeature: object | boolean | string | Charts | ChartsConfig;
1798
+ columnAutoWidthFeature: object | boolean | string | ColumnAutoWidth | ColumnAutoWidthConfig;
1799
+ columnDragToolbarFeature: object | boolean | string | ColumnDragToolbar | ColumnDragToolbarConfig;
1800
+ columnPickerFeature: object | boolean | string | ColumnPicker | ColumnPickerConfig;
1801
+ columnRenameFeature: object | boolean | string | ColumnRename | ColumnRenameConfig;
1802
+ columnReorderFeature: object | boolean | string | ColumnReorder | ColumnReorderConfig;
1803
+ columnResizeFeature: object | boolean | string | ColumnResize | ColumnResizeConfig;
1804
+ excelExporterFeature: object | boolean | string | GridExcelExporter | GridExcelExporterConfig;
1805
+ fileDropFeature: object | boolean | string | FileDrop | FileDropConfig;
1806
+ fillHandleFeature: object | boolean | string | FillHandle | FillHandleConfig;
1807
+ filterFeature: object | boolean | string | Filter | FilterConfig;
1808
+ filterBarFeature: object | boolean | string | FilterBar | FilterBarConfig;
1809
+ groupFeature: object | boolean | string | Group | GroupConfig;
1810
+ groupSummaryFeature: object | boolean | string | GridGroupSummary | GridGroupSummaryConfig;
1811
+ headerMenuFeature: object | boolean | string | HeaderMenu | HeaderMenuConfig;
1812
+ lockRowsFeature: object | boolean | string | GridLockRows | GridLockRowsConfig;
1813
+ mergeCellsFeature: object | boolean | string | MergeCells | MergeCellsConfig;
1814
+ pdfExportFeature: object | boolean | string | GridPdfExport | GridPdfExportConfig;
1815
+ pinColumnsFeature: object | boolean | string | PinColumns | PinColumnsConfig;
1816
+ printFeature: object | boolean | string | GridPrint | GridPrintConfig;
1817
+ quickFindFeature: object | boolean | string | QuickFind | QuickFindConfig;
1818
+ regionResizeFeature: object | boolean | string | RegionResize | RegionResizeConfig;
1819
+ rowCopyPasteFeature: object | boolean | string | RowCopyPaste | RowCopyPasteConfig;
1820
+ rowEditFeature: object | boolean | string | RowEdit | RowEditConfig;
1821
+ rowExpanderFeature: object | boolean | string | RowExpander | RowExpanderConfig;
1822
+ rowReorderFeature: object | boolean | string | GridRowReorder | GridRowReorderConfig;
1823
+ rowResizeFeature: object | boolean | string | GridRowResize | GridRowResizeConfig;
1824
+ searchFeature: object | boolean | string | Search | SearchConfig;
1825
+ sortFeature: object | boolean | string | Sort | SortConfig;
1826
+ splitFeature: object | boolean | string | GridSplit | GridSplitConfig;
1827
+ stickyCellsFeature: object | boolean | string | StickyCells | StickyCellsConfig;
1828
+ stripeFeature: object | boolean | string | Stripe | StripeConfig;
1829
+ summaryFeature: object | boolean | string | GridSummary | GridSummaryConfig;
1830
+ treeFeature: object | boolean | string | Tree | TreeConfig;
1831
+ treeGroupFeature: object | boolean | string | TreeGroup | TreeGroupConfig;
1832
+ /**
1833
+ * This event fires whenever the [autoCreate gesture](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/CalendarMixin#config-autoCreate) is detected
1834
+ * and also when a [drag-create](https://bryntum.com/products/calendar/docs/api/Calendar/feature/CalendarDrag) gesture is detected.
1835
+ * ...
1836
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#event-beforeAutoCreate)
1837
+ * @param {object} event Event object
1838
+ * @param {Event} event.domEvent The DOM event which initiated the creation.
1839
+ * @param {Date} event.date *DEPRECATED in favour of `startDate`.* The starting time of the event to be created. If this is in a `DayView`, this will be snapped according to the specification in [autoCreate](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/CalendarMixin#config-autoCreate)
1840
+ * @param {Date} event.startDate The starting time of the event to be created. If this is in a `DayView`, this will be snapped according to the specification in [autoCreate](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/CalendarMixin#config-autoCreate)
1841
+ * @param {Date} event.endDate The ending time of the event to be created.
1842
+ * @param {Scheduler.model.ResourceModel} event.resourceRecord The resource if the UI includes a resource.
1843
+ * @param {CalendarView} event.view This view.
1844
+ */
1845
+ onBeforeAutoCreate: any;
1846
+ /**
1847
+ * Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
1848
+ * @param {object} event Event object
1849
+ * @param {Grid.view.Grid} event.source Owner grid
1850
+ * @param {Grid.util.GridLocation} event.editorContext Editing context
1851
+ */
1852
+ onBeforeCancelCellEdit: any;
1853
+ /**
1854
+ * 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.
1855
+ * ...
1856
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#event-beforeCancelRowEdit)
1857
+ * @param {object} event Event object
1858
+ * @param {Grid.view.Grid} event.grid Target grid
1859
+ * @param {RowEditorContext} event.editorContext Editing context
1860
+ */
1861
+ onBeforeCancelRowEdit: any;
1862
+ /**
1863
+ * Fires on the owning Grid before editing starts, return `false` to prevent editing
1864
+ * @param {object} event Event object
1865
+ * @param {Grid.view.Grid} event.source Owner grid
1866
+ * @param {CellEditorContext} event.editorContext Editing context
1867
+ */
1868
+ onBeforeCellEditStart: any;
1869
+ /**
1870
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
1871
+ * buttons while [autoEdit](https://bryntum.com/products/calendar/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
1872
+ * @param {object} event Event object
1873
+ * @param {Grid.view.Grid} event.source Owner grid
1874
+ * @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).
1875
+ */
1876
+ onBeforeCellRangeDelete: any;
1877
+ /**
1878
+ * Fires for each selected record on the owning Grid before editing a range of selected cell values
1879
+ * @param {object} event Event object
1880
+ * @param {Core.data.Model} event.record Current selected record from the range
1881
+ * @param {string} event.field The field being changed
1882
+ * @param {any} event.value The value being set
1883
+ */
1884
+ onBeforeCellRangeEdit: any;
1885
+ /**
1886
+ * Triggered before a view's orientating date changes.
1887
+ * ...
1888
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#event-beforeChangeDate)
1889
+ * @param {object} event Event object
1890
+ * @param {Date} event.oldDate The current orientating date of this view.
1891
+ * @param {Date} event.date The new date to which this view is to be orientated.
1892
+ */
1893
+ onBeforeChangeDate: any;
1894
+ /**
1895
+ * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
1896
+ * @param {object} event Event object
1897
+ * @param {Grid.view.Grid} event.source The grid instance.
1898
+ * @param {Grid.column.Column} event.column The dragged column.
1899
+ * @param {Event} event.event The browser event.
1900
+ */
1901
+ onBeforeColumnDragStart: any;
1902
+ /**
1903
+ * This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
1904
+ * @param {object} event Event object
1905
+ * @param {Grid.view.Grid} event.source The grid instance.
1906
+ * @param {Grid.column.Column} event.column The dragged column.
1907
+ * @param {Grid.column.Column} event.insertBefore The column before which the dragged column will be inserted.
1908
+ * @param {Grid.column.Column} event.newParent The new parent column.
1909
+ * @param {Event} event.event The browser event.
1910
+ * @param {string} event.region The region where the column was dropped.
1911
+ */
1912
+ onBeforeColumnDropFinalize: any;
1913
+ /**
1914
+ * This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
1915
+ * `false`.
1916
+ * @param {object} event Event object
1917
+ * @param {Grid.view.Grid} event.source The grid instance
1918
+ * @param {Grid.column.Column} event.column The column
1919
+ * @param {Event} event.domEvent The browser event
1920
+ */
1921
+ onBeforeColumnResize: any;
1922
+ /**
1923
+ * Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
1924
+ * @param {object} event Event object
1925
+ * @param {Grid.view.Grid} event.source Owner grid
1926
+ * @param {Grid.util.GridLocation[]} event.cells The cells about to be copied or cut
1927
+ * @param {string} event.data The string data about to be copied or cut
1928
+ * @param {boolean} event.isCut `true` if this is a cut action
1929
+ * @param {string} event.entityName 'cell' to distinguish this event from other beforeCopy events
1930
+ */
1931
+ onBeforeCopy: any;
1932
+ /**
1933
+ * Fires on the owning Grid before CSV export starts. Return `false` to cancel the export.
1934
+ * @param {object} event Event object
1935
+ * @param {ExportConfig} event.config Export config
1936
+ * @param {Grid.column.Column[]} event.columns An array of columns to export
1937
+ * @param {Core.data.Model[]} event.rows An array of records to export
1938
+ * @param {string} event.lineDelimiter The CSV delimiter to separate lines
1939
+ * @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
1940
+ */
1941
+ onBeforeCSVExport: any;
1942
+ /**
1943
+ * Fires before an object is destroyed.
1944
+ * @param {object} event Event object
1945
+ * @param {Core.Base} event.source The Object that is being destroyed.
1946
+ */
1947
+ onBeforeDestroy: any;
1948
+ /**
1949
+ * Fires on the owning Grid before Excel export starts. Return `false` to cancel the export.
1950
+ * @param {object} event Event object
1951
+ * @param {ExportConfig} event.config Export config
1952
+ * @param {XLSColumn[]} event.columns An array of columns to export
1953
+ * @param {any[][]} event.rows An array of records to export
1954
+ */
1955
+ onBeforeExcelExport: any;
1956
+ /**
1957
+ * Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
1958
+ * @param {object} event Event object
1959
+ * @param {Grid.util.GridLocation} event.cell Information about the column / record
1960
+ * @param {MouseEvent} event.domEvent The raw DOM event
1961
+ */
1962
+ onBeforeFillHandleDragStart: any;
1963
+ /**
1964
+ * 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.
1965
+ * @param {object} event Event object
1966
+ * @param {Grid.view.Grid} event.grid Target grid
1967
+ * @param {CellEditorContext} event.editorContext Editing context
1968
+ */
1969
+ onBeforeFinishCellEdit: any;
1970
+ /**
1971
+ * 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.
1972
+ * ...
1973
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#event-beforeFinishRowEdit)
1974
+ * @param {object} event Event object
1975
+ * @param {Grid.view.Grid} event.grid Target grid
1976
+ * @param {RowEditorContext} event.editorContext Editing context
1977
+ */
1978
+ onBeforeFinishRowEdit: any;
1979
+ /**
1980
+ * Triggered before a widget is hidden. Return `false` to prevent the action.
1981
+ * @param {object} event Event object
1982
+ * @param {Core.widget.Widget} event.source The widget being hidden.
1983
+ */
1984
+ onBeforeHide: any;
1985
+ /**
1986
+ * Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
1987
+ * @param {object} event Event object
1988
+ * @param {Grid.view.Grid} event.source Owner grid
1989
+ * @param {string} event.clipboardData The clipboardData about to be pasted
1990
+ * @param {Grid.util.GridLocation} event.targetCell The cell from which the paste will be started
1991
+ * @param {string} event.entityName 'cell' to distinguish this event from other beforePaste events
1992
+ * @param {string} event.text The raw text from clipboard
1993
+ */
1994
+ onBeforePaste: any;
1995
+ /**
1996
+ * Fires on the owning Grid before export started. Return `false` to cancel the export.
1997
+ * @param {object} event Event object
1998
+ * @param {object} event.config Export config
1999
+ */
2000
+ onBeforePdfExport: any;
2001
+ /**
2002
+ * Fires before a row is rendered.
2003
+ * @param {object} event Event object
2004
+ * @param {Grid.view.Grid} event.source The firing Grid instance.
2005
+ * @param {Grid.row.Row} event.row The row about to be rendered.
2006
+ * @param {Core.data.Model} event.record The record for the row.
2007
+ * @param {number} event.recordIndex The zero-based index of the record.
2008
+ */
2009
+ onBeforeRenderRow: any;
2010
+ /**
2011
+ * Grid rows are about to be rendered
2012
+ * @param {object} event Event object
2013
+ * @param {Grid.view.Grid} event.source This grid.
2014
+ */
2015
+ onBeforeRenderRows: any;
2016
+ /**
2017
+ * Triggered before a new [responsiveState](https://bryntum.com/products/calendar/docs/api/Core/widget/mixin/Responsive#config-responsiveState) is applied.
2018
+ * @param {object} event Event object
2019
+ * @param {Core.widget.Widget} event.source The widget whose `responsiveState` is to be changed
2020
+ * @param {string} event.state The new value for the widget's `responsiveState`
2021
+ * @param {string} event.oldState The previous value for the widget's `responsiveState`
2022
+ */
2023
+ onBeforeResponsiveStateChange: any;
2024
+ /**
2025
+ * This event fires before row collapse is started.
2026
+ * ...
2027
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#event-beforeRowCollapse)
2028
+ * @param {object} event Event object
2029
+ * @param {Core.data.Model} event.record Record
2030
+ */
2031
+ onBeforeRowCollapse: any;
2032
+ /**
2033
+ * This event fires before row expand is started.
2034
+ * ...
2035
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#event-beforeRowExpand)
2036
+ * @param {object} event Event object
2037
+ * @param {Core.data.Model} event.record Record
2038
+ */
2039
+ onBeforeRowExpand: any;
2040
+ /**
2041
+ * Fires before the selection changes. Returning `false` from a listener prevents the change
2042
+ * @param {object} event Event object
2043
+ * @param {string} event.action `'select'`/`'deselect'`
2044
+ * @param {'row','cell'} event.mode `'row'`/`'cell'`
2045
+ * @param {Grid.view.Grid} event.source
2046
+ * @param {Core.data.Model[]} event.deselected The records to be deselected in this operation.
2047
+ * @param {Core.data.Model[]} event.selected The records to be selected in this operation.
2048
+ * @param {Core.data.Model[]} event.selection The records in the current selection, before applying `selected` and `deselected`
2049
+ * @param {Grid.util.GridLocation[]} event.deselectedCells The cells to be deselected in this operation.
2050
+ * @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
2051
+ * @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
2052
+ */
2053
+ onBeforeSelectionChange: any;
2054
+ /**
2055
+ * Fired before this container will load record values into its child fields. This is useful if you
2056
+ * want to modify the UI before data is loaded (e.g. set some input field to be readonly)
2057
+ * @param {object} event Event object
2058
+ * @param {Core.widget.Container} event.source The container
2059
+ * @param {Core.data.Model} event.record The record
2060
+ */
2061
+ onBeforeSetRecord: any;
2062
+ /**
2063
+ * Triggered before a widget is shown. Return `false` to prevent the action.
2064
+ * @param {object} event Event object
2065
+ * @param {Core.widget.Widget,any} event.source The widget being shown
2066
+ */
2067
+ onBeforeShow: any;
2068
+ /**
2069
+ * Fires on the owning Grid before editing starts, return `false` to prevent editing
2070
+ * @param {object} event Event object
2071
+ * @param {Grid.view.Grid} event.source Owner grid
2072
+ * @param {RowEditorContext} event.editorContext Editing context
2073
+ */
2074
+ onBeforeStartRowEdit: any;
2075
+ /**
2076
+ * Fired before state is applied to the source. Allows editing the state object or preventing the operation.
2077
+ * @param {object} event Event object
2078
+ * @param {GridStateInfo} event.state State object config
2079
+ */
2080
+ onBeforeStateApply: any;
2081
+ /**
2082
+ * Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
2083
+ * @param {object} event Event object
2084
+ * @param {GridStateInfo} event.state State object config
2085
+ */
2086
+ onBeforeStateSave: any;
2087
+ /**
2088
+ * Fired when a group is going to be expanded or collapsed using the UI.
2089
+ * Returning `false` from a listener prevents the operation
2090
+ * @param {object} event Event object
2091
+ * @param {Core.data.Model} event.groupRecord [DEPRECATED] Use `groupRecords` param instead
2092
+ * @param {Core.data.Model[]} event.groupRecords The group records being toggled
2093
+ * @param {boolean} event.collapse Collapsed (true) or expanded (false)
2094
+ * @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
2095
+ */
2096
+ onBeforeToggleGroup: any;
2097
+ /**
2098
+ * Fired before a parent node record toggles its collapsed state.
2099
+ * @param {object} event Event object
2100
+ * @param {Grid.view.Grid} event.source The firing Grid instance.
2101
+ * @param {Core.data.Model} event.record The record being toggled.
2102
+ * @param {boolean} event.collapse `true` if the node is being collapsed.
2103
+ */
2104
+ onBeforeToggleNode: any;
2105
+ /**
2106
+ * Fires on the owning Grid when editing is cancelled
2107
+ * @param {object} event Event object
2108
+ * @param {Grid.view.Grid} event.source Owner grid
2109
+ * @param {Grid.util.GridLocation} event.editorContext Editing context
2110
+ * @param {Event} event.event Included if the cancellation was triggered by a DOM event
2111
+ */
2112
+ onCancelCellEdit: any;
2113
+ /**
2114
+ * Fires when any other event is fired from the object.
2115
+ * ...
2116
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#event-catchAll)
2117
+ * @param {object} event Event object
2118
+ * @param {{[key: string]: any, type: string}} event.event The Object that contains event details
2119
+ * @param {string} event.event.type The type of the event which is caught by the listener
2120
+ */
2121
+ onCatchAll: any;
2122
+ /**
2123
+ * Fired when user clicks in a grid cell
2124
+ * @param {object} event Event object
2125
+ * @param {Grid.view.Grid} event.grid The grid instance
2126
+ * @param {Core.data.Model} event.record The record representing the row
2127
+ * @param {Grid.column.Column} event.column The column to which the cell belongs
2128
+ * @param {HTMLElement} event.cellElement The cell HTML element
2129
+ * @param {HTMLElement} event.target The target element
2130
+ * @param {MouseEvent} event.event The native DOM event
2131
+ */
2132
+ onCellClick: any;
2133
+ /**
2134
+ * Fired when user activates contextmenu in a grid cell
2135
+ * @param {object} event Event object
2136
+ * @param {Grid.view.Grid} event.grid The grid instance
2137
+ * @param {Core.data.Model} event.record The record representing the row
2138
+ * @param {Grid.column.Column} event.column The column to which the cell belongs
2139
+ * @param {HTMLElement} event.cellElement The cell HTML element
2140
+ * @param {HTMLElement} event.target The target element
2141
+ * @param {MouseEvent} event.event The native DOM event
2142
+ */
2143
+ onCellContextMenu: any;
2144
+ /**
2145
+ * Fired when user double clicks a grid cell
2146
+ * @param {object} event Event object
2147
+ * @param {Grid.view.Grid} event.grid The grid instance
2148
+ * @param {Core.data.Model} event.record The record representing the row
2149
+ * @param {Grid.column.Column} event.column The column to which the cell belongs
2150
+ * @param {HTMLElement} event.cellElement The cell HTML element
2151
+ * @param {HTMLElement} event.target The target element
2152
+ * @param {MouseEvent} event.event The native DOM event
2153
+ */
2154
+ onCellDblClick: any;
2155
+ /**
2156
+ * Fired when a new set of events has been gathered for this view's date range.
2157
+ * @param {object} event Event object
2158
+ * @param {Map<any, any>} event.cellMap The map of date keys to [day cell](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/DayCellCollecter#typedef-DayCell) data blocks.
2159
+ */
2160
+ onCellMapPopulated: any;
2161
+ /**
2162
+ * This event fires on the owning grid before the context menu is shown for a cell.
2163
+ * Allows manipulation of the items to show in the same way as in the [processItems](https://bryntum.com/products/calendar/docs/api/Grid/feature/CellMenu#config-processItems).
2164
+ * ...
2165
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#event-cellMenuBeforeShow)
2166
+ * @param {object} event Event object
2167
+ * @param {Grid.view.Grid} event.source The grid
2168
+ * @param {Core.widget.Menu} event.menu The menu
2169
+ * @param {Record<string, MenuItemEntry>} event.items Menu item configs
2170
+ * @param {Grid.column.Column} event.column Column
2171
+ * @param {Core.data.Model} event.record Record
2172
+ */
2173
+ onCellMenuBeforeShow: any;
2174
+ /**
2175
+ * This event fires on the owning grid when an item is selected in the cell context menu.
2176
+ * @param {object} event Event object
2177
+ * @param {Grid.view.Grid} event.source The grid
2178
+ * @param {Core.widget.Menu} event.menu The menu
2179
+ * @param {Core.widget.MenuItem} event.item Selected menu item
2180
+ * @param {Grid.column.Column} event.column Column
2181
+ * @param {Core.data.Model} event.record Record
2182
+ */
2183
+ onCellMenuItem: any;
2184
+ /**
2185
+ * This event fires on the owning grid after the context menu is shown for a cell.
2186
+ * @param {object} event Event object
2187
+ * @param {Grid.view.Grid} event.source The grid
2188
+ * @param {Core.widget.Menu} event.menu The menu
2189
+ * @param {Record<string, MenuItemEntry>} event.items Menu item configs
2190
+ * @param {Grid.column.Column} event.column Column
2191
+ * @param {Core.data.Model} event.record Record
2192
+ */
2193
+ onCellMenuShow: any;
2194
+ /**
2195
+ * This event fires on the owning grid when a check item is toggled in the cell context menu.
2196
+ * @param {object} event Event object
2197
+ * @param {Grid.view.Grid} event.source The grid
2198
+ * @param {Core.widget.Menu} event.menu The menu
2199
+ * @param {Core.widget.MenuItem} event.item Selected menu item
2200
+ * @param {Grid.column.Column} event.column Column
2201
+ * @param {Core.data.Model} event.record Record
2202
+ * @param {boolean} event.checked Checked or not
2203
+ */
2204
+ onCellMenuToggleItem: any;
2205
+ /**
2206
+ * Fired when the mouse enters a cell
2207
+ * @param {object} event Event object
2208
+ * @param {Grid.view.Grid} event.source The grid instance
2209
+ * @param {Core.data.Model} event.record The record representing the hovered cell
2210
+ * @param {Grid.column.Column} event.column The column currently hovered
2211
+ * @param {HTMLElement} event.cellElement The cell HTML element
2212
+ * @param {MouseEvent} event.event The native DOM event
2213
+ */
2214
+ onCellMouseEnter: any;
2215
+ /**
2216
+ * Fired when the mouse leaves a cell
2217
+ * @param {object} event Event object
2218
+ * @param {Grid.view.Grid} event.source The grid instance
2219
+ * @param {Core.data.Model} event.record The record representing the cell that the mouse left
2220
+ * @param {Grid.column.Column} event.column The column representing the cell that the mouse left
2221
+ * @param {HTMLElement} event.cellElement The cell HTML element that the mouse left
2222
+ * @param {MouseEvent} event.event The native DOM event
2223
+ */
2224
+ onCellMouseLeave: any;
2225
+ /**
2226
+ * Fired when a user moves the mouse out of a grid cell
2227
+ * @param {object} event Event object
2228
+ * @param {Grid.view.Grid} event.grid The grid instance
2229
+ * @param {Core.data.Model} event.record The record representing the row
2230
+ * @param {Grid.column.Column} event.column The column to which the cell belongs
2231
+ * @param {HTMLElement} event.cellElement The cell HTML element
2232
+ * @param {HTMLElement} event.target The target element
2233
+ * @param {MouseEvent} event.event The native DOM event
2234
+ */
2235
+ onCellMouseOut: any;
2236
+ /**
2237
+ * Fired when user moves the mouse over a grid cell
2238
+ * @param {object} event Event object
2239
+ * @param {Grid.view.Grid} event.grid The grid instance
2240
+ * @param {Core.data.Model} event.record The record representing the row
2241
+ * @param {Grid.column.Column} event.column The column to which the cell belongs
2242
+ * @param {HTMLElement} event.cellElement The cell HTML element
2243
+ * @param {HTMLElement} event.target The target element
2244
+ * @param {MouseEvent} event.event The native DOM event
2245
+ */
2246
+ onCellMouseOver: any;
2247
+ /**
2248
+ * Fires when a Panel is collapsed using the [collapsible](https://bryntum.com/products/calendar/docs/api/Core/widget/Panel#config-collapsible) setting.
2249
+ * @param {object} event Event object
2250
+ * @param {Core.widget.Panel} event.source This Panel.
2251
+ */
2252
+ onCollapse: any;
2253
+ /**
2254
+ * Fired before a parent node record is collapsed.
2255
+ * @param {object} event Event object
2256
+ * @param {Grid.view.Grid} event.source The firing Grid instance.
2257
+ * @param {Core.data.Model} event.record The record which has been collapsed.
2258
+ */
2259
+ onCollapseNode: any;
2260
+ /**
2261
+ * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
2262
+ * to indicate whether the drop position is valid or not.
2263
+ * @param {object} event Event object
2264
+ * @param {Grid.view.Grid} event.source The grid instance.
2265
+ * @param {Grid.column.Column} event.column The dragged column.
2266
+ * @param {Grid.column.Column} event.insertBefore The column before which the dragged column will be inserted (if not last).
2267
+ * @param {Event} event.event The browser event.
2268
+ * @param {object} event.context
2269
+ * @param {boolean} event.context.valid Set this to `true` or `false` to indicate whether the drop position is valid.
2270
+ */
2271
+ onColumnDrag: any;
2272
+ /**
2273
+ * This event is fired when a column drag gesture has started.
2274
+ * @param {object} event Event object
2275
+ * @param {Grid.view.Grid} event.source The grid instance.
2276
+ * @param {Grid.column.Column} event.column The dragged column.
2277
+ * @param {Event} event.event The browser event.
2278
+ */
2279
+ onColumnDragStart: any;
2280
+ /**
2281
+ * This event is always fired after a column is dropped. The `valid` param is `true` if the operation was not
2282
+ * vetoed and the column was moved in the column store.
2283
+ * @param {object} event Event object
2284
+ * @param {Grid.view.Grid} event.source The grid instance.
2285
+ * @param {Grid.column.Column} event.column The dragged column.
2286
+ * @param {Grid.column.Column} event.insertBefore The column before which the dragged column will be inserted.
2287
+ * @param {Grid.column.Column} event.newParent The new parent column.
2288
+ * @param {boolean} event.valid `true` if the operation was not vetoed.
2289
+ * @param {Event} event.event The browser event.
2290
+ * @param {string} event.region The region where the column was dropped.
2291
+ */
2292
+ onColumnDrop: any;
2293
+ /**
2294
+ * This event is fired after a resize gesture is completed.
2295
+ * @param {object} event Event object
2296
+ * @param {Grid.view.Grid} event.source The grid instance
2297
+ * @param {Grid.column.Column} event.column The resized column
2298
+ * @param {Event} event.domEvent The browser event
2299
+ */
2300
+ onColumnResize: any;
2301
+ /**
2302
+ * This event is fired when a column resize gesture starts.
2303
+ * @param {object} event Event object
2304
+ * @param {Grid.view.Grid} event.source The grid instance
2305
+ * @param {Grid.column.Column} event.column The column
2306
+ * @param {Event} event.domEvent The browser event
2307
+ */
2308
+ onColumnResizeStart: any;
2309
+ /**
2310
+ * This event fires on the owning widget when an item is selected in the context menu.
2311
+ * @param {object} event Event object
2312
+ * @param {Core.widget.Widget} event.source The owning widget
2313
+ * @param {Core.widget.Menu} event.menu The menu
2314
+ * @param {Core.widget.MenuItem} event.item Selected menu item
2315
+ */
2316
+ onContextMenuItem: any;
2317
+ /**
2318
+ * This event fires on the owning widget when a check item is toggled in the context menu.
2319
+ * @param {object} event Event object
2320
+ * @param {Core.widget.Widget} event.source The owning widget
2321
+ * @param {Core.widget.Menu} event.menu The menu
2322
+ * @param {Core.widget.MenuItem} event.item Selected menu item
2323
+ * @param {boolean} event.checked Checked or not
2324
+ */
2325
+ onContextMenuToggleItem: any;
2326
+ /**
2327
+ * Fires on the owning Grid after a copy action is performed.
2328
+ * @param {object} event Event object
2329
+ * @param {Grid.view.Grid} event.source Owner grid
2330
+ * @param {Grid.util.GridLocation[]} event.cells The cells about to be copied or cut
2331
+ * @param {string} event.copiedDataString The concatenated data string that was copied or cut
2332
+ * @param {boolean} event.isCut `true` if this was a cut action
2333
+ * @param {string} event.entityName 'cell' to distinguish this event from other copy events
2334
+ */
2335
+ onCopy: any;
2336
+ /**
2337
+ * Fired when data in the store changes.
2338
+ * ...
2339
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#event-dataChange)
2340
+ * @param {object} event Event object
2341
+ * @param {Grid.view.Grid} event.source Owning grid
2342
+ * @param {Core.data.Store} event.store The originating store
2343
+ * @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'`
2344
+ * @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
2345
+ * @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
2346
+ * @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
2347
+ */
2348
+ onDataChange: any;
2349
+ /**
2350
+ * Fired after one day cell's events are collected in sorted order according to the
2351
+ * [eventSorter](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/CalendarMixin#config-eventSorter)
2352
+ * ...
2353
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#event-dayCellPopulated)
2354
+ * @param {object} event Event object
2355
+ * @param {Scheduler.model.EventModel[]} event.events The events to be shown for the passed date
2356
+ * @param {Date} event.The date the events are to be shown in.
2357
+ */
2358
+ onDayCellPopulated: any;
2359
+ /**
2360
+ * Fires when an object is destroyed.
2361
+ * @param {object} event Event object
2362
+ * @param {Core.Base} event.source The Object that is being destroyed.
2363
+ */
2364
+ onDestroy: any;
2365
+ /**
2366
+ * Fires when a field is mutated and the state of the [hasChanges](https://bryntum.com/products/calendar/docs/api/Core/widget/Container#property-hasChanges) property changes
2367
+ * @param {object} event Event object
2368
+ * @param {Core.widget.Container} event.source The container.
2369
+ * @param {boolean} event.dirty The dirty state of the Container - `true` if there are any fields which have been changed since initial load.
2370
+ */
2371
+ onDirtyStateChange: any;
2372
+ /**
2373
+ * Fires while drag selecting. UI will update with current range, but the cells will not be selected until
2374
+ * mouse up. This event can be listened for to perform actions while drag selecting.
2375
+ * @param {object} event Event object
2376
+ * @param {Grid.view.Grid} event.source
2377
+ * @param {GridLocationConfig[],Grid.util.GridLocation[]} event.selectedCells The cells that is currently being dragged over
2378
+ * @param {Core.data.Model[]} event.selectedRecords The records that is currently being dragged over
2379
+ */
2380
+ onDragSelecting: any;
2381
+ /**
2382
+ * Triggered when a widget's [element](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#property-element) is available.
2383
+ * @param {object} event Event object
2384
+ * @param {HTMLElement} event.element The Widget's element.
2385
+ */
2386
+ onElementCreated: any;
2387
+ /**
2388
+ * Fired when an [autoCreate](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/CalendarMixin#config-autoCreate) gesture has created a new event
2389
+ * and added it to the event store.
2390
+ * ...
2391
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#event-eventAutoCreated)
2392
+ * @param {object} event Event object
2393
+ * @param {CalendarView} event.source This Calendar view instance.
2394
+ * @param {Scheduler.model.EventModel} event.eventRecord The new event record.
2395
+ */
2396
+ onEventAutoCreated: any;
2397
+ /**
2398
+ * Fires when a day spanning event is found, and the date to which its encapsulating event bar
2399
+ * extends has been calculated.
2400
+ * ...
2401
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#event-eventPropagate)
2402
+ * @param {object} event Event object
2403
+ * @param {Date} event.eventEndDate The end date for which to calculate the propagate end date.
2404
+ * @param {Date} event.propagateEndDate The system-calculated end point of the event bar.
2405
+ * @param {boolean} event.isAllDay `true` if the event is an all day event, or spans multiple days.
2406
+ * @param {boolean} event.isOverflow `true` if this is being called as part of further propagation.
2407
+ * @param {boolean} event.overflows `true` if the event extends into future cells.
2408
+ * @param {Scheduler.model.EventModel} event.eventRecord The event record being propagated.
2409
+ * @param {Date} event.date The date from which the event is being propagated.
2410
+ */
2411
+ onEventPropagate: any;
2412
+ /**
2413
+ * Fires when a Panel is expanded using the [collapsible](https://bryntum.com/products/calendar/docs/api/Core/widget/Panel#config-collapsible) setting.
2414
+ * @param {object} event Event object
2415
+ * @param {Core.widget.Panel} event.source This Panel.
2416
+ */
2417
+ onExpand: any;
2418
+ /**
2419
+ * Fired after a parent node record is expanded.
2420
+ * @param {object} event Event object
2421
+ * @param {Grid.view.Grid} event.source The firing Grid instance.
2422
+ * @param {Core.data.Model} event.record The record which has been expanded.
2423
+ */
2424
+ onExpandNode: any;
2425
+ /**
2426
+ * Fired when a file is dropped on the widget element
2427
+ * @param {object} event Event object
2428
+ * @param {Grid.view.Grid} event.source The owning Grid instance
2429
+ * @param {DataTransferItem} event.file The dropped file descriptor
2430
+ * @param {DragEvent} event.domEvent The native DragEvent
2431
+ */
2432
+ onFileDrop: any;
2433
+ /**
2434
+ * Fired before the FillHandle dragging is finalized and values are applied to cells, return `false` to prevent the
2435
+ * drag operation from applying data changes.
2436
+ * @param {object} event Event object
2437
+ * @param {Grid.util.GridLocation} event.from The from cell
2438
+ * @param {Grid.util.GridLocation} event.to The to cell
2439
+ * @param {MouseEvent} event.domEvent The raw DOM event
2440
+ */
2441
+ onFillHandleBeforeDragFinalize: any;
2442
+ /**
2443
+ * Fired while dragging the FillHandle.
2444
+ * @param {object} event Event object
2445
+ * @param {Grid.util.GridLocation} event.from The from cell
2446
+ * @param {Grid.util.GridLocation} event.to The to cell
2447
+ * @param {MouseEvent} event.domEvent The raw DOM event
2448
+ */
2449
+ onFillHandleDrag: any;
2450
+ /**
2451
+ * Fired when a FillHandle drag operation is aborted.
2452
+ */
2453
+ onFillHandleDragAbort: any;
2454
+ /**
2455
+ * Fired after a FillHandle drag operation.
2456
+ * @param {object} event Event object
2457
+ * @param {Grid.util.GridLocation} event.from The from cell
2458
+ * @param {Grid.util.GridLocation} event.to The to cell
2459
+ * @param {MouseEvent} event.domEvent The raw DOM event
2460
+ */
2461
+ onFillHandleDragEnd: any;
2462
+ /**
2463
+ * Fired when dragging of the FillHandle starts.
2464
+ * @param {object} event Event object
2465
+ * @param {Grid.util.GridLocation} event.cell Information about the column / record
2466
+ * @param {MouseEvent} event.domEvent The raw DOM event
2467
+ */
2468
+ onFillHandleDragStart: any;
2469
+ /**
2470
+ * Fires on the owning Grid when cell editing is finished
2471
+ * @param {object} event Event object
2472
+ * @param {Grid.view.Grid} event.grid Target grid
2473
+ * @param {CellEditorContext} event.editorContext Editing context
2474
+ */
2475
+ onFinishCellEdit: any;
2476
+ /**
2477
+ * 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.
2478
+ * ...
2479
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#event-finishRowEdit)
2480
+ * @param {object} event Event object
2481
+ * @param {Grid.view.Grid} event.grid Target grid
2482
+ * @param {RowEditorContext} event.editorContext Editing context
2483
+ */
2484
+ onFinishRowEdit: any;
2485
+ /**
2486
+ * Fired when focus enters this Widget.
2487
+ * @param {object} event Event object
2488
+ * @param {Core.widget.Widget} event.source This Widget
2489
+ * @param {HTMLElement} event.fromElement The element which lost focus.
2490
+ * @param {HTMLElement} event.toElement The element which gained focus.
2491
+ * @param {Core.widget.Widget} event.fromWidget The widget which lost focus.
2492
+ * @param {Core.widget.Widget} event.toWidget The widget which gained focus.
2493
+ * @param {boolean} event.backwards `true` if the `toElement` is before the `fromElement` in document order.
2494
+ */
2495
+ onFocusIn: any;
2496
+ /**
2497
+ * Fired when focus exits this Widget's ownership tree. This is different from a `blur` event.
2498
+ * focus moving from within this Widget's ownership tree, even if there are floating widgets
2499
+ * will not trigger this event. This is when focus exits this widget completely.
2500
+ * @param {object} event Event object
2501
+ * @param {Core.widget.Widget} event.source This Widget
2502
+ * @param {HTMLElement} event.fromElement The element which lost focus.
2503
+ * @param {HTMLElement} event.toElement The element which gained focus.
2504
+ * @param {Core.widget.Widget} event.fromWidget The widget which lost focus.
2505
+ * @param {Core.widget.Widget} event.toWidget The widget which gained focus.
2506
+ * @param {boolean} event.backwards `true` if the `toElement` is before the `fromElement` in document order.
2507
+ */
2508
+ onFocusOut: any;
2509
+ /**
2510
+ * Fired before dragging starts, return false to prevent the drag operation.
2511
+ * @param {object} event Event object
2512
+ * @param {Grid.view.GridBase} event.source
2513
+ * @param {object} event.context
2514
+ * @param {Core.data.Model[]} event.context.records The dragged row records
2515
+ * @param {MouseEvent,TouchEvent} event.event
2516
+ */
2517
+ onGridRowBeforeDragStart: any;
2518
+ /**
2519
+ * Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
2520
+ * Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
2521
+ * @param {object} event Event object
2522
+ * @param {Grid.view.GridBase} event.source
2523
+ * @param {object} event.context
2524
+ * @param {boolean} event.context.valid Set this to true or false to indicate whether the drop position is valid
2525
+ * @param {Core.data.Model} event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
2526
+ * @param {Core.data.Model} event.context.parent The parent record of the current drop position (only applicable for trees)
2527
+ * @param {Core.data.Model[]} event.context.records The dragged row records
2528
+ * @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
2529
+ * @param {MouseEvent} event.event
2530
+ */
2531
+ onGridRowBeforeDropFinalize: any;
2532
+ /**
2533
+ * Fired while the row is being dragged, in the listener function you have access to `context.insertBefore` a grid /
2534
+ * tree record, and additionally `context.parent` (a TreeNode) for trees. You can signal that the drop position is
2535
+ * valid or invalid by setting `context.valid = false;`
2536
+ * @param {object} event Event object
2537
+ * @param {Grid.view.GridBase} event.source
2538
+ * @param {object} event.context
2539
+ * @param {boolean} event.context.valid Set this to true or false to indicate whether the drop position is valid.
2540
+ * @param {Core.data.Model} event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
2541
+ * @param {Core.data.Model} event.context.parent The parent record of the current drop position (only applicable for trees)
2542
+ * @param {Core.data.Model[]} event.context.records The dragged row records
2543
+ * @param {MouseEvent} event.event
2544
+ */
2545
+ onGridRowDrag: any;
2546
+ /**
2547
+ * Fired when a row drag operation is aborted
2548
+ * @param {object} event Event object
2549
+ * @param {Grid.view.GridBase} event.source
2550
+ * @param {object} event.context
2551
+ * @param {Core.data.Model[]} event.context.records The dragged row records
2552
+ * @param {MouseEvent} event.event
2553
+ */
2554
+ onGridRowDragAbort: any;
2555
+ /**
2556
+ * Fired when dragging starts.
2557
+ * @param {object} event Event object
2558
+ * @param {Grid.view.GridBase} event.source
2559
+ * @param {object} event.context
2560
+ * @param {Core.data.Model[]} event.context.records The dragged row records
2561
+ * @param {MouseEvent,TouchEvent} event.event
2562
+ */
2563
+ onGridRowDragStart: any;
2564
+ /**
2565
+ * Fired after the row drop operation has completed, regardless of validity
2566
+ * @param {object} event Event object
2567
+ * @param {Grid.view.GridBase} event.source
2568
+ * @param {object} event.context
2569
+ * @param {boolean} event.context.valid true or false depending on whether the drop position was valid
2570
+ * @param {Core.data.Model} event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
2571
+ * @param {Core.data.Model} event.context.parent The parent record of the current drop position (only applicable for trees)
2572
+ * @param {Core.data.Model[]} event.context.records The dragged row records
2573
+ * @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
2574
+ * @param {MouseEvent} event.event
2575
+ */
2576
+ onGridRowDrop: any;
2577
+ /**
2578
+ * Fired when a grid header is clicked on.
2579
+ * ...
2580
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#event-headerClick)
2581
+ * @param {object} event Event object
2582
+ * @param {Event} event.domEvent The triggering DOM event.
2583
+ * @param {Grid.column.Column} event.column The column clicked on.
2584
+ */
2585
+ onHeaderClick: any;
2586
+ /**
2587
+ * This event fires on the owning Grid before the context menu is shown for a header.
2588
+ * Allows manipulation of the items to show in the same way as in the [processItems](https://bryntum.com/products/calendar/docs/api/Grid/feature/HeaderMenu#config-processItems).
2589
+ * ...
2590
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#event-headerMenuBeforeShow)
2591
+ * @param {object} event Event object
2592
+ * @param {Grid.view.Grid} event.source The grid
2593
+ * @param {Core.widget.Menu} event.menu The menu
2594
+ * @param {Record<string, MenuItemEntry>} event.items Menu item configs
2595
+ * @param {Grid.column.Column} event.column Column
2596
+ */
2597
+ onHeaderMenuBeforeShow: any;
2598
+ /**
2599
+ * This event fires on the owning Grid when an item is selected in the header context menu.
2600
+ * @param {object} event Event object
2601
+ * @param {Grid.view.Grid} event.source The grid
2602
+ * @param {Core.widget.Menu} event.menu The menu
2603
+ * @param {Core.widget.MenuItem} event.item Selected menu item
2604
+ * @param {Grid.column.Column} event.column Column
2605
+ */
2606
+ onHeaderMenuItem: any;
2607
+ /**
2608
+ * This event fires on the owning Grid after the context menu is shown for a header
2609
+ * @param {object} event Event object
2610
+ * @param {Grid.view.Grid} event.source The grid
2611
+ * @param {Core.widget.Menu} event.menu The menu
2612
+ * @param {Record<string, MenuItemEntry>} event.items Menu item configs
2613
+ * @param {Grid.column.Column} event.column Column
2614
+ */
2615
+ onHeaderMenuShow: any;
2616
+ /**
2617
+ * This event fires on the owning Grid when a check item is toggled in the header context menu.
2618
+ * @param {object} event Event object
2619
+ * @param {Grid.view.Grid} event.source The grid
2620
+ * @param {Core.widget.Menu} event.menu The menu
2621
+ * @param {Core.widget.MenuItem} event.item Selected menu item
2622
+ * @param {Grid.column.Column} event.column Column
2623
+ * @param {boolean} event.checked Checked or not
2624
+ */
2625
+ onHeaderMenuToggleItem: any;
2626
+ /**
2627
+ * Triggered after a widget was hidden
2628
+ * @param {object} event Event object
2629
+ * @param {Core.widget.Widget} event.source The widget
2630
+ */
2631
+ onHide: any;
2632
+ /**
2633
+ * Fires when row locking is enabled.
2634
+ * @param {object} event Event object
2635
+ * @param {Grid.view.GridBase} event.clone The created clone
2636
+ */
2637
+ onLockRows: any;
2638
+ /**
2639
+ * Mouse moved out from element in grid
2640
+ * @param {object} event Event object
2641
+ * @param {MouseEvent} event.event The native browser event
2642
+ */
2643
+ onMouseOut: any;
2644
+ /**
2645
+ * Mouse moved in over element in grid
2646
+ * @param {object} event Event object
2647
+ * @param {MouseEvent} event.event The native browser event
2648
+ */
2649
+ onMouseOver: any;
2650
+ /**
2651
+ * Triggered when a widget which had been in a non-visible state for any reason
2652
+ * achieves visibility.
2653
+ * ...
2654
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#event-paint)
2655
+ * @param {object} event Event object
2656
+ * @param {Core.widget.Widget} event.source The widget being painted.
2657
+ * @param {boolean} event.firstPaint `true` if this is the first paint.
2658
+ */
2659
+ onPaint: any;
2660
+ /**
2661
+ * Fires on the owning Grid after a paste action is performed.
2662
+ * @param {object} event Event object
2663
+ * @param {Grid.view.Grid} event.source Owner grid
2664
+ * @param {string} event.clipboardData The clipboardData that was pasted
2665
+ * @param {Core.data.Model[]} event.modifiedRecords The records which have been modified due to the paste action
2666
+ * @param {Grid.util.GridLocation} event.targetCell The cell from which the paste will be started
2667
+ * @param {string} event.entityName 'cell' to distinguish this event from other paste events
2668
+ */
2669
+ onPaste: any;
2670
+ /**
2671
+ * Fires on the owning Grid when export has finished
2672
+ * @param {object} event Event object
2673
+ * @param {Response} event.response Optional response, if received
2674
+ * @param {Error} event.error Optional error, if exception occurred
2675
+ */
2676
+ onPdfExport: any;
2677
+ /**
2678
+ * Fired when the range of dates encapsulated by this view changes.
2679
+ * ...
2680
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#event-rangeChange)
2681
+ * @param {object} event Event object
2682
+ * @param {typeof DateRangeOwner} event.source This calendar view instance.
2683
+ * @param {object} event.old The old date range <strong>if any</strong>.
2684
+ * @param {Date} event.old.startDate the old start date.
2685
+ * @param {Date} event.old.endDate the old end date.
2686
+ * @param {object} event.new The new date range
2687
+ * @param {Date} event.new.startDate the new start date.
2688
+ * @param {Date} event.new.endDate the new end date.
2689
+ */
2690
+ onRangeChange: any;
2691
+ /**
2692
+ * Fired when a Widget's read only state is toggled
2693
+ * @param {object} event Event object
2694
+ * @param {boolean} event.readOnly Read only or not
2695
+ */
2696
+ onReadOnly: any;
2697
+ /**
2698
+ * This event is fired after a widget's elements have been synchronized due to a direct or indirect call
2699
+ * to [recompose](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#function-recompose), if this results in some change to the widget's rendered DOM elements.
2700
+ */
2701
+ onRecompose: any;
2702
+ /**
2703
+ * Fires when this AgendaView refreshes.
2704
+ * @param {object} event Event object
2705
+ * @param {Calendar.widget.AgendaView} event.source The triggering instance.
2706
+ */
2707
+ onRefresh: any;
2708
+ /**
2709
+ * Fires after a row is rendered.
2710
+ * @param {object} event Event object
2711
+ * @param {Grid.view.Grid} event.source The firing Grid instance.
2712
+ * @param {Grid.row.Row} event.row The row that has been rendered.
2713
+ * @param {Core.data.Model} event.record The record for the row.
2714
+ * @param {number} event.recordIndex The zero-based index of the record.
2715
+ */
2716
+ onRenderRow: any;
2717
+ /**
2718
+ * Grid rows have been rendered
2719
+ * @param {object} event Event object
2720
+ * @param {Grid.view.Grid} event.source This grid.
2721
+ */
2722
+ onRenderRows: any;
2723
+ /**
2724
+ * Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
2725
+ * @param {object} event Event object
2726
+ * @param {Core.widget.Widget} event.source This Widget
2727
+ * @param {number} event.width The new width
2728
+ * @param {number} event.height The new height
2729
+ * @param {number} event.oldWidth The old width
2730
+ * @param {number} event.oldHeight The old height
2731
+ */
2732
+ onResize: any;
2733
+ /**
2734
+ * Grid resize lead to a new responsive level being applied
2735
+ * @param {object} event Event object
2736
+ * @param {Grid.view.Grid} event.grid Grid that was resized
2737
+ * @param {string} event.level New responsive level (small, large, etc)
2738
+ * @param {number} event.width New width in px
2739
+ * @param {string} event.oldLevel Old responsive level
2740
+ * @param {number} event.oldWidth Old width in px
2741
+ */
2742
+ onResponsive: any;
2743
+ /**
2744
+ * Triggered when a new [responsiveState](https://bryntum.com/products/calendar/docs/api/Core/widget/mixin/Responsive#config-responsiveState) is applied.
2745
+ * @param {object} event Event object
2746
+ * @param {Core.widget.Widget} event.source The widget whose `responsiveState` has changed
2747
+ * @param {string} event.state The new value for the widget's `responsiveState`
2748
+ * @param {string} event.oldState The previous value for the widget's `responsiveState`
2749
+ */
2750
+ onResponsiveStateChange: any;
2751
+ /**
2752
+ * This event fires when a row has finished collapsing.
2753
+ * @param {object} event Event object
2754
+ * @param {Core.data.Model} event.record Record
2755
+ */
2756
+ onRowCollapse: any;
2757
+ /**
2758
+ * This event fires when a row expand has finished expanding.
2759
+ * ...
2760
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/AgendaView#event-rowExpand)
2761
+ * @param {object} event Event object
2762
+ * @param {Core.data.Model} event.record Record
2763
+ * @param {object} event.expandedElements An object with the Grid region name as property and the expanded body element as value
2764
+ * @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.
2765
+ * @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
2766
+ */
2767
+ onRowExpand: any;
2768
+ /**
2769
+ * Fired when the mouse enters a row
2770
+ * @param {object} event Event object
2771
+ * @param {Grid.view.Grid} event.source The grid instance
2772
+ * @param {Core.data.Model} event.record The record representing the hovered row
2773
+ * @param {Grid.column.Column} event.column The column currently hovered
2774
+ * @param {HTMLElement} event.cellElement The cell HTML element
2775
+ * @param {MouseEvent} event.event The native DOM event
2776
+ */
2777
+ onRowMouseEnter: any;
2778
+ /**
2779
+ * Fired when the mouse leaves a row
2780
+ * @param {object} event Event object
2781
+ * @param {Grid.view.Grid} event.source The grid instance
2782
+ * @param {Core.data.Model} event.record The record representing the row that the mouse left
2783
+ * @param {HTMLElement} event.cellElement The cell HTML element that the mouse left
2784
+ * @param {MouseEvent} event.event The native DOM event
2785
+ */
2786
+ onRowMouseLeave: any;
2787
+ /**
2788
+ * Grid has scrolled vertically
2789
+ * @param {object} event Event object
2790
+ * @param {Grid.view.Grid} event.source The firing Grid instance.
2791
+ * @param {number} event.scrollTop The vertical scroll position.
2792
+ */
2793
+ onScroll: any;
2794
+ /**
2795
+ * The selection has been changed.
2796
+ * @param {object} event Event object
2797
+ * @param {'select','deselect'} event.action `'select'`/`'deselect'`
2798
+ * @param {'row','cell'} event.mode `'row'`/`'cell'`
2799
+ * @param {Grid.view.Grid} event.source
2800
+ * @param {Core.data.Model[]} event.deselected The records deselected in this operation.
2801
+ * @param {Core.data.Model[]} event.selected The records selected in this operation.
2802
+ * @param {Core.data.Model[]} event.selection The records in the new selection.
2803
+ * @param {Grid.util.GridLocation[]} event.deselectedCells The cells deselected in this operation.
2804
+ * @param {Grid.util.GridLocation[]} event.selectedCells The cells selected in this operation.
2805
+ * @param {Grid.util.GridLocation[]} event.cellSelection The cells in the new selection.
2806
+ */
2807
+ onSelectionChange: any;
2808
+ /**
2809
+ * The selectionMode configuration has been changed.
2810
+ * @param {object} event Event object
2811
+ * @param {object} event.selectionMode The new [selectionMode](https://bryntum.com/products/calendar/docs/api/Grid/view/mixin/GridSelection#config-selectionMode)
2812
+ */
2813
+ onSelectionModeChange: any;
2814
+ /**
2815
+ * Fired when the [shiftIncrement](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/DateRangeOwner#property-shiftIncrement) of this view changes.
2816
+ * @param {object} event Event object
2817
+ * @param {object} event.old The shift increment *if any*.
2818
+ * @param {object} event.new The shift increment
2819
+ */
2820
+ onShiftIncrementChange: any;
2821
+ /**
2822
+ * Triggered after a widget is shown.
2823
+ * @param {object} event Event object
2824
+ * @param {Core.widget.Widget} event.source The widget
2825
+ */
2826
+ onShow: any;
2827
+ /**
2828
+ * Fires when splitting the Grid.
2829
+ * @param {object} event Event object
2830
+ * @param {Grid.view.GridBase[]} event.subViews The sub views created by the split
2831
+ * @param {object} event.options The options passed to the split call
2832
+ * @param {'horizontal','vertical','both'} event.options.direction The direction of the split
2833
+ * @param {Grid.column.Column} event.options.atColumn The column to split at
2834
+ * @param {Core.data.Model} event.options.atRecord The record to split at
2835
+ */
2836
+ onSplit: any;
2837
+ /**
2838
+ * Fired by the Grid when the collapse icon is clicked. Return `false` to prevent the default collapse action,
2839
+ * if you want to implement your own behavior.
2840
+ * @param {object} event Event object
2841
+ * @param {Grid.view.Grid} event.source The Grid instance.
2842
+ * @param {Grid.view.SubGrid} event.subGrid The subgrid
2843
+ * @param {Event} event.domEvent The native DOM event
2844
+ */
2845
+ onSplitterCollapseClick: any;
2846
+ /**
2847
+ * Fired by the Grid after a sub-grid has been resized using the splitter
2848
+ * @param {object} event Event object
2849
+ * @param {Grid.view.Grid} event.source The Grid instance.
2850
+ * @param {Grid.view.SubGrid} event.subGrid The resized subgrid
2851
+ * @param {Event} event.domEvent The native DOM event
2852
+ */
2853
+ onSplitterDragEnd: any;
2854
+ /**
2855
+ * Fired by the Grid when a sub-grid resize gesture starts
2856
+ * @param {object} event Event object
2857
+ * @param {Grid.view.Grid} event.source The Grid instance.
2858
+ * @param {Grid.view.SubGrid} event.subGrid The subgrid about to be resized
2859
+ * @param {Event} event.domEvent The native DOM event
2860
+ */
2861
+ onSplitterDragStart: any;
2862
+ /**
2863
+ * Fired by the Grid when the expand icon is clicked. Return `false` to prevent the default expand action,
2864
+ * if you want to implement your own behavior.
2865
+ * @param {object} event Event object
2866
+ * @param {Grid.view.Grid} event.source The Grid instance.
2867
+ * @param {Grid.view.SubGrid} event.subGrid The subgrid
2868
+ * @param {Event} event.domEvent The native DOM event
2869
+ */
2870
+ onSplitterExpandClick: any;
2871
+ /**
2872
+ * Fires on the owning Grid when editing starts
2873
+ * @param {object} event Event object
2874
+ * @param {Grid.view.Grid} event.source Owner grid
2875
+ * @param {CellEditorContext} event.editorContext Editing context
2876
+ */
2877
+ onStartCellEdit: any;
2878
+ /**
2879
+ * Fires on the owning Grid when editing starts
2880
+ * @param {object} event Event object
2881
+ * @param {Grid.view.Grid} event.source Owner grid
2882
+ * @param {RowEditorContext} event.editorContext Editing context
2883
+ */
2884
+ onStartRowEdit: any;
2885
+ /**
2886
+ * Fires after a sub grid is collapsed.
2887
+ * @param {object} event Event object
2888
+ * @param {Grid.view.Grid} event.source The firing Grid instance
2889
+ * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
2890
+ */
2891
+ onSubGridCollapse: any;
2892
+ /**
2893
+ * Fires after a sub grid is expanded.
2894
+ * @param {object} event Event object
2895
+ * @param {Grid.view.Grid} event.source The firing Grid instance
2896
+ * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
2897
+ */
2898
+ onSubGridExpand: any;
2899
+ /**
2900
+ * Fired when one or more groups are expanded or collapsed
2901
+ * @param {object} event Event object
2902
+ * @param {Core.data.Model} event.groupRecord [DEPRECATED] Use `groupRecords` param instead
2903
+ * @param {Core.data.Model[]} event.groupRecords The group records being toggled
2904
+ * @param {boolean} event.collapse Collapsed (true) or expanded (false)
2905
+ * @param {boolean} event.allRecords True if this event is part of toggling all groups
2906
+ */
2907
+ onToggleGroup: any;
2908
+ /**
2909
+ * Fired after a parent node record toggles its collapsed state.
2910
+ * @param {object} event Event object
2911
+ * @param {Core.data.Model} event.record The record being toggled.
2912
+ * @param {boolean} event.collapse `true` if the node is being collapsed.
2913
+ */
2914
+ onToggleNode: any;
2915
+ /**
2916
+ * A header [tool](https://bryntum.com/products/calendar/docs/api/Core/widget/Panel#config-tools) has been clicked.
2917
+ * @param {object} event Event object
2918
+ * @param {Core.widget.Tool} event.source This Panel.
2919
+ * @param {Core.widget.Tool} event.tool The tool which is being clicked.
2920
+ */
2921
+ onToolClick: any;
2922
+ /**
2923
+ * Fired when the date header stuck at the top of the view changes.
2924
+ * @param {object} event Event object
2925
+ * @param {Date} event.date The date which is at the top of the view
2926
+ */
2927
+ onTopDateChange: any;
2928
+ /**
2929
+ * Fires when row locking is disabled.
2930
+ * @param {object} event Event object
2931
+ * @param {Grid.view.GridBase} event.clone The locked clone that will be destroyed
2932
+ */
2933
+ onUnlockRows: any;
2934
+ /**
2935
+ * Fires when un-splitting the Grid.
2936
+ */
2937
+ onUnsplit: any;
2938
+ /**
2939
+ * Create and append the underlying widget
2940
+ */
2941
+ ngOnInit(): void;
2942
+ /**
2943
+ * Watch for changes
2944
+ * @param changes
2945
+ */
2946
+ ngOnChanges(changes: SimpleChanges): void;
2947
+ /**
2948
+ * Destroy the component
2949
+ */
2950
+ ngOnDestroy(): void;
2951
+ static ɵfac: i0.ɵɵFactoryDeclaration<BryntumAgendaViewComponent, never>;
2952
+ static ɵcmp: i0.ɵɵComponentDeclaration<BryntumAgendaViewComponent, "bryntum-agenda-view", never, { "activationKey": "activationKey"; "adopt": "adopt"; "animateFilterRemovals": "animateFilterRemovals"; "animateRemovingRows": "animateRemovingRows"; "ariaDescription": "ariaDescription"; "ariaLabel": "ariaLabel"; "autoHeight": "autoHeight"; "bbar": "bbar"; "bodyCls": "bodyCls"; "bubbleEvents": "bubbleEvents"; "collapsible": "collapsible"; "color": "color"; "config": "config"; "contentElementCls": "contentElementCls"; "contextMenuTriggerEvent": "contextMenuTriggerEvent"; "dataField": "dataField"; "defaultRegion": "defaultRegion"; "descriptionRenderer": "descriptionRenderer"; "destroyStore": "destroyStore"; "detectCSSCompatibilityIssues": "detectCSSCompatibilityIssues"; "disableGridColumnIdWarning": "disableGridColumnIdWarning"; "disableGridRowModelWarning": "disableGridRowModelWarning"; "dock": "dock"; "drawer": "drawer"; "elementAttributes": "elementAttributes"; "enableSticky": "enableSticky"; "enableTextSelection": "enableTextSelection"; "endDate": "endDate"; "eventFilter": "eventFilter"; "eventHeaderRenderer": "eventHeaderRenderer"; "eventHeight": "eventHeight"; "eventListTimeFormat": "eventListTimeFormat"; "eventRenderer": "eventRenderer"; "eventRowSpacing": "eventRowSpacing"; "eventSorter": "eventSorter"; "fillLastColumn": "fillLastColumn"; "fixedRowHeight": "fixedRowHeight"; "footer": "footer"; "formulaProviders": "formulaProviders"; "fullRowRefresh": "fullRowRefresh"; "getPrimaryResource": "getPrimaryResource"; "getRowHeight": "getRowHeight"; "header": "header"; "hideEventOverflow": "hideEventOverflow"; "hideHorizontalScrollbar": "hideHorizontalScrollbar"; "hoverCls": "hoverCls"; "icon": "icon"; "ignoreParentReadOnly": "ignoreParentReadOnly"; "listeners": "listeners"; "listRangeMenu": "listRangeMenu"; "loadMask": "loadMask"; "loadMaskDefaults": "loadMaskDefaults"; "loadMaskError": "loadMaskError"; "localizable": "localizable"; "maskDefaults": "maskDefaults"; "masked": "masked"; "monitorResize": "monitorResize"; "owner": "owner"; "plugins": "plugins"; "preserveFocusOnDatasetChange": "preserveFocusOnDatasetChange"; "preserveScrollOnDatasetChange": "preserveScrollOnDatasetChange"; "preventTooltipOnTouch": "preventTooltipOnTouch"; "relayStoreEvents": "relayStoreEvents"; "resizable": "resizable"; "resizeToFitIncludesHeader": "resizeToFitIncludesHeader"; "resourceImagePath": "resourceImagePath"; "responsive": "responsive"; "responsiveLevels": "responsiveLevels"; "responsiveRoot": "responsiveRoot"; "responsiveState": "responsiveState"; "responsiveTarget": "responsiveTarget"; "ripple": "ripple"; "rootElement": "rootElement"; "scrollerClass": "scrollerClass"; "scrollManager": "scrollManager"; "selectorButton": "selectorButton"; "selectorMenuItem": "selectorMenuItem"; "shortEventCls": "shortEventCls"; "shortEventDuration": "shortEventDuration"; "showBullet": "showBullet"; "showDirty": "showDirty"; "showResourceAvatars": "showResourceAvatars"; "startDate": "startDate"; "stateful": "stateful"; "statefulEvents": "statefulEvents"; "stateId": "stateId"; "stateProvider": "stateProvider"; "strips": "strips"; "subGridConfigs": "subGridConfigs"; "syncMask": "syncMask"; "tab": "tab"; "tabBarItems": "tabBarItems"; "tbar": "tbar"; "timeFormat": "timeFormat"; "type": "type"; "ui": "ui"; "weekStartDay": "weekStartDay"; "weight": "weight"; "alignSelf": "alignSelf"; "allowDragCreate": "allowDragCreate"; "allowDragMove": "allowDragMove"; "allowDragResize": "allowDragResize"; "alwaysShowCurrentDate": "alwaysShowCurrentDate"; "animateTimeShift": "animateTimeShift"; "animateTreeNodeToggle": "animateTreeNodeToggle"; "appendTo": "appendTo"; "autoCreate": "autoCreate"; "callOnFunctions": "callOnFunctions"; "catchEventHandlerExceptions": "catchEventHandlerExceptions"; "cellEllipsis": "cellEllipsis"; "cls": "cls"; "collapsed": "collapsed"; "column": "column"; "columnLines": "columnLines"; "columns": "columns"; "data": "data"; "dataset": "dataset"; "date": "date"; "dateFilter": "dateFilter"; "dateFormat": "dateFormat"; "dateSeparator": "dateSeparator"; "defaultScrollOptions": "defaultScrollOptions"; "descriptionFormat": "descriptionFormat"; "disabled": "disabled"; "dragUnit": "dragUnit"; "emptyText": "emptyText"; "enableUndoRedoKeys": "enableUndoRedoKeys"; "eventTimeRenderer": "eventTimeRenderer"; "extendAllDayEndDay": "extendAllDayEndDay"; "extraData": "extraData"; "filterEventResources": "filterEventResources"; "fixedDuration": "fixedDuration"; "flex": "flex"; "height": "height"; "hidden": "hidden"; "hideFooters": "hideFooters"; "hideHeaders": "hideHeaders"; "hideNonWorkingDays": "hideNonWorkingDays"; "id": "id"; "inputFieldAlign": "inputFieldAlign"; "insertBefore": "insertBefore"; "insertFirst": "insertFirst"; "keyMap": "keyMap"; "labelPosition": "labelPosition"; "longPressTime": "longPressTime"; "margin": "margin"; "maxDate": "maxDate"; "maxHeight": "maxHeight"; "maxWidth": "maxWidth"; "minDate": "minDate"; "minHeight": "minHeight"; "minWidth": "minWidth"; "nonWorkingDays": "nonWorkingDays"; "offsetStartsBeforeEvents": "offsetStartsBeforeEvents"; "pastEventCls": "pastEventCls"; "preserveScroll": "preserveScroll"; "range": "range"; "readOnly": "readOnly"; "rendition": "rendition"; "rowHeight": "rowHeight"; "rowLines": "rowLines"; "rtl": "rtl"; "scrollable": "scrollable"; "selectionMode": "selectionMode"; "settingsButton": "settingsButton"; "shiftIncrement": "shiftIncrement"; "shortDateFormat": "shortDateFormat"; "shortDateTimeFormat": "shortDateTimeFormat"; "showAllDates": "showAllDates"; "showEmptyDates": "showEmptyDates"; "span": "span"; "stackMultiDayEvents": "stackMultiDayEvents"; "stateSettings": "stateSettings"; "store": "store"; "syncCalendarDate": "syncCalendarDate"; "syncViewDate": "syncViewDate"; "title": "title"; "tools": "tools"; "transition": "transition"; "transitionDuration": "transitionDuration"; "width": "width"; "dayCellCls": "dayCellCls"; "firstVisibleCell": "firstVisibleCell"; "firstVisibleDate": "firstVisibleDate"; "focusVisible": "focusVisible"; "hasChanges": "hasChanges"; "lastVisibleCell": "lastVisibleCell"; "lastVisibleDate": "lastVisibleDate"; "originalStore": "originalStore"; "parent": "parent"; "selectedCell": "selectedCell"; "selectedCells": "selectedCells"; "selectedRecord": "selectedRecord"; "selectedRecords": "selectedRecords"; "selectedRows": "selectedRows"; "state": "state"; "tooltip": "tooltip"; "aiFilterFeature": "aiFilterFeature"; "cellCopyPasteFeature": "cellCopyPasteFeature"; "cellEditFeature": "cellEditFeature"; "cellMenuFeature": "cellMenuFeature"; "cellTooltipFeature": "cellTooltipFeature"; "chartsFeature": "chartsFeature"; "columnAutoWidthFeature": "columnAutoWidthFeature"; "columnDragToolbarFeature": "columnDragToolbarFeature"; "columnPickerFeature": "columnPickerFeature"; "columnRenameFeature": "columnRenameFeature"; "columnReorderFeature": "columnReorderFeature"; "columnResizeFeature": "columnResizeFeature"; "excelExporterFeature": "excelExporterFeature"; "fileDropFeature": "fileDropFeature"; "fillHandleFeature": "fillHandleFeature"; "filterFeature": "filterFeature"; "filterBarFeature": "filterBarFeature"; "groupFeature": "groupFeature"; "groupSummaryFeature": "groupSummaryFeature"; "headerMenuFeature": "headerMenuFeature"; "lockRowsFeature": "lockRowsFeature"; "mergeCellsFeature": "mergeCellsFeature"; "pdfExportFeature": "pdfExportFeature"; "pinColumnsFeature": "pinColumnsFeature"; "printFeature": "printFeature"; "quickFindFeature": "quickFindFeature"; "regionResizeFeature": "regionResizeFeature"; "rowCopyPasteFeature": "rowCopyPasteFeature"; "rowEditFeature": "rowEditFeature"; "rowExpanderFeature": "rowExpanderFeature"; "rowReorderFeature": "rowReorderFeature"; "rowResizeFeature": "rowResizeFeature"; "searchFeature": "searchFeature"; "sortFeature": "sortFeature"; "splitFeature": "splitFeature"; "stickyCellsFeature": "stickyCellsFeature"; "stripeFeature": "stripeFeature"; "summaryFeature": "summaryFeature"; "treeFeature": "treeFeature"; "treeGroupFeature": "treeGroupFeature"; }, { "onBeforeAutoCreate": "onBeforeAutoCreate"; "onBeforeCancelCellEdit": "onBeforeCancelCellEdit"; "onBeforeCancelRowEdit": "onBeforeCancelRowEdit"; "onBeforeCellEditStart": "onBeforeCellEditStart"; "onBeforeCellRangeDelete": "onBeforeCellRangeDelete"; "onBeforeCellRangeEdit": "onBeforeCellRangeEdit"; "onBeforeChangeDate": "onBeforeChangeDate"; "onBeforeColumnDragStart": "onBeforeColumnDragStart"; "onBeforeColumnDropFinalize": "onBeforeColumnDropFinalize"; "onBeforeColumnResize": "onBeforeColumnResize"; "onBeforeCopy": "onBeforeCopy"; "onBeforeCSVExport": "onBeforeCSVExport"; "onBeforeDestroy": "onBeforeDestroy"; "onBeforeExcelExport": "onBeforeExcelExport"; "onBeforeFillHandleDragStart": "onBeforeFillHandleDragStart"; "onBeforeFinishCellEdit": "onBeforeFinishCellEdit"; "onBeforeFinishRowEdit": "onBeforeFinishRowEdit"; "onBeforeHide": "onBeforeHide"; "onBeforePaste": "onBeforePaste"; "onBeforePdfExport": "onBeforePdfExport"; "onBeforeRenderRow": "onBeforeRenderRow"; "onBeforeRenderRows": "onBeforeRenderRows"; "onBeforeResponsiveStateChange": "onBeforeResponsiveStateChange"; "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"; "onCellMapPopulated": "onCellMapPopulated"; "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"; "onDataChange": "onDataChange"; "onDayCellPopulated": "onDayCellPopulated"; "onDestroy": "onDestroy"; "onDirtyStateChange": "onDirtyStateChange"; "onDragSelecting": "onDragSelecting"; "onElementCreated": "onElementCreated"; "onEventAutoCreated": "onEventAutoCreated"; "onEventPropagate": "onEventPropagate"; "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"; "onLockRows": "onLockRows"; "onMouseOut": "onMouseOut"; "onMouseOver": "onMouseOver"; "onPaint": "onPaint"; "onPaste": "onPaste"; "onPdfExport": "onPdfExport"; "onRangeChange": "onRangeChange"; "onReadOnly": "onReadOnly"; "onRecompose": "onRecompose"; "onRefresh": "onRefresh"; "onRenderRow": "onRenderRow"; "onRenderRows": "onRenderRows"; "onResize": "onResize"; "onResponsive": "onResponsive"; "onResponsiveStateChange": "onResponsiveStateChange"; "onRowCollapse": "onRowCollapse"; "onRowExpand": "onRowExpand"; "onRowMouseEnter": "onRowMouseEnter"; "onRowMouseLeave": "onRowMouseLeave"; "onScroll": "onScroll"; "onSelectionChange": "onSelectionChange"; "onSelectionModeChange": "onSelectionModeChange"; "onShiftIncrementChange": "onShiftIncrementChange"; "onShow": "onShow"; "onSplit": "onSplit"; "onSplitterCollapseClick": "onSplitterCollapseClick"; "onSplitterDragEnd": "onSplitterDragEnd"; "onSplitterDragStart": "onSplitterDragStart"; "onSplitterExpandClick": "onSplitterExpandClick"; "onStartCellEdit": "onStartCellEdit"; "onStartRowEdit": "onStartRowEdit"; "onSubGridCollapse": "onSubGridCollapse"; "onSubGridExpand": "onSubGridExpand"; "onToggleGroup": "onToggleGroup"; "onToggleNode": "onToggleNode"; "onToolClick": "onToolClick"; "onTopDateChange": "onTopDateChange"; "onUnlockRows": "onUnlockRows"; "onUnsplit": "onUnsplit"; }, never, never>;
2953
+ }