The HorizontalSlider widget lets the user select a value with a horizontally draggable handle. It allows the user to change an integer value.


  • UI Type:

Extends: BaseWidget

Properties

Name Desciption
Click to selectAllows clicking the slider to select a value (if disabled, values can only be selected using the left/right arrow buttons).
Disable HotKeysPrevent the widget from being controlled using keyboard hot-keys.
DisabledThe widget cannot be used.
Display ValueDisplay Widget value.
HiddenHides the widget from the user.
Maximum valueThe maximum selectable value of the slider.
Minimum valueThe minimum selectable value of the slider.
Show ButtonsShows left/right arrow buttons at the edges of the horizontal slider.
Tab IndexThe Tab Index is an integer that tells the order of the widget when using the tab-key to move from one widget to another.
Total stepsTotal steps between minimum and maximum value. 0 is considered as undefined.

Style

Name Desciption
Background-colorChange background color of the widget.
ColorColor of the text inside the widgets. May not apply to all text inside all widgets.
Font SizeSet the font size in pixels for text.
Progress bar backgroundThe background color of the progress bar.
Slider nozzle backgroundThe background color of the nozzle of the progress bar.
Slider nozzle radiusThe border radius of the nozzle of the progress bar.
Square/Round slider nozzleEnable to make the nozzle circular in the progress bar.
Text-alignmentSet left, centered or right. Applies both to icon and text.
Value background colorThe background color of the value text box.

Events

Name Description Event Attribute
Blur Event when a widget goes out of focus.
Change Event triggered after the element has finished changing.
event The current value of the HorizontalSlider.
oldval The old value of the HorizontalSlider.
Click Event that triggers based on touch or click.
event The event that triggered the handler.
DblClick Event that triggers based on double click.
event The event that triggered the handler.
Focus Event when indicating/ highlighting widget using the cursor.

Function

blur ( )

Triggers the blur event.

focus ( )

Triggers the focus event.

get ( name: String ) →{ Object }

Gets the value of the specified property.

Parameters
Name Type Description
name String The name of the property.
Returns

The property's value.

getId ( ) →{ ID }

Returns the ID of the widget.

Returns

The ID of the widget

getValue ( ) →{ Object }

Returns the widget's value.

Returns

The widget's value.

hide ( )

Hides the widget.

isEnabled ( ) →{ Boolean }

Returns true if the widget is enabled.

Returns

True if enabled, otherwise false.

isHidden ( ) →{ Boolean }

Returns true if the widget is hidden.

Returns

True if hidden, otherwise false.

set ( name: String , value: Object )

Sets the value of the specified property.

Parameters
Name Type Description
name String The name of the property.
value Object The new value.

setEnabled ( Enabled: Boolean )

Enables/disables the widget.

Parameters
Name Type Description
Enabled Boolean True to enable the widget, false to disable.

setStyle ( Object: Object )

Set the widget-style

Parameters
Name Type Description
Object Object properties

setValue ( value: Object )

Sets the widget's value.

Parameters
Name Type Description
value Object The new value.

show ( )

Shows the widget.