Configuration

An object defining configuration options for the widget.

accessKey

Specifies a shortcut key that sets focus on the widget element.

Type: String
Default Value: null

The accessKey option value is passed to the accesskey attribute of the actual HTML element of the widget.

allDayExpr

Specifies the name of the data source item field whose value defines whether or not the corresponding appointment is an all-day appointment.

Type: String
Default Value: 'allDay'

appointmentTemplate

The template to be used for rendering appointments.

Type: template
Function parameters:
itemData: Object
The appointment object to be rendered.
itemIndex: Number
The index of the appointment to be rendered.
itemElement: jQuery
An HTML element of the appointment to be rendered.
Return Value: String|DOM Node|jQuery
A template name or a template container.
Default Value: 'item'

A binding context of an appointment template is the data source object that corresponds to the currently rendered appointment.

So, in Knockout approach, you can bind template elements to the appointment object fields. To access another binding context within an appointment template, use Knockout binding variables.

In AngularJS approach, if you need to access appointment object fields within a template, use a variable whose name is assigned to the dx-item-alias directive. Add the directive to the widget element to specify an alias to the root object. Without this directive, appointment object fields are beyond reach. To access another binding context within an appointment template, use AngularJS binding variables.

AngularJS
HTML
<div dx-scheduler="{
    dataSource: schedulerData,
    currentDate: currentDate,
    appointmentTemplate: 'appointment',
}" dx-item-alias="appItem">
    <div data-options="dxTemplate: {name: 'appointment'}" style="padding: 0;">
        <div class="appointment-header">{{appItem.text}}</div>
        <div class="appointment-time">{{appItem.from}} - {{appItem.to}}</div>
    </div>
</div>

View Demo

See Also
Show Example:
AngularJS
Knockout
jQuery

appointmentTooltipTemplate

The template to be used for rendering an appointment tooltip.

Type: template
Function parameters:
appointmentData: Object
The appointment object whose tooltip should be rendered.
contentElement: jQuery
An HTML element of the appointment tooltip to be rendered.
Return Value: String|jQuery
A template name or a template container.
Default Value: 'appointmentTooltip'

A binding context of an appointment tooltip template is the data source object that corresponds to the currently rendered appointment.

So, in Knockout approach, you can bind template elements to the appointment object's fields directly. To access another binding context within an appointment tooltip template, use Knockout binding variables.

In AngularJS approach, if you need to access appointment object fields within a template, use a variable whose name is assigned to the dx-item-alias directive. Add the directive to the widget element to specify an alias to the root object. Without this directive, appointment object fields are beyond reach. To access another binding context within an appointment tooltip template, use AngularJS binding variables.

AngularJS
HTML
<div id="scheduler" dx-scheduler="options" dx-item-alias="showtime">
    <div data-options="dxTemplate: {name: 'tooltip-template'}">
        <div class='movie-tooltip' ng-init="movieData = getMovieById(showtime.movieId)">
            <img ng-src="{{movieData.image}}" />
            <div class='movie-info'>
                <div class='movie-title'>
                    {{movieData.text + ' (' + movieData.year + ')'}}
                </div> 
                <div>
                    {{'Director: ' + movieData.director}}
                </div>
                <div>
                    {{'Duration: ' + movieData.duration + ' minutes'}}
                </div>
            </div><br />
            <div dx-button = "{
                text: 'Edit details',
                onClick: 'editDetails(showtime)'
            }"></div>
        </div>
    </div>
</div>

View Demo

See Also

cellDuration

Specifies cell duration in minutes.

Type: Number
Default Value: 30

crossScrollingEnabled

Specifies whether or not an end-user can scroll the view in both directions at the same time.

Type: Boolean
Default Value: false

This option is useful when displaying Scheduler on narrow screens.

currentDate

Specifies a date displayed on the current scheduler view by default.

Default Value: new Date()

This is the date which is displayed when rendering the widget. Although, an end-user can change the current date by using the Date Navigator.

