Skip to content

Source: Added loading source doku and screenshots #552

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
momotosushi wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

Source: Added loading source doku and screenshots #552

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2066873
Source: Added loading source doku and screenshots
Sep 17, 2025
a9c5f8d
Described TMS accordingly and changes the link
Sep 18, 2025
07ed2e4
Added WMTS definition to the Doku
Sep 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
114 changes: 72 additions & 42 deletions de/backend/sources.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,57 +151,87 @@ WMS
WMTS/TMS
--------

* **type**: muss wmts oder tms sein
* **url**: URL zum GetCapabilities-XML des Dienstes. Beachten Sie, dass dieses Dokument für jede Seitenansicht heruntergeladen wird (anders als bei Datenbank-WMTS-Quellen, bei denen diese Informationen im Cache gespeichert werden)
* **title**: Der Titel der Quelle, wie er im Ebenenbaum angezeigt wird
* **basesource (alias: isBaseSource)**: Bool-Wert, ob die Quelle als Basisquelle behandelt werden soll
* **opacity**: int 0 (vollständig transparent)-100 (vollständig undurchsichtig)
* **selected (alias: visible)**: Anfangszustand der Wurzelebene. (Standard: true)
* **allowSelected**: Kann der Benutzer den Zustand der Wurzelebene im Ebenenbaum ändern? Wenn sowohl selected als auch allowSelected false sind, wird der Layer ignoriert. (Standard: true)
* **toggle**: Anfangszustand des Wurzelordners im Ebenenbaum (Standard: true = Ordner ist erweitert)
* **allowToggle**: Kann der Benutzer den Wurzelordner ein-/ausklappen? (Standard: true)
* **layers**: Optionales Objekt zur Anpassung einzelner Sublayer. Der Schlüssel sollte der Wert des <ows:Identifier>-Attributs im GetCapabilities-Dokument (für WMTS) oder der URL-Suffix des Layers für TMS sein. Beispiel: Wenn die URL des Capability-Dokuments https://osm-demo.wheregroup.com/tms/1.0.0/ ist und der href des Layers im TileMap-Tag als https://osm-demo.wheregroup.com/tms/1.0.0/osm/webmercator definiert ist, lautet der Layer-Schlüssel osm/webmercator.
* **title**: Der Titel des Layers, wie er im Ebenenbaum angezeigt wird
* **active**: Wenn false, wird der Layer ignoriert und steht in der Anwendung überhaupt nicht zur Verfügung (Standard: true)
* **selected (alias: visible)**: Anfangszustand des Layers. (Standard: true)
* **allowSelected**: Kann der Benutzer den Zustand im Ebenenbaum ändern? Wenn sowohl selected als auch allowSelected false sind, wird der Layer ignoriert, als ob active auf false gesetzt wäre. (Standard: true)
WMTS (Web Map Tile Service) und WMS (Web Map Service) sind standardisierte OGC-Dienste zur Bereitstellung von Rasterkartenbildern über das Internet, wobei WMTS Kacheln und WMS Einzelbilder auf Anfrage liefert.

Laden einer WMTS/TMS Quelle
+++++++++++++++++++++++++++

.. image:: ../../figures/de/mapbender_add_wmts_source.png
:width: 100%

* **Dienst-URL**: URL zum Capabilities-Dokument des Dienstes (z. B. für `OGC WMS Version 1.3.0 <https://osm-demo.wheregroup.com/service?SERVICE=WMS&Version=1.3.0&REQUEST=GetCapabilities>`_)

* **Benutzername / Passwort**: Eingabe von Benutzername und Passwort bei gesicherten Diensten.

YAML
++++

