Global

Type Definitions

BKG

BKG layer (/layers/baseLayer|overlays/items/BKG)
Properties:
Name Type Description
type string Type of layer: BKG (/layers/baseLayer|overlays/items/BKG/type)
id string | null Unique ID. It will be used in permaLink and persistence JSON. If not available, it will be added by Framework. (/layers/baseLayer|overlays/items/BKG/id)
name string Name of layer shown in Menu. (/layers/baseLayer|overlays/items/BKG/name)
ref string Reference of layer in BKG layer registry. This is the name of BKG layer to load. (/layers/baseLayer|overlays/items/BKG/ref)
visibility boolean Initial visibility of layer. (/layers/baseLayer|overlays/items/BKG/visibility)
srsName string | null Projection of layer. If null, then map projection will be used. (/layers/baseLayer|overlays/items/BKG/srsName)
minResolution number Minimum resolution. (/layers/baseLayer|overlays/items/BKG/minResolution)
maxResolution number Maximum resolution. (/layers/baseLayer|overlays/items/BKG/maxResolution)
properties object Updates for the layer that will overwrite the preconfigured values. The complete set of available properties depends on the preconfigured layer class. (/layers/baseLayer|overlays/items/BKG/properties)
opacity number Default Opacity. (Values: 0, 0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9, 1)(/layers/baseLayer|overlays/items/BKG/opacity)
copyright string | null Copyright. If null or empty it will be parsed from GetCapabilities. (/layers/baseLayer|overlays/items/BKG/copyright)
legendUrl string | null URL for legend. (/layers/baseLayer|overlays/items/BKG/legendUrl)
Source:

CONTROL_FACTORIES_cookieCheck(map, controlName, options) → {object}

Create cookieCheck Control
Parameters:
Name Type Description
map object Map object
controlName string Name of control (cookieCheck)
options object Control options.
Source:
Returns:
Type
object

CONTROL_FACTORIES_copyCoordinates(map, controlName, options, panel) → {object}

Create copyCoordinates Control
Parameters:
Name Type Description
map object Map object
controlName string Name of control (copyCoordinates)
options object Control options. See properties in copyCoordinates_options
panel object Panel object
Source:
Returns:
Type
object
Create copyright Control
Parameters:
Name Type Description
map object Map object
controlName string Name of control (copyright)
options object Control options. See properties in copyright_options
panel object Panel object
standardPositionControls object Object with standardPositionControls
Source:
Returns:
Type
object

CONTROL_FACTORIES_customLayers(map, controlName, options, panel) → {object}

Create customLayers Control
Parameters:
Name Type Description
map object Map object
controlName string Name of control (customLayers)
options object Control options. See properties in customLayers_options
panel object Panel object
Source:
Returns:
Type
object

CONTROL_FACTORIES_edit(map, controlName, options, panel) → {object}

Create edit Control
Parameters:
Name Type Description
map object Map object
controlName string Name of control (edit)
options object Control options. See properties in edit_options
panel object Panel object
Source:
Returns:
Type
object

CONTROL_FACTORIES_fullScreen(map, controlName, options, panel, standardPositionControls) → {object}

Create fullScreen Control
Parameters:
Name Type Description
map object Map object
controlName string Name of control (fullScreen)
options object Control options. See properties in fullScreen_options
panel object Panel object
standardPositionControls object Object with standardPositionControls
Source:
Returns:
Type
object

CONTROL_FACTORIES_geoSearch(map, controlName, options, panel) → {object}

Create geoSearch Control
Parameters:
Name Type Description
map object Map object
controlName string Name of control (geoSearch)
options object Control options. See properties in geoSearch_options
panel object Panel object
Source:
Returns:
Type
object

CONTROL_FACTORIES_infoPanel(map, controlName, options, panel) → {object}

Create infoPanel Control
Parameters:
Name Type Description
map object Map object
controlName string Name of control (infoPanel)
options null InfoPlanel options. Currently not used.
panel object Panel object
Source:
Returns:
Type
object

CONTROL_FACTORIES_jsonExport(map, options, panel) → {object}

Create jsonExport Control
Parameters:
Name Type Description
map object Map object
options object Control options.
Properties
Name Type Description
active boolean Activate tool. (/options/tools/share/jsonExport/active)
appName string Name of BKG Webmap implementation that will be used in exported JSON. (/options/tools/share/jsonExport/appName)
panel object Panel object
Source:
Returns:
Type
object

CONTROL_FACTORIES_layerSwitcher(map, controlName, options, panel) → {object}

Create layerSwitcher Control
Parameters:
Name Type Description
map object Map object
controlName string Name of control (layerSwitcher)
options object Control options. See properties in layerSwitcher_options
panel object Panel object
Source:
Returns:
Type
object

CONTROL_FACTORIES_legend(map, controlName, options, panel) → {object}

Create legend Control
Parameters:
Name Type Description
map object Map object
controlName string Name of control (legend)
options object Control options. See properties in legend_options
panel object Panel object
Source:
Returns:
Type
object

CONTROL_FACTORIES_marker(map) → {object}

Create marker Control
Parameters:
Name Type Description
map object Map object
Source:
Returns:
Type
object

CONTROL_FACTORIES_measure(map, controlName, options, panel) → {object}

Create measure Control
Parameters:
Name Type Description
map object Map object
controlName string Name of control (measure)
options object Control options. See properties in measure_options
panel object Panel object
Source:
Returns:
Type
object

CONTROL_FACTORIES_overviewMap(map, controlName, options, panel, standardPositionControls) → {object}

Create overviewMap Control
Parameters:
Name Type Description
map object Map object
controlName string Name of control (overviewMap)
options object Control options. See properties in overviewMap_options
panel object Panel object
standardPositionControls object Object with standardPositionControls
Source:
Returns:
Type
object

CONTROL_FACTORIES_panel(map, panelPosition, initialize, standardPositionControls) → {object}

