All docs
V19.1
24.1
The page you are viewing does not exist in version 24.1.
23.2
The page you are viewing does not exist in version 23.2.
23.1
The page you are viewing does not exist in version 23.1.
22.2
The page you are viewing does not exist in version 22.2.
22.1
The page you are viewing does not exist in version 22.1.
21.2
The page you are viewing does not exist in version 21.2.
21.1
The page you are viewing does not exist in version 21.1.
20.2
The page you are viewing does not exist in version 20.2.
20.1
The page you are viewing does not exist in version 20.1.
19.2
19.1
18.2
18.1
17.2
Box
Map
Vue
A newer version of this page is available. Switch to the current version.

jQuery Scheduler Methods

This section describes methods used to manipulate the widget.

See Also

addAppointment(appointment)

Adds an appointment.

Parameters:
appointment:

Object

The appointment; should have the same structure as objects in the dataSource.

beginUpdate()

Prevents the widget from refreshing until the endUpdate() method is called.

The beginUpdate() and endUpdate() methods prevent the widget from excessive updates when you are changing multiple widget settings at once. After the beginUpdate() method is called, the widget does not update its UI until the endUpdate() method is called.

See Also

defaultOptions(rule)

Specifies the device-dependent default configuration options for this component.

Parameters:
rule:

Object

The component's default device options.

Object structure:
Name Type Description
device

Device

|

Array<Device>

|

Function

Device parameters.
When specifying a function, get information about the current device from the argument. Return true if the options should be applied to the device.

options

Object

Options to be applied.

defaultOptions is a static method that the widget class supports. The following code demonstrates how to specify default options for all instances of the Scheduler widget in an application executed on the desktop.

jQuery
JavaScript
DevExpress.ui.dxScheduler.defaultOptions({ 
    device: { deviceType: "desktop" },
    options: {
        // Here go the Scheduler options
    }
});
Angular
TypeScript
import Scheduler from "devextreme/ui/scheduler";
// ...
export class AppComponent {
    constructor () {
        Scheduler.defaultOptions({
            device: { deviceType: "desktop" },
            options: {
                // Here go the Scheduler options
            }
        });
    }
}
Vue
<template>
    <div>
        <DxScheduler id="scheduler1" />
        <DxScheduler id="scheduler2" />
    </div>
</template>
<script>
import DxScheduler from "devextreme-vue/scheduler";
import Scheduler from "devextreme/ui/scheduler";

Scheduler.defaultOptions({
    device: { deviceType: "desktop" },
    options: {
        // Here go the Scheduler options
    }
});

export default {
    components: {
        DxScheduler
    }
}
</script>
React
import React from "react";
import dxScheduler from "devextreme/ui/scheduler";
import Scheduler from "devextreme-react/scheduler";

class App extends React.Component {
    render () {
        dxScheduler.defaultOptions({
            device: { deviceType: "desktop" },
            options: {
                // Here go the Scheduler options
            }
        })
        return (
            <div>
                <Scheduler id="scheduler1" />
                <Scheduler id="scheduler2" />
            </div>
        )
    }
}

export default App;

deleteAppointment(appointment)

Deletes an appointment from the timetable and its object from the data source.

Parameters:
appointment:

Object

An appointment object from the dataSource.

If you delete a recurring appointment from the data source, all its occurrences are also deleted from the timetable:

jQuery
JavaScript
$(function() {
    var appointments = [{
        text: "Website Re-Design Plan",
        startDate: new Date(2018, 4, 25, 9, 00),
        endDate: new Date(2018, 4, 25, 9, 30),
        recurrenceRule: "FREQ=DAILY;COUNT=10"
    }, 
    // ...
    ];

    var scheduler = $("#schedulerContainer").dxScheduler({
        dataSource: appointments,
        currentDate: new Date(2018, 4, 25)
    }).dxScheduler("instance");

    $("#deleteButton").dxButton({
        text: "Delete",
        onClick: function () {
            scheduler.deleteAppointment(appointments[0]);
        }
    });
});
Angular
app.component.html
app.component.ts
app.service.ts
app.module.ts
<dx-button
    text="Delete"
    (onClick)="deleteAppointment()">
</dx-button>
<dx-scheduler
    [(dataSource)]="appointments"
    [currentDate]="currentDate">
</dx-scheduler>
import { Component, ViewChild } from "@angular/core";
import { Appointment, Service } from './app.service';
import { DxSchedulerComponent } from "devextreme-angular";
@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent  {
    @ViewChild(DxSchedulerComponent, { static: false }) scheduler: DxSchedulerComponent;
    // Prior to Angular 8
    // @ViewChild(DxSchedulerComponent) scheduler: DxSchedulerComponent;
    currentDate: Date = new Date(2018, 4, 25);
    appointments: Appointment[];

    constructor(service: Service) {
        this.appointments = service.getAppointments();
    }

    deleteAppointment() {
        this.scheduler.instance.deleteAppointment(this.appointments[0]);
    }
}
import { Injectable } from "@angular/core";

