Class NumberControl

Display Name

NumberControl Control for numerical values with optional slider, step, and range constraints

Hierarchy (View Summary)

BaseControl
- NumberControl

Constructors

constructor

new NumberControl(
    parent: any,
    object: Record<string, any>,
    property: string,
    min?: number,
    max?: number,
    step?: number,
): NumberControl
Parameters
- parent: any
- object: Record<string, any>
- property: string
- Optionalmin: number
- Optionalmax: number
- Optionalstep: number
Returns NumberControl
Overrides BaseControl.constructor
- Defined in controls/number-control.ts:59

Properties

_changed

_changed: boolean = false

Whether the value has changed since the last finishChange event

_decimals

_decimals: number

_disabled

_disabled: boolean = false

Whether the controller is disabled

_hasSlider

_hasSlider: boolean

_hidden

_hidden: boolean = false

Whether the controller is hidden

_inputFocused

_inputFocused: boolean

_listenCallbackID

_listenCallbackID: any

ID of the animation frame when listening for changes

_listening

_listening: boolean = false

Whether the controller is actively listening for external changes

_listenPrevValue

_listenPrevValue: any

Previous value when listening for changes

_max

_max: number

_min

_min: number

_name

_name: any

Name of the controller (typically matches the property name)

_onChange

_onChange: any

Callback for when the value changes

_onFinishChange

_onFinishChange: any

Callback for when value changes are completed

_step

_step: number

_stepExplicit

_stepExplicit: boolean

$elForDisable

$elForDisable: any

DOM element that will be disabled when controller is disabled

$fill

$fill: HTMLDivElement

$input

$input: HTMLInputElement

$name

$name: HTMLDivElement

DOM element for displaying the property name

$slider

$slider: HTMLDivElement

$widget: HTMLDivElement

DOM element containing the control widget

decimals

decimals: (decimals: number) => this = ...

Type declaration

- (decimals: number): this
- Sets the number of decimal places (implemented by subclasses)
  Parameters
  - decimals: number
    Number of decimal places
  Returns this
  This controller instance (for chaining)

domElement

domElement: HTMLElement

Main DOM element for this controller

initialValue

initialValue: any

Initial value of the controlled property

max

max: (max: number) => this = ...

Type declaration

- (max: number): this
- Sets the maximum value (implemented by subclasses)
  Parameters
  - max: number
    Maximum value
  Returns this
  This controller instance (for chaining)

min

min: (min: number) => this = ...

Type declaration

- (min: number): this
- Sets the minimum value (implemented by subclasses)
  Parameters
  - min: number
    Minimum value
  Returns this
  This controller instance (for chaining)

object

object: any

Object containing the property to control

parent

parent: any

Parent GUI instance

property

property: any

Property name being controlled

step

step: (step: number, explicit?: boolean) => this = ...

Type declaration

- (step: number, explicit?: boolean): this
- Sets the step size (implemented by subclasses)
  Parameters
  - step: number
    Step size
  - explicit: boolean = true
  Returns this
  This controller instance (for chaining)

`Static`nextNameID

nextNameID: any

Used for generating unique IDs

Accessors

_hasMax

get _hasMax(): boolean
Returns boolean
- Defined in controls/number-control.ts:49

_hasMin

get _hasMin(): boolean
Returns boolean
- Defined in controls/number-control.ts:45

_hasScrollBar

get _hasScrollBar(): boolean
Returns boolean
- Defined in controls/number-control.ts:39

Methods

destroy

destroy(): void
Removes the controller from its parent and the DOM

Returns void
Inherited from BaseControl.destroy
- Defined in controls/base-control.ts:335

disable

disable(disabled?: boolean): NumberControl
Disables or enables the controller
Parameters
- disabled: boolean = true
  Whether to disable the controller
Returns NumberControl
This controller instance (for chaining)
Inherited from BaseControl.disable
- Defined in controls/base-control.ts:180

enable

enable(enabled?: boolean): NumberControl
Enables or disables the controller
Parameters
- enabled: boolean = true
  Whether to enable the controller
Returns NumberControl
This controller instance (for chaining)
Inherited from BaseControl.enable
- Defined in controls/base-control.ts:171

getValue

getValue(): any
Gets the current value of the controlled property

Returns any
The current value
Inherited from BaseControl.getValue
- Defined in controls/base-control.ts:285

hide

hide(): NumberControl
Hides the controller (alias for show(false))

Returns NumberControl
This controller instance (for chaining)
Inherited from BaseControl.hide
- Defined in controls/base-control.ts:205

listen

