SliderHorizontal

(esrith/amos/form/SliderHorizontal)

SliderHorizontal control is a normal slider which can be use like volume control, track bar, etc.

Description
Type Description
lockSlideBar Boolean

if lockSlideBar is true, user cannot slide/move button on slider. However, developer can still move slider by setting "value" property.

maximum Number

maximum value of slider. Maximum value cannot be lower than or equal to minimum. after maximum is set, the position slider button will not changed. Instead, the value of slider will changed to make the button be in the same position.

minimum Number

minimum value of slider. Minimum value cannot be higher than or equal to maximum. after minimum is set, the position slider button will not changed. Instead, the value of slider will changed to make the button be in the same position.

showDecreaseButton Boolean

showDecreaseButton uses to toggle the show/hide decrease button.

showIncreaseButton Boolean

showIncreaseButton uses to toggle the show/hide increase button.

stepSize Number

Step size when user uses increse/decrease button

value Number

Value of slide box associated to button position. value will be between minimum and maximum value.

Return type Description
setMinMax(NumberNumber) None

set new minimum, maximum rage. Use this method if you want to change minimum, maximum in the same time. after minimum, maximum is set, the position slider button will not changed. Instead, the value of slider will changed to make the button be in the same position.

Description
slideBox_Click

The event fires when user left-mouse down on the slider.

slideButton_BeginClick

The event fires when user left-mouse down on the button.

slideButton_BeginSlide

The event fires when user begin to slide the button.

slideButton_Click

The event fires when user left-mouse down and left-mouse up on the button at the same position.

slideButton_EndSlide

The event fires when user stop sliding the button.

slideButton_ValueChange

The event fires when button value change. This can occur when slider button position is changed, or user changed minimum, maximum value of slider.

Constructors Detail
Properties Detail
<Boolean>
lockSlideBar

if lockSlideBar is true, user cannot slide/move button on slider. However, developer can still move slider by setting "value" property.

<Number>
maximum

maximum value of slider. Maximum value cannot be lower than or equal to minimum. after maximum is set, the position slider button will not changed. Instead, the value of slider will changed to make the button be in the same position.

<Number>
minimum

minimum value of slider. Minimum value cannot be higher than or equal to maximum. after minimum is set, the position slider button will not changed. Instead, the value of slider will changed to make the button be in the same position.

<Boolean>
showDecreaseButton

showDecreaseButton uses to toggle the show/hide decrease button.

<Boolean>
showIncreaseButton

showIncreaseButton uses to toggle the show/hide increase button.

<Number>
stepSize

Step size when user uses increse/decrease button

<Number>
value

Inherited from _SliderBase but overwritten in esrith/amos/core/_SliderBase.js:168

Value of slide box associated to button position. value will be between minimum and maximum value.

Methods Detail
setMinMax
(
  • Number
  • Number
)

set new minimum, maximum rage. Use this method if you want to change minimum, maximum in the same time. after minimum, maximum is set, the position slider button will not changed. Instead, the value of slider will changed to make the button be in the same position.

Parameters
  • <Object> Number Required

    minimum the minimum value of slider

  • <Object> Number Required

    maximum the maximum value of slider

Events Detail
slideBox_Click

The event fires when user left-mouse down on the slider.

Event Payload:
  • <Object> evt

    -javascript event object

slideButton_BeginClick

The event fires when user left-mouse down on the button.

Event Payload:
  • <Object> evt

    -javascript event object

slideButton_BeginSlide

The event fires when user begin to slide the button.

Event Payload:
  • <Object> evt

    -javascript event object

slideButton_Click

The event fires when user left-mouse down and left-mouse up on the button at the same position.

Event Payload:
  • <Object> evt

    -javascript event object

slideButton_EndSlide

The event fires when user stop sliding the button.

Event Payload:
  • <Object> evt

    -javascript event object

slideButton_ValueChange

The event fires when button value change. This can occur when slider button position is changed, or user changed minimum, maximum value of slider.

Event Payload:
  • <Object> Number

    oldValue value before change.

  • <Object> Number

    value new value.