Function

Static Public Summary
public	addTooltip($element: jQuery, text: string)
public	asObject(argument: *): Object return argument as object (if it is no object the value is {})
public	asyncImageLoad(image: HTMLImageElement, origUrl: URL, finalUrl: string): Promise
public	changeTooltip($element: jQuery, text: string)
public	checkFor(configurationObject: Object, label: String): boolean Check for a label in a configuration object
public	copy(object: Object): Object Copy an object
public	copyDeep(object: Object): Object Deep copy an object
public	createMapInternal(element: , args: , defaultConfigs: ):
public	even(value: Object): Boolean Checks whether an argument can be interpreted as an even integer
public	filterText(text: string): string Filters text from user input
public	finishAllImages($object: jQuery): Promise finishs loading all images contained in the given jQuery object.
public	getConfig(config: object, name: string): object Gets the subconfig or an empty object
public	getInFront($element: jQuery, $context: jQuery) This function gets an $element inside a $context in fornt of all of them
public	getRegisteredModules(): *
public	html2Text(stringWithHTML: *): string Takes a string with HTML and returns the containing resulting text.
public	layerConfigConverter(layerConfig: ):
public	merge(obj1: Object, obj2: Object): Object A simple object merge function.
public	mergeDeep(obj1: Object, obj2: Object): Object A simple reverse object merge function.
public	mixin(baseClass: , mixinClasses: ): class This creates a new class which inherits from the base class and mixes in every method (except any method named 'initialize') from the mixin class.
public	mixinAsClass(mixinClass: *): class This returns a mixin as a normal class.
public	multiplyExtent(extent: ol.Extent, value: number): ol.Extent returns an extent with the same center but width and height miltiplied by the given value
public	odd(value: Object): Boolean Checks whether an argument can be interpreted as an even integer
public	offset($one: jQuery, $other: jQuery): {top: number, left: number} calculates the distance between one and another jQuery element
public	recursiveSelect($elem: jQuery, query: string): jQuery selects all matching elements and child elements
public	registerModule(module: *)
public	restoreText(text: string): string Restores the text
public	showInteractionActivity(map: *)
public	take(object: Object, prop: String): * Removes a property from an object and returns its value
public	urlDirname(url: string): string A function that tries to get the dir url of an url
public	urlIsAbsolute(url: string): boolean
public	urlJoin(urlRoot: string, urlExt: string): string A function that adds urls
public	urlNormalize(url: string): string A function that normalizes a url
public	urlRelative(source: string, target: string): string A function that tries to get the relative url between to urles

Static Public

public addTooltip($element: jQuery, text: string) source

import {addTooltip} from 'guide4you/src/html/html.js'

Params:

Name	Type	Attribute	Description
$element	jQuery
text	string

public asObject(argument: *): Object source

import {asObject} from 'guide4you/src/utilities.js'

return argument as object (if it is no object the value is {})

Params:

Name	Type	Attribute	Description
argument	*

Return:

Object

public asyncImageLoad(image: HTMLImageElement, origUrl: URL, finalUrl: string): Promise source

import {asyncImageLoad} from 'guide4you/src/utilities.js'

Params:

Name	Type	Attribute	Description
image	HTMLImageElement
origUrl	URL
finalUrl	string	optional

Return:

Promise

public changeTooltip($element: jQuery, text: string) source

import {changeTooltip} from 'guide4you/src/html/html.js'

Params:

Name	Type	Attribute	Description
$element	jQuery
text	string

public checkFor(configurationObject: Object, label: String): boolean source

import {checkFor} from 'guide4you/src/utilities.js'

Check for a label in a configuration object

Params:

Name	Type	Attribute	Description
configurationObject	Object		a configuration object
label	String		a label to check for

Return:

boolean

true if label present and true, false otherwise

public copy(object: Object): Object source

import {copy} from 'guide4you/src/utilitiesObject.js'

Copy an object

Params:

Name	Type	Attribute	Description
object	Object

Return:

Object

public copyDeep(object: Object): Object source

import {copyDeep} from 'guide4you/src/utilitiesObject.js'

Deep copy an object

Params:

Name	Type	Attribute	Description
object	Object

Return:

Object

public createMapInternal(element: , args: , defaultConfigs: ): source

