@syncfusion/ej2-schedule 19.3.55 → 19.4.42

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.
Files changed (121) hide show
  1. package/.github/PULL_REQUEST_TEMPLATE/Bug.md +63 -0
  2. package/.github/PULL_REQUEST_TEMPLATE/Feature.md +39 -0
  3. package/CHANGELOG.md +50 -1
  4. package/dist/ej2-schedule.umd.min.js +2 -2
  5. package/dist/ej2-schedule.umd.min.js.map +1 -1
  6. package/dist/es6/ej2-schedule.es2015.js +489 -145
  7. package/dist/es6/ej2-schedule.es2015.js.map +1 -1
  8. package/dist/es6/ej2-schedule.es5.js +493 -152
  9. package/dist/es6/ej2-schedule.es5.js.map +1 -1
  10. package/dist/global/ej2-schedule.min.js +2 -2
  11. package/dist/global/ej2-schedule.min.js.map +1 -1
  12. package/dist/global/index.d.ts +1 -1
  13. package/package.json +15 -15
  14. package/src/recurrence-editor/recurrence-editor.js +2 -2
  15. package/src/schedule/actions/drag.js +12 -4
  16. package/src/schedule/actions/keyboard.d.ts +7 -0
  17. package/src/schedule/actions/keyboard.js +197 -28
  18. package/src/schedule/actions/resize.js +44 -37
  19. package/src/schedule/base/css-constant.d.ts +6 -0
  20. package/src/schedule/base/css-constant.js +6 -0
  21. package/src/schedule/base/interface.d.ts +12 -0
  22. package/src/schedule/base/resource.js +1 -0
  23. package/src/schedule/base/schedule-model.d.ts +89 -20
  24. package/src/schedule/base/schedule.d.ts +88 -19
  25. package/src/schedule/base/schedule.js +15 -4
  26. package/src/schedule/base/util.d.ts +1 -0
  27. package/src/schedule/base/util.js +1 -0
  28. package/src/schedule/event-renderer/event-base.d.ts +2 -1
  29. package/src/schedule/event-renderer/event-base.js +19 -4
  30. package/src/schedule/event-renderer/inline-edit.js +8 -5
  31. package/src/schedule/event-renderer/month.js +3 -2
  32. package/src/schedule/event-renderer/timeline-view.js +4 -0
  33. package/src/schedule/event-renderer/vertical-view.js +9 -6
  34. package/src/schedule/event-renderer/year.js +1 -1
  35. package/src/schedule/exports/excel-export.d.ts +2 -1
  36. package/src/schedule/exports/excel-export.js +21 -18
  37. package/src/schedule/models/event-settings-model.d.ts +17 -9
  38. package/src/schedule/models/event-settings.d.ts +15 -8
  39. package/src/schedule/models/event-settings.js +6 -3
  40. package/src/schedule/models/views-model.d.ts +19 -0
  41. package/src/schedule/models/views.d.ts +17 -0
  42. package/src/schedule/models/views.js +6 -0
  43. package/src/schedule/popups/quick-popups.js +3 -0
  44. package/src/schedule/renderer/agenda.js +2 -1
  45. package/src/schedule/renderer/header-renderer.d.ts +1 -0
  46. package/src/schedule/renderer/header-renderer.js +23 -8
  47. package/src/schedule/renderer/month.d.ts +4 -0
  48. package/src/schedule/renderer/month.js +69 -19
  49. package/src/schedule/renderer/renderer.js +6 -1
  50. package/src/schedule/renderer/timeline-year.js +4 -1
  51. package/src/schedule/renderer/view-base.js +12 -1
  52. package/src/schedule/renderer/year.d.ts +2 -2
  53. package/src/schedule/renderer/year.js +24 -6
  54. package/styles/bootstrap-dark.css +108 -27
  55. package/styles/bootstrap.css +105 -27
  56. package/styles/bootstrap4.css +117 -62
  57. package/styles/bootstrap5-dark.css +118 -67
  58. package/styles/bootstrap5.css +118 -67
  59. package/styles/fabric-dark.css +108 -26
  60. package/styles/fabric.css +109 -26
  61. package/styles/highcontrast-light.css +104 -26
  62. package/styles/highcontrast.css +109 -28
  63. package/styles/material-dark.css +110 -32
  64. package/styles/material.css +103 -25
  65. package/styles/recurrence-editor/_bootstrap-dark-definition.scss +7 -0
  66. package/styles/recurrence-editor/_bootstrap-definition.scss +7 -0
  67. package/styles/recurrence-editor/_bootstrap4-definition.scss +7 -0
  68. package/styles/recurrence-editor/_bootstrap5-definition.scss +7 -0
  69. package/styles/recurrence-editor/_fabric-dark-definition.scss +8 -0
  70. package/styles/recurrence-editor/_fabric-definition.scss +7 -0
  71. package/styles/recurrence-editor/_fluent-definition.scss +15 -0
  72. package/styles/recurrence-editor/_highcontrast-definition.scss +7 -0
  73. package/styles/recurrence-editor/_highcontrast-light-definition.scss +7 -0
  74. package/styles/recurrence-editor/_layout.scss +20 -4
  75. package/styles/recurrence-editor/_material-dark-definition.scss +7 -0
  76. package/styles/recurrence-editor/_material-definition.scss +7 -0
  77. package/styles/recurrence-editor/_tailwind-definition.scss +15 -8
  78. package/styles/recurrence-editor/bootstrap-dark.css +20 -4
  79. package/styles/recurrence-editor/bootstrap.css +20 -4
  80. package/styles/recurrence-editor/bootstrap4.css +20 -4
  81. package/styles/recurrence-editor/bootstrap5-dark.css +20 -4
  82. package/styles/recurrence-editor/bootstrap5.css +20 -4
  83. package/styles/recurrence-editor/fabric-dark.css +20 -4
  84. package/styles/recurrence-editor/fabric.css +20 -4
  85. package/styles/recurrence-editor/highcontrast-light.css +20 -4
  86. package/styles/recurrence-editor/highcontrast.css +20 -4
  87. package/styles/recurrence-editor/material-dark.css +20 -4
  88. package/styles/recurrence-editor/material.css +20 -4
  89. package/styles/recurrence-editor/tailwind-dark.css +20 -4
  90. package/styles/recurrence-editor/tailwind.css +20 -4
  91. package/styles/schedule/_bootstrap-dark-definition.scss +22 -1
  92. package/styles/schedule/_bootstrap-definition.scss +22 -1
  93. package/styles/schedule/_bootstrap4-definition.scss +23 -1
  94. package/styles/schedule/_bootstrap5-definition.scss +145 -119
  95. package/styles/schedule/_fabric-dark-definition.scss +22 -1
  96. package/styles/schedule/_fabric-definition.scss +22 -1
  97. package/styles/schedule/_fluent-definition.scss +218 -0
  98. package/styles/schedule/_highcontrast-definition.scss +22 -1
  99. package/styles/schedule/_highcontrast-light-definition.scss +22 -1
  100. package/styles/schedule/_layout.scss +95 -158
  101. package/styles/schedule/_material-dark-definition.scss +22 -1
  102. package/styles/schedule/_material-definition.scss +21 -0
  103. package/styles/schedule/_tailwind-definition.scss +216 -195
  104. package/styles/schedule/_theme.scss +1 -1
  105. package/styles/schedule/bootstrap-dark.css +88 -23
  106. package/styles/schedule/bootstrap.css +85 -23
  107. package/styles/schedule/bootstrap4.css +97 -58
  108. package/styles/schedule/bootstrap5-dark.css +98 -63
  109. package/styles/schedule/bootstrap5.css +98 -63
  110. package/styles/schedule/fabric-dark.css +88 -22
  111. package/styles/schedule/fabric.css +89 -22
  112. package/styles/schedule/highcontrast-light.css +84 -22
  113. package/styles/schedule/highcontrast.css +89 -24
  114. package/styles/schedule/icons/_fluent.scss +231 -0
  115. package/styles/schedule/icons/_tailwind.scss +231 -231
  116. package/styles/schedule/material-dark.css +90 -28
  117. package/styles/schedule/material.css +83 -21
  118. package/styles/schedule/tailwind-dark.css +94 -52
  119. package/styles/schedule/tailwind.css +94 -52
  120. package/styles/tailwind-dark.css +114 -56
  121. package/styles/tailwind.css +114 -56
