Class GSSlider

A slider control.

Class Summary
Constructor Attributes Constructor Name and Description
 
GSSlider(parent, options)
Creates a new GSSlider
Method Summary
Method Attributes Method Name and Description
 
Returns the slider element
 
Returns the current slider value
 
setValue(val, animate)
Sets the value of the slider
Class Detail
GSSlider(parent, options)
Creates a new GSSlider
Parameters:
{HTMLElement} parent
the checkbox parent element
{Object} options Optional
an object literal specifying the checkbox options to set:
{int} options.value
the initial value for the slider, defaults to 0
{int} options.min
the minimum value for the slider, defaults to 0
{int} options.max
the maximum value for the slider, defaults to 100
{int} options.stepInterval
the size of each interval the slider takes between min and max. The full specified value range of the slider (max - min) needs to be evenly divisible by the step.
{boolean} options.showDataTip
if true a tooltip will be displayed above the slider thumb while dragging with the current slider value, defaults to true
Method Detail
{HTMLElement} getElement()
Returns the slider element
Returns:
{HTMLElement} the slider element

{int} getValue()
Returns the current slider value
Returns:
{int} the current slider value

setValue(val, animate)
Sets the value of the slider
Parameters:
val
the value of the slider to set
{boolean} animate
animate the slider thumb

Documentation generated by JsDoc Toolkit 2.3.2 on Wed Mar 07 2012 11:47:30 GMT+1300 (NZDT)