Properties

Link copied to clipboard
abstract var alt: String?

Text for the alt attribute of the icon image. Useful for accessibility.

Link copied to clipboard
abstract var attribution: String?

String to be shown in the attribution control, e.g. "© OpenStreetMap contributors". It describes the layer data and is often a legal obligation towards copyright holders and tile providers.

Link copied to clipboard
abstract var autoPan: Boolean?

Whether to pan the map when dragging this marker near its edge or not.

Link copied to clipboard
abstract var autoPanOnFocus: Boolean?

When true, the map will pan whenever the marker is focused (via e.g. pressing tab on the keyboard) to ensure the marker is visible within the map's bounds.

Link copied to clipboard
abstract var autoPanPadding: Point

Distance (in pixels to the left/right and to the top/bottom) of the map edge to start panning the map.

Link copied to clipboard
abstract var autoPanSpeed: Number?

Number of pixels the map should pan by.

Link copied to clipboard
Link copied to clipboard
abstract var draggable: Boolean?

Whether the marker is draggable with mouse/touch or not.

Link copied to clipboard
abstract var icon: Icon<*>?

Icon instance to use for rendering the marker. See Icon documentation for details on how to customize the marker icon. If not specified, a common instance of Icon.Default is used.

Link copied to clipboard
abstract var interactive: Boolean?

If true, the popup/tooltip will listen to the mouse events.

Link copied to clipboard
abstract var keyboard: Boolean?

Whether the marker can be tabbed to with a keyboard and clicked by pressing enter.

Link copied to clipboard
abstract var opacity: Number?

The opacity of the marker.

Link copied to clipboard
abstract var pane: String?

By default, the layer will be added to the map's overlay pane. Overriding this option will cause the layer to be placed on another pane by default.

Link copied to clipboard
abstract var riseOffset: Number?

The z-index offset used for the riseOnHover feature.

Link copied to clipboard
abstract var riseOnHover: Boolean?

If true, the marker will get on top of others when you hover the mouse over it.

Link copied to clipboard
abstract var shadowPane: String?

Map pane where the markers shadow will be added.

Link copied to clipboard
abstract var title: String?

Text for the browser tooltip that appear on marker hover (no tooltip by default). Useful for accessibility.

Link copied to clipboard
abstract var zIndexOffset: Number?

By default, marker images zIndex is set automatically based on its latitude. Use this option if you want to put the marker on top of all others (or below), specifying a high value like 1000 (or high negative value, respectively).