dijit/ProgressBar.js

• Provides:

  • dijit.ProgressBar

• Requires:

  • dojo.fx in common
  • dojo.number in common
  • dijit._Widget in common
  • dijit._Templated in common

• dijit.ProgressBar

  • type

    Function

  • chains:
    • dijit._Widget: (prototype)
    • dijit._Templated.prototype: (prototype)
    • dijit._Widget: (call)
    • dijit._Templated: (call)
  • summary

    A progress indication widget, showing the amount completed
    (often the percentage completed) of a task.

  • example

    	<div dojoType="ProgressBar"
    		 places="0"
    		 value="..." maximum="...">
    	</div>

• dijit.ProgressBar.progress

  • tags: const
  • type

    String

  • summary

    (Percentage or Number)
    Number or percentage indicating amount of task completed.
    Deprecated.   Use "value" instead.

• dijit.ProgressBar.value

  • type

    String

  • summary

    (Percentage or Number)
    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.

• dijit.ProgressBar.maximum

  • tags: const
  • type

    Float

  • summary

    Max sample number

• dijit.ProgressBar.places

  • tags: const
  • type

    Number

  • summary

    Number of places to show in values; 0 by default

• dijit.ProgressBar.indeterminate

  • tags: const
  • type

    Boolean

  • summary

    If false: show progress value (number or percentage).
    If true: show that a process is underway but that the amount completed is unknown.
    Deprecated.   Use "value" instead.

• dijit.ProgressBar.label

  • optional
  • type

    String

  • summary

    Label on progress bar.   Defaults to percentage for determinate progress bar and
    blank for indeterminate progress bar.

• dijit.ProgressBar.name

  • type

    String

  • summary

    this is the field name (for a form) if set. This needs to be set if you want to use
    this widget in a dijit.form.Form widget (such as dijit.Dialog)

• dijit.ProgressBar.templateString

  • type

    Object

• dijit.ProgressBar._indeterminateHighContrastImagePath

  • tags:
  • type

    dojo._URL

  • summary

    URL to image to use for indeterminate progress bar when display is in high contrast mode

• dijit.ProgressBar.postMixInProperties

  • type

    Function

• dijit.ProgressBar.buildRendering

  • type

    Function

• dijit.ProgressBar.update

  • parameters:
    • attributes: (typeof Object)

      May provide progress and/or maximum properties on this parameter;
      see attribute specs for details.

  • summary

    Internal method to change attributes of ProgressBar, similar to set(hash).  Users should call
    set("value", ...) rather than calling this method directly.

  • example

    	myProgressBar.update({'indeterminate': true});
    	myProgressBar.update({'progress': 80});
    	myProgressBar.update({'indeterminate': true, label:"Loading ..." })

  • tags:
  • type

    Function

• dijit.ProgressBar.internalProgress

• dijit.ProgressBar.domNode

• dijit.ProgressBar.labelNode.innerHTML

  • type

    Object

• dijit.ProgressBar.internalProgress.style.width

  • type

    String

• dijit.ProgressBar._setValueAttr

  • parameters:
    • v
  • type

    Function

• dijit.ProgressBar._setLabelAttr

  • parameters:
    • label
  • type

    Function

• dijit.ProgressBar._setIndeterminateAttr

  • parameters:
    • indeterminate
  • type

    Function

• dijit.ProgressBar.report

  • parameters:
    • percent: (typeof float)
  • summary

    Generates message to show inside progress bar (normally indicating amount of task completed).
    May be overridden.

  • tags: extension
  • type

    Function

• dijit.ProgressBar.onChange

  • summary

    Callback fired when progress updates.

  • tags: extension
  • type

    Function

• dijit

  • type

    Object