@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,4692 @@
1
+ /**
2
+ * React wrapper for Bryntum GanttBase
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, GanttBase, GanttBaseListeners, 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 BryntumGanttBaseProps = {
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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#config-listeners)
587
+ */
588
+ listeners? : GanttBaseListeners
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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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/GanttBase#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
+ /**
1189
+ * Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
1190
+ * as a space separated string, an array of strings, or as an object in which property names with truthy
1191
+ * values are used as the class names.
1192
+ * ...
1193
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#config-ui)
1194
+ */
1195
+ ui? : 'plain'|'toolbar'|string|object
1196
+ /**
1197
+ * By default, the day of week and week of month of the event's start date are used to create
1198
+ * helpful contextual recurrence types when editing a non-recurring event record and choosing
1199
+ * an initial recurrence type.
1200
+ * ...
1201
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#config-useContextualRecurrenceRules)
1202
+ */
1203
+ useContextualRecurrenceRules? : boolean
1204
+ /**
1205
+ * A string key used to lookup a predefined [ViewPreset](https://bryntum.com/products/gantt/docs/api/Scheduler/preset/ViewPreset) (e.g. 'weekAndDay', 'hourAndDay'),
1206
+ * managed by [PresetManager](https://bryntum.com/products/gantt/docs/api/Scheduler/preset/PresetManager). See [PresetManager](#Scheduler/preset/PresetManager) for more information.
1207
+ * Or a config object for a viewPreset.
1208
+ * ...
1209
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#config-viewPreset)
1210
+ */
1211
+ viewPreset? : string|ViewPresetConfig
1212
+ /**
1213
+ * A date to bring into view initially on the scrollable timeline.
1214
+ * ...
1215
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#config-visibleDate)
1216
+ */
1217
+ visibleDate? : Date|VisibleDate
1218
+ /**
1219
+ * Integer number indicating the size of timespan during zooming. When zooming, the timespan is adjusted to make
1220
+ * the scrolling area `visibleZoomFactor` times wider than the timeline area itself. Used in
1221
+ * [zoomToSpan](https://bryntum.com/products/gantt/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomToSpan) and [zoomToLevel](#Scheduler/view/mixin/TimelineZoomable#function-zoomToLevel) functions.
1222
+ */
1223
+ visibleZoomFactor? : number
1224
+ /**
1225
+ * A valid JS day index between 0-6 (0: Sunday, 1: Monday etc.) to be considered the start day of the week.
1226
+ * When omitted, the week start day is retrieved from the active locale class.
1227
+ */
1228
+ weekStartDay? : number
1229
+ /**
1230
+ * A widgets weight determines its position among siblings when added to a [Container](https://bryntum.com/products/gantt/docs/api/Core/widget/Container).
1231
+ * Higher weights go further down.
1232
+ */
1233
+ weight? : number
1234
+ /**
1235
+ * Widget's width, used to set element `style.width`. Either specify a valid width string or a number, which
1236
+ * will get 'px' appended. We recommend using CSS as the primary way to control width, but in some cases
1237
+ * this config is convenient.
1238
+ */
1239
+ width? : string|number
1240
+ /**
1241
+ * An object with format `{ fromDay, toDay, fromHour, toHour }` that describes the working days and hours.
1242
+ * This object will be used to populate TimeAxis [include](https://bryntum.com/products/gantt/docs/api/Scheduler/data/TimeAxis#config-include) property.
1243
+ * ...
1244
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#config-workingTime)
1245
+ */
1246
+ workingTime? : {
1247
+ fromDay?: number
1248
+ toDay?: number
1249
+ fromHour?: number
1250
+ toHour?: number
1251
+ }
1252
+ /**
1253
+ * Whether the originally rendered timespan should be preserved while zooming. By default, it is set to `false`,
1254
+ * meaning the timeline panel will adjust the currently rendered timespan to limit the amount of HTML content to
1255
+ * render. When setting this option to `true`, be careful not to allow to zoom a big timespan in seconds
1256
+ * resolution for example. That will cause <strong>a lot</strong> of HTML content to be rendered and affect performance. You
1257
+ * 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.
1258
+ */
1259
+ zoomKeepsOriginalTimespan? : boolean
1260
+ /**
1261
+ * If true, you can zoom in and out on the time axis using CTRL-key + mouse wheel.
1262
+ */
1263
+ zoomOnMouseWheel? : boolean
1264
+ /**
1265
+ * True to zoom to time span when double-clicking a time axis cell.
1266
+ */
1267
+ zoomOnTimeAxisDoubleClick? : boolean
1268
+
1269
+ // Events
1270
+ /**
1271
+ * Fired on the owning Scheduler/Gantt after a dependency drag creation operation finished, no matter to outcome
1272
+ * @param {object} event Event object
1273
+ * @param {Scheduler.model.TimeSpan} event.source The source task
1274
+ * @param {Scheduler.model.TimeSpan} event.target The target task
1275
+ * @param {Scheduler.model.DependencyBaseModel} event.dependency The created dependency
1276
+ */
1277
+ onAfterDependencyCreateDrop? : ((event: { source: TimeSpan, target: TimeSpan, dependency: DependencyBaseModel }) => void)|string
1278
+ /**
1279
+ * Fires on the owning Scheduler or Gantt widget after a dependency is successfully saved using the
1280
+ * dependency edit popup
1281
+ * @param {object} event Event object
1282
+ * @param {Scheduler.view.Scheduler} event.source The scheduler instance or Gantt instance
1283
+ * @param {Scheduler.model.SchedulerDependencyModel} event.dependencyRecord The dependency about to be saved
1284
+ */
1285
+ onAfterDependencySave? : ((event: { source: Scheduler, dependencyRecord: SchedulerDependencyModel }) => void)|string
1286
+ /**
1287
+ * Fires on the owning Gantt at the end of the drag create gesture whether or not
1288
+ * a task was scheduled by the gesture.
1289
+ * @param {object} event Event object
1290
+ * @param {Gantt.view.Gantt} event.source
1291
+ * @param {HTMLElement} event.proxyElement The element showing the drag creation zone.
1292
+ */
1293
+ onAfterDragCreate? : ((event: { source: Gantt, proxyElement: HTMLElement }) => void)|string
1294
+ /**
1295
+ * Fires on the owning Scheduler after editor is closed by any action - save, delete or cancel
1296
+ * @param {object} event Event object
1297
+ * @param {Scheduler.view.Scheduler} event.source The scheduler
1298
+ * @param {'save','delete','cancel'} event.action The action that was taken to end the edit. One of 'save', 'delete' or 'cancel'
1299
+ * @param {Scheduler.feature.EventEdit} event.eventEdit The eventEdit feature
1300
+ * @param {Scheduler.model.SchedulerEventModel} event.eventRecord The record that has been edited.
1301
+ * @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.
1302
+ * @param {HTMLElement} event.eventElement The element which represents the event in the scheduler display.
1303
+ * @param {Core.widget.Popup} event.editor The editor
1304
+ */
1305
+ onAfterEventEdit? : ((event: { source: Scheduler, action: 'save'|'delete'|'cancel', eventEdit: EventEdit, eventRecord: SchedulerEventModel, resourceRecord: SchedulerResourceModel, eventElement: HTMLElement, editor: Popup }) => void)|string
1306
+ /**
1307
+ * Fires on the owning Scheduler or Gantt widget instance after an event record is saved
1308
+ * @param {object} event Event object
1309
+ * @param {SchedulerPro.view.SchedulerPro} event.source The Scheduler Pro instance
1310
+ * @param {SchedulerPro.model.EventModel} event.eventRecord The event record about to be saved
1311
+ * @param {SchedulerPro.widget.TaskEditorBase} event.editor The editor widget
1312
+ */
1313
+ onAfterEventSave? : ((event: { source: SchedulerPro, eventRecord: EventModel, editor: TaskEditorBase }) => void)|string
1314
+ /**
1315
+ * Fires on the owning Gantt widget instance after project editing is finished by applying changes or
1316
+ * cancelling them.
1317
+ * @param {object} event Event object
1318
+ * @param {Gantt.view.Gantt} event.source The Gantt instance
1319
+ * @param {Gantt.model.ProjectModel} event.projectRecord The edited project record
1320
+ * @param {Gantt.widget.ProjectEditor} event.editor The editor widget
1321
+ */
1322
+ onAfterProjectEdit? : ((event: { source: Gantt, projectRecord: ProjectModel, editor: ProjectEditor }) => void)|string
1323
+ /**
1324
+ * Fires on the owning Gantt widget instance after a project is saved
1325
+ * @param {object} event Event object
1326
+ * @param {Gantt.view.Gantt} event.source The Gantt instance
1327
+ * @param {Gantt.model.ProjectModel} event.projectRecord The project about to be saved
1328
+ * @param {Gantt.widget.ProjectEditor} event.editor The editor widget
1329
+ */
1330
+ onAfterProjectSave? : ((event: { source: Gantt, projectRecord: ProjectModel, editor: ProjectEditor }) => void)|string
1331
+ /**
1332
+ * Fires on the owning Gantt after a task drop, regardless if the drop validity
1333
+ * @param {object} event Event object
1334
+ * @param {Gantt.view.Gantt} event.source
1335
+ * @param {Gantt.model.TaskModel[]} event.taskRecords
1336
+ * @param {boolean} event.valid
1337
+ */
1338
+ onAfterTaskDrop? : ((event: { source: Gantt, taskRecords: TaskModel[], valid: boolean }) => void)|string
1339
+ /**
1340
+ * Fires on the owning Scheduler or Gantt widget instance after task editing is finished by applying changes, cancelling them
1341
+ * or deleting the task record.
1342
+ * @param {object} event Event object
1343
+ * @param {SchedulerPro.view.SchedulerPro} event.source The Scheduler Pro instance
1344
+ * @param {SchedulerPro.model.EventModel} event.taskRecord Task record used in the task editor
1345
+ * @param {SchedulerPro.widget.TaskEditorBase} event.editor The editor widget
1346
+ */
1347
+ onAfterTaskEdit? : ((event: { source: SchedulerPro, taskRecord: EventModel, editor: TaskEditorBase }) => void)|string
1348
+ /**
1349
+ * Fires on the owning Scheduler or Gantt widget instance after a task is saved
1350
+ * @param {object} event Event object
1351
+ * @param {SchedulerPro.view.SchedulerPro} event.source The Scheduler Pro instance
1352
+ * @param {SchedulerPro.model.EventModel} event.taskRecord The task about to be saved
1353
+ * @param {SchedulerPro.widget.TaskEditorBase} event.editor The editor widget
1354
+ */
1355
+ onAfterTaskSave? : ((event: { source: SchedulerPro, taskRecord: EventModel, editor: TaskEditorBase }) => void)|string
1356
+ /**
1357
+ * Fires on the owning Gantt after a task drop, regardless if the drop validity
1358
+ * @param {object} event Event object
1359
+ * @param {Gantt.view.Gantt} event.source
1360
+ * @param {Gantt.model.TaskModel[]} event.taskRecords Dropped segments
1361
+ * @param {boolean} event.valid
1362
+ */
1363
+ onAfterTaskSegmentDrop? : ((event: { source: Gantt, taskRecords: TaskModel[], valid: boolean }) => void)|string
1364
+ /**
1365
+ * Fires before an assignment is removed. Can be triggered by user pressing [DELETE] or [BACKSPACE] or
1366
+ * by the event editor. Can for example be used to display a custom dialog to confirm deletion, in which
1367
+ * case records should be "manually" removed after confirmation:
1368
+ * ...
1369
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-beforeAssignmentDelete)
1370
+ * @param {object} event Event object
1371
+ * @param {Scheduler.view.Scheduler} event.source The Scheduler instance
1372
+ * @param {Scheduler.model.SchedulerAssignmentModel[]} event.assignmentRecords The assignment records about to be deleted
1373
+ * @param {object} event.context Additional removal context:
1374
+ * @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.
1375
+ * @param {boolean} event.context.finalize.removeRecords Provide `false` to the function to prevent the removal.
1376
+ */
1377
+ onBeforeAssignmentDelete? : ((event: { source: Scheduler, assignmentRecords: SchedulerAssignmentModel[], context: { finalize: { removeRecords?: boolean } } }) => Promise<boolean>|boolean|void)|string
1378
+ /**
1379
+ * Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
1380
+ * @param {object} event Event object
1381
+ * @param {Grid.view.Grid} event.source Owner grid
1382
+ * @param {Grid.util.GridLocation} event.editorContext Editing context
1383
+ */
1384
+ onBeforeCancelCellEdit? : ((event: { source: Grid, editorContext: GridLocation }) => Promise<boolean>|boolean|void)|string
1385
+ /**
1386
+ * 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.
1387
+ * ...
1388
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-beforeCancelRowEdit)
1389
+ * @param {object} event Event object
1390
+ * @param {Grid.view.Grid} event.grid Target grid
1391
+ * @param {RowEditorContext} event.editorContext Editing context
1392
+ */
1393
+ onBeforeCancelRowEdit? : ((event: { grid: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string
1394
+ /**
1395
+ * Fires on the owning Grid before editing starts, return `false` to prevent editing
1396
+ * @param {object} event Event object
1397
+ * @param {Grid.view.Grid} event.source Owner grid
1398
+ * @param {CellEditorContext} event.editorContext Editing context
1399
+ */
1400
+ onBeforeCellEditStart? : ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
1401
+ /**
1402
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
1403
+ * buttons while [autoEdit](https://bryntum.com/products/gantt/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
1404
+ * @param {object} event Event object
1405
+ * @param {Grid.view.Grid} event.source Owner grid
1406
+ * @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).
1407
+ */
1408
+ onBeforeCellRangeDelete? : ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => Promise<boolean>|boolean|void)|string
1409
+ /**
1410
+ * Fires for each selected record on the owning Grid before editing a range of selected cell values
1411
+ * @param {object} event Event object
1412
+ * @param {Core.data.Model} event.record Current selected record from the range
1413
+ * @param {string} event.field The field being changed
1414
+ * @param {any} event.value The value being set
1415
+ */
1416
+ onBeforeCellRangeEdit? : ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
1417
+ /**
1418
+ * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
1419
+ * @param {object} event Event object
1420
+ * @param {Grid.view.Grid} event.source The grid instance.
1421
+ * @param {Grid.column.Column} event.column The dragged column.
1422
+ * @param {Event} event.event The browser event.
1423
+ */
1424
+ onBeforeColumnDragStart? : ((event: { source: Grid, column: Column, event: Event }) => Promise<boolean>|boolean|void)|string
1425
+ /**
1426
+ * This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
1427
+ * @param {object} event Event object
1428
+ * @param {Grid.view.Grid} event.source The grid instance.
1429
+ * @param {Grid.column.Column} event.column The dragged column.
1430
+ * @param {Grid.column.Column} event.insertBefore The column before which the dragged column will be inserted.
1431
+ * @param {Grid.column.Column} event.newParent The new parent column.
1432
+ * @param {Event} event.event The browser event.
1433
+ * @param {string} event.region The region where the column was dropped.
1434
+ */
1435
+ onBeforeColumnDropFinalize? : ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => Promise<boolean>|boolean|void)|string
1436
+ /**
1437
+ * This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
1438
+ * `false`.
1439
+ * @param {object} event Event object
1440
+ * @param {Grid.view.Grid} event.source The grid instance
1441
+ * @param {Grid.column.Column} event.column The column
1442
+ * @param {Event} event.domEvent The browser event
1443
+ */
1444
+ onBeforeColumnResize? : ((event: { source: Grid, column: Column, domEvent: Event }) => Promise<boolean>|boolean|void)|string
1445
+ /**
1446
+ * Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
1447
+ * @param {object} event Event object
1448
+ * @param {Grid.view.Grid} event.source Owner grid
1449
+ * @param {Grid.util.GridLocation[]} event.cells The cells about to be copied or cut
1450
+ * @param {string} event.data The string data about to be copied or cut
1451
+ * @param {boolean} event.isCut `true` if this is a cut action
1452
+ * @param {string} event.entityName 'cell' to distinguish this event from other beforeCopy events
1453
+ */
1454
+ onBeforeCopy? : ((event: { source: Grid, cells: GridLocation[], data: string, isCut: boolean, entityName: string }) => Promise<boolean>|boolean|void)|string
1455
+ /**
1456
+ * Fires on the owning Grid before CSV export starts. Return `false` to cancel the export.
1457
+ * @param {object} event Event object
1458
+ * @param {ExportConfig} event.config Export config
1459
+ * @param {Grid.column.Column[]} event.columns An array of columns to export
1460
+ * @param {Core.data.Model[]} event.rows An array of records to export
1461
+ * @param {string} event.lineDelimiter The CSV delimiter to separate lines
1462
+ * @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
1463
+ */
1464
+ onBeforeCSVExport? : ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => Promise<boolean>|boolean|void)|string
1465
+ /**
1466
+ * Fires on the owning Scheduler or Gantt widget before a dependency is added from the dependency
1467
+ * edit popup
1468
+ * @param {object} event Event object
1469
+ * @param {Scheduler.view.Scheduler} event.source The scheduler or Gantt instance
1470
+ * @param {Scheduler.feature.SchedulerDependencyEdit} event.dependencyEdit The dependency edit feature
1471
+ * @param {Scheduler.model.SchedulerDependencyModel} event.dependencyRecord The dependency about to be added
1472
+ */
1473
+ onBeforeDependencyAdd? : ((event: { source: Scheduler, dependencyEdit: SchedulerDependencyEdit, dependencyRecord: SchedulerDependencyModel }) => Promise<boolean>|boolean|void)|string
1474
+ /**
1475
+ * Fired on the owning Scheduler/Gantt before a dependency creation drag operation starts. Return `false` to
1476
+ * prevent it
1477
+ * @param {object} event Event object
1478
+ * @param {Scheduler.model.TimeSpan} event.source The source task
1479
+ */
1480
+ onBeforeDependencyCreateDrag? : ((event: { source: TimeSpan }) => Promise<boolean>|boolean|void)|string
1481
+ /**
1482
+ * Fired on the owning Scheduler/Gantt when a dependency drag creation operation is about to finalize
1483
+ * @param {object} event Event object
1484
+ * @param {Scheduler.model.TimeSpan} event.source The source task
1485
+ * @param {Scheduler.model.TimeSpan} event.target The target task
1486
+ * @param {'start','end','top','bottom'} event.fromSide The from side (start / end / top / bottom)
1487
+ * @param {'start','end','top','bottom'} event.toSide The to side (start / end / top / bottom)
1488
+ */
1489
+ onBeforeDependencyCreateFinalize? : ((event: { source: TimeSpan, target: TimeSpan, fromSide: 'start'|'end'|'top'|'bottom', toSide: 'start'|'end'|'top'|'bottom' }) => Promise<boolean>|boolean|void)|string
1490
+ /**
1491
+ * Fires on the owning Scheduler or Gantt widget before a dependency is deleted from the dependency
1492
+ * edit popup, or when clicking the delete icon on a selected dependency line.
1493
+ * @param {object} event Event object
1494
+ * @param {Scheduler.view.Scheduler} event.source The scheduler instance
1495
+ * @param {Scheduler.model.SchedulerDependencyModel} event.dependencyRecord The dependency record about to be deleted
1496
+ */
1497
+ onBeforeDependencyDelete? : ((event: { source: Scheduler, dependencyRecord: SchedulerDependencyModel }) => Promise<boolean>|boolean|void)|string
1498
+ /**
1499
+ * Fires on the owning Scheduler or Gantt widget before an dependency is displayed in the editor.
1500
+ * This may be listened for to allow an application to take over dependency editing duties. Return `false` to
1501
+ * stop the default editing UI from being shown or a `Promise` yielding `true` or `false` for async vetoing.
1502
+ * @param {object} event Event object
1503
+ * @param {Scheduler.view.Scheduler} event.source The scheduler or Gantt instance
1504
+ * @param {Scheduler.feature.SchedulerDependencyEdit} event.dependencyEdit The dependencyEdit feature
1505
+ * @param {Scheduler.model.SchedulerDependencyModel} event.dependencyRecord The record about to be shown in the editor.
1506
+ */
1507
+ onBeforeDependencyEdit? : ((event: { source: Scheduler, dependencyEdit: SchedulerDependencyEdit, dependencyRecord: SchedulerDependencyModel }) => Promise<boolean>|boolean|void)|string
1508
+ /**
1509
+ * Fires on the owning Scheduler or Gantt widget when the editor for a dependency is available, but before it is shown. Allows
1510
+ * manipulating fields before the widget is shown.
1511
+ * @param {object} event Event object
1512
+ * @param {Scheduler.view.Scheduler} event.source The scheduler or Gantt instance
1513
+ * @param {Scheduler.feature.SchedulerDependencyEdit} event.dependencyEdit The dependencyEdit feature
1514
+ * @param {Scheduler.model.SchedulerDependencyModel} event.dependencyRecord The record about to be shown in the editor.
1515
+ * @param {Core.widget.Popup} event.editor The editor popup
1516
+ */
1517
+ onBeforeDependencyEditShow? : ((event: { source: Scheduler, dependencyEdit: SchedulerDependencyEdit, dependencyRecord: SchedulerDependencyModel, editor: Popup }) => void)|string
1518
+ /**
1519
+ * Fires on the owning Scheduler or Gantt widget before a dependency is saved using the dependency edit popup
1520
+ * @param {object} event Event object
1521
+ * @param {Scheduler.view.Scheduler} event.source The scheduler or Gantt instance
1522
+ * @param {Scheduler.model.SchedulerDependencyModel} event.dependencyRecord The dependency about to be saved
1523
+ * @param {object} event.values The new values
1524
+ */
1525
+ onBeforeDependencySave? : ((event: { source: Scheduler, dependencyRecord: SchedulerDependencyModel, values: object }) => Promise<boolean>|boolean|void)|string
1526
+ /**
1527
+ * Fires before an object is destroyed.
1528
+ * @param {object} event Event object
1529
+ * @param {Core.Base} event.source The Object that is being destroyed.
1530
+ */
1531
+ onBeforeDestroy? : ((event: { source: Base }) => void)|string
1532
+ /**
1533
+ * Fires on the owning Gantt at the beginning of the drag gesture
1534
+ * @param {object} event Event object
1535
+ * @param {Gantt.view.Gantt} event.source
1536
+ * @param {Gantt.model.TaskModel} event.taskRecord
1537
+ * @param {Date} event.date The datetime associated with the drag start point.
1538
+ */
1539
+ onBeforeDragCreate? : ((event: { source: Gantt, taskRecord: TaskModel, date: Date }) => void)|string
1540
+ /**
1541
+ * Fires on the owning Gantt to allow implementer to prevent immediate finalization by setting `data.context.async = true`
1542
+ * in the listener, to show a confirmation popup etc
1543
+ * ...
1544
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-beforeDragCreateFinalize)
1545
+ * @param {object} event Event object
1546
+ * @param {Gantt.view.Gantt} event.source Scheduler instance
1547
+ * @param {HTMLElement} event.proxyElement Proxy element, representing future event
1548
+ * @param {object} event.context
1549
+ * @param {boolean} event.context.async Set true to handle drag create asynchronously (e.g. to wait for user confirmation)
1550
+ * @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
1551
+ */
1552
+ onBeforeDragCreateFinalize? : ((event: { source: Gantt, proxyElement: HTMLElement, context: { async: boolean, finalize: Function } }) => void)|string
1553
+ /**
1554
+ * Fires before an event is removed. Can be triggered by user pressing [DELETE] or [BACKSPACE] or by the
1555
+ * event editor. Return `false` to immediately veto the removal (or a `Promise` yielding `true` or `false`
1556
+ * for async vetoing).
1557
+ * ...
1558
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-beforeEventDelete)
1559
+ * @param {object} event Event object
1560
+ * @param {Scheduler.view.Scheduler,any} event.source The Scheduler instance
1561
+ * @param {Scheduler.model.SchedulerEventModel[]} event.eventRecords The records about to be deleted
1562
+ * @param {object} event.context Additional removal context:
1563
+ * @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.
1564
+ * @param {boolean} event.context.finalize.removeRecords Provide `false` to the function to prevent the removal.
1565
+ */
1566
+ onBeforeEventDelete? : ((event: { source: Scheduler|any, eventRecords: SchedulerEventModel[], context: { finalize: { removeRecords?: boolean } } }) => Promise<boolean>|boolean|void)|string
1567
+ /**
1568
+ * Fires on the owning Scheduler before an event is displayed in an editor.
1569
+ * This may be listened for to allow an application to take over event editing duties. Returning `false`
1570
+ * stops the default editing UI from being shown.
1571
+ * ...
1572
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-beforeEventEdit)
1573
+ * @param {object} event Event object
1574
+ * @param {Scheduler.view.Scheduler} event.source The scheduler
1575
+ * @param {Scheduler.feature.EventEdit} event.eventEdit The eventEdit feature
1576
+ * @param {Scheduler.model.SchedulerEventModel} event.eventRecord The record about to be shown in the event editor.
1577
+ * @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.
1578
+ * @param {HTMLElement} event.eventElement The element which represents the event in the scheduler display.
1579
+ */
1580
+ onBeforeEventEdit? : ((event: { source: Scheduler, eventEdit: EventEdit, eventRecord: SchedulerEventModel, resourceRecord: SchedulerResourceModel, eventElement: HTMLElement }) => Promise<boolean>|boolean|void)|string
1581
+ /**
1582
+ * Fires on the owning Scheduler when the editor for an event is available but before it is populated with
1583
+ * data and shown. Allows manipulating fields etc.
1584
+ * @param {object} event Event object
1585
+ * @param {Scheduler.view.Scheduler} event.source The scheduler
1586
+ * @param {Scheduler.feature.EventEdit} event.eventEdit The eventEdit feature
1587
+ * @param {Scheduler.model.SchedulerEventModel} event.eventRecord The record about to be shown in the event editor.
1588
+ * @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.
1589
+ * @param {HTMLElement} event.eventElement The element which represents the event in the scheduler display.
1590
+ * @param {Core.widget.Popup} event.editor The editor
1591
+ */
1592
+ onBeforeEventEditShow? : ((event: { source: Scheduler, eventEdit: EventEdit, eventRecord: SchedulerEventModel, resourceRecord: SchedulerResourceModel, eventElement: HTMLElement, editor: Popup }) => void)|string
1593
+ /**
1594
+ * Fired on the owning Scheduler before resizing starts. Return `false` to prevent the action.
1595
+ * @param {object} event Event object
1596
+ * @param {Scheduler.view.Scheduler} event.source Scheduler instance
1597
+ * @param {Scheduler.model.SchedulerEventModel} event.eventRecord Event record being resized
1598
+ * @param {Scheduler.model.SchedulerResourceModel} event.resourceRecord Resource record the resize starts within
1599
+ * @param {MouseEvent} event.event Browser event
1600
+ */
1601
+ onBeforeEventResize? : ((event: { source: Scheduler, eventRecord: SchedulerEventModel, resourceRecord: SchedulerResourceModel, event: MouseEvent }) => Promise<boolean>|boolean|void)|string
1602
+ /**
1603
+ * Fired on the owning Scheduler to allow implementer to prevent immediate finalization by returning a promise
1604
+ * in the listener, to show a confirmation popup etc
1605
+ * ...
1606
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-beforeEventResizeFinalize)
1607
+ * @param {object} event Event object
1608
+ * @param {Scheduler.view.Scheduler} event.source Scheduler instance
1609
+ * @param {object} event.context [DEPRECATED] de-nested to outer params object
1610
+ * @param {Scheduler.model.SchedulerEventModel} event.eventRecord Event record being resized
1611
+ * @param {Date} event.startDate New startDate (changed if resizing start side)
1612
+ * @param {Date} event.endDate New endDate (changed if resizing end side)
1613
+ * @param {Date} event.originalStartDate Start date before resize
1614
+ * @param {Date} event.originalEndDate End date before resize
1615
+ * @param {boolean} event.async Set true to handle resize asynchronously (e.g. to wait for user confirmation)
1616
+ * @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
1617
+ * @param {Event} event.event Browser event
1618
+ * @param {EventResizeData[]} event.resizeData Data of all events that are being resized
1619
+ */
1620
+ 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
1621
+ /**
1622
+ * Fires on the owning Scheduler or Gantt widget instance before an event record is saved, return `false` to prevent it.
1623
+ * ...
1624
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-beforeEventSave)
1625
+ * @param {object} event Event object
1626
+ * @param {SchedulerPro.view.SchedulerPro} event.source The Scheduler Pro instance
1627
+ * @param {SchedulerPro.model.EventModel} event.eventRecord The event record about to be saved
1628
+ * @param {SchedulerPro.widget.TaskEditorBase} event.editor The editor widget
1629
+ */
1630
+ onBeforeEventSave? : ((event: { source: SchedulerPro, eventRecord: EventModel, editor: TaskEditorBase }) => Promise<boolean>|boolean|void)|string
1631
+ /**
1632
+ * Fired on the owning Scheduler Pro before resizing starts. Return `false` to prevent the action.
1633
+ * @param {object} event Event object
1634
+ * @param {SchedulerPro.view.SchedulerPro} event.source Scheduler Pro instance
1635
+ * @param {SchedulerPro.model.EventModel} event.eventRecord Segment being resized
1636
+ * @param {SchedulerPro.model.SchedulerProResourceModel} event.resourceRecord Resource record the resize starts within
1637
+ * @param {MouseEvent} event.event Browser event
1638
+ */
1639
+ onBeforeEventSegmentResize? : ((event: { source: SchedulerPro, eventRecord: EventModel, resourceRecord: SchedulerProResourceModel, event: MouseEvent }) => Promise<boolean>|boolean|void)|string
1640
+ /**
1641
+ * Fired on the owning Scheduler Pro to allow implementer to prevent immediate finalization by setting
1642
+ * `data.context.async = true` in the listener, to show a confirmation popup etc
1643
+ * ...
1644
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-beforeEventSegmentResizeFinalize)
1645
+ * @param {object} event Event object
1646
+ * @param {SchedulerPro.view.SchedulerPro} event.source Scheduler Pro instance
1647
+ * @param {object} event.context
1648
+ * @param {boolean} event.context.async Set true to handle resize asynchronously (e.g. to wait for user confirmation)
1649
+ * @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
1650
+ */
1651
+ onBeforeEventSegmentResizeFinalize? : ((event: { source: SchedulerPro, context: { async: boolean, finalize: Function } }) => void)|string
1652
+ /**
1653
+ * Fires on the owning Grid before Excel export starts. Return `false` to cancel the export.
1654
+ * @param {object} event Event object
1655
+ * @param {ExportConfig} event.config Export config
1656
+ * @param {XLSColumn[]} event.columns An array of columns to export
1657
+ * @param {any[][]} event.rows An array of records to export
1658
+ */
1659
+ onBeforeExcelExport? : ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => Promise<boolean>|boolean|void)|string
1660
+ /**
1661
+ * Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
1662
+ * @param {object} event Event object
1663
+ * @param {Grid.util.GridLocation} event.cell Information about the column / record
1664
+ * @param {MouseEvent} event.domEvent The raw DOM event
1665
+ */
1666
+ onBeforeFillHandleDragStart? : ((event: { cell: GridLocation, domEvent: MouseEvent }) => Promise<boolean>|boolean|void)|string
1667
+ /**
1668
+ * 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.
1669
+ * @param {object} event Event object
1670
+ * @param {Grid.view.Grid} event.grid Target grid
1671
+ * @param {CellEditorContext} event.editorContext Editing context
1672
+ */
1673
+ onBeforeFinishCellEdit? : ((event: { grid: Grid, editorContext: CellEditorContext }) => void)|string
1674
+ /**
1675
+ * 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.
1676
+ * ...
1677
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-beforeFinishRowEdit)
1678
+ * @param {object} event Event object
1679
+ * @param {Grid.view.Grid} event.grid Target grid
1680
+ * @param {RowEditorContext} event.editorContext Editing context
1681
+ */
1682
+ onBeforeFinishRowEdit? : ((event: { grid: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string
1683
+ /**
1684
+ * Triggered before a widget is hidden. Return `false` to prevent the action.
1685
+ * @param {object} event Event object
1686
+ * @param {Core.widget.Widget} event.source The widget being hidden.
1687
+ */
1688
+ onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
1689
+ /**
1690
+ * Fires on the owning Gantt before export starts. Return `false` to cancel the export.
1691
+ * @param {object} event Event object
1692
+ * @param {object} event.config Export config
1693
+ */
1694
+ onBeforeMspExport? : ((event: { config: object }) => Promise<boolean>|boolean|void)|string
1695
+ /**
1696
+ * Fires on the owning Scheduler or Gantt widget before pan starts. Return `false` to prevent the operation.
1697
+ * @param {object} event Event object
1698
+ * @param {Event} event.event The native browser DOM event
1699
+ */
1700
+ onBeforePan? : ((event: { event: Event }) => Promise<boolean>|boolean|void)|string
1701
+ /**
1702
+ * Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
1703
+ * @param {object} event Event object
1704
+ * @param {Grid.view.Grid} event.source Owner grid
1705
+ * @param {string} event.clipboardData The clipboardData about to be pasted
1706
+ * @param {Grid.util.GridLocation} event.targetCell The cell from which the paste will be started
1707
+ * @param {string} event.entityName 'cell' to distinguish this event from other beforePaste events
1708
+ * @param {string} event.text The raw text from clipboard
1709
+ */
1710
+ onBeforePaste? : ((event: { source: Grid, clipboardData: string, targetCell: GridLocation, entityName: string, text: string }) => Promise<boolean>|boolean|void)|string
1711
+ /**
1712
+ * Fires on the owning Grid before export started. Return `false` to cancel the export.
1713
+ * @param {object} event Event object
1714
+ * @param {object} event.config Export config
1715
+ */
1716
+ onBeforePdfExport? : ((event: { config: object }) => Promise<boolean>|boolean|void)|string
1717
+ /**
1718
+ * Fired before the [viewPreset](https://bryntum.com/products/gantt/docs/api/Scheduler/view/mixin/TimelineViewPresets#config-viewPreset) is changed.
1719
+ * @param {object} event Event object
1720
+ * @param {Scheduler.view.Scheduler} event.source This Scheduler instance.
1721
+ * @param {Date} event.startDate The new start date of the timeline.
1722
+ * @param {Date} event.endDate The new end date of the timeline.
1723
+ * @param {Scheduler.preset.ViewPreset} event.from The outgoing ViewPreset.
1724
+ * @param {Scheduler.preset.ViewPreset} event.to The ViewPreset being switched to.
1725
+ */
1726
+ onBeforePresetChange? : ((event: { source: Scheduler, startDate: Date, endDate: Date, from: ViewPreset, to: ViewPreset }) => Promise<boolean>|boolean|void)|string
1727
+ /**
1728
+ * Fires on the owning Gantt widget instance before a project is displayed in the editor.
1729
+ * This may be listened to in order to take over the project editing flow. Returning `false`
1730
+ * stops the default editing UI from being shown.
1731
+ * ...
1732
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-beforeProjectEdit)
1733
+ * @param {object} event Event object
1734
+ * @param {Gantt.view.Gantt} event.source The Gantt instance
1735
+ * @param {Gantt.feature.ProjectEdit} event.projectEdit The projectEdit feature
1736
+ * @param {Gantt.model.ProjectModel} event.projectRecord The project about to be shown in the editor.
1737
+ */
1738
+ onBeforeProjectEdit? : ((event: { source: Gantt, projectEdit: ProjectEdit, projectRecord: ProjectModel }) => Promise<boolean>|boolean|void)|string
1739
+ /**
1740
+ * Fires on the owning Gantt widget when the editor for a project is available but
1741
+ * before it is shown. Allows manipulating fields etc.
1742
+ * @param {object} event Event object
1743
+ * @param {Gantt.view.Gantt} event.source The Gantt instance
1744
+ * @param {Gantt.feature.ProjectEdit} event.projectEdit The projectEdit feature
1745
+ * @param {Gantt.model.ProjectModel} event.projectRecord The project about to be shown in the editor.
1746
+ * @param {Gantt.widget.ProjectEditor} event.editor The editor
1747
+ */
1748
+ onBeforeProjectEditShow? : ((event: { source: Gantt, projectEdit: ProjectEdit, projectRecord: ProjectModel, editor: ProjectEditor }) => void)|string
1749
+ /**
1750
+ * Fires on the owning Gantt widget instance before a project is saved, return `false` to prevent it.
1751
+ * ...
1752
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-beforeProjectSave)
1753
+ * @param {object} event Event object
1754
+ * @param {Gantt.view.Gantt} event.source The Gantt instance
1755
+ * @param {Gantt.model.ProjectModel} event.projectRecord The project about to be saved
1756
+ * @param {Gantt.widget.ProjectEditor} event.editor The editor widget
1757
+ */
1758
+ onBeforeProjectSave? : ((event: { source: Gantt, projectRecord: ProjectModel, editor: ProjectEditor }) => Promise<boolean>|boolean|void)|string
1759
+ /**
1760
+ * Fires before a row is rendered.
1761
+ * @param {object} event Event object
1762
+ * @param {Grid.view.Grid} event.source The firing Grid instance.
1763
+ * @param {Grid.row.Row} event.row The row about to be rendered.
1764
+ * @param {Core.data.Model} event.record The record for the row.
1765
+ * @param {number} event.recordIndex The zero-based index of the record.
1766
+ */
1767
+ onBeforeRenderRow? : ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
1768
+ /**
1769
+ * Grid rows are about to be rendered
1770
+ * @param {object} event Event object
1771
+ * @param {Grid.view.Grid} event.source This grid.
1772
+ */
1773
+ onBeforeRenderRows? : ((event: { source: Grid }) => void)|string
1774
+ /**
1775
+ * This event fires before row collapse is started.
1776
+ * ...
1777
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-beforeRowCollapse)
1778
+ * @param {object} event Event object
1779
+ * @param {Core.data.Model} event.record Record
1780
+ */
1781
+ onBeforeRowCollapse? : ((event: { record: Model }) => Promise<boolean>|boolean|void)|string
1782
+ /**
1783
+ * This event fires before row expand is started.
1784
+ * ...
1785
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-beforeRowExpand)
1786
+ * @param {object} event Event object
1787
+ * @param {Core.data.Model} event.record Record
1788
+ */
1789
+ onBeforeRowExpand? : ((event: { record: Model }) => Promise<boolean>|boolean|void)|string
1790
+ /**
1791
+ * Fires before the selection changes. Returning `false` from a listener prevents the change
1792
+ * @param {object} event Event object
1793
+ * @param {string} event.action `'select'`/`'deselect'`
1794
+ * @param {'row','cell'} event.mode `'row'`/`'cell'`
1795
+ * @param {Grid.view.Grid} event.source
1796
+ * @param {Core.data.Model[]} event.deselected The records to be deselected in this operation.
1797
+ * @param {Core.data.Model[]} event.selected The records to be selected in this operation.
1798
+ * @param {Core.data.Model[]} event.selection The records in the current selection, before applying `selected` and `deselected`
1799
+ * @param {Grid.util.GridLocation[]} event.deselectedCells The cells to be deselected in this operation.
1800
+ * @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
1801
+ * @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
1802
+ */
1803
+ 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
1804
+ /**
1805
+ * Fired before this container will load record values into its child fields. This is useful if you
1806
+ * want to modify the UI before data is loaded (e.g. set some input field to be readonly)
1807
+ * @param {object} event Event object
1808
+ * @param {Core.widget.Container} event.source The container
1809
+ * @param {Core.data.Model} event.record The record
1810
+ */
1811
+ onBeforeSetRecord? : ((event: { source: Container, record: Model }) => void)|string
1812
+ /**
1813
+ * Triggered before a widget is shown. Return `false` to prevent the action.
1814
+ * @param {object} event Event object
1815
+ * @param {Core.widget.Widget,any} event.source The widget being shown
1816
+ */
1817
+ onBeforeShow? : ((event: { source: Widget|any }) => Promise<boolean>|boolean|void)|string
1818
+ /**
1819
+ * Fired on the owning Scheduler/Gantt before showing dependency terminals on a task or event. Return `false` to
1820
+ * prevent it
1821
+ * @param {object} event Event object
1822
+ * @param {Scheduler.model.TimeSpan} event.source The hovered task
1823
+ */
1824
+ onBeforeShowTerminals? : ((event: { source: TimeSpan }) => Promise<boolean>|boolean|void)|string
1825
+ /**
1826
+ * Fires on the owning Grid before editing starts, return `false` to prevent editing
1827
+ * @param {object} event Event object
1828
+ * @param {Grid.view.Grid} event.source Owner grid
1829
+ * @param {RowEditorContext} event.editorContext Editing context
1830
+ */
1831
+ onBeforeStartRowEdit? : ((event: { source: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string
1832
+ /**
1833
+ * Fired before state is applied to the source. Allows editing the state object or preventing the operation.
1834
+ * @param {object} event Event object
1835
+ * @param {GridStateInfo} event.state State object config
1836
+ */
1837
+ onBeforeStateApply? : ((event: { state: GridStateInfo }) => Promise<boolean>|boolean|void)|string
1838
+ /**
1839
+ * Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
1840
+ * @param {object} event Event object
1841
+ * @param {GridStateInfo} event.state State object config
1842
+ */
1843
+ onBeforeStateSave? : ((event: { state: GridStateInfo }) => Promise<boolean>|boolean|void)|string
1844
+ /**
1845
+ * Fires when adding a task from the UI to allow data mutation.
1846
+ * @param {object} event Event object
1847
+ * @param {Gantt.view.Gantt} event.source The Gantt instance
1848
+ * @param {Gantt.model.TaskModel} event.taskRecord The task
1849
+ */
1850
+ onBeforeTaskAdd? : ((event: { source: Gantt, taskRecord: TaskModel }) => void)|string
1851
+ /**
1852
+ * Fires on the owning Scheduler or Gantt widget before a task is deleted, return `false` to prevent it.
1853
+ * ...
1854
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-beforeTaskDelete)
1855
+ * @param {object} event Event object
1856
+ * @param {SchedulerPro.view.SchedulerPro} event.source The Scheduler Pro instance.
1857
+ * @param {SchedulerPro.model.EventModel} event.taskRecord The record about to be deleted
1858
+ * @param {SchedulerPro.widget.TaskEditorBase} event.editor The editor widget
1859
+ */
1860
+ onBeforeTaskDelete? : ((event: { source: SchedulerPro, taskRecord: EventModel, editor: TaskEditorBase }) => Promise<boolean>|boolean|void)|string
1861
+ /**
1862
+ * Fires on the owning Gantt before task dragging starts. Return false to prevent the action.
1863
+ * @param {object} event Event object
1864
+ * @param {Gantt.view.Gantt} event.source
1865
+ * @param {Gantt.model.TaskModel} event.taskRecord
1866
+ * @param {Event} event.event The native browser event
1867
+ */
1868
+ onBeforeTaskDrag? : ((event: { source: Gantt, taskRecord: TaskModel, event: Event }) => Promise<boolean>|boolean|void)|string
1869
+ /**
1870
+ * Fires on the owning Gantt to allow implementer to prevent immediate finalization by setting `data.context.async = true`
1871
+ * in the listener, to show a confirmation popup etc
1872
+ * ...
1873
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-beforeTaskDropFinalize)
1874
+ * @param {object} event Event object
1875
+ * @param {Gantt.view.Gantt} event.source Gantt instance
1876
+ * @param {object} event.context
1877
+ * @param {Gantt.model.TaskModel[]} event.context.taskRecords The dragged task records
1878
+ * @param {boolean} event.context.valid Set this to `false` to mark the drop as invalid
1879
+ * @param {boolean} event.context.async Set true to handle dragdrop asynchronously (e.g. to wait for user confirmation)
1880
+ * @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
1881
+ */
1882
+ onBeforeTaskDropFinalize? : ((event: { source: Gantt, context: { taskRecords: TaskModel[], valid: boolean, async: boolean, finalize: Function } }) => void)|string
1883
+ /**
1884
+ * Fires on the owning Scheduler or Gantt widget instance before a task is displayed in the editor.
1885
+ * This may be listened to in order to take over the task editing flow. Returning `false`
1886
+ * stops the default editing UI from being shown.
1887
+ * ...
1888
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-beforeTaskEdit)
1889
+ * @param {object} event Event object
1890
+ * @param {SchedulerPro.view.SchedulerPro} event.source The Scheduler Pro instance
1891
+ * @param {SchedulerPro.feature.SchedulerProTaskEdit} event.taskEdit The taskEdit feature
1892
+ * @param {SchedulerPro.model.EventModel} event.taskRecord The task about to be shown in the editor.
1893
+ * @param {HTMLElement} event.taskElement The element which represents the task
1894
+ */
1895
+ onBeforeTaskEdit? : ((event: { source: SchedulerPro, taskEdit: SchedulerProTaskEdit, taskRecord: EventModel, taskElement: HTMLElement }) => Promise<boolean>|boolean|void)|string
1896
+ /**
1897
+ * Fires on the owning Scheduler or Gantt widget when the editor for an event is available but before it is shown. Allows
1898
+ * manipulating fields etc.
1899
+ * @param {object} event Event object
1900
+ * @param {SchedulerPro.view.SchedulerPro} event.source The SchedulerPro instance
1901
+ * @param {SchedulerPro.feature.SchedulerProTaskEdit} event.taskEdit The taskEdit feature
1902
+ * @param {SchedulerPro.model.EventModel} event.taskRecord The task about to be shown in the editor.
1903
+ * @param {HTMLElement} event.eventElement The element which represents the task
1904
+ * @param {SchedulerPro.widget.TaskEditorBase} event.editor The editor
1905
+ */
1906
+ onBeforeTaskEditShow? : ((event: { source: SchedulerPro, taskEdit: SchedulerProTaskEdit, taskRecord: EventModel, eventElement: HTMLElement, editor: TaskEditorBase }) => void)|string
1907
+ /**
1908
+ * Fires on the owning Gantt before resizing starts. Return `false` to prevent the operation.
1909
+ * @param {object} event Event object
1910
+ * @param {Gantt.model.TaskModel} event.taskRecord
1911
+ * @param {Event} event.event
1912
+ */
1913
+ onBeforeTaskResize? : ((event: { taskRecord: TaskModel, event: Event }) => Promise<boolean>|boolean|void)|string
1914
+ /**
1915
+ * Fires on the owning Gantt to allow implementer to prevent immediate finalization by setting
1916
+ * `data.context.async = true` in the listener, to show a confirmation popup etc.
1917
+ * ...
1918
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-beforeTaskResizeFinalize)
1919
+ * @param {object} event Event object
1920
+ * @param {Gantt.model.TaskModel} event.taskRecord
1921
+ * @param {Gantt.view.Gantt} event.source Gantt instance
1922
+ * @param {object} event.context
1923
+ * @param {Date} event.context.endDate New endDate
1924
+ * @param {Date} event.context.originalEndDate End date before resize
1925
+ * @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`.
1926
+ * @param {Event} event.event Browser event
1927
+ * @param {boolean} event.context.async Set true to handle resize asynchronously (e.g. to wait for user confirmation)
1928
+ * @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
1929
+ */
1930
+ onBeforeTaskResizeFinalize? : ((event: { taskRecord: TaskModel, source: Gantt, context: { endDate: Date, originalEndDate: Date, resizeData: TaskResizeData[], async: boolean, finalize: Function }, event: Event }) => void)|string
1931
+ /**
1932
+ * Fires on the owning Scheduler or Gantt widget instance before a task is saved, return `false` to prevent it.
1933
+ * ...
1934
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-beforeTaskSave)
1935
+ * @param {object} event Event object
1936
+ * @param {SchedulerPro.view.SchedulerPro} event.source The Scheduler Pro instance
1937
+ * @param {SchedulerPro.model.EventModel} event.taskRecord The task about to be saved
1938
+ * @param {SchedulerPro.widget.TaskEditorBase} event.editor The editor widget
1939
+ */
1940
+ onBeforeTaskSave? : ((event: { source: SchedulerPro, taskRecord: EventModel, editor: TaskEditorBase }) => Promise<boolean>|boolean|void)|string
1941
+ /**
1942
+ * Fires on the owning Gantt before segment dragging starts. Return `false` to prevent the action.
1943
+ * @param {object} event Event object
1944
+ * @param {Gantt.view.Gantt} event.source
1945
+ * @param {Gantt.model.TaskModel} event.taskRecord The segment about to be dragged
1946
+ * @param {Event} event.event The native browser event
1947
+ */
1948
+ onBeforeTaskSegmentDrag? : ((event: { source: Gantt, taskRecord: TaskModel, event: Event }) => Promise<boolean>|boolean|void)|string
1949
+ /**
1950
+ * Fires on the owning Gantt to allow implementer to prevent immediate finalization by setting `data.context.async = true`
1951
+ * in the listener, to show a confirmation popup etc
1952
+ * ...
1953
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-beforeTaskSegmentDropFinalize)
1954
+ * @param {object} event Event object
1955
+ * @param {Gantt.view.Gantt} event.source Gantt instance
1956
+ * @param {object} event.context
1957
+ * @param {Gantt.model.TaskModel[]} event.context.taskRecords Dragged segments
1958
+ * @param {boolean} event.context.valid Set this to `false` to mark the drop as invalid
1959
+ * @param {boolean} event.context.async Set true to handle dragdrop asynchronously (e.g. to wait for user confirmation)
1960
+ * @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
1961
+ */
1962
+ onBeforeTaskSegmentDropFinalize? : ((event: { source: Gantt, context: { taskRecords: TaskModel[], valid: boolean, async: boolean, finalize: Function } }) => void)|string
1963
+ /**
1964
+ * Fired on the owning Gantt before resizing starts. Return `false` to prevent the action.
1965
+ * @param {object} event Event object
1966
+ * @param {Gantt.view.Gantt} event.source Gantt instance
1967
+ * @param {Gantt.model.TaskModel} event.taskRecord Segment being resized
1968
+ * @param {Scheduler.model.SchedulerResourceModel} event.resourceRecord Resource record the resize starts within
1969
+ * @param {MouseEvent} event.event Browser event
1970
+ */
1971
+ onBeforeTaskSegmentResize? : ((event: { source: Gantt, taskRecord: TaskModel, resourceRecord: SchedulerResourceModel, event: MouseEvent }) => Promise<boolean>|boolean|void)|string
1972
+ /**
1973
+ * Fired on the owning Gantt to allow implementer to prevent immediate finalization by setting
1974
+ * `data.context.async = true` in the listener, to show a confirmation popup etc.
1975
+ * ...
1976
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-beforeTaskSegmentResizeFinalize)
1977
+ * @param {object} event Event object
1978
+ * @param {Gantt.view.Gantt} event.source Gantt instance
1979
+ * @param {object} event.context
1980
+ * @param {boolean} event.context.async Set true to handle resize asynchronously (e.g. to wait for user confirmation)
1981
+ * @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
1982
+ */
1983
+ onBeforeTaskSegmentResizeFinalize? : ((event: { source: Gantt, context: { async: boolean, finalize: Function } }) => void)|string
1984
+ /**
1985
+ * Fired when a group is going to be expanded or collapsed using the UI.
1986
+ * Returning `false` from a listener prevents the operation
1987
+ * @param {object} event Event object
1988
+ * @param {Core.data.Model} event.groupRecord [DEPRECATED] Use `groupRecords` param instead
1989
+ * @param {Core.data.Model[]} event.groupRecords The group records being toggled
1990
+ * @param {boolean} event.collapse Collapsed (true) or expanded (false)
1991
+ * @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
1992
+ */
1993
+ onBeforeToggleGroup? : ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => Promise<boolean>|boolean|void)|string
1994
+ /**
1995
+ * Fired before a parent node record toggles its collapsed state.
1996
+ * @param {object} event Event object
1997
+ * @param {Grid.view.Grid} event.source The firing Grid instance.
1998
+ * @param {Core.data.Model} event.record The record being toggled.
1999
+ * @param {boolean} event.collapse `true` if the node is being collapsed.
2000
+ */
2001
+ onBeforeToggleNode? : ((event: { source: Grid, record: Model, collapse: boolean }) => void)|string
2002
+ /**
2003
+ * Fires on the owning Grid when editing is cancelled
2004
+ * @param {object} event Event object
2005
+ * @param {Grid.view.Grid} event.source Owner grid
2006
+ * @param {Grid.util.GridLocation} event.editorContext Editing context
2007
+ * @param {Event} event.event Included if the cancellation was triggered by a DOM event
2008
+ */
2009
+ onCancelCellEdit? : ((event: { source: Grid, editorContext: GridLocation, event: Event }) => void)|string
2010
+ /**
2011
+ * Fires when any other event is fired from the object.
2012
+ * ...
2013
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-catchAll)
2014
+ * @param {object} event Event object
2015
+ * @param {{[key: string]: any, type: string}} event.event The Object that contains event details
2016
+ * @param {string} event.event.type The type of the event which is caught by the listener
2017
+ */
2018
+ onCatchAll? : ((event: {[key: string]: any, type: string}) => void)|string
2019
+ /**
2020
+ * Fired when user clicks in a grid cell
2021
+ * @param {object} event Event object
2022
+ * @param {Grid.view.Grid} event.grid The grid instance
2023
+ * @param {Core.data.Model} event.record The record representing the row
2024
+ * @param {Grid.column.Column} event.column The column to which the cell belongs
2025
+ * @param {HTMLElement} event.cellElement The cell HTML element
2026
+ * @param {HTMLElement} event.target The target element
2027
+ * @param {MouseEvent} event.event The native DOM event
2028
+ */
2029
+ onCellClick? : ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string
2030
+ /**
2031
+ * Fired when user activates contextmenu in a grid cell
2032
+ * @param {object} event Event object
2033
+ * @param {Grid.view.Grid} event.grid The grid instance
2034
+ * @param {Core.data.Model} event.record The record representing the row
2035
+ * @param {Grid.column.Column} event.column The column to which the cell belongs
2036
+ * @param {HTMLElement} event.cellElement The cell HTML element
2037
+ * @param {HTMLElement} event.target The target element
2038
+ * @param {MouseEvent} event.event The native DOM event
2039
+ */
2040
+ onCellContextMenu? : ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string
2041
+ /**
2042
+ * Fired when user double clicks a grid cell
2043
+ * @param {object} event Event object
2044
+ * @param {Grid.view.Grid} event.grid The grid instance
2045
+ * @param {Core.data.Model} event.record The record representing the row
2046
+ * @param {Grid.column.Column} event.column The column to which the cell belongs
2047
+ * @param {HTMLElement} event.cellElement The cell HTML element
2048
+ * @param {HTMLElement} event.target The target element
2049
+ * @param {MouseEvent} event.event The native DOM event
2050
+ */
2051
+ onCellDblClick? : ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string
2052
+ /**
2053
+ * This event fires on the owning grid before the context menu is shown for a cell.
2054
+ * 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).
2055
+ * ...
2056
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-cellMenuBeforeShow)
2057
+ * @param {object} event Event object
2058
+ * @param {Grid.view.Grid} event.source The grid
2059
+ * @param {Core.widget.Menu} event.menu The menu
2060
+ * @param {Record<string, MenuItemEntry>} event.items Menu item configs
2061
+ * @param {Grid.column.Column} event.column Column
2062
+ * @param {Core.data.Model} event.record Record
2063
+ */
2064
+ onCellMenuBeforeShow? : ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => Promise<boolean>|boolean|void)|string
2065
+ /**
2066
+ * This event fires on the owning grid when an item is selected in the cell context menu.
2067
+ * @param {object} event Event object
2068
+ * @param {Grid.view.Grid} event.source The grid
2069
+ * @param {Core.widget.Menu} event.menu The menu
2070
+ * @param {Core.widget.MenuItem} event.item Selected menu item
2071
+ * @param {Grid.column.Column} event.column Column
2072
+ * @param {Core.data.Model} event.record Record
2073
+ */
2074
+ onCellMenuItem? : ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column, record: Model }) => void)|string
2075
+ /**
2076
+ * This event fires on the owning grid after the context menu is shown for a cell.
2077
+ * @param {object} event Event object
2078
+ * @param {Grid.view.Grid} event.source The grid
2079
+ * @param {Core.widget.Menu} event.menu The menu
2080
+ * @param {Record<string, MenuItemEntry>} event.items Menu item configs
2081
+ * @param {Grid.column.Column} event.column Column
2082
+ * @param {Core.data.Model} event.record Record
2083
+ */
2084
+ onCellMenuShow? : ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => void)|string
2085
+ /**
2086
+ * This event fires on the owning grid when a check item is toggled in the cell context menu.
2087
+ * @param {object} event Event object
2088
+ * @param {Grid.view.Grid} event.source The grid
2089
+ * @param {Core.widget.Menu} event.menu The menu
2090
+ * @param {Core.widget.MenuItem} event.item Selected menu item
2091
+ * @param {Grid.column.Column} event.column Column
2092
+ * @param {Core.data.Model} event.record Record
2093
+ * @param {boolean} event.checked Checked or not
2094
+ */
2095
+ onCellMenuToggleItem? : ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column, record: Model, checked: boolean }) => void)|string
2096
+ /**
2097
+ * Fired when the mouse enters a cell
2098
+ * @param {object} event Event object
2099
+ * @param {Grid.view.Grid} event.source The grid instance
2100
+ * @param {Core.data.Model} event.record The record representing the hovered cell
2101
+ * @param {Grid.column.Column} event.column The column currently hovered
2102
+ * @param {HTMLElement} event.cellElement The cell HTML element
2103
+ * @param {MouseEvent} event.event The native DOM event
2104
+ */
2105
+ onCellMouseEnter? : ((event: { source: Grid, record: Model, column: Column, cellElement: HTMLElement, event: MouseEvent }) => void)|string
2106
+ /**
2107
+ * Fired when the mouse leaves a cell
2108
+ * @param {object} event Event object
2109
+ * @param {Grid.view.Grid} event.source The grid instance
2110
+ * @param {Core.data.Model} event.record The record representing the cell that the mouse left
2111
+ * @param {Grid.column.Column} event.column The column representing the cell that the mouse left
2112
+ * @param {HTMLElement} event.cellElement The cell HTML element that the mouse left
2113
+ * @param {MouseEvent} event.event The native DOM event
2114
+ */
2115
+ onCellMouseLeave? : ((event: { source: Grid, record: Model, column: Column, cellElement: HTMLElement, event: MouseEvent }) => void)|string
2116
+ /**
2117
+ * Fired when a user moves the mouse out of a grid cell
2118
+ * @param {object} event Event object
2119
+ * @param {Grid.view.Grid} event.grid The grid instance
2120
+ * @param {Core.data.Model} event.record The record representing the row
2121
+ * @param {Grid.column.Column} event.column The column to which the cell belongs
2122
+ * @param {HTMLElement} event.cellElement The cell HTML element
2123
+ * @param {HTMLElement} event.target The target element
2124
+ * @param {MouseEvent} event.event The native DOM event
2125
+ */
2126
+ onCellMouseOut? : ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string
2127
+ /**
2128
+ * Fired when user moves the mouse over a grid cell
2129
+ * @param {object} event Event object
2130
+ * @param {Grid.view.Grid} event.grid The grid instance
2131
+ * @param {Core.data.Model} event.record The record representing the row
2132
+ * @param {Grid.column.Column} event.column The column to which the cell belongs
2133
+ * @param {HTMLElement} event.cellElement The cell HTML element
2134
+ * @param {HTMLElement} event.target The target element
2135
+ * @param {MouseEvent} event.event The native DOM event
2136
+ */
2137
+ onCellMouseOver? : ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string
2138
+ /**
2139
+ * Fires when a Panel is collapsed using the [collapsible](https://bryntum.com/products/gantt/docs/api/Core/widget/Panel#config-collapsible) setting.
2140
+ * @param {object} event Event object
2141
+ * @param {Core.widget.Panel} event.source This Panel.
2142
+ */
2143
+ onCollapse? : ((event: { source: Panel }) => void)|string
2144
+ /**
2145
+ * Fired before a parent node record is collapsed.
2146
+ * @param {object} event Event object
2147
+ * @param {Grid.view.Grid} event.source The firing Grid instance.
2148
+ * @param {Core.data.Model} event.record The record which has been collapsed.
2149
+ */
2150
+ onCollapseNode? : ((event: { source: Grid, record: Model }) => void)|string
2151
+ /**
2152
+ * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
2153
+ * to indicate whether the drop position is valid or not.
2154
+ * @param {object} event Event object
2155
+ * @param {Grid.view.Grid} event.source The grid instance.
2156
+ * @param {Grid.column.Column} event.column The dragged column.
2157
+ * @param {Grid.column.Column} event.insertBefore The column before which the dragged column will be inserted (if not last).
2158
+ * @param {Event} event.event The browser event.
2159
+ * @param {object} event.context
2160
+ * @param {boolean} event.context.valid Set this to `true` or `false` to indicate whether the drop position is valid.
2161
+ */
2162
+ onColumnDrag? : ((event: { source: Grid, column: Column, insertBefore: Column, event: Event, context: { valid: boolean } }) => void)|string
2163
+ /**
2164
+ * This event is fired when a column drag gesture has started.
2165
+ * @param {object} event Event object
2166
+ * @param {Grid.view.Grid} event.source The grid instance.
2167
+ * @param {Grid.column.Column} event.column The dragged column.
2168
+ * @param {Event} event.event The browser event.
2169
+ */
2170
+ onColumnDragStart? : ((event: { source: Grid, column: Column, event: Event }) => void)|string
2171
+ /**
2172
+ * This event is always fired after a column is dropped. The `valid` param is `true` if the operation was not
2173
+ * vetoed and the column was moved in the column store.
2174
+ * @param {object} event Event object
2175
+ * @param {Grid.view.Grid} event.source The grid instance.
2176
+ * @param {Grid.column.Column} event.column The dragged column.
2177
+ * @param {Grid.column.Column} event.insertBefore The column before which the dragged column will be inserted.
2178
+ * @param {Grid.column.Column} event.newParent The new parent column.
2179
+ * @param {boolean} event.valid `true` if the operation was not vetoed.
2180
+ * @param {Event} event.event The browser event.
2181
+ * @param {string} event.region The region where the column was dropped.
2182
+ */
2183
+ onColumnDrop? : ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => Promise<boolean>|boolean|void)|string
2184
+ /**
2185
+ * This event is fired after a resize gesture is completed.
2186
+ * @param {object} event Event object
2187
+ * @param {Grid.view.Grid} event.source The grid instance
2188
+ * @param {Grid.column.Column} event.column The resized column
2189
+ * @param {Event} event.domEvent The browser event
2190
+ */
2191
+ onColumnResize? : ((event: { source: Grid, column: Column, domEvent: Event }) => void)|string
2192
+ /**
2193
+ * This event is fired when a column resize gesture starts.
2194
+ * @param {object} event Event object
2195
+ * @param {Grid.view.Grid} event.source The grid instance
2196
+ * @param {Grid.column.Column} event.column The column
2197
+ * @param {Event} event.domEvent The browser event
2198
+ */
2199
+ onColumnResizeStart? : ((event: { source: Grid, column: Column, domEvent: Event }) => void)|string
2200
+ /**
2201
+ * This event fires on the owning widget when an item is selected in the context menu.
2202
+ * @param {object} event Event object
2203
+ * @param {Core.widget.Widget} event.source The owning widget
2204
+ * @param {Core.widget.Menu} event.menu The menu
2205
+ * @param {Core.widget.MenuItem} event.item Selected menu item
2206
+ */
2207
+ onContextMenuItem? : ((event: { source: Widget, menu: Menu, item: MenuItem }) => void)|string
2208
+ /**
2209
+ * This event fires on the owning widget when a check item is toggled in the context menu.
2210
+ * @param {object} event Event object
2211
+ * @param {Core.widget.Widget} event.source The owning widget
2212
+ * @param {Core.widget.Menu} event.menu The menu
2213
+ * @param {Core.widget.MenuItem} event.item Selected menu item
2214
+ * @param {boolean} event.checked Checked or not
2215
+ */
2216
+ onContextMenuToggleItem? : ((event: { source: Widget, menu: Menu, item: MenuItem, checked: boolean }) => void)|string
2217
+ /**
2218
+ * Fires on the owning Grid after a copy action is performed.
2219
+ * @param {object} event Event object
2220
+ * @param {Grid.view.Grid} event.source Owner grid
2221
+ * @param {Grid.util.GridLocation[]} event.cells The cells about to be copied or cut
2222
+ * @param {string} event.copiedDataString The concatenated data string that was copied or cut
2223
+ * @param {boolean} event.isCut `true` if this was a cut action
2224
+ * @param {string} event.entityName 'cell' to distinguish this event from other copy events
2225
+ */
2226
+ onCopy? : ((event: { source: Grid, cells: GridLocation[], copiedDataString: string, isCut: boolean, entityName: string }) => void)|string
2227
+ /**
2228
+ * Fired when critical paths get highlighted.
2229
+ * ...
2230
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-criticalPathsHighlighted)
2231
+ */
2232
+ onCriticalPathsHighlighted? : (() => void)|string
2233
+ /**
2234
+ * Fired when critical paths get hidden.
2235
+ * ...
2236
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-criticalPathsUnhighlighted)
2237
+ */
2238
+ onCriticalPathsUnhighlighted? : (() => void)|string
2239
+ /**
2240
+ * 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)).
2241
+ * @param {object} event Event object
2242
+ * @param {Scheduler.view.Scheduler} event.source The scheduler
2243
+ * @param {Date} event.date The current date
2244
+ */
2245
+ onCurrentTimelineUpdate? : ((event: { source: Scheduler, date: Date }) => void)|string
2246
+ /**
2247
+ * Fired when data in the store changes.
2248
+ * ...
2249
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-dataChange)
2250
+ * @param {object} event Event object
2251
+ * @param {Grid.view.Grid} event.source Owning grid
2252
+ * @param {Core.data.Store} event.store The originating store
2253
+ * @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'`
2254
+ * @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
2255
+ * @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
2256
+ * @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
2257
+ */
2258
+ onDataChange? : ((event: { source: Grid, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
2259
+ /**
2260
+ * Fired when the range of dates encapsulated by the UI changes. This will be when
2261
+ * moving a view in time by reconfiguring its [timeAxis](https://bryntum.com/products/gantt/docs/api/Scheduler/view/TimelineBase#config-timeAxis). This will happen
2262
+ * when zooming, or changing [viewPreset](https://bryntum.com/products/gantt/docs/api/Scheduler/view/TimelineBase#config-viewPreset).
2263
+ * ...
2264
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-dateRangeChange)
2265
+ * @param {object} event Event object
2266
+ * @param {Scheduler.view.TimelineBase} event.source This Scheduler/Gantt instance.
2267
+ * @param {object} event.old The old date range
2268
+ * @param {Date} event.old.startDate the old start date.
2269
+ * @param {Date} event.old.endDate the old end date.
2270
+ * @param {object} event.new The new date range
2271
+ * @param {Date} event.new.startDate the new start date.
2272
+ * @param {Date} event.new.endDate the new end date.
2273
+ */
2274
+ onDateRangeChange? : ((event: { source: TimelineBase, old: { startDate: Date, endDate: Date }, new: { startDate: Date, endDate: Date } }) => void)|string
2275
+ /**
2276
+ * Fired when dependencies are rendered
2277
+ */
2278
+ onDependenciesDrawn? : (() => void)|string
2279
+ /**
2280
+ * Fires on the owning Scheduler/Gantt when a click is registered on a dependency line.
2281
+ * @param {object} event Event object
2282
+ * @param {Scheduler.view.Scheduler} event.source The scheduler
2283
+ * @param {Scheduler.model.SchedulerDependencyModel} event.dependency
2284
+ * @param {MouseEvent} event.event
2285
+ */
2286
+ onDependencyClick? : ((event: { source: Scheduler, dependency: SchedulerDependencyModel, event: MouseEvent }) => void)|string
2287
+ /**
2288
+ * Fires on the owning Scheduler/Gantt when a context menu event is registered on a dependency line.
2289
+ * @param {object} event Event object
2290
+ * @param {Scheduler.view.Scheduler} event.source The scheduler
2291
+ * @param {Scheduler.model.SchedulerDependencyModel} event.dependency
2292
+ * @param {MouseEvent} event.event
2293
+ */
2294
+ onDependencyContextMenu? : ((event: { source: Scheduler, dependency: SchedulerDependencyModel, event: MouseEvent }) => void)|string
2295
+ /**
2296
+ * Fired on the owning Scheduler/Gantt when a dependency creation drag operation starts
2297
+ * @param {object} event Event object
2298
+ * @param {Scheduler.model.TimeSpan} event.source The source task
2299
+ */
2300
+ onDependencyCreateDragStart? : ((event: { source: TimeSpan }) => void)|string
2301
+ /**
2302
+ * Fired on the owning Scheduler/Gantt when a dependency drag creation operation succeeds
2303
+ * @param {object} event Event object
2304
+ * @param {Scheduler.model.TimeSpan} event.source The source task
2305
+ * @param {Scheduler.model.TimeSpan} event.target The target task
2306
+ * @param {Scheduler.model.DependencyBaseModel} event.dependency The created dependency
2307
+ */
2308
+ onDependencyCreateDrop? : ((event: { source: TimeSpan, target: TimeSpan, dependency: DependencyBaseModel }) => void)|string
2309
+ /**
2310
+ * Fires on the owning Scheduler/Gantt when a double click is registered on a dependency line.
2311
+ * @param {object} event Event object
2312
+ * @param {Scheduler.view.Scheduler} event.source The scheduler
2313
+ * @param {Scheduler.model.SchedulerDependencyModel} event.dependency
2314
+ * @param {MouseEvent} event.event
2315
+ */
2316
+ onDependencyDblClick? : ((event: { source: Scheduler, dependency: SchedulerDependencyModel, event: MouseEvent }) => void)|string
2317
+ /**
2318
+ * Fires on the owning Scheduler/Gantt when the mouse moves out of a dependency line.
2319
+ * @param {object} event Event object
2320
+ * @param {Scheduler.view.Scheduler} event.source The scheduler
2321
+ * @param {Scheduler.model.SchedulerDependencyModel} event.dependency
2322
+ * @param {MouseEvent} event.event
2323
+ */
2324
+ onDependencyMouseOut? : ((event: { source: Scheduler, dependency: SchedulerDependencyModel, event: MouseEvent }) => void)|string
2325
+ /**
2326
+ * Fires on the owning Scheduler/Gantt when the mouse moves over a dependency line.
2327
+ * @param {object} event Event object
2328
+ * @param {Scheduler.view.Scheduler} event.source The scheduler
2329
+ * @param {Scheduler.model.SchedulerDependencyModel} event.dependency
2330
+ * @param {MouseEvent} event.event
2331
+ */
2332
+ onDependencyMouseOver? : ((event: { source: Scheduler, dependency: SchedulerDependencyModel, event: MouseEvent }) => void)|string
2333
+ /**
2334
+ * Fired on the owning Scheduler/Gantt when asynchronous dependency validation completes
2335
+ * @param {object} event Event object
2336
+ * @param {Scheduler.model.TimeSpan} event.source The source task
2337
+ * @param {Scheduler.model.TimeSpan} event.target The target task
2338
+ * @param {number} event.dependencyType The dependency type, see [Type](https://bryntum.com/products/gantt/docs/api/Scheduler/model/DependencyBaseModel#property-Type-static)
2339
+ */
2340
+ onDependencyValidationComplete? : ((event: { source: TimeSpan, target: TimeSpan, dependencyType: number }) => void)|string
2341
+ /**
2342
+ * Fired on the owning Scheduler/Gantt when asynchronous dependency validation starts
2343
+ * @param {object} event Event object
2344
+ * @param {Scheduler.model.TimeSpan} event.source The source task
2345
+ * @param {Scheduler.model.TimeSpan} event.target The target task
2346
+ * @param {number} event.dependencyType The dependency type, see [Type](https://bryntum.com/products/gantt/docs/api/Scheduler/model/DependencyBaseModel#property-Type-static)
2347
+ */
2348
+ onDependencyValidationStart? : ((event: { source: TimeSpan, target: TimeSpan, dependencyType: number }) => void)|string
2349
+ /**
2350
+ * Fires when an object is destroyed.
2351
+ * @param {object} event Event object
2352
+ * @param {Core.Base} event.source The Object that is being destroyed.
2353
+ */
2354
+ onDestroy? : ((event: { source: Base }) => void)|string
2355
+ /**
2356
+ * 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
2357
+ * @param {object} event Event object
2358
+ * @param {Core.widget.Container} event.source The container.
2359
+ * @param {boolean} event.dirty The dirty state of the Container - `true` if there are any fields which have been changed since initial load.
2360
+ */
2361
+ onDirtyStateChange? : ((event: { source: Container, dirty: boolean }) => void)|string
2362
+ /**
2363
+ * Fires on the owning Gantt after the task has been scheduled.
2364
+ * @param {object} event Event object
2365
+ * @param {Gantt.view.Gantt} event.source
2366
+ * @param {Gantt.model.TaskModel} event.taskRecord
2367
+ * @param {MouseEvent} event.event The ending mouseup event.
2368
+ * @param {HTMLElement} event.proxyElement The proxy element showing the drag creation zone.
2369
+ */
2370
+ onDragCreateEnd? : ((event: { source: Gantt, taskRecord: TaskModel, event: MouseEvent, proxyElement: HTMLElement }) => void)|string
2371
+ /**
2372
+ * Fires on the owning Gantt after the drag start has created a proxy element.
2373
+ * @param {object} event Event object
2374
+ * @param {Gantt.view.Gantt} event.source
2375
+ * @param {HTMLElement} event.proxyElement The proxy representing the new event.
2376
+ */
2377
+ onDragCreateStart? : ((event: { source: Gantt, proxyElement: HTMLElement }) => void)|string
2378
+ /**
2379
+ * Fires while drag selecting. UI will update with current range, but the cells will not be selected until
2380
+ * mouse up. This event can be listened for to perform actions while drag selecting.
2381
+ * @param {object} event Event object
2382
+ * @param {Grid.view.Grid} event.source
2383
+ * @param {GridLocationConfig[],Grid.util.GridLocation[]} event.selectedCells The cells that is currently being dragged over
2384
+ * @param {Core.data.Model[]} event.selectedRecords The records that is currently being dragged over
2385
+ */
2386
+ onDragSelecting? : ((event: { source: Grid, selectedCells: GridLocationConfig[]|GridLocation[], selectedRecords: Model[] }) => void)|string
2387
+ /**
2388
+ * Triggered when a widget's [element](https://bryntum.com/products/gantt/docs/api/Core/widget/Widget#property-element) is available.
2389
+ * @param {object} event Event object
2390
+ * @param {HTMLElement} event.element The Widget's element.
2391
+ */
2392
+ onElementCreated? : ((event: { element: HTMLElement }) => void)|string
2393
+ /**
2394
+ * Fired before the editor will load the event record data into its input fields. This is useful if you
2395
+ * want to modify the fields before data is loaded (e.g. set some input field to be readonly)
2396
+ * @param {object} event Event object
2397
+ * @param {Core.widget.Container} event.source The editor widget
2398
+ * @param {Scheduler.model.SchedulerEventModel} event.record The record
2399
+ */
2400
+ onEventEditBeforeSetRecord? : ((event: { source: Container, record: SchedulerEventModel }) => void)|string
2401
+ /**
2402
+ * This event fires on the owning Scheduler before the context menu is shown for an event. Allows manipulation of the items
2403
+ * to show in the same way as in `processItems`. Returning `false` from a listener prevents the menu from
2404
+ * being shown.
2405
+ * @param {object} event Event object
2406
+ * @param {Scheduler.view.Scheduler} event.source
2407
+ * @param {Record<string, MenuItemEntry>} event.items Menu item configs
2408
+ * @param {Scheduler.model.SchedulerEventModel} event.eventRecord Event record for which the menu was triggered
2409
+ * @param {Scheduler.model.SchedulerResourceModel} event.resourceRecord Resource record
2410
+ * @param {Scheduler.model.SchedulerAssignmentModel} event.assignmentRecord Assignment record, if assignments are used
2411
+ * @param {HTMLElement} event.eventElement
2412
+ * @param {MouseEvent} event.event Pointer event which triggered the context menu (if any)
2413
+ */
2414
+ onEventMenuBeforeShow? : ((event: { source: Scheduler, items: Record<string, MenuItemEntry>, eventRecord: SchedulerEventModel, resourceRecord: SchedulerResourceModel, assignmentRecord: SchedulerAssignmentModel, eventElement: HTMLElement, event?: MouseEvent }) => Promise<boolean>|boolean|void)|string
2415
+ /**
2416
+ * This event fires on the owning Scheduler when an item is selected in the context menu.
2417
+ * @param {object} event Event object
2418
+ * @param {Scheduler.view.Scheduler} event.source
2419
+ * @param {Core.widget.MenuItem} event.item
2420
+ * @param {Scheduler.model.SchedulerEventModel} event.eventRecord
2421
+ * @param {Scheduler.model.SchedulerResourceModel} event.resourceRecord
2422
+ * @param {Scheduler.model.SchedulerAssignmentModel} event.assignmentRecord Assignment record, if assignments are used
2423
+ * @param {HTMLElement} event.eventElement
2424
+ */
2425
+ onEventMenuItem? : ((event: { source: Scheduler, item: MenuItem, eventRecord: SchedulerEventModel, resourceRecord: SchedulerResourceModel, assignmentRecord: SchedulerAssignmentModel, eventElement: HTMLElement }) => void)|string
2426
+ /**
2427
+ * This event fires on the owning Scheduler after showing the context menu for an event
2428
+ * @param {object} event Event object
2429
+ * @param {Scheduler.view.Scheduler} event.source
2430
+ * @param {Core.widget.Menu} event.menu The menu
2431
+ * @param {Scheduler.model.SchedulerEventModel} event.eventRecord Event record for which the menu was triggered
2432
+ * @param {Scheduler.model.SchedulerResourceModel} event.resourceRecord Resource record
2433
+ * @param {Scheduler.model.SchedulerAssignmentModel} event.assignmentRecord Assignment record, if assignments are used
2434
+ * @param {HTMLElement} event.eventElement
2435
+ */
2436
+ onEventMenuShow? : ((event: { source: Scheduler, menu: Menu, eventRecord: SchedulerEventModel, resourceRecord: SchedulerResourceModel, assignmentRecord: SchedulerAssignmentModel, eventElement: HTMLElement }) => void)|string
2437
+ /**
2438
+ * Fires on the owning Scheduler on each resize move event
2439
+ * @param {object} event Event object
2440
+ * @param {Scheduler.view.Scheduler} event.source Scheduler instance
2441
+ * @param {Scheduler.model.SchedulerEventModel} event.eventRecord Event record being resized
2442
+ * @param {Date} event.startDate
2443
+ * @param {Date} event.endDate
2444
+ * @param {HTMLElement} event.element
2445
+ * @param {EventResizeData[]} event.resizeData Resize data for selected events
2446
+ */
2447
+ onEventPartialResize? : ((event: { source: Scheduler, eventRecord: SchedulerEventModel, startDate: Date, endDate: Date, element: HTMLElement, resizeData: EventResizeData[] }) => void)|string
2448
+ /**
2449
+ * Fires on the owning Scheduler after the resizing gesture has finished.
2450
+ * @param {object} event Event object
2451
+ * @param {Scheduler.view.Scheduler} event.source Scheduler instance
2452
+ * @param {boolean} event.changed Shows if the record has been changed by the resize action
2453
+ * @param {Scheduler.model.SchedulerEventModel} event.eventRecord Event record being resized
2454
+ * @param {EventResizeData[]} event.resizeData Resize data for selected events
2455
+ */
2456
+ onEventResizeEnd? : ((event: { source: Scheduler, changed: boolean, eventRecord: SchedulerEventModel, resizeData: EventResizeData[] }) => void)|string
2457
+ /**
2458
+ * Fires on the owning Scheduler when event resizing starts
2459
+ * @param {object} event Event object
2460
+ * @param {Scheduler.view.Scheduler} event.source Scheduler instance
2461
+ * @param {Scheduler.model.SchedulerEventModel} event.eventRecord Event record being resized
2462
+ * @param {Scheduler.model.SchedulerResourceModel} event.resourceRecord Resource record the resize starts within
2463
+ * @param {MouseEvent} event.event Browser event
2464
+ * @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`
2465
+ */
2466
+ onEventResizeStart? : ((event: { source: Scheduler, eventRecord: SchedulerEventModel, resourceRecord: SchedulerResourceModel, event: MouseEvent, resizeData: EventResizeData[] }) => void)|string
2467
+ /**
2468
+ * Fires on the owning Scheduler Pro on each segment resize move event
2469
+ * @param {object} event Event object
2470
+ * @param {SchedulerPro.view.SchedulerPro} event.source Scheduler Pro instance
2471
+ * @param {SchedulerPro.model.EventModel} event.eventRecord Segment being resized
2472
+ * @param {Date} event.startDate
2473
+ * @param {Date} event.endDate
2474
+ * @param {HTMLElement} event.element
2475
+ */
2476
+ onEventSegmentPartialResize? : ((event: { source: SchedulerPro, eventRecord: EventModel, startDate: Date, endDate: Date, element: HTMLElement }) => void)|string
2477
+ /**
2478
+ * Fires on the owning Scheduler Pro after the resizing gesture has finished.
2479
+ * @param {object} event Event object
2480
+ * @param {SchedulerPro.view.SchedulerPro} event.source Scheduler Pro instance
2481
+ * @param {boolean} event.changed Shows if the record has been changed by the resize action
2482
+ * @param {SchedulerPro.model.EventModel} event.eventRecord Segment being resized
2483
+ */
2484
+ onEventSegmentResizeEnd? : ((event: { source: SchedulerPro, changed: boolean, eventRecord: EventModel }) => void)|string
2485
+ /**
2486
+ * Fires on the owning Scheduler Pro when segment resizing starts
2487
+ * @param {object} event Event object
2488
+ * @param {SchedulerPro.view.SchedulerPro} event.source Scheduler Pro instance
2489
+ * @param {SchedulerPro.model.EventModel} event.eventRecord Segment being resized
2490
+ * @param {SchedulerPro.model.SchedulerProResourceModel} event.resourceRecord Resource record the resize starts within
2491
+ * @param {MouseEvent} event.event Browser event
2492
+ */
2493
+ onEventSegmentResizeStart? : ((event: { source: SchedulerPro, eventRecord: EventModel, resourceRecord: SchedulerProResourceModel, event: MouseEvent }) => void)|string
2494
+ /**
2495
+ * Fires when a Panel is expanded using the [collapsible](https://bryntum.com/products/gantt/docs/api/Core/widget/Panel#config-collapsible) setting.
2496
+ * @param {object} event Event object
2497
+ * @param {Core.widget.Panel} event.source This Panel.
2498
+ */
2499
+ onExpand? : ((event: { source: Panel }) => void)|string
2500
+ /**
2501
+ * Fired after a parent node record is expanded.
2502
+ * @param {object} event Event object
2503
+ * @param {Grid.view.Grid} event.source The firing Grid instance.
2504
+ * @param {Core.data.Model} event.record The record which has been expanded.
2505
+ */
2506
+ onExpandNode? : ((event: { source: Grid, record: Model }) => void)|string
2507
+ /**
2508
+ * Fired when a file is dropped on the widget element
2509
+ * @param {object} event Event object
2510
+ * @param {Grid.view.Grid} event.source The owning Grid instance
2511
+ * @param {DataTransferItem} event.file The dropped file descriptor
2512
+ * @param {DragEvent} event.domEvent The native DragEvent
2513
+ */
2514
+ onFileDrop? : ((event: { source: Grid, file: DataTransferItem, domEvent: DragEvent }) => void)|string
2515
+ /**
2516
+ * Fired before the FillHandle dragging is finalized and values are applied to cells, return `false` to prevent the
2517
+ * drag operation from applying data changes.
2518
+ * @param {object} event Event object
2519
+ * @param {Grid.util.GridLocation} event.from The from cell
2520
+ * @param {Grid.util.GridLocation} event.to The to cell
2521
+ * @param {MouseEvent} event.domEvent The raw DOM event
2522
+ */
2523
+ onFillHandleBeforeDragFinalize? : ((event: { from: GridLocation, to: GridLocation, domEvent: MouseEvent }) => Promise<boolean>|boolean|void)|string
2524
+ /**
2525
+ * Fired while dragging the FillHandle.
2526
+ * @param {object} event Event object
2527
+ * @param {Grid.util.GridLocation} event.from The from cell
2528
+ * @param {Grid.util.GridLocation} event.to The to cell
2529
+ * @param {MouseEvent} event.domEvent The raw DOM event
2530
+ */
2531
+ onFillHandleDrag? : ((event: { from: GridLocation, to: GridLocation, domEvent: MouseEvent }) => void)|string
2532
+ /**
2533
+ * Fired when a FillHandle drag operation is aborted.
2534
+ */
2535
+ onFillHandleDragAbort? : (() => void)|string
2536
+ /**
2537
+ * Fired after a FillHandle drag operation.
2538
+ * @param {object} event Event object
2539
+ * @param {Grid.util.GridLocation} event.from The from cell
2540
+ * @param {Grid.util.GridLocation} event.to The to cell
2541
+ * @param {MouseEvent} event.domEvent The raw DOM event
2542
+ */
2543
+ onFillHandleDragEnd? : ((event: { from: GridLocation, to: GridLocation, domEvent: MouseEvent }) => void)|string
2544
+ /**
2545
+ * Fired when dragging of the FillHandle starts.
2546
+ * @param {object} event Event object
2547
+ * @param {Grid.util.GridLocation} event.cell Information about the column / record
2548
+ * @param {MouseEvent} event.domEvent The raw DOM event
2549
+ */
2550
+ onFillHandleDragStart? : ((event: { cell: GridLocation, domEvent: MouseEvent }) => Promise<boolean>|boolean|void)|string
2551
+ /**
2552
+ * Fires on the owning Grid when cell editing is finished
2553
+ * @param {object} event Event object
2554
+ * @param {Grid.view.Grid} event.grid Target grid
2555
+ * @param {CellEditorContext} event.editorContext Editing context
2556
+ */
2557
+ onFinishCellEdit? : ((event: { grid: Grid, editorContext: CellEditorContext }) => void)|string
2558
+ /**
2559
+ * 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.
2560
+ * ...
2561
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-finishRowEdit)
2562
+ * @param {object} event Event object
2563
+ * @param {Grid.view.Grid} event.grid Target grid
2564
+ * @param {RowEditorContext} event.editorContext Editing context
2565
+ */
2566
+ onFinishRowEdit? : ((event: { grid: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string
2567
+ /**
2568
+ * Fired when focus enters this Widget.
2569
+ * @param {object} event Event object
2570
+ * @param {Core.widget.Widget} event.source This Widget
2571
+ * @param {HTMLElement} event.fromElement The element which lost focus.
2572
+ * @param {HTMLElement} event.toElement The element which gained focus.
2573
+ * @param {Core.widget.Widget} event.fromWidget The widget which lost focus.
2574
+ * @param {Core.widget.Widget} event.toWidget The widget which gained focus.
2575
+ * @param {boolean} event.backwards `true` if the `toElement` is before the `fromElement` in document order.
2576
+ */
2577
+ onFocusIn? : ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string
2578
+ /**
2579
+ * Fired when focus exits this Widget's ownership tree. This is different from a `blur` event.
2580
+ * focus moving from within this Widget's ownership tree, even if there are floating widgets
2581
+ * will not trigger this event. This is when focus exits this widget completely.
2582
+ * @param {object} event Event object
2583
+ * @param {Core.widget.Widget} event.source This Widget
2584
+ * @param {HTMLElement} event.fromElement The element which lost focus.
2585
+ * @param {HTMLElement} event.toElement The element which gained focus.
2586
+ * @param {Core.widget.Widget} event.fromWidget The widget which lost focus.
2587
+ * @param {Core.widget.Widget} event.toWidget The widget which gained focus.
2588
+ * @param {boolean} event.backwards `true` if the `toElement` is before the `fromElement` in document order.
2589
+ */
2590
+ onFocusOut? : ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string
2591
+ /**
2592
+ * Fired before dragging starts, return false to prevent the drag operation.
2593
+ * @param {object} event Event object
2594
+ * @param {Grid.view.GridBase} event.source
2595
+ * @param {object} event.context
2596
+ * @param {Core.data.Model[]} event.context.records The dragged row records
2597
+ * @param {MouseEvent,TouchEvent} event.event
2598
+ */
2599
+ onGridRowBeforeDragStart? : ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => Promise<boolean>|boolean|void)|string
2600
+ /**
2601
+ * Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
2602
+ * Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
2603
+ * @param {object} event Event object
2604
+ * @param {Grid.view.GridBase} event.source
2605
+ * @param {object} event.context
2606
+ * @param {boolean} event.context.valid Set this to true or false to indicate whether the drop position is valid
2607
+ * @param {Core.data.Model} event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
2608
+ * @param {Core.data.Model} event.context.parent The parent record of the current drop position (only applicable for trees)
2609
+ * @param {Core.data.Model[]} event.context.records The dragged row records
2610
+ * @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
2611
+ * @param {MouseEvent} event.event
2612
+ */
2613
+ onGridRowBeforeDropFinalize? : ((event: { source: GridBase, context: { valid: boolean, insertBefore: Model, parent: Model, records: Model[], oldPositionContext: RecordPositionContext[] }, event: MouseEvent }) => Promise<boolean>|boolean|void)|string
2614
+ /**
2615
+ * Fired while the row is being dragged, in the listener function you have access to `context.insertBefore` a grid /
2616
+ * tree record, and additionally `context.parent` (a TreeNode) for trees. You can signal that the drop position is
2617
+ * valid or invalid by setting `context.valid = false;`
2618
+ * @param {object} event Event object
2619
+ * @param {Grid.view.GridBase} event.source
2620
+ * @param {object} event.context
2621
+ * @param {boolean} event.context.valid Set this to true or false to indicate whether the drop position is valid.
2622
+ * @param {Core.data.Model} event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
2623
+ * @param {Core.data.Model} event.context.parent The parent record of the current drop position (only applicable for trees)
2624
+ * @param {Core.data.Model[]} event.context.records The dragged row records
2625
+ * @param {MouseEvent} event.event
2626
+ */
2627
+ onGridRowDrag? : ((event: { source: GridBase, context: { valid: boolean, insertBefore: Model, parent: Model, records: Model[] }, event: MouseEvent }) => void)|string
2628
+ /**
2629
+ * Fired when a row drag operation is aborted
2630
+ * @param {object} event Event object
2631
+ * @param {Grid.view.GridBase} event.source
2632
+ * @param {object} event.context
2633
+ * @param {Core.data.Model[]} event.context.records The dragged row records
2634
+ * @param {MouseEvent} event.event
2635
+ */
2636
+ onGridRowDragAbort? : ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent }) => void)|string
2637
+ /**
2638
+ * Fired when dragging starts.
2639
+ * @param {object} event Event object
2640
+ * @param {Grid.view.GridBase} event.source
2641
+ * @param {object} event.context
2642
+ * @param {Core.data.Model[]} event.context.records The dragged row records
2643
+ * @param {MouseEvent,TouchEvent} event.event
2644
+ */
2645
+ onGridRowDragStart? : ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => void)|string
2646
+ /**
2647
+ * Fired after the row drop operation has completed, regardless of validity
2648
+ * @param {object} event Event object
2649
+ * @param {Grid.view.GridBase} event.source
2650
+ * @param {object} event.context
2651
+ * @param {boolean} event.context.valid true or false depending on whether the drop position was valid
2652
+ * @param {Core.data.Model} event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
2653
+ * @param {Core.data.Model} event.context.parent The parent record of the current drop position (only applicable for trees)
2654
+ * @param {Core.data.Model[]} event.context.records The dragged row records
2655
+ * @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
2656
+ * @param {MouseEvent} event.event
2657
+ */
2658
+ onGridRowDrop? : ((event: { source: GridBase, context: { valid: boolean, insertBefore: Model, parent: Model, records: Model[], oldPositionContext: RecordPositionContext[] }, event: MouseEvent }) => void)|string
2659
+ /**
2660
+ * Fired when a grid header is clicked on.
2661
+ * ...
2662
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-headerClick)
2663
+ * @param {object} event Event object
2664
+ * @param {Event} event.domEvent The triggering DOM event.
2665
+ * @param {Grid.column.Column} event.column The column clicked on.
2666
+ */
2667
+ onHeaderClick? : ((event: { domEvent: Event, column: Column }) => Promise<boolean>|boolean|void)|string
2668
+ /**
2669
+ * This event fires on the owning Grid before the context menu is shown for a header.
2670
+ * 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).
2671
+ * ...
2672
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-headerMenuBeforeShow)
2673
+ * @param {object} event Event object
2674
+ * @param {Grid.view.Grid} event.source The grid
2675
+ * @param {Core.widget.Menu} event.menu The menu
2676
+ * @param {Record<string, MenuItemEntry>} event.items Menu item configs
2677
+ * @param {Grid.column.Column} event.column Column
2678
+ */
2679
+ onHeaderMenuBeforeShow? : ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => Promise<boolean>|boolean|void)|string
2680
+ /**
2681
+ * This event fires on the owning Grid when an item is selected in the header context menu.
2682
+ * @param {object} event Event object
2683
+ * @param {Grid.view.Grid} event.source The grid
2684
+ * @param {Core.widget.Menu} event.menu The menu
2685
+ * @param {Core.widget.MenuItem} event.item Selected menu item
2686
+ * @param {Grid.column.Column} event.column Column
2687
+ */
2688
+ onHeaderMenuItem? : ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column }) => void)|string
2689
+ /**
2690
+ * This event fires on the owning Grid after the context menu is shown for a header
2691
+ * @param {object} event Event object
2692
+ * @param {Grid.view.Grid} event.source The grid
2693
+ * @param {Core.widget.Menu} event.menu The menu
2694
+ * @param {Record<string, MenuItemEntry>} event.items Menu item configs
2695
+ * @param {Grid.column.Column} event.column Column
2696
+ */
2697
+ onHeaderMenuShow? : ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => void)|string
2698
+ /**
2699
+ * This event fires on the owning Grid when a check item is toggled in the header context menu.
2700
+ * @param {object} event Event object
2701
+ * @param {Grid.view.Grid} event.source The grid
2702
+ * @param {Core.widget.Menu} event.menu The menu
2703
+ * @param {Core.widget.MenuItem} event.item Selected menu item
2704
+ * @param {Grid.column.Column} event.column Column
2705
+ * @param {boolean} event.checked Checked or not
2706
+ */
2707
+ onHeaderMenuToggleItem? : ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column, checked: boolean }) => void)|string
2708
+ /**
2709
+ * Triggered after a widget was hidden
2710
+ * @param {object} event Event object
2711
+ * @param {Core.widget.Widget} event.source The widget
2712
+ */
2713
+ onHide? : ((event: { source: Widget }) => void)|string
2714
+ /**
2715
+ * Fires when row locking is enabled.
2716
+ * @param {object} event Event object
2717
+ * @param {Grid.view.GridBase} event.clone The created clone
2718
+ */
2719
+ onLockRows? : ((event: { clone: GridBase }) => void)|string
2720
+ /**
2721
+ * Mouse moved out from element in grid
2722
+ * @param {object} event Event object
2723
+ * @param {MouseEvent} event.event The native browser event
2724
+ */
2725
+ onMouseOut? : ((event: { event: MouseEvent }) => void)|string
2726
+ /**
2727
+ * Mouse moved in over element in grid
2728
+ * @param {object} event Event object
2729
+ * @param {MouseEvent} event.event The native browser event
2730
+ */
2731
+ onMouseOver? : ((event: { event: MouseEvent }) => void)|string
2732
+ /**
2733
+ * Fires on the owning Gantt when project content is exported
2734
+ * to XML, before the XML is downloaded by the browser.
2735
+ * @param {object} event Event object
2736
+ * @param {object} event.config Export config
2737
+ * @param {string} event.fileContent Exported XML-file content
2738
+ */
2739
+ onMspExport? : ((event: { config: object, fileContent: string }) => void)|string
2740
+ /**
2741
+ * Fired when a user gesture causes the active item to change.
2742
+ * @param {object} event Event object
2743
+ * @param {Event} event.event The browser event which instigated navigation. May be a click or key or focus event.
2744
+ * @param {HTMLElement,null} event.item The newly active item, or `null` if focus moved out.
2745
+ * @param {HTMLElement,null} event.oldItem The previously active item, or `null` if focus is moving in.
2746
+ */
2747
+ onNavigate? : ((event: { event: Event, item: HTMLElement|null, oldItem: HTMLElement|null }) => void)|string
2748
+ /**
2749
+ * Fires when the requested date range cannot fit into any zoom level higher than the current level.
2750
+ * @param {object} event Event object
2751
+ * @param {number} event.currentZoomLevel The current zoom level
2752
+ * @param {Date} event.startDate The requested start date
2753
+ * @param {Date} event.endDate The requested end date
2754
+ */
2755
+ onNoZoomChange? : ((event: { currentZoomLevel: number, startDate: Date, endDate: Date }) => void)|string
2756
+ /**
2757
+ * Triggered when a widget which had been in a non-visible state for any reason
2758
+ * achieves visibility.
2759
+ * ...
2760
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-paint)
2761
+ * @param {object} event Event object
2762
+ * @param {Core.widget.Widget} event.source The widget being painted.
2763
+ * @param {boolean} event.firstPaint `true` if this is the first paint.
2764
+ */
2765
+ onPaint? : ((event: { source: Widget, firstPaint: boolean }) => void)|string
2766
+ /**
2767
+ * Fires on the owning Grid after a paste action is performed.
2768
+ * @param {object} event Event object
2769
+ * @param {Grid.view.Grid} event.source Owner grid
2770
+ * @param {string} event.clipboardData The clipboardData that was pasted
2771
+ * @param {Core.data.Model[]} event.modifiedRecords The records which have been modified due to the paste action
2772
+ * @param {Grid.util.GridLocation} event.targetCell The cell from which the paste will be started
2773
+ * @param {string} event.entityName 'cell' to distinguish this event from other paste events
2774
+ */
2775
+ onPaste? : ((event: { source: Grid, clipboardData: string, modifiedRecords: Model[], targetCell: GridLocation, entityName: string }) => void)|string
2776
+ /**
2777
+ * Fires on the owning Grid when export has finished
2778
+ * @param {object} event Event object
2779
+ * @param {Response} event.response Optional response, if received
2780
+ * @param {Error} event.error Optional error, if exception occurred
2781
+ */
2782
+ onPdfExport? : ((event: { response?: any, error?: Error }) => void)|string
2783
+ /**
2784
+ * Fired on the owning Scheduler or Gantt widget when dragging the percent bar
2785
+ * @param {object} event Event object
2786
+ * @param {Scheduler.view.TimelineBase} event.source SchedulerPro or Gantt instance
2787
+ * @param {Core.data.Model} event.taskRecord The task record
2788
+ * @param {MouseEvent} event.domEvent Browser event
2789
+ */
2790
+ onPercentBarDrag? : ((event: { source: TimelineBase, taskRecord: Model, domEvent: MouseEvent }) => void)|string
2791
+ /**
2792
+ * Fired on the owning Scheduler or Gantt widget if a percent bar drag-drop operation is aborted
2793
+ * @param {object} event Event object
2794
+ * @param {Scheduler.view.TimelineBase} event.source SchedulerPro instance
2795
+ * @param {Core.data.Model} event.taskRecord The task record
2796
+ * @param {MouseEvent} event.domEvent Browser event
2797
+ */
2798
+ onPercentBarDragAbort? : ((event: { source: TimelineBase, taskRecord: Model, domEvent: MouseEvent }) => void)|string
2799
+ /**
2800
+ * Fired on the owning Scheduler or Gantt widget when percent bar dragging starts
2801
+ * @param {object} event Event object
2802
+ * @param {Scheduler.view.TimelineBase} event.source SchedulerPro or Gantt instance
2803
+ * @param {Core.data.Model} event.taskRecord The task record
2804
+ * @param {MouseEvent} event.domEvent Browser event
2805
+ */
2806
+ onPercentBarDragStart? : ((event: { source: TimelineBase, taskRecord: Model, domEvent: MouseEvent }) => void)|string
2807
+ /**
2808
+ * Fired on the owning Scheduler or Gantt widget when dropping the percent bar
2809
+ * @param {object} event Event object
2810
+ * @param {Scheduler.view.TimelineBase} event.source SchedulerPro or Gantt instance
2811
+ * @param {Core.data.Model} event.taskRecord The task record
2812
+ * @param {MouseEvent} event.domEvent Browser event
2813
+ */
2814
+ onPercentBarDrop? : ((event: { source: TimelineBase, taskRecord: Model, domEvent: MouseEvent }) => void)|string
2815
+ /**
2816
+ * Fired after the [viewPreset](https://bryntum.com/products/gantt/docs/api/Scheduler/view/mixin/TimelineViewPresets#config-viewPreset) has changed.
2817
+ * @param {object} event Event object
2818
+ * @param {Scheduler.view.Scheduler} event.source This Scheduler instance.
2819
+ * @param {Date} event.startDate The new start date of the timeline.
2820
+ * @param {Date} event.centerDate The new center date of the timeline.
2821
+ * @param {Date} event.endDate The new end date of the timeline.
2822
+ * @param {Scheduler.preset.ViewPreset} event.from The outgoing ViewPreset.
2823
+ * @param {Scheduler.preset.ViewPreset} event.to The ViewPreset being switched to.
2824
+ */
2825
+ onPresetChange? : ((event: { source: Scheduler, startDate: Date, centerDate: Date, endDate: Date, from: ViewPreset, to: ViewPreset }) => Promise<boolean>|boolean|void)|string
2826
+ /**
2827
+ * Fires on the owning Gantt widget when the editor for a project is canceled.
2828
+ * @param {object} event Event object
2829
+ * @param {Gantt.view.Gantt} event.source The Gantt instance
2830
+ * @param {Gantt.model.ProjectModel} event.projectRecord The edited project
2831
+ * @param {Gantt.widget.ProjectEditor} event.editor The editor
2832
+ */
2833
+ onProjectEditCanceled? : ((event: { source: Gantt, projectRecord: ProjectModel, editor: ProjectEditor }) => void)|string
2834
+ /**
2835
+ * Fired when a Widget's read only state is toggled
2836
+ * @param {object} event Event object
2837
+ * @param {boolean} event.readOnly Read only or not
2838
+ */
2839
+ onReadOnly? : ((event: { readOnly: boolean }) => void)|string
2840
+ /**
2841
+ * This event is fired after a widget's elements have been synchronized due to a direct or indirect call
2842
+ * 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.
2843
+ */
2844
+ onRecompose? : (() => void)|string
2845
+ /**
2846
+ * Task is released, no longer in view/removed. A good spot for cleaning custom things added in a `renderTask`
2847
+ * listener up, if needed.
2848
+ * @param {object} event Event object
2849
+ * @param {Gantt.view.Gantt} event.source The Gantt instance
2850
+ * @param {object} event.renderData Task render data
2851
+ * @param {Gantt.model.TaskModel} event.taskRecord Rendered task
2852
+ * @param {HTMLElement} event.element Task element
2853
+ */
2854
+ onReleaseTask? : ((event: { source: Gantt, renderData: object, taskRecord: TaskModel, element: HTMLElement }) => void)|string
2855
+ /**
2856
+ * Fires after a row is rendered.
2857
+ * @param {object} event Event object
2858
+ * @param {Grid.view.Grid} event.source The firing Grid instance.
2859
+ * @param {Grid.row.Row} event.row The row that has been rendered.
2860
+ * @param {Core.data.Model} event.record The record for the row.
2861
+ * @param {number} event.recordIndex The zero-based index of the record.
2862
+ */
2863
+ onRenderRow? : ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
2864
+ /**
2865
+ * Grid rows have been rendered
2866
+ * @param {object} event Event object
2867
+ * @param {Grid.view.Grid} event.source This grid.
2868
+ */
2869
+ onRenderRows? : ((event: { source: Grid }) => void)|string
2870
+ /**
2871
+ * Task is rendered, its element is available in DOM.
2872
+ * @param {object} event Event object
2873
+ * @param {Gantt.view.Gantt} event.source The Gantt instance
2874
+ * @param {object} event.renderData Task render data
2875
+ * @param {Gantt.model.TaskModel} event.taskRecord Rendered task
2876
+ * @param {HTMLElement} event.element Task element
2877
+ */
2878
+ onRenderTask? : ((event: { source: Gantt, renderData: object, taskRecord: TaskModel, element: HTMLElement }) => void)|string
2879
+ /**
2880
+ * 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`*.
2881
+ * @param {object} event Event object
2882
+ * @param {Core.widget.Widget} event.source This Widget
2883
+ * @param {number} event.width The new width
2884
+ * @param {number} event.height The new height
2885
+ * @param {number} event.oldWidth The old width
2886
+ * @param {number} event.oldHeight The old height
2887
+ */
2888
+ onResize? : ((event: { source: Widget, width: number, height: number, oldWidth: number, oldHeight: number }) => void)|string
2889
+ /**
2890
+ * Triggered when clicking a resource avatar or chip in the cells of the [ResourceAssignmentColumn](https://bryntum.com/products/gantt/docs/api/Gantt/column/ResourceAssignmentColumn).
2891
+ * @param {object} event Event object
2892
+ * @param {Gantt.view.Gantt} event.source This Gantt
2893
+ * @param {Gantt.model.TaskModel} event.taskRecord Task record
2894
+ * @param {Gantt.model.ResourceModel} event.resourceRecord Resource record
2895
+ * @param {Event} event.event Browser event
2896
+ */
2897
+ onResourceAssignmentClick? : ((event: { source: Gantt, taskRecord: TaskModel, resourceRecord: ResourceModel, event: Event }) => void)|string
2898
+ /**
2899
+ * Grid resize lead to a new responsive level being applied
2900
+ * @param {object} event Event object
2901
+ * @param {Grid.view.Grid} event.grid Grid that was resized
2902
+ * @param {string} event.level New responsive level (small, large, etc)
2903
+ * @param {number} event.width New width in px
2904
+ * @param {string} event.oldLevel Old responsive level
2905
+ * @param {number} event.oldWidth Old width in px
2906
+ */
2907
+ onResponsive? : ((event: { grid: Grid, level: string, width: number, oldLevel: string, oldWidth: number }) => void)|string
2908
+ /**
2909
+ * This event fires when a row has finished collapsing.
2910
+ * @param {object} event Event object
2911
+ * @param {Core.data.Model} event.record Record
2912
+ */
2913
+ onRowCollapse? : ((event: { record: Model }) => void)|string
2914
+ /**
2915
+ * This event fires when a row expand has finished expanding.
2916
+ * ...
2917
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-rowExpand)
2918
+ * @param {object} event Event object
2919
+ * @param {Core.data.Model} event.record Record
2920
+ * @param {object} event.expandedElements An object with the Grid region name as property and the expanded body element as value
2921
+ * @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.
2922
+ * @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
2923
+ */
2924
+ onRowExpand? : ((event: { record: Model, expandedElements: object, widget: Widget, widgets: object }) => void)|string
2925
+ /**
2926
+ * Fired when the mouse enters a row
2927
+ * @param {object} event Event object
2928
+ * @param {Grid.view.Grid} event.source The grid instance
2929
+ * @param {Core.data.Model} event.record The record representing the hovered row
2930
+ * @param {Grid.column.Column} event.column The column currently hovered
2931
+ * @param {HTMLElement} event.cellElement The cell HTML element
2932
+ * @param {MouseEvent} event.event The native DOM event
2933
+ */
2934
+ onRowMouseEnter? : ((event: { source: Grid, record: Model, column: Column, cellElement: HTMLElement, event: MouseEvent }) => void)|string
2935
+ /**
2936
+ * Fired when the mouse leaves a row
2937
+ * @param {object} event Event object
2938
+ * @param {Grid.view.Grid} event.source The grid instance
2939
+ * @param {Core.data.Model} event.record The record representing the row that the mouse left
2940
+ * @param {HTMLElement} event.cellElement The cell HTML element that the mouse left
2941
+ * @param {MouseEvent} event.event The native DOM event
2942
+ */
2943
+ onRowMouseLeave? : ((event: { source: Grid, record: Model, cellElement: HTMLElement, event: MouseEvent }) => void)|string
2944
+ /**
2945
+ * This event fires on the owning Scheduler or Gantt widget before the context menu is shown for the schedule.
2946
+ * Allows manipulation of the items to show in the same way as in `processItems`. Returning `false` from a listener
2947
+ * prevents the menu from being shown.
2948
+ * @param {object} event Event object
2949
+ * @param {Scheduler.view.Scheduler} event.source
2950
+ * @param {Record<string, MenuItemEntry>} event.items Menu item configs
2951
+ * @param {Scheduler.model.SchedulerResourceModel} event.resourceRecord Resource record
2952
+ * @param {Date} event.date Clicked date, rounded according to viewPreset's settings
2953
+ * @param {Scheduler.model.SchedulerAssignmentModel} event.assignmentRecord Assignment record, if assignments are used
2954
+ * @param {HTMLElement} event.eventElement
2955
+ */
2956
+ onScheduleMenuBeforeShow? : ((event: { source: Scheduler, items: Record<string, MenuItemEntry>, resourceRecord: SchedulerResourceModel, date: Date, assignmentRecord: SchedulerAssignmentModel, eventElement: HTMLElement }) => Promise<boolean>|boolean|void)|string
2957
+ /**
2958
+ * This event fires on the owning Scheduler or Gantt widget when an item is selected in the context menu.
2959
+ * @param {object} event Event object
2960
+ * @param {Scheduler.view.Scheduler} event.source
2961
+ * @param {Core.widget.MenuItem} event.item
2962
+ * @param {Scheduler.model.SchedulerResourceModel} event.resourceRecord
2963
+ * @param {Date} event.date Clicked date, rounded according to viewPreset's settings
2964
+ * @param {HTMLElement} event.element
2965
+ */
2966
+ onScheduleMenuItem? : ((event: { source: Scheduler, item: MenuItem, resourceRecord: SchedulerResourceModel, date: Date, element: HTMLElement }) => void)|string
2967
+ /**
2968
+ * This event fires on the owning Scheduler or Gantt widget after showing the context menu for the schedule.
2969
+ * @param {object} event Event object
2970
+ * @param {Scheduler.view.Scheduler} event.source
2971
+ * @param {Record<string, MenuItemEntry>} event.items Menu item configs
2972
+ * @param {Core.widget.Menu} event.menu The menu
2973
+ * @param {Scheduler.model.SchedulerResourceModel} event.resourceRecord
2974
+ * @param {Date} event.date Clicked date, rounded according to viewPreset's settings
2975
+ * @param {HTMLElement} event.targetElement
2976
+ */
2977
+ onScheduleMenuShow? : ((event: { source: Scheduler, items: Record<string, MenuItemEntry>, menu: Menu, resourceRecord: SchedulerResourceModel, date: Date, targetElement: HTMLElement }) => void)|string
2978
+ /**
2979
+ * Grid has scrolled vertically
2980
+ * @param {object} event Event object
2981
+ * @param {Grid.view.Grid} event.source The firing Grid instance.
2982
+ * @param {number} event.scrollTop The vertical scroll position.
2983
+ */
2984
+ onScroll? : ((event: { source: Grid, scrollTop: number }) => void)|string
2985
+ /**
2986
+ * Fires on owner when the scroll button is clicked, return `false` to prevent default scroll behavior
2987
+ * @param {object} event Event object
2988
+ * @param {Event} event.domEvent DOM event
2989
+ * @param {Gantt.model.TaskModel} event.taskRecord The task record
2990
+ */
2991
+ onScrollButtonClick? : ((event: { domEvent: Event, taskRecord: TaskModel }) => Promise<boolean>|boolean|void)|string
2992
+ /**
2993
+ * The selection has been changed.
2994
+ * @param {object} event Event object
2995
+ * @param {'select','deselect'} event.action `'select'`/`'deselect'`
2996
+ * @param {'row','cell'} event.mode `'row'`/`'cell'`
2997
+ * @param {Grid.view.Grid} event.source
2998
+ * @param {Core.data.Model[]} event.deselected The records deselected in this operation.
2999
+ * @param {Core.data.Model[]} event.selected The records selected in this operation.
3000
+ * @param {Core.data.Model[]} event.selection The records in the new selection.
3001
+ * @param {Grid.util.GridLocation[]} event.deselectedCells The cells deselected in this operation.
3002
+ * @param {Grid.util.GridLocation[]} event.selectedCells The cells selected in this operation.
3003
+ * @param {Grid.util.GridLocation[]} event.cellSelection The cells in the new selection.
3004
+ */
3005
+ onSelectionChange? : ((event: { action: 'select'|'deselect', mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => void)|string
3006
+ /**
3007
+ * The selectionMode configuration has been changed.
3008
+ * @param {object} event Event object
3009
+ * @param {object} event.selectionMode The new [selectionMode](https://bryntum.com/products/gantt/docs/api/Grid/view/mixin/GridSelection#config-selectionMode)
3010
+ */
3011
+ onSelectionModeChange? : ((event: { selectionMode: object }) => void)|string
3012
+ /**
3013
+ * Triggered after a widget is shown.
3014
+ * @param {object} event Event object
3015
+ * @param {Core.widget.Widget} event.source The widget
3016
+ */
3017
+ onShow? : ((event: { source: Widget }) => void)|string
3018
+ /**
3019
+ * Fires when splitting the Grid.
3020
+ * @param {object} event Event object
3021
+ * @param {Grid.view.GridBase[]} event.subViews The sub views created by the split
3022
+ * @param {object} event.options The options passed to the split call
3023
+ * @param {'horizontal','vertical','both'} event.options.direction The direction of the split
3024
+ * @param {Grid.column.Column} event.options.atColumn The column to split at
3025
+ * @param {Core.data.Model} event.options.atRecord The record to split at
3026
+ */
3027
+ onSplit? : ((event: { subViews: GridBase[], options: { direction: 'horizontal'|'vertical'|'both', atColumn: Column, atRecord: Model } }) => void)|string
3028
+ /**
3029
+ * Fired by the Grid when the collapse icon is clicked. Return `false` to prevent the default collapse action,
3030
+ * if you want to implement your own behavior.
3031
+ * @param {object} event Event object
3032
+ * @param {Grid.view.Grid} event.source The Grid instance.
3033
+ * @param {Grid.view.SubGrid} event.subGrid The subgrid
3034
+ * @param {Event} event.domEvent The native DOM event
3035
+ */
3036
+ onSplitterCollapseClick? : ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => Promise<boolean>|boolean|void)|string
3037
+ /**
3038
+ * Fired by the Grid after a sub-grid has been resized using the splitter
3039
+ * @param {object} event Event object
3040
+ * @param {Grid.view.Grid} event.source The Grid instance.
3041
+ * @param {Grid.view.SubGrid} event.subGrid The resized subgrid
3042
+ * @param {Event} event.domEvent The native DOM event
3043
+ */
3044
+ onSplitterDragEnd? : ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => void)|string
3045
+ /**
3046
+ * Fired by the Grid when a sub-grid resize gesture starts
3047
+ * @param {object} event Event object
3048
+ * @param {Grid.view.Grid} event.source The Grid instance.
3049
+ * @param {Grid.view.SubGrid} event.subGrid The subgrid about to be resized
3050
+ * @param {Event} event.domEvent The native DOM event
3051
+ */
3052
+ onSplitterDragStart? : ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => void)|string
3053
+ /**
3054
+ * Fired by the Grid when the expand icon is clicked. Return `false` to prevent the default expand action,
3055
+ * if you want to implement your own behavior.
3056
+ * @param {object} event Event object
3057
+ * @param {Grid.view.Grid} event.source The Grid instance.
3058
+ * @param {Grid.view.SubGrid} event.subGrid The subgrid
3059
+ * @param {Event} event.domEvent The native DOM event
3060
+ */
3061
+ onSplitterExpandClick? : ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => Promise<boolean>|boolean|void)|string
3062
+ /**
3063
+ * Fires on the owning Grid when editing starts
3064
+ * @param {object} event Event object
3065
+ * @param {Grid.view.Grid} event.source Owner grid
3066
+ * @param {CellEditorContext} event.editorContext Editing context
3067
+ */
3068
+ onStartCellEdit? : ((event: { source: Grid, editorContext: CellEditorContext }) => void)|string
3069
+ /**
3070
+ * Fires on the owning Grid when editing starts
3071
+ * @param {object} event Event object
3072
+ * @param {Grid.view.Grid} event.source Owner grid
3073
+ * @param {RowEditorContext} event.editorContext Editing context
3074
+ */
3075
+ onStartRowEdit? : ((event: { source: Grid, editorContext: RowEditorContext }) => void)|string
3076
+ /**
3077
+ * Fires after a sub grid is collapsed.
3078
+ * @param {object} event Event object
3079
+ * @param {Grid.view.Grid} event.source The firing Grid instance
3080
+ * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
3081
+ */
3082
+ onSubGridCollapse? : ((event: { source: Grid, subGrid: SubGrid }) => void)|string
3083
+ /**
3084
+ * Fires after a sub grid is expanded.
3085
+ * @param {object} event Event object
3086
+ * @param {Grid.view.Grid} event.source The firing Grid instance
3087
+ * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
3088
+ */
3089
+ onSubGridExpand? : ((event: { source: Grid, subGrid: SubGrid }) => void)|string
3090
+ /**
3091
+ * Triggered after a click on a task bar.
3092
+ * @param {object} event Event object
3093
+ * @param {Gantt.view.Gantt} event.source The Gantt instance
3094
+ * @param {Gantt.model.TaskModel} event.taskRecord The Task record
3095
+ * @param {MouseEvent} event.event The native browser event
3096
+ */
3097
+ onTaskClick? : ((event: { source: Gantt, taskRecord: TaskModel, event: MouseEvent }) => void)|string
3098
+ /**
3099
+ * Triggered after a rightclick (or long press on a touch device) on a task.
3100
+ * @param {object} event Event object
3101
+ * @param {Gantt.view.Gantt} event.source The Gantt instance
3102
+ * @param {Gantt.model.TaskModel} event.taskRecord The Task record
3103
+ * @param {MouseEvent} event.event The native browser event
3104
+ */
3105
+ onTaskContextMenu? : ((event: { source: Gantt, taskRecord: TaskModel, event: MouseEvent }) => void)|string
3106
+ /**
3107
+ * Triggered after a doubleclick on a task.
3108
+ * @param {object} event Event object
3109
+ * @param {Gantt.view.Gantt} event.source The Gantt instance
3110
+ * @param {Gantt.model.TaskModel} event.taskRecord The Task record
3111
+ * @param {MouseEvent} event.event The native browser event
3112
+ */
3113
+ onTaskDblClick? : ((event: { source: Gantt, taskRecord: TaskModel, event: MouseEvent }) => void)|string
3114
+ /**
3115
+ * Fires on the owning Gantt while a task is being dragged
3116
+ * @param {object} event Event object
3117
+ * @param {Gantt.view.Gantt} event.source
3118
+ * @param {Gantt.model.TaskModel[]} event.taskRecords
3119
+ * @param {Date} event.startDate
3120
+ * @param {Date} event.endDate
3121
+ * @param {object} event.dragData
3122
+ * @param {boolean} event.changed `true` if startDate has changed.
3123
+ */
3124
+ onTaskDrag? : ((event: { source: Gantt, taskRecords: TaskModel[], startDate: Date, endDate: Date, dragData: object, changed: boolean }) => void)|string
3125
+ /**
3126
+ * Fires on the owning Gantt when task dragging starts
3127
+ * @param {object} event Event object
3128
+ * @param {Gantt.view.Gantt} event.source
3129
+ * @param {Gantt.model.TaskModel[]} event.taskRecords
3130
+ */
3131
+ onTaskDragStart? : ((event: { source: Gantt, taskRecords: TaskModel[] }) => void)|string
3132
+ /**
3133
+ * Fires on the owning Gantt after a valid task drop
3134
+ * @param {object} event Event object
3135
+ * @param {Gantt.view.Gantt} event.source
3136
+ * @param {Gantt.model.TaskModel[]} event.taskRecords
3137
+ * @param {boolean} event.isCopy
3138
+ */
3139
+ onTaskDrop? : ((event: { source: Gantt, taskRecords: TaskModel[], isCopy: boolean }) => void)|string
3140
+ /**
3141
+ * Fires on the owning Scheduler or Gantt widget when the editor for an event is canceled.
3142
+ * @param {object} event Event object
3143
+ * @param {SchedulerPro.view.SchedulerPro} event.source The Scheduler Pro instance
3144
+ * @param {SchedulerPro.model.EventModel} event.taskRecord the task about the shown in the editor
3145
+ * @param {SchedulerPro.widget.TaskEditorBase} event.editor The editor
3146
+ */
3147
+ onTaskEditCanceled? : ((event: { source: SchedulerPro, taskRecord: EventModel, editor: TaskEditorBase }) => void)|string
3148
+ /**
3149
+ * Triggered when a keydown event is observed if there are selected tasks.
3150
+ * @param {object} event Event object
3151
+ * @param {Gantt.view.Gantt} event.source This Gantt
3152
+ * @param {Gantt.model.TaskModel} event.taskRecord Task record
3153
+ * @param {KeyboardEvent} event.event Browser event
3154
+ */
3155
+ onTaskKeyDown? : ((event: { source: Gantt, taskRecord: TaskModel, event: KeyboardEvent }) => void)|string
3156
+ /**
3157
+ * Triggered when a keyup event is observed if there are selected tasks.
3158
+ * @param {object} event Event object
3159
+ * @param {Gantt.view.Gantt} event.source This Gantt
3160
+ * @param {Gantt.model.TaskModel} event.taskRecord Task record
3161
+ * @param {KeyboardEvent} event.event Browser event
3162
+ */
3163
+ onTaskKeyUp? : ((event: { source: Gantt, taskRecord: TaskModel, event: KeyboardEvent }) => void)|string
3164
+ /**
3165
+ * This event fires on the owning Gantt before the context menu is shown for a task. Allows manipulation of the items
3166
+ * to show in the same way as in `processItems`. Returning false from a listener prevents the menu from
3167
+ * being shown.
3168
+ * @param {object} event Event object
3169
+ * @param {Gantt.view.Gantt} event.source
3170
+ * @param {MenuItemEntry[]} event.items Menu item configs
3171
+ * @param {Gantt.model.TaskModel} event.taskRecord Event record for which the menu was triggered
3172
+ * @param {HTMLElement} event.taskElement
3173
+ */
3174
+ onTaskMenuBeforeShow? : ((event: { source: Gantt, items: MenuItemEntry[], taskRecord: TaskModel, taskElement: HTMLElement }) => Promise<boolean>|boolean|void)|string
3175
+ /**
3176
+ * This event fires on the owning Gantt when an item is selected in the context menu.
3177
+ * @param {object} event Event object
3178
+ * @param {Gantt.view.Gantt} event.source
3179
+ * @param {Core.widget.MenuItem} event.item
3180
+ * @param {Gantt.model.TaskModel} event.taskRecord
3181
+ * @param {HTMLElement} event.taskElement
3182
+ */
3183
+ onTaskMenuItem? : ((event: { source: Gantt, item: MenuItem, taskRecord: TaskModel, taskElement: HTMLElement }) => void)|string
3184
+ /**
3185
+ * This event fires on the owning Gantt after showing the context menu for an event
3186
+ * @param {object} event Event object
3187
+ * @param {Gantt.view.Gantt} event.source
3188
+ * @param {Core.widget.Menu} event.menu The menu
3189
+ * @param {Gantt.model.TaskModel} event.taskRecord Event record for which the menu was triggered
3190
+ * @param {HTMLElement} event.taskElement
3191
+ */
3192
+ onTaskMenuShow? : ((event: { source: Gantt, menu: Menu, taskRecord: TaskModel, taskElement: HTMLElement }) => void)|string
3193
+ /**
3194
+ * Triggered after a mousedown on a task bar.
3195
+ * @param {object} event Event object
3196
+ * @param {Gantt.view.Gantt} event.source The Gantt instance
3197
+ * @param {Gantt.model.TaskModel} event.taskRecord The Task record
3198
+ * @param {MouseEvent} event.event The native browser event
3199
+ */
3200
+ onTaskMouseDown? : ((event: { source: Gantt, taskRecord: TaskModel, event: MouseEvent }) => void)|string
3201
+ /**
3202
+ * Triggered for mouseout from a task.
3203
+ * @param {object} event Event object
3204
+ * @param {Gantt.view.Gantt} event.source The Gantt instance
3205
+ * @param {Gantt.model.TaskModel} event.taskRecord The Task record
3206
+ * @param {MouseEvent} event.event The native browser event
3207
+ */
3208
+ onTaskMouseOut? : ((event: { source: Gantt, taskRecord: TaskModel, event: MouseEvent }) => void)|string
3209
+ /**
3210
+ * Triggered after a mouseover on a task.
3211
+ * @param {object} event Event object
3212
+ * @param {Gantt.view.Gantt} event.source The Gantt instance
3213
+ * @param {Gantt.model.TaskModel} event.taskRecord The Task record
3214
+ * @param {MouseEvent} event.event The native browser event
3215
+ */
3216
+ onTaskMouseOver? : ((event: { source: Gantt, taskRecord: TaskModel, event: MouseEvent }) => void)|string
3217
+ /**
3218
+ * Triggered after a mouseup on a task bar.
3219
+ * @param {object} event Event object
3220
+ * @param {Gantt.view.Gantt} event.source The Gantt instance
3221
+ * @param {Gantt.model.TaskModel} event.taskRecord The Task record
3222
+ * @param {MouseEvent} event.event The native browser event
3223
+ */
3224
+ onTaskMouseUp? : ((event: { source: Gantt, taskRecord: TaskModel, event: MouseEvent }) => void)|string
3225
+ /**
3226
+ * Triggered when clicking a nonworking time element
3227
+ * @param {object} event Event object
3228
+ * @param {Gantt.view.Gantt} event.source The Gantt chart instance
3229
+ * @param {Gantt.model.TaskModel} event.taskRecord Task record
3230
+ * @param {object} event.interval The raw data describing the nonworking time interval
3231
+ * @param {string} event.interval.name The interval name (if any)
3232
+ * @param {Date} event.interval.startDate The interval start date
3233
+ * @param {Date} event.interval.endDate The interval end date
3234
+ * @param {MouseEvent} event.domEvent Browser event
3235
+ */
3236
+ onTaskNonWorkingTimeClick? : ((event: { source: Gantt, taskRecord: TaskModel, interval: { name: string, startDate: Date, endDate: Date }, domEvent: MouseEvent }) => void)|string
3237
+ /**
3238
+ * Triggered when right-clicking a nonworking time element
3239
+ * @param {object} event Event object
3240
+ * @param {Gantt.view.Gantt} event.source The Gantt chart instance
3241
+ * @param {Gantt.model.TaskModel} event.taskRecord Task record
3242
+ * @param {object} event.interval The raw data describing the nonworking time interval
3243
+ * @param {string} event.interval.name The interval name (if any)
3244
+ * @param {Date} event.interval.startDate The interval start date
3245
+ * @param {Date} event.interval.endDate The interval end date
3246
+ * @param {MouseEvent} event.domEvent Browser event
3247
+ */
3248
+ onTaskNonWorkingTimeContextMenu? : ((event: { source: Gantt, taskRecord: TaskModel, interval: { name: string, startDate: Date, endDate: Date }, domEvent: MouseEvent }) => void)|string
3249
+ /**
3250
+ * Triggered when double-clicking a nonworking time element
3251
+ * @param {object} event Event object
3252
+ * @param {Gantt.view.Gantt} event.source The Gantt chart instance
3253
+ * @param {Gantt.model.TaskModel} event.taskRecord Task record
3254
+ * @param {object} event.interval The raw data describing the nonworking time interval
3255
+ * @param {string} event.interval.name The interval name (if any)
3256
+ * @param {Date} event.interval.startDate The interval start date
3257
+ * @param {Date} event.interval.endDate The interval end date
3258
+ * @param {MouseEvent} event.domEvent Browser event
3259
+ */
3260
+ onTaskNonWorkingTimeDblClick? : ((event: { source: Gantt, taskRecord: TaskModel, interval: { name: string, startDate: Date, endDate: Date }, domEvent: MouseEvent }) => void)|string
3261
+ /**
3262
+ * Fires on the owning Gantt on each resize move event
3263
+ * @param {object} event Event object
3264
+ * @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`
3265
+ * @param {Gantt.model.TaskModel} event.taskRecord Task record being resized
3266
+ * @param {Date} event.startDate New startDate
3267
+ * @param {Date} event.endDate New endDate
3268
+ * @param {HTMLElement} event.element
3269
+ */
3270
+ onTaskPartialResize? : ((event: { resizeData: TaskResizeData[], taskRecord: TaskModel, startDate: Date, endDate: Date, element: HTMLElement }) => void)|string
3271
+ /**
3272
+ * Fires on the owning Gantt after the resizing gesture has finished.
3273
+ * @param {object} event Event object
3274
+ * @param {boolean} event.changed
3275
+ * @param {Gantt.model.TaskModel} event.taskRecord
3276
+ * @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`
3277
+ */
3278
+ onTaskResizeEnd? : ((event: { changed: boolean, taskRecord: TaskModel, resizeData: TaskResizeData[] }) => void)|string
3279
+ /**
3280
+ * Fires on the owning Gantt when task resizing starts
3281
+ * @param {object} event Event object
3282
+ * @param {Gantt.model.TaskModel} event.taskRecord
3283
+ * @param {Event} event.event
3284
+ * @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`
3285
+ */
3286
+ onTaskResizeStart? : ((event: { taskRecord: TaskModel, event: Event, resizeData: TaskResizeData[] }) => void)|string
3287
+ /**
3288
+ * Fires on the owning Gantt while a segment is being dragged
3289
+ * @param {object} event Event object
3290
+ * @param {Gantt.view.Gantt} event.source
3291
+ * @param {Gantt.model.TaskModel[]} event.taskRecords Dragged segments
3292
+ * @param {Date} event.startDate
3293
+ * @param {Date} event.endDate
3294
+ * @param {object} event.dragData
3295
+ * @param {boolean} event.changed `true` if startDate has changed.
3296
+ */
3297
+ onTaskSegmentDrag? : ((event: { source: Gantt, taskRecords: TaskModel[], startDate: Date, endDate: Date, dragData: object, changed: boolean }) => void)|string
3298
+ /**
3299
+ * Fires on the owning Gantt when segment dragging starts
3300
+ * @param {object} event Event object
3301
+ * @param {Gantt.view.Gantt} event.source
3302
+ * @param {Gantt.model.TaskModel[]} event.taskRecords Dragged segments
3303
+ */
3304
+ onTaskSegmentDragStart? : ((event: { source: Gantt, taskRecords: TaskModel[] }) => void)|string
3305
+ /**
3306
+ * Fires on the owning Gantt after a valid task drop
3307
+ * @param {object} event Event object
3308
+ * @param {Gantt.view.Gantt} event.source
3309
+ * @param {Gantt.model.TaskModel[]} event.taskRecords Dropped segments
3310
+ * @param {boolean} event.isCopy
3311
+ */
3312
+ onTaskSegmentDrop? : ((event: { source: Gantt, taskRecords: TaskModel[], isCopy: boolean }) => void)|string
3313
+ /**
3314
+ * Fires on the owning Gantt on each resize move event
3315
+ * @param {object} event Event object
3316
+ * @param {Gantt.view.Gantt} event.source Gantt instance
3317
+ * @param {Gantt.model.TaskModel} event.taskRecord Segment being resized
3318
+ * @param {Date} event.startDate
3319
+ * @param {Date} event.endDate
3320
+ * @param {HTMLElement} event.element
3321
+ */
3322
+ onTaskSegmentPartialResize? : ((event: { source: Gantt, taskRecord: TaskModel, startDate: Date, endDate: Date, element: HTMLElement }) => void)|string
3323
+ /**
3324
+ * Fires on the owning Gantt after the resizing gesture has finished.
3325
+ * @param {object} event Event object
3326
+ * @param {Gantt.view.Gantt} event.source Gantt instance
3327
+ * @param {boolean} event.changed Shows if the record has been changed by the resize action
3328
+ * @param {Gantt.model.TaskModel} event.taskRecord Segment being resized
3329
+ */
3330
+ onTaskSegmentResizeEnd? : ((event: { source: Gantt, changed: boolean, taskRecord: TaskModel }) => void)|string
3331
+ /**
3332
+ * Fires on the owning Gantt when event resizing starts
3333
+ * @param {object} event Event object
3334
+ * @param {Gantt.view.Gantt} event.source Gantt instance
3335
+ * @param {Gantt.model.TaskModel} event.taskRecord Segment being resized
3336
+ * @param {Scheduler.model.SchedulerResourceModel} event.resourceRecord Resource record the resize starts within
3337
+ * @param {MouseEvent} event.event Browser event
3338
+ */
3339
+ onTaskSegmentResizeStart? : ((event: { source: Gantt, taskRecord: TaskModel, resourceRecord: SchedulerResourceModel, event: MouseEvent }) => void)|string
3340
+ /**
3341
+ * Fired when the tick size changes.
3342
+ * ...
3343
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-tickSizeChange)
3344
+ * @param {object} event Event object
3345
+ * @param {Scheduler.view.Scheduler} event.source This Scheduler instance.
3346
+ * @param {number} event.tickSize The tick size in pixels
3347
+ */
3348
+ onTickSizeChange? : ((event: { source: Scheduler, tickSize: number }) => void)|string
3349
+ /**
3350
+ * Fired when the timeaxis has changed, for example by zooming or configuring a new time span.
3351
+ * @param {object} event Event object
3352
+ * @param {Scheduler.view.Scheduler} event.source This Scheduler
3353
+ * @param {object} event.config Config object used to reconfigure the time axis.
3354
+ * @param {Date} event.config.startDate New start date (if supplied)
3355
+ * @param {Date} event.config.endDate New end date (if supplied)
3356
+ */
3357
+ onTimeAxisChange? : ((event: { source: Scheduler, config: { startDate: Date, endDate: Date } }) => void)|string
3358
+ /**
3359
+ * Fires after a click on a time axis cell
3360
+ * @param {object} event Event object
3361
+ * @param {Scheduler.column.SchedulerTimeAxisColumn,Scheduler.column.VerticalTimeAxisColumn} event.source The column object
3362
+ * @param {Date} event.startDate The start date of the header cell
3363
+ * @param {Date} event.endDate The end date of the header cell
3364
+ * @param {Event} event.event The event object
3365
+ */
3366
+ onTimeAxisHeaderClick? : ((event: { source: SchedulerTimeAxisColumn|VerticalTimeAxisColumn, startDate: Date, endDate: Date, event: Event }) => void)|string
3367
+ /**
3368
+ * Fires after a right click on a time axis cell
3369
+ * @param {object} event Event object
3370
+ * @param {Scheduler.column.SchedulerTimeAxisColumn,Scheduler.column.VerticalTimeAxisColumn} event.source The column object
3371
+ * @param {Date} event.startDate The start date of the header cell
3372
+ * @param {Date} event.endDate The end date of the header cell
3373
+ * @param {Event} event.event The event object
3374
+ */
3375
+ onTimeAxisHeaderContextMenu? : ((event: { source: SchedulerTimeAxisColumn|VerticalTimeAxisColumn, startDate: Date, endDate: Date, event: Event }) => void)|string
3376
+ /**
3377
+ * Fires after a double click on a time axis cell
3378
+ * @param {object} event Event object
3379
+ * @param {Scheduler.column.SchedulerTimeAxisColumn,Scheduler.column.VerticalTimeAxisColumn} event.source The column object
3380
+ * @param {Date} event.startDate The start date of the header cell
3381
+ * @param {Date} event.endDate The end date of the header cell
3382
+ * @param {Event} event.event The event object
3383
+ */
3384
+ onTimeAxisHeaderDblClick? : ((event: { source: SchedulerTimeAxisColumn|VerticalTimeAxisColumn, startDate: Date, endDate: Date, event: Event }) => void)|string
3385
+ /**
3386
+ * This event fires on the owning Scheduler or Gantt widget before the context menu is shown for the time axis header.
3387
+ * 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).
3388
+ * ...
3389
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-timeAxisHeaderMenuBeforeShow)
3390
+ * @param {object} event Event object
3391
+ * @param {Scheduler.view.Scheduler} event.source The scheduler
3392
+ * @param {Core.widget.Menu} event.menu The menu
3393
+ * @param {Record<string, MenuItemEntry>} event.items Menu item configs
3394
+ * @param {Grid.column.Column} event.column Time axis column
3395
+ */
3396
+ onTimeAxisHeaderMenuBeforeShow? : ((event: { source: Scheduler, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => Promise<boolean>|boolean|void)|string
3397
+ /**
3398
+ * This event fires on the owning Scheduler or Gantt widget when an item is selected in the header context menu.
3399
+ * @param {object} event Event object
3400
+ * @param {Scheduler.view.Scheduler} event.source The scheduler
3401
+ * @param {Core.widget.Menu} event.menu The menu
3402
+ * @param {Core.widget.MenuItem} event.item Selected menu item
3403
+ * @param {Grid.column.Column} event.column Time axis column
3404
+ */
3405
+ onTimeAxisHeaderMenuItem? : ((event: { source: Scheduler, menu: Menu, item: MenuItem, column: Column }) => void)|string
3406
+ /**
3407
+ * This event fires on the owning Scheduler or Gantt widget after the context menu is shown for a header
3408
+ * @param {object} event Event object
3409
+ * @param {Scheduler.view.Scheduler} event.source The scheduler
3410
+ * @param {Core.widget.Menu} event.menu The menu
3411
+ * @param {Record<string, MenuItemEntry>} event.items Menu item configs
3412
+ * @param {Grid.column.Column} event.column Time axis column
3413
+ */
3414
+ onTimeAxisHeaderMenuShow? : ((event: { source: Scheduler, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => void)|string
3415
+ /**
3416
+ * Fired when the pointer-activated [timelineContext](https://bryntum.com/products/gantt/docs/api/Scheduler/view/mixin/TimelineDomEvents#property-timelineContext) has changed.
3417
+ * @param {object} event Event object
3418
+ * @param {Scheduler.util.TimelineContext} event.oldContext The tick/resource context being deactivated.
3419
+ * @param {Scheduler.util.TimelineContext} event.context The tick/resource context being activated.
3420
+ */
3421
+ onTimelineContextChange? : ((event: { oldContext: TimelineContext, context: TimelineContext }) => void)|string
3422
+ /**
3423
+ * Fired when the *scheduler* viewport (not the overall Scheduler element) changes size.
3424
+ * This happens when the grid changes height, or when the subgrid which encapsulates the
3425
+ * scheduler column changes width.
3426
+ * @param {object} event Event object
3427
+ * @param {Core.widget.Widget} event.source This Scheduler
3428
+ * @param {number} event.width The new width
3429
+ * @param {number} event.height The new height
3430
+ * @param {number} event.oldWidth The old width
3431
+ * @param {number} event.oldHeight The old height
3432
+ */
3433
+ onTimelineViewportResize? : ((event: { source: Widget, width: number, height: number, oldWidth: number, oldHeight: number }) => void)|string
3434
+ /**
3435
+ * Fired on the owning Scheduler or Gantt widget when a click happens on a time range header element
3436
+ * @param {object} event Event object
3437
+ * @param {Scheduler.view.Scheduler} event.source Scheduler instance
3438
+ * @param {Scheduler.model.TimeSpan} event.timeRangeRecord The record
3439
+ * @param {MouseEvent} event.domEvent Browser event
3440
+ */
3441
+ onTimeRangeHeaderClick? : ((event: { source: Scheduler, timeRangeRecord: TimeSpan, domEvent: MouseEvent }) => void)|string
3442
+ /**
3443
+ * Fired on the owning Scheduler or Gantt widget when a right click happens on a time range header element
3444
+ * @param {object} event Event object
3445
+ * @param {Scheduler.view.Scheduler} event.source Scheduler instance
3446
+ * @param {Scheduler.model.TimeSpan} event.timeRangeRecord The record
3447
+ * @param {MouseEvent} event.domEvent Browser event
3448
+ */
3449
+ onTimeRangeHeaderContextMenu? : ((event: { source: Scheduler, timeRangeRecord: TimeSpan, domEvent: MouseEvent }) => void)|string
3450
+ /**
3451
+ * Fired on the owning Scheduler or Gantt widget when a double click happens on a time range header element
3452
+ * @param {object} event Event object
3453
+ * @param {Scheduler.view.Scheduler} event.source Scheduler instance
3454
+ * @param {Scheduler.model.TimeSpan} event.timeRangeRecord The record
3455
+ * @param {MouseEvent} event.domEvent Browser event
3456
+ */
3457
+ onTimeRangeHeaderDblClick? : ((event: { source: Scheduler, timeRangeRecord: TimeSpan, domEvent: MouseEvent }) => void)|string
3458
+ /**
3459
+ * Fired when one or more groups are expanded or collapsed
3460
+ * @param {object} event Event object
3461
+ * @param {Core.data.Model} event.groupRecord [DEPRECATED] Use `groupRecords` param instead
3462
+ * @param {Core.data.Model[]} event.groupRecords The group records being toggled
3463
+ * @param {boolean} event.collapse Collapsed (true) or expanded (false)
3464
+ * @param {boolean} event.allRecords True if this event is part of toggling all groups
3465
+ */
3466
+ onToggleGroup? : ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, allRecords?: boolean }) => void)|string
3467
+ /**
3468
+ * Fired after a parent node record toggles its collapsed state.
3469
+ * @param {object} event Event object
3470
+ * @param {Core.data.Model} event.record The record being toggled.
3471
+ * @param {boolean} event.collapse `true` if the node is being collapsed.
3472
+ */
3473
+ onToggleNode? : ((event: { record: Model, collapse: boolean }) => void)|string
3474
+ /**
3475
+ * A header [tool](https://bryntum.com/products/gantt/docs/api/Core/widget/Panel#config-tools) has been clicked.
3476
+ * @param {object} event Event object
3477
+ * @param {Core.widget.Tool} event.source This Panel.
3478
+ * @param {Core.widget.Tool} event.tool The tool which is being clicked.
3479
+ */
3480
+ onToolClick? : ((event: { source: Tool, tool: Tool }) => void)|string
3481
+ /**
3482
+ * <strong>Note that this event fires on the owning [SchedulerPro](https://bryntum.com/products/gantt/docs/api/SchedulerPro/view/SchedulerPro).</strong>
3483
+ * ...
3484
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-transactionChange)
3485
+ * @param {object} event Event object
3486
+ * @param {boolean} event.hasChanges Whether any changes are recorded that are not yet attached to a version.
3487
+ */
3488
+ onTransactionChange? : ((event: { hasChanges: boolean }) => void)|string
3489
+ /**
3490
+ * Fires when row locking is disabled.
3491
+ * @param {object} event Event object
3492
+ * @param {Grid.view.GridBase} event.clone The locked clone that will be destroyed
3493
+ */
3494
+ onUnlockRows? : ((event: { clone: GridBase }) => void)|string
3495
+ /**
3496
+ * Fires when un-splitting the Grid.
3497
+ */
3498
+ onUnsplit? : (() => void)|string
3499
+ /**
3500
+ * Fired when the range of dates visible within the viewport changes. This will be when
3501
+ * scrolling along a time axis.
3502
+ * ...
3503
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-visibleDateRangeChange)
3504
+ * @param {object} event Event object
3505
+ * @param {Scheduler.view.Scheduler} event.source This Scheduler instance.
3506
+ * @param {object} event.old The old date range
3507
+ * @param {Date} event.old.startDate the old start date.
3508
+ * @param {Date} event.old.endDate the old end date.
3509
+ * @param {object} event.new The new date range
3510
+ * @param {Date} event.new.startDate the new start date.
3511
+ * @param {Date} event.new.endDate the new end date.
3512
+ */
3513
+ onVisibleDateRangeChange? : ((event: { source: Scheduler, old: { startDate: Date, endDate: Date }, new: { startDate: Date, endDate: Date } }) => void)|string
3514
+
3515
+ // Features
3516
+ /**
3517
+ * AI-powered filter feature for Grid. Allows users to type natural language queries to filter grid data.
3518
+ * ...
3519
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/ai/AIFilter)
3520
+ */
3521
+ aiFilterFeature? : object|boolean|string|AIFilter|AIFilterConfig
3522
+ /**
3523
+ * 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
3524
+ * timeline.
3525
+ * ...
3526
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/Baselines)
3527
+ */
3528
+ baselinesFeature? : object|boolean|string|Baselines|BaselinesConfig
3529
+ /**
3530
+ * Allows using `[Ctrl/CMD + C]`, `[Ctrl/CMD + X]` and `[Ctrl/CMD + V]` to cut, copy and paste cell or cell ranges. Also
3531
+ * makes cut, copy and paste actions available via the cell context menu.
3532
+ * ...
3533
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/CellCopyPaste)
3534
+ */
3535
+ cellCopyPasteFeature? : object|boolean|string|CellCopyPaste|CellCopyPasteConfig
3536
+ /**
3537
+ * 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>
3538
+ * ...
3539
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/CellEdit)
3540
+ */
3541
+ cellEditFeature? : object|boolean|string|CellEdit|CellEditConfig
3542
+ /**
3543
+ * Right click to display context menu for cells. To invoke the cell menu in a keyboard-accessible manner, use the
3544
+ * `SPACE` key when the cell is focused.
3545
+ * ...
3546
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/CellMenu)
3547
+ */
3548
+ cellMenuFeature? : object|boolean|string|CellMenu|CellMenuConfig
3549
+ /**
3550
+ * Displays a tooltip when hovering cells.
3551
+ * ...
3552
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/CellTooltip)
3553
+ */
3554
+ cellTooltipFeature? : object|boolean|string|CellTooltip|CellTooltipConfig
3555
+ /**
3556
+ * 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
3557
+ * and updated in realtime as data changes. Supports many common chart types with extensive styling and customization
3558
+ * options.
3559
+ * ...
3560
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/Charts)
3561
+ */
3562
+ chartsFeature? : object|boolean|string|Charts|ChartsConfig
3563
+ /**
3564
+ * Enables the [autoWidth](https://bryntum.com/products/gantt/docs/api/Grid/column/Column#config-autoWidth) config for a grid's columns.
3565
+ * ...
3566
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/ColumnAutoWidth)
3567
+ */
3568
+ columnAutoWidthFeature? : object|boolean|string|ColumnAutoWidth|ColumnAutoWidthConfig
3569
+ /**
3570
+ * Displays a toolbar while dragging column headers. Drop on a button in the toolbar to activate a certain function,
3571
+ * for example to group by that column. This feature simplifies certain operations on touch devices.
3572
+ * ...
3573
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/ColumnDragToolbar)
3574
+ */
3575
+ columnDragToolbarFeature? : object|boolean|string|ColumnDragToolbar|ColumnDragToolbarConfig
3576
+ /**
3577
+ * Displays column lines for ticks, with a different styling for major ticks (by default they are darker). If this
3578
+ * feature is disabled, no lines are shown. If it's enabled, line are shown for the tick level which is set in current
3579
+ * ViewPreset. Please see [columnLinesFor](https://bryntum.com/products/gantt/docs/api/Scheduler/preset/ViewPreset#field-columnLinesFor) config for details.
3580
+ * ...
3581
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Scheduler/feature/ColumnLines)
3582
+ */
3583
+ columnLinesFeature? : object|boolean|string|ColumnLines|ColumnLinesConfig
3584
+ /**
3585
+ * Displays a column picker (to show/hide columns) in the header context menu. Columns can be displayed in sub menus
3586
+ * by region or tag. Grouped headers are displayed as menu hierarchies.
3587
+ * ...
3588
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/ColumnPicker)
3589
+ */
3590
+ columnPickerFeature? : object|boolean|string|ColumnPicker|ColumnPickerConfig
3591
+ /**
3592
+ * Allows user to rename columns by either right-clicking column header or using keyboard shortcuts when column header
3593
+ * is focused.
3594
+ * ...
3595
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/ColumnRename)
3596
+ */
3597
+ columnRenameFeature? : object|boolean|string|ColumnRename|ColumnRenameConfig
3598
+ /**
3599
+ * Allows user to reorder columns by dragging headers. To get notified about column reorder listen to `change` event
3600
+ * on [columns](https://bryntum.com/products/gantt/docs/api/Grid/data/ColumnStore) store.
3601
+ * ...
3602
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/ColumnReorder)
3603
+ */
3604
+ columnReorderFeature? : object|boolean|string|ColumnReorder|ColumnReorderConfig
3605
+ /**
3606
+ * Enables user to resize columns by dragging a handle on the right hand side of the header. To get notified about column
3607
+ * resize listen to `change` event on [columns](https://bryntum.com/products/gantt/docs/api/Grid/data/ColumnStore) store.
3608
+ * ...
3609
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/ColumnResize)
3610
+ */
3611
+ columnResizeFeature? : object|boolean|string|ColumnResize|ColumnResizeConfig
3612
+ /**
3613
+ * This feature highlights the project *critical paths*.
3614
+ * Every task is important, but only some of them are critical.
3615
+ * The critical path is a chain of linked tasks that directly affects the project finish date.
3616
+ * If any task on the critical path is late, the whole project is late.
3617
+ * ...
3618
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/CriticalPaths)
3619
+ */
3620
+ criticalPathsFeature? : object|boolean|string|CriticalPaths|CriticalPathsConfig
3621
+ /**
3622
+ * This feature draws dependencies between tasks. Uses a dependency
3623
+ * [store](https://bryntum.com/products/gantt/docs/api/Gantt/model/ProjectModel#property-dependencyStore) to determine which dependencies to draw.
3624
+ * ...
3625
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/Dependencies)
3626
+ */
3627
+ dependenciesFeature? : object|boolean|string|Dependencies|DependenciesConfig
3628
+ /**
3629
+ * Feature that displays a popup containing fields for editing dependency data.
3630
+ * ...
3631
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/SchedulerPro/feature/DependencyEdit)
3632
+ */
3633
+ dependencyEditFeature? : object|boolean|string|DependencyEdit|DependencyEditConfig
3634
+ /**
3635
+ * Adds event filter menu items to the timeline header context menu.
3636
+ * ...
3637
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Scheduler/feature/EventFilter)
3638
+ */
3639
+ eventFilterFeature? : object|boolean|string|EventFilter|EventFilterConfig
3640
+ /**
3641
+ * This feature provides segmented events support. It implements rendering of such events and also adds a entries to the
3642
+ * event context menu allowing to split the selected event and rename segments.
3643
+ * ...
3644
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/SchedulerPro/feature/EventSegments)
3645
+ */
3646
+ eventSegmentsFeature? : object|boolean|string|EventSegments|EventSegmentsConfig
3647
+ /**
3648
+ * A feature that allows exporting Grid data to Excel or CSV without involving the server. It uses
3649
+ * [TableExporter](https://bryntum.com/products/gantt/docs/api/Grid/util/TableExporter) class as data provider, 3rd party provider to generate XLS files, and
3650
+ * [Microsoft XML specification](https://msdn.microsoft.com/en-us/library/office/documentformat.openxml.spreadsheet.aspx).
3651
+ * ...
3652
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/experimental/ExcelExporter)
3653
+ */
3654
+ excelExporterFeature? : object|boolean|string|GridExcelExporter|GridExcelExporterConfig
3655
+ /**
3656
+ * An experimental feature that lets users drop files on a Widget. The widget fires an event when a file is dropped onto it.
3657
+ * In the event, you get access to the raw files as strings, that were parsed by calling `readAsBinaryString`.
3658
+ * ...
3659
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/experimental/FileDrop)
3660
+ */
3661
+ fileDropFeature? : object|boolean|string|FileDrop|FileDropConfig
3662
+ /**
3663
+ * This feature adds a fill handle to a Grid range selection, which when dragged, fills the cells being dragged over
3664
+ * with values based on the values in the original selected range. This is similar to functionality normally seen in
3665
+ * various spreadsheet applications.
3666
+ * ...
3667
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/FillHandle)
3668
+ */
3669
+ fillHandleFeature? : object|boolean|string|FillHandle|FillHandleConfig
3670
+ /**
3671
+ * Feature that allows filtering of the grid by settings filters on columns. The actual filtering is done by the store.
3672
+ * For info on programmatically handling filters, see [StoreFilter](https://bryntum.com/products/gantt/docs/api/Core/data/mixin/StoreFilter).
3673
+ * ...
3674
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/Filter)
3675
+ */
3676
+ filterFeature? : object|boolean|string|Filter|FilterConfig
3677
+ /**
3678
+ * Feature that allows filtering of the grid by entering filters on column headers.
3679
+ * The actual filtering is done by the store.
3680
+ * For info on programmatically handling filters, see [StoreFilter](https://bryntum.com/products/gantt/docs/api/Core/data/mixin/StoreFilter).
3681
+ * ...
3682
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/FilterBar)
3683
+ */
3684
+ filterBarFeature? : object|boolean|string|FilterBar|FilterBarConfig
3685
+ /**
3686
+ * Enables rendering and handling of row groups. The actual grouping is done in the store, but triggered by
3687
+ * <kbd>shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
3688
+ * one anywhere on grid). Use <kbd>shift</kbd> + <kbd>alt</kbd> + click, or the context menu, to remove a column
3689
+ * grouper.
3690
+ * ...
3691
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/Group)
3692
+ */
3693
+ groupFeature? : object|boolean|string|Group|GroupConfig
3694
+ /**
3695
+ * Displays a summary row as a group footer in a grouped grid. Uses the same configuration options on columns as
3696
+ * [Summary](https://bryntum.com/products/gantt/docs/api/Grid/feature/Summary).
3697
+ * ...
3698
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/GroupSummary)
3699
+ */
3700
+ groupSummaryFeature? : object|boolean|string|GridGroupSummary|GridGroupSummaryConfig
3701
+ /**
3702
+ * Right click column header or focus it and press SPACE key to show the context menu for headers.
3703
+ * ...
3704
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/HeaderMenu)
3705
+ */
3706
+ headerMenuFeature? : object|boolean|string|HeaderMenu|HeaderMenuConfig
3707
+ /**
3708
+ * Enables users to click and drag to zoom to a date range in Scheduler's header time axis. Only supported in horizontal
3709
+ * mode.
3710
+ * ...
3711
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Scheduler/feature/HeaderZoom)
3712
+ */
3713
+ headerZoomFeature? : object|boolean|string|HeaderZoom|HeaderZoomConfig
3714
+ /**
3715
+ * The Indicators feature displays indicators (icons) for different dates related to a task in its row. Hovering an
3716
+ * indicator will show a tooltip with its name and date(s). The owning task `id` is embedded in the indicator element
3717
+ * dataset as `taskRecordId` which can be useful if you want to have custom actions when clicking (showing a menu for example).
3718
+ * ...
3719
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/Indicators)
3720
+ */
3721
+ indicatorsFeature? : object|boolean|string|Indicators|IndicatorsConfig
3722
+ /**
3723
+ * A feature that lets you display a label on each side of a Gantt task bar. See
3724
+ * [Labels](https://bryntum.com/products/gantt/docs/api/Scheduler/feature/Labels) for more information.
3725
+ * ...
3726
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/Labels)
3727
+ */
3728
+ labelsFeature? : object|boolean|string|Labels|LabelsConfig
3729
+ /**
3730
+ * This feature allows records which satisfy a certain condition to be locked at the top of the grid.
3731
+ * ...
3732
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/LockRows)
3733
+ */
3734
+ lockRowsFeature? : object|boolean|string|GridLockRows|GridLockRowsConfig
3735
+ /**
3736
+ * 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
3737
+ * configured to [mergeCells](https://bryntum.com/products/gantt/docs/api/Grid/column/Column#config-mergeCells).
3738
+ * ...
3739
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/MergeCells)
3740
+ */
3741
+ mergeCellsFeature? : object|boolean|string|MergeCells|MergeCellsConfig
3742
+ /**
3743
+ * A feature that allows exporting Gantt to Microsoft Project without involving a server.
3744
+ * ...
3745
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/export/MspExport)
3746
+ */
3747
+ mspExportFeature? : object|boolean|string|MspExport|MspExportConfig
3748
+ /**
3749
+ * Feature that allows styling of weekends (and other non-working time) by adding timeRanges for those days.
3750
+ * ...
3751
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Scheduler/feature/NonWorkingTime)
3752
+ */
3753
+ nonWorkingTimeFeature? : object|boolean|string|NonWorkingTime|NonWorkingTimeConfig
3754
+ /**
3755
+ * Makes the scheduler's timeline pannable by dragging with the mouse. Try it out in the demo below.
3756
+ * ...
3757
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Scheduler/feature/Pan)
3758
+ */
3759
+ panFeature? : object|boolean|string|Pan|PanConfig
3760
+ /**
3761
+ * Highlights the area encapsulating all child tasks of a parent task in a semi-transparent layer. You can style
3762
+ * these layer elements using the `b-parent-area` CSS class.
3763
+ * ...
3764
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/ParentArea)
3765
+ */
3766
+ parentAreaFeature? : object|boolean|string|ParentArea|ParentAreaConfig
3767
+ /**
3768
+ * Generates PDF/PNG files from the Gantt component.
3769
+ * ...
3770
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/export/PdfExport)
3771
+ */
3772
+ pdfExportFeature? : object|boolean|string|PdfExport|PdfExportConfig
3773
+ /**
3774
+ * This feature visualizes the [percentDone](https://bryntum.com/products/gantt/docs/api/SchedulerPro/model/mixin/PercentDoneMixin#field-percentDone) field as a
3775
+ * progress bar on the event elements. Each progress bar also optionally has a drag handle which users can drag can
3776
+ * change the value.
3777
+ * ...
3778
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/SchedulerPro/feature/PercentBar)
3779
+ */
3780
+ percentBarFeature? : object|boolean|string|PercentBar|PercentBarConfig
3781
+ /**
3782
+ * Allows pinning columns to the start or end region of the grid without any additional subGrid configurations.
3783
+ * When pinning to a region that does not yet exist, the feature creates the required subGrid on the fly.
3784
+ * ...
3785
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/PinColumns)
3786
+ */
3787
+ pinColumnsFeature? : object|boolean|string|PinColumns|PinColumnsConfig
3788
+ /**
3789
+ * Allows printing Gantt contents using browser print dialog.
3790
+ * ...
3791
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/export/Print)
3792
+ */
3793
+ printFeature? : object|boolean|string|Print|PrintConfig
3794
+ /**
3795
+ * 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
3796
+ * by default, it is)
3797
+ * ...
3798
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/ProgressLine)
3799
+ */
3800
+ progressLineFeature? : object|boolean|string|ProgressLine|ProgressLineConfig
3801
+ /**
3802
+ * Feature that displays the [project editor](https://bryntum.com/products/gantt/docs/api/Gantt/widget/ProjectEditor) allowing users to edit
3803
+ * the project settings.
3804
+ * ...
3805
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/ProjectEdit)
3806
+ */
3807
+ projectEditFeature? : object|boolean|string|ProjectEdit|ProjectEditConfig
3808
+ /**
3809
+ * This feature draws the vertical lines in the schedule area, indicating project start/end dates
3810
+ * and also its [status date](https://bryntum.com/products/gantt/docs/api/Gantt/model/ProjectModel#field-statusDate). The latter can be disabled
3811
+ * with the [showStatusDate](https://bryntum.com/products/gantt/docs/api/Gantt/feature/ProjectLines#config-showStatusDate) config.
3812
+ * ...
3813
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/ProjectLines)
3814
+ */
3815
+ projectLinesFeature? : object|boolean|string|ProjectLines|ProjectLinesConfig
3816
+ /**
3817
+ * Feature that allows the user to search in a column by focusing a cell and typing. Navigate between hits using the
3818
+ * keyboard, [f3] or [ctrl]/[cmd] + [g] moves to next, also pressing [shift] moves to previous.
3819
+ * ...
3820
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/QuickFind)
3821
+ */
3822
+ quickFindFeature? : object|boolean|string|QuickFind|QuickFindConfig
3823
+ /**
3824
+ * Makes the splitter between grid [sections](https://bryntum.com/products/gantt/docs/api/Grid/view/SubGrid) draggable, to let users resize, and
3825
+ * collapse/expand the sections.
3826
+ * ...
3827
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/RegionResize)
3828
+ */
3829
+ regionResizeFeature? : object|boolean|string|RegionResize|RegionResizeConfig
3830
+ /**
3831
+ * 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.
3832
+ * Each of the rollup elements show a tooltip when hovering it with details of the task.
3833
+ * The tooltip content is customizable, see [template](https://bryntum.com/products/gantt/docs/api/Gantt/feature/Rollups#config-template) config for details.
3834
+ * ...
3835
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/Rollups)
3836
+ */
3837
+ rollupsFeature? : object|boolean|string|Rollups|RollupsConfig
3838
+ /**
3839
+ * Allow using [Ctrl/CMD + C/X] and [Ctrl/CMD + V] to copy/cut-and-paste rows. Also makes cut, copy and paste actions
3840
+ * available via the cell context menu.
3841
+ * ...
3842
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/RowCopyPaste)
3843
+ */
3844
+ rowCopyPasteFeature? : object|boolean|string|RowCopyPaste|RowCopyPasteConfig
3845
+ /**
3846
+ * This feature allows editing of entire rows in a grid in a docked panel which by default slides out from the right.
3847
+ * ...
3848
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/RowEdit)
3849
+ */
3850
+ rowEditFeature? : object|boolean|string|RowEdit|RowEditConfig
3851
+ /**
3852
+ * Enables expanding of Grid rows by either row click or double click, or by adding a separate Grid column which renders
3853
+ * a button that expands or collapses the row.
3854
+ * ...
3855
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/RowExpander)
3856
+ */
3857
+ rowExpanderFeature? : object|boolean|string|RowExpander|RowExpanderConfig
3858
+ /**
3859
+ * This feature implements support for project transactions and used by default in Gantt. For general RowReorder feature
3860
+ * documentation see [RowReorder](https://bryntum.com/products/gantt/docs/api/Grid/feature/RowReorder).
3861
+ * ...
3862
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Scheduler/feature/RowReorder)
3863
+ */
3864
+ rowReorderFeature? : object|boolean|string|RowReorder|RowReorderConfig
3865
+ /**
3866
+ * 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)
3867
+ * field of the record is updated (when [applyToAllRows](https://bryntum.com/products/gantt/docs/api/Grid/feature/RowResize#config-applyToAllRows) is `false`).
3868
+ * ...
3869
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/RowResize)
3870
+ */
3871
+ rowResizeFeature? : object|boolean|string|GridRowResize|GridRowResizeConfig
3872
+ /**
3873
+ * Displays a context menu for empty parts of the schedule. Items are populated in the first place
3874
+ * by configurations of this Feature, then by other features and/or application code.
3875
+ * ...
3876
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Scheduler/feature/ScheduleMenu)
3877
+ */
3878
+ scheduleMenuFeature? : object|boolean|string|ScheduleMenu|ScheduleMenuConfig
3879
+ /**
3880
+ * Feature that displays a tooltip containing the time at the mouse position when hovering empty parts of the schedule.
3881
+ * ...
3882
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Scheduler/feature/ScheduleTooltip)
3883
+ */
3884
+ scheduleTooltipFeature? : object|boolean|string|ScheduleTooltip|ScheduleTooltipConfig
3885
+ /**
3886
+ * This feature injects buttons in each row that scrolls the task bar into view. It can optionally show a label along
3887
+ * with the button, using the [labelRenderer](https://bryntum.com/products/gantt/docs/api/Gantt/feature/ScrollButtons#config-labelRenderer).
3888
+ * ...
3889
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/ScrollButtons)
3890
+ */
3891
+ scrollButtonsFeature? : object|boolean|string|ScrollButtons|ScrollButtonsConfig
3892
+ /**
3893
+ * <div class="external-example vertical" data-file="Grid/feature/Search.js"></div>
3894
+ * ...
3895
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/Search)
3896
+ */
3897
+ searchFeature? : object|boolean|string|Search|SearchConfig
3898
+ /**
3899
+ * Allows sorting of grid by clicking (or tapping) headers, also displays which columns grid is sorted by (numbered if
3900
+ * using multisort). Use modifier keys for multisorting: [Ctrl/CMD + click] to add sorter, [Ctrl/CMD + Alt + click] to remove sorter.
3901
+ * The actual sorting is done by the store, see [Store.sort()](https://bryntum.com/products/gantt/docs/api/Core/data/mixin/StoreSort#function-sort).
3902
+ * ...
3903
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/Sort)
3904
+ */
3905
+ sortFeature? : object|boolean|string|Sort|SortConfig
3906
+ /**
3907
+ * This feature allows splitting the Grid into multiple views, either by using the cell context menu, or
3908
+ * programmatically by calling [split()](https://bryntum.com/products/gantt/docs/api/Grid/feature/Split#function-split).
3909
+ * ...
3910
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/Split)
3911
+ */
3912
+ splitFeature? : object|boolean|string|GridSplit|GridSplitConfig
3913
+ /**
3914
+ * A feature which pins configurable content from a grid row to the top of the grid
3915
+ * while the row scrolls off the top but is still visible.
3916
+ * ...
3917
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/StickyCells)
3918
+ */
3919
+ stickyCellsFeature? : object|boolean|string|StickyCells|StickyCellsConfig
3920
+ /**
3921
+ * Stripes rows by adding alternating CSS classes to all row elements (`b-even` and `b-odd`).
3922
+ * ...
3923
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/Stripe)
3924
+ */
3925
+ stripeFeature? : object|boolean|string|Stripe|StripeConfig
3926
+ /**
3927
+ * A feature displaying a summary bar in the grid footer.
3928
+ * ...
3929
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/Summary)
3930
+ */
3931
+ summaryFeature? : object|boolean|string|Summary|SummaryConfig
3932
+ /**
3933
+ * Allow using <kbd>Ctrl</kbd>/<kbd>CMD</kbd> + <kbd>C</kbd>/<kbd>X</kbd> and <kbd>Ctrl</kbd>/<kbd>CMD</kbd> +
3934
+ * <kbd>V</kbd> to copy/cut and paste tasks. You can configure how a newly pasted record is named using
3935
+ * [generateNewName](https://bryntum.com/products/gantt/docs/api/Gantt/feature/TaskCopyPaste#config-generateNewName)
3936
+ * ...
3937
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/TaskCopyPaste)
3938
+ */
3939
+ taskCopyPasteFeature? : object|boolean|string|TaskCopyPaste|TaskCopyPasteConfig
3940
+ /**
3941
+ * Allows user to drag and drop tasks within Gantt, to change their start date.
3942
+ * ...
3943
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/TaskDrag)
3944
+ */
3945
+ taskDragFeature? : object|boolean|string|TaskDrag|TaskDragConfig
3946
+ /**
3947
+ * 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.
3948
+ * ...
3949
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/TaskDragCreate)
3950
+ */
3951
+ taskDragCreateFeature? : object|boolean|string|TaskDragCreate|TaskDragCreateConfig
3952
+ /**
3953
+ * 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.
3954
+ * ...
3955
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/TaskEdit)
3956
+ */
3957
+ taskEditFeature? : object|boolean|string|TaskEdit|TaskEditConfig
3958
+ /**
3959
+ * Displays a context menu for tasks. Items are populated by other features and/or application code.
3960
+ * Configure it with `false` to disable it completely. If enabled, [CellMenu](https://bryntum.com/products/gantt/docs/api/Grid/feature/CellMenu) feature
3961
+ * is not available. Cell context menu items are handled by this feature.
3962
+ * ...
3963
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/TaskMenu)
3964
+ */
3965
+ taskMenuFeature? : object|boolean|string|TaskMenu|TaskMenuConfig
3966
+ /**
3967
+ * 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).
3968
+ * If a task has no calendar defined, the project's calendar will be used. The non-working time interval can also be
3969
+ * recurring. You can find a live example showing how to achieve this in the [Task Calendars Demo](../examples/calendars/).
3970
+ * ...
3971
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/TaskNonWorkingTime)
3972
+ */
3973
+ taskNonWorkingTimeFeature? : object|boolean|string|TaskNonWorkingTime|TaskNonWorkingTimeConfig
3974
+ /**
3975
+ * Feature that allows resizing a task by dragging its end date. Resizing a task by dragging its start date is not allowed.
3976
+ * ...
3977
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/TaskResize)
3978
+ */
3979
+ taskResizeFeature? : object|boolean|string|TaskResize|TaskResizeConfig
3980
+ /**
3981
+ * Allows user to drag and drop task segments, to change their start date.
3982
+ * ...
3983
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/TaskSegmentDrag)
3984
+ */
3985
+ taskSegmentDragFeature? : object|boolean|string|TaskSegmentDrag|TaskSegmentDragConfig
3986
+ /**
3987
+ * Feature that allows resizing a task segment by dragging its end.
3988
+ * ...
3989
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/TaskSegmentResize)
3990
+ */
3991
+ taskSegmentResizeFeature? : object|boolean|string|TaskSegmentResize|TaskSegmentResizeConfig
3992
+ /**
3993
+ * This feature displays a task tooltip on mouse hover. The template of the tooltip is customizable
3994
+ * with the [template](https://bryntum.com/products/gantt/docs/api/Gantt/feature/TaskTooltip#config-template) function.
3995
+ * ...
3996
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/TaskTooltip)
3997
+ */
3998
+ taskTooltipFeature? : object|boolean|string|TaskTooltip|TaskTooltipConfig
3999
+ /**
4000
+ * Adds scheduler specific menu items to the timeline header context menu.
4001
+ * ...
4002
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Scheduler/feature/TimeAxisHeaderMenu)
4003
+ */
4004
+ timeAxisHeaderMenuFeature? : object|boolean|string|TimeAxisHeaderMenu|TimeAxisHeaderMenuConfig
4005
+ /**
4006
+ * This feature allows drawing line charts on top of the timeline area. Feature consists of two parts: chart and
4007
+ * data providers. Chart provider is responsible for rendering the chart, while data provider is responsible
4008
+ * for providing data for the chart. Feature itself manages the interaction between them, and tracks lifecycle events
4009
+ * of the Gantt chart.
4010
+ * ...
4011
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/TimelineChart)
4012
+ */
4013
+ timelineChartFeature? : object|boolean|string|TimelineChart|TimelineChartConfig
4014
+ /**
4015
+ * Feature that renders global ranges of time in the timeline. Use this feature to visualize a `range` like a 1 hr lunch
4016
+ * or some important point in time (a `line`, i.e. a range with 0 duration). This feature can also show a current time
4017
+ * 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
4018
+ * [cls](https://bryntum.com/products/gantt/docs/api/Scheduler/model/TimeSpan#field-cls) field of the `TimeSpan` class.
4019
+ * ...
4020
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Scheduler/feature/TimeRanges)
4021
+ */
4022
+ timeRangesFeature? : object|boolean|string|TimeRanges|TimeRangesConfig
4023
+ /**
4024
+ * This feature exposes methods on the owning Scheduler or Gantt widget which you can use to highlight one or multiple time spans
4025
+ * 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
4026
+ * more or try the demo below:
4027
+ * ...
4028
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/SchedulerPro/feature/TimeSpanHighlight)
4029
+ */
4030
+ timeSpanHighlightFeature? : object|boolean|string|TimeSpanHighlight|TimeSpanHighlightConfig
4031
+ /**
4032
+ * 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
4033
+ * 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
4034
+ * tree renderer that adds padding and icon to give the appearance of a tree. The original renderer is preserved and
4035
+ * also called.
4036
+ * ...
4037
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/Tree)
4038
+ */
4039
+ treeFeature? : object|boolean|string|Tree|TreeConfig
4040
+ /**
4041
+ * 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.
4042
+ * Allows generating a new task tree where parents are determined by the values of specified task fields/functions:
4043
+ * ...
4044
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/TreeGroup)
4045
+ */
4046
+ treeGroupFeature? : object|boolean|string|TreeGroup|TreeGroupConfig
4047
+ /**
4048
+ * Captures versions (snapshots) of the active project, including a detailed log of the changes new in each version.
4049
+ * ...
4050
+ * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/Versions)
4051
+ */
4052
+ versionsFeature? : object|boolean|string|Versions|VersionsConfig
4053
+
4054
+ }
4055
+
4056
+ export class BryntumGanttBase extends React.Component<BryntumGanttBaseProps> {
4057
+
4058
+ static instanceClass = GanttBase;
4059
+
4060
+ static instanceName = 'GanttBase';
4061
+
4062
+ processWidgetContent = processWidgetContent;
4063
+
4064
+ // Component is View class
4065
+ static isView = true;
4066
+
4067
+ // Hidden div to host unused portals DOM
4068
+ portalsCache? : HTMLElement;
4069
+
4070
+ // CSS class used for individual portal containers
4071
+ portalContainerClass = 'b-react-portal-container';
4072
+
4073
+ state = {
4074
+ // Holds React portals
4075
+ portals : new Map(),
4076
+
4077
+ // Needed to trigger refresh when portals change
4078
+ generation : 0
4079
+ };
4080
+
4081
+ static featureNames = [
4082
+ 'aiFilterFeature',
4083
+ 'baselinesFeature',
4084
+ 'cellCopyPasteFeature',
4085
+ 'cellEditFeature',
4086
+ 'cellMenuFeature',
4087
+ 'cellTooltipFeature',
4088
+ 'chartsFeature',
4089
+ 'columnAutoWidthFeature',
4090
+ 'columnDragToolbarFeature',
4091
+ 'columnLinesFeature',
4092
+ 'columnPickerFeature',
4093
+ 'columnRenameFeature',
4094
+ 'columnReorderFeature',
4095
+ 'columnResizeFeature',
4096
+ 'criticalPathsFeature',
4097
+ 'dependenciesFeature',
4098
+ 'dependencyEditFeature',
4099
+ 'eventFilterFeature',
4100
+ 'eventSegmentsFeature',
4101
+ 'excelExporterFeature',
4102
+ 'fileDropFeature',
4103
+ 'fillHandleFeature',
4104
+ 'filterFeature',
4105
+ 'filterBarFeature',
4106
+ 'groupFeature',
4107
+ 'groupSummaryFeature',
4108
+ 'headerMenuFeature',
4109
+ 'headerZoomFeature',
4110
+ 'indicatorsFeature',
4111
+ 'labelsFeature',
4112
+ 'lockRowsFeature',
4113
+ 'mergeCellsFeature',
4114
+ 'mspExportFeature',
4115
+ 'nonWorkingTimeFeature',
4116
+ 'panFeature',
4117
+ 'parentAreaFeature',
4118
+ 'pdfExportFeature',
4119
+ 'percentBarFeature',
4120
+ 'pinColumnsFeature',
4121
+ 'printFeature',
4122
+ 'progressLineFeature',
4123
+ 'projectEditFeature',
4124
+ 'projectLinesFeature',
4125
+ 'quickFindFeature',
4126
+ 'regionResizeFeature',
4127
+ 'rollupsFeature',
4128
+ 'rowCopyPasteFeature',
4129
+ 'rowEditFeature',
4130
+ 'rowExpanderFeature',
4131
+ 'rowReorderFeature',
4132
+ 'rowResizeFeature',
4133
+ 'scheduleMenuFeature',
4134
+ 'scheduleTooltipFeature',
4135
+ 'scrollButtonsFeature',
4136
+ 'searchFeature',
4137
+ 'sortFeature',
4138
+ 'splitFeature',
4139
+ 'stickyCellsFeature',
4140
+ 'stripeFeature',
4141
+ 'summaryFeature',
4142
+ 'taskCopyPasteFeature',
4143
+ 'taskDragFeature',
4144
+ 'taskDragCreateFeature',
4145
+ 'taskEditFeature',
4146
+ 'taskMenuFeature',
4147
+ 'taskNonWorkingTimeFeature',
4148
+ 'taskResizeFeature',
4149
+ 'taskSegmentDragFeature',
4150
+ 'taskSegmentResizeFeature',
4151
+ 'taskTooltipFeature',
4152
+ 'timeAxisHeaderMenuFeature',
4153
+ 'timelineChartFeature',
4154
+ 'timeRangesFeature',
4155
+ 'timeSpanHighlightFeature',
4156
+ 'treeFeature',
4157
+ 'treeGroupFeature',
4158
+ 'versionsFeature'
4159
+ ];
4160
+
4161
+ projectStores = true;
4162
+
4163
+ dataStores = {
4164
+ 'assignmentStore': 'assignments',
4165
+ 'calendarManagerStore': 'calendars',
4166
+ 'dependencyStore': 'dependencies',
4167
+ 'eventStore': 'events',
4168
+ 'resourceStore': 'resources',
4169
+ 'taskStore': 'tasks',
4170
+ 'timeRangeStore': 'timeRanges'
4171
+ };
4172
+
4173
+ static configNames = [
4174
+ 'adopt',
4175
+ 'allowCreate',
4176
+ 'allowCreateOnlyParent',
4177
+ 'animateFilterRemovals',
4178
+ 'animateRemovingRows',
4179
+ 'ariaDescription',
4180
+ 'ariaLabel',
4181
+ 'autoAdjustTimeAxis',
4182
+ 'autoHeight',
4183
+ 'bbar',
4184
+ 'bodyCls',
4185
+ 'bubbleEvents',
4186
+ 'bufferCoef',
4187
+ 'bufferThreshold',
4188
+ 'collapsible',
4189
+ 'color',
4190
+ 'config',
4191
+ 'contentElementCls',
4192
+ 'contextMenuTriggerEvent',
4193
+ 'creationTooltip',
4194
+ 'cycleResolutionPopupClass',
4195
+ 'dataField',
4196
+ 'defaultRegion',
4197
+ 'defaultResourceImageName',
4198
+ 'dependencyIdField',
4199
+ 'destroyStore',
4200
+ 'detectCSSCompatibilityIssues',
4201
+ 'disableGridColumnIdWarning',
4202
+ 'disableGridRowModelWarning',
4203
+ 'displaySchedulingIssueResolutionPopup',
4204
+ 'dock',
4205
+ 'drawer',
4206
+ 'durationDisplayPrecision',
4207
+ 'elementAttributes',
4208
+ 'enableDeleteKey',
4209
+ 'enableRecurringEvents',
4210
+ 'enableSticky',
4211
+ 'enableTextSelection',
4212
+ 'enableTransactionalFeatures',
4213
+ 'fillLastColumn',
4214
+ 'fixedRowHeight',
4215
+ 'footer',
4216
+ 'formulaProviders',
4217
+ 'fullRowRefresh',
4218
+ 'getDateConstraints',
4219
+ 'getRowHeight',
4220
+ 'header',
4221
+ 'hideHorizontalScrollbar',
4222
+ 'hoverCls',
4223
+ 'icon',
4224
+ 'ignoreDomEventsWhileScrolling',
4225
+ 'ignoreParentReadOnly',
4226
+ 'listeners',
4227
+ 'loadMask',
4228
+ 'loadMaskDefaults',
4229
+ 'loadMaskError',
4230
+ 'localizable',
4231
+ 'managedEventSizing',
4232
+ 'maskDefaults',
4233
+ 'masked',
4234
+ 'maxDate',
4235
+ 'maxTimeAxisUnit',
4236
+ 'minDate',
4237
+ 'monitorResize',
4238
+ 'newTaskDefaults',
4239
+ 'owner',
4240
+ 'partner',
4241
+ 'plugins',
4242
+ 'preserveFocusOnDatasetChange',
4243
+ 'preserveScrollOnDatasetChange',
4244
+ 'preventTooltipOnTouch',
4245
+ 'projectProgressReporting',
4246
+ 'relayStoreEvents',
4247
+ 'resizable',
4248
+ 'resizeToFitIncludesHeader',
4249
+ 'resourceImageFolderPath',
4250
+ 'resourceImagePath',
4251
+ 'responsiveLevels',
4252
+ 'ripple',
4253
+ 'rootElement',
4254
+ 'schedulingIssueResolutionPopupClass',
4255
+ 'scrollerClass',
4256
+ 'scrollManager',
4257
+ 'showCostControls',
4258
+ 'showCreationTooltip',
4259
+ 'showDirty',
4260
+ 'showLagInTooltip',
4261
+ 'showRecurringUI',
4262
+ 'showTaskColorPickers',
4263
+ 'snapRelativeToEventStartDate',
4264
+ 'stateful',
4265
+ 'statefulEvents',
4266
+ 'stateId',
4267
+ 'stateProvider',
4268
+ 'stickyHeaders',
4269
+ 'strips',
4270
+ 'subGridConfigs',
4271
+ 'syncMask',
4272
+ 'tab',
4273
+ 'tabBarItems',
4274
+ 'taskRenderer',
4275
+ 'tbar',
4276
+ 'terminalCls',
4277
+ 'terminalSides',
4278
+ 'timeAxis',
4279
+ 'ui',
4280
+ 'visibleZoomFactor',
4281
+ 'weekStartDay',
4282
+ 'weight',
4283
+ 'zoomKeepsOriginalTimespan',
4284
+ 'zoomOnMouseWheel',
4285
+ 'zoomOnTimeAxisDoubleClick'
4286
+ ];
4287
+
4288
+ static propertyConfigNames = [
4289
+ 'alignSelf',
4290
+ 'allowDropOnEventBar',
4291
+ 'animateTreeNodeToggle',
4292
+ 'appendTo',
4293
+ 'assignments',
4294
+ 'barMargin',
4295
+ 'calendars',
4296
+ 'callOnFunctions',
4297
+ 'catchEventHandlerExceptions',
4298
+ 'cellEllipsis',
4299
+ 'cls',
4300
+ 'collapsed',
4301
+ 'column',
4302
+ 'columnLines',
4303
+ 'columns',
4304
+ 'creationTooltipTemplate',
4305
+ 'data',
4306
+ 'dataset',
4307
+ 'dependencies',
4308
+ 'disabled',
4309
+ 'displayDateFormat',
4310
+ 'emptyText',
4311
+ 'enableEventAnimations',
4312
+ 'enableUndoRedoKeys',
4313
+ 'endDate',
4314
+ 'eventColor',
4315
+ 'eventStyle',
4316
+ 'extraData',
4317
+ 'fillTicks',
4318
+ 'flex',
4319
+ 'forceFit',
4320
+ 'height',
4321
+ 'hidden',
4322
+ 'hideFooters',
4323
+ 'hideHeaders',
4324
+ 'hideRowHover',
4325
+ 'id',
4326
+ 'infiniteScroll',
4327
+ 'inputFieldAlign',
4328
+ 'insertBefore',
4329
+ 'insertFirst',
4330
+ 'keyMap',
4331
+ 'labelPosition',
4332
+ 'longPressTime',
4333
+ 'margin',
4334
+ 'maxHeight',
4335
+ 'maxWidth',
4336
+ 'maxZoomLevel',
4337
+ 'minHeight',
4338
+ 'minWidth',
4339
+ 'minZoomLevel',
4340
+ 'onAfterDependencyCreateDrop',
4341
+ 'onAfterDependencySave',
4342
+ 'onAfterDragCreate',
4343
+ 'onAfterEventEdit',
4344
+ 'onAfterEventSave',
4345
+ 'onAfterProjectEdit',
4346
+ 'onAfterProjectSave',
4347
+ 'onAfterTaskDrop',
4348
+ 'onAfterTaskEdit',
4349
+ 'onAfterTaskSave',
4350
+ 'onAfterTaskSegmentDrop',
4351
+ 'onBeforeAssignmentDelete',
4352
+ 'onBeforeCancelCellEdit',
4353
+ 'onBeforeCancelRowEdit',
4354
+ 'onBeforeCellEditStart',
4355
+ 'onBeforeCellRangeDelete',
4356
+ 'onBeforeCellRangeEdit',
4357
+ 'onBeforeColumnDragStart',
4358
+ 'onBeforeColumnDropFinalize',
4359
+ 'onBeforeColumnResize',
4360
+ 'onBeforeCopy',
4361
+ 'onBeforeCSVExport',
4362
+ 'onBeforeDependencyAdd',
4363
+ 'onBeforeDependencyCreateDrag',
4364
+ 'onBeforeDependencyCreateFinalize',
4365
+ 'onBeforeDependencyDelete',
4366
+ 'onBeforeDependencyEdit',
4367
+ 'onBeforeDependencyEditShow',
4368
+ 'onBeforeDependencySave',
4369
+ 'onBeforeDestroy',
4370
+ 'onBeforeDragCreate',
4371
+ 'onBeforeDragCreateFinalize',
4372
+ 'onBeforeEventDelete',
4373
+ 'onBeforeEventEdit',
4374
+ 'onBeforeEventEditShow',
4375
+ 'onBeforeEventResize',
4376
+ 'onBeforeEventResizeFinalize',
4377
+ 'onBeforeEventSave',
4378
+ 'onBeforeEventSegmentResize',
4379
+ 'onBeforeEventSegmentResizeFinalize',
4380
+ 'onBeforeExcelExport',
4381
+ 'onBeforeFillHandleDragStart',
4382
+ 'onBeforeFinishCellEdit',
4383
+ 'onBeforeFinishRowEdit',
4384
+ 'onBeforeHide',
4385
+ 'onBeforeMspExport',
4386
+ 'onBeforePan',
4387
+ 'onBeforePaste',
4388
+ 'onBeforePdfExport',
4389
+ 'onBeforePresetChange',
4390
+ 'onBeforeProjectEdit',
4391
+ 'onBeforeProjectEditShow',
4392
+ 'onBeforeProjectSave',
4393
+ 'onBeforeRenderRow',
4394
+ 'onBeforeRenderRows',
4395
+ 'onBeforeRowCollapse',
4396
+ 'onBeforeRowExpand',
4397
+ 'onBeforeSelectionChange',
4398
+ 'onBeforeSetRecord',
4399
+ 'onBeforeShow',
4400
+ 'onBeforeShowTerminals',
4401
+ 'onBeforeStartRowEdit',
4402
+ 'onBeforeStateApply',
4403
+ 'onBeforeStateSave',
4404
+ 'onBeforeTaskAdd',
4405
+ 'onBeforeTaskDelete',
4406
+ 'onBeforeTaskDrag',
4407
+ 'onBeforeTaskDropFinalize',
4408
+ 'onBeforeTaskEdit',
4409
+ 'onBeforeTaskEditShow',
4410
+ 'onBeforeTaskResize',
4411
+ 'onBeforeTaskResizeFinalize',
4412
+ 'onBeforeTaskSave',
4413
+ 'onBeforeTaskSegmentDrag',
4414
+ 'onBeforeTaskSegmentDropFinalize',
4415
+ 'onBeforeTaskSegmentResize',
4416
+ 'onBeforeTaskSegmentResizeFinalize',
4417
+ 'onBeforeToggleGroup',
4418
+ 'onBeforeToggleNode',
4419
+ 'onCancelCellEdit',
4420
+ 'onCatchAll',
4421
+ 'onCellClick',
4422
+ 'onCellContextMenu',
4423
+ 'onCellDblClick',
4424
+ 'onCellMenuBeforeShow',
4425
+ 'onCellMenuItem',
4426
+ 'onCellMenuShow',
4427
+ 'onCellMenuToggleItem',
4428
+ 'onCellMouseEnter',
4429
+ 'onCellMouseLeave',
4430
+ 'onCellMouseOut',
4431
+ 'onCellMouseOver',
4432
+ 'onCollapse',
4433
+ 'onCollapseNode',
4434
+ 'onColumnDrag',
4435
+ 'onColumnDragStart',
4436
+ 'onColumnDrop',
4437
+ 'onColumnResize',
4438
+ 'onColumnResizeStart',
4439
+ 'onContextMenuItem',
4440
+ 'onContextMenuToggleItem',
4441
+ 'onCopy',
4442
+ 'onCriticalPathsHighlighted',
4443
+ 'onCriticalPathsUnhighlighted',
4444
+ 'onCurrentTimelineUpdate',
4445
+ 'onDataChange',
4446
+ 'onDateRangeChange',
4447
+ 'onDependenciesDrawn',
4448
+ 'onDependencyClick',
4449
+ 'onDependencyContextMenu',
4450
+ 'onDependencyCreateDragStart',
4451
+ 'onDependencyCreateDrop',
4452
+ 'onDependencyDblClick',
4453
+ 'onDependencyMouseOut',
4454
+ 'onDependencyMouseOver',
4455
+ 'onDependencyValidationComplete',
4456
+ 'onDependencyValidationStart',
4457
+ 'onDestroy',
4458
+ 'onDirtyStateChange',
4459
+ 'onDragCreateEnd',
4460
+ 'onDragCreateStart',
4461
+ 'onDragSelecting',
4462
+ 'onElementCreated',
4463
+ 'onEventEditBeforeSetRecord',
4464
+ 'onEventMenuBeforeShow',
4465
+ 'onEventMenuItem',
4466
+ 'onEventMenuShow',
4467
+ 'onEventPartialResize',
4468
+ 'onEventResizeEnd',
4469
+ 'onEventResizeStart',
4470
+ 'onEventSegmentPartialResize',
4471
+ 'onEventSegmentResizeEnd',
4472
+ 'onEventSegmentResizeStart',
4473
+ 'onExpand',
4474
+ 'onExpandNode',
4475
+ 'onFileDrop',
4476
+ 'onFillHandleBeforeDragFinalize',
4477
+ 'onFillHandleDrag',
4478
+ 'onFillHandleDragAbort',
4479
+ 'onFillHandleDragEnd',
4480
+ 'onFillHandleDragStart',
4481
+ 'onFinishCellEdit',
4482
+ 'onFinishRowEdit',
4483
+ 'onFocusIn',
4484
+ 'onFocusOut',
4485
+ 'onGridRowBeforeDragStart',
4486
+ 'onGridRowBeforeDropFinalize',
4487
+ 'onGridRowDrag',
4488
+ 'onGridRowDragAbort',
4489
+ 'onGridRowDragStart',
4490
+ 'onGridRowDrop',
4491
+ 'onHeaderClick',
4492
+ 'onHeaderMenuBeforeShow',
4493
+ 'onHeaderMenuItem',
4494
+ 'onHeaderMenuShow',
4495
+ 'onHeaderMenuToggleItem',
4496
+ 'onHide',
4497
+ 'onLockRows',
4498
+ 'onMouseOut',
4499
+ 'onMouseOver',
4500
+ 'onMspExport',
4501
+ 'onNavigate',
4502
+ 'onNoZoomChange',
4503
+ 'onPaint',
4504
+ 'onPaste',
4505
+ 'onPdfExport',
4506
+ 'onPercentBarDrag',
4507
+ 'onPercentBarDragAbort',
4508
+ 'onPercentBarDragStart',
4509
+ 'onPercentBarDrop',
4510
+ 'onPresetChange',
4511
+ 'onProjectEditCanceled',
4512
+ 'onReadOnly',
4513
+ 'onRecompose',
4514
+ 'onReleaseTask',
4515
+ 'onRenderRow',
4516
+ 'onRenderRows',
4517
+ 'onRenderTask',
4518
+ 'onResize',
4519
+ 'onResourceAssignmentClick',
4520
+ 'onResponsive',
4521
+ 'onRowCollapse',
4522
+ 'onRowExpand',
4523
+ 'onRowMouseEnter',
4524
+ 'onRowMouseLeave',
4525
+ 'onScheduleMenuBeforeShow',
4526
+ 'onScheduleMenuItem',
4527
+ 'onScheduleMenuShow',
4528
+ 'onScroll',
4529
+ 'onScrollButtonClick',
4530
+ 'onSelectionChange',
4531
+ 'onSelectionModeChange',
4532
+ 'onShow',
4533
+ 'onSplit',
4534
+ 'onSplitterCollapseClick',
4535
+ 'onSplitterDragEnd',
4536
+ 'onSplitterDragStart',
4537
+ 'onSplitterExpandClick',
4538
+ 'onStartCellEdit',
4539
+ 'onStartRowEdit',
4540
+ 'onSubGridCollapse',
4541
+ 'onSubGridExpand',
4542
+ 'onTaskClick',
4543
+ 'onTaskContextMenu',
4544
+ 'onTaskDblClick',
4545
+ 'onTaskDrag',
4546
+ 'onTaskDragStart',
4547
+ 'onTaskDrop',
4548
+ 'onTaskEditCanceled',
4549
+ 'onTaskKeyDown',
4550
+ 'onTaskKeyUp',
4551
+ 'onTaskMenuBeforeShow',
4552
+ 'onTaskMenuItem',
4553
+ 'onTaskMenuShow',
4554
+ 'onTaskMouseDown',
4555
+ 'onTaskMouseOut',
4556
+ 'onTaskMouseOver',
4557
+ 'onTaskMouseUp',
4558
+ 'onTaskNonWorkingTimeClick',
4559
+ 'onTaskNonWorkingTimeContextMenu',
4560
+ 'onTaskNonWorkingTimeDblClick',
4561
+ 'onTaskPartialResize',
4562
+ 'onTaskResizeEnd',
4563
+ 'onTaskResizeStart',
4564
+ 'onTaskSegmentDrag',
4565
+ 'onTaskSegmentDragStart',
4566
+ 'onTaskSegmentDrop',
4567
+ 'onTaskSegmentPartialResize',
4568
+ 'onTaskSegmentResizeEnd',
4569
+ 'onTaskSegmentResizeStart',
4570
+ 'onTickSizeChange',
4571
+ 'onTimeAxisChange',
4572
+ 'onTimeAxisHeaderClick',
4573
+ 'onTimeAxisHeaderContextMenu',
4574
+ 'onTimeAxisHeaderDblClick',
4575
+ 'onTimeAxisHeaderMenuBeforeShow',
4576
+ 'onTimeAxisHeaderMenuItem',
4577
+ 'onTimeAxisHeaderMenuShow',
4578
+ 'onTimelineContextChange',
4579
+ 'onTimelineViewportResize',
4580
+ 'onTimeRangeHeaderClick',
4581
+ 'onTimeRangeHeaderContextMenu',
4582
+ 'onTimeRangeHeaderDblClick',
4583
+ 'onToggleGroup',
4584
+ 'onToggleNode',
4585
+ 'onToolClick',
4586
+ 'onTransactionChange',
4587
+ 'onUnlockRows',
4588
+ 'onUnsplit',
4589
+ 'onVisibleDateRangeChange',
4590
+ 'preserveScroll',
4591
+ 'presets',
4592
+ 'project',
4593
+ 'readOnly',
4594
+ 'recurrenceConfirmationPopup',
4595
+ 'rendition',
4596
+ 'resources',
4597
+ 'rowHeight',
4598
+ 'rowLines',
4599
+ 'rtl',
4600
+ 'scrollable',
4601
+ 'scrollTaskIntoViewOnCellClick',
4602
+ 'selectionMode',
4603
+ 'showTooltip',
4604
+ 'showUnscheduledTasks',
4605
+ 'snap',
4606
+ 'span',
4607
+ 'startDate',
4608
+ 'stateSettings',
4609
+ 'store',
4610
+ 'suppressFit',
4611
+ 'tasks',
4612
+ 'taskStore',
4613
+ 'terminalHideDelay',
4614
+ 'terminalOffset',
4615
+ 'terminalShowDelay',
4616
+ 'terminalSize',
4617
+ 'tickSize',
4618
+ 'timeRanges',
4619
+ 'timeResolution',
4620
+ 'timeZone',
4621
+ 'title',
4622
+ 'toggleParentTasksOnClick',
4623
+ 'tools',
4624
+ 'tooltipTemplate',
4625
+ 'transition',
4626
+ 'transitionDuration',
4627
+ 'useContextualRecurrenceRules',
4628
+ 'viewPreset',
4629
+ 'visibleDate',
4630
+ 'width',
4631
+ 'workingTime'
4632
+ ];
4633
+
4634
+ static propertyNames = [
4635
+ 'calendarManagerStore',
4636
+ 'focusVisible',
4637
+ 'hasChanges',
4638
+ 'originalStore',
4639
+ 'parent',
4640
+ 'scrollLeft',
4641
+ 'scrollTop',
4642
+ 'scrollX',
4643
+ 'selectedCell',
4644
+ 'selectedCells',
4645
+ 'selectedRecord',
4646
+ 'selectedRecords',
4647
+ 'selectedRows',
4648
+ 'state',
4649
+ 'tooltip',
4650
+ 'zoomLevel'
4651
+ ];
4652
+
4653
+ // Component instance
4654
+ instance!: GanttBase;
4655
+
4656
+ // Component element
4657
+ element! : HTMLElement;
4658
+
4659
+ componentDidMount(): void {
4660
+ this.instance = createWidget(this);
4661
+ }
4662
+
4663
+ componentWillUnmount(): void {
4664
+ // @ts-ignore
4665
+ this.instance?.destroy?.();
4666
+ }
4667
+
4668
+ /**
4669
+ * Component about to be updated, from changing a prop using state.
4670
+ * React to it depending on what changed and prevent react from re-rendering our component.
4671
+ * @param nextProps
4672
+ * @param nextState
4673
+ * @returns {boolean}
4674
+ */
4675
+ shouldComponentUpdate(nextProps: Readonly<BryntumGanttBaseProps>, nextState: Readonly<{}>): boolean {
4676
+ return shouldComponentUpdate(this, nextProps, nextState);
4677
+ }
4678
+
4679
+ render(): React.ReactNode {
4680
+
4681
+ const className = `b-react-gantt-base-container`;
4682
+ return (
4683
+ <React.Fragment>
4684
+ <div className={className} ref={(element) => (this.element = element!)}>
4685
+ {Array.from(this.state.portals).map((item) => item[1])}
4686
+ </div>
4687
+ <div ref={el => (this.portalsCache = el!)} className="b-react-portals-cache" style={{ display : 'none' }}></div>
4688
+ </React.Fragment>
4689
+ );
4690
+
4691
+ }
4692
+ }