OpenLayers.Layer.MapGuide - OpenLayers

# OpenLayers. Layer. MapGuide

Instances of OpenLayers.Layer.MapGuide are used to display data from a MapGuide OS instance.

#### Inherits from

- OpenLayers.Layer.Grid

Summary

OpenLayers. Layer. MapGuide | Instances of OpenLayers.Layer.MapGuide are used to display data from a MapGuide OS instance.
Properties |
isBaseLayer | {Boolean} Treat this layer as a base layer.
singleTile | {Boolean} use tile server or request single tile image.
Constants |
TILE_PARAMS | {Object} Hashtable of default parameter key/value pairs for tiled layer
SINGLE_TILE_PARAMS | {Object} Hashtable of default parameter key/value pairs for untiled layer
Constructor |
OpenLayers. Layer. MapGuide | Create a new Mapguide layer, either tiled or untiled.
MapGuide OS uses a DPI value and degrees to meters conversion | factor that are different than the defaults used in OpenLayers, so these must be adjusted accordingly in your application.

### Properties

### isBaseLayer

{Boolean} Treat this layer as a base layer. Default is true.

### singleTile

{Boolean} use tile server or request single tile image. Note that using singleTile and isBaseLayer false is not recommend: it uses synchronous XMLHttpRequests to load tiles, and this will lock up users browsers during requests if the server fails to respond.

### Constants

### TILE_PARAMS

{Object} Hashtable of default parameter key/value pairs for tiled layer

### SINGLE_TILE_PARAMS

{Object} Hashtable of default parameter key/value pairs for untiled layer

### Constructor

### OpenLayers. Layer. MapGuide

Create a new Mapguide layer, either tiled or untiled.

For tiled layers, the ‘groupName’ and ‘mapDefinition’ values must be specified as parameters in the constructor.

For untiled base layers, specify either combination of ‘mapName’ and ‘session’, or ‘mapDefinition’ and ‘locale’.

For untiled overlay layers (singleTile=true and isBaseLayer=false), mapName and session are required parameters for the Layer constructor. Also NOTE: untiled overlay layers issues a synchronous AJAX request before the image request can be issued so the users browser may lock up if the MG Web tier does not respond in a timely fashion.

### MapGuide OS uses a DPI value and degrees to meters conversion

factor that are different than the defaults used in OpenLayers, so these must be adjusted accordingly in your application. See the MapGuide example for how to set these values for MGOS.

#### Parameters

name | {String} Name of the layer displayed in the interface
url | {String} Location of the MapGuide mapagent executable (e.g. http://localhost:8008- /mapguide- /mapagent- /mapagent.fcgi)
params | {Object} hashtable of additional parameters to use. Some parameters may require additional code on the server. The ones that you may want to use are:

- mapDefinition - {String} The MapGuide resource definition (e.g. Library://Samples/Gmap/Maps/gmapTiled.MapDefinition)
- locale - Locale setting (for untiled overlays layers only)
- mapName - {String} Name of the map as stored in the MapGuide session. (for untiled layers with a session parameter only)
- session - { String} MapGuide session ID (for untiled overlays layers only)
- basemaplayergroupname - {String} GroupName for tiled MapGuide layers only
- format - Image format to be returned (for untiled overlay layers only)
- showLayers - {String} A comma separated list of GUID’s for the layers to display eg: ‘cvc-xcv34,453-345-345sdf’.
- hideLayers - {String} A comma separated list of GUID’s for the layers to hide eg: ‘cvc-xcv34,453-345-345sdf’.
- showGroups - {String} A comma separated list of GUID’s for the groups to display eg: ‘cvc-xcv34,453-345-345sdf’.
- hideGroups - {String} A comma separated list of GUID’s for the groups to hide eg: ‘cvc-xcv34,453-345-345sdf’
- selectionXml - {String} A selection xml string Some server plumbing is required to read such a value.

options | {Ojbect} Hashtable of extra options to tag onto the layer; will vary depending if tiled or untiled maps are being requested

Base class for layers that use a lattice of tiles.
Close