@bryntum/schedulerpro-vue-3-thin 7.1.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 +53 -0
- package/lib/chunks/B12rdbvL.js +380 -0
- package/lib/chunks/B12rdbvL.js.map +1 -0
- package/lib/chunks/BBN-5eeI.js +380 -0
- package/lib/chunks/BBN-5eeI.js.map +1 -0
- package/lib/chunks/BaiH7rub.js +591 -0
- package/lib/chunks/BaiH7rub.js.map +1 -0
- package/lib/chunks/BrUxjEMx.js +380 -0
- package/lib/chunks/BrUxjEMx.js.map +1 -0
- package/lib/chunks/BtVT0xgl.js +344 -0
- package/lib/chunks/BtVT0xgl.js.map +1 -0
- package/lib/chunks/C0N8aq7Y.js +340 -0
- package/lib/chunks/C0N8aq7Y.js.map +1 -0
- package/lib/chunks/C9qY739P.js +380 -0
- package/lib/chunks/C9qY739P.js.map +1 -0
- package/lib/chunks/CB9cdxRl.js +935 -0
- package/lib/chunks/CB9cdxRl.js.map +1 -0
- package/lib/chunks/CDbPwyl3.js +326 -0
- package/lib/chunks/CDbPwyl3.js.map +1 -0
- package/lib/chunks/Ct_m9O9h.js +380 -0
- package/lib/chunks/Ct_m9O9h.js.map +1 -0
- package/lib/chunks/D45V9XRN.js +308 -0
- package/lib/chunks/D45V9XRN.js.map +1 -0
- package/lib/chunks/D6AiSClA.js +1139 -0
- package/lib/chunks/D6AiSClA.js.map +1 -0
- package/lib/chunks/DQYJMaQ_.js +350 -0
- package/lib/chunks/DQYJMaQ_.js.map +1 -0
- package/lib/chunks/DT6XYs9d.js +1356 -0
- package/lib/chunks/DT6XYs9d.js.map +1 -0
- package/lib/chunks/DgESZupU.js +380 -0
- package/lib/chunks/DgESZupU.js.map +1 -0
- package/lib/chunks/DvFm-5Hh.js +382 -0
- package/lib/chunks/DvFm-5Hh.js.map +1 -0
- package/lib/chunks/DzO9n33e.js +939 -0
- package/lib/chunks/DzO9n33e.js.map +1 -0
- package/lib/chunks/H51_wkdg.js +1358 -0
- package/lib/chunks/H51_wkdg.js.map +1 -0
- package/lib/chunks/ggN9GDPJ.js +384 -0
- package/lib/chunks/ggN9GDPJ.js.map +1 -0
- package/lib/chunks/qKNUUeE0.js +380 -0
- package/lib/chunks/qKNUUeE0.js.map +1 -0
- package/lib/chunks/xk_S9thL.js +578 -0
- package/lib/chunks/xk_S9thL.js.map +1 -0
- package/lib/chunks/yCHi3rZC.js +336 -0
- package/lib/chunks/yCHi3rZC.js.map +1 -0
- package/lib/components/BryntumCalendarEditor.js +5 -0
- package/lib/components/BryntumCalendarEditor.js.map +1 -0
- package/lib/components/BryntumCalendarField.js +5 -0
- package/lib/components/BryntumCalendarField.js.map +1 -0
- package/lib/components/BryntumConstraintTypePicker.js +5 -0
- package/lib/components/BryntumConstraintTypePicker.js.map +1 -0
- package/lib/components/BryntumCostAccrualField.js +5 -0
- package/lib/components/BryntumCostAccrualField.js.map +1 -0
- package/lib/components/BryntumDependencyTypePicker.js +5 -0
- package/lib/components/BryntumDependencyTypePicker.js.map +1 -0
- package/lib/components/BryntumEffortField.js +5 -0
- package/lib/components/BryntumEffortField.js.map +1 -0
- package/lib/components/BryntumEndDateField.js +5 -0
- package/lib/components/BryntumEndDateField.js.map +1 -0
- package/lib/components/BryntumModelCombo.js +5 -0
- package/lib/components/BryntumModelCombo.js.map +1 -0
- package/lib/components/BryntumRateTableField.js +5 -0
- package/lib/components/BryntumRateTableField.js.map +1 -0
- package/lib/components/BryntumResourceEditor.js +5 -0
- package/lib/components/BryntumResourceEditor.js.map +1 -0
- package/lib/components/BryntumResourceGrid.js +5 -0
- package/lib/components/BryntumResourceGrid.js.map +1 -0
- package/lib/components/BryntumResourceHistogram.js +5 -0
- package/lib/components/BryntumResourceHistogram.js.map +1 -0
- package/lib/components/BryntumResourceTypeField.js +5 -0
- package/lib/components/BryntumResourceTypeField.js.map +1 -0
- package/lib/components/BryntumResourceUtilization.js +5 -0
- package/lib/components/BryntumResourceUtilization.js.map +1 -0
- package/lib/components/BryntumSchedulerPro.js +5 -0
- package/lib/components/BryntumSchedulerPro.js.map +1 -0
- package/lib/components/BryntumSchedulerProBase.js +5 -0
- package/lib/components/BryntumSchedulerProBase.js.map +1 -0
- package/lib/components/BryntumSchedulerProProjectModel.js +5 -0
- package/lib/components/BryntumSchedulerProProjectModel.js.map +1 -0
- package/lib/components/BryntumSchedulingDirectionPicker.js +5 -0
- package/lib/components/BryntumSchedulingDirectionPicker.js.map +1 -0
- package/lib/components/BryntumSchedulingModePicker.js +5 -0
- package/lib/components/BryntumSchedulingModePicker.js.map +1 -0
- package/lib/components/BryntumStartDateField.js +5 -0
- package/lib/components/BryntumStartDateField.js.map +1 -0
- package/lib/components/BryntumTimeline.js +5 -0
- package/lib/components/BryntumTimeline.js.map +1 -0
- package/lib/components/BryntumVersionGrid.js +5 -0
- package/lib/components/BryntumVersionGrid.js.map +1 -0
- package/lib/helper/WrapperHelper.js +291 -0
- package/lib/helper/WrapperHelper.js.map +1 -0
- package/lib/index.d.ts +5 -0
- package/lib/index.js +47 -0
- package/lib/index.js.map +1 -0
- package/license.pdf +0 -0
- package/licenses.md +310 -0
- package/package.json +27 -0
- package/src/components/BryntumCalendarEditor.vue +1268 -0
- package/src/components/BryntumCalendarEditorProps.ts +776 -0
- package/src/components/BryntumCalendarField.vue +1350 -0
- package/src/components/BryntumCalendarFieldProps.ts +849 -0
- package/src/components/BryntumConstraintTypePicker.vue +1337 -0
- package/src/components/BryntumConstraintTypePickerProps.ts +838 -0
- package/src/components/BryntumCostAccrualField.vue +1337 -0
- package/src/components/BryntumCostAccrualFieldProps.ts +838 -0
- package/src/components/BryntumDependencyTypePicker.vue +1337 -0
- package/src/components/BryntumDependencyTypePickerProps.ts +838 -0
- package/src/components/BryntumEffortField.vue +1140 -0
- package/src/components/BryntumEffortFieldProps.ts +683 -0
- package/src/components/BryntumEndDateField.vue +1167 -0
- package/src/components/BryntumEndDateFieldProps.ts +701 -0
- package/src/components/BryntumModelCombo.vue +1337 -0
- package/src/components/BryntumModelComboProps.ts +838 -0
- package/src/components/BryntumRateTableField.vue +1337 -0
- package/src/components/BryntumRateTableFieldProps.ts +838 -0
- package/src/components/BryntumResourceEditor.vue +1247 -0
- package/src/components/BryntumResourceEditorProps.ts +758 -0
- package/src/components/BryntumResourceGrid.vue +2924 -0
- package/src/components/BryntumResourceGridProps.ts +1040 -0
- package/src/components/BryntumResourceHistogram.vue +4495 -0
- package/src/components/BryntumResourceHistogramProps.ts +1697 -0
- package/src/components/BryntumResourceTypeField.vue +1337 -0
- package/src/components/BryntumResourceTypeFieldProps.ts +838 -0
- package/src/components/BryntumResourceUtilization.vue +4525 -0
- package/src/components/BryntumResourceUtilizationProps.ts +1683 -0
- package/src/components/BryntumSchedulerPro.vue +7153 -0
- package/src/components/BryntumSchedulerProBase.vue +7151 -0
- package/src/components/BryntumSchedulerProBaseProps.ts +2169 -0
- package/src/components/BryntumSchedulerProProjectModel.vue +1192 -0
- package/src/components/BryntumSchedulerProProjectModelProps.ts +597 -0
- package/src/components/BryntumSchedulerProProps.ts +2170 -0
- package/src/components/BryntumSchedulingDirectionPicker.vue +1337 -0
- package/src/components/BryntumSchedulingDirectionPickerProps.ts +838 -0
- package/src/components/BryntumSchedulingModePicker.vue +1345 -0
- package/src/components/BryntumSchedulingModePickerProps.ts +845 -0
- package/src/components/BryntumStartDateField.vue +1185 -0
- package/src/components/BryntumStartDateFieldProps.ts +717 -0
- package/src/components/BryntumTimeline.vue +6311 -0
- package/src/components/BryntumTimelineProps.ts +2041 -0
- package/src/components/BryntumVersionGrid.vue +2970 -0
- package/src/components/BryntumVersionGridProps.ts +1053 -0
- package/src/helper/WrapperHelper.ts +573 -0
- package/src/index.ts +48 -0
- package/src/vite-env.d.ts +1 -0
|
@@ -0,0 +1,2041 @@
|
|
|
1
|
+
import type { AjaxStore, AjaxStoreConfig, 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';
|
|
2
|
+
import type { AIFilter, AIFilterConfig, CellCopyPaste, CellCopyPasteConfig, CellEdit as GridCellEdit, CellEditConfig as GridCellEditConfig, CellMenu, CellMenuConfig, CellTooltip, CellTooltipConfig, Charts, ChartsConfig, ColumnAutoWidth, ColumnAutoWidthConfig, ColumnDragToolbar, ColumnDragToolbarConfig, ColumnPicker, ColumnPickerConfig, ColumnRename, ColumnRenameConfig, ColumnReorder, ColumnReorderConfig, ColumnResize, ColumnResizeConfig, ColumnStore, ColumnStoreConfig, EmptyTextDomConfig, 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 { AssignmentModel as SchedulerAssignmentModel, AssignmentModelConfig as SchedulerAssignmentModelConfig, AssignmentStore as SchedulerAssignmentStore, AssignmentStoreConfig as SchedulerAssignmentStoreConfig, ColumnLines, ColumnLinesConfig, CrudManager, CrudManagerConfig, DateConstraint, Dependencies as SchedulerDependencies, DependenciesConfig as SchedulerDependenciesConfig, DependencyBaseModel, DependencyEdit as SchedulerDependencyEdit, DependencyEditConfig as SchedulerDependencyEditConfig, DependencyMenu, DependencyMenuConfig, DependencyModel as SchedulerDependencyModel, DependencyModelConfig as SchedulerDependencyModelConfig, DependencyStore as SchedulerDependencyStore, EventColor, EventCopyPaste, EventCopyPasteConfig, EventDrag, EventDragConfig, EventDragCreate, EventDragCreateConfig, EventDragSelect, EventDragSelectConfig, EventEdit, EventEditConfig, EventFilter, EventFilterConfig, EventMenu, EventMenuConfig, EventModel as SchedulerEventModel, EventModelConfig as SchedulerEventModelConfig, EventNonWorkingTime, EventNonWorkingTimeConfig, EventResize as SchedulerEventResize, EventResizeConfig as SchedulerEventResizeConfig, EventStore as SchedulerEventStore, EventStoreConfig as SchedulerEventStoreConfig, EventTooltip, EventTooltipConfig, ExcelExporter, ExcelExporterConfig, GroupSummary, GroupSummaryConfig, HeaderZoom, HeaderZoomConfig, Labels, LabelsConfig, LockRows, LockRowsConfig, NonWorkingTime, NonWorkingTimeConfig, Pan, PanConfig, PdfExport, PdfExportConfig, Print, PrintConfig, RecurrenceConfirmationPopup, RecurrenceConfirmationPopupConfig, ResourceHeaderConfig, ResourceMarginConfig, ResourceMenu, ResourceMenuConfig, ResourceModel as SchedulerResourceModel, ResourceModelConfig as SchedulerResourceModelConfig, ResourceStore as SchedulerResourceStore, ResourceStoreConfig as SchedulerResourceStoreConfig, ResourceTimeRangeModel, ResourceTimeRangeModelConfig, ResourceTimeRangeStore, ResourceTimeRangeStoreConfig, ResourceTimeRanges, ResourceTimeRangesConfig, RowReorder, RowReorderConfig, RowResize, RowResizeConfig, ScheduleContext, ScheduleContextConfig, ScheduleMenu, ScheduleMenuConfig, ScheduleTooltip, ScheduleTooltipConfig, Scheduler, 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
|
+
import type { SchedulerProContainerItemConfig, DependencyStoreConfig, SchedulerProColumnConfig, ProjectModel, ProjectModelConfig, TimelineListeners } from '@bryntum/schedulerpro-thin';
|
|
5
|
+
|
|
6
|
+
export declare type BryntumTimelineProps = {
|
|
7
|
+
// Configs
|
|
8
|
+
/**
|
|
9
|
+
* Element (or element id) to adopt as this Widget's encapsulating element. The widget's
|
|
10
|
+
* content will be placed inside this element.
|
|
11
|
+
* ...
|
|
12
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-adopt)
|
|
13
|
+
*/
|
|
14
|
+
adopt ? : HTMLElement|string
|
|
15
|
+
/**
|
|
16
|
+
* When this widget is a child of a [Container](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Container), it will by default be participating in a
|
|
17
|
+
* flexbox layout. This config allows you to set this widget's
|
|
18
|
+
* [align-self](https://developer.mozilla.org/en-US/docs/Web/CSS/align-self) style.
|
|
19
|
+
*/
|
|
20
|
+
alignSelf ? : string
|
|
21
|
+
/**
|
|
22
|
+
* Set to `false` to not allow creating dependencies
|
|
23
|
+
*/
|
|
24
|
+
allowCreate ? : Boolean
|
|
25
|
+
/**
|
|
26
|
+
* Set it to `true` to allow dependency creation only for parent events (only applies to Scheduler Pro using the `NestedEvents` feature). Normally the nested event container
|
|
27
|
+
* inside parent events cannot be scrolled when using dependencies, but by enabling this setting and limiting
|
|
28
|
+
* to where dependencies can be drawn scrolling will be enabled.
|
|
29
|
+
*/
|
|
30
|
+
allowCreateOnlyParent ? : Boolean
|
|
31
|
+
/**
|
|
32
|
+
* `false` to require a drop on a target event bar side circle to define the dependency type.
|
|
33
|
+
* If dropped on the event bar, the `defaultValue` of the DependencyModel `type` field will be used to
|
|
34
|
+
* determine the target task side.
|
|
35
|
+
*/
|
|
36
|
+
allowDropOnEventBar ? : Boolean
|
|
37
|
+
/**
|
|
38
|
+
* Set to `false` if you don't want to allow events overlapping times for any one resource (defaults to `true`).
|
|
39
|
+
* ...
|
|
40
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-allowOverlap)
|
|
41
|
+
*/
|
|
42
|
+
allowOverlap ? : Boolean
|
|
43
|
+
/**
|
|
44
|
+
* Set to `true` to animate row removals caused by filtering.
|
|
45
|
+
* @deprecated 7.0.0 Deprecated `animateFilterRemovals`. Use `transition.filterRemoval` instead
|
|
46
|
+
*/
|
|
47
|
+
animateFilterRemovals ? : Boolean
|
|
48
|
+
/**
|
|
49
|
+
* Controls if removing and inserting rows should be animated. Set to `false` to prevent those animations,
|
|
50
|
+
* removing the related delays.
|
|
51
|
+
* @deprecated 7.0.0 Deprecated `animateRemovingRows`. Use `transition.removeRecord` instead
|
|
52
|
+
*/
|
|
53
|
+
animateRemovingRows ? : Boolean
|
|
54
|
+
/**
|
|
55
|
+
* When the [Tree](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Tree) feature is in use and the Store is a tree store, this
|
|
56
|
+
* config may be set to `true` to visually animate branch node expand and collapse operations.
|
|
57
|
+
* *This is not supported in Scheduler and Gantt*
|
|
58
|
+
* @deprecated 7.0.0 Deprecated `animateTreeNodeToggle`. Use `transition.toggleTreeNode` instead
|
|
59
|
+
*/
|
|
60
|
+
animateTreeNodeToggle ? : Boolean
|
|
61
|
+
/**
|
|
62
|
+
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
63
|
+
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#property-element).
|
|
64
|
+
*/
|
|
65
|
+
appendTo ? : HTMLElement|string
|
|
66
|
+
/**
|
|
67
|
+
* A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject
|
|
68
|
+
* into an element which will be linked using the `aria-describedby` attribute.
|
|
69
|
+
* ...
|
|
70
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-ariaDescription)
|
|
71
|
+
*/
|
|
72
|
+
ariaDescription ? : string
|
|
73
|
+
/**
|
|
74
|
+
* A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject as
|
|
75
|
+
* the `aria-label` attribute.
|
|
76
|
+
* ...
|
|
77
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-ariaLabel)
|
|
78
|
+
*/
|
|
79
|
+
ariaLabel ? : string
|
|
80
|
+
/**
|
|
81
|
+
* Inline assignments, will be loaded into an internally created AssignmentStore.
|
|
82
|
+
*/
|
|
83
|
+
assignments ? : SchedulerAssignmentModel[]|object[]|SchedulerAssignmentModelConfig[]
|
|
84
|
+
/**
|
|
85
|
+
* The optional [AssignmentStore](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/data/AssignmentStore), holding assignments between resources and events.
|
|
86
|
+
* Required for multi assignments.
|
|
87
|
+
*/
|
|
88
|
+
assignmentStore ? : SchedulerAssignmentStore|SchedulerAssignmentStoreConfig
|
|
89
|
+
/**
|
|
90
|
+
* You can set this option to `false` to make the timeline panel start and end on the exact provided
|
|
91
|
+
* [startDate](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/TimelineBase#config-startDate)/[endDate](#Scheduler/view/TimelineBase#config-endDate) w/o adjusting them.
|
|
92
|
+
*/
|
|
93
|
+
autoAdjustTimeAxis ? : Boolean
|
|
94
|
+
/**
|
|
95
|
+
* If this config is set, then its `gesture` property (which defaults to `dblclick`) creates a
|
|
96
|
+
* new event at the mouse or touch event's time point.
|
|
97
|
+
* ...
|
|
98
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-autoCreate)
|
|
99
|
+
* @param {'click','dblclick'} autoCreate.gesture The gesture to trigger auto creation of an event. Defaults to `dblclick`.
|
|
100
|
+
* @param {boolean} autoCreate.useEventModelDefaults Set to `true` to set default duration based on the defaults specified by the [duration](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/model/EventModel#field-duration) and [durationUnit](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/model/EventModel#field-durationUnit) fields.
|
|
101
|
+
* @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.
|
|
102
|
+
* @param {DurationConfig,string} autoCreate.step The increment to snap the event start date to.
|
|
103
|
+
* @param {DurationConfig,string} autoCreate.duration The duration of the event to create. Defaults to 1 time axis tick.
|
|
104
|
+
* @param {string} autoCreate.name The name of the event to create. Defaults to the `Object.newEvent` property from the locale.
|
|
105
|
+
*/
|
|
106
|
+
autoCreate ? : Boolean|string|{autoCreate: { gesture?: 'click'|'dblclick', useEventModelDefaults?: Boolean, snapType?: 'round'|'ceil'|'floor', step?: DurationConfig|string, duration?: DurationConfig|string, name?: string }}
|
|
107
|
+
/**
|
|
108
|
+
* Automatically set grids height to fit all rows (no scrolling in the grid). In general you should avoid
|
|
109
|
+
* using `autoHeight: true`, since it will bypass Grids virtual rendering and render all rows at once, which
|
|
110
|
+
* in a larger grid is really bad for performance.
|
|
111
|
+
*/
|
|
112
|
+
autoHeight ? : Boolean
|
|
113
|
+
/**
|
|
114
|
+
* Controls how much space to leave between stacked event bars in px.
|
|
115
|
+
* ...
|
|
116
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-barMargin)
|
|
117
|
+
*/
|
|
118
|
+
barMargin ? : number
|
|
119
|
+
/**
|
|
120
|
+
* A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Toolbar),
|
|
121
|
+
* or array of config objects representing the child items of a Toolbar. Another way to add a bbar is to use [strips](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Panel#config-strips).
|
|
122
|
+
* ...
|
|
123
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-bbar)
|
|
124
|
+
*/
|
|
125
|
+
bbar ? : (SchedulerProContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
|
|
126
|
+
/**
|
|
127
|
+
* Custom CSS classes to add to the panel's body element.
|
|
128
|
+
* ...
|
|
129
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-bodyCls)
|
|
130
|
+
*/
|
|
131
|
+
bodyCls ? : string|object
|
|
132
|
+
/**
|
|
133
|
+
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
134
|
+
* hierarchy when triggered.
|
|
135
|
+
* ...
|
|
136
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-bubbleEvents)
|
|
137
|
+
*/
|
|
138
|
+
bubbleEvents ? : object
|
|
139
|
+
/**
|
|
140
|
+
* This config defines the size of the start and end invisible parts of the timespan when [infiniteScroll](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/mixin/TimelineScroll#config-infiniteScroll) set to `true`.
|
|
141
|
+
* ...
|
|
142
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-bufferCoef)
|
|
143
|
+
*/
|
|
144
|
+
bufferCoef ? : number
|
|
145
|
+
/**
|
|
146
|
+
* This config defines the scroll limit, which, when exceeded will cause a timespan shift.
|
|
147
|
+
* The limit is calculated as the `panelWidth * [bufferCoef](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/mixin/TimelineScroll#config-bufferCoef) * bufferThreshold`. During scrolling, if the left or right side
|
|
148
|
+
* has less than that of the rendered content - a shift is triggered.
|
|
149
|
+
* ...
|
|
150
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-bufferThreshold)
|
|
151
|
+
*/
|
|
152
|
+
bufferThreshold ? : number
|
|
153
|
+
/**
|
|
154
|
+
* Set to `false` to not call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
|
|
155
|
+
* ...
|
|
156
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-callOnFunctions)
|
|
157
|
+
*/
|
|
158
|
+
callOnFunctions ? : Boolean
|
|
159
|
+
/**
|
|
160
|
+
* By default, if an event handler throws an exception, the error propagates up the stack and the
|
|
161
|
+
* application state is undefined. Code which follows the event handler will *not* be executed.
|
|
162
|
+
* ...
|
|
163
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-catchEventHandlerExceptions)
|
|
164
|
+
*/
|
|
165
|
+
catchEventHandlerExceptions ? : Boolean
|
|
166
|
+
/**
|
|
167
|
+
* Set to `false` to crop text in grid cells without ellipsis (...). When enabled, cells containing pure
|
|
168
|
+
* use `display : block`, instead of `display : flex` to allow ellipsis to work.
|
|
169
|
+
* <strong>NOTE</strong> Only supported in browsers that support `:has()` CSS selector
|
|
170
|
+
*/
|
|
171
|
+
cellEllipsis ? : Boolean
|
|
172
|
+
/**
|
|
173
|
+
* Custom CSS classes to add to element.
|
|
174
|
+
* May be specified as a space separated string, or as an object in which property names
|
|
175
|
+
* with truthy values are used as the class names:
|
|
176
|
+
* ...
|
|
177
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-cls)
|
|
178
|
+
*/
|
|
179
|
+
cls ? : string|object
|
|
180
|
+
/**
|
|
181
|
+
* Controls whether the panel is collapsed (the body of the panel is hidden while only the header is
|
|
182
|
+
* visible). Only valid if the panel is [collapsible](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Panel#config-collapsible).
|
|
183
|
+
*/
|
|
184
|
+
collapsed ? : Boolean
|
|
185
|
+
/**
|
|
186
|
+
* This config enables collapsibility for the panel. See [collapsed](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Panel#config-collapsed).
|
|
187
|
+
* ...
|
|
188
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-collapsible)
|
|
189
|
+
*/
|
|
190
|
+
collapsible ? : Boolean|PanelCollapserConfig|PanelCollapserOverlayConfig
|
|
191
|
+
/**
|
|
192
|
+
* Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
|
|
193
|
+
* `style` block.
|
|
194
|
+
* ...
|
|
195
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-color)
|
|
196
|
+
*/
|
|
197
|
+
color ? : string
|
|
198
|
+
/**
|
|
199
|
+
* Programmatic control over which column to start in when used in a grid layout.
|
|
200
|
+
*/
|
|
201
|
+
column ? : number
|
|
202
|
+
/**
|
|
203
|
+
* Set to `false` to not show column lines. End result might be overruled by/differ between themes.
|
|
204
|
+
*/
|
|
205
|
+
columnLines ? : Boolean
|
|
206
|
+
/**
|
|
207
|
+
* Accepts column definitions for the grid during initialization. They will be used to create
|
|
208
|
+
* [Column](https://bryntum.com/products/schedulerpro/docs/api/Grid/column/Column) instances that are added to a [ColumnStore](#Grid/data/ColumnStore).
|
|
209
|
+
* ...
|
|
210
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-columns)
|
|
211
|
+
*/
|
|
212
|
+
columns ? : ColumnStore|SchedulerProColumnConfig[]|ColumnStoreConfig
|
|
213
|
+
config ? : object
|
|
214
|
+
/**
|
|
215
|
+
* Custom CSS classes to add to the [contentElement](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#property-contentElement).
|
|
216
|
+
* May be specified as a space separated string, or as an object in which property names
|
|
217
|
+
* with truthy values are used as the class names:
|
|
218
|
+
* ...
|
|
219
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-contentElementCls)
|
|
220
|
+
*/
|
|
221
|
+
contentElementCls ? : string|object
|
|
222
|
+
/**
|
|
223
|
+
* Event which is used to show context menus.
|
|
224
|
+
* Available options are: 'contextmenu', 'click', 'dblclick'.
|
|
225
|
+
*/
|
|
226
|
+
contextMenuTriggerEvent ? : 'contextmenu'|'click'|'dblclick'
|
|
227
|
+
/**
|
|
228
|
+
* A tooltip config object that will be applied to the dependency creation [Tooltip](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Tooltip)
|
|
229
|
+
*/
|
|
230
|
+
creationTooltip ? : TooltipConfig
|
|
231
|
+
/**
|
|
232
|
+
* A template function that will be called to generate the HTML contents of the dependency creation tooltip.
|
|
233
|
+
* You can return either an HTML string or a [DomConfig](https://bryntum.com/products/schedulerpro/docs/api/Core/helper/DomHelper#typedef-DomConfig) object.
|
|
234
|
+
* @param {object} data Data about the dependency being created
|
|
235
|
+
* @param {Scheduler.model.TimeSpan} data.source The from event
|
|
236
|
+
* @param {Scheduler.model.TimeSpan} data.target The target event
|
|
237
|
+
* @param {string} data.fromSide The from side (start, end, top, bottom)
|
|
238
|
+
* @param {string} data.toSide The target side (start, end, top, bottom)
|
|
239
|
+
* @param {boolean} data.valid The validity of the dependency
|
|
240
|
+
* @returns {string,DomConfig}
|
|
241
|
+
*/
|
|
242
|
+
creationTooltipTemplate ? : (data: { source: TimeSpan, target: TimeSpan, fromSide: string, toSide: string, valid: Boolean }) => string|DomConfig
|
|
243
|
+
/**
|
|
244
|
+
* Supply a [CrudManager](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/data/CrudManager) instance or a config object if you want to use
|
|
245
|
+
* CrudManager for handling data.
|
|
246
|
+
*/
|
|
247
|
+
crudManager ? : CrudManagerConfig|CrudManager
|
|
248
|
+
/**
|
|
249
|
+
* Class that should be used to instantiate a CrudManager in case it's provided as a simple object to
|
|
250
|
+
* [crudManager](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/mixin/SchedulerStores#config-crudManager) config.
|
|
251
|
+
*/
|
|
252
|
+
crudManagerClass ? : typeof CrudManager
|
|
253
|
+
/**
|
|
254
|
+
* Convenient shortcut to set data in grids store both during initialization and at runtime. Can also be
|
|
255
|
+
* used to retrieve data at runtime, although we do recommend interacting with Grids store instead using
|
|
256
|
+
* the [store](https://bryntum.com/products/schedulerpro/docs/api/Grid/view/GridBase#property-store) property.
|
|
257
|
+
* ...
|
|
258
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-data)
|
|
259
|
+
*/
|
|
260
|
+
data ? : object[]|Model[]|ModelConfig[]
|
|
261
|
+
/**
|
|
262
|
+
* When this Widget configuration is used in the Grid's RowExpander feature's `widget` config, provide the
|
|
263
|
+
* field on the expanded record to use for populating this widget's store (if applicable)
|
|
264
|
+
*/
|
|
265
|
+
dataField ? : string
|
|
266
|
+
/**
|
|
267
|
+
* Object to apply to elements dataset (each key will be used as a data-attribute on the element)
|
|
268
|
+
*/
|
|
269
|
+
dataset ? : Record<string, string>
|
|
270
|
+
/**
|
|
271
|
+
* The date to display when used as a component of a Calendar.
|
|
272
|
+
* ...
|
|
273
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-date)
|
|
274
|
+
*/
|
|
275
|
+
date ? : Date
|
|
276
|
+
/**
|
|
277
|
+
* A [DateHelper](https://bryntum.com/products/schedulerpro/docs/api/Core/helper/DateHelper) format string/function to use to create date output for view descriptions.
|
|
278
|
+
* @param {Date} date The date to format.
|
|
279
|
+
* @returns {string} The formatted date.
|
|
280
|
+
*/
|
|
281
|
+
dateFormat ? : string|((date: Date) => string)
|
|
282
|
+
/**
|
|
283
|
+
* A string used to separate start and end dates in the [descriptionFormat](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/mixin/Describable#config-descriptionFormat).
|
|
284
|
+
*/
|
|
285
|
+
dateSeparator ? : string
|
|
286
|
+
/**
|
|
287
|
+
* Region to which columns are added when they have none specified
|
|
288
|
+
*/
|
|
289
|
+
defaultRegion ? : string
|
|
290
|
+
/**
|
|
291
|
+
* Generic resource image, used when provided `imageUrl` or `image` fields or path calculated from resource
|
|
292
|
+
* name are all invalid. If left blank, resource name initials will be shown when no image can be loaded.
|
|
293
|
+
*/
|
|
294
|
+
defaultResourceImageName ? : string
|
|
295
|
+
/**
|
|
296
|
+
* Inline dependencies, will be loaded into an internally created DependencyStore.
|
|
297
|
+
*/
|
|
298
|
+
dependencies ? : SchedulerDependencyModel[]|SchedulerDependencyModelConfig[]
|
|
299
|
+
/**
|
|
300
|
+
* The optional [DependencyStore](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/data/DependencyStore).
|
|
301
|
+
*/
|
|
302
|
+
dependencyStore ? : SchedulerDependencyStore|DependencyStoreConfig
|
|
303
|
+
/**
|
|
304
|
+
* The date format used by the default [descriptionRenderer](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/mixin/Describable#config-descriptionRenderer) for rendering the view's description.
|
|
305
|
+
* If this value is `null`, the [dateFormat](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/mixin/Describable#config-dateFormat) (and potentially [dateSeparator](#Scheduler/view/mixin/Describable#config-dateSeparator)) will
|
|
306
|
+
* be used.
|
|
307
|
+
* ...
|
|
308
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-descriptionFormat)
|
|
309
|
+
* @param {Date} date The date to format.
|
|
310
|
+
* @returns {string} The formatted date.
|
|
311
|
+
*/
|
|
312
|
+
descriptionFormat ? : string|string[]|Boolean[]|((date: Date) => string)|Function[]
|
|
313
|
+
/**
|
|
314
|
+
* A function that provides the textual description for this view. If provided, this function overrides the
|
|
315
|
+
* [descriptionFormat](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/mixin/Describable#config-descriptionFormat).
|
|
316
|
+
* ...
|
|
317
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-descriptionRenderer)
|
|
318
|
+
* @param {Core.widget.Widget} view The active view in case the function is in another scope.
|
|
319
|
+
* @returns {string} Description string
|
|
320
|
+
*/
|
|
321
|
+
descriptionRenderer ? : (view: Widget) => string
|
|
322
|
+
/**
|
|
323
|
+
* Configure as `false` to preserve selection when clicking the empty schedule area.
|
|
324
|
+
*/
|
|
325
|
+
deselectAllOnScheduleClick ? : Boolean
|
|
326
|
+
/**
|
|
327
|
+
* Configure as `true` to deselect a selected event upon click.
|
|
328
|
+
*/
|
|
329
|
+
deselectOnClick ? : Boolean
|
|
330
|
+
/**
|
|
331
|
+
* Set to `true` to destroy the store when the grid is destroyed.
|
|
332
|
+
*/
|
|
333
|
+
destroyStore ? : Boolean
|
|
334
|
+
/**
|
|
335
|
+
* Configure as `true` to destroy the Project and stores when `this` is destroyed.
|
|
336
|
+
*/
|
|
337
|
+
destroyStores ? : Boolean
|
|
338
|
+
/**
|
|
339
|
+
* Check for CSS compatibility issues when upgrading to v7. Performs the following checks:
|
|
340
|
+
* ...
|
|
341
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-detectCSSCompatibilityIssues)
|
|
342
|
+
*/
|
|
343
|
+
detectCSSCompatibilityIssues ? : Boolean
|
|
344
|
+
/**
|
|
345
|
+
* Disable or enable the widget. It is similar to [readOnly](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#config-readOnly) except a disabled widget
|
|
346
|
+
* cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
|
|
347
|
+
* ...
|
|
348
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-disabled)
|
|
349
|
+
*/
|
|
350
|
+
disabled ? : Boolean|'inert'
|
|
351
|
+
/**
|
|
352
|
+
* Set to `true` to not get a warning when calling [getState](https://bryntum.com/products/schedulerpro/docs/api/Grid/view/GridBase#function-getState) when there is a column
|
|
353
|
+
* configured without an `id`. But the recommended action is to always configure columns with an `id` when
|
|
354
|
+
* using states.
|
|
355
|
+
*/
|
|
356
|
+
disableGridColumnIdWarning ? : Boolean
|
|
357
|
+
/**
|
|
358
|
+
* Set to `true` to not get a warning when using another base class than GridRowModel for your grid data. If
|
|
359
|
+
* you do, and would like to use the full feature set of the grid then include the fields from GridRowModel
|
|
360
|
+
* in your model definition.
|
|
361
|
+
*/
|
|
362
|
+
disableGridRowModelWarning ? : Boolean
|
|
363
|
+
/**
|
|
364
|
+
* Defines how dates will be formatted in tooltips etc. This config has priority over similar config on the
|
|
365
|
+
* view preset. For allowed values see [format](https://bryntum.com/products/schedulerpro/docs/api/Core/helper/DateHelper#function-format-static).
|
|
366
|
+
* ...
|
|
367
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-displayDateFormat)
|
|
368
|
+
*/
|
|
369
|
+
displayDateFormat ? : string
|
|
370
|
+
/**
|
|
371
|
+
* Controls the placement of this widget when it is added to a [panel's ](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Panel)
|
|
372
|
+
* [strips collection](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
|
|
373
|
+
* `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
|
|
374
|
+
* body. Such widgets are called "edge strips".
|
|
375
|
+
* ...
|
|
376
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-dock)
|
|
377
|
+
*/
|
|
378
|
+
dock ? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
379
|
+
/**
|
|
380
|
+
* Make this Panel a docked drawer which slides out from one side of the browser viewport by default.
|
|
381
|
+
* ...
|
|
382
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-drawer)
|
|
383
|
+
* @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.
|
|
384
|
+
* @param {string,number} size The size of the drawer in its collapsible axis.
|
|
385
|
+
* @param {boolean} inline If using the [appendTo](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Panel#config-appendTo) config to place the drawer inside a host widget, this may be set to `true` to make the drawer inline within that host. Note that, if using this, the layout of the host element must have `flex-direction` set appropriately.
|
|
386
|
+
* @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.
|
|
387
|
+
* @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.
|
|
388
|
+
* @param {boolean,string} autoClose.focusout If focus moves outside of the drawer, the drawer will automatically be hidden.
|
|
389
|
+
* @param {string} autoClose.mouseout Hides the drawer when the mouse leaves the drawer after the `autoCloseDelay` period.
|
|
390
|
+
* @param {number} autoCloseDelay When using `mouseout`, this is the delay in milliseconds
|
|
391
|
+
*/
|
|
392
|
+
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}
|
|
393
|
+
/**
|
|
394
|
+
* Decimal precision used when displaying durations, used by tooltips and DurationColumn.
|
|
395
|
+
* Specify `false` to use raw value
|
|
396
|
+
*/
|
|
397
|
+
durationDisplayPrecision ? : number|Boolean
|
|
398
|
+
/**
|
|
399
|
+
* An object specifying attributes to assign to the root element of this widget.
|
|
400
|
+
* Set `null` value to attribute to remove it.
|
|
401
|
+
* ...
|
|
402
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-elementAttributes)
|
|
403
|
+
*/
|
|
404
|
+
elementAttributes ? : Record<string, string|null>
|
|
405
|
+
/**
|
|
406
|
+
* Text or HTML, or a [EmptyTextDomConfig](https://bryntum.com/products/schedulerpro/docs/api/Grid/view/GridBase#typedef-EmptyTextDomConfig) block to display when there is no data to display in the grid.
|
|
407
|
+
* When using multiple Grid regions, provide the `region` property to decide where the text is shown.
|
|
408
|
+
* By default, it is shown in the first region.
|
|
409
|
+
* ...
|
|
410
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-emptyText)
|
|
411
|
+
*/
|
|
412
|
+
emptyText ? : string|EmptyTextDomConfig
|
|
413
|
+
/**
|
|
414
|
+
* Allow using [Delete] and [Backspace] to remove events/assignments
|
|
415
|
+
*/
|
|
416
|
+
enableDeleteKey ? : Boolean
|
|
417
|
+
/**
|
|
418
|
+
* Set to `false` if you don't want event bar DOM updates to animate.
|
|
419
|
+
* @deprecated 7.0.0 Deprecated `enableEventAnimations`. Use `transition.changeEvent` instead
|
|
420
|
+
*/
|
|
421
|
+
enableEventAnimations ? : Boolean
|
|
422
|
+
/**
|
|
423
|
+
* Enables showing occurrences of recurring events across the scheduler's time axis. If you want to disable
|
|
424
|
+
* the recurrence popup, you can choose set the `defaultAction` to `future` to affect all future
|
|
425
|
+
* occurrences, or `single` to just affect the currently selected event.
|
|
426
|
+
* ...
|
|
427
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-enableRecurringEvents)
|
|
428
|
+
*/
|
|
429
|
+
enableRecurringEvents ? : Boolean|{
|
|
430
|
+
defaultAction?: 'single'|'future'
|
|
431
|
+
}
|
|
432
|
+
/**
|
|
433
|
+
* Configure this as `true` to allow elements within cells to be styled as `position: sticky`.
|
|
434
|
+
* ...
|
|
435
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-enableSticky)
|
|
436
|
+
*/
|
|
437
|
+
enableSticky ? : Boolean
|
|
438
|
+
/**
|
|
439
|
+
* Set to `true` to allow text selection in the grid cells. Note, this cannot be used simultaneously with the
|
|
440
|
+
* `RowReorder` feature.
|
|
441
|
+
*/
|
|
442
|
+
enableTextSelection ? : Boolean
|
|
443
|
+
/**
|
|
444
|
+
* When true, some features will start a project transaction, blocking the project queue, suspending
|
|
445
|
+
* store events and preventing UI from updates. It behaves similar to
|
|
446
|
+
* [instantUpdate](https://bryntum.com/products/schedulerpro/docs/api/Grid/column/Column#config-instantUpdate) set to `false`.
|
|
447
|
+
* Set `false` to not use project queue.
|
|
448
|
+
*/
|
|
449
|
+
enableTransactionalFeatures ? : Boolean
|
|
450
|
+
/**
|
|
451
|
+
* Set to `true` to listen for CTRL-Z (CMD-Z on Mac OS) keyboard event and trigger undo (redo when SHIFT is
|
|
452
|
+
* pressed). Only applicable when using a [StateTrackingManager](https://bryntum.com/products/schedulerpro/docs/api/Core/data/stm/StateTrackingManager).
|
|
453
|
+
*/
|
|
454
|
+
enableUndoRedoKeys ? : Boolean
|
|
455
|
+
/**
|
|
456
|
+
* The end date of the timeline (if not configure with [infiniteScroll](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/TimelineBase#config-infiniteScroll)).
|
|
457
|
+
* ...
|
|
458
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-endDate)
|
|
459
|
+
*/
|
|
460
|
+
endDate ? : Date|string
|
|
461
|
+
/**
|
|
462
|
+
* The name of the end date parameter that will be passed to in every `eventStore` load request.
|
|
463
|
+
*/
|
|
464
|
+
endParamName ? : string
|
|
465
|
+
/**
|
|
466
|
+
* Field from EventModel displayed as text in the bar when rendering
|
|
467
|
+
*/
|
|
468
|
+
eventBarTextField ? : string
|
|
469
|
+
/**
|
|
470
|
+
* Event color used by default. Events and resources can specify their own color, with priority order being:
|
|
471
|
+
* Event -> Resource -> Scheduler default.
|
|
472
|
+
* ...
|
|
473
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-eventColor)
|
|
474
|
+
*/
|
|
475
|
+
eventColor ? : EventColor
|
|
476
|
+
/**
|
|
477
|
+
* Defines how to handle overlapping events. Valid values are:
|
|
478
|
+
* ...
|
|
479
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-eventLayout)
|
|
480
|
+
*/
|
|
481
|
+
eventLayout ? : 'stack'|'pack'|'mixed'|'none'|{
|
|
482
|
+
type?: 'stack'|'pack'|'mixed'|'none'
|
|
483
|
+
}
|
|
484
|
+
/**
|
|
485
|
+
* An advanced setting that controls the maximum number of released event bars to keep in the DOM.
|
|
486
|
+
* ...
|
|
487
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-eventReleaseThreshold)
|
|
488
|
+
*/
|
|
489
|
+
eventReleaseThreshold ? : number
|
|
490
|
+
/**
|
|
491
|
+
* An empty function by default, but provided so that you can override it. This function is called each time
|
|
492
|
+
* an event is rendered into the schedule to render the contents of the event. It's called with the event,
|
|
493
|
+
* its resource and a `renderData` object which allows you to populate data placeholders inside the event
|
|
494
|
+
* template.
|
|
495
|
+
* ...
|
|
496
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-eventRenderer)
|
|
497
|
+
* @param {object} detail An object containing the information needed to render an Event.
|
|
498
|
+
* @param {Scheduler.model.SchedulerEventModel} detail.eventRecord The event record.
|
|
499
|
+
* @param {Scheduler.model.SchedulerResourceModel} detail.resourceRecord The resource record.
|
|
500
|
+
* @param {Scheduler.model.SchedulerAssignmentModel} detail.assignmentRecord The assignment record.
|
|
501
|
+
* @param {Scheduler.view.Scheduler} detail.scheduler The Scheduler instance.
|
|
502
|
+
* @param {object} detail.renderData An object containing details about the event rendering.
|
|
503
|
+
* @param {Scheduler.model.SchedulerEventModel} detail.renderData.event The event record.
|
|
504
|
+
* @param {Core.helper.util.DomClassList,string} detail.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.
|
|
505
|
+
* @param {Core.helper.util.DomClassList,string} detail.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.
|
|
506
|
+
* @param {Core.helper.util.DomClassList,string} detail.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`.
|
|
507
|
+
* @param {number} detail.renderData.left Vertical offset position (in pixels) on the time axis.
|
|
508
|
+
* @param {number} detail.renderData.width Width in pixels of the event element.
|
|
509
|
+
* @param {number} detail.renderData.height Height in pixels of the event element.
|
|
510
|
+
* @param {string,Record<string, string>} detail.renderData.style Inline styles for the event bar DOM element. Use either 'border: 1px solid black' or `{ border: '1px solid black' }`
|
|
511
|
+
* @param {string,Record<string, string>} detail.renderData.wrapperStyle Inline styles for wrapper of the event bar DOM element. Use either 'border: 1px solid green' or `{ border: '1px solid green' }`
|
|
512
|
+
* @param {'tonal','filled','bordered','traced','outlined','indented','line','dashed','minimal','rounded','calendar','interday','gantt',null} detail.renderData.eventStyle The `eventStyle` of the event. Use this to apply custom styles to the event DOM element
|
|
513
|
+
* @param {string} detail.renderData.eventColor The `eventColor` of the event. Use this to set a custom color for the rendered event
|
|
514
|
+
* @param {string} detail.renderData.ariaLabel A description of the event details used for screen readers
|
|
515
|
+
* @param {DomConfig[]} detail.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.
|
|
516
|
+
* @returns {string,DomConfig,DomConfig[]} A simple string, or a DomConfig (or array thereof)
|
|
517
|
+
*/
|
|
518
|
+
eventRenderer ? : (detail: { eventRecord: SchedulerEventModel, resourceRecord: SchedulerResourceModel, assignmentRecord: SchedulerAssignmentModel, scheduler: Scheduler, renderData: { event: SchedulerEventModel, 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[]
|
|
519
|
+
/**
|
|
520
|
+
* `this` reference for the [eventRenderer](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/mixin/SchedulerEventRendering#config-eventRenderer) function
|
|
521
|
+
*/
|
|
522
|
+
eventRendererThisObj ? : object
|
|
523
|
+
/**
|
|
524
|
+
* Inline events, will be loaded into an internally created EventStore.
|
|
525
|
+
*/
|
|
526
|
+
events ? : SchedulerEventModel[]|SchedulerEventModelConfig[]
|
|
527
|
+
/**
|
|
528
|
+
* Configure as `true`, or set property to `true` to disable event selection.
|
|
529
|
+
*/
|
|
530
|
+
eventSelectionDisabled ? : Boolean
|
|
531
|
+
/**
|
|
532
|
+
* The [EventStore](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/data/EventStore) holding the events to be rendered into the scheduler (required).
|
|
533
|
+
*/
|
|
534
|
+
eventStore ? : SchedulerEventStore|SchedulerEventStoreConfig
|
|
535
|
+
/**
|
|
536
|
+
* Event style used by default. Events and resources can specify their own style, with priority order being:
|
|
537
|
+
* Event -> Resource -> Scheduler default. Determines the appearance of the event by assigning a CSS class
|
|
538
|
+
* to it. Available styles are:
|
|
539
|
+
* ...
|
|
540
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-eventStyle)
|
|
541
|
+
*/
|
|
542
|
+
eventStyle ? : 'tonal'|'filled'|'bordered'|'traced'|'outlined'|'indented'|'line'|'dashed'|'minimal'|'rounded'|'calendar'|'interday'|'gantt'|null
|
|
543
|
+
extraData ? : any
|
|
544
|
+
/**
|
|
545
|
+
* Set to `true` to stretch the last column in a grid with all fixed width columns
|
|
546
|
+
* to fill extra available space if the grid's width is wider than the sum of all
|
|
547
|
+
* configured column widths.
|
|
548
|
+
*/
|
|
549
|
+
fillLastColumn ? : Boolean
|
|
550
|
+
/**
|
|
551
|
+
* Specify `true` to force rendered events/tasks to fill entire ticks. This only affects rendering, start
|
|
552
|
+
* and end dates retain their value on the data level.
|
|
553
|
+
* ...
|
|
554
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-fillTicks)
|
|
555
|
+
*/
|
|
556
|
+
fillTicks ? : Boolean
|
|
557
|
+
/**
|
|
558
|
+
* Use fixed row height. Setting this to `true` will configure the underlying RowManager to use fixed row
|
|
559
|
+
* height, which sacrifices the ability to use rows with variable height to gain a fraction better
|
|
560
|
+
* performance.
|
|
561
|
+
* ...
|
|
562
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-fixedRowHeight)
|
|
563
|
+
*/
|
|
564
|
+
fixedRowHeight ? : Boolean
|
|
565
|
+
/**
|
|
566
|
+
* When this widget is a child of a [Container](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Container), it will by default be participating in a
|
|
567
|
+
* flexbox layout. This config allows you to set this widget's
|
|
568
|
+
* [flex](https://developer.mozilla.org/en-US/docs/Web/CSS/flex) style.
|
|
569
|
+
* This may be configured as a single number or a `<flex-grow> <flex-shrink> <flex-basis>` format string.
|
|
570
|
+
* numeric-only values are interpreted as the `flex-grow` value.
|
|
571
|
+
*/
|
|
572
|
+
flex ? : number|string
|
|
573
|
+
/**
|
|
574
|
+
* Config object of a footer. May contain a `dock`, `html` and a `cls` property. A footer is not a widget,
|
|
575
|
+
* but rather plain HTML that follows the last element of the panel's body and [strips](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Panel#config-strips).
|
|
576
|
+
* ...
|
|
577
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-footer)
|
|
578
|
+
*/
|
|
579
|
+
footer ? : {
|
|
580
|
+
dock?: 'top'|'right'|'bottom'|'left'|'start'|'end'
|
|
581
|
+
html?: string
|
|
582
|
+
cls?: string
|
|
583
|
+
}|string
|
|
584
|
+
/**
|
|
585
|
+
* Set to `true` to force the time columns to fit to the available space (horizontal or vertical depends on mode).
|
|
586
|
+
* Note that setting [suppressFit](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/TimelineBase#config-suppressFit) to `true`, will disable `forceFit` functionality. Zooming
|
|
587
|
+
* cannot be used when `forceFit` is set.
|
|
588
|
+
*/
|
|
589
|
+
forceFit ? : Boolean
|
|
590
|
+
/**
|
|
591
|
+
* An object which names formula prefixes which will be applied to all columns configured with
|
|
592
|
+
* `formula : true`.
|
|
593
|
+
* ...
|
|
594
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-formulaProviders)
|
|
595
|
+
*/
|
|
596
|
+
formulaProviders ? : Record<string, FormulaProviderConfig>
|
|
597
|
+
/**
|
|
598
|
+
* Refresh entire row when a record changes (`true`) or, if possible, only the cells affected (`false`).
|
|
599
|
+
* ...
|
|
600
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-fullRowRefresh)
|
|
601
|
+
*/
|
|
602
|
+
fullRowRefresh ? : Boolean
|
|
603
|
+
/**
|
|
604
|
+
* A method allowing you to define date boundaries that will constrain resize, create and drag drop
|
|
605
|
+
* operations. The method will be called with the Resource record, and the Event record.
|
|
606
|
+
* ...
|
|
607
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-getDateConstraints)
|
|
608
|
+
* @param {Scheduler.model.SchedulerResourceModel} resourceRecord The resource record
|
|
609
|
+
* @param {Scheduler.model.SchedulerEventModel} eventRecord The event record
|
|
610
|
+
* @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.
|
|
611
|
+
*/
|
|
612
|
+
getDateConstraints ? : (resourceRecord?: SchedulerResourceModel, eventRecord?: SchedulerEventModel) => DateConstraint
|
|
613
|
+
/**
|
|
614
|
+
* Scheduler overrides Grid's default implementation of [getRowHeight](https://bryntum.com/products/schedulerpro/docs/api/Grid/view/GridBase#config-getRowHeight) to
|
|
615
|
+
* pre-calculate row heights based on events in the rows.
|
|
616
|
+
* ...
|
|
617
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-getRowHeight)
|
|
618
|
+
* @param {Scheduler.model.SchedulerResourceModel} getRowHeight.record Resource record to determine row height for
|
|
619
|
+
* @returns {number} Desired row height
|
|
620
|
+
*/
|
|
621
|
+
getRowHeight ? : (getRowHeight: { record: SchedulerResourceModel }) => number
|
|
622
|
+
/**
|
|
623
|
+
* A config [object](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Panel#typedef-PanelHeader) for the panel's header or a string in place of a `title`.
|
|
624
|
+
* ...
|
|
625
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-header)
|
|
626
|
+
*/
|
|
627
|
+
header ? : string|Boolean|PanelHeader
|
|
628
|
+
/**
|
|
629
|
+
* Widget's height, used to set element `style.height`. Either specify a valid height string or a number,
|
|
630
|
+
* which will get 'px' appended. We recommend using CSS as the primary way to control height, but in some
|
|
631
|
+
* cases this config is convenient.
|
|
632
|
+
*/
|
|
633
|
+
height ? : string|number
|
|
634
|
+
/**
|
|
635
|
+
* Configure with true to make widget initially hidden.
|
|
636
|
+
*/
|
|
637
|
+
hidden ? : Boolean
|
|
638
|
+
/**
|
|
639
|
+
* Set to `true` to hide the footer elements
|
|
640
|
+
*/
|
|
641
|
+
hideFooters ? : Boolean
|
|
642
|
+
/**
|
|
643
|
+
* Set to `true` to hide the column header elements
|
|
644
|
+
*/
|
|
645
|
+
hideHeaders ? : Boolean
|
|
646
|
+
/**
|
|
647
|
+
* Set to `true` to hide the Grid's horizontal scrollbar(s)
|
|
648
|
+
*/
|
|
649
|
+
hideHorizontalScrollbar ? : Boolean
|
|
650
|
+
/**
|
|
651
|
+
* By default the row hover effect is not visible in the Scheduler part of the grid.
|
|
652
|
+
* ...
|
|
653
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-hideRowHover)
|
|
654
|
+
*/
|
|
655
|
+
hideRowHover ? : Boolean
|
|
656
|
+
/**
|
|
657
|
+
* Configure as `true`, or set property to `true` to highlight dependent events as well when selecting an event.
|
|
658
|
+
*/
|
|
659
|
+
highlightPredecessors ? : Boolean
|
|
660
|
+
/**
|
|
661
|
+
* Configure as `true`, or set property to `true` to highlight dependent events as well when selecting an event.
|
|
662
|
+
*/
|
|
663
|
+
highlightSuccessors ? : Boolean
|
|
664
|
+
/**
|
|
665
|
+
* A CSS class to add to hovered row elements
|
|
666
|
+
*/
|
|
667
|
+
hoverCls ? : string
|
|
668
|
+
/**
|
|
669
|
+
* An icon to show before the [title](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Panel#config-title). Either pass a CSS class as a string, or pass a
|
|
670
|
+
* [DomConfig](https://bryntum.com/products/schedulerpro/docs/api/Core/helper/DomHelper#typedef-DomConfig) object describing an element to represent the icon.
|
|
671
|
+
*/
|
|
672
|
+
icon ? : string|DomConfig
|
|
673
|
+
/**
|
|
674
|
+
* Widget id, if not specified one will be generated. Also used for lookups through Widget.getById
|
|
675
|
+
*/
|
|
676
|
+
id ? : string
|
|
677
|
+
/**
|
|
678
|
+
* Set to `true` to ignore reacting to DOM events (mouseover/mouseout etc) while scrolling. Useful if you
|
|
679
|
+
* want to maximize scroll performance.
|
|
680
|
+
*/
|
|
681
|
+
ignoreDomEventsWhileScrolling ? : Boolean
|
|
682
|
+
/**
|
|
683
|
+
* Determines if the widgets read-only state should be controlled by its parent.
|
|
684
|
+
* ...
|
|
685
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-ignoreParentReadOnly)
|
|
686
|
+
*/
|
|
687
|
+
ignoreParentReadOnly ? : Boolean
|
|
688
|
+
/**
|
|
689
|
+
* Set to `true` to automatically adjust the panel timespan during scrolling in the time dimension,
|
|
690
|
+
* when the scroller comes close to the start/end edges.
|
|
691
|
+
* ...
|
|
692
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-infiniteScroll)
|
|
693
|
+
*/
|
|
694
|
+
infiniteScroll ? : Boolean
|
|
695
|
+
/**
|
|
696
|
+
* Maximum duration (in milliseconds) for the initial animation controlled by [useInitialAnimation](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/mixin/SchedulerEventRendering#config-useInitialAnimation).
|
|
697
|
+
*/
|
|
698
|
+
initialAnimationDuration ? : number
|
|
699
|
+
/**
|
|
700
|
+
* Convenience setting to align input fields of child widgets. By default, the Field input element is
|
|
701
|
+
* placed immediately following the `label`. If you prefer to have all input fields aligned to the
|
|
702
|
+
* right, set this config to `'end'`.
|
|
703
|
+
* ...
|
|
704
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-inputFieldAlign)
|
|
705
|
+
*/
|
|
706
|
+
inputFieldAlign ? : 'start'|'end'
|
|
707
|
+
/**
|
|
708
|
+
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
709
|
+
*/
|
|
710
|
+
insertBefore ? : HTMLElement|string
|
|
711
|
+
/**
|
|
712
|
+
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
713
|
+
*/
|
|
714
|
+
insertFirst ? : HTMLElement|string
|
|
715
|
+
/**
|
|
716
|
+
* A template method (empty by default) allowing you to control if an event can be selected or not.
|
|
717
|
+
* ...
|
|
718
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-isEventSelectable)
|
|
719
|
+
* @param {Scheduler.model.SchedulerEventModel} event The event record
|
|
720
|
+
* @returns {boolean} true if event can be selected, otherwise false
|
|
721
|
+
*/
|
|
722
|
+
isEventSelectable ? : (event: SchedulerEventModel) => Boolean
|
|
723
|
+
/**
|
|
724
|
+
* See [Keyboard shortcuts](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/Scheduler#keyboard-shortcuts) for details
|
|
725
|
+
*/
|
|
726
|
+
keyMap ? : Record<string, KeyMapConfig>
|
|
727
|
+
/**
|
|
728
|
+
* Convenience setting to use same label placement on all child widgets.
|
|
729
|
+
* ...
|
|
730
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-labelPosition)
|
|
731
|
+
*/
|
|
732
|
+
labelPosition ? : 'before'|'above'|'align-before'|'auto'|null
|
|
733
|
+
/**
|
|
734
|
+
* By default, when the `EventStore` (and similar stores) is lazy loading, a loading indicator will be displayed
|
|
735
|
+
* just below the timeline headers. Set this to `false` to prevent this indicator being shown.
|
|
736
|
+
*/
|
|
737
|
+
lazyLoadingIndicator ? : Boolean
|
|
738
|
+
/**
|
|
739
|
+
* The listener set for this object.
|
|
740
|
+
* ...
|
|
741
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-listeners)
|
|
742
|
+
*/
|
|
743
|
+
listeners ? : TimelineListeners
|
|
744
|
+
/**
|
|
745
|
+
* *This property is for use when the Scheduler is used as a Calendar view - a `mode`.*
|
|
746
|
+
* ...
|
|
747
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-listRangeMenu)
|
|
748
|
+
*/
|
|
749
|
+
listRangeMenu ? : MenuConfig
|
|
750
|
+
/**
|
|
751
|
+
* A [Mask](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Mask) config object, or a message to be shown when a store is performing a remote
|
|
752
|
+
* operation, or Crud Manager is loading data from the sever. Set to `null` to disable default load mask.
|
|
753
|
+
*/
|
|
754
|
+
loadMask ? : string|MaskConfig|null
|
|
755
|
+
/**
|
|
756
|
+
* A [Mask](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Mask) config object to adjust the [maskDefaults](#Core/widget/Widget#config-maskDefaults)
|
|
757
|
+
* when data is loading. The message and optional configuration from the
|
|
758
|
+
* [loadMask](https://bryntum.com/products/schedulerpro/docs/api/Core/mixin/LoadMaskable#config-loadMask) config take priority over these options, just as they do
|
|
759
|
+
* for `maskDefaults`, respectively.
|
|
760
|
+
* ...
|
|
761
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-loadMaskDefaults)
|
|
762
|
+
*/
|
|
763
|
+
loadMaskDefaults ? : MaskConfig
|
|
764
|
+
/**
|
|
765
|
+
* A [Mask](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Mask) config object to adjust the [maskDefaults](#Core/widget/Widget#config-maskDefaults)
|
|
766
|
+
* when an error occurs loading data.
|
|
767
|
+
* ...
|
|
768
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-loadMaskError)
|
|
769
|
+
*/
|
|
770
|
+
loadMaskError ? : MaskConfig|Mask|Boolean
|
|
771
|
+
/**
|
|
772
|
+
* Set to `false` to disable localization of this object.
|
|
773
|
+
*/
|
|
774
|
+
localizable ? : Boolean
|
|
775
|
+
/**
|
|
776
|
+
* Time in ms until a longpress is triggered
|
|
777
|
+
*/
|
|
778
|
+
longPressTime ? : number
|
|
779
|
+
/**
|
|
780
|
+
* This flag controls whether Scheduler should preserve its selection of events when loading a new dataset
|
|
781
|
+
* (if selected event ids are included in the newly loaded dataset).
|
|
782
|
+
*/
|
|
783
|
+
maintainSelectionOnDatasetChange ? : Boolean
|
|
784
|
+
/**
|
|
785
|
+
* When `true`, events are sized and positioned based on rowHeight, resourceMargin and barMargin settings.
|
|
786
|
+
* Set this to `false` if you want to control height and vertical position using CSS instead.
|
|
787
|
+
* ...
|
|
788
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-managedEventSizing)
|
|
789
|
+
*/
|
|
790
|
+
managedEventSizing ? : Boolean
|
|
791
|
+
/**
|
|
792
|
+
* Widget's margin. This may be configured as a single number or a `TRBL` format string.
|
|
793
|
+
* numeric-only values are interpreted as pixels.
|
|
794
|
+
*/
|
|
795
|
+
margin ? : number|string
|
|
796
|
+
/**
|
|
797
|
+
* Grids change the `maskDefaults` to cover only their `body` element.
|
|
798
|
+
*/
|
|
799
|
+
maskDefaults ? : MaskConfig
|
|
800
|
+
/**
|
|
801
|
+
* Set to `true` to apply the default mask to the widget. Alternatively, this can be the mask message or a
|
|
802
|
+
* [Mask](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Mask) config object.
|
|
803
|
+
*/
|
|
804
|
+
masked ? : Boolean|string|MaskConfig
|
|
805
|
+
/**
|
|
806
|
+
* Get/set end date limit of the timeline.
|
|
807
|
+
* Actions such as timeline scrolling, all types of timeline zooms and shifts
|
|
808
|
+
* will respect this limit.
|
|
809
|
+
*/
|
|
810
|
+
maxDate ? : Date|string
|
|
811
|
+
/**
|
|
812
|
+
* The element's maxHeight. Can be either a String or a Number (which will have 'px' appended). Note that
|
|
813
|
+
* like [height](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#config-height), *reading* the value will return the numeric value in pixels.
|
|
814
|
+
*/
|
|
815
|
+
maxHeight ? : string|number
|
|
816
|
+
/**
|
|
817
|
+
* The maximum time axis unit to display non-working ranges for ('hour' or 'day' etc).
|
|
818
|
+
* When zooming to a view with a larger unit, no non-working time elements will be rendered.
|
|
819
|
+
* ...
|
|
820
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-maxTimeAxisUnit)
|
|
821
|
+
*/
|
|
822
|
+
maxTimeAxisUnit ? : DurationUnit
|
|
823
|
+
/**
|
|
824
|
+
* The elements maxWidth. Can be either a String or a Number (which will have 'px' appended). Note that
|
|
825
|
+
* like [width](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#config-width), *reading* the value will return the numeric value in pixels.
|
|
826
|
+
*/
|
|
827
|
+
maxWidth ? : string|number
|
|
828
|
+
/**
|
|
829
|
+
* The maximum zoom level to which [zoomIn](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomIn) will work. Defaults to the number of
|
|
830
|
+
* [ViewPresets](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/preset/ViewPreset) available, see [presets](#Scheduler/view/mixin/TimelineViewPresets#property-presets)
|
|
831
|
+
* for information. Unless you have modified the collection of available presets, the max zoom level is
|
|
832
|
+
* milliseconds.
|
|
833
|
+
*/
|
|
834
|
+
maxZoomLevel ? : number
|
|
835
|
+
/**
|
|
836
|
+
* How to align milestones in relation to their startDate. Only applies when using a `milestoneLayoutMode`
|
|
837
|
+
* other than `default`. Valid values are:
|
|
838
|
+
* ...
|
|
839
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-milestoneAlign)
|
|
840
|
+
*/
|
|
841
|
+
milestoneAlign ? : 'start'|'center'|'end'
|
|
842
|
+
/**
|
|
843
|
+
* Factor representing the average char width in pixels used to determine milestone width when configured
|
|
844
|
+
* with `milestoneLayoutMode: 'estimate'`.
|
|
845
|
+
*/
|
|
846
|
+
milestoneCharWidth ? : number
|
|
847
|
+
/**
|
|
848
|
+
* How to handle milestones during event layout. How the milestones are displayed when part of the layout
|
|
849
|
+
* are controlled using [milestoneTextPosition](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/mixin/SchedulerEventRendering#config-milestoneTextPosition).
|
|
850
|
+
* ...
|
|
851
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-milestoneLayoutMode)
|
|
852
|
+
*/
|
|
853
|
+
milestoneLayoutMode ? : 'default'|'estimate'|'data'|'measure'
|
|
854
|
+
/**
|
|
855
|
+
* Position of the milestone text:
|
|
856
|
+
* ...
|
|
857
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-milestoneTextPosition)
|
|
858
|
+
*/
|
|
859
|
+
milestoneTextPosition ? : 'inside'|'outside'|'always-outside'
|
|
860
|
+
/**
|
|
861
|
+
* Get/set start date limit of the timeline.
|
|
862
|
+
* Actions such as timeline scrolling, all types of timeline zooms and shifts
|
|
863
|
+
* will respect this limit.
|
|
864
|
+
*/
|
|
865
|
+
minDate ? : Date|string
|
|
866
|
+
/**
|
|
867
|
+
* Grid's `min-height`. Defaults to `10em` to be sure that the Grid always has a height wherever it is
|
|
868
|
+
* inserted.
|
|
869
|
+
* ...
|
|
870
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-minHeight)
|
|
871
|
+
*/
|
|
872
|
+
minHeight ? : string|number
|
|
873
|
+
/**
|
|
874
|
+
* *Experimental* Minimum size that events should be allowed to shrink to when using `pack` layout. If
|
|
875
|
+
* packing leads to any event being smaller than this value, the row will grow in height instead to maintain
|
|
876
|
+
* this minimum size.
|
|
877
|
+
* ...
|
|
878
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-minPackSize)
|
|
879
|
+
*/
|
|
880
|
+
minPackSize ? : number
|
|
881
|
+
/**
|
|
882
|
+
* The elements minWidth. Can be either a String or a Number (which will have 'px' appended). Note that
|
|
883
|
+
* like [width](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#config-width), *reading* the value will return the numeric value in pixels.
|
|
884
|
+
*/
|
|
885
|
+
minWidth ? : string|number
|
|
886
|
+
/**
|
|
887
|
+
* The minimum zoom level to which [zoomOut](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomOut) will work. Defaults to 0 (year ticks)
|
|
888
|
+
*/
|
|
889
|
+
minZoomLevel ? : number
|
|
890
|
+
/**
|
|
891
|
+
* Scheduler mode. Supported values: horizontal, vertical
|
|
892
|
+
*/
|
|
893
|
+
mode ? : 'horizontal'|'vertical'
|
|
894
|
+
/**
|
|
895
|
+
* Grid monitors window resize by default.
|
|
896
|
+
*/
|
|
897
|
+
monitorResize ? : Boolean
|
|
898
|
+
/**
|
|
899
|
+
* Configure as `true` to allow `CTRL/CMD+click` to select multiple events in the scheduler.
|
|
900
|
+
* ...
|
|
901
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-multiEventSelect)
|
|
902
|
+
*/
|
|
903
|
+
multiEventSelect ? : Boolean|{
|
|
904
|
+
ctrlKey?: Boolean
|
|
905
|
+
altKey?: Boolean
|
|
906
|
+
shiftKey?: Boolean
|
|
907
|
+
}
|
|
908
|
+
/**
|
|
909
|
+
* When an event bar has a width less than this value, it gets the CSS class `b-sch-event-narrow`
|
|
910
|
+
* added. You may apply custom CSS rules using this class.
|
|
911
|
+
* ...
|
|
912
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-narrowEventWidth)
|
|
913
|
+
*/
|
|
914
|
+
narrowEventWidth ? : number
|
|
915
|
+
/**
|
|
916
|
+
* Override this method to provide a custom sort function to sort any overlapping events. This only applies
|
|
917
|
+
* to the horizontal mode, where the order the events are sorted in determines their vertical placement
|
|
918
|
+
* within a resource.
|
|
919
|
+
* ...
|
|
920
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-overlappingEventSorter)
|
|
921
|
+
* @param {Scheduler.model.SchedulerEventModel} a First event
|
|
922
|
+
* @param {Scheduler.model.SchedulerEventModel} b Second event
|
|
923
|
+
* @returns {number} Return -1 to display `a` above `b`, 1 for `b` above `a`
|
|
924
|
+
*/
|
|
925
|
+
overlappingEventSorter ? : (a: SchedulerEventModel, b: SchedulerEventModel) => number
|
|
926
|
+
/**
|
|
927
|
+
* The owning Widget of this Widget. If this Widget is directly contained (that is, it is one of the
|
|
928
|
+
* [items](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Container#property-items) of a Container), this config will be ignored. In this case
|
|
929
|
+
* the owner is <strong>always</strong> the encapsulating Container.
|
|
930
|
+
* ...
|
|
931
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-owner)
|
|
932
|
+
*/
|
|
933
|
+
owner ? : Widget|any
|
|
934
|
+
/**
|
|
935
|
+
* Partners this Timeline panel with another Timeline in order to sync their region sizes (sub-grids like locked, normal will get the same width),
|
|
936
|
+
* start and end dates, view preset, zoom level and scrolling position. All these values will be synced with the timeline defined as the `partner`.
|
|
937
|
+
* ...
|
|
938
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-partner)
|
|
939
|
+
*/
|
|
940
|
+
partner ? : TimelineBase
|
|
941
|
+
/**
|
|
942
|
+
* Set to `true` to include `startDate` and `endDate` params indicating the currently viewed date range in
|
|
943
|
+
* `EventStore` load requests (when loading using `AjaxStore` or `CrudManager` functionality).
|
|
944
|
+
* ...
|
|
945
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-passStartEndParameters)
|
|
946
|
+
*/
|
|
947
|
+
passStartEndParameters ? : Boolean
|
|
948
|
+
/**
|
|
949
|
+
* Specify plugins (an array of classes) in config
|
|
950
|
+
*/
|
|
951
|
+
plugins ? : Function[]
|
|
952
|
+
/**
|
|
953
|
+
* Maximum number of resources for which height is pre-calculated. If you have many events per
|
|
954
|
+
* resource you might want to lower this number to gain some initial rendering performance.
|
|
955
|
+
* ...
|
|
956
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-preCalculateHeightLimit)
|
|
957
|
+
*/
|
|
958
|
+
preCalculateHeightLimit ? : number
|
|
959
|
+
/**
|
|
960
|
+
* True to preserve focused cell after loading new data
|
|
961
|
+
*/
|
|
962
|
+
preserveFocusOnDatasetChange ? : Boolean
|
|
963
|
+
/**
|
|
964
|
+
* Preserve the grid's vertical scroll position when changesets are applied, as in the case of remote
|
|
965
|
+
* changes, or when stores are configured with [syncDataOnLoad](https://bryntum.com/products/schedulerpro/docs/api/Core/data/Store#config-syncDataOnLoad).
|
|
966
|
+
*/
|
|
967
|
+
preserveScroll ? : PreserveScrollOptions|Boolean
|
|
968
|
+
/**
|
|
969
|
+
* Specify `true` to preserve vertical scroll position after store actions that trigger a `refresh` event,
|
|
970
|
+
* such as loading new data and filtering.
|
|
971
|
+
*/
|
|
972
|
+
preserveScrollOnDatasetChange ? : Boolean
|
|
973
|
+
/**
|
|
974
|
+
* An array of [ViewPreset](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/preset/ViewPreset) config objects
|
|
975
|
+
* which describes the available timeline layouts for this scheduler.
|
|
976
|
+
* ...
|
|
977
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-presets)
|
|
978
|
+
*/
|
|
979
|
+
presets ? : ViewPresetConfig[]
|
|
980
|
+
/**
|
|
981
|
+
* Prevent tooltip from being displayed on touch devices. Useful for example for buttons that display a
|
|
982
|
+
* menu on click etc, since the tooltip would be displayed at the same time.
|
|
983
|
+
*/
|
|
984
|
+
preventTooltipOnTouch ? : Boolean
|
|
985
|
+
/**
|
|
986
|
+
* Project config object or a Project instance
|
|
987
|
+
*/
|
|
988
|
+
project ? : ProjectModel|ProjectModelConfig|object
|
|
989
|
+
/**
|
|
990
|
+
* Range used to set the length of the time axis when used as a component of a Calendar. Suitable units are
|
|
991
|
+
* `'month'`, `'week'` and `'day'`.
|
|
992
|
+
* ...
|
|
993
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-range)
|
|
994
|
+
*/
|
|
995
|
+
range ? : string|DurationConfig
|
|
996
|
+
/**
|
|
997
|
+
* Configure as `true` to make the scheduler read-only, by disabling any UIs for modifying data.
|
|
998
|
+
* ...
|
|
999
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-readOnly)
|
|
1000
|
+
*/
|
|
1001
|
+
readOnly ? : Boolean
|
|
1002
|
+
/**
|
|
1003
|
+
* The confirmation dialog shown when a recurring event is edited.
|
|
1004
|
+
* ...
|
|
1005
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-recurrenceConfirmationPopup)
|
|
1006
|
+
*/
|
|
1007
|
+
recurrenceConfirmationPopup ? : RecurrenceConfirmationPopupConfig|RecurrenceConfirmationPopup
|
|
1008
|
+
relayStoreEvents ? : Boolean
|
|
1009
|
+
/**
|
|
1010
|
+
* Either a default `rendition` to apply to all child widgets, or a map of renditions keyed by child widget
|
|
1011
|
+
* `type`.
|
|
1012
|
+
* ...
|
|
1013
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-rendition)
|
|
1014
|
+
*/
|
|
1015
|
+
rendition ? : string|Record<string, string>|null
|
|
1016
|
+
/**
|
|
1017
|
+
* Configure this property to allow the widget/component to be resized. Pressing <kbd>Shift</kbd> while resizing will
|
|
1018
|
+
* constrain the aspect ratio.
|
|
1019
|
+
* ...
|
|
1020
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-resizable)
|
|
1021
|
+
*/
|
|
1022
|
+
resizable ? : Boolean|{
|
|
1023
|
+
minWidth?: number
|
|
1024
|
+
maxWidth?: number
|
|
1025
|
+
minHeight?: number
|
|
1026
|
+
maxHeight?: number
|
|
1027
|
+
handles?: object
|
|
1028
|
+
}
|
|
1029
|
+
/**
|
|
1030
|
+
* Set to `false` to only measure cell contents when double-clicking the edge between column headers.
|
|
1031
|
+
*/
|
|
1032
|
+
resizeToFitIncludesHeader ? : Boolean
|
|
1033
|
+
/**
|
|
1034
|
+
* A config object used to configure the resource columns in vertical mode.
|
|
1035
|
+
* See [ResourceHeader](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/ResourceHeader) for more details on available properties.
|
|
1036
|
+
* ...
|
|
1037
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-resourceColumns)
|
|
1038
|
+
*/
|
|
1039
|
+
resourceColumns ? : ResourceHeaderConfig
|
|
1040
|
+
/**
|
|
1041
|
+
* Resource image extension, used when creating image path from resource name.
|
|
1042
|
+
*/
|
|
1043
|
+
resourceImageExtension ? : string
|
|
1044
|
+
/**
|
|
1045
|
+
* Path to load resource images from. Used by the resource header in vertical mode and the
|
|
1046
|
+
* [ResourceInfoColumn](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/column/ResourceInfoColumn) in horizontal mode. Set this to display miniature
|
|
1047
|
+
* images for each resource using their `image` or `imageUrl` fields.
|
|
1048
|
+
* ...
|
|
1049
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-resourceImagePath)
|
|
1050
|
+
*/
|
|
1051
|
+
resourceImagePath ? : string
|
|
1052
|
+
/**
|
|
1053
|
+
* Convenience config to set both [resourceImagePath](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/mixin/SchedulerResourceRendering#config-resourceImagePath) and [resourceImageExtension](#Scheduler/view/mixin/SchedulerResourceRendering#config-resourceImageExtension).
|
|
1054
|
+
* ...
|
|
1055
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-resourceImages)
|
|
1056
|
+
*/
|
|
1057
|
+
resourceImages ? : {
|
|
1058
|
+
path?: string
|
|
1059
|
+
extension?: string
|
|
1060
|
+
}
|
|
1061
|
+
/**
|
|
1062
|
+
* Control how much space to leave between the first event/last event and the resources edge (top/bottom
|
|
1063
|
+
* margin within the resource row in horizontal mode, left/right margin within the resource column in
|
|
1064
|
+
* vertical mode), in px. Defaults to the value of [barMargin](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/Scheduler#config-barMargin).
|
|
1065
|
+
* ...
|
|
1066
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-resourceMargin)
|
|
1067
|
+
*/
|
|
1068
|
+
resourceMargin ? : number|ResourceMarginConfig
|
|
1069
|
+
/**
|
|
1070
|
+
* Inline resources, will be loaded into an internally created ResourceStore.
|
|
1071
|
+
*/
|
|
1072
|
+
resources ? : SchedulerResourceModel[]|SchedulerResourceModelConfig[]
|
|
1073
|
+
/**
|
|
1074
|
+
* The [ResourceStore](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/data/ResourceStore) holding the resources to be rendered into the scheduler (required).
|
|
1075
|
+
*/
|
|
1076
|
+
resourceStore ? : SchedulerResourceStore|SchedulerResourceStoreConfig
|
|
1077
|
+
/**
|
|
1078
|
+
* An empty function by default, but provided so that you can override it. This function is called each time
|
|
1079
|
+
* a resource time range is rendered into the schedule. It's called with `resourceTimeRangeRecord`, `resourceRecord`,
|
|
1080
|
+
* and `renderData` params.
|
|
1081
|
+
* ...
|
|
1082
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-resourceTimeRangeRenderer)
|
|
1083
|
+
* @param {object} detail An object containing the information needed to render a ResourceTimeRangeModel.
|
|
1084
|
+
* @param {Scheduler.model.ResourceTimeRangeModel} detail.resourceTimeRangeRecord The resource time range record.
|
|
1085
|
+
* @param {Scheduler.model.SchedulerResourceModel} detail.resourceRecord The resource record.
|
|
1086
|
+
* @param {object} detail.renderData An object containing details about the event rendering.
|
|
1087
|
+
* @returns {string,DomConfig,DomConfig[]} A simple string, or a DomConfig object describing the markup
|
|
1088
|
+
*/
|
|
1089
|
+
resourceTimeRangeRenderer ? : (detail: { resourceTimeRangeRecord: ResourceTimeRangeModel, resourceRecord: SchedulerResourceModel, renderData: object }) => string|DomConfig|DomConfig[]
|
|
1090
|
+
/**
|
|
1091
|
+
* Inline resource time ranges, will be loaded into an internally created store if
|
|
1092
|
+
* [ResourceTimeRanges](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ResourceTimeRanges) is enabled.
|
|
1093
|
+
*/
|
|
1094
|
+
resourceTimeRanges ? : ResourceTimeRangeModel[]|ResourceTimeRangeModelConfig[]
|
|
1095
|
+
/**
|
|
1096
|
+
* Resource time ranges store instance or config object for [ResourceTimeRanges](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ResourceTimeRanges) feature.
|
|
1097
|
+
*/
|
|
1098
|
+
resourceTimeRangeStore ? : ResourceTimeRangeStore|ResourceTimeRangeStoreConfig
|
|
1099
|
+
/**
|
|
1100
|
+
* "Break points" for which responsive config to use.
|
|
1101
|
+
* ...
|
|
1102
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-responsiveLevels)
|
|
1103
|
+
*/
|
|
1104
|
+
responsiveLevels ? : Record<string, number|string|SchedulerResponsiveLevelConfig>
|
|
1105
|
+
/**
|
|
1106
|
+
* Configure as `true` to have the component display a translucent ripple when its
|
|
1107
|
+
* [focusElement](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#property-focusElement), or [element](#Core/widget/Widget#property-element) is tapped <em>if the
|
|
1108
|
+
* current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
|
|
1109
|
+
* ...
|
|
1110
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-ripple)
|
|
1111
|
+
*/
|
|
1112
|
+
ripple ? : Boolean|{
|
|
1113
|
+
delegate?: string
|
|
1114
|
+
color?: string
|
|
1115
|
+
radius?: number
|
|
1116
|
+
clip?: string
|
|
1117
|
+
}
|
|
1118
|
+
/**
|
|
1119
|
+
* 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`
|
|
1120
|
+
*/
|
|
1121
|
+
rootElement ? : ShadowRoot|HTMLElement
|
|
1122
|
+
/**
|
|
1123
|
+
* The height in pixels of Scheduler rows.
|
|
1124
|
+
*/
|
|
1125
|
+
rowHeight ? : number
|
|
1126
|
+
/**
|
|
1127
|
+
* Set to `false` to not show row lines. End result might be overruled by/differ between themes.
|
|
1128
|
+
*/
|
|
1129
|
+
rowLines ? : Boolean
|
|
1130
|
+
/**
|
|
1131
|
+
* This may be configured as `true` to make the widget's element use the `direction:rtl` style.
|
|
1132
|
+
* ...
|
|
1133
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-rtl)
|
|
1134
|
+
*/
|
|
1135
|
+
rtl ? : Boolean
|
|
1136
|
+
/**
|
|
1137
|
+
* Configures whether the grid is scrollable in the `Y` axis. This is used to configure a [Scroller](https://bryntum.com/products/schedulerpro/docs/api/Core/helper/util/Scroller).
|
|
1138
|
+
* See the [scrollerClass](https://bryntum.com/products/schedulerpro/docs/api/Grid/view/GridBase#config-scrollerClass) config option.
|
|
1139
|
+
* ...
|
|
1140
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-scrollable)
|
|
1141
|
+
*/
|
|
1142
|
+
scrollable ? : Boolean|ScrollerConfig|Scroller
|
|
1143
|
+
/**
|
|
1144
|
+
* The class to instantiate to use as the [scrollable](https://bryntum.com/products/schedulerpro/docs/api/Grid/view/GridBase#config-scrollable). Defaults to [Scroller](#Core/helper/util/Scroller).
|
|
1145
|
+
*/
|
|
1146
|
+
scrollerClass ? : typeof Scroller
|
|
1147
|
+
/**
|
|
1148
|
+
* Specifies the maximum duration for extending the current [TimeSpan](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/model/TimeSpan) to allow for smooth
|
|
1149
|
+
* scrolling to an event.
|
|
1150
|
+
* ...
|
|
1151
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-scrollExtensionThreshold)
|
|
1152
|
+
*/
|
|
1153
|
+
scrollExtensionThreshold ? : string|DurationConfig
|
|
1154
|
+
/**
|
|
1155
|
+
* Configuration values for the [ScrollManager](https://bryntum.com/products/schedulerpro/docs/api/Core/util/ScrollManager) class on initialization. Returns the
|
|
1156
|
+
* [ScrollManager](https://bryntum.com/products/schedulerpro/docs/api/Core/util/ScrollManager) at runtime.
|
|
1157
|
+
*/
|
|
1158
|
+
scrollManager ? : ScrollManagerConfig|ScrollManager
|
|
1159
|
+
/**
|
|
1160
|
+
* Selection configuration settings, change these properties to control how selection works and what can be
|
|
1161
|
+
* selected.
|
|
1162
|
+
* ...
|
|
1163
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-selectionMode)
|
|
1164
|
+
*/
|
|
1165
|
+
selectionMode ? : GridSelectionMode
|
|
1166
|
+
/**
|
|
1167
|
+
* Set to `false` to not select the resource of the event when clicking an event bar.
|
|
1168
|
+
*/
|
|
1169
|
+
selectResourceOnEventNavigate ? : Boolean
|
|
1170
|
+
/**
|
|
1171
|
+
* Set to `false` to not select the row/resource when clicking the empty area in a time axis cell.
|
|
1172
|
+
*/
|
|
1173
|
+
selectResourceOnScheduleClick ? : Boolean
|
|
1174
|
+
/**
|
|
1175
|
+
* <div class="note">This property is for use when the Scheduler is used as a Calendar view - a `mode`.
|
|
1176
|
+
* it will have no effect on a Scheduler which is not inside a Calendar.</div>
|
|
1177
|
+
* The time range to move by when [next](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/SchedulerBase#function-next) or [previous](#Scheduler/view/SchedulerBase#function-previous) is called.
|
|
1178
|
+
* ...
|
|
1179
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-shiftIncrement)
|
|
1180
|
+
*/
|
|
1181
|
+
shiftIncrement ? : string|DurationConfig
|
|
1182
|
+
/**
|
|
1183
|
+
* `false` to not show a tooltip while creating a dependency
|
|
1184
|
+
*/
|
|
1185
|
+
showCreationTooltip ? : Boolean
|
|
1186
|
+
/**
|
|
1187
|
+
* Configure as `true` to have the grid show a red "changed" tag in cells whose
|
|
1188
|
+
* field value has changed and not yet been committed.
|
|
1189
|
+
* ...
|
|
1190
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-showDirty)
|
|
1191
|
+
*/
|
|
1192
|
+
showDirty ? : Boolean|{
|
|
1193
|
+
duringEdit?: Boolean
|
|
1194
|
+
newRecord?: Boolean
|
|
1195
|
+
}
|
|
1196
|
+
/**
|
|
1197
|
+
* If set to `true` this will show a color field in the [EventEdit](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventEdit) editor and also a
|
|
1198
|
+
* picker in the [EventMenu](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventMenu). Both enables the user to choose a color which will be
|
|
1199
|
+
* applied to the event bar's background. See EventModel's
|
|
1200
|
+
* [eventColor](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/model/mixin/EventModelMixin#field-eventColor) config.
|
|
1201
|
+
* config.
|
|
1202
|
+
*/
|
|
1203
|
+
showEventColorPickers ? : Boolean
|
|
1204
|
+
/**
|
|
1205
|
+
* Set to `true` to show the lag in the tooltip
|
|
1206
|
+
*/
|
|
1207
|
+
showLagInTooltip ? : Boolean
|
|
1208
|
+
/**
|
|
1209
|
+
* Set to `false` to hide recurring fields in event editor, even if the
|
|
1210
|
+
* [Recurring Events](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/mixin/RecurringEvents#config-enableRecurringEvents) is `true`
|
|
1211
|
+
* and a recurring event is being edited.
|
|
1212
|
+
*/
|
|
1213
|
+
showRecurringUI ? : Boolean
|
|
1214
|
+
/**
|
|
1215
|
+
* Set to `true` to show a tooltip when hovering a dependency line
|
|
1216
|
+
*/
|
|
1217
|
+
showTooltip ? : Boolean
|
|
1218
|
+
/**
|
|
1219
|
+
* Set to `true` to snap to the current time resolution increment while interacting with scheduled events.
|
|
1220
|
+
* ...
|
|
1221
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-snap)
|
|
1222
|
+
*/
|
|
1223
|
+
snap ? : Boolean
|
|
1224
|
+
/**
|
|
1225
|
+
* Affects drag drop and resizing of events when [snap](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/mixin/TimelineDateMapper#config-snap)
|
|
1226
|
+
* is enabled.
|
|
1227
|
+
* ...
|
|
1228
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-snapRelativeToEventStartDate)
|
|
1229
|
+
*/
|
|
1230
|
+
snapRelativeToEventStartDate ? : Boolean
|
|
1231
|
+
/**
|
|
1232
|
+
* Programmatic control over how many columns to span when used in a grid layout.
|
|
1233
|
+
*/
|
|
1234
|
+
span ? : number
|
|
1235
|
+
/**
|
|
1236
|
+
* The start date of the timeline (if not configure with [infiniteScroll](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/TimelineBase#config-infiniteScroll)).
|
|
1237
|
+
* ...
|
|
1238
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-startDate)
|
|
1239
|
+
*/
|
|
1240
|
+
startDate ? : Date|string
|
|
1241
|
+
/**
|
|
1242
|
+
* The name of the start date parameter that will be passed to in every `eventStore` load request.
|
|
1243
|
+
*/
|
|
1244
|
+
startParamName ? : string
|
|
1245
|
+
/**
|
|
1246
|
+
* This value can be one of the following:
|
|
1247
|
+
* ...
|
|
1248
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-stateful)
|
|
1249
|
+
*/
|
|
1250
|
+
stateful ? : Boolean|object|string[]
|
|
1251
|
+
/**
|
|
1252
|
+
* The events that, when fired by this component, should trigger it to save its state by calling
|
|
1253
|
+
* [saveState](https://bryntum.com/products/schedulerpro/docs/api/Core/mixin/State#function-saveState).
|
|
1254
|
+
* ...
|
|
1255
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-statefulEvents)
|
|
1256
|
+
*/
|
|
1257
|
+
statefulEvents ? : object|string[]
|
|
1258
|
+
/**
|
|
1259
|
+
* The key to use when saving this object's state in the [stateProvider](https://bryntum.com/products/schedulerpro/docs/api/Core/mixin/State#config-stateProvider). If this config is
|
|
1260
|
+
* not assigned, and [stateful](https://bryntum.com/products/schedulerpro/docs/api/Core/mixin/State#config-stateful) is not set to `false`, the [id](#Core/widget/Widget#config-id)
|
|
1261
|
+
* (if explicitly specified) will be used as the `stateId`.
|
|
1262
|
+
* ...
|
|
1263
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-stateId)
|
|
1264
|
+
*/
|
|
1265
|
+
stateId ? : string
|
|
1266
|
+
/**
|
|
1267
|
+
* The `StateProvider` to use to save and restore this object's [state](https://bryntum.com/products/schedulerpro/docs/api/Core/mixin/State#property-state). By default, `state`
|
|
1268
|
+
* will be saved using the [default state provider](https://bryntum.com/products/schedulerpro/docs/api/Core/state/StateProvider#property-instance-static).
|
|
1269
|
+
* ...
|
|
1270
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-stateProvider)
|
|
1271
|
+
*/
|
|
1272
|
+
stateProvider ? : StateProvider
|
|
1273
|
+
/**
|
|
1274
|
+
* The properties of this settings object controls how grid is restored from state data.
|
|
1275
|
+
* ...
|
|
1276
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-stateSettings)
|
|
1277
|
+
*/
|
|
1278
|
+
stateSettings ? : {
|
|
1279
|
+
restoreUnconfiguredColumns?: Boolean
|
|
1280
|
+
}
|
|
1281
|
+
/**
|
|
1282
|
+
* When set, the text in the major time axis header sticks in the scrolling viewport as long as possible.
|
|
1283
|
+
*/
|
|
1284
|
+
stickyHeaders ? : Boolean
|
|
1285
|
+
/**
|
|
1286
|
+
* Store that holds records to display in the grid, or a store config object. If the configuration contains
|
|
1287
|
+
* a `readUrl`, an `AjaxStore` will be created.
|
|
1288
|
+
* ...
|
|
1289
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-store)
|
|
1290
|
+
*/
|
|
1291
|
+
store ? : Store|StoreConfig|AjaxStore|AjaxStoreConfig
|
|
1292
|
+
/**
|
|
1293
|
+
* An object containing widgets keyed by name. By default (when no `type` is given), strips are
|
|
1294
|
+
* [toolbars](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Toolbar). If you want to pass an array, you can use
|
|
1295
|
+
* the toolbar's [items](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Container#config-items).
|
|
1296
|
+
* ...
|
|
1297
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-strips)
|
|
1298
|
+
*/
|
|
1299
|
+
strips ? : Record<string, SchedulerProContainerItemConfig>
|
|
1300
|
+
/**
|
|
1301
|
+
* An object containing sub grid configuration objects keyed by a `region` property.
|
|
1302
|
+
* By default, grid has a 'locked' region (if configured with locked columns) and a 'normal' region.
|
|
1303
|
+
* The 'normal' region defaults to use `flex: 1`.
|
|
1304
|
+
* ...
|
|
1305
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-subGridConfigs)
|
|
1306
|
+
*/
|
|
1307
|
+
subGridConfigs ? : Record<string, SubGridConfig>
|
|
1308
|
+
/**
|
|
1309
|
+
* Set to `true` to prevent auto calculating of a minimal [tickSize](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/mixin/TimelineEventRendering#property-tickSize)
|
|
1310
|
+
* to always fit the content to the screen size. Setting this property on `true` will disable [forceFit](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/TimelineBase#config-forceFit) behaviour.
|
|
1311
|
+
*/
|
|
1312
|
+
suppressFit ? : Boolean
|
|
1313
|
+
/**
|
|
1314
|
+
* A [Mask](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Mask) config object, or a message to be shown when Crud Manager
|
|
1315
|
+
* is persisting changes on the server. Set to `null` to disable default sync mask.
|
|
1316
|
+
* ...
|
|
1317
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-syncMask)
|
|
1318
|
+
*/
|
|
1319
|
+
syncMask ? : string|MaskConfig|null
|
|
1320
|
+
/**
|
|
1321
|
+
* A configuration for the [tab](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Tab) created for this widget when it is placed in a
|
|
1322
|
+
* [TabPanel](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/TabPanel). For example, this config can be used to control the icon of the `tab` for
|
|
1323
|
+
* this widget:
|
|
1324
|
+
* ...
|
|
1325
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-tab)
|
|
1326
|
+
*/
|
|
1327
|
+
tab ? : Boolean|TabConfig
|
|
1328
|
+
/**
|
|
1329
|
+
* When this container is used as a tab in a TabPanel, these items are added to the
|
|
1330
|
+
* [TabBar](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/TabBar) when this container is the active tab.
|
|
1331
|
+
* ...
|
|
1332
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-tabBarItems)
|
|
1333
|
+
*/
|
|
1334
|
+
tabBarItems ? : ToolbarItems[]|Widget[]
|
|
1335
|
+
/**
|
|
1336
|
+
* A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Toolbar),
|
|
1337
|
+
* or array of config objects representing the child items of a Toolbar.
|
|
1338
|
+
* This creates a toolbar docked to the top of the panel immediately below the header.
|
|
1339
|
+
* ...
|
|
1340
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-tbar)
|
|
1341
|
+
*/
|
|
1342
|
+
tbar ? : (SchedulerProContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
|
|
1343
|
+
/**
|
|
1344
|
+
* CSS class used for terminals
|
|
1345
|
+
*/
|
|
1346
|
+
terminalCls ? : string
|
|
1347
|
+
/**
|
|
1348
|
+
* Delay in ms before hiding the terminals when the mouse leaves an event bar or terminal.
|
|
1349
|
+
* ...
|
|
1350
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-terminalHideDelay)
|
|
1351
|
+
*/
|
|
1352
|
+
terminalHideDelay ? : number
|
|
1353
|
+
/**
|
|
1354
|
+
* Terminal offset from their initial position, in px. Positive values move terminals further away from the
|
|
1355
|
+
* event bar, negative values inside the event bar.
|
|
1356
|
+
* ...
|
|
1357
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-terminalOffset)
|
|
1358
|
+
*/
|
|
1359
|
+
terminalOffset ? : number
|
|
1360
|
+
/**
|
|
1361
|
+
* Delay in ms before showing the terminals when hovering over an event bar.
|
|
1362
|
+
* ...
|
|
1363
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-terminalShowDelay)
|
|
1364
|
+
*/
|
|
1365
|
+
terminalShowDelay ? : number
|
|
1366
|
+
/**
|
|
1367
|
+
* Where (on event bar edges) to display terminals. The sides are `'start'`, `'top'`,
|
|
1368
|
+
* `'end'` and `'bottom'`
|
|
1369
|
+
*/
|
|
1370
|
+
terminalSides ? : string[]
|
|
1371
|
+
/**
|
|
1372
|
+
* Terminal diameter in px, overrides the default CSS value for it (which might depend on theme).
|
|
1373
|
+
* ...
|
|
1374
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-terminalSize)
|
|
1375
|
+
*/
|
|
1376
|
+
terminalSize ? : number|string
|
|
1377
|
+
/**
|
|
1378
|
+
* The width/height (depending on vertical / horizontal mode) of all the time columns.
|
|
1379
|
+
* ...
|
|
1380
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-tickSize)
|
|
1381
|
+
*/
|
|
1382
|
+
tickSize ? : number
|
|
1383
|
+
/**
|
|
1384
|
+
* A [TimeAxis](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/data/TimeAxis) config object or instance, used to create a backing data store of
|
|
1385
|
+
* 'ticks' providing the input date data for the time axis of timeline panel. Created automatically if none
|
|
1386
|
+
* supplied.
|
|
1387
|
+
*/
|
|
1388
|
+
timeAxis ? : TimeAxisConfig|TimeAxis
|
|
1389
|
+
/**
|
|
1390
|
+
* Inline time ranges, will be loaded into an internally created store if [TimeRanges](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/TimeRanges)
|
|
1391
|
+
* is enabled.
|
|
1392
|
+
*/
|
|
1393
|
+
timeRanges ? : TimeSpan[]|TimeSpanConfig[]
|
|
1394
|
+
/**
|
|
1395
|
+
* The time ranges store instance for [TimeRanges](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/TimeRanges) feature.
|
|
1396
|
+
*/
|
|
1397
|
+
timeRangeStore ? : Store|StoreConfig
|
|
1398
|
+
/**
|
|
1399
|
+
* Gets/sets the current time resolution object, which contains a unit identifier and an increment count
|
|
1400
|
+
* `{ unit, increment }`. This value means minimal task duration you can create using UI.
|
|
1401
|
+
* ...
|
|
1402
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-timeResolution)
|
|
1403
|
+
*/
|
|
1404
|
+
timeResolution ? : {
|
|
1405
|
+
increment?: number
|
|
1406
|
+
unit?: DurationUnit
|
|
1407
|
+
}|number
|
|
1408
|
+
/**
|
|
1409
|
+
* A title to display in the header or owning TabPanel. Causes creation and docking of a header
|
|
1410
|
+
* to the top if no header is configured.
|
|
1411
|
+
* ...
|
|
1412
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-title)
|
|
1413
|
+
*/
|
|
1414
|
+
title ? : string
|
|
1415
|
+
/**
|
|
1416
|
+
* The [tools](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Tool) to add either before or after the `title` in the Panel header. Each
|
|
1417
|
+
* property name is the reference by which an instantiated tool may be retrieved from the live
|
|
1418
|
+
* `[tools](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/mixin/Toolable#property-tools)` property.
|
|
1419
|
+
* ...
|
|
1420
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-tools)
|
|
1421
|
+
*/
|
|
1422
|
+
tools ? : Record<string, ToolConfig>|null
|
|
1423
|
+
/**
|
|
1424
|
+
* A template function allowing you to configure the contents of the tooltip shown when hovering a
|
|
1425
|
+
* dependency line. You can return either an HTML string or a [DomConfig](https://bryntum.com/products/schedulerpro/docs/api/Core/helper/DomHelper#typedef-DomConfig) object.
|
|
1426
|
+
* @param {Scheduler.model.DependencyBaseModel} dependency The dependency record
|
|
1427
|
+
* @returns {string,DomConfig}
|
|
1428
|
+
*/
|
|
1429
|
+
tooltipTemplate ? : (dependency: DependencyBaseModel) => string|DomConfig
|
|
1430
|
+
/**
|
|
1431
|
+
* Configure UI transitions for various actions in the grid.
|
|
1432
|
+
*/
|
|
1433
|
+
transition ? : {
|
|
1434
|
+
insertRecord?: Boolean
|
|
1435
|
+
removeRecord?: Boolean
|
|
1436
|
+
toggleColumn?: Boolean
|
|
1437
|
+
expandCollapseColumn?: Boolean
|
|
1438
|
+
toggleRegion?: Boolean
|
|
1439
|
+
toggleTreeNode?: Boolean
|
|
1440
|
+
toggleGroup?: Boolean
|
|
1441
|
+
filterRemoval?: Boolean
|
|
1442
|
+
removeEvent?: Boolean
|
|
1443
|
+
changeEvent?: Boolean
|
|
1444
|
+
}
|
|
1445
|
+
/**
|
|
1446
|
+
* Animation transition duration in milliseconds.
|
|
1447
|
+
*/
|
|
1448
|
+
transitionDuration ? : number
|
|
1449
|
+
/**
|
|
1450
|
+
* Configure as `true` to trigger `selectionChange` when removing a selected event/assignment.
|
|
1451
|
+
*/
|
|
1452
|
+
triggerSelectionChangeOnRemove ? : Boolean
|
|
1453
|
+
type ? : 'timeline'
|
|
1454
|
+
/**
|
|
1455
|
+
* Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
|
|
1456
|
+
* as a space separated string, an array of strings, or as an object in which property names with truthy
|
|
1457
|
+
* values are used as the class names.
|
|
1458
|
+
* ...
|
|
1459
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-ui)
|
|
1460
|
+
*/
|
|
1461
|
+
ui ? : 'plain'|'toolbar'|string|object
|
|
1462
|
+
/**
|
|
1463
|
+
* By default, scrolling the schedule will update the [timelineContext](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/SchedulerBase#property-timelineContext) to reflect the new
|
|
1464
|
+
* currently hovered context. When displaying a large number of events on screen at the same time, this will
|
|
1465
|
+
* have a slight impact on scrolling performance. In such scenarios, opt out of this behavior by setting
|
|
1466
|
+
* this config to `false`.
|
|
1467
|
+
*/
|
|
1468
|
+
updateTimelineContextOnScroll ? : Boolean
|
|
1469
|
+
/**
|
|
1470
|
+
* By default, the day of week and week of month of the event's start date are used to create
|
|
1471
|
+
* helpful contextual recurrence types when editing a non-recurring event record and choosing
|
|
1472
|
+
* an initial recurrence type.
|
|
1473
|
+
* ...
|
|
1474
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-useContextualRecurrenceRules)
|
|
1475
|
+
*/
|
|
1476
|
+
useContextualRecurrenceRules ? : Boolean
|
|
1477
|
+
/**
|
|
1478
|
+
* By default, scheduler fade events in on load. Specify `false` to prevent this animation or specify one
|
|
1479
|
+
* of the available animation types to use it (`true` equals `'fade-in'`):
|
|
1480
|
+
* ...
|
|
1481
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-useInitialAnimation)
|
|
1482
|
+
*/
|
|
1483
|
+
useInitialAnimation ? : Boolean|'fade-in'|'slide-from-left'|'slide-from-top'|string
|
|
1484
|
+
/**
|
|
1485
|
+
* The time axis column config for vertical [mode](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/SchedulerBase#config-mode).
|
|
1486
|
+
* ...
|
|
1487
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-verticalTimeAxisColumn)
|
|
1488
|
+
*/
|
|
1489
|
+
verticalTimeAxisColumn ? : VerticalTimeAxisColumnConfig
|
|
1490
|
+
/**
|
|
1491
|
+
* A string key used to lookup a predefined [ViewPreset](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/preset/ViewPreset) (e.g. 'weekAndDay', 'hourAndDay'),
|
|
1492
|
+
* managed by [PresetManager](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/preset/PresetManager). See [PresetManager](#Scheduler/preset/PresetManager) for more information.
|
|
1493
|
+
* Or a config object for a viewPreset.
|
|
1494
|
+
* ...
|
|
1495
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-viewPreset)
|
|
1496
|
+
*/
|
|
1497
|
+
viewPreset ? : string|ViewPresetConfig
|
|
1498
|
+
/**
|
|
1499
|
+
* A date to bring into view initially on the scrollable timeline.
|
|
1500
|
+
* ...
|
|
1501
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-visibleDate)
|
|
1502
|
+
*/
|
|
1503
|
+
visibleDate ? : Date|VisibleDate
|
|
1504
|
+
/**
|
|
1505
|
+
* Integer number indicating the size of timespan during zooming. When zooming, the timespan is adjusted to make
|
|
1506
|
+
* the scrolling area `visibleZoomFactor` times wider than the timeline area itself. Used in
|
|
1507
|
+
* [zoomToSpan](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomToSpan) and [zoomToLevel](#Scheduler/view/mixin/TimelineZoomable#function-zoomToLevel) functions.
|
|
1508
|
+
*/
|
|
1509
|
+
visibleZoomFactor ? : number
|
|
1510
|
+
/**
|
|
1511
|
+
* A valid JS day index between 0-6 (0: Sunday, 1: Monday etc.) to be considered the start day of the week.
|
|
1512
|
+
* When omitted, the week start day is retrieved from the active locale class.
|
|
1513
|
+
*/
|
|
1514
|
+
weekStartDay ? : number
|
|
1515
|
+
/**
|
|
1516
|
+
* A widgets weight determines its position among siblings when added to a [Container](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Container).
|
|
1517
|
+
* Higher weights go further down.
|
|
1518
|
+
*/
|
|
1519
|
+
weight ? : number
|
|
1520
|
+
/**
|
|
1521
|
+
* Widget's width, used to set element `style.width`. Either specify a valid width string or a number, which
|
|
1522
|
+
* will get 'px' appended. We recommend using CSS as the primary way to control width, but in some cases
|
|
1523
|
+
* this config is convenient.
|
|
1524
|
+
*/
|
|
1525
|
+
width ? : string|number
|
|
1526
|
+
/**
|
|
1527
|
+
* An object with format `{ fromDay, toDay, fromHour, toHour }` that describes the working days and hours.
|
|
1528
|
+
* This object will be used to populate TimeAxis [include](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/data/TimeAxis#config-include) property.
|
|
1529
|
+
* ...
|
|
1530
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-workingTime)
|
|
1531
|
+
*/
|
|
1532
|
+
workingTime ? : {
|
|
1533
|
+
fromDay?: number
|
|
1534
|
+
toDay?: number
|
|
1535
|
+
fromHour?: number
|
|
1536
|
+
toHour?: number
|
|
1537
|
+
}
|
|
1538
|
+
/**
|
|
1539
|
+
* Whether the originally rendered timespan should be preserved while zooming. By default, it is set to `false`,
|
|
1540
|
+
* meaning the timeline panel will adjust the currently rendered timespan to limit the amount of HTML content to
|
|
1541
|
+
* render. When setting this option to `true`, be careful not to allow to zoom a big timespan in seconds
|
|
1542
|
+
* resolution for example. That will cause <strong>a lot</strong> of HTML content to be rendered and affect performance. You
|
|
1543
|
+
* can use [minZoomLevel](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/mixin/TimelineZoomable#config-minZoomLevel) and [maxZoomLevel](#Scheduler/view/mixin/TimelineZoomable#config-maxZoomLevel) config options for that.
|
|
1544
|
+
*/
|
|
1545
|
+
zoomKeepsOriginalTimespan ? : Boolean
|
|
1546
|
+
/**
|
|
1547
|
+
* If true, you can zoom in and out on the time axis using CTRL-key + mouse wheel.
|
|
1548
|
+
*/
|
|
1549
|
+
zoomOnMouseWheel ? : Boolean
|
|
1550
|
+
/**
|
|
1551
|
+
* True to zoom to time span when double-clicking a time axis cell.
|
|
1552
|
+
*/
|
|
1553
|
+
zoomOnTimeAxisDoubleClick ? : Boolean
|
|
1554
|
+
|
|
1555
|
+
// Features
|
|
1556
|
+
/**
|
|
1557
|
+
* AI-powered filter feature for Grid. Allows users to type natural language queries to filter grid data.
|
|
1558
|
+
* ...
|
|
1559
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ai/AIFilter)
|
|
1560
|
+
*/
|
|
1561
|
+
aiFilterFeature ? : object|Boolean|string|AIFilter|AIFilterConfig
|
|
1562
|
+
/**
|
|
1563
|
+
* Allows using `[Ctrl/CMD + C]`, `[Ctrl/CMD + X]` and `[Ctrl/CMD + V]` to cut, copy and paste cell or cell ranges. Also
|
|
1564
|
+
* makes cut, copy and paste actions available via the cell context menu.
|
|
1565
|
+
* ...
|
|
1566
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellCopyPaste)
|
|
1567
|
+
*/
|
|
1568
|
+
cellCopyPasteFeature ? : object|Boolean|string|CellCopyPaste|CellCopyPasteConfig
|
|
1569
|
+
/**
|
|
1570
|
+
* Adding this feature to the grid and other Bryntum products which are based on the Grid (i.e. Scheduler, SchedulerPro, and Gantt)
|
|
1571
|
+
* enables cell editing. Any subclass of [Field](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Field) can be used
|
|
1572
|
+
* as editor for the [Column](https://bryntum.com/products/schedulerpro/docs/api/Grid/column/Column). The most popular are:
|
|
1573
|
+
* ...
|
|
1574
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellEdit)
|
|
1575
|
+
*/
|
|
1576
|
+
cellEditFeature ? : object|Boolean|string|GridCellEdit|GridCellEditConfig
|
|
1577
|
+
/**
|
|
1578
|
+
* Right click to display context menu for cells. To invoke the cell menu in a keyboard-accessible manner, use the
|
|
1579
|
+
* `SPACE` key when the cell is focused.
|
|
1580
|
+
* ...
|
|
1581
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellMenu)
|
|
1582
|
+
*/
|
|
1583
|
+
cellMenuFeature ? : object|Boolean|string|CellMenu|CellMenuConfig
|
|
1584
|
+
/**
|
|
1585
|
+
* Displays a tooltip when hovering cells.
|
|
1586
|
+
* ...
|
|
1587
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellTooltip)
|
|
1588
|
+
*/
|
|
1589
|
+
cellTooltipFeature ? : object|Boolean|string|CellTooltip|CellTooltipConfig
|
|
1590
|
+
/**
|
|
1591
|
+
* Adds interactive charting to a Grid. [Charts](https://bryntum.com/products/schedulerpro/docs/api/Chart/widget/Chart) can be created from a selection of Grid data
|
|
1592
|
+
* and updated in realtime as data changes. Supports many common chart types with extensive styling and customization
|
|
1593
|
+
* options.
|
|
1594
|
+
* ...
|
|
1595
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Charts)
|
|
1596
|
+
*/
|
|
1597
|
+
chartsFeature ? : object|Boolean|string|Charts|ChartsConfig
|
|
1598
|
+
/**
|
|
1599
|
+
* Enables the [autoWidth](https://bryntum.com/products/schedulerpro/docs/api/Grid/column/Column#config-autoWidth) config for a grid's columns.
|
|
1600
|
+
* ...
|
|
1601
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnAutoWidth)
|
|
1602
|
+
*/
|
|
1603
|
+
columnAutoWidthFeature ? : object|Boolean|string|ColumnAutoWidth|ColumnAutoWidthConfig
|
|
1604
|
+
/**
|
|
1605
|
+
* Displays a toolbar while dragging column headers. Drop on a button in the toolbar to activate a certain function,
|
|
1606
|
+
* for example to group by that column. This feature simplifies certain operations on touch devices.
|
|
1607
|
+
* ...
|
|
1608
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnDragToolbar)
|
|
1609
|
+
*/
|
|
1610
|
+
columnDragToolbarFeature ? : object|Boolean|string|ColumnDragToolbar|ColumnDragToolbarConfig
|
|
1611
|
+
/**
|
|
1612
|
+
* Displays column lines for ticks, with a different styling for major ticks (by default they are darker). If this
|
|
1613
|
+
* feature is disabled, no lines are shown. If it's enabled, line are shown for the tick level which is set in current
|
|
1614
|
+
* ViewPreset. Please see [columnLinesFor](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/preset/ViewPreset#field-columnLinesFor) config for details.
|
|
1615
|
+
* ...
|
|
1616
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ColumnLines)
|
|
1617
|
+
*/
|
|
1618
|
+
columnLinesFeature ? : object|Boolean|string|ColumnLines|ColumnLinesConfig
|
|
1619
|
+
/**
|
|
1620
|
+
* Displays a column picker (to show/hide columns) in the header context menu. Columns can be displayed in sub menus
|
|
1621
|
+
* by region or tag. Grouped headers are displayed as menu hierarchies.
|
|
1622
|
+
* ...
|
|
1623
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnPicker)
|
|
1624
|
+
*/
|
|
1625
|
+
columnPickerFeature ? : object|Boolean|string|ColumnPicker|ColumnPickerConfig
|
|
1626
|
+
/**
|
|
1627
|
+
* Allows user to rename columns by either right-clicking column header or using keyboard shortcuts when column header
|
|
1628
|
+
* is focused.
|
|
1629
|
+
* ...
|
|
1630
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnRename)
|
|
1631
|
+
*/
|
|
1632
|
+
columnRenameFeature ? : object|Boolean|string|ColumnRename|ColumnRenameConfig
|
|
1633
|
+
/**
|
|
1634
|
+
* Allows user to reorder columns by dragging headers. To get notified about column reorder listen to `change` event
|
|
1635
|
+
* on [columns](https://bryntum.com/products/schedulerpro/docs/api/Grid/data/ColumnStore) store.
|
|
1636
|
+
* ...
|
|
1637
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnReorder)
|
|
1638
|
+
*/
|
|
1639
|
+
columnReorderFeature ? : object|Boolean|string|ColumnReorder|ColumnReorderConfig
|
|
1640
|
+
/**
|
|
1641
|
+
* Enables user to resize columns by dragging a handle on the right hand side of the header. To get notified about column
|
|
1642
|
+
* resize listen to `change` event on [columns](https://bryntum.com/products/schedulerpro/docs/api/Grid/data/ColumnStore) store.
|
|
1643
|
+
* ...
|
|
1644
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnResize)
|
|
1645
|
+
*/
|
|
1646
|
+
columnResizeFeature ? : object|Boolean|string|ColumnResize|ColumnResizeConfig
|
|
1647
|
+
/**
|
|
1648
|
+
* Feature that draws dependencies between events. Uses a [DependencyStore](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/data/DependencyStore) to determine which
|
|
1649
|
+
* dependencies to draw, if none is defined one will be created automatically. Dependencies can also be specified as
|
|
1650
|
+
* `scheduler.dependencies`, see example below:
|
|
1651
|
+
* ...
|
|
1652
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/Dependencies)
|
|
1653
|
+
*/
|
|
1654
|
+
dependenciesFeature ? : object|Boolean|string|SchedulerDependencies|SchedulerDependenciesConfig
|
|
1655
|
+
/**
|
|
1656
|
+
* Feature that displays a popup containing fields for editing a dependency. Requires the
|
|
1657
|
+
* [Dependencies](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/Dependencies) feature to be enabled. Double-click a dependency line in the demo below to
|
|
1658
|
+
* show the editor.
|
|
1659
|
+
* ...
|
|
1660
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/DependencyEdit)
|
|
1661
|
+
*/
|
|
1662
|
+
dependencyEditFeature ? : object|Boolean|string|SchedulerDependencyEdit|SchedulerDependencyEditConfig
|
|
1663
|
+
/**
|
|
1664
|
+
* Displays a context menu when right-clicking dependency lines. Items are populated by other features and/or
|
|
1665
|
+
* application code.
|
|
1666
|
+
* ...
|
|
1667
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/DependencyMenu)
|
|
1668
|
+
*/
|
|
1669
|
+
dependencyMenuFeature ? : object|Boolean|string|DependencyMenu|DependencyMenuConfig
|
|
1670
|
+
/**
|
|
1671
|
+
* Allow using <kbd>Ctrl</kbd>/<kbd>CMD</kbd> + <kbd>C</kbd>/<kbd>X</kbd> and <kbd>Ctrl</kbd>/<kbd>CMD</kbd> +
|
|
1672
|
+
* <kbd>V</kbd> to copy/cut and paste events.
|
|
1673
|
+
* ...
|
|
1674
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventCopyPaste)
|
|
1675
|
+
*/
|
|
1676
|
+
eventCopyPasteFeature ? : object|Boolean|string|EventCopyPaste|EventCopyPasteConfig
|
|
1677
|
+
/**
|
|
1678
|
+
* Allows user to drag and drop events within the scheduler, to change `startDate` or resource assignment.
|
|
1679
|
+
* ...
|
|
1680
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventDrag)
|
|
1681
|
+
*/
|
|
1682
|
+
eventDragFeature ? : object|Boolean|string|EventDrag|EventDragConfig
|
|
1683
|
+
/**
|
|
1684
|
+
* Feature that allows the user to create new events by dragging in empty parts of the scheduler rows.
|
|
1685
|
+
* ...
|
|
1686
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventDragCreate)
|
|
1687
|
+
*/
|
|
1688
|
+
eventDragCreateFeature ? : object|Boolean|string|EventDragCreate|EventDragCreateConfig
|
|
1689
|
+
/**
|
|
1690
|
+
* Enables users to click and drag to select events (or assignments in multi assignment mode) inside the Scheduler's
|
|
1691
|
+
* timeline. Press <kbd>CTRL</kbd>/<kbd>CMD</kbd> to extend an existing selection.
|
|
1692
|
+
* ...
|
|
1693
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventDragSelect)
|
|
1694
|
+
*/
|
|
1695
|
+
eventDragSelectFeature ? : object|Boolean|string|EventDragSelect|EventDragSelectConfig
|
|
1696
|
+
/**
|
|
1697
|
+
* Feature that displays a popup containing widgets for editing event data.
|
|
1698
|
+
* ...
|
|
1699
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventEdit)
|
|
1700
|
+
*/
|
|
1701
|
+
eventEditFeature ? : object|Boolean|string|EventEdit|EventEditConfig
|
|
1702
|
+
/**
|
|
1703
|
+
* Adds event filter menu items to the timeline header context menu.
|
|
1704
|
+
* ...
|
|
1705
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventFilter)
|
|
1706
|
+
*/
|
|
1707
|
+
eventFilterFeature ? : object|Boolean|string|EventFilter|EventFilterConfig
|
|
1708
|
+
/**
|
|
1709
|
+
* Displays a context menu for events. Items are populated by other features and/or application code.
|
|
1710
|
+
* ...
|
|
1711
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventMenu)
|
|
1712
|
+
*/
|
|
1713
|
+
eventMenuFeature ? : object|Boolean|string|EventMenu|EventMenuConfig
|
|
1714
|
+
/**
|
|
1715
|
+
* Feature that allows rendering non-working time ranges into event bars (weekends for Scheduler, effective calendar for
|
|
1716
|
+
* SchedulerPro):
|
|
1717
|
+
* ...
|
|
1718
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventNonWorkingTime)
|
|
1719
|
+
*/
|
|
1720
|
+
eventNonWorkingTimeFeature ? : object|Boolean|string|EventNonWorkingTime|EventNonWorkingTimeConfig
|
|
1721
|
+
/**
|
|
1722
|
+
* Feature that allows resizing an event by dragging its end.
|
|
1723
|
+
* ...
|
|
1724
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventResize)
|
|
1725
|
+
*/
|
|
1726
|
+
eventResizeFeature ? : object|Boolean|string|SchedulerEventResize|SchedulerEventResizeConfig
|
|
1727
|
+
/**
|
|
1728
|
+
* Displays a tooltip when hovering events. The template used to render the tooltip can be customized, see [template](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventTooltip#config-template).
|
|
1729
|
+
* Config options are also applied to the tooltip shown, see [Tooltip](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Tooltip) for available options.
|
|
1730
|
+
* ...
|
|
1731
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventTooltip)
|
|
1732
|
+
*/
|
|
1733
|
+
eventTooltipFeature ? : object|Boolean|string|EventTooltip|EventTooltipConfig
|
|
1734
|
+
/**
|
|
1735
|
+
* A feature that allows exporting Scheduler data to Excel or CSV without involving the server. It uses
|
|
1736
|
+
* [TableExporter](https://bryntum.com/products/schedulerpro/docs/api/Grid/util/TableExporter) class as data provider, 3rd party provider to generate XLS files, and
|
|
1737
|
+
* [Microsoft XML specification](https://msdn.microsoft.com/en-us/library/office/documentformat.openxml.spreadsheet.aspx).
|
|
1738
|
+
* ...
|
|
1739
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/experimental/ExcelExporter)
|
|
1740
|
+
*/
|
|
1741
|
+
excelExporterFeature ? : object|Boolean|string|ExcelExporter|ExcelExporterConfig
|
|
1742
|
+
/**
|
|
1743
|
+
* An experimental feature that lets users drop files on a Widget. The widget fires an event when a file is dropped onto it.
|
|
1744
|
+
* In the event, you get access to the raw files as strings, that were parsed by calling `readAsBinaryString`.
|
|
1745
|
+
* ...
|
|
1746
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/experimental/FileDrop)
|
|
1747
|
+
*/
|
|
1748
|
+
fileDropFeature ? : object|Boolean|string|FileDrop|FileDropConfig
|
|
1749
|
+
/**
|
|
1750
|
+
* This feature adds a fill handle to a Grid range selection, which when dragged, fills the cells being dragged over
|
|
1751
|
+
* with values based on the values in the original selected range. This is similar to functionality normally seen in
|
|
1752
|
+
* various spreadsheet applications.
|
|
1753
|
+
* ...
|
|
1754
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/FillHandle)
|
|
1755
|
+
*/
|
|
1756
|
+
fillHandleFeature ? : object|Boolean|string|FillHandle|FillHandleConfig
|
|
1757
|
+
/**
|
|
1758
|
+
* Feature that allows filtering of the grid by settings filters on columns. The actual filtering is done by the store.
|
|
1759
|
+
* For info on programmatically handling filters, see [StoreFilter](https://bryntum.com/products/schedulerpro/docs/api/Core/data/mixin/StoreFilter).
|
|
1760
|
+
* ...
|
|
1761
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Filter)
|
|
1762
|
+
*/
|
|
1763
|
+
filterFeature ? : object|Boolean|string|Filter|FilterConfig
|
|
1764
|
+
/**
|
|
1765
|
+
* Feature that allows filtering of the grid by entering filters on column headers.
|
|
1766
|
+
* The actual filtering is done by the store.
|
|
1767
|
+
* For info on programmatically handling filters, see [StoreFilter](https://bryntum.com/products/schedulerpro/docs/api/Core/data/mixin/StoreFilter).
|
|
1768
|
+
* ...
|
|
1769
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/FilterBar)
|
|
1770
|
+
*/
|
|
1771
|
+
filterBarFeature ? : object|Boolean|string|FilterBar|FilterBarConfig
|
|
1772
|
+
/**
|
|
1773
|
+
* Enables rendering and handling of row groups. The actual grouping is done in the store, but triggered by
|
|
1774
|
+
* <kbd>shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
|
|
1775
|
+
* one anywhere on grid). Use <kbd>shift</kbd> + <kbd>alt</kbd> + click, or the context menu, to remove a column
|
|
1776
|
+
* grouper.
|
|
1777
|
+
* ...
|
|
1778
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Group)
|
|
1779
|
+
*/
|
|
1780
|
+
groupFeature ? : object|Boolean|string|Group|GroupConfig
|
|
1781
|
+
/**
|
|
1782
|
+
* A special version of the Grid GroupSummary feature that enables summaries within scheduler. To use a single summary
|
|
1783
|
+
* it is easiest to configure [renderer](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/GroupSummary#config-renderer), for multiple summaries see [summaries](#Scheduler/feature/GroupSummary#config-summaries).
|
|
1784
|
+
* ...
|
|
1785
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/GroupSummary)
|
|
1786
|
+
*/
|
|
1787
|
+
groupSummaryFeature ? : object|Boolean|string|GroupSummary|GroupSummaryConfig
|
|
1788
|
+
/**
|
|
1789
|
+
* Right click column header or focus it and press SPACE key to show the context menu for headers.
|
|
1790
|
+
* ...
|
|
1791
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/HeaderMenu)
|
|
1792
|
+
*/
|
|
1793
|
+
headerMenuFeature ? : object|Boolean|string|HeaderMenu|HeaderMenuConfig
|
|
1794
|
+
/**
|
|
1795
|
+
* Enables users to click and drag to zoom to a date range in Scheduler's header time axis. Only supported in horizontal
|
|
1796
|
+
* mode.
|
|
1797
|
+
* ...
|
|
1798
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/HeaderZoom)
|
|
1799
|
+
*/
|
|
1800
|
+
headerZoomFeature ? : object|Boolean|string|HeaderZoom|HeaderZoomConfig
|
|
1801
|
+
/**
|
|
1802
|
+
* Displays labels at positions [top](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/Labels#config-top), [right](#Scheduler/feature/Labels#config-right), [bottom](#Scheduler/feature/Labels#config-bottom) and
|
|
1803
|
+
* [left](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/Labels#config-left).
|
|
1804
|
+
* ...
|
|
1805
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/Labels)
|
|
1806
|
+
*/
|
|
1807
|
+
labelsFeature ? : object|Boolean|string|Labels|LabelsConfig
|
|
1808
|
+
/**
|
|
1809
|
+
* This feature allows resources which satisfy a certain condition to be locked at the top of the scheduler.
|
|
1810
|
+
* ...
|
|
1811
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/LockRows)
|
|
1812
|
+
*/
|
|
1813
|
+
lockRowsFeature ? : object|Boolean|string|LockRows|LockRowsConfig
|
|
1814
|
+
/**
|
|
1815
|
+
* This feature merges cells that have the same value in sorted (or [optionally](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/MergeCells#config-sortedOnly) any) columns
|
|
1816
|
+
* configured to [mergeCells](https://bryntum.com/products/schedulerpro/docs/api/Grid/column/Column#config-mergeCells).
|
|
1817
|
+
* ...
|
|
1818
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/MergeCells)
|
|
1819
|
+
*/
|
|
1820
|
+
mergeCellsFeature ? : object|Boolean|string|MergeCells|MergeCellsConfig
|
|
1821
|
+
/**
|
|
1822
|
+
* Feature that allows styling of weekends (and other non-working time) by adding timeRanges for those days.
|
|
1823
|
+
* ...
|
|
1824
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/NonWorkingTime)
|
|
1825
|
+
*/
|
|
1826
|
+
nonWorkingTimeFeature ? : object|Boolean|string|NonWorkingTime|NonWorkingTimeConfig
|
|
1827
|
+
/**
|
|
1828
|
+
* Makes the scheduler's timeline pannable by dragging with the mouse. Try it out in the demo below.
|
|
1829
|
+
* ...
|
|
1830
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/Pan)
|
|
1831
|
+
*/
|
|
1832
|
+
panFeature ? : object|Boolean|string|Pan|PanConfig
|
|
1833
|
+
/**
|
|
1834
|
+
* Generates PDF/PNG files from the Scheduler component.
|
|
1835
|
+
* ...
|
|
1836
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/export/PdfExport)
|
|
1837
|
+
*/
|
|
1838
|
+
pdfExportFeature ? : object|Boolean|string|PdfExport|PdfExportConfig
|
|
1839
|
+
/**
|
|
1840
|
+
* Allows pinning columns to the start or end region of the grid without any additional subGrid configurations.
|
|
1841
|
+
* When pinning to a region that does not yet exist, the feature creates the required subGrid on the fly.
|
|
1842
|
+
* ...
|
|
1843
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/PinColumns)
|
|
1844
|
+
*/
|
|
1845
|
+
pinColumnsFeature ? : object|Boolean|string|PinColumns|PinColumnsConfig
|
|
1846
|
+
/**
|
|
1847
|
+
* Allows printing Scheduler contents using browser print dialog.
|
|
1848
|
+
* ...
|
|
1849
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/export/Print)
|
|
1850
|
+
*/
|
|
1851
|
+
printFeature ? : object|Boolean|string|Print|PrintConfig
|
|
1852
|
+
/**
|
|
1853
|
+
* Feature that allows the user to search in a column by focusing a cell and typing. Navigate between hits using the
|
|
1854
|
+
* keyboard, [f3] or [ctrl]/[cmd] + [g] moves to next, also pressing [shift] moves to previous.
|
|
1855
|
+
* ...
|
|
1856
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/QuickFind)
|
|
1857
|
+
*/
|
|
1858
|
+
quickFindFeature ? : object|Boolean|string|QuickFind|QuickFindConfig
|
|
1859
|
+
/**
|
|
1860
|
+
* Makes the splitter between grid [sections](https://bryntum.com/products/schedulerpro/docs/api/Grid/view/SubGrid) draggable, to let users resize, and
|
|
1861
|
+
* collapse/expand the sections.
|
|
1862
|
+
* ...
|
|
1863
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RegionResize)
|
|
1864
|
+
*/
|
|
1865
|
+
regionResizeFeature ? : object|Boolean|string|RegionResize|RegionResizeConfig
|
|
1866
|
+
/**
|
|
1867
|
+
* Applicable only for Scheduler in `vertical` mode. Right click resource header cells to display a context menu.
|
|
1868
|
+
* ...
|
|
1869
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ResourceMenu)
|
|
1870
|
+
*/
|
|
1871
|
+
resourceMenuFeature ? : object|Boolean|string|ResourceMenu|ResourceMenuConfig
|
|
1872
|
+
/**
|
|
1873
|
+
* Feature that draws resource time ranges, shaded areas displayed behind events. These zones are similar to events in
|
|
1874
|
+
* that they have a start and end date but different in that they do not take part in the event layout, and they always
|
|
1875
|
+
* occupy full row height.
|
|
1876
|
+
* ...
|
|
1877
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ResourceTimeRanges)
|
|
1878
|
+
*/
|
|
1879
|
+
resourceTimeRangesFeature ? : object|Boolean|string|ResourceTimeRanges|ResourceTimeRangesConfig
|
|
1880
|
+
/**
|
|
1881
|
+
* Allow using [Ctrl/CMD + C/X] and [Ctrl/CMD + V] to copy/cut-and-paste rows. Also makes cut, copy and paste actions
|
|
1882
|
+
* available via the cell context menu.
|
|
1883
|
+
* ...
|
|
1884
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RowCopyPaste)
|
|
1885
|
+
*/
|
|
1886
|
+
rowCopyPasteFeature ? : object|Boolean|string|RowCopyPaste|RowCopyPasteConfig
|
|
1887
|
+
/**
|
|
1888
|
+
* This feature allows editing of entire rows in a grid in a docked panel which by default slides out from the right.
|
|
1889
|
+
* ...
|
|
1890
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RowEdit)
|
|
1891
|
+
*/
|
|
1892
|
+
rowEditFeature ? : object|Boolean|string|RowEdit|RowEditConfig
|
|
1893
|
+
/**
|
|
1894
|
+
* Enables expanding of Grid rows by either row click or double click, or by adding a separate Grid column which renders
|
|
1895
|
+
* a button that expands or collapses the row.
|
|
1896
|
+
* ...
|
|
1897
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RowExpander)
|
|
1898
|
+
*/
|
|
1899
|
+
rowExpanderFeature ? : object|Boolean|string|RowExpander|RowExpanderConfig
|
|
1900
|
+
/**
|
|
1901
|
+
* This feature implements support for project transactions and used by default in Gantt. For general RowReorder feature
|
|
1902
|
+
* documentation see [RowReorder](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RowReorder).
|
|
1903
|
+
* ...
|
|
1904
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/RowReorder)
|
|
1905
|
+
*/
|
|
1906
|
+
rowReorderFeature ? : object|Boolean|string|RowReorder|RowReorderConfig
|
|
1907
|
+
/**
|
|
1908
|
+
* Enables user to change row height by dragging the bottom row border. After a resize operation, the [rowHeight](https://bryntum.com/products/schedulerpro/docs/api/Grid/data/GridRowModel#field-rowHeight)
|
|
1909
|
+
* field of the record is updated (when [applyToAllRows](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/RowResize#config-applyToAllRows) is `false`) and the [eventLayout](#Scheduler/model/ResourceModel#field-eventLayout) of the dragged resource
|
|
1910
|
+
* row will be switched to `pack` as a result (only applies when `stack` is used by default).
|
|
1911
|
+
* `barMargin` and `resourceMargin` will also be shrunk as you reduce the height of a row.
|
|
1912
|
+
* ...
|
|
1913
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/RowResize)
|
|
1914
|
+
*/
|
|
1915
|
+
rowResizeFeature ? : object|Boolean|string|RowResize|RowResizeConfig
|
|
1916
|
+
/**
|
|
1917
|
+
* Allow visually selecting a schedule "cell" by clicking, or [any other pointer gesture](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ScheduleContext#config-triggerEvent).
|
|
1918
|
+
* ...
|
|
1919
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ScheduleContext)
|
|
1920
|
+
*/
|
|
1921
|
+
scheduleContextFeature ? : object|Boolean|string|ScheduleContext|ScheduleContextConfig
|
|
1922
|
+
/**
|
|
1923
|
+
* Displays a context menu for empty parts of the schedule. Items are populated in the first place
|
|
1924
|
+
* by configurations of this Feature, then by other features and/or application code.
|
|
1925
|
+
* ...
|
|
1926
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ScheduleMenu)
|
|
1927
|
+
*/
|
|
1928
|
+
scheduleMenuFeature ? : object|Boolean|string|ScheduleMenu|ScheduleMenuConfig
|
|
1929
|
+
/**
|
|
1930
|
+
* Feature that displays a tooltip containing the time at the mouse position when hovering empty parts of the schedule.
|
|
1931
|
+
* ...
|
|
1932
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ScheduleTooltip)
|
|
1933
|
+
*/
|
|
1934
|
+
scheduleTooltipFeature ? : object|Boolean|string|ScheduleTooltip|ScheduleTooltipConfig
|
|
1935
|
+
/**
|
|
1936
|
+
* This feature injects buttons to the beginning and end of each row that will scroll to the next or previous event
|
|
1937
|
+
* outside the current view. It can optionally show a label along with the button, using the
|
|
1938
|
+
* [labelRenderer](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ScrollButtons#config-labelRenderer). Only supported in horizontal [mode](#Scheduler/view/SchedulerBase#config-mode)
|
|
1939
|
+
* ...
|
|
1940
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ScrollButtons)
|
|
1941
|
+
*/
|
|
1942
|
+
scrollButtonsFeature ? : object|Boolean|string|ScrollButtons|ScrollButtonsConfig
|
|
1943
|
+
/**
|
|
1944
|
+
* <div class="external-example vertical" data-file="Grid/feature/Search.js"></div>
|
|
1945
|
+
* ...
|
|
1946
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Search)
|
|
1947
|
+
*/
|
|
1948
|
+
searchFeature ? : object|Boolean|string|Search|SearchConfig
|
|
1949
|
+
/**
|
|
1950
|
+
* Feature that displays a text field to edit the event name.
|
|
1951
|
+
* ...
|
|
1952
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/SimpleEventEdit)
|
|
1953
|
+
*/
|
|
1954
|
+
simpleEventEditFeature ? : object|Boolean|string|SimpleEventEdit|SimpleEventEditConfig
|
|
1955
|
+
/**
|
|
1956
|
+
* Allows sorting of grid by clicking (or tapping) headers, also displays which columns grid is sorted by (numbered if
|
|
1957
|
+
* using multisort). Use modifier keys for multisorting: [Ctrl/CMD + click] to add sorter, [Ctrl/CMD + Alt + click] to remove sorter.
|
|
1958
|
+
* The actual sorting is done by the store, see [Store.sort()](https://bryntum.com/products/schedulerpro/docs/api/Core/data/mixin/StoreSort#function-sort).
|
|
1959
|
+
* ...
|
|
1960
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Sort)
|
|
1961
|
+
*/
|
|
1962
|
+
sortFeature ? : object|Boolean|string|Sort|SortConfig
|
|
1963
|
+
/**
|
|
1964
|
+
* This feature allows splitting the Scheduler into multiple views, either by using the cell context menu, or
|
|
1965
|
+
* programmatically by calling [split()](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/Split#function-split).
|
|
1966
|
+
* ...
|
|
1967
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/Split)
|
|
1968
|
+
*/
|
|
1969
|
+
splitFeature ? : object|Boolean|string|Split|SplitConfig
|
|
1970
|
+
/**
|
|
1971
|
+
* A feature which pins configurable content from a grid row to the top of the grid
|
|
1972
|
+
* while the row scrolls off the top but is still visible.
|
|
1973
|
+
* ...
|
|
1974
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/StickyCells)
|
|
1975
|
+
*/
|
|
1976
|
+
stickyCellsFeature ? : object|Boolean|string|StickyCells|StickyCellsConfig
|
|
1977
|
+
/**
|
|
1978
|
+
* This feature applies native `position: sticky` to event contents in horizontal mode, keeping the contents in view as
|
|
1979
|
+
* long as possible on scroll. For vertical mode it uses a programmatic solution to achieve the same result.
|
|
1980
|
+
* ...
|
|
1981
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/StickyEvents)
|
|
1982
|
+
*/
|
|
1983
|
+
stickyEventsFeature ? : object|Boolean|string|StickyEvents|StickyEventsConfig
|
|
1984
|
+
/**
|
|
1985
|
+
* Stripes rows by adding alternating CSS classes to all row elements (`b-even` and `b-odd`).
|
|
1986
|
+
* ...
|
|
1987
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Stripe)
|
|
1988
|
+
*/
|
|
1989
|
+
stripeFeature ? : object|Boolean|string|Stripe|StripeConfig
|
|
1990
|
+
/**
|
|
1991
|
+
* A special version of the Grid Summary feature. This feature displays a summary row in the grid footer.
|
|
1992
|
+
* ...
|
|
1993
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/Summary)
|
|
1994
|
+
*/
|
|
1995
|
+
summaryFeature ? : object|Boolean|string|Summary|SummaryConfig
|
|
1996
|
+
/**
|
|
1997
|
+
* Adds scheduler specific menu items to the timeline header context menu.
|
|
1998
|
+
* ...
|
|
1999
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/TimeAxisHeaderMenu)
|
|
2000
|
+
*/
|
|
2001
|
+
timeAxisHeaderMenuFeature ? : object|Boolean|string|TimeAxisHeaderMenu|TimeAxisHeaderMenuConfig
|
|
2002
|
+
/**
|
|
2003
|
+
* Feature that renders global ranges of time in the timeline. Use this feature to visualize a `range` like a 1 hr lunch
|
|
2004
|
+
* or some important point in time (a `line`, i.e. a range with 0 duration). This feature can also show a current time
|
|
2005
|
+
* indicator if you set [showCurrentTimeLine](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/TimeRanges#config-showCurrentTimeLine) to true. To style the rendered elements, use the
|
|
2006
|
+
* [cls](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/model/TimeSpan#field-cls) field of the `TimeSpan` class.
|
|
2007
|
+
* ...
|
|
2008
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/TimeRanges)
|
|
2009
|
+
*/
|
|
2010
|
+
timeRangesFeature ? : object|Boolean|string|TimeRanges|TimeRangesConfig
|
|
2011
|
+
/**
|
|
2012
|
+
* Feature that allows selection of a time span in the time axis header. When a time span is selected in the header,
|
|
2013
|
+
* a [timeSelectionChange](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/TimeSelection#event-timeSelectionChange) event is fired.
|
|
2014
|
+
* ...
|
|
2015
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/TimeSelection)
|
|
2016
|
+
*/
|
|
2017
|
+
timeSelectionFeature ? : object|Boolean|string|TimeSelection|TimeSelectionConfig
|
|
2018
|
+
/**
|
|
2019
|
+
* Feature that makes the grid work more like a tree. Included by default in [TreeGrid](https://bryntum.com/products/schedulerpro/docs/api/Grid/view/TreeGrid). Requires
|
|
2020
|
+
* exactly one [TreeColumn](https://bryntum.com/products/schedulerpro/docs/api/Grid/column/TreeColumn) among grids columns. That column will have its renderer replaced with a
|
|
2021
|
+
* tree renderer that adds padding and icon to give the appearance of a tree. The original renderer is preserved and
|
|
2022
|
+
* also called.
|
|
2023
|
+
* ...
|
|
2024
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Tree)
|
|
2025
|
+
*/
|
|
2026
|
+
treeFeature ? : object|Boolean|string|Tree|TreeConfig
|
|
2027
|
+
/**
|
|
2028
|
+
* A feature that allows transforming a flat dataset (or the leaves of a hierarchical) into a tree by specifying a
|
|
2029
|
+
* record field per parent level. Parents are generated based on each leaf's value for those fields.
|
|
2030
|
+
* ...
|
|
2031
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/TreeGroup)
|
|
2032
|
+
*/
|
|
2033
|
+
treeGroupFeature ? : object|Boolean|string|TreeGroup|TreeGroupConfig
|
|
2034
|
+
/**
|
|
2035
|
+
* A feature allowing you to roll up and display values in the time axis cell for each parent row in a tree scheduler.
|
|
2036
|
+
* ...
|
|
2037
|
+
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/TreeSummary)
|
|
2038
|
+
*/
|
|
2039
|
+
treeSummaryFeature ? : object|Boolean|string|TreeSummary|TreeSummaryConfig
|
|
2040
|
+
|
|
2041
|
+
}
|