JavaScript/jQuery Scheduler Methods
addAppointment(appointment)
Parameters:
appointment:
The appointment; should have the same structure as objects in the dataSource.
See Also
beginUpdate()
Postpones rendering that can negatively affect performance until the endUpdate() method is called.
The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.
See Also
defaultOptions(rule)
Parameters:
rule:
Object structure:
| Name | Type | Description |
|---|---|---|
| device | | |
Device parameters. |
| options |
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>
)
}You can also set rules for multiple device types:
jQuery
JavaScript
const devicesConfig = [
{ deviceType: 'desktop' },
{ deviceType: 'tablet' },
{ deviceType: 'phone' },
];
devicesConfig.forEach(deviceConfig => {
DevExpress.ui.dxScheduler.defaultOptions({
device: deviceConfig,
options: {
// Here go the Scheduler properties
}
});
});Angular
TypeScript
import Scheduler, { Properties } from "devextreme/ui/scheduler";
// ...
export class AppComponent {
constructor () {
const devicesConfig = [
{ deviceType: 'desktop' },
{ deviceType: 'tablet' },
{ deviceType: 'phone' },
];
devicesConfig.forEach(deviceConfig => {
Scheduler.defaultOptions<Properties>({
device: deviceConfig,
options: {
// Here go the Scheduler properties
}
});
});
}
}Vue
<template>
<div>
<DxScheduler />
</div>
</template>
<script>
import DxScheduler from "devextreme-vue/scheduler";
import Scheduler from "devextreme/ui/scheduler";
const devicesConfig = [
{ deviceType: 'desktop' },
{ deviceType: 'tablet' },
{ deviceType: 'phone' },
];
devicesConfig.forEach(deviceConfig => {
Scheduler.defaultOptions({
device: deviceConfig,
options: {
// Here go the Scheduler properties
}
});
});
export default {
components: {
DxScheduler
}
}
</script>React
import dxScheduler from "devextreme/ui/scheduler";
import Scheduler from "devextreme-react/scheduler";
const devicesConfig = [
{ deviceType: 'desktop' },
{ deviceType: 'tablet' },
{ deviceType: 'phone' },
];
devicesConfig.forEach(deviceConfig => {
dxScheduler.defaultOptions({
device: deviceConfig,
options: {
// Here go the Scheduler properties
}
});
});
export default function App() {
return (
<div>
<Scheduler />
</div>
)
}deleteAppointment(appointment)
Parameters:
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
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
deleteRecurrence(appointment, date, recurrenceEditMode)
Parameters:
appointmentData:
recurrenceEditMode:
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()
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;endUpdate()
Refreshes the UI component after a call of the beginUpdate() method.
The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.
See Also
getDataSource()
Gets the DataSource instance.
Return Value:
NOTE
This method returns the DataSource instance even if the UI component's dataSource property was given a simple array.
See Also
getInstance(element)
Return Value:
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
on(eventName, eventHandler)
Return Value:
Use this method to subscribe to one of the events listed in the Events section.
See Also
on(events)
Parameters:
events:
Return Value:
Use this method to subscribe to several events with one method call. Available events are listed in the Events section.
See Also
repaint()
Renders the component again without reloading data. Use the method to update the component's markup and appearance dynamically.
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.
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:
group:
| undefined
If appointments are grouped by resources, specifies a group ID (optional).
allDay:
| 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
scrollToTime(hours, minutes, date)
Use the scrollTo(dategroupallDay) method instead.
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)
Parameters:
appointmentData:
| undefined
createNewAppointment:
| undefined
currentAppointmentData:
| 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.
See Also
showAppointmentTooltip(appointmentData, target, currentAppointmentData)
Parameters:
appointmentData:
currentAppointmentData:
| undefined
The appointment's data object.
The difference between this and appointmentData fields is explained in the onAppointmentClick description.
Feel free to share topic-related thoughts here.
If you have technical questions, please create a support ticket in the DevExpress Support Center.
Thank you for the feedback!
If you have technical questions, please create a support ticket in the DevExpress Support Center.