Show Example:
AngularJS
Knockout
jQuery

currentView

Specifies the view used in the scheduler by default.

Type: String
Default Value: 'day'
Accepted Values: 'day' | 'week' | 'workWeek' | 'month' | 'timelineDay' | 'timelineWeek' | 'timelineWorkWeek' | 'timelineMonth' | 'agenda'

Specify the views to be available in the scheduler's View Selector for end users in the views array. The default view used by the widget when rendering the scheduler is specified by the currentView option.
For more information on scheduler views, refer to the Views guide.

NOTE: When configuring the widget using ASP.NET MVC Wrappers, specify this option using the SchedulerViewType enum. This enum accepts the following values: Day, Week, WorkWeek, Month, TimelineDay, TimelineWeek, TimelineWorkWeek, TimelineMonth and Agenda.

Show Example:
AngularJS
Knockout
jQuery

dataCellTemplate

The template to be used for rendering table cells.

Type: template
Function parameters:
itemData: Object
The table cell object to be rendered.
itemIndex: Number
The index of the table cell to be rendered.
itemElement: jQuery
An HTML element of the table cell to be rendered.
Return Value: String|DOM Node|jQuery
A template name or a template container.
Default Value: null

A binding context of a cell template is the object that corresponds to the currently rendered table cell.

So, in the Knockout approach, you can bind template elements to the cell object fields. To access another binding context within a template, use Knockout binding variables.

In the AngularJS approach, if you need to access cell object fields within a template, use a variable whose name is assigned to the dx-item-alias directive. Add the directive to the widget element to specify an alias to the root object. Without this directive, cell object fields are beyond reach. To access another binding context within a table cell template, use Angular binding variables.

NOTE: There is no dataCellTemplate in the agenda view.

View Demo

See Also

dataSource

A data source used to fetch data to be displayed by the widget.

Default Value: null

This option accepts one of the following.

  • Array of objects
    A simple JavaScript array containing a collection of plain objects.

  • URL
    A URL to JSON data or to a service returning data in JSON format.

  • DataSource or its configuration object
    A DataSource is an object that provides a handy API for data processing. A DataSource is a stateful object, which means that it saves data processing settings and applies them each time data is loaded. All underlying data access logic of a DataSource is isolated in a Store. A Store provides an API for reading and modifying data. Unlike the DataSource, a Store is a stateless object.

If you access a data source containing Scheduler appointments using a CustomStore, the function passed to the load option should support the Scheduler field in addition to a standard field set of the argument object. This field holds an object containing the following fields.

  • startDate
    Specifies the start date of a range of appointments to be loaded.

  • endDate
    Specifies the end date of a range of appointments to be loaded.

  • resources
    Specifies resources used to filter the appointments to be loaded.

JavaScript
var schedulerInstance = $("#schedulerContainer").dxScheduler("instance");

var myDataSource = new data.DataSource({
    store: new data.CustomStore({
        load: function(options) {
            var result = $.Deferred();
            $.ajax({
                url: "/data/appointments",
                data: {
                    start: schedulerInstance.getStartViewDate().getTime(),
                    end: schedulerInstance.getEndViewDate().getTime(),
                    ownerid: schedulerInstance.option("resources")
                }
            }).done(function(response){
                result.resolve(response);
            });
            return result.promise();
        }
    })
});

NOTE: Filtering by date range and resources should also be implemented on the server.

NOTE: If you use mapping for your data, its filtering becomes unavailable.

You can assign an array directly to this option as well as use the Data Source object provided by the DevExtreme library.

To display appointments, a default template can be used. This template is based on the data source fields that are listed in the Default Item Template section of the widget's API. Alternatively, you can implement a custom item template.

View Demo

Show Example:
AngularJS
Knockout
jQuery

dateCellTemplate

The template to be used for rendering date scale items.

Type: template
Function parameters:
itemData: Object
The currently rendered object that represents a date scale item.
itemIndex: Number
The index of the date scale item to be rendered.
itemElement: jQuery
An HTML element of the date scale item to be rendered.
Return Value: String|DOM Node|jQuery
A template name or a template container.
Default Value: null

A binding context of a date template is the object that corresponds to the currently rendered item of the date scale.

So, in the Knockout approach, you can bind template elements to the date scale item fields. To access another binding context within a template, use Knockout binding variables.

In the AngularJS approach, if you need to access date scale item fields within a template, use a variable whose name is assigned to the dx-item-alias directive. Add the directive to the widget element to specify an alias to the root object. Without this directive, object fields are beyond reach. To access another binding context within a date scale template, use Angular binding variables.

AngularJS Approach
HTML
<div dx-scheduler="{
    dataSource: schedulerData,
    currentDate: currentDate,
    dateCellTemplate: 'dateTemplate',
}" dx-item-alias="item">
    <div data-options="dxTemplate: {name: 'dateTemplate'}">
        <div class="date">{{ item.text }}</div>
    </div>
</div>

NOTE: There is no dateCellTemplate in such views as 'day' and 'timelineDay'.

See Also

descriptionExpr

Specifies the name of the data source item field whose value holds the description of the corresponding appointment.

Type: String
Default Value: 'description'

disabled

A Boolean value specifying whether or not the widget can respond to user interaction.

Type: Boolean
Default Value: false

Create an observable variable and assign it to this option to specify the availability of the widget at runtime.

editing

Specifies which editing operations an end-user can perform on appointments.

Type: Boolean|Object
Default Value: true

elementAttr

Specifies the attributes to be attached to the widget's root element.

Type: Object
Default Value: {}

When you configure this option using a server-side wrapper, pass a dictionary as shown in the following code.

@(Html.DevExtreme()
    // other widget options
    // ...
    .ElementAttr(new Dictionary<string, object>() {
        { "id", "elementId" },
        { "class", "class-name" },
        // ...
    })
)

endDateExpr

Specifies the name of the data source item field that defines the ending of an appointment.

Type: String
Default Value: 'endDate'

endDateTimeZoneExpr

Specifies the name of the data source item field that defines the timezone of the appointment end date.

Type: String
Default Value: 'endDateTimeZone'

endDayHour

Specifies an end hour in the scheduler view's time interval.

Type: Number
Default Value: 24

firstDayOfWeek

Specifies the first day of a week.

Type: Number
Default Value: undefined
Accepted Values: 0 | 1 | 2 | 3 | 4 | 5 | 6

This option can take on a value from 0 to 6.

  • 0 - Sunday
  • 1 - Monday
  • 2 - Tuesday
  • 3 - Wednesday
  • 4 - Thursday
  • 5 - Friday
  • 6 - Saturday

By default, the value provided by the culture settings is used.

NOTE: When configuring the widget using ASP.NET MVC Wrappers, specify this option using the FirstDayOfWeek enum. This enum accepts the following values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday and Saturday.

focusStateEnabled

Specifies whether or not the widget can be focused.

Type: Boolean
Default Value: false
Default for generic: true

groups

Specifies the resource kinds by which the scheduler's appointments are grouped in a timetable.

Type: Array
Default Value: []

The array elements should be strings specifying the field field of the resource kind objects.

JavaScript
var resources = [
    { field: 'room', dataSource: roomsDataSource },
    { field: 'teacher', dataSource: teachersDataSource }
];
var schedulerOptions = {
    dataSource: appointments,
    resources: resources,
    groups: ['room', 'teacher']
    //...
}

To group appointments by resources of one kind, for instance to group appointments that use particular rooms in an office, assign an array with a single element to the groups option. To group appointments by several resource kinds, assign an array of elements. Each element will represent a resource by which appointments will be grouped. Each resource will be nested to the resource represented by the previous element in the groups array.

View Demo

Show Example:
AngularJS
Knockout
jQuery

height

Specifies the height of the widget.

Type: Number|String| function
Return Value: Number|String
The widget height.
Default Value: undefined

