Class Markers

Index

Methods

add animateTo remove removeAll setPosition

Methods

add

add(target, html, options?): Marker
Adds a marker to the map.
Parameters
- target:
      | Coordinate
      | Space
      | Door
      | Node
  The target object (Space, Door, or Coordinate) for the marker.
- html: string
  The HTML content for the Marker.
- Optionaloptions: TAddMarkerOptions
  Optional additional options for the Marker.
Returns Marker
The created Marker, or undefined if creation failed.
Example
```
// Add an interactive {@link Marker} to the map with custom HTML content.
map.Markers.add(coordinate, '<div>Marker Content</div>', { interactive: true });
```

animateTo

animateTo(marker, target, options?): Promise<void>
Update the position of a marker with an animation.
Parameters
- marker: Marker
  The Marker which should be updated.
- target:
      | Coordinate
      | Space
      | Door
      | Node
  The new target object (Space, Door, or Coordinate) for the marker.
- Optionaloptions: TAnimationOptions
  Optional additional options for the animation.
Returns Promise<void>
A promise that resolves when the animation is complete.
Example
```
const marker = map.Markers.add(coordinate, '<div>Marker Content</div>');
mapView.Markers.animateTo(marker, newCoordinate, { duration: 1000 });
```

remove

remove(marker): void
Removes a marker from the map.
Parameters
- marker: Marker
  {Marker} The Marker which should be removed.
Returns void
Example
```
mapView.Markers.remove(marker);
```

removeAll

removeAll(): Marker[]
Remove all the markers from the map.

Returns Marker[]
Example
```
map.Markers.removeAll();
```

setPosition

setPosition(marker, target): void
Update the position of a marker.
Parameters
- marker: Marker
  The Marker which should be removed.
- target:
      | Coordinate
      | Space
      | Door
      | Node
  The new target object (Space, Door, or Coordinate) for the marker.
Returns void
Example
```
const marker = map.Markers.add(coordinate, '<div>Marker Content</div>');
mapView.Markers.setPosition(marker, newCoordinate);
```