A progress indication widget, showing the level of a task completion, often the percentage of a task completion.
See the specification for more information.
Table of contents
CP only
The ProgressBar widget provides an ability to display a progress bar
and its state change.
A value of the value property determines the load state. The size
of the filled-in part is calculated on the basis of a maximum value
specified by the maximum property; the default value is 100.
require(["aps/load", "aps/ready!"],
function(load){
"use strict";
load(["aps/PageContainer", [
["aps/ProgressBar", { value: 10 }]
]]);
});
require(["aps/ProgressBar", "aps/PageContainer", "aps/ready!"],
function(ProgressBar, PageContainer){
"use strict";
var page = new PageContainer({}, "pbDiv");
page.addChild(new ProgressBar({ value: 10 }));
page.startup();
});
Clicking the button starts filling of the progress bar.
require(["aps/ProgressBar", "aps/Button", "aps/PageContainer", "aps/ready!"],
function(ProgressBar, Button, PageContainer) {
"use strict";
var page = new PageContainer();
page.placeAt("main");
var jsProgress = new ProgressBar({value: 10});
function download()
{
var val = jsProgress.get("value");
jsProgress.set("value", val+10);
if(val+10 < 100)
setTimeout(download, 100 + Math.floor(Math.random() * 100));
}
var bt = new Button({
id: "bt",
label: "Run",
timeout: 2000,
onClick: download
});
page.addChild(jsProgress);
page.addChild(bt);
page.startup();
});
| PROPERTY | TYPE | DEFAULT | DESCRIPTION |
|---|---|---|---|
| completedText | string | completed | Text in progressBar control. |
| disabled | boolean | false | Specifies if the widget will respond to user input. |
| gridSize | string | undefined | This specifies the widget width that is relevant only for widgets inside Container, FieldSet, or Tiles. |
| indeterminateHighContrastImage | object | {setAttribute: function(){}} | Used for indeterminate progress bar when display is in high contrast mode. |
| isBusy | boolean | false | If the widget is busy then this property is true. |
| label | string | “” | Text that is shown as a label if the widget is placed inside a aps/FieldSet. |
| value | string | 0 | Number or percentage indicating amount of task completed. |
| visible | boolean | true | If this property value is set to true, then the widget is visible. |
Text in progressBar control. Default value: “completed”.
This specifies the widget width that is relevant only for widgets inside Container, FieldSet, or Tiles. In other cases it will be ignored.
gridSize string contains few options with number values (from 1 to 12) separated by spaces, which specify the grid size of the widget in different layouts:
- md - desktop
- xs - phone
For example, gridSize: “md-4 xs-2”.
All values below 1, e.g. “md-0”, will be replaced with the empty string (“”), values above 12, e.g. “md-14”, will be reduced to 12 (“md-12”).
Default value: undefined.
Used for indeterminate progress bar when display is in high contrast mode. Default value: {setAttribute: function(){}}.
Text that is shown as a label if the widget is placed inside a aps/FieldSet.
Default value: “”.
Number or percentage indicating amount of task completed. With “%”: percentage value, 0% <= progress <= 100%, or without “%”: absolute value, 0 <= progress <= maximum. Infinity means that the progress bar is indeterminate. Default value: “0”.
If this property value is set to true, then the widget is visible.
Default value: true.
| METHOD | RETURN | DESCRIPTION |
|---|---|---|
| cancel () | object
|
Sets the isBusy property to false |
| destroy () | undefined
|
Destroys this widget |
| get () | any
|
Get a property of the Stateful instance |
| getParents () | array
|
Discover and return all parents of the widget |
| placeAt () | dijit/_widgetbase
function
|
Place this widget somewhere in the DOM based on standard dojo/dom-construct::place() conventions |
| set () | object
function
|
Set a property of the Stateful instance |
| startup () | undefined
|
Gets started after the DOM fragment is added to the document |
Destroys this widget. Will also destroy any resources (including widgets) registered via this.own(). This method will also destroy internal widgets such as those created from a template.
Return: undefined
Get a property of the Stateful instance. Get a named property of the Stateful object. The property may potentially be retrieved via a getter method in subclasses.
In the base class, this just retrieves the object’s property.
Return: any
Place this widget somewhere in the DOM based on standard dojo/dom-construct::place() conventions. A convenience function providing a simple shorthand mechanism to put an existing (or newly created) widget somewhere in the DOM, and allow chaining.
Return: dijit/_widgetbase function
Set a property of the Stateful instance. Sets named properties of the stateful object and notifies the watchers of the property. A programmatic setter may be defined in subclasses.
Return: object function
Gets started after the DOM fragment is added to the document Called after the widget and its children have been created and added to the page, and all related widgets have finished their create() cycle, up through postCreate().
Note that startup() may be called while the widget is still hidden, for example if the widget is inside a hidden dijit/Dialog or an unselected tab of a dijit/layout/TabContainer. For widgets that need to do layout, it’s best to put that layout code inside resize(), and then extend dijit/layout/_LayoutWidget so that resize() is called when the widget is visible.
Return: undefined
| EVENT | RETURN | DESCRIPTION |
|---|---|---|
| onClick () | undefined
|
The method is called when a user clicks on the widget |
The method is called when a user clicks on the widget.