* **type**: muss wmts oder tms sein
* **url**: URL zum GetCapabilities-XML des Dienstes. Beachten Sie, dass dieses Dokument für jede Seitenansicht heruntergeladen wird (anders als bei Datenbank-WMTS-Quellen, bei denen diese Informationen im Cache gespeichert werden)
* **title**: Der Titel der Quelle, wie er im Ebenenbaum angezeigt wird
* **basesource (alias: isBaseSource)**: Bool-Wert, ob die Quelle als Basisquelle behandelt werden soll
* **opacity**: int 0 (vollständig transparent)-100 (vollständig undurchsichtig)
* **selected (alias: visible)**: Anfangszustand der Wurzelebene. (Standard: true)
* **allowSelected**: Kann der Benutzer den Zustand der Wurzelebene im Ebenenbaum ändern? Wenn sowohl selected als auch allowSelected false sind, wird der Layer ignoriert. (Standard: true)
* **toggle**: Anfangszustand des Wurzelordners im Ebenenbaum (Standard: true = Ordner ist erweitert)
* **allowToggle**: Kann der Benutzer den Wurzelordner ein-/ausklappen? (Standard: true)
* **layers**: Optionales Objekt zur Anpassung einzelner Sublayer. Der Schlüssel sollte der Wert des <ows:Identifier>-Attributs im GetCapabilities-Dokument (für WMTS) oder der URL-Suffix des Layers für TMS sein. Beispiel: Wenn die URL des Capability-Dokuments https://osm-demo.wheregroup.com/tms/1.0.0/ ist und der href des Layers im TileMap-Tag als https://osm-demo.wheregroup.com/tms/1.0.0/osm/webmercator definiert ist, lautet der Layer-Schlüssel osm/webmercator.
* **title**: Der Titel des Layers, wie er im Ebenenbaum angezeigt wird
* **active**: Wenn false, wird der Layer ignoriert und steht in der Anwendung überhaupt nicht zur Verfügung (Standard: true)
* **selected (alias: visible)**: Anfangszustand des Layers. (Standard: true)
* **allowSelected**: Kann der Benutzer den Zustand im Ebenenbaum ändern? Wenn sowohl selected als auch allowSelected false sind, wird der Layer ignoriert, als ob active auf false gesetzt wäre. (Standard: true)

Vector Tiles
------------

* **type**: muss vector_tiles sein
* **title**: Der Titel der Quelle, wie er im Ebenenbaum angezeigt wird
* **jsonUrl**: URL zur Mapbox Style Spec JSON-Datei
* **basesource (alias: isBaseSource)**: Bool-Wert, ob die Quelle als Basisquelle behandelt werden soll
* **opacity**: int 0 (vollständig transparent)-100 (vollständig undurchsichtig) (Standard: 100)
* **selected (alias: visible)**: Anfangszustand des Layers. (Standard: true)
* **allowSelected**: Kann der Benutzer den ausgewählten Zustand ändern? (Standard: true)
* **toggle**: Anfangszustand des Wurzelordners im Ebenenbaum (Standard: true = Ordner ist erweitert)
* **allowToggle**: Kann der Benutzer den Wurzelordner ein-/ausklappen? (Standard: true)
* **minScale**: Mindestmaßstab (1:x), bei dem die Quelle angezeigt wird (Standard: nicht gesetzt)
* **maxScale**: Höchstmaßstab (1:x), bei dem die Quelle angezeigt wird (Standard: nicht gesetzt)
* **featureInfo**: Ist FeatureInfo standardmäßig aktiviert? (Standard: true)
* **featureInfoAllowToggle**: Kann der Benutzer den FeatureInfo-Zustand umschalten? (Standard: true)
* **featureInfoPropertyMap**: Wenn nicht leer, werden nur die angegebenen Eigenschaften in der FeatureInfo angezeigt. Als YAML-Array angeben. Der Schlüssel ist der Name des Feldes, der optionale Wert ist die Übersetzung. Beispiel:
Vector Tiles sind ein Format zur Übertragung von geografischen Vektordaten in Kachelform, das eine flexible und performante Darstellung interaktiver Karten direkt im Browser ermöglicht.

Laden einer Vector Tiles Quelle
+++++++++++++++++++++++++++++++

.. image:: ../../figures/de/mapbender_add_vt_source.png
:width: 100%

