_global_ (data)

_global_

Properties

{String} color of the background

{Object} basic group for layers, which are not within other group

0 - unchecked 1 - checked - all layers visible 2 - checked - only selected layers visible

{Object} Hashtable of default parameter key/value pairs

appropriate default value from OpenLayers

Set to false for this layer type

{String} className for layers, which are listed in no group

{Array(String)} Supported application event types. Register a listener
for a particular event with the following syntax:

Added “layerloaded” event

{<OpenLayers.Feature.Vector>} The current editable feature.

Url for getting MAP file structure. If this property is empty, property url will be used.

{Array(Object)} List of groups of this layer

{Object} groupName: “Title in layer switcher” If not set, groupName is used

Base Help Service class with global methods and variables, common for all applications

{String} className of layer aditional icons

{Boolean} Was the layer and groups initialized ?

{Array of String} - layer names which will be set as visible

Layers that are attached to this container. Required config option.

{DOMElement} Element, where the layer list is stored

{Double} maximal value

{Double} minimal value

{Boolean} Set, if the groups are mutual disabled

{Object} Mapping of namespace aliases to namespace URIs.

type Ext.Button

{<OpenLayers.Geometry.Point>} The currently snapped vertex.

Contains public functions, grouped by namespace prefix, that will
be applied when a namespaced node is found matching the function name. The function will be applied in the scope of this parser with two arguments: the node being read and a context object passed from the parent.

Compiled regular expressions for manipulating strings.

{Float} The map resolution for the previously considered snap.

{Boolean} Should the Rico rounding object be used?

{String} Schema location

Default target properties.

{Boolean} Wheather the map should be single tiled or not

{String} Some text in the tip

{Integer} step

{Boolean} indicates, whether the Maximize and Minimize buttons are drawed

{String} The transition effect to use when the map is panned or
zoomed.

{String}

{String} 1.0.0

{<OpenLayers.Geometry.Point>} last vertex in the feature

{Integer} Slider width in pixels

_global_.activeColor

Property: activeColor {String} color of the background

_global_.baseGroup

Property: baseGroup {Object} basic group for layers, which are not within other group

_global_.bounds

paper box

_global_.capabilities

GetCapabilities response

_global_.checkState

check state 0 - unchecked 1 - checked - all layers visible 2 - checked - only selected layers visible

_global_.DEFAULT_PARAMS

Constant: DEFAULT_PARAMS {Object} Hashtable of default parameter key/value pairs

_global_.DEFAULT_STYLE_ATTRIBUTE_VALUE

Get default value for style attribute. This value correspond to appropriate default value from OpenLayers

_global_.defaultAutoCreate
_global_.defaultColor
_global_.defaultPrefix

Property: defaultPrefix

_global_.dftUrl

Describe Feature Type URL

_global_.displayClass
Type :String

displayClass

_global_.displayInLayerSwitcher

Property: displayInLayerSwitcher Set to false for this layer type

_global_.edit

edit configuration

_global_.editLayer
Type :HSLayers.Layer.MapServer

edit layer

_global_.emptyGroupName

Property: emptyGroupName {String} className for layers, which are listed in no group

_global_.EVENT_TYPES

Constant: EVENT_TYPES {Array(String)} Supported application event types. Register a listener for a particular event with the following syntax:

Added “layerloaded” event
_global_.events
Type :[OpenLayers.Events]

events list of events

_global_.extForm

ext form object

_global_.feature

Property: feature {<OpenLayers.Feature.Vector>} The current editable feature.

_global_.featureType

Feature type name

_global_.filterWindow

Filter window

_global_.formId
Type :String

form div id

_global_.getLayersUrl

Property: getLayersUrl Url for getting MAP file structure. If this property is empty, property url will be used.

_global_.groups

Property: groups {Array(Object)} List of groups of this layer

_global_.groupTitles

Property: groupTitles {Object} groupName: “Title in layer switcher” If not set, groupName is used

_global_.HS

Class: HS Base Help Service class with global methods and variables, common for all applications

_global_.hsLayerIcon

Property: hsLayerIcon {String} className of layer aditional icons

_global_.initialized

Property: initialized {Boolean} Was the layer and groups initialized ?

_global_.initialVisibleLayers

Property: initialVisibleLayers {Array of String} - layer names which will be set as visible

_global_.JSON

Instance of OpenLayers.Format.JSON for use in conversions

_global_.keyboardHandler
Type :OpenLayers.Handler.Keyboard

keyboard handler

_global_.layer
Type :OpenLayers.Layer

layer

_global_.layers

APIProperty: layers Layers that are attached to this container. Required config option.

_global_.layersDiv

Property: layersDiv {DOMElement} Element, where the layer list is stored

_global_.layout
Type :String

layout

_global_.lengthText
_global_.map
_global_.maxValue

Property: maxValue {Double} maximal value

_global_.minValue

Property: minValue {Double} minimal value

_global_.mutualExclusion

Property: mutualExclusion {Boolean} Set, if the groups are mutual disabled

_global_.namespaces

Property: namespaces {Object} Mapping of namespace aliases to namespace URIs.

_global_.navigationModifierPressed

navigationModifierPressed

_global_.pause

Pause while playing between steps in miliseconds

_global_.play

play button type Ext.Button

_global_.point

Property: point {<OpenLayers.Geometry.Point>} The currently snapped vertex.

_global_.properties

Feature type properties

_global_.readers

Property: readers Contains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name. The function will be applied in the scope of this parser with two arguments: the node being read and a context object passed from the parent.

_global_.regExes

Property: regExes Compiled regular expressions for manipulating strings.

_global_.resolution

Property: resolution {Float} The map resolution for the previously considered snap.

_global_.roundCorner

Property: roundCorner {Boolean} Should the Rico rounding object be used?

_global_.schemaLocation

Property: schemaLocation {String} Schema location

_global_.SERVER_DEFAULTS

CONSTANT: DEFAULTS Default target properties.

