Class SelectController<TOptions>

A ValueController restricted to one value among a fixed set of options.

Type Parameters

const TOptions extends ReadonlyArray<any>

Hierarchy (View Summary)

ValueController<TOptions[number]>
- SelectController

Index

Constructors

Properties

_defaultValue canReset isSelectController isValueController onChange options saveToLocalStorage showInDevTools tag

Accessors

defaultValue value

Methods

Constructors

constructor

new SelectController<const TOptions extends readonly any[]>(
    defaultValue: TOptions[number],
    options: TOptions,
    pOptions?: ValueControllerOptions<TOptions[number]>,
): SelectController<TOptions>
Type Parameters
- const TOptions extends readonly any[]
Parameters
- defaultValue: TOptions[number]
- options: TOptions
- pOptions: ValueControllerOptions<TOptions[number]> = {}
Returns SelectController<TOptions>
Overrides ValueController.constructor
- Defined in packages/viewer/src/utils/valueControllers/SelectController.ts:12

Properties

`Protected`_defaultValue

_defaultValue: TOptions[number]

`Readonly`canReset

canReset: boolean

`Readonly`isSelectController

isSelectController: true

`Readonly`isValueController

isValueController: true

`Readonly`onChange

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

Signal emitted when the value changes

`Readonly`options

options: TOptions

`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:67

value

get value(): TOptions[number]
Returns TOptions[number]
Overrides ValueController.value
- Defined in packages/viewer/src/utils/valueControllers/SelectController.ts:20
set value(newValue: TOptions[number]): void
Parameters
- newValue: TOptions[number]
Returns void
Overrides ValueController.value
- Defined in packages/viewer/src/utils/valueControllers/SelectController.ts:24

Methods

reset

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