Metacat

OpenLayers.Bounds

This class represents a bounding box. Data stores as left, bottom, right, top floats.

* Constructor

  OpenLayers.Bounds(left, bottom, right, top) -- Create new Bounds.

* Methods

  clone() -- {OpenLayers.Bounds} -- Return copy of the current bounds.

  toString() -- {String} -- Return bounds as string.

  toBBOX() -- {String} -- Return bounds as simple string, usable for WMS.

  getWidth() -- {float} -- Return width of bounds.

  getHeight() -- {float} -- Return height of bounds.

  getSize() -- {OpenLayers.Size} -- Return size of bounds.

  getCenterPixel() -- {OpenLayers.Pixel} -- Return center of bounds as pixel.

  getCenterLonLat() -- {OpenLayers.LonLat} -- Return center of bounds as LonLat.

  equals({OpenLayers.Bounds|bounds}) -- {Boolean} -- whether or not the bounds are equivilant.

  add({float|x}, {float|y}) -- {OpenLayers.Bounds} -- Shift bounds by x and y.

  contains({float|x}, {float|y}, {Boolean|inclusive}) -- {Boolean} -- Return Whether or not the passed-in coordinates are within this bounds

  containsBounds({OpenLayers.Bounds|bounds}, {Boolean|partial}, {Boolean|inclusive}) -- {Boolean} -- Returns whether or not the passed-in OpenLayers.Bounds object is contained within this bounds. partial indicates whether bounds must be contained or only overlap. Inclusive determines whether border is included.

  determineQuadrant({OpenLayers.LonLat|lonlat}) -- {String} -- Determine which quadrant the LonLat is in. Returns combination of "b" or "t" and "l" or "r".