Konfiguration #

config.json #

Die config.json enthält die gesamte Konfiguration der Portal-Oberfläche. In ihr wird geregelt welche Elemente sich wo in der Menüleiste befinden, worauf die Karte zentriert werden soll und welche Layer geladen werden sollen. Hier geht es zu einem Beispiel. Die config.json besteht aus der Portalconfig und der Themenconfig

{
   "Portalconfig": {},
   "Themenconfig": {}
}

Portalconfig #

Im Abschnitt Portalconfig können folgende Eigenschaften konfiguriert werden:

1. Titel & Logo (portalTitle)
2. Art der Themenauswahl (treeType)
3. Starteinstellungen der Kartenansicht (mapView)
4. Schaltflächen auf der Kartenansicht sowie mögliche Interaktionen (controls)
5. Menüeinträge sowie Vorhandenheit jeweiliger Tools und deren Reihenfolge (menu)
6. Typ und Eigenschaften des genutzten Suchdienstes (searchBar)
7. Löschbarkeit von Themen (layersRemovable)
8. welche Sprachen genutzt werden sollen (portalLanguage)
9. Konfiguration von Icons für den Classic-Tree
10. Optionales Ausblenden der Header-Leiste

Es existieren die im Folgenden aufgelisteten Konfigurationen:

Beispiel für eine vollständige Konfiguration der Classic-Layertree Icons: #

"classicTreeIcons": {
        "collapsedIcon": "fas fa-caret-right",
        "expandedIcon": "fas fa-caret-down",
        "unselectedIcon": "fas fa-square",
        "selectedIcon": "fas fa-check-square",
        "settingsIcon": "fas fa-cog",
        "showInfoIcon": "fas fa-info-circle",
        "moveLayerUpIcon": "fas fa-caret-up",
        "moveLayerDownIcon": "fas fa-caret-down",
        "copyLayerIcon": "fas fa-copy",
        "removeLayerIcon": "fas fa-trash",
        "zoomToLayerIcon": "fas fa-expand-arrows-alt",
        "folderIcon": "fas fa-folder",
        "authenticationIcon": "fas fa-lock
}

Portalconfig.searchBar #

Konfiguration der Searchbar

Portalconfig.searchBar.bkg #

Konfiguration des BKG Suchdienstes

ACHTUNG: Backend notwendig!

Um die eigene UUID für den BKG nicht öffentlich zu machen, sollten die URLS (hier “bkg_geosearch” und “bkg_suggest”) der restServices im Proxy abgefangen und umgeleitet werden. Beispielhafte Proxy Einstellung

ProxyPass /bkg_geosearch http://sg.geodatenzentrum.de/gdz_geokodierung__[UUID]/geosearch
<Location /bkg_geosearch>
  ProxyPassReverse http://sg.geodatenzentrum.de/gdz_geokodierung__[UUID]/geosearch
</Location>

ProxyPass /bkg_suggest http://sg.geodatenzentrum.de/gdz_geokodierung__[UUID]/suggest
<Location /bkg_suggest>
  ProxyPassReverse http://sg.geodatenzentrum.de/gdz_geokodierung__[UUID]/suggest
</Location>

Beispiel

#!json
"bkg": {
    "minCharacters": 3,
    "suggestServiceId": "4",
    "geosearchServiceId": "5",
    "extent": [454591, 5809000, 700000, 6075769],
    "suggestCount": 10,
    "epsg": "EPSG:25832",
    "filter": "filter=(typ:*)",
    "score": 0.6,
    "zoomToResult": true
}

Portalconfig.searchBar.osm #

Suche bei OpenStreetMap über Stadt, Strasse und Hausnummer. Wird nur durch Klick auf die Lupe oder Enter ausgelöst, da die Anzahl der Abfragen der OSM-Suchmaschine limitiert ist.

Beispiel

#!json

"osm": {
    "minChars": 3,
    "serviceId": "10",
    "limit": 60,
    "states": "Hamburg, Nordrhein-Westfalen, Niedersachsen, Rhineland-Palatinate Rheinland-Pfalz",
    "classes": "place,highway,building,shop,historic,leisure,city,county"
}

Portalconfig.searchBar.gazetteer #

Konfiguration des Gazetteer Suchdienstes

ACHTUNG: Backend notwendig!

Es wird eine Stored Query eines WFS mit vorgegebenen Parametern abgefragt.

Beispiel

#!json
"gazetteer": {
    "minChars": 3,
    "serviceId": "6",
    "searchStreets": true,
    "searchHouseNumbers": true,
    "searchDistricts": true,
    "searchParcels": true,
    "searchStreetKey": true
}

Portalconfig.searchBar.gdi #

Konfiguration des GDI Suchdienstes. Deprecated in 3.0.0. Bitte elasticSearch verwenden.

Beispiel

