Class: ThemeModel

Tools.GFI.Themes ThemeModel

ThemeModel

new ThemeModel()

modules/tools/gfi/themes/model.js, line 25
Properties:
Name Type Default Description
isVisible Boolean false the theme is visible
name String Layer name = Theme Title
isReady= Boolean Theme has queried and edited GFI attributes
infoFormat * Info Format for WMS-GFI
bestMatchingInfoFormat * The best matching info format as detected through capabilities
availableInfoFormats Array.<String> The available info formats retrieved from capabilities
gfiContent * GFI-Attributs
uiStyle String "default" uiStyle Setting
Fires:

Extends

Methods

allKeysToLowerCase(obj){object}

modules/tools/gfi/themes/model.js, line 735
set all keys from object to lowercase
Name Type Description
obj object key value pairs
Returns:
with lowercase keys

beautifyString(str){void}

modules/tools/gfi/themes/model.js, line 518
helper function: first letter upperCase, _ becomes " "
Name Type Description
str string String to be beautified

checkIfMatchesValid(origName, condition, matches){Boolean}

modules/tools/gfi/themes/model.js, line 715
Checks if the matches have exact one entry.
Name Type Description
origName String The name to be proofed against the keys.
condition String Matching conditon.
matches Array.<String> An array of all keys matching the condition.
Returns:
Flag of array has exacly one entry.

checkLayerQueryable(response){boolean}

modules/tools/gfi/themes/model.js, line 853
Simple check if layer is queryable.
Name Type Description
response any Response of GetFeatureInfo request
Returns:
if response contains `LayerNotQueryable` error message

cloneCollModels(pgfi){void}

modules/tools/gfi/themes/model.js, line 427
Clones the models in the collection when a service returns more than one GFI query feature..
Name Type Description
pgfi object pgfi

createGfiUrl(url, useProxy){String}

modules/tools/gfi/themes/model.js, line 752
Check if cors proxy is needed and create url Also set the output format to a desired / available value
Name Type Description
url string target wms service url
useProxy Boolean true if cors proxy needed
Returns:
target url for get feature info

get3DFeatureGfi(){void}

modules/tools/gfi/themes/model.js, line 450
adds the gfiContent for a 3D Cesium TileFeature or a 3d Cesium Entity. The Attributes are saved directly at the model in the attributes property

getManipulateDate(content){object}

modules/tools/gfi/themes/model.js, line 799
Checks all values and checks if it is a "DD-MM-YYYY"-compliant date. If yes, it will be converted to DD.MM.YYYY format.
Name Type Description
content object GFI Attributes

getMultiTags(node){Array.<string>}

modules/tools/gfi/themes/model.js, line 274
Returns multiple attribute names in XML features.
Name Type Description
node xml Feature-Node

getVectorGfi(){void}

modules/tools/gfi/themes/model.js, line 463
todo add jsdoc info about this function

getWmsCapabilities(useProxy, withCredentials){void}

modules/tools/gfi/themes/model.js, line 124
Requestor function for Capabilities of WMS layers to determine available info formats
Name Type Description
useProxy boolean flag to indicate if CORS proxy should be used
withCredentials boolean flag to indicate if credentials should be used

getWmsGfi(url, useProxy, withCredentials){void}

modules/tools/gfi/themes/model.js, line 226
Requestor function for GFI of WMS layers
Name Type Description
url string wms adress for get feature info request
useProxy boolean flag to indicate if CORS proxy should be used
withCredentials boolean flag to indicate if credentials should be used
Fires:

getWmsHtmlGfi(url, useProxy, withCredentials){void}

modules/tools/gfi/themes/model.js, line 86
Requestor function for GFI of WMS layers with infoFormat "text/html"
Name Type Description
url string wms adress for get feature info request
useProxy boolean flag to indicate if CORS proxy should be used
withCredentials boolean flag to indicate if credentials should be used
Fires:

