Module: stma_openlayers

Methods

(inner) addEsriLayer(_url, _layerParams, _sourceParams, _callbackFunction) → {null}

fügt einen Kartendienst eines ArcGIS Servers (dynamisch / gecacht) hinzu.
Wenn nichts anderes angegeben ist, dann gelten folgende zIndexe für die Kartendienste:
  • 10: gecacht
  • 20: gecacht - Kartendienst des Stadtmessungsamtes
  • 40: dynamisch
  • 50: dynamisch - Kartendienst des Stadtmessungsamtes
Beispiel:
mymap.addEsriLayer("https://server.arcgisonline.com/arcgis/rest/services/World_Topo_Map/MapServer");
Parameters:
Name Type Description
_url String URL des Kartendienstes Kartendienste des Stadtmessungsamtes sollten über die Funktion addStmaEsriLayer hinzugefügt werden.
_layerParams object zusätzliche Parameter für das OpenLayer-Layer-Objekt
Siehe https://openlayers.org/en/v6.3.1/apidoc/module-ol_layer_Layer-Layer.html
_sourceParams object zusätzliche Parameter für das OpenLayer-Source-Objekt
Siehe https://openlayers.org/en/v6.3.1/apidoc/module-ol_source_Source-Source.html
_callbackFunction function Möglichkeit, eine Funktion zu übergeben, die nach dem Hinzufügen des Layers ausgeführt wird.
Der Funktion wird das jeweilige Layerobjekt übergeben.
Since:
  • v0.0
Returns:
-
Type
null

(inner) addGeoJSON(_geojson, _style, _callbackFunction) → {null}

fügt Objekte aus einem geoJSON hinzu. Beispiel: mymap.addGeoJSON(_geojson);
Parameters:
Name Type Description
_geojson object GeoJSON-Objekt
_style object (optional) Ausprägungs-Details
Siehe https://openlayers.org/en/v6.3.1/apidoc/module-ol_style_Style-Style.html
_callbackFunction function Möglichkeit, eine Funktion zu übergeben, die nach dem Hinzufügen des Layers ausgeführt wird. Der Funktion wird das jeweilige Layerobjekt übergeben.
Since:
  • v2.0
Returns:
-
Type
null

(inner) addGeoJSONfromURL(_url, _style, _callbackFunction) → {null}

fügt Objekte aus einem geoJSON hinzu. Das geoJSON ist über eine URL erreichbar.
Beispiel: mymap.addGeoJSONfromURL("examples/example.geojson");
Parameters:
Name Type Description
_url String URL zur geoJSON-Datei
_style object (optional) Ausprägungs-Details
Siehe https://openlayers.org/en/v6.3.1/apidoc/module-ol_style_Style-Style.html
_callbackFunction function Möglichkeit, eine Funktion zu übergeben, die nach dem Hinzufügen des Layers ausgeführt wird. Der Funktion wird das jeweilige Layerobjekt übergeben. Der Funktion wird false übergeben, wenn das GeoJSON nicht abgerufen werden konnte.
Since:
  • v2.0
Returns:
-
Type
null

(inner) addOverlayForLayer(_layer, _overlayFunction) → {null}

Bietet die Möglichkeit an für einen Layer ein Overlay hinzuzufügen. Beispiel: mymap.addOverlayForLayer(_layer, _overlayFunction);
Parameters:
Name Type Description
_layer object Das Layerobjekt
_overlayFunction function Funktion, die bei einem Klick auf das Objekt ausgeführt wird. Die Funktion muss den HTML-Inhalt für ein Overlay-Fenster zurückgeben.
Since:
  • v1.2
Returns:
-
Type
null

(inner) addPoints(_pointCoords, _imageURL, _callbackFunction) → {null}