@@ -1,4 +1,4 @@
1
- import { Component, ModuleDeclaration, Property, Event, Animation, Collection, append } from '@syncfusion/ej2-base';import { EventHandler, EmitType, Browser, Internationalization, getDefaultDateObject, cldrData, L10n } from '@syncfusion/ej2-base';import { getValue, compile, extend, isNullOrUndefined, NotifyPropertyChanges, INotifyPropertyChanged, Complex } from '@syncfusion/ej2-base';import { getElement, removeClass, addClass, classList, remove } from '@syncfusion/ej2-base';import { createSpinner, hideSpinner, showSpinner } from '@syncfusion/ej2-popups';import { HeaderRenderer } from '../renderer/header-renderer';import { Scroll } from '../actions/scroll';import { ScheduleTouch } from '../actions/touch';import { KeyboardInteraction } from '../actions/keyboard';import { Data } from '../actions/data';import { View, CurrentAction, ReturnType, WeekRule } from '../base/type';import { EventBase } from '../event-renderer/event-base';import { InlineEdit } from '../event-renderer/inline-edit';import { QuickPopups } from '../popups/quick-popups';import { EventTooltip } from '../popups/event-tooltip';import { EventWindow } from '../popups/event-window';import { Render } from '../renderer/renderer';import { Day } from '../renderer/day';import { Week } from '../renderer/week';import { WorkWeek } from '../renderer/work-week';import { Month } from '../renderer/month';import { Year } from '../renderer/year';import { Agenda } from '../renderer/agenda';import { MonthAgenda } from '../renderer/month-agenda';import { TimelineViews } from '../renderer/timeline-view';import { TimelineMonth } from '../renderer/timeline-month';import { TimelineYear } from '../renderer/timeline-year';import { WorkHours } from '../models/work-hours';import { TimeScale } from '../models/time-scale';import { QuickInfoTemplates } from '../models/quick-info-templates';import { HeaderRows } from '../models/header-rows';import { Crud } from '../actions/crud';import { Resize } from '../actions/resize';import { DragAndDrop } from '../actions/drag';import { VirtualScroll } from '../actions/virtual-scroll';import { WorkCellInteraction } from '../actions/work-cells';import { WorkHoursModel, ViewsModel, EventSettingsModel, GroupModel, ResourcesModel, TimeScaleModel } from '../models/models';import { QuickInfoTemplatesModel, HeaderRowsModel } from '../models/models';import { EventSettings } from '../models/event-settings';import { Group } from '../models/group';import { Resources } from '../models/resources';import { ICalendarExport } from '../exports/calendar-export';import { ICalendarImport } from '../exports/calendar-import';import { ExcelExport } from '../exports/excel-export';import { Print } from '../exports/print';import { IRenderer, ActionEventArgs, NavigatingEventArgs, CellClickEventArgs, RenderCellEventArgs, ScrollCss, TimezoneFields } from '../base/interface';import { EventClickArgs, EventRenderedArgs, PopupOpenEventArgs, UIStateArgs, DragEventArgs, ResizeEventArgs } from '../base/interface';import { EventFieldsMapping, TdData, ResourceDetails, ResizeEdges, StateArgs, ExportOptions, SelectEventArgs } from '../base/interface';import { ViewsData, PopupCloseEventArgs, HoverEventArgs, MoreEventsClickArgs, CallbackFunction } from '../base/interface';import { CalendarUtil, Gregorian, Islamic, CalendarType } from '../../common/calendar-util';import { ResourceBase } from '../base/resource';import { Timezone, timezoneData} from '../timezone/timezone';import { RecurrenceEditor } from '../../recurrence-editor/recurrence-editor';import * as events from '../base/constant';import * as cls from '../base/css-constant';import * as util from '../base/util';
1
+ import { Component, ModuleDeclaration, Property, Event, Animation, Collection, append } from '@syncfusion/ej2-base';import { EventHandler, EmitType, Browser, Internationalization, getDefaultDateObject, cldrData, L10n } from '@syncfusion/ej2-base';import { getValue, compile, extend, isNullOrUndefined, NotifyPropertyChanges, INotifyPropertyChanged, Complex } from '@syncfusion/ej2-base';import { getElement, removeClass, addClass, classList, remove } from '@syncfusion/ej2-base';import { createSpinner, hideSpinner, showSpinner } from '@syncfusion/ej2-popups';import { HeaderRenderer } from '../renderer/header-renderer';import { Scroll } from '../actions/scroll';import { ScheduleTouch } from '../actions/touch';import { KeyboardInteraction } from '../actions/keyboard';import { Data } from '../actions/data';import { View, CurrentAction, ReturnType, WeekRule } from '../base/type';import { EventBase } from '../event-renderer/event-base';import { InlineEdit } from '../event-renderer/inline-edit';import { QuickPopups } from '../popups/quick-popups';import { EventTooltip } from '../popups/event-tooltip';import { EventWindow } from '../popups/event-window';import { Render } from '../renderer/renderer';import { Day } from '../renderer/day';import { Week } from '../renderer/week';import { WorkWeek } from '../renderer/work-week';import { Month } from '../renderer/month';import { Year } from '../renderer/year';import { Agenda } from '../renderer/agenda';import { MonthAgenda } from '../renderer/month-agenda';import { TimelineViews } from '../renderer/timeline-view';import { TimelineMonth } from '../renderer/timeline-month';import { TimelineYear } from '../renderer/timeline-year';import { WorkHours } from '../models/work-hours';import { TimeScale } from '../models/time-scale';import { QuickInfoTemplates } from '../models/quick-info-templates';import { HeaderRows } from '../models/header-rows';import { Crud } from '../actions/crud';import { Resize } from '../actions/resize';import { DragAndDrop } from '../actions/drag';import { VirtualScroll } from '../actions/virtual-scroll';import { WorkCellInteraction } from '../actions/work-cells';import { WorkHoursModel, ViewsModel, EventSettingsModel, GroupModel, ResourcesModel, TimeScaleModel } from '../models/models';import { QuickInfoTemplatesModel, HeaderRowsModel } from '../models/models';import { EventSettings } from '../models/event-settings';import { Group } from '../models/group';import { Resources } from '../models/resources';import { ICalendarExport } from '../exports/calendar-export';import { ICalendarImport } from '../exports/calendar-import';import { ExcelExport } from '../exports/excel-export';import { Print } from '../exports/print';import { IRenderer, ActionEventArgs, NavigatingEventArgs, CellClickEventArgs, RenderCellEventArgs, ScrollCss, TimezoneFields } from '../base/interface';import { EventClickArgs, EventRenderedArgs, PopupOpenEventArgs, UIStateArgs, DragEventArgs, ResizeEventArgs } from '../base/interface';import { EventFieldsMapping, TdData, ResourceDetails, ResizeEdges, StateArgs, ExportOptions, SelectEventArgs } from '../base/interface';import { ViewsData, PopupCloseEventArgs, HoverEventArgs, MoreEventsClickArgs, CallbackFunction } from '../base/interface';import { CalendarUtil, Gregorian, Islamic, CalendarType } from '../../common/calendar-util';import { ResourceBase } from '../base/resource';import { Timezone, timezoneData } from '../timezone/timezone';import { RecurrenceEditor } from '../../recurrence-editor/recurrence-editor';import * as events from '../base/constant';import * as cls from '../base/css-constant';import * as util from '../base/util';
2
2
  import {ComponentModel} from '@syncfusion/ej2-base';
