@progress/kendo-angular-scheduler 19.1.2-develop.4 → 19.1.2-develop.5

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 (161) hide show
  1. package/data-binding.directive.d.ts +12 -3
  2. package/directives.d.ts +42 -2
  3. package/editing/edit-dialog-template.directive.d.ts +15 -2
  4. package/editing/recurrence/recurrence-editor.component.d.ts +29 -10
  5. package/editing/timezone-editor.component.d.ts +13 -3
  6. package/editing-directives/base-edit.service.d.ts +8 -11
  7. package/editing-directives/edit-service.interface.d.ts +22 -24
  8. package/editing-directives/reactive-editing.directive.d.ts +15 -2
  9. package/esm2022/data-binding.directive.mjs +12 -3
  10. package/esm2022/directives.mjs +42 -2
  11. package/esm2022/editing/edit-dialog-template.directive.mjs +15 -2
  12. package/esm2022/editing/recurrence/recurrence-editor.component.mjs +29 -10
  13. package/esm2022/editing/timezone-editor.component.mjs +13 -3
  14. package/esm2022/editing-directives/base-edit.service.mjs +8 -11
  15. package/esm2022/editing-directives/reactive-editing.directive.mjs +15 -2
  16. package/esm2022/events/add-event.mjs +3 -3
  17. package/esm2022/events/cancel-event.mjs +2 -2
  18. package/esm2022/events/create-event.mjs +6 -6
  19. package/esm2022/events/date-change-event.mjs +4 -4
  20. package/esm2022/events/drag-end-event.mjs +8 -8
  21. package/esm2022/events/drag-event.mjs +8 -8
  22. package/esm2022/events/drag-start-event.mjs +4 -4
  23. package/esm2022/events/edit-event.mjs +4 -4
  24. package/esm2022/events/event-click-event.mjs +5 -5
  25. package/esm2022/events/event-keydown-event.mjs +4 -4
  26. package/esm2022/events/navigate-event.mjs +3 -3
  27. package/esm2022/events/remove-event.mjs +4 -4
  28. package/esm2022/events/resize-end-event.mjs +6 -6
  29. package/esm2022/events/resize-event.mjs +8 -8
  30. package/esm2022/events/resize-start-event.mjs +4 -4
  31. package/esm2022/events/save-event.mjs +3 -3
  32. package/esm2022/events/slot-click-event.mjs +7 -7
  33. package/esm2022/events/slot-drag-end-event.mjs +1 -1
  34. package/esm2022/events/slot-drag-event.mjs +7 -7
  35. package/esm2022/events/slot-drag-start-event.mjs +8 -7
  36. package/esm2022/localization/custom-messages.component.mjs +14 -1
  37. package/esm2022/localization/messages.mjs +98 -98
  38. package/esm2022/package-metadata.mjs +2 -2
  39. package/esm2022/pdf/pdf-command.directive.mjs +11 -11
  40. package/esm2022/pdf/pdf-export-event.mjs +1 -1
  41. package/esm2022/pdf/pdf.component.mjs +19 -8
  42. package/esm2022/pdf/pdf.module.mjs +7 -8
  43. package/esm2022/scheduler.component.mjs +62 -62
  44. package/esm2022/scheduler.module.mjs +6 -7
  45. package/esm2022/toolbar/navigation.component.mjs +16 -7
  46. package/esm2022/toolbar/toolbar-template.directive.mjs +18 -10
  47. package/esm2022/toolbar/toolbar.service.mjs +3 -4
  48. package/esm2022/toolbar/view-selector.component.mjs +14 -8
  49. package/esm2022/types/crud-operation.enum.mjs +3 -3
  50. package/esm2022/types/edit-mode.enum.mjs +2 -2
  51. package/esm2022/types/scheduler-view.mjs +1 -1
  52. package/esm2022/views/agenda/agenda-view.component.mjs +15 -11
  53. package/esm2022/views/common/slot-selectable.directive.mjs +16 -4
  54. package/esm2022/views/month/month-view.component.mjs +17 -16
  55. package/esm2022/views/month/multi-week-view.component.mjs +20 -18
  56. package/esm2022/views/multi-day/day-view.component.mjs +12 -7
  57. package/esm2022/views/multi-day/multi-day-view.component.mjs +16 -11
  58. package/esm2022/views/multi-day/week-view.component.mjs +14 -11
  59. package/esm2022/views/multi-day/work-week-view.component.mjs +8 -1
  60. package/esm2022/views/scheduler-view.directive.mjs +13 -3
  61. package/esm2022/views/templates/agenda-date-template.directive.mjs +13 -3
  62. package/esm2022/views/templates/agenda-time-template.directive.mjs +13 -3
  63. package/esm2022/views/templates/all-day-event-template.directive.mjs +13 -3
  64. package/esm2022/views/templates/all-day-slot-template.directive.mjs +13 -3
  65. package/esm2022/views/templates/date-header-template.directive.mjs +14 -4
  66. package/esm2022/views/templates/event-template.directive.mjs +13 -3
  67. package/esm2022/views/templates/group-header-template.directive.mjs +14 -4
  68. package/esm2022/views/templates/major-time-header-template.directive.mjs +13 -3
  69. package/esm2022/views/templates/minor-time-header-template.directive.mjs +13 -3
  70. package/esm2022/views/templates/month-day-slot-template.directive.mjs +13 -3
  71. package/esm2022/views/templates/multi-week-day-slot-template.directive.mjs +12 -3
  72. package/esm2022/views/templates/time-slot-template.directive.mjs +14 -4
  73. package/esm2022/views/timeline/timeline-month-view.component.mjs +16 -11
  74. package/esm2022/views/timeline/timeline-view.component.mjs +16 -11
  75. package/esm2022/views/timeline/timeline-week-view.component.mjs +18 -14
  76. package/esm2022/views/view-context.service.mjs +6 -6
  77. package/esm2022/views/view-state.service.mjs +9 -9
  78. package/esm2022/views/year/year-view.component.mjs +12 -7
  79. package/events/add-event.d.ts +3 -3
  80. package/events/cancel-event.d.ts +2 -2
  81. package/events/create-event.d.ts +6 -6
  82. package/events/date-change-event.d.ts +4 -4
  83. package/events/drag-end-event.d.ts +8 -8
  84. package/events/drag-event.d.ts +8 -8
  85. package/events/drag-start-event.d.ts +4 -4
  86. package/events/edit-event.d.ts +4 -4
  87. package/events/event-click-event.d.ts +5 -5
  88. package/events/event-keydown-event.d.ts +4 -4
  89. package/events/navigate-event.d.ts +3 -3
  90. package/events/remove-event.d.ts +4 -4
  91. package/events/resize-end-event.d.ts +6 -6
  92. package/events/resize-event.d.ts +8 -8
  93. package/events/resize-start-event.d.ts +4 -4
  94. package/events/save-event.d.ts +3 -3
  95. package/events/slot-click-event.d.ts +7 -7
  96. package/events/slot-drag-end-event.d.ts +1 -1
  97. package/events/slot-drag-event.d.ts +7 -7
  98. package/events/slot-drag-start-event.d.ts +8 -7
  99. package/fesm2022/progress-kendo-angular-scheduler.mjs +876 -543
  100. package/localization/custom-messages.component.d.ts +14 -1
  101. package/localization/messages.d.ts +98 -98
  102. package/navigation/focus-position.interface.d.ts +2 -3
  103. package/package.json +15 -15
  104. package/pdf/pdf-command.directive.d.ts +11 -11
  105. package/pdf/pdf-export-event.d.ts +1 -1
  106. package/pdf/pdf.component.d.ts +19 -8
  107. package/pdf/pdf.module.d.ts +7 -8
  108. package/scheduler.component.d.ts +62 -62
  109. package/scheduler.module.d.ts +6 -7
  110. package/schematics/ngAdd/index.js +3 -3
  111. package/toolbar/navigation.component.d.ts +16 -7
  112. package/toolbar/toolbar-template.directive.d.ts +18 -10
  113. package/toolbar/toolbar.service.d.ts +3 -4
  114. package/toolbar/view-selector.component.d.ts +14 -8
  115. package/types/actions.d.ts +51 -45
  116. package/types/create-form-group-args.interface.d.ts +1 -1
  117. package/types/crud-operation.enum.d.ts +3 -3
  118. package/types/current-time-settings.interface.d.ts +10 -8
  119. package/types/date-range.interface.d.ts +7 -11
  120. package/types/datepicker-options.interface.d.ts +33 -38
  121. package/types/edit-event-args.interface.d.ts +3 -4
  122. package/types/edit-mode.enum.d.ts +2 -2
  123. package/types/editable-settings.interface.d.ts +6 -6
  124. package/types/event-style-args.interface.d.ts +4 -4
  125. package/types/group.interface.d.ts +2 -2
  126. package/types/numeric-options.interface.d.ts +20 -16
  127. package/types/ongoing-events-settings.interface.d.ts +8 -6
  128. package/types/resource.interface.d.ts +8 -8
  129. package/types/scheduler-event.d.ts +13 -15
  130. package/types/scheduler-model-fields.interface.d.ts +34 -23
  131. package/types/scheduler-slot.interface.d.ts +7 -7
  132. package/types/scheduler-view.d.ts +3 -5
  133. package/types/slot-class-args.interface.d.ts +6 -6
  134. package/types/view-item.interface.d.ts +1 -1
  135. package/views/agenda/agenda-view.component.d.ts +15 -11
  136. package/views/common/slot-selectable.directive.d.ts +16 -4
  137. package/views/month/month-view.component.d.ts +17 -16
  138. package/views/month/multi-week-view.component.d.ts +20 -18
  139. package/views/multi-day/day-view.component.d.ts +12 -7
  140. package/views/multi-day/multi-day-view.component.d.ts +16 -11
  141. package/views/multi-day/week-view.component.d.ts +14 -11
  142. package/views/multi-day/work-week-view.component.d.ts +8 -1
  143. package/views/scheduler-view.directive.d.ts +13 -3
  144. package/views/templates/agenda-date-template.directive.d.ts +13 -3
  145. package/views/templates/agenda-time-template.directive.d.ts +13 -3
  146. package/views/templates/all-day-event-template.directive.d.ts +13 -3
  147. package/views/templates/all-day-slot-template.directive.d.ts +13 -3
  148. package/views/templates/date-header-template.directive.d.ts +14 -4
  149. package/views/templates/event-template.directive.d.ts +13 -3
  150. package/views/templates/group-header-template.directive.d.ts +14 -4
  151. package/views/templates/major-time-header-template.directive.d.ts +13 -3
  152. package/views/templates/minor-time-header-template.directive.d.ts +13 -3
  153. package/views/templates/month-day-slot-template.directive.d.ts +13 -3
  154. package/views/templates/multi-week-day-slot-template.directive.d.ts +12 -3
  155. package/views/templates/time-slot-template.directive.d.ts +14 -4
  156. package/views/timeline/timeline-month-view.component.d.ts +16 -11
  157. package/views/timeline/timeline-view.component.d.ts +16 -11
  158. package/views/timeline/timeline-week-view.component.d.ts +18 -14
  159. package/views/view-context.service.d.ts +6 -6
  160. package/views/view-state.service.d.ts +9 -9
  161. package/views/year/year-view.component.d.ts +12 -7
