HtmlMarkerOptions | MapGL | Urbi Documentation
MapGL JS API

HtmlMarkerOptions

HtmlMarker initialization options.

Properties
number[]

The position in pixels of the "tip" of the HTML marker relative to its top-left corner.

number[]

An array of numbers [longitude, latitude, height?] , where:

  • 'longitude' and 'latitude' are the geographical coordinates of the top-left corner of the HTML marker. Taking into account the 'anchor' option.
  • 'height' is an optional number in meters by which the marker will be raised/lowered (depending on the sign of the value) relative to the map surface. 0 by default.
boolean

If true, the marker coordinates will not be rounded. By default it's false .

stringHTMLElement

HTML content of the HTML marker.

boolean

HTML marker can be pointer-event target if this option is set to true (pointer-events: auto), otherwise it can't (pointer-events: none).

HTML marker labeling options.

  • type: 'none' — the marker is always visible and not involved in labeling
  • type: 'full' — the marker can hide other labeling elements or can be hidden
  • type: 'invincible' — the marker is always visible and can hide other labeling elements
  • type: 'pinnedToPoi' — the marker can hide other labeling elements or can be hidden. It's labeling behavior is taken from the linked POI id.
  • width — the width of the labeling box
  • height — the height of the labeling box
  • offset — the offset in pixels of the labeling box. Positive values indicate right and down, while negative values indicate left and up.
  • poiId — the linked POI id
number

Maximum display styleZoom of the HTML marker.

number

Minimum display styleZoom of the HTML marker.

boolean

Capture events if set. Otherwise events will passed to the map. By default it's true .

any

User specific data.

number

Draw order.