GeoMOOSE

Parent namespace for all GeoMOOSE classes.

Summary

GeoMOOSE	Parent namespace for all GeoMOOSE classes.
Functions
splitPaths	Splits paths in a GeoMOOSE path string (split by ‘:’)
error	Display an error to the user.
warning	Similar to error, but with less severity.
registerMapSourceType	Registers a Class to a GeoMOOSE class type Parameters: map_source_type - The map-source type from the Mapbook.
getMapSourceType	Get the class for a given layer type Parameters: map_source_type - The map-source type from the Mapbook.
asArray	Converts parameter to an array.
configureMapSource	Parses a map-source XML fragment and adds it to the map.
changeLayerVisibility	Turn a layer on or off.
turnLayerOn.	Turns on some layers.
turnLayerOff.	Turns off some layers.
refreshLayers	Force some layers to redraw.
isEditable	Checks to see if a MapSource is editable.
getLayerUrl	Get the base URL for a given layer.
changeLayerUrl	Change the base URL for a given layer.
updateLayerParameters	Change the params for a given layer.
updateLayerFilter	Change the filter for a given layer.
getLayerParameters	Get the params for a given layer.
getLayerOpacity	Get the client-side Opacity parameter setting.
setLayerOpacity	Set the client-side Opacity parameter setting.
clearLayerParameters	Clears all the user set parameters from a MapSource.
getVisibleLayers	Get the list of currently visible layer paths.
getExtent	Get the map’s extent as an array.
getScale	Return the map’s current scale.
inScale	Check whether a given min/maxscale is within the current scale.
moveLayerUp	Move’s a layer up on the visibility stack.
moveLayerDown	Move’s a layer down on the visibility stack.
fadeLayer	Fade out the opacity by CONFIGURATION.layer_controls.fade.change_percent.
unfadeLayer	Un-Fade out the opacity by CONFIGURATION.layer_controls.fade.change_percent.
startService	Start a service with some given parameters
changeTab	Change to a tab given by tabName
zoomToPoint	Zoom to a point and a buffer
zoomToExtent	Zoom to an extent
addPopup	Add a popup to the map.
addPopupGround	Add a popup to the map.
clearPopups	Remove all popups from the map.
processTemplate	A low-cost, built-in template utility for GeoMOOSE.
getBookmarkUrl	Get an URL for bookmarking.
getUrlParameters	Parses URL parameters and returns a hash.
bookmark	Change the URL to be something bookmarkable.
register	Register an event with GM_Events.
id	Generates an unique ID
addTab	Add a new GeoMOOSE.Tab instance to the tab bar.
getTab	Recall a tab that has been added with addTab.
closeTab	Close a tab by the name.
removeTab	Removes a tab from the internal list, but not the user interface.
selectTab	Bring a tab to the forefront.
getLegendUrls	Returns an array of legend URLs for a given set of paths.
isDefined	Check for the null condition in a variable.
activateMapSource	Set the active map source.
deactivateMapSource	Sets the active map source to null and turns off the controls on any active map source.
getActiveMapSource	Gets the active map source.
saveChanges
zoomToPointsList	Zooms to the bounding box of a points list.
convertLength	Convert a number from one denomination to another.
download	Offers a download dialog for the php/download.php script.
zoomToLonLat	Zooms to a specified lon, lat.
deactivateTools	Turn off all current tools, including layer tools.
activateLayerTool	Activates a layer tool
activateDefaultTool	This is a bit of a “pull the ‘chute” call.
parseBoolean	Inputs a string and outputs a boolean.
commifyNumber	Convert a number into a string that is comma delimited.
stripCommas	Remove the commas from a number.

Functions

splitPaths

splitPaths : function( layerPaths )

Splits paths in a GeoMOOSE path string (split by ‘:’)

Parameters

layerPaths

String of GeoMOOSE paths delimited by “;”.

error

error: function()

Display an error to the user. This is preferable over console.error or console.log as we can start to make browser neutral and increasingly user-friendly delivery.

Parameters

Takes in the entire argument list similiar to console.log

warning

warning: function()

Similar to error, but with less severity.

registerMapSourceType

registerMapSourceType: function( map_source_type,
js_class )

Registers a Class to a GeoMOOSE class type Parameters: map_source_type - The map-source type from the Mapbook. js_class - The class reference.

getMapSourceType

getMapSourceType: function( map_source_type )