@@ -5,13 +5,23 @@
5
5
  import { Directive, TemplateRef, Optional } from '@angular/core';
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
- * Represents the template for rendering the day slots in the **Month** view.
9
- * To define the day template, nest an `<ng-template>` tag with the `kendoSchedulerMonthDaySlotTemplate`
10
- * directive inside the `<kendo-scheduler>`, or in the `<kendo-scheduler-month-view>` component ([see example](slug:templates_scheduler#toc-month-slots)).
8
+ * Use this directive to customize the day slots in the **Month** view of the Scheduler.
9
+ *
10
+ * To define a day slot template, nest an `<ng-template>` tag with the `kendoSchedulerMonthDaySlotTemplate` directive inside the
11
+ * `<kendo-scheduler>` or `<kendo-scheduler-month-view>` component ([see example](slug:templates_scheduler#toc-month-slots)).
11
12
  *
12
13
  * The available fields in the template context are:
13
14
  * - `date`&mdash;The date of the slot.
14
15
  * - `resources`&mdash;The resources of the slot.
16
+ *
17
+ * @example
18
+ * ```html
19
+ * <kendo-scheduler-month-view>
20
+ * <ng-template kendoSchedulerMonthDaySlotTemplate let-date="date" let-resources="resources">
21
+ * <!-- custom month day slot -->
22
+ * </ng-template>
23
+ * </kendo-scheduler-month-view>
24
+ * ```
15
25
  */
16
26
  export class MonthDaySlotTemplateDirective {
17
27
  templateRef;
@@ -5,14 +5,23 @@
5
5
  import { Directive, TemplateRef, Optional } from '@angular/core';
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
- * Represents the template for rendering the day slots in the **Month** view.
9
- * To define the day template, nest an `<ng-template>` tag with the `kendoSchedulerMultiWeekDaySlotTemplate`
10
- * directive inside the `<kendo-scheduler>`, or in the `<kendo-scheduler-month-view>` component ([see example](slug:templates_scheduler#toc-multi-week-slots)).
8
+ * Use this directive to customize the day slots in the **Multi-Week** view of the Scheduler.
9
+ *
10
+ * To defina a day slot template, nest an `<ng-template>` tag with the `kendoSchedulerMultiWeekDaySlotTemplate` directive inside the
11
+ * `<kendo-scheduler>` or `<kendo-scheduler-multi-week-view>` component ([see example](slug:templates_scheduler#toc-multi-week-slots)).
11
12
  *
12
13
  * The available fields in the template context are:
13
14
  * - `date`&mdash;The date of the slot.
14
15
  * - `resources`&mdash;The resources of the slot.
15
16
  *
17
+ * @example
18
+ * ```html
19
+ * <kendo-scheduler-multi-week-view>
20
+ * <ng-template kendoSchedulerMultiWeekDaySlotTemplate let-date="date" let-resources="resources">
21
+ * <!-- custom multi-week day slot -->
22
+ * </ng-template>
23
+ * <kendo-scheduler-multi-week-view>
24
+ * ```
16
25
  */
17
26
  export class MultiWeekDaySlotTemplateDirective {
18
27
  templateRef;
@@ -5,14 +5,24 @@
5
5
  import { Directive, TemplateRef, Optional } from '@angular/core';
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
- * Represents the template for the time-slot renderer in the **Day**, **Week**, and **Timeline** views.
9
- * To define the time-slot template, nest an `<ng-template>` tag with the `kendoSchedulerTimeSlotTemplate`
10
- * directive inside the `<kendo-scheduler>`, or in the `<kendo-scheduler-day-view>`, `<kendo-scheduler-week-view>`,
11
- * `<kendo-scheduler-timeline-view>`, `<kendo-scheduler-timeline-week-view>`, and `<kendo-scheduler-timeline-month-view>` components ([see example](slug:templates_scheduler#toc-time-slots)).
8
+ * Represents the template for the time-slot renderer in the ***Day**, ***Week**, and ***Timeline** views.
9
+ *
10
+ * To define a time-slot template, nest an `<ng-template>` tag with the `kendoSchedulerTimeSlotTemplate`
11
+ * directive inside the `<kendo-scheduler>`, `<kendo-scheduler-day-view>`, `<kendo-scheduler-week-view>`,
12
+ * `<kendo-scheduler-timeline-view>`, `<kendo-scheduler-timeline-week-view>`, or `<kendo-scheduler-timeline-month-view>` component ([see example](slug:templates_scheduler#toc-time-slots)).
12
13
  *
13
14
  * The available fields in the template context are:
14
15
  * - `date`&mdash;The date of the slot.
15
16
  * - `resources`&mdash;The resources of the slot.
17
+ *
18
+ * @example
19
+ * ```html
20
+ * <kendo-scheduler-week-view>
21
+ * <ng-template kendoSchedulerTimeSlotTemplate let-date="date" let-resources="resources">
22
+ * <!-- custom time slot -->
23
+ * </ng-template>
24
+ * </kendo-scheduler-week-view>
25
+ * ```
16
26
  */
17
27
  export class TimeSlotTemplateDirective {
18
28
  templateRef;
@@ -18,7 +18,14 @@ import * as i1 from "@progress/kendo-angular-l10n";
18
18
  import * as i2 from "../view-context.service";
19
19
  import * as i3 from "../view-state.service";
20
20
  /**
21
- * The component for rendering the **Month** timeline view.
21
+ * Represents the component that renders the **Timeline Month** view in the Scheduler.
22
+ *
23
+ * @example
24
+ * ```html
25
+ * <kendo-scheduler>
26
+ * <kendo-scheduler-timeline-month-view></kendo-scheduler-timeline-month-view>
27
+ * </kendo-scheduler>
28
+ * ```
22
29
  */
23
30
  export class TimelineMonthViewComponent extends TimelineBase {
24
31
  /**
@@ -28,10 +35,9 @@ export class TimelineMonthViewComponent extends TimelineBase {
28
35
  return this.localization.get('timelineMonthViewTitle');
29
36
  }
30
37
  /**
31
- * The long-date format for displaying the
32
- * selected date in the Scheduler toolbar.
33
- * ([more information]({% slug parsingandformatting_intl %}#toc-date-formatting)).
34
- * > Note: If [numberOfMonths](#toc-numberofmonths) > 1, the default format value shows a range - `'{0:Y} - {1:Y}'`, where `0` is the start and `1` is the end date.
38
+ * Sets the long-date format for the selected date in the Scheduler toolbar.
39
+ * For more information, see [Parsing and Formatting Dates and Numbers](slug:parsingandformatting_intl#date-formatting).
40
+ * If `numberOfMonths` is greater than 1, the default format displays a range: `'{0:Y} - {1:Y}'`, where `0` is the start and `1` is the end date.
35
41
  * @default '{0:Y}'
36
42
  */
37
43
  set selectedDateFormat(format) {
@@ -45,10 +51,9 @@ export class TimelineMonthViewComponent extends TimelineBase {
45
51
  }
46
52
  _selectedDateFormat;
47
53
  /**
48
- * The short-date format for displaying the
49
- * selected date in the Scheduler toolbar.
50
- * ([more information]({% slug parsingandformatting_intl %}#toc-date-formatting)).
51
- * > Note: If [numberOfMonths](#toc-numberofmonths) > 1, the default format value shows a range - `'{0:y} - {1:y}'`, where `0` is the start and `1` is the end date.
54
+ * Sets the short-date format for the selected date in the Scheduler toolbar.
55
+ * For more information, see [Parsing and Formatting Dates and Numbers](slug:parsingandformatting_intl#date-formatting).
56
+ * If `numberOfMonths` is greater than 1, the default format displays a range: `'{0:y} - {1:y}'`, where `0` is the start and `1` is the end date.
52
57
  * @default '{0:y}'
53
58
  */
54
59
  set selectedShortDateFormat(format) {
@@ -62,8 +67,8 @@ export class TimelineMonthViewComponent extends TimelineBase {
62
67
  }
63
68
  _selectedShortDateFormat;
64
69
  /**
65
- * Specifies the number of months that the view will render.
66
- * > Normalized to `1` if the provided value is <= 0.
70
+ * Sets the number of months to render in the view.
71
+ * If the value is less than or equal to 0, it defaults to 1.
67
72
  * @default 1
68
73
  */
69
74
  set numberOfMonths(months) {
@@ -17,7 +17,14 @@ import * as i1 from "@progress/kendo-angular-l10n";
17
17
  import * as i2 from "../view-context.service";
18
18
  import * as i3 from "../view-state.service";
19
19
  /**
20
- * The component for rendering the **Timeline** view.
20
+ * Represents the component that renders the **Timeline** view in the Scheduler.
21
+ *
22
+ * @example
23
+ * ```html
24
+ * <kendo-scheduler>
25
+ * <kendo-scheduler-timeline-view></kendo-scheduler-timeline-view>
26
+ * </kendo-scheduler>
27
+ * ```
21
28
  */
22
29
  export class TimelineViewComponent extends TimelineBase {
23
30
  /**
@@ -27,10 +34,9 @@ export class TimelineViewComponent extends TimelineBase {
27
34
  return this.localization.get('timelineViewTitle');
28
35
  }
29
36
  /**
30
- * The long-date format for displaying the
31
- * selected date in the Scheduler toolbar.
32
- * ([more information]({% slug parsingandformatting_intl %}#toc-date-formatting)).
33
- * > Note: If [numberOfDays](#toc-numberofdays) > 1, the default format value shows a range - `'{0:D} - {1:D}'`, where `0` is the start and `1` is the end date.
37
+ * Sets the long-date format for the selected date in the Scheduler toolbar.
38
+ * For more information, see [Parsing and Formatting Dates and Numbers](slug:parsingandformatting_intl#date-formatting).
39
+ * If `numberOfDays` is greater than 1, the default format displays a range: `'{0:D} - {1:D}'`, where `0` is the start and `1` is the end date.
34
40
  * @default '{0:D}'
35
41
  */
36
42
  set selectedDateFormat(format) {
@@ -44,10 +50,9 @@ export class TimelineViewComponent extends TimelineBase {
44
50
  }
45
51
  _selectedDateFormat;
46
52
  /**
47
- * The short-date format for displaying the
48
- * selected date in the Scheduler toolbar.
49
- * ([more information]({% slug parsingandformatting_intl %}#toc-date-formatting)).
50
- * > Note: If [numberOfDays](#toc-numberofdays) > 1, the default format value shows a range - `'{0:d} - {1:d}'`, where `0` is the start and `1` is the end date.
53
+ * Sets the short-date format for the selected date in the Scheduler toolbar.
54
+ * For more information, see [Parsing and Formatting Dates and Numbers](slug:parsingandformatting_intl#date-formatting).
55
+ * If `numberOfDays` is greater than 1, the default format displays a range: `'{0:d} - {1:d}'`, where `0` is the start and `1` is the end date.
51
56
  * @default '{0:d}'
52
57
  */
53
58
  set selectedShortDateFormat(format) {
@@ -61,8 +66,8 @@ export class TimelineViewComponent extends TimelineBase {
61
66
  }
62
67
  _selectedShortDateFormat;
63
68
  /**
64
- * Specifies the number of days that the view will render.
65
- * > Normalized to `1` if the provided value is <= 0.
69
+ * Sets the number of days to render in the view.
70
+ * If the value is less than or equal to 0, it defaults to 1.
66
71
  * @default 1
67
72
  */
68
73
  set numberOfDays(days) {
@@ -20,7 +20,14 @@ import * as i2 from "@progress/kendo-angular-l10n";
20
20
  import * as i3 from "../view-context.service";
21
21
  import * as i4 from "../view-state.service";
22
22
  /**
23
- * The component for rendering the **Week** timeline view.
23
+ * Represents the component that renders the **Timeline Week** view in the Scheduler.
24
+ *
25
+ * @example
26
+ * ```html
27
+ * <kendo-scheduler>
28
+ * <kendo-scheduler-timeline-week-view></kendo-scheduler-timeline-week-view>
29
+ * </kendo-scheduler>
30
+ * ```
24
31
  */
25
32
  export class TimelineWeekViewComponent extends TimelineBase {
26
33
  /**
@@ -30,27 +37,24 @@ export class TimelineWeekViewComponent extends TimelineBase {
30
37
  return this.localization.get('timelineWeekViewTitle');
31
38
  }
32
39
  /**
33
- * The long-date format that will be used for displaying the
34
- * selected date in the Scheduler toolbar.
35
- * Defaults to `{0:D} - {1:D}`
36
- * where `0` is the start and `1` is the end date
37
- * ([more information]({% slug parsingandformatting_intl %}#toc-date-formatting)).
40
+ * Sets the long-date format for the selected date in the Scheduler toolbar.
41
+ * Defaults to `'{0:D} - {1:D}'`, where `0` is the start and `1` is the end date.
42
+ * For more information, see [Parsing and Formatting Dates and Numbers](slug:parsingandformatting_intl#date-formatting).
38
43
  * @default '{0:D} - {1:D}'
39
44
  */
40
45
  selectedDateFormat = '{0:D} - {1:D}';
41
46
  /**
42
- * The short date format that will be used for displaying the
43
- * selected date in the Scheduler toolbar.
44
- * Defaults to `{0:d} - {1:d}`
45
- * where `0` is the start and `1` is the end date
46
- * ([more information]({% slug parsingandformatting_intl %}#toc-date-formatting)).
47
+ * Sets the short-date format for the selected date in the Scheduler toolbar.
48
+ * Defaults to `'{0:d} - {1:d}'`, where `0` is the start and `1` is the end date.
49
+ * For more information, see [Parsing and Formatting Dates and Numbers](slug:parsingandformatting_intl#date-formatting).
47
50
  * @default '{0:d} - {1:d}'
48
51
  */
49
52
  selectedShortDateFormat = '{0:d} - {1:d}';
50
53
  /**
51
- * Specifies the number of weeks that the view will render.
52
- * @default 1
53
- */
54
+ * Sets the number of weeks to render in the view.
55
+ * If the value is less than or equal to 0, it defaults to 1.
56
+ * @default 1
57
+ */
54
58
  set numberOfWeeks(weeks) {
55
59
  this._numberOfWeeks = weeks > 0 ? weeks : 1;
56
60
  }
@@ -11,27 +11,27 @@ import * as i0 from "@angular/core";
11
11
  */
12
12
  export class ViewContextService {
13
13
  /**
14
- * A stream of navigation actions that will be handled by the view.
14
+ * Represents a stream that publishes navigation actions to the view.
15
15
  */
16
16
  action;
17
17
  /**
18
- * A stream that executes methods from the view.
18
+ * Represents a stream that executes methods from the view.
19
19
  */
20
20
  execute;
21
21
  /**
22
- * A stream of items (events) that will be displayed in the view.
22
+ * Represents a stream of items (events) to be displayed in the view.
23
23
  */
24
24
  items;
25
25
  /**
26
- * A stream with the selected date that will be displayed by the view.
26
+ * Represents a stream with the selected date to be displayed in the view.
27
27
  */
28
28
  selectedDate;
29
29
  /**
30
- * Fires when the Scheduler element is resized.
30
+ * Emits when the Scheduler element is resized.
31
31
  */
32
32
  resize;
33
33
  /**
34
- * Fires when the Scheduler options are changed.
34
+ * Emits when the Scheduler options change.
35
35
  */
36
36
  optionsChange;
37
37
  actionSource = new Subject();
@@ -16,39 +16,39 @@ const emptyDateRange = () => ({
16
16
  */
17
17
  export class ViewStateService {
18
18
  /**
19
- * A stream for publishing the visible date range of the current view to the Scheduler.
19
+ * Represents a stream that publishes the visible date range for the current view to the Scheduler.
20
20
  */
21
21
  dateRange;
22
22
  /**
23
- * A stream for publishing the changes to the selected date that are initiated from the view.
23
+ * Represents a stream that publishes changes to the selected date, which initiate from the view.
24
24
  */
25
25
  nextDate;
26
26
  /**
27
- * A stream fro navigating from the current to another view.
27
+ * Represents a stream for navigating from the current view to another view.
28
28
  */
29
29
  navigate;
30
30
  /**
31
- * A stream for navigating from the current to another view.
31
+ * Represents a stream that publishes events for navigation between views.
32
32
  */
33
33
  viewEvent;
34
34
  /**
35
- * A stream for indicating that the view layout finished.
35
+ * Represents a stream that indicates when the view layout finishes.
36
36
  */
37
37
  layoutEnd;
38
38
  /**
39
- * A stream for indicating that the view options has changed.
39
+ * Represents a stream that indicates when the view options change.
40
40
  */
41
41
  optionsChange;
42
42
  /**
43
- * A stream indicating that the user has started making a new slot selection.
43
+ * Represents a stream that indicates when the user starts a new slot selection.
44
44
  */
45
45
  slotSelectionStart;
46
46
  /**
47
- * A stream indicating that the user has dragged over a different slot while making a selection.
47
+ * Represents a stream that indicates when the user drags over a different slot during selection.
48
48
  */
49
49
  slotSelectionDrag;
50
50
  /**
51
- * A stream indicating that the user has finished making a slot selection.
51
+ * Represents a stream that indicates when the user finishes making a slot selection.
52
52
  */
53
53
  slotSelectionEnd;
54
54
  /**
@@ -18,21 +18,26 @@ import * as i2 from "../view-context.service";
18
18
  import * as i3 from "../view-state.service";
19
19
  import * as i4 from "@progress/kendo-angular-intl";
20
20
  /**
21
- * The component for rendering the **Year** view.
21
+ * Represents the component that renders the **Year** view in the Scheduler.
22
+ *
23
+ * @example
24
+ * ```html
25
+ * <kendo-scheduler>
26
+ * <kendo-scheduler-year-view></kendo-scheduler-year-view>
27
+ * </kendo-scheduler>
28
+ * ```
22
29
  */
23
30
  export class YearViewComponent extends ConfigurationViewBase {
24
31
  intl;
25
32
  /**
26
- * The long-date format for displaying the
27
- * selected year in the Scheduler toolbar.
28
- * For more information, see [Parsing and Formatting Dates and Numbers]({% slug parsingandformatting_intl %}#toc-date-formatting).
33
+ * Sets the long-date format for the selected year in the Scheduler toolbar.
34
+ * For more information, see [Parsing and Formatting Dates and Numbers](slug:parsingandformatting_intl#date-formatting).
29
35
  * @default '{0:yyy}'
30
36
  */
31
37
  selectedDateFormat = '{0:yyy}';
32
38
  /**
33
- * The short-date format for displaying the
34
- * selected year in the Scheduler toolbar.
35
- * For more information, see [Parsing and Formatting Dates and Numbers]({% slug parsingandformatting_intl %}#toc-date-formatting).
39
+ * Sets the short-date format for the selected year in the Scheduler toolbar.
40
+ * For more information, see [Parsing and Formatting Dates and Numbers](slug:parsingandformatting_intl#date-formatting).
36
41
  * @default '{0:yyy}'
37
42
  */
38
43
  selectedShortDateFormat = '{0:yyy}';
@@ -5,15 +5,15 @@
5
5
  import { PreventableEvent } from './preventable-event';
6
6
  import { SchedulerComponent } from '../scheduler.component';
7
7
  /**
8
- * Arguments for the `add` event of the editing directives.
8
+ * Represents the arguments for the `add` event of the editing directives.
9
9
  */
10
10
  export declare class AddEvent extends PreventableEvent {
11
11
  /**
12
- * The data for binding the **Add** dialog.
12
+ * Provides the data for binding the **Add** dialog.
13
13
  */
14
14
  dataItem: any;
15
15
  /**
16
- * A reference to the Scheduler instance that triggered the event.
16
+ * Provides a reference to the Scheduler instance that triggered the event.
17
17
  */
18
18
  sender: SchedulerComponent;
19
19
  /**
@@ -5,11 +5,11 @@
5
5
  import { FormGroup } from '@angular/forms';
6
6
  import { EditEventBase } from './edit-event-base';
7
7
  /**
8
- * Arguments for the `cancel` event.
8
+ * Represents the arguments for the `cancel` event.
9
9
  */
10
10
  export declare class CancelEvent extends EditEventBase {
11
11
  /**
12
- * The edited `formGroup` instance.
12
+ * Provides the edited `formGroup` instance.
13
13
  */
14
14
  formGroup: FormGroup;
15
15
  }
@@ -4,15 +4,15 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  import { SchedulerComponent } from '../scheduler.component';
6
6
  /**
7
- * Arguments for the `create` event.
7
+ * Represents the arguments for the `create` event.
8
8
  */
9
9
  export declare class CreateEvent {
10
10
  /**
11
- * The start date of the slot.
11
+ * Provides the start date of the slot.
12
12
  */
13
13
  start: Date;
14
14
  /**
15
- * The end date of the slot.
15
+ * Provides the end date of the slot.
16
16
  */
17
17
  end: Date;
18
18
  /**
@@ -20,15 +20,15 @@ export declare class CreateEvent {
20
20
  */
21
21
  isAllDay: boolean;
22
22
  /**
23
- * The resources of the slot.
23
+ * Provides the resources of the slot.
24
24
  */
25
25
  resources: any[];
26
26
  /**
27
- * The original DOM event.
27
+ * Provides the original DOM event.
28
28
  */
29
29
  originalEvent: any;
30
30
  /**
31
- * A reference to the Scheduler instance that triggered the event.
31
+ * Provides a reference to the Scheduler instance that triggered the event.
32
32
  */
33
33
  sender: SchedulerComponent;
34
34
  /**
@@ -5,19 +5,19 @@
5
5
  import { SchedulerComponent } from '../scheduler.component';
6
6
  import { DateRange } from '../types';
7
7
  /**
8
- * Arguments for the `dateChange` event.
8
+ * Represents the arguments for the `dateChange` event.
9
9
  */
10
10
  export declare class DateChangeEvent {
11
11
  /**
12
- * The currently selected date of the Scheduler.
12
+ * Provides the currently selected date of the Scheduler.
13
13
  */
14
14
  selectedDate: Date;
15
15
  /**
16
- * The date range of the current view.
16
+ * Provides the date range of the current view.
17
17
  */
18
18
  dateRange: DateRange;
19
19
  /**
20
- * A reference to the Scheduler instance that triggered the event.
20
+ * Provides a reference to the Scheduler instance that triggered the event.
21
21
  */
22
22
  sender: SchedulerComponent;
23
23
  /**
@@ -5,35 +5,35 @@
5
5
  import { SchedulerComponent } from '../scheduler.component';
6
6
  import { PreventableEvent } from './preventable-event';
7
7
  /**
8
- * Arguments for the `dragEnd` event.
8
+ * Represents the arguments for the `dragEnd` event.
9
9
  */
10
10
  export declare class DragEndEvent extends PreventableEvent {
11
11
  /**
12
- * The original Scheduler event.
12
+ * Provides the original Scheduler event.
13
13
  */
14
14
  event: any;
15
15
  /**
16
- * The `isAllDay` value.
16
+ * Provides the `isAllDay` value.
17
17
  */
18
18
  isAllDay: boolean;
19
19
  /**
20
- * The data item of the event.
20
+ * Provides the data item of the event.
21
21
  */
22
22
  dataItem: any;
23
23
  /**
24
- * The new start date of the event.
24
+ * Provides the new start date of the event.
25
25
  */
26
26
  start: Date;
27
27
  /**
28
- * The new end date of the event.
28
+ * Provides the new end date of the event.
29
29
  */
30
30
  end: Date;
31
31
  /**
32
- * The resources when ending the dragging.
32
+ * Provides the resources when ending the dragging.
33
33
  */
34
34
  resources: any;
35
35
  /**
36
- * A reference to the Scheduler instance that triggered the event.
36
+ * Provides a reference to the Scheduler instance that triggered the event.
37
37
  */
38
38
  sender: SchedulerComponent;
39
39
  /**
@@ -5,31 +5,31 @@
5
5
  import { SchedulerComponent } from '../scheduler.component';
6
6
  import { PreventableEvent } from './preventable-event';
7
7
  /**
8
- * Arguments for the `drag` event.
8
+ * Represents the arguments for the `drag` event.
9
9
  */
10
10
  export declare class DragEvent extends PreventableEvent {
11
11
  /**
12
- * The original Scheduler event.
12
+ * Provides the original Scheduler event.
13
13
  */
14
14
  event: any;
15
15
  /**
16
- * The current `isAllDay` value.
16
+ * Provides the current `isAllDay` value.
17
17
  */
18
18
  isAllDay: boolean;
19
19
  /**
20
- * The data item of the event.
20
+ * Provides the data item of the event.
21
21
  */
22
22
  dataItem: any;
23
23
  /**
24
- * The new start date of the event.
24
+ * Provides the new start date of the event.
25
25
  */
26
26
  start: Date;
27
27
  /**
28
- * The new end date of the event.
28
+ * Provides the new end date of the event.
29
29
  */
30
30
  end: Date;
31
31
  /**
32
- * The current resources while dragging.
32
+ * Provides the current resources while dragging.
33
33
  */
34
34
  resources: any;
35
35
  /**
@@ -41,7 +41,7 @@ export declare class DragEvent extends PreventableEvent {
41
41
  */
42
42
  setSlotClass: (className: string) => void;
43
43
  /**
44
- * A reference to the Scheduler instance that triggered the event.
44
+ * Provides a reference to the Scheduler instance that triggered the event.
45
45
  */
46
46
  sender: SchedulerComponent;
47
47
  /**
@@ -5,19 +5,19 @@
5
5
  import { SchedulerComponent } from '../scheduler.component';
6
6
  import { PreventableEvent } from './preventable-event';
7
7
  /**
8
- * Arguments for the `dragStart` event.
8
+ * Represents the arguments for the `dragStart` event.
9
9
  */
10
10
  export declare class DragStartEvent extends PreventableEvent {
11
11
  /**
12
- * The original Scheduler event.
12
+ * Provides the original Scheduler event.
13
13
  */
14
14
  event: any;
15
15
  /**
16
- * The data item of the event.
16
+ * Provides the data item of the event.
17
17
  */
18
18
  dataItem: any;
19
19
  /**
20
- * A reference to the Scheduler instance that triggered the event.
20
+ * Provides a reference to the Scheduler instance that triggered the event.
21
21
  */
22
22
  sender: SchedulerComponent;
23
23
  /**
@@ -6,19 +6,19 @@ import { PreventableEvent } from './preventable-event';
6
6
  import { SchedulerComponent } from '../scheduler.component';
7
7
  import { SchedulerEvent } from '../types';
8
8
  /**
9
- * Arguments for the `edit` event of the editing directives.
9
+ * Represents the arguments for the `edit` event of the editing directives.
10
10
  */
11
11
  export declare class EditEvent extends PreventableEvent {
12
12
  /**
13
- * The event data item for which the **Edit** dialog will be opened.
13
+ * Provides the event data item for which the **Edit** dialog will be opened.
14
14
  */
15
15
  dataItem: any;
16
16
  /**
17
- * The event for which the **Edit** dialog will be opened.
17
+ * Provides the event for which the **Edit** dialog will be opened.
18
18
  */
19
19
  event: SchedulerEvent;
20
20
  /**
21
- * A reference to the Scheduler instance that triggered the event.
21
+ * Provides a reference to the Scheduler instance that triggered the event.
22
22
  */
23
23
  sender: SchedulerComponent;
24
24
  /**
@@ -4,23 +4,23 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  import { SchedulerComponent } from '../scheduler.component';
6
6
  /**
7
- * Arguments for the `eventClick` and `eventDblClick` events.
7
+ * Represents the arguments for the `eventClick` and `eventDblClick` events.
8
8
  */
9
9
  export declare class EventClickEvent {
10
10
  /**
11
- * The event type.
11
+ * Provides the event type.
12
12
  */
13
13
  type: 'click' | 'contextmenu';
14
14
  /**
15
- * The original Scheduler event.
15
+ * Provides the original Scheduler event.
16
16
  */
17
17
  event: any;
18
18
  /**
19
- * The original DOM event.
19
+ * Provides the original DOM event.
20
20
  */
21
21
  originalEvent: any;
22
22
  /**
23
- * A reference to the Scheduler instance that triggered the event.
23
+ * Provides a reference to the Scheduler instance that triggered the event.
24
24
  */
25
25
  sender: SchedulerComponent;
26
26
  /**