Class UserPreference

Contains info/config about preference items the user can change in the UserPreferenceComponent.

Index

Constructors

Properties

configPath currentValue group statePath uiElement visible

Accessors

Methods

getCurrentValueForState

Constructors

constructor

new UserPreference(
    configPath: string,
    statePath: null | string,
    group: string,
    uiElement: "color" | "select" | "checkbox",
    configToStateMapper?: (valueInConfig: any) => any,
): UserPreference
Parameters
- configPath: string
- statePath: null | string
- group: string
- uiElement: "color" | "select" | "checkbox"
- OptionalconfigToStateMapper: (valueInConfig: any) => any
Returns UserPreference
- Defined in src/components/userpreferences/userPreference.ts:24

Properties

configPath

configPath: string

currentValue

currentValue: unknown = undefined

group

group: string

statePath

statePath: null | string

uiElement

uiElement: "color" | "select" | "checkbox"

visible

visible: boolean = true

Accessors

options

get options(): PreferenceOption[]
Returns PreferenceOption[]
- Defined in src/components/userpreferences/userPreference.ts:38
set options(options: PreferenceOption[]): void
Parameters
- options: PreferenceOption[]
Returns void
- Defined in src/components/userpreferences/userPreference.ts:42

Methods

getCurrentValueForState

getCurrentValueForState(): any
Returns any
- Defined in src/components/userpreferences/userPreference.ts:49