Interface for a block of tiles including necessary metadata. For more details, refer to spec v02.

interface Block {
    blockOffset: number;
    colMax: number;
    colMin: number;
    column: number;
    level: number;
    row: number;
    rowMax: number;
    rowMin: number;
    tileCount: number;
    tileIndex?: TileIndex;
    tileIndexLength: number;
    tileIndexOffset: number;
}

Properties

blockOffset: number

Byte position where this block starts in the file container.

colMax: number

Maximum column index for tiles stored in this block (range: 0-255).

colMin: number

Minimum column index for tiles stored in this block (range: 0-255).

column: number

The column position of this block at the current zoom level.

level: number

The zoom level for this block.

row: number

The row position of this block at the current zoom level.

rowMax: number

Maximum row index for tiles stored in this block (range: 0-255).

rowMin: number

Minimum row index for tiles stored in this block (range: 0-255).

tileCount: number

The number of tiles contained in this block.

tileIndex?: TileIndex

Optional tile index if it has been fetched.

tileIndexLength: number

Length of the tile index in bytes.

tileIndexOffset: number

Byte position where the tile index starts within the container.