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