Skip to content

Wegue configuration

Christian Mayer edited this page May 20, 2020 · 10 revisions

Wegue configuration

This describes the Wegue application configuration, which is modelled as JSON document.

Properties

General

Property Mandatory Meaning Example
title Title shown in the top toolbar "title": "A Wegue WebGIS App"
baseColor Main colour of the UI elements "baseColor": "red darken-3" or "baseColor": "#ff3388"
logo URL to an image shown as application logo "logo": "https://dummyimage.com/100x100/aaa/fff&text=Wegue"
logoSize Size of the application logo defined in logo "logoSize": "100"
footerTextLeft Text or HTML string to be displayed in the left side of the toolbar "footerTextLeft": "Powered by <a href='https://meggsimum.de/wegue/' target='_blank'>Wegue WebGIS</a>"
footerTextRight Text or HTML string to be displayed in the right side of the toolbar "footerTextRight": "meggsimum"
showCopyrightYear Boolean value, whether the copyright year should be shown on the right side of the toolbar "showCopyrightYear": true or "showCopyrightYear": false
mapZoom x Initial zoom level of the map "mapZoom": 2
mapCenter x Initial center of the map in map projection "mapCenter": [0, 0]
mapProjection Configuration object for CRS / projection used for the map
modules x Array of module configuration objects
mapLayers x Array of map layer configuration objects
projectionDefs Array of CRS / projection definition objects compatible to proj4js
tileGridDefs Array of tile grid definition objects

mapLayers

WMS

Property Mandatory Meaning Example
type x Indicator that the layer is a WMS, always WMS here "type": "WMS"
lid x Unique identifier for the layer "lid": "my-super-wms-layer"
name x Human readable name for the layer, used e.g. in the LayerList "name": "My super WMS"
format Image format for the WMS (has to be supported by the WMS) "format": "image/png"
layers x The WMS LAYERS parameter "layers": "topp:states"
url x The GetMap URL of the WMS "url": "https://ahocevar.com/geoserver/wms"
transparent Boolean value, whether the WMS layer should be queried with a transparent background "transparent": true
singleTile Boolean value, whether the WMS layer should be queried in single tile mode "singleTile": false
projection The projection of the layer. Has to be defined in projectionDefs if not EPSG:4326 or EPSG:3857. if not set the projection of the map is used "projection": "EPSG:3857"
tileGridRef Identifier of the tile grid to use for this layer (has to be defined in tileGridDefs tileGridRef": "dutch_rd"
isBaseLayer Boolean value, whether the layer should be a background layeror not "isBaseLayer": false
visible Boolean value, whether the layer should be initially visible "visible": false
displayInLayerList Boolean value, whether the layer appear in the LayerList "displayInLayerList": true
attributions Text or HTML string to be displayed as source attribution in the map "attributions": "<a href='https://www.pdok.nl' target='_blank'>PDOK</a> by Dutch Kadaster",

JSON Schema

TODO

Clone this wiki locally