@bryntum/gantt-react 7.1.1

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