@progress/kendo-angular-scheduler 13.4.1-develop.2 → 13.4.1-develop.4

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 (48) hide show
  1. package/editing/recurrence/recurrence-editor.component.d.ts +1 -0
  2. package/editing/timezone-editor.component.d.ts +1 -0
  3. package/editing-directives/edit-service.interface.d.ts +1 -2
  4. package/esm2020/editing/recurrence/recurrence-editor.component.mjs +1 -0
  5. package/esm2020/editing/timezone-editor.component.mjs +1 -0
  6. package/esm2020/package-metadata.mjs +2 -2
  7. package/esm2020/pdf/pdf.component.mjs +1 -1
  8. package/esm2020/scheduler.component.mjs +16 -39
  9. package/esm2020/toolbar/navigation.component.mjs +0 -8
  10. package/esm2020/toolbar/view-selector.component.mjs +0 -8
  11. package/esm2020/types/crud-operation.enum.mjs +6 -4
  12. package/esm2020/types/edit-mode.enum.mjs +9 -5
  13. package/esm2020/views/agenda/agenda-view.component.mjs +3 -1
  14. package/esm2020/views/month/month-view.component.mjs +4 -3
  15. package/esm2020/views/month/multi-week-view.component.mjs +3 -3
  16. package/esm2020/views/multi-day/day-view.component.mjs +4 -3
  17. package/esm2020/views/multi-day/multi-day-view.component.mjs +5 -2
  18. package/esm2020/views/multi-day/week-view.component.mjs +4 -1
  19. package/esm2020/views/multi-day/work-week-view.component.mjs +2 -1
  20. package/esm2020/views/timeline/timeline-month-view.component.mjs +4 -3
  21. package/esm2020/views/timeline/timeline-view.component.mjs +4 -3
  22. package/esm2020/views/timeline/timeline-week-view.component.mjs +4 -1
  23. package/fesm2015/progress-kendo-angular-scheduler.mjs +73 -88
  24. package/fesm2020/progress-kendo-angular-scheduler.mjs +73 -88
  25. package/localization/messages.d.ts +1 -1
  26. package/package.json +12 -12
  27. package/pdf/pdf.component.d.ts +5 -12
  28. package/scheduler.component.d.ts +20 -149
  29. package/schematics/ngAdd/index.js +2 -2
  30. package/toolbar/navigation.component.d.ts +0 -8
  31. package/toolbar/view-selector.component.d.ts +0 -8
  32. package/types/crud-operation.enum.d.ts +6 -4
  33. package/types/datepicker-options.interface.d.ts +26 -27
  34. package/types/edit-mode.enum.d.ts +9 -5
  35. package/types/editable-settings.interface.d.ts +2 -2
  36. package/types/view-item.interface.d.ts +12 -0
  37. package/views/agenda/agenda-view.component.d.ts +3 -1
  38. package/views/day-time/day-time-view-base.d.ts +1 -0
  39. package/views/month/month-view.component.d.ts +4 -3
  40. package/views/month/multi-week-view.component.d.ts +3 -3
  41. package/views/multi-day/day-view.component.d.ts +4 -3
  42. package/views/multi-day/multi-day-view-base.d.ts +1 -1
  43. package/views/multi-day/multi-day-view.component.d.ts +5 -2
  44. package/views/multi-day/week-view.component.d.ts +4 -1
  45. package/views/multi-day/work-week-view.component.d.ts +2 -1
  46. package/views/timeline/timeline-month-view.component.d.ts +4 -3
  47. package/views/timeline/timeline-view.component.d.ts +4 -3
  48. package/views/timeline/timeline-week-view.component.d.ts +4 -1
@@ -46,22 +46,6 @@ import { SlotDragEndEvent } from './events/slot-drag-end-event';
46
46
  import * as i0 from "@angular/core";
47
47
  /**
48
48
  * Represents the [Kendo UI Scheduler component for Angular]({% slug overview_scheduler %}).
49
- *
50
- * @example
51
- * ```ts-preview
52
- * _@Component({
53
- * selector: 'my-app',
54
- * template: `
55
- * <kendo-scheduler style="height: 600px">
56
- * <kendo-scheduler-day-view>
57
- * </kendo-scheduler-day-view>
58
- * <kendo-scheduler-week-view>
59
- * </kendo-scheduler-week-view>
60
- * </kendo-scheduler>
61
- * `
62
- * })
63
- * class AppComponent {}
64
- * ```
65
49
  */
