Interface PoiInfoInternal

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

Hierarchy

  • PoiInfo

Properties

iconBrightness?: number

Icon brightness.

iconColor?: Color

Icon color override

iconIsOptional?: boolean

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.

iconMaxZoomLevel?: number

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

iconMinZoomLevel?: number

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

imageTextureName?: string
isValid?: boolean

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

mayOverlap?: boolean

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

poiName?: string

Name of the POI description in the PoiTable.

poiTableName?: string

Name of the POI table PoiTable.

reserveSpace?: boolean

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

stackMode?: PoiStackMode

Specify stack mode. Defaults to ShowInStack.

technique: PoiTechnique | LineMarkerTechnique

Technique defining the POI or LineMarker

textElement: TextElement

Reference back to owning TextElement.

textIsOptional?: boolean

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

textMaxZoomLevel?: number

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

textMinZoomLevel?: number

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

Generated using TypeDoc