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