HtmlMarker | MapGL | Urbi Documentation
MapGL JS API
Maps
Search
Navigation
Urbi Pro
CityLens
On‑Premise
Account

HtmlMarker

Class for creating an HTML marker on the map.

new constructor(map, options)

Example:

const htmlMarker = new mapgl.HtmlMarker(map, {
    coordinates: map.getCenter(),
    html: '<div>Some content</div>',
});
Parameters
map
Map

The map instance.

options
HtmlMarkerOptions

HtmlMarker options.

Returns
Methods
destroy()

Destroys the HTML marker.

Returns
void
getAnchor()

Returns the HTML marker's anchor in pixels.

Returns
number[]
getContent()

Returns the whole HTMLElement of the marker. Previously specified HTML content is a child of the element.

Returns
HTMLElement
getCoordinates()

Returns current position of the top-left corner of the HTML marker with its anchor in geographical coordinates [longitude, latitude].

Returns
number[]
getZIndex()

Returns the z-index CSS property value of the HTML marker's root DOM element.

Returns
number
setAnchor(anchor)

Sets the anchor relative to the top-left corner of the HTML marker.

Parameters
anchor
number[]

An anchor of the HTML marker in pixels.

Returns
this
setContent(html)

Sets the HTML content of the HTML marker.

Parameters
html
HTMLElementstring

The content that will replace the current content of the HTML marker.

Returns
this
setCoordinates(coordinates)

Sets the geographical coordinates of the HTML marker.

Parameters
coordinates
number[]

Coordinates [longitude, latitude] where the top-left corner of the HTML marker with its anchor should be set.

Returns
this
setZIndex(zIndex)

Sets the z-index CSS property value of the HTML marker's root DOM element.

Parameters
zIndex
number

The z-index property value.

Returns
this