@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.
- package/README.md +7 -7
- package/lib/chunks/{D4JDuI0s.js → B4dVznPx.js} +1 -8
- package/lib/chunks/B4dVznPx.js.map +1 -0
- package/lib/chunks/{BhUeT19h.js → BFFz1c24.js} +5 -5
- package/lib/chunks/BFFz1c24.js.map +1 -0
- package/lib/chunks/{BJPdcix1.js → BIkGnHve.js} +3 -3
- package/lib/chunks/BIkGnHve.js.map +1 -0
- package/lib/chunks/{BRGc8bUJ.js → BNBuOpUp.js} +8 -7
- package/lib/chunks/BNBuOpUp.js.map +1 -0
- package/lib/chunks/{BjTPjWi9.js → Bp7aU5Ia.js} +6 -6
- package/lib/chunks/Bp7aU5Ia.js.map +1 -0
- package/lib/chunks/{CuODT2-U.js → C3Dz-ovY.js} +3 -3
- package/lib/chunks/C3Dz-ovY.js.map +1 -0
- package/lib/chunks/{BTT_cGQU.js → CPjow0gO.js} +8 -9
- package/lib/chunks/CPjow0gO.js.map +1 -0
- package/lib/chunks/{DYBe70El.js → CqtUB81W.js} +18 -11
- package/lib/chunks/CqtUB81W.js.map +1 -0
- package/lib/chunks/{C41opZKx.js → CvNpXefN.js} +18 -11
- package/lib/chunks/CvNpXefN.js.map +1 -0
- package/lib/chunks/{BbI7XKMd.js → D0hJ3P6L.js} +5 -3
- package/lib/chunks/D0hJ3P6L.js.map +1 -0
- package/lib/chunks/{BpAvqwr_.js → D1a3F6m-.js} +23 -13
- package/lib/chunks/D1a3F6m-.js.map +1 -0
- package/lib/chunks/{CGbW6pgm.js → DPA-xEW5.js} +8 -9
- package/lib/chunks/DPA-xEW5.js.map +1 -0
- package/lib/chunks/{MOjUZ-Rj.js → DdbMybqv.js} +5 -5
- package/lib/chunks/DdbMybqv.js.map +1 -0
- package/lib/chunks/{DGV7a5Xo.js → DjFBhm9P.js} +6 -6
- package/lib/chunks/DjFBhm9P.js.map +1 -0
- package/lib/chunks/{Dz-up1_i.js → DmFXOMJ5.js} +5 -5
- package/lib/chunks/DmFXOMJ5.js.map +1 -0
- package/lib/chunks/{DwzPrR90.js → Pb5GbfMi.js} +5 -5
- package/lib/chunks/Pb5GbfMi.js.map +1 -0
- package/lib/chunks/{M0cBUV91.js → W-pa3HyX.js} +6 -6
- package/lib/chunks/W-pa3HyX.js.map +1 -0
- package/lib/chunks/{CJFZbm_i.js → b8yreHIz.js} +23 -13
- package/lib/chunks/b8yreHIz.js.map +1 -0
- package/lib/chunks/{9jfNe_y3.js → oM3gO3yH.js} +14 -8
- package/lib/chunks/oM3gO3yH.js.map +1 -0
- package/lib/chunks/{BO8FwQoh.js → p1r0F5YC.js} +6 -6
- package/lib/chunks/p1r0F5YC.js.map +1 -0
- package/lib/chunks/{DlNFp5e-.js → s35t-2ke.js} +10 -10
- package/lib/chunks/s35t-2ke.js.map +1 -0
- package/lib/chunks/{j8JzZ-07.js → yF4wtntA.js} +4 -4
- package/lib/chunks/yF4wtntA.js.map +1 -0
- package/lib/components/BryntumCalendarEditor.js +1 -1
- package/lib/components/BryntumCalendarField.js +1 -1
- package/lib/components/BryntumConstraintTypePicker.js +1 -1
- package/lib/components/BryntumCostAccrualField.js +1 -1
- package/lib/components/BryntumDependencyTypePicker.js +1 -1
- package/lib/components/BryntumEffortField.js +1 -1
- package/lib/components/BryntumEndDateField.js +1 -1
- package/lib/components/BryntumModelCombo.js +1 -1
- package/lib/components/BryntumRateTableField.js +1 -1
- package/lib/components/BryntumResourceEditor.js +1 -1
- package/lib/components/BryntumResourceGrid.js +1 -1
- package/lib/components/BryntumResourceHistogram.js +1 -1
- package/lib/components/BryntumResourceTypeField.js +1 -1
- package/lib/components/BryntumResourceUtilization.js +1 -1
- package/lib/components/BryntumSchedulerPro.js +1 -1
- package/lib/components/BryntumSchedulerProBase.js +1 -1
- package/lib/components/BryntumSchedulerProProjectModel.js +1 -1
- package/lib/components/BryntumSchedulingDirectionPicker.js +1 -1
- package/lib/components/BryntumSchedulingModePicker.js +1 -1
- package/lib/components/BryntumStartDateField.js +1 -1
- package/lib/components/BryntumThemeCombo.js +57 -0
- package/lib/components/BryntumThemeCombo.js.map +1 -0
- package/lib/components/BryntumTimeline.js +1 -1
- package/lib/components/BryntumVersionGrid.js +1 -1
- package/lib/index.js +22 -22
- package/package.json +1 -1
- package/src/components/BryntumCalendarEditor.vue +127 -186
- package/src/components/BryntumCalendarEditorProps.ts +123 -177
- package/src/components/BryntumCalendarField.vue +91 -151
- package/src/components/BryntumCalendarFieldProps.ts +87 -143
- package/src/components/BryntumConstraintTypePicker.vue +91 -151
- package/src/components/BryntumConstraintTypePickerProps.ts +87 -143
- package/src/components/BryntumCostAccrualField.vue +91 -151
- package/src/components/BryntumCostAccrualFieldProps.ts +87 -143
- package/src/components/BryntumDependencyTypePicker.vue +91 -151
- package/src/components/BryntumDependencyTypePickerProps.ts +87 -143
- package/src/components/BryntumEffortField.vue +79 -124
- package/src/components/BryntumEffortFieldProps.ts +73 -114
- package/src/components/BryntumEndDateField.vue +79 -122
- package/src/components/BryntumEndDateFieldProps.ts +75 -114
- package/src/components/BryntumModelCombo.vue +91 -151
- package/src/components/BryntumModelComboProps.ts +87 -143
- package/src/components/BryntumRateTableField.vue +91 -151
- package/src/components/BryntumRateTableFieldProps.ts +87 -143
- package/src/components/BryntumResourceEditor.vue +126 -184
- package/src/components/BryntumResourceEditorProps.ts +122 -175
- package/src/components/BryntumResourceGrid.vue +204 -293
- package/src/components/BryntumResourceGridProps.ts +187 -263
- package/src/components/BryntumResourceHistogram.vue +335 -458
- package/src/components/BryntumResourceHistogramProps.ts +287 -402
- package/src/components/BryntumResourceTypeField.vue +91 -151
- package/src/components/BryntumResourceTypeFieldProps.ts +87 -143
- package/src/components/BryntumResourceUtilization.vue +335 -458
- package/src/components/BryntumResourceUtilizationProps.ts +288 -404
- package/src/components/BryntumSchedulerPro.vue +504 -643
- package/src/components/BryntumSchedulerProBase.vue +504 -643
- package/src/components/BryntumSchedulerProBaseProps.ts +408 -556
- package/src/components/BryntumSchedulerProProjectModel.vue +63 -107
- package/src/components/BryntumSchedulerProProjectModelProps.ts +55 -85
- package/src/components/BryntumSchedulerProProps.ts +408 -556
- package/src/components/BryntumSchedulingDirectionPicker.vue +91 -151
- package/src/components/BryntumSchedulingDirectionPickerProps.ts +87 -143
- package/src/components/BryntumSchedulingModePicker.vue +92 -153
- package/src/components/BryntumSchedulingModePickerProps.ts +88 -145
- package/src/components/BryntumStartDateField.vue +81 -126
- package/src/components/BryntumStartDateFieldProps.ts +77 -118
- package/src/components/BryntumThemeCombo.vue +60 -0
- package/src/components/BryntumTimeline.vue +425 -594
- package/src/components/BryntumTimelineProps.ts +366 -519
- package/src/components/BryntumVersionGrid.vue +203 -290
- package/src/components/BryntumVersionGridProps.ts +186 -261
- package/lib/chunks/9jfNe_y3.js.map +0 -1
- package/lib/chunks/BJPdcix1.js.map +0 -1
- package/lib/chunks/BO8FwQoh.js.map +0 -1
- package/lib/chunks/BRGc8bUJ.js.map +0 -1
- package/lib/chunks/BTT_cGQU.js.map +0 -1
- package/lib/chunks/BbI7XKMd.js.map +0 -1
- package/lib/chunks/BhUeT19h.js.map +0 -1
- package/lib/chunks/BjTPjWi9.js.map +0 -1
- package/lib/chunks/BpAvqwr_.js.map +0 -1
- package/lib/chunks/C41opZKx.js.map +0 -1
- package/lib/chunks/CGbW6pgm.js.map +0 -1
- package/lib/chunks/CJFZbm_i.js.map +0 -1
- package/lib/chunks/CuODT2-U.js.map +0 -1
- package/lib/chunks/D4JDuI0s.js.map +0 -1
- package/lib/chunks/DGV7a5Xo.js.map +0 -1
- package/lib/chunks/DYBe70El.js.map +0 -1
- package/lib/chunks/DlNFp5e-.js.map +0 -1
- package/lib/chunks/DwzPrR90.js.map +0 -1
- package/lib/chunks/Dz-up1_i.js.map +0 -1
- package/lib/chunks/M0cBUV91.js.map +0 -1
- package/lib/chunks/MOjUZ-Rj.js.map +0 -1
- package/lib/chunks/j8JzZ-07.js.map +0 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { Color, DomConfig, FormulaProviderConfig, KeyMapConfig, Mask, MaskConfig, Model, ModelConfig, PagingToolbarConfig, PanelCollapserConfig, PanelCollapserOverlayConfig, PanelHeader, ScrollManager, ScrollManagerConfig, Scroller, ScrollerConfig, StateProvider, Store, StoreConfig, TabConfig, ToolConfig, ToolbarConfig, ToolbarItems, Widget } from '@bryntum/core-thin';
|
|
1
|
+
import type { Color, DomConfig, FormulaProviderConfig, InstancePlugin, KeyMapConfig, Mask, MaskConfig, Model, ModelConfig, PagingToolbarConfig, PanelCollapserConfig, PanelCollapserOverlayConfig, PanelHeader, ScrollManager, ScrollManagerConfig, Scroller, ScrollerConfig, StateProvider, Store, StoreConfig, TabConfig, ToolConfig, ToolbarConfig, ToolbarItems, Widget } from '@bryntum/core-thin';
|
|
2
2
|
import type { AI as GridAI, AIConfig as GridAIConfig, AIFilter, AIFilterConfig, CellCopyPaste, CellCopyPasteConfig, CellEdit as GridCellEdit, CellEditConfig as GridCellEditConfig, CellMenu, CellMenuConfig, CellTooltip, CellTooltipConfig, Charts, ChartsConfig, ColumnAutoWidth, ColumnAutoWidthConfig, ColumnDragToolbar, ColumnDragToolbarConfig, ColumnPicker, ColumnPickerConfig, ColumnRename, ColumnRenameConfig, ColumnReorder, ColumnReorderConfig, ColumnResize, ColumnResizeConfig, ColumnStore, ColumnStoreConfig, EmptyTextDomConfig, ExcelExporter as GridExcelExporter, ExcelExporterConfig as GridExcelExporterConfig, FileDrop, FileDropConfig, FillHandle, FillHandleConfig, Filter, FilterBar, FilterBarConfig, FilterConfig, GridSelectionMode, 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, RegionResize, RegionResizeConfig, ResponsiveLevelConfig, RowCopyPaste, RowCopyPasteConfig, RowEdit, RowEditConfig, 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, SubGridConfig, Summary as GridSummary, SummaryConfig as GridSummaryConfig, Tree, TreeConfig, TreeGroup, TreeGroupConfig } from '@bryntum/grid-thin';
|
|
3
3
|
import type { SchedulerProContainerItemConfig, SchedulerProColumnConfig, ProjectModel, VersionGridListeners } from '@bryntum/schedulerpro-thin';
|
|
4
4
|
|
|
@@ -7,8 +7,7 @@ export declare type BryntumVersionGridProps = {
|
|
|
7
7
|
/**
|
|
8
8
|
* Element (or element id) to adopt as this Widget's encapsulating element. The widget's
|
|
9
9
|
* content will be placed inside this element.
|
|
10
|
-
* ...
|
|
11
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-adopt)
|
|
10
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-adopt)
|
|
12
11
|
*/
|
|
13
12
|
adopt ? : HTMLElement|string
|
|
14
13
|
/**
|
|
@@ -43,15 +42,13 @@ export declare type BryntumVersionGridProps = {
|
|
|
43
42
|
/**
|
|
44
43
|
* A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject
|
|
45
44
|
* into an element which will be linked using the `aria-describedby` attribute.
|
|
46
|
-
* ...
|
|
47
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-ariaDescription)
|
|
45
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-ariaDescription)
|
|
48
46
|
*/
|
|
49
47
|
ariaDescription ? : string
|
|
50
48
|
/**
|
|
51
49
|
* A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject as
|
|
52
50
|
* the `aria-label` attribute.
|
|
53
|
-
* ...
|
|
54
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-ariaLabel)
|
|
51
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-ariaLabel)
|
|
55
52
|
*/
|
|
56
53
|
ariaLabel ? : string
|
|
57
54
|
/**
|
|
@@ -63,14 +60,12 @@ export declare type BryntumVersionGridProps = {
|
|
|
63
60
|
/**
|
|
64
61
|
* A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Toolbar),
|
|
65
62
|
* 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).
|
|
66
|
-
* ...
|
|
67
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-bbar)
|
|
63
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-bbar)
|
|
68
64
|
*/
|
|
69
65
|
bbar ? : (SchedulerProContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
|
|
70
66
|
/**
|
|
71
67
|
* Custom CSS classes to add to the panel's body element.
|
|
72
|
-
* ...
|
|
73
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-bodyCls)
|
|
68
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-bodyCls)
|
|
74
69
|
*/
|
|
75
70
|
bodyCls ? : string|object
|
|
76
71
|
/**
|
|
@@ -80,21 +75,18 @@ export declare type BryntumVersionGridProps = {
|
|
|
80
75
|
/**
|
|
81
76
|
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
82
77
|
* hierarchy when triggered.
|
|
83
|
-
* ...
|
|
84
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-bubbleEvents)
|
|
78
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-bubbleEvents)
|
|
85
79
|
*/
|
|
86
80
|
bubbleEvents ? : object
|
|
87
81
|
/**
|
|
88
82
|
* Set to `false` to not call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
|
|
89
|
-
* ...
|
|
90
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-callOnFunctions)
|
|
83
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-callOnFunctions)
|
|
91
84
|
*/
|
|
92
85
|
callOnFunctions ? : Boolean
|
|
93
86
|
/**
|
|
94
87
|
* By default, if an event handler throws an exception, the error propagates up the stack and the
|
|
95
88
|
* application state is undefined. Code which follows the event handler will *not* be executed.
|
|
96
|
-
* ...
|
|
97
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-catchEventHandlerExceptions)
|
|
89
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-catchEventHandlerExceptions)
|
|
98
90
|
*/
|
|
99
91
|
catchEventHandlerExceptions ? : Boolean
|
|
100
92
|
/**
|
|
@@ -107,8 +99,7 @@ export declare type BryntumVersionGridProps = {
|
|
|
107
99
|
* Custom CSS classes to add to element.
|
|
108
100
|
* May be specified as a space separated string, or as an object in which property names
|
|
109
101
|
* with truthy values are used as the class names:
|
|
110
|
-
* ...
|
|
111
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-cls)
|
|
102
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-cls)
|
|
112
103
|
*/
|
|
113
104
|
cls ? : string|object
|
|
114
105
|
/**
|
|
@@ -118,15 +109,13 @@ export declare type BryntumVersionGridProps = {
|
|
|
118
109
|
collapsed ? : Boolean
|
|
119
110
|
/**
|
|
120
111
|
* This config enables collapsibility for the panel. See [collapsed](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Panel#config-collapsed).
|
|
121
|
-
* ...
|
|
122
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-collapsible)
|
|
112
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-collapsible)
|
|
123
113
|
*/
|
|
124
114
|
collapsible ? : Boolean|PanelCollapserConfig|PanelCollapserOverlayConfig
|
|
125
115
|
/**
|
|
126
116
|
* Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
|
|
127
117
|
* `style` block.
|
|
128
|
-
* ...
|
|
129
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-color)
|
|
118
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-color)
|
|
130
119
|
*/
|
|
131
120
|
color ? : Color
|
|
132
121
|
/**
|
|
@@ -140,8 +129,7 @@ export declare type BryntumVersionGridProps = {
|
|
|
140
129
|
/**
|
|
141
130
|
* Accepts column definitions for the grid during initialization. They will be used to create
|
|
142
131
|
* [Column](https://bryntum.com/products/schedulerpro/docs/api/Grid/column/Column) instances that are added to a [ColumnStore](#Grid/data/ColumnStore).
|
|
143
|
-
* ...
|
|
144
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-columns)
|
|
132
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-columns)
|
|
145
133
|
*/
|
|
146
134
|
columns ? : ColumnStore|SchedulerProColumnConfig[]|ColumnStoreConfig
|
|
147
135
|
/**
|
|
@@ -153,8 +141,7 @@ export declare type BryntumVersionGridProps = {
|
|
|
153
141
|
* Custom CSS classes to add to the [contentElement](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#property-contentElement).
|
|
154
142
|
* May be specified as a space separated string, or as an object in which property names
|
|
155
143
|
* with truthy values are used as the class names:
|
|
156
|
-
* ...
|
|
157
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-contentElementCls)
|
|
144
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-contentElementCls)
|
|
158
145
|
*/
|
|
159
146
|
contentElementCls ? : string|object
|
|
160
147
|
/**
|
|
@@ -166,8 +153,7 @@ export declare type BryntumVersionGridProps = {
|
|
|
166
153
|
* Convenient shortcut to set data in grids store both during initialization and at runtime. Can also be
|
|
167
154
|
* used to retrieve data at runtime, although we do recommend interacting with Grids store instead using
|
|
168
155
|
* the [store](https://bryntum.com/products/schedulerpro/docs/api/Grid/view/GridBase#property-store) property.
|
|
169
|
-
* ...
|
|
170
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-data)
|
|
156
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-data)
|
|
171
157
|
*/
|
|
172
158
|
data ? : object[]|Model[]|ModelConfig[]
|
|
173
159
|
/**
|
|
@@ -192,16 +178,15 @@ export declare type BryntumVersionGridProps = {
|
|
|
192
178
|
*/
|
|
193
179
|
destroyStore ? : Boolean
|
|
194
180
|
/**
|
|
195
|
-
* Check for CSS compatibility issues
|
|
196
|
-
*
|
|
197
|
-
* [
|
|
181
|
+
* Check for CSS compatibility and inclusion related issues and try to auto fix them. Performs the following
|
|
182
|
+
* checks:
|
|
183
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-detectCSSCompatibilityIssues)
|
|
198
184
|
*/
|
|
199
185
|
detectCSSCompatibilityIssues ? : Boolean
|
|
200
186
|
/**
|
|
201
187
|
* 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
|
|
202
188
|
* cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
|
|
203
|
-
* ...
|
|
204
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-disabled)
|
|
189
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-disabled)
|
|
205
190
|
*/
|
|
206
191
|
disabled ? : Boolean|'inert'
|
|
207
192
|
/**
|
|
@@ -221,43 +206,39 @@ export declare type BryntumVersionGridProps = {
|
|
|
221
206
|
* [strips collection](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
|
|
222
207
|
* `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
|
|
223
208
|
* body. Such widgets are called "edge strips".
|
|
224
|
-
* ...
|
|
225
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-dock)
|
|
209
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-dock)
|
|
226
210
|
*/
|
|
227
211
|
dock ? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
228
212
|
/**
|
|
229
213
|
* Make this Panel a docked drawer which slides out from one side of the browser viewport by default.
|
|
230
|
-
* ...
|
|
231
|
-
* [
|
|
232
|
-
* @param {
|
|
233
|
-
* @param {
|
|
234
|
-
* @param {boolean}
|
|
235
|
-
* @param {boolean,
|
|
236
|
-
* @param {boolean,string} autoClose.
|
|
237
|
-
* @param {
|
|
238
|
-
* @param {
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
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}
|
|
214
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-drawer)
|
|
215
|
+
* @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.
|
|
216
|
+
* @param {string,number} [size] The size of the drawer in its collapsible axis.
|
|
217
|
+
* @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.
|
|
218
|
+
* @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.
|
|
219
|
+
* @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.
|
|
220
|
+
* @param {boolean,string} [autoClose.focusout] If focus moves outside of the drawer, the drawer will automatically be hidden.
|
|
221
|
+
* @param {string} [autoClose.mouseout] Hides the drawer when the mouse leaves the drawer after the `autoCloseDelay` period.
|
|
222
|
+
* @param {number} [autoCloseDelay] When using `mouseout`, this is the delay in milliseconds
|
|
223
|
+
*/
|
|
224
|
+
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 }
|
|
242
225
|
/**
|
|
243
226
|
* An object specifying attributes to assign to the root element of this widget.
|
|
244
227
|
* Set `null` value to attribute to remove it.
|
|
245
|
-
* ...
|
|
246
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-elementAttributes)
|
|
228
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-elementAttributes)
|
|
247
229
|
*/
|
|
248
230
|
elementAttributes ? : Record<string, string|null>
|
|
249
231
|
/**
|
|
250
232
|
* 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.
|
|
251
233
|
* When using multiple Grid regions, provide the `region` property to decide where the text is shown.
|
|
252
234
|
* By default, it is shown in the first region.
|
|
253
|
-
* ...
|
|
254
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-emptyText)
|
|
235
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-emptyText)
|
|
255
236
|
*/
|
|
256
237
|
emptyText ? : string|EmptyTextDomConfig
|
|
257
238
|
/**
|
|
258
|
-
*
|
|
259
|
-
*
|
|
260
|
-
*
|
|
239
|
+
* Set to `true` to enable the [StickyCells](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/StickyCells) feature, which pins cell
|
|
240
|
+
* content to the top of the grid while rows scroll off the top but remain visible.
|
|
241
|
+
* @deprecated 7.3.0 Use `features : { stickyCells : true }` instead
|
|
261
242
|
*/
|
|
262
243
|
enableSticky ? : Boolean
|
|
263
244
|
/**
|
|
@@ -281,8 +262,7 @@ export declare type BryntumVersionGridProps = {
|
|
|
281
262
|
* Use fixed row height. Setting this to `true` will configure the underlying RowManager to use fixed row
|
|
282
263
|
* height, which sacrifices the ability to use rows with variable height to gain a fraction better
|
|
283
264
|
* performance.
|
|
284
|
-
* ...
|
|
285
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-fixedRowHeight)
|
|
265
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-fixedRowHeight)
|
|
286
266
|
*/
|
|
287
267
|
fixedRowHeight ? : Boolean
|
|
288
268
|
/**
|
|
@@ -296,41 +276,35 @@ export declare type BryntumVersionGridProps = {
|
|
|
296
276
|
/**
|
|
297
277
|
* Config object of a footer. May contain a `dock`, `html` and a `cls` property. A footer is not a widget,
|
|
298
278
|
* 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).
|
|
299
|
-
* ...
|
|
300
|
-
*
|
|
279
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-footer)
|
|
280
|
+
* @property {'top','right','bottom','left','start','end'} dock Where to dock
|
|
281
|
+
* @property {string} html Html to populate the footer with
|
|
282
|
+
* @property {string} cls CSS class to add to the footer
|
|
301
283
|
*/
|
|
302
|
-
footer ? :
|
|
303
|
-
dock?: 'top'|'right'|'bottom'|'left'|'start'|'end'
|
|
304
|
-
html?: string
|
|
305
|
-
cls?: string
|
|
306
|
-
}|string
|
|
284
|
+
footer ? : object|string
|
|
307
285
|
/**
|
|
308
286
|
* An object which names formula prefixes which will be applied to all columns configured with
|
|
309
287
|
* `formula : true`.
|
|
310
|
-
* ...
|
|
311
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-formulaProviders)
|
|
288
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-formulaProviders)
|
|
312
289
|
*/
|
|
313
290
|
formulaProviders ? : Record<string, FormulaProviderConfig>
|
|
314
291
|
/**
|
|
315
292
|
* Refresh entire row when a record changes (`true`) or, if possible, only the cells affected (`false`).
|
|
316
|
-
* ...
|
|
317
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-fullRowRefresh)
|
|
293
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-fullRowRefresh)
|
|
318
294
|
*/
|
|
319
295
|
fullRowRefresh ? : Boolean
|
|
320
296
|
/**
|
|
321
297
|
* 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
|
|
322
298
|
* expected to return the desired height of that records row. If the function returns a falsy value, Grids
|
|
323
299
|
* configured [rowHeight](https://bryntum.com/products/schedulerpro/docs/api/Grid/view/GridBase#config-rowHeight) is used.
|
|
324
|
-
* ...
|
|
325
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-getRowHeight)
|
|
300
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-getRowHeight)
|
|
326
301
|
* @param {Core.data.Model} getRowHeight.record Record to determine row height for
|
|
327
302
|
* @returns {number} Desired row height
|
|
328
303
|
*/
|
|
329
|
-
getRowHeight ? : (
|
|
304
|
+
getRowHeight ? : () => number
|
|
330
305
|
/**
|
|
331
306
|
* 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`.
|
|
332
|
-
* ...
|
|
333
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-header)
|
|
307
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-header)
|
|
334
308
|
*/
|
|
335
309
|
header ? : string|Boolean|PanelHeader
|
|
336
310
|
/**
|
|
@@ -370,16 +344,14 @@ export declare type BryntumVersionGridProps = {
|
|
|
370
344
|
id ? : string
|
|
371
345
|
/**
|
|
372
346
|
* Determines if the widgets read-only state should be controlled by its parent.
|
|
373
|
-
* ...
|
|
374
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-ignoreParentReadOnly)
|
|
347
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-ignoreParentReadOnly)
|
|
375
348
|
*/
|
|
376
349
|
ignoreParentReadOnly ? : Boolean
|
|
377
350
|
/**
|
|
378
351
|
* Convenience setting to align input fields of child widgets. By default, the Field input element is
|
|
379
352
|
* placed immediately following the `label`. If you prefer to have all input fields aligned to the
|
|
380
353
|
* right, set this config to `'end'`.
|
|
381
|
-
* ...
|
|
382
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-inputFieldAlign)
|
|
354
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-inputFieldAlign)
|
|
383
355
|
*/
|
|
384
356
|
inputFieldAlign ? : 'start'|'end'
|
|
385
357
|
/**
|
|
@@ -396,14 +368,17 @@ export declare type BryntumVersionGridProps = {
|
|
|
396
368
|
keyMap ? : Record<string, KeyMapConfig>
|
|
397
369
|
/**
|
|
398
370
|
* Convenience setting to use same label placement on all child widgets.
|
|
399
|
-
* ...
|
|
400
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-labelPosition)
|
|
371
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-labelPosition)
|
|
401
372
|
*/
|
|
402
373
|
labelPosition ? : 'before'|'above'|'align-before'|'auto'|null
|
|
374
|
+
/**
|
|
375
|
+
* Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
|
|
376
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-labelWidth)
|
|
377
|
+
*/
|
|
378
|
+
labelWidth ? : number|null
|
|
403
379
|
/**
|
|
404
380
|
* The listener set for this object.
|
|
405
|
-
* ...
|
|
406
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-listeners)
|
|
381
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-listeners)
|
|
407
382
|
*/
|
|
408
383
|
listeners ? : VersionGridListeners
|
|
409
384
|
/**
|
|
@@ -416,15 +391,13 @@ export declare type BryntumVersionGridProps = {
|
|
|
416
391
|
* when data is loading. The message and optional configuration from the
|
|
417
392
|
* [loadMask](https://bryntum.com/products/schedulerpro/docs/api/Core/mixin/LoadMaskable#config-loadMask) config take priority over these options, just as they do
|
|
418
393
|
* for `maskDefaults`, respectively.
|
|
419
|
-
* ...
|
|
420
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-loadMaskDefaults)
|
|
394
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-loadMaskDefaults)
|
|
421
395
|
*/
|
|
422
396
|
loadMaskDefaults ? : MaskConfig
|
|
423
397
|
/**
|
|
424
398
|
* A [Mask](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Mask) config object to adjust the [maskDefaults](#Core/widget/Widget#config-maskDefaults)
|
|
425
399
|
* when an error occurs loading data.
|
|
426
|
-
* ...
|
|
427
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-loadMaskError)
|
|
400
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-loadMaskError)
|
|
428
401
|
*/
|
|
429
402
|
loadMaskError ? : MaskConfig|Mask|Boolean
|
|
430
403
|
/**
|
|
@@ -462,8 +435,7 @@ export declare type BryntumVersionGridProps = {
|
|
|
462
435
|
/**
|
|
463
436
|
* Grid's `min-height`. Defaults to `10em` to be sure that the Grid always has a height wherever it is
|
|
464
437
|
* inserted.
|
|
465
|
-
* ...
|
|
466
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-minHeight)
|
|
438
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-minHeight)
|
|
467
439
|
*/
|
|
468
440
|
minHeight ? : string|number
|
|
469
441
|
/**
|
|
@@ -478,7 +450,7 @@ export declare type BryntumVersionGridProps = {
|
|
|
478
450
|
/**
|
|
479
451
|
* Specify plugins (an array of classes) in config
|
|
480
452
|
*/
|
|
481
|
-
plugins ? :
|
|
453
|
+
plugins ? : InstancePlugin[]|InstancePlugin
|
|
482
454
|
/**
|
|
483
455
|
* True to preserve focused cell after loading new data
|
|
484
456
|
*/
|
|
@@ -504,54 +476,61 @@ export declare type BryntumVersionGridProps = {
|
|
|
504
476
|
project ? : ProjectModel|object
|
|
505
477
|
/**
|
|
506
478
|
* Set to `true` to make the grid read-only, by disabling any UIs for modifying data.
|
|
507
|
-
* ...
|
|
508
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-readOnly)
|
|
479
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-readOnly)
|
|
509
480
|
*/
|
|
510
481
|
readOnly ? : Boolean
|
|
511
482
|
relayStoreEvents ? : Boolean
|
|
512
483
|
/**
|
|
513
484
|
* Either a default `rendition` to apply to all child widgets, or a map of renditions keyed by child widget
|
|
514
485
|
* `type`.
|
|
515
|
-
* ...
|
|
516
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-rendition)
|
|
486
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-rendition)
|
|
517
487
|
*/
|
|
518
488
|
rendition ? : string|Record<string, string>|null
|
|
519
489
|
/**
|
|
520
490
|
* Configure this property to allow the widget/component to be resized. Pressing <kbd>Shift</kbd> while resizing will
|
|
521
491
|
* constrain the aspect ratio.
|
|
522
|
-
* ...
|
|
523
|
-
* [
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
492
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-resizable)
|
|
493
|
+
* @property {number} [resizable.minWidth] The minimum width of the element.
|
|
494
|
+
* @property {number} [resizable.maxWidth] The maximum width of the element.
|
|
495
|
+
* @property {number} [resizable.minHeight] The minimum height of the element.
|
|
496
|
+
* @property {number} [resizable.maxHeight] The maximum height of the element
|
|
497
|
+
* @property {object} [resizable.handles] An object controlling which edges/corners are resizable.
|
|
498
|
+
* @property {boolean} [resizable.handles.topStart] Resizable from top-start corner
|
|
499
|
+
* @property {boolean} [resizable.handles.top] Resizable from top edge
|
|
500
|
+
* @property {boolean} [resizable.handles.topEnd] Resizable from top-end corner
|
|
501
|
+
* @property {boolean} [resizable.handles.end] Resizable from end edge
|
|
502
|
+
* @property {boolean} [resizable.handles.bottomEnd] Resizable from bottom-end corner
|
|
503
|
+
* @property {boolean} [resizable.handles.bottom] Resizable from bottom edge
|
|
504
|
+
* @property {boolean} [resizable.handles.bottomStart] Resizable from bottom-start corner
|
|
505
|
+
* @property {boolean} [resizable.handles.start] Resizable from start edge
|
|
506
|
+
*/
|
|
507
|
+
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 } }
|
|
532
508
|
/**
|
|
533
509
|
* Set to `false` to only measure cell contents when double-clicking the edge between column headers.
|
|
534
510
|
*/
|
|
535
511
|
resizeToFitIncludesHeader ? : Boolean
|
|
536
512
|
/**
|
|
537
513
|
* "Break points" for which responsive config to use for columns and css.
|
|
538
|
-
* ...
|
|
539
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-responsiveLevels)
|
|
514
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-responsiveLevels)
|
|
540
515
|
*/
|
|
541
516
|
responsiveLevels ? : Record<string, number|string|ResponsiveLevelConfig>
|
|
542
517
|
/**
|
|
543
518
|
* Configure as `true` to have the component display a translucent ripple when its
|
|
544
519
|
* [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
|
|
545
520
|
* current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
|
|
546
|
-
* ...
|
|
547
|
-
* [
|
|
521
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-ripple)
|
|
522
|
+
* @property {string} [delegate] A CSS selector to filter which child elements trigger ripples. By default, the ripple is clipped to the triggering element.
|
|
523
|
+
* @property {string} [color] A CSS color name or specification.
|
|
524
|
+
* @property {number} [radius] The ending radius of the ripple. Note that it will be clipped by the target element by default.
|
|
525
|
+
* @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.
|
|
526
|
+
*/
|
|
527
|
+
ripple ? : Boolean|object
|
|
528
|
+
/**
|
|
529
|
+
* The ARIA role to apply to this widget's element. By default, this is set to `'presentation'` to avoid
|
|
530
|
+
* accidentally applying a role which may interfere with screen readers.
|
|
531
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-role)
|
|
548
532
|
*/
|
|
549
|
-
|
|
550
|
-
delegate?: string
|
|
551
|
-
color?: string
|
|
552
|
-
radius?: number
|
|
553
|
-
clip?: string
|
|
554
|
-
}
|
|
533
|
+
role ? : string
|
|
555
534
|
/**
|
|
556
535
|
* 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`
|
|
557
536
|
*/
|
|
@@ -560,8 +539,7 @@ export declare type BryntumVersionGridProps = {
|
|
|
560
539
|
* Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
|
|
561
540
|
* overridden by specifying a [rowHeight](https://bryntum.com/products/schedulerpro/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
|
|
562
541
|
* a column [renderer](https://bryntum.com/products/schedulerpro/docs/api/Grid/column/Column#config-renderer).
|
|
563
|
-
* ...
|
|
564
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-rowHeight)
|
|
542
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-rowHeight)
|
|
565
543
|
*/
|
|
566
544
|
rowHeight ? : number
|
|
567
545
|
/**
|
|
@@ -570,15 +548,13 @@ export declare type BryntumVersionGridProps = {
|
|
|
570
548
|
rowLines ? : Boolean
|
|
571
549
|
/**
|
|
572
550
|
* This may be configured as `true` to make the widget's element use the `direction:rtl` style.
|
|
573
|
-
* ...
|
|
574
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-rtl)
|
|
551
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-rtl)
|
|
575
552
|
*/
|
|
576
553
|
rtl ? : Boolean
|
|
577
554
|
/**
|
|
578
555
|
* 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).
|
|
579
556
|
* See the [scrollerClass](https://bryntum.com/products/schedulerpro/docs/api/Grid/view/GridBase#config-scrollerClass) config option.
|
|
580
|
-
* ...
|
|
581
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-scrollable)
|
|
557
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-scrollable)
|
|
582
558
|
*/
|
|
583
559
|
scrollable ? : Boolean|ScrollerConfig|Scroller
|
|
584
560
|
/**
|
|
@@ -593,20 +569,17 @@ export declare type BryntumVersionGridProps = {
|
|
|
593
569
|
/**
|
|
594
570
|
* Selection configuration settings, change these properties to control how selection works and what can be
|
|
595
571
|
* selected.
|
|
596
|
-
* ...
|
|
597
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-selectionMode)
|
|
572
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-selectionMode)
|
|
598
573
|
*/
|
|
599
574
|
selectionMode ? : GridSelectionMode
|
|
600
575
|
/**
|
|
601
576
|
* Configure as `true` to have the grid show a red "changed" tag in cells whose
|
|
602
577
|
* field value has changed and not yet been committed.
|
|
603
|
-
* ...
|
|
604
|
-
*
|
|
578
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-showDirty)
|
|
579
|
+
* @property {boolean} showDirty.duringEdit Set to `true` to show the red tag while editing a cell
|
|
580
|
+
* @property {boolean} showDirty.newRecord Set to `true` to show the red tag for all the cells of the new record
|
|
605
581
|
*/
|
|
606
|
-
showDirty ? : Boolean|{
|
|
607
|
-
duringEdit?: Boolean
|
|
608
|
-
newRecord?: Boolean
|
|
609
|
-
}
|
|
582
|
+
showDirty ? : Boolean|{ duringEdit: Boolean, newRecord: Boolean }
|
|
610
583
|
/**
|
|
611
584
|
* Whether to show only versions that have been assigned a specific name.
|
|
612
585
|
*/
|
|
@@ -625,121 +598,105 @@ export declare type BryntumVersionGridProps = {
|
|
|
625
598
|
span ? : number
|
|
626
599
|
/**
|
|
627
600
|
* This value can be one of the following:
|
|
628
|
-
* ...
|
|
629
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-stateful)
|
|
601
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-stateful)
|
|
630
602
|
*/
|
|
631
603
|
stateful ? : Boolean|object|string[]
|
|
632
604
|
/**
|
|
633
605
|
* The events that, when fired by this component, should trigger it to save its state by calling
|
|
634
606
|
* [saveState](https://bryntum.com/products/schedulerpro/docs/api/Core/mixin/State#function-saveState).
|
|
635
|
-
* ...
|
|
636
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-statefulEvents)
|
|
607
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-statefulEvents)
|
|
637
608
|
*/
|
|
638
609
|
statefulEvents ? : object|string[]
|
|
639
610
|
/**
|
|
640
611
|
* 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
|
|
641
612
|
* 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)
|
|
642
613
|
* (if explicitly specified) will be used as the `stateId`.
|
|
643
|
-
* ...
|
|
644
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-stateId)
|
|
614
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-stateId)
|
|
645
615
|
*/
|
|
646
616
|
stateId ? : string
|
|
647
617
|
/**
|
|
648
618
|
* 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`
|
|
649
619
|
* will be saved using the [default state provider](https://bryntum.com/products/schedulerpro/docs/api/Core/state/StateProvider#property-instance-static).
|
|
650
|
-
* ...
|
|
651
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-stateProvider)
|
|
620
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-stateProvider)
|
|
652
621
|
*/
|
|
653
622
|
stateProvider ? : StateProvider
|
|
654
623
|
/**
|
|
655
624
|
* The properties of this settings object controls how grid is restored from state data.
|
|
656
|
-
* ...
|
|
657
|
-
* [
|
|
625
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-stateSettings)
|
|
626
|
+
* @property {boolean} [restoreUnconfiguredColumns] Determines whether to restore columns from the state that are not explicitly defined in the grid configuration.
|
|
658
627
|
*/
|
|
659
|
-
stateSettings ? :
|
|
660
|
-
restoreUnconfiguredColumns?: Boolean
|
|
661
|
-
}
|
|
628
|
+
stateSettings ? : object
|
|
662
629
|
/**
|
|
663
630
|
* The store instance or config object that holds the records to be displayed by this TreeGrid. If assigning
|
|
664
631
|
* a store instance, it must be configured with `tree: true`.
|
|
665
|
-
* ...
|
|
666
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-store)
|
|
632
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-store)
|
|
667
633
|
*/
|
|
668
634
|
store ? : Store|StoreConfig
|
|
669
635
|
/**
|
|
670
636
|
* An object containing widgets keyed by name. By default (when no `type` is given), strips are
|
|
671
637
|
* [toolbars](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Toolbar). If you want to pass an array, you can use
|
|
672
638
|
* the toolbar's [items](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Container#config-items).
|
|
673
|
-
* ...
|
|
674
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-strips)
|
|
639
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-strips)
|
|
675
640
|
*/
|
|
676
641
|
strips ? : Record<string, SchedulerProContainerItemConfig>
|
|
677
642
|
/**
|
|
678
643
|
* An object containing sub grid configuration objects keyed by a `region` property.
|
|
679
644
|
* By default, grid has a 'locked' region (if configured with locked columns) and a 'normal' region.
|
|
680
645
|
* The 'normal' region defaults to use `flex: 1`.
|
|
681
|
-
* ...
|
|
682
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-subGridConfigs)
|
|
646
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-subGridConfigs)
|
|
683
647
|
*/
|
|
684
648
|
subGridConfigs ? : Record<string, SubGridConfig>
|
|
685
649
|
/**
|
|
686
650
|
* A [Mask](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Mask) config object, or a message to be shown when Crud Manager
|
|
687
651
|
* is persisting changes on the server. Set to `null` to disable default sync mask.
|
|
688
|
-
* ...
|
|
689
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-syncMask)
|
|
652
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-syncMask)
|
|
690
653
|
*/
|
|
691
654
|
syncMask ? : string|MaskConfig|null
|
|
692
655
|
/**
|
|
693
656
|
* 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
|
|
694
657
|
* [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
|
|
695
658
|
* this widget:
|
|
696
|
-
* ...
|
|
697
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-tab)
|
|
659
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-tab)
|
|
698
660
|
*/
|
|
699
661
|
tab ? : Boolean|TabConfig
|
|
700
662
|
/**
|
|
701
663
|
* When this container is used as a tab in a TabPanel, these items are added to the
|
|
702
664
|
* [TabBar](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/TabBar) when this container is the active tab.
|
|
703
|
-
* ...
|
|
704
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-tabBarItems)
|
|
665
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-tabBarItems)
|
|
705
666
|
*/
|
|
706
667
|
tabBarItems ? : ToolbarItems[]|Widget[]
|
|
707
668
|
/**
|
|
708
669
|
* A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Toolbar),
|
|
709
670
|
* or array of config objects representing the child items of a Toolbar.
|
|
710
671
|
* This creates a toolbar docked to the top of the panel immediately below the header.
|
|
711
|
-
* ...
|
|
712
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-tbar)
|
|
672
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-tbar)
|
|
713
673
|
*/
|
|
714
674
|
tbar ? : (SchedulerProContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
|
|
715
675
|
/**
|
|
716
676
|
* A title to display in the header or owning TabPanel. Causes creation and docking of a header
|
|
717
677
|
* to the top if no header is configured.
|
|
718
|
-
* ...
|
|
719
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-title)
|
|
678
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-title)
|
|
720
679
|
*/
|
|
721
680
|
title ? : string
|
|
722
681
|
/**
|
|
723
682
|
* 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
|
|
724
683
|
* property name is the reference by which an instantiated tool may be retrieved from the live
|
|
725
684
|
* `[tools](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/mixin/Toolable#property-tools)` property.
|
|
726
|
-
* ...
|
|
727
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-tools)
|
|
685
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-tools)
|
|
728
686
|
*/
|
|
729
687
|
tools ? : Record<string, ToolConfig>|null
|
|
730
688
|
/**
|
|
731
689
|
* Configure UI transitions for various actions in the grid.
|
|
690
|
+
* @property {boolean} insertRecord Transition record insertions
|
|
691
|
+
* @property {boolean} removeRecord Transition record removals
|
|
692
|
+
* @property {boolean} toggleColumn Transition column visibility changes
|
|
693
|
+
* @property {boolean} expandCollapseColumn Transition parent/group column expand/collapse
|
|
694
|
+
* @property {boolean} toggleRegion Transition region expand/collapse
|
|
695
|
+
* @property {boolean} toggleTreeNode Transition tree node expand/collapse
|
|
696
|
+
* @property {boolean} toggleGroup Transition group expand/collapse
|
|
697
|
+
* @property {boolean} filterRemoval Transition row removals caused by filtering (under specific conditions)
|
|
732
698
|
*/
|
|
733
|
-
transition ? :
|
|
734
|
-
insertRecord?: Boolean
|
|
735
|
-
removeRecord?: Boolean
|
|
736
|
-
toggleColumn?: Boolean
|
|
737
|
-
expandCollapseColumn?: Boolean
|
|
738
|
-
toggleRegion?: Boolean
|
|
739
|
-
toggleTreeNode?: Boolean
|
|
740
|
-
toggleGroup?: Boolean
|
|
741
|
-
filterRemoval?: Boolean
|
|
742
|
-
}
|
|
699
|
+
transition ? : object
|
|
743
700
|
/**
|
|
744
701
|
* Animation transition duration in milliseconds.
|
|
745
702
|
*/
|
|
@@ -749,8 +706,7 @@ export declare type BryntumVersionGridProps = {
|
|
|
749
706
|
* Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
|
|
750
707
|
* as a space separated string, an array of strings, or as an object in which property names with truthy
|
|
751
708
|
* values are used as the class names.
|
|
752
|
-
* ...
|
|
753
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-ui)
|
|
709
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-ui)
|
|
754
710
|
*/
|
|
755
711
|
ui ? : 'plain'|'toolbar'|string|object
|
|
756
712
|
/**
|
|
@@ -771,129 +727,117 @@ export declare type BryntumVersionGridProps = {
|
|
|
771
727
|
* agent and see the responses. Which allows the user to use natural language to interact with the Grid in different
|
|
772
728
|
* ways. For example, the user can ask the agent to filter the data, sort it, or select specific records. The agent can
|
|
773
729
|
* also perform data manipulation operations such as adding, updating, deleting records.
|
|
774
|
-
* ...
|
|
775
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/AI)
|
|
730
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/AI)
|
|
776
731
|
*/
|
|
777
732
|
aiFeature ? : object|Boolean|string|GridAI|GridAIConfig
|
|
778
733
|
/**
|
|
779
734
|
* AI-powered filter feature for Grid. Allows users to type natural language queries to filter grid data.
|
|
780
|
-
* ...
|
|
781
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ai/AIFilter)
|
|
735
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ai/AIFilter)
|
|
782
736
|
*/
|
|
783
737
|
aiFilterFeature ? : object|Boolean|string|AIFilter|AIFilterConfig
|
|
784
738
|
/**
|
|
785
739
|
* Allows using `[Ctrl/CMD + C]`, `[Ctrl/CMD + X]` and `[Ctrl/CMD + V]` to cut, copy and paste cell or cell ranges. Also
|
|
786
740
|
* makes cut, copy and paste actions available via the cell context menu.
|
|
787
|
-
* ...
|
|
788
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellCopyPaste)
|
|
741
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellCopyPaste)
|
|
789
742
|
*/
|
|
790
743
|
cellCopyPasteFeature ? : object|Boolean|string|CellCopyPaste|CellCopyPasteConfig
|
|
791
744
|
/**
|
|
792
745
|
* Adding this feature to the grid and other Bryntum products which are based on the Grid (i.e. Scheduler, SchedulerPro, and Gantt)
|
|
793
746
|
* enables cell editing. Any subclass of [Field](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Field) can be used
|
|
794
747
|
* as editor for the [Column](https://bryntum.com/products/schedulerpro/docs/api/Grid/column/Column). The most popular are:
|
|
795
|
-
* ...
|
|
796
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellEdit)
|
|
748
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellEdit)
|
|
797
749
|
*/
|
|
798
750
|
cellEditFeature ? : object|Boolean|string|GridCellEdit|GridCellEditConfig
|
|
799
751
|
/**
|
|
800
752
|
* Right click to display context menu for cells. To invoke the cell menu in a keyboard-accessible manner, use the
|
|
801
753
|
* <kbd>Space</kbd> key when the cell is focused.
|
|
802
|
-
* ...
|
|
803
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellMenu)
|
|
754
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellMenu)
|
|
804
755
|
*/
|
|
805
756
|
cellMenuFeature ? : object|Boolean|string|CellMenu|CellMenuConfig
|
|
806
757
|
/**
|
|
807
758
|
* Displays a tooltip when hovering cells.
|
|
808
|
-
* ...
|
|
809
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellTooltip)
|
|
759
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellTooltip)
|
|
810
760
|
*/
|
|
811
761
|
cellTooltipFeature ? : object|Boolean|string|CellTooltip|CellTooltipConfig
|
|
812
762
|
/**
|
|
813
763
|
* 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
|
|
814
764
|
* and updated in realtime as data changes. Supports many common chart types with extensive styling and customization
|
|
815
765
|
* options.
|
|
816
|
-
* ...
|
|
817
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Charts)
|
|
766
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Charts)
|
|
818
767
|
*/
|
|
819
768
|
chartsFeature ? : object|Boolean|string|Charts|ChartsConfig
|
|
820
769
|
/**
|
|
821
|
-
* Enables the [autoWidth](https://bryntum.com/products/schedulerpro/docs/api/Grid/column/Column#config-autoWidth) config for a grid's columns.
|
|
822
|
-
*
|
|
823
|
-
*
|
|
770
|
+
* Enables the [autoWidth](https://bryntum.com/products/schedulerpro/docs/api/Grid/column/Column#config-autoWidth) config for a grid's columns. When a column
|
|
771
|
+
* has `autoWidth` set, this feature measures the rendered content of all visible cells in that column
|
|
772
|
+
* and adjusts the column width to fit. The measurement is triggered automatically when data changes
|
|
773
|
+
* or rows are rendered.
|
|
774
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnAutoWidth)
|
|
824
775
|
*/
|
|
825
776
|
columnAutoWidthFeature ? : object|Boolean|string|ColumnAutoWidth|ColumnAutoWidthConfig
|
|
826
777
|
/**
|
|
827
778
|
* Displays a toolbar while dragging column headers. Drop on a button in the toolbar to activate a certain function,
|
|
828
779
|
* for example to group by that column. This feature simplifies certain operations on touch devices.
|
|
829
|
-
* ...
|
|
830
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnDragToolbar)
|
|
780
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnDragToolbar)
|
|
831
781
|
*/
|
|
832
782
|
columnDragToolbarFeature ? : object|Boolean|string|ColumnDragToolbar|ColumnDragToolbarConfig
|
|
833
783
|
/**
|
|
834
784
|
* Displays a column picker (to show/hide columns) in the header context menu. Columns can be displayed in sub menus
|
|
835
785
|
* by region or tag. Grouped headers are displayed as menu hierarchies.
|
|
836
|
-
* ...
|
|
837
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnPicker)
|
|
786
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnPicker)
|
|
838
787
|
*/
|
|
839
788
|
columnPickerFeature ? : object|Boolean|string|ColumnPicker|ColumnPickerConfig
|
|
840
789
|
/**
|
|
841
790
|
* Allows user to rename columns by either right-clicking column header or using keyboard shortcuts when column header
|
|
842
791
|
* is focused.
|
|
843
|
-
* ...
|
|
844
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnRename)
|
|
792
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnRename)
|
|
845
793
|
*/
|
|
846
794
|
columnRenameFeature ? : object|Boolean|string|ColumnRename|ColumnRenameConfig
|
|
847
795
|
/**
|
|
848
|
-
* Allows user to reorder columns by dragging headers.
|
|
849
|
-
*
|
|
850
|
-
*
|
|
851
|
-
* [
|
|
796
|
+
* Allows user to reorder columns by dragging headers. Click and drag a column header to move it to a new position.
|
|
797
|
+
* Visual feedback shows the drop target while dragging. To get notified about column reorder, listen to the
|
|
798
|
+
* `change` event on the [columns](https://bryntum.com/products/schedulerpro/docs/api/Grid/data/ColumnStore) store.
|
|
799
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnReorder)
|
|
852
800
|
*/
|
|
853
801
|
columnReorderFeature ? : object|Boolean|string|ColumnReorder|ColumnReorderConfig
|
|
854
802
|
/**
|
|
855
|
-
* Enables user to resize columns by dragging a handle on the right hand side of the header.
|
|
856
|
-
*
|
|
857
|
-
*
|
|
858
|
-
* [
|
|
803
|
+
* Enables user to resize columns by dragging a handle on the right hand side of the header. A drag handle
|
|
804
|
+
* appears when hovering near the right edge of a column header. Dragging it adjusts the column width, respecting
|
|
805
|
+
* any [minWidth](https://bryntum.com/products/schedulerpro/docs/api/Grid/column/Column#config-minWidth) or [maxWidth](#Grid/column/Column#config-maxWidth) constraints.
|
|
806
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnResize)
|
|
859
807
|
*/
|
|
860
808
|
columnResizeFeature ? : object|Boolean|string|ColumnResize|ColumnResizeConfig
|
|
861
809
|
/**
|
|
862
810
|
* A feature that allows exporting Grid data to Excel or CSV without involving the server. It uses
|
|
863
811
|
* [TableExporter](https://bryntum.com/products/schedulerpro/docs/api/Grid/util/TableExporter) class as data provider, 3rd party provider to generate XLS files, and
|
|
864
812
|
* [Microsoft XML specification](https://msdn.microsoft.com/en-us/library/office/documentformat.openxml.spreadsheet.aspx).
|
|
865
|
-
* ...
|
|
866
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/experimental/ExcelExporter)
|
|
813
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/experimental/ExcelExporter)
|
|
867
814
|
*/
|
|
868
815
|
excelExporterFeature ? : object|Boolean|string|GridExcelExporter|GridExcelExporterConfig
|
|
869
816
|
/**
|
|
870
|
-
* An experimental feature that lets users drop files on a Widget. The widget fires
|
|
871
|
-
* In the event, you get access to the raw
|
|
872
|
-
*
|
|
873
|
-
* [
|
|
817
|
+
* An experimental feature that lets users drop files on a Widget. The widget fires a
|
|
818
|
+
* [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
|
|
819
|
+
* files as strings, that were parsed by calling `readAsBinaryString`.
|
|
820
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/experimental/FileDrop)
|
|
874
821
|
*/
|
|
875
822
|
fileDropFeature ? : object|Boolean|string|FileDrop|FileDropConfig
|
|
876
823
|
/**
|
|
877
824
|
* This feature adds a fill handle to a Grid range selection, which when dragged, fills the cells being dragged over
|
|
878
825
|
* with values based on the values in the original selected range. This is similar to functionality normally seen in
|
|
879
826
|
* various spreadsheet applications.
|
|
880
|
-
* ...
|
|
881
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/FillHandle)
|
|
827
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/FillHandle)
|
|
882
828
|
*/
|
|
883
829
|
fillHandleFeature ? : object|Boolean|string|FillHandle|FillHandleConfig
|
|
884
830
|
/**
|
|
885
831
|
* Feature that allows filtering of the grid by settings filters on columns. The actual filtering is done by the store.
|
|
886
832
|
* For info on programmatically handling filters, see [StoreFilter](https://bryntum.com/products/schedulerpro/docs/api/Core/data/mixin/StoreFilter).
|
|
887
|
-
* ...
|
|
888
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Filter)
|
|
833
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Filter)
|
|
889
834
|
*/
|
|
890
835
|
filterFeature ? : object|Boolean|string|Filter|FilterConfig
|
|
891
836
|
/**
|
|
892
837
|
* Feature that allows filtering of the grid by entering filters on column headers.
|
|
893
838
|
* The actual filtering is done by the store.
|
|
894
839
|
* For info on programmatically handling filters, see [StoreFilter](https://bryntum.com/products/schedulerpro/docs/api/Core/data/mixin/StoreFilter).
|
|
895
|
-
* ...
|
|
896
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/FilterBar)
|
|
840
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/FilterBar)
|
|
897
841
|
*/
|
|
898
842
|
filterBarFeature ? : object|Boolean|string|FilterBar|FilterBarConfig
|
|
899
843
|
/**
|
|
@@ -901,141 +845,124 @@ export declare type BryntumVersionGridProps = {
|
|
|
901
845
|
* <kbd>Shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
|
|
902
846
|
* one anywhere on grid). Use <kbd>Shift</kbd> + <kbd>Alt</kbd> + click, or the context menu, to remove a column
|
|
903
847
|
* grouper.
|
|
904
|
-
* ...
|
|
905
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Group)
|
|
848
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Group)
|
|
906
849
|
*/
|
|
907
850
|
groupFeature ? : object|Boolean|string|Group|GroupConfig
|
|
908
851
|
/**
|
|
909
852
|
* Displays a summary row as a group footer in a grouped grid. Uses the same configuration options on columns as
|
|
910
853
|
* [Summary](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Summary).
|
|
911
|
-
* ...
|
|
912
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/GroupSummary)
|
|
854
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/GroupSummary)
|
|
913
855
|
*/
|
|
914
856
|
groupSummaryFeature ? : object|Boolean|string|GridGroupSummary|GridGroupSummaryConfig
|
|
915
857
|
/**
|
|
916
858
|
* Right click column header or focus it and press SPACE key to show the context menu for headers.
|
|
917
|
-
* ...
|
|
918
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/HeaderMenu)
|
|
859
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/HeaderMenu)
|
|
919
860
|
*/
|
|
920
861
|
headerMenuFeature ? : object|Boolean|string|HeaderMenu|HeaderMenuConfig
|
|
921
862
|
/**
|
|
922
863
|
* This feature allows records which satisfy a certain condition to be locked at the top of the grid.
|
|
923
|
-
* ...
|
|
924
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/LockRows)
|
|
864
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/LockRows)
|
|
925
865
|
*/
|
|
926
866
|
lockRowsFeature ? : object|Boolean|string|GridLockRows|GridLockRowsConfig
|
|
927
867
|
/**
|
|
928
868
|
* 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
|
|
929
869
|
* configured to [mergeCells](https://bryntum.com/products/schedulerpro/docs/api/Grid/column/Column#config-mergeCells).
|
|
930
|
-
* ...
|
|
931
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/MergeCells)
|
|
870
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/MergeCells)
|
|
932
871
|
*/
|
|
933
872
|
mergeCellsFeature ? : object|Boolean|string|MergeCells|MergeCellsConfig
|
|
934
873
|
/**
|
|
935
874
|
* Generates PDF/PNG files from the Grid component.
|
|
936
|
-
* ...
|
|
937
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/export/PdfExport)
|
|
875
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/export/PdfExport)
|
|
938
876
|
*/
|
|
939
877
|
pdfExportFeature ? : object|Boolean|string|GridPdfExport|GridPdfExportConfig
|
|
940
878
|
/**
|
|
941
879
|
* Allows pinning columns to the start or end region of the grid without any additional subGrid configurations.
|
|
942
880
|
* When pinning to a region that does not yet exist, the feature creates the required subGrid on the fly.
|
|
943
|
-
* ...
|
|
944
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/PinColumns)
|
|
881
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/PinColumns)
|
|
945
882
|
*/
|
|
946
883
|
pinColumnsFeature ? : object|Boolean|string|PinColumns|PinColumnsConfig
|
|
947
884
|
/**
|
|
948
885
|
* Allows printing Grid contents using browser print dialog.
|
|
949
|
-
* ...
|
|
950
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/export/Print)
|
|
886
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/export/Print)
|
|
951
887
|
*/
|
|
952
888
|
printFeature ? : object|Boolean|string|GridPrint|GridPrintConfig
|
|
953
889
|
/**
|
|
954
890
|
* Feature that allows the user to search in a column by focusing a cell and typing. Navigate between hits using the
|
|
955
|
-
* keyboard,
|
|
956
|
-
*
|
|
957
|
-
* [
|
|
891
|
+
* keyboard, <kbd>f3</kbd> or <kbd>ctrl</kbd>/<kbd>cmd</kbd> + <kbd>g</kbd> moves to next, also pressing
|
|
892
|
+
* <kbd>shift</kbd> moves to previous.
|
|
893
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/QuickFind)
|
|
958
894
|
*/
|
|
959
895
|
quickFindFeature ? : object|Boolean|string|QuickFind|QuickFindConfig
|
|
960
896
|
/**
|
|
961
897
|
* Makes the splitter between grid [sections](https://bryntum.com/products/schedulerpro/docs/api/Grid/view/SubGrid) draggable, to let users resize, and
|
|
962
898
|
* collapse/expand the sections.
|
|
963
|
-
* ...
|
|
964
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RegionResize)
|
|
899
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RegionResize)
|
|
965
900
|
*/
|
|
966
901
|
regionResizeFeature ? : object|Boolean|string|RegionResize|RegionResizeConfig
|
|
967
902
|
/**
|
|
968
903
|
* Allow using [Ctrl/CMD + C/X] and [Ctrl/CMD + V] to copy/cut-and-paste rows. Also makes cut, copy and paste actions
|
|
969
904
|
* available via the cell context menu.
|
|
970
|
-
* ...
|
|
971
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RowCopyPaste)
|
|
905
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RowCopyPaste)
|
|
972
906
|
*/
|
|
973
907
|
rowCopyPasteFeature ? : object|Boolean|string|RowCopyPaste|RowCopyPasteConfig
|
|
974
908
|
/**
|
|
975
909
|
* This feature allows editing of entire rows in a grid in a docked panel which by default slides out from the right.
|
|
976
|
-
* ...
|
|
977
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RowEdit)
|
|
910
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RowEdit)
|
|
978
911
|
*/
|
|
979
912
|
rowEditFeature ? : object|Boolean|string|RowEdit|RowEditConfig
|
|
980
913
|
/**
|
|
981
914
|
* Enables expanding of Grid rows by either row click or double click, or by adding a separate Grid column which renders
|
|
982
915
|
* a button that expands or collapses the row.
|
|
983
|
-
* ...
|
|
984
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RowExpander)
|
|
916
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RowExpander)
|
|
985
917
|
*/
|
|
986
918
|
rowExpanderFeature ? : object|Boolean|string|RowExpander|RowExpanderConfig
|
|
987
919
|
/**
|
|
988
920
|
* Allows user to reorder rows by dragging them. To get notified about row reorder listen to `change` event
|
|
989
921
|
* on the grid [store](https://bryntum.com/products/schedulerpro/docs/api/Core/data/Store).
|
|
990
|
-
* ...
|
|
991
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RowReorder)
|
|
922
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RowReorder)
|
|
992
923
|
*/
|
|
993
924
|
rowReorderFeature ? : object|Boolean|string|GridRowReorder|GridRowReorderConfig
|
|
994
925
|
/**
|
|
995
926
|
* 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)
|
|
996
927
|
* field of the record is updated (when [applyToAllRows](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RowResize#config-applyToAllRows) is `false`).
|
|
997
|
-
* ...
|
|
998
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RowResize)
|
|
928
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RowResize)
|
|
999
929
|
*/
|
|
1000
930
|
rowResizeFeature ? : object|Boolean|string|GridRowResize|GridRowResizeConfig
|
|
1001
931
|
/**
|
|
1002
932
|
* <div class="external-example vertical" data-file="Grid/feature/Search.js"></div>
|
|
1003
|
-
* ...
|
|
1004
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Search)
|
|
933
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Search)
|
|
1005
934
|
*/
|
|
1006
935
|
searchFeature ? : object|Boolean|string|Search|SearchConfig
|
|
1007
936
|
/**
|
|
1008
937
|
* Allows sorting of grid by clicking (or tapping) headers, also displays which columns grid is sorted by (numbered if
|
|
1009
938
|
* using multisort). Use modifier keys for multisorting: [Ctrl/CMD + click] to add sorter, [Ctrl/CMD + Alt + click] to remove sorter.
|
|
1010
939
|
* The actual sorting is done by the store, see [Store.sort()](https://bryntum.com/products/schedulerpro/docs/api/Core/data/mixin/StoreSort#function-sort).
|
|
1011
|
-
* ...
|
|
1012
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Sort)
|
|
940
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Sort)
|
|
1013
941
|
*/
|
|
1014
942
|
sortFeature ? : object|Boolean|string|Sort|SortConfig
|
|
1015
943
|
/**
|
|
1016
944
|
* This feature allows splitting the Grid into multiple views, either by using the cell context menu, or
|
|
1017
945
|
* programmatically by calling [split()](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Split#function-split).
|
|
1018
|
-
* ...
|
|
1019
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Split)
|
|
946
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Split)
|
|
1020
947
|
*/
|
|
1021
948
|
splitFeature ? : object|Boolean|string|GridSplit|GridSplitConfig
|
|
1022
949
|
/**
|
|
1023
|
-
* A feature which pins
|
|
1024
|
-
*
|
|
1025
|
-
*
|
|
1026
|
-
* [
|
|
950
|
+
* A feature which pins cell content to the top of the grid while the row scrolls off the top but is still visible. Very
|
|
951
|
+
* similar to native `position: sticky`, which because of Grid's multiple-region setup unfortunately cannot be used to
|
|
952
|
+
* achieve the same effect.
|
|
953
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/StickyCells)
|
|
1027
954
|
*/
|
|
1028
955
|
stickyCellsFeature ? : object|Boolean|string|StickyCells|StickyCellsConfig
|
|
1029
956
|
/**
|
|
1030
957
|
* Stripes rows by adding alternating CSS classes to all row elements (`b-even` and `b-odd`).
|
|
1031
|
-
*
|
|
1032
|
-
*
|
|
958
|
+
* This improves visual readability in data-heavy grids by giving adjacent rows different background colors.
|
|
959
|
+
* Style the striped rows using the `.b-even` and `.b-odd` CSS classes.
|
|
960
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Stripe)
|
|
1033
961
|
*/
|
|
1034
962
|
stripeFeature ? : object|Boolean|string|Stripe|StripeConfig
|
|
1035
963
|
/**
|
|
1036
964
|
* Displays a summary row in the grid footer.
|
|
1037
|
-
* ...
|
|
1038
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Summary)
|
|
965
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Summary)
|
|
1039
966
|
*/
|
|
1040
967
|
summaryFeature ? : object|Boolean|string|GridSummary|GridSummaryConfig
|
|
1041
968
|
/**
|
|
@@ -1043,15 +970,13 @@ export declare type BryntumVersionGridProps = {
|
|
|
1043
970
|
* 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
|
|
1044
971
|
* tree renderer that adds padding and icon to give the appearance of a tree. The original renderer is preserved and
|
|
1045
972
|
* also called.
|
|
1046
|
-
* ...
|
|
1047
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Tree)
|
|
973
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Tree)
|
|
1048
974
|
*/
|
|
1049
975
|
treeFeature ? : object|Boolean|string|Tree|TreeConfig
|
|
1050
976
|
/**
|
|
1051
977
|
* A feature that allows transforming a flat dataset (or the leaves of a hierarchical) into a tree by specifying a
|
|
1052
978
|
* record field per parent level. Parents are generated based on each leaf's value for those fields.
|
|
1053
|
-
* ...
|
|
1054
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/TreeGroup)
|
|
979
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/TreeGroup)
|
|
1055
980
|
*/
|
|
1056
981
|
treeGroupFeature ? : object|Boolean|string|TreeGroup|TreeGroupConfig
|
|
1057
982
|
|