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