Class ThemesHelper

Hierarchy (View Summary)

GirafeSingleton
- ThemesHelper

Constructors

constructor

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

Properties

`Protected` `Readonly`context

context: IGirafeContext

Methods

addGroupsFromUrl

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

addLayerFromName

addLayerFromName(layername: string): boolean
Parameters
- layername: string
Returns boolean
- Defined in tools/themes/themeshelper.ts:264

addLayersFromUrl

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

addThemesFromUrl

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

emptyLayerTree

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

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

findBaseLayerById

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

findGroupByName

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

findLayerByName

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

findThemeByName

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

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 tools/themes/themeshelper.ts:381

getMinimalClonedThemeForLayer

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

initializeSingleton

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

`Protected`isNullOrUndefinedOrBlank

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

mergeThemeInLayerTree

mergeThemeInLayerTree(
    theme: ThemeLayer,
    activate?: boolean,
    forceTop?: boolean,
): LayerTreeChanges
Parameters
- theme: ThemeLayer
- activate: boolean = false
- forceTop: boolean = false
Returns LayerTreeChanges
- Defined in tools/themes/themeshelper.ts:388

removeLayersFromLayerTree

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