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
Properties |
defaultSize | {OpenLayers.Size} Tile size as produced by MapGuide server
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.
Functions |
clone | Create a clone of this layer
addTile | Creates a tile, initializes it, and adds it to the layer div.
getURL | Return a query string for this layer
getFullRequestString | getFullRequestString on MapGuide layers is special, because we do a regular expression replace on ‘,’ in parameters to ‘+’.
calculateGridLayout | Generate parameters for the grid layout.

### 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

### Properties

### defaultSize

{OpenLayers.Size} Tile size as produced by MapGuide server

### 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

### Functions

### clone

> clone: function ( | obj | )

Create a clone of this layer

#### Returns

{OpenLayers.Layer.MapGuide} An exact clone of this layer

### addTile

> addTile:function( | bounds,
> | position | )

Creates a tile, initializes it, and adds it to the layer div.

#### Parameters

bounds | {OpenLayers.Bounds}
position | {OpenLayers.Pixel}

#### Returns

{OpenLayers.Tile.Image} The added OpenLayers.Tile.Image

### getURL

> getURL: function ( | bounds | )

Return a query string for this layer

#### Parameters

bounds | {OpenLayers.Bounds} A bounds representing the bbox for the request

#### Returns

{String} A string with the layer’s url and parameters and also the passed-in bounds and appropriate tile size specified as parameters.

### getFullRequestString

> getFullRequestString:function( | newParams,
> | altUrl | )

getFullRequestString on MapGuide layers is special, because we do a regular expression replace on ‘,’ in parameters to ‘+’. This is why it is subclassed here.

#### Parameters

altUrl | {String} Alternative base URL to use.

#### Returns

{String} A string with the layer’s url appropriately encoded for MapGuide

### calculateGridLayout

> calculateGridLayout: function( | bounds,
> | extent,
> | resolution | )

Generate parameters for the grid layout. This

#### Parameters

bounds | {<OpenLayers.Bound>}
extent | {OpenLayers.Bounds}
resolution | {Number}

#### Returns

Object containing properties tilelon, tilelat, tileoffsetlat, tileoffsetlat, tileoffsetx, tileoffsety

Instances of this class represent a width/height pair

> clone: function ( | obj | )

Create a clone of this layer

> addTile:function( | bounds,
> | position | )

Creates a tile, initializes it, and adds it to the layer div.

> getURL: function ( | bounds | )

Return a query string for this layer

> getFullRequestString:function( | newParams,
> | altUrl | )

getFullRequestString on MapGuide layers is special, because we do a regular expression replace on ‘,’ in parameters to ‘+’.

> calculateGridLayout: function( | bounds,
> | extent,
> | resolution | )

Generate parameters for the grid layout.
Base class for layers that use a lattice of tiles.
Create a new Mapguide layer, either tiled or untiled.
Instances of this class represent bounding boxes.
This class represents a screen coordinate, in x and y coordinates
Instances of OpenLayers.Tile.Image are used to manage the image tiles used by various layers.
Close