_global_.serverSnapScript

URL

_global_.serviceType

service

_global_.showHexValue
_global_.singleTile

Property: singleTile {Boolean} Wheather the map should be single tiled or not

_global_.slider
Type :Ext.Slider

Slider itself

_global_.sliderTipText

Property: sliderTipText {String} Some text in the tip

_global_.snapping
Type :Integer

snapping radius in pixels

_global_.step

Property: step {Integer} step

_global_.store

Data store, in which the files are loaded in

_global_.styleMap
Type :OpenLayers.StyleMap

styleMap for edited features

_global_.switcherIsVisible

Property: switcherIsVisible {Boolean} indicates, whether the Maximize and Minimize buttons are drawed

_global_.target
_global_.tip
Type :Ext.ToolTip

Tooltip

_global_.transitionEffect

Property: transitionEffect {String} The transition effect to use when the map is panned or zoomed.

_global_.triggerClass
_global_.type

One of two file dialog types: ‘load’ or ‘save’

Default Value:
save
_global_.units

Property: units {String}

_global_.url
_global_.values
Type :[Date]

list of values

_global_.VERSION

Constant: VERSION {String} 1.0.0

_global_.version

wfs version

_global_.vertex

Property: vertex {<OpenLayers.Geometry.Point>} last vertex in the feature

_global_.width

Property: width {Integer} Slider width in pixels

Methods

  • _global_.initialize() - Constructor: OpenLayers.Layer.Vector.RootContainer

Create a new root container for multiple vector layer. This constructor is not supposed to be used from user space, it is only to be used by controls that need feature selection across multiple vector layers.

Parameters: name - {String} A name for the layer options - {Object} Optional object with non-default properties to set on

the layer.

Required options properties: layers - {Array(<OpenLayers.Layer.Vector>)} The layers managed by this

container

Returns: {<OpenLayers.Layer.Vector.RootContainer>} A new vector layer root

container
  • _global_.display() - Method: display
  • _global_.getFeatureFromEvent() - Method: getFeatureFromEvent

walk through the layers to find the feature returned by the event

Parameters: evt - {Object} event object with a feature property

Returns: {<OpenLayers.Feature.Vector>}

  • _global_.setMap() - Method: setMap

Parameters: map - {<OpenLayers.Map>}

  • _global_.removeMap() - Method: removeMap

Parameters: map - {<OpenLayers.Map>}

  • _global_.collectRoots() - Method: collectRoots

Collects the root nodes of all layers this control is configured with and moves the nodes to this control’s layer

  • _global_.resetRoots() - Method: resetRoots

Resets the root nodes back into the layers they belong to.

  • _global_.handleChangeLayer() - Method: handleChangeLayer

Event handler for the map’s changelayer event. We need to rebuild this container’s layer dom if order of one of its layers changes. This handler is added with the setMap method, and removed with the removeMap method.

Parameters: evt - {Object}

  • _global_.read() - APIMethod: read

Parse a WPS DescribeProcess and return an object with its information.

Parameters: data - {String} or {DOMElement} data to read/parse.

Returns: {Object}

  • _global_.setValue() - getValue
  • _global_._gmlLayerFromURL() -
  • _global_.enable() - enable the field
  • _global_.disable() - disable the field
  • _global_.getValue() -
  • _global_.constructor() -
  • _global_.setInputValue() -
  • _global_.HSLayersEmbed() - General embedding of map into the HTML page
  • _global_.getFullRequestString() - Method: getFullRequestString

combine the layer’s url with its params and these newParams.

Parameter: newParams - {Object} New parameters that should be added to the

request string.
altUrl - {String} (optional) Replace the URL in the full request
string with the provided URL.

Returns: {String} A string with the layer’s url and parameters embedded in it.

  • _global_.getCheckedLayers() - Method: getCheckedLayers

Returns list of visible layers

Returns: {Array(String)} List of layer names

  • _global_.setLayerVisibility() - Method: setLayerVisibility

Will redraw the map with new layer visibility

Parameters: name - {String} layer name visibility - {Boolean}

  • _global_.setGroupVisibility() - Method: setGroupVisibility

Will redraw the map with new layers visibility

Parameters: name - {String} group name visibility - {Boolean}

  • _global_.getGroup() - Method: getGroup

Will return group

Parameters: name - {String} group name

Returns: {Object} group

  • _global_.getLayer() - Method: getLayer

Will return layer

Parameters: name - {String} layer name group - {Object} base group object

Returns: {Object} layer

  • _global_.requestSuccess() - Method: requestSuccess

Process JSON after it has been loaded. Called by setMap()

Parameters: request - {String}

  • _global_.setBouble() - Method: setBouble

add boubeling function to all group objects

  • _global_.initLayersVisibility() - Method: initLayersVisibility

Initialize visibility of layers by property initialVisibleLayers

Parameters: obj - {Object} group or layer object

  • _global_.initLayerVisibility() - Method: initLayerVisibility

Initialize visibility of layer by property initialVisibleLayers

Parameters: layer - {Object} layer object

  • _global_.initGroup() - Method: initGroup

Initialize group of layers

Parameters: group - {Object} group object

  • _global_.requestFailure() - Method: requestFailure

Process a failed loading of GML. Called by initialise() and loadUrl() if there was a problem loading GML.

Parameters: request - {String}

  • _global_.onGroupsLoaded() - Method: onGroupsLoaded

To be rewritten

  • _global_.saltURL() - Method: saltURL

Add salt&paper parameter to given URL

  • _global_.setInitialVisibleLayers() - Method: setInitialVisibleLayers

Initialize visibility of layers by property initialVisibleLayers

Parameters: visibleLayers - {String} layer name

  • {Array of String} layer names
  • _global_.onGetCapabilitiesResponse() - Set filter capabilities from the GetCapabilities response

