Class NumberController

A ValueController for a numeric setting, clamped between min and max and stepped by step.

Hierarchy (View Summary)

ValueController<number>
- NumberController

Index

Constructors

Properties

_defaultValue canReset isNumberController isValueController max min onChange saveToLocalStorage showInDevTools step tag

Accessors

defaultValue value

Methods

Constructors

constructor

new NumberController(
defaultValue?: number,
options?: NumberControllerOptions,
): NumberController
Parameters
- defaultValue: number = 0
- options: NumberControllerOptions = {}
Returns NumberController
Overrides ValueController.constructor
- Defined in packages/viewer/src/utils/valueControllers/NumberController.ts:29

Properties

`Protected`_defaultValue

_defaultValue: number

`Readonly`canReset

canReset: boolean

`Readonly`isNumberController

isNumberController: true

`Readonly`isValueController

isValueController: true

`Readonly`max

max: number

`Readonly`min

min: number

`Readonly`onChange

onChange: ViewerSignal<(value: number) => void> = ...

Signal emitted when the value changes

`Readonly`saveToLocalStorage

saveToLocalStorage: boolean

`Readonly`showInDevTools

showInDevTools: boolean

`Readonly`step

step: number

`Readonly`tag

tag: string

Accessors

defaultValue

get defaultValue(): T
Returns T
Inherited from ValueController.defaultValue
- Defined in packages/viewer/src/utils/valueControllers/ValueController.ts:67

value

get value(): number
Returns number
Overrides ValueController.value
- Defined in packages/viewer/src/utils/valueControllers/NumberController.ts:52
set value(newValue: number): void
Parameters
- newValue: number
Returns void
Overrides ValueController.value
- Defined in packages/viewer/src/utils/valueControllers/NumberController.ts:56

Methods

reset

reset(): void
Returns void
Inherited from ValueController.reset
- Defined in packages/viewer/src/utils/valueControllers/ValueController.ts:71