Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TextElementBuilder

Constructs TextElement objects from {@link @here/harp-datasource-protocol/Technique}, text, coordinates and optional icon.

Hierarchy

  • TextElementBuilder

Index

Constructors

constructor

Properties

Readonly renderOrderUpBound

renderOrderUpBound: number

Static Readonly RENDER_ORDER_UP_BOUND

RENDER_ORDER_UP_BOUND: 10000000 = 10000000

Methods

build

  • build(text: string, points: Vector3 | Vector3[], tileOffset: number, dataSourceName: string, dataSourceOrder: number, attributes?: AttributeMap, pathLengthSqr?: undefined | number, offsetDirection?: undefined | number): TextElement
  • Creates a TextElement with the given properties.

    Parameters

    • text: string

      The text to be displayed.

    • points: Vector3 | Vector3[]

      The position(s) for the text element.

    • tileOffset: number

      The TextElement's tile offset, see Tile.offset.

    • dataSourceName: string

      The name of the data source.

    • dataSourceOrder: number
    • Optional attributes: AttributeMap

      TextElement attribute map.

    • Optional pathLengthSqr: undefined | number

      Precomputed path length squared for path labels.

    • Optional offsetDirection: undefined | number

    Returns TextElement

    The created text element.

withIcon

  • withIcon(imageTextureName?: undefined | string, shieldGroupIndex?: undefined | number): this
  • Sets an icon that will be used to create text elements on subsequent calls to TextElementBuilder.build until the next call to this method.

    Parameters

    • Optional imageTextureName: undefined | string

      The name of the icon image.

    • Optional shieldGroupIndex: undefined | number

      Index to the shield group.

    Returns this

    This builder.

withTechnique

Static alignZoomLevelRanges

Static composeRenderOrder

  • composeRenderOrder(baseRenderOrder: number, offset: number): number
  • Combines two render order numbers into a single one.

    Parameters

    • baseRenderOrder: number

      The most significative part of the render order.

    • offset: number

      The least significative part of the render order. It must be within the interval (-RENDER_ORDER_UP_BOUND, RENDER_ORDER_UP_BOUND).

    Returns number

    The combined render order.

Generated using TypeDoc