Slider

(part of package 'Servoy Extra Components') Extends designtime/SolutionModel: JSWebComponent Extends runtime: RuntimeWebComponent

This is a reference page; many components have detailed usage guides here.

Properties

autoHideLimitLabels

Set to false to disable the auto-hiding behavior of the limit labels

Type: boolean Default Value: false


ceil

Maximum value for a slider

Type: int Default Value: null


dataChangeOnSlideEnd

Set this to false to update the dataProvider(s) while the user drags the slider and not only when the user is done dragging

Type: boolean Default Value: true


dataProvider

The dataProvider for the slider value

Type: dataprovider


dataProviderHigh

The dataProvider for a range slider's maximum value

Type: dataprovider


draggableRange

When set to true and using a range slider, the range can be dragged by the selection bar

Type: boolean Default Value: false


draggableRangeOnly

Same as draggableRange but the slider range can't be changed

Type: boolean Default Value: false


enabled

Type: enabled Default Value: true


enforceRange

Set to true to round the value and valueHigh to the slider range

Type: boolean Default Value: false


enforceStep

Set to true to force the value to be rounded to the step

Type: boolean Default Value: false


floor

Minimum value for a slider

Type: int Default Value: 0


formattingFunction

Can be given a function code as string that can be used to format numbers client side.

Type: tagstring


getLegendFunction

Can be given a function code as string that can be used to display legend under ticks

Type: clientfunction


hideLimitLabels

Set to true to hide min / max labels

Type: boolean Default Value: false


hidePointerLabels

Set to true to hide pointer labels

Type: boolean Default Value: false


logScale

Set to true to use a logarithmic scale to display the slider

Type: boolean Default Value: false


maxLimit

The maximum value authorized on the slider.

Type: int Default Value: null


maxRange

The maximum range authorized on the slider.

Type: int Default Value: null


minLimit

The minimum value authorized on the slider.

Type: int Default Value: null


minRange

The minimum range authorized on the slider.

Type: int Default Value: null


noSwitching

Set to true to prevent to user from switching the min and max handles

Type: boolean Default Value: false


numberFormat

A Servoy number format that is used to format numbers when a formattingFunction is not provided

Type: format


pointerColorFunction

Function provided as a String that returns the color of a tick.

Type: clientfunction


precision

The precision to display values with.

Type: int Default Value: 0


pushRange

Set to true to have a push behavior. When the min handle goes above the max, the max is moved as well

Type: boolean Default Value: false


readOnly

Type: protected Default Value: false


rightToLeft

Set to true to show graphs right to left.

Type: boolean Default Value: false


selectionBarColorFunction

Function code as String that returns the current color of the selection bar.

Type: clientfunction


selectionBarGradient

Use to display the selection bar as a gradient

Type: gradient


showOuterSelectionBars

Only for range slider. Set to true to visualize in different colour the areas on the left/right (top/bottom for vertical range slider) of selection bar between the handles

Type: boolean Default Value: false


showSelectionBar

Set to true to always show the selection bar before the slider handle

Type: boolean Default Value: false


showSelectionBarEnd

Set to true to always show the selection bar after the slider handle

Type: boolean Default Value: false


showTicks

Set to true to display a tick for each step of the slider

Type: boolean Default Value: false


showTicksValues

Set to true to display a tick and the step value for each step of the slider

Type: boolean Default Value: false


step

Step between each value

Type: int Default Value: 1


stepsArray

If you want to display a slider with non linear/number steps.

Type: int[]


stepsValueList

If you want to provide all the steps with display and real values, you can provide a value list to provide step values (realValues) and step labels (displayValues).

Type: valuelist


styleClass

Type: styleclass


tickColorFunction

Function provided as a String that returns the color of a tick.

Type: clientfunction


ticksArray

Use to display ticks at specific positions. The array contains the index of the ticks that should be displayed.

Type: int[]


ticksInterval

Number of steps between each tick to display ticks at intermediate positions. In Titanium Client you cannot select by click values between ticks, you can only drag slider pointer to select.

Type: int Default Value: null


ticksTooltipFunction

Function provided as string that returns the tooltip content for a tick.

Type: clientfunction


ticksValuesInterval

Number of steps between each tick to display tick values at intermediate positions

Type: int Default Value: 0


ticksValuesTooltipFunction

Function provided as string that returns the tooltip content for a tick value.

Type: clientfunction


vertical

Set to true to display the slider vertically.

Type: boolean Default Value: false


visible

Type: boolean Default Value: true


Events

onDataChangeHigh

Called when the dataProviderHigh value changed

Parameters:

oldValue ${dataproviderType} newValue ${dataproviderType} event JSEvent

Returns: boolean


onDataChangeMethodID

Called when the dataProvider value changed

Parameters:

oldValue ${dataproviderType} newValue ${dataproviderType} event JSEvent

Returns: boolean


onSlideEnd

Called when user stops dragging the slider

Parameters:

event JSEvent value object highValue object pointerType string


onSlideStart

Called when user starts dragging the slider

Parameters:

event JSEvent value object highValue object pointerType string


API

refresh

Refreshes the slider


Types

gradient

Last updated