JavaScript/jQuery ProgressBar Methods
This section describes members used to manipulate the widget.
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
- Call Methods: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
defaultOptions(rule)
Specifies the device-dependent default configuration options for this component.
The component's default device options.
defaultOptions is a static method that the widget class supports. The following code demonstrates how to specify default options for all instances of the ProgressBar widget in an application executed on the desktop.
jQuery
DevExpress.ui.dxProgressBar.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the ProgressBar options } });
Angular
import ProgressBar from 'devextreme/ui/progress_bar'; // ... export class AppComponent { constructor () { ProgressBar.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the ProgressBar options } }); } }
dispose()
Disposes of all the resources allocated to the ProgressBar instance.
The following code disposes of an ProgressBar instance that corresponds to the element ID (or reference variable in Angular) and removes the element from the DOM:
jQuery
$("#myProgressBar").dxProgressBar("dispose"); $("#myProgressBar").remove();
Angular
<dx-progress-bar #progressBarVar id="myProgressBar"></dx-progress-bar>
import { ..., ViewChild } from "@angular/core"; import { DxProgressBarComponent } from "devextreme-angular"; // ... export class AppComponent { @ViewChild("progressBarVar") progressBar: DxProgressBarComponent; removeProgressBar (e) { this.progressBar.instance.dispose(); document.getElementById("myProgressBar").remove(); } }
element()
Gets the root widget element.
An HTML element or a jQuery element when you use jQuery.
See Also
- Call Methods: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
endUpdate()
Refreshes the widget after a call of the beginUpdate() method.
Main article: beginUpdate()
See Also
- Call Methods: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
getInstance(element)
Gets the instance of a widget found using its DOM node.
The widget's instance.
getInstance is a static method that the widget 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
instance()
Gets the widget's instance. Use it to access other methods of the widget.
This widget's instance.
See Also
- Call Methods: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
off(eventName)
Detaches all event handlers from a single event.
The event's name.
The object for which this method is called.
See Also
- Handle Events: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
off(eventName, eventHandler)
Detaches a particular event handler from a single event.
The object for which this method is called.
See Also
- Handle Events: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
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()
Gets all widget options.
The widget's options.
See Also
- Get and Set Options
- Call Methods: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
option(optionName)
Gets the value of a single option.
The option's name or full path.
This option's value.
See Also
- Get and Set Options
- Call Methods: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
option(optionName, optionValue)
Updates the value of a single option.
See Also
- Get and Set Options
- Call Methods: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
option(options)
Updates the values of several options.
Options with their new values.
See Also
- Get and Set Options
- Call Methods: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
repaint()
Repaints the widget. Call it if you made modifications that changed the widget's state to invalid.
See Also
- Call Methods: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
reset()
Resets the value option to null.
See Also
- Call Methods: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
If you have technical questions, please create a support ticket in the DevExpress Support Center.