Class StringController

Hierarchy (View Summary)

ValueController<string>
- StringController

Index

Constructors

Properties

_defaultValue canReset isStringController isValueController onChange saveToLocalStorage showInDevTools tag

Accessors

defaultValue value

Methods

Constructors

constructor

new StringController(
defaultValue: string,
options?: ValueControllerOptions<string>,
): StringController
Signal emitted when the value changes
Parameters
- defaultValue: string
- options: ValueControllerOptions<string> = {}
Returns StringController
Inherited from ValueController.constructor
- Defined in packages/viewer/src/utils/valueControllers/ValueController.ts:42

Properties

`Protected`_defaultValue

_defaultValue: string

`Readonly`canReset

canReset: boolean

`Readonly`isStringController

isStringController: true

`Readonly`isValueController

isValueController: true

`Readonly`onChange

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

`Readonly`saveToLocalStorage

saveToLocalStorage: boolean

`Readonly`showInDevTools

showInDevTools: boolean

`Readonly`tag

tag: string

Accessors

defaultValue

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

value

get value(): T
Returns T
Inherited from ValueController.value
- Defined in packages/viewer/src/utils/valueControllers/ValueController.ts:57
set value(newValue: T): void
Parameters
- newValue: T
Returns void
Inherited from ValueController.value
- Defined in packages/viewer/src/utils/valueControllers/ValueController.ts:52

Methods

reset

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