and request Describe Feature Type

  • _global_.onDescribeFeatureTypeResponse() - Set properties from the DescribeFeatureType response
  • _global_.getCoverageUrl() - getCoverage url for actual extend and map properties
  • _global_.destroy() - destroy
  • _global_.fillPropertiesForm() - fill properties form with data
  • _global_.parseWMSOptions() - Search given attribute in the input XML
  • _global_.featureInList() - feature in given array
  • _global_.getLayerMetadataUrl() - return object with layer metadataURL
  • _global_.requestGetCapabilities() - Request WFS Capabilities

Here we use the OWS proxy and give it some extra parameters to let it know that we want WFS

  • _global_.makePropertiesForm() - make properties form
  • _global_.onFeatureSelect() - Feature selected
  • _global_.onFeatureUnselect() - Feature unselect
  • _global_.onaddLayer() - handler of the new layer add event - rewritten from MapViewer
  • _global_.updateFeatureCountInfo() - set information about feature count to bbar
  • _global_.updateFeatureLengthInfo() - set information about features length to bbar
  • _global_.updateFeatureAreaInfo() - set information about features area to bbar
  • _global_.getValues() - get values from given time
  • _global_.onPlayClicked() - handle play click event
  • _global_.onLayerGroupLoadEnd() - handle play click event
  • _global_.onFromChange() - called when from/to time/date is changed
  • _global_.getClosestValue() - returns closest available time value
  • _global_._onOpacitySliderDrag() - ***************** Handlers *******************
  • _global_._registerPanelEvents() - register events
  • _global_.displayToolBar() - ce - linie

display the editing tool bar

  • _global_.onNewFeatureAdded() - feature added, add the attribute form
  • _global_.onExistingFeatureAdded() - feature added, add the attributes form
  • _global_.deleteFeature() - called, when deleted
  • _global_.clearPanel() - start editing new feature
  • _global_.onInputButtonClicked() - start manual input
  • _global_.onSnapChanged() - onSnapChanged in settings panel
  • _global_.onSnapParamsChanged() - onSnapParamsChanged
  • _global_.setSize() - Used to adjust the size of the popup.
  • _global_.onSearch() - Handler for the click event, triggered when the user clicks the

trigger button or hits ENTER key with focus on the search field This method should be redefined for each application.

  • _global_.connect() - connec to the service for given url and type
  • _global_.parseTimeValue() - parse time value
  • _global_.onPlusClicked() - clicked at the ‘+’ button for adding new keyword field, add new one
  • _global_.parsePermalink() - parse permalink data
  • _global_.getLayerAttribution() -
  • _global_.mergeNewParams() - mergeNewParams propagation from layer to group
  • _global_.openFilterWindow() - Open window with FES Filter
  • _global_.setFilter() - Set filter

Called by WFSFilterForm

  • _global_.draw() - Method: draw

calls the default draw, and then activates mouse defaults.

Returns: {DOMElement}

  • _global_.formatTip() - Property: formatTip

How the tooltip should be formated ‘this’ is this.slider

Return: {String} to be displayed as Slider’s tooltip

  • _global_.onDrag() - Method: onDrag

Slider moved

  • _global_.updateLimits() - Method: updateLimits

Update min, max, step

Parameters: min - {Double} max - {Double} step - {Double}

  • _global_.activate() -
  • _global_.getState() - destroy
  • _global_.findLayer() - Check for the given layer in JSON if it is already present in the map.

Match criteria: name & layer type.

  • _global_.setHSLLayerMapServerVisibility() - Set visibility of HSLayers.Layer.MapServer layers
  • _global_.createContext() -
  • _global_.getAttributionNode() -
  • _global_.setColor() - Sets the current color and changes the background.

Does not change the value of the field.

  • _global_.getLayerGroup() - get group based on given layer
  • _global_.onActivityChanged() - some group activity was changed, if it was ‘activated’, deactivate

all other available ‘base’ groups

  • _global_.initNewGroup() - Method: initNewGroup

Initializes new group structure, appends new object to this.group

Properties: groupName - {String} group identifier

Returns: {Object} with new group:

  • title String
  • layers Array
  • visibility Boolean
  • _global_.appendLayerToGroup() - Method: appendLayerToGroup

Adds new layer to group, according to group, defined as Layer attribute

Properties: layer - {<OpenLayer.Layer>}

Returns: {Object} with group:

  • title String
  • layers Array
  • visibility Boolean
  • _global_.setGroupVisible() - Method: setGroupVisible

Toggle visibility for specified group

Properties: groupName {String}

  • _global_.rebuildLayerGroupObject() - Method: rebuldLayerGroupObject

Rebuilds this.groups object according to layers

  • _global_.redraw() - Method: redraw
Goes through and takes the current state of the Map and rebuilds the
control to display that state. Groups layers into groups.

Returns: {DOMElement} A reference to the DIV DOMElement containing the control

  • _global_.addLayer() - Method: addLayer

adds layer to parent ul element in layerSwicher

Parameters: layer - {OpenLayer.Layer} parentEl - {DOMElement}

  • _global_.makeMaxMinDivs() - Method: makeMaxMinDivs

Creates Minimazing and Maximizing controls

  • _global_.onGroupInputClick() - Method:

Called, when the user clickes on the Group name or input

Parameters: e - {Event}

Context:
  • {DOMElement} input
  • {<OpenLayers.Control.LayerSwitcher>} switcher
  • {String} groupName
  • _global_.onLayerInputClick() - Method:

A label has been clicked, check or uncheck its corresponding input

Parameters: e - {Event}

Context:
  • {DOMElement} input
  • {<OpenLayers.Control.LayerSwitcher>} switcher
  • {<OpenLayers.Layer>} layer
  • _global_.maximizeControl() - Method: maximizeControl

Set up the labels and divs for the control

Parameters: e - {Event}

  • _global_.minimizeControl() - Method: minimizeControl
Hide all the contents of the control, shrink the size,
add the maximize icon

Parameters: e - {Event}

  • _global_.showControls() - Method: showControls
