Class: ProgressBar

ProgressBar

The Progress Bar control offers a visual representation of a users progress completing a particular page.  This visual display gives the user an immediate understanding of how many tabs, pages, or input fields have been completed. A ProgressBar control provides the following configuration properties in Process Designer:

Formula

Progress Formula: Formula/expression to use for calculating progress string

Behavior

Max Value: Value that constitutes 100% of bar filled. Note that progress can go past this value, but will not be apparent. decimal

Appearance

Color Style: Color-based styling for this control
{Default | Primary | Info | Success | Warning | Danger}
string
Striped: Set stripes on the progress bar. boolean
Active: Make the stripes within the progress bar move (only has an effect when Striped is true). boolean
Radius: Set the roundness of the corners of the progress bar string
Width: Width in px, %, em For example: 50px, 20%, 0.4em. If no unit is specified, px is assumed string
Height: Height in px, em For example: 50px, 0.4em. If no unit is specified, px is assumed string

Events

On Load:
Description: Triggers whenever the view is loaded.
Example:
me.setProgress(100)
On Load:
Description: Triggers whenever the view is loaded.
Example:
me.setProgress(0)
Article(s)
Progress Bar

new ProgressBar()

This constructor is never used explicitly.

Extends

Members

Methods

Add/replace CSS class(es) for this control
Name Type Description
name string CSS class name(s) to add to the control. Separate class names by a space if more than one class.
replaced string optional CSS class name(s) to be replaced by the first argument. Separate class names by a space if more than one class.
Example
Button.addClass("green");

getHeight(){string}

Get configured height for progressBar (including unit)
Returns:
Type Description
string

getProgress(){decimal}

Gets the current value associated with the Progress Bar.
Returns:
Type Description
decimal

getType(){string}

Get descriptive string representing the type of control
Returns:
Type Description
string

getWidth(){string}

Get configured width for progressBar (including unit)
Returns:
Type Description
string
Hide this view/control
Name Type Description
collapseFlag boolean Set to true to collapse the view (equivalent to a view setting of "NONE")
Example
MyView.hide();
Indicates bound status of control.
Returns:
Type Description
boolean True if the control is bound to coach data.
Checks if the view is enabled or not
Returns:
Type Description
boolean Enabled status
Example
var enabled = MyView.isEnabled();
Checks whether or not view is visible
Returns:
Type Description
boolean Visibility status
Example
var visible = MyView.isVisible();
Propagates value change of control up through parent views
Name Type Description
event Event Value change event (usually an onchange event)
Returns:
Type Description
boolean True if a formula update was triggered on the control's parent, otherwise false
Example
MyView.propagateUp(event);

setColorStyle(style)

Sets color style of progressBar. NOTE: to avoid ambiguity always set the color using "D"|"P"|"I"|"S"|"W"|"G"
Name Type Description
style string "DEFAULT"|"DEF"|"D"=Default | "PRIMARY"|"P"=Primary | "INFO"|INF"|"I"=Info | "SUCCESS"|"S"=Success | "WARNING"|"WARN"|"W"=Warning | "DANGER"|"G"=Danger
Enable/disable this view/control
Name Type Description
enabled boolean Enabled/read-only flag (true to enable view, false to disable/make read-only)
required boolean Enable/disable required field flag for control
Example
MyView.setEnabled(false); //Make MyView read-only

setHeight(height)

Set height of progressBar (e.g. 50px, 20%, 2em - omitting the unit assumes px)
Name Type Description
height string

setMaximum(value)

Sets the maximum value associated with the progress bar
Name Type Description
value decimal Maximum value of bar (what constitutes 100%). Note that it is possible for progress to be set past this value, though it will not be apparent.

setProgress(value)

Sets progress status
Name Type Description
value decimal Progress of bar

setRadius(radius)

Sets radius (roundness) of progressBar
Name Type Description
radius string Radius of curvature for progress bar corners
Show/hide this view/control
Name Type Description
visible boolean Visibility flag (true to show view, false to hide)
collapse boolean Set to true to collapse the control space when visible is set to false.
Examples
MyView.setVisible(false, false); //Equivalent to MyView.hide()
MyView.setVisible(false, true); // Sets visibility to "None"

setWidth(width)

Set width of progressBar (e.g. 50px, 20%, 2em - omitting the unit assumes px)
Name Type Description
width string
Show this view/control
Example
MyView.show();
Broadcasts the expression trigger for the specified view
Name Type Default Description
phase int bpmext.ui.PHASE_NORMAL optional The phase we are currently in
Example
MyView.triggerFormulaUpdates();