Class MapPaneOL

Object
   |
   +--WidgetBase
         |
         +--MapPaneOL

class MapPaneOL

extends WidgetBase

Defined in MapPaneOL.js

Field Detail

containerNodeId

Object containerNodeId

displayOutsideMaxExtent

Object displayOutsideMaxExtent

Should layers also be rendered outside the map extent? Default is false.

imageBuffer

Object imageBuffer

for untiled wms layers: how many times should the map image be larger than the visible map. Large values mean slow loading, small ones mean many reloads when panning. Recommended values: 1-3, default is 2.

imageReproject

Object imageReproject

For WMS on top of Google Maps you need to reproject the WMS image. This will stretch the WMS images to fit the odd sized google tiles. Default is false

loadingLayers

Object loadingLayers

Number of layers that are currently being loaded

singleTile

Object singleTile

For WMS layers: should they be regarded as normal WMS layers, with a single tile for the entire boundingbox or as a tiled WMS layer

tileBuffer

Object tileBuffer

For tiled wms layers: how many rows of tiles should be preloaded outside the visible map? Large values mean slow loading, small ones mean longer delays when panning. Recommended values: 1-3, default is 2.

tileGutter

Object tileGutter

For tiled wms layers: Overlap of map tiles in pixels. Useful for preventing rendering artefacts at tile edges. Recommended values: 0-15, default is 0 (no gutter at all).

tileSize

Object tileSize

For tiled wms layers: how many pixels should the size of one tile be? Default is 256.

MapPaneOL

MapPaneOL(widgetNode, model)

Widget to render a map from an OGC context document. The layers are rendered using http://openlayers.org .

Parameters:
widgetNode - The widget's XML object node from the configuration document.
model - The model object that this widget belongs to.

addLayer

void addLayer(objRef, layerNode)

Adds a layer into the output

Parameters:
objRef - This object.
layerNode - The node of the layer

clear

void clear(objRef)

remove OpenLayers events and layers

Parameters:
objRef - reference to this widget

decreaseLoadingLayers

void decreaseLoadingLayers(e)

Event handler to keep the modelStatus updated when an OpenLayers layer finished loading.

Parameters:
e - OpenLayers event

deleteAllLayers

void deleteAllLayers(objRef)

Removes all layers from the output

Parameters:
objRef - Pointer to this object.
objRef - Pointer to this object.

deleteLayer

void deleteLayer(objRef, layerId)

Removes a layer from the output /** Removes a layer from the output

Parameters:
objRef - Pointer to this object.
layerId - the WMS name for the layer to be removed

getLayer

Object getLayer(objRef,layerId)

Returns OL layer node from LayerMgr

Parameters:
layerId - The layer Id (or layerName)

getWebSafeStyle

Object getWebSafeStyle(objRef, colorNumber)

gets an OpenLayers vector style with web safe colors.

Parameters:
objRef - reference to this object
colorNumber - number of a color from which to generate websafe color

Returns:
{OpenLayers.Style} style for OpenLayers vector rendering

hidden

void hidden(objRef, layerId)

Hide/unhide a layer. Called by Context when the hidden attribute changes.

Parameters:
objRef - Pointer to widget object.
layerId - Id of the layer to hide/unhide.

increaseLoadingLayers

void increaseLoadingLayers(e)

Event handler to keep the modelStatus updated when an OpenLayers layer starts loading.

Parameters:
e - OpenLayers event

moveLayerDown

void moveLayerDown(objRef, layerId)

Moves a layer up in the stack of map layers

Parameters:
objRef - Pointer to this object.
layerId - the WMS name for the layer to be removed

moveLayerUp

void moveLayerUp(objRef, layerId)

Moves a layer up in the stack of map layers

Parameters:
objRef - Pointer to this object.
layerId - the WMS name for the layer to be removed

paint

void paint(objRef, refresh)

Render the widget.

Parameters:
objRef - Pointer to widget object.

refreshLayer

void refreshLayer(objRef, layerId , newParams)

Called for refreshing one layer.

Parameters:
objRef - This object.
layerId - The id of the layer that was toggled.

refreshWmsLayers

void refreshWmsLayers(objRef)

Called after a feature has been added to a WFS. This function triggers the WMS basemaps to be redrawn. A timestamp param is added to the URL to ensure the basemap image is not cached. This function is triggered by the refreshWmsLayers event. If this event is fired with a as param, only that layer will be refreshed.

Parameters:
objRef - reference to this widget

setOpacity

void setOpacity(objRef, layerId)

Called when the context's opacity attribute changes. /** Called when the context's opacity attribute changes.

Parameters:
objRef - This object.
layerId - The id of the layer that was toggled.

timestampListener

void timestampListener(objRef, timestampIndex)

Called when the map timestamp is changed so set the layer visiblity.

Parameters:
objRef - This object.
timestampIndex - The array index for the layer to be displayed.

updateContext

void updateContext(e)

Event handler to keep the Mapbuilder context updated. It also sets the map cursor to the previously stored value. This is called by OpenLayers.

Parameters:
e - OpenLayers event

updateMouse

void updateMouse(e)

Restore the map cursor stored by buttons. This has to be done in an OpenLayers mouseup event, because the mouseup event in OpenLayers resets the cursor to default.

Parameters:
e - OpenLayers event

zoomToBbox

void zoomToBbox(objRef)

Zoom to the current Bounding Box.

Parameters:
objRef - reference to this widget