@bryntum/calendar-vue-3 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 (520) hide show
  1. package/README.md +53 -0
  2. package/lib/chunks/6e5LeSJU.js +348 -0
  3. package/lib/chunks/6e5LeSJU.js.map +1 -0
  4. package/lib/chunks/Au1iuOl5.js +231 -0
  5. package/lib/chunks/Au1iuOl5.js.map +1 -0
  6. package/lib/chunks/AuFgCdLX.js +265 -0
  7. package/lib/chunks/AuFgCdLX.js.map +1 -0
  8. package/lib/chunks/B4_IqbDS.js +313 -0
  9. package/lib/chunks/B4_IqbDS.js.map +1 -0
  10. package/lib/chunks/B7YXa-I1.js +315 -0
  11. package/lib/chunks/B7YXa-I1.js.map +1 -0
  12. package/lib/chunks/B8gugSPH.js +303 -0
  13. package/lib/chunks/B8gugSPH.js.map +1 -0
  14. package/lib/chunks/B9IN35xb.js +722 -0
  15. package/lib/chunks/B9IN35xb.js.map +1 -0
  16. package/lib/chunks/BCQU3pVW.js +332 -0
  17. package/lib/chunks/BCQU3pVW.js.map +1 -0
  18. package/lib/chunks/BCapNDrC.js +1138 -0
  19. package/lib/chunks/BCapNDrC.js.map +1 -0
  20. package/lib/chunks/BGB1Jol1.js +420 -0
  21. package/lib/chunks/BGB1Jol1.js.map +1 -0
  22. package/lib/chunks/BI1N0MIj.js +233 -0
  23. package/lib/chunks/BI1N0MIj.js.map +1 -0
  24. package/lib/chunks/BNOuYpbo.js +324 -0
  25. package/lib/chunks/BNOuYpbo.js.map +1 -0
  26. package/lib/chunks/BO4n9DQP.js +308 -0
  27. package/lib/chunks/BO4n9DQP.js.map +1 -0
  28. package/lib/chunks/BOcV1Utm.js +311 -0
  29. package/lib/chunks/BOcV1Utm.js.map +1 -0
  30. package/lib/chunks/BPTCZ6IE.js +385 -0
  31. package/lib/chunks/BPTCZ6IE.js.map +1 -0
  32. package/lib/chunks/BPonWkID.js +283 -0
  33. package/lib/chunks/BPonWkID.js.map +1 -0
  34. package/lib/chunks/BUN4Rk5-.js +287 -0
  35. package/lib/chunks/BUN4Rk5-.js.map +1 -0
  36. package/lib/chunks/BXimBVRa.js +515 -0
  37. package/lib/chunks/BXimBVRa.js.map +1 -0
  38. package/lib/chunks/Baux7HCy.js +157 -0
  39. package/lib/chunks/Baux7HCy.js.map +1 -0
  40. package/lib/chunks/BhoSqDZl.js +382 -0
  41. package/lib/chunks/BhoSqDZl.js.map +1 -0
  42. package/lib/chunks/BmShyJT9.js +283 -0
  43. package/lib/chunks/BmShyJT9.js.map +1 -0
  44. package/lib/chunks/Bpz21Q9F.js +279 -0
  45. package/lib/chunks/Bpz21Q9F.js.map +1 -0
  46. package/lib/chunks/Br_UPlga.js +322 -0
  47. package/lib/chunks/Br_UPlga.js.map +1 -0
  48. package/lib/chunks/BtTswK-2.js +380 -0
  49. package/lib/chunks/BtTswK-2.js.map +1 -0
  50. package/lib/chunks/BuuryInq.js +284 -0
  51. package/lib/chunks/BuuryInq.js.map +1 -0
  52. package/lib/chunks/BwlMnX42.js +273 -0
  53. package/lib/chunks/BwlMnX42.js.map +1 -0
  54. package/lib/chunks/BxJmG96S.js +673 -0
  55. package/lib/chunks/BxJmG96S.js.map +1 -0
  56. package/lib/chunks/BzUFQEuh.js +865 -0
  57. package/lib/chunks/BzUFQEuh.js.map +1 -0
  58. package/lib/chunks/C04gcDe3.js +90 -0
  59. package/lib/chunks/C04gcDe3.js.map +1 -0
  60. package/lib/chunks/C0MrmpSO.js +304 -0
  61. package/lib/chunks/C0MrmpSO.js.map +1 -0
  62. package/lib/chunks/C3SXPZJJ.js +332 -0
  63. package/lib/chunks/C3SXPZJJ.js.map +1 -0
  64. package/lib/chunks/CIQAmaY-.js +311 -0
  65. package/lib/chunks/CIQAmaY-.js.map +1 -0
  66. package/lib/chunks/CMw4TMDz.js +285 -0
  67. package/lib/chunks/CMw4TMDz.js.map +1 -0
  68. package/lib/chunks/COlyo1Wo.js +340 -0
  69. package/lib/chunks/COlyo1Wo.js.map +1 -0
  70. package/lib/chunks/COpeCHCq.js +331 -0
  71. package/lib/chunks/COpeCHCq.js.map +1 -0
  72. package/lib/chunks/CS4HSz2w.js +289 -0
  73. package/lib/chunks/CS4HSz2w.js.map +1 -0
  74. package/lib/chunks/C_mtEjpv.js +382 -0
  75. package/lib/chunks/C_mtEjpv.js.map +1 -0
  76. package/lib/chunks/ChCStTku.js +480 -0
  77. package/lib/chunks/ChCStTku.js.map +1 -0
  78. package/lib/chunks/CkcPGhiH.js +332 -0
  79. package/lib/chunks/CkcPGhiH.js.map +1 -0
  80. package/lib/chunks/Cl4Odf2t.js +316 -0
  81. package/lib/chunks/Cl4Odf2t.js.map +1 -0
  82. package/lib/chunks/ClGqwKHp.js +422 -0
  83. package/lib/chunks/ClGqwKHp.js.map +1 -0
  84. package/lib/chunks/CnJKO_p1.js +408 -0
  85. package/lib/chunks/CnJKO_p1.js.map +1 -0
  86. package/lib/chunks/CocHPfxT.js +305 -0
  87. package/lib/chunks/CocHPfxT.js.map +1 -0
  88. package/lib/chunks/Cpsh5wb1.js +326 -0
  89. package/lib/chunks/Cpsh5wb1.js.map +1 -0
  90. package/lib/chunks/CrReHJfD.js +641 -0
  91. package/lib/chunks/CrReHJfD.js.map +1 -0
  92. package/lib/chunks/Cz07volV.js +293 -0
  93. package/lib/chunks/Cz07volV.js.map +1 -0
  94. package/lib/chunks/D2pGT64x.js +318 -0
  95. package/lib/chunks/D2pGT64x.js.map +1 -0
  96. package/lib/chunks/D65UKHfq.js +301 -0
  97. package/lib/chunks/D65UKHfq.js.map +1 -0
  98. package/lib/chunks/DAPG7Ryp.js +506 -0
  99. package/lib/chunks/DAPG7Ryp.js.map +1 -0
  100. package/lib/chunks/DRBud7Vf.js +329 -0
  101. package/lib/chunks/DRBud7Vf.js.map +1 -0
  102. package/lib/chunks/DRk05Cde.js +28 -0
  103. package/lib/chunks/DRk05Cde.js.map +1 -0
  104. package/lib/chunks/DSQuUUDN.js +642 -0
  105. package/lib/chunks/DSQuUUDN.js.map +1 -0
  106. package/lib/chunks/DUc7x35-.js +285 -0
  107. package/lib/chunks/DUc7x35-.js.map +1 -0
  108. package/lib/chunks/DWa9zkiz.js +317 -0
  109. package/lib/chunks/DWa9zkiz.js.map +1 -0
  110. package/lib/chunks/DXlCOnqx.js +312 -0
  111. package/lib/chunks/DXlCOnqx.js.map +1 -0
  112. package/lib/chunks/DYF0breI.js +334 -0
  113. package/lib/chunks/DYF0breI.js.map +1 -0
  114. package/lib/chunks/DaG1s_Iy.js +299 -0
  115. package/lib/chunks/DaG1s_Iy.js.map +1 -0
  116. package/lib/chunks/Dcppz32C.js +311 -0
  117. package/lib/chunks/Dcppz32C.js.map +1 -0
  118. package/lib/chunks/Dehw9x4O.js +289 -0
  119. package/lib/chunks/Dehw9x4O.js.map +1 -0
  120. package/lib/chunks/DfqTiRbh.js +328 -0
  121. package/lib/chunks/DfqTiRbh.js.map +1 -0
  122. package/lib/chunks/DlS1ldri.js +326 -0
  123. package/lib/chunks/DlS1ldri.js.map +1 -0
  124. package/lib/chunks/Dn19CjWt.js +235 -0
  125. package/lib/chunks/Dn19CjWt.js.map +1 -0
  126. package/lib/chunks/DnHfXxVT.js +301 -0
  127. package/lib/chunks/DnHfXxVT.js.map +1 -0
  128. package/lib/chunks/DngkKfCU.js +302 -0
  129. package/lib/chunks/DngkKfCU.js.map +1 -0
  130. package/lib/chunks/DpOsHkDw.js +241 -0
  131. package/lib/chunks/DpOsHkDw.js.map +1 -0
  132. package/lib/chunks/Dr5r7W-p.js +348 -0
  133. package/lib/chunks/Dr5r7W-p.js.map +1 -0
  134. package/lib/chunks/Dw-ylqNh.js +311 -0
  135. package/lib/chunks/Dw-ylqNh.js.map +1 -0
  136. package/lib/chunks/Dxf58SvP.js +334 -0
  137. package/lib/chunks/Dxf58SvP.js.map +1 -0
  138. package/lib/chunks/H4veMHX5.js +1140 -0
  139. package/lib/chunks/H4veMHX5.js.map +1 -0
  140. package/lib/chunks/HdbtMGp9.js +285 -0
  141. package/lib/chunks/HdbtMGp9.js.map +1 -0
  142. package/lib/chunks/IO_Vc2Ew.js +446 -0
  143. package/lib/chunks/IO_Vc2Ew.js.map +1 -0
  144. package/lib/chunks/Jjh0qb7k.js +702 -0
  145. package/lib/chunks/Jjh0qb7k.js.map +1 -0
  146. package/lib/chunks/Ma6QaT97.js +515 -0
  147. package/lib/chunks/Ma6QaT97.js.map +1 -0
  148. package/lib/chunks/Ot6TFUU0.js +380 -0
  149. package/lib/chunks/Ot6TFUU0.js.map +1 -0
  150. package/lib/chunks/YwcGSX-M.js +289 -0
  151. package/lib/chunks/YwcGSX-M.js.map +1 -0
  152. package/lib/chunks/bCzZXC7O.js +277 -0
  153. package/lib/chunks/bCzZXC7O.js.map +1 -0
  154. package/lib/chunks/dR8Qrbh-.js +402 -0
  155. package/lib/chunks/dR8Qrbh-.js.map +1 -0
  156. package/lib/chunks/fKCtMbe3.js +281 -0
  157. package/lib/chunks/fKCtMbe3.js.map +1 -0
  158. package/lib/chunks/hHtgT0eU.js +520 -0
  159. package/lib/chunks/hHtgT0eU.js.map +1 -0
  160. package/lib/chunks/hfgcSOCj.js +305 -0
  161. package/lib/chunks/hfgcSOCj.js.map +1 -0
  162. package/lib/chunks/jvLNe3VS.js +639 -0
  163. package/lib/chunks/jvLNe3VS.js.map +1 -0
  164. package/lib/chunks/kRnC6m7g.js +461 -0
  165. package/lib/chunks/kRnC6m7g.js.map +1 -0
  166. package/lib/chunks/lsEyA_FU.js +313 -0
  167. package/lib/chunks/lsEyA_FU.js.map +1 -0
  168. package/lib/chunks/nuMBkhIE.js +527 -0
  169. package/lib/chunks/nuMBkhIE.js.map +1 -0
  170. package/lib/chunks/q6v1OTTI.js +344 -0
  171. package/lib/chunks/q6v1OTTI.js.map +1 -0
  172. package/lib/components/BryntumAIFilterField.js +5 -0
  173. package/lib/components/BryntumAIFilterField.js.map +1 -0
  174. package/lib/components/BryntumAgendaView.js +5 -0
  175. package/lib/components/BryntumAgendaView.js.map +1 -0
  176. package/lib/components/BryntumButton.js +5 -0
  177. package/lib/components/BryntumButton.js.map +1 -0
  178. package/lib/components/BryntumButtonGroup.js +5 -0
  179. package/lib/components/BryntumButtonGroup.js.map +1 -0
  180. package/lib/components/BryntumCalendar.js +5 -0
  181. package/lib/components/BryntumCalendar.js.map +1 -0
  182. package/lib/components/BryntumCalendarDatePicker.js +5 -0
  183. package/lib/components/BryntumCalendarDatePicker.js.map +1 -0
  184. package/lib/components/BryntumCalendarProjectModel.js +5 -0
  185. package/lib/components/BryntumCalendarProjectModel.js.map +1 -0
  186. package/lib/components/BryntumChatPanel.js +5 -0
  187. package/lib/components/BryntumChatPanel.js.map +1 -0
  188. package/lib/components/BryntumCheckbox.js +5 -0
  189. package/lib/components/BryntumCheckbox.js.map +1 -0
  190. package/lib/components/BryntumCheckboxGroup.js +5 -0
  191. package/lib/components/BryntumCheckboxGroup.js.map +1 -0
  192. package/lib/components/BryntumChecklistFilterCombo.js +5 -0
  193. package/lib/components/BryntumChecklistFilterCombo.js.map +1 -0
  194. package/lib/components/BryntumChipView.js +5 -0
  195. package/lib/components/BryntumChipView.js.map +1 -0
  196. package/lib/components/BryntumCodeEditor.js +5 -0
  197. package/lib/components/BryntumCodeEditor.js.map +1 -0
  198. package/lib/components/BryntumColorField.js +5 -0
  199. package/lib/components/BryntumColorField.js.map +1 -0
  200. package/lib/components/BryntumCombo.js +5 -0
  201. package/lib/components/BryntumCombo.js.map +1 -0
  202. package/lib/components/BryntumContainer.js +5 -0
  203. package/lib/components/BryntumContainer.js.map +1 -0
  204. package/lib/components/BryntumDateField.js +5 -0
  205. package/lib/components/BryntumDateField.js.map +1 -0
  206. package/lib/components/BryntumDatePicker.js +5 -0
  207. package/lib/components/BryntumDatePicker.js.map +1 -0
  208. package/lib/components/BryntumDateRangeField.js +5 -0
  209. package/lib/components/BryntumDateRangeField.js.map +1 -0
  210. package/lib/components/BryntumDateTimeField.js +5 -0
  211. package/lib/components/BryntumDateTimeField.js.map +1 -0
  212. package/lib/components/BryntumDayAgendaView.js +5 -0
  213. package/lib/components/BryntumDayAgendaView.js.map +1 -0
  214. package/lib/components/BryntumDayResourceView.js +5 -0
  215. package/lib/components/BryntumDayResourceView.js.map +1 -0
  216. package/lib/components/BryntumDayView.js +5 -0
  217. package/lib/components/BryntumDayView.js.map +1 -0
  218. package/lib/components/BryntumDemoCodeEditor.js +5 -0
  219. package/lib/components/BryntumDemoCodeEditor.js.map +1 -0
  220. package/lib/components/BryntumDemoHeader.js +5 -0
  221. package/lib/components/BryntumDemoHeader.js.map +1 -0
  222. package/lib/components/BryntumDisplayField.js +5 -0
  223. package/lib/components/BryntumDisplayField.js.map +1 -0
  224. package/lib/components/BryntumDurationField.js +5 -0
  225. package/lib/components/BryntumDurationField.js.map +1 -0
  226. package/lib/components/BryntumEditor.js +5 -0
  227. package/lib/components/BryntumEditor.js.map +1 -0
  228. package/lib/components/BryntumEventColorField.js +5 -0
  229. package/lib/components/BryntumEventColorField.js.map +1 -0
  230. package/lib/components/BryntumEventList.js +5 -0
  231. package/lib/components/BryntumEventList.js.map +1 -0
  232. package/lib/components/BryntumFieldFilterPicker.js +5 -0
  233. package/lib/components/BryntumFieldFilterPicker.js.map +1 -0
  234. package/lib/components/BryntumFieldFilterPickerGroup.js +5 -0
  235. package/lib/components/BryntumFieldFilterPickerGroup.js.map +1 -0
  236. package/lib/components/BryntumFieldSet.js +5 -0
  237. package/lib/components/BryntumFieldSet.js.map +1 -0
  238. package/lib/components/BryntumFileField.js +5 -0
  239. package/lib/components/BryntumFileField.js.map +1 -0
  240. package/lib/components/BryntumFilePicker.js +5 -0
  241. package/lib/components/BryntumFilePicker.js.map +1 -0
  242. package/lib/components/BryntumFilterField.js +5 -0
  243. package/lib/components/BryntumFilterField.js.map +1 -0
  244. package/lib/components/BryntumFullscreenButton.js +5 -0
  245. package/lib/components/BryntumFullscreenButton.js.map +1 -0
  246. package/lib/components/BryntumGrid.js +5 -0
  247. package/lib/components/BryntumGrid.js.map +1 -0
  248. package/lib/components/BryntumGridBase.js +5 -0
  249. package/lib/components/BryntumGridBase.js.map +1 -0
  250. package/lib/components/BryntumGridChartDesigner.js +5 -0
  251. package/lib/components/BryntumGridChartDesigner.js.map +1 -0
  252. package/lib/components/BryntumGridFieldFilterPicker.js +5 -0
  253. package/lib/components/BryntumGridFieldFilterPicker.js.map +1 -0
  254. package/lib/components/BryntumGridFieldFilterPickerGroup.js +5 -0
  255. package/lib/components/BryntumGridFieldFilterPickerGroup.js.map +1 -0
  256. package/lib/components/BryntumGroupBar.js +5 -0
  257. package/lib/components/BryntumGroupBar.js.map +1 -0
  258. package/lib/components/BryntumHint.js +5 -0
  259. package/lib/components/BryntumHint.js.map +1 -0
  260. package/lib/components/BryntumLabel.js +5 -0
  261. package/lib/components/BryntumLabel.js.map +1 -0
  262. package/lib/components/BryntumList.js +5 -0
  263. package/lib/components/BryntumList.js.map +1 -0
  264. package/lib/components/BryntumMenu.js +5 -0
  265. package/lib/components/BryntumMenu.js.map +1 -0
  266. package/lib/components/BryntumModeSelector.js +5 -0
  267. package/lib/components/BryntumModeSelector.js.map +1 -0
  268. package/lib/components/BryntumMonthAgendaView.js +5 -0
  269. package/lib/components/BryntumMonthAgendaView.js.map +1 -0
  270. package/lib/components/BryntumMonthGrid.js +5 -0
  271. package/lib/components/BryntumMonthGrid.js.map +1 -0
  272. package/lib/components/BryntumMonthPicker.js +5 -0
  273. package/lib/components/BryntumMonthPicker.js.map +1 -0
  274. package/lib/components/BryntumMonthView.js +5 -0
  275. package/lib/components/BryntumMonthView.js.map +1 -0
  276. package/lib/components/BryntumNumberField.js +5 -0
  277. package/lib/components/BryntumNumberField.js.map +1 -0
  278. package/lib/components/BryntumPagingToolbar.js +5 -0
  279. package/lib/components/BryntumPagingToolbar.js.map +1 -0
  280. package/lib/components/BryntumPanel.js +5 -0
  281. package/lib/components/BryntumPanel.js.map +1 -0
  282. package/lib/components/BryntumPasswordField.js +5 -0
  283. package/lib/components/BryntumPasswordField.js.map +1 -0
  284. package/lib/components/BryntumProjectCombo.js +5 -0
  285. package/lib/components/BryntumProjectCombo.js.map +1 -0
  286. package/lib/components/BryntumRadio.js +5 -0
  287. package/lib/components/BryntumRadio.js.map +1 -0
  288. package/lib/components/BryntumRadioGroup.js +5 -0
  289. package/lib/components/BryntumRadioGroup.js.map +1 -0
  290. package/lib/components/BryntumRangeMenu.js +5 -0
  291. package/lib/components/BryntumRangeMenu.js.map +1 -0
  292. package/lib/components/BryntumResourceCombo.js +5 -0
  293. package/lib/components/BryntumResourceCombo.js.map +1 -0
  294. package/lib/components/BryntumResourceFilter.js +5 -0
  295. package/lib/components/BryntumResourceFilter.js.map +1 -0
  296. package/lib/components/BryntumResourceView.js +5 -0
  297. package/lib/components/BryntumResourceView.js.map +1 -0
  298. package/lib/components/BryntumScheduler.js +5 -0
  299. package/lib/components/BryntumScheduler.js.map +1 -0
  300. package/lib/components/BryntumSchedulerBase.js +5 -0
  301. package/lib/components/BryntumSchedulerBase.js.map +1 -0
  302. package/lib/components/BryntumSchedulerDatePicker.js +5 -0
  303. package/lib/components/BryntumSchedulerDatePicker.js.map +1 -0
  304. package/lib/components/BryntumSlideToggle.js +5 -0
  305. package/lib/components/BryntumSlideToggle.js.map +1 -0
  306. package/lib/components/BryntumSlider.js +5 -0
  307. package/lib/components/BryntumSlider.js.map +1 -0
  308. package/lib/components/BryntumSplitter.js +5 -0
  309. package/lib/components/BryntumSplitter.js.map +1 -0
  310. package/lib/components/BryntumTabPanel.js +5 -0
  311. package/lib/components/BryntumTabPanel.js.map +1 -0
  312. package/lib/components/BryntumTextAreaField.js +5 -0
  313. package/lib/components/BryntumTextAreaField.js.map +1 -0
  314. package/lib/components/BryntumTextAreaPickerField.js +5 -0
  315. package/lib/components/BryntumTextAreaPickerField.js.map +1 -0
  316. package/lib/components/BryntumTextField.js +5 -0
  317. package/lib/components/BryntumTextField.js.map +1 -0
  318. package/lib/components/BryntumTimeField.js +5 -0
  319. package/lib/components/BryntumTimeField.js.map +1 -0
  320. package/lib/components/BryntumTimePicker.js +5 -0
  321. package/lib/components/BryntumTimePicker.js.map +1 -0
  322. package/lib/components/BryntumTimelineHistogram.js +5 -0
  323. package/lib/components/BryntumTimelineHistogram.js.map +1 -0
  324. package/lib/components/BryntumToolbar.js +5 -0
  325. package/lib/components/BryntumToolbar.js.map +1 -0
  326. package/lib/components/BryntumTreeCombo.js +5 -0
  327. package/lib/components/BryntumTreeCombo.js.map +1 -0
  328. package/lib/components/BryntumTreeGrid.js +5 -0
  329. package/lib/components/BryntumTreeGrid.js.map +1 -0
  330. package/lib/components/BryntumUndoRedo.js +5 -0
  331. package/lib/components/BryntumUndoRedo.js.map +1 -0
  332. package/lib/components/BryntumViewPresetCombo.js +5 -0
  333. package/lib/components/BryntumViewPresetCombo.js.map +1 -0
  334. package/lib/components/BryntumWeekView.js +5 -0
  335. package/lib/components/BryntumWeekView.js.map +1 -0
  336. package/lib/components/BryntumWidget.js +5 -0
  337. package/lib/components/BryntumWidget.js.map +1 -0
  338. package/lib/components/BryntumYearPicker.js +5 -0
  339. package/lib/components/BryntumYearPicker.js.map +1 -0
  340. package/lib/components/BryntumYearView.js +5 -0
  341. package/lib/components/BryntumYearView.js.map +1 -0
  342. package/lib/helper/WrapperHelper.js +291 -0
  343. package/lib/helper/WrapperHelper.js.map +1 -0
  344. package/lib/index.d.ts +5 -0
  345. package/lib/index.js +174 -0
  346. package/lib/index.js.map +1 -0
  347. package/license.pdf +0 -0
  348. package/licenses.md +310 -0
  349. package/package.json +27 -0
  350. package/src/components/BryntumAIFilterField.vue +1063 -0
  351. package/src/components/BryntumAIFilterFieldProps.ts +646 -0
  352. package/src/components/BryntumAgendaView.vue +3328 -0
  353. package/src/components/BryntumAgendaViewProps.ts +1448 -0
  354. package/src/components/BryntumButton.vue +952 -0
  355. package/src/components/BryntumButtonGroup.vue +967 -0
  356. package/src/components/BryntumButtonGroupProps.ts +575 -0
  357. package/src/components/BryntumButtonProps.ts +556 -0
  358. package/src/components/BryntumCalendar.vue +3027 -0
  359. package/src/components/BryntumCalendarDatePicker.vue +1540 -0
  360. package/src/components/BryntumCalendarDatePickerProps.ts +1002 -0
  361. package/src/components/BryntumCalendarProjectModel.vue +439 -0
  362. package/src/components/BryntumCalendarProjectModelProps.ts +279 -0
  363. package/src/components/BryntumCalendarProps.ts +1137 -0
  364. package/src/components/BryntumChatPanel.vue +1159 -0
  365. package/src/components/BryntumChatPanelProps.ts +707 -0
  366. package/src/components/BryntumCheckbox.vue +1071 -0
  367. package/src/components/BryntumCheckboxGroup.vue +1193 -0
  368. package/src/components/BryntumCheckboxGroupProps.ts +739 -0
  369. package/src/components/BryntumCheckboxProps.ts +631 -0
  370. package/src/components/BryntumChecklistFilterCombo.vue +1309 -0
  371. package/src/components/BryntumChecklistFilterComboProps.ts +846 -0
  372. package/src/components/BryntumChipView.vue +979 -0
  373. package/src/components/BryntumChipViewProps.ts +583 -0
  374. package/src/components/BryntumCodeEditor.vue +1136 -0
  375. package/src/components/BryntumCodeEditorProps.ts +708 -0
  376. package/src/components/BryntumColorField.vue +1060 -0
  377. package/src/components/BryntumColorFieldProps.ts +642 -0
  378. package/src/components/BryntumCombo.vue +1298 -0
  379. package/src/components/BryntumComboProps.ts +838 -0
  380. package/src/components/BryntumContainer.vue +917 -0
  381. package/src/components/BryntumContainerProps.ts +563 -0
  382. package/src/components/BryntumDateField.vue +1120 -0
  383. package/src/components/BryntumDateFieldProps.ts +693 -0
  384. package/src/components/BryntumDatePicker.vue +1427 -0
  385. package/src/components/BryntumDatePickerProps.ts +898 -0
  386. package/src/components/BryntumDateRangeField.vue +1122 -0
  387. package/src/components/BryntumDateRangeFieldProps.ts +694 -0
  388. package/src/components/BryntumDateTimeField.vue +1007 -0
  389. package/src/components/BryntumDateTimeFieldProps.ts +600 -0
  390. package/src/components/BryntumDayAgendaView.vue +1979 -0
  391. package/src/components/BryntumDayAgendaViewProps.ts +1270 -0
  392. package/src/components/BryntumDayResourceView.vue +2044 -0
  393. package/src/components/BryntumDayResourceViewProps.ts +1334 -0
  394. package/src/components/BryntumDayView.vue +1999 -0
  395. package/src/components/BryntumDayViewProps.ts +1295 -0
  396. package/src/components/BryntumDemoCodeEditor.vue +1152 -0
  397. package/src/components/BryntumDemoCodeEditorProps.ts +721 -0
  398. package/src/components/BryntumDemoHeader.vue +131 -0
  399. package/src/components/BryntumDisplayField.vue +1044 -0
  400. package/src/components/BryntumDisplayFieldProps.ts +632 -0
  401. package/src/components/BryntumDurationField.vue +1103 -0
  402. package/src/components/BryntumDurationFieldProps.ts +683 -0
  403. package/src/components/BryntumEditor.vue +1093 -0
  404. package/src/components/BryntumEditorProps.ts +622 -0
  405. package/src/components/BryntumEventColorField.vue +1060 -0
  406. package/src/components/BryntumEventColorFieldProps.ts +642 -0
  407. package/src/components/BryntumEventList.vue +3255 -0
  408. package/src/components/BryntumEventListProps.ts +1403 -0
  409. package/src/components/BryntumFieldFilterPicker.vue +1002 -0
  410. package/src/components/BryntumFieldFilterPickerGroup.vue +1038 -0
  411. package/src/components/BryntumFieldFilterPickerGroupProps.ts +646 -0
  412. package/src/components/BryntumFieldFilterPickerProps.ts +624 -0
  413. package/src/components/BryntumFieldSet.vue +1129 -0
  414. package/src/components/BryntumFieldSetProps.ts +703 -0
  415. package/src/components/BryntumFileField.vue +1047 -0
  416. package/src/components/BryntumFileFieldProps.ts +634 -0
  417. package/src/components/BryntumFilePicker.vue +948 -0
  418. package/src/components/BryntumFilePickerProps.ts +575 -0
  419. package/src/components/BryntumFilterField.vue +1088 -0
  420. package/src/components/BryntumFilterFieldProps.ts +668 -0
  421. package/src/components/BryntumFullscreenButton.vue +38 -0
  422. package/src/components/BryntumGrid.vue +2759 -0
  423. package/src/components/BryntumGridBase.vue +2756 -0
  424. package/src/components/BryntumGridBaseProps.ts +1027 -0
  425. package/src/components/BryntumGridChartDesigner.vue +778 -0
  426. package/src/components/BryntumGridChartDesignerProps.ts +466 -0
  427. package/src/components/BryntumGridFieldFilterPicker.vue +1015 -0
  428. package/src/components/BryntumGridFieldFilterPickerGroup.vue +1032 -0
  429. package/src/components/BryntumGridFieldFilterPickerGroupProps.ts +641 -0
  430. package/src/components/BryntumGridFieldFilterPickerProps.ts +636 -0
  431. package/src/components/BryntumGridProps.ts +1028 -0
  432. package/src/components/BryntumGroupBar.vue +979 -0
  433. package/src/components/BryntumGroupBarProps.ts +583 -0
  434. package/src/components/BryntumHint.vue +1199 -0
  435. package/src/components/BryntumHintProps.ts +753 -0
  436. package/src/components/BryntumLabel.vue +770 -0
  437. package/src/components/BryntumLabelProps.ts +459 -0
  438. package/src/components/BryntumList.vue +956 -0
  439. package/src/components/BryntumListProps.ts +563 -0
  440. package/src/components/BryntumMenu.vue +1223 -0
  441. package/src/components/BryntumMenuProps.ts +749 -0
  442. package/src/components/BryntumModeSelector.vue +945 -0
  443. package/src/components/BryntumModeSelectorProps.ts +586 -0
  444. package/src/components/BryntumMonthAgendaView.vue +1775 -0
  445. package/src/components/BryntumMonthAgendaViewProps.ts +1162 -0
  446. package/src/components/BryntumMonthGrid.vue +1767 -0
  447. package/src/components/BryntumMonthGridProps.ts +1028 -0
  448. package/src/components/BryntumMonthPicker.vue +1133 -0
  449. package/src/components/BryntumMonthPickerProps.ts +688 -0
  450. package/src/components/BryntumMonthView.vue +1939 -0
  451. package/src/components/BryntumMonthViewProps.ts +1189 -0
  452. package/src/components/BryntumNumberField.vue +1090 -0
  453. package/src/components/BryntumNumberFieldProps.ts +671 -0
  454. package/src/components/BryntumPagingToolbar.vue +989 -0
  455. package/src/components/BryntumPagingToolbarProps.ts +592 -0
  456. package/src/components/BryntumPanel.vue +1106 -0
  457. package/src/components/BryntumPanelProps.ts +684 -0
  458. package/src/components/BryntumPasswordField.vue +1034 -0
  459. package/src/components/BryntumPasswordFieldProps.ts +623 -0
  460. package/src/components/BryntumProjectCombo.vue +1300 -0
  461. package/src/components/BryntumProjectComboProps.ts +839 -0
  462. package/src/components/BryntumRadio.vue +1071 -0
  463. package/src/components/BryntumRadioGroup.vue +1159 -0
  464. package/src/components/BryntumRadioGroupProps.ts +729 -0
  465. package/src/components/BryntumRadioProps.ts +631 -0
  466. package/src/components/BryntumRangeMenu.vue +1223 -0
  467. package/src/components/BryntumRangeMenuProps.ts +749 -0
  468. package/src/components/BryntumResourceCombo.vue +1303 -0
  469. package/src/components/BryntumResourceComboProps.ts +842 -0
  470. package/src/components/BryntumResourceFilter.vue +998 -0
  471. package/src/components/BryntumResourceFilterProps.ts +589 -0
  472. package/src/components/BryntumResourceView.vue +1556 -0
  473. package/src/components/BryntumResourceViewProps.ts +995 -0
  474. package/src/components/BryntumScheduler.vue +5828 -0
  475. package/src/components/BryntumSchedulerBase.vue +5826 -0
  476. package/src/components/BryntumSchedulerBaseProps.ts +2050 -0
  477. package/src/components/BryntumSchedulerDatePicker.vue +1451 -0
  478. package/src/components/BryntumSchedulerDatePickerProps.ts +919 -0
  479. package/src/components/BryntumSchedulerProps.ts +2051 -0
  480. package/src/components/BryntumSlideToggle.vue +1071 -0
  481. package/src/components/BryntumSlideToggleProps.ts +631 -0
  482. package/src/components/BryntumSlider.vue +871 -0
  483. package/src/components/BryntumSliderProps.ts +523 -0
  484. package/src/components/BryntumSplitter.vue +813 -0
  485. package/src/components/BryntumSplitterProps.ts +468 -0
  486. package/src/components/BryntumTabPanel.vue +1164 -0
  487. package/src/components/BryntumTabPanelProps.ts +710 -0
  488. package/src/components/BryntumTextAreaField.vue +1046 -0
  489. package/src/components/BryntumTextAreaFieldProps.ts +633 -0
  490. package/src/components/BryntumTextAreaPickerField.vue +1067 -0
  491. package/src/components/BryntumTextAreaPickerFieldProps.ts +648 -0
  492. package/src/components/BryntumTextField.vue +1052 -0
  493. package/src/components/BryntumTextFieldProps.ts +637 -0
  494. package/src/components/BryntumTimeField.vue +1101 -0
  495. package/src/components/BryntumTimeFieldProps.ts +677 -0
  496. package/src/components/BryntumTimePicker.vue +952 -0
  497. package/src/components/BryntumTimePickerProps.ts +583 -0
  498. package/src/components/BryntumTimelineHistogram.vue +3893 -0
  499. package/src/components/BryntumTimelineHistogramProps.ts +1560 -0
  500. package/src/components/BryntumToolbar.vue +982 -0
  501. package/src/components/BryntumToolbarProps.ts +586 -0
  502. package/src/components/BryntumTreeCombo.vue +1298 -0
  503. package/src/components/BryntumTreeComboProps.ts +838 -0
  504. package/src/components/BryntumTreeGrid.vue +2758 -0
  505. package/src/components/BryntumTreeGridProps.ts +1028 -0
  506. package/src/components/BryntumUndoRedo.vue +941 -0
  507. package/src/components/BryntumUndoRedoProps.ts +583 -0
  508. package/src/components/BryntumViewPresetCombo.vue +979 -0
  509. package/src/components/BryntumViewPresetComboProps.ts +575 -0
  510. package/src/components/BryntumWeekView.vue +1999 -0
  511. package/src/components/BryntumWeekViewProps.ts +1295 -0
  512. package/src/components/BryntumWidget.vue +765 -0
  513. package/src/components/BryntumWidgetProps.ts +455 -0
  514. package/src/components/BryntumYearPicker.vue +1144 -0
  515. package/src/components/BryntumYearPickerProps.ts +705 -0
  516. package/src/components/BryntumYearView.vue +1701 -0
  517. package/src/components/BryntumYearViewProps.ts +1061 -0
  518. package/src/helper/WrapperHelper.ts +573 -0
  519. package/src/index.ts +173 -0
  520. package/src/vite-env.d.ts +1 -0
