Class S2PMTilesWriter

Write a PMTiles file.

Index

Constructors

Properties

compression type writer

Methods

commit writeTile writeTileS2 writeTileXYZ

Constructors

constructor

new S2PMTilesWriter(
    writer: Writer,
    type: TileType,
    compression?: Compression,
): S2PMTilesWriter
Parameters
- writer: Writer
  the writer to append to
- type: TileType
  the tile type
- compression: Compression = Compression.Gzip
  the compression algorithm
Returns S2PMTilesWriter

Properties

`Readonly`compression

compression: Compression = Compression.Gzip

the compression algorithm

`Readonly`type

the tile type

`Readonly`writer

writer: Writer

the writer to append to

Methods

commit

commit(metadata: Metadata): Promise<void>
Finish writing by building the header with root and leaf directories
Parameters
- metadata: Metadata
  the metadata to store
Returns Promise<void>

writeTile

writeTile(tileID: number, data: Uint8Array, face?: Face): Promise<void>
Write a tile to the PMTiles file given its tile ID.
Parameters
- tileID: number
  the tile ID
- data: Uint8Array
  the tile data
- Optionalface: Face
  If it exists, then we are storing S2 data
Returns Promise<void>

writeTileS2

writeTileS2(
    face: Face,
    zoom: number,
    x: number,
    y: number,
    data: Uint8Array,
): Promise<void>
Write a tile to the PMTiles file given its (face, zoom, x, y) coordinates.
Parameters
- face: Face
  the Open S2 projection face
- zoom: number
  the zoom level
- x: number
  the tile X coordinate
- y: number
  the tile Y coordinate
- data: Uint8Array
  the tile data to store
Returns Promise<void>

writeTileXYZ

writeTileXYZ(
    zoom: number,
    x: number,
    y: number,
    data: Uint8Array,
): Promise<void>
Write a tile to the PMTiles file given its (z, x, y) coordinates.
Parameters
- zoom: number
  the zoom level
- x: number
  the tile X coordinate
- y: number
  the tile Y coordinate
- data: Uint8Array
  the tile data to store
Returns Promise<void>