Class Markers

Hierarchy

Markers

Index

Constructors

constructor

Accessors

markers

Methods

Constructors

constructor

new Markers(markersController: MarkersController): Markers

Parameters
- markersController: MarkersController
Returns Markers

Accessors

markers

get markers(): Marker[]

Returns Marker[]

Methods

add

add(nodeOrCoordinate: MappedinNode | MappedinCoordinate, contentHtml: string, options?: TCreateMarkerOptions): Marker

Create a new Marker, containing some HTML, at the specified position

Parameters
- nodeOrCoordinate: MappedinNode | MappedinCoordinate
  
  the position for the Marker
- contentHtml: string
  
  the content to show in the Marker
- Optional options: TCreateMarkerOptions
  
  options for the display of the Marker
Returns Marker
the Marker object that was created.

animate

animate(markerOrMarkerId: string | Marker, target: MappedinNode | MappedinCoordinate, options?: TAnimationOptions): Promise<void>

Moves a Marker to a new position over time.

Parameters
- markerOrMarkerId: string | Marker
  
  the Marker to move
- target: MappedinNode | MappedinCoordinate
  
  the new position for this Marker
- Optional options: TAnimationOptions
  
  the options for how this movement should be animated
Returns Promise<void>

remove

remove(markerOrMarkerId: string | Marker): void

Removes a Marker.

Parameters
- markerOrMarkerId: string | Marker
  
  the Marker to be removed
Returns void

removeAll

removeAll(): void

Remove all Markers from all maps.

Returns void

setPosition

setPosition(markerOrMarkerId: string | Marker, target: MappedinNode | MappedinCoordinate): void

Moves a Marker to a new position instantaneously.

Parameters
- markerOrMarkerId: string | Marker
  
  the Marker to move
- target: MappedinNode | MappedinCoordinate
  
  the new position for this Marker
Returns void