Special URL parameters exist to change configuration details or execute initial actions on opening the Masterportal. The URL parameter list begins with a "?", and individual parameters are separated with "&" characters. The Parameters are not case sensitive.
| Name | Description | Example | Alternative |
|---|---|---|---|
| ALTITUDE | Only works when used in combination with MAP/MAPMODE. Sets the altitude in 3D mode. |
?Map/mapMode=3D&altitude=127 |
|
| BEZIRK | Deprecated in 3.0.0. Please use "ZOOMTOGEOMETRY" instead. |
?bezirk=wandsbek |
|
| CENTER | Moves the view to center the given coordinate. If PROJECTION is given as parameter, the CENTER coordinates are expected to be given in it, and are translated to the map's coordinate reference system before usage. If PROJECTION is not given, the CENTER coordinates must be given in the map's configured coordinate reference system; see config.namedProjections.epsg. |
?center=553925,5931898 |
|
| MAP/CENTER | Moves the view to center the given coordinate. If PROJECTION is given as parameter, the CENTER coordinates are expected to be given in it, and are translated to the map's coordinate reference system before usage. If PROJECTION is not given, the CENTER coordinates must be given in the map's configured coordinate reference system; see config.namedProjections.epsg. |
?Map/center=[553925,5931898] |
?center=[553925,5931898] or `?center=553925,5931898 |
| CONFIG | Sets the configuration file to use. This is done by either providing an absolute URL (http://... resp. https://...) or a relative path. In the second case, the relative path is combined with the path given in the config.portalConf, and the resulting path must link to a config.json file. |
?config=../config.json |
|
| CONFIGJSON | Sets the configuration file to use. This is done by either providing an absolute URL (http://... resp. https://...) or a relative path. In the second case, the relative path is combined with the path given in the config.portalConf, and the resulting path must link to a config.json file. |
?configJson=../config.json |
|
| FEATUREID | Zooms to the features of a WFS configured via config.zoomtofeature. | ?featureid=18,26 |
|
| MAP/ZOOMTOFEATUREID | Zooms to the features of a WFS configured via config.zoomtofeature (Deprecated in the next major release. Please refer to config.zoomTo instead.). | ?Map/zoomToFeatureId=18,26 |
?zoomToFeatureId=18,26 |
| FEATUREVIAURL | Creates the given features and adds them to a GeoJSON layer. A layerId should be given for each feature set, and each feature must provide the fields coordinates and label. The coordinates should match the respective GeometryType according to the GeoJSON specification RFC7946, which also states that the coordinates must fit the "EPSG:4326" coordinate system. The parameters also depend on the module's configuration in config.featureviaurl. If another coordinate system is defined in the module´s configuration, the coordinates will be transformed to "EPSG:4326". |
&featureviaurl=[{"layerId":"42","features":[{"coordinates":[10,53.5],"label":"TestPunkt"}]}] |
|
| HEADING | Only works when used in combination with MAP/MAPMODE. Sets the heading in 3D mode. |
?Map/mapMode=3D&heading=-1.2502079000000208 |
|
| HIGHLIGHTFEATURE | Describes a layer's feature that is to be highlighted. Layer and feature id are given separated by a comma. | &highlightfeature=layerid,featureId |
|
| MAP/HIGHLIGHTFEATURE | Describes a layer's feature that is to be highlighted. Layer and feature id are given separated by a comma. | &Map/highlightfeature=layerid,featureId |
|
| API/HIGHLIGHTFEATURESBYATTRIBUTE | Highlights the features of a WFS configured via URL parameters wfsId, attributeName, attributeValue and optional attributeQuery. The wfsId has to match the layer configuration in Themenconfig.Layer.WFS and services-internet.json. WFS version has to be 1.1.0. The parameters - attributeName has to contain the name of the property in the WFS (with featurePrefix from config.json prefixed), attributeValue the value to match and optional attributeQuery can be isEqual for exact searching or isLike for an isLike search. See also | ?api/highlightFeaturesByAttribute=1&wfsId=1&attributeName=DK5&attributeValue=valueToSearchFor&attributeQuery=isequal |
?api/highlightFeaturesByAttribute=1&wfsId=1&attributeName=DK5&attributeValue=5555&attributeQuery=islike |
| LNG | Sets the language, if configured in config.js | ?lng=en |
|
| ISINITOPEN | The module matching the given id of the tool is opened initially. Please mind that only one of the windowed tools may be open at a time. | &isinitopen=draw |
|
| TOOLS/[tool-id]/ACTIVE=TRUE | The module matching the given id of the tool is opened initially. Please mind that only one of the windowed tools may be open at a time. | ?Tools/Draw/active=true |
?Draw/active=true or ?draw/active or ?draw=true |
| LAYERIDS | Overrides the initially visible layers. The effect depends on the config.Portalconfig.treeType. If set to "light", layers are set visible additionally. In other trees, the base configuration is overwritten. This can be complemented with the VISIBILITY and TRANSPARENCY flags. It should be noted, that only one WMSTimeLayer can be visible at a time. If the configuration is incorrect (e.g. several WMS-TimeLayer are initially set) only one is displayed. |
&layerids=453,2128 |
|
| MAP/LAYERIDS | Overrides the initially visible layers. The effect depends on the config.Portalconfig.treeType. If set to "light", layers are set visible additionally. In other trees, the base configuration is overwritten. This can be complemented with the VISIBILITY and TRANSPARENCY flags. It should be noted, that only one WMSTimeLayer can be visible at a time. If the configuration is incorrect (e.g. several WMS-TimeLayer are initially set) only one is displayed. |
&Map/layerids=453,2128 |
|
| MAP | Mapmode 2D shows the 2D map (as usual),mapmode 3D shows 3D map when starting masterportal. | ?map=3D |
|
| MAP/MAPMODE | Mapmode 2D shows the 2D map (as usual),mapmode 3D shows 3D map when starting masterportal. | ?Map/mapMode=2D |
?mapMode=2d or ?mapMode=3D |
| MARKER | Sets a marker to the given coordinate and zooms to it. If PROJECTION is given as parameter, the marker coordinates are to be expected in that coordinate reference system and are translated before application. Else, the given coordinates must match the map's coordinate reference system. See config.namedProjections.epsg. |
&marker=565874,5934140 |
|
| MAPMARKER | Sets a marker to the given coordinate and zooms to it. If PROJECTION is given as parameter, the marker coordinates are to be expected in that coordinate reference system and are translated before application. Else, the given coordinates must match the map's coordinate reference system. See config.namedProjections.epsg. |
?MapMarker=[565874,5934140] |
?MapMarker=565874,5934140 |
| MDID | Activates the layer with the given metadata id. Only usable in tree mode "default". |
&mdid=6520CBEF-D2A6-11D5-88C8-000102DCCF41 |
|
| MAP/MDID | Activates the layer with the given metadata id. Only usable in tree mode "default". |
?Map/mdId=6E28E698-F4FA-4231-A8C5-CC44441FF2A7 |
|
| PROJECTION | Coordinate reference system EPSG code. Only works when used in combination with MAP/ZOOMTOEXTENT, MAP/CENTER and MAPMARKER, the coordinates of the Parameters are transformed to the projection. If not set, projection of the map is used. Does not set the projection of the map. |
&projection=EPSG:4326 |
|
| MAP/PROJECTION | Coordinate reference system EPSG code. Only works when used in combination with MAP/ZOOMTOEXTENT, MAP/CENTER and MAPMARKER, the coordinates of the Parameters are transformed to the projection. If not set, projection of the map is used. Does not set the projection of the map. |
?Map/projection=EPSG:4326 |
|
| QUERY | Starts an address search via the search slot with any string given. House numbers must be given separated with a blank. | &query=Neuenfelder Straße 19 |
|
| SEARCH/QUERY | Starts an address search via the search slot with any string given. House numbers must be given separated with a blank. | ?Search/query=Neuenfelder Straße 19 |
|
| STARTUPMODUL | Deprecated in major release 3.0.0. Please use the parameter "TOOLS/[tool-id]/ACTIVE=TRUE" instead. |
?startupmodul=Draw |
|
| STYLE | Activates a special UI variant. E.g. simple may be set to hide all UI elements in an iFrame scenario. |
?style=simple |
|
| UISTYLE | Activates a special UI variant. E.g. simple may be set to hide all UI elements in an iFrame scenario. |
?uiStyle=simple |
|
| TILT | Only works when used in combination with MAP/MAPMODE. Sets the tilt in 3D mode. |
?Map/mapMode=3D&tilt=45 |
|
| TRANSPARENCY | Only works when used in combination with MAP/LAYERIDS. Transparency can be set separated by commas from 0 to 100; the transparency will be applied to the MAP/LAYERIDS layer of the same index. |
?Map/layerids=453,2128&transparency=0,40 |
|
| VISIBILITY | Only works when used in combination with MAP/LAYERIDS. Visibility can be set separated by commas as true or false; the visibility will be applied to the MAP/LAYERIDS layer of the same index. |
?Map/layerids=453,2128&visibility=true,false |
|
| ZOOMLEVEL | The initial zoom level is the given zoom level; see config.view.options. | ?zoomlevel=2 |
|
| MAP/ZOOMLEVEL | The initial zoom level is the given zoom level; see config.view.options. | ?Map/zoomLevel=7 |
|
| ZOOMTOEXTENT | Zooms to an extent. May be combined with projection. | ?zoomToExtent=510000,5850000,625000,6000000 |
|
| MAP/ZOOMTOEXTENT | Zooms to an extent. May be combined with projection. | ?Map/zoomToExtent=510000,5850000,625000,6000000 |
|
| ZOOMTOGEOMETRY | Zooms to a feature requested from a WFS. Allowed parameters depend on config.zoomToGeometry (Deprecated in the next major release. Please refer to config.zoomTo instead.). As an alternative to the feature name, features may also be addressed by their geometries array index, starting at 1. |
?zoomToGeometry=bergedorf |
|
| MAP/ZOOMTOGEOMETRY | Zooms to a feature requested from a WFS. Allowed parameters depend on config.zoomToGeometry (Deprecated in the next major release. Please refer to config.zoomTo instead.). As an alternative to the feature name, features may also be addressed by their geometries array index, starting at 1. |
?Map/zoomToGeometry=bergedorf |