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