Create panel Control
Parameters:
Name Type Description
map object Map object
panelPosition string Panel position (Values: "left", "right") (/options/panelPosition)
initialize object Tool that should be shown, when starting the Application. If empty or null, then panel will be closed. (Values: "geoSearch", "searchCoordinates", "layerSwitcher", "legend", "showAttributes", "copyCoordinates", "measure", "edit", "share") (/options/initialize)
standardPositionControls object Object with standardPositionControls
Source:
Returns:
Type
object
Create permaLink Control
Parameters:
Name Type Description
map object Map object
Source:
Returns:
Type
object

CONTROL_FACTORIES_print(map, options, panel) → {object}

Create print Control
Parameters:
Name Type Description
map object Map object
options object Control options.
Properties
Name Type Description
active boolean Activate tool. (/options/tools/share/print/active)
stylesheet string URL of stylesheet file that can be used when printing. (/options/tools/share/print/stylesheet)
panel object Panel object
Source:
Returns:
Type
object

CONTROL_FACTORIES_scalebar(map, controlName, options, panel, standardPositionControls) → {object}

Create scalebar Control
Parameters:
Name Type Description
map object Map object
controlName string Name of control (scalebar)
options object Control options. See properties in scalebar_options
panel object Panel object
standardPositionControls object Object with standardPositionControls
Source:
Returns:
Type
object

CONTROL_FACTORIES_searchCoordinates(map, controlName, options, panel) → {object}

Create searchCoordinates Control
Parameters:
Name Type Description
map object Map object
controlName string Name of control (searchCoordinates)
options object Control options. See properties in searchCoordinates_options
panel object Panel object
Source:
Returns:
Type
object

CONTROL_FACTORIES_searchPanel(map, controlName, geoSearch, panel) → {object}

Method to create searchPanel Control
Parameters:
Name Type Description
map object Map object
controlName string Name of control (searchpanel)
geoSearch boolean Is there a geoSearch control available
panel object Panel object
Source:
Returns:
Type
object

CONTROL_FACTORIES_share(map, controlName, options, panel) → {object}

Create share Control
Parameters:
Name Type Description
map object Map object
controlName string Name of control (share)
options object Control options. See properties in share_options
panel object Panel object
Source:
Returns:
Type
object

CONTROL_FACTORIES_showAttributes(map, controlName, options, panel) → {object}

Create showAttributes Control
Parameters:
Name Type Description
map object Map object
controlName string Name of control (showAttributes)
options object Control options. See properties in showAttributes_options
panel object Panel object
Source:
Returns:
Type
object

CONTROL_FACTORIES_showCoordinates(map, controlName, options, panel, standardPositionControls) → {object}

Create showCoordinates Control
Parameters:
Name Type Description
map object Map object
controlName string Name of control (showCoordinates)
options object Control options. See properties in showCoordinates_options
panel object Panel object
standardPositionControls object Object with standardPositionControls
Source:
Returns:
Type
object

CONTROL_FACTORIES_standardPosition(map, position) → {object}

Create four standard positions for map controls (top-left, top-right, bottom-left, bottom-right)
Parameters:
Name Type Description
map object Map object
position string Position of control (top-left, top-right, bottom-left, bottom-right)
Source:
Returns:
Type
object
Create staticLinks Control
Parameters:
Name Type Description
map object Map object
controlName string Name of control (staticLinks)
options object Control options. See properties in staticLinks_options
panel object Panel object
standardPositionControls object Object with standardPositionControls
Source:
Returns:
Type
object

CONTROL_FACTORIES_staticWindows(map, controlName, options, panel) → {object}

Create staticWindows Control
Parameters:
Name Type Description
map object Map object
controlName string Name of control (staticWindows)
options object Control options. See properties in staticWindows_options
panel object Panel object
Source:
Returns:
Type
object

CONTROL_FACTORIES_timeSlider(map, controlName, options, panel, standardPositionControls) → {object}

Create timeSlider Control
Parameters:
Name Type Description
map object Map object
controlName string Name of control (timeSlider)
options object Control options. See properties in timeSlider_options
panel object Panel object
standardPositionControls object Object with standardPositionControls
Source:
Returns:
Type
object

CONTROL_FACTORIES_zoom(map, controlName, options, panel, standardPositionControls) → {object}

Create zoom Control
Parameters:
Name Type Description
map object Map object
controlName string Name of control (zoom)
options object Control options. See properties in zoom_options
panel object Panel object
standardPositionControls object Object with standardPositionControls
Source:
Returns:
Type
object

copyCoordinates_options

Properties:
Name Type Description
active boolean Activate tool. (/options/tools/copyCoordinates/active)
div string | null DIV ID. (/options/tools/copyCoordinates/div)
style string CSS Class used for styling. (/options/tools/copyCoordinates/style)
coordinateSystems Array.<object> Coordinate systems for dropdown menu. (/options/tools/copyCoordinates/coordinateSystems)
Below are properties of each Object in Array:
Properties
Name Type Description
epsg string EPSG code. (/options/tools/searchCoordinates/copyCoordinates/items/epsg)
name string Name of coordinate system. (/options/tools/copyCoordinates/coordinateSystems/items/name)
Source:
Properties:
Name Type Description
active boolean Activate tool. (/options/tools/copyright/active)
position string Position of control. It will be used only if div is null. Values: 'top-left', 'top-right', 'bottom-left', 'bottom-right' or CSS properties (e.g. 'left: 5px; top: 10px;'). (/options/tools/copyright/position)
div string | null DIV ID. (/options/tools/copyright/div)
style string CSS Class used for styling. (/options/tools/copyright/style)
maxWidth string Maximum width of copyright div (e.g. '200px'). (/options/tools/copyright/maxWidth)
maxHeight string Maximum height of copyright div (e.g. '100px'). (/options/tools/copyright/maxHeight)
onlyFullScreen boolean Tool available only in full screen mode. (/options/tools/copyright/onlyFullScreen)
Source:

createCallback()

Callback for getting ready map object. You can use the parameter to change the map.
Parameters:
Name Type Description
_this.map ol.Map OpenLayer map object.
Source:

CSV

