Commit documentation for remaining layers.

git-svn-id: http://svn.openlayers.org/trunk/openlayers/doc@1265 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf
This commit is contained in:
crschmidt
2006-08-16 23:23:19 +00:00
parent ef13849db1
commit 7144f467f9
6 changed files with 58 additions and 0 deletions

7
Layer.Boxes.txt Normal file
View File

@@ -0,0 +1,7 @@
OpenLayers.Layer.Boxes
A subclass of the markers layer, this layer draws boxes using div elements
instead of icons using images.
* Constructor
OpenLayers.Layer.Boxes(name, options) -- Same as OpenLayers.Layer.Markers.

11
Layer.GeoRSS.txt Normal file
View File

@@ -0,0 +1,11 @@
OpenLayers.Layer.GeoRSS
GeoRSS layer. Pass a name and location of a GeoRSS file on the web, and a marker will be added to the map for each item in the GeoRSS feed. Uses OpenLayers.loadURL to load the XML, parses the data, and adds markers to the map.
* Constructor
OpenLayers.Layer.GeoRSS(name, url) -- Name and location of GeoRSS XML file.
* Methods
parseData(ajaxResponse) -- none -- Callback for the loadURL call. This function parses the XML for the GeoRSS feed, creating markers for the data and adding a popup to each marker. It populates an array of features as 'this.features'.
markerClick(Event) -- none -- Action to perform when a marker is clicked.
clearFeatures() -- none -- Removes all features and markers from the map.

7
Layer.KaMap.txt Normal file
View File

@@ -0,0 +1,7 @@
OpenLayers.Layer.KaMap
ka-Map is a Mapserver wrapper which performs caching and works around many of the deficiencies with tiling when using Mapserver as a WMS client.
* Construtor
OpenLayers.Layer.KaMap(name, url, params, options) -- URL is the url of the tile.php for KaMap.

13
Layer.Markers.txt Normal file
View File

@@ -0,0 +1,13 @@
OpenLayers.Layer.Markers
The base class for all vector drawing, The OpenLayers.Layer.Markers layer is the primary way to get annotations into your map.
* Constructor
OpenLayers.Layer.Markers(name, options) -- Name and options for layer.
* Methods
addMarker({OpenLayers.Marker|Marker}) -- none -- Adds a marker to the layer, sets the map object on the marker, and calls drawMarker on the marker.
removeMarker({OpenLayers.Marker|Marker}) -- none -- Remove the marker from the layer and map.
clearMarkers() -- none -- Remove all markers from the layer with removeMarker.
redraw() -- none -- Redraw all markers. Used so that markers can change their position when a base layer changes.
drawMarker -- none -- Call marker.draw(px), which passes the Pixel of the latitude/longitude in the map viewport to the marker. adds the marker to the div, and marks the marker as drawn.

10
Layer.Text.txt Normal file
View File

@@ -0,0 +1,10 @@
OpenLayers.Layer.Text
Subclass of Markers layer which retrieves CSV file from the web, and parses content to create markers and popups.
* Constructor
OpenLayers.Layer.Text(name, options) -- Pass in name, and set location: 'URL of CSV file' in the options hash.
* Methods
parseData(ajaxRequest) -- none -- Parses returned CSV file.

10
Marker.Box.txt Normal file
View File

@@ -0,0 +1,10 @@
OpenLayers.Marker.Box
A different kind of Marker, designed to be added to a Boxes layer instead of a Markers layer.
* Constructor
OpenLayers.Marker.Box({OpenLayers.Bounds|bounds}, borderColor, borderWidth) -- Set up a box. Defaults are red, with a width of 2.
* Methods
setBorder(color, width) -- sets properties of border color and width.