Scheduler

The Scheduler is a widget that represents scheduled data and allows a user to manage and edit it.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
Module: ui/scheduler
Scheduler interactive configuration
Copy Code
Copy to Codepen
$("#scheduler").dxScheduler({
});

You can create the widget using one of the following approaches.

  • jQuery
    Use the dxScheduler jQuery plug-in.

    HTML
    <div id="scheduler">
    JavaScript
    $("#scheduler").dxScheduler({
        dataSource: schedulerDataSource
    });
  • Knockout
    Add a div element and apply the dxScheduler binding to this element.

    HTML
    <div data-bind="dxScheduler: {
        dataSource: schedulerDataSource
    }">
    </div>
  • AngularJS
    Add a div element and apply the dx-scheduler directive to this element.

    HTML
    <div dx-scheduler="{
        dataSource: schedulerDataSource
    }">
    </div>

Note that DevExtreme widgets require you to link the jQuery library to your application. If you use the Knockout or AngularJS approach, the Knockout or AngularJS library is also required. For detailed information on linking these libraries to your project, refer to the Installation article.

The dataSource option takes on an array of appointment objects, as well as the DataSource object that requests appointment data from the associated Store (local, OData or a custom one). The appointment objects loaded to the widget's data source may have a particular set of fields that allow the widget to use a default appointment template. In case of custom data source fields, you can define a custom template for displaying appointments.

See Also

Refer to the Scheduler UI Widgets guides for more information on working with the Scheduler widget.

View Demo

Watch Video

Show Example:
AngularJS
Knockout
jQuery

Configuration

An object defining configuration options for the widget.

Methods

This section describes methods used to manipulate the widget.

Events

This section describes events fired by this widget.

Default Appointment Template

This section lists the fields that are used in a default template for scheduler appointments.

By default, a predefined appointment template is applied to display scheduler appointments. This template is based on certain fields of the data source provided for the widget. Below is the list of these fields. If the default appointment template is not appropriate for your task, implement a custom appointment template based on these or other fields of your data source.

See Also

Default Tooltip Template

This section lists the fields that are used in a default template for scheduler appointment tooltips.

By default, a predefined appointment tooltip template is applied to display appointment toolips. This template is based on certain fields of the data source provided for the widget. Below is the list of these fields. If the default tooltip template is not appropriate for your task, implement a custom template based on these or other fields of your data source.

See Also