3
3
 
4
4
  /**
@@ -8,7 +8,9 @@ export interface ScheduleModel extends ComponentModel{
8
8
 
9
9
  /**
10
10
  * Sets the `width` of the Schedule component, accepting both string and number values.
11
+ *
11
12
  * {% codeBlock src='schedule/width/index.md' %}{% endcodeBlock %}
13
+ *
12
14
  * The string value can be either pixel or percentage format.
13
15
  * When set to `auto`, the Schedule width gets auto-adjusted and display its content related to the viewable screen size.
14
16
  *
@@ -18,7 +20,9 @@ export interface ScheduleModel extends ComponentModel{
18
20
 
19
21
  /**
20
22
  * Sets the `height` of the Schedule component, accepting both string and number values.
23
+ *
21
24
  * {% codeBlock src='schedule/height/index.md' %}{% endcodeBlock %}
25
+ *
22
26
  * The string type includes either pixel or percentage values.
23
27
  * When `height` is set with specific pixel value, then the Schedule will be rendered to that specified space.
24
28
  * In case, if `auto` value is set, then the height of the Schedule gets auto-adjusted within the given container.
@@ -30,6 +34,7 @@ export interface ScheduleModel extends ComponentModel{
30
34
  /**
31
35
  * When set to `false`, hides the header bar of the Schedule from UI. By default,
32
36
  * the header bar holds the date and view navigation options, to which the user can add their own custom items onto it.
37
+ *
33
38
  * {% codeBlock src='schedule/showHeaderBar/index.md' %}{% endcodeBlock %}
34
39
  *
35
40
  * @default true
@@ -39,6 +44,7 @@ export interface ScheduleModel extends ComponentModel{
39
44
  /**
40
45
  * When set to `false`, hides the current time indicator from the Schedule. Otherwise,
41
46
  * it visually depicts the live current system time appropriately on the user interface.
47
+ *
42
48
  * {% codeBlock src='schedule/showTimeIndicator/index.md' %}{% endcodeBlock %}
43
49
  *
44
50
  * @default true
@@ -60,6 +66,7 @@ export interface ScheduleModel extends ComponentModel{
60
66
  * * TimelineWorkWeek
61
67
  * * TimelineMonth
62
68
  * * TimelineYear
69
+ *
63
70
  * {% codeBlock src='schedule/currentView/index.md' %}{% endcodeBlock %}
64
71
  *
65
72
  * @default 'Week'
@@ -70,8 +77,10 @@ export interface ScheduleModel extends ComponentModel{
70
77
  * This property holds the views collection and its configurations. It accepts either the array of view names or the array of view
71
78
  * objects that holds different configurations for each views. By default,
72
79
  * Schedule displays all the views namely `Day`, `Week`, `Work Week`, `Month` and `Agenda`.
80
+ *
73
81
  * Example for array of views:
74
82
  * {% codeBlock src="schedule/view-api/index.ts" %}{% endcodeBlock %}
83
+ *
75
84
  * Example for array of view objects:
76
85
  * {% codeBlock src="schedule/view-api/array.ts" %}{% endcodeBlock %}
77
86
  * {% codeBlock src='schedule/views/index.md' %}{% endcodeBlock %}
@@ -83,6 +92,7 @@ export interface ScheduleModel extends ComponentModel{
83
92
  /**
84
93
  * To mark the active (current) date on the Schedule, `selectedDate` property can be defined.
85
94
  * Usually, it defaults to the current System date.
95
+ *
86
96
  * {% codeBlock src='schedule/selectedDate/index.md' %}{% endcodeBlock %}
87
97
  *
88
98
  * @default 'new Date()'
@@ -93,6 +103,7 @@ export interface ScheduleModel extends ComponentModel{
93
103
  /**
94
104
  * To define the minimum date on the Schedule, `minDate` property can be defined.
95
105
  * Usually, it defaults to the new Date(1900, 0, 1).
106
+ *
96
107
  * {% codeBlock src='schedule/minDate/index.md' %}{% endcodeBlock %}
97
108
  *
98
109
  * @default new Date(1900, 0, 1)
@@ -103,6 +114,7 @@ export interface ScheduleModel extends ComponentModel{
103
114
  /**
104
115
  * To define the maximum date on the Schedule, `maxDate` property can be defined.
105
116
  * Usually, it defaults to the new Date(2099, 11, 31).
117
+ *
106
118
  * {% codeBlock src='schedule/maxDate/index.md' %}{% endcodeBlock %}
107
119
  *
108
120
  * @default new Date(2099, 11, 31)
@@ -113,7 +125,9 @@ export interface ScheduleModel extends ComponentModel{
113
125
  /**
114
126
  * By default, Schedule follows the date-format as per the default culture assigned to it.
115
127
  * It is also possible to manually set specific date format by using the `dateFormat` property.
128
+ *
116
129
  * {% codeBlock src='schedule/dateFormat/index.md' %}{% endcodeBlock %}
130
+ *
117
131
  * The format of the date range label in the header bar depends on the `dateFormat` value or else based on the
118
132
  * locale assigned to the Schedule.
119
133
  *
@@ -122,9 +136,11 @@ export interface ScheduleModel extends ComponentModel{
122
136
  dateFormat?: string;
123
137
 
124
138
  /**
125
- * It allows the Scheduler to display in other calendar modes.
139
+ * It allows the Scheduler to display in other calendar modes.
126
140
  * By default, Scheduler is displayed in `Gregorian` calendar mode.
141
+ *
127
142
  * {% codeBlock src='schedule/calendarMode/index.md' %}{% endcodeBlock %}
143
+ *
128
144
  * To change the mode, you can set either `Gregorian` or `Islamic` as a value to this `calendarMode` property.
129
145
  *
130
146
  * @default 'Gregorian'
@@ -134,7 +150,9 @@ export interface ScheduleModel extends ComponentModel{
134
150
  /**
135
151
  * 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
136
152
  * collection are usually treated as weekend days.
153
+ *
137
154
  * {% codeBlock src='schedule/showWeekend/index.md' %}{% endcodeBlock %}
155
+ *
138
156
  * Note: By default, this option is not applicable on `Work Week` view.
139
157
  * For example, if the working days are defined as [1, 2, 3, 4], then the remaining days of that week will be considered as
140
158
  * the weekend days and will be hidden on all the views.
@@ -147,6 +165,7 @@ export interface ScheduleModel extends ComponentModel{
147
165
  * 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
148
166
  * defines its own first day of week values. If needed, the user can set it manually on his own by defining the value through
149
167
  * this property. It usually accepts the integer values, whereby 0 is always denoted as Sunday, 1 as Monday and so on.
168
+ *
150
169
  * {% codeBlock src='schedule/firstDayOfWeek/index.md' %}{% endcodeBlock %}
151
170
  *
152
171
  * @default 0
@@ -159,6 +178,7 @@ export interface ScheduleModel extends ComponentModel{
159
178
  * * FirstDay
160
179
  * * FirstFourDayWeek
161
180
  * * FirstFullWeek
181
+ *
162
182
  * {% codeBlock src='schedule/weekRule/index.md' %}{% endcodeBlock %}
163
183
  *
164
184
  * @default 'FirstDay'
@@ -168,6 +188,7 @@ export interface ScheduleModel extends ComponentModel{
168
188
  /**
169
189
  * 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`
170
190
  * view whereas on other views, it will display all the usual days and simply highlights the working days with different shade.
191
+ *
171
192
  * {% codeBlock src='schedule/workDays/index.md' %}{% endcodeBlock %}
172
193
  *
173
194
  * @default '[1, 2, 3, 4, 5]'
@@ -177,6 +198,7 @@ export interface ScheduleModel extends ComponentModel{
177
198
 
178
199
  /**
179
200
  * This option allows the user to set the number of months count to be displayed on the Schedule.
201
+ *
180
202
  * {% codeBlock src='schedule/monthsCount/index.md' %}{% endcodeBlock %}
181
203
  *
182
204
  * @default 12
@@ -187,6 +209,7 @@ export interface ScheduleModel extends ComponentModel{
187
209
  /**
188
210
  * It is used to specify the starting hour, from which the Schedule starts to display. It accepts the time string in a short skeleton
189
211
  * format and also, hides the time beyond the specified start time.
212
+ *
190
213
  * {% codeBlock src='schedule/startHour/index.md' %}{% endcodeBlock %}
191
214
  *
192
215
  * @default '00:00'
@@ -195,6 +218,7 @@ export interface ScheduleModel extends ComponentModel{
195
218
 
196
219
  /**
197
220
  * It is used to specify the end hour, at which the Schedule ends. It too accepts the time string in a short skeleton format.
221
+ *
198
222
  * {% codeBlock src='schedule/endHour/index.md' %}{% endcodeBlock %}
199
223
  *
200
224
  * @default '24:00'
@@ -204,6 +228,7 @@ export interface ScheduleModel extends ComponentModel{
204
228
  /**
205
229
  * By default, Schedule follows the time-format as per the default culture assigned to it.
206
230
  * It is also possible to manually set specific time format by using the `timeFormat` property.
231
+ *
207
232
  * {% codeBlock src='schedule/timeFormat/index.md' %}{% endcodeBlock %}
208
233
  *
209
234
  * @default null
@@ -213,6 +238,7 @@ export interface ScheduleModel extends ComponentModel{
213
238
  /**
214
239
  * When set to `true`, If valid, the scroll on the all day row is activated when the all day row
215
240
  * height reaches the max height when the all day row is expanded.
241
+ *
216
242
  * {% codeBlock src='schedule/enableAllDayScroll/index.md' %}{% endcodeBlock %}
217
243
  *
218
244
  * @default false
@@ -221,6 +247,7 @@ export interface ScheduleModel extends ComponentModel{
221
247
 
222
248
  /**
223
249
  * 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.
250
+ *
224
251
  * {% codeBlock src='schedule/enableAdaptiveUI/index.md' %}{% endcodeBlock %}
225
252
  *
226
253
  * @default false
@@ -230,6 +257,7 @@ export interface ScheduleModel extends ComponentModel{
230
257
  /**
231
258
  * When set to `true`, allows the resizing of appointments. It allows the rescheduling of appointments either by changing the
232
259
  * start or end time by dragging the event resize handlers.
260
+ *
233
261
  * {% codeBlock src='schedule/allowResizing/index.md' %}{% endcodeBlock %}
234
262
  *
235
263
  * @default true
@@ -240,6 +268,7 @@ export interface ScheduleModel extends ComponentModel{
240
268
  * The working hours should be highlighted on Schedule with different color shade and an additional option must be provided to
241
269
  * highlight it or not. This functionality is handled through `workHours` property and the start work hour should be 9 AM by default
242
270
  * 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.
271
+ *
243
272
  * {% codeBlock src='schedule/workHours/index.md' %}{% endcodeBlock %}
244
273
  *
245
274
  * @default { highlight: true, start: '09:00', end: '18:00' }
@@ -249,6 +278,7 @@ export interface ScheduleModel extends ComponentModel{
249
278
  /**
250
279
  * Allows to set different time duration on Schedule along with the customized grid count. It also has template option to
251
280
  * customize the time slots with required time values in its own format.
281
+ *
252
282
  * {% codeBlock src='schedule/timeScale/index.md' %}{% endcodeBlock %}
253
283
  *
254
284
  * @default { enable: true, interval: 60, slotCount: 2, majorSlotTemplate: null, minorSlotTemplate: null }
@@ -257,6 +287,7 @@ export interface ScheduleModel extends ComponentModel{
257
287
 
258
288
  /**
259
289
  * When set to `true`, allows the keyboard interaction to take place on Schedule.
290
+ *
260
291
  * {% codeBlock src='schedule/allowKeyboardInteraction/index.md' %}{% endcodeBlock %}
261
292
  *
262
293
  * @default true
@@ -266,6 +297,7 @@ export interface ScheduleModel extends ComponentModel{
266
297
  /**
267
298
  * When set to `true`, allows the appointments to move over the time slots. When an appointment is dragged, both its start
268
299
  * and end time tends to change simultaneously allowing it to reschedule the appointment on some other time.
300
+ *
269
301
  * {% codeBlock src='schedule/allowDragAndDrop/index.md' %}{% endcodeBlock %}
270
302
  *
271
303
  * @default true
@@ -275,6 +307,7 @@ export interface ScheduleModel extends ComponentModel{
275
307
  /**
276
308
  * It accepts either the string or HTMLElement as template design content and parse it appropriately before displaying it onto
277
309
  * the date header cells. The field that can be accessed via this template is `date`.
310
+ *
278
311
  * {% codeBlock src='schedule/dateHeaderTemplate/index.md' %}{% endcodeBlock %}
279
312
  *
280
313
  * @default null
@@ -284,6 +317,7 @@ export interface ScheduleModel extends ComponentModel{
284
317
  /**
285
318
  * It accepts either the string or HTMLElement as template design content and parse it appropriately before displaying it onto
286
319
  * the month date cells. This template is only applicable for month view day cells.
320
+ *
287
321
  * {% codeBlock src='schedule/cellHeaderTemplate/index.md' %}{% endcodeBlock %}
288
322
  *
289
323
  * @default null
@@ -293,6 +327,7 @@ export interface ScheduleModel extends ComponentModel{
293
327
  /**
294
328
  * It accepts either the string or HTMLElement as template design content and parse it appropriately before displaying it onto
295
329
  * the day header cells. This template is only applicable for year view header cells.
330
+ *
296
331
  * {% codeBlock src='schedule/dayHeaderTemplate/index.md' %}{% endcodeBlock %}
297
332
  *
298
333
  * @default null
@@ -302,6 +337,7 @@ export interface ScheduleModel extends ComponentModel{
302
337
  /**
303
338
  * It accepts either the string or HTMLElement as template design content and parse it appropriately before displaying it onto
304
339
  * the month header cells. This template is only applicable for year view header cells.
340
+ *
305
341
  * {% codeBlock src='schedule/monthHeaderTemplate/index.md' %}{% endcodeBlock %}
306
342
  *
307
343
  * @default null
@@ -326,6 +362,7 @@ export interface ScheduleModel extends ComponentModel{
326
362
 
327
363
  /**
328
364
  * When set to `true`, makes the Schedule to render in a read only mode. No CRUD actions will be allowed at this time.
365
+ *
329
366
  * {% codeBlock src='schedule/readonly/index.md' %}{% endcodeBlock %}
330
367
  *
331
368
  * @default false
@@ -335,6 +372,7 @@ export interface ScheduleModel extends ComponentModel{
335
372
  /**
336
373
  * When set to `true`, displays a quick popup with cell or event details on single clicking over the cells or on events.
337
374
  * By default, it is set to `true`.
375
+ *
338
376
  * {% codeBlock src='schedule/showQuickInfo/index.md' %}{% endcodeBlock %}
339
377
  *
340
378
  * @default true
@@ -342,44 +380,44 @@ export interface ScheduleModel extends ComponentModel{
342
380
  showQuickInfo?: boolean;
343
381
 
344
382
  /**
345
- * This property helps user to add/edit the event in inline.
383
+ * This property helps user to add/edit the event in inline. By default, it is set to `false`.
384
+ *
346
385
  * {% codeBlock src='schedule/allowInline/index.md' %}{% endcodeBlock %}
347
- * By default, it is set to `false`.
348
386
  *
349
387
  * @default false
350
388
  */
