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