gfiErrorHandler(jqXHR){void}

modules/tools/gfi/themes/model.js, line 263
Error handler for unanswered GFI requests
Name Type Description
jqXHR object error object
Fires:

isMultiTag(str){void}

modules/tools/gfi/themes/model.js, line 527
helper function to provide information about a "multiTag" attribute on a non parsed JSON string
Name Type Description
str string JSON string to parse and to check

isValidKey(key){boolean}

modules/tools/gfi/themes/model.js, line 484
Checks validity of a key according to configured list of ignored keys
Name Type Description
key string Name of the key
Fires:
Returns:
returns the validita of a key

isValidValue(value){boolean}

modules/tools/gfi/themes/model.js, line 500
checks if the value is a string or array and if it is a string, whether the value is unequal to NULL or an empty string
Name Type Description
value string | Array value
Returns:
or false

parseMultiElementNodes(xml){void}

modules/tools/gfi/themes/model.js, line 319
Replace multi attributes of a feature
Name Type Description
xml xml GFI

parseWmsCapabilities(data){void}

modules/tools/gfi/themes/model.js, line 172
Parse capabilities and set the available info formats
Name Type Description
data String The capabilities XML document

parseWmsGfi(data){void}

modules/tools/gfi/themes/model.js, line 335
Parse feature info response of a WMS
Name Type Description
data string | xml response to parse

parseWmsHtmlGfi(data, url){void}

modules/tools/gfi/themes/model.js, line 188
Parse response for WMS as text/html
Name Type Description
data string response as html
url string wms adress for get feature info request

removeIFrameAttributes(preGfi, prefix){Object}

modules/tools/gfi/themes/model.js, line 624
Removes Attributes from the preGfi object that start with the given string. Currently used only for sensor-Theme.
Name Type Description
preGfi Object preGfi.
prefix String String condition each attributes starts with.
Returns:
The pregfi without the attributes starting with string.

replaceMultiNodes(multiTags, childNode){void}

modules/tools/gfi/themes/model.js, line 296
Replaces the multiTags of a feature with a tag with accumulated value.
Name Type Description
multiTags Array.<string> multiple tags in one feature
childNode xml Feature-Node

requestFeatureInfos(){void}

modules/tools/gfi/themes/model.js, line 40
Requestor for feature informations on all layer types

setGfiContent(value){void}

modules/tools/gfi/themes/model.js, line 834
Setter for gfiContent
Name Type Description
value object Value for gfiContent
Fires:

setIsReady(value){void}

modules/tools/gfi/themes/model.js, line 844
Setter for isReady
Name Type Description
value boolean Value for isReady

setIsVisible(value){void}

modules/tools/gfi/themes/model.js, line 824
Setter for isVisible
Name Type Description
value boolean Value for isVsible

setUiStyle(value){void}

modules/tools/gfi/themes/model.js, line 815
Setter for uiStyle
Name Type Description
value string Value for uiStyle

showLayerNotQueryableMessage(){void}

modules/tools/gfi/themes/model.js, line 871
Shows an error message that the layer is not querable

translateGFI(gfiList, gfiAttributes){Array.<object>}

modules/tools/gfi/themes/model.js, line 548
Selector of feature infos to show
Name Type Description
gfiList Array.<object> gfiList list array with feature infos
gfiAttributes string | object Flag to describe necessary gfi infos "ignore" || "showAll" or specific list of objects
Returns:
List of objects

translateNameFromObject(preGfi, origName, condition){String}

modules/tools/gfi/themes/model.js, line 673
Translates the given name from gfiAttribute Object based on the condition type
Name Type Description
preGfi Object Object of all values that the feature has.
origName String The name to be proofed against the keys.
condition Object GFI-Attribute Object.
Returns:
name if condition matches exactly one key.

Events

inherited RadioRequestGFIGetRequestedParcelId

devtools/jsdoc/events.js, line 2447
Todo