Beschreibung

Die Geo-API besitzt ein eigenes User-Interface (UI), welches grundsätzliche Funktionen zum Darstellen von Adressen und GeoPunkten auf einer Karte darzustellen.


Jede VIA-Instanz bringt diese Funktionen mit, welche allerdings nur über URL-Parameter aufgerufen werden können.




Verwendung

Das Geo-API UI dient dazu, grundsätzliche Funktionen von VIA in Drittprogramme zu integrieren. Dabei müssen durch die Drittprogramme URLs mit speziellen Parametern erzeugt werden.


Darstellen eines einzelnen Geo-Punktes mit einzelnen Parametern:

Stellt den übergebenen Geo-Punkt auf einer Karte dar. Benutzt einfache URL-Parameter.


Erstellen Sie eine URL nach folgendem Schema:

https://[via_instanz_url]?lat=[längengrad]&lng=[breitengrad]&caption=[Beschreibung zum Punkt]&embed=true


Beispiel:

https://via.demo.via-cloud.de?lat=51.7199&lng=12.1999&caption=Ihr%20übergebener%20Punkt&embed=true


Parameter-NameBeschreibungPflichtBeispiel
latDie Längengrad-Komponenteja51.7199
lngDie Breitengrad-Komponenteja12.1999
captionDie Beschriftung des Punktes. Dies wird in die Karte und die Liste übernommen und einfach angezeigt.optionalEine Punkt-Bezeichnung
embedGibt an, ob die Karte mit den UI-Elementen und Listen dargestellt werden, oder ob nur die Karte angezeigt werden soll.optionaltrue
marker
Gibt dem auf der Karte gezeichneten Punkt einen farbigen Markeroptional
blue, red, green



Darstellen eines einzelnen Geo-Punktes mit einem JSON-Objekt:

Stellt den übergebenen Geo-Punkt auf einer Karte dar. Benutzt ein eindimensionales JSON-Objekt.


Erstellen Sie eine URL nach folgendem Schema:

https://[via_instanz_url]?geopoint=[JSON-Objekt]&embed=true


Beispiel:

https://via.demo.via-cloud.de?geopoint={"lat":"51.1","lng":"12.8","caption":"Ihr Punkt"}&embed=true


Parameter-NameBeschreibungPflichtBeispiel
geopointDas JSON-Objektja{
"lat":"51.1",
"lng":"12.8",
"caption":"Ihr Punkt",
"marker":"green"
}
embedGibt an, ob die Karte mit den UI-Elementen und Listen dargestellt werden, oder ob nur die Karte angezeigt werden soll.optionaltrue


Die JSON-Felder:

JSON-FeldBeschreibungPflichtBeispiel
"lat"Die Längengrad-Komponenteja51.7199
"lng"Die Breitengrad-Komponenteja12.1999
"caption"Die Beschriftung des Punktes. Dies wird in die Karte und die Liste übernommen und einfach angezeigt.optionalEin Freitext
"marker"Gibt dem auf der Karte gezeichneten Punkt einen farbigen Marker
optional
blue, red, green



Darstellen mehrerer Geo-Punkte mit einem JSON-Objekt:

Stellt den übergebenen Geo-Punkt auf einer Karte dar. Benutzt ein eindimensionales JSON-Objekt.


Erstellen Sie eine URL nach folgendem Schema:

https://[via_instanz_url]?geopoints=[JSON-Objekt]&embed=true


Beispiel:  

https://via.demo.via-cloud.de?geopoint=[{"lat": "52.1", "lng": "11.8","caption": "Punkt 1"},{"lat": "51.5","lng": "12.2"},{"lat": "50.43","lng": "13.89"}]&embed=true


Parameter-NameBeschreibungPflichtBeispiel
geopointsDas JSON-Objekt als Arrayja

[

    {

        "lat": "52.1",

        "lng": "11.8",

        "caption": "Punkt 1"

    },

    {

        "lat": "51.5",

        "lng": "12.2"

    },

    {

        "lat": "50.43",

        "lng": "13.89"

    }

]


embedGibt an, ob die Karte mit den UI-Elementen und Listen dargestellt werden, oder ob nur die Karte angezeigt werden soll.optionaltrue


Die JSON-Felder:

JSON-FeldBeschreibungPflichtBeispiel
"lat"Die Längengrad-Komponenteja51.7199
"lng"Die Breitengrad-Komponenteja12.1999
"caption"Die Beschriftung des Punktes. Dies wird in die Karte und die Liste übernommen und einfach angezeigt.optionalIhr Punkt
"marker"
Gibt dem auf der Karte gezeichneten Punkt einen farbigen Marker
optional
blue, red, green



Darstellen eines einzelnen Geo-Punktes anhand einer Adresse:

Stellt die übergebene Adresse auf einer Karte dar. Benutzt einfache URL-Parameter.


Erstellen Sie eine URL nach folgendem Schema:

https://[via_instanz_url]?address=[Straße Hnr, PLZ, Ort]&caption=[Beschreibung zum Punkt]&embed=true


Beispiel:

https://via.demo.via-cloud.de?address=ayrische Straße 8, 01069 Dresden&caption=Ein Punkt&embed=true


Parameter-NameBeschreibungPflichtBeispiel
addressDie in Textform übergebene Adresse.jaBayrische Straße 8, 01069 Dresden
captionDie Beschriftung des Punktes. Dies wird in die Karte und die Liste übernommen und einfach angezeigt.optionalEine Punkt-Bezeichnung
embedGibt an, ob die Karte mit den UI-Elementen und Listen dargestellt werden, oder ob nur die Karte angezeigt werden soll.optionaltrue
marker
Gibt dem auf der Karte gezeichneten Punkt einen farbigen Marker
optional
blue, red, green