Class PoiTableManager

The PoiTableManager manages the list of [[PoiTables]] that can be defined in the {@link @here/harp-datasource-protocol#Theme} sfile.

Hierarchy

PoiTableManager

Index

Constructors

constructor

Properties

mapView

Accessors

Methods

Constructors

constructor

new PoiTableManager(mapView: MapView): PoiTableManager

- Defined in @here/harp-mapview/lib/poi/PoiTableManager.ts:302
Creates an instance of PoiTableManager.

Parameters
- mapView: MapView
  
  Owning MapView.
Returns PoiTableManager

Properties

Readonly mapView

mapView: MapView

Owning MapView.

Accessors

finishedLoading

get finishedLoading(): boolean

- Defined in @here/harp-mapview/lib/poi/PoiTableManager.ts:426
Return true if the PoiTables have finished loading.

readonly

Returns boolean

poiTables

get poiTables(): Map<string, PoiTable>

- Defined in @here/harp-mapview/lib/poi/PoiTableManager.ts:394
Return the map of PoiTables.

Returns Map<string, PoiTable>

Methods

addTable

addTable(poiTable: PoiTable): void

- Defined in @here/harp-mapview/lib/poi/PoiTableManager.ts:405
Manually add a PoiTable. Normally, the [[PoiTables]]s are specified in the {@link @here/harp-datasource-protocol#Theme}.

remarks

Ensure that the name is unique.

Parameters
- poiTable: PoiTable
Returns void

clear

clear(): void

- Defined in @here/harp-mapview/lib/poi/PoiTableManager.ts:383
Clear the list of PoiTables.

Returns void

getPoiTable

getPoiTable(poiTableName: string | undefined): PoiTable | undefined

- Defined in @here/harp-mapview/lib/poi/PoiTableManager.ts:417
Retrieve a PoiTable by name.

Parameters
- poiTableName: string | undefined
  
  Name of the PoiTable.
Returns PoiTable | undefined

The found poiTable if it could be found, undefined otherwise.

loadPoiTables

loadPoiTables(poiTables?: PoiTableRef[]): Promise<void>

- Defined in @here/harp-mapview/lib/poi/PoiTableManager.ts:324
Load the PoiTables that are stored in the MapViews {@link @here/harp-datasource-protocol#Theme}.

remarks

Note that duplicate names of PoiTables in the {@link @here/harp-datasource-protocol#Theme} will lead to inaccessible PoiTables.

Parameters
- Optional poiTables: PoiTableRef[]
  
  {@link @here/harp-datasource-protocol#PoiTableRef[]} containing all PoiTables to load.
Returns Promise<void>

Resolved once all the PoiTables in the {@link @here/harp-datasource-protocol#Theme} have been loaded.

Generated using TypeDoc