The option can hold a value of the following types.

  • number
    The height of the widget in pixels

  • string
    A CSS measurement of the widget height (e.g., "55px", "80%", "auto" and "inherit")

  • function
    A function returning the widget height, e.g.,

    JavaScript
    height: function () {
        return baseHeight - 10 + "%";
    }

hint

Specifies the text of the hint displayed for the widget.

Type: String
Default Value: undefined

horizontalScrollingEnabled

Deprecated

Use the crossScrollingEnabled option instead.

max

The latest date the widget allows you to select.

Type: Date
Default Value: undefined

min

The earliest date the widget allows you to select.

Type: Date
Default Value: undefined

noDataText

The text or HTML markup displayed by the widget if the item collection is empty. Available for the Agenda view only.

Type: String
Default Value: 'No data to display'

Show Example:
AngularJS
Knockout
jQuery

onAppointmentAdded

A handler for the appointmentAdded event.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
appointmentData: Object
The appointment object added to the data source.
The standard Error object that defines the occurred error.
Default Value: null

Assign a function to perform a custom action after an appointment has been added to the widget's data source.

onAppointmentAdding

A handler for the appointmentAdding event.

Type: function
Function parameters:
e: Object
Information about the event.
Object structure:
component: Object
The widget instance.
element: jQuery
The widget's container.
model: Object
Data that is available for binding against the element. Available only in the Knockout approach.
appointmentData: Object
The appointment object to be added to the data source.
A flag allowing you to prevent the appointment from being added. This field accepts a Boolean value or Promise. If you pass Promise to this field, appointment adding is continued or canceled once Promise has been resolved.
Default Value: null

Assign a function to perform a custom action before an appointment is added to the widget's data source.

Show Example:
AngularJS
Knockout
jQuery

onAppointmentClick

A handler for the appointmentClick event.

Type: function |String
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
appointmentData: Object
The object associated with the initial appointment.
targetedAppointmentData: Object
The object associated with the clicked appointment.
appointmentElement: jQuery
An HTML element of the clicked appointment.
jQueryEvent: jQuery.Event
Specifies the jQuery event that caused action execution.
cancel: Boolean
Indicates whether or not to cancel execution of the default appointment click handler.
Default Value: null

In case of recurring appointments or appointments with multiple resources, you may want to obtain information about the currently selected appointment, not the initial appointment. For this purpose, use the targetedAppointmentData field of the function parameter. Otherwise, use the appointmentData field.

For example, there is a recurring appointment that starts on July 18 at 8:00 AM, repeats every day and belongs to two owners:

JavaScript
var appointments = [
    ...
    {
        startDate: new Date(2016, 6, 18, 8),
        endDate: new Date(2016, 6, 18, 9),
        ownerId: [1, 2],
        recurrenceRule: "FREQ=DAILY"
    }
];

If you click an appointment from the recurring series, for example the second appointment belonging to the second owner, the following information is presented in the appointmentData and targetedAppointmentData fields.

JavaScript
onAppointmentClick: function(e) {
    /* The initial appointment data
        {
            startDate: new Date(2016, 6, 18, 8), 
            endDate: new Date(2016, 6, 18, 9),
            ownerId: [1, 2],
            recurrenceRule: "FREQ=DAILY"
        }
    */
    var appointmentData = e.appointmentData;

    /* The clicked appointment data
        {
            startDate: new Date(2016, 6, 19, 8), 
            endDate: new Date(2016, 6, 19, 9),
            ownerId: 2,
            recurrenceRule: "FREQ=DAILY"
        }
    */
    var targetedAppointmentData = e.targetedAppointmentData;
}

Assign a function to perform a custom action after an appointment has been clicked.

onAppointmentDblClick

A handler for the appointmentDblClick event.

