Angular LoadPanel 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
content()
Gets the UI component's content.
An HTML element or a jQuery element when you use jQuery.
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 LoadPanel UI component in an application executed on the desktop.
jQuery
DevExpress.ui.dxLoadPanel.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the LoadPanel properties } });
Angular
import LoadPanel from "devextreme/ui/load_panel"; // ... export class AppComponent { constructor () { LoadPanel.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the LoadPanel properties } }); } }
Vue
<template> <div> <DxLoadPanel id="loadPanel1" /> <DxLoadPanel id="loadPanel2" /> </div> </template> <script> import DxLoadPanel from "devextreme-vue/load-panel"; import LoadPanel from "devextreme/ui/load_panel"; LoadPanel.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the LoadPanel properties } }); export default { components: { DxLoadPanel } } </script>
React
import React, {useEffect} from "react"; import dxLoadPanel from "devextreme/ui/load_panel"; import LoadPanel from "devextreme-react/load-panel"; export default function App() { useEffect(() => { dxLoadPanel.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the LoadPanel properties } }) }); return ( <div> <LoadPanel id="loadPanel1" /> <LoadPanel id="loadPanel2" /> </div> ) }
dispose()
Disposes of all the resources allocated to the LoadPanel instance.
After calling this method, remove the DOM element associated with the UI component:
$("#myLoadPanel").dxLoadPanel("dispose"); $("#myLoadPanel").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-load-panel ... *ngIf="condition"> </dx-load-panel>
Vue
<template> <DxLoadPanel ... v-if="condition"> </DxLoadPanel> </template> <script> import DxLoadPanel from 'devextreme-vue/load-panel'; export default { components: { DxLoadPanel } } </script>
React
import React from 'react'; import LoadPanel from 'devextreme-react/load-panel'; function DxLoadPanel(props) { if (!props.shouldRender) { return null; } return ( <LoadPanel ... > </LoadPanel> ); } class App extends React.Component { render() { return ( <DxLoadPanel 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.
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 LoadPanel instance found in an element with the myLoadPanel
ID:
// Modular approach import LoadPanel from "devextreme/ui/load_panel"; ... let element = document.getElementById("myLoadPanel"); let instance = LoadPanel.getInstance(element) as LoadPanel; // Non-modular approach let element = document.getElementById("myLoadPanel"); let instance = DevExpress.ui.dxLoadPanel.getInstance(element);
See Also
hide()
Hides the UI component.
A Promise that is resolved after the UI component 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.
resetOption(optionName)
Resets a property to its default value.
A property's name.
show()
Shows the UI component.
A Promise that is resolved after the UI component is shown. It is a native Promise or a jQuery.Promise when you use jQuery.
toggle(showing)
Shows or hides the UI component depending on the argument.
Specifies whether to show or hide the UI component.
A Promise that is resolved with true if the UI component is shown or false if it is hidden. It is a native Promise or a jQuery.Promise when you use jQuery.
If you have technical questions, please create a support ticket in the DevExpress Support Center.