Class PoiBuilder

Constructs PoiInfo objects from {@link @here/harp-datasource-protocol/Technique} and an icon.

Hierarchy

PoiBuilder

Index

Constructors

constructor

Methods

Constructors

constructor

new PoiBuilder(m_env: MapEnv | Env): PoiBuilder

- Defined in @here/harp-mapview/lib/poi/PoiBuilder.ts:40
Constructor

Parameters
- m_env: MapEnv | Env
  
  The {@link @link @here/harp-datasource-protocol#MapEnv} used to evaluate technique properties.
Returns PoiBuilder

Methods

build

build(textElement: TextElement): PoiInfo | undefined

- Defined in @here/harp-mapview/lib/poi/PoiBuilder.ts:100
Creates a PoiInfo for the given TextElement.

Parameters
- textElement: TextElement
  
  The text element the poi info will be attached to.
Returns PoiInfo | undefined

The created PoiInfo or undefined if no icon image was set for it.

withIcon

withIcon(imageTextureName?: undefined | string, shieldGroupIndex?: undefined | number): this

- Defined in @here/harp-mapview/lib/poi/PoiBuilder.ts:86
Sets an icon that will be used to create PoiInfos on subsequent calls to PoiBuilder.build until the next call to this method.

Parameters
- Optional imageTextureName: undefined | string
  
  The name of the icon image. If undefined, the image defined by the technique set on the last call to PoiBuilder.withTechnique wil be used.
- Optional shieldGroupIndex: undefined | number
  
  Index to a shield group if the icon belongs to one.
Returns this

This builder.

withTechnique

withTechnique(technique: PoiTechnique | LineMarkerTechnique & IndexedTechniqueParams): this

- Defined in @here/harp-mapview/lib/poi/PoiBuilder.ts:57
Sets a technique that will be used to create PoiInfos on subsequent calls to PoiBuilder.build until the next call to this method.

Parameters
- technique: PoiTechnique | LineMarkerTechnique & IndexedTechniqueParams
  
  The {@link @here/harp-datasource-protocol/Technique}.
Returns this

This builder.

Generated using TypeDoc