Interface IMarkers

Interface defining the controls and actions for markers (Marker) on the map.

Hierarchy

IMarkers

Index

Properties

add remove removeAll

Properties

add

add: ((target, html, options?) => undefined | Marker)

Type declaration

- (target, html, options?): undefined | Marker
- Adds a marker to the map.
  Parameters
  - target: Coordinate | Space | Door
    
    The target object (Space, Door, or Coordinate) for the marker.
  - html: string
    
    The HTML content for the Marker.
  - Optional options: TAddMarkerOptions
    
    Optional additional options for the Marker.
  Returns undefined | 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 });
```

remove

remove: ((marker) => void)

Type declaration

- (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[])

Type declaration

- (): Marker[]
- Remove all the markers (Marker) from the map.
  
  Returns Marker[]
  Example
```
map.Markers.removeAll();
```