import {createMapInternal} from 'guide4you/src/main.js'

Params:

Name	Type	Attribute	Description
element	*
args	*
defaultConfigs	*

Return:

public even(value: Object): Boolean source

import {even} from 'guide4you/src/utilities.js'

Checks whether an argument can be interpreted as an even integer

Params:

Name	Type	Attribute	Description
value	Object		A value of any type

Return:

Boolean

True when value is numeric, parses as an integer (no matter if decimal, octal or sexadecimal)

public filterText(text: string): string source

import {filterText} from 'guide4you/src/xssprotection.js'

Filters text from user input

Params:

Name	Type	Attribute	Description
text	string

Return:

string

public finishAllImages($object: jQuery): Promise source

import {finishAllImages} from 'guide4you/src/utilities.js'

finishs loading all images contained in the given jQuery object.

Params:

Name	Type	Attribute	Description
$object	jQuery

Return:

Promise

public getConfig(config: object, name: string): object source

import {getConfig} from 'guide4you/src/utilities.js'

Gets the subconfig or an empty object

Params:

Name	Type	Attribute	Description
config	object
name	string

Return:

object

public getInFront($element: jQuery, $context: jQuery) source

import {getInFront} from 'guide4you/src/html/html.js'

This function gets an $element inside a $context in fornt of all of them

Params:

Name	Type	Attribute	Description
$element	jQuery
$context	jQuery

public getRegisteredModules(): * source

import {getRegisteredModules} from 'guide4you/src/moduleRegistration.js'

Return:

public html2Text(stringWithHTML: *): string source

import {html2Text} from 'guide4you/src/utilities.js'

Takes a string with HTML and returns the containing resulting text.

Params:

Name	Type	Attribute	Description
stringWithHTML	*		string with encoded HTML entities

Return:

string

public layerConfigConverter(layerConfig: ): source

import {layerConfigConverter} from 'guide4you/src/layerSelector/layerConfigConverter.js'

Params:

Name	Type	Attribute	Description
layerConfig	*

Return:

public merge(obj1: Object, obj2: Object): Object source

import {merge} from 'guide4you/src/utilitiesObject.js'

A simple object merge function. merges all keys of obj2 to obj1.

Params:

Name	Type	Attribute	Description
obj1	Object		the object which will be merged into
obj2	Object		the object that will be merged into obj1

Return:

Object

public mergeDeep(obj1: Object, obj2: Object): Object source

import {mergeDeep} from 'guide4you/src/utilitiesObject.js'

A simple reverse object merge function. merges all keys of obj2 to obj1.

Params:

Name	Type	Attribute	Description
obj1	Object		the object which will be merged into
obj2	Object		the object that will be merged into obj1

Return:

Object

public mixin(baseClass: , mixinClasses: ): class source

import {mixin} from 'guide4you/src/utilities.js'

This creates a new class which inherits from the base class and mixes in every method (except any method named 'initialize') from the mixin class. The mixin class may not overwrite any existing method. If it has a method called 'initialize' this will be remembered and called after the constructor of the base class has finished

Params:

Name	Type	Attribute	Description
baseClass	*
mixinClasses	*

Return:

class

public mixinAsClass(mixinClass: *): class source

import {mixinAsClass} from 'guide4you/src/utilities.js'

This returns a mixin as a normal class.

Params:

Name	Type	Attribute	Description
mixinClass	*

Return:

class

public multiplyExtent(extent: ol.Extent, value: number): ol.Extent source

import {multiplyExtent} from 'guide4you/src/extent.js'

returns an extent with the same center but width and height miltiplied by the given value

Params:

Name	Type	Attribute	Description
extent	ol.Extent
value	number

Return:

ol.Extent

public odd(value: Object): Boolean source

import {odd} from 'guide4you/src/utilities.js'

Checks whether an argument can be interpreted as an even integer

Params:

Name	Type	Attribute	Description
value	Object		A value of any type

Return:

Boolean

True when value is numeric, parses as an integer (no matter if decimal, octal or sexadecimal)

public offset($one: jQuery, $other: jQuery): {top: number, left: number} source

import {offset} from 'guide4you/src/utilities.js'

calculates the distance between one and another jQuery element

Params:

Name	Type	Attribute	Description
$one	jQuery
$other	jQuery

