HtmlMarkerManager interface

  • Reference
Package:
azure-maps-control

A manager for the map control's HTML markers. Exposed through the markers property of the atlas.Map class. Cannot be instantiated by the user.

Methods

add(HtmlMarker, Position)

Adds an HTML based marker to the map.
add(HtmlMarker[])

Adds HTML based markers to the map.
clear()

Clears all markers.
getMarkers()

Gets an array of all the markers on the map.
remove(string | HtmlMarker | Array<string | HtmlMarker>)

Removes one or more HTML markers from the map.

Method Details

add(HtmlMarker, Position)

Adds an HTML based marker to the map.

function add(element: HtmlMarker, position?: Position): any

Parameters

element
HtmlMarker

The marker to add.

position
Position

Optionally specify the position of the marker on the map.

Returns

any

add(HtmlMarker[])

Adds HTML based markers to the map.

function add(elements: HtmlMarker[]): any

Parameters

elements

HtmlMarker[]

The markers to add.

Returns

any

clear()

Clears all markers.

function clear()

getMarkers()

Gets an array of all the markers on the map.

function getMarkers(): HtmlMarker[]

Returns

HtmlMarker[]

remove(string | HtmlMarker | Array<string | HtmlMarker>)

Removes one or more HTML markers from the map.

function remove(marker: string | HtmlMarker | Array<string | HtmlMarker>)

Parameters

marker

string | HtmlMarker | Array<string | HtmlMarker>

A HtmlMarker instance, a string id of a marker's htmlContent, or an array of these.