Hide/Show all LayerSwitcher controls depending on whether we are
minimized or not

Parameters: minimize - {Boolean}

  • _global_.ignoreEvent() - Method: ignoreEvent

Parameters: evt - {Event}

  • _global_.mouseDown() - Method: mouseDown
Register a local ‘mouseDown’ flag so that we’ll know whether or not
to ignore a mouseUp event

Parameters: evt - {Event}

  • _global_.mouseUp() - Method: mouseUp
If the ‘isMouseDown’ flag has been set, that means that the drag was
started from within the LayerSwitcher control, and thus we can ignore the mouseup. Otherwise, let the Event continue.

Parameters: evt - {Event}

  • _global_.appendButtonDiv() - Method: appendButtonDiv

Creates div and appends it to parent element

Parameters: target - {String} or {Object} imgsrc - {String} layer - {OpenLayer.Layer} parentEl - {DOMElement} element, to which the metadata div will be

appended
  • _global_.onRemoveLayerClick() - Method: onRemoveLayerClick

Parameters: e - {Event}

Context:
  • {Layer} Layer
  • {Map} Map
  • {ls} LayerSwitcher
  • _global_.onClick() - On click handler: call the service
  • _global_.setLayer() - APIMethod: setLayer
Set the editable layer. Call the setLayer method if the editable layer
changes and the same control should be used on a new editable layer. If the control is already active, it will be active after the new layer is set.

Parameters: layer - {OpenLayers.Layer.Vector} The new editable layer.

  • _global_.deactivate() - APIMethod: deactivate
Deactivate the control. Deactivating the control unregisters listeners
so feature editing may proceed without engaging the snapping agent.
  • _global_.onVertexModified() - feture was modified, snap
  • _global_.onSketchStarted() - sketch started, set the style
  • _global_.getRadius() - get radius in pixels
  • _global_.afterFeatureModified() - feture was modified, snap
  • _global_.onSketchModified() - Method: onVertexModified
Registered as a listener for the vertexmodified event on the editable
layer.

Parameters: event - {Object} The vertex modified event.

  • _global_.considerSnapping() - Method: considerSnapping
  • _global_.snapToSelf() - Method: snapToSelf

Snap last point to first point, if needed

  • _global_.getGeoTolerance() - Method: getGeoTolerance

Calculate a tolerance in map units given a tolerance in pixels.

Parameters: tolerance - {Number} A tolerance value in pixels.

Returns: {Number} A tolerance value in map units.

  • _global_.update() - update relevant this parameters to the controls
  • _global_.updateParams() - updateParams - update snapParams
  • _global_.onEditButtonActivated() - set this drawing control to vector layer used by handler

deactivate ALL buttons in all different panles, which might be in the map

  • _global_.onSubmit() - common submit function
  • _global_.onSubmitSuccess() - on submit succeeded
  • _global_.onSubmitFailure() - on failed
  • _global_.finelizeFeature() - finelize currently digitized feature
  • _global_.setControl() - activate particular tool
  • _global_.clearForm() - Clears existing form element
  • _global_.onFormLoaded() - Form loaded, clear previous form, append form to element
  • _global_.getGrid() - getgrid
  • _global_.setBounds() - set box
  • _global_.setScale() - set scale
  • _global_.setResolution() - set resolution
  • _global_.toContext() - to context
  • _global_.write() - write map context to JSON
  • _global_.getLayers() - this function takes care, that only layers we are able to convert

into the context, will be converted

  • _global_.layerToContext() - Layer To Context
  • _global_.layerMapServerToContext() - Layer To Context
  • _global_.layerGridToContext() - Layer To Context
  • _global_.layerImageToContext() - Layer To Context
  • _global_.layerWithContextToContext() - some Layer with wms context To Context
  • _global_.layerHSWMSToContext() - HS.WMS Layer To Context
  • _global_.layerWMSToContext() - WMS Layer To Context
  • _global_.layerVectorToContext() - Layer To Context
  • _global_.getBasicLayerContext() - creates basic layer object
  • _global_.getRefence() - format reference map informations
  • _global_.map2string() - Converts the map from Map object to text in JSON notation.

Syntactic sugar for map2json() & OpenLayers.Format.JSON.write()

  • _global_.map2json() - Converts the map from Map object to JSON.

Uses layers2json().

Properties covered:

  • Map properties: scale, projection, center, title.
  • Layers properties: Those covered by layer2json().

The layer index is not covered, as we assume that it is corresponding to the layers order.

  • _global_.layers2string() - Converts map layers from array of Layer objects to text in JSON notation.

Syntactic sugar for layers2json() & OpenLayers.Format.JSON.write()

  • _global_.layers2json() - Converts map layers into a JSON object.

Uses layer2json().

  • _global_.layer2string() - Converts map layer from Layer object to text in JSON notation.

Syntactic sugar for layer2json() & OpenLayers.Format.JSON.write()

  • _global_.layer2json() - Converts map layer into a JSON object.
Layer properties covered: CLASS_NAME, name, url, params,

group, displayInLayerSwitcher, visibility, attribution, transitionEffect,

isBaseLayer, minResolution,

maxResolution, minScale, maxScale, metadata, abstract, opacity, singleTile, removable, queryable, legend, projections, wmsMinScale, wmsMaxScale

The layer index is not covered, as we assume that it is corresponding to the layers order.

  • _global_.json2string() - Syntactic sugar for OpenLayers.Format.JSON.write()
  • _global_.string2json() - Syntactic sugar for OpenLayers.Format.JSON.read()
  • _global_.string2layer() - Converts map layer from text in JSON notation to Layer object

Syntactic sugar for OpenLayers.JSON.read() & json2layer()

  • _global_.json2layer() - Converts map layer from JSON object to Layer object

Only OpenLayers.Layer.WMS layer type is supported in the moment. The layers of other types are silently discarded.