66
50
  export declare class SchedulerComponent implements AfterContentInit, OnDestroy, OnInit {
67
51
  wrapper: ElementRef;
@@ -109,43 +93,52 @@ export declare class SchedulerComponent implements AfterContentInit, OnDestroy,
109
93
  max: Date;
110
94
  /**
111
95
  * The height of the events in the **Month** and **Timeline** views, and the height of the **All day** events in the **Day** and **Week** views.
96
+ * @default 25
112
97
  */
113
98
  eventHeight: number;
114
99
  /**
115
100
  * Specifies the columns width. Applicable for the **Timeline** views.
101
+ * @default 100
116
102
  */
117
103
  columnWidth: number;
118
104
  /**
119
105
  * If set to `true`, the view will be initially shown in the business-hours mode.
120
106
  * By default, the view is displayed in the full-day mode. Applicable for the **Day**, **Week**, and **Timeline** views.
107
+ * @default false
121
108
  */
122
109
  showWorkHours: boolean;
123
110
  /**
124
111
  * The start time of the view. The Scheduler displays events which start after the start time.
125
112
  * Accepts string values in the `HH:mm` format. Applicable for the **Day**, **Week**, and **Timeline** views.
113
+ * @default '00:00'
126
114
  */
127
115
  startTime: string;
128
116
  /**
129
117
  * The end time of the view. The Scheduler displays events which end before the end time.
130
118
  * Accepts string values in the `HH:mm` format. Applicable for the **Day**, **Week**, and **Timeline** views.
119
+ * @default '00:00'
131
120
  */
132
121
  endTime: string;
133
122
  /**
134
123
  * The start time of the view when `showWorkHours` is set to `true`.
135
124
  * Accepts string values in the `HH:mm` format. Applicable for the **Day**, **Week**, and **Timeline** views.
125
+ * @default '08:00'
136
126
  */
137
127
  workDayStart: string;
138
128
  /**
139
129
  * The end time of the view when `showWorkHours` is set to `true`.
140
130
  * Accepts string values in the `HH:mm` format. Applicable for the **Day**, **Week**, and **Timeline** views.
131
+ * @default '17:00'
141
132
  */
142
133
  workDayEnd: string;
143
134
  /**
144
135
  * The start of the work week. Applicable for the **Day**, **Week**, and **Timeline** views.
136
+ * @default 1
145
137
  */
146
138
  workWeekStart: Day;
147
139
  /**
148
140
  * The end of the work week. Applicable for the **Day**, **Week**, and **Timeline** views.
141
+ * @default 5
149
142
  */
150
143
  workWeekEnd: Day;
151
144
  /**
@@ -156,21 +149,24 @@ export declare class SchedulerComponent implements AfterContentInit, OnDestroy,
156
149
  get weekStart(): Day;
157
150
  /**
158
151
  * The duration (in minutes) of the time slots. Applicable for the day, week and timeline views.
152
+ * @default 60
159
153
  */
160
154
  slotDuration: number;
161
155
  /**
162
156
  * The number of divisions of the time slots. Applicable for the **Day**, **Week**, and **Timeline** views.
157
+ * @default 2
163
158
  */
164
159
  slotDivisions: number;
165
160
  /**
166
161
  * A numeric value between 0 and 1 that specifies what percentage of the slot will be filled by the events.
167
162
  * Applicable for the **Day** and **Week** views.
168
- * Defaults to `0.9` (90% fill).
163
+ * @default 0.9
169
164
  */
170
165
  slotFill: number;
171
166
  /**
172
167
  * The time to which the view will initially be scrolled.
173
168
  * Accepts string values in the `HH:mm` format or a JavaScript `Date`. Applicable for the **Day**, **Week**, and **Timeline** views.
169
+ * @default '08:00'
174
170
  */
175
171
  scrollTime: string | Date;
176
172
  /**
@@ -183,12 +179,13 @@ export declare class SchedulerComponent implements AfterContentInit, OnDestroy,
183
179
  resources: Resource[];
184
180
  /**
185
181
  * Specifies if the Scheduler will display a loading indicator.
182
+ * @default false
186
183
  */
187
184
  loading: boolean;
188
185
  /**
189
186
  * Specifies the id of the timezone that will be displayed in the Scheduler.
190
187
  * For example, `Europe/Sofia`.
191
- * Defaults to `Etc/UTC`.
188
+ * @default 'Etc/UTC'
192
189
  */
193
190
  set timezone(value: string);
194
191
  get timezone(): string;
@@ -215,140 +212,33 @@ export declare class SchedulerComponent implements AfterContentInit, OnDestroy,
215
212
  get modelFields(): SchedulerModelFields;
216
213
  /**
217
214
  * Specifies the Scheduler current time marker settings.
215
+ * @default true
218
216
  */
219
217
  currentTimeMarker: boolean | CurrentTimeSettings;
220
218
  /**
221
219
  * Specifies the settings for the ongoing events highlight of the Scheduler.
220
+ * @default true
222
221
  */
223
222
  highlightOngoingEvents: boolean | OngoingEventsSettings;
224
223
  /**
225
224
  * Defines a function that is executed for every slot in the view.
226
225
  * The function returns a value which is supported by [`ngClass`](link:site.data.urls.angular['ngclassapi']).
227
- *
228
- * @example
229
- * ```ts
230
- * import { Component, ViewEncapsulation } from '@angular/core';
231
- * import { SlotClassArgs } from '@progress/kendo-angular-scheduler';
232
- *
233
- * _@Component({
234
- * selector: 'my-app',
235
- * encapsulation: ViewEncapsulation.None,
236
- * styles: [`
237
- * .k-scheduler .evening {
238
- * background-color: steelblue;
239
- * }
240
- * `],
241
- * template: `
242
- * <kendo-scheduler [slotClass]="getSlotClass"
243
- * style="height: 600px">
244
- * <kendo-scheduler-day-view>
245
- * </kendo-scheduler-day-view>
246
- * <kendo-scheduler-week-view>
247
- * </kendo-scheduler-week-view>
248
- * </kendo-scheduler>
249
- * `
250
- * })
251
- * export class AppComponent {
252
- * // Use an arrow function to capture the 'this' execution context of the class.
253
- * public getSlotClass = (args: SlotClassArgs) => {
254
- * const hour = args.start.getHours();
255
- *
256
- * return {
257
- * evening: !args.isAllDay && (hour < 6 || hour > 19)
258
- * };
259
- * }
260
- * }
261
- * ```
262
226
  */
263
227
  slotClass: (args: SlotClassArgs) => any;
264
228
  /**
265
229
  * Defines a function that is executed for every event in the view.
266
230
  * The function returns a value which is supported by [`ngClass`](link:site.data.urls.angular['ngclassapi']).
267
- *
268
- * @example
269
- * ```ts
270
- * import { Component, ViewEncapsulation } from '@angular/core';
271
- * import { EventStyleArgs, SchedulerEvent } from '@progress/kendo-angular-scheduler';
272
- *
273
- * _@Component({
274
- * selector: 'my-app',
275
- * encapsulation: ViewEncapsulation.None,
276
- * styles: [`
277
- * .morning.k-event {
278
- * background-color: steelblue;
279
- * }
280
- * `],
281
- * template: `
282
- * <kendo-scheduler [selectedDate]="selectedDate"
283
- * [kendoSchedulerBinding]="events"
284
- * [eventClass]="getEventClass"
285
- * style="height: 600px">
286
- * <kendo-scheduler-day-view>
287
- * </kendo-scheduler-day-view>
288
- * <kendo-scheduler-week-view>
289
- * </kendo-scheduler-week-view>
290
- * </kendo-scheduler>
291
- * `
292
- * })
293
- * export class AppComponent {
294
- * public selectedDate: Date = new Date('2018-10-22T00:00:00');
295
- * public events: SchedulerEvent[] = [{
296
- * id: 1,
297
- * title: 'Breakfast',
298
- * start: new Date('2018-10-22T09:00:00'),
299
- * end: new Date('2018-10-22T09:30:00'),
300
- * type: 'morning'
301
- * }];
302
- * // Use an arrow function to capture the 'this' execution context of the class.
303
- * public getEventClass = (args: EventStyleArgs) => {
304
- * return args.event.dataItem.type;
305
- * }
306
- * }
307
- * ```
308
231
  */
309
232
  eventClass: (args: EventStyleArgs) => any;
310
233
  /**
311
234
  * Defines a function that is executed for every event in the view.
312
235
  * The function returns a value which is supported by [`ngStyle`](link:site.data.urls.angular['ngstyleapi']).
313
- * @example
314
- * ```ts
315
- * import { Component } from '@angular/core';
316
- * import { EventStyleArgs, SchedulerEvent } from '@progress/kendo-angular-scheduler';
317
- *
318
- * _@Component({
319
- * selector: 'my-app',
320
- * template: `
321
- * <kendo-scheduler [selectedDate]="selectedDate"
322
- * [kendoSchedulerBinding]="events"
323
- * [eventStyles]="getEventStyles"
324
- * style="height: 600px">
325
- * <kendo-scheduler-day-view>
326
- * </kendo-scheduler-day-view>
327
- * <kendo-scheduler-week-view>
328
- * </kendo-scheduler-week-view>
329
- * </kendo-scheduler>
330
- * `
331
- * })
332
- * export class AppComponent {
333
- * public selectedDate: Date = new Date('2018-10-22T00:00:00');
334
- * public events: SchedulerEvent[] = [{
335
- * id: 1,
336
- * title: 'Breakfast',
337
- * start: new Date('2018-10-22T09:00:00'),
338
- * end: new Date('2018-10-22T09:30:00'),
339
- * color: 'steelblue'
340
- * }];
341
- * // Use an arrow function to capture the 'this' execution context of the class.
342
- * public getEventStyles = (args: EventStyleArgs) => {
343
- * return { backgroundColor: args.event.dataItem.color };
344
- * }
345
- * }
346
- * ```
347
236
  */
348
237
  eventStyles: (args: EventStyleArgs) => any;
349
238
  /**
350
239
  * A callback that executes for each slot of the Scheduler view.
351
240
  * If it returns `true`, the `k-selected` CSS class will be added to the cell, making it visibly selected.
241
+ * @default () => false
352
242
  */
353
243
  isSlotSelected: (args: IsSlotSelectedArgs) => boolean;
354
244
  /**
@@ -619,11 +509,6 @@ export declare class SchedulerComponent implements AfterContentInit, OnDestroy,
619
509
  * @param y - The y document position.
620
510
  *
621
511
  * @return {SchedulerSlot} - The slot.
622
- *
623
- * {% embed_file drag-and-drop/app.component.ts %}
624
- * {% embed_file drag-and-drop/draggable.directive.ts %}
625
- * {% embed_file drag-and-drop/app.module.ts %}
626
- * {% embed_file shared/main.ts %}
627
512
  */
628
513
  slotByPosition(x: number, y: number): SchedulerSlot;
629
514
  /**
@@ -641,17 +526,9 @@ export declare class SchedulerComponent implements AfterContentInit, OnDestroy,
641
526
  /**
642
527
  * Focuses the next event or an event at a specified relative position.
643
528
  * The `options` parameter can be used to set a positive or negative offset
644
- * that is relative to the currently focused event.
529
+ * that is relative to the currently focused event ([see example](slug:keyboard_navigation_scheduler#toc-event-navigation-with-the-tab-key)).
645
530
  * A `nowrap` flag toggles the wrapping to the first or to the last item.
646
531
  *
647
- * @example
648
- * ```ts-no-run
649
- * scheduler.focusNext(); // Focuses the next event.
650
- * scheduler.focusNext({ offset: 1 }); // Focuses the next event.
651
- * scheduler.focusNext({ offset: -1 }); // Focuses the previous event.
652
- * scheduler.focusNext({ nowrap: true }); // If the focus is on the last event, does not move the focus to the first event.
653
- * ```
654
- *
655
532
  * @param position The relative position of the event to focus.
656
533
  * @returns `true` if the focused event changed. Otherwise, returns `false`.
657
534
  */
@@ -659,15 +536,9 @@ export declare class SchedulerComponent implements AfterContentInit, OnDestroy,
659
536
  /**
660
537
  * Focuses the previous event or an event at a specified relative position.
661
538
  * The `options` parameter can be used to set a positive or negative offset
662
- * that is relative to the currently focused event.
539
+ * that is relative to the currently focused event ([see example](slug:keyboard_navigation_scheduler#toc-event-navigation-with-the-tab-key)).
663
540
  * A `nowrap` flag toggles the wrapping to the first or to the last item.
664
541
  *
665
- * @example
666
- * ```ts-no-run
667
- * scheduler.focusPrev(); // Focuses the previous event
668
- * scheduler.focusPrev({ nowrap: true }); // Does not move the focus to the last event, if focus is on the first one.
669
- * ```
670
- *
671
542
  * @param position The relative position of the event to focus.
672
543
  * @returns `true` if the focused event changed. Otherwise, returns `false`.
673
544
  */
@@ -4,9 +4,9 @@ const schematics_1 = require("@angular-devkit/schematics");
4
4
  function default_1(options) {
5
5
  const finalOptions = Object.assign(Object.assign({}, options), { mainNgModule: 'SchedulerModule', package: 'scheduler', peerDependencies: {
6
6
  // peer dep of the dropdowns
7
- '@progress/kendo-angular-treeview': '13.4.1-develop.2',
7
+ '@progress/kendo-angular-treeview': '13.4.1-develop.4',
8
8
  // peer dependency of kendo-angular-inputs
9
- '@progress/kendo-angular-dialog': '13.4.1-develop.2',
9
+ '@progress/kendo-angular-dialog': '13.4.1-develop.4',
10
10
  // peer dependency of kendo-angular-icons
11
11
  '@progress/kendo-svg-icons': '^1.0.0'
12
12
  } });
@@ -26,14 +26,6 @@ interface DateRangeText {
26
26
  * To render the **Previous**, **Today**, **Next**, and **Date picker**
27
27
  * buttons, include the component in the
28
28
  * [toolbar template]({% slug api_scheduler_toolbartemplatedirective %}).
29
- *
30
- * {% meta height:700 %}
31
- * {% embed_file toolbar/template/app.component.ts preview %}
32
- * {% embed_file toolbar/template/my-navigation.component.ts %}
33
- * {% embed_file toolbar/template/app.module.ts %}
34
- * {% embed_file shared/events-utc.ts %}
35
- * {% embed_file shared/main.ts %}
36
- * {% endmeta %}
37
29
  */
38
30
  export declare class ToolbarNavigationComponent implements OnDestroy {
39
31
  private popupService;
@@ -14,14 +14,6 @@ import * as i0 from "@angular/core";
14
14
  *
15
15
  * To render the view-selection buttons, include the component in the
16
16
  * [toolbar template]({% slug api_scheduler_toolbartemplatedirective %}).
17
- *
18
- * {% meta height:700 %}
19
- * {% embed_file toolbar/template/app.component.ts preview %}
20
- * {% embed_file toolbar/template/my-navigation.component.ts %}
21
- * {% embed_file toolbar/template/app.module.ts %}
22
- * {% embed_file shared/events-utc.ts %}
23
- * {% embed_file shared/main.ts %}
24
- * {% endmeta %}
25
17
  */
26
18
  export declare class ToolbarViewSelectorComponent implements OnDestroy {
27
19
  private service;
@@ -4,12 +4,14 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
6
  * The selected CRUD operation when the user edits or removes recurring events.
7
- *
8
- * The supported values are:
9
- * * `Edit`
10
- * * `Remove`
11
7
  */
12
8
  export declare enum CrudOperation {
9
+ /**
10
+ * The user edits the selected recurring event.
11
+ */
13
12
  Edit = 0,
13
+ /**
14
+ * The user removes the selected recurring event.
15
+ */
14
16
  Remove = 1
15
17
  }
@@ -9,71 +9,70 @@ import { Day } from '@progress/kendo-date-math';
9
9
  */
10
10
  export interface DatePickerOptions {
11
11
  /**
12
- * Defines the active view that the Calendar initially renders
13
- * ([see example]({% slug calendar_type_datepicker %}#toc-active-view)).
12
+ * Defines the active view that the Calendar initially renders.
13
+ * ([See example]({% slug calendar_type_datepicker %}#toc-active-view)).
14
14
  * By default, the active view is `month`.
15
15
  *
16
- * > You have to set `activeView` within the `topView`-`bottomView` range.
16
+ * Always configure the `activeView` within the range defined by `topView` and `bottomView`.
17
17
  */
18
18
  activeView?: CalendarView;
19
19
  /**
20
- * Defines the bottommost Calendar view to which the user can navigate
21
- * ([see example]({% slug calendar_type_datepicker %}#toc-focused-dates)).
20
+ * Defines the bottommost Calendar view to which the user can navigate.
21
+ * ([See example]({% slug calendar_type_datepicker %}#toc-focused-dates)).
22
22
  */
23
23
  bottomView?: CalendarView;
24
24
  /**
25
25
  * Determines whether the built-in validator for disabled
26
- * date ranges is enforced when validating a form
26
+ * date ranges is enforced when validating a form.
27
27
  * ([see example]({% slug disabled_dates_datepicker %}#toc-validation)).
28
28
  */
29
29
  disabledDatesValidation?: boolean;
30
30
  /**
31
- * Specifies the focused date of the Calendar component
31
+ * Specifies the focused date of the Calendar component.
32
32
  * ([see example]({% slug calendar_type_datepicker %}#toc-focused-dates)).
33
33
  */
34
34
  focusedDate?: Date;
35
35
  /**
36
- * Specifies the date format that is used to display the input value
36
+ * Specifies the date format that is used to display the input value.
37
37
  * ([see example]({% slug formats_datepicker %})).
38
38
  */
39
39
  format?: string;
40
40
  /**
41
41
  * Defines the descriptions of the format sections in the input field.
42
- * ([more information and examples]({% slug placeholders_datepicker %})).
42
+ * ([More information and examples]({% slug placeholders_datepicker %})).
43
43
  */
44
44
  formatPlaceHolder?: DateInputFormatPlaceholder;
45
45
  /**
46
- * Specifies the biggest valid date
47
- * ([see example]({% slug dateranges_datepicker %})).
46
+ * Specifies the biggest valid date.
47
+ * ([See example]({% slug dateranges_datepicker %})).
48
48
  */
49
49
  max?: Date;
50
50
  /**
51
- * Specifies the smallest valid date
52
- * ([see example]({% slug dateranges_datepicker %})).
51
+ * Specifies the smallest valid date.
52
+ * ([See example]({% slug dateranges_datepicker %})).
53
53
  */
54
54
  min?: Date;
55
55
  /**
56
56
  * Sets or gets the `navigation` property of the Calendar
57
57
  * and determines whether the navigation side-bar is displayed.
58
- * ([see example]({% slug sidebar_datepicker %})).
58
+ * ([See example]({% slug sidebar_datepicker %})).
59
59
  */
60
60
  navigation?: boolean;
61
61
  /**
62
62
  * Specifies the hint the DatePicker displays when its value is `null`.
63
- * ([more information and examples]({% slug placeholders_datepicker %})).
63
+ * ([More information and examples]({% slug placeholders_datepicker %})).
64
64
  */
65
65
  placeholder?: string;
66
66
  /**
67
- * Sets the read-only state of the DatePicker input field
68
- * ([see example]({% slug readonly_datepicker %}#toc-read-only-input)).
67
+ * Sets the read-only state of the DatePicker input field.
68
+ * ([See example]({% slug readonly_datepicker %}#toc-read-only-input)).
69
69
  *
70
- * > Note that if you set the [`readonly`]({% slug api_dateinputs_datepickercomponent %}#toc-readonly) property value to `true`,
71
- * the input will be rendered in a read-only state regardless of the `readOnlyInput` value.
70
+ * If [`readonly`]({% slug api_dateinputs_datepickercomponent %}#toc-readonly) property is set to `true`, the input will appear in a read-only state, without regard to the `readOnlyInput` value.
72
71
  */
73
72
  readOnlyInput?: boolean;
74
73
  /**
75
- * Sets the read-only state of the DatePicker
76
- * ([see example]({% slug readonly_datepicker %}#toc-read-only-datepicker)).
74
+ * Sets the read-only state of the DatePicker.
75
+ * ([See example]({% slug readonly_datepicker %}#toc-read-only-datepicker)).
77
76
  */
78
77
  readonly?: boolean;
79
78
  /**
@@ -81,18 +80,18 @@ export interface DatePickerOptions {
81
80
  */
82
81
  title?: string;
83
82
  /**
84
- * Defines the topmost Calendar view to which the user can navigate
85
- * ([see example]({% slug calendar_type_datepicker %}#toc-focused-dates)).
83
+ * Defines the topmost Calendar view to which the user can navigate.
84
+ * ([See example]({% slug calendar_type_datepicker %}#toc-view-selection-depth)).
86
85
  */
87
86
  topView?: CalendarView;
88
87
  /**
89
- * Determines whether to display a week number column in the `month` view of the Calendar
90
- * ([see example]({% slug calendar_type_datepicker %}#toc-week-number-column)).
88
+ * Determines whether to display a week number column in the `month` view of the Calendar.
89
+ * ([See example]({% slug calendar_type_datepicker %}#toc-week-number-column)).
91
90
  */
92
91
  weekNumber?: boolean;
93
92
  /**
94
- * Sets the dates of the DatePicker that will be disabled
95
- * ([see example]({% slug disabled_dates_datepicker %})).
93
+ * Sets the dates of the DatePicker that will be disabled.
94
+ * ([See example]({% slug disabled_dates_datepicker %})).
96
95
  */
97
96
  disabledDates?: ((date: Date) => boolean) | Date[] | Day[];
98
97
  /**
@@ -5,14 +5,18 @@
5
5
  /**
6
6
  * The selected edit mode during the update or removal of events.
7
7
  * For non-recurring events, set to `Event`.
8
- *
9
- * The supported values are:
10
- * * `Event`&mdash;Edits the selected event.
11
- * * `Occurrence`&mdash;Edits the selected occurrence.
12
- * * `Series`&mdash;Edits all events in the series.
13
8
  */
14
9
  export declare enum EditMode {
10
+ /**
11
+ * Edits the selected event.
12
+ */
15
13
  Event = 0,
14
+ /**
15
+ * Edits the selected occurrence.
16
+ */
16
17
  Occurrence = 1,
18
+ /**
19
+ * Edits all events in the series.
20
+ */
17
21
  Series = 2
18
22
  }
@@ -19,11 +19,11 @@ export interface EditableSettings {
19
19
  */
20
20
  resize: boolean;
21
21
  /**
22
- * Specifies if new events can be added on `slotDblClick` when using the editing directives.
22
+ * Specifies if new events can be added on [`slotDblClick`](slug:api_scheduler_schedulercomponent#toc-slotdblclick) when using the editing directives.
23
23
  */
24
24
  add: boolean;
25
25
  /**
26
- * Specifies if the events can be edited on `eventDblClick` when using the editing directives.
26
+ * Specifies if the events can be edited on [`eventDblClick`](slug:api_scheduler_schedulercomponent#toc-eventdblclick) when using the editing directives.
27
27
  */
28
28
  edit: boolean;
29
29
  }
@@ -4,8 +4,20 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  import { ZonedDate } from "@progress/kendo-date-math";
6
6
  import { SchedulerEvent } from "../types";
7
+ /**
8
+ * Represents the view item model of the Scheduler event.
9
+ */
7
10
  export interface ViewItem {
11
+ /**
12
+ * Represents the start date of the event in a specified timezone.
13
+ */
8
14
  start: ZonedDate;
15
+ /**
16
+ * Represents the end date of the event in a specified timezone.
17
+ */
9
18
  end: ZonedDate;
19
+ /**
20
+ * Represents the Scheduler event data.
21
+ */
10
22
  event: SchedulerEvent;
11
23
  }
@@ -31,11 +31,12 @@ export declare class AgendaViewComponent extends ConfigurationViewBase {
31
31
  * Defaults to `{0:d} - {1:d}`,
32
32
  * where `0` is the start and `1` is the end date
33
33
  * ([more information]({% slug parsingandformatting_intl %}#toc-date-formatting)).
34
+ * @default '{0:d} - {1:d}'
34
35
  */
35
36
  selectedShortDateFormat: string;
36
37
  /**
37
38
  * Specifies the number of days that the view will render.
38
- * Defaults to `7`.
39
+ * @default 7
39
40
  */
40
41
  numberOfDays: number;
41
42
  /**
@@ -52,6 +53,7 @@ export declare class AgendaViewComponent extends ConfigurationViewBase {
52
53
  agendaDateTemplate: AgendaDateTemplateDirective;
53
54
  /**
54
55
  * The invariant name for this view (`agenda`).
56
+ * @default 'agenda'
55
57
  */
56
58
  readonly name: string;
57
59
  constructor(localization: LocalizationService, changeDetector: ChangeDetectorRef, viewContext: ViewContextService, viewState: ViewStateService);
@@ -26,6 +26,7 @@ export declare abstract class DayTimeViewBase extends ConfigurationViewBase impl
26
26
  /**
27
27
  * If set to `true`, the view will be initially shown in the business-hours mode.
28
28
  * By default, the view is displayed in the full-day mode.
29
+ * @default false
29
30
  */
30
31
  showWorkHours: boolean;
31
32
  /**
@@ -28,20 +28,21 @@ export declare class MonthViewComponent extends ConfigurationViewBase implements
28
28
  /**
29
29
  * The long-date format for displaying the
30
30
  * selected date in the Scheduler toolbar.
31
- * Defaults to `{0:Y}`
32
31
  * ([more information]({% slug parsingandformatting_intl %}#toc-date-formatting)).
32
+ * @default '{0:Y}'
33
33
  */
34
34
  selectedDateFormat: string;
35
35
  /**
36
36
  * The short-date format for displaying the
37
37
  * selected date in the Scheduler toolbar.
38
- * Defaults to `{0:y}`
39
38
  * ([more information]({% slug parsingandformatting_intl %}#toc-date-formatting.
39
+ * @default '{0:y}'
40
40
  */
41
41
  selectedShortDateFormat: string;
42
42
  monthDaySlotTemplate: MonthDaySlotTemplateDirective;
43
43
  /**
44
- * The invariant name for this view (`month`).
44
+ * The invariant name for this view.
45
+ * @default 'month'
45
46
  */
46
47
  readonly name: string;
47
48
  get viewEventHeight(): number;
@@ -27,21 +27,21 @@ export declare class MultiWeekViewComponent extends ConfigurationViewBase implem
27
27
  eventHeight: number;
28
28
  /**
29
29
  * The number of weeks to be rendered.
30
- * Defaults to `6`.
30
+ * @default 6
31
31
  */
32
32
  numberOfWeeks: number;
33
33
  /**
34
34
  * The long-date format for displaying the
35
35
  * selected date in the Scheduler toolbar.
36
- * Defaults to `{0:D} - {1:D}`
37
36
  * ([more information]({% slug parsingandformatting_intl %}#toc-date-formatting)).
37
+ * @default '{0:D} - {1:D}'
38
38
  */
39
39
  selectedDateFormat: string;
40
40
  /**
41
41
  * The short-date format for displaying the
42
42
  * selected date in the Scheduler toolbar.
43
- * Defaults to `{0:d} - {1:d}`
44
43
  * ([more information]({% slug parsingandformatting_intl %}#toc-date-formatting.
44
+ * @default '{0:d} - {1:d}'
45
45
  */
46
46
  selectedShortDateFormat: string;
47
47
  multiWeekDaySlotTemplate: MultiWeekDaySlotTemplateDirective;
@@ -20,16 +20,16 @@ export declare class DayViewComponent extends MultiDayViewBase {
20
20
  /**
21
21
  * The long-date format for displaying the
22
22
  * selected date in the Scheduler toolbar.
23
- * Defaults to `{0:D}`
24
23
  * ([more information]({% slug parsingandformatting_intl %}#toc-date-formatting)).
24
+ * @default '{0:D}'
25
25
  */
26
26
  set selectedDateFormat(value: string);
27
27
  get selectedDateFormat(): string;
28
28
  /**
29
29
  * The short-date format for displaying the
30
30
  * selected date in the Scheduler toolbar.
31
- * Defaults to `{0:D}`
32
31
  * ([more information]({% slug parsingandformatting_intl %}#toc-date-formatting)).
32
+ * @default '{0:d}'
33
33
  */
34
34
  set selectedShortDateFormat(value: string);
35
35
  get selectedShortDateFormat(): string;
@@ -50,7 +50,8 @@ export declare class DayViewComponent extends MultiDayViewBase {
50
50
  */
51
51
  majorTimeHeaderTemplate: MajorTimeHeaderTemplateDirective;
52
52
  /**
53
- * The invariant name for this view (`day`).
53
+ * The invariant name for this view.
54
+ * @default 'day'
54
55
  */
55
56
  readonly name: string;
56
57
  private _selectedDateFormat;
@@ -15,7 +15,7 @@ export declare abstract class MultiDayViewBase extends DayTimeViewBase {
15
15
  /**
16
16
  * Numeric value between 0 and 1 that specifies what percentage of the slot should be filled by the events.
17
17
  *
18
- * Defaults to 0.9 (90% fill).
18
+ * @default 0.9
19
19
  */
20
20
  slotFill: number;
21
21
  /**