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 SlideOut widget in an application executed on the desktop.
jQuery
DevExpress.ui.dxSlideOut.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the SlideOut options } });
Angular
import SlideOut from "devextreme/ui/slide_out"; // ... export class AppComponent { constructor () { SlideOut.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the SlideOut options } }); } }
Vue
<template> <div> <dx-slide-out id="slideOut1" /> <dx-slide-out id="slideOut2" /> </div> </template> <script> import DxSlideOut from "devextreme-vue/slide-out"; import SlideOut from "devextreme/ui/slide_out"; SlideOut.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the SlideOut options } }); export default { components: { DxSlideOut } } </script>
React
import React from "react"; import dxSlideOut from "devextreme/ui/slide_out"; import SlideOut from "devextreme-react/slide-out"; class App extends React.Component { render () { dxSlideOut.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the SlideOut options } }) return ( <div> <SlideOut id="slideOut1" /> <SlideOut id="slideOut2" /> </div> ) } } export default App;
dispose()
The following code disposes of an SlideOut instance that corresponds to the element ID (or reference variable in Angular) and removes the element from the DOM:
jQuery
$("#mySlideOut").dxSlideOut("dispose"); $("#mySlideOut").remove();
Angular
<dx-slide-out #slideOutVar id="mySlideOut"></dx-slide-out>
import { ..., ViewChild } from "@angular/core"; import { DxSlideOutComponent } from "devextreme-angular"; // ... export class AppComponent { @ViewChild("slideOutVar") slideOut: DxSlideOutComponent; removeSlideOut (e) { this.slideOut.instance.dispose(); document.getElementById("mySlideOut").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 SlideOut instance found in an element with the mySlideOut
ID:
// Modular approach import SlideOut from "devextreme/ui/slide_out"; ... let element = document.getElementById("mySlideOut"); let instance = SlideOut.getInstance(element) as SlideOut; // Non-modular approach let element = document.getElementById("mySlideOut"); let instance = DevExpress.ui.dxSlideOut.getInstance(element);
See Also
hideMenu()
A Promise that is resolved after the menu is hidden. It is a native Promise or a jQuery.Promise when you use jQuery.
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
showMenu()
A Promise that is resolved after the menu is shown. It is a native Promise or a jQuery.Promise when you use jQuery.
toggleMenuVisibility(showing)
A Promise that is resolved after the menu is shown/hidden. It is a native Promise or a jQuery.Promise when you use jQuery.
You can use this method instead of showMenu() and hideMenu() methods. The only difference is that you specify whether to show or hide the widget passing true or false to the method parameter.