Interface PmtilesArchiveDescription

The archive metadata surfaced by describePmtilesArchive. Bounds are [west, south, east, north] in degrees; center is [lon, lat, zoom]. The raw metadata JSON is preserved on metadata for callers that need archive fields beyond the normalized shape.

interface PmtilesArchiveDescription {
    attribution?: string;
    bounds: readonly [number, number, number, number];
    center: readonly [number, number, number];
    maxZoom: number;
    metadata: Readonly<Record<string, unknown>>;
    minZoom: number;
    tileKind: PmtilesTileKind;
    url: string;
    vectorLayers: readonly PmtilesVectorLayerInfo[];
}

Properties

attribution? bounds center maxZoom metadata minZoom tileKind url vectorLayers

Properties

Optional Readonlyattribution

attribution?: string

Attribution string advertised in the archive metadata, when present.

Readonlybounds

bounds: readonly [number, number, number, number]

Geographic bounds [west, south, east, north] in degrees.

Readonlycenter

center: readonly [number, number, number]

Suggested view center [lon, lat, zoom].

ReadonlymaxZoom

maxZoom: number

Highest zoom level present in the archive.

Readonlymetadata

metadata: Readonly<Record<string, unknown>>

The raw, parsed archive metadata JSON.

ReadonlyminZoom

minZoom: number

Lowest zoom level present in the archive.

ReadonlytileKind

tileKind: PmtilesTileKind

Tile payload kind stored in the archive.

Readonlyurl

url: string

Archive URL the description was read from.

ReadonlyvectorLayers

vectorLayers: readonly PmtilesVectorLayerInfo[]

Vector layer definitions (empty for raster archives).

Settings

Member Visibility

On This Page

Properties