Class: ProgressBar

ProgressBar~ProgressBar(elParentopt, step, settingsopt)

new ProgressBar(elParentopt, step, settingsopt)

Creates a progress bar element on your web page.
Parameters:
Name Type Attributes Default Description
elParent HTMLElement <optional>
 parent element. ProgressBar is not visible if elParent is undefined.
step function The step(progressBar, i) function to be executed asynchronous during progress. 
parameter progressBar: this ProgressBar instance.
parameter i: current iteration index.
parameter params: User defined parameters that can passed from params of the step method.
settings object <optional>
 {} The following settings are available
Properties
Name Type Attributes Default Description
sTitle string <optional>
 "" Progress bar title.
min number <optional>
 0 The lowest value in the range of permitted values.
max number <optional>
 1 The greatest value in the range of permitted values.
iterationCount number <optional>
 Count of calling of the step function from settings.min to settings.iterationCount.
timeoutPeriod number <optional>
 0 You can call the step function asynchronous or directly. Directly calling of the step function decreases the execute time but your web page froze during executing. For example if timeoutPeriod parameter is 3, then the step function will be called 3 times directly and one time asynchronous. If timeoutPeriod parameter is 0, then the step function will be called permanently as asynchronous.
Source:

Members

value

set new value of the progress bar
Source:

Methods

newStep(stepFunction)

set new step function
Parameters:
Name Type Description
stepFunction function New step function. See the ProgressBar constructor's step parameter.
Source:

remove()

remove progress bar from your web page.
Source:

step(paramsopt)

Execute the next step asynchronously.
Parameters:
Name Type Attributes Description
params Object <optional>
 User defined parameters that will be passed to the params of the step function of the ProgressBar constructor.
Source:

title(newTitle)

set new title
Parameters:
Name Type Description
newTitle string
Source: