Class ColorController

A ValueController for a color setting, stored as a hexadecimal color string.

Hierarchy (View Summary)

ValueController<HexColor>
- ColorController

Index

Constructors

Properties

_defaultValue canReset isColorController isValueController onChange saveToLocalStorage showInDevTools tag

Accessors

defaultValue value

Methods

Constructors

constructor

new ColorController(
defaultValue: `#${string}`,
options?: ValueControllerOptions<`#${string}`>,
): ColorController
Parameters
- defaultValue: `#${string}`
- options: ValueControllerOptions<`#${string}`> = {}
Returns ColorController
Inherited from ValueController.constructor
- Defined in packages/viewer/src/utils/valueControllers/ValueController.ts:48

Properties

`Protected`_defaultValue

_defaultValue: `#${string}`

`Readonly`canReset

canReset: boolean

`Readonly`isColorController

isColorController: true

`Readonly`isValueController

isValueController: true

`Readonly`onChange

onChange: ViewerSignal<(value: `#${string}`) => void> = ...

Signal emitted when the value changes

`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(): T
Returns T
Inherited from ValueController.value
- Defined in packages/viewer/src/utils/valueControllers/ValueController.ts:63
set value(newValue: T): void
Parameters
- newValue: T
Returns void
Inherited from ValueController.value
- Defined in packages/viewer/src/utils/valueControllers/ValueController.ts:58

Methods

reset

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