Class Variable<V>

An aggregate helper class for widgets that contain a variable with a specified type which is intended to be controlled by the user.

Useful for implementing widgets such as sliders, checkboxes, text input, etc...

Type Parameters

V
The type of Variable#value.

Hierarchy (view full)

Variable
- ValidatedVariable

Implements

Box<V>

Index

Constructors

Properties

_value callbacks

Accessors

Methods

doCallback setValue unwatch watch

Constructors

constructor

new Variable<V>(initialValue): Variable<V>
Type Parameters
- V
Parameters
- initialValue: V
  The initial value of this variable. Sets Variable#_value.
Returns Variable<V>
- Defined in src/state/Variable.ts:23

Properties

`Private`_value

_value: V

The current value, for internal use.

`Private`callbacks

callbacks: ObservableCallback<V>[] = ...

The function callbacks called when the value is changed

Accessors

value

get value(): V
The current value.

If setting, Variable#setValue is called with no group.

Returns V
Implementation of Box.value
- Defined in src/state/Variable.ts:32
set value(value): void
The current value.

When the value is set via this setter, the class implementing this interface should notify the observable with no group (undefined). Note that this is just a suggestion, not a strict requirement.
Parameters
- value: V
Returns void
Implementation of Box.value
- Defined in src/state/Variable.ts:36

Methods

`Private`doCallback

doCallback(callback, group): void
Parameters
- callback: ObservableCallback<V>
- group: unknown
Returns void
- Defined in src/state/Variable.ts:76

setValue

setValue(value, group?): boolean
Sets Box#value. Does nothing if the value is already the one specified.
Parameters
- value: V
- Optionalgroup: unknown
  The observable group that this change belongs to. undefined by default.
Returns boolean
Returns true if the value was changed, false if not
Implementation of Box.setValue
- Defined in src/state/Variable.ts:62

unwatch

unwatch(callback): this
Unregister a previously registered callback from this observable.
Parameters
- callback: ObservableCallback<V>
Returns this
Implementation of Box.unwatch
- Defined in src/state/Variable.ts:50

watch

watch(callback, callNow?, group?): this
Register a callback to this observable. When the value is changed, the callback will be called.
Parameters
- callback: ObservableCallback<V>
- callNow: boolean = false
  If true, the callback will be called once immediately after it's registered. False by default
- Optionalgroup: unknown
  The group to use when calling immediately. Only used if callNow is true, and is undefined by default
Returns this
Implementation of Box.watch
- Defined in src/state/Variable.ts:40