JavaScript/jQuery Scheduler Methods
This section describes methods used to manipulate the widget.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
addAppointment(appointment)
Adds an appointment.
The appointment; should have the same structure as objects in the dataSource.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- onAppointmentAdding
- onAppointmentAdded
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
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
defaultOptions(rule)
Specifies the device-dependent default configuration options for this component.
The component's default device options.
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
DevExpress.ui.dxScheduler.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the Scheduler options } });
Angular
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.
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
$(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
<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
<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
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
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- onAppointmentDeleting
- onAppointmentDeleted
dispose()
Disposes of all the resources allocated to the Scheduler instance.
After calling this method, remove the DOM element associated with the widget:
$("#myScheduler").dxScheduler("dispose"); $("#myScheduler").remove();
Use this method only if the widget was created with jQuery or pure JavaScript. In Angular, Vue, and React, use conditional rendering:
Angular
<dx-scheduler ... *ngIf="condition"> </dx-scheduler>
Vue
<template> <DxScheduler ... v-if="condition"> </DxScheduler> </template> <script> import DxScheduler from 'devextreme-vue/scheduler'; export default { components: { DxScheduler } } </script>
React
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;
See Also
element()
Gets the root widget element.
An HTML element or a jQuery element when you use jQuery.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
endUpdate()
Refreshes the widget after a call of the beginUpdate() method.
Main article: beginUpdate()
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
focus()
Sets focus on the widget.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
getDataSource()
Gets the DataSource instance.
The DataSource instance.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- Data Layer - Overview
- Data Layer - DataSource Examples
getEndViewDate()
Gets the current view's end date.
The view's end date.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
getInstance(element)
Gets the instance of a widget found using its DOM node.
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.
The view's start date.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
hideAppointmentPopup(saveChanges)
Hides an appointment details form.
Specifies whether to save changes.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
hideAppointmentTooltip()
Hides an appointment's or cell overflow indicator's tooltip.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
instance()
Gets the widget's instance. Use it to access other methods of the widget.
This widget's instance.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
off(eventName)
Detaches all event handlers from a single event.
The event's name.
The object for which this method is called.
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
off(eventName, eventHandler)
Detaches a particular event handler from a single event.
The object for which this method is called.
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
on(eventName, eventHandler)
Subscribes to an event.
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
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
on(events)
Subscribes to events.
Events with their handlers: { "eventName1": handler1, "eventName2": handler2, ...}
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
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option()
Gets all widget options.
The widget's options.
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(optionName)
Gets the value of a single option.
The option's name or full path.
This option's value.
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(optionName, optionValue)
Updates the value of a single option.
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(options)
Updates the values of several options.
Options with their new values.
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
repaint()
Repaints the widget without reloading data. Call it to update the widget's markup.
See Also
- reload() in DataSource | List
- refresh() in DataGrid | TreeList
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
resetOption(optionName)
Resets an option to its default value.
An option's name.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
scrollToTime(hours, minutes, date)
Scrolls the current view to a specific day and time.
If the specified date is outside the current date range, the method scrolls the view to the specified time.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
showAppointmentPopup(appointmentData, createNewAppointment, currentAppointmentData)
Shows the appointment details form.
The initial appointment.
Specifies whether a new appointment is created when editing is finished.
The appointment's data object.
The difference between this and appointmentData fields is explained in the onAppointmentClick description.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
showAppointmentTooltip(appointmentData, target, currentAppointmentData)
Shows a tooltip for a target element.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
updateAppointment(target, appointment)
Updates an appointment.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- onAppointmentUpdating
- onAppointmentUpdated