Type: function |String
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
appointmentData: Object
The object associated with the initial appointment.
targetedAppointmentData: Object
The object associated with the clicked appointment.
appointmentElement: jQuery
An HTML element of the clicked appointment.
jQueryEvent: jQuery.Event
Specifies the jQuery event that caused action execution.
cancel: Boolean
Indicates whether or not to cancel execution of the default appointment double click handler.
Default Value: null

In case of recurring appointments or appointments with multiple resources, you may want to obtain information about the currently selected appointment, not the initial appointment. For this purpose, use the targetedAppointmentData field of the function parameter. Otherwise, use the appointmentData field.

For example, there is a recurring appointment that starts on July 18 at 8:00 AM, repeats every day and belongs to two owners:

JavaScript
var appointments = [
    ...
    {
        startDate: new Date(2016, 6, 18, 8),
        endDate: new Date(2016, 6, 18, 9),
        ownerId: [1, 2],
        recurrenceRule: "FREQ=DAILY"
    }
];

If you double-click an appointment from the recurring series, for example the second appointment belonging to the second owner, the following information is presented in the appointmentData and targetedAppointmentData fields.

JavaScript
onAppointmentDblClick: function(e) {
    /* The initial appointment data
        {
            startDate: new Date(2016, 6, 18, 8), 
            endDate: new Date(2016, 6, 18, 9),
            ownerId: [1, 2],
            recurrenceRule: "FREQ=DAILY"
        }
    */
    var appointmentData = e.appointmentData;

    /* The clicked appointment data
        {
            startDate: new Date(2016, 6, 19, 8), 
            endDate: new Date(2016, 6, 19, 9),
            ownerId: 2,
            recurrenceRule: "FREQ=DAILY"
        }
    */
    var targetedAppointmentData = e.targetedAppointmentData;
}

Assign a function to perform a custom action after an appointment has been double clicked.

onAppointmentDeleted

A handler for the appointmentDeleted event.

Type: function
Function parameters:
e: Object
Information about the event.
Object structure:
component: Object
The widget instance.
element: jQuery
The widget's container.
model: Object
Data that is available for binding against the element. Available only in the Knockout approach.
appointmentData: Object
The appointment object deleted from the data source.
The standard Error object that defines the occurred error.
Default Value: null

Assign a function to perform a custom action after an appointment has been deleted from the widget's data source.

onAppointmentDeleting

A handler for the appointmentDeleting event.

Type: function
Function parameters:
e: Object
Information about the event.
Object structure:
component: Object
The widget instance.
element: jQuery
The widget's container.
model: Object
Data that is available for binding against the element. Available only in the Knockout approach.
appointmentData: Object
The appointment object to be deleted from the data source.
A flag that allows you to prevent an appointment from being deleted. This field accepts a Boolean value or Promise. If you pass Promise to this field, appointment deleting is continued or canceled once Promise has been resolved.
Default Value: null

Assign a function to perform a custom action before an appointment is deleted from the widget's data source.

Show Example:
AngularJS
Knockout
jQuery

onAppointmentFormCreated

A handler for the appointmentFormCreated event.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
appointmentData: Object
The object associated with the appointment for which a form is created.
form: Object
An instance of the Form widget used to edit the appointment details.
Default Value: null

Assign a function to perform a custom action after an edit form has been created for an appointment.

View Demo Watch Video

onAppointmentRendered

A handler for the appointmentRendered event.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
The widget instance.
element: jQuery
The widget's container.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
appointmentData: Object
The data that is bound to the initial appointment.
targetedAppointmentData: Object
The data that is bound to the appointment to be rendered.
appointmentElement: jQuery
An HTML element of the appointment.
Default Value: null

In case of recurring appointments or appointments with multiple resources, you may want to obtain information about the appointment to be rendered, not the initial appointment. For this purpose, use the targetedAppointmentData field of the function parameter. Otherwise, use the appointmentData field.

For example, there is a recurring appointment that starts on July 18 at 8:00 AM, repeats every day and belongs to two owners:

