Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PoiInfo

Additional information for an icon that is to be rendered along with a TextElement.

internal

Hierarchy

  • PoiInfo

Index

Properties

Optional iconBrightness

iconBrightness: undefined | number

Icon brightness.

see

{@link @here/harp-datasource-protocol#MarkerTechniqueParams.iconBrightness};

Optional iconColor

iconColor: THREE.Color

Icon color override

see

{@link @here/harp-datasource-protocol#MarkerTechniqueParams.iconColor};

Optional iconIsOptional

iconIsOptional: undefined | false | true

If true, the text will appear even if the icon is blocked by other labels or if it cannot be rendered because of missing icon graphics. Defaults to false.

Optional iconMaxZoomLevel

iconMaxZoomLevel: undefined | number

Maximum zoomLevel at which to display the label icon. No default.

Optional iconMinZoomLevel

iconMinZoomLevel: undefined | number

Minimum zoomLevel at which to display the label icon. No default.

Optional imageTextureName

imageTextureName: undefined | string

Name of the {@link @here/harp-datasource-protocol#ImageTexture} or image in {@link @here/harp-mapview#userImageCache}.

Optional isValid

isValid: undefined | false | true

If isValid is false, the icon will no longer be placed or rendered. The reason may be a missing resource. Defaults to false.

Optional mayOverlap

mayOverlap: undefined | false | true

If true, icon is allowed to overlap other labels or icons of lower priority.

Optional poiName

poiName: undefined | string

Name of the POI description in the PoiTable.

Optional poiTableName

poiTableName: undefined | string

Name of the POI table PoiTable.

Optional reserveSpace

reserveSpace: undefined | false | true

If true, icon will reserve screen space, other markers of lower priority will not be able to overlap.

Optional stackMode

stackMode: PoiStackMode

Specify stack mode. Defaults to ShowInStack.

technique

Technique defining the POI or LineMarker

textElement

textElement: TextElement

Reference back to owning TextElement.

Optional textIsOptional

textIsOptional: undefined | false | true

If true, the text icon will appear even if the text part is blocked by other labels. Defaults to false.

Optional textMaxZoomLevel

textMaxZoomLevel: undefined | number

Maximum zoomLevel at which to display the label text. No default.

Optional textMinZoomLevel

textMinZoomLevel: undefined | number

Minimum zoomLevel at which to display the label text. No default.

Generated using TypeDoc