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