Vue Scheduler Methods
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
addAppointment(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 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
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
defaultOptions(rule)
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.
- <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>
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:
- <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"
- },
- // ...
- ];
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- onAppointmentDeleting
- onAppointmentDeleted
dispose()
After calling this method, remove the DOM element associated with the UI component:
- $("#myScheduler").dxScheduler("dispose");
- $("#myScheduler").remove();
Use this method only if the UI component was created with jQuery or pure JavaScript. In Angular, Vue, and React, use conditional rendering:
- <template>
- <DxScheduler ...
- v-if="condition">
- </DxScheduler>
- </template>
- <script>
- import DxScheduler from 'devextreme-vue/scheduler';
- export default {
- components: {
- DxScheduler
- }
- }
- </script>
See Also
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 UI component 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()
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
getDataSource()
Gets 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()
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
getInstance(element)
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()
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
hideAppointmentPopup(saveChanges)
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()
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
off(eventName)
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
off(eventName, eventHandler)
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
on(eventName, eventHandler)
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)
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 UI component properties.
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(optionName)
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(optionName, optionValue)
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(options)
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
repaint()
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)
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
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
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
showAppointmentPopup(appointmentData, createNewAppointment, currentAppointmentData)
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)
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
updateAppointment(target, appointment)
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- onAppointmentUpdating
- onAppointmentUpdated
If you have technical questions, please create a support ticket in the DevExpress Support Center.