fügt einzelne Punkte hinzu.
Wenn nichts anderes angegeben ist, dann gilt der zIndex 60.
Beispiel:
mymap.addPoints([[3513223, 5405026]], "images/target.png");
Parameters:
Name Type Description
_pointCoords Array Array von Koordinatenpaaren
[ [x,y], [x,y], ... ]
_imageURL String URL zu dem Bild des Punktes / Data-URL des Bildes
_callbackFunction function Möglichkeit, eine Funktion zu übergeben, die nach dem Hinzufügen des Layers ausgeführt wird. Der Funktion wird das jeweilige Layerobjekt übergeben.
Since:
  • v0.0
Returns:
-
Type
null

(inner) addStmaBaseLayer(_mapname, _layerParams, _sourceParams, _callbackFunction) → {null}

fügt einen Basis-Kartendienst (dynamisch / gecacht) des Stadtmessungsamtes hinzu.
Wenn nichts anderes angegeben ist, dann gelten folgende zIndexe für die Kartendienste:
  • 10: gecacht
  • 20: gecacht - Kartendienst des Stadtmessungsamtes
  • 40: dynamisch
  • 50: dynamisch - Kartendienst des Stadtmessungsamtes
Beispiel:
mymap.addStmaBaseLayer("Grundkarte");
mymap.addStmaBaseLayer("Luftbild");
Parameters:
Name Type Description
_mapname String sprechende Bezeichnung des Kartendienstes Für ausgewählte Basiskartendienste kann hierüber über eine sprechende Bezeichnung der Kartendienst hinzugefügt werden. Eventuelle Kartendienstnamenänderungen werden automatisch von der API berücksichtigt. Deswegen sollten die Basiskarten (Grundkarte, Luftbild, ..) immer über diese Funktion eingebundne werden.
_layerParams object zusätzliche Parameter für das OpenLayer-Layer-Objekt
Siehe https://openlayers.org/en/v6.3.1/apidoc/module-ol_layer_Layer-Layer.html
_sourceParams object zusätzliche Parameter für das OpenLayer-Source-Objekt
Siehe https://openlayers.org/en/v6.3.1/apidoc/module-ol_source_Source-Source.html
_callbackFunction function Möglichkeit, eine Funktion zu übergeben, die nach dem Hinzufügen des Layers ausgeführt wird. Der Funktion wird das jeweilige Layerobjekt übergeben.
Since:
  • v0.0
Returns:
-
Type
null

(inner) addStmaEsriFeatureLayer(_mapservice, _layerId, _styleFunction, _callbackFunction) → {null}

fügt einen Kartendienst eines ArcGIS Servers (dynamisch / gecacht) des Stadtmessungsamtes hinzu. Wenn nichts anderes angegeben ist, dann gelten folgende zIndexe für die Kartendienste:
  • 10: gecacht
  • 20: gecacht - Kartendienst des Stadtmessungsamtes
  • 40: dynamisch
  • 50: dynamisch - Kartendienst des Stadtmessungsamtes
Beispiel:
mymap.addStmaEsriFeatureLayer("1_Base/Stadtkarte_Internet_c");
Parameters:
Name Type Description
_mapservice String Bezeichnung des Kartendienstes Wenn die URL des Kartendienstes beispielsweise https://SERVER/ArcGIS/rest/services/ORDNER/KARTENDIENST/MapServer heißt, so sollte ORDNER/KARTENDIENST angegeben werden.
_layerId Integer LayerId im Kartendienst Wenn die URL des Kartendienstes beispielsweise https://SERVER/ArcGIS/rest/services/ORDNER/KARTENDIENST/MapServer/LAYERID heißt, so sollte LAYERID angegeben werden.
_styleFunction function Funktion, wie die Objekte aussehen sollen. Der Funktion wird als 1. Parameter das feature-Objekt (ol.Feature) übergeben. Mit Hilfe von z.B. feature.get('activeprod') könnte dann der Inhalt des Attributes 'activeprod' abgerufen werden und in Abhängigkeit von ihm unterschiedliche Stile angegeben werden. Rückgabe der Funktion muss ein ol.style.Style-Objekt sein.
Siehe https://openlayers.org/en/v6.3.1/apidoc/module-ol_style_Style-Style.html
_callbackFunction function Möglichkeit, eine Funktion zu übergeben, die nach dem Hinzufügen des Layers ausgeführt wird. Der Funktion wird das jeweilige Layerobjekt übergeben.
Since:
  • v0.86
