Class HonuaMapRuntime

Readonlymap

composedStyle

• get composedStyle(): HonuaStyleSpecification

• The composed MapLibre style last handed to the underlying map.

  Returns HonuaStyleSpecification

dataset

• get dataset(): Dataset

• The Dataset bound to the current package's source bindings. The reference is replaced after every successful updatePackage call so a source-binding locator or filter change is visible through runtime.dataset.source(id).

  Returns Dataset

honuaMap

• get honuaMap(): HonuaMap

• The HonuaMap owning the current package's sources and layers. The reference is replaced after every successful updatePackage call so consumers always observe the live source and layer specs rather than the ones captured at first load.

  Returns HonuaMap

mapPackage

• get mapPackage(): HonuaMapPackage

• The currently applied package.

  Returns HonuaMapPackage

addLayer

• addLayer(layer, order?): void

• Parameters

  • layer: RuntimeLayerSpecification
  • Optionalorder: RuntimeLayerOrder

  Returns void

addSource

• addSource(sourceId, source): void

• Parameters

  • sourceId: string
  • source: RuntimeSourceSpecification

  Returns void

bindClick

• bindClick(layerId, handler, options?): {
      remove(): void;
  }

• Parameters

  • layerId: string
  • handler: RuntimeClickInteractionHandler
  • options: RuntimeClickInteractionOptions = {}

  Returns {
      remove(): void;
  }

  • remove:function

    • remove(): void

    • Returns void

bindHover

• bindHover(layerId, options?): HoverHandle

• Parameters

  • layerId: string
  • options: RuntimeHoverInteractionOptions = {}

  Returns HoverHandle

bindPopup

• bindPopup(layerId, binding?): {
      remove(): void;
  }

• Parameters

  • layerId: string
  • Optionalbinding: HonuaMapPackagePopupBinding

  Returns {
      remove(): void;
  }

  • remove:function

    • remove(): void

    • Returns void

bindSelect

• bindSelect(layerId, options?): SelectionHandle

• Parameters

  • layerId: string
  • options: RuntimeSelectionInteractionOptions = {}

  Returns SelectionHandle

bindSelectionToExploration

• bindSelectionToExploration(layerId, view, options?): SelectionHandle

• Parameters

  • layerId: string
  • view: ExplorationViewController
  • options: RuntimeExplorationSelectionOptions = {}

  Returns SelectionHandle

dispose

• dispose(): void

• Returns void

getFeatureStateForTarget

• getFeatureStateForTarget(target): Record<string, unknown>

• Parameters

  • target: SourceQualifiedFeatureSelectionTarget | RuntimeFeatureStateTarget

  Returns Record<string, unknown>

getLegend

• getLegend(): LegendEntry[]

• Returns LegendEntry[]

hitTest

• hitTest(input, options?): Promise<HonuaHitTestResult>

• Parameters

  • input: unknown
  • options: HonuaHitTestOptions = {}

  Returns Promise<HonuaHitTestResult>

layerSelectionTarget

• layerSelectionTarget(layerId, id): SourceQualifiedFeatureSelectionTarget

• Parameters

  • layerId: string
  • id: FeatureId

  Returns SourceQualifiedFeatureSelectionTarget

moveLayer

• moveLayer(layerId, order?): void

• Parameters

  • layerId: string
  • Optionalorder: RuntimeLayerOrder

  Returns void

on

• on(listener): {
      remove(): void;
  }

• Parameters

  • listener: HonuaRuntimeEventListener

  Returns {
      remove(): void;
  }

  • remove:function

    • remove(): void

    • Returns void

onPointer

• onPointer(handler, options?): {
      remove(): void;
  }

• Parameters

  • handler: RuntimePointerInteractionHandler
  • options: RuntimePointerInteractionOptions = {}

  Returns {
      remove(): void;
  }

  • remove:function

    • remove(): void

    • Returns void

refreshSource

• refreshSource(sourceId): boolean

• Parameters

  • sourceId: string

  Returns boolean

removeFeatureStateForTarget

• removeFeatureStateForTarget(target, key?): void

• Parameters

  • target: SourceQualifiedFeatureSelectionTarget | RuntimeFeatureStateTarget
  • Optionalkey: string

  Returns void

removeLayer

• removeLayer(layerId): boolean

• Parameters

  • layerId: string

  Returns boolean

removeSource

• removeSource(sourceId): string[]

• Parameters

  • sourceId: string

  Returns string[]

reportSourceError

• reportSourceError(sourceId, error): void

• Surface a per-source failure detected outside the loader path — typically a query / stream rejection in a mixed-source fan-out (the canonical consumer is #29's operator components). Emits the existing source-error runtime event so listeners do not have to subscribe to a parallel error channel and pipes the failure through HonuaRuntimeTelemetry.error as a source-bind span if the consumer wired one up.

  Idempotent and side-effect-free outside listener / telemetry fan-out: the runtime does not retry, suppress, or reshape the underlying source. Disposed runtimes silently no-op so a late rejection from a stream never throws inside an event handler.

  Parameters

  • sourceId: string
  • error: unknown

  Returns void

setFeatureStateForTarget

• setFeatureStateForTarget(target, state): void

• Parameters

  • target: SourceQualifiedFeatureSelectionTarget | RuntimeFeatureStateTarget
  • state: Record<string, unknown>

  Returns void

setLayerFilter

• setLayerFilter(layerId, filter): void

• Parameters

  • layerId: string
  • filter: unknown

  Returns void

setLayerLayout

• setLayerLayout(layerId, layout): void

• Parameters

  • layerId: string
  • layout: RuntimeLayoutSpecification

  Returns void

setLayerPaint

• setLayerPaint(layerId, paint): void

• Parameters

  • layerId: string
  • paint: RuntimePaintSpecification

  Returns void

setLayerVisibility

• setLayerVisibility(layerId, visible): void

• Parameters

  • layerId: string
  • visible: boolean

  Returns void

setViewState

• setViewState(view): void

• Parameters

  • view: SetViewStateInput

  Returns void

syncSelectionFromExploration

• syncSelectionFromExploration(layerId, view, options?): {
      remove(): void;
  }

• Parameters

  • layerId: string
  • view: ExplorationViewController
  • options: Omit<RuntimeExplorationSelectionOptions, "multiSelect" | "onChange" | "onSelectionTargetsChange"> = {}

  Returns {
      remove(): void;
  }

  • remove:function

    • remove(): void

    • Returns void

updateLayer

• updateLayer(layerId, update): void

• Parameters

  • layerId: string
  • update: RuntimeLayerUpdate

  Returns void

updatePackage

• updatePackage(next): Promise<void>

• Diff the current package against next. Applies the change incrementally when safe; falls back to map.setStyle for structural changes. Preserves unknown fields from next on round-trip.

  Parameters

  • next: HonuaMapPackage

  Returns Promise<void>

updateSource

• updateSource(sourceId, source): void

• Parameters

  • sourceId: string
  • source: RuntimeSourceSpecification

  Returns void

validateFilterExpression

• validateFilterExpression(filter, layerId?): HonuaRuntimeDiagnostic[]

• Parameters

  • filter: unknown
  • OptionallayerId: string

  Returns HonuaRuntimeDiagnostic[]

validateStyleExpression

• validateStyleExpression(value): HonuaRuntimeDiagnostic[]

• Parameters

  • value: unknown

  Returns HonuaRuntimeDiagnostic[]