URL Parameter

Diese Dokumentation soll einen kurzen Überblick über die URL Parameter und wie man diese nutzt geben. Die URL Parameter dienen der Umsetzung der Integration des Lageplans in die Uni Webseiten.

Grundvoraussetzung für die Einbindung

Der Parameter `embedded` mit dem Wert `1` ist immer zu übergeben. Nur so ist sichergestellt, dass die App auf die Einbettung reagiert.

https://uocmaps.uni-koeln.de/?embedded=1

Wird der Lageplan mit `embedded=1` aufgerufen, werden die unter "2. GUI Elemente ausblenden/einblenden" gelisteten UI-Elemente prinzipiell ausgeblendet. Falls auch der `building` Parameter übergeben wurde, ist das Anklicken/händische Auswählen von Gebäuden deaktiviert. Zudem wird ein Button eingeblendet mit dem User den Lageplan in einem neuen Tab öffnen können. Dabei werden alle Parameter (abgesehen von `embedded` übernommen), so dass für den User ein möglichst nahtloser Übergang besteht.

Beispielcode zur Einbindung: 


    <iframe
        id="uocmaps"
        title="UoC Maps"
        width="450"
        height="450"
        src="https://uocmaps.uni-koeln.de/?embedded=1"  + Optional weitere Parameter wie zum Beispiel 'building' mit & anhängen ('&building=100')
    \>

2. GUI Elemente ausblenden/einblenden (derzeit werden diese Parameter ignoriert)

Mit folgenden URL Parametern können einzelne GUI Elemente ein- oder ausgeblendet werden:

    Zum ein-/ausblenden der Searchbar

  • search

    • Zum ein-/ausblenden von 'Routenplaner' Button

  • routeplanner

    • Zum ein-/ausblenden von '3D' Button

  • 3dbutton

    • Zum ein-/ausblenden von 'Gebäudeliste' Button

  • list

    • Zum ein-/ausblenden von dem Basemap Button

  • basemapbtn

    • Zum ein-/ausblenden von Feedback Button

  • feedback

    • Zum ein-/ausblenden von der Gebäude Information

  • buildinginfo

Beispiel Nutzung

| Ist der Wert der Parameter auf 'hide' gesetzt, sind die GUI Elemente ausgeblendet

https://uocmaps.uni-koeln.de/?embedded=1&search=hide&routeplanner=hide&3dbutton=hide&list=hide&basemapbtn=hide&feedback=hide&buildinginfo=hide

| Ist der Wert der Parameter auf 'show' gesetzt, sind die GUI Elemente eingeblendet

https://uocmaps.uni-koeln.de/?embedded=1&search=show&routeplanner=show&3dbutton=show&list=show&basemapbtn=show&feedback=show&buildinginfo=show

3. Basemap Optionen auswählen

Mit folgendem URL Parameter sind die vier Basemap Optionen (Hell, Dunkel, Kontrast und Sattelite) auswählbar:

  • basemap

Nutzung

| Ist der Wert von dem Parameter auf 'light' gesetzt, wird die Karte 'Hell' angezeigt

https://uocmaps.uni-koeln.de/?embedded=1&basemap=light

| Ist der Wert von dem Parameter auf 'dark' gesetzt, wird die Karte 'Dunkel' angezeigt

https://uocmaps.uni-koeln.de/?embedded=1&basemap=dark

| Ist der Wert von dem Parameter auf 'highcontrast' gesetzt, wird die Karte 'Kontrast' angezeigt

https://uocmaps.uni-koeln.de/?embedded=1&basemap=highcontrast

| Ist der Wert von dem Parameter auf 'satellite' gesetzt, wird die Karte 'Satellite' angezeigt

https://uocmaps.uni-koeln.de/?embedded=1&basemap=satellite

4. Auf Gebäude zentrieren

Mit folgendem URL Parameter kann auf die Gebäude zentriert werden, indem die Gebäudenummer übergeben wird:

  • building

Die Gebäudenummern sind in der Datei buildings.json unter 'buildingID' zu finden

Nutzung

| Beispiel: Ist der Wert von dem Parameter auf '100' gesetzt, wird auf der Karte das 'Hauptgebäude' zentriert

https://uocmaps.uni-koeln.de/?embedded=1&building=100

Hinweis: Wenn ein Gebäude zentriert wird und kein Zoom-Wert angegeben ist, wird standardmäßig Zoom-Level 17 verwendet.

5. Zoom-Level anpassen

Mit folgendem URL Parameter kann das Zoom-Level der Karte angepasst werden:

  • zoom

Nutzung

Wenn ein Gebäude ausgewählt ist ist das Zoom-Level der Karte per default auf 17 (sonst 16) gesetzt. Wird also kein Zoom-Wert per Param übergeben und ein ist der Zoom-Wert 17 wenn ein Gebäude markiert ist und 16, wenn kein Gebäude markiert ist. Der Zoom-Bereich liegt zwischen einem minimalen Zoomwert von 11 und einem maximalen Zoomwert von 25. Wenn ein Gebäude markiert ist, wird bei "zu hohem" Zoom-Wert dieser intern begrenzt, so dass das ausgewählte Gebäude noch komplett im Fenster angezeigt wird.

| Beispiel: Ist der Wert von dem Parameter auf '18' gesetzt und das ausgewählte Gebäude kann mit diesem Zoom-Wert komplette auf dem Bildschirm angezeigt werden, ist das Zoom Level auf 18

https://uocmaps.uni-koeln.de/?embedded=1&zoom=18

6. Sprache anpassen

Mit folgendem URL Parameter kann die Sprache für die Anwendung festgelegt werden:

  • lang

Nutzung

Aktuell ist der Lageplan in Deutsch ('de') und Englisch ('en') verfügbar. Wir nutzen als die gekürzten Sprachcodes ohne Locale (also nicht z.B. 'de-DE'). Wird der Parameter `lang` mit einer anderen Sprache oder in einem anderen Format gesetzt, setzen wir die Sprache auf Englisch fest. Wird der Parameter gar nicht übermittelt, setzen wir die Sprache auf Deutsch fest.

| Beispiel: Ist der Wert von dem Parameter auf 'en' gesetzt wird das UI der Anwendung in Englisch erscheinen.

https://uocmaps.uni-koeln.de/?embedded=1&lang=en