The following layer properties are covered: CLASS_NAME, name, url, params,
group, displayInLayerSwitcher, visibility, attribution, transitionEffect, isBaseLayer, minResolution, maxResolution, minScale, maxScale, metadata, abstract, opacity, singleTile, removable, queryable, legend, projections, wmsMinScale, wmsMaxScale
  • _global_.string2layers() - Converts map layers from text in JSON notation to array of Layer objects

Syntactic sugar for OpenLayers.JSON.read() & json2layers()

  • _global_.json2layers() - Converts map layers from JSON object to array of Layer objects.

Uses json2layer().

  • _global_.fetchLink() - Method: fetchLink

Fetches a URL and returns the result

Parameters: href - {String} url to be fetched

  • _global_.customizeExternalLink() - function to be redefined in the application

append needed parameters to external link url according to https://developers.google.com/kml/documentation/kmlreference#viewformat

initialize(name, options)
Constructor: OpenLayers.Layer.Vector.RootContainer

Create a new root container for multiple vector layer. This constructor is not supposed to be used from user space, it is only to be used by controls that need feature selection across multiple vector layers.

Parameters: name - {String} A name for the layer options - {Object} Optional object with non-default properties to set on the layer.

Required options properties: layers - {Array(<OpenLayers>)} The layers managed by this container

Returns: {<OpenLayers>} A new vector layer root container

param name:
param options:
display()

Method: display

getFeatureFromEvent(evt)
Method: getFeatureFromEvent

walk through the layers to find the feature returned by the event

Parameters: evt - {Object} event object with a feature property

Returns: {<OpenLayers>}

param evt:
setMap(map)
Method: setMap

Parameters: map - {<OpenLayers>}

param map:
removeMap(map)
Method: removeMap

Parameters: map - {<OpenLayers>}

param map:
collectRoots()
Method: collectRoots

Collects the root nodes of all layers this control is configured with and moves the nodes to this control’s layer

resetRoots()
Method: resetRoots

Resets the root nodes back into the layers they belong to.

handleChangeLayer(evt)
Method: handleChangeLayer

Event handler for the map’s changelayer event. We need to rebuild this container’s layer dom if order of one of its layers changes. This handler is added with the setMap method, and removed with the removeMap method.

Parameters: evt - {Object}

param evt:
read(data)
APIMethod: read

Parse a WPS DescribeProcess and return an object with its information.

Parameters: data - {String} or {DOMElement} data to read/parse.

Returns: {Object}

param data:
setValue(data)

getValue

Arguments:
  • data
_gmlLayerFromURL()
enable()

enable the field

disable()

disable the field

getValue()
constructor(config)
Arguments:
  • config
setInputValue()
HSLayersEmbed()

General embedding of map into the HTML page

getFullRequestString(newParams, altUrl)
Method: getFullRequestString

combine the layer’s url with its params and these newParams.

Parameter: newParams - {Object} New parameters that should be added to the request string. altUrl - {String} (optional) Replace the URL in the full request string with the provided URL.

Returns: {String} A string with the layer’s url and parameters embedded in it.

param newParams:
 
param altUrl:
getCheckedLayers()
Method: getCheckedLayers

Returns list of visible layers

Returns: {Array(String)} List of layer names

setLayerVisibility(name, visibility)
Method: setLayerVisibility

Will redraw the map with new layer visibility

Parameters: name - {String} layer name visibility - {Boolean}

param name:
param visibility:
 
setGroupVisibility(name, visibility)
Method: setGroupVisibility

Will redraw the map with new layers visibility

Parameters: name - {String} group name visibility - {Boolean}

param name:
param visibility:
 
getGroup(name)
Method: getGroup

Will return group

Parameters: name - {String} group name

Returns: {Object} group

param name:
getLayer(name, group)
Method: getLayer

Will return layer

Parameters: name - {String} layer name group - {Object} base group object

Returns: {Object} layer

param name:
param group:
requestSuccess(request)
Method: requestSuccess

Process JSON after it has been loaded. Called by setMap()

Parameters: request - {String}

param request:
setBouble(group, base)
Method: setBouble

add boubeling function to all group objects

param group:
param base:
initLayersVisibility(obj)
Method: initLayersVisibility

Initialize visibility of layers by property initialVisibleLayers

Parameters: obj - {Object} group or layer object

param obj:
initLayerVisibility(layer)
Method: initLayerVisibility

Initialize visibility of layer by property initialVisibleLayers

Parameters: layer - {Object} layer object

param layer:
initGroup(group)
Method: initGroup

Initialize group of layers

Parameters: group - {Object} group object

param group:
requestFailure(request)
Method: requestFailure

Process a failed loading of GML. Called by initialise() and loadUrl() if there was a problem loading GML.

Parameters: request - {String}

param request:
onGroupsLoaded()
Method: onGroupsLoaded

To be rewritten

saltURL(url)
Method: saltURL

Add salt&paper parameter to given URL

param url:
setInitialVisibleLayers(visibleLayers)
Method: setInitialVisibleLayers

Initialize visibility of layers by property initialVisibleLayers

Parameters: visibleLayers - {String} layer name - {Array of String} layer names

param visibleLayers:
 
onGetCapabilitiesResponse(response)
Set filter capabilities from the GetCapabilities response

and request Describe Feature Type

param response:
 
onDescribeFeatureTypeResponse(response)

Set properties from the DescribeFeatureType response

Arguments:
  • response
getCoverageUrl(mimeType)

getCoverage url for actual extend and map properties

Arguments:
destroy()

destroy

fillPropertiesForm()

fill properties form with data

parseWMSOptions(parentNode, childNodeName, upperCase)

Search given attribute in the input XML

Arguments:
  • parentNode (DOMElement) – node, where to start to search
  • childNodeName (String) – what is to be searched, like “srs”,”format”, ...
  • upperCase
Returns:

values

Return type:

String[]

featureInList(feature, list)

feature in given array

Arguments:
  • feature (Object) –
  • list (Array) –