export class Appointment {
    text: string;
    startDate: Date;
    endDate: Date;
    recurrenceRule?: string;
}

let appointments: Appointment[] = [{
    text: "Website Re-Design Plan",
    startDate: new Date(2018, 4, 25, 9, 0),
    endDate: new Date(2018, 4, 25, 9, 30),
    recurrenceRule: "FREQ=DAILY;COUNT=10"
}, 
// ...
];

@Injectable()
export class Service {
    getAppointments(): Appointment[] {
        return appointments;
    }
}
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

import { 
    DxButtonModule, 
    DxSchedulerModule
} from "devextreme-angular";

import { Service } from './app.service';

@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxButtonModule,
        DxSchedulerModule
    ],
    providers: [
        Service
    ],
    bootstrap: [AppComponent]
})
export class AppModule { }
Vue
App.vue
data.js
<template>
    <div>
        <DxButton 
            text="Delete" 
            @click="deleteAppointment" />
        <DxScheduler :ref="schedulerRef"
            :data-source="dataSource"
            :current-date="currentDate" />
    </div>
</template>
<script>
import 'devextreme/dist/css/dx.common.css';
import 'devextreme/dist/css/dx.light.css';

import DxScheduler from 'devextreme-vue/scheduler';
import DxButton from 'devextreme-vue/button';
import { appointments } from './data.js';

const schedulerRef = "scheduler";

export default {
    components: {
        DxScheduler,
        DxButton
    },
    data() {
        return {
            schedulerRef,
            currentDate: new Date(2018, 4, 25),
            dataSource: appointments
        };
    },
    methods: {
        deleteAppointment() {
            this.scheduler.deleteAppointment(appointments[0]);
        } 
    },
    computed: {
        scheduler: function() {
            return this.$refs[schedulerRef].instance;
        }
    }
};
</script>
export const appointments = [{
    text: "Website Re-Design Plan",
    startDate: new Date(2018, 4, 25, 9, 0),
    endDate: new Date(2018, 4, 25, 9, 30),
    recurrenceRule: "FREQ=DAILY;COUNT=10"
}, 
// ...
];
React
App.js
data.js
import React from 'react';
import 'devextreme/dist/css/dx.common.css';
import 'devextreme/dist/css/dx.light.css';
import Scheduler from 'devextreme-react/scheduler';
import Button from 'devextreme-react/button';
import { appointments } from './data.js';

const currentDate = new Date(2018, 4, 25);

class App extends React.Component {
    constructor(props) {
        super(props);

        this.schedulerRef = React.createRef();

        this.deleteAppointment = () => {
            this.scheduler.deleteAppointment(appointments[0]);
        }
    }

    get scheduler() {
        return this.schedulerRef.current.instance;
    }

    render() {
        return (
            <div>
                <Button text="Delete" onClick={this.deleteAppointment} />
                <Scheduler ref={this.schedulerRef}
                    dataSource={appointments}
                    defaultCurrentDate={currentDate} />
            </div>
        );
    }
}
export default App;
export const appointments = [{
    text: "Website Re-Design Plan",
    startDate: new Date(2018, 4, 25, 9, 0),
    endDate: new Date(2018, 4, 25, 9, 30),
    recurrenceRule: "FREQ=DAILY;COUNT=10"
}, 
// ...
];
See Also

dispose()

Disposes of all the resources allocated to the Scheduler instance.

After calling this method, remove the DOM element associated with the widget:

jQuery
JavaScript
$("#myScheduler").dxScheduler("dispose");
$("#myScheduler").remove();
Angular
HTML
<dx-scheduler #schedulerVar id="myScheduler"></dx-scheduler>
TypeScript
import { ..., ViewChild } from "@angular/core";
import { DxSchedulerComponent } from "devextreme-angular";
// ...
export class AppComponent {
    @ViewChild("schedulerVar", { static: false }) scheduler: DxSchedulerComponent;
    // Prior to Angular 8
    // @ViewChild("schedulerVar") scheduler: DxSchedulerComponent;

    removeScheduler (e) {
        this.scheduler.instance.dispose();
        document.getElementById("myScheduler").remove();
    }
}

element()

Gets the root widget element.

Return Value:

HTMLElement | jQuery

An HTML element or a jQuery element when you use jQuery.

See Also

endUpdate()

Refreshes the widget after a call of the beginUpdate() method.

Main article: beginUpdate()

See Also

focus()

Sets focus on the widget.

See Also

getDataSource()

Gets the DataSource instance.

Return Value:

DataSource

The DataSource instance.

NOTE
This method returns the DataSource instance even if the widget's dataSource option was given a simple array.
See Also

getEndViewDate()

Gets the current view's end date.

Return Value:

Date

The view's end date.

See Also

getInstance(element)

Gets the instance of a widget found using its DOM node.

Parameters:
element:

DOM Node

|

jQuery

The widget's container.

Return Value:

Object

The widget's instance.

getInstance is a static method that the widget class supports. The following code demonstrates how to get the Scheduler instance found in an element with the myScheduler ID:

