@bryntum/schedulerpro-vue-3-thin 7.2.4 → 7.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -9
- package/lib/chunks/{BhUeT19h.js → 7vz3cAx6.js} +9 -7
- package/lib/chunks/7vz3cAx6.js.map +1 -0
- package/lib/chunks/{9jfNe_y3.js → B1SaPsRu.js} +16 -8
- package/lib/chunks/B1SaPsRu.js.map +1 -0
- package/lib/chunks/{D4JDuI0s.js → B4dVznPx.js} +1 -8
- package/lib/chunks/B4dVznPx.js.map +1 -0
- package/lib/chunks/{DwzPrR90.js → B8GKehTJ.js} +10 -8
- package/lib/chunks/B8GKehTJ.js.map +1 -0
- package/lib/chunks/{C41opZKx.js → BhXv58eE.js} +23 -14
- package/lib/chunks/BhXv58eE.js.map +1 -0
- package/lib/chunks/{Dz-up1_i.js → BhfdqXGU.js} +10 -8
- package/lib/chunks/BhfdqXGU.js.map +1 -0
- package/lib/chunks/{CJFZbm_i.js → Bk2bIVfG.js} +25 -13
- package/lib/chunks/Bk2bIVfG.js.map +1 -0
- package/lib/chunks/{DlNFp5e-.js → C1vi1h_N.js} +13 -11
- package/lib/chunks/C1vi1h_N.js.map +1 -0
- package/lib/chunks/{DYBe70El.js → CEQZr1q6.js} +20 -11
- package/lib/chunks/CEQZr1q6.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/{BRGc8bUJ.js → Cb_akueu.js} +16 -13
- package/lib/chunks/Cb_akueu.js.map +1 -0
- package/lib/chunks/{BJPdcix1.js → Cc_DPp3S.js} +8 -6
- package/lib/chunks/Cc_DPp3S.js.map +1 -0
- package/lib/chunks/{BjTPjWi9.js → Cr5VTUbs.js} +10 -8
- package/lib/chunks/Cr5VTUbs.js.map +1 -0
- package/lib/chunks/{j8JzZ-07.js → D-hmgVVF.js} +13 -11
- package/lib/chunks/D-hmgVVF.js.map +1 -0
- package/lib/chunks/{BpAvqwr_.js → D-v-Wqj4.js} +25 -13
- package/lib/chunks/D-v-Wqj4.js.map +1 -0
- package/lib/chunks/{BbI7XKMd.js → D0hJ3P6L.js} +5 -3
- package/lib/chunks/D0hJ3P6L.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/{CuODT2-U.js → XQWZfDOm.js} +7 -5
- package/lib/chunks/XQWZfDOm.js.map +1 -0
- package/lib/chunks/{MOjUZ-Rj.js → eKXSEOkn.js} +7 -5
- package/lib/chunks/eKXSEOkn.js.map +1 -0
- package/lib/chunks/{DGV7a5Xo.js → edcDjaO2.js} +7 -5
- package/lib/chunks/edcDjaO2.js.map +1 -0
- package/lib/chunks/{BO8FwQoh.js → n2IZFQjR.js} +10 -8
- package/lib/chunks/n2IZFQjR.js.map +1 -0
- package/lib/chunks/{M0cBUV91.js → zY4Qxi9x.js} +8 -6
- package/lib/chunks/zY4Qxi9x.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 +191 -292
- package/src/components/BryntumCalendarEditorProps.ts +123 -177
- package/src/components/BryntumCalendarField.vue +172 -260
- package/src/components/BryntumCalendarFieldProps.ts +96 -143
- package/src/components/BryntumConstraintTypePicker.vue +172 -260
- package/src/components/BryntumConstraintTypePickerProps.ts +96 -143
- package/src/components/BryntumCostAccrualField.vue +172 -260
- package/src/components/BryntumCostAccrualFieldProps.ts +96 -143
- package/src/components/BryntumDependencyTypePicker.vue +172 -260
- package/src/components/BryntumDependencyTypePickerProps.ts +96 -143
- package/src/components/BryntumEffortField.vue +153 -224
- package/src/components/BryntumEffortFieldProps.ts +82 -114
- package/src/components/BryntumEndDateField.vue +159 -228
- package/src/components/BryntumEndDateFieldProps.ts +84 -114
- package/src/components/BryntumModelCombo.vue +172 -260
- package/src/components/BryntumModelComboProps.ts +96 -143
- package/src/components/BryntumRateTableField.vue +172 -260
- package/src/components/BryntumRateTableFieldProps.ts +96 -143
- package/src/components/BryntumResourceEditor.vue +190 -290
- package/src/components/BryntumResourceEditorProps.ts +122 -175
- package/src/components/BryntumResourceGrid.vue +730 -1045
- package/src/components/BryntumResourceGridProps.ts +192 -263
- package/src/components/BryntumResourceHistogram.vue +1098 -1539
- package/src/components/BryntumResourceHistogramProps.ts +292 -402
- package/src/components/BryntumResourceTypeField.vue +172 -260
- package/src/components/BryntumResourceTypeFieldProps.ts +96 -143
- package/src/components/BryntumResourceUtilization.vue +1114 -1561
- package/src/components/BryntumResourceUtilizationProps.ts +293 -404
- package/src/components/BryntumSchedulerPro.vue +2099 -2820
- package/src/components/BryntumSchedulerProBase.vue +2099 -2820
- package/src/components/BryntumSchedulerProBaseProps.ts +413 -556
- package/src/components/BryntumSchedulerProProjectModel.vue +192 -289
- package/src/components/BryntumSchedulerProProjectModelProps.ts +59 -88
- package/src/components/BryntumSchedulerProProps.ts +413 -556
- package/src/components/BryntumSchedulingDirectionPicker.vue +172 -260
- package/src/components/BryntumSchedulingDirectionPickerProps.ts +96 -143
- package/src/components/BryntumSchedulingModePicker.vue +173 -262
- package/src/components/BryntumSchedulingModePickerProps.ts +97 -145
- package/src/components/BryntumStartDateField.vue +161 -232
- package/src/components/BryntumStartDateFieldProps.ts +86 -118
- package/src/components/BryntumThemeCombo.vue +60 -0
- package/src/components/BryntumTimeline.vue +1846 -2517
- package/src/components/BryntumTimelineProps.ts +371 -519
- package/src/components/BryntumVersionGrid.vue +727 -1050
- 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,71 @@ 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
|
|
475
|
+
/**
|
|
476
|
+
* The project model class to use when creating the project instance. Override this to use a custom project
|
|
477
|
+
* model class. In SchedulerPro and Gantt, this is overridden to use their respective project model classes.
|
|
478
|
+
*/
|
|
479
|
+
projectModelClass ? : typeof ProjectModel
|
|
504
480
|
/**
|
|
505
481
|
* 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)
|
|
482
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceGrid#config-readOnly)
|
|
508
483
|
*/
|
|
509
484
|
readOnly ? : Boolean
|
|
510
485
|
relayStoreEvents ? : Boolean
|
|
511
486
|
/**
|
|
512
487
|
* Either a default `rendition` to apply to all child widgets, or a map of renditions keyed by child widget
|
|
513
488
|
* `type`.
|
|
514
|
-
* ...
|
|
515
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceGrid#config-rendition)
|
|
489
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceGrid#config-rendition)
|
|
516
490
|
*/
|
|
517
491
|
rendition ? : string|Record<string, string>|null
|
|
518
492
|
/**
|
|
519
493
|
* Configure this property to allow the widget/component to be resized. Pressing <kbd>Shift</kbd> while resizing will
|
|
520
494
|
* constrain the aspect ratio.
|
|
521
|
-
* ...
|
|
522
|
-
* [
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
|
|
495
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceGrid#config-resizable)
|
|
496
|
+
* @property {number} [resizable.minWidth] The minimum width of the element.
|
|
497
|
+
* @property {number} [resizable.maxWidth] The maximum width of the element.
|
|
498
|
+
* @property {number} [resizable.minHeight] The minimum height of the element.
|
|
499
|
+
* @property {number} [resizable.maxHeight] The maximum height of the element
|
|
500
|
+
* @property {object} [resizable.handles] An object controlling which edges/corners are resizable.
|
|
501
|
+
* @property {boolean} [resizable.handles.topStart] Resizable from top-start corner
|
|
502
|
+
* @property {boolean} [resizable.handles.top] Resizable from top edge
|
|
503
|
+
* @property {boolean} [resizable.handles.topEnd] Resizable from top-end corner
|
|
504
|
+
* @property {boolean} [resizable.handles.end] Resizable from end edge
|
|
505
|
+
* @property {boolean} [resizable.handles.bottomEnd] Resizable from bottom-end corner
|
|
506
|
+
* @property {boolean} [resizable.handles.bottom] Resizable from bottom edge
|
|
507
|
+
* @property {boolean} [resizable.handles.bottomStart] Resizable from bottom-start corner
|
|
508
|
+
* @property {boolean} [resizable.handles.start] Resizable from start edge
|
|
509
|
+
*/
|
|
510
|
+
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
511
|
/**
|
|
532
512
|
* Set to `false` to only measure cell contents when double-clicking the edge between column headers.
|
|
533
513
|
*/
|
|
534
514
|
resizeToFitIncludesHeader ? : Boolean
|
|
535
515
|
/**
|
|
536
516
|
* "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)
|
|
517
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceGrid#config-responsiveLevels)
|
|
539
518
|
*/
|
|
540
519
|
responsiveLevels ? : Record<string, number|string|ResponsiveLevelConfig>
|
|
541
520
|
/**
|
|
542
521
|
* Configure as `true` to have the component display a translucent ripple when its
|
|
543
522
|
* [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
523
|
* current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
|
|
545
|
-
* ...
|
|
546
|
-
* [
|
|
524
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceGrid#config-ripple)
|
|
525
|
+
* @property {string} [delegate] A CSS selector to filter which child elements trigger ripples. By default, the ripple is clipped to the triggering element.
|
|
526
|
+
* @property {string} [color] A CSS color name or specification.
|
|
527
|
+
* @property {number} [radius] The ending radius of the ripple. Note that it will be clipped by the target element by default.
|
|
528
|
+
* @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.
|
|
529
|
+
*/
|
|
530
|
+
ripple ? : Boolean|object
|
|
531
|
+
/**
|
|
532
|
+
* The ARIA role to apply to this widget's element. By default, this is set to `'presentation'` to avoid
|
|
533
|
+
* accidentally applying a role which may interfere with screen readers.
|
|
534
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceGrid#config-role)
|
|
547
535
|
*/
|
|
548
|
-
|
|
549
|
-
delegate?: string
|
|
550
|
-
color?: string
|
|
551
|
-
radius?: number
|
|
552
|
-
clip?: string
|
|
553
|
-
}
|
|
536
|
+
role ? : string
|
|
554
537
|
/**
|
|
555
538
|
* 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
539
|
*/
|
|
@@ -559,8 +542,7 @@ export declare type BryntumResourceGridProps = {
|
|
|
559
542
|
* Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
|
|
560
543
|
* 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
544
|
* 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)
|
|
545
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceGrid#config-rowHeight)
|
|
564
546
|
*/
|
|
565
547
|
rowHeight ? : number
|
|
566
548
|
/**
|
|
@@ -569,15 +551,13 @@ export declare type BryntumResourceGridProps = {
|
|
|
569
551
|
rowLines ? : Boolean
|
|
570
552
|
/**
|
|
571
553
|
* 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)
|
|
554
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceGrid#config-rtl)
|
|
574
555
|
*/
|
|
575
556
|
rtl ? : Boolean
|
|
576
557
|
/**
|
|
577
558
|
* 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
559
|
* 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)
|
|
560
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceGrid#config-scrollable)
|
|
581
561
|
*/
|
|
582
562
|
scrollable ? : Boolean|ScrollerConfig|Scroller
|
|
583
563
|
/**
|
|
@@ -592,141 +572,122 @@ export declare type BryntumResourceGridProps = {
|
|
|
592
572
|
/**
|
|
593
573
|
* Selection configuration settings, change these properties to control how selection works and what can be
|
|
594
574
|
* selected.
|
|
595
|
-
* ...
|
|
596
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceGrid#config-selectionMode)
|
|
575
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceGrid#config-selectionMode)
|
|
597
576
|
*/
|
|
598
577
|
selectionMode ? : GridSelectionMode
|
|
599
578
|
/**
|
|
600
579
|
* Configure as `true` to have the grid show a red "changed" tag in cells whose
|
|
601
580
|
* field value has changed and not yet been committed.
|
|
602
|
-
* ...
|
|
603
|
-
*
|
|
581
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceGrid#config-showDirty)
|
|
582
|
+
* @property {boolean} showDirty.duringEdit Set to `true` to show the red tag while editing a cell
|
|
583
|
+
* @property {boolean} showDirty.newRecord Set to `true` to show the red tag for all the cells of the new record
|
|
604
584
|
*/
|
|
605
|
-
showDirty ? : Boolean|{
|
|
606
|
-
duringEdit?: Boolean
|
|
607
|
-
newRecord?: Boolean
|
|
608
|
-
}
|
|
585
|
+
showDirty ? : Boolean|{ duringEdit: Boolean, newRecord: Boolean }
|
|
609
586
|
/**
|
|
610
587
|
* Programmatic control over how many columns to span when used in a grid layout.
|
|
611
588
|
*/
|
|
612
589
|
span ? : number
|
|
613
590
|
/**
|
|
614
591
|
* 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)
|
|
592
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceGrid#config-stateful)
|
|
617
593
|
*/
|
|
618
594
|
stateful ? : Boolean|object|string[]
|
|
619
595
|
/**
|
|
620
596
|
* The events that, when fired by this component, should trigger it to save its state by calling
|
|
621
597
|
* [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)
|
|
598
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceGrid#config-statefulEvents)
|
|
624
599
|
*/
|
|
625
600
|
statefulEvents ? : object|string[]
|
|
626
601
|
/**
|
|
627
602
|
* 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
603
|
* 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
604
|
* (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)
|
|
605
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceGrid#config-stateId)
|
|
632
606
|
*/
|
|
633
607
|
stateId ? : string
|
|
634
608
|
/**
|
|
635
609
|
* 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
610
|
* 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)
|
|
611
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceGrid#config-stateProvider)
|
|
639
612
|
*/
|
|
640
613
|
stateProvider ? : StateProvider
|
|
641
614
|
/**
|
|
642
615
|
* The properties of this settings object controls how grid is restored from state data.
|
|
643
|
-
* ...
|
|
644
|
-
* [
|
|
616
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceGrid#config-stateSettings)
|
|
617
|
+
* @property {boolean} [restoreUnconfiguredColumns] Determines whether to restore columns from the state that are not explicitly defined in the grid configuration.
|
|
645
618
|
*/
|
|
646
|
-
stateSettings ? :
|
|
647
|
-
restoreUnconfiguredColumns?: Boolean
|
|
648
|
-
}
|
|
619
|
+
stateSettings ? : object
|
|
649
620
|
/**
|
|
650
621
|
* Store that holds records to display in the grid, or a store config object. If the configuration contains
|
|
651
622
|
* a `readUrl`, an `AjaxStore` will be created.
|
|
652
|
-
* ...
|
|
653
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceGrid#config-store)
|
|
623
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceGrid#config-store)
|
|
654
624
|
*/
|
|
655
625
|
store ? : Store|StoreConfig|AjaxStore|AjaxStoreConfig
|
|
656
626
|
/**
|
|
657
627
|
* An object containing widgets keyed by name. By default (when no `type` is given), strips are
|
|
658
628
|
* [toolbars](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Toolbar). If you want to pass an array, you can use
|
|
659
629
|
* 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)
|
|
630
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceGrid#config-strips)
|
|
662
631
|
*/
|
|
663
632
|
strips ? : Record<string, SchedulerProContainerItemConfig>
|
|
664
633
|
/**
|
|
665
634
|
* An object containing sub grid configuration objects keyed by a `region` property.
|
|
666
635
|
* By default, grid has a 'locked' region (if configured with locked columns) and a 'normal' region.
|
|
667
636
|
* 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)
|
|
637
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceGrid#config-subGridConfigs)
|
|
670
638
|
*/
|
|
671
639
|
subGridConfigs ? : Record<string, SubGridConfig>
|
|
672
640
|
/**
|
|
673
641
|
* A [Mask](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Mask) config object, or a message to be shown when Crud Manager
|
|
674
642
|
* 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)
|
|
643
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceGrid#config-syncMask)
|
|
677
644
|
*/
|
|
678
645
|
syncMask ? : string|MaskConfig|null
|
|
679
646
|
/**
|
|
680
647
|
* 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
648
|
* [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
649
|
* this widget:
|
|
683
|
-
* ...
|
|
684
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceGrid#config-tab)
|
|
650
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceGrid#config-tab)
|
|
685
651
|
*/
|
|
686
652
|
tab ? : Boolean|TabConfig
|
|
687
653
|
/**
|
|
688
654
|
* When this container is used as a tab in a TabPanel, these items are added to the
|
|
689
655
|
* [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)
|
|
656
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceGrid#config-tabBarItems)
|
|
692
657
|
*/
|
|
693
658
|
tabBarItems ? : ToolbarItems[]|Widget[]
|
|
694
659
|
/**
|
|
695
660
|
* A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Toolbar),
|
|
696
661
|
* or array of config objects representing the child items of a Toolbar.
|
|
697
662
|
* 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)
|
|
663
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceGrid#config-tbar)
|
|
700
664
|
*/
|
|
701
665
|
tbar ? : (SchedulerProContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
|
|
702
666
|
/**
|
|
703
667
|
* A title to display in the header or owning TabPanel. Causes creation and docking of a header
|
|
704
668
|
* 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)
|
|
669
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceGrid#config-title)
|
|
707
670
|
*/
|
|
708
671
|
title ? : string
|
|
709
672
|
/**
|
|
710
673
|
* 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
674
|
* property name is the reference by which an instantiated tool may be retrieved from the live
|
|
712
675
|
* `[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)
|
|
676
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceGrid#config-tools)
|
|
715
677
|
*/
|
|
716
678
|
tools ? : Record<string, ToolConfig>|null
|
|
717
679
|
/**
|
|
718
680
|
* Configure UI transitions for various actions in the grid.
|
|
681
|
+
* @property {boolean} insertRecord Transition record insertions
|
|
682
|
+
* @property {boolean} removeRecord Transition record removals
|
|
683
|
+
* @property {boolean} toggleColumn Transition column visibility changes
|
|
684
|
+
* @property {boolean} expandCollapseColumn Transition parent/group column expand/collapse
|
|
685
|
+
* @property {boolean} toggleRegion Transition region expand/collapse
|
|
686
|
+
* @property {boolean} toggleTreeNode Transition tree node expand/collapse
|
|
687
|
+
* @property {boolean} toggleGroup Transition group expand/collapse
|
|
688
|
+
* @property {boolean} filterRemoval Transition row removals caused by filtering (under specific conditions)
|
|
719
689
|
*/
|
|
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
|
-
}
|
|
690
|
+
transition ? : object
|
|
730
691
|
/**
|
|
731
692
|
* Animation transition duration in milliseconds.
|
|
732
693
|
*/
|
|
@@ -736,8 +697,7 @@ export declare type BryntumResourceGridProps = {
|
|
|
736
697
|
* Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
|
|
737
698
|
* as a space separated string, an array of strings, or as an object in which property names with truthy
|
|
738
699
|
* values are used as the class names.
|
|
739
|
-
* ...
|
|
740
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceGrid#config-ui)
|
|
700
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/ResourceGrid#config-ui)
|
|
741
701
|
*/
|
|
742
702
|
ui ? : 'plain'|'toolbar'|string|object
|
|
743
703
|
/**
|
|
@@ -758,129 +718,117 @@ export declare type BryntumResourceGridProps = {
|
|
|
758
718
|
* agent and see the responses. Which allows the user to use natural language to interact with the Grid in different
|
|
759
719
|
* ways. For example, the user can ask the agent to filter the data, sort it, or select specific records. The agent can
|
|
760
720
|
* 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)
|
|
721
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/AI)
|
|
763
722
|
*/
|
|
764
723
|
aiFeature ? : object|Boolean|string|GridAI|GridAIConfig
|
|
765
724
|
/**
|
|
766
725
|
* 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)
|
|
726
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ai/AIFilter)
|
|
769
727
|
*/
|
|
770
728
|
aiFilterFeature ? : object|Boolean|string|AIFilter|AIFilterConfig
|
|
771
729
|
/**
|
|
772
730
|
* Allows using `[Ctrl/CMD + C]`, `[Ctrl/CMD + X]` and `[Ctrl/CMD + V]` to cut, copy and paste cell or cell ranges. Also
|
|
773
731
|
* 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)
|
|
732
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellCopyPaste)
|
|
776
733
|
*/
|
|
777
734
|
cellCopyPasteFeature ? : object|Boolean|string|CellCopyPaste|CellCopyPasteConfig
|
|
778
735
|
/**
|
|
779
736
|
* Adding this feature to the grid and other Bryntum products which are based on the Grid (i.e. Scheduler, SchedulerPro, and Gantt)
|
|
780
737
|
* enables cell editing. Any subclass of [Field](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Field) can be used
|
|
781
738
|
* 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)
|
|
739
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellEdit)
|
|
784
740
|
*/
|
|
785
741
|
cellEditFeature ? : object|Boolean|string|GridCellEdit|GridCellEditConfig
|
|
786
742
|
/**
|
|
787
743
|
* Right click to display context menu for cells. To invoke the cell menu in a keyboard-accessible manner, use the
|
|
788
744
|
* <kbd>Space</kbd> key when the cell is focused.
|
|
789
|
-
* ...
|
|
790
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellMenu)
|
|
745
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellMenu)
|
|
791
746
|
*/
|
|
792
747
|
cellMenuFeature ? : object|Boolean|string|CellMenu|CellMenuConfig
|
|
793
748
|
/**
|
|
794
749
|
* Displays a tooltip when hovering cells.
|
|
795
|
-
* ...
|
|
796
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellTooltip)
|
|
750
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellTooltip)
|
|
797
751
|
*/
|
|
798
752
|
cellTooltipFeature ? : object|Boolean|string|CellTooltip|CellTooltipConfig
|
|
799
753
|
/**
|
|
800
754
|
* 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
755
|
* and updated in realtime as data changes. Supports many common chart types with extensive styling and customization
|
|
802
756
|
* options.
|
|
803
|
-
* ...
|
|
804
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Charts)
|
|
757
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Charts)
|
|
805
758
|
*/
|
|
806
759
|
chartsFeature ? : object|Boolean|string|Charts|ChartsConfig
|
|
807
760
|
/**
|
|
808
|
-
* Enables the [autoWidth](https://bryntum.com/products/schedulerpro/docs/api/Grid/column/Column#config-autoWidth) config for a grid's columns.
|
|
809
|
-
*
|
|
810
|
-
*
|
|
761
|
+
* Enables the [autoWidth](https://bryntum.com/products/schedulerpro/docs/api/Grid/column/Column#config-autoWidth) config for a grid's columns. When a column
|
|
762
|
+
* has `autoWidth` set, this feature measures the rendered content of all visible cells in that column
|
|
763
|
+
* and adjusts the column width to fit. The measurement is triggered automatically when data changes
|
|
764
|
+
* or rows are rendered.
|
|
765
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnAutoWidth)
|
|
811
766
|
*/
|
|
812
767
|
columnAutoWidthFeature ? : object|Boolean|string|ColumnAutoWidth|ColumnAutoWidthConfig
|
|
813
768
|
/**
|
|
814
769
|
* Displays a toolbar while dragging column headers. Drop on a button in the toolbar to activate a certain function,
|
|
815
770
|
* 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)
|
|
771
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnDragToolbar)
|
|
818
772
|
*/
|
|
819
773
|
columnDragToolbarFeature ? : object|Boolean|string|ColumnDragToolbar|ColumnDragToolbarConfig
|
|
820
774
|
/**
|
|
821
775
|
* Displays a column picker (to show/hide columns) in the header context menu. Columns can be displayed in sub menus
|
|
822
776
|
* 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)
|
|
777
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnPicker)
|
|
825
778
|
*/
|
|
826
779
|
columnPickerFeature ? : object|Boolean|string|ColumnPicker|ColumnPickerConfig
|
|
827
780
|
/**
|
|
828
781
|
* Allows user to rename columns by either right-clicking column header or using keyboard shortcuts when column header
|
|
829
782
|
* is focused.
|
|
830
|
-
* ...
|
|
831
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnRename)
|
|
783
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnRename)
|
|
832
784
|
*/
|
|
833
785
|
columnRenameFeature ? : object|Boolean|string|ColumnRename|ColumnRenameConfig
|
|
834
786
|
/**
|
|
835
|
-
* Allows user to reorder columns by dragging headers.
|
|
836
|
-
*
|
|
837
|
-
*
|
|
838
|
-
* [
|
|
787
|
+
* Allows user to reorder columns by dragging headers. Click and drag a column header to move it to a new position.
|
|
788
|
+
* Visual feedback shows the drop target while dragging. To get notified about column reorder, listen to the
|
|
789
|
+
* `change` event on the [columns](https://bryntum.com/products/schedulerpro/docs/api/Grid/data/ColumnStore) store.
|
|
790
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnReorder)
|
|
839
791
|
*/
|
|
840
792
|
columnReorderFeature ? : object|Boolean|string|ColumnReorder|ColumnReorderConfig
|
|
841
793
|
/**
|
|
842
|
-
* Enables user to resize columns by dragging a handle on the right hand side of the header.
|
|
843
|
-
*
|
|
844
|
-
*
|
|
845
|
-
* [
|
|
794
|
+
* Enables user to resize columns by dragging a handle on the right hand side of the header. A drag handle
|
|
795
|
+
* appears when hovering near the right edge of a column header. Dragging it adjusts the column width, respecting
|
|
796
|
+
* any [minWidth](https://bryntum.com/products/schedulerpro/docs/api/Grid/column/Column#config-minWidth) or [maxWidth](#Grid/column/Column#config-maxWidth) constraints.
|
|
797
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnResize)
|
|
846
798
|
*/
|
|
847
799
|
columnResizeFeature ? : object|Boolean|string|ColumnResize|ColumnResizeConfig
|
|
848
800
|
/**
|
|
849
801
|
* A feature that allows exporting Grid data to Excel or CSV without involving the server. It uses
|
|
850
802
|
* [TableExporter](https://bryntum.com/products/schedulerpro/docs/api/Grid/util/TableExporter) class as data provider, 3rd party provider to generate XLS files, and
|
|
851
803
|
* [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)
|
|
804
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/experimental/ExcelExporter)
|
|
854
805
|
*/
|
|
855
806
|
excelExporterFeature ? : object|Boolean|string|GridExcelExporter|GridExcelExporterConfig
|
|
856
807
|
/**
|
|
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
|
-
* [
|
|
808
|
+
* An experimental feature that lets users drop files on a Widget. The widget fires a
|
|
809
|
+
* [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
|
|
810
|
+
* files as strings, that were parsed by calling `readAsBinaryString`.
|
|
811
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/experimental/FileDrop)
|
|
861
812
|
*/
|
|
862
813
|
fileDropFeature ? : object|Boolean|string|FileDrop|FileDropConfig
|
|
863
814
|
/**
|
|
864
815
|
* This feature adds a fill handle to a Grid range selection, which when dragged, fills the cells being dragged over
|
|
865
816
|
* with values based on the values in the original selected range. This is similar to functionality normally seen in
|
|
866
817
|
* various spreadsheet applications.
|
|
867
|
-
* ...
|
|
868
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/FillHandle)
|
|
818
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/FillHandle)
|
|
869
819
|
*/
|
|
870
820
|
fillHandleFeature ? : object|Boolean|string|FillHandle|FillHandleConfig
|
|
871
821
|
/**
|
|
872
822
|
* Feature that allows filtering of the grid by settings filters on columns. The actual filtering is done by the store.
|
|
873
823
|
* 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)
|
|
824
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Filter)
|
|
876
825
|
*/
|
|
877
826
|
filterFeature ? : object|Boolean|string|Filter|FilterConfig
|
|
878
827
|
/**
|
|
879
828
|
* Feature that allows filtering of the grid by entering filters on column headers.
|
|
880
829
|
* The actual filtering is done by the store.
|
|
881
830
|
* 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)
|
|
831
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/FilterBar)
|
|
884
832
|
*/
|
|
885
833
|
filterBarFeature ? : object|Boolean|string|FilterBar|FilterBarConfig
|
|
886
834
|
/**
|
|
@@ -888,141 +836,124 @@ export declare type BryntumResourceGridProps = {
|
|
|
888
836
|
* <kbd>Shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
|
|
889
837
|
* one anywhere on grid). Use <kbd>Shift</kbd> + <kbd>Alt</kbd> + click, or the context menu, to remove a column
|
|
890
838
|
* grouper.
|
|
891
|
-
* ...
|
|
892
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Group)
|
|
839
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Group)
|
|
893
840
|
*/
|
|
894
841
|
groupFeature ? : object|Boolean|string|Group|GroupConfig
|
|
895
842
|
/**
|
|
896
843
|
* Displays a summary row as a group footer in a grouped grid. Uses the same configuration options on columns as
|
|
897
844
|
* [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)
|
|
845
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/GroupSummary)
|
|
900
846
|
*/
|
|
901
847
|
groupSummaryFeature ? : object|Boolean|string|GridGroupSummary|GridGroupSummaryConfig
|
|
902
848
|
/**
|
|
903
849
|
* 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)
|
|
850
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/HeaderMenu)
|
|
906
851
|
*/
|
|
907
852
|
headerMenuFeature ? : object|Boolean|string|HeaderMenu|HeaderMenuConfig
|
|
908
853
|
/**
|
|
909
854
|
* 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)
|
|
855
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/LockRows)
|
|
912
856
|
*/
|
|
913
857
|
lockRowsFeature ? : object|Boolean|string|GridLockRows|GridLockRowsConfig
|
|
914
858
|
/**
|
|
915
859
|
* 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
860
|
* 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)
|
|
861
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/MergeCells)
|
|
919
862
|
*/
|
|
920
863
|
mergeCellsFeature ? : object|Boolean|string|MergeCells|MergeCellsConfig
|
|
921
864
|
/**
|
|
922
865
|
* Generates PDF/PNG files from the Grid component.
|
|
923
|
-
* ...
|
|
924
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/export/PdfExport)
|
|
866
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/export/PdfExport)
|
|
925
867
|
*/
|
|
926
868
|
pdfExportFeature ? : object|Boolean|string|GridPdfExport|GridPdfExportConfig
|
|
927
869
|
/**
|
|
928
870
|
* Allows pinning columns to the start or end region of the grid without any additional subGrid configurations.
|
|
929
871
|
* 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)
|
|
872
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/PinColumns)
|
|
932
873
|
*/
|
|
933
874
|
pinColumnsFeature ? : object|Boolean|string|PinColumns|PinColumnsConfig
|
|
934
875
|
/**
|
|
935
876
|
* Allows printing Grid contents using browser print dialog.
|
|
936
|
-
* ...
|
|
937
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/export/Print)
|
|
877
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/export/Print)
|
|
938
878
|
*/
|
|
939
879
|
printFeature ? : object|Boolean|string|GridPrint|GridPrintConfig
|
|
940
880
|
/**
|
|
941
881
|
* 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
|
-
* [
|
|
882
|
+
* keyboard, <kbd>f3</kbd> or <kbd>ctrl</kbd>/<kbd>cmd</kbd> + <kbd>g</kbd> moves to next, also pressing
|
|
883
|
+
* <kbd>shift</kbd> moves to previous.
|
|
884
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/QuickFind)
|
|
945
885
|
*/
|
|
946
886
|
quickFindFeature ? : object|Boolean|string|QuickFind|QuickFindConfig
|
|
947
887
|
/**
|
|
948
888
|
* Makes the splitter between grid [sections](https://bryntum.com/products/schedulerpro/docs/api/Grid/view/SubGrid) draggable, to let users resize, and
|
|
949
889
|
* collapse/expand the sections.
|
|
950
|
-
* ...
|
|
951
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RegionResize)
|
|
890
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RegionResize)
|
|
952
891
|
*/
|
|
953
892
|
regionResizeFeature ? : object|Boolean|string|RegionResize|RegionResizeConfig
|
|
954
893
|
/**
|
|
955
894
|
* Allow using [Ctrl/CMD + C/X] and [Ctrl/CMD + V] to copy/cut-and-paste rows. Also makes cut, copy and paste actions
|
|
956
895
|
* available via the cell context menu.
|
|
957
|
-
* ...
|
|
958
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RowCopyPaste)
|
|
896
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RowCopyPaste)
|
|
959
897
|
*/
|
|
960
898
|
rowCopyPasteFeature ? : object|Boolean|string|RowCopyPaste|RowCopyPasteConfig
|
|
961
899
|
/**
|
|
962
900
|
* 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)
|
|
901
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RowEdit)
|
|
965
902
|
*/
|
|
966
903
|
rowEditFeature ? : object|Boolean|string|RowEdit|RowEditConfig
|
|
967
904
|
/**
|
|
968
905
|
* Enables expanding of Grid rows by either row click or double click, or by adding a separate Grid column which renders
|
|
969
906
|
* a button that expands or collapses the row.
|
|
970
|
-
* ...
|
|
971
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RowExpander)
|
|
907
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RowExpander)
|
|
972
908
|
*/
|
|
973
909
|
rowExpanderFeature ? : object|Boolean|string|RowExpander|RowExpanderConfig
|
|
974
910
|
/**
|
|
975
911
|
* Allows user to reorder rows by dragging them. To get notified about row reorder listen to `change` event
|
|
976
912
|
* 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)
|
|
913
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RowReorder)
|
|
979
914
|
*/
|
|
980
915
|
rowReorderFeature ? : object|Boolean|string|GridRowReorder|GridRowReorderConfig
|
|
981
916
|
/**
|
|
982
917
|
* 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
918
|
* 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)
|
|
919
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RowResize)
|
|
986
920
|
*/
|
|
987
921
|
rowResizeFeature ? : object|Boolean|string|GridRowResize|GridRowResizeConfig
|
|
988
922
|
/**
|
|
989
923
|
* <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)
|
|
924
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Search)
|
|
992
925
|
*/
|
|
993
926
|
searchFeature ? : object|Boolean|string|Search|SearchConfig
|
|
994
927
|
/**
|
|
995
928
|
* Allows sorting of grid by clicking (or tapping) headers, also displays which columns grid is sorted by (numbered if
|
|
996
929
|
* using multisort). Use modifier keys for multisorting: [Ctrl/CMD + click] to add sorter, [Ctrl/CMD + Alt + click] to remove sorter.
|
|
997
930
|
* 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)
|
|
931
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Sort)
|
|
1000
932
|
*/
|
|
1001
933
|
sortFeature ? : object|Boolean|string|Sort|SortConfig
|
|
1002
934
|
/**
|
|
1003
935
|
* This feature allows splitting the Grid into multiple views, either by using the cell context menu, or
|
|
1004
936
|
* 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)
|
|
937
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Split)
|
|
1007
938
|
*/
|
|
1008
939
|
splitFeature ? : object|Boolean|string|GridSplit|GridSplitConfig
|
|
1009
940
|
/**
|
|
1010
|
-
* A feature which pins
|
|
1011
|
-
*
|
|
1012
|
-
*
|
|
1013
|
-
* [
|
|
941
|
+
* A feature which pins cell content to the top of the grid while the row scrolls off the top but is still visible. Very
|
|
942
|
+
* similar to native `position: sticky`, which because of Grid's multiple-region setup unfortunately cannot be used to
|
|
943
|
+
* achieve the same effect.
|
|
944
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/StickyCells)
|
|
1014
945
|
*/
|
|
1015
946
|
stickyCellsFeature ? : object|Boolean|string|StickyCells|StickyCellsConfig
|
|
1016
947
|
/**
|
|
1017
948
|
* Stripes rows by adding alternating CSS classes to all row elements (`b-even` and `b-odd`).
|
|
1018
|
-
*
|
|
1019
|
-
*
|
|
949
|
+
* This improves visual readability in data-heavy grids by giving adjacent rows different background colors.
|
|
950
|
+
* Style the striped rows using the `.b-even` and `.b-odd` CSS classes.
|
|
951
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Stripe)
|
|
1020
952
|
*/
|
|
1021
953
|
stripeFeature ? : object|Boolean|string|Stripe|StripeConfig
|
|
1022
954
|
/**
|
|
1023
955
|
* Displays a summary row in the grid footer.
|
|
1024
|
-
* ...
|
|
1025
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Summary)
|
|
956
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Summary)
|
|
1026
957
|
*/
|
|
1027
958
|
summaryFeature ? : object|Boolean|string|GridSummary|GridSummaryConfig
|
|
1028
959
|
/**
|
|
@@ -1030,15 +961,13 @@ export declare type BryntumResourceGridProps = {
|
|
|
1030
961
|
* 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
962
|
* tree renderer that adds padding and icon to give the appearance of a tree. The original renderer is preserved and
|
|
1032
963
|
* also called.
|
|
1033
|
-
* ...
|
|
1034
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Tree)
|
|
964
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Tree)
|
|
1035
965
|
*/
|
|
1036
966
|
treeFeature ? : object|Boolean|string|Tree|TreeConfig
|
|
1037
967
|
/**
|
|
1038
968
|
* A feature that allows transforming a flat dataset (or the leaves of a hierarchical) into a tree by specifying a
|
|
1039
969
|
* 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)
|
|
970
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/TreeGroup)
|
|
1042
971
|
*/
|
|
1043
972
|
treeGroupFeature ? : object|Boolean|string|TreeGroup|TreeGroupConfig
|
|
1044
973
|
|