Namespace: Util

BKGWebMap. Util

Source:

Util.js, line 325

Members

<static> layerId :number

Counter for layer IDs

Source:

Util.js, line 305

<static> layerId :number

Counter for layer IDs

Source:

Util.js, line 629

Methods

<static> cssParser(cssString) → {object}

Generate object with css properties from a string

Parameters:

Name	Type	Description
`cssString`	string	String to parse

Source:

Util.js, line 468

Returns:

Type: object

<static> cssParser(cssString) → {object}

Generate object with css properties from a string

Parameters:

Name	Type	Description
`cssString`	string	String to parse

Source:

Util.js, line 144

Returns:

Type: object

<static> deepCopy(obj) → {object}

Creates a deep copy of an object

Parameters:

Name	Type	Description
`obj`	object	Object to copy

Source:

Util.js, line 65

Returns:

Type: object

<static> deepCopy(obj) → {object}

Creates a deep copy of an object

Parameters:

Name	Type	Description
`obj`	object	Object to copy

Source:

Util.js, line 389

Returns:

Type: object

<static> each(elements, method)

Iterates over arrays

Parameters:

Name	Type	Description
`elements`	array	Array that this method is being applied to
`method`	function	Function to be executed for each element

Source:

Util.js, line 12

<static> each(elements, method)

Iterates over arrays

Parameters:

Name	Type	Description
`elements`	array	Array that this method is being applied to
`method`	function	Function to be executed for each element

Source:

Util.js, line 336

<static> extend(obj1, obj2) → {object}

Extends an object using properties of a second object. Common properties will be overwritten.

Parameters:

Name	Type	Description
`obj1`	object	Object to extend.
`obj2`	object	Object to get new properties.

Source:

Util.js, line 84

Returns:

Type: object

<static> extend(obj1, obj2) → {object}

Extends an object using properties of a second object. Common properties will be overwritten.

Parameters:

Name	Type	Description
`obj1`	object	Object to extend.
`obj2`	object	Object to get new properties.

Source:

Util.js, line 408

Returns:

Type: object

<static> findGeometryType(features) → {object}

Find geometry type of features

Parameters:

Name	Type	Description
`features`	array	Array with OpenLayers features

Source:

Util.js, line 589

Returns:

Type: object

<static> findGeometryType(features) → {object}

Find geometry type of features

Parameters:

Name	Type	Description
`features`	array	Array with OpenLayers features

Source:

Util.js, line 265

Returns:

Type: object

<static> generateLayerId() → {string}

Generate ID for layers to use in permalink

Source:

Util.js, line 311

Returns:

Type: string

<static> generateLayerId() → {string}

Generate ID for layers to use in permalink

Source:

Util.js, line 635

Returns:

Type: string

<static> getLayerExtent(layer, projection) → {ol.Extent}

Returns the extent of the given layer. Depending on the layer type the access to the extent may vary.

Parameters:

Name	Type	Description
`layer`	ol.layer.Layer	the layer from which to retrieve the extent
`projection`	ol.proj.Projection	optional target projection for layer

Source:

Util.js, line 674

Returns:

Type: ol.Extent

<static> getObjValueFromStringPath(obj, propertyPath) → {object}

Get a value from an object using a string path in dot notation

Parameters:

Name	Type	Description
`obj`	object	Object to search.
`propertyPath`	string	String path in dot notation.

Source:

Util.js, line 132

Returns:

Type: object

<static> getObjValueFromStringPath(obj, propertyPath) → {object}

Get a value from an object using a string path in dot notation

Parameters:

Name	Type	Description
`obj`	object	Object to search.
`propertyPath`	string	String path in dot notation.

Source:

Util.js, line 456

Returns:

Type: object

<static> getSessionToken(appID, appDomain, callback) → {function}

Generate a Session-Token for secure BKG services

Parameters:

Name	Type	Description
`appID`	string
`appDomain`	string
`callback`	function	Callback function

Source:

Util.js, line 535

Returns:

Type: function

<static> getSessionToken(appID, appDomain, callback) → {function}

Generate a Session-Token for secure BKG services

Parameters:

Name	Type	Description
`appID`	string
`appDomain`	string
`callback`	function	Callback function

Source:

Util.js, line 211

Returns:

Type: function

<static> hasNestedProperty(obj, propertyPath) → {boolean}

Checks if an object has a nested property

Parameters:

Name	Type	Description
`obj`	object	The object to test
`propertyPath`	string	Path of property. Syntax: 'prop1.prop2.prop3...'

Source:

Util.js, line 433

Returns:

Type: boolean

<static> hasNestedProperty(obj, propertyPath) → {boolean}

Checks if an object has a nested property

Parameters:

Name	Type	Description
`obj`	object	The object to test
`propertyPath`	string	Path of property. Syntax: 'prop1.prop2.prop3...'

