Interface Header

PMTiles v3 header storing basic archive-level information.

interface Header {
    centerLat: number;
    centerLon: number;
    centerZoom: number;
    clustered: boolean;
    etag?: string;
    internalCompression: Compression;
    jsonMetadataLength: number;
    jsonMetadataOffset: number;
    leafDirectoryLength?: number;
    leafDirectoryOffset: number;
    maxLat: number;
    maxLon: number;
    maxZoom: number;
    minLat: number;
    minLon: number;
    minZoom: number;
    numAddressedTiles: number;
    numTileContents: number;
    numTileEntries: number;
    rootDirectoryLength: number;
    rootDirectoryOffset: number;
    specVersion: number;
    tileCompression: Compression;
    tileDataLength?: number;
    tileDataOffset: number;
    tileType: TileType;
}

Properties

centerLat centerLon centerZoom clustered etag? internalCompression jsonMetadataLength jsonMetadataOffset leafDirectoryLength? leafDirectoryOffset maxLat maxLon maxZoom minLat minLon minZoom numAddressedTiles numTileContents numTileEntries rootDirectoryLength rootDirectoryOffset specVersion tileCompression tileDataLength? tileDataOffset tileType

Properties

centerLat

centerLat: number

centerLon

centerLon: number

centerZoom

centerZoom: number

clustered

clustered: boolean

Optional etag

etag?: string

internalCompression

internalCompression: Compression

jsonMetadataLength

jsonMetadataLength: number

jsonMetadataOffset

jsonMetadataOffset: number

Optional leafDirectoryLength

leafDirectoryLength?: number

leafDirectoryOffset

leafDirectoryOffset: number

maxLat

maxLat: number

maxLon

maxLon: number

maxZoom

maxZoom: number

minLat

minLat: number

minLon

minLon: number

minZoom

minZoom: number

numAddressedTiles

numAddressedTiles: number

numTileContents

numTileContents: number

numTileEntries

numTileEntries: number

rootDirectoryLength

rootDirectoryLength: number

rootDirectoryOffset

rootDirectoryOffset: number

specVersion

specVersion: number

tileCompression

tileCompression: Compression

Optional tileDataLength

tileDataLength?: number

tileDataOffset

tileDataOffset: number

tileType

tileType: TileType

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc