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