Zum Inhalt

ym.modules.provider.Marker

Überblick

Dient zum Setzen von Markern auf der Karte.

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

Initialisierung

Factory: ym.layerGroup(latlng, options)

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

Parameter Beschreibung Datentyp Standardwert
latlng [erforderlich] LatLng
options [optional] Marker-Options

Parameter: options

Name Beschreibung Datentyp Standardwert
icon Icon-Klasse, die zum Rendern des Markers verwendet wird Icon
clickable Wenn false, werden keine Mausereignisse gesendet. Der Marker verhält sich dann wie ein Teil der zugrunde liegenden Karte. bool true
draggable Gibt an, ob der Marker per Maus oder Touch verschoben werden kann. 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 beim Hover-Ereignis angezeigt wird (Standard: kein Tooltip) string Leere Zeichenfolge
alt Text für das alt-Attribut des Icon-Bilds (nützlich für Barrierefreiheit). string Leere Zeichenfolge
zIndexOffset Standardmäßig wird der z-Index für das Marker-Bild automatisch anhand seiner Breite festgelegt. Verwenden Sie diese Option, wenn Sie den Marker über oder unter allen anderen platzieren möchten. Geben Sie einen hohen Wert wie 1000 an (oder einen stark negativen Wert). int 0
opacity Die Deckkraft des Markers. double 1.0
riseOnHover Wenn true, wird der Marker über die anderen gelegt, während Sie die Maus darüber bewegen. bool false
riseOffset Der z-Index-Offset, der für die riseOnHover-Funktion verwendet wird. int 250

Ereignisse

Event Event object Description
add Event Wird ausgelöst, wenn der Marker der 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 doppelt auf den Marker klickt (oder doppelt tippt).
drag Event Wird wiederholt ausgelöst, während der Benutzer den Marker zieht.
dragend DragEndEvent Wird ausgelöst, wenn der Benutzer das Ziehen des Markers beendet.
dragstart Event Wird ausgelöst, wenn der Benutzer beginnt, den Marker zu ziehen.
mousedown MouseEvent Wird ausgelöst, wenn der Benutzer die Maustaste auf dem Marker drückt.
mouseout MouseEvent Wird ausgelöst, wenn die Maus die Auswahl verlässt.
mouseover MouseEvent Wird ausgelöst, wenn die Maus den Marker berührt.
move Event Wird ausgelöst, wenn der Marker über setLatLng verschoben wird. Die neuen Koordinaten werden den Ereignisargumenten hinzugefügt.
popupclose PopupEvent Wird ausgelöst, wenn ein an den Marker gebundenes Pop-up geschlossen wird.
popupopen PopupEvent Wird ausgelöst, wenn ein an den Marker gebundenes Pop-up geöffnet wird.
remove Event Wird ausgelöst, wenn der Marker von der Karte entfernt wird.

Methoden

addTo(map)

Fügt der Karte einen Marker hinzu.

Parameter Beschreibung Datentyp Standardwert
map Map
  • Rückgabe: this

getLatLng()

Gibt die aktuelle geografische Position des Markers zurück.

  • Rückgabe: LatLng

setLatLng(latlng)

Ändert die Position des Markers auf den angegebenen Punkt.

Parameter Beschreibung Datentyp Standardwert
latlng LatLng
  • Rückgabe: this

setIcon(icon)

Ändert das Icon des Markers.

Parameter Beschreibung Datentyp Standardwert
icon Icon
  • Rückgabe: this

setZIndexOffset(offset)

Ändert den z-Index-Offset des Markers.

Parameter Beschreibung Datentyp Standardwert
offset int
  • Rückgabe: this

setOpacity(opacity)

Ändert die Deckkraft des Markers.

Parameter Beschreibung Datentyp Standardwert
opacity int
  • Rückgabe: this

update()

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

  • Rückgabe: this

bindPopup(html, options)

Bindet ein Pop-up mit einem bestimmten HTML-Inhalt an einen Klick auf diesen Marker. Sie können das gebundene Pop-up auch mit der Methode openPopup öffnen.

Parameter Beschreibung Datentyp Standardwert
html string or HTMLElement or Popup
options [optional] Popup options
  • Rückgabe: this

unbindPopup()

Entfernt das Pop-up, das zuvor mit bindPopup an den Marker gebunden wurde.

  • Rückgabe: this

openPopup()

Öffnet das Pop-up, das zuvor mit der Methode bindPopup gebunden wurde.

  • Rückgabe: this

getPopup()

Gibt das Pop-up zurück, das zuvor mit der Methode bindPopup gebunden wurde.

  • Rückgabe: Popup

closePopup()

Schließt das gebundene Marker-Pop-up, wenn es geöffnet ist.

  • Rückgabe: this

togglePopup()

Schaltet das zuvor mit der Methode bindPopup gebundene Pop-up ein und aus.

  • Rückgabe: this

setPopupContent(html)

Legt einen HTML-Inhalt für das Pop-up dieses Markers fest.

Parameter Beschreibung Datentyp Standardwert
html string or HTMLElement
  • Rückgabe: this

toGeoJSON()

Gibt eine GeoJSON-Darstellung des Markers zurück (GeoJSON Point Feature).

  • Rückgabe: Object