351
389
  allowInline?: boolean;
352
390
 
353
391
  /**
354
- * This property helps user to allow/prevent the selection of multiple cells.
392
+ * This property helps user to allow/prevent the selection of multiple cells. By default, it is set to `true`.
393
+ *
355
394
  * {% codeBlock src='schedule/allowMultiCellSelection/index.md' %}{% endcodeBlock %}
356
- * By default, it is set to `true`.
357
395
  *
358
396
  * @default true
359
397
  */
360
398
  allowMultiCellSelection?: boolean;
361
399
 
362
400
  /**
363
- * This property helps user to allow/prevent the selection of multiple days(rows).
401
+ * This property helps user to allow/prevent the selection of multiple days(rows). By default, it is set to `true`.
402
+ *
364
403
  * {% codeBlock src='schedule/allowMultiRowSelection/index.md' %}{% endcodeBlock %}
365
- * By default, it is set to `true`.
366
404
  *
367
405
  * @default true
368
406
  */
369
407
  allowMultiRowSelection?: boolean;
370
408
 
371
409
  /**
372
- * This property helps to show quick popup after multiple cell selection.
410
+ * This property helps to show quick popup after multiple cell selection. By default, it is set to `false`.
411
+ *
373
412
  * {% codeBlock src='schedule/quickInfoOnSelectionEnd/index.md' %}{% endcodeBlock %}
374
- * By default, it is set to `false`.
375
413
  *
376
414
  * @default false
377
415
  */
