Interface HonuaSourceLayerProps<T>Experimental

Props for HonuaSourceLayer.

interface HonuaSourceLayerProps<T> {
    attribution?: string;
    beforeId?: string;
    enabled?: boolean;
    fitBounds?: boolean | {
        padding?: number;
    };
    hover?: boolean | {
        stateKey?: string;
    };
    layerId?: string;
    map?: null | DataToMapLibreMap;
    maxGeoJsonFeatures?: number;
    onDiagnostics?: ((diagnostics: MountedSourceDiagnostics) => void);
    onError?: ((error: unknown) => void);
    popup?: MountSourcePopupOptions;
    query?: Readonly<Omit<Query<T>, "signal">>;
    queryTiles?: QueryTileSourceDescriptor<T>;
    renderer?: Renderer | HonuaSourceRenderer<T>;
    selection?: boolean | {
        multiSelect?: boolean;
        stateKey?: string;
    };
    source: undefined | null | Source<T>;
    sourceId?: string;
    sourceLayer?: string;
    strategy?: DataToMapStrategy;
}

Type Parameters

  • T = Record<string, unknown>

Properties

attribution? beforeId? enabled? fitBounds? hover? layerId? map? maxGeoJsonFeatures? onDiagnostics? onError? popup? query? queryTiles? renderer? selection? source sourceId? sourceLayer? strategy?

Properties

Optional Experimentalattribution

attribution?: string

Attribution override.

Optional ExperimentalbeforeId

beforeId?: string

Existing layer id to insert the bridge layers before.

Optional Experimentalenabled

enabled?: boolean

When false, nothing is mounted.

Default

true

Optional ExperimentalfitBounds

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

Fit the map to the mounted data.

Optional Experimentalhover

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

Toggle hover feature-state on the mounted layers (bridge hover option).

Optional ExperimentallayerId

layerId?: string

Base layer id override; geometry suffixes are appended.

Optional Experimentalmap

map?: null | DataToMapLibreMap

Target map. Omit to resolve the nearest enclosing HonuaMap / HonuaMapProvider (external-map interop).

Optional ExperimentalmaxGeoJsonFeatures

maxGeoJsonFeatures?: number

GeoJSON materialization bound.

Default

10000

OptionalonDiagnostics

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

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

OptionalonError

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

Called when mounting or an update fails.

Optional Experimentalpopup

popup?: MountSourcePopupOptions

Open a popup on feature click (factory usually () => new maplibregl.Popup()).

Optional Experimentalquery

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

Filter applied to the mounted data; changes diff via setFilter.

Optional ExperimentalqueryTiles

queryTiles?: QueryTileSourceDescriptor<T>

Dynamic query-tile descriptor enabling the tile strategy.

Optional Experimentalrenderer

renderer?: Renderer | HonuaSourceRenderer<T>

Styling: either a first-class renderer object from @honua/sdk-js/style (diffed via setRenderer) or a HonuaSourceRenderer bag of geometry restriction + paint/layout overrides or custom layers.

Optional Experimentalselection

selection?: boolean | {
    multiSelect?: boolean;
    stateKey?: string;
}

Share feature selection with the enclosing HonuaSelectionProvider: clicks toggle the shared selection and the shared selection is mirrored onto feature-state (default key "selected"). Also publishes hover to the provider when hover is enabled. No-op without a provider.

Experimentalsource

source: undefined | null | Source<T>

The contract Source to mount. null while it is still resolving.

Optional ExperimentalsourceId

sourceId?: string

MapLibre source id override.

Default

honua-<descriptor id>

Optional ExperimentalsourceLayer

sourceLayer?: string

Vector source-layer for the tile strategy.

Optional Experimentalstrategy

strategy?: DataToMapStrategy

Force a bridge strategy ("geojson" / "query-tiles").

Settings

Member Visibility

On This Page

Properties