CSV layer (/layers/baseLayer|overlays/items/CSV)
Properties:
Name Type Description
type string Type of layer: CSV (/layers/baseLayer|overlays/items/CSV/type)
id string | null Unique ID. It will be used in permaLink and persistence JSON. If not available, it will be added by Framework. (/layers/baseLayer|overlays/items/CSV/id)
name string Name of layer shown in Menu. (/layers/baseLayer|overlays/items/CSV/name)
url string URL of CSV file. (/layers/baseLayer|overlays/items/CSV/url)
visibility boolean Initial visibility of layer. (/layers/baseLayer|overlays/items/CSV/visibility)
srsName string | null Projection of layer. If null, then EPSG 4326 will be used. (/layers/baseLayer|overlays/items/CSV/srsName)
csvOptions object Options only for CSV layer. (/layers/baseLayer|overlays/items/CSV/csvOptions)
Properties
Name Type Description
header boolean Should the first row be used as header. (/layers/baseLayer|overlays/items/CSV/csvOptions/header)
delimiter string Delimiter used in CSV file (default: ";"). (/layers/baseLayer|overlays/items/CSV/csvOptions/delimiter)
columnsToParse Array.<integer> Names (strings) or positions (integer) of columns that should be used as attributes. 1 is the start position. If null, then all columns will be used. (/layers/baseLayer|overlays/items/CSV/csvOptions/columnsToParse)
columnNames Array.<integer> ADefine custom column names. Used only if header is false. The length should be the same as in columnsToParse.. (/layers/baseLayer|overlays/items/CSV/csvOptions/columnNames)
LatColumn string | integer Name (string) or position (integer) of column with coordinates (Lat). The coordinate system is defined through srsName. (/layers/baseLayer|overlays/items/CSV/csvOptions/LatColumn)
LonColumn string | integer Name (string) or position (integer) of column with coordinates (Lon). The coordinate system is defined through srsName. (/layers/baseLayer|overlays/items/CSV/csvOptions/LonColumn)
encoding string The encoding to use when opening the file (default: "UTF-8"). (/layers/baseLayer|overlays/items/CSV/csvOptions/encoding)
minResolution number Minimum resolution. (/layers/baseLayer|overlays/items/CSV/minResolution)
maxResolution number Maximum resolution. (/layers/baseLayer|overlays/items/CSV/maxResolution)
edit boolean Enable edit layer. Always false. (/layers/baseLayer|overlays/items/CSV/edit)
style string | null Style of WFS. Use /styles/items/name. (/layers/baseLayer|overlays/items/CSV/style)
opacity number Default Opacity. (Values: 0, 0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9, 1)(/layers/baseLayer|overlays/items/CSV/opacity)
copyright string | null Copyright. If null or empty it will be parsed from GetCapabilities. (/layers/baseLayer|overlays/items/CSV/copyright)
legendUrl string | null URL for legend. (/layers/baseLayer|overlays/items/CSV/legendUrl)
Source:

custom_style

GROUP layer (/styles/items/custom)
Properties:
Name Type Description
name string Name of style. This should be used as reference for a layer. (/styles/items/custom/name)
type string Type of style: custom. (/styles/items/custom/type)
fill object Properties of OpenLayers Class ol.style.Fill. (/styles/items/custom/fill)
stroke object SProperties of OpenLayers Class ol.style.Stroke. (/styles/items/custom/stroke)
image object Styling points. Use only one key of the following. If more than one keys are used, this is the reading order: regularShape->icon->circle (last overwrites first) (/styles/items/custom/image)
Properties
Name Type Description
circle object Properties of OpenLayers Class ol.style.Circle (/styles/items/custom/image/circle)
icon object Properties of OpenLayers Class ol.style.Icon (/styles/items/custom/image/icon)
regularShape object Properties of OpenLayers Class ol.style.RegularShape (/styles/items/custom/image/regularShape)
Source:

customLayers_options

Properties:
Name Type Description
active boolean Activate tool. (/options/tools/customLayers/active)
edit boolean Enable editing for custom layer. (/options/tools/customLayers/edit)
changeVisibility boolean User can change visibility of custom layers. (/options/tools/customLayers/changeVisibility)
defaultStyle string Default style of custom vector layers. Use /styles/items/name. (/options/tools/customLayers/defaultStyle)
dataTypes Array.<string> Layer types. (Values in array: "BKG", "WMS", "WMTS", "WFS", "CSV", "XLS", "GPS") (/options/tools/customLayers/dataTypes)
Source:

edit_options

Properties:
Name Type Description
active boolean Activate tool. (/options/tools/edit/active)
div string | null DIV ID. (/options/tools/edit/div)
style string CSS Class used for styling. (/options/tools/edit/style)
emptyLayer boolean If edit is active and there is no vector layer, add an empty vector layer. (/options/tools/edit/emptyLayer)
export object Export editable layers. (/options/tools/edit/export)
Properties
Name Type Description
active boolean Activate tool. (/options/tools/edit/export/active)
formats array Export formats. (Array values: "KML", "GML", "GEOJSON", "GPX", "WKT") (/options/tools/edit/export/formats)
Source:

fullScreen_options

Properties:
Name Type Description
active boolean Activate tool. (/options/tools/fullScreen/active)
position string Position of control. It will be used only if div is null. Values: 'top-left', 'top-right', 'bottom-left', 'bottom-right' or CSS properties (e.g. 'left: 5px; top: 10px;'). (/options/tools/fullScreen/position)
div string | null DIV ID. (/options/tools/fullScreen/div)
style string CSS Class used for styling. (/options/tools/fullScreen/style)
Source:

geoSearch_options

Properties:
Name Type Description
active boolean Activate tool. (/options/tools/geoSearch/active)
div string | null DIV ID. (/options/tools/geoSearch/div)
style string CSS Class used for styling. (/options/tools/geoSearch/style)
resultsMaxZoom integer | null Max value for zooming to result features. (/options/tools/geoSearch/resultsMaxZoom)
suggestCount integer | null Suggestion results that will be fetched. (/options/tools/geoSearch/suggestCount)
resultsCount integer | null Results that will be fetched. (/options/tools/geoSearch/resultsCount)
templatePopup string | null Template for popups (e.g. "< b>$text< /b>< br/>$typ< br/>($geometry.x $geometry.y)"). (/options/tools/geoSearch/templatePopup)
templateList string | null Template for results list. (e.g. "< b>$text< /b>< br/>$typ< br/>($geometry.x $geometry.y)"). (/options/tools/geoSearch/templateList)
protocol object Protocol used for geoSearch control. (/options/tools/geoSearch/protocol)
Source:

