Zum Inhalt

ym.modules.provider.Popup

Overview

Wird verwendet, um Pop-ups an bestimmten Positionen auf der Karte zu öffnen. Verwenden Sie Map.openPopup, um Pop-ups zu öffnen und dabei sicherzustellen, dass immer nur ein Pop-up gleichzeitig geöffnet ist (empfohlen für einfache Bedienung), oder verwenden Sie Map.addLayer, um beliebig viele zu öffnen.

Example calls

Öffnen Sie ein Pop-up und binden Sie es folgendermaßen an einen Marker-Klick:

marker.bindPopup(popupContent).openPopup();

Path-Overlays wie Polylinien verfügen über eine bindPopup-Methode. Hier ist eine weitere Möglichkeit, ein Pop-up auf einer Karte zu öffnen:

var popup = ym.popup()
    .setLatLng(latlng)
    .setContent('<p>Hello world!<br />This is a nice popup.</p>')
    .openOn(map);

Initialization

Factory: ym.popup(options, source)

Instanziiert ein Popup-Objekt mit einem optionalen Options-Objekt, das dessen Erscheinungsbild und Position beschreibt, sowie einem optionalen Source-Objekt, das dem Pop-up eine Referenz auf das ILayer liefert, auf das es sich bezieht.

Parameter Beschreibung Data type Default value
options [optional] PopupOptions
source [optional] ILayer

Parameter: options

Sie können Path-Optionen sowie zusätzlich die folgenden Optionen verwenden:

Name Beschreibung Data type Default value
maxWidth Maximale Breite des Pop-ups. int 300
minWidth Minimale Breite des Pop-ups. int 50
maxHeight Falls gesetzt, wird innerhalb eines Pop-ups ein scrollbarer Container mit der angegebenen Höhe erstellt, sofern dessen Inhalt diese Höhe überschreitet. int null
autoPan Setzen Sie den Wert auf false, wenn die Karte keine Bewegungsanimation ausführen soll, um das geöffnete Pop-up anzupassen. bool true
keepInView Setzen Sie den Wert auf true, wenn verhindert werden soll, dass Nutzer das Pop-up aus dem sichtbaren Bereich ziehen, solange es geöffnet ist. bool false
closeButton Steuert das Vorhandensein einer Schließen-Schaltfläche im Pop-up. bool true
offset Der Versatz der Pop-up-Position. Nützlich, um den Anker des Pop-ups beim Öffnen auf bestimmten Overlays zu steuern. Point Point(0, 6)
autoPanPaddingTopLeft Der Abstand zwischen dem Pop-up und der oberen linken Ecke der Kartenansicht nach dem automatischen Verschieben. Point null
autoPanPaddingBottomRight Der Abstand zwischen dem Pop-up und der unteren rechten Ecke der Kartenansicht nach dem automatischen Verschieben. Point null
autoPanPadding Legt den Abstand für das automatische Verschieben oben links und unten rechts auf denselben Wert fest. Point Point(5, 5)
zoomAnimation Legt fest, ob das Pop-up beim Zoomen animiert werden soll. Deaktivieren Sie diese Option, wenn Probleme mit Flash-Inhalten in Pop-ups auftreten. bool true
closeOnClick Setzen Sie den Wert auf false, wenn Sie das Standardverhalten des Pop-ups bei einem Klick auf die Karte überschreiben möchten (global über die Map-Option closePopupOnClick). bool null
className Ein benutzerdefinierter Klassenname, der dem Pop-up zugewiesen wird. string ''

Methods

addTo(map)

Fügt das Pop-up der Karte hinzu.

Parameter Beschreibung Data type Default value
map Map
  • Return: this

openOn()

Fügt das Pop-up der Karte hinzu und schließt das vorherige. Entspricht map.openPopup(popup).

Parameter Beschreibung Data type Default value
map Map
  • Return: this

setLatLng(latlng)

Legt den geografischen Punkt fest, an dem das Pop-up geöffnet wird.

Parameter Beschreibung Data type Default value
latlng LatLng
  • Return: this

getLatLng()

Gibt den geografischen Punkt des Pop-ups zurück.

  • Return: LatLng

setContent(htmlContent)

Legt den HTML-Inhalt des Pop-ups fest.

Parameter Beschreibung Data type Default value
htmlContent String or HTMLElement
  • Return: this

getContent()

Gibt den Inhalt des Pop-ups zurück.

  • Return: string or HTMLElement

update()

Aktualisiert den Inhalt, das Layout und die Position des Pop-ups. Nützlich, um das Pop-up zu aktualisieren, wenn sich intern etwas geändert hat, zum Beispiel wenn ein Bild geladen wurde.

  • Return: this