ym.modules.provider.Popup

Überblick

Dient zum Öffnen von Popups an bestimmten Stellen der Karte. Verwenden Sie Map.openPopup, um Popups zu öffnen und dabei sicherzustellen, dass nur ein Popup gleichzeitig geöffnet ist (empfohlen für die Benutzerfreundlichkeit), oder verwenden Sie Map.addLayer, um so viele zu öffnen, wie Sie möchten.

Beispielaufrufe

Ein Popup öffnen und binden sie an einen Marker-Klick auf die folgende Weise:

marker.bindPopup(popupContent).openPopup();

Pfadüberlagerungen wie Polylinien haben eine bindPopup-Methode. Hier ist ein anderer Weg, um ein Popup auf einer Karte zu öffnen:

var popup = ym.popup()

    .setLatLng(latlng)

    .setContent('<p>Hello world!<br />This is a nice popup.</p>')

    .openOn(map);

Initialisierung

Factory: ym.popup(options, source)

Instanziiert ein Popup-Objekt mit einem optionalen Optionen-Objekt, das sein Aussehen und seine Position beschreibt, und einem optionalen Quellobjekt, das verwendet wird, um das Popup mit einer Referenz auf den ILayer zu versehen, auf den es sich bezieht.

Parameter

Name Beschreibung Datentyp Standardwert
options [optional] PopupOptions  
source [optional] ILayer  

Parameter: options

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

Name Beschreibung Datentyp Standardwert
maxWidth Maximale Breite des Popups. int 300
minWidth Minimale Breite des Popups. int 50
maxHeight Wenn gesetzt, wird ein scrollbarer Container der angegebenen Höhe innerhalb eines Popups erzeugt, wenn sein Inhalt diesen überschreitet. int null
autoPan Setzen Sie es auf false, wenn Sie nicht möchten, dass die Karte eine Verschiebe-Animation durchführt, um das geöffnete Popup anzupassen. bool true
keepInView Setzen Sie es auf true, wenn Sie verhindern möchten, dass Benutzer das Popup aus dem sichtbaren Bereich ziehen, während es geöffnet ist. bool false
closeButton Steuert das Vorhandensein eines Schließen-Buttons im Popup. bool true
offset Der Offset der Popup-Position. Nützlich, um den Anker des Popups beim Öffnen auf einigen Overlays zu kontrollieren. Point Point(0, 6)
autoPanPaddingTopLeft Der Rand zwischen dem Popup und der linken oberen Ecke der Kartenansicht nach dem automatischen Verschieben. Point null
autoPanPaddingBottomRight Der Rand zwischen dem Popup und der rechten unteren Ecke der Kartenansicht nach dem automatischen Verschieben. Point null
autoPanPadding Setzt den Abstand für das automatische Verschieben oben links und unten rechts auf den gleichen Wert. Point Point(5, 5)
zoomAnimation Gibt an, ob das Popup beim Zoomen animiert werden soll. Deaktivieren Sie es, wenn Sie Probleme mit Flash-Inhalten in Popups haben. bool true
closeOnClick Setzen Sie es auf false, wenn Sie das Standardverhalten des Popups beim Klicken auf die Karte überschreiben möchten (global durch die Option Map closePopupOnClick). bool null
className Ein benutzerdefinierter Klassenname, der dem Popup zugewiesen wird. string ''

Methoden

addTo(map) ab v3

Fügt das Popup zur Karte hinzu.

Parameter

Name Beschreibung Datentyp Standardwert
map   Map  

Rückgabe

this

openOn() ab v3

Fügt das Popup zur Karte hinzu und schließt das vorherige. Das gleiche wie map.openPopup(popup).

Parameter

Name Beschreibung Datentyp Standardwert
map   Map  

Rückgabe

this

setLatLng(latlng) ab v3

Legt den geografischen Punkt fest, an dem sich das Popup öffnet.

Parameter

Name Beschreibung Datentyp Standardwert
latlng   LatLng  

Rückgabe

this

getLatLng() ab v3

Gibt den geografischen Punkt des Popups zurück.

Rückgabe

LatLng

setContent(htmlContent) ab v3

Setzt den HTML-Inhalt des Popups.

Parameter

Name Beschreibung Datentyp Standardwert
htmlContent   String oder HTMLElement  

Rückgabe

this

getContent() ab v3

Gibt den Inhalt des Popups zurück.

Rückgabe

string oder HTMLElement

update() ab v3

Aktualisiert den Popup-Inhalt, das Layout und die Position. Nützlich, um das Popup zu aktualisieren, wenn sich etwas im Inneren geändert hat, beispielsweise ein Bild geladen wurde.

Rückgabe

this