JavaScript
var appointments = [
    ...
    {
        startDate: new Date(2016, 6, 18, 8),
        endDate: new Date(2016, 6, 18, 9),
        ownerId: [1, 2],
        recurrenceRule: "FREQ=DAILY"
    }
];

After the appointments from recurring series is rendered, for example the second appointment belonging to the second owner, the following information is presented in the appointmentData and targetedAppointmentData fields.

JavaScript
onAppointmentRendered: function(e) {
    /* The initial appointment data
        {
            startDate: new Date(2016, 6, 18, 8), 
            endDate: new Date(2016, 6, 18, 9),
            ownerId: [1, 2],
            recurrenceRule: "FREQ=DAILY"
        }
    */
    var appointmentData = e.appointmentData;

    /* The clicked appointment data
        {
            startDate: new Date(2016, 6, 19, 8), 
            endDate: new Date(2016, 6, 19, 9),
            ownerId: 2,
            recurrenceRule: "FREQ=DAILY"
        }
    */
    var targetedAppointmentData = e.targetedAppointmentData;
}

Assign a function to perform a custom action after an appointment is rendered.

onAppointmentUpdated

A handler for the appointmentUpdated event.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
appointmentData: Object
The appointment object updated in the data source.
The standard Error object that defines the occurred error.
Default Value: null

Assign a function to perform a custom action after an appointment has been updated in the widget's data source.

onAppointmentUpdating

A handler for the appointmentUpdating event.

Type: function
Function parameters:
e: Object
Information about the event.
Object structure:
component: Object
The widget instance.
element: jQuery
The widget's container.
model: Object
Data that is available for binding against the element. Available only in the Knockout approach.
oldData: Object
The appointment object to be updated in the data source.
newData: Object
The appointment object containing new values for the specified appointment.
A flag that allows you to prevent an appointment from being updated. This field accepts a Boolean value or Promise. If you pass Promise to this field, the appointment updating is continued or canceled once Promise has been resolved.
Default Value: null

Assign a function to perform a custom action before an appointment is updated in the widget's data source.

Show Example:
AngularJS
Knockout
jQuery

onCellClick

A handler for the cellClick event.

Type: function |String
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
cellData: Object
An object associated with the clicked cell.
cellElement: jQuery
An HTML element of the clicked cell.
jQueryEvent: jQuery.Event
Specifies the jQuery event that caused action execution.
cancel: Boolean
Indicates whether or not to cancel execution of the default cell click handler.
Default Value: null

Assign a function to perform a custom action after a view cell has been clicked.

onContentReady

A handler for the contentReady event.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
Default Value: null

If data displayed by the widget is specified using a DataSource instance, the contentReady event fires each time the load() method of the DataSource instance is called, as well as when the widget content is ready or an appointment is modified.

onDisposing

A handler for the disposing event.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
Default Value: null

Assign a function to perform a custom action when the widget is being removed.

NOTE: The function assigned to this option is executed only if the widget is removed using the remove(), empty(), or html() jQuery methods.

onInitialized

A handler for the initialized event.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
Default Value: null

Assign a function to perform a custom action when the widget is initialized.

onOptionChanged

A handler for the optionChanged event.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
name: String
Specifies the name of the option whose value is changed.
fullName: String
Specifies a full name of the option whose value is changed. The full name is formed by concatenating the names of the options that are presented in the hierarchy of the given option. The names are delimited by commas.
value: any
Specifies a new value for the option.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
Default Value: null

Assign a function to perform a custom action after an option of the component is changed.

recurrenceEditMode

Specifies the edit mode for recurring appointments.

Type: String
Default Value: 'dialog'
Accepted Values: 'dialog' | 'series' | 'occurrence'

This option accepts the following values.

  • 'dialog'
    Displays a dialog that suggests to a user to choose between editing the entire series or only the current appointment.

  • 'series'
    Enables an end-user to edit only the entire appointment series.

  • 'occurrence'
    Enables an end-user to edit only the current appointment.

NOTE: When configuring the widget using ASP.NET MVC Wrappers, specify this option using the SchedulerRecurrenceEditMode enum. This enum accepts the following values: Dialog, Series and Occurrence.

recurrenceExceptionExpr

Specifies the name of the data source item field that defines exceptions for the current recurring appointment.

Type: String
Default Value: 'recurrenceException'

recurrenceRuleExpr

Specifies the name of the data source item field that defines a recurrence rule for generating recurring appointments.

Type: String
Default Value: 'recurrenceRule'

If the option value is null, the widget does not support recurring appointments. It displays only initial appointments without generating appointment series.

remoteFiltering

Specifies whether filtering is performed on the server or client side.

Type: Boolean
Default Value: false

NOTE: If you use the CustomStore as a data source and the remoteFiltering option is set to false, the parameter of the load method does not contain the filter field.

resourceCellTemplate

The template to be used for rendering resource headers.

Type: template
Function parameters:
itemData: Object
The resource header object to be rendered.
itemIndex: Number
The index of the resource header to be rendered.
itemElement: jQuery
An HTML element of the resource header to be rendered.
Return Value: String|DOM Node|jQuery
A template name or a template container.
Default Value: null

A binding context of a resource template is the data source object that corresponds to the currently rendered resource header.

So, in the Knockout approach, you can bind template elements to the resource object fields. To access another binding context within a resource template, use Knockout binding variables.

In the AngularJS approach, if you need to access resource object fields within a template, use a variable whose name is assigned to the dx-item-alias directive. Add the directive to the widget element to specify an alias to the root object. Without this directive, resource object fields are beyond reach. To access another binding context within a resource template, use Angular binding variables.

AngularJS Approach
HTML
<div dx-scheduler="options" dx-item-alias="item">
    <div data-options="dxTemplate: {name: 'resource'}">
        <img src="{{ item.image }}">
        <div class="resource-header">{{ item.text }}</div>
    </div>
</div>
JavaScript
var appointements = [
    {
        text: "Website Re-Design Plan",
        priorityId: 2,
        startDate: new Date(2015, 4, 25, 9, 0),
        endDate: new Date(2015, 4, 25, 11, 30)
    }, // . . .
];

var priorityData = [
    {
        text: "Low Priority",
        image: "img1.png",
        id: 1,
        color: "#1e90ff"
    }, {
        text: "High Priority",
        image: "img2.png",
        id: 2,
        color: "#ff9747"
    }
];

var DemoApp = angular.module('DemoApp', ['dx']);
DemoApp.controller('DemoController', function DemoController($scope) {
    $scope.options = {
        dataSource: appointements,
        currentDate: new Date(2015, 4, 25),
        groups: ["priorityId"],
        resources: [
            { 
                 field: "priorityId", 
                 allowMultiple: false, 
                 dataSource: priorityData,
                 label: "Priority"
            }
        ],
        resourceCellTemplate: 'resource'
    };
});

View Demo

See Also

resources[]

Specifies an array of resources available in the scheduler.

Type: Array
Default Value: []

Each element of this array is an object that defines a resource kind - a room, a car or any other resource kind. A resource kind object must have at least the following fields.

There are more fields that can be specified within a resource kind object. They are listed below. For details on how to define a resource and assign it to scheduler appointments, refer to the Resources article.

View Demo

See Also

rtlEnabled

Specifies whether or not the current component supports a right-to-left representation.

Type: Boolean
Default Value: false

If you need to switch the display of this DevExtreme component to right-to-left, enable a specifically designed configuration option - rtlEnabled. When this option is set to true, the text flows from right to left, and the layout the component's elements is reversed. To switch the entire application/site to a right-to-left representation, use the static DevExpress.rtlEnabled field.

showAllDayPanel

Specifies whether or not the "All-day" panel is visible.

Type: Boolean
Default Value: true

startDateExpr

Specifies the name of the data source item field that defines the start of an appointment.

Type: String
Default Value: 'startDate'

startDateTimeZoneExpr

Specifies the name of the data source item field that defines the timezone of the appointment start date.

