Class ThemeLoader

Loads and validates a theme from URL objects.

Hierarchy

ThemeLoader

Index

Constructors

Methods

isThemeLoaded load loadAsync

Constructors

constructor

new ThemeLoader(): ThemeLoader
Returns ThemeLoader

Methods

`Static` isThemeLoaded

isThemeLoaded(theme): boolean
Checks if theme instance is completely loaded, meaning that extends property is resolved.
Parameters
- theme: Theme
Returns boolean
- Defined in @xyzmaps/harp-mapview/lib/ThemeLoader.ts:166

`Static` load

load(theme, options?): Promise<Theme>
Loads a @xyzmaps/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 @xyzmaps/harp-utils#UriResolver using uriResolver option.
Parameters
- theme: string | Theme
  
  @xyzmaps/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>
- Defined in @xyzmaps/harp-mapview/lib/ThemeLoader.ts:126

`Static` loadAsync

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

Deprecated
Please use ThemeLoader.load

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

Generated using TypeDoc