Class WorkerBasedTiler

Tiler based on [[ConcurrentWorkerSet]].

Tiles payloads using workers running in separate contexts (also known as WebWorkers):

connection establishment,
sends tile requests,
configuration.

Hierarchy

WorkerBasedTiler

Implements

ITiler

Index

Constructors

Methods

connect dispose getTile registerIndex updateIndex

Constructors

constructor

new WorkerBasedTiler(workerSet, tilerServiceType): WorkerBasedTiler
Creates a new WorkerBasedTiler.
Parameters
- workerSet: ConcurrentWorkerSet
  
  [[ConcurrentWorkerSet]] this tiler will live in.
- tilerServiceType: string
  
  Service type identifier.
Returns WorkerBasedTiler
- Defined in @xyzmaps/harp-mapview/lib/WorkerBasedTiler.ts:42

Methods

connect

connect(): Promise<void>
Connects to [[WorkerServiceManager]]s in underlying [[ConcurrentWorkerSet]] and creates dedicated [[TilerService]]s in all workers to serve tiling requests.

Returns Promise<void>
Implementation of ITiler.connect
- Defined in @xyzmaps/harp-mapview/lib/WorkerBasedTiler.ts:73

dispose

dispose(): void
Dispose of dedicated tiler services in workers and remove reference to underlying [[ConcurrentWorkerSet]].

Returns void
Implementation of ITiler.dispose
- Defined in @xyzmaps/harp-mapview/lib/WorkerBasedTiler.ts:54

getTile

getTile(indexId, tileKey): Promise<{}>
Retrieves a tile for a previously registered index.
Parameters
- indexId: string
  
  Index identifier.
- tileKey: TileKey
  
  The @xyzmaps/harp-geoutils#TileKey that identifies the tile.
Returns Promise<{}>
Implementation of ITiler.getTile
- Defined in @xyzmaps/harp-mapview/lib/WorkerBasedTiler.ts:127

registerIndex

registerIndex(indexId, input): Promise<void>
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.
- input: URL | GeoJson
  
  Url to the index payload, or direct GeoJSON.
Returns Promise<void>
Implementation of ITiler.registerIndex
- Defined in @xyzmaps/harp-mapview/lib/WorkerBasedTiler.ts:96

updateIndex

updateIndex(indexId, input): Promise<void>
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.
- input: URL | GeoJson
  
  Url to the index payload, or direct GeoJSON.
Returns Promise<void>
Implementation of ITiler.updateIndex
- Defined in @xyzmaps/harp-mapview/lib/WorkerBasedTiler.ts:112

Generated using TypeDoc