378
416
  quickInfoOnSelectionEnd?: boolean;
379
417
 
380
418
  /**
381
- * When set to `true`, displays the week number of the current view date range.
382
- * By default, it is set to `false`.
419
+ * When set to `true`, displays the week number of the current view date range. By default, it is set to `false`.
420
+ *
383
421
  * {% codeBlock src='schedule/showWeekNumber/index.md' %}{% endcodeBlock %}
384
422
  *
385
423
  * @default false
@@ -389,6 +427,7 @@ export interface ScheduleModel extends ComponentModel{
389
427
  /**
390
428
  * when set to `true`, allows the height of the work-cells to adjust automatically
391
429
  * based on the number of appointments present in those time ranges.
430
+ *
392
431
  * {% codeBlock src='schedule/rowAutoHeight/index.md' %}{% endcodeBlock %}
393
432
  *
394
433
  * @default false
@@ -396,16 +435,18 @@ export interface ScheduleModel extends ComponentModel{
396
435
  rowAutoHeight?: boolean;
397
436
 
398
437
  /**
399
- * This property helps to drag the multiple selected events.
400
- * By default, it is set to `false`.
438
+ * This property helps to drag the multiple selected events. By default, it is set to `false`.
439
+ *
440
+ * {% codeBlock src='schedule/allowMultiDrag/index.md' %}{% endcodeBlock %}
401
441
  *
402
442
  * @default false
403
443
  */
