Class Labels

Index

Methods

add all remove removeAll

Methods

add

add(target, text, options?): Label
Adds a label (Label) to the map.
Parameters
- target:
      | Coordinate
      | Space
      | MapObject
      | Door
      | PointOfInterest
  The target object (Space, Door, or Coordinate) where the label should be added.
- text: string
  The text of the label.
- Optionaloptions: TAddLabelOptions
  Optional additional options for the label.
Returns Label
The created label, or undefined if creation failed.
Example
```
map.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
map.Labels.all();
```

remove

remove(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
```
map.Labels.removeAll();
```