@bryntum/scheduler-vue-3-thin 7.2.4 → 7.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -8
- package/lib/chunks/{B0m0r-NV.js → BTSObfAz.js} +11 -9
- package/lib/chunks/BTSObfAz.js.map +1 -0
- package/lib/chunks/BXIuEgYD.js +265 -0
- package/lib/chunks/BXIuEgYD.js.map +1 -0
- package/lib/chunks/{DerP_qo7.js → CCTV8qn0.js} +18 -10
- package/lib/chunks/CCTV8qn0.js.map +1 -0
- package/lib/chunks/{CsoS615B.js → COFzBhB8.js} +11 -9
- package/lib/chunks/COFzBhB8.js.map +1 -0
- package/lib/chunks/{BD-Hg3lY.js → DB0UHrA3.js} +17 -24
- package/lib/chunks/DB0UHrA3.js.map +1 -0
- package/lib/chunks/{C7ZFK2B7.js → DJSlX0qP.js} +18 -10
- package/lib/chunks/DJSlX0qP.js.map +1 -0
- package/lib/chunks/{DmQj0tBi.js → DP61St-u.js} +14 -6
- package/lib/chunks/DP61St-u.js.map +1 -0
- package/lib/chunks/{mKqb8_2f.js → LNqNYJck.js} +9 -7
- package/lib/chunks/LNqNYJck.js.map +1 -0
- package/lib/chunks/{CP1Mm_Ak.js → R69sJLmF.js} +16 -17
- package/lib/chunks/R69sJLmF.js.map +1 -0
- package/lib/chunks/{BNGLBrCN.js → WykRcMCN.js} +7 -5
- package/lib/chunks/WykRcMCN.js.map +1 -0
- package/lib/chunks/{C0UqC4Uj.js → eUISgYXE.js} +9 -9
- package/lib/chunks/eUISgYXE.js.map +1 -0
- package/lib/chunks/{C2PT-Ukt.js → t8aiH3XL.js} +13 -14
- package/lib/chunks/t8aiH3XL.js.map +1 -0
- package/lib/components/BryntumEventColorField.js +1 -1
- package/lib/components/BryntumProjectCombo.js +1 -1
- package/lib/components/BryntumResourceCombo.js +1 -1
- package/lib/components/BryntumResourceFilter.js +1 -1
- package/lib/components/BryntumScheduler.js +1 -1
- package/lib/components/BryntumSchedulerBase.js +1 -1
- package/lib/components/BryntumSchedulerDatePicker.js +1 -1
- package/lib/components/BryntumSchedulerProjectModel.js +1 -1
- package/lib/components/BryntumThemeCombo.js +57 -0
- package/lib/components/BryntumThemeCombo.js.map +1 -0
- package/lib/components/BryntumTimeZoomSlider.js +5 -0
- package/lib/components/BryntumTimeZoomSlider.js.map +1 -0
- package/lib/components/BryntumTimelineHistogram.js +1 -1
- package/lib/components/BryntumUndoRedo.js +1 -1
- package/lib/components/BryntumViewPresetCombo.js +1 -1
- package/lib/index.js +18 -16
- package/lib/index.js.map +1 -1
- package/package.json +1 -1
- package/src/components/BryntumEventColorField.vue +152 -222
- package/src/components/BryntumEventColorFieldProps.ts +77 -108
- package/src/components/BryntumProjectCombo.vue +171 -258
- package/src/components/BryntumProjectComboProps.ts +95 -141
- package/src/components/BryntumResourceCombo.vue +172 -260
- package/src/components/BryntumResourceComboProps.ts +96 -143
- package/src/components/BryntumResourceFilter.vue +132 -211
- package/src/components/BryntumResourceFilterProps.ts +60 -98
- package/src/components/BryntumScheduler.vue +1847 -2520
- package/src/components/BryntumSchedulerBase.vue +1847 -2520
- package/src/components/BryntumSchedulerBaseProps.ts +372 -522
- package/src/components/BryntumSchedulerDatePicker.vue +205 -331
- package/src/components/BryntumSchedulerDatePickerProps.ts +116 -187
- package/src/components/BryntumSchedulerProjectModel.vue +23 -46
- package/src/components/BryntumSchedulerProjectModelProps.ts +10 -20
- package/src/components/BryntumSchedulerProps.ts +372 -522
- package/src/components/BryntumThemeCombo.vue +60 -0
- package/src/components/BryntumTimeZoomSlider.vue +829 -0
- package/src/components/BryntumTimeZoomSliderProps.ts +482 -0
- package/src/components/BryntumTimelineHistogram.vue +1034 -1461
- package/src/components/BryntumTimelineHistogramProps.ts +275 -388
- package/src/components/BryntumUndoRedo.vue +127 -204
- package/src/components/BryntumUndoRedoProps.ts +74 -116
- package/src/components/BryntumViewPresetCombo.vue +144 -210
- package/src/components/BryntumViewPresetComboProps.ts +72 -99
- package/src/index.ts +2 -0
- package/lib/chunks/B0m0r-NV.js.map +0 -1
- package/lib/chunks/BD-Hg3lY.js.map +0 -1
- package/lib/chunks/BNGLBrCN.js.map +0 -1
- package/lib/chunks/C0UqC4Uj.js.map +0 -1
- package/lib/chunks/C2PT-Ukt.js.map +0 -1
- package/lib/chunks/C7ZFK2B7.js.map +0 -1
- package/lib/chunks/CP1Mm_Ak.js.map +0 -1
- package/lib/chunks/CsoS615B.js.map +0 -1
- package/lib/chunks/DerP_qo7.js.map +0 -1
- package/lib/chunks/DmQj0tBi.js.map +0 -1
- package/lib/chunks/mKqb8_2f.js.map +0 -1
|
@@ -1,14 +1,13 @@
|
|
|
1
|
-
import type { AjaxStore, AjaxStoreConfig, Color, DomClassList, DomConfig, DurationConfig, DurationUnit, FormulaProviderConfig, KeyMapConfig, Mask, MaskConfig, MenuConfig, Model, ModelConfig, PagingToolbarConfig, PanelCollapserConfig, PanelCollapserOverlayConfig, PanelHeader, ScrollManager, ScrollManagerConfig, Scroller, ScrollerConfig, StateProvider, Store, StoreConfig, TabConfig, ToolConfig, ToolbarConfig, ToolbarItems, TooltipConfig, Widget } from '@bryntum/core-thin';
|
|
1
|
+
import type { AjaxStore, AjaxStoreConfig, Color, DomClassList, DomConfig, DurationConfig, DurationUnit, FormulaProviderConfig, InstancePlugin, KeyMapConfig, Mask, MaskConfig, MenuConfig, Model, ModelConfig, PagingToolbarConfig, PanelCollapserConfig, PanelCollapserOverlayConfig, PanelHeader, ScrollManager, ScrollManagerConfig, Scroller, ScrollerConfig, StateProvider, Store, StoreConfig, TabConfig, ToolConfig, ToolbarConfig, ToolbarItems, TooltipConfig, Widget } from '@bryntum/core-thin';
|
|
2
2
|
import type { AIFilter, AIFilterConfig, CellCopyPaste, CellCopyPasteConfig, CellEdit, CellEditConfig, CellMenu, CellMenuConfig, CellTooltip, CellTooltipConfig, Charts, ChartsConfig, ColumnAutoWidth, ColumnAutoWidthConfig, ColumnDragToolbar, ColumnDragToolbarConfig, ColumnPicker, ColumnPickerConfig, ColumnRename, ColumnRenameConfig, ColumnReorder, ColumnReorderConfig, ColumnResize, ColumnResizeConfig, ColumnStore, ColumnStoreConfig, EmptyTextDomConfig, FileDrop, FileDropConfig, FillHandle, FillHandleConfig, Filter, FilterBar, FilterBarConfig, FilterConfig, GridSelectionMode, Group, GroupConfig, HeaderMenu, HeaderMenuConfig, MergeCells, MergeCellsConfig, PinColumns, PinColumnsConfig, PreserveScrollOptions, QuickFind, QuickFindConfig, RegionResize, RegionResizeConfig, RowCopyPaste, RowCopyPasteConfig, RowEdit, RowEditConfig, RowExpander, RowExpanderConfig, Search, SearchConfig, Sort, SortConfig, StickyCells, StickyCellsConfig, Stripe, StripeConfig, SubGridConfig, Tree, TreeConfig, TreeGroup, TreeGroupConfig } from '@bryntum/grid-thin';
|
|
3
|
-
import type { AI, AIConfig, AssignmentModel, AssignmentModelConfig, AssignmentStore, AssignmentStoreConfig, ColumnLines, ColumnLinesConfig, SchedulerContainerItemConfig, CrudManager, CrudManagerConfig, DateConstraint, Dependencies, DependenciesConfig, DependencyBaseModel, DependencyEdit, DependencyEditConfig, DependencyMenu, DependencyMenuConfig, DependencyModel, DependencyModelConfig, DependencyStore, DependencyStoreConfig, EventColor, EventCopyPaste, EventCopyPasteConfig, EventDrag, EventDragConfig, EventDragCreate, EventDragCreateConfig, EventDragSelect, EventDragSelectConfig, EventEdit, EventEditConfig, EventFilter, EventFilterConfig, EventMenu, EventMenuConfig, EventModel, EventModelConfig, EventNonWorkingTime, EventNonWorkingTimeConfig, EventResize, EventResizeConfig, EventStore, EventStoreConfig, EventTooltip, EventTooltipConfig, ExcelExporter, ExcelExporterConfig, SchedulerColumnConfig, GroupSummary, GroupSummaryConfig, HeaderZoom, HeaderZoomConfig, Labels, LabelsConfig, LockRows, LockRowsConfig, NonWorkingTime, NonWorkingTimeConfig, Pan, PanConfig, PdfExport, PdfExportConfig, Print, PrintConfig, ProjectModel, ProjectModelConfig,
|
|
3
|
+
import type { AI, AIConfig, AssignmentModel, AssignmentModelConfig, AssignmentStore, AssignmentStoreConfig, ColumnLines, ColumnLinesConfig, SchedulerContainerItemConfig, CrudManager, CrudManagerConfig, DateConstraint, Dependencies, DependenciesConfig, DependencyBaseModel, DependencyEdit, DependencyEditConfig, DependencyMenu, DependencyMenuConfig, DependencyModel, DependencyModelConfig, DependencyStore, DependencyStoreConfig, EventColor, EventCopyPaste, EventCopyPasteConfig, EventDrag, EventDragConfig, EventDragCreate, EventDragCreateConfig, EventDragSelect, EventDragSelectConfig, EventEdit, EventEditConfig, EventFilter, EventFilterConfig, EventMenu, EventMenuConfig, EventModel, EventModelConfig, EventNonWorkingTime, EventNonWorkingTimeConfig, EventResize, EventResizeConfig, EventStore, EventStoreConfig, EventTooltip, EventTooltipConfig, ExcelExporter, ExcelExporterConfig, SchedulerColumnConfig, GroupSummary, GroupSummaryConfig, HeaderZoom, HeaderZoomConfig, Labels, LabelsConfig, LockRows, LockRowsConfig, NonWorkingTime, NonWorkingTimeConfig, Pan, PanConfig, PdfExport, PdfExportConfig, Print, PrintConfig, ProjectModel, ProjectModelConfig, RecurrenceConfirmationPopupConfig, ResourceColumnReorder, ResourceColumnReorderConfig, ResourceHeaderConfig, ResourceMarginConfig, ResourceMenu, ResourceMenuConfig, ResourceModel, ResourceModelConfig, ResourceStore, ResourceStoreConfig, ResourceTimeRangeModel, ResourceTimeRangeModelConfig, ResourceTimeRangeStore, ResourceTimeRangeStoreConfig, ResourceTimeRanges, ResourceTimeRangesConfig, RowReorder, RowReorderConfig, RowResize, RowResizeConfig, ScheduleContext, ScheduleContextConfig, ScheduleMenu, ScheduleMenuConfig, ScheduleTooltip, ScheduleTooltipConfig, Scheduler, SchedulerListeners, SchedulerResponsiveLevelConfig, ScrollButtons, ScrollButtonsConfig, SimpleEventEdit, SimpleEventEditConfig, Split, SplitConfig, StickyEvents, StickyEventsConfig, Summary, SummaryConfig, TimeAxis, TimeAxisConfig, TimeAxisHeaderMenu, TimeAxisHeaderMenuConfig, TimeRanges, TimeRangesConfig, TimeSelection, TimeSelectionConfig, TimeSpan, TimeSpanConfig, TimelineBase, TreeSummary, TreeSummaryConfig, VerticalTimeAxisColumnConfig, ViewPresetConfig, VisibleDate } from '@bryntum/scheduler-thin';
|
|
4
4
|
|
|
5
5
|
export declare type BryntumSchedulerProps = {
|
|
6
6
|
// Configs
|
|
7
7
|
/**
|
|
8
8
|
* Element (or element id) to adopt as this Widget's encapsulating element. The widget's
|
|
9
9
|
* content will be placed inside this element.
|
|
10
|
-
* ...
|
|
11
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-adopt)
|
|
10
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-adopt)
|
|
12
11
|
*/
|
|
13
12
|
adopt ? : HTMLElement|string
|
|
14
13
|
/**
|
|
@@ -35,8 +34,7 @@ export declare type BryntumSchedulerProps = {
|
|
|
35
34
|
allowDropOnEventBar ? : Boolean
|
|
36
35
|
/**
|
|
37
36
|
* Set to `false` if you don't want to allow events overlapping times for any one resource (defaults to `true`).
|
|
38
|
-
* ...
|
|
39
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-allowOverlap)
|
|
37
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-allowOverlap)
|
|
40
38
|
*/
|
|
41
39
|
allowOverlap ? : Boolean
|
|
42
40
|
/**
|
|
@@ -65,15 +63,13 @@ export declare type BryntumSchedulerProps = {
|
|
|
65
63
|
/**
|
|
66
64
|
* A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject
|
|
67
65
|
* into an element which will be linked using the `aria-describedby` attribute.
|
|
68
|
-
* ...
|
|
69
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-ariaDescription)
|
|
66
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-ariaDescription)
|
|
70
67
|
*/
|
|
71
68
|
ariaDescription ? : string
|
|
72
69
|
/**
|
|
73
70
|
* A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject as
|
|
74
71
|
* the `aria-label` attribute.
|
|
75
|
-
* ...
|
|
76
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-ariaLabel)
|
|
72
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-ariaLabel)
|
|
77
73
|
*/
|
|
78
74
|
ariaLabel ? : string
|
|
79
75
|
/**
|
|
@@ -93,16 +89,15 @@ export declare type BryntumSchedulerProps = {
|
|
|
93
89
|
/**
|
|
94
90
|
* If this config is set, then its `gesture` property (which defaults to `dblclick`) creates a
|
|
95
91
|
* new event at the mouse or touch event's time point.
|
|
96
|
-
* ...
|
|
97
|
-
* [
|
|
98
|
-
* @param {
|
|
99
|
-
* @param {
|
|
100
|
-
* @param {
|
|
101
|
-
* @param {DurationConfig,string} autoCreate.
|
|
102
|
-
* @param {
|
|
103
|
-
* @param {string} autoCreate.name The name of the event to create. Defaults to the `Object.newEvent` property from the locale.
|
|
92
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-autoCreate)
|
|
93
|
+
* @param {'click','dblclick'} [autoCreate.gesture] The gesture to trigger auto creation of an event. Defaults to `dblclick`.
|
|
94
|
+
* @param {boolean} [autoCreate.useEventModelDefaults] Set to `true` to set default duration based on the defaults specified by the [duration](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/EventModel#field-duration) and [durationUnit](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/EventModel#field-durationUnit) fields.
|
|
95
|
+
* @param {'round','ceil','floor'} [autoCreate.snapType] The type of snapping to apply to the event start date. If omitted, the date will be floored to the time axis resolution.
|
|
96
|
+
* @param {DurationConfig,string} [autoCreate.step] The increment to snap the event start date to.
|
|
97
|
+
* @param {DurationConfig,string} [autoCreate.duration] The duration of the event to create. Defaults to 1 time axis tick.
|
|
98
|
+
* @param {string} [autoCreate.name] The name of the event to create. Defaults to the `Object.newEvent` property from the locale.
|
|
104
99
|
*/
|
|
105
|
-
autoCreate ? : Boolean|string|
|
|
100
|
+
autoCreate ? : Boolean|string|object
|
|
106
101
|
/**
|
|
107
102
|
* Automatically set grids height to fit all rows (no scrolling in the grid). In general you should avoid
|
|
108
103
|
* using `autoHeight: true`, since it will bypass Grids virtual rendering and render all rows at once, which
|
|
@@ -111,21 +106,18 @@ export declare type BryntumSchedulerProps = {
|
|
|
111
106
|
autoHeight ? : Boolean
|
|
112
107
|
/**
|
|
113
108
|
* Controls how much space to leave between stacked event bars in px.
|
|
114
|
-
* ...
|
|
115
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-barMargin)
|
|
109
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-barMargin)
|
|
116
110
|
*/
|
|
117
111
|
barMargin ? : number
|
|
118
112
|
/**
|
|
119
113
|
* A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/scheduler/docs/api/Core/widget/Toolbar),
|
|
120
114
|
* 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).
|
|
121
|
-
* ...
|
|
122
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-bbar)
|
|
115
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-bbar)
|
|
123
116
|
*/
|
|
124
117
|
bbar ? : (SchedulerContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
|
|
125
118
|
/**
|
|
126
119
|
* Custom CSS classes to add to the panel's body element.
|
|
127
|
-
* ...
|
|
128
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-bodyCls)
|
|
120
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-bodyCls)
|
|
129
121
|
*/
|
|
130
122
|
bodyCls ? : string|object
|
|
131
123
|
/**
|
|
@@ -135,35 +127,30 @@ export declare type BryntumSchedulerProps = {
|
|
|
135
127
|
/**
|
|
136
128
|
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
137
129
|
* hierarchy when triggered.
|
|
138
|
-
* ...
|
|
139
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-bubbleEvents)
|
|
130
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-bubbleEvents)
|
|
140
131
|
*/
|
|
141
132
|
bubbleEvents ? : object
|
|
142
133
|
/**
|
|
143
134
|
* 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`.
|
|
144
|
-
* ...
|
|
145
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-bufferCoef)
|
|
135
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-bufferCoef)
|
|
146
136
|
*/
|
|
147
137
|
bufferCoef ? : number
|
|
148
138
|
/**
|
|
149
139
|
* This config defines the scroll limit, which, when exceeded will cause a timespan shift.
|
|
150
140
|
* 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
|
|
151
141
|
* has less than that of the rendered content - a shift is triggered.
|
|
152
|
-
* ...
|
|
153
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-bufferThreshold)
|
|
142
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-bufferThreshold)
|
|
154
143
|
*/
|
|
155
144
|
bufferThreshold ? : number
|
|
156
145
|
/**
|
|
157
146
|
* Set to `false` to not call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
|
|
158
|
-
* ...
|
|
159
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-callOnFunctions)
|
|
147
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-callOnFunctions)
|
|
160
148
|
*/
|
|
161
149
|
callOnFunctions ? : Boolean
|
|
162
150
|
/**
|
|
163
151
|
* By default, if an event handler throws an exception, the error propagates up the stack and the
|
|
164
152
|
* application state is undefined. Code which follows the event handler will *not* be executed.
|
|
165
|
-
* ...
|
|
166
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-catchEventHandlerExceptions)
|
|
153
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-catchEventHandlerExceptions)
|
|
167
154
|
*/
|
|
168
155
|
catchEventHandlerExceptions ? : Boolean
|
|
169
156
|
/**
|
|
@@ -176,8 +163,7 @@ export declare type BryntumSchedulerProps = {
|
|
|
176
163
|
* Custom CSS classes to add to element.
|
|
177
164
|
* May be specified as a space separated string, or as an object in which property names
|
|
178
165
|
* with truthy values are used as the class names:
|
|
179
|
-
* ...
|
|
180
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-cls)
|
|
166
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-cls)
|
|
181
167
|
*/
|
|
182
168
|
cls ? : string|object
|
|
183
169
|
/**
|
|
@@ -187,15 +173,13 @@ export declare type BryntumSchedulerProps = {
|
|
|
187
173
|
collapsed ? : Boolean
|
|
188
174
|
/**
|
|
189
175
|
* This config enables collapsibility for the panel. See [collapsed](https://bryntum.com/products/scheduler/docs/api/Core/widget/Panel#config-collapsed).
|
|
190
|
-
* ...
|
|
191
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-collapsible)
|
|
176
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-collapsible)
|
|
192
177
|
*/
|
|
193
178
|
collapsible ? : Boolean|PanelCollapserConfig|PanelCollapserOverlayConfig
|
|
194
179
|
/**
|
|
195
180
|
* Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
|
|
196
181
|
* `style` block.
|
|
197
|
-
* ...
|
|
198
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-color)
|
|
182
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-color)
|
|
199
183
|
*/
|
|
200
184
|
color ? : Color
|
|
201
185
|
/**
|
|
@@ -209,8 +193,7 @@ export declare type BryntumSchedulerProps = {
|
|
|
209
193
|
/**
|
|
210
194
|
* Accepts column definitions for the grid during initialization. They will be used to create
|
|
211
195
|
* [Column](https://bryntum.com/products/scheduler/docs/api/Grid/column/Column) instances that are added to a [ColumnStore](#Grid/data/ColumnStore).
|
|
212
|
-
* ...
|
|
213
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-columns)
|
|
196
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-columns)
|
|
214
197
|
*/
|
|
215
198
|
columns ? : ColumnStore|SchedulerColumnConfig[]|ColumnStoreConfig
|
|
216
199
|
config ? : object
|
|
@@ -218,8 +201,7 @@ export declare type BryntumSchedulerProps = {
|
|
|
218
201
|
* Custom CSS classes to add to the [contentElement](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-contentElement).
|
|
219
202
|
* May be specified as a space separated string, or as an object in which property names
|
|
220
203
|
* with truthy values are used as the class names:
|
|
221
|
-
* ...
|
|
222
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-contentElementCls)
|
|
204
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-contentElementCls)
|
|
223
205
|
*/
|
|
224
206
|
contentElementCls ? : string|object
|
|
225
207
|
/**
|
|
@@ -257,8 +239,7 @@ export declare type BryntumSchedulerProps = {
|
|
|
257
239
|
* Convenient shortcut to set data in grids store both during initialization and at runtime. Can also be
|
|
258
240
|
* used to retrieve data at runtime, although we do recommend interacting with Grids store instead using
|
|
259
241
|
* the [store](https://bryntum.com/products/scheduler/docs/api/Grid/view/GridBase#property-store) property.
|
|
260
|
-
* ...
|
|
261
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-data)
|
|
242
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-data)
|
|
262
243
|
*/
|
|
263
244
|
data ? : object[]|Model[]|ModelConfig[]
|
|
264
245
|
/**
|
|
@@ -272,8 +253,7 @@ export declare type BryntumSchedulerProps = {
|
|
|
272
253
|
dataset ? : Record<string, string>
|
|
273
254
|
/**
|
|
274
255
|
* The date to display when used as a component of a Calendar.
|
|
275
|
-
* ...
|
|
276
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-date)
|
|
256
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-date)
|
|
277
257
|
*/
|
|
278
258
|
date ? : Date
|
|
279
259
|
/**
|
|
@@ -307,17 +287,15 @@ export declare type BryntumSchedulerProps = {
|
|
|
307
287
|
* The date format used by the default [descriptionRenderer](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/Describable#config-descriptionRenderer) for rendering the view's description.
|
|
308
288
|
* If this value is `null`, the [dateFormat](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/Describable#config-dateFormat) (and potentially [dateSeparator](#Scheduler/view/mixin/Describable#config-dateSeparator)) will
|
|
309
289
|
* be used.
|
|
310
|
-
* ...
|
|
311
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-descriptionFormat)
|
|
290
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-descriptionFormat)
|
|
312
291
|
* @param {Date} date The date to format.
|
|
313
292
|
* @returns {string} The formatted date.
|
|
314
293
|
*/
|
|
315
|
-
descriptionFormat ? : string|string[]|Boolean[]|((date: Date) => string)|
|
|
294
|
+
descriptionFormat ? : string|string[]|Boolean[]|((date: Date) => string)|(((date: Date) => string)[])
|
|
316
295
|
/**
|
|
317
296
|
* A function that provides the textual description for this view. If provided, this function overrides the
|
|
318
297
|
* [descriptionFormat](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/Describable#config-descriptionFormat).
|
|
319
|
-
* ...
|
|
320
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-descriptionRenderer)
|
|
298
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-descriptionRenderer)
|
|
321
299
|
* @param {Core.widget.Widget} view The active view in case the function is in another scope.
|
|
322
300
|
* @returns {string} Description string
|
|
323
301
|
*/
|
|
@@ -339,16 +317,15 @@ export declare type BryntumSchedulerProps = {
|
|
|
339
317
|
*/
|
|
340
318
|
destroyStores ? : Boolean
|
|
341
319
|
/**
|
|
342
|
-
* Check for CSS compatibility issues
|
|
343
|
-
*
|
|
344
|
-
* [
|
|
320
|
+
* Check for CSS compatibility and inclusion related issues and try to auto fix them. Performs the following
|
|
321
|
+
* checks:
|
|
322
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-detectCSSCompatibilityIssues)
|
|
345
323
|
*/
|
|
346
324
|
detectCSSCompatibilityIssues ? : Boolean
|
|
347
325
|
/**
|
|
348
326
|
* 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
|
|
349
327
|
* cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
|
|
350
|
-
* ...
|
|
351
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-disabled)
|
|
328
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-disabled)
|
|
352
329
|
*/
|
|
353
330
|
disabled ? : Boolean|'inert'
|
|
354
331
|
/**
|
|
@@ -366,8 +343,7 @@ export declare type BryntumSchedulerProps = {
|
|
|
366
343
|
/**
|
|
367
344
|
* Defines how dates will be formatted in tooltips etc. This config has priority over similar config on the
|
|
368
345
|
* view preset. For allowed values see [format](https://bryntum.com/products/scheduler/docs/api/Core/helper/DateHelper#function-format-static).
|
|
369
|
-
* ...
|
|
370
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-displayDateFormat)
|
|
346
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-displayDateFormat)
|
|
371
347
|
*/
|
|
372
348
|
displayDateFormat ? : string
|
|
373
349
|
/**
|
|
@@ -375,24 +351,22 @@ export declare type BryntumSchedulerProps = {
|
|
|
375
351
|
* [strips collection](https://bryntum.com/products/scheduler/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
|
|
376
352
|
* `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
|
|
377
353
|
* body. Such widgets are called "edge strips".
|
|
378
|
-
* ...
|
|
379
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-dock)
|
|
354
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-dock)
|
|
380
355
|
*/
|
|
381
356
|
dock ? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
382
357
|
/**
|
|
383
358
|
* Make this Panel a docked drawer which slides out from one side of the browser viewport by default.
|
|
384
|
-
* ...
|
|
385
|
-
* [
|
|
386
|
-
* @param {
|
|
387
|
-
* @param {
|
|
388
|
-
* @param {boolean}
|
|
389
|
-
* @param {boolean,
|
|
390
|
-
* @param {boolean,string} autoClose.
|
|
391
|
-
* @param {
|
|
392
|
-
* @param {
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
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}
|
|
359
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-drawer)
|
|
360
|
+
* @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.
|
|
361
|
+
* @param {string,number} [size] The size of the drawer in its collapsible axis.
|
|
362
|
+
* @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.
|
|
363
|
+
* @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.
|
|
364
|
+
* @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.
|
|
365
|
+
* @param {boolean,string} [autoClose.focusout] If focus moves outside of the drawer, the drawer will automatically be hidden.
|
|
366
|
+
* @param {string} [autoClose.mouseout] Hides the drawer when the mouse leaves the drawer after the `autoCloseDelay` period.
|
|
367
|
+
* @param {number} [autoCloseDelay] When using `mouseout`, this is the delay in milliseconds
|
|
368
|
+
*/
|
|
369
|
+
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 }
|
|
396
370
|
/**
|
|
397
371
|
* Decimal precision used when displaying durations, used by tooltips and DurationColumn.
|
|
398
372
|
* Specify `false` to use raw value
|
|
@@ -401,16 +375,14 @@ export declare type BryntumSchedulerProps = {
|
|
|
401
375
|
/**
|
|
402
376
|
* An object specifying attributes to assign to the root element of this widget.
|
|
403
377
|
* Set `null` value to attribute to remove it.
|
|
404
|
-
* ...
|
|
405
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-elementAttributes)
|
|
378
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-elementAttributes)
|
|
406
379
|
*/
|
|
407
380
|
elementAttributes ? : Record<string, string|null>
|
|
408
381
|
/**
|
|
409
382
|
* 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.
|
|
410
383
|
* When using multiple Grid regions, provide the `region` property to decide where the text is shown.
|
|
411
384
|
* By default, it is shown in the first region.
|
|
412
|
-
* ...
|
|
413
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-emptyText)
|
|
385
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-emptyText)
|
|
414
386
|
*/
|
|
415
387
|
emptyText ? : string|EmptyTextDomConfig
|
|
416
388
|
/**
|
|
@@ -426,16 +398,14 @@ export declare type BryntumSchedulerProps = {
|
|
|
426
398
|
* Enables showing occurrences of recurring events across the scheduler's time axis. If you want to disable
|
|
427
399
|
* the recurrence popup, you can choose set the `defaultAction` to `future` to affect all future
|
|
428
400
|
* occurrences, or `single` to just affect the currently selected event.
|
|
429
|
-
* ...
|
|
430
|
-
*
|
|
401
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-enableRecurringEvents)
|
|
402
|
+
* @property {'single','future'} defaultAction
|
|
431
403
|
*/
|
|
432
|
-
enableRecurringEvents ? : Boolean|
|
|
433
|
-
defaultAction?: 'single'|'future'
|
|
434
|
-
}
|
|
404
|
+
enableRecurringEvents ? : Boolean|object
|
|
435
405
|
/**
|
|
436
|
-
*
|
|
437
|
-
*
|
|
438
|
-
*
|
|
406
|
+
* Set to `true` to enable the [StickyCells](https://bryntum.com/products/scheduler/docs/api/Grid/feature/StickyCells) feature, which pins cell
|
|
407
|
+
* content to the top of the grid while rows scroll off the top but remain visible.
|
|
408
|
+
* @deprecated 7.3.0 Use `features : { stickyCells : true }` instead
|
|
439
409
|
*/
|
|
440
410
|
enableSticky ? : Boolean
|
|
441
411
|
/**
|
|
@@ -457,8 +427,7 @@ export declare type BryntumSchedulerProps = {
|
|
|
457
427
|
enableUndoRedoKeys ? : Boolean
|
|
458
428
|
/**
|
|
459
429
|
* The end date of the timeline (if not configure with [infiniteScroll](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineBase#config-infiniteScroll)).
|
|
460
|
-
* ...
|
|
461
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-endDate)
|
|
430
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-endDate)
|
|
462
431
|
*/
|
|
463
432
|
endDate ? : Date|string
|
|
464
433
|
/**
|
|
@@ -472,22 +441,18 @@ export declare type BryntumSchedulerProps = {
|
|
|
472
441
|
/**
|
|
473
442
|
* Event color used by default. Events and resources can specify their own color, with priority order being:
|
|
474
443
|
* Event -> Resource -> Scheduler default.
|
|
475
|
-
* ...
|
|
476
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-eventColor)
|
|
444
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-eventColor)
|
|
477
445
|
*/
|
|
478
446
|
eventColor ? : EventColor
|
|
479
447
|
/**
|
|
480
448
|
* Defines how to handle overlapping events. Valid values are:
|
|
481
|
-
* ...
|
|
482
|
-
*
|
|
449
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-eventLayout)
|
|
450
|
+
* @property {'stack','pack','mixed','none'} eventLayout.type
|
|
483
451
|
*/
|
|
484
|
-
eventLayout ? : 'stack'|'pack'|'mixed'|'none'|{
|
|
485
|
-
type?: 'stack'|'pack'|'mixed'|'none'
|
|
486
|
-
}
|
|
452
|
+
eventLayout ? : 'stack'|'pack'|'mixed'|'none'|{ type: 'stack'|'pack'|'mixed'|'none' }
|
|
487
453
|
/**
|
|
488
454
|
* An advanced setting that controls the maximum number of released event bars to keep in the DOM.
|
|
489
|
-
* ...
|
|
490
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-eventReleaseThreshold)
|
|
455
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-eventReleaseThreshold)
|
|
491
456
|
*/
|
|
492
457
|
eventReleaseThreshold ? : number
|
|
493
458
|
/**
|
|
@@ -495,30 +460,31 @@ export declare type BryntumSchedulerProps = {
|
|
|
495
460
|
* an event is rendered into the schedule to render the contents of the event. It's called with the event,
|
|
496
461
|
* its resource and a `renderData` object which allows you to populate data placeholders inside the event
|
|
497
462
|
* template.
|
|
498
|
-
* ...
|
|
499
|
-
*
|
|
500
|
-
* @param {
|
|
501
|
-
* @param {Scheduler.model.
|
|
502
|
-
* @param {Scheduler.model.
|
|
503
|
-
* @param {Scheduler.
|
|
504
|
-
* @param {
|
|
505
|
-
* @param {
|
|
506
|
-
* @param {
|
|
507
|
-
* @param {
|
|
508
|
-
* @param {Core.helper.util.DomClassList,string}
|
|
509
|
-
* @param {Core.helper.util.DomClassList,string}
|
|
510
|
-
* @param {
|
|
511
|
-
* @param {number}
|
|
512
|
-
* @param {number}
|
|
513
|
-
* @param {
|
|
514
|
-
* @param {string,Record<string, string>}
|
|
515
|
-
* @param {
|
|
516
|
-
* @param {
|
|
517
|
-
* @param {string}
|
|
518
|
-
* @param {
|
|
463
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-eventRenderer)
|
|
464
|
+
* @param {object} context An object containing the information needed to render an Event
|
|
465
|
+
* @param {Scheduler.model.EventModel} context.eventRecord The event record
|
|
466
|
+
* @param {Scheduler.model.ResourceModel} context.resourceRecord The resource record
|
|
467
|
+
* @param {Scheduler.model.AssignmentModel} context.assignmentRecord The assignment record
|
|
468
|
+
* @param {Scheduler.view.Scheduler} context.scheduler The Scheduler instance
|
|
469
|
+
* @param {object} context.renderData An object containing details about the event rendering
|
|
470
|
+
* @param {Date} context.renderData.start The start date of the event, reflecting any ongoing resize or drag operation. Use this instead of `eventRecord.startDate` to get the correct visual dates during interactions
|
|
471
|
+
* @param {Date} context.renderData.end The end date of the event, reflecting any ongoing resize or drag operation. Use this instead of `eventRecord.endDate` to get the correct visual dates during interactions
|
|
472
|
+
* @param {Scheduler.model.EventModel} context.renderData.event The event record
|
|
473
|
+
* @param {Core.helper.util.DomClassList,string} context.renderData.cls An object whose property names represent the CSS class names to be added to the event bar element. Set a property's value to truthy or falsy to add or remove the class name based on the property name. Using this technique, you do not have to know whether the class is already there, or deal with concatenation
|
|
474
|
+
* @param {Core.helper.util.DomClassList,string} context.renderData.wrapperCls An object whose property names represent the CSS class names to be added to the event wrapper element. Set a property's value to truthy or falsy to add or remove the class name based on the property name. Using this technique, you do not have to know whether the class is already there, or deal with concatenation.
|
|
475
|
+
* @param {Core.helper.util.DomClassList,string} context.renderData.iconCls An object whose property names represent the CSS class names to be added to an event icon element. Note that an element carrying this icon class is injected into the event element *after* the renderer completes, *before* the renderer's created content. To disable this if the renderer takes full control and creates content using the iconCls, you can set `renderData.iconCls = null`
|
|
476
|
+
* @param {number} context.renderData.left Vertical offset position (in pixels) on the time axis
|
|
477
|
+
* @param {number} context.renderData.width Width in pixels of the event element
|
|
478
|
+
* @param {number} context.renderData.height Height in pixels of the event element
|
|
479
|
+
* @param {string,Record<string, string>} context.renderData.style Inline styles for the event bar DOM element Use either `'border: 1px solid black'` or `{ border: '1px solid black' }`
|
|
480
|
+
* @param {string,Record<string, string>} context.renderData.wrapperStyle Inline styles for wrapper of the event bar DOM element. Use either `'border: 1px solid green'` or `{ border: '1px solid green' }`
|
|
481
|
+
* @param {'tonal','filled','bordered','traced','outlined','indented','line','dashed','minimal','rounded','calendar','interday','gantt',null} context.renderData.eventStyle The `eventStyle` of the event. Use this to apply custom styles to the event DOM element
|
|
482
|
+
* @param {string} context.renderData.eventColor The `eventColor` of the event. Use this to set a custom color for the rendered event
|
|
483
|
+
* @param {string} context.renderData.ariaLabel A description of the event details used for screen readers
|
|
484
|
+
* @param {DomConfig[]} context.renderData.children An array of DOM configs used as children to the `b-sch-event` element. Can be populated with additional DOM configs to have more control over contents. <h3>Using JSX (React)</h3> When using the Bryntum React wrapper, the event renderer can return JSX elements: ```javascript eventRenderer({ eventRecord, resourceRecord, renderData }) { return <MyEventComponent event={eventRecord} resource={resourceRecord} />; } ``` *Using JSX in the event renderer creates a React portal for each rendered event. For schedulers with many visible events or frequently re-rendered views, this may impact scrolling performance compared to returning plain strings or [DomConfig](https://bryntum.com/products/scheduler/docs/api/Core/helper/DomHelper#typedef-DomConfig) objects. Consider using JSX primarily for events that require complex interactive React components.*
|
|
519
485
|
* @returns {string,DomConfig,DomConfig[]} A simple string, a DomConfig (or array thereof), or a JSX element when using React
|
|
520
486
|
*/
|
|
521
|
-
eventRenderer ? : (
|
|
487
|
+
eventRenderer ? : (context: { eventRecord: EventModel, resourceRecord: ResourceModel, assignmentRecord: AssignmentModel, scheduler: Scheduler, renderData: { start: Date, end: Date, event: EventModel, cls: DomClassList|string, wrapperCls: DomClassList|string, iconCls: DomClassList|string, left: number, width: number, height: number, style: string|Record<string, string>, wrapperStyle: string|Record<string, string>, eventStyle: 'tonal'|'filled'|'bordered'|'traced'|'outlined'|'indented'|'line'|'dashed'|'minimal'|'rounded'|'calendar'|'interday'|'gantt'|null, eventColor: string, ariaLabel: string, children: DomConfig[] } }) => string|DomConfig|DomConfig[]
|
|
522
488
|
/**
|
|
523
489
|
* `this` reference for the [eventRenderer](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/SchedulerEventRendering#config-eventRenderer) function
|
|
524
490
|
*/
|
|
@@ -539,8 +505,7 @@ export declare type BryntumSchedulerProps = {
|
|
|
539
505
|
* Event style used by default. Events and resources can specify their own style, with priority order being:
|
|
540
506
|
* Event -> Resource -> Scheduler default. Determines the appearance of the event by assigning a CSS class
|
|
541
507
|
* to it. Available styles are:
|
|
542
|
-
* ...
|
|
543
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-eventStyle)
|
|
508
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-eventStyle)
|
|
544
509
|
*/
|
|
545
510
|
eventStyle ? : 'tonal'|'filled'|'bordered'|'traced'|'outlined'|'indented'|'line'|'dashed'|'minimal'|'rounded'|'calendar'|'interday'|'gantt'|null
|
|
546
511
|
extraData ? : any
|
|
@@ -553,16 +518,14 @@ export declare type BryntumSchedulerProps = {
|
|
|
553
518
|
/**
|
|
554
519
|
* Specify `true` to force rendered events/tasks to fill entire ticks. This only affects rendering, start
|
|
555
520
|
* and end dates retain their value on the data level.
|
|
556
|
-
* ...
|
|
557
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-fillTicks)
|
|
521
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-fillTicks)
|
|
558
522
|
*/
|
|
559
523
|
fillTicks ? : Boolean
|
|
560
524
|
/**
|
|
561
525
|
* Use fixed row height. Setting this to `true` will configure the underlying RowManager to use fixed row
|
|
562
526
|
* height, which sacrifices the ability to use rows with variable height to gain a fraction better
|
|
563
527
|
* performance.
|
|
564
|
-
* ...
|
|
565
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-fixedRowHeight)
|
|
528
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-fixedRowHeight)
|
|
566
529
|
*/
|
|
567
530
|
fixedRowHeight ? : Boolean
|
|
568
531
|
/**
|
|
@@ -576,14 +539,12 @@ export declare type BryntumSchedulerProps = {
|
|
|
576
539
|
/**
|
|
577
540
|
* Config object of a footer. May contain a `dock`, `html` and a `cls` property. A footer is not a widget,
|
|
578
541
|
* 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).
|
|
579
|
-
* ...
|
|
580
|
-
*
|
|
542
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-footer)
|
|
543
|
+
* @property {'top','right','bottom','left','start','end'} dock Where to dock
|
|
544
|
+
* @property {string} html Html to populate the footer with
|
|
545
|
+
* @property {string} cls CSS class to add to the footer
|
|
581
546
|
*/
|
|
582
|
-
footer ? :
|
|
583
|
-
dock?: 'top'|'right'|'bottom'|'left'|'start'|'end'
|
|
584
|
-
html?: string
|
|
585
|
-
cls?: string
|
|
586
|
-
}|string
|
|
547
|
+
footer ? : object|string
|
|
587
548
|
/**
|
|
588
549
|
* Set to `true` to force the time columns to fit to the available space (horizontal or vertical depends on mode).
|
|
589
550
|
* Note that setting [suppressFit](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineBase#config-suppressFit) to `true`, will disable `forceFit` functionality. Zooming
|
|
@@ -593,39 +554,34 @@ export declare type BryntumSchedulerProps = {
|
|
|
593
554
|
/**
|
|
594
555
|
* An object which names formula prefixes which will be applied to all columns configured with
|
|
595
556
|
* `formula : true`.
|
|
596
|
-
* ...
|
|
597
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-formulaProviders)
|
|
557
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-formulaProviders)
|
|
598
558
|
*/
|
|
599
559
|
formulaProviders ? : Record<string, FormulaProviderConfig>
|
|
600
560
|
/**
|
|
601
561
|
* Refresh entire row when a record changes (`true`) or, if possible, only the cells affected (`false`).
|
|
602
|
-
* ...
|
|
603
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-fullRowRefresh)
|
|
562
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-fullRowRefresh)
|
|
604
563
|
*/
|
|
605
564
|
fullRowRefresh ? : Boolean
|
|
606
565
|
/**
|
|
607
566
|
* A method allowing you to define date boundaries that will constrain resize, create and drag drop
|
|
608
567
|
* operations. The method will be called with the Resource record, and the Event record.
|
|
609
|
-
* ...
|
|
610
|
-
* [
|
|
611
|
-
* @param {Scheduler.model.
|
|
612
|
-
* @param {Scheduler.model.EventModel} eventRecord The event record
|
|
568
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-getDateConstraints)
|
|
569
|
+
* @param {Scheduler.model.ResourceModel} [resourceRecord] The resource record
|
|
570
|
+
* @param {Scheduler.model.EventModel} [eventRecord] The event record
|
|
613
571
|
* @returns {DateConstraint} Constraining `Object` containing `start` and `end` constraints. Omitting either will mean that end is not constrained. So you can prevent a resize or move from moving *before* a certain time while not constraining the end date.
|
|
614
572
|
*/
|
|
615
|
-
getDateConstraints ? : (resourceRecord
|
|
573
|
+
getDateConstraints ? : (resourceRecord: ResourceModel, eventRecord: EventModel) => DateConstraint
|
|
616
574
|
/**
|
|
617
575
|
* Scheduler overrides Grid's default implementation of [getRowHeight](https://bryntum.com/products/scheduler/docs/api/Grid/view/GridBase#config-getRowHeight) to
|
|
618
576
|
* pre-calculate row heights based on events in the rows.
|
|
619
|
-
* ...
|
|
620
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-getRowHeight)
|
|
577
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-getRowHeight)
|
|
621
578
|
* @param {Scheduler.model.ResourceModel} getRowHeight.record Resource record to determine row height for
|
|
622
579
|
* @returns {number} Desired row height
|
|
623
580
|
*/
|
|
624
|
-
getRowHeight ? : (
|
|
581
|
+
getRowHeight ? : () => number
|
|
625
582
|
/**
|
|
626
583
|
* 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`.
|
|
627
|
-
* ...
|
|
628
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-header)
|
|
584
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-header)
|
|
629
585
|
*/
|
|
630
586
|
header ? : string|Boolean|PanelHeader
|
|
631
587
|
/**
|
|
@@ -652,8 +608,7 @@ export declare type BryntumSchedulerProps = {
|
|
|
652
608
|
hideHorizontalScrollbar ? : Boolean
|
|
653
609
|
/**
|
|
654
610
|
* By default the row hover effect is not visible in the Scheduler part of the grid.
|
|
655
|
-
* ...
|
|
656
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-hideRowHover)
|
|
611
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-hideRowHover)
|
|
657
612
|
*/
|
|
658
613
|
hideRowHover ? : Boolean
|
|
659
614
|
/**
|
|
@@ -684,15 +639,13 @@ export declare type BryntumSchedulerProps = {
|
|
|
684
639
|
ignoreDomEventsWhileScrolling ? : Boolean
|
|
685
640
|
/**
|
|
686
641
|
* Determines if the widgets read-only state should be controlled by its parent.
|
|
687
|
-
* ...
|
|
688
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-ignoreParentReadOnly)
|
|
642
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-ignoreParentReadOnly)
|
|
689
643
|
*/
|
|
690
644
|
ignoreParentReadOnly ? : Boolean
|
|
691
645
|
/**
|
|
692
646
|
* Set to `true` to automatically adjust the panel timespan during scrolling in the time dimension,
|
|
693
647
|
* when the scroller comes close to the start/end edges.
|
|
694
|
-
* ...
|
|
695
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-infiniteScroll)
|
|
648
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-infiniteScroll)
|
|
696
649
|
*/
|
|
697
650
|
infiniteScroll ? : Boolean
|
|
698
651
|
/**
|
|
@@ -707,8 +660,7 @@ export declare type BryntumSchedulerProps = {
|
|
|
707
660
|
* Convenience setting to align input fields of child widgets. By default, the Field input element is
|
|
708
661
|
* placed immediately following the `label`. If you prefer to have all input fields aligned to the
|
|
709
662
|
* right, set this config to `'end'`.
|
|
710
|
-
* ...
|
|
711
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-inputFieldAlign)
|
|
663
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-inputFieldAlign)
|
|
712
664
|
*/
|
|
713
665
|
inputFieldAlign ? : 'start'|'end'
|
|
714
666
|
/**
|
|
@@ -721,8 +673,7 @@ export declare type BryntumSchedulerProps = {
|
|
|
721
673
|
insertFirst ? : HTMLElement|string
|
|
722
674
|
/**
|
|
723
675
|
* A template method (empty by default) allowing you to control if an event can be selected or not.
|
|
724
|
-
* ...
|
|
725
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-isEventSelectable)
|
|
676
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-isEventSelectable)
|
|
726
677
|
* @param {Scheduler.model.EventModel} event The event record
|
|
727
678
|
* @returns {boolean} true if event can be selected, otherwise false
|
|
728
679
|
*/
|
|
@@ -733,10 +684,14 @@ export declare type BryntumSchedulerProps = {
|
|
|
733
684
|
keyMap ? : Record<string, KeyMapConfig>
|
|
734
685
|
/**
|
|
735
686
|
* Convenience setting to use same label placement on all child widgets.
|
|
736
|
-
* ...
|
|
737
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-labelPosition)
|
|
687
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-labelPosition)
|
|
738
688
|
*/
|
|
739
689
|
labelPosition ? : 'before'|'above'|'align-before'|'auto'|null
|
|
690
|
+
/**
|
|
691
|
+
* Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
|
|
692
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-labelWidth)
|
|
693
|
+
*/
|
|
694
|
+
labelWidth ? : number|null
|
|
740
695
|
/**
|
|
741
696
|
* By default, when the `EventStore` (and similar stores) is lazy loading, a loading indicator will be displayed
|
|
742
697
|
* just below the timeline headers. Set this to `false` to prevent this indicator being shown.
|
|
@@ -744,14 +699,12 @@ export declare type BryntumSchedulerProps = {
|
|
|
744
699
|
lazyLoadingIndicator ? : Boolean
|
|
745
700
|
/**
|
|
746
701
|
* The listener set for this object.
|
|
747
|
-
* ...
|
|
748
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-listeners)
|
|
702
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-listeners)
|
|
749
703
|
*/
|
|
750
704
|
listeners ? : SchedulerListeners
|
|
751
705
|
/**
|
|
752
706
|
* *This property is for use when the Scheduler is used as a Calendar view - a `mode`.*
|
|
753
|
-
* ...
|
|
754
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-listRangeMenu)
|
|
707
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-listRangeMenu)
|
|
755
708
|
*/
|
|
756
709
|
listRangeMenu ? : MenuConfig
|
|
757
710
|
/**
|
|
@@ -764,15 +717,13 @@ export declare type BryntumSchedulerProps = {
|
|
|
764
717
|
* when data is loading. The message and optional configuration from the
|
|
765
718
|
* [loadMask](https://bryntum.com/products/scheduler/docs/api/Core/mixin/LoadMaskable#config-loadMask) config take priority over these options, just as they do
|
|
766
719
|
* for `maskDefaults`, respectively.
|
|
767
|
-
* ...
|
|
768
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-loadMaskDefaults)
|
|
720
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-loadMaskDefaults)
|
|
769
721
|
*/
|
|
770
722
|
loadMaskDefaults ? : MaskConfig
|
|
771
723
|
/**
|
|
772
724
|
* A [Mask](https://bryntum.com/products/scheduler/docs/api/Core/widget/Mask) config object to adjust the [maskDefaults](#Core/widget/Widget#config-maskDefaults)
|
|
773
725
|
* when an error occurs loading data.
|
|
774
|
-
* ...
|
|
775
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-loadMaskError)
|
|
726
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-loadMaskError)
|
|
776
727
|
*/
|
|
777
728
|
loadMaskError ? : MaskConfig|Mask|Boolean
|
|
778
729
|
/**
|
|
@@ -791,8 +742,7 @@ export declare type BryntumSchedulerProps = {
|
|
|
791
742
|
/**
|
|
792
743
|
* When `true`, events are sized and positioned based on rowHeight, resourceMargin and barMargin settings.
|
|
793
744
|
* Set this to `false` if you want to control height and vertical position using CSS instead.
|
|
794
|
-
* ...
|
|
795
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-managedEventSizing)
|
|
745
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-managedEventSizing)
|
|
796
746
|
*/
|
|
797
747
|
managedEventSizing ? : Boolean
|
|
798
748
|
/**
|
|
@@ -823,8 +773,7 @@ export declare type BryntumSchedulerProps = {
|
|
|
823
773
|
/**
|
|
824
774
|
* The maximum time axis unit to display non-working ranges for ('hour' or 'day' etc).
|
|
825
775
|
* When zooming to a view with a larger unit, no non-working time elements will be rendered.
|
|
826
|
-
* ...
|
|
827
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-maxTimeAxisUnit)
|
|
776
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-maxTimeAxisUnit)
|
|
828
777
|
*/
|
|
829
778
|
maxTimeAxisUnit ? : DurationUnit
|
|
830
779
|
/**
|
|
@@ -833,17 +782,14 @@ export declare type BryntumSchedulerProps = {
|
|
|
833
782
|
*/
|
|
834
783
|
maxWidth ? : string|number
|
|
835
784
|
/**
|
|
836
|
-
* The maximum zoom level to which [zoomIn](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomIn) will work.
|
|
837
|
-
* [
|
|
838
|
-
* for information. Unless you have modified the collection of available presets, the max zoom level is
|
|
839
|
-
* milliseconds.
|
|
785
|
+
* The maximum zoom level to which [zoomIn](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomIn) will work.
|
|
786
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-maxZoomLevel)
|
|
840
787
|
*/
|
|
841
|
-
maxZoomLevel ? : number
|
|
788
|
+
maxZoomLevel ? : number|string
|
|
842
789
|
/**
|
|
843
790
|
* How to align milestones in relation to their startDate. Only applies when using a `milestoneLayoutMode`
|
|
844
791
|
* other than `default`. Valid values are:
|
|
845
|
-
* ...
|
|
846
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-milestoneAlign)
|
|
792
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-milestoneAlign)
|
|
847
793
|
*/
|
|
848
794
|
milestoneAlign ? : 'start'|'center'|'end'
|
|
849
795
|
/**
|
|
@@ -854,14 +800,12 @@ export declare type BryntumSchedulerProps = {
|
|
|
854
800
|
/**
|
|
855
801
|
* How to handle milestones during event layout. How the milestones are displayed when part of the layout
|
|
856
802
|
* are controlled using [milestoneTextPosition](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/SchedulerEventRendering#config-milestoneTextPosition).
|
|
857
|
-
* ...
|
|
858
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-milestoneLayoutMode)
|
|
803
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-milestoneLayoutMode)
|
|
859
804
|
*/
|
|
860
805
|
milestoneLayoutMode ? : 'default'|'estimate'|'data'|'measure'
|
|
861
806
|
/**
|
|
862
807
|
* Position of the milestone text:
|
|
863
|
-
* ...
|
|
864
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-milestoneTextPosition)
|
|
808
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-milestoneTextPosition)
|
|
865
809
|
*/
|
|
866
810
|
milestoneTextPosition ? : 'inside'|'outside'|'always-outside'
|
|
867
811
|
/**
|
|
@@ -873,16 +817,14 @@ export declare type BryntumSchedulerProps = {
|
|
|
873
817
|
/**
|
|
874
818
|
* Grid's `min-height`. Defaults to `10em` to be sure that the Grid always has a height wherever it is
|
|
875
819
|
* inserted.
|
|
876
|
-
* ...
|
|
877
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-minHeight)
|
|
820
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-minHeight)
|
|
878
821
|
*/
|
|
879
822
|
minHeight ? : string|number
|
|
880
823
|
/**
|
|
881
824
|
* *Experimental* Minimum size that events should be allowed to shrink to when using `pack` layout. If
|
|
882
825
|
* packing leads to any event being smaller than this value, the row will grow in height instead to maintain
|
|
883
826
|
* this minimum size.
|
|
884
|
-
* ...
|
|
885
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-minPackSize)
|
|
827
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-minPackSize)
|
|
886
828
|
*/
|
|
887
829
|
minPackSize ? : number
|
|
888
830
|
/**
|
|
@@ -891,9 +833,10 @@ export declare type BryntumSchedulerProps = {
|
|
|
891
833
|
*/
|
|
892
834
|
minWidth ? : string|number
|
|
893
835
|
/**
|
|
894
|
-
* The minimum zoom level to which [zoomOut](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomOut) will work.
|
|
836
|
+
* The minimum zoom level to which [zoomOut](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomOut) will work.
|
|
837
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-minZoomLevel)
|
|
895
838
|
*/
|
|
896
|
-
minZoomLevel ? : number
|
|
839
|
+
minZoomLevel ? : number|string
|
|
897
840
|
/**
|
|
898
841
|
* Scheduler mode. Supported values: horizontal, vertical
|
|
899
842
|
*/
|
|
@@ -904,27 +847,23 @@ export declare type BryntumSchedulerProps = {
|
|
|
904
847
|
monitorResize ? : Boolean
|
|
905
848
|
/**
|
|
906
849
|
* Configure as `true` to allow `CTRL/CMD+click` to select multiple events in the scheduler.
|
|
907
|
-
* ...
|
|
908
|
-
* [
|
|
850
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-multiEventSelect)
|
|
851
|
+
* @property {boolean} [ctrlKey] Set to `true` to use <kbd>Ctrl</kbd> key for multi selection (<kbd>Cmd</kbd> on Mac).
|
|
852
|
+
* @property {boolean} [altKey] Set to `true` to use <kbd>Alt</kbd> key for multi selection (<kbd>Option</kbd> on Mac)
|
|
853
|
+
* @property {boolean} [shiftKey] Set to `true` to use <kbd>Shift</kbd> key for multi selection
|
|
909
854
|
*/
|
|
910
|
-
multiEventSelect ? : Boolean|
|
|
911
|
-
ctrlKey?: Boolean
|
|
912
|
-
altKey?: Boolean
|
|
913
|
-
shiftKey?: Boolean
|
|
914
|
-
}
|
|
855
|
+
multiEventSelect ? : Boolean|object
|
|
915
856
|
/**
|
|
916
857
|
* When an event bar has a width less than this value, it gets the CSS class `b-sch-event-narrow`
|
|
917
858
|
* added. You may apply custom CSS rules using this class.
|
|
918
|
-
* ...
|
|
919
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-narrowEventWidth)
|
|
859
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-narrowEventWidth)
|
|
920
860
|
*/
|
|
921
861
|
narrowEventWidth ? : number
|
|
922
862
|
/**
|
|
923
863
|
* Override this method to provide a custom sort function to sort any overlapping events. This only applies
|
|
924
864
|
* to the horizontal mode, where the order the events are sorted in determines their vertical placement
|
|
925
865
|
* within a resource.
|
|
926
|
-
* ...
|
|
927
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-overlappingEventSorter)
|
|
866
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-overlappingEventSorter)
|
|
928
867
|
* @param {Scheduler.model.EventModel} a First event
|
|
929
868
|
* @param {Scheduler.model.EventModel} b Second event
|
|
930
869
|
* @returns {number} Return -1 to display `a` above `b`, 1 for `b` above `a`
|
|
@@ -933,26 +872,23 @@ export declare type BryntumSchedulerProps = {
|
|
|
933
872
|
/**
|
|
934
873
|
* Partners this Timeline panel with another Timeline in order to sync their region sizes (sub-grids like locked, normal will get the same width),
|
|
935
874
|
* start and end dates, view preset, zoom level and scrolling position. All these values will be synced with the timeline defined as the `partner`.
|
|
936
|
-
* ...
|
|
937
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-partner)
|
|
875
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-partner)
|
|
938
876
|
*/
|
|
939
877
|
partner ? : TimelineBase|string
|
|
940
878
|
/**
|
|
941
879
|
* Set to `true` to include `startDate` and `endDate` params indicating the currently viewed date range in
|
|
942
880
|
* `EventStore` load requests (when loading using `AjaxStore` or `CrudManager` functionality).
|
|
943
|
-
* ...
|
|
944
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-passStartEndParameters)
|
|
881
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-passStartEndParameters)
|
|
945
882
|
*/
|
|
946
883
|
passStartEndParameters ? : Boolean
|
|
947
884
|
/**
|
|
948
885
|
* Specify plugins (an array of classes) in config
|
|
949
886
|
*/
|
|
950
|
-
plugins ? :
|
|
887
|
+
plugins ? : InstancePlugin[]|InstancePlugin
|
|
951
888
|
/**
|
|
952
889
|
* Maximum number of resources for which height is pre-calculated. If you have many events per
|
|
953
890
|
* resource you might want to lower this number to gain some initial rendering performance.
|
|
954
|
-
* ...
|
|
955
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-preCalculateHeightLimit)
|
|
891
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-preCalculateHeightLimit)
|
|
956
892
|
*/
|
|
957
893
|
preCalculateHeightLimit ? : number
|
|
958
894
|
/**
|
|
@@ -970,10 +906,9 @@ export declare type BryntumSchedulerProps = {
|
|
|
970
906
|
*/
|
|
971
907
|
preserveScrollOnDatasetChange ? : Boolean
|
|
972
908
|
/**
|
|
973
|
-
* An array of [ViewPreset](https://bryntum.com/products/scheduler/docs/api/Scheduler/preset/ViewPreset) config objects
|
|
974
|
-
*
|
|
975
|
-
* ...
|
|
976
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-presets)
|
|
909
|
+
* An array of [ViewPreset](https://bryntum.com/products/scheduler/docs/api/Scheduler/preset/ViewPreset) config objects which describes the available timeline layouts
|
|
910
|
+
* for this scheduler.
|
|
911
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-presets)
|
|
977
912
|
*/
|
|
978
913
|
presets ? : ViewPresetConfig[]
|
|
979
914
|
/**
|
|
@@ -984,50 +919,56 @@ export declare type BryntumSchedulerProps = {
|
|
|
984
919
|
/**
|
|
985
920
|
* A [ProjectModel](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/ProjectModel) instance or a config object. The project holds all Scheduler data.
|
|
986
921
|
* Can be omitted in favor of individual store configs or [crudManager](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/SchedulerStores#config-crudManager) config.
|
|
987
|
-
* ...
|
|
988
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-project)
|
|
922
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-project)
|
|
989
923
|
*/
|
|
990
924
|
project ? : ProjectModel|ProjectModelConfig|object
|
|
925
|
+
/**
|
|
926
|
+
* The project model class to use when creating the project instance. Override this to use a custom project
|
|
927
|
+
* model class. In SchedulerPro and Gantt, this is overridden to use their respective project model classes.
|
|
928
|
+
*/
|
|
929
|
+
projectModelClass ? : typeof ProjectModel
|
|
991
930
|
/**
|
|
992
931
|
* Range used to set the length of the time axis when used as a component of a Calendar. Suitable units are
|
|
993
932
|
* `'month'`, `'week'` and `'day'`.
|
|
994
|
-
* ...
|
|
995
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-range)
|
|
933
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-range)
|
|
996
934
|
*/
|
|
997
935
|
range ? : string|DurationConfig
|
|
998
936
|
/**
|
|
999
937
|
* Configure as `true` to make the scheduler read-only, by disabling any UIs for modifying data.
|
|
1000
|
-
* ...
|
|
1001
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-readOnly)
|
|
938
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-readOnly)
|
|
1002
939
|
*/
|
|
1003
940
|
readOnly ? : Boolean
|
|
1004
941
|
/**
|
|
1005
942
|
* The confirmation dialog shown when a recurring event is edited.
|
|
1006
|
-
* ...
|
|
1007
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-recurrenceConfirmationPopup)
|
|
943
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-recurrenceConfirmationPopup)
|
|
1008
944
|
*/
|
|
1009
|
-
recurrenceConfirmationPopup ? : RecurrenceConfirmationPopupConfig
|
|
945
|
+
recurrenceConfirmationPopup ? : RecurrenceConfirmationPopupConfig
|
|
1010
946
|
relayStoreEvents ? : Boolean
|
|
1011
947
|
/**
|
|
1012
948
|
* Either a default `rendition` to apply to all child widgets, or a map of renditions keyed by child widget
|
|
1013
949
|
* `type`.
|
|
1014
|
-
* ...
|
|
1015
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-rendition)
|
|
950
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-rendition)
|
|
1016
951
|
*/
|
|
1017
952
|
rendition ? : string|Record<string, string>|null
|
|
1018
953
|
/**
|
|
1019
954
|
* Configure this property to allow the widget/component to be resized. Pressing <kbd>Shift</kbd> while resizing will
|
|
1020
955
|
* constrain the aspect ratio.
|
|
1021
|
-
* ...
|
|
1022
|
-
* [
|
|
1023
|
-
|
|
1024
|
-
|
|
1025
|
-
|
|
1026
|
-
|
|
1027
|
-
|
|
1028
|
-
|
|
1029
|
-
|
|
1030
|
-
|
|
956
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-resizable)
|
|
957
|
+
* @property {number} [resizable.minWidth] The minimum width of the element.
|
|
958
|
+
* @property {number} [resizable.maxWidth] The maximum width of the element.
|
|
959
|
+
* @property {number} [resizable.minHeight] The minimum height of the element.
|
|
960
|
+
* @property {number} [resizable.maxHeight] The maximum height of the element
|
|
961
|
+
* @property {object} [resizable.handles] An object controlling which edges/corners are resizable.
|
|
962
|
+
* @property {boolean} [resizable.handles.topStart] Resizable from top-start corner
|
|
963
|
+
* @property {boolean} [resizable.handles.top] Resizable from top edge
|
|
964
|
+
* @property {boolean} [resizable.handles.topEnd] Resizable from top-end corner
|
|
965
|
+
* @property {boolean} [resizable.handles.end] Resizable from end edge
|
|
966
|
+
* @property {boolean} [resizable.handles.bottomEnd] Resizable from bottom-end corner
|
|
967
|
+
* @property {boolean} [resizable.handles.bottom] Resizable from bottom edge
|
|
968
|
+
* @property {boolean} [resizable.handles.bottomStart] Resizable from bottom-start corner
|
|
969
|
+
* @property {boolean} [resizable.handles.start] Resizable from start edge
|
|
970
|
+
*/
|
|
971
|
+
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 } }
|
|
1031
972
|
/**
|
|
1032
973
|
* Set to `false` to only measure cell contents when double-clicking the edge between column headers.
|
|
1033
974
|
*/
|
|
@@ -1035,8 +976,7 @@ export declare type BryntumSchedulerProps = {
|
|
|
1035
976
|
/**
|
|
1036
977
|
* A config object used to configure the resource columns in vertical mode.
|
|
1037
978
|
* See [ResourceHeader](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/ResourceHeader) for more details on available properties.
|
|
1038
|
-
* ...
|
|
1039
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-resourceColumns)
|
|
979
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-resourceColumns)
|
|
1040
980
|
*/
|
|
1041
981
|
resourceColumns ? : ResourceHeaderConfig
|
|
1042
982
|
/**
|
|
@@ -1047,25 +987,21 @@ export declare type BryntumSchedulerProps = {
|
|
|
1047
987
|
* Path to load resource images from. Used by the resource header in vertical mode and the
|
|
1048
988
|
* [ResourceInfoColumn](https://bryntum.com/products/scheduler/docs/api/Scheduler/column/ResourceInfoColumn) in horizontal mode. Set this to display miniature
|
|
1049
989
|
* images for each resource using their `image` or `imageUrl` fields.
|
|
1050
|
-
* ...
|
|
1051
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-resourceImagePath)
|
|
990
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-resourceImagePath)
|
|
1052
991
|
*/
|
|
1053
992
|
resourceImagePath ? : string
|
|
1054
993
|
/**
|
|
1055
994
|
* Convenience config to set both [resourceImagePath](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/SchedulerResourceRendering#config-resourceImagePath) and [resourceImageExtension](#Scheduler/view/mixin/SchedulerResourceRendering#config-resourceImageExtension).
|
|
1056
|
-
* ...
|
|
1057
|
-
*
|
|
995
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-resourceImages)
|
|
996
|
+
* @property {string} path Path to load resource images from
|
|
997
|
+
* @property {string} extension Resource image extension
|
|
1058
998
|
*/
|
|
1059
|
-
resourceImages ? :
|
|
1060
|
-
path?: string
|
|
1061
|
-
extension?: string
|
|
1062
|
-
}
|
|
999
|
+
resourceImages ? : object
|
|
1063
1000
|
/**
|
|
1064
1001
|
* Control how much space to leave between the first event/last event and the resources edge (top/bottom
|
|
1065
1002
|
* margin within the resource row in horizontal mode, left/right margin within the resource column in
|
|
1066
1003
|
* vertical mode), in px. Defaults to the value of [barMargin](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-barMargin).
|
|
1067
|
-
* ...
|
|
1068
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-resourceMargin)
|
|
1004
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-resourceMargin)
|
|
1069
1005
|
*/
|
|
1070
1006
|
resourceMargin ? : number|ResourceMarginConfig
|
|
1071
1007
|
/**
|
|
@@ -1080,8 +1016,7 @@ export declare type BryntumSchedulerProps = {
|
|
|
1080
1016
|
* An empty function by default, but provided so that you can override it. This function is called each time
|
|
1081
1017
|
* a resource time range is rendered into the schedule. It's called with `resourceTimeRangeRecord`, `resourceRecord`,
|
|
1082
1018
|
* and `renderData` params.
|
|
1083
|
-
* ...
|
|
1084
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-resourceTimeRangeRenderer)
|
|
1019
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-resourceTimeRangeRenderer)
|
|
1085
1020
|
* @param {object} detail An object containing the information needed to render a ResourceTimeRangeModel.
|
|
1086
1021
|
* @param {Scheduler.model.ResourceTimeRangeModel} detail.resourceTimeRangeRecord The resource time range record.
|
|
1087
1022
|
* @param {Scheduler.model.ResourceModel} detail.resourceRecord The resource record.
|
|
@@ -1100,23 +1035,26 @@ export declare type BryntumSchedulerProps = {
|
|
|
1100
1035
|
resourceTimeRangeStore ? : ResourceTimeRangeStore|ResourceTimeRangeStoreConfig
|
|
1101
1036
|
/**
|
|
1102
1037
|
* "Break points" for which responsive config to use.
|
|
1103
|
-
* ...
|
|
1104
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-responsiveLevels)
|
|
1038
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-responsiveLevels)
|
|
1105
1039
|
*/
|
|
1106
1040
|
responsiveLevels ? : Record<string, number|string|SchedulerResponsiveLevelConfig>
|
|
1107
1041
|
/**
|
|
1108
1042
|
* Configure as `true` to have the component display a translucent ripple when its
|
|
1109
1043
|
* [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
|
|
1110
1044
|
* current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
|
|
1111
|
-
* ...
|
|
1112
|
-
* [
|
|
1045
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-ripple)
|
|
1046
|
+
* @property {string} [delegate] A CSS selector to filter which child elements trigger ripples. By default, the ripple is clipped to the triggering element.
|
|
1047
|
+
* @property {string} [color] A CSS color name or specification.
|
|
1048
|
+
* @property {number} [radius] The ending radius of the ripple. Note that it will be clipped by the target element by default.
|
|
1049
|
+
* @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.
|
|
1113
1050
|
*/
|
|
1114
|
-
ripple ? : Boolean|
|
|
1115
|
-
|
|
1116
|
-
|
|
1117
|
-
|
|
1118
|
-
|
|
1119
|
-
|
|
1051
|
+
ripple ? : Boolean|object
|
|
1052
|
+
/**
|
|
1053
|
+
* The ARIA role to apply to this widget's element. By default, this is set to `'presentation'` to avoid
|
|
1054
|
+
* accidentally applying a role which may interfere with screen readers.
|
|
1055
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-role)
|
|
1056
|
+
*/
|
|
1057
|
+
role ? : string
|
|
1120
1058
|
/**
|
|
1121
1059
|
* 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`
|
|
1122
1060
|
*/
|
|
@@ -1131,15 +1069,13 @@ export declare type BryntumSchedulerProps = {
|
|
|
1131
1069
|
rowLines ? : Boolean
|
|
1132
1070
|
/**
|
|
1133
1071
|
* This may be configured as `true` to make the widget's element use the `direction:rtl` style.
|
|
1134
|
-
* ...
|
|
1135
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-rtl)
|
|
1072
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-rtl)
|
|
1136
1073
|
*/
|
|
1137
1074
|
rtl ? : Boolean
|
|
1138
1075
|
/**
|
|
1139
1076
|
* 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).
|
|
1140
1077
|
* See the [scrollerClass](https://bryntum.com/products/scheduler/docs/api/Grid/view/GridBase#config-scrollerClass) config option.
|
|
1141
|
-
* ...
|
|
1142
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-scrollable)
|
|
1078
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-scrollable)
|
|
1143
1079
|
*/
|
|
1144
1080
|
scrollable ? : Boolean|ScrollerConfig|Scroller
|
|
1145
1081
|
/**
|
|
@@ -1149,8 +1085,7 @@ export declare type BryntumSchedulerProps = {
|
|
|
1149
1085
|
/**
|
|
1150
1086
|
* Specifies the maximum duration for extending the current [TimeSpan](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/TimeSpan) to allow for smooth
|
|
1151
1087
|
* scrolling to an event.
|
|
1152
|
-
* ...
|
|
1153
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-scrollExtensionThreshold)
|
|
1088
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-scrollExtensionThreshold)
|
|
1154
1089
|
*/
|
|
1155
1090
|
scrollExtensionThreshold ? : string|DurationConfig
|
|
1156
1091
|
/**
|
|
@@ -1161,8 +1096,7 @@ export declare type BryntumSchedulerProps = {
|
|
|
1161
1096
|
/**
|
|
1162
1097
|
* Selection configuration settings, change these properties to control how selection works and what can be
|
|
1163
1098
|
* selected.
|
|
1164
|
-
* ...
|
|
1165
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-selectionMode)
|
|
1099
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-selectionMode)
|
|
1166
1100
|
*/
|
|
1167
1101
|
selectionMode ? : GridSelectionMode
|
|
1168
1102
|
/**
|
|
@@ -1174,11 +1108,9 @@ export declare type BryntumSchedulerProps = {
|
|
|
1174
1108
|
*/
|
|
1175
1109
|
selectResourceOnScheduleClick ? : Boolean
|
|
1176
1110
|
/**
|
|
1177
|
-
* <div class="note">This property is for use when the Scheduler is used as a Calendar view - a `mode
|
|
1178
|
-
*
|
|
1179
|
-
*
|
|
1180
|
-
* ...
|
|
1181
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-shiftIncrement)
|
|
1111
|
+
* <div class="note">This property is for use when the Scheduler is used as a Calendar view - a `mode` - it will have no
|
|
1112
|
+
* effect on a Scheduler which is not inside a Calendar.</div>
|
|
1113
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-shiftIncrement)
|
|
1182
1114
|
*/
|
|
1183
1115
|
shiftIncrement ? : string|DurationConfig
|
|
1184
1116
|
/**
|
|
@@ -1188,13 +1120,11 @@ export declare type BryntumSchedulerProps = {
|
|
|
1188
1120
|
/**
|
|
1189
1121
|
* Configure as `true` to have the grid show a red "changed" tag in cells whose
|
|
1190
1122
|
* field value has changed and not yet been committed.
|
|
1191
|
-
* ...
|
|
1192
|
-
*
|
|
1123
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-showDirty)
|
|
1124
|
+
* @property {boolean} showDirty.duringEdit Set to `true` to show the red tag while editing a cell
|
|
1125
|
+
* @property {boolean} showDirty.newRecord Set to `true` to show the red tag for all the cells of the new record
|
|
1193
1126
|
*/
|
|
1194
|
-
showDirty ? : Boolean|{
|
|
1195
|
-
duringEdit?: Boolean
|
|
1196
|
-
newRecord?: Boolean
|
|
1197
|
-
}
|
|
1127
|
+
showDirty ? : Boolean|{ duringEdit: Boolean, newRecord: Boolean }
|
|
1198
1128
|
/**
|
|
1199
1129
|
* If set to `true` this will show a color field in the [EventEdit](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/EventEdit) editor and also a
|
|
1200
1130
|
* picker in the [EventMenu](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/EventMenu). Both enables the user to choose a color which will be
|
|
@@ -1217,17 +1147,25 @@ export declare type BryntumSchedulerProps = {
|
|
|
1217
1147
|
* Set to `true` to show a tooltip when hovering a dependency line
|
|
1218
1148
|
*/
|
|
1219
1149
|
showTooltip ? : Boolean
|
|
1150
|
+
/**
|
|
1151
|
+
* When `true`, all zoom operations ([zoomIn](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomIn),
|
|
1152
|
+
* [zoomOut](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomOut),
|
|
1153
|
+
* [zoomInFull](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomInFull),
|
|
1154
|
+
* [zoomOutFull](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomOutFull)) will use the smooth zoom system instead
|
|
1155
|
+
* of jumping between discrete preset levels. This provides finer-grained control over zoom levels by
|
|
1156
|
+
* interpolating tick sizes between presets.
|
|
1157
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-smoothZoom)
|
|
1158
|
+
*/
|
|
1159
|
+
smoothZoom ? : Boolean
|
|
1220
1160
|
/**
|
|
1221
1161
|
* Set to `true` to snap to the current time resolution increment while interacting with scheduled events.
|
|
1222
|
-
* ...
|
|
1223
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-snap)
|
|
1162
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-snap)
|
|
1224
1163
|
*/
|
|
1225
1164
|
snap ? : Boolean
|
|
1226
1165
|
/**
|
|
1227
1166
|
* Affects drag drop and resizing of events when [snap](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineDateMapper#config-snap)
|
|
1228
1167
|
* is enabled.
|
|
1229
|
-
* ...
|
|
1230
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-snapRelativeToEventStartDate)
|
|
1168
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-snapRelativeToEventStartDate)
|
|
1231
1169
|
*/
|
|
1232
1170
|
snapRelativeToEventStartDate ? : Boolean
|
|
1233
1171
|
/**
|
|
@@ -1236,8 +1174,7 @@ export declare type BryntumSchedulerProps = {
|
|
|
1236
1174
|
span ? : number
|
|
1237
1175
|
/**
|
|
1238
1176
|
* The start date of the timeline (if not configure with [infiniteScroll](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineBase#config-infiniteScroll)).
|
|
1239
|
-
* ...
|
|
1240
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-startDate)
|
|
1177
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-startDate)
|
|
1241
1178
|
*/
|
|
1242
1179
|
startDate ? : Date|string
|
|
1243
1180
|
/**
|
|
@@ -1246,40 +1183,34 @@ export declare type BryntumSchedulerProps = {
|
|
|
1246
1183
|
startParamName ? : string
|
|
1247
1184
|
/**
|
|
1248
1185
|
* This value can be one of the following:
|
|
1249
|
-
* ...
|
|
1250
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-stateful)
|
|
1186
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-stateful)
|
|
1251
1187
|
*/
|
|
1252
1188
|
stateful ? : Boolean|object|string[]
|
|
1253
1189
|
/**
|
|
1254
1190
|
* The events that, when fired by this component, should trigger it to save its state by calling
|
|
1255
1191
|
* [saveState](https://bryntum.com/products/scheduler/docs/api/Core/mixin/State#function-saveState).
|
|
1256
|
-
* ...
|
|
1257
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-statefulEvents)
|
|
1192
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-statefulEvents)
|
|
1258
1193
|
*/
|
|
1259
1194
|
statefulEvents ? : object|string[]
|
|
1260
1195
|
/**
|
|
1261
1196
|
* 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
|
|
1262
1197
|
* 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)
|
|
1263
1198
|
* (if explicitly specified) will be used as the `stateId`.
|
|
1264
|
-
* ...
|
|
1265
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-stateId)
|
|
1199
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-stateId)
|
|
1266
1200
|
*/
|
|
1267
1201
|
stateId ? : string
|
|
1268
1202
|
/**
|
|
1269
1203
|
* 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`
|
|
1270
1204
|
* will be saved using the [default state provider](https://bryntum.com/products/scheduler/docs/api/Core/state/StateProvider#property-instance-static).
|
|
1271
|
-
* ...
|
|
1272
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-stateProvider)
|
|
1205
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-stateProvider)
|
|
1273
1206
|
*/
|
|
1274
1207
|
stateProvider ? : StateProvider
|
|
1275
1208
|
/**
|
|
1276
1209
|
* The properties of this settings object controls how grid is restored from state data.
|
|
1277
|
-
* ...
|
|
1278
|
-
* [
|
|
1210
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-stateSettings)
|
|
1211
|
+
* @property {boolean} [restoreUnconfiguredColumns] Determines whether to restore columns from the state that are not explicitly defined in the grid configuration.
|
|
1279
1212
|
*/
|
|
1280
|
-
stateSettings ? :
|
|
1281
|
-
restoreUnconfiguredColumns?: Boolean
|
|
1282
|
-
}
|
|
1213
|
+
stateSettings ? : object
|
|
1283
1214
|
/**
|
|
1284
1215
|
* When set, the text in the major time axis header sticks in the scrolling viewport as long as possible.
|
|
1285
1216
|
*/
|
|
@@ -1287,24 +1218,21 @@ export declare type BryntumSchedulerProps = {
|
|
|
1287
1218
|
/**
|
|
1288
1219
|
* Store that holds records to display in the grid, or a store config object. If the configuration contains
|
|
1289
1220
|
* a `readUrl`, an `AjaxStore` will be created.
|
|
1290
|
-
* ...
|
|
1291
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-store)
|
|
1221
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-store)
|
|
1292
1222
|
*/
|
|
1293
1223
|
store ? : Store|StoreConfig|AjaxStore|AjaxStoreConfig
|
|
1294
1224
|
/**
|
|
1295
1225
|
* An object containing widgets keyed by name. By default (when no `type` is given), strips are
|
|
1296
1226
|
* [toolbars](https://bryntum.com/products/scheduler/docs/api/Core/widget/Toolbar). If you want to pass an array, you can use
|
|
1297
1227
|
* the toolbar's [items](https://bryntum.com/products/scheduler/docs/api/Core/widget/Container#config-items).
|
|
1298
|
-
* ...
|
|
1299
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-strips)
|
|
1228
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-strips)
|
|
1300
1229
|
*/
|
|
1301
1230
|
strips ? : Record<string, SchedulerContainerItemConfig>
|
|
1302
1231
|
/**
|
|
1303
1232
|
* An object containing sub grid configuration objects keyed by a `region` property.
|
|
1304
1233
|
* By default, grid has a 'locked' region (if configured with locked columns) and a 'normal' region.
|
|
1305
1234
|
* The 'normal' region defaults to use `flex: 1`.
|
|
1306
|
-
* ...
|
|
1307
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-subGridConfigs)
|
|
1235
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-subGridConfigs)
|
|
1308
1236
|
*/
|
|
1309
1237
|
subGridConfigs ? : Record<string, SubGridConfig>
|
|
1310
1238
|
/**
|
|
@@ -1315,31 +1243,27 @@ export declare type BryntumSchedulerProps = {
|
|
|
1315
1243
|
/**
|
|
1316
1244
|
* A [Mask](https://bryntum.com/products/scheduler/docs/api/Core/widget/Mask) config object, or a message to be shown when Crud Manager
|
|
1317
1245
|
* is persisting changes on the server. Set to `null` to disable default sync mask.
|
|
1318
|
-
* ...
|
|
1319
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-syncMask)
|
|
1246
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-syncMask)
|
|
1320
1247
|
*/
|
|
1321
1248
|
syncMask ? : string|MaskConfig|null
|
|
1322
1249
|
/**
|
|
1323
1250
|
* 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
|
|
1324
1251
|
* [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
|
|
1325
1252
|
* this widget:
|
|
1326
|
-
* ...
|
|
1327
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-tab)
|
|
1253
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-tab)
|
|
1328
1254
|
*/
|
|
1329
1255
|
tab ? : Boolean|TabConfig
|
|
1330
1256
|
/**
|
|
1331
1257
|
* When this container is used as a tab in a TabPanel, these items are added to the
|
|
1332
1258
|
* [TabBar](https://bryntum.com/products/scheduler/docs/api/Core/widget/TabBar) when this container is the active tab.
|
|
1333
|
-
* ...
|
|
1334
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-tabBarItems)
|
|
1259
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-tabBarItems)
|
|
1335
1260
|
*/
|
|
1336
1261
|
tabBarItems ? : ToolbarItems[]|Widget[]
|
|
1337
1262
|
/**
|
|
1338
1263
|
* A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/scheduler/docs/api/Core/widget/Toolbar),
|
|
1339
1264
|
* or array of config objects representing the child items of a Toolbar.
|
|
1340
1265
|
* This creates a toolbar docked to the top of the panel immediately below the header.
|
|
1341
|
-
* ...
|
|
1342
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-tbar)
|
|
1266
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-tbar)
|
|
1343
1267
|
*/
|
|
1344
1268
|
tbar ? : (SchedulerContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
|
|
1345
1269
|
/**
|
|
@@ -1348,21 +1272,18 @@ export declare type BryntumSchedulerProps = {
|
|
|
1348
1272
|
terminalCls ? : string
|
|
1349
1273
|
/**
|
|
1350
1274
|
* Delay in ms before hiding the terminals when the mouse leaves an event bar or terminal.
|
|
1351
|
-
* ...
|
|
1352
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-terminalHideDelay)
|
|
1275
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-terminalHideDelay)
|
|
1353
1276
|
*/
|
|
1354
1277
|
terminalHideDelay ? : number
|
|
1355
1278
|
/**
|
|
1356
1279
|
* Terminal offset from their initial position, in px. Positive values move terminals further away from the
|
|
1357
1280
|
* event bar, negative values inside the event bar.
|
|
1358
|
-
* ...
|
|
1359
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-terminalOffset)
|
|
1281
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-terminalOffset)
|
|
1360
1282
|
*/
|
|
1361
1283
|
terminalOffset ? : number
|
|
1362
1284
|
/**
|
|
1363
1285
|
* Delay in ms before showing the terminals when hovering over an event bar.
|
|
1364
|
-
* ...
|
|
1365
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-terminalShowDelay)
|
|
1286
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-terminalShowDelay)
|
|
1366
1287
|
*/
|
|
1367
1288
|
terminalShowDelay ? : number
|
|
1368
1289
|
/**
|
|
@@ -1372,14 +1293,12 @@ export declare type BryntumSchedulerProps = {
|
|
|
1372
1293
|
terminalSides ? : string[]
|
|
1373
1294
|
/**
|
|
1374
1295
|
* Terminal diameter in px, overrides the default CSS value for it (which might depend on theme).
|
|
1375
|
-
* ...
|
|
1376
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-terminalSize)
|
|
1296
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-terminalSize)
|
|
1377
1297
|
*/
|
|
1378
1298
|
terminalSize ? : number|string
|
|
1379
1299
|
/**
|
|
1380
1300
|
* The width/height (depending on vertical / horizontal mode) of all the time columns.
|
|
1381
|
-
* ...
|
|
1382
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-tickSize)
|
|
1301
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-tickSize)
|
|
1383
1302
|
*/
|
|
1384
1303
|
tickSize ? : number
|
|
1385
1304
|
/**
|
|
@@ -1400,35 +1319,30 @@ export declare type BryntumSchedulerProps = {
|
|
|
1400
1319
|
/**
|
|
1401
1320
|
* Gets/sets the current time resolution object, which contains a unit identifier and an increment count
|
|
1402
1321
|
* `{ unit, increment }`. This value means minimal task duration you can create using UI.
|
|
1403
|
-
* ...
|
|
1404
|
-
*
|
|
1322
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-timeResolution)
|
|
1323
|
+
* @property {number} increment The increment in the specified unit
|
|
1324
|
+
* @property {DurationUnit} unit The time resolution unit
|
|
1405
1325
|
*/
|
|
1406
|
-
timeResolution ? :
|
|
1407
|
-
increment?: number
|
|
1408
|
-
unit?: DurationUnit
|
|
1409
|
-
}|number
|
|
1326
|
+
timeResolution ? : object|number
|
|
1410
1327
|
/**
|
|
1411
1328
|
* Set to a time zone or a UTC offset. This will set the projects
|
|
1412
1329
|
* [timeZone](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/ProjectModel#config-timeZone) config accordingly. As this config is only a referer,
|
|
1413
1330
|
* please see project's config [documentation](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/ProjectModel#config-timeZone) for more
|
|
1414
1331
|
* information.
|
|
1415
|
-
* ...
|
|
1416
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-timeZone)
|
|
1332
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-timeZone)
|
|
1417
1333
|
*/
|
|
1418
1334
|
timeZone ? : string|number
|
|
1419
1335
|
/**
|
|
1420
1336
|
* A title to display in the header or owning TabPanel. Causes creation and docking of a header
|
|
1421
1337
|
* to the top if no header is configured.
|
|
1422
|
-
* ...
|
|
1423
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-title)
|
|
1338
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-title)
|
|
1424
1339
|
*/
|
|
1425
1340
|
title ? : string
|
|
1426
1341
|
/**
|
|
1427
1342
|
* 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
|
|
1428
1343
|
* property name is the reference by which an instantiated tool may be retrieved from the live
|
|
1429
1344
|
* `[tools](https://bryntum.com/products/scheduler/docs/api/Core/widget/mixin/Toolable#property-tools)` property.
|
|
1430
|
-
* ...
|
|
1431
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-tools)
|
|
1345
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-tools)
|
|
1432
1346
|
*/
|
|
1433
1347
|
tools ? : Record<string, ToolConfig>|null
|
|
1434
1348
|
/**
|
|
@@ -1440,19 +1354,18 @@ export declare type BryntumSchedulerProps = {
|
|
|
1440
1354
|
tooltipTemplate ? : (dependency: DependencyBaseModel) => string|DomConfig
|
|
1441
1355
|
/**
|
|
1442
1356
|
* Configure UI transitions for various actions in the grid.
|
|
1443
|
-
|
|
1444
|
-
|
|
1445
|
-
|
|
1446
|
-
|
|
1447
|
-
|
|
1448
|
-
|
|
1449
|
-
|
|
1450
|
-
|
|
1451
|
-
|
|
1452
|
-
|
|
1453
|
-
|
|
1454
|
-
|
|
1455
|
-
}
|
|
1357
|
+
* @property {boolean} insertRecord Transition record insertions
|
|
1358
|
+
* @property {boolean} removeRecord Transition record removals
|
|
1359
|
+
* @property {boolean} toggleColumn Transition column visibility changes
|
|
1360
|
+
* @property {boolean} expandCollapseColumn Transition parent/group column expand/collapse
|
|
1361
|
+
* @property {boolean} toggleRegion Transition region expand/collapse
|
|
1362
|
+
* @property {boolean} toggleTreeNode Transition tree node expand/collapse
|
|
1363
|
+
* @property {boolean} toggleGroup Transition group expand/collapse
|
|
1364
|
+
* @property {boolean} filterRemoval Transition row removals caused by filtering (under specific conditions)
|
|
1365
|
+
* @property {boolean} removeEvent Transition event removals
|
|
1366
|
+
* @property {boolean} changeEvent Transition event changes
|
|
1367
|
+
*/
|
|
1368
|
+
transition ? : object
|
|
1456
1369
|
/**
|
|
1457
1370
|
* Animation transition duration in milliseconds.
|
|
1458
1371
|
*/
|
|
@@ -1466,8 +1379,7 @@ export declare type BryntumSchedulerProps = {
|
|
|
1466
1379
|
* Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
|
|
1467
1380
|
* as a space separated string, an array of strings, or as an object in which property names with truthy
|
|
1468
1381
|
* values are used as the class names.
|
|
1469
|
-
* ...
|
|
1470
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-ui)
|
|
1382
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-ui)
|
|
1471
1383
|
*/
|
|
1472
1384
|
ui ? : 'plain'|'toolbar'|string|object
|
|
1473
1385
|
/**
|
|
@@ -1481,35 +1393,30 @@ export declare type BryntumSchedulerProps = {
|
|
|
1481
1393
|
* By default, the day of week and week of month of the event's start date are used to create
|
|
1482
1394
|
* helpful contextual recurrence types when editing a non-recurring event record and choosing
|
|
1483
1395
|
* an initial recurrence type.
|
|
1484
|
-
* ...
|
|
1485
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-useContextualRecurrenceRules)
|
|
1396
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-useContextualRecurrenceRules)
|
|
1486
1397
|
*/
|
|
1487
1398
|
useContextualRecurrenceRules ? : Boolean
|
|
1488
1399
|
/**
|
|
1489
1400
|
* By default, scheduler fade events in on load. Specify `false` to prevent this animation or specify one
|
|
1490
1401
|
* of the available animation types to use it (`true` equals `'fade-in'`):
|
|
1491
|
-
* ...
|
|
1492
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-useInitialAnimation)
|
|
1402
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-useInitialAnimation)
|
|
1493
1403
|
*/
|
|
1494
1404
|
useInitialAnimation ? : Boolean|'fade-in'|'slide-from-left'|'slide-from-top'|string
|
|
1495
1405
|
/**
|
|
1496
1406
|
* The time axis column config for vertical [mode](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/SchedulerBase#config-mode).
|
|
1497
|
-
* ...
|
|
1498
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-verticalTimeAxisColumn)
|
|
1407
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-verticalTimeAxisColumn)
|
|
1499
1408
|
*/
|
|
1500
1409
|
verticalTimeAxisColumn ? : VerticalTimeAxisColumnConfig
|
|
1501
1410
|
/**
|
|
1502
|
-
* A string key used to
|
|
1503
|
-
* managed by [PresetManager](https://bryntum.com/products/scheduler/docs/api/Scheduler/preset/PresetManager). See [PresetManager](#Scheduler/preset/PresetManager)
|
|
1504
|
-
* Or a config object for a viewPreset.
|
|
1505
|
-
* ...
|
|
1506
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-viewPreset)
|
|
1411
|
+
* A string key used to look up a predefined [ViewPreset](https://bryntum.com/products/scheduler/docs/api/Scheduler/preset/ViewPreset) (e.g. 'weekAndDay',
|
|
1412
|
+
* 'hourAndDay'), managed by [PresetManager](https://bryntum.com/products/scheduler/docs/api/Scheduler/preset/PresetManager). See [PresetManager](#Scheduler/preset/PresetManager)
|
|
1413
|
+
* for more information. Or a config object for a viewPreset.
|
|
1414
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-viewPreset)
|
|
1507
1415
|
*/
|
|
1508
1416
|
viewPreset ? : string|ViewPresetConfig
|
|
1509
1417
|
/**
|
|
1510
1418
|
* A date to bring into view initially on the scrollable timeline.
|
|
1511
|
-
* ...
|
|
1512
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-visibleDate)
|
|
1419
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-visibleDate)
|
|
1513
1420
|
*/
|
|
1514
1421
|
visibleDate ? : Date|VisibleDate
|
|
1515
1422
|
/**
|
|
@@ -1537,15 +1444,19 @@ export declare type BryntumSchedulerProps = {
|
|
|
1537
1444
|
/**
|
|
1538
1445
|
* An object with format `{ fromDay, toDay, fromHour, toHour }` that describes the working days and hours.
|
|
1539
1446
|
* This object will be used to populate TimeAxis [include](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/TimeAxis#config-include) property.
|
|
1540
|
-
* ...
|
|
1541
|
-
*
|
|
1447
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-workingTime)
|
|
1448
|
+
* @property {number} workingTime.fromDay Day index 0-6 (0 is Sunday)
|
|
1449
|
+
* @property {number} workingTime.toDay Day index 0-6 (0 is Sunday)
|
|
1450
|
+
* @property {number} workingTime.fromHour 0-23
|
|
1451
|
+
* @property {number} workingTime.toHour 0-23
|
|
1452
|
+
*/
|
|
1453
|
+
workingTime ? : { fromDay: number, toDay: number, fromHour: number, toHour: number }
|
|
1454
|
+
/**
|
|
1455
|
+
* Factor multiplied with wheel delta to calculate smooth zoom level changes when zooming with mouse wheel or
|
|
1456
|
+
* trackpad pinch gestures. A higher value means faster zooming.
|
|
1457
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-zoomFactor)
|
|
1542
1458
|
*/
|
|
1543
|
-
|
|
1544
|
-
fromDay?: number
|
|
1545
|
-
toDay?: number
|
|
1546
|
-
fromHour?: number
|
|
1547
|
-
toHour?: number
|
|
1548
|
-
}
|
|
1459
|
+
zoomFactor ? : number
|
|
1549
1460
|
/**
|
|
1550
1461
|
* Whether the originally rendered timespan should be preserved while zooming. By default, it is set to `false`,
|
|
1551
1462
|
* meaning the timeline panel will adjust the currently rendered timespan to limit the amount of HTML content to
|
|
@@ -1555,11 +1466,11 @@ export declare type BryntumSchedulerProps = {
|
|
|
1555
1466
|
*/
|
|
1556
1467
|
zoomKeepsOriginalTimespan ? : Boolean
|
|
1557
1468
|
/**
|
|
1558
|
-
* If true
|
|
1469
|
+
* If `true`, you can zoom in and out on the time axis using <kbd>CTRL</kbd> + mouse wheel.
|
|
1559
1470
|
*/
|
|
1560
1471
|
zoomOnMouseWheel ? : Boolean
|
|
1561
1472
|
/**
|
|
1562
|
-
*
|
|
1473
|
+
* If `true`, you can zoom to a time span by double-clicking a time axis cell.
|
|
1563
1474
|
*/
|
|
1564
1475
|
zoomOnTimeAxisDoubleClick ? : Boolean
|
|
1565
1476
|
|
|
@@ -1569,224 +1480,199 @@ export declare type BryntumSchedulerProps = {
|
|
|
1569
1480
|
* to send messages to the agent and see the responses. Which allows the user to use natural language to interact with
|
|
1570
1481
|
* the Scheduler in different ways. For example, the user can ask the agent to filter the data, sort it, or select
|
|
1571
1482
|
* specific records. The agent can also perform data manipulation operations such as adding, updating, deleting records.
|
|
1572
|
-
* ...
|
|
1573
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/AI)
|
|
1483
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/AI)
|
|
1574
1484
|
*/
|
|
1575
1485
|
aiFeature ? : object|Boolean|string|AI|AIConfig
|
|
1576
1486
|
/**
|
|
1577
1487
|
* AI-powered filter feature for Grid. Allows users to type natural language queries to filter grid data.
|
|
1578
|
-
* ...
|
|
1579
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/ai/AIFilter)
|
|
1488
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/ai/AIFilter)
|
|
1580
1489
|
*/
|
|
1581
1490
|
aiFilterFeature ? : object|Boolean|string|AIFilter|AIFilterConfig
|
|
1582
1491
|
/**
|
|
1583
1492
|
* Allows using `[Ctrl/CMD + C]`, `[Ctrl/CMD + X]` and `[Ctrl/CMD + V]` to cut, copy and paste cell or cell ranges. Also
|
|
1584
1493
|
* makes cut, copy and paste actions available via the cell context menu.
|
|
1585
|
-
* ...
|
|
1586
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/CellCopyPaste)
|
|
1494
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/CellCopyPaste)
|
|
1587
1495
|
*/
|
|
1588
1496
|
cellCopyPasteFeature ? : object|Boolean|string|CellCopyPaste|CellCopyPasteConfig
|
|
1589
1497
|
/**
|
|
1590
1498
|
* Adding this feature to the grid and other Bryntum products which are based on the Grid (i.e. Scheduler, SchedulerPro, and Gantt)
|
|
1591
1499
|
* enables cell editing. Any subclass of [Field](https://bryntum.com/products/scheduler/docs/api/Core/widget/Field) can be used
|
|
1592
1500
|
* as editor for the [Column](https://bryntum.com/products/scheduler/docs/api/Grid/column/Column). The most popular are:
|
|
1593
|
-
* ...
|
|
1594
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/CellEdit)
|
|
1501
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/CellEdit)
|
|
1595
1502
|
*/
|
|
1596
1503
|
cellEditFeature ? : object|Boolean|string|CellEdit|CellEditConfig
|
|
1597
1504
|
/**
|
|
1598
1505
|
* Right click to display context menu for cells. To invoke the cell menu in a keyboard-accessible manner, use the
|
|
1599
1506
|
* <kbd>Space</kbd> key when the cell is focused.
|
|
1600
|
-
* ...
|
|
1601
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/CellMenu)
|
|
1507
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/CellMenu)
|
|
1602
1508
|
*/
|
|
1603
1509
|
cellMenuFeature ? : object|Boolean|string|CellMenu|CellMenuConfig
|
|
1604
1510
|
/**
|
|
1605
1511
|
* Displays a tooltip when hovering cells.
|
|
1606
|
-
* ...
|
|
1607
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/CellTooltip)
|
|
1512
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/CellTooltip)
|
|
1608
1513
|
*/
|
|
1609
1514
|
cellTooltipFeature ? : object|Boolean|string|CellTooltip|CellTooltipConfig
|
|
1610
1515
|
/**
|
|
1611
1516
|
* 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
|
|
1612
1517
|
* and updated in realtime as data changes. Supports many common chart types with extensive styling and customization
|
|
1613
1518
|
* options.
|
|
1614
|
-
* ...
|
|
1615
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Charts)
|
|
1519
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Charts)
|
|
1616
1520
|
*/
|
|
1617
1521
|
chartsFeature ? : object|Boolean|string|Charts|ChartsConfig
|
|
1618
1522
|
/**
|
|
1619
|
-
* Enables the [autoWidth](https://bryntum.com/products/scheduler/docs/api/Grid/column/Column#config-autoWidth) config for a grid's columns.
|
|
1620
|
-
*
|
|
1621
|
-
*
|
|
1523
|
+
* Enables the [autoWidth](https://bryntum.com/products/scheduler/docs/api/Grid/column/Column#config-autoWidth) config for a grid's columns. When a column
|
|
1524
|
+
* has `autoWidth` set, this feature measures the rendered content of all visible cells in that column
|
|
1525
|
+
* and adjusts the column width to fit. The measurement is triggered automatically when data changes
|
|
1526
|
+
* or rows are rendered.
|
|
1527
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/ColumnAutoWidth)
|
|
1622
1528
|
*/
|
|
1623
1529
|
columnAutoWidthFeature ? : object|Boolean|string|ColumnAutoWidth|ColumnAutoWidthConfig
|
|
1624
1530
|
/**
|
|
1625
1531
|
* Displays a toolbar while dragging column headers. Drop on a button in the toolbar to activate a certain function,
|
|
1626
1532
|
* for example to group by that column. This feature simplifies certain operations on touch devices.
|
|
1627
|
-
* ...
|
|
1628
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/ColumnDragToolbar)
|
|
1533
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/ColumnDragToolbar)
|
|
1629
1534
|
*/
|
|
1630
1535
|
columnDragToolbarFeature ? : object|Boolean|string|ColumnDragToolbar|ColumnDragToolbarConfig
|
|
1631
1536
|
/**
|
|
1632
1537
|
* Displays column lines for ticks, with a different styling for major ticks (by default they are darker). If this
|
|
1633
1538
|
* feature is disabled, no lines are shown. If it's enabled, line are shown for the tick level which is set in current
|
|
1634
1539
|
* ViewPreset. Please see [columnLinesFor](https://bryntum.com/products/scheduler/docs/api/Scheduler/preset/ViewPreset#field-columnLinesFor) config for details.
|
|
1635
|
-
* ...
|
|
1636
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ColumnLines)
|
|
1540
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ColumnLines)
|
|
1637
1541
|
*/
|
|
1638
1542
|
columnLinesFeature ? : object|Boolean|string|ColumnLines|ColumnLinesConfig
|
|
1639
1543
|
/**
|
|
1640
1544
|
* Displays a column picker (to show/hide columns) in the header context menu. Columns can be displayed in sub menus
|
|
1641
1545
|
* by region or tag. Grouped headers are displayed as menu hierarchies.
|
|
1642
|
-
* ...
|
|
1643
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/ColumnPicker)
|
|
1546
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/ColumnPicker)
|
|
1644
1547
|
*/
|
|
1645
1548
|
columnPickerFeature ? : object|Boolean|string|ColumnPicker|ColumnPickerConfig
|
|
1646
1549
|
/**
|
|
1647
1550
|
* Allows user to rename columns by either right-clicking column header or using keyboard shortcuts when column header
|
|
1648
1551
|
* is focused.
|
|
1649
|
-
* ...
|
|
1650
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/ColumnRename)
|
|
1552
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/ColumnRename)
|
|
1651
1553
|
*/
|
|
1652
1554
|
columnRenameFeature ? : object|Boolean|string|ColumnRename|ColumnRenameConfig
|
|
1653
1555
|
/**
|
|
1654
|
-
* Allows user to reorder columns by dragging headers.
|
|
1655
|
-
*
|
|
1656
|
-
*
|
|
1657
|
-
* [
|
|
1556
|
+
* Allows user to reorder columns by dragging headers. Click and drag a column header to move it to a new position.
|
|
1557
|
+
* Visual feedback shows the drop target while dragging. To get notified about column reorder, listen to the
|
|
1558
|
+
* `change` event on the [columns](https://bryntum.com/products/scheduler/docs/api/Grid/data/ColumnStore) store.
|
|
1559
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/ColumnReorder)
|
|
1658
1560
|
*/
|
|
1659
1561
|
columnReorderFeature ? : object|Boolean|string|ColumnReorder|ColumnReorderConfig
|
|
1660
1562
|
/**
|
|
1661
|
-
* Enables user to resize columns by dragging a handle on the right hand side of the header.
|
|
1662
|
-
*
|
|
1663
|
-
*
|
|
1664
|
-
* [
|
|
1563
|
+
* Enables user to resize columns by dragging a handle on the right hand side of the header. A drag handle
|
|
1564
|
+
* appears when hovering near the right edge of a column header. Dragging it adjusts the column width, respecting
|
|
1565
|
+
* any [minWidth](https://bryntum.com/products/scheduler/docs/api/Grid/column/Column#config-minWidth) or [maxWidth](#Grid/column/Column#config-maxWidth) constraints.
|
|
1566
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/ColumnResize)
|
|
1665
1567
|
*/
|
|
1666
1568
|
columnResizeFeature ? : object|Boolean|string|ColumnResize|ColumnResizeConfig
|
|
1667
1569
|
/**
|
|
1668
1570
|
* Feature that draws dependencies between events. Uses a [DependencyStore](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/DependencyStore) to determine which
|
|
1669
1571
|
* dependencies to draw, if none is defined one will be created automatically. Dependencies can also be specified as
|
|
1670
1572
|
* `scheduler.dependencies`, see example below:
|
|
1671
|
-
* ...
|
|
1672
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Dependencies)
|
|
1573
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Dependencies)
|
|
1673
1574
|
*/
|
|
1674
1575
|
dependenciesFeature ? : object|Boolean|string|Dependencies|DependenciesConfig
|
|
1675
1576
|
/**
|
|
1676
1577
|
* Feature that displays a popup containing fields for editing a dependency. Requires the
|
|
1677
1578
|
* [Dependencies](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Dependencies) feature to be enabled. Double-click a dependency line in the demo below to
|
|
1678
1579
|
* show the editor.
|
|
1679
|
-
* ...
|
|
1680
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/DependencyEdit)
|
|
1580
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/DependencyEdit)
|
|
1681
1581
|
*/
|
|
1682
1582
|
dependencyEditFeature ? : object|Boolean|string|DependencyEdit|DependencyEditConfig
|
|
1683
1583
|
/**
|
|
1684
1584
|
* Displays a context menu when right-clicking dependency lines. Items are populated by other features and/or
|
|
1685
1585
|
* application code.
|
|
1686
|
-
* ...
|
|
1687
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/DependencyMenu)
|
|
1586
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/DependencyMenu)
|
|
1688
1587
|
*/
|
|
1689
1588
|
dependencyMenuFeature ? : object|Boolean|string|DependencyMenu|DependencyMenuConfig
|
|
1690
1589
|
/**
|
|
1691
1590
|
* Allow using <kbd>Ctrl</kbd>/<kbd>Cmd</kbd>+<kbd>C</kbd>, <kbd>Ctrl</kbd>/<kbd>Cmd</kbd>+<kbd>X</kbd> and
|
|
1692
1591
|
* <kbd>Ctrl</kbd>/<kbd>Cmd</kbd>+<kbd>V</kbd> to copy/cut and paste events.
|
|
1693
|
-
* ...
|
|
1694
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/EventCopyPaste)
|
|
1592
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/EventCopyPaste)
|
|
1695
1593
|
*/
|
|
1696
1594
|
eventCopyPasteFeature ? : object|Boolean|string|EventCopyPaste|EventCopyPasteConfig
|
|
1697
1595
|
/**
|
|
1698
1596
|
* Allows user to drag and drop events within the scheduler, to change `startDate` or resource assignment.
|
|
1699
|
-
* ...
|
|
1700
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/EventDrag)
|
|
1597
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/EventDrag)
|
|
1701
1598
|
*/
|
|
1702
1599
|
eventDragFeature ? : object|Boolean|string|EventDrag|EventDragConfig
|
|
1703
1600
|
/**
|
|
1704
1601
|
* Feature that allows the user to create new events by dragging in empty parts of the scheduler rows.
|
|
1705
|
-
* ...
|
|
1706
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/EventDragCreate)
|
|
1602
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/EventDragCreate)
|
|
1707
1603
|
*/
|
|
1708
1604
|
eventDragCreateFeature ? : object|Boolean|string|EventDragCreate|EventDragCreateConfig
|
|
1709
1605
|
/**
|
|
1710
1606
|
* Enables users to click and drag to select events (or assignments in multi assignment mode) inside the Scheduler's
|
|
1711
1607
|
* timeline. Press <kbd>CTRL</kbd>/<kbd>CMD</kbd> to extend an existing selection.
|
|
1712
|
-
* ...
|
|
1713
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/EventDragSelect)
|
|
1608
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/EventDragSelect)
|
|
1714
1609
|
*/
|
|
1715
1610
|
eventDragSelectFeature ? : object|Boolean|string|EventDragSelect|EventDragSelectConfig
|
|
1716
1611
|
/**
|
|
1717
1612
|
* Feature that displays a popup containing widgets for editing event data.
|
|
1718
|
-
* ...
|
|
1719
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/EventEdit)
|
|
1613
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/EventEdit)
|
|
1720
1614
|
*/
|
|
1721
1615
|
eventEditFeature ? : object|Boolean|string|EventEdit|EventEditConfig
|
|
1722
1616
|
/**
|
|
1723
|
-
* Adds event filter menu items to the timeline header context menu.
|
|
1724
|
-
*
|
|
1725
|
-
* [
|
|
1617
|
+
* Adds event filter menu items to the timeline header context menu. Users can type filter text to show
|
|
1618
|
+
* only events whose name matches the query.
|
|
1619
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/EventFilter)
|
|
1726
1620
|
*/
|
|
1727
1621
|
eventFilterFeature ? : object|Boolean|string|EventFilter|EventFilterConfig
|
|
1728
1622
|
/**
|
|
1729
1623
|
* Displays a context menu for events. Items are populated by other features and/or application code.
|
|
1730
|
-
* ...
|
|
1731
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/EventMenu)
|
|
1624
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/EventMenu)
|
|
1732
1625
|
*/
|
|
1733
1626
|
eventMenuFeature ? : object|Boolean|string|EventMenu|EventMenuConfig
|
|
1734
1627
|
/**
|
|
1735
1628
|
* Feature that allows rendering non-working time ranges into event bars (weekends for Scheduler, effective calendar for
|
|
1736
1629
|
* SchedulerPro):
|
|
1737
|
-
* ...
|
|
1738
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/EventNonWorkingTime)
|
|
1630
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/EventNonWorkingTime)
|
|
1739
1631
|
*/
|
|
1740
1632
|
eventNonWorkingTimeFeature ? : object|Boolean|string|EventNonWorkingTime|EventNonWorkingTimeConfig
|
|
1741
1633
|
/**
|
|
1742
1634
|
* Feature that allows resizing an event by dragging its end.
|
|
1743
|
-
* ...
|
|
1744
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/EventResize)
|
|
1635
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/EventResize)
|
|
1745
1636
|
*/
|
|
1746
1637
|
eventResizeFeature ? : object|Boolean|string|EventResize|EventResizeConfig
|
|
1747
1638
|
/**
|
|
1748
1639
|
* Displays a tooltip when hovering events. The template used to render the tooltip can be customized, see [template](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/EventTooltip#config-template).
|
|
1749
1640
|
* Config options are also applied to the tooltip shown, see [Tooltip](https://bryntum.com/products/scheduler/docs/api/Core/widget/Tooltip) for available options.
|
|
1750
|
-
* ...
|
|
1751
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/EventTooltip)
|
|
1641
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/EventTooltip)
|
|
1752
1642
|
*/
|
|
1753
1643
|
eventTooltipFeature ? : object|Boolean|string|EventTooltip|EventTooltipConfig
|
|
1754
1644
|
/**
|
|
1755
1645
|
* A feature that allows exporting Scheduler data to Excel or CSV without involving the server. It uses
|
|
1756
1646
|
* [TableExporter](https://bryntum.com/products/scheduler/docs/api/Grid/util/TableExporter) class as data provider, 3rd party provider to generate XLS files, and
|
|
1757
1647
|
* [Microsoft XML specification](https://msdn.microsoft.com/en-us/library/office/documentformat.openxml.spreadsheet.aspx).
|
|
1758
|
-
* ...
|
|
1759
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/experimental/ExcelExporter)
|
|
1648
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/experimental/ExcelExporter)
|
|
1760
1649
|
*/
|
|
1761
1650
|
excelExporterFeature ? : object|Boolean|string|ExcelExporter|ExcelExporterConfig
|
|
1762
1651
|
/**
|
|
1763
|
-
* An experimental feature that lets users drop files on a Widget. The widget fires
|
|
1764
|
-
* In the event, you get access to the raw
|
|
1765
|
-
*
|
|
1766
|
-
* [
|
|
1652
|
+
* An experimental feature that lets users drop files on a Widget. The widget fires a
|
|
1653
|
+
* [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
|
|
1654
|
+
* files as strings, that were parsed by calling `readAsBinaryString`.
|
|
1655
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/experimental/FileDrop)
|
|
1767
1656
|
*/
|
|
1768
1657
|
fileDropFeature ? : object|Boolean|string|FileDrop|FileDropConfig
|
|
1769
1658
|
/**
|
|
1770
1659
|
* This feature adds a fill handle to a Grid range selection, which when dragged, fills the cells being dragged over
|
|
1771
1660
|
* with values based on the values in the original selected range. This is similar to functionality normally seen in
|
|
1772
1661
|
* various spreadsheet applications.
|
|
1773
|
-
* ...
|
|
1774
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/FillHandle)
|
|
1662
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/FillHandle)
|
|
1775
1663
|
*/
|
|
1776
1664
|
fillHandleFeature ? : object|Boolean|string|FillHandle|FillHandleConfig
|
|
1777
1665
|
/**
|
|
1778
1666
|
* Feature that allows filtering of the grid by settings filters on columns. The actual filtering is done by the store.
|
|
1779
1667
|
* For info on programmatically handling filters, see [StoreFilter](https://bryntum.com/products/scheduler/docs/api/Core/data/mixin/StoreFilter).
|
|
1780
|
-
* ...
|
|
1781
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Filter)
|
|
1668
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Filter)
|
|
1782
1669
|
*/
|
|
1783
1670
|
filterFeature ? : object|Boolean|string|Filter|FilterConfig
|
|
1784
1671
|
/**
|
|
1785
1672
|
* Feature that allows filtering of the grid by entering filters on column headers.
|
|
1786
1673
|
* The actual filtering is done by the store.
|
|
1787
1674
|
* For info on programmatically handling filters, see [StoreFilter](https://bryntum.com/products/scheduler/docs/api/Core/data/mixin/StoreFilter).
|
|
1788
|
-
* ...
|
|
1789
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/FilterBar)
|
|
1675
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/FilterBar)
|
|
1790
1676
|
*/
|
|
1791
1677
|
filterBarFeature ? : object|Boolean|string|FilterBar|FilterBarConfig
|
|
1792
1678
|
/**
|
|
@@ -1794,142 +1680,122 @@ export declare type BryntumSchedulerProps = {
|
|
|
1794
1680
|
* <kbd>Shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
|
|
1795
1681
|
* one anywhere on grid). Use <kbd>Shift</kbd> + <kbd>Alt</kbd> + click, or the context menu, to remove a column
|
|
1796
1682
|
* grouper.
|
|
1797
|
-
* ...
|
|
1798
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Group)
|
|
1683
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Group)
|
|
1799
1684
|
*/
|
|
1800
1685
|
groupFeature ? : object|Boolean|string|Group|GroupConfig
|
|
1801
1686
|
/**
|
|
1802
1687
|
* A special version of the Grid GroupSummary feature that enables summaries within scheduler. To use a single summary
|
|
1803
1688
|
* 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).
|
|
1804
|
-
* ...
|
|
1805
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/GroupSummary)
|
|
1689
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/GroupSummary)
|
|
1806
1690
|
*/
|
|
1807
1691
|
groupSummaryFeature ? : object|Boolean|string|GroupSummary|GroupSummaryConfig
|
|
1808
1692
|
/**
|
|
1809
1693
|
* Right click column header or focus it and press SPACE key to show the context menu for headers.
|
|
1810
|
-
* ...
|
|
1811
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/HeaderMenu)
|
|
1694
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/HeaderMenu)
|
|
1812
1695
|
*/
|
|
1813
1696
|
headerMenuFeature ? : object|Boolean|string|HeaderMenu|HeaderMenuConfig
|
|
1814
1697
|
/**
|
|
1815
1698
|
* Enables users to click and drag to zoom to a date range in Scheduler's header time axis. Only supported in horizontal
|
|
1816
1699
|
* mode.
|
|
1817
|
-
* ...
|
|
1818
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/HeaderZoom)
|
|
1700
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/HeaderZoom)
|
|
1819
1701
|
*/
|
|
1820
1702
|
headerZoomFeature ? : object|Boolean|string|HeaderZoom|HeaderZoomConfig
|
|
1821
1703
|
/**
|
|
1822
1704
|
* Displays labels at positions [top](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Labels#config-top), [right](#Scheduler/feature/Labels#config-right), [bottom](#Scheduler/feature/Labels#config-bottom) and
|
|
1823
1705
|
* [left](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Labels#config-left).
|
|
1824
|
-
* ...
|
|
1825
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Labels)
|
|
1706
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Labels)
|
|
1826
1707
|
*/
|
|
1827
1708
|
labelsFeature ? : object|Boolean|string|Labels|LabelsConfig
|
|
1828
1709
|
/**
|
|
1829
1710
|
* This feature allows resources which satisfy a certain condition to be locked at the top of the scheduler.
|
|
1830
|
-
* ...
|
|
1831
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/LockRows)
|
|
1711
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/LockRows)
|
|
1832
1712
|
*/
|
|
1833
1713
|
lockRowsFeature ? : object|Boolean|string|LockRows|LockRowsConfig
|
|
1834
1714
|
/**
|
|
1835
1715
|
* 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
|
|
1836
1716
|
* configured to [mergeCells](https://bryntum.com/products/scheduler/docs/api/Grid/column/Column#config-mergeCells).
|
|
1837
|
-
* ...
|
|
1838
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/MergeCells)
|
|
1717
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/MergeCells)
|
|
1839
1718
|
*/
|
|
1840
1719
|
mergeCellsFeature ? : object|Boolean|string|MergeCells|MergeCellsConfig
|
|
1841
1720
|
/**
|
|
1842
1721
|
* Feature that allows styling of weekends (and other non-working time) by adding timeRanges for those days.
|
|
1843
|
-
* ...
|
|
1844
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/NonWorkingTime)
|
|
1722
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/NonWorkingTime)
|
|
1845
1723
|
*/
|
|
1846
1724
|
nonWorkingTimeFeature ? : object|Boolean|string|NonWorkingTime|NonWorkingTimeConfig
|
|
1847
1725
|
/**
|
|
1848
1726
|
* Makes the scheduler's timeline pannable by dragging with the mouse. Try it out in the demo below.
|
|
1849
|
-
* ...
|
|
1850
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Pan)
|
|
1727
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Pan)
|
|
1851
1728
|
*/
|
|
1852
1729
|
panFeature ? : object|Boolean|string|Pan|PanConfig
|
|
1853
1730
|
/**
|
|
1854
1731
|
* Generates PDF/PNG files from the Scheduler component.
|
|
1855
|
-
* ...
|
|
1856
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/export/PdfExport)
|
|
1732
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/export/PdfExport)
|
|
1857
1733
|
*/
|
|
1858
1734
|
pdfExportFeature ? : object|Boolean|string|PdfExport|PdfExportConfig
|
|
1859
1735
|
/**
|
|
1860
1736
|
* Allows pinning columns to the start or end region of the grid without any additional subGrid configurations.
|
|
1861
1737
|
* When pinning to a region that does not yet exist, the feature creates the required subGrid on the fly.
|
|
1862
|
-
* ...
|
|
1863
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/PinColumns)
|
|
1738
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/PinColumns)
|
|
1864
1739
|
*/
|
|
1865
1740
|
pinColumnsFeature ? : object|Boolean|string|PinColumns|PinColumnsConfig
|
|
1866
1741
|
/**
|
|
1867
1742
|
* Allows printing Scheduler contents using browser print dialog.
|
|
1868
|
-
* ...
|
|
1869
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/export/Print)
|
|
1743
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/export/Print)
|
|
1870
1744
|
*/
|
|
1871
1745
|
printFeature ? : object|Boolean|string|Print|PrintConfig
|
|
1872
1746
|
/**
|
|
1873
1747
|
* Feature that allows the user to search in a column by focusing a cell and typing. Navigate between hits using the
|
|
1874
|
-
* keyboard,
|
|
1875
|
-
*
|
|
1876
|
-
* [
|
|
1748
|
+
* keyboard, <kbd>f3</kbd> or <kbd>ctrl</kbd>/<kbd>cmd</kbd> + <kbd>g</kbd> moves to next, also pressing
|
|
1749
|
+
* <kbd>shift</kbd> moves to previous.
|
|
1750
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/QuickFind)
|
|
1877
1751
|
*/
|
|
1878
1752
|
quickFindFeature ? : object|Boolean|string|QuickFind|QuickFindConfig
|
|
1879
1753
|
/**
|
|
1880
1754
|
* Makes the splitter between grid [sections](https://bryntum.com/products/scheduler/docs/api/Grid/view/SubGrid) draggable, to let users resize, and
|
|
1881
1755
|
* collapse/expand the sections.
|
|
1882
|
-
* ...
|
|
1883
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/RegionResize)
|
|
1756
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/RegionResize)
|
|
1884
1757
|
*/
|
|
1885
1758
|
regionResizeFeature ? : object|Boolean|string|RegionResize|RegionResizeConfig
|
|
1886
1759
|
/**
|
|
1887
1760
|
* Allows user to reorder resource columns in vertical mode by dragging them. The feature fires various events
|
|
1888
1761
|
* during the drag operation (see events below). To get notified about the actual resource reorder, you can also
|
|
1889
1762
|
* listen to the `change` event on the scheduler [ResourceStore](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/ResourceStore).
|
|
1890
|
-
* ...
|
|
1891
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ResourceColumnReorder)
|
|
1763
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ResourceColumnReorder)
|
|
1892
1764
|
*/
|
|
1893
1765
|
resourceColumnReorderFeature ? : object|Boolean|string|ResourceColumnReorder|ResourceColumnReorderConfig
|
|
1894
1766
|
/**
|
|
1895
1767
|
* Applicable only for Scheduler in `vertical` mode. Right click resource header cells to display a context menu.
|
|
1896
|
-
* ...
|
|
1897
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ResourceMenu)
|
|
1768
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ResourceMenu)
|
|
1898
1769
|
*/
|
|
1899
1770
|
resourceMenuFeature ? : object|Boolean|string|ResourceMenu|ResourceMenuConfig
|
|
1900
1771
|
/**
|
|
1901
1772
|
* Feature that draws resource time ranges, shaded areas displayed behind events. These zones are similar to events in
|
|
1902
1773
|
* that they have a start and end date but different in that they do not take part in the event layout, and they always
|
|
1903
1774
|
* occupy full row height.
|
|
1904
|
-
* ...
|
|
1905
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ResourceTimeRanges)
|
|
1775
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ResourceTimeRanges)
|
|
1906
1776
|
*/
|
|
1907
1777
|
resourceTimeRangesFeature ? : object|Boolean|string|ResourceTimeRanges|ResourceTimeRangesConfig
|
|
1908
1778
|
/**
|
|
1909
1779
|
* Allow using [Ctrl/CMD + C/X] and [Ctrl/CMD + V] to copy/cut-and-paste rows. Also makes cut, copy and paste actions
|
|
1910
1780
|
* available via the cell context menu.
|
|
1911
|
-
* ...
|
|
1912
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/RowCopyPaste)
|
|
1781
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/RowCopyPaste)
|
|
1913
1782
|
*/
|
|
1914
1783
|
rowCopyPasteFeature ? : object|Boolean|string|RowCopyPaste|RowCopyPasteConfig
|
|
1915
1784
|
/**
|
|
1916
1785
|
* This feature allows editing of entire rows in a grid in a docked panel which by default slides out from the right.
|
|
1917
|
-
* ...
|
|
1918
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/RowEdit)
|
|
1786
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/RowEdit)
|
|
1919
1787
|
*/
|
|
1920
1788
|
rowEditFeature ? : object|Boolean|string|RowEdit|RowEditConfig
|
|
1921
1789
|
/**
|
|
1922
1790
|
* Enables expanding of Grid rows by either row click or double click, or by adding a separate Grid column which renders
|
|
1923
1791
|
* a button that expands or collapses the row.
|
|
1924
|
-
* ...
|
|
1925
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/RowExpander)
|
|
1792
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/RowExpander)
|
|
1926
1793
|
*/
|
|
1927
1794
|
rowExpanderFeature ? : object|Boolean|string|RowExpander|RowExpanderConfig
|
|
1928
1795
|
/**
|
|
1929
1796
|
* This feature implements support for project transactions and used by default in Gantt. For general RowReorder feature
|
|
1930
1797
|
* documentation see [RowReorder](https://bryntum.com/products/scheduler/docs/api/Grid/feature/RowReorder).
|
|
1931
|
-
* ...
|
|
1932
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/RowReorder)
|
|
1798
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/RowReorder)
|
|
1933
1799
|
*/
|
|
1934
1800
|
rowReorderFeature ? : object|Boolean|string|RowReorder|RowReorderConfig
|
|
1935
1801
|
/**
|
|
@@ -1937,94 +1803,83 @@ export declare type BryntumSchedulerProps = {
|
|
|
1937
1803
|
* field of the record is updated (when [applyToAllRows](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/RowResize#config-applyToAllRows) is `false`) and the [eventLayout](#Scheduler/model/ResourceModel#field-eventLayout) of the dragged resource
|
|
1938
1804
|
* row will be switched to `pack` as a result (only applies when `stack` is used by default).
|
|
1939
1805
|
* `barMargin` and `resourceMargin` will also be shrunk as you reduce the height of a row.
|
|
1940
|
-
* ...
|
|
1941
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/RowResize)
|
|
1806
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/RowResize)
|
|
1942
1807
|
*/
|
|
1943
1808
|
rowResizeFeature ? : object|Boolean|string|RowResize|RowResizeConfig
|
|
1944
1809
|
/**
|
|
1945
1810
|
* Allow visually selecting a schedule "cell" by clicking, or [any other pointer gesture](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ScheduleContext#config-triggerEvent).
|
|
1946
|
-
* ...
|
|
1947
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ScheduleContext)
|
|
1811
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ScheduleContext)
|
|
1948
1812
|
*/
|
|
1949
1813
|
scheduleContextFeature ? : object|Boolean|string|ScheduleContext|ScheduleContextConfig
|
|
1950
1814
|
/**
|
|
1951
1815
|
* Displays a context menu for empty parts of the schedule. Items are populated in the first place
|
|
1952
1816
|
* by configurations of this Feature, then by other features and/or application code.
|
|
1953
|
-
* ...
|
|
1954
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ScheduleMenu)
|
|
1817
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ScheduleMenu)
|
|
1955
1818
|
*/
|
|
1956
1819
|
scheduleMenuFeature ? : object|Boolean|string|ScheduleMenu|ScheduleMenuConfig
|
|
1957
1820
|
/**
|
|
1958
1821
|
* Feature that displays a tooltip containing the time at the mouse position when hovering empty parts of the schedule.
|
|
1959
|
-
* ...
|
|
1960
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ScheduleTooltip)
|
|
1822
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ScheduleTooltip)
|
|
1961
1823
|
*/
|
|
1962
1824
|
scheduleTooltipFeature ? : object|Boolean|string|ScheduleTooltip|ScheduleTooltipConfig
|
|
1963
1825
|
/**
|
|
1964
1826
|
* This feature injects buttons to the beginning and end of each row that will scroll to the next or previous event
|
|
1965
1827
|
* outside the current view. It can optionally show a label along with the button, using the
|
|
1966
1828
|
* [labelRenderer](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ScrollButtons#config-labelRenderer). Only supported in horizontal [mode](#Scheduler/view/SchedulerBase#config-mode)
|
|
1967
|
-
* ...
|
|
1968
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ScrollButtons)
|
|
1829
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ScrollButtons)
|
|
1969
1830
|
*/
|
|
1970
1831
|
scrollButtonsFeature ? : object|Boolean|string|ScrollButtons|ScrollButtonsConfig
|
|
1971
1832
|
/**
|
|
1972
1833
|
* <div class="external-example vertical" data-file="Grid/feature/Search.js"></div>
|
|
1973
|
-
* ...
|
|
1974
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Search)
|
|
1834
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Search)
|
|
1975
1835
|
*/
|
|
1976
1836
|
searchFeature ? : object|Boolean|string|Search|SearchConfig
|
|
1977
1837
|
/**
|
|
1978
1838
|
* Feature that displays a text field to edit the event name.
|
|
1979
|
-
* ...
|
|
1980
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/SimpleEventEdit)
|
|
1839
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/SimpleEventEdit)
|
|
1981
1840
|
*/
|
|
1982
1841
|
simpleEventEditFeature ? : object|Boolean|string|SimpleEventEdit|SimpleEventEditConfig
|
|
1983
1842
|
/**
|
|
1984
1843
|
* Allows sorting of grid by clicking (or tapping) headers, also displays which columns grid is sorted by (numbered if
|
|
1985
1844
|
* using multisort). Use modifier keys for multisorting: [Ctrl/CMD + click] to add sorter, [Ctrl/CMD + Alt + click] to remove sorter.
|
|
1986
1845
|
* The actual sorting is done by the store, see [Store.sort()](https://bryntum.com/products/scheduler/docs/api/Core/data/mixin/StoreSort#function-sort).
|
|
1987
|
-
* ...
|
|
1988
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Sort)
|
|
1846
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Sort)
|
|
1989
1847
|
*/
|
|
1990
1848
|
sortFeature ? : object|Boolean|string|Sort|SortConfig
|
|
1991
1849
|
/**
|
|
1992
1850
|
* This feature allows splitting the Scheduler into multiple views, either by using the cell context menu, or
|
|
1993
1851
|
* programmatically by calling [split()](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Split#function-split).
|
|
1994
|
-
* ...
|
|
1995
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Split)
|
|
1852
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Split)
|
|
1996
1853
|
*/
|
|
1997
1854
|
splitFeature ? : object|Boolean|string|Split|SplitConfig
|
|
1998
1855
|
/**
|
|
1999
|
-
* A feature which pins
|
|
2000
|
-
*
|
|
2001
|
-
*
|
|
2002
|
-
* [
|
|
1856
|
+
* A feature which pins cell content to the top of the grid while the row scrolls off the top but is still visible. Very
|
|
1857
|
+
* similar to native `position: sticky`, which because of Grid's multiple-region setup unfortunately cannot be used to
|
|
1858
|
+
* achieve the same effect.
|
|
1859
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/StickyCells)
|
|
2003
1860
|
*/
|
|
2004
1861
|
stickyCellsFeature ? : object|Boolean|string|StickyCells|StickyCellsConfig
|
|
2005
1862
|
/**
|
|
2006
1863
|
* This feature applies native `position: sticky` to event contents in horizontal mode, keeping the contents in view as
|
|
2007
1864
|
* long as possible on scroll. For vertical mode it uses a programmatic solution to achieve the same result.
|
|
2008
|
-
* ...
|
|
2009
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/StickyEvents)
|
|
1865
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/StickyEvents)
|
|
2010
1866
|
*/
|
|
2011
1867
|
stickyEventsFeature ? : object|Boolean|string|StickyEvents|StickyEventsConfig
|
|
2012
1868
|
/**
|
|
2013
1869
|
* Stripes rows by adding alternating CSS classes to all row elements (`b-even` and `b-odd`).
|
|
2014
|
-
*
|
|
2015
|
-
*
|
|
1870
|
+
* This improves visual readability in data-heavy grids by giving adjacent rows different background colors.
|
|
1871
|
+
* Style the striped rows using the `.b-even` and `.b-odd` CSS classes.
|
|
1872
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Stripe)
|
|
2016
1873
|
*/
|
|
2017
1874
|
stripeFeature ? : object|Boolean|string|Stripe|StripeConfig
|
|
2018
1875
|
/**
|
|
2019
1876
|
* A special version of the Grid Summary feature. This feature displays a summary row in the grid footer.
|
|
2020
|
-
* ...
|
|
2021
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Summary)
|
|
1877
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Summary)
|
|
2022
1878
|
*/
|
|
2023
1879
|
summaryFeature ? : object|Boolean|string|Summary|SummaryConfig
|
|
2024
1880
|
/**
|
|
2025
1881
|
* Adds scheduler specific menu items to the timeline header context menu.
|
|
2026
|
-
* ...
|
|
2027
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/TimeAxisHeaderMenu)
|
|
1882
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/TimeAxisHeaderMenu)
|
|
2028
1883
|
*/
|
|
2029
1884
|
timeAxisHeaderMenuFeature ? : object|Boolean|string|TimeAxisHeaderMenu|TimeAxisHeaderMenuConfig
|
|
2030
1885
|
/**
|
|
@@ -2032,15 +1887,13 @@ export declare type BryntumSchedulerProps = {
|
|
|
2032
1887
|
* or some important point in time (a `line`, i.e. a range with 0 duration). This feature can also show a current time
|
|
2033
1888
|
* 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
|
|
2034
1889
|
* [cls](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/TimeSpan#field-cls) field of the `TimeSpan` class.
|
|
2035
|
-
* ...
|
|
2036
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/TimeRanges)
|
|
1890
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/TimeRanges)
|
|
2037
1891
|
*/
|
|
2038
1892
|
timeRangesFeature ? : object|Boolean|string|TimeRanges|TimeRangesConfig
|
|
2039
1893
|
/**
|
|
2040
1894
|
* Feature that allows selection of a time span in the time axis header. When a time span is selected in the header,
|
|
2041
1895
|
* a [timeSelectionChange](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/TimeSelection#event-timeSelectionChange) event is fired.
|
|
2042
|
-
* ...
|
|
2043
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/TimeSelection)
|
|
1896
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/TimeSelection)
|
|
2044
1897
|
*/
|
|
2045
1898
|
timeSelectionFeature ? : object|Boolean|string|TimeSelection|TimeSelectionConfig
|
|
2046
1899
|
/**
|
|
@@ -2048,21 +1901,18 @@ export declare type BryntumSchedulerProps = {
|
|
|
2048
1901
|
* 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
|
|
2049
1902
|
* tree renderer that adds padding and icon to give the appearance of a tree. The original renderer is preserved and
|
|
2050
1903
|
* also called.
|
|
2051
|
-
* ...
|
|
2052
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Tree)
|
|
1904
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Tree)
|
|
2053
1905
|
*/
|
|
2054
1906
|
treeFeature ? : object|Boolean|string|Tree|TreeConfig
|
|
2055
1907
|
/**
|
|
2056
1908
|
* A feature that allows transforming a flat dataset (or the leaves of a hierarchical) into a tree by specifying a
|
|
2057
1909
|
* record field per parent level. Parents are generated based on each leaf's value for those fields.
|
|
2058
|
-
* ...
|
|
2059
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/TreeGroup)
|
|
1910
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/TreeGroup)
|
|
2060
1911
|
*/
|
|
2061
1912
|
treeGroupFeature ? : object|Boolean|string|TreeGroup|TreeGroupConfig
|
|
2062
1913
|
/**
|
|
2063
1914
|
* A feature allowing you to roll up and display values in the time axis cell for each parent row in a tree scheduler.
|
|
2064
|
-
* ...
|
|
2065
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/TreeSummary)
|
|
1915
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/TreeSummary)
|
|
2066
1916
|
*/
|
|
2067
1917
|
treeSummaryFeature ? : object|Boolean|string|TreeSummary|TreeSummaryConfig
|
|
2068
1918
|
|