Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

container

container: string | HTMLElement

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

Read more...

declaredClass

declaredClass: string

destroyed

destroyed: boolean

disabled

disabled: boolean

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

Read more...

draggableSegmentsEnabled

draggableSegmentsEnabled: boolean

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

Read more...

id

id: string

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

Read more...

initialized

initialized: boolean

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...

inputFormatFunction

inputFormatFunction: SliderLabelFormatter

A function used to format user inputs.

Read more...

inputParseFunction

inputParseFunction: InputParser

Function used to parse slider inputs formatted by the inputFormatFunction.

Read more...

label

label: string

The widget's label.

Read more...

Readonly labelElements

labelElements: Collection<HTMLElement>

The HTML Element nodes representing labels attached to slider thumbs.

Read more...

labelFormatFunction

labelFormatFunction: SliderLabelFormatter

A function used to format labels.

Read more...

labelInputsEnabled

labelInputsEnabled: boolean

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

Read more...

Readonly labels

labels: string[]

An array of strings associated with 'values' generated using an internal label formatter or the values returned from labelFormatFunction.

Read more...

labelsVisible

labelsVisible: boolean

Indicates whether to display labels alongside slider thumbs.

Read more...

layout

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

Determines the layout/orientation of the Slider widget.

Read more...

max

max: number

The maximum possible data/thumb value of the slider.

Read more...

Readonly maxLabelElement

maxLabelElement: HTMLElement

The HTML Element node representing the max value label.

Read more...

min

min: number

The minimum possible data/thumb value of the slider.

Read more...

Readonly minLabelElement

minLabelElement: HTMLElement

The HTML Element node representing the min value label.

Read more...

precision

precision: number

Defines how slider thumb values should be rounded.

Read more...

rangeLabelInputsEnabled

rangeLabelInputsEnabled: boolean

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

Read more...

rangeLabelsVisible

rangeLabelsVisible: boolean

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

Read more...

Readonly segmentElements

segmentElements: Collection<HTMLElement>

The HTML Element nodes representing interactive slider segments.

Read more...

snapOnClickEnabled

snapOnClickEnabled: boolean

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

Read more...

Readonly state

state: "disabled" | "ready" | "editing" | "dragging"

The current state of the widget.

Read more...

steps

steps: number | number[]

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

Read more...

syncedSegmentsEnabled

syncedSegmentsEnabled: boolean

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

Read more...

thumbCreatedFunction

thumbCreatedFunction: ThumbCreatedFunction

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

Read more...

Readonly thumbElements

thumbElements: Collection<HTMLElement>

The HTML Element nodes representing slider thumbs.

Read more...

thumbsConstrained

thumbsConstrained: boolean

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

Read more...

tickConfigs

tickConfigs: TickConfig[]

When set, renders ticks along the slider track.

Read more...

Readonly tickElements

The HTML Element nodes representing slider ticks and their associated labels.

Read more...

trackElement

trackElement: HTMLElement

The HTML Element node representing the slider track.

Read more...

values

values: number[]

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

Read more...

viewModel

viewModel: SliderViewModel

The view model for the Slider widget.

Read more...

visible

visible: boolean

Indicates whether the widget is visible.

Read more...

visibleElements

visibleElements: SliderVisibleElements

The visible elements that are displayed within the widget.

Read more...

Methods

Protected _get

  • _get(propertyName: string): any
  • _get<T>(propertyName: string): T
  • Parameters

    • propertyName: string

    Returns any

  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

Protected _set

  • _set<T>(propertyName: string, value: T): Slider
  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns Slider

classes

  • classes(...classNames: any[]): string
  • A utility method used for building the value for a widget's class property.

    Read more...

    Parameters

    • Rest ...classNames: any[]

    Returns string

destroy

  • destroy(): void
  • Destroys the widget instance.

    Read more...

    Returns void

emit

  • emit(type: string, event?: any): boolean
  • Emits an event on the instance.

    Read more...

    Parameters

    • type: string
    • Optional event: any

    Returns boolean

get

  • get<T>(propertyName: string): T
  • get(propertyName: string): any
  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: string

    Returns any

hasEventListener

  • hasEventListener(type: string): boolean
  • Indicates whether there is an event listener on the instance that matches the provided event name.

    Read more...

    Parameters

    • type: string

    Returns boolean

isFulfilled

  • isFulfilled(): boolean
  • isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).

    Read more...

    Returns boolean

isRejected

  • isRejected(): boolean
  • isRejected() may be used to verify if creating an instance of the class is rejected.

    Read more...

    Returns boolean

isResolved

  • isResolved(): boolean
  • isResolved() may be used to verify if creating an instance of the class is resolved.

    Read more...

    Returns boolean

Protected notifyChange

  • notifyChange(propertyName: string): void
  • Parameters

    • propertyName: string

    Returns void

on

  • Parameters

    Returns IHandle

  • Parameters

    Returns IHandle

  • Parameters

    Returns IHandle

  • Parameters

    Returns IHandle

  • Parameters

    Returns IHandle

  • Parameters

    Returns IHandle

  • Parameters

    Returns IHandle

  • Parameters

    Returns IHandle

  • Parameters

    Returns IHandle

  • Parameters

    Returns IHandle

  • Parameters

    Returns IHandle

own

  • Widget teardown helper.

    Read more...

    Parameters

    Returns void

postInitialize

  • postInitialize(): void
  • This method is primarily used by developers when implementing custom widgets. Executes after widget is ready for rendering.

    Read more...

    Returns void

render

  • render(): any
  • This method is primarily used by developers when implementing custom widgets. It must be implemented by subclasses for rendering.

    Read more...

    Returns any

renderNow

  • renderNow(): void
  • Renders widget to the DOM immediately.

    Read more...

    Returns void

scheduleRender

  • scheduleRender(): void
  • This method is primarily used by developers when implementing custom widgets. Schedules widget rendering.

    Read more...

    Returns void

set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns Slider

  • Parameters

    Returns Slider

watch

  • Parameters

    • path: string | string[]
    • callback: WatchCallback
    • Optional sync: boolean

    Returns WatchHandle

when

  • when(callback?: Function, errback?: Function): Promise<any>
  • when() may be leveraged once an instance of the class is created.

    Read more...

    Parameters

    • Optional callback: Function
    • Optional errback: Function

    Returns Promise<any>

Generated using TypeDoc