GPS

GPS layer (/layers/baseLayer|overlays/items/GPS)
Properties:
Name Type Description
type string Type of layer: GPS (/layers/baseLayer|overlays/items/GPS/type)
id string | null Unique ID. It will be used in permaLink and persistence JSON. If not available, it will be added by Framework. (/layers/baseLayer|overlays/items/GPS/id)
name string Name of layer shown in Menu. (/layers/baseLayer|overlays/items/GPS/name)
url string URL of GPX file. (/layers/baseLayer|overlays/items/GPS/url)
visibility boolean Initial visibility of layer. (/layers/baseLayer|overlays/items/GPS/visibility)
minResolution number Minimum resolution. (/layers/baseLayer|overlays/items/GPS/minResolution)
maxResolution number Maximum resolution. (/layers/baseLayer|overlays/items/GPS/maxResolution)
edit boolean Enable edit layer. Always false. (/layers/baseLayer|overlays/items/GPS/edit)
style string | null Style of WFS. Use /styles/items/name. (/layers/baseLayer|overlays/items/GPS/style)
opacity number Default Opacity. (Values: 0, 0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9, 1)(/layers/baseLayer|overlays/items/GPS/opacity)
copyright string | null Copyright. If null or empty it will be parsed from GetCapabilities. (/layers/baseLayer|overlays/items/GPS/copyright)
legendUrl string | null URL for legend. (/layers/baseLayer|overlays/items/GPS/legendUrl)
Source:

GROUP

GROUP layer (/layers/overlays/items/GROUP)
Properties:
Name Type Description
type string Type of layer: GROUP (/layers/overlays/items/GROUP/type)
id string | null Unique ID. It will be used in permaLink and persistence JSON. If not available, it will be added by Framework. (/layers/overlays/items/GROUP/id)
name string Name of group. (/layers/overlays/items/GROUP/name)
layers Array.<object> List of layers in a group. The position in this list will determine the position on map. (Array values: WMS, WMTS, WFS, MARKER, CSV, CSV, XLS, GPS, BKG) (/layers/overlays/items/GROUP/layers)
visibility boolean Initial visibility of layer. (/layers/overlays/items/GROUP/visibility)
Source:

LAYER_FACTORIES_BKG(createConfig, map, config, styles, bkg, callback) → {object}

Create BKG layer
Parameters:
Name Type Description
createConfig BKGWebMap.ParseConfig BKGWebMap.ParseConfig object
map object Map object
config BKG BKG configuration
styles object Object with styles (symbol_style|custom_style)
bkg boolean This layer is generated from a BKG Layer
callback function Callback function. It will be called when all information of layer are parsed.
Source:
Returns:
Type
object

LAYER_FACTORIES_GPS(createConfig, map, config, styles, bkg, callback) → {object}

Create GPS layer
Parameters:
Name Type Description
createConfig BKGWebMap.ParseConfig BKGWebMap.ParseConfig object
map object Map object
config GPS GPS configuration
styles object Object with styles (symbol_style|custom_style)
bkg boolean This layer is generated from a BKG Layer
callback function Callback function. It will be called when all information of layer are parsed.
Source:
Returns:
Type
object

LAYER_FACTORIES_GROUP(createConfig, map, config, styles, bkg, callback) → {object}

Create GROUP layer
Parameters:
Name Type Description
createConfig BKGWebMap.ParseConfig BKGWebMap.ParseConfig object
map object Map object
config GROUP GROUP configuration
styles object Object with styles (symbol_style|custom_style)
bkg boolean This layer is generated from a BKG Layer
callback function Callback function. It will be called when all information of layer are parsed.
Source:
Returns:
Type
object

LAYER_FACTORIES_MARKER(createConfig, map, config, styles, bkg, callback) → {object}

Create MARKER layer
Parameters:
Name Type Description
createConfig BKGWebMap.ParseConfig BKGWebMap.ParseConfig object
map object Map object
config MARKER MARKER configuration
styles object Object with styles (symbol_style|custom_style)
bkg boolean This layer is generated from a BKG Layer
callback function Callback function. It will be called when all information of layer are parsed.
Source:
Returns:
Type
object

LAYER_FACTORIES_MARKER(createConfig, map, config, styles, bkg, callback) → {object}

Create CSV layer
Parameters:
Name Type Description
createConfig BKGWebMap.ParseConfig BKGWebMap.ParseConfig object
map object Map object
config CSV CSV configuration
styles object Object with styles (symbol_style|custom_style)
bkg boolean This layer is generated from a BKG Layer
callback function Callback function. It will be called when all information of layer are parsed.
Source:
Returns:
Type
object

LAYER_FACTORIES_NONE(createConfig, map, config, styles, bkg, callback) → {object}

Create NONE (empty) layer
Parameters:
Name Type Description
createConfig BKGWebMap.ParseConfig BKGWebMap.ParseConfig object
map object Map object
config NONE NONE configuration
styles object Object with styles (symbol_style|custom_style)
bkg boolean This layer is generated from a BKG Layer
callback function Callback function. It will be called when all information of layer are parsed.
Source:
Returns:
Type
object

LAYER_FACTORIES_VECTOR(createConfig, map, config, styles, bkg, callback) → {object}

Create VECTOR layer
Parameters:
Name Type Description
createConfig BKGWebMap.ParseConfig BKGWebMap.ParseConfig object
map object Map object
config object VECTOR configuration
styles object Object with styles (symbol_style|custom_style)
bkg boolean This layer is generated from a BKG Layer
callback function Callback function. It will be called when all information of layer are parsed.
Source:
Returns:
Type
object

LAYER_FACTORIES_WFS(createConfig, map, config, styles, bkg, callback) → {object}

