Class PoiManager

constructor

• new PoiManager(mapView): PoiManager

• The constructor of the PoiManager.

  Parameters

  • mapView: MapView

    The MapView instance that should display the POIs.

  Returns PoiManager

Readonly mapView

addImageTexture

• addImageTexture(imageTexture): void

• Add an @xyzmaps/harp-datasource-protocol#ImageTexture such that it is available as a named entity for techniques in theme files.

  Parameters

  • imageTexture: ImageTexture

    @xyzmaps/harp-datasource-protocol#ImageTexture that should be available for POIs.

  Returns void

addPois

• addPois(tile, decodedTile): void

• Add all POIs from a decoded tile and store them as TextElements in the Tile.

  Also handles LineMarkers, which is a recurring marker along a line (road).

  Parameters

  • tile: Tile

    Tile to add POIs to.

  • decodedTile: DecodedTile

    DecodedTile containing the raw @xyzmaps/harp-datasource-protocol#PoiGeometry objects describing the POIs.

  Returns void

addTextureAtlas

• addTextureAtlas(imageName, atlas, abortSignal?): Promise<void>

• Load the texture atlas that defines the segments of the texture that should be used for specific icons.

  Parameters

  • imageName: string

    Name of the image from the theme (NOT the url!).

  • atlas: string

    URL of the JSON file defining the texture atlas.

  • Optional abortSignal: AbortSignal

    Signal to Abort the loading of the Atlas Image

  Returns Promise<void>

  Remarks

  Creates an @xyzmaps/harp-datasource-protocol#ImageTexture for every element in the atlas, such that it can be addressed in the theme file.

clear

• clear(): void

• Clear internal state. Applicable when switching themes.

  Returns void

getImageTexture

• getImageTexture(name): undefined | ImageTexture

• Return the @xyzmaps/harp-datasource-protocol#ImageTexture registered under the specified name.

  Parameters

  • name: string

    Name of the @xyzmaps/harp-datasource-protocol#ImageTexture.

  Returns undefined | ImageTexture

updatePoiFromPoiTable

• updatePoiFromPoiTable(pointLabel): boolean

• Update the TextElement with the information taken from the PoiTable which is referenced in the PoiInfo of the pointLabel.

  If the requested PoiTable is not available yet, the function returns false. If the PoiTable is not defined, or if the references POI has no entry in the PoiTable, no action is taken, and the function returns false.

  If the PoiTable has been processed, it returns true, indicating that this function doesn't have to be called again.

  Parameters

  • pointLabel: TextElement

    The TextElement to update.

  Returns boolean

  true if the PoiTable has been processed, and the function does not have to be called again.