Source:

Util.js, line 109

Returns:

Type: boolean

<static> map(method, elements) → {array}

Maps elements of array. It creates a new array with the results of calling a method for every array element. You can pass further static arguments to the method.

Parameters:

Name	Type	Description
`method`	function	Function to be run for each element in the array
`elements`	array	Array that this method is being applied to

Source:

Util.js, line 367

Returns:

Type: array

<static> map(method, elements) → {array}

Maps elements of array. It creates a new array with the results of calling a method for every array element. You can pass further static arguments to the method.

Parameters:

Name	Type	Description
`method`	function	Function to be run for each element in the array
`elements`	array	Array that this method is being applied to

Source:

Util.js, line 43

Returns:

Type: array

<static> reverseEach(elements, method)

Iterates reverse over arrays

Parameters:

Name	Type	Description
`elements`	array	Array that this method is being applied to
`method`	function	Function to be executed for each element

Source:

Util.js, line 351

<static> reverseEach(elements, method)

Iterates reverse over arrays

Parameters:

Name	Type	Description
`elements`	array	Array that this method is being applied to
`method`	function	Function to be executed for each element

Source:

Util.js, line 27

<static> shouldCreatePanel(controls) → {boolean}

Determine if we need to create a panel

Parameters:

Name	Type	Description
`controls`	object	Object with controls configuration

Source:

Util.js, line 235

Returns:

Type: boolean

<static> shouldCreatePanel(controls) → {boolean}

Determine if we need to create a panel

Parameters:

Name	Type	Description
`controls`	object	Object with controls configuration

Source:

Util.js, line 559

Returns:

Type: boolean

<static> uniqueId() → {string}

Generate a unique BKG WebMap ID that can be used in DOM elements

Source:

Util.js, line 160

Returns:

Type: string

<static> uniqueId() → {string}

Generate a unique BKG WebMap ID that can be used in DOM elements

Source:

Util.js, line 484

Returns:

Type: string

<static> xmlToJson(xml) → {object}

Converts XML to JSON format

Parameters:

Name	Type	Description
`xml`	object	XML as JavaScript object

Source:

Util.js, line 169

Returns:

Type: object

<static> xmlToJson(xml) → {object}

Converts XML to JSON format

Parameters:

Name	Type	Description
`xml`	object	XML as JavaScript object

Source:

Util.js, line 493

Returns:

Type: object

BKGWebMap. Util

Source:

Util.js, line 1

Members

<static> layerId :number

Counter for layer IDs

Source:

Util.js, line 305

<static> layerId :number

Counter for layer IDs

Source:

Util.js, line 629

Methods

<static> cssParser(cssString) → {object}

Generate object with css properties from a string

Parameters:

Name	Type	Description
`cssString`	string	String to parse

Source:

Util.js, line 468

Returns:

Type: object

<static> cssParser(cssString) → {object}

Generate object with css properties from a string

Parameters:

Name	Type	Description
`cssString`	string	String to parse

Source:

Util.js, line 144

Returns:

Type: object

<static> deepCopy(obj) → {object}

Creates a deep copy of an object

Parameters:

Name	Type	Description
`obj`	object	Object to copy

Source:

Util.js, line 65

Returns:

Type: object

<static> deepCopy(obj) → {object}

Creates a deep copy of an object

Parameters:

Name	Type	Description
`obj`	object	Object to copy

Source:

Util.js, line 389

Returns:

Type: object

<static> each(elements, method)

Iterates over arrays

Parameters:

Name	Type	Description
`elements`	array	Array that this method is being applied to
`method`	function	Function to be executed for each element

Source:

Util.js, line 12

<static> each(elements, method)

Iterates over arrays

Parameters:

Name	Type	Description
`elements`	array	Array that this method is being applied to
`method`	function	Function to be executed for each element

Source:

Util.js, line 336

<static> extend(obj1, obj2) → {object}

Extends an object using properties of a second object. Common properties will be overwritten.

Parameters:

Name	Type	Description
`obj1`	object	Object to extend.
`obj2`	object	Object to get new properties.

Source:

Util.js, line 84

Returns:

Type: object

<static> extend(obj1, obj2) → {object}

Extends an object using properties of a second object. Common properties will be overwritten.

Parameters:

Name	Type	Description
`obj1`	object	Object to extend.
`obj2`	object	Object to get new properties.

Source:

Util.js, line 408

Returns:

Type: object

<static> findGeometryType(features) → {object}

Find geometry type of features

Parameters:

Name	Type	Description
`features`	array	Array with OpenLayers features

Source:

Util.js, line 589

Returns:

Type: object

<static> findGeometryType(features) → {object}

Find geometry type of features

Parameters:

Name	Type	Description
`features`	array	Array with OpenLayers features

