Class SliderWidget

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

@ extends Widget implements ValueWidget

Hierarchy (View Summary)

Widget
- SliderWidget

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 SliderWidget(
    options: {
        callback?: ((value: number, currentValue: number) => void) | null;
        label?: string;
        max?: number;
        min?: number;
        step?: number;
        value?: number;
    },
): SliderWidget
Create a new slider and initialize it.
Parameters
- options: {
      callback?: ((value: number, currentValue: number) => void) | null;
      label?: string;
      max?: number;
      min?: number;
      step?: number;
      value?: number;
  }
  The options for the slider
  - Optionalcallback?: ((value: number, currentValue: number) => void) | null
    The function to call when the slider is changed
  - Optionallabel?: string
    The label text
  - Optionalmax?: number
    The maximum value
  - Optionalmin?: number
    The minimum value
  - Optionalstep?: number
    The step size
  - Optionalvalue?: number
    The initial value
Returns SliderWidget
Overrides Widget.constructor
- Defined in widgets/SliderWidget.ts:31

Properties

accuracy

accuracy: number = 0

labelRef

labelRef: HTMLDivElement

listeners

listeners: { [key: string]: EventCallback[] }

max

max: number = 100

min

min: number = 0

ref

ref: HTMLDivElement

sliderRef

sliderRef: HTMLDivElement

step

step: number = 1

thumbRef

thumbRef: HTMLDivElement

value

value: number = 0

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: string[]): this
Add one or more classes to an element.
Parameters
- ...classes: string[]
Returns this
Implementation of ValueWidget.addClass
Inherited from Widget.addClass
- Defined in widgets/GUIElement.ts:28

bind

bind(obj: any, prop: string): 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
- Defined in widgets/SliderWidget.ts:123

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 | null
Returns HTMLElement | null
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/SliderWidget.ts:220

initSlider

initSlider(): void
Returns void
- Defined in widgets/SliderWidget.ts:173

off

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

on

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

onChange

onChange(f: (value: number, currentValue: number) => void): this
Add a change event listener to the slider.
Parameters
- f: (value: number, currentValue: number) => void
  The function to call when the slider is changed.
Returns this
- Defined in widgets/SliderWidget.ts:112

onClick

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

removeClass

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

setContent

setContent(value: string): 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:29

setLabel

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

setMax

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

setMin

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

setStep

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

setText

setText(value: string): 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:39

setValue

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

trigger

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