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