Returns:
-
Type
null

(inner) addStmaEsriLayer(_mapservice, _layerParams, _sourceParams, _callbackFunction) → {null}

fügt einen Kartendienst eines ArcGIS Servers (dynamisch / gecacht) des Stadtmessungsamtes hinzu.
Wenn nichts anderes angegeben ist, dann gelten folgende zIndexe für die Kartendienste:
  • 10: gecacht
  • 20: gecacht - Kartendienst des Stadtmessungsamtes
  • 40: dynamisch
  • 50: dynamisch - Kartendienst des Stadtmessungsamtes
Beispiel:
mymap.addStmaEsriLayer("1_Base/Stadtkarte_Internet_c");
Parameters:
Name Type Description
_mapservice String Bezeichnung des Kartendienstes Wenn die URL des Kartendienstes beispielsweise https://SERVER/ArcGIS/rest/services/ORDNER/KARTENDIENST/MapServer heißt, so sollte ORDNER/KARTENDIENST angegeben werden.
_layerParams object zusätzliche Parameter für das OpenLayer-Layer-Objekt
Siehe https://openlayers.org/en/v6.3.1/apidoc/module-ol_layer_Layer-Layer.html
_sourceParams object zusätzliche Parameter für das OpenLayer-Source-Objekt
Siehe https://openlayers.org/en/v6.3.1/apidoc/module-ol_source_Source-Source.html
_callbackFunction function Möglichkeit, eine Funktion zu übergeben, die nach dem Hinzufügen des Layers ausgeführt wird. Der Funktion wird das jeweilige Layerobjekt übergeben.
Since:
  • v0.0
Returns:
-
Type
null

(inner) addStmaWMSLayer(_layerName, _layerParams, _sourceParams, _callbackFunction) → {null}

fügt einen dynamischen WMS-Kartendienst des Stadtmessungsamtes hinzu.
Wenn nichts anderes angegeben ist, dann gelten folgende zIndexe für die Kartendienste:
  • 10: gecacht
  • 20: gecacht - Kartendienst des Stadtmessungsamtes
  • 40: dynamisch
  • 50: dynamisch - Kartendienst des Stadtmessungsamtes
Beispiel:
mymap.addStmaWMSLayer("LAYERNAME");

Der Layer kann gekachelt oder als ganzes Bild abgerufen werden. Standard ist der Abruf als ganzes Bild, da aber einige WMS-Dienste keine großen Bilder auf einmal zurückgeben können, kann der WMS auch gekachelt abgerufen werden. Dies kann zu Lasten der Kartographie gehen - so kann es passieren, dass Beschriftungen abgeschnitten oder mehrfach im Kartenbild enthalten sind.
Standardmäßig wird der WMS-Dienst als dynamischer Dienst behandelt, wenn der als gekachelter Dienst eingebunden wird, wird er als gecachter Dienst behandelt (wichtig für die zIndexe der Kartendienste) Zum gekachelten Abruf muss als _sourceParams { "TILED": true } übergeben werden.
Beispiel:
mymap.addStmaWMSLayer("LAYERNAME", {}, { "TILED": true });
Parameters:
Name Type Description
_layerName String Layername Name des Layers, der eingebunden werden soll
_layerParams object zusätzliche Parameter für das OpenLayer-Layer-Objekt
Siehe https://openlayers.org/en/v6.5.0/apidoc/module-ol_layer_Layer-Layer.html
_sourceParams object zusätzliche Parameter für das OpenLayer-Source-Objekt
Siehe https://openlayers.org/en/v6.5.0/apidoc/module-ol_source_Source-Source.html
_callbackFunction function Möglichkeit, eine Funktion zu übergeben, die nach dem Hinzufügen des Layers ausgeführt wird.
Der Funktion wird das jeweilige Layerobjekt übergeben.
Since:
  • v2.1
