@bryntum/scheduler-thin-trial 7.1.3 → 7.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/entry.js +3 -0
- package/lib/column/ResourceInfoColumn.css +20 -0
- package/lib/column/ResourceInfoColumn.js +1 -1
- package/lib/crud/AbstractCrudManagerMixin.js +1 -1
- package/lib/data/AISettingsModel.js +1 -0
- package/lib/data/mixin/DependencyStoreMixin.js +1 -1
- package/lib/data/mixin/EventStoreMixin.js +1 -1
- package/lib/data/mixin/GetEventsMixin.js +1 -1
- package/lib/feature/AI.js +1 -0
- package/lib/feature/AbstractTimeRanges.js +1 -1
- package/lib/feature/Dependencies.js +1 -1
- package/lib/feature/DependencyEdit.js +1 -1
- package/lib/feature/DependencyMenu.js +1 -1
- package/lib/feature/EventCopyPaste.js +1 -1
- package/lib/feature/EventDragSelect.js +1 -1
- package/lib/feature/EventEdit.js +1 -1
- package/lib/feature/EventFilter.js +1 -1
- package/lib/feature/EventMenu.js +1 -1
- package/lib/feature/EventNonWorkingTime.js +1 -1
- package/lib/feature/EventResize.js +1 -1
- package/lib/feature/GroupSummary.js +1 -1
- package/lib/feature/Labels.js +1 -1
- package/lib/feature/LockRows.js +1 -1
- package/lib/feature/NonWorkingTime.js +1 -1
- package/lib/feature/Pan.js +1 -1
- package/lib/feature/ResourceColumnReorder.css +78 -0
- package/lib/feature/ResourceColumnReorder.js +1 -0
- package/lib/feature/ResourceMenu.js +1 -1
- package/lib/feature/ScheduleContext.js +1 -1
- package/lib/feature/ScheduleMenu.js +1 -1
- package/lib/feature/ScheduleTooltip.js +1 -1
- package/lib/feature/ScrollButtons.js +1 -1
- package/lib/feature/SimpleEventEdit.js +1 -1
- package/lib/feature/Split.js +1 -1
- package/lib/feature/StickyEvents.js +1 -1
- package/lib/feature/Summary.js +1 -1
- package/lib/feature/TimeAxisHeaderMenu.js +1 -1
- package/lib/feature/TimelineSummary.js +1 -1
- package/lib/feature/TreeSummary.js +1 -1
- package/lib/feature/ai/agents/DefaultSchedulerAgent.js +18 -0
- package/lib/feature/ai/agents/trainingData.js +1 -0
- package/lib/feature/base/DragBase.js +1 -1
- package/lib/feature/base/DragCreateBase.js +1 -1
- package/lib/feature/base/EditBase.js +1 -1
- package/lib/feature/base/ResourceTimeRangesBase.js +1 -1
- package/lib/feature/base/TooltipBase.js +1 -1
- package/lib/feature/mixin/DependencyCreation.js +1 -1
- package/lib/feature/mixin/HeaderDragSelect.js +1 -1
- package/lib/feature/mixin/RecurringEventEdit.js +1 -1
- package/lib/model/DependencyBaseModel.js +1 -1
- package/lib/model/TimeSpan.js +1 -1
- package/lib/model/mixin/EventModelMixin.js +1 -1
- package/lib/model/mixin/RecurringTimeSpan.js +1 -1
- package/lib/model/mixin/ResourceModelMixin.js +1 -1
- package/lib/view/ResourceHeader.js +1 -1
- package/lib/view/SchedulerBase.js +1 -1
- package/lib/view/TimelineBase.js +1 -1
- package/lib/view/mixin/EventNavigation.js +1 -1
- package/lib/view/mixin/SchedulerDom.js +1 -1
- package/lib/view/mixin/SchedulerEventRendering.js +1 -1
- package/lib/view/mixin/SchedulerState.js +1 -1
- package/lib/view/mixin/TimelineDomEvents.js +1 -1
- package/lib/view/mixin/TimelineEventRendering.js +1 -1
- package/lib/view/mixin/TimelineViewPresets.js +1 -1
- package/lib/view/orientation/HorizontalRendering.js +1 -1
- package/lib/view/orientation/VerticalRendering.js +1 -1
- package/lib/view/recurrence/RecurrenceEditorPanel.js +1 -1
- package/lib/view/recurrence/RecurrenceLegendButton.js +1 -1
- package/lib/widget/DayButtons.js +1 -1
- package/lib/widget/SchedulerDatePicker.css +1 -1
- package/locales/scheduler.locale.Ar.js +1 -1
- package/locales/scheduler.locale.Bg.js +1 -1
- package/locales/scheduler.locale.Ca.js +1 -1
- package/locales/scheduler.locale.Cs.js +1 -1
- package/locales/scheduler.locale.Da.js +1 -1
- package/locales/scheduler.locale.De.js +1 -1
- package/locales/scheduler.locale.El.js +1 -1
- package/locales/scheduler.locale.En.js +1 -1
- package/locales/scheduler.locale.EnGb.js +1 -1
- package/locales/scheduler.locale.Es.js +1 -1
- package/locales/scheduler.locale.Et.js +1 -1
- package/locales/scheduler.locale.Eu.js +1 -1
- package/locales/scheduler.locale.Fi.js +1 -1
- package/locales/scheduler.locale.FrFr.js +1 -1
- package/locales/scheduler.locale.Gl.js +1 -1
- package/locales/scheduler.locale.He.js +1 -1
- package/locales/scheduler.locale.Hi.js +1 -1
- package/locales/scheduler.locale.Hr.js +1 -1
- package/locales/scheduler.locale.Hu.js +1 -1
- package/locales/scheduler.locale.Id.js +1 -1
- package/locales/scheduler.locale.It.js +1 -1
- package/locales/scheduler.locale.Ja.js +1 -1
- package/locales/scheduler.locale.Kk.js +1 -1
- package/locales/scheduler.locale.Ko.js +1 -1
- package/locales/scheduler.locale.Lt.js +1 -1
- package/locales/scheduler.locale.Lv.js +1 -1
- package/locales/scheduler.locale.Ms.js +1 -1
- package/locales/scheduler.locale.Nl.js +1 -1
- package/locales/scheduler.locale.No.js +1 -1
- package/locales/scheduler.locale.Pl.js +1 -1
- package/locales/scheduler.locale.Pt.js +1 -1
- package/locales/scheduler.locale.PtBr.js +1 -1
- package/locales/scheduler.locale.Ro.js +1 -1
- package/locales/scheduler.locale.Ru.js +1 -1
- package/locales/scheduler.locale.Sk.js +1 -1
- package/locales/scheduler.locale.Sl.js +1 -1
- package/locales/scheduler.locale.Sr.js +1 -1
- package/locales/scheduler.locale.SrRs.js +1 -1
- package/locales/scheduler.locale.SvSE.js +1 -1
- package/locales/scheduler.locale.Th.js +1 -1
- package/locales/scheduler.locale.Tr.js +1 -1
- package/locales/scheduler.locale.Uk.js +1 -1
- package/locales/scheduler.locale.Vi.js +1 -1
- package/locales/scheduler.locale.ZhCn.js +1 -1
- package/locales/scheduler.locale.ZhTw.js +1 -1
- package/package.json +1 -1
- package/scheduler.css +56 -1
- package/scheduler.css.map +3 -3
- package/scheduler.d.ts +1689 -348
package/scheduler.d.ts
CHANGED
|
@@ -1,35 +1,37 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
1
|
+
import { AIModelConfiguration, AIModelSelector, AITool, AIToolConfig, AIVoiceActivationConfig, AbstractApiPlugin, AjaxStore,
|
|
2
|
+
AjaxStoreConfig, AlignSpec, AnimateScrollOptions, Base, BryntumListenerConfig, BryntumScrollOptions, Button, ButtonGroup, CalendarPanel,
|
|
3
|
+
CellWidgetContext, ChatButton, ChatButtonConfig, ChipView, ChipViewConfig, Collection, CollectionCompareOperator, CollectionConfig,
|
|
4
|
+
CollectionFilter, CollectionFilterConfig, CollectionSorter, CollectionSorterConfig, Color, ColorDescriptor, ColorField, ColorPicker,
|
|
5
|
+
Combo, ComboModel, Container, ContextMenuBase, AISettingsModel as CoreAISettingsModel, DataField, DataLoadRequestResponse, DateField,
|
|
6
|
+
DatePicker, DisplayField, DomClassList, DomConfig, DragHelper, DragHelperConfig, Duration, DurationConfig, DurationField, DurationUnit,
|
|
7
|
+
DurationUnitShort, Editor, EditorConfig, EventsClass, FetchOptions, Field, FieldContainer, FieldContainerConfig, FieldTriggerConfig,
|
|
8
|
+
FormulaProvider, FormulaProviderConfig, Grouper, Histogram, HistogramConfig, HistogramSeries, HttpMethods, InstancePlugin, KeyMap,
|
|
9
|
+
KeyMapConfig, LazyLoadRequestParams, List, ListConfig, LoadMaskableClass, LocaleHelper, LocaleManager, Mask, MaskConfig, Menu,
|
|
10
|
+
MenuConfig, MenuContext, MenuItem, MenuItemEntry, Model, Month, MonthConfig, NumberFormat, NumberFormatConfig, PagingRequestParams,
|
|
11
|
+
PagingToolbar, PagingToolbarConfig, Panel, PanelCollapser, PanelCollapserConfig, PanelCollapserOverlay, PanelCollapserOverlayConfig,
|
|
12
|
+
PanelHeader, Popup, PopupConfig, Rectangle, RelationConfig, ScrollManager, ScrollManagerConfig, Scroller, ScrollerConfig, Sorter,
|
|
13
|
+
StateProvider, StateTrackingManager, StateTrackingManagerConfig, Store, StoreConfig, SyncDataOnLoadOptions, Tab, TabConfig, TextField,
|
|
14
|
+
TimeField, Tool, ToolConfig, Toolbar, ToolbarConfig, ToolbarItems, Tooltip, TooltipConfig, UndoRedoBase, VueConfig, Widget } from
|
|
15
|
+
'@bryntum/core-thin'
|
|
14
16
|
import { AIFilter, AIFilterConfig, CellCopyPaste, CellCopyPasteConfig, CellEdit, CellEditConfig, CellEditorContext, CellMenu,
|
|
15
17
|
CellMenuConfig, CellTooltip, CellTooltipConfig, Charts, ChartsConfig, ColorColumn, Column, ColumnAutoWidth, ColumnAutoWidthConfig,
|
|
16
18
|
ColumnDragToolbar, ColumnDragToolbarConfig, ColumnPicker, ColumnPickerConfig, ColumnRename, ColumnRenameConfig, ColumnReorder,
|
|
17
19
|
ColumnReorderConfig, ColumnResize, ColumnResizeConfig, ColumnStore, ColumnStoreConfig, ColumnSummaryConfig, CopyPasteBase,
|
|
18
20
|
EmptyTextDomConfig, ExportConfig, ExportDialog, Exporter, ExporterBase, FileDrop, FileDropConfig, FillHandle, FillHandleConfig, Filter,
|
|
19
|
-
FilterBar, FilterBarConfig, FilterConfig, Grid,
|
|
20
|
-
GridContainerItemConfig, GridContainerLayoutConfig, ExcelExporter as GridExcelExporter,
|
|
21
|
-
GroupSummary as GridGroupSummary, GroupSummaryConfig as GridGroupSummaryConfig,
|
|
22
|
-
LockRows as GridLockRows, LockRowsConfig as GridLockRowsConfig,
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
WidgetColumn, XLSColumn, XlsProviderBase } from '@bryntum/grid-thin'
|
|
21
|
+
FilterBar, FilterBarConfig, FilterConfig, Grid, AI as GridAI, AIConfig as GridAIConfig, GridBase, GridColumn, GridColumnConfig,
|
|
22
|
+
GridConfig, GridContainerItem, GridContainerItemConfig, GridContainerLayoutConfig, ExcelExporter as GridExcelExporter,
|
|
23
|
+
ExcelExporterConfig as GridExcelExporterConfig, GroupSummary as GridGroupSummary, GroupSummaryConfig as GridGroupSummaryConfig,
|
|
24
|
+
GridInputFieldConfig, GridLocation, GridLocationConfig, LockRows as GridLockRows, LockRowsConfig as GridLockRowsConfig,
|
|
25
|
+
GridModelFieldConfig, MultiPageExporter as GridMultiPageExporter, MultiPageVerticalExporter as GridMultiPageVerticalExporter, PdfExport
|
|
26
|
+
as GridPdfExport, PdfExportConfig as GridPdfExportConfig, Print as GridPrint, PrintConfig as GridPrintConfig, GridRowModel, RowReorder
|
|
27
|
+
as GridRowReorder, RowReorderConfig as GridRowReorderConfig, RowResize as GridRowResize, RowResizeConfig as GridRowResizeConfig,
|
|
28
|
+
GridScrollOptions, GridSelectionMode, SinglePageExporter as GridSinglePageExporter, SinglePageUnscaledExporter as
|
|
29
|
+
GridSinglePageUnscaledExporter, Split as GridSplit, SplitConfig as GridSplitConfig, GridStateInfo, Summary as GridSummary, SummaryConfig
|
|
30
|
+
as GridSummaryConfig, Group, GroupConfig, HeaderMenu, HeaderMenuConfig, MergeCells, MergeCellsConfig, NumberColumn, PinColumns,
|
|
31
|
+
PinColumnsConfig, PreserveScrollOptions, QuickFind, QuickFindConfig, RecordPositionContext, RegionResize, RegionResizeConfig,
|
|
32
|
+
ResponsiveLevelConfig, Row, RowCopyPaste, RowCopyPasteConfig, RowEdit, RowEditConfig, RowEditorContext, RowExpander, RowExpanderConfig,
|
|
33
|
+
Search, SearchConfig, Sort, SortConfig, StickyCells, StickyCellsConfig, Stripe, StripeConfig, SubGrid, SubGridConfig, TableExporter,
|
|
34
|
+
Tree, TreeConfig, TreeGroup, TreeGroupConfig, WidgetColumn, XLSColumn, XlsProviderBase } from '@bryntum/grid-thin'
|
|
33
35
|
|
|
34
36
|
type AnyConstructor<A = any> = new (...input: any[]) => A
|
|
35
37
|
|
|
@@ -940,6 +942,8 @@ type DurationColumnConfig = {
|
|
|
940
942
|
headerMenuItems?: Record<string, MenuItemEntry>
|
|
941
943
|
/**
|
|
942
944
|
* Renderer function for the column header.
|
|
945
|
+
* ...
|
|
946
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/column/DurationColumn#config-headerRenderer)
|
|
943
947
|
* @param {object} renderData
|
|
944
948
|
* @param {Grid.column.Column} renderData.column This column
|
|
945
949
|
* @param {HTMLElement} renderData.headerElement The header element
|
|
@@ -1686,6 +1690,8 @@ type EventColorColumnConfig = {
|
|
|
1686
1690
|
headerMenuItems?: Record<string, MenuItemEntry>
|
|
1687
1691
|
/**
|
|
1688
1692
|
* Renderer function for the column header.
|
|
1693
|
+
* ...
|
|
1694
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/column/EventColorColumn#config-headerRenderer)
|
|
1689
1695
|
* @param {object} renderData
|
|
1690
1696
|
* @param {Grid.column.Column} renderData.column This column
|
|
1691
1697
|
* @param {HTMLElement} renderData.headerElement The header element
|
|
@@ -2394,6 +2400,8 @@ type ResourceCollapseColumnConfig = {
|
|
|
2394
2400
|
headerMenuItems?: Record<string, MenuItemEntry>
|
|
2395
2401
|
/**
|
|
2396
2402
|
* Renderer function for the column header.
|
|
2403
|
+
* ...
|
|
2404
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/column/ResourceCollapseColumn#config-headerRenderer)
|
|
2397
2405
|
* @param {object} renderData
|
|
2398
2406
|
* @param {Grid.column.Column} renderData.column This column
|
|
2399
2407
|
* @param {HTMLElement} renderData.headerElement The header element
|
|
@@ -3080,6 +3088,8 @@ type ResourceInfoColumnConfig = {
|
|
|
3080
3088
|
headerMenuItems?: Record<string, MenuItemEntry>
|
|
3081
3089
|
/**
|
|
3082
3090
|
* Renderer function for the column header.
|
|
3091
|
+
* ...
|
|
3092
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/column/ResourceInfoColumn#config-headerRenderer)
|
|
3083
3093
|
* @param {object} renderData
|
|
3084
3094
|
* @param {Grid.column.Column} renderData.column This column
|
|
3085
3095
|
* @param {HTMLElement} renderData.headerElement The header element
|
|
@@ -3821,6 +3831,8 @@ type ScaleColumnConfig = {
|
|
|
3821
3831
|
headerMenuItems?: Record<string, MenuItemEntry>
|
|
3822
3832
|
/**
|
|
3823
3833
|
* Renderer function for the column header.
|
|
3834
|
+
* ...
|
|
3835
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/column/ScaleColumn#config-headerRenderer)
|
|
3824
3836
|
* @param {object} renderData
|
|
3825
3837
|
* @param {Grid.column.Column} renderData.column This column
|
|
3826
3838
|
* @param {HTMLElement} renderData.headerElement The header element
|
|
@@ -4543,6 +4555,8 @@ type TimeAxisColumnConfig = {
|
|
|
4543
4555
|
headerMenuItems?: Record<string, MenuItemEntry>
|
|
4544
4556
|
/**
|
|
4545
4557
|
* Renderer function for the column header.
|
|
4558
|
+
* ...
|
|
4559
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/column/TimeAxisColumn#config-headerRenderer)
|
|
4546
4560
|
* @param {object} renderData
|
|
4547
4561
|
* @param {Grid.column.Column} renderData.column This column
|
|
4548
4562
|
* @param {HTMLElement} renderData.headerElement The header element
|
|
@@ -5246,6 +5260,8 @@ type VerticalTimeAxisColumnConfig = {
|
|
|
5246
5260
|
headerMenuItems?: Record<string, MenuItemEntry>
|
|
5247
5261
|
/**
|
|
5248
5262
|
* Renderer function for the column header.
|
|
5263
|
+
* ...
|
|
5264
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/column/VerticalTimeAxisColumn#config-headerRenderer)
|
|
5249
5265
|
* @param {object} renderData
|
|
5250
5266
|
* @param {Grid.column.Column} renderData.column This column
|
|
5251
5267
|
* @param {HTMLElement} renderData.headerElement The header element
|
|
@@ -8207,6 +8223,125 @@ export abstract class AjaxTransportClass {
|
|
|
8207
8223
|
|
|
8208
8224
|
export const AjaxTransport : <T extends AnyConstructor<Base>>(base : T) => AnyConstructor<InstanceType<T> & AjaxTransportClass>
|
|
8209
8225
|
|
|
8226
|
+
/**
|
|
8227
|
+
* Type with configuration options for [AISettingsModel](https://bryntum.com/products/grid/docs/api/Scheduler/data/AISettingsModel) class.
|
|
8228
|
+
*/
|
|
8229
|
+
type AISettingsModelConfig = {
|
|
8230
|
+
/**
|
|
8231
|
+
* Sets [autoStart](https://bryntum.com/products/scheduler/docs/api/Core/feature/ai/AIBase#config-voiceActivation) value
|
|
8232
|
+
*/
|
|
8233
|
+
autoStart?: boolean
|
|
8234
|
+
/**
|
|
8235
|
+
* Child nodes. To allow loading children on demand, specify `children : true` in your data. Omit the field for leaf
|
|
8236
|
+
* tasks.
|
|
8237
|
+
* ...
|
|
8238
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/AISettingsModel#config-children)
|
|
8239
|
+
*/
|
|
8240
|
+
children?: boolean|object[]|Model[]
|
|
8241
|
+
/**
|
|
8242
|
+
* Start expanded or not (only valid for tree data)
|
|
8243
|
+
*/
|
|
8244
|
+
expanded?: boolean
|
|
8245
|
+
/**
|
|
8246
|
+
* Sets [highlightRelatedItems](https://bryntum.com/products/scheduler/docs/api/Core/feature/ai/AIBase#config-highlightRelatedItems) value
|
|
8247
|
+
*/
|
|
8248
|
+
highlight?: boolean
|
|
8249
|
+
/**
|
|
8250
|
+
* Unique identifier for the record. Might be mapped to another dataSource using idField, but always exposed as
|
|
8251
|
+
* record.id. Will get a generated value if none is specified in records data.
|
|
8252
|
+
* ...
|
|
8253
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/AISettingsModel#config-id)
|
|
8254
|
+
*/
|
|
8255
|
+
id?: string|number
|
|
8256
|
+
/**
|
|
8257
|
+
* This field is added to the class at runtime when the Store is configured with
|
|
8258
|
+
* [lazyLoad](https://bryntum.com/products/scheduler/docs/api/Core/data/Store#config-lazyLoad). If set on a parent record at load time, that parent will not cause any
|
|
8259
|
+
* more child load requests. If omitted, it will be automatically set to `true` when a load request receives fewer
|
|
8260
|
+
* child records than requested.
|
|
8261
|
+
* ...
|
|
8262
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/AISettingsModel#config-isFullyLoaded)
|
|
8263
|
+
*/
|
|
8264
|
+
isFullyLoaded?: boolean
|
|
8265
|
+
/**
|
|
8266
|
+
* Sets [defaultRange](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/AI#config-defaultRange) value
|
|
8267
|
+
*/
|
|
8268
|
+
model?: string
|
|
8269
|
+
/**
|
|
8270
|
+
* This is a read-only field provided in server synchronization packets to specify
|
|
8271
|
+
* which position the node takes in the parent's ordered children array.
|
|
8272
|
+
* This index is set on load and gets updated on reordering nodes in tree. Sorting and filtering
|
|
8273
|
+
* have no effect on it.
|
|
8274
|
+
*/
|
|
8275
|
+
orderedParentIndex?: number
|
|
8276
|
+
/**
|
|
8277
|
+
* This is a read-only field provided in server synchronization packets to specify
|
|
8278
|
+
* which record id is the parent of the record.
|
|
8279
|
+
*/
|
|
8280
|
+
parentId?: string|number|null
|
|
8281
|
+
/**
|
|
8282
|
+
* This is a read-only field provided in server synchronization packets to specify
|
|
8283
|
+
* which position the node takes in the parent's children array.
|
|
8284
|
+
* This index is set on load and gets updated automatically after row reordering, sorting, etc.
|
|
8285
|
+
* To save the order, need to persist the field on the server and when data is fetched to be loaded,
|
|
8286
|
+
* need to sort by this field.
|
|
8287
|
+
*/
|
|
8288
|
+
parentIndex?: number
|
|
8289
|
+
/**
|
|
8290
|
+
* Flag the record as read-only on the UI level, preventing the end user from manipulating it using editing
|
|
8291
|
+
* features such as cell editing and event dragging.
|
|
8292
|
+
* ...
|
|
8293
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/AISettingsModel#config-readOnly)
|
|
8294
|
+
*/
|
|
8295
|
+
readOnly?: boolean
|
|
8296
|
+
/**
|
|
8297
|
+
* This field is added to the class at runtime when the Store is configured with
|
|
8298
|
+
* [lazyLoad](https://bryntum.com/products/scheduler/docs/api/Core/data/Store#config-lazyLoad). The
|
|
8299
|
+
* number specified should reflect the <strong>total</strong> amount of children of a parent node, including nested descendants.
|
|
8300
|
+
* @deprecated This field has been deprecated. Please read the [guide](https://bryntum.com/products/scheduler/docs/api/Grid/guides/data/lazyloading.md) to find out if your app needs to use the new [isFullyLoaded](https://bryntum.com/products/scheduler/docs/api/Core/data/mixin/TreeNode#field-isFullyLoaded) field.
|
|
8301
|
+
*/
|
|
8302
|
+
remoteChildCount?: number
|
|
8303
|
+
/**
|
|
8304
|
+
* Sets [requireConfirmationOnAdds](https://bryntum.com/products/scheduler/docs/api/Core/feature/ai/AIBase#config-requireConfirmationOnAdds) value
|
|
8305
|
+
*/
|
|
8306
|
+
requireConfirmationOnAdds?: boolean
|
|
8307
|
+
/**
|
|
8308
|
+
* Sets [requireConfirmationOnRemovals](https://bryntum.com/products/scheduler/docs/api/Core/feature/ai/AIBase#config-requireConfirmationOnRemovals) value
|
|
8309
|
+
*/
|
|
8310
|
+
requireConfirmationOnRemovals?: boolean
|
|
8311
|
+
/**
|
|
8312
|
+
* Sets [requireConfirmationOnUpdates](https://bryntum.com/products/scheduler/docs/api/Core/feature/ai/AIBase#config-requireConfirmationOnUpdates) value
|
|
8313
|
+
*/
|
|
8314
|
+
requireConfirmationOnUpdates?: boolean
|
|
8315
|
+
/**
|
|
8316
|
+
* Sets [verbosityLevel](https://bryntum.com/products/scheduler/docs/api/Core/feature/ai/AIBase#config-verbosityLevel) value
|
|
8317
|
+
*/
|
|
8318
|
+
verbosity?: string
|
|
8319
|
+
/**
|
|
8320
|
+
* Sets [voiceOnly](https://bryntum.com/products/scheduler/docs/api/Core/feature/ai/AIBase#config-voiceActivation) value
|
|
8321
|
+
*/
|
|
8322
|
+
voiceOnly?: boolean
|
|
8323
|
+
}
|
|
8324
|
+
|
|
8325
|
+
/**
|
|
8326
|
+
* An AISettingsModel defines the user settings for the Scheduler AI feature.
|
|
8327
|
+
* ...
|
|
8328
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/AISettingsModel)
|
|
8329
|
+
*/
|
|
8330
|
+
export class AISettingsModel extends CoreAISettingsModel {
|
|
8331
|
+
/**
|
|
8332
|
+
* Identifies an object as an instance of [AISettingsModel](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/AISettingsModel) class, or subclass thereof.
|
|
8333
|
+
*/
|
|
8334
|
+
static readonly isAISettingsModel: boolean
|
|
8335
|
+
/**
|
|
8336
|
+
* Identifies an object as an instance of [AISettingsModel](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/AISettingsModel) class, or subclass thereof.
|
|
8337
|
+
*/
|
|
8338
|
+
readonly isAISettingsModel: boolean
|
|
8339
|
+
/**
|
|
8340
|
+
* Sets [defaultRange](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/AI#config-defaultRange) value
|
|
8341
|
+
*/
|
|
8342
|
+
model: string
|
|
8343
|
+
}
|
|
8344
|
+
|
|
8210
8345
|
/**
|
|
8211
8346
|
* Type with available listeners functions for [AssignmentStore](https://bryntum.com/products/grid/docs/api/Scheduler/data/AssignmentStore) class.
|
|
8212
8347
|
* Could be used for callbacks typings in TypeScript application.
|
|
@@ -12333,6 +12468,13 @@ type DependencyStoreConfig = {
|
|
|
12333
12468
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/DependencyStore#config-allowNoId)
|
|
12334
12469
|
*/
|
|
12335
12470
|
allowNoId?: boolean
|
|
12471
|
+
/**
|
|
12472
|
+
* An array of allowed dependency types. When set, only the specified dependency types can be created.
|
|
12473
|
+
* Use values from [DependencyModel.Type](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/DependencyBaseModel#property-Type-static):
|
|
12474
|
+
* ...
|
|
12475
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/DependencyStore#config-allowedDependencyTypes)
|
|
12476
|
+
*/
|
|
12477
|
+
allowedDependencyTypes?: number[]
|
|
12336
12478
|
/**
|
|
12337
12479
|
* Specifies target to filter and sort after applying changeset:
|
|
12338
12480
|
* ...
|
|
@@ -13466,6 +13608,12 @@ export class DependencyStore extends AjaxStore {
|
|
|
13466
13608
|
* @param {string} cls
|
|
13467
13609
|
*/
|
|
13468
13610
|
getHighlightedDependencies(cls: string): DependencyBaseModel[];
|
|
13611
|
+
/**
|
|
13612
|
+
* Returns `true` if the specified dependency type is allowed according to the
|
|
13613
|
+
* [allowedDependencyTypes](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/mixin/DependencyStoreMixin#config-allowedDependencyTypes) configuration.
|
|
13614
|
+
* @param {number} type Dependency [Type](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/DependencyBaseModel#property-Type-static)
|
|
13615
|
+
*/
|
|
13616
|
+
isDependencyTypeAllowed(type: number): boolean;
|
|
13469
13617
|
/**
|
|
13470
13618
|
* Validation method used to validate a dependency. Override and return `true` to indicate that an
|
|
13471
13619
|
* existing dependency between two tasks is valid. For a new dependency being created please see
|
|
@@ -15608,6 +15756,22 @@ export class EventStore extends AjaxStore {
|
|
|
15608
15756
|
* @param {Scheduler.model.ResourceModel,string,number} resource Resource or resource id.
|
|
15609
15757
|
*/
|
|
15610
15758
|
getEventsForResource(resource: ResourceModel|string|number): EventModel[];
|
|
15759
|
+
/**
|
|
15760
|
+
* This function will find the next available start date where the provided duration fits without causing any
|
|
15761
|
+
* conflicts. It begins by checking the provided `resources` on the provided `startDate`. And if any conflicting
|
|
15762
|
+
* events is found, it restarts searching from the last of the conflicting events and continues like this until a
|
|
15763
|
+
* matching time slot is found.
|
|
15764
|
+
* @param {object} options
|
|
15765
|
+
*/
|
|
15766
|
+
getNextAvailableDateRange(options: {
|
|
15767
|
+
startDate: Date
|
|
15768
|
+
duration: DurationConfig|string
|
|
15769
|
+
resources: ResourceModel[]
|
|
15770
|
+
matchAllResources?: boolean
|
|
15771
|
+
stopDate?: Date
|
|
15772
|
+
isConflict?: Function
|
|
15773
|
+
getValidDate?: Function
|
|
15774
|
+
}): object|undefined;
|
|
15611
15775
|
/**
|
|
15612
15776
|
* Returns all the recurring events.
|
|
15613
15777
|
*/
|
|
@@ -23339,6 +23503,19 @@ export class AttachToProjectMixinClass {
|
|
|
23339
23503
|
|
|
23340
23504
|
export const AttachToProjectMixin : <T extends AnyConstructor<Base>>(base : T) => AnyConstructor<InstanceType<T> & AttachToProjectMixinClass>
|
|
23341
23505
|
|
|
23506
|
+
/**
|
|
23507
|
+
* Type with configuration options for [DependencyStoreMixin](https://bryntum.com/products/grid/docs/api/Scheduler/data/mixin/DependencyStoreMixin) class.
|
|
23508
|
+
*/
|
|
23509
|
+
type DependencyStoreMixinClassConfig = {
|
|
23510
|
+
/**
|
|
23511
|
+
* An array of allowed dependency types. When set, only the specified dependency types can be created.
|
|
23512
|
+
* Use values from [DependencyModel.Type](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/DependencyBaseModel#property-Type-static):
|
|
23513
|
+
* ...
|
|
23514
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/mixin/DependencyStoreMixin#config-allowedDependencyTypes)
|
|
23515
|
+
*/
|
|
23516
|
+
allowedDependencyTypes?: number[]
|
|
23517
|
+
}
|
|
23518
|
+
|
|
23342
23519
|
export class DependencyStoreMixinClass {
|
|
23343
23520
|
/**
|
|
23344
23521
|
* Identifies an object as an instance of [DependencyStoreMixin](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/mixin/DependencyStoreMixin) class, or subclass thereof.
|
|
@@ -23352,6 +23529,11 @@ export class DependencyStoreMixinClass {
|
|
|
23352
23529
|
* Identifies an object as an instance of [DependencyStoreMixin](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/mixin/DependencyStoreMixin) class, or subclass thereof.
|
|
23353
23530
|
*/
|
|
23354
23531
|
readonly isDependencyStoreMixin: boolean
|
|
23532
|
+
/**
|
|
23533
|
+
* Creates an instance of the class using the supplied configuration
|
|
23534
|
+
* @param {DependencyStoreMixinClassConfig} config
|
|
23535
|
+
*/
|
|
23536
|
+
constructor(config?: DependencyStoreMixinClassConfig);
|
|
23355
23537
|
/**
|
|
23356
23538
|
* Add dependencies to the store.
|
|
23357
23539
|
* @param {Scheduler.model.DependencyModel,Scheduler.model.DependencyModel[],DependencyModelConfig,DependencyModelConfig[]} records Array of records/data or a single record/data to add to store
|
|
@@ -23389,6 +23571,12 @@ export class DependencyStoreMixinClass {
|
|
|
23389
23571
|
* @param {string} cls
|
|
23390
23572
|
*/
|
|
23391
23573
|
getHighlightedDependencies(cls: string): DependencyBaseModel[];
|
|
23574
|
+
/**
|
|
23575
|
+
* Returns `true` if the specified dependency type is allowed according to the
|
|
23576
|
+
* [allowedDependencyTypes](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/mixin/DependencyStoreMixin#config-allowedDependencyTypes) configuration.
|
|
23577
|
+
* @param {number} type Dependency [Type](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/DependencyBaseModel#property-Type-static)
|
|
23578
|
+
*/
|
|
23579
|
+
isDependencyTypeAllowed(type: number): boolean;
|
|
23392
23580
|
/**
|
|
23393
23581
|
* Validation method used to validate a dependency. Override and return `true` to indicate that an
|
|
23394
23582
|
* existing dependency between two tasks is valid. For a new dependency being created please see
|
|
@@ -23694,6 +23882,22 @@ export class GetEventsMixinClass {
|
|
|
23694
23882
|
onlyAssigned?: boolean
|
|
23695
23883
|
dateMap?: boolean|Map<any, any>
|
|
23696
23884
|
}): EventModel[]|Map<any, any>;
|
|
23885
|
+
/**
|
|
23886
|
+
* This function will find the next available start date where the provided duration fits without causing any
|
|
23887
|
+
* conflicts. It begins by checking the provided `resources` on the provided `startDate`. And if any conflicting
|
|
23888
|
+
* events is found, it restarts searching from the last of the conflicting events and continues like this until a
|
|
23889
|
+
* matching time slot is found.
|
|
23890
|
+
* @param {object} options
|
|
23891
|
+
*/
|
|
23892
|
+
getNextAvailableDateRange(options: {
|
|
23893
|
+
startDate: Date
|
|
23894
|
+
duration: DurationConfig|string
|
|
23895
|
+
resources: ResourceModel[]
|
|
23896
|
+
matchAllResources?: boolean
|
|
23897
|
+
stopDate?: Date
|
|
23898
|
+
isConflict?: Function
|
|
23899
|
+
getValidDate?: Function
|
|
23900
|
+
}): object|undefined;
|
|
23697
23901
|
/**
|
|
23698
23902
|
* Checks if a date range is available for a given resource.
|
|
23699
23903
|
* @param {Date} startDate The start date
|
|
@@ -25241,6 +25445,352 @@ export class RecurrenceLegend {
|
|
|
25241
25445
|
updateLocalization(): void;
|
|
25242
25446
|
}
|
|
25243
25447
|
|
|
25448
|
+
/**
|
|
25449
|
+
* Type with available listeners functions for [AI](https://bryntum.com/products/grid/docs/api/Scheduler/feature/AI) class.
|
|
25450
|
+
* Could be used for callbacks typings in TypeScript application.
|
|
25451
|
+
*/
|
|
25452
|
+
type AIListenersTypes = {
|
|
25453
|
+
/**
|
|
25454
|
+
* Fires before an object is destroyed.
|
|
25455
|
+
* @param {object} event Event object
|
|
25456
|
+
* @param {Core.Base} event.source The Object that is being destroyed.
|
|
25457
|
+
*/
|
|
25458
|
+
beforeDestroy: (event: { source: Base }) => void
|
|
25459
|
+
/**
|
|
25460
|
+
* Fires when any other event is fired from the object.
|
|
25461
|
+
* ...
|
|
25462
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/AI#event-catchAll)
|
|
25463
|
+
* @param {object} event Event object
|
|
25464
|
+
* @param {{[key: string]: any, type: string}} event.event The Object that contains event details
|
|
25465
|
+
* @param {string} event.event.type The type of the event which is caught by the listener
|
|
25466
|
+
*/
|
|
25467
|
+
catchAll: (event: {[key: string]: any, type: string}) => void
|
|
25468
|
+
/**
|
|
25469
|
+
* Fires when an object is destroyed.
|
|
25470
|
+
* @param {object} event Event object
|
|
25471
|
+
* @param {Core.Base} event.source The Object that is being destroyed.
|
|
25472
|
+
*/
|
|
25473
|
+
destroy: (event: { source: Base }) => void
|
|
25474
|
+
/**
|
|
25475
|
+
* Fired when the plugin/feature is disabled.
|
|
25476
|
+
* @param {object} event Event object
|
|
25477
|
+
* @param {Core.mixin.InstancePlugin} event.source
|
|
25478
|
+
*/
|
|
25479
|
+
disable: (event: { source: InstancePlugin }) => void
|
|
25480
|
+
/**
|
|
25481
|
+
* Fired when the plugin/feature is enabled.
|
|
25482
|
+
* @param {object} event Event object
|
|
25483
|
+
* @param {Core.mixin.InstancePlugin} event.source
|
|
25484
|
+
*/
|
|
25485
|
+
enable: (event: { source: InstancePlugin }) => void
|
|
25486
|
+
/**
|
|
25487
|
+
* Fired when the user changes it's settings via the settings panel
|
|
25488
|
+
* @param {object} event Event object
|
|
25489
|
+
* @param {Core.data.CoreAISettingsModel} event.userSettings The user settings record
|
|
25490
|
+
* @param {object} event.changes The changed properties and the new value
|
|
25491
|
+
*/
|
|
25492
|
+
userSettingsUpdate: (event: { userSettings: CoreAISettingsModel, changes: object }) => void
|
|
25493
|
+
}
|
|
25494
|
+
|
|
25495
|
+
/**
|
|
25496
|
+
* Type with listeners options for [AI](https://bryntum.com/products/grid/docs/api/Scheduler/feature/AI) class.
|
|
25497
|
+
*/
|
|
25498
|
+
type AIListeners = {
|
|
25499
|
+
/**
|
|
25500
|
+
* The `this` object for listener methods
|
|
25501
|
+
*/
|
|
25502
|
+
thisObj?: object
|
|
25503
|
+
/**
|
|
25504
|
+
* Fires before an object is destroyed.
|
|
25505
|
+
* @param {object} event Event object
|
|
25506
|
+
* @param {Core.Base} event.source The Object that is being destroyed.
|
|
25507
|
+
*/
|
|
25508
|
+
beforeDestroy?: ((event: { source: Base }) => void)|string
|
|
25509
|
+
/**
|
|
25510
|
+
* Fires when any other event is fired from the object.
|
|
25511
|
+
* ...
|
|
25512
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/AI#event-catchAll)
|
|
25513
|
+
* @param {object} event Event object
|
|
25514
|
+
* @param {{[key: string]: any, type: string}} event.event The Object that contains event details
|
|
25515
|
+
* @param {string} event.event.type The type of the event which is caught by the listener
|
|
25516
|
+
*/
|
|
25517
|
+
catchAll?: ((event: {[key: string]: any, type: string}) => void)|string
|
|
25518
|
+
/**
|
|
25519
|
+
* Fires when an object is destroyed.
|
|
25520
|
+
* @param {object} event Event object
|
|
25521
|
+
* @param {Core.Base} event.source The Object that is being destroyed.
|
|
25522
|
+
*/
|
|
25523
|
+
destroy?: ((event: { source: Base }) => void)|string
|
|
25524
|
+
/**
|
|
25525
|
+
* Fired when the plugin/feature is disabled.
|
|
25526
|
+
* @param {object} event Event object
|
|
25527
|
+
* @param {Core.mixin.InstancePlugin} event.source
|
|
25528
|
+
*/
|
|
25529
|
+
disable?: ((event: { source: InstancePlugin }) => void)|string
|
|
25530
|
+
/**
|
|
25531
|
+
* Fired when the plugin/feature is enabled.
|
|
25532
|
+
* @param {object} event Event object
|
|
25533
|
+
* @param {Core.mixin.InstancePlugin} event.source
|
|
25534
|
+
*/
|
|
25535
|
+
enable?: ((event: { source: InstancePlugin }) => void)|string
|
|
25536
|
+
/**
|
|
25537
|
+
* Fired when the user changes it's settings via the settings panel
|
|
25538
|
+
* @param {object} event Event object
|
|
25539
|
+
* @param {Core.data.CoreAISettingsModel} event.userSettings The user settings record
|
|
25540
|
+
* @param {object} event.changes The changed properties and the new value
|
|
25541
|
+
*/
|
|
25542
|
+
userSettingsUpdate?: ((event: { userSettings: CoreAISettingsModel, changes: object }) => void)|string
|
|
25543
|
+
}
|
|
25544
|
+
|
|
25545
|
+
/**
|
|
25546
|
+
* Type with configuration options for [AI](https://bryntum.com/products/grid/docs/api/Scheduler/feature/AI) class.
|
|
25547
|
+
*/
|
|
25548
|
+
type AIConfig = {
|
|
25549
|
+
type?: 'ai'
|
|
25550
|
+
/**
|
|
25551
|
+
* AI plugin to use. Provide the class here. Available plugins are:
|
|
25552
|
+
* ...
|
|
25553
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/AI#config-apiPlugin)
|
|
25554
|
+
*/
|
|
25555
|
+
apiPlugin?: typeof AbstractApiPlugin
|
|
25556
|
+
/**
|
|
25557
|
+
* Shows an AI model selector in the SettingsPanel where the user can select between the available API:s
|
|
25558
|
+
*/
|
|
25559
|
+
availableApis?: AIModelSelector[]
|
|
25560
|
+
/**
|
|
25561
|
+
* Set this to `true` or a config object to add a [ChatButton](https://bryntum.com/products/scheduler/docs/api/Core/widget/chat/ChatButton)
|
|
25562
|
+
*/
|
|
25563
|
+
chatButton?: boolean|ChatButtonConfig
|
|
25564
|
+
/**
|
|
25565
|
+
* Set to `true` to automatically console.log things that happen internally. AI responses and audio processing
|
|
25566
|
+
* for example.
|
|
25567
|
+
*/
|
|
25568
|
+
debugMode?: boolean
|
|
25569
|
+
/**
|
|
25570
|
+
* The date range to use for agent "conditions", when the user doesn't specify a given date range in the prompt.
|
|
25571
|
+
* Available options are:
|
|
25572
|
+
* ...
|
|
25573
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/AI#config-defaultRange)
|
|
25574
|
+
*/
|
|
25575
|
+
defaultRange?: string
|
|
25576
|
+
/**
|
|
25577
|
+
* An array of strings which will be circulated as waiting status texts when awaiting long AI responses
|
|
25578
|
+
* Defaults to `['Waiting', 'Waiting ...', 'Still waiting', 'Still waiting ...']`
|
|
25579
|
+
*/
|
|
25580
|
+
delayStatusTexts?: string[]
|
|
25581
|
+
/**
|
|
25582
|
+
* The plugin/feature `disabled` state.
|
|
25583
|
+
* ...
|
|
25584
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/AI#config-disabled)
|
|
25585
|
+
*/
|
|
25586
|
+
disabled?: boolean|'inert'
|
|
25587
|
+
/**
|
|
25588
|
+
* The URL to send feedback (thumbs up/thumbs down) to
|
|
25589
|
+
*/
|
|
25590
|
+
feedbackUrl?: string
|
|
25591
|
+
/**
|
|
25592
|
+
* Additional options to pass to fetch requests
|
|
25593
|
+
*/
|
|
25594
|
+
fetchOptions?: object
|
|
25595
|
+
/**
|
|
25596
|
+
* By default, data item which are targeted in an AI action will be highlighted in the UI. Set this to `false`
|
|
25597
|
+
* to prevent this behavior.
|
|
25598
|
+
*/
|
|
25599
|
+
highlightRelatedItems?: boolean
|
|
25600
|
+
/**
|
|
25601
|
+
* The listener set for this object.
|
|
25602
|
+
* ...
|
|
25603
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/AI#config-listeners)
|
|
25604
|
+
*/
|
|
25605
|
+
listeners?: AIListeners
|
|
25606
|
+
/**
|
|
25607
|
+
* Set to `false` to not manage chat history on the client
|
|
25608
|
+
*/
|
|
25609
|
+
manageChatHistory?: boolean
|
|
25610
|
+
/**
|
|
25611
|
+
* Max tokens setting (if applicable)
|
|
25612
|
+
*/
|
|
25613
|
+
max_tokens?: number
|
|
25614
|
+
/**
|
|
25615
|
+
* AI model name (if applicable)
|
|
25616
|
+
*/
|
|
25617
|
+
model?: string
|
|
25618
|
+
/**
|
|
25619
|
+
* Use this to provide more details of data models currently available for the AI agent to work with. Provide
|
|
25620
|
+
* an object with model class names as keys and configuration objects as values.
|
|
25621
|
+
* ...
|
|
25622
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/AI#config-models)
|
|
25623
|
+
*/
|
|
25624
|
+
models?: Record<string, AIModelConfiguration>
|
|
25625
|
+
/**
|
|
25626
|
+
* The URL to send text prompts to
|
|
25627
|
+
*/
|
|
25628
|
+
promptUrl?: string
|
|
25629
|
+
/**
|
|
25630
|
+
* Enables support for redoing data modifying actions performed by the AI. Shows a redo icon under the last
|
|
25631
|
+
* redoable message in the ChatPanel. Requires undo to be enabled.
|
|
25632
|
+
*/
|
|
25633
|
+
redo?: boolean
|
|
25634
|
+
/**
|
|
25635
|
+
* Set to `true` to always prompt the user for confirmation before allowing the AI to add records
|
|
25636
|
+
*/
|
|
25637
|
+
requireConfirmationOnAdds?: boolean
|
|
25638
|
+
/**
|
|
25639
|
+
* Set to `true` to always prompt the user for confirmation before allowing the AI to remove records
|
|
25640
|
+
*/
|
|
25641
|
+
requireConfirmationOnRemovals?: boolean
|
|
25642
|
+
/**
|
|
25643
|
+
* Set to `true` to always prompt the user for confirmation before allowing the AI to update records
|
|
25644
|
+
*/
|
|
25645
|
+
requireConfirmationOnUpdates?: boolean
|
|
25646
|
+
/**
|
|
25647
|
+
* A configuration object containing the user's preferred AI feature settings. If there is a matching AI feature
|
|
25648
|
+
* class config, the user setting will take precedence
|
|
25649
|
+
* JSON.
|
|
25650
|
+
*/
|
|
25651
|
+
settings?: AISettingsModelConfig|AISettingsModel
|
|
25652
|
+
/**
|
|
25653
|
+
* Set to `true` to upon creation, send a test prompt to verify the connection to the AI backend. If the test
|
|
25654
|
+
* fails, a warning icon will be shown on the chat panel.
|
|
25655
|
+
*/
|
|
25656
|
+
showNoConnectionIcon?: boolean
|
|
25657
|
+
/**
|
|
25658
|
+
* Temperature setting (if applicable). Overrides the default temperature set by the apiPlugin.
|
|
25659
|
+
*/
|
|
25660
|
+
temperature?: number
|
|
25661
|
+
/**
|
|
25662
|
+
* The URL to send text for speech synthesizing
|
|
25663
|
+
*/
|
|
25664
|
+
textToSpeechUrl?: string
|
|
25665
|
+
/**
|
|
25666
|
+
* A number of milliseconds a prompt is allowed to take before being aborted. Defaults to `60000` (1 minute).
|
|
25667
|
+
*/
|
|
25668
|
+
timeout?: number
|
|
25669
|
+
/**
|
|
25670
|
+
* Use this to add custom tools to the AI model's tool list or to remove existing tools. Provide an object
|
|
25671
|
+
* with the tool names as keys and configuration objects as values. Please note that modifying existing tools is
|
|
25672
|
+
* not supported, only removing them.
|
|
25673
|
+
* ...
|
|
25674
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/AI#config-tools)
|
|
25675
|
+
*/
|
|
25676
|
+
tools?: Record<string, AIToolConfig>
|
|
25677
|
+
/**
|
|
25678
|
+
* Use this to provide example prompt scenarios to "teach" the AI of more complex tasks. Must be configured as
|
|
25679
|
+
* an array containing arrays which contains the AI messages for the complete conversation.
|
|
25680
|
+
* ...
|
|
25681
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/AI#config-trainingData)
|
|
25682
|
+
*/
|
|
25683
|
+
trainingData?: any[]
|
|
25684
|
+
/**
|
|
25685
|
+
* The URL to send audio for transcribing
|
|
25686
|
+
*/
|
|
25687
|
+
transcribeUrl?: string
|
|
25688
|
+
/**
|
|
25689
|
+
* Enables support for undoing data modifying actions performed by the AI. Shows an undo icon under the last
|
|
25690
|
+
* undoable message in the ChatPanel.
|
|
25691
|
+
*/
|
|
25692
|
+
undo?: boolean
|
|
25693
|
+
/**
|
|
25694
|
+
* A configuration object containing the user's preferred AI feature settings. If there is a matching AI feature
|
|
25695
|
+
* class config, the user setting will take precedence
|
|
25696
|
+
* JSON.
|
|
25697
|
+
*/
|
|
25698
|
+
userSettings?: AISettingsModelConfig|CoreAISettingsModel
|
|
25699
|
+
/**
|
|
25700
|
+
* Experimental configuration of the AI verbosity. Valid values are `"1"`, `"2"` and `"3"`, where `"1"` is
|
|
25701
|
+
* lowest.
|
|
25702
|
+
*/
|
|
25703
|
+
verbosityLevel?: string
|
|
25704
|
+
/**
|
|
25705
|
+
* Configuration settings for voice activation
|
|
25706
|
+
*/
|
|
25707
|
+
voiceActivation?: AIVoiceActivationConfig
|
|
25708
|
+
/**
|
|
25709
|
+
* Forces voice only mode, which hides the chat panel and only shows a record chat button.
|
|
25710
|
+
*/
|
|
25711
|
+
voiceOnly?: boolean
|
|
25712
|
+
/**
|
|
25713
|
+
* Fires before an object is destroyed.
|
|
25714
|
+
* @param {object} event Event object
|
|
25715
|
+
* @param {Core.Base} event.source The Object that is being destroyed.
|
|
25716
|
+
*/
|
|
25717
|
+
onBeforeDestroy?: ((event: { source: Base }) => void)|string
|
|
25718
|
+
/**
|
|
25719
|
+
* Fires when any other event is fired from the object.
|
|
25720
|
+
* ...
|
|
25721
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/AI#event-catchAll)
|
|
25722
|
+
* @param {object} event Event object
|
|
25723
|
+
* @param {{[key: string]: any, type: string}} event.event The Object that contains event details
|
|
25724
|
+
* @param {string} event.event.type The type of the event which is caught by the listener
|
|
25725
|
+
*/
|
|
25726
|
+
onCatchAll?: ((event: {[key: string]: any, type: string}) => void)|string
|
|
25727
|
+
/**
|
|
25728
|
+
* Fires when an object is destroyed.
|
|
25729
|
+
* @param {object} event Event object
|
|
25730
|
+
* @param {Core.Base} event.source The Object that is being destroyed.
|
|
25731
|
+
*/
|
|
25732
|
+
onDestroy?: ((event: { source: Base }) => void)|string
|
|
25733
|
+
/**
|
|
25734
|
+
* Fired when the plugin/feature is disabled.
|
|
25735
|
+
* @param {object} event Event object
|
|
25736
|
+
* @param {Core.mixin.InstancePlugin} event.source
|
|
25737
|
+
*/
|
|
25738
|
+
onDisable?: ((event: { source: InstancePlugin }) => void)|string
|
|
25739
|
+
/**
|
|
25740
|
+
* Fired when the plugin/feature is enabled.
|
|
25741
|
+
* @param {object} event Event object
|
|
25742
|
+
* @param {Core.mixin.InstancePlugin} event.source
|
|
25743
|
+
*/
|
|
25744
|
+
onEnable?: ((event: { source: InstancePlugin }) => void)|string
|
|
25745
|
+
/**
|
|
25746
|
+
* Fired when the user changes it's settings via the settings panel
|
|
25747
|
+
* @param {object} event Event object
|
|
25748
|
+
* @param {Core.data.CoreAISettingsModel} event.userSettings The user settings record
|
|
25749
|
+
* @param {object} event.changes The changed properties and the new value
|
|
25750
|
+
*/
|
|
25751
|
+
onUserSettingsUpdate?: ((event: { userSettings: CoreAISettingsModel, changes: object }) => void)|string
|
|
25752
|
+
}
|
|
25753
|
+
|
|
25754
|
+
/**
|
|
25755
|
+
* This feature provides an AI agent for the Scheduler and SchedulerPro. It provides a chat panel that allows the user
|
|
25756
|
+
* to send messages to the agent and see the responses. Which allows the user to use natural language to interact with
|
|
25757
|
+
* the Scheduler in different ways. For example, the user can ask the agent to filter the data, sort it, or select
|
|
25758
|
+
* specific records. The agent can also perform data manipulation operations such as adding, updating, deleting records.
|
|
25759
|
+
* ...
|
|
25760
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/AI)
|
|
25761
|
+
*/
|
|
25762
|
+
export class AI extends GridAI {
|
|
25763
|
+
/**
|
|
25764
|
+
* Identifies an object as an instance of [AI](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/AI) class, or subclass thereof.
|
|
25765
|
+
*/
|
|
25766
|
+
static readonly isAI: boolean
|
|
25767
|
+
/**
|
|
25768
|
+
* Identifies an object as an instance of [AI](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/AI) class, or subclass thereof.
|
|
25769
|
+
*/
|
|
25770
|
+
readonly isAI: boolean
|
|
25771
|
+
/**
|
|
25772
|
+
* Fires before an object is destroyed.
|
|
25773
|
+
* @param {object} event Event object
|
|
25774
|
+
* @param {Core.Base} event.source The Object that is being destroyed.
|
|
25775
|
+
*/
|
|
25776
|
+
onBeforeDestroy: ((event: { source: Base }) => void)|string
|
|
25777
|
+
/**
|
|
25778
|
+
* Fires when any other event is fired from the object.
|
|
25779
|
+
* ...
|
|
25780
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/AI#event-catchAll)
|
|
25781
|
+
* @param {object} event Event object
|
|
25782
|
+
* @param {{[key: string]: any, type: string}} event.event The Object that contains event details
|
|
25783
|
+
* @param {string} event.event.type The type of the event which is caught by the listener
|
|
25784
|
+
*/
|
|
25785
|
+
onCatchAll: ((event: {[key: string]: any, type: string}) => void)|string
|
|
25786
|
+
/**
|
|
25787
|
+
* Fires when an object is destroyed.
|
|
25788
|
+
* @param {object} event Event object
|
|
25789
|
+
* @param {Core.Base} event.source The Object that is being destroyed.
|
|
25790
|
+
*/
|
|
25791
|
+
onDestroy: ((event: { source: Base }) => void)|string
|
|
25792
|
+
}
|
|
25793
|
+
|
|
25244
25794
|
/**
|
|
25245
25795
|
* Type with available listeners functions for [AbstractTimeRanges](https://bryntum.com/products/grid/docs/api/Scheduler/feature/AbstractTimeRanges) class.
|
|
25246
25796
|
* Could be used for callbacks typings in TypeScript application.
|
|
@@ -28781,11 +29331,11 @@ export class EventEdit extends EditBase {
|
|
|
28781
29331
|
/**
|
|
28782
29332
|
* Opens an editor for the passed event. This function is exposed on Scheduler and can be called as
|
|
28783
29333
|
* `scheduler.editEvent()`.
|
|
28784
|
-
* @param {Scheduler.model.EventModel} eventRecord Event to edit
|
|
29334
|
+
* @param {Scheduler.model.EventModel,string,number} eventRecord Event to edit or the id of the eventRecord. When a String or Number is passed, it must be the id of an event that exists in the Scheduler's event store.
|
|
28785
29335
|
* @param {Scheduler.model.ResourceModel} resourceRecord The Resource record for the event. This parameter is needed if the event is newly created for a resource and has not been assigned, or when using multi assignment.
|
|
28786
29336
|
* @param {HTMLElement} element Element to anchor editor to (defaults to events element)
|
|
28787
29337
|
*/
|
|
28788
|
-
editEvent(eventRecord: EventModel, resourceRecord?: ResourceModel, element?: HTMLElement): void;
|
|
29338
|
+
editEvent(eventRecord: EventModel|string|number, resourceRecord?: ResourceModel, element?: HTMLElement): void;
|
|
28789
29339
|
}
|
|
28790
29340
|
|
|
28791
29341
|
/**
|
|
@@ -30067,6 +30617,10 @@ type EventTooltipConfig = {
|
|
|
30067
30617
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/EventTooltip#config-bodyCls)
|
|
30068
30618
|
*/
|
|
30069
30619
|
bodyCls?: string|object
|
|
30620
|
+
/**
|
|
30621
|
+
* Set `true` to add a border to this container's element.
|
|
30622
|
+
*/
|
|
30623
|
+
border?: boolean
|
|
30070
30624
|
/**
|
|
30071
30625
|
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
30072
30626
|
* hierarchy when triggered.
|
|
@@ -30139,7 +30693,7 @@ type EventTooltipConfig = {
|
|
|
30139
30693
|
* ...
|
|
30140
30694
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/EventTooltip#config-color)
|
|
30141
30695
|
*/
|
|
30142
|
-
color?:
|
|
30696
|
+
color?: Color
|
|
30143
30697
|
/**
|
|
30144
30698
|
* Programmatic control over which column to start in when used in a grid layout.
|
|
30145
30699
|
*/
|
|
@@ -31405,20 +31959,282 @@ type HeaderZoomConfig = {
|
|
|
31405
31959
|
}
|
|
31406
31960
|
|
|
31407
31961
|
/**
|
|
31408
|
-
* Enables users to click and drag to zoom to a date range in Scheduler's header time axis. Only supported in horizontal
|
|
31409
|
-
* mode.
|
|
31962
|
+
* Enables users to click and drag to zoom to a date range in Scheduler's header time axis. Only supported in horizontal
|
|
31963
|
+
* mode.
|
|
31964
|
+
* ...
|
|
31965
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/HeaderZoom)
|
|
31966
|
+
*/
|
|
31967
|
+
export class HeaderZoom extends InstancePlugin {
|
|
31968
|
+
/**
|
|
31969
|
+
* Identifies an object as an instance of [HeaderZoom](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/HeaderZoom) class, or subclass thereof.
|
|
31970
|
+
*/
|
|
31971
|
+
static readonly isHeaderZoom: boolean
|
|
31972
|
+
/**
|
|
31973
|
+
* Identifies an object as an instance of [HeaderZoom](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/HeaderZoom) class, or subclass thereof.
|
|
31974
|
+
*/
|
|
31975
|
+
readonly isHeaderZoom: boolean
|
|
31976
|
+
/**
|
|
31977
|
+
* Fires before an object is destroyed.
|
|
31978
|
+
* @param {object} event Event object
|
|
31979
|
+
* @param {Core.Base} event.source The Object that is being destroyed.
|
|
31980
|
+
*/
|
|
31981
|
+
onBeforeDestroy: ((event: { source: Base }) => void)|string
|
|
31982
|
+
/**
|
|
31983
|
+
* Fires when any other event is fired from the object.
|
|
31984
|
+
* ...
|
|
31985
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/HeaderZoom#event-catchAll)
|
|
31986
|
+
* @param {object} event Event object
|
|
31987
|
+
* @param {{[key: string]: any, type: string}} event.event The Object that contains event details
|
|
31988
|
+
* @param {string} event.event.type The type of the event which is caught by the listener
|
|
31989
|
+
*/
|
|
31990
|
+
onCatchAll: ((event: {[key: string]: any, type: string}) => void)|string
|
|
31991
|
+
/**
|
|
31992
|
+
* Fires when an object is destroyed.
|
|
31993
|
+
* @param {object} event Event object
|
|
31994
|
+
* @param {Core.Base} event.source The Object that is being destroyed.
|
|
31995
|
+
*/
|
|
31996
|
+
onDestroy: ((event: { source: Base }) => void)|string
|
|
31997
|
+
}
|
|
31998
|
+
|
|
31999
|
+
/**
|
|
32000
|
+
* Type with available listeners functions for [Labels](https://bryntum.com/products/grid/docs/api/Scheduler/feature/Labels) class.
|
|
32001
|
+
* Could be used for callbacks typings in TypeScript application.
|
|
32002
|
+
*/
|
|
32003
|
+
type LabelsListenersTypes = {
|
|
32004
|
+
/**
|
|
32005
|
+
* Fires before an object is destroyed.
|
|
32006
|
+
* @param {object} event Event object
|
|
32007
|
+
* @param {Core.Base} event.source The Object that is being destroyed.
|
|
32008
|
+
*/
|
|
32009
|
+
beforeDestroy: (event: { source: Base }) => void
|
|
32010
|
+
/**
|
|
32011
|
+
* Fires when any other event is fired from the object.
|
|
32012
|
+
* ...
|
|
32013
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Labels#event-catchAll)
|
|
32014
|
+
* @param {object} event Event object
|
|
32015
|
+
* @param {{[key: string]: any, type: string}} event.event The Object that contains event details
|
|
32016
|
+
* @param {string} event.event.type The type of the event which is caught by the listener
|
|
32017
|
+
*/
|
|
32018
|
+
catchAll: (event: {[key: string]: any, type: string}) => void
|
|
32019
|
+
/**
|
|
32020
|
+
* Fires when an object is destroyed.
|
|
32021
|
+
* @param {object} event Event object
|
|
32022
|
+
* @param {Core.Base} event.source The Object that is being destroyed.
|
|
32023
|
+
*/
|
|
32024
|
+
destroy: (event: { source: Base }) => void
|
|
32025
|
+
/**
|
|
32026
|
+
* Fired when the plugin/feature is disabled.
|
|
32027
|
+
* @param {object} event Event object
|
|
32028
|
+
* @param {Core.mixin.InstancePlugin} event.source
|
|
32029
|
+
*/
|
|
32030
|
+
disable: (event: { source: InstancePlugin }) => void
|
|
32031
|
+
/**
|
|
32032
|
+
* Fired when the plugin/feature is enabled.
|
|
32033
|
+
* @param {object} event Event object
|
|
32034
|
+
* @param {Core.mixin.InstancePlugin} event.source
|
|
32035
|
+
*/
|
|
32036
|
+
enable: (event: { source: InstancePlugin }) => void
|
|
32037
|
+
}
|
|
32038
|
+
|
|
32039
|
+
/**
|
|
32040
|
+
* Type with listeners options for [Labels](https://bryntum.com/products/grid/docs/api/Scheduler/feature/Labels) class.
|
|
32041
|
+
*/
|
|
32042
|
+
type LabelsListeners = {
|
|
32043
|
+
/**
|
|
32044
|
+
* The `this` object for listener methods
|
|
32045
|
+
*/
|
|
32046
|
+
thisObj?: object
|
|
32047
|
+
/**
|
|
32048
|
+
* Fires before an object is destroyed.
|
|
32049
|
+
* @param {object} event Event object
|
|
32050
|
+
* @param {Core.Base} event.source The Object that is being destroyed.
|
|
32051
|
+
*/
|
|
32052
|
+
beforeDestroy?: ((event: { source: Base }) => void)|string
|
|
32053
|
+
/**
|
|
32054
|
+
* Fires when any other event is fired from the object.
|
|
32055
|
+
* ...
|
|
32056
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Labels#event-catchAll)
|
|
32057
|
+
* @param {object} event Event object
|
|
32058
|
+
* @param {{[key: string]: any, type: string}} event.event The Object that contains event details
|
|
32059
|
+
* @param {string} event.event.type The type of the event which is caught by the listener
|
|
32060
|
+
*/
|
|
32061
|
+
catchAll?: ((event: {[key: string]: any, type: string}) => void)|string
|
|
32062
|
+
/**
|
|
32063
|
+
* Fires when an object is destroyed.
|
|
32064
|
+
* @param {object} event Event object
|
|
32065
|
+
* @param {Core.Base} event.source The Object that is being destroyed.
|
|
32066
|
+
*/
|
|
32067
|
+
destroy?: ((event: { source: Base }) => void)|string
|
|
32068
|
+
/**
|
|
32069
|
+
* Fired when the plugin/feature is disabled.
|
|
32070
|
+
* @param {object} event Event object
|
|
32071
|
+
* @param {Core.mixin.InstancePlugin} event.source
|
|
32072
|
+
*/
|
|
32073
|
+
disable?: ((event: { source: InstancePlugin }) => void)|string
|
|
32074
|
+
/**
|
|
32075
|
+
* Fired when the plugin/feature is enabled.
|
|
32076
|
+
* @param {object} event Event object
|
|
32077
|
+
* @param {Core.mixin.InstancePlugin} event.source
|
|
32078
|
+
*/
|
|
32079
|
+
enable?: ((event: { source: InstancePlugin }) => void)|string
|
|
32080
|
+
}
|
|
32081
|
+
|
|
32082
|
+
/**
|
|
32083
|
+
* Type with configuration options for [Labels](https://bryntum.com/products/grid/docs/api/Scheduler/feature/Labels) class.
|
|
32084
|
+
*/
|
|
32085
|
+
type LabelsConfig = {
|
|
32086
|
+
type?: 'labels'
|
|
32087
|
+
/**
|
|
32088
|
+
* Configuration object for the label which appears *after* the event bar in the current writing direction.
|
|
32089
|
+
*/
|
|
32090
|
+
after?: SchedulerLabelConfig
|
|
32091
|
+
/**
|
|
32092
|
+
* Configuration object for the label which appears *before* the event bar in the current writing direction.
|
|
32093
|
+
*/
|
|
32094
|
+
before?: SchedulerLabelConfig
|
|
32095
|
+
/**
|
|
32096
|
+
* What action should be taken when focus moves leaves the cell editor, for example when clicking outside.
|
|
32097
|
+
* May be `'complete'` or `'cancel`'.
|
|
32098
|
+
*/
|
|
32099
|
+
blurAction?: 'complete'|'cancel'
|
|
32100
|
+
/**
|
|
32101
|
+
* Bottom label configuration object.
|
|
32102
|
+
*/
|
|
32103
|
+
bottom?: SchedulerLabelConfig
|
|
32104
|
+
/**
|
|
32105
|
+
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
32106
|
+
* hierarchy when triggered.
|
|
32107
|
+
* ...
|
|
32108
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Labels#config-bubbleEvents)
|
|
32109
|
+
*/
|
|
32110
|
+
bubbleEvents?: object
|
|
32111
|
+
/**
|
|
32112
|
+
* Set to `true` to call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
|
|
32113
|
+
* ...
|
|
32114
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Labels#config-callOnFunctions)
|
|
32115
|
+
*/
|
|
32116
|
+
callOnFunctions?: boolean
|
|
32117
|
+
/**
|
|
32118
|
+
* By default, if an event handler throws an exception, the error propagates up the stack and the
|
|
32119
|
+
* application state is undefined. Code which follows the event handler will *not* be executed.
|
|
32120
|
+
* ...
|
|
32121
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Labels#config-catchEventHandlerExceptions)
|
|
32122
|
+
*/
|
|
32123
|
+
catchEventHandlerExceptions?: boolean
|
|
32124
|
+
/**
|
|
32125
|
+
* The widget which this plugin is to attach to.
|
|
32126
|
+
*/
|
|
32127
|
+
client?: Widget
|
|
32128
|
+
/**
|
|
32129
|
+
* The plugin/feature `disabled` state.
|
|
32130
|
+
* ...
|
|
32131
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Labels#config-disabled)
|
|
32132
|
+
*/
|
|
32133
|
+
disabled?: boolean|'inert'
|
|
32134
|
+
/**
|
|
32135
|
+
* Factor representing the average char width in pixels used to determine label width when configured
|
|
32136
|
+
* with `labelLayoutMode: 'estimate'`.
|
|
32137
|
+
*/
|
|
32138
|
+
labelCharWidth?: number
|
|
32139
|
+
/**
|
|
32140
|
+
* CSS class to apply to label elements
|
|
32141
|
+
*/
|
|
32142
|
+
labelCls?: string
|
|
32143
|
+
/**
|
|
32144
|
+
* How to handle labels during event layout. Options are:
|
|
32145
|
+
* ...
|
|
32146
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Labels#config-labelLayoutMode)
|
|
32147
|
+
*/
|
|
32148
|
+
labelLayoutMode?: 'default'|'estimate'|'measure'
|
|
32149
|
+
/**
|
|
32150
|
+
* Left label configuration object.
|
|
32151
|
+
*/
|
|
32152
|
+
left?: SchedulerLabelConfig
|
|
32153
|
+
/**
|
|
32154
|
+
* The listener set for this object.
|
|
32155
|
+
* ...
|
|
32156
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Labels#config-listeners)
|
|
32157
|
+
*/
|
|
32158
|
+
listeners?: LabelsListeners
|
|
32159
|
+
/**
|
|
32160
|
+
* A class translations of which are used for translating this entity.
|
|
32161
|
+
* This is often used when translations of an item are defined on its container class.
|
|
32162
|
+
* For example:
|
|
32163
|
+
* ...
|
|
32164
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Labels#config-localeClass)
|
|
32165
|
+
*/
|
|
32166
|
+
localeClass?: typeof Base
|
|
32167
|
+
/**
|
|
32168
|
+
* Set to `false` to disable localization of this object.
|
|
32169
|
+
*/
|
|
32170
|
+
localizable?: boolean
|
|
32171
|
+
/**
|
|
32172
|
+
* List of properties which values should be translated automatically upon a locale applying.
|
|
32173
|
+
* In case there is a need to localize not typical value (not a String value or a field with re-defined setter/getter),
|
|
32174
|
+
* you could use 'localeKey' meta configuration.
|
|
32175
|
+
* Example:
|
|
32176
|
+
* ...
|
|
32177
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Labels#config-localizableProperties)
|
|
32178
|
+
*/
|
|
32179
|
+
localizableProperties?: string[]
|
|
32180
|
+
/**
|
|
32181
|
+
* Right label configuration object.
|
|
32182
|
+
*/
|
|
32183
|
+
right?: SchedulerLabelConfig
|
|
32184
|
+
/**
|
|
32185
|
+
* Top label configuration object.
|
|
32186
|
+
*/
|
|
32187
|
+
top?: SchedulerLabelConfig
|
|
32188
|
+
/**
|
|
32189
|
+
* Fires before an object is destroyed.
|
|
32190
|
+
* @param {object} event Event object
|
|
32191
|
+
* @param {Core.Base} event.source The Object that is being destroyed.
|
|
32192
|
+
*/
|
|
32193
|
+
onBeforeDestroy?: ((event: { source: Base }) => void)|string
|
|
32194
|
+
/**
|
|
32195
|
+
* Fires when any other event is fired from the object.
|
|
32196
|
+
* ...
|
|
32197
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Labels#event-catchAll)
|
|
32198
|
+
* @param {object} event Event object
|
|
32199
|
+
* @param {{[key: string]: any, type: string}} event.event The Object that contains event details
|
|
32200
|
+
* @param {string} event.event.type The type of the event which is caught by the listener
|
|
32201
|
+
*/
|
|
32202
|
+
onCatchAll?: ((event: {[key: string]: any, type: string}) => void)|string
|
|
32203
|
+
/**
|
|
32204
|
+
* Fires when an object is destroyed.
|
|
32205
|
+
* @param {object} event Event object
|
|
32206
|
+
* @param {Core.Base} event.source The Object that is being destroyed.
|
|
32207
|
+
*/
|
|
32208
|
+
onDestroy?: ((event: { source: Base }) => void)|string
|
|
32209
|
+
/**
|
|
32210
|
+
* Fired when the plugin/feature is disabled.
|
|
32211
|
+
* @param {object} event Event object
|
|
32212
|
+
* @param {Core.mixin.InstancePlugin} event.source
|
|
32213
|
+
*/
|
|
32214
|
+
onDisable?: ((event: { source: InstancePlugin }) => void)|string
|
|
32215
|
+
/**
|
|
32216
|
+
* Fired when the plugin/feature is enabled.
|
|
32217
|
+
* @param {object} event Event object
|
|
32218
|
+
* @param {Core.mixin.InstancePlugin} event.source
|
|
32219
|
+
*/
|
|
32220
|
+
onEnable?: ((event: { source: InstancePlugin }) => void)|string
|
|
32221
|
+
}
|
|
32222
|
+
|
|
32223
|
+
/**
|
|
32224
|
+
* Displays labels at positions [top](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Labels#config-top), [right](#Scheduler/feature/Labels#config-right), [bottom](#Scheduler/feature/Labels#config-bottom) and
|
|
32225
|
+
* [left](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Labels#config-left).
|
|
31410
32226
|
* ...
|
|
31411
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
32227
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Labels)
|
|
31412
32228
|
*/
|
|
31413
|
-
export class
|
|
32229
|
+
export class Labels extends InstancePlugin {
|
|
31414
32230
|
/**
|
|
31415
|
-
* Identifies an object as an instance of [
|
|
32231
|
+
* Identifies an object as an instance of [Labels](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Labels) class, or subclass thereof.
|
|
31416
32232
|
*/
|
|
31417
|
-
static readonly
|
|
32233
|
+
static readonly isLabels: boolean
|
|
31418
32234
|
/**
|
|
31419
|
-
* Identifies an object as an instance of [
|
|
32235
|
+
* Identifies an object as an instance of [Labels](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Labels) class, or subclass thereof.
|
|
31420
32236
|
*/
|
|
31421
|
-
readonly
|
|
32237
|
+
readonly isLabels: boolean
|
|
31422
32238
|
/**
|
|
31423
32239
|
* Fires before an object is destroyed.
|
|
31424
32240
|
* @param {object} event Event object
|
|
@@ -31428,7 +32244,7 @@ export class HeaderZoom extends InstancePlugin {
|
|
|
31428
32244
|
/**
|
|
31429
32245
|
* Fires when any other event is fired from the object.
|
|
31430
32246
|
* ...
|
|
31431
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
32247
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Labels#event-catchAll)
|
|
31432
32248
|
* @param {object} event Event object
|
|
31433
32249
|
* @param {{[key: string]: any, type: string}} event.event The Object that contains event details
|
|
31434
32250
|
* @param {string} event.event.type The type of the event which is caught by the listener
|
|
@@ -31440,13 +32256,18 @@ export class HeaderZoom extends InstancePlugin {
|
|
|
31440
32256
|
* @param {Core.Base} event.source The Object that is being destroyed.
|
|
31441
32257
|
*/
|
|
31442
32258
|
onDestroy: ((event: { source: Base }) => void)|string
|
|
32259
|
+
/**
|
|
32260
|
+
* Creates an instance of the class using the supplied configuration
|
|
32261
|
+
* @param {LabelsConfig} config
|
|
32262
|
+
*/
|
|
32263
|
+
constructor(config?: LabelsConfig);
|
|
31443
32264
|
}
|
|
31444
32265
|
|
|
31445
32266
|
/**
|
|
31446
|
-
* Type with available listeners functions for [
|
|
32267
|
+
* Type with available listeners functions for [LockRows](https://bryntum.com/products/grid/docs/api/Scheduler/feature/LockRows) class.
|
|
31447
32268
|
* Could be used for callbacks typings in TypeScript application.
|
|
31448
32269
|
*/
|
|
31449
|
-
type
|
|
32270
|
+
type LockRowsListenersTypes = {
|
|
31450
32271
|
/**
|
|
31451
32272
|
* Fires before an object is destroyed.
|
|
31452
32273
|
* @param {object} event Event object
|
|
@@ -31456,7 +32277,7 @@ type LabelsListenersTypes = {
|
|
|
31456
32277
|
/**
|
|
31457
32278
|
* Fires when any other event is fired from the object.
|
|
31458
32279
|
* ...
|
|
31459
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
32280
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/LockRows#event-catchAll)
|
|
31460
32281
|
* @param {object} event Event object
|
|
31461
32282
|
* @param {{[key: string]: any, type: string}} event.event The Object that contains event details
|
|
31462
32283
|
* @param {string} event.event.type The type of the event which is caught by the listener
|
|
@@ -31483,9 +32304,9 @@ type LabelsListenersTypes = {
|
|
|
31483
32304
|
}
|
|
31484
32305
|
|
|
31485
32306
|
/**
|
|
31486
|
-
* Type with listeners options for [
|
|
32307
|
+
* Type with listeners options for [LockRows](https://bryntum.com/products/grid/docs/api/Scheduler/feature/LockRows) class.
|
|
31487
32308
|
*/
|
|
31488
|
-
type
|
|
32309
|
+
type LockRowsListeners = {
|
|
31489
32310
|
/**
|
|
31490
32311
|
* The `this` object for listener methods
|
|
31491
32312
|
*/
|
|
@@ -31499,7 +32320,7 @@ type LabelsListeners = {
|
|
|
31499
32320
|
/**
|
|
31500
32321
|
* Fires when any other event is fired from the object.
|
|
31501
32322
|
* ...
|
|
31502
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
32323
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/LockRows#event-catchAll)
|
|
31503
32324
|
* @param {object} event Event object
|
|
31504
32325
|
* @param {{[key: string]: any, type: string}} event.event The Object that contains event details
|
|
31505
32326
|
* @param {string} event.event.type The type of the event which is caught by the listener
|
|
@@ -31526,45 +32347,34 @@ type LabelsListeners = {
|
|
|
31526
32347
|
}
|
|
31527
32348
|
|
|
31528
32349
|
/**
|
|
31529
|
-
* Type with configuration options for [
|
|
32350
|
+
* Type with configuration options for [LockRows](https://bryntum.com/products/grid/docs/api/Scheduler/feature/LockRows) class.
|
|
31530
32351
|
*/
|
|
31531
|
-
type
|
|
31532
|
-
type?: '
|
|
31533
|
-
/**
|
|
31534
|
-
* Configuration object for the label which appears *after* the event bar in the current writing direction.
|
|
31535
|
-
*/
|
|
31536
|
-
after?: SchedulerLabelConfig
|
|
31537
|
-
/**
|
|
31538
|
-
* Configuration object for the label which appears *before* the event bar in the current writing direction.
|
|
31539
|
-
*/
|
|
31540
|
-
before?: SchedulerLabelConfig
|
|
31541
|
-
/**
|
|
31542
|
-
* What action should be taken when focus moves leaves the cell editor, for example when clicking outside.
|
|
31543
|
-
* May be `'complete'` or `'cancel`'.
|
|
31544
|
-
*/
|
|
31545
|
-
blurAction?: 'complete'|'cancel'
|
|
32352
|
+
type LockRowsConfig = {
|
|
32353
|
+
type?: 'lockRows'|'lockrows'
|
|
31546
32354
|
/**
|
|
31547
|
-
*
|
|
32355
|
+
* An object containing grid configuration for the bottom grid instance.
|
|
32356
|
+
* ...
|
|
32357
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/LockRows#config-bottomGridConfig)
|
|
31548
32358
|
*/
|
|
31549
|
-
|
|
32359
|
+
bottomGridConfig?: GridConfig
|
|
31550
32360
|
/**
|
|
31551
32361
|
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
31552
32362
|
* hierarchy when triggered.
|
|
31553
32363
|
* ...
|
|
31554
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
32364
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/LockRows#config-bubbleEvents)
|
|
31555
32365
|
*/
|
|
31556
32366
|
bubbleEvents?: object
|
|
31557
32367
|
/**
|
|
31558
32368
|
* Set to `true` to call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
|
|
31559
32369
|
* ...
|
|
31560
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
32370
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/LockRows#config-callOnFunctions)
|
|
31561
32371
|
*/
|
|
31562
32372
|
callOnFunctions?: boolean
|
|
31563
32373
|
/**
|
|
31564
32374
|
* By default, if an event handler throws an exception, the error propagates up the stack and the
|
|
31565
32375
|
* application state is undefined. Code which follows the event handler will *not* be executed.
|
|
31566
32376
|
* ...
|
|
31567
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
32377
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/LockRows#config-catchEventHandlerExceptions)
|
|
31568
32378
|
*/
|
|
31569
32379
|
catchEventHandlerExceptions?: boolean
|
|
31570
32380
|
/**
|
|
@@ -31574,40 +32384,36 @@ type LabelsConfig = {
|
|
|
31574
32384
|
/**
|
|
31575
32385
|
* The plugin/feature `disabled` state.
|
|
31576
32386
|
* ...
|
|
31577
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
32387
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/LockRows#config-disabled)
|
|
31578
32388
|
*/
|
|
31579
32389
|
disabled?: boolean|'inert'
|
|
31580
32390
|
/**
|
|
31581
|
-
*
|
|
31582
|
-
* with `labelLayoutMode: 'estimate'`.
|
|
31583
|
-
*/
|
|
31584
|
-
labelCharWidth?: number
|
|
31585
|
-
/**
|
|
31586
|
-
* CSS class to apply to label elements
|
|
31587
|
-
*/
|
|
31588
|
-
labelCls?: string
|
|
31589
|
-
/**
|
|
31590
|
-
* How to handle labels during event layout. Options are:
|
|
32391
|
+
* The field name whose truthy/falsy state decides whether a record is locked at the top of the grid.
|
|
31591
32392
|
* ...
|
|
31592
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
32393
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/LockRows#config-fieldName)
|
|
31593
32394
|
*/
|
|
31594
|
-
|
|
32395
|
+
fieldName?: string
|
|
31595
32396
|
/**
|
|
31596
|
-
*
|
|
32397
|
+
* A function, or the name of a function in the Grid's ownership hierarchy, that decides whether a record is
|
|
32398
|
+
* locked at the top of the grid.
|
|
32399
|
+
* ...
|
|
32400
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/LockRows#config-filterFn)
|
|
32401
|
+
* @param {Core.data.Model} record The record to decide upon.
|
|
32402
|
+
* @returns {boolean} Return `true` to lock the record at the top.
|
|
31597
32403
|
*/
|
|
31598
|
-
|
|
32404
|
+
filterFn?: ((record: Model) => boolean)|string
|
|
31599
32405
|
/**
|
|
31600
32406
|
* The listener set for this object.
|
|
31601
32407
|
* ...
|
|
31602
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
32408
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/LockRows#config-listeners)
|
|
31603
32409
|
*/
|
|
31604
|
-
listeners?:
|
|
32410
|
+
listeners?: LockRowsListeners
|
|
31605
32411
|
/**
|
|
31606
32412
|
* A class translations of which are used for translating this entity.
|
|
31607
32413
|
* This is often used when translations of an item are defined on its container class.
|
|
31608
32414
|
* For example:
|
|
31609
32415
|
* ...
|
|
31610
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
32416
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/LockRows#config-localeClass)
|
|
31611
32417
|
*/
|
|
31612
32418
|
localeClass?: typeof Base
|
|
31613
32419
|
/**
|
|
@@ -31620,17 +32426,15 @@ type LabelsConfig = {
|
|
|
31620
32426
|
* you could use 'localeKey' meta configuration.
|
|
31621
32427
|
* Example:
|
|
31622
32428
|
* ...
|
|
31623
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
32429
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/LockRows#config-localizableProperties)
|
|
31624
32430
|
*/
|
|
31625
32431
|
localizableProperties?: string[]
|
|
31626
32432
|
/**
|
|
31627
|
-
*
|
|
31628
|
-
|
|
31629
|
-
|
|
31630
|
-
/**
|
|
31631
|
-
* Top label configuration object.
|
|
32433
|
+
* Properties whose changes should be relayed to sub-views at runtime.
|
|
32434
|
+
* ...
|
|
32435
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/LockRows#config-relayProperties)
|
|
31632
32436
|
*/
|
|
31633
|
-
|
|
32437
|
+
relayProperties?: Record<string, boolean>
|
|
31634
32438
|
/**
|
|
31635
32439
|
* Fires before an object is destroyed.
|
|
31636
32440
|
* @param {object} event Event object
|
|
@@ -31640,7 +32444,7 @@ type LabelsConfig = {
|
|
|
31640
32444
|
/**
|
|
31641
32445
|
* Fires when any other event is fired from the object.
|
|
31642
32446
|
* ...
|
|
31643
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
32447
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/LockRows#event-catchAll)
|
|
31644
32448
|
* @param {object} event Event object
|
|
31645
32449
|
* @param {{[key: string]: any, type: string}} event.event The Object that contains event details
|
|
31646
32450
|
* @param {string} event.event.type The type of the event which is caught by the listener
|
|
@@ -31667,20 +32471,19 @@ type LabelsConfig = {
|
|
|
31667
32471
|
}
|
|
31668
32472
|
|
|
31669
32473
|
/**
|
|
31670
|
-
*
|
|
31671
|
-
* [left](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Labels#config-left).
|
|
32474
|
+
* This feature allows resources which satisfy a certain condition to be locked at the top of the scheduler.
|
|
31672
32475
|
* ...
|
|
31673
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
32476
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/LockRows)
|
|
31674
32477
|
*/
|
|
31675
|
-
export class
|
|
32478
|
+
export class LockRows extends GridLockRows {
|
|
31676
32479
|
/**
|
|
31677
|
-
* Identifies an object as an instance of [
|
|
32480
|
+
* Identifies an object as an instance of [LockRows](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/LockRows) class, or subclass thereof.
|
|
31678
32481
|
*/
|
|
31679
|
-
static readonly
|
|
32482
|
+
static readonly isLockRows: boolean
|
|
31680
32483
|
/**
|
|
31681
|
-
* Identifies an object as an instance of [
|
|
32484
|
+
* Identifies an object as an instance of [LockRows](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/LockRows) class, or subclass thereof.
|
|
31682
32485
|
*/
|
|
31683
|
-
readonly
|
|
32486
|
+
readonly isLockRows: boolean
|
|
31684
32487
|
/**
|
|
31685
32488
|
* Fires before an object is destroyed.
|
|
31686
32489
|
* @param {object} event Event object
|
|
@@ -31690,7 +32493,7 @@ export class Labels extends InstancePlugin {
|
|
|
31690
32493
|
/**
|
|
31691
32494
|
* Fires when any other event is fired from the object.
|
|
31692
32495
|
* ...
|
|
31693
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
32496
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/LockRows#event-catchAll)
|
|
31694
32497
|
* @param {object} event Event object
|
|
31695
32498
|
* @param {{[key: string]: any, type: string}} event.event The Object that contains event details
|
|
31696
32499
|
* @param {string} event.event.type The type of the event which is caught by the listener
|
|
@@ -31702,18 +32505,13 @@ export class Labels extends InstancePlugin {
|
|
|
31702
32505
|
* @param {Core.Base} event.source The Object that is being destroyed.
|
|
31703
32506
|
*/
|
|
31704
32507
|
onDestroy: ((event: { source: Base }) => void)|string
|
|
31705
|
-
/**
|
|
31706
|
-
* Creates an instance of the class using the supplied configuration
|
|
31707
|
-
* @param {LabelsConfig} config
|
|
31708
|
-
*/
|
|
31709
|
-
constructor(config?: LabelsConfig);
|
|
31710
32508
|
}
|
|
31711
32509
|
|
|
31712
32510
|
/**
|
|
31713
|
-
* Type with available listeners functions for [
|
|
32511
|
+
* Type with available listeners functions for [NonWorkingTime](https://bryntum.com/products/grid/docs/api/Scheduler/feature/NonWorkingTime) class.
|
|
31714
32512
|
* Could be used for callbacks typings in TypeScript application.
|
|
31715
32513
|
*/
|
|
31716
|
-
type
|
|
32514
|
+
type NonWorkingTimeListenersTypes = {
|
|
31717
32515
|
/**
|
|
31718
32516
|
* Fires before an object is destroyed.
|
|
31719
32517
|
* @param {object} event Event object
|
|
@@ -31723,7 +32521,7 @@ type LockRowsListenersTypes = {
|
|
|
31723
32521
|
/**
|
|
31724
32522
|
* Fires when any other event is fired from the object.
|
|
31725
32523
|
* ...
|
|
31726
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
32524
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/NonWorkingTime#event-catchAll)
|
|
31727
32525
|
* @param {object} event Event object
|
|
31728
32526
|
* @param {{[key: string]: any, type: string}} event.event The Object that contains event details
|
|
31729
32527
|
* @param {string} event.event.type The type of the event which is caught by the listener
|
|
@@ -31750,9 +32548,9 @@ type LockRowsListenersTypes = {
|
|
|
31750
32548
|
}
|
|
31751
32549
|
|
|
31752
32550
|
/**
|
|
31753
|
-
* Type with listeners options for [
|
|
32551
|
+
* Type with listeners options for [NonWorkingTime](https://bryntum.com/products/grid/docs/api/Scheduler/feature/NonWorkingTime) class.
|
|
31754
32552
|
*/
|
|
31755
|
-
type
|
|
32553
|
+
type NonWorkingTimeListeners = {
|
|
31756
32554
|
/**
|
|
31757
32555
|
* The `this` object for listener methods
|
|
31758
32556
|
*/
|
|
@@ -31766,7 +32564,7 @@ type LockRowsListeners = {
|
|
|
31766
32564
|
/**
|
|
31767
32565
|
* Fires when any other event is fired from the object.
|
|
31768
32566
|
* ...
|
|
31769
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
32567
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/NonWorkingTime#event-catchAll)
|
|
31770
32568
|
* @param {object} event Event object
|
|
31771
32569
|
* @param {{[key: string]: any, type: string}} event.event The Object that contains event details
|
|
31772
32570
|
* @param {string} event.event.type The type of the event which is caught by the listener
|
|
@@ -31793,34 +32591,37 @@ type LockRowsListeners = {
|
|
|
31793
32591
|
}
|
|
31794
32592
|
|
|
31795
32593
|
/**
|
|
31796
|
-
* Type with configuration options for [
|
|
32594
|
+
* Type with configuration options for [NonWorkingTime](https://bryntum.com/products/grid/docs/api/Scheduler/feature/NonWorkingTime) class.
|
|
31797
32595
|
*/
|
|
31798
|
-
type
|
|
31799
|
-
type?: '
|
|
32596
|
+
type NonWorkingTimeConfig = {
|
|
32597
|
+
type?: 'nonWorkingTime'|'nonworkingtime'
|
|
31800
32598
|
/**
|
|
31801
|
-
*
|
|
32599
|
+
* Function used to generate the HTML content for a time range body element.
|
|
31802
32600
|
* ...
|
|
31803
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
32601
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/NonWorkingTime#config-bodyRenderer)
|
|
32602
|
+
* @param {object} data Render data
|
|
32603
|
+
* @param {Scheduler.model.TimeSpan} data.timeRange
|
|
32604
|
+
* @returns {string} String representing the HTML markup
|
|
31804
32605
|
*/
|
|
31805
|
-
|
|
32606
|
+
bodyRenderer?: (data: { timeRange: TimeSpan }) => string
|
|
31806
32607
|
/**
|
|
31807
32608
|
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
31808
32609
|
* hierarchy when triggered.
|
|
31809
32610
|
* ...
|
|
31810
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
32611
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/NonWorkingTime#config-bubbleEvents)
|
|
31811
32612
|
*/
|
|
31812
32613
|
bubbleEvents?: object
|
|
31813
32614
|
/**
|
|
31814
32615
|
* Set to `true` to call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
|
|
31815
32616
|
* ...
|
|
31816
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
32617
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/NonWorkingTime#config-callOnFunctions)
|
|
31817
32618
|
*/
|
|
31818
32619
|
callOnFunctions?: boolean
|
|
31819
32620
|
/**
|
|
31820
32621
|
* By default, if an event handler throws an exception, the error propagates up the stack and the
|
|
31821
32622
|
* application state is undefined. Code which follows the event handler will *not* be executed.
|
|
31822
32623
|
* ...
|
|
31823
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
32624
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/NonWorkingTime#config-catchEventHandlerExceptions)
|
|
31824
32625
|
*/
|
|
31825
32626
|
catchEventHandlerExceptions?: boolean
|
|
31826
32627
|
/**
|
|
@@ -31830,36 +32631,42 @@ type LockRowsConfig = {
|
|
|
31830
32631
|
/**
|
|
31831
32632
|
* The plugin/feature `disabled` state.
|
|
31832
32633
|
* ...
|
|
31833
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
32634
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/NonWorkingTime#config-disabled)
|
|
31834
32635
|
*/
|
|
31835
32636
|
disabled?: boolean|'inert'
|
|
31836
32637
|
/**
|
|
31837
|
-
*
|
|
32638
|
+
* Function used to generate the HTML content for a time range header element.
|
|
31838
32639
|
* ...
|
|
31839
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
32640
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/NonWorkingTime#config-headerRenderer)
|
|
32641
|
+
* @param {object} data Render data
|
|
32642
|
+
* @param {Scheduler.model.TimeSpan} data.timeRange
|
|
32643
|
+
* @returns {string} String representing the HTML markup
|
|
31840
32644
|
*/
|
|
31841
|
-
|
|
32645
|
+
headerRenderer?: (data: { timeRange: TimeSpan }) => string
|
|
31842
32646
|
/**
|
|
31843
|
-
*
|
|
31844
|
-
*
|
|
32647
|
+
* The feature by default does not render ranges smaller than the base unit used by the time axis.
|
|
32648
|
+
* Set this config to `false` to disable this behavior.
|
|
31845
32649
|
* ...
|
|
31846
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
31847
|
-
* @param {Core.data.Model} record The record to decide upon.
|
|
31848
|
-
* @returns {boolean} Return `true` to lock the record at the top.
|
|
32650
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/NonWorkingTime#config-hideRangesOnZooming)
|
|
31849
32651
|
*/
|
|
31850
|
-
|
|
32652
|
+
hideRangesOnZooming?: boolean
|
|
32653
|
+
/**
|
|
32654
|
+
* A [Tooltip](https://bryntum.com/products/scheduler/docs/api/Core/widget/Tooltip) config object which is applied to the tooltip shown when hovering a
|
|
32655
|
+
* TimeRange header element
|
|
32656
|
+
*/
|
|
32657
|
+
hoverTooltip?: TooltipConfig
|
|
31851
32658
|
/**
|
|
31852
32659
|
* The listener set for this object.
|
|
31853
32660
|
* ...
|
|
31854
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
32661
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/NonWorkingTime#config-listeners)
|
|
31855
32662
|
*/
|
|
31856
|
-
listeners?:
|
|
32663
|
+
listeners?: NonWorkingTimeListeners
|
|
31857
32664
|
/**
|
|
31858
32665
|
* A class translations of which are used for translating this entity.
|
|
31859
32666
|
* This is often used when translations of an item are defined on its container class.
|
|
31860
32667
|
* For example:
|
|
31861
32668
|
* ...
|
|
31862
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
32669
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/NonWorkingTime#config-localeClass)
|
|
31863
32670
|
*/
|
|
31864
32671
|
localeClass?: typeof Base
|
|
31865
32672
|
/**
|
|
@@ -31872,15 +32679,38 @@ type LockRowsConfig = {
|
|
|
31872
32679
|
* you could use 'localeKey' meta configuration.
|
|
31873
32680
|
* Example:
|
|
31874
32681
|
* ...
|
|
31875
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
32682
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/NonWorkingTime#config-localizableProperties)
|
|
31876
32683
|
*/
|
|
31877
32684
|
localizableProperties?: string[]
|
|
31878
32685
|
/**
|
|
31879
|
-
*
|
|
32686
|
+
* The maximum time axis unit to display non-working ranges for ('hour' or 'day' etc).
|
|
32687
|
+
* When zooming to a view with a larger unit, no non-working time elements will be rendered.
|
|
31880
32688
|
* ...
|
|
31881
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
32689
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/NonWorkingTime#config-maxTimeAxisUnit)
|
|
31882
32690
|
*/
|
|
31883
|
-
|
|
32691
|
+
maxTimeAxisUnit?: DurationUnit
|
|
32692
|
+
/**
|
|
32693
|
+
* Set to `false` to not render range elements into the time axis header. Note that header elements are
|
|
32694
|
+
* required for interaction such as dragging/resizing, so enabling [enableResizing](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/AbstractTimeRanges#config-enableResizing) will
|
|
32695
|
+
* automatically enable this setting.
|
|
32696
|
+
*/
|
|
32697
|
+
showHeaderElements?: boolean
|
|
32698
|
+
/**
|
|
32699
|
+
* A Boolean specifying whether to show tooltip while resizing range elements, or a
|
|
32700
|
+
* [Tooltip](https://bryntum.com/products/scheduler/docs/api/Core/widget/Tooltip) config object which is applied to the tooltip
|
|
32701
|
+
*/
|
|
32702
|
+
showTooltip?: boolean|TooltipConfig
|
|
32703
|
+
/**
|
|
32704
|
+
* Template used to generate the tooltip contents when hovering a time range header element.
|
|
32705
|
+
* ...
|
|
32706
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/NonWorkingTime#config-tooltipTemplate)
|
|
32707
|
+
* @param {object} data Tooltip data
|
|
32708
|
+
* @param {Scheduler.model.TimeSpan} data.timeRange
|
|
32709
|
+
* @param {string} data.startClockHtml Predefined HTML to show the start time
|
|
32710
|
+
* @param {string} data.endClockHtml Predefined HTML to show the end time
|
|
32711
|
+
* @returns {string} String representing the HTML markup
|
|
32712
|
+
*/
|
|
32713
|
+
tooltipTemplate?: (data: { timeRange: TimeSpan, startClockHtml: string, endClockHtml: string }) => string
|
|
31884
32714
|
/**
|
|
31885
32715
|
* Fires before an object is destroyed.
|
|
31886
32716
|
* @param {object} event Event object
|
|
@@ -31890,7 +32720,7 @@ type LockRowsConfig = {
|
|
|
31890
32720
|
/**
|
|
31891
32721
|
* Fires when any other event is fired from the object.
|
|
31892
32722
|
* ...
|
|
31893
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
32723
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/NonWorkingTime#event-catchAll)
|
|
31894
32724
|
* @param {object} event Event object
|
|
31895
32725
|
* @param {{[key: string]: any, type: string}} event.event The Object that contains event details
|
|
31896
32726
|
* @param {string} event.event.type The type of the event which is caught by the listener
|
|
@@ -31917,19 +32747,27 @@ type LockRowsConfig = {
|
|
|
31917
32747
|
}
|
|
31918
32748
|
|
|
31919
32749
|
/**
|
|
31920
|
-
*
|
|
32750
|
+
* Feature that allows styling of weekends (and other non-working time) by adding timeRanges for those days.
|
|
31921
32751
|
* ...
|
|
31922
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
32752
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/NonWorkingTime)
|
|
31923
32753
|
*/
|
|
31924
|
-
export class
|
|
32754
|
+
export class NonWorkingTime extends AbstractTimeRanges {
|
|
31925
32755
|
/**
|
|
31926
|
-
* Identifies an object as an instance of [
|
|
32756
|
+
* Identifies an object as an instance of [NonWorkingTime](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/NonWorkingTime) class, or subclass thereof.
|
|
31927
32757
|
*/
|
|
31928
|
-
static readonly
|
|
32758
|
+
static readonly isNonWorkingTime: boolean
|
|
31929
32759
|
/**
|
|
31930
|
-
* Identifies an object as an instance of [
|
|
32760
|
+
* Identifies an object as an instance of [NonWorkingTimeMixin](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/mixin/NonWorkingTimeMixin) class, or subclass thereof.
|
|
31931
32761
|
*/
|
|
31932
|
-
readonly
|
|
32762
|
+
static readonly isNonWorkingTimeMixin: boolean
|
|
32763
|
+
/**
|
|
32764
|
+
* Identifies an object as an instance of [NonWorkingTime](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/NonWorkingTime) class, or subclass thereof.
|
|
32765
|
+
*/
|
|
32766
|
+
readonly isNonWorkingTime: boolean
|
|
32767
|
+
/**
|
|
32768
|
+
* Identifies an object as an instance of [NonWorkingTimeMixin](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/mixin/NonWorkingTimeMixin) class, or subclass thereof.
|
|
32769
|
+
*/
|
|
32770
|
+
readonly isNonWorkingTimeMixin: boolean
|
|
31933
32771
|
/**
|
|
31934
32772
|
* Fires before an object is destroyed.
|
|
31935
32773
|
* @param {object} event Event object
|
|
@@ -31939,7 +32777,7 @@ export class LockRows extends GridLockRows {
|
|
|
31939
32777
|
/**
|
|
31940
32778
|
* Fires when any other event is fired from the object.
|
|
31941
32779
|
* ...
|
|
31942
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
32780
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/NonWorkingTime#event-catchAll)
|
|
31943
32781
|
* @param {object} event Event object
|
|
31944
32782
|
* @param {{[key: string]: any, type: string}} event.event The Object that contains event details
|
|
31945
32783
|
* @param {string} event.event.type The type of the event which is caught by the listener
|
|
@@ -31951,13 +32789,27 @@ export class LockRows extends GridLockRows {
|
|
|
31951
32789
|
* @param {Core.Base} event.source The Object that is being destroyed.
|
|
31952
32790
|
*/
|
|
31953
32791
|
onDestroy: ((event: { source: Base }) => void)|string
|
|
32792
|
+
/**
|
|
32793
|
+
* Creates an instance of the class using the supplied configuration
|
|
32794
|
+
* @param {NonWorkingTimeConfig} config
|
|
32795
|
+
*/
|
|
32796
|
+
constructor(config?: NonWorkingTimeConfig);
|
|
32797
|
+
/**
|
|
32798
|
+
* Based on this method result the feature decides whether the provided non-working period should
|
|
32799
|
+
* be rendered or not.
|
|
32800
|
+
* The method checks that the range has non-zero [duration](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/TimeSpan#field-duration),
|
|
32801
|
+
* lays in the visible timespan and its duration is longer or equal the base timeaxis unit
|
|
32802
|
+
* (if [hideRangesOnZooming](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/NonWorkingTime#config-hideRangesOnZooming) is `true`).
|
|
32803
|
+
* @param {Scheduler.model.TimeSpan} range Range to render.
|
|
32804
|
+
*/
|
|
32805
|
+
shouldRenderRange(range: TimeSpan): boolean;
|
|
31954
32806
|
}
|
|
31955
32807
|
|
|
31956
32808
|
/**
|
|
31957
|
-
* Type with available listeners functions for [
|
|
32809
|
+
* Type with available listeners functions for [Pan](https://bryntum.com/products/grid/docs/api/Scheduler/feature/Pan) class.
|
|
31958
32810
|
* Could be used for callbacks typings in TypeScript application.
|
|
31959
32811
|
*/
|
|
31960
|
-
type
|
|
32812
|
+
type PanListenersTypes = {
|
|
31961
32813
|
/**
|
|
31962
32814
|
* Fires before an object is destroyed.
|
|
31963
32815
|
* @param {object} event Event object
|
|
@@ -31967,7 +32819,7 @@ type NonWorkingTimeListenersTypes = {
|
|
|
31967
32819
|
/**
|
|
31968
32820
|
* Fires when any other event is fired from the object.
|
|
31969
32821
|
* ...
|
|
31970
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
32822
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Pan#event-catchAll)
|
|
31971
32823
|
* @param {object} event Event object
|
|
31972
32824
|
* @param {{[key: string]: any, type: string}} event.event The Object that contains event details
|
|
31973
32825
|
* @param {string} event.event.type The type of the event which is caught by the listener
|
|
@@ -31994,9 +32846,9 @@ type NonWorkingTimeListenersTypes = {
|
|
|
31994
32846
|
}
|
|
31995
32847
|
|
|
31996
32848
|
/**
|
|
31997
|
-
* Type with listeners options for [
|
|
32849
|
+
* Type with listeners options for [Pan](https://bryntum.com/products/grid/docs/api/Scheduler/feature/Pan) class.
|
|
31998
32850
|
*/
|
|
31999
|
-
type
|
|
32851
|
+
type PanListeners = {
|
|
32000
32852
|
/**
|
|
32001
32853
|
* The `this` object for listener methods
|
|
32002
32854
|
*/
|
|
@@ -32010,7 +32862,7 @@ type NonWorkingTimeListeners = {
|
|
|
32010
32862
|
/**
|
|
32011
32863
|
* Fires when any other event is fired from the object.
|
|
32012
32864
|
* ...
|
|
32013
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
32865
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Pan#event-catchAll)
|
|
32014
32866
|
* @param {object} event Event object
|
|
32015
32867
|
* @param {{[key: string]: any, type: string}} event.event The Object that contains event details
|
|
32016
32868
|
* @param {string} event.event.type The type of the event which is caught by the listener
|
|
@@ -32037,37 +32889,28 @@ type NonWorkingTimeListeners = {
|
|
|
32037
32889
|
}
|
|
32038
32890
|
|
|
32039
32891
|
/**
|
|
32040
|
-
* Type with configuration options for [
|
|
32892
|
+
* Type with configuration options for [Pan](https://bryntum.com/products/grid/docs/api/Scheduler/feature/Pan) class.
|
|
32041
32893
|
*/
|
|
32042
|
-
type
|
|
32043
|
-
type?: '
|
|
32044
|
-
/**
|
|
32045
|
-
* Function used to generate the HTML content for a time range body element.
|
|
32046
|
-
* ...
|
|
32047
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/NonWorkingTime#config-bodyRenderer)
|
|
32048
|
-
* @param {object} data Render data
|
|
32049
|
-
* @param {Scheduler.model.TimeSpan} data.timeRange
|
|
32050
|
-
* @returns {string} String representing the HTML markup
|
|
32051
|
-
*/
|
|
32052
|
-
bodyRenderer?: (data: { timeRange: TimeSpan }) => string
|
|
32894
|
+
type PanConfig = {
|
|
32895
|
+
type?: 'pan'
|
|
32053
32896
|
/**
|
|
32054
32897
|
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
32055
32898
|
* hierarchy when triggered.
|
|
32056
32899
|
* ...
|
|
32057
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
32900
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Pan#config-bubbleEvents)
|
|
32058
32901
|
*/
|
|
32059
32902
|
bubbleEvents?: object
|
|
32060
32903
|
/**
|
|
32061
32904
|
* Set to `true` to call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
|
|
32062
32905
|
* ...
|
|
32063
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
32906
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Pan#config-callOnFunctions)
|
|
32064
32907
|
*/
|
|
32065
32908
|
callOnFunctions?: boolean
|
|
32066
32909
|
/**
|
|
32067
32910
|
* By default, if an event handler throws an exception, the error propagates up the stack and the
|
|
32068
32911
|
* application state is undefined. Code which follows the event handler will *not* be executed.
|
|
32069
32912
|
* ...
|
|
32070
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
32913
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Pan#config-catchEventHandlerExceptions)
|
|
32071
32914
|
*/
|
|
32072
32915
|
catchEventHandlerExceptions?: boolean
|
|
32073
32916
|
/**
|
|
@@ -32077,42 +32920,29 @@ type NonWorkingTimeConfig = {
|
|
|
32077
32920
|
/**
|
|
32078
32921
|
* The plugin/feature `disabled` state.
|
|
32079
32922
|
* ...
|
|
32080
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
32923
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Pan#config-disabled)
|
|
32081
32924
|
*/
|
|
32082
32925
|
disabled?: boolean|'inert'
|
|
32083
32926
|
/**
|
|
32084
|
-
*
|
|
32085
|
-
* ...
|
|
32086
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/NonWorkingTime#config-headerRenderer)
|
|
32087
|
-
* @param {object} data Render data
|
|
32088
|
-
* @param {Scheduler.model.TimeSpan} data.timeRange
|
|
32089
|
-
* @returns {string} String representing the HTML markup
|
|
32090
|
-
*/
|
|
32091
|
-
headerRenderer?: (data: { timeRange: TimeSpan }) => string
|
|
32092
|
-
/**
|
|
32093
|
-
* The feature by default does not render ranges smaller than the base unit used by the time axis.
|
|
32094
|
-
* Set this config to `false` to disable this behavior.
|
|
32095
|
-
* ...
|
|
32096
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/NonWorkingTime#config-hideRangesOnZooming)
|
|
32927
|
+
* Set to `false` to not pan horizontally when dragging in the time axis header
|
|
32097
32928
|
*/
|
|
32098
|
-
|
|
32929
|
+
enableInHeader?: boolean
|
|
32099
32930
|
/**
|
|
32100
|
-
*
|
|
32101
|
-
* TimeRange header element
|
|
32931
|
+
* Set to `false` to not pan horizontally
|
|
32102
32932
|
*/
|
|
32103
|
-
|
|
32933
|
+
horizontal?: boolean
|
|
32104
32934
|
/**
|
|
32105
32935
|
* The listener set for this object.
|
|
32106
32936
|
* ...
|
|
32107
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
32937
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Pan#config-listeners)
|
|
32108
32938
|
*/
|
|
32109
|
-
listeners?:
|
|
32939
|
+
listeners?: PanListeners
|
|
32110
32940
|
/**
|
|
32111
32941
|
* A class translations of which are used for translating this entity.
|
|
32112
32942
|
* This is often used when translations of an item are defined on its container class.
|
|
32113
32943
|
* For example:
|
|
32114
32944
|
* ...
|
|
32115
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
32945
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Pan#config-localeClass)
|
|
32116
32946
|
*/
|
|
32117
32947
|
localeClass?: typeof Base
|
|
32118
32948
|
/**
|
|
@@ -32125,38 +32955,13 @@ type NonWorkingTimeConfig = {
|
|
|
32125
32955
|
* you could use 'localeKey' meta configuration.
|
|
32126
32956
|
* Example:
|
|
32127
32957
|
* ...
|
|
32128
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
32958
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Pan#config-localizableProperties)
|
|
32129
32959
|
*/
|
|
32130
32960
|
localizableProperties?: string[]
|
|
32131
32961
|
/**
|
|
32132
|
-
*
|
|
32133
|
-
* When zooming to a view with a larger unit, no non-working time elements will be rendered.
|
|
32134
|
-
* ...
|
|
32135
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/NonWorkingTime#config-maxTimeAxisUnit)
|
|
32136
|
-
*/
|
|
32137
|
-
maxTimeAxisUnit?: DurationUnit
|
|
32138
|
-
/**
|
|
32139
|
-
* Set to `false` to not render range elements into the time axis header. Note that header elements are
|
|
32140
|
-
* required for interaction such as dragging/resizing, so enabling [enableResizing](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/AbstractTimeRanges#config-enableResizing) will
|
|
32141
|
-
* automatically enable this setting.
|
|
32142
|
-
*/
|
|
32143
|
-
showHeaderElements?: boolean
|
|
32144
|
-
/**
|
|
32145
|
-
* A Boolean specifying whether to show tooltip while resizing range elements, or a
|
|
32146
|
-
* [Tooltip](https://bryntum.com/products/scheduler/docs/api/Core/widget/Tooltip) config object which is applied to the tooltip
|
|
32147
|
-
*/
|
|
32148
|
-
showTooltip?: boolean|TooltipConfig
|
|
32149
|
-
/**
|
|
32150
|
-
* Template used to generate the tooltip contents when hovering a time range header element.
|
|
32151
|
-
* ...
|
|
32152
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/NonWorkingTime#config-tooltipTemplate)
|
|
32153
|
-
* @param {object} data Tooltip data
|
|
32154
|
-
* @param {Scheduler.model.TimeSpan} data.timeRange
|
|
32155
|
-
* @param {string} data.startClockHtml Predefined HTML to show the start time
|
|
32156
|
-
* @param {string} data.endClockHtml Predefined HTML to show the end time
|
|
32157
|
-
* @returns {string} String representing the HTML markup
|
|
32962
|
+
* Set to `false` to not pan vertically
|
|
32158
32963
|
*/
|
|
32159
|
-
|
|
32964
|
+
vertical?: boolean
|
|
32160
32965
|
/**
|
|
32161
32966
|
* Fires before an object is destroyed.
|
|
32162
32967
|
* @param {object} event Event object
|
|
@@ -32166,7 +32971,7 @@ type NonWorkingTimeConfig = {
|
|
|
32166
32971
|
/**
|
|
32167
32972
|
* Fires when any other event is fired from the object.
|
|
32168
32973
|
* ...
|
|
32169
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
32974
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Pan#event-catchAll)
|
|
32170
32975
|
* @param {object} event Event object
|
|
32171
32976
|
* @param {{[key: string]: any, type: string}} event.event The Object that contains event details
|
|
32172
32977
|
* @param {string} event.event.type The type of the event which is caught by the listener
|
|
@@ -32193,27 +32998,35 @@ type NonWorkingTimeConfig = {
|
|
|
32193
32998
|
}
|
|
32194
32999
|
|
|
32195
33000
|
/**
|
|
32196
|
-
*
|
|
33001
|
+
* Makes the scheduler's timeline pannable by dragging with the mouse. Try it out in the demo below.
|
|
32197
33002
|
* ...
|
|
32198
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
33003
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Pan)
|
|
32199
33004
|
*/
|
|
32200
|
-
export class
|
|
33005
|
+
export class Pan extends InstancePlugin {
|
|
32201
33006
|
/**
|
|
32202
|
-
* Identifies an object as an instance of [
|
|
33007
|
+
* Identifies an object as an instance of [Pan](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Pan) class, or subclass thereof.
|
|
32203
33008
|
*/
|
|
32204
|
-
static readonly
|
|
33009
|
+
static readonly isPan: boolean
|
|
32205
33010
|
/**
|
|
32206
|
-
*
|
|
33011
|
+
* Set to `false` to not pan horizontally when dragging in the time axis header
|
|
32207
33012
|
*/
|
|
32208
|
-
|
|
33013
|
+
enableInHeader: boolean
|
|
32209
33014
|
/**
|
|
32210
|
-
*
|
|
33015
|
+
* Set to `false` to not pan horizontally
|
|
32211
33016
|
*/
|
|
32212
|
-
|
|
33017
|
+
horizontal: boolean
|
|
32213
33018
|
/**
|
|
32214
|
-
*
|
|
33019
|
+
* Yields `true` if a pan gesture is in process.
|
|
32215
33020
|
*/
|
|
32216
|
-
readonly
|
|
33021
|
+
readonly isActive: boolean
|
|
33022
|
+
/**
|
|
33023
|
+
* Identifies an object as an instance of [Pan](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Pan) class, or subclass thereof.
|
|
33024
|
+
*/
|
|
33025
|
+
readonly isPan: boolean
|
|
33026
|
+
/**
|
|
33027
|
+
* Set to `false` to not pan vertically
|
|
33028
|
+
*/
|
|
33029
|
+
vertical: boolean
|
|
32217
33030
|
/**
|
|
32218
33031
|
* Fires before an object is destroyed.
|
|
32219
33032
|
* @param {object} event Event object
|
|
@@ -32223,7 +33036,7 @@ export class NonWorkingTime extends AbstractTimeRanges {
|
|
|
32223
33036
|
/**
|
|
32224
33037
|
* Fires when any other event is fired from the object.
|
|
32225
33038
|
* ...
|
|
32226
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
33039
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Pan#event-catchAll)
|
|
32227
33040
|
* @param {object} event Event object
|
|
32228
33041
|
* @param {{[key: string]: any, type: string}} event.event The Object that contains event details
|
|
32229
33042
|
* @param {string} event.event.type The type of the event which is caught by the listener
|
|
@@ -32237,25 +33050,16 @@ export class NonWorkingTime extends AbstractTimeRanges {
|
|
|
32237
33050
|
onDestroy: ((event: { source: Base }) => void)|string
|
|
32238
33051
|
/**
|
|
32239
33052
|
* Creates an instance of the class using the supplied configuration
|
|
32240
|
-
* @param {
|
|
32241
|
-
*/
|
|
32242
|
-
constructor(config?: NonWorkingTimeConfig);
|
|
32243
|
-
/**
|
|
32244
|
-
* Based on this method result the feature decides whether the provided non-working period should
|
|
32245
|
-
* be rendered or not.
|
|
32246
|
-
* The method checks that the range has non-zero [duration](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/TimeSpan#field-duration),
|
|
32247
|
-
* lays in the visible timespan and its duration is longer or equal the base timeaxis unit
|
|
32248
|
-
* (if [hideRangesOnZooming](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/NonWorkingTime#config-hideRangesOnZooming) is `true`).
|
|
32249
|
-
* @param {Scheduler.model.TimeSpan} range Range to render.
|
|
33053
|
+
* @param {PanConfig} config
|
|
32250
33054
|
*/
|
|
32251
|
-
|
|
33055
|
+
constructor(config?: PanConfig);
|
|
32252
33056
|
}
|
|
32253
33057
|
|
|
32254
33058
|
/**
|
|
32255
|
-
* Type with available listeners functions for [
|
|
33059
|
+
* Type with available listeners functions for [ResourceColumnReorder](https://bryntum.com/products/grid/docs/api/Scheduler/feature/ResourceColumnReorder) class.
|
|
32256
33060
|
* Could be used for callbacks typings in TypeScript application.
|
|
32257
33061
|
*/
|
|
32258
|
-
type
|
|
33062
|
+
type ResourceColumnReorderListenersTypes = {
|
|
32259
33063
|
/**
|
|
32260
33064
|
* Fires before an object is destroyed.
|
|
32261
33065
|
* @param {object} event Event object
|
|
@@ -32265,7 +33069,7 @@ type PanListenersTypes = {
|
|
|
32265
33069
|
/**
|
|
32266
33070
|
* Fires when any other event is fired from the object.
|
|
32267
33071
|
* ...
|
|
32268
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
33072
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ResourceColumnReorder#event-catchAll)
|
|
32269
33073
|
* @param {object} event Event object
|
|
32270
33074
|
* @param {{[key: string]: any, type: string}} event.event The Object that contains event details
|
|
32271
33075
|
* @param {string} event.event.type The type of the event which is caught by the listener
|
|
@@ -32292,9 +33096,9 @@ type PanListenersTypes = {
|
|
|
32292
33096
|
}
|
|
32293
33097
|
|
|
32294
33098
|
/**
|
|
32295
|
-
* Type with listeners options for [
|
|
33099
|
+
* Type with listeners options for [ResourceColumnReorder](https://bryntum.com/products/grid/docs/api/Scheduler/feature/ResourceColumnReorder) class.
|
|
32296
33100
|
*/
|
|
32297
|
-
type
|
|
33101
|
+
type ResourceColumnReorderListeners = {
|
|
32298
33102
|
/**
|
|
32299
33103
|
* The `this` object for listener methods
|
|
32300
33104
|
*/
|
|
@@ -32308,7 +33112,7 @@ type PanListeners = {
|
|
|
32308
33112
|
/**
|
|
32309
33113
|
* Fires when any other event is fired from the object.
|
|
32310
33114
|
* ...
|
|
32311
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
33115
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ResourceColumnReorder#event-catchAll)
|
|
32312
33116
|
* @param {object} event Event object
|
|
32313
33117
|
* @param {{[key: string]: any, type: string}} event.event The Object that contains event details
|
|
32314
33118
|
* @param {string} event.event.type The type of the event which is caught by the listener
|
|
@@ -32335,28 +33139,28 @@ type PanListeners = {
|
|
|
32335
33139
|
}
|
|
32336
33140
|
|
|
32337
33141
|
/**
|
|
32338
|
-
* Type with configuration options for [
|
|
33142
|
+
* Type with configuration options for [ResourceColumnReorder](https://bryntum.com/products/grid/docs/api/Scheduler/feature/ResourceColumnReorder) class.
|
|
32339
33143
|
*/
|
|
32340
|
-
type
|
|
32341
|
-
type?: '
|
|
33144
|
+
type ResourceColumnReorderConfig = {
|
|
33145
|
+
type?: 'resourceColumnReorder'|'resourcecolumnreorder'
|
|
32342
33146
|
/**
|
|
32343
33147
|
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
32344
33148
|
* hierarchy when triggered.
|
|
32345
33149
|
* ...
|
|
32346
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
33150
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ResourceColumnReorder#config-bubbleEvents)
|
|
32347
33151
|
*/
|
|
32348
33152
|
bubbleEvents?: object
|
|
32349
33153
|
/**
|
|
32350
33154
|
* Set to `true` to call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
|
|
32351
33155
|
* ...
|
|
32352
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
33156
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ResourceColumnReorder#config-callOnFunctions)
|
|
32353
33157
|
*/
|
|
32354
33158
|
callOnFunctions?: boolean
|
|
32355
33159
|
/**
|
|
32356
33160
|
* By default, if an event handler throws an exception, the error propagates up the stack and the
|
|
32357
33161
|
* application state is undefined. Code which follows the event handler will *not* be executed.
|
|
32358
33162
|
* ...
|
|
32359
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
33163
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ResourceColumnReorder#config-catchEventHandlerExceptions)
|
|
32360
33164
|
*/
|
|
32361
33165
|
catchEventHandlerExceptions?: boolean
|
|
32362
33166
|
/**
|
|
@@ -32366,29 +33170,21 @@ type PanConfig = {
|
|
|
32366
33170
|
/**
|
|
32367
33171
|
* The plugin/feature `disabled` state.
|
|
32368
33172
|
* ...
|
|
32369
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
33173
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ResourceColumnReorder#config-disabled)
|
|
32370
33174
|
*/
|
|
32371
33175
|
disabled?: boolean|'inert'
|
|
32372
|
-
/**
|
|
32373
|
-
* Set to `false` to not pan horizontally when dragging in the time axis header
|
|
32374
|
-
*/
|
|
32375
|
-
enableInHeader?: boolean
|
|
32376
|
-
/**
|
|
32377
|
-
* Set to `false` to not pan horizontally
|
|
32378
|
-
*/
|
|
32379
|
-
horizontal?: boolean
|
|
32380
33176
|
/**
|
|
32381
33177
|
* The listener set for this object.
|
|
32382
33178
|
* ...
|
|
32383
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
33179
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ResourceColumnReorder#config-listeners)
|
|
32384
33180
|
*/
|
|
32385
|
-
listeners?:
|
|
33181
|
+
listeners?: ResourceColumnReorderListeners
|
|
32386
33182
|
/**
|
|
32387
33183
|
* A class translations of which are used for translating this entity.
|
|
32388
33184
|
* This is often used when translations of an item are defined on its container class.
|
|
32389
33185
|
* For example:
|
|
32390
33186
|
* ...
|
|
32391
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
33187
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ResourceColumnReorder#config-localeClass)
|
|
32392
33188
|
*/
|
|
32393
33189
|
localeClass?: typeof Base
|
|
32394
33190
|
/**
|
|
@@ -32401,13 +33197,9 @@ type PanConfig = {
|
|
|
32401
33197
|
* you could use 'localeKey' meta configuration.
|
|
32402
33198
|
* Example:
|
|
32403
33199
|
* ...
|
|
32404
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
33200
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ResourceColumnReorder#config-localizableProperties)
|
|
32405
33201
|
*/
|
|
32406
33202
|
localizableProperties?: string[]
|
|
32407
|
-
/**
|
|
32408
|
-
* Set to `false` to not pan vertically
|
|
32409
|
-
*/
|
|
32410
|
-
vertical?: boolean
|
|
32411
33203
|
/**
|
|
32412
33204
|
* Fires before an object is destroyed.
|
|
32413
33205
|
* @param {object} event Event object
|
|
@@ -32417,7 +33209,7 @@ type PanConfig = {
|
|
|
32417
33209
|
/**
|
|
32418
33210
|
* Fires when any other event is fired from the object.
|
|
32419
33211
|
* ...
|
|
32420
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
33212
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ResourceColumnReorder#event-catchAll)
|
|
32421
33213
|
* @param {object} event Event object
|
|
32422
33214
|
* @param {{[key: string]: any, type: string}} event.event The Object that contains event details
|
|
32423
33215
|
* @param {string} event.event.type The type of the event which is caught by the listener
|
|
@@ -32444,35 +33236,21 @@ type PanConfig = {
|
|
|
32444
33236
|
}
|
|
32445
33237
|
|
|
32446
33238
|
/**
|
|
32447
|
-
*
|
|
33239
|
+
* Allows user to reorder resource columns in vertical mode by dragging them. The feature fires various events
|
|
33240
|
+
* during the drag operation (see events below). To get notified about the actual resource reorder, you can also
|
|
33241
|
+
* listen to the `change` event on the scheduler [ResourceStore](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/ResourceStore).
|
|
32448
33242
|
* ...
|
|
32449
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
33243
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ResourceColumnReorder)
|
|
32450
33244
|
*/
|
|
32451
|
-
export class
|
|
32452
|
-
/**
|
|
32453
|
-
* Identifies an object as an instance of [Pan](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Pan) class, or subclass thereof.
|
|
32454
|
-
*/
|
|
32455
|
-
static readonly isPan: boolean
|
|
32456
|
-
/**
|
|
32457
|
-
* Set to `false` to not pan horizontally when dragging in the time axis header
|
|
32458
|
-
*/
|
|
32459
|
-
enableInHeader: boolean
|
|
32460
|
-
/**
|
|
32461
|
-
* Set to `false` to not pan horizontally
|
|
32462
|
-
*/
|
|
32463
|
-
horizontal: boolean
|
|
32464
|
-
/**
|
|
32465
|
-
* Yields `true` if a pan gesture is in process.
|
|
32466
|
-
*/
|
|
32467
|
-
readonly isActive: boolean
|
|
33245
|
+
export class ResourceColumnReorder extends InstancePlugin {
|
|
32468
33246
|
/**
|
|
32469
|
-
* Identifies an object as an instance of [
|
|
33247
|
+
* Identifies an object as an instance of [ResourceColumnReorder](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ResourceColumnReorder) class, or subclass thereof.
|
|
32470
33248
|
*/
|
|
32471
|
-
readonly
|
|
33249
|
+
static readonly isResourceColumnReorder: boolean
|
|
32472
33250
|
/**
|
|
32473
|
-
*
|
|
33251
|
+
* Identifies an object as an instance of [ResourceColumnReorder](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ResourceColumnReorder) class, or subclass thereof.
|
|
32474
33252
|
*/
|
|
32475
|
-
|
|
33253
|
+
readonly isResourceColumnReorder: boolean
|
|
32476
33254
|
/**
|
|
32477
33255
|
* Fires before an object is destroyed.
|
|
32478
33256
|
* @param {object} event Event object
|
|
@@ -32482,7 +33260,7 @@ export class Pan extends InstancePlugin {
|
|
|
32482
33260
|
/**
|
|
32483
33261
|
* Fires when any other event is fired from the object.
|
|
32484
33262
|
* ...
|
|
32485
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/
|
|
33263
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ResourceColumnReorder#event-catchAll)
|
|
32486
33264
|
* @param {object} event Event object
|
|
32487
33265
|
* @param {{[key: string]: any, type: string}} event.event The Object that contains event details
|
|
32488
33266
|
* @param {string} event.event.type The type of the event which is caught by the listener
|
|
@@ -32496,9 +33274,9 @@ export class Pan extends InstancePlugin {
|
|
|
32496
33274
|
onDestroy: ((event: { source: Base }) => void)|string
|
|
32497
33275
|
/**
|
|
32498
33276
|
* Creates an instance of the class using the supplied configuration
|
|
32499
|
-
* @param {
|
|
33277
|
+
* @param {ResourceColumnReorderConfig} config
|
|
32500
33278
|
*/
|
|
32501
|
-
constructor(config?:
|
|
33279
|
+
constructor(config?: ResourceColumnReorderConfig);
|
|
32502
33280
|
}
|
|
32503
33281
|
|
|
32504
33282
|
/**
|
|
@@ -35074,10 +35852,10 @@ export class SimpleEventEdit extends InstancePlugin {
|
|
|
35074
35852
|
/**
|
|
35075
35853
|
* Opens an Editor for the passed event. This function is exposed on Scheduler and can be called as
|
|
35076
35854
|
* `scheduler.editEvent()`.
|
|
35077
|
-
* @param {Scheduler.model.EventModel} eventRecord
|
|
35855
|
+
* @param {Scheduler.model.EventModel,string,number} eventRecord Event to edit or the id of the eventRecord. When a String or Number is passed, it must be the id of an event that exists in the Scheduler's event store.
|
|
35078
35856
|
* @param {Scheduler.model.ResourceModel} resourceRecord The Resource record for the event.
|
|
35079
35857
|
*/
|
|
35080
|
-
editEvent(eventRecord: EventModel, resourceRecord?: ResourceModel): Promise<void>;
|
|
35858
|
+
editEvent(eventRecord: EventModel|string|number, resourceRecord?: ResourceModel): Promise<void>;
|
|
35081
35859
|
}
|
|
35082
35860
|
|
|
35083
35861
|
/**
|
|
@@ -38741,6 +39519,10 @@ type TooltipBaseConfig = {
|
|
|
38741
39519
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/base/TooltipBase#config-bodyCls)
|
|
38742
39520
|
*/
|
|
38743
39521
|
bodyCls?: string|object
|
|
39522
|
+
/**
|
|
39523
|
+
* Set `true` to add a border to this container's element.
|
|
39524
|
+
*/
|
|
39525
|
+
border?: boolean
|
|
38744
39526
|
/**
|
|
38745
39527
|
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
38746
39528
|
* hierarchy when triggered.
|
|
@@ -38813,7 +39595,7 @@ type TooltipBaseConfig = {
|
|
|
38813
39595
|
* ...
|
|
38814
39596
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/base/TooltipBase#config-color)
|
|
38815
39597
|
*/
|
|
38816
|
-
color?:
|
|
39598
|
+
color?: Color
|
|
38817
39599
|
/**
|
|
38818
39600
|
* Programmatic control over which column to start in when used in a grid layout.
|
|
38819
39601
|
*/
|
|
@@ -42975,6 +43757,10 @@ export class DependencyBaseModel extends Model {
|
|
|
42975
43757
|
* Dependency type, see static property [Type](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/DependencyBaseModel#property-Type-static)
|
|
42976
43758
|
*/
|
|
42977
43759
|
type: number
|
|
43760
|
+
/**
|
|
43761
|
+
* Returns the default dependency type value from the model's field definition.
|
|
43762
|
+
*/
|
|
43763
|
+
static getDefaultType(): number;
|
|
42978
43764
|
/**
|
|
42979
43765
|
* Returns dependency hard type, see [hardType](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/DependencyBaseModel#property-hardType).
|
|
42980
43766
|
*/
|
|
@@ -43894,6 +44680,12 @@ type ProjectModelConfig = {
|
|
|
43894
44680
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/ProjectModel)
|
|
43895
44681
|
*/
|
|
43896
44682
|
export class ProjectModel extends Model {
|
|
44683
|
+
/**
|
|
44684
|
+
* Class name getter.
|
|
44685
|
+
* Used when original ES6 class name is minified or mangled during production build.
|
|
44686
|
+
* Should be overridden in each class which extends Model or it descendants.
|
|
44687
|
+
*/
|
|
44688
|
+
static $name: string
|
|
43897
44689
|
/**
|
|
43898
44690
|
* An array containing all the *defined* fields for this Model class. This will include all superclass's
|
|
43899
44691
|
* defined fields.
|
|
@@ -44003,6 +44795,11 @@ export class ProjectModel extends Model {
|
|
|
44003
44795
|
* tasks.
|
|
44004
44796
|
*/
|
|
44005
44797
|
readonly children: boolean|object[]|Model[]
|
|
44798
|
+
/**
|
|
44799
|
+
* Returns the string value for display purposes of an instance of this Model class. Needs to be overridden in
|
|
44800
|
+
* subclasses.
|
|
44801
|
+
*/
|
|
44802
|
+
readonly classDisplayName: string
|
|
44006
44803
|
/**
|
|
44007
44804
|
* Returns a *copy* of the full configuration which was used to configure this object.
|
|
44008
44805
|
*/
|
|
@@ -45141,7 +45938,7 @@ export class ResourceModel extends GridRowModel {
|
|
|
45141
45938
|
*/
|
|
45142
45939
|
resourceMargin: number|ResourceMarginConfig
|
|
45143
45940
|
/**
|
|
45144
|
-
*
|
|
45941
|
+
* The base height of this resource, in px. When unset, Schedulers configured rowHeight is used.
|
|
45145
45942
|
*/
|
|
45146
45943
|
rowHeight: number
|
|
45147
45944
|
/**
|
|
@@ -46814,7 +47611,7 @@ type ResourceModelMixinClassConfig = {
|
|
|
46814
47611
|
*/
|
|
46815
47612
|
resourceMargin?: number|ResourceMarginConfig
|
|
46816
47613
|
/**
|
|
46817
|
-
*
|
|
47614
|
+
* The base height of this resource, in px. When unset, Schedulers configured rowHeight is used.
|
|
46818
47615
|
* ...
|
|
46819
47616
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/mixin/ResourceModelMixin#config-rowHeight)
|
|
46820
47617
|
*/
|
|
@@ -46907,7 +47704,7 @@ export class ResourceModelMixinClass {
|
|
|
46907
47704
|
*/
|
|
46908
47705
|
resourceMargin: number|ResourceMarginConfig
|
|
46909
47706
|
/**
|
|
46910
|
-
*
|
|
47707
|
+
* The base height of this resource, in px. When unset, Schedulers configured rowHeight is used.
|
|
46911
47708
|
*/
|
|
46912
47709
|
rowHeight: number
|
|
46913
47710
|
/**
|
|
@@ -50120,6 +50917,10 @@ type EventEditorConfig = {
|
|
|
50120
50917
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/EventEditor#config-bodyCls)
|
|
50121
50918
|
*/
|
|
50122
50919
|
bodyCls?: string|object
|
|
50920
|
+
/**
|
|
50921
|
+
* Set `true` to add a border to this container's element.
|
|
50922
|
+
*/
|
|
50923
|
+
border?: boolean
|
|
50123
50924
|
/**
|
|
50124
50925
|
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
50125
50926
|
* hierarchy when triggered.
|
|
@@ -50188,7 +50989,7 @@ type EventEditorConfig = {
|
|
|
50188
50989
|
* ...
|
|
50189
50990
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/EventEditor#config-color)
|
|
50190
50991
|
*/
|
|
50191
|
-
color?:
|
|
50992
|
+
color?: Color
|
|
50192
50993
|
/**
|
|
50193
50994
|
* Programmatic control over which column to start in when used in a grid layout.
|
|
50194
50995
|
*/
|
|
@@ -51339,7 +52140,7 @@ type ResourceHeaderConfig = {
|
|
|
51339
52140
|
* ...
|
|
51340
52141
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/ResourceHeader#config-color)
|
|
51341
52142
|
*/
|
|
51342
|
-
color?:
|
|
52143
|
+
color?: Color
|
|
51343
52144
|
/**
|
|
51344
52145
|
* Programmatic control over which column to start in when used in a grid layout.
|
|
51345
52146
|
*/
|
|
@@ -53692,6 +54493,70 @@ type SchedulerListenersTypes = {
|
|
|
53692
54493
|
* @param {number} event.oldHeight The old height
|
|
53693
54494
|
*/
|
|
53694
54495
|
resize: (event: { source: Widget, width: number, height: number, oldWidth: number, oldHeight: number }) => void
|
|
54496
|
+
/**
|
|
54497
|
+
* Fired before dragging starts, return `false` to prevent the drag operation.
|
|
54498
|
+
* @param {object} event Event object
|
|
54499
|
+
* @param {Scheduler.view.Scheduler} event.source
|
|
54500
|
+
* @param {object} event.context
|
|
54501
|
+
* @param {Scheduler.model.ResourceModel} event.context.resource The dragged resource
|
|
54502
|
+
* @param {MouseEvent,TouchEvent} event.event
|
|
54503
|
+
*/
|
|
54504
|
+
resourceColumnBeforeDragStart: (event: { source: Scheduler, context: { resource: ResourceModel }, event: MouseEvent|TouchEvent }) => Promise<boolean>|boolean|void
|
|
54505
|
+
/**
|
|
54506
|
+
* Fired before the drop is finalized. You can return `false` or a Promise that resolves to `false`
|
|
54507
|
+
* to cancel the drop operation.
|
|
54508
|
+
* @param {object} event Event object
|
|
54509
|
+
* @param {Scheduler.view.Scheduler} event.source
|
|
54510
|
+
* @param {object} event.context
|
|
54511
|
+
* @param {Scheduler.model.ResourceModel} event.context.resource The dragged resource
|
|
54512
|
+
* @param {Scheduler.model.ResourceModel} event.context.insertBefore The resource to insert before
|
|
54513
|
+
* @param {Core.data.Model} event.context.targetGroup When the resourceStore is grouped, the group header record of the target group
|
|
54514
|
+
* @param {MouseEvent} event.event
|
|
54515
|
+
*/
|
|
54516
|
+
resourceColumnBeforeDropFinalize: (event: { source: Scheduler, context: { resource: ResourceModel, insertBefore: ResourceModel, targetGroup: Model }, event: MouseEvent }) => Promise<boolean>|boolean|void
|
|
54517
|
+
/**
|
|
54518
|
+
* Fired while the resource column is being dragged. You can signal that the drop position is
|
|
54519
|
+
* valid or invalid by setting `context.valid = false;`
|
|
54520
|
+
* @param {object} event Event object
|
|
54521
|
+
* @param {Scheduler.view.Scheduler} event.source
|
|
54522
|
+
* @param {object} event.context
|
|
54523
|
+
* @param {boolean} event.context.valid Set this to `true` or `false` to indicate whether the drop position is valid
|
|
54524
|
+
* @param {Scheduler.model.ResourceModel} event.context.insertBefore The resource to insert before (`null` if inserting at last position)
|
|
54525
|
+
* @param {Scheduler.model.ResourceModel} event.context.resource The dragged resource
|
|
54526
|
+
* @param {Core.data.Model} event.context.targetGroup When the resourceStore is grouped, the group header record of the target group
|
|
54527
|
+
* @param {MouseEvent} event.event
|
|
54528
|
+
*/
|
|
54529
|
+
resourceColumnDrag: (event: { source: Scheduler, context: { valid: boolean, insertBefore: ResourceModel, resource: ResourceModel, targetGroup: Model }, event: MouseEvent }) => void
|
|
54530
|
+
/**
|
|
54531
|
+
* Fired when drag is aborted
|
|
54532
|
+
* @param {object} event Event object
|
|
54533
|
+
* @param {Scheduler.view.Scheduler} event.source
|
|
54534
|
+
* @param {object} event.context
|
|
54535
|
+
* @param {Scheduler.model.ResourceModel} event.context.resource The dragged resource
|
|
54536
|
+
* @param {MouseEvent} event.event
|
|
54537
|
+
*/
|
|
54538
|
+
resourceColumnDragAbort: (event: { source: Scheduler, context: { resource: ResourceModel }, event: MouseEvent }) => void
|
|
54539
|
+
/**
|
|
54540
|
+
* Fired when dragging starts.
|
|
54541
|
+
* @param {object} event Event object
|
|
54542
|
+
* @param {Scheduler.view.Scheduler} event.source
|
|
54543
|
+
* @param {object} event.context
|
|
54544
|
+
* @param {Scheduler.model.ResourceModel} event.context.resource The dragged resource
|
|
54545
|
+
* @param {MouseEvent,TouchEvent} event.event
|
|
54546
|
+
*/
|
|
54547
|
+
resourceColumnDragStart: (event: { source: Scheduler, context: { resource: ResourceModel }, event: MouseEvent|TouchEvent }) => void
|
|
54548
|
+
/**
|
|
54549
|
+
* Fired after drop
|
|
54550
|
+
* @param {object} event Event object
|
|
54551
|
+
* @param {Scheduler.view.Scheduler} event.source
|
|
54552
|
+
* @param {object} event.context
|
|
54553
|
+
* @param {Scheduler.model.ResourceModel} event.context.resource The dragged resource
|
|
54554
|
+
* @param {Scheduler.model.ResourceModel} event.context.insertBefore The resource that was inserted before
|
|
54555
|
+
* @param {Core.data.Model} event.context.targetGroup When the resourceStore is grouped, the group header record of the target group. The resource's group field has been updated if moved between groups.
|
|
54556
|
+
* @param {boolean} event.context.valid `true` if the drop was valid, `false` otherwise
|
|
54557
|
+
* @param {MouseEvent} event.event
|
|
54558
|
+
*/
|
|
54559
|
+
resourceColumnDrop: (event: { source: Scheduler, context: { resource: ResourceModel, insertBefore: ResourceModel, targetGroup: Model, valid: boolean }, event: MouseEvent }) => void
|
|
53695
54560
|
/**
|
|
53696
54561
|
* Fired when clicking a resource header cell
|
|
53697
54562
|
* @param {object} event Event object
|
|
@@ -56165,6 +57030,70 @@ type SchedulerListeners = {
|
|
|
56165
57030
|
* @param {number} event.oldHeight The old height
|
|
56166
57031
|
*/
|
|
56167
57032
|
resize?: ((event: { source: Widget, width: number, height: number, oldWidth: number, oldHeight: number }) => void)|string
|
|
57033
|
+
/**
|
|
57034
|
+
* Fired before dragging starts, return `false` to prevent the drag operation.
|
|
57035
|
+
* @param {object} event Event object
|
|
57036
|
+
* @param {Scheduler.view.Scheduler} event.source
|
|
57037
|
+
* @param {object} event.context
|
|
57038
|
+
* @param {Scheduler.model.ResourceModel} event.context.resource The dragged resource
|
|
57039
|
+
* @param {MouseEvent,TouchEvent} event.event
|
|
57040
|
+
*/
|
|
57041
|
+
resourceColumnBeforeDragStart?: ((event: { source: Scheduler, context: { resource: ResourceModel }, event: MouseEvent|TouchEvent }) => Promise<boolean>|boolean|void)|string
|
|
57042
|
+
/**
|
|
57043
|
+
* Fired before the drop is finalized. You can return `false` or a Promise that resolves to `false`
|
|
57044
|
+
* to cancel the drop operation.
|
|
57045
|
+
* @param {object} event Event object
|
|
57046
|
+
* @param {Scheduler.view.Scheduler} event.source
|
|
57047
|
+
* @param {object} event.context
|
|
57048
|
+
* @param {Scheduler.model.ResourceModel} event.context.resource The dragged resource
|
|
57049
|
+
* @param {Scheduler.model.ResourceModel} event.context.insertBefore The resource to insert before
|
|
57050
|
+
* @param {Core.data.Model} event.context.targetGroup When the resourceStore is grouped, the group header record of the target group
|
|
57051
|
+
* @param {MouseEvent} event.event
|
|
57052
|
+
*/
|
|
57053
|
+
resourceColumnBeforeDropFinalize?: ((event: { source: Scheduler, context: { resource: ResourceModel, insertBefore: ResourceModel, targetGroup: Model }, event: MouseEvent }) => Promise<boolean>|boolean|void)|string
|
|
57054
|
+
/**
|
|
57055
|
+
* Fired while the resource column is being dragged. You can signal that the drop position is
|
|
57056
|
+
* valid or invalid by setting `context.valid = false;`
|
|
57057
|
+
* @param {object} event Event object
|
|
57058
|
+
* @param {Scheduler.view.Scheduler} event.source
|
|
57059
|
+
* @param {object} event.context
|
|
57060
|
+
* @param {boolean} event.context.valid Set this to `true` or `false` to indicate whether the drop position is valid
|
|
57061
|
+
* @param {Scheduler.model.ResourceModel} event.context.insertBefore The resource to insert before (`null` if inserting at last position)
|
|
57062
|
+
* @param {Scheduler.model.ResourceModel} event.context.resource The dragged resource
|
|
57063
|
+
* @param {Core.data.Model} event.context.targetGroup When the resourceStore is grouped, the group header record of the target group
|
|
57064
|
+
* @param {MouseEvent} event.event
|
|
57065
|
+
*/
|
|
57066
|
+
resourceColumnDrag?: ((event: { source: Scheduler, context: { valid: boolean, insertBefore: ResourceModel, resource: ResourceModel, targetGroup: Model }, event: MouseEvent }) => void)|string
|
|
57067
|
+
/**
|
|
57068
|
+
* Fired when drag is aborted
|
|
57069
|
+
* @param {object} event Event object
|
|
57070
|
+
* @param {Scheduler.view.Scheduler} event.source
|
|
57071
|
+
* @param {object} event.context
|
|
57072
|
+
* @param {Scheduler.model.ResourceModel} event.context.resource The dragged resource
|
|
57073
|
+
* @param {MouseEvent} event.event
|
|
57074
|
+
*/
|
|
57075
|
+
resourceColumnDragAbort?: ((event: { source: Scheduler, context: { resource: ResourceModel }, event: MouseEvent }) => void)|string
|
|
57076
|
+
/**
|
|
57077
|
+
* Fired when dragging starts.
|
|
57078
|
+
* @param {object} event Event object
|
|
57079
|
+
* @param {Scheduler.view.Scheduler} event.source
|
|
57080
|
+
* @param {object} event.context
|
|
57081
|
+
* @param {Scheduler.model.ResourceModel} event.context.resource The dragged resource
|
|
57082
|
+
* @param {MouseEvent,TouchEvent} event.event
|
|
57083
|
+
*/
|
|
57084
|
+
resourceColumnDragStart?: ((event: { source: Scheduler, context: { resource: ResourceModel }, event: MouseEvent|TouchEvent }) => void)|string
|
|
57085
|
+
/**
|
|
57086
|
+
* Fired after drop
|
|
57087
|
+
* @param {object} event Event object
|
|
57088
|
+
* @param {Scheduler.view.Scheduler} event.source
|
|
57089
|
+
* @param {object} event.context
|
|
57090
|
+
* @param {Scheduler.model.ResourceModel} event.context.resource The dragged resource
|
|
57091
|
+
* @param {Scheduler.model.ResourceModel} event.context.insertBefore The resource that was inserted before
|
|
57092
|
+
* @param {Core.data.Model} event.context.targetGroup When the resourceStore is grouped, the group header record of the target group. The resource's group field has been updated if moved between groups.
|
|
57093
|
+
* @param {boolean} event.context.valid `true` if the drop was valid, `false` otherwise
|
|
57094
|
+
* @param {MouseEvent} event.event
|
|
57095
|
+
*/
|
|
57096
|
+
resourceColumnDrop?: ((event: { source: Scheduler, context: { resource: ResourceModel, insertBefore: ResourceModel, targetGroup: Model, valid: boolean }, event: MouseEvent }) => void)|string
|
|
56168
57097
|
/**
|
|
56169
57098
|
* Fired when clicking a resource header cell
|
|
56170
57099
|
* @param {object} event Event object
|
|
@@ -56860,6 +57789,7 @@ type SchedulerListeners = {
|
|
|
56860
57789
|
}
|
|
56861
57790
|
|
|
56862
57791
|
type SchedulerFeaturesType = {
|
|
57792
|
+
ai: AI
|
|
56863
57793
|
aiFilter: AIFilter
|
|
56864
57794
|
cellCopyPaste: CellCopyPaste
|
|
56865
57795
|
cellEdit: CellEdit
|
|
@@ -56905,6 +57835,7 @@ type SchedulerFeaturesType = {
|
|
|
56905
57835
|
print: Print
|
|
56906
57836
|
quickFind: QuickFind
|
|
56907
57837
|
regionResize: RegionResize
|
|
57838
|
+
resourceColumnReorder: ResourceColumnReorder
|
|
56908
57839
|
resourceMenu: ResourceMenu
|
|
56909
57840
|
resourceTimeRanges: ResourceTimeRanges
|
|
56910
57841
|
rowCopyPaste: RowCopyPaste
|
|
@@ -56933,6 +57864,7 @@ type SchedulerFeaturesType = {
|
|
|
56933
57864
|
}
|
|
56934
57865
|
|
|
56935
57866
|
type SchedulerFeaturesConfigType = {
|
|
57867
|
+
ai?: string|boolean|AIConfig
|
|
56936
57868
|
aiFilter?: string|boolean|AIFilterConfig
|
|
56937
57869
|
cellCopyPaste?: string|boolean|CellCopyPasteConfig
|
|
56938
57870
|
cellEdit?: string|boolean|CellEditConfig
|
|
@@ -56978,6 +57910,7 @@ type SchedulerFeaturesConfigType = {
|
|
|
56978
57910
|
print?: string|boolean|PrintConfig
|
|
56979
57911
|
quickFind?: string|boolean|QuickFindConfig
|
|
56980
57912
|
regionResize?: string|boolean|RegionResizeConfig
|
|
57913
|
+
resourceColumnReorder?: string|boolean|ResourceColumnReorderConfig
|
|
56981
57914
|
resourceMenu?: string|boolean|ResourceMenuConfig
|
|
56982
57915
|
resourceTimeRanges?: string|boolean|ResourceTimeRangesConfig
|
|
56983
57916
|
rowCopyPaste?: string|boolean|RowCopyPasteConfig
|
|
@@ -57134,6 +58067,10 @@ type SchedulerConfig = {
|
|
|
57134
58067
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-bodyCls)
|
|
57135
58068
|
*/
|
|
57136
58069
|
bodyCls?: string|object
|
|
58070
|
+
/**
|
|
58071
|
+
* Set `true` to add a border to this container's element.
|
|
58072
|
+
*/
|
|
58073
|
+
border?: boolean
|
|
57137
58074
|
/**
|
|
57138
58075
|
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
57139
58076
|
* hierarchy when triggered.
|
|
@@ -57199,7 +58136,7 @@ type SchedulerConfig = {
|
|
|
57199
58136
|
* ...
|
|
57200
58137
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-color)
|
|
57201
58138
|
*/
|
|
57202
|
-
color?:
|
|
58139
|
+
color?: Color
|
|
57203
58140
|
/**
|
|
57204
58141
|
* Programmatic control over which column to start in when used in a grid layout.
|
|
57205
58142
|
*/
|
|
@@ -57516,8 +58453,8 @@ type SchedulerConfig = {
|
|
|
57516
58453
|
* @param {'tonal','filled','bordered','traced','outlined','indented','line','dashed','minimal','rounded','calendar','interday','gantt',null} detail.renderData.eventStyle The `eventStyle` of the event. Use this to apply custom styles to the event DOM element
|
|
57517
58454
|
* @param {string} detail.renderData.eventColor The `eventColor` of the event. Use this to set a custom color for the rendered event
|
|
57518
58455
|
* @param {string} detail.renderData.ariaLabel A description of the event details used for screen readers
|
|
57519
|
-
* @param {DomConfig[]} detail.renderData.children An array of DOM configs used as children to the `b-sch-event` element. Can be populated with additional DOM configs to have more control over contents.
|
|
57520
|
-
* @returns {string,DomConfig,DomConfig[]} A simple string,
|
|
58456
|
+
* @param {DomConfig[]} detail.renderData.children An array of DOM configs used as children to the `b-sch-event` element. Can be populated with additional DOM configs to have more control over contents. <h3>Using JSX (React)</h3> When using the Bryntum React wrapper, the event renderer can return JSX elements: ```javascript eventRenderer({ eventRecord, resourceRecord, renderData }) { return <MyEventComponent event={eventRecord} resource={resourceRecord} />; } ``` *Using JSX in the event renderer creates a React portal for each rendered event. For schedulers with many visible events or frequently re-rendered views, this may impact scrolling performance compared to returning plain strings or [DomConfig](https://bryntum.com/products/scheduler/docs/api/Core/helper/DomHelper#typedef-DomConfig) objects. Consider using JSX primarily for events that require complex interactive React components.*
|
|
58457
|
+
* @returns {string,DomConfig,DomConfig[]} A simple string, a DomConfig (or array thereof), or a JSX element when using React
|
|
57521
58458
|
*/
|
|
57522
58459
|
eventRenderer?: (detail: { eventRecord: EventModel, resourceRecord: ResourceModel, assignmentRecord: AssignmentModel, scheduler: Scheduler, renderData: { event: EventModel, cls: DomClassList|string, wrapperCls: DomClassList|string, iconCls: DomClassList|string, left: number, width: number, height: number, style: string|Record<string, string>, wrapperStyle: string|Record<string, string>, eventStyle: 'tonal'|'filled'|'bordered'|'traced'|'outlined'|'indented'|'line'|'dashed'|'minimal'|'rounded'|'calendar'|'interday'|'gantt'|null, eventColor: string, ariaLabel: string, children: DomConfig[] } }) => string|DomConfig|DomConfig[]
|
|
57523
58460
|
/**
|
|
@@ -57700,6 +58637,10 @@ type SchedulerConfig = {
|
|
|
57700
58637
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-infiniteScroll)
|
|
57701
58638
|
*/
|
|
57702
58639
|
infiniteScroll?: boolean
|
|
58640
|
+
/**
|
|
58641
|
+
* Set to true for child nodes in a tree store to inherit their parent´s `eventColor`
|
|
58642
|
+
*/
|
|
58643
|
+
inheritEventColor?: boolean
|
|
57703
58644
|
/**
|
|
57704
58645
|
* Maximum duration (in milliseconds) for the initial animation controlled by [useInitialAnimation](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/SchedulerEventRendering#config-useInitialAnimation).
|
|
57705
58646
|
*/
|
|
@@ -57945,7 +58886,7 @@ type SchedulerConfig = {
|
|
|
57945
58886
|
* ...
|
|
57946
58887
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-partner)
|
|
57947
58888
|
*/
|
|
57948
|
-
partner?: TimelineBase
|
|
58889
|
+
partner?: TimelineBase|string
|
|
57949
58890
|
/**
|
|
57950
58891
|
* Set to `true` to include `startDate` and `endDate` params indicating the currently viewed date range in
|
|
57951
58892
|
* `EventStore` load requests (when loading using `AjaxStore` or `CrudManager` functionality).
|
|
@@ -60351,6 +61292,70 @@ type SchedulerConfig = {
|
|
|
60351
61292
|
* @param {number} event.oldHeight The old height
|
|
60352
61293
|
*/
|
|
60353
61294
|
onResize?: ((event: { source: Widget, width: number, height: number, oldWidth: number, oldHeight: number }) => void)|string
|
|
61295
|
+
/**
|
|
61296
|
+
* Fired before dragging starts, return `false` to prevent the drag operation.
|
|
61297
|
+
* @param {object} event Event object
|
|
61298
|
+
* @param {Scheduler.view.Scheduler} event.source
|
|
61299
|
+
* @param {object} event.context
|
|
61300
|
+
* @param {Scheduler.model.ResourceModel} event.context.resource The dragged resource
|
|
61301
|
+
* @param {MouseEvent,TouchEvent} event.event
|
|
61302
|
+
*/
|
|
61303
|
+
onResourceColumnBeforeDragStart?: ((event: { source: Scheduler, context: { resource: ResourceModel }, event: MouseEvent|TouchEvent }) => Promise<boolean>|boolean|void)|string
|
|
61304
|
+
/**
|
|
61305
|
+
* Fired before the drop is finalized. You can return `false` or a Promise that resolves to `false`
|
|
61306
|
+
* to cancel the drop operation.
|
|
61307
|
+
* @param {object} event Event object
|
|
61308
|
+
* @param {Scheduler.view.Scheduler} event.source
|
|
61309
|
+
* @param {object} event.context
|
|
61310
|
+
* @param {Scheduler.model.ResourceModel} event.context.resource The dragged resource
|
|
61311
|
+
* @param {Scheduler.model.ResourceModel} event.context.insertBefore The resource to insert before
|
|
61312
|
+
* @param {Core.data.Model} event.context.targetGroup When the resourceStore is grouped, the group header record of the target group
|
|
61313
|
+
* @param {MouseEvent} event.event
|
|
61314
|
+
*/
|
|
61315
|
+
onResourceColumnBeforeDropFinalize?: ((event: { source: Scheduler, context: { resource: ResourceModel, insertBefore: ResourceModel, targetGroup: Model }, event: MouseEvent }) => Promise<boolean>|boolean|void)|string
|
|
61316
|
+
/**
|
|
61317
|
+
* Fired while the resource column is being dragged. You can signal that the drop position is
|
|
61318
|
+
* valid or invalid by setting `context.valid = false;`
|
|
61319
|
+
* @param {object} event Event object
|
|
61320
|
+
* @param {Scheduler.view.Scheduler} event.source
|
|
61321
|
+
* @param {object} event.context
|
|
61322
|
+
* @param {boolean} event.context.valid Set this to `true` or `false` to indicate whether the drop position is valid
|
|
61323
|
+
* @param {Scheduler.model.ResourceModel} event.context.insertBefore The resource to insert before (`null` if inserting at last position)
|
|
61324
|
+
* @param {Scheduler.model.ResourceModel} event.context.resource The dragged resource
|
|
61325
|
+
* @param {Core.data.Model} event.context.targetGroup When the resourceStore is grouped, the group header record of the target group
|
|
61326
|
+
* @param {MouseEvent} event.event
|
|
61327
|
+
*/
|
|
61328
|
+
onResourceColumnDrag?: ((event: { source: Scheduler, context: { valid: boolean, insertBefore: ResourceModel, resource: ResourceModel, targetGroup: Model }, event: MouseEvent }) => void)|string
|
|
61329
|
+
/**
|
|
61330
|
+
* Fired when drag is aborted
|
|
61331
|
+
* @param {object} event Event object
|
|
61332
|
+
* @param {Scheduler.view.Scheduler} event.source
|
|
61333
|
+
* @param {object} event.context
|
|
61334
|
+
* @param {Scheduler.model.ResourceModel} event.context.resource The dragged resource
|
|
61335
|
+
* @param {MouseEvent} event.event
|
|
61336
|
+
*/
|
|
61337
|
+
onResourceColumnDragAbort?: ((event: { source: Scheduler, context: { resource: ResourceModel }, event: MouseEvent }) => void)|string
|
|
61338
|
+
/**
|
|
61339
|
+
* Fired when dragging starts.
|
|
61340
|
+
* @param {object} event Event object
|
|
61341
|
+
* @param {Scheduler.view.Scheduler} event.source
|
|
61342
|
+
* @param {object} event.context
|
|
61343
|
+
* @param {Scheduler.model.ResourceModel} event.context.resource The dragged resource
|
|
61344
|
+
* @param {MouseEvent,TouchEvent} event.event
|
|
61345
|
+
*/
|
|
61346
|
+
onResourceColumnDragStart?: ((event: { source: Scheduler, context: { resource: ResourceModel }, event: MouseEvent|TouchEvent }) => void)|string
|
|
61347
|
+
/**
|
|
61348
|
+
* Fired after drop
|
|
61349
|
+
* @param {object} event Event object
|
|
61350
|
+
* @param {Scheduler.view.Scheduler} event.source
|
|
61351
|
+
* @param {object} event.context
|
|
61352
|
+
* @param {Scheduler.model.ResourceModel} event.context.resource The dragged resource
|
|
61353
|
+
* @param {Scheduler.model.ResourceModel} event.context.insertBefore The resource that was inserted before
|
|
61354
|
+
* @param {Core.data.Model} event.context.targetGroup When the resourceStore is grouped, the group header record of the target group. The resource's group field has been updated if moved between groups.
|
|
61355
|
+
* @param {boolean} event.context.valid `true` if the drop was valid, `false` otherwise
|
|
61356
|
+
* @param {MouseEvent} event.event
|
|
61357
|
+
*/
|
|
61358
|
+
onResourceColumnDrop?: ((event: { source: Scheduler, context: { resource: ResourceModel, insertBefore: ResourceModel, targetGroup: Model, valid: boolean }, event: MouseEvent }) => void)|string
|
|
60354
61359
|
/**
|
|
60355
61360
|
* Fired when clicking a resource header cell
|
|
60356
61361
|
* @param {object} event Event object
|
|
@@ -63457,6 +64462,70 @@ type SchedulerBaseListenersTypes = {
|
|
|
63457
64462
|
* @param {number} event.oldHeight The old height
|
|
63458
64463
|
*/
|
|
63459
64464
|
resize: (event: { source: Widget, width: number, height: number, oldWidth: number, oldHeight: number }) => void
|
|
64465
|
+
/**
|
|
64466
|
+
* Fired before dragging starts, return `false` to prevent the drag operation.
|
|
64467
|
+
* @param {object} event Event object
|
|
64468
|
+
* @param {Scheduler.view.Scheduler} event.source
|
|
64469
|
+
* @param {object} event.context
|
|
64470
|
+
* @param {Scheduler.model.ResourceModel} event.context.resource The dragged resource
|
|
64471
|
+
* @param {MouseEvent,TouchEvent} event.event
|
|
64472
|
+
*/
|
|
64473
|
+
resourceColumnBeforeDragStart: (event: { source: Scheduler, context: { resource: ResourceModel }, event: MouseEvent|TouchEvent }) => Promise<boolean>|boolean|void
|
|
64474
|
+
/**
|
|
64475
|
+
* Fired before the drop is finalized. You can return `false` or a Promise that resolves to `false`
|
|
64476
|
+
* to cancel the drop operation.
|
|
64477
|
+
* @param {object} event Event object
|
|
64478
|
+
* @param {Scheduler.view.Scheduler} event.source
|
|
64479
|
+
* @param {object} event.context
|
|
64480
|
+
* @param {Scheduler.model.ResourceModel} event.context.resource The dragged resource
|
|
64481
|
+
* @param {Scheduler.model.ResourceModel} event.context.insertBefore The resource to insert before
|
|
64482
|
+
* @param {Core.data.Model} event.context.targetGroup When the resourceStore is grouped, the group header record of the target group
|
|
64483
|
+
* @param {MouseEvent} event.event
|
|
64484
|
+
*/
|
|
64485
|
+
resourceColumnBeforeDropFinalize: (event: { source: Scheduler, context: { resource: ResourceModel, insertBefore: ResourceModel, targetGroup: Model }, event: MouseEvent }) => Promise<boolean>|boolean|void
|
|
64486
|
+
/**
|
|
64487
|
+
* Fired while the resource column is being dragged. You can signal that the drop position is
|
|
64488
|
+
* valid or invalid by setting `context.valid = false;`
|
|
64489
|
+
* @param {object} event Event object
|
|
64490
|
+
* @param {Scheduler.view.Scheduler} event.source
|
|
64491
|
+
* @param {object} event.context
|
|
64492
|
+
* @param {boolean} event.context.valid Set this to `true` or `false` to indicate whether the drop position is valid
|
|
64493
|
+
* @param {Scheduler.model.ResourceModel} event.context.insertBefore The resource to insert before (`null` if inserting at last position)
|
|
64494
|
+
* @param {Scheduler.model.ResourceModel} event.context.resource The dragged resource
|
|
64495
|
+
* @param {Core.data.Model} event.context.targetGroup When the resourceStore is grouped, the group header record of the target group
|
|
64496
|
+
* @param {MouseEvent} event.event
|
|
64497
|
+
*/
|
|
64498
|
+
resourceColumnDrag: (event: { source: Scheduler, context: { valid: boolean, insertBefore: ResourceModel, resource: ResourceModel, targetGroup: Model }, event: MouseEvent }) => void
|
|
64499
|
+
/**
|
|
64500
|
+
* Fired when drag is aborted
|
|
64501
|
+
* @param {object} event Event object
|
|
64502
|
+
* @param {Scheduler.view.Scheduler} event.source
|
|
64503
|
+
* @param {object} event.context
|
|
64504
|
+
* @param {Scheduler.model.ResourceModel} event.context.resource The dragged resource
|
|
64505
|
+
* @param {MouseEvent} event.event
|
|
64506
|
+
*/
|
|
64507
|
+
resourceColumnDragAbort: (event: { source: Scheduler, context: { resource: ResourceModel }, event: MouseEvent }) => void
|
|
64508
|
+
/**
|
|
64509
|
+
* Fired when dragging starts.
|
|
64510
|
+
* @param {object} event Event object
|
|
64511
|
+
* @param {Scheduler.view.Scheduler} event.source
|
|
64512
|
+
* @param {object} event.context
|
|
64513
|
+
* @param {Scheduler.model.ResourceModel} event.context.resource The dragged resource
|
|
64514
|
+
* @param {MouseEvent,TouchEvent} event.event
|
|
64515
|
+
*/
|
|
64516
|
+
resourceColumnDragStart: (event: { source: Scheduler, context: { resource: ResourceModel }, event: MouseEvent|TouchEvent }) => void
|
|
64517
|
+
/**
|
|
64518
|
+
* Fired after drop
|
|
64519
|
+
* @param {object} event Event object
|
|
64520
|
+
* @param {Scheduler.view.Scheduler} event.source
|
|
64521
|
+
* @param {object} event.context
|
|
64522
|
+
* @param {Scheduler.model.ResourceModel} event.context.resource The dragged resource
|
|
64523
|
+
* @param {Scheduler.model.ResourceModel} event.context.insertBefore The resource that was inserted before
|
|
64524
|
+
* @param {Core.data.Model} event.context.targetGroup When the resourceStore is grouped, the group header record of the target group. The resource's group field has been updated if moved between groups.
|
|
64525
|
+
* @param {boolean} event.context.valid `true` if the drop was valid, `false` otherwise
|
|
64526
|
+
* @param {MouseEvent} event.event
|
|
64527
|
+
*/
|
|
64528
|
+
resourceColumnDrop: (event: { source: Scheduler, context: { resource: ResourceModel, insertBefore: ResourceModel, targetGroup: Model, valid: boolean }, event: MouseEvent }) => void
|
|
63460
64529
|
/**
|
|
63461
64530
|
* Fired when clicking a resource header cell
|
|
63462
64531
|
* @param {object} event Event object
|
|
@@ -65930,6 +66999,70 @@ type SchedulerBaseListeners = {
|
|
|
65930
66999
|
* @param {number} event.oldHeight The old height
|
|
65931
67000
|
*/
|
|
65932
67001
|
resize?: ((event: { source: Widget, width: number, height: number, oldWidth: number, oldHeight: number }) => void)|string
|
|
67002
|
+
/**
|
|
67003
|
+
* Fired before dragging starts, return `false` to prevent the drag operation.
|
|
67004
|
+
* @param {object} event Event object
|
|
67005
|
+
* @param {Scheduler.view.Scheduler} event.source
|
|
67006
|
+
* @param {object} event.context
|
|
67007
|
+
* @param {Scheduler.model.ResourceModel} event.context.resource The dragged resource
|
|
67008
|
+
* @param {MouseEvent,TouchEvent} event.event
|
|
67009
|
+
*/
|
|
67010
|
+
resourceColumnBeforeDragStart?: ((event: { source: Scheduler, context: { resource: ResourceModel }, event: MouseEvent|TouchEvent }) => Promise<boolean>|boolean|void)|string
|
|
67011
|
+
/**
|
|
67012
|
+
* Fired before the drop is finalized. You can return `false` or a Promise that resolves to `false`
|
|
67013
|
+
* to cancel the drop operation.
|
|
67014
|
+
* @param {object} event Event object
|
|
67015
|
+
* @param {Scheduler.view.Scheduler} event.source
|
|
67016
|
+
* @param {object} event.context
|
|
67017
|
+
* @param {Scheduler.model.ResourceModel} event.context.resource The dragged resource
|
|
67018
|
+
* @param {Scheduler.model.ResourceModel} event.context.insertBefore The resource to insert before
|
|
67019
|
+
* @param {Core.data.Model} event.context.targetGroup When the resourceStore is grouped, the group header record of the target group
|
|
67020
|
+
* @param {MouseEvent} event.event
|
|
67021
|
+
*/
|
|
67022
|
+
resourceColumnBeforeDropFinalize?: ((event: { source: Scheduler, context: { resource: ResourceModel, insertBefore: ResourceModel, targetGroup: Model }, event: MouseEvent }) => Promise<boolean>|boolean|void)|string
|
|
67023
|
+
/**
|
|
67024
|
+
* Fired while the resource column is being dragged. You can signal that the drop position is
|
|
67025
|
+
* valid or invalid by setting `context.valid = false;`
|
|
67026
|
+
* @param {object} event Event object
|
|
67027
|
+
* @param {Scheduler.view.Scheduler} event.source
|
|
67028
|
+
* @param {object} event.context
|
|
67029
|
+
* @param {boolean} event.context.valid Set this to `true` or `false` to indicate whether the drop position is valid
|
|
67030
|
+
* @param {Scheduler.model.ResourceModel} event.context.insertBefore The resource to insert before (`null` if inserting at last position)
|
|
67031
|
+
* @param {Scheduler.model.ResourceModel} event.context.resource The dragged resource
|
|
67032
|
+
* @param {Core.data.Model} event.context.targetGroup When the resourceStore is grouped, the group header record of the target group
|
|
67033
|
+
* @param {MouseEvent} event.event
|
|
67034
|
+
*/
|
|
67035
|
+
resourceColumnDrag?: ((event: { source: Scheduler, context: { valid: boolean, insertBefore: ResourceModel, resource: ResourceModel, targetGroup: Model }, event: MouseEvent }) => void)|string
|
|
67036
|
+
/**
|
|
67037
|
+
* Fired when drag is aborted
|
|
67038
|
+
* @param {object} event Event object
|
|
67039
|
+
* @param {Scheduler.view.Scheduler} event.source
|
|
67040
|
+
* @param {object} event.context
|
|
67041
|
+
* @param {Scheduler.model.ResourceModel} event.context.resource The dragged resource
|
|
67042
|
+
* @param {MouseEvent} event.event
|
|
67043
|
+
*/
|
|
67044
|
+
resourceColumnDragAbort?: ((event: { source: Scheduler, context: { resource: ResourceModel }, event: MouseEvent }) => void)|string
|
|
67045
|
+
/**
|
|
67046
|
+
* Fired when dragging starts.
|
|
67047
|
+
* @param {object} event Event object
|
|
67048
|
+
* @param {Scheduler.view.Scheduler} event.source
|
|
67049
|
+
* @param {object} event.context
|
|
67050
|
+
* @param {Scheduler.model.ResourceModel} event.context.resource The dragged resource
|
|
67051
|
+
* @param {MouseEvent,TouchEvent} event.event
|
|
67052
|
+
*/
|
|
67053
|
+
resourceColumnDragStart?: ((event: { source: Scheduler, context: { resource: ResourceModel }, event: MouseEvent|TouchEvent }) => void)|string
|
|
67054
|
+
/**
|
|
67055
|
+
* Fired after drop
|
|
67056
|
+
* @param {object} event Event object
|
|
67057
|
+
* @param {Scheduler.view.Scheduler} event.source
|
|
67058
|
+
* @param {object} event.context
|
|
67059
|
+
* @param {Scheduler.model.ResourceModel} event.context.resource The dragged resource
|
|
67060
|
+
* @param {Scheduler.model.ResourceModel} event.context.insertBefore The resource that was inserted before
|
|
67061
|
+
* @param {Core.data.Model} event.context.targetGroup When the resourceStore is grouped, the group header record of the target group. The resource's group field has been updated if moved between groups.
|
|
67062
|
+
* @param {boolean} event.context.valid `true` if the drop was valid, `false` otherwise
|
|
67063
|
+
* @param {MouseEvent} event.event
|
|
67064
|
+
*/
|
|
67065
|
+
resourceColumnDrop?: ((event: { source: Scheduler, context: { resource: ResourceModel, insertBefore: ResourceModel, targetGroup: Model, valid: boolean }, event: MouseEvent }) => void)|string
|
|
65933
67066
|
/**
|
|
65934
67067
|
* Fired when clicking a resource header cell
|
|
65935
67068
|
* @param {object} event Event object
|
|
@@ -66625,6 +67758,7 @@ type SchedulerBaseListeners = {
|
|
|
66625
67758
|
}
|
|
66626
67759
|
|
|
66627
67760
|
type SchedulerBaseFeaturesType = {
|
|
67761
|
+
ai: AI
|
|
66628
67762
|
aiFilter: AIFilter
|
|
66629
67763
|
cellCopyPaste: CellCopyPaste
|
|
66630
67764
|
cellEdit: CellEdit
|
|
@@ -66670,6 +67804,7 @@ type SchedulerBaseFeaturesType = {
|
|
|
66670
67804
|
print: Print
|
|
66671
67805
|
quickFind: QuickFind
|
|
66672
67806
|
regionResize: RegionResize
|
|
67807
|
+
resourceColumnReorder: ResourceColumnReorder
|
|
66673
67808
|
resourceMenu: ResourceMenu
|
|
66674
67809
|
resourceTimeRanges: ResourceTimeRanges
|
|
66675
67810
|
rowCopyPaste: RowCopyPaste
|
|
@@ -66698,6 +67833,7 @@ type SchedulerBaseFeaturesType = {
|
|
|
66698
67833
|
}
|
|
66699
67834
|
|
|
66700
67835
|
type SchedulerBaseFeaturesConfigType = {
|
|
67836
|
+
ai?: string|boolean|AIConfig
|
|
66701
67837
|
aiFilter?: string|boolean|AIFilterConfig
|
|
66702
67838
|
cellCopyPaste?: string|boolean|CellCopyPasteConfig
|
|
66703
67839
|
cellEdit?: string|boolean|CellEditConfig
|
|
@@ -66743,6 +67879,7 @@ type SchedulerBaseFeaturesConfigType = {
|
|
|
66743
67879
|
print?: string|boolean|PrintConfig
|
|
66744
67880
|
quickFind?: string|boolean|QuickFindConfig
|
|
66745
67881
|
regionResize?: string|boolean|RegionResizeConfig
|
|
67882
|
+
resourceColumnReorder?: string|boolean|ResourceColumnReorderConfig
|
|
66746
67883
|
resourceMenu?: string|boolean|ResourceMenuConfig
|
|
66747
67884
|
resourceTimeRanges?: string|boolean|ResourceTimeRangesConfig
|
|
66748
67885
|
rowCopyPaste?: string|boolean|RowCopyPasteConfig
|
|
@@ -66898,6 +68035,10 @@ type SchedulerBaseConfig = {
|
|
|
66898
68035
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/SchedulerBase#config-bodyCls)
|
|
66899
68036
|
*/
|
|
66900
68037
|
bodyCls?: string|object
|
|
68038
|
+
/**
|
|
68039
|
+
* Set `true` to add a border to this container's element.
|
|
68040
|
+
*/
|
|
68041
|
+
border?: boolean
|
|
66901
68042
|
/**
|
|
66902
68043
|
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
66903
68044
|
* hierarchy when triggered.
|
|
@@ -66963,7 +68104,7 @@ type SchedulerBaseConfig = {
|
|
|
66963
68104
|
* ...
|
|
66964
68105
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/SchedulerBase#config-color)
|
|
66965
68106
|
*/
|
|
66966
|
-
color?:
|
|
68107
|
+
color?: Color
|
|
66967
68108
|
/**
|
|
66968
68109
|
* Programmatic control over which column to start in when used in a grid layout.
|
|
66969
68110
|
*/
|
|
@@ -67280,8 +68421,8 @@ type SchedulerBaseConfig = {
|
|
|
67280
68421
|
* @param {'tonal','filled','bordered','traced','outlined','indented','line','dashed','minimal','rounded','calendar','interday','gantt',null} detail.renderData.eventStyle The `eventStyle` of the event. Use this to apply custom styles to the event DOM element
|
|
67281
68422
|
* @param {string} detail.renderData.eventColor The `eventColor` of the event. Use this to set a custom color for the rendered event
|
|
67282
68423
|
* @param {string} detail.renderData.ariaLabel A description of the event details used for screen readers
|
|
67283
|
-
* @param {DomConfig[]} detail.renderData.children An array of DOM configs used as children to the `b-sch-event` element. Can be populated with additional DOM configs to have more control over contents.
|
|
67284
|
-
* @returns {string,DomConfig,DomConfig[]} A simple string,
|
|
68424
|
+
* @param {DomConfig[]} detail.renderData.children An array of DOM configs used as children to the `b-sch-event` element. Can be populated with additional DOM configs to have more control over contents. <h3>Using JSX (React)</h3> When using the Bryntum React wrapper, the event renderer can return JSX elements: ```javascript eventRenderer({ eventRecord, resourceRecord, renderData }) { return <MyEventComponent event={eventRecord} resource={resourceRecord} />; } ``` *Using JSX in the event renderer creates a React portal for each rendered event. For schedulers with many visible events or frequently re-rendered views, this may impact scrolling performance compared to returning plain strings or [DomConfig](https://bryntum.com/products/scheduler/docs/api/Core/helper/DomHelper#typedef-DomConfig) objects. Consider using JSX primarily for events that require complex interactive React components.*
|
|
68425
|
+
* @returns {string,DomConfig,DomConfig[]} A simple string, a DomConfig (or array thereof), or a JSX element when using React
|
|
67285
68426
|
*/
|
|
67286
68427
|
eventRenderer?: (detail: { eventRecord: EventModel, resourceRecord: ResourceModel, assignmentRecord: AssignmentModel, scheduler: Scheduler, renderData: { event: EventModel, cls: DomClassList|string, wrapperCls: DomClassList|string, iconCls: DomClassList|string, left: number, width: number, height: number, style: string|Record<string, string>, wrapperStyle: string|Record<string, string>, eventStyle: 'tonal'|'filled'|'bordered'|'traced'|'outlined'|'indented'|'line'|'dashed'|'minimal'|'rounded'|'calendar'|'interday'|'gantt'|null, eventColor: string, ariaLabel: string, children: DomConfig[] } }) => string|DomConfig|DomConfig[]
|
|
67287
68428
|
/**
|
|
@@ -67464,6 +68605,10 @@ type SchedulerBaseConfig = {
|
|
|
67464
68605
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/SchedulerBase#config-infiniteScroll)
|
|
67465
68606
|
*/
|
|
67466
68607
|
infiniteScroll?: boolean
|
|
68608
|
+
/**
|
|
68609
|
+
* Set to true for child nodes in a tree store to inherit their parent´s `eventColor`
|
|
68610
|
+
*/
|
|
68611
|
+
inheritEventColor?: boolean
|
|
67467
68612
|
/**
|
|
67468
68613
|
* Maximum duration (in milliseconds) for the initial animation controlled by [useInitialAnimation](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/SchedulerEventRendering#config-useInitialAnimation).
|
|
67469
68614
|
*/
|
|
@@ -67709,7 +68854,7 @@ type SchedulerBaseConfig = {
|
|
|
67709
68854
|
* ...
|
|
67710
68855
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/SchedulerBase#config-partner)
|
|
67711
68856
|
*/
|
|
67712
|
-
partner?: TimelineBase
|
|
68857
|
+
partner?: TimelineBase|string
|
|
67713
68858
|
/**
|
|
67714
68859
|
* Set to `true` to include `startDate` and `endDate` params indicating the currently viewed date range in
|
|
67715
68860
|
* `EventStore` load requests (when loading using `AjaxStore` or `CrudManager` functionality).
|
|
@@ -70115,6 +71260,70 @@ type SchedulerBaseConfig = {
|
|
|
70115
71260
|
* @param {number} event.oldHeight The old height
|
|
70116
71261
|
*/
|
|
70117
71262
|
onResize?: ((event: { source: Widget, width: number, height: number, oldWidth: number, oldHeight: number }) => void)|string
|
|
71263
|
+
/**
|
|
71264
|
+
* Fired before dragging starts, return `false` to prevent the drag operation.
|
|
71265
|
+
* @param {object} event Event object
|
|
71266
|
+
* @param {Scheduler.view.Scheduler} event.source
|
|
71267
|
+
* @param {object} event.context
|
|
71268
|
+
* @param {Scheduler.model.ResourceModel} event.context.resource The dragged resource
|
|
71269
|
+
* @param {MouseEvent,TouchEvent} event.event
|
|
71270
|
+
*/
|
|
71271
|
+
onResourceColumnBeforeDragStart?: ((event: { source: Scheduler, context: { resource: ResourceModel }, event: MouseEvent|TouchEvent }) => Promise<boolean>|boolean|void)|string
|
|
71272
|
+
/**
|
|
71273
|
+
* Fired before the drop is finalized. You can return `false` or a Promise that resolves to `false`
|
|
71274
|
+
* to cancel the drop operation.
|
|
71275
|
+
* @param {object} event Event object
|
|
71276
|
+
* @param {Scheduler.view.Scheduler} event.source
|
|
71277
|
+
* @param {object} event.context
|
|
71278
|
+
* @param {Scheduler.model.ResourceModel} event.context.resource The dragged resource
|
|
71279
|
+
* @param {Scheduler.model.ResourceModel} event.context.insertBefore The resource to insert before
|
|
71280
|
+
* @param {Core.data.Model} event.context.targetGroup When the resourceStore is grouped, the group header record of the target group
|
|
71281
|
+
* @param {MouseEvent} event.event
|
|
71282
|
+
*/
|
|
71283
|
+
onResourceColumnBeforeDropFinalize?: ((event: { source: Scheduler, context: { resource: ResourceModel, insertBefore: ResourceModel, targetGroup: Model }, event: MouseEvent }) => Promise<boolean>|boolean|void)|string
|
|
71284
|
+
/**
|
|
71285
|
+
* Fired while the resource column is being dragged. You can signal that the drop position is
|
|
71286
|
+
* valid or invalid by setting `context.valid = false;`
|
|
71287
|
+
* @param {object} event Event object
|
|
71288
|
+
* @param {Scheduler.view.Scheduler} event.source
|
|
71289
|
+
* @param {object} event.context
|
|
71290
|
+
* @param {boolean} event.context.valid Set this to `true` or `false` to indicate whether the drop position is valid
|
|
71291
|
+
* @param {Scheduler.model.ResourceModel} event.context.insertBefore The resource to insert before (`null` if inserting at last position)
|
|
71292
|
+
* @param {Scheduler.model.ResourceModel} event.context.resource The dragged resource
|
|
71293
|
+
* @param {Core.data.Model} event.context.targetGroup When the resourceStore is grouped, the group header record of the target group
|
|
71294
|
+
* @param {MouseEvent} event.event
|
|
71295
|
+
*/
|
|
71296
|
+
onResourceColumnDrag?: ((event: { source: Scheduler, context: { valid: boolean, insertBefore: ResourceModel, resource: ResourceModel, targetGroup: Model }, event: MouseEvent }) => void)|string
|
|
71297
|
+
/**
|
|
71298
|
+
* Fired when drag is aborted
|
|
71299
|
+
* @param {object} event Event object
|
|
71300
|
+
* @param {Scheduler.view.Scheduler} event.source
|
|
71301
|
+
* @param {object} event.context
|
|
71302
|
+
* @param {Scheduler.model.ResourceModel} event.context.resource The dragged resource
|
|
71303
|
+
* @param {MouseEvent} event.event
|
|
71304
|
+
*/
|
|
71305
|
+
onResourceColumnDragAbort?: ((event: { source: Scheduler, context: { resource: ResourceModel }, event: MouseEvent }) => void)|string
|
|
71306
|
+
/**
|
|
71307
|
+
* Fired when dragging starts.
|
|
71308
|
+
* @param {object} event Event object
|
|
71309
|
+
* @param {Scheduler.view.Scheduler} event.source
|
|
71310
|
+
* @param {object} event.context
|
|
71311
|
+
* @param {Scheduler.model.ResourceModel} event.context.resource The dragged resource
|
|
71312
|
+
* @param {MouseEvent,TouchEvent} event.event
|
|
71313
|
+
*/
|
|
71314
|
+
onResourceColumnDragStart?: ((event: { source: Scheduler, context: { resource: ResourceModel }, event: MouseEvent|TouchEvent }) => void)|string
|
|
71315
|
+
/**
|
|
71316
|
+
* Fired after drop
|
|
71317
|
+
* @param {object} event Event object
|
|
71318
|
+
* @param {Scheduler.view.Scheduler} event.source
|
|
71319
|
+
* @param {object} event.context
|
|
71320
|
+
* @param {Scheduler.model.ResourceModel} event.context.resource The dragged resource
|
|
71321
|
+
* @param {Scheduler.model.ResourceModel} event.context.insertBefore The resource that was inserted before
|
|
71322
|
+
* @param {Core.data.Model} event.context.targetGroup When the resourceStore is grouped, the group header record of the target group. The resource's group field has been updated if moved between groups.
|
|
71323
|
+
* @param {boolean} event.context.valid `true` if the drop was valid, `false` otherwise
|
|
71324
|
+
* @param {MouseEvent} event.event
|
|
71325
|
+
*/
|
|
71326
|
+
onResourceColumnDrop?: ((event: { source: Scheduler, context: { resource: ResourceModel, insertBefore: ResourceModel, targetGroup: Model, valid: boolean }, event: MouseEvent }) => void)|string
|
|
70118
71327
|
/**
|
|
70119
71328
|
* Fired when clicking a resource header cell
|
|
70120
71329
|
* @param {object} event Event object
|
|
@@ -71081,6 +72290,10 @@ export class SchedulerBase extends TimelineBase {
|
|
|
71081
72290
|
* when the scroller comes close to the start/end edges.
|
|
71082
72291
|
*/
|
|
71083
72292
|
infiniteScroll: boolean
|
|
72293
|
+
/**
|
|
72294
|
+
* Set to true for child nodes in a tree store to inherit their parent´s `eventColor`
|
|
72295
|
+
*/
|
|
72296
|
+
inheritEventColor: boolean
|
|
71084
72297
|
/**
|
|
71085
72298
|
* Maximum duration (in milliseconds) for the initial animation controlled by [useInitialAnimation](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/SchedulerEventRendering#config-useInitialAnimation).
|
|
71086
72299
|
*/
|
|
@@ -72508,6 +73721,70 @@ export class SchedulerBase extends TimelineBase {
|
|
|
72508
73721
|
* @param {HTMLElement} event.element The event bar element
|
|
72509
73722
|
*/
|
|
72510
73723
|
onRenderEvent: ((event: { source: Scheduler, eventRecord: EventModel, resourceRecord: ResourceModel, assignmentRecord: AssignmentModel, renderData: object, isRepaint: boolean, isReusingElement: boolean, element: HTMLElement }) => void)|string
|
|
73724
|
+
/**
|
|
73725
|
+
* Fired before dragging starts, return `false` to prevent the drag operation.
|
|
73726
|
+
* @param {object} event Event object
|
|
73727
|
+
* @param {Scheduler.view.Scheduler} event.source
|
|
73728
|
+
* @param {object} event.context
|
|
73729
|
+
* @param {Scheduler.model.ResourceModel} event.context.resource The dragged resource
|
|
73730
|
+
* @param {MouseEvent,TouchEvent} event.event
|
|
73731
|
+
*/
|
|
73732
|
+
onResourceColumnBeforeDragStart: ((event: { source: Scheduler, context: { resource: ResourceModel }, event: MouseEvent|TouchEvent }) => Promise<boolean>|boolean|void)|string
|
|
73733
|
+
/**
|
|
73734
|
+
* Fired before the drop is finalized. You can return `false` or a Promise that resolves to `false`
|
|
73735
|
+
* to cancel the drop operation.
|
|
73736
|
+
* @param {object} event Event object
|
|
73737
|
+
* @param {Scheduler.view.Scheduler} event.source
|
|
73738
|
+
* @param {object} event.context
|
|
73739
|
+
* @param {Scheduler.model.ResourceModel} event.context.resource The dragged resource
|
|
73740
|
+
* @param {Scheduler.model.ResourceModel} event.context.insertBefore The resource to insert before
|
|
73741
|
+
* @param {Core.data.Model} event.context.targetGroup When the resourceStore is grouped, the group header record of the target group
|
|
73742
|
+
* @param {MouseEvent} event.event
|
|
73743
|
+
*/
|
|
73744
|
+
onResourceColumnBeforeDropFinalize: ((event: { source: Scheduler, context: { resource: ResourceModel, insertBefore: ResourceModel, targetGroup: Model }, event: MouseEvent }) => Promise<boolean>|boolean|void)|string
|
|
73745
|
+
/**
|
|
73746
|
+
* Fired while the resource column is being dragged. You can signal that the drop position is
|
|
73747
|
+
* valid or invalid by setting `context.valid = false;`
|
|
73748
|
+
* @param {object} event Event object
|
|
73749
|
+
* @param {Scheduler.view.Scheduler} event.source
|
|
73750
|
+
* @param {object} event.context
|
|
73751
|
+
* @param {boolean} event.context.valid Set this to `true` or `false` to indicate whether the drop position is valid
|
|
73752
|
+
* @param {Scheduler.model.ResourceModel} event.context.insertBefore The resource to insert before (`null` if inserting at last position)
|
|
73753
|
+
* @param {Scheduler.model.ResourceModel} event.context.resource The dragged resource
|
|
73754
|
+
* @param {Core.data.Model} event.context.targetGroup When the resourceStore is grouped, the group header record of the target group
|
|
73755
|
+
* @param {MouseEvent} event.event
|
|
73756
|
+
*/
|
|
73757
|
+
onResourceColumnDrag: ((event: { source: Scheduler, context: { valid: boolean, insertBefore: ResourceModel, resource: ResourceModel, targetGroup: Model }, event: MouseEvent }) => void)|string
|
|
73758
|
+
/**
|
|
73759
|
+
* Fired when drag is aborted
|
|
73760
|
+
* @param {object} event Event object
|
|
73761
|
+
* @param {Scheduler.view.Scheduler} event.source
|
|
73762
|
+
* @param {object} event.context
|
|
73763
|
+
* @param {Scheduler.model.ResourceModel} event.context.resource The dragged resource
|
|
73764
|
+
* @param {MouseEvent} event.event
|
|
73765
|
+
*/
|
|
73766
|
+
onResourceColumnDragAbort: ((event: { source: Scheduler, context: { resource: ResourceModel }, event: MouseEvent }) => void)|string
|
|
73767
|
+
/**
|
|
73768
|
+
* Fired when dragging starts.
|
|
73769
|
+
* @param {object} event Event object
|
|
73770
|
+
* @param {Scheduler.view.Scheduler} event.source
|
|
73771
|
+
* @param {object} event.context
|
|
73772
|
+
* @param {Scheduler.model.ResourceModel} event.context.resource The dragged resource
|
|
73773
|
+
* @param {MouseEvent,TouchEvent} event.event
|
|
73774
|
+
*/
|
|
73775
|
+
onResourceColumnDragStart: ((event: { source: Scheduler, context: { resource: ResourceModel }, event: MouseEvent|TouchEvent }) => void)|string
|
|
73776
|
+
/**
|
|
73777
|
+
* Fired after drop
|
|
73778
|
+
* @param {object} event Event object
|
|
73779
|
+
* @param {Scheduler.view.Scheduler} event.source
|
|
73780
|
+
* @param {object} event.context
|
|
73781
|
+
* @param {Scheduler.model.ResourceModel} event.context.resource The dragged resource
|
|
73782
|
+
* @param {Scheduler.model.ResourceModel} event.context.insertBefore The resource that was inserted before
|
|
73783
|
+
* @param {Core.data.Model} event.context.targetGroup When the resourceStore is grouped, the group header record of the target group. The resource's group field has been updated if moved between groups.
|
|
73784
|
+
* @param {boolean} event.context.valid `true` if the drop was valid, `false` otherwise
|
|
73785
|
+
* @param {MouseEvent} event.event
|
|
73786
|
+
*/
|
|
73787
|
+
onResourceColumnDrop: ((event: { source: Scheduler, context: { resource: ResourceModel, insertBefore: ResourceModel, targetGroup: Model, valid: boolean }, event: MouseEvent }) => void)|string
|
|
72511
73788
|
/**
|
|
72512
73789
|
* Fired when clicking a resource header cell
|
|
72513
73790
|
* @param {object} event Event object
|
|
@@ -73100,11 +74377,11 @@ export class SchedulerBase extends TimelineBase {
|
|
|
73100
74377
|
deselectEvents(events: EventModel[]): void;
|
|
73101
74378
|
/**
|
|
73102
74379
|
* Opens an editor UI to edit the passed event, or a config object for a new event.
|
|
73103
|
-
* @param {Scheduler.model.EventModel,EventModelConfig} eventRecord Event to edit
|
|
74380
|
+
* @param {Scheduler.model.EventModel,EventModelConfig,string,number} eventRecord Event to edit
|
|
73104
74381
|
* @param {Scheduler.model.ResourceModel} resourceRecord The Resource record for the event. This parameter is needed if the event is newly created for a resource and has not been assigned, or when using multi assignment.
|
|
73105
74382
|
* @param {HTMLElement} element Element to anchor editor to (defaults to events element)
|
|
73106
74383
|
*/
|
|
73107
|
-
editEvent(eventRecord: EventModel|EventModelConfig, resourceRecord?: ResourceModel, element?: HTMLElement): void;
|
|
74384
|
+
editEvent(eventRecord: EventModel|EventModelConfig|string|number, resourceRecord?: ResourceModel, element?: HTMLElement): void;
|
|
73108
74385
|
/**
|
|
73109
74386
|
* Gets the x or y coordinate relative to the scheduler element, or page coordinate (based on the 'local' flag)
|
|
73110
74387
|
* If the coordinate is not in the currently rendered view, -1 will be returned.
|
|
@@ -73161,6 +74438,24 @@ export class SchedulerBase extends TimelineBase {
|
|
|
73161
74438
|
* @param {Scheduler.model.ResourceModel} resourceRecord A resource record
|
|
73162
74439
|
*/
|
|
73163
74440
|
getElementsFromEventRecord(eventRecord: EventModel, resourceRecord?: ResourceModel): HTMLElement[];
|
|
74441
|
+
/**
|
|
74442
|
+
* Returns an array of events for the date range specified by the `startDate` and `endDate` options.
|
|
74443
|
+
* @param {object} options An options object determining which events to return
|
|
74444
|
+
*/
|
|
74445
|
+
getEvents(options: {
|
|
74446
|
+
date?: Date
|
|
74447
|
+
startDate: Date
|
|
74448
|
+
endDate?: Date
|
|
74449
|
+
resourceRecord?: ResourceModel
|
|
74450
|
+
filter?: Function
|
|
74451
|
+
ignoreFilters?: boolean
|
|
74452
|
+
includeOccurrences?: boolean
|
|
74453
|
+
allowPartial?: boolean
|
|
74454
|
+
startOnly?: boolean
|
|
74455
|
+
silent?: boolean
|
|
74456
|
+
onlyAssigned?: boolean
|
|
74457
|
+
dateMap?: boolean|Map<any, any>
|
|
74458
|
+
}): EventModel[]|Map<any, any>;
|
|
73164
74459
|
/**
|
|
73165
74460
|
* Determines width of a milestones label. How width is determined is decided by configuring
|
|
73166
74461
|
* [milestoneLayoutMode](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/SchedulerEventRendering#config-milestoneLayoutMode). Please note that text width is always determined using the events
|
|
@@ -75965,6 +77260,7 @@ type TimelineBaseListeners = {
|
|
|
75965
77260
|
}
|
|
75966
77261
|
|
|
75967
77262
|
type TimelineBaseFeaturesType = {
|
|
77263
|
+
ai: GridAI
|
|
75968
77264
|
aiFilter: AIFilter
|
|
75969
77265
|
cellCopyPaste: CellCopyPaste
|
|
75970
77266
|
cellEdit: CellEdit
|
|
@@ -76008,6 +77304,7 @@ type TimelineBaseFeaturesType = {
|
|
|
76008
77304
|
}
|
|
76009
77305
|
|
|
76010
77306
|
type TimelineBaseFeaturesConfigType = {
|
|
77307
|
+
ai?: string|boolean|GridAIConfig
|
|
76011
77308
|
aiFilter?: string|boolean|AIFilterConfig
|
|
76012
77309
|
cellCopyPaste?: string|boolean|CellCopyPasteConfig
|
|
76013
77310
|
cellEdit?: string|boolean|CellEditConfig
|
|
@@ -76134,6 +77431,10 @@ type TimelineBaseConfig = {
|
|
|
76134
77431
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineBase#config-bodyCls)
|
|
76135
77432
|
*/
|
|
76136
77433
|
bodyCls?: string|object
|
|
77434
|
+
/**
|
|
77435
|
+
* Set `true` to add a border to this container's element.
|
|
77436
|
+
*/
|
|
77437
|
+
border?: boolean
|
|
76137
77438
|
/**
|
|
76138
77439
|
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
76139
77440
|
* hierarchy when triggered.
|
|
@@ -76199,7 +77500,7 @@ type TimelineBaseConfig = {
|
|
|
76199
77500
|
* ...
|
|
76200
77501
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineBase#config-color)
|
|
76201
77502
|
*/
|
|
76202
|
-
color?:
|
|
77503
|
+
color?: Color
|
|
76203
77504
|
/**
|
|
76204
77505
|
* Programmatic control over which column to start in when used in a grid layout.
|
|
76205
77506
|
*/
|
|
@@ -76664,7 +77965,7 @@ type TimelineBaseConfig = {
|
|
|
76664
77965
|
* ...
|
|
76665
77966
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineBase#config-partner)
|
|
76666
77967
|
*/
|
|
76667
|
-
partner?: TimelineBase
|
|
77968
|
+
partner?: TimelineBase|string
|
|
76668
77969
|
/**
|
|
76669
77970
|
* Specify plugins (an array of classes) in config
|
|
76670
77971
|
*/
|
|
@@ -81935,6 +83236,7 @@ type TimelineHistogramListeners = {
|
|
|
81935
83236
|
}
|
|
81936
83237
|
|
|
81937
83238
|
type TimelineHistogramFeaturesType = {
|
|
83239
|
+
ai: GridAI
|
|
81938
83240
|
aiFilter: AIFilter
|
|
81939
83241
|
cellCopyPaste: CellCopyPaste
|
|
81940
83242
|
cellEdit: CellEdit
|
|
@@ -81987,6 +83289,7 @@ type TimelineHistogramFeaturesType = {
|
|
|
81987
83289
|
}
|
|
81988
83290
|
|
|
81989
83291
|
type TimelineHistogramFeaturesConfigType = {
|
|
83292
|
+
ai?: string|boolean|GridAIConfig
|
|
81990
83293
|
aiFilter?: string|boolean|AIFilterConfig
|
|
81991
83294
|
cellCopyPaste?: string|boolean|CellCopyPasteConfig
|
|
81992
83295
|
cellEdit?: string|boolean|CellEditConfig
|
|
@@ -82152,6 +83455,10 @@ type TimelineHistogramConfig = {
|
|
|
82152
83455
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-bodyCls)
|
|
82153
83456
|
*/
|
|
82154
83457
|
bodyCls?: string|object
|
|
83458
|
+
/**
|
|
83459
|
+
* Set `true` to add a border to this container's element.
|
|
83460
|
+
*/
|
|
83461
|
+
border?: boolean
|
|
82155
83462
|
/**
|
|
82156
83463
|
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
82157
83464
|
* hierarchy when triggered.
|
|
@@ -82217,7 +83524,7 @@ type TimelineHistogramConfig = {
|
|
|
82217
83524
|
* ...
|
|
82218
83525
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-color)
|
|
82219
83526
|
*/
|
|
82220
|
-
color?:
|
|
83527
|
+
color?: Color
|
|
82221
83528
|
/**
|
|
82222
83529
|
* Programmatic control over which column to start in when used in a grid layout.
|
|
82223
83530
|
*/
|
|
@@ -82810,7 +84117,7 @@ type TimelineHistogramConfig = {
|
|
|
82810
84117
|
* ...
|
|
82811
84118
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-partner)
|
|
82812
84119
|
*/
|
|
82813
|
-
partner?: TimelineBase
|
|
84120
|
+
partner?: TimelineBase|string
|
|
82814
84121
|
/**
|
|
82815
84122
|
* Specify plugins (an array of classes) in config
|
|
82816
84123
|
*/
|
|
@@ -86199,17 +87506,15 @@ export class TimelineHistogram extends TimelineHistogramBase {
|
|
|
86199
87506
|
static optionalL(text: string, templateData?: any): string;
|
|
86200
87507
|
/**
|
|
86201
87508
|
* Analogous to `document.querySelector`, finds the first Bryntum widget matching the passed
|
|
86202
|
-
* selector.
|
|
86203
|
-
*
|
|
86204
|
-
* @param {string,Function} selector A lowercased class name, or a filter function.
|
|
87509
|
+
* selector. Supported selector formats:
|
|
87510
|
+
* @param {Core.widget.Widget,string,Function} selector A widget instance, widget type, id selector (#id), attribute selector ([attr=value]), or filter function.
|
|
86205
87511
|
* @param {boolean} deep Specify `true` to search the prototype chain (requires supplying a string `selector`). For example 'widget' would then find a Grid
|
|
86206
87512
|
*/
|
|
86207
|
-
static query(selector: string|Function, deep?: boolean): Widget;
|
|
87513
|
+
static query(selector: Widget|string|Function, deep?: boolean): Widget;
|
|
86208
87514
|
/**
|
|
86209
|
-
* Analogous to document.querySelectorAll
|
|
86210
|
-
* selector.
|
|
86211
|
-
*
|
|
86212
|
-
* @param {string,Function} selector A lowercased class name, or a filter function.
|
|
87515
|
+
* Analogous to `document.querySelectorAll`, finds all Bryntum widgets matching the passed
|
|
87516
|
+
* selector. Supported selector formats:
|
|
87517
|
+
* @param {string,Function} selector A widget type, id selector (#id), attribute selector ([attr=value]), or filter function.
|
|
86213
87518
|
* @param {boolean} deep Specify `true` to search the prototype chain (requires supplying a string `selector`). For example 'widget' would then find a Grid
|
|
86214
87519
|
*/
|
|
86215
87520
|
static queryAll(selector: string|Function, deep?: boolean): Widget[];
|
|
@@ -89699,6 +91004,7 @@ type TimelineHistogramBaseListeners = {
|
|
|
89699
91004
|
}
|
|
89700
91005
|
|
|
89701
91006
|
type TimelineHistogramBaseFeaturesType = {
|
|
91007
|
+
ai: GridAI
|
|
89702
91008
|
aiFilter: AIFilter
|
|
89703
91009
|
cellCopyPaste: CellCopyPaste
|
|
89704
91010
|
cellEdit: CellEdit
|
|
@@ -89742,6 +91048,7 @@ type TimelineHistogramBaseFeaturesType = {
|
|
|
89742
91048
|
}
|
|
89743
91049
|
|
|
89744
91050
|
type TimelineHistogramBaseFeaturesConfigType = {
|
|
91051
|
+
ai?: string|boolean|GridAIConfig
|
|
89745
91052
|
aiFilter?: string|boolean|AIFilterConfig
|
|
89746
91053
|
cellCopyPaste?: string|boolean|CellCopyPasteConfig
|
|
89747
91054
|
cellEdit?: string|boolean|CellEditConfig
|
|
@@ -89881,6 +91188,10 @@ type TimelineHistogramBaseConfig = {
|
|
|
89881
91188
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogramBase#config-bodyCls)
|
|
89882
91189
|
*/
|
|
89883
91190
|
bodyCls?: string|object
|
|
91191
|
+
/**
|
|
91192
|
+
* Set `true` to add a border to this container's element.
|
|
91193
|
+
*/
|
|
91194
|
+
border?: boolean
|
|
89884
91195
|
/**
|
|
89885
91196
|
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
89886
91197
|
* hierarchy when triggered.
|
|
@@ -89946,7 +91257,7 @@ type TimelineHistogramBaseConfig = {
|
|
|
89946
91257
|
* ...
|
|
89947
91258
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogramBase#config-color)
|
|
89948
91259
|
*/
|
|
89949
|
-
color?:
|
|
91260
|
+
color?: Color
|
|
89950
91261
|
/**
|
|
89951
91262
|
* Programmatic control over which column to start in when used in a grid layout.
|
|
89952
91263
|
*/
|
|
@@ -90515,7 +91826,7 @@ type TimelineHistogramBaseConfig = {
|
|
|
90515
91826
|
* ...
|
|
90516
91827
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogramBase#config-partner)
|
|
90517
91828
|
*/
|
|
90518
|
-
partner?: TimelineBase
|
|
91829
|
+
partner?: TimelineBase|string
|
|
90519
91830
|
/**
|
|
90520
91831
|
* Specify plugins (an array of classes) in config
|
|
90521
91832
|
*/
|
|
@@ -92993,6 +94304,10 @@ type SchedulerExportDialogConfig = {
|
|
|
92993
94304
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/export/SchedulerExportDialog#config-bodyCls)
|
|
92994
94305
|
*/
|
|
92995
94306
|
bodyCls?: string|object
|
|
94307
|
+
/**
|
|
94308
|
+
* Set `true` to add a border to this container's element.
|
|
94309
|
+
*/
|
|
94310
|
+
border?: boolean
|
|
92996
94311
|
/**
|
|
92997
94312
|
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
92998
94313
|
* hierarchy when triggered.
|
|
@@ -93065,7 +94380,7 @@ type SchedulerExportDialogConfig = {
|
|
|
93065
94380
|
* ...
|
|
93066
94381
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/export/SchedulerExportDialog#config-color)
|
|
93067
94382
|
*/
|
|
93068
|
-
color?:
|
|
94383
|
+
color?: Color
|
|
93069
94384
|
/**
|
|
93070
94385
|
* Programmatic control over which column to start in when used in a grid layout.
|
|
93071
94386
|
*/
|
|
@@ -95052,8 +96367,8 @@ type SchedulerEventRenderingClassConfig = {
|
|
|
95052
96367
|
* @param {'tonal','filled','bordered','traced','outlined','indented','line','dashed','minimal','rounded','calendar','interday','gantt',null} detail.renderData.eventStyle The `eventStyle` of the event. Use this to apply custom styles to the event DOM element
|
|
95053
96368
|
* @param {string} detail.renderData.eventColor The `eventColor` of the event. Use this to set a custom color for the rendered event
|
|
95054
96369
|
* @param {string} detail.renderData.ariaLabel A description of the event details used for screen readers
|
|
95055
|
-
* @param {DomConfig[]} detail.renderData.children An array of DOM configs used as children to the `b-sch-event` element. Can be populated with additional DOM configs to have more control over contents.
|
|
95056
|
-
* @returns {string,DomConfig,DomConfig[]} A simple string,
|
|
96370
|
+
* @param {DomConfig[]} detail.renderData.children An array of DOM configs used as children to the `b-sch-event` element. Can be populated with additional DOM configs to have more control over contents. <h3>Using JSX (React)</h3> When using the Bryntum React wrapper, the event renderer can return JSX elements: ```javascript eventRenderer({ eventRecord, resourceRecord, renderData }) { return <MyEventComponent event={eventRecord} resource={resourceRecord} />; } ``` *Using JSX in the event renderer creates a React portal for each rendered event. For schedulers with many visible events or frequently re-rendered views, this may impact scrolling performance compared to returning plain strings or [DomConfig](https://bryntum.com/products/scheduler/docs/api/Core/helper/DomHelper#typedef-DomConfig) objects. Consider using JSX primarily for events that require complex interactive React components.*
|
|
96371
|
+
* @returns {string,DomConfig,DomConfig[]} A simple string, a DomConfig (or array thereof), or a JSX element when using React
|
|
95057
96372
|
*/
|
|
95058
96373
|
eventRenderer?: (detail: { eventRecord: EventModel, resourceRecord: ResourceModel, assignmentRecord: AssignmentModel, scheduler: Scheduler, renderData: { event: EventModel, cls: DomClassList|string, wrapperCls: DomClassList|string, iconCls: DomClassList|string, left: number, width: number, height: number, style: string|Record<string, string>, wrapperStyle: string|Record<string, string>, eventStyle: 'tonal'|'filled'|'bordered'|'traced'|'outlined'|'indented'|'line'|'dashed'|'minimal'|'rounded'|'calendar'|'interday'|'gantt'|null, eventColor: string, ariaLabel: string, children: DomConfig[] } }) => string|DomConfig|DomConfig[]
|
|
95059
96374
|
/**
|
|
@@ -98355,6 +99670,7 @@ type TimelineHistogramGroupingClassListeners = {
|
|
|
98355
99670
|
}
|
|
98356
99671
|
|
|
98357
99672
|
type TimelineHistogramGroupingClassFeaturesType = {
|
|
99673
|
+
ai: GridAI
|
|
98358
99674
|
aiFilter: AIFilter
|
|
98359
99675
|
cellCopyPaste: CellCopyPaste
|
|
98360
99676
|
cellEdit: CellEdit
|
|
@@ -98398,6 +99714,7 @@ type TimelineHistogramGroupingClassFeaturesType = {
|
|
|
98398
99714
|
}
|
|
98399
99715
|
|
|
98400
99716
|
type TimelineHistogramGroupingClassFeaturesConfigType = {
|
|
99717
|
+
ai?: string|boolean|GridAIConfig
|
|
98401
99718
|
aiFilter?: string|boolean|AIFilterConfig
|
|
98402
99719
|
cellCopyPaste?: string|boolean|CellCopyPasteConfig
|
|
98403
99720
|
cellEdit?: string|boolean|CellEditConfig
|
|
@@ -98553,6 +99870,10 @@ type TimelineHistogramGroupingClassConfig = {
|
|
|
98553
99870
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineHistogramGrouping#config-bodyCls)
|
|
98554
99871
|
*/
|
|
98555
99872
|
bodyCls?: string|object
|
|
99873
|
+
/**
|
|
99874
|
+
* Set `true` to add a border to this container's element.
|
|
99875
|
+
*/
|
|
99876
|
+
border?: boolean
|
|
98556
99877
|
/**
|
|
98557
99878
|
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
98558
99879
|
* hierarchy when triggered.
|
|
@@ -98618,7 +99939,7 @@ type TimelineHistogramGroupingClassConfig = {
|
|
|
98618
99939
|
* ...
|
|
98619
99940
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineHistogramGrouping#config-color)
|
|
98620
99941
|
*/
|
|
98621
|
-
color?:
|
|
99942
|
+
color?: Color
|
|
98622
99943
|
/**
|
|
98623
99944
|
* Programmatic control over which column to start in when used in a grid layout.
|
|
98624
99945
|
*/
|
|
@@ -99204,7 +100525,7 @@ type TimelineHistogramGroupingClassConfig = {
|
|
|
99204
100525
|
* ...
|
|
99205
100526
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineHistogramGrouping#config-partner)
|
|
99206
100527
|
*/
|
|
99207
|
-
partner?: TimelineBase
|
|
100528
|
+
partner?: TimelineBase|string
|
|
99208
100529
|
/**
|
|
99209
100530
|
* Specify plugins (an array of classes) in config
|
|
99210
100531
|
*/
|
|
@@ -102304,6 +103625,10 @@ type RecurrenceConfirmationPopupConfig = {
|
|
|
102304
103625
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/RecurrenceConfirmationPopup#config-bodyCls)
|
|
102305
103626
|
*/
|
|
102306
103627
|
bodyCls?: string|object
|
|
103628
|
+
/**
|
|
103629
|
+
* Set `true` to add a border to this container's element.
|
|
103630
|
+
*/
|
|
103631
|
+
border?: boolean
|
|
102307
103632
|
/**
|
|
102308
103633
|
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
102309
103634
|
* hierarchy when triggered.
|
|
@@ -102372,7 +103697,7 @@ type RecurrenceConfirmationPopupConfig = {
|
|
|
102372
103697
|
* ...
|
|
102373
103698
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/RecurrenceConfirmationPopup#config-color)
|
|
102374
103699
|
*/
|
|
102375
|
-
color?:
|
|
103700
|
+
color?: Color
|
|
102376
103701
|
/**
|
|
102377
103702
|
* Programmatic control over which column to start in when used in a grid layout.
|
|
102378
103703
|
*/
|
|
@@ -103657,6 +104982,10 @@ type RecurrenceEditorConfig = {
|
|
|
103657
104982
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/RecurrenceEditor#config-bodyCls)
|
|
103658
104983
|
*/
|
|
103659
104984
|
bodyCls?: string|object
|
|
104985
|
+
/**
|
|
104986
|
+
* Set `true` to add a border to this container's element.
|
|
104987
|
+
*/
|
|
104988
|
+
border?: boolean
|
|
103660
104989
|
/**
|
|
103661
104990
|
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
103662
104991
|
* hierarchy when triggered.
|
|
@@ -103725,7 +105054,7 @@ type RecurrenceEditorConfig = {
|
|
|
103725
105054
|
* ...
|
|
103726
105055
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/RecurrenceEditor#config-color)
|
|
103727
105056
|
*/
|
|
103728
|
-
color?:
|
|
105057
|
+
color?: Color
|
|
103729
105058
|
/**
|
|
103730
105059
|
* Programmatic control over which column to start in when used in a grid layout.
|
|
103731
105060
|
*/
|
|
@@ -104971,7 +106300,7 @@ type RecurrenceLegendButtonConfig = {
|
|
|
104971
106300
|
* ...
|
|
104972
106301
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/RecurrenceLegendButton#config-color)
|
|
104973
106302
|
*/
|
|
104974
|
-
color?:
|
|
106303
|
+
color?: Color
|
|
104975
106304
|
/**
|
|
104976
106305
|
* Programmatic control over which column to start in when used in a grid layout.
|
|
104977
106306
|
*/
|
|
@@ -106112,7 +107441,7 @@ type RecurrenceComboConfig = {
|
|
|
106112
107441
|
* ...
|
|
106113
107442
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/field/RecurrenceCombo#config-color)
|
|
106114
107443
|
*/
|
|
106115
|
-
color?:
|
|
107444
|
+
color?: Color
|
|
106116
107445
|
/**
|
|
106117
107446
|
* Programmatic control over which column to start in when used in a grid layout.
|
|
106118
107447
|
*/
|
|
@@ -107495,7 +108824,7 @@ type RecurrenceDaysComboConfig = {
|
|
|
107495
108824
|
* ...
|
|
107496
108825
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/field/RecurrenceDaysCombo#config-color)
|
|
107497
108826
|
*/
|
|
107498
|
-
color?:
|
|
108827
|
+
color?: Color
|
|
107499
108828
|
/**
|
|
107500
108829
|
* Programmatic control over which column to start in when used in a grid layout.
|
|
107501
108830
|
*/
|
|
@@ -108877,7 +110206,7 @@ type RecurrenceFrequencyComboConfig = {
|
|
|
108877
110206
|
* ...
|
|
108878
110207
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/field/RecurrenceFrequencyCombo#config-color)
|
|
108879
110208
|
*/
|
|
108880
|
-
color?:
|
|
110209
|
+
color?: Color
|
|
108881
110210
|
/**
|
|
108882
110211
|
* Programmatic control over which column to start in when used in a grid layout.
|
|
108883
110212
|
*/
|
|
@@ -110259,7 +111588,7 @@ type RecurrencePositionsComboConfig = {
|
|
|
110259
111588
|
* ...
|
|
110260
111589
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/field/RecurrencePositionsCombo#config-color)
|
|
110261
111590
|
*/
|
|
110262
|
-
color?:
|
|
111591
|
+
color?: Color
|
|
110263
111592
|
/**
|
|
110264
111593
|
* Programmatic control over which column to start in when used in a grid layout.
|
|
110265
111594
|
*/
|
|
@@ -111641,7 +112970,7 @@ type RecurrenceStopConditionComboConfig = {
|
|
|
111641
112970
|
* ...
|
|
111642
112971
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/field/RecurrenceStopConditionCombo#config-color)
|
|
111643
112972
|
*/
|
|
111644
|
-
color?:
|
|
112973
|
+
color?: Color
|
|
111645
112974
|
/**
|
|
111646
112975
|
* Programmatic control over which column to start in when used in a grid layout.
|
|
111647
112976
|
*/
|
|
@@ -112902,6 +114231,10 @@ type DayButtonsConfig = {
|
|
|
112902
114231
|
* Update assigned [record](https://bryntum.com/products/scheduler/docs/api/Core/widget/Container#config-record) automatically on field changes
|
|
112903
114232
|
*/
|
|
112904
114233
|
autoUpdateRecord?: boolean
|
|
114234
|
+
/**
|
|
114235
|
+
* Set `true` to add a border to this container's element.
|
|
114236
|
+
*/
|
|
114237
|
+
border?: boolean
|
|
112905
114238
|
/**
|
|
112906
114239
|
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
112907
114240
|
* hierarchy when triggered.
|
|
@@ -115234,7 +116567,7 @@ type EventColorPickerConfig = {
|
|
|
115234
116567
|
* ...
|
|
115235
116568
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/EventColorPicker#config-color)
|
|
115236
116569
|
*/
|
|
115237
|
-
color?:
|
|
116570
|
+
color?: Color
|
|
115238
116571
|
/**
|
|
115239
116572
|
* A callback function that will be called when the user selects a color in the picker.
|
|
115240
116573
|
* @param {object} event Object containing event data
|
|
@@ -116389,7 +117722,7 @@ type ProjectComboConfig = {
|
|
|
116389
117722
|
* ...
|
|
116390
117723
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ProjectCombo#config-color)
|
|
116391
117724
|
*/
|
|
116392
|
-
color?:
|
|
117725
|
+
color?: Color
|
|
116393
117726
|
/**
|
|
116394
117727
|
* Programmatic control over which column to start in when used in a grid layout.
|
|
116395
117728
|
*/
|
|
@@ -117778,7 +119111,7 @@ type ResourceComboConfig = {
|
|
|
117778
119111
|
* ...
|
|
117779
119112
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ResourceCombo#config-color)
|
|
117780
119113
|
*/
|
|
117781
|
-
color?:
|
|
119114
|
+
color?: Color
|
|
117782
119115
|
/**
|
|
117783
119116
|
* Programmatic control over which column to start in when used in a grid layout.
|
|
117784
119117
|
*/
|
|
@@ -119130,7 +120463,7 @@ type ResourceFilterConfig = {
|
|
|
119130
120463
|
* ...
|
|
119131
120464
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ResourceFilter#config-color)
|
|
119132
120465
|
*/
|
|
119133
|
-
color?:
|
|
120466
|
+
color?: Color
|
|
119134
120467
|
/**
|
|
119135
120468
|
* Programmatic control over which column to start in when used in a grid layout.
|
|
119136
120469
|
*/
|
|
@@ -120335,6 +121668,10 @@ type SchedulerDatePickerConfig = {
|
|
|
120335
121668
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/SchedulerDatePicker#config-bodyCls)
|
|
120336
121669
|
*/
|
|
120337
121670
|
bodyCls?: string|object
|
|
121671
|
+
/**
|
|
121672
|
+
* Set `true` to add a border to this container's element.
|
|
121673
|
+
*/
|
|
121674
|
+
border?: boolean
|
|
120338
121675
|
/**
|
|
120339
121676
|
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
120340
121677
|
* hierarchy when triggered.
|
|
@@ -120404,7 +121741,7 @@ type SchedulerDatePickerConfig = {
|
|
|
120404
121741
|
* ...
|
|
120405
121742
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/SchedulerDatePicker#config-color)
|
|
120406
121743
|
*/
|
|
120407
|
-
color?:
|
|
121744
|
+
color?: Color
|
|
120408
121745
|
/**
|
|
120409
121746
|
* Programmatic control over which column to start in when used in a grid layout.
|
|
120410
121747
|
*/
|
|
@@ -121748,6 +123085,10 @@ type UndoRedoConfig = {
|
|
|
121748
123085
|
* Update assigned [record](https://bryntum.com/products/scheduler/docs/api/Core/widget/Container#config-record) automatically on field changes
|
|
121749
123086
|
*/
|
|
121750
123087
|
autoUpdateRecord?: boolean
|
|
123088
|
+
/**
|
|
123089
|
+
* Set `true` to add a border to this container's element.
|
|
123090
|
+
*/
|
|
123091
|
+
border?: boolean
|
|
121751
123092
|
/**
|
|
121752
123093
|
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
121753
123094
|
* hierarchy when triggered.
|
|
@@ -122878,7 +124219,7 @@ type ViewPresetComboConfig = {
|
|
|
122878
124219
|
* ...
|
|
122879
124220
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-color)
|
|
122880
124221
|
*/
|
|
122881
|
-
color?:
|
|
124222
|
+
color?: Color
|
|
122882
124223
|
/**
|
|
122883
124224
|
* Programmatic control over which column to start in when used in a grid layout.
|
|
122884
124225
|
*/
|