ym.modules.provider.Polyline

Überblick

Die Klasse dient dem Zeichnen von Polylinien auf eine Karte. Sie erweitert die Klasse Path. Verwenden Sie Map.addLayer(), um eine Polylinie der Karte hinzuzufügen.

Beispielaufrufe

// Erstellen einer roten Polylinie aus einem Array von LatLng-Punkten.   
var polyline = ym.polyline(latlngs, {color: 'red'}).addTo(map);   
// Die Karte auf die Polylinie zoomen.
map.fitBounds(polyline.getBounds());

Initialisierung

Factory: ym.polyline(latlngs, options)

Instanziiert ein Polylinienobjekt mit einem Array von geografischen Punkten und optional einem Optionen-Objekt.

Parameter

Name Beschreibung Datentypen Standardwert
latlngs [erforderlich] LatLng[]  
options [optional] PolylineOptions  

Parameter: options

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

Name Beschreibung Datentyp Standardwert
smoothFactor Gibt an, wie stark die Polylinie in jeder Zoomstufe vereinfacht werden soll. Mehr bedeutet bessere Leistung und glatteres Aussehen, und weniger bedeutet genauere Darstellung. int 1.0
noClip Deaktiviert das Ausschneiden von Polylinien. bool false

Methoden

addLatLng(latlng) ab v3

Fügt der Polylinie einen bestimmten Punkt hinzu.

Parameter

Name Beschreibung Datentyp Standardwert
latlng   LatLng  

Rückgabe

this

setLatLngs(latlngs) ab v3

Ersetzt alle Punkte in der Polylinie durch das angegebene Array von geografischen Punkten.

Parameter

Name Beschreibung Datentyp Standardwert
latlngs   LatLng[]  

Rückgabe

this

getLatLngs() ab v3

Gibt ein Array der Punkte im Pfad zurück.

Rückgabe

LatLng[]

spliceLatLngs(index, pointsToRemove, latlng) ab v3

Ermöglicht das Hinzufügen, Entfernen oder Ersetzen von Punkten in der Polylinie. Die Syntax ist die gleiche wie in Array.splice. Gibt das Array der entfernten Punkte zurück (falls vorhanden).

Parameter

Name Beschreibung Datentyp Standardwert
index [required] int  
pointsToRemove [required] int  
latlng [optional] LatLng  

Rückgabe

LatLng[]

getBounds() ab v3

Gibt die LatLngBounds der Polylinie zurück.

Rückgabe

LatLngBounds

toGeoJSON() ab v3

Gibt eine GeoJSON-Darstellung der Polylinie zurück (GeoJSON LineString Feature).

Rückgabe

object