Class Labels

Class used to add and remove a Label on the MapView.

Labels contain text and an image that are anchored to a specific point on the map. They automatically rotate and show and hide based on priority and zoom level. Use them to inform users about location names, points of interest and more!

Effective use of labels allows an app to convey additional information to the user. For example labels can be used to show room names, important points of interest, main entrances or any other piece of contextual information that is useful to the user.

This class is accessed using MapView.Labels.

Refer to the Labels Guide for more information and interactive examples.

Methods

add all remove removeAll

Methods

add

  • add(target: IAnchorable, text: string, options?: TAddLabelOptions): Label

  • Adds a label (Label) to the map.

    Parameters

    Returns Label

    The created label, or undefined if creation failed.

    Example

    mapView.Labels.add(space, 'Welcome', { appearance: { color: 'blue' } });

all

  • all(): Label[]

  • Automatically adds all the labels (Label) to the map.

    The text, appearance, priority, etc. of the labels will be automatically determined based on the external data.

    Returns Label[]

    Example

    // Add all the labels to the map
    mapView.Labels.all();

remove

  • remove(label: Label): void

  • Removes a label (Label) from the map.

    Parameters

    • label: Label

      The label which should be removed.

    Returns void

    Example

    mapView.Labels.remove(space);

removeAll

  • removeAll(): Label[]

  • Removes all the labels (Label) from the map.

    Returns Label[]

    Example

    mapView.Labels.removeAll();

Settings

Member Visibility

On This Page

Methods
MMNEPVFCICPMFPCPTTAAATR