ym.modules.provider.Marker

Überblick

Dient dazu, Markierungen auf der Karte zu setzen.

var marker = ym.marker([49, 10]).addTo(map);

Initialisierung

Factory: ym.layerGroup(latlng, options)

Instanziiert ein Marker-Objekt mit einem geographischen Punkt und optional mit weiteren Einstellungen.

Parameter

Name Beschreibung Datentyp Standardwert
latlng [erforderlich] LatLng  
options [optional] Marker-Optionen  

Parameter: options

Name Beschreibung Datentyp Standardwert
icon Icon-Klasse, die zum Rendern des Markers verwendet werden soll. Icon  
clickable Wenn false, wird kein Mausereignisse ausgesendet. Der Marker fungiert dann als Teil der darunter liegenden Karte. bool true
draggable Gibt an, ob der Marker über Maus oder Touch verschiebbar ist. bool false
keyboard Gibt an, ob der Marker mit der Tastatur ausgewählt und mit der Eingabetaste angeklickt werden kann. bool true
title Text für den Browser-Tooltip, der während des Hover-Ereignisses angezeigt wird (Standard: kein Tooltip). string Leere Zeichenfolge
alt Text für das alt-Attribut des Icon-Bildes (nützlich für die Barrierefreiheit). string Leere Zeichenfolge
zIndexOffset Standardmäßig wird z-Index für das Markerbild automatisch auf der Grundlage seiner Breite gesetzt. Benutzen Sie diese Option, wenn Sie den Marker über oder unter allen anderen platzieren möchten. Geben Sie hierzu einen hohen Wert wie 1000 (beziehungsweise einen hohen negativen Wert) an. int 0
opacity Die Deckkraft des Markers. double 1.0
riseOnHover Wenn true, wird der Marker während Sie über ihn mit der Maus fahren über die anderen gesetzt. bool false
riseOffset Der z-Index-Offset, der für die Funktion riseOnHover verwendet wird. int 250

Ereignisse

Ereignis Ereignisobjekt Beschreibung
add Event Wird ausgelöst, wenn der Marker zur Karte hinzugefügt wird.
click MouseEvent Wird ausgelöst, wenn der Benutzer auf den Marker klickt (oder tippt).
contextmenu MouseEvent Wird ausgelöst, wenn der Benutzer mit der rechten Maustaste auf den Marker klickt.
dblclick MouseEvent Wird ausgelöst, wenn der Benutzer auf den Marker doppelklickt (oder doppeltippt).
drag Event Wird wiederholt ausgelöst, während der Benutzer den Marker zieht.
dragend DragEndEvent Wird ausgelöst, wenn der Benutzer aufhört, den Marker zu ziehen.
dragstart Event Wird ausgelöst, wenn der Benutzer anfängt, die Markierung zu ziehen.
mousedown MouseEvent Wird ausgelöst, wenn der Benutzer die Maustaste auf den Marker drückt.
mouseout MouseEvent Wird ausgelöst, wenn die Maus die Markierung verlässt.
mouseover MouseEvent Wird ausgelöst, wenn die Maus in den Marker eintritt.
move Event Wird ausgelöst, wenn der Marker über setLatLng bewegt wird. Neue Koordinaten werden in Ereignisargumente aufgenommen.
popupclose PopupEvent Wird ausgelöst, wenn ein an den Marker gebundenes Popup geschlossen wird.
popupopen PopupEvent Wird ausgelöst, wenn ein an den Marker gebundenes Popup geöffnet ist.
remove Event Wird ausgelöst, wenn der Marker von der Karte entfernt wird.

Methoden

addTo(map) ab v3

Fügt einen Marker zur Karte hinzu.

Parameter

Name Beschreibung Datentyp Standardwert
map   Map  

Rückgabe

this

getLatLng() ab v3

Gibt die aktuelle geographische Position des Markers zurück.

Rückgabe

LatLng

setLatLng(latlng) ab v3

Ändert die Position des Markers auf den angegebenen Punkt.

Parameter

Name Beschreibung Datentyp Standardwert
latlng   LatLng  

Rückgabe

this

setIcon(icon) ab v3

Ändert das Icon des Markers.

Parameter

Name Beschreibung Datentyp Standardwert
icon   Icon  

Rückgabe

this

setZIndexOffset(offset) ab v3

Ändert den z-Index-Offset des Markers.

Parameter

Name Beschreibung Datentyp Standardwert
offset   int  

Rückgabe

this

setOpacity(opacity) ab v3

Ändert die Deckkraft des Markers.

Parameter

Name Beschreibung Datentyp Standardwert
opacity   int  

Rückgabe

this

update() ab v3

Aktualisiert die Position des Markers (hilfreich, wenn die Koordinaten des zugehörigen latLng-Objekts direkt geändert wurden).

Rückgabe

this

bindPopup(html, options) ab v3

Bindet ein Popup mit einem bestimmten HTML-Inhalt an einen Klick auf diese Markierung. Sie können das gebundene Popup auch mit der Methode openPopup öffnen.

Parameter

Name Beschreibung Datentyp Standardwert
html   string oder HTMLElement oder Popup  
options [optional] Popup options  

Rückgabe

this

unbindPopup() ab v3

Entfernt das zuvor mit bindPopup an den Marker gebundene Popup.

Rückgabe

this

openPopup() ab v3

Öffnet das zuvor durch die bindPopup-Methode gebundene Popup.

Rückgabe

this

getPopup() ab v3

Gibt das Popup zurück, das zuvor durch die Methode bindPopup gebunden war.

Rückgabe

Popup

closePopup() ab v3

Schließt das gebundene Popup des Markers, wenn es geöffnet ist.

Rückgabe

this

togglePopup() ab v3

Schaltet das zuvor durch die bindPopup-Methode gebundene Popup ein und aus.

Rückgabe

this

setPopupContent(html) ab v3

Setzt einen HTML-Inhalt des Popups dieses Markers.

Parameter

Name Beschreibung Datentyp Standardwert
html   string oder HTMLElement  

Rückgabe

this

toGeoJSON() ab v3

Liefert eine GeoJSON-Darstellung des Markers (GeoJSON Point Feature).

Rückgabe

Object