Returns:

Return type:

Boolean

getLayerMetadataUrl(layer)

return object with layer metadataURL

Arguments:
  • layer (object) –
Returns:

or undefined

Return type:

Object

requestGetCapabilities(url, retFunction, capabilitiesFailed)
Request WFS Capabilities

Here we use the OWS proxy and give it some extra parameters to let it know that we want WFS

param url:
param retFunction:
 
param capabilitiesFailed:
 
makePropertiesForm()

make properties form

onFeatureSelect(event)

Feature selected

Arguments:
  • event
onFeatureUnselect(event)

Feature unselect

Arguments:
  • event
onaddLayer(evt)

handler of the new layer add event - rewritten from MapViewer

Arguments:
  • evt (Event) –
updateFeatureCountInfo(count)

set information about feature count to bbar

Arguments:
  • count – {Integer} features count
updateFeatureLengthInfo(count)

set information about features length to bbar

Arguments:
  • count – {Float} features length
updateFeatureAreaInfo(count)

set information about features area to bbar

Arguments:
  • count – {Float} features length
getValues(or)

get values from given time

Arguments:
  • or (String) – {Array} of times
Returns:

of {Date}s

Return type:

Array

onPlayClicked(e)

handle play click event

Arguments:
  • e
onLayerGroupLoadEnd(e)

handle play click event

Arguments:
  • e
onFromChange(e)

called when from/to time/date is changed

Arguments:
  • e
getClosestValue(valueIn)

returns closest available time value

Arguments:
  • valueIn
Returns:

miliseconds

Return type:

Integer

_onOpacitySliderDrag(e)

***************** Handlers *******************

Arguments:
  • e
_registerPanelEvents(p)

register events

Arguments:
  • p
displayToolBar(|{Object}, forNewFeature, activateEditing)
ce - linie

display the editing tool bar

param String |{Object}:
 layer name of the layer to be edited
param forNewFeature:
 
param activateEditing:
 
onNewFeatureAdded()

feature added, add the attribute form

onExistingFeatureAdded()

feature added, add the attributes form

deleteFeature(projectName, layerName, featureId)

called, when deleted

Arguments:
  • projectName
  • layerName
  • featureId
clearPanel()

start editing new feature

onInputButtonClicked()

start manual input

onSnapChanged(snapObject)

onSnapChanged in settings panel

Arguments:
  • snapObject (Object) – object with snapping attributes
onSnapParamsChanged(snapParams)

onSnapParamsChanged

Arguments:
  • snapParams (Object) – HSLayers.Snapping.snapParams object with snapping attributes
setSize(contentSize)

Used to adjust the size of the popup.

param OpenLayers.Size contentSize:
 the new size for the popup’s

contents div (in pixels).

onSearch()
Handler for the click event, triggered when the user clicks the

trigger button or hits ENTER key with focus on the search field This method should be redefined for each application.

connect(url, service)

connec to the service for given url and type

Arguments:
parseTimeValue(timestr)

parse time value

Arguments:
  • timestr
onPlusClicked()

clicked at the ‘+’ button for adding new keyword field, add new one

:param KeywordsField :

:param Event :

parse permalink data

Arguments:
  • permalink
getLayerAttribution()
mergeNewParams(params)

mergeNewParams propagation from layer to group

Arguments:
  • params
openFilterWindow()

Open window with FES Filter

setFilter(filter)
Set filter

Called by WFSFilterForm

param OpenLayers.Filter filter:
 
draw()
Method: draw

calls the default draw, and then activates mouse defaults.

Returns: {DOMElement}

formatTip()
Property: formatTip

How the tooltip should be formated ‘this’ is this.slider

Return: {String} to be displayed as Slider’s tooltip

onDrag(e)
Method: onDrag

Slider moved

param e:
updateLimits(min, max, step)
Method: updateLimits

Update min, max, step

Parameters: min - {Double} max - {Double} step - {Double}

param min:
param max:
param step:
activate()
getState()

destroy

findLayer(Layer)
Check for the given layer in JSON if it is already present in the map.

Match criteria: name & layer type.

param Object Layer:
 in JSON
returns:Index of layer if present, null otherwise. If more than one layer matches, the lowest corresponding index is returned.
rtype:Integer
setHSLLayerMapServerVisibility(jsonLayer)

Set visibility of HSLayers.Layer.MapServer layers

:param :

