ym.modules.provider.Polyline
Überblick
Diese Klasse wird verwendet, um Polylinien auf einer Karte zu zeichnen. Sie erweitert die Klasse Path. Verwenden Sie Map.addLayer(), um eine Polylinie zur Karte hinzuzufügen.
Beispielaufrufe
// Create a red polyline from an array of LatLng points.
var polyline = ym.polyline(latlngs, {color: 'red'}).addTo(map);
// Zoom the map to the polyline.
map.fitBounds(polyline.getBounds());
Initialisierung
Factory: ym.polyline(latlngs, options)
Instanziiert ein Polyline-Objekt mit einem Array geografischer Punkte und optional einem Options-Objekt.
| Parameter | Beschreibung | Datentyp | Standardwert |
|---|---|---|---|
| latlngs | [erforderlich] | LatLng[] | |
| options | [optional] | PolylineOptions |
Parameter: options
Sie können Path-Optionen sowie zusätzlich die folgenden Optionen verwenden:
| Name | Beschreibung | Datentyp | Standardwert |
|---|---|---|---|
| smoothFactor | Legt fest, wie stark die Polylinie bei jeder Zoomstufe vereinfacht werden soll. Mehr bedeutet bessere Performance und ein glatteres Erscheinungsbild, weniger bedeutet eine genauere Darstellung. | int | 1.0 |
| noClip | Deaktiviert das Zuschneiden von Polylinien. | bool | false |
Methoden
addLatLng(latlng)
Fügt der Polylinie einen bestimmten Punkt hinzu.
| Parameter | Beschreibung | Datentyp | Standardwert |
|---|---|---|---|
| latlng | LatLng |
- Rückgabe: this
setLatLngs(latlngs)
Ersetzt alle Punkte in der Polylinie durch das angegebene Array geografischer Punkte.
| Parameter | Beschreibung | Datentyp | Standardwert |
|---|---|---|---|
| latlngs | LatLng[] |
- Rückgabe: this
getLatLngs()
Gibt ein Array der Punkte im Pfad zurück.
- Rückgabe: LatLng[]
spliceLatLngs(index, pointsToRemove, latlng)
Ermöglicht das Hinzufügen, Entfernen oder Ersetzen von Punkten in der Polylinie. Die Syntax entspricht der von Array.splice. Gibt das Array der entfernten Punkte zurück (falls vorhanden).
| Parameter | Beschreibung | Datentyp | Standardwert |
|---|---|---|---|
| index | [erforderlich] | int | |
| pointsToRemove | [erforderlich] | int | |
| latlng | [optional] | LatLng |
- Rückgabe: LatLng[]
getBounds()
Gibt die LatLngBounds der Polylinie zurück.
- Rückgabe: LatLngBounds
toGeoJSON()
Gibt eine GeoJSON-Repräsentation der Polylinie zurück (GeoJSON LineString Feature).
- Rückgabe: object