Return:

{top: number, left: number}

public recursiveSelect($elem: jQuery, query: string): jQuery source

import {recursiveSelect} from 'guide4you/src/utilities.js'

selects all matching elements and child elements

Params:

Name	Type	Attribute	Description
$elem	jQuery
query	string

Return:

jQuery

public registerModule(module: *) source

import {registerModule} from 'guide4you/src/moduleRegistration.js'

Params:

Name	Type	Attribute	Description
module	*

public restoreText(text: string): string source

import {restoreText} from 'guide4you/src/xssprotection.js'

Restores the text

Params:

Name	Type	Attribute	Description
text	string

Return:

string

public showInteractionActivity(map: *) source

import {showInteractionActivity} from 'guide4you/src/utilities.js'

Params:

Name	Type	Attribute	Description
map	*

public take(object: Object, prop: String): * source

import {take} from 'guide4you/src/utilitiesObject.js'

Removes a property from an object and returns its value

Params:

Name	Type	Attribute	Description
object	Object
prop	String

Return:

public urlDirname(url: string): string source

import {urlDirname} from 'guide4you/src/utilities.js'

A function that tries to get the dir url of an url

Params:

Name	Type	Attribute	Description
url	string

Return:

string

public urlIsAbsolute(url: string): boolean source

import {urlIsAbsolute} from 'guide4you/src/utilities.js'

Params:

Name	Type	Attribute	Description
url	string

Return:

boolean

public urlJoin(urlRoot: string, urlExt: string): string source

import {urlJoin} from 'guide4you/src/utilities.js'

A function that adds urls

Params:

Name	Type	Attribute	Description
urlRoot	string
urlExt	string

Return:

string

public urlNormalize(url: string): string source

import {urlNormalize} from 'guide4you/src/utilities.js'

A function that normalizes a url

Params:

Name	Type	Attribute	Description
url	string

Return:

string

public urlRelative(source: string, target: string): string source

import {urlRelative} from 'guide4you/src/utilities.js'

A function that tries to get the relative url between to urles

Params:

Name	Type	Attribute	Description
source	string
target	string

Return:

string

Function

Static Public

public addTooltip($element: jQuery, text: string) source

Params:

public asObject(argument: *): Object source

Params:

Return:

public asyncImageLoad(image: HTMLImageElement, origUrl: URL, finalUrl: string): Promise source

Params:

Return:

public changeTooltip($element: jQuery, text: string) source

Params:

public checkFor(configurationObject: Object, label: String): boolean source

Params:

Return:

public copy(object: Object): Object source

Params:

Return:

public copyDeep(object: Object): Object source

Params:

Return:

public createMapInternal(element: *, args: *, defaultConfigs: *): * source

Params:

Return:

public even(value: Object): Boolean source

Params:

Return:

public filterText(text: string): string source

Params:

Return:

public finishAllImages($object: jQuery): Promise source

Params:

Return:

public getConfig(config: object, name: string): object source

Params:

Return:

public getInFront($element: jQuery, $context: jQuery) source

Params:

public getRegisteredModules(): * source

Return:

public html2Text(stringWithHTML: *): string source

Params:

Return:

public layerConfigConverter(layerConfig: *): * source

Params:

Return:

public merge(obj1: Object, obj2: Object): Object source

Params:

Return:

public mergeDeep(obj1: Object, obj2: Object): Object source

Params:

Return:

public mixin(baseClass: *, mixinClasses: *): class source

Params:

Return:

public mixinAsClass(mixinClass: *): class source

Params:

Return:

public multiplyExtent(extent: ol.Extent, value: number): ol.Extent source

Params:

Return:

public odd(value: Object): Boolean source

Params:

Return:

public offset($one: jQuery, $other: jQuery): {top: number, left: number} source

Params:

Return:

public recursiveSelect($elem: jQuery, query: string): jQuery source

Params:

Return:

public registerModule(module: *) source

Params:

public restoreText(text: string): string source

Params:

Return:

public showInteractionActivity(map: *) source

Params:

public take(object: Object, prop: String): * source

Params:

Return:

public createMapInternal(element: , args: , defaultConfigs: ): source

public layerConfigConverter(layerConfig: ): source

public mixin(baseClass: , mixinClasses: ): class source