{HSLayers.Layer.MapServer layer
Arguments:
  • jsonLayer (Object) –
createContext()
Returns:context of layers
Return type:Object
getAttributionNode(attribution)
Arguments:
  • String attribution (Object) – object or string
setColor(hex)
Sets the current color and changes the background.

Does not change the value of the field.

param String hex:
 The color value.
getLayerGroup(layer)

get group based on given layer

Arguments:
  • layer (OpenLayers.Layer) –
Returns:

OWSContext group

Return type:

Object

onActivityChanged(evt)
some group activity was changed, if it was ‘activated’, deactivate

all other available ‘base’ groups

param Event evt:
 
initNewGroup(groupName)
Method: initNewGroup

Initializes new group structure, appends new object to this.group

Properties: groupName - {String} group identifier

Returns: {Object} with new group: * title String * layers Array * visibility Boolean

param groupName:
 
appendLayerToGroup(layer)
Method: appendLayerToGroup

Adds new layer to group, according to group, defined as Layer attribute

Properties: layer - {<OpenLayer>}

Returns: {Object} with group: * title String * layers Array * visibility Boolean

param layer:
setGroupVisible(groupName, visibility)
Method: setGroupVisible

Toggle visibility for specified group

Properties: groupName {String}

param groupName:
 
param visibility:
 
rebuildLayerGroupObject()
Method: rebuldLayerGroupObject

Rebuilds this.groups object according to layers

redraw()
Method: redraw

Goes through and takes the current state of the Map and rebuilds the control to display that state. Groups layers into groups.

Returns: {DOMElement} A reference to the DIV DOMElement containing the control

addLayer(layer, parentEl)
Method: addLayer

adds layer to parent ul element in layerSwicher

Parameters: layer - {OpenLayer.Layer} parentEl - {DOMElement}

param layer:
param parentEl:
 
makeMaxMinDivs()
Method: makeMaxMinDivs

Creates Minimazing and Maximizing controls

onGroupInputClick(e)
Method:

Called, when the user clickes on the Group name or input

Parameters: e - {Event}

Context: - {DOMElement} input - {<OpenLayers>} switcher - {String} groupName

param e:
onLayerInputClick(e)
Method:

A label has been clicked, check or uncheck its corresponding input

Parameters: e - {Event}

Context: - {DOMElement} input - {<OpenLayers>} switcher - {<OpenLayers>} layer

param e:
maximizeControl(e)
Method: maximizeControl

Set up the labels and divs for the control

Parameters: e - {Event}

param e:
minimizeControl(e)
Method: minimizeControl

Hide all the contents of the control, shrink the size, add the maximize icon

Parameters: e - {Event}

param e:
showControls(minimize)
Method: showControls

Hide/Show all LayerSwitcher controls depending on whether we are minimized or not

Parameters: minimize - {Boolean}

param minimize:
 
ignoreEvent(evt)
Method: ignoreEvent

Parameters: evt - {Event}

param evt:
mouseDown(evt)
Method: mouseDown

Register a local ‘mouseDown’ flag so that we’ll know whether or not to ignore a mouseUp event

Parameters: evt - {Event}

param evt:
mouseUp(evt)
Method: mouseUp

If the ‘isMouseDown’ flag has been set, that means that the drag was started from within the LayerSwitcher control, and thus we can ignore the mouseup. Otherwise, let the Event continue.

Parameters: evt - {Event}

param evt:
appendButtonDiv(target, imgsrc, layer, title, parentEl)
Method: appendButtonDiv

Creates div and appends it to parent element

Parameters: target - {String} or {Object} imgsrc - {String} layer - {OpenLayer.Layer} parentEl - {DOMElement} element, to which the metadata div will be appended

param target:
param imgsrc:
param layer:
param title:
param parentEl:
 
onRemoveLayerClick(e)
Method: onRemoveLayerClick

Parameters: e - {Event}

Context: - {Layer} Layer - {Map} Map - {ls} LayerSwitcher

param e:
onClick(evt)

On click handler: call the service

Arguments:
  • evt (Event) –
setLayer(layer)
APIMethod: setLayer

Set the editable layer. Call the setLayer method if the editable layer changes and the same control should be used on a new editable layer. If the control is already active, it will be active after the new layer is set.

Parameters: layer - {OpenLayers.Layer.Vector} The new editable layer.

param layer:
deactivate()
APIMethod: deactivate

Deactivate the control. Deactivating the control unregisters listeners so feature editing may proceed without engaging the snapping agent.

onVertexModified(event)

feture was modified, snap

Arguments:
  • event
onSketchStarted(event)

sketch started, set the style

Arguments:
  • event
getRadius()

get radius in pixels

afterFeatureModified(event)

feture was modified, snap

Arguments:
  • event
onSketchModified(event)
Method: onVertexModified

Registered as a listener for the vertexmodified event on the editable layer.

Parameters: event - {Object} The vertex modified event.

param event:
considerSnapping(idx, vertex)

Method: considerSnapping

param Integer idx:
 index of the point in the geometry
param OpenLayers.Geometry.Point vertex:
 The vertex to be snapped
param {OpenLayers.Geometry}:
 geometry geometry of the snapped

feature

Optional
snapToSelf(idx, vertex)
Method: snapToSelf

Snap last point to first point, if needed

param Integer idx:
 index of the point in the geometry
param OpenLayers.Geometry.Point vertex:
 The vertex to be snapped
param {OpenLayers.Geometry}:
 geometry geometry of the snapped

feature

Optional
getGeoTolerance(tolerance)
Method: getGeoTolerance

Calculate a tolerance in map units given a tolerance in pixels.

Parameters: tolerance - {Number} A tolerance value in pixels.

Returns: {Number} A tolerance value in map units.

param tolerance:
 
update(evt)

update relevant this parameters to the controls

Arguments:
  • evt
updateParams(snapObj)

updateParams - update snapParams

Arguments:
  • snapObj
onEditButtonActivated(evt)
set this drawing control to vector layer used by handler

deactivate ALL buttons in all different panles, which might be in the map

param evt:
onSubmit()

common submit function

onSubmitSuccess()

on submit succeeded

onSubmitFailure()

on failed

finelizeFeature(event)

finelize currently digitized feature

Arguments:
  • event
setControl(idx)

activate particular tool

Arguments:
  • idx (Integer) – control index to be activated
clearForm()

Clears existing form element

onFormLoaded(r)

Form loaded, clear previous form, append form to element

Arguments:
  • r
getGrid()

getgrid

Returns:
Return type:Ext.grid.GridPanel
setBounds(bounds)

set box

Arguments:
  • bounds (OpenLayers.Bounds) –
setScale(scaledenom)

set scale

Arguments:
  • scaledenom (Float) –
setResolution(resolution)

set resolution

Arguments:
  • resolution (Integer) –
toContext(map)

to context

Arguments:
  • map (OpenLayers.Map) –
Returns:

Return type:

Object

write(map, template, parameters)

write map context to JSON

Arguments:
  • map (OpenLayers.Map) –
  • template (String) – file name
  • parameters
Returns:

Return type:

String

getLayers(obj)
this function takes care, that only layers we are able to convert

into the context, will be converted

param obj:
layerToContext(layer)

Layer To Context

Arguments:
  • layer (OpenLayers.Layer) –
Returns:

Return type:

Object

layerMapServerToContext(layer)

Layer To Context

Arguments:
  • layer (OpenLayers.Layer) –
Returns:

Return type:

Object

layerGridToContext(layer)

Layer To Context

Arguments:
  • layer (OpenLayers.Layer) –
Returns:

Return type:

Object

layerImageToContext(layer)

Layer To Context

Arguments:
  • layer (OpenLayers.Layer) –
Returns:

Return type:

Object

layerWithContextToContext(layer)

some Layer with wms context To Context

Arguments:
  • layer (OpenLayers.Layer) –
Returns:

Return type:

Object

layerHSWMSToContext(layer)

HS.WMS Layer To Context

Arguments:
  • layer (OpenLayers.Layer) –
Returns:

Return type:

Object

layerWMSToContext(layer)

WMS Layer To Context

Arguments:
  • layer (OpenLayers.Layer) –
Returns:

Return type:

Object

layerVectorToContext(layer)

Layer To Context

Arguments:
  • layer (OpenLayers.Layer) –
Returns:

Return type:

Object

getBasicLayerContext(layer)

creates basic layer object

Arguments:
  • layer (OpenLayers.Layer) –
Returns:

Return type:

Object

getRefence(overview)

format reference map informations

Arguments:
  • overview
map2string(map, pretty, saveAll)
Converts the map from Map object to text in JSON notation.

Syntactic sugar for map2json() & OpenLayers.Format.JSON.write()

param Object map:
 The map that should be converted
param Boolean pretty:
 Whether to use pretty notation
param Boolean saveAll:
 Whether all the layer attributes should be saved
returns:Text in JSON notation representing the map
rtype:String
map2json(map, saveAll)
Converts the map from Map object to JSON.

Uses layers2json().

Properties covered:

  • Map properties: scale, projection, center, title.
  • Layers properties: Those covered by layer2json().

The layer index is not covered, as we assume that it is corresponding to the layers order.

param Object map:
 The map that should be converted
param Boolean saveAll:
 Whether all the layer attributes should be saved
returns:JSON object representing the map
rtype:Object
layers2string(layers, Whether, saveAll)
Converts map layers from array of Layer objects to text in JSON notation.

Syntactic sugar for layers2json() & OpenLayers.Format.JSON.write()

param Array layers:
 Array of layers to be converted
param Boolean Whether:
 to use pretty notation
param Boolean saveAll:
 Whether all the layer attributes should be saved
returns:Text in JSON notation representing the layers
rtype:String
layers2json(layers, saveAll)
Converts map layers into a JSON object.

Uses layer2json().

param Array layers:
 Map layers that should be converted
param Boolean saveAll:
 Whether all the layer attributes should be saved
returns:JSON object representing the layers
rtype:Array
layer2string(layer, Whether, saveAll)
Converts map layer from Layer object to text in JSON notation.

Syntactic sugar for layer2json() & OpenLayers.Format.JSON.write()

param Object layer:
 Layer to be converted
param Boolean Whether:
 to use pretty notation
param Boolean saveAll:
 Whether all the layer attributes should be saved
returns:Text in JSON notation representing the layer
rtype:String
layer2json(layer, saveAll)
Converts map layer into a JSON object.

Layer properties covered: CLASS_NAME, name, url, params, group, displayInLayerSwitcher, visibility, attribution, transitionEffect, isBaseLayer, minResolution, maxResolution, minScale, maxScale, metadata, abstract, opacity, singleTile, removable, queryable, legend, projections, wmsMinScale, wmsMaxScale

The layer index is not covered, as we assume that it is corresponding to the layers order.

param Object layer:
 Map layer that should be converted
param Boolean saveAll:
 Whether all the layer attributes should be saved. Sometimes we want to save network traffic and save completely only the foreign layers, in such a case set saveAll to false.
returns:JSON object representing the layer
rtype:Object
json2string(json, pretty)

Syntactic sugar for OpenLayers.Format.JSON.write()

Arguments:
  • json (Object) – JSON object to be written
  • pretty (Boolean) – Whether to use pretty notation
Returns:

Text repesentation of the JSON object

Return type:

String

string2json(text)

Syntactic sugar for OpenLayers.Format.JSON.read()

Arguments:
  • text (String) – Text representing a JSON object
Returns:

JSON object corresponding to the text

Return type:

Object

string2layer(text)
Converts map layer from text in JSON notation to Layer object

Syntactic sugar for OpenLayers.JSON.read() & json2layer()

param String text:
 Text in JSON notation representing the layer
returns:Layer object corresponding to the given text
rtype:Object
json2layer(json)
Converts map layer from JSON object to Layer object

Only OpenLayers.Layer.WMS layer type is supported in the moment. The layers of other types are silently discarded.

The following layer properties are covered: CLASS_NAME, name, url, params, group, displayInLayerSwitcher, visibility, attribution, transitionEffect, isBaseLayer, minResolution, maxResolution, minScale, maxScale, metadata, abstract, opacity, singleTile, removable, queryable, legend, projections, wmsMinScale, wmsMaxScale

param Object json:
 JSON object representing map layer
returns:Layer object corresponding to the JSON object if the layer type is supported. null is returned otherwise.
rtype:Object
string2layers(text)
Converts map layers from text in JSON notation to array of Layer objects

Syntactic sugar for OpenLayers.JSON.read() & json2layers()

param String text:
 Text in JSON notation representing the layers
returns:Array of layers corresponding to the given text
rtype:Array
json2layers(contextLayers)
Converts map layers from JSON object to array of Layer objects.

Uses json2layer().

param Object contextLayers:
 JSON object representing map layers
returns:Array of Layer objects corresponding to the JSON object
rtype:Array
Method: fetchLink

Fetches a URL and returns the result

Parameters: href - {String} url to be fetched

param href:
function to be redefined in the application

append needed parameters to external link url according to https://developers.google.com/kml/documentation/kmlreference#viewformat

param String href:
 
returns:href
rtype:String

Main Menu


Table Of Contents

Previous topic

String (data)

Next topic

constructor (class)

This Page