Wijmo UI for the Web
wijprogressbar jQuery Widget
Let end users see the progress of an operation in an indicator with customized animations, styles, labels, and more.
Syntax
Javascript (Usage) 
$(function () {
    var options; // Type:  wijmo.progressbar.wijprogressbar.options
     
    $(".selector").wijprogressbar(options);
});
Javascript (Specification) 
function wijprogressbar() : any;
Browser Compatibility
7
5
5
Options
 NameDescription
public OptionanimationDelay

Default value: 0

Gets or sets the delay time of the progress bar's animation in milliseconds. The default value of this option is "0".

 
public OptionanimationOptions

The options parameter of the jQuery's animation.

 
public Optionchange  
public Optioncomplete  
public Optioncreate  
public Optiondisabled  
public OptionfillDirection

Default value: 'east'

The fill direction of the progress bar.the value should be "east", "west", "north" or "south".

 
public OptionindicatorImage

Default value: ""

The Url of the image's indicator.

 
public OptionindicatorIncrement

Default value: 1

The increment of the progress bar's indicator.

 
public OptionlabelAlign

Default value: 'center'

The label's alignment on the progress bar. The value should be "east", "west", "center", "north", "south" or "running".

 
public OptionlabelFormatString

Default value: 'undefined%'

Sets the format of the label text.

 
public Optionmax  
public OptionmaxValue

Default value: 100

The value of the progress bar,the type should be numeric.

 
public OptionminValue

Default value: 0

The minimum value of the progress bar,the type should be numeric.

 
public OptiontoolTipFormatString

Default value: 'undefined%'

Set the format of the ToolTip of the progress bar,the expression of the format like the labelFormatString. ,'undefined%').

 
public Optionvalue

Default value: 0

The value of the progressbar.

 
Top
Methods
 NameDescription
public MethoddestroyRemoves the wijprogressbar functionality completely. This returns the element to its pre-init state.  
public Methoddisable  
public Methodenable  
public Methodoption  
public MethodvalueSets the current value of the progressbar.  
public Methodwidget  
Top
Events
 NameDescription
public EventbeforeProgressChanging

The event that raises before running the ProgressBar. The parameters are an object:

{oldValue:xxx,newValue:xxx} 

Return "false" to prevent the ProgressBar from running.

 
public EventprogressChanged

The event that raises when the ProgressBar changes. The parameter is an object:

{oldValue:xxx,newValue:xxx}
 
public EventprogressChanging

The event that raises upon running the ProgressBar. The parameter is an object:

{oldValue:xxx,newValue:xxx}

Return false to cancel the event and stop the ProgressBar from running.

 
Top

See Also

Widgets

ProgressBar

Reference

wijprogressbar jQuery Widget

 

 


© 2013 All Rights Reserved.

Send comments on this topic.