@bryntum/schedulerpro-vue-3-thin 7.2.4 → 7.3.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 (138) hide show
  1. package/README.md +9 -9
  2. package/lib/chunks/{BhUeT19h.js → 7vz3cAx6.js} +9 -7
  3. package/lib/chunks/7vz3cAx6.js.map +1 -0
  4. package/lib/chunks/{9jfNe_y3.js → B1SaPsRu.js} +16 -8
  5. package/lib/chunks/B1SaPsRu.js.map +1 -0
  6. package/lib/chunks/{D4JDuI0s.js → B4dVznPx.js} +1 -8
  7. package/lib/chunks/B4dVznPx.js.map +1 -0
  8. package/lib/chunks/{DwzPrR90.js → B8GKehTJ.js} +10 -8
  9. package/lib/chunks/B8GKehTJ.js.map +1 -0
  10. package/lib/chunks/{C41opZKx.js → BhXv58eE.js} +23 -14
  11. package/lib/chunks/BhXv58eE.js.map +1 -0
  12. package/lib/chunks/{Dz-up1_i.js → BhfdqXGU.js} +10 -8
  13. package/lib/chunks/BhfdqXGU.js.map +1 -0
  14. package/lib/chunks/{CJFZbm_i.js → Bk2bIVfG.js} +25 -13
  15. package/lib/chunks/Bk2bIVfG.js.map +1 -0
  16. package/lib/chunks/{DlNFp5e-.js → C1vi1h_N.js} +13 -11
  17. package/lib/chunks/C1vi1h_N.js.map +1 -0
  18. package/lib/chunks/{DYBe70El.js → CEQZr1q6.js} +20 -11
  19. package/lib/chunks/CEQZr1q6.js.map +1 -0
  20. package/lib/chunks/{BTT_cGQU.js → CPjow0gO.js} +8 -9
  21. package/lib/chunks/CPjow0gO.js.map +1 -0
  22. package/lib/chunks/{BRGc8bUJ.js → Cb_akueu.js} +16 -13
  23. package/lib/chunks/Cb_akueu.js.map +1 -0
  24. package/lib/chunks/{BJPdcix1.js → Cc_DPp3S.js} +8 -6
  25. package/lib/chunks/Cc_DPp3S.js.map +1 -0
  26. package/lib/chunks/{BjTPjWi9.js → Cr5VTUbs.js} +10 -8
  27. package/lib/chunks/Cr5VTUbs.js.map +1 -0
  28. package/lib/chunks/{j8JzZ-07.js → D-hmgVVF.js} +13 -11
  29. package/lib/chunks/D-hmgVVF.js.map +1 -0
  30. package/lib/chunks/{BpAvqwr_.js → D-v-Wqj4.js} +25 -13
  31. package/lib/chunks/D-v-Wqj4.js.map +1 -0
  32. package/lib/chunks/{BbI7XKMd.js → D0hJ3P6L.js} +5 -3
  33. package/lib/chunks/D0hJ3P6L.js.map +1 -0
  34. package/lib/chunks/{CGbW6pgm.js → DPA-xEW5.js} +8 -9
  35. package/lib/chunks/DPA-xEW5.js.map +1 -0
  36. package/lib/chunks/{CuODT2-U.js → XQWZfDOm.js} +7 -5
  37. package/lib/chunks/XQWZfDOm.js.map +1 -0
  38. package/lib/chunks/{MOjUZ-Rj.js → eKXSEOkn.js} +7 -5
  39. package/lib/chunks/eKXSEOkn.js.map +1 -0
  40. package/lib/chunks/{DGV7a5Xo.js → edcDjaO2.js} +7 -5
  41. package/lib/chunks/edcDjaO2.js.map +1 -0
  42. package/lib/chunks/{BO8FwQoh.js → n2IZFQjR.js} +10 -8
  43. package/lib/chunks/n2IZFQjR.js.map +1 -0
  44. package/lib/chunks/{M0cBUV91.js → zY4Qxi9x.js} +8 -6
  45. package/lib/chunks/zY4Qxi9x.js.map +1 -0
  46. package/lib/components/BryntumCalendarEditor.js +1 -1
  47. package/lib/components/BryntumCalendarField.js +1 -1
  48. package/lib/components/BryntumConstraintTypePicker.js +1 -1
  49. package/lib/components/BryntumCostAccrualField.js +1 -1
  50. package/lib/components/BryntumDependencyTypePicker.js +1 -1
  51. package/lib/components/BryntumEffortField.js +1 -1
  52. package/lib/components/BryntumEndDateField.js +1 -1
  53. package/lib/components/BryntumModelCombo.js +1 -1
  54. package/lib/components/BryntumRateTableField.js +1 -1
  55. package/lib/components/BryntumResourceEditor.js +1 -1
  56. package/lib/components/BryntumResourceGrid.js +1 -1
  57. package/lib/components/BryntumResourceHistogram.js +1 -1
  58. package/lib/components/BryntumResourceTypeField.js +1 -1
  59. package/lib/components/BryntumResourceUtilization.js +1 -1
  60. package/lib/components/BryntumSchedulerPro.js +1 -1
  61. package/lib/components/BryntumSchedulerProBase.js +1 -1
  62. package/lib/components/BryntumSchedulerProProjectModel.js +1 -1
  63. package/lib/components/BryntumSchedulingDirectionPicker.js +1 -1
  64. package/lib/components/BryntumSchedulingModePicker.js +1 -1
  65. package/lib/components/BryntumStartDateField.js +1 -1
  66. package/lib/components/BryntumThemeCombo.js +57 -0
  67. package/lib/components/BryntumThemeCombo.js.map +1 -0
  68. package/lib/components/BryntumTimeline.js +1 -1
  69. package/lib/components/BryntumVersionGrid.js +1 -1
  70. package/lib/index.js +22 -22
  71. package/package.json +1 -1
  72. package/src/components/BryntumCalendarEditor.vue +191 -292
  73. package/src/components/BryntumCalendarEditorProps.ts +123 -177
  74. package/src/components/BryntumCalendarField.vue +172 -260
  75. package/src/components/BryntumCalendarFieldProps.ts +96 -143
  76. package/src/components/BryntumConstraintTypePicker.vue +172 -260
  77. package/src/components/BryntumConstraintTypePickerProps.ts +96 -143
  78. package/src/components/BryntumCostAccrualField.vue +172 -260
  79. package/src/components/BryntumCostAccrualFieldProps.ts +96 -143
  80. package/src/components/BryntumDependencyTypePicker.vue +172 -260
  81. package/src/components/BryntumDependencyTypePickerProps.ts +96 -143
  82. package/src/components/BryntumEffortField.vue +153 -224
  83. package/src/components/BryntumEffortFieldProps.ts +82 -114
  84. package/src/components/BryntumEndDateField.vue +159 -228
  85. package/src/components/BryntumEndDateFieldProps.ts +84 -114
  86. package/src/components/BryntumModelCombo.vue +172 -260
  87. package/src/components/BryntumModelComboProps.ts +96 -143
  88. package/src/components/BryntumRateTableField.vue +172 -260
  89. package/src/components/BryntumRateTableFieldProps.ts +96 -143
  90. package/src/components/BryntumResourceEditor.vue +190 -290
  91. package/src/components/BryntumResourceEditorProps.ts +122 -175
  92. package/src/components/BryntumResourceGrid.vue +730 -1045
  93. package/src/components/BryntumResourceGridProps.ts +192 -263
  94. package/src/components/BryntumResourceHistogram.vue +1098 -1539
  95. package/src/components/BryntumResourceHistogramProps.ts +292 -402
  96. package/src/components/BryntumResourceTypeField.vue +172 -260
  97. package/src/components/BryntumResourceTypeFieldProps.ts +96 -143
  98. package/src/components/BryntumResourceUtilization.vue +1114 -1561
  99. package/src/components/BryntumResourceUtilizationProps.ts +293 -404
  100. package/src/components/BryntumSchedulerPro.vue +2099 -2820
  101. package/src/components/BryntumSchedulerProBase.vue +2099 -2820
  102. package/src/components/BryntumSchedulerProBaseProps.ts +413 -556
  103. package/src/components/BryntumSchedulerProProjectModel.vue +192 -289
  104. package/src/components/BryntumSchedulerProProjectModelProps.ts +59 -88
  105. package/src/components/BryntumSchedulerProProps.ts +413 -556
  106. package/src/components/BryntumSchedulingDirectionPicker.vue +172 -260
  107. package/src/components/BryntumSchedulingDirectionPickerProps.ts +96 -143
  108. package/src/components/BryntumSchedulingModePicker.vue +173 -262
  109. package/src/components/BryntumSchedulingModePickerProps.ts +97 -145
  110. package/src/components/BryntumStartDateField.vue +161 -232
  111. package/src/components/BryntumStartDateFieldProps.ts +86 -118
  112. package/src/components/BryntumThemeCombo.vue +60 -0
  113. package/src/components/BryntumTimeline.vue +1846 -2517
  114. package/src/components/BryntumTimelineProps.ts +371 -519
  115. package/src/components/BryntumVersionGrid.vue +727 -1050
  116. package/src/components/BryntumVersionGridProps.ts +186 -261
  117. package/lib/chunks/9jfNe_y3.js.map +0 -1
  118. package/lib/chunks/BJPdcix1.js.map +0 -1
  119. package/lib/chunks/BO8FwQoh.js.map +0 -1
  120. package/lib/chunks/BRGc8bUJ.js.map +0 -1
  121. package/lib/chunks/BTT_cGQU.js.map +0 -1
  122. package/lib/chunks/BbI7XKMd.js.map +0 -1
  123. package/lib/chunks/BhUeT19h.js.map +0 -1
  124. package/lib/chunks/BjTPjWi9.js.map +0 -1
  125. package/lib/chunks/BpAvqwr_.js.map +0 -1
  126. package/lib/chunks/C41opZKx.js.map +0 -1
  127. package/lib/chunks/CGbW6pgm.js.map +0 -1
  128. package/lib/chunks/CJFZbm_i.js.map +0 -1
  129. package/lib/chunks/CuODT2-U.js.map +0 -1
  130. package/lib/chunks/D4JDuI0s.js.map +0 -1
  131. package/lib/chunks/DGV7a5Xo.js.map +0 -1
  132. package/lib/chunks/DYBe70El.js.map +0 -1
  133. package/lib/chunks/DlNFp5e-.js.map +0 -1
  134. package/lib/chunks/DwzPrR90.js.map +0 -1
  135. package/lib/chunks/Dz-up1_i.js.map +0 -1
  136. package/lib/chunks/M0cBUV91.js.map +0 -1
  137. package/lib/chunks/MOjUZ-Rj.js.map +0 -1
  138. package/lib/chunks/j8JzZ-07.js.map +0 -1
@@ -10,7 +10,7 @@
10
10
 
11
11
  import { getCurrentInstance, onBeforeUnmount, onMounted, provide, ref, watch, toRaw } from 'vue';
12
12
 
