Class Variable<V, C>

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 value.
C extends CallableFunction = VariableCallback<V>

The type of a callback function. Should not be passed manually.

Hierarchy

Variable
- ValidatedVariable

Index

Constructors

Properties

_value callbacks

Accessors

Methods

doCallback hasCallback setValue unwatch watch

Constructors

constructor

new Variable<V, C>(initialValue: V, callback?: C, callNow?: boolean): Variable<V, C>
Create a new Variable.
Type Parameters
- V
- C extends CallableFunction = VariableCallback<V>
Parameters
- initialValue: V
  
  The initial value of this variable. Sets _value.
- Optional callback: C
  
  A callback for when the variable changes. Equivalent to calling watch after creating the variable, but allows for variables to created inline.
- callNow: boolean = true
  
  If true, the callback will be called once immediately after it's registered, unless the callback is already registered. Doesn't apply if no callback was passed.
Returns Variable<V, C>
- Defined in src/state/Variable.ts:33

Properties

`Private` _value

_value: V

The current value, for internal use.

`Private` callbacks

callbacks: Set<C> = ...

The function callbacks called when the value is changed

Accessors

value

get value(): V
The current value.

If setting, setValue is called.

Returns V
- Defined in src/state/Variable.ts:45
set value(value: V): void
Parameters
- value: V
Returns void
- Defined in src/state/Variable.ts:49

Methods

`Protected` doCallback

doCallback(callback: C): void
Parameters
- callback: C
Returns void
- Defined in src/state/Variable.ts:102

hasCallback

hasCallback(callback: C): boolean
Check if a callback is registered to this variable.
Parameters
- callback: C
Returns boolean
- Defined in src/state/Variable.ts:54

setValue

setValue(value: V, notify?: boolean): boolean
Sets _value. Does nothing if the value is already the one specified.

Returns
Returns true if the value was changed, false if not
Parameters
- value: V
- notify: boolean = true
  
  If true, then the callbacks are called.
Returns boolean
- Defined in src/state/Variable.ts:88

unwatch

unwatch(callback: C): boolean
Unregister a previously registered callback from this variable.
Parameters
- callback: C
Returns boolean
- Defined in src/state/Variable.ts:77

watch

watch(callback: C, callNow?: boolean): boolean
Register a callback to this variable. When the value is changed, the callback will be called.
Parameters
- callback: C
- callNow: boolean = true
  
  If true, the callback will be called once immediately after it's registered, unless the callback is already registered.
Returns boolean
- Defined in src/state/Variable.ts:64

Generated using TypeDoc