@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,2759 @@
1
+ <!-- Vue 3 wrapper for Bryntum Grid -->
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 { AIFilter, AIFilterConfig, AjaxStore, AjaxStoreConfig, Base, CellCopyPaste, CellCopyPasteConfig, CellEdit, CellEditConfig, CellEditorContext, CellMenu, CellMenuConfig, CellTooltip, CellTooltipConfig, Charts, ChartsConfig, Column, ColumnAutoWidth, ColumnAutoWidthConfig, ColumnDragToolbar, ColumnDragToolbarConfig, ColumnPicker, ColumnPickerConfig, ColumnRename, ColumnRenameConfig, ColumnReorder, ColumnReorderConfig, ColumnResize, ColumnResizeConfig, ColumnStore, ColumnStoreConfig, Container, ContainerItemConfig, DomConfig, EmptyTextDomConfig, ExportConfig, FileDrop, FileDropConfig, FillHandle, FillHandleConfig, Filter, FilterBar, FilterBarConfig, FilterConfig, FormulaProviderConfig, GridBase, GridColumnConfig, GridExcelExporter, GridExcelExporterConfig, GridGroupSummary, GridGroupSummaryConfig, GridListeners, GridLocation, GridLocationConfig, GridLockRows, GridLockRowsConfig, GridPdfExport, GridPdfExportConfig, GridPrint, GridPrintConfig, GridRowReorder, GridRowReorderConfig, GridRowResize, GridRowResizeConfig, GridSelectionMode, GridSplit, GridSplitConfig, GridStateInfo, GridSummary, GridSummaryConfig, Group, GroupConfig, HeaderMenu, HeaderMenuConfig, KeyMapConfig, Mask, MaskConfig, Menu, MenuItem, MenuItemEntry, MergeCells, MergeCellsConfig, Model, ModelConfig, PagingToolbarConfig, Panel, PanelCollapserConfig, PanelCollapserOverlayConfig, PanelHeader, PinColumns, PinColumnsConfig, PreserveScrollOptions, QuickFind, QuickFindConfig, RecordPositionContext, RegionResize, RegionResizeConfig, ResponsiveLevelConfig, Row, RowCopyPaste, RowCopyPasteConfig, RowEdit, RowEditConfig, RowEditorContext, RowExpander, RowExpanderConfig, ScrollManager, ScrollManagerConfig, Scroller, ScrollerConfig, Search, SearchConfig, Sort, SortConfig, StateProvider, StickyCells, StickyCellsConfig, Store, StoreConfig, Stripe, StripeConfig, SubGrid, SubGridConfig, TabConfig, Tool, ToolConfig, ToolbarConfig, ToolbarItems, Tree, TreeConfig, TreeGroup, TreeGroupConfig, Widget, XLSColumn } from '@bryntum/calendar';
37
+ import { Grid } from '@bryntum/calendar';
38
+
39
+ import { WrapperHelper } from '../helper/WrapperHelper';
40
+
41
+ defineProps<{
42
+ // Configs
43
+ /**
44
+ * Element (or element id) to adopt as this Widget's encapsulating element. The widget's
45
+ * content will be placed inside this element.
46
+ * ...
47
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-adopt)
48
+ */
49
+ adopt ? : HTMLElement|string
50
+ /**
51
+ * 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
52
+ * flexbox layout. This config allows you to set this widget's
53
+ * [align-self](https://developer.mozilla.org/en-US/docs/Web/CSS/align-self) style.
54
+ */
55
+ alignSelf ? : string
56
+ /**
57
+ * Set to `true` to animate row removals caused by filtering.
58
+ * @deprecated 7.0.0 Deprecated `animateFilterRemovals`. Use `transition.filterRemoval` instead
59
+ */
60
+ animateFilterRemovals ? : Boolean
61
+ /**
62
+ * Controls if removing and inserting rows should be animated. Set to `false` to prevent those animations,
63
+ * removing the related delays.
64
+ * @deprecated 7.0.0 Deprecated `animateRemovingRows`. Use `transition.removeRecord` instead
65
+ */
66
+ animateRemovingRows ? : Boolean
67
+ /**
68
+ * When the [Tree](https://bryntum.com/products/calendar/docs/api/Grid/feature/Tree) feature is in use and the Store is a tree store, this
69
+ * config may be set to `true` to visually animate branch node expand and collapse operations.
70
+ * *This is not supported in Scheduler and Gantt*
71
+ * @deprecated 7.0.0 Deprecated `animateTreeNodeToggle`. Use `transition.toggleTreeNode` instead
72
+ */
73
+ animateTreeNodeToggle ? : 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/Grid/view/Grid#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/Grid/view/Grid#config-ariaLabel)
91
+ */
92
+ ariaLabel ? : string
93
+ /**
94
+ * Automatically set grids height to fit all rows (no scrolling in the grid). In general you should avoid
95
+ * using `autoHeight: true`, since it will bypass Grids virtual rendering and render all rows at once, which
96
+ * in a larger grid is really bad for performance.
97
+ */
98
+ autoHeight ? : Boolean
99
+ /**
100
+ * A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/calendar/docs/api/Core/widget/Toolbar),
101
+ * or array of config objects representing the child items of a Toolbar. Another way to add a bbar is to use [strips](https://bryntum.com/products/calendar/docs/api/Core/widget/Panel#config-strips).
102
+ * ...
103
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-bbar)
104
+ */
105
+ bbar ? : (ContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
106
+ /**
107
+ * Custom CSS classes to add to the panel's body element.
108
+ * ...
109
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-bodyCls)
110
+ */
111
+ bodyCls ? : string|object
112
+ /**
113
+ * An object where property names with a truthy value indicate which events should bubble up the ownership
114
+ * hierarchy when triggered.
115
+ * ...
116
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-bubbleEvents)
117
+ */
118
+ bubbleEvents ? : object
119
+ /**
120
+ * Set to `false` to not call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
121
+ * ...
122
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-callOnFunctions)
123
+ */
124
+ callOnFunctions ? : Boolean
125
+ /**
126
+ * By default, if an event handler throws an exception, the error propagates up the stack and the
127
+ * application state is undefined. Code which follows the event handler will *not* be executed.
128
+ * ...
129
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-catchEventHandlerExceptions)
130
+ */
131
+ catchEventHandlerExceptions ? : Boolean
132
+ /**
133
+ * Set to `false` to crop text in grid cells without ellipsis (...). When enabled, cells containing pure
134
+ * use `display : block`, instead of `display : flex` to allow ellipsis to work.
135
+ * <strong>NOTE</strong> Only supported in browsers that support `:has()` CSS selector
136
+ */
137
+ cellEllipsis ? : Boolean
138
+ /**
139
+ * Custom CSS classes to add to element.
140
+ * May be specified as a space separated string, or as an object in which property names
141
+ * with truthy values are used as the class names:
142
+ * ...
143
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-cls)
144
+ */
145
+ cls ? : string|object
146
+ /**
147
+ * Controls whether the panel is collapsed (the body of the panel is hidden while only the header is
148
+ * visible). Only valid if the panel is [collapsible](https://bryntum.com/products/calendar/docs/api/Core/widget/Panel#config-collapsible).
149
+ */
150
+ collapsed ? : Boolean
151
+ /**
152
+ * This config enables collapsibility for the panel. See [collapsed](https://bryntum.com/products/calendar/docs/api/Core/widget/Panel#config-collapsed).
153
+ * ...
154
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-collapsible)
155
+ */
156
+ collapsible ? : Boolean|PanelCollapserConfig|PanelCollapserOverlayConfig
157
+ /**
158
+ * Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
159
+ * `style` block.
160
+ * ...
161
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-color)
162
+ */
163
+ color ? : string
164
+ /**
165
+ * Programmatic control over which column to start in when used in a grid layout.
166
+ */
167
+ column ? : number
168
+ /**
169
+ * Set to `false` to not show column lines. End result might be overruled by/differ between themes.
170
+ */
171
+ columnLines ? : Boolean
172
+ /**
173
+ * Accepts column definitions for the grid during initialization. They will be used to create
174
+ * [Column](https://bryntum.com/products/calendar/docs/api/Grid/column/Column) instances that are added to a [ColumnStore](#Grid/data/ColumnStore).
175
+ * ...
176
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-columns)
177
+ */
178
+ columns ? : ColumnStore|GridColumnConfig[]|ColumnStoreConfig
179
+ config ? : object
180
+ /**
181
+ * Custom CSS classes to add to the [contentElement](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#property-contentElement).
182
+ * May be specified as a space separated string, or as an object in which property names
183
+ * with truthy values are used as the class names:
184
+ * ...
185
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-contentElementCls)
186
+ */
187
+ contentElementCls ? : string|object
188
+ /**
189
+ * Event which is used to show context menus.
190
+ * Available options are: 'contextmenu', 'click', 'dblclick'.
191
+ */
192
+ contextMenuTriggerEvent ? : 'contextmenu'|'click'|'dblclick'
193
+ /**
194
+ * Convenient shortcut to set data in grids store both during initialization and at runtime. Can also be
195
+ * used to retrieve data at runtime, although we do recommend interacting with Grids store instead using
196
+ * the [store](https://bryntum.com/products/calendar/docs/api/Grid/view/GridBase#property-store) property.
197
+ * ...
198
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-data)
199
+ */
200
+ data ? : object[]|Model[]|ModelConfig[]
201
+ /**
202
+ * When this Widget configuration is used in the Grid's RowExpander feature's `widget` config, provide the
203
+ * field on the expanded record to use for populating this widget's store (if applicable)
204
+ */
205
+ dataField ? : string
206
+ /**
207
+ * Object to apply to elements dataset (each key will be used as a data-attribute on the element)
208
+ */
209
+ dataset ? : Record<string, string>
210
+ /**
211
+ * Region to which columns are added when they have none specified
212
+ */
213
+ defaultRegion ? : string
214
+ /**
215
+ * Set to `true` to destroy the store when the grid is destroyed.
216
+ */
217
+ destroyStore ? : Boolean
218
+ /**
219
+ * Check for CSS compatibility issues when upgrading to v7. Performs the following checks:
220
+ * ...
221
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-detectCSSCompatibilityIssues)
222
+ */
223
+ detectCSSCompatibilityIssues ? : Boolean
224
+ /**
225
+ * 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
226
+ * cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
227
+ * ...
228
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-disabled)
229
+ */
230
+ disabled ? : Boolean|'inert'
231
+ /**
232
+ * Set to `true` to not get a warning when calling [getState](https://bryntum.com/products/calendar/docs/api/Grid/view/GridBase#function-getState) when there is a column
233
+ * configured without an `id`. But the recommended action is to always configure columns with an `id` when
234
+ * using states.
235
+ */
236
+ disableGridColumnIdWarning ? : Boolean
237
+ /**
238
+ * Set to `true` to not get a warning when using another base class than GridRowModel for your grid data. If
239
+ * you do, and would like to use the full feature set of the grid then include the fields from GridRowModel
240
+ * in your model definition.
241
+ */
242
+ disableGridRowModelWarning ? : Boolean
243
+ /**
244
+ * Controls the placement of this widget when it is added to a [panel's ](https://bryntum.com/products/calendar/docs/api/Core/widget/Panel)
245
+ * [strips collection](https://bryntum.com/products/calendar/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
246
+ * `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
247
+ * body. Such widgets are called "edge strips".
248
+ * ...
249
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-dock)
250
+ */
251
+ dock ? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
252
+ /**
253
+ * Make this Panel a docked drawer which slides out from one side of the browser viewport by default.
254
+ * ...
255
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-drawer)
256
+ * @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.
257
+ * @param {string,number} size The size of the drawer in its collapsible axis.
258
+ * @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.
259
+ * @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.
260
+ * @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.
261
+ * @param {boolean,string} autoClose.focusout If focus moves outside of the drawer, the drawer will automatically be hidden.
262
+ * @param {string} autoClose.mouseout Hides the drawer when the mouse leaves the drawer after the `autoCloseDelay` period.
263
+ * @param {number} autoCloseDelay When using `mouseout`, this is the delay in milliseconds
264
+ */
265
+ 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}
266
+ /**
267
+ * An object specifying attributes to assign to the root element of this widget.
268
+ * Set `null` value to attribute to remove it.
269
+ * ...
270
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-elementAttributes)
271
+ */
272
+ elementAttributes ? : Record<string, string|null>
273
+ /**
274
+ * Text or HTML, or a [EmptyTextDomConfig](https://bryntum.com/products/calendar/docs/api/Grid/view/GridBase#typedef-EmptyTextDomConfig) block to display when there is no data to display in the grid.
275
+ * When using multiple Grid regions, provide the `region` property to decide where the text is shown.
276
+ * By default, it is shown in the first region.
277
+ * ...
278
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-emptyText)
279
+ */
280
+ emptyText ? : string|EmptyTextDomConfig
281
+ /**
282
+ * Configure this as `true` to allow elements within cells to be styled as `position: sticky`.
283
+ * ...
284
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-enableSticky)
285
+ */
286
+ enableSticky ? : Boolean
287
+ /**
288
+ * Set to `true` to allow text selection in the grid cells. Note, this cannot be used simultaneously with the
289
+ * `RowReorder` feature.
290
+ */
291
+ enableTextSelection ? : Boolean
292
+ /**
293
+ * Set to `true` to listen for CTRL-Z (CMD-Z on Mac OS) keyboard event and trigger undo (redo when SHIFT is
294
+ * pressed). Only applicable when using a [StateTrackingManager](https://bryntum.com/products/calendar/docs/api/Core/data/stm/StateTrackingManager).
295
+ */
296
+ enableUndoRedoKeys ? : Boolean
297
+ extraData ? : any
298
+ /**
299
+ * Set to `true` to stretch the last column in a grid with all fixed width columns
300
+ * to fill extra available space if the grid's width is wider than the sum of all
301
+ * configured column widths.
302
+ */
303
+ fillLastColumn ? : Boolean
304
+ /**
305
+ * Use fixed row height. Setting this to `true` will configure the underlying RowManager to use fixed row
306
+ * height, which sacrifices the ability to use rows with variable height to gain a fraction better
307
+ * performance.
308
+ * ...
309
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-fixedRowHeight)
310
+ */
311
+ fixedRowHeight ? : Boolean
312
+ /**
313
+ * 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
314
+ * flexbox layout. This config allows you to set this widget's
315
+ * [flex](https://developer.mozilla.org/en-US/docs/Web/CSS/flex) style.
316
+ * This may be configured as a single number or a `&lt;flex-grow&gt; &lt;flex-shrink&gt; &lt;flex-basis&gt;` format string.
317
+ * numeric-only values are interpreted as the `flex-grow` value.
318
+ */
319
+ flex ? : number|string
320
+ /**
321
+ * Config object of a footer. May contain a `dock`, `html` and a `cls` property. A footer is not a widget,
322
+ * 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).
323
+ * ...
324
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-footer)
325
+ */
326
+ footer ? : {
327
+ dock?: 'top'|'right'|'bottom'|'left'|'start'|'end'
328
+ html?: string
329
+ cls?: string
330
+ }|string
331
+ /**
332
+ * An object which names formula prefixes which will be applied to all columns configured with
333
+ * `formula : true`.
334
+ * ...
335
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-formulaProviders)
336
+ */
337
+ formulaProviders ? : Record<string, FormulaProviderConfig>
338
+ /**
339
+ * Refresh entire row when a record changes (`true`) or, if possible, only the cells affected (`false`).
340
+ * ...
341
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-fullRowRefresh)
342
+ */
343
+ fullRowRefresh ? : Boolean
344
+ /**
345
+ * A function called for each row to determine its height. It is passed a [record](https://bryntum.com/products/calendar/docs/api/Core/data/Model) and
346
+ * expected to return the desired height of that records row. If the function returns a falsy value, Grids
347
+ * configured [rowHeight](https://bryntum.com/products/calendar/docs/api/Grid/view/GridBase#config-rowHeight) is used.
348
+ * ...
349
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-getRowHeight)
350
+ * @param {Core.data.Model} getRowHeight.record Record to determine row height for
351
+ * @returns {number} Desired row height
352
+ */
353
+ getRowHeight ? : (getRowHeight: { record: Model }) => number
354
+ /**
355
+ * 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`.
356
+ * ...
357
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-header)
358
+ */
359
+ header ? : string|Boolean|PanelHeader
360
+ /**
361
+ * Widget's height, used to set element `style.height`. Either specify a valid height string or a number,
362
+ * which will get 'px' appended. We recommend using CSS as the primary way to control height, but in some
363
+ * cases this config is convenient.
364
+ */
365
+ height ? : string|number
366
+ /**
367
+ * Configure with true to make widget initially hidden.
368
+ */
369
+ hidden ? : Boolean
370
+ /**
371
+ * Set to `true` to hide the footer elements
372
+ */
373
+ hideFooters ? : Boolean
374
+ /**
375
+ * Set to `true` to hide the column header elements
376
+ */
377
+ hideHeaders ? : Boolean
378
+ /**
379
+ * Set to `true` to hide the Grid's horizontal scrollbar(s)
380
+ */
381
+ hideHorizontalScrollbar ? : Boolean
382
+ /**
383
+ * A CSS class to add to hovered row elements
384
+ */
385
+ hoverCls ? : string
386
+ /**
387
+ * 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
388
+ * [DomConfig](https://bryntum.com/products/calendar/docs/api/Core/helper/DomHelper#typedef-DomConfig) object describing an element to represent the icon.
389
+ */
390
+ icon ? : string|DomConfig
391
+ /**
392
+ * Widget id, if not specified one will be generated. Also used for lookups through Widget.getById
393
+ */
394
+ id ? : string
395
+ /**
396
+ * Determines if the widgets read-only state should be controlled by its parent.
397
+ * ...
398
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-ignoreParentReadOnly)
399
+ */
400
+ ignoreParentReadOnly ? : Boolean
401
+ /**
402
+ * Convenience setting to align input fields of child widgets. By default, the Field input element is
403
+ * placed immediately following the `label`. If you prefer to have all input fields aligned to the
404
+ * right, set this config to `'end'`.
405
+ * ...
406
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-inputFieldAlign)
407
+ */
408
+ inputFieldAlign ? : 'start'|'end'
409
+ /**
410
+ * 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.
411
+ */
412
+ insertBefore ? : HTMLElement|string
413
+ /**
414
+ * 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.
415
+ */
416
+ insertFirst ? : HTMLElement|string
417
+ /**
418
+ * See [Keyboard shortcuts](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#keyboard-shortcuts) for details
419
+ */
420
+ keyMap ? : Record<string, KeyMapConfig>
421
+ /**
422
+ * Convenience setting to use same label placement on all child widgets.
423
+ * ...
424
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-labelPosition)
425
+ */
426
+ labelPosition ? : 'before'|'above'|'align-before'|'auto'|null
427
+ /**
428
+ * The listener set for this object.
429
+ * ...
430
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-listeners)
431
+ */
432
+ listeners ? : GridListeners
433
+ /**
434
+ * 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
435
+ * operation, or Crud Manager is loading data from the sever. Set to `null` to disable default load mask.
436
+ */
437
+ loadMask ? : string|MaskConfig|null
438
+ /**
439
+ * A [Mask](https://bryntum.com/products/calendar/docs/api/Core/widget/Mask) config object to adjust the [maskDefaults](#Core/widget/Widget#config-maskDefaults)
440
+ * when data is loading. The message and optional configuration from the
441
+ * [loadMask](https://bryntum.com/products/calendar/docs/api/Core/mixin/LoadMaskable#config-loadMask) config take priority over these options, just as they do
442
+ * for `maskDefaults`, respectively.
443
+ * ...
444
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-loadMaskDefaults)
445
+ */
446
+ loadMaskDefaults ? : MaskConfig
447
+ /**
448
+ * A [Mask](https://bryntum.com/products/calendar/docs/api/Core/widget/Mask) config object to adjust the [maskDefaults](#Core/widget/Widget#config-maskDefaults)
449
+ * when an error occurs loading data.
450
+ * ...
451
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-loadMaskError)
452
+ */
453
+ loadMaskError ? : MaskConfig|Mask|Boolean
454
+ /**
455
+ * Set to `false` to disable localization of this object.
456
+ */
457
+ localizable ? : Boolean
458
+ /**
459
+ * Time in ms until a longpress is triggered
460
+ */
461
+ longPressTime ? : number
462
+ /**
463
+ * Widget's margin. This may be configured as a single number or a `TRBL` format string.
464
+ * numeric-only values are interpreted as pixels.
465
+ */
466
+ margin ? : number|string
467
+ /**
468
+ * Grids change the `maskDefaults` to cover only their `body` element.
469
+ */
470
+ maskDefaults ? : MaskConfig
471
+ /**
472
+ * Set to `true` to apply the default mask to the widget. Alternatively, this can be the mask message or a
473
+ * [Mask](https://bryntum.com/products/calendar/docs/api/Core/widget/Mask) config object.
474
+ */
475
+ masked ? : Boolean|string|MaskConfig
476
+ /**
477
+ * The element's maxHeight. Can be either a String or a Number (which will have 'px' appended). Note that
478
+ * like [height](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-height), *reading* the value will return the numeric value in pixels.
479
+ */
480
+ maxHeight ? : string|number
481
+ /**
482
+ * The elements maxWidth. Can be either a String or a Number (which will have 'px' appended). Note that
483
+ * like [width](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-width), *reading* the value will return the numeric value in pixels.
484
+ */
485
+ maxWidth ? : string|number
486
+ /**
487
+ * Grid's `min-height`. Defaults to `10em` to be sure that the Grid always has a height wherever it is
488
+ * inserted.
489
+ * ...
490
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-minHeight)
491
+ */
492
+ minHeight ? : string|number
493
+ /**
494
+ * The elements minWidth. Can be either a String or a Number (which will have 'px' appended). Note that
495
+ * like [width](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-width), *reading* the value will return the numeric value in pixels.
496
+ */
497
+ minWidth ? : string|number
498
+ /**
499
+ * Grid monitors window resize by default.
500
+ */
501
+ monitorResize ? : Boolean
502
+ /**
503
+ * The owning Widget of this Widget. If this Widget is directly contained (that is, it is one of the
504
+ * [items](https://bryntum.com/products/calendar/docs/api/Core/widget/Container#property-items) of a Container), this config will be ignored. In this case
505
+ * the owner is <strong>always</strong> the encapsulating Container.
506
+ * ...
507
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-owner)
508
+ */
509
+ owner ? : Widget|any
510
+ /**
511
+ * Specify plugins (an array of classes) in config
512
+ */
513
+ plugins ? : Function[]
514
+ /**
515
+ * True to preserve focused cell after loading new data
516
+ */
517
+ preserveFocusOnDatasetChange ? : Boolean
518
+ /**
519
+ * Preserve the grid's vertical scroll position when changesets are applied, as in the case of remote
520
+ * changes, or when stores are configured with [syncDataOnLoad](https://bryntum.com/products/calendar/docs/api/Core/data/Store#config-syncDataOnLoad).
521
+ */
522
+ preserveScroll ? : PreserveScrollOptions|Boolean
523
+ /**
524
+ * Specify `true` to preserve vertical scroll position after store actions that trigger a `refresh` event,
525
+ * such as loading new data and filtering.
526
+ */
527
+ preserveScrollOnDatasetChange ? : Boolean
528
+ /**
529
+ * Prevent tooltip from being displayed on touch devices. Useful for example for buttons that display a
530
+ * menu on click etc, since the tooltip would be displayed at the same time.
531
+ */
532
+ preventTooltipOnTouch ? : Boolean
533
+ /**
534
+ * Set to `true` to make the grid read-only, by disabling any UIs for modifying data.
535
+ * ...
536
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-readOnly)
537
+ */
538
+ readOnly ? : Boolean
539
+ relayStoreEvents ? : Boolean
540
+ /**
541
+ * Either a default `rendition` to apply to all child widgets, or a map of renditions keyed by child widget
542
+ * `type`.
543
+ * ...
544
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-rendition)
545
+ */
546
+ rendition ? : string|Record<string, string>|null
547
+ /**
548
+ * Configure this property to allow the widget/component to be resized. Pressing <kbd>Shift</kbd> while resizing will
549
+ * constrain the aspect ratio.
550
+ * ...
551
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-resizable)
552
+ */
553
+ resizable ? : Boolean|{
554
+ minWidth?: number
555
+ maxWidth?: number
556
+ minHeight?: number
557
+ maxHeight?: number
558
+ handles?: object
559
+ }
560
+ /**
561
+ * Set to `false` to only measure cell contents when double-clicking the edge between column headers.
562
+ */
563
+ resizeToFitIncludesHeader ? : Boolean
564
+ /**
565
+ * "Break points" for which responsive config to use for columns and css.
566
+ * ...
567
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-responsiveLevels)
568
+ */
569
+ responsiveLevels ? : Record<string, number|string|ResponsiveLevelConfig>
570
+ /**
571
+ * Configure as `true` to have the component display a translucent ripple when its
572
+ * [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
573
+ * current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
574
+ * ...
575
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-ripple)
576
+ */
577
+ ripple ? : Boolean|{
578
+ delegate?: string
579
+ color?: string
580
+ radius?: number
581
+ clip?: string
582
+ }
583
+ /**
584
+ * 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`
585
+ */
586
+ rootElement ? : ShadowRoot|HTMLElement
587
+ /**
588
+ * Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
589
+ * overriden by specifying a [rowHeight](https://bryntum.com/products/calendar/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
590
+ * a column [renderer](https://bryntum.com/products/calendar/docs/api/Grid/column/Column#config-renderer).
591
+ * ...
592
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-rowHeight)
593
+ */
594
+ rowHeight ? : number
595
+ /**
596
+ * Set to `false` to not show row lines. End result might be overruled by/differ between themes.
597
+ */
598
+ rowLines ? : Boolean
599
+ /**
600
+ * This may be configured as `true` to make the widget's element use the `direction:rtl` style.
601
+ * ...
602
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-rtl)
603
+ */
604
+ rtl ? : Boolean
605
+ /**
606
+ * Configures whether the grid is scrollable in the `Y` axis. This is used to configure a [Scroller](https://bryntum.com/products/calendar/docs/api/Core/helper/util/Scroller).
607
+ * See the [scrollerClass](https://bryntum.com/products/calendar/docs/api/Grid/view/GridBase#config-scrollerClass) config option.
608
+ * ...
609
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-scrollable)
610
+ */
611
+ scrollable ? : Boolean|ScrollerConfig|Scroller
612
+ /**
613
+ * The class to instantiate to use as the [scrollable](https://bryntum.com/products/calendar/docs/api/Grid/view/GridBase#config-scrollable). Defaults to [Scroller](#Core/helper/util/Scroller).
614
+ */
615
+ scrollerClass ? : typeof Scroller
616
+ /**
617
+ * Configuration values for the [ScrollManager](https://bryntum.com/products/calendar/docs/api/Core/util/ScrollManager) class on initialization. Returns the
618
+ * [ScrollManager](https://bryntum.com/products/calendar/docs/api/Core/util/ScrollManager) at runtime.
619
+ */
620
+ scrollManager ? : ScrollManagerConfig|ScrollManager
621
+ /**
622
+ * Selection configuration settings, change these properties to control how selection works and what can be
623
+ * selected.
624
+ * ...
625
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-selectionMode)
626
+ */
627
+ selectionMode ? : GridSelectionMode
628
+ /**
629
+ * Configure as `true` to have the grid show a red "changed" tag in cells whose
630
+ * field value has changed and not yet been committed.
631
+ * ...
632
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-showDirty)
633
+ */
634
+ showDirty ? : Boolean|{
635
+ duringEdit?: Boolean
636
+ newRecord?: Boolean
637
+ }
638
+ /**
639
+ * Programmatic control over how many columns to span when used in a grid layout.
640
+ */
641
+ span ? : number
642
+ /**
643
+ * This value can be one of the following:
644
+ * ...
645
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-stateful)
646
+ */
647
+ stateful ? : Boolean|object|string[]
648
+ /**
649
+ * The events that, when fired by this component, should trigger it to save its state by calling
650
+ * [saveState](https://bryntum.com/products/calendar/docs/api/Core/mixin/State#function-saveState).
651
+ * ...
652
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-statefulEvents)
653
+ */
654
+ statefulEvents ? : object|string[]
655
+ /**
656
+ * 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
657
+ * 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)
658
+ * (if explicitly specified) will be used as the `stateId`.
659
+ * ...
660
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-stateId)
661
+ */
662
+ stateId ? : string
663
+ /**
664
+ * 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`
665
+ * will be saved using the [default state provider](https://bryntum.com/products/calendar/docs/api/Core/state/StateProvider#property-instance-static).
666
+ * ...
667
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-stateProvider)
668
+ */
669
+ stateProvider ? : StateProvider
670
+ /**
671
+ * The properties of this settings object controls how grid is restored from state data.
672
+ * ...
673
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-stateSettings)
674
+ */
675
+ stateSettings ? : {
676
+ restoreUnconfiguredColumns?: Boolean
677
+ }
678
+ /**
679
+ * Store that holds records to display in the grid, or a store config object. If the configuration contains
680
+ * a `readUrl`, an `AjaxStore` will be created.
681
+ * ...
682
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-store)
683
+ */
684
+ store ? : Store|StoreConfig|AjaxStore|AjaxStoreConfig
685
+ /**
686
+ * An object containing widgets keyed by name. By default (when no `type` is given), strips are
687
+ * [toolbars](https://bryntum.com/products/calendar/docs/api/Core/widget/Toolbar). If you want to pass an array, you can use
688
+ * the toolbar's [items](https://bryntum.com/products/calendar/docs/api/Core/widget/Container#config-items).
689
+ * ...
690
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-strips)
691
+ */
692
+ strips ? : Record<string, ContainerItemConfig>
693
+ /**
694
+ * An object containing sub grid configuration objects keyed by a `region` property.
695
+ * By default, grid has a 'locked' region (if configured with locked columns) and a 'normal' region.
696
+ * The 'normal' region defaults to use `flex: 1`.
697
+ * ...
698
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-subGridConfigs)
699
+ */
700
+ subGridConfigs ? : Record<string, SubGridConfig>
701
+ /**
702
+ * A [Mask](https://bryntum.com/products/calendar/docs/api/Core/widget/Mask) config object, or a message to be shown when Crud Manager
703
+ * is persisting changes on the server. Set to `null` to disable default sync mask.
704
+ * ...
705
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-syncMask)
706
+ */
707
+ syncMask ? : string|MaskConfig|null
708
+ /**
709
+ * 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
710
+ * [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
711
+ * this widget:
712
+ * ...
713
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-tab)
714
+ */
715
+ tab ? : Boolean|TabConfig
716
+ /**
717
+ * When this container is used as a tab in a TabPanel, these items are added to the
718
+ * [TabBar](https://bryntum.com/products/calendar/docs/api/Core/widget/TabBar) when this container is the active tab.
719
+ * ...
720
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-tabBarItems)
721
+ */
722
+ tabBarItems ? : ToolbarItems[]|Widget[]
723
+ /**
724
+ * A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/calendar/docs/api/Core/widget/Toolbar),
725
+ * or array of config objects representing the child items of a Toolbar.
726
+ * This creates a toolbar docked to the top of the panel immediately below the header.
727
+ * ...
728
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-tbar)
729
+ */
730
+ tbar ? : (ContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
731
+ /**
732
+ * A title to display in the header or owning TabPanel. Causes creation and docking of a header
733
+ * to the top if no header is configured.
734
+ * ...
735
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-title)
736
+ */
737
+ title ? : string
738
+ /**
739
+ * 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
740
+ * property name is the reference by which an instantiated tool may be retrieved from the live
741
+ * `[tools](https://bryntum.com/products/calendar/docs/api/Core/widget/mixin/Toolable#property-tools)` property.
742
+ * ...
743
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-tools)
744
+ */
745
+ tools ? : Record<string, ToolConfig>|null
746
+ /**
747
+ * Configure UI transitions for various actions in the grid.
748
+ */
749
+ transition ? : {
750
+ insertRecord?: Boolean
751
+ removeRecord?: Boolean
752
+ toggleColumn?: Boolean
753
+ expandCollapseColumn?: Boolean
754
+ toggleRegion?: Boolean
755
+ toggleTreeNode?: Boolean
756
+ toggleGroup?: Boolean
757
+ filterRemoval?: Boolean
758
+ }
759
+ /**
760
+ * Animation transition duration in milliseconds.
761
+ */
762
+ transitionDuration ? : number
763
+ type ? : 'grid'
764
+ /**
765
+ * Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
766
+ * as a space separated string, an array of strings, or as an object in which property names with truthy
767
+ * values are used as the class names.
768
+ * ...
769
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-ui)
770
+ */
771
+ ui ? : 'plain'|'toolbar'|string|object
772
+ /**
773
+ * A widgets weight determines its position among siblings when added to a [Container](https://bryntum.com/products/calendar/docs/api/Core/widget/Container).
774
+ * Higher weights go further down.
775
+ */
776
+ weight ? : number
777
+ /**
778
+ * Widget's width, used to set element `style.width`. Either specify a valid width string or a number, which
779
+ * will get 'px' appended. We recommend using CSS as the primary way to control width, but in some cases
780
+ * this config is convenient.
781
+ */
782
+ width ? : string|number
783
+
784
+ // Features
785
+ /**
786
+ * AI-powered filter feature for Grid. Allows users to type natural language queries to filter grid data.
787
+ * ...
788
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/ai/AIFilter)
789
+ */
790
+ aiFilterFeature ? : object|Boolean|string|AIFilter|AIFilterConfig
791
+ /**
792
+ * Allows using `[Ctrl/CMD + C]`, `[Ctrl/CMD + X]` and `[Ctrl/CMD + V]` to cut, copy and paste cell or cell ranges. Also
793
+ * makes cut, copy and paste actions available via the cell context menu.
794
+ * ...
795
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/CellCopyPaste)
796
+ */
797
+ cellCopyPasteFeature ? : object|Boolean|string|CellCopyPaste|CellCopyPasteConfig
798
+ /**
799
+ * Adding this feature to the grid and other Bryntum products which are based on the Grid (i.e. Scheduler, SchedulerPro, and Gantt)
800
+ * enables cell editing. Any subclass of [Field](https://bryntum.com/products/calendar/docs/api/Core/widget/Field) can be used
801
+ * as editor for the [Column](https://bryntum.com/products/calendar/docs/api/Grid/column/Column). The most popular are:
802
+ * ...
803
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/CellEdit)
804
+ */
805
+ cellEditFeature ? : object|Boolean|string|CellEdit|CellEditConfig
806
+ /**
807
+ * Right click to display context menu for cells. To invoke the cell menu in a keyboard-accessible manner, use the
808
+ * `SPACE` key when the cell is focused.
809
+ * ...
810
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/CellMenu)
811
+ */
812
+ cellMenuFeature ? : object|Boolean|string|CellMenu|CellMenuConfig
813
+ /**
814
+ * Displays a tooltip when hovering cells.
815
+ * ...
816
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/CellTooltip)
817
+ */
818
+ cellTooltipFeature ? : object|Boolean|string|CellTooltip|CellTooltipConfig
819
+ /**
820
+ * Adds interactive charting to a Grid. [Charts](https://bryntum.com/products/calendar/docs/api/Chart/widget/Chart) can be created from a selection of Grid data
821
+ * and updated in realtime as data changes. Supports many common chart types with extensive styling and customization
822
+ * options.
823
+ * ...
824
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/Charts)
825
+ */
826
+ chartsFeature ? : object|Boolean|string|Charts|ChartsConfig
827
+ /**
828
+ * Enables the [autoWidth](https://bryntum.com/products/calendar/docs/api/Grid/column/Column#config-autoWidth) config for a grid's columns.
829
+ * ...
830
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/ColumnAutoWidth)
831
+ */
832
+ columnAutoWidthFeature ? : object|Boolean|string|ColumnAutoWidth|ColumnAutoWidthConfig
833
+ /**
834
+ * Displays a toolbar while dragging column headers. Drop on a button in the toolbar to activate a certain function,
835
+ * for example to group by that column. This feature simplifies certain operations on touch devices.
836
+ * ...
837
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/ColumnDragToolbar)
838
+ */
839
+ columnDragToolbarFeature ? : object|Boolean|string|ColumnDragToolbar|ColumnDragToolbarConfig
840
+ /**
841
+ * Displays a column picker (to show/hide columns) in the header context menu. Columns can be displayed in sub menus
842
+ * by region or tag. Grouped headers are displayed as menu hierarchies.
843
+ * ...
844
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/ColumnPicker)
845
+ */
846
+ columnPickerFeature ? : object|Boolean|string|ColumnPicker|ColumnPickerConfig
847
+ /**
848
+ * Allows user to rename columns by either right-clicking column header or using keyboard shortcuts when column header
849
+ * is focused.
850
+ * ...
851
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/ColumnRename)
852
+ */
853
+ columnRenameFeature ? : object|Boolean|string|ColumnRename|ColumnRenameConfig
854
+ /**
855
+ * Allows user to reorder columns by dragging headers. To get notified about column reorder listen to `change` event
856
+ * on [columns](https://bryntum.com/products/calendar/docs/api/Grid/data/ColumnStore) store.
857
+ * ...
858
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/ColumnReorder)
859
+ */
860
+ columnReorderFeature ? : object|Boolean|string|ColumnReorder|ColumnReorderConfig
861
+ /**
862
+ * Enables user to resize columns by dragging a handle on the right hand side of the header. To get notified about column
863
+ * resize listen to `change` event on [columns](https://bryntum.com/products/calendar/docs/api/Grid/data/ColumnStore) store.
864
+ * ...
865
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/ColumnResize)
866
+ */
867
+ columnResizeFeature ? : object|Boolean|string|ColumnResize|ColumnResizeConfig
868
+ /**
869
+ * A feature that allows exporting Grid data to Excel or CSV without involving the server. It uses
870
+ * [TableExporter](https://bryntum.com/products/calendar/docs/api/Grid/util/TableExporter) class as data provider, 3rd party provider to generate XLS files, and
871
+ * [Microsoft XML specification](https://msdn.microsoft.com/en-us/library/office/documentformat.openxml.spreadsheet.aspx).
872
+ * ...
873
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/experimental/ExcelExporter)
874
+ */
875
+ excelExporterFeature ? : object|Boolean|string|GridExcelExporter|GridExcelExporterConfig
876
+ /**
877
+ * An experimental feature that lets users drop files on a Widget. The widget fires an event when a file is dropped onto it.
878
+ * In the event, you get access to the raw files as strings, that were parsed by calling `readAsBinaryString`.
879
+ * ...
880
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/experimental/FileDrop)
881
+ */
882
+ fileDropFeature ? : object|Boolean|string|FileDrop|FileDropConfig
883
+ /**
884
+ * This feature adds a fill handle to a Grid range selection, which when dragged, fills the cells being dragged over
885
+ * with values based on the values in the original selected range. This is similar to functionality normally seen in
886
+ * various spreadsheet applications.
887
+ * ...
888
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/FillHandle)
889
+ */
890
+ fillHandleFeature ? : object|Boolean|string|FillHandle|FillHandleConfig
891
+ /**
892
+ * Feature that allows filtering of the grid by settings filters on columns. The actual filtering is done by the store.
893
+ * For info on programmatically handling filters, see [StoreFilter](https://bryntum.com/products/calendar/docs/api/Core/data/mixin/StoreFilter).
894
+ * ...
895
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/Filter)
896
+ */
897
+ filterFeature ? : object|Boolean|string|Filter|FilterConfig
898
+ /**
899
+ * Feature that allows filtering of the grid by entering filters on column headers.
900
+ * The actual filtering is done by the store.
901
+ * For info on programmatically handling filters, see [StoreFilter](https://bryntum.com/products/calendar/docs/api/Core/data/mixin/StoreFilter).
902
+ * ...
903
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/FilterBar)
904
+ */
905
+ filterBarFeature ? : object|Boolean|string|FilterBar|FilterBarConfig
906
+ /**
907
+ * Enables rendering and handling of row groups. The actual grouping is done in the store, but triggered by
908
+ * <kbd>shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
909
+ * one anywhere on grid). Use <kbd>shift</kbd> + <kbd>alt</kbd> + click, or the context menu, to remove a column
910
+ * grouper.
911
+ * ...
912
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/Group)
913
+ */
914
+ groupFeature ? : object|Boolean|string|Group|GroupConfig
915
+ /**
916
+ * Displays a summary row as a group footer in a grouped grid. Uses the same configuration options on columns as
917
+ * [Summary](https://bryntum.com/products/calendar/docs/api/Grid/feature/Summary).
918
+ * ...
919
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/GroupSummary)
920
+ */
921
+ groupSummaryFeature ? : object|Boolean|string|GridGroupSummary|GridGroupSummaryConfig
922
+ /**
923
+ * Right click column header or focus it and press SPACE key to show the context menu for headers.
924
+ * ...
925
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/HeaderMenu)
926
+ */
927
+ headerMenuFeature ? : object|Boolean|string|HeaderMenu|HeaderMenuConfig
928
+ /**
929
+ * This feature allows records which satisfy a certain condition to be locked at the top of the grid.
930
+ * ...
931
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/LockRows)
932
+ */
933
+ lockRowsFeature ? : object|Boolean|string|GridLockRows|GridLockRowsConfig
934
+ /**
935
+ * This feature merges cells that have the same value in sorted (or [optionally](https://bryntum.com/products/calendar/docs/api/Grid/feature/MergeCells#config-sortedOnly) any) columns
936
+ * configured to [mergeCells](https://bryntum.com/products/calendar/docs/api/Grid/column/Column#config-mergeCells).
937
+ * ...
938
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/MergeCells)
939
+ */
940
+ mergeCellsFeature ? : object|Boolean|string|MergeCells|MergeCellsConfig
941
+ /**
942
+ * Generates PDF/PNG files from the Grid component.
943
+ * ...
944
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/export/PdfExport)
945
+ */
946
+ pdfExportFeature ? : object|Boolean|string|GridPdfExport|GridPdfExportConfig
947
+ /**
948
+ * Allows pinning columns to the start or end region of the grid without any additional subGrid configurations.
949
+ * When pinning to a region that does not yet exist, the feature creates the required subGrid on the fly.
950
+ * ...
951
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/PinColumns)
952
+ */
953
+ pinColumnsFeature ? : object|Boolean|string|PinColumns|PinColumnsConfig
954
+ /**
955
+ * Allows printing Grid contents using browser print dialog.
956
+ * ...
957
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/export/GridPrint)
958
+ */
959
+ printFeature ? : object|Boolean|string|GridPrint|GridPrintConfig
960
+ /**
961
+ * Feature that allows the user to search in a column by focusing a cell and typing. Navigate between hits using the
962
+ * keyboard, [f3] or [ctrl]/[cmd] + [g] moves to next, also pressing [shift] moves to previous.
963
+ * ...
964
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/QuickFind)
965
+ */
966
+ quickFindFeature ? : object|Boolean|string|QuickFind|QuickFindConfig
967
+ /**
968
+ * Makes the splitter between grid [sections](https://bryntum.com/products/calendar/docs/api/Grid/view/SubGrid) draggable, to let users resize, and
969
+ * collapse/expand the sections.
970
+ * ...
971
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/RegionResize)
972
+ */
973
+ regionResizeFeature ? : object|Boolean|string|RegionResize|RegionResizeConfig
974
+ /**
975
+ * Allow using [Ctrl/CMD + C/X] and [Ctrl/CMD + V] to copy/cut-and-paste rows. Also makes cut, copy and paste actions
976
+ * available via the cell context menu.
977
+ * ...
978
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/RowCopyPaste)
979
+ */
980
+ rowCopyPasteFeature ? : object|Boolean|string|RowCopyPaste|RowCopyPasteConfig
981
+ /**
982
+ * This feature allows editing of entire rows in a grid in a docked panel which by default slides out from the right.
983
+ * ...
984
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/RowEdit)
985
+ */
986
+ rowEditFeature ? : object|Boolean|string|RowEdit|RowEditConfig
987
+ /**
988
+ * Enables expanding of Grid rows by either row click or double click, or by adding a separate Grid column which renders
989
+ * a button that expands or collapses the row.
990
+ * ...
991
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/RowExpander)
992
+ */
993
+ rowExpanderFeature ? : object|Boolean|string|RowExpander|RowExpanderConfig
994
+ /**
995
+ * Allows user to reorder rows by dragging them. To get notified about row reorder listen to `change` event
996
+ * on the grid [store](https://bryntum.com/products/calendar/docs/api/Core/data/Store).
997
+ * ...
998
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/RowReorder)
999
+ */
1000
+ rowReorderFeature ? : object|Boolean|string|GridRowReorder|GridRowReorderConfig
1001
+ /**
1002
+ * Enables user to change row height by dragging the bottom row border. After a resize operation, the [rowHeight](https://bryntum.com/products/calendar/docs/api/Grid/data/GridRowModel#field-rowHeight)
1003
+ * field of the record is updated (when [applyToAllRows](https://bryntum.com/products/calendar/docs/api/Grid/feature/RowResize#config-applyToAllRows) is `false`).
1004
+ * ...
1005
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/RowResize)
1006
+ */
1007
+ rowResizeFeature ? : object|Boolean|string|GridRowResize|GridRowResizeConfig
1008
+ /**
1009
+ * <div class="external-example vertical" data-file="Grid/feature/Search.js"></div>
1010
+ * ...
1011
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/Search)
1012
+ */
1013
+ searchFeature ? : object|Boolean|string|Search|SearchConfig
1014
+ /**
1015
+ * Allows sorting of grid by clicking (or tapping) headers, also displays which columns grid is sorted by (numbered if
1016
+ * using multisort). Use modifier keys for multisorting: [Ctrl/CMD + click] to add sorter, [Ctrl/CMD + Alt + click] to remove sorter.
1017
+ * The actual sorting is done by the store, see [Store.sort()](https://bryntum.com/products/calendar/docs/api/Core/data/mixin/StoreSort#function-sort).
1018
+ * ...
1019
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/Sort)
1020
+ */
1021
+ sortFeature ? : object|Boolean|string|Sort|SortConfig
1022
+ /**
1023
+ * This feature allows splitting the Grid into multiple views, either by using the cell context menu, or
1024
+ * programmatically by calling [split()](https://bryntum.com/products/calendar/docs/api/Grid/feature/Split#function-split).
1025
+ * ...
1026
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/Split)
1027
+ */
1028
+ splitFeature ? : object|Boolean|string|GridSplit|GridSplitConfig
1029
+ /**
1030
+ * A feature which pins configurable content from a grid row to the top of the grid
1031
+ * while the row scrolls off the top but is still visible.
1032
+ * ...
1033
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/StickyCells)
1034
+ */
1035
+ stickyCellsFeature ? : object|Boolean|string|StickyCells|StickyCellsConfig
1036
+ /**
1037
+ * Stripes rows by adding alternating CSS classes to all row elements (`b-even` and `b-odd`).
1038
+ * ...
1039
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/Stripe)
1040
+ */
1041
+ stripeFeature ? : object|Boolean|string|Stripe|StripeConfig
1042
+ /**
1043
+ * Displays a summary row in the grid footer.
1044
+ * ...
1045
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/Summary)
1046
+ */
1047
+ summaryFeature ? : object|Boolean|string|GridSummary|GridSummaryConfig
1048
+ /**
1049
+ * Feature that makes the grid work more like a tree. Included by default in [TreeGrid](https://bryntum.com/products/calendar/docs/api/Grid/view/TreeGrid). Requires
1050
+ * exactly one [TreeColumn](https://bryntum.com/products/calendar/docs/api/Grid/column/TreeColumn) among grids columns. That column will have its renderer replaced with a
1051
+ * tree renderer that adds padding and icon to give the appearance of a tree. The original renderer is preserved and
1052
+ * also called.
1053
+ * ...
1054
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/Tree)
1055
+ */
1056
+ treeFeature ? : object|Boolean|string|Tree|TreeConfig
1057
+ /**
1058
+ * A feature that allows transforming a flat dataset (or the leaves of a hierarchical) into a tree by specifying a
1059
+ * record field per parent level. Parents are generated based on each leaf's value for those fields.
1060
+ * ...
1061
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/TreeGroup)
1062
+ */
1063
+ treeGroupFeature ? : object|Boolean|string|TreeGroup|TreeGroupConfig
1064
+
1065
+ }>();
1066
+
1067
+ const emit = defineEmits<{
1068
+ /**
1069
+ * Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
1070
+ * @param {string} e Event name
1071
+ * @param {object} params Event parameters
1072
+ * @param {object} params.event Event object
1073
+ * @param {Grid.view.Grid} params.event.source Owner grid
1074
+ * @param {Grid.util.GridLocation} params.event.editorContext Editing context
1075
+ */
1076
+ (e: 'beforeCancelCellEdit', params: ((event: { source: Grid, editorContext: GridLocation }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1077
+ /**
1078
+ * Fires on the owning Grid before the row editing is canceled, return false to signal that the value is invalid and editing should not be finalized.
1079
+ * ...
1080
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#event-beforeCancelRowEdit)
1081
+ * @param {string} e Event name
1082
+ * @param {object} params Event parameters
1083
+ * @param {object} params.event Event object
1084
+ * @param {Grid.view.Grid} params.event.grid Target grid
1085
+ * @param {RowEditorContext} params.event.editorContext Editing context
1086
+ */
1087
+ (e: 'beforeCancelRowEdit', params: ((event: { grid: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1088
+ /**
1089
+ * Fires on the owning Grid before editing starts, return `false` to prevent editing
1090
+ * @param {string} e Event name
1091
+ * @param {object} params Event parameters
1092
+ * @param {object} params.event Event object
1093
+ * @param {Grid.view.Grid} params.event.source Owner grid
1094
+ * @param {CellEditorContext} params.event.editorContext Editing context
1095
+ */
1096
+ (e: 'beforeCellEditStart', params: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1097
+ /**
1098
+ * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
1099
+ * buttons while [autoEdit](https://bryntum.com/products/calendar/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
1100
+ * @param {string} e Event name
1101
+ * @param {object} params Event parameters
1102
+ * @param {object} params.event Event object
1103
+ * @param {Grid.view.Grid} params.event.source Owner grid
1104
+ * @param {(Grid.util.GridLocation|Core.data.Model)[]} params.event.gridSelection An array of cell selectors or records that will have their values deleted (the records themselves will not get deleted, only visible column values).
1105
+ */
1106
+ (e: 'beforeCellRangeDelete', params: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1107
+ /**
1108
+ * Fires for each selected record on the owning Grid before editing a range of selected cell values
1109
+ * @param {string} e Event name
1110
+ * @param {object} params Event parameters
1111
+ * @param {object} params.event Event object
1112
+ * @param {Core.data.Model} params.event.record Current selected record from the range
1113
+ * @param {string} params.event.field The field being changed
1114
+ * @param {any} params.event.value The value being set
1115
+ */
1116
+ (e: 'beforeCellRangeEdit', params: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1117
+ /**
1118
+ * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
1119
+ * @param {string} e Event name
1120
+ * @param {object} params Event parameters
1121
+ * @param {object} params.event Event object
1122
+ * @param {Grid.view.Grid} params.event.source The grid instance.
1123
+ * @param {Grid.column.Column} params.event.column The dragged column.
1124
+ * @param {Event} params.event.event The browser event.
1125
+ */
1126
+ (e: 'beforeColumnDragStart', params: ((event: { source: Grid, column: Column, event: Event }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1127
+ /**
1128
+ * This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
1129
+ * @param {string} e Event name
1130
+ * @param {object} params Event parameters
1131
+ * @param {object} params.event Event object
1132
+ * @param {Grid.view.Grid} params.event.source The grid instance.
1133
+ * @param {Grid.column.Column} params.event.column The dragged column.
1134
+ * @param {Grid.column.Column} params.event.insertBefore The column before which the dragged column will be inserted.
1135
+ * @param {Grid.column.Column} params.event.newParent The new parent column.
1136
+ * @param {Event} params.event.event The browser event.
1137
+ * @param {string} params.event.region The region where the column was dropped.
1138
+ */
1139
+ (e: 'beforeColumnDropFinalize', params: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1140
+ /**
1141
+ * This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
1142
+ * `false`.
1143
+ * @param {string} e Event name
1144
+ * @param {object} params Event parameters
1145
+ * @param {object} params.event Event object
1146
+ * @param {Grid.view.Grid} params.event.source The grid instance
1147
+ * @param {Grid.column.Column} params.event.column The column
1148
+ * @param {Event} params.event.domEvent The browser event
1149
+ */
1150
+ (e: 'beforeColumnResize', params: ((event: { source: Grid, column: Column, domEvent: Event }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1151
+ /**
1152
+ * Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
1153
+ * @param {string} e Event name
1154
+ * @param {object} params Event parameters
1155
+ * @param {object} params.event Event object
1156
+ * @param {Grid.view.Grid} params.event.source Owner grid
1157
+ * @param {Grid.util.GridLocation[]} params.event.cells The cells about to be copied or cut
1158
+ * @param {string} params.event.data The string data about to be copied or cut
1159
+ * @param {boolean} params.event.isCut `true` if this is a cut action
1160
+ * @param {string} params.event.entityName 'cell' to distinguish this event from other beforeCopy events
1161
+ */
1162
+ (e: 'beforeCopy', params: ((event: { source: Grid, cells: GridLocation[], data: string, isCut: boolean, entityName: string }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1163
+ /**
1164
+ * Fires on the owning Grid before CSV export starts. Return `false` to cancel the export.
1165
+ * @param {string} e Event name
1166
+ * @param {object} params Event parameters
1167
+ * @param {object} params.event Event object
1168
+ * @param {ExportConfig} params.event.config Export config
1169
+ * @param {Grid.column.Column[]} params.event.columns An array of columns to export
1170
+ * @param {Core.data.Model[]} params.event.rows An array of records to export
1171
+ * @param {string} params.event.lineDelimiter The CSV delimiter to separate lines
1172
+ * @param {string} params.event.columnDelimiter The CSV delimiter to separate values on one line
1173
+ */
1174
+ (e: 'beforeCSVExport', params: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1175
+ /**
1176
+ * Fires before an object is destroyed.
1177
+ * @param {string} e Event name
1178
+ * @param {object} params Event parameters
1179
+ * @param {object} params.event Event object
1180
+ * @param {Core.Base} params.event.source The Object that is being destroyed.
1181
+ */
1182
+ (e: 'beforeDestroy', params: ((event: { source: Base }) => void)|string): void
1183
+ /**
1184
+ * Fires on the owning Grid before Excel export starts. Return `false` to cancel the export.
1185
+ * @param {string} e Event name
1186
+ * @param {object} params Event parameters
1187
+ * @param {object} params.event Event object
1188
+ * @param {ExportConfig} params.event.config Export config
1189
+ * @param {XLSColumn[]} params.event.columns An array of columns to export
1190
+ * @param {any[][]} params.event.rows An array of records to export
1191
+ */
1192
+ (e: 'beforeExcelExport', params: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1193
+ /**
1194
+ * Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
1195
+ * @param {string} e Event name
1196
+ * @param {object} params Event parameters
1197
+ * @param {object} params.event Event object
1198
+ * @param {Grid.util.GridLocation} params.event.cell Information about the column / record
1199
+ * @param {MouseEvent} params.event.domEvent The raw DOM event
1200
+ */
1201
+ (e: 'beforeFillHandleDragStart', params: ((event: { cell: GridLocation, domEvent: MouseEvent }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1202
+ /**
1203
+ * Fires on the owning Grid before the cell editing is finished, return false to signal that the value is invalid and editing should not be finalized.
1204
+ * @param {string} e Event name
1205
+ * @param {object} params Event parameters
1206
+ * @param {object} params.event Event object
1207
+ * @param {Grid.view.Grid} params.event.grid Target grid
1208
+ * @param {CellEditorContext} params.event.editorContext Editing context
1209
+ */
1210
+ (e: 'beforeFinishCellEdit', params: ((event: { grid: Grid, editorContext: CellEditorContext }) => void)|string): void
1211
+ /**
1212
+ * Fires on the owning Grid before the row editing is finished, return false to signal that the value is invalid and editing should not be finalized.
1213
+ * ...
1214
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#event-beforeFinishRowEdit)
1215
+ * @param {string} e Event name
1216
+ * @param {object} params Event parameters
1217
+ * @param {object} params.event Event object
1218
+ * @param {Grid.view.Grid} params.event.grid Target grid
1219
+ * @param {RowEditorContext} params.event.editorContext Editing context
1220
+ */
1221
+ (e: 'beforeFinishRowEdit', params: ((event: { grid: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1222
+ /**
1223
+ * Triggered before a widget is hidden. Return `false` to prevent the action.
1224
+ * @param {string} e Event name
1225
+ * @param {object} params Event parameters
1226
+ * @param {object} params.event Event object
1227
+ * @param {Core.widget.Widget} params.event.source The widget being hidden.
1228
+ */
1229
+ (e: 'beforeHide', params: ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1230
+ /**
1231
+ * Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
1232
+ * @param {string} e Event name
1233
+ * @param {object} params Event parameters
1234
+ * @param {object} params.event Event object
1235
+ * @param {Grid.view.Grid} params.event.source Owner grid
1236
+ * @param {string} params.event.clipboardData The clipboardData about to be pasted
1237
+ * @param {Grid.util.GridLocation} params.event.targetCell The cell from which the paste will be started
1238
+ * @param {string} params.event.entityName 'cell' to distinguish this event from other beforePaste events
1239
+ * @param {string} params.event.text The raw text from clipboard
1240
+ */
1241
+ (e: 'beforePaste', params: ((event: { source: Grid, clipboardData: string, targetCell: GridLocation, entityName: string, text: string }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1242
+ /**
1243
+ * Fires on the owning Grid before export started. Return `false` to cancel the export.
1244
+ * @param {string} e Event name
1245
+ * @param {object} params Event parameters
1246
+ * @param {object} params.event Event object
1247
+ * @param {object} params.event.config Export config
1248
+ */
1249
+ (e: 'beforePdfExport', params: ((event: { config: object }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1250
+ /**
1251
+ * Fires before a row is rendered.
1252
+ * @param {string} e Event name
1253
+ * @param {object} params Event parameters
1254
+ * @param {object} params.event Event object
1255
+ * @param {Grid.view.Grid} params.event.source The firing Grid instance.
1256
+ * @param {Grid.row.Row} params.event.row The row about to be rendered.
1257
+ * @param {Core.data.Model} params.event.record The record for the row.
1258
+ * @param {number} params.event.recordIndex The zero-based index of the record.
1259
+ */
1260
+ (e: 'beforeRenderRow', params: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string): void
1261
+ /**
1262
+ * Grid rows are about to be rendered
1263
+ * @param {string} e Event name
1264
+ * @param {object} params Event parameters
1265
+ * @param {object} params.event Event object
1266
+ * @param {Grid.view.Grid} params.event.source This grid.
1267
+ */
1268
+ (e: 'beforeRenderRows', params: ((event: { source: Grid }) => void)|string): void
1269
+ /**
1270
+ * This event fires before row collapse is started.
1271
+ * ...
1272
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#event-beforeRowCollapse)
1273
+ * @param {string} e Event name
1274
+ * @param {object} params Event parameters
1275
+ * @param {object} params.event Event object
1276
+ * @param {Core.data.Model} params.event.record Record
1277
+ */
1278
+ (e: 'beforeRowCollapse', params: ((event: { record: Model }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1279
+ /**
1280
+ * This event fires before row expand is started.
1281
+ * ...
1282
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#event-beforeRowExpand)
1283
+ * @param {string} e Event name
1284
+ * @param {object} params Event parameters
1285
+ * @param {object} params.event Event object
1286
+ * @param {Core.data.Model} params.event.record Record
1287
+ */
1288
+ (e: 'beforeRowExpand', params: ((event: { record: Model }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1289
+ /**
1290
+ * Fires before the selection changes. Returning `false` from a listener prevents the change
1291
+ * @param {string} e Event name
1292
+ * @param {object} params Event parameters
1293
+ * @param {object} params.event Event object
1294
+ * @param {string} params.event.action `'select'`/`'deselect'`
1295
+ * @param {'row','cell'} params.event.mode `'row'`/`'cell'`
1296
+ * @param {Grid.view.Grid} params.event.source
1297
+ * @param {Core.data.Model[]} params.event.deselected The records to be deselected in this operation.
1298
+ * @param {Core.data.Model[]} params.event.selected The records to be selected in this operation.
1299
+ * @param {Core.data.Model[]} params.event.selection The records in the current selection, before applying `selected` and `deselected`
1300
+ * @param {Grid.util.GridLocation[]} params.event.deselectedCells The cells to be deselected in this operation.
1301
+ * @param {Grid.util.GridLocation[]} params.event.selectedCells The cells to be selected in this operation.
1302
+ * @param {Grid.util.GridLocation[]} params.event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
1303
+ */
1304
+ (e: 'beforeSelectionChange', params: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1305
+ /**
1306
+ * Fired before this container will load record values into its child fields. This is useful if you
1307
+ * want to modify the UI before data is loaded (e.g. set some input field to be readonly)
1308
+ * @param {string} e Event name
1309
+ * @param {object} params Event parameters
1310
+ * @param {object} params.event Event object
1311
+ * @param {Core.widget.Container} params.event.source The container
1312
+ * @param {Core.data.Model} params.event.record The record
1313
+ */
1314
+ (e: 'beforeSetRecord', params: ((event: { source: Container, record: Model }) => void)|string): void
1315
+ /**
1316
+ * Triggered before a widget is shown. Return `false` to prevent the action.
1317
+ * @param {string} e Event name
1318
+ * @param {object} params Event parameters
1319
+ * @param {object} params.event Event object
1320
+ * @param {Core.widget.Widget,any} params.event.source The widget being shown
1321
+ */
1322
+ (e: 'beforeShow', params: ((event: { source: Widget|any }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1323
+ /**
1324
+ * Fires on the owning Grid before editing starts, return `false` to prevent editing
1325
+ * @param {string} e Event name
1326
+ * @param {object} params Event parameters
1327
+ * @param {object} params.event Event object
1328
+ * @param {Grid.view.Grid} params.event.source Owner grid
1329
+ * @param {RowEditorContext} params.event.editorContext Editing context
1330
+ */
1331
+ (e: 'beforeStartRowEdit', params: ((event: { source: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1332
+ /**
1333
+ * Fired before state is applied to the source. Allows editing the state object or preventing the operation.
1334
+ * @param {string} e Event name
1335
+ * @param {object} params Event parameters
1336
+ * @param {object} params.event Event object
1337
+ * @param {GridStateInfo} params.event.state State object config
1338
+ */
1339
+ (e: 'beforeStateApply', params: ((event: { state: GridStateInfo }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1340
+ /**
1341
+ * Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
1342
+ * @param {string} e Event name
1343
+ * @param {object} params Event parameters
1344
+ * @param {object} params.event Event object
1345
+ * @param {GridStateInfo} params.event.state State object config
1346
+ */
1347
+ (e: 'beforeStateSave', params: ((event: { state: GridStateInfo }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1348
+ /**
1349
+ * Fired when a group is going to be expanded or collapsed using the UI.
1350
+ * Returning `false` from a listener prevents the operation
1351
+ * @param {string} e Event name
1352
+ * @param {object} params Event parameters
1353
+ * @param {object} params.event Event object
1354
+ * @param {Core.data.Model} params.event.groupRecord [DEPRECATED] Use `groupRecords` param instead
1355
+ * @param {Core.data.Model[]} params.event.groupRecords The group records being toggled
1356
+ * @param {boolean} params.event.collapse Collapsed (true) or expanded (false)
1357
+ * @param {Event} params.event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
1358
+ */
1359
+ (e: 'beforeToggleGroup', params: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1360
+ /**
1361
+ * Fired before a parent node record toggles its collapsed state.
1362
+ * @param {string} e Event name
1363
+ * @param {object} params Event parameters
1364
+ * @param {object} params.event Event object
1365
+ * @param {Grid.view.Grid} params.event.source The firing Grid instance.
1366
+ * @param {Core.data.Model} params.event.record The record being toggled.
1367
+ * @param {boolean} params.event.collapse `true` if the node is being collapsed.
1368
+ */
1369
+ (e: 'beforeToggleNode', params: ((event: { source: Grid, record: Model, collapse: boolean }) => void)|string): void
1370
+ /**
1371
+ * Fires on the owning Grid when editing is cancelled
1372
+ * @param {string} e Event name
1373
+ * @param {object} params Event parameters
1374
+ * @param {object} params.event Event object
1375
+ * @param {Grid.view.Grid} params.event.source Owner grid
1376
+ * @param {Grid.util.GridLocation} params.event.editorContext Editing context
1377
+ * @param {Event} params.event.event Included if the cancellation was triggered by a DOM event
1378
+ */
1379
+ (e: 'cancelCellEdit', params: ((event: { source: Grid, editorContext: GridLocation, event: Event }) => void)|string): void
1380
+ /**
1381
+ * Fires when any other event is fired from the object.
1382
+ * ...
1383
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#event-catchAll)
1384
+ * @param {string} e Event name
1385
+ * @param {object} params Event parameters
1386
+ * @param {object} params.event Event object
1387
+ * @param {{[key: string]: any, type: string}} params.event.event The Object that contains event details
1388
+ * @param {string} params.event.event.type The type of the event which is caught by the listener
1389
+ */
1390
+ (e: 'catchAll', params: ((event: {[key: string]: any, type: string}) => void)|string): void
1391
+ /**
1392
+ * Fired when user clicks in a grid cell
1393
+ * @param {string} e Event name
1394
+ * @param {object} params Event parameters
1395
+ * @param {object} params.event Event object
1396
+ * @param {Grid.view.Grid} params.event.grid The grid instance
1397
+ * @param {Core.data.Model} params.event.record The record representing the row
1398
+ * @param {Grid.column.Column} params.event.column The column to which the cell belongs
1399
+ * @param {HTMLElement} params.event.cellElement The cell HTML element
1400
+ * @param {HTMLElement} params.event.target The target element
1401
+ * @param {MouseEvent} params.event.event The native DOM event
1402
+ */
1403
+ (e: 'cellClick', params: ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string): void
1404
+ /**
1405
+ * Fired when user activates contextmenu in a grid cell
1406
+ * @param {string} e Event name
1407
+ * @param {object} params Event parameters
1408
+ * @param {object} params.event Event object
1409
+ * @param {Grid.view.Grid} params.event.grid The grid instance
1410
+ * @param {Core.data.Model} params.event.record The record representing the row
1411
+ * @param {Grid.column.Column} params.event.column The column to which the cell belongs
1412
+ * @param {HTMLElement} params.event.cellElement The cell HTML element
1413
+ * @param {HTMLElement} params.event.target The target element
1414
+ * @param {MouseEvent} params.event.event The native DOM event
1415
+ */
1416
+ (e: 'cellContextMenu', params: ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string): void
1417
+ /**
1418
+ * Fired when user double clicks a grid cell
1419
+ * @param {string} e Event name
1420
+ * @param {object} params Event parameters
1421
+ * @param {object} params.event Event object
1422
+ * @param {Grid.view.Grid} params.event.grid The grid instance
1423
+ * @param {Core.data.Model} params.event.record The record representing the row
1424
+ * @param {Grid.column.Column} params.event.column The column to which the cell belongs
1425
+ * @param {HTMLElement} params.event.cellElement The cell HTML element
1426
+ * @param {HTMLElement} params.event.target The target element
1427
+ * @param {MouseEvent} params.event.event The native DOM event
1428
+ */
1429
+ (e: 'cellDblClick', params: ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string): void
1430
+ /**
1431
+ * This event fires on the owning grid before the context menu is shown for a cell.
1432
+ * Allows manipulation of the items to show in the same way as in the [processItems](https://bryntum.com/products/calendar/docs/api/Grid/feature/CellMenu#config-processItems).
1433
+ * ...
1434
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#event-cellMenuBeforeShow)
1435
+ * @param {string} e Event name
1436
+ * @param {object} params Event parameters
1437
+ * @param {object} params.event Event object
1438
+ * @param {Grid.view.Grid} params.event.source The grid
1439
+ * @param {Core.widget.Menu} params.event.menu The menu
1440
+ * @param {Record<string, MenuItemEntry>} params.event.items Menu item configs
1441
+ * @param {Grid.column.Column} params.event.column Column
1442
+ * @param {Core.data.Model} params.event.record Record
1443
+ */
1444
+ (e: 'cellMenuBeforeShow', params: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1445
+ /**
1446
+ * This event fires on the owning grid when an item is selected in the cell context menu.
1447
+ * @param {string} e Event name
1448
+ * @param {object} params Event parameters
1449
+ * @param {object} params.event Event object
1450
+ * @param {Grid.view.Grid} params.event.source The grid
1451
+ * @param {Core.widget.Menu} params.event.menu The menu
1452
+ * @param {Core.widget.MenuItem} params.event.item Selected menu item
1453
+ * @param {Grid.column.Column} params.event.column Column
1454
+ * @param {Core.data.Model} params.event.record Record
1455
+ */
1456
+ (e: 'cellMenuItem', params: ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column, record: Model }) => void)|string): void
1457
+ /**
1458
+ * This event fires on the owning grid after the context menu is shown for a cell.
1459
+ * @param {string} e Event name
1460
+ * @param {object} params Event parameters
1461
+ * @param {object} params.event Event object
1462
+ * @param {Grid.view.Grid} params.event.source The grid
1463
+ * @param {Core.widget.Menu} params.event.menu The menu
1464
+ * @param {Record<string, MenuItemEntry>} params.event.items Menu item configs
1465
+ * @param {Grid.column.Column} params.event.column Column
1466
+ * @param {Core.data.Model} params.event.record Record
1467
+ */
1468
+ (e: 'cellMenuShow', params: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => void)|string): void
1469
+ /**
1470
+ * This event fires on the owning grid when a check item is toggled in the cell context menu.
1471
+ * @param {string} e Event name
1472
+ * @param {object} params Event parameters
1473
+ * @param {object} params.event Event object
1474
+ * @param {Grid.view.Grid} params.event.source The grid
1475
+ * @param {Core.widget.Menu} params.event.menu The menu
1476
+ * @param {Core.widget.MenuItem} params.event.item Selected menu item
1477
+ * @param {Grid.column.Column} params.event.column Column
1478
+ * @param {Core.data.Model} params.event.record Record
1479
+ * @param {boolean} params.event.checked Checked or not
1480
+ */
1481
+ (e: 'cellMenuToggleItem', params: ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column, record: Model, checked: boolean }) => void)|string): void
1482
+ /**
1483
+ * Fired when the mouse enters a cell
1484
+ * @param {string} e Event name
1485
+ * @param {object} params Event parameters
1486
+ * @param {object} params.event Event object
1487
+ * @param {Grid.view.Grid} params.event.source The grid instance
1488
+ * @param {Core.data.Model} params.event.record The record representing the hovered cell
1489
+ * @param {Grid.column.Column} params.event.column The column currently hovered
1490
+ * @param {HTMLElement} params.event.cellElement The cell HTML element
1491
+ * @param {MouseEvent} params.event.event The native DOM event
1492
+ */
1493
+ (e: 'cellMouseEnter', params: ((event: { source: Grid, record: Model, column: Column, cellElement: HTMLElement, event: MouseEvent }) => void)|string): void
1494
+ /**
1495
+ * Fired when the mouse leaves a cell
1496
+ * @param {string} e Event name
1497
+ * @param {object} params Event parameters
1498
+ * @param {object} params.event Event object
1499
+ * @param {Grid.view.Grid} params.event.source The grid instance
1500
+ * @param {Core.data.Model} params.event.record The record representing the cell that the mouse left
1501
+ * @param {Grid.column.Column} params.event.column The column representing the cell that the mouse left
1502
+ * @param {HTMLElement} params.event.cellElement The cell HTML element that the mouse left
1503
+ * @param {MouseEvent} params.event.event The native DOM event
1504
+ */
1505
+ (e: 'cellMouseLeave', params: ((event: { source: Grid, record: Model, column: Column, cellElement: HTMLElement, event: MouseEvent }) => void)|string): void
1506
+ /**
1507
+ * Fired when a user moves the mouse out of a grid cell
1508
+ * @param {string} e Event name
1509
+ * @param {object} params Event parameters
1510
+ * @param {object} params.event Event object
1511
+ * @param {Grid.view.Grid} params.event.grid The grid instance
1512
+ * @param {Core.data.Model} params.event.record The record representing the row
1513
+ * @param {Grid.column.Column} params.event.column The column to which the cell belongs
1514
+ * @param {HTMLElement} params.event.cellElement The cell HTML element
1515
+ * @param {HTMLElement} params.event.target The target element
1516
+ * @param {MouseEvent} params.event.event The native DOM event
1517
+ */
1518
+ (e: 'cellMouseOut', params: ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string): void
1519
+ /**
1520
+ * Fired when user moves the mouse over a grid cell
1521
+ * @param {string} e Event name
1522
+ * @param {object} params Event parameters
1523
+ * @param {object} params.event Event object
1524
+ * @param {Grid.view.Grid} params.event.grid The grid instance
1525
+ * @param {Core.data.Model} params.event.record The record representing the row
1526
+ * @param {Grid.column.Column} params.event.column The column to which the cell belongs
1527
+ * @param {HTMLElement} params.event.cellElement The cell HTML element
1528
+ * @param {HTMLElement} params.event.target The target element
1529
+ * @param {MouseEvent} params.event.event The native DOM event
1530
+ */
1531
+ (e: 'cellMouseOver', params: ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string): void
1532
+ /**
1533
+ * Fires when a Panel is collapsed using the [collapsible](https://bryntum.com/products/calendar/docs/api/Core/widget/Panel#config-collapsible) setting.
1534
+ * @param {string} e Event name
1535
+ * @param {object} params Event parameters
1536
+ * @param {object} params.event Event object
1537
+ * @param {Core.widget.Panel} params.event.source This Panel.
1538
+ */
1539
+ (e: 'collapse', params: ((event: { source: Panel }) => void)|string): void
1540
+ /**
1541
+ * Fired before a parent node record is collapsed.
1542
+ * @param {string} e Event name
1543
+ * @param {object} params Event parameters
1544
+ * @param {object} params.event Event object
1545
+ * @param {Grid.view.Grid} params.event.source The firing Grid instance.
1546
+ * @param {Core.data.Model} params.event.record The record which has been collapsed.
1547
+ */
1548
+ (e: 'collapseNode', params: ((event: { source: Grid, record: Model }) => void)|string): void
1549
+ /**
1550
+ * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
1551
+ * to indicate whether the drop position is valid or not.
1552
+ * @param {string} e Event name
1553
+ * @param {object} params Event parameters
1554
+ * @param {object} params.event Event object
1555
+ * @param {Grid.view.Grid} params.event.source The grid instance.
1556
+ * @param {Grid.column.Column} params.event.column The dragged column.
1557
+ * @param {Grid.column.Column} params.event.insertBefore The column before which the dragged column will be inserted (if not last).
1558
+ * @param {Event} params.event.event The browser event.
1559
+ * @param {object} params.event.context
1560
+ * @param {boolean} params.event.context.valid Set this to `true` or `false` to indicate whether the drop position is valid.
1561
+ */
1562
+ (e: 'columnDrag', params: ((event: { source: Grid, column: Column, insertBefore: Column, event: Event, context: { valid: boolean } }) => void)|string): void
1563
+ /**
1564
+ * This event is fired when a column drag gesture has started.
1565
+ * @param {string} e Event name
1566
+ * @param {object} params Event parameters
1567
+ * @param {object} params.event Event object
1568
+ * @param {Grid.view.Grid} params.event.source The grid instance.
1569
+ * @param {Grid.column.Column} params.event.column The dragged column.
1570
+ * @param {Event} params.event.event The browser event.
1571
+ */
1572
+ (e: 'columnDragStart', params: ((event: { source: Grid, column: Column, event: Event }) => void)|string): void
1573
+ /**
1574
+ * This event is always fired after a column is dropped. The `valid` param is `true` if the operation was not
1575
+ * vetoed and the column was moved in the column store.
1576
+ * @param {string} e Event name
1577
+ * @param {object} params Event parameters
1578
+ * @param {object} params.event Event object
1579
+ * @param {Grid.view.Grid} params.event.source The grid instance.
1580
+ * @param {Grid.column.Column} params.event.column The dragged column.
1581
+ * @param {Grid.column.Column} params.event.insertBefore The column before which the dragged column will be inserted.
1582
+ * @param {Grid.column.Column} params.event.newParent The new parent column.
1583
+ * @param {boolean} params.event.valid `true` if the operation was not vetoed.
1584
+ * @param {Event} params.event.event The browser event.
1585
+ * @param {string} params.event.region The region where the column was dropped.
1586
+ */
1587
+ (e: 'columnDrop', params: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1588
+ /**
1589
+ * This event is fired after a resize gesture is completed.
1590
+ * @param {string} e Event name
1591
+ * @param {object} params Event parameters
1592
+ * @param {object} params.event Event object
1593
+ * @param {Grid.view.Grid} params.event.source The grid instance
1594
+ * @param {Grid.column.Column} params.event.column The resized column
1595
+ * @param {Event} params.event.domEvent The browser event
1596
+ */
1597
+ (e: 'columnResize', params: ((event: { source: Grid, column: Column, domEvent: Event }) => void)|string): void
1598
+ /**
1599
+ * This event is fired when a column resize gesture starts.
1600
+ * @param {string} e Event name
1601
+ * @param {object} params Event parameters
1602
+ * @param {object} params.event Event object
1603
+ * @param {Grid.view.Grid} params.event.source The grid instance
1604
+ * @param {Grid.column.Column} params.event.column The column
1605
+ * @param {Event} params.event.domEvent The browser event
1606
+ */
1607
+ (e: 'columnResizeStart', params: ((event: { source: Grid, column: Column, domEvent: Event }) => void)|string): void
1608
+ /**
1609
+ * This event fires on the owning widget when an item is selected in the context menu.
1610
+ * @param {string} e Event name
1611
+ * @param {object} params Event parameters
1612
+ * @param {object} params.event Event object
1613
+ * @param {Core.widget.Widget} params.event.source The owning widget
1614
+ * @param {Core.widget.Menu} params.event.menu The menu
1615
+ * @param {Core.widget.MenuItem} params.event.item Selected menu item
1616
+ */
1617
+ (e: 'contextMenuItem', params: ((event: { source: Widget, menu: Menu, item: MenuItem }) => void)|string): void
1618
+ /**
1619
+ * This event fires on the owning widget when a check item is toggled in the context menu.
1620
+ * @param {string} e Event name
1621
+ * @param {object} params Event parameters
1622
+ * @param {object} params.event Event object
1623
+ * @param {Core.widget.Widget} params.event.source The owning widget
1624
+ * @param {Core.widget.Menu} params.event.menu The menu
1625
+ * @param {Core.widget.MenuItem} params.event.item Selected menu item
1626
+ * @param {boolean} params.event.checked Checked or not
1627
+ */
1628
+ (e: 'contextMenuToggleItem', params: ((event: { source: Widget, menu: Menu, item: MenuItem, checked: boolean }) => void)|string): void
1629
+ /**
1630
+ * Fires on the owning Grid after a copy action is performed.
1631
+ * @param {string} e Event name
1632
+ * @param {object} params Event parameters
1633
+ * @param {object} params.event Event object
1634
+ * @param {Grid.view.Grid} params.event.source Owner grid
1635
+ * @param {Grid.util.GridLocation[]} params.event.cells The cells about to be copied or cut
1636
+ * @param {string} params.event.copiedDataString The concatenated data string that was copied or cut
1637
+ * @param {boolean} params.event.isCut `true` if this was a cut action
1638
+ * @param {string} params.event.entityName 'cell' to distinguish this event from other copy events
1639
+ */
1640
+ (e: 'copy', params: ((event: { source: Grid, cells: GridLocation[], copiedDataString: string, isCut: boolean, entityName: string }) => void)|string): void
1641
+ /**
1642
+ * Fired when data in the store changes.
1643
+ * ...
1644
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#event-dataChange)
1645
+ * @param {string} e Event name
1646
+ * @param {object} params Event parameters
1647
+ * @param {object} params.event Event object
1648
+ * @param {Grid.view.Grid} params.event.source Owning grid
1649
+ * @param {Core.data.Store} params.event.store The originating store
1650
+ * @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'`
1651
+ * @param {Core.data.Model} params.event.record Changed record, for actions that affects exactly one record (`'update'`)
1652
+ * @param {Core.data.Model[]} params.event.records Changed records, passed for all actions except `'removeAll'`
1653
+ * @param {object} params.event.changes Passed for the `'update'` action, info on which record fields changed
1654
+ */
1655
+ (e: 'dataChange', params: ((event: { source: Grid, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string): void
1656
+ /**
1657
+ * Fires when an object is destroyed.
1658
+ * @param {string} e Event name
1659
+ * @param {object} params Event parameters
1660
+ * @param {object} params.event Event object
1661
+ * @param {Core.Base} params.event.source The Object that is being destroyed.
1662
+ */
1663
+ (e: 'destroy', params: ((event: { source: Base }) => void)|string): void
1664
+ /**
1665
+ * 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
1666
+ * @param {string} e Event name
1667
+ * @param {object} params Event parameters
1668
+ * @param {object} params.event Event object
1669
+ * @param {Core.widget.Container} params.event.source The container.
1670
+ * @param {boolean} params.event.dirty The dirty state of the Container - `true` if there are any fields which have been changed since initial load.
1671
+ */
1672
+ (e: 'dirtyStateChange', params: ((event: { source: Container, dirty: boolean }) => void)|string): void
1673
+ /**
1674
+ * Fires while drag selecting. UI will update with current range, but the cells will not be selected until
1675
+ * mouse up. This event can be listened for to perform actions while drag selecting.
1676
+ * @param {string} e Event name
1677
+ * @param {object} params Event parameters
1678
+ * @param {object} params.event Event object
1679
+ * @param {Grid.view.Grid} params.event.source
1680
+ * @param {GridLocationConfig[],Grid.util.GridLocation[]} params.event.selectedCells The cells that is currently being dragged over
1681
+ * @param {Core.data.Model[]} params.event.selectedRecords The records that is currently being dragged over
1682
+ */
1683
+ (e: 'dragSelecting', params: ((event: { source: Grid, selectedCells: GridLocationConfig[]|GridLocation[], selectedRecords: Model[] }) => void)|string): void
1684
+ /**
1685
+ * Triggered when a widget's [element](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#property-element) is available.
1686
+ * @param {string} e Event name
1687
+ * @param {object} params Event parameters
1688
+ * @param {object} params.event Event object
1689
+ * @param {HTMLElement} params.event.element The Widget's element.
1690
+ */
1691
+ (e: 'elementCreated', params: ((event: { element: HTMLElement }) => void)|string): void
1692
+ /**
1693
+ * Fires when a Panel is expanded using the [collapsible](https://bryntum.com/products/calendar/docs/api/Core/widget/Panel#config-collapsible) setting.
1694
+ * @param {string} e Event name
1695
+ * @param {object} params Event parameters
1696
+ * @param {object} params.event Event object
1697
+ * @param {Core.widget.Panel} params.event.source This Panel.
1698
+ */
1699
+ (e: 'expand', params: ((event: { source: Panel }) => void)|string): void
1700
+ /**
1701
+ * Fired after a parent node record is expanded.
1702
+ * @param {string} e Event name
1703
+ * @param {object} params Event parameters
1704
+ * @param {object} params.event Event object
1705
+ * @param {Grid.view.Grid} params.event.source The firing Grid instance.
1706
+ * @param {Core.data.Model} params.event.record The record which has been expanded.
1707
+ */
1708
+ (e: 'expandNode', params: ((event: { source: Grid, record: Model }) => void)|string): void
1709
+ /**
1710
+ * Fired when a file is dropped on the widget element
1711
+ * @param {string} e Event name
1712
+ * @param {object} params Event parameters
1713
+ * @param {object} params.event Event object
1714
+ * @param {Grid.view.Grid} params.event.source The owning Grid instance
1715
+ * @param {DataTransferItem} params.event.file The dropped file descriptor
1716
+ * @param {DragEvent} params.event.domEvent The native DragEvent
1717
+ */
1718
+ (e: 'fileDrop', params: ((event: { source: Grid, file: DataTransferItem, domEvent: DragEvent }) => void)|string): void
1719
+ /**
1720
+ * Fired before the FillHandle dragging is finalized and values are applied to cells, return `false` to prevent the
1721
+ * drag operation from applying data changes.
1722
+ * @param {string} e Event name
1723
+ * @param {object} params Event parameters
1724
+ * @param {object} params.event Event object
1725
+ * @param {Grid.util.GridLocation} params.event.from The from cell
1726
+ * @param {Grid.util.GridLocation} params.event.to The to cell
1727
+ * @param {MouseEvent} params.event.domEvent The raw DOM event
1728
+ */
1729
+ (e: 'fillHandleBeforeDragFinalize', params: ((event: { from: GridLocation, to: GridLocation, domEvent: MouseEvent }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1730
+ /**
1731
+ * Fired while dragging the FillHandle.
1732
+ * @param {string} e Event name
1733
+ * @param {object} params Event parameters
1734
+ * @param {object} params.event Event object
1735
+ * @param {Grid.util.GridLocation} params.event.from The from cell
1736
+ * @param {Grid.util.GridLocation} params.event.to The to cell
1737
+ * @param {MouseEvent} params.event.domEvent The raw DOM event
1738
+ */
1739
+ (e: 'fillHandleDrag', params: ((event: { from: GridLocation, to: GridLocation, domEvent: MouseEvent }) => void)|string): void
1740
+ /**
1741
+ * Fired when a FillHandle drag operation is aborted.
1742
+ */
1743
+ (e: 'fillHandleDragAbort', params: (() => void)|string): void
1744
+ /**
1745
+ * Fired after a FillHandle drag operation.
1746
+ * @param {string} e Event name
1747
+ * @param {object} params Event parameters
1748
+ * @param {object} params.event Event object
1749
+ * @param {Grid.util.GridLocation} params.event.from The from cell
1750
+ * @param {Grid.util.GridLocation} params.event.to The to cell
1751
+ * @param {MouseEvent} params.event.domEvent The raw DOM event
1752
+ */
1753
+ (e: 'fillHandleDragEnd', params: ((event: { from: GridLocation, to: GridLocation, domEvent: MouseEvent }) => void)|string): void
1754
+ /**
1755
+ * Fired when dragging of the FillHandle starts.
1756
+ * @param {string} e Event name
1757
+ * @param {object} params Event parameters
1758
+ * @param {object} params.event Event object
1759
+ * @param {Grid.util.GridLocation} params.event.cell Information about the column / record
1760
+ * @param {MouseEvent} params.event.domEvent The raw DOM event
1761
+ */
1762
+ (e: 'fillHandleDragStart', params: ((event: { cell: GridLocation, domEvent: MouseEvent }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1763
+ /**
1764
+ * Fires on the owning Grid when cell editing is finished
1765
+ * @param {string} e Event name
1766
+ * @param {object} params Event parameters
1767
+ * @param {object} params.event Event object
1768
+ * @param {Grid.view.Grid} params.event.grid Target grid
1769
+ * @param {CellEditorContext} params.event.editorContext Editing context
1770
+ */
1771
+ (e: 'finishCellEdit', params: ((event: { grid: Grid, editorContext: CellEditorContext }) => void)|string): void
1772
+ /**
1773
+ * Fires on the owning Grid before the row editing is finished, return false to signal that the value is invalid and editing should not be finalized.
1774
+ * ...
1775
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#event-finishRowEdit)
1776
+ * @param {string} e Event name
1777
+ * @param {object} params Event parameters
1778
+ * @param {object} params.event Event object
1779
+ * @param {Grid.view.Grid} params.event.grid Target grid
1780
+ * @param {RowEditorContext} params.event.editorContext Editing context
1781
+ */
1782
+ (e: 'finishRowEdit', params: ((event: { grid: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1783
+ /**
1784
+ * Fired when focus enters this Widget.
1785
+ * @param {string} e Event name
1786
+ * @param {object} params Event parameters
1787
+ * @param {object} params.event Event object
1788
+ * @param {Core.widget.Widget} params.event.source This Widget
1789
+ * @param {HTMLElement} params.event.fromElement The element which lost focus.
1790
+ * @param {HTMLElement} params.event.toElement The element which gained focus.
1791
+ * @param {Core.widget.Widget} params.event.fromWidget The widget which lost focus.
1792
+ * @param {Core.widget.Widget} params.event.toWidget The widget which gained focus.
1793
+ * @param {boolean} params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
1794
+ */
1795
+ (e: 'focusIn', params: ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string): void
1796
+ /**
1797
+ * Fired when focus exits this Widget's ownership tree. This is different from a `blur` event.
1798
+ * focus moving from within this Widget's ownership tree, even if there are floating widgets
1799
+ * will not trigger this event. This is when focus exits this widget completely.
1800
+ * @param {string} e Event name
1801
+ * @param {object} params Event parameters
1802
+ * @param {object} params.event Event object
1803
+ * @param {Core.widget.Widget} params.event.source This Widget
1804
+ * @param {HTMLElement} params.event.fromElement The element which lost focus.
1805
+ * @param {HTMLElement} params.event.toElement The element which gained focus.
1806
+ * @param {Core.widget.Widget} params.event.fromWidget The widget which lost focus.
1807
+ * @param {Core.widget.Widget} params.event.toWidget The widget which gained focus.
1808
+ * @param {boolean} params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
1809
+ */
1810
+ (e: 'focusOut', params: ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string): void
1811
+ /**
1812
+ * Fired before dragging starts, return false to prevent the drag operation.
1813
+ * @param {string} e Event name
1814
+ * @param {object} params Event parameters
1815
+ * @param {object} params.event Event object
1816
+ * @param {Grid.view.GridBase} params.event.source
1817
+ * @param {object} params.event.context
1818
+ * @param {Core.data.Model[]} params.event.context.records The dragged row records
1819
+ * @param {MouseEvent,TouchEvent} params.event.event
1820
+ */
1821
+ (e: 'gridRowBeforeDragStart', params: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1822
+ /**
1823
+ * Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
1824
+ * Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
1825
+ * @param {string} e Event name
1826
+ * @param {object} params Event parameters
1827
+ * @param {object} params.event Event object
1828
+ * @param {Grid.view.GridBase} params.event.source
1829
+ * @param {object} params.event.context
1830
+ * @param {boolean} params.event.context.valid Set this to true or false to indicate whether the drop position is valid
1831
+ * @param {Core.data.Model} params.event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
1832
+ * @param {Core.data.Model} params.event.context.parent The parent record of the current drop position (only applicable for trees)
1833
+ * @param {Core.data.Model[]} params.event.context.records The dragged row records
1834
+ * @param {RecordPositionContext[]} params.event.context.oldPositionContext An array of objects with information about the previous tree position. Objects contain the `record`, and its original `parentIndex` and `parentId` values
1835
+ * @param {MouseEvent} params.event.event
1836
+ */
1837
+ (e: 'gridRowBeforeDropFinalize', params: ((event: { source: GridBase, context: { valid: boolean, insertBefore: Model, parent: Model, records: Model[], oldPositionContext: RecordPositionContext[] }, event: MouseEvent }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1838
+ /**
1839
+ * Fired while the row is being dragged, in the listener function you have access to `context.insertBefore` a grid /
1840
+ * tree record, and additionally `context.parent` (a TreeNode) for trees. You can signal that the drop position is
1841
+ * valid or invalid by setting `context.valid = false;`
1842
+ * @param {string} e Event name
1843
+ * @param {object} params Event parameters
1844
+ * @param {object} params.event Event object
1845
+ * @param {Grid.view.GridBase} params.event.source
1846
+ * @param {object} params.event.context
1847
+ * @param {boolean} params.event.context.valid Set this to true or false to indicate whether the drop position is valid.
1848
+ * @param {Core.data.Model} params.event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
1849
+ * @param {Core.data.Model} params.event.context.parent The parent record of the current drop position (only applicable for trees)
1850
+ * @param {Core.data.Model[]} params.event.context.records The dragged row records
1851
+ * @param {MouseEvent} params.event.event
1852
+ */
1853
+ (e: 'gridRowDrag', params: ((event: { source: GridBase, context: { valid: boolean, insertBefore: Model, parent: Model, records: Model[] }, event: MouseEvent }) => void)|string): void
1854
+ /**
1855
+ * Fired when a row drag operation is aborted
1856
+ * @param {string} e Event name
1857
+ * @param {object} params Event parameters
1858
+ * @param {object} params.event Event object
1859
+ * @param {Grid.view.GridBase} params.event.source
1860
+ * @param {object} params.event.context
1861
+ * @param {Core.data.Model[]} params.event.context.records The dragged row records
1862
+ * @param {MouseEvent} params.event.event
1863
+ */
1864
+ (e: 'gridRowDragAbort', params: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent }) => void)|string): void
1865
+ /**
1866
+ * Fired when dragging starts.
1867
+ * @param {string} e Event name
1868
+ * @param {object} params Event parameters
1869
+ * @param {object} params.event Event object
1870
+ * @param {Grid.view.GridBase} params.event.source
1871
+ * @param {object} params.event.context
1872
+ * @param {Core.data.Model[]} params.event.context.records The dragged row records
1873
+ * @param {MouseEvent,TouchEvent} params.event.event
1874
+ */
1875
+ (e: 'gridRowDragStart', params: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => void)|string): void
1876
+ /**
1877
+ * Fired after the row drop operation has completed, regardless of validity
1878
+ * @param {string} e Event name
1879
+ * @param {object} params Event parameters
1880
+ * @param {object} params.event Event object
1881
+ * @param {Grid.view.GridBase} params.event.source
1882
+ * @param {object} params.event.context
1883
+ * @param {boolean} params.event.context.valid true or false depending on whether the drop position was valid
1884
+ * @param {Core.data.Model} params.event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
1885
+ * @param {Core.data.Model} params.event.context.parent The parent record of the current drop position (only applicable for trees)
1886
+ * @param {Core.data.Model[]} params.event.context.records The dragged row records
1887
+ * @param {RecordPositionContext[]} params.event.context.oldPositionContext An array of objects with information about the previous tree position. Objects contain the record, and its original `parentIndex` and `parentId` values
1888
+ * @param {MouseEvent} params.event.event
1889
+ */
1890
+ (e: 'gridRowDrop', params: ((event: { source: GridBase, context: { valid: boolean, insertBefore: Model, parent: Model, records: Model[], oldPositionContext: RecordPositionContext[] }, event: MouseEvent }) => void)|string): void
1891
+ /**
1892
+ * Fired when a grid header is clicked on.
1893
+ * ...
1894
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#event-headerClick)
1895
+ * @param {string} e Event name
1896
+ * @param {object} params Event parameters
1897
+ * @param {object} params.event Event object
1898
+ * @param {Event} params.event.domEvent The triggering DOM event.
1899
+ * @param {Grid.column.Column} params.event.column The column clicked on.
1900
+ */
1901
+ (e: 'headerClick', params: ((event: { domEvent: Event, column: Column }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1902
+ /**
1903
+ * This event fires on the owning Grid before the context menu is shown for a header.
1904
+ * Allows manipulation of the items to show in the same way as in the [processItems](https://bryntum.com/products/calendar/docs/api/Grid/feature/HeaderMenu#config-processItems).
1905
+ * ...
1906
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#event-headerMenuBeforeShow)
1907
+ * @param {string} e Event name
1908
+ * @param {object} params Event parameters
1909
+ * @param {object} params.event Event object
1910
+ * @param {Grid.view.Grid} params.event.source The grid
1911
+ * @param {Core.widget.Menu} params.event.menu The menu
1912
+ * @param {Record<string, MenuItemEntry>} params.event.items Menu item configs
1913
+ * @param {Grid.column.Column} params.event.column Column
1914
+ */
1915
+ (e: 'headerMenuBeforeShow', params: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1916
+ /**
1917
+ * This event fires on the owning Grid when an item is selected in the header context menu.
1918
+ * @param {string} e Event name
1919
+ * @param {object} params Event parameters
1920
+ * @param {object} params.event Event object
1921
+ * @param {Grid.view.Grid} params.event.source The grid
1922
+ * @param {Core.widget.Menu} params.event.menu The menu
1923
+ * @param {Core.widget.MenuItem} params.event.item Selected menu item
1924
+ * @param {Grid.column.Column} params.event.column Column
1925
+ */
1926
+ (e: 'headerMenuItem', params: ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column }) => void)|string): void
1927
+ /**
1928
+ * This event fires on the owning Grid after the context menu is shown for a header
1929
+ * @param {string} e Event name
1930
+ * @param {object} params Event parameters
1931
+ * @param {object} params.event Event object
1932
+ * @param {Grid.view.Grid} params.event.source The grid
1933
+ * @param {Core.widget.Menu} params.event.menu The menu
1934
+ * @param {Record<string, MenuItemEntry>} params.event.items Menu item configs
1935
+ * @param {Grid.column.Column} params.event.column Column
1936
+ */
1937
+ (e: 'headerMenuShow', params: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => void)|string): void
1938
+ /**
1939
+ * This event fires on the owning Grid when a check item is toggled in the header context menu.
1940
+ * @param {string} e Event name
1941
+ * @param {object} params Event parameters
1942
+ * @param {object} params.event Event object
1943
+ * @param {Grid.view.Grid} params.event.source The grid
1944
+ * @param {Core.widget.Menu} params.event.menu The menu
1945
+ * @param {Core.widget.MenuItem} params.event.item Selected menu item
1946
+ * @param {Grid.column.Column} params.event.column Column
1947
+ * @param {boolean} params.event.checked Checked or not
1948
+ */
1949
+ (e: 'headerMenuToggleItem', params: ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column, checked: boolean }) => void)|string): void
1950
+ /**
1951
+ * Triggered after a widget was hidden
1952
+ * @param {string} e Event name
1953
+ * @param {object} params Event parameters
1954
+ * @param {object} params.event Event object
1955
+ * @param {Core.widget.Widget} params.event.source The widget
1956
+ */
1957
+ (e: 'hide', params: ((event: { source: Widget }) => void)|string): void
1958
+ /**
1959
+ * Fires when row locking is enabled.
1960
+ * @param {string} e Event name
1961
+ * @param {object} params Event parameters
1962
+ * @param {object} params.event Event object
1963
+ * @param {Grid.view.GridBase} params.event.clone The created clone
1964
+ */
1965
+ (e: 'lockRows', params: ((event: { clone: GridBase }) => void)|string): void
1966
+ /**
1967
+ * Mouse moved out from element in grid
1968
+ * @param {string} e Event name
1969
+ * @param {object} params Event parameters
1970
+ * @param {object} params.event Event object
1971
+ * @param {MouseEvent} params.event.event The native browser event
1972
+ */
1973
+ (e: 'mouseOut', params: ((event: { event: MouseEvent }) => void)|string): void
1974
+ /**
1975
+ * Mouse moved in over element in grid
1976
+ * @param {string} e Event name
1977
+ * @param {object} params Event parameters
1978
+ * @param {object} params.event Event object
1979
+ * @param {MouseEvent} params.event.event The native browser event
1980
+ */
1981
+ (e: 'mouseOver', params: ((event: { event: MouseEvent }) => void)|string): void
1982
+ /**
1983
+ * Triggered when a widget which had been in a non-visible state for any reason
1984
+ * achieves visibility.
1985
+ * ...
1986
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#event-paint)
1987
+ * @param {string} e Event name
1988
+ * @param {object} params Event parameters
1989
+ * @param {object} params.event Event object
1990
+ * @param {Core.widget.Widget} params.event.source The widget being painted.
1991
+ * @param {boolean} params.event.firstPaint `true` if this is the first paint.
1992
+ */
1993
+ (e: 'paint', params: ((event: { source: Widget, firstPaint: boolean }) => void)|string): void
1994
+ /**
1995
+ * Fires on the owning Grid after a paste action is performed.
1996
+ * @param {string} e Event name
1997
+ * @param {object} params Event parameters
1998
+ * @param {object} params.event Event object
1999
+ * @param {Grid.view.Grid} params.event.source Owner grid
2000
+ * @param {string} params.event.clipboardData The clipboardData that was pasted
2001
+ * @param {Core.data.Model[]} params.event.modifiedRecords The records which have been modified due to the paste action
2002
+ * @param {Grid.util.GridLocation} params.event.targetCell The cell from which the paste will be started
2003
+ * @param {string} params.event.entityName 'cell' to distinguish this event from other paste events
2004
+ */
2005
+ (e: 'paste', params: ((event: { source: Grid, clipboardData: string, modifiedRecords: Model[], targetCell: GridLocation, entityName: string }) => void)|string): void
2006
+ /**
2007
+ * Fires on the owning Grid when export has finished
2008
+ * @param {string} e Event name
2009
+ * @param {object} params Event parameters
2010
+ * @param {object} params.event Event object
2011
+ * @param {Response} params.event.response Optional response, if received
2012
+ * @param {Error} params.event.error Optional error, if exception occurred
2013
+ */
2014
+ (e: 'pdfExport', params: ((event: { response?: any, error?: Error }) => void)|string): void
2015
+ /**
2016
+ * Fired when a Widget's read only state is toggled
2017
+ * @param {string} e Event name
2018
+ * @param {object} params Event parameters
2019
+ * @param {object} params.event Event object
2020
+ * @param {boolean} params.event.readOnly Read only or not
2021
+ */
2022
+ (e: 'readOnly', params: ((event: { readOnly: boolean }) => void)|string): void
2023
+ /**
2024
+ * This event is fired after a widget's elements have been synchronized due to a direct or indirect call
2025
+ * 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.
2026
+ */
2027
+ (e: 'recompose', params: (() => void)|string): void
2028
+ /**
2029
+ * Fires after a row is rendered.
2030
+ * @param {string} e Event name
2031
+ * @param {object} params Event parameters
2032
+ * @param {object} params.event Event object
2033
+ * @param {Grid.view.Grid} params.event.source The firing Grid instance.
2034
+ * @param {Grid.row.Row} params.event.row The row that has been rendered.
2035
+ * @param {Core.data.Model} params.event.record The record for the row.
2036
+ * @param {number} params.event.recordIndex The zero-based index of the record.
2037
+ */
2038
+ (e: 'renderRow', params: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string): void
2039
+ /**
2040
+ * Grid rows have been rendered
2041
+ * @param {string} e Event name
2042
+ * @param {object} params Event parameters
2043
+ * @param {object} params.event Event object
2044
+ * @param {Grid.view.Grid} params.event.source This grid.
2045
+ */
2046
+ (e: 'renderRows', params: ((event: { source: Grid }) => void)|string): void
2047
+ /**
2048
+ * 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`*.
2049
+ * @param {string} e Event name
2050
+ * @param {object} params Event parameters
2051
+ * @param {object} params.event Event object
2052
+ * @param {Core.widget.Widget} params.event.source This Widget
2053
+ * @param {number} params.event.width The new width
2054
+ * @param {number} params.event.height The new height
2055
+ * @param {number} params.event.oldWidth The old width
2056
+ * @param {number} params.event.oldHeight The old height
2057
+ */
2058
+ (e: 'resize', params: ((event: { source: Widget, width: number, height: number, oldWidth: number, oldHeight: number }) => void)|string): void
2059
+ /**
2060
+ * Grid resize lead to a new responsive level being applied
2061
+ * @param {string} e Event name
2062
+ * @param {object} params Event parameters
2063
+ * @param {object} params.event Event object
2064
+ * @param {Grid.view.Grid} params.event.grid Grid that was resized
2065
+ * @param {string} params.event.level New responsive level (small, large, etc)
2066
+ * @param {number} params.event.width New width in px
2067
+ * @param {string} params.event.oldLevel Old responsive level
2068
+ * @param {number} params.event.oldWidth Old width in px
2069
+ */
2070
+ (e: 'responsive', params: ((event: { grid: Grid, level: string, width: number, oldLevel: string, oldWidth: number }) => void)|string): void
2071
+ /**
2072
+ * This event fires when a row has finished collapsing.
2073
+ * @param {string} e Event name
2074
+ * @param {object} params Event parameters
2075
+ * @param {object} params.event Event object
2076
+ * @param {Core.data.Model} params.event.record Record
2077
+ */
2078
+ (e: 'rowCollapse', params: ((event: { record: Model }) => void)|string): void
2079
+ /**
2080
+ * This event fires when a row expand has finished expanding.
2081
+ * ...
2082
+ * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#event-rowExpand)
2083
+ * @param {string} e Event name
2084
+ * @param {object} params Event parameters
2085
+ * @param {object} params.event Event object
2086
+ * @param {Core.data.Model} params.event.record Record
2087
+ * @param {object} params.event.expandedElements An object with the Grid region name as property and the expanded body element as value
2088
+ * @param {Core.widget.Widget} params.event.widget In case of expanding a Widget, this will be a reference to the instance created by the actual expansion. If there is multiple Grid regions, use the `widgets` param instead.
2089
+ * @param {object} params.event.widgets In case of expanding a Widget, this will be an object with the Grid region name as property and the reference to the widget instance created by the actual expansion
2090
+ */
2091
+ (e: 'rowExpand', params: ((event: { record: Model, expandedElements: object, widget: Widget, widgets: object }) => void)|string): void
2092
+ /**
2093
+ * Fired when the mouse enters a row
2094
+ * @param {string} e Event name
2095
+ * @param {object} params Event parameters
2096
+ * @param {object} params.event Event object
2097
+ * @param {Grid.view.Grid} params.event.source The grid instance
2098
+ * @param {Core.data.Model} params.event.record The record representing the hovered row
2099
+ * @param {Grid.column.Column} params.event.column The column currently hovered
2100
+ * @param {HTMLElement} params.event.cellElement The cell HTML element
2101
+ * @param {MouseEvent} params.event.event The native DOM event
2102
+ */
2103
+ (e: 'rowMouseEnter', params: ((event: { source: Grid, record: Model, column: Column, cellElement: HTMLElement, event: MouseEvent }) => void)|string): void
2104
+ /**
2105
+ * Fired when the mouse leaves a row
2106
+ * @param {string} e Event name
2107
+ * @param {object} params Event parameters
2108
+ * @param {object} params.event Event object
2109
+ * @param {Grid.view.Grid} params.event.source The grid instance
2110
+ * @param {Core.data.Model} params.event.record The record representing the row that the mouse left
2111
+ * @param {HTMLElement} params.event.cellElement The cell HTML element that the mouse left
2112
+ * @param {MouseEvent} params.event.event The native DOM event
2113
+ */
2114
+ (e: 'rowMouseLeave', params: ((event: { source: Grid, record: Model, cellElement: HTMLElement, event: MouseEvent }) => void)|string): void
2115
+ /**
2116
+ * Grid has scrolled vertically
2117
+ * @param {string} e Event name
2118
+ * @param {object} params Event parameters
2119
+ * @param {object} params.event Event object
2120
+ * @param {Grid.view.Grid} params.event.source The firing Grid instance.
2121
+ * @param {number} params.event.scrollTop The vertical scroll position.
2122
+ */
2123
+ (e: 'scroll', params: ((event: { source: Grid, scrollTop: number }) => void)|string): void
2124
+ /**
2125
+ * The selection has been changed.
2126
+ * @param {string} e Event name
2127
+ * @param {object} params Event parameters
2128
+ * @param {object} params.event Event object
2129
+ * @param {'select','deselect'} params.event.action `'select'`/`'deselect'`
2130
+ * @param {'row','cell'} params.event.mode `'row'`/`'cell'`
2131
+ * @param {Grid.view.Grid} params.event.source
2132
+ * @param {Core.data.Model[]} params.event.deselected The records deselected in this operation.
2133
+ * @param {Core.data.Model[]} params.event.selected The records selected in this operation.
2134
+ * @param {Core.data.Model[]} params.event.selection The records in the new selection.
2135
+ * @param {Grid.util.GridLocation[]} params.event.deselectedCells The cells deselected in this operation.
2136
+ * @param {Grid.util.GridLocation[]} params.event.selectedCells The cells selected in this operation.
2137
+ * @param {Grid.util.GridLocation[]} params.event.cellSelection The cells in the new selection.
2138
+ */
2139
+ (e: 'selectionChange', params: ((event: { action: 'select'|'deselect', mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => void)|string): void
2140
+ /**
2141
+ * The selectionMode configuration has been changed.
2142
+ * @param {string} e Event name
2143
+ * @param {object} params Event parameters
2144
+ * @param {object} params.event Event object
2145
+ * @param {object} params.event.selectionMode The new [selectionMode](https://bryntum.com/products/calendar/docs/api/Grid/view/mixin/GridSelection#config-selectionMode)
2146
+ */
2147
+ (e: 'selectionModeChange', params: ((event: { selectionMode: object }) => void)|string): void
2148
+ /**
2149
+ * Triggered after a widget is shown.
2150
+ * @param {string} e Event name
2151
+ * @param {object} params Event parameters
2152
+ * @param {object} params.event Event object
2153
+ * @param {Core.widget.Widget} params.event.source The widget
2154
+ */
2155
+ (e: 'show', params: ((event: { source: Widget }) => void)|string): void
2156
+ /**
2157
+ * Fires when splitting the Grid.
2158
+ * @param {string} e Event name
2159
+ * @param {object} params Event parameters
2160
+ * @param {object} params.event Event object
2161
+ * @param {Grid.view.GridBase[]} params.event.subViews The sub views created by the split
2162
+ * @param {object} params.event.options The options passed to the split call
2163
+ * @param {'horizontal','vertical','both'} params.event.options.direction The direction of the split
2164
+ * @param {Grid.column.Column} params.event.options.atColumn The column to split at
2165
+ * @param {Core.data.Model} params.event.options.atRecord The record to split at
2166
+ */
2167
+ (e: 'split', params: ((event: { subViews: GridBase[], options: { direction: 'horizontal'|'vertical'|'both', atColumn: Column, atRecord: Model } }) => void)|string): void
2168
+ /**
2169
+ * Fired by the Grid when the collapse icon is clicked. Return `false` to prevent the default collapse action,
2170
+ * if you want to implement your own behavior.
2171
+ * @param {string} e Event name
2172
+ * @param {object} params Event parameters
2173
+ * @param {object} params.event Event object
2174
+ * @param {Grid.view.Grid} params.event.source The Grid instance.
2175
+ * @param {Grid.view.SubGrid} params.event.subGrid The subgrid
2176
+ * @param {Event} params.event.domEvent The native DOM event
2177
+ */
2178
+ (e: 'splitterCollapseClick', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
2179
+ /**
2180
+ * Fired by the Grid after a sub-grid has been resized using the splitter
2181
+ * @param {string} e Event name
2182
+ * @param {object} params Event parameters
2183
+ * @param {object} params.event Event object
2184
+ * @param {Grid.view.Grid} params.event.source The Grid instance.
2185
+ * @param {Grid.view.SubGrid} params.event.subGrid The resized subgrid
2186
+ * @param {Event} params.event.domEvent The native DOM event
2187
+ */
2188
+ (e: 'splitterDragEnd', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => void)|string): void
2189
+ /**
2190
+ * Fired by the Grid when a sub-grid resize gesture starts
2191
+ * @param {string} e Event name
2192
+ * @param {object} params Event parameters
2193
+ * @param {object} params.event Event object
2194
+ * @param {Grid.view.Grid} params.event.source The Grid instance.
2195
+ * @param {Grid.view.SubGrid} params.event.subGrid The subgrid about to be resized
2196
+ * @param {Event} params.event.domEvent The native DOM event
2197
+ */
2198
+ (e: 'splitterDragStart', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => void)|string): void
2199
+ /**
2200
+ * Fired by the Grid when the expand icon is clicked. Return `false` to prevent the default expand action,
2201
+ * if you want to implement your own behavior.
2202
+ * @param {string} e Event name
2203
+ * @param {object} params Event parameters
2204
+ * @param {object} params.event Event object
2205
+ * @param {Grid.view.Grid} params.event.source The Grid instance.
2206
+ * @param {Grid.view.SubGrid} params.event.subGrid The subgrid
2207
+ * @param {Event} params.event.domEvent The native DOM event
2208
+ */
2209
+ (e: 'splitterExpandClick', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
2210
+ /**
2211
+ * Fires on the owning Grid when editing starts
2212
+ * @param {string} e Event name
2213
+ * @param {object} params Event parameters
2214
+ * @param {object} params.event Event object
2215
+ * @param {Grid.view.Grid} params.event.source Owner grid
2216
+ * @param {CellEditorContext} params.event.editorContext Editing context
2217
+ */
2218
+ (e: 'startCellEdit', params: ((event: { source: Grid, editorContext: CellEditorContext }) => void)|string): void
2219
+ /**
2220
+ * Fires on the owning Grid when editing starts
2221
+ * @param {string} e Event name
2222
+ * @param {object} params Event parameters
2223
+ * @param {object} params.event Event object
2224
+ * @param {Grid.view.Grid} params.event.source Owner grid
2225
+ * @param {RowEditorContext} params.event.editorContext Editing context
2226
+ */
2227
+ (e: 'startRowEdit', params: ((event: { source: Grid, editorContext: RowEditorContext }) => void)|string): void
2228
+ /**
2229
+ * Fires after a sub grid is collapsed.
2230
+ * @param {string} e Event name
2231
+ * @param {object} params Event parameters
2232
+ * @param {object} params.event Event object
2233
+ * @param {Grid.view.Grid} params.event.source The firing Grid instance
2234
+ * @param {Grid.view.SubGrid} params.event.subGrid The sub grid instance
2235
+ */
2236
+ (e: 'subGridCollapse', params: ((event: { source: Grid, subGrid: SubGrid }) => void)|string): void
2237
+ /**
2238
+ * Fires after a sub grid is expanded.
2239
+ * @param {string} e Event name
2240
+ * @param {object} params Event parameters
2241
+ * @param {object} params.event Event object
2242
+ * @param {Grid.view.Grid} params.event.source The firing Grid instance
2243
+ * @param {Grid.view.SubGrid} params.event.subGrid The sub grid instance
2244
+ */
2245
+ (e: 'subGridExpand', params: ((event: { source: Grid, subGrid: SubGrid }) => void)|string): void
2246
+ /**
2247
+ * Fired when one or more groups are expanded or collapsed
2248
+ * @param {string} e Event name
2249
+ * @param {object} params Event parameters
2250
+ * @param {object} params.event Event object
2251
+ * @param {Core.data.Model} params.event.groupRecord [DEPRECATED] Use `groupRecords` param instead
2252
+ * @param {Core.data.Model[]} params.event.groupRecords The group records being toggled
2253
+ * @param {boolean} params.event.collapse Collapsed (true) or expanded (false)
2254
+ * @param {boolean} params.event.allRecords True if this event is part of toggling all groups
2255
+ */
2256
+ (e: 'toggleGroup', params: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, allRecords?: boolean }) => void)|string): void
2257
+ /**
2258
+ * Fired after a parent node record toggles its collapsed state.
2259
+ * @param {string} e Event name
2260
+ * @param {object} params Event parameters
2261
+ * @param {object} params.event Event object
2262
+ * @param {Core.data.Model} params.event.record The record being toggled.
2263
+ * @param {boolean} params.event.collapse `true` if the node is being collapsed.
2264
+ */
2265
+ (e: 'toggleNode', params: ((event: { record: Model, collapse: boolean }) => void)|string): void
2266
+ /**
2267
+ * A header [tool](https://bryntum.com/products/calendar/docs/api/Core/widget/Panel#config-tools) has been clicked.
2268
+ * @param {string} e Event name
2269
+ * @param {object} params Event parameters
2270
+ * @param {object} params.event Event object
2271
+ * @param {Core.widget.Tool} params.event.source This Panel.
2272
+ * @param {Core.widget.Tool} params.event.tool The tool which is being clicked.
2273
+ */
2274
+ (e: 'toolClick', params: ((event: { source: Tool, tool: Tool }) => void)|string): void
2275
+ /**
2276
+ * Fires when row locking is disabled.
2277
+ * @param {string} e Event name
2278
+ * @param {object} params Event parameters
2279
+ * @param {object} params.event Event object
2280
+ * @param {Grid.view.GridBase} params.event.clone The locked clone that will be destroyed
2281
+ */
2282
+ (e: 'unlockRows', params: ((event: { clone: GridBase }) => void)|string): void
2283
+ /**
2284
+ * Fires when un-splitting the Grid.
2285
+ */
2286
+ (e: 'unsplit', params: (() => void)|string): void
2287
+ }>();
2288
+
2289
+ const widgetData = {
2290
+ instanceClass : Grid,
2291
+ instanceName : 'Grid',
2292
+
2293
+ isView : true,
2294
+ dataStores : {
2295
+ 'originalStore': 'originals',
2296
+ 'store': 'data'
2297
+ },
2298
+ projectStores : false,
2299
+ featureNames : [
2300
+ 'aiFilterFeature',
2301
+ 'cellCopyPasteFeature',
2302
+ 'cellEditFeature',
2303
+ 'cellMenuFeature',
2304
+ 'cellTooltipFeature',
2305
+ 'chartsFeature',
2306
+ 'columnAutoWidthFeature',
2307
+ 'columnDragToolbarFeature',
2308
+ 'columnPickerFeature',
2309
+ 'columnRenameFeature',
2310
+ 'columnReorderFeature',
2311
+ 'columnResizeFeature',
2312
+ 'excelExporterFeature',
2313
+ 'fileDropFeature',
2314
+ 'fillHandleFeature',
2315
+ 'filterFeature',
2316
+ 'filterBarFeature',
2317
+ 'groupFeature',
2318
+ 'groupSummaryFeature',
2319
+ 'headerMenuFeature',
2320
+ 'lockRowsFeature',
2321
+ 'mergeCellsFeature',
2322
+ 'pdfExportFeature',
2323
+ 'pinColumnsFeature',
2324
+ 'printFeature',
2325
+ 'quickFindFeature',
2326
+ 'regionResizeFeature',
2327
+ 'rowCopyPasteFeature',
2328
+ 'rowEditFeature',
2329
+ 'rowExpanderFeature',
2330
+ 'rowReorderFeature',
2331
+ 'rowResizeFeature',
2332
+ 'searchFeature',
2333
+ 'sortFeature',
2334
+ 'splitFeature',
2335
+ 'stickyCellsFeature',
2336
+ 'stripeFeature',
2337
+ 'summaryFeature',
2338
+ 'treeFeature',
2339
+ 'treeGroupFeature'
2340
+ ],
2341
+
2342
+ configNames : [
2343
+ 'adopt',
2344
+ 'animateFilterRemovals',
2345
+ 'animateRemovingRows',
2346
+ 'ariaDescription',
2347
+ 'ariaLabel',
2348
+ 'autoHeight',
2349
+ 'bbar',
2350
+ 'bodyCls',
2351
+ 'bubbleEvents',
2352
+ 'collapsible',
2353
+ 'color',
2354
+ 'config',
2355
+ 'contentElementCls',
2356
+ 'contextMenuTriggerEvent',
2357
+ 'dataField',
2358
+ 'defaultRegion',
2359
+ 'destroyStore',
2360
+ 'detectCSSCompatibilityIssues',
2361
+ 'disableGridColumnIdWarning',
2362
+ 'disableGridRowModelWarning',
2363
+ 'dock',
2364
+ 'drawer',
2365
+ 'elementAttributes',
2366
+ 'enableSticky',
2367
+ 'enableTextSelection',
2368
+ 'fillLastColumn',
2369
+ 'fixedRowHeight',
2370
+ 'footer',
2371
+ 'formulaProviders',
2372
+ 'fullRowRefresh',
2373
+ 'getRowHeight',
2374
+ 'header',
2375
+ 'hideHorizontalScrollbar',
2376
+ 'hoverCls',
2377
+ 'icon',
2378
+ 'ignoreParentReadOnly',
2379
+ 'listeners',
2380
+ 'loadMask',
2381
+ 'loadMaskDefaults',
2382
+ 'loadMaskError',
2383
+ 'localizable',
2384
+ 'maskDefaults',
2385
+ 'masked',
2386
+ 'monitorResize',
2387
+ 'owner',
2388
+ 'plugins',
2389
+ 'preserveFocusOnDatasetChange',
2390
+ 'preserveScrollOnDatasetChange',
2391
+ 'preventTooltipOnTouch',
2392
+ 'relayStoreEvents',
2393
+ 'resizable',
2394
+ 'resizeToFitIncludesHeader',
2395
+ 'responsiveLevels',
2396
+ 'ripple',
2397
+ 'rootElement',
2398
+ 'scrollerClass',
2399
+ 'scrollManager',
2400
+ 'showDirty',
2401
+ 'stateful',
2402
+ 'statefulEvents',
2403
+ 'stateId',
2404
+ 'stateProvider',
2405
+ 'strips',
2406
+ 'subGridConfigs',
2407
+ 'syncMask',
2408
+ 'tab',
2409
+ 'tabBarItems',
2410
+ 'tbar',
2411
+ 'type',
2412
+ 'ui',
2413
+ 'weight'
2414
+ ],
2415
+ propertyConfigNames : [
2416
+ 'alignSelf',
2417
+ 'animateTreeNodeToggle',
2418
+ 'appendTo',
2419
+ 'callOnFunctions',
2420
+ 'catchEventHandlerExceptions',
2421
+ 'cellEllipsis',
2422
+ 'cls',
2423
+ 'collapsed',
2424
+ 'column',
2425
+ 'columnLines',
2426
+ 'columns',
2427
+ 'data',
2428
+ 'dataset',
2429
+ 'disabled',
2430
+ 'emptyText',
2431
+ 'enableUndoRedoKeys',
2432
+ 'extraData',
2433
+ 'flex',
2434
+ 'height',
2435
+ 'hidden',
2436
+ 'hideFooters',
2437
+ 'hideHeaders',
2438
+ 'id',
2439
+ 'inputFieldAlign',
2440
+ 'insertBefore',
2441
+ 'insertFirst',
2442
+ 'keyMap',
2443
+ 'labelPosition',
2444
+ 'longPressTime',
2445
+ 'margin',
2446
+ 'maxHeight',
2447
+ 'maxWidth',
2448
+ 'minHeight',
2449
+ 'minWidth',
2450
+ 'onBeforeCancelCellEdit',
2451
+ 'onBeforeCancelRowEdit',
2452
+ 'onBeforeCellEditStart',
2453
+ 'onBeforeCellRangeDelete',
2454
+ 'onBeforeCellRangeEdit',
2455
+ 'onBeforeColumnDragStart',
2456
+ 'onBeforeColumnDropFinalize',
2457
+ 'onBeforeColumnResize',
2458
+ 'onBeforeCopy',
2459
+ 'onBeforeCSVExport',
2460
+ 'onBeforeDestroy',
2461
+ 'onBeforeExcelExport',
2462
+ 'onBeforeFillHandleDragStart',
2463
+ 'onBeforeFinishCellEdit',
2464
+ 'onBeforeFinishRowEdit',
2465
+ 'onBeforeHide',
2466
+ 'onBeforePaste',
2467
+ 'onBeforePdfExport',
2468
+ 'onBeforeRenderRow',
2469
+ 'onBeforeRenderRows',
2470
+ 'onBeforeRowCollapse',
2471
+ 'onBeforeRowExpand',
2472
+ 'onBeforeSelectionChange',
2473
+ 'onBeforeSetRecord',
2474
+ 'onBeforeShow',
2475
+ 'onBeforeStartRowEdit',
2476
+ 'onBeforeStateApply',
2477
+ 'onBeforeStateSave',
2478
+ 'onBeforeToggleGroup',
2479
+ 'onBeforeToggleNode',
2480
+ 'onCancelCellEdit',
2481
+ 'onCatchAll',
2482
+ 'onCellClick',
2483
+ 'onCellContextMenu',
2484
+ 'onCellDblClick',
2485
+ 'onCellMenuBeforeShow',
2486
+ 'onCellMenuItem',
2487
+ 'onCellMenuShow',
2488
+ 'onCellMenuToggleItem',
2489
+ 'onCellMouseEnter',
2490
+ 'onCellMouseLeave',
2491
+ 'onCellMouseOut',
2492
+ 'onCellMouseOver',
2493
+ 'onCollapse',
2494
+ 'onCollapseNode',
2495
+ 'onColumnDrag',
2496
+ 'onColumnDragStart',
2497
+ 'onColumnDrop',
2498
+ 'onColumnResize',
2499
+ 'onColumnResizeStart',
2500
+ 'onContextMenuItem',
2501
+ 'onContextMenuToggleItem',
2502
+ 'onCopy',
2503
+ 'onDataChange',
2504
+ 'onDestroy',
2505
+ 'onDirtyStateChange',
2506
+ 'onDragSelecting',
2507
+ 'onElementCreated',
2508
+ 'onExpand',
2509
+ 'onExpandNode',
2510
+ 'onFileDrop',
2511
+ 'onFillHandleBeforeDragFinalize',
2512
+ 'onFillHandleDrag',
2513
+ 'onFillHandleDragAbort',
2514
+ 'onFillHandleDragEnd',
2515
+ 'onFillHandleDragStart',
2516
+ 'onFinishCellEdit',
2517
+ 'onFinishRowEdit',
2518
+ 'onFocusIn',
2519
+ 'onFocusOut',
2520
+ 'onGridRowBeforeDragStart',
2521
+ 'onGridRowBeforeDropFinalize',
2522
+ 'onGridRowDrag',
2523
+ 'onGridRowDragAbort',
2524
+ 'onGridRowDragStart',
2525
+ 'onGridRowDrop',
2526
+ 'onHeaderClick',
2527
+ 'onHeaderMenuBeforeShow',
2528
+ 'onHeaderMenuItem',
2529
+ 'onHeaderMenuShow',
2530
+ 'onHeaderMenuToggleItem',
2531
+ 'onHide',
2532
+ 'onLockRows',
2533
+ 'onMouseOut',
2534
+ 'onMouseOver',
2535
+ 'onPaint',
2536
+ 'onPaste',
2537
+ 'onPdfExport',
2538
+ 'onReadOnly',
2539
+ 'onRecompose',
2540
+ 'onRenderRow',
2541
+ 'onRenderRows',
2542
+ 'onResize',
2543
+ 'onResponsive',
2544
+ 'onRowCollapse',
2545
+ 'onRowExpand',
2546
+ 'onRowMouseEnter',
2547
+ 'onRowMouseLeave',
2548
+ 'onScroll',
2549
+ 'onSelectionChange',
2550
+ 'onSelectionModeChange',
2551
+ 'onShow',
2552
+ 'onSplit',
2553
+ 'onSplitterCollapseClick',
2554
+ 'onSplitterDragEnd',
2555
+ 'onSplitterDragStart',
2556
+ 'onSplitterExpandClick',
2557
+ 'onStartCellEdit',
2558
+ 'onStartRowEdit',
2559
+ 'onSubGridCollapse',
2560
+ 'onSubGridExpand',
2561
+ 'onToggleGroup',
2562
+ 'onToggleNode',
2563
+ 'onToolClick',
2564
+ 'onUnlockRows',
2565
+ 'onUnsplit',
2566
+ 'preserveScroll',
2567
+ 'readOnly',
2568
+ 'rendition',
2569
+ 'rowHeight',
2570
+ 'rowLines',
2571
+ 'rtl',
2572
+ 'scrollable',
2573
+ 'selectionMode',
2574
+ 'span',
2575
+ 'stateSettings',
2576
+ 'store',
2577
+ 'title',
2578
+ 'tools',
2579
+ 'transition',
2580
+ 'transitionDuration',
2581
+ 'width'
2582
+ ],
2583
+ propertyNames : [
2584
+ 'focusVisible',
2585
+ 'hasChanges',
2586
+ 'originalStore',
2587
+ 'parent',
2588
+ 'selectedCell',
2589
+ 'selectedCells',
2590
+ 'selectedRecord',
2591
+ 'selectedRecords',
2592
+ 'selectedRows',
2593
+ 'state',
2594
+ 'tooltip'
2595
+ ],
2596
+ eventNames : [
2597
+ 'beforeCancelCellEdit',
2598
+ 'beforeCancelRowEdit',
2599
+ 'beforeCellEditStart',
2600
+ 'beforeCellRangeDelete',
2601
+ 'beforeCellRangeEdit',
2602
+ 'beforeColumnDragStart',
2603
+ 'beforeColumnDropFinalize',
2604
+ 'beforeColumnResize',
2605
+ 'beforeCopy',
2606
+ 'beforeCSVExport',
2607
+ 'beforeDestroy',
2608
+ 'beforeExcelExport',
2609
+ 'beforeFillHandleDragStart',
2610
+ 'beforeFinishCellEdit',
2611
+ 'beforeFinishRowEdit',
2612
+ 'beforeHide',
2613
+ 'beforePaste',
2614
+ 'beforePdfExport',
2615
+ 'beforeRenderRow',
2616
+ 'beforeRenderRows',
2617
+ 'beforeRowCollapse',
2618
+ 'beforeRowExpand',
2619
+ 'beforeSelectionChange',
2620
+ 'beforeSetRecord',
2621
+ 'beforeShow',
2622
+ 'beforeStartRowEdit',
2623
+ 'beforeStateApply',
2624
+ 'beforeStateSave',
2625
+ 'beforeToggleGroup',
2626
+ 'beforeToggleNode',
2627
+ 'cancelCellEdit',
2628
+ 'catchAll',
2629
+ 'cellClick',
2630
+ 'cellContextMenu',
2631
+ 'cellDblClick',
2632
+ 'cellMenuBeforeShow',
2633
+ 'cellMenuItem',
2634
+ 'cellMenuShow',
2635
+ 'cellMenuToggleItem',
2636
+ 'cellMouseEnter',
2637
+ 'cellMouseLeave',
2638
+ 'cellMouseOut',
2639
+ 'cellMouseOver',
2640
+ 'collapse',
2641
+ 'collapseNode',
2642
+ 'columnDrag',
2643
+ 'columnDragStart',
2644
+ 'columnDrop',
2645
+ 'columnResize',
2646
+ 'columnResizeStart',
2647
+ 'contextMenuItem',
2648
+ 'contextMenuToggleItem',
2649
+ 'copy',
2650
+ 'dataChange',
2651
+ 'destroy',
2652
+ 'dirtyStateChange',
2653
+ 'dragSelecting',
2654
+ 'elementCreated',
2655
+ 'expand',
2656
+ 'expandNode',
2657
+ 'fileDrop',
2658
+ 'fillHandleBeforeDragFinalize',
2659
+ 'fillHandleDrag',
2660
+ 'fillHandleDragAbort',
2661
+ 'fillHandleDragEnd',
2662
+ 'fillHandleDragStart',
2663
+ 'finishCellEdit',
2664
+ 'finishRowEdit',
2665
+ 'focusIn',
2666
+ 'focusOut',
2667
+ 'gridRowBeforeDragStart',
2668
+ 'gridRowBeforeDropFinalize',
2669
+ 'gridRowDrag',
2670
+ 'gridRowDragAbort',
2671
+ 'gridRowDragStart',
2672
+ 'gridRowDrop',
2673
+ 'headerClick',
2674
+ 'headerMenuBeforeShow',
2675
+ 'headerMenuItem',
2676
+ 'headerMenuShow',
2677
+ 'headerMenuToggleItem',
2678
+ 'hide',
2679
+ 'lockRows',
2680
+ 'mouseOut',
2681
+ 'mouseOver',
2682
+ 'paint',
2683
+ 'paste',
2684
+ 'pdfExport',
2685
+ 'readOnly',
2686
+ 'recompose',
2687
+ 'renderRow',
2688
+ 'renderRows',
2689
+ 'resize',
2690
+ 'responsive',
2691
+ 'rowCollapse',
2692
+ 'rowExpand',
2693
+ 'rowMouseEnter',
2694
+ 'rowMouseLeave',
2695
+ 'scroll',
2696
+ 'selectionChange',
2697
+ 'selectionModeChange',
2698
+ 'show',
2699
+ 'split',
2700
+ 'splitterCollapseClick',
2701
+ 'splitterDragEnd',
2702
+ 'splitterDragStart',
2703
+ 'splitterExpandClick',
2704
+ 'startCellEdit',
2705
+ 'startRowEdit',
2706
+ 'subGridCollapse',
2707
+ 'subGridExpand',
2708
+ 'toggleGroup',
2709
+ 'toggleNode',
2710
+ 'toolClick',
2711
+ 'unlockRows',
2712
+ 'unsplit'
2713
+ ]
2714
+ };
2715
+
2716
+ const instance: {
2717
+ value?: Grid
2718
+ } = {};
2719
+
2720
+ const refElement = ref<HTMLDivElement>()!;
2721
+ // Storage for teleports (in-cell Vue component instances) automatically renderer by template
2722
+ const teleports = ref(new Map());
2723
+
2724
+ // Provide teleports for processCellContent
2725
+ provide('teleports', teleports);
2726
+
2727
+ onMounted(() => {
2728
+
2729
+ const me = getCurrentInstance()!;
2730
+
2731
+ instance.value = WrapperHelper.createWidget<typeof Grid>({
2732
+ me,
2733
+ widgetData,
2734
+ emit,
2735
+ element : refElement.value!,
2736
+ processCellContent : WrapperHelper.processCellContent,
2737
+ processEventContent : WrapperHelper.processEventContent,
2738
+ processWidgetContent : WrapperHelper.processWidgetContent,
2739
+ hasFrameworkRenderer : WrapperHelper.hasFrameworkRenderer,
2740
+ toRaw
2741
+ });
2742
+ WrapperHelper.relayStores(me.data, instance.value);
2743
+
2744
+ const watcher = (prop: string, callback: any) => watch(() => me.props[prop], callback);
2745
+ WrapperHelper.watchProps(instance.value, widgetData, watcher);
2746
+ });
2747
+
2748
+ onBeforeUnmount(() => {
2749
+ // @ts-ignore
2750
+ instance.value?.destroy?.();
2751
+ });
2752
+
2753
+ defineExpose({
2754
+ instance,
2755
+ refElement,
2756
+ teleports
2757
+ });
2758
+
2759
+ </script>