ym.modules.provider.TileLayer
Überblick
Wird verwendet, um Tile-Layer auf der Karte zu laden und anzuzeigen. Implementiert das ILayer-Interface.
Beispielaufruf
Initialisierung
Factory: ym.tileLayer(urlTemplate, options)
Instanziiert ein Tile-Layer-Objekt mit einer URL-Vorlage und optional einem Options-Objekt.
| Parameter | Beschreibung | Datentyp | Standardwert |
|---|---|---|---|
| urlTemplate | [erforderlich] | string | |
| options | [optional] | TileLayerOptions |
Parameter: urlTemplate
Ein String der folgenden Form:
-{s} steht für eine der verfügbaren Subdomains (werden nacheinander verwendet, um parallele Browser-Anfragen je Domain-Grenze zu unterstützen; die Subdomain-Werte werden in den Optionen angegeben).
- {z} - Zoomstufe, {x} und {y} - Tile-Koordinaten.
Sie können im Template benutzerdefinierte Schlüssel verwenden, die anhand der TileLayer-Optionen ausgewertet werden:
Parameter: options
| Name | Beschreibung | Datentyp | Standardwert |
|---|---|---|---|
| attribution | Zum Beispiel "© SmartMaps" - der von der Attribution-Control verwendete String beschreibt die Layer-Daten. | string | '' |
| bounds | Ist diese Option gesetzt, lädt TileLayer nur Tiles, die innerhalb der angegebenen geografischen Grenzen liegen. | LatLngBounds | null |
| continuousWorld | Bei true werden die Tile-Koordinaten nicht um den Weltbreitengrad (-180 bis 180 Längengrad) gewrapped oder so begrenzt, dass sie innerhalb der Weltbreite (-90 bis 90) liegen. Verwenden Sie diese Option, wenn Sie Leaflet für Karten nutzen, die nicht die reale Welt abbilden (z. B. Spielkarten, Innenraumkarten oder Fotokarten). | bool | false |
| detectRetina | Bei true und wenn der Nutzer ein Retina-Display verwendet, werden vier Tiles mit halber Größe und einer höheren Zoomstufe angefordert, um die hohe Auflösung zu nutzen. | bool | false |
| errorTileUrl | URL zum Tile-Bild, das anstelle des Tiles angezeigt wird, das nicht geladen werden konnte. | string | '' |
| maxNativeZoom | Maximale Zoomzahl, die von der Tile-Quelle bereitgestellt wird. Ist dies angegeben, werden Tiles aller Zoomstufen oberhalb von maxNativeZoom von der Ebene maxNativeZoom geladen und automatisch skaliert. | int | null |
| maxZoom | Maximale Zoomzahl. | int | 18 |
| minZoom | Minimale Zoomzahl. | int | 0 |
| noWrap | Bei true werden die Tiles außerhalb des Weltbreitengrads (-180 bis 180 Längengrad) nur geladen, statt sich zu wiederholen. | bool | false |
| opacity | Die Deckkraft des Tile-Layers. | int | 1.0 |
| reuseTiles | Bei true werden alle nach dem Verschieben nicht mehr sichtbaren Tiles in eine Wiederverwendungswarteschlange gestellt, aus der sie abgerufen werden, sobald neue Tiles sichtbar werden (statt neue dynamisch zu erzeugen). Dies hält den Speicherverbrauch niedrig und erspart das Reservieren von Speicher für neue Tiles. | bool | false |
| subdomains | Subdomains des Tile-Dienstes. Kann als String übergeben werden (wobei jedes Zeichen einen Subdomain-Namen darstellt) oder als Array von Strings. | string or string[] | 'abc' |
| tileSize | Tile-Größe (Breite und Höhe in Pixeln, sofern die Tiles quadratisch sind). | int | 256 |
| tms | Bei true wird die Y-Achsen-Nummerierung für Tiles umgekehrt (für TMS-Dienste aktivieren). | bool | false |
| unloadInvisibleTiles | Bei true werden alle nach dem Verschieben nicht mehr sichtbaren Tiles entfernt (für bessere Performance). Standardmäßig true auf mobilem WebKit, sonst false. | bool | |
| updateWhenIdle | Bei false werden neue Tiles während des Verschiebens geladen, andernfalls erst danach (für bessere Performance). Standardmäßig true auf mobilem WebKit, sonst false. | bool | |
| zIndex | Der explizite zIndex des Tile-Layers. Standardmäßig nicht gesetzt. | int | null |
| zoomOffset | Dieser Wert wird zu der in Tile-URLs verwendeten Zoomzahl addiert. | int | 0 |
| zoomReverse | Bei true wird die in den Tile-URLs verwendete Zoomzahl umgekehrt (maxZoom - zoom statt zoom). | bool | false |
Events
| Event | Event-Typ | Beschreibung |
|---|---|---|
| loading | Event | Wird ausgelöst, wenn der Tile-Layer beginnt, die Tiles zu laden. |
| load | Event | Wird ausgelöst, nachdem der Tile-Layer alle sichtbaren Tiles geladen hat. |
| tileloadstart | TileEvent | Wird ausgelöst, wenn ein Tile angefordert wird und mit dem Laden beginnt. |
| tileload | TileEvent | Wird ausgelöst, wenn ein Tile geladen wurde. |
| tileunload | TileEvent | Wird ausgelöst, wenn ein Tile entfernt wird (zum Beispiel, wenn Sie unloadInvisibleTiles aktiviert haben). |
| tileerror | TileEvent | Wird ausgelöst, wenn beim Laden eines Tiles ein Fehler auftritt. |
Methoden
addTo(map)
Fügt den Layer der Karte hinzu.
| Parameter | Beschreibung | Datentyp | Standardwert |
|---|---|---|---|
| map | Map |
- Rückgabe: this
bringToFront()
Bringt den Tile-Layer über alle anderen Tile-Layer nach vorne.
- Rückgabe: this
bringToBack()
Bringt den Tile-Layer unter alle anderen Tile-Layer nach hinten.
- Rückgabe: this
setOpacity(opacity)
Ändert die Deckkraft des Tile-Layers.
| Parameter | Beschreibung | Datentyp | Standardwert |
|---|---|---|---|
| opacity | int |
- Rückgabe: this
setZIndex(zIndex)
Setzt den zIndex des Tile-Layers.
| Parameter | Beschreibung | Datentyp | Standardwert |
|---|---|---|---|
| zIndex | int |
- Rückgabe: this
redraw()
Bewirkt, dass der Layer alle Tiles verwirft und erneut anfordert.
- Rückgabe: this
setUrl(urlTemplate)
Aktualisiert die URL-Vorlage des Layers und zeichnet ihn neu.
| Parameter | Beschreibung | Datentyp | Standardwert |
|---|---|---|---|
| urlTemplate | string |
- Rückgabe: this
getContainer()
Gibt das HTML-Element zurück, das die Tiles für diesen Layer enthält.
- Rückgabe: HTMLElement