\Kendo\UI\SchedulerView

A PHP class representing the view setting of SchedulerViews.

Methods

adaptiveSlotHeight

Increases the slot height when containing events up to views.eventsPerDay and reduces its height if there are less events for that specific day.

Returns

\Kendo\UI\SchedulerView

Parameters

$value boolean

Example

<?php
$view = new \Kendo\UI\SchedulerView();
$view->adaptiveSlotHeight(true);
?>

allDayEventTemplate

The 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 or title String - the event title.

Returns

\Kendo\UI\SchedulerView

Parameters

$value string|\Kendo\JavaScriptFunction

Example - using string

<?php
$view = new \Kendo\UI\SchedulerView();
$view->allDayEventTemplate('value');
?>

Example - using \Kendo\JavaScriptFunction

<?php
$view = new \Kendo\UI\SchedulerView();
$view->allDayEventTemplate(new \Kendo\JavaScriptFunction('function() { }'));
?>

allDaySlot

If set to true the scheduler will display a slot for "all day" events.

Returns

\Kendo\UI\SchedulerView

Parameters

$value boolean

Example

<?php
$view = new \Kendo\UI\SchedulerView();
$view->allDaySlot(true);
?>

allDaySlotTemplate

The template used to render the all day slot cell.The fields which can be used in the template are: date - represents the slot date. or resources() - returns the relevant resources for the current slot..

Returns

\Kendo\UI\SchedulerView

Parameters

$value string|\Kendo\JavaScriptFunction

Example - using string

<?php
$view = new \Kendo\UI\SchedulerView();
$view->allDaySlotTemplate('value');
?>

Example - using \Kendo\JavaScriptFunction

<?php
$view = new \Kendo\UI\SchedulerView();
$view->allDaySlotTemplate(new \Kendo\JavaScriptFunction('function() { }'));
?>

columnWidth

The width of the table columns in timeline views. Value is treated as pixels.

Returns

\Kendo\UI\SchedulerView

Parameters

$value float

Example

<?php
$view = new \Kendo\UI\SchedulerView();
$view->columnWidth(1);
?>

dateHeaderTemplate

The 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..

Returns

\Kendo\UI\SchedulerView

Parameters

$value string|\Kendo\JavaScriptFunction

Example - using string

<?php
$view = new \Kendo\UI\SchedulerView();
$view->dateHeaderTemplate('value');
?>

Example - using \Kendo\JavaScriptFunction

<?php
$view = new \Kendo\UI\SchedulerView();
$view->dateHeaderTemplate(new \Kendo\JavaScriptFunction('function() { }'));
?>

dayTemplate

The 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 or resources() - returns the relevant resources for the current slot..

Returns

\Kendo\UI\SchedulerView

Parameters

$value string|\Kendo\JavaScriptFunction

Example - using string

<?php
$view = new \Kendo\UI\SchedulerView();
$view->dayTemplate('value');
?>

Example - using \Kendo\JavaScriptFunction

<?php
$view = new \Kendo\UI\SchedulerView();
$view->dayTemplate(new \Kendo\JavaScriptFunction('function() { }'));
?>

editable

If 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.

Returns

\Kendo\UI\SchedulerView

Parameters

$value boolean|\Kendo\UI\SchedulerViewEditable|array

Example - using boolean

<?php
$view = new \Kendo\UI\SchedulerView();
$view->editable(true);
?>

Example - using \Kendo\UI\SchedulerViewEditable

<?php
$view = new \Kendo\UI\SchedulerView();
$editable = new \Kendo\UI\SchedulerViewEditable();
$create = true;
$editable->create($create);
$view->editable($editable);
?>

Example - using array

<?php
$view = new \Kendo\UI\SchedulerView();
$create = true;
$view->editable(array('create' => $create));
?>

endTime

The end time of the view. The scheduler will display events ending before the endTime.

Returns

\Kendo\UI\SchedulerView

Parameters

$value date

Example

<?php
$view = new \Kendo\UI\SchedulerView();
$view->endTime(new date());
?>

eventHeight

The 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.

Returns

\Kendo\UI\SchedulerView

Parameters

$value string|float

Example - using string