Create WFS layer
Parameters:
Name Type Description
createConfig BKGWebMap.ParseConfig BKGWebMap.ParseConfig object
map object Map object
config WFS WFS configuration
styles object Object with styles (symbol_style|custom_style)
bkg boolean This layer is generated from a BKG Layer
callback function Callback function. It will be called when all information of layer are parsed.
Source:
Returns:
Type
object

LAYER_FACTORIES_WMS(createConfig, map, config, styles, bkg, callback) → {object}

Create WMS layer
Parameters:
Name Type Description
createConfig BKGWebMap.ParseConfig BKGWebMap.ParseConfig object
map object Map object
config WMS WMS configuration
styles object Object with styles (symbol_style|custom_style)
bkg boolean This layer is generated from a BKG Layer
callback function Callback function. It will be called when all information of layer are parsed.
Source:
Returns:
Type
object

LAYER_FACTORIES_WMTS(createConfig, map, config, styles, bkg, callback) → {object}

Create WMTS layer
Parameters:
Name Type Description
createConfig BKGWebMap.ParseConfig BKGWebMap.ParseConfig object
map object Map object
config WMTS WMTS configuration
styles object Object with styles (symbol_style|custom_style)
bkg boolean This layer is generated from a BKG Layer
callback function Callback function. It will be called when all information of layer are parsed.
Source:
Returns:
Type
object

LAYER_FACTORIES_XLS(createConfig, map, config, styles, bkg, callback) → {object}

Create XLS layer
Parameters:
Name Type Description
createConfig BKGWebMap.ParseConfig BKGWebMap.ParseConfig object
map object Map object
config XLS XLS configuration
styles object Object with styles (symbol_style|custom_style)
bkg boolean This layer is generated from a BKG Layer
callback function Callback function. It will be called when all information of layer are parsed.
Source:
Returns:
Type
object

layerSwitcher_options

Properties:
Name Type Description
active boolean Activate tool. (/options/tools/layerSwitcher/active)
div string | null DIV ID. (/options/tools/layerSwitcher/div)
style string CSS Class used for styling. (/options/tools/layerSwitcher/style)
editStyle boolean User can change style of vector layers. (/options/tools/layerSwitcher/editStyle)
changeVisibility boolean User can change visibility of layers. (/options/tools/layerSwitcher/changeVisibility)
changeOrder boolean User can change layer order. (/options/tools/layerSwitcher/changeOrder)
showWMSLayers boolean Show layers of WMS Services in menu. (/options/tools/layerSwitcher/showWMSLayers)
openLevel integer Define which level of layerswitcher should be open. 0: Menu is closed, 1: Basemaps/Overlays menu is open, 2: Group layers are open. (/options/tools/layerSwitcher/openLevel)
Source:

legend_options

Properties:
Name Type Description
active boolean Activate tool. (/options/tools/legend/active)
div string | null DIV ID. (/options/tools/legend/div)
style string CSS Class used for styling. (/options/tools/legend/style)
Source:

MARKER

MARKER layer (/layers/baseLayer|overlays/items/MARKER)
Properties:
Name Type Description
type string Type of layer: MARKER (/layers/baseLayer|overlays/items/MARKER/type)
id string | null Unique ID. It will be used in permaLink and persistence JSON. If not available, it will be added by Framework. (/layers/baseLayer|overlays/items/MARKER/id)
name string Name of layer shown in Menu. (/layers/baseLayer|overlays/items/MARKER/name)
visibility boolean Initial visibility of layer. (/layers/baseLayer|overlays/items/MARKER/visibility)
srsName string | null Projection of layer. If null, then EPSG 4326 will be used. (/layers/baseLayer|overlays/items/MARKER/srsName)
markers Array.<object> List of markers. (/layers/baseLayer|overlays/items/MARKER/markers)
Below are properties of each Object in Array:
coordinates object Coordinates of marker. The coordinate system is defined through srsName. (/layers/baseLayer|overlays/items/MARKER/coordinates)
Properties
Name Type Description
lat number Marker latitude. (/layers/baseLayer|overlays/items/MARKER/coordinates/lat)
lon number Marker longitude. (/layers/baseLayer|overlays/items/MARKER/coordinates/lon)
markers.content string Content for info area. Markup is allowed. (/layers/baseLayer|overlays/items/MARKER/markers/content)
minResolution number Minimum resolution. (/layers/baseLayer|overlays/items/MARKER/minResolution)
maxResolution number Maximum resolution. (/layers/baseLayer|overlays/items/MARKER/maxResolution)
edit boolean Enable edit layer. Always false. (/layers/baseLayer|overlays/items/MARKER/edit)
style string | null Style of WFS. Use /styles/items/name. (/layers/baseLayer|overlays/items/MARKER/style)
opacity number Default Opacity. (Values: 0, 0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9, 1)(/layers/baseLayer|overlays/items/MARKER/opacity)
copyright string | null Copyright. If null or empty it will be parsed from GetCapabilities. (/layers/baseLayer|overlays/items/MARKER/copyright)
legendUrl string | null URL for legend. (/layers/baseLayer|overlays/items/MARKER/legendUrl)
Source:

measure_options

Properties:
Name Type Description
active boolean Activate tool. (/options/tools/measure/active)
div string | null DIV ID. (/options/tools/measure/div)
style string CSS Class used for styling. (/options/tools/measure/style)
Source:

NONE

NONE layer (/layers/baseLayer/items/NONE)
Properties:
Name Type Description
type string Type of layer: NONE (/layers/baseLayer/items/NONE/type)
id string | null Unique ID. It will be used in permaLink and persistence JSON. If not available, it will be added by Framework. (/layers/baseLayer/items/NONE/id)
Source:

overviewMap_options

Properties:
Name Type Description
active boolean Activate tool. (/options/tools/overviewMap/active)
position string Position of control. It will be used only if div is null. Values: 'top-left', 'top-right', 'bottom-left', 'bottom-right' or CSS properties (e.g. 'left: 5px; top: 10px;'). (/options/tools/overviewMap/position)
div string | null DIV ID. (/options/tools/overviewMap/div)
collapsible boolean Overview map can be collapsed. (/options/tools/overviewMap/collapsible)
collapsed boolean Overview map should start collapsed. (/options/tools/overviewMap/collapsed)
layers array | null Array with layer IDs that should be shown in overview map. If empty or null, all layers will be used.. (/options/tools/overviewMap/layers)
onlyFullScreen boolean Link available only in full screen mode. (/options/tools/overviewMap/items/onlyFullScreen)
Source:

