Interface MarkerOptions

interface MarkerOptions {
    alt?: string;
    attribution?: string;
    autoPan?: boolean;
    autoPanOnFocus?: boolean;
    autoPanPadding?: PointExpression;
    autoPanSpeed?: number;
    bubblingMouseEvents?: boolean;
    draggable?: boolean;
    icon?: DivIcon | Icon<IconOptions>;
    interactive?: boolean;
    keyboard?: boolean;
    opacity?: number;
    pane?: string;
    riseOffset?: number;
    riseOnHover?: boolean;
    shadowPane?: string;
    title?: string;
    zIndexOffset?: number;
}

Hierarchy (View Summary)

Properties

alt? attribution? autoPan? autoPanOnFocus? autoPanPadding? autoPanSpeed? bubblingMouseEvents? draggable? icon? interactive? keyboard? opacity? pane? riseOffset? riseOnHover? shadowPane? title? zIndexOffset?

Properties

Optionalalt

alt?: string

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

Optionalattribution

attribution?: string

OptionalautoPan

autoPan?: boolean

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

OptionalautoPanOnFocus

autoPanOnFocus?: boolean

OptionalautoPanPadding

autoPanPadding?: PointExpression

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

OptionalautoPanSpeed

autoPanSpeed?: number

Number of pixels the map should pan by.

OptionalbubblingMouseEvents

bubblingMouseEvents?: boolean

Optionaldraggable

draggable?: boolean

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

Optionalicon

icon?: DivIcon | Icon<IconOptions>

Optionalinteractive

interactive?: boolean

Optionalkeyboard

keyboard?: boolean

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

Optionalopacity

opacity?: number

The opacity of the marker.

Optionalpane

pane?: string

OptionalriseOffset

riseOffset?: number

The z-index offset used for the riseOnHover feature.

OptionalriseOnHover

riseOnHover?: boolean

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

OptionalshadowPane

shadowPane?: string

Map pane where the markers shadow will be added.

Optionaltitle

title?: string

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

OptionalzIndexOffset

zIndexOffset?: number

Option for putting the marker on top of all others (or below).

Settings

Member Visibility

On This Page

Properties