Class TileDao

Data Access Object for querying, inserting, and deleting tiles in a GeoPackage tile pyramid user data table.

The TileDao provides methods for accessing individual tiles by their grid coordinates and zoom level, iterating over tiles, retrieving zoom level metadata, and managing tile data.

Example

const tileDao = new TileDao(conn, 'my_tiles', tileMatrixSet);

// Query a specific tile
const tile = tileDao.queryForTile(0, 0, 0);
if (tile) {
  fs.writeFileSync('tile.png', tile.tile_data);
}

// Get available zoom levels
const zooms = tileDao.getZoomLevels();
console.log('Available zoom levels:', zooms);

Index

Constructors

constructor

new TileDao(
    conn: GeoPackageConnection,
    tableName: string,
    tileMatrixSet: TileMatrixSet,
): TileDao
Creates a new TileDao instance.
Parameters
- conn: GeoPackageConnection
  The GeoPackage database connection.
- tableName: string
  The name of the tile pyramid user data table.
- tileMatrixSet: TileMatrixSet
  The tile matrix set defining the spatial extent and SRS for the table.
Returns TileDao
- Defined in src/tiles/tile-dao.ts:67

Accessors

tableName

get tableName(): string
The name of the tile pyramid user data table.

Returns string
- Defined in src/tiles/tile-dao.ts:75

Methods

count

count(): number
Counts the total number of tiles across all zoom levels.

Returns number
The total tile count.
- Defined in src/tiles/tile-dao.ts:295

countAtZoomLevel

countAtZoomLevel(zoomLevel: number): number
Counts the number of tiles at a specific zoom level.
Parameters
- zoomLevel: number
  The zoom level to count tiles for.
Returns number
The number of tiles at the given zoom level.
- Defined in src/tiles/tile-dao.ts:282

deleteById

deleteById(id: number): number
Deletes a tile by its unique row ID.
Parameters
- id: number
  The primary key of the tile row to delete.
Returns number
The number of rows deleted (0 or 1).
- Defined in src/tiles/tile-dao.ts:202

deleteTile

deleteTile(column: number, row: number, zoomLevel: number): number
Deletes a tile at the specified grid position and zoom level.
Parameters
- column: number
  The tile column index.
- row: number
  The tile row index.
- zoomLevel: number
  The zoom level.
Returns number
The number of rows deleted (0 or 1).
- Defined in src/tiles/tile-dao.ts:186

getBoundingBox

getBoundingBox(): BoundingBox
Returns the bounding box of the tile matrix set as a BoundingBox.

The coordinates are in the coordinate reference system defined by the tile matrix set's SRS ID.

Returns BoundingBox
The spatial extent of the tile data.
- Defined in src/tiles/tile-dao.ts:267

getMaxZoom

getMaxZoom(): number | null
Returns the maximum zoom level containing tiles.

Returns number | null
The maximum zoom level, or null if the table contains no tiles.
- Defined in src/tiles/tile-dao.ts:242

getMinZoom

getMinZoom(): number | null
Returns the minimum zoom level containing tiles.

Returns number | null
The minimum zoom level, or null if the table contains no tiles.
- Defined in src/tiles/tile-dao.ts:230

getTileMatrices

getTileMatrices(): TileMatrix[]
Returns all tile matrices (zoom level definitions) for this tile table, ordered by zoom level ascending.

Returns TileMatrix[]
An array of TileMatrix records.
- Defined in src/tiles/tile-dao.ts:94

getTileMatrix

getTileMatrix(zoomLevel: number): TileMatrix | undefined
Retrieves the tile matrix definition for a specific zoom level.
Parameters
- zoomLevel: number
  The zoom level to query.
Returns TileMatrix | undefined
The TileMatrix for the specified zoom level, or undefined if not defined.
- Defined in src/tiles/tile-dao.ts:255

getTileMatrixSet

getTileMatrixSet(): TileMatrixSet
Returns the tile matrix set associated with this DAO.

Returns TileMatrixSet
The TileMatrixSet defining the spatial extent and coordinate reference system.
- Defined in src/tiles/tile-dao.ts:84

getZoomLevels

getZoomLevels(): number[]
Returns all distinct zoom levels that contain tiles, sorted in ascending order.

Returns number[]
An array of zoom level numbers.
Example
```
const levels = tileDao.getZoomLevels();
// e.g., [0, 1, 2, 3, 4]
```
- Defined in src/tiles/tile-dao.ts:218

insert

insert(
    row: {
        tile_column: number;
        tile_data: Buffer;
        tile_row: number;
        zoom_level: number;
    },
): number
Inserts a new tile into the table.
Parameters
- row: { tile_column: number; tile_data: Buffer; tile_row: number; zoom_level: number }
  The tile data to insert, including the zoom level, column, row, and binary tile data.
Returns number
The row ID of the newly inserted tile.
Example
```
const tileData = fs.readFileSync('tile.png');
const id = tileDao.insert({
  zoom_level: 5,
  tile_column: 10,
  tile_row: 20,
  tile_data: tileData,
});
console.log(`Inserted tile with ID: ${id}`);
```
- Defined in src/tiles/tile-dao.ts:167

queryForAll

queryForAll(): IterableIterator<TileRow>
Returns an iterator over all tiles in the table across all zoom levels.

Returns IterableIterator<TileRow>
An iterable iterator of all TileRow records.
- Defined in src/tiles/tile-dao.ts:145

queryForTile

queryForTile(
    column: number,
    row: number,
    zoomLevel: number,
): TileRow | undefined
Queries for a single tile at the specified grid position and zoom level.
Parameters
- column: number
  The tile column index.
- row: number
  The tile row index.
- zoomLevel: number
  The zoom level.
Returns TileRow | undefined
The tile row if found, or undefined if no tile exists at the specified position.
Example
```
const tile = tileDao.queryForTile(10, 20, 5);
if (tile) {
  console.log(`Tile size: ${tile.tile_data.length} bytes`);
}
```
- Defined in src/tiles/tile-dao.ts:114

queryForTilesAtZoom

queryForTilesAtZoom(zoomLevel: number): IterableIterator<TileRow>
Returns an iterator over all tiles at the specified zoom level.
Parameters
- zoomLevel: number
  The zoom level to query.
Returns IterableIterator<TileRow>
An iterable iterator of TileRow records at the given zoom level.
Example
```
for (const tile of tileDao.queryForTilesAtZoom(3)) {
  console.log(`Tile at column=${tile.tile_column}, row=${tile.tile_row}`);
}
```
- Defined in src/tiles/tile-dao.ts:136

Class TileDao

Example

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns TileDao

Accessors

tableName

Returns string

Methods

count

Returns number

countAtZoomLevel

Parameters

Returns number

deleteById

Parameters

Returns number

deleteTile

Parameters

Returns number

getBoundingBox

Returns BoundingBox

getMaxZoom

Returns number | null

getMinZoom

Returns number | null

getTileMatrices

Returns TileMatrix[]

getTileMatrix

Parameters

Returns TileMatrix | undefined

getTileMatrixSet

Returns TileMatrixSet

getZoomLevels

Returns number[]

Example

insert

Parameters

Returns number

Example

queryForAll

Returns IterableIterator<TileRow>

queryForTile

Parameters

Returns TileRow | undefined

Example

queryForTilesAtZoom

Parameters

Returns IterableIterator<TileRow>

Example

Settings

On This Page