Angular Scheduler Methods

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.

defaultOptions(rule)

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

Parameters:

rule:

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.

Name

Type

Description

device

Device

|

Array<Device>

|

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

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
            }
        });
    }
}

deleteAppointment(appointment)

Deletes an appointment.

Parameters:

appointment:

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

dispose()

Disposes of all the resources allocated to the Scheduler instance.

The following code disposes of an Scheduler instance that corresponds to the element ID (or reference variable in Angular) and removes the element from the DOM:

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

endUpdate()

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

Main article: beginUpdate()

focus()

Sets focus on the widget.

getDataSource()

Gets the DataSource instance.

Return Value:

DataSource

The DataSource instance.

getEndViewDate()

Gets the current view's end date.

Return Value:

Date

The view's end date.

getInstance(element)

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

Parameters:

element:

DOM Node

|

jQuery

The widget's container.

Return Value:

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);

getStartViewDate()

Gets the current view's start date.

Return Value:

Date

The view's start date.

hideAppointmentPopup(saveChanges)

Hides an appointment details form.

Parameters:

saveChanges:

Boolean

| undefined

Specifies whether to save changes.

hideAppointmentTooltip()

Hides an appointment tooltip.

instance()

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

Return Value:

This widget's instance.

off(eventName)

Detaches all event handlers from a single event.

Parameters:

eventName:

The event's name.

Return Value:

The object for which this method is called.

off(eventName, eventHandler)

Detaches a particular event handler from a single event.

Parameters:

eventName:

The event's name.

eventHandler:

The event's handler.

Return Value:

The object for which this method is called.

on(eventName, eventHandler)

Subscribes to an event.

Parameters:

eventName:

The event's name.

eventHandler:

The event's handler.

Return Value:

The object for which this method is called.

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

on(events)

Subscribes to events.

Parameters:

events:

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

Return Value:

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.

option()

Gets all widget options.

Return Value:

The widget's options.

option(optionName)

Gets the value of a single option.

Parameters:

optionName:

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:

The option's name or full path.

optionValue: any

This option's new value.

option(options)

Updates the values of several options.

Parameters:

options:

Options with their new values.

registerKeyHandler(key, handler)

Registers a handler to be executed when a user presses a specific key.

Parameters:

key:

The key.

handler:

The handler.

The key argument accepts one of the following values:

"backspace"
"tab"
"enter"
"escape"
"pageUp"
"pageDown"
"end"
"home"
"leftArrow"
"upArrow"
"rightArrow"
"downArrow"
"del"
"space"
"F"
"A"
"asterisk"
"minus"

A custom handler for a key cancels the default handler for this key.

repaint()

Repaints the widget. Call it if you made modifications that changed the widget's state to invalid.

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 not included in the current date range, the method scrolls the scheduler work space to the specified time.

showAppointmentPopup(appointmentData, createNewAppointment, currentAppointmentData)

Shows the appointment details form.

Parameters:

appointmentData:

The initial appointment.

createNewAppointment:

Boolean

| undefined

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

currentAppointmentData:

| 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"
};

showAppointmentTooltip(appointmentData, target, currentAppointmentData)

Shows a tooltip for a target element.

Parameters:

appointmentData:

The initial appointment.

target:

|

DOM Node

|

jQuery

The target element.

currentAppointmentData:

| 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"
};

updateAppointment(target, appointment)

Updates an appointment.

Parameters:

target:

The appointment to be updated.

appointment: