Class UserPreferencesComponent

Lets the user override default configuration values and saves them as user data.

Hierarchy (View Summary)

GirafeHTMLElement
- UserPreferencesComponent

Implements

IGirafePanel

Constructors

constructor

new UserPreferencesComponent(): UserPreferencesComponent
Returns UserPreferencesComponent
Overrides GirafeHTMLElement.constructor
- Defined in components/userpreferences/component.ts:30

Properties

colorPickers

colorPickers: Record<string, GirafeColorPicker> = {}

`Protected` `Optional`displayStyle

displayStyle?: string

`Protected` `Optional`feedbackTemplateHtml

feedbackTemplateHtml?: string

isPanelVisible

isPanelVisible: boolean = false

`Readonly`name

name: string

panelTitle

panelTitle: string = 'user-preferences-panel'

panelTogglePath

panelTogglePath: string = 'interface.userPreferencesPanelVisible'

preferenceGroups

preferenceGroups: string[] = PreferenceGroups

preferences

preferences: Record<string, UserPreference>

ready

ready: boolean = false

`Protected`rendered

rendered: boolean = false

`Protected`shadow

shadow: ShadowRoot

styleUrls

styleUrls: string[] = ...

`Protected`template

template: Hole | (() => Hole)

templateUrl

templateUrl: string = './template.html'

Accessors

`Protected`context

get context(): IGirafeContext
Returns IGirafeContext
Inherited from GirafeHTMLElement.context
- Defined in base/GirafeHTMLElement.ts:45

customStyle

get customStyle(): string
Returns string
Inherited from GirafeHTMLElement.customStyle
- Defined in base/GirafeHTMLElement.ts:33

`Protected`isFullscreenComponent

get isFullscreenComponent(): boolean
Whether this Component must stay visible when the App is in Fullscreen Mode. Controlled by the "fullscreen" attribute (default: false).

Returns boolean
Inherited from GirafeHTMLElement.isFullscreenComponent
- Defined in base/GirafeHTMLElement.ts:256

`Protected`state

get state(): State
Returns State
Inherited from GirafeHTMLElement.state
- Defined in base/GirafeHTMLElement.ts:61

Methods

activateTheme

activateTheme(mode: "light" | "dark", className: string): void
Parameters
- mode: "light" | "dark"
- className: string
Returns void
- Defined in components/userpreferences/component.ts:138

`Protected`canExecute

canExecute(eventName: GgUserInteractionEvent): boolean
Parameters
- eventName: GgUserInteractionEvent
Returns boolean
Inherited from GirafeHTMLElement.canExecute
- Defined in base/GirafeHTMLElement.ts:369

changePreference

changePreference(preferenceKey: string, newValue: unknown): void
Update state and local storage with new value
Parameters
- preferenceKey: string
- newValue: unknown
Returns void
- Defined in components/userpreferences/component.ts:295

`Protected`connectedCallback

connectedCallback(): void
Returns void
Overrides GirafeHTMLElement.connectedCallback
- Defined in components/userpreferences/component.ts:98

`Protected`disconnectedCallback

disconnectedCallback(): void
When the component is disconnected from the DOM all the callbacks will be unregistered

Returns void
Inherited from GirafeHTMLElement.disconnectedCallback
- Defined in base/GirafeHTMLElement.ts:345

`Protected`getById

getById<T = HTMLElement>(id: string): T
Type Parameters
- T = HTMLElement
Parameters
- id: string
Returns T
Inherited from GirafeHTMLElement.getById
- Defined in base/GirafeHTMLElement.ts:65

`Protected`getChildElement

getChildElement<T = HTMLElement>(selector: string): T
Type Parameters
- T = HTMLElement
Parameters
- selector: string
Returns T
Inherited from GirafeHTMLElement.getChildElement
- Defined in base/GirafeHTMLElement.ts:69

`Protected`getInheritedContext

getInheritedContext(): IGirafeContext
Returns IGirafeContext
Inherited from GirafeHTMLElement.getInheritedContext
- Defined in base/GirafeHTMLElement.ts:373

`Protected`getParentOfType

getParentOfType(
    parentNodeName: string,
    elem: Node | null,
    initialElem?: Node | null,
): Node | null
Parameters
- parentNodeName: string
- elem: Node | null
- initialElem: Node | null = elem
Returns Node | null
Inherited from GirafeHTMLElement.getParentOfType
- Defined in base/GirafeHTMLElement.ts:100

getPreferencesByGroup

