@syncfusion/ej2-schedule 30.1.42 → 30.2.4-744881
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/.eslintrc.json +243 -262
- package/.gitleaksignore +4 -4
- package/README.md +83 -83
- package/dist/ej2-schedule.umd.min.js +1 -10
- package/dist/ej2-schedule.umd.min.js.map +1 -1
- package/dist/es6/ej2-schedule.es2015.js +94 -83
- package/dist/es6/ej2-schedule.es2015.js.map +1 -1
- package/dist/es6/ej2-schedule.es5.js +559 -548
- package/dist/es6/ej2-schedule.es5.js.map +1 -1
- package/helpers/e2e/index.js +3 -3
- package/helpers/e2e/recurrence-editor.js +13 -13
- package/helpers/e2e/schedule.js +13 -13
- package/license +9 -9
- package/package.json +42 -42
- package/src/recurrence-editor/recurrence-editor-model.d.ts +75 -75
- package/src/recurrence-editor/recurrence-editor.js +19 -19
- package/src/schedule/actions/drag.js +13 -13
- package/src/schedule/actions/keyboard.js +11 -11
- package/src/schedule/actions/resize.js +13 -13
- package/src/schedule/base/interface.d.ts +2 -2
- package/src/schedule/base/schedule-model.d.ts +864 -864
- package/src/schedule/base/schedule.js +19 -19
- package/src/schedule/event-renderer/agenda-base.js +13 -13
- package/src/schedule/event-renderer/month.js +13 -13
- package/src/schedule/event-renderer/timeline-view.js +13 -13
- package/src/schedule/event-renderer/vertical-view.js +13 -13
- package/src/schedule/event-renderer/year.js +13 -13
- package/src/schedule/models/event-settings-model.d.ts +156 -156
- package/src/schedule/models/event-settings.js +19 -19
- package/src/schedule/models/field-options-model.d.ts +22 -22
- package/src/schedule/models/field-options.js +19 -19
- package/src/schedule/models/fields-model.d.ts +92 -92
- package/src/schedule/models/fields.js +19 -19
- package/src/schedule/models/group-model.d.ts +48 -48
- package/src/schedule/models/group.js +19 -19
- package/src/schedule/models/header-rows-model.d.ts +22 -22
- package/src/schedule/models/header-rows.js +19 -19
- package/src/schedule/models/quick-info-templates-model.d.ts +37 -37
- package/src/schedule/models/quick-info-templates.js +19 -19
- package/src/schedule/models/resources-model.d.ts +85 -85
- package/src/schedule/models/resources.js +19 -19
- package/src/schedule/models/time-scale-model.d.ts +40 -40
- package/src/schedule/models/time-scale.js +19 -19
- package/src/schedule/models/toolbar-model.d.ts +187 -187
- package/src/schedule/models/toolbar.js +19 -19
- package/src/schedule/models/views-model.d.ts +361 -361
- package/src/schedule/models/views.js +19 -19
- package/src/schedule/models/work-hours-model.d.ts +16 -16
- package/src/schedule/models/work-hours.js +19 -19
- package/src/schedule/popups/quick-popups.js +1 -1
- package/src/schedule/renderer/agenda.js +13 -13
- package/src/schedule/renderer/day.js +13 -13
- package/src/schedule/renderer/header-renderer.js +11 -11
- package/src/schedule/renderer/month-agenda.js +13 -13
- package/src/schedule/renderer/month.js +22 -20
- package/src/schedule/renderer/timeline-month.js +13 -13
- package/src/schedule/renderer/timeline-view.js +13 -13
- package/src/schedule/renderer/timeline-year.js +13 -13
- package/src/schedule/renderer/vertical-view.js +13 -13
- package/src/schedule/renderer/view-base.d.ts +2 -0
- package/src/schedule/renderer/view-base.js +9 -0
- package/src/schedule/renderer/week.js +13 -13
- package/src/schedule/renderer/work-week.js +13 -13
- package/src/schedule/renderer/year.js +13 -13
- package/styles/bds-lite.css +0 -4446
- package/styles/bds-lite.scss +0 -18
- package/styles/bds.css +0 -5198
- package/styles/bds.scss +0 -20
- package/styles/bootstrap-dark-lite.css +0 -4228
- package/styles/bootstrap-dark-lite.scss +0 -18
- package/styles/bootstrap-dark.css +0 -4980
- package/styles/bootstrap-dark.scss +0 -20
- package/styles/bootstrap-lite.css +0 -4223
- package/styles/bootstrap-lite.scss +0 -18
- package/styles/bootstrap.css +0 -4975
- package/styles/bootstrap.scss +0 -20
- package/styles/bootstrap4-lite.css +0 -4270
- package/styles/bootstrap4-lite.scss +0 -18
- package/styles/bootstrap4.css +0 -5022
- package/styles/bootstrap4.scss +0 -20
- package/styles/bootstrap5-dark-lite.css +0 -4273
- package/styles/bootstrap5-dark-lite.scss +0 -18
- package/styles/bootstrap5-dark.css +0 -5025
- package/styles/bootstrap5-dark.scss +0 -20
- package/styles/bootstrap5-lite.css +0 -4273
- package/styles/bootstrap5-lite.scss +0 -18
- package/styles/bootstrap5.3-lite.css +0 -4319
- package/styles/bootstrap5.3-lite.scss +0 -18
- package/styles/bootstrap5.3.css +0 -5071
- package/styles/bootstrap5.3.scss +0 -20
- package/styles/bootstrap5.css +0 -5025
- package/styles/bootstrap5.scss +0 -20
- package/styles/fabric-dark-lite.css +0 -4198
- package/styles/fabric-dark-lite.scss +0 -18
- package/styles/fabric-dark.css +0 -4950
- package/styles/fabric-dark.scss +0 -20
- package/styles/fabric-lite.css +0 -4195
- package/styles/fabric-lite.scss +0 -18
- package/styles/fabric.css +0 -4947
- package/styles/fabric.scss +0 -20
- package/styles/fluent-dark-lite.css +0 -4261
- package/styles/fluent-dark-lite.scss +0 -18
- package/styles/fluent-dark.css +0 -5013
- package/styles/fluent-dark.scss +0 -20
- package/styles/fluent-lite.css +0 -4261
- package/styles/fluent-lite.scss +0 -18
- package/styles/fluent.css +0 -5013
- package/styles/fluent.scss +0 -20
- package/styles/fluent2-lite.css +0 -4505
- package/styles/fluent2-lite.scss +0 -18
- package/styles/fluent2.css +0 -5261
- package/styles/fluent2.scss +0 -20
- package/styles/highcontrast-light-lite.css +0 -4287
- package/styles/highcontrast-light-lite.scss +0 -18
- package/styles/highcontrast-light.css +0 -5039
- package/styles/highcontrast-light.scss +0 -20
- package/styles/highcontrast-lite.css +0 -4296
- package/styles/highcontrast-lite.scss +0 -18
- package/styles/highcontrast.css +0 -5048
- package/styles/highcontrast.scss +0 -20
- package/styles/material-dark-lite.css +0 -4275
- package/styles/material-dark-lite.scss +0 -18
- package/styles/material-dark.css +0 -5027
- package/styles/material-dark.scss +0 -20
- package/styles/material-lite.css +0 -4310
- package/styles/material-lite.scss +0 -18
- package/styles/material.css +0 -5062
- package/styles/material.scss +0 -20
- package/styles/material3-dark-lite.css +0 -4292
- package/styles/material3-dark-lite.scss +0 -18
- package/styles/material3-dark.css +0 -5045
- package/styles/material3-dark.scss +1 -21
- package/styles/material3-lite.css +0 -4294
- package/styles/material3-lite.scss +0 -18
- package/styles/material3.css +0 -5045
- package/styles/material3.scss +1 -21
- package/styles/tailwind-dark-lite.css +0 -4238
- package/styles/tailwind-dark-lite.scss +0 -18
- package/styles/tailwind-dark.css +0 -4990
- package/styles/tailwind-dark.scss +0 -20
- package/styles/tailwind-lite.css +0 -4238
- package/styles/tailwind-lite.scss +0 -18
- package/styles/tailwind.css +0 -4990
- package/styles/tailwind.scss +0 -20
- package/styles/tailwind3-lite.css +0 -4285
- package/styles/tailwind3-lite.scss +0 -18
- package/styles/tailwind3.css +0 -5037
- package/styles/tailwind3.scss +0 -20
- package/dist/ej2-schedule.min.js +0 -10
- package/dist/global/ej2-schedule.min.js +0 -11
- package/dist/global/ej2-schedule.min.js.map +0 -1
- package/dist/global/index.d.ts +0 -14
- package/styles/recurrence-editor/_all.scss +0 -2
- package/styles/recurrence-editor/_bds-definition.scss +0 -14
- package/styles/recurrence-editor/_bigger.scss +0 -133
- package/styles/recurrence-editor/_bootstrap-dark-definition.scss +0 -14
- package/styles/recurrence-editor/_bootstrap-definition.scss +0 -14
- package/styles/recurrence-editor/_bootstrap4-definition.scss +0 -14
- package/styles/recurrence-editor/_bootstrap5-dark-definition.scss +0 -1
- package/styles/recurrence-editor/_bootstrap5-definition.scss +0 -14
- package/styles/recurrence-editor/_bootstrap5.3-definition.scss +0 -14
- package/styles/recurrence-editor/_fabric-dark-definition.scss +0 -14
- package/styles/recurrence-editor/_fabric-definition.scss +0 -14
- package/styles/recurrence-editor/_fluent-dark-definition.scss +0 -1
- package/styles/recurrence-editor/_fluent-definition.scss +0 -14
- package/styles/recurrence-editor/_fluent2-definition.scss +0 -14
- package/styles/recurrence-editor/_fusionnew-definition.scss +0 -14
- package/styles/recurrence-editor/_highcontrast-definition.scss +0 -14
- package/styles/recurrence-editor/_highcontrast-light-definition.scss +0 -14
- package/styles/recurrence-editor/_layout.scss +0 -420
- package/styles/recurrence-editor/_material-dark-definition.scss +0 -14
- package/styles/recurrence-editor/_material-definition.scss +0 -14
- package/styles/recurrence-editor/_material3-dark-definition.scss +0 -1
- package/styles/recurrence-editor/_material3-definition.scss +0 -14
- package/styles/recurrence-editor/_tailwind-dark-definition.scss +0 -1
- package/styles/recurrence-editor/_tailwind-definition.scss +0 -14
- package/styles/recurrence-editor/_tailwind3-definition.scss +0 -14
- package/styles/recurrence-editor/_theme.scss +0 -1
- package/styles/recurrence-editor/bds.css +0 -537
- package/styles/recurrence-editor/bds.scss +0 -9
- package/styles/recurrence-editor/bootstrap-dark.css +0 -462
- package/styles/recurrence-editor/bootstrap-dark.scss +0 -9
- package/styles/recurrence-editor/bootstrap.css +0 -462
- package/styles/recurrence-editor/bootstrap.scss +0 -9
- package/styles/recurrence-editor/bootstrap4.css +0 -490
- package/styles/recurrence-editor/bootstrap4.scss +0 -9
- package/styles/recurrence-editor/bootstrap5-dark.css +0 -500
- package/styles/recurrence-editor/bootstrap5-dark.scss +0 -9
- package/styles/recurrence-editor/bootstrap5.3.css +0 -504
- package/styles/recurrence-editor/bootstrap5.3.scss +0 -9
- package/styles/recurrence-editor/bootstrap5.css +0 -500
- package/styles/recurrence-editor/bootstrap5.scss +0 -9
- package/styles/recurrence-editor/fabric-dark.css +0 -438
- package/styles/recurrence-editor/fabric-dark.scss +0 -9
- package/styles/recurrence-editor/fabric.css +0 -438
- package/styles/recurrence-editor/fabric.scss +0 -9
- package/styles/recurrence-editor/fluent-dark.css +0 -493
- package/styles/recurrence-editor/fluent-dark.scss +0 -9
- package/styles/recurrence-editor/fluent.css +0 -493
- package/styles/recurrence-editor/fluent.scss +0 -9
- package/styles/recurrence-editor/fluent2.css +0 -483
- package/styles/recurrence-editor/fluent2.scss +0 -9
- package/styles/recurrence-editor/highcontrast-light.css +0 -447
- package/styles/recurrence-editor/highcontrast-light.scss +0 -9
- package/styles/recurrence-editor/highcontrast.css +0 -447
- package/styles/recurrence-editor/highcontrast.scss +0 -9
- package/styles/recurrence-editor/material-dark.css +0 -487
- package/styles/recurrence-editor/material-dark.scss +0 -9
- package/styles/recurrence-editor/material.css +0 -491
- package/styles/recurrence-editor/material.scss +0 -9
- package/styles/recurrence-editor/material3-dark.css +0 -499
- package/styles/recurrence-editor/material3-dark.scss +0 -10
- package/styles/recurrence-editor/material3.css +0 -501
- package/styles/recurrence-editor/material3.scss +0 -10
- package/styles/recurrence-editor/tailwind-dark.css +0 -474
- package/styles/recurrence-editor/tailwind-dark.scss +0 -9
- package/styles/recurrence-editor/tailwind.css +0 -474
- package/styles/recurrence-editor/tailwind.scss +0 -9
- package/styles/recurrence-editor/tailwind3.css +0 -504
- package/styles/recurrence-editor/tailwind3.scss +0 -9
- package/styles/schedule/_all.scss +0 -2
- package/styles/schedule/_bds-definition.scss +0 -274
- package/styles/schedule/_bigger.scss +0 -801
- package/styles/schedule/_bootstrap-dark-definition.scss +0 -274
- package/styles/schedule/_bootstrap-definition.scss +0 -274
- package/styles/schedule/_bootstrap4-definition.scss +0 -277
- package/styles/schedule/_bootstrap5-dark-definition.scss +0 -1
- package/styles/schedule/_bootstrap5-definition.scss +0 -278
- package/styles/schedule/_bootstrap5.3-definition.scss +0 -278
- package/styles/schedule/_fabric-dark-definition.scss +0 -273
- package/styles/schedule/_fabric-definition.scss +0 -274
- package/styles/schedule/_fluent-dark-definition.scss +0 -1
- package/styles/schedule/_fluent-definition.scss +0 -278
- package/styles/schedule/_fluent2-definition.scss +0 -275
- package/styles/schedule/_fusionnew-definition.scss +0 -275
- package/styles/schedule/_highcontrast-definition.scss +0 -275
- package/styles/schedule/_highcontrast-light-definition.scss +0 -275
- package/styles/schedule/_layout.scss +0 -3870
- package/styles/schedule/_material-dark-definition.scss +0 -272
- package/styles/schedule/_material-definition.scss +0 -272
- package/styles/schedule/_material3-dark-definition.scss +0 -1
- package/styles/schedule/_material3-definition.scss +0 -277
- package/styles/schedule/_tailwind-dark-definition.scss +0 -1
- package/styles/schedule/_tailwind-definition.scss +0 -273
- package/styles/schedule/_tailwind3-definition.scss +0 -278
- package/styles/schedule/_theme.scss +0 -585
- package/styles/schedule/bds.css +0 -4793
- package/styles/schedule/bds.scss +0 -17
- package/styles/schedule/bootstrap-dark.css +0 -4575
- package/styles/schedule/bootstrap-dark.scss +0 -17
- package/styles/schedule/bootstrap.css +0 -4570
- package/styles/schedule/bootstrap.scss +0 -17
- package/styles/schedule/bootstrap4.css +0 -4617
- package/styles/schedule/bootstrap4.scss +0 -17
- package/styles/schedule/bootstrap5-dark.css +0 -4620
- package/styles/schedule/bootstrap5-dark.scss +0 -16
- package/styles/schedule/bootstrap5.3.css +0 -4666
- package/styles/schedule/bootstrap5.3.scss +0 -17
- package/styles/schedule/bootstrap5.css +0 -4620
- package/styles/schedule/bootstrap5.scss +0 -17
- package/styles/schedule/fabric-dark.css +0 -4545
- package/styles/schedule/fabric-dark.scss +0 -17
- package/styles/schedule/fabric.css +0 -4542
- package/styles/schedule/fabric.scss +0 -17
- package/styles/schedule/fluent-dark.css +0 -4608
- package/styles/schedule/fluent-dark.scss +0 -16
- package/styles/schedule/fluent.css +0 -4608
- package/styles/schedule/fluent.scss +0 -17
- package/styles/schedule/fluent2.css +0 -4853
- package/styles/schedule/fluent2.scss +0 -17
- package/styles/schedule/highcontrast-light.css +0 -4634
- package/styles/schedule/highcontrast-light.scss +0 -17
- package/styles/schedule/highcontrast.css +0 -4643
- package/styles/schedule/highcontrast.scss +0 -17
- package/styles/schedule/icons/_bds.scss +0 -220
- package/styles/schedule/icons/_bootstrap-dark.scss +0 -223
- package/styles/schedule/icons/_bootstrap.scss +0 -223
- package/styles/schedule/icons/_bootstrap4.scss +0 -217
- package/styles/schedule/icons/_bootstrap5-dark.scss +0 -1
- package/styles/schedule/icons/_bootstrap5.3.scss +0 -220
- package/styles/schedule/icons/_bootstrap5.scss +0 -220
- package/styles/schedule/icons/_fabric-dark.scss +0 -223
- package/styles/schedule/icons/_fabric.scss +0 -223
- package/styles/schedule/icons/_fluent-dark.scss +0 -1
- package/styles/schedule/icons/_fluent.scss +0 -220
- package/styles/schedule/icons/_fluent2.scss +0 -220
- package/styles/schedule/icons/_fusionnew.scss +0 -220
- package/styles/schedule/icons/_highcontrast-light.scss +0 -223
- package/styles/schedule/icons/_highcontrast.scss +0 -223
- package/styles/schedule/icons/_material-dark.scss +0 -223
- package/styles/schedule/icons/_material.scss +0 -223
- package/styles/schedule/icons/_material3-dark.scss +0 -1
- package/styles/schedule/icons/_material3.scss +0 -220
- package/styles/schedule/icons/_tailwind-dark.scss +0 -1
- package/styles/schedule/icons/_tailwind.scss +0 -220
- package/styles/schedule/icons/_tailwind3.scss +0 -220
- package/styles/schedule/material-dark.css +0 -4622
- package/styles/schedule/material-dark.scss +0 -17
- package/styles/schedule/material.css +0 -4657
- package/styles/schedule/material.scss +0 -17
- package/styles/schedule/material3-dark.css +0 -4640
- package/styles/schedule/material3-dark.scss +0 -17
- package/styles/schedule/material3.css +0 -4642
- package/styles/schedule/material3.scss +0 -18
- package/styles/schedule/tailwind-dark.css +0 -4585
- package/styles/schedule/tailwind-dark.scss +0 -16
- package/styles/schedule/tailwind.css +0 -4585
- package/styles/schedule/tailwind.scss +0 -17
- package/styles/schedule/tailwind3.css +0 -4632
- package/styles/schedule/tailwind3.scss +0 -17
- package/tslint.json +0 -111
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { Component, ModuleDeclaration, Property, Event, Animation, Collection, append } from '@syncfusion/ej2-base';
|
|
1
|
+
import { Component, ModuleDeclaration, Property, Event, Animation, Collection, append } from '@syncfusion/ej2-base';
|
|
2
2
|
import {ComponentModel} from '@syncfusion/ej2-base';
|
|
3
3
|
|
|
4
4
|
/**
|
|
@@ -7,924 +7,924 @@ import {ComponentModel} from '@syncfusion/ej2-base';
|
|
|
7
7
|
export interface ScheduleModel extends ComponentModel{
|
|
8
8
|
|
|
9
9
|
/**
|
|
10
|
-
* Sets the `width` of the Schedule component, accepting both string and number values.
|
|
11
|
-
*
|
|
12
|
-
* {% codeBlock src='schedule/width/index.md' %}{% endcodeBlock %}
|
|
13
|
-
*
|
|
14
|
-
* The string value can be either pixel or percentage format.
|
|
15
|
-
* When set to `auto`, the Schedule width gets auto-adjusted and display its content related to the viewable screen size.
|
|
16
|
-
*
|
|
17
|
-
* @default 'auto'
|
|
18
|
-
*/
|
|
19
|
-
width?: string | number;
|
|
20
|
-
|
|
21
|
-
/**
|
|
22
|
-
* Sets the `height` of the Schedule component, accepting both string and number values.
|
|
23
|
-
*
|
|
24
|
-
* {% codeBlock src='schedule/height/index.md' %}{% endcodeBlock %}
|
|
25
|
-
*
|
|
26
|
-
* The string type includes either pixel or percentage values.
|
|
27
|
-
* When `height` is set with specific pixel value, then the Schedule will be rendered to that specified space.
|
|
28
|
-
* In case, if `auto` value is set, then the height of the Schedule gets auto-adjusted within the given container.
|
|
29
|
-
*
|
|
30
|
-
* @default 'auto'
|
|
31
|
-
*/
|
|
32
|
-
height?: string | number;
|
|
33
|
-
|
|
34
|
-
/**
|
|
35
|
-
* When set to `false`, hides the header bar of the Schedule from UI. By default,
|
|
36
|
-
* the header bar holds the date and view navigation options, to which the user can add their own custom items onto it.
|
|
37
|
-
*
|
|
38
|
-
* @default true
|
|
39
|
-
*/
|
|
40
|
-
showHeaderBar?: boolean;
|
|
41
|
-
|
|
42
|
-
/**
|
|
43
|
-
* When set to `false`, hides the current time indicator from the Schedule. Otherwise,
|
|
44
|
-
* it visually depicts the live current system time appropriately on the user interface.
|
|
45
|
-
*
|
|
46
|
-
* @default true
|
|
47
|
-
*/
|
|
48
|
-
showTimeIndicator?: boolean;
|
|
49
|
-
|
|
50
|
-
/**
|
|
51
|
-
* Defines whether to enable date navigations via swipe in touch devices or not.
|
|
52
|
-
*
|
|
53
|
-
* @default true
|
|
54
|
-
*/
|
|
55
|
-
allowSwiping?: boolean;
|
|
56
|
-
|
|
57
|
-
/**
|
|
58
|
-
* Specifies whether overlapping appointments are allowed within the same time slot in the Scheduler.
|
|
59
|
-
*
|
|
60
|
-
* @remarks
|
|
61
|
-
* When set to `false`, the Scheduler enforces restrictions to prevent creating or displaying overlapping appointments within the same time duration.
|
|
62
|
-
* This setting includes the following limitations:
|
|
63
|
-
*
|
|
64
|
-
* - **Initial Loading**: The alert for overlapping appointments will not display during the initial load. Overlapping events will be ignored in rendering, including occurrences.
|
|
65
|
-
*
|
|
66
|
-
* - **Dynamic Add/Edit**: When adding or editing events dynamically, overlapping validation is performed. If an overlap is detected for a single event, an alert will be shown, and the event will not be saved.
|
|
67
|
-
*
|
|
68
|
-
* For recurring events, an alert will be displayed, and the event will not be saved. To save recurring events while ignoring overlapping occurrences, trigger the `PopupOpen` event. The `Data` field will contain the parent recurrence data, and the `overlapEvents` field will contain the overlap events. Using these details, users can include exceptions in the recurrence events and save them with the `addEvent` method.
|
|
69
|
-
*
|
|
70
|
-
* - **Out-of-Date-Range Events**: The `allowOverlap` setting only prevents overlaps for events within the current view date range. To validate overlap events outside the current date range, use the `actionBegin` event to send a request to the server for validation and return a promise-based response. Assign this promise response to the `promise` field in `ActionEventArgs` to handle asynchronous server validation.
|
|
71
|
-
*
|
|
72
|
-
* @default true
|
|
73
|
-
*/
|
|
74
|
-
allowOverlap?: boolean;
|
|
75
|
-
|
|
76
|
-
/**
|
|
77
|
-
* Specifies the number of additional rows or columns to render outside the visible area during virtual scrolling.
|
|
78
|
-
* This property helps in achieving smoother scrolling by pre-loading data just outside the visible region.
|
|
79
|
-
*
|
|
80
|
-
* @remarks
|
|
81
|
-
* The default value is 3. Increasing this value can result in smoother scrolling but may impact performance
|
|
82
|
-
* with larger datasets. Decreasing it can improve performance but may cause more frequent data fetches during scrolling.
|
|
83
|
-
* This property only takes effect when `allowVirtualScrolling` is enabled for the current view.
|
|
84
|
-
*
|
|
85
|
-
* @default 3
|
|
86
|
-
*/
|
|
87
|
-
overscanCount?: number;
|
|
88
|
-
|
|
89
|
-
/**
|
|
90
|
-
* To render the custom toolbar items, the `toolbarItems` property can be used. It contains built-in and custom toolbar items.
|
|
91
|
-
* To avail the built-in toolbar items, the below string values are assigned to the `name` property of the `ToolbarItemModel`.
|
|
92
|
-
* * `Previous`: Schedule component navigates to the previous date from the current date.
|
|
93
|
-
* * `Next`: Schedule component navigates to the next date from the current date.
|
|
94
|
-
* * `Today`: Schedule component navigates to the current date from any date.
|
|
95
|
-
* * `Views`: Schedule component render the defined view options in the toolbar. If view option is not defined, then it will render default view options in the Schedule.
|
|
96
|
-
* * `DateRangeText`: Schedule component displays the current date text range.
|
|
97
|
-
* * `NewEvent`: Schedule component render the icon to add a new event.
|
|
98
|
-
*
|
|
99
|
-
* @default []
|
|
100
|
-
*/
|
|
101
|
-
toolbarItems?: ToolbarItemModel[]
|
|
102
|
-
|
|
103
|
-
/**
|
|
104
|
-
* To set the active view on scheduler, the `currentView` property can be used and it usually accepts either of the following available
|
|
105
|
-
* view options. The view option specified in this property will be initially loaded on the schedule.
|
|
106
|
-
* * `Day`: Denotes Day view of the scheduler.
|
|
107
|
-
* * `Week`: Denotes Week view of the scheduler.
|
|
108
|
-
* * `WorkWeek`: Denotes Work Week view of the scheduler.
|
|
109
|
-
* * `Month`: Denotes Month view of the scheduler.
|
|
110
|
-
* * `Year`: Denotes Year view of the scheduler.
|
|
111
|
-
* * `Agenda`: Denotes Agenda view of the scheduler.
|
|
112
|
-
* * `MonthAgenda`: Denotes Month Agenda view of the scheduler.
|
|
113
|
-
* * `TimelineDay`: Denotes Timeline Day view of the scheduler.
|
|
114
|
-
* * `TimelineWeek`: Denotes Timeline Week view of the scheduler.
|
|
115
|
-
* * `TimelineWorkWeek`: Denotes Timeline Work Week view of the scheduler.
|
|
116
|
-
* * `TimelineMonth`: Denotes Timeline Month view of the scheduler.
|
|
117
|
-
* * `TimelineYear`: Denotes Timeline Year view of the scheduler.
|
|
118
|
-
*
|
|
119
|
-
* {% codeBlock src='schedule/currentView/index.md' %}{% endcodeBlock %}
|
|
120
|
-
*
|
|
121
|
-
* @default 'Week'
|
|
122
|
-
*/
|
|
123
|
-
currentView?: View;
|
|
124
|
-
|
|
125
|
-
/**
|
|
126
|
-
* This property holds the views collection and its configurations. It accepts either the array of view names or the array of view
|
|
127
|
-
* objects that holds different configurations for each views. By default,
|
|
128
|
-
* Schedule displays all the views namely `Day`, `Week`, `Work Week`, `Month` and `Agenda`.
|
|
129
|
-
*
|
|
130
|
-
* Example for array of views:
|
|
131
|
-
* {% codeBlock src="schedule/views/index.md" %}{% endcodeBlock %}
|
|
132
|
-
*
|
|
133
|
-
* Example for array of view objects:
|
|
134
|
-
* {% codeBlock src='schedule/viewOption/index.md' %}{% endcodeBlock %}
|
|
135
|
-
*
|
|
136
|
-
* @default '["Day", "Week", "WorkWeek", "Month", "Agenda"]'
|
|
137
|
-
*/
|
|
138
|
-
views?: View[] | ViewsModel[];
|
|
139
|
-
|
|
140
|
-
/**
|
|
141
|
-
* To mark the active (current) date on the Schedule, `selectedDate` property can be defined.
|
|
142
|
-
* Usually, it defaults to the current System date.
|
|
143
|
-
*
|
|
144
|
-
* {% codeBlock src='schedule/selectedDate/index.md' %}{% endcodeBlock %}
|
|
145
|
-
*
|
|
146
|
-
* @default 'new Date()'
|
|
147
|
-
* @aspDefaultValue DateTime.Now
|
|
148
|
-
*/
|
|
149
|
-
selectedDate?: Date;
|
|
150
|
-
|
|
151
|
-
/**
|
|
152
|
-
* To define the minimum date on the Schedule, `minDate` property can be defined.
|
|
153
|
-
* Usually, it defaults to the new Date(1900, 0, 1).
|
|
154
|
-
*
|
|
155
|
-
* {% codeBlock src='schedule/minDate/index.md' %}{% endcodeBlock %}
|
|
156
|
-
*
|
|
157
|
-
* @default new Date(1900, 0, 1)
|
|
158
|
-
* @aspDefaultValue new DateTime(1900, 1, 1)
|
|
159
|
-
*/
|
|
160
|
-
minDate?: Date;
|
|
161
|
-
|
|
162
|
-
/**
|
|
163
|
-
* To define the maximum date on the Schedule, `maxDate` property can be defined.
|
|
164
|
-
* Usually, it defaults to the new Date(2099, 11, 31).
|
|
165
|
-
*
|
|
166
|
-
* {% codeBlock src='schedule/maxDate/index.md' %}{% endcodeBlock %}
|
|
167
|
-
*
|
|
168
|
-
* @default new Date(2099, 11, 31)
|
|
169
|
-
* @aspDefaultValue new DateTime(2099, 12, 31)
|
|
170
|
-
*/
|
|
171
|
-
maxDate?: Date;
|
|
172
|
-
|
|
173
|
-
/**
|
|
174
|
-
* By default, Schedule follows the date-format as per the default culture assigned to it.
|
|
175
|
-
* It is also possible to manually set specific date format by using the `dateFormat` property.
|
|
176
|
-
*
|
|
177
|
-
* {% codeBlock src='schedule/dateFormat/index.md' %}{% endcodeBlock %}
|
|
178
|
-
*
|
|
179
|
-
* The format of the date range label in the header bar depends on the `dateFormat` value or else based on the
|
|
180
|
-
* locale assigned to the Schedule.
|
|
181
|
-
*
|
|
182
|
-
* @default null
|
|
183
|
-
*/
|
|
184
|
-
dateFormat?: string;
|
|
185
|
-
|
|
186
|
-
/**
|
|
187
|
-
* It allows the Scheduler to display in other calendar modes.
|
|
188
|
-
* By default, Scheduler is displayed in `Gregorian` calendar mode.
|
|
189
|
-
*
|
|
190
|
-
* {% codeBlock src='schedule/calendarMode/index.md' %}{% endcodeBlock %}
|
|
191
|
-
*
|
|
192
|
-
* To change the mode, you can set either `Gregorian` or `Islamic` as a value to this `calendarMode` property.
|
|
193
|
-
*
|
|
194
|
-
* @default 'Gregorian'
|
|
195
|
-
*/
|
|
196
|
-
calendarMode?: CalendarType;
|
|
197
|
-
|
|
198
|
-
/**
|
|
199
|
-
* When set to `false`, it hides the weekend days of a week from the Schedule. The days which are not defined in the working days
|
|
200
|
-
* collection are usually treated as weekend days.
|
|
201
|
-
*
|
|
202
|
-
* Note: By default, this option is not applicable on `Work Week` view.
|
|
203
|
-
* For example, if the working days are defined as [1, 2, 3, 4], then the remaining days of that week will be considered as
|
|
204
|
-
* the weekend days and will be hidden on all the views.
|
|
205
|
-
*
|
|
206
|
-
* @default true
|
|
207
|
-
*/
|
|
208
|
-
showWeekend?: boolean;
|
|
209
|
-
|
|
210
|
-
/**
|
|
211
|
-
* This option allows the user to set the first day of a week on Schedule. It should be based on the locale set to it and each culture
|
|
212
|
-
* defines its own first day of week values. If needed, the user can set it manually on his own by defining the value through
|
|
213
|
-
* this property. It usually accepts the integer values, whereby 0 is always denoted as Sunday, 1 as Monday and so on.
|
|
214
|
-
*
|
|
215
|
-
* {% codeBlock src='schedule/firstDayOfWeek/index.md' %}{% endcodeBlock %}
|
|
216
|
-
*
|
|
217
|
-
* @default 0
|
|
218
|
-
*/
|
|
219
|
-
firstDayOfWeek?: number;
|
|
220
|
-
|
|
221
|
-
/**
|
|
222
|
-
* It allows the Scheduler to display week numbers based on following available week options. The week
|
|
223
|
-
* option specified in this property will be initially loaded on the schedule.
|
|
224
|
-
* * `FirstDay`: Denotes that the first week of the year starts on the first day of the year and ends before the following designated first day of the week.
|
|
225
|
-
* * `FirstFourDayWeek`:Denotes that the first week of the year is the first week with four or more days before the designated first day of the week.
|
|
226
|
-
* * `FirstFullWeek`: Denotes that the first week of the year begins on the first occurrence of the designated first day of the week on or after the first day of the year.
|
|
227
|
-
*
|
|
228
|
-
* {% codeBlock src='schedule/weekRule/index.md' %}{% endcodeBlock %}
|
|
229
|
-
*
|
|
230
|
-
* @default 'FirstDay'
|
|
231
|
-
*/
|
|
232
|
-
weekRule?: WeekRule;
|
|
233
|
-
|
|
234
|
-
/**
|
|
235
|
-
* It is used to set the working days on Schedule. The only days that are defined in this collection will be rendered on the `workWeek`
|
|
236
|
-
* view whereas on other views, it will display all the usual days and simply highlights the working days with different shade.
|
|
237
|
-
*
|
|
238
|
-
* {% codeBlock src='schedule/workDays/index.md' %}{% endcodeBlock %}
|
|
239
|
-
*
|
|
240
|
-
* @default '[1, 2, 3, 4, 5]'
|
|
241
|
-
* @aspType int[]
|
|
242
|
-
*/
|
|
243
|
-
workDays?: number[];
|
|
244
|
-
|
|
245
|
-
/**
|
|
246
|
-
* This option allows the user to set the number of months count to be displayed on the Schedule.
|
|
247
|
-
*
|
|
248
|
-
* {% codeBlock src='schedule/monthsCount/index.md' %}{% endcodeBlock %}
|
|
249
|
-
*
|
|
250
|
-
* @default 12
|
|
251
|
-
* @aspType int
|
|
252
|
-
*/
|
|
253
|
-
monthsCount?: number;
|
|
254
|
-
|
|
255
|
-
/**
|
|
256
|
-
* It is used to specify the starting hour, from which the Schedule starts to display. It accepts the time string in a short skeleton
|
|
257
|
-
* format and also, hides the time beyond the specified start time.
|
|
258
|
-
*
|
|
259
|
-
* {% codeBlock src='schedule/startHour/index.md' %}{% endcodeBlock %}
|
|
260
|
-
*
|
|
261
|
-
* @default '00:00'
|
|
262
|
-
*/
|
|
263
|
-
startHour?: string;
|
|
264
|
-
|
|
265
|
-
/**
|
|
266
|
-
* It is used to specify the end hour, at which the Schedule ends. It too accepts the time string in a short skeleton format.
|
|
267
|
-
*
|
|
268
|
-
* {% codeBlock src='schedule/endHour/index.md' %}{% endcodeBlock %}
|
|
269
|
-
*
|
|
270
|
-
* @default '24:00'
|
|
271
|
-
*/
|
|
272
|
-
endHour?: string;
|
|
273
|
-
|
|
274
|
-
/**
|
|
275
|
-
* By default, Schedule follows the time-format as per the default culture assigned to it.
|
|
276
|
-
* It is also possible to manually set specific time format by using the `timeFormat` property.
|
|
277
|
-
*
|
|
278
|
-
* {% codeBlock src='schedule/timeFormat/index.md' %}{% endcodeBlock %}
|
|
279
|
-
*
|
|
280
|
-
* @default null
|
|
281
|
-
*/
|
|
282
|
-
timeFormat?: string;
|
|
283
|
-
|
|
284
|
-
/**
|
|
285
|
-
* Specifies whether to enable the rendering of untrusted HTML values in the Schedule component.
|
|
286
|
-
* When this property is enabled, the component will sanitize any suspected untrusted strings and scripts before rendering them.
|
|
287
|
-
*
|
|
288
|
-
* @default true
|
|
289
|
-
*/
|
|
290
|
-
enableHtmlSanitizer?: boolean;
|
|
291
|
-
|
|
292
|
-
/**
|
|
293
|
-
* When set to `true`, If valid, the scroll on the all day row is activated when the all day row
|
|
294
|
-
* height reaches the max height when the all day row is expanded.
|
|
295
|
-
*
|
|
296
|
-
* @default false
|
|
297
|
-
*/
|
|
298
|
-
enableAllDayScroll?: boolean;
|
|
299
|
-
|
|
300
|
-
/**
|
|
301
|
-
* When set to `true`, the header view navigations are listed under the popup and if we enable resource grouping, the compact view will be enabled.
|
|
302
|
-
*
|
|
303
|
-
* @default false
|
|
304
|
-
*/
|
|
305
|
-
enableAdaptiveUI?: boolean;
|
|
306
|
-
|
|
307
|
-
/**
|
|
308
|
-
* When set to `true`, allows the resizing of appointments. It allows the rescheduling of appointments either by changing the
|
|
309
|
-
* start or end time by dragging the event resize handlers.
|
|
310
|
-
*
|
|
311
|
-
* @default true
|
|
312
|
-
*/
|
|
313
|
-
allowResizing?: boolean;
|
|
314
|
-
|
|
315
|
-
/**
|
|
316
|
-
* The working hours should be highlighted on Schedule with different color shade and an additional option must be provided to
|
|
317
|
-
* highlight it or not. This functionality is handled through `workHours` property and the start work hour should be 9 AM by default
|
|
318
|
-
* and end work hour should point to 6 PM. The start and end working hours needs to be provided as Time value of short skeleton type.
|
|
319
|
-
*
|
|
320
|
-
* {% codeBlock src='schedule/workHours/index.md' %}{% endcodeBlock %}
|
|
321
|
-
*
|
|
322
|
-
* @default { highlight: true, start: '09:00', end: '18:00' }
|
|
323
|
-
*/
|
|
324
|
-
workHours?: WorkHoursModel;
|
|
325
|
-
|
|
326
|
-
/**
|
|
327
|
-
* Allows to set different time duration on Schedule along with the customized grid count. It also has template option to
|
|
328
|
-
* customize the time slots with required time values in its own format.
|
|
329
|
-
*
|
|
330
|
-
* {% codeBlock src='schedule/timeScale/index.md' %}{% endcodeBlock %}
|
|
331
|
-
*
|
|
332
|
-
* @default { enable: true, interval: 60, slotCount: 2, majorSlotTemplate: null, minorSlotTemplate: null }
|
|
333
|
-
*/
|
|
334
|
-
timeScale?: TimeScaleModel;
|
|
335
|
-
|
|
336
|
-
/**
|
|
337
|
-
* When set to `true`, allows the keyboard interaction to take place on Schedule.
|
|
338
|
-
*
|
|
339
|
-
* @default true
|
|
340
|
-
*/
|
|
341
|
-
allowKeyboardInteraction?: boolean;
|
|
342
|
-
|
|
343
|
-
/**
|
|
344
|
-
* When set to `true`, allows the appointments to move over the time slots. When an appointment is dragged, both its start
|
|
345
|
-
* and end time tends to change simultaneously allowing it to reschedule the appointment on some other time.
|
|
346
|
-
*
|
|
347
|
-
* @default true
|
|
348
|
-
*/
|
|
349
|
-
allowDragAndDrop?: boolean;
|
|
350
|
-
|
|
351
|
-
/**
|
|
352
|
-
* It accepts either the string or HTMLElement as template design content and parse it appropriately before displaying it onto
|
|
353
|
-
* the date header cells. The field that can be accessed via this template is `date`.
|
|
354
|
-
*
|
|
355
|
-
* {% codeBlock src='schedule/dateHeaderTemplate/index.md' %}{% endcodeBlock %}
|
|
356
|
-
*
|
|
357
|
-
* @default null
|
|
358
|
-
* @angularType string | object
|
|
359
|
-
* @reactType string | function | JSX.Element
|
|
360
|
-
* @vueType string | function
|
|
361
|
-
* @aspType string
|
|
362
|
-
*/
|
|
363
|
-
dateHeaderTemplate?: string | Function;
|
|
364
|
-
|
|
365
|
-
/**
|
|
366
|
-
* It accepts either the string or HTMLElement as template design content and parse it appropriately before displaying it onto the header date range.
|
|
367
|
-
*
|
|
368
|
-
* @default null
|
|
369
|
-
* @angularType string | object
|
|
370
|
-
* @reactType string | function | JSX.Element
|
|
371
|
-
* @vueType string | function
|
|
372
|
-
* @aspType string
|
|
373
|
-
*/
|
|
374
|
-
dateRangeTemplate?: string | Function;
|
|
375
|
-
|
|
376
|
-
/**
|
|
377
|
-
* It accepts either the string or HTMLElement as template design content and parse it appropriately before displaying it onto
|
|
378
|
-
* the month date cells. This template is only applicable for month view day cells.
|
|
379
|
-
*
|
|
380
|
-
* {% codeBlock src='schedule/cellHeaderTemplate/index.md' %}{% endcodeBlock %}
|
|
381
|
-
*
|
|
382
|
-
* @default null
|
|
383
|
-
* @angularType string | object
|
|
384
|
-
* @reactType string | function | JSX.Element
|
|
385
|
-
* @vueType string | function
|
|
386
|
-
* @aspType string
|
|
387
|
-
*/
|
|
388
|
-
cellHeaderTemplate?: string | Function;
|
|
389
|
-
|
|
390
|
-
/**
|
|
391
|
-
* It accepts either the string or HTMLElement as template design content and parse it appropriately before displaying it onto
|
|
392
|
-
* the day header cells. This template is only applicable for year view header cells.
|
|
393
|
-
*
|
|
394
|
-
* {% codeBlock src='schedule/dayHeaderTemplate/index.md' %}{% endcodeBlock %}
|
|
395
|
-
*
|
|
396
|
-
* @default null
|
|
397
|
-
* @angularType string | object
|
|
398
|
-
* @reactType string | function | JSX.Element
|
|
399
|
-
* @vueType string | function
|
|
400
|
-
* @aspType string
|
|
401
|
-
*/
|
|
402
|
-
dayHeaderTemplate?: string | Function;
|
|
403
|
-
|
|
404
|
-
/**
|
|
405
|
-
* It accepts either the string or HTMLElement as template design content and parse it appropriately before displaying it onto
|
|
406
|
-
* the month header cells. This template is only applicable for year view header cells.
|
|
407
|
-
*
|
|
408
|
-
* {% codeBlock src='schedule/monthHeaderTemplate/index.md' %}{% endcodeBlock %}
|
|
409
|
-
*
|
|
410
|
-
* @default null
|
|
411
|
-
* @angularType string | object
|
|
412
|
-
* @reactType string | function | JSX.Element
|
|
413
|
-
* @vueType string | function
|
|
414
|
-
* @aspType string
|
|
415
|
-
*/
|
|
416
|
-
monthHeaderTemplate?: string | Function;
|
|
417
|
-
|
|
418
|
-
/**
|
|
419
|
-
* The template option which is used to render the customized work cells on the Schedule. Here, the template accepts either
|
|
420
|
-
* the string or HTMLElement as template design and then the parsed design is displayed onto the work cells.
|
|
421
|
-
* The fields accessible via template are as follows.
|
|
422
|
-
* * `date`: Returns the date of the cell.
|
|
423
|
-
* * `groupIndex`: Returns the group index of the cell.
|
|
424
|
-
* * `type`: Returns the type of the work cell.
|
|
425
|
-
*
|
|
426
|
-
* Refer to the below code snippet.
|
|
427
|
-
*
|
|
428
|
-
* {% codeBlock src='schedule/cellTemplate/index.md' %}{% endcodeBlock %}
|
|
429
|
-
*
|
|
430
|
-
* @default null
|
|
431
|
-
* @angularType string | object
|
|
432
|
-
* @reactType string | function | JSX.Element
|
|
433
|
-
* @vueType string | function
|
|
434
|
-
* @aspType string
|
|
435
|
-
*/
|
|
436
|
-
cellTemplate?: string | Function;
|
|
437
|
-
|
|
438
|
-
/**
|
|
439
|
-
* When set to `true`, makes the Schedule to render in a read only mode. No CRUD actions will be allowed at this time.
|
|
440
|
-
*
|
|
441
|
-
* @default false
|
|
442
|
-
*/
|
|
443
|
-
readonly?: boolean;
|
|
444
|
-
|
|
445
|
-
/**
|
|
446
|
-
* When set to `true`, displays a quick popup with cell or event details on single clicking over the cells or on events.
|
|
447
|
-
* By default, it is set to `true`.
|
|
448
|
-
*
|
|
449
|
-
* @default true
|
|
450
|
-
*/
|
|
451
|
-
showQuickInfo?: boolean;
|
|
452
|
-
|
|
453
|
-
/**
|
|
454
|
-
* This property helps user to add/edit the event in inline. By default, it is set to `false`.
|
|
455
|
-
*
|
|
456
|
-
* @default false
|
|
457
|
-
*/
|
|
458
|
-
allowInline?: boolean;
|
|
459
|
-
|
|
460
|
-
/**
|
|
461
|
-
* This property helps user to allow/prevent the selection of multiple cells. By default, it is set to `true`.
|
|
462
|
-
*
|
|
463
|
-
* @default true
|
|
464
|
-
*/
|
|
465
|
-
allowMultiCellSelection?: boolean;
|
|
466
|
-
|
|
467
|
-
/**
|
|
468
|
-
* This property helps user to allow/prevent the selection of multiple days(rows). By default, it is set to `true`.
|
|
469
|
-
*
|
|
470
|
-
* @default true
|
|
471
|
-
*/
|
|
472
|
-
allowMultiRowSelection?: boolean;
|
|
473
|
-
|
|
474
|
-
/**
|
|
475
|
-
* This property helps to show quick popup after multiple cell selection. By default, it is set to `false`.
|
|
476
|
-
*
|
|
477
|
-
* @default false
|
|
478
|
-
*/
|
|
479
|
-
quickInfoOnSelectionEnd?: boolean;
|
|
480
|
-
|
|
481
|
-
/**
|
|
482
|
-
* When set to `true`, displays the week number of the current view date range. By default, it is set to `false`.
|
|
483
|
-
*
|
|
484
|
-
* @default false
|
|
485
|
-
*/
|
|
486
|
-
showWeekNumber?: boolean;
|
|
487
|
-
|
|
488
|
-
/**
|
|
489
|
-
* when set to `true`, allows the height of the work-cells to adjust automatically
|
|
490
|
-
* based on the number of appointments present in those time ranges.
|
|
491
|
-
*
|
|
492
|
-
* @default false
|
|
493
|
-
*/
|
|
494
|
-
rowAutoHeight?: boolean;
|
|
495
|
-
|
|
496
|
-
/**
|
|
497
|
-
* This property helps to drag the multiple selected events. By default, it is set to `false`.
|
|
498
|
-
*
|
|
499
|
-
* @default false
|
|
500
|
-
*/
|
|
501
|
-
allowMultiDrag?: boolean;
|
|
502
|
-
|
|
503
|
-
/**
|
|
504
|
-
* This property helps render the year view customized months. By default, it is set to `0`.
|
|
505
|
-
*
|
|
506
|
-
* {% codeBlock src='schedule/firstMonthOfYear/index.md' %}{% endcodeBlock %}
|
|
507
|
-
*
|
|
508
|
-
* @default 0
|
|
509
|
-
*/
|
|
510
|
-
firstMonthOfYear?: number;
|
|
511
|
-
|
|
512
|
-
/**
|
|
513
|
-
* The template option to render the customized editor window. The form elements defined within this template should be accompanied
|
|
514
|
-
* with `e-field` class, so as to fetch and process it from internally.
|
|
515
|
-
*
|
|
516
|
-
* {% codeBlock src='schedule/editorTemplate/index.md' %}{% endcodeBlock %}
|
|
517
|
-
*
|
|
518
|
-
* @default null
|
|
519
|
-
* @angularType string | object
|
|
520
|
-
* @reactType string | function | JSX.Element
|
|
521
|
-
* @vueType string | function
|
|
522
|
-
* @aspType string
|
|
523
|
-
*/
|
|
524
|
-
editorTemplate?: string | Function;
|
|
525
|
-
|
|
526
|
-
/**
|
|
527
|
-
* The template option to render the customized header of the editor window.
|
|
528
|
-
*
|
|
529
|
-
*
|
|
530
|
-
* @default null
|
|
531
|
-
* @angularType string | object
|
|
532
|
-
* @reactType string | function | JSX.Element
|
|
533
|
-
* @vueType string | function
|
|
534
|
-
* @aspType string
|
|
535
|
-
*/
|
|
536
|
-
editorHeaderTemplate?: string | Function;
|
|
537
|
-
|
|
538
|
-
/**
|
|
539
|
-
* The template option to render the customized footer of the editor window.
|
|
540
|
-
*
|
|
541
|
-
*
|
|
542
|
-
* @default null
|
|
543
|
-
* @angularType string | object
|
|
544
|
-
* @reactType string | function | JSX.Element
|
|
545
|
-
* @vueType string | function
|
|
546
|
-
* @aspType string
|
|
547
|
-
*/
|
|
548
|
-
editorFooterTemplate?: string | Function;
|
|
549
|
-
|
|
550
|
-
/**
|
|
551
|
-
* The template option to customize the quick window. The three sections of the quick popup whereas the header, content,
|
|
552
|
-
* and footer can be easily customized with individual template option.
|
|
553
|
-
*
|
|
554
|
-
* {% codeBlock src='schedule/quickInfoTemplates/index.md' %}{% endcodeBlock %}
|
|
555
|
-
*
|
|
556
|
-
* @default null
|
|
557
|
-
*/
|
|
558
|
-
quickInfoTemplates?: QuickInfoTemplatesModel;
|
|
559
|
-
|
|
560
|
-
/**
|
|
561
|
-
* Sets the number of days to be displayed by default in Agenda View and in case of virtual scrolling,
|
|
562
|
-
* the number of days will be fetched on each scroll-end based on this count.
|
|
563
|
-
*
|
|
564
|
-
* {% codeBlock src='schedule/agendaDaysCount/index.md' %}{% endcodeBlock %}
|
|
565
|
-
*
|
|
566
|
-
* @default 7
|
|
567
|
-
*/
|
|
568
|
-
agendaDaysCount?: number;
|
|
569
|
-
|
|
570
|
-
/**
|
|
571
|
-
* The days which does not has even a single event to display will be hidden from the UI of Agenda View by default.
|
|
572
|
-
* When this property is set to `false`, the empty dates will also be displayed on the Schedule.
|
|
573
|
-
*
|
|
574
|
-
* @default true
|
|
575
|
-
*/
|
|
576
|
-
hideEmptyAgendaDays?: boolean;
|
|
577
|
-
|
|
578
|
-
/**
|
|
579
|
-
* The recurrence validation will be done by default. When this property is set to `false`, the recurrence validation will be skipped.
|
|
580
|
-
*
|
|
581
|
-
* @default true
|
|
582
|
-
*/
|
|
583
|
-
enableRecurrenceValidation?: boolean;
|
|
584
|
-
|
|
585
|
-
/**
|
|
586
|
-
* Schedule will be assigned with specific timezone, so as to display the events in it accordingly. By default,
|
|
587
|
-
* Schedule dates are processed with System timezone, as no timezone will be assigned specifically to the Schedule at the initial time.
|
|
588
|
-
* Whenever the Schedule is bound to remote data services, it is always recommended to set specific timezone to Schedule to make the
|
|
589
|
-
* events on it to display on the same time irrespective of the system timezone. It usually accepts
|
|
590
|
-
* the valid [IANA](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) timezone names.
|
|
591
|
-
*
|
|
592
|
-
* {% codeBlock src='schedule/timezone/index.md' %}{% endcodeBlock %}
|
|
593
|
-
*
|
|
594
|
-
* @default null
|
|
595
|
-
*/
|
|
596
|
-
timezone?: string;
|
|
597
|
-
|
|
598
|
-
/**
|
|
599
|
-
* Complete set of settings related to Schedule events to bind it to local or remote dataSource, map applicable database fields and
|
|
600
|
-
* other validation to be carried out on the available fields.
|
|
601
|
-
*
|
|
602
|
-
* {% codeBlock src='schedule/eventSettings/index.md' %}{% endcodeBlock %}
|
|
603
|
-
*
|
|
604
|
-
* @default null
|
|
605
|
-
*/
|
|
606
|
-
eventSettings?: EventSettingsModel;
|
|
607
|
-
|
|
608
|
-
/**
|
|
609
|
-
* Allows to define the collection of timezone items in the Schedule. Only the items bound to this property get listed out in the timezone dropdown of the appointment window.
|
|
610
|
-
*
|
|
611
|
-
* {% codeBlock src='schedule/timezoneDatasource/index.md' %}{% endcodeBlock %}
|
|
612
|
-
*
|
|
613
|
-
* @default timezoneData
|
|
614
|
-
*/
|
|
615
|
-
timezoneDataSource?: TimezoneFields[];
|
|
616
|
-
|
|
617
|
-
/**
|
|
618
|
-
* Template option to customize the resource header bar. Here, the template accepts either
|
|
619
|
-
* the string or HTMLElement as template design and then the parsed design is displayed onto the resource header cells.
|
|
620
|
-
* The following can be accessible via template.
|
|
621
|
-
* * `resource` - All the resource fields.
|
|
622
|
-
* * `resourceData` - Object collection of current resource.
|
|
623
|
-
*
|
|
624
|
-
* Refer to the below code snippet.
|
|
625
|
-
*
|
|
626
|
-
* {% codeBlock src='schedule/resourceHeaderTemplate/index.md' %}{% endcodeBlock %}
|
|
627
|
-
*
|
|
628
|
-
* @default null
|
|
629
|
-
* @angularType string | object
|
|
630
|
-
* @reactType string | function | JSX.Element
|
|
631
|
-
* @vueType string | function
|
|
632
|
-
* @aspType string
|
|
633
|
-
*/
|
|
634
|
-
resourceHeaderTemplate?: string | Function;
|
|
635
|
-
|
|
636
|
-
/**
|
|
637
|
-
* Template option to customize the header indent bar. Here, the template accepts either
|
|
638
|
-
* the string or HTMLElement as template design and then the parsed design is displayed onto the header indent cell.
|
|
639
|
-
*
|
|
640
|
-
* Refer to the below code snippet.
|
|
641
|
-
*
|
|
642
|
-
* {% codeBlock src='schedule/headerIndentTemplate/index.md' %}{% endcodeBlock %}
|
|
643
|
-
*
|
|
644
|
-
* @default null
|
|
645
|
-
* @angularType string | object
|
|
646
|
-
* @reactType string | function | JSX.Element
|
|
647
|
-
* @vueType string | function
|
|
648
|
-
* @aspType string
|
|
649
|
-
*/
|
|
650
|
-
headerIndentTemplate?: string | Function;
|
|
651
|
-
|
|
652
|
-
/**
|
|
653
|
-
* Allows defining the group related settings of multiple resources. When this property is non-empty, it means
|
|
654
|
-
* that the resources will be grouped on the schedule layout based on the provided resource names.
|
|
655
|
-
*
|
|
656
|
-
* {% codeBlock src='schedule/group/index.md' %}{% endcodeBlock %}
|
|
657
|
-
*
|
|
658
|
-
* @default {}
|
|
659
|
-
*/
|
|
660
|
-
group?: GroupModel;
|
|
661
|
-
|
|
662
|
-
/**
|
|
663
|
-
* Allows defining the collection of resources to be displayed on the Schedule. The resource collection needs to be defined
|
|
664
|
-
* with unique resource names to identify it along with the respective dataSource and field mapping options.
|
|
665
|
-
*
|
|
666
|
-
* {% codeBlock src='schedule/resources/index.md' %}{% endcodeBlock %}
|
|
667
|
-
*
|
|
668
|
-
* @default []
|
|
669
|
-
*/
|
|
670
|
-
resources?: ResourcesModel[];
|
|
671
|
-
|
|
672
|
-
/**
|
|
673
|
-
* Allows defining the collection of custom header rows to display the year, month, week, date and hour label as an individual row
|
|
674
|
-
* on the timeline view of the scheduler.
|
|
675
|
-
*
|
|
676
|
-
* {% codeBlock src='schedule/headerRows/index.md' %}{% endcodeBlock %}
|
|
677
|
-
*
|
|
678
|
-
* @default []
|
|
679
|
-
*/
|
|
680
|
-
headerRows?: HeaderRowsModel[];
|
|
681
|
-
|
|
682
|
-
/**
|
|
683
|
-
* It is used to customize the Schedule which accepts custom CSS class names that defines specific user-defined styles and themes
|
|
684
|
-
* to be applied on the Schedule element.
|
|
685
|
-
*
|
|
686
|
-
* {% codeBlock src='schedule/cssClass/index.md' %}{% endcodeBlock %}
|
|
687
|
-
*
|
|
688
|
-
* @default null
|
|
689
|
-
*/
|
|
690
|
-
cssClass?: string;
|
|
691
|
-
|
|
692
|
-
/**
|
|
693
|
-
* Enables clipboard functionality for appointments, allowing them to be copied using keyboard shortcuts and pasted onto the Scheduler.
|
|
694
|
-
* When set to `true`, users can use keyboard shortcuts to cut, copy appointments and paste them into different time slots or calendars.
|
|
695
|
-
*
|
|
696
|
-
* @default false
|
|
697
|
-
* @remarks The `allowKeyboardInteraction` property should be enabled to use the keyboard shortcuts.
|
|
698
|
-
*/
|
|
699
|
-
allowClipboard?: boolean;
|
|
700
|
-
|
|
701
|
-
/**
|
|
702
|
-
* It enables the external drag and drop support for appointments on scheduler, to be able to move them out of the scheduler layout.
|
|
703
|
-
* When the drag area is explicitly set with specific DOM element name, the appointments can be dragged anywhere within the specified drag area location.
|
|
704
|
-
*
|
|
705
|
-
* {% codeBlock src='schedule/eventDragArea/index.md' %}{% endcodeBlock %}
|
|
706
|
-
*
|
|
707
|
-
* @default null
|
|
708
|
-
*/
|
|
709
|
-
eventDragArea?: string;
|
|
710
|
-
|
|
711
|
-
/**
|
|
712
|
-
* Triggers after the scheduler component is created.
|
|
713
|
-
*
|
|
714
|
-
* @event 'created'
|
|
715
|
-
*/
|
|
716
|
-
created?: EmitType<Record<string, any>>;
|
|
717
|
-
|
|
718
|
-
/**
|
|
719
|
-
* Triggers when the scheduler component is destroyed.
|
|
720
|
-
*
|
|
721
|
-
* @event 'destroyed'
|
|
722
|
-
*/
|
|
723
|
-
destroyed?: EmitType<Record<string, any>>;
|
|
724
|
-
|
|
725
|
-
/**
|
|
726
|
-
* Triggers when the scheduler cells are single clicked or on single tap on the same cells in mobile devices.
|
|
727
|
-
*
|
|
728
|
-
* @event 'cellClick'
|
|
729
|
-
*/
|
|
730
|
-
cellClick?: EmitType<CellClickEventArgs>;
|
|
10
|
+
* Sets the `width` of the Schedule component, accepting both string and number values.
|
|
11
|
+
*
|
|
12
|
+
* {% codeBlock src='schedule/width/index.md' %}{% endcodeBlock %}
|
|
13
|
+
*
|
|
14
|
+
* The string value can be either pixel or percentage format.
|
|
15
|
+
* When set to `auto`, the Schedule width gets auto-adjusted and display its content related to the viewable screen size.
|
|
16
|
+
*
|
|
17
|
+
* @default 'auto'
|
|
18
|
+
*/
|
|
19
|
+
width?: string | number;
|
|
20
|
+
|
|
21
|
+
/**
|
|
22
|
+
* Sets the `height` of the Schedule component, accepting both string and number values.
|
|
23
|
+
*
|
|
24
|
+
* {% codeBlock src='schedule/height/index.md' %}{% endcodeBlock %}
|
|
25
|
+
*
|
|
26
|
+
* The string type includes either pixel or percentage values.
|
|
27
|
+
* When `height` is set with specific pixel value, then the Schedule will be rendered to that specified space.
|
|
28
|
+
* In case, if `auto` value is set, then the height of the Schedule gets auto-adjusted within the given container.
|
|
29
|
+
*
|
|
30
|
+
* @default 'auto'
|
|
31
|
+
*/
|
|
32
|
+
height?: string | number;
|
|
33
|
+
|
|
34
|
+
/**
|
|
35
|
+
* When set to `false`, hides the header bar of the Schedule from UI. By default,
|
|
36
|
+
* the header bar holds the date and view navigation options, to which the user can add their own custom items onto it.
|
|
37
|
+
*
|
|
38
|
+
* @default true
|
|
39
|
+
*/
|
|
40
|
+
showHeaderBar?: boolean;
|
|
41
|
+
|
|
42
|
+
/**
|
|
43
|
+
* When set to `false`, hides the current time indicator from the Schedule. Otherwise,
|
|
44
|
+
* it visually depicts the live current system time appropriately on the user interface.
|
|
45
|
+
*
|
|
46
|
+
* @default true
|
|
47
|
+
*/
|
|
48
|
+
showTimeIndicator?: boolean;
|
|
49
|
+
|
|
50
|
+
/**
|
|
51
|
+
* Defines whether to enable date navigations via swipe in touch devices or not.
|
|
52
|
+
*
|
|
53
|
+
* @default true
|
|
54
|
+
*/
|
|
55
|
+
allowSwiping?: boolean;
|
|
56
|
+
|
|
57
|
+
/**
|
|
58
|
+
* Specifies whether overlapping appointments are allowed within the same time slot in the Scheduler.
|
|
59
|
+
*
|
|
60
|
+
* @remarks
|
|
61
|
+
* When set to `false`, the Scheduler enforces restrictions to prevent creating or displaying overlapping appointments within the same time duration.
|
|
62
|
+
* This setting includes the following limitations:
|
|
63
|
+
*
|
|
64
|
+
* - **Initial Loading**: The alert for overlapping appointments will not display during the initial load. Overlapping events will be ignored in rendering, including occurrences.
|
|
65
|
+
*
|
|
66
|
+
* - **Dynamic Add/Edit**: When adding or editing events dynamically, overlapping validation is performed. If an overlap is detected for a single event, an alert will be shown, and the event will not be saved.
|
|
67
|
+
*
|
|
68
|
+
* For recurring events, an alert will be displayed, and the event will not be saved. To save recurring events while ignoring overlapping occurrences, trigger the `PopupOpen` event. The `Data` field will contain the parent recurrence data, and the `overlapEvents` field will contain the overlap events. Using these details, users can include exceptions in the recurrence events and save them with the `addEvent` method.
|
|
69
|
+
*
|
|
70
|
+
* - **Out-of-Date-Range Events**: The `allowOverlap` setting only prevents overlaps for events within the current view date range. To validate overlap events outside the current date range, use the `actionBegin` event to send a request to the server for validation and return a promise-based response. Assign this promise response to the `promise` field in `ActionEventArgs` to handle asynchronous server validation.
|
|
71
|
+
*
|
|
72
|
+
* @default true
|
|
73
|
+
*/
|
|
74
|
+
allowOverlap?: boolean;
|
|
75
|
+
|
|
76
|
+
/**
|
|
77
|
+
* Specifies the number of additional rows or columns to render outside the visible area during virtual scrolling.
|
|
78
|
+
* This property helps in achieving smoother scrolling by pre-loading data just outside the visible region.
|
|
79
|
+
*
|
|
80
|
+
* @remarks
|
|
81
|
+
* The default value is 3. Increasing this value can result in smoother scrolling but may impact performance
|
|
82
|
+
* with larger datasets. Decreasing it can improve performance but may cause more frequent data fetches during scrolling.
|
|
83
|
+
* This property only takes effect when `allowVirtualScrolling` is enabled for the current view.
|
|
84
|
+
*
|
|
85
|
+
* @default 3
|
|
86
|
+
*/
|
|
87
|
+
overscanCount?: number;
|
|
88
|
+
|
|
89
|
+
/**
|
|
90
|
+
* To render the custom toolbar items, the `toolbarItems` property can be used. It contains built-in and custom toolbar items.
|
|
91
|
+
* To avail the built-in toolbar items, the below string values are assigned to the `name` property of the `ToolbarItemModel`.
|
|
92
|
+
* * `Previous`: Schedule component navigates to the previous date from the current date.
|
|
93
|
+
* * `Next`: Schedule component navigates to the next date from the current date.
|
|
94
|
+
* * `Today`: Schedule component navigates to the current date from any date.
|
|
95
|
+
* * `Views`: Schedule component render the defined view options in the toolbar. If view option is not defined, then it will render default view options in the Schedule.
|
|
96
|
+
* * `DateRangeText`: Schedule component displays the current date text range.
|
|
97
|
+
* * `NewEvent`: Schedule component render the icon to add a new event.
|
|
98
|
+
*
|
|
99
|
+
* @default []
|
|
100
|
+
*/
|
|
101
|
+
toolbarItems?: ToolbarItemModel[]
|
|
102
|
+
|
|
103
|
+
/**
|
|
104
|
+
* To set the active view on scheduler, the `currentView` property can be used and it usually accepts either of the following available
|
|
105
|
+
* view options. The view option specified in this property will be initially loaded on the schedule.
|
|
106
|
+
* * `Day`: Denotes Day view of the scheduler.
|
|
107
|
+
* * `Week`: Denotes Week view of the scheduler.
|
|
108
|
+
* * `WorkWeek`: Denotes Work Week view of the scheduler.
|
|
109
|
+
* * `Month`: Denotes Month view of the scheduler.
|
|
110
|
+
* * `Year`: Denotes Year view of the scheduler.
|
|
111
|
+
* * `Agenda`: Denotes Agenda view of the scheduler.
|
|
112
|
+
* * `MonthAgenda`: Denotes Month Agenda view of the scheduler.
|
|
113
|
+
* * `TimelineDay`: Denotes Timeline Day view of the scheduler.
|
|
114
|
+
* * `TimelineWeek`: Denotes Timeline Week view of the scheduler.
|
|
115
|
+
* * `TimelineWorkWeek`: Denotes Timeline Work Week view of the scheduler.
|
|
116
|
+
* * `TimelineMonth`: Denotes Timeline Month view of the scheduler.
|
|
117
|
+
* * `TimelineYear`: Denotes Timeline Year view of the scheduler.
|
|
118
|
+
*
|
|
119
|
+
* {% codeBlock src='schedule/currentView/index.md' %}{% endcodeBlock %}
|
|
120
|
+
*
|
|
121
|
+
* @default 'Week'
|
|
122
|
+
*/
|
|
123
|
+
currentView?: View;
|
|
124
|
+
|
|
125
|
+
/**
|
|
126
|
+
* This property holds the views collection and its configurations. It accepts either the array of view names or the array of view
|
|
127
|
+
* objects that holds different configurations for each views. By default,
|
|
128
|
+
* Schedule displays all the views namely `Day`, `Week`, `Work Week`, `Month` and `Agenda`.
|
|
129
|
+
*
|
|
130
|
+
* Example for array of views:
|
|
131
|
+
* {% codeBlock src="schedule/views/index.md" %}{% endcodeBlock %}
|
|
132
|
+
*
|
|
133
|
+
* Example for array of view objects:
|
|
134
|
+
* {% codeBlock src='schedule/viewOption/index.md' %}{% endcodeBlock %}
|
|
135
|
+
*
|
|
136
|
+
* @default '["Day", "Week", "WorkWeek", "Month", "Agenda"]'
|
|
137
|
+
*/
|
|
138
|
+
views?: View[] | ViewsModel[];
|
|
139
|
+
|
|
140
|
+
/**
|
|
141
|
+
* To mark the active (current) date on the Schedule, `selectedDate` property can be defined.
|
|
142
|
+
* Usually, it defaults to the current System date.
|
|
143
|
+
*
|
|
144
|
+
* {% codeBlock src='schedule/selectedDate/index.md' %}{% endcodeBlock %}
|
|
145
|
+
*
|
|
146
|
+
* @default 'new Date()'
|
|
147
|
+
* @aspDefaultValue DateTime.Now
|
|
148
|
+
*/
|
|
149
|
+
selectedDate?: Date;
|
|
150
|
+
|
|
151
|
+
/**
|
|
152
|
+
* To define the minimum date on the Schedule, `minDate` property can be defined.
|
|
153
|
+
* Usually, it defaults to the new Date(1900, 0, 1).
|
|
154
|
+
*
|
|
155
|
+
* {% codeBlock src='schedule/minDate/index.md' %}{% endcodeBlock %}
|
|
156
|
+
*
|
|
157
|
+
* @default new Date(1900, 0, 1)
|
|
158
|
+
* @aspDefaultValue new DateTime(1900, 1, 1)
|
|
159
|
+
*/
|
|
160
|
+
minDate?: Date;
|
|
161
|
+
|
|
162
|
+
/**
|
|
163
|
+
* To define the maximum date on the Schedule, `maxDate` property can be defined.
|
|
164
|
+
* Usually, it defaults to the new Date(2099, 11, 31).
|
|
165
|
+
*
|
|
166
|
+
* {% codeBlock src='schedule/maxDate/index.md' %}{% endcodeBlock %}
|
|
167
|
+
*
|
|
168
|
+
* @default new Date(2099, 11, 31)
|
|
169
|
+
* @aspDefaultValue new DateTime(2099, 12, 31)
|
|
170
|
+
*/
|
|
171
|
+
maxDate?: Date;
|
|
172
|
+
|
|
173
|
+
/**
|
|
174
|
+
* By default, Schedule follows the date-format as per the default culture assigned to it.
|
|
175
|
+
* It is also possible to manually set specific date format by using the `dateFormat` property.
|
|
176
|
+
*
|
|
177
|
+
* {% codeBlock src='schedule/dateFormat/index.md' %}{% endcodeBlock %}
|
|
178
|
+
*
|
|
179
|
+
* The format of the date range label in the header bar depends on the `dateFormat` value or else based on the
|
|
180
|
+
* locale assigned to the Schedule.
|
|
181
|
+
*
|
|
182
|
+
* @default null
|
|
183
|
+
*/
|
|
184
|
+
dateFormat?: string;
|
|
185
|
+
|
|
186
|
+
/**
|
|
187
|
+
* It allows the Scheduler to display in other calendar modes.
|
|
188
|
+
* By default, Scheduler is displayed in `Gregorian` calendar mode.
|
|
189
|
+
*
|
|
190
|
+
* {% codeBlock src='schedule/calendarMode/index.md' %}{% endcodeBlock %}
|
|
191
|
+
*
|
|
192
|
+
* To change the mode, you can set either `Gregorian` or `Islamic` as a value to this `calendarMode` property.
|
|
193
|
+
*
|
|
194
|
+
* @default 'Gregorian'
|
|
195
|
+
*/
|
|
196
|
+
calendarMode?: CalendarType;
|
|
197
|
+
|
|
198
|
+
/**
|
|
199
|
+
* When set to `false`, it hides the weekend days of a week from the Schedule. The days which are not defined in the working days
|
|
200
|
+
* collection are usually treated as weekend days.
|
|
201
|
+
*
|
|
202
|
+
* Note: By default, this option is not applicable on `Work Week` view.
|
|
203
|
+
* For example, if the working days are defined as [1, 2, 3, 4], then the remaining days of that week will be considered as
|
|
204
|
+
* the weekend days and will be hidden on all the views.
|
|
205
|
+
*
|
|
206
|
+
* @default true
|
|
207
|
+
*/
|
|
208
|
+
showWeekend?: boolean;
|
|
209
|
+
|
|
210
|
+
/**
|
|
211
|
+
* This option allows the user to set the first day of a week on Schedule. It should be based on the locale set to it and each culture
|
|
212
|
+
* defines its own first day of week values. If needed, the user can set it manually on his own by defining the value through
|
|
213
|
+
* this property. It usually accepts the integer values, whereby 0 is always denoted as Sunday, 1 as Monday and so on.
|
|
214
|
+
*
|
|
215
|
+
* {% codeBlock src='schedule/firstDayOfWeek/index.md' %}{% endcodeBlock %}
|
|
216
|
+
*
|
|
217
|
+
* @default 0
|
|
218
|
+
*/
|
|
219
|
+
firstDayOfWeek?: number;
|
|
220
|
+
|
|
221
|
+
/**
|
|
222
|
+
* It allows the Scheduler to display week numbers based on following available week options. The week
|
|
223
|
+
* option specified in this property will be initially loaded on the schedule.
|
|
224
|
+
* * `FirstDay`: Denotes that the first week of the year starts on the first day of the year and ends before the following designated first day of the week.
|
|
225
|
+
* * `FirstFourDayWeek`:Denotes that the first week of the year is the first week with four or more days before the designated first day of the week.
|
|
226
|
+
* * `FirstFullWeek`: Denotes that the first week of the year begins on the first occurrence of the designated first day of the week on or after the first day of the year.
|
|
227
|
+
*
|
|
228
|
+
* {% codeBlock src='schedule/weekRule/index.md' %}{% endcodeBlock %}
|
|
229
|
+
*
|
|
230
|
+
* @default 'FirstDay'
|
|
231
|
+
*/
|
|
232
|
+
weekRule?: WeekRule;
|
|
233
|
+
|
|
234
|
+
/**
|
|
235
|
+
* It is used to set the working days on Schedule. The only days that are defined in this collection will be rendered on the `workWeek`
|
|
236
|
+
* view whereas on other views, it will display all the usual days and simply highlights the working days with different shade.
|
|
237
|
+
*
|
|
238
|
+
* {% codeBlock src='schedule/workDays/index.md' %}{% endcodeBlock %}
|
|
239
|
+
*
|
|
240
|
+
* @default '[1, 2, 3, 4, 5]'
|
|
241
|
+
* @aspType int[]
|
|
242
|
+
*/
|
|
243
|
+
workDays?: number[];
|
|
244
|
+
|
|
245
|
+
/**
|
|
246
|
+
* This option allows the user to set the number of months count to be displayed on the Schedule.
|
|
247
|
+
*
|
|
248
|
+
* {% codeBlock src='schedule/monthsCount/index.md' %}{% endcodeBlock %}
|
|
249
|
+
*
|
|
250
|
+
* @default 12
|
|
251
|
+
* @aspType int
|
|
252
|
+
*/
|
|
253
|
+
monthsCount?: number;
|
|
254
|
+
|
|
255
|
+
/**
|
|
256
|
+
* It is used to specify the starting hour, from which the Schedule starts to display. It accepts the time string in a short skeleton
|
|
257
|
+
* format and also, hides the time beyond the specified start time.
|
|
258
|
+
*
|
|
259
|
+
* {% codeBlock src='schedule/startHour/index.md' %}{% endcodeBlock %}
|
|
260
|
+
*
|
|
261
|
+
* @default '00:00'
|
|
262
|
+
*/
|
|
263
|
+
startHour?: string;
|
|
264
|
+
|
|
265
|
+
/**
|
|
266
|
+
* It is used to specify the end hour, at which the Schedule ends. It too accepts the time string in a short skeleton format.
|
|
267
|
+
*
|
|
268
|
+
* {% codeBlock src='schedule/endHour/index.md' %}{% endcodeBlock %}
|
|
269
|
+
*
|
|
270
|
+
* @default '24:00'
|
|
271
|
+
*/
|
|
272
|
+
endHour?: string;
|
|
273
|
+
|
|
274
|
+
/**
|
|
275
|
+
* By default, Schedule follows the time-format as per the default culture assigned to it.
|
|
276
|
+
* It is also possible to manually set specific time format by using the `timeFormat` property.
|
|
277
|
+
*
|
|
278
|
+
* {% codeBlock src='schedule/timeFormat/index.md' %}{% endcodeBlock %}
|
|
279
|
+
*
|
|
280
|
+
* @default null
|
|
281
|
+
*/
|
|
282
|
+
timeFormat?: string;
|
|
283
|
+
|
|
284
|
+
/**
|
|
285
|
+
* Specifies whether to enable the rendering of untrusted HTML values in the Schedule component.
|
|
286
|
+
* When this property is enabled, the component will sanitize any suspected untrusted strings and scripts before rendering them.
|
|
287
|
+
*
|
|
288
|
+
* @default true
|
|
289
|
+
*/
|
|
290
|
+
enableHtmlSanitizer?: boolean;
|
|
291
|
+
|
|
292
|
+
/**
|
|
293
|
+
* When set to `true`, If valid, the scroll on the all day row is activated when the all day row
|
|
294
|
+
* height reaches the max height when the all day row is expanded.
|
|
295
|
+
*
|
|
296
|
+
* @default false
|
|
297
|
+
*/
|
|
298
|
+
enableAllDayScroll?: boolean;
|
|
299
|
+
|
|
300
|
+
/**
|
|
301
|
+
* When set to `true`, the header view navigations are listed under the popup and if we enable resource grouping, the compact view will be enabled.
|
|
302
|
+
*
|
|
303
|
+
* @default false
|
|
304
|
+
*/
|
|
305
|
+
enableAdaptiveUI?: boolean;
|
|
306
|
+
|
|
307
|
+
/**
|
|
308
|
+
* When set to `true`, allows the resizing of appointments. It allows the rescheduling of appointments either by changing the
|
|
309
|
+
* start or end time by dragging the event resize handlers.
|
|
310
|
+
*
|
|
311
|
+
* @default true
|
|
312
|
+
*/
|
|
313
|
+
allowResizing?: boolean;
|
|
314
|
+
|
|
315
|
+
/**
|
|
316
|
+
* The working hours should be highlighted on Schedule with different color shade and an additional option must be provided to
|
|
317
|
+
* highlight it or not. This functionality is handled through `workHours` property and the start work hour should be 9 AM by default
|
|
318
|
+
* and end work hour should point to 6 PM. The start and end working hours needs to be provided as Time value of short skeleton type.
|
|
319
|
+
*
|
|
320
|
+
* {% codeBlock src='schedule/workHours/index.md' %}{% endcodeBlock %}
|
|
321
|
+
*
|
|
322
|
+
* @default { highlight: true, start: '09:00', end: '18:00' }
|
|
323
|
+
*/
|
|
324
|
+
workHours?: WorkHoursModel;
|
|
325
|
+
|
|
326
|
+
/**
|
|
327
|
+
* Allows to set different time duration on Schedule along with the customized grid count. It also has template option to
|
|
328
|
+
* customize the time slots with required time values in its own format.
|
|
329
|
+
*
|
|
330
|
+
* {% codeBlock src='schedule/timeScale/index.md' %}{% endcodeBlock %}
|
|
331
|
+
*
|
|
332
|
+
* @default { enable: true, interval: 60, slotCount: 2, majorSlotTemplate: null, minorSlotTemplate: null }
|
|
333
|
+
*/
|
|
334
|
+
timeScale?: TimeScaleModel;
|
|
335
|
+
|
|
336
|
+
/**
|
|
337
|
+
* When set to `true`, allows the keyboard interaction to take place on Schedule.
|
|
338
|
+
*
|
|
339
|
+
* @default true
|
|
340
|
+
*/
|
|
341
|
+
allowKeyboardInteraction?: boolean;
|
|
342
|
+
|
|
343
|
+
/**
|
|
344
|
+
* When set to `true`, allows the appointments to move over the time slots. When an appointment is dragged, both its start
|
|
345
|
+
* and end time tends to change simultaneously allowing it to reschedule the appointment on some other time.
|
|
346
|
+
*
|
|
347
|
+
* @default true
|
|
348
|
+
*/
|
|
349
|
+
allowDragAndDrop?: boolean;
|
|
350
|
+
|
|
351
|
+
/**
|
|
352
|
+
* It accepts either the string or HTMLElement as template design content and parse it appropriately before displaying it onto
|
|
353
|
+
* the date header cells. The field that can be accessed via this template is `date`.
|
|
354
|
+
*
|
|
355
|
+
* {% codeBlock src='schedule/dateHeaderTemplate/index.md' %}{% endcodeBlock %}
|
|
356
|
+
*
|
|
357
|
+
* @default null
|
|
358
|
+
* @angularType string | object
|
|
359
|
+
* @reactType string | function | JSX.Element
|
|
360
|
+
* @vueType string | function
|
|
361
|
+
* @aspType string
|
|
362
|
+
*/
|
|
363
|
+
dateHeaderTemplate?: string | Function;
|
|
364
|
+
|
|
365
|
+
/**
|
|
366
|
+
* It accepts either the string or HTMLElement as template design content and parse it appropriately before displaying it onto the header date range.
|
|
367
|
+
*
|
|
368
|
+
* @default null
|
|
369
|
+
* @angularType string | object
|
|
370
|
+
* @reactType string | function | JSX.Element
|
|
371
|
+
* @vueType string | function
|
|
372
|
+
* @aspType string
|
|
373
|
+
*/
|
|
374
|
+
dateRangeTemplate?: string | Function;
|
|
375
|
+
|
|
376
|
+
/**
|
|
377
|
+
* It accepts either the string or HTMLElement as template design content and parse it appropriately before displaying it onto
|
|
378
|
+
* the month date cells. This template is only applicable for month view day cells.
|
|
379
|
+
*
|
|
380
|
+
* {% codeBlock src='schedule/cellHeaderTemplate/index.md' %}{% endcodeBlock %}
|
|
381
|
+
*
|
|
382
|
+
* @default null
|
|
383
|
+
* @angularType string | object
|
|
384
|
+
* @reactType string | function | JSX.Element
|
|
385
|
+
* @vueType string | function
|
|
386
|
+
* @aspType string
|
|
387
|
+
*/
|
|
388
|
+
cellHeaderTemplate?: string | Function;
|
|
389
|
+
|
|
390
|
+
/**
|
|
391
|
+
* It accepts either the string or HTMLElement as template design content and parse it appropriately before displaying it onto
|
|
392
|
+
* the day header cells. This template is only applicable for year view header cells.
|
|
393
|
+
*
|
|
394
|
+
* {% codeBlock src='schedule/dayHeaderTemplate/index.md' %}{% endcodeBlock %}
|
|
395
|
+
*
|
|
396
|
+
* @default null
|
|
397
|
+
* @angularType string | object
|
|
398
|
+
* @reactType string | function | JSX.Element
|
|
399
|
+
* @vueType string | function
|
|
400
|
+
* @aspType string
|
|
401
|
+
*/
|
|
402
|
+
dayHeaderTemplate?: string | Function;
|
|
403
|
+
|
|
404
|
+
/**
|
|
405
|
+
* It accepts either the string or HTMLElement as template design content and parse it appropriately before displaying it onto
|
|
406
|
+
* the month header cells. This template is only applicable for year view header cells.
|
|
407
|
+
*
|
|
408
|
+
* {% codeBlock src='schedule/monthHeaderTemplate/index.md' %}{% endcodeBlock %}
|
|
409
|
+
*
|
|
410
|
+
* @default null
|
|
411
|
+
* @angularType string | object
|
|
412
|
+
* @reactType string | function | JSX.Element
|
|
413
|
+
* @vueType string | function
|
|
414
|
+
* @aspType string
|
|
415
|
+
*/
|
|
416
|
+
monthHeaderTemplate?: string | Function;
|
|
417
|
+
|
|
418
|
+
/**
|
|
419
|
+
* The template option which is used to render the customized work cells on the Schedule. Here, the template accepts either
|
|
420
|
+
* the string or HTMLElement as template design and then the parsed design is displayed onto the work cells.
|
|
421
|
+
* The fields accessible via template are as follows.
|
|
422
|
+
* * `date`: Returns the date of the cell.
|
|
423
|
+
* * `groupIndex`: Returns the group index of the cell.
|
|
424
|
+
* * `type`: Returns the type of the work cell.
|
|
425
|
+
*
|
|
426
|
+
* Refer to the below code snippet.
|
|
427
|
+
*
|
|
428
|
+
* {% codeBlock src='schedule/cellTemplate/index.md' %}{% endcodeBlock %}
|
|
429
|
+
*
|
|
430
|
+
* @default null
|
|
431
|
+
* @angularType string | object
|
|
432
|
+
* @reactType string | function | JSX.Element
|
|
433
|
+
* @vueType string | function
|
|
434
|
+
* @aspType string
|
|
435
|
+
*/
|
|
436
|
+
cellTemplate?: string | Function;
|
|
437
|
+
|
|
438
|
+
/**
|
|
439
|
+
* When set to `true`, makes the Schedule to render in a read only mode. No CRUD actions will be allowed at this time.
|
|
440
|
+
*
|
|
441
|
+
* @default false
|
|
442
|
+
*/
|
|
443
|
+
readonly?: boolean;
|
|
444
|
+
|
|
445
|
+
/**
|
|
446
|
+
* When set to `true`, displays a quick popup with cell or event details on single clicking over the cells or on events.
|
|
447
|
+
* By default, it is set to `true`.
|
|
448
|
+
*
|
|
449
|
+
* @default true
|
|
450
|
+
*/
|
|
451
|
+
showQuickInfo?: boolean;
|
|
452
|
+
|
|
453
|
+
/**
|
|
454
|
+
* This property helps user to add/edit the event in inline. By default, it is set to `false`.
|
|
455
|
+
*
|
|
456
|
+
* @default false
|
|
457
|
+
*/
|
|
458
|
+
allowInline?: boolean;
|
|
459
|
+
|
|
460
|
+
/**
|
|
461
|
+
* This property helps user to allow/prevent the selection of multiple cells. By default, it is set to `true`.
|
|
462
|
+
*
|
|
463
|
+
* @default true
|
|
464
|
+
*/
|
|
465
|
+
allowMultiCellSelection?: boolean;
|
|
466
|
+
|
|
467
|
+
/**
|
|
468
|
+
* This property helps user to allow/prevent the selection of multiple days(rows). By default, it is set to `true`.
|
|
469
|
+
*
|
|
470
|
+
* @default true
|
|
471
|
+
*/
|
|
472
|
+
allowMultiRowSelection?: boolean;
|
|
473
|
+
|
|
474
|
+
/**
|
|
475
|
+
* This property helps to show quick popup after multiple cell selection. By default, it is set to `false`.
|
|
476
|
+
*
|
|
477
|
+
* @default false
|
|
478
|
+
*/
|
|
479
|
+
quickInfoOnSelectionEnd?: boolean;
|
|
480
|
+
|
|
481
|
+
/**
|
|
482
|
+
* When set to `true`, displays the week number of the current view date range. By default, it is set to `false`.
|
|
483
|
+
*
|
|
484
|
+
* @default false
|
|
485
|
+
*/
|
|
486
|
+
showWeekNumber?: boolean;
|
|
487
|
+
|
|
488
|
+
/**
|
|
489
|
+
* when set to `true`, allows the height of the work-cells to adjust automatically
|
|
490
|
+
* based on the number of appointments present in those time ranges.
|
|
491
|
+
*
|
|
492
|
+
* @default false
|
|
493
|
+
*/
|
|
494
|
+
rowAutoHeight?: boolean;
|
|
495
|
+
|
|
496
|
+
/**
|
|
497
|
+
* This property helps to drag the multiple selected events. By default, it is set to `false`.
|
|
498
|
+
*
|
|
499
|
+
* @default false
|
|
500
|
+
*/
|
|
501
|
+
allowMultiDrag?: boolean;
|
|
502
|
+
|
|
503
|
+
/**
|
|
504
|
+
* This property helps render the year view customized months. By default, it is set to `0`.
|
|
505
|
+
*
|
|
506
|
+
* {% codeBlock src='schedule/firstMonthOfYear/index.md' %}{% endcodeBlock %}
|
|
507
|
+
*
|
|
508
|
+
* @default 0
|
|
509
|
+
*/
|
|
510
|
+
firstMonthOfYear?: number;
|
|
511
|
+
|
|
512
|
+
/**
|
|
513
|
+
* The template option to render the customized editor window. The form elements defined within this template should be accompanied
|
|
514
|
+
* with `e-field` class, so as to fetch and process it from internally.
|
|
515
|
+
*
|
|
516
|
+
* {% codeBlock src='schedule/editorTemplate/index.md' %}{% endcodeBlock %}
|
|
517
|
+
*
|
|
518
|
+
* @default null
|
|
519
|
+
* @angularType string | object
|
|
520
|
+
* @reactType string | function | JSX.Element
|
|
521
|
+
* @vueType string | function
|
|
522
|
+
* @aspType string
|
|
523
|
+
*/
|
|
524
|
+
editorTemplate?: string | Function;
|
|
525
|
+
|
|
526
|
+
/**
|
|
527
|
+
* The template option to render the customized header of the editor window.
|
|
528
|
+
*
|
|
529
|
+
*
|
|
530
|
+
* @default null
|
|
531
|
+
* @angularType string | object
|
|
532
|
+
* @reactType string | function | JSX.Element
|
|
533
|
+
* @vueType string | function
|
|
534
|
+
* @aspType string
|
|
535
|
+
*/
|
|
536
|
+
editorHeaderTemplate?: string | Function;
|
|
537
|
+
|
|
538
|
+
/**
|
|
539
|
+
* The template option to render the customized footer of the editor window.
|
|
540
|
+
*
|
|
541
|
+
*
|
|
542
|
+
* @default null
|
|
543
|
+
* @angularType string | object
|
|
544
|
+
* @reactType string | function | JSX.Element
|
|
545
|
+
* @vueType string | function
|
|
546
|
+
* @aspType string
|
|
547
|
+
*/
|
|
548
|
+
editorFooterTemplate?: string | Function;
|
|
549
|
+
|
|
550
|
+
/**
|
|
551
|
+
* The template option to customize the quick window. The three sections of the quick popup whereas the header, content,
|
|
552
|
+
* and footer can be easily customized with individual template option.
|
|
553
|
+
*
|
|
554
|
+
* {% codeBlock src='schedule/quickInfoTemplates/index.md' %}{% endcodeBlock %}
|
|
555
|
+
*
|
|
556
|
+
* @default null
|
|
557
|
+
*/
|
|
558
|
+
quickInfoTemplates?: QuickInfoTemplatesModel;
|
|
559
|
+
|
|
560
|
+
/**
|
|
561
|
+
* Sets the number of days to be displayed by default in Agenda View and in case of virtual scrolling,
|
|
562
|
+
* the number of days will be fetched on each scroll-end based on this count.
|
|
563
|
+
*
|
|
564
|
+
* {% codeBlock src='schedule/agendaDaysCount/index.md' %}{% endcodeBlock %}
|
|
565
|
+
*
|
|
566
|
+
* @default 7
|
|
567
|
+
*/
|
|
568
|
+
agendaDaysCount?: number;
|
|
569
|
+
|
|
570
|
+
/**
|
|
571
|
+
* The days which does not has even a single event to display will be hidden from the UI of Agenda View by default.
|
|
572
|
+
* When this property is set to `false`, the empty dates will also be displayed on the Schedule.
|
|
573
|
+
*
|
|
574
|
+
* @default true
|
|
575
|
+
*/
|
|
576
|
+
hideEmptyAgendaDays?: boolean;
|
|
577
|
+
|
|
578
|
+
/**
|
|
579
|
+
* The recurrence validation will be done by default. When this property is set to `false`, the recurrence validation will be skipped.
|
|
580
|
+
*
|
|
581
|
+
* @default true
|
|
582
|
+
*/
|
|
583
|
+
enableRecurrenceValidation?: boolean;
|
|
584
|
+
|
|
585
|
+
/**
|
|
586
|
+
* Schedule will be assigned with specific timezone, so as to display the events in it accordingly. By default,
|
|
587
|
+
* Schedule dates are processed with System timezone, as no timezone will be assigned specifically to the Schedule at the initial time.
|
|
588
|
+
* Whenever the Schedule is bound to remote data services, it is always recommended to set specific timezone to Schedule to make the
|
|
589
|
+
* events on it to display on the same time irrespective of the system timezone. It usually accepts
|
|
590
|
+
* the valid [IANA](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) timezone names.
|
|
591
|
+
*
|
|
592
|
+
* {% codeBlock src='schedule/timezone/index.md' %}{% endcodeBlock %}
|
|
593
|
+
*
|
|
594
|
+
* @default null
|
|
595
|
+
*/
|
|
596
|
+
timezone?: string;
|
|
597
|
+
|
|
598
|
+
/**
|
|
599
|
+
* Complete set of settings related to Schedule events to bind it to local or remote dataSource, map applicable database fields and
|
|
600
|
+
* other validation to be carried out on the available fields.
|
|
601
|
+
*
|
|
602
|
+
* {% codeBlock src='schedule/eventSettings/index.md' %}{% endcodeBlock %}
|
|
603
|
+
*
|
|
604
|
+
* @default null
|
|
605
|
+
*/
|
|
606
|
+
eventSettings?: EventSettingsModel;
|
|
607
|
+
|
|
608
|
+
/**
|
|
609
|
+
* Allows to define the collection of timezone items in the Schedule. Only the items bound to this property get listed out in the timezone dropdown of the appointment window.
|
|
610
|
+
*
|
|
611
|
+
* {% codeBlock src='schedule/timezoneDatasource/index.md' %}{% endcodeBlock %}
|
|
612
|
+
*
|
|
613
|
+
* @default timezoneData
|
|
614
|
+
*/
|
|
615
|
+
timezoneDataSource?: TimezoneFields[];
|
|
616
|
+
|
|
617
|
+
/**
|
|
618
|
+
* Template option to customize the resource header bar. Here, the template accepts either
|
|
619
|
+
* the string or HTMLElement as template design and then the parsed design is displayed onto the resource header cells.
|
|
620
|
+
* The following can be accessible via template.
|
|
621
|
+
* * `resource` - All the resource fields.
|
|
622
|
+
* * `resourceData` - Object collection of current resource.
|
|
623
|
+
*
|
|
624
|
+
* Refer to the below code snippet.
|
|
625
|
+
*
|
|
626
|
+
* {% codeBlock src='schedule/resourceHeaderTemplate/index.md' %}{% endcodeBlock %}
|
|
627
|
+
*
|
|
628
|
+
* @default null
|
|
629
|
+
* @angularType string | object
|
|
630
|
+
* @reactType string | function | JSX.Element
|
|
631
|
+
* @vueType string | function
|
|
632
|
+
* @aspType string
|
|
633
|
+
*/
|
|
634
|
+
resourceHeaderTemplate?: string | Function;
|
|
635
|
+
|
|
636
|
+
/**
|
|
637
|
+
* Template option to customize the header indent bar. Here, the template accepts either
|
|
638
|
+
* the string or HTMLElement as template design and then the parsed design is displayed onto the header indent cell.
|
|
639
|
+
*
|
|
640
|
+
* Refer to the below code snippet.
|
|
641
|
+
*
|
|
642
|
+
* {% codeBlock src='schedule/headerIndentTemplate/index.md' %}{% endcodeBlock %}
|
|
643
|
+
*
|
|
644
|
+
* @default null
|
|
645
|
+
* @angularType string | object
|
|
646
|
+
* @reactType string | function | JSX.Element
|
|
647
|
+
* @vueType string | function
|
|
648
|
+
* @aspType string
|
|
649
|
+
*/
|
|
650
|
+
headerIndentTemplate?: string | Function;
|
|
651
|
+
|
|
652
|
+
/**
|
|
653
|
+
* Allows defining the group related settings of multiple resources. When this property is non-empty, it means
|
|
654
|
+
* that the resources will be grouped on the schedule layout based on the provided resource names.
|
|
655
|
+
*
|
|
656
|
+
* {% codeBlock src='schedule/group/index.md' %}{% endcodeBlock %}
|
|
657
|
+
*
|
|
658
|
+
* @default {}
|
|
659
|
+
*/
|
|
660
|
+
group?: GroupModel;
|
|
661
|
+
|
|
662
|
+
/**
|
|
663
|
+
* Allows defining the collection of resources to be displayed on the Schedule. The resource collection needs to be defined
|
|
664
|
+
* with unique resource names to identify it along with the respective dataSource and field mapping options.
|
|
665
|
+
*
|
|
666
|
+
* {% codeBlock src='schedule/resources/index.md' %}{% endcodeBlock %}
|
|
667
|
+
*
|
|
668
|
+
* @default []
|
|
669
|
+
*/
|
|
670
|
+
resources?: ResourcesModel[];
|
|
671
|
+
|
|
672
|
+
/**
|
|
673
|
+
* Allows defining the collection of custom header rows to display the year, month, week, date and hour label as an individual row
|
|
674
|
+
* on the timeline view of the scheduler.
|
|
675
|
+
*
|
|
676
|
+
* {% codeBlock src='schedule/headerRows/index.md' %}{% endcodeBlock %}
|
|
677
|
+
*
|
|
678
|
+
* @default []
|
|
679
|
+
*/
|
|
680
|
+
headerRows?: HeaderRowsModel[];
|
|
681
|
+
|
|
682
|
+
/**
|
|
683
|
+
* It is used to customize the Schedule which accepts custom CSS class names that defines specific user-defined styles and themes
|
|
684
|
+
* to be applied on the Schedule element.
|
|
685
|
+
*
|
|
686
|
+
* {% codeBlock src='schedule/cssClass/index.md' %}{% endcodeBlock %}
|
|
687
|
+
*
|
|
688
|
+
* @default null
|
|
689
|
+
*/
|
|
690
|
+
cssClass?: string;
|
|
691
|
+
|
|
692
|
+
/**
|
|
693
|
+
* Enables clipboard functionality for appointments, allowing them to be copied using keyboard shortcuts and pasted onto the Scheduler.
|
|
694
|
+
* When set to `true`, users can use keyboard shortcuts to cut, copy appointments and paste them into different time slots or calendars.
|
|
695
|
+
*
|
|
696
|
+
* @default false
|
|
697
|
+
* @remarks The `allowKeyboardInteraction` property should be enabled to use the keyboard shortcuts.
|
|
698
|
+
*/
|
|
699
|
+
allowClipboard?: boolean;
|
|
700
|
+
|
|
701
|
+
/**
|
|
702
|
+
* It enables the external drag and drop support for appointments on scheduler, to be able to move them out of the scheduler layout.
|
|
703
|
+
* When the drag area is explicitly set with specific DOM element name, the appointments can be dragged anywhere within the specified drag area location.
|
|
704
|
+
*
|
|
705
|
+
* {% codeBlock src='schedule/eventDragArea/index.md' %}{% endcodeBlock %}
|
|
706
|
+
*
|
|
707
|
+
* @default null
|
|
708
|
+
*/
|
|
709
|
+
eventDragArea?: string;
|
|
710
|
+
|
|
711
|
+
/**
|
|
712
|
+
* Triggers after the scheduler component is created.
|
|
713
|
+
*
|
|
714
|
+
* @event 'created'
|
|
715
|
+
*/
|
|
716
|
+
created?: EmitType<Record<string, any>>;
|
|
717
|
+
|
|
718
|
+
/**
|
|
719
|
+
* Triggers when the scheduler component is destroyed.
|
|
720
|
+
*
|
|
721
|
+
* @event 'destroyed'
|
|
722
|
+
*/
|
|
723
|
+
destroyed?: EmitType<Record<string, any>>;
|
|
724
|
+
|
|
725
|
+
/**
|
|
726
|
+
* Triggers when the scheduler cells are single clicked or on single tap on the same cells in mobile devices.
|
|
727
|
+
*
|
|
728
|
+
* @event 'cellClick'
|
|
729
|
+
*/
|
|
730
|
+
cellClick?: EmitType<CellClickEventArgs>;
|
|
731
731
|
|
|
732
732
|
/**
|
|
733
|
-
* Triggers when the scheduler cells are double clicked.
|
|
734
|
-
*
|
|
735
|
-
* @event 'cellDoubleClick'
|
|
736
|
-
*/
|
|
737
|
-
cellDoubleClick?: EmitType<CellClickEventArgs>;
|
|
733
|
+
* Triggers when the scheduler cells are double clicked.
|
|
734
|
+
*
|
|
735
|
+
* @event 'cellDoubleClick'
|
|
736
|
+
*/
|
|
737
|
+
cellDoubleClick?: EmitType<CellClickEventArgs>;
|
|
738
738
|
|
|
739
739
|
/**
|
|
740
|
-
* Triggers when the more events indicator are clicked.
|
|
741
|
-
*
|
|
742
|
-
* @event 'moreEventsClick'
|
|
743
|
-
*/
|
|
744
|
-
moreEventsClick?: EmitType<MoreEventsClickArgs>;
|
|
740
|
+
* Triggers when the more events indicator are clicked.
|
|
741
|
+
*
|
|
742
|
+
* @event 'moreEventsClick'
|
|
743
|
+
*/
|
|
744
|
+
moreEventsClick?: EmitType<MoreEventsClickArgs>;
|
|
745
745
|
|
|
746
746
|
/**
|
|
747
|
-
* Triggers when the scheduler elements are hovered.
|
|
748
|
-
*
|
|
749
|
-
* @event 'hover'
|
|
750
|
-
*/
|
|
751
|
-
hover?: EmitType<HoverEventArgs>;
|
|
747
|
+
* Triggers when the scheduler elements are hovered.
|
|
748
|
+
*
|
|
749
|
+
* @event 'hover'
|
|
750
|
+
*/
|
|
751
|
+
hover?: EmitType<HoverEventArgs>;
|
|
752
752
|
|
|
753
753
|
/**
|
|
754
|
-
* Triggers when multiple cells or events are selected on the Scheduler.
|
|
755
|
-
*
|
|
756
|
-
* @event 'select'
|
|
757
|
-
*/
|
|
758
|
-
select?: EmitType<SelectEventArgs>;
|
|
754
|
+
* Triggers when multiple cells or events are selected on the Scheduler.
|
|
755
|
+
*
|
|
756
|
+
* @event 'select'
|
|
757
|
+
*/
|
|
758
|
+
select?: EmitType<SelectEventArgs>;
|
|
759
759
|
|
|
760
760
|
/**
|
|
761
|
-
* Triggers on beginning of every scheduler action.
|
|
762
|
-
*
|
|
763
|
-
* @event 'actionBegin'
|
|
764
|
-
*/
|
|
765
|
-
actionBegin?: EmitType<ActionEventArgs>;
|
|
761
|
+
* Triggers on beginning of every scheduler action.
|
|
762
|
+
*
|
|
763
|
+
* @event 'actionBegin'
|
|
764
|
+
*/
|
|
765
|
+
actionBegin?: EmitType<ActionEventArgs>;
|
|
766
766
|
|
|
767
767
|
/**
|
|
768
|
-
* Triggers on successful completion of the scheduler actions.
|
|
769
|
-
*
|
|
770
|
-
* @event 'actionComplete'
|
|
771
|
-
*/
|
|
772
|
-
actionComplete?: EmitType<ActionEventArgs>;
|
|
768
|
+
* Triggers on successful completion of the scheduler actions.
|
|
769
|
+
*
|
|
770
|
+
* @event 'actionComplete'
|
|
771
|
+
*/
|
|
772
|
+
actionComplete?: EmitType<ActionEventArgs>;
|
|
773
773
|
|
|
774
774
|
/**
|
|
775
|
-
* Triggers when a scheduler action gets failed or interrupted and an error information will be returned.
|
|
776
|
-
*
|
|
777
|
-
* @event 'actionFailure'
|
|
778
|
-
*/
|
|
779
|
-
actionFailure?: EmitType<ActionEventArgs>;
|
|
775
|
+
* Triggers when a scheduler action gets failed or interrupted and an error information will be returned.
|
|
776
|
+
*
|
|
777
|
+
* @event 'actionFailure'
|
|
778
|
+
*/
|
|
779
|
+
actionFailure?: EmitType<ActionEventArgs>;
|
|
780
780
|
|
|
781
781
|
/**
|
|
782
|
-
* Triggers before the date or view navigation takes place on scheduler.
|
|
783
|
-
*
|
|
784
|
-
* @event 'navigating'
|
|
785
|
-
*/
|
|
786
|
-
navigating?: EmitType<NavigatingEventArgs>;
|
|
782
|
+
* Triggers before the date or view navigation takes place on scheduler.
|
|
783
|
+
*
|
|
784
|
+
* @event 'navigating'
|
|
785
|
+
*/
|
|
786
|
+
navigating?: EmitType<NavigatingEventArgs>;
|
|
787
787
|
|
|
788
788
|
/**
|
|
789
|
-
* Triggers before each element of the schedule rendering on the page.
|
|
790
|
-
*
|
|
791
|
-
* @event 'renderCell'
|
|
792
|
-
*/
|
|
793
|
-
renderCell?: EmitType<RenderCellEventArgs>;
|
|
789
|
+
* Triggers before each element of the schedule rendering on the page.
|
|
790
|
+
*
|
|
791
|
+
* @event 'renderCell'
|
|
792
|
+
*/
|
|
793
|
+
renderCell?: EmitType<RenderCellEventArgs>;
|
|
794
794
|
|
|
795
795
|
/**
|
|
796
|
-
* Triggers when the events are single clicked or on single tapping the events on the mobile devices.
|
|
797
|
-
*
|
|
798
|
-
* @event 'eventClick'
|
|
799
|
-
*/
|
|
800
|
-
eventClick?: EmitType<EventClickArgs>;
|
|
796
|
+
* Triggers when the events are single clicked or on single tapping the events on the mobile devices.
|
|
797
|
+
*
|
|
798
|
+
* @event 'eventClick'
|
|
799
|
+
*/
|
|
800
|
+
eventClick?: EmitType<EventClickArgs>;
|
|
801
801
|
|
|
802
802
|
/**
|
|
803
|
-
* Triggers when the events are double clicked or on double tapping the events on the desktop devices.
|
|
804
|
-
*
|
|
805
|
-
* @event 'eventDoubleClick'
|
|
806
|
-
*/
|
|
807
|
-
eventDoubleClick?: EmitType<EventClickArgs>;
|
|
803
|
+
* Triggers when the events are double clicked or on double tapping the events on the desktop devices.
|
|
804
|
+
*
|
|
805
|
+
* @event 'eventDoubleClick'
|
|
806
|
+
*/
|
|
807
|
+
eventDoubleClick?: EmitType<EventClickArgs>;
|
|
808
808
|
|
|
809
809
|
/**
|
|
810
|
-
* Triggers before each of the event getting rendered on the scheduler user interface.
|
|
811
|
-
*
|
|
812
|
-
* @event 'eventRendered'
|
|
813
|
-
*/
|
|
814
|
-
eventRendered?: EmitType<EventRenderedArgs>;
|
|
810
|
+
* Triggers before each of the event getting rendered on the scheduler user interface.
|
|
811
|
+
*
|
|
812
|
+
* @event 'eventRendered'
|
|
813
|
+
*/
|
|
814
|
+
eventRendered?: EmitType<EventRenderedArgs>;
|
|
815
815
|
|
|
816
816
|
/**
|
|
817
|
-
* Triggers before the data binds to the scheduler.
|
|
818
|
-
*
|
|
819
|
-
* @event 'dataBinding'
|
|
820
|
-
*/
|
|
821
|
-
dataBinding?: EmitType<ReturnType>;
|
|
817
|
+
* Triggers before the data binds to the scheduler.
|
|
818
|
+
*
|
|
819
|
+
* @event 'dataBinding'
|
|
820
|
+
*/
|
|
821
|
+
dataBinding?: EmitType<ReturnType>;
|
|
822
822
|
|
|
823
823
|
/**
|
|
824
|
-
* Triggers before any of the scheduler popups opens on the page.
|
|
825
|
-
*
|
|
826
|
-
* @event 'popupOpen'
|
|
827
|
-
*/
|
|
828
|
-
popupOpen?: EmitType<PopupOpenEventArgs>;
|
|
824
|
+
* Triggers before any of the scheduler popups opens on the page.
|
|
825
|
+
*
|
|
826
|
+
* @event 'popupOpen'
|
|
827
|
+
*/
|
|
828
|
+
popupOpen?: EmitType<PopupOpenEventArgs>;
|
|
829
829
|
|
|
830
830
|
/**
|
|
831
|
-
* Triggers before any of the scheduler popups close on the page.
|
|
832
|
-
*
|
|
833
|
-
* @event 'popupClose'
|
|
834
|
-
*/
|
|
835
|
-
popupClose?: EmitType<PopupCloseEventArgs>;
|
|
831
|
+
* Triggers before any of the scheduler popups close on the page.
|
|
832
|
+
*
|
|
833
|
+
* @event 'popupClose'
|
|
834
|
+
*/
|
|
835
|
+
popupClose?: EmitType<PopupCloseEventArgs>;
|
|
836
836
|
|
|
837
837
|
/**
|
|
838
|
-
* Triggers when an appointment is started to drag.
|
|
839
|
-
*
|
|
840
|
-
* @event 'dragStart'
|
|
841
|
-
*/
|
|
842
|
-
dragStart?: EmitType<DragEventArgs>;
|
|
838
|
+
* Triggers when an appointment is started to drag.
|
|
839
|
+
*
|
|
840
|
+
* @event 'dragStart'
|
|
841
|
+
*/
|
|
842
|
+
dragStart?: EmitType<DragEventArgs>;
|
|
843
843
|
|
|
844
844
|
/**
|
|
845
|
-
* Triggers when an appointment is being in a dragged state.
|
|
846
|
-
*
|
|
847
|
-
* @event 'drag'
|
|
848
|
-
*/
|
|
849
|
-
drag?: EmitType<DragEventArgs>;
|
|
845
|
+
* Triggers when an appointment is being in a dragged state.
|
|
846
|
+
*
|
|
847
|
+
* @event 'drag'
|
|
848
|
+
*/
|
|
849
|
+
drag?: EmitType<DragEventArgs>;
|
|
850
850
|
|
|
851
851
|
/**
|
|
852
|
-
* Triggers when the dragging of appointment is stopped.
|
|
853
|
-
*
|
|
854
|
-
* @event 'dragStop'
|
|
855
|
-
*/
|
|
856
|
-
dragStop?: EmitType<DragEventArgs>;
|
|
852
|
+
* Triggers when the dragging of appointment is stopped.
|
|
853
|
+
*
|
|
854
|
+
* @event 'dragStop'
|
|
855
|
+
*/
|
|
856
|
+
dragStop?: EmitType<DragEventArgs>;
|
|
857
857
|
|
|
858
858
|
/**
|
|
859
|
-
* Triggers when an appointment is started to resize.
|
|
860
|
-
*
|
|
861
|
-
* @event 'resizeStart'
|
|
862
|
-
*/
|
|
863
|
-
resizeStart?: EmitType<ResizeEventArgs>;
|
|
859
|
+
* Triggers when an appointment is started to resize.
|
|
860
|
+
*
|
|
861
|
+
* @event 'resizeStart'
|
|
862
|
+
*/
|
|
863
|
+
resizeStart?: EmitType<ResizeEventArgs>;
|
|
864
864
|
|
|
865
865
|
/**
|
|
866
|
-
* Triggers when an appointment is being in a resizing action.
|
|
867
|
-
*
|
|
868
|
-
* @event 'resizing'
|
|
869
|
-
*/
|
|
870
|
-
resizing?: EmitType<ResizeEventArgs>;
|
|
866
|
+
* Triggers when an appointment is being in a resizing action.
|
|
867
|
+
*
|
|
868
|
+
* @event 'resizing'
|
|
869
|
+
*/
|
|
870
|
+
resizing?: EmitType<ResizeEventArgs>;
|
|
871
871
|
|
|
872
872
|
/**
|
|
873
|
-
* Triggers when the resizing of appointment is stopped.
|
|
874
|
-
*
|
|
875
|
-
* @event 'resizeStop'
|
|
876
|
-
*/
|
|
877
|
-
resizeStop?: EmitType<ResizeEventArgs>;
|
|
873
|
+
* Triggers when the resizing of appointment is stopped.
|
|
874
|
+
*
|
|
875
|
+
* @event 'resizeStop'
|
|
876
|
+
*/
|
|
877
|
+
resizeStop?: EmitType<ResizeEventArgs>;
|
|
878
878
|
|
|
879
879
|
/**
|
|
880
|
-
* Triggers when the scroll action is started.
|
|
881
|
-
* This event triggers only when `allowVirtualScrolling` or `enableLazyLoading` properties are enabled along with resource grouping.
|
|
882
|
-
*
|
|
883
|
-
* @event 'virtualScrollStart'
|
|
884
|
-
*/
|
|
885
|
-
virtualScrollStart?: EmitType<ScrollEventArgs>;
|
|
880
|
+
* Triggers when the scroll action is started.
|
|
881
|
+
* This event triggers only when `allowVirtualScrolling` or `enableLazyLoading` properties are enabled along with resource grouping.
|
|
882
|
+
*
|
|
883
|
+
* @event 'virtualScrollStart'
|
|
884
|
+
*/
|
|
885
|
+
virtualScrollStart?: EmitType<ScrollEventArgs>;
|
|
886
886
|
|
|
887
887
|
/**
|
|
888
|
-
* Triggers when the scroll action is stopped.
|
|
889
|
-
* This event triggers only when `allowVirtualScrolling` or `enableLazyLoading` properties are enabled along with resource grouping.
|
|
890
|
-
*
|
|
891
|
-
* @event 'virtualScrollStop'
|
|
892
|
-
*/
|
|
893
|
-
virtualScrollStop?: EmitType<ScrollEventArgs>;
|
|
888
|
+
* Triggers when the scroll action is stopped.
|
|
889
|
+
* This event triggers only when `allowVirtualScrolling` or `enableLazyLoading` properties are enabled along with resource grouping.
|
|
890
|
+
*
|
|
891
|
+
* @event 'virtualScrollStop'
|
|
892
|
+
*/
|
|
893
|
+
virtualScrollStop?: EmitType<ScrollEventArgs>;
|
|
894
894
|
|
|
895
895
|
/**
|
|
896
|
-
* Triggers once the event data is bound to the scheduler.
|
|
897
|
-
*
|
|
898
|
-
* @event 'dataBound'
|
|
899
|
-
*/
|
|
900
|
-
dataBound?: EmitType<ReturnType>;
|
|
896
|
+
* Triggers once the event data is bound to the scheduler.
|
|
897
|
+
*
|
|
898
|
+
* @event 'dataBound'
|
|
899
|
+
*/
|
|
900
|
+
dataBound?: EmitType<ReturnType>;
|
|
901
901
|
|
|
902
902
|
/**
|
|
903
|
-
* Triggers once when pasting an event on the scheduler.
|
|
904
|
-
*
|
|
905
|
-
* @event 'beforePaste'
|
|
906
|
-
*/
|
|
907
|
-
beforePaste?: EmitType<BeforePasteEventArgs>;
|
|
903
|
+
* Triggers once when pasting an event on the scheduler.
|
|
904
|
+
*
|
|
905
|
+
* @event 'beforePaste'
|
|
906
|
+
*/
|
|
907
|
+
beforePaste?: EmitType<BeforePasteEventArgs>;
|
|
908
908
|
|
|
909
909
|
/**
|
|
910
|
-
* Triggers when the print event is called.
|
|
911
|
-
*
|
|
912
|
-
* @event 'beforePrint'
|
|
913
|
-
*/
|
|
914
|
-
beforePrint?: EmitType<BeforePrintEventArgs>;
|
|
910
|
+
* Triggers when the print event is called.
|
|
911
|
+
*
|
|
912
|
+
* @event 'beforePrint'
|
|
913
|
+
*/
|
|
914
|
+
beforePrint?: EmitType<BeforePrintEventArgs>;
|
|
915
915
|
|
|
916
916
|
/**
|
|
917
|
-
* Triggers before the Excel export process begins.
|
|
918
|
-
*
|
|
919
|
-
* @event 'excelExport'
|
|
920
|
-
*/
|
|
921
|
-
excelExport?: EmitType<ExcelExportEventArgs>;
|
|
917
|
+
* Triggers before the Excel export process begins.
|
|
918
|
+
*
|
|
919
|
+
* @event 'excelExport'
|
|
920
|
+
*/
|
|
921
|
+
excelExport?: EmitType<ExcelExportEventArgs>;
|
|
922
922
|
|
|
923
923
|
/**
|
|
924
|
-
* Triggers before the tooltip is rendered.
|
|
925
|
-
*
|
|
926
|
-
* @event 'tooltipOpen'
|
|
927
|
-
*/
|
|
928
|
-
tooltipOpen?: EmitType<TooltipOpenEventArgs>;
|
|
924
|
+
* Triggers before the tooltip is rendered.
|
|
925
|
+
*
|
|
926
|
+
* @event 'tooltipOpen'
|
|
927
|
+
*/
|
|
928
|
+
tooltipOpen?: EmitType<TooltipOpenEventArgs>;
|
|
929
929
|
|
|
930
930
|
}
|