Authors:Yoshiroh Kamiyama
Developers:Yoshiroh Kamiyama

ProgressIndicator is a round spinning graphical representation that indicates the current task is on-going.


The spinning object is NOT an animated gif, but a collection of div elements. Non-CSS3 browsers do not have ability to rotate dom nodes. In that case, the indicator becomes a rectangle shape, not a round shape.


ProgressIndicator is not a widget. It is a singleton class. An instance of this class can be obtained by calling The start() method of ProgressIndicator starts spinning, and the stop() method stops spinning. You need to explicitly add ProgressIndicator.domNode to somewhere visible. The stop() method automatically removes ProgressIndicator.domNode from the dom tree for you.

Constructor Parameters

Parameter Type Default Description
interval Number 100 The time interval in milliseconds for updating the spinning indicator.
colors Array   An array of indicator colors.

Method Detail


Starts the ProgressIndicator spinning.


Stop the ProgressIndicator spinning.

setImage(/*String*/ file)

Set an indicator icon image file (typically animated GIF). If null is specified, restores the default spinner.

file - a path for an indicator icon image file


In this example, get the progress indicator instance using getInstance(), add it to the current dom tree, and call the start() method to start spinning of the progress indicator. In the load() handler of dojo.xhr, call the stop() method to stop spinning and remove it from the dom tree.

function loadPage(){
  var prog =;
  prog.start(); // start the progress indicator

    url: url,
    handleAs: "text",
    load: function(response, ioArgs){
      prog.stop(); // stop the progress indicator
      container.innerHTML = response;;
Error in the documentation? Can’t find what you are looking for? Let us know!