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