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