Interface MountedSource<T>Experimental

Live handle returned by mountSource. Owns every MapLibre resource the bridge created (source, layers, event listeners); dispose() is idempotent and removes all of them.

interface MountedSource<T> {
    diagnostics: MountedSourceDiagnostics;
    layerIds: readonly string[];
    sourceId: string;
    sourceLayer?: string;
    state: "ready" | "disposed";
    strategy: DataToMapStrategy;
    [asyncDispose](): PromiseLike<void>;
    dispose(): void;
    refresh(): Promise<MountedSourceDiagnostics>;
    setFilter(query: undefined | Readonly<Omit<Query<T>, "signal">>): Promise<MountedSourceDiagnostics>;
    setRenderer(renderer: undefined | Renderer): Promise<MountedSourceDiagnostics>;
}

Type Parameters

  • T = Record<string, unknown>

Hierarchy

  • AsyncDisposable
    • MountedSource

Properties

diagnostics layerIds sourceId sourceLayer? state strategy

Methods

[asyncDispose] dispose refresh setFilter setRenderer

Properties

Readonly Experimentaldiagnostics

diagnostics: MountedSourceDiagnostics

Readonly ExperimentallayerIds

layerIds: readonly string[]

Readonly ExperimentalsourceId

sourceId: string

Optional Readonly ExperimentalsourceLayer

sourceLayer?: string

Resolved vector source-layer used by the mounted layers — the explicit option, or the default derived from the query-tile descriptor. Always undefined for the GeoJSON strategy. Feature-state operations against a vector tile source must target this same value.

Readonly Experimentalstate

state: "ready" | "disposed"

Readonly Experimentalstrategy

strategy: DataToMapStrategy

Methods

[asyncDispose]

  • [asyncDispose](): PromiseLike<void>
  • Experimental

    Returns PromiseLike<void>

dispose

refresh

setFilter

setRenderer

  • setRenderer(renderer): Promise<MountedSourceDiagnostics>
  • Experimental

    Swap the mounted renderer and diff-update in place where MapLibre allows: when the layer structure is unchanged, paint/layout/filter are updated per property (setPaintProperty/setLayoutProperty/ setFilter) without layer teardown; a structural change (e.g. to or from a cluster/heatmap renderer) recreates only the owned layers, and changed GeoJSON cluster options recreate the source. Passing undefined restores the geometry-default styling.

    Parameters

    Returns Promise<MountedSourceDiagnostics>

Settings

Member Visibility

On This Page

Properties
Methods