Returns:
-
Type
null

(inner) addStmaWMTSLayer(_layerName, _layerParams, _sourceParams, _callbackFunction) → {null}

fügt einen gecachten WMTS-Kartendienst des Stadtmessungsamtes hinzu.
Wenn nichts anderes angegeben ist, dann gelten folgende zIndexe für die Kartendienste:
  • 10: gecacht
  • 20: gecacht - Kartendienst des Stadtmessungsamtes
  • 40: dynamisch
  • 50: dynamisch - Kartendienst des Stadtmessungsamtes
Beispiel:
mymap.addStmaWMTSLayer("LAYERNAME");
Parameters:
Name Type Description
_layerName String Layername Name des Layers, der eingebunden werden soll
_layerParams object zusätzliche Parameter für das OpenLayer-Layer-Objekt
Siehe https://openlayers.org/en/v6.5.0/apidoc/module-ol_layer_Layer-Layer.html
_sourceParams object zusätzliche Parameter für das OpenLayer-Source-Objekt
Siehe https://openlayers.org/en/v6.5.0/apidoc/module-ol_source_Source-Source.html
_callbackFunction function Möglichkeit, eine Funktion zu übergeben, die nach dem Hinzufügen des Layers ausgeführt wird.
Der Funktion wird das jeweilige Layerobjekt übergeben.
Since:
  • v2.1
Returns:
-
Type
null

(inner) addWMSLayer(_url, _layerName, _layerParams, _sourceParams, _callbackFunction) → {null}

fügt einen dynamischen WMS-Kartendienst hinzu.
Wenn nichts anderes angegeben ist, dann gelten folgende zIndexe für die Kartendienste:
  • 10: gecacht
  • 20: gecacht - Kartendienst des Stadtmessungsamtes
  • 40: dynamisch
  • 50: dynamisch - Kartendienst des Stadtmessungsamtes
Beispiel:
mymap.addWMSLayer("https://SERVERNAME/INSTANZ/gwc/service/wms", "LAYERNAME");

Der Layer kann gekachelt oder als ganzes Bild abgerufen werden. Standard ist der Abruf als ganzes Bild, da aber einige WMS-Dienste keine großen Bilder auf einmal zurückgeben können, kann der WMS auch gekachelt abgerufen werden. Dies kann zu Lasten der Kartographie gehen - so kann es passieren, dass Beschriftungen abgeschnitten oder mehrfach im Kartenbild enthalten sind.
Standardmäßig wird der WMS-Dienst als dynamischer Dienst behandelt, wenn der als gekachelter Dienst eingebunden wird, wird er als gecachter Dienst behandelt (wichtig für die zIndexe der Kartendienste) Zum gekachelten Abruf muss als _sourceParams { "TILED": true } übergeben werden.
Beispiel:
mymap.addWMSLayer("https://SERVERNAME/INSTANZ/gwc/service/wms", "LAYERNAME", {}, { "TILED": true });
Parameters:
Name Type Description
_url String URL zum WMS Kartendienste des Stadtmessungsamtes sollten über die Funktion addStmaWMSLayer hinzugefügt werden.
_layerName String Layername Name des Layers, der eingebunden werden soll
_layerParams object zusätzliche Parameter für das OpenLayer-Layer-Objekt
Siehe https://openlayers.org/en/v6.5.0/apidoc/module-ol_layer_Layer-Layer.html
_sourceParams object zusätzliche Parameter für das OpenLayer-Source-Objekt
Siehe https://openlayers.org/en/v6.5.0/apidoc/module-ol_source_Source-Source.html
_callbackFunction function Möglichkeit, eine Funktion zu übergeben, die nach dem Hinzufügen des Layers ausgeführt wird.
Der Funktion wird das jeweilige Layerobjekt übergeben.
Since:
  • v2.1
Returns:
-
Type
null

(inner) addWMTSLayer(_url, _layerName, _layerParams, _sourceParams, _callbackFunction) → {null}

