Interface LoadMapPackageOptions

Hierarchy (view full)

Properties

applyInitialView?: boolean

When true, apply pkg.initialView to the map immediately after load. Defaults to true.

client: HonuaClient

Active HonuaClient; used for protocol adapter binding.

disableDefaultStyleRefResolver?: boolean

Disable the default /ogc/styles StyleRef resolver. When true and no resolveStyleRef callback is supplied, style refs without an inline body are left unresolved (composition then errors on them).

Listener registered on the runtime before the first source-ready / package-loaded emissions so callers can observe the initial lifecycle without race-binding through runtime.on(...). Equivalent to calling runtime.on(listener) immediately after construction. Subsequent events (updatePackage, disposed, …) also flow through this listener.

popupFactory?: PopupFactory

Optional popup factory; required only if the caller calls runtime.bindPopup.

popupRenderer?: PopupRenderer

Optional popup renderer; defaults to an unstyled <dl> of feature properties.

resolveSource?: SourceResolver

Resolver passed to createDataset for adapters the built-in set (geoservices-*, ogc-features) does not cover — typically the WFS/WMS/OData/tile-layer adapters contributed by #24#28.

resolveStyleRef?: StyleRefResolver

Out-of-band style-ref body resolver. Only called when the ref has no inline body. When omitted, the runtime defaults to resolving styleRefs.styleId against the server's OGC API – Styles surface (GET /ogc/styles/{styleId}, content-negotiated MapLibre) via createOgcStyleRefResolver, so the JS identifier matches the server's canonical styleId. Pass a callback to override that path (back-compat), or set disableDefaultStyleRefResolver to skip it.

resolveTheme?: ThemeResolver

Out-of-band theme resolver. Only called when pkg.theme is absent and pkg.themeId is set.

skipCompatibilityCheck?: boolean

Skip client.checkCompatibility() — useful in tests and conformance fixtures.

sourceErrorPolicy?: SourceErrorPolicy

Per-source binding error policy. Defaults to "tolerant": a single source failing to bind (resolver throws, toHonuaSourceSpec throws, dataset.source(id) throws) does not abort the whole package load. Failed sources surface via source-error events and the HonuaRuntimeTelemetry.error hook; remaining sources continue to render. Pass "fail-fast" to reject the load on any per-source binding failure (the historical single-source behaviour).

styleSpecValidationMode?: RuntimeStyleSpecValidationMode

MapLibre style-spec validation mode used by runtime source/layer mutation helpers. Defaults to "strict"; pass "warning-only" to keep diagnostics non-fatal, or "renderer-deferred" to skip SDK style-spec checks and let the renderer report invalid style values.

Telemetry collector; wired through the HonuaClient interceptor chain.