@bryntum/scheduler-vue-3-thin 7.2.4 → 7.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -6
- package/lib/chunks/{C7ZFK2B7.js → 5o-YjSb7.js} +16 -10
- package/lib/chunks/5o-YjSb7.js.map +1 -0
- package/lib/chunks/BXIuEgYD.js +265 -0
- package/lib/chunks/BXIuEgYD.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/{DmQj0tBi.js → DP61St-u.js} +14 -6
- package/lib/chunks/DP61St-u.js.map +1 -0
- package/lib/chunks/{B0m0r-NV.js → DVFhf2Ma.js} +11 -11
- package/lib/chunks/DVFhf2Ma.js.map +1 -0
- package/lib/chunks/{DerP_qo7.js → DhhzgoYL.js} +16 -10
- package/lib/chunks/DhhzgoYL.js.map +1 -0
- package/lib/chunks/{BNGLBrCN.js → OJaN5ZWK.js} +6 -6
- package/lib/chunks/OJaN5ZWK.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/{mKqb8_2f.js → ZkU6CtWX.js} +6 -6
- package/lib/chunks/ZkU6CtWX.js.map +1 -0
- package/lib/chunks/{C0UqC4Uj.js → eUISgYXE.js} +9 -9
- package/lib/chunks/eUISgYXE.js.map +1 -0
- package/lib/chunks/{CsoS615B.js → kN-s_8Na.js} +6 -6
- package/lib/chunks/kN-s_8Na.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 +72 -116
- package/src/components/BryntumEventColorFieldProps.ts +68 -108
- package/src/components/BryntumProjectCombo.vue +90 -149
- package/src/components/BryntumProjectComboProps.ts +86 -141
- package/src/components/BryntumResourceCombo.vue +91 -151
- package/src/components/BryntumResourceComboProps.ts +87 -143
- package/src/components/BryntumResourceFilter.vue +63 -104
- package/src/components/BryntumResourceFilterProps.ts +60 -98
- package/src/components/BryntumScheduler.vue +426 -597
- package/src/components/BryntumSchedulerBase.vue +426 -597
- package/src/components/BryntumSchedulerBaseProps.ts +367 -522
- package/src/components/BryntumSchedulerDatePicker.vue +120 -196
- package/src/components/BryntumSchedulerDatePickerProps.ts +116 -187
- package/src/components/BryntumSchedulerProjectModel.vue +12 -31
- package/src/components/BryntumSchedulerProjectModelProps.ts +10 -20
- package/src/components/BryntumSchedulerProps.ts +367 -522
- package/src/components/BryntumThemeCombo.vue +60 -0
- package/src/components/BryntumTimeZoomSlider.vue +859 -0
- package/src/components/BryntumTimeZoomSliderProps.ts +482 -0
- package/src/components/BryntumTimelineHistogram.vue +322 -441
- package/src/components/BryntumTimelineHistogramProps.ts +275 -388
- package/src/components/BryntumUndoRedo.vue +78 -125
- package/src/components/BryntumUndoRedoProps.ts +74 -116
- package/src/components/BryntumViewPresetCombo.vue +67 -107
- package/src/components/BryntumViewPresetComboProps.ts +63 -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.
|
|
848
|
+
*/
|
|
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)
|
|
898
854
|
*/
|
|
899
|
-
|
|
900
|
-
delegate?: string
|
|
901
|
-
color?: string
|
|
902
|
-
radius?: number
|
|
903
|
-
clip?: string
|
|
904
|
-
}
|
|
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
|
|
1154
|
+
*/
|
|
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)
|
|
1228
1160
|
*/
|
|
1229
|
-
|
|
1230
|
-
fromDay?: number
|
|
1231
|
-
toDay?: number
|
|
1232
|
-
fromHour?: number
|
|
1233
|
-
toHour?: number
|
|
1234
|
-
}
|
|
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,8 +1495,7 @@ 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
1501
|
* @param {string} params.e Event name
|
|
@@ -1619,7 +1505,7 @@ const emit = defineEmits<{
|
|
|
1619
1505
|
* @param {Scheduler.model.AssignmentModel[]} params.params.event.assignmentRecords The assignment records about to be deleted
|
|
1620
1506
|
* @param {object} params.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.
|
|
1621
1507
|
* @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.
|
|
1508
|
+
* @param {boolean} [params.params.event.context.finalize.removeRecords] Provide `false` to the function to prevent the removal.
|
|
1623
1509
|
*/
|
|
1624
1510
|
(e: 'beforeAssignmentDelete', params: ((event: { source: Scheduler, assignmentRecords: AssignmentModel[], context: { finalize: { removeRecords?: boolean } } }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
1625
1511
|
/**
|
|
@@ -1635,8 +1521,7 @@ const emit = defineEmits<{
|
|
|
1635
1521
|
(e: 'beforeCancelCellEdit', params: ((event: { source: Grid, editorContext: GridLocation }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
1636
1522
|
/**
|
|
1637
1523
|
* 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)
|
|
1524
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-beforeCancelRowEdit)
|
|
1640
1525
|
* @param {string} e Event name
|
|
1641
1526
|
* @param {object} params Event parameters
|
|
1642
1527
|
* @param {string} params.e Event name
|
|
@@ -1775,8 +1660,7 @@ const emit = defineEmits<{
|
|
|
1775
1660
|
* Fires before an event is removed. Can be triggered by user pressing <kbd>Delete</kbd> or <kbd>Backspace</kbd> or by the
|
|
1776
1661
|
* event editor. Return `false` to immediately veto the removal (or a `Promise` yielding `true` or `false`
|
|
1777
1662
|
* for async vetoing).
|
|
1778
|
-
* ...
|
|
1779
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-beforeEventDelete)
|
|
1663
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-beforeEventDelete)
|
|
1780
1664
|
* @param {string} e Event name
|
|
1781
1665
|
* @param {object} params Event parameters
|
|
1782
1666
|
* @param {string} params.e Event name
|
|
@@ -1786,7 +1670,7 @@ const emit = defineEmits<{
|
|
|
1786
1670
|
* @param {Scheduler.model.EventModel[]} params.params.event.eventRecords The records about to be deleted
|
|
1787
1671
|
* @param {object} params.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.
|
|
1788
1672
|
* @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.
|
|
1673
|
+
* @param {boolean} [params.params.event.context.finalize.removeRecords] Provide `false` to the function to prevent the removal.
|
|
1790
1674
|
*/
|
|
1791
1675
|
(e: 'beforeEventDelete', params: ((event: { source: Scheduler|any, eventRecords: EventModel[], context: { finalize: { removeRecords?: boolean } } }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
1792
1676
|
/**
|
|
@@ -1825,8 +1709,7 @@ const emit = defineEmits<{
|
|
|
1825
1709
|
(e: 'beforeFinishCellEdit', params: ((event: { grid: Grid, editorContext: CellEditorContext }) => void)|string): void
|
|
1826
1710
|
/**
|
|
1827
1711
|
* 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)
|
|
1712
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-beforeFinishRowEdit)
|
|
1830
1713
|
* @param {string} e Event name
|
|
1831
1714
|
* @param {object} params Event parameters
|
|
1832
1715
|
* @param {string} params.e Event name
|
|
@@ -1848,8 +1731,7 @@ const emit = defineEmits<{
|
|
|
1848
1731
|
(e: 'beforeHide', params: ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
1849
1732
|
/**
|
|
1850
1733
|
* 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)
|
|
1734
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-beforeHistogramDataCacheSet)
|
|
1853
1735
|
* @param {string} e Event name
|
|
1854
1736
|
* @param {object} params Event parameters
|
|
1855
1737
|
* @param {string} params.e Event name
|
|
@@ -1910,8 +1792,7 @@ const emit = defineEmits<{
|
|
|
1910
1792
|
(e: 'beforePresetChange', params: ((event: { source: Scheduler, startDate: Date, endDate: Date, from: ViewPreset, to: ViewPreset }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
1911
1793
|
/**
|
|
1912
1794
|
* Fires before the component renders a row.
|
|
1913
|
-
* ...
|
|
1914
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-beforeRenderHistogramRow)
|
|
1795
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-beforeRenderHistogramRow)
|
|
1915
1796
|
* @param {string} e Event name
|
|
1916
1797
|
* @param {object} params Event parameters
|
|
1917
1798
|
* @param {string} params.e Event name
|
|
@@ -1961,8 +1842,7 @@ const emit = defineEmits<{
|
|
|
1961
1842
|
(e: 'beforeRenderRows', params: ((event: { source: GridBase }) => void)|string): void
|
|
1962
1843
|
/**
|
|
1963
1844
|
* 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)
|
|
1845
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-beforeRowCollapse)
|
|
1966
1846
|
* @param {string} e Event name
|
|
1967
1847
|
* @param {object} params Event parameters
|
|
1968
1848
|
* @param {string} params.e Event name
|
|
@@ -1973,8 +1853,7 @@ const emit = defineEmits<{
|
|
|
1973
1853
|
(e: 'beforeRowCollapse', params: ((event: { record: Model }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
1974
1854
|
/**
|
|
1975
1855
|
* 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)
|
|
1856
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-beforeRowExpand)
|
|
1978
1857
|
* @param {string} e Event name
|
|
1979
1858
|
* @param {object} params Event parameters
|
|
1980
1859
|
* @param {string} params.e Event name
|
|
@@ -2094,8 +1973,7 @@ const emit = defineEmits<{
|
|
|
2094
1973
|
(e: 'cancelCellEdit', params: ((event: { source: Grid, editorContext: GridLocation, event: Event }) => void)|string): void
|
|
2095
1974
|
/**
|
|
2096
1975
|
* 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)
|
|
1976
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-catchAll)
|
|
2099
1977
|
* @param {string} e Event name
|
|
2100
1978
|
* @param {object} params Event parameters
|
|
2101
1979
|
* @param {string} params.e Event name
|
|
@@ -2153,8 +2031,7 @@ const emit = defineEmits<{
|
|
|
2153
2031
|
/**
|
|
2154
2032
|
* This event fires on the owning grid before the context menu is shown for a cell.
|
|
2155
2033
|
* 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)
|
|
2034
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-cellMenuBeforeShow)
|
|
2158
2035
|
* @param {string} e Event name
|
|
2159
2036
|
* @param {object} params Event parameters
|
|
2160
2037
|
* @param {string} params.e Event name
|
|
@@ -2422,8 +2299,7 @@ const emit = defineEmits<{
|
|
|
2422
2299
|
(e: 'currentTimelineUpdate', params: ((event: { source: Scheduler, date: Date }) => void)|string): void
|
|
2423
2300
|
/**
|
|
2424
2301
|
* Fired when data in the store changes.
|
|
2425
|
-
* ...
|
|
2426
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-dataChange)
|
|
2302
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-dataChange)
|
|
2427
2303
|
* @param {string} e Event name
|
|
2428
2304
|
* @param {object} params Event parameters
|
|
2429
2305
|
* @param {string} params.e Event name
|
|
@@ -2441,8 +2317,7 @@ const emit = defineEmits<{
|
|
|
2441
2317
|
* Fired when the range of dates encapsulated by the UI changes. This will be when
|
|
2442
2318
|
* 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
2319
|
* 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)
|
|
2320
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-dateRangeChange)
|
|
2446
2321
|
* @param {string} e Event name
|
|
2447
2322
|
* @param {object} params Event parameters
|
|
2448
2323
|
* @param {string} params.e Event name
|
|
@@ -2599,8 +2474,7 @@ const emit = defineEmits<{
|
|
|
2599
2474
|
(e: 'finishCellEdit', params: ((event: { grid: Grid, editorContext: CellEditorContext }) => void)|string): void
|
|
2600
2475
|
/**
|
|
2601
2476
|
* 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)
|
|
2477
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-finishRowEdit)
|
|
2604
2478
|
* @param {string} e Event name
|
|
2605
2479
|
* @param {object} params Event parameters
|
|
2606
2480
|
* @param {string} params.e Event name
|
|
@@ -2736,8 +2610,7 @@ const emit = defineEmits<{
|
|
|
2736
2610
|
(e: 'gridRowDrop', params: ((event: { source: GridBase, context: { valid: boolean, insertBefore: Model, parent: Model, records: Model[], oldPositionContext: RecordPositionContext[] }, event: MouseEvent }) => void)|string): void
|
|
2737
2611
|
/**
|
|
2738
2612
|
* 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)
|
|
2613
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-headerClick)
|
|
2741
2614
|
* @param {string} e Event name
|
|
2742
2615
|
* @param {object} params Event parameters
|
|
2743
2616
|
* @param {string} params.e Event name
|
|
@@ -2750,8 +2623,7 @@ const emit = defineEmits<{
|
|
|
2750
2623
|
/**
|
|
2751
2624
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
2752
2625
|
* 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)
|
|
2626
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-headerMenuBeforeShow)
|
|
2755
2627
|
* @param {string} e Event name
|
|
2756
2628
|
* @param {object} params Event parameters
|
|
2757
2629
|
* @param {string} params.e Event name
|
|
@@ -2816,8 +2688,7 @@ const emit = defineEmits<{
|
|
|
2816
2688
|
/**
|
|
2817
2689
|
* Fires after the component retrieves a record's histogram data and stores
|
|
2818
2690
|
* it into the cache.
|
|
2819
|
-
* ...
|
|
2820
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-histogramDataCacheSet)
|
|
2691
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-histogramDataCacheSet)
|
|
2821
2692
|
* @param {string} e Event name
|
|
2822
2693
|
* @param {object} params Event parameters
|
|
2823
2694
|
* @param {string} params.e Event name
|
|
@@ -2873,8 +2744,7 @@ const emit = defineEmits<{
|
|
|
2873
2744
|
/**
|
|
2874
2745
|
* Triggered when a widget which had been in a non-visible state for any reason
|
|
2875
2746
|
* achieves visibility.
|
|
2876
|
-
* ...
|
|
2877
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-paint)
|
|
2747
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-paint)
|
|
2878
2748
|
* @param {string} e Event name
|
|
2879
2749
|
* @param {object} params Event parameters
|
|
2880
2750
|
* @param {string} params.e Event name
|
|
@@ -2905,8 +2775,8 @@ const emit = defineEmits<{
|
|
|
2905
2775
|
* @param {string} params.e Event name
|
|
2906
2776
|
* @param {object} params.params Event parameters
|
|
2907
2777
|
* @param {object} params.params.event Event object
|
|
2908
|
-
* @param {Response} params.params.event.response Optional response, if received
|
|
2909
|
-
* @param {Error} params.params.event.error Optional error, if exception occurred
|
|
2778
|
+
* @param {Response} [params.params.event.response] Optional response, if received
|
|
2779
|
+
* @param {Error} [params.params.event.error] Optional error, if exception occurred
|
|
2910
2780
|
*/
|
|
2911
2781
|
(e: 'pdfExport', params: ((event: { response?: Response, error?: Error }) => void)|string): void
|
|
2912
2782
|
/**
|
|
@@ -2979,8 +2849,7 @@ const emit = defineEmits<{
|
|
|
2979
2849
|
/**
|
|
2980
2850
|
* This event fires on the owning scheduler before the context menu is shown for a resource.
|
|
2981
2851
|
* 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)
|
|
2852
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-resourceMenuBeforeShow)
|
|
2984
2853
|
* @param {string} e Event name
|
|
2985
2854
|
* @param {object} params Event parameters
|
|
2986
2855
|
* @param {string} params.e Event name
|
|
@@ -3164,8 +3033,7 @@ const emit = defineEmits<{
|
|
|
3164
3033
|
(e: 'rowCollapse', params: ((event: { record: Model }) => void)|string): void
|
|
3165
3034
|
/**
|
|
3166
3035
|
* 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)
|
|
3036
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-rowExpand)
|
|
3169
3037
|
* @param {string} e Event name
|
|
3170
3038
|
* @param {object} params Event parameters
|
|
3171
3039
|
* @param {string} params.e Event name
|
|
@@ -3363,8 +3231,7 @@ const emit = defineEmits<{
|
|
|
3363
3231
|
(e: 'subGridExpand', params: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string): void
|
|
3364
3232
|
/**
|
|
3365
3233
|
* Fired when the tick size changes.
|
|
3366
|
-
* ...
|
|
3367
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-tickSizeChange)
|
|
3234
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-tickSizeChange)
|
|
3368
3235
|
* @param {string} e Event name
|
|
3369
3236
|
* @param {object} params Event parameters
|
|
3370
3237
|
* @param {string} params.e Event name
|
|
@@ -3429,8 +3296,7 @@ const emit = defineEmits<{
|
|
|
3429
3296
|
/**
|
|
3430
3297
|
* This event fires on the owning Scheduler or Gantt widget before the context menu is shown for the time axis header.
|
|
3431
3298
|
* 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)
|
|
3299
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-timeAxisHeaderMenuBeforeShow)
|
|
3434
3300
|
* @param {string} e Event name
|
|
3435
3301
|
* @param {object} params Event parameters
|
|
3436
3302
|
* @param {string} params.e Event name
|
|
@@ -3541,7 +3407,7 @@ const emit = defineEmits<{
|
|
|
3541
3407
|
* @param {Core.data.Model} params.params.event.groupRecord [DEPRECATED] Use `groupRecords` param instead
|
|
3542
3408
|
* @param {Core.data.Model[]} params.params.event.groupRecords The group records being toggled
|
|
3543
3409
|
* @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
|
|
3410
|
+
* @param {boolean} [params.params.event.allRecords] True if this event is part of toggling all groups
|
|
3545
3411
|
*/
|
|
3546
3412
|
(e: 'toggleGroup', params: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, allRecords?: boolean }) => void)|string): void
|
|
3547
3413
|
/**
|
|
@@ -3595,8 +3461,7 @@ const emit = defineEmits<{
|
|
|
3595
3461
|
/**
|
|
3596
3462
|
* Fired when the range of dates visible within the viewport changes. This will be when
|
|
3597
3463
|
* scrolling along a time axis.
|
|
3598
|
-
* ...
|
|
3599
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-visibleDateRangeChange)
|
|
3464
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-visibleDateRangeChange)
|
|
3600
3465
|
* @param {string} e Event name
|
|
3601
3466
|
* @param {object} params Event parameters
|
|
3602
3467
|
* @param {string} params.e Event name
|
|
@@ -3611,6 +3476,18 @@ const emit = defineEmits<{
|
|
|
3611
3476
|
* @param {Date} params.params.event.new.endDate the new end date.
|
|
3612
3477
|
*/
|
|
3613
3478
|
(e: 'visibleDateRangeChange', params: ((event: { source: Scheduler, old: { startDate: Date, endDate: Date }, new: { startDate: Date, endDate: Date } }) => void)|string): void
|
|
3479
|
+
/**
|
|
3480
|
+
* Fires when the smooth zoom level changes, either through programmatic zoom methods or mouse wheel zooming.
|
|
3481
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-zoomLevelChange)
|
|
3482
|
+
* @param {string} e Event name
|
|
3483
|
+
* @param {object} params Event parameters
|
|
3484
|
+
* @param {string} params.e Event name
|
|
3485
|
+
* @param {object} params.params Event parameters
|
|
3486
|
+
* @param {object} params.params.event Event object
|
|
3487
|
+
* @param {Scheduler.view.TimelineBase} params.params.event.source
|
|
3488
|
+
* @param {number} params.params.event.zoomLevel New zoom level
|
|
3489
|
+
*/
|
|
3490
|
+
(e: 'zoomLevelChange', params: ((event: { source: TimelineBase, zoomLevel: number }) => void)|string): void
|
|
3614
3491
|
}>();
|
|
3615
3492
|
|
|
3616
3493
|
const widgetData = {
|
|
@@ -3755,6 +3632,7 @@ const widgetData = {
|
|
|
3755
3632
|
'resourceTimeRangeRenderer',
|
|
3756
3633
|
'responsiveLevels',
|
|
3757
3634
|
'ripple',
|
|
3635
|
+
'role',
|
|
3758
3636
|
'rootElement',
|
|
3759
3637
|
'scaleColumn',
|
|
3760
3638
|
'scrollerClass',
|
|
@@ -3762,6 +3640,7 @@ const widgetData = {
|
|
|
3762
3640
|
'series',
|
|
3763
3641
|
'showBarTipWhenNavigatingTimeAxis',
|
|
3764
3642
|
'showDirty',
|
|
3643
|
+
'smoothZoom',
|
|
3765
3644
|
'snapRelativeToEventStartDate',
|
|
3766
3645
|
'stateful',
|
|
3767
3646
|
'statefulEvents',
|
|
@@ -3824,6 +3703,7 @@ const widgetData = {
|
|
|
3824
3703
|
'insertFirst',
|
|
3825
3704
|
'keyMap',
|
|
3826
3705
|
'labelPosition',
|
|
3706
|
+
'labelWidth',
|
|
3827
3707
|
'longPressTime',
|
|
3828
3708
|
'margin',
|
|
3829
3709
|
'maxDate',
|
|
@@ -3990,6 +3870,7 @@ const widgetData = {
|
|
|
3990
3870
|
'onUnlockRows',
|
|
3991
3871
|
'onUnsplit',
|
|
3992
3872
|
'onVisibleDateRangeChange',
|
|
3873
|
+
'onZoomLevelChange',
|
|
3993
3874
|
'preserveScroll',
|
|
3994
3875
|
'presets',
|
|
3995
3876
|
'readOnly',
|
|
@@ -4018,11 +3899,10 @@ const widgetData = {
|
|
|
4018
3899
|
'viewPreset',
|
|
4019
3900
|
'visibleDate',
|
|
4020
3901
|
'width',
|
|
4021
|
-
'workingTime'
|
|
3902
|
+
'workingTime',
|
|
3903
|
+
'zoomFactor'
|
|
4022
3904
|
],
|
|
4023
3905
|
propertyNames : [
|
|
4024
|
-
'focusVisible',
|
|
4025
|
-
'hasChanges',
|
|
4026
3906
|
'originalStore',
|
|
4027
3907
|
'parent',
|
|
4028
3908
|
'scrollLeft',
|
|
@@ -4193,7 +4073,8 @@ const widgetData = {
|
|
|
4193
4073
|
'treeGroup',
|
|
4194
4074
|
'unlockRows',
|
|
4195
4075
|
'unsplit',
|
|
4196
|
-
'visibleDateRangeChange'
|
|
4076
|
+
'visibleDateRangeChange',
|
|
4077
|
+
'zoomLevelChange'
|
|
4197
4078
|
]
|
|
4198
4079
|
};
|
|
4199
4080
|
|