getPreferencesByGroup(group: string): [UserPreference, string][]
Parameters
- group: string
Returns [UserPreference, string][]
all preferences of a group for easy usage in the template.
- Defined in components/userpreferences/component.ts:366

`Protected`girafeTranslate

girafeTranslate(): void
Returns void
Inherited from GirafeHTMLElement.girafeTranslate
- Defined in base/GirafeHTMLElement.ts:73

`Protected`hide

hide(): void
Hide the component (display: none).

Returns void
Inherited from GirafeHTMLElement.hide
- Defined in base/GirafeHTMLElement.ts:238

`Protected`htmlUnsafe

htmlUnsafe(str: string): Hole
Convert the string in parameter with uHtml and return it. This allows to convert a string with html in a right html object. For example, htmlUnsafe('
') will return an html div object.
Parameters
- str: string
Returns Hole
Inherited from GirafeHTMLElement.htmlUnsafe
- Defined in base/GirafeHTMLElement.ts:186

insertFeedbackTemplate

insertFeedbackTemplate(template: string): void
Parameters
- template: string
Returns void
Inherited from GirafeHTMLElement.insertFeedbackTemplate
- Defined in base/GirafeHTMLElement.ts:131

`Protected`isNullOrUndefined

isNullOrUndefined(val: unknown): boolean
NOTE REG: We cannot just use truthy here, because javascript comparaison table is really problematic. For example: 0 == false [] == false "" == false And there are cases where we want to check null or undefined, because 0 can be a right value. More here : https://dorey.github.io/JavaScript-Equality-Table/
Parameters
- val: unknown
Returns boolean
Inherited from GirafeHTMLElement.isNullOrUndefined
- Defined in base/GirafeHTMLElement.ts:92

`Protected`isNullOrUndefinedOrBlank

isNullOrUndefinedOrBlank(val: unknown): boolean
Parameters
- val: unknown
Returns boolean
Inherited from GirafeHTMLElement.isNullOrUndefinedOrBlank
- Defined in base/GirafeHTMLElement.ts:96

onChangeDarkFrontendMode

onChangeDarkFrontendMode(newValue: boolean | undefined): void
Parameters
- newValue: boolean | undefined
Returns void
- Defined in components/userpreferences/component.ts:132

onChangeDarkMapMode

onChangeDarkMapMode(newValue: boolean | undefined): void
Parameters
- newValue: boolean | undefined
Returns void
- Defined in components/userpreferences/component.ts:127

onOpenSelectOption

onOpenSelectOption(preferenceKey: string): void
If necessary, change/update options of select elements right before they're shown.
Parameters
- preferenceKey: string
Returns void
- Defined in components/userpreferences/component.ts:274

onResetAll

onResetAll(): Promise<void>
Reset user preferences back to defaults. This will delete the configOverrides object in storage and set the current state back to the defaults from config.json

Returns Promise<void>
- Defined in components/userpreferences/component.ts:343

onSelectOption

onSelectOption(preferenceKey: string, evt: Event): void
Called when user changes a preference in the panel
Parameters
- preferenceKey: string
- evt: Event
Returns void
- Defined in components/userpreferences/component.ts:284

`Protected`refreshRender

refreshRender(): void
Re-Render the component. The method should be called when the component has already been rendered and needs to be updated.

Returns void
Inherited from GirafeHTMLElement.refreshRender
- Defined in base/GirafeHTMLElement.ts:140

`Protected`registerInteractionListener

registerInteractionListener(
eventName: GgUserInteractionEvent,
isExclusive: boolean,
): boolean
Parameters
- eventName: GgUserInteractionEvent
- isExclusive: boolean
Returns boolean
Inherited from GirafeHTMLElement.registerInteractionListener
- Defined in base/GirafeHTMLElement.ts:353

render

render(): void
Render the component's template.

Returns void
Overrides GirafeHTMLElement.render
- Defined in components/userpreferences/component.ts:106

`Protected`renderEmpty

renderEmpty(): void
Renders a hidden span with the name of the component. Useful to render a placeholder for not visible component.

Returns void
Inherited from GirafeHTMLElement.renderEmpty
- Defined in base/GirafeHTMLElement.ts:174

`Protected`show

show(): void
Show the component (display: block).

Returns void
Inherited from GirafeHTMLElement.show
- Defined in base/GirafeHTMLElement.ts:246

`Protected`simulateClick

simulateClick(e: KeyboardEvent): void
In the templates, sometimes for accessibility reasons, we have to support the KeyDown Event In those case, we often juste want to do the same as the click event when Enter or Space is pressed Then this method can be used : it just calls the click event on the same element
Parameters
- e: KeyboardEvent
Returns void
Inherited from GirafeHTMLElement.simulateClick
- Defined in base/GirafeHTMLElement.ts:225

`Protected`subscribe

subscribe(path: string, callback: Callback): Callback
Subscribes with to the state changes made on
Parameters
- path: string
- callback: Callback
Returns Callback
Inherited from GirafeHTMLElement.subscribe
- Defined in base/GirafeHTMLElement.ts:305
subscribe(path: RegExp, callback: Callback): Callback
Subscribes with to the state changes made on
Parameters
- path: RegExp
- callback: Callback
Returns Callback
Inherited from GirafeHTMLElement.subscribe
- Defined in base/GirafeHTMLElement.ts:306

togglePanel

togglePanel(visible: boolean): void
Parameters
- visible: boolean
Returns void
Implementation of IGirafePanel.togglePanel
- Defined in components/userpreferences/component.ts:122

`Protected`unregisterInteractionListeners

unregisterInteractionListeners(
eventNames?: GgUserInteractionEvent | GgUserInteractionEvent[],
): void
Parameters
- OptionaleventNames: GgUserInteractionEvent | GgUserInteractionEvent[]
Returns void
Inherited from GirafeHTMLElement.unregisterInteractionListeners
- Defined in base/GirafeHTMLElement.ts:357

`Protected`unsubscribe

unsubscribe(callback: Callback): void
Parameters
- callback: Callback
  Unsubscribe all callbacks
Returns void
Inherited from GirafeHTMLElement.unsubscribe
- Defined in base/GirafeHTMLElement.ts:319
unsubscribe(callbacks: Callback[]): void
Parameters
- callbacks: Callback[]
Returns void
Inherited from GirafeHTMLElement.unsubscribe
- Defined in base/GirafeHTMLElement.ts:320

`Static`setCustomStyle

setCustomStyle(componentName: string, customCss: string): void
Parameters
- componentName: string
- customCss: string
Returns void
Inherited from GirafeHTMLElement.setCustomStyle
- Defined in base/GirafeHTMLElement.ts:41

Class UserPreferencesComponent

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns UserPreferencesComponent

Properties

colorPickers

Protected OptionaldisplayStyle

Protected OptionalfeedbackTemplateHtml

isPanelVisible

Readonlyname

panelTitle

panelTogglePath

preferenceGroups

preferences

ready

Protectedrendered

Protectedshadow

styleUrls

Protectedtemplate

templateUrl

Accessors

Protectedcontext

Returns IGirafeContext

customStyle

Returns string

ProtectedisFullscreenComponent

Returns boolean

Protectedstate

Returns State

Methods

activateTheme

Parameters

Returns void

ProtectedcanExecute

Parameters

Returns boolean

changePreference

Parameters

Returns void

ProtectedconnectedCallback

Returns void

ProtecteddisconnectedCallback

Returns void

ProtectedgetById

Type Parameters

Parameters

Returns T

ProtectedgetChildElement

Type Parameters

Parameters

Returns T

ProtectedgetInheritedContext

Returns IGirafeContext

ProtectedgetParentOfType

Parameters

Returns Node | null

getPreferencesByGroup

Parameters

Returns [UserPreference, string][]

ProtectedgirafeTranslate

Returns void

Protectedhide

Returns void

ProtectedhtmlUnsafe

Parameters

Returns Hole

insertFeedbackTemplate

Parameters

Returns void

ProtectedisNullOrUndefined

Parameters

Returns boolean

ProtectedisNullOrUndefinedOrBlank

`Protected` `Optional`displayStyle

`Protected` `Optional`feedbackTemplateHtml

`Readonly`name

`Protected`rendered

`Protected`shadow

`Protected`template

`Protected`context

`Protected`isFullscreenComponent

`Protected`state

`Protected`canExecute

`Protected`connectedCallback

`Protected`disconnectedCallback

`Protected`getById

`Protected`getChildElement

`Protected`getInheritedContext

`Protected`getParentOfType

`Protected`girafeTranslate

`Protected`hide

`Protected`htmlUnsafe

`Protected`isNullOrUndefined

`Protected`isNullOrUndefinedOrBlank

`Protected`refreshRender

`Protected`registerInteractionListener

`Protected`renderEmpty

`Protected`show

`Protected`simulateClick

`Protected`subscribe

`Protected`unregisterInteractionListeners

`Protected`unsubscribe

`Static`setCustomStyle