404
444
  allowMultiDrag?: boolean;
405
445
 
406
446
  /**
407
- * This property helps render the year view customized months.
408
- * By default, it is set to `0`.
447
+ * This property helps render the year view customized months. By default, it is set to `0`.
448
+ *
449
+ * {% codeBlock src='schedule/firstMonthOfYear/index.md' %}{% endcodeBlock %}
409
450
  *
410
451
  * @default 0
411
452
  */
@@ -414,6 +455,7 @@ export interface ScheduleModel extends ComponentModel{
414
455
  /**
415
456
  * The template option to render the customized editor window. The form elements defined within this template should be accompanied
416
457
  * with `e-field` class, so as to fetch and process it from internally.
458
+ *
417
459
  * {% codeBlock src='schedule/editorTemplate/index.md' %}{% endcodeBlock %}
418
460
  *
419
461
  * @default null
@@ -423,6 +465,7 @@ export interface ScheduleModel extends ComponentModel{
423
465
  /**
424
466
  * The template option to customize the quick window. The three sections of the quick popup whereas the header, content,
425
467
  * and footer can be easily customized with individual template option.
468
+ *
426
469
  * {% codeBlock src='schedule/quickInfoTemplates/index.md' %}{% endcodeBlock %}
427
470
  *
428
471
  * @default null
@@ -432,6 +475,7 @@ export interface ScheduleModel extends ComponentModel{
432
475
  /**
433
476
  * Sets the number of days to be displayed by default in Agenda View and in case of virtual scrolling,
434
477
  * the number of days will be fetched on each scroll-end based on this count.
478
+ *
435
479
  * {% codeBlock src='schedule/agendaDaysCount/index.md' %}{% endcodeBlock %}
436
480
  *
437
481
  * @default 7
@@ -441,6 +485,7 @@ export interface ScheduleModel extends ComponentModel{
441
485
  /**
442
486
  * The days which does not has even a single event to display will be hidden from the UI of Agenda View by default.
443
487
  * When this property is set to `false`, the empty dates will also be displayed on the Schedule.
488
+ *
444
489
  * {% codeBlock src='schedule/hideEmptyAgendaDays/index.md' %}{% endcodeBlock %}
445
490
  *
446
491
  * @default true
@@ -448,8 +493,8 @@ export interface ScheduleModel extends ComponentModel{
448
493
  hideEmptyAgendaDays?: boolean;
449
494
 
450
495
  /**
451
- * The recurrence validation will be done by default
452
- * When this property is set to `false`, the recurrence validation will be skipped.
496
+ * The recurrence validation will be done by default. When this property is set to `false`, the recurrence validation will be skipped.
497
+ *
453
498
  * {% codeBlock src='schedule/enableRecurrenceValidation/index.md' %}{% endcodeBlock %}
454
499
  *
455
500
  * @default true
@@ -462,6 +507,7 @@ export interface ScheduleModel extends ComponentModel{
462
507
  * Whenever the Schedule is bound to remote data services, it is always recommended to set specific timezone to Schedule to make the
463
508
  * events on it to display on the same time irrespective of the system timezone. It usually accepts
464
509
  * the valid [IANA](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) timezone names.
510
+ *
465
511
  * {% codeBlock src='schedule/timezone/index.md' %}{% endcodeBlock %}
466
512
  *
467
513
  * @default null
@@ -471,6 +517,7 @@ export interface ScheduleModel extends ComponentModel{
471
517
  /**
472
518
  * Complete set of settings related to Schedule events to bind it to local or remote dataSource, map applicable database fields and
473
519
  * other validation to be carried out on the available fields.
520
+ *
474
521
  * {% codeBlock src='schedule/eventSettings/index.md' %}{% endcodeBlock %}
475
522
  *
476
523
  * @default null
@@ -479,6 +526,7 @@ export interface ScheduleModel extends ComponentModel{
479
526
 
480
527
  /**
481
528
  * 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.
529
+ *
482
530
  * {% codeBlock src='schedule/timezoneDatasource/index.md' %}{% endcodeBlock %}
483
531
  *
484
532
  * @default timezoneData
@@ -515,6 +563,7 @@ export interface ScheduleModel extends ComponentModel{
515
563
  /**
516
564
  * Allows defining the group related settings of multiple resources. When this property is non-empty, it means
517
565
  * that the resources will be grouped on the schedule layout based on the provided resource names.
566
+ *
518
567
  * {% codeBlock src='schedule/group/index.md' %}{% endcodeBlock %}
519
568
  *
520
569
  * @default {}
@@ -524,6 +573,7 @@ export interface ScheduleModel extends ComponentModel{
524
573
  /**
525
574
  * Allows defining the collection of resources to be displayed on the Schedule. The resource collection needs to be defined
526
575
  * with unique resource names to identify it along with the respective dataSource and field mapping options.
576
+ *
527
577
  * {% codeBlock src='schedule/resources/index.md' %}{% endcodeBlock %}
528
578
  *
529
579
  * @default []
@@ -533,6 +583,7 @@ export interface ScheduleModel extends ComponentModel{
533
583
  /**
534
584
  * Allows defining the collection of custom header rows to display the year, month, week, date and hour label as an individual row
535
585
  * on the timeline view of the scheduler.
586
+ *
536
587
  * {% codeBlock src='schedule/headerRows/index.md' %}{% endcodeBlock %}
537
588
  *
538
589
  * @default []
@@ -542,6 +593,7 @@ export interface ScheduleModel extends ComponentModel{
542
593
  /**
543
594
  * It is used to customize the Schedule which accepts custom CSS class names that defines specific user-defined styles and themes
544
595
  * to be applied on the Schedule element.
596
+ *
545
597
  * {% codeBlock src='schedule/cssClass/index.md' %}{% endcodeBlock %}
546
598
  *
547
599
  * @default null
@@ -550,8 +602,8 @@ export interface ScheduleModel extends ComponentModel{
550
602
 
551
603
  /**
552
604
  * It enables the external drag and drop support for appointments on scheduler, to be able to move them out of the scheduler layout.
553
- * When the drag area is explicitly set with specific DOM element name,
554
- * the appointments can be dragged anywhere within the specified drag area location.
605
+ * When the drag area is explicitly set with specific DOM element name, the appointments can be dragged anywhere within the specified drag area location.
606
+ *
555
607
  * {% codeBlock src='schedule/eventDragArea/index.md' %}{% endcodeBlock %}
556
608
  *
557
609
  * @default null
@@ -609,6 +661,7 @@ export interface ScheduleModel extends ComponentModel{
609
661
 
610
662
  /**
611
663
  * Triggers on beginning of every scheduler action.
664
+ *
612
665
  * {% codeBlock src='schedule/actionBegin/index.md' %}{% endcodeBlock %}
613
666
  *
614
667
  * @event 'actionBegin'
@@ -617,6 +670,7 @@ export interface ScheduleModel extends ComponentModel{
617
670
 
618
671
  /**
619
672
  * Triggers on successful completion of the scheduler actions.
673
+ *
620
674
  * {% codeBlock src='schedule/actionComplete/index.md' %}{% endcodeBlock %}
621
675
  *
622
676
  * @event 'actionComplete'
@@ -625,6 +679,7 @@ export interface ScheduleModel extends ComponentModel{
625
679
 
626
680
  /**
627
681
  * Triggers when a scheduler action gets failed or interrupted and an error information will be returned.
682
+ *
628
683
  * {% codeBlock src='schedule/actionFailure/index.md' %}{% endcodeBlock %}
629
684
  *
630
685
  * @event 'actionFailure'
@@ -633,6 +688,7 @@ export interface ScheduleModel extends ComponentModel{
633
688
 
634
689
  /**
635
690
  * Triggers before the date or view navigation takes place on scheduler.
691
+ *
636
692
  * {% codeBlock src='schedule/navigating/index.md' %}{% endcodeBlock %}
637
693
  *
638
694
  * @event 'navigating'
@@ -641,6 +697,7 @@ export interface ScheduleModel extends ComponentModel{
641
697
 
642
698
  /**
643
699
  * Triggers before each element of the schedule rendering on the page.
700
+ *
644
701
  * {% codeBlock src='schedule/renderCell/index.md' %}{% endcodeBlock %}
645
702
  *
646
703
  * @event 'renderCell'
@@ -649,6 +706,7 @@ export interface ScheduleModel extends ComponentModel{
649
706
 
650
707
  /**
651
708
  * Triggers when the events are single clicked or on single tapping the events on the mobile devices.
709
+ *
652
710
  * {% codeBlock src='schedule/eventClick/index.md' %}{% endcodeBlock %}
653
711
  *
654
712
  * @event 'eventClick'
@@ -657,6 +715,7 @@ export interface ScheduleModel extends ComponentModel{
657
715
 
658
716
  /**
659
717
  * Triggers before each of the event getting rendered on the scheduler user interface.
718
+ *
660
719
  * {% codeBlock src='schedule/eventRendered/index.md' %}{% endcodeBlock %}
661
720
  *
662
721
  * @event 'eventRendered'
@@ -665,6 +724,7 @@ export interface ScheduleModel extends ComponentModel{
665
724
 
666
725
  /**
667
726
  * Triggers before the data binds to the scheduler.
727
+ *
668
728
  * {% codeBlock src='schedule/dataBinding/index.md' %}{% endcodeBlock %}
669
729
  *
670
730
  * @event 'dataBinding'
@@ -673,6 +733,7 @@ export interface ScheduleModel extends ComponentModel{
673
733
 
674
734
  /**
675
735
  * Triggers before any of the scheduler popups opens on the page.
736
+ *
676
737
  * {% codeBlock src='schedule/popupOpen/index.md' %}{% endcodeBlock %}
677
738
  *
678
739
  * @event 'popupOpen'
@@ -681,6 +742,7 @@ export interface ScheduleModel extends ComponentModel{
681
742
 
682
743
  /**
683
744
  * Triggers before any of the scheduler popups close on the page.
745
+ *
684
746
  * {% codeBlock src='schedule/popupClose/index.md' %}{% endcodeBlock %}
685
747
  *
686
748
  * @event 'popupClose'
@@ -689,6 +751,7 @@ export interface ScheduleModel extends ComponentModel{
689
751
 
690
752
  /**
691
753
  * Triggers when an appointment is started to drag.
754
+ *
692
755
  * {% codeBlock src='schedule/dragStart/index.md' %}{% endcodeBlock %}
693
756
  *
694
757
  * @event 'dragStart'
@@ -697,6 +760,7 @@ export interface ScheduleModel extends ComponentModel{
697
760
 
698
761
  /**
699
762
  * Triggers when an appointment is being in a dragged state.
763
+ *
700
764
  * {% codeBlock src='schedule/drag/index.md' %}{% endcodeBlock %}
701
765
  *
702
766
  * @event 'drag'
@@ -705,6 +769,7 @@ export interface ScheduleModel extends ComponentModel{
705
769
 
706
770
  /**
707
771
  * Triggers when the dragging of appointment is stopped.
772
+ *
708
773
  * {% codeBlock src='schedule/dragStop/index.md' %}{% endcodeBlock %}
709
774
  *
710
775
  * @event 'dragStop'
@@ -713,6 +778,7 @@ export interface ScheduleModel extends ComponentModel{
713
778
 
714
779
  /**
715
780
  * Triggers when an appointment is started to resize.
781
+ *
716
782
  * {% codeBlock src='schedule/resizeStart/index.md' %}{% endcodeBlock %}
717
783
  *
718
784
  * @event 'resizeStart'
@@ -721,6 +787,7 @@ export interface ScheduleModel extends ComponentModel{
721
787
 
722
788
  /**
723
789
  * Triggers when an appointment is being in a resizing action.
790
+ *
724
791
  * {% codeBlock src='schedule/resizing/index.md' %}{% endcodeBlock %}
725
792
  *
726
793
  * @event 'resizing'
@@ -729,6 +796,7 @@ export interface ScheduleModel extends ComponentModel{
729
796
 
730
797
  /**
731
798
  * Triggers when the resizing of appointment is stopped.
799
+ *
732
800
  * {% codeBlock src='schedule/resizeStop/index.md' %}{% endcodeBlock %}
733
801
  *
734
802
  * @event 'resizeStop'
@@ -737,6 +805,7 @@ export interface ScheduleModel extends ComponentModel{
737
805
 
738
806
  /**
739
807
  * Triggers once the event data is bound to the scheduler.
808
+ *
740
809
  * {% codeBlock src='schedule/dataBound/index.md' %}{% endcodeBlock %}
741
810
  *
742
811
  * @event 'dataBound'