13
- import type { Base, Color, 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';
13
+ import type { Base, Color, Container, DomConfig, FormulaProviderConfig, InstancePlugin, 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
14
  import type { AI as GridAI, AIConfig as GridAIConfig, 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
15
  import type { PdfExportConfig } from '@bryntum/scheduler-thin';
16
16
  import type { SchedulerProContainerItemConfig, SchedulerProColumnConfig, ProjectModel, VersionGridListeners, VersionModel } from '@bryntum/schedulerpro-thin';
@@ -23,8 +23,7 @@ defineProps<{
23
23
  /**
24
24
  * Element (or element id) to adopt as this Widget's encapsulating element. The widget's
25
25
  * content will be placed inside this element.
26
- * ...
27
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-adopt)
26
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-adopt)
28
27
  */
29
28
  adopt ? : HTMLElement|string
30
29
  /**
@@ -59,15 +58,13 @@ defineProps<{
59
58
  /**
60
59
  * A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject
61
60
  * into an element which will be linked using the `aria-describedby` attribute.
62
- * ...
63
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-ariaDescription)
61
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-ariaDescription)
64
62
  */
65
63
  ariaDescription ? : string
66
64
  /**
67
65
  * A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject as
68
66
  * the `aria-label` attribute.
69
- * ...
70
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-ariaLabel)
67
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-ariaLabel)
71
68
  */
72
69
  ariaLabel ? : string
73
70
  /**
@@ -79,14 +76,12 @@ defineProps<{
79
76
  /**
80
77
  * A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Toolbar),
81
78
  * 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).
82
- * ...
83
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-bbar)
79
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-bbar)
84
80
  */
85
81
  bbar ? : (SchedulerProContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
86
82
  /**
87
83
  * Custom CSS classes to add to the panel's body element.
88
- * ...
89
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-bodyCls)
84
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-bodyCls)
90
85
  */
91
86
  bodyCls ? : string|object
92
87
  /**
@@ -96,21 +91,18 @@ defineProps<{
96
91
  /**
97
92
  * An object where property names with a truthy value indicate which events should bubble up the ownership
98
93
  * hierarchy when triggered.
99
- * ...
100
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-bubbleEvents)
94
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-bubbleEvents)
101
95
  */
102
96
  bubbleEvents ? : object
103
97
  /**
104
98
  * Set to `false` to not call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
105
- * ...
106
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-callOnFunctions)
99
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-callOnFunctions)
107
100
  */
108
101
  callOnFunctions ? : Boolean
109
102
  /**
110
103
  * By default, if an event handler throws an exception, the error propagates up the stack and the
111
104
  * application state is undefined. Code which follows the event handler will *not* be executed.
112
- * ...
113
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-catchEventHandlerExceptions)
105
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-catchEventHandlerExceptions)
114
106
  */
115
107
  catchEventHandlerExceptions ? : Boolean
116
108
  /**
@@ -123,8 +115,7 @@ defineProps<{
123
115
  * Custom CSS classes to add to element.
124
116
  * May be specified as a space separated string, or as an object in which property names
125
117
  * with truthy values are used as the class names:
126
- * ...
127
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-cls)
118
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-cls)
128
119
  */
129
120
  cls ? : string|object
130
121
  /**
@@ -134,15 +125,13 @@ defineProps<{
134
125
  collapsed ? : Boolean
135
126
  /**
136
127
  * This config enables collapsibility for the panel. See [collapsed](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Panel#config-collapsed).
137
- * ...
138
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-collapsible)
128
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-collapsible)
139
129
  */
140
130
  collapsible ? : Boolean|PanelCollapserConfig|PanelCollapserOverlayConfig
141
131
  /**
142
132
  * Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
143
133
  * `style` block.
144
- * ...
145
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-color)
134
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-color)
146
135
  */
147
136
  color ? : Color
148
137
  /**
@@ -156,8 +145,7 @@ defineProps<{
156
145
  /**
157
146
  * Accepts column definitions for the grid during initialization. They will be used to create
158
147
  * [Column](https://bryntum.com/products/schedulerpro/docs/api/Grid/column/Column) instances that are added to a [ColumnStore](#Grid/data/ColumnStore).
159
- * ...
160
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-columns)
148
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-columns)
161
149
  */
162
150
  columns ? : ColumnStore|SchedulerProColumnConfig[]|ColumnStoreConfig
163
151
  /**
@@ -169,8 +157,7 @@ defineProps<{
169
157
  * Custom CSS classes to add to the [contentElement](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#property-contentElement).
170
158
  * May be specified as a space separated string, or as an object in which property names
171
159
  * with truthy values are used as the class names:
172
- * ...
173
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-contentElementCls)
160
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-contentElementCls)
174
161
  */
175
162
  contentElementCls ? : string|object
176
163
  /**
@@ -182,8 +169,7 @@ defineProps<{
182
169
  * Convenient shortcut to set data in grids store both during initialization and at runtime. Can also be
183
170
  * used to retrieve data at runtime, although we do recommend interacting with Grids store instead using
184
171
  * the [store](https://bryntum.com/products/schedulerpro/docs/api/Grid/view/GridBase#property-store) property.
185
- * ...
186
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-data)
172
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-data)
187
173
  */
188
174
  data ? : object[]|Model[]|ModelConfig[]
189
175
  /**
@@ -208,16 +194,15 @@ defineProps<{
208
194
  */
209
195
  destroyStore ? : Boolean
210
196
  /**
211
- * Check for CSS compatibility issues when upgrading to v7. Performs the following checks:
212
- * ...
213
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-detectCSSCompatibilityIssues)
197
+ * Check for CSS compatibility and inclusion related issues and try to auto fix them. Performs the following
198
+ * checks:
199
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-detectCSSCompatibilityIssues)
214
200
  */
215
201
  detectCSSCompatibilityIssues ? : Boolean
216
202
  /**
217
203
  * 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
218
204
  * cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
219
- * ...
220
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-disabled)
205
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-disabled)
221
206
  */
222
207
  disabled ? : Boolean|'inert'
223
208
  /**
@@ -237,43 +222,39 @@ defineProps<{
237
222
  * [strips collection](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
238
223
  * `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
239
224
  * body. Such widgets are called "edge strips".
240
- * ...
241
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-dock)
225
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-dock)
242
226
  */
243
227
  dock ? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
244
228
  /**
245
229
  * Make this Panel a docked drawer which slides out from one side of the browser viewport by default.
246
- * ...
247
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-drawer)
248
- * @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.
249
- * @param {string,number} size The size of the drawer in its collapsible axis.
250
- * @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.
251
- * @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.
252
- * @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.
253
- * @param {boolean,string} autoClose.focusout If focus moves outside of the drawer, the drawer will automatically be hidden.
254
- * @param {string} autoClose.mouseout Hides the drawer when the mouse leaves the drawer after the `autoCloseDelay` period.
255
- * @param {number} autoCloseDelay When using `mouseout`, this is the delay in milliseconds
256
- */
257
- 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}
230
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-drawer)
231
+ * @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.
232
+ * @param {string,number} [size] The size of the drawer in its collapsible axis.
233
+ * @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.
234
+ * @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.
235
+ * @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.
236
+ * @param {boolean,string} [autoClose.focusout] If focus moves outside of the drawer, the drawer will automatically be hidden.
237
+ * @param {string} [autoClose.mouseout] Hides the drawer when the mouse leaves the drawer after the `autoCloseDelay` period.
238
+ * @param {number} [autoCloseDelay] When using `mouseout`, this is the delay in milliseconds
239
+ */
240
+ drawer ? : Boolean|{ side?: 'start'|'left'|'end'|'right'|'top'|'bottom', size?: string|number, inline?: Boolean, autoClose?: Boolean|{ mousedown?: Boolean|string, focusout?: Boolean|string, mouseout?: string }, autoCloseDelay?: number }
258
241
  /**
259
242
  * An object specifying attributes to assign to the root element of this widget.
260
243
  * Set `null` value to attribute to remove it.
261
- * ...
262
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-elementAttributes)
244
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-elementAttributes)
263
245
  */
264
246
  elementAttributes ? : Record<string, string|null>
265
247
  /**
266
248
  * 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.
267
249
  * When using multiple Grid regions, provide the `region` property to decide where the text is shown.
268
250
  * By default, it is shown in the first region.
269
- * ...
270
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-emptyText)
251
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-emptyText)
271
252
  */
272
253
  emptyText ? : string|EmptyTextDomConfig
273
254
  /**
274
- * Configure this as `true` to allow elements within cells to be styled as `position: sticky`.
275
- * ...
276
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-enableSticky)
255
+ * Set to `true` to enable the [StickyCells](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/StickyCells) feature, which pins cell
256
+ * content to the top of the grid while rows scroll off the top but remain visible.
257
+ * @deprecated 7.3.0 Use `features : { stickyCells : true }` instead
277
258
  */
278
259
  enableSticky ? : Boolean
279
260
  /**
@@ -297,8 +278,7 @@ defineProps<{
297
278
  * Use fixed row height. Setting this to `true` will configure the underlying RowManager to use fixed row
298
279
  * height, which sacrifices the ability to use rows with variable height to gain a fraction better
299
280
  * performance.
300
- * ...
301
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-fixedRowHeight)
281
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-fixedRowHeight)
302
282
  */
303
283
  fixedRowHeight ? : Boolean
304
284
  /**
@@ -312,41 +292,35 @@ defineProps<{
312
292
  /**
313
293
  * Config object of a footer. May contain a `dock`, `html` and a `cls` property. A footer is not a widget,
314
294
  * 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).
315
- * ...
316
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-footer)
295
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-footer)
296
+ * @property {'top','right','bottom','left','start','end'} dock Where to dock
297
+ * @property {string} html Html to populate the footer with
298
+ * @property {string} cls CSS class to add to the footer
317
299
  */
318
- footer ? : {
319
- dock?: 'top'|'right'|'bottom'|'left'|'start'|'end'
320
- html?: string
321
- cls?: string
322
- }|string
300
+ footer ? : object|string
323
301
  /**
324
302
  * An object which names formula prefixes which will be applied to all columns configured with
325
303
  * `formula : true`.
326
- * ...
327
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-formulaProviders)
304
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-formulaProviders)
328
305
  */
329
306
  formulaProviders ? : Record<string, FormulaProviderConfig>
330
307
  /**
331
308
  * Refresh entire row when a record changes (`true`) or, if possible, only the cells affected (`false`).
332
- * ...
333
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-fullRowRefresh)
309
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-fullRowRefresh)
334
310
  */
335
311
  fullRowRefresh ? : Boolean
336
312
  /**
337
313
  * 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
338
314
  * expected to return the desired height of that records row. If the function returns a falsy value, Grids
339
315
  * configured [rowHeight](https://bryntum.com/products/schedulerpro/docs/api/Grid/view/GridBase#config-rowHeight) is used.
340
- * ...
341
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-getRowHeight)
316
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-getRowHeight)
342
317
  * @param {Core.data.Model} getRowHeight.record Record to determine row height for
343
318
  * @returns {number} Desired row height
344
319
  */
345
- getRowHeight ? : (getRowHeight: { record: Model }) => number
320
+ getRowHeight ? : () => number
346
321
  /**
347
322
  * 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`.
348
- * ...
349
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-header)
323
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-header)
350
324
  */
351
325
  header ? : string|Boolean|PanelHeader
352
326
  /**
@@ -386,16 +360,14 @@ defineProps<{
386
360
  id ? : string
387
361
  /**
388
362
  * Determines if the widgets read-only state should be controlled by its parent.
389
- * ...
390
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-ignoreParentReadOnly)
363
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-ignoreParentReadOnly)
391
364
  */
392
365
  ignoreParentReadOnly ? : Boolean
393
366
  /**
394
367
  * Convenience setting to align input fields of child widgets. By default, the Field input element is
395
368
  * placed immediately following the `label`. If you prefer to have all input fields aligned to the
396
369
  * right, set this config to `'end'`.
397
- * ...
398
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-inputFieldAlign)
370
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-inputFieldAlign)
399
371
  */
400
372
  inputFieldAlign ? : 'start'|'end'
401
373
  /**
@@ -412,14 +384,17 @@ defineProps<{
412
384
  keyMap ? : Record<string, KeyMapConfig>
413
385
  /**
414
386
  * Convenience setting to use same label placement on all child widgets.
415
- * ...
416
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-labelPosition)
387
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-labelPosition)
417
388
  */
418
389
  labelPosition ? : 'before'|'above'|'align-before'|'auto'|null
390
+ /**
391
+ * Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
392
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-labelWidth)
393
+ */
394
+ labelWidth ? : number|null
419
395
  /**
420
396
  * The listener set for this object.
421
- * ...
422
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-listeners)
397
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-listeners)
423
398
  */
424
399
  listeners ? : VersionGridListeners
425
400
  /**
@@ -432,15 +407,13 @@ defineProps<{
432
407
  * when data is loading. The message and optional configuration from the
433
408
  * [loadMask](https://bryntum.com/products/schedulerpro/docs/api/Core/mixin/LoadMaskable#config-loadMask) config take priority over these options, just as they do
434
409
  * for `maskDefaults`, respectively.
435
- * ...
436
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-loadMaskDefaults)
410
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-loadMaskDefaults)
437
411
  */
438
412
  loadMaskDefaults ? : MaskConfig
439
413
  /**
440
414
  * A [Mask](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Mask) config object to adjust the [maskDefaults](#Core/widget/Widget#config-maskDefaults)
441
415
  * when an error occurs loading data.
442
- * ...
443
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-loadMaskError)
416
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-loadMaskError)
444
417
  */
445
418
  loadMaskError ? : MaskConfig|Mask|Boolean
446
419
  /**
@@ -478,8 +451,7 @@ defineProps<{
478
451
  /**
479
452
  * Grid's `min-height`. Defaults to `10em` to be sure that the Grid always has a height wherever it is
480
453
  * inserted.
481
- * ...
482
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-minHeight)
454
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-minHeight)
483
455
  */
484
456
  minHeight ? : string|number
485
457
  /**
@@ -494,7 +466,7 @@ defineProps<{
494
466
  /**
495
467
  * Specify plugins (an array of classes) in config
496
468
  */
497
- plugins ? : Function[]
469
+ plugins ? : InstancePlugin[]|InstancePlugin
498
470
  /**
499
471
  * True to preserve focused cell after loading new data
500
472
  */
@@ -520,54 +492,61 @@ defineProps<{
520
492
  project ? : ProjectModel|object
521
493
  /**
522
494
  * Set to `true` to make the grid read-only, by disabling any UIs for modifying data.
523
- * ...
524
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-readOnly)
495
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-readOnly)
525
496
  */
526
497
  readOnly ? : Boolean
527
498
  relayStoreEvents ? : Boolean
528
499
  /**
529
500
  * Either a default `rendition` to apply to all child widgets, or a map of renditions keyed by child widget
530
501
  * `type`.
531
- * ...
532
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-rendition)
502
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-rendition)
533
503
  */
534
504
  rendition ? : string|Record<string, string>|null
535
505
  /**
536
506
  * Configure this property to allow the widget/component to be resized. Pressing <kbd>Shift</kbd> while resizing will
537
507
  * constrain the aspect ratio.
538
- * ...
539
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-resizable)
540
- */
541
- resizable ? : Boolean|{
542
- minWidth?: number
543
- maxWidth?: number
544
- minHeight?: number
545
- maxHeight?: number
546
- handles?: object
547
- }
508
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-resizable)
509
+ * @property {number} [resizable.minWidth] The minimum width of the element.
510
+ * @property {number} [resizable.maxWidth] The maximum width of the element.
511
+ * @property {number} [resizable.minHeight] The minimum height of the element.
512
+ * @property {number} [resizable.maxHeight] The maximum height of the element
513
+ * @property {object} [resizable.handles] An object controlling which edges/corners are resizable.
514
+ * @property {boolean} [resizable.handles.topStart] Resizable from top-start corner
515
+ * @property {boolean} [resizable.handles.top] Resizable from top edge
516
+ * @property {boolean} [resizable.handles.topEnd] Resizable from top-end corner
517
+ * @property {boolean} [resizable.handles.end] Resizable from end edge
518
+ * @property {boolean} [resizable.handles.bottomEnd] Resizable from bottom-end corner
519
+ * @property {boolean} [resizable.handles.bottom] Resizable from bottom edge
520
+ * @property {boolean} [resizable.handles.bottomStart] Resizable from bottom-start corner
521
+ * @property {boolean} [resizable.handles.start] Resizable from start edge
522
+ */
523
+ resizable ? : Boolean|{ minWidth?: number, maxWidth?: number, minHeight?: number, maxHeight?: number, handles?: { topStart?: Boolean, top?: Boolean, topEnd?: Boolean, end?: Boolean, bottomEnd?: Boolean, bottom?: Boolean, bottomStart?: Boolean, start?: Boolean } }
548
524
  /**
549
525
  * Set to `false` to only measure cell contents when double-clicking the edge between column headers.
550
526
  */
551
527
  resizeToFitIncludesHeader ? : Boolean
552
528
  /**
553
529
  * "Break points" for which responsive config to use for columns and css.
554
- * ...
555
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-responsiveLevels)
530
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-responsiveLevels)
556
531
  */
557
532
  responsiveLevels ? : Record<string, number|string|ResponsiveLevelConfig>
558
533
  /**
559
534
  * Configure as `true` to have the component display a translucent ripple when its
560
535
  * [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
561
536
  * current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
562
- * ...
563
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-ripple)
537
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-ripple)
538
+ * @property {string} [delegate] A CSS selector to filter which child elements trigger ripples. By default, the ripple is clipped to the triggering element.
539
+ * @property {string} [color] A CSS color name or specification.
540
+ * @property {number} [radius] The ending radius of the ripple. Note that it will be clipped by the target element by default.
541
+ * @property {string} [clip] A string which describes how to clip the ripple if it is not to be clipped to the default element. Either the property of the widget to use as the clipping element, or a selector to allow clipping to the closest matching ancestor to the target element.
542
+ */
543
+ ripple ? : Boolean|object
544
+ /**
545
+ * The ARIA role to apply to this widget's element. By default, this is set to `'presentation'` to avoid
546
+ * accidentally applying a role which may interfere with screen readers.
547
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-role)
564
548
  */
565
- ripple ? : Boolean|{
566
- delegate?: string
567
- color?: string
568
- radius?: number
569
- clip?: string
570
- }
549
+ role ? : string
571
550
  /**
572
551
  * 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`
573
552
  */
@@ -576,8 +555,7 @@ defineProps<{
576
555
  * Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
577
556
  * overridden by specifying a [rowHeight](https://bryntum.com/products/schedulerpro/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
578
557
  * a column [renderer](https://bryntum.com/products/schedulerpro/docs/api/Grid/column/Column#config-renderer).
579
- * ...
580
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-rowHeight)
558
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-rowHeight)
581
559
  */
582
560
  rowHeight ? : number
583
561
  /**
@@ -586,15 +564,13 @@ defineProps<{
586
564
  rowLines ? : Boolean
587
565
  /**
588
566
  * This may be configured as `true` to make the widget's element use the `direction:rtl` style.
589
- * ...
590
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-rtl)
567
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-rtl)
591
568
  */
592
569
  rtl ? : Boolean
593
570
  /**
594
571
  * 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).
595
572
  * See the [scrollerClass](https://bryntum.com/products/schedulerpro/docs/api/Grid/view/GridBase#config-scrollerClass) config option.
596
- * ...
597
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-scrollable)
573
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-scrollable)
598
574
  */
599
575
  scrollable ? : Boolean|ScrollerConfig|Scroller
600
576
  /**
@@ -609,20 +585,17 @@ defineProps<{
609
585
  /**
610
586
  * Selection configuration settings, change these properties to control how selection works and what can be
611
587
  * selected.
612
- * ...
613
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-selectionMode)
588
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-selectionMode)
614
589
  */
615
590
  selectionMode ? : GridSelectionMode
616
591
  /**
617
592
  * Configure as `true` to have the grid show a red "changed" tag in cells whose
618
593
  * field value has changed and not yet been committed.
619
- * ...
620
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-showDirty)
594
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-showDirty)
595
+ * @property {boolean} showDirty.duringEdit Set to `true` to show the red tag while editing a cell
596
+ * @property {boolean} showDirty.newRecord Set to `true` to show the red tag for all the cells of the new record
621
597
  */
622
- showDirty ? : Boolean|{
623
- duringEdit?: Boolean
624
- newRecord?: Boolean
625
- }
598
+ showDirty ? : Boolean|{ duringEdit: Boolean, newRecord: Boolean }
626
599
  /**
627
600
  * Whether to show only versions that have been assigned a specific name.
628
601
  */
@@ -641,121 +614,105 @@ defineProps<{
641
614
  span ? : number
642
615
  /**
643
616
  * This value can be one of the following:
644
- * ...
645
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-stateful)
617
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-stateful)
646
618
  */
647
619
  stateful ? : Boolean|object|string[]
648
620
  /**
649
621
  * The events that, when fired by this component, should trigger it to save its state by calling
650
622
  * [saveState](https://bryntum.com/products/schedulerpro/docs/api/Core/mixin/State#function-saveState).
651
- * ...
652
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-statefulEvents)
623
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-statefulEvents)
653
624
  */
654
625
  statefulEvents ? : object|string[]
655
626
  /**
656
627
  * 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
657
628
  * 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)
658
629
  * (if explicitly specified) will be used as the `stateId`.
659
- * ...
660
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-stateId)
630
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-stateId)
661
631
  */
662
632
  stateId ? : string
663
633
  /**
664
634
  * 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`
665
635
  * will be saved using the [default state provider](https://bryntum.com/products/schedulerpro/docs/api/Core/state/StateProvider#property-instance-static).
666
- * ...
667
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-stateProvider)
636
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-stateProvider)
668
637
  */
669
638
  stateProvider ? : StateProvider
670
639
  /**
671
640
  * The properties of this settings object controls how grid is restored from state data.
672
- * ...
673
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-stateSettings)
641
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-stateSettings)
642
+ * @property {boolean} [restoreUnconfiguredColumns] Determines whether to restore columns from the state that are not explicitly defined in the grid configuration.
674
643
  */
675
- stateSettings ? : {
676
- restoreUnconfiguredColumns?: Boolean
677
- }
644
+ stateSettings ? : object
678
645
  /**
679
646
  * The store instance or config object that holds the records to be displayed by this TreeGrid. If assigning
680
647
  * a store instance, it must be configured with `tree: true`.
681
- * ...
682
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-store)
648
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-store)
683
649
  */
684
650
  store ? : Store|StoreConfig
685
651
  /**
686
652
  * An object containing widgets keyed by name. By default (when no `type` is given), strips are
687
653
  * [toolbars](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Toolbar). If you want to pass an array, you can use
688
654
  * the toolbar's [items](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Container#config-items).
689
- * ...
690
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-strips)
655
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-strips)
691
656
  */
692
657
  strips ? : Record<string, SchedulerProContainerItemConfig>
693
658
  /**
694
659
  * An object containing sub grid configuration objects keyed by a `region` property.
695
660
  * By default, grid has a 'locked' region (if configured with locked columns) and a 'normal' region.
696
661
  * The 'normal' region defaults to use `flex: 1`.
697
- * ...
698
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-subGridConfigs)
662
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-subGridConfigs)
699
663
  */
700
664
  subGridConfigs ? : Record<string, SubGridConfig>
701
665
  /**
702
666
  * A [Mask](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Mask) config object, or a message to be shown when Crud Manager
703
667
  * is persisting changes on the server. Set to `null` to disable default sync mask.
704
- * ...
705
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-syncMask)
668
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-syncMask)
706
669
  */
707
670
  syncMask ? : string|MaskConfig|null
708
671
  /**
709
672
  * 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
710
673
  * [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
711
674
  * this widget:
712
- * ...
713
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-tab)
675
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-tab)
714
676
  */
715
677
  tab ? : Boolean|TabConfig
716
678
  /**
717
679
  * When this container is used as a tab in a TabPanel, these items are added to the
718
680
  * [TabBar](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/TabBar) when this container is the active tab.
719
- * ...
720
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-tabBarItems)
681
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-tabBarItems)
721
682
  */
722
683
  tabBarItems ? : ToolbarItems[]|Widget[]
723
684
  /**
724
685
  * A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Toolbar),
725
686
  * or array of config objects representing the child items of a Toolbar.
726
687
  * This creates a toolbar docked to the top of the panel immediately below the header.
727
- * ...
728
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-tbar)
688
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-tbar)
729
689
  */
730
690
  tbar ? : (SchedulerProContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
731
691
  /**
732
692
  * A title to display in the header or owning TabPanel. Causes creation and docking of a header
733
693
  * to the top if no header is configured.
734
- * ...
735
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-title)
694
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-title)
736
695
  */
737
696
  title ? : string
738
697
  /**
739
698
  * 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
740
699
  * property name is the reference by which an instantiated tool may be retrieved from the live
741
700
  * `[tools](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/mixin/Toolable#property-tools)` property.
742
- * ...
743
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-tools)
701
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-tools)
744
702
  */
745
703
  tools ? : Record<string, ToolConfig>|null
746
704
  /**
747
705
  * Configure UI transitions for various actions in the grid.
706
+ * @property {boolean} insertRecord Transition record insertions
707
+ * @property {boolean} removeRecord Transition record removals
708
+ * @property {boolean} toggleColumn Transition column visibility changes
709
+ * @property {boolean} expandCollapseColumn Transition parent/group column expand/collapse
710
+ * @property {boolean} toggleRegion Transition region expand/collapse
711
+ * @property {boolean} toggleTreeNode Transition tree node expand/collapse
712
+ * @property {boolean} toggleGroup Transition group expand/collapse
713
+ * @property {boolean} filterRemoval Transition row removals caused by filtering (under specific conditions)
748
714
  */
749
- transition ? : {
750
- insertRecord?: Boolean
751
- removeRecord?: Boolean
752
- toggleColumn?: Boolean
753
- expandCollapseColumn?: Boolean
754
- toggleRegion?: Boolean
755
- toggleTreeNode?: Boolean
756
- toggleGroup?: Boolean
757
- filterRemoval?: Boolean
758
- }
715
+ transition ? : object
759
716
  /**
760
717
  * Animation transition duration in milliseconds.
761
718
  */
@@ -765,8 +722,7 @@ defineProps<{
765
722
  * Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
766
723
  * as a space separated string, an array of strings, or as an object in which property names with truthy
767
724
  * values are used as the class names.
768
- * ...
769
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-ui)
725
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-ui)
770
726
  */
771
727
  ui ? : 'plain'|'toolbar'|string|object
772
728
  /**
@@ -787,129 +743,117 @@ defineProps<{
787
743
  * agent and see the responses. Which allows the user to use natural language to interact with the Grid in different
788
744
  * ways. For example, the user can ask the agent to filter the data, sort it, or select specific records. The agent can
789
745
  * also perform data manipulation operations such as adding, updating, deleting records.
790
- * ...
791
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/AI)
746
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/AI)
792
747
  */
793
748
  aiFeature ? : object|Boolean|string|GridAI|GridAIConfig
794
749
  /**
795
750
  * AI-powered filter feature for Grid. Allows users to type natural language queries to filter grid data.
796
- * ...
797
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ai/AIFilter)
751
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ai/AIFilter)
798
752
  */
799
753
  aiFilterFeature ? : object|Boolean|string|AIFilter|AIFilterConfig
800
754
  /**
801
755
  * Allows using `[Ctrl/CMD + C]`, `[Ctrl/CMD + X]` and `[Ctrl/CMD + V]` to cut, copy and paste cell or cell ranges. Also
802
756
  * makes cut, copy and paste actions available via the cell context menu.
803
- * ...
804
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellCopyPaste)
757
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellCopyPaste)
805
758
  */
806
759
  cellCopyPasteFeature ? : object|Boolean|string|CellCopyPaste|CellCopyPasteConfig
807
760
  /**
808
761
  * Adding this feature to the grid and other Bryntum products which are based on the Grid (i.e. Scheduler, SchedulerPro, and Gantt)
809
762
  * enables cell editing. Any subclass of [Field](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Field) can be used
810
763
  * as editor for the [Column](https://bryntum.com/products/schedulerpro/docs/api/Grid/column/Column). The most popular are:
811
- * ...
812
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellEdit)
764
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellEdit)
813
765
  */
814
766
  cellEditFeature ? : object|Boolean|string|GridCellEdit|GridCellEditConfig
815
767
  /**
816
768
  * Right click to display context menu for cells. To invoke the cell menu in a keyboard-accessible manner, use the
817
769
  * <kbd>Space</kbd> key when the cell is focused.
818
- * ...
819
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellMenu)
770
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellMenu)
820
771
  */
821
772
  cellMenuFeature ? : object|Boolean|string|CellMenu|CellMenuConfig
822
773
  /**
823
774
  * Displays a tooltip when hovering cells.
824
- * ...
825
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellTooltip)
775
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellTooltip)
826
776
  */
827
777
  cellTooltipFeature ? : object|Boolean|string|CellTooltip|CellTooltipConfig
828
778
  /**
829
779
  * 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
830
780
  * and updated in realtime as data changes. Supports many common chart types with extensive styling and customization
831
781
  * options.
832
- * ...
833
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Charts)
782
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Charts)
834
783
  */
835
784
  chartsFeature ? : object|Boolean|string|Charts|ChartsConfig
836
785
  /**
837
- * Enables the [autoWidth](https://bryntum.com/products/schedulerpro/docs/api/Grid/column/Column#config-autoWidth) config for a grid's columns.
838
- * ...
839
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnAutoWidth)
786
+ * Enables the [autoWidth](https://bryntum.com/products/schedulerpro/docs/api/Grid/column/Column#config-autoWidth) config for a grid's columns. When a column
787
+ * has `autoWidth` set, this feature measures the rendered content of all visible cells in that column
788
+ * and adjusts the column width to fit. The measurement is triggered automatically when data changes
789
+ * or rows are rendered.
790
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnAutoWidth)
840
791
  */
841
792
  columnAutoWidthFeature ? : object|Boolean|string|ColumnAutoWidth|ColumnAutoWidthConfig
842
793
  /**
843
794
  * Displays a toolbar while dragging column headers. Drop on a button in the toolbar to activate a certain function,
844
795
  * for example to group by that column. This feature simplifies certain operations on touch devices.
845
- * ...
846
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnDragToolbar)
796
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnDragToolbar)
847
797
  */
848
798
  columnDragToolbarFeature ? : object|Boolean|string|ColumnDragToolbar|ColumnDragToolbarConfig
849
799
  /**
850
800
  * Displays a column picker (to show/hide columns) in the header context menu. Columns can be displayed in sub menus
851
801
  * by region or tag. Grouped headers are displayed as menu hierarchies.
852
- * ...
853
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnPicker)
802
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnPicker)
854
803
  */
855
804
  columnPickerFeature ? : object|Boolean|string|ColumnPicker|ColumnPickerConfig
856
805
  /**
857
806
  * Allows user to rename columns by either right-clicking column header or using keyboard shortcuts when column header
858
807
  * is focused.
859
- * ...
860
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnRename)
808
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnRename)
861
809
  */
862
810
  columnRenameFeature ? : object|Boolean|string|ColumnRename|ColumnRenameConfig
863
811
  /**
864
- * Allows user to reorder columns by dragging headers. To get notified about column reorder listen to `change` event
865
- * on [columns](https://bryntum.com/products/schedulerpro/docs/api/Grid/data/ColumnStore) store.
866
- * ...
867
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnReorder)
812
+ * Allows user to reorder columns by dragging headers. Click and drag a column header to move it to a new position.
813
+ * Visual feedback shows the drop target while dragging. To get notified about column reorder, listen to the
814
+ * `change` event on the [columns](https://bryntum.com/products/schedulerpro/docs/api/Grid/data/ColumnStore) store.
815
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnReorder)
868
816
  */
869
817
  columnReorderFeature ? : object|Boolean|string|ColumnReorder|ColumnReorderConfig
870
818
  /**
871
- * Enables user to resize columns by dragging a handle on the right hand side of the header. To get notified about column
872
- * resize listen to `change` event on [columns](https://bryntum.com/products/schedulerpro/docs/api/Grid/data/ColumnStore) store.
873
- * ...
874
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnResize)
819
+ * Enables user to resize columns by dragging a handle on the right hand side of the header. A drag handle
820
+ * appears when hovering near the right edge of a column header. Dragging it adjusts the column width, respecting
821
+ * any [minWidth](https://bryntum.com/products/schedulerpro/docs/api/Grid/column/Column#config-minWidth) or [maxWidth](#Grid/column/Column#config-maxWidth) constraints.
822
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnResize)
875
823
  */
876
824
  columnResizeFeature ? : object|Boolean|string|ColumnResize|ColumnResizeConfig
877
825
  /**
878
826
  * A feature that allows exporting Grid data to Excel or CSV without involving the server. It uses
879
827
  * [TableExporter](https://bryntum.com/products/schedulerpro/docs/api/Grid/util/TableExporter) class as data provider, 3rd party provider to generate XLS files, and
880
828
  * [Microsoft XML specification](https://msdn.microsoft.com/en-us/library/office/documentformat.openxml.spreadsheet.aspx).
881
- * ...
882
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/experimental/ExcelExporter)
829
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/experimental/ExcelExporter)
883
830
  */
884
831
  excelExporterFeature ? : object|Boolean|string|GridExcelExporter|GridExcelExporterConfig
885
832
  /**
886
- * An experimental feature that lets users drop files on a Widget. The widget fires an event when a file is dropped onto it.
887
- * In the event, you get access to the raw files as strings, that were parsed by calling `readAsBinaryString`.
888
- * ...
889
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/experimental/FileDrop)
833
+ * An experimental feature that lets users drop files on a Widget. The widget fires a
834
+ * [fileDrop](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/experimental/FileDrop#event-fileDrop) event when a file is dropped onto it. In the event, you get access to the raw
835
+ * files as strings, that were parsed by calling `readAsBinaryString`.
836
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/experimental/FileDrop)
890
837
  */
891
838
  fileDropFeature ? : object|Boolean|string|FileDrop|FileDropConfig
892
839
  /**
893
840
  * This feature adds a fill handle to a Grid range selection, which when dragged, fills the cells being dragged over
894
841
  * with values based on the values in the original selected range. This is similar to functionality normally seen in
895
842
  * various spreadsheet applications.
896
- * ...
897
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/FillHandle)
843
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/FillHandle)
898
844
  */
899
845
  fillHandleFeature ? : object|Boolean|string|FillHandle|FillHandleConfig
900
846
  /**
901
847
  * Feature that allows filtering of the grid by settings filters on columns. The actual filtering is done by the store.
902
848
  * For info on programmatically handling filters, see [StoreFilter](https://bryntum.com/products/schedulerpro/docs/api/Core/data/mixin/StoreFilter).
903
- * ...
904
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Filter)
849
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Filter)
905
850
  */
906
851
  filterFeature ? : object|Boolean|string|Filter|FilterConfig
907
852
  /**
908
853
  * Feature that allows filtering of the grid by entering filters on column headers.
909
854
  * The actual filtering is done by the store.
910
855
  * For info on programmatically handling filters, see [StoreFilter](https://bryntum.com/products/schedulerpro/docs/api/Core/data/mixin/StoreFilter).
911
- * ...
912
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/FilterBar)
856
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/FilterBar)
913
857
  */
914
858
  filterBarFeature ? : object|Boolean|string|FilterBar|FilterBarConfig
915
859
  /**
@@ -917,141 +861,124 @@ defineProps<{
917
861
  * <kbd>Shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
918
862
  * one anywhere on grid). Use <kbd>Shift</kbd> + <kbd>Alt</kbd> + click, or the context menu, to remove a column
919
863
  * grouper.
920
- * ...
921
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Group)
864
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Group)
922
865
  */
923
866
  groupFeature ? : object|Boolean|string|Group|GroupConfig
924
867
  /**
925
868
  * Displays a summary row as a group footer in a grouped grid. Uses the same configuration options on columns as
926
869
  * [Summary](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Summary).
927
- * ...
928
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/GroupSummary)
870
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/GroupSummary)
929
871
  */
930
872
  groupSummaryFeature ? : object|Boolean|string|GridGroupSummary|GridGroupSummaryConfig
931
873
  /**
932
874
  * Right click column header or focus it and press SPACE key to show the context menu for headers.
933
- * ...
934
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/HeaderMenu)
875
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/HeaderMenu)
935
876
  */
936
877
  headerMenuFeature ? : object|Boolean|string|HeaderMenu|HeaderMenuConfig
937
878
  /**
938
879
  * This feature allows records which satisfy a certain condition to be locked at the top of the grid.
939
- * ...
940
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/LockRows)
880
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/LockRows)
941
881
  */
942
882
  lockRowsFeature ? : object|Boolean|string|GridLockRows|GridLockRowsConfig
943
883
  /**
944
884
  * 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
945
885
  * configured to [mergeCells](https://bryntum.com/products/schedulerpro/docs/api/Grid/column/Column#config-mergeCells).
946
- * ...
947
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/MergeCells)
886
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/MergeCells)
948
887
  */
949
888
  mergeCellsFeature ? : object|Boolean|string|MergeCells|MergeCellsConfig
950
889
  /**
951
890
  * Generates PDF/PNG files from the Grid component.
952
- * ...
953
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/export/PdfExport)
891
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/export/PdfExport)
954
892
  */
955
893
  pdfExportFeature ? : object|Boolean|string|GridPdfExport|GridPdfExportConfig
956
894
  /**
957
895
  * Allows pinning columns to the start or end region of the grid without any additional subGrid configurations.
958
896
  * When pinning to a region that does not yet exist, the feature creates the required subGrid on the fly.
959
- * ...
960
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/PinColumns)
897
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/PinColumns)
961
898
  */
962
899
  pinColumnsFeature ? : object|Boolean|string|PinColumns|PinColumnsConfig
963
900
  /**
964
901
  * Allows printing Grid contents using browser print dialog.
965
- * ...
966
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/export/Print)
902
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/export/Print)
967
903
  */
968
904
  printFeature ? : object|Boolean|string|GridPrint|GridPrintConfig
969
905
  /**
970
906
  * Feature that allows the user to search in a column by focusing a cell and typing. Navigate between hits using the
971
- * keyboard, [f3] or [ctrl]/[cmd] + [g] moves to next, also pressing [shift] moves to previous.
972
- * ...
973
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/QuickFind)
907
+ * keyboard, <kbd>f3</kbd> or <kbd>ctrl</kbd>/<kbd>cmd</kbd> + <kbd>g</kbd> moves to next, also pressing
908
+ * <kbd>shift</kbd> moves to previous.
909
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/QuickFind)
974
910
  */
975
911
  quickFindFeature ? : object|Boolean|string|QuickFind|QuickFindConfig
976
912
  /**
977
913
  * Makes the splitter between grid [sections](https://bryntum.com/products/schedulerpro/docs/api/Grid/view/SubGrid) draggable, to let users resize, and
978
914
  * collapse/expand the sections.
979
- * ...
980
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RegionResize)
915
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RegionResize)
981
916
  */
982
917
  regionResizeFeature ? : object|Boolean|string|RegionResize|RegionResizeConfig
983
918
  /**
984
919
  * Allow using [Ctrl/CMD + C/X] and [Ctrl/CMD + V] to copy/cut-and-paste rows. Also makes cut, copy and paste actions
985
920
  * available via the cell context menu.
986
- * ...
987
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RowCopyPaste)
921
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RowCopyPaste)
988
922
  */
989
923
  rowCopyPasteFeature ? : object|Boolean|string|RowCopyPaste|RowCopyPasteConfig
990
924
  /**
991
925
  * This feature allows editing of entire rows in a grid in a docked panel which by default slides out from the right.
992
- * ...
993
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RowEdit)
926
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RowEdit)
994
927
  */
995
928
  rowEditFeature ? : object|Boolean|string|RowEdit|RowEditConfig
996
929
  /**
997
930
  * Enables expanding of Grid rows by either row click or double click, or by adding a separate Grid column which renders
998
931
  * a button that expands or collapses the row.
999
- * ...
1000
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RowExpander)
932
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RowExpander)
1001
933
  */
1002
934
  rowExpanderFeature ? : object|Boolean|string|RowExpander|RowExpanderConfig
1003
935
  /**
1004
936
  * Allows user to reorder rows by dragging them. To get notified about row reorder listen to `change` event
1005
937
  * on the grid [store](https://bryntum.com/products/schedulerpro/docs/api/Core/data/Store).
1006
- * ...
1007
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RowReorder)
938
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RowReorder)
1008
939
  */
1009
940
  rowReorderFeature ? : object|Boolean|string|GridRowReorder|GridRowReorderConfig
1010
941
  /**
1011
942
  * 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)
1012
943
  * field of the record is updated (when [applyToAllRows](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RowResize#config-applyToAllRows) is `false`).
1013
- * ...
1014
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RowResize)
944
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RowResize)
1015
945
  */
1016
946
  rowResizeFeature ? : object|Boolean|string|GridRowResize|GridRowResizeConfig
1017
947
  /**
1018
948
  * <div class="external-example vertical" data-file="Grid/feature/Search.js"></div>
1019
- * ...
1020
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Search)
949
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Search)
1021
950
  */
1022
951
  searchFeature ? : object|Boolean|string|Search|SearchConfig
1023
952
  /**
1024
953
  * Allows sorting of grid by clicking (or tapping) headers, also displays which columns grid is sorted by (numbered if
1025
954
  * using multisort). Use modifier keys for multisorting: [Ctrl/CMD + click] to add sorter, [Ctrl/CMD + Alt + click] to remove sorter.
1026
955
  * The actual sorting is done by the store, see [Store.sort()](https://bryntum.com/products/schedulerpro/docs/api/Core/data/mixin/StoreSort#function-sort).
1027
- * ...
1028
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Sort)
956
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Sort)
1029
957
  */
1030
958
  sortFeature ? : object|Boolean|string|Sort|SortConfig
1031
959
  /**
1032
960
  * This feature allows splitting the Grid into multiple views, either by using the cell context menu, or
1033
961
  * programmatically by calling [split()](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Split#function-split).
1034
- * ...
1035
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Split)
962
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Split)
1036
963
  */
1037
964
  splitFeature ? : object|Boolean|string|GridSplit|GridSplitConfig
1038
965
  /**
1039
- * A feature which pins configurable content from a grid row to the top of the grid
1040
- * while the row scrolls off the top but is still visible.
1041
- * ...
1042
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/StickyCells)
966
+ * A feature which pins cell content to the top of the grid while the row scrolls off the top but is still visible. Very
967
+ * similar to native `position: sticky`, which because of Grid's multiple-region setup unfortunately cannot be used to
968
+ * achieve the same effect.
969
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/StickyCells)
1043
970
  */
1044
971
  stickyCellsFeature ? : object|Boolean|string|StickyCells|StickyCellsConfig
1045
972
  /**
1046
973
  * Stripes rows by adding alternating CSS classes to all row elements (`b-even` and `b-odd`).
1047
- * ...
1048
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Stripe)
974
+ * This improves visual readability in data-heavy grids by giving adjacent rows different background colors.
975
+ * Style the striped rows using the `.b-even` and `.b-odd` CSS classes.
976
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Stripe)
1049
977
  */
1050
978
  stripeFeature ? : object|Boolean|string|Stripe|StripeConfig
1051
979
  /**
1052
980
  * Displays a summary row in the grid footer.
1053
- * ...
1054
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Summary)
981
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Summary)
1055
982
  */
1056
983
  summaryFeature ? : object|Boolean|string|GridSummary|GridSummaryConfig
1057
984
  /**
@@ -1059,15 +986,13 @@ defineProps<{
1059
986
  * 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
1060
987
  * tree renderer that adds padding and icon to give the appearance of a tree. The original renderer is preserved and
1061
988
  * also called.
1062
- * ...
1063
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Tree)
989
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Tree)
1064
990
  */
1065
991
  treeFeature ? : object|Boolean|string|Tree|TreeConfig
1066
992
  /**
1067
993
  * A feature that allows transforming a flat dataset (or the leaves of a hierarchical) into a tree by specifying a
1068
994
  * record field per parent level. Parents are generated based on each leaf's value for those fields.
1069
- * ...
1070
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/TreeGroup)
995
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/TreeGroup)
1071
996
  */
1072
997
  treeGroupFeature ? : object|Boolean|string|TreeGroup|TreeGroupConfig
1073
998
 
@@ -1078,595 +1003,495 @@ const emit = defineEmits<{
1078
1003
  * Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
1079
1004
  * @param {string} e Event name
1080
1005
  * @param {object} params Event parameters
1081
- * @param {string} params.e Event name
1082
- * @param {object} params.params Event parameters
1083
- * @param {object} params.params.event Event object
1084
- * @param {Grid.view.Grid} params.params.event.source Owner grid
1085
- * @param {Grid.util.GridLocation} params.params.event.editorContext Editing context
1006
+ * @param {object} params.event Event object
1007
+ * @param {Grid.view.Grid} params.event.source Owner grid
1008
+ * @param {Grid.util.GridLocation} params.event.editorContext Editing context
1086
1009
  */
1087
- (e: 'beforeCancelCellEdit', params: ((event: { source: Grid, editorContext: GridLocation }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1010
+ (e: 'beforeCancelCellEdit', params: ((event: { source: Grid, editorContext: GridLocation }) => boolean|void)|string): boolean|void
1088
1011
  /**
1089
1012
  * 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.
1090
- * ...
1091
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#event-beforeCancelRowEdit)
1013
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#event-beforeCancelRowEdit)
1092
1014
  * @param {string} e Event name
1093
1015
  * @param {object} params Event parameters
1094
- * @param {string} params.e Event name
1095
- * @param {object} params.params Event parameters
1096
- * @param {object} params.params.event Event object
1097
- * @param {Grid.view.Grid} params.params.event.grid Target grid
1098
- * @param {RowEditorContext} params.params.event.editorContext Editing context
1016
+ * @param {object} params.event Event object
1017
+ * @param {Grid.view.Grid} params.event.grid Target grid
1018
+ * @param {RowEditorContext} params.event.editorContext Editing context
1099
1019
  */
1100
1020
  (e: 'beforeCancelRowEdit', params: ((event: { grid: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1101
1021
  /**
1102
1022
  * Fires on the owning Grid before editing starts, return `false` to prevent editing
1103
1023
  * @param {string} e Event name
1104
1024
  * @param {object} params Event parameters
1105
- * @param {string} params.e Event name
1106
- * @param {object} params.params Event parameters
1107
- * @param {object} params.params.event Event object
1108
- * @param {Grid.view.Grid} params.params.event.source Owner grid
1109
- * @param {CellEditorContext} params.params.event.editorContext Editing context
1025
+ * @param {object} params.event Event object
1026
+ * @param {Grid.view.Grid} params.event.source Owner grid
1027
+ * @param {CellEditorContext} params.event.editorContext Editing context
1110
1028
  */
1111
- (e: 'beforeCellEditStart', params: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1029
+ (e: 'beforeCellEditStart', params: ((event: { source: Grid, editorContext: CellEditorContext }) => boolean|void)|string): boolean|void
1112
1030
  /**
1113
1031
  * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
1114
1032
  * buttons while [autoEdit](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
1115
1033
  * @param {string} e Event name
1116
1034
  * @param {object} params Event parameters
1117
- * @param {string} params.e Event name
1118
- * @param {object} params.params Event parameters
1119
- * @param {object} params.params.event Event object
1120
- * @param {Grid.view.Grid} params.params.event.source Owner grid
1121
- * @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).
1035
+ * @param {object} params.event Event object
1036
+ * @param {Grid.view.Grid} params.event.source Owner grid
1037
+ * @param {(Grid.util.GridLocation|Core.data.Model)[]} 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).
1122
1038
  */
1123
- (e: 'beforeCellRangeDelete', params: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1039
+ (e: 'beforeCellRangeDelete', params: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void)|string): boolean|void
1124
1040
  /**
1125
1041
  * Fires for each selected record on the owning Grid before editing a range of selected cell values
1126
1042
  * @param {string} e Event name
1127
1043
  * @param {object} params Event parameters
1128
- * @param {string} params.e Event name
1129
- * @param {object} params.params Event parameters
1130
- * @param {object} params.params.event Event object
1131
- * @param {Core.data.Model} params.params.event.record Current selected record from the range
1132
- * @param {string} params.params.event.field The field being changed
1133
- * @param {any} params.params.event.value The value being set
1044
+ * @param {object} params.event Event object
1045
+ * @param {Core.data.Model} params.event.record Current selected record from the range
1046
+ * @param {string} params.event.field The field being changed
1047
+ * @param {any} params.event.value The value being set
1134
1048
  */
1135
- (e: 'beforeCellRangeEdit', params: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1049
+ (e: 'beforeCellRangeEdit', params: ((event: { record: Model, field: string, value: any }) => boolean|void)|string): boolean|void
1136
1050
  /**
1137
1051
  * This event is triggered before a parent column is collapsed or expanded.
1138
1052
  * @param {string} e Event name
1139
1053
  * @param {object} params Event parameters
1140
- * @param {string} params.e Event name
1141
- * @param {object} params.params Event parameters
1142
- * @param {object} params.params.event Event object
1143
- * @param {Grid.view.GridBase} params.params.event.source The grid instance
1144
- * @param {Grid.column.Column} params.params.event.column The column
1145
- * @param {boolean} params.params.event.collapsed `true` if the column is being collapsed, `false` if expanded
1054
+ * @param {object} params.event Event object
1055
+ * @param {Grid.view.GridBase} params.event.source The grid instance
1056
+ * @param {Grid.column.Column} params.event.column The column
1057
+ * @param {boolean} params.event.collapsed `true` if the column is being collapsed, `false` if expanded
1146
1058
  */
1147
1059
  (e: 'beforeColumnCollapseToggle', params: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string): void
1148
1060
  /**
1149
1061
  * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
1150
1062
  * @param {string} e Event name
1151
1063
  * @param {object} params Event parameters
1152
- * @param {string} params.e Event name
1153
- * @param {object} params.params Event parameters
1154
- * @param {object} params.params.event Event object
1155
- * @param {Grid.view.Grid} params.params.event.source The grid instance.
1156
- * @param {Grid.column.Column} params.params.event.column The dragged column.
1157
- * @param {Event} params.params.event.event The browser event.
1064
+ * @param {object} params.event Event object
1065
+ * @param {Grid.view.Grid} params.event.source The grid instance.
1066
+ * @param {Grid.column.Column} params.event.column The dragged column.
1067
+ * @param {Event} params.event.event The browser event.
1158
1068
  */
1159
- (e: 'beforeColumnDragStart', params: ((event: { source: Grid, column: Column, event: Event }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1069
+ (e: 'beforeColumnDragStart', params: ((event: { source: Grid, column: Column, event: Event }) => boolean|void)|string): boolean|void
1160
1070
  /**
1161
1071
  * This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
1162
1072
  * @param {string} e Event name
1163
1073
  * @param {object} params Event parameters
1164
- * @param {string} params.e Event name
1165
- * @param {object} params.params Event parameters
1166
- * @param {object} params.params.event Event object
1167
- * @param {Grid.view.Grid} params.params.event.source The grid instance.
1168
- * @param {Grid.column.Column} params.params.event.column The dragged column.
1169
- * @param {Grid.column.Column} params.params.event.insertBefore The column before which the dragged column will be inserted.
1170
- * @param {Grid.column.Column} params.params.event.newParent The new parent column.
1171
- * @param {Event} params.params.event.event The browser event.
1172
- * @param {string} params.params.event.region The region where the column was dropped.
1074
+ * @param {object} params.event Event object
1075
+ * @param {Grid.view.Grid} params.event.source The grid instance.
1076
+ * @param {Grid.column.Column} params.event.column The dragged column.
1077
+ * @param {Grid.column.Column} params.event.insertBefore The column before which the dragged column will be inserted.
1078
+ * @param {Grid.column.Column} params.event.newParent The new parent column.
1079
+ * @param {Event} params.event.event The browser event.
1080
+ * @param {string} params.event.region The region where the column was dropped.
1173
1081
  */
1174
- (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
1082
+ (e: 'beforeColumnDropFinalize', params: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void)|string): boolean|void
1175
1083
  /**
1176
1084
  * This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
1177
1085
  * `false`.
1178
1086
  * @param {string} e Event name
1179
1087
  * @param {object} params Event parameters
1180
- * @param {string} params.e Event name
1181
- * @param {object} params.params Event parameters
1182
- * @param {object} params.params.event Event object
1183
- * @param {Grid.view.Grid} params.params.event.source The grid instance
1184
- * @param {Grid.column.Column} params.params.event.column The column
1185
- * @param {Event} params.params.event.domEvent The browser event
1088
+ * @param {object} params.event Event object
1089
+ * @param {Grid.view.Grid} params.event.source The grid instance
1090
+ * @param {Grid.column.Column} params.event.column The column
1091
+ * @param {Event} params.event.domEvent The browser event
1186
1092
  */
1187
- (e: 'beforeColumnResize', params: ((event: { source: Grid, column: Column, domEvent: Event }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1093
+ (e: 'beforeColumnResize', params: ((event: { source: Grid, column: Column, domEvent: Event }) => boolean|void)|string): boolean|void
1188
1094
  /**
1189
1095
  * Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
1190
1096
  * @param {string} e Event name
1191
1097
  * @param {object} params Event parameters
1192
- * @param {string} params.e Event name
1193
- * @param {object} params.params Event parameters
1194
- * @param {object} params.params.event Event object
1195
- * @param {Grid.view.Grid} params.params.event.source Owner grid
1196
- * @param {Grid.util.GridLocation[]} params.params.event.cells The cells about to be copied or cut
1197
- * @param {string} params.params.event.data The string data about to be copied or cut
1198
- * @param {boolean} params.params.event.isCut `true` if this is a cut action
1199
- * @param {string} params.params.event.entityName 'cell' to distinguish this event from other beforeCopy events
1098
+ * @param {object} params.event Event object
1099
+ * @param {Grid.view.Grid} params.event.source Owner grid
1100
+ * @param {Grid.util.GridLocation[]} params.event.cells The cells about to be copied or cut
1101
+ * @param {string} params.event.data The string data about to be copied or cut
1102
+ * @param {boolean} params.event.isCut `true` if this is a cut action
1103
+ * @param {string} params.event.entityName 'cell' to distinguish this event from other beforeCopy events
1200
1104
  */
1201
1105
  (e: 'beforeCopy', params: ((event: { source: Grid, cells: GridLocation[], data: string, isCut: boolean, entityName: string }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1202
1106
  /**
1203
1107
  * Fires on the owning Grid before CSV export starts. Return `false` to cancel the export.
1204
1108
  * @param {string} e Event name
1205
1109
  * @param {object} params Event parameters
1206
- * @param {string} params.e Event name
1207
- * @param {object} params.params Event parameters
1208
- * @param {object} params.params.event Event object
1209
- * @param {ExportConfig} params.params.event.config Export config
1210
- * @param {Grid.column.Column[]} params.params.event.columns An array of columns to export
1211
- * @param {Core.data.Model[]} params.params.event.rows An array of records to export
1212
- * @param {string} params.params.event.lineDelimiter The CSV delimiter to separate lines
1213
- * @param {string} params.params.event.columnDelimiter The CSV delimiter to separate values on one line
1110
+ * @param {object} params.event Event object
1111
+ * @param {ExportConfig} params.event.config Export config
1112
+ * @param {Grid.column.Column[]} params.event.columns An array of columns to export
1113
+ * @param {Core.data.Model[]} params.event.rows An array of records to export
1114
+ * @param {string} params.event.lineDelimiter The CSV delimiter to separate lines
1115
+ * @param {string} params.event.columnDelimiter The CSV delimiter to separate values on one line
1214
1116
  */
1215
- (e: 'beforeCSVExport', params: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1117
+ (e: 'beforeCSVExport', params: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void)|string): boolean|void
1216
1118
  /**
1217
1119
  * Fires before an object is destroyed.
1218
1120
  * @param {string} e Event name
1219
1121
  * @param {object} params Event parameters
1220
- * @param {string} params.e Event name
1221
- * @param {object} params.params Event parameters
1222
- * @param {object} params.params.event Event object
1223
- * @param {Core.Base} params.params.event.source The Object that is being destroyed.
1122
+ * @param {object} params.event Event object
1123
+ * @param {Core.Base} params.event.source The Object that is being destroyed.
1224
1124
  */
1225
1125
  (e: 'beforeDestroy', params: ((event: { source: Base }) => void)|string): void
1226
1126
  /**
1227
1127
  * Fires on the owning Grid before Excel export starts. Return `false` to cancel the export.
1228
1128
  * @param {string} e Event name
1229
1129
  * @param {object} params Event parameters
1230
- * @param {string} params.e Event name
1231
- * @param {object} params.params Event parameters
1232
- * @param {object} params.params.event Event object
1233
- * @param {ExportConfig} params.params.event.config Export config
1234
- * @param {XLSColumn[]} params.params.event.columns An array of columns to export
1235
- * @param {any[][]} params.params.event.rows An array of records to export
1130
+ * @param {object} params.event Event object
1131
+ * @param {ExportConfig} params.event.config Export config
1132
+ * @param {XLSColumn[]} params.event.columns An array of columns to export
1133
+ * @param {any[][]} params.event.rows An array of records to export
1236
1134
  */
1237
- (e: 'beforeExcelExport', params: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1135
+ (e: 'beforeExcelExport', params: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void)|string): boolean|void
1238
1136
  /**
1239
1137
  * Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
1240
1138
  * @param {string} e Event name
1241
1139
  * @param {object} params Event parameters
1242
- * @param {string} params.e Event name
1243
- * @param {object} params.params Event parameters
1244
- * @param {object} params.params.event Event object
1245
- * @param {Grid.util.GridLocation} params.params.event.cell Information about the column / record
1246
- * @param {MouseEvent} params.params.event.domEvent The raw DOM event
1140
+ * @param {object} params.event Event object
1141
+ * @param {Grid.util.GridLocation} params.event.cell Information about the column / record
1142
+ * @param {MouseEvent} params.event.domEvent The raw DOM event
1247
1143
  */
1248
- (e: 'beforeFillHandleDragStart', params: ((event: { cell: GridLocation, domEvent: MouseEvent }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1144
+ (e: 'beforeFillHandleDragStart', params: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string): boolean|void
1249
1145
  /**
1250
1146
  * 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.
1251
1147
  * @param {string} e Event name
1252
1148
  * @param {object} params Event parameters
1253
- * @param {string} params.e Event name
1254
- * @param {object} params.params Event parameters
1255
- * @param {object} params.params.event Event object
1256
- * @param {Grid.view.Grid} params.params.event.grid Target grid
1257
- * @param {CellEditorContext} params.params.event.editorContext Editing context
1149
+ * @param {object} params.event Event object
1150
+ * @param {Grid.view.Grid} params.event.grid Target grid
1151
+ * @param {CellEditorContext} params.event.editorContext Editing context
1258
1152
  */
1259
1153
  (e: 'beforeFinishCellEdit', params: ((event: { grid: Grid, editorContext: CellEditorContext }) => void)|string): void
1260
1154
  /**
1261
1155
  * 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.
1262
- * ...
1263
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#event-beforeFinishRowEdit)
1156
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#event-beforeFinishRowEdit)
1264
1157
  * @param {string} e Event name
1265
1158
  * @param {object} params Event parameters
1266
- * @param {string} params.e Event name
1267
- * @param {object} params.params Event parameters
1268
- * @param {object} params.params.event Event object
1269
- * @param {Grid.view.Grid} params.params.event.grid Target grid
1270
- * @param {RowEditorContext} params.params.event.editorContext Editing context
1159
+ * @param {object} params.event Event object
1160
+ * @param {Grid.view.Grid} params.event.grid Target grid
1161
+ * @param {RowEditorContext} params.event.editorContext Editing context
1271
1162
  */
1272
1163
  (e: 'beforeFinishRowEdit', params: ((event: { grid: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1273
1164
  /**
1274
1165
  * Triggered before a widget is hidden. Return `false` to prevent the action.
1275
1166
  * @param {string} e Event name
1276
1167
  * @param {object} params Event parameters
1277
- * @param {string} params.e Event name
1278
- * @param {object} params.params Event parameters
1279
- * @param {object} params.params.event Event object
1280
- * @param {Core.widget.Widget} params.params.event.source The widget being hidden.
1168
+ * @param {object} params.event Event object
1169
+ * @param {Core.widget.Widget} params.event.source The widget being hidden.
1281
1170
  */
1282
- (e: 'beforeHide', params: ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1171
+ (e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
1283
1172
  /**
1284
1173
  * Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
1285
1174
  * @param {string} e Event name
1286
1175
  * @param {object} params Event parameters
1287
- * @param {string} params.e Event name
1288
- * @param {object} params.params Event parameters
1289
- * @param {object} params.params.event Event object
1290
- * @param {Grid.view.Grid} params.params.event.source Owner grid
1291
- * @param {string} params.params.event.clipboardData The clipboardData about to be pasted
1292
- * @param {Grid.util.GridLocation} params.params.event.targetCell The cell from which the paste will be started
1293
- * @param {string} params.params.event.entityName 'cell' to distinguish this event from other beforePaste events
1294
- * @param {string} params.params.event.text The raw text from clipboard
1176
+ * @param {object} params.event Event object
1177
+ * @param {Grid.view.Grid} params.event.source Owner grid
1178
+ * @param {string} params.event.clipboardData The clipboardData about to be pasted
1179
+ * @param {Grid.util.GridLocation} params.event.targetCell The cell from which the paste will be started
1180
+ * @param {string} params.event.entityName 'cell' to distinguish this event from other beforePaste events
1181
+ * @param {string} params.event.text The raw text from clipboard
1295
1182
  */
1296
1183
  (e: 'beforePaste', params: ((event: { source: Grid, clipboardData: string, targetCell: GridLocation, entityName: string, text: string }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1297
1184
  /**
1298
1185
  * Fires on the owning Grid before export started. Return `false` to cancel the export.
1299
1186
  * @param {string} e Event name
1300
1187
  * @param {object} params Event parameters
1301
- * @param {string} params.e Event name
1302
- * @param {object} params.params Event parameters
1303
- * @param {object} params.params.event Event object
1304
- * @param {PdfExportConfig} params.params.event.config Export config
1188
+ * @param {object} params.event Event object
1189
+ * @param {PdfExportConfig} params.event.config Export config
1305
1190
  */
1306
- (e: 'beforePdfExport', params: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1191
+ (e: 'beforePdfExport', params: ((event: { config: PdfExportConfig }) => boolean|void)|string): boolean|void
1307
1192
  /**
1308
1193
  * Fires before a row is rendered.
1309
1194
  * @param {string} e Event name
1310
1195
  * @param {object} params Event parameters
1311
- * @param {string} params.e Event name
1312
- * @param {object} params.params Event parameters
1313
- * @param {object} params.params.event Event object
1314
- * @param {Grid.view.GridBase} params.params.event.source The firing Grid instance
1315
- * @param {Grid.row.Row} params.params.event.row The row about to be rendered
1316
- * @param {Core.data.Model} params.params.event.record The record for the row
1317
- * @param {number} params.params.event.recordIndex The zero-based index of the record
1196
+ * @param {object} params.event Event object
1197
+ * @param {Grid.view.GridBase} params.event.source The firing Grid instance
1198
+ * @param {Grid.row.Row} params.event.row The row about to be rendered
1199
+ * @param {Core.data.Model} params.event.record The record for the row
1200
+ * @param {number} params.event.recordIndex The zero-based index of the record
1318
1201
  */
1319
1202
  (e: 'beforeRenderRow', params: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string): void
1320
1203
  /**
1321
1204
  * Grid rows are about to be rendered
1322
1205
  * @param {string} e Event name
1323
1206
  * @param {object} params Event parameters
1324
- * @param {string} params.e Event name
1325
- * @param {object} params.params Event parameters
1326
- * @param {object} params.params.event Event object
1327
- * @param {Grid.view.GridBase} params.params.event.source This grid.
1207
+ * @param {object} params.event Event object
1208
+ * @param {Grid.view.GridBase} params.event.source This grid.
1328
1209
  */
1329
1210
  (e: 'beforeRenderRows', params: ((event: { source: GridBase }) => void)|string): void
1330
1211
  /**
1331
1212
  * This event fires before row collapse is started.
1332
- * ...
1333
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#event-beforeRowCollapse)
1213
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#event-beforeRowCollapse)
1334
1214
  * @param {string} e Event name
1335
1215
  * @param {object} params Event parameters
1336
- * @param {string} params.e Event name
1337
- * @param {object} params.params Event parameters
1338
- * @param {object} params.params.event Event object
1339
- * @param {Core.data.Model} params.params.event.record Record
1216
+ * @param {object} params.event Event object
1217
+ * @param {Core.data.Model} params.event.record Record
1340
1218
  */
1341
1219
  (e: 'beforeRowCollapse', params: ((event: { record: Model }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1342
1220
  /**
1343
1221
  * This event fires before row expand is started.
1344
- * ...
1345
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#event-beforeRowExpand)
1222
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#event-beforeRowExpand)
1346
1223
  * @param {string} e Event name
1347
1224
  * @param {object} params Event parameters
1348
- * @param {string} params.e Event name
1349
- * @param {object} params.params Event parameters
1350
- * @param {object} params.params.event Event object
1351
- * @param {Core.data.Model} params.params.event.record Record
1225
+ * @param {object} params.event Event object
1226
+ * @param {Core.data.Model} params.event.record Record
1352
1227
  */
1353
1228
  (e: 'beforeRowExpand', params: ((event: { record: Model }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1354
1229
  /**
1355
1230
  * Fires before the selection changes. Returning `false` from a listener prevents the change
1356
1231
  * @param {string} e Event name
1357
1232
  * @param {object} params Event parameters
1358
- * @param {string} params.e Event name
1359
- * @param {object} params.params Event parameters
1360
- * @param {object} params.params.event Event object
1361
- * @param {string} params.params.event.action `'select'`/`'deselect'`
1362
- * @param {'row','cell'} params.params.event.mode `'row'`/`'cell'`
1363
- * @param {Grid.view.Grid} params.params.event.source
1364
- * @param {Core.data.Model[]} params.params.event.deselected The records to be deselected in this operation.
1365
- * @param {Core.data.Model[]} params.params.event.selected The records to be selected in this operation.
1366
- * @param {Core.data.Model[]} params.params.event.selection The records in the current selection, before applying `selected` and `deselected`
1367
- * @param {Grid.util.GridLocation[]} params.params.event.deselectedCells The cells to be deselected in this operation.
1368
- * @param {Grid.util.GridLocation[]} params.params.event.selectedCells The cells to be selected in this operation.
1369
- * @param {Grid.util.GridLocation[]} params.params.event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
1233
+ * @param {object} params.event Event object
1234
+ * @param {string} params.event.action `'select'`/`'deselect'`
1235
+ * @param {'row','cell'} params.event.mode `'row'`/`'cell'`
1236
+ * @param {Grid.view.Grid} params.event.source
1237
+ * @param {Core.data.Model[]} params.event.deselected The records to be deselected in this operation.
1238
+ * @param {Core.data.Model[]} params.event.selected The records to be selected in this operation.
1239
+ * @param {Core.data.Model[]} params.event.selection The records in the current selection, before applying `selected` and `deselected`
1240
+ * @param {Grid.util.GridLocation[]} params.event.deselectedCells The cells to be deselected in this operation.
1241
+ * @param {Grid.util.GridLocation[]} params.event.selectedCells The cells to be selected in this operation.
1242
+ * @param {Grid.util.GridLocation[]} params.event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
1370
1243
  */
1371
- (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
1244
+ (e: 'beforeSelectionChange', params: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => boolean|void)|string): boolean|void
1372
1245
  /**
1373
1246
  * Fired before this container will load record values into its child fields. This is useful if you
1374
1247
  * want to modify the UI before data is loaded (e.g. set some input field to be readonly)
1375
1248
  * @param {string} e Event name
1376
1249
  * @param {object} params Event parameters
1377
- * @param {string} params.e Event name
1378
- * @param {object} params.params Event parameters
1379
- * @param {object} params.params.event Event object
1380
- * @param {Core.widget.Container} params.params.event.source The container
1381
- * @param {Core.data.Model} params.params.event.record The record
1250
+ * @param {object} params.event Event object
1251
+ * @param {Core.widget.Container} params.event.source The container
1252
+ * @param {Core.data.Model} params.event.record The record
1382
1253
  */
1383
1254
  (e: 'beforeSetRecord', params: ((event: { source: Container, record: Model }) => void)|string): void
1384
1255
  /**
1385
1256
  * Triggered before a widget is shown. Return `false` to prevent the action.
1386
1257
  * @param {string} e Event name
1387
1258
  * @param {object} params Event parameters
1388
- * @param {string} params.e Event name
1389
- * @param {object} params.params Event parameters
1390
- * @param {object} params.params.event Event object
1391
- * @param {Core.widget.Widget,any} params.params.event.source The widget being shown
1259
+ * @param {object} params.event Event object
1260
+ * @param {Core.widget.Widget,any} params.event.source The widget being shown
1392
1261
  */
1393
1262
  (e: 'beforeShow', params: ((event: { source: Widget|any }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1394
1263
  /**
1395
1264
  * Fires on the owning Grid before editing starts, return `false` to prevent editing
1396
1265
  * @param {string} e Event name
1397
1266
  * @param {object} params Event parameters
1398
- * @param {string} params.e Event name
1399
- * @param {object} params.params Event parameters
1400
- * @param {object} params.params.event Event object
1401
- * @param {Grid.view.Grid} params.params.event.source Owner grid
1402
- * @param {RowEditorContext} params.params.event.editorContext Editing context
1267
+ * @param {object} params.event Event object
1268
+ * @param {Grid.view.Grid} params.event.source Owner grid
1269
+ * @param {RowEditorContext} params.event.editorContext Editing context
1403
1270
  */
1404
- (e: 'beforeStartRowEdit', params: ((event: { source: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1271
+ (e: 'beforeStartRowEdit', params: ((event: { source: Grid, editorContext: RowEditorContext }) => boolean|void)|string): boolean|void
1405
1272
  /**
1406
1273
  * Fired before state is applied to the source. Allows editing the state object or preventing the operation.
1407
1274
  * @param {string} e Event name
1408
1275
  * @param {object} params Event parameters
1409
- * @param {string} params.e Event name
1410
- * @param {object} params.params Event parameters
1411
- * @param {object} params.params.event Event object
1412
- * @param {GridStateInfo} params.params.event.state State object config
1276
+ * @param {object} params.event Event object
1277
+ * @param {GridStateInfo} params.event.state State object config
1413
1278
  */
1414
- (e: 'beforeStateApply', params: ((event: { state: GridStateInfo }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1279
+ (e: 'beforeStateApply', params: ((event: { state: GridStateInfo }) => boolean|void)|string): boolean|void
1415
1280
  /**
1416
1281
  * Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
1417
1282
  * @param {string} e Event name
1418
1283
  * @param {object} params Event parameters
1419
- * @param {string} params.e Event name
1420
- * @param {object} params.params Event parameters
1421
- * @param {object} params.params.event Event object
1422
- * @param {GridStateInfo} params.params.event.state State object config
1284
+ * @param {object} params.event Event object
1285
+ * @param {GridStateInfo} params.event.state State object config
1423
1286
  */
1424
- (e: 'beforeStateSave', params: ((event: { state: GridStateInfo }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1287
+ (e: 'beforeStateSave', params: ((event: { state: GridStateInfo }) => boolean|void)|string): boolean|void
1425
1288
  /**
1426
1289
  * Fired when a group is going to be expanded or collapsed using the UI.
1427
1290
  * Returning `false` from a listener prevents the operation
1428
1291
  * @param {string} e Event name
1429
1292
  * @param {object} params Event parameters
1430
- * @param {string} params.e Event name
1431
- * @param {object} params.params Event parameters
1432
- * @param {object} params.params.event Event object
1433
- * @param {Core.data.Model} params.params.event.groupRecord [DEPRECATED] Use `groupRecords` param instead
1434
- * @param {Core.data.Model[]} params.params.event.groupRecords The group records being toggled
1435
- * @param {boolean} params.params.event.collapse Collapsed (true) or expanded (false)
1436
- * @param {Event} params.params.event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
1293
+ * @param {object} params.event Event object
1294
+ * @param {Core.data.Model} params.event.groupRecord [DEPRECATED] Use `groupRecords` param instead
1295
+ * @param {Core.data.Model[]} params.event.groupRecords The group records being toggled
1296
+ * @param {boolean} params.event.collapse Collapsed (true) or expanded (false)
1297
+ * @param {Event} params.event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
1437
1298
  */
1438
- (e: 'beforeToggleGroup', params: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1299
+ (e: 'beforeToggleGroup', params: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void)|string): boolean|void
1439
1300
  /**
1440
1301
  * Fired before a parent node record toggles its collapsed state.
1441
1302
  * @param {string} e Event name
1442
1303
  * @param {object} params Event parameters
1443
- * @param {string} params.e Event name
1444
- * @param {object} params.params Event parameters
1445
- * @param {object} params.params.event Event object
1446
- * @param {Grid.view.Grid} params.params.event.source The firing Grid instance.
1447
- * @param {Core.data.Model} params.params.event.record The record being toggled.
1448
- * @param {boolean} params.params.event.collapse `true` if the node is being collapsed.
1304
+ * @param {object} params.event Event object
1305
+ * @param {Grid.view.Grid} params.event.source The firing Grid instance.
1306
+ * @param {Core.data.Model} params.event.record The record being toggled.
1307
+ * @param {boolean} params.event.collapse `true` if the node is being collapsed.
1449
1308
  */
1450
1309
  (e: 'beforeToggleNode', params: ((event: { source: Grid, record: Model, collapse: boolean }) => void)|string): void
1451
1310
  /**
1452
1311
  * Fires on the owning Grid when editing is cancelled
1453
1312
  * @param {string} e Event name
1454
1313
  * @param {object} params Event parameters
1455
- * @param {string} params.e Event name
1456
- * @param {object} params.params Event parameters
1457
- * @param {object} params.params.event Event object
1458
- * @param {Grid.view.Grid} params.params.event.source Owner grid
1459
- * @param {Grid.util.GridLocation} params.params.event.editorContext Editing context
1460
- * @param {Event} params.params.event.event Included if the cancellation was triggered by a DOM event
1314
+ * @param {object} params.event Event object
1315
+ * @param {Grid.view.Grid} params.event.source Owner grid
1316
+ * @param {Grid.util.GridLocation} params.event.editorContext Editing context
1317
+ * @param {Event} params.event.event Included if the cancellation was triggered by a DOM event
1461
1318
  */
1462
1319
  (e: 'cancelCellEdit', params: ((event: { source: Grid, editorContext: GridLocation, event: Event }) => void)|string): void
1463
1320
  /**
1464
1321
  * Fires when any other event is fired from the object.
1465
- * ...
1466
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#event-catchAll)
1322
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#event-catchAll)
1467
1323
  * @param {string} e Event name
1468
1324
  * @param {object} params Event parameters
1469
- * @param {string} params.e Event name
1470
- * @param {object} params.params Event parameters
1471
- * @param {object} params.params.event Event object
1472
- * @param {{[key: string]: any, type: string}} params.params.event.event The Object that contains event details
1473
- * @param {string} params.params.event.event.type The type of the event which is caught by the listener
1325
+ * @param {object} params.event Event object
1326
+ * @param {{[key: string]: any, type: string}} params.event.event The Object that contains event details
1327
+ * @param {string} params.event.event.type The type of the event which is caught by the listener
1474
1328
  */
1475
1329
  (e: 'catchAll', params: ((event: {[key: string]: any, type: string}) => void)|string): void
1476
1330
  /**
1477
1331
  * Fired when user clicks in a grid cell
1478
1332
  * @param {string} e Event name
1479
1333
  * @param {object} params Event parameters
1480
- * @param {string} params.e Event name
1481
- * @param {object} params.params Event parameters
1482
- * @param {object} params.params.event Event object
1483
- * @param {Grid.view.Grid} params.params.event.grid The grid instance
1484
- * @param {Core.data.Model} params.params.event.record The record representing the row
1485
- * @param {Grid.column.Column} params.params.event.column The column to which the cell belongs
1486
- * @param {HTMLElement} params.params.event.cellElement The cell HTML element
1487
- * @param {HTMLElement} params.params.event.target The target element
1488
- * @param {MouseEvent} params.params.event.event The native DOM event
1334
+ * @param {object} params.event Event object
1335
+ * @param {Grid.view.Grid} params.event.grid The grid instance
1336
+ * @param {Core.data.Model} params.event.record The record representing the row
1337
+ * @param {Grid.column.Column} params.event.column The column to which the cell belongs
1338
+ * @param {HTMLElement} params.event.cellElement The cell HTML element
1339
+ * @param {HTMLElement} params.event.target The target element
1340
+ * @param {MouseEvent} params.event.event The native DOM event
1489
1341
  */
1490
1342
  (e: 'cellClick', params: ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string): void
1491
1343
  /**
1492
1344
  * Fired when user activates contextmenu in a grid cell
1493
1345
  * @param {string} e Event name
1494
1346
  * @param {object} params Event parameters
1495
- * @param {string} params.e Event name
1496
- * @param {object} params.params Event parameters
1497
- * @param {object} params.params.event Event object
1498
- * @param {Grid.view.Grid} params.params.event.grid The grid instance
1499
- * @param {Core.data.Model} params.params.event.record The record representing the row
1500
- * @param {Grid.column.Column} params.params.event.column The column to which the cell belongs
1501
- * @param {HTMLElement} params.params.event.cellElement The cell HTML element
1502
- * @param {HTMLElement} params.params.event.target The target element
1503
- * @param {MouseEvent} params.params.event.event The native DOM event
1347
+ * @param {object} params.event Event object
1348
+ * @param {Grid.view.Grid} params.event.grid The grid instance
1349
+ * @param {Core.data.Model} params.event.record The record representing the row
1350
+ * @param {Grid.column.Column} params.event.column The column to which the cell belongs
1351
+ * @param {HTMLElement} params.event.cellElement The cell HTML element
1352
+ * @param {HTMLElement} params.event.target The target element
1353
+ * @param {MouseEvent} params.event.event The native DOM event
1504
1354
  */
1505
1355
  (e: 'cellContextMenu', params: ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string): void
1506
1356
  /**
1507
1357
  * Fired when user double clicks a grid cell
1508
1358
  * @param {string} e Event name
1509
1359
  * @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.grid The grid instance
1514
- * @param {Core.data.Model} params.params.event.record The record representing the row
1515
- * @param {Grid.column.Column} params.params.event.column The column to which the cell belongs
1516
- * @param {HTMLElement} params.params.event.cellElement The cell HTML element
1517
- * @param {HTMLElement} params.params.event.target The target element
1518
- * @param {MouseEvent} params.params.event.event The native DOM event
1360
+ * @param {object} params.event Event object
1361
+ * @param {Grid.view.Grid} params.event.grid The grid instance
1362
+ * @param {Core.data.Model} params.event.record The record representing the row
1363
+ * @param {Grid.column.Column} params.event.column The column to which the cell belongs
1364
+ * @param {HTMLElement} params.event.cellElement The cell HTML element
1365
+ * @param {HTMLElement} params.event.target The target element
1366
+ * @param {MouseEvent} params.event.event The native DOM event
1519
1367
  */
1520
1368
  (e: 'cellDblClick', params: ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string): void
1521
1369
  /**
1522
1370
  * This event fires on the owning grid before the context menu is shown for a cell.
1523
1371
  * 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).
1524
- * ...
1525
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#event-cellMenuBeforeShow)
1372
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#event-cellMenuBeforeShow)
1526
1373
  * @param {string} e Event name
1527
1374
  * @param {object} params Event parameters
1528
- * @param {string} params.e Event name
1529
- * @param {object} params.params Event parameters
1530
- * @param {object} params.params.event Event object
1531
- * @param {Grid.view.Grid} params.params.event.source The grid
1532
- * @param {Core.widget.Menu} params.params.event.menu The menu
1533
- * @param {Record<string, MenuItemEntry>} params.params.event.items Menu item configs
1534
- * @param {Grid.column.Column} params.params.event.column Column
1535
- * @param {Core.data.Model} params.params.event.record Record
1375
+ * @param {object} params.event Event object
1376
+ * @param {Grid.view.Grid} params.event.source The grid
1377
+ * @param {Core.widget.Menu} params.event.menu The menu
1378
+ * @param {Record<string, MenuItemEntry>} params.event.items Menu item configs
1379
+ * @param {Grid.column.Column} params.event.column Column
1380
+ * @param {Core.data.Model} params.event.record Record
1536
1381
  */
1537
- (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
1382
+ (e: 'cellMenuBeforeShow', params: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void)|string): boolean|void
1538
1383
  /**
1539
1384
  * This event fires on the owning grid when an item is selected in the cell context menu.
1540
1385
  * @param {string} e Event name
1541
1386
  * @param {object} params Event parameters
1542
- * @param {string} params.e Event name
1543
- * @param {object} params.params Event parameters
1544
- * @param {object} params.params.event Event object
1545
- * @param {Grid.view.Grid} params.params.event.source The grid
1546
- * @param {Core.widget.Menu} params.params.event.menu The menu
1547
- * @param {Core.widget.MenuItem} params.params.event.item Selected menu item
1548
- * @param {Grid.column.Column} params.params.event.column Column
1549
- * @param {Core.data.Model} params.params.event.record Record
1387
+ * @param {object} params.event Event object
1388
+ * @param {Grid.view.Grid} params.event.source The grid
1389
+ * @param {Core.widget.Menu} params.event.menu The menu
1390
+ * @param {Core.widget.MenuItem} params.event.item Selected menu item
1391
+ * @param {Grid.column.Column} params.event.column Column
1392
+ * @param {Core.data.Model} params.event.record Record
1550
1393
  */
1551
1394
  (e: 'cellMenuItem', params: ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column, record: Model }) => void)|string): void
1552
1395
  /**
1553
1396
  * This event fires on the owning grid after the context menu is shown for a cell.
1554
1397
  * @param {string} e Event name
1555
1398
  * @param {object} params Event parameters
1556
- * @param {string} params.e Event name
1557
- * @param {object} params.params Event parameters
1558
- * @param {object} params.params.event Event object
1559
- * @param {Grid.view.Grid} params.params.event.source The grid
1560
- * @param {Core.widget.Menu} params.params.event.menu The menu
1561
- * @param {Record<string, MenuItemEntry>} params.params.event.items Menu item configs
1562
- * @param {Grid.column.Column} params.params.event.column Column
1563
- * @param {Core.data.Model} params.params.event.record Record
1399
+ * @param {object} params.event Event object
1400
+ * @param {Grid.view.Grid} params.event.source The grid
1401
+ * @param {Core.widget.Menu} params.event.menu The menu
1402
+ * @param {Record<string, MenuItemEntry>} params.event.items Menu item configs
1403
+ * @param {Grid.column.Column} params.event.column Column
1404
+ * @param {Core.data.Model} params.event.record Record
1564
1405
  */
1565
1406
  (e: 'cellMenuShow', params: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => void)|string): void
1566
1407
  /**
1567
1408
  * This event fires on the owning grid when a check item is toggled in the cell context menu.
1568
1409
  * @param {string} e Event name
1569
1410
  * @param {object} params Event parameters
1570
- * @param {string} params.e Event name
1571
- * @param {object} params.params Event parameters
1572
- * @param {object} params.params.event Event object
1573
- * @param {Grid.view.Grid} params.params.event.source The grid
1574
- * @param {Core.widget.Menu} params.params.event.menu The menu
1575
- * @param {Core.widget.MenuItem} params.params.event.item Selected menu item
1576
- * @param {Grid.column.Column} params.params.event.column Column
1577
- * @param {Core.data.Model} params.params.event.record Record
1578
- * @param {boolean} params.params.event.checked Checked or not
1411
+ * @param {object} params.event Event object
1412
+ * @param {Grid.view.Grid} params.event.source The grid
1413
+ * @param {Core.widget.Menu} params.event.menu The menu
1414
+ * @param {Core.widget.MenuItem} params.event.item Selected menu item
1415
+ * @param {Grid.column.Column} params.event.column Column
1416
+ * @param {Core.data.Model} params.event.record Record
1417
+ * @param {boolean} params.event.checked Checked or not
1579
1418
  */
1580
1419
  (e: 'cellMenuToggleItem', params: ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column, record: Model, checked: boolean }) => void)|string): void
1581
1420
  /**
1582
1421
  * Fired when the mouse enters a cell
1583
1422
  * @param {string} e Event name
1584
1423
  * @param {object} params Event parameters
1585
- * @param {string} params.e Event name
1586
- * @param {object} params.params Event parameters
1587
- * @param {object} params.params.event Event object
1588
- * @param {Grid.view.Grid} params.params.event.source The grid instance
1589
- * @param {Core.data.Model} params.params.event.record The record representing the hovered cell
1590
- * @param {Grid.column.Column} params.params.event.column The column currently hovered
1591
- * @param {HTMLElement} params.params.event.cellElement The cell HTML element
1592
- * @param {MouseEvent} params.params.event.event The native DOM event
1424
+ * @param {object} params.event Event object
1425
+ * @param {Grid.view.Grid} params.event.source The grid instance
1426
+ * @param {Core.data.Model} params.event.record The record representing the hovered cell
1427
+ * @param {Grid.column.Column} params.event.column The column currently hovered
1428
+ * @param {HTMLElement} params.event.cellElement The cell HTML element
1429
+ * @param {MouseEvent} params.event.event The native DOM event
1593
1430
  */
1594
1431
  (e: 'cellMouseEnter', params: ((event: { source: Grid, record: Model, column: Column, cellElement: HTMLElement, event: MouseEvent }) => void)|string): void
1595
1432
  /**
1596
1433
  * Fired when the mouse leaves a cell
1597
1434
  * @param {string} e Event name
1598
1435
  * @param {object} params Event parameters
1599
- * @param {string} params.e Event name
1600
- * @param {object} params.params Event parameters
1601
- * @param {object} params.params.event Event object
1602
- * @param {Grid.view.Grid} params.params.event.source The grid instance
1603
- * @param {Core.data.Model} params.params.event.record The record representing the cell that the mouse left
1604
- * @param {Grid.column.Column} params.params.event.column The column representing the cell that the mouse left
1605
- * @param {HTMLElement} params.params.event.cellElement The cell HTML element that the mouse left
1606
- * @param {MouseEvent} params.params.event.event The native DOM event
1436
+ * @param {object} params.event Event object
1437
+ * @param {Grid.view.Grid} params.event.source The grid instance
1438
+ * @param {Core.data.Model} params.event.record The record representing the cell that the mouse left
1439
+ * @param {Grid.column.Column} params.event.column The column representing the cell that the mouse left
1440
+ * @param {HTMLElement} params.event.cellElement The cell HTML element that the mouse left
1441
+ * @param {MouseEvent} params.event.event The native DOM event
1607
1442
  */
1608
1443
  (e: 'cellMouseLeave', params: ((event: { source: Grid, record: Model, column: Column, cellElement: HTMLElement, event: MouseEvent }) => void)|string): void
1609
1444
  /**
1610
1445
  * Fired when a user moves the mouse out of a grid cell
1611
1446
  * @param {string} e Event name
1612
1447
  * @param {object} params Event parameters
1613
- * @param {string} params.e Event name
1614
- * @param {object} params.params Event parameters
1615
- * @param {object} params.params.event Event object
1616
- * @param {Grid.view.Grid} params.params.event.grid The grid instance
1617
- * @param {Core.data.Model} params.params.event.record The record representing the row
1618
- * @param {Grid.column.Column} params.params.event.column The column to which the cell belongs
1619
- * @param {HTMLElement} params.params.event.cellElement The cell HTML element
1620
- * @param {HTMLElement} params.params.event.target The target element
1621
- * @param {MouseEvent} params.params.event.event The native DOM event
1448
+ * @param {object} params.event Event object
1449
+ * @param {Grid.view.Grid} params.event.grid The grid instance
1450
+ * @param {Core.data.Model} params.event.record The record representing the row
1451
+ * @param {Grid.column.Column} params.event.column The column to which the cell belongs
1452
+ * @param {HTMLElement} params.event.cellElement The cell HTML element
1453
+ * @param {HTMLElement} params.event.target The target element
1454
+ * @param {MouseEvent} params.event.event The native DOM event
1622
1455
  */
1623
1456
  (e: 'cellMouseOut', params: ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string): void
1624
1457
  /**
1625
1458
  * Fired when user moves the mouse over a grid cell
1626
1459
  * @param {string} e Event name
1627
1460
  * @param {object} params Event parameters
1628
- * @param {string} params.e Event name
1629
- * @param {object} params.params Event parameters
1630
- * @param {object} params.params.event Event object
1631
- * @param {Grid.view.Grid} params.params.event.grid The grid instance
1632
- * @param {Core.data.Model} params.params.event.record The record representing the row
1633
- * @param {Grid.column.Column} params.params.event.column The column to which the cell belongs
1634
- * @param {HTMLElement} params.params.event.cellElement The cell HTML element
1635
- * @param {HTMLElement} params.params.event.target The target element
1636
- * @param {MouseEvent} params.params.event.event The native DOM event
1461
+ * @param {object} params.event Event object
1462
+ * @param {Grid.view.Grid} params.event.grid The grid instance
1463
+ * @param {Core.data.Model} params.event.record The record representing the row
1464
+ * @param {Grid.column.Column} params.event.column The column to which the cell belongs
1465
+ * @param {HTMLElement} params.event.cellElement The cell HTML element
1466
+ * @param {HTMLElement} params.event.target The target element
1467
+ * @param {MouseEvent} params.event.event The native DOM event
1637
1468
  */
1638
1469
  (e: 'cellMouseOver', params: ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string): void
1639
1470
  /**
1640
1471
  * Fires when a Panel is collapsed using the [collapsible](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Panel#config-collapsible) setting.
1641
1472
  * @param {string} e Event name
1642
1473
  * @param {object} params Event parameters
1643
- * @param {string} params.e Event name
1644
- * @param {object} params.params Event parameters
1645
- * @param {object} params.params.event Event object
1646
- * @param {Core.widget.Panel} params.params.event.source This Panel.
1474
+ * @param {object} params.event Event object
1475
+ * @param {Core.widget.Panel} params.event.source This Panel.
1647
1476
  */
1648
1477
  (e: 'collapse', params: ((event: { source: Panel }) => void)|string): void
1649
1478
  /**
1650
1479
  * Fired before a parent node record is collapsed.
1651
1480
  * @param {string} e Event name
1652
1481
  * @param {object} params Event parameters
1653
- * @param {string} params.e Event name
1654
- * @param {object} params.params Event parameters
1655
- * @param {object} params.params.event Event object
1656
- * @param {Grid.view.Grid} params.params.event.source The firing Grid instance.
1657
- * @param {Core.data.Model} params.params.event.record The record which has been collapsed.
1482
+ * @param {object} params.event Event object
1483
+ * @param {Grid.view.Grid} params.event.source The firing Grid instance.
1484
+ * @param {Core.data.Model} params.event.record The record which has been collapsed.
1658
1485
  */
1659
1486
  (e: 'collapseNode', params: ((event: { source: Grid, record: Model }) => void)|string): void
1660
1487
  /**
1661
1488
  * This event is triggered after a parent column has been collapsed or expanded.
1662
1489
  * @param {string} e Event name
1663
1490
  * @param {object} params Event parameters
1664
- * @param {string} params.e Event name
1665
- * @param {object} params.params Event parameters
1666
- * @param {object} params.params.event Event object
1667
- * @param {Grid.view.GridBase} params.params.event.source The Grid instance
1668
- * @param {Grid.column.Column} params.params.event.column The column being toggled
1669
- * @param {boolean} params.params.event.collapsed `true` if the column is now collapsed, `false` if expanded
1491
+ * @param {object} params.event Event object
1492
+ * @param {Grid.view.GridBase} params.event.source The Grid instance
1493
+ * @param {Grid.column.Column} params.event.column The column being toggled
1494
+ * @param {boolean} params.event.collapsed `true` if the column is now collapsed, `false` if expanded
1670
1495
  */
1671
1496
  (e: 'columnCollapseToggle', params: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string): void
1672
1497
  /**
@@ -1674,27 +1499,23 @@ const emit = defineEmits<{
1674
1499
  * to indicate whether the drop position is valid or not.
1675
1500
  * @param {string} e Event name
1676
1501
  * @param {object} params Event parameters
1677
- * @param {string} params.e Event name
1678
- * @param {object} params.params Event parameters
1679
- * @param {object} params.params.event Event object
1680
- * @param {Grid.view.Grid} params.params.event.source The grid instance.
1681
- * @param {Grid.column.Column} params.params.event.column The dragged column.
1682
- * @param {Grid.column.Column} params.params.event.insertBefore The column before which the dragged column will be inserted (if not last).
1683
- * @param {Event} params.params.event.event The browser event.
1684
- * @param {object} params.params.event.context
1685
- * @param {boolean} params.params.event.context.valid Set this to `true` or `false` to indicate whether the drop position is valid.
1502
+ * @param {object} params.event Event object
1503
+ * @param {Grid.view.Grid} params.event.source The grid instance.
1504
+ * @param {Grid.column.Column} params.event.column The dragged column.
1505
+ * @param {Grid.column.Column} params.event.insertBefore The column before which the dragged column will be inserted (if not last).
1506
+ * @param {Event} params.event.event The browser event.
1507
+ * @param {object} params.event.context
1508
+ * @param {boolean} params.event.context.valid Set this to `true` or `false` to indicate whether the drop position is valid.
1686
1509
  */
1687
1510
  (e: 'columnDrag', params: ((event: { source: Grid, column: Column, insertBefore: Column, event: Event, context: { valid: boolean } }) => void)|string): void
1688
1511
  /**
1689
1512
  * This event is fired when a column drag gesture has started.
1690
1513
  * @param {string} e Event name
1691
1514
  * @param {object} params Event parameters
1692
- * @param {string} params.e Event name
1693
- * @param {object} params.params Event parameters
1694
- * @param {object} params.params.event Event object
1695
- * @param {Grid.view.Grid} params.params.event.source The grid instance.
1696
- * @param {Grid.column.Column} params.params.event.column The dragged column.
1697
- * @param {Event} params.params.event.event The browser event.
1515
+ * @param {object} params.event Event object
1516
+ * @param {Grid.view.Grid} params.event.source The grid instance.
1517
+ * @param {Grid.column.Column} params.event.column The dragged column.
1518
+ * @param {Event} params.event.event The browser event.
1698
1519
  */
1699
1520
  (e: 'columnDragStart', params: ((event: { source: Grid, column: Column, event: Event }) => void)|string): void
1700
1521
  /**
@@ -1702,127 +1523,106 @@ const emit = defineEmits<{
1702
1523
  * vetoed and the column was moved in the column store.
1703
1524
  * @param {string} e Event name
1704
1525
  * @param {object} params Event parameters
1705
- * @param {string} params.e Event name
1706
- * @param {object} params.params Event parameters
1707
- * @param {object} params.params.event Event object
1708
- * @param {Grid.view.Grid} params.params.event.source The grid instance.
1709
- * @param {Grid.column.Column} params.params.event.column The dragged column.
1710
- * @param {Grid.column.Column} params.params.event.insertBefore The column before which the dragged column will be inserted.
1711
- * @param {Grid.column.Column} params.params.event.newParent The new parent column.
1712
- * @param {boolean} params.params.event.valid `true` if the operation was not vetoed.
1713
- * @param {Event} params.params.event.event The browser event.
1714
- * @param {string} params.params.event.region The region where the column was dropped.
1526
+ * @param {object} params.event Event object
1527
+ * @param {Grid.view.Grid} params.event.source The grid instance.
1528
+ * @param {Grid.column.Column} params.event.column The dragged column.
1529
+ * @param {Grid.column.Column} params.event.insertBefore The column before which the dragged column will be inserted.
1530
+ * @param {Grid.column.Column} params.event.newParent The new parent column.
1531
+ * @param {boolean} params.event.valid `true` if the operation was not vetoed.
1532
+ * @param {Event} params.event.event The browser event.
1533
+ * @param {string} params.event.region The region where the column was dropped.
1715
1534
  */
1716
- (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
1535
+ (e: 'columnDrop', params: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void)|string): boolean|void
1717
1536
  /**
1718
1537
  * This event is fired after a resize gesture is completed.
1719
1538
  * @param {string} e Event name
1720
1539
  * @param {object} params Event parameters
1721
- * @param {string} params.e Event name
1722
- * @param {object} params.params Event parameters
1723
- * @param {object} params.params.event Event object
1724
- * @param {Grid.view.Grid} params.params.event.source The grid instance
1725
- * @param {Grid.column.Column} params.params.event.column The resized column
1726
- * @param {Event} params.params.event.domEvent The browser event
1540
+ * @param {object} params.event Event object
1541
+ * @param {Grid.view.Grid} params.event.source The grid instance
1542
+ * @param {Grid.column.Column} params.event.column The resized column
1543
+ * @param {Event} params.event.domEvent The browser event
1727
1544
  */
1728
1545
  (e: 'columnResize', params: ((event: { source: Grid, column: Column, domEvent: Event }) => void)|string): void
1729
1546
  /**
1730
1547
  * This event is fired when a column resize gesture starts.
1731
1548
  * @param {string} e Event name
1732
1549
  * @param {object} params Event parameters
1733
- * @param {string} params.e Event name
1734
- * @param {object} params.params Event parameters
1735
- * @param {object} params.params.event Event object
1736
- * @param {Grid.view.Grid} params.params.event.source The grid instance
1737
- * @param {Grid.column.Column} params.params.event.column The column
1738
- * @param {Event} params.params.event.domEvent The browser event
1550
+ * @param {object} params.event Event object
1551
+ * @param {Grid.view.Grid} params.event.source The grid instance
1552
+ * @param {Grid.column.Column} params.event.column The column
1553
+ * @param {Event} params.event.domEvent The browser event
1739
1554
  */
1740
1555
  (e: 'columnResizeStart', params: ((event: { source: Grid, column: Column, domEvent: Event }) => void)|string): void
1741
1556
  /**
1742
1557
  * Fires when the user chooses to compare a selected version.
1743
1558
  * @param {string} e Event name
1744
1559
  * @param {object} params Event parameters
1745
- * @param {string} params.e Event name
1746
- * @param {object} params.params Event parameters
1747
- * @param {object} params.params.event Event object
1748
- * @param {SchedulerPro.model.VersionModel} params.params.event.version The [VersionModel](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/VersionModel) being restored
1560
+ * @param {object} params.event Event object
1561
+ * @param {SchedulerPro.model.VersionModel} params.event.version The [VersionModel](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/VersionModel) being restored
1749
1562
  */
1750
1563
  (e: 'compare', params: ((event: { version: VersionModel }) => void)|string): void
1751
1564
  /**
1752
1565
  * This event fires on the owning widget when an item is selected in the context menu.
1753
1566
  * @param {string} e Event name
1754
1567
  * @param {object} params Event parameters
1755
- * @param {string} params.e Event name
1756
- * @param {object} params.params Event parameters
1757
- * @param {object} params.params.event Event object
1758
- * @param {Core.widget.Widget} params.params.event.source The owning widget
1759
- * @param {Core.widget.Menu} params.params.event.menu The menu
1760
- * @param {Core.widget.MenuItem} params.params.event.item Selected menu item
1568
+ * @param {object} params.event Event object
1569
+ * @param {Core.widget.Widget} params.event.source The owning widget
1570
+ * @param {Core.widget.Menu} params.event.menu The menu
1571
+ * @param {Core.widget.MenuItem} params.event.item Selected menu item
1761
1572
  */
1762
1573
  (e: 'contextMenuItem', params: ((event: { source: Widget, menu: Menu, item: MenuItem }) => void)|string): void
1763
1574
  /**
1764
1575
  * This event fires on the owning widget when a check item is toggled in the context menu.
1765
1576
  * @param {string} e Event name
1766
1577
  * @param {object} params Event parameters
1767
- * @param {string} params.e Event name
1768
- * @param {object} params.params Event parameters
1769
- * @param {object} params.params.event Event object
1770
- * @param {Core.widget.Widget} params.params.event.source The owning widget
1771
- * @param {Core.widget.Menu} params.params.event.menu The menu
1772
- * @param {Core.widget.MenuItem} params.params.event.item Selected menu item
1773
- * @param {boolean} params.params.event.checked Checked or not
1578
+ * @param {object} params.event Event object
1579
+ * @param {Core.widget.Widget} params.event.source The owning widget
1580
+ * @param {Core.widget.Menu} params.event.menu The menu
1581
+ * @param {Core.widget.MenuItem} params.event.item Selected menu item
1582
+ * @param {boolean} params.event.checked Checked or not
1774
1583
  */
1775
1584
  (e: 'contextMenuToggleItem', params: ((event: { source: Widget, menu: Menu, item: MenuItem, checked: boolean }) => void)|string): void
1776
1585
  /**
1777
1586
  * Fires on the owning Grid after a copy action is performed.
1778
1587
  * @param {string} e Event name
1779
1588
  * @param {object} params Event parameters
1780
- * @param {string} params.e Event name
1781
- * @param {object} params.params Event parameters
1782
- * @param {object} params.params.event Event object
1783
- * @param {Grid.view.Grid} params.params.event.source Owner grid
1784
- * @param {Grid.util.GridLocation[]} params.params.event.cells The cells about to be copied or cut
1785
- * @param {string} params.params.event.copiedDataString The concatenated data string that was copied or cut
1786
- * @param {boolean} params.params.event.isCut `true` if this was a cut action
1787
- * @param {string} params.params.event.entityName 'cell' to distinguish this event from other copy events
1589
+ * @param {object} params.event Event object
1590
+ * @param {Grid.view.Grid} params.event.source Owner grid
1591
+ * @param {Grid.util.GridLocation[]} params.event.cells The cells about to be copied or cut
1592
+ * @param {string} params.event.copiedDataString The concatenated data string that was copied or cut
1593
+ * @param {boolean} params.event.isCut `true` if this was a cut action
1594
+ * @param {string} params.event.entityName 'cell' to distinguish this event from other copy events
1788
1595
  */
1789
1596
  (e: 'copy', params: ((event: { source: Grid, cells: GridLocation[], copiedDataString: string, isCut: boolean, entityName: string }) => void)|string): void
1790
1597
  /**
1791
1598
  * Fired when data in the store changes.
1792
- * ...
1793
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#event-dataChange)
1599
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#event-dataChange)
1794
1600
  * @param {string} e Event name
1795
1601
  * @param {object} params Event parameters
1796
- * @param {string} params.e Event name
1797
- * @param {object} params.params Event parameters
1798
- * @param {object} params.params.event Event object
1799
- * @param {Grid.view.GridBase} params.params.event.source Owning grid
1800
- * @param {Core.data.Store} params.params.event.store The originating store
1801
- * @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'`
1802
- * @param {Core.data.Model} params.params.event.record Changed record, for actions that affects exactly one record (`'update'`)
1803
- * @param {Core.data.Model[]} params.params.event.records Changed records, passed for all actions except `'removeAll'`
1804
- * @param {object} params.params.event.changes Passed for the `'update'` action, info on which record fields changed
1602
+ * @param {object} params.event Event object
1603
+ * @param {Grid.view.GridBase} params.event.source Owning grid
1604
+ * @param {Core.data.Store} params.event.store The originating store
1605
+ * @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} params.event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
1606
+ * @param {Core.data.Model} params.event.record Changed record, for actions that affects exactly one record (`'update'`)
1607
+ * @param {Core.data.Model[]} params.event.records Changed records, passed for all actions except `'removeAll'`
1608
+ * @param {object} params.event.changes Passed for the `'update'` action, info on which record fields changed
1805
1609
  */
1806
1610
  (e: 'dataChange', params: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string): void
1807
1611
  /**
1808
1612
  * Fires when an object is destroyed.
1809
1613
  * @param {string} e Event name
1810
1614
  * @param {object} params Event parameters
1811
- * @param {string} params.e Event name
1812
- * @param {object} params.params Event parameters
1813
- * @param {object} params.params.event Event object
1814
- * @param {Core.Base} params.params.event.source The Object that is being destroyed.
1615
+ * @param {object} params.event Event object
1616
+ * @param {Core.Base} params.event.source The Object that is being destroyed.
1815
1617
  */
1816
1618
  (e: 'destroy', params: ((event: { source: Base }) => void)|string): void
1817
1619
  /**
1818
1620
  * 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
1819
1621
  * @param {string} e Event name
1820
1622
  * @param {object} params Event parameters
1821
- * @param {string} params.e Event name
1822
- * @param {object} params.params Event parameters
1823
- * @param {object} params.params.event Event object
1824
- * @param {Core.widget.Container} params.params.event.source The container.
1825
- * @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.
1623
+ * @param {object} params.event Event object
1624
+ * @param {Core.widget.Container} params.event.source The container.
1625
+ * @param {boolean} params.event.dirty The dirty state of the Container - `true` if there are any fields which have been changed since initial load.
1826
1626
  */
1827
1627
  (e: 'dirtyStateChange', params: ((event: { source: Container, dirty: boolean }) => void)|string): void
1828
1628
  /**
@@ -1830,55 +1630,45 @@ const emit = defineEmits<{
1830
1630
  * mouse up. This event can be listened for to perform actions while drag selecting.
1831
1631
  * @param {string} e Event name
1832
1632
  * @param {object} params Event parameters
1833
- * @param {string} params.e Event name
1834
- * @param {object} params.params Event parameters
1835
- * @param {object} params.params.event Event object
1836
- * @param {Grid.view.Grid} params.params.event.source
1837
- * @param {GridLocationConfig[],Grid.util.GridLocation[]} params.params.event.selectedCells The cells that is currently being dragged over
1838
- * @param {Core.data.Model[]} params.params.event.selectedRecords The records that is currently being dragged over
1633
+ * @param {object} params.event Event object
1634
+ * @param {Grid.view.Grid} params.event.source
1635
+ * @param {GridLocationConfig[],Grid.util.GridLocation[]} params.event.selectedCells The cells that is currently being dragged over
1636
+ * @param {Core.data.Model[]} params.event.selectedRecords The records that is currently being dragged over
1839
1637
  */
1840
1638
  (e: 'dragSelecting', params: ((event: { source: Grid, selectedCells: GridLocationConfig[]|GridLocation[], selectedRecords: Model[] }) => void)|string): void
1841
1639
  /**
1842
1640
  * Triggered when a widget's [element](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#property-element) is available.
1843
1641
  * @param {string} e Event name
1844
1642
  * @param {object} params Event parameters
1845
- * @param {string} params.e Event name
1846
- * @param {object} params.params Event parameters
1847
- * @param {object} params.params.event Event object
1848
- * @param {HTMLElement} params.params.event.element The Widget's element.
1643
+ * @param {object} params.event Event object
1644
+ * @param {HTMLElement} params.event.element The Widget's element.
1849
1645
  */
1850
1646
  (e: 'elementCreated', params: ((event: { element: HTMLElement }) => void)|string): void
1851
1647
  /**
1852
1648
  * Fires when a Panel is expanded using the [collapsible](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Panel#config-collapsible) setting.
1853
1649
  * @param {string} e Event name
1854
1650
  * @param {object} params Event parameters
1855
- * @param {string} params.e Event name
1856
- * @param {object} params.params Event parameters
1857
- * @param {object} params.params.event Event object
1858
- * @param {Core.widget.Panel} params.params.event.source This Panel.
1651
+ * @param {object} params.event Event object
1652
+ * @param {Core.widget.Panel} params.event.source This Panel.
1859
1653
  */
1860
1654
  (e: 'expand', params: ((event: { source: Panel }) => void)|string): void
1861
1655
  /**
1862
1656
  * Fired after a parent node record is expanded.
1863
1657
  * @param {string} e Event name
1864
1658
  * @param {object} params Event parameters
1865
- * @param {string} params.e Event name
1866
- * @param {object} params.params Event parameters
1867
- * @param {object} params.params.event Event object
1868
- * @param {Grid.view.Grid} params.params.event.source The firing Grid instance.
1869
- * @param {Core.data.Model} params.params.event.record The record which has been expanded.
1659
+ * @param {object} params.event Event object
1660
+ * @param {Grid.view.Grid} params.event.source The firing Grid instance.
1661
+ * @param {Core.data.Model} params.event.record The record which has been expanded.
1870
1662
  */
1871
1663
  (e: 'expandNode', params: ((event: { source: Grid, record: Model }) => void)|string): void
1872
1664
  /**
1873
1665
  * Fired when a file is dropped on the widget element
1874
1666
  * @param {string} e Event name
1875
1667
  * @param {object} params Event parameters
1876
- * @param {string} params.e Event name
1877
- * @param {object} params.params Event parameters
1878
- * @param {object} params.params.event Event object
1879
- * @param {Grid.view.Grid} params.params.event.source The owning Grid instance
1880
- * @param {DataTransferItem} params.params.event.file The dropped file descriptor
1881
- * @param {DragEvent} params.params.event.domEvent The native DragEvent
1668
+ * @param {object} params.event Event object
1669
+ * @param {Grid.view.Grid} params.event.source The owning Grid instance
1670
+ * @param {DataTransferItem} params.event.file The dropped file descriptor
1671
+ * @param {DragEvent} params.event.domEvent The native DragEvent
1882
1672
  */
1883
1673
  (e: 'fileDrop', params: ((event: { source: Grid, file: DataTransferItem, domEvent: DragEvent }) => void)|string): void
1884
1674
  /**
@@ -1886,24 +1676,20 @@ const emit = defineEmits<{
1886
1676
  * drag operation from applying data changes.
1887
1677
  * @param {string} e Event name
1888
1678
  * @param {object} params Event parameters
1889
- * @param {string} params.e Event name
1890
- * @param {object} params.params Event parameters
1891
- * @param {object} params.params.event Event object
1892
- * @param {Grid.util.GridLocation} params.params.event.from The from cell
1893
- * @param {Grid.util.GridLocation} params.params.event.to The to cell
1894
- * @param {MouseEvent} params.params.event.domEvent The raw DOM event
1679
+ * @param {object} params.event Event object
1680
+ * @param {Grid.util.GridLocation} params.event.from The from cell
1681
+ * @param {Grid.util.GridLocation} params.event.to The to cell
1682
+ * @param {MouseEvent} params.event.domEvent The raw DOM event
1895
1683
  */
1896
1684
  (e: 'fillHandleBeforeDragFinalize', params: ((event: { from: GridLocation, to: GridLocation, domEvent: MouseEvent }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1897
1685
  /**
1898
1686
  * Fired while dragging the FillHandle.
1899
1687
  * @param {string} e Event name
1900
1688
  * @param {object} params Event parameters
1901
- * @param {string} params.e Event name
1902
- * @param {object} params.params Event parameters
1903
- * @param {object} params.params.event Event object
1904
- * @param {Grid.util.GridLocation} params.params.event.from The from cell
1905
- * @param {Grid.util.GridLocation} params.params.event.to The to cell
1906
- * @param {MouseEvent} params.params.event.domEvent The raw DOM event
1689
+ * @param {object} params.event Event object
1690
+ * @param {Grid.util.GridLocation} params.event.from The from cell
1691
+ * @param {Grid.util.GridLocation} params.event.to The to cell
1692
+ * @param {MouseEvent} params.event.domEvent The raw DOM event
1907
1693
  */
1908
1694
  (e: 'fillHandleDrag', params: ((event: { from: GridLocation, to: GridLocation, domEvent: MouseEvent }) => void)|string): void
1909
1695
  /**
@@ -1914,62 +1700,51 @@ const emit = defineEmits<{
1914
1700
  * Fired after a FillHandle drag operation.
1915
1701
  * @param {string} e Event name
1916
1702
  * @param {object} params Event parameters
1917
- * @param {string} params.e Event name
1918
- * @param {object} params.params Event parameters
1919
- * @param {object} params.params.event Event object
1920
- * @param {Grid.util.GridLocation} params.params.event.from The from cell
1921
- * @param {Grid.util.GridLocation} params.params.event.to The to cell
1922
- * @param {MouseEvent} params.params.event.domEvent The raw DOM event
1703
+ * @param {object} params.event Event object
1704
+ * @param {Grid.util.GridLocation} params.event.from The from cell
1705
+ * @param {Grid.util.GridLocation} params.event.to The to cell
1706
+ * @param {MouseEvent} params.event.domEvent The raw DOM event
1923
1707
  */
1924
1708
  (e: 'fillHandleDragEnd', params: ((event: { from: GridLocation, to: GridLocation, domEvent: MouseEvent }) => void)|string): void
1925
1709
  /**
1926
1710
  * Fired when dragging of the FillHandle starts.
1927
1711
  * @param {string} e Event name
1928
1712
  * @param {object} params Event parameters
1929
- * @param {string} params.e Event name
1930
- * @param {object} params.params Event parameters
1931
- * @param {object} params.params.event Event object
1932
- * @param {Grid.util.GridLocation} params.params.event.cell Information about the column / record
1933
- * @param {MouseEvent} params.params.event.domEvent The raw DOM event
1713
+ * @param {object} params.event Event object
1714
+ * @param {Grid.util.GridLocation} params.event.cell Information about the column / record
1715
+ * @param {MouseEvent} params.event.domEvent The raw DOM event
1934
1716
  */
1935
- (e: 'fillHandleDragStart', params: ((event: { cell: GridLocation, domEvent: MouseEvent }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1717
+ (e: 'fillHandleDragStart', params: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string): boolean|void
1936
1718
  /**
1937
1719
  * Fires on the owning Grid when cell editing is finished
1938
1720
  * @param {string} e Event name
1939
1721
  * @param {object} params Event parameters
1940
- * @param {string} params.e Event name
1941
- * @param {object} params.params Event parameters
1942
- * @param {object} params.params.event Event object
1943
- * @param {Grid.view.Grid} params.params.event.grid Target grid
1944
- * @param {CellEditorContext} params.params.event.editorContext Editing context
1722
+ * @param {object} params.event Event object
1723
+ * @param {Grid.view.Grid} params.event.grid Target grid
1724
+ * @param {CellEditorContext} params.event.editorContext Editing context
1945
1725
  */
1946
1726
  (e: 'finishCellEdit', params: ((event: { grid: Grid, editorContext: CellEditorContext }) => void)|string): void
1947
1727
  /**
1948
1728
  * 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.
1949
- * ...
1950
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#event-finishRowEdit)
1729
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#event-finishRowEdit)
1951
1730
  * @param {string} e Event name
1952
1731
  * @param {object} params Event parameters
1953
- * @param {string} params.e Event name
1954
- * @param {object} params.params Event parameters
1955
- * @param {object} params.params.event Event object
1956
- * @param {Grid.view.Grid} params.params.event.grid Target grid
1957
- * @param {RowEditorContext} params.params.event.editorContext Editing context
1732
+ * @param {object} params.event Event object
1733
+ * @param {Grid.view.Grid} params.event.grid Target grid
1734
+ * @param {RowEditorContext} params.event.editorContext Editing context
1958
1735
  */
1959
1736
  (e: 'finishRowEdit', params: ((event: { grid: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1960
1737
  /**
1961
1738
  * Fired when focus enters this Widget.
1962
1739
  * @param {string} e Event name
1963
1740
  * @param {object} params Event parameters
1964
- * @param {string} params.e Event name
1965
- * @param {object} params.params Event parameters
1966
- * @param {object} params.params.event Event object
1967
- * @param {Core.widget.Widget} params.params.event.source This Widget
1968
- * @param {HTMLElement} params.params.event.fromElement The element which lost focus.
1969
- * @param {HTMLElement} params.params.event.toElement The element which gained focus.
1970
- * @param {Core.widget.Widget} params.params.event.fromWidget The widget which lost focus.
1971
- * @param {Core.widget.Widget} params.params.event.toWidget The widget which gained focus.
1972
- * @param {boolean} params.params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
1741
+ * @param {object} params.event Event object
1742
+ * @param {Core.widget.Widget} params.event.source This Widget
1743
+ * @param {HTMLElement} params.event.fromElement The element which lost focus.
1744
+ * @param {HTMLElement} params.event.toElement The element which gained focus.
1745
+ * @param {Core.widget.Widget} params.event.fromWidget The widget which lost focus.
1746
+ * @param {Core.widget.Widget} params.event.toWidget The widget which gained focus.
1747
+ * @param {boolean} params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
1973
1748
  */
1974
1749
  (e: 'focusIn', params: ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string): void
1975
1750
  /**
@@ -1978,46 +1753,40 @@ const emit = defineEmits<{
1978
1753
  * will not trigger this event. This is when focus exits this widget completely.
1979
1754
  * @param {string} e Event name
1980
1755
  * @param {object} params Event parameters
1981
- * @param {string} params.e Event name
1982
- * @param {object} params.params Event parameters
1983
- * @param {object} params.params.event Event object
1984
- * @param {Core.widget.Widget} params.params.event.source This Widget
1985
- * @param {HTMLElement} params.params.event.fromElement The element which lost focus.
1986
- * @param {HTMLElement} params.params.event.toElement The element which gained focus.
1987
- * @param {Core.widget.Widget} params.params.event.fromWidget The widget which lost focus.
1988
- * @param {Core.widget.Widget} params.params.event.toWidget The widget which gained focus.
1989
- * @param {boolean} params.params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
1756
+ * @param {object} params.event Event object
1757
+ * @param {Core.widget.Widget} params.event.source This Widget
1758
+ * @param {HTMLElement} params.event.fromElement The element which lost focus.
1759
+ * @param {HTMLElement} params.event.toElement The element which gained focus.
1760
+ * @param {Core.widget.Widget} params.event.fromWidget The widget which lost focus.
1761
+ * @param {Core.widget.Widget} params.event.toWidget The widget which gained focus.
1762
+ * @param {boolean} params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
1990
1763
  */
1991
1764
  (e: 'focusOut', params: ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string): void
1992
1765
  /**
1993
1766
  * Fired before dragging starts, return false to prevent the drag operation.
1994
1767
  * @param {string} e Event name
1995
1768
  * @param {object} params Event parameters
1996
- * @param {string} params.e Event name
1997
- * @param {object} params.params Event parameters
1998
- * @param {object} params.params.event Event object
1999
- * @param {Grid.view.GridBase} params.params.event.source
2000
- * @param {object} params.params.event.context
2001
- * @param {Core.data.Model[]} params.params.event.context.records The dragged row records
2002
- * @param {MouseEvent,TouchEvent} params.params.event.event
1769
+ * @param {object} params.event Event object
1770
+ * @param {Grid.view.GridBase} params.event.source
1771
+ * @param {object} params.event.context
1772
+ * @param {Core.data.Model[]} params.event.context.records The dragged row records
1773
+ * @param {MouseEvent,TouchEvent} params.event.event
2003
1774
  */
2004
- (e: 'gridRowBeforeDragStart', params: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1775
+ (e: 'gridRowBeforeDragStart', params: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void)|string): boolean|void
2005
1776
  /**
2006
1777
  * Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
2007
1778
  * Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
2008
1779
  * @param {string} e Event name
2009
1780
  * @param {object} params Event parameters
2010
- * @param {string} params.e Event name
2011
- * @param {object} params.params Event parameters
2012
- * @param {object} params.params.event Event object
2013
- * @param {Grid.view.GridBase} params.params.event.source
2014
- * @param {object} params.params.event.context
2015
- * @param {boolean} params.params.event.context.valid Set this to true or false to indicate whether the drop position is valid
2016
- * @param {Core.data.Model} params.params.event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
2017
- * @param {Core.data.Model} params.params.event.context.parent The parent record of the current drop position (only applicable for trees)
2018
- * @param {Core.data.Model[]} params.params.event.context.records The dragged row records
2019
- * @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
2020
- * @param {MouseEvent} params.params.event.event
1781
+ * @param {object} params.event Event object
1782
+ * @param {Grid.view.GridBase} params.event.source
1783
+ * @param {object} params.event.context
1784
+ * @param {boolean} params.event.context.valid Set this to true or false to indicate whether the drop position is valid
1785
+ * @param {Core.data.Model} params.event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
1786
+ * @param {Core.data.Model} params.event.context.parent The parent record of the current drop position (only applicable for trees)
1787
+ * @param {Core.data.Model[]} params.event.context.records The dragged row records
1788
+ * @param {RecordPositionContext[]} 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
1789
+ * @param {MouseEvent} params.event.event
2021
1790
  */
2022
1791
  (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
2023
1792
  /**
@@ -2026,217 +1795,180 @@ const emit = defineEmits<{
2026
1795
  * valid or invalid by setting `context.valid = false;`
2027
1796
  * @param {string} e Event name
2028
1797
  * @param {object} params Event parameters
2029
- * @param {string} params.e Event name
2030
- * @param {object} params.params Event parameters
2031
- * @param {object} params.params.event Event object
2032
- * @param {Grid.view.GridBase} params.params.event.source
2033
- * @param {object} params.params.event.context
2034
- * @param {boolean} params.params.event.context.valid Set this to true or false to indicate whether the drop position is valid.
2035
- * @param {Core.data.Model} params.params.event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
2036
- * @param {Core.data.Model} params.params.event.context.parent The parent record of the current drop position (only applicable for trees)
2037
- * @param {Core.data.Model[]} params.params.event.context.records The dragged row records
2038
- * @param {MouseEvent} params.params.event.event
1798
+ * @param {object} params.event Event object
1799
+ * @param {Grid.view.GridBase} params.event.source
1800
+ * @param {object} params.event.context
1801
+ * @param {boolean} params.event.context.valid Set this to true or false to indicate whether the drop position is valid.
1802
+ * @param {Core.data.Model} params.event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
1803
+ * @param {Core.data.Model} params.event.context.parent The parent record of the current drop position (only applicable for trees)
1804
+ * @param {Core.data.Model[]} params.event.context.records The dragged row records
1805
+ * @param {MouseEvent} params.event.event
2039
1806
  */
2040
1807
  (e: 'gridRowDrag', params: ((event: { source: GridBase, context: { valid: boolean, insertBefore: Model, parent: Model, records: Model[] }, event: MouseEvent }) => void)|string): void
2041
1808
  /**
2042
1809
  * Fired when a row drag operation is aborted
2043
1810
  * @param {string} e Event name
2044
1811
  * @param {object} params Event parameters
2045
- * @param {string} params.e Event name
2046
- * @param {object} params.params Event parameters
2047
- * @param {object} params.params.event Event object
2048
- * @param {Grid.view.GridBase} params.params.event.source
2049
- * @param {object} params.params.event.context
2050
- * @param {Core.data.Model[]} params.params.event.context.records The dragged row records
2051
- * @param {MouseEvent} params.params.event.event
1812
+ * @param {object} params.event Event object
1813
+ * @param {Grid.view.GridBase} params.event.source
1814
+ * @param {object} params.event.context
1815
+ * @param {Core.data.Model[]} params.event.context.records The dragged row records
1816
+ * @param {MouseEvent} params.event.event
2052
1817
  */
2053
1818
  (e: 'gridRowDragAbort', params: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent }) => void)|string): void
2054
1819
  /**
2055
1820
  * Fired when dragging starts.
2056
1821
  * @param {string} e Event name
2057
1822
  * @param {object} params Event parameters
2058
- * @param {string} params.e Event name
2059
- * @param {object} params.params Event parameters
2060
- * @param {object} params.params.event Event object
2061
- * @param {Grid.view.GridBase} params.params.event.source
2062
- * @param {object} params.params.event.context
2063
- * @param {Core.data.Model[]} params.params.event.context.records The dragged row records
2064
- * @param {MouseEvent,TouchEvent} params.params.event.event
1823
+ * @param {object} params.event Event object
1824
+ * @param {Grid.view.GridBase} params.event.source
1825
+ * @param {object} params.event.context
1826
+ * @param {Core.data.Model[]} params.event.context.records The dragged row records
1827
+ * @param {MouseEvent,TouchEvent} params.event.event
2065
1828
  */
2066
1829
  (e: 'gridRowDragStart', params: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => void)|string): void
2067
1830
  /**
2068
1831
  * Fired after the row drop operation has completed, regardless of validity
2069
1832
  * @param {string} e Event name
2070
1833
  * @param {object} params Event parameters
2071
- * @param {string} params.e Event name
2072
- * @param {object} params.params Event parameters
2073
- * @param {object} params.params.event Event object
2074
- * @param {Grid.view.GridBase} params.params.event.source
2075
- * @param {object} params.params.event.context
2076
- * @param {boolean} params.params.event.context.valid true or false depending on whether the drop position was valid
2077
- * @param {Core.data.Model} params.params.event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
2078
- * @param {Core.data.Model} params.params.event.context.parent The parent record of the current drop position (only applicable for trees)
2079
- * @param {Core.data.Model[]} params.params.event.context.records The dragged row records
2080
- * @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
2081
- * @param {MouseEvent} params.params.event.event
1834
+ * @param {object} params.event Event object
1835
+ * @param {Grid.view.GridBase} params.event.source
1836
+ * @param {object} params.event.context
1837
+ * @param {boolean} params.event.context.valid true or false depending on whether the drop position was valid
1838
+ * @param {Core.data.Model} params.event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
1839
+ * @param {Core.data.Model} params.event.context.parent The parent record of the current drop position (only applicable for trees)
1840
+ * @param {Core.data.Model[]} params.event.context.records The dragged row records
1841
+ * @param {RecordPositionContext[]} 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
1842
+ * @param {MouseEvent} params.event.event
2082
1843
  */
2083
1844
  (e: 'gridRowDrop', params: ((event: { source: GridBase, context: { valid: boolean, insertBefore: Model, parent: Model, records: Model[], oldPositionContext: RecordPositionContext[] }, event: MouseEvent }) => void)|string): void
2084
1845
  /**
2085
1846
  * Fired when a grid header is clicked on.
2086
- * ...
2087
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#event-headerClick)
1847
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#event-headerClick)
2088
1848
  * @param {string} e Event name
2089
1849
  * @param {object} params Event parameters
2090
- * @param {string} params.e Event name
2091
- * @param {object} params.params Event parameters
2092
- * @param {object} params.params.event Event object
2093
- * @param {Event} params.params.event.domEvent The triggering DOM event.
2094
- * @param {Grid.column.Column} params.params.event.column The column clicked on.
1850
+ * @param {object} params.event Event object
1851
+ * @param {Event} params.event.domEvent The triggering DOM event.
1852
+ * @param {Grid.column.Column} params.event.column The column clicked on.
2095
1853
  */
2096
- (e: 'headerClick', params: ((event: { domEvent: Event, column: Column }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1854
+ (e: 'headerClick', params: ((event: { domEvent: Event, column: Column }) => boolean|void)|string): boolean|void
2097
1855
  /**
2098
1856
  * This event fires on the owning Grid before the context menu is shown for a header.
2099
1857
  * 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).
2100
- * ...
2101
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#event-headerMenuBeforeShow)
1858
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#event-headerMenuBeforeShow)
2102
1859
  * @param {string} e Event name
2103
1860
  * @param {object} params Event parameters
2104
- * @param {string} params.e Event name
2105
- * @param {object} params.params Event parameters
2106
- * @param {object} params.params.event Event object
2107
- * @param {Grid.view.Grid} params.params.event.source The grid
2108
- * @param {Core.widget.Menu} params.params.event.menu The menu
2109
- * @param {Record<string, MenuItemEntry>} params.params.event.items Menu item configs
2110
- * @param {Grid.column.Column} params.params.event.column Column
1861
+ * @param {object} params.event Event object
1862
+ * @param {Grid.view.Grid} params.event.source The grid
1863
+ * @param {Core.widget.Menu} params.event.menu The menu
1864
+ * @param {Record<string, MenuItemEntry>} params.event.items Menu item configs
1865
+ * @param {Grid.column.Column} params.event.column Column
2111
1866
  */
2112
- (e: 'headerMenuBeforeShow', params: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1867
+ (e: 'headerMenuBeforeShow', params: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void)|string): boolean|void
2113
1868
  /**
2114
1869
  * This event fires on the owning Grid when an item is selected in the header context menu.
2115
1870
  * @param {string} e Event name
2116
1871
  * @param {object} params Event parameters
2117
- * @param {string} params.e Event name
2118
- * @param {object} params.params Event parameters
2119
- * @param {object} params.params.event Event object
2120
- * @param {Grid.view.Grid} params.params.event.source The grid
2121
- * @param {Core.widget.Menu} params.params.event.menu The menu
2122
- * @param {Core.widget.MenuItem} params.params.event.item Selected menu item
2123
- * @param {Grid.column.Column} params.params.event.column Column
1872
+ * @param {object} params.event Event object
1873
+ * @param {Grid.view.Grid} params.event.source The grid
1874
+ * @param {Core.widget.Menu} params.event.menu The menu
1875
+ * @param {Core.widget.MenuItem} params.event.item Selected menu item
1876
+ * @param {Grid.column.Column} params.event.column Column
2124
1877
  */
2125
1878
  (e: 'headerMenuItem', params: ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column }) => void)|string): void
2126
1879
  /**
2127
1880
  * This event fires on the owning Grid after the context menu is shown for a header
2128
1881
  * @param {string} e Event name
2129
1882
  * @param {object} params Event parameters
2130
- * @param {string} params.e Event name
2131
- * @param {object} params.params Event parameters
2132
- * @param {object} params.params.event Event object
2133
- * @param {Grid.view.Grid} params.params.event.source The grid
2134
- * @param {Core.widget.Menu} params.params.event.menu The menu
2135
- * @param {Record<string, MenuItemEntry>} params.params.event.items Menu item configs
2136
- * @param {Grid.column.Column} params.params.event.column Column
1883
+ * @param {object} params.event Event object
1884
+ * @param {Grid.view.Grid} params.event.source The grid
1885
+ * @param {Core.widget.Menu} params.event.menu The menu
1886
+ * @param {Record<string, MenuItemEntry>} params.event.items Menu item configs
1887
+ * @param {Grid.column.Column} params.event.column Column
2137
1888
  */
2138
1889
  (e: 'headerMenuShow', params: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => void)|string): void
2139
1890
  /**
2140
1891
  * This event fires on the owning Grid when a check item is toggled in the header context menu.
2141
1892
  * @param {string} e Event name
2142
1893
  * @param {object} params Event parameters
2143
- * @param {string} params.e Event name
2144
- * @param {object} params.params Event parameters
2145
- * @param {object} params.params.event Event object
2146
- * @param {Grid.view.Grid} params.params.event.source The grid
2147
- * @param {Core.widget.Menu} params.params.event.menu The menu
2148
- * @param {Core.widget.MenuItem} params.params.event.item Selected menu item
2149
- * @param {Grid.column.Column} params.params.event.column Column
2150
- * @param {boolean} params.params.event.checked Checked or not
1894
+ * @param {object} params.event Event object
1895
+ * @param {Grid.view.Grid} params.event.source The grid
1896
+ * @param {Core.widget.Menu} params.event.menu The menu
1897
+ * @param {Core.widget.MenuItem} params.event.item Selected menu item
1898
+ * @param {Grid.column.Column} params.event.column Column
1899
+ * @param {boolean} params.event.checked Checked or not
2151
1900
  */
2152
1901
  (e: 'headerMenuToggleItem', params: ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column, checked: boolean }) => void)|string): void
2153
1902
  /**
2154
1903
  * Triggered after a widget was hidden
2155
1904
  * @param {string} e Event name
2156
1905
  * @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 {Core.widget.Widget} params.params.event.source The widget
1906
+ * @param {object} params.event Event object
1907
+ * @param {Core.widget.Widget} params.event.source The widget
2161
1908
  */
2162
1909
  (e: 'hide', params: ((event: { source: Widget }) => void)|string): void
2163
1910
  /**
2164
1911
  * Fires when row locking is enabled.
2165
1912
  * @param {string} e Event name
2166
1913
  * @param {object} params Event parameters
2167
- * @param {string} params.e Event name
2168
- * @param {object} params.params Event parameters
2169
- * @param {object} params.params.event Event object
2170
- * @param {Grid.view.GridBase} params.params.event.clone The created clone
1914
+ * @param {object} params.event Event object
1915
+ * @param {Grid.view.GridBase} params.event.clone The created clone
2171
1916
  */
2172
1917
  (e: 'lockRows', params: ((event: { clone: GridBase }) => void)|string): void
2173
1918
  /**
2174
1919
  * Mouse moved out from element in grid
2175
1920
  * @param {string} e Event name
2176
1921
  * @param {object} params Event parameters
2177
- * @param {string} params.e Event name
2178
- * @param {object} params.params Event parameters
2179
- * @param {object} params.params.event Event object
2180
- * @param {MouseEvent} params.params.event.event The native browser event
1922
+ * @param {object} params.event Event object
1923
+ * @param {MouseEvent} params.event.event The native browser event
2181
1924
  */
2182
1925
  (e: 'mouseOut', params: ((event: { event: MouseEvent }) => void)|string): void
2183
1926
  /**
2184
1927
  * Mouse moved in over element in grid
2185
1928
  * @param {string} e Event name
2186
1929
  * @param {object} params Event parameters
2187
- * @param {string} params.e Event name
2188
- * @param {object} params.params Event parameters
2189
- * @param {object} params.params.event Event object
2190
- * @param {MouseEvent} params.params.event.event The native browser event
1930
+ * @param {object} params.event Event object
1931
+ * @param {MouseEvent} params.event.event The native browser event
2191
1932
  */
2192
1933
  (e: 'mouseOver', params: ((event: { event: MouseEvent }) => void)|string): void
2193
1934
  /**
2194
1935
  * Triggered when a widget which had been in a non-visible state for any reason
2195
1936
  * achieves visibility.
2196
- * ...
2197
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#event-paint)
1937
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#event-paint)
2198
1938
  * @param {string} e Event name
2199
1939
  * @param {object} params Event parameters
2200
- * @param {string} params.e Event name
2201
- * @param {object} params.params Event parameters
2202
- * @param {object} params.params.event Event object
2203
- * @param {Core.widget.Widget} params.params.event.source The widget being painted.
2204
- * @param {boolean} params.params.event.firstPaint `true` if this is the first paint.
1940
+ * @param {object} params.event Event object
1941
+ * @param {Core.widget.Widget} params.event.source The widget being painted.
1942
+ * @param {boolean} params.event.firstPaint `true` if this is the first paint.
2205
1943
  */
2206
1944
  (e: 'paint', params: ((event: { source: Widget, firstPaint: boolean }) => void)|string): void
2207
1945
  /**
2208
1946
  * Fires on the owning Grid after a paste action is performed.
2209
1947
  * @param {string} e Event name
2210
1948
  * @param {object} params Event parameters
2211
- * @param {string} params.e Event name
2212
- * @param {object} params.params Event parameters
2213
- * @param {object} params.params.event Event object
2214
- * @param {Grid.view.Grid} params.params.event.source Owner grid
2215
- * @param {string} params.params.event.clipboardData The clipboardData that was pasted
2216
- * @param {Core.data.Model[]} params.params.event.modifiedRecords The records which have been modified due to the paste action
2217
- * @param {Grid.util.GridLocation} params.params.event.targetCell The cell from which the paste will be started
2218
- * @param {string} params.params.event.entityName 'cell' to distinguish this event from other paste events
1949
+ * @param {object} params.event Event object
1950
+ * @param {Grid.view.Grid} params.event.source Owner grid
1951
+ * @param {string} params.event.clipboardData The clipboardData that was pasted
1952
+ * @param {Core.data.Model[]} params.event.modifiedRecords The records which have been modified due to the paste action
1953
+ * @param {Grid.util.GridLocation} params.event.targetCell The cell from which the paste will be started
1954
+ * @param {string} params.event.entityName 'cell' to distinguish this event from other paste events
2219
1955
  */
2220
1956
  (e: 'paste', params: ((event: { source: Grid, clipboardData: string, modifiedRecords: Model[], targetCell: GridLocation, entityName: string }) => void)|string): void
2221
1957
  /**
2222
1958
  * Fires on the owning Grid when export has finished
2223
1959
  * @param {string} e Event name
2224
1960
  * @param {object} params Event parameters
2225
- * @param {string} params.e Event name
2226
- * @param {object} params.params Event parameters
2227
- * @param {object} params.params.event Event object
2228
- * @param {Response} params.params.event.response Optional response, if received
2229
- * @param {Error} params.params.event.error Optional error, if exception occurred
1961
+ * @param {object} params.event Event object
1962
+ * @param {Response} [params.event.response] Optional response, if received
1963
+ * @param {Error} [params.event.error] Optional error, if exception occurred
2230
1964
  */
2231
1965
  (e: 'pdfExport', params: ((event: { response?: Response, error?: Error }) => void)|string): void
2232
1966
  /**
2233
1967
  * Fired when a Widget's read only state is toggled
2234
1968
  * @param {string} e Event name
2235
1969
  * @param {object} params Event parameters
2236
- * @param {string} params.e Event name
2237
- * @param {object} params.params Event parameters
2238
- * @param {object} params.params.event Event object
2239
- * @param {boolean} params.params.event.readOnly Read only or not
1970
+ * @param {object} params.event Event object
1971
+ * @param {boolean} params.event.readOnly Read only or not
2240
1972
  */
2241
1973
  (e: 'readOnly', params: ((event: { readOnly: boolean }) => void)|string): void
2242
1974
  /**
@@ -2248,176 +1980,147 @@ const emit = defineEmits<{
2248
1980
  * Fires after a row is rendered.
2249
1981
  * @param {string} e Event name
2250
1982
  * @param {object} params Event parameters
2251
- * @param {string} params.e Event name
2252
- * @param {object} params.params Event parameters
2253
- * @param {object} params.params.event Event object
2254
- * @param {Grid.view.GridBase} params.params.event.source The firing Grid instance
2255
- * @param {Grid.row.Row} params.params.event.row The row that has been rendered
2256
- * @param {Core.data.Model} params.params.event.record The record for the row
2257
- * @param {number} params.params.event.recordIndex The zero-based index of the record
1983
+ * @param {object} params.event Event object
1984
+ * @param {Grid.view.GridBase} params.event.source The firing Grid instance
1985
+ * @param {Grid.row.Row} params.event.row The row that has been rendered
1986
+ * @param {Core.data.Model} params.event.record The record for the row
1987
+ * @param {number} params.event.recordIndex The zero-based index of the record
2258
1988
  */
2259
1989
  (e: 'renderRow', params: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string): void
2260
1990
  /**
2261
1991
  * Grid rows have been rendered
2262
1992
  * @param {string} e Event name
2263
1993
  * @param {object} params Event parameters
2264
- * @param {string} params.e Event name
2265
- * @param {object} params.params Event parameters
2266
- * @param {object} params.params.event Event object
2267
- * @param {Grid.view.GridBase} params.params.event.source This grid.
1994
+ * @param {object} params.event Event object
1995
+ * @param {Grid.view.GridBase} params.event.source This grid.
2268
1996
  */
2269
1997
  (e: 'renderRows', params: ((event: { source: GridBase }) => void)|string): void
2270
1998
  /**
2271
1999
  * 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`*.
2272
2000
  * @param {string} e Event name
2273
2001
  * @param {object} params Event parameters
2274
- * @param {string} params.e Event name
2275
- * @param {object} params.params Event parameters
2276
- * @param {object} params.params.event Event object
2277
- * @param {Core.widget.Widget} params.params.event.source This Widget
2278
- * @param {number} params.params.event.width The new width
2279
- * @param {number} params.params.event.height The new height
2280
- * @param {number} params.params.event.oldWidth The old width
2281
- * @param {number} params.params.event.oldHeight The old height
2002
+ * @param {object} params.event Event object
2003
+ * @param {Core.widget.Widget} params.event.source This Widget
2004
+ * @param {number} params.event.width The new width
2005
+ * @param {number} params.event.height The new height
2006
+ * @param {number} params.event.oldWidth The old width
2007
+ * @param {number} params.event.oldHeight The old height
2282
2008
  */
2283
2009
  (e: 'resize', params: ((event: { source: Widget, width: number, height: number, oldWidth: number, oldHeight: number }) => void)|string): void
2284
2010
  /**
2285
2011
  * Grid resize lead to a new responsive level being applied
2286
2012
  * @param {string} e Event name
2287
2013
  * @param {object} params Event parameters
2288
- * @param {string} params.e Event name
2289
- * @param {object} params.params Event parameters
2290
- * @param {object} params.params.event Event object
2291
- * @param {Grid.view.Grid} params.params.event.grid Grid that was resized
2292
- * @param {string} params.params.event.level New responsive level (small, large, etc)
2293
- * @param {number} params.params.event.width New width in px
2294
- * @param {string} params.params.event.oldLevel Old responsive level
2295
- * @param {number} params.params.event.oldWidth Old width in px
2014
+ * @param {object} params.event Event object
2015
+ * @param {Grid.view.Grid} params.event.grid Grid that was resized
2016
+ * @param {string} params.event.level New responsive level (small, large, etc)
2017
+ * @param {number} params.event.width New width in px
2018
+ * @param {string} params.event.oldLevel Old responsive level
2019
+ * @param {number} params.event.oldWidth Old width in px
2296
2020
  */
2297
2021
  (e: 'responsive', params: ((event: { grid: Grid, level: string, width: number, oldLevel: string, oldWidth: number }) => void)|string): void
2298
2022
  /**
2299
2023
  * Fires when the user chooses to restore a selected version.
2300
2024
  * @param {string} e Event name
2301
2025
  * @param {object} params Event parameters
2302
- * @param {string} params.e Event name
2303
- * @param {object} params.params Event parameters
2304
- * @param {object} params.params.event Event object
2305
- * @param {SchedulerPro.model.VersionModel} params.params.event.version The [VersionModel](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/VersionModel) being restored
2026
+ * @param {object} params.event Event object
2027
+ * @param {SchedulerPro.model.VersionModel} params.event.version The [VersionModel](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/VersionModel) being restored
2306
2028
  */
2307
2029
  (e: 'restore', params: ((event: { version: VersionModel }) => void)|string): void
2308
2030
  /**
2309
2031
  * This event fires when a row has finished collapsing.
2310
2032
  * @param {string} e Event name
2311
2033
  * @param {object} params Event parameters
2312
- * @param {string} params.e Event name
2313
- * @param {object} params.params Event parameters
2314
- * @param {object} params.params.event Event object
2315
- * @param {Core.data.Model} params.params.event.record Record
2034
+ * @param {object} params.event Event object
2035
+ * @param {Core.data.Model} params.event.record Record
2316
2036
  */
2317
2037
  (e: 'rowCollapse', params: ((event: { record: Model }) => void)|string): void
2318
2038
  /**
2319
2039
  * This event fires when a row expand has finished expanding.
2320
- * ...
2321
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#event-rowExpand)
2040
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#event-rowExpand)
2322
2041
  * @param {string} e Event name
2323
2042
  * @param {object} params Event parameters
2324
- * @param {string} params.e Event name
2325
- * @param {object} params.params Event parameters
2326
- * @param {object} params.params.event Event object
2327
- * @param {Core.data.Model} params.params.event.record Record
2328
- * @param {object} params.params.event.expandedElements An object with the Grid region name as property and the expanded body element as value
2329
- * @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.
2330
- * @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
2043
+ * @param {object} params.event Event object
2044
+ * @param {Core.data.Model} params.event.record Record
2045
+ * @param {object} params.event.expandedElements An object with the Grid region name as property and the expanded body element as value
2046
+ * @param {Core.widget.Widget} 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.
2047
+ * @param {object} 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
2331
2048
  */
2332
2049
  (e: 'rowExpand', params: ((event: { record: Model, expandedElements: object, widget: Widget, widgets: object }) => void)|string): void
2333
2050
  /**
2334
2051
  * Fired when the mouse enters a row
2335
2052
  * @param {string} e Event name
2336
2053
  * @param {object} params Event parameters
2337
- * @param {string} params.e Event name
2338
- * @param {object} params.params Event parameters
2339
- * @param {object} params.params.event Event object
2340
- * @param {Grid.view.Grid} params.params.event.source The grid instance
2341
- * @param {Core.data.Model} params.params.event.record The record representing the hovered row
2342
- * @param {Grid.column.Column} params.params.event.column The column currently hovered
2343
- * @param {HTMLElement} params.params.event.cellElement The cell HTML element
2344
- * @param {MouseEvent} params.params.event.event The native DOM event
2054
+ * @param {object} params.event Event object
2055
+ * @param {Grid.view.Grid} params.event.source The grid instance
2056
+ * @param {Core.data.Model} params.event.record The record representing the hovered row
2057
+ * @param {Grid.column.Column} params.event.column The column currently hovered
2058
+ * @param {HTMLElement} params.event.cellElement The cell HTML element
2059
+ * @param {MouseEvent} params.event.event The native DOM event
2345
2060
  */
2346
2061
  (e: 'rowMouseEnter', params: ((event: { source: Grid, record: Model, column: Column, cellElement: HTMLElement, event: MouseEvent }) => void)|string): void
2347
2062
  /**
2348
2063
  * Fired when the mouse leaves a row
2349
2064
  * @param {string} e Event name
2350
2065
  * @param {object} params Event parameters
2351
- * @param {string} params.e Event name
2352
- * @param {object} params.params Event parameters
2353
- * @param {object} params.params.event Event object
2354
- * @param {Grid.view.Grid} params.params.event.source The grid instance
2355
- * @param {Core.data.Model} params.params.event.record The record representing the row that the mouse left
2356
- * @param {HTMLElement} params.params.event.cellElement The cell HTML element that the mouse left
2357
- * @param {MouseEvent} params.params.event.event The native DOM event
2066
+ * @param {object} params.event Event object
2067
+ * @param {Grid.view.Grid} params.event.source The grid instance
2068
+ * @param {Core.data.Model} params.event.record The record representing the row that the mouse left
2069
+ * @param {HTMLElement} params.event.cellElement The cell HTML element that the mouse left
2070
+ * @param {MouseEvent} params.event.event The native DOM event
2358
2071
  */
2359
2072
  (e: 'rowMouseLeave', params: ((event: { source: Grid, record: Model, cellElement: HTMLElement, event: MouseEvent }) => void)|string): void
2360
2073
  /**
2361
2074
  * Grid has scrolled vertically
2362
2075
  * @param {string} e Event name
2363
2076
  * @param {object} params Event parameters
2364
- * @param {string} params.e Event name
2365
- * @param {object} params.params Event parameters
2366
- * @param {object} params.params.event Event object
2367
- * @param {Grid.view.GridBase} params.params.event.source The firing Grid instance.
2368
- * @param {number} params.params.event.scrollTop The vertical scroll position.
2077
+ * @param {object} params.event Event object
2078
+ * @param {Grid.view.GridBase} params.event.source The firing Grid instance.
2079
+ * @param {number} params.event.scrollTop The vertical scroll position.
2369
2080
  */
2370
2081
  (e: 'scroll', params: ((event: { source: GridBase, scrollTop: number }) => void)|string): void
2371
2082
  /**
2372
2083
  * The selection has been changed.
2373
2084
  * @param {string} e Event name
2374
2085
  * @param {object} params Event parameters
2375
- * @param {string} params.e Event name
2376
- * @param {object} params.params Event parameters
2377
- * @param {object} params.params.event Event object
2378
- * @param {'select','deselect'} params.params.event.action `'select'`/`'deselect'`
2379
- * @param {'row','cell'} params.params.event.mode `'row'`/`'cell'`
2380
- * @param {Grid.view.Grid} params.params.event.source
2381
- * @param {Core.data.Model[]} params.params.event.deselected The records deselected in this operation.
2382
- * @param {Core.data.Model[]} params.params.event.selected The records selected in this operation.
2383
- * @param {Core.data.Model[]} params.params.event.selection The records in the new selection.
2384
- * @param {Grid.util.GridLocation[]} params.params.event.deselectedCells The cells deselected in this operation.
2385
- * @param {Grid.util.GridLocation[]} params.params.event.selectedCells The cells selected in this operation.
2386
- * @param {Grid.util.GridLocation[]} params.params.event.cellSelection The cells in the new selection.
2086
+ * @param {object} params.event Event object
2087
+ * @param {'select','deselect'} params.event.action `'select'`/`'deselect'`
2088
+ * @param {'row','cell'} params.event.mode `'row'`/`'cell'`
2089
+ * @param {Grid.view.Grid} params.event.source
2090
+ * @param {Core.data.Model[]} params.event.deselected The records deselected in this operation.
2091
+ * @param {Core.data.Model[]} params.event.selected The records selected in this operation.
2092
+ * @param {Core.data.Model[]} params.event.selection The records in the new selection.
2093
+ * @param {Grid.util.GridLocation[]} params.event.deselectedCells The cells deselected in this operation.
2094
+ * @param {Grid.util.GridLocation[]} params.event.selectedCells The cells selected in this operation.
2095
+ * @param {Grid.util.GridLocation[]} params.event.cellSelection The cells in the new selection.
2387
2096
  */
2388
2097
  (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
2389
2098
  /**
2390
2099
  * The selectionMode configuration has been changed.
2391
2100
  * @param {string} e Event name
2392
2101
  * @param {object} params Event parameters
2393
- * @param {string} params.e Event name
2394
- * @param {object} params.params Event parameters
2395
- * @param {object} params.params.event Event object
2396
- * @param {object} params.params.event.selectionMode The new [selectionMode](https://bryntum.com/products/schedulerpro/docs/api/Grid/view/mixin/GridSelection#config-selectionMode)
2102
+ * @param {object} params.event Event object
2103
+ * @param {object} params.event.selectionMode The new [selectionMode](https://bryntum.com/products/schedulerpro/docs/api/Grid/view/mixin/GridSelection#config-selectionMode)
2397
2104
  */
2398
2105
  (e: 'selectionModeChange', params: ((event: { selectionMode: object }) => void)|string): void
2399
2106
  /**
2400
2107
  * Triggered after a widget is shown.
2401
2108
  * @param {string} e Event name
2402
2109
  * @param {object} params Event parameters
2403
- * @param {string} params.e Event name
2404
- * @param {object} params.params Event parameters
2405
- * @param {object} params.params.event Event object
2406
- * @param {Core.widget.Widget} params.params.event.source The widget
2110
+ * @param {object} params.event Event object
2111
+ * @param {Core.widget.Widget} params.event.source The widget
2407
2112
  */
2408
2113
  (e: 'show', params: ((event: { source: Widget }) => void)|string): void
2409
2114
  /**
2410
2115
  * Fires when splitting the Grid.
2411
2116
  * @param {string} e Event name
2412
2117
  * @param {object} params Event parameters
2413
- * @param {string} params.e Event name
2414
- * @param {object} params.params Event parameters
2415
- * @param {object} params.params.event Event object
2416
- * @param {Grid.view.GridBase[]} params.params.event.subViews The sub views created by the split
2417
- * @param {object} params.params.event.options The options passed to the split call
2418
- * @param {'horizontal','vertical','both'} params.params.event.options.direction The direction of the split
2419
- * @param {Grid.column.Column} params.params.event.options.atColumn The column to split at
2420
- * @param {Core.data.Model} params.params.event.options.atRecord The record to split at
2118
+ * @param {object} params.event Event object
2119
+ * @param {Grid.view.GridBase[]} params.event.subViews The sub views created by the split
2120
+ * @param {object} params.event.options The options passed to the split call
2121
+ * @param {'horizontal','vertical','both'} params.event.options.direction The direction of the split
2122
+ * @param {Grid.column.Column} params.event.options.atColumn The column to split at
2123
+ * @param {Core.data.Model} params.event.options.atRecord The record to split at
2421
2124
  */
2422
2125
  (e: 'split', params: ((event: { subViews: GridBase[], options: { direction: 'horizontal'|'vertical'|'both', atColumn: Column, atRecord: Model } }) => void)|string): void
2423
2126
  /**
@@ -2425,36 +2128,30 @@ const emit = defineEmits<{
2425
2128
  * if you want to implement your own behavior.
2426
2129
  * @param {string} e Event name
2427
2130
  * @param {object} params Event parameters
2428
- * @param {string} params.e Event name
2429
- * @param {object} params.params Event parameters
2430
- * @param {object} params.params.event Event object
2431
- * @param {Grid.view.Grid} params.params.event.source The Grid instance.
2432
- * @param {Grid.view.SubGrid} params.params.event.subGrid The subgrid
2433
- * @param {Event} params.params.event.domEvent The native DOM event
2131
+ * @param {object} params.event Event object
2132
+ * @param {Grid.view.Grid} params.event.source The Grid instance.
2133
+ * @param {Grid.view.SubGrid} params.event.subGrid The subgrid
2134
+ * @param {Event} params.event.domEvent The native DOM event
2434
2135
  */
2435
- (e: 'splitterCollapseClick', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
2136
+ (e: 'splitterCollapseClick', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string): boolean|void
2436
2137
  /**
2437
2138
  * Fired by the Grid after a sub-grid has been resized using the splitter
2438
2139
  * @param {string} e Event name
2439
2140
  * @param {object} params Event parameters
2440
- * @param {string} params.e Event name
2441
- * @param {object} params.params Event parameters
2442
- * @param {object} params.params.event Event object
2443
- * @param {Grid.view.Grid} params.params.event.source The Grid instance.
2444
- * @param {Grid.view.SubGrid} params.params.event.subGrid The resized subgrid
2445
- * @param {Event} params.params.event.domEvent The native DOM event
2141
+ * @param {object} params.event Event object
2142
+ * @param {Grid.view.Grid} params.event.source The Grid instance.
2143
+ * @param {Grid.view.SubGrid} params.event.subGrid The resized subgrid
2144
+ * @param {Event} params.event.domEvent The native DOM event
2446
2145
  */
2447
2146
  (e: 'splitterDragEnd', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => void)|string): void
2448
2147
  /**
2449
2148
  * Fired by the Grid when a sub-grid resize gesture starts
2450
2149
  * @param {string} e Event name
2451
2150
  * @param {object} params Event parameters
2452
- * @param {string} params.e Event name
2453
- * @param {object} params.params Event parameters
2454
- * @param {object} params.params.event Event object
2455
- * @param {Grid.view.Grid} params.params.event.source The Grid instance.
2456
- * @param {Grid.view.SubGrid} params.params.event.subGrid The subgrid about to be resized
2457
- * @param {Event} params.params.event.domEvent The native DOM event
2151
+ * @param {object} params.event Event object
2152
+ * @param {Grid.view.Grid} params.event.source The Grid instance.
2153
+ * @param {Grid.view.SubGrid} params.event.subGrid The subgrid about to be resized
2154
+ * @param {Event} params.event.domEvent The native DOM event
2458
2155
  */
2459
2156
  (e: 'splitterDragStart', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => void)|string): void
2460
2157
  /**
@@ -2462,34 +2159,28 @@ const emit = defineEmits<{
2462
2159
  * if you want to implement your own behavior.
2463
2160
  * @param {string} e Event name
2464
2161
  * @param {object} params Event parameters
2465
- * @param {string} params.e Event name
2466
- * @param {object} params.params Event parameters
2467
- * @param {object} params.params.event Event object
2468
- * @param {Grid.view.Grid} params.params.event.source The Grid instance.
2469
- * @param {Grid.view.SubGrid} params.params.event.subGrid The subgrid
2470
- * @param {Event} params.params.event.domEvent The native DOM event
2162
+ * @param {object} params.event Event object
2163
+ * @param {Grid.view.Grid} params.event.source The Grid instance.
2164
+ * @param {Grid.view.SubGrid} params.event.subGrid The subgrid
2165
+ * @param {Event} params.event.domEvent The native DOM event
2471
2166
  */
2472
- (e: 'splitterExpandClick', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
2167
+ (e: 'splitterExpandClick', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string): boolean|void
2473
2168
  /**
2474
2169
  * Fires on the owning Grid when editing starts
2475
2170
  * @param {string} e Event name
2476
2171
  * @param {object} params Event parameters
2477
- * @param {string} params.e Event name
2478
- * @param {object} params.params Event parameters
2479
- * @param {object} params.params.event Event object
2480
- * @param {Grid.view.Grid} params.params.event.source Owner grid
2481
- * @param {CellEditorContext} params.params.event.editorContext Editing context
2172
+ * @param {object} params.event Event object
2173
+ * @param {Grid.view.Grid} params.event.source Owner grid
2174
+ * @param {CellEditorContext} params.event.editorContext Editing context
2482
2175
  */
2483
2176
  (e: 'startCellEdit', params: ((event: { source: Grid, editorContext: CellEditorContext }) => void)|string): void
2484
2177
  /**
2485
2178
  * Fires on the owning Grid when editing starts
2486
2179
  * @param {string} e Event name
2487
2180
  * @param {object} params Event parameters
2488
- * @param {string} params.e Event name
2489
- * @param {object} params.params Event parameters
2490
- * @param {object} params.params.event Event object
2491
- * @param {Grid.view.Grid} params.params.event.source Owner grid
2492
- * @param {RowEditorContext} params.params.event.editorContext Editing context
2181
+ * @param {object} params.event Event object
2182
+ * @param {Grid.view.Grid} params.event.source Owner grid
2183
+ * @param {RowEditorContext} params.event.editorContext Editing context
2493
2184
  */
2494
2185
  (e: 'startRowEdit', params: ((event: { source: Grid, editorContext: RowEditorContext }) => void)|string): void
2495
2186
  /**
@@ -2500,79 +2191,65 @@ const emit = defineEmits<{
2500
2191
  * Fires after a sub grid is collapsed.
2501
2192
  * @param {string} e Event name
2502
2193
  * @param {object} params Event parameters
2503
- * @param {string} params.e Event name
2504
- * @param {object} params.params Event parameters
2505
- * @param {object} params.params.event Event object
2506
- * @param {Grid.view.GridBase} params.params.event.source The firing Grid instance
2507
- * @param {Grid.view.SubGrid} params.params.event.subGrid The sub grid instance
2194
+ * @param {object} params.event Event object
2195
+ * @param {Grid.view.GridBase} params.event.source The firing Grid instance
2196
+ * @param {Grid.view.SubGrid} params.event.subGrid The sub grid instance
2508
2197
  */
2509
2198
  (e: 'subGridCollapse', params: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string): void
2510
2199
  /**
2511
2200
  * Fires after a sub grid is expanded.
2512
2201
  * @param {string} e Event name
2513
2202
  * @param {object} params Event parameters
2514
- * @param {string} params.e Event name
2515
- * @param {object} params.params Event parameters
2516
- * @param {object} params.params.event Event object
2517
- * @param {Grid.view.GridBase} params.params.event.source The firing Grid instance
2518
- * @param {Grid.view.SubGrid} params.params.event.subGrid The sub grid instance
2203
+ * @param {object} params.event Event object
2204
+ * @param {Grid.view.GridBase} params.event.source The firing Grid instance
2205
+ * @param {Grid.view.SubGrid} params.event.subGrid The sub grid instance
2519
2206
  */
2520
2207
  (e: 'subGridExpand', params: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string): void
2521
2208
  /**
2522
2209
  * Fired when one or more groups are expanded or collapsed
2523
2210
  * @param {string} e Event name
2524
2211
  * @param {object} params Event parameters
2525
- * @param {string} params.e Event name
2526
- * @param {object} params.params Event parameters
2527
- * @param {object} params.params.event Event object
2528
- * @param {Core.data.Model} params.params.event.groupRecord [DEPRECATED] Use `groupRecords` param instead
2529
- * @param {Core.data.Model[]} params.params.event.groupRecords The group records being toggled
2530
- * @param {boolean} params.params.event.collapse Collapsed (true) or expanded (false)
2531
- * @param {boolean} params.params.event.allRecords True if this event is part of toggling all groups
2212
+ * @param {object} params.event Event object
2213
+ * @param {Core.data.Model} params.event.groupRecord [DEPRECATED] Use `groupRecords` param instead
2214
+ * @param {Core.data.Model[]} params.event.groupRecords The group records being toggled
2215
+ * @param {boolean} params.event.collapse Collapsed (true) or expanded (false)
2216
+ * @param {boolean} [params.event.allRecords] True if this event is part of toggling all groups
2532
2217
  */
2533
2218
  (e: 'toggleGroup', params: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, allRecords?: boolean }) => void)|string): void
2534
2219
  /**
2535
2220
  * Fired after a parent node record toggles its collapsed state.
2536
2221
  * @param {string} e Event name
2537
2222
  * @param {object} params Event parameters
2538
- * @param {string} params.e Event name
2539
- * @param {object} params.params Event parameters
2540
- * @param {object} params.params.event Event object
2541
- * @param {Core.data.Model} params.params.event.record The record being toggled.
2542
- * @param {boolean} params.params.event.collapse `true` if the node is being collapsed.
2223
+ * @param {object} params.event Event object
2224
+ * @param {Core.data.Model} params.event.record The record being toggled.
2225
+ * @param {boolean} params.event.collapse `true` if the node is being collapsed.
2543
2226
  */
2544
2227
  (e: 'toggleNode', params: ((event: { record: Model, collapse: boolean }) => void)|string): void
2545
2228
  /**
2546
2229
  * A header [tool](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Panel#config-tools) has been clicked.
2547
2230
  * @param {string} e Event name
2548
2231
  * @param {object} params Event parameters
2549
- * @param {string} params.e Event name
2550
- * @param {object} params.params Event parameters
2551
- * @param {object} params.params.event Event object
2552
- * @param {Core.widget.Tool} params.params.event.source This Panel.
2553
- * @param {Core.widget.Tool} params.params.event.tool The tool which is being clicked.
2232
+ * @param {object} params.event Event object
2233
+ * @param {Core.widget.Tool} params.event.source This Panel.
2234
+ * @param {Core.widget.Tool} params.event.tool The tool which is being clicked.
2554
2235
  */
2555
2236
  (e: 'toolClick', params: ((event: { source: Tool, tool: Tool }) => void)|string): void
2556
2237
  /**
2557
2238
  * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
2558
2239
  * @param {string} e Event name
2559
2240
  * @param {object} params Event parameters
2560
- * @param {string} params.e Event name
2561
- * @param {object} params.params Event parameters
2562
- * @param {object} params.params.event Event object
2563
- * @param {Grid.view.Grid} params.params.event.source The grid instance
2564
- * @param {(string|Function)[]} params.params.event.groupers Array of field names or functions representing the current grouping levels
2565
- * @param {(string|Function)[]} params.params.event.oldGroupers Array of field names or functions representing the previous grouping levels
2241
+ * @param {object} params.event Event object
2242
+ * @param {Grid.view.Grid} params.event.source The grid instance
2243
+ * @param {(string|Function)[]} params.event.groupers Array of field names or functions representing the current grouping levels
2244
+ * @param {(string|Function)[]} params.event.oldGroupers Array of field names or functions representing the previous grouping levels
2566
2245
  */
2567
2246
  (e: 'treeGroup', params: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string): void
2568
2247
  /**
2569
2248
  * Fires when row locking is disabled.
2570
2249
  * @param {string} e Event name
2571
2250
  * @param {object} params Event parameters
2572
- * @param {string} params.e Event name
2573
- * @param {object} params.params Event parameters
2574
- * @param {object} params.params.event Event object
2575
- * @param {Grid.view.GridBase} params.params.event.clone The locked clone that will be destroyed
2251
+ * @param {object} params.event Event object
2252
+ * @param {Grid.view.GridBase} params.event.clone The locked clone that will be destroyed
2576
2253
  */
2577
2254
  (e: 'unlockRows', params: ((event: { clone: GridBase }) => void)|string): void
2578
2255
  /**
@@ -2642,6 +2319,7 @@ const widgetData = {
2642
2319
  'resizeToFitIncludesHeader',
2643
2320
  'responsiveLevels',
2644
2321
  'ripple',
2322
+ 'role',
2645
2323
  'rootElement',
2646
2324
  'scrollerClass',
2647
2325
  'scrollManager',
@@ -2690,6 +2368,7 @@ const widgetData = {
2690
2368
  'insertFirst',
2691
2369
  'keyMap',
2692
2370
  'labelPosition',
2371
+ 'labelWidth',
2693
2372
  'longPressTime',
2694
2373
  'margin',
2695
2374
  'maxHeight',
@@ -2839,8 +2518,6 @@ const widgetData = {
2839
2518
  'width'
2840
2519
  ],
2841
2520
  propertyNames : [
2842
- 'focusVisible',
2843
- 'hasChanges',
2844
2521
  'originalStore',
2845
2522
  'parent',
2846
2523
  'selectedCell',