Class: Slider

Slider

The Slider Control is used to display and/or change a numeric value visually, instead of having to manually enter it. A Slider control provides the following configuration properties in Process Designer:

Formula

Value Formula: Formula/expression to use when calculating slider values automatically string

Behavior

Minimum: Minimum value in slider range decimal
Maximum: Maximum value in slider range decimal
Step: Slider value step size decimal
Tab Index: Form control tabbing sequence index. Tab indices start at 1, and may be set sparsely. integer

Appearance

Vertical: When selected, slider will be vertical, instead of horizontal boolean
Color Style: Set the color styling of the slider control
{Default | Primary | Info | Success | Warning | Danger}
string
Height: Slider height, in px or em string
Width: Width in px, %, em For example: 50px, 20%, 0.4em. If no unit is specified, px is assumed string
Border Radius: Radius of curvature for corners of slider bar string
Handle Width: Width in px, em. For example: 50px, 0.4em. If no unit is specified, px is assumed (% should be avoided) string
Handle Radius: Radius of curvature for corners of the handle string

Events

On Load:
Description: Triggers when control loads
Example:
me.setValue(50)
On Change:
Description: This event is fired when the slider value is changed.
Example:
if (newVal > 50) {${icon}.setIcon("smile-o");} else {${icon}.setIcon("frown-o");}
Context Variables newVal {numeric} oldVal {numeric}

new Slider()

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");

focus()

Set focus on this control
Retrieve bound data associated this view/control. Only works for views/controls with bound data.
Returns:
Type Description
Object Value of bound data. undefined if the view has no data binding.
Example
var dec1 = MyDecimal.getData();

getTabIndex(){integer}

Get tab index for text control
Returns:
Type Description
integer

getType(){string}

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

getValue(){numeric}

Get the current value this control is set to
Returns:
Type Description
numeric
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();
Returns the valid status as last set by the setValid() method.
Returns:
Type Description
boolean Validity status. true if setValid(false, ...) was never called
Example
var valid = MyView.isValid();
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);
Only for formula-enabled views!
Explicitly triggers the re-evaluation of the formula for this view (if a formula has been specified). If the view is not formula-enabled, recalculate() does nothing.
Example
Text1.recalculate(); //If the formula for Text1 is: new Date().toString(), Text1 is updated to the current date/time
Set/update bound data associated this view/control. Only works for views/controls with bound data.
Name Type Description
value Object Value of bound data. The type of this parameter must match the type of the bound data.
Example
MyView.setData("TEST"); //Updates bound data to the string 'TEST'
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

setTabIndex(tabIndex)

Sets tab index of text control
Name Type Description
tabIndex integer Tab indices start at 1 and may be set sparsely
Flag this view/control as valid or invalid
Name Type Description
valid boolean Valid/invalid flag (true to set view valid, false to make it invalid - which typically shows the view with "invalid" styling and indicator)
errorText string Validation error text to show on the invalid-styled view
Example
MyView.setValid(false, "Please fix your data entry"); //Make MyView invalid

setValue(val)

Sets the value of the control
Name Type Description
val numeric Value to set control to
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"
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();