scalebar_options

Properties:
Name Type Description
active boolean Activate tool. (/options/tools/scalebar/active)
position string Position of control. It will be used only if div is null. Values: 'top-left', 'top-right', 'bottom-left', 'bottom-right' or CSS properties (e.g. 'left: 5px; top: 10px;'). (/options/tools/scalebar/position)
scalebarType string Type of scalebar. (Values: "mapscale", "resolution", "distance", "mapscaleDistance", "resolutionDistance") (/options/tools/scalebar/scalebarType)
div string | null DIV ID. (/options/tools/scalebar/div)
style string CSS Class used for styling. (/options/tools/scalebar/style)
onlyFullScreen boolean Tool available only in full screen mode. (/options/tools/scalebar/onlyFullScreen)
Source:

searchCoordinates_options

Properties:
Name Type Description
active boolean Activate tool. (/options/tools/searchCoordinates/active)
div string | null DIV ID. (/options/tools/searchCoordinates/div)
style string CSS Class used for styling. (/options/tools/searchCoordinates/style)
coordinateSystems Array.<object> Coordinate systems for dropdown menu. (/options/tools/searchCoordinates/coordinateSystems)
Below are properties of each Object in Array:
Properties
Name Type Description
epsg string EPSG code. (/options/tools/searchCoordinates/coordinateSystems/items/epsg)
name string Name of coordinate system. (/options/tools/searchCoordinates/coordinateSystems/items/name)
Source:

share_options

Properties:
Name Type Description
active boolean Activate tool. (/options/tools/share/active)
div string | null DIV ID. (/options/tools/share/div)
style string CSS Class used for styling. (/options/tools/share/style)
print object Print map. (/options/tools/share/print)
Properties
Name Type Description
active boolean Activate tool. (/options/tools/share/print/active)
stylesheet string URL of stylesheet file that can be used when printing. (/options/tools/share/print/stylesheet)
permaLink object Use URL paramaters for exporting-importing map status. (/options/tools/share/permaLink)
Properties
Name Type Description
active boolean Activate tool. (/options/tools/share/permaLink/active)
jsonExport object Export-Import JSON with current status of application. (/options/tools/share/jsonExport)
Properties
Name Type Description
active boolean Activate tool. (/options/tools/share/jsonExport/active)
appName string Name of BKG Webmap implementation that will be used in exported JSON. (/options/tools/share/jsonExport/appName)
Source:

showAttributes_options

Properties:
Name Type Description
active boolean Activate tool. (/options/tools/showAttributes/active)
div string | null DIV ID. (/options/tools/showAttributes/div)
style string CSS Class used for styling. (/options/tools/showAttributes/style)
Source:

showCoordinates_options

Properties:
Name Type Description
active boolean Activate tool. (/options/tools/showCoordinates/active)
position string Position of control. It will be used only if div is null. Values: 'top-left', 'top-right', 'bottom-left', 'bottom-right' or CSS properties (e.g. 'left: 5px; top: 10px;'). (/options/tools/showCoordinates/position)
coordinateSystems Array.<object> Coordinate systems for dropdown menu. (/options/tools/showCoordinates/coordinateSystems)
Below are properties of each Object in Array:
Properties
Name Type Description
epsg string EPSG code. (/options/tools/searchCoordinates/showCoordinates/items/epsg)
name string Name of coordinate system. (/options/tools/showCoordinates/coordinateSystems/items/name)
div string | null DIV ID. (/options/tools/showCoordinates/div)
style string CSS Class used for styling. (/options/tools/showCoordinates/style)
Source:
Properties:
Name Type Description
position string Position of control. It will be used only if div is null. Values: 'top-left', 'top-right', 'bottom-left', 'bottom-right' or CSS properties (e.g. 'left: 5px; top: 10px;'). (/options/tools/staticLinks/items/position)
div string | null DIV ID. (/options/tools/staticLinks/items/div)
style string CSS Class used for styling. (/options/tools/staticLinks/items/style)
url string URL for link. (/options/tools/staticLinks/items/url)
title string Title for link shown on hover. (/options/tools/staticLinks/items/title)
content string Content for link. Markup is allowed. (/options/tools/staticLinks/items/content)
onlyFullScreen boolean Link available only in full screen mode. (/options/tools/staticLinks/items/onlyFullScreen)
Source:

staticWindows_options

Properties:
Name Type Description
active boolean Should window be initially open or close. (/options/tools/staticWindows/active)
position string Position of control. It will be used only if div is null. Values: 'top-left', 'top-right', 'bottom-left', 'bottom-right' or CSS properties (e.g. 'left: 5px; top: 10px;'). (/options/tools/staticWindows/items/position)
div string | null DIV ID. (/options/tools/staticWindows/items/div)
style string CSS Class used for styling. (/options/tools/staticWindows/items/style)
size Array.<integer> Size of window in pixel [width, height]. (/options/tools/staticWindows/items/size)
title string Title for link shown on hover. (/options/tools/staticWindows/items/title)
content string Content for link. Markup is allowed. (/options/tools/staticWindows/items/content)
onlyFullScreen boolean Link available only in full screen mode. (/options/tools/staticWindows/items/onlyFullScreen)
Source:

symbol_style

GROUP layer (/styles/items/symbol)
Properties:
Name Type Description
name string Name of style. This should be used as reference for a layer. (/styles/items/symbol/name)
type string Type of style: symbol. (/styles/items/symbol/type)
fillColor string Fill color for vector layers. A hexadecimal value. (/styles/items/symbol/fillColor)
strokeColor string Stroke color for vector layers. A hexadecimal value. (/styles/items/symbol/strokeColor)
symbol string Symbol for vector layers (points). (Values: "marker", "star", "circle", "dottedCircle", "pentagon") (/styles/items/symbol/symbol)
Source:

timeSlider_options

