@bryntum/schedulerpro-vue-3-thin 7.2.4 → 7.3.0

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 +7 -7
  2. package/lib/chunks/{D4JDuI0s.js → B4dVznPx.js} +1 -8
  3. package/lib/chunks/B4dVznPx.js.map +1 -0
  4. package/lib/chunks/{BhUeT19h.js → BFFz1c24.js} +5 -5
  5. package/lib/chunks/BFFz1c24.js.map +1 -0
  6. package/lib/chunks/{BJPdcix1.js → BIkGnHve.js} +3 -3
  7. package/lib/chunks/BIkGnHve.js.map +1 -0
  8. package/lib/chunks/{BRGc8bUJ.js → BNBuOpUp.js} +8 -7
  9. package/lib/chunks/BNBuOpUp.js.map +1 -0
  10. package/lib/chunks/{BjTPjWi9.js → Bp7aU5Ia.js} +6 -6
  11. package/lib/chunks/Bp7aU5Ia.js.map +1 -0
  12. package/lib/chunks/{CuODT2-U.js → C3Dz-ovY.js} +3 -3
  13. package/lib/chunks/C3Dz-ovY.js.map +1 -0
  14. package/lib/chunks/{BTT_cGQU.js → CPjow0gO.js} +8 -9
  15. package/lib/chunks/CPjow0gO.js.map +1 -0
  16. package/lib/chunks/{DYBe70El.js → CqtUB81W.js} +18 -11
  17. package/lib/chunks/CqtUB81W.js.map +1 -0
  18. package/lib/chunks/{C41opZKx.js → CvNpXefN.js} +18 -11
  19. package/lib/chunks/CvNpXefN.js.map +1 -0
  20. package/lib/chunks/{BbI7XKMd.js → D0hJ3P6L.js} +5 -3
  21. package/lib/chunks/D0hJ3P6L.js.map +1 -0
  22. package/lib/chunks/{BpAvqwr_.js → D1a3F6m-.js} +23 -13
  23. package/lib/chunks/D1a3F6m-.js.map +1 -0
  24. package/lib/chunks/{CGbW6pgm.js → DPA-xEW5.js} +8 -9
  25. package/lib/chunks/DPA-xEW5.js.map +1 -0
  26. package/lib/chunks/{MOjUZ-Rj.js → DdbMybqv.js} +5 -5
  27. package/lib/chunks/DdbMybqv.js.map +1 -0
  28. package/lib/chunks/{DGV7a5Xo.js → DjFBhm9P.js} +6 -6
  29. package/lib/chunks/DjFBhm9P.js.map +1 -0
  30. package/lib/chunks/{Dz-up1_i.js → DmFXOMJ5.js} +5 -5
  31. package/lib/chunks/DmFXOMJ5.js.map +1 -0
  32. package/lib/chunks/{DwzPrR90.js → Pb5GbfMi.js} +5 -5
  33. package/lib/chunks/Pb5GbfMi.js.map +1 -0
  34. package/lib/chunks/{M0cBUV91.js → W-pa3HyX.js} +6 -6
  35. package/lib/chunks/W-pa3HyX.js.map +1 -0
  36. package/lib/chunks/{CJFZbm_i.js → b8yreHIz.js} +23 -13
  37. package/lib/chunks/b8yreHIz.js.map +1 -0
  38. package/lib/chunks/{9jfNe_y3.js → oM3gO3yH.js} +14 -8
  39. package/lib/chunks/oM3gO3yH.js.map +1 -0
  40. package/lib/chunks/{BO8FwQoh.js → p1r0F5YC.js} +6 -6
  41. package/lib/chunks/p1r0F5YC.js.map +1 -0
  42. package/lib/chunks/{DlNFp5e-.js → s35t-2ke.js} +10 -10
  43. package/lib/chunks/s35t-2ke.js.map +1 -0
  44. package/lib/chunks/{j8JzZ-07.js → yF4wtntA.js} +4 -4
  45. package/lib/chunks/yF4wtntA.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 +127 -186
  73. package/src/components/BryntumCalendarEditorProps.ts +123 -177
  74. package/src/components/BryntumCalendarField.vue +91 -151
  75. package/src/components/BryntumCalendarFieldProps.ts +87 -143
  76. package/src/components/BryntumConstraintTypePicker.vue +91 -151
  77. package/src/components/BryntumConstraintTypePickerProps.ts +87 -143
  78. package/src/components/BryntumCostAccrualField.vue +91 -151
  79. package/src/components/BryntumCostAccrualFieldProps.ts +87 -143
  80. package/src/components/BryntumDependencyTypePicker.vue +91 -151
  81. package/src/components/BryntumDependencyTypePickerProps.ts +87 -143
  82. package/src/components/BryntumEffortField.vue +79 -124
  83. package/src/components/BryntumEffortFieldProps.ts +73 -114
  84. package/src/components/BryntumEndDateField.vue +79 -122
  85. package/src/components/BryntumEndDateFieldProps.ts +75 -114
  86. package/src/components/BryntumModelCombo.vue +91 -151
  87. package/src/components/BryntumModelComboProps.ts +87 -143
  88. package/src/components/BryntumRateTableField.vue +91 -151
  89. package/src/components/BryntumRateTableFieldProps.ts +87 -143
  90. package/src/components/BryntumResourceEditor.vue +126 -184
  91. package/src/components/BryntumResourceEditorProps.ts +122 -175
  92. package/src/components/BryntumResourceGrid.vue +204 -293
  93. package/src/components/BryntumResourceGridProps.ts +187 -263
  94. package/src/components/BryntumResourceHistogram.vue +335 -458
  95. package/src/components/BryntumResourceHistogramProps.ts +287 -402
  96. package/src/components/BryntumResourceTypeField.vue +91 -151
  97. package/src/components/BryntumResourceTypeFieldProps.ts +87 -143
  98. package/src/components/BryntumResourceUtilization.vue +335 -458
  99. package/src/components/BryntumResourceUtilizationProps.ts +288 -404
  100. package/src/components/BryntumSchedulerPro.vue +504 -643
  101. package/src/components/BryntumSchedulerProBase.vue +504 -643
  102. package/src/components/BryntumSchedulerProBaseProps.ts +408 -556
  103. package/src/components/BryntumSchedulerProProjectModel.vue +63 -107
  104. package/src/components/BryntumSchedulerProProjectModelProps.ts +55 -85
  105. package/src/components/BryntumSchedulerProProps.ts +408 -556
  106. package/src/components/BryntumSchedulingDirectionPicker.vue +91 -151
  107. package/src/components/BryntumSchedulingDirectionPickerProps.ts +87 -143
  108. package/src/components/BryntumSchedulingModePicker.vue +92 -153
  109. package/src/components/BryntumSchedulingModePickerProps.ts +88 -145
  110. package/src/components/BryntumStartDateField.vue +81 -126
  111. package/src/components/BryntumStartDateFieldProps.ts +77 -118
  112. package/src/components/BryntumThemeCombo.vue +60 -0
  113. package/src/components/BryntumTimeline.vue +425 -594
  114. package/src/components/BryntumTimelineProps.ts +366 -519
  115. package/src/components/BryntumVersionGrid.vue +203 -290
  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
 
@@ -1087,8 +1012,7 @@ const emit = defineEmits<{
1087
1012
  (e: 'beforeCancelCellEdit', params: ((event: { source: Grid, editorContext: GridLocation }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1088
1013
  /**
1089
1014
  * 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)
1015
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#event-beforeCancelRowEdit)
1092
1016
  * @param {string} e Event name
1093
1017
  * @param {object} params Event parameters
1094
1018
  * @param {string} params.e Event name
@@ -1259,8 +1183,7 @@ const emit = defineEmits<{
1259
1183
  (e: 'beforeFinishCellEdit', params: ((event: { grid: Grid, editorContext: CellEditorContext }) => void)|string): void
1260
1184
  /**
1261
1185
  * 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)
1186
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#event-beforeFinishRowEdit)
1264
1187
  * @param {string} e Event name
1265
1188
  * @param {object} params Event parameters
1266
1189
  * @param {string} params.e Event name
@@ -1329,8 +1252,7 @@ const emit = defineEmits<{
1329
1252
  (e: 'beforeRenderRows', params: ((event: { source: GridBase }) => void)|string): void
1330
1253
  /**
1331
1254
  * 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)
1255
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#event-beforeRowCollapse)
1334
1256
  * @param {string} e Event name
1335
1257
  * @param {object} params Event parameters
1336
1258
  * @param {string} params.e Event name
@@ -1341,8 +1263,7 @@ const emit = defineEmits<{
1341
1263
  (e: 'beforeRowCollapse', params: ((event: { record: Model }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1342
1264
  /**
1343
1265
  * 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)
1266
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#event-beforeRowExpand)
1346
1267
  * @param {string} e Event name
1347
1268
  * @param {object} params Event parameters
1348
1269
  * @param {string} params.e Event name
@@ -1462,8 +1383,7 @@ const emit = defineEmits<{
1462
1383
  (e: 'cancelCellEdit', params: ((event: { source: Grid, editorContext: GridLocation, event: Event }) => void)|string): void
1463
1384
  /**
1464
1385
  * 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)
1386
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#event-catchAll)
1467
1387
  * @param {string} e Event name
1468
1388
  * @param {object} params Event parameters
1469
1389
  * @param {string} params.e Event name
@@ -1521,8 +1441,7 @@ const emit = defineEmits<{
1521
1441
  /**
1522
1442
  * This event fires on the owning grid before the context menu is shown for a cell.
1523
1443
  * 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)
1444
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#event-cellMenuBeforeShow)
1526
1445
  * @param {string} e Event name
1527
1446
  * @param {object} params Event parameters
1528
1447
  * @param {string} params.e Event name
@@ -1789,8 +1708,7 @@ const emit = defineEmits<{
1789
1708
  (e: 'copy', params: ((event: { source: Grid, cells: GridLocation[], copiedDataString: string, isCut: boolean, entityName: string }) => void)|string): void
1790
1709
  /**
1791
1710
  * Fired when data in the store changes.
1792
- * ...
1793
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#event-dataChange)
1711
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#event-dataChange)
1794
1712
  * @param {string} e Event name
1795
1713
  * @param {object} params Event parameters
1796
1714
  * @param {string} params.e Event name
@@ -1946,8 +1864,7 @@ const emit = defineEmits<{
1946
1864
  (e: 'finishCellEdit', params: ((event: { grid: Grid, editorContext: CellEditorContext }) => void)|string): void
1947
1865
  /**
1948
1866
  * 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)
1867
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#event-finishRowEdit)
1951
1868
  * @param {string} e Event name
1952
1869
  * @param {object} params Event parameters
1953
1870
  * @param {string} params.e Event name
@@ -2083,8 +2000,7 @@ const emit = defineEmits<{
2083
2000
  (e: 'gridRowDrop', params: ((event: { source: GridBase, context: { valid: boolean, insertBefore: Model, parent: Model, records: Model[], oldPositionContext: RecordPositionContext[] }, event: MouseEvent }) => void)|string): void
2084
2001
  /**
2085
2002
  * 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)
2003
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#event-headerClick)
2088
2004
  * @param {string} e Event name
2089
2005
  * @param {object} params Event parameters
2090
2006
  * @param {string} params.e Event name
@@ -2097,8 +2013,7 @@ const emit = defineEmits<{
2097
2013
  /**
2098
2014
  * This event fires on the owning Grid before the context menu is shown for a header.
2099
2015
  * 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)
2016
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#event-headerMenuBeforeShow)
2102
2017
  * @param {string} e Event name
2103
2018
  * @param {object} params Event parameters
2104
2019
  * @param {string} params.e Event name
@@ -2193,8 +2108,7 @@ const emit = defineEmits<{
2193
2108
  /**
2194
2109
  * Triggered when a widget which had been in a non-visible state for any reason
2195
2110
  * achieves visibility.
2196
- * ...
2197
- * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#event-paint)
2111
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#event-paint)
2198
2112
  * @param {string} e Event name
2199
2113
  * @param {object} params Event parameters
2200
2114
  * @param {string} params.e Event name
@@ -2225,8 +2139,8 @@ const emit = defineEmits<{
2225
2139
  * @param {string} params.e Event name
2226
2140
  * @param {object} params.params Event parameters
2227
2141
  * @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
2142
+ * @param {Response} [params.params.event.response] Optional response, if received
2143
+ * @param {Error} [params.params.event.error] Optional error, if exception occurred
2230
2144
  */
2231
2145
  (e: 'pdfExport', params: ((event: { response?: Response, error?: Error }) => void)|string): void
2232
2146
  /**
@@ -2317,8 +2231,7 @@ const emit = defineEmits<{
2317
2231
  (e: 'rowCollapse', params: ((event: { record: Model }) => void)|string): void
2318
2232
  /**
2319
2233
  * 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)
2234
+ * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#event-rowExpand)
2322
2235
  * @param {string} e Event name
2323
2236
  * @param {object} params Event parameters
2324
2237
  * @param {string} params.e Event name
@@ -2528,7 +2441,7 @@ const emit = defineEmits<{
2528
2441
  * @param {Core.data.Model} params.params.event.groupRecord [DEPRECATED] Use `groupRecords` param instead
2529
2442
  * @param {Core.data.Model[]} params.params.event.groupRecords The group records being toggled
2530
2443
  * @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
2444
+ * @param {boolean} [params.params.event.allRecords] True if this event is part of toggling all groups
2532
2445
  */
2533
2446
  (e: 'toggleGroup', params: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, allRecords?: boolean }) => void)|string): void
2534
2447
  /**
@@ -2642,6 +2555,7 @@ const widgetData = {
2642
2555
  'resizeToFitIncludesHeader',
2643
2556
  'responsiveLevels',
2644
2557
  'ripple',
2558
+ 'role',
2645
2559
  'rootElement',
2646
2560
  'scrollerClass',
2647
2561
  'scrollManager',
@@ -2690,6 +2604,7 @@ const widgetData = {
2690
2604
  'insertFirst',
2691
2605
  'keyMap',
2692
2606
  'labelPosition',
2607
+ 'labelWidth',
2693
2608
  'longPressTime',
2694
2609
  'margin',
2695
2610
  'maxHeight',
@@ -2839,8 +2754,6 @@ const widgetData = {
2839
2754
  'width'
2840
2755
  ],
2841
2756
  propertyNames : [
2842
- 'focusVisible',
2843
- 'hasChanges',
2844
2757
  'originalStore',
2845
2758
  'parent',
2846
2759
  'selectedCell',