<?php
$view = new \Kendo\UI\SchedulerView();
$view->eventHeight('value');
?>

Example - using float

<?php
$view = new \Kendo\UI\SchedulerView();
$view->eventHeight(1);
?>

eventSpacing

Specifies the distance between individual events.

Returns

\Kendo\UI\SchedulerView

Parameters

$value float

Example

<?php
$view = new \Kendo\UI\SchedulerView();
$view->eventSpacing(1);
?>

eventTemplate

The 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 or title String - the event title.

Returns

\Kendo\UI\SchedulerView

Parameters

$value string|\Kendo\JavaScriptFunction

Example - using string

<?php
$view = new \Kendo\UI\SchedulerView();
$view->eventTemplate('value');
?>

Example - using \Kendo\JavaScriptFunction

<?php
$view = new \Kendo\UI\SchedulerView();
$view->eventTemplate(new \Kendo\JavaScriptFunction('function() { }'));
?>

eventTimeTemplate

The 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 or title String - the event title.

Returns

\Kendo\UI\SchedulerView

Parameters

$value string|\Kendo\JavaScriptFunction

Example - using string

<?php
$view = new \Kendo\UI\SchedulerView();
$view->eventTimeTemplate('value');
?>

Example - using \Kendo\JavaScriptFunction

<?php
$view = new \Kendo\UI\SchedulerView();
$view->eventTimeTemplate(new \Kendo\JavaScriptFunction('function() { }'));
?>

eventsPerDay

Indicates 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.

Returns

\Kendo\UI\SchedulerView

Parameters

$value float

Example

<?php
$view = new \Kendo\UI\SchedulerView();
$view->eventsPerDay(1);
?>

group

The configuration of the view resource(s) grouping.

Returns

\Kendo\UI\SchedulerView

Parameters

$value \Kendo\UI\SchedulerViewGroup|array

Example - using \Kendo\UI\SchedulerViewGroup

<?php
$view = new \Kendo\UI\SchedulerView();
$group = new \Kendo\UI\SchedulerViewGroup();
$date = true;
$group->date($date);
$view->group($group);
?>

Example - using array

<?php
$view = new \Kendo\UI\SchedulerView();
$date = true;
$view->group(array('date' => $date));
?>

majorTick

The number of minutes represented by a major tick.

Returns

\Kendo\UI\SchedulerView

Parameters

$value float

Example

<?php
$view = new \Kendo\UI\SchedulerView();
$view->majorTick(1);
?>

majorTimeHeaderTemplate

The 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..

Returns

\Kendo\UI\SchedulerView

Parameters

$value string|\Kendo\JavaScriptFunction

Example - using string

<?php
$view = new \Kendo\UI\SchedulerView();
$view->majorTimeHeaderTemplate('value');
?>

Example - using \Kendo\JavaScriptFunction

<?php
$view = new \Kendo\UI\SchedulerView();
$view->majorTimeHeaderTemplate(new \Kendo\JavaScriptFunction('function() { }'));
?>

minorTickCount

The number of time slots to display per major tick.

Returns

\Kendo\UI\SchedulerView

Parameters

$value float

Example

<?php
$view = new \Kendo\UI\SchedulerView();
$view->minorTickCount(1);
?>

minorTimeHeaderTemplate

The 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..

Returns

\Kendo\UI\SchedulerView

Parameters

$value string|\Kendo\JavaScriptFunction

Example - using string

<?php
$view = new \Kendo\UI\SchedulerView();
$view->minorTimeHeaderTemplate('value');
?>

Example - using \Kendo\JavaScriptFunction

<?php
$view = new \Kendo\UI\SchedulerView();
$view->minorTimeHeaderTemplate(new \Kendo\JavaScriptFunction('function() { }'));
?>

months

Configures the number of months that will be displayed in the year view calendar.

Returns

\Kendo\UI\SchedulerView

Parameters

$value float

Example

<?php
$view = new \Kendo\UI\SchedulerView();
$view->months(1);
?>

name

The name of the view. Typically, used to get the name of the currently selected view via the view method.

Returns

\Kendo\UI\SchedulerView

Parameters

$value string

Example

<?php
$view = new \Kendo\UI\SchedulerView();
$view->name('value');
?>