fügt einen gecachten WMTS-Kartendienst hinzu.
Wenn nichts anderes angegeben ist, dann gelten folgende zIndexe für die Kartendienste:
  • 10: gecacht
  • 20: gecacht - Kartendienst des Stadtmessungsamtes
  • 40: dynamisch
  • 50: dynamisch - Kartendienst des Stadtmessungsamtes
Beispiel:
mymap.addWMTSLayer("https://SERVERNAME/INSTANZ/gwc/service/wmts?REQUEST=GetCapabilities", "LAYERNAME");
Parameters:
Name Type Description
_url String GetCapabilities-URL zum WMTS Kartendienste des Stadtmessungsamtes sollten über die Funktion addStmaWMTSLayer hinzugefügt werden.
_layerName String Layername Name des Layers, der eingebunden werden soll
_layerParams object zusätzliche Parameter für das OpenLayer-Layer-Objekt
Siehe https://openlayers.org/en/v6.5.0/apidoc/module-ol_layer_Layer-Layer.html
_sourceParams object zusätzliche Parameter für das OpenLayer-Source-Objekt
Siehe https://openlayers.org/en/v6.5.0/apidoc/module-ol_source_Source-Source.html
_callbackFunction function Möglichkeit, eine Funktion zu übergeben, die nach dem Hinzufügen des Layers ausgeführt wird.
Der Funktion wird das jeweilige Layerobjekt übergeben.
Since:
  • v2.1
Returns:
-
Type
null

(inner) getConfig() → {object}

gibt die interne Konfiguration von geoline.ol.js zurück.
Diese Funktion sollte nur sparsam genutzt werden, zum Beispiel zum Ermitteln der Konfiguration für die Offlineverfügbarkeit in Apps.
Since:
  • v1.0
Returns:
Type
object

(inner) getMap() → {object}

gibt das OpenLayer-Map-Objekt zurück.
Siehe https://openlayers.org/en/v6.3.1/apidoc/module-ol_Map-Map.html
Since:
  • v0.0
Returns:
ol.Map
Siehe https://openlayers.org/en/v6.3.1/apidoc/module-ol_Map-Map.html
Type
object

(inner) initMap(_epsgCode, _mapParams, _viewParams, _customParams) → {null}

initialisiert die Karte
Beispiel:
mymap = new stma_openlayers();
mymap.initMap(25832, {}, {});
Parameters:
Name Type Description
_epsgCode int EPSG-Code des Koordinatensystems. Unterstütze Werte sind: 25832, 3857
Siehe auch: https://epsg.io/25832, http://epsg.io/3857
_mapParams object zusätzliche Parameter für das OpenLayer-Map-Objekt
Siehe https://openlayers.org/en/v6.3.1/apidoc/module-ol_Map-Map.html
_viewParams object zusätzliche Parameter für das OpenLayer-View-Objekt
Siehe https://openlayers.org/en/v6.3.1/apidoc/module-ol_View-View.html
_customParams object zusätzliche Parameter für geoline.ol.js
Unterstützte Parameter:
  • tileLoadFunction: Optionale Funktion, die bei gecachten Kartendiensten ausgeführt wird, um eine Kachel zu laden.
    Beispiel:
    { tileLoadFunction: function(imageTile, src) { imageTile.getImage().src = src;}}
    Siehe https://openlayers.org/en/v6.3.1/apidoc/module-ol_source_XYZ-XYZ.html
  • config: Hier kann das Konfigurationsobjekt, das normalerweise direkt vom Server des Stadtmessungsamtes geladen wird überschrieben werden.
    Diese Funktion sollte nur sparsam genutzt werden, zum Beispiel für die Offlineverfügbarkeit in Apps.
    Wird diese Funktion verwendet, so muss sichergestellt werden, dass die übergebene Konfiguration aktuell ist.
Since:
  • v0.0
Returns:
-
Type
null

(inner) stma_openlayers() → {null}

Momentan ist OpenLayers 6.3.1 eingebunden.
Since:
  • v0.0
Returns:
-
Type
null