Class ThemesHelper

Hierarchy (View Summary)

GirafeSingleton
- ThemesHelper

Index

Constructors

Properties

Accessors

Methods

addGroupsFromUrl addLayersFromUrl addThemesFromUrl emptyLayerTree findBaseLayerById findGroupByName findLayerByName findThemeByName getInitialOrderForNewTheme getMinimalClonedThemeForLayer initializeSingleton isNullOrUndefinedOrBlank mergeThemeInLayerTree removeLayersFromLayerTree

Constructors

constructor

new ThemesHelper(context: IGirafeContext): ThemesHelper
Parameters
- context: IGirafeContext
Returns ThemesHelper
Inherited from GirafeSingleton.constructor
- Defined in src/base/GirafeSingleton.ts:7

Properties

`Protected` `Readonly`context

context: IGirafeContext

Accessors

state

get state(): State
Returns State
- Defined in src/tools/themes/themeshelper.ts:21

Methods

addGroupsFromUrl

addGroupsFromUrl(): boolean
Returns boolean
- Defined in src/tools/themes/themeshelper.ts:202

addLayersFromUrl

addLayersFromUrl(): boolean
Returns boolean
- Defined in src/tools/themes/themeshelper.ts:212

addThemesFromUrl

addThemesFromUrl(): boolean
Returns boolean
- Defined in src/tools/themes/themeshelper.ts:186

emptyLayerTree

emptyLayerTree(): void
Removes all layers from the layer tree except themes that are pinned.

Returns void
- Defined in src/tools/themes/themeshelper.ts:407

findBaseLayerById

findBaseLayerById(layerId: number): BaseLayer
Parameters
- layerId: number
Returns BaseLayer
- Defined in src/tools/themes/themeshelper.ts:25

findGroupByName

findGroupByName(groupname: string): GroupLayer | null
Parameters
- groupname: string
Returns GroupLayer | null
- Defined in src/tools/themes/themeshelper.ts:67

findLayerByName

findLayerByName(layername: string): Layer | null
Parameters
- layername: string
Returns Layer | null
- Defined in src/tools/themes/themeshelper.ts:77

findThemeByName

findThemeByName(themename: string): ThemeLayer | null
Parameters
- themename: string
Returns ThemeLayer | null
- Defined in src/tools/themes/themeshelper.ts:56

getInitialOrderForNewTheme

getInitialOrderForNewTheme(): number
Calculates the initial order (=position) for a new theme in the tree. Themes are added at the top of the tree, but underneath any pinned themes. Defaults to 0. This prevents themes of visibly "jumping" around in the tree after being added due to reordering.

Returns number
- Defined in src/tools/themes/themeshelper.ts:330

getMinimalClonedThemeForLayer

getMinimalClonedThemeForLayer(layer: BaseLayer): ThemeLayer
Parameters
- layer: BaseLayer
Returns ThemeLayer
- Defined in src/tools/themes/themeshelper.ts:153

initializeSingleton

initializeSingleton(): void
Returns void
Overrides GirafeSingleton.initializeSingleton
- Defined in src/tools/themes/themeshelper.ts:13

isNullOrUndefinedOrBlank

isNullOrUndefinedOrBlank(val: unknown): val is "" | null | undefined
Parameters
- val: unknown
Returns val is "" | null | undefined
Inherited from GirafeSingleton.isNullOrUndefinedOrBlank
- Defined in src/base/GirafeSingleton.ts:18

mergeThemeInLayerTree

mergeThemeInLayerTree(theme: ThemeLayer, activate?: boolean): BaseLayer[]
Parameters
- theme: ThemeLayer
- activate: boolean = false
Returns BaseLayer[]
- Defined in src/tools/themes/themeshelper.ts:337

removeLayersFromLayerTree

removeLayersFromLayerTree(layersToRemove: BaseLayer[]): void
Parameters
- layersToRemove: BaseLayer[]
Returns void
- Defined in src/tools/themes/themeshelper.ts:384