Interface ThemeLoadOptions

Options to customize @xyzmaps/harp-datasource-protocol#Theme loading process.

See

load

Hierarchy

  • ThemeLoadOptions

Properties

logger?: ISimpleChannel

Custom logging channel on which diagnostics and warnings will be reported.

If not specified, load will log to console.

maxInheritanceDepth?: number

Maximum recursion depth when resolving base themes through [@xyzmaps/harp-datasource-protocol#Themes extends property.

Default

[[DEFAULT_MAX_THEME_INTHERITANCE_DEPTH]]
resolveDefinitions?: boolean

Whether to resolve ref expressions in definition and styles elements.

Default

false, as datasources resolve definitions in [[StyleSetEvaluator]].

resolveIncludeUris?: boolean

Resolve the URIs of inherited themes (using extends feature). If true, [[uriResolver]] will be used to resolve the URI

Default

true
resolveResourceUris?: boolean

Resolve the URIs to resources like fonts, icons, ... If true, [[uriResolver]] will be used to resolve the URI

Default

true
signal?: AbortSignal

An AbortSignal object instance; allows you to communicate with a loading process (including fetch requests) request and abort it if desired via an AbortController.

Modeled after Web APIs fetchs init.signal.

uriResolver?: UriResolver

Resolve asset URIs referenced in Theme assets using this resolver.

Generated using TypeDoc