Class ThemeLoader

Loads and validates a theme from URL objects.

Hierarchy

ThemeLoader

Index

Methods

Methods

Static isThemeLoaded

isThemeLoaded(theme: Theme): boolean

- Defined in @here/harp-mapview/lib/ThemeLoader.ts:165
Checks if theme instance is completely loaded, meaning that extends property is resolved.

Parameters
- theme: Theme
  
  -
Returns boolean

Static load

load(theme: string | Theme, options?: ThemeLoadOptions): Promise<Theme>

- Defined in @here/harp-mapview/lib/ThemeLoader.ts:125
Loads a {@link @here/harp-datasource-protocol#Theme} from a remote resource, provided as a URL that points to a JSON-encoded theme.

By default, resolves following features of theme:
- extends - loads and merges all inherited themes (see [[resolveBaseTheme]])
- ref - resolves all ref instances to their values defined in definitions section of theme (see [[resolveThemeReferences]])
Relative URIs of reference resources are resolved to full URL using the document's base URL (see [[resolveUrls]]).

Custom URIs (of theme itself and of resources referenced by theme) may be resolved with by providing {@link @here/harp-utils#UriResolver} using ThemeLoadOptions.uriResolver option.
Parameters
- theme: string | Theme
  
  {@link @here/harp-datasource-protocol#Theme} instance or theme URL to the theme.
- Optional options: ThemeLoadOptions
  
  Optional, a ThemeLoadOptions objects containing any custom settings for this load request.
Returns Promise<Theme>

Static loadAsync

loadAsync(themeUrl: string): Promise<Theme>

- Defined in @here/harp-mapview/lib/ThemeLoader.ts:181
deprecated

Please use ThemeLoader.load

Loads a {@link @here/harp-datasource-protocol#Theme} from a remote resource, provided as a URL that points to a JSON-encoded theme.

Parameters
- themeUrl: string
  
  The URL to the theme.
Returns Promise<Theme>

Generated using TypeDoc