Interface UseMountedSourceOptions<T>Experimental

Options for useMountedSource.

interface UseMountedSourceOptions<T> {
    attribution?: string;
    beforeId?: string;
    enabled?: boolean;
    fitBounds?: boolean | {
        padding?: number;
    };
    geometry?: "auto" | MapLibreGeometryKind;
    hover?: boolean | {
        stateKey?: string;
    };
    layerId?: string;
    layers?: readonly Readonly<Record<string, unknown>>[];
    layout?: Partial<Readonly<Record<MapLibreGeometryKind | "polygonOutline", Readonly<Record<string, unknown>>>>>;
    maxGeoJsonFeatures?: number;
    onDiagnostics?: ((diagnostics: MountedSourceDiagnostics) => void);
    onError?: ((error: unknown) => void);
    paint?: Partial<Readonly<Record<MapLibreGeometryKind | "polygonOutline", Readonly<Record<string, unknown>>>>>;
    popup?: MountSourcePopupOptions;
    query?: Readonly<Omit<Query<T>, "signal">>;
    queryTiles?: QueryTileSourceDescriptor<T>;
    renderer?: Renderer;
    sourceId?: string;
    sourceLayer?: string;
    strategy?: DataToMapStrategy;
}

Type Parameters

  • T = Record<string, unknown>

Hierarchy

Properties

attribution? beforeId? enabled? fitBounds? geometry? hover? layerId? layers? layout? maxGeoJsonFeatures? onDiagnostics? onError? paint? popup? query? queryTiles? renderer? sourceId? sourceLayer? strategy?

Properties

Optional Readonly Experimentalattribution

attribution?: string

Attribution override; defaults to the source descriptor's attribution.

Optional Readonly ExperimentalbeforeId

beforeId?: string

Existing layer id to insert the bridge layers before.

Optional Experimentalenabled

enabled?: boolean

When false, nothing is mounted (and any existing mount is disposed). Default true.

Optional Readonly ExperimentalfitBounds

fitBounds?: boolean | {
    padding?: number;
}

Fit the map to the mounted data (GeoJSON bbox or tile descriptor bounds).

Optional Readonly Experimentalgeometry

geometry?: "auto" | MapLibreGeometryKind

Restrict default styling to one geometry kind, or "auto" (default) to install the stable point/line/polygon(+outline) matrix so filter changes can move between geometry kinds without structural layer churn.

Optional Readonly Experimentalhover

hover?: boolean | {
    stateKey?: string;
}

Toggle a boolean feature-state key (default "hover") while the pointer is over a feature. Requires event and feature-state map methods, and feature ids (schema.primaryKey or GeoJSON feature ids).

Optional Readonly ExperimentallayerId

layerId?: string

Base layer id; geometry suffixes (-point, -line, …) are appended. Defaults to the source id.

Optional Readonly Experimentallayers

layers?: readonly Readonly<Record<string, unknown>>[]

Full layer override: the bridge adds these layers verbatim (injecting source, and source-layer for the tile strategy, when absent) instead of the geometry-appropriate defaults. Each entry must carry a unique id.

Optional Readonly Experimentallayout

layout?: Partial<Readonly<Record<MapLibreGeometryKind | "polygonOutline", Readonly<Record<string, unknown>>>>>

Per-geometry layout overrides.

Optional Readonly ExperimentalmaxGeoJsonFeatures

maxGeoJsonFeatures?: number

Bound (and result-size heuristic threshold) for GeoJSON materialization. Truncation is reported through MountedSourceDiagnostics.overflow.

Default

10000

OptionalonDiagnostics

onDiagnostics?: ((diagnostics: MountedSourceDiagnostics) => void)

Called with fresh diagnostics after the mount and after every applied update.

OptionalonError

onError?: ((error: unknown) => void)

Called when mounting or a diff update fails (aborted mounts are silent).

Optional Readonly Experimentalpaint

paint?: Partial<Readonly<Record<MapLibreGeometryKind | "polygonOutline", Readonly<Record<string, unknown>>>>>

Per-geometry paint overrides merged over the defaults.

Optional Readonly Experimentalpopup

popup?: MountSourcePopupOptions

Open a popup on layer click. Requires map.on/map.off.

Optional Readonly Experimentalquery

query?: Readonly<Omit<Query<T>, "signal">>

Initial filter applied to the mounted data. Replaced by setFilter.

Optional Readonly ExperimentalqueryTiles

queryTiles?: QueryTileSourceDescriptor<T>

Dynamic query-tile source descriptor enabling the "query-tiles" strategy (see @honua/sdk-js/runtime query-tile helpers). Without it the bridge can only materialize GeoJSON, even when the source declares the tiles capability.

Optional Readonly Experimentalrenderer

renderer?: Renderer

First-class renderer object from @honua/sdk-js/style (classBreaksRenderer, uniqueValueRenderer, heatmapRenderer, clusterRenderer). Layers and paint derive from the renderer instead of the geometry defaults; paint/layout overrides still win per property. A cluster renderer additionally configures GeoJSON-source clustering and requires the "geojson" strategy. Mutually exclusive with layers. Swap at runtime with MountedSource.setRenderer.

Optional Readonly ExperimentalsourceId

sourceId?: string

MapLibre source id.

Default

honua-<descriptor id>

Optional Readonly ExperimentalsourceLayer

sourceLayer?: string

Vector source-layer for the tile strategy. Defaults to the tile descriptor's sourceId.

Optional Readonly Experimentalstrategy

strategy?: DataToMapStrategy

Force a strategy instead of capability + result-size selection. "query-tiles" requires MountSourceOptions.queryTiles.

Settings

Member Visibility

On This Page

Properties