Angular Scheduler Methods

This section describes methods used to manipulate the UI component.

See Also
jQuery
Angular
Vue
React

addAppointment(appointment)

Adds an appointment.

Parameters:
appointment:

dxSchedulerAppointment

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

View Demo

See Also
jQuery
Angular
Vue
React

beginUpdate()

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

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

See Also
jQuery
Angular
Vue
React

defaultOptions(rule)

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

Parameters:
rule:

Object

The component's default device properties.

Object structure:
Name Type Description
device

Device

|

Function

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

Object

Options to be applied.

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

jQuery
JavaScript
DevExpress.ui.dxScheduler.defaultOptions({ 
    device: { deviceType: "desktop" },
    options: {
        // Here go the Scheduler properties
    }
});
Angular
TypeScript
import Scheduler, { Properties } from "devextreme/ui/scheduler";
// ...
export class AppComponent {
    constructor () {
        Scheduler.defaultOptions<Properties>({
            device: { deviceType: "desktop" },
            options: {
                // Here go the Scheduler properties
            }
        });
    }
}
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 properties
    }
});

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

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

export default function App() {
    return (
        <div>
            <Scheduler id="scheduler1" />
            <Scheduler id="scheduler2" />
        </div>
    )
}

deleteAppointment(appointment)

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

Parameters:
appointment:

dxSchedulerAppointment

An appointment object from the dataSource.

View Demo

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.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.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
jQuery
Angular
Vue
React

deleteRecurrence(appointment, date, recurrenceEditMode)

Deletes a recurring appointment occurrence.

Parameters:
appointmentData:

dxSchedulerAppointment

The initial appointment.

date:

Date

|

String

A date for which to delete a recurrence.

recurrenceEditMode: 'dialog' | 'occurrence' | 'series'

An edit mode for recurring appointments.

jQuery
index.js
$(function() {
    const 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"
    }, 
    // ...
    ];

    const scheduler = $("#schedulerContainer").dxScheduler({
        dataSource: appointments,
        // ...
        onAppointmentClick: function(e) {
            if (condition){
                e.component.deleteRecurrence(e.appointmentData, e.targetedAppointmentData.startDate, 'occurrence');
            }
        }
    }).dxScheduler("instance");
});
Angular
app.component.html
app.component.ts
app.service.ts
app.module.ts
<dx-scheduler ...
    [dataSource]="appointments"
    (onAppointmentClick)="deleteRecurrence($event)">
</dx-scheduler>
import { Component } from "@angular/core";
import { Appointment, Service } from './app.service';
@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent  {
    appointments: Appointment[];

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

    deleteAppointment(e) {
        e.component.deleteRecurrence(e.appointmentData, e.targetedAppointmentData.startDate, 'occurrence');
    }
}
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 { DxSchedulerModule } from "devextreme-angular";

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

@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxSchedulerModule
    ],
    providers: [
        Service
    ],
    bootstrap: [AppComponent]
})
export class AppModule { }
Vue
App.vue
data.js
<template>
    <DxScheduler ...
        :data-source="dataSource"
        @appointment-click="deleteRecurrence"
    />
</template>

<script>
import 'devextreme/dist/css/dx.light.css';
import DxScheduler from 'devextreme-vue/scheduler';
import { appointments } from './data.js';

export default {
    components: {
        DxScheduler
    },
    data() {
        return {
            dataSource: appointments
        };
    },
    methods: {
        deleteRecurrence(e) {
            e.component.deleteRecurrence(e.appointmentData, e.targetedAppointmentData.startDate, 'occurrence');
        } 
    }
};
</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, { useCallback } from 'react';
import Scheduler from 'devextreme-react/scheduler';
import { appointments } from './data.js';

function App() {
    const deleteRecurrence = useCallback((e) => { 
        e.component.deleteRecurrence(e.appointmentData, e.targetedAppointmentData.startDate, 'occurrence');
    }, []);

    return (
        <Scheduler ...
            dataSource={appointments}
            onAppointmentClick={deleteRecurrence} 
        />
    );
}

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"
}, 
// ...
];

dispose()

Disposes of all the resources allocated to the Scheduler instance.

jQuery

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

JavaScript
$("#myScheduler").dxScheduler("dispose");
$("#myScheduler").remove();
Angular

Use conditional rendering instead of this method:

app.component.html
<dx-scheduler ...
    *ngIf="condition">
</dx-scheduler>
Vue

Use conditional rendering instead of this method:

App.vue
<template>
    <DxScheduler ...
        v-if="condition">
    </DxScheduler>
</template>

<script>
import DxScheduler from 'devextreme-vue/scheduler';

export default {
    components: {
        DxScheduler
    }
}
</script>
React

Use conditional rendering instead of this method:

App.js
import React from 'react';

import Scheduler from 'devextreme-react/scheduler';

function DxScheduler(props) {
    if (!props.shouldRender) {
        return null;
    }

    return (
        <Scheduler ... >    
        </Scheduler>
    );
}

class App extends React.Component {
    render() {
        return (
            <DxScheduler shouldRender="condition" />
        );
    }
}
export default App;

