Unions

The following unions are available in the Scheduler component:

NameValueDescription
CrudAction
'Add' | 'Edit' | 'EditSeries' | 'EditCurrentSeries' | 'EditOccurrence' | 'Delete' | 'DeleteOccurrence' | 'DeleteSeries' | 'EditFollowingEvents' | 'EditCurrentFollowingEvents' | 'DeleteFollowingEvents'

A type representing the action performed when opening the editor.

  • Add - Opens the editor to create a new event.
  • Edit - Opens the editor to modify an existing event.
  • EditSeries - Opens the editor to modify an entire recurring event series.
  • EditCurrentSeries - Opens the editor to modify the current occurrence of a recurring event.
  • EditOccurrence - Opens the editor to modify a specific occurrence of a recurring event.
  • Delete - Opens an editor to delete a specific occurrence of a recurring event.
  • DeleteOccurrence - Opens a confirmation dialog to delete a specific occurrence of a recurring event.
  • DeleteSeries - Opens a confirmation dialog to delete an entire recurring event series.
  • EditFollowingEvents - Opens the editor to modify the current and following occurrences of a recurring event.
  • DeleteFollowingEvents - Opens a confirmation dialog to delete the current and following occurrences of a recurring event.
EditAction
'Add' | 'Edit' | 'EditSeries' | 'EditOccurrence' | 'EditFollowingEvents'

An enum that represents the context type used to open the editor.

  • Add - Opens the editor to create a new event.
  • Edit - Opens the editor to modify an existing event.
  • EditSeries - Opens the editor to modify an entire recurring event series.
  • EditOccurrence - Opens the editor to modify a specific occurrence of a recurring event.
SpannedEventPlacement
'AllDayRow' | 'TimeSlot'

An enum that holds the options to render the spanned events in all day row or time slot.

  • AllDayRow - Denotes the rendering of spanned events in an all-day row.
  • TimeSlot - Denotes the rendering of spanned events in an time slot row.
View
'Day' | 'Week' | 'WorkWeek' | 'Month' | 'TimelineDay' | 'TimelineWeek' | 'TimelineWorkWeek' | 'TimelineMonth' | 'Agenda'

Defines the view options for the Scheduler component.

WeekRule
'FirstDay' | 'FirstFourDayWeek' | 'FirstFullWeek'

An enum that holds the options to render the week number based on different rules.

  • FirstDay - Denotes that the first week of the year starts on the first day of the year and ends before the following designated first day of the week.
  • FirstFourDayWeek - Denotes that the first week of the year is the first week with four or more days before the designated first day of the week.
  • FirstFullWeek - Denotes that the first week of the year begins on the first occurrence of the designated first day of the week on or after the first day of the year.
HeaderRowOption
'Year' | 'Month' | 'Week' | 'Date' | 'Hour'

Header row options for timeline views