Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MarkerOptions

Hierarchy

  • MarkerOptions

Index

Properties

Optional alt

alt: string

Text for the alt attribute of the icon image (useful for accessibility).

Default value: ''.

Optional clickable

clickable: boolean

If false, the marker will not emit mouse events and will act as a part of the underlying map.

Default value: true.

Optional draggable

draggable: boolean

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

Default value: false.

Optional icon

icon: Icon

Icon class to use for rendering the marker. See Icon documentation for details on how to customize the marker icon.

Default value: new L.Icon.Default().

Optional keyboard

keyboard: boolean

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

Default value: true.

Optional opacity

opacity: number

The opacity of the marker.

Default value: 1.0.

Optional riseOffset

riseOffset: number

The z-index offset used for the riseOnHover feature.

Default value: 250.

Optional riseOnHover

riseOnHover: boolean

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

Default value: false.

Optional title

title: string

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

Default value: ''.

Optional zIndexOffset

zIndexOffset: number

By default, marker images zIndex is set automatically based on its latitude. You 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).

Default value: 0.