Class: map

Core map

map

new map(mapViewSettings)

modules/core/map.js, line 85
todo
Name Type Description
mapViewSettings Object Settings for the map.
Properties:
Name Type Default Description
initalLoading Number 0 todo
Fires:
Listens to Events:

Extends

Methods

addControl(control){void}

modules/core/map.js, line 436
Adds a control to the map.
Name Type Description
control * Control to be added.

addInteraction(interaction){void}

modules/core/map.js, line 392
Adds an interaction to the map.
Name Type Description
interaction * Interaction to be added.

addLayerOnTop(layer){void}

modules/core/map.js, line 454
Put the layer on top of the map.
Name Type Description
layer ol/layer To be placed on top of the map.

addLayerToIndex(args){void}

modules/core/map.js, line 472
Moves the layer on the map to the intended position.
Name Type Description
args Array [0] = Layer, [1] = Index

addLoadingLayer(){void}

modules/core/map.js, line 650
todo

addMarker(event){void}

modules/core/map.js, line 227
Function is registered as an event listener if the config-parameter "inputMap" is present and always sets a mapMarker at the clicked position without activating it. Also triggers the RemoteInterface with the marker coordinates.
Name Type Description
event event The MapBrowserPointerEvent
Fires:

addOverlay(overlay){void}

modules/core/map.js, line 410
Adds an ovleray to the map.
Name Type Description
overlay * Overlay to be added.

addProjectionAliases(projections){void}

modules/core/map.js, line 202
Register aliases for available projections. This is necessary for several WFS that use the http://www.opengis.net/gml/srs/epsg.xml# as srs identifier
Name Type Description
projections String projections

bBoxToMap(bbox){void}

modules/core/map.js, line 300
todo
Name Type Description
bbox * todo

calculateExtent(features){*}

modules/core/map.js, line 620
todo
Name Type Description
features * todo

createLayerIfNotExists(name){*}

modules/core/map.js, line 690
Checks if the layer with the name "Name" already exists and uses it, if not, creates a new layer.
Name Type Description
name * todo
Fires:

getFeaturesAtPixel(pixel, options){Array.<features>}

modules/core/map.js, line 367
Return features at a pixel coordinate
Name Type Description
pixel pixel Pixelcoordinate
options object layerDefinition and pixelTolerance
Returns:
Array with features

getLayerByName(layerName){ol.layer}

modules/core/map.js, line 252
Finds a layer by its name and returns it.
Name Type Description
layerName string Name of the Layers
Returns:
found layer

getLayers(){*}

modules/core/map.js, line 273
Getter for Layers from the map.
Returns:
from the map

getMapMode(){String}

modules/core/map.js, line 375
Returns the mapmode. Oblique, 3D and 2D are available for selection.

getOverlayById(id){ol.Overlay}

modules/core/map.js, line 723
gets an overlay by its identifier
Name Type Description
id string | number identifier
Returns:
overlay

getResolutionForScale(scale, units){Number}

modules/core/map.js, line 768
Gets the resolution for a given scale Code taken from https://github.com/terrestris/ol-util/blob/8284a4d984bb429d8283c9b5d4bc802d67b4a6f7/src/MapUtil/MapUtil.js#L88
Name Type Description
scale Number scale to derive resolution from
units String Unit of measurement "m" or "degrees"
Returns:
resolution for a given scale

getScaleForResolution(resolution, units){Number}

modules/core/map.js, line 786
Gets the scale for a given resolution Code taken from https://github.com/terrestris/ol-util/blob/8284a4d984bb429d8283c9b5d4bc802d67b4a6f7/src/MapUtil/MapUtil.js#L105
Name Type Description
resolution Number resolution to derive scale from
units String Unit of measurement "m" or "degrees"
Returns:
scale for a given resolution

getSize(){ol.Size}

modules/core/map.js, line 642
Returns the size in pixels of the map.
Returns:
array of two numbers [width, height].

getWGS84MapSizeBBOX(){*}

modules/core/map.js, line 310
todo

getWGS84MapSizeBBOXFromEPSG25833(){*}

modules/core/map.js, line 323
todo

initalLoadingChanged(){void}

modules/core/map.js, line 669
Initial loading. "initalLoading" is incremented across layers if several tiles are loaded and incremented again if the tiles are loaded. Listener is then stopped so that the loader is only displayed during initial loading - not when zoom/pan is selected. [...]
Fires:

registerListener(event, callback, context){*}

modules/core/map.js, line 341
Registered listener for certain events on the map. See http://openlayers.org/en/latest/apidoc/ol.Map.html
Name Type Description
event String The Eventtype.
callback function The Callback function.
context Object todo

removeControl(control){void}

modules/core/map.js, line 445
Removes a control from the map.
Name Type Description
control * Control to be removed.

removeInteraction(interaction){void}

modules/core/map.js, line 401
Removes an interaction from the map.
Name Type Description
interaction * Interaction to be remove.

removeLayer(layer){void}

modules/core/map.js, line 463
Removes a layler from the map.
Name Type Description
layer * - Layer to be removed.

removeLoadingLayer(){void}

modules/core/map.js, line 658
todo

removeOverlay(overlay){void}

modules/core/map.js, line 419
Removes an overlay from the map.
Name Type Description
overlay * Overlay to be removed.

removeOverlays(){void}

modules/core/map.js, line 427
Removes all overlays from the map.

render(){void}

modules/core/map.js, line 281
Render the map

setBBox(bbox){void}

modules/core/map.js, line 290
Sets the bounding box for the map.
Name Type Description
bbox * todo

setImportDrawMeasureLayersOnTop(layers){void}

modules/core/map.js, line 551
Pushes 'alwaysOnTop' layers to the top of the collection.
Name Type Description
layers ol.Collection Layer Collection.

setLayerToIndex(layer, index){void}

modules/core/map.js, line 535
Sets an already inserted ol.layer to the defined index using openlayers setZIndex method
Name Type Default Description
layer ol.Layer Layer to set.
index integer 0 optional New Index.

setMap(value){void}

modules/core/map.js, line 754
Setter for the map.
Name Type Description
value ol/map The map.

setVectorLayer(value){void}

modules/core/map.js, line 265
Setter for vectorLayer.
Name Type Description
value * todo

showMouseMoveText(){void}

modules/core/map.js, line 731
This function allows the hover text to be hovered so that the text could be copied a new class "hoverText" will be inserted by mouseover and removed by mouseout

unregisterListener(event, callback, context){void}

modules/core/map.js, line 352
Unsubscribes listener to certain events.
Name Type Description
event String | Object The event type or an object used as a key.
callback function The callback function.
context Object todo

zoomToExtent(extent, options){void}

modules/core/map.js, line 568
todo
Name Type Description
extent * todo
options * todo

zoomToFilteredFeatures(ids, layerId){void}

modules/core/map.js, line 590
todo
Name Type Description
ids * todo
layerId * todo
Fires: