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

package/fesm2015/progress-kendo-angular-scheduler.mjs

@@ -48,8 +48,8 @@ const packageMetadata = {
     name: '@progress/kendo-angular-scheduler',
     productName: 'Kendo UI for Angular',
     productCodes: ['KENDOUIANGULAR', 'KENDOUICOMPLETE'],
-    publishDate: 1693395130,
-    version: '13.4.1-develop.3',
+    publishDate: 1694174973,
+    version: '13.4.1-develop.4',
     licensingDocsUrl: 'https://www.telerik.com/kendo-angular-ui/my-license/'
 };
 
@@ -438,29 +438,35 @@ class SchedulerView {
 /**
  * The selected edit mode during the update or removal of events.
  * For non-recurring events, set to `Event`.
- *
- * The supported values are:
- * * `Event`—Edits the selected event.
- * * `Occurrence`—Edits the selected occurrence.
- * * `Series`—Edits all events in the series.
  */
 var EditMode;
 (function (EditMode) {
+    /**
+     * Edits the selected event.
+     */
     EditMode[EditMode["Event"] = 0] = "Event";
+    /**
+     * Edits the selected occurrence.
+     */
     EditMode[EditMode["Occurrence"] = 1] = "Occurrence";
+    /**
+     * Edits all events in the series.
+     */
     EditMode[EditMode["Series"] = 2] = "Series";
 })(EditMode || (EditMode = {}));
 
 /**
  * The selected CRUD operation when the user edits or removes recurring events.
- *
- * The supported values are:
- * * `Edit`
- * * `Remove`
  */
 var CrudOperation;
 (function (CrudOperation) {
+    /**
+     * The user edits the selected recurring event.
+     */
     CrudOperation[CrudOperation["Edit"] = 0] = "Edit";
+    /**
+     * The user removes the selected recurring event.
+     */
     CrudOperation[CrudOperation["Remove"] = 1] = "Remove";
 })(CrudOperation || (CrudOperation = {}));
 
@@ -2279,14 +2285,6 @@ const iconsMap = { caretAltLeftIcon, caretAltRightIcon, calendarIcon };
  * To render the **Previous**, **Today**, **Next**, and **Date picker**
  * buttons, include the component in the
  * [toolbar template]({% slug api_scheduler_toolbartemplatedirective %}).
- *
- * {% meta height:700 %}
- * {% embed_file toolbar/template/app.component.ts preview %}
- * {% embed_file toolbar/template/my-navigation.component.ts %}
- * {% embed_file toolbar/template/app.module.ts %}
- * {% embed_file shared/events-utc.ts %}
- * {% embed_file shared/main.ts %}
- * {% endmeta %}
  */
 class ToolbarNavigationComponent {
     constructor(popupService, toolbarService, localization, cd, viewContext) {
@@ -2609,14 +2607,6 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
  *
  * To render the view-selection buttons, include the component in the
  * [toolbar template]({% slug api_scheduler_toolbartemplatedirective %}).
- *
- * {% meta height:700 %}
- * {% embed_file toolbar/template/app.component.ts preview %}
- * {% embed_file toolbar/template/my-navigation.component.ts %}
- * {% embed_file toolbar/template/app.module.ts %}
- * {% embed_file shared/events-utc.ts %}
- * {% embed_file shared/main.ts %}
- * {% endmeta %}
  */
 class ToolbarViewSelectorComponent {
     constructor(service, localization) {
@@ -3220,6 +3210,7 @@ class TimeZoneEditorComponent {
     constructor() {
         /**
          * Specifies the width of the ComboBox which contains the names of the timezones.
+         * @default 260
          */
         this.width = 260;
         /**
@@ -4885,6 +4876,7 @@ class RecurrenceEditorComponent {
         this.cssClass = true;
         /**
          * Specifies the id of the timezone that will be used.
+         * @default 'Etc/UTC'
          */
         this.timezone = 'Etc/UTC';
         /**
@@ -6067,22 +6059,6 @@ const todayDate = () => getDate(new Date());
 const DAYS_IN_WEEK$1 = 7;
 /**
  * Represents the [Kendo UI Scheduler component for Angular]({% slug overview_scheduler %}).
- *
- * @example
- * ```ts-preview
- * _@Component({
- *    selector: 'my-app',
- *    template: `
- *        <kendo-scheduler style="height: 600px">
- *            <kendo-scheduler-day-view>
- *            </kendo-scheduler-day-view>
- *            <kendo-scheduler-week-view>
- *            </kendo-scheduler-week-view>
- *        </kendo-scheduler>
- *    `
- * })
- * class AppComponent {}
- * ```
  */
 class SchedulerComponent {
     constructor(wrapper, viewContext, viewState, editService, dialogsService, intlService, changeDetector, zone, pdfService, localization, domEvents, renderer, focusService) {
@@ -6114,62 +6090,74 @@ class SchedulerComponent {
         this.selectable = false;
         /**
          * 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.
+         * @default 25
          */
         this.eventHeight = 25;
         /**
          * Specifies the columns width. Applicable for the **Timeline** views.
+         * @default 100
          */
         this.columnWidth = 100;
         /**
          * The start time of the view. The Scheduler displays events which start after the start time.
          * Accepts string values in the `HH:mm` format. Applicable for the **Day**, **Week**, and **Timeline** views.
+         * @default '00:00'
          */
         this.startTime = '00:00';
         /**
          * The end time of the view. The Scheduler displays events which end before the end time.
          * Accepts string values in the `HH:mm` format. Applicable for the **Day**, **Week**, and **Timeline** views.
+         * @default '00:00'
          */
         this.endTime = '00:00';
         /**
          * The start time of the view when `showWorkHours` is set to `true`.
          * Accepts string values in the `HH:mm` format. Applicable for the **Day**, **Week**, and **Timeline** views.
+         * @default '08:00'
          */
         this.workDayStart = '08:00';
         /**
          * The end time of the view when `showWorkHours` is set to `true`.
          * Accepts string values in the `HH:mm` format. Applicable for the **Day**, **Week**, and **Timeline** views.
+         * @default '17:00'
          */
         this.workDayEnd = '17:00';
         /**
          * The duration (in minutes) of the time slots. Applicable for the day, week and timeline views.
+         * @default 60
          */
         this.slotDuration = 60;
         /**
          * The number of divisions of the time slots. Applicable for the **Day**, **Week**, and **Timeline** views.
+         * @default 2
          */
         this.slotDivisions = 2;
         /**
          * A numeric value between 0 and 1 that specifies what percentage of the slot will be filled by the events.
          * Applicable for the **Day** and **Week** views.
-         * Defaults to `0.9` (90% fill).
+         * @default 0.9
          */
         this.slotFill = 0.9;
         /**
          * The time to which the view will initially be scrolled.
          * Accepts string values in the `HH:mm` format or a JavaScript `Date`. Applicable for the **Day**, **Week**, and **Timeline** views.
+         * @default '08:00'
          */
         this.scrollTime = this.workDayStart;
         /**
          * Specifies the Scheduler current time marker settings.
+         * @default true
          */
         this.currentTimeMarker = true;
         /**
          * Specifies the settings for the ongoing events highlight of the Scheduler.
+         * @default true
          */
         this.highlightOngoingEvents = true;
         /**
          * A callback that executes for each slot of the Scheduler view.
          * If it returns `true`, the `k-selected` CSS class will be added to the cell, making it visibly selected.
+         * @default () => false
          */
         this.isSlotSelected = alwaysFalse;
         /**
@@ -6317,7 +6305,7 @@ class SchedulerComponent {
     /**
      * Specifies the id of the timezone that will be displayed in the Scheduler.
      * For example, `Europe/Sofia`.
-     * Defaults to `Etc/UTC`.
+     * @default 'Etc/UTC'
      */
     set timezone(value) {
         this._timezone = value;
@@ -6645,11 +6633,6 @@ class SchedulerComponent {
      * @param y - The y document position.
      *
      * @return {SchedulerSlot} - The slot.
-     *
-     * {% embed_file drag-and-drop/app.component.ts %}
-     * {% embed_file drag-and-drop/draggable.directive.ts %}
-     * {% embed_file drag-and-drop/app.module.ts %}
-     * {% embed_file shared/main.ts %}
      */
     slotByPosition(x, y) {
         return this.viewContext.executeMethod('slotByPosition', { x, y });
@@ -6676,17 +6659,9 @@ class SchedulerComponent {
     /**
      * Focuses the next event or an event at a specified relative position.
      * The `options` parameter can be used to set a positive or negative offset
-     * that is relative to the currently focused event.
+     * that is relative to the currently focused event ([see example](slug:keyboard_navigation_scheduler#toc-event-navigation-with-the-tab-key)).
      * A `nowrap` flag toggles the wrapping to the first or to the last item.
      *
-     * @example
-     * ```ts-no-run
-     * scheduler.focusNext(); // Focuses the next event.
-     * scheduler.focusNext({ offset: 1 }); // Focuses the next event.
-     * scheduler.focusNext({ offset: -1 }); // Focuses the previous event.
-     * scheduler.focusNext({ nowrap: true }); // If the focus is on the last event, does not move the focus to the first event.
-     * ```
-     *
      * @param position The relative position of the event to focus.
      * @returns `true` if the focused event changed. Otherwise, returns `false`.
      */
@@ -6698,15 +6673,9 @@ class SchedulerComponent {
     /**
      * Focuses the previous event or an event at a specified relative position.
      * The `options` parameter can be used to set a positive or negative offset
-     * that is relative to the currently focused event.
+     * that is relative to the currently focused event ([see example](slug:keyboard_navigation_scheduler#toc-event-navigation-with-the-tab-key)).
      * A `nowrap` flag toggles the wrapping to the first or to the last item.
      *
-     * @example
-     * ```ts-no-run
-     * scheduler.focusPrev(); // Focuses the previous event
-     * scheduler.focusPrev({ nowrap: true }); // Does not move the focus to the last event, if focus is on the first one.
-     * ```
-     *
      * @param position The relative position of the event to focus.
      * @returns `true` if the focused event changed. Otherwise, returns `false`.
      */
@@ -9066,15 +9035,17 @@ class AgendaViewComponent extends ConfigurationViewBase {
          * Defaults to `{0:d} - {1:d}`,
          * where `0` is the start and `1` is the end date
          * ([more information]({% slug parsingandformatting_intl %}#toc-date-formatting)).
+         * @default '{0:d} - {1:d}'
          */
         this.selectedShortDateFormat = '{0:d} - {1:d}';
         /**
          * Specifies the number of days that the view will render.
-         * Defaults to `7`.
+         * @default 7
          */
         this.numberOfDays = 7;
         /**
          * The invariant name for this view (`agenda`).
+         * @default 'agenda'
          */
         this.name = 'agenda';
     }
@@ -11783,19 +11754,20 @@ class MonthViewComponent extends ConfigurationViewBase {
         /**
          * The long-date format for displaying the
          * selected date in the Scheduler toolbar.
-         * Defaults to `{0:Y}`
          * ([more information]({% slug parsingandformatting_intl %}#toc-date-formatting)).
+         * @default '{0:Y}'
          */
         this.selectedDateFormat = '{0:Y}';
         /**
          * The short-date format for displaying the
          * selected date in the Scheduler toolbar.
-         * Defaults to `{0:y}`
          * ([more information]({% slug parsingandformatting_intl %}#toc-date-formatting.
+         * @default '{0:y}'
          */
         this.selectedShortDateFormat = '{0:y}';
         /**
-         * The invariant name for this view (`month`).
+         * The invariant name for this view.
+         * @default 'month'
          */
         this.name = 'month';
     }
@@ -11900,21 +11872,21 @@ class MultiWeekViewComponent extends ConfigurationViewBase {
         this.intl = intl;
         /**
          * The number of weeks to be rendered.
-         * Defaults to `6`.
+         * @default 6
          */
         this.numberOfWeeks = WEEKS_COUNT;
         /**
          * The long-date format for displaying the
          * selected date in the Scheduler toolbar.
-         * Defaults to `{0:D} - {1:D}`
          * ([more information]({% slug parsingandformatting_intl %}#toc-date-formatting)).
+         * @default '{0:D} - {1:D}'
          */
         this.selectedDateFormat = '{0:D} - {1:D}';
         /**
          * The short-date format for displaying the
          * selected date in the Scheduler toolbar.
-         * Defaults to `{0:d} - {1:d}`
          * ([more information]({% slug parsingandformatting_intl %}#toc-date-formatting.
+         * @default '{0:d} - {1:d}'
          */
         this.selectedShortDateFormat = '{0:d} - {1:d}';
         /**
@@ -14468,7 +14440,8 @@ class DayViewComponent extends MultiDayViewBase {
     constructor(localization, changeDetector, viewContext, viewState) {
         super(localization, changeDetector, viewContext, viewState);
         /**
-         * The invariant name for this view (`day`).
+         * The invariant name for this view.
+         * @default 'day'
          */
         this.name = 'day';
         this._selectedDateFormat = '{0:D}';
@@ -14483,8 +14456,8 @@ class DayViewComponent extends MultiDayViewBase {
     /**
      * The long-date format for displaying the
      * selected date in the Scheduler toolbar.
-     * Defaults to `{0:D}`
      * ([more information]({% slug parsingandformatting_intl %}#toc-date-formatting)).
+     * @default '{0:D}'
      */
     set selectedDateFormat(value) {
         this._selectedDateFormat = value;
@@ -14496,8 +14469,8 @@ class DayViewComponent extends MultiDayViewBase {
     /**
      * The short-date format for displaying the
      * selected date in the Scheduler toolbar.
-     * Defaults to `{0:D}`
      * ([more information]({% slug parsingandformatting_intl %}#toc-date-formatting)).
+     * @default '{0:d}'
      */
     set selectedShortDateFormat(value) {
         this._selectedShortDateFormat = value;
@@ -14617,11 +14590,12 @@ class MultiDayViewComponent extends DayViewComponent {
         super(localization, changeDetector, viewContext, viewState);
         /**
          * Specifies the number of days that the view will render.
-         * Defaults to `1`.
+         * @default 1
          */
         this.numberOfDays = 1;
         /**
-         * The invariant name for this view (`multi-day`).
+         * The invariant name for this view.
+         * @default 'multi-day'
          */
         this.name = 'multiDay';
     }
@@ -14630,6 +14604,7 @@ class MultiDayViewComponent extends DayViewComponent {
      * selected date in the Scheduler toolbar.
      * Defaults to `{0:D} - {1:D}` for multiple days and `{0:D}` for a single day
      * ([more information](slug:parsingandformatting_intl#toc-date-formatting)).
+     * @default '{0:D} - {1:D}'
      */
     set selectedDateFormat(value) {
         this.dateFormat = value;
@@ -14642,6 +14617,7 @@ class MultiDayViewComponent extends DayViewComponent {
      * selected date in the Scheduler toolbar.
      * Defaults to `{0:d} - {1:d}` for multiple days and `{0:d}` for a single day
      * ([more information](slug:parsingandformatting_intl#toc-date-formatting)).
+     * @default '{0:d} - {1:d}'
      */
     set selectedShortDateFormat(value) {
         this.shortDateFormat = value;
@@ -14771,6 +14747,7 @@ class WeekViewComponent extends MultiDayViewBase {
          * Defaults to `{0:D} - {1:D}`,
          * where `0` is the start and `1` is the end date
          * ([more information]({% slug parsingandformatting_intl %}#toc-date-formatting).
+         * @default '{0:D} - {1:D}'
          */
         this.selectedDateFormat = '{0:D} - {1:D}';
         /**
@@ -14779,10 +14756,12 @@ class WeekViewComponent extends MultiDayViewBase {
          * Defaults to `{0:d} - {1:d}`,
          * where `0` is the start and `1` is the end date
          * ([more information]({% slug parsingandformatting_intl %}#toc-date-formatting).
+         * @default '{0:d} - {1:d}'
          */
         this.selectedShortDateFormat = '{0:d} - {1:d}';
         /**
-         * The invariant name for this view (`week`).
+         * The invariant name for this view.
+         * @default 'week'
          */
         this.name = 'week';
         this.getStartDate = this.getStartDate.bind(this);
@@ -14916,7 +14895,8 @@ class WorkWeekViewComponent extends WeekViewComponent {
     constructor(intl, localization, changeDetector, viewContext, viewState) {
         super(intl, localization, changeDetector, viewContext, viewState);
         /**
-         * The invariant name for this view (`week`).
+         * The invariant name for this view.
+         * @default 'workWeek'
          */
         this.name = 'workWeek';
         this.getNextDate = this.getNextDate.bind(this);
@@ -15626,19 +15606,20 @@ class TimelineViewComponent extends TimelineBase {
         /**
          * The long-date format for displaying the
          * selected date in the Scheduler toolbar.
-         * Defaults to `{0:D}`
          * ([more information]({% slug parsingandformatting_intl %}#toc-date-formatting)).
+         * @default '{0:D}'
          */
         this.selectedDateFormat = '{0:D}';
         /**
          * The short-date format for displaying the
          * selected date in the Scheduler toolbar.
-         * Defaults to `{0:D}`
          * ([more information]({% slug parsingandformatting_intl %}#toc-date-formatting)).
+         * @default '{0:d}'
          */
         this.selectedShortDateFormat = '{0:d}';
         /**
-         * The invariant name for this view (`timeline`).
+         * The invariant name for this view.
+         * @default 'timeline'
          */
         this.name = 'timeline';
     }
@@ -15743,6 +15724,7 @@ class TimelineWeekViewComponent extends TimelineBase {
          * Defaults to `{0:D} - {1:D}`
          * where `0` is the start and `1` is the end date
          * ([more information]({% slug parsingandformatting_intl %}#toc-date-formatting)).
+         * @default '{0:D} - {1:D}'
          */
         this.selectedDateFormat = '{0:D} - {1:D}';
         /**
@@ -15751,10 +15733,12 @@ class TimelineWeekViewComponent extends TimelineBase {
          * Defaults to `{0:d} - {1:d}`
          * where `0` is the start and `1` is the end date
          * ([more information]({% slug parsingandformatting_intl %}#toc-date-formatting)).
+         * @default '{0:d} - {1:d}'
          */
         this.selectedShortDateFormat = '{0:d} - {1:d}';
         /**
-         * The invariant name for this view (`timelineWeek`).
+         * The invariant name for this view.
+         * @default 'timelineWeek'
          */
         this.name = 'timelineWeek';
         /**
@@ -15870,19 +15854,20 @@ class TimelineMonthViewComponent extends TimelineBase {
         /**
          * The long-date format for displaying the
          * selected date in the Scheduler toolbar.
-         * Defaults to `{0:Y}`
          * ([more information]({% slug parsingandformatting_intl %}#toc-date-formatting)).
+         * @default '{0:Y}'
          */
         this.selectedDateFormat = '{0:Y}';
         /**
          * The short-date format for displaying the
          * selected date in the Scheduler toolbar.
-         * Defaults to `{0:y}`
          * ([more information]({% slug parsingandformatting_intl %}#toc-date-formatting)).
+         * @default '{0:y}'
          */
         this.selectedShortDateFormat = '{0:y}';
         /**
-         * The invariant name for this view (`timelineMonth`).
+         * The invariant name for this view.
+         * @default 'timelineMonth'
          */
         this.name = 'timelineMonth';
         /**
@@ -17346,7 +17331,7 @@ class PDFComponent {
         this.ngZone = ngZone;
         /**
          * The creator of the PDF document.
-         * Defaults to `Kendo UI PDF Generator`.
+         * @default 'Kendo UI PDF Generator'
          */
         this.creator = 'Kendo UI PDF Generator';
         this.subscriptions = this.pdfService.elementReady.subscribe(this.createElement.bind(this));