@bryntum/scheduler-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 +8 -8
- package/lib/chunks/{B0m0r-NV.js → BTSObfAz.js} +11 -9
- package/lib/chunks/BTSObfAz.js.map +1 -0
- package/lib/chunks/BXIuEgYD.js +265 -0
- package/lib/chunks/BXIuEgYD.js.map +1 -0
- package/lib/chunks/{DerP_qo7.js → CCTV8qn0.js} +18 -10
- package/lib/chunks/CCTV8qn0.js.map +1 -0
- package/lib/chunks/{CsoS615B.js → COFzBhB8.js} +11 -9
- package/lib/chunks/COFzBhB8.js.map +1 -0
- package/lib/chunks/{BD-Hg3lY.js → DB0UHrA3.js} +17 -24
- package/lib/chunks/DB0UHrA3.js.map +1 -0
- package/lib/chunks/{C7ZFK2B7.js → DJSlX0qP.js} +18 -10
- package/lib/chunks/DJSlX0qP.js.map +1 -0
- package/lib/chunks/{DmQj0tBi.js → DP61St-u.js} +14 -6
- package/lib/chunks/DP61St-u.js.map +1 -0
- package/lib/chunks/{mKqb8_2f.js → LNqNYJck.js} +9 -7
- package/lib/chunks/LNqNYJck.js.map +1 -0
- package/lib/chunks/{CP1Mm_Ak.js → R69sJLmF.js} +16 -17
- package/lib/chunks/R69sJLmF.js.map +1 -0
- package/lib/chunks/{BNGLBrCN.js → WykRcMCN.js} +7 -5
- package/lib/chunks/WykRcMCN.js.map +1 -0
- package/lib/chunks/{C0UqC4Uj.js → eUISgYXE.js} +9 -9
- package/lib/chunks/eUISgYXE.js.map +1 -0
- package/lib/chunks/{C2PT-Ukt.js → t8aiH3XL.js} +13 -14
- package/lib/chunks/t8aiH3XL.js.map +1 -0
- package/lib/components/BryntumEventColorField.js +1 -1
- package/lib/components/BryntumProjectCombo.js +1 -1
- package/lib/components/BryntumResourceCombo.js +1 -1
- package/lib/components/BryntumResourceFilter.js +1 -1
- package/lib/components/BryntumScheduler.js +1 -1
- package/lib/components/BryntumSchedulerBase.js +1 -1
- package/lib/components/BryntumSchedulerDatePicker.js +1 -1
- package/lib/components/BryntumSchedulerProjectModel.js +1 -1
- package/lib/components/BryntumThemeCombo.js +57 -0
- package/lib/components/BryntumThemeCombo.js.map +1 -0
- package/lib/components/BryntumTimeZoomSlider.js +5 -0
- package/lib/components/BryntumTimeZoomSlider.js.map +1 -0
- package/lib/components/BryntumTimelineHistogram.js +1 -1
- package/lib/components/BryntumUndoRedo.js +1 -1
- package/lib/components/BryntumViewPresetCombo.js +1 -1
- package/lib/index.js +18 -16
- package/lib/index.js.map +1 -1
- package/package.json +1 -1
- package/src/components/BryntumEventColorField.vue +152 -222
- package/src/components/BryntumEventColorFieldProps.ts +77 -108
- package/src/components/BryntumProjectCombo.vue +171 -258
- package/src/components/BryntumProjectComboProps.ts +95 -141
- package/src/components/BryntumResourceCombo.vue +172 -260
- package/src/components/BryntumResourceComboProps.ts +96 -143
- package/src/components/BryntumResourceFilter.vue +132 -211
- package/src/components/BryntumResourceFilterProps.ts +60 -98
- package/src/components/BryntumScheduler.vue +1847 -2520
- package/src/components/BryntumSchedulerBase.vue +1847 -2520
- package/src/components/BryntumSchedulerBaseProps.ts +372 -522
- package/src/components/BryntumSchedulerDatePicker.vue +205 -331
- package/src/components/BryntumSchedulerDatePickerProps.ts +116 -187
- package/src/components/BryntumSchedulerProjectModel.vue +23 -46
- package/src/components/BryntumSchedulerProjectModelProps.ts +10 -20
- package/src/components/BryntumSchedulerProps.ts +372 -522
- package/src/components/BryntumThemeCombo.vue +60 -0
- package/src/components/BryntumTimeZoomSlider.vue +829 -0
- package/src/components/BryntumTimeZoomSliderProps.ts +482 -0
- package/src/components/BryntumTimelineHistogram.vue +1034 -1461
- package/src/components/BryntumTimelineHistogramProps.ts +275 -388
- package/src/components/BryntumUndoRedo.vue +127 -204
- package/src/components/BryntumUndoRedoProps.ts +74 -116
- package/src/components/BryntumViewPresetCombo.vue +144 -210
- package/src/components/BryntumViewPresetComboProps.ts +72 -99
- package/src/index.ts +2 -0
- package/lib/chunks/B0m0r-NV.js.map +0 -1
- package/lib/chunks/BD-Hg3lY.js.map +0 -1
- package/lib/chunks/BNGLBrCN.js.map +0 -1
- package/lib/chunks/C0UqC4Uj.js.map +0 -1
- package/lib/chunks/C2PT-Ukt.js.map +0 -1
- package/lib/chunks/C7ZFK2B7.js.map +0 -1
- package/lib/chunks/CP1Mm_Ak.js.map +0 -1
- package/lib/chunks/CsoS615B.js.map +0 -1
- package/lib/chunks/DerP_qo7.js.map +0 -1
- package/lib/chunks/DmQj0tBi.js.map +0 -1
- package/lib/chunks/mKqb8_2f.js.map +0 -1
|
@@ -33,9 +33,9 @@
|
|
|
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, DurationUnit, FormulaProviderConfig, Histogram, HistogramConfig, HistogramSeries, 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, Tooltip, TooltipConfig, Widget } from '@bryntum/core-thin';
|
|
36
|
+
import type { AjaxStore, AjaxStoreConfig, Base, Color, Container, DomConfig, DurationUnit, FormulaProviderConfig, Histogram, HistogramConfig, HistogramSeries, 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, Tooltip, TooltipConfig, Widget } from '@bryntum/core-thin';
|
|
37
37
|
import type { AI as GridAI, AIConfig as GridAIConfig, AIFilter, AIFilterConfig, CellCopyPaste, CellCopyPasteConfig, CellEdit, CellEditConfig, 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, 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, RowResize as GridRowResize, RowResizeConfig as GridRowResizeConfig, Search, SearchConfig, Sort, SortConfig, StickyCells, StickyCellsConfig, Stripe, StripeConfig, SubGrid, SubGridConfig, Tree, TreeConfig, TreeGroup, TreeGroupConfig, XLSColumn } from '@bryntum/grid-thin';
|
|
38
|
-
import type { AssignmentModel, ColumnLines, ColumnLinesConfig, SchedulerContainerItemConfig, EventColor, EventModel, SchedulerColumnConfig, GroupSummary, GroupSummaryConfig, HeaderZoom, HeaderZoomConfig, HistogramRenderData, NonWorkingTime, NonWorkingTimeConfig, Pan, PanConfig, PdfExportConfig,
|
|
38
|
+
import type { AssignmentModel, ColumnLines, ColumnLinesConfig, SchedulerContainerItemConfig, EventColor, EventModel, SchedulerColumnConfig, GroupSummary, GroupSummaryConfig, HeaderZoom, HeaderZoomConfig, HistogramRenderData, NonWorkingTime, NonWorkingTimeConfig, Pan, PanConfig, PdfExportConfig, RecurrenceConfirmationPopupConfig, ResourceMenu, ResourceMenuConfig, ResourceModel, ResourceTimeRangeModel, ResourceTimeRanges, ResourceTimeRangesConfig, RowReorder, RowReorderConfig, ScaleColumnConfig, ScalePoint, ScheduleTooltip, ScheduleTooltipConfig, Scheduler, Split, SplitConfig, Summary, SummaryConfig, TimeAxis, TimeAxisColumn, TimeAxisConfig, TimeAxisHeaderMenu, TimeAxisHeaderMenuConfig, TimeRanges, TimeRangesConfig, TimeSpan, TimelineBase, TimelineContext, TimelineHistogramListeners, VerticalTimeAxisColumn, ViewPreset, ViewPresetConfig, VisibleDate } from '@bryntum/scheduler-thin';
|
|
39
39
|
import { TimelineHistogram } from '@bryntum/scheduler-thin';
|
|
40
40
|
|
|
41
41
|
import { WrapperHelper } from '../helper/WrapperHelper';
|
|
@@ -45,21 +45,19 @@ defineProps<{
|
|
|
45
45
|
/**
|
|
46
46
|
* Element (or element id) to adopt as this Widget's encapsulating element. The widget's
|
|
47
47
|
* content will be placed inside this element.
|
|
48
|
-
* ...
|
|
49
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-adopt)
|
|
48
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-adopt)
|
|
50
49
|
*/
|
|
51
50
|
adopt ? : HTMLElement|string
|
|
52
51
|
/**
|
|
53
52
|
* A function used for aggregating child records histogram data entries to their parent entry.
|
|
54
|
-
* ...
|
|
55
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-aggregateDataEntry)
|
|
53
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-aggregateDataEntry)
|
|
56
54
|
* @param {object} aggregateDataEntry.aggregated Target parent data entry to aggregate the entry into.
|
|
57
55
|
* @param {object} aggregateDataEntry.entry Current entry to aggregate into `aggregated`.
|
|
58
56
|
* @param {number} aggregateDataEntry.arrayIndex Index of current array (index of the record among other records being aggregated).
|
|
59
57
|
* @param {object[]} aggregateDataEntry.entryIndex Index of `entry` in the current array.
|
|
60
58
|
* @returns {object} Return value becomes the value of the `aggregated` parameter on the next invocation of this function.
|
|
61
59
|
*/
|
|
62
|
-
aggregateDataEntry ? : ((
|
|
60
|
+
aggregateDataEntry ? : (() => object)|string
|
|
63
61
|
/**
|
|
64
62
|
* When `true` the component will automatically calculate data for group records
|
|
65
63
|
* based on the groups members data by calling [getGroupRecordHistogramData](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineHistogramGrouping#function-getGroupRecordHistogramData) method.
|
|
@@ -97,15 +95,13 @@ defineProps<{
|
|
|
97
95
|
/**
|
|
98
96
|
* A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject
|
|
99
97
|
* into an element which will be linked using the `aria-describedby` attribute.
|
|
100
|
-
* ...
|
|
101
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-ariaDescription)
|
|
98
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-ariaDescription)
|
|
102
99
|
*/
|
|
103
100
|
ariaDescription ? : string
|
|
104
101
|
/**
|
|
105
102
|
* A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject as
|
|
106
103
|
* the `aria-label` attribute.
|
|
107
|
-
* ...
|
|
108
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-ariaLabel)
|
|
104
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-ariaLabel)
|
|
109
105
|
*/
|
|
110
106
|
ariaLabel ? : string
|
|
111
107
|
/**
|
|
@@ -121,8 +117,7 @@ defineProps<{
|
|
|
121
117
|
autoHeight ? : Boolean
|
|
122
118
|
/**
|
|
123
119
|
* Controls how much space to leave between stacked event bars in px.
|
|
124
|
-
* ...
|
|
125
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-barMargin)
|
|
120
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-barMargin)
|
|
126
121
|
*/
|
|
127
122
|
barMargin ? : number
|
|
128
123
|
/**
|
|
@@ -141,14 +136,12 @@ defineProps<{
|
|
|
141
136
|
/**
|
|
142
137
|
* A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/scheduler/docs/api/Core/widget/Toolbar),
|
|
143
138
|
* 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/scheduler/docs/api/Core/widget/Panel#config-strips).
|
|
144
|
-
* ...
|
|
145
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-bbar)
|
|
139
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-bbar)
|
|
146
140
|
*/
|
|
147
141
|
bbar ? : (SchedulerContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
|
|
148
142
|
/**
|
|
149
143
|
* Custom CSS classes to add to the panel's body element.
|
|
150
|
-
* ...
|
|
151
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-bodyCls)
|
|
144
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-bodyCls)
|
|
152
145
|
*/
|
|
153
146
|
bodyCls ? : string|object
|
|
154
147
|
/**
|
|
@@ -158,35 +151,30 @@ defineProps<{
|
|
|
158
151
|
/**
|
|
159
152
|
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
160
153
|
* hierarchy when triggered.
|
|
161
|
-
* ...
|
|
162
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-bubbleEvents)
|
|
154
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-bubbleEvents)
|
|
163
155
|
*/
|
|
164
156
|
bubbleEvents ? : object
|
|
165
157
|
/**
|
|
166
158
|
* This config defines the size of the start and end invisible parts of the timespan when [infiniteScroll](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineScroll#config-infiniteScroll) set to `true`.
|
|
167
|
-
* ...
|
|
168
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-bufferCoef)
|
|
159
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-bufferCoef)
|
|
169
160
|
*/
|
|
170
161
|
bufferCoef ? : number
|
|
171
162
|
/**
|
|
172
163
|
* This config defines the scroll limit, which, when exceeded will cause a timespan shift.
|
|
173
164
|
* The limit is calculated as the `panelWidth * [bufferCoef](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineScroll#config-bufferCoef) * bufferThreshold`. During scrolling, if the left or right side
|
|
174
165
|
* has less than that of the rendered content - a shift is triggered.
|
|
175
|
-
* ...
|
|
176
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-bufferThreshold)
|
|
166
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-bufferThreshold)
|
|
177
167
|
*/
|
|
178
168
|
bufferThreshold ? : number
|
|
179
169
|
/**
|
|
180
170
|
* Set to `false` to not call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
|
|
181
|
-
* ...
|
|
182
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-callOnFunctions)
|
|
171
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-callOnFunctions)
|
|
183
172
|
*/
|
|
184
173
|
callOnFunctions ? : Boolean
|
|
185
174
|
/**
|
|
186
175
|
* By default, if an event handler throws an exception, the error propagates up the stack and the
|
|
187
176
|
* application state is undefined. Code which follows the event handler will *not* be executed.
|
|
188
|
-
* ...
|
|
189
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-catchEventHandlerExceptions)
|
|
177
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-catchEventHandlerExceptions)
|
|
190
178
|
*/
|
|
191
179
|
catchEventHandlerExceptions ? : Boolean
|
|
192
180
|
/**
|
|
@@ -199,8 +187,7 @@ defineProps<{
|
|
|
199
187
|
* Custom CSS classes to add to element.
|
|
200
188
|
* May be specified as a space separated string, or as an object in which property names
|
|
201
189
|
* with truthy values are used as the class names:
|
|
202
|
-
* ...
|
|
203
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-cls)
|
|
190
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-cls)
|
|
204
191
|
*/
|
|
205
192
|
cls ? : string|object
|
|
206
193
|
/**
|
|
@@ -210,15 +197,13 @@ defineProps<{
|
|
|
210
197
|
collapsed ? : Boolean
|
|
211
198
|
/**
|
|
212
199
|
* This config enables collapsibility for the panel. See [collapsed](https://bryntum.com/products/scheduler/docs/api/Core/widget/Panel#config-collapsed).
|
|
213
|
-
* ...
|
|
214
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-collapsible)
|
|
200
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-collapsible)
|
|
215
201
|
*/
|
|
216
202
|
collapsible ? : Boolean|PanelCollapserConfig|PanelCollapserOverlayConfig
|
|
217
203
|
/**
|
|
218
204
|
* Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
|
|
219
205
|
* `style` block.
|
|
220
|
-
* ...
|
|
221
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-color)
|
|
206
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-color)
|
|
222
207
|
*/
|
|
223
208
|
color ? : Color
|
|
224
209
|
/**
|
|
@@ -232,8 +217,7 @@ defineProps<{
|
|
|
232
217
|
/**
|
|
233
218
|
* Accepts column definitions for the grid during initialization. They will be used to create
|
|
234
219
|
* [Column](https://bryntum.com/products/scheduler/docs/api/Grid/column/Column) instances that are added to a [ColumnStore](#Grid/data/ColumnStore).
|
|
235
|
-
* ...
|
|
236
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-columns)
|
|
220
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-columns)
|
|
237
221
|
*/
|
|
238
222
|
columns ? : ColumnStore|SchedulerColumnConfig[]|ColumnStoreConfig
|
|
239
223
|
config ? : object
|
|
@@ -241,8 +225,7 @@ defineProps<{
|
|
|
241
225
|
* Custom CSS classes to add to the [contentElement](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-contentElement).
|
|
242
226
|
* May be specified as a space separated string, or as an object in which property names
|
|
243
227
|
* with truthy values are used as the class names:
|
|
244
|
-
* ...
|
|
245
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-contentElementCls)
|
|
228
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-contentElementCls)
|
|
246
229
|
*/
|
|
247
230
|
contentElementCls ? : string|object
|
|
248
231
|
/**
|
|
@@ -254,8 +237,7 @@ defineProps<{
|
|
|
254
237
|
* Convenient shortcut to set data in grids store both during initialization and at runtime. Can also be
|
|
255
238
|
* used to retrieve data at runtime, although we do recommend interacting with Grids store instead using
|
|
256
239
|
* the [store](https://bryntum.com/products/scheduler/docs/api/Grid/view/GridBase#property-store) property.
|
|
257
|
-
* ...
|
|
258
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-data)
|
|
240
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-data)
|
|
259
241
|
*/
|
|
260
242
|
data ? : object[]|Model[]|ModelConfig[]
|
|
261
243
|
/**
|
|
@@ -265,8 +247,7 @@ defineProps<{
|
|
|
265
247
|
dataField ? : string
|
|
266
248
|
/**
|
|
267
249
|
* Record field from which the histogram data will be collected.
|
|
268
|
-
* ...
|
|
269
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-dataModelField)
|
|
250
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-dataModelField)
|
|
270
251
|
*/
|
|
271
252
|
dataModelField ? : string
|
|
272
253
|
/**
|
|
@@ -282,16 +263,15 @@ defineProps<{
|
|
|
282
263
|
*/
|
|
283
264
|
destroyStore ? : Boolean
|
|
284
265
|
/**
|
|
285
|
-
* Check for CSS compatibility issues
|
|
286
|
-
*
|
|
287
|
-
* [
|
|
266
|
+
* Check for CSS compatibility and inclusion related issues and try to auto fix them. Performs the following
|
|
267
|
+
* checks:
|
|
268
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-detectCSSCompatibilityIssues)
|
|
288
269
|
*/
|
|
289
270
|
detectCSSCompatibilityIssues ? : Boolean
|
|
290
271
|
/**
|
|
291
272
|
* Disable or enable the widget. It is similar to [readOnly](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-readOnly) except a disabled widget
|
|
292
273
|
* cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
|
|
293
|
-
* ...
|
|
294
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-disabled)
|
|
274
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-disabled)
|
|
295
275
|
*/
|
|
296
276
|
disabled ? : Boolean|'inert'
|
|
297
277
|
/**
|
|
@@ -309,8 +289,7 @@ defineProps<{
|
|
|
309
289
|
/**
|
|
310
290
|
* Defines how dates will be formatted in tooltips etc. This config has priority over similar config on the
|
|
311
291
|
* view preset. For allowed values see [format](https://bryntum.com/products/scheduler/docs/api/Core/helper/DateHelper#function-format-static).
|
|
312
|
-
* ...
|
|
313
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-displayDateFormat)
|
|
292
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-displayDateFormat)
|
|
314
293
|
*/
|
|
315
294
|
displayDateFormat ? : string
|
|
316
295
|
/**
|
|
@@ -318,24 +297,22 @@ defineProps<{
|
|
|
318
297
|
* [strips collection](https://bryntum.com/products/scheduler/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
|
|
319
298
|
* `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
|
|
320
299
|
* body. Such widgets are called "edge strips".
|
|
321
|
-
* ...
|
|
322
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-dock)
|
|
300
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-dock)
|
|
323
301
|
*/
|
|
324
302
|
dock ? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
325
303
|
/**
|
|
326
304
|
* Make this Panel a docked drawer which slides out from one side of the browser viewport by default.
|
|
327
|
-
* ...
|
|
328
|
-
* [
|
|
329
|
-
* @param {
|
|
330
|
-
* @param {
|
|
331
|
-
* @param {boolean}
|
|
332
|
-
* @param {boolean,
|
|
333
|
-
* @param {boolean,string} autoClose.
|
|
334
|
-
* @param {
|
|
335
|
-
* @param {
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
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}
|
|
305
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-drawer)
|
|
306
|
+
* @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.
|
|
307
|
+
* @param {string,number} [size] The size of the drawer in its collapsible axis.
|
|
308
|
+
* @param {boolean} [inline] If using the [appendTo](https://bryntum.com/products/scheduler/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.
|
|
309
|
+
* @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.
|
|
310
|
+
* @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.
|
|
311
|
+
* @param {boolean,string} [autoClose.focusout] If focus moves outside of the drawer, the drawer will automatically be hidden.
|
|
312
|
+
* @param {string} [autoClose.mouseout] Hides the drawer when the mouse leaves the drawer after the `autoCloseDelay` period.
|
|
313
|
+
* @param {number} [autoCloseDelay] When using `mouseout`, this is the delay in milliseconds
|
|
314
|
+
*/
|
|
315
|
+
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 }
|
|
339
316
|
/**
|
|
340
317
|
* Decimal precision used when displaying durations, used by tooltips and DurationColumn.
|
|
341
318
|
* Specify `false` to use raw value
|
|
@@ -344,16 +321,14 @@ defineProps<{
|
|
|
344
321
|
/**
|
|
345
322
|
* An object specifying attributes to assign to the root element of this widget.
|
|
346
323
|
* Set `null` value to attribute to remove it.
|
|
347
|
-
* ...
|
|
348
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-elementAttributes)
|
|
324
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-elementAttributes)
|
|
349
325
|
*/
|
|
350
326
|
elementAttributes ? : Record<string, string|null>
|
|
351
327
|
/**
|
|
352
328
|
* Text or HTML, or a [EmptyTextDomConfig](https://bryntum.com/products/scheduler/docs/api/Grid/view/GridBase#typedef-EmptyTextDomConfig) block to display when there is no data to display in the grid.
|
|
353
329
|
* When using multiple Grid regions, provide the `region` property to decide where the text is shown.
|
|
354
330
|
* By default, it is shown in the first region.
|
|
355
|
-
* ...
|
|
356
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-emptyText)
|
|
331
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-emptyText)
|
|
357
332
|
*/
|
|
358
333
|
emptyText ? : string|EmptyTextDomConfig
|
|
359
334
|
/**
|
|
@@ -365,16 +340,14 @@ defineProps<{
|
|
|
365
340
|
* Enables showing occurrences of recurring events across the scheduler's time axis. If you want to disable
|
|
366
341
|
* the recurrence popup, you can choose set the `defaultAction` to `future` to affect all future
|
|
367
342
|
* occurrences, or `single` to just affect the currently selected event.
|
|
368
|
-
* ...
|
|
369
|
-
*
|
|
343
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-enableRecurringEvents)
|
|
344
|
+
* @property {'single','future'} defaultAction
|
|
370
345
|
*/
|
|
371
|
-
enableRecurringEvents ? : Boolean|
|
|
372
|
-
defaultAction?: 'single'|'future'
|
|
373
|
-
}
|
|
346
|
+
enableRecurringEvents ? : Boolean|object
|
|
374
347
|
/**
|
|
375
|
-
*
|
|
376
|
-
*
|
|
377
|
-
*
|
|
348
|
+
* Set to `true` to enable the [StickyCells](https://bryntum.com/products/scheduler/docs/api/Grid/feature/StickyCells) feature, which pins cell
|
|
349
|
+
* content to the top of the grid while rows scroll off the top but remain visible.
|
|
350
|
+
* @deprecated 7.3.0 Use `features : { stickyCells : true }` instead
|
|
378
351
|
*/
|
|
379
352
|
enableSticky ? : Boolean
|
|
380
353
|
/**
|
|
@@ -389,23 +362,20 @@ defineProps<{
|
|
|
389
362
|
enableUndoRedoKeys ? : Boolean
|
|
390
363
|
/**
|
|
391
364
|
* The end date of the timeline (if not configure with [infiniteScroll](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineBase#config-infiniteScroll)).
|
|
392
|
-
* ...
|
|
393
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-endDate)
|
|
365
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-endDate)
|
|
394
366
|
*/
|
|
395
367
|
endDate ? : Date|string
|
|
396
368
|
/**
|
|
397
369
|
* Event color used by default. Events and resources can specify their own color, with priority order being:
|
|
398
370
|
* Event -> Resource -> Scheduler default.
|
|
399
|
-
* ...
|
|
400
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-eventColor)
|
|
371
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-eventColor)
|
|
401
372
|
*/
|
|
402
373
|
eventColor ? : EventColor
|
|
403
374
|
/**
|
|
404
375
|
* Event style used by default. Events and resources can specify their own style, with priority order being:
|
|
405
376
|
* Event -> Resource -> Scheduler default. Determines the appearance of the event by assigning a CSS class
|
|
406
377
|
* to it. Available styles are:
|
|
407
|
-
* ...
|
|
408
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-eventStyle)
|
|
378
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-eventStyle)
|
|
409
379
|
*/
|
|
410
380
|
eventStyle ? : 'tonal'|'filled'|'bordered'|'traced'|'outlined'|'indented'|'line'|'dashed'|'minimal'|'rounded'|'calendar'|'interday'|'gantt'|null
|
|
411
381
|
extraData ? : any
|
|
@@ -418,16 +388,14 @@ defineProps<{
|
|
|
418
388
|
/**
|
|
419
389
|
* Specify `true` to force rendered events/tasks to fill entire ticks. This only affects rendering, start
|
|
420
390
|
* and end dates retain their value on the data level.
|
|
421
|
-
* ...
|
|
422
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-fillTicks)
|
|
391
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-fillTicks)
|
|
423
392
|
*/
|
|
424
393
|
fillTicks ? : Boolean
|
|
425
394
|
/**
|
|
426
395
|
* Use fixed row height. Setting this to `true` will configure the underlying RowManager to use fixed row
|
|
427
396
|
* height, which sacrifices the ability to use rows with variable height to gain a fraction better
|
|
428
397
|
* performance.
|
|
429
|
-
* ...
|
|
430
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-fixedRowHeight)
|
|
398
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-fixedRowHeight)
|
|
431
399
|
*/
|
|
432
400
|
fixedRowHeight ? : Boolean
|
|
433
401
|
/**
|
|
@@ -441,14 +409,12 @@ defineProps<{
|
|
|
441
409
|
/**
|
|
442
410
|
* Config object of a footer. May contain a `dock`, `html` and a `cls` property. A footer is not a widget,
|
|
443
411
|
* but rather plain HTML that follows the last element of the panel's body and [strips](https://bryntum.com/products/scheduler/docs/api/Core/widget/Panel#config-strips).
|
|
444
|
-
* ...
|
|
445
|
-
*
|
|
412
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-footer)
|
|
413
|
+
* @property {'top','right','bottom','left','start','end'} dock Where to dock
|
|
414
|
+
* @property {string} html Html to populate the footer with
|
|
415
|
+
* @property {string} cls CSS class to add to the footer
|
|
446
416
|
*/
|
|
447
|
-
footer ? :
|
|
448
|
-
dock?: 'top'|'right'|'bottom'|'left'|'start'|'end'
|
|
449
|
-
html?: string
|
|
450
|
-
cls?: string
|
|
451
|
-
}|string
|
|
417
|
+
footer ? : object|string
|
|
452
418
|
/**
|
|
453
419
|
* Set to `true` to force the time columns to fit to the available space (horizontal or vertical depends on mode).
|
|
454
420
|
* Note that setting [suppressFit](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineBase#config-suppressFit) to `true`, will disable `forceFit` functionality. Zooming
|
|
@@ -458,14 +424,12 @@ defineProps<{
|
|
|
458
424
|
/**
|
|
459
425
|
* An object which names formula prefixes which will be applied to all columns configured with
|
|
460
426
|
* `formula : true`.
|
|
461
|
-
* ...
|
|
462
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-formulaProviders)
|
|
427
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-formulaProviders)
|
|
463
428
|
*/
|
|
464
429
|
formulaProviders ? : Record<string, FormulaProviderConfig>
|
|
465
430
|
/**
|
|
466
431
|
* Refresh entire row when a record changes (`true`) or, if possible, only the cells affected (`false`).
|
|
467
|
-
* ...
|
|
468
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-fullRowRefresh)
|
|
432
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-fullRowRefresh)
|
|
469
433
|
*/
|
|
470
434
|
fullRowRefresh ? : Boolean
|
|
471
435
|
/**
|
|
@@ -484,8 +448,7 @@ defineProps<{
|
|
|
484
448
|
* (a `RECT` element representing a single "bar"-type value).
|
|
485
449
|
* The function is passed a default prepared DOM configuration
|
|
486
450
|
* in an argument which then can be processed and returned.
|
|
487
|
-
* ...
|
|
488
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-getBarDOMConfig)
|
|
451
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-getBarDOMConfig)
|
|
489
452
|
* @param {HistogramSeries} series The series being rendered
|
|
490
453
|
* @param {DomConfig} domConfig The rectangle DOM configuration object
|
|
491
454
|
* @param {object} datum The datum being rendered
|
|
@@ -496,8 +459,7 @@ defineProps<{
|
|
|
496
459
|
getBarDOMConfig ? : (series: HistogramSeries, domConfig: DomConfig, datum: object, index: number, renderData: HistogramRenderData) => object
|
|
497
460
|
/**
|
|
498
461
|
* A Function which returns the text to render inside a bar.
|
|
499
|
-
* ...
|
|
500
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-getBarText)
|
|
462
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-getBarText)
|
|
501
463
|
* @param {object} datum The datum being rendered
|
|
502
464
|
* @param {number} index The index of the datum being rendered
|
|
503
465
|
* @param {HistogramSeries} series The series (provided if histogram widget [singleTextForAllBars](https://bryntum.com/products/scheduler/docs/api/Core/widget/graph/Histogram#config-singleTextForAllBars) is `false`)
|
|
@@ -507,8 +469,7 @@ defineProps<{
|
|
|
507
469
|
getBarText ? : (datum: object, index: number, series: HistogramSeries, renderData: HistogramRenderData) => string
|
|
508
470
|
/**
|
|
509
471
|
* A Function which returns a DOM configuration object for text elements.
|
|
510
|
-
* ...
|
|
511
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-getBarTextDOMConfig)
|
|
472
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-getBarTextDOMConfig)
|
|
512
473
|
* @param {DomConfig} domConfig The `TEXT` element DOM configuration object
|
|
513
474
|
* @param {object} datum The datum being rendered
|
|
514
475
|
* @param {number} index The index of the datum being rendered
|
|
@@ -521,12 +482,11 @@ defineProps<{
|
|
|
521
482
|
* Function that extracts a record histogram data entry for aggregating.
|
|
522
483
|
* By default it returns the entry as is. Override the function if you need a more complex way
|
|
523
484
|
* to retrieve the value for aggregating.
|
|
524
|
-
* ...
|
|
525
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-getDataEntryForAggregating)
|
|
485
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-getDataEntryForAggregating)
|
|
526
486
|
* @param {object} getDataEntryForAggregating.entry Current data entry.
|
|
527
487
|
* @returns {object} Entry to aggregate
|
|
528
488
|
*/
|
|
529
|
-
getDataEntryForAggregating ? : ((
|
|
489
|
+
getDataEntryForAggregating ? : (() => object)|string
|
|
530
490
|
/**
|
|
531
491
|
* A Function which returns a CSS class name to add to a path element
|
|
532
492
|
* built for an `outline` type series.
|
|
@@ -542,8 +502,7 @@ defineProps<{
|
|
|
542
502
|
* a `path` element built for an `outline` type series.
|
|
543
503
|
* The function accepts a default prepared DOM configuration
|
|
544
504
|
* in an argument which then can be processed and returned.
|
|
545
|
-
* ...
|
|
546
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-getOutlineDOMConfig)
|
|
505
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-getOutlineDOMConfig)
|
|
547
506
|
* @param {HistogramSeries} series The series being rendered
|
|
548
507
|
* @param {DomConfig} domConfig The `path` element DOM configuration object
|
|
549
508
|
* @param {object[]} data The series data
|
|
@@ -552,23 +511,21 @@ defineProps<{
|
|
|
552
511
|
getOutlineDOMConfig ? : (series: HistogramSeries, domConfig: DomConfig, data: object[]) => object
|
|
553
512
|
/**
|
|
554
513
|
* A function, or name of a function which builds histogram data for the provided record.
|
|
555
|
-
* ...
|
|
556
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-getRecordData)
|
|
514
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-getRecordData)
|
|
557
515
|
* @param {Core.data.Model} getRecordData.record Record to get histogram data for.
|
|
558
|
-
* @param {object} aggregationContext Context object passed in case the data is being retrieved as a part of some parent record data collecting.
|
|
516
|
+
* @param {object} [aggregationContext] Context object passed in case the data is being retrieved as a part of some parent record data collecting.
|
|
559
517
|
* @returns {object} Histogram data.
|
|
560
518
|
*/
|
|
561
|
-
getRecordData ? : ((
|
|
519
|
+
getRecordData ? : ((aggregationContext: object) => object)|string
|
|
562
520
|
/**
|
|
563
521
|
* A function called for each row to determine its height. It is passed a [record](https://bryntum.com/products/scheduler/docs/api/Core/data/Model) and
|
|
564
522
|
* expected to return the desired height of that records row. If the function returns a falsy value, Grids
|
|
565
523
|
* configured [rowHeight](https://bryntum.com/products/scheduler/docs/api/Grid/view/GridBase#config-rowHeight) is used.
|
|
566
|
-
* ...
|
|
567
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-getRowHeight)
|
|
524
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-getRowHeight)
|
|
568
525
|
* @param {Core.data.Model} getRowHeight.record Record to determine row height for
|
|
569
526
|
* @returns {number} Desired row height
|
|
570
527
|
*/
|
|
571
|
-
getRowHeight ? : (
|
|
528
|
+
getRowHeight ? : () => number
|
|
572
529
|
/**
|
|
573
530
|
* When set to `true` (default) the component reacts on time axis changes
|
|
574
531
|
* (zooming or changing the displayed time span), clears the histogram data cache of the records
|
|
@@ -577,8 +534,7 @@ defineProps<{
|
|
|
577
534
|
hardRefreshOnTimeAxisReconfigure ? : Boolean
|
|
578
535
|
/**
|
|
579
536
|
* A config [object](https://bryntum.com/products/scheduler/docs/api/Core/widget/Panel#typedef-PanelHeader) for the panel's header or a string in place of a `title`.
|
|
580
|
-
* ...
|
|
581
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-header)
|
|
537
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-header)
|
|
582
538
|
*/
|
|
583
539
|
header ? : string|Boolean|PanelHeader
|
|
584
540
|
/**
|
|
@@ -605,8 +561,7 @@ defineProps<{
|
|
|
605
561
|
hideHorizontalScrollbar ? : Boolean
|
|
606
562
|
/**
|
|
607
563
|
* By default the row hover effect is not visible in the Scheduler part of the grid.
|
|
608
|
-
* ...
|
|
609
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-hideRowHover)
|
|
564
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-hideRowHover)
|
|
610
565
|
*/
|
|
611
566
|
hideRowHover ? : Boolean
|
|
612
567
|
/**
|
|
@@ -640,21 +595,18 @@ defineProps<{
|
|
|
640
595
|
ignoreDomEventsWhileScrolling ? : Boolean
|
|
641
596
|
/**
|
|
642
597
|
* Determines if the widgets read-only state should be controlled by its parent.
|
|
643
|
-
* ...
|
|
644
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-ignoreParentReadOnly)
|
|
598
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-ignoreParentReadOnly)
|
|
645
599
|
*/
|
|
646
600
|
ignoreParentReadOnly ? : Boolean
|
|
647
601
|
/**
|
|
648
602
|
* Set to `true` to automatically adjust the panel timespan during scrolling in the time dimension,
|
|
649
603
|
* when the scroller comes close to the start/end edges.
|
|
650
|
-
* ...
|
|
651
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-infiniteScroll)
|
|
604
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-infiniteScroll)
|
|
652
605
|
*/
|
|
653
606
|
infiniteScroll ? : Boolean
|
|
654
607
|
/**
|
|
655
608
|
* A function that initializes a target group record entry.
|
|
656
|
-
* ...
|
|
657
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-initAggregatedDataEntry)
|
|
609
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-initAggregatedDataEntry)
|
|
658
610
|
* @returns {object} Target aggregated entry
|
|
659
611
|
*/
|
|
660
612
|
initAggregatedDataEntry ? : (() => object)|string
|
|
@@ -662,8 +614,7 @@ defineProps<{
|
|
|
662
614
|
* Convenience setting to align input fields of child widgets. By default, the Field input element is
|
|
663
615
|
* placed immediately following the `label`. If you prefer to have all input fields aligned to the
|
|
664
616
|
* right, set this config to `'end'`.
|
|
665
|
-
* ...
|
|
666
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-inputFieldAlign)
|
|
617
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-inputFieldAlign)
|
|
667
618
|
*/
|
|
668
619
|
inputFieldAlign ? : 'start'|'end'
|
|
669
620
|
/**
|
|
@@ -680,14 +631,17 @@ defineProps<{
|
|
|
680
631
|
keyMap ? : Record<string, KeyMapConfig>
|
|
681
632
|
/**
|
|
682
633
|
* Convenience setting to use same label placement on all child widgets.
|
|
683
|
-
* ...
|
|
684
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-labelPosition)
|
|
634
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-labelPosition)
|
|
685
635
|
*/
|
|
686
636
|
labelPosition ? : 'before'|'above'|'align-before'|'auto'|null
|
|
637
|
+
/**
|
|
638
|
+
* Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
|
|
639
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-labelWidth)
|
|
640
|
+
*/
|
|
641
|
+
labelWidth ? : number|null
|
|
687
642
|
/**
|
|
688
643
|
* The listener set for this object.
|
|
689
|
-
* ...
|
|
690
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-listeners)
|
|
644
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-listeners)
|
|
691
645
|
*/
|
|
692
646
|
listeners ? : TimelineHistogramListeners
|
|
693
647
|
/**
|
|
@@ -700,15 +654,13 @@ defineProps<{
|
|
|
700
654
|
* when data is loading. The message and optional configuration from the
|
|
701
655
|
* [loadMask](https://bryntum.com/products/scheduler/docs/api/Core/mixin/LoadMaskable#config-loadMask) config take priority over these options, just as they do
|
|
702
656
|
* for `maskDefaults`, respectively.
|
|
703
|
-
* ...
|
|
704
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-loadMaskDefaults)
|
|
657
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-loadMaskDefaults)
|
|
705
658
|
*/
|
|
706
659
|
loadMaskDefaults ? : MaskConfig
|
|
707
660
|
/**
|
|
708
661
|
* A [Mask](https://bryntum.com/products/scheduler/docs/api/Core/widget/Mask) config object to adjust the [maskDefaults](#Core/widget/Widget#config-maskDefaults)
|
|
709
662
|
* when an error occurs loading data.
|
|
710
|
-
* ...
|
|
711
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-loadMaskError)
|
|
663
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-loadMaskError)
|
|
712
664
|
*/
|
|
713
665
|
loadMaskError ? : MaskConfig|Mask|Boolean
|
|
714
666
|
/**
|
|
@@ -722,8 +674,7 @@ defineProps<{
|
|
|
722
674
|
/**
|
|
723
675
|
* When `true`, events are sized and positioned based on rowHeight, resourceMargin and barMargin settings.
|
|
724
676
|
* Set this to `false` if you want to control height and vertical position using CSS instead.
|
|
725
|
-
* ...
|
|
726
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-managedEventSizing)
|
|
677
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-managedEventSizing)
|
|
727
678
|
*/
|
|
728
679
|
managedEventSizing ? : Boolean
|
|
729
680
|
/**
|
|
@@ -754,8 +705,7 @@ defineProps<{
|
|
|
754
705
|
/**
|
|
755
706
|
* The maximum time axis unit to display non-working ranges for ('hour' or 'day' etc).
|
|
756
707
|
* When zooming to a view with a larger unit, no non-working time elements will be rendered.
|
|
757
|
-
* ...
|
|
758
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-maxTimeAxisUnit)
|
|
708
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-maxTimeAxisUnit)
|
|
759
709
|
*/
|
|
760
710
|
maxTimeAxisUnit ? : DurationUnit
|
|
761
711
|
/**
|
|
@@ -764,12 +714,10 @@ defineProps<{
|
|
|
764
714
|
*/
|
|
765
715
|
maxWidth ? : string|number
|
|
766
716
|
/**
|
|
767
|
-
* The maximum zoom level to which [zoomIn](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomIn) will work.
|
|
768
|
-
* [
|
|
769
|
-
* for information. Unless you have modified the collection of available presets, the max zoom level is
|
|
770
|
-
* milliseconds.
|
|
717
|
+
* The maximum zoom level to which [zoomIn](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomIn) will work.
|
|
718
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-maxZoomLevel)
|
|
771
719
|
*/
|
|
772
|
-
maxZoomLevel ? : number
|
|
720
|
+
maxZoomLevel ? : number|string
|
|
773
721
|
/**
|
|
774
722
|
* Get/set start date limit of the timeline.
|
|
775
723
|
* Actions such as timeline scrolling, all types of timeline zooms and shifts
|
|
@@ -779,8 +727,7 @@ defineProps<{
|
|
|
779
727
|
/**
|
|
780
728
|
* Grid's `min-height`. Defaults to `10em` to be sure that the Grid always has a height wherever it is
|
|
781
729
|
* inserted.
|
|
782
|
-
* ...
|
|
783
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-minHeight)
|
|
730
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-minHeight)
|
|
784
731
|
*/
|
|
785
732
|
minHeight ? : string|number
|
|
786
733
|
/**
|
|
@@ -789,9 +736,10 @@ defineProps<{
|
|
|
789
736
|
*/
|
|
790
737
|
minWidth ? : string|number
|
|
791
738
|
/**
|
|
792
|
-
* The minimum zoom level to which [zoomOut](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomOut) will work.
|
|
739
|
+
* The minimum zoom level to which [zoomOut](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomOut) will work.
|
|
740
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-minZoomLevel)
|
|
793
741
|
*/
|
|
794
|
-
minZoomLevel ? : number
|
|
742
|
+
minZoomLevel ? : number|string
|
|
795
743
|
/**
|
|
796
744
|
* Grid monitors window resize by default.
|
|
797
745
|
*/
|
|
@@ -799,14 +747,13 @@ defineProps<{
|
|
|
799
747
|
/**
|
|
800
748
|
* Partners this Timeline panel with another Timeline in order to sync their region sizes (sub-grids like locked, normal will get the same width),
|
|
801
749
|
* start and end dates, view preset, zoom level and scrolling position. All these values will be synced with the timeline defined as the `partner`.
|
|
802
|
-
* ...
|
|
803
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-partner)
|
|
750
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-partner)
|
|
804
751
|
*/
|
|
805
752
|
partner ? : TimelineBase|string
|
|
806
753
|
/**
|
|
807
754
|
* Specify plugins (an array of classes) in config
|
|
808
755
|
*/
|
|
809
|
-
plugins ? :
|
|
756
|
+
plugins ? : InstancePlugin[]|InstancePlugin
|
|
810
757
|
/**
|
|
811
758
|
* True to preserve focused cell after loading new data
|
|
812
759
|
*/
|
|
@@ -822,10 +769,9 @@ defineProps<{
|
|
|
822
769
|
*/
|
|
823
770
|
preserveScrollOnDatasetChange ? : Boolean
|
|
824
771
|
/**
|
|
825
|
-
* An array of [ViewPreset](https://bryntum.com/products/scheduler/docs/api/Scheduler/preset/ViewPreset) config objects
|
|
826
|
-
*
|
|
827
|
-
* ...
|
|
828
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-presets)
|
|
772
|
+
* An array of [ViewPreset](https://bryntum.com/products/scheduler/docs/api/Scheduler/preset/ViewPreset) config objects which describes the available timeline layouts
|
|
773
|
+
* for this scheduler.
|
|
774
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-presets)
|
|
829
775
|
*/
|
|
830
776
|
presets ? : ViewPresetConfig[]
|
|
831
777
|
/**
|
|
@@ -835,37 +781,40 @@ defineProps<{
|
|
|
835
781
|
preventTooltipOnTouch ? : Boolean
|
|
836
782
|
/**
|
|
837
783
|
* Set to `true` to make the grid read-only, by disabling any UIs for modifying data.
|
|
838
|
-
* ...
|
|
839
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-readOnly)
|
|
784
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-readOnly)
|
|
840
785
|
*/
|
|
841
786
|
readOnly ? : Boolean
|
|
842
787
|
/**
|
|
843
788
|
* The confirmation dialog shown when a recurring event is edited.
|
|
844
|
-
* ...
|
|
845
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-recurrenceConfirmationPopup)
|
|
789
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-recurrenceConfirmationPopup)
|
|
846
790
|
*/
|
|
847
|
-
recurrenceConfirmationPopup ? : RecurrenceConfirmationPopupConfig
|
|
791
|
+
recurrenceConfirmationPopup ? : RecurrenceConfirmationPopupConfig
|
|
848
792
|
relayStoreEvents ? : Boolean
|
|
849
793
|
/**
|
|
850
794
|
* Either a default `rendition` to apply to all child widgets, or a map of renditions keyed by child widget
|
|
851
795
|
* `type`.
|
|
852
|
-
* ...
|
|
853
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-rendition)
|
|
796
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-rendition)
|
|
854
797
|
*/
|
|
855
798
|
rendition ? : string|Record<string, string>|null
|
|
856
799
|
/**
|
|
857
800
|
* Configure this property to allow the widget/component to be resized. Pressing <kbd>Shift</kbd> while resizing will
|
|
858
801
|
* constrain the aspect ratio.
|
|
859
|
-
* ...
|
|
860
|
-
* [
|
|
861
|
-
|
|
862
|
-
|
|
863
|
-
|
|
864
|
-
|
|
865
|
-
|
|
866
|
-
|
|
867
|
-
|
|
868
|
-
|
|
802
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-resizable)
|
|
803
|
+
* @property {number} [resizable.minWidth] The minimum width of the element.
|
|
804
|
+
* @property {number} [resizable.maxWidth] The maximum width of the element.
|
|
805
|
+
* @property {number} [resizable.minHeight] The minimum height of the element.
|
|
806
|
+
* @property {number} [resizable.maxHeight] The maximum height of the element
|
|
807
|
+
* @property {object} [resizable.handles] An object controlling which edges/corners are resizable.
|
|
808
|
+
* @property {boolean} [resizable.handles.topStart] Resizable from top-start corner
|
|
809
|
+
* @property {boolean} [resizable.handles.top] Resizable from top edge
|
|
810
|
+
* @property {boolean} [resizable.handles.topEnd] Resizable from top-end corner
|
|
811
|
+
* @property {boolean} [resizable.handles.end] Resizable from end edge
|
|
812
|
+
* @property {boolean} [resizable.handles.bottomEnd] Resizable from bottom-end corner
|
|
813
|
+
* @property {boolean} [resizable.handles.bottom] Resizable from bottom edge
|
|
814
|
+
* @property {boolean} [resizable.handles.bottomStart] Resizable from bottom-start corner
|
|
815
|
+
* @property {boolean} [resizable.handles.start] Resizable from start edge
|
|
816
|
+
*/
|
|
817
|
+
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 } }
|
|
869
818
|
/**
|
|
870
819
|
* Set to `false` to only measure cell contents when double-clicking the edge between column headers.
|
|
871
820
|
*/
|
|
@@ -874,8 +823,7 @@ defineProps<{
|
|
|
874
823
|
* An empty function by default, but provided so that you can override it. This function is called each time
|
|
875
824
|
* a resource time range is rendered into the schedule. It's called with `resourceTimeRangeRecord`, `resourceRecord`,
|
|
876
825
|
* and `renderData` params.
|
|
877
|
-
* ...
|
|
878
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-resourceTimeRangeRenderer)
|
|
826
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-resourceTimeRangeRenderer)
|
|
879
827
|
* @param {object} detail An object containing the information needed to render a ResourceTimeRangeModel.
|
|
880
828
|
* @param {Scheduler.model.ResourceTimeRangeModel} detail.resourceTimeRangeRecord The resource time range record.
|
|
881
829
|
* @param {Scheduler.model.ResourceModel} detail.resourceRecord The resource record.
|
|
@@ -885,23 +833,26 @@ defineProps<{
|
|
|
885
833
|
resourceTimeRangeRenderer ? : (detail: { resourceTimeRangeRecord: ResourceTimeRangeModel, resourceRecord: ResourceModel, renderData: object }) => string|DomConfig|DomConfig[]
|
|
886
834
|
/**
|
|
887
835
|
* "Break points" for which responsive config to use for columns and css.
|
|
888
|
-
* ...
|
|
889
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-responsiveLevels)
|
|
836
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-responsiveLevels)
|
|
890
837
|
*/
|
|
891
838
|
responsiveLevels ? : Record<string, number|string|ResponsiveLevelConfig>
|
|
892
839
|
/**
|
|
893
840
|
* Configure as `true` to have the component display a translucent ripple when its
|
|
894
841
|
* [focusElement](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-focusElement), or [element](#Core/widget/Widget#property-element) is tapped <em>if the
|
|
895
842
|
* current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
|
|
896
|
-
* ...
|
|
897
|
-
* [
|
|
843
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-ripple)
|
|
844
|
+
* @property {string} [delegate] A CSS selector to filter which child elements trigger ripples. By default, the ripple is clipped to the triggering element.
|
|
845
|
+
* @property {string} [color] A CSS color name or specification.
|
|
846
|
+
* @property {number} [radius] The ending radius of the ripple. Note that it will be clipped by the target element by default.
|
|
847
|
+
* @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.
|
|
898
848
|
*/
|
|
899
|
-
ripple ? : Boolean|
|
|
900
|
-
|
|
901
|
-
|
|
902
|
-
|
|
903
|
-
|
|
904
|
-
|
|
849
|
+
ripple ? : Boolean|object
|
|
850
|
+
/**
|
|
851
|
+
* The ARIA role to apply to this widget's element. By default, this is set to `'presentation'` to avoid
|
|
852
|
+
* accidentally applying a role which may interfere with screen readers.
|
|
853
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-role)
|
|
854
|
+
*/
|
|
855
|
+
role ? : string
|
|
905
856
|
/**
|
|
906
857
|
* 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`
|
|
907
858
|
*/
|
|
@@ -910,8 +861,7 @@ defineProps<{
|
|
|
910
861
|
* Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
|
|
911
862
|
* overridden by specifying a [rowHeight](https://bryntum.com/products/scheduler/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
|
|
912
863
|
* a column [renderer](https://bryntum.com/products/scheduler/docs/api/Grid/column/Column#config-renderer).
|
|
913
|
-
* ...
|
|
914
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-rowHeight)
|
|
864
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-rowHeight)
|
|
915
865
|
*/
|
|
916
866
|
rowHeight ? : number
|
|
917
867
|
/**
|
|
@@ -920,29 +870,25 @@ defineProps<{
|
|
|
920
870
|
rowLines ? : Boolean
|
|
921
871
|
/**
|
|
922
872
|
* This may be configured as `true` to make the widget's element use the `direction:rtl` style.
|
|
923
|
-
* ...
|
|
924
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-rtl)
|
|
873
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-rtl)
|
|
925
874
|
*/
|
|
926
875
|
rtl ? : Boolean
|
|
927
876
|
/**
|
|
928
877
|
* An object with configuration for the [ScaleColumn](https://bryntum.com/products/scheduler/docs/api/Scheduler/column/ScaleColumn).
|
|
929
|
-
* ...
|
|
930
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-scaleColumn)
|
|
878
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-scaleColumn)
|
|
931
879
|
*/
|
|
932
880
|
scaleColumn ? : ScaleColumnConfig
|
|
933
881
|
/**
|
|
934
882
|
* Array of objects representing the [scale column](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineHistogramScaleColumn#config-scaleColumn) scale points.
|
|
935
883
|
* The config basically is a mapping to the column [scalePoints](https://bryntum.com/products/scheduler/docs/api/Scheduler/column/ScaleColumn#config-scalePoints)
|
|
936
884
|
* config.
|
|
937
|
-
* ...
|
|
938
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-scalePoints)
|
|
885
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-scalePoints)
|
|
939
886
|
*/
|
|
940
887
|
scalePoints ? : ScalePoint[]
|
|
941
888
|
/**
|
|
942
889
|
* Configures whether the grid is scrollable in the `Y` axis. This is used to configure a [Scroller](https://bryntum.com/products/scheduler/docs/api/Core/helper/util/Scroller).
|
|
943
890
|
* See the [scrollerClass](https://bryntum.com/products/scheduler/docs/api/Grid/view/GridBase#config-scrollerClass) config option.
|
|
944
|
-
* ...
|
|
945
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-scrollable)
|
|
891
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-scrollable)
|
|
946
892
|
*/
|
|
947
893
|
scrollable ? : Boolean|ScrollerConfig|Scroller
|
|
948
894
|
/**
|
|
@@ -957,16 +903,14 @@ defineProps<{
|
|
|
957
903
|
/**
|
|
958
904
|
* Selection configuration settings, change these properties to control how selection works and what can be
|
|
959
905
|
* selected.
|
|
960
|
-
* ...
|
|
961
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-selectionMode)
|
|
906
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-selectionMode)
|
|
962
907
|
*/
|
|
963
908
|
selectionMode ? : GridSelectionMode
|
|
964
909
|
/**
|
|
965
910
|
* Object enumerating data series for the histogram.
|
|
966
911
|
* The object keys are treated as the series identifiers and values are objects that
|
|
967
912
|
* must contain two properties:
|
|
968
|
-
* ...
|
|
969
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-series)
|
|
913
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-series)
|
|
970
914
|
*/
|
|
971
915
|
series ? : Record<string, HistogramSeries>
|
|
972
916
|
/**
|
|
@@ -984,24 +928,30 @@ defineProps<{
|
|
|
984
928
|
/**
|
|
985
929
|
* Configure as `true` to have the grid show a red "changed" tag in cells whose
|
|
986
930
|
* field value has changed and not yet been committed.
|
|
987
|
-
* ...
|
|
988
|
-
*
|
|
931
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-showDirty)
|
|
932
|
+
* @property {boolean} showDirty.duringEdit Set to `true` to show the red tag while editing a cell
|
|
933
|
+
* @property {boolean} showDirty.newRecord Set to `true` to show the red tag for all the cells of the new record
|
|
934
|
+
*/
|
|
935
|
+
showDirty ? : Boolean|{ duringEdit: Boolean, newRecord: Boolean }
|
|
936
|
+
/**
|
|
937
|
+
* When `true`, all zoom operations ([zoomIn](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomIn),
|
|
938
|
+
* [zoomOut](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomOut),
|
|
939
|
+
* [zoomInFull](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomInFull),
|
|
940
|
+
* [zoomOutFull](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomOutFull)) will use the smooth zoom system instead
|
|
941
|
+
* of jumping between discrete preset levels. This provides finer-grained control over zoom levels by
|
|
942
|
+
* interpolating tick sizes between presets.
|
|
943
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-smoothZoom)
|
|
989
944
|
*/
|
|
990
|
-
|
|
991
|
-
duringEdit?: Boolean
|
|
992
|
-
newRecord?: Boolean
|
|
993
|
-
}
|
|
945
|
+
smoothZoom ? : Boolean
|
|
994
946
|
/**
|
|
995
947
|
* Set to `true` to snap to the current time resolution increment while interacting with scheduled events.
|
|
996
|
-
* ...
|
|
997
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-snap)
|
|
948
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-snap)
|
|
998
949
|
*/
|
|
999
950
|
snap ? : Boolean
|
|
1000
951
|
/**
|
|
1001
952
|
* Affects drag drop and resizing of events when [snap](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineDateMapper#config-snap)
|
|
1002
953
|
* is enabled.
|
|
1003
|
-
* ...
|
|
1004
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-snapRelativeToEventStartDate)
|
|
954
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-snapRelativeToEventStartDate)
|
|
1005
955
|
*/
|
|
1006
956
|
snapRelativeToEventStartDate ? : Boolean
|
|
1007
957
|
/**
|
|
@@ -1010,46 +960,39 @@ defineProps<{
|
|
|
1010
960
|
span ? : number
|
|
1011
961
|
/**
|
|
1012
962
|
* The start date of the timeline (if not configure with [infiniteScroll](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineBase#config-infiniteScroll)).
|
|
1013
|
-
* ...
|
|
1014
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-startDate)
|
|
963
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-startDate)
|
|
1015
964
|
*/
|
|
1016
965
|
startDate ? : Date|string
|
|
1017
966
|
/**
|
|
1018
967
|
* This value can be one of the following:
|
|
1019
|
-
* ...
|
|
1020
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-stateful)
|
|
968
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-stateful)
|
|
1021
969
|
*/
|
|
1022
970
|
stateful ? : Boolean|object|string[]
|
|
1023
971
|
/**
|
|
1024
972
|
* The events that, when fired by this component, should trigger it to save its state by calling
|
|
1025
973
|
* [saveState](https://bryntum.com/products/scheduler/docs/api/Core/mixin/State#function-saveState).
|
|
1026
|
-
* ...
|
|
1027
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-statefulEvents)
|
|
974
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-statefulEvents)
|
|
1028
975
|
*/
|
|
1029
976
|
statefulEvents ? : object|string[]
|
|
1030
977
|
/**
|
|
1031
978
|
* The key to use when saving this object's state in the [stateProvider](https://bryntum.com/products/scheduler/docs/api/Core/mixin/State#config-stateProvider). If this config is
|
|
1032
979
|
* not assigned, and [stateful](https://bryntum.com/products/scheduler/docs/api/Core/mixin/State#config-stateful) is not set to `false`, the [id](#Core/widget/Widget#config-id)
|
|
1033
980
|
* (if explicitly specified) will be used as the `stateId`.
|
|
1034
|
-
* ...
|
|
1035
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-stateId)
|
|
981
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-stateId)
|
|
1036
982
|
*/
|
|
1037
983
|
stateId ? : string
|
|
1038
984
|
/**
|
|
1039
985
|
* The `StateProvider` to use to save and restore this object's [state](https://bryntum.com/products/scheduler/docs/api/Core/mixin/State#property-state). By default, `state`
|
|
1040
986
|
* will be saved using the [default state provider](https://bryntum.com/products/scheduler/docs/api/Core/state/StateProvider#property-instance-static).
|
|
1041
|
-
* ...
|
|
1042
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-stateProvider)
|
|
987
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-stateProvider)
|
|
1043
988
|
*/
|
|
1044
989
|
stateProvider ? : StateProvider
|
|
1045
990
|
/**
|
|
1046
991
|
* The properties of this settings object controls how grid is restored from state data.
|
|
1047
|
-
* ...
|
|
1048
|
-
* [
|
|
992
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-stateSettings)
|
|
993
|
+
* @property {boolean} [restoreUnconfiguredColumns] Determines whether to restore columns from the state that are not explicitly defined in the grid configuration.
|
|
1049
994
|
*/
|
|
1050
|
-
stateSettings ? :
|
|
1051
|
-
restoreUnconfiguredColumns?: Boolean
|
|
1052
|
-
}
|
|
995
|
+
stateSettings ? : object
|
|
1053
996
|
/**
|
|
1054
997
|
* When set, the text in the major time axis header sticks in the scrolling viewport as long as possible.
|
|
1055
998
|
*/
|
|
@@ -1057,24 +1000,21 @@ defineProps<{
|
|
|
1057
1000
|
/**
|
|
1058
1001
|
* Store that holds records to display in the grid, or a store config object. If the configuration contains
|
|
1059
1002
|
* a `readUrl`, an `AjaxStore` will be created.
|
|
1060
|
-
* ...
|
|
1061
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-store)
|
|
1003
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-store)
|
|
1062
1004
|
*/
|
|
1063
1005
|
store ? : Store|StoreConfig|AjaxStore|AjaxStoreConfig
|
|
1064
1006
|
/**
|
|
1065
1007
|
* An object containing widgets keyed by name. By default (when no `type` is given), strips are
|
|
1066
1008
|
* [toolbars](https://bryntum.com/products/scheduler/docs/api/Core/widget/Toolbar). If you want to pass an array, you can use
|
|
1067
1009
|
* the toolbar's [items](https://bryntum.com/products/scheduler/docs/api/Core/widget/Container#config-items).
|
|
1068
|
-
* ...
|
|
1069
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-strips)
|
|
1010
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-strips)
|
|
1070
1011
|
*/
|
|
1071
1012
|
strips ? : Record<string, SchedulerContainerItemConfig>
|
|
1072
1013
|
/**
|
|
1073
1014
|
* An object containing sub grid configuration objects keyed by a `region` property.
|
|
1074
1015
|
* By default, grid has a 'locked' region (if configured with locked columns) and a 'normal' region.
|
|
1075
1016
|
* The 'normal' region defaults to use `flex: 1`.
|
|
1076
|
-
* ...
|
|
1077
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-subGridConfigs)
|
|
1017
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-subGridConfigs)
|
|
1078
1018
|
*/
|
|
1079
1019
|
subGridConfigs ? : Record<string, SubGridConfig>
|
|
1080
1020
|
/**
|
|
@@ -1085,37 +1025,32 @@ defineProps<{
|
|
|
1085
1025
|
/**
|
|
1086
1026
|
* A [Mask](https://bryntum.com/products/scheduler/docs/api/Core/widget/Mask) config object, or a message to be shown when Crud Manager
|
|
1087
1027
|
* is persisting changes on the server. Set to `null` to disable default sync mask.
|
|
1088
|
-
* ...
|
|
1089
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-syncMask)
|
|
1028
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-syncMask)
|
|
1090
1029
|
*/
|
|
1091
1030
|
syncMask ? : string|MaskConfig|null
|
|
1092
1031
|
/**
|
|
1093
1032
|
* A configuration for the [tab](https://bryntum.com/products/scheduler/docs/api/Core/widget/Tab) created for this widget when it is placed in a
|
|
1094
1033
|
* [TabPanel](https://bryntum.com/products/scheduler/docs/api/Core/widget/TabPanel). For example, this config can be used to control the icon of the `tab` for
|
|
1095
1034
|
* this widget:
|
|
1096
|
-
* ...
|
|
1097
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-tab)
|
|
1035
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-tab)
|
|
1098
1036
|
*/
|
|
1099
1037
|
tab ? : Boolean|TabConfig
|
|
1100
1038
|
/**
|
|
1101
1039
|
* When this container is used as a tab in a TabPanel, these items are added to the
|
|
1102
1040
|
* [TabBar](https://bryntum.com/products/scheduler/docs/api/Core/widget/TabBar) when this container is the active tab.
|
|
1103
|
-
* ...
|
|
1104
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-tabBarItems)
|
|
1041
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-tabBarItems)
|
|
1105
1042
|
*/
|
|
1106
1043
|
tabBarItems ? : ToolbarItems[]|Widget[]
|
|
1107
1044
|
/**
|
|
1108
1045
|
* A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/scheduler/docs/api/Core/widget/Toolbar),
|
|
1109
1046
|
* or array of config objects representing the child items of a Toolbar.
|
|
1110
1047
|
* This creates a toolbar docked to the top of the panel immediately below the header.
|
|
1111
|
-
* ...
|
|
1112
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-tbar)
|
|
1048
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-tbar)
|
|
1113
1049
|
*/
|
|
1114
1050
|
tbar ? : (SchedulerContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
|
|
1115
1051
|
/**
|
|
1116
1052
|
* The width/height (depending on vertical / horizontal mode) of all the time columns.
|
|
1117
|
-
* ...
|
|
1118
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-tickSize)
|
|
1053
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-tickSize)
|
|
1119
1054
|
*/
|
|
1120
1055
|
tickSize ? : number
|
|
1121
1056
|
/**
|
|
@@ -1127,50 +1062,41 @@ defineProps<{
|
|
|
1127
1062
|
/**
|
|
1128
1063
|
* Gets/sets the current time resolution object, which contains a unit identifier and an increment count
|
|
1129
1064
|
* `{ unit, increment }`. This value means minimal task duration you can create using UI.
|
|
1130
|
-
* ...
|
|
1131
|
-
*
|
|
1065
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-timeResolution)
|
|
1066
|
+
* @property {number} increment The increment in the specified unit
|
|
1067
|
+
* @property {DurationUnit} unit The time resolution unit
|
|
1132
1068
|
*/
|
|
1133
|
-
timeResolution ? :
|
|
1134
|
-
increment?: number
|
|
1135
|
-
unit?: DurationUnit
|
|
1136
|
-
}|number
|
|
1069
|
+
timeResolution ? : object|number
|
|
1137
1070
|
/**
|
|
1138
1071
|
* Set to a time zone or a UTC offset. This will set the projects
|
|
1139
1072
|
* [timeZone](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/ProjectModel#config-timeZone) config accordingly. As this config is only a referer,
|
|
1140
1073
|
* please see project's config [documentation](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/ProjectModel#config-timeZone) for more
|
|
1141
1074
|
* information.
|
|
1142
|
-
* ...
|
|
1143
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-timeZone)
|
|
1075
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-timeZone)
|
|
1144
1076
|
*/
|
|
1145
1077
|
timeZone ? : string|number
|
|
1146
1078
|
/**
|
|
1147
1079
|
* A title to display in the header or owning TabPanel. Causes creation and docking of a header
|
|
1148
1080
|
* to the top if no header is configured.
|
|
1149
|
-
* ...
|
|
1150
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-title)
|
|
1081
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-title)
|
|
1151
1082
|
*/
|
|
1152
1083
|
title ? : string
|
|
1153
1084
|
/**
|
|
1154
1085
|
* The [tools](https://bryntum.com/products/scheduler/docs/api/Core/widget/Tool) to add either before or after the `title` in the Panel header. Each
|
|
1155
1086
|
* property name is the reference by which an instantiated tool may be retrieved from the live
|
|
1156
1087
|
* `[tools](https://bryntum.com/products/scheduler/docs/api/Core/widget/mixin/Toolable#property-tools)` property.
|
|
1157
|
-
* ...
|
|
1158
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-tools)
|
|
1088
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-tools)
|
|
1159
1089
|
*/
|
|
1160
1090
|
tools ? : Record<string, ToolConfig>|null
|
|
1161
1091
|
/**
|
|
1162
1092
|
* Configure UI transitions for various actions in the grid.
|
|
1093
|
+
* @property {boolean} insertRecord Transition row insertions
|
|
1094
|
+
* @property {boolean} removeRecord Transition row removals
|
|
1095
|
+
* @property {boolean} barChange Transition data changes that lead to bars being updated
|
|
1096
|
+
* @property {boolean} toggleTreeNode Transition tree node expand/collapse
|
|
1097
|
+
* @property {boolean} toggleGroup Transition group expand/collapse
|
|
1163
1098
|
*/
|
|
1164
|
-
transition ? :
|
|
1165
|
-
insertRecord?: Boolean
|
|
1166
|
-
removeRecord?: Boolean
|
|
1167
|
-
toggleColumn?: Boolean
|
|
1168
|
-
expandCollapseColumn?: Boolean
|
|
1169
|
-
toggleRegion?: Boolean
|
|
1170
|
-
toggleTreeNode?: Boolean
|
|
1171
|
-
toggleGroup?: Boolean
|
|
1172
|
-
filterRemoval?: Boolean
|
|
1173
|
-
}
|
|
1099
|
+
transition ? : object
|
|
1174
1100
|
/**
|
|
1175
1101
|
* Animation transition duration in milliseconds.
|
|
1176
1102
|
*/
|
|
@@ -1180,22 +1106,19 @@ defineProps<{
|
|
|
1180
1106
|
* Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
|
|
1181
1107
|
* as a space separated string, an array of strings, or as an object in which property names with truthy
|
|
1182
1108
|
* values are used as the class names.
|
|
1183
|
-
* ...
|
|
1184
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-ui)
|
|
1109
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-ui)
|
|
1185
1110
|
*/
|
|
1186
1111
|
ui ? : 'plain'|'toolbar'|string|object
|
|
1187
1112
|
/**
|
|
1188
|
-
* A string key used to
|
|
1189
|
-
* managed by [PresetManager](https://bryntum.com/products/scheduler/docs/api/Scheduler/preset/PresetManager). See [PresetManager](#Scheduler/preset/PresetManager)
|
|
1190
|
-
* Or a config object for a viewPreset.
|
|
1191
|
-
* ...
|
|
1192
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-viewPreset)
|
|
1113
|
+
* A string key used to look up a predefined [ViewPreset](https://bryntum.com/products/scheduler/docs/api/Scheduler/preset/ViewPreset) (e.g. 'weekAndDay',
|
|
1114
|
+
* 'hourAndDay'), managed by [PresetManager](https://bryntum.com/products/scheduler/docs/api/Scheduler/preset/PresetManager). See [PresetManager](#Scheduler/preset/PresetManager)
|
|
1115
|
+
* for more information. Or a config object for a viewPreset.
|
|
1116
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-viewPreset)
|
|
1193
1117
|
*/
|
|
1194
1118
|
viewPreset ? : string|ViewPresetConfig
|
|
1195
1119
|
/**
|
|
1196
1120
|
* A date to bring into view initially on the scrollable timeline.
|
|
1197
|
-
* ...
|
|
1198
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-visibleDate)
|
|
1121
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-visibleDate)
|
|
1199
1122
|
*/
|
|
1200
1123
|
visibleDate ? : Date|VisibleDate
|
|
1201
1124
|
/**
|
|
@@ -1223,15 +1146,19 @@ defineProps<{
|
|
|
1223
1146
|
/**
|
|
1224
1147
|
* An object with format `{ fromDay, toDay, fromHour, toHour }` that describes the working days and hours.
|
|
1225
1148
|
* This object will be used to populate TimeAxis [include](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/TimeAxis#config-include) property.
|
|
1226
|
-
* ...
|
|
1227
|
-
*
|
|
1149
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-workingTime)
|
|
1150
|
+
* @property {number} workingTime.fromDay Day index 0-6 (0 is Sunday)
|
|
1151
|
+
* @property {number} workingTime.toDay Day index 0-6 (0 is Sunday)
|
|
1152
|
+
* @property {number} workingTime.fromHour 0-23
|
|
1153
|
+
* @property {number} workingTime.toHour 0-23
|
|
1228
1154
|
*/
|
|
1229
|
-
workingTime ? : {
|
|
1230
|
-
|
|
1231
|
-
|
|
1232
|
-
|
|
1233
|
-
|
|
1234
|
-
|
|
1155
|
+
workingTime ? : { fromDay: number, toDay: number, fromHour: number, toHour: number }
|
|
1156
|
+
/**
|
|
1157
|
+
* Factor multiplied with wheel delta to calculate smooth zoom level changes when zooming with mouse wheel or
|
|
1158
|
+
* trackpad pinch gestures. A higher value means faster zooming.
|
|
1159
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-zoomFactor)
|
|
1160
|
+
*/
|
|
1161
|
+
zoomFactor ? : number
|
|
1235
1162
|
/**
|
|
1236
1163
|
* Whether the originally rendered timespan should be preserved while zooming. By default, it is set to `false`,
|
|
1237
1164
|
* meaning the timeline panel will adjust the currently rendered timespan to limit the amount of HTML content to
|
|
@@ -1241,11 +1168,11 @@ defineProps<{
|
|
|
1241
1168
|
*/
|
|
1242
1169
|
zoomKeepsOriginalTimespan ? : Boolean
|
|
1243
1170
|
/**
|
|
1244
|
-
* If true
|
|
1171
|
+
* If `true`, you can zoom in and out on the time axis using <kbd>CTRL</kbd> + mouse wheel.
|
|
1245
1172
|
*/
|
|
1246
1173
|
zoomOnMouseWheel ? : Boolean
|
|
1247
1174
|
/**
|
|
1248
|
-
*
|
|
1175
|
+
* If `true`, you can zoom to a time span by double-clicking a time axis cell.
|
|
1249
1176
|
*/
|
|
1250
1177
|
zoomOnTimeAxisDoubleClick ? : Boolean
|
|
1251
1178
|
|
|
@@ -1255,137 +1182,124 @@ defineProps<{
|
|
|
1255
1182
|
* agent and see the responses. Which allows the user to use natural language to interact with the Grid in different
|
|
1256
1183
|
* ways. For example, the user can ask the agent to filter the data, sort it, or select specific records. The agent can
|
|
1257
1184
|
* also perform data manipulation operations such as adding, updating, deleting records.
|
|
1258
|
-
* ...
|
|
1259
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/AI)
|
|
1185
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/AI)
|
|
1260
1186
|
*/
|
|
1261
1187
|
aiFeature ? : object|Boolean|string|GridAI|GridAIConfig
|
|
1262
1188
|
/**
|
|
1263
1189
|
* AI-powered filter feature for Grid. Allows users to type natural language queries to filter grid data.
|
|
1264
|
-
* ...
|
|
1265
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/ai/AIFilter)
|
|
1190
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/ai/AIFilter)
|
|
1266
1191
|
*/
|
|
1267
1192
|
aiFilterFeature ? : object|Boolean|string|AIFilter|AIFilterConfig
|
|
1268
1193
|
/**
|
|
1269
1194
|
* Allows using `[Ctrl/CMD + C]`, `[Ctrl/CMD + X]` and `[Ctrl/CMD + V]` to cut, copy and paste cell or cell ranges. Also
|
|
1270
1195
|
* makes cut, copy and paste actions available via the cell context menu.
|
|
1271
|
-
* ...
|
|
1272
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/CellCopyPaste)
|
|
1196
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/CellCopyPaste)
|
|
1273
1197
|
*/
|
|
1274
1198
|
cellCopyPasteFeature ? : object|Boolean|string|CellCopyPaste|CellCopyPasteConfig
|
|
1275
1199
|
/**
|
|
1276
1200
|
* Adding this feature to the grid and other Bryntum products which are based on the Grid (i.e. Scheduler, SchedulerPro, and Gantt)
|
|
1277
1201
|
* enables cell editing. Any subclass of [Field](https://bryntum.com/products/scheduler/docs/api/Core/widget/Field) can be used
|
|
1278
1202
|
* as editor for the [Column](https://bryntum.com/products/scheduler/docs/api/Grid/column/Column). The most popular are:
|
|
1279
|
-
* ...
|
|
1280
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/CellEdit)
|
|
1203
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/CellEdit)
|
|
1281
1204
|
*/
|
|
1282
1205
|
cellEditFeature ? : object|Boolean|string|CellEdit|CellEditConfig
|
|
1283
1206
|
/**
|
|
1284
1207
|
* Right click to display context menu for cells. To invoke the cell menu in a keyboard-accessible manner, use the
|
|
1285
1208
|
* <kbd>Space</kbd> key when the cell is focused.
|
|
1286
|
-
* ...
|
|
1287
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/CellMenu)
|
|
1209
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/CellMenu)
|
|
1288
1210
|
*/
|
|
1289
1211
|
cellMenuFeature ? : object|Boolean|string|CellMenu|CellMenuConfig
|
|
1290
1212
|
/**
|
|
1291
1213
|
* Displays a tooltip when hovering cells.
|
|
1292
|
-
* ...
|
|
1293
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/CellTooltip)
|
|
1214
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/CellTooltip)
|
|
1294
1215
|
*/
|
|
1295
1216
|
cellTooltipFeature ? : object|Boolean|string|CellTooltip|CellTooltipConfig
|
|
1296
1217
|
/**
|
|
1297
1218
|
* Adds interactive charting to a Grid. [Charts](https://bryntum.com/products/scheduler/docs/api/Chart/widget/Chart) can be created from a selection of Grid data
|
|
1298
1219
|
* and updated in realtime as data changes. Supports many common chart types with extensive styling and customization
|
|
1299
1220
|
* options.
|
|
1300
|
-
* ...
|
|
1301
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Charts)
|
|
1221
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Charts)
|
|
1302
1222
|
*/
|
|
1303
1223
|
chartsFeature ? : object|Boolean|string|Charts|ChartsConfig
|
|
1304
1224
|
/**
|
|
1305
|
-
* Enables the [autoWidth](https://bryntum.com/products/scheduler/docs/api/Grid/column/Column#config-autoWidth) config for a grid's columns.
|
|
1306
|
-
*
|
|
1307
|
-
*
|
|
1225
|
+
* Enables the [autoWidth](https://bryntum.com/products/scheduler/docs/api/Grid/column/Column#config-autoWidth) config for a grid's columns. When a column
|
|
1226
|
+
* has `autoWidth` set, this feature measures the rendered content of all visible cells in that column
|
|
1227
|
+
* and adjusts the column width to fit. The measurement is triggered automatically when data changes
|
|
1228
|
+
* or rows are rendered.
|
|
1229
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/ColumnAutoWidth)
|
|
1308
1230
|
*/
|
|
1309
1231
|
columnAutoWidthFeature ? : object|Boolean|string|ColumnAutoWidth|ColumnAutoWidthConfig
|
|
1310
1232
|
/**
|
|
1311
1233
|
* Displays a toolbar while dragging column headers. Drop on a button in the toolbar to activate a certain function,
|
|
1312
1234
|
* for example to group by that column. This feature simplifies certain operations on touch devices.
|
|
1313
|
-
* ...
|
|
1314
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/ColumnDragToolbar)
|
|
1235
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/ColumnDragToolbar)
|
|
1315
1236
|
*/
|
|
1316
1237
|
columnDragToolbarFeature ? : object|Boolean|string|ColumnDragToolbar|ColumnDragToolbarConfig
|
|
1317
1238
|
/**
|
|
1318
1239
|
* Displays column lines for ticks, with a different styling for major ticks (by default they are darker). If this
|
|
1319
1240
|
* feature is disabled, no lines are shown. If it's enabled, line are shown for the tick level which is set in current
|
|
1320
1241
|
* ViewPreset. Please see [columnLinesFor](https://bryntum.com/products/scheduler/docs/api/Scheduler/preset/ViewPreset#field-columnLinesFor) config for details.
|
|
1321
|
-
* ...
|
|
1322
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ColumnLines)
|
|
1242
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ColumnLines)
|
|
1323
1243
|
*/
|
|
1324
1244
|
columnLinesFeature ? : object|Boolean|string|ColumnLines|ColumnLinesConfig
|
|
1325
1245
|
/**
|
|
1326
1246
|
* Displays a column picker (to show/hide columns) in the header context menu. Columns can be displayed in sub menus
|
|
1327
1247
|
* by region or tag. Grouped headers are displayed as menu hierarchies.
|
|
1328
|
-
* ...
|
|
1329
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/ColumnPicker)
|
|
1248
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/ColumnPicker)
|
|
1330
1249
|
*/
|
|
1331
1250
|
columnPickerFeature ? : object|Boolean|string|ColumnPicker|ColumnPickerConfig
|
|
1332
1251
|
/**
|
|
1333
1252
|
* Allows user to rename columns by either right-clicking column header or using keyboard shortcuts when column header
|
|
1334
1253
|
* is focused.
|
|
1335
|
-
* ...
|
|
1336
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/ColumnRename)
|
|
1254
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/ColumnRename)
|
|
1337
1255
|
*/
|
|
1338
1256
|
columnRenameFeature ? : object|Boolean|string|ColumnRename|ColumnRenameConfig
|
|
1339
1257
|
/**
|
|
1340
|
-
* Allows user to reorder columns by dragging headers.
|
|
1341
|
-
*
|
|
1342
|
-
*
|
|
1343
|
-
* [
|
|
1258
|
+
* Allows user to reorder columns by dragging headers. Click and drag a column header to move it to a new position.
|
|
1259
|
+
* Visual feedback shows the drop target while dragging. To get notified about column reorder, listen to the
|
|
1260
|
+
* `change` event on the [columns](https://bryntum.com/products/scheduler/docs/api/Grid/data/ColumnStore) store.
|
|
1261
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/ColumnReorder)
|
|
1344
1262
|
*/
|
|
1345
1263
|
columnReorderFeature ? : object|Boolean|string|ColumnReorder|ColumnReorderConfig
|
|
1346
1264
|
/**
|
|
1347
|
-
* Enables user to resize columns by dragging a handle on the right hand side of the header.
|
|
1348
|
-
*
|
|
1349
|
-
*
|
|
1350
|
-
* [
|
|
1265
|
+
* Enables user to resize columns by dragging a handle on the right hand side of the header. A drag handle
|
|
1266
|
+
* appears when hovering near the right edge of a column header. Dragging it adjusts the column width, respecting
|
|
1267
|
+
* any [minWidth](https://bryntum.com/products/scheduler/docs/api/Grid/column/Column#config-minWidth) or [maxWidth](#Grid/column/Column#config-maxWidth) constraints.
|
|
1268
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/ColumnResize)
|
|
1351
1269
|
*/
|
|
1352
1270
|
columnResizeFeature ? : object|Boolean|string|ColumnResize|ColumnResizeConfig
|
|
1353
1271
|
/**
|
|
1354
1272
|
* A feature that allows exporting Grid data to Excel or CSV without involving the server. It uses
|
|
1355
1273
|
* [TableExporter](https://bryntum.com/products/scheduler/docs/api/Grid/util/TableExporter) class as data provider, 3rd party provider to generate XLS files, and
|
|
1356
1274
|
* [Microsoft XML specification](https://msdn.microsoft.com/en-us/library/office/documentformat.openxml.spreadsheet.aspx).
|
|
1357
|
-
* ...
|
|
1358
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/experimental/ExcelExporter)
|
|
1275
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/experimental/ExcelExporter)
|
|
1359
1276
|
*/
|
|
1360
1277
|
excelExporterFeature ? : object|Boolean|string|GridExcelExporter|GridExcelExporterConfig
|
|
1361
1278
|
/**
|
|
1362
|
-
* An experimental feature that lets users drop files on a Widget. The widget fires
|
|
1363
|
-
* In the event, you get access to the raw
|
|
1364
|
-
*
|
|
1365
|
-
* [
|
|
1279
|
+
* An experimental feature that lets users drop files on a Widget. The widget fires a
|
|
1280
|
+
* [fileDrop](https://bryntum.com/products/scheduler/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
|
|
1281
|
+
* files as strings, that were parsed by calling `readAsBinaryString`.
|
|
1282
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/experimental/FileDrop)
|
|
1366
1283
|
*/
|
|
1367
1284
|
fileDropFeature ? : object|Boolean|string|FileDrop|FileDropConfig
|
|
1368
1285
|
/**
|
|
1369
1286
|
* This feature adds a fill handle to a Grid range selection, which when dragged, fills the cells being dragged over
|
|
1370
1287
|
* with values based on the values in the original selected range. This is similar to functionality normally seen in
|
|
1371
1288
|
* various spreadsheet applications.
|
|
1372
|
-
* ...
|
|
1373
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/FillHandle)
|
|
1289
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/FillHandle)
|
|
1374
1290
|
*/
|
|
1375
1291
|
fillHandleFeature ? : object|Boolean|string|FillHandle|FillHandleConfig
|
|
1376
1292
|
/**
|
|
1377
1293
|
* Feature that allows filtering of the grid by settings filters on columns. The actual filtering is done by the store.
|
|
1378
1294
|
* For info on programmatically handling filters, see [StoreFilter](https://bryntum.com/products/scheduler/docs/api/Core/data/mixin/StoreFilter).
|
|
1379
|
-
* ...
|
|
1380
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Filter)
|
|
1295
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Filter)
|
|
1381
1296
|
*/
|
|
1382
1297
|
filterFeature ? : object|Boolean|string|Filter|FilterConfig
|
|
1383
1298
|
/**
|
|
1384
1299
|
* Feature that allows filtering of the grid by entering filters on column headers.
|
|
1385
1300
|
* The actual filtering is done by the store.
|
|
1386
1301
|
* For info on programmatically handling filters, see [StoreFilter](https://bryntum.com/products/scheduler/docs/api/Core/data/mixin/StoreFilter).
|
|
1387
|
-
* ...
|
|
1388
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/FilterBar)
|
|
1302
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/FilterBar)
|
|
1389
1303
|
*/
|
|
1390
1304
|
filterBarFeature ? : object|Boolean|string|FilterBar|FilterBarConfig
|
|
1391
1305
|
/**
|
|
@@ -1393,186 +1307,162 @@ defineProps<{
|
|
|
1393
1307
|
* <kbd>Shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
|
|
1394
1308
|
* one anywhere on grid). Use <kbd>Shift</kbd> + <kbd>Alt</kbd> + click, or the context menu, to remove a column
|
|
1395
1309
|
* grouper.
|
|
1396
|
-
* ...
|
|
1397
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Group)
|
|
1310
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Group)
|
|
1398
1311
|
*/
|
|
1399
1312
|
groupFeature ? : object|Boolean|string|Group|GroupConfig
|
|
1400
1313
|
/**
|
|
1401
1314
|
* A special version of the Grid GroupSummary feature that enables summaries within scheduler. To use a single summary
|
|
1402
1315
|
* it is easiest to configure [renderer](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/GroupSummary#config-renderer), for multiple summaries see [summaries](#Scheduler/feature/GroupSummary#config-summaries).
|
|
1403
|
-
* ...
|
|
1404
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/GroupSummary)
|
|
1316
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/GroupSummary)
|
|
1405
1317
|
*/
|
|
1406
1318
|
groupSummaryFeature ? : object|Boolean|string|GroupSummary|GroupSummaryConfig
|
|
1407
1319
|
/**
|
|
1408
1320
|
* Right click column header or focus it and press SPACE key to show the context menu for headers.
|
|
1409
|
-
* ...
|
|
1410
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/HeaderMenu)
|
|
1321
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/HeaderMenu)
|
|
1411
1322
|
*/
|
|
1412
1323
|
headerMenuFeature ? : object|Boolean|string|HeaderMenu|HeaderMenuConfig
|
|
1413
1324
|
/**
|
|
1414
1325
|
* Enables users to click and drag to zoom to a date range in Scheduler's header time axis. Only supported in horizontal
|
|
1415
1326
|
* mode.
|
|
1416
|
-
* ...
|
|
1417
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/HeaderZoom)
|
|
1327
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/HeaderZoom)
|
|
1418
1328
|
*/
|
|
1419
1329
|
headerZoomFeature ? : object|Boolean|string|HeaderZoom|HeaderZoomConfig
|
|
1420
1330
|
/**
|
|
1421
1331
|
* This feature allows records which satisfy a certain condition to be locked at the top of the grid.
|
|
1422
|
-
* ...
|
|
1423
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/LockRows)
|
|
1332
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/LockRows)
|
|
1424
1333
|
*/
|
|
1425
1334
|
lockRowsFeature ? : object|Boolean|string|GridLockRows|GridLockRowsConfig
|
|
1426
1335
|
/**
|
|
1427
1336
|
* This feature merges cells that have the same value in sorted (or [optionally](https://bryntum.com/products/scheduler/docs/api/Grid/feature/MergeCells#config-sortedOnly) any) columns
|
|
1428
1337
|
* configured to [mergeCells](https://bryntum.com/products/scheduler/docs/api/Grid/column/Column#config-mergeCells).
|
|
1429
|
-
* ...
|
|
1430
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/MergeCells)
|
|
1338
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/MergeCells)
|
|
1431
1339
|
*/
|
|
1432
1340
|
mergeCellsFeature ? : object|Boolean|string|MergeCells|MergeCellsConfig
|
|
1433
1341
|
/**
|
|
1434
1342
|
* Feature that allows styling of weekends (and other non-working time) by adding timeRanges for those days.
|
|
1435
|
-
* ...
|
|
1436
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/NonWorkingTime)
|
|
1343
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/NonWorkingTime)
|
|
1437
1344
|
*/
|
|
1438
1345
|
nonWorkingTimeFeature ? : object|Boolean|string|NonWorkingTime|NonWorkingTimeConfig
|
|
1439
1346
|
/**
|
|
1440
1347
|
* Makes the scheduler's timeline pannable by dragging with the mouse. Try it out in the demo below.
|
|
1441
|
-
* ...
|
|
1442
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Pan)
|
|
1348
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Pan)
|
|
1443
1349
|
*/
|
|
1444
1350
|
panFeature ? : object|Boolean|string|Pan|PanConfig
|
|
1445
1351
|
/**
|
|
1446
1352
|
* Generates PDF/PNG files from the Grid component.
|
|
1447
|
-
* ...
|
|
1448
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/export/PdfExport)
|
|
1353
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/export/PdfExport)
|
|
1449
1354
|
*/
|
|
1450
1355
|
pdfExportFeature ? : object|Boolean|string|GridPdfExport|GridPdfExportConfig
|
|
1451
1356
|
/**
|
|
1452
1357
|
* Allows pinning columns to the start or end region of the grid without any additional subGrid configurations.
|
|
1453
1358
|
* When pinning to a region that does not yet exist, the feature creates the required subGrid on the fly.
|
|
1454
|
-
* ...
|
|
1455
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/PinColumns)
|
|
1359
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/PinColumns)
|
|
1456
1360
|
*/
|
|
1457
1361
|
pinColumnsFeature ? : object|Boolean|string|PinColumns|PinColumnsConfig
|
|
1458
1362
|
/**
|
|
1459
1363
|
* Allows printing Grid contents using browser print dialog.
|
|
1460
|
-
* ...
|
|
1461
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/export/Print)
|
|
1364
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/export/Print)
|
|
1462
1365
|
*/
|
|
1463
1366
|
printFeature ? : object|Boolean|string|GridPrint|GridPrintConfig
|
|
1464
1367
|
/**
|
|
1465
1368
|
* Feature that allows the user to search in a column by focusing a cell and typing. Navigate between hits using the
|
|
1466
|
-
* keyboard,
|
|
1467
|
-
*
|
|
1468
|
-
* [
|
|
1369
|
+
* keyboard, <kbd>f3</kbd> or <kbd>ctrl</kbd>/<kbd>cmd</kbd> + <kbd>g</kbd> moves to next, also pressing
|
|
1370
|
+
* <kbd>shift</kbd> moves to previous.
|
|
1371
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/QuickFind)
|
|
1469
1372
|
*/
|
|
1470
1373
|
quickFindFeature ? : object|Boolean|string|QuickFind|QuickFindConfig
|
|
1471
1374
|
/**
|
|
1472
1375
|
* Makes the splitter between grid [sections](https://bryntum.com/products/scheduler/docs/api/Grid/view/SubGrid) draggable, to let users resize, and
|
|
1473
1376
|
* collapse/expand the sections.
|
|
1474
|
-
* ...
|
|
1475
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/RegionResize)
|
|
1377
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/RegionResize)
|
|
1476
1378
|
*/
|
|
1477
1379
|
regionResizeFeature ? : object|Boolean|string|RegionResize|RegionResizeConfig
|
|
1478
1380
|
/**
|
|
1479
1381
|
* Applicable only for Scheduler in `vertical` mode. Right click resource header cells to display a context menu.
|
|
1480
|
-
* ...
|
|
1481
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ResourceMenu)
|
|
1382
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ResourceMenu)
|
|
1482
1383
|
*/
|
|
1483
1384
|
resourceMenuFeature ? : object|Boolean|string|ResourceMenu|ResourceMenuConfig
|
|
1484
1385
|
/**
|
|
1485
1386
|
* Feature that draws resource time ranges, shaded areas displayed behind events. These zones are similar to events in
|
|
1486
1387
|
* that they have a start and end date but different in that they do not take part in the event layout, and they always
|
|
1487
1388
|
* occupy full row height.
|
|
1488
|
-
* ...
|
|
1489
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ResourceTimeRanges)
|
|
1389
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ResourceTimeRanges)
|
|
1490
1390
|
*/
|
|
1491
1391
|
resourceTimeRangesFeature ? : object|Boolean|string|ResourceTimeRanges|ResourceTimeRangesConfig
|
|
1492
1392
|
/**
|
|
1493
1393
|
* Allow using [Ctrl/CMD + C/X] and [Ctrl/CMD + V] to copy/cut-and-paste rows. Also makes cut, copy and paste actions
|
|
1494
1394
|
* available via the cell context menu.
|
|
1495
|
-
* ...
|
|
1496
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/RowCopyPaste)
|
|
1395
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/RowCopyPaste)
|
|
1497
1396
|
*/
|
|
1498
1397
|
rowCopyPasteFeature ? : object|Boolean|string|RowCopyPaste|RowCopyPasteConfig
|
|
1499
1398
|
/**
|
|
1500
1399
|
* This feature allows editing of entire rows in a grid in a docked panel which by default slides out from the right.
|
|
1501
|
-
* ...
|
|
1502
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/RowEdit)
|
|
1400
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/RowEdit)
|
|
1503
1401
|
*/
|
|
1504
1402
|
rowEditFeature ? : object|Boolean|string|RowEdit|RowEditConfig
|
|
1505
1403
|
/**
|
|
1506
1404
|
* Enables expanding of Grid rows by either row click or double click, or by adding a separate Grid column which renders
|
|
1507
1405
|
* a button that expands or collapses the row.
|
|
1508
|
-
* ...
|
|
1509
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/RowExpander)
|
|
1406
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/RowExpander)
|
|
1510
1407
|
*/
|
|
1511
1408
|
rowExpanderFeature ? : object|Boolean|string|RowExpander|RowExpanderConfig
|
|
1512
1409
|
/**
|
|
1513
1410
|
* This feature implements support for project transactions and used by default in Gantt. For general RowReorder feature
|
|
1514
1411
|
* documentation see [RowReorder](https://bryntum.com/products/scheduler/docs/api/Grid/feature/RowReorder).
|
|
1515
|
-
* ...
|
|
1516
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/RowReorder)
|
|
1412
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/RowReorder)
|
|
1517
1413
|
*/
|
|
1518
1414
|
rowReorderFeature ? : object|Boolean|string|RowReorder|RowReorderConfig
|
|
1519
1415
|
/**
|
|
1520
1416
|
* Enables user to change row height by dragging the bottom row border. After a resize operation, the [rowHeight](https://bryntum.com/products/scheduler/docs/api/Grid/data/GridRowModel#field-rowHeight)
|
|
1521
1417
|
* field of the record is updated (when [applyToAllRows](https://bryntum.com/products/scheduler/docs/api/Grid/feature/RowResize#config-applyToAllRows) is `false`).
|
|
1522
|
-
* ...
|
|
1523
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/RowResize)
|
|
1418
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/RowResize)
|
|
1524
1419
|
*/
|
|
1525
1420
|
rowResizeFeature ? : object|Boolean|string|GridRowResize|GridRowResizeConfig
|
|
1526
1421
|
/**
|
|
1527
1422
|
* Feature that displays a tooltip containing the time at the mouse position when hovering empty parts of the schedule.
|
|
1528
|
-
* ...
|
|
1529
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ScheduleTooltip)
|
|
1423
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ScheduleTooltip)
|
|
1530
1424
|
*/
|
|
1531
1425
|
scheduleTooltipFeature ? : object|Boolean|string|ScheduleTooltip|ScheduleTooltipConfig
|
|
1532
1426
|
/**
|
|
1533
1427
|
* <div class="external-example vertical" data-file="Grid/feature/Search.js"></div>
|
|
1534
|
-
* ...
|
|
1535
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Search)
|
|
1428
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Search)
|
|
1536
1429
|
*/
|
|
1537
1430
|
searchFeature ? : object|Boolean|string|Search|SearchConfig
|
|
1538
1431
|
/**
|
|
1539
1432
|
* Allows sorting of grid by clicking (or tapping) headers, also displays which columns grid is sorted by (numbered if
|
|
1540
1433
|
* using multisort). Use modifier keys for multisorting: [Ctrl/CMD + click] to add sorter, [Ctrl/CMD + Alt + click] to remove sorter.
|
|
1541
1434
|
* The actual sorting is done by the store, see [Store.sort()](https://bryntum.com/products/scheduler/docs/api/Core/data/mixin/StoreSort#function-sort).
|
|
1542
|
-
* ...
|
|
1543
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Sort)
|
|
1435
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Sort)
|
|
1544
1436
|
*/
|
|
1545
1437
|
sortFeature ? : object|Boolean|string|Sort|SortConfig
|
|
1546
1438
|
/**
|
|
1547
1439
|
* This feature allows splitting the Scheduler into multiple views, either by using the cell context menu, or
|
|
1548
1440
|
* programmatically by calling [split()](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Split#function-split).
|
|
1549
|
-
* ...
|
|
1550
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Split)
|
|
1441
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Split)
|
|
1551
1442
|
*/
|
|
1552
1443
|
splitFeature ? : object|Boolean|string|Split|SplitConfig
|
|
1553
1444
|
/**
|
|
1554
|
-
* A feature which pins
|
|
1555
|
-
*
|
|
1556
|
-
*
|
|
1557
|
-
* [
|
|
1445
|
+
* A feature which pins cell content to the top of the grid while the row scrolls off the top but is still visible. Very
|
|
1446
|
+
* similar to native `position: sticky`, which because of Grid's multiple-region setup unfortunately cannot be used to
|
|
1447
|
+
* achieve the same effect.
|
|
1448
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/StickyCells)
|
|
1558
1449
|
*/
|
|
1559
1450
|
stickyCellsFeature ? : object|Boolean|string|StickyCells|StickyCellsConfig
|
|
1560
1451
|
/**
|
|
1561
1452
|
* Stripes rows by adding alternating CSS classes to all row elements (`b-even` and `b-odd`).
|
|
1562
|
-
*
|
|
1563
|
-
*
|
|
1453
|
+
* This improves visual readability in data-heavy grids by giving adjacent rows different background colors.
|
|
1454
|
+
* Style the striped rows using the `.b-even` and `.b-odd` CSS classes.
|
|
1455
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Stripe)
|
|
1564
1456
|
*/
|
|
1565
1457
|
stripeFeature ? : object|Boolean|string|Stripe|StripeConfig
|
|
1566
1458
|
/**
|
|
1567
1459
|
* A special version of the Grid Summary feature. This feature displays a summary row in the grid footer.
|
|
1568
|
-
* ...
|
|
1569
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Summary)
|
|
1460
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Summary)
|
|
1570
1461
|
*/
|
|
1571
1462
|
summaryFeature ? : object|Boolean|string|Summary|SummaryConfig
|
|
1572
1463
|
/**
|
|
1573
1464
|
* Adds scheduler specific menu items to the timeline header context menu.
|
|
1574
|
-
* ...
|
|
1575
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/TimeAxisHeaderMenu)
|
|
1465
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/TimeAxisHeaderMenu)
|
|
1576
1466
|
*/
|
|
1577
1467
|
timeAxisHeaderMenuFeature ? : object|Boolean|string|TimeAxisHeaderMenu|TimeAxisHeaderMenuConfig
|
|
1578
1468
|
/**
|
|
@@ -1580,8 +1470,7 @@ defineProps<{
|
|
|
1580
1470
|
* or some important point in time (a `line`, i.e. a range with 0 duration). This feature can also show a current time
|
|
1581
1471
|
* indicator if you set [showCurrentTimeLine](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/TimeRanges#config-showCurrentTimeLine) to true. To style the rendered elements, use the
|
|
1582
1472
|
* [cls](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/TimeSpan#field-cls) field of the `TimeSpan` class.
|
|
1583
|
-
* ...
|
|
1584
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/TimeRanges)
|
|
1473
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/TimeRanges)
|
|
1585
1474
|
*/
|
|
1586
1475
|
timeRangesFeature ? : object|Boolean|string|TimeRanges|TimeRangesConfig
|
|
1587
1476
|
/**
|
|
@@ -1589,15 +1478,13 @@ defineProps<{
|
|
|
1589
1478
|
* exactly one [TreeColumn](https://bryntum.com/products/scheduler/docs/api/Grid/column/TreeColumn) among grids columns. That column will have its renderer replaced with a
|
|
1590
1479
|
* tree renderer that adds padding and icon to give the appearance of a tree. The original renderer is preserved and
|
|
1591
1480
|
* also called.
|
|
1592
|
-
* ...
|
|
1593
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Tree)
|
|
1481
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Tree)
|
|
1594
1482
|
*/
|
|
1595
1483
|
treeFeature ? : object|Boolean|string|Tree|TreeConfig
|
|
1596
1484
|
/**
|
|
1597
1485
|
* A feature that allows transforming a flat dataset (or the leaves of a hierarchical) into a tree by specifying a
|
|
1598
1486
|
* record field per parent level. Parents are generated based on each leaf's value for those fields.
|
|
1599
|
-
* ...
|
|
1600
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/TreeGroup)
|
|
1487
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/TreeGroup)
|
|
1601
1488
|
*/
|
|
1602
1489
|
treeGroupFeature ? : object|Boolean|string|TreeGroup|TreeGroupConfig
|
|
1603
1490
|
|
|
@@ -1608,697 +1495,579 @@ const emit = defineEmits<{
|
|
|
1608
1495
|
* Fires before an assignment is removed. Can be triggered by user pressing <kbd>Delete</kbd> or <kbd>Backspace</kbd> or
|
|
1609
1496
|
* by the event editor. Can for example be used to display a custom dialog to confirm deletion, in which
|
|
1610
1497
|
* case records should be "manually" removed after confirmation.
|
|
1611
|
-
* ...
|
|
1612
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-beforeAssignmentDelete)
|
|
1498
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-beforeAssignmentDelete)
|
|
1613
1499
|
* @param {string} e Event name
|
|
1614
1500
|
* @param {object} params Event parameters
|
|
1615
|
-
* @param {
|
|
1616
|
-
* @param {
|
|
1617
|
-
* @param {
|
|
1618
|
-
* @param {
|
|
1619
|
-
* @param {
|
|
1620
|
-
* @param {
|
|
1621
|
-
* @param {Function} params.params.event.context.finalize Function to call to finalize the removal. Used to asynchronously decide to remove the records or not. Provide `false` to the function to prevent the removal.
|
|
1622
|
-
* @param {boolean} params.params.event.context.finalize.removeRecords Provide `false` to the function to prevent the removal.
|
|
1501
|
+
* @param {object} params.event Event object
|
|
1502
|
+
* @param {Scheduler.view.Scheduler} params.event.source The Scheduler instance
|
|
1503
|
+
* @param {Scheduler.model.AssignmentModel[]} params.event.assignmentRecords The assignment records about to be deleted
|
|
1504
|
+
* @param {object} params.event.context Additional removal context. This allows you to process the deletion by calling `context.finalize()` if you return `false` from the event handler.
|
|
1505
|
+
* @param {Function} params.event.context.finalize Function to call to finalize the removal. Used to asynchronously decide to remove the records or not. Provide `false` to the function to prevent the removal.
|
|
1506
|
+
* @param {boolean} [params.event.context.finalize.removeRecords] Provide `false` to the function to prevent the removal.
|
|
1623
1507
|
*/
|
|
1624
1508
|
(e: 'beforeAssignmentDelete', params: ((event: { source: Scheduler, assignmentRecords: AssignmentModel[], context: { finalize: { removeRecords?: boolean } } }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
1625
1509
|
/**
|
|
1626
1510
|
* Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
|
|
1627
1511
|
* @param {string} e Event name
|
|
1628
1512
|
* @param {object} params Event parameters
|
|
1629
|
-
* @param {
|
|
1630
|
-
* @param {
|
|
1631
|
-
* @param {
|
|
1632
|
-
* @param {Grid.view.Grid} params.params.event.source Owner grid
|
|
1633
|
-
* @param {Grid.util.GridLocation} params.params.event.editorContext Editing context
|
|
1513
|
+
* @param {object} params.event Event object
|
|
1514
|
+
* @param {Grid.view.Grid} params.event.source Owner grid
|
|
1515
|
+
* @param {Grid.util.GridLocation} params.event.editorContext Editing context
|
|
1634
1516
|
*/
|
|
1635
|
-
(e: 'beforeCancelCellEdit', params: ((event: { source: Grid, editorContext: GridLocation }) =>
|
|
1517
|
+
(e: 'beforeCancelCellEdit', params: ((event: { source: Grid, editorContext: GridLocation }) => boolean|void)|string): boolean|void
|
|
1636
1518
|
/**
|
|
1637
1519
|
* 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.
|
|
1638
|
-
* ...
|
|
1639
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-beforeCancelRowEdit)
|
|
1520
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-beforeCancelRowEdit)
|
|
1640
1521
|
* @param {string} e Event name
|
|
1641
1522
|
* @param {object} params Event parameters
|
|
1642
|
-
* @param {
|
|
1643
|
-
* @param {
|
|
1644
|
-
* @param {
|
|
1645
|
-
* @param {Grid.view.Grid} params.params.event.grid Target grid
|
|
1646
|
-
* @param {RowEditorContext} params.params.event.editorContext Editing context
|
|
1523
|
+
* @param {object} params.event Event object
|
|
1524
|
+
* @param {Grid.view.Grid} params.event.grid Target grid
|
|
1525
|
+
* @param {RowEditorContext} params.event.editorContext Editing context
|
|
1647
1526
|
*/
|
|
1648
1527
|
(e: 'beforeCancelRowEdit', params: ((event: { grid: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
1649
1528
|
/**
|
|
1650
1529
|
* Fires on the owning Grid before editing starts, return `false` to prevent editing
|
|
1651
1530
|
* @param {string} e Event name
|
|
1652
1531
|
* @param {object} params Event parameters
|
|
1653
|
-
* @param {
|
|
1654
|
-
* @param {
|
|
1655
|
-
* @param {
|
|
1656
|
-
* @param {Grid.view.Grid} params.params.event.source Owner grid
|
|
1657
|
-
* @param {CellEditorContext} params.params.event.editorContext Editing context
|
|
1532
|
+
* @param {object} params.event Event object
|
|
1533
|
+
* @param {Grid.view.Grid} params.event.source Owner grid
|
|
1534
|
+
* @param {CellEditorContext} params.event.editorContext Editing context
|
|
1658
1535
|
*/
|
|
1659
|
-
(e: 'beforeCellEditStart', params: ((event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
1536
|
+
(e: 'beforeCellEditStart', params: ((event: { source: Grid, editorContext: CellEditorContext }) => boolean|void)|string): boolean|void
|
|
1660
1537
|
/**
|
|
1661
1538
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
1662
1539
|
* buttons while [autoEdit](https://bryntum.com/products/scheduler/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
|
|
1663
1540
|
* @param {string} e Event name
|
|
1664
1541
|
* @param {object} params Event parameters
|
|
1665
|
-
* @param {
|
|
1666
|
-
* @param {
|
|
1667
|
-
* @param {
|
|
1668
|
-
* @param {Grid.view.Grid} params.params.event.source Owner grid
|
|
1669
|
-
* @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).
|
|
1542
|
+
* @param {object} params.event Event object
|
|
1543
|
+
* @param {Grid.view.Grid} params.event.source Owner grid
|
|
1544
|
+
* @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).
|
|
1670
1545
|
*/
|
|
1671
|
-
(e: 'beforeCellRangeDelete', params: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
1546
|
+
(e: 'beforeCellRangeDelete', params: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void)|string): boolean|void
|
|
1672
1547
|
/**
|
|
1673
1548
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
1674
1549
|
* @param {string} e Event name
|
|
1675
1550
|
* @param {object} params Event parameters
|
|
1676
|
-
* @param {
|
|
1677
|
-
* @param {
|
|
1678
|
-
* @param {
|
|
1679
|
-
* @param {
|
|
1680
|
-
* @param {string} params.params.event.field The field being changed
|
|
1681
|
-
* @param {any} params.params.event.value The value being set
|
|
1551
|
+
* @param {object} params.event Event object
|
|
1552
|
+
* @param {Core.data.Model} params.event.record Current selected record from the range
|
|
1553
|
+
* @param {string} params.event.field The field being changed
|
|
1554
|
+
* @param {any} params.event.value The value being set
|
|
1682
1555
|
*/
|
|
1683
|
-
(e: 'beforeCellRangeEdit', params: ((event: { record: Model, field: string, value: any }) =>
|
|
1556
|
+
(e: 'beforeCellRangeEdit', params: ((event: { record: Model, field: string, value: any }) => boolean|void)|string): boolean|void
|
|
1684
1557
|
/**
|
|
1685
1558
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
1686
1559
|
* @param {string} e Event name
|
|
1687
1560
|
* @param {object} params Event parameters
|
|
1688
|
-
* @param {
|
|
1689
|
-
* @param {
|
|
1690
|
-
* @param {
|
|
1691
|
-
* @param {
|
|
1692
|
-
* @param {Grid.column.Column} params.params.event.column The column
|
|
1693
|
-
* @param {boolean} params.params.event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
1561
|
+
* @param {object} params.event Event object
|
|
1562
|
+
* @param {Grid.view.GridBase} params.event.source The grid instance
|
|
1563
|
+
* @param {Grid.column.Column} params.event.column The column
|
|
1564
|
+
* @param {boolean} params.event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
1694
1565
|
*/
|
|
1695
1566
|
(e: 'beforeColumnCollapseToggle', params: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string): void
|
|
1696
1567
|
/**
|
|
1697
1568
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
1698
1569
|
* @param {string} e Event name
|
|
1699
1570
|
* @param {object} params Event parameters
|
|
1700
|
-
* @param {
|
|
1701
|
-
* @param {
|
|
1702
|
-
* @param {
|
|
1703
|
-
* @param {
|
|
1704
|
-
* @param {Grid.column.Column} params.params.event.column The dragged column.
|
|
1705
|
-
* @param {Event} params.params.event.event The browser event.
|
|
1571
|
+
* @param {object} params.event Event object
|
|
1572
|
+
* @param {Grid.view.Grid} params.event.source The grid instance.
|
|
1573
|
+
* @param {Grid.column.Column} params.event.column The dragged column.
|
|
1574
|
+
* @param {Event} params.event.event The browser event.
|
|
1706
1575
|
*/
|
|
1707
|
-
(e: 'beforeColumnDragStart', params: ((event: { source: Grid, column: Column, event: Event }) =>
|
|
1576
|
+
(e: 'beforeColumnDragStart', params: ((event: { source: Grid, column: Column, event: Event }) => boolean|void)|string): boolean|void
|
|
1708
1577
|
/**
|
|
1709
1578
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
1710
1579
|
* @param {string} e Event name
|
|
1711
1580
|
* @param {object} params Event parameters
|
|
1712
|
-
* @param {
|
|
1713
|
-
* @param {
|
|
1714
|
-
* @param {
|
|
1715
|
-
* @param {Grid.
|
|
1716
|
-
* @param {Grid.column.Column} params.
|
|
1717
|
-
* @param {
|
|
1718
|
-
* @param {
|
|
1719
|
-
* @param {Event} params.params.event.event The browser event.
|
|
1720
|
-
* @param {string} params.params.event.region The region where the column was dropped.
|
|
1581
|
+
* @param {object} params.event Event object
|
|
1582
|
+
* @param {Grid.view.Grid} params.event.source The grid instance.
|
|
1583
|
+
* @param {Grid.column.Column} params.event.column The dragged column.
|
|
1584
|
+
* @param {Grid.column.Column} params.event.insertBefore The column before which the dragged column will be inserted.
|
|
1585
|
+
* @param {Grid.column.Column} params.event.newParent The new parent column.
|
|
1586
|
+
* @param {Event} params.event.event The browser event.
|
|
1587
|
+
* @param {string} params.event.region The region where the column was dropped.
|
|
1721
1588
|
*/
|
|
1722
|
-
(e: 'beforeColumnDropFinalize', params: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
1589
|
+
(e: 'beforeColumnDropFinalize', params: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void)|string): boolean|void
|
|
1723
1590
|
/**
|
|
1724
1591
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
1725
1592
|
* `false`.
|
|
1726
1593
|
* @param {string} e Event name
|
|
1727
1594
|
* @param {object} params Event parameters
|
|
1728
|
-
* @param {
|
|
1729
|
-
* @param {
|
|
1730
|
-
* @param {
|
|
1731
|
-
* @param {
|
|
1732
|
-
* @param {Grid.column.Column} params.params.event.column The column
|
|
1733
|
-
* @param {Event} params.params.event.domEvent The browser event
|
|
1595
|
+
* @param {object} params.event Event object
|
|
1596
|
+
* @param {Grid.view.Grid} params.event.source The grid instance
|
|
1597
|
+
* @param {Grid.column.Column} params.event.column The column
|
|
1598
|
+
* @param {Event} params.event.domEvent The browser event
|
|
1734
1599
|
*/
|
|
1735
|
-
(e: 'beforeColumnResize', params: ((event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
1600
|
+
(e: 'beforeColumnResize', params: ((event: { source: Grid, column: Column, domEvent: Event }) => boolean|void)|string): boolean|void
|
|
1736
1601
|
/**
|
|
1737
1602
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
1738
1603
|
* @param {string} e Event name
|
|
1739
1604
|
* @param {object} params Event parameters
|
|
1740
|
-
* @param {
|
|
1741
|
-
* @param {
|
|
1742
|
-
* @param {
|
|
1743
|
-
* @param {
|
|
1744
|
-
* @param {
|
|
1745
|
-
* @param {string} params.
|
|
1746
|
-
* @param {boolean} params.params.event.isCut `true` if this is a cut action
|
|
1747
|
-
* @param {string} params.params.event.entityName 'cell' to distinguish this event from other beforeCopy events
|
|
1605
|
+
* @param {object} params.event Event object
|
|
1606
|
+
* @param {Grid.view.Grid} params.event.source Owner grid
|
|
1607
|
+
* @param {Grid.util.GridLocation[]} params.event.cells The cells about to be copied or cut
|
|
1608
|
+
* @param {string} params.event.data The string data about to be copied or cut
|
|
1609
|
+
* @param {boolean} params.event.isCut `true` if this is a cut action
|
|
1610
|
+
* @param {string} params.event.entityName 'cell' to distinguish this event from other beforeCopy events
|
|
1748
1611
|
*/
|
|
1749
1612
|
(e: 'beforeCopy', params: ((event: { source: Grid, cells: GridLocation[], data: string, isCut: boolean, entityName: string }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
1750
1613
|
/**
|
|
1751
1614
|
* Fires on the owning Grid before CSV export starts. Return `false` to cancel the export.
|
|
1752
1615
|
* @param {string} e Event name
|
|
1753
1616
|
* @param {object} params Event parameters
|
|
1754
|
-
* @param {
|
|
1755
|
-
* @param {
|
|
1756
|
-
* @param {
|
|
1757
|
-
* @param {
|
|
1758
|
-
* @param {
|
|
1759
|
-
* @param {
|
|
1760
|
-
* @param {string} params.params.event.lineDelimiter The CSV delimiter to separate lines
|
|
1761
|
-
* @param {string} params.params.event.columnDelimiter The CSV delimiter to separate values on one line
|
|
1617
|
+
* @param {object} params.event Event object
|
|
1618
|
+
* @param {ExportConfig} params.event.config Export config
|
|
1619
|
+
* @param {Grid.column.Column[]} params.event.columns An array of columns to export
|
|
1620
|
+
* @param {Core.data.Model[]} params.event.rows An array of records to export
|
|
1621
|
+
* @param {string} params.event.lineDelimiter The CSV delimiter to separate lines
|
|
1622
|
+
* @param {string} params.event.columnDelimiter The CSV delimiter to separate values on one line
|
|
1762
1623
|
*/
|
|
1763
|
-
(e: 'beforeCSVExport', params: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
1624
|
+
(e: 'beforeCSVExport', params: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void)|string): boolean|void
|
|
1764
1625
|
/**
|
|
1765
1626
|
* Fires before an object is destroyed.
|
|
1766
1627
|
* @param {string} e Event name
|
|
1767
1628
|
* @param {object} params Event parameters
|
|
1768
|
-
* @param {
|
|
1769
|
-
* @param {
|
|
1770
|
-
* @param {object} params.params.event Event object
|
|
1771
|
-
* @param {Core.Base} params.params.event.source The Object that is being destroyed.
|
|
1629
|
+
* @param {object} params.event Event object
|
|
1630
|
+
* @param {Core.Base} params.event.source The Object that is being destroyed.
|
|
1772
1631
|
*/
|
|
1773
1632
|
(e: 'beforeDestroy', params: ((event: { source: Base }) => void)|string): void
|
|
1774
1633
|
/**
|
|
1775
1634
|
* Fires before an event is removed. Can be triggered by user pressing <kbd>Delete</kbd> or <kbd>Backspace</kbd> or by the
|
|
1776
1635
|
* event editor. Return `false` to immediately veto the removal (or a `Promise` yielding `true` or `false`
|
|
1777
1636
|
* for async vetoing).
|
|
1778
|
-
* ...
|
|
1779
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-beforeEventDelete)
|
|
1637
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-beforeEventDelete)
|
|
1780
1638
|
* @param {string} e Event name
|
|
1781
1639
|
* @param {object} params Event parameters
|
|
1782
|
-
* @param {
|
|
1783
|
-
* @param {
|
|
1784
|
-
* @param {
|
|
1785
|
-
* @param {
|
|
1786
|
-
* @param {
|
|
1787
|
-
* @param {
|
|
1788
|
-
* @param {Function} params.params.event.context.finalize Function to call to finalize the removal. Used to asynchronously decide to remove the records or not. Provide `false` to the function to prevent the removal.
|
|
1789
|
-
* @param {boolean} params.params.event.context.finalize.removeRecords Provide `false` to the function to prevent the removal.
|
|
1640
|
+
* @param {object} params.event Event object
|
|
1641
|
+
* @param {Scheduler.view.Scheduler,any} params.event.source The Scheduler instance
|
|
1642
|
+
* @param {Scheduler.model.EventModel[]} params.event.eventRecords The records about to be deleted
|
|
1643
|
+
* @param {object} params.event.context Additional removal context. This allows you to process the deletion by calling `context.finalize()` if you return `false` from the event handler.
|
|
1644
|
+
* @param {Function} params.event.context.finalize Function to call to finalize the removal. Used to asynchronously decide to remove the records or not. Provide `false` to the function to prevent the removal.
|
|
1645
|
+
* @param {boolean} [params.event.context.finalize.removeRecords] Provide `false` to the function to prevent the removal.
|
|
1790
1646
|
*/
|
|
1791
1647
|
(e: 'beforeEventDelete', params: ((event: { source: Scheduler|any, eventRecords: EventModel[], context: { finalize: { removeRecords?: boolean } } }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
1792
1648
|
/**
|
|
1793
1649
|
* Fires on the owning Grid before Excel export starts. Return `false` to cancel the export.
|
|
1794
1650
|
* @param {string} e Event name
|
|
1795
1651
|
* @param {object} params Event parameters
|
|
1796
|
-
* @param {
|
|
1797
|
-
* @param {
|
|
1798
|
-
* @param {
|
|
1799
|
-
* @param {
|
|
1800
|
-
* @param {XLSColumn[]} params.params.event.columns An array of columns to export
|
|
1801
|
-
* @param {any[][]} params.params.event.rows An array of records to export
|
|
1652
|
+
* @param {object} params.event Event object
|
|
1653
|
+
* @param {ExportConfig} params.event.config Export config
|
|
1654
|
+
* @param {XLSColumn[]} params.event.columns An array of columns to export
|
|
1655
|
+
* @param {any[][]} params.event.rows An array of records to export
|
|
1802
1656
|
*/
|
|
1803
|
-
(e: 'beforeExcelExport', params: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
1657
|
+
(e: 'beforeExcelExport', params: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void)|string): boolean|void
|
|
1804
1658
|
/**
|
|
1805
1659
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
1806
1660
|
* @param {string} e Event name
|
|
1807
1661
|
* @param {object} params Event parameters
|
|
1808
|
-
* @param {
|
|
1809
|
-
* @param {
|
|
1810
|
-
* @param {
|
|
1811
|
-
* @param {Grid.util.GridLocation} params.params.event.cell Information about the column / record
|
|
1812
|
-
* @param {MouseEvent} params.params.event.domEvent The raw DOM event
|
|
1662
|
+
* @param {object} params.event Event object
|
|
1663
|
+
* @param {Grid.util.GridLocation} params.event.cell Information about the column / record
|
|
1664
|
+
* @param {MouseEvent} params.event.domEvent The raw DOM event
|
|
1813
1665
|
*/
|
|
1814
|
-
(e: 'beforeFillHandleDragStart', params: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
1666
|
+
(e: 'beforeFillHandleDragStart', params: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string): boolean|void
|
|
1815
1667
|
/**
|
|
1816
1668
|
* 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.
|
|
1817
1669
|
* @param {string} e Event name
|
|
1818
1670
|
* @param {object} params Event parameters
|
|
1819
|
-
* @param {
|
|
1820
|
-
* @param {
|
|
1821
|
-
* @param {
|
|
1822
|
-
* @param {Grid.view.Grid} params.params.event.grid Target grid
|
|
1823
|
-
* @param {CellEditorContext} params.params.event.editorContext Editing context
|
|
1671
|
+
* @param {object} params.event Event object
|
|
1672
|
+
* @param {Grid.view.Grid} params.event.grid Target grid
|
|
1673
|
+
* @param {CellEditorContext} params.event.editorContext Editing context
|
|
1824
1674
|
*/
|
|
1825
1675
|
(e: 'beforeFinishCellEdit', params: ((event: { grid: Grid, editorContext: CellEditorContext }) => void)|string): void
|
|
1826
1676
|
/**
|
|
1827
1677
|
* 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.
|
|
1828
|
-
* ...
|
|
1829
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-beforeFinishRowEdit)
|
|
1678
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-beforeFinishRowEdit)
|
|
1830
1679
|
* @param {string} e Event name
|
|
1831
1680
|
* @param {object} params Event parameters
|
|
1832
|
-
* @param {
|
|
1833
|
-
* @param {
|
|
1834
|
-
* @param {
|
|
1835
|
-
* @param {Grid.view.Grid} params.params.event.grid Target grid
|
|
1836
|
-
* @param {RowEditorContext} params.params.event.editorContext Editing context
|
|
1681
|
+
* @param {object} params.event Event object
|
|
1682
|
+
* @param {Grid.view.Grid} params.event.grid Target grid
|
|
1683
|
+
* @param {RowEditorContext} params.event.editorContext Editing context
|
|
1837
1684
|
*/
|
|
1838
1685
|
(e: 'beforeFinishRowEdit', params: ((event: { grid: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
1839
1686
|
/**
|
|
1840
1687
|
* Triggered before a widget is hidden. Return `false` to prevent the action.
|
|
1841
1688
|
* @param {string} e Event name
|
|
1842
1689
|
* @param {object} params Event parameters
|
|
1843
|
-
* @param {
|
|
1844
|
-
* @param {
|
|
1845
|
-
* @param {object} params.params.event Event object
|
|
1846
|
-
* @param {Core.widget.Widget} params.params.event.source The widget being hidden.
|
|
1690
|
+
* @param {object} params.event Event object
|
|
1691
|
+
* @param {Core.widget.Widget} params.event.source The widget being hidden.
|
|
1847
1692
|
*/
|
|
1848
|
-
(e: 'beforeHide', params: ((event: { source: Widget }) =>
|
|
1693
|
+
(e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
|
|
1849
1694
|
/**
|
|
1850
1695
|
* Fires before the component stores a record's histogram data into the cache.
|
|
1851
|
-
* ...
|
|
1852
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-beforeHistogramDataCacheSet)
|
|
1696
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-beforeHistogramDataCacheSet)
|
|
1853
1697
|
* @param {string} e Event name
|
|
1854
1698
|
* @param {object} params Event parameters
|
|
1855
|
-
* @param {
|
|
1856
|
-
* @param {
|
|
1857
|
-
* @param {
|
|
1858
|
-
* @param {
|
|
1859
|
-
* @param {Core.data.Model} params.params.event.record Record the histogram data of which is ready.
|
|
1860
|
-
* @param {object} params.params.event.data The record histogram data.
|
|
1699
|
+
* @param {object} params.event Event object
|
|
1700
|
+
* @param {Scheduler.view.TimelineHistogram} params.event.source The component instance
|
|
1701
|
+
* @param {Core.data.Model} params.event.record Record the histogram data of which is ready.
|
|
1702
|
+
* @param {object} params.event.data The record histogram data.
|
|
1861
1703
|
*/
|
|
1862
1704
|
(e: 'beforeHistogramDataCacheSet', params: ((event: { source: TimelineHistogram, record: Model, data: object }) => void)|string): void
|
|
1863
1705
|
/**
|
|
1864
1706
|
* Fires on the owning Scheduler or Gantt widget before pan starts. Return `false` to prevent the operation.
|
|
1865
1707
|
* @param {string} e Event name
|
|
1866
1708
|
* @param {object} params Event parameters
|
|
1867
|
-
* @param {
|
|
1868
|
-
* @param {
|
|
1869
|
-
* @param {object} params.params.event Event object
|
|
1870
|
-
* @param {Event} params.params.event.event The native browser DOM event
|
|
1709
|
+
* @param {object} params.event Event object
|
|
1710
|
+
* @param {Event} params.event.event The native browser DOM event
|
|
1871
1711
|
*/
|
|
1872
|
-
(e: 'beforePan', params: ((event: { event: Event }) =>
|
|
1712
|
+
(e: 'beforePan', params: ((event: { event: Event }) => boolean|void)|string): boolean|void
|
|
1873
1713
|
/**
|
|
1874
1714
|
* Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
|
|
1875
1715
|
* @param {string} e Event name
|
|
1876
1716
|
* @param {object} params Event parameters
|
|
1877
|
-
* @param {
|
|
1878
|
-
* @param {
|
|
1879
|
-
* @param {
|
|
1880
|
-
* @param {Grid.
|
|
1881
|
-
* @param {string} params.
|
|
1882
|
-
* @param {
|
|
1883
|
-
* @param {string} params.params.event.entityName 'cell' to distinguish this event from other beforePaste events
|
|
1884
|
-
* @param {string} params.params.event.text The raw text from clipboard
|
|
1717
|
+
* @param {object} params.event Event object
|
|
1718
|
+
* @param {Grid.view.Grid} params.event.source Owner grid
|
|
1719
|
+
* @param {string} params.event.clipboardData The clipboardData about to be pasted
|
|
1720
|
+
* @param {Grid.util.GridLocation} params.event.targetCell The cell from which the paste will be started
|
|
1721
|
+
* @param {string} params.event.entityName 'cell' to distinguish this event from other beforePaste events
|
|
1722
|
+
* @param {string} params.event.text The raw text from clipboard
|
|
1885
1723
|
*/
|
|
1886
1724
|
(e: 'beforePaste', params: ((event: { source: Grid, clipboardData: string, targetCell: GridLocation, entityName: string, text: string }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
1887
1725
|
/**
|
|
1888
1726
|
* Fires on the owning Grid before export started. Return `false` to cancel the export.
|
|
1889
1727
|
* @param {string} e Event name
|
|
1890
1728
|
* @param {object} params Event parameters
|
|
1891
|
-
* @param {
|
|
1892
|
-
* @param {
|
|
1893
|
-
* @param {object} params.params.event Event object
|
|
1894
|
-
* @param {PdfExportConfig} params.params.event.config Export config
|
|
1729
|
+
* @param {object} params.event Event object
|
|
1730
|
+
* @param {PdfExportConfig} params.event.config Export config
|
|
1895
1731
|
*/
|
|
1896
|
-
(e: 'beforePdfExport', params: ((event: { config: PdfExportConfig }) =>
|
|
1732
|
+
(e: 'beforePdfExport', params: ((event: { config: PdfExportConfig }) => boolean|void)|string): boolean|void
|
|
1897
1733
|
/**
|
|
1898
1734
|
* Fired before the [viewPreset](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineViewPresets#config-viewPreset) is changed.
|
|
1899
1735
|
* @param {string} e Event name
|
|
1900
1736
|
* @param {object} params Event parameters
|
|
1901
|
-
* @param {
|
|
1902
|
-
* @param {
|
|
1903
|
-
* @param {
|
|
1904
|
-
* @param {
|
|
1905
|
-
* @param {
|
|
1906
|
-
* @param {
|
|
1907
|
-
* @param {Scheduler.preset.ViewPreset} params.params.event.from The outgoing ViewPreset.
|
|
1908
|
-
* @param {Scheduler.preset.ViewPreset} params.params.event.to The ViewPreset being switched to.
|
|
1737
|
+
* @param {object} params.event Event object
|
|
1738
|
+
* @param {Scheduler.view.Scheduler} params.event.source This Scheduler instance.
|
|
1739
|
+
* @param {Date} params.event.startDate The new start date of the timeline.
|
|
1740
|
+
* @param {Date} params.event.endDate The new end date of the timeline.
|
|
1741
|
+
* @param {Scheduler.preset.ViewPreset} params.event.from The outgoing ViewPreset.
|
|
1742
|
+
* @param {Scheduler.preset.ViewPreset} params.event.to The ViewPreset being switched to.
|
|
1909
1743
|
*/
|
|
1910
|
-
(e: 'beforePresetChange', params: ((event: { source: Scheduler, startDate: Date, endDate: Date, from: ViewPreset, to: ViewPreset }) =>
|
|
1744
|
+
(e: 'beforePresetChange', params: ((event: { source: Scheduler, startDate: Date, endDate: Date, from: ViewPreset, to: ViewPreset }) => boolean|void)|string): boolean|void
|
|
1911
1745
|
/**
|
|
1912
1746
|
* Fires before the component renders a row.
|
|
1913
|
-
* ...
|
|
1914
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-beforeRenderHistogramRow)
|
|
1747
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-beforeRenderHistogramRow)
|
|
1915
1748
|
* @param {string} e Event name
|
|
1916
1749
|
* @param {object} params Event parameters
|
|
1917
|
-
* @param {
|
|
1918
|
-
* @param {
|
|
1919
|
-
* @param {
|
|
1920
|
-
* @param {
|
|
1921
|
-
* @param {Core.
|
|
1922
|
-
* @param {HistogramConfig} params.params.event.histogramConfig Configuration object that will be applied to `histogramWidget`.
|
|
1923
|
-
* @param {Core.widget.graph.Histogram} params.params.event.histogramWidget The underlying widget that is used to render a chart.
|
|
1750
|
+
* @param {object} params.event Event object
|
|
1751
|
+
* @param {Scheduler.view.TimelineHistogram} params.event.source The component instance
|
|
1752
|
+
* @param {Core.data.Model} params.event.record Record the histogram data of which is ready.
|
|
1753
|
+
* @param {HistogramConfig} params.event.histogramConfig Configuration object that will be applied to `histogramWidget`.
|
|
1754
|
+
* @param {Core.widget.graph.Histogram} params.event.histogramWidget The underlying widget that is used to render a chart.
|
|
1924
1755
|
*/
|
|
1925
1756
|
(e: 'beforeRenderHistogramRow', params: ((event: { source: TimelineHistogram, record: Model, histogramConfig: HistogramConfig, histogramWidget: Histogram }) => void)|string): void
|
|
1926
1757
|
/**
|
|
1927
1758
|
* Fires before the component renders a histogram in a cell.
|
|
1928
1759
|
* @param {string} e Event name
|
|
1929
1760
|
* @param {object} params Event parameters
|
|
1930
|
-
* @param {
|
|
1931
|
-
* @param {
|
|
1932
|
-
* @param {
|
|
1933
|
-
* @param {
|
|
1934
|
-
* @param {Core.
|
|
1935
|
-
* @param {HistogramConfig} params.params.event.histogramConfig Configuration object that will be applied to `histogramWidget`.
|
|
1936
|
-
* @param {Core.widget.graph.Histogram} params.params.event.histogramWidget The underlying widget that is used to render a chart.
|
|
1761
|
+
* @param {object} params.event Event object
|
|
1762
|
+
* @param {Scheduler.view.TimelineHistogram} params.event.source The component instance
|
|
1763
|
+
* @param {Core.data.Model} params.event.record Record the histogram data of which is ready.
|
|
1764
|
+
* @param {HistogramConfig} params.event.histogramConfig Configuration object that will be applied to `histogramWidget`.
|
|
1765
|
+
* @param {Core.widget.graph.Histogram} params.event.histogramWidget The underlying widget that is used to render a chart.
|
|
1937
1766
|
*/
|
|
1938
1767
|
(e: 'beforeRenderRecordHistogram', params: ((event: { source: TimelineHistogram, record: Model, histogramConfig: HistogramConfig, histogramWidget: Histogram }) => void)|string): void
|
|
1939
1768
|
/**
|
|
1940
1769
|
* Fires before a row is rendered.
|
|
1941
1770
|
* @param {string} e Event name
|
|
1942
1771
|
* @param {object} params Event parameters
|
|
1943
|
-
* @param {
|
|
1944
|
-
* @param {
|
|
1945
|
-
* @param {
|
|
1946
|
-
* @param {
|
|
1947
|
-
* @param {
|
|
1948
|
-
* @param {Core.data.Model} params.params.event.record The record for the row
|
|
1949
|
-
* @param {number} params.params.event.recordIndex The zero-based index of the record
|
|
1772
|
+
* @param {object} params.event Event object
|
|
1773
|
+
* @param {Grid.view.GridBase} params.event.source The firing Grid instance
|
|
1774
|
+
* @param {Grid.row.Row} params.event.row The row about to be rendered
|
|
1775
|
+
* @param {Core.data.Model} params.event.record The record for the row
|
|
1776
|
+
* @param {number} params.event.recordIndex The zero-based index of the record
|
|
1950
1777
|
*/
|
|
1951
1778
|
(e: 'beforeRenderRow', params: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string): void
|
|
1952
1779
|
/**
|
|
1953
1780
|
* Grid rows are about to be rendered
|
|
1954
1781
|
* @param {string} e Event name
|
|
1955
1782
|
* @param {object} params Event parameters
|
|
1956
|
-
* @param {
|
|
1957
|
-
* @param {
|
|
1958
|
-
* @param {object} params.params.event Event object
|
|
1959
|
-
* @param {Grid.view.GridBase} params.params.event.source This grid.
|
|
1783
|
+
* @param {object} params.event Event object
|
|
1784
|
+
* @param {Grid.view.GridBase} params.event.source This grid.
|
|
1960
1785
|
*/
|
|
1961
1786
|
(e: 'beforeRenderRows', params: ((event: { source: GridBase }) => void)|string): void
|
|
1962
1787
|
/**
|
|
1963
1788
|
* This event fires before row collapse is started.
|
|
1964
|
-
* ...
|
|
1965
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-beforeRowCollapse)
|
|
1789
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-beforeRowCollapse)
|
|
1966
1790
|
* @param {string} e Event name
|
|
1967
1791
|
* @param {object} params Event parameters
|
|
1968
|
-
* @param {
|
|
1969
|
-
* @param {
|
|
1970
|
-
* @param {object} params.params.event Event object
|
|
1971
|
-
* @param {Core.data.Model} params.params.event.record Record
|
|
1792
|
+
* @param {object} params.event Event object
|
|
1793
|
+
* @param {Core.data.Model} params.event.record Record
|
|
1972
1794
|
*/
|
|
1973
1795
|
(e: 'beforeRowCollapse', params: ((event: { record: Model }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
1974
1796
|
/**
|
|
1975
1797
|
* This event fires before row expand is started.
|
|
1976
|
-
* ...
|
|
1977
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-beforeRowExpand)
|
|
1798
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-beforeRowExpand)
|
|
1978
1799
|
* @param {string} e Event name
|
|
1979
1800
|
* @param {object} params Event parameters
|
|
1980
|
-
* @param {
|
|
1981
|
-
* @param {
|
|
1982
|
-
* @param {object} params.params.event Event object
|
|
1983
|
-
* @param {Core.data.Model} params.params.event.record Record
|
|
1801
|
+
* @param {object} params.event Event object
|
|
1802
|
+
* @param {Core.data.Model} params.event.record Record
|
|
1984
1803
|
*/
|
|
1985
1804
|
(e: 'beforeRowExpand', params: ((event: { record: Model }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
1986
1805
|
/**
|
|
1987
1806
|
* Fires before the selection changes. Returning `false` from a listener prevents the change
|
|
1988
1807
|
* @param {string} e Event name
|
|
1989
1808
|
* @param {object} params Event parameters
|
|
1990
|
-
* @param {
|
|
1991
|
-
* @param {
|
|
1992
|
-
* @param {
|
|
1993
|
-
* @param {
|
|
1994
|
-
* @param {
|
|
1995
|
-
* @param {
|
|
1996
|
-
* @param {Core.data.Model[]} params.
|
|
1997
|
-
* @param {
|
|
1998
|
-
* @param {
|
|
1999
|
-
* @param {Grid.util.GridLocation[]} params.
|
|
2000
|
-
* @param {Grid.util.GridLocation[]} params.params.event.selectedCells The cells to be selected in this operation.
|
|
2001
|
-
* @param {Grid.util.GridLocation[]} params.params.event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
1809
|
+
* @param {object} params.event Event object
|
|
1810
|
+
* @param {string} params.event.action `'select'`/`'deselect'`
|
|
1811
|
+
* @param {'row','cell'} params.event.mode `'row'`/`'cell'`
|
|
1812
|
+
* @param {Grid.view.Grid} params.event.source
|
|
1813
|
+
* @param {Core.data.Model[]} params.event.deselected The records to be deselected in this operation.
|
|
1814
|
+
* @param {Core.data.Model[]} params.event.selected The records to be selected in this operation.
|
|
1815
|
+
* @param {Core.data.Model[]} params.event.selection The records in the current selection, before applying `selected` and `deselected`
|
|
1816
|
+
* @param {Grid.util.GridLocation[]} params.event.deselectedCells The cells to be deselected in this operation.
|
|
1817
|
+
* @param {Grid.util.GridLocation[]} params.event.selectedCells The cells to be selected in this operation.
|
|
1818
|
+
* @param {Grid.util.GridLocation[]} params.event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
2002
1819
|
*/
|
|
2003
|
-
(e: 'beforeSelectionChange', params: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
1820
|
+
(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
|
|
2004
1821
|
/**
|
|
2005
1822
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
2006
1823
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
2007
1824
|
* @param {string} e Event name
|
|
2008
1825
|
* @param {object} params Event parameters
|
|
2009
|
-
* @param {
|
|
2010
|
-
* @param {
|
|
2011
|
-
* @param {
|
|
2012
|
-
* @param {Core.widget.Container} params.params.event.source The container
|
|
2013
|
-
* @param {Core.data.Model} params.params.event.record The record
|
|
1826
|
+
* @param {object} params.event Event object
|
|
1827
|
+
* @param {Core.widget.Container} params.event.source The container
|
|
1828
|
+
* @param {Core.data.Model} params.event.record The record
|
|
2014
1829
|
*/
|
|
2015
1830
|
(e: 'beforeSetRecord', params: ((event: { source: Container, record: Model }) => void)|string): void
|
|
2016
1831
|
/**
|
|
2017
1832
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
2018
1833
|
* @param {string} e Event name
|
|
2019
1834
|
* @param {object} params Event parameters
|
|
2020
|
-
* @param {
|
|
2021
|
-
* @param {
|
|
2022
|
-
* @param {object} params.params.event Event object
|
|
2023
|
-
* @param {Core.widget.Widget,any} params.params.event.source The widget being shown
|
|
1835
|
+
* @param {object} params.event Event object
|
|
1836
|
+
* @param {Core.widget.Widget,any} params.event.source The widget being shown
|
|
2024
1837
|
*/
|
|
2025
1838
|
(e: 'beforeShow', params: ((event: { source: Widget|any }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
2026
1839
|
/**
|
|
2027
1840
|
* Fires on the owning Grid before editing starts, return `false` to prevent editing
|
|
2028
1841
|
* @param {string} e Event name
|
|
2029
1842
|
* @param {object} params Event parameters
|
|
2030
|
-
* @param {
|
|
2031
|
-
* @param {
|
|
2032
|
-
* @param {
|
|
2033
|
-
* @param {Grid.view.Grid} params.params.event.source Owner grid
|
|
2034
|
-
* @param {RowEditorContext} params.params.event.editorContext Editing context
|
|
1843
|
+
* @param {object} params.event Event object
|
|
1844
|
+
* @param {Grid.view.Grid} params.event.source Owner grid
|
|
1845
|
+
* @param {RowEditorContext} params.event.editorContext Editing context
|
|
2035
1846
|
*/
|
|
2036
|
-
(e: 'beforeStartRowEdit', params: ((event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
1847
|
+
(e: 'beforeStartRowEdit', params: ((event: { source: Grid, editorContext: RowEditorContext }) => boolean|void)|string): boolean|void
|
|
2037
1848
|
/**
|
|
2038
1849
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
2039
1850
|
* @param {string} e Event name
|
|
2040
1851
|
* @param {object} params Event parameters
|
|
2041
|
-
* @param {
|
|
2042
|
-
* @param {
|
|
2043
|
-
* @param {object} params.params.event Event object
|
|
2044
|
-
* @param {GridStateInfo} params.params.event.state State object config
|
|
1852
|
+
* @param {object} params.event Event object
|
|
1853
|
+
* @param {GridStateInfo} params.event.state State object config
|
|
2045
1854
|
*/
|
|
2046
|
-
(e: 'beforeStateApply', params: ((event: { state: GridStateInfo }) =>
|
|
1855
|
+
(e: 'beforeStateApply', params: ((event: { state: GridStateInfo }) => boolean|void)|string): boolean|void
|
|
2047
1856
|
/**
|
|
2048
1857
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
2049
1858
|
* @param {string} e Event name
|
|
2050
1859
|
* @param {object} params Event parameters
|
|
2051
|
-
* @param {
|
|
2052
|
-
* @param {
|
|
2053
|
-
* @param {object} params.params.event Event object
|
|
2054
|
-
* @param {GridStateInfo} params.params.event.state State object config
|
|
1860
|
+
* @param {object} params.event Event object
|
|
1861
|
+
* @param {GridStateInfo} params.event.state State object config
|
|
2055
1862
|
*/
|
|
2056
|
-
(e: 'beforeStateSave', params: ((event: { state: GridStateInfo }) =>
|
|
1863
|
+
(e: 'beforeStateSave', params: ((event: { state: GridStateInfo }) => boolean|void)|string): boolean|void
|
|
2057
1864
|
/**
|
|
2058
1865
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
2059
1866
|
* Returning `false` from a listener prevents the operation
|
|
2060
1867
|
* @param {string} e Event name
|
|
2061
1868
|
* @param {object} params Event parameters
|
|
2062
|
-
* @param {
|
|
2063
|
-
* @param {
|
|
2064
|
-
* @param {
|
|
2065
|
-
* @param {
|
|
2066
|
-
* @param {
|
|
2067
|
-
* @param {boolean} params.params.event.collapse Collapsed (true) or expanded (false)
|
|
2068
|
-
* @param {Event} params.params.event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
1869
|
+
* @param {object} params.event Event object
|
|
1870
|
+
* @param {Core.data.Model} params.event.groupRecord [DEPRECATED] Use `groupRecords` param instead
|
|
1871
|
+
* @param {Core.data.Model[]} params.event.groupRecords The group records being toggled
|
|
1872
|
+
* @param {boolean} params.event.collapse Collapsed (true) or expanded (false)
|
|
1873
|
+
* @param {Event} params.event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
2069
1874
|
*/
|
|
2070
|
-
(e: 'beforeToggleGroup', params: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
1875
|
+
(e: 'beforeToggleGroup', params: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void)|string): boolean|void
|
|
2071
1876
|
/**
|
|
2072
1877
|
* Fired before a parent node record toggles its collapsed state.
|
|
2073
1878
|
* @param {string} e Event name
|
|
2074
1879
|
* @param {object} params Event parameters
|
|
2075
|
-
* @param {
|
|
2076
|
-
* @param {
|
|
2077
|
-
* @param {
|
|
2078
|
-
* @param {
|
|
2079
|
-
* @param {Core.data.Model} params.params.event.record The record being toggled.
|
|
2080
|
-
* @param {boolean} params.params.event.collapse `true` if the node is being collapsed.
|
|
1880
|
+
* @param {object} params.event Event object
|
|
1881
|
+
* @param {Grid.view.Grid} params.event.source The firing Grid instance.
|
|
1882
|
+
* @param {Core.data.Model} params.event.record The record being toggled.
|
|
1883
|
+
* @param {boolean} params.event.collapse `true` if the node is being collapsed.
|
|
2081
1884
|
*/
|
|
2082
1885
|
(e: 'beforeToggleNode', params: ((event: { source: Grid, record: Model, collapse: boolean }) => void)|string): void
|
|
2083
1886
|
/**
|
|
2084
1887
|
* Fires on the owning Grid when editing is cancelled
|
|
2085
1888
|
* @param {string} e Event name
|
|
2086
1889
|
* @param {object} params Event parameters
|
|
2087
|
-
* @param {
|
|
2088
|
-
* @param {
|
|
2089
|
-
* @param {
|
|
2090
|
-
* @param {
|
|
2091
|
-
* @param {Grid.util.GridLocation} params.params.event.editorContext Editing context
|
|
2092
|
-
* @param {Event} params.params.event.event Included if the cancellation was triggered by a DOM event
|
|
1890
|
+
* @param {object} params.event Event object
|
|
1891
|
+
* @param {Grid.view.Grid} params.event.source Owner grid
|
|
1892
|
+
* @param {Grid.util.GridLocation} params.event.editorContext Editing context
|
|
1893
|
+
* @param {Event} params.event.event Included if the cancellation was triggered by a DOM event
|
|
2093
1894
|
*/
|
|
2094
1895
|
(e: 'cancelCellEdit', params: ((event: { source: Grid, editorContext: GridLocation, event: Event }) => void)|string): void
|
|
2095
1896
|
/**
|
|
2096
1897
|
* Fires when any other event is fired from the object.
|
|
2097
|
-
* ...
|
|
2098
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-catchAll)
|
|
1898
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-catchAll)
|
|
2099
1899
|
* @param {string} e Event name
|
|
2100
1900
|
* @param {object} params Event parameters
|
|
2101
|
-
* @param {
|
|
2102
|
-
* @param {
|
|
2103
|
-
* @param {
|
|
2104
|
-
* @param {{[key: string]: any, type: string}} params.params.event.event The Object that contains event details
|
|
2105
|
-
* @param {string} params.params.event.event.type The type of the event which is caught by the listener
|
|
1901
|
+
* @param {object} params.event Event object
|
|
1902
|
+
* @param {{[key: string]: any, type: string}} params.event.event The Object that contains event details
|
|
1903
|
+
* @param {string} params.event.event.type The type of the event which is caught by the listener
|
|
2106
1904
|
*/
|
|
2107
1905
|
(e: 'catchAll', params: ((event: {[key: string]: any, type: string}) => void)|string): void
|
|
2108
1906
|
/**
|
|
2109
1907
|
* Fired when user clicks in a grid cell
|
|
2110
1908
|
* @param {string} e Event name
|
|
2111
1909
|
* @param {object} params Event parameters
|
|
2112
|
-
* @param {
|
|
2113
|
-
* @param {
|
|
2114
|
-
* @param {
|
|
2115
|
-
* @param {Grid.
|
|
2116
|
-
* @param {
|
|
2117
|
-
* @param {
|
|
2118
|
-
* @param {
|
|
2119
|
-
* @param {HTMLElement} params.params.event.target The target element
|
|
2120
|
-
* @param {MouseEvent} params.params.event.event The native DOM event
|
|
1910
|
+
* @param {object} params.event Event object
|
|
1911
|
+
* @param {Grid.view.Grid} params.event.grid The grid instance
|
|
1912
|
+
* @param {Core.data.Model} params.event.record The record representing the row
|
|
1913
|
+
* @param {Grid.column.Column} params.event.column The column to which the cell belongs
|
|
1914
|
+
* @param {HTMLElement} params.event.cellElement The cell HTML element
|
|
1915
|
+
* @param {HTMLElement} params.event.target The target element
|
|
1916
|
+
* @param {MouseEvent} params.event.event The native DOM event
|
|
2121
1917
|
*/
|
|
2122
1918
|
(e: 'cellClick', params: ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string): void
|
|
2123
1919
|
/**
|
|
2124
1920
|
* Fired when user activates contextmenu in a grid cell
|
|
2125
1921
|
* @param {string} e Event name
|
|
2126
1922
|
* @param {object} params Event parameters
|
|
2127
|
-
* @param {
|
|
2128
|
-
* @param {
|
|
2129
|
-
* @param {
|
|
2130
|
-
* @param {Grid.
|
|
2131
|
-
* @param {
|
|
2132
|
-
* @param {
|
|
2133
|
-
* @param {
|
|
2134
|
-
* @param {HTMLElement} params.params.event.target The target element
|
|
2135
|
-
* @param {MouseEvent} params.params.event.event The native DOM event
|
|
1923
|
+
* @param {object} params.event Event object
|
|
1924
|
+
* @param {Grid.view.Grid} params.event.grid The grid instance
|
|
1925
|
+
* @param {Core.data.Model} params.event.record The record representing the row
|
|
1926
|
+
* @param {Grid.column.Column} params.event.column The column to which the cell belongs
|
|
1927
|
+
* @param {HTMLElement} params.event.cellElement The cell HTML element
|
|
1928
|
+
* @param {HTMLElement} params.event.target The target element
|
|
1929
|
+
* @param {MouseEvent} params.event.event The native DOM event
|
|
2136
1930
|
*/
|
|
2137
1931
|
(e: 'cellContextMenu', params: ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string): void
|
|
2138
1932
|
/**
|
|
2139
1933
|
* Fired when user double clicks a grid cell
|
|
2140
1934
|
* @param {string} e Event name
|
|
2141
1935
|
* @param {object} params Event parameters
|
|
2142
|
-
* @param {
|
|
2143
|
-
* @param {
|
|
2144
|
-
* @param {
|
|
2145
|
-
* @param {Grid.
|
|
2146
|
-
* @param {
|
|
2147
|
-
* @param {
|
|
2148
|
-
* @param {
|
|
2149
|
-
* @param {HTMLElement} params.params.event.target The target element
|
|
2150
|
-
* @param {MouseEvent} params.params.event.event The native DOM event
|
|
1936
|
+
* @param {object} params.event Event object
|
|
1937
|
+
* @param {Grid.view.Grid} params.event.grid The grid instance
|
|
1938
|
+
* @param {Core.data.Model} params.event.record The record representing the row
|
|
1939
|
+
* @param {Grid.column.Column} params.event.column The column to which the cell belongs
|
|
1940
|
+
* @param {HTMLElement} params.event.cellElement The cell HTML element
|
|
1941
|
+
* @param {HTMLElement} params.event.target The target element
|
|
1942
|
+
* @param {MouseEvent} params.event.event The native DOM event
|
|
2151
1943
|
*/
|
|
2152
1944
|
(e: 'cellDblClick', params: ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string): void
|
|
2153
1945
|
/**
|
|
2154
1946
|
* This event fires on the owning grid before the context menu is shown for a cell.
|
|
2155
1947
|
* Allows manipulation of the items to show in the same way as in the [processItems](https://bryntum.com/products/scheduler/docs/api/Grid/feature/CellMenu#config-processItems).
|
|
2156
|
-
* ...
|
|
2157
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-cellMenuBeforeShow)
|
|
1948
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-cellMenuBeforeShow)
|
|
2158
1949
|
* @param {string} e Event name
|
|
2159
1950
|
* @param {object} params Event parameters
|
|
2160
|
-
* @param {
|
|
2161
|
-
* @param {
|
|
2162
|
-
* @param {
|
|
2163
|
-
* @param {
|
|
2164
|
-
* @param {
|
|
2165
|
-
* @param {
|
|
2166
|
-
* @param {Grid.column.Column} params.params.event.column Column
|
|
2167
|
-
* @param {Core.data.Model} params.params.event.record Record
|
|
1951
|
+
* @param {object} params.event Event object
|
|
1952
|
+
* @param {Grid.view.Grid} params.event.source The grid
|
|
1953
|
+
* @param {Core.widget.Menu} params.event.menu The menu
|
|
1954
|
+
* @param {Record<string, MenuItemEntry>} params.event.items Menu item configs
|
|
1955
|
+
* @param {Grid.column.Column} params.event.column Column
|
|
1956
|
+
* @param {Core.data.Model} params.event.record Record
|
|
2168
1957
|
*/
|
|
2169
|
-
(e: 'cellMenuBeforeShow', params: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
1958
|
+
(e: 'cellMenuBeforeShow', params: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void)|string): boolean|void
|
|
2170
1959
|
/**
|
|
2171
1960
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
2172
1961
|
* @param {string} e Event name
|
|
2173
1962
|
* @param {object} params Event parameters
|
|
2174
|
-
* @param {
|
|
2175
|
-
* @param {
|
|
2176
|
-
* @param {
|
|
2177
|
-
* @param {
|
|
2178
|
-
* @param {
|
|
2179
|
-
* @param {Core.
|
|
2180
|
-
* @param {Grid.column.Column} params.params.event.column Column
|
|
2181
|
-
* @param {Core.data.Model} params.params.event.record Record
|
|
1963
|
+
* @param {object} params.event Event object
|
|
1964
|
+
* @param {Grid.view.Grid} params.event.source The grid
|
|
1965
|
+
* @param {Core.widget.Menu} params.event.menu The menu
|
|
1966
|
+
* @param {Core.widget.MenuItem} params.event.item Selected menu item
|
|
1967
|
+
* @param {Grid.column.Column} params.event.column Column
|
|
1968
|
+
* @param {Core.data.Model} params.event.record Record
|
|
2182
1969
|
*/
|
|
2183
1970
|
(e: 'cellMenuItem', params: ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column, record: Model }) => void)|string): void
|
|
2184
1971
|
/**
|
|
2185
1972
|
* This event fires on the owning grid after the context menu is shown for a cell.
|
|
2186
1973
|
* @param {string} e Event name
|
|
2187
1974
|
* @param {object} params Event parameters
|
|
2188
|
-
* @param {
|
|
2189
|
-
* @param {
|
|
2190
|
-
* @param {
|
|
2191
|
-
* @param {
|
|
2192
|
-
* @param {
|
|
2193
|
-
* @param {
|
|
2194
|
-
* @param {Grid.column.Column} params.params.event.column Column
|
|
2195
|
-
* @param {Core.data.Model} params.params.event.record Record
|
|
1975
|
+
* @param {object} params.event Event object
|
|
1976
|
+
* @param {Grid.view.Grid} params.event.source The grid
|
|
1977
|
+
* @param {Core.widget.Menu} params.event.menu The menu
|
|
1978
|
+
* @param {Record<string, MenuItemEntry>} params.event.items Menu item configs
|
|
1979
|
+
* @param {Grid.column.Column} params.event.column Column
|
|
1980
|
+
* @param {Core.data.Model} params.event.record Record
|
|
2196
1981
|
*/
|
|
2197
1982
|
(e: 'cellMenuShow', params: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => void)|string): void
|
|
2198
1983
|
/**
|
|
2199
1984
|
* This event fires on the owning grid when a check item is toggled in the cell context menu.
|
|
2200
1985
|
* @param {string} e Event name
|
|
2201
1986
|
* @param {object} params Event parameters
|
|
2202
|
-
* @param {
|
|
2203
|
-
* @param {
|
|
2204
|
-
* @param {
|
|
2205
|
-
* @param {
|
|
2206
|
-
* @param {
|
|
2207
|
-
* @param {Core.
|
|
2208
|
-
* @param {
|
|
2209
|
-
* @param {Core.data.Model} params.params.event.record Record
|
|
2210
|
-
* @param {boolean} params.params.event.checked Checked or not
|
|
1987
|
+
* @param {object} params.event Event object
|
|
1988
|
+
* @param {Grid.view.Grid} params.event.source The grid
|
|
1989
|
+
* @param {Core.widget.Menu} params.event.menu The menu
|
|
1990
|
+
* @param {Core.widget.MenuItem} params.event.item Selected menu item
|
|
1991
|
+
* @param {Grid.column.Column} params.event.column Column
|
|
1992
|
+
* @param {Core.data.Model} params.event.record Record
|
|
1993
|
+
* @param {boolean} params.event.checked Checked or not
|
|
2211
1994
|
*/
|
|
2212
1995
|
(e: 'cellMenuToggleItem', params: ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column, record: Model, checked: boolean }) => void)|string): void
|
|
2213
1996
|
/**
|
|
2214
1997
|
* Fired when the mouse enters a cell
|
|
2215
1998
|
* @param {string} e Event name
|
|
2216
1999
|
* @param {object} params Event parameters
|
|
2217
|
-
* @param {
|
|
2218
|
-
* @param {
|
|
2219
|
-
* @param {
|
|
2220
|
-
* @param {Grid.
|
|
2221
|
-
* @param {
|
|
2222
|
-
* @param {
|
|
2223
|
-
* @param {HTMLElement} params.params.event.cellElement The cell HTML element
|
|
2224
|
-
* @param {MouseEvent} params.params.event.event The native DOM event
|
|
2000
|
+
* @param {object} params.event Event object
|
|
2001
|
+
* @param {Grid.view.Grid} params.event.source The grid instance
|
|
2002
|
+
* @param {Core.data.Model} params.event.record The record representing the hovered cell
|
|
2003
|
+
* @param {Grid.column.Column} params.event.column The column currently hovered
|
|
2004
|
+
* @param {HTMLElement} params.event.cellElement The cell HTML element
|
|
2005
|
+
* @param {MouseEvent} params.event.event The native DOM event
|
|
2225
2006
|
*/
|
|
2226
2007
|
(e: 'cellMouseEnter', params: ((event: { source: Grid, record: Model, column: Column, cellElement: HTMLElement, event: MouseEvent }) => void)|string): void
|
|
2227
2008
|
/**
|
|
2228
2009
|
* Fired when the mouse leaves a cell
|
|
2229
2010
|
* @param {string} e Event name
|
|
2230
2011
|
* @param {object} params Event parameters
|
|
2231
|
-
* @param {
|
|
2232
|
-
* @param {
|
|
2233
|
-
* @param {
|
|
2234
|
-
* @param {Grid.
|
|
2235
|
-
* @param {
|
|
2236
|
-
* @param {
|
|
2237
|
-
* @param {HTMLElement} params.params.event.cellElement The cell HTML element that the mouse left
|
|
2238
|
-
* @param {MouseEvent} params.params.event.event The native DOM event
|
|
2012
|
+
* @param {object} params.event Event object
|
|
2013
|
+
* @param {Grid.view.Grid} params.event.source The grid instance
|
|
2014
|
+
* @param {Core.data.Model} params.event.record The record representing the cell that the mouse left
|
|
2015
|
+
* @param {Grid.column.Column} params.event.column The column representing the cell that the mouse left
|
|
2016
|
+
* @param {HTMLElement} params.event.cellElement The cell HTML element that the mouse left
|
|
2017
|
+
* @param {MouseEvent} params.event.event The native DOM event
|
|
2239
2018
|
*/
|
|
2240
2019
|
(e: 'cellMouseLeave', params: ((event: { source: Grid, record: Model, column: Column, cellElement: HTMLElement, event: MouseEvent }) => void)|string): void
|
|
2241
2020
|
/**
|
|
2242
2021
|
* Fired when a user moves the mouse out of a grid cell
|
|
2243
2022
|
* @param {string} e Event name
|
|
2244
2023
|
* @param {object} params Event parameters
|
|
2245
|
-
* @param {
|
|
2246
|
-
* @param {
|
|
2247
|
-
* @param {
|
|
2248
|
-
* @param {Grid.
|
|
2249
|
-
* @param {
|
|
2250
|
-
* @param {
|
|
2251
|
-
* @param {
|
|
2252
|
-
* @param {HTMLElement} params.params.event.target The target element
|
|
2253
|
-
* @param {MouseEvent} params.params.event.event The native DOM event
|
|
2024
|
+
* @param {object} params.event Event object
|
|
2025
|
+
* @param {Grid.view.Grid} params.event.grid The grid instance
|
|
2026
|
+
* @param {Core.data.Model} params.event.record The record representing the row
|
|
2027
|
+
* @param {Grid.column.Column} params.event.column The column to which the cell belongs
|
|
2028
|
+
* @param {HTMLElement} params.event.cellElement The cell HTML element
|
|
2029
|
+
* @param {HTMLElement} params.event.target The target element
|
|
2030
|
+
* @param {MouseEvent} params.event.event The native DOM event
|
|
2254
2031
|
*/
|
|
2255
2032
|
(e: 'cellMouseOut', params: ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string): void
|
|
2256
2033
|
/**
|
|
2257
2034
|
* Fired when user moves the mouse over a grid cell
|
|
2258
2035
|
* @param {string} e Event name
|
|
2259
2036
|
* @param {object} params Event parameters
|
|
2260
|
-
* @param {
|
|
2261
|
-
* @param {
|
|
2262
|
-
* @param {
|
|
2263
|
-
* @param {Grid.
|
|
2264
|
-
* @param {
|
|
2265
|
-
* @param {
|
|
2266
|
-
* @param {
|
|
2267
|
-
* @param {HTMLElement} params.params.event.target The target element
|
|
2268
|
-
* @param {MouseEvent} params.params.event.event The native DOM event
|
|
2037
|
+
* @param {object} params.event Event object
|
|
2038
|
+
* @param {Grid.view.Grid} params.event.grid The grid instance
|
|
2039
|
+
* @param {Core.data.Model} params.event.record The record representing the row
|
|
2040
|
+
* @param {Grid.column.Column} params.event.column The column to which the cell belongs
|
|
2041
|
+
* @param {HTMLElement} params.event.cellElement The cell HTML element
|
|
2042
|
+
* @param {HTMLElement} params.event.target The target element
|
|
2043
|
+
* @param {MouseEvent} params.event.event The native DOM event
|
|
2269
2044
|
*/
|
|
2270
2045
|
(e: 'cellMouseOver', params: ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string): void
|
|
2271
2046
|
/**
|
|
2272
2047
|
* Fires when a Panel is collapsed using the [collapsible](https://bryntum.com/products/scheduler/docs/api/Core/widget/Panel#config-collapsible) setting.
|
|
2273
2048
|
* @param {string} e Event name
|
|
2274
2049
|
* @param {object} params Event parameters
|
|
2275
|
-
* @param {
|
|
2276
|
-
* @param {
|
|
2277
|
-
* @param {object} params.params.event Event object
|
|
2278
|
-
* @param {Core.widget.Panel} params.params.event.source This Panel.
|
|
2050
|
+
* @param {object} params.event Event object
|
|
2051
|
+
* @param {Core.widget.Panel} params.event.source This Panel.
|
|
2279
2052
|
*/
|
|
2280
2053
|
(e: 'collapse', params: ((event: { source: Panel }) => void)|string): void
|
|
2281
2054
|
/**
|
|
2282
2055
|
* Fired before a parent node record is collapsed.
|
|
2283
2056
|
* @param {string} e Event name
|
|
2284
2057
|
* @param {object} params Event parameters
|
|
2285
|
-
* @param {
|
|
2286
|
-
* @param {
|
|
2287
|
-
* @param {
|
|
2288
|
-
* @param {Grid.view.Grid} params.params.event.source The firing Grid instance.
|
|
2289
|
-
* @param {Core.data.Model} params.params.event.record The record which has been collapsed.
|
|
2058
|
+
* @param {object} params.event Event object
|
|
2059
|
+
* @param {Grid.view.Grid} params.event.source The firing Grid instance.
|
|
2060
|
+
* @param {Core.data.Model} params.event.record The record which has been collapsed.
|
|
2290
2061
|
*/
|
|
2291
2062
|
(e: 'collapseNode', params: ((event: { source: Grid, record: Model }) => void)|string): void
|
|
2292
2063
|
/**
|
|
2293
2064
|
* This event is triggered after a parent column has been collapsed or expanded.
|
|
2294
2065
|
* @param {string} e Event name
|
|
2295
2066
|
* @param {object} params Event parameters
|
|
2296
|
-
* @param {
|
|
2297
|
-
* @param {
|
|
2298
|
-
* @param {
|
|
2299
|
-
* @param {
|
|
2300
|
-
* @param {Grid.column.Column} params.params.event.column The column being toggled
|
|
2301
|
-
* @param {boolean} params.params.event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
2067
|
+
* @param {object} params.event Event object
|
|
2068
|
+
* @param {Grid.view.GridBase} params.event.source The Grid instance
|
|
2069
|
+
* @param {Grid.column.Column} params.event.column The column being toggled
|
|
2070
|
+
* @param {boolean} params.event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
2302
2071
|
*/
|
|
2303
2072
|
(e: 'columnCollapseToggle', params: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string): void
|
|
2304
2073
|
/**
|
|
@@ -2306,27 +2075,23 @@ const emit = defineEmits<{
|
|
|
2306
2075
|
* to indicate whether the drop position is valid or not.
|
|
2307
2076
|
* @param {string} e Event name
|
|
2308
2077
|
* @param {object} params Event parameters
|
|
2309
|
-
* @param {
|
|
2310
|
-
* @param {
|
|
2311
|
-
* @param {
|
|
2312
|
-
* @param {Grid.
|
|
2313
|
-
* @param {
|
|
2314
|
-
* @param {
|
|
2315
|
-
* @param {
|
|
2316
|
-
* @param {object} params.params.event.context
|
|
2317
|
-
* @param {boolean} params.params.event.context.valid Set this to `true` or `false` to indicate whether the drop position is valid.
|
|
2078
|
+
* @param {object} params.event Event object
|
|
2079
|
+
* @param {Grid.view.Grid} params.event.source The grid instance.
|
|
2080
|
+
* @param {Grid.column.Column} params.event.column The dragged column.
|
|
2081
|
+
* @param {Grid.column.Column} params.event.insertBefore The column before which the dragged column will be inserted (if not last).
|
|
2082
|
+
* @param {Event} params.event.event The browser event.
|
|
2083
|
+
* @param {object} params.event.context
|
|
2084
|
+
* @param {boolean} params.event.context.valid Set this to `true` or `false` to indicate whether the drop position is valid.
|
|
2318
2085
|
*/
|
|
2319
2086
|
(e: 'columnDrag', params: ((event: { source: Grid, column: Column, insertBefore: Column, event: Event, context: { valid: boolean } }) => void)|string): void
|
|
2320
2087
|
/**
|
|
2321
2088
|
* This event is fired when a column drag gesture has started.
|
|
2322
2089
|
* @param {string} e Event name
|
|
2323
2090
|
* @param {object} params Event parameters
|
|
2324
|
-
* @param {
|
|
2325
|
-
* @param {
|
|
2326
|
-
* @param {
|
|
2327
|
-
* @param {
|
|
2328
|
-
* @param {Grid.column.Column} params.params.event.column The dragged column.
|
|
2329
|
-
* @param {Event} params.params.event.event The browser event.
|
|
2091
|
+
* @param {object} params.event Event object
|
|
2092
|
+
* @param {Grid.view.Grid} params.event.source The grid instance.
|
|
2093
|
+
* @param {Grid.column.Column} params.event.column The dragged column.
|
|
2094
|
+
* @param {Event} params.event.event The browser event.
|
|
2330
2095
|
*/
|
|
2331
2096
|
(e: 'columnDragStart', params: ((event: { source: Grid, column: Column, event: Event }) => void)|string): void
|
|
2332
2097
|
/**
|
|
@@ -2334,148 +2099,124 @@ const emit = defineEmits<{
|
|
|
2334
2099
|
* vetoed and the column was moved in the column store.
|
|
2335
2100
|
* @param {string} e Event name
|
|
2336
2101
|
* @param {object} params Event parameters
|
|
2337
|
-
* @param {
|
|
2338
|
-
* @param {
|
|
2339
|
-
* @param {
|
|
2340
|
-
* @param {Grid.
|
|
2341
|
-
* @param {Grid.column.Column} params.
|
|
2342
|
-
* @param {
|
|
2343
|
-
* @param {
|
|
2344
|
-
* @param {
|
|
2345
|
-
* @param {Event} params.params.event.event The browser event.
|
|
2346
|
-
* @param {string} params.params.event.region The region where the column was dropped.
|
|
2102
|
+
* @param {object} params.event Event object
|
|
2103
|
+
* @param {Grid.view.Grid} params.event.source The grid instance.
|
|
2104
|
+
* @param {Grid.column.Column} params.event.column The dragged column.
|
|
2105
|
+
* @param {Grid.column.Column} params.event.insertBefore The column before which the dragged column will be inserted.
|
|
2106
|
+
* @param {Grid.column.Column} params.event.newParent The new parent column.
|
|
2107
|
+
* @param {boolean} params.event.valid `true` if the operation was not vetoed.
|
|
2108
|
+
* @param {Event} params.event.event The browser event.
|
|
2109
|
+
* @param {string} params.event.region The region where the column was dropped.
|
|
2347
2110
|
*/
|
|
2348
|
-
(e: 'columnDrop', params: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
2111
|
+
(e: 'columnDrop', params: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void)|string): boolean|void
|
|
2349
2112
|
/**
|
|
2350
2113
|
* This event is fired after a resize gesture is completed.
|
|
2351
2114
|
* @param {string} e Event name
|
|
2352
2115
|
* @param {object} params Event parameters
|
|
2353
|
-
* @param {
|
|
2354
|
-
* @param {
|
|
2355
|
-
* @param {
|
|
2356
|
-
* @param {
|
|
2357
|
-
* @param {Grid.column.Column} params.params.event.column The resized column
|
|
2358
|
-
* @param {Event} params.params.event.domEvent The browser event
|
|
2116
|
+
* @param {object} params.event Event object
|
|
2117
|
+
* @param {Grid.view.Grid} params.event.source The grid instance
|
|
2118
|
+
* @param {Grid.column.Column} params.event.column The resized column
|
|
2119
|
+
* @param {Event} params.event.domEvent The browser event
|
|
2359
2120
|
*/
|
|
2360
2121
|
(e: 'columnResize', params: ((event: { source: Grid, column: Column, domEvent: Event }) => void)|string): void
|
|
2361
2122
|
/**
|
|
2362
2123
|
* This event is fired when a column resize gesture starts.
|
|
2363
2124
|
* @param {string} e Event name
|
|
2364
2125
|
* @param {object} params Event parameters
|
|
2365
|
-
* @param {
|
|
2366
|
-
* @param {
|
|
2367
|
-
* @param {
|
|
2368
|
-
* @param {
|
|
2369
|
-
* @param {Grid.column.Column} params.params.event.column The column
|
|
2370
|
-
* @param {Event} params.params.event.domEvent The browser event
|
|
2126
|
+
* @param {object} params.event Event object
|
|
2127
|
+
* @param {Grid.view.Grid} params.event.source The grid instance
|
|
2128
|
+
* @param {Grid.column.Column} params.event.column The column
|
|
2129
|
+
* @param {Event} params.event.domEvent The browser event
|
|
2371
2130
|
*/
|
|
2372
2131
|
(e: 'columnResizeStart', params: ((event: { source: Grid, column: Column, domEvent: Event }) => void)|string): void
|
|
2373
2132
|
/**
|
|
2374
2133
|
* This event fires on the owning widget when an item is selected in the context menu.
|
|
2375
2134
|
* @param {string} e Event name
|
|
2376
2135
|
* @param {object} params Event parameters
|
|
2377
|
-
* @param {
|
|
2378
|
-
* @param {
|
|
2379
|
-
* @param {
|
|
2380
|
-
* @param {Core.widget.
|
|
2381
|
-
* @param {Core.widget.Menu} params.params.event.menu The menu
|
|
2382
|
-
* @param {Core.widget.MenuItem} params.params.event.item Selected menu item
|
|
2136
|
+
* @param {object} params.event Event object
|
|
2137
|
+
* @param {Core.widget.Widget} params.event.source The owning widget
|
|
2138
|
+
* @param {Core.widget.Menu} params.event.menu The menu
|
|
2139
|
+
* @param {Core.widget.MenuItem} params.event.item Selected menu item
|
|
2383
2140
|
*/
|
|
2384
2141
|
(e: 'contextMenuItem', params: ((event: { source: Widget, menu: Menu, item: MenuItem }) => void)|string): void
|
|
2385
2142
|
/**
|
|
2386
2143
|
* This event fires on the owning widget when a check item is toggled in the context menu.
|
|
2387
2144
|
* @param {string} e Event name
|
|
2388
2145
|
* @param {object} params Event parameters
|
|
2389
|
-
* @param {
|
|
2390
|
-
* @param {
|
|
2391
|
-
* @param {
|
|
2392
|
-
* @param {Core.widget.
|
|
2393
|
-
* @param {
|
|
2394
|
-
* @param {Core.widget.MenuItem} params.params.event.item Selected menu item
|
|
2395
|
-
* @param {boolean} params.params.event.checked Checked or not
|
|
2146
|
+
* @param {object} params.event Event object
|
|
2147
|
+
* @param {Core.widget.Widget} params.event.source The owning widget
|
|
2148
|
+
* @param {Core.widget.Menu} params.event.menu The menu
|
|
2149
|
+
* @param {Core.widget.MenuItem} params.event.item Selected menu item
|
|
2150
|
+
* @param {boolean} params.event.checked Checked or not
|
|
2396
2151
|
*/
|
|
2397
2152
|
(e: 'contextMenuToggleItem', params: ((event: { source: Widget, menu: Menu, item: MenuItem, checked: boolean }) => void)|string): void
|
|
2398
2153
|
/**
|
|
2399
2154
|
* Fires on the owning Grid after a copy action is performed.
|
|
2400
2155
|
* @param {string} e Event name
|
|
2401
2156
|
* @param {object} params Event parameters
|
|
2402
|
-
* @param {
|
|
2403
|
-
* @param {
|
|
2404
|
-
* @param {
|
|
2405
|
-
* @param {
|
|
2406
|
-
* @param {
|
|
2407
|
-
* @param {string} params.
|
|
2408
|
-
* @param {boolean} params.params.event.isCut `true` if this was a cut action
|
|
2409
|
-
* @param {string} params.params.event.entityName 'cell' to distinguish this event from other copy events
|
|
2157
|
+
* @param {object} params.event Event object
|
|
2158
|
+
* @param {Grid.view.Grid} params.event.source Owner grid
|
|
2159
|
+
* @param {Grid.util.GridLocation[]} params.event.cells The cells about to be copied or cut
|
|
2160
|
+
* @param {string} params.event.copiedDataString The concatenated data string that was copied or cut
|
|
2161
|
+
* @param {boolean} params.event.isCut `true` if this was a cut action
|
|
2162
|
+
* @param {string} params.event.entityName 'cell' to distinguish this event from other copy events
|
|
2410
2163
|
*/
|
|
2411
2164
|
(e: 'copy', params: ((event: { source: Grid, cells: GridLocation[], copiedDataString: string, isCut: boolean, entityName: string }) => void)|string): void
|
|
2412
2165
|
/**
|
|
2413
2166
|
* Fires on the owning Scheduler/Gantt when the line indicating the current time is updated (see [currentTimeLineUpdateInterval](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/TimeRanges#config-currentTimeLineUpdateInterval)).
|
|
2414
2167
|
* @param {string} e Event name
|
|
2415
2168
|
* @param {object} params Event parameters
|
|
2416
|
-
* @param {
|
|
2417
|
-
* @param {
|
|
2418
|
-
* @param {
|
|
2419
|
-
* @param {Scheduler.view.Scheduler} params.params.event.source The scheduler
|
|
2420
|
-
* @param {Date} params.params.event.date The current date
|
|
2169
|
+
* @param {object} params.event Event object
|
|
2170
|
+
* @param {Scheduler.view.Scheduler} params.event.source The scheduler
|
|
2171
|
+
* @param {Date} params.event.date The current date
|
|
2421
2172
|
*/
|
|
2422
2173
|
(e: 'currentTimelineUpdate', params: ((event: { source: Scheduler, date: Date }) => void)|string): void
|
|
2423
2174
|
/**
|
|
2424
2175
|
* Fired when data in the store changes.
|
|
2425
|
-
* ...
|
|
2426
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-dataChange)
|
|
2176
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-dataChange)
|
|
2427
2177
|
* @param {string} e Event name
|
|
2428
2178
|
* @param {object} params Event parameters
|
|
2429
|
-
* @param {
|
|
2430
|
-
* @param {
|
|
2431
|
-
* @param {
|
|
2432
|
-
* @param {
|
|
2433
|
-
* @param {Core.data.
|
|
2434
|
-
* @param {
|
|
2435
|
-
* @param {
|
|
2436
|
-
* @param {Core.data.Model[]} params.params.event.records Changed records, passed for all actions except `'removeAll'`
|
|
2437
|
-
* @param {object} params.params.event.changes Passed for the `'update'` action, info on which record fields changed
|
|
2179
|
+
* @param {object} params.event Event object
|
|
2180
|
+
* @param {Grid.view.GridBase} params.event.source Owning grid
|
|
2181
|
+
* @param {Core.data.Store} params.event.store The originating store
|
|
2182
|
+
* @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'`
|
|
2183
|
+
* @param {Core.data.Model} params.event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
2184
|
+
* @param {Core.data.Model[]} params.event.records Changed records, passed for all actions except `'removeAll'`
|
|
2185
|
+
* @param {object} params.event.changes Passed for the `'update'` action, info on which record fields changed
|
|
2438
2186
|
*/
|
|
2439
2187
|
(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
|
|
2440
2188
|
/**
|
|
2441
2189
|
* Fired when the range of dates encapsulated by the UI changes. This will be when
|
|
2442
2190
|
* moving a view in time by reconfiguring its [timeAxis](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineBase#config-timeAxis). This will happen
|
|
2443
2191
|
* when zooming, or changing [viewPreset](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineBase#config-viewPreset).
|
|
2444
|
-
* ...
|
|
2445
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-dateRangeChange)
|
|
2192
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-dateRangeChange)
|
|
2446
2193
|
* @param {string} e Event name
|
|
2447
2194
|
* @param {object} params Event parameters
|
|
2448
|
-
* @param {
|
|
2449
|
-
* @param {
|
|
2450
|
-
* @param {object} params.
|
|
2451
|
-
* @param {
|
|
2452
|
-
* @param {
|
|
2453
|
-
* @param {
|
|
2454
|
-
* @param {Date} params.
|
|
2455
|
-
* @param {
|
|
2456
|
-
* @param {Date} params.params.event.new.startDate the new start date.
|
|
2457
|
-
* @param {Date} params.params.event.new.endDate the new end date.
|
|
2195
|
+
* @param {object} params.event Event object
|
|
2196
|
+
* @param {Scheduler.view.TimelineBase} params.event.source This Scheduler/Gantt instance.
|
|
2197
|
+
* @param {object} params.event.old The old date range
|
|
2198
|
+
* @param {Date} params.event.old.startDate the old start date.
|
|
2199
|
+
* @param {Date} params.event.old.endDate the old end date.
|
|
2200
|
+
* @param {object} params.event.new The new date range
|
|
2201
|
+
* @param {Date} params.event.new.startDate the new start date.
|
|
2202
|
+
* @param {Date} params.event.new.endDate the new end date.
|
|
2458
2203
|
*/
|
|
2459
2204
|
(e: 'dateRangeChange', params: ((event: { source: TimelineBase, old: { startDate: Date, endDate: Date }, new: { startDate: Date, endDate: Date } }) => void)|string): void
|
|
2460
2205
|
/**
|
|
2461
2206
|
* Fires when an object is destroyed.
|
|
2462
2207
|
* @param {string} e Event name
|
|
2463
2208
|
* @param {object} params Event parameters
|
|
2464
|
-
* @param {
|
|
2465
|
-
* @param {
|
|
2466
|
-
* @param {object} params.params.event Event object
|
|
2467
|
-
* @param {Core.Base} params.params.event.source The Object that is being destroyed.
|
|
2209
|
+
* @param {object} params.event Event object
|
|
2210
|
+
* @param {Core.Base} params.event.source The Object that is being destroyed.
|
|
2468
2211
|
*/
|
|
2469
2212
|
(e: 'destroy', params: ((event: { source: Base }) => void)|string): void
|
|
2470
2213
|
/**
|
|
2471
2214
|
* Fires when a field is mutated and the state of the [hasChanges](https://bryntum.com/products/scheduler/docs/api/Core/widget/Container#property-hasChanges) property changes
|
|
2472
2215
|
* @param {string} e Event name
|
|
2473
2216
|
* @param {object} params Event parameters
|
|
2474
|
-
* @param {
|
|
2475
|
-
* @param {
|
|
2476
|
-
* @param {
|
|
2477
|
-
* @param {Core.widget.Container} params.params.event.source The container.
|
|
2478
|
-
* @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.
|
|
2217
|
+
* @param {object} params.event Event object
|
|
2218
|
+
* @param {Core.widget.Container} params.event.source The container.
|
|
2219
|
+
* @param {boolean} params.event.dirty The dirty state of the Container - `true` if there are any fields which have been changed since initial load.
|
|
2479
2220
|
*/
|
|
2480
2221
|
(e: 'dirtyStateChange', params: ((event: { source: Container, dirty: boolean }) => void)|string): void
|
|
2481
2222
|
/**
|
|
@@ -2483,55 +2224,45 @@ const emit = defineEmits<{
|
|
|
2483
2224
|
* mouse up. This event can be listened for to perform actions while drag selecting.
|
|
2484
2225
|
* @param {string} e Event name
|
|
2485
2226
|
* @param {object} params Event parameters
|
|
2486
|
-
* @param {
|
|
2487
|
-
* @param {
|
|
2488
|
-
* @param {
|
|
2489
|
-
* @param {
|
|
2490
|
-
* @param {GridLocationConfig[],Grid.util.GridLocation[]} params.params.event.selectedCells The cells that is currently being dragged over
|
|
2491
|
-
* @param {Core.data.Model[]} params.params.event.selectedRecords The records that is currently being dragged over
|
|
2227
|
+
* @param {object} params.event Event object
|
|
2228
|
+
* @param {Grid.view.Grid} params.event.source
|
|
2229
|
+
* @param {GridLocationConfig[],Grid.util.GridLocation[]} params.event.selectedCells The cells that is currently being dragged over
|
|
2230
|
+
* @param {Core.data.Model[]} params.event.selectedRecords The records that is currently being dragged over
|
|
2492
2231
|
*/
|
|
2493
2232
|
(e: 'dragSelecting', params: ((event: { source: Grid, selectedCells: GridLocationConfig[]|GridLocation[], selectedRecords: Model[] }) => void)|string): void
|
|
2494
2233
|
/**
|
|
2495
2234
|
* Triggered when a widget's [element](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-element) is available.
|
|
2496
2235
|
* @param {string} e Event name
|
|
2497
2236
|
* @param {object} params Event parameters
|
|
2498
|
-
* @param {
|
|
2499
|
-
* @param {
|
|
2500
|
-
* @param {object} params.params.event Event object
|
|
2501
|
-
* @param {HTMLElement} params.params.event.element The Widget's element.
|
|
2237
|
+
* @param {object} params.event Event object
|
|
2238
|
+
* @param {HTMLElement} params.event.element The Widget's element.
|
|
2502
2239
|
*/
|
|
2503
2240
|
(e: 'elementCreated', params: ((event: { element: HTMLElement }) => void)|string): void
|
|
2504
2241
|
/**
|
|
2505
2242
|
* Fires when a Panel is expanded using the [collapsible](https://bryntum.com/products/scheduler/docs/api/Core/widget/Panel#config-collapsible) setting.
|
|
2506
2243
|
* @param {string} e Event name
|
|
2507
2244
|
* @param {object} params Event parameters
|
|
2508
|
-
* @param {
|
|
2509
|
-
* @param {
|
|
2510
|
-
* @param {object} params.params.event Event object
|
|
2511
|
-
* @param {Core.widget.Panel} params.params.event.source This Panel.
|
|
2245
|
+
* @param {object} params.event Event object
|
|
2246
|
+
* @param {Core.widget.Panel} params.event.source This Panel.
|
|
2512
2247
|
*/
|
|
2513
2248
|
(e: 'expand', params: ((event: { source: Panel }) => void)|string): void
|
|
2514
2249
|
/**
|
|
2515
2250
|
* Fired after a parent node record is expanded.
|
|
2516
2251
|
* @param {string} e Event name
|
|
2517
2252
|
* @param {object} params Event parameters
|
|
2518
|
-
* @param {
|
|
2519
|
-
* @param {
|
|
2520
|
-
* @param {
|
|
2521
|
-
* @param {Grid.view.Grid} params.params.event.source The firing Grid instance.
|
|
2522
|
-
* @param {Core.data.Model} params.params.event.record The record which has been expanded.
|
|
2253
|
+
* @param {object} params.event Event object
|
|
2254
|
+
* @param {Grid.view.Grid} params.event.source The firing Grid instance.
|
|
2255
|
+
* @param {Core.data.Model} params.event.record The record which has been expanded.
|
|
2523
2256
|
*/
|
|
2524
2257
|
(e: 'expandNode', params: ((event: { source: Grid, record: Model }) => void)|string): void
|
|
2525
2258
|
/**
|
|
2526
2259
|
* Fired when a file is dropped on the widget element
|
|
2527
2260
|
* @param {string} e Event name
|
|
2528
2261
|
* @param {object} params Event parameters
|
|
2529
|
-
* @param {
|
|
2530
|
-
* @param {
|
|
2531
|
-
* @param {
|
|
2532
|
-
* @param {
|
|
2533
|
-
* @param {DataTransferItem} params.params.event.file The dropped file descriptor
|
|
2534
|
-
* @param {DragEvent} params.params.event.domEvent The native DragEvent
|
|
2262
|
+
* @param {object} params.event Event object
|
|
2263
|
+
* @param {Grid.view.Grid} params.event.source The owning Grid instance
|
|
2264
|
+
* @param {DataTransferItem} params.event.file The dropped file descriptor
|
|
2265
|
+
* @param {DragEvent} params.event.domEvent The native DragEvent
|
|
2535
2266
|
*/
|
|
2536
2267
|
(e: 'fileDrop', params: ((event: { source: Grid, file: DataTransferItem, domEvent: DragEvent }) => void)|string): void
|
|
2537
2268
|
/**
|
|
@@ -2539,24 +2270,20 @@ const emit = defineEmits<{
|
|
|
2539
2270
|
* drag operation from applying data changes.
|
|
2540
2271
|
* @param {string} e Event name
|
|
2541
2272
|
* @param {object} params Event parameters
|
|
2542
|
-
* @param {
|
|
2543
|
-
* @param {
|
|
2544
|
-
* @param {
|
|
2545
|
-
* @param {
|
|
2546
|
-
* @param {Grid.util.GridLocation} params.params.event.to The to cell
|
|
2547
|
-
* @param {MouseEvent} params.params.event.domEvent The raw DOM event
|
|
2273
|
+
* @param {object} params.event Event object
|
|
2274
|
+
* @param {Grid.util.GridLocation} params.event.from The from cell
|
|
2275
|
+
* @param {Grid.util.GridLocation} params.event.to The to cell
|
|
2276
|
+
* @param {MouseEvent} params.event.domEvent The raw DOM event
|
|
2548
2277
|
*/
|
|
2549
2278
|
(e: 'fillHandleBeforeDragFinalize', params: ((event: { from: GridLocation, to: GridLocation, domEvent: MouseEvent }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
2550
2279
|
/**
|
|
2551
2280
|
* Fired while dragging the FillHandle.
|
|
2552
2281
|
* @param {string} e Event name
|
|
2553
2282
|
* @param {object} params Event parameters
|
|
2554
|
-
* @param {
|
|
2555
|
-
* @param {
|
|
2556
|
-
* @param {
|
|
2557
|
-
* @param {
|
|
2558
|
-
* @param {Grid.util.GridLocation} params.params.event.to The to cell
|
|
2559
|
-
* @param {MouseEvent} params.params.event.domEvent The raw DOM event
|
|
2283
|
+
* @param {object} params.event Event object
|
|
2284
|
+
* @param {Grid.util.GridLocation} params.event.from The from cell
|
|
2285
|
+
* @param {Grid.util.GridLocation} params.event.to The to cell
|
|
2286
|
+
* @param {MouseEvent} params.event.domEvent The raw DOM event
|
|
2560
2287
|
*/
|
|
2561
2288
|
(e: 'fillHandleDrag', params: ((event: { from: GridLocation, to: GridLocation, domEvent: MouseEvent }) => void)|string): void
|
|
2562
2289
|
/**
|
|
@@ -2567,62 +2294,51 @@ const emit = defineEmits<{
|
|
|
2567
2294
|
* Fired after a FillHandle drag operation.
|
|
2568
2295
|
* @param {string} e Event name
|
|
2569
2296
|
* @param {object} params Event parameters
|
|
2570
|
-
* @param {
|
|
2571
|
-
* @param {
|
|
2572
|
-
* @param {
|
|
2573
|
-
* @param {
|
|
2574
|
-
* @param {Grid.util.GridLocation} params.params.event.to The to cell
|
|
2575
|
-
* @param {MouseEvent} params.params.event.domEvent The raw DOM event
|
|
2297
|
+
* @param {object} params.event Event object
|
|
2298
|
+
* @param {Grid.util.GridLocation} params.event.from The from cell
|
|
2299
|
+
* @param {Grid.util.GridLocation} params.event.to The to cell
|
|
2300
|
+
* @param {MouseEvent} params.event.domEvent The raw DOM event
|
|
2576
2301
|
*/
|
|
2577
2302
|
(e: 'fillHandleDragEnd', params: ((event: { from: GridLocation, to: GridLocation, domEvent: MouseEvent }) => void)|string): void
|
|
2578
2303
|
/**
|
|
2579
2304
|
* Fired when dragging of the FillHandle starts.
|
|
2580
2305
|
* @param {string} e Event name
|
|
2581
2306
|
* @param {object} params Event parameters
|
|
2582
|
-
* @param {
|
|
2583
|
-
* @param {
|
|
2584
|
-
* @param {
|
|
2585
|
-
* @param {Grid.util.GridLocation} params.params.event.cell Information about the column / record
|
|
2586
|
-
* @param {MouseEvent} params.params.event.domEvent The raw DOM event
|
|
2307
|
+
* @param {object} params.event Event object
|
|
2308
|
+
* @param {Grid.util.GridLocation} params.event.cell Information about the column / record
|
|
2309
|
+
* @param {MouseEvent} params.event.domEvent The raw DOM event
|
|
2587
2310
|
*/
|
|
2588
|
-
(e: 'fillHandleDragStart', params: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
2311
|
+
(e: 'fillHandleDragStart', params: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string): boolean|void
|
|
2589
2312
|
/**
|
|
2590
2313
|
* Fires on the owning Grid when cell editing is finished
|
|
2591
2314
|
* @param {string} e Event name
|
|
2592
2315
|
* @param {object} params Event parameters
|
|
2593
|
-
* @param {
|
|
2594
|
-
* @param {
|
|
2595
|
-
* @param {
|
|
2596
|
-
* @param {Grid.view.Grid} params.params.event.grid Target grid
|
|
2597
|
-
* @param {CellEditorContext} params.params.event.editorContext Editing context
|
|
2316
|
+
* @param {object} params.event Event object
|
|
2317
|
+
* @param {Grid.view.Grid} params.event.grid Target grid
|
|
2318
|
+
* @param {CellEditorContext} params.event.editorContext Editing context
|
|
2598
2319
|
*/
|
|
2599
2320
|
(e: 'finishCellEdit', params: ((event: { grid: Grid, editorContext: CellEditorContext }) => void)|string): void
|
|
2600
2321
|
/**
|
|
2601
2322
|
* 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.
|
|
2602
|
-
* ...
|
|
2603
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-finishRowEdit)
|
|
2323
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-finishRowEdit)
|
|
2604
2324
|
* @param {string} e Event name
|
|
2605
2325
|
* @param {object} params Event parameters
|
|
2606
|
-
* @param {
|
|
2607
|
-
* @param {
|
|
2608
|
-
* @param {
|
|
2609
|
-
* @param {Grid.view.Grid} params.params.event.grid Target grid
|
|
2610
|
-
* @param {RowEditorContext} params.params.event.editorContext Editing context
|
|
2326
|
+
* @param {object} params.event Event object
|
|
2327
|
+
* @param {Grid.view.Grid} params.event.grid Target grid
|
|
2328
|
+
* @param {RowEditorContext} params.event.editorContext Editing context
|
|
2611
2329
|
*/
|
|
2612
2330
|
(e: 'finishRowEdit', params: ((event: { grid: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
2613
2331
|
/**
|
|
2614
2332
|
* Fired when focus enters this Widget.
|
|
2615
2333
|
* @param {string} e Event name
|
|
2616
2334
|
* @param {object} params Event parameters
|
|
2617
|
-
* @param {
|
|
2618
|
-
* @param {
|
|
2619
|
-
* @param {
|
|
2620
|
-
* @param {
|
|
2621
|
-
* @param {
|
|
2622
|
-
* @param {
|
|
2623
|
-
* @param {
|
|
2624
|
-
* @param {Core.widget.Widget} params.params.event.toWidget The widget which gained focus.
|
|
2625
|
-
* @param {boolean} params.params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
|
|
2335
|
+
* @param {object} params.event Event object
|
|
2336
|
+
* @param {Core.widget.Widget} params.event.source This Widget
|
|
2337
|
+
* @param {HTMLElement} params.event.fromElement The element which lost focus.
|
|
2338
|
+
* @param {HTMLElement} params.event.toElement The element which gained focus.
|
|
2339
|
+
* @param {Core.widget.Widget} params.event.fromWidget The widget which lost focus.
|
|
2340
|
+
* @param {Core.widget.Widget} params.event.toWidget The widget which gained focus.
|
|
2341
|
+
* @param {boolean} params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
|
|
2626
2342
|
*/
|
|
2627
2343
|
(e: 'focusIn', params: ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string): void
|
|
2628
2344
|
/**
|
|
@@ -2631,46 +2347,40 @@ const emit = defineEmits<{
|
|
|
2631
2347
|
* will not trigger this event. This is when focus exits this widget completely.
|
|
2632
2348
|
* @param {string} e Event name
|
|
2633
2349
|
* @param {object} params Event parameters
|
|
2634
|
-
* @param {
|
|
2635
|
-
* @param {
|
|
2636
|
-
* @param {
|
|
2637
|
-
* @param {
|
|
2638
|
-
* @param {
|
|
2639
|
-
* @param {
|
|
2640
|
-
* @param {
|
|
2641
|
-
* @param {Core.widget.Widget} params.params.event.toWidget The widget which gained focus.
|
|
2642
|
-
* @param {boolean} params.params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
|
|
2350
|
+
* @param {object} params.event Event object
|
|
2351
|
+
* @param {Core.widget.Widget} params.event.source This Widget
|
|
2352
|
+
* @param {HTMLElement} params.event.fromElement The element which lost focus.
|
|
2353
|
+
* @param {HTMLElement} params.event.toElement The element which gained focus.
|
|
2354
|
+
* @param {Core.widget.Widget} params.event.fromWidget The widget which lost focus.
|
|
2355
|
+
* @param {Core.widget.Widget} params.event.toWidget The widget which gained focus.
|
|
2356
|
+
* @param {boolean} params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
|
|
2643
2357
|
*/
|
|
2644
2358
|
(e: 'focusOut', params: ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string): void
|
|
2645
2359
|
/**
|
|
2646
2360
|
* Fired before dragging starts, return false to prevent the drag operation.
|
|
2647
2361
|
* @param {string} e Event name
|
|
2648
2362
|
* @param {object} params Event parameters
|
|
2649
|
-
* @param {
|
|
2650
|
-
* @param {
|
|
2651
|
-
* @param {object} params.
|
|
2652
|
-
* @param {
|
|
2653
|
-
* @param {
|
|
2654
|
-
* @param {Core.data.Model[]} params.params.event.context.records The dragged row records
|
|
2655
|
-
* @param {MouseEvent,TouchEvent} params.params.event.event
|
|
2363
|
+
* @param {object} params.event Event object
|
|
2364
|
+
* @param {Grid.view.GridBase} params.event.source
|
|
2365
|
+
* @param {object} params.event.context
|
|
2366
|
+
* @param {Core.data.Model[]} params.event.context.records The dragged row records
|
|
2367
|
+
* @param {MouseEvent,TouchEvent} params.event.event
|
|
2656
2368
|
*/
|
|
2657
|
-
(e: 'gridRowBeforeDragStart', params: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
2369
|
+
(e: 'gridRowBeforeDragStart', params: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void)|string): boolean|void
|
|
2658
2370
|
/**
|
|
2659
2371
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
2660
2372
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
2661
2373
|
* @param {string} e Event name
|
|
2662
2374
|
* @param {object} params Event parameters
|
|
2663
|
-
* @param {
|
|
2664
|
-
* @param {
|
|
2665
|
-
* @param {object} params.
|
|
2666
|
-
* @param {
|
|
2667
|
-
* @param {
|
|
2668
|
-
* @param {
|
|
2669
|
-
* @param {Core.data.Model} params.
|
|
2670
|
-
* @param {
|
|
2671
|
-
* @param {
|
|
2672
|
-
* @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
|
|
2673
|
-
* @param {MouseEvent} params.params.event.event
|
|
2375
|
+
* @param {object} params.event Event object
|
|
2376
|
+
* @param {Grid.view.GridBase} params.event.source
|
|
2377
|
+
* @param {object} params.event.context
|
|
2378
|
+
* @param {boolean} params.event.context.valid Set this to true or false to indicate whether the drop position is valid
|
|
2379
|
+
* @param {Core.data.Model} params.event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
|
|
2380
|
+
* @param {Core.data.Model} params.event.context.parent The parent record of the current drop position (only applicable for trees)
|
|
2381
|
+
* @param {Core.data.Model[]} params.event.context.records The dragged row records
|
|
2382
|
+
* @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
|
|
2383
|
+
* @param {MouseEvent} params.event.event
|
|
2674
2384
|
*/
|
|
2675
2385
|
(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
|
|
2676
2386
|
/**
|
|
@@ -2679,259 +2389,215 @@ const emit = defineEmits<{
|
|
|
2679
2389
|
* valid or invalid by setting `context.valid = false;`
|
|
2680
2390
|
* @param {string} e Event name
|
|
2681
2391
|
* @param {object} params Event parameters
|
|
2682
|
-
* @param {
|
|
2683
|
-
* @param {
|
|
2684
|
-
* @param {object} params.
|
|
2685
|
-
* @param {
|
|
2686
|
-
* @param {
|
|
2687
|
-
* @param {
|
|
2688
|
-
* @param {Core.data.Model} params.
|
|
2689
|
-
* @param {
|
|
2690
|
-
* @param {Core.data.Model[]} params.params.event.context.records The dragged row records
|
|
2691
|
-
* @param {MouseEvent} params.params.event.event
|
|
2392
|
+
* @param {object} params.event Event object
|
|
2393
|
+
* @param {Grid.view.GridBase} params.event.source
|
|
2394
|
+
* @param {object} params.event.context
|
|
2395
|
+
* @param {boolean} params.event.context.valid Set this to true or false to indicate whether the drop position is valid.
|
|
2396
|
+
* @param {Core.data.Model} params.event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
|
|
2397
|
+
* @param {Core.data.Model} params.event.context.parent The parent record of the current drop position (only applicable for trees)
|
|
2398
|
+
* @param {Core.data.Model[]} params.event.context.records The dragged row records
|
|
2399
|
+
* @param {MouseEvent} params.event.event
|
|
2692
2400
|
*/
|
|
2693
2401
|
(e: 'gridRowDrag', params: ((event: { source: GridBase, context: { valid: boolean, insertBefore: Model, parent: Model, records: Model[] }, event: MouseEvent }) => void)|string): void
|
|
2694
2402
|
/**
|
|
2695
2403
|
* Fired when a row drag operation is aborted
|
|
2696
2404
|
* @param {string} e Event name
|
|
2697
2405
|
* @param {object} params Event parameters
|
|
2698
|
-
* @param {
|
|
2699
|
-
* @param {
|
|
2700
|
-
* @param {object} params.
|
|
2701
|
-
* @param {
|
|
2702
|
-
* @param {
|
|
2703
|
-
* @param {Core.data.Model[]} params.params.event.context.records The dragged row records
|
|
2704
|
-
* @param {MouseEvent} params.params.event.event
|
|
2406
|
+
* @param {object} params.event Event object
|
|
2407
|
+
* @param {Grid.view.GridBase} params.event.source
|
|
2408
|
+
* @param {object} params.event.context
|
|
2409
|
+
* @param {Core.data.Model[]} params.event.context.records The dragged row records
|
|
2410
|
+
* @param {MouseEvent} params.event.event
|
|
2705
2411
|
*/
|
|
2706
2412
|
(e: 'gridRowDragAbort', params: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent }) => void)|string): void
|
|
2707
2413
|
/**
|
|
2708
2414
|
* Fired when dragging starts.
|
|
2709
2415
|
* @param {string} e Event name
|
|
2710
2416
|
* @param {object} params Event parameters
|
|
2711
|
-
* @param {
|
|
2712
|
-
* @param {
|
|
2713
|
-
* @param {object} params.
|
|
2714
|
-
* @param {
|
|
2715
|
-
* @param {
|
|
2716
|
-
* @param {Core.data.Model[]} params.params.event.context.records The dragged row records
|
|
2717
|
-
* @param {MouseEvent,TouchEvent} params.params.event.event
|
|
2417
|
+
* @param {object} params.event Event object
|
|
2418
|
+
* @param {Grid.view.GridBase} params.event.source
|
|
2419
|
+
* @param {object} params.event.context
|
|
2420
|
+
* @param {Core.data.Model[]} params.event.context.records The dragged row records
|
|
2421
|
+
* @param {MouseEvent,TouchEvent} params.event.event
|
|
2718
2422
|
*/
|
|
2719
2423
|
(e: 'gridRowDragStart', params: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => void)|string): void
|
|
2720
2424
|
/**
|
|
2721
2425
|
* Fired after the row drop operation has completed, regardless of validity
|
|
2722
2426
|
* @param {string} e Event name
|
|
2723
2427
|
* @param {object} params Event parameters
|
|
2724
|
-
* @param {
|
|
2725
|
-
* @param {
|
|
2726
|
-
* @param {object} params.
|
|
2727
|
-
* @param {
|
|
2728
|
-
* @param {
|
|
2729
|
-
* @param {
|
|
2730
|
-
* @param {Core.data.Model} params.
|
|
2731
|
-
* @param {
|
|
2732
|
-
* @param {
|
|
2733
|
-
* @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
|
|
2734
|
-
* @param {MouseEvent} params.params.event.event
|
|
2428
|
+
* @param {object} params.event Event object
|
|
2429
|
+
* @param {Grid.view.GridBase} params.event.source
|
|
2430
|
+
* @param {object} params.event.context
|
|
2431
|
+
* @param {boolean} params.event.context.valid true or false depending on whether the drop position was valid
|
|
2432
|
+
* @param {Core.data.Model} params.event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
|
|
2433
|
+
* @param {Core.data.Model} params.event.context.parent The parent record of the current drop position (only applicable for trees)
|
|
2434
|
+
* @param {Core.data.Model[]} params.event.context.records The dragged row records
|
|
2435
|
+
* @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
|
|
2436
|
+
* @param {MouseEvent} params.event.event
|
|
2735
2437
|
*/
|
|
2736
2438
|
(e: 'gridRowDrop', params: ((event: { source: GridBase, context: { valid: boolean, insertBefore: Model, parent: Model, records: Model[], oldPositionContext: RecordPositionContext[] }, event: MouseEvent }) => void)|string): void
|
|
2737
2439
|
/**
|
|
2738
2440
|
* Fired when a grid header is clicked on.
|
|
2739
|
-
* ...
|
|
2740
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-headerClick)
|
|
2441
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-headerClick)
|
|
2741
2442
|
* @param {string} e Event name
|
|
2742
2443
|
* @param {object} params Event parameters
|
|
2743
|
-
* @param {
|
|
2744
|
-
* @param {
|
|
2745
|
-
* @param {
|
|
2746
|
-
* @param {Event} params.params.event.domEvent The triggering DOM event.
|
|
2747
|
-
* @param {Grid.column.Column} params.params.event.column The column clicked on.
|
|
2444
|
+
* @param {object} params.event Event object
|
|
2445
|
+
* @param {Event} params.event.domEvent The triggering DOM event.
|
|
2446
|
+
* @param {Grid.column.Column} params.event.column The column clicked on.
|
|
2748
2447
|
*/
|
|
2749
|
-
(e: 'headerClick', params: ((event: { domEvent: Event, column: Column }) =>
|
|
2448
|
+
(e: 'headerClick', params: ((event: { domEvent: Event, column: Column }) => boolean|void)|string): boolean|void
|
|
2750
2449
|
/**
|
|
2751
2450
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
2752
2451
|
* Allows manipulation of the items to show in the same way as in the [processItems](https://bryntum.com/products/scheduler/docs/api/Grid/feature/HeaderMenu#config-processItems).
|
|
2753
|
-
* ...
|
|
2754
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-headerMenuBeforeShow)
|
|
2452
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-headerMenuBeforeShow)
|
|
2755
2453
|
* @param {string} e Event name
|
|
2756
2454
|
* @param {object} params Event parameters
|
|
2757
|
-
* @param {
|
|
2758
|
-
* @param {
|
|
2759
|
-
* @param {
|
|
2760
|
-
* @param {
|
|
2761
|
-
* @param {
|
|
2762
|
-
* @param {Record<string, MenuItemEntry>} params.params.event.items Menu item configs
|
|
2763
|
-
* @param {Grid.column.Column} params.params.event.column Column
|
|
2455
|
+
* @param {object} params.event Event object
|
|
2456
|
+
* @param {Grid.view.Grid} params.event.source The grid
|
|
2457
|
+
* @param {Core.widget.Menu} params.event.menu The menu
|
|
2458
|
+
* @param {Record<string, MenuItemEntry>} params.event.items Menu item configs
|
|
2459
|
+
* @param {Grid.column.Column} params.event.column Column
|
|
2764
2460
|
*/
|
|
2765
|
-
(e: 'headerMenuBeforeShow', params: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
2461
|
+
(e: 'headerMenuBeforeShow', params: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void)|string): boolean|void
|
|
2766
2462
|
/**
|
|
2767
2463
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
2768
2464
|
* @param {string} e Event name
|
|
2769
2465
|
* @param {object} params Event parameters
|
|
2770
|
-
* @param {
|
|
2771
|
-
* @param {
|
|
2772
|
-
* @param {
|
|
2773
|
-
* @param {
|
|
2774
|
-
* @param {
|
|
2775
|
-
* @param {Core.widget.MenuItem} params.params.event.item Selected menu item
|
|
2776
|
-
* @param {Grid.column.Column} params.params.event.column Column
|
|
2466
|
+
* @param {object} params.event Event object
|
|
2467
|
+
* @param {Grid.view.Grid} params.event.source The grid
|
|
2468
|
+
* @param {Core.widget.Menu} params.event.menu The menu
|
|
2469
|
+
* @param {Core.widget.MenuItem} params.event.item Selected menu item
|
|
2470
|
+
* @param {Grid.column.Column} params.event.column Column
|
|
2777
2471
|
*/
|
|
2778
2472
|
(e: 'headerMenuItem', params: ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column }) => void)|string): void
|
|
2779
2473
|
/**
|
|
2780
2474
|
* This event fires on the owning Grid after the context menu is shown for a header
|
|
2781
2475
|
* @param {string} e Event name
|
|
2782
2476
|
* @param {object} params Event parameters
|
|
2783
|
-
* @param {
|
|
2784
|
-
* @param {
|
|
2785
|
-
* @param {
|
|
2786
|
-
* @param {
|
|
2787
|
-
* @param {
|
|
2788
|
-
* @param {Record<string, MenuItemEntry>} params.params.event.items Menu item configs
|
|
2789
|
-
* @param {Grid.column.Column} params.params.event.column Column
|
|
2477
|
+
* @param {object} params.event Event object
|
|
2478
|
+
* @param {Grid.view.Grid} params.event.source The grid
|
|
2479
|
+
* @param {Core.widget.Menu} params.event.menu The menu
|
|
2480
|
+
* @param {Record<string, MenuItemEntry>} params.event.items Menu item configs
|
|
2481
|
+
* @param {Grid.column.Column} params.event.column Column
|
|
2790
2482
|
*/
|
|
2791
2483
|
(e: 'headerMenuShow', params: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => void)|string): void
|
|
2792
2484
|
/**
|
|
2793
2485
|
* This event fires on the owning Grid when a check item is toggled in the header context menu.
|
|
2794
2486
|
* @param {string} e Event name
|
|
2795
2487
|
* @param {object} params Event parameters
|
|
2796
|
-
* @param {
|
|
2797
|
-
* @param {
|
|
2798
|
-
* @param {
|
|
2799
|
-
* @param {
|
|
2800
|
-
* @param {
|
|
2801
|
-
* @param {
|
|
2802
|
-
* @param {Grid.column.Column} params.params.event.column Column
|
|
2803
|
-
* @param {boolean} params.params.event.checked Checked or not
|
|
2488
|
+
* @param {object} params.event Event object
|
|
2489
|
+
* @param {Grid.view.Grid} params.event.source The grid
|
|
2490
|
+
* @param {Core.widget.Menu} params.event.menu The menu
|
|
2491
|
+
* @param {Core.widget.MenuItem} params.event.item Selected menu item
|
|
2492
|
+
* @param {Grid.column.Column} params.event.column Column
|
|
2493
|
+
* @param {boolean} params.event.checked Checked or not
|
|
2804
2494
|
*/
|
|
2805
2495
|
(e: 'headerMenuToggleItem', params: ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column, checked: boolean }) => void)|string): void
|
|
2806
2496
|
/**
|
|
2807
2497
|
* Triggered after a widget was hidden
|
|
2808
2498
|
* @param {string} e Event name
|
|
2809
2499
|
* @param {object} params Event parameters
|
|
2810
|
-
* @param {
|
|
2811
|
-
* @param {
|
|
2812
|
-
* @param {object} params.params.event Event object
|
|
2813
|
-
* @param {Core.widget.Widget} params.params.event.source The widget
|
|
2500
|
+
* @param {object} params.event Event object
|
|
2501
|
+
* @param {Core.widget.Widget} params.event.source The widget
|
|
2814
2502
|
*/
|
|
2815
2503
|
(e: 'hide', params: ((event: { source: Widget }) => void)|string): void
|
|
2816
2504
|
/**
|
|
2817
2505
|
* Fires after the component retrieves a record's histogram data and stores
|
|
2818
2506
|
* it into the cache.
|
|
2819
|
-
* ...
|
|
2820
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-histogramDataCacheSet)
|
|
2507
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-histogramDataCacheSet)
|
|
2821
2508
|
* @param {string} e Event name
|
|
2822
2509
|
* @param {object} params Event parameters
|
|
2823
|
-
* @param {
|
|
2824
|
-
* @param {
|
|
2825
|
-
* @param {
|
|
2826
|
-
* @param {
|
|
2827
|
-
* @param {Core.data.Model} params.params.event.record Record the histogram data of which is ready.
|
|
2828
|
-
* @param {object} params.params.event.data The record histogram data.
|
|
2510
|
+
* @param {object} params.event Event object
|
|
2511
|
+
* @param {Scheduler.view.TimelineHistogram} params.event.source The component instance
|
|
2512
|
+
* @param {Core.data.Model} params.event.record Record the histogram data of which is ready.
|
|
2513
|
+
* @param {object} params.event.data The record histogram data.
|
|
2829
2514
|
*/
|
|
2830
2515
|
(e: 'histogramDataCacheSet', params: ((event: { source: TimelineHistogram, record: Model, data: object }) => void)|string): void
|
|
2831
2516
|
/**
|
|
2832
2517
|
* Fires when row locking is enabled.
|
|
2833
2518
|
* @param {string} e Event name
|
|
2834
2519
|
* @param {object} params Event parameters
|
|
2835
|
-
* @param {
|
|
2836
|
-
* @param {
|
|
2837
|
-
* @param {object} params.params.event Event object
|
|
2838
|
-
* @param {Grid.view.GridBase} params.params.event.clone The created clone
|
|
2520
|
+
* @param {object} params.event Event object
|
|
2521
|
+
* @param {Grid.view.GridBase} params.event.clone The created clone
|
|
2839
2522
|
*/
|
|
2840
2523
|
(e: 'lockRows', params: ((event: { clone: GridBase }) => void)|string): void
|
|
2841
2524
|
/**
|
|
2842
2525
|
* Mouse moved out from element in grid
|
|
2843
2526
|
* @param {string} e Event name
|
|
2844
2527
|
* @param {object} params Event parameters
|
|
2845
|
-
* @param {
|
|
2846
|
-
* @param {
|
|
2847
|
-
* @param {object} params.params.event Event object
|
|
2848
|
-
* @param {MouseEvent} params.params.event.event The native browser event
|
|
2528
|
+
* @param {object} params.event Event object
|
|
2529
|
+
* @param {MouseEvent} params.event.event The native browser event
|
|
2849
2530
|
*/
|
|
2850
2531
|
(e: 'mouseOut', params: ((event: { event: MouseEvent }) => void)|string): void
|
|
2851
2532
|
/**
|
|
2852
2533
|
* Mouse moved in over element in grid
|
|
2853
2534
|
* @param {string} e Event name
|
|
2854
2535
|
* @param {object} params Event parameters
|
|
2855
|
-
* @param {
|
|
2856
|
-
* @param {
|
|
2857
|
-
* @param {object} params.params.event Event object
|
|
2858
|
-
* @param {MouseEvent} params.params.event.event The native browser event
|
|
2536
|
+
* @param {object} params.event Event object
|
|
2537
|
+
* @param {MouseEvent} params.event.event The native browser event
|
|
2859
2538
|
*/
|
|
2860
2539
|
(e: 'mouseOver', params: ((event: { event: MouseEvent }) => void)|string): void
|
|
2861
2540
|
/**
|
|
2862
2541
|
* Fires when the requested date range cannot fit into any zoom level higher than the current level.
|
|
2863
2542
|
* @param {string} e Event name
|
|
2864
2543
|
* @param {object} params Event parameters
|
|
2865
|
-
* @param {
|
|
2866
|
-
* @param {
|
|
2867
|
-
* @param {
|
|
2868
|
-
* @param {
|
|
2869
|
-
* @param {Date} params.params.event.startDate The requested start date
|
|
2870
|
-
* @param {Date} params.params.event.endDate The requested end date
|
|
2544
|
+
* @param {object} params.event Event object
|
|
2545
|
+
* @param {number} params.event.currentZoomLevel The current zoom level
|
|
2546
|
+
* @param {Date} params.event.startDate The requested start date
|
|
2547
|
+
* @param {Date} params.event.endDate The requested end date
|
|
2871
2548
|
*/
|
|
2872
2549
|
(e: 'noZoomChange', params: ((event: { currentZoomLevel: number, startDate: Date, endDate: Date }) => void)|string): void
|
|
2873
2550
|
/**
|
|
2874
2551
|
* Triggered when a widget which had been in a non-visible state for any reason
|
|
2875
2552
|
* achieves visibility.
|
|
2876
|
-
* ...
|
|
2877
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-paint)
|
|
2553
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-paint)
|
|
2878
2554
|
* @param {string} e Event name
|
|
2879
2555
|
* @param {object} params Event parameters
|
|
2880
|
-
* @param {
|
|
2881
|
-
* @param {
|
|
2882
|
-
* @param {
|
|
2883
|
-
* @param {Core.widget.Widget} params.params.event.source The widget being painted.
|
|
2884
|
-
* @param {boolean} params.params.event.firstPaint `true` if this is the first paint.
|
|
2556
|
+
* @param {object} params.event Event object
|
|
2557
|
+
* @param {Core.widget.Widget} params.event.source The widget being painted.
|
|
2558
|
+
* @param {boolean} params.event.firstPaint `true` if this is the first paint.
|
|
2885
2559
|
*/
|
|
2886
2560
|
(e: 'paint', params: ((event: { source: Widget, firstPaint: boolean }) => void)|string): void
|
|
2887
2561
|
/**
|
|
2888
2562
|
* Fires on the owning Grid after a paste action is performed.
|
|
2889
2563
|
* @param {string} e Event name
|
|
2890
2564
|
* @param {object} params Event parameters
|
|
2891
|
-
* @param {
|
|
2892
|
-
* @param {
|
|
2893
|
-
* @param {
|
|
2894
|
-
* @param {
|
|
2895
|
-
* @param {
|
|
2896
|
-
* @param {
|
|
2897
|
-
* @param {Grid.util.GridLocation} params.params.event.targetCell The cell from which the paste will be started
|
|
2898
|
-
* @param {string} params.params.event.entityName 'cell' to distinguish this event from other paste events
|
|
2565
|
+
* @param {object} params.event Event object
|
|
2566
|
+
* @param {Grid.view.Grid} params.event.source Owner grid
|
|
2567
|
+
* @param {string} params.event.clipboardData The clipboardData that was pasted
|
|
2568
|
+
* @param {Core.data.Model[]} params.event.modifiedRecords The records which have been modified due to the paste action
|
|
2569
|
+
* @param {Grid.util.GridLocation} params.event.targetCell The cell from which the paste will be started
|
|
2570
|
+
* @param {string} params.event.entityName 'cell' to distinguish this event from other paste events
|
|
2899
2571
|
*/
|
|
2900
2572
|
(e: 'paste', params: ((event: { source: Grid, clipboardData: string, modifiedRecords: Model[], targetCell: GridLocation, entityName: string }) => void)|string): void
|
|
2901
2573
|
/**
|
|
2902
2574
|
* Fires on the owning Grid when export has finished
|
|
2903
2575
|
* @param {string} e Event name
|
|
2904
2576
|
* @param {object} params Event parameters
|
|
2905
|
-
* @param {
|
|
2906
|
-
* @param {
|
|
2907
|
-
* @param {
|
|
2908
|
-
* @param {Response} params.params.event.response Optional response, if received
|
|
2909
|
-
* @param {Error} params.params.event.error Optional error, if exception occurred
|
|
2577
|
+
* @param {object} params.event Event object
|
|
2578
|
+
* @param {Response} [params.event.response] Optional response, if received
|
|
2579
|
+
* @param {Error} [params.event.error] Optional error, if exception occurred
|
|
2910
2580
|
*/
|
|
2911
2581
|
(e: 'pdfExport', params: ((event: { response?: Response, error?: Error }) => void)|string): void
|
|
2912
2582
|
/**
|
|
2913
2583
|
* Fired after the [viewPreset](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineViewPresets#config-viewPreset) has changed.
|
|
2914
2584
|
* @param {string} e Event name
|
|
2915
2585
|
* @param {object} params Event parameters
|
|
2916
|
-
* @param {
|
|
2917
|
-
* @param {
|
|
2918
|
-
* @param {
|
|
2919
|
-
* @param {
|
|
2920
|
-
* @param {Date} params.
|
|
2921
|
-
* @param {
|
|
2922
|
-
* @param {
|
|
2923
|
-
* @param {Scheduler.preset.ViewPreset} params.params.event.from The outgoing ViewPreset.
|
|
2924
|
-
* @param {Scheduler.preset.ViewPreset} params.params.event.to The ViewPreset being switched to.
|
|
2586
|
+
* @param {object} params.event Event object
|
|
2587
|
+
* @param {Scheduler.view.Scheduler} params.event.source This Scheduler instance.
|
|
2588
|
+
* @param {Date} params.event.startDate The new start date of the timeline.
|
|
2589
|
+
* @param {Date} params.event.centerDate The new center date of the timeline.
|
|
2590
|
+
* @param {Date} params.event.endDate The new end date of the timeline.
|
|
2591
|
+
* @param {Scheduler.preset.ViewPreset} params.event.from The outgoing ViewPreset.
|
|
2592
|
+
* @param {Scheduler.preset.ViewPreset} params.event.to The ViewPreset being switched to.
|
|
2925
2593
|
*/
|
|
2926
|
-
(e: 'presetChange', params: ((event: { source: Scheduler, startDate: Date, centerDate: Date, endDate: Date, from: ViewPreset, to: ViewPreset }) =>
|
|
2594
|
+
(e: 'presetChange', params: ((event: { source: Scheduler, startDate: Date, centerDate: Date, endDate: Date, from: ViewPreset, to: ViewPreset }) => boolean|void)|string): boolean|void
|
|
2927
2595
|
/**
|
|
2928
2596
|
* Fired when a Widget's read only state is toggled
|
|
2929
2597
|
* @param {string} e Event name
|
|
2930
2598
|
* @param {object} params Event parameters
|
|
2931
|
-
* @param {
|
|
2932
|
-
* @param {
|
|
2933
|
-
* @param {object} params.params.event Event object
|
|
2934
|
-
* @param {boolean} params.params.event.readOnly Read only or not
|
|
2599
|
+
* @param {object} params.event Event object
|
|
2600
|
+
* @param {boolean} params.event.readOnly Read only or not
|
|
2935
2601
|
*/
|
|
2936
2602
|
(e: 'readOnly', params: ((event: { readOnly: boolean }) => void)|string): void
|
|
2937
2603
|
/**
|
|
@@ -2943,94 +2609,79 @@ const emit = defineEmits<{
|
|
|
2943
2609
|
* Fires after a row is rendered.
|
|
2944
2610
|
* @param {string} e Event name
|
|
2945
2611
|
* @param {object} params Event parameters
|
|
2946
|
-
* @param {
|
|
2947
|
-
* @param {
|
|
2948
|
-
* @param {
|
|
2949
|
-
* @param {
|
|
2950
|
-
* @param {
|
|
2951
|
-
* @param {Core.data.Model} params.params.event.record The record for the row
|
|
2952
|
-
* @param {number} params.params.event.recordIndex The zero-based index of the record
|
|
2612
|
+
* @param {object} params.event Event object
|
|
2613
|
+
* @param {Grid.view.GridBase} params.event.source The firing Grid instance
|
|
2614
|
+
* @param {Grid.row.Row} params.event.row The row that has been rendered
|
|
2615
|
+
* @param {Core.data.Model} params.event.record The record for the row
|
|
2616
|
+
* @param {number} params.event.recordIndex The zero-based index of the record
|
|
2953
2617
|
*/
|
|
2954
2618
|
(e: 'renderRow', params: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string): void
|
|
2955
2619
|
/**
|
|
2956
2620
|
* Grid rows have been rendered
|
|
2957
2621
|
* @param {string} e Event name
|
|
2958
2622
|
* @param {object} params Event parameters
|
|
2959
|
-
* @param {
|
|
2960
|
-
* @param {
|
|
2961
|
-
* @param {object} params.params.event Event object
|
|
2962
|
-
* @param {Grid.view.GridBase} params.params.event.source This grid.
|
|
2623
|
+
* @param {object} params.event Event object
|
|
2624
|
+
* @param {Grid.view.GridBase} params.event.source This grid.
|
|
2963
2625
|
*/
|
|
2964
2626
|
(e: 'renderRows', params: ((event: { source: GridBase }) => void)|string): void
|
|
2965
2627
|
/**
|
|
2966
2628
|
* Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
|
|
2967
2629
|
* @param {string} e Event name
|
|
2968
2630
|
* @param {object} params Event parameters
|
|
2969
|
-
* @param {
|
|
2970
|
-
* @param {
|
|
2971
|
-
* @param {
|
|
2972
|
-
* @param {
|
|
2973
|
-
* @param {number} params.
|
|
2974
|
-
* @param {number} params.
|
|
2975
|
-
* @param {number} params.params.event.oldWidth The old width
|
|
2976
|
-
* @param {number} params.params.event.oldHeight The old height
|
|
2631
|
+
* @param {object} params.event Event object
|
|
2632
|
+
* @param {Core.widget.Widget} params.event.source This Widget
|
|
2633
|
+
* @param {number} params.event.width The new width
|
|
2634
|
+
* @param {number} params.event.height The new height
|
|
2635
|
+
* @param {number} params.event.oldWidth The old width
|
|
2636
|
+
* @param {number} params.event.oldHeight The old height
|
|
2977
2637
|
*/
|
|
2978
2638
|
(e: 'resize', params: ((event: { source: Widget, width: number, height: number, oldWidth: number, oldHeight: number }) => void)|string): void
|
|
2979
2639
|
/**
|
|
2980
2640
|
* This event fires on the owning scheduler before the context menu is shown for a resource.
|
|
2981
2641
|
* Allows manipulation of the items to show in the same way as in the [processItems](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ResourceMenu#config-processItems).
|
|
2982
|
-
* ...
|
|
2983
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-resourceMenuBeforeShow)
|
|
2642
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-resourceMenuBeforeShow)
|
|
2984
2643
|
* @param {string} e Event name
|
|
2985
2644
|
* @param {object} params Event parameters
|
|
2986
|
-
* @param {
|
|
2987
|
-
* @param {
|
|
2988
|
-
* @param {
|
|
2989
|
-
* @param {
|
|
2990
|
-
* @param {
|
|
2991
|
-
* @param {
|
|
2992
|
-
* @param {Grid.column.Column} params.params.event.column Column
|
|
2993
|
-
* @param {Scheduler.model.ResourceModel} params.params.event.resourceRecord Record
|
|
2645
|
+
* @param {object} params.event Event object
|
|
2646
|
+
* @param {Scheduler.view.Scheduler} params.event.source The grid
|
|
2647
|
+
* @param {Core.widget.Menu} params.event.menu The menu
|
|
2648
|
+
* @param {Record<string, MenuItemEntry>} params.event.items Menu item configs
|
|
2649
|
+
* @param {Grid.column.Column} params.event.column Column
|
|
2650
|
+
* @param {Scheduler.model.ResourceModel} params.event.resourceRecord Record
|
|
2994
2651
|
*/
|
|
2995
|
-
(e: 'resourceMenuBeforeShow', params: ((event: { source: Scheduler, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, resourceRecord: ResourceModel }) =>
|
|
2652
|
+
(e: 'resourceMenuBeforeShow', params: ((event: { source: Scheduler, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, resourceRecord: ResourceModel }) => boolean|void)|string): boolean|void
|
|
2996
2653
|
/**
|
|
2997
2654
|
* This event fires on the owning scheduler when an item is selected in the context menu.
|
|
2998
2655
|
* @param {string} e Event name
|
|
2999
2656
|
* @param {object} params Event parameters
|
|
3000
|
-
* @param {
|
|
3001
|
-
* @param {
|
|
3002
|
-
* @param {
|
|
3003
|
-
* @param {
|
|
3004
|
-
* @param {
|
|
3005
|
-
* @param {Core.widget.MenuItem} params.params.event.item Selected menu item
|
|
3006
|
-
* @param {Scheduler.model.ResourceModel} params.params.event.record Record
|
|
2657
|
+
* @param {object} params.event Event object
|
|
2658
|
+
* @param {Scheduler.view.Scheduler} params.event.source The grid
|
|
2659
|
+
* @param {Core.widget.Menu} params.event.menu The menu
|
|
2660
|
+
* @param {Core.widget.MenuItem} params.event.item Selected menu item
|
|
2661
|
+
* @param {Scheduler.model.ResourceModel} params.event.record Record
|
|
3007
2662
|
*/
|
|
3008
2663
|
(e: 'resourceMenuItem', params: ((event: { source: Scheduler, menu: Menu, item: MenuItem, record: ResourceModel }) => void)|string): void
|
|
3009
2664
|
/**
|
|
3010
2665
|
* This event fires on the owning scheduler after the context menu is shown for a resource.
|
|
3011
2666
|
* @param {string} e Event name
|
|
3012
2667
|
* @param {object} params Event parameters
|
|
3013
|
-
* @param {
|
|
3014
|
-
* @param {
|
|
3015
|
-
* @param {
|
|
3016
|
-
* @param {
|
|
3017
|
-
* @param {
|
|
3018
|
-
* @param {Record<string, MenuItemEntry>} params.params.event.items Menu item configs
|
|
3019
|
-
* @param {Scheduler.model.ResourceModel} params.params.event.record Record
|
|
2668
|
+
* @param {object} params.event Event object
|
|
2669
|
+
* @param {Scheduler.view.Scheduler} params.event.source The grid
|
|
2670
|
+
* @param {Core.widget.Menu} params.event.menu The menu
|
|
2671
|
+
* @param {Record<string, MenuItemEntry>} params.event.items Menu item configs
|
|
2672
|
+
* @param {Scheduler.model.ResourceModel} params.event.record Record
|
|
3020
2673
|
*/
|
|
3021
2674
|
(e: 'resourceMenuShow', params: ((event: { source: Scheduler, menu: Menu, items: Record<string, MenuItemEntry>, record: ResourceModel }) => void)|string): void
|
|
3022
2675
|
/**
|
|
3023
2676
|
* This event fires on the owning grid when a check item is toggled in the context menu.
|
|
3024
2677
|
* @param {string} e Event name
|
|
3025
2678
|
* @param {object} params Event parameters
|
|
3026
|
-
* @param {
|
|
3027
|
-
* @param {
|
|
3028
|
-
* @param {
|
|
3029
|
-
* @param {
|
|
3030
|
-
* @param {
|
|
3031
|
-
* @param {
|
|
3032
|
-
* @param {Scheduler.model.ResourceModel} params.params.event.resourceRecord Record
|
|
3033
|
-
* @param {boolean} params.params.event.checked Checked or not
|
|
2679
|
+
* @param {object} params.event Event object
|
|
2680
|
+
* @param {Scheduler.view.Scheduler} params.event.source The grid
|
|
2681
|
+
* @param {Core.widget.Menu} params.event.menu The menu
|
|
2682
|
+
* @param {Core.widget.MenuItem} params.event.item Selected menu item
|
|
2683
|
+
* @param {Scheduler.model.ResourceModel} params.event.resourceRecord Record
|
|
2684
|
+
* @param {boolean} params.event.checked Checked or not
|
|
3034
2685
|
*/
|
|
3035
2686
|
(e: 'resourceMenuToggleItem', params: ((event: { source: Scheduler, menu: Menu, item: MenuItem, resourceRecord: ResourceModel, checked: boolean }) => void)|string): void
|
|
3036
2687
|
/**
|
|
@@ -3038,14 +2689,12 @@ const emit = defineEmits<{
|
|
|
3038
2689
|
* `enableMouseEvents: true`.
|
|
3039
2690
|
* @param {string} e Event name
|
|
3040
2691
|
* @param {object} params Event parameters
|
|
3041
|
-
* @param {
|
|
3042
|
-
* @param {
|
|
3043
|
-
* @param {
|
|
3044
|
-
* @param {Scheduler.
|
|
3045
|
-
* @param {Scheduler.
|
|
3046
|
-
* @param {
|
|
3047
|
-
* @param {Scheduler.model.ResourceModel} params.params.event.resourceRecord Resource record
|
|
3048
|
-
* @param {MouseEvent} params.params.event.domEvent Browser event
|
|
2692
|
+
* @param {object} params.event Event object
|
|
2693
|
+
* @param {Scheduler.view.Scheduler} params.event.source This Scheduler
|
|
2694
|
+
* @param {Scheduler.feature.ResourceTimeRanges} params.event.feature The ResourceTimeRange feature
|
|
2695
|
+
* @param {Scheduler.model.ResourceTimeRangeModel} params.event.resourceTimeRangeRecord Resource time range record
|
|
2696
|
+
* @param {Scheduler.model.ResourceModel} params.event.resourceRecord Resource record
|
|
2697
|
+
* @param {MouseEvent} params.event.domEvent Browser event
|
|
3049
2698
|
*/
|
|
3050
2699
|
(e: 'resourceTimeRangeClick', params: ((event: { source: Scheduler, feature: ResourceTimeRanges, resourceTimeRangeRecord: ResourceTimeRangeModel, resourceRecord: ResourceModel, domEvent: MouseEvent }) => void)|string): void
|
|
3051
2700
|
/**
|
|
@@ -3053,14 +2702,12 @@ const emit = defineEmits<{
|
|
|
3053
2702
|
* with `enableMouseEvents: true`.
|
|
3054
2703
|
* @param {string} e Event name
|
|
3055
2704
|
* @param {object} params Event parameters
|
|
3056
|
-
* @param {
|
|
3057
|
-
* @param {
|
|
3058
|
-
* @param {
|
|
3059
|
-
* @param {Scheduler.
|
|
3060
|
-
* @param {Scheduler.
|
|
3061
|
-
* @param {
|
|
3062
|
-
* @param {Scheduler.model.ResourceModel} params.params.event.resourceRecord Resource record
|
|
3063
|
-
* @param {MouseEvent} params.params.event.domEvent Browser event
|
|
2705
|
+
* @param {object} params.event Event object
|
|
2706
|
+
* @param {Scheduler.view.Scheduler} params.event.source This Scheduler
|
|
2707
|
+
* @param {Scheduler.feature.ResourceTimeRanges} params.event.feature The ResourceTimeRange feature
|
|
2708
|
+
* @param {Scheduler.model.ResourceTimeRangeModel} params.event.resourceTimeRangeRecord Resource time range record
|
|
2709
|
+
* @param {Scheduler.model.ResourceModel} params.event.resourceRecord Resource record
|
|
2710
|
+
* @param {MouseEvent} params.event.domEvent Browser event
|
|
3064
2711
|
*/
|
|
3065
2712
|
(e: 'resourceTimeRangeContextMenu', params: ((event: { source: Scheduler, feature: ResourceTimeRanges, resourceTimeRangeRecord: ResourceTimeRangeModel, resourceRecord: ResourceModel, domEvent: MouseEvent }) => void)|string): void
|
|
3066
2713
|
/**
|
|
@@ -3068,14 +2715,12 @@ const emit = defineEmits<{
|
|
|
3068
2715
|
* with `enableMouseEvents: true`.
|
|
3069
2716
|
* @param {string} e Event name
|
|
3070
2717
|
* @param {object} params Event parameters
|
|
3071
|
-
* @param {
|
|
3072
|
-
* @param {
|
|
3073
|
-
* @param {
|
|
3074
|
-
* @param {Scheduler.
|
|
3075
|
-
* @param {Scheduler.
|
|
3076
|
-
* @param {
|
|
3077
|
-
* @param {Scheduler.model.ResourceModel} params.params.event.resourceRecord Resource record
|
|
3078
|
-
* @param {MouseEvent} params.params.event.domEvent Browser event
|
|
2718
|
+
* @param {object} params.event Event object
|
|
2719
|
+
* @param {Scheduler.view.Scheduler} params.event.source This Scheduler
|
|
2720
|
+
* @param {Scheduler.feature.ResourceTimeRanges} params.event.feature The ResourceTimeRange feature
|
|
2721
|
+
* @param {Scheduler.model.ResourceTimeRangeModel} params.event.resourceTimeRangeRecord Resource time range record
|
|
2722
|
+
* @param {Scheduler.model.ResourceModel} params.event.resourceRecord Resource record
|
|
2723
|
+
* @param {MouseEvent} params.event.domEvent Browser event
|
|
3079
2724
|
*/
|
|
3080
2725
|
(e: 'resourceTimeRangeDblClick', params: ((event: { source: Scheduler, feature: ResourceTimeRanges, resourceTimeRangeRecord: ResourceTimeRangeModel, resourceRecord: ResourceModel, domEvent: MouseEvent }) => void)|string): void
|
|
3081
2726
|
/**
|
|
@@ -3083,14 +2728,12 @@ const emit = defineEmits<{
|
|
|
3083
2728
|
* with `enableMouseEvents: true`.
|
|
3084
2729
|
* @param {string} e Event name
|
|
3085
2730
|
* @param {object} params Event parameters
|
|
3086
|
-
* @param {
|
|
3087
|
-
* @param {
|
|
3088
|
-
* @param {
|
|
3089
|
-
* @param {Scheduler.
|
|
3090
|
-
* @param {Scheduler.
|
|
3091
|
-
* @param {
|
|
3092
|
-
* @param {Scheduler.model.ResourceModel} params.params.event.resourceRecord Resource record
|
|
3093
|
-
* @param {MouseEvent} params.params.event.domEvent Browser event
|
|
2731
|
+
* @param {object} params.event Event object
|
|
2732
|
+
* @param {Scheduler.view.Scheduler} params.event.source This Scheduler
|
|
2733
|
+
* @param {Scheduler.feature.ResourceTimeRanges} params.event.feature The ResourceTimeRange feature
|
|
2734
|
+
* @param {Scheduler.model.ResourceTimeRangeModel} params.event.resourceTimeRangeRecord Resource time range record
|
|
2735
|
+
* @param {Scheduler.model.ResourceModel} params.event.resourceRecord Resource record
|
|
2736
|
+
* @param {MouseEvent} params.event.domEvent Browser event
|
|
3094
2737
|
*/
|
|
3095
2738
|
(e: 'resourceTimeRangeMouseDown', params: ((event: { source: Scheduler, feature: ResourceTimeRanges, resourceTimeRangeRecord: ResourceTimeRangeModel, resourceRecord: ResourceModel, domEvent: MouseEvent }) => void)|string): void
|
|
3096
2739
|
/**
|
|
@@ -3098,14 +2741,12 @@ const emit = defineEmits<{
|
|
|
3098
2741
|
* with `enableMouseEvents: true`.
|
|
3099
2742
|
* @param {string} e Event name
|
|
3100
2743
|
* @param {object} params Event parameters
|
|
3101
|
-
* @param {
|
|
3102
|
-
* @param {
|
|
3103
|
-
* @param {
|
|
3104
|
-
* @param {Scheduler.
|
|
3105
|
-
* @param {Scheduler.
|
|
3106
|
-
* @param {
|
|
3107
|
-
* @param {Scheduler.model.ResourceModel} params.params.event.resourceRecord Resource record
|
|
3108
|
-
* @param {MouseEvent} params.params.event.domEvent Browser event
|
|
2744
|
+
* @param {object} params.event Event object
|
|
2745
|
+
* @param {Scheduler.view.Scheduler} params.event.source This Scheduler
|
|
2746
|
+
* @param {Scheduler.feature.ResourceTimeRanges} params.event.feature The ResourceTimeRange feature
|
|
2747
|
+
* @param {Scheduler.model.ResourceTimeRangeModel} params.event.resourceTimeRangeRecord Resource time range record
|
|
2748
|
+
* @param {Scheduler.model.ResourceModel} params.event.resourceRecord Resource record
|
|
2749
|
+
* @param {MouseEvent} params.event.domEvent Browser event
|
|
3109
2750
|
*/
|
|
3110
2751
|
(e: 'resourceTimeRangeMouseOut', params: ((event: { source: Scheduler, feature: ResourceTimeRanges, resourceTimeRangeRecord: ResourceTimeRangeModel, resourceRecord: ResourceModel, domEvent: MouseEvent }) => void)|string): void
|
|
3111
2752
|
/**
|
|
@@ -3113,14 +2754,12 @@ const emit = defineEmits<{
|
|
|
3113
2754
|
* with `enableMouseEvents: true`.
|
|
3114
2755
|
* @param {string} e Event name
|
|
3115
2756
|
* @param {object} params Event parameters
|
|
3116
|
-
* @param {
|
|
3117
|
-
* @param {
|
|
3118
|
-
* @param {
|
|
3119
|
-
* @param {Scheduler.
|
|
3120
|
-
* @param {Scheduler.
|
|
3121
|
-
* @param {
|
|
3122
|
-
* @param {Scheduler.model.ResourceModel} params.params.event.resourceRecord Resource record
|
|
3123
|
-
* @param {MouseEvent} params.params.event.domEvent Browser event
|
|
2757
|
+
* @param {object} params.event Event object
|
|
2758
|
+
* @param {Scheduler.view.Scheduler} params.event.source This Scheduler
|
|
2759
|
+
* @param {Scheduler.feature.ResourceTimeRanges} params.event.feature The ResourceTimeRange feature
|
|
2760
|
+
* @param {Scheduler.model.ResourceTimeRangeModel} params.event.resourceTimeRangeRecord Resource time range record
|
|
2761
|
+
* @param {Scheduler.model.ResourceModel} params.event.resourceRecord Resource record
|
|
2762
|
+
* @param {MouseEvent} params.event.domEvent Browser event
|
|
3124
2763
|
*/
|
|
3125
2764
|
(e: 'resourceTimeRangeMouseOver', params: ((event: { source: Scheduler, feature: ResourceTimeRanges, resourceTimeRangeRecord: ResourceTimeRangeModel, resourceRecord: ResourceModel, domEvent: MouseEvent }) => void)|string): void
|
|
3126
2765
|
/**
|
|
@@ -3128,143 +2767,120 @@ const emit = defineEmits<{
|
|
|
3128
2767
|
* with `enableMouseEvents: true`.
|
|
3129
2768
|
* @param {string} e Event name
|
|
3130
2769
|
* @param {object} params Event parameters
|
|
3131
|
-
* @param {
|
|
3132
|
-
* @param {
|
|
3133
|
-
* @param {
|
|
3134
|
-
* @param {Scheduler.
|
|
3135
|
-
* @param {Scheduler.
|
|
3136
|
-
* @param {
|
|
3137
|
-
* @param {Scheduler.model.ResourceModel} params.params.event.resourceRecord Resource record
|
|
3138
|
-
* @param {MouseEvent} params.params.event.domEvent Browser event
|
|
2770
|
+
* @param {object} params.event Event object
|
|
2771
|
+
* @param {Scheduler.view.Scheduler} params.event.source This Scheduler
|
|
2772
|
+
* @param {Scheduler.feature.ResourceTimeRanges} params.event.feature The ResourceTimeRange feature
|
|
2773
|
+
* @param {Scheduler.model.ResourceTimeRangeModel} params.event.resourceTimeRangeRecord Resource time range record
|
|
2774
|
+
* @param {Scheduler.model.ResourceModel} params.event.resourceRecord Resource record
|
|
2775
|
+
* @param {MouseEvent} params.event.domEvent Browser event
|
|
3139
2776
|
*/
|
|
3140
2777
|
(e: 'resourceTimeRangeMouseUp', params: ((event: { source: Scheduler, feature: ResourceTimeRanges, resourceTimeRangeRecord: ResourceTimeRangeModel, resourceRecord: ResourceModel, domEvent: MouseEvent }) => void)|string): void
|
|
3141
2778
|
/**
|
|
3142
2779
|
* Grid resize lead to a new responsive level being applied
|
|
3143
2780
|
* @param {string} e Event name
|
|
3144
2781
|
* @param {object} params Event parameters
|
|
3145
|
-
* @param {
|
|
3146
|
-
* @param {
|
|
3147
|
-
* @param {
|
|
3148
|
-
* @param {
|
|
3149
|
-
* @param {string} params.
|
|
3150
|
-
* @param {number} params.
|
|
3151
|
-
* @param {string} params.params.event.oldLevel Old responsive level
|
|
3152
|
-
* @param {number} params.params.event.oldWidth Old width in px
|
|
2782
|
+
* @param {object} params.event Event object
|
|
2783
|
+
* @param {Grid.view.Grid} params.event.grid Grid that was resized
|
|
2784
|
+
* @param {string} params.event.level New responsive level (small, large, etc)
|
|
2785
|
+
* @param {number} params.event.width New width in px
|
|
2786
|
+
* @param {string} params.event.oldLevel Old responsive level
|
|
2787
|
+
* @param {number} params.event.oldWidth Old width in px
|
|
3153
2788
|
*/
|
|
3154
2789
|
(e: 'responsive', params: ((event: { grid: Grid, level: string, width: number, oldLevel: string, oldWidth: number }) => void)|string): void
|
|
3155
2790
|
/**
|
|
3156
2791
|
* This event fires when a row has finished collapsing.
|
|
3157
2792
|
* @param {string} e Event name
|
|
3158
2793
|
* @param {object} params Event parameters
|
|
3159
|
-
* @param {
|
|
3160
|
-
* @param {
|
|
3161
|
-
* @param {object} params.params.event Event object
|
|
3162
|
-
* @param {Core.data.Model} params.params.event.record Record
|
|
2794
|
+
* @param {object} params.event Event object
|
|
2795
|
+
* @param {Core.data.Model} params.event.record Record
|
|
3163
2796
|
*/
|
|
3164
2797
|
(e: 'rowCollapse', params: ((event: { record: Model }) => void)|string): void
|
|
3165
2798
|
/**
|
|
3166
2799
|
* This event fires when a row expand has finished expanding.
|
|
3167
|
-
* ...
|
|
3168
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-rowExpand)
|
|
2800
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-rowExpand)
|
|
3169
2801
|
* @param {string} e Event name
|
|
3170
2802
|
* @param {object} params Event parameters
|
|
3171
|
-
* @param {
|
|
3172
|
-
* @param {
|
|
3173
|
-
* @param {object} params.
|
|
3174
|
-
* @param {Core.
|
|
3175
|
-
* @param {object} params.
|
|
3176
|
-
* @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.
|
|
3177
|
-
* @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
|
|
2803
|
+
* @param {object} params.event Event object
|
|
2804
|
+
* @param {Core.data.Model} params.event.record Record
|
|
2805
|
+
* @param {object} params.event.expandedElements An object with the Grid region name as property and the expanded body element as value
|
|
2806
|
+
* @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.
|
|
2807
|
+
* @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
|
|
3178
2808
|
*/
|
|
3179
2809
|
(e: 'rowExpand', params: ((event: { record: Model, expandedElements: object, widget: Widget, widgets: object }) => void)|string): void
|
|
3180
2810
|
/**
|
|
3181
2811
|
* Fired when the mouse enters a row
|
|
3182
2812
|
* @param {string} e Event name
|
|
3183
2813
|
* @param {object} params Event parameters
|
|
3184
|
-
* @param {
|
|
3185
|
-
* @param {
|
|
3186
|
-
* @param {
|
|
3187
|
-
* @param {Grid.
|
|
3188
|
-
* @param {
|
|
3189
|
-
* @param {
|
|
3190
|
-
* @param {HTMLElement} params.params.event.cellElement The cell HTML element
|
|
3191
|
-
* @param {MouseEvent} params.params.event.event The native DOM event
|
|
2814
|
+
* @param {object} params.event Event object
|
|
2815
|
+
* @param {Grid.view.Grid} params.event.source The grid instance
|
|
2816
|
+
* @param {Core.data.Model} params.event.record The record representing the hovered row
|
|
2817
|
+
* @param {Grid.column.Column} params.event.column The column currently hovered
|
|
2818
|
+
* @param {HTMLElement} params.event.cellElement The cell HTML element
|
|
2819
|
+
* @param {MouseEvent} params.event.event The native DOM event
|
|
3192
2820
|
*/
|
|
3193
2821
|
(e: 'rowMouseEnter', params: ((event: { source: Grid, record: Model, column: Column, cellElement: HTMLElement, event: MouseEvent }) => void)|string): void
|
|
3194
2822
|
/**
|
|
3195
2823
|
* Fired when the mouse leaves a row
|
|
3196
2824
|
* @param {string} e Event name
|
|
3197
2825
|
* @param {object} params Event parameters
|
|
3198
|
-
* @param {
|
|
3199
|
-
* @param {
|
|
3200
|
-
* @param {
|
|
3201
|
-
* @param {
|
|
3202
|
-
* @param {
|
|
3203
|
-
* @param {HTMLElement} params.params.event.cellElement The cell HTML element that the mouse left
|
|
3204
|
-
* @param {MouseEvent} params.params.event.event The native DOM event
|
|
2826
|
+
* @param {object} params.event Event object
|
|
2827
|
+
* @param {Grid.view.Grid} params.event.source The grid instance
|
|
2828
|
+
* @param {Core.data.Model} params.event.record The record representing the row that the mouse left
|
|
2829
|
+
* @param {HTMLElement} params.event.cellElement The cell HTML element that the mouse left
|
|
2830
|
+
* @param {MouseEvent} params.event.event The native DOM event
|
|
3205
2831
|
*/
|
|
3206
2832
|
(e: 'rowMouseLeave', params: ((event: { source: Grid, record: Model, cellElement: HTMLElement, event: MouseEvent }) => void)|string): void
|
|
3207
2833
|
/**
|
|
3208
2834
|
* Grid has scrolled vertically
|
|
3209
2835
|
* @param {string} e Event name
|
|
3210
2836
|
* @param {object} params Event parameters
|
|
3211
|
-
* @param {
|
|
3212
|
-
* @param {
|
|
3213
|
-
* @param {
|
|
3214
|
-
* @param {Grid.view.GridBase} params.params.event.source The firing Grid instance.
|
|
3215
|
-
* @param {number} params.params.event.scrollTop The vertical scroll position.
|
|
2837
|
+
* @param {object} params.event Event object
|
|
2838
|
+
* @param {Grid.view.GridBase} params.event.source The firing Grid instance.
|
|
2839
|
+
* @param {number} params.event.scrollTop The vertical scroll position.
|
|
3216
2840
|
*/
|
|
3217
2841
|
(e: 'scroll', params: ((event: { source: GridBase, scrollTop: number }) => void)|string): void
|
|
3218
2842
|
/**
|
|
3219
2843
|
* The selection has been changed.
|
|
3220
2844
|
* @param {string} e Event name
|
|
3221
2845
|
* @param {object} params Event parameters
|
|
3222
|
-
* @param {
|
|
3223
|
-
* @param {
|
|
3224
|
-
* @param {
|
|
3225
|
-
* @param {
|
|
3226
|
-
* @param {
|
|
3227
|
-
* @param {
|
|
3228
|
-
* @param {Core.data.Model[]} params.
|
|
3229
|
-
* @param {
|
|
3230
|
-
* @param {
|
|
3231
|
-
* @param {Grid.util.GridLocation[]} params.
|
|
3232
|
-
* @param {Grid.util.GridLocation[]} params.params.event.selectedCells The cells selected in this operation.
|
|
3233
|
-
* @param {Grid.util.GridLocation[]} params.params.event.cellSelection The cells in the new selection.
|
|
2846
|
+
* @param {object} params.event Event object
|
|
2847
|
+
* @param {'select','deselect'} params.event.action `'select'`/`'deselect'`
|
|
2848
|
+
* @param {'row','cell'} params.event.mode `'row'`/`'cell'`
|
|
2849
|
+
* @param {Grid.view.Grid} params.event.source
|
|
2850
|
+
* @param {Core.data.Model[]} params.event.deselected The records deselected in this operation.
|
|
2851
|
+
* @param {Core.data.Model[]} params.event.selected The records selected in this operation.
|
|
2852
|
+
* @param {Core.data.Model[]} params.event.selection The records in the new selection.
|
|
2853
|
+
* @param {Grid.util.GridLocation[]} params.event.deselectedCells The cells deselected in this operation.
|
|
2854
|
+
* @param {Grid.util.GridLocation[]} params.event.selectedCells The cells selected in this operation.
|
|
2855
|
+
* @param {Grid.util.GridLocation[]} params.event.cellSelection The cells in the new selection.
|
|
3234
2856
|
*/
|
|
3235
2857
|
(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
|
|
3236
2858
|
/**
|
|
3237
2859
|
* The selectionMode configuration has been changed.
|
|
3238
2860
|
* @param {string} e Event name
|
|
3239
2861
|
* @param {object} params Event parameters
|
|
3240
|
-
* @param {
|
|
3241
|
-
* @param {object} params.
|
|
3242
|
-
* @param {object} params.params.event Event object
|
|
3243
|
-
* @param {object} params.params.event.selectionMode The new [selectionMode](https://bryntum.com/products/scheduler/docs/api/Grid/view/mixin/GridSelection#config-selectionMode)
|
|
2862
|
+
* @param {object} params.event Event object
|
|
2863
|
+
* @param {object} params.event.selectionMode The new [selectionMode](https://bryntum.com/products/scheduler/docs/api/Grid/view/mixin/GridSelection#config-selectionMode)
|
|
3244
2864
|
*/
|
|
3245
2865
|
(e: 'selectionModeChange', params: ((event: { selectionMode: object }) => void)|string): void
|
|
3246
2866
|
/**
|
|
3247
2867
|
* Triggered after a widget is shown.
|
|
3248
2868
|
* @param {string} e Event name
|
|
3249
2869
|
* @param {object} params Event parameters
|
|
3250
|
-
* @param {
|
|
3251
|
-
* @param {
|
|
3252
|
-
* @param {object} params.params.event Event object
|
|
3253
|
-
* @param {Core.widget.Widget} params.params.event.source The widget
|
|
2870
|
+
* @param {object} params.event Event object
|
|
2871
|
+
* @param {Core.widget.Widget} params.event.source The widget
|
|
3254
2872
|
*/
|
|
3255
2873
|
(e: 'show', params: ((event: { source: Widget }) => void)|string): void
|
|
3256
2874
|
/**
|
|
3257
2875
|
* Fires when splitting the Grid.
|
|
3258
2876
|
* @param {string} e Event name
|
|
3259
2877
|
* @param {object} params Event parameters
|
|
3260
|
-
* @param {
|
|
3261
|
-
* @param {
|
|
3262
|
-
* @param {object} params.
|
|
3263
|
-
* @param {
|
|
3264
|
-
* @param {
|
|
3265
|
-
* @param {
|
|
3266
|
-
* @param {Grid.column.Column} params.params.event.options.atColumn The column to split at
|
|
3267
|
-
* @param {Core.data.Model} params.params.event.options.atRecord The record to split at
|
|
2878
|
+
* @param {object} params.event Event object
|
|
2879
|
+
* @param {Grid.view.GridBase[]} params.event.subViews The sub views created by the split
|
|
2880
|
+
* @param {object} params.event.options The options passed to the split call
|
|
2881
|
+
* @param {'horizontal','vertical','both'} params.event.options.direction The direction of the split
|
|
2882
|
+
* @param {Grid.column.Column} params.event.options.atColumn The column to split at
|
|
2883
|
+
* @param {Core.data.Model} params.event.options.atRecord The record to split at
|
|
3268
2884
|
*/
|
|
3269
2885
|
(e: 'split', params: ((event: { subViews: GridBase[], options: { direction: 'horizontal'|'vertical'|'both', atColumn: Column, atRecord: Model } }) => void)|string): void
|
|
3270
2886
|
/**
|
|
@@ -3272,36 +2888,30 @@ const emit = defineEmits<{
|
|
|
3272
2888
|
* if you want to implement your own behavior.
|
|
3273
2889
|
* @param {string} e Event name
|
|
3274
2890
|
* @param {object} params Event parameters
|
|
3275
|
-
* @param {
|
|
3276
|
-
* @param {
|
|
3277
|
-
* @param {
|
|
3278
|
-
* @param {
|
|
3279
|
-
* @param {Grid.view.SubGrid} params.params.event.subGrid The subgrid
|
|
3280
|
-
* @param {Event} params.params.event.domEvent The native DOM event
|
|
2891
|
+
* @param {object} params.event Event object
|
|
2892
|
+
* @param {Grid.view.Grid} params.event.source The Grid instance.
|
|
2893
|
+
* @param {Grid.view.SubGrid} params.event.subGrid The subgrid
|
|
2894
|
+
* @param {Event} params.event.domEvent The native DOM event
|
|
3281
2895
|
*/
|
|
3282
|
-
(e: 'splitterCollapseClick', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
2896
|
+
(e: 'splitterCollapseClick', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string): boolean|void
|
|
3283
2897
|
/**
|
|
3284
2898
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
3285
2899
|
* @param {string} e Event name
|
|
3286
2900
|
* @param {object} params Event parameters
|
|
3287
|
-
* @param {
|
|
3288
|
-
* @param {
|
|
3289
|
-
* @param {
|
|
3290
|
-
* @param {
|
|
3291
|
-
* @param {Grid.view.SubGrid} params.params.event.subGrid The resized subgrid
|
|
3292
|
-
* @param {Event} params.params.event.domEvent The native DOM event
|
|
2901
|
+
* @param {object} params.event Event object
|
|
2902
|
+
* @param {Grid.view.Grid} params.event.source The Grid instance.
|
|
2903
|
+
* @param {Grid.view.SubGrid} params.event.subGrid The resized subgrid
|
|
2904
|
+
* @param {Event} params.event.domEvent The native DOM event
|
|
3293
2905
|
*/
|
|
3294
2906
|
(e: 'splitterDragEnd', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => void)|string): void
|
|
3295
2907
|
/**
|
|
3296
2908
|
* Fired by the Grid when a sub-grid resize gesture starts
|
|
3297
2909
|
* @param {string} e Event name
|
|
3298
2910
|
* @param {object} params Event parameters
|
|
3299
|
-
* @param {
|
|
3300
|
-
* @param {
|
|
3301
|
-
* @param {
|
|
3302
|
-
* @param {
|
|
3303
|
-
* @param {Grid.view.SubGrid} params.params.event.subGrid The subgrid about to be resized
|
|
3304
|
-
* @param {Event} params.params.event.domEvent The native DOM event
|
|
2911
|
+
* @param {object} params.event Event object
|
|
2912
|
+
* @param {Grid.view.Grid} params.event.source The Grid instance.
|
|
2913
|
+
* @param {Grid.view.SubGrid} params.event.subGrid The subgrid about to be resized
|
|
2914
|
+
* @param {Event} params.event.domEvent The native DOM event
|
|
3305
2915
|
*/
|
|
3306
2916
|
(e: 'splitterDragStart', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => void)|string): void
|
|
3307
2917
|
/**
|
|
@@ -3309,174 +2919,144 @@ const emit = defineEmits<{
|
|
|
3309
2919
|
* if you want to implement your own behavior.
|
|
3310
2920
|
* @param {string} e Event name
|
|
3311
2921
|
* @param {object} params Event parameters
|
|
3312
|
-
* @param {
|
|
3313
|
-
* @param {
|
|
3314
|
-
* @param {
|
|
3315
|
-
* @param {
|
|
3316
|
-
* @param {Grid.view.SubGrid} params.params.event.subGrid The subgrid
|
|
3317
|
-
* @param {Event} params.params.event.domEvent The native DOM event
|
|
2922
|
+
* @param {object} params.event Event object
|
|
2923
|
+
* @param {Grid.view.Grid} params.event.source The Grid instance.
|
|
2924
|
+
* @param {Grid.view.SubGrid} params.event.subGrid The subgrid
|
|
2925
|
+
* @param {Event} params.event.domEvent The native DOM event
|
|
3318
2926
|
*/
|
|
3319
|
-
(e: 'splitterExpandClick', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
2927
|
+
(e: 'splitterExpandClick', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string): boolean|void
|
|
3320
2928
|
/**
|
|
3321
2929
|
* Fires on the owning Grid when editing starts
|
|
3322
2930
|
* @param {string} e Event name
|
|
3323
2931
|
* @param {object} params Event parameters
|
|
3324
|
-
* @param {
|
|
3325
|
-
* @param {
|
|
3326
|
-
* @param {
|
|
3327
|
-
* @param {Grid.view.Grid} params.params.event.source Owner grid
|
|
3328
|
-
* @param {CellEditorContext} params.params.event.editorContext Editing context
|
|
2932
|
+
* @param {object} params.event Event object
|
|
2933
|
+
* @param {Grid.view.Grid} params.event.source Owner grid
|
|
2934
|
+
* @param {CellEditorContext} params.event.editorContext Editing context
|
|
3329
2935
|
*/
|
|
3330
2936
|
(e: 'startCellEdit', params: ((event: { source: Grid, editorContext: CellEditorContext }) => void)|string): void
|
|
3331
2937
|
/**
|
|
3332
2938
|
* Fires on the owning Grid when editing starts
|
|
3333
2939
|
* @param {string} e Event name
|
|
3334
2940
|
* @param {object} params Event parameters
|
|
3335
|
-
* @param {
|
|
3336
|
-
* @param {
|
|
3337
|
-
* @param {
|
|
3338
|
-
* @param {Grid.view.Grid} params.params.event.source Owner grid
|
|
3339
|
-
* @param {RowEditorContext} params.params.event.editorContext Editing context
|
|
2941
|
+
* @param {object} params.event Event object
|
|
2942
|
+
* @param {Grid.view.Grid} params.event.source Owner grid
|
|
2943
|
+
* @param {RowEditorContext} params.event.editorContext Editing context
|
|
3340
2944
|
*/
|
|
3341
2945
|
(e: 'startRowEdit', params: ((event: { source: Grid, editorContext: RowEditorContext }) => void)|string): void
|
|
3342
2946
|
/**
|
|
3343
2947
|
* Fires after a sub grid is collapsed.
|
|
3344
2948
|
* @param {string} e Event name
|
|
3345
2949
|
* @param {object} params Event parameters
|
|
3346
|
-
* @param {
|
|
3347
|
-
* @param {
|
|
3348
|
-
* @param {
|
|
3349
|
-
* @param {Grid.view.GridBase} params.params.event.source The firing Grid instance
|
|
3350
|
-
* @param {Grid.view.SubGrid} params.params.event.subGrid The sub grid instance
|
|
2950
|
+
* @param {object} params.event Event object
|
|
2951
|
+
* @param {Grid.view.GridBase} params.event.source The firing Grid instance
|
|
2952
|
+
* @param {Grid.view.SubGrid} params.event.subGrid The sub grid instance
|
|
3351
2953
|
*/
|
|
3352
2954
|
(e: 'subGridCollapse', params: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string): void
|
|
3353
2955
|
/**
|
|
3354
2956
|
* Fires after a sub grid is expanded.
|
|
3355
2957
|
* @param {string} e Event name
|
|
3356
2958
|
* @param {object} params Event parameters
|
|
3357
|
-
* @param {
|
|
3358
|
-
* @param {
|
|
3359
|
-
* @param {
|
|
3360
|
-
* @param {Grid.view.GridBase} params.params.event.source The firing Grid instance
|
|
3361
|
-
* @param {Grid.view.SubGrid} params.params.event.subGrid The sub grid instance
|
|
2959
|
+
* @param {object} params.event Event object
|
|
2960
|
+
* @param {Grid.view.GridBase} params.event.source The firing Grid instance
|
|
2961
|
+
* @param {Grid.view.SubGrid} params.event.subGrid The sub grid instance
|
|
3362
2962
|
*/
|
|
3363
2963
|
(e: 'subGridExpand', params: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string): void
|
|
3364
2964
|
/**
|
|
3365
2965
|
* Fired when the tick size changes.
|
|
3366
|
-
* ...
|
|
3367
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-tickSizeChange)
|
|
2966
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-tickSizeChange)
|
|
3368
2967
|
* @param {string} e Event name
|
|
3369
2968
|
* @param {object} params Event parameters
|
|
3370
|
-
* @param {
|
|
3371
|
-
* @param {
|
|
3372
|
-
* @param {
|
|
3373
|
-
* @param {Scheduler.view.Scheduler} params.params.event.source This Scheduler instance.
|
|
3374
|
-
* @param {number} params.params.event.tickSize The tick size in pixels
|
|
2969
|
+
* @param {object} params.event Event object
|
|
2970
|
+
* @param {Scheduler.view.Scheduler} params.event.source This Scheduler instance.
|
|
2971
|
+
* @param {number} params.event.tickSize The tick size in pixels
|
|
3375
2972
|
*/
|
|
3376
2973
|
(e: 'tickSizeChange', params: ((event: { source: Scheduler, tickSize: number }) => void)|string): void
|
|
3377
2974
|
/**
|
|
3378
2975
|
* Fired when the timeaxis has changed, for example by zooming or configuring a new time span.
|
|
3379
2976
|
* @param {string} e Event name
|
|
3380
2977
|
* @param {object} params Event parameters
|
|
3381
|
-
* @param {
|
|
3382
|
-
* @param {
|
|
3383
|
-
* @param {object} params.
|
|
3384
|
-
* @param {
|
|
3385
|
-
* @param {
|
|
3386
|
-
* @param {Date} params.params.event.config.startDate New start date (if supplied)
|
|
3387
|
-
* @param {Date} params.params.event.config.endDate New end date (if supplied)
|
|
2978
|
+
* @param {object} params.event Event object
|
|
2979
|
+
* @param {Scheduler.view.Scheduler} params.event.source This Scheduler
|
|
2980
|
+
* @param {object} params.event.config Config object used to reconfigure the time axis.
|
|
2981
|
+
* @param {Date} params.event.config.startDate New start date (if supplied)
|
|
2982
|
+
* @param {Date} params.event.config.endDate New end date (if supplied)
|
|
3388
2983
|
*/
|
|
3389
2984
|
(e: 'timeAxisChange', params: ((event: { source: Scheduler, config: { startDate: Date, endDate: Date } }) => void)|string): void
|
|
3390
2985
|
/**
|
|
3391
2986
|
* Fires after a click on a time axis cell
|
|
3392
2987
|
* @param {string} e Event name
|
|
3393
2988
|
* @param {object} params Event parameters
|
|
3394
|
-
* @param {
|
|
3395
|
-
* @param {
|
|
3396
|
-
* @param {
|
|
3397
|
-
* @param {
|
|
3398
|
-
* @param {
|
|
3399
|
-
* @param {Date} params.params.event.endDate The end date of the header cell
|
|
3400
|
-
* @param {Event} params.params.event.event The event object
|
|
2989
|
+
* @param {object} params.event Event object
|
|
2990
|
+
* @param {Scheduler.column.TimeAxisColumn,Scheduler.column.VerticalTimeAxisColumn} params.event.source The column object
|
|
2991
|
+
* @param {Date} params.event.startDate The start date of the header cell
|
|
2992
|
+
* @param {Date} params.event.endDate The end date of the header cell
|
|
2993
|
+
* @param {Event} params.event.event The event object
|
|
3401
2994
|
*/
|
|
3402
2995
|
(e: 'timeAxisHeaderClick', params: ((event: { source: TimeAxisColumn|VerticalTimeAxisColumn, startDate: Date, endDate: Date, event: Event }) => void)|string): void
|
|
3403
2996
|
/**
|
|
3404
2997
|
* Fires after a right click on a time axis cell
|
|
3405
2998
|
* @param {string} e Event name
|
|
3406
2999
|
* @param {object} params Event parameters
|
|
3407
|
-
* @param {
|
|
3408
|
-
* @param {
|
|
3409
|
-
* @param {
|
|
3410
|
-
* @param {
|
|
3411
|
-
* @param {
|
|
3412
|
-
* @param {Date} params.params.event.endDate The end date of the header cell
|
|
3413
|
-
* @param {Event} params.params.event.event The event object
|
|
3000
|
+
* @param {object} params.event Event object
|
|
3001
|
+
* @param {Scheduler.column.TimeAxisColumn,Scheduler.column.VerticalTimeAxisColumn} params.event.source The column object
|
|
3002
|
+
* @param {Date} params.event.startDate The start date of the header cell
|
|
3003
|
+
* @param {Date} params.event.endDate The end date of the header cell
|
|
3004
|
+
* @param {Event} params.event.event The event object
|
|
3414
3005
|
*/
|
|
3415
3006
|
(e: 'timeAxisHeaderContextMenu', params: ((event: { source: TimeAxisColumn|VerticalTimeAxisColumn, startDate: Date, endDate: Date, event: Event }) => void)|string): void
|
|
3416
3007
|
/**
|
|
3417
3008
|
* Fires after a double click on a time axis cell
|
|
3418
3009
|
* @param {string} e Event name
|
|
3419
3010
|
* @param {object} params Event parameters
|
|
3420
|
-
* @param {
|
|
3421
|
-
* @param {
|
|
3422
|
-
* @param {
|
|
3423
|
-
* @param {
|
|
3424
|
-
* @param {
|
|
3425
|
-
* @param {Date} params.params.event.endDate The end date of the header cell
|
|
3426
|
-
* @param {Event} params.params.event.event The event object
|
|
3011
|
+
* @param {object} params.event Event object
|
|
3012
|
+
* @param {Scheduler.column.TimeAxisColumn,Scheduler.column.VerticalTimeAxisColumn} params.event.source The column object
|
|
3013
|
+
* @param {Date} params.event.startDate The start date of the header cell
|
|
3014
|
+
* @param {Date} params.event.endDate The end date of the header cell
|
|
3015
|
+
* @param {Event} params.event.event The event object
|
|
3427
3016
|
*/
|
|
3428
3017
|
(e: 'timeAxisHeaderDblClick', params: ((event: { source: TimeAxisColumn|VerticalTimeAxisColumn, startDate: Date, endDate: Date, event: Event }) => void)|string): void
|
|
3429
3018
|
/**
|
|
3430
3019
|
* This event fires on the owning Scheduler or Gantt widget before the context menu is shown for the time axis header.
|
|
3431
3020
|
* Allows manipulation of the items to show in the same way as in the [processItems](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/TimeAxisHeaderMenu#config-processItems).
|
|
3432
|
-
* ...
|
|
3433
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-timeAxisHeaderMenuBeforeShow)
|
|
3021
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-timeAxisHeaderMenuBeforeShow)
|
|
3434
3022
|
* @param {string} e Event name
|
|
3435
3023
|
* @param {object} params Event parameters
|
|
3436
|
-
* @param {
|
|
3437
|
-
* @param {
|
|
3438
|
-
* @param {
|
|
3439
|
-
* @param {
|
|
3440
|
-
* @param {
|
|
3441
|
-
* @param {Record<string, MenuItemEntry>} params.params.event.items Menu item configs
|
|
3442
|
-
* @param {Grid.column.Column} params.params.event.column Time axis column
|
|
3024
|
+
* @param {object} params.event Event object
|
|
3025
|
+
* @param {Scheduler.view.Scheduler} params.event.source The scheduler
|
|
3026
|
+
* @param {Core.widget.Menu} params.event.menu The menu
|
|
3027
|
+
* @param {Record<string, MenuItemEntry>} params.event.items Menu item configs
|
|
3028
|
+
* @param {Grid.column.Column} params.event.column Time axis column
|
|
3443
3029
|
*/
|
|
3444
|
-
(e: 'timeAxisHeaderMenuBeforeShow', params: ((event: { source: Scheduler, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
3030
|
+
(e: 'timeAxisHeaderMenuBeforeShow', params: ((event: { source: Scheduler, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void)|string): boolean|void
|
|
3445
3031
|
/**
|
|
3446
3032
|
* This event fires on the owning Scheduler or Gantt widget when an item is selected in the header context menu.
|
|
3447
3033
|
* @param {string} e Event name
|
|
3448
3034
|
* @param {object} params Event parameters
|
|
3449
|
-
* @param {
|
|
3450
|
-
* @param {
|
|
3451
|
-
* @param {
|
|
3452
|
-
* @param {
|
|
3453
|
-
* @param {
|
|
3454
|
-
* @param {Core.widget.MenuItem} params.params.event.item Selected menu item
|
|
3455
|
-
* @param {Grid.column.Column} params.params.event.column Time axis column
|
|
3035
|
+
* @param {object} params.event Event object
|
|
3036
|
+
* @param {Scheduler.view.Scheduler} params.event.source The scheduler
|
|
3037
|
+
* @param {Core.widget.Menu} params.event.menu The menu
|
|
3038
|
+
* @param {Core.widget.MenuItem} params.event.item Selected menu item
|
|
3039
|
+
* @param {Grid.column.Column} params.event.column Time axis column
|
|
3456
3040
|
*/
|
|
3457
3041
|
(e: 'timeAxisHeaderMenuItem', params: ((event: { source: Scheduler, menu: Menu, item: MenuItem, column: Column }) => void)|string): void
|
|
3458
3042
|
/**
|
|
3459
3043
|
* This event fires on the owning Scheduler or Gantt widget after the context menu is shown for a header
|
|
3460
3044
|
* @param {string} e Event name
|
|
3461
3045
|
* @param {object} params Event parameters
|
|
3462
|
-
* @param {
|
|
3463
|
-
* @param {
|
|
3464
|
-
* @param {
|
|
3465
|
-
* @param {
|
|
3466
|
-
* @param {
|
|
3467
|
-
* @param {Record<string, MenuItemEntry>} params.params.event.items Menu item configs
|
|
3468
|
-
* @param {Grid.column.Column} params.params.event.column Time axis column
|
|
3046
|
+
* @param {object} params.event Event object
|
|
3047
|
+
* @param {Scheduler.view.Scheduler} params.event.source The scheduler
|
|
3048
|
+
* @param {Core.widget.Menu} params.event.menu The menu
|
|
3049
|
+
* @param {Record<string, MenuItemEntry>} params.event.items Menu item configs
|
|
3050
|
+
* @param {Grid.column.Column} params.event.column Time axis column
|
|
3469
3051
|
*/
|
|
3470
3052
|
(e: 'timeAxisHeaderMenuShow', params: ((event: { source: Scheduler, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => void)|string): void
|
|
3471
3053
|
/**
|
|
3472
3054
|
* Fired when the pointer-activated [timelineContext](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineDomEvents#property-timelineContext) has changed.
|
|
3473
3055
|
* @param {string} e Event name
|
|
3474
3056
|
* @param {object} params Event parameters
|
|
3475
|
-
* @param {
|
|
3476
|
-
* @param {
|
|
3477
|
-
* @param {
|
|
3478
|
-
* @param {Scheduler.util.TimelineContext} params.params.event.oldContext The tick/resource context being deactivated.
|
|
3479
|
-
* @param {Scheduler.util.TimelineContext} params.params.event.context The tick/resource context being activated.
|
|
3057
|
+
* @param {object} params.event Event object
|
|
3058
|
+
* @param {Scheduler.util.TimelineContext} params.event.oldContext The tick/resource context being deactivated.
|
|
3059
|
+
* @param {Scheduler.util.TimelineContext} params.event.context The tick/resource context being activated.
|
|
3480
3060
|
*/
|
|
3481
3061
|
(e: 'timelineContextChange', params: ((event: { oldContext: TimelineContext, context: TimelineContext }) => void)|string): void
|
|
3482
3062
|
/**
|
|
@@ -3485,107 +3065,89 @@ const emit = defineEmits<{
|
|
|
3485
3065
|
* scheduler column changes width.
|
|
3486
3066
|
* @param {string} e Event name
|
|
3487
3067
|
* @param {object} params Event parameters
|
|
3488
|
-
* @param {
|
|
3489
|
-
* @param {
|
|
3490
|
-
* @param {
|
|
3491
|
-
* @param {
|
|
3492
|
-
* @param {number} params.
|
|
3493
|
-
* @param {number} params.
|
|
3494
|
-
* @param {number} params.params.event.oldWidth The old width
|
|
3495
|
-
* @param {number} params.params.event.oldHeight The old height
|
|
3068
|
+
* @param {object} params.event Event object
|
|
3069
|
+
* @param {Core.widget.Widget} params.event.source This Scheduler
|
|
3070
|
+
* @param {number} params.event.width The new width
|
|
3071
|
+
* @param {number} params.event.height The new height
|
|
3072
|
+
* @param {number} params.event.oldWidth The old width
|
|
3073
|
+
* @param {number} params.event.oldHeight The old height
|
|
3496
3074
|
*/
|
|
3497
3075
|
(e: 'timelineViewportResize', params: ((event: { source: Widget, width: number, height: number, oldWidth: number, oldHeight: number }) => void)|string): void
|
|
3498
3076
|
/**
|
|
3499
3077
|
* Fired on the owning Scheduler or Gantt widget when a click happens on a time range header element
|
|
3500
3078
|
* @param {string} e Event name
|
|
3501
3079
|
* @param {object} params Event parameters
|
|
3502
|
-
* @param {
|
|
3503
|
-
* @param {
|
|
3504
|
-
* @param {
|
|
3505
|
-
* @param {
|
|
3506
|
-
* @param {Scheduler.model.TimeSpan} params.params.event.timeRangeRecord The record
|
|
3507
|
-
* @param {MouseEvent} params.params.event.domEvent Browser event
|
|
3080
|
+
* @param {object} params.event Event object
|
|
3081
|
+
* @param {Scheduler.view.Scheduler} params.event.source Scheduler instance
|
|
3082
|
+
* @param {Scheduler.model.TimeSpan} params.event.timeRangeRecord The record
|
|
3083
|
+
* @param {MouseEvent} params.event.domEvent Browser event
|
|
3508
3084
|
*/
|
|
3509
3085
|
(e: 'timeRangeHeaderClick', params: ((event: { source: Scheduler, timeRangeRecord: TimeSpan, domEvent: MouseEvent }) => void)|string): void
|
|
3510
3086
|
/**
|
|
3511
3087
|
* Fired on the owning Scheduler or Gantt widget when a right click happens on a time range header element
|
|
3512
3088
|
* @param {string} e Event name
|
|
3513
3089
|
* @param {object} params Event parameters
|
|
3514
|
-
* @param {
|
|
3515
|
-
* @param {
|
|
3516
|
-
* @param {
|
|
3517
|
-
* @param {
|
|
3518
|
-
* @param {Scheduler.model.TimeSpan} params.params.event.timeRangeRecord The record
|
|
3519
|
-
* @param {MouseEvent} params.params.event.domEvent Browser event
|
|
3090
|
+
* @param {object} params.event Event object
|
|
3091
|
+
* @param {Scheduler.view.Scheduler} params.event.source Scheduler instance
|
|
3092
|
+
* @param {Scheduler.model.TimeSpan} params.event.timeRangeRecord The record
|
|
3093
|
+
* @param {MouseEvent} params.event.domEvent Browser event
|
|
3520
3094
|
*/
|
|
3521
3095
|
(e: 'timeRangeHeaderContextMenu', params: ((event: { source: Scheduler, timeRangeRecord: TimeSpan, domEvent: MouseEvent }) => void)|string): void
|
|
3522
3096
|
/**
|
|
3523
3097
|
* Fired on the owning Scheduler or Gantt widget when a double click happens on a time range header element
|
|
3524
3098
|
* @param {string} e Event name
|
|
3525
3099
|
* @param {object} params Event parameters
|
|
3526
|
-
* @param {
|
|
3527
|
-
* @param {
|
|
3528
|
-
* @param {
|
|
3529
|
-
* @param {
|
|
3530
|
-
* @param {Scheduler.model.TimeSpan} params.params.event.timeRangeRecord The record
|
|
3531
|
-
* @param {MouseEvent} params.params.event.domEvent Browser event
|
|
3100
|
+
* @param {object} params.event Event object
|
|
3101
|
+
* @param {Scheduler.view.Scheduler} params.event.source Scheduler instance
|
|
3102
|
+
* @param {Scheduler.model.TimeSpan} params.event.timeRangeRecord The record
|
|
3103
|
+
* @param {MouseEvent} params.event.domEvent Browser event
|
|
3532
3104
|
*/
|
|
3533
3105
|
(e: 'timeRangeHeaderDblClick', params: ((event: { source: Scheduler, timeRangeRecord: TimeSpan, domEvent: MouseEvent }) => void)|string): void
|
|
3534
3106
|
/**
|
|
3535
3107
|
* Fired when one or more groups are expanded or collapsed
|
|
3536
3108
|
* @param {string} e Event name
|
|
3537
3109
|
* @param {object} params Event parameters
|
|
3538
|
-
* @param {
|
|
3539
|
-
* @param {
|
|
3540
|
-
* @param {
|
|
3541
|
-
* @param {
|
|
3542
|
-
* @param {
|
|
3543
|
-
* @param {boolean} params.params.event.collapse Collapsed (true) or expanded (false)
|
|
3544
|
-
* @param {boolean} params.params.event.allRecords True if this event is part of toggling all groups
|
|
3110
|
+
* @param {object} params.event Event object
|
|
3111
|
+
* @param {Core.data.Model} params.event.groupRecord [DEPRECATED] Use `groupRecords` param instead
|
|
3112
|
+
* @param {Core.data.Model[]} params.event.groupRecords The group records being toggled
|
|
3113
|
+
* @param {boolean} params.event.collapse Collapsed (true) or expanded (false)
|
|
3114
|
+
* @param {boolean} [params.event.allRecords] True if this event is part of toggling all groups
|
|
3545
3115
|
*/
|
|
3546
3116
|
(e: 'toggleGroup', params: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, allRecords?: boolean }) => void)|string): void
|
|
3547
3117
|
/**
|
|
3548
3118
|
* Fired after a parent node record toggles its collapsed state.
|
|
3549
3119
|
* @param {string} e Event name
|
|
3550
3120
|
* @param {object} params Event parameters
|
|
3551
|
-
* @param {
|
|
3552
|
-
* @param {
|
|
3553
|
-
* @param {
|
|
3554
|
-
* @param {Core.data.Model} params.params.event.record The record being toggled.
|
|
3555
|
-
* @param {boolean} params.params.event.collapse `true` if the node is being collapsed.
|
|
3121
|
+
* @param {object} params.event Event object
|
|
3122
|
+
* @param {Core.data.Model} params.event.record The record being toggled.
|
|
3123
|
+
* @param {boolean} params.event.collapse `true` if the node is being collapsed.
|
|
3556
3124
|
*/
|
|
3557
3125
|
(e: 'toggleNode', params: ((event: { record: Model, collapse: boolean }) => void)|string): void
|
|
3558
3126
|
/**
|
|
3559
3127
|
* A header [tool](https://bryntum.com/products/scheduler/docs/api/Core/widget/Panel#config-tools) has been clicked.
|
|
3560
3128
|
* @param {string} e Event name
|
|
3561
3129
|
* @param {object} params Event parameters
|
|
3562
|
-
* @param {
|
|
3563
|
-
* @param {
|
|
3564
|
-
* @param {
|
|
3565
|
-
* @param {Core.widget.Tool} params.params.event.source This Panel.
|
|
3566
|
-
* @param {Core.widget.Tool} params.params.event.tool The tool which is being clicked.
|
|
3130
|
+
* @param {object} params.event Event object
|
|
3131
|
+
* @param {Core.widget.Tool} params.event.source This Panel.
|
|
3132
|
+
* @param {Core.widget.Tool} params.event.tool The tool which is being clicked.
|
|
3567
3133
|
*/
|
|
3568
3134
|
(e: 'toolClick', params: ((event: { source: Tool, tool: Tool }) => void)|string): void
|
|
3569
3135
|
/**
|
|
3570
3136
|
* Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
|
|
3571
3137
|
* @param {string} e Event name
|
|
3572
3138
|
* @param {object} params Event parameters
|
|
3573
|
-
* @param {
|
|
3574
|
-
* @param {
|
|
3575
|
-
* @param {
|
|
3576
|
-
* @param {
|
|
3577
|
-
* @param {(string|Function)[]} params.params.event.groupers Array of field names or functions representing the current grouping levels
|
|
3578
|
-
* @param {(string|Function)[]} params.params.event.oldGroupers Array of field names or functions representing the previous grouping levels
|
|
3139
|
+
* @param {object} params.event Event object
|
|
3140
|
+
* @param {Grid.view.Grid} params.event.source The grid instance
|
|
3141
|
+
* @param {(string|Function)[]} params.event.groupers Array of field names or functions representing the current grouping levels
|
|
3142
|
+
* @param {(string|Function)[]} params.event.oldGroupers Array of field names or functions representing the previous grouping levels
|
|
3579
3143
|
*/
|
|
3580
3144
|
(e: 'treeGroup', params: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string): void
|
|
3581
3145
|
/**
|
|
3582
3146
|
* Fires when row locking is disabled.
|
|
3583
3147
|
* @param {string} e Event name
|
|
3584
3148
|
* @param {object} params Event parameters
|
|
3585
|
-
* @param {
|
|
3586
|
-
* @param {
|
|
3587
|
-
* @param {object} params.params.event Event object
|
|
3588
|
-
* @param {Grid.view.GridBase} params.params.event.clone The locked clone that will be destroyed
|
|
3149
|
+
* @param {object} params.event Event object
|
|
3150
|
+
* @param {Grid.view.GridBase} params.event.clone The locked clone that will be destroyed
|
|
3589
3151
|
*/
|
|
3590
3152
|
(e: 'unlockRows', params: ((event: { clone: GridBase }) => void)|string): void
|
|
3591
3153
|
/**
|
|
@@ -3595,22 +3157,29 @@ const emit = defineEmits<{
|
|
|
3595
3157
|
/**
|
|
3596
3158
|
* Fired when the range of dates visible within the viewport changes. This will be when
|
|
3597
3159
|
* scrolling along a time axis.
|
|
3598
|
-
* ...
|
|
3599
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-visibleDateRangeChange)
|
|
3160
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-visibleDateRangeChange)
|
|
3600
3161
|
* @param {string} e Event name
|
|
3601
3162
|
* @param {object} params Event parameters
|
|
3602
|
-
* @param {
|
|
3603
|
-
* @param {
|
|
3604
|
-
* @param {object} params.
|
|
3605
|
-
* @param {
|
|
3606
|
-
* @param {
|
|
3607
|
-
* @param {
|
|
3608
|
-
* @param {Date} params.
|
|
3609
|
-
* @param {
|
|
3610
|
-
* @param {Date} params.params.event.new.startDate the new start date.
|
|
3611
|
-
* @param {Date} params.params.event.new.endDate the new end date.
|
|
3163
|
+
* @param {object} params.event Event object
|
|
3164
|
+
* @param {Scheduler.view.Scheduler} params.event.source This Scheduler instance.
|
|
3165
|
+
* @param {object} params.event.old The old date range
|
|
3166
|
+
* @param {Date} params.event.old.startDate the old start date.
|
|
3167
|
+
* @param {Date} params.event.old.endDate the old end date.
|
|
3168
|
+
* @param {object} params.event.new The new date range
|
|
3169
|
+
* @param {Date} params.event.new.startDate the new start date.
|
|
3170
|
+
* @param {Date} params.event.new.endDate the new end date.
|
|
3612
3171
|
*/
|
|
3613
3172
|
(e: 'visibleDateRangeChange', params: ((event: { source: Scheduler, old: { startDate: Date, endDate: Date }, new: { startDate: Date, endDate: Date } }) => void)|string): void
|
|
3173
|
+
/**
|
|
3174
|
+
* Fires when the smooth zoom level changes, either through programmatic zoom methods or mouse wheel zooming.
|
|
3175
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-zoomLevelChange)
|
|
3176
|
+
* @param {string} e Event name
|
|
3177
|
+
* @param {object} params Event parameters
|
|
3178
|
+
* @param {object} params.event Event object
|
|
3179
|
+
* @param {Scheduler.view.TimelineBase} params.event.source
|
|
3180
|
+
* @param {number} params.event.zoomLevel New zoom level
|
|
3181
|
+
*/
|
|
3182
|
+
(e: 'zoomLevelChange', params: ((event: { source: TimelineBase, zoomLevel: number }) => void)|string): void
|
|
3614
3183
|
}>();
|
|
3615
3184
|
|
|
3616
3185
|
const widgetData = {
|
|
@@ -3755,6 +3324,7 @@ const widgetData = {
|
|
|
3755
3324
|
'resourceTimeRangeRenderer',
|
|
3756
3325
|
'responsiveLevels',
|
|
3757
3326
|
'ripple',
|
|
3327
|
+
'role',
|
|
3758
3328
|
'rootElement',
|
|
3759
3329
|
'scaleColumn',
|
|
3760
3330
|
'scrollerClass',
|
|
@@ -3762,6 +3332,7 @@ const widgetData = {
|
|
|
3762
3332
|
'series',
|
|
3763
3333
|
'showBarTipWhenNavigatingTimeAxis',
|
|
3764
3334
|
'showDirty',
|
|
3335
|
+
'smoothZoom',
|
|
3765
3336
|
'snapRelativeToEventStartDate',
|
|
3766
3337
|
'stateful',
|
|
3767
3338
|
'statefulEvents',
|
|
@@ -3824,6 +3395,7 @@ const widgetData = {
|
|
|
3824
3395
|
'insertFirst',
|
|
3825
3396
|
'keyMap',
|
|
3826
3397
|
'labelPosition',
|
|
3398
|
+
'labelWidth',
|
|
3827
3399
|
'longPressTime',
|
|
3828
3400
|
'margin',
|
|
3829
3401
|
'maxDate',
|
|
@@ -3990,6 +3562,7 @@ const widgetData = {
|
|
|
3990
3562
|
'onUnlockRows',
|
|
3991
3563
|
'onUnsplit',
|
|
3992
3564
|
'onVisibleDateRangeChange',
|
|
3565
|
+
'onZoomLevelChange',
|
|
3993
3566
|
'preserveScroll',
|
|
3994
3567
|
'presets',
|
|
3995
3568
|
'readOnly',
|
|
@@ -4018,11 +3591,10 @@ const widgetData = {
|
|
|
4018
3591
|
'viewPreset',
|
|
4019
3592
|
'visibleDate',
|
|
4020
3593
|
'width',
|
|
4021
|
-
'workingTime'
|
|
3594
|
+
'workingTime',
|
|
3595
|
+
'zoomFactor'
|
|
4022
3596
|
],
|
|
4023
3597
|
propertyNames : [
|
|
4024
|
-
'focusVisible',
|
|
4025
|
-
'hasChanges',
|
|
4026
3598
|
'originalStore',
|
|
4027
3599
|
'parent',
|
|
4028
3600
|
'scrollLeft',
|
|
@@ -4193,7 +3765,8 @@ const widgetData = {
|
|
|
4193
3765
|
'treeGroup',
|
|
4194
3766
|
'unlockRows',
|
|
4195
3767
|
'unsplit',
|
|
4196
|
-
'visibleDateRangeChange'
|
|
3768
|
+
'visibleDateRangeChange',
|
|
3769
|
+
'zoomLevelChange'
|
|
4197
3770
|
]
|
|
4198
3771
|
};
|
|
4199
3772
|
|