#!json
"gdi": {
    "minChars": 3,
    "serviceId": "elastic",
    "queryObject": {
        "id": "query",
        "params": {
            "query_string": "%%searchString%%"
        }
}

Portalconfig.searchBar.gdi.queryObject #

Todo

Portalconfig.searchBar.gdi.queryObject.params #

Todo

Portalconfig.searchBar.elasticSearch #

Konfiguration des Elastic Search Suchdienstes

Beispiel

#!json
"elasticSearch": {
    "minChars":3,
    "serviceId":"elastic_hh",
    "type": "GET",
    "payload": {
        "id":"query",
        "params":{
            "query_string":""
        }
    },
    "searchStringAttribute": "query_string",
    "responseEntryPath": "hits.hits",
    "triggerEvent": {
        "channel": "Parser",
        "event": "addGdiLayer"
    },
    "hitMap": {
        "name": "_source.name",
        "id": "_source.id",
        "source": "_source"
    },
    "hitType": "Fachthema",
    "hitGlyphicon": "glyphicon-list"
}

Portalconfig.searchBar.elasticSearch.hitMap #

Mapping Objekt. Mappt die Attribute des Ergebnis Objektes auf den entsprechenden Key.

Portalconfig.searchBar.elasticSearch.triggerEvent #

Radio event das ausgelöst werden soll durch Mouseover und Click. Definiert durch “channel” und “event”.

Portalconfig.searchBar.specialWFS #

Konfiguration der SpecialWFS Suche

Beispiel

#!json
"specialWFS": {
    "minChars": 5,
    "timeout": 10000,
    "definitions": [
        {
            "url": "/geodienste_beispiel_de/MRH_WFS_Rotenburg",
            "typeName": "app:mrh_row_bplan",
            "propertyNames": ["app:name"],
            "name": "B-Plan",
            "namespaces": "xmlns:app='http://www.deegree.org/app'"
        },
        {
            "url": "/geodienste_beispiel_de/HH_WFS_Bebauungsplaene",
            "typeName": "app:prosin_imverfahren",
            "propertyNames": ["app:plan"],
            "geometryName": "app:the_geom",
            "name": "im Verfahren",
            "namespaces": "xmlns:app='http://www.deegree.org/app'"
        }
    ]
}

Portalconfig.searchBar.specialWFS.definition #

Konfiguration einer Definition bei der SpecialWFS Suche

Beispiel

#!json
{
    "url": "/geodienste_beispiel_de/HH_WFS_Bebauungsplaene",
    "typeName": "app:prosin_imverfahren",
    "propertyNames": ["app:plan"],
    "geometryName": "app:the_geom",
    "name": "im Verfahren"
}

Portalconfig.searchBar.tree #

Alle Layer, die im Themenbaum des Portals sind, werden durchsucht.

Beispiel

#!json
"tree": {
    "minChars": 5
}

Portalconfig.searchBar.visibleWFS #

Konfiguration der Suche über die sichtbaren WFS. Deprecated in 3.0.0. Verwenden Sie visibleVector.

Beispiel

#!json
"visibleWFS": {
    "minChars": 3
}

Portalconfig.searchBar.visibleVector #

Konfiguration der Suche über die sichtbaren VectorLayer. Bei der Layerdefinition unter “Fachdaten” muss für jeden VectorLayer, der durchsucht werden soll das attribut “searchField” gesetzt sein. siehe searchField

Beispiel

#!json
"visibleVector": {
    "minChars": 3,
    "layerTypes": ["WFS", "GeoJSON"]
}

Portalconfig.portalLanguage #

Konfiguration der Sprache

Portalconfig.controls #

Portalconfig.controls.attributions #

Das Attribut attributions kann vom Typ Boolean oder Object sein. Wenn es vom Typ Boolean ist, zeigt diese flag ob vorhandene Attributions angezeigt werden sollen oder nicht. Ist es vom Typ Object so gelten folgende Attribute:

Beispiel als Boolean

#!json
"attributions": true

Beispiel als Object

#!json
"attributions": {
    "isInitOpenDesktop": true,
    "isInitOpenMobile": false,
}

Portalconfig.controls.orientation #

Beispiel mit poiDistances vom Typ Boolean

#!json
"orientation": {
    "zoomMode": "once",
    "poiDistances": true
}

Beispiel mit poiDistances vom Typ Integer[]

#!json
"orientation": {
    "zoomMode": "once",
    "poiDistances": [500, 1000, 2000, 5000]
}

Beispiel mit Positionierung des Werkzeugs

#!json
"orientation": {
    "zoomMode": "once",
    "position": "top"
}

Portalconfig.controls.overviewMap #

Hinweis: Overviewmap ist nur für die Positionierung bottomLeft optimiert.

Beispiel overviewmap als Object:

#!json
"overviewMap": {
    "resolution": 305.7487246381551,
    "layerId": "452",
    "isInitOpen": false,
    "position": "bottomLeft"
}

Portalconfig.controls.zoom #

Beispiel nur Zoombox wird freigeschalten

#!json
"zoom": {
    "showZoomIn": false,
    "showZoomOut": false,
    "showZoomBox": true
}

Portalconfig.controls.geolocation #

Beispiel mit Positionierung des Werkzeugs

#!json
"geolocation": {
    "zoomLevel": 8,
    "position": "bottom",
    "showAccuracyGeometry": true
}

Portalconfig.portalTitle #

In der Menüleiste kann der Portalname und ein Bild angezeigt werden, sofern die Breite der Leiste ausreicht. Der Portaltitle ist mobil nicht verfügbar.

Beispiel portalTitle:

#!json
"portalTitle": {
    "title": "Master",
    "logo": "../../lgv-config/img/hh-logo.png",
    "link": "https://geobasis-bb.de",
    "toolTip": "Landesbetrieb Geoinformation und Vermessung"
}

Portalconfig.portalTitle.titlelist #

Beispiel portalTitle mit titlelist:

#!json
"portalTitle": {
    "title": "Master",
    "logo": "../../lgv-config/img/hh-logo.png",
    "link": "https://geobasis-bb.de",
    "toolTip": "Landesbetrieb Geoinformation und Vermessung",
    "titlelist": {
        "help": {
            "title": "Hilfe",
            "href": "ressources/Hilfe/Brandenburgviewer_Nutzerhandbuch.pdf",
            "separator": "|"
        },
        "feedback": {
            "href": "mailto:kundenservice@geobasis-bb.de?subject=Feedback%20zum%20neuen%20BRANDENBURGVIEWER&body=Sehr%20geehrte%20Damen%20und%20Herren,%0D%0A%0D%0A",
            "title": "Feedback",
            "title-alternative": "Feedback geben", 
            "separator": "|"
        },
        "neues": {
            "title": "Neuerungen",
            "href": "ressources/Hilfe/Brandenburgviewer_Neuerungen.pdf",
            "title-alternative": "Was ist neu?", 
            "separator": "|"
        }               
    }
}

Portalconfig.controls.totalView #

Das Attribut totalView kann vom Typ Boolean oder Object sein. Wenn es vom Typ Boolean ist, zeigt es den Butten an, der in den Defaulteinsellungen gesetzt ist. Ist es vom Typ Object, so gelten folgende Attribute

Beispiel totalView als Object:

#!json
"totalView" : {
    "glyphicon": "glyphicon-step-forward",
    "tableGlyphicon": "glyphicon-step-forward"
},

Beispiel totalView als Boolean:

#!json
"totalView": true

Portalconfig.controls.backForward #

Das Attribut backForward kann vom Typ Boolean oder Object sein. Wenn es vom Typ Boolean, zeigt es die Buttons zur Steuerung der letzten und nächsten Kartenansichten mit den Defaulteinsellungen an. Ist es vom Typ Object, so gelten folgende Attribute

Beispiel backForward als Object:

#!json
"backForward" : {
    "glyphiconFor": "glyphicon-fast-forward",
    "glyphiconBack": "glyphicon-fast-backward"
}

Beispiel backForward als Boolean:

#!json
"backForward": true

Portalconfig.mapView #

Beispiel:

#!json
"mapView": {
    "backgroundImage": "/lgv-config/img/backgroundCanvas.jpeg",
    "startCenter": [561210, 5932600],
    "options": [
        {
            "resolution": 611.4974492763076,
            "scale": 2311167,
            "zoomLevel": 0
        },
        {
            "resolution": 305.7487246381551,
            "scale": 1155583,
            "zoomLevel": 1
        },
        {
            "resolution": 152.87436231907702,
            "scale": 577791,
            "zoomLevel": 2
        },
        {
            "resolution": 76.43718115953851,
            "scale": 288896,
            "zoomLevel": 3
        },
        {
            "resolution": 38.21859057976939,
            "scale": 144448,
            "zoomLevel": 4
        },
        {
            "resolution": 19.109295289884642,
            "scale": 72223,
            "zoomLevel": 5
        },
        {
            "resolution": 9.554647644942321,
            "scale": 36112,
            "zoomLevel": 6
        },
        {
            "resolution": 4.7773238224711605,
            "scale": 18056,
            "zoomLevel": 7
        },
        {
            "resolution": 2.3886619112355802,
            "scale": 9028,
            "zoomLevel": 8
        },
        {
            "resolution": 1.1943309556178034,
            "scale": 4514,
            "zoomLevel": 9
        },
        {
            "resolution": 0.5971654778089017,
            "scale": 2257,
            "zoomLevel": 10
        }
    ],
    "extent": [510000.0, 5850000.0, 625000.4, 6000000.0],
    "resolution": 15.874991427504629,
    "zoomLevel": 1,
    "epsg": "EPSG:25832"
    }

Portalconfig.mapView.option #

Eine option definiert eine Zoomstufe. Diese muss definiert werden über die Auflösung, die Maßstabszahl und das ZoomLevel. Je höher das ZoomLevel ist, desto kleiner ist die Scale. und desto näher hat man gezoomt.

Beispiel einer mapview Option

#!json
{
    "resolution": 611.4974492763076,
    "scale": 2311167,
    "zoomLevel": 0
}

Portalconfig.menu #

Hier können die Menüeinträge und deren Anordnung konfiguriert werden. Die Reihenfolge der Werkzeuge ergibt sich aus der Reihenfolge in der Config.json.

Portalconfig.menu.legend #

Konfigurations-Optionen der Legende.

Portalconfig.menu.info #

Informations-Ordner in dem Werkzeuge oder staticlinks eingetragen werden können.

Portalconfig.menu.info.children #

Liste der Werkzeuge oder Staticlinks die im Info-Ordner erscheinen sollen.

Portalconfig.menu.tree #

Hier können die Menüeinträge und deren Anordnung konfiguriert werden. Die Reihenfolge der Werkzeuge ergibt sich aus der Reihenfolge in der Config.json.

Portalconfig.menu.folder #

Ein Ordner-Object wird dadurch definiert, dass es neben “name” und “glyphicon” noch das attribut “children” besitzt.

Beispiel eines folders

#!json
"tools":{
    "name": "Werkzeuge",
    "glyphicon": "glyphicon-wrench",
    "children": {
        {
            "name": "Legende",
            "glyphicon": "glyphicon-book"
        }
    }
}

Portalconfig.menu.menuPosition #

Definiert die Positionierung der Menüleiste. Wenn nicht angegegben wird “top” als default verwendet. “top” hat eine Ausdehnung von 100%, während die anderen Varianten standardmäßig 200px breit sind. Die Breite kann mittels menuWidth angegeben werden, siehe unten.

Beispiel

#!json
"menu": {
    "menuPosition": "left",
    "menuWidth": 250,
    "tools": {
        ...
    }
}

Portalconfig.menu.menuWidth #

Definiert die Breite des Menüs wenn die Positionierung “left” oder “right” ist. Der Wert verwendet die Einheit Pixel.

Beispiel

#!json
"menu": {
    "menuPosition": "left",
    "menuWidth": 250,
    "tools": {
        ...
    }
}

Portalconfig.menu.tools #

Portalconfig.menu.tools.children #

Liste aller konfigurierbaren Werkzeuge. Jedes Werkzeug erbt von tool und kann/muss somit auch die dort angegebenen attribute konfiguiert bekommen.

Portalconfig.menu.tool #

Über den Attribut-key des Werkzeuges wird definiert, welches Werkzeug mit welchen Eigenschaften geladen wird. Jedes Tool besitzt mindestens die unten aufgeführten Attribute. Welche Tools konfigurierbar sind, finden Sie unter tools.

Beispiel eines Tools

#!json
"legend":{
    "name": "Legende",
    "glyphicon": "glyphicon-book"
}

Portalconfig.menu.tool.gfi #

Zeigt Informationen zu einem abgefragten Feature ab, indem GetFeatureInfo-Requests oder GetFeature-Requests oder geladene Vektordaten abgefragt werden.

Beispiel einer GFI Konfiguration

#!json
"gfi":{
    "name":"Informationen abfragen",
    "glyphicon":"glyphicon-info-sign",
    "isActive":true,
    "centerMapMarkerPolygon":true,
    "highlightVectorRules": {
        "fill": {
            "color": [215, 102, 41, 0.9]
        },
        "image": {
            "scale": 1.5
        },
        "stroke": {
            "width": 4
        },
        "text": {
            "scale": 2
        }
    }
}

Beispiel einer GFI Konfiguration zur Informationsabfrage von Features

#!json
"gfi":{
    "name":"Informationen abfragen",
    "glyphicon":"glyphicon-info-sign",
    "isActive":true,
    "centerMapMarkerPolygon":true
}

Portalconfig.menu.tool.gfi.highlightVectorRules #

Liste der Einstellungen zum überschreiben von Vektorstyles bei GFI Abfragen.

Portalconfig.menu.tool.gfi.highlightVectorRules.fill #

Todo

#!json
{
    "color": [215, 102, 41, 0.9]
}

Portalconfig.menu.tool.gfi.highlightVectorRules.image #

Todo

#!json
{
    "scale": 1.5
}

Portalconfig.menu.tool.gfi.highlightVectorRules.stroke #

Todo

#!json
{
    "width": 4
}

Portalconfig.menu.tool.gfi.highlightVectorRules.text #

Todo

#!json
{
    "scale": 2
}

Portalconfig.menu.tool.filter #

Der Filter bietet eine vielzahl von Möglichkeiten um Vektor-Daten filtern zu können.

Beispiel

#!json
"filter":{
    "name": "Filter",
    "glyphicon": "glyphicon-filter",
    "deactivateGFI": false,
    "isGeneric": false,
    "isInitOpen": false,
    "allowMultipleQueriesPerLayer": false,
    "predefinedQueries": [
        {
            "layerId": "8712",
            "isActive": false,
            "isSelected": false,
            "name": "Grundschulen",
            "predefinedRules": [
                {
                    "attrName": "kapitelbezeichnung",
                    "values": ["Grundschulen", "Langformschulen"]
                }
            ],
            "attributeWhiteList": ["bezirk", "stadtteil", "schulform", "ganztagsform", "anzahl_schueler", "schwerpunktschule", "bilingual"]
        },
        {
            "layerId": "8712",
            "isActive": false,
            "isSelected": false,
            "name": "Stadtteilschulen",
            "predefinedRules": [
                {
                    "attrName": "kapitelbezeichnung",
                    "values": ["Stadtteilschulen", "Langformschulen"]
                }
            ],
            "attributeWhiteList": ["bezirk", "stadtteil", "schulform", "ganztagsform", "anzahl_schueler", "schwerpunktschule", "fremdsprache", "fremdsprache_mit_klasse", "schulische_ausrichtung"]
        },
        {
            "layerId": "8712",
            "isActive": false,
            "isSelected": false,
            "name": "Gymnasien",
            "info": "Sie finden berufliche Gymnasien ab der Klassenstufe 11 bei den Beruflichen Schulen.",
            "predefinedRules": [
                {
                    "attrName": "kapitelbezeichnung",
                    "values": ["Gymnasien"]
                }
            ],
            "attributeWhiteList": ["bezirk", "stadtteil", "schulform", "ganztagsform", "anzahl_schueler", "fremdsprache", "fremdsprache_mit_klasse", "schulische_ausrichtung"]
        },
        {
            "layerId": "8712",
            "isActive": false,
            "isSelected": false,
            "name": "Sonderschulen",
            "predefinedRules": [
                {
                    "attrName": "kapitelbezeichnung",
                    "values": ["Sonderschulen"]
                }
            ],
            "attributeWhiteList": ["bezirk", "stadtteil", "ganztagsform", "foerderart", "abschluss"]
        },
        {
        "layerId": "1711",
        "isActive": true,
        "isSelected": true,
        "name": "Krankenhäuser",
        "predefinedRules": [],
        "attributeWhiteList": ["teilnahme_geburtsklinik", "teilnahme_notversorgung"]
        }
    ]
}

Portalconfig.menu.tool.filter.predefinedQuery #

Objekt, das eine Filtereinstelung definiert.

Beispiel

#!json
{
    "layerId": "8712",
    "isActive": false,
    "isSelected": false,
    "name": "Grundschulen",
    "predefinedRules": [
        {
            "attrName": "kapitelbezeichnung",
            "values": ["Grundschulen", "Langformschulen"]
        }
    ],
    "attributeWhiteList": ["bezirk", "stadtteil", "schulform", "ganztagsform", "anzahl_schueler", "schwerpunktschule", "bilingual"]
}

Portalconfig.menu.tool.filter.predefinedQuery.predefinedRule #

Filterregel die die Daten immer vorfiltert.

Beispiel

#!json
{
    "attrName": "kapitelbezeichnung",
    "values": ["Grundschulen", "Langformschulen"]
}

Portalconfig.menu.tool.filter.predefinedQuery.attributeWhiteListObject #

Ein AttributeWhiteList Objekt kann entweder ein String sein, welcher den Attributnamen repräsentiert. Er kann aber auch ein Objekt sein.

Beispiel als String

#!json
"Grundschulen"

Beispiel als Objekt

#!json
{
    "name": "Grundschulen",
    "matchingMode": "AND"
}

Portalconfig.menu.tool.compareFeatures #

Hier können Vector Features miteinander verglichen werden.

Beispiel

#!json
"compareFeatures": {
    "name": "Vergleichsliste",
    "glyphicon": "glyphicon-th-list",
    "numberOfFeaturesToShow": 5,
    "numberOfAttributesToShow": 10
}

Portalconfig.menu.tool.parcelSearch #

Flurstückssuche über einen WFS.

ACHTUNG: Backend notwendig!

Je nach Konfiguration werden spezielle Stored Queries eines WFS mit vorgegebenen Parametern abgefragt.

Beispiel: https://geodienste.beispiel.de/HH_WFS_DOG?service=WFS&request=GetFeature&version=2.0.0&&StoredQuery_ID=Flurstueck&gemarkung=0601&flurstuecksnummer=00011

Beispiel

#!json
"parcelSearch": {
    "name": "Flurstückssuche",
    "glyphicon": "glyphicon-search",
    "serviceId": "6",
    "storedQueryID": "Flurstueck",
    "configJSON": "/lgv-config/gemarkungen_hh.json",
    "parcelDenominator": false,
    "styleId": "flaecheninfo"
}

Portalconfig.menu.tool.print #

Druckmodul. Konfigurierbar für 3 Druckdienste: den High Resolution PlotService, MapfishPrint 2 oder MapfishPrint 3.

ACHTUNG: Backend notwendig!

Es wird mit einem Mapfish-Print2, Mapfish-Print3 oder einem HighResolutionPlotService im Backend kommuniziert.

Beispiel Konfiguration mit MapfishPrint2

#!json
"print": {
    "name": "Karte drucken",
    "glyphicon": "glyphicon-print",
    "printID": "123456",
    "configYAML": "/master",
    "outputFilename": "report",
    "title": "Mein Titel",
    "gfi": true
}

Beispiel Konfiguration mit High Resolution PlotService

#!json
"print": {
    "name": "Karte drucken",
    "glyphicon": "glyphicon-print",
    "mapfishServiceId": "123456",
    "filename": "Ausdruck",
    "title": "Mein Titel",
    "version" : "HighResolutionPlotService"
}

Beispiel Konfiguration mit MapfishPrint3

#!json
"print": {
    "name": "Karte drucken",
    "glyphicon": "glyphicon-print",
    "mapfishServiceId": "mapfish_printservice_id",
    "printAppId": "mrh",
    "filename": "Ausdruck",
    "title": "Mein Titel",
    "version" : "mapfish_print_3"
}

Portalconfig.menu.tool.routing #

Routing Modul.

ACHTUNG: Backend notwendig!

Beispiel

#!json
"routing": {
    "name": "Routenplaner",
    "glyphicon": "glyphicon-road",
    "viomRoutingID": "1",
    "bkgSuggestID": "2",
    "bkgGeosearchID": "3",
    "isInitOpen": false
}

Portalconfig.menu.tool.featureLister #

Modul, das Vektor Features darstellt. Durch hovern über ein feature in der Liste wird auf der Karte der Marker gesetzt.

Beispiel

#!json
"featureLister": {
    "name": "Liste",
    "glyphicon": "glyphicon-menu-hamburger",
    "maxFeatures": 10
}

Portalconfig.menu.tool.contact #

Werkzeug, wodurch der Nutzer mit einem definierten Postfach Kontakt aufnehmen kann.

ACHTUNG: Backend notwendig!

Das Contact kommuniziert mit einem SMTP-Server und ruft dort die sendmail.php auf.

Beispiel

#!json
"contact":{
    "name": "Kontakt",
    "glyphicon": "glyphicon-envelope",
    "serviceID": "123",
    "from": [
        {
            "email": "kundenservice@geobasis-bb.de",
            "name":"LGBGeoportalHilfe"
        }
    ],
    "to": [
        {
            "email": "kundenservice@geobasis-bb.de",
            "name":"LGBGeoportalHilfe"
        }
    ],
    "cc": [],
    "bcc": [],
    "ccTouser": true,
    "textPlaceholder": "Hier Text eingeben.",
    "includeSystemInfo": true,
    "deleteAfterSend": true,
    "withTicketNo": false
}

Portalconfig.menu.tool.contact.email #

Email Objekt bestehend aus der email und aus dem Anzeigename.

Beispiel

#!json
{
    "email": "kundenservice@geobasis-bb.de",
    "name":"LGBGeoportalHilfe"
}

Portalconfig.menu.tool.layerSlider #

Der Layerslider ist ein Werkzeug um verschiedene Layer in der Anwendung hintereinander an bzw auszuschalten. Dadurch kann z.B. eine Zeitreihe verschiedener Zustände animiert werden.

#!json
"layerSlider": {
    "name": "Zeitreihe",
    "glyphicon": "glyphicon-film",
    "title": "Simulation von Beispiel-WMS",
    "sliderType": "player",
    "timeInterval": 2000,
    "layerIds": [
        {
            "title": "Dienst 1",
            "layerId": "123"
        },
        {
            "title": "Dienst 2",
            "layerId": "456"
        },
        {
            "title": "Dienst 3",
            "layerId": "789"
        }
    ]
}

Portalconfig.menu.tool.layerSlider.layerId #

Definiert einen Layer für den Layerslider.

Beispiel

#!json
{
    "title": "Dienst 1",
    "layerId": "123"
}

Portalconfig.menu.tool.virtualcity #

Das virtualcity Tool bietet die Möglichkeit die Planungen von einem virtualcityPLANNER Dienst in der Kartenviewer API anzuzeigen. Die Planungen müssen im virtualcityPLANNER auf Öffentlich gesetzt sein, dann können sie über dieses Tool angezeigt werden

Beispiel

#!json
{
  "title": "virtualcityPLANNER",
  "serviceId": "1"
}

Portalconfig.menu.tool.shadow #

Das ShadowTool bietet eine Oberfläche zur Definition einer Zeitangabe. Über Slider und Datepicker können Zeitangaben in einem 30-Minuten Raster angegeben werden. Die ausgewählte Zeitangabe dient dem Rendern der Schatten aller 3D-Objekte im 3D-Modus, indem der Sonnenstand simuliert wird. Durch Ziehen des Sliders oder Auswahl eines neuen Datums wird unmittelbar ein neuer Sonnenstand simuliert. Per default startet das Tool mit der aktuellen Zeitangabe, die über Parameter überschrieben werden kann.

Beispiel

#!json
{
    "shadowTime": {
        "month": "6",
        "day": "20",
        "hour": "13",
        "minute": "0"
    },
    "isShadowEnabled": true
}

Portalconfig.menu.tool.shadow.shadowTime #

Todo

Beispiel

#!json
{
    "month": "6",
    "day": "20",
    "hour": "13",
    "minute": "0"
}

Portalconfig.menu.tool.measure #

Messwerkzeug um Flächen oder Strecken zu messen. Dabei kann zwischen den Einheiten m/km bzw m²/km² gewechselt werden. Die Anzeige der Messgenauigkeit bzw. Abweichung kann ausgeschaltet werden (displayDeviance: false).

Portalconfig.menu.staticlinks #

Das Array staticlink beinhaltet Objekte die entweder als link zu einer anderen Webressource dienen oder als Trigger eines zu definierenden Events.

Beispiel als onClickTrigger

#!json
"staticlinks": [
    {
        "name": "Alert",
        "glyphicon": "glyphicon-globe",
        "onClickTrigger": [
            {
                "channel": "Alert",
                "event": "alert",
                "data": "Hello World!"
            }
        ]
    }
]

Portalconfig.menu.staticlinks.staticlink #

Ein Staticlink-Objekt enthält folgende Attribute.

Beispiel als url

#!json
{
    "name": "Brandenburg",
    "glyphicon": "glyphicon-globe",
    "url": "http://www.brandenburg.de"
}

Beispiel als onClickTrigger

#!json
{
    "name": "Alert",
    "glyphicon": "glyphicon-globe",
    "onClickTrigger": [
        {
            "channel": "Alert",
            "event": "alert",
            "data": "Hello World!"
        }
    ]
}

Portalconfig.menu.staticlinks.staticlink.onClickTrigger #

Über einen onClickTrigger wird ein Event getriggert und eventuell Daten mitgeschickt.

Beispiel

#!json
{
    "channel": "Alert",
    "event": "alert",
    "data": "Hello World!"
}

Themenconfig #

Die Themenconfig definiert welche Inhalte an welche Stelle im Themenbaum vorkommen. Je nach Konfiguration des treeType können auch Ordner Strukturen in den Fachdaten angegeben werden. Für eine komplett freie Konfiguration des Themenbaums wählen Sie den Typ “classic”.

Beispiel

#!json
"Themenconfig": {
    "Hintergrundkarten": {},
    "Fachdaten": {},
    "Fachdaten_3D": {}
}

oder

#!json
"Themenconfig": {
    "classicTree": [
        ...
    ]
}

Themenconfig.Hintergrundkarten #

Hier werden die Hintergrundkarten definiert

Beispiel

#!json
"Hintergrundkarten": {
    "name": "Meine Hintergrundkarten",
    "Layer": [
        {
            "id": "123"
        }
    ]
},

Themenconfig.Fachdaten #

Hier werden die Fachdaten definiert

Beispiel

#!json
"Fachdaten": {
    "name": "Meine Fachdaten",
    "Layer": [
        {
            "id": "123"
        }
    ]
},

Themenconfig.Fachdaten_3D #

Hier werden die 3D-Daten für die 3D-Ansicht definiert. Wird nur im 3D-Modus eingeblendet.

Beispiel

#!json
"Fachdaten_3D":
    {
      "name": "Meine Fachdaten 3D",
      "Layer":
        [
        {
          "id": "12883"
        }
       ]
    }

Themenconfig.classicTree #

Hier wird die Konfiguration des “classic” Themenbaums angegeben. Es gibt hier keine festen Einteilungen in Fachdaten oder Hintergrundkarten. Der Nutzer kann die Struktur und Reihenfolge von Ordnern und Layern vollständig über diese Konfiguration steuern.

Soll ein Layer als “BaseLayer” bzw. Hintergrundlayer verwendet werden, so kann dies hier oder in der services*.json mittels des Attributes “isBaseLayer” angegeben werden.

Ordner müssen zwingend die Eigenschaft “type” mit dem Wert “folder” verwenden. Für Layer ist die Verwendung der Eigenschaft “type” mit dem Wert “layer” optional.

Beispiel

#!json
"Themenconfig": {
    "classicTree": [
      {
        "id": "1000",
        "name": "Layer 1"
      },
      {
        "name": "Mein erster Ordner",
        "type": "folder",
        "children": [
            {
              "id": "1006",
              "name": "Luftbilder 1"
            },
            {
              "id": "1007",
              "name": "Luftbilder 2"
            },
            {
                "name": "Mein zweiter Ordner",
                "type": "folder",
                "children": [
                  {
                    "name": "Mein dritter Ordner",
                    "type": "folder",
                    "children": [
                      {
                        "id": "2426",
                        "name": "Layer 2"
                      },
                      {
                        "id": "2005",
                        "name": "Layer 3"
                      }
                    ]
                  }
                ]
            }
        ]
      },
      {
        "id": "1234",
        "name": "Layer 4"
      }
    ]
  }

Themenconfig.Ordner #

Hier werden die Ordner definiert. Ordner können auch verschachtelt konfiguriert werden.

Beispiel Ordner mit einem Layer

#!json
"Fachdaten": {
    "Ordner": [
        {
            "Titel": "Mein Ordner",
            "Layer": [
                {
                    "id": "123"
                }
            ]
        }
    ]
}

Beispiel Ordner mit einem Unterordner in dem eine Layer konfiguriert ist

#!json
"Fachdaten": {
    "Ordner": [
        {
            "Titel": "Mein erster Ordner",
            "Ordner": [
                {
                    "Titel": "Mein zweiter Ordner",
                    "Layer": [
                        {
                            "id": "123"
                        }
                    ]
                }
            ]
        }
    ]
}

Beispiel Ordner einem Unterordner. Auf der Ebene des Unterordners ist auch nochmal ein Layer definiert

#!json
"Fachdaten": {
    "Ordner": [
        {
            "Titel": "Mein erster Ordner",
            "Ordner": [
                {
                    "Titel": "Mein zweiter Ordner",
                    "Layer": [
                        {
                            "id": "123"
                        }
                    ]
                }
            ],
            "Layer": [
                {
                    "id": "456"
                }
            ]
        }
    ]
}

Themenconfig.GroupLayer #

Hier werden die GruppenLayer definiert. Layer können auf viele verschiedene Arten konfiguriert werden. Ein großteil der Attribute ist in der services.json definiert, kann jedoch hier am Layer überschrieben werden. Neben diesen Attributen gibt es auch Typ-spezifische Attribute für WMS und Vector.

Beispiel

#!json
{
    "id": "myId",
    "name": "myGroupLayer",
    "children": [
        {
            "id": "123",
            "name": "myLayer_1"
        },
        {
            "id": "456",
            "name": "myLayer_2"
        }
    ]
}

Themenconfig.Layer #

Hier werden die Layer definiert. Layer können auf viele verschiedene Arten konfiguriert werden. Ein großteil der Attribute ist in der services.json definiert, kann jedoch hier am Layer überschrieben werden. Neben diesen Attributen gibt es auch Typ-spezifische Attribute für WMS und Vector.

Beispiel mit einer Id

#!json
{
    "id": "123"
}

Beispiel mit einem Array von Ids

#!json
{
    "id": ["123", "456", "789"],
    "name": "mein testlayer"
}

Beispiel mit einem LayerSlider

#!json
{
    "type": "folder",
    "name": "Luftbilder",
    "isVisibleInTree": false,
    "layerSliderConfig": {
        "title": "Luftbilder",
        "layers": [
            {
                "title": "Luftbilder 1936",
                "layerId": "1000"
            },
            {
                "title": "Luftbilder 1967",
                "layerId": "1001"
            },
            {
                "title": "Luftbilder 1995",
                "layerId": "1002"
            }
        ]
    }
}

Themenconfig.Layer.WMS #

Hier werden WMS typische Attribute aufgelistet.

Beispiel

#!json
{
    "id": "123456",
    "name": "MyWMSLayerName",
    "transparency": 0,
    "visibility": true,
    "supported": ["2D"],
    "extent": [454591, 5809000, 700000, 6075769],
    "gfiTheme": "default",
    "layerAttribution": "MyBoldAttribution for layer 123456",
    "legendURL": "https://myServer/myService/legend.pdf",
    "maxScale": "100000",
    "minScale": "1000",
    "autoRefresh": "10000",
    "isNeverVisibleInTree": false,
    "attributesToStyle": ["MyFirstAttr"],
    "featureCount": 2,
    "geomType": "geometry",
    "infoFormat": "text/html",
    "styleable": true,
    "styles": ["firstStyle", "secondStyle"]
}

Themenconfig.Layer.Tileset #

Hier werden Tileset typische Attribute aufgelistet.

Beispiel

#!json
{
    "id": "123456",
    "name": "TilesetLayerName",
    "visibility": true,
    "hiddenFeatures": ["id1", "id2"],
    "cesium3DTilesetOptions" : {
        "maximumScreenSpaceError" : 6
    },
    "cesium3DTileStyle" : {
        "color": "color('red', 0.5)"
    }
}

Themenconfig.Layer.Tileset.Cesium3DTilesetOptions #

Todo

Beispiel

#!json
"cesium3DTilesetOptions" : {
    "maximumScreenSpaceError" : 6
}

Themenconfig.Layer.Tileset.Cesium3DTileStyle #

Todo

Beispiel

#!json
"cesium3DTileStyle" : {
    "color": "color('red', 0.5)"
}

Themenconfig.Layer.Terrain #

Hier werden Terrain typische Attribute aufgelistet.

Beispiel

#!json
{
    "id": "123456",
    "name": "TerrainLayerName",
    "visibility": true,
    "cesiumTerrainProviderOptions": {
        "requestVertexNormals" : true
    },
}

Themenconfig.Layer.Terrain.CesiumTerrainProviderOptions #

Todo

#!json
"cesiumTerrainProviderOptions": {
    "requestVertexNormals" : true
}

Themenconfig.Layer.Entity3D #

Hier werden Entities3D typische Attribute aufgelistet.

Beispiel

#!json
{
      "id": "123456",
      "name": "EntitiesLayerName",
      "visibility": true,
      "typ": "Entities3D",
      "entities": [
         {
            "url": "https://datenbeispiel.de/gdi3d/datasource-data/Simple_Building.glb",
           "attributes": {
             "name": "simple building in Planten und Blomen"
           },
           "latitude": 53.5631,
           "longitude": 9.9800,
           "height": 12,
           "heading": 0,
           "pitch": 0,
           "roll": 0,
           "scale": 5,
           "allowPicking": true,
           "show": true
         }
       ],
       "gfiAttributes" : {
         "name": "Name"
      }
  },

Themenconfig.Layer.Entity3D.Attribute #

Beispiel

#!json
{
   "name": "Fernsehturm.kmz"
}

Themenconfig.Layer.StaticImage #

Hier werden typische Attribute für ein StaticImage aufgelistet.

Beispiel

#!json
{
    "typ": "StaticImage",
    "url": "https://www.w3.org/Graphics/PNG/alphatest.png",
    "name": "Testing PNG File",
    "visibility": true,
    "extent": [560296.72, 5932154.22, 562496.72, 5933454.22]
}

Themenconfig.Layer.Vector #

Hier werden Vector typische Attribute aufgelistet. Vector Layer sind WFS, GeoJSON (nur in EPSG:4326), SensorLayer.

Beispiel

#!json
{
    "id": "123456",
    "name": "MyVectorLayerName",
    "transparency": 0,
    "visibility": true,
    "supported": ["2D"],
    "extent": [454591, 5809000, 700000, 6075769],
    "gfiTheme": "default",
    "layerAttribution": "MyBoldAttribution for layer 123456",
    "legendURL": "https://myServer/myService/legend.pdf",
    "maxScale": "100000",
    "minScale": "1000",
    "autoRefresh": "10000",
    "isNeverVisibleInTree": false,
    "clusterDistance": 60,
    "extendedFilter": true,
    "filterOptions": [
        {
            "fieldName": "myFirstAttributeToFilter",
            "filterName": "Filter_1",
            "filterString": ["*", "value1", "value2"],
            "filterType": "combo"
        },
        {
            "fieldName": "mySecondAttributeToFilter",
            "filterName": "Filter_2",
            "filterString": ["*", "value3", "value4"],
            "filterType": "combo"
        }
    ],
    "mouseHoverField": "name",
    "routable": false,
    "searchField": "name",
    "styleId": "123456",
    "hitTolerance": 50
},
{
    "id" : "11111",
    "name" : "lokale GeoJSON",
    "url" : "portal/master/test.json",
    "typ" : "GeoJSON",
    "gfiAttributes" : "showAll",
    "layerAttribution" : "nicht vorhanden",
    "legendURL" : ""
}

Themenconfig.Layer.Vector.filterOption #

Filteroption die vom Werkzeug “wfsFeatureFilter” in tools benötigt wird.

Beispiel

#!json
{
    "fieldName": "myFirstAttributeToFilter",
    "filterName": "Filter_1",
    "filterString": ["*", "value1", "value2"],
    "filterType": "combo"
}

Datatypes #

In diesem Kapitel werden die erwarteten Datentypen definiert.

Datatypes.Coordinate #

Eine Koordinate besteht aus einem Array bestehend aus zwei Zahlen. Die erste repräsentiert den Rechtswert, die zweite den Hochwert.

Beispiel Koordinate bestehend aus Ganzzahlen(Integer)

#!json
[561210, 5932600]

Beispiel Koordinate bestehend aus Gleitkommazahlen(Float)

#!json
[561210.1458, 5932600.12358]

Datatypes.Extent #

Ein Extent besteht aus einem Array bestehend aus vier Zahlen. Ein Extent besschreibt einen rechteckigen Gültigkeitsbereich. Dabei wird ein Rechteck aufgespannt, das durch die “linke untere” und die “rechte obere” Ecke definiert wird. Das Schema lautet [Rechtswert-Links-Unten, Hochwert-Links-Unten, Rechtswert-Rechts-Oben, Hochwert-Rechts-Oben] oder [minx, miny, maxx, maxy].

Beispiel Extent

#!json
[510000.0, 5850000.0, 625000.4, 6000000.0]

Datatypes.CustomObject #

Ein Objekt mit den benötigten Inhalten. Parameter können je nach Konfiguration, Verwendung und Backend-Komponenten unterschiedlich sein.