Interface MapLibreRendererOptions

Adapter-specific construction and automatic-strategy controls.

interface MapLibreRendererOptions {
    beforeId?: string;
    evidence?: {
        maxAgeMs: number;
        now: string;
        observedAt: string;
    };
    firstFrameEvent?: "render" | "idle";
    format?: string;
    geometry?: "auto" | MapLibreGeometryKind;
    layerId?: string;
    layout?: Readonly<Record<string, unknown>>;
    mapOptions?: Readonly<Record<string, unknown>>;
    maxzoom?: number;
    minzoom?: number;
    offlineRegion?: {
        tileHandler: OfflineRegionTileHandler;
    };
    override?: AutomaticMapLibreStrategy;
    paint?: Readonly<Record<string, unknown>>;
    pmtilesType?: "vector" | "raster";
    queryTileSource?: AutomaticMapLibreNativeSourceSpec;
    sourceId?: string;
    sourceLayer?: string;
    tileSize?: number;
    transparent?: boolean;
}

Hierarchy

Properties

beforeId? evidence? firstFrameEvent? format? geometry? layerId? layout? mapOptions? maxzoom? minzoom? offlineRegion? override? paint? pmtilesType? queryTileSource? sourceId? sourceLayer? tileSize? transparent?

Properties

Optional ReadonlybeforeId

beforeId?: string

Optional Readonlyevidence

evidence?: {
    maxAgeMs: number;
    now: string;
    observedAt: string;
}

Caller-observed metadata time and explicit freshness budget.

Type declaration

  • ReadonlymaxAgeMs: number
  • Readonlynow: string

    Explicit clock evidence keeps planning deterministic.

  • ReadonlyobservedAt: string

Optional ReadonlyfirstFrameEvent

firstFrameEvent?: "render" | "idle"

Defaults to render, the first frame that can contain the mounted layer.

Optional Readonlyformat

format?: string

Optional Readonlygeometry

geometry?: "auto" | MapLibreGeometryKind

Optional ReadonlylayerId

layerId?: string

Optional Readonlylayout

layout?: Readonly<Record<string, unknown>>

Optional ReadonlymapOptions

mapOptions?: Readonly<Record<string, unknown>>

Map-constructor options for an owned selector/element target; invalid for an existing map host.

Optional Readonlymaxzoom

maxzoom?: number

Optional Readonlyminzoom

minzoom?: number

Optional ReadonlyofflineRegion

offlineRegion?: {
    tileHandler: OfflineRegionTileHandler;
}

Tile handler for a style that addresses a persisted offline region.

Registered before an owned map is constructed, but only when the style actually references the offline-region:// scheme. A style that references it without a handler fails construction instead of rendering blank tiles.

Optional Readonlyoverride

override?: AutomaticMapLibreStrategy

Optional Readonlypaint

paint?: Readonly<Record<string, unknown>>

Optional ReadonlypmtilesType

pmtilesType?: "vector" | "raster"

Archive payload evidence obtained from PMTiles metadata.

Optional ReadonlyqueryTileSource

queryTileSource?: AutomaticMapLibreNativeSourceSpec

A source spec built by the dynamic-query-tile helpers.

Optional ReadonlysourceId

sourceId?: string

Optional ReadonlysourceLayer

sourceLayer?: string

Required layer name for vector tile and vector PMTiles sources.

Optional ReadonlytileSize

tileSize?: number

Optional Readonlytransparent

transparent?: boolean

Settings

Member Visibility

On This Page

Properties