Source:

Util.js, line 265

Returns:

Type: object

<static> generateLayerId() → {string}

Generate ID for layers to use in permalink

Source:

Util.js, line 311

Returns:

Type: string

<static> generateLayerId() → {string}

Generate ID for layers to use in permalink

Source:

Util.js, line 635

Returns:

Type: string

<static> getLayerExtent(layer, projection) → {ol.Extent}

Returns the extent of the given layer. Depending on the layer type the access to the extent may vary.

Parameters:

Name	Type	Description
`layer`	ol.layer.Layer	the layer from which to retrieve the extent
`projection`	ol.proj.Projection	optional target projection for layer

Source:

Util.js, line 674

Returns:

Type: ol.Extent

<static> getObjValueFromStringPath(obj, propertyPath) → {object}

Get a value from an object using a string path in dot notation

Parameters:

Name	Type	Description
`obj`	object	Object to search.
`propertyPath`	string	String path in dot notation.

Source:

Util.js, line 132

Returns:

Type: object

<static> getObjValueFromStringPath(obj, propertyPath) → {object}

Get a value from an object using a string path in dot notation

Parameters:

Name	Type	Description
`obj`	object	Object to search.
`propertyPath`	string	String path in dot notation.

Source:

Util.js, line 456

Returns:

Type: object

<static> getSessionToken(appID, appDomain, callback) → {function}

Generate a Session-Token for secure BKG services

Parameters:

Name	Type	Description
`appID`	string
`appDomain`	string
`callback`	function	Callback function

Source:

Util.js, line 535

Returns:

Type: function

<static> getSessionToken(appID, appDomain, callback) → {function}

Generate a Session-Token for secure BKG services

Parameters:

Name	Type	Description
`appID`	string
`appDomain`	string
`callback`	function	Callback function

Source:

Util.js, line 211

Returns:

Type: function

<static> hasNestedProperty(obj, propertyPath) → {boolean}

Checks if an object has a nested property

Parameters:

Name	Type	Description
`obj`	object	The object to test
`propertyPath`	string	Path of property. Syntax: 'prop1.prop2.prop3...'

Source:

Util.js, line 433

Returns:

Type: boolean

<static> hasNestedProperty(obj, propertyPath) → {boolean}

Checks if an object has a nested property

Parameters:

Name	Type	Description
`obj`	object	The object to test
`propertyPath`	string	Path of property. Syntax: 'prop1.prop2.prop3...'

Source:

Util.js, line 109

Returns:

Type: boolean

<static> map(method, elements) → {array}

Maps elements of array. It creates a new array with the results of calling a method for every array element. You can pass further static arguments to the method.

Parameters:

Name	Type	Description
`method`	function	Function to be run for each element in the array
`elements`	array	Array that this method is being applied to

Source:

Util.js, line 367

Returns:

Type: array

<static> map(method, elements) → {array}

Maps elements of array. It creates a new array with the results of calling a method for every array element. You can pass further static arguments to the method.

Parameters:

Name	Type	Description
`method`	function	Function to be run for each element in the array
`elements`	array	Array that this method is being applied to

Source:

Util.js, line 43

Returns:

Type: array

<static> reverseEach(elements, method)

Iterates reverse over arrays

Parameters:

Name	Type	Description
`elements`	array	Array that this method is being applied to
`method`	function	Function to be executed for each element

Source:

Util.js, line 351

<static> reverseEach(elements, method)

Iterates reverse over arrays

Parameters:

Name	Type	Description
`elements`	array	Array that this method is being applied to
`method`	function	Function to be executed for each element

Source:

Util.js, line 27

<static> shouldCreatePanel(controls) → {boolean}

Determine if we need to create a panel

Parameters:

Name	Type	Description
`controls`	object	Object with controls configuration

Source:

Util.js, line 235

Returns:

Type: boolean

<static> shouldCreatePanel(controls) → {boolean}

Determine if we need to create a panel

Parameters:

Name	Type	Description
`controls`	object	Object with controls configuration

Source:

Util.js, line 559

Returns:

Type: boolean

<static> uniqueId() → {string}

Generate a unique BKG WebMap ID that can be used in DOM elements

Source:

Util.js, line 160

Returns:

Type: string

<static> uniqueId() → {string}

Generate a unique BKG WebMap ID that can be used in DOM elements

Source:

Util.js, line 484

Returns:

Type: string

<static> xmlToJson(xml) → {object}

Converts XML to JSON format

Parameters:

Name	Type	Description
`xml`	object	XML as JavaScript object

Source:

Util.js, line 169

Returns:

Type: object

<static> xmlToJson(xml) → {object}

Converts XML to JSON format

Parameters:

Name	Type	Description
`xml`	object	XML as JavaScript object

Source:

Util.js, line 493

Returns:

Type: object