@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
|
@@ -33,10 +33,10 @@
|
|
|
33
33
|
|
|
34
34
|
import { getCurrentInstance, onBeforeUnmount, onMounted, provide, ref, watch, toRaw } from 'vue';
|
|
35
35
|
|
|
36
|
-
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';
|
|
36
|
+
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';
|
|
37
37
|
import type { AIFilter, AIFilterConfig, CellCopyPaste, CellCopyPasteConfig, 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';
|
|
38
|
-
import type { AI, AIConfig, AssignmentModel as SchedulerAssignmentModel, ColumnLines, ColumnLinesConfig, CrudManager, CrudManagerConfig, DateConstraint, DependencyBaseModel, DependencyEdit as SchedulerDependencyEdit, DependencyMenu, DependencyMenuConfig, DependencyModel as SchedulerDependencyModel, DropData, EventColor, EventCopyPaste, EventCopyPasteConfig,
|
|
39
|
-
import type { AssignmentModel, AssignmentModelConfig, AssignmentStore, AssignmentStoreConfig, CalendarHighlight, CalendarHighlightConfig, CalendarModel, CalendarModelConfig, CellEdit, CellEditConfig, SchedulerProContainerItemConfig, CycleResolutionPopup, Dependencies, DependenciesConfig, DependencyEdit, DependencyEditConfig, DependencyModel, DependencyModelConfig, DependencyStore, DependencyStoreConfig, EventBuffer, EventBufferConfig, EventLayoutConfig, EventModel, EventModelConfig, EventResize, EventResizeConfig, EventSegmentDrag, EventSegmentDragConfig, EventSegmentResize, EventSegmentResizeConfig, EventSegments, EventSegmentsConfig, EventStore, EventStoreConfig, SchedulerProColumnConfig, NestedEvents, NestedEventsConfig, PercentBar, PercentBarConfig, ProjectModel, ProjectModelConfig, ResourceEdit, ResourceEditConfig, ResourceEditor, ResourceGrid, ResourceModel, ResourceModelConfig, ResourceNonWorkingTime, ResourceNonWorkingTimeConfig, ResourceStore, ResourceStoreConfig, SchedulerPro, SchedulerProBaseListeners, SchedulingIssueResolutionPopup, TaskEdit, TaskEditConfig, TaskEditorBase, TimeSpanHighlight, TimeSpanHighlightConfig, Versions, VersionsConfig } from '@bryntum/schedulerpro-thin';
|
|
38
|
+
import type { AI, AIConfig, AssignmentModel as SchedulerAssignmentModel, ColumnLines, ColumnLinesConfig, CrudManager, CrudManagerConfig, DateConstraint, DependencyBaseModel, DependencyEdit as SchedulerDependencyEdit, DependencyMenu, DependencyMenuConfig, DependencyModel as SchedulerDependencyModel, DropData, EventColor, EventCopyPaste, EventCopyPasteConfig, EventDragCreate, EventDragCreateConfig, EventDragSelect, EventDragSelectConfig, EventEdit, EventEditConfig, EventFilter, EventFilterConfig, EventMenu, EventMenuConfig, EventModel as SchedulerEventModel, EventNonWorkingTime, EventNonWorkingTimeConfig, EventResizeData, 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, 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';
|
|
39
|
+
import type { AssignmentModel, AssignmentModelConfig, AssignmentStore, AssignmentStoreConfig, CalendarHighlight, CalendarHighlightConfig, CalendarModel, CalendarModelConfig, CellEdit, CellEditConfig, SchedulerProContainerItemConfig, CycleResolutionPopup, Dependencies, DependenciesConfig, DependencyEdit, DependencyEditConfig, DependencyModel, DependencyModelConfig, DependencyStore, DependencyStoreConfig, EventBuffer, EventBufferConfig, EventDrag, EventDragConfig, EventLayoutConfig, EventModel, EventModelConfig, EventResize, EventResizeConfig, EventSegmentDrag, EventSegmentDragConfig, EventSegmentResize, EventSegmentResizeConfig, EventSegments, EventSegmentsConfig, EventStore, EventStoreConfig, SchedulerProColumnConfig, NestedEvents, NestedEventsConfig, PercentBar, PercentBarConfig, ProjectModel, ProjectModelConfig, ResourceEdit, ResourceEditConfig, ResourceEditor, ResourceGrid, ResourceModel, ResourceModelConfig, ResourceNonWorkingTime, ResourceNonWorkingTimeConfig, ResourceStore, ResourceStoreConfig, SchedulerPro, SchedulerProBaseListeners, SchedulingIssueResolutionPopup, TaskEdit, TaskEditConfig, TaskEditorBase, TimeSpanHighlight, TimeSpanHighlightConfig, Versions, VersionsConfig } from '@bryntum/schedulerpro-thin';
|
|
40
40
|
import { SchedulerProBase } from '@bryntum/schedulerpro-thin';
|
|
41
41
|
|
|
42
42
|
import { WrapperHelper } from '../helper/WrapperHelper';
|
|
@@ -46,8 +46,7 @@ defineProps<{
|
|
|
46
46
|
/**
|
|
47
47
|
* Element (or element id) to adopt as this Widget's encapsulating element. The widget's
|
|
48
48
|
* content will be placed inside this element.
|
|
49
|
-
* ...
|
|
50
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-adopt)
|
|
49
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-adopt)
|
|
51
50
|
*/
|
|
52
51
|
adopt ? : HTMLElement|string
|
|
53
52
|
/**
|
|
@@ -74,8 +73,7 @@ defineProps<{
|
|
|
74
73
|
allowDropOnEventBar ? : Boolean
|
|
75
74
|
/**
|
|
76
75
|
* Set to `false` if you don't want to allow events overlapping times for any one resource (defaults to `true`).
|
|
77
|
-
* ...
|
|
78
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-allowOverlap)
|
|
76
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-allowOverlap)
|
|
79
77
|
*/
|
|
80
78
|
allowOverlap ? : Boolean
|
|
81
79
|
/**
|
|
@@ -104,15 +102,13 @@ defineProps<{
|
|
|
104
102
|
/**
|
|
105
103
|
* A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject
|
|
106
104
|
* into an element which will be linked using the `aria-describedby` attribute.
|
|
107
|
-
* ...
|
|
108
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-ariaDescription)
|
|
105
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-ariaDescription)
|
|
109
106
|
*/
|
|
110
107
|
ariaDescription ? : string
|
|
111
108
|
/**
|
|
112
109
|
* A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject as
|
|
113
110
|
* the `aria-label` attribute.
|
|
114
|
-
* ...
|
|
115
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-ariaLabel)
|
|
111
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-ariaLabel)
|
|
116
112
|
*/
|
|
117
113
|
ariaLabel ? : string
|
|
118
114
|
/**
|
|
@@ -132,16 +128,15 @@ defineProps<{
|
|
|
132
128
|
/**
|
|
133
129
|
* If this config is set, then its `gesture` property (which defaults to `dblclick`) creates a
|
|
134
130
|
* new event at the mouse or touch event's time point.
|
|
135
|
-
* ...
|
|
136
|
-
* [
|
|
137
|
-
* @param {
|
|
138
|
-
* @param {
|
|
139
|
-
* @param {
|
|
140
|
-
* @param {DurationConfig,string} autoCreate.
|
|
141
|
-
* @param {
|
|
142
|
-
* @param {string} autoCreate.name The name of the event to create. Defaults to the `Object.newEvent` property from the locale.
|
|
131
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-autoCreate)
|
|
132
|
+
* @param {'click','dblclick'} [autoCreate.gesture] The gesture to trigger auto creation of an event. Defaults to `dblclick`.
|
|
133
|
+
* @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.
|
|
134
|
+
* @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.
|
|
135
|
+
* @param {DurationConfig,string} [autoCreate.step] The increment to snap the event start date to.
|
|
136
|
+
* @param {DurationConfig,string} [autoCreate.duration] The duration of the event to create. Defaults to 1 time axis tick.
|
|
137
|
+
* @param {string} [autoCreate.name] The name of the event to create. Defaults to the `Object.newEvent` property from the locale.
|
|
143
138
|
*/
|
|
144
|
-
autoCreate ? : Boolean|string|
|
|
139
|
+
autoCreate ? : Boolean|string|object
|
|
145
140
|
/**
|
|
146
141
|
* Automatically set grids height to fit all rows (no scrolling in the grid). In general you should avoid
|
|
147
142
|
* using `autoHeight: true`, since it will bypass Grids virtual rendering and render all rows at once, which
|
|
@@ -150,21 +145,18 @@ defineProps<{
|
|
|
150
145
|
autoHeight ? : Boolean
|
|
151
146
|
/**
|
|
152
147
|
* Controls how much space to leave between stacked event bars in px.
|
|
153
|
-
* ...
|
|
154
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-barMargin)
|
|
148
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-barMargin)
|
|
155
149
|
*/
|
|
156
150
|
barMargin ? : number
|
|
157
151
|
/**
|
|
158
152
|
* A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Toolbar),
|
|
159
153
|
* 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).
|
|
160
|
-
* ...
|
|
161
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-bbar)
|
|
154
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-bbar)
|
|
162
155
|
*/
|
|
163
156
|
bbar ? : (SchedulerProContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
|
|
164
157
|
/**
|
|
165
158
|
* Custom CSS classes to add to the panel's body element.
|
|
166
|
-
* ...
|
|
167
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-bodyCls)
|
|
159
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-bodyCls)
|
|
168
160
|
*/
|
|
169
161
|
bodyCls ? : string|object
|
|
170
162
|
/**
|
|
@@ -174,22 +166,19 @@ defineProps<{
|
|
|
174
166
|
/**
|
|
175
167
|
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
176
168
|
* hierarchy when triggered.
|
|
177
|
-
* ...
|
|
178
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-bubbleEvents)
|
|
169
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-bubbleEvents)
|
|
179
170
|
*/
|
|
180
171
|
bubbleEvents ? : object
|
|
181
172
|
/**
|
|
182
173
|
* 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`.
|
|
183
|
-
* ...
|
|
184
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-bufferCoef)
|
|
174
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-bufferCoef)
|
|
185
175
|
*/
|
|
186
176
|
bufferCoef ? : number
|
|
187
177
|
/**
|
|
188
178
|
* This config defines the scroll limit, which, when exceeded will cause a timespan shift.
|
|
189
179
|
* 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
|
|
190
180
|
* has less than that of the rendered content - a shift is triggered.
|
|
191
|
-
* ...
|
|
192
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-bufferThreshold)
|
|
181
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-bufferThreshold)
|
|
193
182
|
*/
|
|
194
183
|
bufferThreshold ? : number
|
|
195
184
|
/**
|
|
@@ -198,15 +187,13 @@ defineProps<{
|
|
|
198
187
|
calendars ? : CalendarModel[]|CalendarModelConfig[]
|
|
199
188
|
/**
|
|
200
189
|
* Set to `false` to not call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
|
|
201
|
-
* ...
|
|
202
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-callOnFunctions)
|
|
190
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-callOnFunctions)
|
|
203
191
|
*/
|
|
204
192
|
callOnFunctions ? : Boolean
|
|
205
193
|
/**
|
|
206
194
|
* By default, if an event handler throws an exception, the error propagates up the stack and the
|
|
207
195
|
* application state is undefined. Code which follows the event handler will *not* be executed.
|
|
208
|
-
* ...
|
|
209
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-catchEventHandlerExceptions)
|
|
196
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-catchEventHandlerExceptions)
|
|
210
197
|
*/
|
|
211
198
|
catchEventHandlerExceptions ? : Boolean
|
|
212
199
|
/**
|
|
@@ -219,8 +206,7 @@ defineProps<{
|
|
|
219
206
|
* Custom CSS classes to add to element.
|
|
220
207
|
* May be specified as a space separated string, or as an object in which property names
|
|
221
208
|
* with truthy values are used as the class names:
|
|
222
|
-
* ...
|
|
223
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-cls)
|
|
209
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-cls)
|
|
224
210
|
*/
|
|
225
211
|
cls ? : string|object
|
|
226
212
|
/**
|
|
@@ -230,15 +216,13 @@ defineProps<{
|
|
|
230
216
|
collapsed ? : Boolean
|
|
231
217
|
/**
|
|
232
218
|
* This config enables collapsibility for the panel. See [collapsed](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Panel#config-collapsed).
|
|
233
|
-
* ...
|
|
234
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-collapsible)
|
|
219
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-collapsible)
|
|
235
220
|
*/
|
|
236
221
|
collapsible ? : Boolean|PanelCollapserConfig|PanelCollapserOverlayConfig
|
|
237
222
|
/**
|
|
238
223
|
* Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
|
|
239
224
|
* `style` block.
|
|
240
|
-
* ...
|
|
241
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-color)
|
|
225
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-color)
|
|
242
226
|
*/
|
|
243
227
|
color ? : Color
|
|
244
228
|
/**
|
|
@@ -252,8 +236,7 @@ defineProps<{
|
|
|
252
236
|
/**
|
|
253
237
|
* Accepts column definitions for the grid during initialization. They will be used to create
|
|
254
238
|
* [Column](https://bryntum.com/products/schedulerpro/docs/api/Grid/column/Column) instances that are added to a [ColumnStore](#Grid/data/ColumnStore).
|
|
255
|
-
* ...
|
|
256
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-columns)
|
|
239
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-columns)
|
|
257
240
|
*/
|
|
258
241
|
columns ? : ColumnStore|SchedulerProColumnConfig[]|ColumnStoreConfig
|
|
259
242
|
config ? : object
|
|
@@ -261,8 +244,7 @@ defineProps<{
|
|
|
261
244
|
* Custom CSS classes to add to the [contentElement](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#property-contentElement).
|
|
262
245
|
* May be specified as a space separated string, or as an object in which property names
|
|
263
246
|
* with truthy values are used as the class names:
|
|
264
|
-
* ...
|
|
265
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-contentElementCls)
|
|
247
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-contentElementCls)
|
|
266
248
|
*/
|
|
267
249
|
contentElementCls ? : string|object
|
|
268
250
|
/**
|
|
@@ -298,16 +280,14 @@ defineProps<{
|
|
|
298
280
|
crudManagerClass ? : typeof CrudManager
|
|
299
281
|
/**
|
|
300
282
|
* Class implementing the popup resolving *scheduling cycles*.
|
|
301
|
-
* ...
|
|
302
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-cycleResolutionPopupClass)
|
|
283
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-cycleResolutionPopupClass)
|
|
303
284
|
*/
|
|
304
285
|
cycleResolutionPopupClass ? : typeof CycleResolutionPopup
|
|
305
286
|
/**
|
|
306
287
|
* Convenient shortcut to set data in grids store both during initialization and at runtime. Can also be
|
|
307
288
|
* used to retrieve data at runtime, although we do recommend interacting with Grids store instead using
|
|
308
289
|
* the [store](https://bryntum.com/products/schedulerpro/docs/api/Grid/view/GridBase#property-store) property.
|
|
309
|
-
* ...
|
|
310
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-data)
|
|
290
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-data)
|
|
311
291
|
*/
|
|
312
292
|
data ? : object[]|Model[]|ModelConfig[]
|
|
313
293
|
/**
|
|
@@ -321,8 +301,7 @@ defineProps<{
|
|
|
321
301
|
dataset ? : Record<string, string>
|
|
322
302
|
/**
|
|
323
303
|
* The date to display when used as a component of a Calendar.
|
|
324
|
-
* ...
|
|
325
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-date)
|
|
304
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-date)
|
|
326
305
|
*/
|
|
327
306
|
date ? : Date
|
|
328
307
|
/**
|
|
@@ -360,17 +339,15 @@ defineProps<{
|
|
|
360
339
|
* 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.
|
|
361
340
|
* 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
|
|
362
341
|
* be used.
|
|
363
|
-
* ...
|
|
364
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-descriptionFormat)
|
|
342
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-descriptionFormat)
|
|
365
343
|
* @param {Date} date The date to format.
|
|
366
344
|
* @returns {string} The formatted date.
|
|
367
345
|
*/
|
|
368
|
-
descriptionFormat ? : string|string[]|Boolean[]|((date: Date) => string)|
|
|
346
|
+
descriptionFormat ? : string|string[]|Boolean[]|((date: Date) => string)|(((date: Date) => string)[])
|
|
369
347
|
/**
|
|
370
348
|
* A function that provides the textual description for this view. If provided, this function overrides the
|
|
371
349
|
* [descriptionFormat](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/mixin/Describable#config-descriptionFormat).
|
|
372
|
-
* ...
|
|
373
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-descriptionRenderer)
|
|
350
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-descriptionRenderer)
|
|
374
351
|
* @param {Core.widget.Widget} view The active view in case the function is in another scope.
|
|
375
352
|
* @returns {string} Description string
|
|
376
353
|
*/
|
|
@@ -392,16 +369,15 @@ defineProps<{
|
|
|
392
369
|
*/
|
|
393
370
|
destroyStores ? : Boolean
|
|
394
371
|
/**
|
|
395
|
-
* Check for CSS compatibility issues
|
|
396
|
-
*
|
|
397
|
-
* [
|
|
372
|
+
* Check for CSS compatibility and inclusion related issues and try to auto fix them. Performs the following
|
|
373
|
+
* checks:
|
|
374
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-detectCSSCompatibilityIssues)
|
|
398
375
|
*/
|
|
399
376
|
detectCSSCompatibilityIssues ? : Boolean
|
|
400
377
|
/**
|
|
401
378
|
* 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
|
|
402
379
|
* cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
|
|
403
|
-
* ...
|
|
404
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-disabled)
|
|
380
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-disabled)
|
|
405
381
|
*/
|
|
406
382
|
disabled ? : Boolean|'inert'
|
|
407
383
|
/**
|
|
@@ -419,8 +395,7 @@ defineProps<{
|
|
|
419
395
|
/**
|
|
420
396
|
* Defines how dates will be formatted in tooltips etc. This config has priority over similar config on the
|
|
421
397
|
* view preset. For allowed values see [format](https://bryntum.com/products/schedulerpro/docs/api/Core/helper/DateHelper#function-format-static).
|
|
422
|
-
* ...
|
|
423
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-displayDateFormat)
|
|
398
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-displayDateFormat)
|
|
424
399
|
*/
|
|
425
400
|
displayDateFormat ? : string
|
|
426
401
|
/**
|
|
@@ -435,24 +410,22 @@ defineProps<{
|
|
|
435
410
|
* [strips collection](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
|
|
436
411
|
* `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
|
|
437
412
|
* body. Such widgets are called "edge strips".
|
|
438
|
-
* ...
|
|
439
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-dock)
|
|
413
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-dock)
|
|
440
414
|
*/
|
|
441
415
|
dock ? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
442
416
|
/**
|
|
443
417
|
* Make this Panel a docked drawer which slides out from one side of the browser viewport by default.
|
|
444
|
-
* ...
|
|
445
|
-
* [
|
|
446
|
-
* @param {
|
|
447
|
-
* @param {
|
|
448
|
-
* @param {boolean}
|
|
449
|
-
* @param {boolean,
|
|
450
|
-
* @param {boolean,string} autoClose.
|
|
451
|
-
* @param {
|
|
452
|
-
* @param {
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
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}
|
|
418
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-drawer)
|
|
419
|
+
* @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.
|
|
420
|
+
* @param {string,number} [size] The size of the drawer in its collapsible axis.
|
|
421
|
+
* @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.
|
|
422
|
+
* @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.
|
|
423
|
+
* @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.
|
|
424
|
+
* @param {boolean,string} [autoClose.focusout] If focus moves outside of the drawer, the drawer will automatically be hidden.
|
|
425
|
+
* @param {string} [autoClose.mouseout] Hides the drawer when the mouse leaves the drawer after the `autoCloseDelay` period.
|
|
426
|
+
* @param {number} [autoCloseDelay] When using `mouseout`, this is the delay in milliseconds
|
|
427
|
+
*/
|
|
428
|
+
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 }
|
|
456
429
|
/**
|
|
457
430
|
* Decimal precision used when displaying durations, used by tooltips and DurationColumn.
|
|
458
431
|
* Specify `false` to use raw value
|
|
@@ -461,16 +434,14 @@ defineProps<{
|
|
|
461
434
|
/**
|
|
462
435
|
* An object specifying attributes to assign to the root element of this widget.
|
|
463
436
|
* Set `null` value to attribute to remove it.
|
|
464
|
-
* ...
|
|
465
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-elementAttributes)
|
|
437
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-elementAttributes)
|
|
466
438
|
*/
|
|
467
439
|
elementAttributes ? : Record<string, string|null>
|
|
468
440
|
/**
|
|
469
441
|
* 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.
|
|
470
442
|
* When using multiple Grid regions, provide the `region` property to decide where the text is shown.
|
|
471
443
|
* By default, it is shown in the first region.
|
|
472
|
-
* ...
|
|
473
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-emptyText)
|
|
444
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-emptyText)
|
|
474
445
|
*/
|
|
475
446
|
emptyText ? : string|EmptyTextDomConfig
|
|
476
447
|
/**
|
|
@@ -486,16 +457,14 @@ defineProps<{
|
|
|
486
457
|
* Enables showing occurrences of recurring events across the scheduler's time axis. If you want to disable
|
|
487
458
|
* the recurrence popup, you can choose set the `defaultAction` to `future` to affect all future
|
|
488
459
|
* occurrences, or `single` to just affect the currently selected event.
|
|
489
|
-
* ...
|
|
490
|
-
*
|
|
460
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-enableRecurringEvents)
|
|
461
|
+
* @property {'single','future'} defaultAction
|
|
491
462
|
*/
|
|
492
|
-
enableRecurringEvents ? : Boolean|
|
|
493
|
-
defaultAction?: 'single'|'future'
|
|
494
|
-
}
|
|
463
|
+
enableRecurringEvents ? : Boolean|object
|
|
495
464
|
/**
|
|
496
|
-
*
|
|
497
|
-
*
|
|
498
|
-
*
|
|
465
|
+
* Set to `true` to enable the [StickyCells](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/StickyCells) feature, which pins cell
|
|
466
|
+
* content to the top of the grid while rows scroll off the top but remain visible.
|
|
467
|
+
* @deprecated 7.3.0 Use `features : { stickyCells : true }` instead
|
|
499
468
|
*/
|
|
500
469
|
enableSticky ? : Boolean
|
|
501
470
|
/**
|
|
@@ -517,8 +486,7 @@ defineProps<{
|
|
|
517
486
|
enableUndoRedoKeys ? : Boolean
|
|
518
487
|
/**
|
|
519
488
|
* The end date of the timeline (if not configure with [infiniteScroll](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/TimelineBase#config-infiniteScroll)).
|
|
520
|
-
* ...
|
|
521
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-endDate)
|
|
489
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-endDate)
|
|
522
490
|
*/
|
|
523
491
|
endDate ? : Date|string
|
|
524
492
|
/**
|
|
@@ -532,20 +500,17 @@ defineProps<{
|
|
|
532
500
|
/**
|
|
533
501
|
* Event color used by default. Events and resources can specify their own color, with priority order being:
|
|
534
502
|
* Event -> Resource -> Scheduler default.
|
|
535
|
-
* ...
|
|
536
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-eventColor)
|
|
503
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-eventColor)
|
|
537
504
|
*/
|
|
538
505
|
eventColor ? : EventColor
|
|
539
506
|
/**
|
|
540
507
|
* This config defines how to handle overlapping events. Valid values are:
|
|
541
|
-
* ...
|
|
542
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-eventLayout)
|
|
508
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-eventLayout)
|
|
543
509
|
*/
|
|
544
510
|
eventLayout ? : 'stack'|'pack'|'mixed'|'none'|EventLayoutConfig|any
|
|
545
511
|
/**
|
|
546
512
|
* An advanced setting that controls the maximum number of released event bars to keep in the DOM.
|
|
547
|
-
* ...
|
|
548
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-eventReleaseThreshold)
|
|
513
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-eventReleaseThreshold)
|
|
549
514
|
*/
|
|
550
515
|
eventReleaseThreshold ? : number
|
|
551
516
|
/**
|
|
@@ -553,30 +518,31 @@ defineProps<{
|
|
|
553
518
|
* an event is rendered into the schedule to render the contents of the event. It's called with the event,
|
|
554
519
|
* its resource and a `renderData` object which allows you to populate data placeholders inside the event
|
|
555
520
|
* template.
|
|
556
|
-
* ...
|
|
557
|
-
*
|
|
558
|
-
* @param {
|
|
559
|
-
* @param {Scheduler.model.
|
|
560
|
-
* @param {Scheduler.model.
|
|
561
|
-
* @param {Scheduler.
|
|
562
|
-
* @param {
|
|
563
|
-
* @param {
|
|
564
|
-
* @param {
|
|
565
|
-
* @param {
|
|
566
|
-
* @param {Core.helper.util.DomClassList,string}
|
|
567
|
-
* @param {Core.helper.util.DomClassList,string}
|
|
568
|
-
* @param {
|
|
569
|
-
* @param {number}
|
|
570
|
-
* @param {number}
|
|
571
|
-
* @param {
|
|
572
|
-
* @param {string,Record<string, string>}
|
|
573
|
-
* @param {
|
|
574
|
-
* @param {
|
|
575
|
-
* @param {string}
|
|
576
|
-
* @param {
|
|
521
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-eventRenderer)
|
|
522
|
+
* @param {object} context An object containing the information needed to render an Event
|
|
523
|
+
* @param {Scheduler.model.SchedulerEventModel} context.eventRecord The event record
|
|
524
|
+
* @param {Scheduler.model.SchedulerResourceModel} context.resourceRecord The resource record
|
|
525
|
+
* @param {Scheduler.model.SchedulerAssignmentModel} context.assignmentRecord The assignment record
|
|
526
|
+
* @param {Scheduler.view.Scheduler} context.scheduler The Scheduler instance
|
|
527
|
+
* @param {object} context.renderData An object containing details about the event rendering
|
|
528
|
+
* @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
|
|
529
|
+
* @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
|
|
530
|
+
* @param {Scheduler.model.SchedulerEventModel} context.renderData.event The event record
|
|
531
|
+
* @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
|
|
532
|
+
* @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.
|
|
533
|
+
* @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`
|
|
534
|
+
* @param {number} context.renderData.left Vertical offset position (in pixels) on the time axis
|
|
535
|
+
* @param {number} context.renderData.width Width in pixels of the event element
|
|
536
|
+
* @param {number} context.renderData.height Height in pixels of the event element
|
|
537
|
+
* @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' }`
|
|
538
|
+
* @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' }`
|
|
539
|
+
* @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
|
|
540
|
+
* @param {string} context.renderData.eventColor The `eventColor` of the event. Use this to set a custom color for the rendered event
|
|
541
|
+
* @param {string} context.renderData.ariaLabel A description of the event details used for screen readers
|
|
542
|
+
* @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.*
|
|
577
543
|
* @returns {string,DomConfig,DomConfig[]} A simple string, a DomConfig (or array thereof), or a JSX element when using React
|
|
578
544
|
*/
|
|
579
|
-
eventRenderer ? : (
|
|
545
|
+
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[]
|
|
580
546
|
/**
|
|
581
547
|
* `this` reference for the [eventRenderer](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/mixin/SchedulerEventRendering#config-eventRenderer) function
|
|
582
548
|
*/
|
|
@@ -597,8 +563,7 @@ defineProps<{
|
|
|
597
563
|
* Event style used by default. Events and resources can specify their own style, with priority order being:
|
|
598
564
|
* Event -> Resource -> Scheduler default. Determines the appearance of the event by assigning a CSS class
|
|
599
565
|
* to it. Available styles are:
|
|
600
|
-
* ...
|
|
601
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-eventStyle)
|
|
566
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-eventStyle)
|
|
602
567
|
*/
|
|
603
568
|
eventStyle ? : 'tonal'|'filled'|'bordered'|'traced'|'outlined'|'indented'|'line'|'dashed'|'minimal'|'rounded'|'calendar'|'interday'|'gantt'|null
|
|
604
569
|
extraData ? : any
|
|
@@ -611,16 +576,14 @@ defineProps<{
|
|
|
611
576
|
/**
|
|
612
577
|
* Specify `true` to force rendered events/tasks to fill entire ticks. This only affects rendering, start
|
|
613
578
|
* and end dates retain their value on the data level.
|
|
614
|
-
* ...
|
|
615
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-fillTicks)
|
|
579
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-fillTicks)
|
|
616
580
|
*/
|
|
617
581
|
fillTicks ? : Boolean
|
|
618
582
|
/**
|
|
619
583
|
* Use fixed row height. Setting this to `true` will configure the underlying RowManager to use fixed row
|
|
620
584
|
* height, which sacrifices the ability to use rows with variable height to gain a fraction better
|
|
621
585
|
* performance.
|
|
622
|
-
* ...
|
|
623
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-fixedRowHeight)
|
|
586
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-fixedRowHeight)
|
|
624
587
|
*/
|
|
625
588
|
fixedRowHeight ? : Boolean
|
|
626
589
|
/**
|
|
@@ -634,14 +597,12 @@ defineProps<{
|
|
|
634
597
|
/**
|
|
635
598
|
* Config object of a footer. May contain a `dock`, `html` and a `cls` property. A footer is not a widget,
|
|
636
599
|
* 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).
|
|
637
|
-
* ...
|
|
638
|
-
*
|
|
600
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-footer)
|
|
601
|
+
* @property {'top','right','bottom','left','start','end'} dock Where to dock
|
|
602
|
+
* @property {string} html Html to populate the footer with
|
|
603
|
+
* @property {string} cls CSS class to add to the footer
|
|
639
604
|
*/
|
|
640
|
-
footer ? :
|
|
641
|
-
dock?: 'top'|'right'|'bottom'|'left'|'start'|'end'
|
|
642
|
-
html?: string
|
|
643
|
-
cls?: string
|
|
644
|
-
}|string
|
|
605
|
+
footer ? : object|string
|
|
645
606
|
/**
|
|
646
607
|
* Set to `true` to force the time columns to fit to the available space (horizontal or vertical depends on mode).
|
|
647
608
|
* Note that setting [suppressFit](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/TimelineBase#config-suppressFit) to `true`, will disable `forceFit` functionality. Zooming
|
|
@@ -651,39 +612,34 @@ defineProps<{
|
|
|
651
612
|
/**
|
|
652
613
|
* An object which names formula prefixes which will be applied to all columns configured with
|
|
653
614
|
* `formula : true`.
|
|
654
|
-
* ...
|
|
655
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-formulaProviders)
|
|
615
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-formulaProviders)
|
|
656
616
|
*/
|
|
657
617
|
formulaProviders ? : Record<string, FormulaProviderConfig>
|
|
658
618
|
/**
|
|
659
619
|
* Refresh entire row when a record changes (`true`) or, if possible, only the cells affected (`false`).
|
|
660
|
-
* ...
|
|
661
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-fullRowRefresh)
|
|
620
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-fullRowRefresh)
|
|
662
621
|
*/
|
|
663
622
|
fullRowRefresh ? : Boolean
|
|
664
623
|
/**
|
|
665
624
|
* A method allowing you to define date boundaries that will constrain resize, create and drag drop
|
|
666
625
|
* operations. The method will be called with the Resource record, and the Event record.
|
|
667
|
-
* ...
|
|
668
|
-
* [
|
|
669
|
-
* @param {Scheduler.model.
|
|
670
|
-
* @param {Scheduler.model.SchedulerEventModel} eventRecord The event record
|
|
626
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-getDateConstraints)
|
|
627
|
+
* @param {Scheduler.model.SchedulerResourceModel} [resourceRecord] The resource record
|
|
628
|
+
* @param {Scheduler.model.SchedulerEventModel} [eventRecord] The event record
|
|
671
629
|
* @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.
|
|
672
630
|
*/
|
|
673
|
-
getDateConstraints ? : (resourceRecord
|
|
631
|
+
getDateConstraints ? : (resourceRecord: SchedulerResourceModel, eventRecord: SchedulerEventModel) => DateConstraint
|
|
674
632
|
/**
|
|
675
633
|
* Scheduler overrides Grid's default implementation of [getRowHeight](https://bryntum.com/products/schedulerpro/docs/api/Grid/view/GridBase#config-getRowHeight) to
|
|
676
634
|
* pre-calculate row heights based on events in the rows.
|
|
677
|
-
* ...
|
|
678
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-getRowHeight)
|
|
635
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-getRowHeight)
|
|
679
636
|
* @param {Scheduler.model.SchedulerResourceModel} getRowHeight.record Resource record to determine row height for
|
|
680
637
|
* @returns {number} Desired row height
|
|
681
638
|
*/
|
|
682
|
-
getRowHeight ? : (
|
|
639
|
+
getRowHeight ? : () => number
|
|
683
640
|
/**
|
|
684
641
|
* 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`.
|
|
685
|
-
* ...
|
|
686
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-header)
|
|
642
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-header)
|
|
687
643
|
*/
|
|
688
644
|
header ? : string|Boolean|PanelHeader
|
|
689
645
|
/**
|
|
@@ -710,8 +666,7 @@ defineProps<{
|
|
|
710
666
|
hideHorizontalScrollbar ? : Boolean
|
|
711
667
|
/**
|
|
712
668
|
* By default the row hover effect is not visible in the Scheduler part of the grid.
|
|
713
|
-
* ...
|
|
714
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-hideRowHover)
|
|
669
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-hideRowHover)
|
|
715
670
|
*/
|
|
716
671
|
hideRowHover ? : Boolean
|
|
717
672
|
/**
|
|
@@ -742,15 +697,13 @@ defineProps<{
|
|
|
742
697
|
ignoreDomEventsWhileScrolling ? : Boolean
|
|
743
698
|
/**
|
|
744
699
|
* Determines if the widgets read-only state should be controlled by its parent.
|
|
745
|
-
* ...
|
|
746
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-ignoreParentReadOnly)
|
|
700
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-ignoreParentReadOnly)
|
|
747
701
|
*/
|
|
748
702
|
ignoreParentReadOnly ? : Boolean
|
|
749
703
|
/**
|
|
750
704
|
* Set to `true` to automatically adjust the panel timespan during scrolling in the time dimension,
|
|
751
705
|
* when the scroller comes close to the start/end edges.
|
|
752
|
-
* ...
|
|
753
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-infiniteScroll)
|
|
706
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-infiniteScroll)
|
|
754
707
|
*/
|
|
755
708
|
infiniteScroll ? : Boolean
|
|
756
709
|
/**
|
|
@@ -765,8 +718,7 @@ defineProps<{
|
|
|
765
718
|
* Convenience setting to align input fields of child widgets. By default, the Field input element is
|
|
766
719
|
* placed immediately following the `label`. If you prefer to have all input fields aligned to the
|
|
767
720
|
* right, set this config to `'end'`.
|
|
768
|
-
* ...
|
|
769
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-inputFieldAlign)
|
|
721
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-inputFieldAlign)
|
|
770
722
|
*/
|
|
771
723
|
inputFieldAlign ? : 'start'|'end'
|
|
772
724
|
/**
|
|
@@ -779,8 +731,7 @@ defineProps<{
|
|
|
779
731
|
insertFirst ? : HTMLElement|string
|
|
780
732
|
/**
|
|
781
733
|
* A template method (empty by default) allowing you to control if an event can be selected or not.
|
|
782
|
-
* ...
|
|
783
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-isEventSelectable)
|
|
734
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-isEventSelectable)
|
|
784
735
|
* @param {Scheduler.model.SchedulerEventModel} event The event record
|
|
785
736
|
* @returns {boolean} true if event can be selected, otherwise false
|
|
786
737
|
*/
|
|
@@ -791,10 +742,14 @@ defineProps<{
|
|
|
791
742
|
keyMap ? : Record<string, KeyMapConfig>
|
|
792
743
|
/**
|
|
793
744
|
* Convenience setting to use same label placement on all child widgets.
|
|
794
|
-
* ...
|
|
795
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-labelPosition)
|
|
745
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-labelPosition)
|
|
796
746
|
*/
|
|
797
747
|
labelPosition ? : 'before'|'above'|'align-before'|'auto'|null
|
|
748
|
+
/**
|
|
749
|
+
* Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
|
|
750
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-labelWidth)
|
|
751
|
+
*/
|
|
752
|
+
labelWidth ? : number|null
|
|
798
753
|
/**
|
|
799
754
|
* By default, when the `EventStore` (and similar stores) is lazy loading, a loading indicator will be displayed
|
|
800
755
|
* just below the timeline headers. Set this to `false` to prevent this indicator being shown.
|
|
@@ -802,14 +757,12 @@ defineProps<{
|
|
|
802
757
|
lazyLoadingIndicator ? : Boolean
|
|
803
758
|
/**
|
|
804
759
|
* The listener set for this object.
|
|
805
|
-
* ...
|
|
806
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-listeners)
|
|
760
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-listeners)
|
|
807
761
|
*/
|
|
808
762
|
listeners ? : SchedulerProBaseListeners
|
|
809
763
|
/**
|
|
810
764
|
* *This property is for use when the Scheduler is used as a Calendar view - a `mode`.*
|
|
811
|
-
* ...
|
|
812
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-listRangeMenu)
|
|
765
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-listRangeMenu)
|
|
813
766
|
*/
|
|
814
767
|
listRangeMenu ? : MenuConfig
|
|
815
768
|
/**
|
|
@@ -822,15 +775,13 @@ defineProps<{
|
|
|
822
775
|
* when data is loading. The message and optional configuration from the
|
|
823
776
|
* [loadMask](https://bryntum.com/products/schedulerpro/docs/api/Core/mixin/LoadMaskable#config-loadMask) config take priority over these options, just as they do
|
|
824
777
|
* for `maskDefaults`, respectively.
|
|
825
|
-
* ...
|
|
826
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-loadMaskDefaults)
|
|
778
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-loadMaskDefaults)
|
|
827
779
|
*/
|
|
828
780
|
loadMaskDefaults ? : MaskConfig
|
|
829
781
|
/**
|
|
830
782
|
* A [Mask](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Mask) config object to adjust the [maskDefaults](#Core/widget/Widget#config-maskDefaults)
|
|
831
783
|
* when an error occurs loading data.
|
|
832
|
-
* ...
|
|
833
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-loadMaskError)
|
|
784
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-loadMaskError)
|
|
834
785
|
*/
|
|
835
786
|
loadMaskError ? : MaskConfig|Mask|Boolean
|
|
836
787
|
/**
|
|
@@ -849,8 +800,7 @@ defineProps<{
|
|
|
849
800
|
/**
|
|
850
801
|
* When `true`, events are sized and positioned based on rowHeight, resourceMargin and barMargin settings.
|
|
851
802
|
* Set this to `false` if you want to control height and vertical position using CSS instead.
|
|
852
|
-
* ...
|
|
853
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-managedEventSizing)
|
|
803
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-managedEventSizing)
|
|
854
804
|
*/
|
|
855
805
|
managedEventSizing ? : Boolean
|
|
856
806
|
/**
|
|
@@ -881,8 +831,7 @@ defineProps<{
|
|
|
881
831
|
/**
|
|
882
832
|
* The maximum time axis unit to display non-working ranges for ('hour' or 'day' etc).
|
|
883
833
|
* When zooming to a view with a larger unit, no non-working time elements will be rendered.
|
|
884
|
-
* ...
|
|
885
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-maxTimeAxisUnit)
|
|
834
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-maxTimeAxisUnit)
|
|
886
835
|
*/
|
|
887
836
|
maxTimeAxisUnit ? : DurationUnit
|
|
888
837
|
/**
|
|
@@ -891,17 +840,14 @@ defineProps<{
|
|
|
891
840
|
*/
|
|
892
841
|
maxWidth ? : string|number
|
|
893
842
|
/**
|
|
894
|
-
* The maximum zoom level to which [zoomIn](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomIn) will work.
|
|
895
|
-
* [
|
|
896
|
-
* for information. Unless you have modified the collection of available presets, the max zoom level is
|
|
897
|
-
* milliseconds.
|
|
843
|
+
* The maximum zoom level to which [zoomIn](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomIn) will work.
|
|
844
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-maxZoomLevel)
|
|
898
845
|
*/
|
|
899
|
-
maxZoomLevel ? : number
|
|
846
|
+
maxZoomLevel ? : number|string
|
|
900
847
|
/**
|
|
901
848
|
* How to align milestones in relation to their startDate. Only applies when using a `milestoneLayoutMode`
|
|
902
849
|
* other than `default`. Valid values are:
|
|
903
|
-
* ...
|
|
904
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-milestoneAlign)
|
|
850
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-milestoneAlign)
|
|
905
851
|
*/
|
|
906
852
|
milestoneAlign ? : 'start'|'center'|'end'
|
|
907
853
|
/**
|
|
@@ -912,14 +858,12 @@ defineProps<{
|
|
|
912
858
|
/**
|
|
913
859
|
* How to handle milestones during event layout. How the milestones are displayed when part of the layout
|
|
914
860
|
* are controlled using [milestoneTextPosition](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/mixin/SchedulerEventRendering#config-milestoneTextPosition).
|
|
915
|
-
* ...
|
|
916
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-milestoneLayoutMode)
|
|
861
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-milestoneLayoutMode)
|
|
917
862
|
*/
|
|
918
863
|
milestoneLayoutMode ? : 'default'|'estimate'|'data'|'measure'
|
|
919
864
|
/**
|
|
920
865
|
* Position of the milestone text:
|
|
921
|
-
* ...
|
|
922
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-milestoneTextPosition)
|
|
866
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-milestoneTextPosition)
|
|
923
867
|
*/
|
|
924
868
|
milestoneTextPosition ? : 'inside'|'outside'|'always-outside'
|
|
925
869
|
/**
|
|
@@ -931,16 +875,14 @@ defineProps<{
|
|
|
931
875
|
/**
|
|
932
876
|
* Grid's `min-height`. Defaults to `10em` to be sure that the Grid always has a height wherever it is
|
|
933
877
|
* inserted.
|
|
934
|
-
* ...
|
|
935
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-minHeight)
|
|
878
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-minHeight)
|
|
936
879
|
*/
|
|
937
880
|
minHeight ? : string|number
|
|
938
881
|
/**
|
|
939
882
|
* *Experimental* Minimum size that events should be allowed to shrink to when using `pack` layout. If
|
|
940
883
|
* packing leads to any event being smaller than this value, the row will grow in height instead to maintain
|
|
941
884
|
* this minimum size.
|
|
942
|
-
* ...
|
|
943
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-minPackSize)
|
|
885
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-minPackSize)
|
|
944
886
|
*/
|
|
945
887
|
minPackSize ? : number
|
|
946
888
|
/**
|
|
@@ -949,9 +891,10 @@ defineProps<{
|
|
|
949
891
|
*/
|
|
950
892
|
minWidth ? : string|number
|
|
951
893
|
/**
|
|
952
|
-
* The minimum zoom level to which [zoomOut](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomOut) will work.
|
|
894
|
+
* The minimum zoom level to which [zoomOut](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomOut) will work.
|
|
895
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-minZoomLevel)
|
|
953
896
|
*/
|
|
954
|
-
minZoomLevel ? : number
|
|
897
|
+
minZoomLevel ? : number|string
|
|
955
898
|
/**
|
|
956
899
|
* Scheduler mode. Supported values: horizontal, vertical
|
|
957
900
|
*/
|
|
@@ -962,27 +905,23 @@ defineProps<{
|
|
|
962
905
|
monitorResize ? : Boolean
|
|
963
906
|
/**
|
|
964
907
|
* Configure as `true` to allow `CTRL/CMD+click` to select multiple events in the scheduler.
|
|
965
|
-
* ...
|
|
966
|
-
* [
|
|
908
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-multiEventSelect)
|
|
909
|
+
* @property {boolean} [ctrlKey] Set to `true` to use <kbd>Ctrl</kbd> key for multi selection (<kbd>Cmd</kbd> on Mac).
|
|
910
|
+
* @property {boolean} [altKey] Set to `true` to use <kbd>Alt</kbd> key for multi selection (<kbd>Option</kbd> on Mac)
|
|
911
|
+
* @property {boolean} [shiftKey] Set to `true` to use <kbd>Shift</kbd> key for multi selection
|
|
967
912
|
*/
|
|
968
|
-
multiEventSelect ? : Boolean|
|
|
969
|
-
ctrlKey?: Boolean
|
|
970
|
-
altKey?: Boolean
|
|
971
|
-
shiftKey?: Boolean
|
|
972
|
-
}
|
|
913
|
+
multiEventSelect ? : Boolean|object
|
|
973
914
|
/**
|
|
974
915
|
* When an event bar has a width less than this value, it gets the CSS class `b-sch-event-narrow`
|
|
975
916
|
* added. You may apply custom CSS rules using this class.
|
|
976
|
-
* ...
|
|
977
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-narrowEventWidth)
|
|
917
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-narrowEventWidth)
|
|
978
918
|
*/
|
|
979
919
|
narrowEventWidth ? : number
|
|
980
920
|
/**
|
|
981
921
|
* Override this method to provide a custom sort function to sort any overlapping events. This only applies
|
|
982
922
|
* to the horizontal mode, where the order the events are sorted in determines their vertical placement
|
|
983
923
|
* within a resource.
|
|
984
|
-
* ...
|
|
985
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-overlappingEventSorter)
|
|
924
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-overlappingEventSorter)
|
|
986
925
|
* @param {Scheduler.model.SchedulerEventModel} a First event
|
|
987
926
|
* @param {Scheduler.model.SchedulerEventModel} b Second event
|
|
988
927
|
* @returns {number} Return -1 to display `a` above `b`, 1 for `b` above `a`
|
|
@@ -991,26 +930,23 @@ defineProps<{
|
|
|
991
930
|
/**
|
|
992
931
|
* Partners this Timeline panel with another Timeline in order to sync their region sizes (sub-grids like locked, normal will get the same width),
|
|
993
932
|
* start and end dates, view preset, zoom level and scrolling position. All these values will be synced with the timeline defined as the `partner`.
|
|
994
|
-
* ...
|
|
995
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-partner)
|
|
933
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-partner)
|
|
996
934
|
*/
|
|
997
935
|
partner ? : TimelineBase|string
|
|
998
936
|
/**
|
|
999
937
|
* Set to `true` to include `startDate` and `endDate` params indicating the currently viewed date range in
|
|
1000
938
|
* `EventStore` load requests (when loading using `AjaxStore` or `CrudManager` functionality).
|
|
1001
|
-
* ...
|
|
1002
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-passStartEndParameters)
|
|
939
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-passStartEndParameters)
|
|
1003
940
|
*/
|
|
1004
941
|
passStartEndParameters ? : Boolean
|
|
1005
942
|
/**
|
|
1006
943
|
* Specify plugins (an array of classes) in config
|
|
1007
944
|
*/
|
|
1008
|
-
plugins ? :
|
|
945
|
+
plugins ? : InstancePlugin[]|InstancePlugin
|
|
1009
946
|
/**
|
|
1010
947
|
* Maximum number of resources for which height is pre-calculated. If you have many events per
|
|
1011
948
|
* resource you might want to lower this number to gain some initial rendering performance.
|
|
1012
|
-
* ...
|
|
1013
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-preCalculateHeightLimit)
|
|
949
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-preCalculateHeightLimit)
|
|
1014
950
|
*/
|
|
1015
951
|
preCalculateHeightLimit ? : number
|
|
1016
952
|
/**
|
|
@@ -1028,10 +964,9 @@ defineProps<{
|
|
|
1028
964
|
*/
|
|
1029
965
|
preserveScrollOnDatasetChange ? : Boolean
|
|
1030
966
|
/**
|
|
1031
|
-
* An array of [ViewPreset](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/preset/ViewPreset) config objects
|
|
1032
|
-
*
|
|
1033
|
-
* ...
|
|
1034
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-presets)
|
|
967
|
+
* An array of [ViewPreset](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/preset/ViewPreset) config objects which describes the available timeline layouts
|
|
968
|
+
* for this scheduler.
|
|
969
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-presets)
|
|
1035
970
|
*/
|
|
1036
971
|
presets ? : ViewPresetConfig[]
|
|
1037
972
|
/**
|
|
@@ -1045,50 +980,51 @@ defineProps<{
|
|
|
1045
980
|
project ? : ProjectModel|ProjectModelConfig|object
|
|
1046
981
|
/**
|
|
1047
982
|
* Accepts the following values:
|
|
1048
|
-
* ...
|
|
1049
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-projectProgressReporting)
|
|
983
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-projectProgressReporting)
|
|
1050
984
|
*/
|
|
1051
985
|
projectProgressReporting ? : string|null
|
|
1052
986
|
/**
|
|
1053
987
|
* Range used to set the length of the time axis when used as a component of a Calendar. Suitable units are
|
|
1054
988
|
* `'month'`, `'week'` and `'day'`.
|
|
1055
|
-
* ...
|
|
1056
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-range)
|
|
989
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-range)
|
|
1057
990
|
*/
|
|
1058
991
|
range ? : string|DurationConfig
|
|
1059
992
|
/**
|
|
1060
993
|
* Configure as `true` to make the scheduler read-only, by disabling any UIs for modifying data.
|
|
1061
|
-
* ...
|
|
1062
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-readOnly)
|
|
994
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-readOnly)
|
|
1063
995
|
*/
|
|
1064
996
|
readOnly ? : Boolean
|
|
1065
997
|
/**
|
|
1066
998
|
* The confirmation dialog shown when a recurring event is edited.
|
|
1067
|
-
* ...
|
|
1068
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-recurrenceConfirmationPopup)
|
|
999
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-recurrenceConfirmationPopup)
|
|
1069
1000
|
*/
|
|
1070
|
-
recurrenceConfirmationPopup ? : RecurrenceConfirmationPopupConfig
|
|
1001
|
+
recurrenceConfirmationPopup ? : RecurrenceConfirmationPopupConfig
|
|
1071
1002
|
relayStoreEvents ? : Boolean
|
|
1072
1003
|
/**
|
|
1073
1004
|
* Either a default `rendition` to apply to all child widgets, or a map of renditions keyed by child widget
|
|
1074
1005
|
* `type`.
|
|
1075
|
-
* ...
|
|
1076
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-rendition)
|
|
1006
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-rendition)
|
|
1077
1007
|
*/
|
|
1078
1008
|
rendition ? : string|Record<string, string>|null
|
|
1079
1009
|
/**
|
|
1080
1010
|
* Configure this property to allow the widget/component to be resized. Pressing <kbd>Shift</kbd> while resizing will
|
|
1081
1011
|
* constrain the aspect ratio.
|
|
1082
|
-
* ...
|
|
1083
|
-
* [
|
|
1084
|
-
|
|
1085
|
-
|
|
1086
|
-
|
|
1087
|
-
|
|
1088
|
-
|
|
1089
|
-
|
|
1090
|
-
|
|
1091
|
-
|
|
1012
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-resizable)
|
|
1013
|
+
* @property {number} [resizable.minWidth] The minimum width of the element.
|
|
1014
|
+
* @property {number} [resizable.maxWidth] The maximum width of the element.
|
|
1015
|
+
* @property {number} [resizable.minHeight] The minimum height of the element.
|
|
1016
|
+
* @property {number} [resizable.maxHeight] The maximum height of the element
|
|
1017
|
+
* @property {object} [resizable.handles] An object controlling which edges/corners are resizable.
|
|
1018
|
+
* @property {boolean} [resizable.handles.topStart] Resizable from top-start corner
|
|
1019
|
+
* @property {boolean} [resizable.handles.top] Resizable from top edge
|
|
1020
|
+
* @property {boolean} [resizable.handles.topEnd] Resizable from top-end corner
|
|
1021
|
+
* @property {boolean} [resizable.handles.end] Resizable from end edge
|
|
1022
|
+
* @property {boolean} [resizable.handles.bottomEnd] Resizable from bottom-end corner
|
|
1023
|
+
* @property {boolean} [resizable.handles.bottom] Resizable from bottom edge
|
|
1024
|
+
* @property {boolean} [resizable.handles.bottomStart] Resizable from bottom-start corner
|
|
1025
|
+
* @property {boolean} [resizable.handles.start] Resizable from start edge
|
|
1026
|
+
*/
|
|
1027
|
+
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 } }
|
|
1092
1028
|
/**
|
|
1093
1029
|
* Set to `false` to only measure cell contents when double-clicking the edge between column headers.
|
|
1094
1030
|
*/
|
|
@@ -1096,8 +1032,7 @@ defineProps<{
|
|
|
1096
1032
|
/**
|
|
1097
1033
|
* A config object used to configure the resource columns in vertical mode.
|
|
1098
1034
|
* See [ResourceHeader](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/ResourceHeader) for more details on available properties.
|
|
1099
|
-
* ...
|
|
1100
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-resourceColumns)
|
|
1035
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-resourceColumns)
|
|
1101
1036
|
*/
|
|
1102
1037
|
resourceColumns ? : ResourceHeaderConfig
|
|
1103
1038
|
/**
|
|
@@ -1108,25 +1043,21 @@ defineProps<{
|
|
|
1108
1043
|
* Path to load resource images from. Used by the resource header in vertical mode and the
|
|
1109
1044
|
* [ResourceInfoColumn](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/column/ResourceInfoColumn) in horizontal mode. Set this to display miniature
|
|
1110
1045
|
* images for each resource using their `image` or `imageUrl` fields.
|
|
1111
|
-
* ...
|
|
1112
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-resourceImagePath)
|
|
1046
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-resourceImagePath)
|
|
1113
1047
|
*/
|
|
1114
1048
|
resourceImagePath ? : string
|
|
1115
1049
|
/**
|
|
1116
1050
|
* 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).
|
|
1117
|
-
* ...
|
|
1118
|
-
*
|
|
1051
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-resourceImages)
|
|
1052
|
+
* @property {string} path Path to load resource images from
|
|
1053
|
+
* @property {string} extension Resource image extension
|
|
1119
1054
|
*/
|
|
1120
|
-
resourceImages ? :
|
|
1121
|
-
path?: string
|
|
1122
|
-
extension?: string
|
|
1123
|
-
}
|
|
1055
|
+
resourceImages ? : object
|
|
1124
1056
|
/**
|
|
1125
1057
|
* Control how much space to leave between the first event/last event and the resources edge (top/bottom
|
|
1126
1058
|
* margin within the resource row in horizontal mode, left/right margin within the resource column in
|
|
1127
1059
|
* vertical mode), in px. Defaults to the value of [barMargin](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/Scheduler#config-barMargin).
|
|
1128
|
-
* ...
|
|
1129
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-resourceMargin)
|
|
1060
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-resourceMargin)
|
|
1130
1061
|
*/
|
|
1131
1062
|
resourceMargin ? : number|ResourceMarginConfig
|
|
1132
1063
|
/**
|
|
@@ -1141,8 +1072,7 @@ defineProps<{
|
|
|
1141
1072
|
* An empty function by default, but provided so that you can override it. This function is called each time
|
|
1142
1073
|
* a resource time range is rendered into the schedule. It's called with `resourceTimeRangeRecord`, `resourceRecord`,
|
|
1143
1074
|
* and `renderData` params.
|
|
1144
|
-
* ...
|
|
1145
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-resourceTimeRangeRenderer)
|
|
1075
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-resourceTimeRangeRenderer)
|
|
1146
1076
|
* @param {object} detail An object containing the information needed to render a ResourceTimeRangeModel.
|
|
1147
1077
|
* @param {Scheduler.model.ResourceTimeRangeModel} detail.resourceTimeRangeRecord The resource time range record.
|
|
1148
1078
|
* @param {Scheduler.model.SchedulerResourceModel} detail.resourceRecord The resource record.
|
|
@@ -1161,23 +1091,26 @@ defineProps<{
|
|
|
1161
1091
|
resourceTimeRangeStore ? : ResourceTimeRangeStore|ResourceTimeRangeStoreConfig
|
|
1162
1092
|
/**
|
|
1163
1093
|
* "Break points" for which responsive config to use.
|
|
1164
|
-
* ...
|
|
1165
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-responsiveLevels)
|
|
1094
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-responsiveLevels)
|
|
1166
1095
|
*/
|
|
1167
1096
|
responsiveLevels ? : Record<string, number|string|SchedulerResponsiveLevelConfig>
|
|
1168
1097
|
/**
|
|
1169
1098
|
* Configure as `true` to have the component display a translucent ripple when its
|
|
1170
1099
|
* [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
|
|
1171
1100
|
* current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
|
|
1172
|
-
* ...
|
|
1173
|
-
* [
|
|
1101
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-ripple)
|
|
1102
|
+
* @property {string} [delegate] A CSS selector to filter which child elements trigger ripples. By default, the ripple is clipped to the triggering element.
|
|
1103
|
+
* @property {string} [color] A CSS color name or specification.
|
|
1104
|
+
* @property {number} [radius] The ending radius of the ripple. Note that it will be clipped by the target element by default.
|
|
1105
|
+
* @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.
|
|
1174
1106
|
*/
|
|
1175
|
-
ripple ? : Boolean|
|
|
1176
|
-
|
|
1177
|
-
|
|
1178
|
-
|
|
1179
|
-
|
|
1180
|
-
|
|
1107
|
+
ripple ? : Boolean|object
|
|
1108
|
+
/**
|
|
1109
|
+
* The ARIA role to apply to this widget's element. By default, this is set to `'presentation'` to avoid
|
|
1110
|
+
* accidentally applying a role which may interfere with screen readers.
|
|
1111
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-role)
|
|
1112
|
+
*/
|
|
1113
|
+
role ? : string
|
|
1181
1114
|
/**
|
|
1182
1115
|
* 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`
|
|
1183
1116
|
*/
|
|
@@ -1192,21 +1125,18 @@ defineProps<{
|
|
|
1192
1125
|
rowLines ? : Boolean
|
|
1193
1126
|
/**
|
|
1194
1127
|
* This may be configured as `true` to make the widget's element use the `direction:rtl` style.
|
|
1195
|
-
* ...
|
|
1196
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-rtl)
|
|
1128
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-rtl)
|
|
1197
1129
|
*/
|
|
1198
1130
|
rtl ? : Boolean
|
|
1199
1131
|
/**
|
|
1200
1132
|
* Class implementing the popup resolving *scheduling conflicts* and *calendar misconfigurations*.
|
|
1201
|
-
* ...
|
|
1202
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-schedulingIssueResolutionPopupClass)
|
|
1133
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-schedulingIssueResolutionPopupClass)
|
|
1203
1134
|
*/
|
|
1204
1135
|
schedulingIssueResolutionPopupClass ? : typeof SchedulingIssueResolutionPopup
|
|
1205
1136
|
/**
|
|
1206
1137
|
* Configures whether the grid is scrollable in the `Y` axis. This is used to configure a [Scroller](https://bryntum.com/products/schedulerpro/docs/api/Core/helper/util/Scroller).
|
|
1207
1138
|
* See the [scrollerClass](https://bryntum.com/products/schedulerpro/docs/api/Grid/view/GridBase#config-scrollerClass) config option.
|
|
1208
|
-
* ...
|
|
1209
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-scrollable)
|
|
1139
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-scrollable)
|
|
1210
1140
|
*/
|
|
1211
1141
|
scrollable ? : Boolean|ScrollerConfig|Scroller
|
|
1212
1142
|
/**
|
|
@@ -1216,8 +1146,7 @@ defineProps<{
|
|
|
1216
1146
|
/**
|
|
1217
1147
|
* Specifies the maximum duration for extending the current [TimeSpan](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/model/TimeSpan) to allow for smooth
|
|
1218
1148
|
* scrolling to an event.
|
|
1219
|
-
* ...
|
|
1220
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-scrollExtensionThreshold)
|
|
1149
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-scrollExtensionThreshold)
|
|
1221
1150
|
*/
|
|
1222
1151
|
scrollExtensionThreshold ? : string|DurationConfig
|
|
1223
1152
|
/**
|
|
@@ -1228,8 +1157,7 @@ defineProps<{
|
|
|
1228
1157
|
/**
|
|
1229
1158
|
* Selection configuration settings, change these properties to control how selection works and what can be
|
|
1230
1159
|
* selected.
|
|
1231
|
-
* ...
|
|
1232
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-selectionMode)
|
|
1160
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-selectionMode)
|
|
1233
1161
|
*/
|
|
1234
1162
|
selectionMode ? : GridSelectionMode
|
|
1235
1163
|
/**
|
|
@@ -1241,11 +1169,9 @@ defineProps<{
|
|
|
1241
1169
|
*/
|
|
1242
1170
|
selectResourceOnScheduleClick ? : Boolean
|
|
1243
1171
|
/**
|
|
1244
|
-
* <div class="note">This property is for use when the Scheduler is used as a Calendar view - a `mode
|
|
1245
|
-
*
|
|
1246
|
-
*
|
|
1247
|
-
* ...
|
|
1248
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-shiftIncrement)
|
|
1172
|
+
* <div class="note">This property is for use when the Scheduler is used as a Calendar view - a `mode` - it will have no
|
|
1173
|
+
* effect on a Scheduler which is not inside a Calendar.</div>
|
|
1174
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-shiftIncrement)
|
|
1249
1175
|
*/
|
|
1250
1176
|
shiftIncrement ? : string|DurationConfig
|
|
1251
1177
|
/**
|
|
@@ -1255,13 +1181,11 @@ defineProps<{
|
|
|
1255
1181
|
/**
|
|
1256
1182
|
* Configure as `true` to have the grid show a red "changed" tag in cells whose
|
|
1257
1183
|
* field value has changed and not yet been committed.
|
|
1258
|
-
* ...
|
|
1259
|
-
*
|
|
1184
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-showDirty)
|
|
1185
|
+
* @property {boolean} showDirty.duringEdit Set to `true` to show the red tag while editing a cell
|
|
1186
|
+
* @property {boolean} showDirty.newRecord Set to `true` to show the red tag for all the cells of the new record
|
|
1260
1187
|
*/
|
|
1261
|
-
showDirty ? : Boolean|{
|
|
1262
|
-
duringEdit?: Boolean
|
|
1263
|
-
newRecord?: Boolean
|
|
1264
|
-
}
|
|
1188
|
+
showDirty ? : Boolean|{ duringEdit: Boolean, newRecord: Boolean }
|
|
1265
1189
|
/**
|
|
1266
1190
|
* 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
|
|
1267
1191
|
* 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
|
|
@@ -1292,17 +1216,25 @@ defineProps<{
|
|
|
1292
1216
|
* Set to `true` to show a tooltip when hovering a dependency line
|
|
1293
1217
|
*/
|
|
1294
1218
|
showTooltip ? : Boolean
|
|
1219
|
+
/**
|
|
1220
|
+
* When `true`, all zoom operations ([zoomIn](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomIn),
|
|
1221
|
+
* [zoomOut](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomOut),
|
|
1222
|
+
* [zoomInFull](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomInFull),
|
|
1223
|
+
* [zoomOutFull](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomOutFull)) will use the smooth zoom system instead
|
|
1224
|
+
* of jumping between discrete preset levels. This provides finer-grained control over zoom levels by
|
|
1225
|
+
* interpolating tick sizes between presets.
|
|
1226
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-smoothZoom)
|
|
1227
|
+
*/
|
|
1228
|
+
smoothZoom ? : Boolean
|
|
1295
1229
|
/**
|
|
1296
1230
|
* Set to `true` to snap to the current time resolution increment while interacting with scheduled events.
|
|
1297
|
-
* ...
|
|
1298
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-snap)
|
|
1231
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-snap)
|
|
1299
1232
|
*/
|
|
1300
1233
|
snap ? : Boolean
|
|
1301
1234
|
/**
|
|
1302
1235
|
* Affects drag drop and resizing of events when [snap](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/mixin/TimelineDateMapper#config-snap)
|
|
1303
1236
|
* is enabled.
|
|
1304
|
-
* ...
|
|
1305
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-snapRelativeToEventStartDate)
|
|
1237
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-snapRelativeToEventStartDate)
|
|
1306
1238
|
*/
|
|
1307
1239
|
snapRelativeToEventStartDate ? : Boolean
|
|
1308
1240
|
/**
|
|
@@ -1311,8 +1243,7 @@ defineProps<{
|
|
|
1311
1243
|
span ? : number
|
|
1312
1244
|
/**
|
|
1313
1245
|
* The start date of the timeline (if not configure with [infiniteScroll](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/TimelineBase#config-infiniteScroll)).
|
|
1314
|
-
* ...
|
|
1315
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-startDate)
|
|
1246
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-startDate)
|
|
1316
1247
|
*/
|
|
1317
1248
|
startDate ? : Date|string
|
|
1318
1249
|
/**
|
|
@@ -1321,40 +1252,34 @@ defineProps<{
|
|
|
1321
1252
|
startParamName ? : string
|
|
1322
1253
|
/**
|
|
1323
1254
|
* This value can be one of the following:
|
|
1324
|
-
* ...
|
|
1325
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-stateful)
|
|
1255
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-stateful)
|
|
1326
1256
|
*/
|
|
1327
1257
|
stateful ? : Boolean|object|string[]
|
|
1328
1258
|
/**
|
|
1329
1259
|
* The events that, when fired by this component, should trigger it to save its state by calling
|
|
1330
1260
|
* [saveState](https://bryntum.com/products/schedulerpro/docs/api/Core/mixin/State#function-saveState).
|
|
1331
|
-
* ...
|
|
1332
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-statefulEvents)
|
|
1261
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-statefulEvents)
|
|
1333
1262
|
*/
|
|
1334
1263
|
statefulEvents ? : object|string[]
|
|
1335
1264
|
/**
|
|
1336
1265
|
* 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
|
|
1337
1266
|
* 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)
|
|
1338
1267
|
* (if explicitly specified) will be used as the `stateId`.
|
|
1339
|
-
* ...
|
|
1340
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-stateId)
|
|
1268
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-stateId)
|
|
1341
1269
|
*/
|
|
1342
1270
|
stateId ? : string
|
|
1343
1271
|
/**
|
|
1344
1272
|
* 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`
|
|
1345
1273
|
* will be saved using the [default state provider](https://bryntum.com/products/schedulerpro/docs/api/Core/state/StateProvider#property-instance-static).
|
|
1346
|
-
* ...
|
|
1347
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-stateProvider)
|
|
1274
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-stateProvider)
|
|
1348
1275
|
*/
|
|
1349
1276
|
stateProvider ? : StateProvider
|
|
1350
1277
|
/**
|
|
1351
1278
|
* The properties of this settings object controls how grid is restored from state data.
|
|
1352
|
-
* ...
|
|
1353
|
-
* [
|
|
1279
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-stateSettings)
|
|
1280
|
+
* @property {boolean} [restoreUnconfiguredColumns] Determines whether to restore columns from the state that are not explicitly defined in the grid configuration.
|
|
1354
1281
|
*/
|
|
1355
|
-
stateSettings ? :
|
|
1356
|
-
restoreUnconfiguredColumns?: Boolean
|
|
1357
|
-
}
|
|
1282
|
+
stateSettings ? : object
|
|
1358
1283
|
/**
|
|
1359
1284
|
* When set, the text in the major time axis header sticks in the scrolling viewport as long as possible.
|
|
1360
1285
|
*/
|
|
@@ -1362,24 +1287,21 @@ defineProps<{
|
|
|
1362
1287
|
/**
|
|
1363
1288
|
* Store that holds records to display in the grid, or a store config object. If the configuration contains
|
|
1364
1289
|
* a `readUrl`, an `AjaxStore` will be created.
|
|
1365
|
-
* ...
|
|
1366
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-store)
|
|
1290
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-store)
|
|
1367
1291
|
*/
|
|
1368
1292
|
store ? : Store|StoreConfig|AjaxStore|AjaxStoreConfig
|
|
1369
1293
|
/**
|
|
1370
1294
|
* An object containing widgets keyed by name. By default (when no `type` is given), strips are
|
|
1371
1295
|
* [toolbars](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Toolbar). If you want to pass an array, you can use
|
|
1372
1296
|
* the toolbar's [items](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Container#config-items).
|
|
1373
|
-
* ...
|
|
1374
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-strips)
|
|
1297
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-strips)
|
|
1375
1298
|
*/
|
|
1376
1299
|
strips ? : Record<string, SchedulerProContainerItemConfig>
|
|
1377
1300
|
/**
|
|
1378
1301
|
* An object containing sub grid configuration objects keyed by a `region` property.
|
|
1379
1302
|
* By default, grid has a 'locked' region (if configured with locked columns) and a 'normal' region.
|
|
1380
1303
|
* The 'normal' region defaults to use `flex: 1`.
|
|
1381
|
-
* ...
|
|
1382
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-subGridConfigs)
|
|
1304
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-subGridConfigs)
|
|
1383
1305
|
*/
|
|
1384
1306
|
subGridConfigs ? : Record<string, SubGridConfig>
|
|
1385
1307
|
/**
|
|
@@ -1390,31 +1312,27 @@ defineProps<{
|
|
|
1390
1312
|
/**
|
|
1391
1313
|
* A [Mask](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Mask) config object, or a message to be shown when Crud Manager
|
|
1392
1314
|
* is persisting changes on the server. Set to `null` to disable default sync mask.
|
|
1393
|
-
* ...
|
|
1394
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-syncMask)
|
|
1315
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-syncMask)
|
|
1395
1316
|
*/
|
|
1396
1317
|
syncMask ? : string|MaskConfig|null
|
|
1397
1318
|
/**
|
|
1398
1319
|
* 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
|
|
1399
1320
|
* [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
|
|
1400
1321
|
* this widget:
|
|
1401
|
-
* ...
|
|
1402
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-tab)
|
|
1322
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-tab)
|
|
1403
1323
|
*/
|
|
1404
1324
|
tab ? : Boolean|TabConfig
|
|
1405
1325
|
/**
|
|
1406
1326
|
* When this container is used as a tab in a TabPanel, these items are added to the
|
|
1407
1327
|
* [TabBar](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/TabBar) when this container is the active tab.
|
|
1408
|
-
* ...
|
|
1409
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-tabBarItems)
|
|
1328
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-tabBarItems)
|
|
1410
1329
|
*/
|
|
1411
1330
|
tabBarItems ? : ToolbarItems[]|Widget[]
|
|
1412
1331
|
/**
|
|
1413
1332
|
* A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Toolbar),
|
|
1414
1333
|
* or array of config objects representing the child items of a Toolbar.
|
|
1415
1334
|
* This creates a toolbar docked to the top of the panel immediately below the header.
|
|
1416
|
-
* ...
|
|
1417
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-tbar)
|
|
1335
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-tbar)
|
|
1418
1336
|
*/
|
|
1419
1337
|
tbar ? : (SchedulerProContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
|
|
1420
1338
|
/**
|
|
@@ -1423,21 +1341,18 @@ defineProps<{
|
|
|
1423
1341
|
terminalCls ? : string
|
|
1424
1342
|
/**
|
|
1425
1343
|
* Delay in ms before hiding the terminals when the mouse leaves an event bar or terminal.
|
|
1426
|
-
* ...
|
|
1427
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-terminalHideDelay)
|
|
1344
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-terminalHideDelay)
|
|
1428
1345
|
*/
|
|
1429
1346
|
terminalHideDelay ? : number
|
|
1430
1347
|
/**
|
|
1431
1348
|
* Terminal offset from their initial position, in px. Positive values move terminals further away from the
|
|
1432
1349
|
* event bar, negative values inside the event bar.
|
|
1433
|
-
* ...
|
|
1434
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-terminalOffset)
|
|
1350
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-terminalOffset)
|
|
1435
1351
|
*/
|
|
1436
1352
|
terminalOffset ? : number
|
|
1437
1353
|
/**
|
|
1438
1354
|
* Delay in ms before showing the terminals when hovering over an event bar.
|
|
1439
|
-
* ...
|
|
1440
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-terminalShowDelay)
|
|
1355
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-terminalShowDelay)
|
|
1441
1356
|
*/
|
|
1442
1357
|
terminalShowDelay ? : number
|
|
1443
1358
|
/**
|
|
@@ -1447,14 +1362,12 @@ defineProps<{
|
|
|
1447
1362
|
terminalSides ? : string[]
|
|
1448
1363
|
/**
|
|
1449
1364
|
* Terminal diameter in px, overrides the default CSS value for it (which might depend on theme).
|
|
1450
|
-
* ...
|
|
1451
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-terminalSize)
|
|
1365
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-terminalSize)
|
|
1452
1366
|
*/
|
|
1453
1367
|
terminalSize ? : number|string
|
|
1454
1368
|
/**
|
|
1455
1369
|
* The width/height (depending on vertical / horizontal mode) of all the time columns.
|
|
1456
|
-
* ...
|
|
1457
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-tickSize)
|
|
1370
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-tickSize)
|
|
1458
1371
|
*/
|
|
1459
1372
|
tickSize ? : number
|
|
1460
1373
|
/**
|
|
@@ -1475,35 +1388,30 @@ defineProps<{
|
|
|
1475
1388
|
/**
|
|
1476
1389
|
* Gets/sets the current time resolution object, which contains a unit identifier and an increment count
|
|
1477
1390
|
* `{ unit, increment }`. This value means minimal task duration you can create using UI.
|
|
1478
|
-
* ...
|
|
1479
|
-
*
|
|
1391
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-timeResolution)
|
|
1392
|
+
* @property {number} increment The increment in the specified unit
|
|
1393
|
+
* @property {DurationUnit} unit The time resolution unit
|
|
1480
1394
|
*/
|
|
1481
|
-
timeResolution ? :
|
|
1482
|
-
increment?: number
|
|
1483
|
-
unit?: DurationUnit
|
|
1484
|
-
}|number
|
|
1395
|
+
timeResolution ? : object|number
|
|
1485
1396
|
/**
|
|
1486
1397
|
* Set to a time zone or a UTC offset. This will set the projects
|
|
1487
1398
|
* [timeZone](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/model/ProjectModel#config-timeZone) config accordingly. As this config is only a referer,
|
|
1488
1399
|
* please see project's config [documentation](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/model/ProjectModel#config-timeZone) for more
|
|
1489
1400
|
* information.
|
|
1490
|
-
* ...
|
|
1491
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-timeZone)
|
|
1401
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-timeZone)
|
|
1492
1402
|
*/
|
|
1493
1403
|
timeZone ? : string|number
|
|
1494
1404
|
/**
|
|
1495
1405
|
* A title to display in the header or owning TabPanel. Causes creation and docking of a header
|
|
1496
1406
|
* to the top if no header is configured.
|
|
1497
|
-
* ...
|
|
1498
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-title)
|
|
1407
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-title)
|
|
1499
1408
|
*/
|
|
1500
1409
|
title ? : string
|
|
1501
1410
|
/**
|
|
1502
1411
|
* 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
|
|
1503
1412
|
* property name is the reference by which an instantiated tool may be retrieved from the live
|
|
1504
1413
|
* `[tools](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/mixin/Toolable#property-tools)` property.
|
|
1505
|
-
* ...
|
|
1506
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-tools)
|
|
1414
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-tools)
|
|
1507
1415
|
*/
|
|
1508
1416
|
tools ? : Record<string, ToolConfig>|null
|
|
1509
1417
|
/**
|
|
@@ -1515,19 +1423,18 @@ defineProps<{
|
|
|
1515
1423
|
tooltipTemplate ? : (dependency: DependencyBaseModel) => string|DomConfig
|
|
1516
1424
|
/**
|
|
1517
1425
|
* Configure UI transitions for various actions in the grid.
|
|
1518
|
-
|
|
1519
|
-
|
|
1520
|
-
|
|
1521
|
-
|
|
1522
|
-
|
|
1523
|
-
|
|
1524
|
-
|
|
1525
|
-
|
|
1526
|
-
|
|
1527
|
-
|
|
1528
|
-
|
|
1529
|
-
|
|
1530
|
-
}
|
|
1426
|
+
* @property {boolean} insertRecord Transition record insertions
|
|
1427
|
+
* @property {boolean} removeRecord Transition record removals
|
|
1428
|
+
* @property {boolean} toggleColumn Transition column visibility changes
|
|
1429
|
+
* @property {boolean} expandCollapseColumn Transition parent/group column expand/collapse
|
|
1430
|
+
* @property {boolean} toggleRegion Transition region expand/collapse
|
|
1431
|
+
* @property {boolean} toggleTreeNode Transition tree node expand/collapse
|
|
1432
|
+
* @property {boolean} toggleGroup Transition group expand/collapse
|
|
1433
|
+
* @property {boolean} filterRemoval Transition row removals caused by filtering (under specific conditions)
|
|
1434
|
+
* @property {boolean} removeEvent Transition event removals
|
|
1435
|
+
* @property {boolean} changeEvent Transition event changes
|
|
1436
|
+
*/
|
|
1437
|
+
transition ? : object
|
|
1531
1438
|
/**
|
|
1532
1439
|
* Animation transition duration in milliseconds.
|
|
1533
1440
|
*/
|
|
@@ -1540,8 +1447,7 @@ defineProps<{
|
|
|
1540
1447
|
* Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
|
|
1541
1448
|
* as a space separated string, an array of strings, or as an object in which property names with truthy
|
|
1542
1449
|
* values are used as the class names.
|
|
1543
|
-
* ...
|
|
1544
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-ui)
|
|
1450
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-ui)
|
|
1545
1451
|
*/
|
|
1546
1452
|
ui ? : 'plain'|'toolbar'|string|object
|
|
1547
1453
|
/**
|
|
@@ -1555,35 +1461,30 @@ defineProps<{
|
|
|
1555
1461
|
* By default, the day of week and week of month of the event's start date are used to create
|
|
1556
1462
|
* helpful contextual recurrence types when editing a non-recurring event record and choosing
|
|
1557
1463
|
* an initial recurrence type.
|
|
1558
|
-
* ...
|
|
1559
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-useContextualRecurrenceRules)
|
|
1464
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-useContextualRecurrenceRules)
|
|
1560
1465
|
*/
|
|
1561
1466
|
useContextualRecurrenceRules ? : Boolean
|
|
1562
1467
|
/**
|
|
1563
1468
|
* By default, scheduler fade events in on load. Specify `false` to prevent this animation or specify one
|
|
1564
1469
|
* of the available animation types to use it (`true` equals `'fade-in'`):
|
|
1565
|
-
* ...
|
|
1566
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-useInitialAnimation)
|
|
1470
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-useInitialAnimation)
|
|
1567
1471
|
*/
|
|
1568
1472
|
useInitialAnimation ? : Boolean|'fade-in'|'slide-from-left'|'slide-from-top'|string
|
|
1569
1473
|
/**
|
|
1570
1474
|
* The time axis column config for vertical [mode](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/SchedulerBase#config-mode).
|
|
1571
|
-
* ...
|
|
1572
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-verticalTimeAxisColumn)
|
|
1475
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-verticalTimeAxisColumn)
|
|
1573
1476
|
*/
|
|
1574
1477
|
verticalTimeAxisColumn ? : VerticalTimeAxisColumnConfig
|
|
1575
1478
|
/**
|
|
1576
|
-
* A string key used to
|
|
1577
|
-
* managed by [PresetManager](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/preset/PresetManager). See [PresetManager](#Scheduler/preset/PresetManager)
|
|
1578
|
-
* Or a config object for a viewPreset.
|
|
1579
|
-
* ...
|
|
1580
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-viewPreset)
|
|
1479
|
+
* A string key used to look up a predefined [ViewPreset](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/preset/ViewPreset) (e.g. 'weekAndDay',
|
|
1480
|
+
* 'hourAndDay'), managed by [PresetManager](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/preset/PresetManager). See [PresetManager](#Scheduler/preset/PresetManager)
|
|
1481
|
+
* for more information. Or a config object for a viewPreset.
|
|
1482
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-viewPreset)
|
|
1581
1483
|
*/
|
|
1582
1484
|
viewPreset ? : string|ViewPresetConfig
|
|
1583
1485
|
/**
|
|
1584
1486
|
* A date to bring into view initially on the scrollable timeline.
|
|
1585
|
-
* ...
|
|
1586
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-visibleDate)
|
|
1487
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-visibleDate)
|
|
1587
1488
|
*/
|
|
1588
1489
|
visibleDate ? : Date|VisibleDate
|
|
1589
1490
|
/**
|
|
@@ -1611,15 +1512,19 @@ defineProps<{
|
|
|
1611
1512
|
/**
|
|
1612
1513
|
* An object with format `{ fromDay, toDay, fromHour, toHour }` that describes the working days and hours.
|
|
1613
1514
|
* This object will be used to populate TimeAxis [include](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/data/TimeAxis#config-include) property.
|
|
1614
|
-
* ...
|
|
1615
|
-
*
|
|
1515
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-workingTime)
|
|
1516
|
+
* @property {number} workingTime.fromDay Day index 0-6 (0 is Sunday)
|
|
1517
|
+
* @property {number} workingTime.toDay Day index 0-6 (0 is Sunday)
|
|
1518
|
+
* @property {number} workingTime.fromHour 0-23
|
|
1519
|
+
* @property {number} workingTime.toHour 0-23
|
|
1520
|
+
*/
|
|
1521
|
+
workingTime ? : { fromDay: number, toDay: number, fromHour: number, toHour: number }
|
|
1522
|
+
/**
|
|
1523
|
+
* Factor multiplied with wheel delta to calculate smooth zoom level changes when zooming with mouse wheel or
|
|
1524
|
+
* trackpad pinch gestures. A higher value means faster zooming.
|
|
1525
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#config-zoomFactor)
|
|
1616
1526
|
*/
|
|
1617
|
-
|
|
1618
|
-
fromDay?: number
|
|
1619
|
-
toDay?: number
|
|
1620
|
-
fromHour?: number
|
|
1621
|
-
toHour?: number
|
|
1622
|
-
}
|
|
1527
|
+
zoomFactor ? : number
|
|
1623
1528
|
/**
|
|
1624
1529
|
* Whether the originally rendered timespan should be preserved while zooming. By default, it is set to `false`,
|
|
1625
1530
|
* meaning the timeline panel will adjust the currently rendered timespan to limit the amount of HTML content to
|
|
@@ -1629,11 +1534,11 @@ defineProps<{
|
|
|
1629
1534
|
*/
|
|
1630
1535
|
zoomKeepsOriginalTimespan ? : Boolean
|
|
1631
1536
|
/**
|
|
1632
|
-
* If true
|
|
1537
|
+
* If `true`, you can zoom in and out on the time axis using <kbd>CTRL</kbd> + mouse wheel.
|
|
1633
1538
|
*/
|
|
1634
1539
|
zoomOnMouseWheel ? : Boolean
|
|
1635
1540
|
/**
|
|
1636
|
-
*
|
|
1541
|
+
* If `true`, you can zoom to a time span by double-clicking a time axis cell.
|
|
1637
1542
|
*/
|
|
1638
1543
|
zoomOnTimeAxisDoubleClick ? : Boolean
|
|
1639
1544
|
|
|
@@ -1643,14 +1548,12 @@ defineProps<{
|
|
|
1643
1548
|
* to send messages to the agent and see the responses. Which allows the user to use natural language to interact with
|
|
1644
1549
|
* the Scheduler in different ways. For example, the user can ask the agent to filter the data, sort it, or select
|
|
1645
1550
|
* specific records. The agent can also perform data manipulation operations such as adding, updating, deleting records.
|
|
1646
|
-
* ...
|
|
1647
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/AI)
|
|
1551
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/AI)
|
|
1648
1552
|
*/
|
|
1649
1553
|
aiFeature ? : object|Boolean|string|AI|AIConfig
|
|
1650
1554
|
/**
|
|
1651
1555
|
* AI-powered filter feature for Grid. Allows users to type natural language queries to filter grid data.
|
|
1652
|
-
* ...
|
|
1653
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ai/AIFilter)
|
|
1556
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ai/AIFilter)
|
|
1654
1557
|
*/
|
|
1655
1558
|
aiFilterFeature ? : object|Boolean|string|AIFilter|AIFilterConfig
|
|
1656
1559
|
/**
|
|
@@ -1658,240 +1561,232 @@ defineProps<{
|
|
|
1658
1561
|
* calendar (controlled by the [calendar](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/feature/CalendarHighlight#config-calendar) config). The calendars are highlighted while a user is creating,
|
|
1659
1562
|
* dragging or resizing a task. Enabling this feature makes it easier for the end user to understand the underlying
|
|
1660
1563
|
* rules of the schedule.
|
|
1661
|
-
* ...
|
|
1662
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/feature/CalendarHighlight)
|
|
1564
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/feature/CalendarHighlight)
|
|
1663
1565
|
*/
|
|
1664
1566
|
calendarHighlightFeature ? : object|Boolean|string|CalendarHighlight|CalendarHighlightConfig
|
|
1665
1567
|
/**
|
|
1666
1568
|
* Allows using `[Ctrl/CMD + C]`, `[Ctrl/CMD + X]` and `[Ctrl/CMD + V]` to cut, copy and paste cell or cell ranges. Also
|
|
1667
1569
|
* makes cut, copy and paste actions available via the cell context menu.
|
|
1668
|
-
* ...
|
|
1669
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellCopyPaste)
|
|
1570
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellCopyPaste)
|
|
1670
1571
|
*/
|
|
1671
1572
|
cellCopyPasteFeature ? : object|Boolean|string|CellCopyPaste|CellCopyPasteConfig
|
|
1672
1573
|
/**
|
|
1673
|
-
* Extends the Grid's [CellEdit](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellEdit) feature to
|
|
1674
|
-
*
|
|
1675
|
-
*
|
|
1574
|
+
* Extends the Grid's [CellEdit](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellEdit) feature to integrate with the Scheduler Pro scheduling engine.
|
|
1575
|
+
* It wraps cell edit operations in project transactions, ensuring that all changes to scheduling-related fields
|
|
1576
|
+
* (such as start date, duration, or effort) are processed atomically through the scheduling engine and can be
|
|
1577
|
+
* cleanly committed or reverted. This feature also coordinates with other transactional features to prevent
|
|
1578
|
+
* conflicting edits from occurring simultaneously.
|
|
1579
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/feature/CellEdit)
|
|
1676
1580
|
*/
|
|
1677
1581
|
cellEditFeature ? : object|Boolean|string|CellEdit|CellEditConfig
|
|
1678
1582
|
/**
|
|
1679
1583
|
* Right click to display context menu for cells. To invoke the cell menu in a keyboard-accessible manner, use the
|
|
1680
1584
|
* <kbd>Space</kbd> key when the cell is focused.
|
|
1681
|
-
* ...
|
|
1682
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellMenu)
|
|
1585
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellMenu)
|
|
1683
1586
|
*/
|
|
1684
1587
|
cellMenuFeature ? : object|Boolean|string|CellMenu|CellMenuConfig
|
|
1685
1588
|
/**
|
|
1686
1589
|
* Displays a tooltip when hovering cells.
|
|
1687
|
-
* ...
|
|
1688
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellTooltip)
|
|
1590
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellTooltip)
|
|
1689
1591
|
*/
|
|
1690
1592
|
cellTooltipFeature ? : object|Boolean|string|CellTooltip|CellTooltipConfig
|
|
1691
1593
|
/**
|
|
1692
1594
|
* 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
|
|
1693
1595
|
* and updated in realtime as data changes. Supports many common chart types with extensive styling and customization
|
|
1694
1596
|
* options.
|
|
1695
|
-
* ...
|
|
1696
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Charts)
|
|
1597
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Charts)
|
|
1697
1598
|
*/
|
|
1698
1599
|
chartsFeature ? : object|Boolean|string|Charts|ChartsConfig
|
|
1699
1600
|
/**
|
|
1700
|
-
* Enables the [autoWidth](https://bryntum.com/products/schedulerpro/docs/api/Grid/column/Column#config-autoWidth) config for a grid's columns.
|
|
1701
|
-
*
|
|
1702
|
-
*
|
|
1601
|
+
* Enables the [autoWidth](https://bryntum.com/products/schedulerpro/docs/api/Grid/column/Column#config-autoWidth) config for a grid's columns. When a column
|
|
1602
|
+
* has `autoWidth` set, this feature measures the rendered content of all visible cells in that column
|
|
1603
|
+
* and adjusts the column width to fit. The measurement is triggered automatically when data changes
|
|
1604
|
+
* or rows are rendered.
|
|
1605
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnAutoWidth)
|
|
1703
1606
|
*/
|
|
1704
1607
|
columnAutoWidthFeature ? : object|Boolean|string|ColumnAutoWidth|ColumnAutoWidthConfig
|
|
1705
1608
|
/**
|
|
1706
1609
|
* Displays a toolbar while dragging column headers. Drop on a button in the toolbar to activate a certain function,
|
|
1707
1610
|
* for example to group by that column. This feature simplifies certain operations on touch devices.
|
|
1708
|
-
* ...
|
|
1709
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnDragToolbar)
|
|
1611
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnDragToolbar)
|
|
1710
1612
|
*/
|
|
1711
1613
|
columnDragToolbarFeature ? : object|Boolean|string|ColumnDragToolbar|ColumnDragToolbarConfig
|
|
1712
1614
|
/**
|
|
1713
1615
|
* Displays column lines for ticks, with a different styling for major ticks (by default they are darker). If this
|
|
1714
1616
|
* feature is disabled, no lines are shown. If it's enabled, line are shown for the tick level which is set in current
|
|
1715
1617
|
* ViewPreset. Please see [columnLinesFor](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/preset/ViewPreset#field-columnLinesFor) config for details.
|
|
1716
|
-
* ...
|
|
1717
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ColumnLines)
|
|
1618
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ColumnLines)
|
|
1718
1619
|
*/
|
|
1719
1620
|
columnLinesFeature ? : object|Boolean|string|ColumnLines|ColumnLinesConfig
|
|
1720
1621
|
/**
|
|
1721
1622
|
* Displays a column picker (to show/hide columns) in the header context menu. Columns can be displayed in sub menus
|
|
1722
1623
|
* by region or tag. Grouped headers are displayed as menu hierarchies.
|
|
1723
|
-
* ...
|
|
1724
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnPicker)
|
|
1624
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnPicker)
|
|
1725
1625
|
*/
|
|
1726
1626
|
columnPickerFeature ? : object|Boolean|string|ColumnPicker|ColumnPickerConfig
|
|
1727
1627
|
/**
|
|
1728
1628
|
* Allows user to rename columns by either right-clicking column header or using keyboard shortcuts when column header
|
|
1729
1629
|
* is focused.
|
|
1730
|
-
* ...
|
|
1731
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnRename)
|
|
1630
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnRename)
|
|
1732
1631
|
*/
|
|
1733
1632
|
columnRenameFeature ? : object|Boolean|string|ColumnRename|ColumnRenameConfig
|
|
1734
1633
|
/**
|
|
1735
|
-
* Allows user to reorder columns by dragging headers.
|
|
1736
|
-
*
|
|
1737
|
-
*
|
|
1738
|
-
* [
|
|
1634
|
+
* Allows user to reorder columns by dragging headers. Click and drag a column header to move it to a new position.
|
|
1635
|
+
* Visual feedback shows the drop target while dragging. To get notified about column reorder, listen to the
|
|
1636
|
+
* `change` event on the [columns](https://bryntum.com/products/schedulerpro/docs/api/Grid/data/ColumnStore) store.
|
|
1637
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnReorder)
|
|
1739
1638
|
*/
|
|
1740
1639
|
columnReorderFeature ? : object|Boolean|string|ColumnReorder|ColumnReorderConfig
|
|
1741
1640
|
/**
|
|
1742
|
-
* Enables user to resize columns by dragging a handle on the right hand side of the header.
|
|
1743
|
-
*
|
|
1744
|
-
*
|
|
1745
|
-
* [
|
|
1641
|
+
* Enables user to resize columns by dragging a handle on the right hand side of the header. A drag handle
|
|
1642
|
+
* appears when hovering near the right edge of a column header. Dragging it adjusts the column width, respecting
|
|
1643
|
+
* any [minWidth](https://bryntum.com/products/schedulerpro/docs/api/Grid/column/Column#config-minWidth) or [maxWidth](#Grid/column/Column#config-maxWidth) constraints.
|
|
1644
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/ColumnResize)
|
|
1746
1645
|
*/
|
|
1747
1646
|
columnResizeFeature ? : object|Boolean|string|ColumnResize|ColumnResizeConfig
|
|
1748
1647
|
/**
|
|
1749
|
-
*
|
|
1750
|
-
*
|
|
1751
|
-
*
|
|
1752
|
-
*
|
|
1648
|
+
* Extends the Scheduler's [Dependencies](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/Dependencies) feature to integrate with the Scheduler Pro
|
|
1649
|
+
* scheduling engine. It renders dependency lines between events and supports interactive creation of new
|
|
1650
|
+
* dependencies by dragging from one event's dependency terminal to another. All dependency creation and
|
|
1651
|
+
* modification operations are wrapped in project transactions, ensuring that the scheduling engine processes
|
|
1652
|
+
* the changes atomically and can revert them if needed.
|
|
1653
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/feature/Dependencies)
|
|
1753
1654
|
*/
|
|
1754
1655
|
dependenciesFeature ? : object|Boolean|string|Dependencies|DependenciesConfig
|
|
1755
1656
|
/**
|
|
1756
|
-
*
|
|
1757
|
-
*
|
|
1758
|
-
*
|
|
1657
|
+
* Extends the Scheduler's [DependencyEdit](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/DependencyEdit) feature to integrate with the Scheduler Pro
|
|
1658
|
+
* scheduling engine. It displays a popup containing fields for editing dependency data such as type, lag, and
|
|
1659
|
+
* active state. All edits, saves, and deletions performed through this editor are wrapped in project transactions,
|
|
1660
|
+
* ensuring that the scheduling engine processes the changes atomically and can revert them on cancel.
|
|
1661
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/feature/DependencyEdit)
|
|
1759
1662
|
*/
|
|
1760
1663
|
dependencyEditFeature ? : object|Boolean|string|DependencyEdit|DependencyEditConfig
|
|
1761
1664
|
/**
|
|
1762
1665
|
* Displays a context menu when right-clicking dependency lines. Items are populated by other features and/or
|
|
1763
1666
|
* application code.
|
|
1764
|
-
* ...
|
|
1765
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/DependencyMenu)
|
|
1667
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/DependencyMenu)
|
|
1766
1668
|
*/
|
|
1767
1669
|
dependencyMenuFeature ? : object|Boolean|string|DependencyMenu|DependencyMenuConfig
|
|
1768
1670
|
/**
|
|
1769
1671
|
* Feature that allows showing additional time before & after an event, to visualize things like travel time - or the
|
|
1770
1672
|
* time you need to prepare a room for a meeting + clean it up after. You can configure whether the buffer time
|
|
1771
1673
|
* intervals should be considered busy time or available time using [bufferIsUnavailableTime](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/feature/EventBuffer#property-bufferIsUnavailableTime).
|
|
1772
|
-
* ...
|
|
1773
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/feature/EventBuffer)
|
|
1674
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/feature/EventBuffer)
|
|
1774
1675
|
*/
|
|
1775
1676
|
eventBufferFeature ? : object|Boolean|string|EventBuffer|EventBufferConfig
|
|
1776
1677
|
/**
|
|
1777
1678
|
* Allow using <kbd>Ctrl</kbd>/<kbd>Cmd</kbd>+<kbd>C</kbd>, <kbd>Ctrl</kbd>/<kbd>Cmd</kbd>+<kbd>X</kbd> and
|
|
1778
1679
|
* <kbd>Ctrl</kbd>/<kbd>Cmd</kbd>+<kbd>V</kbd> to copy/cut and paste events.
|
|
1779
|
-
* ...
|
|
1780
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventCopyPaste)
|
|
1680
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventCopyPaste)
|
|
1781
1681
|
*/
|
|
1782
1682
|
eventCopyPasteFeature ? : object|Boolean|string|EventCopyPaste|EventCopyPasteConfig
|
|
1783
1683
|
/**
|
|
1784
|
-
* Allows user to drag and drop events within the
|
|
1785
|
-
*
|
|
1786
|
-
* [
|
|
1684
|
+
* Allows user to drag and drop events within the Scheduler Pro, to change `startDate` or resource assignment.
|
|
1685
|
+
* This class extends the Scheduler's [EventDrag](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventDrag) feature for use in Scheduler Pro.
|
|
1686
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/feature/EventDrag)
|
|
1787
1687
|
*/
|
|
1788
1688
|
eventDragFeature ? : object|Boolean|string|EventDrag|EventDragConfig
|
|
1789
1689
|
/**
|
|
1790
1690
|
* Feature that allows the user to create new events by dragging in empty parts of the scheduler rows.
|
|
1791
|
-
* ...
|
|
1792
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventDragCreate)
|
|
1691
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventDragCreate)
|
|
1793
1692
|
*/
|
|
1794
1693
|
eventDragCreateFeature ? : object|Boolean|string|EventDragCreate|EventDragCreateConfig
|
|
1795
1694
|
/**
|
|
1796
1695
|
* Enables users to click and drag to select events (or assignments in multi assignment mode) inside the Scheduler's
|
|
1797
1696
|
* timeline. Press <kbd>CTRL</kbd>/<kbd>CMD</kbd> to extend an existing selection.
|
|
1798
|
-
* ...
|
|
1799
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventDragSelect)
|
|
1697
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventDragSelect)
|
|
1800
1698
|
*/
|
|
1801
1699
|
eventDragSelectFeature ? : object|Boolean|string|EventDragSelect|EventDragSelectConfig
|
|
1802
1700
|
/**
|
|
1803
1701
|
* Feature that displays a popup containing widgets for editing event data.
|
|
1804
|
-
* ...
|
|
1805
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventEdit)
|
|
1702
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventEdit)
|
|
1806
1703
|
*/
|
|
1807
1704
|
eventEditFeature ? : object|Boolean|string|EventEdit|EventEditConfig
|
|
1808
1705
|
/**
|
|
1809
|
-
* Adds event filter menu items to the timeline header context menu.
|
|
1810
|
-
*
|
|
1811
|
-
* [
|
|
1706
|
+
* Adds event filter menu items to the timeline header context menu. Users can type filter text to show
|
|
1707
|
+
* only events whose name matches the query.
|
|
1708
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventFilter)
|
|
1812
1709
|
*/
|
|
1813
1710
|
eventFilterFeature ? : object|Boolean|string|EventFilter|EventFilterConfig
|
|
1814
1711
|
/**
|
|
1815
1712
|
* Displays a context menu for events. Items are populated by other features and/or application code.
|
|
1816
|
-
* ...
|
|
1817
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventMenu)
|
|
1713
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventMenu)
|
|
1818
1714
|
*/
|
|
1819
1715
|
eventMenuFeature ? : object|Boolean|string|EventMenu|EventMenuConfig
|
|
1820
1716
|
/**
|
|
1821
1717
|
* Feature that allows rendering non-working time ranges into event bars (weekends for Scheduler, effective calendar for
|
|
1822
1718
|
* SchedulerPro):
|
|
1823
|
-
* ...
|
|
1824
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventNonWorkingTime)
|
|
1719
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventNonWorkingTime)
|
|
1825
1720
|
*/
|
|
1826
1721
|
eventNonWorkingTimeFeature ? : object|Boolean|string|EventNonWorkingTime|EventNonWorkingTimeConfig
|
|
1827
1722
|
/**
|
|
1828
|
-
*
|
|
1829
|
-
*
|
|
1830
|
-
*
|
|
1723
|
+
* Extends the Scheduler's [EventResize](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventResize) feature for use in Scheduler Pro. It allows
|
|
1724
|
+
* resizing an event by dragging its start or end edge, updating the event's dates accordingly through the
|
|
1725
|
+
* scheduling engine. This override excludes event segments from being resized by the main resize feature,
|
|
1726
|
+
* deferring segment resize handling to the dedicated [EventSegmentResize](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/feature/EventSegmentResize) feature.
|
|
1727
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/feature/EventResize)
|
|
1831
1728
|
*/
|
|
1832
1729
|
eventResizeFeature ? : object|Boolean|string|EventResize|EventResizeConfig
|
|
1833
1730
|
/**
|
|
1834
|
-
* Allows
|
|
1835
|
-
*
|
|
1836
|
-
*
|
|
1731
|
+
* Allows users to drag and drop individual event segments within the resource row to reschedule them. When a
|
|
1732
|
+
* segment is dragged, its start date is updated and the scheduling engine recalculates the overall event
|
|
1733
|
+
* accordingly. Segment dragging is constrained to the owning resource row and respects boundaries set by
|
|
1734
|
+
* neighboring segments, preventing overlap between adjacent segments of the same event.
|
|
1735
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/feature/EventSegmentDrag)
|
|
1837
1736
|
*/
|
|
1838
1737
|
eventSegmentDragFeature ? : object|Boolean|string|EventSegmentDrag|EventSegmentDragConfig
|
|
1839
1738
|
/**
|
|
1840
|
-
*
|
|
1841
|
-
*
|
|
1842
|
-
*
|
|
1739
|
+
* Allows resizing individual event segments by dragging their start or end edges. When a segment is resized, the
|
|
1740
|
+
* scheduling engine recalculates the parent event's dates and duration accordingly. Resize operations are
|
|
1741
|
+
* constrained by neighboring segments, preventing overlap between adjacent segments of the same event. If the
|
|
1742
|
+
* first or last segment is resized, the parent event's start or end date is updated to match.
|
|
1743
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/feature/EventSegmentResize)
|
|
1843
1744
|
*/
|
|
1844
1745
|
eventSegmentResizeFeature ? : object|Boolean|string|EventSegmentResize|EventSegmentResizeConfig
|
|
1845
1746
|
/**
|
|
1846
1747
|
* This feature provides segmented events support. It implements rendering of such events and also adds a entries to the
|
|
1847
1748
|
* event context menu allowing to split the selected event and rename segments.
|
|
1848
|
-
* ...
|
|
1849
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/feature/EventSegments)
|
|
1749
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/feature/EventSegments)
|
|
1850
1750
|
*/
|
|
1851
1751
|
eventSegmentsFeature ? : object|Boolean|string|EventSegments|EventSegmentsConfig
|
|
1852
1752
|
/**
|
|
1853
1753
|
* 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).
|
|
1854
1754
|
* Config options are also applied to the tooltip shown, see [Tooltip](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Tooltip) for available options.
|
|
1855
|
-
* ...
|
|
1856
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventTooltip)
|
|
1755
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventTooltip)
|
|
1857
1756
|
*/
|
|
1858
1757
|
eventTooltipFeature ? : object|Boolean|string|EventTooltip|EventTooltipConfig
|
|
1859
1758
|
/**
|
|
1860
1759
|
* A feature that allows exporting Scheduler data to Excel or CSV without involving the server. It uses
|
|
1861
1760
|
* [TableExporter](https://bryntum.com/products/schedulerpro/docs/api/Grid/util/TableExporter) class as data provider, 3rd party provider to generate XLS files, and
|
|
1862
1761
|
* [Microsoft XML specification](https://msdn.microsoft.com/en-us/library/office/documentformat.openxml.spreadsheet.aspx).
|
|
1863
|
-
* ...
|
|
1864
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/experimental/ExcelExporter)
|
|
1762
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/experimental/ExcelExporter)
|
|
1865
1763
|
*/
|
|
1866
1764
|
excelExporterFeature ? : object|Boolean|string|ExcelExporter|ExcelExporterConfig
|
|
1867
1765
|
/**
|
|
1868
|
-
* An experimental feature that lets users drop files on a Widget. The widget fires
|
|
1869
|
-
* In the event, you get access to the raw
|
|
1870
|
-
*
|
|
1871
|
-
* [
|
|
1766
|
+
* An experimental feature that lets users drop files on a Widget. The widget fires a
|
|
1767
|
+
* [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
|
|
1768
|
+
* files as strings, that were parsed by calling `readAsBinaryString`.
|
|
1769
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/experimental/FileDrop)
|
|
1872
1770
|
*/
|
|
1873
1771
|
fileDropFeature ? : object|Boolean|string|FileDrop|FileDropConfig
|
|
1874
1772
|
/**
|
|
1875
1773
|
* This feature adds a fill handle to a Grid range selection, which when dragged, fills the cells being dragged over
|
|
1876
1774
|
* with values based on the values in the original selected range. This is similar to functionality normally seen in
|
|
1877
1775
|
* various spreadsheet applications.
|
|
1878
|
-
* ...
|
|
1879
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/FillHandle)
|
|
1776
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/FillHandle)
|
|
1880
1777
|
*/
|
|
1881
1778
|
fillHandleFeature ? : object|Boolean|string|FillHandle|FillHandleConfig
|
|
1882
1779
|
/**
|
|
1883
1780
|
* Feature that allows filtering of the grid by settings filters on columns. The actual filtering is done by the store.
|
|
1884
1781
|
* For info on programmatically handling filters, see [StoreFilter](https://bryntum.com/products/schedulerpro/docs/api/Core/data/mixin/StoreFilter).
|
|
1885
|
-
* ...
|
|
1886
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Filter)
|
|
1782
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Filter)
|
|
1887
1783
|
*/
|
|
1888
1784
|
filterFeature ? : object|Boolean|string|Filter|FilterConfig
|
|
1889
1785
|
/**
|
|
1890
1786
|
* Feature that allows filtering of the grid by entering filters on column headers.
|
|
1891
1787
|
* The actual filtering is done by the store.
|
|
1892
1788
|
* For info on programmatically handling filters, see [StoreFilter](https://bryntum.com/products/schedulerpro/docs/api/Core/data/mixin/StoreFilter).
|
|
1893
|
-
* ...
|
|
1894
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/FilterBar)
|
|
1789
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/FilterBar)
|
|
1895
1790
|
*/
|
|
1896
1791
|
filterBarFeature ? : object|Boolean|string|FilterBar|FilterBarConfig
|
|
1897
1792
|
/**
|
|
@@ -1899,171 +1794,147 @@ defineProps<{
|
|
|
1899
1794
|
* <kbd>Shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
|
|
1900
1795
|
* one anywhere on grid). Use <kbd>Shift</kbd> + <kbd>Alt</kbd> + click, or the context menu, to remove a column
|
|
1901
1796
|
* grouper.
|
|
1902
|
-
* ...
|
|
1903
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Group)
|
|
1797
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Group)
|
|
1904
1798
|
*/
|
|
1905
1799
|
groupFeature ? : object|Boolean|string|Group|GroupConfig
|
|
1906
1800
|
/**
|
|
1907
1801
|
* A special version of the Grid GroupSummary feature that enables summaries within scheduler. To use a single summary
|
|
1908
1802
|
* 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).
|
|
1909
|
-
* ...
|
|
1910
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/GroupSummary)
|
|
1803
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/GroupSummary)
|
|
1911
1804
|
*/
|
|
1912
1805
|
groupSummaryFeature ? : object|Boolean|string|GroupSummary|GroupSummaryConfig
|
|
1913
1806
|
/**
|
|
1914
1807
|
* Right click column header or focus it and press SPACE key to show the context menu for headers.
|
|
1915
|
-
* ...
|
|
1916
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/HeaderMenu)
|
|
1808
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/HeaderMenu)
|
|
1917
1809
|
*/
|
|
1918
1810
|
headerMenuFeature ? : object|Boolean|string|HeaderMenu|HeaderMenuConfig
|
|
1919
1811
|
/**
|
|
1920
1812
|
* Enables users to click and drag to zoom to a date range in Scheduler's header time axis. Only supported in horizontal
|
|
1921
1813
|
* mode.
|
|
1922
|
-
* ...
|
|
1923
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/HeaderZoom)
|
|
1814
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/HeaderZoom)
|
|
1924
1815
|
*/
|
|
1925
1816
|
headerZoomFeature ? : object|Boolean|string|HeaderZoom|HeaderZoomConfig
|
|
1926
1817
|
/**
|
|
1927
1818
|
* 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
|
|
1928
1819
|
* [left](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/Labels#config-left).
|
|
1929
|
-
* ...
|
|
1930
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/Labels)
|
|
1820
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/Labels)
|
|
1931
1821
|
*/
|
|
1932
1822
|
labelsFeature ? : object|Boolean|string|Labels|LabelsConfig
|
|
1933
1823
|
/**
|
|
1934
1824
|
* This feature allows resources which satisfy a certain condition to be locked at the top of the scheduler.
|
|
1935
|
-
* ...
|
|
1936
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/LockRows)
|
|
1825
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/LockRows)
|
|
1937
1826
|
*/
|
|
1938
1827
|
lockRowsFeature ? : object|Boolean|string|LockRows|LockRowsConfig
|
|
1939
1828
|
/**
|
|
1940
1829
|
* 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
|
|
1941
1830
|
* configured to [mergeCells](https://bryntum.com/products/schedulerpro/docs/api/Grid/column/Column#config-mergeCells).
|
|
1942
|
-
* ...
|
|
1943
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/MergeCells)
|
|
1831
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/MergeCells)
|
|
1944
1832
|
*/
|
|
1945
1833
|
mergeCellsFeature ? : object|Boolean|string|MergeCells|MergeCellsConfig
|
|
1946
1834
|
/**
|
|
1947
1835
|
* A feature that renders child events nested inside their parent. Requires Scheduler Pro to use a tree event store
|
|
1948
1836
|
* (normally handled automatically when events in data has children).
|
|
1949
|
-
* ...
|
|
1950
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/feature/NestedEvents)
|
|
1837
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/feature/NestedEvents)
|
|
1951
1838
|
*/
|
|
1952
1839
|
nestedEventsFeature ? : object|Boolean|string|NestedEvents|NestedEventsConfig
|
|
1953
1840
|
/**
|
|
1954
1841
|
* Feature that allows styling of weekends (and other non-working time) by adding timeRanges for those days.
|
|
1955
|
-
* ...
|
|
1956
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/NonWorkingTime)
|
|
1842
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/NonWorkingTime)
|
|
1957
1843
|
*/
|
|
1958
1844
|
nonWorkingTimeFeature ? : object|Boolean|string|NonWorkingTime|NonWorkingTimeConfig
|
|
1959
1845
|
/**
|
|
1960
1846
|
* Makes the scheduler's timeline pannable by dragging with the mouse. Try it out in the demo below.
|
|
1961
|
-
* ...
|
|
1962
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/Pan)
|
|
1847
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/Pan)
|
|
1963
1848
|
*/
|
|
1964
1849
|
panFeature ? : object|Boolean|string|Pan|PanConfig
|
|
1965
1850
|
/**
|
|
1966
1851
|
* Generates PDF/PNG files from the Scheduler component.
|
|
1967
|
-
* ...
|
|
1968
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/export/PdfExport)
|
|
1852
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/export/PdfExport)
|
|
1969
1853
|
*/
|
|
1970
1854
|
pdfExportFeature ? : object|Boolean|string|PdfExport|PdfExportConfig
|
|
1971
1855
|
/**
|
|
1972
1856
|
* This feature visualizes the [percentDone](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/mixin/PercentDoneMixin#field-percentDone) field as a
|
|
1973
1857
|
* progress bar on the event elements. Each progress bar also optionally has a drag handle which users can drag can
|
|
1974
1858
|
* change the value.
|
|
1975
|
-
* ...
|
|
1976
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/feature/PercentBar)
|
|
1859
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/feature/PercentBar)
|
|
1977
1860
|
*/
|
|
1978
1861
|
percentBarFeature ? : object|Boolean|string|PercentBar|PercentBarConfig
|
|
1979
1862
|
/**
|
|
1980
1863
|
* Allows pinning columns to the start or end region of the grid without any additional subGrid configurations.
|
|
1981
1864
|
* When pinning to a region that does not yet exist, the feature creates the required subGrid on the fly.
|
|
1982
|
-
* ...
|
|
1983
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/PinColumns)
|
|
1865
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/PinColumns)
|
|
1984
1866
|
*/
|
|
1985
1867
|
pinColumnsFeature ? : object|Boolean|string|PinColumns|PinColumnsConfig
|
|
1986
1868
|
/**
|
|
1987
1869
|
* Allows printing Scheduler contents using browser print dialog.
|
|
1988
|
-
* ...
|
|
1989
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/export/Print)
|
|
1870
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/export/Print)
|
|
1990
1871
|
*/
|
|
1991
1872
|
printFeature ? : object|Boolean|string|Print|PrintConfig
|
|
1992
1873
|
/**
|
|
1993
1874
|
* Feature that allows the user to search in a column by focusing a cell and typing. Navigate between hits using the
|
|
1994
|
-
* keyboard,
|
|
1995
|
-
*
|
|
1996
|
-
* [
|
|
1875
|
+
* keyboard, <kbd>f3</kbd> or <kbd>ctrl</kbd>/<kbd>cmd</kbd> + <kbd>g</kbd> moves to next, also pressing
|
|
1876
|
+
* <kbd>shift</kbd> moves to previous.
|
|
1877
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/QuickFind)
|
|
1997
1878
|
*/
|
|
1998
1879
|
quickFindFeature ? : object|Boolean|string|QuickFind|QuickFindConfig
|
|
1999
1880
|
/**
|
|
2000
1881
|
* Makes the splitter between grid [sections](https://bryntum.com/products/schedulerpro/docs/api/Grid/view/SubGrid) draggable, to let users resize, and
|
|
2001
1882
|
* collapse/expand the sections.
|
|
2002
|
-
* ...
|
|
2003
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RegionResize)
|
|
1883
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RegionResize)
|
|
2004
1884
|
*/
|
|
2005
1885
|
regionResizeFeature ? : object|Boolean|string|RegionResize|RegionResizeConfig
|
|
2006
1886
|
/**
|
|
2007
1887
|
* Allows user to reorder resource columns in vertical mode by dragging them. The feature fires various events
|
|
2008
1888
|
* during the drag operation (see events below). To get notified about the actual resource reorder, you can also
|
|
2009
1889
|
* listen to the `change` event on the scheduler [ResourceStore](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/data/ResourceStore).
|
|
2010
|
-
* ...
|
|
2011
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ResourceColumnReorder)
|
|
1890
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ResourceColumnReorder)
|
|
2012
1891
|
*/
|
|
2013
1892
|
resourceColumnReorderFeature ? : object|Boolean|string|ResourceColumnReorder|ResourceColumnReorderConfig
|
|
2014
1893
|
/**
|
|
2015
1894
|
* Feature that displays a popup containing widgets for editing resource data.
|
|
2016
|
-
* ...
|
|
2017
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/feature/ResourceEdit)
|
|
1895
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/feature/ResourceEdit)
|
|
2018
1896
|
*/
|
|
2019
1897
|
resourceEditFeature ? : object|Boolean|string|ResourceEdit|ResourceEditConfig
|
|
2020
1898
|
/**
|
|
2021
1899
|
* Applicable only for Scheduler in `vertical` mode. Right click resource header cells to display a context menu.
|
|
2022
|
-
* ...
|
|
2023
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ResourceMenu)
|
|
1900
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ResourceMenu)
|
|
2024
1901
|
*/
|
|
2025
1902
|
resourceMenuFeature ? : object|Boolean|string|ResourceMenu|ResourceMenuConfig
|
|
2026
1903
|
/**
|
|
2027
1904
|
* Feature that highlights the non-working intervals for resources based on their [calendar](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ResourceModel#field-calendar).
|
|
2028
1905
|
* If a resource has no calendar defined, the project's calendar will be used. The non-working time interval can
|
|
2029
1906
|
* also be recurring. You can find a live example showing how to achieve this in the [Resource Non-Working Time Demo](../examples/resource-non-working-time/).
|
|
2030
|
-
* ...
|
|
2031
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/feature/ResourceNonWorkingTime)
|
|
1907
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/feature/ResourceNonWorkingTime)
|
|
2032
1908
|
*/
|
|
2033
1909
|
resourceNonWorkingTimeFeature ? : object|Boolean|string|ResourceNonWorkingTime|ResourceNonWorkingTimeConfig
|
|
2034
1910
|
/**
|
|
2035
1911
|
* Feature that draws resource time ranges, shaded areas displayed behind events. These zones are similar to events in
|
|
2036
1912
|
* that they have a start and end date but different in that they do not take part in the event layout, and they always
|
|
2037
1913
|
* occupy full row height.
|
|
2038
|
-
* ...
|
|
2039
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ResourceTimeRanges)
|
|
1914
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ResourceTimeRanges)
|
|
2040
1915
|
*/
|
|
2041
1916
|
resourceTimeRangesFeature ? : object|Boolean|string|ResourceTimeRanges|ResourceTimeRangesConfig
|
|
2042
1917
|
/**
|
|
2043
1918
|
* Allow using [Ctrl/CMD + C/X] and [Ctrl/CMD + V] to copy/cut-and-paste rows. Also makes cut, copy and paste actions
|
|
2044
1919
|
* available via the cell context menu.
|
|
2045
|
-
* ...
|
|
2046
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RowCopyPaste)
|
|
1920
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RowCopyPaste)
|
|
2047
1921
|
*/
|
|
2048
1922
|
rowCopyPasteFeature ? : object|Boolean|string|RowCopyPaste|RowCopyPasteConfig
|
|
2049
1923
|
/**
|
|
2050
1924
|
* This feature allows editing of entire rows in a grid in a docked panel which by default slides out from the right.
|
|
2051
|
-
* ...
|
|
2052
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RowEdit)
|
|
1925
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RowEdit)
|
|
2053
1926
|
*/
|
|
2054
1927
|
rowEditFeature ? : object|Boolean|string|RowEdit|RowEditConfig
|
|
2055
1928
|
/**
|
|
2056
1929
|
* Enables expanding of Grid rows by either row click or double click, or by adding a separate Grid column which renders
|
|
2057
1930
|
* a button that expands or collapses the row.
|
|
2058
|
-
* ...
|
|
2059
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RowExpander)
|
|
1931
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RowExpander)
|
|
2060
1932
|
*/
|
|
2061
1933
|
rowExpanderFeature ? : object|Boolean|string|RowExpander|RowExpanderConfig
|
|
2062
1934
|
/**
|
|
2063
1935
|
* This feature implements support for project transactions and used by default in Gantt. For general RowReorder feature
|
|
2064
1936
|
* documentation see [RowReorder](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/RowReorder).
|
|
2065
|
-
* ...
|
|
2066
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/RowReorder)
|
|
1937
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/RowReorder)
|
|
2067
1938
|
*/
|
|
2068
1939
|
rowReorderFeature ? : object|Boolean|string|RowReorder|RowReorderConfig
|
|
2069
1940
|
/**
|
|
@@ -2071,101 +1942,89 @@ defineProps<{
|
|
|
2071
1942
|
* 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
|
|
2072
1943
|
* row will be switched to `pack` as a result (only applies when `stack` is used by default).
|
|
2073
1944
|
* `barMargin` and `resourceMargin` will also be shrunk as you reduce the height of a row.
|
|
2074
|
-
* ...
|
|
2075
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/RowResize)
|
|
1945
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/RowResize)
|
|
2076
1946
|
*/
|
|
2077
1947
|
rowResizeFeature ? : object|Boolean|string|RowResize|RowResizeConfig
|
|
2078
1948
|
/**
|
|
2079
1949
|
* 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).
|
|
2080
|
-
* ...
|
|
2081
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ScheduleContext)
|
|
1950
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ScheduleContext)
|
|
2082
1951
|
*/
|
|
2083
1952
|
scheduleContextFeature ? : object|Boolean|string|ScheduleContext|ScheduleContextConfig
|
|
2084
1953
|
/**
|
|
2085
1954
|
* Displays a context menu for empty parts of the schedule. Items are populated in the first place
|
|
2086
1955
|
* by configurations of this Feature, then by other features and/or application code.
|
|
2087
|
-
* ...
|
|
2088
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ScheduleMenu)
|
|
1956
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ScheduleMenu)
|
|
2089
1957
|
*/
|
|
2090
1958
|
scheduleMenuFeature ? : object|Boolean|string|ScheduleMenu|ScheduleMenuConfig
|
|
2091
1959
|
/**
|
|
2092
1960
|
* Feature that displays a tooltip containing the time at the mouse position when hovering empty parts of the schedule.
|
|
2093
|
-
* ...
|
|
2094
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ScheduleTooltip)
|
|
1961
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ScheduleTooltip)
|
|
2095
1962
|
*/
|
|
2096
1963
|
scheduleTooltipFeature ? : object|Boolean|string|ScheduleTooltip|ScheduleTooltipConfig
|
|
2097
1964
|
/**
|
|
2098
1965
|
* This feature injects buttons to the beginning and end of each row that will scroll to the next or previous event
|
|
2099
1966
|
* outside the current view. It can optionally show a label along with the button, using the
|
|
2100
1967
|
* [labelRenderer](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ScrollButtons#config-labelRenderer). Only supported in horizontal [mode](#Scheduler/view/SchedulerBase#config-mode)
|
|
2101
|
-
* ...
|
|
2102
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ScrollButtons)
|
|
1968
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ScrollButtons)
|
|
2103
1969
|
*/
|
|
2104
1970
|
scrollButtonsFeature ? : object|Boolean|string|ScrollButtons|ScrollButtonsConfig
|
|
2105
1971
|
/**
|
|
2106
1972
|
* <div class="external-example vertical" data-file="Grid/feature/Search.js"></div>
|
|
2107
|
-
* ...
|
|
2108
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Search)
|
|
1973
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Search)
|
|
2109
1974
|
*/
|
|
2110
1975
|
searchFeature ? : object|Boolean|string|Search|SearchConfig
|
|
2111
1976
|
/**
|
|
2112
1977
|
* Feature that displays a text field to edit the event name.
|
|
2113
|
-
* ...
|
|
2114
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/SimpleEventEdit)
|
|
1978
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/SimpleEventEdit)
|
|
2115
1979
|
*/
|
|
2116
1980
|
simpleEventEditFeature ? : object|Boolean|string|SimpleEventEdit|SimpleEventEditConfig
|
|
2117
1981
|
/**
|
|
2118
1982
|
* Allows sorting of grid by clicking (or tapping) headers, also displays which columns grid is sorted by (numbered if
|
|
2119
1983
|
* using multisort). Use modifier keys for multisorting: [Ctrl/CMD + click] to add sorter, [Ctrl/CMD + Alt + click] to remove sorter.
|
|
2120
1984
|
* The actual sorting is done by the store, see [Store.sort()](https://bryntum.com/products/schedulerpro/docs/api/Core/data/mixin/StoreSort#function-sort).
|
|
2121
|
-
* ...
|
|
2122
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Sort)
|
|
1985
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Sort)
|
|
2123
1986
|
*/
|
|
2124
1987
|
sortFeature ? : object|Boolean|string|Sort|SortConfig
|
|
2125
1988
|
/**
|
|
2126
1989
|
* This feature allows splitting the Scheduler into multiple views, either by using the cell context menu, or
|
|
2127
1990
|
* programmatically by calling [split()](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/Split#function-split).
|
|
2128
|
-
* ...
|
|
2129
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/Split)
|
|
1991
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/Split)
|
|
2130
1992
|
*/
|
|
2131
1993
|
splitFeature ? : object|Boolean|string|Split|SplitConfig
|
|
2132
1994
|
/**
|
|
2133
|
-
* A feature which pins
|
|
2134
|
-
*
|
|
2135
|
-
*
|
|
2136
|
-
* [
|
|
1995
|
+
* A feature which pins cell content to the top of the grid while the row scrolls off the top but is still visible. Very
|
|
1996
|
+
* similar to native `position: sticky`, which because of Grid's multiple-region setup unfortunately cannot be used to
|
|
1997
|
+
* achieve the same effect.
|
|
1998
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/StickyCells)
|
|
2137
1999
|
*/
|
|
2138
2000
|
stickyCellsFeature ? : object|Boolean|string|StickyCells|StickyCellsConfig
|
|
2139
2001
|
/**
|
|
2140
2002
|
* This feature applies native `position: sticky` to event contents in horizontal mode, keeping the contents in view as
|
|
2141
2003
|
* long as possible on scroll. For vertical mode it uses a programmatic solution to achieve the same result.
|
|
2142
|
-
* ...
|
|
2143
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/StickyEvents)
|
|
2004
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/StickyEvents)
|
|
2144
2005
|
*/
|
|
2145
2006
|
stickyEventsFeature ? : object|Boolean|string|StickyEvents|StickyEventsConfig
|
|
2146
2007
|
/**
|
|
2147
2008
|
* Stripes rows by adding alternating CSS classes to all row elements (`b-even` and `b-odd`).
|
|
2148
|
-
*
|
|
2149
|
-
*
|
|
2009
|
+
* This improves visual readability in data-heavy grids by giving adjacent rows different background colors.
|
|
2010
|
+
* Style the striped rows using the `.b-even` and `.b-odd` CSS classes.
|
|
2011
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Stripe)
|
|
2150
2012
|
*/
|
|
2151
2013
|
stripeFeature ? : object|Boolean|string|Stripe|StripeConfig
|
|
2152
2014
|
/**
|
|
2153
2015
|
* A special version of the Grid Summary feature. This feature displays a summary row in the grid footer.
|
|
2154
|
-
* ...
|
|
2155
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/Summary)
|
|
2016
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/Summary)
|
|
2156
2017
|
*/
|
|
2157
2018
|
summaryFeature ? : object|Boolean|string|Summary|SummaryConfig
|
|
2158
2019
|
/**
|
|
2159
2020
|
* Feature that displays a [Task editor](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/SchedulerTaskEditor), allowing users to edit task data.
|
|
2160
2021
|
* The Task editor is a popup containing tabs with fields for editing task data.
|
|
2161
|
-
* ...
|
|
2162
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/feature/TaskEdit)
|
|
2022
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/feature/TaskEdit)
|
|
2163
2023
|
*/
|
|
2164
2024
|
taskEditFeature ? : object|Boolean|string|TaskEdit|TaskEditConfig
|
|
2165
2025
|
/**
|
|
2166
2026
|
* Adds scheduler specific menu items to the timeline header context menu.
|
|
2167
|
-
* ...
|
|
2168
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/TimeAxisHeaderMenu)
|
|
2027
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/TimeAxisHeaderMenu)
|
|
2169
2028
|
*/
|
|
2170
2029
|
timeAxisHeaderMenuFeature ? : object|Boolean|string|TimeAxisHeaderMenu|TimeAxisHeaderMenuConfig
|
|
2171
2030
|
/**
|
|
@@ -2173,23 +2032,20 @@ defineProps<{
|
|
|
2173
2032
|
* or some important point in time (a `line`, i.e. a range with 0 duration). This feature can also show a current time
|
|
2174
2033
|
* 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
|
|
2175
2034
|
* [cls](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/model/TimeSpan#field-cls) field of the `TimeSpan` class.
|
|
2176
|
-
* ...
|
|
2177
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/TimeRanges)
|
|
2035
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/TimeRanges)
|
|
2178
2036
|
*/
|
|
2179
2037
|
timeRangesFeature ? : object|Boolean|string|TimeRanges|TimeRangesConfig
|
|
2180
2038
|
/**
|
|
2181
2039
|
* Feature that allows selection of a time span in the time axis header. When a time span is selected in the header,
|
|
2182
2040
|
* a [timeSelectionChange](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/TimeSelection#event-timeSelectionChange) event is fired.
|
|
2183
|
-
* ...
|
|
2184
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/TimeSelection)
|
|
2041
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/TimeSelection)
|
|
2185
2042
|
*/
|
|
2186
2043
|
timeSelectionFeature ? : object|Boolean|string|TimeSelection|TimeSelectionConfig
|
|
2187
2044
|
/**
|
|
2188
2045
|
* This feature exposes methods on the owning Scheduler or Gantt widget which you can use to highlight one or multiple time spans
|
|
2189
2046
|
* in the schedule. Please see [highlightTimeSpan](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/feature/TimeSpanHighlight#function-highlightTimeSpan) and [highlightTimeSpans](#SchedulerPro/feature/TimeSpanHighlight#function-highlightTimeSpans) to learn
|
|
2190
2047
|
* more or try the demo below:
|
|
2191
|
-
* ...
|
|
2192
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/feature/TimeSpanHighlight)
|
|
2048
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/feature/TimeSpanHighlight)
|
|
2193
2049
|
*/
|
|
2194
2050
|
timeSpanHighlightFeature ? : object|Boolean|string|TimeSpanHighlight|TimeSpanHighlightConfig
|
|
2195
2051
|
/**
|
|
@@ -2197,27 +2053,23 @@ defineProps<{
|
|
|
2197
2053
|
* 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
|
|
2198
2054
|
* tree renderer that adds padding and icon to give the appearance of a tree. The original renderer is preserved and
|
|
2199
2055
|
* also called.
|
|
2200
|
-
* ...
|
|
2201
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Tree)
|
|
2056
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Tree)
|
|
2202
2057
|
*/
|
|
2203
2058
|
treeFeature ? : object|Boolean|string|Tree|TreeConfig
|
|
2204
2059
|
/**
|
|
2205
2060
|
* A feature that allows transforming a flat dataset (or the leaves of a hierarchical) into a tree by specifying a
|
|
2206
2061
|
* record field per parent level. Parents are generated based on each leaf's value for those fields.
|
|
2207
|
-
* ...
|
|
2208
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/TreeGroup)
|
|
2062
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/TreeGroup)
|
|
2209
2063
|
*/
|
|
2210
2064
|
treeGroupFeature ? : object|Boolean|string|TreeGroup|TreeGroupConfig
|
|
2211
2065
|
/**
|
|
2212
2066
|
* A feature allowing you to roll up and display values in the time axis cell for each parent row in a tree scheduler.
|
|
2213
|
-
* ...
|
|
2214
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/TreeSummary)
|
|
2067
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/TreeSummary)
|
|
2215
2068
|
*/
|
|
2216
2069
|
treeSummaryFeature ? : object|Boolean|string|TreeSummary|TreeSummaryConfig
|
|
2217
2070
|
/**
|
|
2218
2071
|
* Captures versions (snapshots) of the active project, including a detailed log of the changes new in each version.
|
|
2219
|
-
* ...
|
|
2220
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/feature/Versions)
|
|
2072
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/feature/Versions)
|
|
2221
2073
|
*/
|
|
2222
2074
|
versionsFeature ? : object|Boolean|string|Versions|VersionsConfig
|
|
2223
2075
|
|
|
@@ -2369,9 +2221,8 @@ const emit = defineEmits<{
|
|
|
2369
2221
|
/**
|
|
2370
2222
|
* Fires before an assignment is removed. Can be triggered by user pressing <kbd>Delete</kbd> or <kbd>Backspace</kbd> or
|
|
2371
2223
|
* by the event editor. Can for example be used to display a custom dialog to confirm deletion, in which
|
|
2372
|
-
* case records should be "manually" removed after confirmation
|
|
2373
|
-
* ...
|
|
2374
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-beforeAssignmentDelete)
|
|
2224
|
+
* case records should be "manually" removed after confirmation.
|
|
2225
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-beforeAssignmentDelete)
|
|
2375
2226
|
* @param {string} e Event name
|
|
2376
2227
|
* @param {object} params Event parameters
|
|
2377
2228
|
* @param {string} params.e Event name
|
|
@@ -2379,9 +2230,9 @@ const emit = defineEmits<{
|
|
|
2379
2230
|
* @param {object} params.params.event Event object
|
|
2380
2231
|
* @param {Scheduler.view.Scheduler} params.params.event.source The Scheduler instance
|
|
2381
2232
|
* @param {Scheduler.model.SchedulerAssignmentModel[]} params.params.event.assignmentRecords The assignment records about to be deleted
|
|
2382
|
-
* @param {object} params.params.event.context Additional removal context
|
|
2233
|
+
* @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.
|
|
2383
2234
|
* @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.
|
|
2384
|
-
* @param {boolean} params.params.event.context.finalize.removeRecords Provide `false` to the function to prevent the removal.
|
|
2235
|
+
* @param {boolean} [params.params.event.context.finalize.removeRecords] Provide `false` to the function to prevent the removal.
|
|
2385
2236
|
*/
|
|
2386
2237
|
(e: 'beforeAssignmentDelete', params: ((event: { source: Scheduler, assignmentRecords: SchedulerAssignmentModel[], context: { finalize: { removeRecords?: boolean } } }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
2387
2238
|
/**
|
|
@@ -2401,8 +2252,7 @@ const emit = defineEmits<{
|
|
|
2401
2252
|
(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
|
|
2402
2253
|
/**
|
|
2403
2254
|
* This event fires whenever the [autoCreate gesture](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/SchedulerBase#config-autoCreate) is detected.
|
|
2404
|
-
* ...
|
|
2405
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-beforeAutoCreate)
|
|
2255
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-beforeAutoCreate)
|
|
2406
2256
|
* @param {string} e Event name
|
|
2407
2257
|
* @param {object} params Event parameters
|
|
2408
2258
|
* @param {string} params.e Event name
|
|
@@ -2426,8 +2276,7 @@ const emit = defineEmits<{
|
|
|
2426
2276
|
(e: 'beforeCancelCellEdit', params: ((event: { source: Grid, editorContext: GridLocation }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
2427
2277
|
/**
|
|
2428
2278
|
* 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.
|
|
2429
|
-
* ...
|
|
2430
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-beforeCancelRowEdit)
|
|
2279
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-beforeCancelRowEdit)
|
|
2431
2280
|
* @param {string} e Event name
|
|
2432
2281
|
* @param {object} params Event parameters
|
|
2433
2282
|
* @param {string} params.e Event name
|
|
@@ -2527,8 +2376,7 @@ const emit = defineEmits<{
|
|
|
2527
2376
|
/**
|
|
2528
2377
|
* 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
|
|
2529
2378
|
* [widget](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ScheduleContext#property-widget) is about to be shown.
|
|
2530
|
-
* ...
|
|
2531
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-beforeContextShow)
|
|
2379
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-beforeContextShow)
|
|
2532
2380
|
* @param {string} e Event name
|
|
2533
2381
|
* @param {object} params Event parameters
|
|
2534
2382
|
* @param {string} params.e Event name
|
|
@@ -2558,6 +2406,20 @@ const emit = defineEmits<{
|
|
|
2558
2406
|
* @param {string} params.params.event.entityName 'cell' to distinguish this event from other beforeCopy events
|
|
2559
2407
|
*/
|
|
2560
2408
|
(e: 'beforeCopy', params: ((event: { source: Grid, cells: GridLocation[], data: string, isCut: boolean, entityName: string }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
2409
|
+
/**
|
|
2410
|
+
* Fired before a group of events is created. Return `false` from a listener (may be async) to prevent
|
|
2411
|
+
* group creation.
|
|
2412
|
+
* @param {string} e Event name
|
|
2413
|
+
* @param {object} params Event parameters
|
|
2414
|
+
* @param {string} params.e Event name
|
|
2415
|
+
* @param {object} params.params Event parameters
|
|
2416
|
+
* @param {object} params.params.event Event object
|
|
2417
|
+
* @param {SchedulerPro.view.SchedulerPro} params.params.event.source The Scheduler Pro instance
|
|
2418
|
+
* @param {SchedulerPro.model.EventModel[]} params.params.event.events The events to be grouped
|
|
2419
|
+
* @param {Scheduler.model.SchedulerResourceModel} params.params.event.resourceRecord The target resource
|
|
2420
|
+
* @param {object} params.params.event.data Data for the new parent event
|
|
2421
|
+
*/
|
|
2422
|
+
(e: 'beforeCreateEventGroup', params: ((event: { source: SchedulerPro, events: EventModel[], resourceRecord: SchedulerResourceModel, data: object }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
2561
2423
|
/**
|
|
2562
2424
|
* Fires on the owning Grid before CSV export starts. Return `false` to cancel the export.
|
|
2563
2425
|
* @param {string} e Event name
|
|
@@ -2674,8 +2536,7 @@ const emit = defineEmits<{
|
|
|
2674
2536
|
/**
|
|
2675
2537
|
* Fires on the owning Scheduler at the beginning of the drag gesture. Returning `false` from a listener prevents
|
|
2676
2538
|
* the drag create operation from starting.
|
|
2677
|
-
* ...
|
|
2678
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-beforeDragCreate)
|
|
2539
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-beforeDragCreate)
|
|
2679
2540
|
* @param {string} e Event name
|
|
2680
2541
|
* @param {object} params Event parameters
|
|
2681
2542
|
* @param {string} params.e Event name
|
|
@@ -2689,8 +2550,7 @@ const emit = defineEmits<{
|
|
|
2689
2550
|
/**
|
|
2690
2551
|
* Fires on the owning Scheduler to allow implementer to prevent immediate finalization by setting
|
|
2691
2552
|
* `data.context.async = true` in the listener, to show a confirmation popup etc.
|
|
2692
|
-
* ...
|
|
2693
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-beforeDragCreateFinalize)
|
|
2553
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-beforeDragCreateFinalize)
|
|
2694
2554
|
* @param {string} e Event name
|
|
2695
2555
|
* @param {object} params Event parameters
|
|
2696
2556
|
* @param {string} params.e Event name
|
|
@@ -2724,8 +2584,7 @@ const emit = defineEmits<{
|
|
|
2724
2584
|
* Fires before an event is removed. Can be triggered by user pressing <kbd>Delete</kbd> or <kbd>Backspace</kbd> or by the
|
|
2725
2585
|
* event editor. Return `false` to immediately veto the removal (or a `Promise` yielding `true` or `false`
|
|
2726
2586
|
* for async vetoing).
|
|
2727
|
-
* ...
|
|
2728
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-beforeEventDelete)
|
|
2587
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-beforeEventDelete)
|
|
2729
2588
|
* @param {string} e Event name
|
|
2730
2589
|
* @param {object} params Event parameters
|
|
2731
2590
|
* @param {string} params.e Event name
|
|
@@ -2733,9 +2592,9 @@ const emit = defineEmits<{
|
|
|
2733
2592
|
* @param {object} params.params.event Event object
|
|
2734
2593
|
* @param {Scheduler.view.Scheduler,any} params.params.event.source The Scheduler instance
|
|
2735
2594
|
* @param {Scheduler.model.SchedulerEventModel[]} params.params.event.eventRecords The records about to be deleted
|
|
2736
|
-
* @param {object} params.params.event.context Additional removal context
|
|
2595
|
+
* @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.
|
|
2737
2596
|
* @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.
|
|
2738
|
-
* @param {boolean} params.params.event.context.finalize.removeRecords Provide `false` to the function to prevent the removal.
|
|
2597
|
+
* @param {boolean} [params.params.event.context.finalize.removeRecords] Provide `false` to the function to prevent the removal.
|
|
2739
2598
|
*/
|
|
2740
2599
|
(e: 'beforeEventDelete', params: ((event: { source: Scheduler|any, eventRecords: SchedulerEventModel[], context: { finalize: { removeRecords?: boolean } } }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
2741
2600
|
/**
|
|
@@ -2769,8 +2628,7 @@ const emit = defineEmits<{
|
|
|
2769
2628
|
* It allows implementer to use asynchronous validation/finalization by setting `context.async = true`
|
|
2770
2629
|
* in the listener, for example, to show a confirmation popup, make async data request etc.
|
|
2771
2630
|
* In such case, implementer need to call the `context.finalize()` method manually:
|
|
2772
|
-
* ...
|
|
2773
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-beforeEventDropFinalize)
|
|
2631
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-beforeEventDropFinalize)
|
|
2774
2632
|
* @param {string} e Event name
|
|
2775
2633
|
* @param {object} params Event parameters
|
|
2776
2634
|
* @param {string} params.e Event name
|
|
@@ -2793,8 +2651,7 @@ const emit = defineEmits<{
|
|
|
2793
2651
|
* Fires on the owning Scheduler before an event is displayed in an editor.
|
|
2794
2652
|
* This may be listened for to allow an application to take over event editing duties. Returning `false`
|
|
2795
2653
|
* stops the default editing UI from being shown.
|
|
2796
|
-
* ...
|
|
2797
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-beforeEventEdit)
|
|
2654
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-beforeEventEdit)
|
|
2798
2655
|
* @param {string} e Event name
|
|
2799
2656
|
* @param {object} params Event parameters
|
|
2800
2657
|
* @param {string} params.e Event name
|
|
@@ -2839,8 +2696,7 @@ const emit = defineEmits<{
|
|
|
2839
2696
|
/**
|
|
2840
2697
|
* Fired on the owning Scheduler to allow implementer to prevent immediate finalization by returning a promise
|
|
2841
2698
|
* in the listener, to show a confirmation popup etc
|
|
2842
|
-
* ...
|
|
2843
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-beforeEventResizeFinalize)
|
|
2699
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-beforeEventResizeFinalize)
|
|
2844
2700
|
* @param {string} e Event name
|
|
2845
2701
|
* @param {object} params Event parameters
|
|
2846
2702
|
* @param {string} params.e Event name
|
|
@@ -2862,8 +2718,7 @@ const emit = defineEmits<{
|
|
|
2862
2718
|
/**
|
|
2863
2719
|
* Fires on the owning Scheduler before an event is saved.
|
|
2864
2720
|
* Return `false` to immediately prevent saving
|
|
2865
|
-
* ...
|
|
2866
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-beforeEventSave)
|
|
2721
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-beforeEventSave)
|
|
2867
2722
|
* @param {string} e Event name
|
|
2868
2723
|
* @param {object} params Event parameters
|
|
2869
2724
|
* @param {string} params.e Event name
|
|
@@ -2874,7 +2729,7 @@ const emit = defineEmits<{
|
|
|
2874
2729
|
* @param {Scheduler.model.SchedulerResourceModel[]} params.params.event.resourceRecords The resources to which the event is assigned
|
|
2875
2730
|
* @param {object} params.params.event.values The new values
|
|
2876
2731
|
* @param {object} params.params.event.context Extended save context:
|
|
2877
|
-
* @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.
|
|
2732
|
+
* @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.
|
|
2878
2733
|
* @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.
|
|
2879
2734
|
*/
|
|
2880
2735
|
(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
|
|
@@ -2893,8 +2748,7 @@ const emit = defineEmits<{
|
|
|
2893
2748
|
/**
|
|
2894
2749
|
* Fired on the owning Scheduler to allow implementer to use asynchronous finalization by setting
|
|
2895
2750
|
* `context.async = true` in the listener, to show a confirmation popup etc.
|
|
2896
|
-
* ...
|
|
2897
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-beforeEventSegmentDropFinalize)
|
|
2751
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-beforeEventSegmentDropFinalize)
|
|
2898
2752
|
* @param {string} e Event name
|
|
2899
2753
|
* @param {object} params Event parameters
|
|
2900
2754
|
* @param {string} params.e Event name
|
|
@@ -2924,8 +2778,7 @@ const emit = defineEmits<{
|
|
|
2924
2778
|
/**
|
|
2925
2779
|
* Fired on the owning Scheduler Pro to allow implementer to prevent immediate finalization by setting
|
|
2926
2780
|
* `data.context.async = true` in the listener, to show a confirmation popup etc
|
|
2927
|
-
* ...
|
|
2928
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-beforeEventSegmentResizeFinalize)
|
|
2781
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-beforeEventSegmentResizeFinalize)
|
|
2929
2782
|
* @param {string} e Event name
|
|
2930
2783
|
* @param {object} params Event parameters
|
|
2931
2784
|
* @param {string} params.e Event name
|
|
@@ -2988,8 +2841,7 @@ const emit = defineEmits<{
|
|
|
2988
2841
|
(e: 'beforeFinishCellEdit', params: ((event: { grid: Grid, editorContext: CellEditorContext }) => void)|string): void
|
|
2989
2842
|
/**
|
|
2990
2843
|
* 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.
|
|
2991
|
-
* ...
|
|
2992
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-beforeFinishRowEdit)
|
|
2844
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-beforeFinishRowEdit)
|
|
2993
2845
|
* @param {string} e Event name
|
|
2994
2846
|
* @param {object} params Event parameters
|
|
2995
2847
|
* @param {string} params.e Event name
|
|
@@ -3110,8 +2962,7 @@ const emit = defineEmits<{
|
|
|
3110
2962
|
(e: 'beforeResourceEdit', params: ((event: { source: ResourceGrid, resourceEdit: ResourceEdit, resourceRecord: ResourceModel }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
3111
2963
|
/**
|
|
3112
2964
|
* This event fires before row collapse is started.
|
|
3113
|
-
* ...
|
|
3114
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-beforeRowCollapse)
|
|
2965
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-beforeRowCollapse)
|
|
3115
2966
|
* @param {string} e Event name
|
|
3116
2967
|
* @param {object} params Event parameters
|
|
3117
2968
|
* @param {string} params.e Event name
|
|
@@ -3122,8 +2973,7 @@ const emit = defineEmits<{
|
|
|
3122
2973
|
(e: 'beforeRowCollapse', params: ((event: { record: Model }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
3123
2974
|
/**
|
|
3124
2975
|
* This event fires before row expand is started.
|
|
3125
|
-
* ...
|
|
3126
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-beforeRowExpand)
|
|
2976
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-beforeRowExpand)
|
|
3127
2977
|
* @param {string} e Event name
|
|
3128
2978
|
* @param {object} params Event parameters
|
|
3129
2979
|
* @param {string} params.e Event name
|
|
@@ -3135,8 +2985,7 @@ const emit = defineEmits<{
|
|
|
3135
2985
|
/**
|
|
3136
2986
|
* This event is fired on the owning Scheduler before the selected contexts are rendered.
|
|
3137
2987
|
* The event is triggered only when [multiSelect](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/ScheduleContext#config-multiSelect) is enabled
|
|
3138
|
-
* ...
|
|
3139
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-beforeSelectedContextsShow)
|
|
2988
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-beforeSelectedContextsShow)
|
|
3140
2989
|
* @param {string} e Event name
|
|
3141
2990
|
* @param {object} params Event parameters
|
|
3142
2991
|
* @param {string} params.e Event name
|
|
@@ -3231,8 +3080,7 @@ const emit = defineEmits<{
|
|
|
3231
3080
|
(e: 'beforeStateSave', params: ((event: { state: SchedulerStateInfo }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
3232
3081
|
/**
|
|
3233
3082
|
* Fires on the owning Scheduler or Gantt widget before a task is deleted, return `false` to prevent it.
|
|
3234
|
-
* ...
|
|
3235
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-beforeTaskDelete)
|
|
3083
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-beforeTaskDelete)
|
|
3236
3084
|
* @param {string} e Event name
|
|
3237
3085
|
* @param {object} params Event parameters
|
|
3238
3086
|
* @param {string} params.e Event name
|
|
@@ -3247,8 +3095,7 @@ const emit = defineEmits<{
|
|
|
3247
3095
|
* Fires on the owning Scheduler or Gantt widget instance before a task is displayed in the editor.
|
|
3248
3096
|
* This may be listened to in order to take over the task editing flow. Returning `false`
|
|
3249
3097
|
* stops the default editing UI from being shown.
|
|
3250
|
-
* ...
|
|
3251
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-beforeTaskEdit)
|
|
3098
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-beforeTaskEdit)
|
|
3252
3099
|
* @param {string} e Event name
|
|
3253
3100
|
* @param {object} params Event parameters
|
|
3254
3101
|
* @param {string} params.e Event name
|
|
@@ -3277,8 +3124,7 @@ const emit = defineEmits<{
|
|
|
3277
3124
|
(e: 'beforeTaskEditShow', params: ((event: { source: SchedulerPro, taskEdit: TaskEdit, taskRecord: EventModel, eventElement: HTMLElement, editor: TaskEditorBase }) => void)|string): void
|
|
3278
3125
|
/**
|
|
3279
3126
|
* Fires on the owning Scheduler or Gantt widget instance before a task is saved, return `false` to prevent it.
|
|
3280
|
-
* ...
|
|
3281
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-beforeTaskSave)
|
|
3127
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-beforeTaskSave)
|
|
3282
3128
|
* @param {string} e Event name
|
|
3283
3129
|
* @param {object} params Event parameters
|
|
3284
3130
|
* @param {string} params.e Event name
|
|
@@ -3329,8 +3175,7 @@ const emit = defineEmits<{
|
|
|
3329
3175
|
(e: 'cancelCellEdit', params: ((event: { source: Grid, editorContext: GridLocation, event: Event }) => void)|string): void
|
|
3330
3176
|
/**
|
|
3331
3177
|
* Fires when any other event is fired from the object.
|
|
3332
|
-
* ...
|
|
3333
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-catchAll)
|
|
3178
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-catchAll)
|
|
3334
3179
|
* @param {string} e Event name
|
|
3335
3180
|
* @param {object} params Event parameters
|
|
3336
3181
|
* @param {string} params.e Event name
|
|
@@ -3388,8 +3233,7 @@ const emit = defineEmits<{
|
|
|
3388
3233
|
/**
|
|
3389
3234
|
* This event fires on the owning grid before the context menu is shown for a cell.
|
|
3390
3235
|
* 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).
|
|
3391
|
-
* ...
|
|
3392
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-cellMenuBeforeShow)
|
|
3236
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-cellMenuBeforeShow)
|
|
3393
3237
|
* @param {string} e Event name
|
|
3394
3238
|
* @param {object} params Event parameters
|
|
3395
3239
|
* @param {string} params.e Event name
|
|
@@ -3644,6 +3488,19 @@ const emit = defineEmits<{
|
|
|
3644
3488
|
* @param {string} params.params.event.entityName 'cell' to distinguish this event from other copy events
|
|
3645
3489
|
*/
|
|
3646
3490
|
(e: 'copy', params: ((event: { source: Grid, cells: GridLocation[], copiedDataString: string, isCut: boolean, entityName: string }) => void)|string): void
|
|
3491
|
+
/**
|
|
3492
|
+
* Fired after a group of events has been successfully created.
|
|
3493
|
+
* @param {string} e Event name
|
|
3494
|
+
* @param {object} params Event parameters
|
|
3495
|
+
* @param {string} params.e Event name
|
|
3496
|
+
* @param {object} params.params Event parameters
|
|
3497
|
+
* @param {object} params.params.event Event object
|
|
3498
|
+
* @param {SchedulerPro.view.SchedulerPro} params.params.event.source The Scheduler Pro instance
|
|
3499
|
+
* @param {SchedulerPro.model.EventModel} params.params.event.parentEvent The newly created parent event
|
|
3500
|
+
* @param {SchedulerPro.model.EventModel[]} params.params.event.events The grouped child events
|
|
3501
|
+
* @param {Scheduler.model.SchedulerResourceModel} params.params.event.resourceRecord The target resource
|
|
3502
|
+
*/
|
|
3503
|
+
(e: 'createEventGroup', params: ((event: { source: SchedulerPro, parentEvent: EventModel, events: EventModel[], resourceRecord: SchedulerResourceModel }) => void)|string): void
|
|
3647
3504
|
/**
|
|
3648
3505
|
* Fires on the owning Scheduler/Gantt when the line indicating the current time is updated (see [currentTimeLineUpdateInterval](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/TimeRanges#config-currentTimeLineUpdateInterval)).
|
|
3649
3506
|
* @param {string} e Event name
|
|
@@ -3657,8 +3514,7 @@ const emit = defineEmits<{
|
|
|
3657
3514
|
(e: 'currentTimelineUpdate', params: ((event: { source: Scheduler, date: Date }) => void)|string): void
|
|
3658
3515
|
/**
|
|
3659
3516
|
* Fired when data in the store changes.
|
|
3660
|
-
* ...
|
|
3661
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-dataChange)
|
|
3517
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-dataChange)
|
|
3662
3518
|
* @param {string} e Event name
|
|
3663
3519
|
* @param {object} params Event parameters
|
|
3664
3520
|
* @param {string} params.e Event name
|
|
@@ -3676,8 +3532,7 @@ const emit = defineEmits<{
|
|
|
3676
3532
|
* Fired when the range of dates encapsulated by the UI changes. This will be when
|
|
3677
3533
|
* moving a view in time by reconfiguring its [timeAxis](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/TimelineBase#config-timeAxis). This will happen
|
|
3678
3534
|
* when zooming, or changing [viewPreset](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/TimelineBase#config-viewPreset).
|
|
3679
|
-
* ...
|
|
3680
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-dateRangeChange)
|
|
3535
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-dateRangeChange)
|
|
3681
3536
|
* @param {string} e Event name
|
|
3682
3537
|
* @param {object} params Event parameters
|
|
3683
3538
|
* @param {string} params.e Event name
|
|
@@ -3767,7 +3622,7 @@ const emit = defineEmits<{
|
|
|
3767
3622
|
* @param {Record<string, MenuItemEntry>} params.params.event.items Menu item configs
|
|
3768
3623
|
* @param {Scheduler.model.SchedulerDependencyModel} params.params.event.dependencyRecord Dependency record for which the menu was triggered
|
|
3769
3624
|
* @param {HTMLElement} params.params.event.element
|
|
3770
|
-
* @param {MouseEvent} params.params.event.event Pointer event which triggered the context menu (if any)
|
|
3625
|
+
* @param {MouseEvent} [params.params.event.event] Pointer event which triggered the context menu (if any)
|
|
3771
3626
|
*/
|
|
3772
3627
|
(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
|
|
3773
3628
|
/**
|
|
@@ -4147,7 +4002,7 @@ const emit = defineEmits<{
|
|
|
4147
4002
|
* @param {Scheduler.model.SchedulerResourceModel} params.params.event.resourceRecord Resource record
|
|
4148
4003
|
* @param {Scheduler.model.SchedulerAssignmentModel} params.params.event.assignmentRecord Assignment record, if assignments are used
|
|
4149
4004
|
* @param {HTMLElement} params.params.event.eventElement
|
|
4150
|
-
* @param {MouseEvent} params.params.event.event Pointer event which triggered the context menu (if any)
|
|
4005
|
+
* @param {MouseEvent} [params.params.event.event] Pointer event which triggered the context menu (if any)
|
|
4151
4006
|
*/
|
|
4152
4007
|
(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
|
|
4153
4008
|
/**
|
|
@@ -4245,8 +4100,7 @@ const emit = defineEmits<{
|
|
|
4245
4100
|
(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
|
|
4246
4101
|
/**
|
|
4247
4102
|
* Triggered for mouse out events within and when moving out of an event bar.
|
|
4248
|
-
* ...
|
|
4249
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-eventMouseOut)
|
|
4103
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-eventMouseOut)
|
|
4250
4104
|
* @param {string} e Event name
|
|
4251
4105
|
* @param {object} params Event parameters
|
|
4252
4106
|
* @param {string} params.e Event name
|
|
@@ -4268,8 +4122,7 @@ const emit = defineEmits<{
|
|
|
4268
4122
|
(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
|
|
4269
4123
|
/**
|
|
4270
4124
|
* Triggered for mouse over events when moving into and within an event bar.
|
|
4271
|
-
* ...
|
|
4272
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-eventMouseOver)
|
|
4125
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-eventMouseOver)
|
|
4273
4126
|
* @param {string} e Event name
|
|
4274
4127
|
* @param {object} params Event parameters
|
|
4275
4128
|
* @param {string} params.e Event name
|
|
@@ -4563,8 +4416,7 @@ const emit = defineEmits<{
|
|
|
4563
4416
|
(e: 'finishCellEdit', params: ((event: { grid: Grid, editorContext: CellEditorContext }) => void)|string): void
|
|
4564
4417
|
/**
|
|
4565
4418
|
* 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.
|
|
4566
|
-
* ...
|
|
4567
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-finishRowEdit)
|
|
4419
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-finishRowEdit)
|
|
4568
4420
|
* @param {string} e Event name
|
|
4569
4421
|
* @param {object} params Event parameters
|
|
4570
4422
|
* @param {string} params.e Event name
|
|
@@ -4700,8 +4552,7 @@ const emit = defineEmits<{
|
|
|
4700
4552
|
(e: 'gridRowDrop', params: ((event: { source: GridBase, context: { valid: boolean, insertBefore: Model, parent: Model, records: Model[], oldPositionContext: RecordPositionContext[] }, event: MouseEvent }) => void)|string): void
|
|
4701
4553
|
/**
|
|
4702
4554
|
* Fired when a grid header is clicked on.
|
|
4703
|
-
* ...
|
|
4704
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-headerClick)
|
|
4555
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-headerClick)
|
|
4705
4556
|
* @param {string} e Event name
|
|
4706
4557
|
* @param {object} params Event parameters
|
|
4707
4558
|
* @param {string} params.e Event name
|
|
@@ -4714,8 +4565,7 @@ const emit = defineEmits<{
|
|
|
4714
4565
|
/**
|
|
4715
4566
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
4716
4567
|
* 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).
|
|
4717
|
-
* ...
|
|
4718
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-headerMenuBeforeShow)
|
|
4568
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-headerMenuBeforeShow)
|
|
4719
4569
|
* @param {string} e Event name
|
|
4720
4570
|
* @param {object} params Event parameters
|
|
4721
4571
|
* @param {string} params.e Event name
|
|
@@ -4834,8 +4684,7 @@ const emit = defineEmits<{
|
|
|
4834
4684
|
/**
|
|
4835
4685
|
* Triggered when a widget which had been in a non-visible state for any reason
|
|
4836
4686
|
* achieves visibility.
|
|
4837
|
-
* ...
|
|
4838
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-paint)
|
|
4687
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-paint)
|
|
4839
4688
|
* @param {string} e Event name
|
|
4840
4689
|
* @param {object} params Event parameters
|
|
4841
4690
|
* @param {string} params.e Event name
|
|
@@ -4889,8 +4738,8 @@ const emit = defineEmits<{
|
|
|
4889
4738
|
* @param {string} params.e Event name
|
|
4890
4739
|
* @param {object} params.params Event parameters
|
|
4891
4740
|
* @param {object} params.params.event Event object
|
|
4892
|
-
* @param {Response} params.params.event.response Optional response, if received
|
|
4893
|
-
* @param {Error} params.params.event.error Optional error, if exception occurred
|
|
4741
|
+
* @param {Response} [params.params.event.response] Optional response, if received
|
|
4742
|
+
* @param {Error} [params.params.event.error] Optional error, if exception occurred
|
|
4894
4743
|
*/
|
|
4895
4744
|
(e: 'pdfExport', params: ((event: { response?: Response, error?: Error }) => void)|string): void
|
|
4896
4745
|
/**
|
|
@@ -5212,8 +5061,7 @@ const emit = defineEmits<{
|
|
|
5212
5061
|
/**
|
|
5213
5062
|
* This event fires on the owning scheduler before the context menu is shown for a resource.
|
|
5214
5063
|
* 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).
|
|
5215
|
-
* ...
|
|
5216
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-resourceMenuBeforeShow)
|
|
5064
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-resourceMenuBeforeShow)
|
|
5217
5065
|
* @param {string} e Event name
|
|
5218
5066
|
* @param {object} params Event parameters
|
|
5219
5067
|
* @param {string} params.e Event name
|
|
@@ -5502,8 +5350,7 @@ const emit = defineEmits<{
|
|
|
5502
5350
|
(e: 'rowCollapse', params: ((event: { record: Model }) => void)|string): void
|
|
5503
5351
|
/**
|
|
5504
5352
|
* This event fires when a row expand has finished expanding.
|
|
5505
|
-
* ...
|
|
5506
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-rowExpand)
|
|
5353
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-rowExpand)
|
|
5507
5354
|
* @param {string} e Event name
|
|
5508
5355
|
* @param {object} params Event parameters
|
|
5509
5356
|
* @param {string} params.e Event name
|
|
@@ -5785,7 +5632,7 @@ const emit = defineEmits<{
|
|
|
5785
5632
|
* @param {object} params.params Event parameters
|
|
5786
5633
|
* @param {object} params.params.event Event object
|
|
5787
5634
|
* @param {Scheduler.view.TimelineBase} params.params.event.source This Scheduler/Gantt instance.
|
|
5788
|
-
* @param {object} params.params.event.old The shift increment *if any*.
|
|
5635
|
+
* @param {object} [params.params.event.old] The shift increment *if any*.
|
|
5789
5636
|
* @param {object} params.params.event.new The shift increment
|
|
5790
5637
|
*/
|
|
5791
5638
|
(e: 'shiftIncrementChange', params: ((event: { source: TimelineBase, old?: object, new: object }) => void)|string): void
|
|
@@ -6001,8 +5848,7 @@ const emit = defineEmits<{
|
|
|
6001
5848
|
(e: 'tickCellMouseUp', params: ((event: { source: Scheduler, feature: TreeSummary, startDate: Date, endDate: Date, resourceRecord: SchedulerResourceModel, domEvent: MouseEvent }) => void)|string): void
|
|
6002
5849
|
/**
|
|
6003
5850
|
* Fired when the tick size changes.
|
|
6004
|
-
* ...
|
|
6005
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-tickSizeChange)
|
|
5851
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-tickSizeChange)
|
|
6006
5852
|
* @param {string} e Event name
|
|
6007
5853
|
* @param {object} params Event parameters
|
|
6008
5854
|
* @param {string} params.e Event name
|
|
@@ -6067,8 +5913,7 @@ const emit = defineEmits<{
|
|
|
6067
5913
|
/**
|
|
6068
5914
|
* This event fires on the owning Scheduler or Gantt widget before the context menu is shown for the time axis header.
|
|
6069
5915
|
* 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).
|
|
6070
|
-
* ...
|
|
6071
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-timeAxisHeaderMenuBeforeShow)
|
|
5916
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-timeAxisHeaderMenuBeforeShow)
|
|
6072
5917
|
* @param {string} e Event name
|
|
6073
5918
|
* @param {object} params Event parameters
|
|
6074
5919
|
* @param {string} params.e Event name
|
|
@@ -6204,7 +6049,7 @@ const emit = defineEmits<{
|
|
|
6204
6049
|
* @param {Core.data.Model} params.params.event.groupRecord [DEPRECATED] Use `groupRecords` param instead
|
|
6205
6050
|
* @param {Core.data.Model[]} params.params.event.groupRecords The group records being toggled
|
|
6206
6051
|
* @param {boolean} params.params.event.collapse Collapsed (true) or expanded (false)
|
|
6207
|
-
* @param {boolean} params.params.event.allRecords True if this event is part of toggling all groups
|
|
6052
|
+
* @param {boolean} [params.params.event.allRecords] True if this event is part of toggling all groups
|
|
6208
6053
|
*/
|
|
6209
6054
|
(e: 'toggleGroup', params: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, allRecords?: boolean }) => void)|string): void
|
|
6210
6055
|
/**
|
|
@@ -6231,8 +6076,7 @@ const emit = defineEmits<{
|
|
|
6231
6076
|
(e: 'toolClick', params: ((event: { source: Tool, tool: Tool }) => void)|string): void
|
|
6232
6077
|
/**
|
|
6233
6078
|
* <strong>Note that this event fires on the owning [SchedulerPro](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerPro).</strong>
|
|
6234
|
-
* ...
|
|
6235
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-transactionChange)
|
|
6079
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-transactionChange)
|
|
6236
6080
|
* @param {string} e Event name
|
|
6237
6081
|
* @param {object} params Event parameters
|
|
6238
6082
|
* @param {string} params.e Event name
|
|
@@ -6270,8 +6114,7 @@ const emit = defineEmits<{
|
|
|
6270
6114
|
/**
|
|
6271
6115
|
* Fired when the range of dates visible within the viewport changes. This will be when
|
|
6272
6116
|
* scrolling along a time axis.
|
|
6273
|
-
* ...
|
|
6274
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-visibleDateRangeChange)
|
|
6117
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-visibleDateRangeChange)
|
|
6275
6118
|
* @param {string} e Event name
|
|
6276
6119
|
* @param {object} params Event parameters
|
|
6277
6120
|
* @param {string} params.e Event name
|
|
@@ -6286,6 +6129,18 @@ const emit = defineEmits<{
|
|
|
6286
6129
|
* @param {Date} params.params.event.new.endDate the new end date.
|
|
6287
6130
|
*/
|
|
6288
6131
|
(e: 'visibleDateRangeChange', params: ((event: { source: Scheduler, old: { startDate: Date, endDate: Date }, new: { startDate: Date, endDate: Date } }) => void)|string): void
|
|
6132
|
+
/**
|
|
6133
|
+
* Fires when the smooth zoom level changes, either through programmatic zoom methods or mouse wheel zooming.
|
|
6134
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerProBase#event-zoomLevelChange)
|
|
6135
|
+
* @param {string} e Event name
|
|
6136
|
+
* @param {object} params Event parameters
|
|
6137
|
+
* @param {string} params.e Event name
|
|
6138
|
+
* @param {object} params.params Event parameters
|
|
6139
|
+
* @param {object} params.params.event Event object
|
|
6140
|
+
* @param {Scheduler.view.TimelineBase} params.params.event.source
|
|
6141
|
+
* @param {number} params.params.event.zoomLevel New zoom level
|
|
6142
|
+
*/
|
|
6143
|
+
(e: 'zoomLevelChange', params: ((event: { source: TimelineBase, zoomLevel: number }) => void)|string): void
|
|
6289
6144
|
}>();
|
|
6290
6145
|
|
|
6291
6146
|
const widgetData = {
|
|
@@ -6489,6 +6344,7 @@ const widgetData = {
|
|
|
6489
6344
|
'resourceTimeRangeRenderer',
|
|
6490
6345
|
'responsiveLevels',
|
|
6491
6346
|
'ripple',
|
|
6347
|
+
'role',
|
|
6492
6348
|
'rootElement',
|
|
6493
6349
|
'schedulingIssueResolutionPopupClass',
|
|
6494
6350
|
'scrollerClass',
|
|
@@ -6500,6 +6356,7 @@ const widgetData = {
|
|
|
6500
6356
|
'showLagInTooltip',
|
|
6501
6357
|
'showRecurringUI',
|
|
6502
6358
|
'showTaskColorPickers',
|
|
6359
|
+
'smoothZoom',
|
|
6503
6360
|
'snapRelativeToEventStartDate',
|
|
6504
6361
|
'startParamName',
|
|
6505
6362
|
'stateful',
|
|
@@ -6586,6 +6443,7 @@ const widgetData = {
|
|
|
6586
6443
|
'isEventSelectable',
|
|
6587
6444
|
'keyMap',
|
|
6588
6445
|
'labelPosition',
|
|
6446
|
+
'labelWidth',
|
|
6589
6447
|
'lazyLoadingIndicator',
|
|
6590
6448
|
'longPressTime',
|
|
6591
6449
|
'margin',
|
|
@@ -6627,6 +6485,7 @@ const widgetData = {
|
|
|
6627
6485
|
'onBeforeColumnResize',
|
|
6628
6486
|
'onBeforeContextShow',
|
|
6629
6487
|
'onBeforeCopy',
|
|
6488
|
+
'onBeforeCreateEventGroup',
|
|
6630
6489
|
'onBeforeCSVExport',
|
|
6631
6490
|
'onBeforeDependencyAdd',
|
|
6632
6491
|
'onBeforeDependencyCreateDrag',
|
|
@@ -6706,6 +6565,7 @@ const widgetData = {
|
|
|
6706
6565
|
'onContextMenuItem',
|
|
6707
6566
|
'onContextMenuToggleItem',
|
|
6708
6567
|
'onCopy',
|
|
6568
|
+
'onCreateEventGroup',
|
|
6709
6569
|
'onCurrentTimelineUpdate',
|
|
6710
6570
|
'onDataChange',
|
|
6711
6571
|
'onDateRangeChange',
|
|
@@ -6899,6 +6759,7 @@ const widgetData = {
|
|
|
6899
6759
|
'onUnlockRows',
|
|
6900
6760
|
'onUnsplit',
|
|
6901
6761
|
'onVisibleDateRangeChange',
|
|
6762
|
+
'onZoomLevelChange',
|
|
6902
6763
|
'overlappingEventSorter',
|
|
6903
6764
|
'preserveScroll',
|
|
6904
6765
|
'presets',
|
|
@@ -6947,13 +6808,10 @@ const widgetData = {
|
|
|
6947
6808
|
'viewPreset',
|
|
6948
6809
|
'visibleDate',
|
|
6949
6810
|
'width',
|
|
6950
|
-
'workingTime'
|
|
6811
|
+
'workingTime',
|
|
6812
|
+
'zoomFactor'
|
|
6951
6813
|
],
|
|
6952
6814
|
propertyNames : [
|
|
6953
|
-
'focusVisible',
|
|
6954
|
-
'hasChanges',
|
|
6955
|
-
'isEngineReady',
|
|
6956
|
-
'isNavigatingTimelineCells',
|
|
6957
6815
|
'originalStore',
|
|
6958
6816
|
'parent',
|
|
6959
6817
|
'scrollLeft',
|
|
@@ -6997,6 +6855,7 @@ const widgetData = {
|
|
|
6997
6855
|
'beforeColumnResize',
|
|
6998
6856
|
'beforeContextShow',
|
|
6999
6857
|
'beforeCopy',
|
|
6858
|
+
'beforeCreateEventGroup',
|
|
7000
6859
|
'beforeCSVExport',
|
|
7001
6860
|
'beforeDependencyAdd',
|
|
7002
6861
|
'beforeDependencyCreateDrag',
|
|
@@ -7076,6 +6935,7 @@ const widgetData = {
|
|
|
7076
6935
|
'contextMenuItem',
|
|
7077
6936
|
'contextMenuToggleItem',
|
|
7078
6937
|
'copy',
|
|
6938
|
+
'createEventGroup',
|
|
7079
6939
|
'currentTimelineUpdate',
|
|
7080
6940
|
'dataChange',
|
|
7081
6941
|
'dateRangeChange',
|
|
@@ -7268,7 +7128,8 @@ const widgetData = {
|
|
|
7268
7128
|
'treeGroup',
|
|
7269
7129
|
'unlockRows',
|
|
7270
7130
|
'unsplit',
|
|
7271
|
-
'visibleDateRangeChange'
|
|
7131
|
+
'visibleDateRangeChange',
|
|
7132
|
+
'zoomLevelChange'
|
|
7272
7133
|
]
|
|
7273
7134
|
};
|
|
7274
7135
|
|