JavaScript/jQuery SlideOut Methods
This section describes members used to manipulate the UI component.
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
defaultOptions(rule)
Specifies the device-dependent default configuration properties for this component.
The component's default device properties.
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 SlideOut UI component in an application executed on the desktop.
jQuery
DevExpress.ui.dxSlideOut.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the SlideOut properties
}
});Angular
import SlideOut from "devextreme/ui/slide_out";
// ...
export class AppComponent {
constructor () {
SlideOut.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the SlideOut properties
}
});
}
}Vue
<template>
<div>
<DxSlideOut id="slideOut1" />
<DxSlideOut 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 properties
}
});
export default {
components: {
DxSlideOut
}
}
</script>React
import React, {useEffect} from "react";
import dxSlideOut from "devextreme/ui/slide_out";
import SlideOut from "devextreme-react/slide-out";
export default function App() {
useEffect(() => {
dxSlideOut.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the SlideOut properties
}
})
});
return (
<div>
<SlideOut id="slideOut1" />
<SlideOut id="slideOut2" />
</div>
)
}dispose()
Disposes of all the resources allocated to the SlideOut instance.
After calling this method, remove the DOM element associated with the UI component:
$("#mySlideOut").dxSlideOut("dispose");
$("#mySlideOut").remove();Use this method only if the UI component was created with jQuery or pure JavaScript. In Angular, Vue, and React, use conditional rendering:
Angular
<dx-slide-out ...
*ngIf="condition">
</dx-slide-out>Vue
<template>
<DxSlideOut ...
v-if="condition">
</DxSlideOut>
</template>
<script>
import DxSlideOut from 'devextreme-vue/slide-out';
export default {
components: {
DxSlideOut
}
}
</script>React
import React from 'react';
import SlideOut from 'devextreme-react/slide-out';
function DxSlideOut(props) {
if (!props.shouldRender) {
return null;
}
return (
<SlideOut ... >
</SlideOut>
);
}
class App extends React.Component {
render() {
return (
<DxSlideOut shouldRender="condition" />
);
}
}
export default App;See Also
element()
Gets the root UI component element.
An HTML element or a jQuery element when you use jQuery.
getDataSource()
Gets the DataSource instance.
The DataSource instance.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout
- Data Layer - Overview
- Data Layer - DataSource Examples
getInstance(element)
Gets the instance of a UI component found using its DOM node.
The UI component's instance.
getInstance is a static method that the UI component 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()
Hides the UI component's slide-out menu.
A Promise that is resolved after the menu is hidden. It is a native Promise or a jQuery.Promise when you use jQuery.
instance()
Gets the UI component's instance. Use it to access other methods of the UI component.
This UI component's instance.
off(eventName)
Detaches all event handlers from a single event.
The event's name.
The object for which this method is called.
off(eventName, eventHandler)
Detaches a particular event handler from a single event.
The object for which this method is called.
on(eventName, eventHandler)
Subscribes to an event.
The object for which this method is called.
on(events)
Subscribes to events.
Events with their handlers: { "eventName1": handler1, "eventName2": handler2, ...}
The object for which this method is called.
option(optionName)
Gets the value of a single property.
The property's name or full path.
This property's value.
option(options)
Updates the values of several properties.
Options with their new values.
repaint()
Repaints the UI component without reloading data. Call it to update the UI component's markup.
resetOption(optionName)
Resets a property to its default value.
A property's name.
showMenu()
Displays the UI component's slide-out menu.
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)
Shows or hides the slide-out menu depending on the argument.
Specifies whether to show or hide the UI component. undefined reverses the current visibility state.
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 the showMenu() and hideMenu() methods.