OpenLayers.Layer.Grid - OpenLayers

# OpenLayers. Layer.Grid

Base class for layers that use a lattice of tiles. Create a new grid layer with the OpenLayers.Layer.Grid constructor.

#### Inherits from

- OpenLayers.Layer.HTTPRequest

Summary

OpenLayers. Layer.Grid | Base class for layers that use a lattice of tiles.
Properties |
tileSize | {OpenLayers.Size}
singleTile | {Boolean} Moves the layer into single-tile mode, meaning that one tile will be loaded.
ratio | {Float} Used only when in single-tile mode, this specifies the ratio of the size of the single tile to the size of the map.
buffer | {Integer} Used only when in gridded mode, this specifies the number of extra rows and colums of tiles on each side which will surround the minimum grid tiles to cover the map.
numLoadingTiles | {Integer} How many tiles are still loading?
Constructor |
OpenLayers. Layer.Grid | Create a new grid layer
Functions |
destroy | Deconstruct the layer and clear the grid.
clone | Create a clone of this layer
setTileSize | Check if we are in singleTile mode and if so, set the size as a ratio of the map size (as specified by the layer’s ‘ratio’ property).
getTilesBounds | Return the bounds of the tile grid.
addTile | Gives subclasses of Grid the opportunity to create an OpenLayer.Tile of their choosing.
getTileBounds | Returns The tile bounds for a layer given a pixel location.

### Properties

### tileSize

{OpenLayers.Size}

### singleTile

{Boolean} Moves the layer into single-tile mode, meaning that one tile will be loaded. The tile’s size will be determined by the ‘ratio’ property. When the tile is dragged such that it does not cover the entire viewport, it is reloaded.

### ratio

{Float} Used only when in single-tile mode, this specifies the ratio of the size of the single tile to the size of the map.

### buffer

{Integer} Used only when in gridded mode, this specifies the number of extra rows and colums of tiles on each side which will surround the minimum grid tiles to cover the map.

### numLoadingTiles

{Integer} How many tiles are still loading?

### Constructor

### OpenLayers. Layer.Grid

Create a new grid layer

#### Parameters

name | {String}
url | {String}
params | {Object}
options | {Object} Hashtable of extra options to tag onto the layer

### Functions

### destroy

> destroy: function()

Deconstruct the layer and clear the grid.

### clone

> clone: function ( | obj | )

Create a clone of this layer

#### Parameters

obj | {Object} Is this ever used?

#### Returns

{OpenLayers.Layer.Grid} An exact clone of this OpenLayers.Layer.Grid

### setTileSize

> setTileSize: function( | size | )

Check if we are in singleTile mode and if so, set the size as a ratio of the map size (as specified by the layer’s ‘ratio’ property).

#### Parameters

size | {OpenLayers.Size}

### getTilesBounds

> getTilesBounds: function()

Return the bounds of the tile grid.

#### Returns

{OpenLayers.Bounds} A Bounds object representing the bounds of all the currently loaded tiles (including those partially or not at all seen onscreen).

### addTile

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

Gives subclasses of Grid the opportunity to create an OpenLayer.Tile of their choosing. The implementer should initialize the new tile and take whatever steps necessary to display it.

Parameters bounds - {OpenLayers.Bounds} position - {OpenLayers.Pixel}

#### Returns

{OpenLayers.Tile} The added OpenLayers.Tile

### getTileBounds

> getTileBounds: function( | viewPortPx | )

Returns The tile bounds for a layer given a pixel location.

#### Parameters

viewPortPx | {OpenLayers.Pixel} The location in the viewport.

#### Returns

{OpenLayers.Bounds} Bounds of the tile at the given pixel location.

Instances of this class represent a width/height pair

> destroy: function()

Deconstruct the layer and clear the grid.

> clone: function ( | obj | )

Create a clone of this layer

> setTileSize: function( | size | )

Check if we are in singleTile mode and if so, set the size as a ratio of the map size (as specified by the layer’s ‘ratio’ property).

> getTilesBounds: function()

Return the bounds of the tile grid.

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

Gives subclasses of Grid the opportunity to create an OpenLayer.Tile of their choosing.

> getTileBounds: function( | viewPortPx | )

Returns The tile bounds for a layer given a pixel location.
Create a new grid layer
Instances of this class represent bounding boxes.
This class represents a screen coordinate, in x and y coordinates
This is a class designed to designate a single tile, however it is explicitly designed to do relatively little.
Close