React ProgressBar Methods
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)
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 ProgressBar UI component in an application executed on the desktop.
jQuery
DevExpress.ui.dxProgressBar.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the ProgressBar properties } });
Angular
import ProgressBar, { Properties } from "devextreme/ui/progress_bar"; // ... export class AppComponent { constructor () { ProgressBar.defaultOptions<Properties>({ device: { deviceType: "desktop" }, options: { // Here go the ProgressBar properties } }); } }
Vue
<template> <div> <DxProgressBar id="progressBar1" /> <DxProgressBar id="progressBar2" /> </div> </template> <script> import DxProgressBar from "devextreme-vue/progress-bar"; import ProgressBar from "devextreme/ui/progress_bar"; ProgressBar.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the ProgressBar properties } }); export default { components: { DxProgressBar } } </script>
React
import dxProgressBar from "devextreme/ui/progress_bar"; import ProgressBar from "devextreme-react/progress-bar"; dxProgressBar.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the ProgressBar properties } }); export default function App() { return ( <div> <ProgressBar id="progressBar1" /> <ProgressBar id="progressBar2" /> </div> ) }
You can also set rules for multiple device types:
jQuery
const devicesConfig = [ { deviceType: 'desktop' }, { deviceType: 'tablet' }, { deviceType: 'phone' }, ]; devicesConfig.forEach(deviceConfig => { DevExpress.ui.dxProgressBar.defaultOptions({ device: deviceConfig, options: { // Here go the ProgressBar properties } }); });
Angular
import ProgressBar, { Properties } from "devextreme/ui/progress_bar"; // ... export class AppComponent { constructor () { const devicesConfig = [ { deviceType: 'desktop' }, { deviceType: 'tablet' }, { deviceType: 'phone' }, ]; devicesConfig.forEach(deviceConfig => { ProgressBar.defaultOptions<Properties>({ device: deviceConfig, options: { // Here go the ProgressBar properties } }); }); } }
Vue
<template> <div> <DxProgressBar /> </div> </template> <script> import DxProgressBar from "devextreme-vue/progress-bar"; import ProgressBar from "devextreme/ui/progress_bar"; const devicesConfig = [ { deviceType: 'desktop' }, { deviceType: 'tablet' }, { deviceType: 'phone' }, ]; devicesConfig.forEach(deviceConfig => { ProgressBar.defaultOptions({ device: deviceConfig, options: { // Here go the ProgressBar properties } }); }); export default { components: { DxProgressBar } } </script>
React
import dxProgressBar from "devextreme/ui/progress_bar"; import ProgressBar from "devextreme-react/progress-bar"; const devicesConfig = [ { deviceType: 'desktop' }, { deviceType: 'tablet' }, { deviceType: 'phone' }, ]; devicesConfig.forEach(deviceConfig => { dxProgressBar.defaultOptions({ device: deviceConfig, options: { // Here go the ProgressBar properties } }); }); export default function App() { return ( <div> <ProgressBar /> </div> ) }
dispose()
jQuery
After calling this method, remove the DOM element associated with the UI component:
$("#myProgressBar").dxProgressBar("dispose"); $("#myProgressBar").remove();
Angular
Use conditional rendering instead of this method:
<dx-progress-bar ... *ngIf="condition"> </dx-progress-bar>
Vue
Use conditional rendering instead of this method:
<template> <DxProgressBar ... v-if="condition"> </DxProgressBar> </template> <script> import DxProgressBar from 'devextreme-vue/progress-bar'; export default { components: { DxProgressBar } } </script>
React
Use conditional rendering instead of this method:
import React from 'react'; import ProgressBar from 'devextreme-react/progress-bar'; function DxProgressBar(props) { if (!props.shouldRender) { return null; } return ( <ProgressBar ... > </ProgressBar> ); } class App extends React.Component { render() { return ( <DxProgressBar 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
getInstance(element)
getInstance is a static method that the UI component class supports. The following code demonstrates how to get the ProgressBar instance found in an element with the myProgressBar
ID:
// Modular approach import ProgressBar from "devextreme/ui/progress_bar"; ... let element = document.getElementById("myProgressBar"); let instance = ProgressBar.getInstance(element) as ProgressBar; // Non-modular approach let element = document.getElementById("myProgressBar"); let instance = DevExpress.ui.dxProgressBar.getInstance(element);
See Also
on(eventName, eventHandler)
Use this method to subscribe to one of the events listed in the Events section.
See Also
on(events)
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.
The repaint()
method re-initializes the component with new settings, resetting its state and history.
See Also
- reload() in DataSource | List
- refresh() in DataGrid | TreeList
reset(value)
Resets the value property to the value passed as an argument.
If you have technical questions, please create a support ticket in the DevExpress Support Center.