selected

If set to true the view will be initially selected by the scheduler widget.

Returns

\Kendo\UI\SchedulerView

Parameters

$value boolean

Example

<?php
$view = new \Kendo\UI\SchedulerView();
$view->selected(true);
?>

selectedDateFormat

The 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.

Returns

\Kendo\UI\SchedulerView

Parameters

$value string

Example

<?php
$view = new \Kendo\UI\SchedulerView();
$view->selectedDateFormat('value');
?>

selectedShortDateFormat

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.

Returns

\Kendo\UI\SchedulerView

Parameters

$value string

Example

<?php
$view = new \Kendo\UI\SchedulerView();
$view->selectedShortDateFormat('value');
?>

showWorkHours

If set to true the view will be initially shown in business hours mode. By default view is displayed in full day mode.

Returns

\Kendo\UI\SchedulerView

Parameters

$value boolean

Example

<?php
$view = new \Kendo\UI\SchedulerView();
$view->showWorkHours(true);
?>

slotTemplate

The 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. or resources() - returns the relevant resources for the current slot..

Returns

\Kendo\UI\SchedulerView

Parameters

$value string|\Kendo\JavaScriptFunction

Example - using string

<?php
$view = new \Kendo\UI\SchedulerView();
$view->slotTemplate('value');
?>

Example - using \Kendo\JavaScriptFunction

<?php
$view = new \Kendo\UI\SchedulerView();
$view->slotTemplate(new \Kendo\JavaScriptFunction('function() { }'));
?>

startDate

Configures the start date of the year view. The Scheduler will display 12 months starting from the startDate.

Returns

\Kendo\UI\SchedulerView

Parameters

$value date

Example

<?php
$view = new \Kendo\UI\SchedulerView();
$view->startDate(new date());
?>

startTime

The start time of the view. The scheduler will display events starting after the startTime.

Returns

\Kendo\UI\SchedulerView

Parameters

$value date

Example

<?php
$view = new \Kendo\UI\SchedulerView();
$view->startTime(new date());
?>

title

The user-friendly title of the view displayed by the scheduler.

Returns

\Kendo\UI\SchedulerView

Parameters

$value string

Example

<?php
$view = new \Kendo\UI\SchedulerView();
$view->title('value');
?>

tooltipTemplate

Configures the template used to render the Tooltip in the Scheduler year view.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 or messages Object - the configuration of the Scheduler messages used for localization..

Returns

\Kendo\UI\SchedulerView

Parameters

$value string|\Kendo\JavaScriptFunction

Example - using string

<?php
$view = new \Kendo\UI\SchedulerView();
$view->tooltipTemplate('value');
?>

Example - using \Kendo\JavaScriptFunction

<?php
$view = new \Kendo\UI\SchedulerView();
$view->tooltipTemplate(new \Kendo\JavaScriptFunction('function() { }'));
?>

type

The type of the view. The built-in views are: "day", "week", "workWeek", "month", "agenda", "timeline", "timelineWeek", "timelineWorkWeek", "timelineMonth" and "year".

Returns

\Kendo\UI\SchedulerView

Parameters

$value string

Example

<?php
$view = new \Kendo\UI\SchedulerView();
$view->type('value');
?>

virtual

Enables 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".

Returns

\Kendo\UI\SchedulerView

Parameters

$value boolean

Example

<?php
$view = new \Kendo\UI\SchedulerView();
$view->virtual(true);
?>

workDays

Sets the working days (index based).

Returns

\Kendo\UI\SchedulerView

Parameters

$value array

Example

<?php
$view = new \Kendo\UI\SchedulerView();
$view->workDays(array());
?>

workWeekEnd

The end of working week (index based).

Returns

\Kendo\UI\SchedulerView

Parameters

$value float

Example

<?php
$view = new \Kendo\UI\SchedulerView();
$view->workWeekEnd(1);
?>

workWeekStart

The start of working week (index based).

Returns

\Kendo\UI\SchedulerView

Parameters

$value float

Example

<?php
$view = new \Kendo\UI\SchedulerView();
$view->workWeekStart(1);
?>
In this article
Not finding the help you need?