addAppointment(appointment)
The appointment; should have the same structure as objects in the dataSource.
See Also
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
- 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
defaultOptions(rule)
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> <dx-scheduler id="scheduler1" /> <dx-scheduler 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)
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) 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> <dx-button text="Delete" @click="deleteAppointment" /> <dx-scheduler :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 DxComponent 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 DxComponent;
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: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
- onAppointmentDeleting
- onAppointmentDeleted
dispose()
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
$("#myScheduler").dxScheduler("dispose"); $("#myScheduler").remove();
Angular
<dx-scheduler #schedulerVar id="myScheduler"></dx-scheduler>
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(); } }
endUpdate()
Refreshes the widget after a call of the beginUpdate() method.
Main article: beginUpdate()
See Also
getDataSource()
Gets the DataSource instance.
See Also
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
- Data Layer - Overview
- Data Layer - DataSource Examples
getInstance(element)
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
option()
See Also
- Get and Set Options
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
option(optionName)
See Also
- Get and Set Options
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
option(optionName, optionValue)
See Also
- Get and Set Options
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
option(options)
See Also
- Get and Set Options
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
registerKeyHandler(key, handler)
A handler. Accepts the keydown event as the argument. It is a dxEvent or a jQuery.Event when you use jQuery.
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.
See Also
scrollToTime(hours, minutes, date)
If the specified date is outside the current date range, the method scrolls the view to the specified time.
See Also
showAppointmentPopup(appointmentData, createNewAppointment, currentAppointmentData)
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.
// 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)
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.
// 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)
See Also
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
- onAppointmentUpdating
- onAppointmentUpdated
If you have technical questions, please create a support ticket in the DevExpress Support Center.