API

###progressJs([targetElm])

Creating an ProgressJS object.

Available since: v0.1.0

Parameters:

• targetElm : String (optional) Should be defined to start progress-bar for specific element, for example: #targetElement.

Returns:

• progressJs object.

Example:

progressJs() //without selector, set progress-bar for whole page
progressJs("#targetElement") //start progress-bar for element id='targetElement'

---

###progressJs.start()

Start the progress-bar for defined element(s).

Available since: v0.1.0

Returns:

• progressJs object.

Example:

progressJs().start()

---

###progressJs.set(percent)

Set specific percentage to progress-bar

Available since: v0.1.0

Parameters:

• percent: Number
  Set to specific percentage

Returns:

• progressJs object.

Example:

progressJs().set(20); //set progress to 20%

---

###progressJs.autoIncrease(size, millisecond)

Set an auto-increase timer for the progress-bar.

Available since: v0.1.0

Parameters:

• size: Number
  The size of increment when timer elapsed

• millisecond: Number
  Timer in milliseconds

Returns:

• progressJs object.

Example:

progressJs().start().autoIncrease(4, 500); //every 500 milliseconds, percentage + 4

---

###progressJs.increase([size])

Increase the progress-bar bar specified size. Default size is 1.

Available since: v0.1.0

Parameters:

• size: Number
  The size of increment

Returns:

• progressJs object.

Example:

progressJs().increase(); //increase one percent
progressJs().increase(2); //increase two percent

---

###progressJs.setOption(option, value)

Set a single option to progressJs object.

Available since: v0.1.0

Parameters:

• option : String
  Option key name.

• value : String/Number
  Value of the option.

Returns:

• progressJs object.

Example:

progressJs().setOption("theme", "black");

---

###progressJs.setOptions(options)

Set a group of options to the progressJs object.

Available since: v0.1.0

Parameters:

• options : Object
  Object that contains option keys with values.

Returns:

• progressJs object.

Example:

progressJs().setOptions({ 'theme': 'black', 'overlayMode': true });

---