Get the class for a given layer type Parameters: map_source_type - The map-source type from the Mapbook.

asArray

asArray: function( layer_list )

Converts parameter to an array.

Parameters

layer_list

Misnomer, really, it’s “var” and then returns an array if it’s not one already.

configureMapSource

configureMapSource: function( map_source_xml )

Parses a map-source XML fragment and adds it to the map. Important: this does not add anything to the catalog!

Parameters map_source_xml - The <map-source> xml node

changeLayerVisibility

changeLayerVisibility : function( layerPaths,
visibility )

Turn a layer on or off. Parameters: layerPaths - The full GeoMOOSE layer path. (ex. my_wms/my_layer)

turnLayerOn.

Turns on some layers.

Parameters

layerPaths

The list of layers.

turnLayerOff.

Turns off some layers.

Parameters

layerPaths

The list of layers.

refreshLayers

refreshLayers : function( layerNames )

Force some layers to redraw.

Parameters

layerNames

List of layers to redraw.

isEditable

isEditable: function( source )

Checks to see if a MapSource is editable.

Parameters

source

The map source.

getLayerUrl

getLayerUrl : function( layerName )

Get the base URL for a given layer.

Parameters

layerName

The name of the layer to find.

changeLayerUrl

changeLayerUrl : function( layerName,
url )

Change the base URL for a given layer.

Parameters

layerName	The name of the layer to find.
url	The URL to change to.

updateLayerParameters

updateLayerParameters : function( layerName,
paramObject )

Change the params for a given layer.

Parameters

layerName	The name of the layer to find.
paramObject	A hash of the parameters.

updateLayerFilter

updateLayerFilter: function( layerName,
filterText )

Change the filter for a given layer.

getLayerParameters

getLayerParameters : function( layerName )

Get the params for a given layer.

Parameters

layerName

The name of the layer to find.

Returns

The parameters, in a hash.

getLayerOpacity

getLayerOpacity : function( layerName )

Get the client-side Opacity parameter setting.

Parameters

layerName

The layername.

Returns

A floating point number represeting the opacity (0-100)

setLayerOpacity

setLayerOpacity: function( layerName,
opacity )

Set the client-side Opacity parameter setting.

Parameters

layerName	The layername.
opacity	0-100, percentage of visibility.

clearLayerParameters

clearLayerParameters: function( layerName )

Clears all the user set parameters from a MapSource.

Parameters

layerName

The Layername.

getVisibleLayers

getVisibleLayers : function()

Get the list of currently visible layer paths.

Parameters

None

Returns

A list of layer names.

getExtent

getExtent: function()

Get the map’s extent as an array.

Returns

An array with [minx,miny,maxx,maxy]

getScale

getScale: function()

Return the map’s current scale.

Returns

Floating point of the map’s scale.

inScale

inScale: function( minscale,
maxscale )

Check whether a given min/maxscale is within the current scale.

moveLayerUp

moveLayerUp: function( path )

Move’s a layer up on the visibility stack.

Parameters

path	the layer path.

moveLayerDown

moveLayerDown: function( path )

Move’s a layer down on the visibility stack.

Parameters

path	the layer path.

fadeLayer

fadeLayer: function( path )

Fade out the opacity by CONFIGURATION.layer_controls.fade.change_percent.

Parameters

path	the layer path.

unfadeLayer

unfadeLayer: function( path )

Un-Fade out the opacity by CONFIGURATION.layer_controls.fade.change_percent.

Parameters

path	the layer path.

startService

startService : function( serviceName,
settingsObj,
forceStart )

Start a service with some given parameters

Parameters

serviceName	The service to call.
settingsObj	A hash of settings to pass to the service. The keys in the hash should match the names of inputs in the service definition from the Mapbook.
forceStart	When true, the service will start, ignoring any user input requirements.

changeTab

changeTab : function( tabName )

Change to a tab given by tabName

Parameters

tabName

A name of a tab.

zoomToPoint

zoomToPoint : function( x,
y,
buffer )

Zoom to a point and a buffer

Parameters

x	X coordinate.
y	Y coordinate.
buffer	Buffer in ground units.

zoomToExtent

zoomToExtent : function( minx,
miny,
maxx,
maxy,
projection )

Zoom to an extent

Parameters

minx	Minimum X-bound.
miny	Minimum Y-bound.
maxx	Maximum X-bound.
maxx	Maximum Y-bound.
projection	Optional projection. When unspecified, assumes map coordinates.