listen(listen?: boolean): NumberControl
Enables or disables listening for external changes to the property
Parameters
- listen: boolean = true
  Whether to listen for changes
Returns NumberControl
This controller instance (for chaining)
Inherited from BaseControl.listen
- Defined in controls/base-control.ts:254

load

load(value: any): NumberControl
Sets the value and triggers the onFinishChange callback
Parameters
- value: any
  The value to set
Returns NumberControl
This controller instance (for chaining)
Inherited from BaseControl.load
- Defined in controls/base-control.ts:318

name

name(name: any): NumberControl
Sets the display name of the controller
Parameters
- name: any
  The name to display
Returns NumberControl
This controller instance (for chaining)
Inherited from BaseControl.name
- Defined in controls/base-control.ts:100

onChange

onChange(callback: any): NumberControl
Registers a callback for value changes
Parameters
- callback: any
  Function called when the value changes
Returns NumberControl
This controller instance (for chaining)
Inherited from BaseControl.onChange
- Defined in controls/base-control.ts:111

onFinishChange

onFinishChange(callback: any): NumberControl
Registers a callback for when value changes are completed
Parameters
- callback: any
  Function called when value changes are completed
Returns NumberControl
This controller instance (for chaining)
Inherited from BaseControl.onFinishChange
- Defined in controls/base-control.ts:134

options

options(options: any): any
Replaces this controller with an options controller
Parameters
- options: any
  Option values for the new controller
Returns any
The new options controller
Inherited from BaseControl.options
- Defined in controls/base-control.ts:214

reset

reset(): NumberControl
Resets the value to its initial state

Returns NumberControl
This controller instance (for chaining)
Inherited from BaseControl.reset
- Defined in controls/base-control.ts:160

save

save(): any
Returns the current value (used for saving state)

Returns any
The current value
Inherited from BaseControl.save
- Defined in controls/base-control.ts:328

setDecimals

setDecimals(decimals: number): this
Sets the number of decimal places (implemented by subclasses)
Parameters
- decimals: number
  Number of decimal places
Returns this
This controller instance (for chaining)
Overrides BaseControl.setDecimals
- Defined in controls/number-control.ts:99

setMax

setMax(max: number): this
Sets the maximum value (implemented by subclasses)
Parameters
- max: number
  Maximum value
Returns this
This controller instance (for chaining)
Overrides BaseControl.setMax
- Defined in controls/number-control.ts:113

setMin

setMin(min: number): this
Sets the minimum value (implemented by subclasses)
Parameters
- min: number
  Minimum value
Returns this
This controller instance (for chaining)
Overrides BaseControl.setMin
- Defined in controls/number-control.ts:105

setStep

setStep(step: number, explicit?: boolean): this
Sets the step size (implemented by subclasses)
Parameters
- step: number
  Step size
- explicit: boolean = true
Returns this
This controller instance (for chaining)
Overrides BaseControl.setStep
- Defined in controls/number-control.ts:121

setValue

setValue(value: any): NumberControl
Sets the value of the controlled property Only updates if the value has changed
Parameters
- value: any
  The new value
Returns NumberControl
This controller instance (for chaining)
Inherited from BaseControl.setValue
- Defined in controls/base-control.ts:295

show

show(show?: boolean): NumberControl
Shows or hides the controller
Parameters
- show: boolean = true
  Whether to show the controller
Returns NumberControl
This controller instance (for chaining)
Inherited from BaseControl.show
- Defined in controls/base-control.ts:195

update

update(): this
Updates the controller's visual state (implemented by subclasses)

Returns this
This controller instance (for chaining)
Overrides BaseControl.update
- Defined in controls/number-control.ts:127

Class NumberControl

Display Name

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns NumberControl

Properties

_changed

_decimals

_disabled

_hasSlider

_hidden

_inputFocused

_listenCallbackID

_listening

_listenPrevValue

_max

_min

_name

_onChange

_onFinishChange

_step

_stepExplicit

$elForDisable

$fill

$input

$name

$slider

$widget

decimals

Type declaration

Parameters

Returns this

domElement

initialValue

max

Type declaration

Parameters

Returns this

min

Type declaration

Parameters

Returns this

object

parent

property

step

Type declaration

Parameters

Returns this

StaticnextNameID

Accessors

_hasMax

Returns boolean

_hasMin

Returns boolean

_hasScrollBar

Returns boolean

Methods

destroy

Returns void

disable

Parameters

Returns NumberControl

enable

Parameters

Returns NumberControl

getValue

Returns any

hide

Returns NumberControl

listen

Parameters

Returns NumberControl

`Static`nextNameID