SchedulerComponent
Represents the Kendo UI Scheduler component for Angular.
@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 {}
Selector
kendo-scheduler
Inputs
Name | Type | Default | Description |
---|---|---|---|
columnWidth |
| Specifies the columns width. Applicable for the Timeline views. | |
currentTimeMarker |
| Specifies the Scheduler current time marker settings. | |
editable |
| Specifies if the Scheduler is editable. | |
endTime |
| The end time of the view. The Scheduler displays events which end before the end time.
Accepts string values in the | |
eventClass |
| Defines a function that is executed for every event in the view.
The function returns a value which is supported by
| |
eventHeight |
| 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. | |
eventStyles |
| Defines a function that is executed for every event in the view.
The function returns a value which is supported by
| |
group |
| Specifies the groups of the Scheduler. | |
highlightOngoingEvents |
| Specifies the settings for the ongoing events highlight of the Scheduler. | |
isSlotSelected |
| A callback that executes for each slot of the Scheduler view.
If it returns | |
loading |
| Specifies if the Scheduler will display a loading indicator. | |
max |
| The maximum date that can be selected by using the navigation of the Scheduler. | |
min |
| The minimum date that can be selected by using the navigation of the Scheduler. | |
resources |
| Specifies the resources of the Scheduler. | |
scrollTime |
| The time to which the view will initially be scrolled.
Accepts string values in the | |
selectable |
| Specifies if the Scheduler's day or time slots are selectable (see example). When this input is set to | |
showWorkHours |
| If set to | |
slotClass |
| Defines a function that is executed for every slot in the view.
The function returns a value which is supported by
| |
slotDivisions |
| The number of divisions of the time slots. Applicable for the Day, Week, and Timeline views. | |
slotDuration |
| The duration (in minutes) of the time slots. Applicable for the day, week and timeline views. | |
slotFill |
| 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 | |
startTime |
| The start time of the view. The Scheduler displays events which start after the start time.
Accepts string values in the | |
workDayEnd |
| The end time of the view when | |
workDayStart |
| The start time of the view when | |
workWeekEnd |
| The end of the work week. Applicable for the Day, Week, and Timeline views. | |
workWeekStart |
| The start of the work week. Applicable for the Day, Week, and Timeline views. | |
events |
| An array of event instances which will be shown by the Scheduler. | |
modelFields |
| The names of the model fields from which the Scheduler will read its data (see example). | |
selectedDate |
| The currently selected date of the Scheduler. Determines the period which is displayed. | |
selectedViewIndex |
| The index of the currently selected view. By default, the selected view index is | |
timezone |
| Specifies the id of the timezone that will be displayed in the Scheduler.
For example, | |
weekStart |
| The first day of the week. Applicable to Week, Month and TimelineWeek views. Defaults to the locale settings. |
Fields
Name | Type | Default | Description |
---|---|---|---|
selectedView |
| The currently selected view. | |
activeEvent |
| Gets the currently active event, if any. The active event is the event that can currently receive focus. |
Events
Name | Type | Description |
---|---|---|
cancel |
| Fires when the user cancels the editing by clicking the Cancel command button. |
create |
| Fires when the user creates a new event using the |
dateChange |
| Fires when the date range that is displayed in the Scheduler changes. |
drag |
| Fires when 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 |
| Fires when a key is pressed on a focused Scheduler event. |
navigate |
| Fires when the Scheduler is about to execute a navigation action (a view, date, or focus change). |
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 |
| Fires when 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. |
slotClick |
| Fires when a Scheduler view slot is clicked. |
slotDblClick |
| Fires when a Scheduler view slot is double-clicked. |
slotDrag |
| Fires when 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 event 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. | |||||||||
| |||||||||
|