Fusion. Widget.Map

mapLoaded: function()

Callback for when all maps have been loaded

Parameter: none.

Return: none

setMenu: function()

Attaches a context menu as defined in the AppDef to the map

Parameter: none.

Return: none

loadMapGroup: function( mapGroup )

Controls the creation of Layers based on the MapGroup object passed in

Return: none

layerLoaded: function()

Called after each layer is loaded in the OL viewport.  Nothing happens here until the last layer is laoded, then it sets the OL baselayer and zooms to the initial extent.

Parameter: none

Return: none

wheelChange: function( evt, deltaZ )

handles mouse wheel events by accummulating the events and setting a timer to do the actual zoom in/out

Parameters

doWheelChange: function( evt, deltaZ )

Carries out the actual map zoom based on the wheel movement

Parameters

Return: none

wheelUp: function( evt )

User spun scroll wheel up

Parameters

wheelDown: function( evt )

User spun scroll wheel down

Parameters

getDomObj: function()

returns the dom element for this widget

Parameters: none

Return: none

getMapName: function()

returns the name of the baselayer map

Parameters: none

Return: {String} the name of the baselayer map

getMapTitle: function()

returns the Title of the baselayer map.  This is a human-readable title

Parameters: none

Return: {String} the Title of the baselayer map

getSessionID: function()

returns the server session ID

Parameters: none

Return: {String} the session ID

getDomId: function()

returns the ID of dom element for this widget

Parameters: none

Return: {String} the id of the DOM element

setMapOptions: function( options )

sets options on the OpenLayers map object, a wrapper for the OL function

Return: none

addMap: function( map )

adds a map/Layer to the map and registers some event handlers on the map

Return: none

getAllMaps: function()

returns the array of map objects

Parameters: none

Return: {Array} the array of map Objects

reloadMap: function()

Called to reload all the map objects. this uses setTimeout so this method can be called from an IFRAME

Parameters: none

Return: none

loadScaleRanges: function( userFunc )

Loads the ScaleRange objects separate from the LoadMap sequence since this also generates sprites and is a relatively expensive operation.

Return: none

query: function( options )

dispatch query requests to the maps

selectionHandler: function()

handle selection events from maps and republish for widgets as appropriate

Parameters: none

Return: none

hasSelection: function()

cehck to see if any of the maps have an active selection

clearSelection: function()

clear the selection on all maps

getSelection: function( callback, layers, startcount )

initiates a call to get the current selection asynchronously in case we need to retrieve the details from the server

setSelection: function( selText, zoomTo )

sets a Selection XML back to the server for each of the maps

Parameters

accumulateSelection: function( map, oSelection )

accumulate the selection results from each map and when all have reported in, pass the results to the callback function

Parameters

setActiveLayer: function( oLayer )

sets the active layer for selection/manipulation

Parameters

getActiveLayer: function()

returns the active layer for selection/manipulation

Returns

{Object} the active layer

_addWorker: function()

indicate that a new asynchronous process has started and make sure the visual indicator is visible for the user.  This is intended to be used internally by gMap but could be used by external tools if appropriate.

_removeWorker: function()

indicate that an asynchronous process has completed and hide the visual indicator if no remaining processes are active.  This is intended to be used internally by gMap but could be used by external tools if appropriate.  Only call this function if addWorker was previously called

mapExtentsChanged: function()

OpenLayers event handler for whenever the map changes either zoom level of the center has changed.  This in turn triggers the Fusion event.

Parameters: none

Return: none

isBusy: function()

check to see if there are any outstanding requests to the server

Parameters: none

Return: {Boolean} true if there are active requests

sizeChanged: function()

callback for when the browser window size changes, simply calls resize on the map viewport layout object

Parameters: none

Return: none

resize: function()

handles the resizing of the maps and triggers a Fusion event

Parameters: none

Return: none

redraw: function()

redraws the map using current extents and zoom level.  A dummy parameter is added to the map request to ensure the map request is not cached.

Parameters: none

Return: none

setBackgroundColor: function( color )

sets the background color for the map

Return: none

setExtents: function( oExtents )

handle selection events from maps and republish for widgets as appropriate

Return: none

setInitialExtents: function()

determine the initialExtents of the map from (in order of precedence)

1. a URL query parameter called ‘extent’ 2. an <InitialView> specified in the MapGroup in AppDef 3. the maxExtent as specified by the LoadMap call (default)

Returns: {Object} an OpenLayers.Bounds object which is the initial extent

getMapGroupExtent: function( includeGenericLayers )

gets the intitial extents from all maps with or without including the extent of any Generic/commercial layers

Return: {Object} an OpenLayers.Bounds object which is the initial extent

fullExtents: function()

sets the extent of the map to the max as returned by loadMap

isMapLoaded: function()

returns if the map has finished loading (based on setting the _oCurrentExtent value)

Returns {Boolean} true if the map is loaded and extent has been set

zoom: function( fX, fY, nFactor )

sets the map zoom and extent.

Parameters

• if set to 0 or 1, the map is just recentered
• if the map has fractional zoom enabled, the map resolution will be modified by this factor
• with fixed scales, zoom up or down one level, depending on the sign

Returns: none

zoomToScale: function( fScale )

sets the map zoom and extent.

Parameters

• if set to 0 or 1, the map is just recentered
• if the map has fractional zoom enabled, the map resolution will be modified by this factor
• with fixed scales, zoom up or down one level, depending on the sign

Returns: none

sets the map zoom and extent.

Parameters

• if set to 0 or 1, the map is just recentered
• if the map has fractional zoom enabled, the map resolution will be modified by this factor
• with fixed scales, zoom up or down one level, depending on the sign

Returns: none

sets the map zoom and extent.

Parameters

• if set to 0 or 1, the map is just recentered
• if the map has fractional zoom enabled, the map resolution will be modified by this factor
• with fixed scales, zoom up or down one level, depending on the sign

Returns: none

getCurrentCenter: function()

returns the current center of the map view

Return: {Object} an object with the following attributes x - the x coordinate of the center y - the y coordinate of the center

getExtentFromPoint: function( fX, fY, fScale )

returns the Extent of the map given a center point and a scale (optional)

Return: {OpenLayers.Bounds} the bounds for the map centered on a point