Views
configurationThe views displayed by the scheduler and their configuration. The array items can be either objects specifying the view configuration or strings representing the view types (assuming default configuration). By default the Kendo UI Scheduler widget displays "day" and "week" view.
views
Arrayviews.adaptiveSlotHeight
BooleanIncreases the slot height when containing events up to views.eventsPerDay and reduces its height if there are less events for that specific day.
The
adaptiveSlotHeightoption is supported whenviews.typeis set to "month". TheadaptiveSlotHeightoption is not supported in resource grouping or date grouping scenarios.
Default: false
views.allDayEventTemplate
String|FunctionThe template used to render the "all day" scheduler events.
The fields which can be used in the template are:
- description
String- the event description - end
Date- the event end date - resources
Array- the event resources - start
Date- the event start date - title
String- the event title
The
allDayEventTemplateoption is supported when views.type is set to "day" or "week".
views.allDaySlot
BooleanIf set to true the scheduler will display a slot for "all day" events.
The
allDaySlotoption is supported when views.type is set to "day" or "week".
Default: true
views.allDaySlotTemplate
String|FunctionThe template used to render the all day slot cell.
The fields which can be used in the template are:
-
date - represents the slot date.
-
resources() - returns the relevant resources for the current slot.
The
allDaySlotTemplateoption is supported when views.type is set to "day", "week" or "workWeek".
views.columnWidth
NumberThe width of the table columns in timeline views. Value is treated as pixels.
The
columnWidthoption is supported when views.type is set to "timeline", "timelineWeek", "timelineWorkWeek" or "timelineMonth".
Default: 100
views.dateHeaderTemplate
String|FunctionThe template used to render the date header cells.
By default the scheduler renders the date using a custom date format - "ddd M/dd". The "ddd" specifier, a.k.a abbreviated name of the week day, will be localized using the current Kendo UI culture. If the developer wants to control the day and month order then one needs to define a custom template.
The fields which can be used in the template are:
- date - represents the major tick date.
The
dateHeaderTemplateoption is supported when views.type is set to "day", "week", "workweek" and "timeline" views.
views.dayTemplate
String|FunctionThe template used to render the day slots in month view.
The fields which can be used in the template are:
-
date
Date- represents the current day -
resources() - returns the relevant resources for the current slot.
The
dayTemplateoption is supported when views.type is set to "month".
views.editable
Boolean|ObjectIf set to true the user would be able to create new scheduler events and modify or delete existing ones.
Overrides the editable option of the scheduler.
Default: true
views.endTime
DateThe end time of the view. The scheduler will display events ending before the endTime.
The template used by the agenda view to render the date of the scheduler events.
The fields which can be used in the template are:
- date
Date- represents the event date.
The
eventDateTemplateoption is supported when views.type is set to "agenda".
views.eventHeight
String|NumberThe height of the scheduler event rendered in month and timeline views. In month view it could be set to a concrete number or to the string value "auto". When set to "auto" it will automatically set the views.adaptiveSlotHeight property to true.
The
eventHeightoption is supported when views.type is set to "month", "timeline", "timelineWeek", "timelineWorkWeek" or "timelineMonth". The "auto" value is supported when views.type is set to "month" and it sets the views.adaptiveSlotHeight to true. TheeventHeightoption is not supported in resource grouping or date grouping scenarios.
Default: 25
views.eventSpacing
NumberSpecifies the distance between individual events.
The
eventSpacing option is supported whenviews.type` is set to "month".
Default: 3
views.eventTemplate
String|FunctionThe template used by the view to render the scheduler events.
The fields which can be used in the template are:
- description
String- the event description - end
Date- the event end date - resources
Array- the event resources - start
Date- the event start date - title
String- the event title
views.eventTimeTemplate
String|FunctionThe template used by the agenda view to render the time of the scheduler events.
The fields which can be used in the template are:
- description
String- the event description - end
Date- the event end date - isAllDay
Boolean- if true the event is "all day" - resources
Array- the event resources - start
Date- the event start date - title
String- the event title
The
eventTimeTemplateoption is supported when views.type is set to "agenda".
views.eventsPerDay
NumberIndicates how many events could be listed for a day. When there are more events for a specific day a "more" link will be placed at the bottom of the day slot and will navigate to the day view if clicked.
The
eventsPerDayoption is supported whenviews.typeis set to "month". If it is set to 0 it is internally set to 1.
Default: 2
views.group
ObjectThe configuration of the view resource(s) grouping.
views.majorTick
NumberThe number of minutes represented by a major tick.
The
majorTickoption is supported when views.type is set to "day" or "week".
Default: 60
views.majorTimeHeaderTemplate
String|FunctionThe template used to render the major ticks.
By default the scheduler renders the time using the current culture time format.
The fields which can be used in the template are:
- date - represents the major tick date.
The
majorTimeHeaderTemplateoption is supported when views.type is set to "day", "week", "workweek" and "timeline" views.
views.minorTickCount
NumberThe number of time slots to display per major tick.
The
minorTickCountoption is supported when views.type is set to "day", "week" or "timeline".
Default: 2
views.minorTimeHeaderTemplate
String|FunctionThe template used to render the minor ticks.
By default the scheduler renders a " ".
The fields which can be used in the template are:
- date - represents the major tick date.
The
minorTimeHeaderTemplateoption is supported when views.type is set to "day" or "week".
views.months
NumberConfigures the number of months that will be displayed in the year view calendar.
The
monthsoption is supported when views.type is set to "year".
Default: 12
views.moreEventsPopover
BooleanControls how event overflow is opened in the Month view. When set to true, clicking the more-events link opens a popover for the date. When set to false, clicking the link uses the legacy behavior and navigates to the Day view.
The
moreEventsPopoveroption is supported only whenviews.typeis set to"month". The messages.moreEventsPopover messages are processed only when this option istrue.
Default: false
views.name
StringThe name of the view. Typically, used to get the name of the currently selected view via the view method.
views.selected
BooleanIf set to true the view will be initially selected by the scheduler widget.
If more than one view is selected then last of them will prevail.
Default: false
views.selectedDateFormat
StringThe format used to display the selected date. Uses kendo.format.
Contains two placeholders - "{0}" and "{1}" which represent the start and end date displayed by the view.
The format used to display the selected date when viewport is narrow, and the date is displayed in short ("d") format by default. Uses kendo.format.
views.showWorkHours
BooleanIf set to true the view will be initially shown in business hours mode. By default view is displayed in full day mode.
The
showWorkHoursoption is supported when views.type is set to "day" or "week".
Default: false
views.slotTemplate
String|FunctionThe template used to render the time slot cells.
The fields which can be used in the template are:
-
date - represents the slot date and time.
-
resources() - returns the relevant resources for the current slot.
The
slotTemplateoption is supported when views.type is set to "day", "week", "workWeek" or "timeline" views.
views.startDate
DateConfigures the start date of the year view. The Scheduler will display 12 months starting from the startDate.
The
startDateoption is supported when views.type is set to "year".
views.startTime
DateThe start time of the view. The scheduler will display events starting after the startTime.
views.title
StringThe user-friendly title of the view displayed by the scheduler.
views.tooltipTemplate
String|FunctionConfigures the template used to render the Tooltip in the Scheduler year view.
The
tooltipTemplateoption is supported when views.type is set to "year".
The fields which can be used in the template are:
- date
Date- the selected date from the calendar - events
Array- list of the events and their respective resource for the selected date - messages
Object- the configuration of the Scheduler messages used for localization.
views.type
StringThe type of the view. The built-in views are: "day", "week", "workWeek", "month", "agenda", "timeline", "timelineWeek", "timelineWorkWeek", "timelineMonth" and "year".
views.virtual
BooleanEnables the DOM virtualization for vertical grouping of the view - renders batches of DOM elements as you scroll. The views that support this option are: "day", "week", "workWeek", "month".
Default: false
views.workDays
ArraySets the working days (index based).
views.workWeekEnd
NumberThe end of working week (index based).
The
workWeekEndoption is supported when views.type is set to "day" or "week".
Default: 5
views.workWeekStart
NumberThe start of working week (index based).
The
workWeekStartoption is supported when views.type is set to "day" or "week".
Default: 1