Class S2PMTilesReader

constructor

• new S2PMTilesReader(path, rangeRequests?, maxSize?): S2PMTilesReader

• Given an input path, read in the header and root directory

  Parameters

  • path: string | Reader

    the location of the PMTiles data
  • rangeRequests: boolean = false

    FetchReader specific; enable range requests or use urlParam "bytes"
  • maxSize: number = 20

    the max size of the cache before dumping old data. Defaults to 20.

  Returns S2PMTilesReader

Readonlypath

getHeader

• getHeader(): Promise<Header>

• Returns Promise<Header>

  • the header of the archive

getMetadata

• getMetadata(): Promise<Metadata>

• Returns Promise<Metadata>

  • the metadata of the archive

getTile

• getTile(zoom, x, y): Promise<undefined | Uint8Array>

• Parameters

  • zoom: number

    the zoom level of the tile
  • x: number

    the x coordinate of the tile
  • y: number

    the y coordinate of the tile

  Returns Promise<undefined | Uint8Array>

  • the bytes of the tile at the given (z, x, y) coordinates, or undefined if the tile does not exist in the archive.

getTileS2

• getTileS2(face, zoom, x, y): Promise<undefined | Uint8Array>

• Parameters

  • face: Face

    the Open S2 projection face
  • zoom: number

    the zoom level of the tile
  • x: number

    the x coordinate of the tile
  • y: number

    the y coordinate of the tile

  Returns Promise<undefined | Uint8Array>

  • the bytes of the tile at the given (face, zoom, x, y) coordinates, or undefined if the tile does not exist in the archive.