* **URL zur JSON-Style-Definition**: URL zur Mapbox Style Spec JSON-Datei (z. B. https://sgx.geodatenzentrum.de/gdz_basemapde_vektor/styles/bm_web_col.json)

* **HTTP-Referer**: Einige Dienste erfordern einen bestimmten HTTP-Referer-Header, um Anfragen zu akzeptieren. Geben Sie hier die entsprechende URL ein, wenn der Dienst dies verlangt.

YAML
++++

* **type**: muss vector_tiles sein
* **title**: Der Titel der Quelle, wie er im Ebenenbaum angezeigt wird
* **jsonUrl**: URL zur Mapbox Style Spec JSON-Datei
* **basesource (alias: isBaseSource)**: Bool-Wert, ob die Quelle als Basisquelle behandelt werden soll
* **opacity**: int 0 (vollständig transparent)-100 (vollständig undurchsichtig) (Standard: 100)
* **selected (alias: visible)**: Anfangszustand des Layers. (Standard: true)
* **allowSelected**: Kann der Benutzer den ausgewählten Zustand ändern? (Standard: true)
* **toggle**: Anfangszustand des Wurzelordners im Ebenenbaum (Standard: true = Ordner ist erweitert)
* **allowToggle**: Kann der Benutzer den Wurzelordner ein-/ausklappen? (Standard: true)
* **minScale**: Mindestmaßstab (1:x), bei dem die Quelle angezeigt wird (Standard: nicht gesetzt)
* **maxScale**: Höchstmaßstab (1:x), bei dem die Quelle angezeigt wird (Standard: nicht gesetzt)
* **featureInfo**: Ist FeatureInfo standardmäßig aktiviert? (Standard: true)
* **featureInfoAllowToggle**: Kann der Benutzer den FeatureInfo-Zustand umschalten? (Standard: true)
* **featureInfoPropertyMap**: Wenn nicht leer, werden nur die angegebenen Eigenschaften in der FeatureInfo angezeigt. Als YAML-Array angeben. Der Schlüssel ist der Name des Feldes, der optionale Wert ist die Übersetzung. Beispiel:

.. code-block:: yaml
.. code-block:: yaml

class
name
layer: Layer-Name
class
name
layer: Layer-Name


* **hideIfNoTitle**: Verstecke Features mit leerem Titel in der FeatureInfo (Standard: true)
* **featureInfoTitle**: Eigenschaft/Eigenschaften des Features, die als Titel über der Tabelle angezeigt werden. ${property} wird durch den Wert der Eigenschaft ersetzt. Wenn nicht angegeben, wird der erste nicht-leere Wert aus "label", "name" und "title" verwendet.
* **printScaleCorrection**: Auflösungskorrektur für den Druck. Standardwert ist 1.0. Höhere Werte führen zu mehr Details und kleineren Beschriftungen; niedrigere Werte zu weniger Details und größeren Beschriftungen.
* **legendEnabled (alias: legend)**: Soll eine Legende für diese Quelle angezeigt werden? (Standard: false)
* **legendPropertyMap**: Wenn nicht leer, werden nur die angegebenen Layer in der Legende angezeigt. Als YAML-Array angeben. Der Schlüssel ist die Layer-ID aus dem "layers"-Feld im Style-JSON; der optionale Wert ist die Übersetzung. Beispiel:
* **hideIfNoTitle**: Verstecke Features mit leerem Titel in der FeatureInfo (Standard: true)
* **featureInfoTitle**: Eigenschaft/Eigenschaften des Features, die als Titel über der Tabelle angezeigt werden. ${property} wird durch den Wert der Eigenschaft ersetzt. Wenn nicht angegeben, wird der erste nicht-leere Wert aus "label", "name" und "title" verwendet.
* **printScaleCorrection**: Auflösungskorrektur für den Druck. Standardwert ist 1.0. Höhere Werte führen zu mehr Details und kleineren Beschriftungen; niedrigere Werte zu weniger Details und größeren Beschriftungen.
* **legendEnabled (alias: legend)**: Soll eine Legende für diese Quelle angezeigt werden? (Standard: false)
* **legendPropertyMap**: Wenn nicht leer, werden nur die angegebenen Layer in der Legende angezeigt. Als YAML-Array angeben. Der Schlüssel ist die Layer-ID aus dem "layers"-Feld im Style-JSON; der optionale Wert ist die Übersetzung. Beispiel:

.. code-block:: yaml
.. code-block:: yaml

Stadt
Stationen
Verkehr: Öffentlicher Verkehr
Stadt
Stationen
Verkehr: Öffentlicher Verkehr

* **bbox**: Begrenzungsrahmen (Array xmin, ymin, xmax, ymax) für die Quelle
* **bbox**: Begrenzungsrahmen (Array xmin, ymin, xmax, ymax) für die Quelle

114 changes: 72 additions & 42 deletions en/backend/sources.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,56 +154,86 @@ WMS
WMTS/TMS
--------

* **type**: must be wmts or tms
* **url**: URL to the service's Get capability XML. Note that to obtain the TileMatrices this document will be downloaded for every page view (unlike for database WMTS sources, where this information is cached in the database)
* **title**: The source title as displayed in the layer tree
* **basesource (alias: isBaseSource)**: boolean value if the source should be treated as a base source
* **opacity**: int 0 (fully transparent)-100 (fully opaque)
* **selected (alias: visible)**: initial selected state of the root layer. (default: true)
* **allowSelected**: can the user change state of the root layer in the layertree? If selected and allowSelected are both false, the layer is ignored. (default: true)
* **toggle**: initial folder state of the root layer in the layer tree (default: true = folder is expanded)
* **allowToggle**: can the user collapse/expand the root layer? (default: true)
* **layers**: optional object to modify individual sublayers. The key should be the value of the <ows:Identifier> attribute in the GetCapabilities document (for WMTS) or the url suffix of the layer for TMS. For example, if The URL of the Capability document is https://osm-demo.wheregroup.com/tms/1.0.0/ and the layer's href in the TileMap tag is defined as https://osm-demo.wheregroup.com/tms/1.0.0/osm/webmercator, the layer key will be osm/webmercator.
WMTS (Web Map Tile Service) and TMS (Tile Map Service) are standardized OGC services for providing raster map images over the internet, with WMTS delivering tiles and TMS delivering single images on request.

Loading WMTS/TMS Source
+++++++++++++++++++++++

.. image:: ../../figures/mapbender_add_wmts_source.png
:width: 100%

* **Service URL**: URL to the Capabilities document of the service (e.g. `OGC WMS Version 1.3.0: <https://osm-demo.wheregroup.com/service?SERVICE=WMS&Version=1.3.0&REQUEST=GetCapabilities>`_)

* **Username / Password**: Input of the username and the password for secured services.

YAML
++++

* **type**: must be wmts or tms
* **url**: URL to the service's Get capability XML. Note that to obtain the TileMatrices this document will be downloaded for every page view (unlike for database WMTS sources, where this information is cached in the database)
* **title**: The source title as displayed in the layer tree
* **basesource (alias: isBaseSource)**: boolean value if the source should be treated as a base source
* **opacity**: int 0 (fully transparent)-100 (fully opaque)
* **selected (alias: visible)**: initial selected state of the root layer. (default: true)
* **allowSelected**: can the user change state of the root layer in the layertree? If selected and allowSelected are both false, the layer is ignored. (default: true)
* **toggle**: initial folder state of the root layer in the layer tree (default: true = folder is expanded)
* **allowToggle**: can the user collapse/expand the root layer? (default: true)
* **layers**: optional object to modify individual sublayers. The key should be the value of the <ows:Identifier> attribute in the GetCapabilities document (for WMTS) or the url suffix of the layer for TMS. For example, if The URL of the Capability document is https://osm-demo.wheregroup.com/tms/1.0.0/ and the layer's href in the TileMap tag is defined as https://osm-demo.wheregroup.com/tms/1.0.0/osm/webmercator, the layer key will be osm/webmercator.

* **title**: The layer title as displayed in the layer tree
* **active**: if false, the layer is ignored and won't be available in the application at all (default: true)
* **selected (alias: visible)**: initial selected state of the layer. (default: true)
* **allowSelected**: can the user change state in the layertree? If selected and allowSelected are both false, the layer is ignored, as if active was set to false. (default: true)
* **title**: The layer title as displayed in the layer tree
* **active**: if false, the layer is ignored and won't be available in the application at all (default: true)
* **selected (alias: visible)**: initial selected state of the layer. (default: true)
* **allowSelected**: can the user change state in the layertree? If selected and allowSelected are both false, the layer is ignored, as if active was set to false. (default: true)

Vector Tiles
------------

* **type**: must be vector_tiles
* **title**: The source title as displayed in the layer tree
* **jsonUrl**: URL to the Mapbox Style Spec JSON file
* **basesource (alias: isBaseSource)**: boolean value if the source should be treated as a base source
* **opacity**: int 0 (fully transparent)-100 (fully opaque) (default: 100)
* **selected (alias: visible)**: initial selected state of the layer. (default: true)
* **allowSelected**: can the user change the selected state? (default: true)
* **toggle**: initial folder state of the root layer in the layer tree (default: true = folder is expanded)
* **allowToggle**: can the user collapse/expand the root layer? (default: true)
* **minScale**: minimum scale (1:x) where the source is displayed (default: unset)
* **maxScale**: maximum scale (1:x) where the source is displayed (default: unset)
* **featureInfo**: is featureinfo enabled by default? (default: true)
* **featureInfoAllowToggle**: can the user toggle the feature info state? (default: true)
* **featureInfoPropertyMap**: If not empty, only the specified properties will be displayed in the feature info. Specify as YAML array. The key is the name of the field, the optional value is the translation. Example:
Vector Tiles are a format for transmitting geographic vector data in tile form, enabling flexible and performant rendering of interactive maps directly in the browser.

Loading Vector Tiles Source
+++++++++++++++++++++++++++

.. image:: ../../figures/mapbender_add_vt_source.png
:width: 100%

* **Service URL**: URL to the Capabilities document of the service (e.g. https://sgx.geodatenzentrum.de/gdz_basemapde_vektor/styles/bm_web_col.json)

* **HTTP Referer**: Some services require a specific HTTP referer header to accept requests. If the service demands this, please enter the corresponding URL here.

YAML
++++

* **type**: must be vector_tiles
* **title**: The source title as displayed in the layer tree
* **jsonUrl**: URL to the Mapbox Style Spec JSON file
* **basesource (alias: isBaseSource)**: boolean value if the source should be treated as a base source
* **opacity**: int 0 (fully transparent)-100 (fully opaque) (default: 100)
* **selected (alias: visible)**: initial selected state of the layer. (default: true)
* **allowSelected**: can the user change the selected state? (default: true)
* **toggle**: initial folder state of the root layer in the layer tree (default: true = folder is expanded)
* **allowToggle**: can the user collapse/expand the root layer? (default: true)
* **minScale**: minimum scale (1:x) where the source is displayed (default: unset)
* **maxScale**: maximum scale (1:x) where the source is displayed (default: unset)
* **featureInfo**: is featureinfo enabled by default? (default: true)
* **featureInfoAllowToggle**: can the user toggle the feature info state? (default: true)
* **featureInfoPropertyMap**: If not empty, only the specified properties will be displayed in the feature info. Specify as YAML array. The key is the name of the field, the optional value is the translation. Example:

.. code-block:: yaml
.. code-block:: yaml

class
name
layer: Layer-Name
class
name
layer: Layer-Name

* **hideIfNoTitle**: Hide features with empty title in the featureInfo (default: true)
* **featureInfoTitle**: Property/Properties of the feature that is/are displayed as title above the table. ${property} will be replaced by the property's value. If not specified, the first non-empty value from "label", "name", and "title" will be used.
* **printScaleCorrection**: Resolution correction for printing. Default value is 1.0. Higher values result in more details and smaller labels; lower values in less details and larger labels.
* **legendEnabled (alias: legend)**: should a legend be displayed for this source? (default: false)
* **legendPropertyMap**: If not empty, only the specified layers will be shown in the legend. Specify as a YAML array. The key is the layer ID from the "layers" field in the style JSON; the optional value is the translation. Example:
* **hideIfNoTitle**: Hide features with empty title in the featureInfo (default: true)
* **featureInfoTitle**: Property/Properties of the feature that is/are displayed as title above the table. ${property} will be replaced by the property's value. If not specified, the first non-empty value from "label", "name", and "title" will be used.
* **printScaleCorrection**: Resolution correction for printing. Default value is 1.0. Higher values result in more details and smaller labels; lower values in less details and larger labels.
* **legendEnabled (alias: legend)**: should a legend be displayed for this source? (default: false)
* **legendPropertyMap**: If not empty, only the specified layers will be shown in the legend. Specify as a YAML array. The key is the layer ID from the "layers" field in the style JSON; the optional value is the translation. Example:

.. code-block:: yaml
.. code-block:: yaml

City
Stations
Transport: Public Transport
City
Stations
Transport: Public Transport

* **bbox**: Bounding box (array xmin, ymin, xmax, ymax) for the source
* **bbox**: Bounding box (array xmin, ymin, xmax, ymax) for the source
Binary file added figures/de/mapbender_add_vt_source.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added figures/de/mapbender_add_wmts_source.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added figures/mapbender_add_vt_source.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added figures/mapbender_add_wmts_source.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.