addPopup

addPopup : function( x,
y,
w,
h,
html,
title )

Add a popup to the map.

Parameters

x	X-coordinate to place the popup.
y	Y-coordinate to place the popup.
w	Deprecated. The width of the popup.
h	Deprecated. The height of the popup.
html	The contents of the popup.
title	The title of the popup

addPopupGround

addPopupGround : function( easting,
northing,
html,
title )

Add a popup to the map.

Parameters

easting	easting (or lon) coordinate to place the popup.
northing	northing (or lat) coordinate to place the popup.
html	The contents of the popup.
title	The title of the popup

clearPopups

clearPopups : function()

Remove all popups from the map.

processTemplate

processTemplate : function ( template,
replace_dict )

A low-cost, built-in template utility for GeoMOOSE. Takes in a string and replace all “%name%” instances with their appropriate values from replace_dict. Example: GeoMOOSE.processTemplate(“Hello, %name%!”, {‘name’ : ‘World’}); will return the ubiquitous “Hello, World”.

Parameters

template	String containining “%...%”’s to be replaced.
replace_dict	A hash/object containing the replacement values.

Returns

A string with the values substituted.

getBookmarkUrl

getBookmarkUrl: function()

Get an URL for bookmarking.

getUrlParameters

getUrlParameters: function()

Parses URL parameters and returns a hash.

bookmark

bookmark: function()

Change the URL to be something bookmarkable. Warning! Sets document.location!

register

register: function( event_type,
ref_obj,
func )

Parameters

event_type	Name of the event.
ref_obj	A reference object. Sets the scope for “func”.
func	The function to call when the event is triggered.

id

id: function()

Generates an unique ID

addTab

addTab: function( tab_name,
tab )

Add a new GeoMOOSE.Tab instance to the tab bar. Parameters: tab_name - Internal controllable name for the tab. tab - The dijit Object being added.

getTab

getTab: function( tab_name )

Recall a tab that has been added with addTab.

closeTab

closeTab: function( tab_name )

Close a tab by the name.

removeTab

removeTab: function( tab_name )

Removes a tab from the internal list, but not the user interface.

selectTab

selectTab: function( tab_name )

Bring a tab to the forefront.

Parameters

tab_name

Name of the tab to bring to the front.

getLegendUrls

getLegendUrls: function( layer_paths )

Returns an array of legend URLs for a given set of paths.

Parameters

layer_paths

GeoMOOSE Paths

isDefined

isDefined: function( v )

Check for the null condition in a variable.

activateMapSource

activateMapSource: function( name )

Set the active map source.

Parameters

name	The name of the mapsource to activate.

deactivateMapSource

Sets the active map source to null and turns off the controls on any active map source.

getActiveMapSource

getActiveMapSource: function()

Gets the active map source.

Returns

A GeoMOOSE.MapSource class representing the current active map class, or null if none is active.

saveChanges

saveChanges: function( name )

Parameters

name	MapSource name to save.

zoomToPointsList

zoomToPointsList: function( points_list,
projection )

Zooms to the bounding box of a points list.

Parameters

points_lits	String formatted as “X Y, X Y, X Y”
projection	MapServer’s [shpxy proj=] is broken, this allows for client-side reprojection.

convertLength

convertLength: function( length,
src_units,
dest_units )

Convert a number from one denomination to another.

download

download: function( id,
extension )

Offers a download dialog for the php/download.php script.

zoomToLonLat

_latLongProj: null, zoomToLonLat: function( lon,
lat )

Zooms to a specified lon, lat.

deactivateTools

deactivateTools: function()

Turn off all current tools, including layer tools.

activateLayerTool

activateLayerTool: function( action,
kwargs )

Activates a layer tool

activateDefaultTool

activateDefaultTool: function()

This is a bit of a “pull the ‘chute” call. Starts up the pan tool. In the future this needs to be more configurable.

parseBoolean

function parseBoolean( bool,
def )

Inputs a string and outputs a boolean.

Parameters

bool	The bit to parse.
def	The default value in case of an undefined value.

commifyNumber

function commifyNumber( number )

Convert a number into a string that is comma delimited. TODO: Replace this with an internationalized friendly function.

Parameters

number

The number to commify

stripCommas

function stripCommas( v )

Remove the commas from a number. TODO: Again, more international version of this. (e.g. the Europeans use “,” as the decimal point)

Parameters

v	The string number with commas.