Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SliderProperties

Hierarchy

Index

Properties

Optional container

container: string | HTMLElement

The ID or node representing the DOM element containing the widget.

Read more...

Optional disabled

disabled: boolean

When true, sets the slider to a disabled state so the user cannot interact with it.

Read more...

Optional draggableSegmentsEnabled

draggableSegmentsEnabled: boolean

Indicates if the user can drag the segment between thumbs to update thumb positions.

Read more...

Optional id

id: string

The unique ID assigned to the widget when the widget is created.

Read more...

Optional inputCreatedFunction

inputCreatedFunction: InputCreatedFunction

A function that provides the developer with access to the input elements when rangeLabelInputsEnabled and/or labelInputsEnabled are set to true.

Read more...

Optional inputFormatFunction

inputFormatFunction: SliderLabelFormatter

A function used to format user inputs.

Read more...

Optional inputParseFunction

inputParseFunction: InputParser

Function used to parse slider inputs formatted by the inputFormatFunction.

Read more...

Optional label

label: string

The widget's label.

Read more...

Optional labelFormatFunction

labelFormatFunction: SliderLabelFormatter

A function used to format labels.

Read more...

Optional labelInputsEnabled

labelInputsEnabled: boolean

Indicates whether to enable editing input values via keyboard input when the user clicks a label.

Read more...

Optional labelsVisible

labelsVisible: boolean

Indicates whether to display labels alongside slider thumbs.

Read more...

Optional layout

layout: "horizontal" | "vertical" | "horizontal-reversed" | "vertical-reversed"

Determines the layout/orientation of the Slider widget.

Read more...

Optional max

max: number

The maximum possible data/thumb value of the slider.

Read more...

Optional min

min: number

The minimum possible data/thumb value of the slider.

Read more...

Optional precision

precision: number

Defines how slider thumb values should be rounded.

Read more...

Optional rangeLabelInputsEnabled

rangeLabelInputsEnabled: boolean

Indicates whether to enable editing range values via keyboard input when the user clicks a min or max label.

Read more...

Optional rangeLabelsVisible

rangeLabelsVisible: boolean

Indicates whether to display min or max range values on the slider.

Read more...

Optional snapOnClickEnabled

snapOnClickEnabled: boolean

Indicates if the closest thumb will snap to the clicked location on the track.

Read more...

Optional steps

steps: number | number[]

Sets steps, or intervals, on the slider that restrict user input to specific values.

Read more...

Optional syncedSegmentsEnabled

syncedSegmentsEnabled: boolean

When true, all segments will sync together in updating thumb values when the user drags any segment.

Read more...

Optional thumbCreatedFunction

thumbCreatedFunction: ThumbCreatedFunction

Function that executes each time a thumb is created on the slider.

Read more...

Optional thumbsConstrained

thumbsConstrained: boolean

When false, the user can freely move any slider thumb to any position along the track.

Read more...

Optional tickConfigs

tickConfigs: TickConfig[]

When set, renders ticks along the slider track.

Read more...

Optional trackElement

trackElement: HTMLElement

The HTML Element node representing the slider track.

Read more...

Optional values

values: number[]

An array of numbers representing absolute thumb positions on the slider.

Read more...

Optional viewModel

The view model for the Slider widget.

Read more...

Optional visible

visible: boolean

Indicates whether the widget is visible.

Read more...

Optional visibleElements

visibleElements: SliderVisibleElements

The visible elements that are displayed within the widget.

Read more...

Generated using TypeDoc