@honua/sdk-js
    Preparing search index...

    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;
        specVersion?: number;
        tileKind: PmtilesTileKind;
        url: string;
        vectorLayers: readonly PmtilesVectorLayerInfo[];
    }
    Index

    Properties

    attribution? bounds center maxZoom metadata minZoom specVersion? tileKind url vectorLayers

    Properties

    attribution?: string

    Attribution string advertised in the archive metadata, when present.

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

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

    center: readonly [number, number, number]

    Suggested view center [lon, lat, zoom].

    maxZoom: number

    Highest zoom level present in the archive.

    metadata: Readonly<Record<string, unknown>>

    The raw, parsed archive metadata JSON.

    minZoom: number

    Lowest zoom level present in the archive.

    specVersion?: number

    PMTiles archive specification version advertised by the header.

    tileKind: PmtilesTileKind

    Tile payload kind stored in the archive.

    url: string

    Archive URL the description was read from.

    vectorLayers: readonly PmtilesVectorLayerInfo[]

    Vector layer definitions (empty for raster archives).

    Settings

    Member Visibility

    On This Page

    Properties