@@ -0,0 +1,3027 @@
1
+ <!-- Vue 3 wrapper for Bryntum Calendar -->
2
+
3
+ <template>
4
+ <div ref="refElement">
5
+
6
+ <!-- Container for Vue components used in cells, hidden from view -->
7
+ <div
8
+ ref="teleportsHolder"
9
+ style="display: none"
10
+ >
11
+ <!-- Vue components rendered in the grid cells -->
12
+ <teleport
13
+ v-for="item in teleports.values()"
14
+ :key="item.key"
15
+ :to="item.to"
16
+ >
17
+ <component
18
+ :is="item.is"
19
+ :ref="item.key"
20
+ :data-key="item.key"
21
+ :data-generation="item.generation"
22
+ v-bind="item.bind"
23
+ data-vue
24
+ v-on="item.on"
25
+ />
26
+ </teleport>
27
+ </div>
28
+
29
+ </div>
30
+ </template>
31
+
32
+ <script setup lang="ts">
33
+
34
+ import { getCurrentInstance, onBeforeUnmount, onMounted, provide, ref, watch, toRaw } from 'vue';
35
+
36
+ import type { AgendaViewConfig, AlignSpec, AssignmentModel, AssignmentModelConfig, AssignmentStore, AssignmentStoreConfig, Base, ButtonConfig, CalendarDatePickerConfig, CalendarDrag, CalendarDragConfig, CalendarListeners, CalendarToolbarConfig, CalendarView, Column, Container, ContainerConfig, ContainerItemConfig, ContainerLayoutConfig, CrudManagerConfig, DatePickerConfig, DayAgendaViewConfig, DayCell, DayResourceViewConfig, DayViewConfig, DomConfig, DragContext, EventBuffer, EventBufferConfig, EventCopyPaste, EventCopyPasteConfig, EventEdit, EventEditConfig, EventListConfig, EventMenu, EventMenuConfig, EventModel, EventModelConfig, EventStore, EventStoreConfig, EventTooltip, EventTooltipConfig, ExcelExporter, ExcelExporterConfig, ExportConfig, ExternalEventSource, ExternalEventSourceConfig, KeyMapConfig, LoadOnDemand, LoadOnDemandConfig, Mask, MaskConfig, Menu, MenuItem, MenuItemEntry, Model, MonthAgendaViewConfig, MonthGridConfig, MonthViewConfig, PagingToolbarConfig, Panel, PanelCollapserConfig, PanelCollapserOverlayConfig, PanelHeader, Popup, Print, PrintConfig, ProjectConsumer, ProjectModel, ProjectModelConfig, ProjectModelMixin, Rectangle, RecurrenceConfirmationPopup, RecurrenceConfirmationPopupConfig, ResourceFilterConfig, ResourceModel, ResourceModelConfig, ResourceStore, ResourceStoreConfig, ResourceTimeRangeModel, ResourceTimeRangeModelConfig, ResourceTimeRangeStore, ResourceTimeRangeStoreConfig, ResourceViewConfig, ScheduleMenu, ScheduleMenuConfig, ScheduleTooltip, ScheduleTooltipConfig, Scheduler, SchedulerCrudManager, SchedulerEventEdit, Scroller, ScrollerConfig, StateProvider, Store, TabConfig, TextFieldConfig, TimeRangeModel, TimeRangeModelConfig, TimeRangeStore, TimeRangeStoreConfig, TimeRanges, TimeRangesConfig, TimeSpan, Tool, ToolConfig, ToolbarConfig, ToolbarItems, TooltipConfig, ValidateCreateResult, WeekExpander, WeekExpanderConfig, WeekViewConfig, Widget, XLSColumn, YearViewConfig } from '@bryntum/calendar';
37
+ import { Calendar } from '@bryntum/calendar';
38
+
39
+ import { WrapperHelper } from '../helper/WrapperHelper';
40
+
41
+ defineProps<{
42
+ // Configs
43
+ /**
44
+ * An optional CSS class name to add to calendar date cells which encapsulate the calendar's
45
+ * active [date](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#property-date).
46
+ * ...
47
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-activeDateCls)
48
+ */
49
+ activeDateCls ? : string
50
+ /**
51
+ * Element (or element id) to adopt as this Widget's encapsulating element. The widget's
52
+ * content will be placed inside this element.
53
+ * ...
54
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-adopt)
55
+ */
56
+ adopt ? : HTMLElement|string
57
+ /**
58
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-floating).*
59
+ * ...
60
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-align)
61
+ */
62
+ align ? : AlignSpec|string
63
+ /**
64
+ * When this widget is a child of a [Container](https://bryntum.com/products/calendar/docs/api/Core/widget/Container), it will by default be participating in a
65
+ * flexbox layout. This config allows you to set this widget's
66
+ * [align-self](https://developer.mozilla.org/en-US/docs/Web/CSS/align-self) style.
67
+ */
68
+ alignSelf ? : string
69
+ /**
70
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-floating) and being shown through [showBy](#Core/widget/Widget#function-showBy).*
71
+ * `true` to show a connector arrow pointing to the align target.
72
+ */
73
+ anchor ? : Boolean
74
+ /**
75
+ * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
76
+ * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#property-element).
77
+ */
78
+ appendTo ? : HTMLElement|string
79
+ /**
80
+ * A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject
81
+ * into an element which will be linked using the `aria-describedby` attribute.
82
+ * ...
83
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-ariaDescription)
84
+ */
85
+ ariaDescription ? : string
86
+ /**
87
+ * A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject as
88
+ * the `aria-label` attribute.
89
+ * ...
90
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-ariaLabel)
91
+ */
92
+ ariaLabel ? : string
93
+ /**
94
+ * Inline assignments, will be loaded into the [assignmentStore](https://bryntum.com/products/calendar/docs/api/Calendar/mixin/CalendarStores#property-assignmentStore).
95
+ */
96
+ assignments ? : AssignmentModel[]|AssignmentModelConfig[]
97
+ /**
98
+ * The [AssignmentStore](https://bryntum.com/products/calendar/docs/api/Scheduler/data/AssignmentStore) or a reconfiguring object for a store which will hold assignments linking resources to events.
99
+ */
100
+ assignmentStore ? : AssignmentStore|AssignmentStoreConfig
101
+ /**
102
+ * If this config is set, then the `gesture` configured (which defaults to `dblclick`) creates a
103
+ * new event at the mouse or touch event's time point.
104
+ * ...
105
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-autoCreate)
106
+ */
107
+ autoCreate ? : {
108
+ gesture?: string
109
+ newName?: Function|string
110
+ step?: string
111
+ duration?: string
112
+ startHour?: number|string
113
+ }|string|Boolean
114
+ /**
115
+ * A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/calendar/docs/api/Core/widget/Toolbar),
116
+ * or array of config objects representing the child items of a Toolbar. Another way to add a bbar is to use [strips](https://bryntum.com/products/calendar/docs/api/Core/widget/Panel#config-strips).
117
+ * ...
118
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-bbar)
119
+ */
120
+ bbar ? : (ContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
121
+ /**
122
+ * Custom CSS classes to add to the panel's body element.
123
+ * ...
124
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-bodyCls)
125
+ */
126
+ bodyCls ? : string|object
127
+ /**
128
+ * An object where property names with a truthy value indicate which events should bubble up the ownership
129
+ * hierarchy when triggered.
130
+ * ...
131
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-bubbleEvents)
132
+ */
133
+ bubbleEvents ? : object
134
+ /**
135
+ * Set to `false` to not call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
136
+ * ...
137
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-callOnFunctions)
138
+ */
139
+ callOnFunctions ? : Boolean
140
+ /**
141
+ * By default, if an event handler throws an exception, the error propagates up the stack and the
142
+ * application state is undefined. Code which follows the event handler will *not* be executed.
143
+ * ...
144
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-catchEventHandlerExceptions)
145
+ */
146
+ catchEventHandlerExceptions ? : Boolean
147
+ /**
148
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-floating).*
149
+ * Set to `true` to centre the Widget in browser viewport space.
150
+ */
151
+ centered ? : Boolean
152
+ /**
153
+ * Custom CSS classes to add to element.
154
+ * May be specified as a space separated string, or as an object in which property names
155
+ * with truthy values are used as the class names:
156
+ * ...
157
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-cls)
158
+ */
159
+ cls ? : string|object
160
+ /**
161
+ * Controls whether the panel is collapsed (the body of the panel is hidden while only the header is
162
+ * visible). Only valid if the panel is [collapsible](https://bryntum.com/products/calendar/docs/api/Core/widget/Panel#config-collapsible).
163
+ */
164
+ collapsed ? : Boolean
165
+ /**
166
+ * This config enables collapsibility for the panel. See [collapsed](https://bryntum.com/products/calendar/docs/api/Core/widget/Panel#config-collapsed).
167
+ * ...
168
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-collapsible)
169
+ */
170
+ collapsible ? : Boolean|PanelCollapserConfig|PanelCollapserOverlayConfig
171
+ /**
172
+ * Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
173
+ * `style` block.
174
+ * ...
175
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-color)
176
+ */
177
+ color ? : string
178
+ /**
179
+ * Programmatic control over which column to start in when used in a grid layout.
180
+ */
181
+ column ? : number
182
+ config ? : object
183
+ /**
184
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-floating) or [positioned](#Core/widget/Widget#config-positioned).*
185
+ * Element, Widget or Rectangle to which this Widget is constrained.
186
+ */
187
+ constrainTo ? : HTMLElement|Widget|Rectangle
188
+ /**
189
+ * Custom CSS classes to add to the [contentElement](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#property-contentElement).
190
+ * May be specified as a space separated string, or as an object in which property names
191
+ * with truthy values are used as the class names:
192
+ * ...
193
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-contentElementCls)
194
+ */
195
+ contentElementCls ? : string|object
196
+ /**
197
+ * Event which is used to show context menus via the context menu features
198
+ * [EventMenu](https://bryntum.com/products/calendar/docs/api/Calendar/feature/EventMenu) and [ScheduleMenu](#Calendar/feature/ScheduleMenu).
199
+ * Available options are: 'contextmenu', 'click', 'dblclick'.
200
+ */
201
+ contextMenuTriggerEvent ? : 'contextmenu'|'click'|'dblclick'
202
+ /**
203
+ * Supply a [CrudManager](https://bryntum.com/products/calendar/docs/api/Scheduler/data/CrudManager) instance or a config object if you want to use
204
+ * CrudManager for handling data.
205
+ */
206
+ crudManager ? : CrudManagerConfig|SchedulerCrudManager
207
+ /**
208
+ * Class that should be used to instantiate a CrudManager in case it's provided as a simple object to
209
+ * [crudManager](https://bryntum.com/products/calendar/docs/api/Calendar/mixin/CalendarStores#config-crudManager) config.
210
+ */
211
+ crudManagerClass ? : SchedulerCrudManager
212
+ /**
213
+ * When this Widget configuration is used in the Grid's RowExpander feature's `widget` config, provide the
214
+ * field on the expanded record to use for populating this widget's store (if applicable)
215
+ */
216
+ dataField ? : string
217
+ /**
218
+ * Object to apply to elements dataset (each key will be used as a data-attribute on the element)
219
+ */
220
+ dataset ? : Record<string, string>
221
+ /**
222
+ * The date which the Calendar, its [sidebar](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#property-sidebar)'s date picker, and
223
+ * its active view should encapsulate upon creation.
224
+ * ...
225
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-date)
226
+ */
227
+ date ? : Date|string
228
+ /**
229
+ * A [DateHelper](https://bryntum.com/products/calendar/docs/api/Core/helper/DateHelper) format string to use to create date output for
230
+ * view descriptions.
231
+ */
232
+ dateFormat ? : string
233
+ /**
234
+ * An optional config object to configure the [CalendarDatePicker](https://bryntum.com/products/calendar/docs/api/Calendar/widget/CalendarDatePicker) which is
235
+ * shown in the [sidebar](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#property-sidebar) next to the calendar views.
236
+ * ...
237
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-datePicker)
238
+ * @param {boolean,'count','dots'} datePicker.showEvents Displays the presence of events in each cell. values may be: * `false` - Do not show events in cells. * `true` - Show a themeable bullet to indicate the presence of events for a date. * `'count'` - Show a themeable badge containing the event count for a date. * '`dots'` - Show small event-coloured bullets (to a maximum of three) below the date.
239
+ * @param {boolean} datePicker.collapsible `true` to enable collapse into a header.
240
+ * @param {string} datePicker.title The text to place in a header above the picker.
241
+ * @param {boolean} datePicker.editMonth `true` to enable setting the date using the controls in the DatePicker header.
242
+ * @param {boolean,'range'} multiSelect The DatePicker can select [multiple dates](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-multiSelect) in two modes: * `true` to mean many discontiguous dates may be selected. * `'range'` to mean that a start date and end date may be selected. If set up to multi select, views which are not fixed to a date duration will obey the date selection by using a [dateFilter](https://bryntum.com/products/calendar/docs/api/Calendar/widget/DayView#property-dateFilter) to skip days which are not selected. These include: * AgendaView (mode type `'agenda'`) * DayViews (view type `'dayview'`) which you add to the modes - The default `day` and `week` modes have a fixed duration. * ResourceView (view type `'resourceview'`) * DayResourceView (view type `'dayresourceview'`) The `MonthView`, and the `WeekView` and the built-in single day `DayView` <strong>mode</strong> all have fixed duration and will not participate in this. If you select a discontiguous range, then the views which are amenable to being controlled in this way will switch their range to encompass what you have selected. For example, if you select the first to the last days of a month, the view's [range](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/DateRangeOwner#property-range) will be set to `'1 month'`. This choice will be maintained, and by navigating using the next and previous tbar buttons, the views will move by exactly one month. If your set of selected dates is enclosed within a two week block, then the [range](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/DateRangeOwner#property-range) of the views will be set to `{ unit : 'week', magnitude : 2 }`. If you select the 1st, 3th and 5th of the month, and those days are all on one week row, the [range](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/DateRangeOwner#property-range) of the views will be set to `{ unit : 'week', magnitude : 1 }`. For selection ranges other than exactly one month, navigation in time will be in increments of one week for intuitive navigation up and down the date picker. When navigating in time, the selected block of dates moves and *follows the time navigation* so that there are always dates in view, even if they are empty.
243
+ */
244
+ datePicker ? : CalendarDatePickerConfig|Boolean|null
245
+ /**
246
+ * The name of the property to set when a single value is to be applied to this Widget. Such as when used
247
+ * in a grid WidgetColumn, this is the property to which the column's `field` is applied.
248
+ */
249
+ defaultBindProperty ? : string
250
+ /**
251
+ * The calendar ([Resource](https://bryntum.com/products/calendar/docs/api/Scheduler/model/ResourceModel)), (or its `id`) to use as the
252
+ * default calendar for new events created using [dblclick](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-autoCreate)
253
+ * or [drag-create](https://bryntum.com/products/calendar/docs/api/Calendar/feature/CalendarDrag), or [dragging in](#Calendar/feature/ExternalEventSource).
254
+ * ...
255
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-defaultCalendar)
256
+ */
257
+ defaultCalendar ? : string|ResourceModel
258
+ /**
259
+ * A [query](https://bryntum.com/products/calendar/docs/api/Core/widget/Container#function-query) selector function which can identify the descendant widget to which
260
+ * focus should be directed by default.
261
+ * ...
262
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-defaultFocus)
263
+ * @param {Core.widget.Widget} widget Widget passed to method
264
+ * @returns {boolean} truthy value if widget is the default one
265
+ */
266
+ defaultFocus ? : ((widget: Widget) => Boolean)|string
267
+ /**
268
+ * A config object containing default settings to apply to all child widgets.
269
+ */
270
+ defaults ? : ContainerItemConfig
271
+ /**
272
+ * Configure as `false` to preserve selection when clicking the empty schedule area.
273
+ */
274
+ deselectAllOnScheduleClick ? : Boolean
275
+ /**
276
+ * Configure as `true` to deselect a selected event upon click.
277
+ */
278
+ deselectOnClick ? : Boolean
279
+ /**
280
+ * Configure as `true` to destroy the Project and stores when `this` is destroyed.
281
+ */
282
+ destroyStores ? : Boolean
283
+ /**
284
+ * Check for CSS compatibility issues when upgrading to v7. Performs the following checks:
285
+ * ...
286
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-detectCSSCompatibilityIssues)
287
+ */
288
+ detectCSSCompatibilityIssues ? : Boolean
289
+ /**
290
+ * Disable or enable the widget. It is similar to [readOnly](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-readOnly) except a disabled widget
291
+ * cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
292
+ * ...
293
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-disabled)
294
+ */
295
+ disabled ? : Boolean|'inert'
296
+ /**
297
+ * Controls the placement of this widget when it is added to a [panel's ](https://bryntum.com/products/calendar/docs/api/Core/widget/Panel)
298
+ * [strips collection](https://bryntum.com/products/calendar/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
299
+ * `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
300
+ * body. Such widgets are called "edge strips".
301
+ * ...
302
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-dock)
303
+ */
304
+ dock ? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
305
+ /**
306
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-floating).*
307
+ * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
308
+ * property which controls when a drag should start.
309
+ * ...
310
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-draggable)
311
+ */
312
+ draggable ? : Boolean|{
313
+ handleSelector?: string
314
+ }
315
+ /**
316
+ * Make this Panel a docked drawer which slides out from one side of the browser viewport by default.
317
+ * ...
318
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-drawer)
319
+ * @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.
320
+ * @param {string,number} size The size of the drawer in its collapsible axis.
321
+ * @param {boolean} inline If using the [appendTo](https://bryntum.com/products/calendar/docs/api/Core/widget/Panel#config-appendTo) config to place the drawer inside a host widget, this may be set to `true` to make the drawer inline within that host. Note that, if using this, the layout of the host element must have `flex-direction` set appropriately.
322
+ * @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.
323
+ * @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.
324
+ * @param {boolean,string} autoClose.focusout If focus moves outside of the drawer, the drawer will automatically be hidden.
325
+ * @param {string} autoClose.mouseout Hides the drawer when the mouse leaves the drawer after the `autoCloseDelay` period.
326
+ * @param {number} autoCloseDelay When using `mouseout`, this is the delay in milliseconds
327
+ */
328
+ 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}
329
+ /**
330
+ * An object specifying attributes to assign to the root element of this widget.
331
+ * Set `null` value to attribute to remove it.
332
+ * ...
333
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-elementAttributes)
334
+ */
335
+ elementAttributes ? : Record<string, string|null>
336
+ /**
337
+ * Allow using [Delete] and [Backspace] to remove events/assignments
338
+ */
339
+ enableDeleteKey ? : Boolean
340
+ /**
341
+ * Enables events being recurring and also adds extra recurrence UI fields in the built-in event editor.
342
+ * ...
343
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-enableRecurringEvents)
344
+ */
345
+ enableRecurringEvents ? : Boolean|{
346
+ defaultAction?: 'single'|'future'
347
+ }
348
+ /**
349
+ * Set to `true` to listen for CTRL-Z (CMD-Z on Mac OS) keyboard event and trigger undo (redo when SHIFT is pressed).
350
+ * Only applicable when using a [StateTrackingManager](https://bryntum.com/products/calendar/docs/api/Core/data/stm/StateTrackingManager).
351
+ */
352
+ enableUndoRedoKeys ? : Boolean
353
+ /**
354
+ * Inline events, will be loaded into the [eventStore](https://bryntum.com/products/calendar/docs/api/Calendar/mixin/CalendarStores#property-eventStore).
355
+ */
356
+ events ? : EventModel[]|EventModelConfig[]
357
+ /**
358
+ * Configure as `true`, or set property to `true` to disable event selection.
359
+ */
360
+ eventSelectionDisabled ? : Boolean
361
+ /**
362
+ * The [EventStore](https://bryntum.com/products/calendar/docs/api/Scheduler/data/EventStore) or a reconfiguring object for a store which will hold
363
+ * the events to be rendered into the Calendar.
364
+ */
365
+ eventStore ? : EventStore|EventStoreConfig
366
+ extraData ? : any
367
+ /**
368
+ * If this is set to `true`, then when determining which assigned resource of a multi assigned event
369
+ * to use to create the event UI, the first resource which is still selected in the
370
+ * [resourceFilter](https://bryntum.com/products/calendar/docs/api/Calendar/widget/Sidebar#property-resourceFilter) is used.
371
+ * ...
372
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-filterEventResources)
373
+ */
374
+ filterEventResources ? : Boolean
375
+ /**
376
+ * When this widget is a child of a [Container](https://bryntum.com/products/calendar/docs/api/Core/widget/Container), it will by default be participating in a
377
+ * flexbox layout. This config allows you to set this widget's
378
+ * [flex](https://developer.mozilla.org/en-US/docs/Web/CSS/flex) style.
379
+ * This may be configured as a single number or a `&lt;flex-grow&gt; &lt;flex-shrink&gt; &lt;flex-basis&gt;` format string.
380
+ * numeric-only values are interpreted as the `flex-grow` value.
381
+ */
382
+ flex ? : number|string
383
+ /**
384
+ * Set to `true` to move the widget out of the document flow and position it
385
+ * absolutely in browser viewport space.
386
+ */
387
+ floating ? : Boolean
388
+ /**
389
+ * Config object of a footer. May contain a `dock`, `html` and a `cls` property. A footer is not a widget,
390
+ * but rather plain HTML that follows the last element of the panel's body and [strips](https://bryntum.com/products/calendar/docs/api/Core/widget/Panel#config-strips).
391
+ * ...
392
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-footer)
393
+ */
394
+ footer ? : {
395
+ dock?: 'top'|'right'|'bottom'|'left'|'start'|'end'
396
+ html?: string
397
+ cls?: string
398
+ }|string
399
+ /**
400
+ * A config [object](https://bryntum.com/products/calendar/docs/api/Core/widget/Panel#typedef-PanelHeader) for the panel's header or a string in place of a `title`.
401
+ * ...
402
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-header)
403
+ */
404
+ header ? : string|Boolean|PanelHeader
405
+ /**
406
+ * Widget's height, used to set element `style.height`. Either specify a valid height string or a number,
407
+ * which will get 'px' appended. We recommend using CSS as the primary way to control height, but in some
408
+ * cases this config is convenient.
409
+ */
410
+ height ? : string|number
411
+ /**
412
+ * Configure with true to make widget initially hidden.
413
+ */
414
+ hidden ? : Boolean
415
+ /**
416
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-floating).*
417
+ * ...
418
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-hideAnimation)
419
+ */
420
+ hideAnimation ? : Boolean|object
421
+ /**
422
+ * Configure as `true` to hide [nonWorkingDays](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-nonWorkingDays) for each calendar view
423
+ */
424
+ hideNonWorkingDays ? : Boolean
425
+ /**
426
+ * Specify `true` to make this container hide when it has no visible children (Either empty
427
+ * or all children hidden).
428
+ * ...
429
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-hideWhenEmpty)
430
+ */
431
+ hideWhenEmpty ? : Boolean
432
+ /**
433
+ * Configure this as `true` to make picking a date in the [sidebar](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-sidebar)'s
434
+ * date picker highlight the date cell in the active view.
435
+ * ...
436
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-highlightDate)
437
+ * @param {Date} date Cell date
438
+ * @returns {boolean} Returns `true` to make picking a date in a date picker
439
+ */
440
+ highlightDate ? : Boolean|((date: Date) => Boolean)
441
+ /**
442
+ * Configure as `true`, or set property to `true` to highlight dependent events as well when selecting an event.
443
+ */
444
+ highlightPredecessors ? : Boolean
445
+ /**
446
+ * Configure as `true`, or set property to `true` to highlight dependent events as well when selecting an event.
447
+ */
448
+ highlightSuccessors ? : Boolean
449
+ /**
450
+ * An icon to show before the [title](https://bryntum.com/products/calendar/docs/api/Core/widget/Panel#config-title). Either pass a CSS class as a string, or pass a
451
+ * [DomConfig](https://bryntum.com/products/calendar/docs/api/Core/helper/DomHelper#typedef-DomConfig) object describing an element to represent the icon.
452
+ */
453
+ icon ? : string|DomConfig
454
+ /**
455
+ * Widget id, if not specified one will be generated. Also used for lookups through Widget.getById
456
+ */
457
+ id ? : string
458
+ /**
459
+ * Determines if the widgets read-only state should be controlled by its parent.
460
+ * ...
461
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-ignoreParentReadOnly)
462
+ */
463
+ ignoreParentReadOnly ? : Boolean
464
+ /**
465
+ * Set to `true` to show the "Weekends" toggle button of the mode selector. Alternatively, this config
466
+ * can be a [Button](https://bryntum.com/products/calendar/docs/api/Core/widget/Button) config object to configure the button.
467
+ * ...
468
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-includeWeekendsButton)
469
+ */
470
+ includeWeekendsButton ? : Boolean|ButtonConfig
471
+ /**
472
+ * Convenience setting to align input fields of child widgets. By default, the Field input element is
473
+ * placed immediately following the `label`. If you prefer to have all input fields aligned to the
474
+ * right, set this config to `'end'`.
475
+ * ...
476
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-inputFieldAlign)
477
+ */
478
+ inputFieldAlign ? : 'start'|'end'
479
+ /**
480
+ * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
481
+ */
482
+ insertBefore ? : HTMLElement|string
483
+ /**
484
+ * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
485
+ */
486
+ insertFirst ? : HTMLElement|string
487
+ /**
488
+ * A template method (empty by default) allowing you to control if an event can be selected or not.
489
+ * ...
490
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-isEventSelectable)
491
+ * @param {Scheduler.model.EventModel} event The event record
492
+ * @returns {boolean} true if event can be selected, otherwise false
493
+ */
494
+ isEventSelectable ? : (event: EventModel) => Boolean
495
+ /**
496
+ * An optional CSS class to add to child items of this container.
497
+ */
498
+ itemCls ? : string
499
+ /**
500
+ * The child items of the Calendar view.
501
+ * ...
502
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-items)
503
+ */
504
+ items ? : object
505
+ /**
506
+ * The default key shortcuts for the Calendar.
507
+ * ...
508
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-keyMap)
509
+ */
510
+ keyMap ? : Record<string, KeyMapConfig>
511
+ /**
512
+ * Convenience setting to use same label placement on all child widgets.
513
+ * ...
514
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-labelPosition)
515
+ */
516
+ labelPosition ? : 'before'|'above'|'align-before'|'auto'|null
517
+ /**
518
+ * The short name of a helper class which manages rendering and styling of child items.
519
+ * ...
520
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-layout)
521
+ */
522
+ layout ? : string|ContainerLayoutConfig
523
+ /**
524
+ * The CSS style properties to apply to the [contentElement](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#property-contentElement).
525
+ * ...
526
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-layoutStyle)
527
+ */
528
+ layoutStyle ? : object
529
+ /**
530
+ * An array of [child item](https://bryntum.com/products/calendar/docs/api/Core/widget/Container#config-items) *config objects* which is to be converted into
531
+ * instances only when this Container is rendered, rather than eagerly at construct time.
532
+ * ...
533
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-lazyItems)
534
+ */
535
+ lazyItems ? : Record<string, ContainerItemConfig>|ContainerItemConfig[]|Widget[]
536
+ /**
537
+ * The listener set for this object.
538
+ * ...
539
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-listeners)
540
+ */
541
+ listeners ? : CalendarListeners
542
+ /**
543
+ * A [Mask](https://bryntum.com/products/calendar/docs/api/Core/widget/Mask) config object, or a message to be shown when a store is performing a remote
544
+ * operation, or Crud Manager is loading data from the sever. Set to `null` to disable default load mask.
545
+ */
546
+ loadMask ? : string|MaskConfig|null
547
+ /**
548
+ * A [Mask](https://bryntum.com/products/calendar/docs/api/Core/widget/Mask) config object to adjust the [maskDefaults](#Core/widget/Widget#config-maskDefaults)
549
+ * when data is loading. The message and optional configuration from the
550
+ * [loadMask](https://bryntum.com/products/calendar/docs/api/Core/mixin/LoadMaskable#config-loadMask) config take priority over these options, just as they do
551
+ * for `maskDefaults`, respectively.
552
+ * ...
553
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-loadMaskDefaults)
554
+ */
555
+ loadMaskDefaults ? : MaskConfig
556
+ /**
557
+ * A [Mask](https://bryntum.com/products/calendar/docs/api/Core/widget/Mask) config object to adjust the [maskDefaults](#Core/widget/Widget#config-maskDefaults)
558
+ * when an error occurs loading data.
559
+ * ...
560
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-loadMaskError)
561
+ */
562
+ loadMaskError ? : MaskConfig|Mask|Boolean
563
+ /**
564
+ * A class translations of which are used for translating this entity.
565
+ * This is often used when translations of an item are defined on its container class.
566
+ * For example:
567
+ * ...
568
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-localeClass)
569
+ */
570
+ localeClass ? : typeof Base
571
+ /**
572
+ * Set to `false` to disable localization of this object.
573
+ */
574
+ localizable ? : Boolean
575
+ /**
576
+ * List of properties which values should be translated automatically upon a locale applying.
577
+ * In case there is a need to localize not typical value (not a String value or a field with re-defined setter/getter),
578
+ * you could use 'localeKey' meta configuration.
579
+ * Example:
580
+ * ...
581
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-localizableProperties)
582
+ */
583
+ localizableProperties ? : string[]
584
+ /**
585
+ * This flag controls whether Scheduler should preserve its selection of events when loading a new dataset
586
+ * (if selected event ids are included in the newly loaded dataset).
587
+ */
588
+ maintainSelectionOnDatasetChange ? : Boolean
589
+ /**
590
+ * Widget's margin. This may be configured as a single number or a `TRBL` format string.
591
+ * numeric-only values are interpreted as pixels.
592
+ */
593
+ margin ? : number|string
594
+ /**
595
+ * This config object contains the defaults for the [Mask](https://bryntum.com/products/calendar/docs/api/Core/widget/Mask) created for the
596
+ * [masked](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-masked) config. Any properties specified in the `masked` config will override these
597
+ * values.
598
+ */
599
+ maskDefaults ? : MaskConfig
600
+ /**
601
+ * Set to `true` to apply the default mask to the widget. Alternatively, this can be the mask message or a
602
+ * [Mask](https://bryntum.com/products/calendar/docs/api/Core/widget/Mask) config object.
603
+ */
604
+ masked ? : Boolean|string|MaskConfig
605
+ /**
606
+ * The maximum date to which the `endDate` of any child view may be navigated.
607
+ */
608
+ maxDate ? : Date|string
609
+ /**
610
+ * The element's maxHeight. Can be either a String or a Number (which will have 'px' appended). Note that
611
+ * like [height](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-height), *reading* the value will return the numeric value in pixels.
612
+ */
613
+ maxHeight ? : string|number
614
+ /**
615
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-floating).*
616
+ * ...
617
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-maximizeOnMobile)
618
+ */
619
+ maximizeOnMobile ? : number|string
620
+ /**
621
+ * The elements maxWidth. Can be either a String or a Number (which will have 'px' appended). Note that
622
+ * like [width](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-width), *reading* the value will return the numeric value in pixels.
623
+ */
624
+ maxWidth ? : string|number
625
+ /**
626
+ * The minimum date to which the `startDate` of any child view may be navigated.
627
+ */
628
+ minDate ? : Date|string
629
+ /**
630
+ * The element's minHeight. Can be either a String or a Number (which will have 'px' appended). Note that
631
+ * like [height](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-height), *reading* the value will return the numeric value in pixels.
632
+ */
633
+ minHeight ? : string|number
634
+ /**
635
+ * The elements minWidth. Can be either a String or a Number (which will have 'px' appended). Note that
636
+ * like [width](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-width), *reading* the value will return the numeric value in pixels.
637
+ */
638
+ minWidth ? : string|number
639
+ /**
640
+ * Which of the built-in [modes](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-modes) should be the initially active view.
641
+ */
642
+ mode ? : 'agenda'|'year'|'month'|'week'|'day'|'list'|'resource'|'dayresource'|'dayagenda'|'monthagenda'|'monthgrid'|string
643
+ /**
644
+ * An object to use to configure common properties for all [modes](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-modes) prior to their construction.
645
+ */
646
+ modeDefaults ? : object
647
+ /**
648
+ * Configures the view modes which are to be available in this Calendar.
649
+ * ...
650
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-modes)
651
+ */
652
+ modes ? : {
653
+ [mode: string]: ContainerItemConfig|Boolean|null|undefined
654
+ agenda?: AgendaViewConfig|Boolean|null
655
+ year?: YearViewConfig|Boolean|null
656
+ month?: MonthViewConfig|Boolean|null
657
+ week?: WeekViewConfig|Boolean|null
658
+ day?: DayViewConfig|Boolean|null
659
+ list?: EventListConfig|Boolean|null
660
+ resource?: ResourceViewConfig|Boolean|null
661
+ dayresourceview?: DayResourceViewConfig|Boolean|null
662
+ dayagenda?: DayAgendaViewConfig|Boolean|null
663
+ monthagenda?: MonthAgendaViewConfig|Boolean|null
664
+ monthgrid?: MonthGridConfig|Boolean|null
665
+ }
666
+ /**
667
+ * When this is configured as `true` a [ResizeObserver](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver)
668
+ * is used to monitor this element for size changes caused by either style manipulation, or by CSS
669
+ * layout.
670
+ * ...
671
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-monitorResize)
672
+ */
673
+ monitorResize ? : Boolean|{
674
+ immediate?: Boolean
675
+ }
676
+ /**
677
+ * Configure as `true` to allow `CTRL/CMD+click` to select multiple events in the scheduler.
678
+ * ...
679
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-multiEventSelect)
680
+ */
681
+ multiEventSelect ? : Boolean|{
682
+ ctrlKey?: Boolean
683
+ altKey?: Boolean
684
+ shiftKey?: Boolean
685
+ }
686
+ /**
687
+ * An object containing default config objects which may be referenced by name in the [items](https://bryntum.com/products/calendar/docs/api/Core/widget/Container#config-items)
688
+ * config. For example, a specialized [Menu](https://bryntum.com/products/calendar/docs/api/Core/widget/Menu) subclass may have a `namedItems` default
689
+ * value defined like this:
690
+ * ...
691
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-namedItems)
692
+ */
693
+ namedItems ? : Record<string, ContainerItemConfig>
694
+ /**
695
+ * Indicates where the Next/Previous/Today buttons should be placed.
696
+ */
697
+ navigatorPlacement ? : 'toolbar'|'sidebar'
698
+ /**
699
+ * Non-working days as an object where keys are day indices, 0-6 (Sunday-Saturday), and the value is `true`.
700
+ * ...
701
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-nonWorkingDays)
702
+ */
703
+ nonWorkingDays ? : Record<number, Boolean>
704
+ /**
705
+ * By default, the [sidebar](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#property-sidebar) expands and collapses taking width from the
706
+ * calendar UI. Configure `overlaySidebar` as `true` to have it start collapsed, and then
707
+ * <strong>overlay</strong> the calendar UI when the expand/collapse button is toggled.
708
+ */
709
+ overlaySidebar ? : Boolean
710
+ /**
711
+ * The owning Widget of this Widget. If this Widget is directly contained (that is, it is one of the
712
+ * [items](https://bryntum.com/products/calendar/docs/api/Core/widget/Container#property-items) of a Container), this config will be ignored. In this case
713
+ * the owner is <strong>always</strong> the encapsulating Container.
714
+ * ...
715
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-owner)
716
+ */
717
+ owner ? : Widget|any
718
+ /**
719
+ * Set to `true` when a widget is rendered into another widget's [contentElement](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#property-contentElement), but must
720
+ * not participate in the standard layout of that widget, and must be positioned relatively to that
721
+ * widget's [contentElement](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#property-contentElement).
722
+ * ...
723
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-positioned)
724
+ */
725
+ positioned ? : Boolean
726
+ /**
727
+ * Prevent tooltip from being displayed on touch devices. Useful for example for buttons that display a
728
+ * menu on click etc, since the tooltip would be displayed at the same time.
729
+ */
730
+ preventTooltipOnTouch ? : Boolean
731
+ /**
732
+ * A [ProjectModel](https://bryntum.com/products/calendar/docs/api/Scheduler/model/ProjectModel) instance or a config object. The project holds all Scheduler data.
733
+ * Can be omitted in favor of individual store configs or [crudManager](https://bryntum.com/products/calendar/docs/api/Scheduler/view/mixin/SchedulerStores#config-crudManager) config.
734
+ * ...
735
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-project)
736
+ */
737
+ project ? : ProjectModel|ProjectModelConfig|object
738
+ /**
739
+ * The names of properties which are propagated down from the Calendar to child views
740
+ * unless the view has its own value for that property.
741
+ */
742
+ propagatedConfigs ? : string[]
743
+ /**
744
+ * Configure as `true` to make the calendar read-only, by disabling any UIs for modifying data.
745
+ * ...
746
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-readOnly)
747
+ */
748
+ readOnly ? : Boolean
749
+ /**
750
+ * The confirmation dialog shown when a recurring event is edited.
751
+ * ...
752
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-recurrenceConfirmationPopup)
753
+ */
754
+ recurrenceConfirmationPopup ? : RecurrenceConfirmationPopupConfig|RecurrenceConfirmationPopup
755
+ relayStoreEvents ? : Boolean
756
+ /**
757
+ * Either a default `rendition` to apply to all child widgets, or a map of renditions keyed by child widget
758
+ * `type`.
759
+ * ...
760
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-rendition)
761
+ */
762
+ rendition ? : string|Record<string, string>|null
763
+ /**
764
+ * Path to load resource images from. Used by the resource headers in ResourceView and by
765
+ * [showResourceAvatars](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/CalendarMixin#config-showResourceAvatars) in event-displaying
766
+ * modes.
767
+ * ...
768
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-resourceImagePath)
769
+ */
770
+ resourceImagePath ? : string
771
+ /**
772
+ * Inline resources, will be loaded into the [resourceStore](https://bryntum.com/products/calendar/docs/api/Calendar/mixin/CalendarStores#property-resourceStore).
773
+ */
774
+ resources ? : ResourceModel[]|ResourceModelConfig[]
775
+ /**
776
+ * The [ResourceStore](https://bryntum.com/products/calendar/docs/api/Scheduler/data/ResourceStore) or a reconfiguring object for a store which will hold the resources to be rendered into the Calendar.
777
+ */
778
+ resourceStore ? : ResourceStore|ResourceStoreConfig
779
+ /**
780
+ * Inline resource time ranges, will be loaded into [resourceTimeRangeStore](https://bryntum.com/products/calendar/docs/api/Calendar/mixin/CalendarStores#property-resourceTimeRangeStore).
781
+ * ...
782
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-resourceTimeRanges)
783
+ */
784
+ resourceTimeRanges ? : ResourceTimeRangeModel[]|ResourceTimeRangeModelConfig[]
785
+ /**
786
+ * The [ResourceTimeRangeStore](https://bryntum.com/products/calendar/docs/api/Scheduler/data/ResourceTimeRangeStore) or a reconfiguring object for a store which will hold resource time ranges.
787
+ * These may be used by the [TimeRanges](https://bryntum.com/products/calendar/docs/api/Calendar/feature/TimeRanges) feature.
788
+ */
789
+ resourceTimeRangeStore ? : ResourceTimeRangeStore|ResourceTimeRangeStoreConfig
790
+ /**
791
+ * Specifies the various responsive state objects keyed by their name. Each key (except `'*'`, see below) in
792
+ * this object is a state name (see [responsiveState](https://bryntum.com/products/calendar/docs/api/Core/widget/mixin/Responsive#config-responsiveState)) and its corresponding value is the
793
+ * associated [ResponsiveState](https://bryntum.com/products/calendar/docs/api/Core/widget/mixin/Responsive#typedef-ResponsiveState) object.
794
+ * ...
795
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-responsive)
796
+ */
797
+ responsive ? : object
798
+ /**
799
+ * Set to `true` to mark this instance as the default [responsiveTarget](https://bryntum.com/products/calendar/docs/api/Core/widget/mixin/Responsive#config-responsiveTarget) for descendants that do
800
+ * not specify an explicit [responsiveTarget](https://bryntum.com/products/calendar/docs/api/Core/widget/mixin/Responsive#config-responsiveTarget) of their own.
801
+ */
802
+ responsiveRoot ? : Boolean
803
+ /**
804
+ * The name of the active state of the [responsive](https://bryntum.com/products/calendar/docs/api/Core/widget/mixin/Responsive#config-responsive) config. This is assigned internally
805
+ * and should not be assigned directly.
806
+ */
807
+ responsiveState ? : string
808
+ /**
809
+ * The widget whose size and other properties drive this object's responsive behavior. If this config is not
810
+ * specified, the closest ancestor that specified [responsiveRoot=true](https://bryntum.com/products/calendar/docs/api/Core/widget/mixin/Responsive#config-responsiveRoot) will be
811
+ * used. If there is no such ancestor, then the instance using this mixin is used.
812
+ * ...
813
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-responsiveTarget)
814
+ */
815
+ responsiveTarget ? : string|Widget
816
+ /**
817
+ * Configure as `true` to have the component display a translucent ripple when its
818
+ * [focusElement](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#property-focusElement), or [element](#Core/widget/Widget#property-element) is tapped <em>if the
819
+ * current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
820
+ * ...
821
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-ripple)
822
+ */
823
+ ripple ? : Boolean|{
824
+ delegate?: string
825
+ color?: string
826
+ radius?: number
827
+ clip?: string
828
+ }
829
+ /**
830
+ * 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`
831
+ */
832
+ rootElement ? : ShadowRoot|HTMLElement
833
+ /**
834
+ * This may be configured as `true` to make the widget's element use the `direction:rtl` style.
835
+ * ...
836
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-rtl)
837
+ */
838
+ rtl ? : Boolean
839
+ /**
840
+ * Specifies whether (and optionally in which axes) a Widget may scroll. `true` means this widget may scroll
841
+ * in both axes. May be an object containing boolean `overflowX` and `overflowY` properties which are
842
+ * applied to CSS style properties `overflowX` and `overflowY`. If they are boolean, they are translated to
843
+ * CSS overflow properties thus:
844
+ * ...
845
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-scrollable)
846
+ */
847
+ scrollable ? : Boolean|ScrollerConfig|Scroller
848
+ /**
849
+ * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
850
+ * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
851
+ */
852
+ scrollAction ? : 'hide'|'realign'|null
853
+ /**
854
+ * Set to `false` to not select the resource of the event when clicking an event bar.
855
+ */
856
+ selectResourceOnEventNavigate ? : Boolean
857
+ /**
858
+ * Set to `false` to not select the row/resource when clicking the empty area in a time axis cell.
859
+ */
860
+ selectResourceOnScheduleClick ? : Boolean
861
+ /**
862
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-floating).*
863
+ * ...
864
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-showAnimation)
865
+ */
866
+ showAnimation ? : Boolean|object
867
+ /**
868
+ * Set to `false` to hide recurring fields in event editor, even if the
869
+ * [Recurring Events](https://bryntum.com/products/calendar/docs/api/Scheduler/view/mixin/RecurringEvents#config-enableRecurringEvents) is `true`
870
+ * and a recurring event is being edited.
871
+ */
872
+ showRecurringUI ? : Boolean
873
+ /**
874
+ * Set to `false` to not show the tooltip when this widget is [disabled](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#property-disabled)
875
+ */
876
+ showTooltipWhenDisabled ? : Boolean
877
+ /**
878
+ * An optional config object to configure the [Sidebar](https://bryntum.com/products/calendar/docs/api/Calendar/widget/Sidebar) which is
879
+ * shown next to the calendar views specified by the [modes](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-modes).
880
+ * ...
881
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-sidebar)
882
+ * @param {'left','right'} side Which [side](https://bryntum.com/products/calendar/docs/api/Calendar/widget/Sidebar#config-side) to dock to.
883
+ * @param {boolean} collapsed May be initially [collapsed](https://bryntum.com/products/calendar/docs/api/Calendar/widget/Sidebar#config-collapsed).
884
+ * @param {Record<string, ContainerItemConfig>} items Reconfigure or add to the sidebar UI.
885
+ * @param {ContainerItemConfig} items.custom Settings specific to custom item.
886
+ * @param {DatePickerConfig} items.datePicker The [DatePicker](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker) may be reconfigured using an object, or configured away using `null`. Its default [weight](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-weight) is 100.
887
+ * @param {TextFieldConfig} items.eventFilter The eventFilter is a [TextField](https://bryntum.com/products/calendar/docs/api/Core/widget/TextField) which may be used to filter the events by matched name. It may be reconfigured using an object, or configured away using `null`. Its default [weight](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-weight) is 150.
888
+ * @param {ResourceFilterConfig} items.resourceFilter The [ResourceFilter](https://bryntum.com/products/calendar/docs/api/Scheduler/widget/ResourceFilter) may be reconfigured using an object, or configured away using `null`. Its default [weight](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-weight) is 200.
889
+ */
890
+ sidebar ? : {side?: 'left'|'right', collapsed?: Boolean, items: { [mode: string]: ContainerItemConfig|null|undefined, datePicker?: DatePickerConfig, eventFilter?: TextFieldConfig, resourceFilter?: ResourceFilterConfig }}|Boolean
891
+ /**
892
+ * Programmatic control over how many columns to span when used in a grid layout.
893
+ */
894
+ span ? : number
895
+ /**
896
+ * This value can be one of the following:
897
+ * ...
898
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-stateful)
899
+ */
900
+ stateful ? : Boolean|object|string[]
901
+ /**
902
+ * The events that, when fired by this component, should trigger it to save its state by calling
903
+ * [saveState](https://bryntum.com/products/calendar/docs/api/Core/mixin/State#function-saveState).
904
+ * ...
905
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-statefulEvents)
906
+ */
907
+ statefulEvents ? : object|string[]
908
+ /**
909
+ * The key to use when saving this object's state in the [stateProvider](https://bryntum.com/products/calendar/docs/api/Core/mixin/State#config-stateProvider). If this config is
910
+ * not assigned, and [stateful](https://bryntum.com/products/calendar/docs/api/Core/mixin/State#config-stateful) is not set to `false`, the [id](#Core/widget/Widget#config-id)
911
+ * (if explicitly specified) will be used as the `stateId`.
912
+ * ...
913
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-stateId)
914
+ */
915
+ stateId ? : string
916
+ /**
917
+ * The `StateProvider` to use to save and restore this object's [state](https://bryntum.com/products/calendar/docs/api/Core/mixin/State#property-state). By default, `state`
918
+ * will be saved using the [default state provider](https://bryntum.com/products/calendar/docs/api/Core/state/StateProvider#property-instance-static).
919
+ * ...
920
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-stateProvider)
921
+ */
922
+ stateProvider ? : StateProvider
923
+ /**
924
+ * Specify `true` to match fields by their `name` property only when assigning a [record](https://bryntum.com/products/calendar/docs/api/Core/widget/Container#config-record),
925
+ * without falling back to `ref`.
926
+ */
927
+ strictRecordMapping ? : Boolean
928
+ /**
929
+ * An object containing widgets keyed by name. By default (when no `type` is given), strips are
930
+ * [toolbars](https://bryntum.com/products/calendar/docs/api/Core/widget/Toolbar). If you want to pass an array, you can use
931
+ * the toolbar's [items](https://bryntum.com/products/calendar/docs/api/Core/widget/Container#config-items).
932
+ * ...
933
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-strips)
934
+ */
935
+ strips ? : Record<string, ContainerItemConfig>
936
+ /**
937
+ * A [Mask](https://bryntum.com/products/calendar/docs/api/Core/widget/Mask) config object, or a message to be shown when Crud Manager
938
+ * is persisting changes on the server. Set to `null` to disable default sync mask.
939
+ * ...
940
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-syncMask)
941
+ */
942
+ syncMask ? : string|MaskConfig|null
943
+ /**
944
+ * A configuration for the [tab](https://bryntum.com/products/calendar/docs/api/Core/widget/Tab) created for this widget when it is placed in a
945
+ * [TabPanel](https://bryntum.com/products/calendar/docs/api/Core/widget/TabPanel). For example, this config can be used to control the icon of the `tab` for
946
+ * this widget:
947
+ * ...
948
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-tab)
949
+ */
950
+ tab ? : Boolean|TabConfig
951
+ /**
952
+ * When this container is used as a tab in a TabPanel, these items are added to the
953
+ * [TabBar](https://bryntum.com/products/calendar/docs/api/Core/widget/TabBar) when this container is the active tab.
954
+ * ...
955
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-tabBarItems)
956
+ */
957
+ tabBarItems ? : ToolbarItems[]|Widget[]
958
+ /**
959
+ * The tag name of this Widget's root element
960
+ */
961
+ tag ? : string
962
+ /**
963
+ * A config object containing definitions of the toolbar of the Calendar.
964
+ * ...
965
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-tbar)
966
+ */
967
+ tbar ? : (ContainerItemConfig|string)[]|ToolbarConfig|CalendarToolbarConfig|null
968
+ /**
969
+ * Text alignment: 'left', 'center' or 'right'. Also accepts direction neutral 'start' and 'end'.
970
+ * ...
971
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-textAlign)
972
+ */
973
+ textAlign ? : 'left'|'center'|'right'|'start'|'end'
974
+ /**
975
+ * Inline time ranges, will be loaded into the [timeRangeStore](https://bryntum.com/products/calendar/docs/api/Calendar/mixin/CalendarStores#property-timeRangeStore).
976
+ * ...
977
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-timeRanges)
978
+ */
979
+ timeRanges ? : TimeRangeModel[]|TimeRangeModelConfig[]
980
+ /**
981
+ * The [TimeRangeStore](https://bryntum.com/products/calendar/docs/api/Calendar/data/TimeRangeStore) or a reconfiguring object for a store which will hold time ranges.
982
+ * These may be used by the [TimeRanges](https://bryntum.com/products/calendar/docs/api/Calendar/feature/TimeRanges) feature.
983
+ */
984
+ timeRangeStore ? : TimeRangeStore|TimeRangeStoreConfig
985
+ /**
986
+ * Set to a time zone or a UTC offset. This will set the project's
987
+ * [timeZone](https://bryntum.com/products/calendar/docs/api/Scheduler/model/ProjectModel#config-timeZone) config accordingly. As this config is only a referer,
988
+ * please see project's config [documentation](https://bryntum.com/products/calendar/docs/api/Scheduler/model/ProjectModel#config-timeZone) for more
989
+ * information.
990
+ * ...
991
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-timeZone)
992
+ */
993
+ timeZone ? : string|number
994
+ /**
995
+ * A title to display in the header or owning TabPanel. Causes creation and docking of a header
996
+ * to the top if no header is configured.
997
+ * ...
998
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-title)
999
+ */
1000
+ title ? : string
1001
+ /**
1002
+ * The [tools](https://bryntum.com/products/calendar/docs/api/Core/widget/Tool) to add either before or after the `title` in the Panel header. Each
1003
+ * property name is the reference by which an instantiated tool may be retrieved from the live
1004
+ * `[tools](https://bryntum.com/products/calendar/docs/api/Core/widget/mixin/Toolable#property-tools)` property.
1005
+ * ...
1006
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-tools)
1007
+ */
1008
+ tools ? : Record<string, ToolConfig>|null
1009
+ /**
1010
+ * Tooltip for the widget, either as a string or as a Tooltip config object.
1011
+ * ...
1012
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-tooltip)
1013
+ */
1014
+ tooltip ? : string|TooltipConfig|null
1015
+ /**
1016
+ * By default, tabbing within a Panel is not contained, ie you can TAB out of the Panel
1017
+ * forwards or backwards.
1018
+ * Configure this as `true` to disallow tabbing out of the Panel, and make tabbing circular within this Panel.
1019
+ */
1020
+ trapFocus ? : Boolean
1021
+ /**
1022
+ * Configure as `true` to trigger `selectionChange` when removing a selected event/assignment.
1023
+ */
1024
+ triggerSelectionChangeOnRemove ? : Boolean
1025
+ type ? : 'calendar'
1026
+ /**
1027
+ * Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
1028
+ * as a space separated string, an array of strings, or as an object in which property names with truthy
1029
+ * values are used as the class names.
1030
+ * ...
1031
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-ui)
1032
+ */
1033
+ ui ? : 'plain'|'toolbar'|string|object
1034
+ /**
1035
+ * By default, the day of week and week of month of the event's start date are used to create
1036
+ * helpful contextual recurrence types when editing a non-recurring event record and choosing
1037
+ * an initial recurrence type.
1038
+ * ...
1039
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-useContextualRecurrenceRules)
1040
+ */
1041
+ useContextualRecurrenceRules ? : Boolean
1042
+ /**
1043
+ * Configuration options to change how the subordinate [Container](https://bryntum.com/products/calendar/docs/api/Core/widget/Container) which contains
1044
+ * the calendar's child views is created.
1045
+ * ...
1046
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-viewContainer)
1047
+ */
1048
+ viewContainer ? : ContainerConfig
1049
+ /**
1050
+ * The week start day to be used throughout this Calendar, 0 meaning Sunday, 6 meaning Saturday.
1051
+ * ...
1052
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-weekStartDay)
1053
+ */
1054
+ weekStartDay ? : number
1055
+ /**
1056
+ * A widgets weight determines its position among siblings when added to a [Container](https://bryntum.com/products/calendar/docs/api/Core/widget/Container).
1057
+ * Higher weights go further down.
1058
+ */
1059
+ weight ? : number
1060
+ /**
1061
+ * Widget's width, used to set element `style.width`. Either specify a valid width string or a number, which
1062
+ * will get 'px' appended. We recommend using CSS as the primary way to control width, but in some cases
1063
+ * this config is convenient.
1064
+ */
1065
+ width ? : string|number
1066
+ /**
1067
+ * The x position for the widget.
1068
+ * ...
1069
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-x)
1070
+ */
1071
+ x ? : number
1072
+ /**
1073
+ * The y position for the widget.
1074
+ * ...
1075
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#config-y)
1076
+ */
1077
+ y ? : number
1078
+
1079
+ // Features
1080
+ /**
1081
+ * This feature provides drag-based event creation and modification for Calendars. When enabled (which is the default
1082
+ * for calendars), the user can do the following via the mouse or touch screen:
1083
+ * ...
1084
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/feature/CalendarDrag)
1085
+ */
1086
+ dragFeature ? : object|Boolean|string|CalendarDrag|CalendarDragConfig
1087
+ /**
1088
+ * A Feature that allows showing additional time before &amp; after an event, to visualize things like travel time - or the time you
1089
+ * need to prepare a room for a meeting + clean it up after.
1090
+ * ...
1091
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/feature/EventBuffer)
1092
+ */
1093
+ eventBufferFeature ? : object|Boolean|string|EventBuffer|EventBufferConfig
1094
+ /**
1095
+ * Allow using [Ctrl/CMD + C/X/V] to copy/cut-and-paste events.
1096
+ * ...
1097
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/feature/EventCopyPaste)
1098
+ */
1099
+ eventCopyPasteFeature ? : object|Boolean|string|EventCopyPaste|EventCopyPasteConfig
1100
+ /**
1101
+ * Feature that displays a popup containing fields for editing event data.
1102
+ * ...
1103
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/feature/EventEdit)
1104
+ */
1105
+ eventEditFeature ? : object|Boolean|string|EventEdit|EventEditConfig
1106
+ /**
1107
+ * A feature which shows a context menu when right-clicking events in the calendar.
1108
+ * ...
1109
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/feature/EventMenu)
1110
+ */
1111
+ eventMenuFeature ? : object|Boolean|string|EventMenu|EventMenuConfig
1112
+ /**
1113
+ * A feature which displays a [tooltip](https://bryntum.com/products/calendar/docs/api/Calendar/feature/EventTooltip#config-tooltip) containing extra information. The tooltip can
1114
+ * be triggered by clicking or hovering an event bar element (see [showOn](https://bryntum.com/products/calendar/docs/api/Calendar/feature/EventTooltip#config-showOn)).
1115
+ * ...
1116
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/feature/EventTooltip)
1117
+ */
1118
+ eventTooltipFeature ? : object|Boolean|string|EventTooltip|EventTooltipConfig
1119
+ /**
1120
+ * A feature that allows exporting Calendar data to Excel or CSV without involving the server. It uses
1121
+ * [TableExporter](https://bryntum.com/products/calendar/docs/api/Grid/util/TableExporter) class as data provider, 3rd party provider to generate XLS files, and
1122
+ * [Microsoft XML specification](https://msdn.microsoft.com/en-us/library/office/documentformat.openxml.spreadsheet.aspx).
1123
+ * ...
1124
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/feature/experimental/ExcelExporter)
1125
+ */
1126
+ excelExporterFeature ? : object|Boolean|string|ExcelExporter|ExcelExporterConfig
1127
+ /**
1128
+ * A Calendar feature which allows new events to be dragged into the Calendar from an external source.
1129
+ * ...
1130
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/feature/ExternalEventSource)
1131
+ */
1132
+ externalEventSourceFeature ? : object|Boolean|string|ExternalEventSource|ExternalEventSourceConfig
1133
+ /**
1134
+ * Loads the host Calendar's [CrudManager](https://bryntum.com/products/calendar/docs/api/Scheduler/view/mixin/SchedulerStores#config-crudManager) on demand
1135
+ * as the date range required to produce the UI changes.
1136
+ * ...
1137
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/feature/LoadOnDemand)
1138
+ */
1139
+ loadOnDemandFeature ? : object|Boolean|string|LoadOnDemand|LoadOnDemandConfig
1140
+ /**
1141
+ * This feature enables printing of the current Calendar mode.
1142
+ * ...
1143
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/feature/print/Print)
1144
+ */
1145
+ printFeature ? : object|Boolean|string|Print|PrintConfig
1146
+ /**
1147
+ * A feature which adds a context menu to the unoccupied parts of calendar views.
1148
+ * ...
1149
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/feature/ScheduleMenu)
1150
+ */
1151
+ scheduleMenuFeature ? : object|Boolean|string|ScheduleMenu|ScheduleMenuConfig
1152
+ /**
1153
+ * A feature that displays a tooltip containing the time at the mouse position when hovering empty parts of the schedule.
1154
+ * ...
1155
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/feature/ScheduleTooltip)
1156
+ */
1157
+ scheduleTooltipFeature ? : object|Boolean|string|ScheduleTooltip|ScheduleTooltipConfig
1158
+ /**
1159
+ * This feature provides an easy way to highlight ranges of time in a calendar's day and week views. Each time range is
1160
+ * represented using the [TimeRangeModel](https://bryntum.com/products/calendar/docs/api/Calendar/model/TimeRangeModel).
1161
+ * ...
1162
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/feature/TimeRanges)
1163
+ */
1164
+ timeRangesFeature ? : object|Boolean|string|TimeRanges|TimeRangesConfig
1165
+ /**
1166
+ * A Feature which, when present, adds a week row expansion tool to week rows in
1167
+ * [MonthView](https://bryntum.com/products/calendar/docs/api/Calendar/widget/MonthView)s so that a row which contains overflowing cells
1168
+ * can be expanded to show all events with no overflow.
1169
+ * ...
1170
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/feature/WeekExpander)
1171
+ */
1172
+ weekExpanderFeature ? : object|Boolean|string|WeekExpander|WeekExpanderConfig
1173
+
1174
+ }>();
1175
+
1176
+ const emit = defineEmits<{
1177
+ /**
1178
+ * Fired when a change of view (Calendar mode) has completed. By default, view changes are animated and this
1179
+ * event fires when the view is fully visible.
1180
+ * @param {string} e Event name
1181
+ * @param {object} params Event parameters
1182
+ * @param {object} params.event Event object
1183
+ * @param {Calendar.view.Calendar} params.event.source This Calendar instance.
1184
+ * @param {CalendarView} params.event.prevActiveItem The previously active view.
1185
+ * @param {CalendarView} params.event.activeItem The new active view.
1186
+ * @param {boolean} params.event.containedFocus `true` if the outgoing view contained focus.
1187
+ */
1188
+ (e: 'activeItemChange', params: ((event: { source: Calendar, prevActiveItem: CalendarView, activeItem: CalendarView, containedFocus: boolean }) => void)|string): void
1189
+ /**
1190
+ * Fires on the owning Scheduler after editor is closed by any action - save, delete or cancel
1191
+ * @param {string} e Event name
1192
+ * @param {object} params Event parameters
1193
+ * @param {object} params.event Event object
1194
+ * @param {Scheduler.view.Scheduler} params.event.source The scheduler
1195
+ * @param {'save','delete','cancel'} params.event.action The action that was taken to end the edit. One of 'save', 'delete' or 'cancel'
1196
+ * @param {Scheduler.feature.SchedulerEventEdit} params.event.eventEdit The eventEdit feature
1197
+ * @param {Scheduler.model.EventModel} params.event.eventRecord The record that has been edited.
1198
+ * @param {Scheduler.model.ResourceModel} params.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.
1199
+ * @param {HTMLElement} params.event.eventElement The element which represents the event in the scheduler display.
1200
+ * @param {Core.widget.Popup} params.event.editor The editor
1201
+ */
1202
+ (e: 'afterEventEdit', params: ((event: { source: Scheduler, action: 'save'|'delete'|'cancel', eventEdit: SchedulerEventEdit, eventRecord: EventModel, resourceRecord: ResourceModel, eventElement: HTMLElement, editor: Popup }) => void)|string): void
1203
+ /**
1204
+ * Fires on the owning Scheduler after an event is successfully saved
1205
+ * @param {string} e Event name
1206
+ * @param {object} params Event parameters
1207
+ * @param {object} params.event Event object
1208
+ * @param {Scheduler.view.Scheduler} params.event.source The scheduler instance
1209
+ * @param {Scheduler.model.EventModel} params.event.eventRecord The record about to be saved
1210
+ */
1211
+ (e: 'afterEventSave', params: ((event: { source: Scheduler, eventRecord: EventModel }) => void)|string): void
1212
+ /**
1213
+ * Fired before a change of view (Calendar mode) is initiated.
1214
+ * @param {string} e Event name
1215
+ * @param {object} params Event parameters
1216
+ * @param {object} params.event Event object
1217
+ * @param {Calendar.view.Calendar} params.event.source This Calendar instance.
1218
+ * @param {CalendarView} params.event.prevActiveItem The previously active view.
1219
+ * @param {CalendarView} params.event.activeItem The new active view.
1220
+ */
1221
+ (e: 'beforeActiveItemChange', params: ((event: { source: Calendar, prevActiveItem: CalendarView, activeItem: CalendarView }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1222
+ /**
1223
+ * Fires before an assignment is removed. Can be triggered by user pressing [DELETE] or [BACKSPACE] or
1224
+ * by the event editor. Can for example be used to display a custom dialog to confirm deletion, in which
1225
+ * case records should be "manually" removed after confirmation:
1226
+ * ...
1227
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#event-beforeAssignmentDelete)
1228
+ * @param {string} e Event name
1229
+ * @param {object} params Event parameters
1230
+ * @param {object} params.event Event object
1231
+ * @param {Scheduler.view.Scheduler} params.event.source The Scheduler instance
1232
+ * @param {Scheduler.model.AssignmentModel[]} params.event.assignmentRecords The assignment records about to be deleted
1233
+ * @param {object} params.event.context Additional removal context:
1234
+ * @param {Function} params.event.context.finalize Function to call to finalize the removal. Used to asynchronously decide to remove the records or not. Provide `false` to the function to prevent the removal.
1235
+ * @param {boolean} params.event.context.finalize.removeRecords Provide `false` to the function to prevent the removal.
1236
+ */
1237
+ (e: 'beforeAssignmentDelete', params: ((event: { source: Scheduler, assignmentRecords: AssignmentModel[], context: { finalize: { removeRecords?: boolean } } }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1238
+ /**
1239
+ * Fired any time there is going to be a change to the assignments selected in the Scheduler.
1240
+ * Returning `false` prevents the change
1241
+ * @param {string} e Event name
1242
+ * @param {object} params Event parameters
1243
+ * @param {object} params.event Event object
1244
+ * @param {Scheduler.view.Scheduler} params.event.source This Scheduler instance.
1245
+ * @param {'select','deselect','update','clear'} params.event.action One of the actions 'select', 'deselect', 'update', 'clear'
1246
+ * @param {Scheduler.model.AssignmentModel[]} params.event.selected An array of assignments that will be added to the selection.
1247
+ * @param {Scheduler.model.AssignmentModel[]} params.event.deselected An array of assignments that will be removed from the selection.
1248
+ * @param {Scheduler.model.AssignmentModel[]} params.event.selection The currently selected assignments, before applying `selected` and `deselected`.
1249
+ */
1250
+ (e: 'beforeAssignmentSelectionChange', params: ((event: { source: Scheduler, action: 'select'|'deselect'|'update'|'clear', selected: AssignmentModel[], deselected: AssignmentModel[], selection: AssignmentModel[] }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1251
+ /**
1252
+ * This event fires whenever a child view's [autoCreate gesture](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/CalendarMixin#config-autoCreate) is detected and also when a [drag-create](#Calendar/feature/CalendarDrag) gesture is detected.
1253
+ * ...
1254
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#event-beforeAutoCreate)
1255
+ * @param {string} e Event name
1256
+ * @param {object} params Event parameters
1257
+ * @param {object} params.event Event object
1258
+ * @param {CalendarView} params.event.source The child view on which the event was initiated.
1259
+ * @param {Event} params.event.domEvent The DOM event which initiated the creation.
1260
+ * @param {Date} params.event.date *DEPRECATED in favour of `startDate`.* The starting time of the event to be created. If this is in a `DayView`, this will be snapped according to the specification in [autoCreate](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/CalendarMixin#config-autoCreate)
1261
+ * @param {Date} params.event.startDate The starting time of the event to be created. If this is in a `DayView`, this will be snapped according to the specification in [autoCreate](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/CalendarMixin#config-autoCreate)
1262
+ * @param {Date} params.event.endDate The ending time of the event to be created.
1263
+ * @param {Scheduler.model.ResourceModel} params.event.resourceRecord The resource if the UI includes a resource.
1264
+ */
1265
+ (e: 'beforeAutoCreate', params: ((event: { source: CalendarView, domEvent: Event, date: Date, startDate: Date, endDate: Date, resourceRecord: ResourceModel }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1266
+ /**
1267
+ * Fires on the owning Scheduler before a copy action is performed, return `false` to prevent the action
1268
+ * @param {string} e Event name
1269
+ * @param {object} params Event parameters
1270
+ * @param {object} params.event Event object
1271
+ * @param {Scheduler.view.Scheduler} params.event.source Owner scheduler
1272
+ * @param {Scheduler.model.EventModel[]} params.event.eventRecords The event records about to be copied
1273
+ * @param {Scheduler.model.AssignmentModel[]} params.event.assignmentRecords The assignment records about to be copied
1274
+ * @param {boolean} params.event.isCut `true` if this is a cut action
1275
+ * @param {string} params.event.entityName 'event' to distinguish this event from other beforeCopy events
1276
+ */
1277
+ (e: 'beforeCopy', params: ((event: { source: Scheduler, eventRecords: EventModel[], assignmentRecords: AssignmentModel[], isCut: boolean, entityName: string }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1278
+ /**
1279
+ * Fires before a mode is created. The configuration block is passed to the handler for possible modification.
1280
+ * @param {string} e Event name
1281
+ * @param {object} params Event parameters
1282
+ * @param {object} params.event Event object
1283
+ * @param {Calendar.view.Calendar} params.event.source This Calendar
1284
+ * @param {AgendaViewConfig,DayResourceViewConfig,DayViewConfig,EventListConfig,MonthViewConfig,ResourceViewConfig,WeekViewConfig,YearViewConfig,DayAgendaViewConfig,MonthAgendaViewConfig,ContainerItemConfig} params.event.config The configuration block of the mode about to be created. Any property, including the `type` may be changed.
1285
+ */
1286
+ (e: 'beforeCreateMode', params: ((event: { source: Calendar, config: AgendaViewConfig|DayResourceViewConfig|DayViewConfig|EventListConfig|MonthViewConfig|ResourceViewConfig|WeekViewConfig|YearViewConfig|DayAgendaViewConfig|MonthAgendaViewConfig|ContainerItemConfig }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1287
+ /**
1288
+ * Fires on the owning Grid before CSV export starts. Return `false` to cancel the export.
1289
+ * @param {string} e Event name
1290
+ * @param {object} params Event parameters
1291
+ * @param {object} params.event Event object
1292
+ * @param {ExportConfig} params.event.config Export config
1293
+ * @param {Grid.column.Column[]} params.event.columns An array of columns to export
1294
+ * @param {Core.data.Model[]} params.event.rows An array of records to export
1295
+ * @param {string} params.event.lineDelimiter The CSV delimiter to separate lines
1296
+ * @param {string} params.event.columnDelimiter The CSV delimiter to separate values on one line
1297
+ */
1298
+ (e: 'beforeCSVExport', params: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1299
+ /**
1300
+ * Fires before an object is destroyed.
1301
+ * @param {string} e Event name
1302
+ * @param {object} params Event parameters
1303
+ * @param {object} params.event Event object
1304
+ * @param {Core.Base} params.event.source The Object that is being destroyed.
1305
+ */
1306
+ (e: 'beforeDestroy', params: ((event: { source: Base }) => void)|string): void
1307
+ /**
1308
+ * This event fires on the owning Calendar before a drag creation gesture is started. Return `false` to
1309
+ * veto the operation.
1310
+ * @param {string} e Event name
1311
+ * @param {object} params Event parameters
1312
+ * @param {object} params.event Event object
1313
+ * @param {Calendar.view.Calendar} params.event.source The Calendar instance that fired the event.
1314
+ * @param {Core.util.drag.DragContext} params.event.drag The drag create context.
1315
+ * @param {Event} params.event.domEvent The browser event.
1316
+ * @param {Date} params.event.date The date at the drag DOM event position.
1317
+ * @param {Scheduler.model.ResourceModel} params.event.resourceRecord The `ResourceModel` record if the gesture was performed in a resource-type view.
1318
+ * @param {Calendar.feature.CalendarDrag} params.event.feature The Calendar drag feature instance.
1319
+ * @param {CalendarView} params.event.view The Calendar widget in which the drag is being started.
1320
+ */
1321
+ (e: 'beforeDragCreate', params: ((event: { source: Calendar, drag: DragContext, domEvent: Event, date: Date, resourceRecord?: ResourceModel, feature: CalendarDrag, view: CalendarView }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1322
+ /**
1323
+ * This event fires on the owning Calendar before a drag creation gesture is completed. Return `false` to
1324
+ * immediately veto the operation or a Promise yielding `true` or `false` for async vetoing.
1325
+ * @param {string} e Event name
1326
+ * @param {object} params Event parameters
1327
+ * @param {object} params.event Event object
1328
+ * @param {Calendar.view.Calendar} params.event.source The Calendar instance that fired the event.
1329
+ * @param {Core.util.drag.DragContext} params.event.drag The drag create context.
1330
+ * @param {Event} params.event.event The browser event.
1331
+ * @param {Scheduler.model.EventModel} params.event.eventRecord The `EventModel` record being created that has not yet been added in the store.
1332
+ * @param {Date} params.event.newStartDate The new start date.
1333
+ * @param {Date} params.event.newEndDate The new end date.
1334
+ * @param {Scheduler.model.ResourceModel} params.event.resourceRecord The `ResourceModel` record if the gesture was performed in a resource-type view.
1335
+ * @param {Calendar.feature.CalendarDrag} params.event.feature The Calendar drag feature instance.
1336
+ * @param {boolean,ValidateCreateResult} params.event.validation The result of the [validateCreateFn](https://bryntum.com/products/calendar/docs/api/Calendar/feature/CalendarDrag#config-validateCreateFn) if one was provided.
1337
+ * @param {CalendarView} params.event.view The Calendar widget in which the drag completed.
1338
+ */
1339
+ (e: 'beforeDragCreateEnd', params: ((event: { source: Calendar, drag: DragContext, event: Event, eventRecord: EventModel, newStartDate: Date, newEndDate: Date, resourceRecord?: ResourceModel, feature: CalendarDrag, validation: boolean|ValidateCreateResult, view: CalendarView }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1340
+ /**
1341
+ * This event fires on the owning Calendar before a drag move gesture is started. Return `false` to
1342
+ * veto the operation.
1343
+ * @param {string} e Event name
1344
+ * @param {object} params Event parameters
1345
+ * @param {object} params.event Event object
1346
+ * @param {Calendar.view.Calendar} params.event.source The Calendar instance that fired the event.
1347
+ * @param {Core.util.drag.DragContext} params.event.drag The drag move context.
1348
+ * @param {Event} params.event.domEvent The browser event.
1349
+ * @param {Scheduler.model.EventModel} params.event.eventRecord The `EventModel` record being moved.
1350
+ * @param {Date} params.event.date The date at the drag DOM event position.
1351
+ * @param {Scheduler.model.ResourceModel} params.event.resourceRecord The `ResourceModel` record if the gesture was performed in a resource-type view.
1352
+ * @param {Calendar.feature.CalendarDrag} params.event.feature The Calendar drag feature instance.
1353
+ * @param {CalendarView} params.event.view The Calendar widget in which the drag is being started.
1354
+ */
1355
+ (e: 'beforeDragMove', params: ((event: { source: Calendar, drag: DragContext, domEvent: Event, eventRecord: EventModel, date: Date, resourceRecord?: ResourceModel, feature: CalendarDrag, view: CalendarView }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1356
+ /**
1357
+ * This event fires on the owning Calendar before a drag move gesture is completed. Return `false` to immediately veto the operation
1358
+ * or a Promise yielding `true` or `false` for async vetoing.
1359
+ * @param {string} e Event name
1360
+ * @param {object} params Event parameters
1361
+ * @param {object} params.event Event object
1362
+ * @param {Calendar.view.Calendar} params.event.source The Calendar instance that fired the event.
1363
+ * @param {Core.util.drag.DragContext} params.event.drag The drag create context.
1364
+ * @param {Event} params.event.event The browser event.
1365
+ * @param {Scheduler.model.EventModel} params.event.eventRecord The `EventModel` record that has *not yet been updated* in the store.
1366
+ * @param {Scheduler.model.EventModel} params.event.proxyEventRecord The `EventModel` record that is being used as a proxy for the drag operation and being updated on every pointer move. This will contain changed values based on the drag position.
1367
+ * @param {Date} params.event.newStartDate The new start date.
1368
+ * @param {Date} params.event.newEndDate The new end date.
1369
+ * @param {Scheduler.model.ResourceModel} params.event.resourceRecord The `ResourceModel` record if the gesture was performed in a resource-type view.
1370
+ * @param {Calendar.feature.CalendarDrag} params.event.feature The Calendar drag feature instance.
1371
+ * @param {boolean,ValidateCreateResult} params.event.validation The result of the [validateMoveFn](https://bryntum.com/products/calendar/docs/api/Calendar/feature/CalendarDrag#config-validateMoveFn) if one was provided.
1372
+ * @param {CalendarView} params.event.view The Calendar widget in which the drag completed.
1373
+ */
1374
+ (e: 'beforeDragMoveEnd', params: ((event: { source: Calendar, drag: DragContext, event: Event, eventRecord: EventModel, proxyEventRecord: EventModel, newStartDate: Date, newEndDate: Date, resourceRecord?: ResourceModel, feature: CalendarDrag, validation: boolean|ValidateCreateResult, view: CalendarView }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1375
+ /**
1376
+ * This event fires on the owning Calendar before a drag resize gesture is started. Return `false` to
1377
+ * veto the operation.
1378
+ * @param {string} e Event name
1379
+ * @param {object} params Event parameters
1380
+ * @param {object} params.event Event object
1381
+ * @param {Calendar.view.Calendar} params.event.source The Calendar instance that fired the event.
1382
+ * @param {Core.util.drag.DragContext} params.event.drag The drag resize context.
1383
+ * @param {Event} params.event.domEvent The browser event.
1384
+ * @param {Scheduler.model.EventModel} params.event.eventRecord The `EventModel` record being resized.
1385
+ * @param {Date} params.event.date The date at the drag DOM event position.
1386
+ * @param {Scheduler.model.ResourceModel} params.event.resourceRecord The `ResourceModel` record if the gesture was performed in a resource-type view.
1387
+ * @param {Calendar.feature.CalendarDrag} params.event.feature The Calendar drag feature instance.
1388
+ * @param {CalendarView} params.event.view The Calendar widget in which the drag is being started.
1389
+ */
1390
+ (e: 'beforeDragResize', params: ((event: { source: Calendar, drag: DragContext, domEvent: Event, eventRecord: EventModel, date: Date, resourceRecord?: ResourceModel, feature: CalendarDrag, view: CalendarView }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1391
+ /**
1392
+ * This event fires on the owning Calendar before a drag resize gesture is completed. Return `false` to immediately veto the operation
1393
+ * or a Promise yielding `true` or `false` for async vetoing.
1394
+ * @param {string} e Event name
1395
+ * @param {object} params Event parameters
1396
+ * @param {object} params.event Event object
1397
+ * @param {Calendar.view.Calendar} params.event.source The Calendar instance that fired the event.
1398
+ * @param {Core.util.drag.DragContext} params.event.drag The drag create context.
1399
+ * @param {Event} params.event.event The browser event.
1400
+ * @param {Scheduler.model.EventModel} params.event.eventRecord The `EventModel` record that has *not yet been updated* in the store.
1401
+ * @param {Scheduler.model.EventModel} params.event.proxyEventRecord The `EventModel` record that is being used as a proxy for the drag operation and being updated on every pointer move. This will contain changed values based on the drag position.
1402
+ * @param {Date} params.event.newStartDate The new start date.
1403
+ * @param {Date} params.event.newEndDate The new end date.
1404
+ * @param {Calendar.feature.CalendarDrag} params.event.feature The Calendar drag feature instance.
1405
+ * @param {boolean,ValidateCreateResult} params.event.validation The result of the [validateResizeFn](https://bryntum.com/products/calendar/docs/api/Calendar/feature/CalendarDrag#config-validateResizeFn) if one was provided.
1406
+ * @param {CalendarView} params.event.view The Calendar widget in which the drag completed.
1407
+ */
1408
+ (e: 'beforeDragResizeEnd', params: ((event: { source: Calendar, drag: DragContext, event: Event, eventRecord: EventModel, proxyEventRecord: EventModel, newStartDate: Date, newEndDate: Date, feature: CalendarDrag, validation: boolean|ValidateCreateResult, view: CalendarView }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1409
+ /**
1410
+ * This event is fired on the owning Calendar when dropping an event from the calendar on the
1411
+ * external source <strong>if the [droppable](https://bryntum.com/products/calendar/docs/api/Calendar/feature/ExternalEventSource#config-droppable) was configured</strong>. Returning `false`
1412
+ * prevents the gesture from being completed.
1413
+ * ...
1414
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#event-beforeDropExternal)
1415
+ * @param {string} e Event name
1416
+ * @param {object} params Event parameters
1417
+ * @param {object} params.event Event object
1418
+ * @param {Scheduler.model.EventModel} params.event.eventRecord The event record being dragged.
1419
+ * @param {boolean} params.event.dropOnCalendar `true` if the drop gesture is over the client Calendar. This feature also allows drag *out* of the Calendar and onto the external event source if the [droppable](https://bryntum.com/products/calendar/docs/api/Calendar/feature/ExternalEventSource#config-droppable) config is set.
1420
+ * @param {HTMLElement} params.event.itemElement The element in which the drag gesture started.
1421
+ * @param {HTMLElement} params.event.targetElement The current over element.
1422
+ * @param {Event} params.event.domEvent The pointer event associated with the drag point.
1423
+ * @param {number} params.event.overIndex *If [grid](https://bryntum.com/products/calendar/docs/api/Calendar/feature/ExternalEventSource#config-grid) was specified*, the index of the row being moved over;
1424
+ * @param {Core.data.Model} params.event.overRecord *If [grid](https://bryntum.com/products/calendar/docs/api/Calendar/feature/ExternalEventSource#config-grid) was specified*, the record being moved over;
1425
+ * @param {boolean} params.event.isAbove *If [grid](https://bryntum.com/products/calendar/docs/api/Calendar/feature/ExternalEventSource#config-grid) was specified*, `true` if the pointer position is above the halfway line of the over row.
1426
+ * @param {boolean} params.event.altKey `true` if the Alt key was down when the last event was processed.
1427
+ * @param {boolean} params.event.ctrlKey `true` if the Ctrl key was down when the last event was processed.
1428
+ * @param {boolean} params.event.metaKey `true` if the Meta key was down when the last event was processed.
1429
+ * @param {boolean} params.event.shiftKey `true` if the Shift key was down when the last event was processed.
1430
+ */
1431
+ (e: 'beforeDropExternal', params: ((event: { eventRecord: EventModel, dropOnCalendar: boolean, itemElement: HTMLElement, targetElement: HTMLElement, domEvent: Event, overIndex: number, overRecord: Model, isAbove: boolean, altKey: boolean, ctrlKey: boolean, metaKey: boolean, shiftKey: boolean }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1432
+ /**
1433
+ * Fires before an event is removed. Can be triggered by user pressing [DELETE] or [BACKSPACE] or by the
1434
+ * event editor. Can for example be used to display a custom dialog to confirm deletion, in which case
1435
+ * records should be "manually" removed after confirmation:
1436
+ * ...
1437
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#event-beforeEventDelete)
1438
+ * @param {string} e Event name
1439
+ * @param {object} params Event parameters
1440
+ * @param {object} params.event Event object
1441
+ * @param {Calendar.view.Calendar} params.event.source The Calendar instance
1442
+ * @param {Scheduler.model.EventModel[]} params.event.eventRecords The records about to be deleted
1443
+ * @param {object} params.event.context Additional removal context:
1444
+ * @param {Function} params.event.context.finalize Function to call to finalize the removal. Used to asynchronously decide to remove the records or not. Provide `false` to the function to prevent the removal.
1445
+ * @param {boolean} params.event.context.finalize.removeRecords Provide `false` to the function to prevent the removal.
1446
+ */
1447
+ (e: 'beforeEventDelete', params: ((event: { source: Calendar, eventRecords: EventModel[], context: { finalize: { removeRecords?: boolean } } }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1448
+ /**
1449
+ * Fires on the owning Scheduler before an event is displayed in an editor.
1450
+ * This may be listened for to allow an application to take over event editing duties. Returning `false`
1451
+ * stops the default editing UI from being shown.
1452
+ * ...
1453
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#event-beforeEventEdit)
1454
+ * @param {string} e Event name
1455
+ * @param {object} params Event parameters
1456
+ * @param {object} params.event Event object
1457
+ * @param {Scheduler.view.Scheduler} params.event.source The scheduler
1458
+ * @param {Scheduler.feature.SchedulerEventEdit} params.event.eventEdit The eventEdit feature
1459
+ * @param {Scheduler.model.EventModel} params.event.eventRecord The record about to be shown in the event editor.
1460
+ * @param {Scheduler.model.ResourceModel} params.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.
1461
+ * @param {HTMLElement} params.event.eventElement The element which represents the event in the scheduler display.
1462
+ */
1463
+ (e: 'beforeEventEdit', params: ((event: { source: Scheduler, eventEdit: SchedulerEventEdit, eventRecord: EventModel, resourceRecord: ResourceModel, eventElement: HTMLElement }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1464
+ /**
1465
+ * Fires on the owning Scheduler when the editor for an event is available but before it is populated with
1466
+ * data and shown. Allows manipulating fields etc.
1467
+ * @param {string} e Event name
1468
+ * @param {object} params Event parameters
1469
+ * @param {object} params.event Event object
1470
+ * @param {Scheduler.view.Scheduler} params.event.source The scheduler
1471
+ * @param {Scheduler.feature.SchedulerEventEdit} params.event.eventEdit The eventEdit feature
1472
+ * @param {Scheduler.model.EventModel} params.event.eventRecord The record about to be shown in the event editor.
1473
+ * @param {Scheduler.model.ResourceModel} params.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.
1474
+ * @param {HTMLElement} params.event.eventElement The element which represents the event in the scheduler display.
1475
+ * @param {Core.widget.Popup} params.event.editor The editor
1476
+ */
1477
+ (e: 'beforeEventEditShow', params: ((event: { source: Scheduler, eventEdit: SchedulerEventEdit, eventRecord: EventModel, resourceRecord: ResourceModel, eventElement: HTMLElement, editor: Popup }) => void)|string): void
1478
+ /**
1479
+ * Fires on the owning Scheduler before an event is saved.
1480
+ * Return `false` to immediately prevent saving
1481
+ * ...
1482
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#event-beforeEventSave)
1483
+ * @param {string} e Event name
1484
+ * @param {object} params Event parameters
1485
+ * @param {object} params.event Event object
1486
+ * @param {Scheduler.view.Scheduler} params.event.source The scheduler instance
1487
+ * @param {Scheduler.model.EventModel} params.event.eventRecord The record about to be saved
1488
+ * @param {Scheduler.model.ResourceModel[]} params.event.resourceRecords The resources to which the event is assigned
1489
+ * @param {object} params.event.values The new values
1490
+ * @param {object} params.event.context Extended save context:
1491
+ * @param {boolean} params.event.context.async Set this to `true` in a listener to indicate that the listener will asynchronously decide to prevent or not the event save.
1492
+ * @param {Function} params.event.context.finalize Function to call to finalize the save. Used when `async` is `true`. Provide `false` to the function to prevent the save.
1493
+ */
1494
+ (e: 'beforeEventSave', params: ((event: { source: Scheduler, eventRecord: EventModel, resourceRecords: ResourceModel[], values: object, context: { async?: boolean, finalize: Function } }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1495
+ /**
1496
+ * Fired any time there is going to be a change to the events selected in the Scheduler.
1497
+ * Returning `false` prevents the change
1498
+ * @param {string} e Event name
1499
+ * @param {object} params Event parameters
1500
+ * @param {object} params.event Event object
1501
+ * @param {Scheduler.view.Scheduler} params.event.source This Scheduler instance.
1502
+ * @param {'select','deselect','update','clear'} params.event.action One of the actions 'select', 'deselect', 'update', 'clear'
1503
+ * @param {Scheduler.model.EventModel[]} params.event.selected An array of events that will be added to the selection.
1504
+ * @param {Scheduler.model.EventModel[]} params.event.deselected An array of events that will be removed from the selection.
1505
+ * @param {Scheduler.model.EventModel[]} params.event.selection The currently selected events, before applying `selected` and `deselected`.
1506
+ */
1507
+ (e: 'beforeEventSelectionChange', params: ((event: { source: Scheduler, action: 'select'|'deselect'|'update'|'clear', selected: EventModel[], deselected: EventModel[], selection: EventModel[] }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1508
+ /**
1509
+ * Fires on the owning Grid before Excel export starts. Return `false` to cancel the export.
1510
+ * @param {string} e Event name
1511
+ * @param {object} params Event parameters
1512
+ * @param {object} params.event Event object
1513
+ * @param {ExportConfig} params.event.config Export config
1514
+ * @param {XLSColumn[]} params.event.columns An array of columns to export
1515
+ * @param {any[][]} params.event.rows An array of records to export
1516
+ */
1517
+ (e: 'beforeExcelExport', params: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1518
+ /**
1519
+ * Triggered before a widget is hidden. Return `false` to prevent the action.
1520
+ * @param {string} e Event name
1521
+ * @param {object} params Event parameters
1522
+ * @param {object} params.event Event object
1523
+ * @param {Core.widget.Widget} params.event.source The widget being hidden.
1524
+ */
1525
+ (e: 'beforeHide', params: ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1526
+ /**
1527
+ * Fires on the owning Scheduler before a paste action is performed, return `false` to prevent the action.
1528
+ * Depending on if the EventStore is using [singleAssignment](https://bryntum.com/products/calendar/docs/api/Scheduler/data/EventStore#config-singleAssignment) or the
1529
+ * configuration of [copyPasteAction](https://bryntum.com/products/calendar/docs/api/Scheduler/feature/EventCopyPaste#config-copyPasteAction), either the `eventRecords` or the `assignmentRecords` param
1530
+ * will be populated with record copies.
1531
+ * @param {string} e Event name
1532
+ * @param {object} params Event parameters
1533
+ * @param {object} params.event Event object
1534
+ * @param {Scheduler.view.Scheduler} params.event.source Owner scheduler
1535
+ * @param {Scheduler.model.EventModel[]} params.event.eventRecords The events about to be pasted
1536
+ * @param {Scheduler.model.AssignmentModel[]} params.event.assignmentRecords The assignments about to be pasted
1537
+ * @param {Scheduler.model.EventModel[]} params.event.originalEventRecords The original event records
1538
+ * @param {Scheduler.model.AssignmentModel[]} params.event.originalAssignmentRecords The original assignment record
1539
+ * @param {Date} params.event.date The date when the pasted events will be scheduled
1540
+ * @param {Scheduler.model.ResourceModel} params.event.resourceRecord The target resource record, the clipboard event records will be assigned to this resource.
1541
+ * @param {boolean} params.event.isCut `true` if this is a cut action
1542
+ * @param {string} params.event.entityName 'event' to distinguish this event from other beforePaste events
1543
+ */
1544
+ (e: 'beforePaste', params: ((event: { source: Scheduler, eventRecords: EventModel[], assignmentRecords: AssignmentModel[], originalEventRecords: EventModel[], originalAssignmentRecords: AssignmentModel[], date: Date, resourceRecord: ResourceModel, isCut: boolean, entityName: string }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1545
+ /**
1546
+ * Fires on the owning Calendar before print starts. Return `false` to cancel the print.
1547
+ * @param {string} e Event name
1548
+ * @param {object} params Event parameters
1549
+ * @param {object} params.event Event object
1550
+ * @param {object} params.event.config Print config
1551
+ */
1552
+ (e: 'beforePrint', params: ((event: { config: object }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1553
+ /**
1554
+ * Triggered before a new [responsiveState](https://bryntum.com/products/calendar/docs/api/Core/widget/mixin/Responsive#config-responsiveState) is applied.
1555
+ * @param {string} e Event name
1556
+ * @param {object} params Event parameters
1557
+ * @param {object} params.event Event object
1558
+ * @param {Core.widget.Widget} params.event.source The widget whose `responsiveState` is to be changed
1559
+ * @param {string} params.event.state The new value for the widget's `responsiveState`
1560
+ * @param {string} params.event.oldState The previous value for the widget's `responsiveState`
1561
+ */
1562
+ (e: 'beforeResponsiveStateChange', params: ((event: { source: Widget, state: string, oldState: string }) => void)|string): void
1563
+ /**
1564
+ * Fired before this container will load record values into its child fields. This is useful if you
1565
+ * want to modify the UI before data is loaded (e.g. set some input field to be readonly)
1566
+ * @param {string} e Event name
1567
+ * @param {object} params Event parameters
1568
+ * @param {object} params.event Event object
1569
+ * @param {Core.widget.Container} params.event.source The container
1570
+ * @param {Core.data.Model} params.event.record The record
1571
+ */
1572
+ (e: 'beforeSetRecord', params: ((event: { source: Container, record: Model }) => void)|string): void
1573
+ /**
1574
+ * Triggered before a widget is shown. Return `false` to prevent the action.
1575
+ * @param {string} e Event name
1576
+ * @param {object} params Event parameters
1577
+ * @param {object} params.event Event object
1578
+ * @param {Core.widget.Widget,any} params.event.source The widget being shown
1579
+ */
1580
+ (e: 'beforeShow', params: ((event: { source: Widget|any }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1581
+ /**
1582
+ * Fired before state is applied to the source. Allows editing the state object or preventing the operation.
1583
+ * @param {string} e Event name
1584
+ * @param {object} params Event parameters
1585
+ * @param {object} params.event Event object
1586
+ * @param {any} params.event.state State object config
1587
+ */
1588
+ (e: 'beforeStateApply', params: ((event: { state: any }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1589
+ /**
1590
+ * Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
1591
+ * @param {string} e Event name
1592
+ * @param {object} params Event parameters
1593
+ * @param {object} params.event Event object
1594
+ * @param {any} params.event.state State object config
1595
+ */
1596
+ (e: 'beforeStateSave', params: ((event: { state: any }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1597
+ /**
1598
+ * Fires when any other event is fired from the object.
1599
+ * ...
1600
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#event-catchAll)
1601
+ * @param {string} e Event name
1602
+ * @param {object} params Event parameters
1603
+ * @param {object} params.event Event object
1604
+ * @param {{[key: string]: any, type: string}} params.event.event The Object that contains event details
1605
+ * @param {string} params.event.event.type The type of the event which is caught by the listener
1606
+ */
1607
+ (e: 'catchAll', params: ((event: {[key: string]: any, type: string}) => void)|string): void
1608
+ /**
1609
+ * Fires when a cell overflow indicator is clicked or activated by the <kbd>ENTER</kbd> key in any view. This will include
1610
+ * the cells of a [YearView](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView) and the `+ n more` overflow
1611
+ * indicator of cells in a [MonthView](https://bryntum.com/products/calendar/docs/api/Calendar/widget/MonthView), and "all day" events section
1612
+ * of a [DayView](https://bryntum.com/products/calendar/docs/api/Calendar/widget/DayView).
1613
+ * @param {string} e Event name
1614
+ * @param {object} params Event parameters
1615
+ * @param {object} params.event Event object
1616
+ * @param {CalendarView} params.event.source The view which triggered the event.
1617
+ * @param {Event} params.event.domEvent The initiating DOM event.
1618
+ * @param {Date} params.event.date The date clicked on.
1619
+ */
1620
+ (e: 'cellOverflowClick', params: ((event: { source: CalendarView, domEvent: Event, date: Date }) => void)|string): void
1621
+ /**
1622
+ * Fires when a Panel is collapsed using the [collapsible](https://bryntum.com/products/calendar/docs/api/Core/widget/Panel#config-collapsible) setting.
1623
+ * @param {string} e Event name
1624
+ * @param {object} params Event parameters
1625
+ * @param {object} params.event Event object
1626
+ * @param {Core.widget.Panel} params.event.source This Panel.
1627
+ */
1628
+ (e: 'collapse', params: ((event: { source: Panel }) => void)|string): void
1629
+ /**
1630
+ * This event fires on the owning widget when an item is selected in the context menu.
1631
+ * @param {string} e Event name
1632
+ * @param {object} params Event parameters
1633
+ * @param {object} params.event Event object
1634
+ * @param {Core.widget.Widget} params.event.source The owning widget
1635
+ * @param {Core.widget.Menu} params.event.menu The menu
1636
+ * @param {Core.widget.MenuItem} params.event.item Selected menu item
1637
+ */
1638
+ (e: 'contextMenuItem', params: ((event: { source: Widget, menu: Menu, item: MenuItem }) => void)|string): void
1639
+ /**
1640
+ * This event fires on the owning widget when a check item is toggled in the context menu.
1641
+ * @param {string} e Event name
1642
+ * @param {object} params Event parameters
1643
+ * @param {object} params.event Event object
1644
+ * @param {Core.widget.Widget} params.event.source The owning widget
1645
+ * @param {Core.widget.Menu} params.event.menu The menu
1646
+ * @param {Core.widget.MenuItem} params.event.item Selected menu item
1647
+ * @param {boolean} params.event.checked Checked or not
1648
+ */
1649
+ (e: 'contextMenuToggleItem', params: ((event: { source: Widget, menu: Menu, item: MenuItem, checked: boolean }) => void)|string): void
1650
+ /**
1651
+ * Fires on the owning Scheduler after a copy action is performed. Depending on if the EventStore is using
1652
+ * [singleAssignment](https://bryntum.com/products/calendar/docs/api/Scheduler/data/EventStore#config-singleAssignment) or the configuration of
1653
+ * [copyPasteAction](https://bryntum.com/products/calendar/docs/api/Scheduler/feature/EventCopyPaste#config-copyPasteAction), either the `eventRecords` or the `assignmentRecords` param will be populated
1654
+ * with record copies.
1655
+ * @param {string} e Event name
1656
+ * @param {object} params Event parameters
1657
+ * @param {object} params.event Event object
1658
+ * @param {Scheduler.view.Scheduler} params.event.source Owner scheduler
1659
+ * @param {Scheduler.model.EventModel[]} params.event.eventRecords The event record copies
1660
+ * @param {Scheduler.model.AssignmentModel[]} params.event.assignmentRecords The assignment record copies
1661
+ * @param {Scheduler.model.EventModel[]} params.event.originalEventRecords The event records that were copied
1662
+ * @param {Scheduler.model.AssignmentModel[]} params.event.originalAssignmentRecord The assignment records that were copied
1663
+ * @param {boolean} params.event.isCut `true` if this is a cut action
1664
+ * @param {string} params.event.entityName 'event' to distinguish this event from other copy events
1665
+ */
1666
+ (e: 'copy', params: ((event: { source: Scheduler, eventRecords: EventModel[], assignmentRecords: AssignmentModel[], originalEventRecords: EventModel[], originalAssignmentRecord: AssignmentModel[], isCut: boolean, entityName: string }) => void)|string): void
1667
+ /**
1668
+ * Fires on the owning Scheduler/Gantt when the line indicating the current time is updated (see [currentTimeLineUpdateInterval](https://bryntum.com/products/calendar/docs/api/Scheduler/feature/TimeRanges#config-currentTimeLineUpdateInterval)).
1669
+ * @param {string} e Event name
1670
+ * @param {object} params Event parameters
1671
+ * @param {object} params.event Event object
1672
+ * @param {Scheduler.view.Scheduler} params.event.source The scheduler
1673
+ * @param {Date} params.event.date The current date
1674
+ */
1675
+ (e: 'currentTimelineUpdate', params: ((event: { source: Scheduler, date: Date }) => void)|string): void
1676
+ /**
1677
+ * Fired when data in any of the projects stores changes.
1678
+ * ...
1679
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#event-dataChange)
1680
+ * @param {string} e Event name
1681
+ * @param {object} params Event parameters
1682
+ * @param {object} params.event Event object
1683
+ * @param {typeof Scheduler.data.mixin.ProjectConsumer,any} params.event.source Owning component
1684
+ * @param {typeof Scheduler.model.mixin.ProjectModelMixin,any} params.event.project Project model
1685
+ * @param {Core.data.Store} params.event.store Affected store
1686
+ * @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} params.event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
1687
+ * @param {Core.data.Model} params.event.record Changed record, for actions that affects exactly one record (`'update'`)
1688
+ * @param {Core.data.Model[]} params.event.records Changed records, passed for all actions except `'removeAll'`
1689
+ * @param {object} params.event.changes Passed for the `'update'` action, info on which record fields changed
1690
+ */
1691
+ (e: 'dataChange', params: ((event: { source: typeof ProjectConsumer|any, project: typeof ProjectModelMixin|any, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string): void
1692
+ /**
1693
+ * Fires when the calendar changes the date that it orientates its views around.
1694
+ * ...
1695
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#event-dateChange)
1696
+ * @param {string} e Event name
1697
+ * @param {object} params Event parameters
1698
+ * @param {object} params.event Event object
1699
+ * @param {Calendar.view.Calendar} params.event.source This Calendar.
1700
+ * @param {Date} params.event.oldDate The previous Calendar date.
1701
+ * @param {Date} params.event.date The new Calendar date.
1702
+ */
1703
+ (e: 'dateChange', params: ((event: { source: Calendar, oldDate: Date, date: Date }) => void)|string): void
1704
+ /**
1705
+ * Fired when the eventStore is queried for events by date range, and the date range
1706
+ * requested is different from the last time the store was queried.
1707
+ * ...
1708
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#event-dateRangeChange)
1709
+ * @param {string} e Event name
1710
+ * @param {object} params Event parameters
1711
+ * @param {object} params.event Event object
1712
+ * @param {Calendar.view.Calendar} params.event.source This Calendar instance
1713
+ * @param {object} params.event.old The old date range
1714
+ * @param {Date} params.event.old.startDate the old start date
1715
+ * @param {Date} params.event.old.endDate the old end date
1716
+ * @param {object} params.event.new The new date range
1717
+ * @param {Date} params.event.new.startDate the new start date
1718
+ * @param {Date} params.event.new.endDate the new end date
1719
+ */
1720
+ (e: 'dateRangeChange', params: ((event: { source: Calendar, old: { startDate: Date, endDate: Date }, new: { startDate: Date, endDate: Date } }) => void)|string): void
1721
+ /**
1722
+ * Fires when the [LoadOnDemand](https://bryntum.com/products/calendar/docs/api/Calendar/feature/LoadOnDemand) feature has loaded a range of events.
1723
+ * @param {string} e Event name
1724
+ * @param {object} params Event parameters
1725
+ * @param {object} params.event Event object
1726
+ * @param {object} params.event.response The decoded JSON response.
1727
+ * @param {object} params.event.options The options object passed into the CrudManager [CrudManager](https://bryntum.com/products/calendar/docs/api/Scheduler/data/CrudManager) [load](https://bryntum.com/products/calendar/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) method.
1728
+ * @param {Date} params.event.startDate The start date of the range to request.
1729
+ * @param {Date} params.event.endDate The end date of the range to request. <strong>Note that Dates are timestamps</strong>.
1730
+ */
1731
+ (e: 'dateRangeLoad', params: ((event: { response: object, options: object, startDate: Date, endDate: Date }) => void)|string): void
1732
+ /**
1733
+ * Fired <strong>every</strong> time the eventStore is queried for events by date range.
1734
+ * ...
1735
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#event-dateRangeRequested)
1736
+ * @param {string} e Event name
1737
+ * @param {object} params Event parameters
1738
+ * @param {object} params.event Event object
1739
+ * @param {Calendar.view.Calendar} params.event.source This Calendar instance
1740
+ * @param {object} params.event.old The old date range
1741
+ * @param {Date} params.event.old.startDate the old start date
1742
+ * @param {Date} params.event.old.endDate the old end date
1743
+ * @param {object} params.event.new The new date range
1744
+ * @param {Date} params.event.new.startDate the new start date
1745
+ * @param {Date} params.event.new.endDate the new end date
1746
+ * @param {boolean} params.event.changed `true` if the date range is different from the last time a request was made
1747
+ */
1748
+ (e: 'dateRangeRequested', params: ((event: { source: Calendar, old: { startDate: Date, endDate: Date }, new: { startDate: Date, endDate: Date }, changed: boolean }) => void)|string): void
1749
+ /**
1750
+ * Fired by the active view after one day cell's events are collected in sorted order according to the
1751
+ * [eventSorter](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/CalendarMixin#config-eventSorter)
1752
+ * ...
1753
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#event-dayCellPopulated)
1754
+ * @param {string} e Event name
1755
+ * @param {object} params Event parameters
1756
+ * @param {object} params.event Event object
1757
+ * @param {CalendarView} params.event.source The view which triggered the event.
1758
+ * @param {Scheduler.model.EventModel[]} params.event.events The events to be shown for the passed date
1759
+ * @param {Date} params.event.The date the events are to be shown in.
1760
+ */
1761
+ (e: 'dayCellPopulated', params: ((event: { source: CalendarView, events: EventModel[], The: Date }) => void)|string): void
1762
+ /**
1763
+ * Fires when a day number is clicked or activated by the <kbd>ENTER</kbd> key in a view which shows day numbers.
1764
+ * This will include the cells of a [YearView](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView), the cell header of cells
1765
+ * in a [MonthView](https://bryntum.com/products/calendar/docs/api/Calendar/widget/MonthView), and the day header in a [DayView](#Calendar/widget/DayView).
1766
+ * ...
1767
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#event-dayNumberClick)
1768
+ * @param {string} e Event name
1769
+ * @param {object} params Event parameters
1770
+ * @param {object} params.event Event object
1771
+ * @param {CalendarView} params.event.source The view which triggered the event.
1772
+ * @param {Event} params.event.domEvent The initiating DOM event.
1773
+ * @param {Date} params.event.date The date clicked on.
1774
+ * @param {DayCell} params.event.cellData An object that contains data about the calendar cell for the date.
1775
+ * @param {boolean} params.event.fromOverflowPopup `true` if the interaction was through the source view's [overflowPopup](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/DayCellRenderer#property-overflowPopup).
1776
+ */
1777
+ (e: 'dayNumberClick', params: ((event: { source: CalendarView, domEvent: Event, date: Date, cellData: DayCell, fromOverflowPopup: boolean }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1778
+ /**
1779
+ * Fires when an object is destroyed.
1780
+ * @param {string} e Event name
1781
+ * @param {object} params Event parameters
1782
+ * @param {object} params.event Event object
1783
+ * @param {Core.Base} params.event.source The Object that is being destroyed.
1784
+ */
1785
+ (e: 'destroy', params: ((event: { source: Base }) => void)|string): void
1786
+ /**
1787
+ * Fires when a field is mutated and the state of the [hasChanges](https://bryntum.com/products/calendar/docs/api/Core/widget/Container#property-hasChanges) property changes
1788
+ * @param {string} e Event name
1789
+ * @param {object} params Event parameters
1790
+ * @param {object} params.event Event object
1791
+ * @param {Core.widget.Container} params.event.source The container.
1792
+ * @param {boolean} params.event.dirty The dirty state of the Container - `true` if there are any fields which have been changed since initial load.
1793
+ */
1794
+ (e: 'dirtyStateChange', params: ((event: { source: Container, dirty: boolean }) => void)|string): void
1795
+ /**
1796
+ * This event fires on the owning Calendar when a drag creation gesture is completed.
1797
+ * @param {string} e Event name
1798
+ * @param {object} params Event parameters
1799
+ * @param {object} params.event Event object
1800
+ * @param {Calendar.view.Calendar} params.event.source The Calendar instance that fired the event.
1801
+ * @param {Core.util.drag.DragContext} params.event.drag The drag create context.
1802
+ * @param {Event} params.event.event The browser event.
1803
+ * @param {Scheduler.model.EventModel} params.event.eventRecord The new `EventModel` record added in the store.
1804
+ * @param {Scheduler.model.ResourceModel} params.event.resourceRecord The `ResourceModel` record if the gesture was performed in a resource-type view.
1805
+ * @param {Calendar.feature.CalendarDrag} params.event.feature The Calendar drag feature instance.
1806
+ * @param {boolean,ValidateCreateResult} params.event.validation The result of the [validateCreateFn](https://bryntum.com/products/calendar/docs/api/Calendar/feature/CalendarDrag#config-validateCreateFn) if one was provided.
1807
+ * @param {CalendarView} params.event.view The Calendar widget in which the drag completed.
1808
+ */
1809
+ (e: 'dragCreateEnd', params: ((event: { source: Calendar, drag: DragContext, event: Event, eventRecord: EventModel, resourceRecord?: ResourceModel, feature: CalendarDrag, validation: boolean|ValidateCreateResult, view: CalendarView }) => void)|string): void
1810
+ /**
1811
+ * This event fires on the owning Calendar when a drag move gesture is completed. The `eventRecord` has already been added
1812
+ * to the `eventStore` of the owning calendar.
1813
+ * @param {string} e Event name
1814
+ * @param {object} params Event parameters
1815
+ * @param {object} params.event Event object
1816
+ * @param {Calendar.view.Calendar} params.event.source The Calendar instance that fired the event.
1817
+ * @param {Core.util.drag.DragContext} params.event.drag The drag create context.
1818
+ * @param {Event} params.event.event The browser event.
1819
+ * @param {Scheduler.model.EventModel} params.event.eventRecord The updated `EventModel` record.
1820
+ * @param {Scheduler.model.ResourceModel} params.event.resourceRecord The `ResourceModel` record if the gesture was performed in a resource-type view.
1821
+ * @param {Calendar.feature.CalendarDrag} params.event.feature The Calendar drag feature instance.
1822
+ * @param {boolean,ValidateCreateResult} params.event.validation The result of the [validateMoveFn](https://bryntum.com/products/calendar/docs/api/Calendar/feature/CalendarDrag#config-validateMoveFn) if one was provided.
1823
+ * @param {CalendarView} params.event.view The Calendar widget in which the drag completed.
1824
+ */
1825
+ (e: 'dragMoveEnd', params: ((event: { source: Calendar, drag: DragContext, event: Event, eventRecord: EventModel, resourceRecord?: ResourceModel, feature: CalendarDrag, validation: boolean|ValidateCreateResult, view: CalendarView }) => void)|string): void
1826
+ /**
1827
+ * This event is fired on the owning Calendar when dragging an event from the calendar over the
1828
+ * external source <strong>if the [droppable](https://bryntum.com/products/calendar/docs/api/Calendar/feature/ExternalEventSource#config-droppable) was configured</strong>.
1829
+ * ...
1830
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#event-dragMoveExternal)
1831
+ * @param {string} e Event name
1832
+ * @param {object} params Event parameters
1833
+ * @param {object} params.event Event object
1834
+ * @param {Scheduler.model.EventModel} params.event.eventRecord The event record being dragged.
1835
+ * @param {HTMLElement} params.event.itemElement The element in which the drag gesture started.
1836
+ * @param {HTMLElement} params.event.targetElement The current over element.
1837
+ * @param {Event} params.event.domEvent The pointer event associated with the drag point.
1838
+ * @param {number} params.event.overIndex *If [grid](https://bryntum.com/products/calendar/docs/api/Calendar/feature/ExternalEventSource#config-grid) was specified*, the index of the row being moved over;
1839
+ * @param {Core.data.Model} params.event.overRecord *If [grid](https://bryntum.com/products/calendar/docs/api/Calendar/feature/ExternalEventSource#config-grid) was specified*, the record being moved over;
1840
+ * @param {boolean} params.event.isAbove *If [grid](https://bryntum.com/products/calendar/docs/api/Calendar/feature/ExternalEventSource#config-grid) was specified*, `true` if the pointer position is above the halfway line of the over row.
1841
+ * @param {boolean} params.event.altKey `true` if the Alt key was down when the last event was processed.
1842
+ * @param {boolean} params.event.ctrlKey `true` if the Ctrl key was down when the last event was processed.
1843
+ * @param {boolean} params.event.metaKey `true` if the Meta key was down when the last event was processed.
1844
+ * @param {boolean} params.event.shiftKey `true` if the Shift key was down when the last event was processed.
1845
+ */
1846
+ (e: 'dragMoveExternal', params: ((event: { eventRecord: EventModel, itemElement: HTMLElement, targetElement: HTMLElement, domEvent: Event, overIndex: number, overRecord: Model, isAbove: boolean, altKey: boolean, ctrlKey: boolean, metaKey: boolean, shiftKey: boolean }) => void)|string): void
1847
+ /**
1848
+ * This event fires on the owning Calendar when a drag resize gesture is completed.
1849
+ * @param {string} e Event name
1850
+ * @param {object} params Event parameters
1851
+ * @param {object} params.event Event object
1852
+ * @param {Calendar.view.Calendar} params.event.source The Calendar instance that fired the event.
1853
+ * @param {Core.util.drag.DragContext} params.event.drag The drag create context.
1854
+ * @param {Event} params.event.event The browser event.
1855
+ * @param {Scheduler.model.EventModel} params.event.eventRecord The updated `EventModel` record.
1856
+ * @param {Calendar.feature.CalendarDrag} params.event.feature The Calendar drag feature instance.
1857
+ * @param {boolean,ValidateCreateResult} params.event.validation The result of the [validateResizeFn](https://bryntum.com/products/calendar/docs/api/Calendar/feature/CalendarDrag#config-validateResizeFn) if one was provided.
1858
+ * @param {CalendarView} params.event.view The Calendar widget in which the drag completed.
1859
+ */
1860
+ (e: 'dragResizeEnd', params: ((event: { source: Calendar, drag: DragContext, event: Event, eventRecord: EventModel, feature: CalendarDrag, validation: boolean|ValidateCreateResult, view: CalendarView }) => void)|string): void
1861
+ /**
1862
+ * This event is fired on the owning Calendar after dropping an event from the calendar on the
1863
+ * external source has been completed <strong>if the [droppable](https://bryntum.com/products/calendar/docs/api/Calendar/feature/ExternalEventSource#config-droppable) was configured</strong>.
1864
+ * ...
1865
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#event-dropExternal)
1866
+ * @param {string} e Event name
1867
+ * @param {object} params Event parameters
1868
+ * @param {object} params.event Event object
1869
+ * @param {Scheduler.model.EventModel} params.event.eventRecord The event record that was dropped.
1870
+ * @param {boolean} params.event.dropOnCalendar `true` if the drop gesture is over the client Calendar. This feature also allows drag *out* of the Calendar and onto the external event source if the [droppable](https://bryntum.com/products/calendar/docs/api/Calendar/feature/ExternalEventSource#config-droppable) config is set.
1871
+ * @param {HTMLElement} params.event.itemElement The element in which the drag gesture started.
1872
+ * @param {HTMLElement} params.event.targetElement The current over element.
1873
+ * @param {Event} params.event.domEvent The pointer event associated with the drag point.
1874
+ * @param {number} params.event.overIndex *If [grid](https://bryntum.com/products/calendar/docs/api/Calendar/feature/ExternalEventSource#config-grid) was specified*, the index of the row being moved over;
1875
+ * @param {Core.data.Model} params.event.overRecord *If [grid](https://bryntum.com/products/calendar/docs/api/Calendar/feature/ExternalEventSource#config-grid) was specified*, the record being moved over;
1876
+ * @param {boolean} params.event.isAbove *If [grid](https://bryntum.com/products/calendar/docs/api/Calendar/feature/ExternalEventSource#config-grid) was specified*, `true` if the pointer position is above the halfway line of the over row.
1877
+ * @param {boolean} params.event.altKey `true` if the Alt key was down when the last event was processed.
1878
+ * @param {boolean} params.event.ctrlKey `true` if the Ctrl key was down when the last event was processed.
1879
+ * @param {boolean} params.event.metaKey `true` if the Meta key was down when the last event was processed.
1880
+ * @param {boolean} params.event.shiftKey `true` if the Shift key was down when the last event was processed.
1881
+ */
1882
+ (e: 'dropExternal', params: ((event: { eventRecord: EventModel, dropOnCalendar: boolean, itemElement: HTMLElement, targetElement: HTMLElement, domEvent: Event, overIndex: number, overRecord: Model, isAbove: boolean, altKey: boolean, ctrlKey: boolean, metaKey: boolean, shiftKey: boolean }) => void)|string): void
1883
+ /**
1884
+ * Triggered when a widget's [element](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#property-element) is available.
1885
+ * @param {string} e Event name
1886
+ * @param {object} params Event parameters
1887
+ * @param {object} params.event Event object
1888
+ * @param {HTMLElement} params.event.element The Widget's element.
1889
+ */
1890
+ (e: 'elementCreated', params: ((event: { element: HTMLElement }) => void)|string): void
1891
+ /**
1892
+ * Fired when an empty cell content area is clicked on in a [MonthView](https://bryntum.com/products/calendar/docs/api/Calendar/widget/MonthView) or a
1893
+ * [CalendarRow](https://bryntum.com/products/calendar/docs/api/Calendar/widget/CalendarRow).
1894
+ * @param {string} e Event name
1895
+ * @param {object} params Event parameters
1896
+ * @param {object} params.event Event object
1897
+ * @param {CalendarView} params.event.source The child view on which the event was initiated.
1898
+ * @param {Event} params.event.domEvent The triggering DOM event.
1899
+ * @param {Date} params.event.date The date which has no visible events
1900
+ */
1901
+ (e: 'emptyCellClick', params: ((event: { source: CalendarView, domEvent: Event, date: Date }) => void)|string): void
1902
+ /**
1903
+ * Fired when an [autoCreate](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/CalendarMixin#config-autoCreate) gesture has
1904
+ * created a new event and added it to the event store.
1905
+ * ...
1906
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#event-eventAutoCreated)
1907
+ * @param {string} e Event name
1908
+ * @param {object} params Event parameters
1909
+ * @param {object} params.event Event object
1910
+ * @param {CalendarView} params.event.source The child view on which the event was initiated.
1911
+ * @param {Scheduler.model.EventModel} params.event.eventRecord The new event record.
1912
+ */
1913
+ (e: 'eventAutoCreated', params: ((event: { source: CalendarView, eventRecord: EventModel }) => void)|string): void
1914
+ /**
1915
+ * Fires when an event bar is clicked in any view.
1916
+ * @param {string} e Event name
1917
+ * @param {object} params Event parameters
1918
+ * @param {object} params.event Event object
1919
+ * @param {CalendarView} params.event.source The view which triggered the event.
1920
+ * @param {Event} params.event.domEvent The initiating DOM event.
1921
+ * @param {Date} params.event.date The date of the UI element which contains the event.
1922
+ * @param {HTMLElement} params.event.eventElement The UI element which represents the event.
1923
+ * @param {Scheduler.model.EventModel} params.event.eventRecord The event clicked on.
1924
+ * @param {Scheduler.model.ResourceModel} params.event.resourceRecord The resource clicked on if the UI includes a resource.
1925
+ * @param {boolean} params.event.fromOverflowPopup `true` if the interaction was through the source view's [overflowPopup](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/DayCellRenderer#property-overflowPopup).
1926
+ */
1927
+ (e: 'eventClick', params: ((event: { source: CalendarView, domEvent: Event, date: Date, eventElement: HTMLElement, eventRecord: EventModel, resourceRecord: ResourceModel, fromOverflowPopup: boolean }) => void)|string): void
1928
+ /**
1929
+ * Fires when an event bar is right-clicked in any view.
1930
+ * @param {string} e Event name
1931
+ * @param {object} params Event parameters
1932
+ * @param {object} params.event Event object
1933
+ * @param {CalendarView} params.event.source The view which triggered the event.
1934
+ * @param {Event} params.event.domEvent The initiating DOM event.
1935
+ * @param {Date} params.event.date The date of the UI element which contains the event.
1936
+ * @param {HTMLElement} params.event.eventElement The UI element which represents the event.
1937
+ * @param {Scheduler.model.EventModel} params.event.eventRecord The event right-clicked on.
1938
+ * @param {Scheduler.model.ResourceModel} params.event.resourceRecord The resource right-clicked on if the UI includes a resource.
1939
+ * @param {boolean} params.event.fromOverflowPopup `true` if the interaction was through the source view's [overflowPopup](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/DayCellRenderer#property-overflowPopup).
1940
+ */
1941
+ (e: 'eventContextMenu', params: ((event: { source: CalendarView, domEvent: Event, date: Date, eventElement: HTMLElement, eventRecord: EventModel, resourceRecord: ResourceModel, fromOverflowPopup: boolean }) => void)|string): void
1942
+ /**
1943
+ * Fires when an event bar is double clicked in any view.
1944
+ * @param {string} e Event name
1945
+ * @param {object} params Event parameters
1946
+ * @param {object} params.event Event object
1947
+ * @param {CalendarView} params.event.source The view which triggered the event.
1948
+ * @param {Event} params.event.domEvent The initiating DOM event.
1949
+ * @param {Date} params.event.date The date of the UI element which contains the event.
1950
+ * @param {HTMLElement} params.event.eventElement The UI element which represents the event.
1951
+ * @param {Scheduler.model.EventModel} params.event.eventRecord The event double clicked on.
1952
+ * @param {Scheduler.model.ResourceModel} params.event.resourceRecord The resource double clicked on if the UI includes a resource.
1953
+ * @param {boolean} params.event.fromOverflowPopup `true` if the interaction was through the source view's [overflowPopup](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/DayCellRenderer#property-overflowPopup).
1954
+ */
1955
+ (e: 'eventDblClick', params: ((event: { source: CalendarView, domEvent: Event, date: Date, eventElement: HTMLElement, eventRecord: EventModel, resourceRecord: ResourceModel, fromOverflowPopup: boolean }) => void)|string): void
1956
+ /**
1957
+ * Fired before the editor will load the event record data into its input fields. This is useful if you
1958
+ * want to modify the fields before data is loaded (e.g. set some input field to be readonly)
1959
+ * @param {string} e Event name
1960
+ * @param {object} params Event parameters
1961
+ * @param {object} params.event Event object
1962
+ * @param {Core.widget.Container} params.event.source The editor widget
1963
+ * @param {Scheduler.model.EventModel} params.event.record The record
1964
+ */
1965
+ (e: 'eventEditBeforeSetRecord', params: ((event: { source: Container, record: EventModel }) => void)|string): void
1966
+ /**
1967
+ * Fires when a key is pressed while an event bar is focused.
1968
+ * @param {string} e Event name
1969
+ * @param {object} params Event parameters
1970
+ * @param {object} params.event Event object
1971
+ * @param {CalendarView} params.event.source The view which triggered the event.
1972
+ * @param {Event} params.event.domEvent The initiating DOM event.
1973
+ * @param {Date} params.event.date The date of the UI element which contains the event.
1974
+ * @param {HTMLElement} params.event.eventElement The UI element which represents the event.
1975
+ * @param {Scheduler.model.EventModel} params.event.eventRecord The event in which the key event was detected.
1976
+ * @param {Scheduler.model.ResourceModel} params.event.resourceRecord The resource in which the key event was detected if the UI includes a resource.
1977
+ * @param {boolean} params.event.fromOverflowPopup `true` if the interaction was through the source view's [overflowPopup](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/DayCellRenderer#property-overflowPopup).
1978
+ */
1979
+ (e: 'eventKeyDown', params: ((event: { source: CalendarView, domEvent: Event, date: Date, eventElement: HTMLElement, eventRecord: EventModel, resourceRecord: ResourceModel, fromOverflowPopup: boolean }) => void)|string): void
1980
+ /**
1981
+ * This event fires on the owning Scheduler before the context menu is shown for an event. Allows manipulation of the items
1982
+ * to show in the same way as in `processItems`. Returning `false` from a listener prevents the menu from
1983
+ * being shown.
1984
+ * @param {string} e Event name
1985
+ * @param {object} params Event parameters
1986
+ * @param {object} params.event Event object
1987
+ * @param {Scheduler.view.Scheduler} params.event.source
1988
+ * @param {Record<string, MenuItemEntry>} params.event.items Menu item configs
1989
+ * @param {Scheduler.model.EventModel} params.event.eventRecord Event record for which the menu was triggered
1990
+ * @param {Scheduler.model.ResourceModel} params.event.resourceRecord Resource record
1991
+ * @param {Scheduler.model.AssignmentModel} params.event.assignmentRecord Assignment record, if assignments are used
1992
+ * @param {HTMLElement} params.event.eventElement
1993
+ * @param {MouseEvent} params.event.event Pointer event which triggered the context menu (if any)
1994
+ */
1995
+ (e: 'eventMenuBeforeShow', params: ((event: { source: Scheduler, items: Record<string, MenuItemEntry>, eventRecord: EventModel, resourceRecord: ResourceModel, assignmentRecord: AssignmentModel, eventElement: HTMLElement, event?: MouseEvent }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1996
+ /**
1997
+ * This event fires on the owning Scheduler when an item is selected in the context menu.
1998
+ * @param {string} e Event name
1999
+ * @param {object} params Event parameters
2000
+ * @param {object} params.event Event object
2001
+ * @param {Scheduler.view.Scheduler} params.event.source
2002
+ * @param {Core.widget.MenuItem} params.event.item
2003
+ * @param {Scheduler.model.EventModel} params.event.eventRecord
2004
+ * @param {Scheduler.model.ResourceModel} params.event.resourceRecord
2005
+ * @param {Scheduler.model.AssignmentModel} params.event.assignmentRecord Assignment record, if assignments are used
2006
+ * @param {HTMLElement} params.event.eventElement
2007
+ */
2008
+ (e: 'eventMenuItem', params: ((event: { source: Scheduler, item: MenuItem, eventRecord: EventModel, resourceRecord: ResourceModel, assignmentRecord: AssignmentModel, eventElement: HTMLElement }) => void)|string): void
2009
+ /**
2010
+ * This event fires on the owning Scheduler after showing the context menu for an event
2011
+ * @param {string} e Event name
2012
+ * @param {object} params Event parameters
2013
+ * @param {object} params.event Event object
2014
+ * @param {Scheduler.view.Scheduler} params.event.source
2015
+ * @param {Core.widget.Menu} params.event.menu The menu
2016
+ * @param {Scheduler.model.EventModel} params.event.eventRecord Event record for which the menu was triggered
2017
+ * @param {Scheduler.model.ResourceModel} params.event.resourceRecord Resource record
2018
+ * @param {Scheduler.model.AssignmentModel} params.event.assignmentRecord Assignment record, if assignments are used
2019
+ * @param {HTMLElement} params.event.eventElement
2020
+ */
2021
+ (e: 'eventMenuShow', params: ((event: { source: Scheduler, menu: Menu, eventRecord: EventModel, resourceRecord: ResourceModel, assignmentRecord: AssignmentModel, eventElement: HTMLElement }) => void)|string): void
2022
+ /**
2023
+ * Fires when an event bar is mousedowned in any view.
2024
+ * @param {string} e Event name
2025
+ * @param {object} params Event parameters
2026
+ * @param {object} params.event Event object
2027
+ * @param {CalendarView} params.event.source The view which triggered the event.
2028
+ * @param {Event} params.event.domEvent The initiating DOM event.
2029
+ * @param {Date} params.event.date The date of the UI element which contains the event.
2030
+ * @param {HTMLElement} params.event.eventElement The UI element which represents the event.
2031
+ * @param {Scheduler.model.EventModel} params.event.eventRecord The event mousedowned on.
2032
+ * @param {Scheduler.model.ResourceModel} params.event.resourceRecord The resource mousedowned on if the UI includes a resource.
2033
+ * @param {boolean} params.event.fromOverflowPopup `true` if the interaction was through the source view's [overflowPopup](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/DayCellRenderer#property-overflowPopup).
2034
+ */
2035
+ (e: 'eventMouseDown', params: ((event: { source: CalendarView, domEvent: Event, date: Date, eventElement: HTMLElement, eventRecord: EventModel, resourceRecord: ResourceModel, fromOverflowPopup: boolean }) => void)|string): void
2036
+ /**
2037
+ * Fires when cursor enters an event bar in any view.
2038
+ * @param {string} e Event name
2039
+ * @param {object} params Event parameters
2040
+ * @param {object} params.event Event object
2041
+ * @param {CalendarView} params.event.source The view which triggered the event.
2042
+ * @param {Event} params.event.domEvent The initiating DOM event.
2043
+ * @param {Date} params.event.date The date of the UI element which contains the event.
2044
+ * @param {HTMLElement} params.event.eventElement The UI element which represents the event.
2045
+ * @param {Scheduler.model.EventModel} params.event.eventRecord The event record.
2046
+ * @param {Scheduler.model.ResourceModel} params.event.resourceRecord The resource if the UI includes a resource.
2047
+ * @param {boolean} params.event.fromOverflowPopup `true` if the interaction was through the source view's [overflowPopup](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/DayCellRenderer#property-overflowPopup).
2048
+ */
2049
+ (e: 'eventMouseEnter', params: ((event: { source: CalendarView, domEvent: Event, date: Date, eventElement: HTMLElement, eventRecord: EventModel, resourceRecord: ResourceModel, fromOverflowPopup: boolean }) => void)|string): void
2050
+ /**
2051
+ * Fires when cursor leaves an event bar in any view.
2052
+ * @param {string} e Event name
2053
+ * @param {object} params Event parameters
2054
+ * @param {object} params.event Event object
2055
+ * @param {CalendarView} params.event.source The view which triggered the event.
2056
+ * @param {Event} params.event.domEvent The initiating DOM event.
2057
+ * @param {Date} params.event.date The date of the UI element which contains the event.
2058
+ * @param {HTMLElement} params.event.eventElement The UI element which represents the event.
2059
+ * @param {Scheduler.model.EventModel} params.event.eventRecord The event record.
2060
+ * @param {Scheduler.model.ResourceModel} params.event.resourceRecord The resource if the UI includes a resource.
2061
+ * @param {boolean} params.event.fromOverflowPopup `true` if the interaction was through the source view's [overflowPopup](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/DayCellRenderer#property-overflowPopup).
2062
+ */
2063
+ (e: 'eventMouseLeave', params: ((event: { source: CalendarView, domEvent: Event, date: Date, eventElement: HTMLElement, eventRecord: EventModel, resourceRecord: ResourceModel, fromOverflowPopup: boolean }) => void)|string): void
2064
+ /**
2065
+ * Fires when an event bar is mouseouted in any view.
2066
+ * @param {string} e Event name
2067
+ * @param {object} params Event parameters
2068
+ * @param {object} params.event Event object
2069
+ * @param {CalendarView} params.event.source The view which triggered the event.
2070
+ * @param {Event} params.event.domEvent The initiating DOM event.
2071
+ * @param {Date} params.event.date The date of the UI element which contains the event.
2072
+ * @param {HTMLElement} params.event.eventElement The UI element which represents the event.
2073
+ * @param {Scheduler.model.EventModel} params.event.eventRecord The event mouseouted.
2074
+ * @param {Scheduler.model.ResourceModel} params.event.resourceRecord The resource mouseouted if the UI includes a resource.
2075
+ * @param {boolean} params.event.fromOverflowPopup `true` if the interaction was through the source view's [overflowPopup](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/DayCellRenderer#property-overflowPopup).
2076
+ */
2077
+ (e: 'eventMouseOut', params: ((event: { source: CalendarView, domEvent: Event, date: Date, eventElement: HTMLElement, eventRecord: EventModel, resourceRecord: ResourceModel, fromOverflowPopup: boolean }) => void)|string): void
2078
+ /**
2079
+ * Fires when an event bar is mouseovered in any view.
2080
+ * @param {string} e Event name
2081
+ * @param {object} params Event parameters
2082
+ * @param {object} params.event Event object
2083
+ * @param {CalendarView} params.event.source The view which triggered the event.
2084
+ * @param {Event} params.event.domEvent The initiating DOM event.
2085
+ * @param {Date} params.event.date The date of the UI element which contains the event.
2086
+ * @param {HTMLElement} params.event.eventElement The UI element which represents the event.
2087
+ * @param {Scheduler.model.EventModel} params.event.eventRecord The event mouseovered.
2088
+ * @param {Scheduler.model.ResourceModel} params.event.resourceRecord The resource mouseovered if the UI includes a resource.
2089
+ * @param {boolean} params.event.fromOverflowPopup `true` if the interaction was through the source view's [overflowPopup](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/DayCellRenderer#property-overflowPopup).
2090
+ */
2091
+ (e: 'eventMouseOver', params: ((event: { source: CalendarView, domEvent: Event, date: Date, eventElement: HTMLElement, eventRecord: EventModel, resourceRecord: ResourceModel, fromOverflowPopup: boolean }) => void)|string): void
2092
+ /**
2093
+ * Fires when an event bar is mouseupped in any view.
2094
+ * @param {string} e Event name
2095
+ * @param {object} params Event parameters
2096
+ * @param {object} params.event Event object
2097
+ * @param {CalendarView} params.event.source The view which triggered the event.
2098
+ * @param {Event} params.event.domEvent The initiating DOM event.
2099
+ * @param {Date} params.event.date The date of the UI element which contains the event.
2100
+ * @param {HTMLElement} params.event.eventElement The UI element which represents the event.
2101
+ * @param {Scheduler.model.EventModel} params.event.eventRecord The event mouseupped.
2102
+ * @param {Scheduler.model.ResourceModel} params.event.resourceRecord The resource mouseupped if the UI includes a resource.
2103
+ * @param {boolean} params.event.fromOverflowPopup `true` if the interaction was through the source view's [overflowPopup](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/DayCellRenderer#property-overflowPopup).
2104
+ */
2105
+ (e: 'eventMouseUp', params: ((event: { source: CalendarView, domEvent: Event, date: Date, eventElement: HTMLElement, eventRecord: EventModel, resourceRecord: ResourceModel, fromOverflowPopup: boolean }) => void)|string): void
2106
+ /**
2107
+ * Fires when a day spanning event is found, and the date to which its encapsulating event bar
2108
+ * extends has been calculated.
2109
+ * ...
2110
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#event-eventPropagate)
2111
+ * @param {string} e Event name
2112
+ * @param {object} params Event parameters
2113
+ * @param {object} params.event Event object
2114
+ * @param {CalendarView} params.event.source The view which triggered the event.
2115
+ * @param {Date} params.event.eventEndDate The end date for which to calculate the propagate end date.
2116
+ * @param {Date} params.event.propagateEndDate The system-calculated end point of the event bar.
2117
+ * @param {boolean} params.event.isAllDay `true` if the event is an all day event, or spans multiple days.
2118
+ * @param {boolean} params.event.isOverflow `true` if this is being called as part of further propagation.
2119
+ * @param {boolean} params.event.overflows `true` if the event extends into future cells.
2120
+ * @param {Scheduler.model.EventModel} params.event.eventRecord The event record being propagated.
2121
+ * @param {Date} params.event.date The date from which the event is being propagated.
2122
+ */
2123
+ (e: 'eventPropagate', params: ((event: { source: CalendarView, eventEndDate: Date, propagateEndDate: Date, isAllDay: boolean, isOverflow: boolean, overflows: boolean, eventRecord: EventModel, date: Date }) => void)|string): void
2124
+ /**
2125
+ * Fires when a Panel is expanded using the [collapsible](https://bryntum.com/products/calendar/docs/api/Core/widget/Panel#config-collapsible) setting.
2126
+ * @param {string} e Event name
2127
+ * @param {object} params Event parameters
2128
+ * @param {object} params.event Event object
2129
+ * @param {Core.widget.Panel} params.event.source This Panel.
2130
+ */
2131
+ (e: 'expand', params: ((event: { source: Panel }) => void)|string): void
2132
+ /**
2133
+ * Fired when focus enters this Widget.
2134
+ * @param {string} e Event name
2135
+ * @param {object} params Event parameters
2136
+ * @param {object} params.event Event object
2137
+ * @param {Core.widget.Widget} params.event.source This Widget
2138
+ * @param {HTMLElement} params.event.fromElement The element which lost focus.
2139
+ * @param {HTMLElement} params.event.toElement The element which gained focus.
2140
+ * @param {Core.widget.Widget} params.event.fromWidget The widget which lost focus.
2141
+ * @param {Core.widget.Widget} params.event.toWidget The widget which gained focus.
2142
+ * @param {boolean} params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
2143
+ */
2144
+ (e: 'focusIn', params: ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string): void
2145
+ /**
2146
+ * Fired when focus exits this Widget's ownership tree. This is different from a `blur` event.
2147
+ * focus moving from within this Widget's ownership tree, even if there are floating widgets
2148
+ * will not trigger this event. This is when focus exits this widget completely.
2149
+ * @param {string} e Event name
2150
+ * @param {object} params Event parameters
2151
+ * @param {object} params.event Event object
2152
+ * @param {Core.widget.Widget} params.event.source This Widget
2153
+ * @param {HTMLElement} params.event.fromElement The element which lost focus.
2154
+ * @param {HTMLElement} params.event.toElement The element which gained focus.
2155
+ * @param {Core.widget.Widget} params.event.fromWidget The widget which lost focus.
2156
+ * @param {Core.widget.Widget} params.event.toWidget The widget which gained focus.
2157
+ * @param {boolean} params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
2158
+ */
2159
+ (e: 'focusOut', params: ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string): void
2160
+ /**
2161
+ * Triggered after a widget was hidden
2162
+ * @param {string} e Event name
2163
+ * @param {object} params Event parameters
2164
+ * @param {object} params.event Event object
2165
+ * @param {Core.widget.Widget} params.event.source The widget
2166
+ */
2167
+ (e: 'hide', params: ((event: { source: Widget }) => void)|string): void
2168
+ /**
2169
+ * Fires when the [LoadOnDemand](https://bryntum.com/products/calendar/docs/api/Calendar/feature/LoadOnDemand) feature detects that a request
2170
+ * for data from the server has failed.
2171
+ * ...
2172
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#event-loadOnDemandFail)
2173
+ * @param {string} e Event name
2174
+ * @param {object} params Event parameters
2175
+ * @param {object} params.event Event object
2176
+ * @param {Response} params.event.rawResponse The HTTP `fetch` response object.
2177
+ * @param {object} params.event.request The CrudManager load data block.
2178
+ * @param {object} params.event.response The decoded JSON response.
2179
+ */
2180
+ (e: 'loadOnDemandFail', params: ((event: { rawResponse: any, request: object, response: object }) => void)|string): void
2181
+ /**
2182
+ * Fires when a month name header in a [YearView](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView) or a [MonthGrid](#Calendar/widget/MonthGrid) is clicked
2183
+ * or activated by the <kbd>ENTER</kbd> key.
2184
+ * ...
2185
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#event-monthNameClick)
2186
+ * @param {string} e Event name
2187
+ * @param {object} params Event parameters
2188
+ * @param {object} params.event Event object
2189
+ * @param {CalendarView} params.event.source The view which triggered the event.
2190
+ * @param {Event} params.event.domEvent The initiating DOM event.
2191
+ * @param {number} params.event.month The month index *(zero based)* clicked on.
2192
+ * @param {Date} params.event.date The date of the first of the month clicked on.
2193
+ */
2194
+ (e: 'monthNameClick', params: ((event: { source: CalendarView, domEvent: Event, month: number, date: Date }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
2195
+ /**
2196
+ * Fired when a user gesture causes the active item to change.
2197
+ * @param {string} e Event name
2198
+ * @param {object} params Event parameters
2199
+ * @param {object} params.event Event object
2200
+ * @param {Event} params.event.event The browser event which instigated navigation. May be a click or key or focus event.
2201
+ * @param {HTMLElement,null} params.event.item The newly active item, or `null` if focus moved out.
2202
+ * @param {HTMLElement,null} params.event.oldItem The previously active item, or `null` if focus is moving in.
2203
+ */
2204
+ (e: 'navigate', params: ((event: { event: Event, item: HTMLElement|null, oldItem: HTMLElement|null }) => void)|string): void
2205
+ /**
2206
+ * Triggered when a widget which had been in a non-visible state for any reason
2207
+ * achieves visibility.
2208
+ * ...
2209
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#event-paint)
2210
+ * @param {string} e Event name
2211
+ * @param {object} params Event parameters
2212
+ * @param {object} params.event Event object
2213
+ * @param {Core.widget.Widget} params.event.source The widget being painted.
2214
+ * @param {boolean} params.event.firstPaint `true` if this is the first paint.
2215
+ */
2216
+ (e: 'paint', params: ((event: { source: Widget, firstPaint: boolean }) => void)|string): void
2217
+ /**
2218
+ * Fires on the owning Scheduler after a paste action is performed.
2219
+ * @param {string} e Event name
2220
+ * @param {object} params Event parameters
2221
+ * @param {object} params.event Event object
2222
+ * @param {Scheduler.view.Scheduler} params.event.source Owner scheduler
2223
+ * @param {Scheduler.model.EventModel[]} params.event.eventRecords The pasted event records
2224
+ * @param {Scheduler.model.AssignmentModel[]} params.event.assignmentRecords The pasted assignment records
2225
+ * @param {Scheduler.model.EventModel[]} params.event.pastedEventRecords (DEPRECATED) Use eventRecords instead
2226
+ * @param {Scheduler.model.EventModel[]} params.event.originalEventRecords The original copied event records
2227
+ * @param {Scheduler.model.AssignmentModel[]} params.event.originalAssignmentRecords The original copied assignment records
2228
+ * @param {Date} params.event.date date Pasted to this date
2229
+ * @param {Scheduler.model.ResourceModel} params.event.resourceRecord The target resource record
2230
+ * @param {boolean} params.event.isCut `true` if this is a cut action
2231
+ * @param {string} params.event.entityName 'event' to distinguish this event from other paste events
2232
+ */
2233
+ (e: 'paste', params: ((event: { source: Scheduler, eventRecords: EventModel[], assignmentRecords: AssignmentModel[], pastedEventRecords: EventModel[], originalEventRecords: EventModel[], originalAssignmentRecords: AssignmentModel[], date: Date, resourceRecord: ResourceModel, isCut: boolean, entityName: string }) => void)|string): void
2234
+ /**
2235
+ * Fires on the owning Scheduler if a paste action is not allowed. Depending on if the EventStore is using
2236
+ * [singleAssignment](https://bryntum.com/products/calendar/docs/api/Scheduler/data/EventStore#config-singleAssignment) or the configuration of
2237
+ * [copyPasteAction](https://bryntum.com/products/calendar/docs/api/Scheduler/feature/EventCopyPaste#config-copyPasteAction), either the `eventRecords` or the `assignmentRecords` param will be populated
2238
+ * with record copies.
2239
+ * @param {string} e Event name
2240
+ * @param {object} params Event parameters
2241
+ * @param {object} params.event Event object
2242
+ * @param {Scheduler.view.Scheduler} params.event.source Owner scheduler
2243
+ * @param {Scheduler.model.EventModel[]} params.event.eventRecords The event records about to be pasted
2244
+ * @param {Scheduler.model.AssignmentModel[]} params.event.assignmentRecords The assignment records about to be pasted
2245
+ * @param {Scheduler.model.EventModel[]} params.event.originalEventRecords The event records that were copied
2246
+ * @param {Scheduler.model.AssignmentModel[]} params.event.originalAssignmentRecords The assignment records that were copied
2247
+ * @param {Date} params.event.date The paste date
2248
+ * @param {Scheduler.model.ResourceModel} params.event.resourceRecord The target resource record
2249
+ * @param {boolean} params.event.isCut `true` if this is a cut action
2250
+ * @param {string} params.event.entityName 'event' to distinguish this event from other `pasteNotAllowed` events
2251
+ * @param {'overlappingEvents','resourceReadOnly'} params.event.reason A string id to use for displaying an error message to the user.
2252
+ */
2253
+ (e: 'pasteNotAllowed', params: ((event: { source: Scheduler, eventRecords: EventModel[], assignmentRecords: AssignmentModel[], originalEventRecords: EventModel[], originalAssignmentRecords: AssignmentModel[], date: Date, resourceRecord: ResourceModel, isCut: boolean, entityName: string, reason: 'overlappingEvents'|'resourceReadOnly' }) => void)|string): void
2254
+ /**
2255
+ * Fired when a Widget's read only state is toggled
2256
+ * @param {string} e Event name
2257
+ * @param {object} params Event parameters
2258
+ * @param {object} params.event Event object
2259
+ * @param {boolean} params.event.readOnly Read only or not
2260
+ */
2261
+ (e: 'readOnly', params: ((event: { readOnly: boolean }) => void)|string): void
2262
+ /**
2263
+ * This event is fired after a widget's elements have been synchronized due to a direct or indirect call
2264
+ * to [recompose](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#function-recompose), if this results in some change to the widget's rendered DOM elements.
2265
+ */
2266
+ (e: 'recompose', params: (() => void)|string): void
2267
+ /**
2268
+ * Fires when one of the views in this Calendar refreshes.
2269
+ * @param {string} e Event name
2270
+ * @param {object} params Event parameters
2271
+ * @param {object} params.event Event object
2272
+ * @param {CalendarView} params.event.source The view which refreshed.
2273
+ */
2274
+ (e: 'refresh', params: ((event: { source: CalendarView }) => void)|string): void
2275
+ /**
2276
+ * Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
2277
+ * @param {string} e Event name
2278
+ * @param {object} params Event parameters
2279
+ * @param {object} params.event Event object
2280
+ * @param {Core.widget.Widget} params.event.source This Widget
2281
+ * @param {number} params.event.width The new width
2282
+ * @param {number} params.event.height The new height
2283
+ * @param {number} params.event.oldWidth The old width
2284
+ * @param {number} params.event.oldHeight The old height
2285
+ */
2286
+ (e: 'resize', params: ((event: { source: Widget, width: number, height: number, oldWidth: number, oldHeight: number }) => void)|string): void
2287
+ /**
2288
+ * Fires when a click event is received by a view which supports resources.
2289
+ * ...
2290
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#event-resourceClick)
2291
+ * @param {string} e Event name
2292
+ * @param {object} params Event parameters
2293
+ * @param {object} params.event Event object
2294
+ * @param {CalendarView} params.event.source The view which triggered the event.
2295
+ * @param {Event} params.event.domEvent The initiating DOM event.
2296
+ * @param {Date} params.event.date The date of the UI element which contains the event.
2297
+ * @param {HTMLElement} params.event.eventElement *If* an event was interacted with, the UI element which represents the event.
2298
+ * @param {Scheduler.model.EventModel} params.event.eventRecord *If* an event was interacted with.
2299
+ * @param {HTMLElement} params.event.resourceElement The UI element which encapsulates the resource.
2300
+ * @param {Scheduler.model.ResourceModel} params.event.resourceRecord The resource associated with the target element.
2301
+ * @param {boolean} params.event.fromOverflowPopup `true` if the interaction was through the source view's [overflowPopup](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/DayCellRenderer#property-overflowPopup).
2302
+ */
2303
+ (e: 'resourceClick', params: ((event: { source: CalendarView, domEvent: Event, date: Date, eventElement: HTMLElement, eventRecord: EventModel, resourceElement: HTMLElement, resourceRecord: ResourceModel, fromOverflowPopup: boolean }) => void)|string): void
2304
+ /**
2305
+ * Triggered when a new [responsiveState](https://bryntum.com/products/calendar/docs/api/Core/widget/mixin/Responsive#config-responsiveState) is applied.
2306
+ * @param {string} e Event name
2307
+ * @param {object} params Event parameters
2308
+ * @param {object} params.event Event object
2309
+ * @param {Core.widget.Widget} params.event.source The widget whose `responsiveState` has changed
2310
+ * @param {string} params.event.state The new value for the widget's `responsiveState`
2311
+ * @param {string} params.event.oldState The previous value for the widget's `responsiveState`
2312
+ */
2313
+ (e: 'responsiveStateChange', params: ((event: { source: Widget, state: string, oldState: string }) => void)|string): void
2314
+ /**
2315
+ * Fires when a click made its way through to an empty part of any view.
2316
+ * @param {string} e Event name
2317
+ * @param {object} params Event parameters
2318
+ * @param {object} params.event Event object
2319
+ * @param {CalendarView} params.event.source The view which triggered the event.
2320
+ * @param {Event} params.event.domEvent The initiating DOM event.
2321
+ * @param {Date} params.event.date The date clicked on. _Note that in a [DayView](https://bryntum.com/products/calendar/docs/api/Calendar/widget/DayView), this will include granular time information. For other views, this is the *start* of the date.
2322
+ * @param {Scheduler.model.ResourceModel} params.event.resourceRecord The resource associated with the view if any. Only [ResourceView](https://bryntum.com/products/calendar/docs/api/Calendar/widget/ResourceView) or a [DayResourceView](#Calendar/widget/DayResourceView) will include this.
2323
+ */
2324
+ (e: 'scheduleClick', params: ((event: { source: CalendarView, domEvent: Event, date: Date, resourceRecord: ResourceModel }) => void)|string): void
2325
+ /**
2326
+ * Fires when a context menu made its way through to an empty part of any view.
2327
+ * @param {string} e Event name
2328
+ * @param {object} params Event parameters
2329
+ * @param {object} params.event Event object
2330
+ * @param {CalendarView} params.event.source The view which triggered the event.
2331
+ * @param {Event} params.event.domEvent The initiating DOM event.
2332
+ * @param {Date} params.event.date The date clicked on. _Note that in a [DayView](https://bryntum.com/products/calendar/docs/api/Calendar/widget/DayView), this will include granular time information. For other views, this is the *start* of the date.
2333
+ * @param {Scheduler.model.ResourceModel} params.event.resourceRecord The resource associated with the view if any. Only [ResourceView](https://bryntum.com/products/calendar/docs/api/Calendar/widget/ResourceView) or a [DayResourceView](#Calendar/widget/DayResourceView) will include this.
2334
+ */
2335
+ (e: 'scheduleContextMenu', params: ((event: { source: CalendarView, domEvent: Event, date: Date, resourceRecord: ResourceModel }) => void)|string): void
2336
+ /**
2337
+ * Fires when a dblclick made its way through to an empty part of any view.
2338
+ * @param {string} e Event name
2339
+ * @param {object} params Event parameters
2340
+ * @param {object} params.event Event object
2341
+ * @param {CalendarView} params.event.source The view which triggered the event.
2342
+ * @param {Event} params.event.domEvent The initiating DOM event.
2343
+ * @param {Date} params.event.date The date double clicked on. _Note that in a [DayView](https://bryntum.com/products/calendar/docs/api/Calendar/widget/DayView), this will include granular time information. For other views, this is the *start* of the date.
2344
+ * @param {Scheduler.model.ResourceModel} params.event.resourceRecord The resource associated with the view if any. Only [ResourceView](https://bryntum.com/products/calendar/docs/api/Calendar/widget/ResourceView) or a [DayResourceView](#Calendar/widget/DayResourceView) will include this.
2345
+ */
2346
+ (e: 'scheduleDblClick', params: ((event: { source: CalendarView, domEvent: Event, date: Date, resourceRecord: ResourceModel }) => void)|string): void
2347
+ /**
2348
+ * This event fires on the owning Scheduler or Gantt widget before the context menu is shown for the schedule.
2349
+ * Allows manipulation of the items to show in the same way as in `processItems`. Returning `false` from a listener
2350
+ * prevents the menu from being shown.
2351
+ * @param {string} e Event name
2352
+ * @param {object} params Event parameters
2353
+ * @param {object} params.event Event object
2354
+ * @param {Scheduler.view.Scheduler} params.event.source
2355
+ * @param {Record<string, MenuItemEntry>} params.event.items Menu item configs
2356
+ * @param {Scheduler.model.ResourceModel} params.event.resourceRecord Resource record
2357
+ * @param {Date} params.event.date Clicked date, rounded according to viewPreset's settings
2358
+ * @param {Scheduler.model.AssignmentModel} params.event.assignmentRecord Assignment record, if assignments are used
2359
+ * @param {HTMLElement} params.event.eventElement
2360
+ */
2361
+ (e: 'scheduleMenuBeforeShow', params: ((event: { source: Scheduler, items: Record<string, MenuItemEntry>, resourceRecord: ResourceModel, date: Date, assignmentRecord: AssignmentModel, eventElement: HTMLElement }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
2362
+ /**
2363
+ * This event fires on the owning Scheduler or Gantt widget when an item is selected in the context menu.
2364
+ * @param {string} e Event name
2365
+ * @param {object} params Event parameters
2366
+ * @param {object} params.event Event object
2367
+ * @param {Scheduler.view.Scheduler} params.event.source
2368
+ * @param {Core.widget.MenuItem} params.event.item
2369
+ * @param {Scheduler.model.ResourceModel} params.event.resourceRecord
2370
+ * @param {Date} params.event.date Clicked date, rounded according to viewPreset's settings
2371
+ * @param {HTMLElement} params.event.element
2372
+ */
2373
+ (e: 'scheduleMenuItem', params: ((event: { source: Scheduler, item: MenuItem, resourceRecord: ResourceModel, date: Date, element: HTMLElement }) => void)|string): void
2374
+ /**
2375
+ * This event fires on the owning Scheduler or Gantt widget after showing the context menu for the schedule.
2376
+ * @param {string} e Event name
2377
+ * @param {object} params Event parameters
2378
+ * @param {object} params.event Event object
2379
+ * @param {Scheduler.view.Scheduler} params.event.source
2380
+ * @param {Record<string, MenuItemEntry>} params.event.items Menu item configs
2381
+ * @param {Core.widget.Menu} params.event.menu The menu
2382
+ * @param {Scheduler.model.ResourceModel} params.event.resourceRecord
2383
+ * @param {Date} params.event.date Clicked date, rounded according to viewPreset's settings
2384
+ * @param {HTMLElement} params.event.targetElement
2385
+ */
2386
+ (e: 'scheduleMenuShow', params: ((event: { source: Scheduler, items: Record<string, MenuItemEntry>, menu: Menu, resourceRecord: ResourceModel, date: Date, targetElement: HTMLElement }) => void)|string): void
2387
+ /**
2388
+ * Fires when a mousedown made its way through to an empty part of any view.
2389
+ * @param {string} e Event name
2390
+ * @param {object} params Event parameters
2391
+ * @param {object} params.event Event object
2392
+ * @param {CalendarView} params.event.source The view which triggered the event.
2393
+ * @param {Event} params.event.domEvent The initiating DOM event.
2394
+ * @param {Date} params.event.date The date mousedowned on. _Note that in a [DayView](https://bryntum.com/products/calendar/docs/api/Calendar/widget/DayView), this will include granular time information. For other views, this is the *start* of the date.
2395
+ * @param {Scheduler.model.ResourceModel} params.event.resourceRecord The resource associated with the view if any. Only [ResourceView](https://bryntum.com/products/calendar/docs/api/Calendar/widget/ResourceView) or a [DayResourceView](#Calendar/widget/DayResourceView) will include this.
2396
+ */
2397
+ (e: 'scheduleMouseDown', params: ((event: { source: CalendarView, domEvent: Event, date: Date, resourceRecord: ResourceModel }) => void)|string): void
2398
+ /**
2399
+ * Fires when a mouseout made it's way through to an empty part of any view.
2400
+ * @param {string} e Event name
2401
+ * @param {object} params Event parameters
2402
+ * @param {object} params.event Event object
2403
+ * @param {CalendarView} params.event.source The view which triggered the event.
2404
+ * @param {Event} params.event.domEvent The initiating DOM event.
2405
+ * @param {Date} params.event.date The date mouseouted. _Note that in a [DayView](https://bryntum.com/products/calendar/docs/api/Calendar/widget/DayView), this will include granular time information. For other views, this is the *start* of the date.
2406
+ * @param {Scheduler.model.ResourceModel} params.event.resourceRecord The resource associated with the view if any. Only [ResourceView](https://bryntum.com/products/calendar/docs/api/Calendar/widget/ResourceView) or a [DayResourceView](#Calendar/widget/DayResourceView) will include this.
2407
+ */
2408
+ (e: 'scheduleMouseOut', params: ((event: { source: CalendarView, domEvent: Event, date: Date, resourceRecord: ResourceModel }) => void)|string): void
2409
+ /**
2410
+ * Fires when a mouseover made its way through to an empty part of any view.
2411
+ * @param {string} e Event name
2412
+ * @param {object} params Event parameters
2413
+ * @param {object} params.event Event object
2414
+ * @param {CalendarView} params.event.source The view which triggered the event.
2415
+ * @param {Event} params.event.domEvent The initiating DOM event.
2416
+ * @param {Date} params.event.date The date mouseovered. _Note that in a [DayView](https://bryntum.com/products/calendar/docs/api/Calendar/widget/DayView), this will include granular time information. For other views, this is the *start* of the date.
2417
+ * @param {Scheduler.model.ResourceModel} params.event.resourceRecord The resource associated with the view if any. Only [ResourceView](https://bryntum.com/products/calendar/docs/api/Calendar/widget/ResourceView) or a [DayResourceView](#Calendar/widget/DayResourceView) will include this.
2418
+ */
2419
+ (e: 'scheduleMouseOver', params: ((event: { source: CalendarView, domEvent: Event, date: Date, resourceRecord: ResourceModel }) => void)|string): void
2420
+ /**
2421
+ * Fires when a mouseup made its way through to an empty part of any view.
2422
+ * @param {string} e Event name
2423
+ * @param {object} params Event parameters
2424
+ * @param {object} params.event Event object
2425
+ * @param {CalendarView} params.event.source The view which triggered the event.
2426
+ * @param {Event} params.event.domEvent The initiating DOM event.
2427
+ * @param {Date} params.event.date The date mouseupped on. _Note that in a [DayView](https://bryntum.com/products/calendar/docs/api/Calendar/widget/DayView), this will include granular time information. For other views, this is the *start* of the date.
2428
+ * @param {Scheduler.model.ResourceModel} params.event.resourceRecord The resource associated with the view if any. Only [ResourceView](https://bryntum.com/products/calendar/docs/api/Calendar/widget/ResourceView) or a [DayResourceView](#Calendar/widget/DayResourceView) will include this.
2429
+ */
2430
+ (e: 'scheduleMouseUp', params: ((event: { source: CalendarView, domEvent: Event, date: Date, resourceRecord: ResourceModel }) => void)|string): void
2431
+ /**
2432
+ * Fired any time there is a change to the events selected in the Calendar.
2433
+ * @param {string} e Event name
2434
+ * @param {object} params Event parameters
2435
+ * @param {object} params.event Event object
2436
+ * @param {Calendar.view.Calendar} params.event.source The Calendar instance.
2437
+ * @param {'select','deselect','update','clear'} params.event.action One of the actions 'select', 'deselect', 'update', 'clear'
2438
+ * @param {Scheduler.model.EventModel[]} params.event.selected An array of the Events added to the selection.
2439
+ * @param {Scheduler.model.EventModel[]} params.event.deselected An array of the Event removed from the selection.
2440
+ * @param {Scheduler.model.EventModel[]} params.event.selection The new selection.
2441
+ */
2442
+ (e: 'selectionChange', params: ((event: { source: Calendar, action: 'select'|'deselect'|'update'|'clear', selected: EventModel[], deselected: EventModel[], selection: EventModel[] }) => void)|string): void
2443
+ /**
2444
+ * Triggered after a widget is shown.
2445
+ * @param {string} e Event name
2446
+ * @param {object} params Event parameters
2447
+ * @param {object} params.event Event object
2448
+ * @param {Core.widget.Widget} params.event.source The widget
2449
+ */
2450
+ (e: 'show', params: ((event: { source: Widget }) => void)|string): void
2451
+ /**
2452
+ * Fired when the sidebar is collapsed either through the UI or programatically.
2453
+ * @param {string} e Event name
2454
+ * @param {object} params Event parameters
2455
+ * @param {object} params.event Event object
2456
+ * @param {Calendar.view.Calendar} params.event.source This Calendar instance
2457
+ */
2458
+ (e: 'sidebarCollapse', params: ((event: { source: Calendar }) => void)|string): void
2459
+ /**
2460
+ * Fired when the sidebar is expanded either through the UI or programatically.
2461
+ * @param {string} e Event name
2462
+ * @param {object} params Event parameters
2463
+ * @param {object} params.event Event object
2464
+ * @param {Calendar.view.Calendar} params.event.source This Calendar instance
2465
+ */
2466
+ (e: 'sidebarExpand', params: ((event: { source: Calendar }) => void)|string): void
2467
+ /**
2468
+ * Fired when a time axis of a DayView or WeekView is clicked on. If the handler returns
2469
+ * `false` the current pointer event is not processed further.
2470
+ * @param {string} e Event name
2471
+ * @param {object} params Event parameters
2472
+ * @param {object} params.event Event object
2473
+ * @param {CalendarView} params.event.source The view which triggered the event.
2474
+ * @param {Event} params.event.domEvent The triggering DOM event.
2475
+ * @param {Date} params.event.preciseTime The exact date and time at the clicked position
2476
+ * @param {Date} params.event.time The date and time at the clicked position snapped according to the [increment](https://bryntum.com/products/calendar/docs/api/Calendar/widget/DayView#config-increment) and [timeSnapType](#Calendar/widget/DayView#config-timeSnapType)
2477
+ */
2478
+ (e: 'timeAxisClick', params: ((event: { source: CalendarView, domEvent: Event, preciseTime: Date, time: Date }) => void)|string): void
2479
+ /**
2480
+ * Fired on the owning Scheduler or Gantt widget when a click happens on a time range header element
2481
+ * @param {string} e Event name
2482
+ * @param {object} params Event parameters
2483
+ * @param {object} params.event Event object
2484
+ * @param {Scheduler.view.Scheduler} params.event.source Scheduler instance
2485
+ * @param {Scheduler.model.TimeSpan} params.event.timeRangeRecord The record
2486
+ * @param {MouseEvent} params.event.domEvent Browser event
2487
+ */
2488
+ (e: 'timeRangeHeaderClick', params: ((event: { source: Scheduler, timeRangeRecord: TimeSpan, domEvent: MouseEvent }) => void)|string): void
2489
+ /**
2490
+ * Fired on the owning Scheduler or Gantt widget when a right click happens on a time range header element
2491
+ * @param {string} e Event name
2492
+ * @param {object} params Event parameters
2493
+ * @param {object} params.event Event object
2494
+ * @param {Scheduler.view.Scheduler} params.event.source Scheduler instance
2495
+ * @param {Scheduler.model.TimeSpan} params.event.timeRangeRecord The record
2496
+ * @param {MouseEvent} params.event.domEvent Browser event
2497
+ */
2498
+ (e: 'timeRangeHeaderContextMenu', params: ((event: { source: Scheduler, timeRangeRecord: TimeSpan, domEvent: MouseEvent }) => void)|string): void
2499
+ /**
2500
+ * Fired on the owning Scheduler or Gantt widget when a double click happens on a time range header element
2501
+ * @param {string} e Event name
2502
+ * @param {object} params Event parameters
2503
+ * @param {object} params.event Event object
2504
+ * @param {Scheduler.view.Scheduler} params.event.source Scheduler instance
2505
+ * @param {Scheduler.model.TimeSpan} params.event.timeRangeRecord The record
2506
+ * @param {MouseEvent} params.event.domEvent Browser event
2507
+ */
2508
+ (e: 'timeRangeHeaderDblClick', params: ((event: { source: Scheduler, timeRangeRecord: TimeSpan, domEvent: MouseEvent }) => void)|string): void
2509
+ /**
2510
+ * A header [tool](https://bryntum.com/products/calendar/docs/api/Core/widget/Panel#config-tools) has been clicked.
2511
+ * @param {string} e Event name
2512
+ * @param {object} params Event parameters
2513
+ * @param {object} params.event Event object
2514
+ * @param {Core.widget.Tool} params.event.source This Panel.
2515
+ * @param {Core.widget.Tool} params.event.tool The tool which is being clicked.
2516
+ */
2517
+ (e: 'toolClick', params: ((event: { source: Tool, tool: Tool }) => void)|string): void
2518
+ /**
2519
+ * Fires when one of the child views is painted. That is when it becomes visible.
2520
+ * Note that due to the slide-in animation, while the view is visible, it will not
2521
+ * yet be in its final position.
2522
+ * @param {string} e Event name
2523
+ * @param {object} params Event parameters
2524
+ * @param {object} params.event Event object
2525
+ * @param {CalendarView} params.event.source The widget being painted
2526
+ * @param {boolean} params.event.firstPaint `true` if this is the first paint
2527
+ */
2528
+ (e: 'viewPaint', params: ((event: { source: CalendarView, firstPaint: boolean }) => void)|string): void
2529
+ /**
2530
+ * Fires when a week number is clicked or activated by the <kbd>ENTER</kbd> key. This will include the week number cells of a
2531
+ * [YearView](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView), the week number in the first cell
2532
+ * in each row of a [MonthView](https://bryntum.com/products/calendar/docs/api/Calendar/widget/MonthView)
2533
+ * ...
2534
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/view/Calendar#event-weekNumberClick)
2535
+ * @param {string} e Event name
2536
+ * @param {object} params Event parameters
2537
+ * @param {object} params.event Event object
2538
+ * @param {CalendarView} params.event.source The view which triggered the event.
2539
+ * @param {Event} params.event.domEvent The initiating DOM event.
2540
+ * @param {number[]} params.event.week The `[year, week]` clicked on.
2541
+ * @param {Date} params.event.date The date clicked on.
2542
+ */
2543
+ (e: 'weekNumberClick', params: ((event: { source: CalendarView, domEvent: Event, week: number[], date: Date }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
2544
+ }>();
2545
+
2546
+ const widgetData = {
2547
+ instanceClass : Calendar,
2548
+ instanceName : 'Calendar',
2549
+
2550
+ isView : true,
2551
+ dataStores : {
2552
+ 'assignmentStore': 'assignments',
2553
+ 'dependencyStore': 'dependencies',
2554
+ 'eventStore': 'events',
2555
+ 'resourceStore': 'resources',
2556
+ 'resourceTimeRangeStore': 'resourceTimeRanges',
2557
+ 'timeRangeStore': 'timeRanges'
2558
+ },
2559
+ projectStores : true,
2560
+ featureNames : [
2561
+ 'dragFeature',
2562
+ 'eventBufferFeature',
2563
+ 'eventCopyPasteFeature',
2564
+ 'eventEditFeature',
2565
+ 'eventMenuFeature',
2566
+ 'eventTooltipFeature',
2567
+ 'excelExporterFeature',
2568
+ 'externalEventSourceFeature',
2569
+ 'loadOnDemandFeature',
2570
+ 'printFeature',
2571
+ 'scheduleMenuFeature',
2572
+ 'scheduleTooltipFeature',
2573
+ 'timeRangesFeature',
2574
+ 'weekExpanderFeature'
2575
+ ],
2576
+
2577
+ configNames : [
2578
+ 'adopt',
2579
+ 'align',
2580
+ 'anchor',
2581
+ 'ariaDescription',
2582
+ 'ariaLabel',
2583
+ 'assignmentStore',
2584
+ 'autoCreate',
2585
+ 'bbar',
2586
+ 'bodyCls',
2587
+ 'bubbleEvents',
2588
+ 'centered',
2589
+ 'collapsible',
2590
+ 'color',
2591
+ 'config',
2592
+ 'constrainTo',
2593
+ 'contentElementCls',
2594
+ 'contextMenuTriggerEvent',
2595
+ 'crudManagerClass',
2596
+ 'dataField',
2597
+ 'datePicker',
2598
+ 'defaultBindProperty',
2599
+ 'defaultFocus',
2600
+ 'defaults',
2601
+ 'deselectOnClick',
2602
+ 'destroyStores',
2603
+ 'detectCSSCompatibilityIssues',
2604
+ 'dock',
2605
+ 'draggable',
2606
+ 'drawer',
2607
+ 'elementAttributes',
2608
+ 'enableDeleteKey',
2609
+ 'enableRecurringEvents',
2610
+ 'enableUndoRedoKeys',
2611
+ 'eventSelectionDisabled',
2612
+ 'eventStore',
2613
+ 'filterEventResources',
2614
+ 'floating',
2615
+ 'footer',
2616
+ 'header',
2617
+ 'hideAnimation',
2618
+ 'hideWhenEmpty',
2619
+ 'highlightDate',
2620
+ 'highlightPredecessors',
2621
+ 'highlightSuccessors',
2622
+ 'icon',
2623
+ 'ignoreParentReadOnly',
2624
+ 'includeWeekendsButton',
2625
+ 'itemCls',
2626
+ 'lazyItems',
2627
+ 'listeners',
2628
+ 'loadMask',
2629
+ 'loadMaskDefaults',
2630
+ 'loadMaskError',
2631
+ 'localeClass',
2632
+ 'localizable',
2633
+ 'localizableProperties',
2634
+ 'maintainSelectionOnDatasetChange',
2635
+ 'maskDefaults',
2636
+ 'masked',
2637
+ 'monitorResize',
2638
+ 'multiEventSelect',
2639
+ 'namedItems',
2640
+ 'navigatorPlacement',
2641
+ 'overlaySidebar',
2642
+ 'owner',
2643
+ 'positioned',
2644
+ 'preventTooltipOnTouch',
2645
+ 'propagatedConfigs',
2646
+ 'relayStoreEvents',
2647
+ 'resourceImagePath',
2648
+ 'resourceStore',
2649
+ 'resourceTimeRangeStore',
2650
+ 'responsive',
2651
+ 'responsiveRoot',
2652
+ 'responsiveState',
2653
+ 'responsiveTarget',
2654
+ 'ripple',
2655
+ 'rootElement',
2656
+ 'scrollAction',
2657
+ 'showAnimation',
2658
+ 'showRecurringUI',
2659
+ 'showTooltipWhenDisabled',
2660
+ 'sidebar',
2661
+ 'stateful',
2662
+ 'statefulEvents',
2663
+ 'stateId',
2664
+ 'stateProvider',
2665
+ 'strips',
2666
+ 'syncMask',
2667
+ 'tab',
2668
+ 'tabBarItems',
2669
+ 'tag',
2670
+ 'tbar',
2671
+ 'textAlign',
2672
+ 'timeRangeStore',
2673
+ 'timeZone',
2674
+ 'trapFocus',
2675
+ 'triggerSelectionChangeOnRemove',
2676
+ 'type',
2677
+ 'ui',
2678
+ 'viewContainer',
2679
+ 'weekStartDay',
2680
+ 'weight'
2681
+ ],
2682
+ propertyConfigNames : [
2683
+ 'activeDateCls',
2684
+ 'alignSelf',
2685
+ 'appendTo',
2686
+ 'assignments',
2687
+ 'callOnFunctions',
2688
+ 'catchEventHandlerExceptions',
2689
+ 'cls',
2690
+ 'collapsed',
2691
+ 'column',
2692
+ 'crudManager',
2693
+ 'dataset',
2694
+ 'date',
2695
+ 'dateFormat',
2696
+ 'defaultCalendar',
2697
+ 'deselectAllOnScheduleClick',
2698
+ 'disabled',
2699
+ 'events',
2700
+ 'extraData',
2701
+ 'flex',
2702
+ 'height',
2703
+ 'hidden',
2704
+ 'hideNonWorkingDays',
2705
+ 'id',
2706
+ 'inputFieldAlign',
2707
+ 'insertBefore',
2708
+ 'insertFirst',
2709
+ 'isEventSelectable',
2710
+ 'items',
2711
+ 'keyMap',
2712
+ 'labelPosition',
2713
+ 'layout',
2714
+ 'layoutStyle',
2715
+ 'margin',
2716
+ 'maxDate',
2717
+ 'maxHeight',
2718
+ 'maximizeOnMobile',
2719
+ 'maxWidth',
2720
+ 'minDate',
2721
+ 'minHeight',
2722
+ 'minWidth',
2723
+ 'mode',
2724
+ 'modeDefaults',
2725
+ 'modes',
2726
+ 'nonWorkingDays',
2727
+ 'onActiveItemChange',
2728
+ 'onAfterEventEdit',
2729
+ 'onAfterEventSave',
2730
+ 'onBeforeActiveItemChange',
2731
+ 'onBeforeAssignmentDelete',
2732
+ 'onBeforeAssignmentSelectionChange',
2733
+ 'onBeforeAutoCreate',
2734
+ 'onBeforeCopy',
2735
+ 'onBeforeCreateMode',
2736
+ 'onBeforeCSVExport',
2737
+ 'onBeforeDestroy',
2738
+ 'onBeforeDragCreate',
2739
+ 'onBeforeDragCreateEnd',
2740
+ 'onBeforeDragMove',
2741
+ 'onBeforeDragMoveEnd',
2742
+ 'onBeforeDragResize',
2743
+ 'onBeforeDragResizeEnd',
2744
+ 'onBeforeDropExternal',
2745
+ 'onBeforeEventDelete',
2746
+ 'onBeforeEventEdit',
2747
+ 'onBeforeEventEditShow',
2748
+ 'onBeforeEventSave',
2749
+ 'onBeforeEventSelectionChange',
2750
+ 'onBeforeExcelExport',
2751
+ 'onBeforeHide',
2752
+ 'onBeforePaste',
2753
+ 'onBeforePrint',
2754
+ 'onBeforeResponsiveStateChange',
2755
+ 'onBeforeSetRecord',
2756
+ 'onBeforeShow',
2757
+ 'onBeforeStateApply',
2758
+ 'onBeforeStateSave',
2759
+ 'onCatchAll',
2760
+ 'onCellOverflowClick',
2761
+ 'onCollapse',
2762
+ 'onContextMenuItem',
2763
+ 'onContextMenuToggleItem',
2764
+ 'onCopy',
2765
+ 'onCurrentTimelineUpdate',
2766
+ 'onDataChange',
2767
+ 'onDateChange',
2768
+ 'onDateRangeChange',
2769
+ 'onDateRangeLoad',
2770
+ 'onDateRangeRequested',
2771
+ 'onDayCellPopulated',
2772
+ 'onDayNumberClick',
2773
+ 'onDestroy',
2774
+ 'onDirtyStateChange',
2775
+ 'onDragCreateEnd',
2776
+ 'onDragMoveEnd',
2777
+ 'onDragMoveExternal',
2778
+ 'onDragResizeEnd',
2779
+ 'onDropExternal',
2780
+ 'onElementCreated',
2781
+ 'onEmptyCellClick',
2782
+ 'onEventAutoCreated',
2783
+ 'onEventClick',
2784
+ 'onEventContextMenu',
2785
+ 'onEventDblClick',
2786
+ 'onEventEditBeforeSetRecord',
2787
+ 'onEventKeyDown',
2788
+ 'onEventMenuBeforeShow',
2789
+ 'onEventMenuItem',
2790
+ 'onEventMenuShow',
2791
+ 'onEventMouseDown',
2792
+ 'onEventMouseEnter',
2793
+ 'onEventMouseLeave',
2794
+ 'onEventMouseOut',
2795
+ 'onEventMouseOver',
2796
+ 'onEventMouseUp',
2797
+ 'onEventPropagate',
2798
+ 'onExpand',
2799
+ 'onFocusIn',
2800
+ 'onFocusOut',
2801
+ 'onHide',
2802
+ 'onLoadOnDemandFail',
2803
+ 'onMonthNameClick',
2804
+ 'onNavigate',
2805
+ 'onPaint',
2806
+ 'onPaste',
2807
+ 'onPasteNotAllowed',
2808
+ 'onReadOnly',
2809
+ 'onRecompose',
2810
+ 'onRefresh',
2811
+ 'onResize',
2812
+ 'onResourceClick',
2813
+ 'onResponsiveStateChange',
2814
+ 'onScheduleClick',
2815
+ 'onScheduleContextMenu',
2816
+ 'onScheduleDblClick',
2817
+ 'onScheduleMenuBeforeShow',
2818
+ 'onScheduleMenuItem',
2819
+ 'onScheduleMenuShow',
2820
+ 'onScheduleMouseDown',
2821
+ 'onScheduleMouseOut',
2822
+ 'onScheduleMouseOver',
2823
+ 'onScheduleMouseUp',
2824
+ 'onSelectionChange',
2825
+ 'onShow',
2826
+ 'onSidebarCollapse',
2827
+ 'onSidebarExpand',
2828
+ 'onTimeAxisClick',
2829
+ 'onTimeRangeHeaderClick',
2830
+ 'onTimeRangeHeaderContextMenu',
2831
+ 'onTimeRangeHeaderDblClick',
2832
+ 'onToolClick',
2833
+ 'onViewPaint',
2834
+ 'onWeekNumberClick',
2835
+ 'project',
2836
+ 'readOnly',
2837
+ 'recurrenceConfirmationPopup',
2838
+ 'rendition',
2839
+ 'resources',
2840
+ 'resourceTimeRanges',
2841
+ 'rtl',
2842
+ 'scrollable',
2843
+ 'selectResourceOnEventNavigate',
2844
+ 'selectResourceOnScheduleClick',
2845
+ 'span',
2846
+ 'strictRecordMapping',
2847
+ 'timeRanges',
2848
+ 'title',
2849
+ 'tools',
2850
+ 'tooltip',
2851
+ 'useContextualRecurrenceRules',
2852
+ 'width',
2853
+ 'x',
2854
+ 'y'
2855
+ ],
2856
+ propertyNames : [
2857
+ 'activeSubView',
2858
+ 'activeView',
2859
+ 'anchorSize',
2860
+ 'focusVisible',
2861
+ 'hasChanges',
2862
+ 'isEngineReady',
2863
+ 'isSettingValues',
2864
+ 'isValid',
2865
+ 'parent',
2866
+ 'record',
2867
+ 'selectedEvents',
2868
+ 'state',
2869
+ 'values',
2870
+ 'views'
2871
+ ],
2872
+ eventNames : [
2873
+ 'activeItemChange',
2874
+ 'afterEventEdit',
2875
+ 'afterEventSave',
2876
+ 'beforeActiveItemChange',
2877
+ 'beforeAssignmentDelete',
2878
+ 'beforeAssignmentSelectionChange',
2879
+ 'beforeAutoCreate',
2880
+ 'beforeCopy',
2881
+ 'beforeCreateMode',
2882
+ 'beforeCSVExport',
2883
+ 'beforeDestroy',
2884
+ 'beforeDragCreate',
2885
+ 'beforeDragCreateEnd',
2886
+ 'beforeDragMove',
2887
+ 'beforeDragMoveEnd',
2888
+ 'beforeDragResize',
2889
+ 'beforeDragResizeEnd',
2890
+ 'beforeDropExternal',
2891
+ 'beforeEventDelete',
2892
+ 'beforeEventEdit',
2893
+ 'beforeEventEditShow',
2894
+ 'beforeEventSave',
2895
+ 'beforeEventSelectionChange',
2896
+ 'beforeExcelExport',
2897
+ 'beforeHide',
2898
+ 'beforePaste',
2899
+ 'beforePrint',
2900
+ 'beforeResponsiveStateChange',
2901
+ 'beforeSetRecord',
2902
+ 'beforeShow',
2903
+ 'beforeStateApply',
2904
+ 'beforeStateSave',
2905
+ 'catchAll',
2906
+ 'cellOverflowClick',
2907
+ 'collapse',
2908
+ 'contextMenuItem',
2909
+ 'contextMenuToggleItem',
2910
+ 'copy',
2911
+ 'currentTimelineUpdate',
2912
+ 'dataChange',
2913
+ 'dateChange',
2914
+ 'dateRangeChange',
2915
+ 'dateRangeLoad',
2916
+ 'dateRangeRequested',
2917
+ 'dayCellPopulated',
2918
+ 'dayNumberClick',
2919
+ 'destroy',
2920
+ 'dirtyStateChange',
2921
+ 'dragCreateEnd',
2922
+ 'dragMoveEnd',
2923
+ 'dragMoveExternal',
2924
+ 'dragResizeEnd',
2925
+ 'dropExternal',
2926
+ 'elementCreated',
2927
+ 'emptyCellClick',
2928
+ 'eventAutoCreated',
2929
+ 'eventClick',
2930
+ 'eventContextMenu',
2931
+ 'eventDblClick',
2932
+ 'eventEditBeforeSetRecord',
2933
+ 'eventKeyDown',
2934
+ 'eventMenuBeforeShow',
2935
+ 'eventMenuItem',
2936
+ 'eventMenuShow',
2937
+ 'eventMouseDown',
2938
+ 'eventMouseEnter',
2939
+ 'eventMouseLeave',
2940
+ 'eventMouseOut',
2941
+ 'eventMouseOver',
2942
+ 'eventMouseUp',
2943
+ 'eventPropagate',
2944
+ 'expand',
2945
+ 'focusIn',
2946
+ 'focusOut',
2947
+ 'hide',
2948
+ 'loadOnDemandFail',
2949
+ 'monthNameClick',
2950
+ 'navigate',
2951
+ 'paint',
2952
+ 'paste',
2953
+ 'pasteNotAllowed',
2954
+ 'readOnly',
2955
+ 'recompose',
2956
+ 'refresh',
2957
+ 'resize',
2958
+ 'resourceClick',
2959
+ 'responsiveStateChange',
2960
+ 'scheduleClick',
2961
+ 'scheduleContextMenu',
2962
+ 'scheduleDblClick',
2963
+ 'scheduleMenuBeforeShow',
2964
+ 'scheduleMenuItem',
2965
+ 'scheduleMenuShow',
2966
+ 'scheduleMouseDown',
2967
+ 'scheduleMouseOut',
2968
+ 'scheduleMouseOver',
2969
+ 'scheduleMouseUp',
2970
+ 'selectionChange',
2971
+ 'show',
2972
+ 'sidebarCollapse',
2973
+ 'sidebarExpand',
2974
+ 'timeAxisClick',
2975
+ 'timeRangeHeaderClick',
2976
+ 'timeRangeHeaderContextMenu',
2977
+ 'timeRangeHeaderDblClick',
2978
+ 'toolClick',
2979
+ 'viewPaint',
2980
+ 'weekNumberClick'
2981
+ ]
2982
+ };
2983
+
2984
+ const instance: {
2985
+ value?: Calendar
2986
+ } = {};
2987
+
2988
+ const refElement = ref<HTMLDivElement>()!;
2989
+ // Storage for teleports (in-cell Vue component instances) automatically renderer by template
2990
+ const teleports = ref(new Map());
2991
+
2992
+ // Provide teleports for processCellContent
2993
+ provide('teleports', teleports);
2994
+
2995
+ onMounted(() => {
2996
+
2997
+ const me = getCurrentInstance()!;
2998
+
2999
+ instance.value = WrapperHelper.createWidget<typeof Calendar>({
3000
+ me,
3001
+ widgetData,
3002
+ emit,
3003
+ element : refElement.value!,
3004
+ processCellContent : WrapperHelper.processCellContent,
3005
+ processEventContent : WrapperHelper.processEventContent,
3006
+ processWidgetContent : WrapperHelper.processWidgetContent,
3007
+ hasFrameworkRenderer : WrapperHelper.hasFrameworkRenderer,
3008
+ toRaw
3009
+ });
3010
+ WrapperHelper.relayStores(me.data, instance.value);
3011
+
3012
+ const watcher = (prop: string, callback: any) => watch(() => me.props[prop], callback);
3013
+ WrapperHelper.watchProps(instance.value, widgetData, watcher);
3014
+ });
3015
+
3016
+ onBeforeUnmount(() => {
3017
+ // @ts-ignore
3018
+ instance.value?.destroy?.();
3019
+ });
3020
+
3021
+ defineExpose({
3022
+ instance,
3023
+ refElement,
3024
+ teleports
3025
+ });
3026
+
3027
+ </script>