Class Slider

A class representing a slider where you can select a value from a specific range.

@ extends Widget implements ValueWidget

Hierarchy (view full)

Widget
- Slider

Implements

ValueWidget

Index

Constructors

Properties

accuracy labelRef listeners max min ref sliderRef step thumbRef value view

Methods

_init addClass bind destroy getRef getValue initSlider off on onChange onClick removeClass setContent setLabel setMax setMin setStep setText setValue trigger

Constructors

constructor

new Slider(options): Slider
Create a new slider and initialize it.
Parameters
- options: {
      callback?: null;
      label?: string;
      max?: number;
      min?: number;
      step?: number;
      value?: number;
  }
  The options for the slider
  - Optional callback?: null
    The function to call when the slider is changed
  - Optional label?: string
    The label text
  - Optional max?: number
    The maximum value
  - Optional min?: number
    The minimum value
  - Optional step?: number
    The step size
  - Optional value?: number
    The initial value
Returns Slider
Overrides Widget.constructor
- Defined in widgets/Slider.ts:30

Properties

accuracy

accuracy: number

labelRef

labelRef: HTMLDivElement

listeners

listeners: {
[key: string]: Function[];
}

Type declaration

[key: string]: Function[]

max

max: number

min

min: number

ref

ref: HTMLDivElement

sliderRef

sliderRef: HTMLDivElement

step

step: number

thumbRef

thumbRef: HTMLDivElement

value

value: any

view

view: View

Methods

_init

_init(): void
Do the necessary initialization.

Returns void
Implementation of ValueWidget._init
Inherited from Widget._init
- Defined in widgets/GUIElement.ts:19

addClass

addClass(...classes): this
Add one or more classes to an element.
Parameters
- Rest ...classes: string[]
Returns this
Implementation of ValueWidget.addClass
Inherited from Widget.addClass
- Defined in widgets/GUIElement.ts:28

bind

bind(obj, prop): this
Bind a slider to an object property.
Parameters
- obj: any
  The object to bind the property to.
- prop: string
  The property to bind.
Returns this
Implementation of ValueWidget.bind
Overrides Widget.bind
- Defined in widgets/Slider.ts:112

destroy

destroy(): void
Destroy the element

Returns void
Implementation of ValueWidget.destroy
Inherited from Widget.destroy
- Defined in widgets/GUIElement.ts:53

getRef

getRef(): HTMLElement
Returns HTMLElement
Implementation of ValueWidget.getRef
Inherited from Widget.getRef
- Defined in widgets/GUIElement.ts:46

getValue

getValue(): number
Get the current value of the slider.

Returns number
Implementation of ValueWidget.getValue
- Defined in widgets/Slider.ts:203

initSlider

initSlider(): void
Returns void
- Defined in widgets/Slider.ts:163

off

off(event, callback): void
Parameters
- event: string
- callback: Function
Returns void
Implementation of ValueWidget.off
Inherited from Widget.off
- Defined in EventSupport.ts:16

on

on(event, callback): void
Parameters
- event: string
- callback: Function
Returns void
Implementation of ValueWidget.on
Inherited from Widget.on
- Defined in EventSupport.ts:11

onChange

onChange(f): this
Add a change event listener to the slider.
Parameters
- f: Function
  The function to call when the slider is changed.
Returns this
- Defined in widgets/Slider.ts:101

onClick

onClick(f): this
Add a click event listener to the widget.
Parameters
- f: Function
  The function to call when the widget is clicked.
Returns this
Implementation of ValueWidget.onClick
Inherited from Widget.onClick
- Defined in widgets/Widget.ts:50

removeClass

removeClass(...classes): this
Remove one or more classes from an element.
Parameters
- Rest ...classes: string[]
Returns this
Implementation of ValueWidget.removeClass
Inherited from Widget.removeClass
- Defined in widgets/GUIElement.ts:38

setContent

setContent(value): this
Set the content of the widget.
Parameters
- value: string
  The value to set the content to.
Returns this
Implementation of ValueWidget.setContent
Inherited from Widget.setContent
- Defined in widgets/Widget.ts:30

setLabel

setLabel(text): this
Set the label of the slider.
Parameters
- text: string
  The new label text.
Returns this
- Defined in widgets/Slider.ts:91

setMax

setMax(max): this
Set the maximum value of the slider.
Parameters
- max: number
  The new maximum value.
Returns this
- Defined in widgets/Slider.ts:132

setMin

setMin(min): this
Set the minimum value of the slider.
Parameters
- min: number
  The new minimum value.
Returns this
- Defined in widgets/Slider.ts:122

setStep

setStep(step): this
Set the step size of the slider.
Parameters
- step: number
  The new step size.
Returns this
- Defined in widgets/Slider.ts:142

setText

setText(value): this
Set the text of the widget.
Parameters
- value: string
  The value to set the text to.
Returns this
Implementation of ValueWidget.setText
Inherited from Widget.setText
- Defined in widgets/Widget.ts:40

setValue

setValue(value): Slider
Set the value of the slider.
Parameters
- value: number
  The new value.
Returns Slider
Implementation of ValueWidget.setValue
- Defined in widgets/Slider.ts:152

trigger

trigger(event, ...args): void
Parameters
- event: string
- Rest ...args: any[]
Returns void
Implementation of ValueWidget.trigger
Inherited from Widget.trigger
- Defined in EventSupport.ts:22