SchedulerComponent
Represents the Kendo UI Scheduler component for Angular.
<kendo-scheduler [kendoSchedulerBinding]="events" [selectedDate]="selectedDate">
<kendo-scheduler-day-view></kendo-scheduler-day-view>
</kendo-scheduler>
Selector
kendo-scheduler
Inputs
| Name | Type | Default | Description |
|---|---|---|---|
allDaySlot |
|
|
Toggles the visibility of the all-day slot. Applies to Day, Multi-Day, Week, and Work-Week views. |
columnWidth |
|
|
Sets the column width for Timeline views. |
currentTimeMarker |
|
|
Sets the Scheduler current time marker settings. |
editable |
|
|
Specifies whether the Scheduler is editable.
When you use an |
endTime |
|
|
Sets the end time of the view. Accepts a string in |
eventClass |
|
Defines a function that is executed for every event in the view.
The function returns a value supported by | |
eventHeight |
|
|
Sets the height of events in the Month and Timeline views, and the height of All day events in the Day and Week views. |
events |
|
Sets the array of event instances shown by the Scheduler. Provide an array of SchedulerEvent objects to display events in the Scheduler. To bind data from custom object schemas, configure the modelFields property to map your custom fields to the Scheduler event fields. | |
eventStyles |
|
Defines a function that is executed for every event in the view.
The function returns a value supported by | |
group |
|
Configures resource-based grouping in the Scheduler. When set, the Scheduler arranges events into separate lanes or columns according to the resources defined in the | |
hiddenDays |
|
Specifies the days that will be hidden from the view.
Applies to Week, MultiWeek, WorkWeek, Month, MultiDay, TimeLineWeek, TimeLineMonth, and Agenda views.
Accepts an array of | |
highlightOngoingEvents |
|
|
Defines the settings for highlighting ongoing events in the Scheduler. |
isSlotSelected |
|
A callback that is executed for each slot of the Scheduler view.
If it returns | |
loading |
|
|
Specifies whether the Scheduler displays a loading indicator. |
max |
|
Sets the maximum date that you can select using the Scheduler navigation. | |
min |
|
Sets the minimum date that you can select using the Scheduler navigation. | |
modelFields |
|
Sets the names of the model fields from which the Scheduler reads its data ([see example])(https://www.telerik.com/kendo-angular-ui/components/scheduler/data-binding#binding-to-custom-object-schemas). Use | |
resources |
|
Specifies the collection of resources available for event assignment in the Scheduler. Each resource describes a category and provides metadata. | |
scrollTime |
|
|
Sets the time to which the view initially scrolls. Accepts a string in |
selectable |
|
|
Specifies whether the Scheduler's day or time slots are selectable (see example).
When set to |
selectedDate |
|
Sets the currently selected date of the Scheduler. Determines the displayed period. | |
selectedViewIndex |
|
|
Sets the index of the currently selected view. The default value is |
showFooter |
|
|
Specifies whether to display the Scheduler footer. |
showToolbar |
|
|
Specifies whether to display the Scheduler toolbar. |
showWorkHours |
|
|
Sets whether the view shows business hours on initialization. By default, the view shows full-day hours. Applies to Day, Week, and Timeline views. |
slotClass |
|
Defines a function that is executed for every slot in the view.
The function returns a value supported by | |
slotDivisions |
|
|
Sets the number of divisions for the time slots. Applies to Day, Week, and Timeline views. |
slotDuration |
|
|
Sets the duration (in minutes) of the time slots. Applies to Day, Week, and Timeline views. |
slotFill |
|
|
Sets the percentage of the slot filled by events. Accepts a value between 0 and 1. Applies to Day and Week views. |
startTime |
|
|
Sets the start time of the view. Accepts a string in |
timezone |
|
|
Sets the timezone ID displayed in the Scheduler. For example, |
weekStart |
|
Sets the first day of the week. Applies to Week, Month, and TimelineWeek views. Defaults to the locale settings. | |
workDayEnd |
|
|
Sets the end time of the view when |
workDayStart |
|
|
Sets the start time of the view when |
workWeekEnd |
|
|
Sets the end of the work week. Applies to Day, Week, and Timeline views. |
workWeekStart |
|
|
Sets the start of the work week. Applies to Day, Week, and Timeline views. |
Fields
| Name | Type | Default | Description |
|---|---|---|---|
activeEvent |
|
Gets the currently active event, if any. The active event is the event that can currently receive focus. | |
selectedView |
|
The currently selected view. |
Events
| Name | Type | Description |
|---|---|---|
cancel |
|
Fires when the user cancels the editing by clicking the Cancel command button. |
create |
|
Emits when the user creates a new event using the |
dateChange |
|
Emits when the displayed date range in the Scheduler changes. |
drag |
|
Fires while the user is dragging a Scheduler event. |
dragEnd |
|
Fires when the user stops dragging a Scheduler event. |
dragStart |
|
Fires when the user starts dragging a Scheduler event. |
eventClick |
|
Fires when a Scheduler event is clicked. |
eventDblClick |
|
Fires when a Scheduler event is double-clicked. |
eventKeydown |
|
Emits when you press a key on a focused Scheduler event. |
navigate |
|
Emits when the Scheduler is about to perform a navigation action, such as changing the view, date, or focus. |
pdfExport |
|
Fires when the user clicks the PDF export command button. |
remove |
|
Fires when the user clicks the Remove icon of a Scheduler event. |
resize |
|
Emits while the user is resizing a Scheduler event. |
resizeEnd |
|
Fires when the user stops resizing a Scheduler event. |
resizeStart |
|
Fires when the user starts resizing a Scheduler event. |
save |
|
Fires when the user clicks the Save command button to save the changes of the edited event. |
schedulerResize |
|
Fires when the Scheduler is resized horizontally. |
slotClick |
|
Emits when a Scheduler view slot is clicked. |
slotDblClick |
|
Fires when a Scheduler view slot is double-clicked. |
slotDrag |
|
Fires while the user is drag-selecting a Scheduler slot range. |
slotDragEnd |
|
Fires when the user stops drag-selecting a Scheduler slot range. |
slotDragStart |
|
Fires when the user starts drag-selecting a Scheduler slot range. |
Methods
addEvent | ||||||
|---|---|---|---|---|---|---|
|
Creates a popup editor for the new event. | ||||||
|
closeEvent |
|---|
|
Closes the event editor, if open. |
editEvent | |||||||||
|---|---|---|---|---|---|---|---|---|---|
|
Switches the specified event in edit mode. | |||||||||
|
eventFromElement | ||||||
|---|---|---|---|---|---|---|
|
Returns the event associated with the specified DOM element, if any. | ||||||
| ||||||
|
focus |
|---|
|
Focuses the last focused scheduler element or the Scheduler element, if no events are available. |
focusNext | ||||||
|---|---|---|---|---|---|---|
|
Focuses the next event or an event at a specified relative position.
The | ||||||
| ||||||
|
focusPrev | ||||||
|---|---|---|---|---|---|---|
|
Focuses the previous event or an event at a specified relative position.
The | ||||||
| ||||||
|
isEditing | ||||
|---|---|---|---|---|
|
Returns a flag which indicates if an event is currently edited. | ||||
|
openRecurringConfirmationDialog | ||||||
|---|---|---|---|---|---|---|
|
Opens the built-in confirmation dialog for defining the edit mode that will be used when the user edits or removes a recurring event. | ||||||
| ||||||
|
openRemoveConfirmationDialog | ||||
|---|---|---|---|---|
|
Opens the built-in removal confirmation dialog. | ||||
|
saveAsPDF |
|---|
|
Saves the current view as PDF. |
scrollToTime | ||||||
|---|---|---|---|---|---|---|
|
Scrolls the view to the specified time. | ||||||
|
slotByPosition | |||||||||
|---|---|---|---|---|---|---|---|---|---|
|
Returns the current view slot that matches the passed document position. | |||||||||
| |||||||||
|