Properties:
Name Type Description
active boolean Activate tool. (/options/tools/timeSlider/active)
position string Position of control. It will be used only if div is null. Values: 'top-left', 'top-right', 'bottom-left', 'bottom-right' or CSS properties (e.g. 'left: 5px; top: 10px;'). (/options/tools/timeSlider/position)
div string | null DIV ID. (/options/tools/timeSlider/div)
style string CSS Class used for styling. (/options/tools/timeSlider/style)
Source:

WFS

WFS layer (/layers/baseLayer|overlays/items/WFS)
Properties:
Name Type Description
type string Type of layer: WFS (/layers/baseLayer|overlays/items/WFS/type)
id string | null Unique ID. It will be used in permaLink and persistence JSON. If not available, it will be added by Framework. (/layers/baseLayer|overlays/items/WFS/id)
name string Name of layer shown in Menu. (/layers/baseLayer|overlays/items/WFS/name)
typename string Typename of WFS (namespace:featuretype). (/layers/baseLayer|overlays/items/WFS/typename)
url string Service-URL. (/layers/baseLayer|overlays/items/WFS/url)
visibility boolean Initial visibility of layer. (/layers/baseLayer|overlays/items/WFS/visibility)
srsName string | null Projection of layer. If null, then EPSG 25832 will be used. (/layers/baseLayer|overlays/items/WFS/srsName)
format string | null Format for WFS layers. If null, then GML3 will be used. (Values: "GEOJSON", "GML2" ,"GML3") (/layers/baseLayer|overlays/items/WFS/format)
version string | null WFS version. If null, 1.1.0 will be used. (Values: "1.0.0", "1.1.0", 2.0.0") (/layers/baseLayer|overlays/items/WFS/version)
tiles boolean Load layer using tile strategy. (/layers/baseLayer|overlays/items/WFS/tiles)
minResolution number Minimum resolution. (/layers/baseLayer|overlays/items/WFS/minResolution)
maxResolution number Maximum resolution. (/layers/baseLayer|overlays/items/WFS/maxResolution)
edit boolean Enable edit layer. Always false. (/layers/baseLayer|overlays/items/WFS/edit)
style string | null Style of WFS. Use /styles/items/name. (/layers/baseLayer|overlays/items/WFS/style)
opacity number Default Opacity. (Values: 0, 0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9, 1)(/layers/baseLayer|overlays/items/WFS/opacity)
copyright string | null Copyright. If null or empty it will be parsed from GetCapabilities. (/layers/baseLayer|overlays/items/WFS/copyright)
legendUrl string | null URL for legend. (/layers/baseLayer|overlays/items/WFS/legendUrl)
Source:

WMS

WMS layer (/layers/baseLayer|overlays/items/WMS)
Properties:
Name Type Description
type string Type of layer: WMS (/layers/baseLayer|overlays/items/WMS/type)
id string | null Unique ID. It will be used in permaLink and persistence JSON. If not available, it will be added by Framework. (/layers/baseLayer|overlays/items/WMS/id)
name string Name of layer shown in Menu. (/layers/baseLayer|overlays/items/WMS/name)
url string Service-URL. (/layers/baseLayer|overlays/items/WMS/url)
layers Array.<object> Layers of specific service that should be loaded. If empty, then all available layers will be loaded. (/layers/baseLayer|overlays/items/WMS/layers)
Below are properties of each Object in Array:
Properties
Name Type Description
id string | null Unique ID. (/layers/baseLayer|overlays/items/WMS/layers/id)
name string Name of layer shown in Menu. (/layers/baseLayer|overlays/items/WMS/layers/name)
layer string Name of layer to load. (/layers/baseLayer|overlays/items/WMS/layers/layer)
visibility boolean Initial visibility of layer. (/layers/baseLayer|overlays/items/WMS/layers/visibility)
style string | null Style of layer. (/layers/baseLayer|overlays/items/WMS/layers/style)
selectStyle boolean The user is able to select a style for this layer. (/layers/baseLayer|overlays/items/WMS/layers/selectStyle)
legendUrl string | null URL for legend. If empty or null, legend will be loaded using GetLegendGraphic. (/layers/baseLayer|overlays/items/WMS/layers/legendUrl)
minResolution number Minimum resolution. (/layers/baseLayer|overlays/items/WMS/layers/minResolution)
maxResolution number Maximum resolution. (/layers/baseLayer|overlays/items/WMS/layers/maxResolution)
visibility boolean Selected visibility of layer. (/layers/baseLayer|overlays/items/WMS/visibility)
tiles boolean Load tiles or single image. (/layers/baseLayer|overlays/items/WMS/tiles)
version string | null WMS version. If null, 1.3.0 will be used. (Values: "1.1.0", "1.1.1", 1.3.0") (/layers/baseLayer|overlays/items/WMS/version)
srsName string | null Projection of layer. If null, then EPSG 25832 will be used. (/layers/baseLayer|overlays/items/WMS/srsName)
minResolution number Minimum resolution. (/layers/baseLayer|overlays/items/WMS/minResolution)
maxResolution number Maximum resolution. (/layers/baseLayer|overlays/items/WMS/maxResolution)
opacity number Default Opacity. (Values: 0, 0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9, 1)(/layers/baseLayer|overlays/items/WMS/opacity)
legendUrl string | null URL for legend. If empty or null, legend will be loaded using GetLegendGraphic. It has priority over legendUrl in each WMS-Layer (/layers/WMS/layers/items/legendUrl). (/layers/baseLayer|overlays/items/WMS/legendUrl)
copyright string | null Copyright. If null or empty it will be parsed from GetCapabilities. (/layers/baseLayer|overlays/items/WMS/copyright)
time object Time options for WMS-T. (/layers/baseLayer|overlays/items/WMS/time)
Properties
Name Type Description
active boolean Activate tool. (/layers/baseLayer|overlays/items/WMS/time/active)
values string Specify time range and interval in ISO 8601 format. Example: '2016-03-10T23:00:00.000Z/2016-03-15T23:00:00.000Z/P1D'. Infos: https://en.wikipedia.org/wiki/ISO_8601. (/layers/baseLayer|overlays/items/WMS/time/values)
mode string Time slider mode. Values: 'period|time'. If not defined, both modes will be used.
default string Default value for time slider
Source:

WMTS

WTMS layer (/layers/baseLayer|overlays/items/WTMS)
Properties:
Name Type Description
type string Type of layer: WMTS (/layers/baseLayer|overlays/items/WMTS/type)
id string | null Unique ID. It will be used in permaLink and persistence JSON. If not available, it will be added by Framework. (/layers/baseLayer|overlays/items/WMTS/id)
name string Name of layer shown in Menu. (/layers/baseLayer|overlays/items/WMTS/name)
url string Service-URL. (/layers/baseLayer|overlays/items/WMTS/url)
layer string Service-URL. If the URL ends with .xml, then make a getCapabilites request and use the response to load the layer.(/layers/baseLayer|overlays/items/WMTS/layer)
visibility boolean Initial visibility of layer. (/layers/baseLayer|overlays/items/WMTS/visibility)
srsName string | null Projection of layer. If null, then EPSG 25832 will be used. (/layers/baseLayer|overlays/items/WMTS/srsName)
tileGrid object Tile grid options (/layers/baseLayer|overlays/items/WMTS/tileGrid)
Properties
Name Type Description
origin array | null Tile grid origin. Array with numbers [lon, lat] or null. (/layers/baseLayer|overlays/items/WMTS/tileGrid/origin)
resolutions array | null Array with numbers. (/layers/baseLayer|overlays/items/WMTS//tileGrid/resolutions)
matrixIds array | null Array with strings. The length of this array needs to match the length of the resolutions array. (/layers/baseLayer|overlays/items/WMTS//tileGrid/matrixIds)
version string | null WMTS version. Always 1.0.0 (/layers/baseLayer|overlays/items/WMTS/version)
minResolution number Minimum resolution. (/layers/baseLayer|overlays/items/WMTS/minResolution)
maxResolution number Maximum resolution. (/layers/baseLayer|overlays/items/WMTS/maxResolution)
style string | null Style of WMTS. If null, default will be loaded. (/layers/baseLayer|overlays/items/WMTS/style)
matrixSet string | null Matrix set. (/layers/baseLayer|overlays/items/WMTS/matrixSet)
opacity number Default Opacity. (Values: 0, 0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9, 1)(/layers/baseLayer|overlays/items/WMTS/opacity)
copyright string | null Copyright. If null or empty it will be parsed from GetCapabilities. (/layers/baseLayer|overlays/items/WMTS/copyright)
legendUrl string | null URL for legend. (/layers/WMS/layers/items/legendUrl). (/layers/baseLayer|overlays/items/WMTS/legendUrl)
Source:

XLS

XLS layer (/layers/baseLayer|overlays/items/XLS)
Properties:
Name Type Description
type string Type of layer: XLS (/layers/baseLayer|overlays/items/XLS/type)
id string | null Unique ID. It will be used in permaLink and persistence JSON. If not available, it will be added by Framework. (/layers/baseLayer|overlays/items/XLS/id)
name string Name of layer shown in Menu. (/layers/baseLayer|overlays/items/XLS/name)
url string URL of Excel file. (/layers/baseLayer|overlays/items/XLS/url)
visibility boolean Initial visibility of layer. (/layers/baseLayer|overlays/items/XLS/visibility)
srsName string | null Projection of layer. If null, then EPSG 4326 will be used. (/layers/baseLayer|overlays/items/XLS/srsName)
excelOptions object Options only for XLS layer. (/layers/baseLayer|overlays/items/XLS/csvOptions)
Properties
Name Type Description
header boolean Should the first row be used as header. (/layers/baseLayer|overlays/items/XLS/excelOptions/header)
columnsToParse Array.<integer> Names (strings) or positions (integer) of columns that should be used as attributes. 1 is the start position. If null, then all columns will be used. (/layers/baseLayer|overlays/items/XLS/excelOptions/columnsToParse)
columnNames Array.<integer> ADefine custom column names. Used only if header is false. The length should be the same as in columnsToParse.. (/layers/baseLayer|overlays/items/XLS/excelOptions/columnNames)
LatColumn string | integer Name (string) or position (integer) of column with coordinates (Lat). The coordinate system is defined through srsName. (/layers/baseLayer|overlays/items/XLS/excelOptions/LatColumn)
LonColumn string | integer Name (string) or position (integer) of column with coordinates (Lon). The coordinate system is defined through srsName. (/layers/baseLayer|overlays/items/XLS/excelOptions/LonColumn)
minResolution number Minimum resolution. (/layers/baseLayer|overlays/items/XLS/minResolution)
maxResolution number Maximum resolution. (/layers/baseLayer|overlays/items/XLS/maxResolution)
edit boolean Enable edit layer. Always false. (/layers/baseLayer|overlays/items/XLS/edit)
style string | null Style of WFS. Use /styles/items/name. (/layers/baseLayer|overlays/items/XLS/style)
opacity number Default Opacity. (Values: 0, 0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9, 1)(/layers/baseLayer|overlays/items/XLS/opacity)
copyright string | null Copyright. If null or empty it will be parsed from GetCapabilities. (/layers/baseLayer|overlays/items/XLS/copyright)
legendUrl string | null URL for legend. (/layers/baseLayer|overlays/items/XLS/legendUrl)
Source:

zoom_options

Properties:
Name Type Description
active boolean Activate tool. (/options/tools/zoom/active)
showZoomLevel boolean Show zoom level as text under the zoom buttons. (/options/tools/zoom/showZoomLevel)
zoomToFullExtent boolean Zoom to full extent button. (/options/tools/zoom/zoomToFullExtent)
history boolean Navigation history buttons. (/options/tools/zoom/history)
position string Position of control. It will be used only if div is null. Values: 'top-left', 'top-right', 'bottom-left', 'bottom-right' or CSS properties (e.g. 'left: 5px; top: 10px;'). (/options/tools/zoom/position)
div string | null DIV ID. (/options/tools/zoom/div)
style string CSS Class used for styling. (/options/tools/zoom/style)
onlyFullScreen boolean Tool available only in full screen mode. (/options/tools/zoom/onlyFullScreen)
Source: