diff --git a/Layer.EventPane.txt b/Layer.EventPane.txt new file mode 100644 index 0000000000..ca75b4610c --- /dev/null +++ b/Layer.EventPane.txt @@ -0,0 +1,6 @@ +OpenLayers.Layer.EventPane + +Designed to act as a super-class for layers which need OpenLayers to intercept click events. Google Maps and Microsoft Virtual Earth both use this functionality, in order to allow for actions like the rubber-band-zoom/zoombox functionality. This Layer is not designed to be used on its own, but instead to act as an intermediary between the user and layers which have their own click handlers. + +* Constructor + OpenLayers.Layer.EventPane(name, options) -- Only designed to be used by subclasses. diff --git a/Layer.Google.txt b/Layer.Google.txt new file mode 100644 index 0000000000..1f611070a4 --- /dev/null +++ b/Layer.Google.txt @@ -0,0 +1,16 @@ +OpenLayers.Layer.Google + +The Google Layer in OpenLayers allows you to include Google Maps functionality in your OpenLayers maps. In order to use the Google Layer, you must first obtain an API key for Google Maps, and include the Google Maps API script in your page. Once you have done this, + +* Constructor + OpenLayers.Layer.Google(name, options?) -- Constructor for Google layer. Accepts name and options. + +* Methods + getOLLonLatFromGLatLng(GLonLat) -- {OpenLayers.LonLat} -- Convert from GLatLon to OpenLayers LonLat + getGLatLngFromOLLonLat({OpenLayers.LonLat|lonlat}) -- GLatLon -- Convert From OpenLayers LonLat to GLatLon + getOLPixelFromGPoint(GPoint) -- {OpenLayers.Pixel} -- Convert from GPoint to OpenLayers.Pixel + getGPointFromOLPixel({OpenLayers.Pixel|pixel}) -- GPoint -- Create GPoint from OpenLayers Pixel. + +* Parameters + type -- one of G_MAP, G_SATELLITE_MAP, G_HYBRID_MAP, used to choose the type of map to display. + diff --git a/Layer.Grid.txt b/Layer.Grid.txt new file mode 100644 index 0000000000..c6ae0d95ea --- /dev/null +++ b/Layer.Grid.txt @@ -0,0 +1,31 @@ +OpenLayers.Layer.Grid + +The Grid layer is the base layer for almost all image layers. This is a subclass of HTTPRequest. + +* Constructor + OpenLayers.Layer.Grid(name, url, params, options) -- URL is the base URL to the layer. Params is a set of params to be included in the HTTP Request. Options is a set of options, extending the parameters of the layer. + +* Methods + getGridBounds() -- {OpenLayers.Bounds} -- return geographic extent of the grid of tiles. + _initTiles() -- none -- Used to initialize the tile grid, creating image elements as neccesary and filling them with the correct images. + spiralTileLoad() -- none -- Called from _initTiles. Rotates through the grid filling in the images for the grid. + clone() -- {OpenLayers.Layer.Grid} -- create a clone of the layer. Subclassed from {OpenLayers.Layer}. + setMap(map) -- none -- Set the map property of the layer. Also set the parameters which are inherited from the map. This is also where the tileSize is retrieved from the map. Subclassed from {OpenLayers.Layer}. + moveTo({OpenLayers.Bounds|bounds}, {Boolean|zoomChanged}) -- none -- Not implemented here, but the general function called on dragging or setCenter, to move the Layer to a new geographic location. Subclassed from {OpenLayers.Layer}. + getResolution() -- {float} -- Return the current resolution of the map, in units/pixel. Subclassed from {OpenLayers.Layer}. + getExtent() -- {OpenLayers.Bounds} -- Return the geographic extent of the current map viewport. Subclassed from {OpenLayers.Layer}. + getZoomForExtent({OpenLayers.Bounds|bounds}) -- {Integer} -- return the integer zoom which most closely matches the passed bounds. Subclassed from {OpenLayers.Layer}. + getLonLatFromViewPortPx({OpenLayers.Pixel|pixel}) -- {OpenLayers.LonLat} -- Returns an OpenLayers.LonLat which is the passed-in view port OpenLayers.Pixel, translated into lon/lat by the layer. Subclassed from {OpenLayers.Layer}. + getViewPortPxFromLonLat({OpenLayers.LonLat|lonlat}) -- {OpenLayers.Pixel} -- Returns An OpenLayers.Pixel which is the passed-in OpenLayers.LonLat, translated into view port pixels. Subclassed from {OpenLayers.Layer}. + +* Parameters + buffer -- Default 2. Number of tiles around the central map area which OpenLayers will preload so that dragging goes more smoothly. + * Subclassed from OpenLayers.Layer + isBaseLayer -- This determines whether the layer is a base layer or an overlay. Only one Base Layer can be displayed on the map at once. Default is false. + projection -- SRS string to describe the layer. If this is set on the map before the Layer is added to the map, it will inherit from the map. + maxExtent -- an OpenLayers.Bounds for the layer. This is the maximum geographic extent of the layer. If this is set on the map before the Layer is added to the map, it will inherit from the map. + maxResolution -- The number of degrees per pixel at zoom level 0. If this is set on the map before the Layer is added to the map, it will inherit from the map. + maxZoomLevel -- The maximum zoom level for the layer. If this is set on the map before the Layer is added to the map, it will inherit from the map. + minScale -- The scale at zoom level 0. If this is set on the map before the Layer is added to the map, it will inherit from the map. + maxScale -- The scale at the highest zoom level. If this is set on the map before the Layer is added to the map, it will inherit from the map. + units -- The units the map is projected into. If this is set on the map before the Layer is added to the map, it will inherit from the map. diff --git a/Layer.HTTPRequest.txt b/Layer.HTTPRequest.txt new file mode 100644 index 0000000000..ea683e6d77 --- /dev/null +++ b/Layer.HTTPRequest.txt @@ -0,0 +1,11 @@ +OpenLayers.Layer.HTTPRequest + +Sublass of Layer used for services which require initiating multiple HTTPRequests. + +* Constructor + OpenLayers.Layer.HTTPRequest(name, url, params, options) -- URL is the base URL to the layer. Params is a set of params to be included in the HTTP Request. Options is a set of options, extending the parameters of the layer. + +* Methods + initResolutions() -- none -- Based on the current minScale/maxScale/maxResolution/maxZoomLevels/scales/resolutions parameters, initializes an array of 'zoom levels' as this.resolutions, which are then used as an index into when zooming. + getFullRequestString(newParams) -- {String} -- Returns the full request string for a combination of the defaults on this layer and the parameters passed via newParams. + diff --git a/Layer.VirtualEarth.txt b/Layer.VirtualEarth.txt new file mode 100644 index 0000000000..0876131f09 --- /dev/null +++ b/Layer.VirtualEarth.txt @@ -0,0 +1,14 @@ +OpenLayers.Layer.VirtualEarth + +The Virtual Earth Layer in OpenLayers allows you to include Virtual Earth Maps in your OpenLayers maps. In order to use the Virtual Earth Layer, you must first include the Virtual Earth API script in your page. Once you have done this, simply add the layer to your map. + +* Constructor + OpenLayers.Layer.VirtualEarth(name) -- Constructor for Virtual Earth layer. Accepts name. + +* Methods + getOLLonLatFromVELatLng(VELatLon) -- {OpenLayers.LonLat} -- Convert from VELatLon to OpenLayers LonLat + getVELatLngFromOLLonLat({OpenLayers.LonLat|lonlat}) -- VELatLon -- Convert From OpenLayers LonLat to VELatLon + getOLPixelFromVEPoint(Msn.VE.Pixel) -- {OpenLayers.Pixel} -- Convert from VEPoint to OpenLayers.Pixel + getGPointFromOLPixel({OpenLayers.Pixel|pixel}) -- Msn.VE.Pixel -- Create Msvn.VE.Pixel from OpenLayers Pixel. + + diff --git a/Layer.WMS.txt b/Layer.WMS.txt new file mode 100644 index 0000000000..dc4d374d01 --- /dev/null +++ b/Layer.WMS.txt @@ -0,0 +1,13 @@ +OpenLayers.Layer.WMS + +The WMS layer allows one to connect to a WMS server to obtain images. + +* Constructor + OpenLayers.Layer.WMS(name, url, params, options) -- URL is the base URL to the layer. Params is a set of params to be included in the HTTP Request. Options is a set of options, extending the parameters of the layer. + +* Methods + getURL({OpenLayers.Bounds|bounds}) -- {String} -- Returns a WMS URL for the given bounds based on the properties of the layer. + All other methods are inherited from {OpenLayers.Layer.Grid} + +* Parameters + isBaseLayer -- WMS layers default to being base layers unless one of their parameters is 'transparent':'true'.