Progress bar
Provides a visual representation of how far a user is into completing a particular operation.
Appearance
Color style: | Color-based styling for this view {Default | Primary | Info | Success | Warning | Danger} |
TooltipColorStyle |
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: | The roundness of the corners of the progress bar | String |
Width: | The width in px, % or em.\r\nFor example\: 50px, 20%, 0.4em. If no unit is specified, px is assumed. | String |
Height: | Height in px, em\r\nFor example\: 50px, 0.4em. If no unit is specified, px is assumed | 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 |
Formula
Progress formula: | The formula or expression to calculate progress. | String |
Events | ||||||
On Load: |
| |||||
On Load: |
|
Extends:
Methods:
Inherited
addClass(name, [replaced])
Add/replace CSS class(es) for this control
Name | Type | Default | 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} | 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()
Returns:
{string}
Get configured height for progressBar (including unit)
getProgress()
Returns:
{decimal}
Gets the current value associated with the Progress Bar.
getType()
Returns:
{string}
Get descriptive string representing the type of control
getWidth()
Returns:
{string}
Get configured width for progressBar (including unit)
Inherited
hide(collapseFlag)
Hide this view/control
Name | Type | Default | Description |
collapseFlag | {boolean} | Set to true to collapse the view (equivalent to a view setting of "NONE") |
Example
MyView.hide(); |
Inherited
isBound()
Returns:
{boolean}
Indicates bound status of control.
Inherited
isEnabled()
Returns:
{boolean}
Checks if the view is enabled or not
Example
var enabled = MyView.isEnabled(); |
Inherited
isVisible()
Returns:
{boolean}
Checks whether or not view is visible
Example
var visible = MyView.isVisible(); |
Inherited
propagateUpValueChange(event)
Returns:
{boolean}
Propagates value change of control up through parent views
Name | Type | Default | Description |
event | {Event} | Value change event (usually an onchange event) |
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 | Default | Description |
style | {string} | "DEFAULT"|"DEF"|"D"=Default | "PRIMARY"|"P"=Primary | "INFO"|INF"|"I"=Info | "SUCCESS"|"S"=Success | "WARNING"|"WARN"|"W"=Warning | "DANGER"|"G"=Danger |
Inherited
setEnabled(enabled, required)
Enable/disable this view/control
Name | Type | Default | 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(null)
Set height of progressBar (e.g. 50px, 20%, 2em - omitting the unit assumes px)
Name | Type | Default | Description |
{string} | height |
setMaximum(value)
Sets the maximum value associated with the progress bar
Name | Type | Default | 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 | Default | Description |
value | {decimal} | Progress of bar |
setRadius(radius)
Sets radius (roundness) of progressBar
Name | Type | Default | Description |
radius | {string} | Radius of curvature for progress bar corners |
Inherited
setViewData(data, createPseudoBinding)
Set/update bound data associated this view/control. Only works for views/controls with bound data.
Note: Should only be used with simple type bindings, or complex type bindings with simple type properties.
Should not be used with bindings that have properties that are lists or compext types. For complex types, set bindings using
the
Note: Should only be used with simple type bindings, or complex type bindings with simple type properties.
Should not be used with bindings that have properties that are lists or compext types. For complex types, set bindings using
the
binding.set
pattern detailed in the Knowlege Center section Binding Data and Configuration OptionsName | Type | Default | Description |
data | {Object} | Value of bound data. The type of this parameter must match the type of the bound data. | |
createPseudoBinding | {boolean} | If set to true, creates a pseudo binding if there is no current binding. |
Example
MyView.setViewData("TEST"); //Updates bound data to the string 'TEST' |
Inherited
setVisible(visible, collapse)
Show/hide this view/control
Name | Type | Default | 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(null)
Set width of progressBar (e.g. 50px, 20%, 2em - omitting the unit assumes px)
Name | Type | Default | Description |
{string} | width |
Inherited
show()
Show this view/control
Example
MyView.show(); |
Inherited
triggerFormulaUpdates([phase])
Broadcasts the expression trigger for the specified view
Name | Type | Default | Description |
phase | {int} | bpmext.ui.PHASE_NORMAL | The phase we are currently in |
Example
MyView.triggerFormulaUpdates(); |