// Modular approach
import Scheduler from "devextreme/ui/scheduler";
...
let element = document.getElementById("myScheduler");
let instance = Scheduler.getInstance(element) as Scheduler;

// Non-modular approach
let element = document.getElementById("myScheduler");
let instance = DevExpress.ui.dxScheduler.getInstance(element);
See Also

getStartViewDate()

Gets the current view's start date.

Return Value:

Date

The view's start date.

See Also

hideAppointmentPopup(saveChanges)

Hides an appointment details form.

Parameters:
saveChanges:

Boolean

| undefined

Specifies whether to save changes.

See Also

hideAppointmentTooltip()

Hides an appointment tooltip.

See Also

instance()

Gets the widget's instance. Use it to access other methods of the widget.

Return Value:

Scheduler

This widget's instance.

See Also

off(eventName)

Detaches all event handlers from a single event.

Parameters:
eventName:

String

The event's name.

Return Value:

Scheduler

The object for which this method is called.

See Also

off(eventName, eventHandler)

Detaches a particular event handler from a single event.

Parameters:
eventName:

String

The event's name.

eventHandler:

Function

The event's handler.

Return Value:

Scheduler

The object for which this method is called.

See Also

on(eventName, eventHandler)

Subscribes to an event.

Parameters:
eventName:

String

The event's name.

eventHandler:

Function

The event's handler.

Return Value:

Scheduler

The object for which this method is called.

Use this method to subscribe to one of the events listed in the Events section.

See Also

on(events)

Subscribes to events.

Parameters:
events:

Object

Events with their handlers: { "eventName1": handler1, "eventName2": handler2, ...}

Return Value:

Scheduler

The object for which this method is called.

Use this method to subscribe to several events with one method call. Available events are listed in the Events section.

See Also

option()

Gets all widget options.

Return Value:

Object

The widget's options.

option(optionName)

Gets the value of a single option.

Parameters:
optionName:

String

The option's name or full path.

Return Value: any

This option's value.

option(optionName, optionValue)

Updates the value of a single option.

Parameters:
optionName:

String

The option's name or full path.

optionValue: any

This option's new value.

option(options)

Updates the values of several options.

Parameters:
options:

Object

Options with their new values.

repaint()

Repaints the widget without reloading data. Call it to update the widget's markup.

See Also

scrollToTime(hours, minutes, date)

Scrolls the current view to a specific day and time.

Parameters:
hours:

Number

An hour component.

minutes:

Number

A minute component.

date:

Date

| undefined

A date component.

If the specified date is outside the current date range, the method scrolls the view to the specified time.

NOTE
This method requires that the markup is already rendered. To scroll the Scheduler at launch, call this method in the onContentReady function.
NOTE
This method does not work in the month view.
See Also

showAppointmentPopup(appointmentData, createNewAppointment, currentAppointmentData)

Shows the appointment details form.

Parameters:
appointmentData:

Object

| undefined

The initial appointment.

createNewAppointment:

Boolean

| undefined

Specifies whether a new appointment is created when editing is finished.

currentAppointmentData:

Object

| undefined

The current appointment.

In case of recurring appointments or appointments with multiple resources, you may want to show a popup for the specified appointment, not the initial appointment. For this purpose, use the currentAppointmentData field of the function parameter. Otherwise, use the appointmentData field.

For example, take a look at a recurring appointment that starts on July 18 at 8:00 AM, repeats every day and belongs to two owners. If you call the method for the appointment from the recurring series, for example the second appointment belonging to the second owner, the following information will be in the appointmentData and currentAppointmentData fields.

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

// The current appointment data
var currentAppointmentData = {
    startDate: new Date(2016, 6, 19, 8), 
    endDate: new Date(2016, 6, 19, 9),
    ownerId: 2,
    recurrenceRule: "FREQ=DAILY"
};
See Also

showAppointmentTooltip(appointmentData, target, currentAppointmentData)

Shows a tooltip for a target element.

Parameters:
appointmentData:

Object

The initial appointment.

target:

String

|

DOM Node

|

jQuery

The target element.

currentAppointmentData:

Object

| undefined

The current appointment.

In case of recurring appointments or appointments with multiple resources, you may want to show a tooltip for the specified appointment, not the initial one. For this purpose, use the currentAppointmentData of the method parameters. Otherwise, use the appointmentData parameter.

For example, there is a recurring appointment that starts on July 18 at 8:00 AM, repeats every day and belongs to two owners. If you call the method for an appointment from the recurring series, for example the second appointment belonging to the second owner, the following information will be presented in the appointmentData and currentAppointmentData parameters.

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

// The current appointment data
var currentAppointmentData = {
    startDate: new Date(2016, 6, 19, 8), 
    endDate: new Date(2016, 6, 19, 9),
    ownerId: 2,
    recurrenceRule: "FREQ=DAILY"
};
See Also

updateAppointment(target, appointment)

Updates an appointment.

Parameters:
target:

Object

The appointment to be updated.

appointment:

Object

The appointment with updated data.