element()

Gets the root UI component element.

Return Value:

HTMLElement | jQuery

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

See Also
jQuery
Angular
Vue
React

endUpdate()

Refreshes the UI component after a call of the beginUpdate() method.

Main article: beginUpdate()

See Also
jQuery
Angular
Vue
React

focus()

Sets focus on the UI component.

See Also
jQuery
Angular
Vue
React

getDataSource()

Gets the DataSource instance.

Return Value:

DataSource

The DataSource instance.

NOTE
This method returns the DataSource instance even if the UI component's dataSource property was given a simple array.
See Also
jQuery
Angular
Vue
React

getEndViewDate()

Gets the current view's end date.

Return Value:

Date

The view's end date.

See Also
jQuery
Angular
Vue
React

getInstance(element)

Gets the instance of a UI component found using its DOM node.

Parameters:
element:

Element

|

jQuery

The UI component's container.

Return Value:

Object

The UI component's instance.

getInstance is a static method that the UI component 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
jQuery
Angular
Vue
React

hideAppointmentPopup(saveChanges)

Hides an appointment details form.

Parameters:
saveChanges:

Boolean

| undefined

Specifies whether to save changes.

See Also
jQuery
Angular
Vue
React

hideAppointmentTooltip()

Hides an appointment's or cell overflow indicator's tooltip.

See Also
jQuery
Angular
Vue
React

instance()

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

Return Value:

Scheduler

This UI component's instance.

See Also
jQuery
Angular
Vue
React

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
jQuery
Angular
Vue
React

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
jQuery
Angular
Vue
React

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
jQuery
Angular
Vue
React

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
jQuery
Angular
Vue
React

option()

Gets all UI component properties.

Return Value:

Object

The UI component's properties.

See Also
jQuery
Angular
Vue
React

option(optionName)

Gets the value of a single property.

Parameters:
optionName:

String

The property's name or full path.

Return Value: any

This property's value.

See Also
jQuery
Angular
Vue
React

option(optionName, optionValue)

Updates the value of a single property.

Parameters:
optionName:

String

The property's name or full path.

optionValue: any

This property's new value.

See Also
jQuery
Angular
Vue
React

option(options)

Updates the values of several properties.

Parameters:
options:

Object

Options with their new values.

See Also
jQuery
Angular
Vue
React

repaint()

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

Use the DataSource reload method to reload data in Scheduler. To get a DataSource, you can call the getDataSource() method. Change the dataSource property of the corresponding resources item if you need to update resource data.

resetOption(optionName)

Resets a property to its default value.

Parameters:
optionName:

String

A property's name.

See Also
jQuery
Angular
Vue
React

scrollTo(date, group, allDay)

Scrolls the current view to a specified position. Available for all views except "agenda". You should specify the height property to use this method.

Parameters:
date:

Date

A date and time to which to scroll.

group:

Object

| undefined

If appointments are grouped by resources, specifies a group ID (optional).

allDay:

Boolean

| undefined

If true, scrolls the view to the all-day panel of the specified group. Applies only if the all-day panel is visible.

The following example shows how to use this method:

// Scroll to January 14, 2021
scrollTo(new Date(2021, 0, 14));
// Scroll to the second group at 5:30 p.m. on January 14, 2021
scrollTo(new Date(2021, 0, 14, 17, 30), {groupId: 2})
// Scroll to the all-day panel of the second group
scrollTo(new Date(2021, 0, 14, 17, 30), {groupId: 2}, true);
NOTE
If you need to navigate to a date outside the current view, use the currentDate property instead.
See Also
jQuery
Angular
Vue
React

scrollToTime(hours, minutes, date) Deprecated

Use the scrollTo(dategroupallDay) method instead.

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
jQuery
Angular
Vue
React

showAppointmentPopup(appointmentData, createNewAppointment, currentAppointmentData)

Shows the appointment details form.

Parameters:
appointmentData:

dxSchedulerAppointment

| undefined

The initial appointment.

createNewAppointment:

Boolean

| undefined

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

currentAppointmentData:

dxSchedulerAppointment

| undefined

The appointment's data object.
The difference between this and appointmentData fields is explained in the onAppointmentClick description.

If invoked without parameters, the method shows a new appointment window. Its start and end dates are prepopulated in accordance with the currentDate value. The default appointment duration is 30 minutes.

View Demo

See Also
jQuery
Angular
Vue
React

showAppointmentTooltip(appointmentData, target, currentAppointmentData)

Shows a tooltip for a target element.

Parameters:
appointmentData:

dxSchedulerAppointment

The initial appointment.

target:

String

|

Element

|

jQuery

The target element.

currentAppointmentData:

dxSchedulerAppointment

| undefined

The appointment's data object.
The difference between this and appointmentData fields is explained in the onAppointmentClick description.

See Also
jQuery
Angular
Vue
React

updateAppointment(target, appointment)

Updates an appointment.

Parameters:
target:

dxSchedulerAppointment

The appointment to be updated.

appointment:

dxSchedulerAppointment

The appointment with updated data.

View Demo

See Also
jQuery
Angular
Vue
React