Interface ITiler

General type tiler which can be used to provide tile untiled payloads.

Hierarchy

ITiler

Implemented by

Index

Methods

Methods

connect

connect(): Promise<void>

- Defined in @here/harp-datasource-protocol/lib/ITiler.ts:21
Connect to tiler.

Should be implemented by implementations that use special resources that decode jobs like WebWorkers.

Returns Promise<void>

dispose

dispose(): void

- Defined in @here/harp-datasource-protocol/lib/ITiler.ts:54
Free all resources associated with this tiler.

Called by users when decoder is no longer used and all resources must be freed.

Returns void

getTile

getTile(indexId: string, tileKey: TileKey): Promise<{}>

- Defined in @here/harp-datasource-protocol/lib/ITiler.ts:47
Retrieves a tile for a previously registered index.

Parameters
- indexId: string
  
  Index identifier.
- tileKey: TileKey
  
  The TileKey that identifies the tile.
Returns Promise<{}>

registerIndex

registerIndex(indexId: string, indexUrl: URL | GeoJson): Promise<void>

- Defined in @here/harp-datasource-protocol/lib/ITiler.ts:30
Register index in the tiler. Indexes registered in the tiler can be later used to retrieved tiled payloads using getTile.

Parameters
- indexId: string
  
  Index identifier.
- indexUrl: URL | GeoJson
  
  Url to the index payload, or direct GeoJson.
Returns Promise<void>

updateIndex

updateIndex(indexId: string, indexUrl: URL | GeoJson): Promise<void>

- Defined in @here/harp-datasource-protocol/lib/ITiler.ts:39
Update index in the tiler. Indexes registered in the tiler can be later used to retrieved tiled payloads using getTile.

Parameters
- indexId: string
  
  Index identifier.
- indexUrl: URL | GeoJson
  
  Url to the index payload, or direct GeoJson.
Returns Promise<void>

Generated using TypeDoc