flywave-mapview.poitable

Home > @flywave/flywave-mapview > PoiTable

PoiTable class

The PoiTable stores individual information for each POI type.

Signature:

export declare class PoiTable 

Remarks

If a has a reference to a PoiTable (if TextElement.poiInfo.poiTableName is set), information for the TextElement and its icon are read from the PoiTable.

The key to look up the POI is taken from the data, in case of OSM data with TileZen data, the poiNameField is set to kind, which makes the content of the field kind in the data the key to look up the POIs in the PoiTable.

On the side of the PoiTable, the key to look up the PoiTableEntry is either the property "name" of the [[PoiTableEntry]] (which should be unique), or the alternative list of names altNames, where each value should also be unique. If the property useAltNamesForKey is set to true, the altNames will be used.

Constructors

Constructor	Modifiers	Description
(constructor)(name, useAltNamesForKey)		Creates an instance of PoiTable.

Properties

Property	Modifiers	Type	Description
isLoading	readonly	boolean	Returns true if the table is currently being loaded, false otherwise.
loadedOk	readonly	boolean	Returns true if the table has been loaded correctly, false otherwise.
name	readonly	string
useAltNamesForKey	readonly	boolean

Methods

Method	Modifiers	Description
getEntry(poiName)		Gets [[PoiTableEntry]] for poi name specified.
load(poiTableUrl, abortSignal)		Start to load the PoiTable from the specified URL. Can only be called once per table.