Type: String
Default Value: 'startDateTimeZone'

startDayHour

Specifies a start hour in the scheduler view's time interval.

Type: Number
Default Value: 0

tabIndex

Specifies the widget tab index.

Type: Number
Default Value: 0

textExpr

Specifies the name of the data source item field that holds the subject of an appointment.

Type: String
Default Value: 'text'

timeCellTemplate

The template to be used for rendering time scale items.

Type: template
Function parameters:
itemData: Object
The currently rendered object that represents a time scale item.
itemIndex: Number
The index of the time scale item to be rendered.
itemElement: jQuery
An HTML element of the time scale item to be rendered.
Return Value: String|DOM Node|jQuery
A template name or a template container.
Default Value: null

A binding context of a time template is the object that corresponds to the currently rendered item of the time scale.

So, in the Knockout approach, you can bind template elements to the time scale item fields. To access another binding context within a template, use Knockout binding variables.

In the AngularJS approach, if you need to access time scale item fields within a template, use a variable whose name is assigned to the dx-item-alias directive. Add the directive to the widget element to specify an alias to the root object. Without this directive, time scale item fields are beyond reach. To access another binding context within a time scale template, use Angular binding variables.

AngularJS Approach
HTML
<div dx-scheduler="{
    dataSource: schedulerData,
    currentDate: currentDate,
    timeCellTemplate: 'timeTemplate'
}" dx-item-alias="item">
    <div data-options="dxTemplate: {name: 'timeTemplate'}">
        <div class="time">{{ item.text }}</div>
    </div>
</div>

NOTE: There is no timeCellTemplate in such views as 'month', 'timelineMonth' and 'agenda'.

See Also

timeZone

Specifies the timezone of the widget.

Type: String
Default Value: ''

By default, the scheduler displays appointments in the current timezone. To define the timezone, specify the timeZone option.

The list of supported timezones is available in the list of IANA time zones.

View Demo

useDropDownViewSwitcher

Specifies whether a user can switch views using tabs or a drop-down menu.

Type: Boolean
Default Value: false
Default for mobile: true

Using a drop-down menu makes the view switcher more compact.

views[]

Configures individual views.

Type: Array
Default Value: ['day', 'week']
Accepted Values: 'day' | 'week' | 'workWeek' | 'month' | 'timelineDay' | 'timelineWeek' | 'timelineWorkWeek' | 'timelineMonth' | 'agenda'

The option accepts an array of views to be available within the scheduler View Selector. If you need to customize a view, add a configuration object for it to the array. The configuration options that you can specify are listed further in this documentation section. If a view does not need individual customization, just add its type to the array.

JavaScript
var schedulerOptions = {
    // . . .
    dataSource: schedulerData,
    startDayHour: 9,
    endDayHour: 18,
    views: [
        { type: "day", startDayHour: 7, endDayHour: 22 },
        { type: "workWeek", cellDuration: 60 },
        "week",
        "agenda"
    ]
};

Set a default view by using the currentView option.
For more information on scheduler views, refer to the Views guide.

NOTE: When configuring the widget using ASP.NET MVC Wrappers, specify this option using the SchedulerViewType enum. This enum accepts the following values: Day, Week, WorkWeek, Month, TimelineDay, TimelineWeek, TimelineWorkWeek, TimelineMonth and Agenda.

View Demo Watch Video

Show Example:
AngularJS
Knockout
jQuery

visible

A Boolean value specifying whether or not the widget is visible.

Type: Boolean
Default Value: true

width

Specifies the width of the widget.

Type: Number|String| function
Return Value: Number|String
The widget width.
Default Value: undefined

The option can hold a value of the following types.

  • numeric
    The widget width in pixels.
  • string
    A CSS measurement of the widget width (e.g., "55px", "80%", "auto" and "inherit").
  • function
    The function returning the widget width. For example, see the following code.

    JavaScript
    width: function () { 
        return baseWidth - 10 + "%";
    }