@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
|
@@ -10,9 +10,9 @@
|
|
|
10
10
|
|
|
11
11
|
import { getCurrentInstance, onBeforeUnmount, onMounted, provide, ref, watch, toRaw } from 'vue';
|
|
12
12
|
|
|
13
|
-
import type { AjaxStore, AjaxStoreConfig, Base, Color, Container, DomClassList, DomConfig, DurationConfig, DurationUnit, FormulaProviderConfig, KeyMapConfig, Mask, MaskConfig, Menu, MenuConfig, MenuItem, MenuItemEntry, Model, ModelConfig, PagingToolbarConfig, Panel, PanelCollapserConfig, PanelCollapserOverlayConfig, PanelHeader, Popup, Rectangle, ScrollManager, ScrollManagerConfig, Scroller, ScrollerConfig, StateProvider, Store, StoreConfig, TabConfig, Tool, ToolConfig, ToolbarConfig, ToolbarItems, TooltipConfig, Widget } from '@bryntum/core-thin';
|
|
13
|
+
import type { AjaxStore, AjaxStoreConfig, Base, Color, Container, DomClassList, DomConfig, DurationConfig, DurationUnit, FormulaProviderConfig, InstancePlugin, KeyMapConfig, Mask, MaskConfig, Menu, MenuConfig, MenuItem, MenuItemEntry, Model, ModelConfig, PagingToolbarConfig, Panel, PanelCollapserConfig, PanelCollapserOverlayConfig, PanelHeader, Popup, Rectangle, ScrollManager, ScrollManagerConfig, Scroller, ScrollerConfig, StateProvider, Store, StoreConfig, TabConfig, Tool, ToolConfig, ToolbarConfig, ToolbarItems, TooltipConfig, Widget } from '@bryntum/core-thin';
|
|
14
14
|
import type { AIFilter, AIFilterConfig, CellCopyPaste, CellCopyPasteConfig, CellEdit as GridCellEdit, CellEditConfig as GridCellEditConfig, CellEditorContext, CellMenu, CellMenuConfig, CellTooltip, CellTooltipConfig, Charts, ChartsConfig, Column, ColumnAutoWidth, ColumnAutoWidthConfig, ColumnDragToolbar, ColumnDragToolbarConfig, ColumnPicker, ColumnPickerConfig, ColumnRename, ColumnRenameConfig, ColumnReorder, ColumnReorderConfig, ColumnResize, ColumnResizeConfig, ColumnStore, ColumnStoreConfig, EmptyTextDomConfig, ExportConfig, FileDrop, FileDropConfig, FillHandle, FillHandleConfig, Filter, FilterBar, FilterBarConfig, FilterConfig, Grid, GridBase, GridLocation, GridLocationConfig, GridSelectionMode, Group, GroupConfig, HeaderMenu, HeaderMenuConfig, MergeCells, MergeCellsConfig, PinColumns, PinColumnsConfig, PreserveScrollOptions, QuickFind, QuickFindConfig, RecordPositionContext, RegionResize, RegionResizeConfig, Row, RowCopyPaste, RowCopyPasteConfig, RowEdit, RowEditConfig, RowEditorContext, RowExpander, RowExpanderConfig, Search, SearchConfig, Sort, SortConfig, StickyCells, StickyCellsConfig, Stripe, StripeConfig, SubGrid, SubGridConfig, Tree, TreeConfig, TreeGroup, TreeGroupConfig, XLSColumn } from '@bryntum/grid-thin';
|
|
15
|
-
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, DropData, 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, EventResizeData, 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,
|
|
15
|
+
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, DropData, 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, EventResizeData, 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, SchedulerBase, SchedulerResponsiveLevelConfig, SchedulerStateInfo, ScrollButtons, ScrollButtonsConfig, SimpleEventEdit, SimpleEventEditConfig, Split, SplitConfig, StickyEvents, StickyEventsConfig, Summary, SummaryConfig, TimeAxis, TimeAxisColumn, TimeAxisConfig, TimeAxisHeaderMenu, TimeAxisHeaderMenuConfig, TimeRanges, TimeRangesConfig, TimeSelection, TimeSelectionConfig, TimeSpan, TimeSpanConfig, TimelineBase, TimelineContext, TreeSummary, TreeSummaryConfig, VerticalTimeAxisColumn, VerticalTimeAxisColumnConfig, ViewPreset, ViewPresetConfig, VisibleDate } from '@bryntum/scheduler-thin';
|
|
16
16
|
import type { SchedulerProContainerItemConfig, DependencyStoreConfig, SchedulerProColumnConfig, ProjectModel, ProjectModelConfig, TimelineListeners } from '@bryntum/schedulerpro-thin';
|
|
17
17
|
import { Timeline } from '@bryntum/schedulerpro-thin';
|
|
18
18
|
|
|
@@ -23,8 +23,7 @@ defineProps<{
|
|
|
23
23
|
/**
|
|
24
24
|
* Element (or element id) to adopt as this Widget's encapsulating element. The widget's
|
|
25
25
|
* content will be placed inside this element.
|
|
26
|
-
* ...
|
|
27
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-adopt)
|
|
26
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-adopt)
|
|
28
27
|
*/
|
|
29
28
|
adopt ? : HTMLElement|string
|
|
30
29
|
/**
|
|
@@ -51,8 +50,7 @@ defineProps<{
|
|
|
51
50
|
allowDropOnEventBar ? : Boolean
|
|
52
51
|
/**
|
|
53
52
|
* Set to `false` if you don't want to allow events overlapping times for any one resource (defaults to `true`).
|
|
54
|
-
* ...
|
|
55
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-allowOverlap)
|
|
53
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-allowOverlap)
|
|
56
54
|
*/
|
|
57
55
|
allowOverlap ? : Boolean
|
|
58
56
|
/**
|
|
@@ -81,15 +79,13 @@ defineProps<{
|
|
|
81
79
|
/**
|
|
82
80
|
* A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject
|
|
83
81
|
* into an element which will be linked using the `aria-describedby` attribute.
|
|
84
|
-
* ...
|
|
85
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-ariaDescription)
|
|
82
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-ariaDescription)
|
|
86
83
|
*/
|
|
87
84
|
ariaDescription ? : string
|
|
88
85
|
/**
|
|
89
86
|
* A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject as
|
|
90
87
|
* the `aria-label` attribute.
|
|
91
|
-
* ...
|
|
92
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-ariaLabel)
|
|
88
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-ariaLabel)
|
|
93
89
|
*/
|
|
94
90
|
ariaLabel ? : string
|
|
95
91
|
/**
|
|
@@ -109,16 +105,15 @@ defineProps<{
|
|
|
109
105
|
/**
|
|
110
106
|
* If this config is set, then its `gesture` property (which defaults to `dblclick`) creates a
|
|
111
107
|
* new event at the mouse or touch event's time point.
|
|
112
|
-
* ...
|
|
113
|
-
* [
|
|
114
|
-
* @param {
|
|
115
|
-
* @param {
|
|
116
|
-
* @param {
|
|
117
|
-
* @param {DurationConfig,string} autoCreate.
|
|
118
|
-
* @param {
|
|
119
|
-
* @param {string} autoCreate.name The name of the event to create. Defaults to the `Object.newEvent` property from the locale.
|
|
108
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-autoCreate)
|
|
109
|
+
* @param {'click','dblclick'} [autoCreate.gesture] The gesture to trigger auto creation of an event. Defaults to `dblclick`.
|
|
110
|
+
* @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.
|
|
111
|
+
* @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.
|
|
112
|
+
* @param {DurationConfig,string} [autoCreate.step] The increment to snap the event start date to.
|
|
113
|
+
* @param {DurationConfig,string} [autoCreate.duration] The duration of the event to create. Defaults to 1 time axis tick.
|
|
114
|
+
* @param {string} [autoCreate.name] The name of the event to create. Defaults to the `Object.newEvent` property from the locale.
|
|
120
115
|
*/
|
|
121
|
-
autoCreate ? : Boolean|string|
|
|
116
|
+
autoCreate ? : Boolean|string|object
|
|
122
117
|
/**
|
|
123
118
|
* Automatically set grids height to fit all rows (no scrolling in the grid). In general you should avoid
|
|
124
119
|
* using `autoHeight: true`, since it will bypass Grids virtual rendering and render all rows at once, which
|
|
@@ -127,21 +122,18 @@ defineProps<{
|
|
|
127
122
|
autoHeight ? : Boolean
|
|
128
123
|
/**
|
|
129
124
|
* Controls how much space to leave between stacked event bars in px.
|
|
130
|
-
* ...
|
|
131
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-barMargin)
|
|
125
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-barMargin)
|
|
132
126
|
*/
|
|
133
127
|
barMargin ? : number
|
|
134
128
|
/**
|
|
135
129
|
* A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Toolbar),
|
|
136
130
|
* 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).
|
|
137
|
-
* ...
|
|
138
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-bbar)
|
|
131
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-bbar)
|
|
139
132
|
*/
|
|
140
133
|
bbar ? : (SchedulerProContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
|
|
141
134
|
/**
|
|
142
135
|
* Custom CSS classes to add to the panel's body element.
|
|
143
|
-
* ...
|
|
144
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-bodyCls)
|
|
136
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-bodyCls)
|
|
145
137
|
*/
|
|
146
138
|
bodyCls ? : string|object
|
|
147
139
|
/**
|
|
@@ -151,35 +143,30 @@ defineProps<{
|
|
|
151
143
|
/**
|
|
152
144
|
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
153
145
|
* hierarchy when triggered.
|
|
154
|
-
* ...
|
|
155
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-bubbleEvents)
|
|
146
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-bubbleEvents)
|
|
156
147
|
*/
|
|
157
148
|
bubbleEvents ? : object
|
|
158
149
|
/**
|
|
159
150
|
* 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`.
|
|
160
|
-
* ...
|
|
161
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-bufferCoef)
|
|
151
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-bufferCoef)
|
|
162
152
|
*/
|
|
163
153
|
bufferCoef ? : number
|
|
164
154
|
/**
|
|
165
155
|
* This config defines the scroll limit, which, when exceeded will cause a timespan shift.
|
|
166
156
|
* 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
|
|
167
157
|
* has less than that of the rendered content - a shift is triggered.
|
|
168
|
-
* ...
|
|
169
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-bufferThreshold)
|
|
158
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-bufferThreshold)
|
|
170
159
|
*/
|
|
171
160
|
bufferThreshold ? : number
|
|
172
161
|
/**
|
|
173
162
|
* Set to `false` to not call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
|
|
174
|
-
* ...
|
|
175
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-callOnFunctions)
|
|
163
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-callOnFunctions)
|
|
176
164
|
*/
|
|
177
165
|
callOnFunctions ? : Boolean
|
|
178
166
|
/**
|
|
179
167
|
* By default, if an event handler throws an exception, the error propagates up the stack and the
|
|
180
168
|
* application state is undefined. Code which follows the event handler will *not* be executed.
|
|
181
|
-
* ...
|
|
182
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-catchEventHandlerExceptions)
|
|
169
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-catchEventHandlerExceptions)
|
|
183
170
|
*/
|
|
184
171
|
catchEventHandlerExceptions ? : Boolean
|
|
185
172
|
/**
|
|
@@ -192,8 +179,7 @@ defineProps<{
|
|
|
192
179
|
* Custom CSS classes to add to element.
|
|
193
180
|
* May be specified as a space separated string, or as an object in which property names
|
|
194
181
|
* with truthy values are used as the class names:
|
|
195
|
-
* ...
|
|
196
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-cls)
|
|
182
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-cls)
|
|
197
183
|
*/
|
|
198
184
|
cls ? : string|object
|
|
199
185
|
/**
|
|
@@ -203,15 +189,13 @@ defineProps<{
|
|
|
203
189
|
collapsed ? : Boolean
|
|
204
190
|
/**
|
|
205
191
|
* This config enables collapsibility for the panel. See [collapsed](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Panel#config-collapsed).
|
|
206
|
-
* ...
|
|
207
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-collapsible)
|
|
192
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-collapsible)
|
|
208
193
|
*/
|
|
209
194
|
collapsible ? : Boolean|PanelCollapserConfig|PanelCollapserOverlayConfig
|
|
210
195
|
/**
|
|
211
196
|
* Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
|
|
212
197
|
* `style` block.
|
|
213
|
-
* ...
|
|
214
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-color)
|
|
198
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-color)
|
|
215
199
|
*/
|
|
216
200
|
color ? : Color
|
|
217
201
|
/**
|
|
@@ -225,8 +209,7 @@ defineProps<{
|
|
|
225
209
|
/**
|
|
226
210
|
* Accepts column definitions for the grid during initialization. They will be used to create
|
|
227
211
|
* [Column](https://bryntum.com/products/schedulerpro/docs/api/Grid/column/Column) instances that are added to a [ColumnStore](#Grid/data/ColumnStore).
|
|
228
|
-
* ...
|
|
229
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-columns)
|
|
212
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-columns)
|
|
230
213
|
*/
|
|
231
214
|
columns ? : ColumnStore|SchedulerProColumnConfig[]|ColumnStoreConfig
|
|
232
215
|
config ? : object
|
|
@@ -234,8 +217,7 @@ defineProps<{
|
|
|
234
217
|
* Custom CSS classes to add to the [contentElement](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#property-contentElement).
|
|
235
218
|
* May be specified as a space separated string, or as an object in which property names
|
|
236
219
|
* with truthy values are used as the class names:
|
|
237
|
-
* ...
|
|
238
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-contentElementCls)
|
|
220
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-contentElementCls)
|
|
239
221
|
*/
|
|
240
222
|
contentElementCls ? : string|object
|
|
241
223
|
/**
|
|
@@ -273,8 +255,7 @@ defineProps<{
|
|
|
273
255
|
* Convenient shortcut to set data in grids store both during initialization and at runtime. Can also be
|
|
274
256
|
* used to retrieve data at runtime, although we do recommend interacting with Grids store instead using
|
|
275
257
|
* the [store](https://bryntum.com/products/schedulerpro/docs/api/Grid/view/GridBase#property-store) property.
|
|
276
|
-
* ...
|
|
277
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-data)
|
|
258
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-data)
|
|
278
259
|
*/
|
|
279
260
|
data ? : object[]|Model[]|ModelConfig[]
|
|
280
261
|
/**
|
|
@@ -288,8 +269,7 @@ defineProps<{
|
|
|
288
269
|
dataset ? : Record<string, string>
|
|
289
270
|
/**
|
|
290
271
|
* The date to display when used as a component of a Calendar.
|
|
291
|
-
* ...
|
|
292
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-date)
|
|
272
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-date)
|
|
293
273
|
*/
|
|
294
274
|
date ? : Date
|
|
295
275
|
/**
|
|
@@ -323,17 +303,15 @@ defineProps<{
|
|
|
323
303
|
* 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.
|
|
324
304
|
* 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
|
|
325
305
|
* be used.
|
|
326
|
-
* ...
|
|
327
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-descriptionFormat)
|
|
306
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-descriptionFormat)
|
|
328
307
|
* @param {Date} date The date to format.
|
|
329
308
|
* @returns {string} The formatted date.
|
|
330
309
|
*/
|
|
331
|
-
descriptionFormat ? : string|string[]|Boolean[]|((date: Date) => string)|
|
|
310
|
+
descriptionFormat ? : string|string[]|Boolean[]|((date: Date) => string)|(((date: Date) => string)[])
|
|
332
311
|
/**
|
|
333
312
|
* A function that provides the textual description for this view. If provided, this function overrides the
|
|
334
313
|
* [descriptionFormat](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/mixin/Describable#config-descriptionFormat).
|
|
335
|
-
* ...
|
|
336
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-descriptionRenderer)
|
|
314
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-descriptionRenderer)
|
|
337
315
|
* @param {Core.widget.Widget} view The active view in case the function is in another scope.
|
|
338
316
|
* @returns {string} Description string
|
|
339
317
|
*/
|
|
@@ -355,16 +333,15 @@ defineProps<{
|
|
|
355
333
|
*/
|
|
356
334
|
destroyStores ? : Boolean
|
|
357
335
|
/**
|
|
358
|
-
* Check for CSS compatibility issues
|
|
359
|
-
*
|
|
360
|
-
* [
|
|
336
|
+
* Check for CSS compatibility and inclusion related issues and try to auto fix them. Performs the following
|
|
337
|
+
* checks:
|
|
338
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-detectCSSCompatibilityIssues)
|
|
361
339
|
*/
|
|
362
340
|
detectCSSCompatibilityIssues ? : Boolean
|
|
363
341
|
/**
|
|
364
342
|
* 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
|
|
365
343
|
* cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
|
|
366
|
-
* ...
|
|
367
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-disabled)
|
|
344
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-disabled)
|
|
368
345
|
*/
|
|
369
346
|
disabled ? : Boolean|'inert'
|
|
370
347
|
/**
|
|
@@ -382,8 +359,7 @@ defineProps<{
|
|
|
382
359
|
/**
|
|
383
360
|
* Defines how dates will be formatted in tooltips etc. This config has priority over similar config on the
|
|
384
361
|
* view preset. For allowed values see [format](https://bryntum.com/products/schedulerpro/docs/api/Core/helper/DateHelper#function-format-static).
|
|
385
|
-
* ...
|
|
386
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-displayDateFormat)
|
|
362
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-displayDateFormat)
|
|
387
363
|
*/
|
|
388
364
|
displayDateFormat ? : string
|
|
389
365
|
/**
|
|
@@ -391,24 +367,22 @@ defineProps<{
|
|
|
391
367
|
* [strips collection](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
|
|
392
368
|
* `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
|
|
393
369
|
* body. Such widgets are called "edge strips".
|
|
394
|
-
* ...
|
|
395
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-dock)
|
|
370
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-dock)
|
|
396
371
|
*/
|
|
397
372
|
dock ? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
398
373
|
/**
|
|
399
374
|
* Make this Panel a docked drawer which slides out from one side of the browser viewport by default.
|
|
400
|
-
* ...
|
|
401
|
-
* [
|
|
402
|
-
* @param {
|
|
403
|
-
* @param {
|
|
404
|
-
* @param {boolean}
|
|
405
|
-
* @param {boolean,
|
|
406
|
-
* @param {boolean,string} autoClose.
|
|
407
|
-
* @param {
|
|
408
|
-
* @param {
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
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}
|
|
375
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-drawer)
|
|
376
|
+
* @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.
|
|
377
|
+
* @param {string,number} [size] The size of the drawer in its collapsible axis.
|
|
378
|
+
* @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.
|
|
379
|
+
* @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.
|
|
380
|
+
* @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.
|
|
381
|
+
* @param {boolean,string} [autoClose.focusout] If focus moves outside of the drawer, the drawer will automatically be hidden.
|
|
382
|
+
* @param {string} [autoClose.mouseout] Hides the drawer when the mouse leaves the drawer after the `autoCloseDelay` period.
|
|
383
|
+
* @param {number} [autoCloseDelay] When using `mouseout`, this is the delay in milliseconds
|
|
384
|
+
*/
|
|
385
|
+
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 }
|
|
412
386
|
/**
|
|
413
387
|
* Decimal precision used when displaying durations, used by tooltips and DurationColumn.
|
|
414
388
|
* Specify `false` to use raw value
|
|
@@ -417,16 +391,14 @@ defineProps<{
|
|
|
417
391
|
/**
|
|
418
392
|
* An object specifying attributes to assign to the root element of this widget.
|
|
419
393
|
* Set `null` value to attribute to remove it.
|
|
420
|
-
* ...
|
|
421
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-elementAttributes)
|
|
394
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-elementAttributes)
|
|
422
395
|
*/
|
|
423
396
|
elementAttributes ? : Record<string, string|null>
|
|
424
397
|
/**
|
|
425
398
|
* 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.
|
|
426
399
|
* When using multiple Grid regions, provide the `region` property to decide where the text is shown.
|
|
427
400
|
* By default, it is shown in the first region.
|
|
428
|
-
* ...
|
|
429
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-emptyText)
|
|
401
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-emptyText)
|
|
430
402
|
*/
|
|
431
403
|
emptyText ? : string|EmptyTextDomConfig
|
|
432
404
|
/**
|
|
@@ -442,16 +414,14 @@ defineProps<{
|
|
|
442
414
|
* Enables showing occurrences of recurring events across the scheduler's time axis. If you want to disable
|
|
443
415
|
* the recurrence popup, you can choose set the `defaultAction` to `future` to affect all future
|
|
444
416
|
* occurrences, or `single` to just affect the currently selected event.
|
|
445
|
-
* ...
|
|
446
|
-
*
|
|
417
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-enableRecurringEvents)
|
|
418
|
+
* @property {'single','future'} defaultAction
|
|
447
419
|
*/
|
|
448
|
-
enableRecurringEvents ? : Boolean|
|
|
449
|
-
defaultAction?: 'single'|'future'
|
|
450
|
-
}
|
|
420
|
+
enableRecurringEvents ? : Boolean|object
|
|
451
421
|
/**
|
|
452
|
-
*
|
|
453
|
-
*
|
|
454
|
-
*
|
|
422
|
+
* Set to `true` to enable the [StickyCells](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/StickyCells) feature, which pins cell
|
|
423
|
+
* content to the top of the grid while rows scroll off the top but remain visible.
|
|
424
|
+
* @deprecated 7.3.0 Use `features : { stickyCells : true }` instead
|
|
455
425
|
*/
|
|
456
426
|
enableSticky ? : Boolean
|
|
457
427
|
/**
|
|
@@ -473,8 +443,7 @@ defineProps<{
|
|
|
473
443
|
enableUndoRedoKeys ? : Boolean
|
|
474
444
|
/**
|
|
475
445
|
* The end date of the timeline (if not configure with [infiniteScroll](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/TimelineBase#config-infiniteScroll)).
|
|
476
|
-
* ...
|
|
477
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-endDate)
|
|
446
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-endDate)
|
|
478
447
|
*/
|
|
479
448
|
endDate ? : Date|string
|
|
480
449
|
/**
|
|
@@ -488,22 +457,18 @@ defineProps<{
|
|
|
488
457
|
/**
|
|
489
458
|
* Event color used by default. Events and resources can specify their own color, with priority order being:
|
|
490
459
|
* Event -> Resource -> Scheduler default.
|
|
491
|
-
* ...
|
|
492
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-eventColor)
|
|
460
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-eventColor)
|
|
493
461
|
*/
|
|
494
462
|
eventColor ? : EventColor
|
|
495
463
|
/**
|
|
496
464
|
* Defines how to handle overlapping events. Valid values are:
|
|
497
|
-
* ...
|
|
498
|
-
*
|
|
465
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-eventLayout)
|
|
466
|
+
* @property {'stack','pack','mixed','none'} eventLayout.type
|
|
499
467
|
*/
|
|
500
|
-
eventLayout ? : 'stack'|'pack'|'mixed'|'none'|{
|
|
501
|
-
type?: 'stack'|'pack'|'mixed'|'none'
|
|
502
|
-
}
|
|
468
|
+
eventLayout ? : 'stack'|'pack'|'mixed'|'none'|{ type: 'stack'|'pack'|'mixed'|'none' }
|
|
503
469
|
/**
|
|
504
470
|
* An advanced setting that controls the maximum number of released event bars to keep in the DOM.
|
|
505
|
-
* ...
|
|
506
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-eventReleaseThreshold)
|
|
471
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-eventReleaseThreshold)
|
|
507
472
|
*/
|
|
508
473
|
eventReleaseThreshold ? : number
|
|
509
474
|
/**
|
|
@@ -511,30 +476,31 @@ defineProps<{
|
|
|
511
476
|
* an event is rendered into the schedule to render the contents of the event. It's called with the event,
|
|
512
477
|
* its resource and a `renderData` object which allows you to populate data placeholders inside the event
|
|
513
478
|
* template.
|
|
514
|
-
* ...
|
|
515
|
-
*
|
|
516
|
-
* @param {
|
|
517
|
-
* @param {Scheduler.model.
|
|
518
|
-
* @param {Scheduler.model.
|
|
519
|
-
* @param {Scheduler.
|
|
520
|
-
* @param {
|
|
521
|
-
* @param {
|
|
522
|
-
* @param {
|
|
523
|
-
* @param {
|
|
524
|
-
* @param {Core.helper.util.DomClassList,string}
|
|
525
|
-
* @param {Core.helper.util.DomClassList,string}
|
|
526
|
-
* @param {
|
|
527
|
-
* @param {number}
|
|
528
|
-
* @param {number}
|
|
529
|
-
* @param {
|
|
530
|
-
* @param {string,Record<string, string>}
|
|
531
|
-
* @param {
|
|
532
|
-
* @param {
|
|
533
|
-
* @param {string}
|
|
534
|
-
* @param {
|
|
479
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-eventRenderer)
|
|
480
|
+
* @param {object} context An object containing the information needed to render an Event
|
|
481
|
+
* @param {Scheduler.model.SchedulerEventModel} context.eventRecord The event record
|
|
482
|
+
* @param {Scheduler.model.SchedulerResourceModel} context.resourceRecord The resource record
|
|
483
|
+
* @param {Scheduler.model.SchedulerAssignmentModel} context.assignmentRecord The assignment record
|
|
484
|
+
* @param {Scheduler.view.Scheduler} context.scheduler The Scheduler instance
|
|
485
|
+
* @param {object} context.renderData An object containing details about the event rendering
|
|
486
|
+
* @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
|
|
487
|
+
* @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
|
|
488
|
+
* @param {Scheduler.model.SchedulerEventModel} context.renderData.event The event record
|
|
489
|
+
* @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
|
|
490
|
+
* @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.
|
|
491
|
+
* @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`
|
|
492
|
+
* @param {number} context.renderData.left Vertical offset position (in pixels) on the time axis
|
|
493
|
+
* @param {number} context.renderData.width Width in pixels of the event element
|
|
494
|
+
* @param {number} context.renderData.height Height in pixels of the event element
|
|
495
|
+
* @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' }`
|
|
496
|
+
* @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' }`
|
|
497
|
+
* @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
|
|
498
|
+
* @param {string} context.renderData.eventColor The `eventColor` of the event. Use this to set a custom color for the rendered event
|
|
499
|
+
* @param {string} context.renderData.ariaLabel A description of the event details used for screen readers
|
|
500
|
+
* @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.*
|
|
535
501
|
* @returns {string,DomConfig,DomConfig[]} A simple string, a DomConfig (or array thereof), or a JSX element when using React
|
|
536
502
|
*/
|
|
537
|
-
eventRenderer ? : (
|
|
503
|
+
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[]
|
|
538
504
|
/**
|
|
539
505
|
* `this` reference for the [eventRenderer](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/mixin/SchedulerEventRendering#config-eventRenderer) function
|
|
540
506
|
*/
|
|
@@ -555,8 +521,7 @@ defineProps<{
|
|
|
555
521
|
* Event style used by default. Events and resources can specify their own style, with priority order being:
|
|
556
522
|
* Event -> Resource -> Scheduler default. Determines the appearance of the event by assigning a CSS class
|
|
557
523
|
* to it. Available styles are:
|
|
558
|
-
* ...
|
|
559
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-eventStyle)
|
|
524
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-eventStyle)
|
|
560
525
|
*/
|
|
561
526
|
eventStyle ? : 'tonal'|'filled'|'bordered'|'traced'|'outlined'|'indented'|'line'|'dashed'|'minimal'|'rounded'|'calendar'|'interday'|'gantt'|null
|
|
562
527
|
extraData ? : any
|
|
@@ -569,16 +534,14 @@ defineProps<{
|
|
|
569
534
|
/**
|
|
570
535
|
* Specify `true` to force rendered events/tasks to fill entire ticks. This only affects rendering, start
|
|
571
536
|
* and end dates retain their value on the data level.
|
|
572
|
-
* ...
|
|
573
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-fillTicks)
|
|
537
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-fillTicks)
|
|
574
538
|
*/
|
|
575
539
|
fillTicks ? : Boolean
|
|
576
540
|
/**
|
|
577
541
|
* Use fixed row height. Setting this to `true` will configure the underlying RowManager to use fixed row
|
|
578
542
|
* height, which sacrifices the ability to use rows with variable height to gain a fraction better
|
|
579
543
|
* performance.
|
|
580
|
-
* ...
|
|
581
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-fixedRowHeight)
|
|
544
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-fixedRowHeight)
|
|
582
545
|
*/
|
|
583
546
|
fixedRowHeight ? : Boolean
|
|
584
547
|
/**
|
|
@@ -592,14 +555,12 @@ defineProps<{
|
|
|
592
555
|
/**
|
|
593
556
|
* Config object of a footer. May contain a `dock`, `html` and a `cls` property. A footer is not a widget,
|
|
594
557
|
* 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).
|
|
595
|
-
* ...
|
|
596
|
-
*
|
|
558
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-footer)
|
|
559
|
+
* @property {'top','right','bottom','left','start','end'} dock Where to dock
|
|
560
|
+
* @property {string} html Html to populate the footer with
|
|
561
|
+
* @property {string} cls CSS class to add to the footer
|
|
597
562
|
*/
|
|
598
|
-
footer ? :
|
|
599
|
-
dock?: 'top'|'right'|'bottom'|'left'|'start'|'end'
|
|
600
|
-
html?: string
|
|
601
|
-
cls?: string
|
|
602
|
-
}|string
|
|
563
|
+
footer ? : object|string
|
|
603
564
|
/**
|
|
604
565
|
* Set to `true` to force the time columns to fit to the available space (horizontal or vertical depends on mode).
|
|
605
566
|
* Note that setting [suppressFit](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/TimelineBase#config-suppressFit) to `true`, will disable `forceFit` functionality. Zooming
|
|
@@ -609,39 +570,34 @@ defineProps<{
|
|
|
609
570
|
/**
|
|
610
571
|
* An object which names formula prefixes which will be applied to all columns configured with
|
|
611
572
|
* `formula : true`.
|
|
612
|
-
* ...
|
|
613
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-formulaProviders)
|
|
573
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-formulaProviders)
|
|
614
574
|
*/
|
|
615
575
|
formulaProviders ? : Record<string, FormulaProviderConfig>
|
|
616
576
|
/**
|
|
617
577
|
* Refresh entire row when a record changes (`true`) or, if possible, only the cells affected (`false`).
|
|
618
|
-
* ...
|
|
619
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-fullRowRefresh)
|
|
578
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-fullRowRefresh)
|
|
620
579
|
*/
|
|
621
580
|
fullRowRefresh ? : Boolean
|
|
622
581
|
/**
|
|
623
582
|
* A method allowing you to define date boundaries that will constrain resize, create and drag drop
|
|
624
583
|
* operations. The method will be called with the Resource record, and the Event record.
|
|
625
|
-
* ...
|
|
626
|
-
* [
|
|
627
|
-
* @param {Scheduler.model.
|
|
628
|
-
* @param {Scheduler.model.SchedulerEventModel} eventRecord The event record
|
|
584
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-getDateConstraints)
|
|
585
|
+
* @param {Scheduler.model.SchedulerResourceModel} [resourceRecord] The resource record
|
|
586
|
+
* @param {Scheduler.model.SchedulerEventModel} [eventRecord] The event record
|
|
629
587
|
* @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.
|
|
630
588
|
*/
|
|
631
|
-
getDateConstraints ? : (resourceRecord
|
|
589
|
+
getDateConstraints ? : (resourceRecord: SchedulerResourceModel, eventRecord: SchedulerEventModel) => DateConstraint
|
|
632
590
|
/**
|
|
633
591
|
* Scheduler overrides Grid's default implementation of [getRowHeight](https://bryntum.com/products/schedulerpro/docs/api/Grid/view/GridBase#config-getRowHeight) to
|
|
634
592
|
* pre-calculate row heights based on events in the rows.
|
|
635
|
-
* ...
|
|
636
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-getRowHeight)
|
|
593
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-getRowHeight)
|
|
637
594
|
* @param {Scheduler.model.SchedulerResourceModel} getRowHeight.record Resource record to determine row height for
|
|
638
595
|
* @returns {number} Desired row height
|
|
639
596
|
*/
|
|
640
|
-
getRowHeight ? : (
|
|
597
|
+
getRowHeight ? : () => number
|
|
641
598
|
/**
|
|
642
599
|
* 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`.
|
|
643
|
-
* ...
|
|
644
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-header)
|
|
600
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-header)
|
|
645
601
|
*/
|
|
646
602
|
header ? : string|Boolean|PanelHeader
|
|
647
603
|
/**
|
|
@@ -668,8 +624,7 @@ defineProps<{
|
|
|
668
624
|
hideHorizontalScrollbar ? : Boolean
|
|
669
625
|
/**
|
|
670
626
|
* By default the row hover effect is not visible in the Scheduler part of the grid.
|
|
671
|
-
* ...
|
|
672
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-hideRowHover)
|
|
627
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-hideRowHover)
|
|
673
628
|
*/
|
|
674
629
|
hideRowHover ? : Boolean
|
|
675
630
|
/**
|
|
@@ -700,15 +655,13 @@ defineProps<{
|
|
|
700
655
|
ignoreDomEventsWhileScrolling ? : Boolean
|
|
701
656
|
/**
|
|
702
657
|
* Determines if the widgets read-only state should be controlled by its parent.
|
|
703
|
-
* ...
|
|
704
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-ignoreParentReadOnly)
|
|
658
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-ignoreParentReadOnly)
|
|
705
659
|
*/
|
|
706
660
|
ignoreParentReadOnly ? : Boolean
|
|
707
661
|
/**
|
|
708
662
|
* Set to `true` to automatically adjust the panel timespan during scrolling in the time dimension,
|
|
709
663
|
* when the scroller comes close to the start/end edges.
|
|
710
|
-
* ...
|
|
711
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-infiniteScroll)
|
|
664
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-infiniteScroll)
|
|
712
665
|
*/
|
|
713
666
|
infiniteScroll ? : Boolean
|
|
714
667
|
/**
|
|
@@ -723,8 +676,7 @@ defineProps<{
|
|
|
723
676
|
* Convenience setting to align input fields of child widgets. By default, the Field input element is
|
|
724
677
|
* placed immediately following the `label`. If you prefer to have all input fields aligned to the
|
|
725
678
|
* right, set this config to `'end'`.
|
|
726
|
-
* ...
|
|
727
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-inputFieldAlign)
|
|
679
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-inputFieldAlign)
|
|
728
680
|
*/
|
|
729
681
|
inputFieldAlign ? : 'start'|'end'
|
|
730
682
|
/**
|
|
@@ -737,8 +689,7 @@ defineProps<{
|
|
|
737
689
|
insertFirst ? : HTMLElement|string
|
|
738
690
|
/**
|
|
739
691
|
* A template method (empty by default) allowing you to control if an event can be selected or not.
|
|
740
|
-
* ...
|
|
741
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-isEventSelectable)
|
|
692
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-isEventSelectable)
|
|
742
693
|
* @param {Scheduler.model.SchedulerEventModel} event The event record
|
|
743
694
|
* @returns {boolean} true if event can be selected, otherwise false
|
|
744
695
|
*/
|
|
@@ -749,10 +700,14 @@ defineProps<{
|
|
|
749
700
|
keyMap ? : Record<string, KeyMapConfig>
|
|
750
701
|
/**
|
|
751
702
|
* Convenience setting to use same label placement on all child widgets.
|
|
752
|
-
* ...
|
|
753
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-labelPosition)
|
|
703
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-labelPosition)
|
|
754
704
|
*/
|
|
755
705
|
labelPosition ? : 'before'|'above'|'align-before'|'auto'|null
|
|
706
|
+
/**
|
|
707
|
+
* Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
|
|
708
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-labelWidth)
|
|
709
|
+
*/
|
|
710
|
+
labelWidth ? : number|null
|
|
756
711
|
/**
|
|
757
712
|
* By default, when the `EventStore` (and similar stores) is lazy loading, a loading indicator will be displayed
|
|
758
713
|
* just below the timeline headers. Set this to `false` to prevent this indicator being shown.
|
|
@@ -760,14 +715,12 @@ defineProps<{
|
|
|
760
715
|
lazyLoadingIndicator ? : Boolean
|
|
761
716
|
/**
|
|
762
717
|
* The listener set for this object.
|
|
763
|
-
* ...
|
|
764
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-listeners)
|
|
718
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-listeners)
|
|
765
719
|
*/
|
|
766
720
|
listeners ? : TimelineListeners
|
|
767
721
|
/**
|
|
768
722
|
* *This property is for use when the Scheduler is used as a Calendar view - a `mode`.*
|
|
769
|
-
* ...
|
|
770
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-listRangeMenu)
|
|
723
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-listRangeMenu)
|
|
771
724
|
*/
|
|
772
725
|
listRangeMenu ? : MenuConfig
|
|
773
726
|
/**
|
|
@@ -780,15 +733,13 @@ defineProps<{
|
|
|
780
733
|
* when data is loading. The message and optional configuration from the
|
|
781
734
|
* [loadMask](https://bryntum.com/products/schedulerpro/docs/api/Core/mixin/LoadMaskable#config-loadMask) config take priority over these options, just as they do
|
|
782
735
|
* for `maskDefaults`, respectively.
|
|
783
|
-
* ...
|
|
784
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-loadMaskDefaults)
|
|
736
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-loadMaskDefaults)
|
|
785
737
|
*/
|
|
786
738
|
loadMaskDefaults ? : MaskConfig
|
|
787
739
|
/**
|
|
788
740
|
* A [Mask](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Mask) config object to adjust the [maskDefaults](#Core/widget/Widget#config-maskDefaults)
|
|
789
741
|
* when an error occurs loading data.
|
|
790
|
-
* ...
|
|
791
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-loadMaskError)
|
|
742
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-loadMaskError)
|
|
792
743
|
*/
|
|
793
744
|
loadMaskError ? : MaskConfig|Mask|Boolean
|
|
794
745
|
/**
|
|
@@ -807,8 +758,7 @@ defineProps<{
|
|
|
807
758
|
/**
|
|
808
759
|
* When `true`, events are sized and positioned based on rowHeight, resourceMargin and barMargin settings.
|
|
809
760
|
* Set this to `false` if you want to control height and vertical position using CSS instead.
|
|
810
|
-
* ...
|
|
811
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-managedEventSizing)
|
|
761
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-managedEventSizing)
|
|
812
762
|
*/
|
|
813
763
|
managedEventSizing ? : Boolean
|
|
814
764
|
/**
|
|
@@ -839,8 +789,7 @@ defineProps<{
|
|
|
839
789
|
/**
|
|
840
790
|
* The maximum time axis unit to display non-working ranges for ('hour' or 'day' etc).
|
|
841
791
|
* When zooming to a view with a larger unit, no non-working time elements will be rendered.
|
|
842
|
-
* ...
|
|
843
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-maxTimeAxisUnit)
|
|
792
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-maxTimeAxisUnit)
|
|
844
793
|
*/
|
|
845
794
|
maxTimeAxisUnit ? : DurationUnit
|
|
846
795
|
/**
|
|
@@ -849,17 +798,14 @@ defineProps<{
|
|
|
849
798
|
*/
|
|
850
799
|
maxWidth ? : string|number
|
|
851
800
|
/**
|
|
852
|
-
* The maximum zoom level to which [zoomIn](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomIn) will work.
|
|
853
|
-
* [
|
|
854
|
-
* for information. Unless you have modified the collection of available presets, the max zoom level is
|
|
855
|
-
* milliseconds.
|
|
801
|
+
* The maximum zoom level to which [zoomIn](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomIn) will work.
|
|
802
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-maxZoomLevel)
|
|
856
803
|
*/
|
|
857
|
-
maxZoomLevel ? : number
|
|
804
|
+
maxZoomLevel ? : number|string
|
|
858
805
|
/**
|
|
859
806
|
* How to align milestones in relation to their startDate. Only applies when using a `milestoneLayoutMode`
|
|
860
807
|
* other than `default`. Valid values are:
|
|
861
|
-
* ...
|
|
862
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-milestoneAlign)
|
|
808
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-milestoneAlign)
|
|
863
809
|
*/
|
|
864
810
|
milestoneAlign ? : 'start'|'center'|'end'
|
|
865
811
|
/**
|
|
@@ -870,14 +816,12 @@ defineProps<{
|
|
|
870
816
|
/**
|
|
871
817
|
* How to handle milestones during event layout. How the milestones are displayed when part of the layout
|
|
872
818
|
* are controlled using [milestoneTextPosition](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/mixin/SchedulerEventRendering#config-milestoneTextPosition).
|
|
873
|
-
* ...
|
|
874
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-milestoneLayoutMode)
|
|
819
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-milestoneLayoutMode)
|
|
875
820
|
*/
|
|
876
821
|
milestoneLayoutMode ? : 'default'|'estimate'|'data'|'measure'
|
|
877
822
|
/**
|
|
878
823
|
* Position of the milestone text:
|
|
879
|
-
* ...
|
|
880
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-milestoneTextPosition)
|
|
824
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-milestoneTextPosition)
|
|
881
825
|
*/
|
|
882
826
|
milestoneTextPosition ? : 'inside'|'outside'|'always-outside'
|
|
883
827
|
/**
|
|
@@ -889,16 +833,14 @@ defineProps<{
|
|
|
889
833
|
/**
|
|
890
834
|
* Grid's `min-height`. Defaults to `10em` to be sure that the Grid always has a height wherever it is
|
|
891
835
|
* inserted.
|
|
892
|
-
* ...
|
|
893
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-minHeight)
|
|
836
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-minHeight)
|
|
894
837
|
*/
|
|
895
838
|
minHeight ? : string|number
|
|
896
839
|
/**
|
|
897
840
|
* *Experimental* Minimum size that events should be allowed to shrink to when using `pack` layout. If
|
|
898
841
|
* packing leads to any event being smaller than this value, the row will grow in height instead to maintain
|
|
899
842
|
* this minimum size.
|
|
900
|
-
* ...
|
|
901
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-minPackSize)
|
|
843
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-minPackSize)
|
|
902
844
|
*/
|
|
903
845
|
minPackSize ? : number
|
|
904
846
|
/**
|
|
@@ -907,9 +849,10 @@ defineProps<{
|
|
|
907
849
|
*/
|
|
908
850
|
minWidth ? : string|number
|
|
909
851
|
/**
|
|
910
|
-
* The minimum zoom level to which [zoomOut](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomOut) will work.
|
|
852
|
+
* The minimum zoom level to which [zoomOut](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomOut) will work.
|
|
853
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-minZoomLevel)
|
|
911
854
|
*/
|
|
912
|
-
minZoomLevel ? : number
|
|
855
|
+
minZoomLevel ? : number|string
|
|
913
856
|
/**
|
|
914
857
|
* Scheduler mode. Supported values: horizontal, vertical
|
|
915
858
|
*/
|
|
@@ -920,27 +863,23 @@ defineProps<{
|
|
|
920
863
|
monitorResize ? : Boolean
|
|
921
864
|
/**
|
|
922
865
|
* Configure as `true` to allow `CTRL/CMD+click` to select multiple events in the scheduler.
|
|
923
|
-
* ...
|
|
924
|
-
* [
|
|
866
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-multiEventSelect)
|
|
867
|
+
* @property {boolean} [ctrlKey] Set to `true` to use <kbd>Ctrl</kbd> key for multi selection (<kbd>Cmd</kbd> on Mac).
|
|
868
|
+
* @property {boolean} [altKey] Set to `true` to use <kbd>Alt</kbd> key for multi selection (<kbd>Option</kbd> on Mac)
|
|
869
|
+
* @property {boolean} [shiftKey] Set to `true` to use <kbd>Shift</kbd> key for multi selection
|
|
925
870
|
*/
|
|
926
|
-
multiEventSelect ? : Boolean|
|
|
927
|
-
ctrlKey?: Boolean
|
|
928
|
-
altKey?: Boolean
|
|
929
|
-
shiftKey?: Boolean
|
|
930
|
-
}
|
|
871
|
+
multiEventSelect ? : Boolean|object
|
|
931
872
|
/**
|
|
932
873
|
* When an event bar has a width less than this value, it gets the CSS class `b-sch-event-narrow`
|
|
933
874
|
* added. You may apply custom CSS rules using this class.
|
|
934
|
-
* ...
|
|
935
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-narrowEventWidth)
|
|
875
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-narrowEventWidth)
|
|
936
876
|
*/
|
|
937
877
|
narrowEventWidth ? : number
|
|
938
878
|
/**
|
|
939
879
|
* Override this method to provide a custom sort function to sort any overlapping events. This only applies
|
|
940
880
|
* to the horizontal mode, where the order the events are sorted in determines their vertical placement
|
|
941
881
|
* within a resource.
|
|
942
|
-
* ...
|
|
943
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-overlappingEventSorter)
|
|
882
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-overlappingEventSorter)
|
|
944
883
|
* @param {Scheduler.model.SchedulerEventModel} a First event
|
|
945
884
|
* @param {Scheduler.model.SchedulerEventModel} b Second event
|
|
946
885
|
* @returns {number} Return -1 to display `a` above `b`, 1 for `b` above `a`
|
|
@@ -949,26 +888,23 @@ defineProps<{
|
|
|
949
888
|
/**
|
|
950
889
|
* Partners this Timeline panel with another Timeline in order to sync their region sizes (sub-grids like locked, normal will get the same width),
|
|
951
890
|
* start and end dates, view preset, zoom level and scrolling position. All these values will be synced with the timeline defined as the `partner`.
|
|
952
|
-
* ...
|
|
953
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-partner)
|
|
891
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-partner)
|
|
954
892
|
*/
|
|
955
893
|
partner ? : TimelineBase|string
|
|
956
894
|
/**
|
|
957
895
|
* Set to `true` to include `startDate` and `endDate` params indicating the currently viewed date range in
|
|
958
896
|
* `EventStore` load requests (when loading using `AjaxStore` or `CrudManager` functionality).
|
|
959
|
-
* ...
|
|
960
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-passStartEndParameters)
|
|
897
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-passStartEndParameters)
|
|
961
898
|
*/
|
|
962
899
|
passStartEndParameters ? : Boolean
|
|
963
900
|
/**
|
|
964
901
|
* Specify plugins (an array of classes) in config
|
|
965
902
|
*/
|
|
966
|
-
plugins ? :
|
|
903
|
+
plugins ? : InstancePlugin[]|InstancePlugin
|
|
967
904
|
/**
|
|
968
905
|
* Maximum number of resources for which height is pre-calculated. If you have many events per
|
|
969
906
|
* resource you might want to lower this number to gain some initial rendering performance.
|
|
970
|
-
* ...
|
|
971
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-preCalculateHeightLimit)
|
|
907
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-preCalculateHeightLimit)
|
|
972
908
|
*/
|
|
973
909
|
preCalculateHeightLimit ? : number
|
|
974
910
|
/**
|
|
@@ -986,10 +922,9 @@ defineProps<{
|
|
|
986
922
|
*/
|
|
987
923
|
preserveScrollOnDatasetChange ? : Boolean
|
|
988
924
|
/**
|
|
989
|
-
* An array of [ViewPreset](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/preset/ViewPreset) config objects
|
|
990
|
-
*
|
|
991
|
-
* ...
|
|
992
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-presets)
|
|
925
|
+
* An array of [ViewPreset](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/preset/ViewPreset) config objects which describes the available timeline layouts
|
|
926
|
+
* for this scheduler.
|
|
927
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-presets)
|
|
993
928
|
*/
|
|
994
929
|
presets ? : ViewPresetConfig[]
|
|
995
930
|
/**
|
|
@@ -1004,43 +939,45 @@ defineProps<{
|
|
|
1004
939
|
/**
|
|
1005
940
|
* Range used to set the length of the time axis when used as a component of a Calendar. Suitable units are
|
|
1006
941
|
* `'month'`, `'week'` and `'day'`.
|
|
1007
|
-
* ...
|
|
1008
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-range)
|
|
942
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-range)
|
|
1009
943
|
*/
|
|
1010
944
|
range ? : string|DurationConfig
|
|
1011
945
|
/**
|
|
1012
946
|
* Configure as `true` to make the scheduler read-only, by disabling any UIs for modifying data.
|
|
1013
|
-
* ...
|
|
1014
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-readOnly)
|
|
947
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-readOnly)
|
|
1015
948
|
*/
|
|
1016
949
|
readOnly ? : Boolean
|
|
1017
950
|
/**
|
|
1018
951
|
* The confirmation dialog shown when a recurring event is edited.
|
|
1019
|
-
* ...
|
|
1020
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-recurrenceConfirmationPopup)
|
|
952
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-recurrenceConfirmationPopup)
|
|
1021
953
|
*/
|
|
1022
|
-
recurrenceConfirmationPopup ? : RecurrenceConfirmationPopupConfig
|
|
954
|
+
recurrenceConfirmationPopup ? : RecurrenceConfirmationPopupConfig
|
|
1023
955
|
relayStoreEvents ? : Boolean
|
|
1024
956
|
/**
|
|
1025
957
|
* Either a default `rendition` to apply to all child widgets, or a map of renditions keyed by child widget
|
|
1026
958
|
* `type`.
|
|
1027
|
-
* ...
|
|
1028
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-rendition)
|
|
959
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-rendition)
|
|
1029
960
|
*/
|
|
1030
961
|
rendition ? : string|Record<string, string>|null
|
|
1031
962
|
/**
|
|
1032
963
|
* Configure this property to allow the widget/component to be resized. Pressing <kbd>Shift</kbd> while resizing will
|
|
1033
964
|
* constrain the aspect ratio.
|
|
1034
|
-
* ...
|
|
1035
|
-
* [
|
|
1036
|
-
|
|
1037
|
-
|
|
1038
|
-
|
|
1039
|
-
|
|
1040
|
-
|
|
1041
|
-
|
|
1042
|
-
|
|
1043
|
-
|
|
965
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-resizable)
|
|
966
|
+
* @property {number} [resizable.minWidth] The minimum width of the element.
|
|
967
|
+
* @property {number} [resizable.maxWidth] The maximum width of the element.
|
|
968
|
+
* @property {number} [resizable.minHeight] The minimum height of the element.
|
|
969
|
+
* @property {number} [resizable.maxHeight] The maximum height of the element
|
|
970
|
+
* @property {object} [resizable.handles] An object controlling which edges/corners are resizable.
|
|
971
|
+
* @property {boolean} [resizable.handles.topStart] Resizable from top-start corner
|
|
972
|
+
* @property {boolean} [resizable.handles.top] Resizable from top edge
|
|
973
|
+
* @property {boolean} [resizable.handles.topEnd] Resizable from top-end corner
|
|
974
|
+
* @property {boolean} [resizable.handles.end] Resizable from end edge
|
|
975
|
+
* @property {boolean} [resizable.handles.bottomEnd] Resizable from bottom-end corner
|
|
976
|
+
* @property {boolean} [resizable.handles.bottom] Resizable from bottom edge
|
|
977
|
+
* @property {boolean} [resizable.handles.bottomStart] Resizable from bottom-start corner
|
|
978
|
+
* @property {boolean} [resizable.handles.start] Resizable from start edge
|
|
979
|
+
*/
|
|
980
|
+
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 } }
|
|
1044
981
|
/**
|
|
1045
982
|
* Set to `false` to only measure cell contents when double-clicking the edge between column headers.
|
|
1046
983
|
*/
|
|
@@ -1048,8 +985,7 @@ defineProps<{
|
|
|
1048
985
|
/**
|
|
1049
986
|
* A config object used to configure the resource columns in vertical mode.
|
|
1050
987
|
* See [ResourceHeader](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/ResourceHeader) for more details on available properties.
|
|
1051
|
-
* ...
|
|
1052
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-resourceColumns)
|
|
988
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-resourceColumns)
|
|
1053
989
|
*/
|
|
1054
990
|
resourceColumns ? : ResourceHeaderConfig
|
|
1055
991
|
/**
|
|
@@ -1060,25 +996,21 @@ defineProps<{
|
|
|
1060
996
|
* Path to load resource images from. Used by the resource header in vertical mode and the
|
|
1061
997
|
* [ResourceInfoColumn](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/column/ResourceInfoColumn) in horizontal mode. Set this to display miniature
|
|
1062
998
|
* images for each resource using their `image` or `imageUrl` fields.
|
|
1063
|
-
* ...
|
|
1064
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-resourceImagePath)
|
|
999
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-resourceImagePath)
|
|
1065
1000
|
*/
|
|
1066
1001
|
resourceImagePath ? : string
|
|
1067
1002
|
/**
|
|
1068
1003
|
* 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).
|
|
1069
|
-
* ...
|
|
1070
|
-
*
|
|
1004
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-resourceImages)
|
|
1005
|
+
* @property {string} path Path to load resource images from
|
|
1006
|
+
* @property {string} extension Resource image extension
|
|
1071
1007
|
*/
|
|
1072
|
-
resourceImages ? :
|
|
1073
|
-
path?: string
|
|
1074
|
-
extension?: string
|
|
1075
|
-
}
|
|
1008
|
+
resourceImages ? : object
|
|
1076
1009
|
/**
|
|
1077
1010
|
* Control how much space to leave between the first event/last event and the resources edge (top/bottom
|
|
1078
1011
|
* margin within the resource row in horizontal mode, left/right margin within the resource column in
|
|
1079
1012
|
* vertical mode), in px. Defaults to the value of [barMargin](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/Scheduler#config-barMargin).
|
|
1080
|
-
* ...
|
|
1081
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-resourceMargin)
|
|
1013
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-resourceMargin)
|
|
1082
1014
|
*/
|
|
1083
1015
|
resourceMargin ? : number|ResourceMarginConfig
|
|
1084
1016
|
/**
|
|
@@ -1093,8 +1025,7 @@ defineProps<{
|
|
|
1093
1025
|
* An empty function by default, but provided so that you can override it. This function is called each time
|
|
1094
1026
|
* a resource time range is rendered into the schedule. It's called with `resourceTimeRangeRecord`, `resourceRecord`,
|
|
1095
1027
|
* and `renderData` params.
|
|
1096
|
-
* ...
|
|
1097
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-resourceTimeRangeRenderer)
|
|
1028
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-resourceTimeRangeRenderer)
|
|
1098
1029
|
* @param {object} detail An object containing the information needed to render a ResourceTimeRangeModel.
|
|
1099
1030
|
* @param {Scheduler.model.ResourceTimeRangeModel} detail.resourceTimeRangeRecord The resource time range record.
|
|
1100
1031
|
* @param {Scheduler.model.SchedulerResourceModel} detail.resourceRecord The resource record.
|
|
@@ -1113,23 +1044,26 @@ defineProps<{
|
|
|
1113
1044
|
resourceTimeRangeStore ? : ResourceTimeRangeStore|ResourceTimeRangeStoreConfig
|
|
1114
1045
|
/**
|
|
1115
1046
|
* "Break points" for which responsive config to use.
|
|
1116
|
-
* ...
|
|
1117
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-responsiveLevels)
|
|
1047
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-responsiveLevels)
|
|
1118
1048
|
*/
|
|
1119
1049
|
responsiveLevels ? : Record<string, number|string|SchedulerResponsiveLevelConfig>
|
|
1120
1050
|
/**
|
|
1121
1051
|
* Configure as `true` to have the component display a translucent ripple when its
|
|
1122
1052
|
* [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
|
|
1123
1053
|
* current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
|
|
1124
|
-
* ...
|
|
1125
|
-
* [
|
|
1054
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-ripple)
|
|
1055
|
+
* @property {string} [delegate] A CSS selector to filter which child elements trigger ripples. By default, the ripple is clipped to the triggering element.
|
|
1056
|
+
* @property {string} [color] A CSS color name or specification.
|
|
1057
|
+
* @property {number} [radius] The ending radius of the ripple. Note that it will be clipped by the target element by default.
|
|
1058
|
+
* @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.
|
|
1126
1059
|
*/
|
|
1127
|
-
ripple ? : Boolean|
|
|
1128
|
-
|
|
1129
|
-
|
|
1130
|
-
|
|
1131
|
-
|
|
1132
|
-
|
|
1060
|
+
ripple ? : Boolean|object
|
|
1061
|
+
/**
|
|
1062
|
+
* The ARIA role to apply to this widget's element. By default, this is set to `'presentation'` to avoid
|
|
1063
|
+
* accidentally applying a role which may interfere with screen readers.
|
|
1064
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-role)
|
|
1065
|
+
*/
|
|
1066
|
+
role ? : string
|
|
1133
1067
|
/**
|
|
1134
1068
|
* 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`
|
|
1135
1069
|
*/
|
|
@@ -1144,15 +1078,13 @@ defineProps<{
|
|
|
1144
1078
|
rowLines ? : Boolean
|
|
1145
1079
|
/**
|
|
1146
1080
|
* This may be configured as `true` to make the widget's element use the `direction:rtl` style.
|
|
1147
|
-
* ...
|
|
1148
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-rtl)
|
|
1081
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-rtl)
|
|
1149
1082
|
*/
|
|
1150
1083
|
rtl ? : Boolean
|
|
1151
1084
|
/**
|
|
1152
1085
|
* 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).
|
|
1153
1086
|
* See the [scrollerClass](https://bryntum.com/products/schedulerpro/docs/api/Grid/view/GridBase#config-scrollerClass) config option.
|
|
1154
|
-
* ...
|
|
1155
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-scrollable)
|
|
1087
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-scrollable)
|
|
1156
1088
|
*/
|
|
1157
1089
|
scrollable ? : Boolean|ScrollerConfig|Scroller
|
|
1158
1090
|
/**
|
|
@@ -1162,8 +1094,7 @@ defineProps<{
|
|
|
1162
1094
|
/**
|
|
1163
1095
|
* Specifies the maximum duration for extending the current [TimeSpan](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/model/TimeSpan) to allow for smooth
|
|
1164
1096
|
* scrolling to an event.
|
|
1165
|
-
* ...
|
|
1166
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-scrollExtensionThreshold)
|
|
1097
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-scrollExtensionThreshold)
|
|
1167
1098
|
*/
|
|
1168
1099
|
scrollExtensionThreshold ? : string|DurationConfig
|
|
1169
1100
|
/**
|
|
@@ -1174,8 +1105,7 @@ defineProps<{
|
|
|
1174
1105
|
/**
|
|
1175
1106
|
* Selection configuration settings, change these properties to control how selection works and what can be
|
|
1176
1107
|
* selected.
|
|
1177
|
-
* ...
|
|
1178
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-selectionMode)
|
|
1108
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-selectionMode)
|
|
1179
1109
|
*/
|
|
1180
1110
|
selectionMode ? : GridSelectionMode
|
|
1181
1111
|
/**
|
|
@@ -1187,11 +1117,9 @@ defineProps<{
|
|
|
1187
1117
|
*/
|
|
1188
1118
|
selectResourceOnScheduleClick ? : Boolean
|
|
1189
1119
|
/**
|
|
1190
|
-
* <div class="note">This property is for use when the Scheduler is used as a Calendar view - a `mode
|
|
1191
|
-
*
|
|
1192
|
-
*
|
|
1193
|
-
* ...
|
|
1194
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-shiftIncrement)
|
|
1120
|
+
* <div class="note">This property is for use when the Scheduler is used as a Calendar view - a `mode` - it will have no
|
|
1121
|
+
* effect on a Scheduler which is not inside a Calendar.</div>
|
|
1122
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-shiftIncrement)
|
|
1195
1123
|
*/
|
|
1196
1124
|
shiftIncrement ? : string|DurationConfig
|
|
1197
1125
|
/**
|
|
@@ -1201,13 +1129,11 @@ defineProps<{
|
|
|
1201
1129
|
/**
|
|
1202
1130
|
* Configure as `true` to have the grid show a red "changed" tag in cells whose
|
|
1203
1131
|
* field value has changed and not yet been committed.
|
|
1204
|
-
* ...
|
|
1205
|
-
*
|
|
1132
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-showDirty)
|
|
1133
|
+
* @property {boolean} showDirty.duringEdit Set to `true` to show the red tag while editing a cell
|
|
1134
|
+
* @property {boolean} showDirty.newRecord Set to `true` to show the red tag for all the cells of the new record
|
|
1206
1135
|
*/
|
|
1207
|
-
showDirty ? : Boolean|{
|
|
1208
|
-
duringEdit?: Boolean
|
|
1209
|
-
newRecord?: Boolean
|
|
1210
|
-
}
|
|
1136
|
+
showDirty ? : Boolean|{ duringEdit: Boolean, newRecord: Boolean }
|
|
1211
1137
|
/**
|
|
1212
1138
|
* 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
|
|
1213
1139
|
* 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
|
|
@@ -1230,17 +1156,25 @@ defineProps<{
|
|
|
1230
1156
|
* Set to `true` to show a tooltip when hovering a dependency line
|
|
1231
1157
|
*/
|
|
1232
1158
|
showTooltip ? : Boolean
|
|
1159
|
+
/**
|
|
1160
|
+
* When `true`, all zoom operations ([zoomIn](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomIn),
|
|
1161
|
+
* [zoomOut](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomOut),
|
|
1162
|
+
* [zoomInFull](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomInFull),
|
|
1163
|
+
* [zoomOutFull](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomOutFull)) will use the smooth zoom system instead
|
|
1164
|
+
* of jumping between discrete preset levels. This provides finer-grained control over zoom levels by
|
|
1165
|
+
* interpolating tick sizes between presets.
|
|
1166
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-smoothZoom)
|
|
1167
|
+
*/
|
|
1168
|
+
smoothZoom ? : Boolean
|
|
1233
1169
|
/**
|
|
1234
1170
|
* Set to `true` to snap to the current time resolution increment while interacting with scheduled events.
|
|
1235
|
-
* ...
|
|
1236
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-snap)
|
|
1171
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-snap)
|
|
1237
1172
|
*/
|
|
1238
1173
|
snap ? : Boolean
|
|
1239
1174
|
/**
|
|
1240
1175
|
* Affects drag drop and resizing of events when [snap](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/mixin/TimelineDateMapper#config-snap)
|
|
1241
1176
|
* is enabled.
|
|
1242
|
-
* ...
|
|
1243
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-snapRelativeToEventStartDate)
|
|
1177
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-snapRelativeToEventStartDate)
|
|
1244
1178
|
*/
|
|
1245
1179
|
snapRelativeToEventStartDate ? : Boolean
|
|
1246
1180
|
/**
|
|
@@ -1249,8 +1183,7 @@ defineProps<{
|
|
|
1249
1183
|
span ? : number
|
|
1250
1184
|
/**
|
|
1251
1185
|
* The start date of the timeline (if not configure with [infiniteScroll](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/TimelineBase#config-infiniteScroll)).
|
|
1252
|
-
* ...
|
|
1253
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-startDate)
|
|
1186
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-startDate)
|
|
1254
1187
|
*/
|
|
1255
1188
|
startDate ? : Date|string
|
|
1256
1189
|
/**
|
|
@@ -1259,40 +1192,34 @@ defineProps<{
|
|
|
1259
1192
|
startParamName ? : string
|
|
1260
1193
|
/**
|
|
1261
1194
|
* This value can be one of the following:
|
|
1262
|
-
* ...
|
|
1263
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-stateful)
|
|
1195
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-stateful)
|
|
1264
1196
|
*/
|
|
1265
1197
|
stateful ? : Boolean|object|string[]
|
|
1266
1198
|
/**
|
|
1267
1199
|
* The events that, when fired by this component, should trigger it to save its state by calling
|
|
1268
1200
|
* [saveState](https://bryntum.com/products/schedulerpro/docs/api/Core/mixin/State#function-saveState).
|
|
1269
|
-
* ...
|
|
1270
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-statefulEvents)
|
|
1201
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-statefulEvents)
|
|
1271
1202
|
*/
|
|
1272
1203
|
statefulEvents ? : object|string[]
|
|
1273
1204
|
/**
|
|
1274
1205
|
* 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
|
|
1275
1206
|
* 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)
|
|
1276
1207
|
* (if explicitly specified) will be used as the `stateId`.
|
|
1277
|
-
* ...
|
|
1278
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-stateId)
|
|
1208
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-stateId)
|
|
1279
1209
|
*/
|
|
1280
1210
|
stateId ? : string
|
|
1281
1211
|
/**
|
|
1282
1212
|
* 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`
|
|
1283
1213
|
* will be saved using the [default state provider](https://bryntum.com/products/schedulerpro/docs/api/Core/state/StateProvider#property-instance-static).
|
|
1284
|
-
* ...
|
|
1285
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-stateProvider)
|
|
1214
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-stateProvider)
|
|
1286
1215
|
*/
|
|
1287
1216
|
stateProvider ? : StateProvider
|
|
1288
1217
|
/**
|
|
1289
1218
|
* The properties of this settings object controls how grid is restored from state data.
|
|
1290
|
-
* ...
|
|
1291
|
-
* [
|
|
1219
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-stateSettings)
|
|
1220
|
+
* @property {boolean} [restoreUnconfiguredColumns] Determines whether to restore columns from the state that are not explicitly defined in the grid configuration.
|
|
1292
1221
|
*/
|
|
1293
|
-
stateSettings ? :
|
|
1294
|
-
restoreUnconfiguredColumns?: Boolean
|
|
1295
|
-
}
|
|
1222
|
+
stateSettings ? : object
|
|
1296
1223
|
/**
|
|
1297
1224
|
* When set, the text in the major time axis header sticks in the scrolling viewport as long as possible.
|
|
1298
1225
|
*/
|
|
@@ -1300,24 +1227,21 @@ defineProps<{
|
|
|
1300
1227
|
/**
|
|
1301
1228
|
* Store that holds records to display in the grid, or a store config object. If the configuration contains
|
|
1302
1229
|
* a `readUrl`, an `AjaxStore` will be created.
|
|
1303
|
-
* ...
|
|
1304
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-store)
|
|
1230
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-store)
|
|
1305
1231
|
*/
|
|
1306
1232
|
store ? : Store|StoreConfig|AjaxStore|AjaxStoreConfig
|
|
1307
1233
|
/**
|
|
1308
1234
|
* An object containing widgets keyed by name. By default (when no `type` is given), strips are
|
|
1309
1235
|
* [toolbars](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Toolbar). If you want to pass an array, you can use
|
|
1310
1236
|
* the toolbar's [items](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Container#config-items).
|
|
1311
|
-
* ...
|
|
1312
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-strips)
|
|
1237
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-strips)
|
|
1313
1238
|
*/
|
|
1314
1239
|
strips ? : Record<string, SchedulerProContainerItemConfig>
|
|
1315
1240
|
/**
|
|
1316
1241
|
* An object containing sub grid configuration objects keyed by a `region` property.
|
|
1317
1242
|
* By default, grid has a 'locked' region (if configured with locked columns) and a 'normal' region.
|
|
1318
1243
|
* The 'normal' region defaults to use `flex: 1`.
|
|
1319
|
-
* ...
|
|
1320
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-subGridConfigs)
|
|
1244
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-subGridConfigs)
|
|
1321
1245
|
*/
|
|
1322
1246
|
subGridConfigs ? : Record<string, SubGridConfig>
|
|
1323
1247
|
/**
|
|
@@ -1328,31 +1252,27 @@ defineProps<{
|
|
|
1328
1252
|
/**
|
|
1329
1253
|
* A [Mask](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Mask) config object, or a message to be shown when Crud Manager
|
|
1330
1254
|
* is persisting changes on the server. Set to `null` to disable default sync mask.
|
|
1331
|
-
* ...
|
|
1332
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-syncMask)
|
|
1255
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-syncMask)
|
|
1333
1256
|
*/
|
|
1334
1257
|
syncMask ? : string|MaskConfig|null
|
|
1335
1258
|
/**
|
|
1336
1259
|
* 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
|
|
1337
1260
|
* [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
|
|
1338
1261
|
* this widget:
|
|
1339
|
-
* ...
|
|
1340
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-tab)
|
|
1262
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-tab)
|
|
1341
1263
|
*/
|
|
1342
1264
|
tab ? : Boolean|TabConfig
|
|
1343
1265
|
/**
|
|
1344
1266
|
* When this container is used as a tab in a TabPanel, these items are added to the
|
|
1345
1267
|
* [TabBar](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/TabBar) when this container is the active tab.
|
|
1346
|
-
* ...
|
|
1347
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-tabBarItems)
|
|
1268
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-tabBarItems)
|
|
1348
1269
|
*/
|
|
1349
1270
|
tabBarItems ? : ToolbarItems[]|Widget[]
|
|
1350
1271
|
/**
|
|
1351
1272
|
* A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Toolbar),
|
|
1352
1273
|
* or array of config objects representing the child items of a Toolbar.
|
|
1353
1274
|
* This creates a toolbar docked to the top of the panel immediately below the header.
|
|
1354
|
-
* ...
|
|
1355
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-tbar)
|
|
1275
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-tbar)
|
|
1356
1276
|
*/
|
|
1357
1277
|
tbar ? : (SchedulerProContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
|
|
1358
1278
|
/**
|
|
@@ -1361,21 +1281,18 @@ defineProps<{
|
|
|
1361
1281
|
terminalCls ? : string
|
|
1362
1282
|
/**
|
|
1363
1283
|
* Delay in ms before hiding the terminals when the mouse leaves an event bar or terminal.
|
|
1364
|
-
* ...
|
|
1365
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-terminalHideDelay)
|
|
1284
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-terminalHideDelay)
|
|
1366
1285
|
*/
|
|
1367
1286
|
terminalHideDelay ? : number
|
|
1368
1287
|
/**
|
|
1369
1288
|
* Terminal offset from their initial position, in px. Positive values move terminals further away from the
|
|
1370
1289
|
* event bar, negative values inside the event bar.
|
|
1371
|
-
* ...
|
|
1372
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-terminalOffset)
|
|
1290
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-terminalOffset)
|
|
1373
1291
|
*/
|
|
1374
1292
|
terminalOffset ? : number
|
|
1375
1293
|
/**
|
|
1376
1294
|
* Delay in ms before showing the terminals when hovering over an event bar.
|
|
1377
|
-
* ...
|
|
1378
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-terminalShowDelay)
|
|
1295
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-terminalShowDelay)
|
|
1379
1296
|
*/
|
|
1380
1297
|
terminalShowDelay ? : number
|
|
1381
1298
|
/**
|
|
@@ -1385,14 +1302,12 @@ defineProps<{
|
|
|
1385
1302
|
terminalSides ? : string[]
|
|
1386
1303
|
/**
|
|
1387
1304
|
* Terminal diameter in px, overrides the default CSS value for it (which might depend on theme).
|
|
1388
|
-
* ...
|
|
1389
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-terminalSize)
|
|
1305
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-terminalSize)
|
|
1390
1306
|
*/
|
|
1391
1307
|
terminalSize ? : number|string
|
|
1392
1308
|
/**
|
|
1393
1309
|
* The width/height (depending on vertical / horizontal mode) of all the time columns.
|
|
1394
|
-
* ...
|
|
1395
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-tickSize)
|
|
1310
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-tickSize)
|
|
1396
1311
|
*/
|
|
1397
1312
|
tickSize ? : number
|
|
1398
1313
|
/**
|
|
@@ -1413,26 +1328,22 @@ defineProps<{
|
|
|
1413
1328
|
/**
|
|
1414
1329
|
* Gets/sets the current time resolution object, which contains a unit identifier and an increment count
|
|
1415
1330
|
* `{ unit, increment }`. This value means minimal task duration you can create using UI.
|
|
1416
|
-
* ...
|
|
1417
|
-
*
|
|
1331
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-timeResolution)
|
|
1332
|
+
* @property {number} increment The increment in the specified unit
|
|
1333
|
+
* @property {DurationUnit} unit The time resolution unit
|
|
1418
1334
|
*/
|
|
1419
|
-
timeResolution ? :
|
|
1420
|
-
increment?: number
|
|
1421
|
-
unit?: DurationUnit
|
|
1422
|
-
}|number
|
|
1335
|
+
timeResolution ? : object|number
|
|
1423
1336
|
/**
|
|
1424
1337
|
* A title to display in the header or owning TabPanel. Causes creation and docking of a header
|
|
1425
1338
|
* to the top if no header is configured.
|
|
1426
|
-
* ...
|
|
1427
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-title)
|
|
1339
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-title)
|
|
1428
1340
|
*/
|
|
1429
1341
|
title ? : string
|
|
1430
1342
|
/**
|
|
1431
1343
|
* 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
|
|
1432
1344
|
* property name is the reference by which an instantiated tool may be retrieved from the live
|
|
1433
1345
|
* `[tools](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/mixin/Toolable#property-tools)` property.
|
|
1434
|
-
* ...
|
|
1435
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-tools)
|
|
1346
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-tools)
|
|
1436
1347
|
*/
|
|
1437
1348
|
tools ? : Record<string, ToolConfig>|null
|
|
1438
1349
|
/**
|
|
@@ -1444,19 +1355,18 @@ defineProps<{
|
|
|
1444
1355
|
tooltipTemplate ? : (dependency: DependencyBaseModel) => string|DomConfig
|
|
1445
1356
|
/**
|
|
1446
1357
|
* Configure UI transitions for various actions in the grid.
|
|
1447
|
-
|
|
1448
|
-
|
|
1449
|
-
|
|
1450
|
-
|
|
1451
|
-
|
|
1452
|
-
|
|
1453
|
-
|
|
1454
|
-
|
|
1455
|
-
|
|
1456
|
-
|
|
1457
|
-
|
|
1458
|
-
|
|
1459
|
-
}
|
|
1358
|
+
* @property {boolean} insertRecord Transition record insertions
|
|
1359
|
+
* @property {boolean} removeRecord Transition record removals
|
|
1360
|
+
* @property {boolean} toggleColumn Transition column visibility changes
|
|
1361
|
+
* @property {boolean} expandCollapseColumn Transition parent/group column expand/collapse
|
|
1362
|
+
* @property {boolean} toggleRegion Transition region expand/collapse
|
|
1363
|
+
* @property {boolean} toggleTreeNode Transition tree node expand/collapse
|
|
1364
|
+
* @property {boolean} toggleGroup Transition group expand/collapse
|
|
1365
|
+
* @property {boolean} filterRemoval Transition row removals caused by filtering (under specific conditions)
|
|
1366
|
+
* @property {boolean} removeEvent Transition event removals
|
|
1367
|
+
* @property {boolean} changeEvent Transition event changes
|
|
1368
|
+
*/
|
|
1369
|
+
transition ? : object
|
|
1460
1370
|
/**
|
|
1461
1371
|
* Animation transition duration in milliseconds.
|
|
1462
1372
|
*/
|
|
@@ -1470,8 +1380,7 @@ defineProps<{
|
|
|
1470
1380
|
* Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
|
|
1471
1381
|
* as a space separated string, an array of strings, or as an object in which property names with truthy
|
|
1472
1382
|
* values are used as the class names.
|
|
1473
|
-
* ...
|
|
1474
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-ui)
|
|
1383
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-ui)
|
|
1475
1384
|
*/
|
|
1476
1385
|
ui ? : 'plain'|'toolbar'|string|object
|
|
1477
1386
|
/**
|
|
@@ -1485,35 +1394,30 @@ defineProps<{
|
|
|
1485
1394
|
* By default, the day of week and week of month of the event's start date are used to create
|
|
1486
1395
|
* helpful contextual recurrence types when editing a non-recurring event record and choosing
|
|
1487
1396
|
* an initial recurrence type.
|
|
1488
|
-
* ...
|
|
1489
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-useContextualRecurrenceRules)
|
|
1397
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-useContextualRecurrenceRules)
|
|
1490
1398
|
*/
|
|
1491
1399
|
useContextualRecurrenceRules ? : Boolean
|
|
1492
1400
|
/**
|
|
1493
1401
|
* By default, scheduler fade events in on load. Specify `false` to prevent this animation or specify one
|
|
1494
1402
|
* of the available animation types to use it (`true` equals `'fade-in'`):
|
|
1495
|
-
* ...
|
|
1496
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-useInitialAnimation)
|
|
1403
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-useInitialAnimation)
|
|
1497
1404
|
*/
|
|
1498
1405
|
useInitialAnimation ? : Boolean|'fade-in'|'slide-from-left'|'slide-from-top'|string
|
|
1499
1406
|
/**
|
|
1500
1407
|
* The time axis column config for vertical [mode](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/SchedulerBase#config-mode).
|
|
1501
|
-
* ...
|
|
1502
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-verticalTimeAxisColumn)
|
|
1408
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-verticalTimeAxisColumn)
|
|
1503
1409
|
*/
|
|
1504
1410
|
verticalTimeAxisColumn ? : VerticalTimeAxisColumnConfig
|
|
1505
1411
|
/**
|
|
1506
|
-
* A string key used to
|
|
1507
|
-
* managed by [PresetManager](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/preset/PresetManager). See [PresetManager](#Scheduler/preset/PresetManager)
|
|
1508
|
-
* Or a config object for a viewPreset.
|
|
1509
|
-
* ...
|
|
1510
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-viewPreset)
|
|
1412
|
+
* A string key used to look up a predefined [ViewPreset](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/preset/ViewPreset) (e.g. 'weekAndDay',
|
|
1413
|
+
* 'hourAndDay'), managed by [PresetManager](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/preset/PresetManager). See [PresetManager](#Scheduler/preset/PresetManager)
|
|
1414
|
+
* for more information. Or a config object for a viewPreset.
|
|
1415
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-viewPreset)
|
|
1511
1416
|
*/
|
|
1512
1417
|
viewPreset ? : string|ViewPresetConfig
|
|
1513
1418
|
/**
|
|
1514
1419
|
* A date to bring into view initially on the scrollable timeline.
|
|
1515
|
-
* ...
|
|
1516
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-visibleDate)
|
|
1420
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-visibleDate)
|
|
1517
1421
|
*/
|
|
1518
1422
|
visibleDate ? : Date|VisibleDate
|
|
1519
1423
|
/**
|
|
@@ -1541,15 +1445,19 @@ defineProps<{
|
|
|
1541
1445
|
/**
|
|
1542
1446
|
* An object with format `{ fromDay, toDay, fromHour, toHour }` that describes the working days and hours.
|
|
1543
1447
|
* This object will be used to populate TimeAxis [include](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/data/TimeAxis#config-include) property.
|
|
1544
|
-
* ...
|
|
1545
|
-
*
|
|
1448
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-workingTime)
|
|
1449
|
+
* @property {number} workingTime.fromDay Day index 0-6 (0 is Sunday)
|
|
1450
|
+
* @property {number} workingTime.toDay Day index 0-6 (0 is Sunday)
|
|
1451
|
+
* @property {number} workingTime.fromHour 0-23
|
|
1452
|
+
* @property {number} workingTime.toHour 0-23
|
|
1546
1453
|
*/
|
|
1547
|
-
workingTime ? : {
|
|
1548
|
-
|
|
1549
|
-
|
|
1550
|
-
|
|
1551
|
-
|
|
1552
|
-
|
|
1454
|
+
workingTime ? : { fromDay: number, toDay: number, fromHour: number, toHour: number }
|
|
1455
|
+
/**
|
|
1456
|
+
* Factor multiplied with wheel delta to calculate smooth zoom level changes when zooming with mouse wheel or
|
|
1457
|
+
* trackpad pinch gestures. A higher value means faster zooming.
|
|
1458
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#config-zoomFactor)
|
|
1459
|
+
*/
|
|
1460
|
+
zoomFactor ? : number
|
|
1553
1461
|
/**
|
|
1554
1462
|
* Whether the originally rendered timespan should be preserved while zooming. By default, it is set to `false`,
|
|
1555
1463
|
* meaning the timeline panel will adjust the currently rendered timespan to limit the amount of HTML content to
|
|
@@ -1559,11 +1467,11 @@ defineProps<{
|
|
|
1559
1467
|
*/
|
|
1560
1468
|
zoomKeepsOriginalTimespan ? : Boolean
|
|
1561
1469
|
/**
|
|
1562
|
-
* If true
|
|
1470
|
+
* If `true`, you can zoom in and out on the time axis using <kbd>CTRL</kbd> + mouse wheel.
|
|
1563
1471
|
*/
|
|
1564
1472
|
zoomOnMouseWheel ? : Boolean
|
|
1565
1473
|
/**
|
|
1566
|
-
*
|
|
1474
|
+
* If `true`, you can zoom to a time span by double-clicking a time axis cell.
|
|
1567
1475
|
*/
|
|
1568
1476
|
zoomOnTimeAxisDoubleClick ? : Boolean
|
|
1569
1477
|
|
|
@@ -1573,224 +1481,199 @@ defineProps<{
|
|
|
1573
1481
|
* to send messages to the agent and see the responses. Which allows the user to use natural language to interact with
|
|
1574
1482
|
* the Scheduler in different ways. For example, the user can ask the agent to filter the data, sort it, or select
|
|
1575
1483
|
* specific records. The agent can also perform data manipulation operations such as adding, updating, deleting records.
|
|
1576
|
-
* ...
|
|
1577
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/AI)
|
|
1484
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/AI)
|
|
1578
1485
|
*/
|
|
1579
1486
|
aiFeature ? : object|Boolean|string|AI|AIConfig
|
|
1580
1487
|
/**
|
|
1581
1488
|
* AI-powered filter feature for Grid. Allows users to type natural language queries to filter grid data.
|
|
1582
|
-
* ...
|
|
1583
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ai/AIFilter)
|
|
1489
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ai/AIFilter)
|
|
1584
1490
|
*/
|
|
1585
1491
|
aiFilterFeature ? : object|Boolean|string|AIFilter|AIFilterConfig
|
|
1586
1492
|
/**
|
|
1587
1493
|
* Allows using `[Ctrl/CMD + C]`, `[Ctrl/CMD + X]` and `[Ctrl/CMD + V]` to cut, copy and paste cell or cell ranges. Also
|
|
1588
1494
|
* makes cut, copy and paste actions available via the cell context menu.
|
|
1589
|
-
* ...
|
|
1590
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellCopyPaste)
|
|
1495
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellCopyPaste)
|
|
1591
1496
|
*/
|
|
1592
1497
|
cellCopyPasteFeature ? : object|Boolean|string|CellCopyPaste|CellCopyPasteConfig
|
|
1593
1498
|
/**
|
|
1594
1499
|
* Adding this feature to the grid and other Bryntum products which are based on the Grid (i.e. Scheduler, SchedulerPro, and Gantt)
|
|
1595
1500
|
* enables cell editing. Any subclass of [Field](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Field) can be used
|
|
1596
1501
|
* as editor for the [Column](https://bryntum.com/products/schedulerpro/docs/api/Grid/column/Column). The most popular are:
|
|
1597
|
-
* ...
|
|
1598
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellEdit)
|
|
1502
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellEdit)
|
|
1599
1503
|
*/
|
|
1600
1504
|
cellEditFeature ? : object|Boolean|string|GridCellEdit|GridCellEditConfig
|
|
1601
1505
|
/**
|
|
1602
1506
|
* Right click to display context menu for cells. To invoke the cell menu in a keyboard-accessible manner, use the
|
|
1603
1507
|
* <kbd>Space</kbd> key when the cell is focused.
|
|
1604
|
-
* ...
|
|
1605
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellMenu)
|
|
1508
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellMenu)
|
|
1606
1509
|
*/
|
|
1607
1510
|
cellMenuFeature ? : object|Boolean|string|CellMenu|CellMenuConfig
|
|
1608
1511
|
/**
|
|
1609
1512
|
* Displays a tooltip when hovering cells.
|
|
1610
|
-
* ...
|
|
1611
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellTooltip)
|
|
1513
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellTooltip)
|
|
1612
1514
|
*/
|
|
1613
1515
|
cellTooltipFeature ? : object|Boolean|string|CellTooltip|CellTooltipConfig
|
|
1614
1516
|
/**
|
|
1615
1517
|
* 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
|
|
1616
1518
|
* and updated in realtime as data changes. Supports many common chart types with extensive styling and customization
|
|
1617
1519
|
* options.
|
|
1618
|
-
* ...
|
|
1619
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Charts)
|
|
1520
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Charts)
|
|
1620
1521
|
*/
|
|
1621
1522
|
chartsFeature ? : object|Boolean|string|Charts|ChartsConfig
|
|
1622
1523
|
/**
|
|
1623
|
-
* Enables the [autoWidth](https://bryntum.com/products/schedulerpro/docs/api/Grid/column/Column#config-autoWidth) config for a grid's columns.
|
|
1624
|
-
*
|
|
1625
|
-
*
|
|
1524
|
+
* Enables the [autoWidth](https://bryntum.com/products/schedulerpro/docs/api/Grid/column/Column#config-autoWidth) config for a grid's columns. When a column
|
|
1525
|
+
* has `autoWidth` set, this feature measures the rendered content of all visible cells in that column
|
|
1526
|
+
* and adjusts the column width to fit. The measurement is triggered automatically when data changes
|
|
1527
|
+
* or rows are rendered.
|
|
1528
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnAutoWidth)
|
|
1626
1529
|
*/
|
|
1627
1530
|
columnAutoWidthFeature ? : object|Boolean|string|ColumnAutoWidth|ColumnAutoWidthConfig
|
|
1628
1531
|
/**
|
|
1629
1532
|
* Displays a toolbar while dragging column headers. Drop on a button in the toolbar to activate a certain function,
|
|
1630
1533
|
* for example to group by that column. This feature simplifies certain operations on touch devices.
|
|
1631
|
-
* ...
|
|
1632
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnDragToolbar)
|
|
1534
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnDragToolbar)
|
|
1633
1535
|
*/
|
|
1634
1536
|
columnDragToolbarFeature ? : object|Boolean|string|ColumnDragToolbar|ColumnDragToolbarConfig
|
|
1635
1537
|
/**
|
|
1636
1538
|
* Displays column lines for ticks, with a different styling for major ticks (by default they are darker). If this
|
|
1637
1539
|
* feature is disabled, no lines are shown. If it's enabled, line are shown for the tick level which is set in current
|
|
1638
1540
|
* ViewPreset. Please see [columnLinesFor](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/preset/ViewPreset#field-columnLinesFor) config for details.
|
|
1639
|
-
* ...
|
|
1640
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ColumnLines)
|
|
1541
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ColumnLines)
|
|
1641
1542
|
*/
|
|
1642
1543
|
columnLinesFeature ? : object|Boolean|string|ColumnLines|ColumnLinesConfig
|
|
1643
1544
|
/**
|
|
1644
1545
|
* Displays a column picker (to show/hide columns) in the header context menu. Columns can be displayed in sub menus
|
|
1645
1546
|
* by region or tag. Grouped headers are displayed as menu hierarchies.
|
|
1646
|
-
* ...
|
|
1647
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnPicker)
|
|
1547
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnPicker)
|
|
1648
1548
|
*/
|
|
1649
1549
|
columnPickerFeature ? : object|Boolean|string|ColumnPicker|ColumnPickerConfig
|
|
1650
1550
|
/**
|
|
1651
1551
|
* Allows user to rename columns by either right-clicking column header or using keyboard shortcuts when column header
|
|
1652
1552
|
* is focused.
|
|
1653
|
-
* ...
|
|
1654
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnRename)
|
|
1553
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnRename)
|
|
1655
1554
|
*/
|
|
1656
1555
|
columnRenameFeature ? : object|Boolean|string|ColumnRename|ColumnRenameConfig
|
|
1657
1556
|
/**
|
|
1658
|
-
* Allows user to reorder columns by dragging headers.
|
|
1659
|
-
*
|
|
1660
|
-
*
|
|
1661
|
-
* [
|
|
1557
|
+
* Allows user to reorder columns by dragging headers. Click and drag a column header to move it to a new position.
|
|
1558
|
+
* Visual feedback shows the drop target while dragging. To get notified about column reorder, listen to the
|
|
1559
|
+
* `change` event on the [columns](https://bryntum.com/products/schedulerpro/docs/api/Grid/data/ColumnStore) store.
|
|
1560
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnReorder)
|
|
1662
1561
|
*/
|
|
1663
1562
|
columnReorderFeature ? : object|Boolean|string|ColumnReorder|ColumnReorderConfig
|
|
1664
1563
|
/**
|
|
1665
|
-
* Enables user to resize columns by dragging a handle on the right hand side of the header.
|
|
1666
|
-
*
|
|
1667
|
-
*
|
|
1668
|
-
* [
|
|
1564
|
+
* Enables user to resize columns by dragging a handle on the right hand side of the header. A drag handle
|
|
1565
|
+
* appears when hovering near the right edge of a column header. Dragging it adjusts the column width, respecting
|
|
1566
|
+
* any [minWidth](https://bryntum.com/products/schedulerpro/docs/api/Grid/column/Column#config-minWidth) or [maxWidth](#Grid/column/Column#config-maxWidth) constraints.
|
|
1567
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnResize)
|
|
1669
1568
|
*/
|
|
1670
1569
|
columnResizeFeature ? : object|Boolean|string|ColumnResize|ColumnResizeConfig
|
|
1671
1570
|
/**
|
|
1672
1571
|
* Feature that draws dependencies between events. Uses a [DependencyStore](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/data/DependencyStore) to determine which
|
|
1673
1572
|
* dependencies to draw, if none is defined one will be created automatically. Dependencies can also be specified as
|
|
1674
1573
|
* `scheduler.dependencies`, see example below:
|
|
1675
|
-
* ...
|
|
1676
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/Dependencies)
|
|
1574
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/Dependencies)
|
|
1677
1575
|
*/
|
|
1678
1576
|
dependenciesFeature ? : object|Boolean|string|SchedulerDependencies|SchedulerDependenciesConfig
|
|
1679
1577
|
/**
|
|
1680
1578
|
* Feature that displays a popup containing fields for editing a dependency. Requires the
|
|
1681
1579
|
* [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
|
|
1682
1580
|
* show the editor.
|
|
1683
|
-
* ...
|
|
1684
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/DependencyEdit)
|
|
1581
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/DependencyEdit)
|
|
1685
1582
|
*/
|
|
1686
1583
|
dependencyEditFeature ? : object|Boolean|string|SchedulerDependencyEdit|SchedulerDependencyEditConfig
|
|
1687
1584
|
/**
|
|
1688
1585
|
* Displays a context menu when right-clicking dependency lines. Items are populated by other features and/or
|
|
1689
1586
|
* application code.
|
|
1690
|
-
* ...
|
|
1691
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/DependencyMenu)
|
|
1587
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/DependencyMenu)
|
|
1692
1588
|
*/
|
|
1693
1589
|
dependencyMenuFeature ? : object|Boolean|string|DependencyMenu|DependencyMenuConfig
|
|
1694
1590
|
/**
|
|
1695
1591
|
* Allow using <kbd>Ctrl</kbd>/<kbd>Cmd</kbd>+<kbd>C</kbd>, <kbd>Ctrl</kbd>/<kbd>Cmd</kbd>+<kbd>X</kbd> and
|
|
1696
1592
|
* <kbd>Ctrl</kbd>/<kbd>Cmd</kbd>+<kbd>V</kbd> to copy/cut and paste events.
|
|
1697
|
-
* ...
|
|
1698
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventCopyPaste)
|
|
1593
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventCopyPaste)
|
|
1699
1594
|
*/
|
|
1700
1595
|
eventCopyPasteFeature ? : object|Boolean|string|EventCopyPaste|EventCopyPasteConfig
|
|
1701
1596
|
/**
|
|
1702
1597
|
* Allows user to drag and drop events within the scheduler, to change `startDate` or resource assignment.
|
|
1703
|
-
* ...
|
|
1704
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventDrag)
|
|
1598
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventDrag)
|
|
1705
1599
|
*/
|
|
1706
|
-
eventDragFeature ? : object|Boolean|string|
|
|
1600
|
+
eventDragFeature ? : object|Boolean|string|SchedulerEventDrag|SchedulerEventDragConfig
|
|
1707
1601
|
/**
|
|
1708
1602
|
* Feature that allows the user to create new events by dragging in empty parts of the scheduler rows.
|
|
1709
|
-
* ...
|
|
1710
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventDragCreate)
|
|
1603
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventDragCreate)
|
|
1711
1604
|
*/
|
|
1712
1605
|
eventDragCreateFeature ? : object|Boolean|string|EventDragCreate|EventDragCreateConfig
|
|
1713
1606
|
/**
|
|
1714
1607
|
* Enables users to click and drag to select events (or assignments in multi assignment mode) inside the Scheduler's
|
|
1715
1608
|
* timeline. Press <kbd>CTRL</kbd>/<kbd>CMD</kbd> to extend an existing selection.
|
|
1716
|
-
* ...
|
|
1717
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventDragSelect)
|
|
1609
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventDragSelect)
|
|
1718
1610
|
*/
|
|
1719
1611
|
eventDragSelectFeature ? : object|Boolean|string|EventDragSelect|EventDragSelectConfig
|
|
1720
1612
|
/**
|
|
1721
1613
|
* Feature that displays a popup containing widgets for editing event data.
|
|
1722
|
-
* ...
|
|
1723
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventEdit)
|
|
1614
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventEdit)
|
|
1724
1615
|
*/
|
|
1725
1616
|
eventEditFeature ? : object|Boolean|string|EventEdit|EventEditConfig
|
|
1726
1617
|
/**
|
|
1727
|
-
* Adds event filter menu items to the timeline header context menu.
|
|
1728
|
-
*
|
|
1729
|
-
* [
|
|
1618
|
+
* Adds event filter menu items to the timeline header context menu. Users can type filter text to show
|
|
1619
|
+
* only events whose name matches the query.
|
|
1620
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventFilter)
|
|
1730
1621
|
*/
|
|
1731
1622
|
eventFilterFeature ? : object|Boolean|string|EventFilter|EventFilterConfig
|
|
1732
1623
|
/**
|
|
1733
1624
|
* Displays a context menu for events. Items are populated by other features and/or application code.
|
|
1734
|
-
* ...
|
|
1735
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventMenu)
|
|
1625
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventMenu)
|
|
1736
1626
|
*/
|
|
1737
1627
|
eventMenuFeature ? : object|Boolean|string|EventMenu|EventMenuConfig
|
|
1738
1628
|
/**
|
|
1739
1629
|
* Feature that allows rendering non-working time ranges into event bars (weekends for Scheduler, effective calendar for
|
|
1740
1630
|
* SchedulerPro):
|
|
1741
|
-
* ...
|
|
1742
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventNonWorkingTime)
|
|
1631
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventNonWorkingTime)
|
|
1743
1632
|
*/
|
|
1744
1633
|
eventNonWorkingTimeFeature ? : object|Boolean|string|EventNonWorkingTime|EventNonWorkingTimeConfig
|
|
1745
1634
|
/**
|
|
1746
1635
|
* Feature that allows resizing an event by dragging its end.
|
|
1747
|
-
* ...
|
|
1748
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventResize)
|
|
1636
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventResize)
|
|
1749
1637
|
*/
|
|
1750
1638
|
eventResizeFeature ? : object|Boolean|string|SchedulerEventResize|SchedulerEventResizeConfig
|
|
1751
1639
|
/**
|
|
1752
1640
|
* 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).
|
|
1753
1641
|
* Config options are also applied to the tooltip shown, see [Tooltip](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Tooltip) for available options.
|
|
1754
|
-
* ...
|
|
1755
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventTooltip)
|
|
1642
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventTooltip)
|
|
1756
1643
|
*/
|
|
1757
1644
|
eventTooltipFeature ? : object|Boolean|string|EventTooltip|EventTooltipConfig
|
|
1758
1645
|
/**
|
|
1759
1646
|
* A feature that allows exporting Scheduler data to Excel or CSV without involving the server. It uses
|
|
1760
1647
|
* [TableExporter](https://bryntum.com/products/schedulerpro/docs/api/Grid/util/TableExporter) class as data provider, 3rd party provider to generate XLS files, and
|
|
1761
1648
|
* [Microsoft XML specification](https://msdn.microsoft.com/en-us/library/office/documentformat.openxml.spreadsheet.aspx).
|
|
1762
|
-
* ...
|
|
1763
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/experimental/ExcelExporter)
|
|
1649
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/experimental/ExcelExporter)
|
|
1764
1650
|
*/
|
|
1765
1651
|
excelExporterFeature ? : object|Boolean|string|ExcelExporter|ExcelExporterConfig
|
|
1766
1652
|
/**
|
|
1767
|
-
* An experimental feature that lets users drop files on a Widget. The widget fires
|
|
1768
|
-
* In the event, you get access to the raw
|
|
1769
|
-
*
|
|
1770
|
-
* [
|
|
1653
|
+
* An experimental feature that lets users drop files on a Widget. The widget fires a
|
|
1654
|
+
* [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
|
|
1655
|
+
* files as strings, that were parsed by calling `readAsBinaryString`.
|
|
1656
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/experimental/FileDrop)
|
|
1771
1657
|
*/
|
|
1772
1658
|
fileDropFeature ? : object|Boolean|string|FileDrop|FileDropConfig
|
|
1773
1659
|
/**
|
|
1774
1660
|
* This feature adds a fill handle to a Grid range selection, which when dragged, fills the cells being dragged over
|
|
1775
1661
|
* with values based on the values in the original selected range. This is similar to functionality normally seen in
|
|
1776
1662
|
* various spreadsheet applications.
|
|
1777
|
-
* ...
|
|
1778
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/FillHandle)
|
|
1663
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/FillHandle)
|
|
1779
1664
|
*/
|
|
1780
1665
|
fillHandleFeature ? : object|Boolean|string|FillHandle|FillHandleConfig
|
|
1781
1666
|
/**
|
|
1782
1667
|
* Feature that allows filtering of the grid by settings filters on columns. The actual filtering is done by the store.
|
|
1783
1668
|
* For info on programmatically handling filters, see [StoreFilter](https://bryntum.com/products/schedulerpro/docs/api/Core/data/mixin/StoreFilter).
|
|
1784
|
-
* ...
|
|
1785
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Filter)
|
|
1669
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Filter)
|
|
1786
1670
|
*/
|
|
1787
1671
|
filterFeature ? : object|Boolean|string|Filter|FilterConfig
|
|
1788
1672
|
/**
|
|
1789
1673
|
* Feature that allows filtering of the grid by entering filters on column headers.
|
|
1790
1674
|
* The actual filtering is done by the store.
|
|
1791
1675
|
* For info on programmatically handling filters, see [StoreFilter](https://bryntum.com/products/schedulerpro/docs/api/Core/data/mixin/StoreFilter).
|
|
1792
|
-
* ...
|
|
1793
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/FilterBar)
|
|
1676
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/FilterBar)
|
|
1794
1677
|
*/
|
|
1795
1678
|
filterBarFeature ? : object|Boolean|string|FilterBar|FilterBarConfig
|
|
1796
1679
|
/**
|
|
@@ -1798,142 +1681,122 @@ defineProps<{
|
|
|
1798
1681
|
* <kbd>Shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
|
|
1799
1682
|
* one anywhere on grid). Use <kbd>Shift</kbd> + <kbd>Alt</kbd> + click, or the context menu, to remove a column
|
|
1800
1683
|
* grouper.
|
|
1801
|
-
* ...
|
|
1802
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Group)
|
|
1684
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Group)
|
|
1803
1685
|
*/
|
|
1804
1686
|
groupFeature ? : object|Boolean|string|Group|GroupConfig
|
|
1805
1687
|
/**
|
|
1806
1688
|
* A special version of the Grid GroupSummary feature that enables summaries within scheduler. To use a single summary
|
|
1807
1689
|
* 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).
|
|
1808
|
-
* ...
|
|
1809
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/GroupSummary)
|
|
1690
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/GroupSummary)
|
|
1810
1691
|
*/
|
|
1811
1692
|
groupSummaryFeature ? : object|Boolean|string|GroupSummary|GroupSummaryConfig
|
|
1812
1693
|
/**
|
|
1813
1694
|
* Right click column header or focus it and press SPACE key to show the context menu for headers.
|
|
1814
|
-
* ...
|
|
1815
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/HeaderMenu)
|
|
1695
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/HeaderMenu)
|
|
1816
1696
|
*/
|
|
1817
1697
|
headerMenuFeature ? : object|Boolean|string|HeaderMenu|HeaderMenuConfig
|
|
1818
1698
|
/**
|
|
1819
1699
|
* Enables users to click and drag to zoom to a date range in Scheduler's header time axis. Only supported in horizontal
|
|
1820
1700
|
* mode.
|
|
1821
|
-
* ...
|
|
1822
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/HeaderZoom)
|
|
1701
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/HeaderZoom)
|
|
1823
1702
|
*/
|
|
1824
1703
|
headerZoomFeature ? : object|Boolean|string|HeaderZoom|HeaderZoomConfig
|
|
1825
1704
|
/**
|
|
1826
1705
|
* 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
|
|
1827
1706
|
* [left](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/Labels#config-left).
|
|
1828
|
-
* ...
|
|
1829
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/Labels)
|
|
1707
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/Labels)
|
|
1830
1708
|
*/
|
|
1831
1709
|
labelsFeature ? : object|Boolean|string|Labels|LabelsConfig
|
|
1832
1710
|
/**
|
|
1833
1711
|
* This feature allows resources which satisfy a certain condition to be locked at the top of the scheduler.
|
|
1834
|
-
* ...
|
|
1835
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/LockRows)
|
|
1712
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/LockRows)
|
|
1836
1713
|
*/
|
|
1837
1714
|
lockRowsFeature ? : object|Boolean|string|LockRows|LockRowsConfig
|
|
1838
1715
|
/**
|
|
1839
1716
|
* 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
|
|
1840
1717
|
* configured to [mergeCells](https://bryntum.com/products/schedulerpro/docs/api/Grid/column/Column#config-mergeCells).
|
|
1841
|
-
* ...
|
|
1842
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/MergeCells)
|
|
1718
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/MergeCells)
|
|
1843
1719
|
*/
|
|
1844
1720
|
mergeCellsFeature ? : object|Boolean|string|MergeCells|MergeCellsConfig
|
|
1845
1721
|
/**
|
|
1846
1722
|
* Feature that allows styling of weekends (and other non-working time) by adding timeRanges for those days.
|
|
1847
|
-
* ...
|
|
1848
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/NonWorkingTime)
|
|
1723
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/NonWorkingTime)
|
|
1849
1724
|
*/
|
|
1850
1725
|
nonWorkingTimeFeature ? : object|Boolean|string|NonWorkingTime|NonWorkingTimeConfig
|
|
1851
1726
|
/**
|
|
1852
1727
|
* Makes the scheduler's timeline pannable by dragging with the mouse. Try it out in the demo below.
|
|
1853
|
-
* ...
|
|
1854
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/Pan)
|
|
1728
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/Pan)
|
|
1855
1729
|
*/
|
|
1856
1730
|
panFeature ? : object|Boolean|string|Pan|PanConfig
|
|
1857
1731
|
/**
|
|
1858
1732
|
* Generates PDF/PNG files from the Scheduler component.
|
|
1859
|
-
* ...
|
|
1860
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/export/PdfExport)
|
|
1733
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/export/PdfExport)
|
|
1861
1734
|
*/
|
|
1862
1735
|
pdfExportFeature ? : object|Boolean|string|PdfExport|PdfExportConfig
|
|
1863
1736
|
/**
|
|
1864
1737
|
* Allows pinning columns to the start or end region of the grid without any additional subGrid configurations.
|
|
1865
1738
|
* When pinning to a region that does not yet exist, the feature creates the required subGrid on the fly.
|
|
1866
|
-
* ...
|
|
1867
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/PinColumns)
|
|
1739
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/PinColumns)
|
|
1868
1740
|
*/
|
|
1869
1741
|
pinColumnsFeature ? : object|Boolean|string|PinColumns|PinColumnsConfig
|
|
1870
1742
|
/**
|
|
1871
1743
|
* Allows printing Scheduler contents using browser print dialog.
|
|
1872
|
-
* ...
|
|
1873
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/export/Print)
|
|
1744
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/export/Print)
|
|
1874
1745
|
*/
|
|
1875
1746
|
printFeature ? : object|Boolean|string|Print|PrintConfig
|
|
1876
1747
|
/**
|
|
1877
1748
|
* Feature that allows the user to search in a column by focusing a cell and typing. Navigate between hits using the
|
|
1878
|
-
* keyboard,
|
|
1879
|
-
*
|
|
1880
|
-
* [
|
|
1749
|
+
* keyboard, <kbd>f3</kbd> or <kbd>ctrl</kbd>/<kbd>cmd</kbd> + <kbd>g</kbd> moves to next, also pressing
|
|
1750
|
+
* <kbd>shift</kbd> moves to previous.
|
|
1751
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/QuickFind)
|
|
1881
1752
|
*/
|
|
1882
1753
|
quickFindFeature ? : object|Boolean|string|QuickFind|QuickFindConfig
|
|
1883
1754
|
/**
|
|
1884
1755
|
* Makes the splitter between grid [sections](https://bryntum.com/products/schedulerpro/docs/api/Grid/view/SubGrid) draggable, to let users resize, and
|
|
1885
1756
|
* collapse/expand the sections.
|
|
1886
|
-
* ...
|
|
1887
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RegionResize)
|
|
1757
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RegionResize)
|
|
1888
1758
|
*/
|
|
1889
1759
|
regionResizeFeature ? : object|Boolean|string|RegionResize|RegionResizeConfig
|
|
1890
1760
|
/**
|
|
1891
1761
|
* Allows user to reorder resource columns in vertical mode by dragging them. The feature fires various events
|
|
1892
1762
|
* during the drag operation (see events below). To get notified about the actual resource reorder, you can also
|
|
1893
1763
|
* listen to the `change` event on the scheduler [ResourceStore](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/data/ResourceStore).
|
|
1894
|
-
* ...
|
|
1895
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ResourceColumnReorder)
|
|
1764
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ResourceColumnReorder)
|
|
1896
1765
|
*/
|
|
1897
1766
|
resourceColumnReorderFeature ? : object|Boolean|string|ResourceColumnReorder|ResourceColumnReorderConfig
|
|
1898
1767
|
/**
|
|
1899
1768
|
* Applicable only for Scheduler in `vertical` mode. Right click resource header cells to display a context menu.
|
|
1900
|
-
* ...
|
|
1901
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ResourceMenu)
|
|
1769
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ResourceMenu)
|
|
1902
1770
|
*/
|
|
1903
1771
|
resourceMenuFeature ? : object|Boolean|string|ResourceMenu|ResourceMenuConfig
|
|
1904
1772
|
/**
|
|
1905
1773
|
* Feature that draws resource time ranges, shaded areas displayed behind events. These zones are similar to events in
|
|
1906
1774
|
* that they have a start and end date but different in that they do not take part in the event layout, and they always
|
|
1907
1775
|
* occupy full row height.
|
|
1908
|
-
* ...
|
|
1909
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ResourceTimeRanges)
|
|
1776
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ResourceTimeRanges)
|
|
1910
1777
|
*/
|
|
1911
1778
|
resourceTimeRangesFeature ? : object|Boolean|string|ResourceTimeRanges|ResourceTimeRangesConfig
|
|
1912
1779
|
/**
|
|
1913
1780
|
* Allow using [Ctrl/CMD + C/X] and [Ctrl/CMD + V] to copy/cut-and-paste rows. Also makes cut, copy and paste actions
|
|
1914
1781
|
* available via the cell context menu.
|
|
1915
|
-
* ...
|
|
1916
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RowCopyPaste)
|
|
1782
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RowCopyPaste)
|
|
1917
1783
|
*/
|
|
1918
1784
|
rowCopyPasteFeature ? : object|Boolean|string|RowCopyPaste|RowCopyPasteConfig
|
|
1919
1785
|
/**
|
|
1920
1786
|
* This feature allows editing of entire rows in a grid in a docked panel which by default slides out from the right.
|
|
1921
|
-
* ...
|
|
1922
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RowEdit)
|
|
1787
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RowEdit)
|
|
1923
1788
|
*/
|
|
1924
1789
|
rowEditFeature ? : object|Boolean|string|RowEdit|RowEditConfig
|
|
1925
1790
|
/**
|
|
1926
1791
|
* Enables expanding of Grid rows by either row click or double click, or by adding a separate Grid column which renders
|
|
1927
1792
|
* a button that expands or collapses the row.
|
|
1928
|
-
* ...
|
|
1929
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RowExpander)
|
|
1793
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RowExpander)
|
|
1930
1794
|
*/
|
|
1931
1795
|
rowExpanderFeature ? : object|Boolean|string|RowExpander|RowExpanderConfig
|
|
1932
1796
|
/**
|
|
1933
1797
|
* This feature implements support for project transactions and used by default in Gantt. For general RowReorder feature
|
|
1934
1798
|
* documentation see [RowReorder](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RowReorder).
|
|
1935
|
-
* ...
|
|
1936
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/RowReorder)
|
|
1799
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/RowReorder)
|
|
1937
1800
|
*/
|
|
1938
1801
|
rowReorderFeature ? : object|Boolean|string|RowReorder|RowReorderConfig
|
|
1939
1802
|
/**
|
|
@@ -1941,94 +1804,83 @@ defineProps<{
|
|
|
1941
1804
|
* 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
|
|
1942
1805
|
* row will be switched to `pack` as a result (only applies when `stack` is used by default).
|
|
1943
1806
|
* `barMargin` and `resourceMargin` will also be shrunk as you reduce the height of a row.
|
|
1944
|
-
* ...
|
|
1945
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/RowResize)
|
|
1807
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/RowResize)
|
|
1946
1808
|
*/
|
|
1947
1809
|
rowResizeFeature ? : object|Boolean|string|RowResize|RowResizeConfig
|
|
1948
1810
|
/**
|
|
1949
1811
|
* 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).
|
|
1950
|
-
* ...
|
|
1951
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ScheduleContext)
|
|
1812
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ScheduleContext)
|
|
1952
1813
|
*/
|
|
1953
1814
|
scheduleContextFeature ? : object|Boolean|string|ScheduleContext|ScheduleContextConfig
|
|
1954
1815
|
/**
|
|
1955
1816
|
* Displays a context menu for empty parts of the schedule. Items are populated in the first place
|
|
1956
1817
|
* by configurations of this Feature, then by other features and/or application code.
|
|
1957
|
-
* ...
|
|
1958
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ScheduleMenu)
|
|
1818
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ScheduleMenu)
|
|
1959
1819
|
*/
|
|
1960
1820
|
scheduleMenuFeature ? : object|Boolean|string|ScheduleMenu|ScheduleMenuConfig
|
|
1961
1821
|
/**
|
|
1962
1822
|
* Feature that displays a tooltip containing the time at the mouse position when hovering empty parts of the schedule.
|
|
1963
|
-
* ...
|
|
1964
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ScheduleTooltip)
|
|
1823
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ScheduleTooltip)
|
|
1965
1824
|
*/
|
|
1966
1825
|
scheduleTooltipFeature ? : object|Boolean|string|ScheduleTooltip|ScheduleTooltipConfig
|
|
1967
1826
|
/**
|
|
1968
1827
|
* This feature injects buttons to the beginning and end of each row that will scroll to the next or previous event
|
|
1969
1828
|
* outside the current view. It can optionally show a label along with the button, using the
|
|
1970
1829
|
* [labelRenderer](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ScrollButtons#config-labelRenderer). Only supported in horizontal [mode](#Scheduler/view/SchedulerBase#config-mode)
|
|
1971
|
-
* ...
|
|
1972
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ScrollButtons)
|
|
1830
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ScrollButtons)
|
|
1973
1831
|
*/
|
|
1974
1832
|
scrollButtonsFeature ? : object|Boolean|string|ScrollButtons|ScrollButtonsConfig
|
|
1975
1833
|
/**
|
|
1976
1834
|
* <div class="external-example vertical" data-file="Grid/feature/Search.js"></div>
|
|
1977
|
-
* ...
|
|
1978
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Search)
|
|
1835
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Search)
|
|
1979
1836
|
*/
|
|
1980
1837
|
searchFeature ? : object|Boolean|string|Search|SearchConfig
|
|
1981
1838
|
/**
|
|
1982
1839
|
* Feature that displays a text field to edit the event name.
|
|
1983
|
-
* ...
|
|
1984
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/SimpleEventEdit)
|
|
1840
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/SimpleEventEdit)
|
|
1985
1841
|
*/
|
|
1986
1842
|
simpleEventEditFeature ? : object|Boolean|string|SimpleEventEdit|SimpleEventEditConfig
|
|
1987
1843
|
/**
|
|
1988
1844
|
* Allows sorting of grid by clicking (or tapping) headers, also displays which columns grid is sorted by (numbered if
|
|
1989
1845
|
* using multisort). Use modifier keys for multisorting: [Ctrl/CMD + click] to add sorter, [Ctrl/CMD + Alt + click] to remove sorter.
|
|
1990
1846
|
* The actual sorting is done by the store, see [Store.sort()](https://bryntum.com/products/schedulerpro/docs/api/Core/data/mixin/StoreSort#function-sort).
|
|
1991
|
-
* ...
|
|
1992
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Sort)
|
|
1847
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Sort)
|
|
1993
1848
|
*/
|
|
1994
1849
|
sortFeature ? : object|Boolean|string|Sort|SortConfig
|
|
1995
1850
|
/**
|
|
1996
1851
|
* This feature allows splitting the Scheduler into multiple views, either by using the cell context menu, or
|
|
1997
1852
|
* programmatically by calling [split()](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/Split#function-split).
|
|
1998
|
-
* ...
|
|
1999
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/Split)
|
|
1853
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/Split)
|
|
2000
1854
|
*/
|
|
2001
1855
|
splitFeature ? : object|Boolean|string|Split|SplitConfig
|
|
2002
1856
|
/**
|
|
2003
|
-
* A feature which pins
|
|
2004
|
-
*
|
|
2005
|
-
*
|
|
2006
|
-
* [
|
|
1857
|
+
* A feature which pins cell content to the top of the grid while the row scrolls off the top but is still visible. Very
|
|
1858
|
+
* similar to native `position: sticky`, which because of Grid's multiple-region setup unfortunately cannot be used to
|
|
1859
|
+
* achieve the same effect.
|
|
1860
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/StickyCells)
|
|
2007
1861
|
*/
|
|
2008
1862
|
stickyCellsFeature ? : object|Boolean|string|StickyCells|StickyCellsConfig
|
|
2009
1863
|
/**
|
|
2010
1864
|
* This feature applies native `position: sticky` to event contents in horizontal mode, keeping the contents in view as
|
|
2011
1865
|
* long as possible on scroll. For vertical mode it uses a programmatic solution to achieve the same result.
|
|
2012
|
-
* ...
|
|
2013
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/StickyEvents)
|
|
1866
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/StickyEvents)
|
|
2014
1867
|
*/
|
|
2015
1868
|
stickyEventsFeature ? : object|Boolean|string|StickyEvents|StickyEventsConfig
|
|
2016
1869
|
/**
|
|
2017
1870
|
* Stripes rows by adding alternating CSS classes to all row elements (`b-even` and `b-odd`).
|
|
2018
|
-
*
|
|
2019
|
-
*
|
|
1871
|
+
* This improves visual readability in data-heavy grids by giving adjacent rows different background colors.
|
|
1872
|
+
* Style the striped rows using the `.b-even` and `.b-odd` CSS classes.
|
|
1873
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Stripe)
|
|
2020
1874
|
*/
|
|
2021
1875
|
stripeFeature ? : object|Boolean|string|Stripe|StripeConfig
|
|
2022
1876
|
/**
|
|
2023
1877
|
* A special version of the Grid Summary feature. This feature displays a summary row in the grid footer.
|
|
2024
|
-
* ...
|
|
2025
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/Summary)
|
|
1878
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/Summary)
|
|
2026
1879
|
*/
|
|
2027
1880
|
summaryFeature ? : object|Boolean|string|Summary|SummaryConfig
|
|
2028
1881
|
/**
|
|
2029
1882
|
* Adds scheduler specific menu items to the timeline header context menu.
|
|
2030
|
-
* ...
|
|
2031
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/TimeAxisHeaderMenu)
|
|
1883
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/TimeAxisHeaderMenu)
|
|
2032
1884
|
*/
|
|
2033
1885
|
timeAxisHeaderMenuFeature ? : object|Boolean|string|TimeAxisHeaderMenu|TimeAxisHeaderMenuConfig
|
|
2034
1886
|
/**
|
|
@@ -2036,15 +1888,13 @@ defineProps<{
|
|
|
2036
1888
|
* or some important point in time (a `line`, i.e. a range with 0 duration). This feature can also show a current time
|
|
2037
1889
|
* 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
|
|
2038
1890
|
* [cls](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/model/TimeSpan#field-cls) field of the `TimeSpan` class.
|
|
2039
|
-
* ...
|
|
2040
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/TimeRanges)
|
|
1891
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/TimeRanges)
|
|
2041
1892
|
*/
|
|
2042
1893
|
timeRangesFeature ? : object|Boolean|string|TimeRanges|TimeRangesConfig
|
|
2043
1894
|
/**
|
|
2044
1895
|
* Feature that allows selection of a time span in the time axis header. When a time span is selected in the header,
|
|
2045
1896
|
* a [timeSelectionChange](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/TimeSelection#event-timeSelectionChange) event is fired.
|
|
2046
|
-
* ...
|
|
2047
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/TimeSelection)
|
|
1897
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/TimeSelection)
|
|
2048
1898
|
*/
|
|
2049
1899
|
timeSelectionFeature ? : object|Boolean|string|TimeSelection|TimeSelectionConfig
|
|
2050
1900
|
/**
|
|
@@ -2052,21 +1902,18 @@ defineProps<{
|
|
|
2052
1902
|
* 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
|
|
2053
1903
|
* tree renderer that adds padding and icon to give the appearance of a tree. The original renderer is preserved and
|
|
2054
1904
|
* also called.
|
|
2055
|
-
* ...
|
|
2056
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Tree)
|
|
1905
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Tree)
|
|
2057
1906
|
*/
|
|
2058
1907
|
treeFeature ? : object|Boolean|string|Tree|TreeConfig
|
|
2059
1908
|
/**
|
|
2060
1909
|
* A feature that allows transforming a flat dataset (or the leaves of a hierarchical) into a tree by specifying a
|
|
2061
1910
|
* record field per parent level. Parents are generated based on each leaf's value for those fields.
|
|
2062
|
-
* ...
|
|
2063
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/TreeGroup)
|
|
1911
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/TreeGroup)
|
|
2064
1912
|
*/
|
|
2065
1913
|
treeGroupFeature ? : object|Boolean|string|TreeGroup|TreeGroupConfig
|
|
2066
1914
|
/**
|
|
2067
1915
|
* A feature allowing you to roll up and display values in the time axis cell for each parent row in a tree scheduler.
|
|
2068
|
-
* ...
|
|
2069
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/TreeSummary)
|
|
1916
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/TreeSummary)
|
|
2070
1917
|
*/
|
|
2071
1918
|
treeSummaryFeature ? : object|Boolean|string|TreeSummary|TreeSummaryConfig
|
|
2072
1919
|
|
|
@@ -2180,9 +2027,8 @@ const emit = defineEmits<{
|
|
|
2180
2027
|
/**
|
|
2181
2028
|
* Fires before an assignment is removed. Can be triggered by user pressing <kbd>Delete</kbd> or <kbd>Backspace</kbd> or
|
|
2182
2029
|
* by the event editor. Can for example be used to display a custom dialog to confirm deletion, in which
|
|
2183
|
-
* case records should be "manually" removed after confirmation
|
|
2184
|
-
* ...
|
|
2185
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-beforeAssignmentDelete)
|
|
2030
|
+
* case records should be "manually" removed after confirmation.
|
|
2031
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-beforeAssignmentDelete)
|
|
2186
2032
|
* @param {string} e Event name
|
|
2187
2033
|
* @param {object} params Event parameters
|
|
2188
2034
|
* @param {string} params.e Event name
|
|
@@ -2190,9 +2036,9 @@ const emit = defineEmits<{
|
|
|
2190
2036
|
* @param {object} params.params.event Event object
|
|
2191
2037
|
* @param {Scheduler.view.Scheduler} params.params.event.source The Scheduler instance
|
|
2192
2038
|
* @param {Scheduler.model.SchedulerAssignmentModel[]} params.params.event.assignmentRecords The assignment records about to be deleted
|
|
2193
|
-
* @param {object} params.params.event.context Additional removal context
|
|
2039
|
+
* @param {object} params.params.event.context Additional removal context. This allows you to process the deletion by calling `context.finalize()` if you return `false` from the event handler.
|
|
2194
2040
|
* @param {Function} params.params.event.context.finalize Function to call to finalize the removal. Used to asynchronously decide to remove the records or not. Provide `false` to the function to prevent the removal.
|
|
2195
|
-
* @param {boolean} params.params.event.context.finalize.removeRecords Provide `false` to the function to prevent the removal.
|
|
2041
|
+
* @param {boolean} [params.params.event.context.finalize.removeRecords] Provide `false` to the function to prevent the removal.
|
|
2196
2042
|
*/
|
|
2197
2043
|
(e: 'beforeAssignmentDelete', params: ((event: { source: Scheduler, assignmentRecords: SchedulerAssignmentModel[], context: { finalize: { removeRecords?: boolean } } }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
2198
2044
|
/**
|
|
@@ -2212,8 +2058,7 @@ const emit = defineEmits<{
|
|
|
2212
2058
|
(e: 'beforeAssignmentSelectionChange', params: ((event: { source: Scheduler, action: 'select'|'deselect'|'update'|'clear', selected: SchedulerAssignmentModel[], deselected: SchedulerAssignmentModel[], selection: SchedulerAssignmentModel[] }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
2213
2059
|
/**
|
|
2214
2060
|
* This event fires whenever the [autoCreate gesture](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/SchedulerBase#config-autoCreate) is detected.
|
|
2215
|
-
* ...
|
|
2216
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-beforeAutoCreate)
|
|
2061
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-beforeAutoCreate)
|
|
2217
2062
|
* @param {string} e Event name
|
|
2218
2063
|
* @param {object} params Event parameters
|
|
2219
2064
|
* @param {string} params.e Event name
|
|
@@ -2237,8 +2082,7 @@ const emit = defineEmits<{
|
|
|
2237
2082
|
(e: 'beforeCancelCellEdit', params: ((event: { source: Grid, editorContext: GridLocation }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
2238
2083
|
/**
|
|
2239
2084
|
* Fires on the owning Grid before the row editing is canceled, return false to signal that the value is invalid and editing should not be finalized.
|
|
2240
|
-
* ...
|
|
2241
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-beforeCancelRowEdit)
|
|
2085
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-beforeCancelRowEdit)
|
|
2242
2086
|
* @param {string} e Event name
|
|
2243
2087
|
* @param {object} params Event parameters
|
|
2244
2088
|
* @param {string} params.e Event name
|
|
@@ -2338,8 +2182,7 @@ const emit = defineEmits<{
|
|
|
2338
2182
|
/**
|
|
2339
2183
|
* This event is fired on the owning Scheduler when the context [element](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ScheduleContext#property-element) or
|
|
2340
2184
|
* [widget](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ScheduleContext#property-widget) is about to be shown.
|
|
2341
|
-
* ...
|
|
2342
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-beforeContextShow)
|
|
2185
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-beforeContextShow)
|
|
2343
2186
|
* @param {string} e Event name
|
|
2344
2187
|
* @param {object} params Event parameters
|
|
2345
2188
|
* @param {string} params.e Event name
|
|
@@ -2485,8 +2328,7 @@ const emit = defineEmits<{
|
|
|
2485
2328
|
/**
|
|
2486
2329
|
* Fires on the owning Scheduler at the beginning of the drag gesture. Returning `false` from a listener prevents
|
|
2487
2330
|
* the drag create operation from starting.
|
|
2488
|
-
* ...
|
|
2489
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-beforeDragCreate)
|
|
2331
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-beforeDragCreate)
|
|
2490
2332
|
* @param {string} e Event name
|
|
2491
2333
|
* @param {object} params Event parameters
|
|
2492
2334
|
* @param {string} params.e Event name
|
|
@@ -2500,8 +2342,7 @@ const emit = defineEmits<{
|
|
|
2500
2342
|
/**
|
|
2501
2343
|
* Fires on the owning Scheduler to allow implementer to prevent immediate finalization by setting
|
|
2502
2344
|
* `data.context.async = true` in the listener, to show a confirmation popup etc.
|
|
2503
|
-
* ...
|
|
2504
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-beforeDragCreateFinalize)
|
|
2345
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-beforeDragCreateFinalize)
|
|
2505
2346
|
* @param {string} e Event name
|
|
2506
2347
|
* @param {object} params Event parameters
|
|
2507
2348
|
* @param {string} params.e Event name
|
|
@@ -2535,8 +2376,7 @@ const emit = defineEmits<{
|
|
|
2535
2376
|
* Fires before an event is removed. Can be triggered by user pressing <kbd>Delete</kbd> or <kbd>Backspace</kbd> or by the
|
|
2536
2377
|
* event editor. Return `false` to immediately veto the removal (or a `Promise` yielding `true` or `false`
|
|
2537
2378
|
* for async vetoing).
|
|
2538
|
-
* ...
|
|
2539
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-beforeEventDelete)
|
|
2379
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-beforeEventDelete)
|
|
2540
2380
|
* @param {string} e Event name
|
|
2541
2381
|
* @param {object} params Event parameters
|
|
2542
2382
|
* @param {string} params.e Event name
|
|
@@ -2544,9 +2384,9 @@ const emit = defineEmits<{
|
|
|
2544
2384
|
* @param {object} params.params.event Event object
|
|
2545
2385
|
* @param {Scheduler.view.Scheduler,any} params.params.event.source The Scheduler instance
|
|
2546
2386
|
* @param {Scheduler.model.SchedulerEventModel[]} params.params.event.eventRecords The records about to be deleted
|
|
2547
|
-
* @param {object} params.params.event.context Additional removal context
|
|
2387
|
+
* @param {object} params.params.event.context Additional removal context. This allows you to process the deletion by calling `context.finalize()` if you return `false` from the event handler.
|
|
2548
2388
|
* @param {Function} params.params.event.context.finalize Function to call to finalize the removal. Used to asynchronously decide to remove the records or not. Provide `false` to the function to prevent the removal.
|
|
2549
|
-
* @param {boolean} params.params.event.context.finalize.removeRecords Provide `false` to the function to prevent the removal.
|
|
2389
|
+
* @param {boolean} [params.params.event.context.finalize.removeRecords] Provide `false` to the function to prevent the removal.
|
|
2550
2390
|
*/
|
|
2551
2391
|
(e: 'beforeEventDelete', params: ((event: { source: Scheduler|any, eventRecords: SchedulerEventModel[], context: { finalize: { removeRecords?: boolean } } }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
2552
2392
|
/**
|
|
@@ -2580,8 +2420,7 @@ const emit = defineEmits<{
|
|
|
2580
2420
|
* It allows implementer to use asynchronous validation/finalization by setting `context.async = true`
|
|
2581
2421
|
* in the listener, for example, to show a confirmation popup, make async data request etc.
|
|
2582
2422
|
* In such case, implementer need to call the `context.finalize()` method manually:
|
|
2583
|
-
* ...
|
|
2584
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-beforeEventDropFinalize)
|
|
2423
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-beforeEventDropFinalize)
|
|
2585
2424
|
* @param {string} e Event name
|
|
2586
2425
|
* @param {object} params Event parameters
|
|
2587
2426
|
* @param {string} params.e Event name
|
|
@@ -2604,8 +2443,7 @@ const emit = defineEmits<{
|
|
|
2604
2443
|
* Fires on the owning Scheduler before an event is displayed in an editor.
|
|
2605
2444
|
* This may be listened for to allow an application to take over event editing duties. Returning `false`
|
|
2606
2445
|
* stops the default editing UI from being shown.
|
|
2607
|
-
* ...
|
|
2608
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-beforeEventEdit)
|
|
2446
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-beforeEventEdit)
|
|
2609
2447
|
* @param {string} e Event name
|
|
2610
2448
|
* @param {object} params Event parameters
|
|
2611
2449
|
* @param {string} params.e Event name
|
|
@@ -2650,8 +2488,7 @@ const emit = defineEmits<{
|
|
|
2650
2488
|
/**
|
|
2651
2489
|
* Fired on the owning Scheduler to allow implementer to prevent immediate finalization by returning a promise
|
|
2652
2490
|
* in the listener, to show a confirmation popup etc
|
|
2653
|
-
* ...
|
|
2654
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-beforeEventResizeFinalize)
|
|
2491
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-beforeEventResizeFinalize)
|
|
2655
2492
|
* @param {string} e Event name
|
|
2656
2493
|
* @param {object} params Event parameters
|
|
2657
2494
|
* @param {string} params.e Event name
|
|
@@ -2673,8 +2510,7 @@ const emit = defineEmits<{
|
|
|
2673
2510
|
/**
|
|
2674
2511
|
* Fires on the owning Scheduler before an event is saved.
|
|
2675
2512
|
* Return `false` to immediately prevent saving
|
|
2676
|
-
* ...
|
|
2677
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-beforeEventSave)
|
|
2513
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-beforeEventSave)
|
|
2678
2514
|
* @param {string} e Event name
|
|
2679
2515
|
* @param {object} params Event parameters
|
|
2680
2516
|
* @param {string} params.e Event name
|
|
@@ -2685,7 +2521,7 @@ const emit = defineEmits<{
|
|
|
2685
2521
|
* @param {Scheduler.model.SchedulerResourceModel[]} params.params.event.resourceRecords The resources to which the event is assigned
|
|
2686
2522
|
* @param {object} params.params.event.values The new values
|
|
2687
2523
|
* @param {object} params.params.event.context Extended save context:
|
|
2688
|
-
* @param {boolean} params.params.event.context.async Set this to `true` in a listener to indicate that the listener will asynchronously decide to prevent or not the event save.
|
|
2524
|
+
* @param {boolean} [params.params.event.context.async] Set this to `true` in a listener to indicate that the listener will asynchronously decide to prevent or not the event save.
|
|
2689
2525
|
* @param {Function} params.params.event.context.finalize Function to call to finalize the save. Used when `async` is `true`. Provide `false` to the function to prevent the save.
|
|
2690
2526
|
*/
|
|
2691
2527
|
(e: 'beforeEventSave', params: ((event: { source: Scheduler, eventRecord: SchedulerEventModel, resourceRecords: SchedulerResourceModel[], values: object, context: { async?: boolean, finalize: Function } }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
@@ -2740,8 +2576,7 @@ const emit = defineEmits<{
|
|
|
2740
2576
|
(e: 'beforeFinishCellEdit', params: ((event: { grid: Grid, editorContext: CellEditorContext }) => void)|string): void
|
|
2741
2577
|
/**
|
|
2742
2578
|
* Fires on the owning Grid before the row editing is finished, return false to signal that the value is invalid and editing should not be finalized.
|
|
2743
|
-
* ...
|
|
2744
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-beforeFinishRowEdit)
|
|
2579
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-beforeFinishRowEdit)
|
|
2745
2580
|
* @param {string} e Event name
|
|
2746
2581
|
* @param {object} params Event parameters
|
|
2747
2582
|
* @param {string} params.e Event name
|
|
@@ -2834,8 +2669,7 @@ const emit = defineEmits<{
|
|
|
2834
2669
|
(e: 'beforeRenderRows', params: ((event: { source: GridBase }) => void)|string): void
|
|
2835
2670
|
/**
|
|
2836
2671
|
* This event fires before row collapse is started.
|
|
2837
|
-
* ...
|
|
2838
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-beforeRowCollapse)
|
|
2672
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-beforeRowCollapse)
|
|
2839
2673
|
* @param {string} e Event name
|
|
2840
2674
|
* @param {object} params Event parameters
|
|
2841
2675
|
* @param {string} params.e Event name
|
|
@@ -2846,8 +2680,7 @@ const emit = defineEmits<{
|
|
|
2846
2680
|
(e: 'beforeRowCollapse', params: ((event: { record: Model }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
2847
2681
|
/**
|
|
2848
2682
|
* This event fires before row expand is started.
|
|
2849
|
-
* ...
|
|
2850
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-beforeRowExpand)
|
|
2683
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-beforeRowExpand)
|
|
2851
2684
|
* @param {string} e Event name
|
|
2852
2685
|
* @param {object} params Event parameters
|
|
2853
2686
|
* @param {string} params.e Event name
|
|
@@ -2859,8 +2692,7 @@ const emit = defineEmits<{
|
|
|
2859
2692
|
/**
|
|
2860
2693
|
* This event is fired on the owning Scheduler before the selected contexts are rendered.
|
|
2861
2694
|
* The event is triggered only when [multiSelect](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ScheduleContext#config-multiSelect) is enabled
|
|
2862
|
-
* ...
|
|
2863
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-beforeSelectedContextsShow)
|
|
2695
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-beforeSelectedContextsShow)
|
|
2864
2696
|
* @param {string} e Event name
|
|
2865
2697
|
* @param {object} params Event parameters
|
|
2866
2698
|
* @param {string} params.e Event name
|
|
@@ -2993,8 +2825,7 @@ const emit = defineEmits<{
|
|
|
2993
2825
|
(e: 'cancelCellEdit', params: ((event: { source: Grid, editorContext: GridLocation, event: Event }) => void)|string): void
|
|
2994
2826
|
/**
|
|
2995
2827
|
* Fires when any other event is fired from the object.
|
|
2996
|
-
* ...
|
|
2997
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-catchAll)
|
|
2828
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-catchAll)
|
|
2998
2829
|
* @param {string} e Event name
|
|
2999
2830
|
* @param {object} params Event parameters
|
|
3000
2831
|
* @param {string} params.e Event name
|
|
@@ -3052,8 +2883,7 @@ const emit = defineEmits<{
|
|
|
3052
2883
|
/**
|
|
3053
2884
|
* This event fires on the owning grid before the context menu is shown for a cell.
|
|
3054
2885
|
* Allows manipulation of the items to show in the same way as in the [processItems](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellMenu#config-processItems).
|
|
3055
|
-
* ...
|
|
3056
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-cellMenuBeforeShow)
|
|
2886
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-cellMenuBeforeShow)
|
|
3057
2887
|
* @param {string} e Event name
|
|
3058
2888
|
* @param {object} params Event parameters
|
|
3059
2889
|
* @param {string} params.e Event name
|
|
@@ -3321,8 +3151,7 @@ const emit = defineEmits<{
|
|
|
3321
3151
|
(e: 'currentTimelineUpdate', params: ((event: { source: Scheduler, date: Date }) => void)|string): void
|
|
3322
3152
|
/**
|
|
3323
3153
|
* Fired when data in the store changes.
|
|
3324
|
-
* ...
|
|
3325
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-dataChange)
|
|
3154
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-dataChange)
|
|
3326
3155
|
* @param {string} e Event name
|
|
3327
3156
|
* @param {object} params Event parameters
|
|
3328
3157
|
* @param {string} params.e Event name
|
|
@@ -3340,8 +3169,7 @@ const emit = defineEmits<{
|
|
|
3340
3169
|
* Fired when the range of dates encapsulated by the UI changes. This will be when
|
|
3341
3170
|
* moving a view in time by reconfiguring its [timeAxis](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/TimelineBase#config-timeAxis). This will happen
|
|
3342
3171
|
* when zooming, or changing [viewPreset](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/TimelineBase#config-viewPreset).
|
|
3343
|
-
* ...
|
|
3344
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-dateRangeChange)
|
|
3172
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-dateRangeChange)
|
|
3345
3173
|
* @param {string} e Event name
|
|
3346
3174
|
* @param {object} params Event parameters
|
|
3347
3175
|
* @param {string} params.e Event name
|
|
@@ -3431,7 +3259,7 @@ const emit = defineEmits<{
|
|
|
3431
3259
|
* @param {Record<string, MenuItemEntry>} params.params.event.items Menu item configs
|
|
3432
3260
|
* @param {Scheduler.model.SchedulerDependencyModel} params.params.event.dependencyRecord Dependency record for which the menu was triggered
|
|
3433
3261
|
* @param {HTMLElement} params.params.event.element
|
|
3434
|
-
* @param {MouseEvent} params.params.event.event Pointer event which triggered the context menu (if any)
|
|
3262
|
+
* @param {MouseEvent} [params.params.event.event] Pointer event which triggered the context menu (if any)
|
|
3435
3263
|
*/
|
|
3436
3264
|
(e: 'dependencyMenuBeforeShow', params: ((event: { source: Scheduler, items: Record<string, MenuItemEntry>, dependencyRecord: SchedulerDependencyModel, element: HTMLElement, event?: MouseEvent }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
3437
3265
|
/**
|
|
@@ -3811,7 +3639,7 @@ const emit = defineEmits<{
|
|
|
3811
3639
|
* @param {Scheduler.model.SchedulerResourceModel} params.params.event.resourceRecord Resource record
|
|
3812
3640
|
* @param {Scheduler.model.SchedulerAssignmentModel} params.params.event.assignmentRecord Assignment record, if assignments are used
|
|
3813
3641
|
* @param {HTMLElement} params.params.event.eventElement
|
|
3814
|
-
* @param {MouseEvent} params.params.event.event Pointer event which triggered the context menu (if any)
|
|
3642
|
+
* @param {MouseEvent} [params.params.event.event] Pointer event which triggered the context menu (if any)
|
|
3815
3643
|
*/
|
|
3816
3644
|
(e: 'eventMenuBeforeShow', params: ((event: { source: Scheduler, items: Record<string, MenuItemEntry>, eventRecord: SchedulerEventModel, resourceRecord: SchedulerResourceModel, assignmentRecord: SchedulerAssignmentModel, eventElement: HTMLElement, event?: MouseEvent }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
3817
3645
|
/**
|
|
@@ -3909,8 +3737,7 @@ const emit = defineEmits<{
|
|
|
3909
3737
|
(e: 'eventMouseLeave', params: ((event: { source: Scheduler, eventRecord: SchedulerEventModel, assignmentRecord: SchedulerAssignmentModel, date: Date, tick: TimeSpan, tickIndex: number, tickStartDate: Date, tickEndDate: Date, row: Row, index: number, resourceRecord: SchedulerResourceModel, event: MouseEvent }) => void)|string): void
|
|
3910
3738
|
/**
|
|
3911
3739
|
* Triggered for mouse out events within and when moving out of an event bar.
|
|
3912
|
-
* ...
|
|
3913
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-eventMouseOut)
|
|
3740
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-eventMouseOut)
|
|
3914
3741
|
* @param {string} e Event name
|
|
3915
3742
|
* @param {object} params Event parameters
|
|
3916
3743
|
* @param {string} params.e Event name
|
|
@@ -3932,8 +3759,7 @@ const emit = defineEmits<{
|
|
|
3932
3759
|
(e: 'eventMouseOut', params: ((event: { source: Scheduler, eventRecord: SchedulerEventModel, assignmentRecord: SchedulerAssignmentModel, date: Date, tick: TimeSpan, tickIndex: number, tickStartDate: Date, tickEndDate: Date, row: Row, index: number, resourceRecord: SchedulerResourceModel, event: MouseEvent }) => void)|string): void
|
|
3933
3760
|
/**
|
|
3934
3761
|
* Triggered for mouse over events when moving into and within an event bar.
|
|
3935
|
-
* ...
|
|
3936
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-eventMouseOver)
|
|
3762
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-eventMouseOver)
|
|
3937
3763
|
* @param {string} e Event name
|
|
3938
3764
|
* @param {object} params Event parameters
|
|
3939
3765
|
* @param {string} params.e Event name
|
|
@@ -4128,8 +3954,7 @@ const emit = defineEmits<{
|
|
|
4128
3954
|
(e: 'finishCellEdit', params: ((event: { grid: Grid, editorContext: CellEditorContext }) => void)|string): void
|
|
4129
3955
|
/**
|
|
4130
3956
|
* Fires on the owning Grid before the row editing is finished, return false to signal that the value is invalid and editing should not be finalized.
|
|
4131
|
-
* ...
|
|
4132
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-finishRowEdit)
|
|
3957
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-finishRowEdit)
|
|
4133
3958
|
* @param {string} e Event name
|
|
4134
3959
|
* @param {object} params Event parameters
|
|
4135
3960
|
* @param {string} params.e Event name
|
|
@@ -4265,8 +4090,7 @@ const emit = defineEmits<{
|
|
|
4265
4090
|
(e: 'gridRowDrop', params: ((event: { source: GridBase, context: { valid: boolean, insertBefore: Model, parent: Model, records: Model[], oldPositionContext: RecordPositionContext[] }, event: MouseEvent }) => void)|string): void
|
|
4266
4091
|
/**
|
|
4267
4092
|
* Fired when a grid header is clicked on.
|
|
4268
|
-
* ...
|
|
4269
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-headerClick)
|
|
4093
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-headerClick)
|
|
4270
4094
|
* @param {string} e Event name
|
|
4271
4095
|
* @param {object} params Event parameters
|
|
4272
4096
|
* @param {string} params.e Event name
|
|
@@ -4279,8 +4103,7 @@ const emit = defineEmits<{
|
|
|
4279
4103
|
/**
|
|
4280
4104
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
4281
4105
|
* Allows manipulation of the items to show in the same way as in the [processItems](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/HeaderMenu#config-processItems).
|
|
4282
|
-
* ...
|
|
4283
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-headerMenuBeforeShow)
|
|
4106
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-headerMenuBeforeShow)
|
|
4284
4107
|
* @param {string} e Event name
|
|
4285
4108
|
* @param {object} params Event parameters
|
|
4286
4109
|
* @param {string} params.e Event name
|
|
@@ -4399,8 +4222,7 @@ const emit = defineEmits<{
|
|
|
4399
4222
|
/**
|
|
4400
4223
|
* Triggered when a widget which had been in a non-visible state for any reason
|
|
4401
4224
|
* achieves visibility.
|
|
4402
|
-
* ...
|
|
4403
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-paint)
|
|
4225
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-paint)
|
|
4404
4226
|
* @param {string} e Event name
|
|
4405
4227
|
* @param {object} params Event parameters
|
|
4406
4228
|
* @param {string} params.e Event name
|
|
@@ -4454,8 +4276,8 @@ const emit = defineEmits<{
|
|
|
4454
4276
|
* @param {string} params.e Event name
|
|
4455
4277
|
* @param {object} params.params Event parameters
|
|
4456
4278
|
* @param {object} params.params.event Event object
|
|
4457
|
-
* @param {Response} params.params.event.response Optional response, if received
|
|
4458
|
-
* @param {Error} params.params.event.error Optional error, if exception occurred
|
|
4279
|
+
* @param {Response} [params.params.event.response] Optional response, if received
|
|
4280
|
+
* @param {Error} [params.params.event.error] Optional error, if exception occurred
|
|
4459
4281
|
*/
|
|
4460
4282
|
(e: 'pdfExport', params: ((event: { response?: Response, error?: Error }) => void)|string): void
|
|
4461
4283
|
/**
|
|
@@ -4684,8 +4506,7 @@ const emit = defineEmits<{
|
|
|
4684
4506
|
/**
|
|
4685
4507
|
* This event fires on the owning scheduler before the context menu is shown for a resource.
|
|
4686
4508
|
* Allows manipulation of the items to show in the same way as in the [processItems](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ResourceMenu#config-processItems).
|
|
4687
|
-
* ...
|
|
4688
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-resourceMenuBeforeShow)
|
|
4509
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-resourceMenuBeforeShow)
|
|
4689
4510
|
* @param {string} e Event name
|
|
4690
4511
|
* @param {object} params Event parameters
|
|
4691
4512
|
* @param {string} params.e Event name
|
|
@@ -4869,8 +4690,7 @@ const emit = defineEmits<{
|
|
|
4869
4690
|
(e: 'rowCollapse', params: ((event: { record: Model }) => void)|string): void
|
|
4870
4691
|
/**
|
|
4871
4692
|
* This event fires when a row expand has finished expanding.
|
|
4872
|
-
* ...
|
|
4873
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-rowExpand)
|
|
4693
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-rowExpand)
|
|
4874
4694
|
* @param {string} e Event name
|
|
4875
4695
|
* @param {object} params Event parameters
|
|
4876
4696
|
* @param {string} params.e Event name
|
|
@@ -5152,7 +4972,7 @@ const emit = defineEmits<{
|
|
|
5152
4972
|
* @param {object} params.params Event parameters
|
|
5153
4973
|
* @param {object} params.params.event Event object
|
|
5154
4974
|
* @param {Scheduler.view.TimelineBase} params.params.event.source This Scheduler/Gantt instance.
|
|
5155
|
-
* @param {object} params.params.event.old The shift increment *if any*.
|
|
4975
|
+
* @param {object} [params.params.event.old] The shift increment *if any*.
|
|
5156
4976
|
* @param {object} params.params.event.new The shift increment
|
|
5157
4977
|
*/
|
|
5158
4978
|
(e: 'shiftIncrementChange', params: ((event: { source: TimelineBase, old?: object, new: object }) => void)|string): void
|
|
@@ -5356,8 +5176,7 @@ const emit = defineEmits<{
|
|
|
5356
5176
|
(e: 'tickCellMouseUp', params: ((event: { source: Scheduler, feature: TreeSummary, startDate: Date, endDate: Date, resourceRecord: SchedulerResourceModel, domEvent: MouseEvent }) => void)|string): void
|
|
5357
5177
|
/**
|
|
5358
5178
|
* Fired when the tick size changes.
|
|
5359
|
-
* ...
|
|
5360
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-tickSizeChange)
|
|
5179
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-tickSizeChange)
|
|
5361
5180
|
* @param {string} e Event name
|
|
5362
5181
|
* @param {object} params Event parameters
|
|
5363
5182
|
* @param {string} params.e Event name
|
|
@@ -5422,8 +5241,7 @@ const emit = defineEmits<{
|
|
|
5422
5241
|
/**
|
|
5423
5242
|
* This event fires on the owning Scheduler or Gantt widget before the context menu is shown for the time axis header.
|
|
5424
5243
|
* Allows manipulation of the items to show in the same way as in the [processItems](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/TimeAxisHeaderMenu#config-processItems).
|
|
5425
|
-
* ...
|
|
5426
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-timeAxisHeaderMenuBeforeShow)
|
|
5244
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-timeAxisHeaderMenuBeforeShow)
|
|
5427
5245
|
* @param {string} e Event name
|
|
5428
5246
|
* @param {object} params Event parameters
|
|
5429
5247
|
* @param {string} params.e Event name
|
|
@@ -5559,7 +5377,7 @@ const emit = defineEmits<{
|
|
|
5559
5377
|
* @param {Core.data.Model} params.params.event.groupRecord [DEPRECATED] Use `groupRecords` param instead
|
|
5560
5378
|
* @param {Core.data.Model[]} params.params.event.groupRecords The group records being toggled
|
|
5561
5379
|
* @param {boolean} params.params.event.collapse Collapsed (true) or expanded (false)
|
|
5562
|
-
* @param {boolean} params.params.event.allRecords True if this event is part of toggling all groups
|
|
5380
|
+
* @param {boolean} [params.params.event.allRecords] True if this event is part of toggling all groups
|
|
5563
5381
|
*/
|
|
5564
5382
|
(e: 'toggleGroup', params: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, allRecords?: boolean }) => void)|string): void
|
|
5565
5383
|
/**
|
|
@@ -5613,8 +5431,7 @@ const emit = defineEmits<{
|
|
|
5613
5431
|
/**
|
|
5614
5432
|
* Fired when the range of dates visible within the viewport changes. This will be when
|
|
5615
5433
|
* scrolling along a time axis.
|
|
5616
|
-
* ...
|
|
5617
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-visibleDateRangeChange)
|
|
5434
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-visibleDateRangeChange)
|
|
5618
5435
|
* @param {string} e Event name
|
|
5619
5436
|
* @param {object} params Event parameters
|
|
5620
5437
|
* @param {string} params.e Event name
|
|
@@ -5629,6 +5446,18 @@ const emit = defineEmits<{
|
|
|
5629
5446
|
* @param {Date} params.params.event.new.endDate the new end date.
|
|
5630
5447
|
*/
|
|
5631
5448
|
(e: 'visibleDateRangeChange', params: ((event: { source: Scheduler, old: { startDate: Date, endDate: Date }, new: { startDate: Date, endDate: Date } }) => void)|string): void
|
|
5449
|
+
/**
|
|
5450
|
+
* Fires when the smooth zoom level changes, either through programmatic zoom methods or mouse wheel zooming.
|
|
5451
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/Timeline#event-zoomLevelChange)
|
|
5452
|
+
* @param {string} e Event name
|
|
5453
|
+
* @param {object} params Event parameters
|
|
5454
|
+
* @param {string} params.e Event name
|
|
5455
|
+
* @param {object} params.params Event parameters
|
|
5456
|
+
* @param {object} params.params.event Event object
|
|
5457
|
+
* @param {Scheduler.view.TimelineBase} params.params.event.source
|
|
5458
|
+
* @param {number} params.params.event.zoomLevel New zoom level
|
|
5459
|
+
*/
|
|
5460
|
+
(e: 'zoomLevelChange', params: ((event: { source: TimelineBase, zoomLevel: number }) => void)|string): void
|
|
5632
5461
|
}>();
|
|
5633
5462
|
|
|
5634
5463
|
const widgetData = {
|
|
@@ -5730,6 +5559,7 @@ const widgetData = {
|
|
|
5730
5559
|
'resourceTimeRangeRenderer',
|
|
5731
5560
|
'responsiveLevels',
|
|
5732
5561
|
'ripple',
|
|
5562
|
+
'role',
|
|
5733
5563
|
'rootElement',
|
|
5734
5564
|
'scrollerClass',
|
|
5735
5565
|
'scrollExtensionThreshold',
|
|
@@ -5739,6 +5569,7 @@ const widgetData = {
|
|
|
5739
5569
|
'showEventColorPickers',
|
|
5740
5570
|
'showLagInTooltip',
|
|
5741
5571
|
'showRecurringUI',
|
|
5572
|
+
'smoothZoom',
|
|
5742
5573
|
'snapRelativeToEventStartDate',
|
|
5743
5574
|
'startParamName',
|
|
5744
5575
|
'stateful',
|
|
@@ -5825,6 +5656,7 @@ const widgetData = {
|
|
|
5825
5656
|
'isEventSelectable',
|
|
5826
5657
|
'keyMap',
|
|
5827
5658
|
'labelPosition',
|
|
5659
|
+
'labelWidth',
|
|
5828
5660
|
'lazyLoadingIndicator',
|
|
5829
5661
|
'longPressTime',
|
|
5830
5662
|
'margin',
|
|
@@ -6100,6 +5932,7 @@ const widgetData = {
|
|
|
6100
5932
|
'onUnlockRows',
|
|
6101
5933
|
'onUnsplit',
|
|
6102
5934
|
'onVisibleDateRangeChange',
|
|
5935
|
+
'onZoomLevelChange',
|
|
6103
5936
|
'overlappingEventSorter',
|
|
6104
5937
|
'preserveScroll',
|
|
6105
5938
|
'presets',
|
|
@@ -6147,13 +5980,10 @@ const widgetData = {
|
|
|
6147
5980
|
'viewPreset',
|
|
6148
5981
|
'visibleDate',
|
|
6149
5982
|
'width',
|
|
6150
|
-
'workingTime'
|
|
5983
|
+
'workingTime',
|
|
5984
|
+
'zoomFactor'
|
|
6151
5985
|
],
|
|
6152
5986
|
propertyNames : [
|
|
6153
|
-
'focusVisible',
|
|
6154
|
-
'hasChanges',
|
|
6155
|
-
'isEngineReady',
|
|
6156
|
-
'isNavigatingTimelineCells',
|
|
6157
5987
|
'originalStore',
|
|
6158
5988
|
'parent',
|
|
6159
5989
|
'scrollLeft',
|
|
@@ -6431,7 +6261,8 @@ const widgetData = {
|
|
|
6431
6261
|
'treeGroup',
|
|
6432
6262
|
'unlockRows',
|
|
6433
6263
|
'unsplit',
|
|
6434
|
-
'visibleDateRangeChange'
|
|
6264
|
+
'visibleDateRangeChange',
|
|
6265
|
+
'zoomLevelChange'
|
|
6435
6266
|
]
|
|
6436
6267
|
};
|
|
6437
6268
|
|