/lib/spatial/openlayers/doc/reference.html - Annotate - Metacat - Ecoinformatics Redmine

3032

perry

<html>

2

  <head>

3

    <title>OpenLayers Class Reference Documentation</title>

4

    <style type='text/css'>

5

        .type { background-color: #ddd }

6

        td { border: black solid 1px; padding: 3px;  }

7

        table { border-collapse: collapse; margin: 5px 10px; }

8

        .classref { margin-left: 20px; }

9

        div.index { float:left;  width: 300px; }

10

    </style>

11

  </head>

12

  <body>

13

<div class='index'><a href='#OpenLayers.Map'>OpenLayers.Map</a></div>

14

<div class='index'><a href='#OpenLayers.Layer'>OpenLayers.Layer</a></div>

15

<div class='index'><a href='#OpenLayers.Layer.HTTPRequest'>OpenLayers.Layer.HTTPRequest</a></div>

16

<div class='index'><a href='#OpenLayers.Layer.Grid'>OpenLayers.Layer.Grid</a></div>

17

<div class='index'><a href='#OpenLayers.Layer.WMS'>OpenLayers.Layer.WMS</a></div>

18

<div class='index'><a href='#OpenLayers.Layer.KaMap'>OpenLayers.Layer.KaMap</a></div>

19

<div class='index'><a href='#OpenLayers.Layer.EventPane'>OpenLayers.Layer.EventPane</a></div>

20

<div class='index'><a href='#OpenLayers.Layer.Google'>OpenLayers.Layer.Google</a></div>

21

<div class='index'><a href='#OpenLayers.Layer.VirtualEarth'>OpenLayers.Layer.VirtualEarth</a></div>

22

<div class='index'><a href='#OpenLayers.Layer.Markers'>OpenLayers.Layer.Markers</a></div>

23

<div class='index'><a href='#OpenLayers.Layer.Text'>OpenLayers.Layer.Text</a></div>

24

<div class='index'><a href='#OpenLayers.Layer.GeoRSS'>OpenLayers.Layer.GeoRSS</a></div>

25

<div class='index'><a href='#OpenLayers.Layer.Boxes'>OpenLayers.Layer.Boxes</a></div>

26

<div class='index'><a href='#OpenLayers.Icon'>OpenLayers.Icon</a></div>

27

<div class='index'><a href='#OpenLayers.Marker'>OpenLayers.Marker</a></div>

28

<div class='index'><a href='#OpenLayers.Marker.Box'>OpenLayers.Marker.Box</a></div>

29

<div class='index'><a href='#OpenLayers.Tile'>OpenLayers.Tile</a></div>

30

<div class='index'><a href='#OpenLayers.Tile.Image'>OpenLayers.Tile.Image</a></div>

31

<div class='index'><a href='#OpenLayers.Tile.WFS'>OpenLayers.Tile.WFS</a></div>

32

<div class='index'><a href='#OpenLayers.Control'>OpenLayers.Control</a></div>

33

<div class='index'><a href='#OpenLayers.Control.LayerSwitcher'>OpenLayers.Control.LayerSwitcher</a></div>

34

<div class='index'><a href='#OpenLayers.Control.MouseDefaults'>OpenLayers.Control.MouseDefaults</a></div>

35

<div class='index'><a href='#OpenLayers.Control.MouseToolbar'>OpenLayers.Control.MouseToolbar</a></div>

36

<div class='index'><a href='#OpenLayers.Control.PanZoom'>OpenLayers.Control.PanZoom</a></div>

37

<div class='index'><a href='#OpenLayers.Control.PanZoomBar'>OpenLayers.Control.PanZoomBar</a></div>

38

<div class='index'><a href='#OpenLayers.Control.Permalink'>OpenLayers.Control.Permalink</a></div>

39

<div class='index'><a href='#OpenLayers.Control.Scale'>OpenLayers.Control.Scale</a></div>

40

<div class='index'><a href='#OpenLayers.LonLat'>OpenLayers.LonLat</a></div>

41

<div class='index'><a href='#OpenLayers.Size'>OpenLayers.Size</a></div>

42

<div class='index'><a href='#OpenLayers.Pixel'>OpenLayers.Pixel</a></div>

43

<div class='index'><a href='#OpenLayers.Bounds'>OpenLayers.Bounds</a></div>

44

<br style='clear:both' />

45

<h1><a name="OpenLayers.Map">OpenLayers.Map</a></h1><div class="classref">

46

47

Instantiate class <a href="#OpenLayers.Map" title="OpenLayers.Map">OpenLayers.Map</a> in order to create a map. This is the central class in the API. Everything else is auxiliary.

48

49

</table>

50

<h2>Constructor</h2>

51

<table>

52

  <tr><td>  OpenLayers.Map(container,  opts?)</td><td>Creates a new map inside of the given HTML container, which is typically a DIV element. The opts variable is an object with various options, as described in the options section below.</td></tr>

53

54

</table>

55

<h2>Methods</h2>

56

<table>

57

  </table>

58

59

<h3>Layer Management </h3>

60

  <table>

61

  <tr><td>  addLayer(<a href="#OpenLayers.Layer" title="OpenLayers.Layer">layer</a>)</td><td>none</td><td>adds a layer to the list currently set for the map. </td></tr>

62

  <tr><td>  addLayers([ <a href="#OpenLayers.Layer" title="OpenLayers.Layer">layer</a>, <a href="#OpenLayers.Layer" title="OpenLayers.Layer">layer</a> ])</td><td>none</td><td>Adds multiple layers to a map.</td></tr>

63

  <tr><td>  removeLayer(<a href="#OpenLayers.Layer" title="OpenLayers.Layer">layer</a>)</td><td>none</td><td>Remove a layer from the map.</td></tr>

64

  <tr><td>  setBaseLayer(<a href="#OpenLayers.Layer" title="OpenLayers.Layer">layer</a>)</td><td>none</td><td>Sets a new base layer for the map. The provided layer should have already been added to the map. Changing the base layer causes all other base layers to be turned off, and all overlays to reproject themselves. </td></tr>

65

66

  </table>

67

68

<h3>Control Management</h3>

69

  <table>

70

  <tr><td>  addControl(<a href="#OpenLayers.Control" title="OpenLayers.Control">control</a>)</td><td>none</td><td>Adds a control to the map.</td></tr>

71

72

  </table>

73

74

<h3>Popup Management</h3>

75

  <table>

76

  <tr><td>  addPopup(<a href="#OpenLayers.Popup" title="OpenLayers.Popup">popup</a>, <span class="type" title="Boolean">exclusive</span>)</td><td>none</td><td>adds a popup to the map. If exclusive is set to true, then all other popups are closed first.</td></tr>

77

  <tr><td>  removePopup(<a href="#OpenLayers.Popup" title="OpenLayers.Popup">popup</a>)</td><td>none</td><td>removes an existing popup from the map.</td></tr>

78

79

  </table>

80

81

<h3>Center management</h3>

82

  <table>

83

  <tr><td>  setCenter(<a href="#OpenLayers.LonLat" title="OpenLayers.LonLat">lonlat</a>, <span class="type" title="int">zoom</span>)</td><td>none</td><td>Set the center point of the map. This then moves all the layers to the new center location as well, using each layer's 'moveTo' function. The 'zoom' is an integer from 0 to maxZoomLevel.</td></tr>

84

  <tr><td>  pan(<span class="type" title="Integer">dx</span>, <span class="type" title="Integer">dy</span>)</td><td>none</td><td>Allows user to pan by a value of screen pixels</td></tr>

85

86

  </table>

87

88

<h3>Zoom Management</h3>

89

  <table>

90

  <tr><td>  zoomTo(<span class="type" title="int">zoom</span>)</td><td>none</td><td>zoom to the given zoom level.</td></tr>

91

  <tr><td>  zoomIn()</td><td>none</td><td>zoom in one level.</td></tr>

92

  <tr><td>  zoomOut()</td><td>none</td><td>zoom out one level.</td></tr>

93

  <tr><td>  zoomToExtent(<a href="#OpenLayers.Bounds" title="OpenLayers.Bounds">bounds</a>)</td><td>none</td><td>Set the map such that the bounds fits within the current viewport area.</td></tr>

94

  <tr><td>  zoomToMaxExtent()</td><td>none</td><td>Zoom such that the entire bounds of the map is contained in the viewport.</td></tr>

95

  <tr><td>  zoomToScale(<span class="type" title="float">float</span>)</td><td>none</td><td>Zoom as close to the given scale as possible. Scale can be given as a ratio (1/24000) or as the denominator of the scale value (24000). zoomToScale will find the zoom level which most closely fits the requested scale and set that as the current zoom level.</td></tr>

96

97

  </table>

98

99

<h3>Current Map Information</h3>

100

  <table>

101

  <tr><td>  getLonLatFromPixel(<a href="#OpenLayers.Pixel" title="OpenLayers.Pixel">pixel</a>)</td><td><a href="#OpenLayers.LonLat" title="OpenLayers.LonLat">OpenLayers.LonLat</a></td><td>Returns OpenLayers.LonLat corresponding to the given OpenLayers.Pixel, translated into lon/lat by the current base layer</td></tr>

102

  <tr><td>  getPixelFromLonLat(<a href="#OpenLayers.LonLat" title="OpenLayers.LonLat">lonlat</a>)</td><td><a href="#OpenLayers.Pixel" title="OpenLayers.Pixel">OpenLayers.Pixel</a></td><td>Returns OpenLayers.Pixel corresponding to the given OpenLayers.LonLat, translated by the current base layer  </td></tr>

103

  <tr><td>  getCenter()</td><td><a href="#OpenLayers.LonLat" title="OpenLayers.LonLat">OpenLayers.LonLat</a></td><td>Returns a LonLat for the current center of the map</td></tr>

104

  <tr><td>  getZoom()</td><td><span class="type" title="Integer">Integer</span></td><td>Returns the current zoom level as an integer</td></tr>

105

  <tr><td>  getExtent()</td><td><a href="#OpenLayers.Bounds" title="OpenLayers.Bounds">OpenLayers.Bounds</a></td><td>Returns a Bounds object which represents the geographic bounds of the current viewPort. </td></tr>

106

  <tr><td>  getSize()</td><td><a href="#OpenLayers.Pixel" title="OpenLayers.Pixel">OpenLayers.Pixel</a></td><td>Returns the pixel size of the current map window.</td></tr>

107

  <tr><td>  getTileSize()</td><td><a href="#OpenLayers.Size" title="OpenLayers.Size">OpenLayers.Size</a></td><td>Returns tile size currently set for map.</td></tr>

108

  <tr><td>  getResolution()</td><td><span class="type" title="float">float</span></td><td>Returns the current resolution (units/pixel) of the map</td></tr>

109

  <tr><td>  getZoomForExtent(<a href="#OpenLayers.Bounds" title="OpenLayers.Bounds">bounds</a>)</td><td>Zoom level in which the given bounds will fit</td><td>zooming to this level and setting the center of the map in the center of the bounds will always fit the given bounds in the map.</td></tr>

110

111

  </table>

112

113

<h3>Default Map Information </h3>

114

  <table>

115

  <tr><td>  getMaxResolution()</td><td><span class="type" title="float">float</span></td><td>returns The Map's Maximum Resolution, the units/pixel at zoom level 0. The default is 1.40625, to match the approximate MaxResolution used by the commercial providers. </td></tr>

116

  <tr><td>  getMaxExtent()</td><td><a href="#OpenLayers.Bounds" title="OpenLayers.Bounds">OpenLayers.Bounds</a></td><td>Return the max extent of the current base layer as defined on the layer. The default maxExtent for OpenLayers is -180,-90,180,90</td></tr>

117

  <tr><td>  getMaxZoomLevel()</td><td><span class="type" title="int">int</span></td><td>Returns the maximum zoom level that can be reached in the map for the current base layer</td></tr>

118

  <tr><td>  getMinZoomLevel()</td><td><span class="type" title="int">int</span></td><td>Returns the minimum zoom level that can be reached in the map for the current base layer</td></tr>

119

120

</table>

121

<h2>Events</h2>

122

<table>

123

  <tr><td>  addlayer</td><td>a layer is added to the map</td></tr>

124

  <tr><td>  removelayer</td><td>a layer is removed from the map</td></tr>

125

  <tr><td>  changelayer</td><td>a layer has some property of it, typically visibility, changed.</td></tr>

126

  <tr><td>  changebaselayer</td><td>the current base layer changes</td></tr>

127

  <tr><td>  movestart</td><td>start of a movement in the map       </td></tr>

128

  <tr><td>  zoomend</td><td>end of a zoom action</td></tr>

129

  <tr><td>  mouseover</td><td>map is moused over</td></tr>

130

  <tr><td>  mouseout</td><td>map is no longer mousedout</td></tr>

131

  <tr><td>  mousemove</td><td>mouse moves inside map</td></tr>

132

  <tr><td>  dragstart</td><td>drag action starts</td></tr>

133

  <tr><td>  dragend</td><td>drag action ends</td></tr>

134

135

</table>

136

<h2>Options:</h2>

137

<table>

138

  <tr><td>controls</td><td>an array of control objects to be added to the map. The default is [new OpenLayers.Control.MouseDefaults(), new OpenLayers.Control.PanZoom()] </td></tr>

139

  <tr><td>projection</td><td>used by WMS layers, should be an SRS identifier.</td></tr>

140

  <tr><td>maxZoomLevel</td><td>The number of zoom levels to use in the map.</td></tr>

141

  <tr><td>maxExtent</td><td><a href="#OpenLayers.Bounds" title="OpenLayers.Bounds">OpenLayers.Bounds</a> to be used as the maximum extent of a map. The center of the map can not leave the maxExtent of the map when dragging.</td></tr>

142

  <tr><td>maxResolution</td><td>The units/pixel measurement at zoom level 0. Default is 1.40625</td></tr>

143

  <tr><td>resolutions</td><td>An array of resolutions to be used as an index when zooming. Overrides maxZoomLevel and maxResolution if present.</td></tr>

144

  <tr><td>minScale</td><td>The smallest scale value. minScale is preferred over maxResolution, if present.</td></tr>

145

  <tr><td>maxScale</td><td>The maximum scale the map should include. Overrides maxZoomLevel if present.</td></tr>

146

  <tr><td>units</td><td>The units of the map. Defaults to degrees. Neccesary when using scale in any way.</td></tr>

147

  <tr><td>scales</td><td>An array of scale values. Overrides maxResolution, maxZoomLevel, resolutions, and min/max scale if present.</td></tr>

148

  </table></div>

149

<h1><a name="OpenLayers.Layer">OpenLayers.Layer</a></h1><div class="classref">

150

151

Layers are the most important and central aspect of OpenLayers. They are the

152

core functionality for the software: Everything that ends up on the map comes

153

from a layer. The base layer class is designed to be subclassed by any number

154

of different layers.

155

156

</table>

157

<h2>Constructor</h2>

158

<table>

159

  <tr><td>  OpenLayers.Layer(name, options)</td><td>All layers have a name as their first param. This name is used to display the layer in the LayerSwitcher, and for other purposes. The options parameter is used to replace any parameters of the Layer which need to be different.</td></tr>

160

161

</table>

162

<h2>Methods</h2>

163

<table>

164

  <tr><td>  clone()</td><td><a href="#OpenLayers.Layer" title="OpenLayers.Layer">OpenLayers.Layer</a></td><td>create a clone of the layer.</td></tr>

165

  <tr><td>  setName(<span class="type" title="String">name</span>)</td><td>none</td><td>Set the name of the layer to something different.</td></tr>

166

  <tr><td>  moveTo(<a href="#OpenLayers.Bounds" title="OpenLayers.Bounds">bounds</a>, <span class="type" title="Boolean">zoomChanged</span>)</td><td>none</td><td>Not implemented here, but the general function called on dragging or setCenter, to move the Layer to a new geographic location.</td></tr>

167

  <tr><td>  reproject()</td><td>none</td><td>Subclassed by vector layers to redraw vectors when base layer changes.</td></tr>

168

  <tr><td>  setMap(map)</td><td>none</td><td>Set the map property of the layer. Also set the parameters which are inherited from the map.</td></tr>

169

  <tr><td>  getVisibility()</td><td><span class="type" title="Boolean">Boolean</span></td><td>Return true or false based on visibility of the layer.</td></tr>

170

  <tr><td>  setVisibility(<span class="type" title="Boolean">visible</span>)</td><td>none</td><td>Set the layer visibility, and trigger the appropriate events.</td></tr>

171

  <tr><td>  getResolution()</td><td><span class="type" title="float">float</span></td><td>Return the current resolution of the map, in units/pixel.</td></tr>

172

  <tr><td>  getExtent()</td><td><a href="#OpenLayers.Bounds" title="OpenLayers.Bounds">OpenLayers.Bounds</a></td><td>Return the geographic extent of the current map viewport.</td></tr>

173

  <tr><td>  getZoomForExtent(<a href="#OpenLayers.Bounds" title="OpenLayers.Bounds">bounds</a>)</td><td><span class="type" title="Integer">Integer</span></td><td>return the integer zoom which most closely matches the passed bounds.</td></tr>

174

  <tr><td>  getLonLatFromViewPortPx(<a href="#OpenLayers.Pixel" title="OpenLayers.Pixel">pixel</a>)</td><td><a href="#OpenLayers.LonLat" title="OpenLayers.LonLat">OpenLayers.LonLat</a></td><td>Returns an OpenLayers.LonLat which is the passed-in view port OpenLayers.Pixel, translated into lon/lat by the laye</td></tr>

175

  <tr><td>  getViewPortPxFromLonLat(<a href="#OpenLayers.LonLat" title="OpenLayers.LonLat">lonlat</a>)</td><td><a href="#OpenLayers.Pixel" title="OpenLayers.Pixel">OpenLayers.Pixel</a></td><td>Returns An OpenLayers.Pixel which is the passed-in OpenLayers.LonLat, translated into view port pixels</td></tr>

176

177

</table>

178

<h2>Parameters</h2>

179

<table>

180

  <tr><td>  isBaseLayer</td><td>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.</td></tr>

181

  <tr><td>  projection</td><td>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.</td></tr>

182

  <tr><td>  maxExtent</td><td>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.</td></tr>

183

  <tr><td>  maxResolution</td><td>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.</td></tr>

184

  <tr><td>  maxZoomLevel</td><td>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.</td></tr>

185

  <tr><td>  minScale</td><td>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.</td></tr>

186

  <tr><td>  maxScale</td><td>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.</td></tr>

187

  <tr><td>  units</td><td>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.</td></tr>

</table></div>

194

<h1><a name="OpenLayers.Layer.HTTPRequest">OpenLayers.Layer.HTTPRequest</a></h1><div class="classref">

195

196

Sublass of Layer used for services which require initiating multiple HTTPRequests.

197

198

</table>

199

<h2>Constructor</h2>

200

<table>

201

  <tr><td>  OpenLayers.Layer.HTTPRequest(name, url, params, options)</td><td>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.</td></tr>

202

203

</table>

204

<h2>Methods</h2>

205

<table>

206

  <tr><td>  initResolutions()</td><td>none</td><td>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.</td></tr>

207

  <tr><td>  getFullRequestString(newParams)</td><td><span class="type" title="String">String</span></td><td>Returns the full request string for a combination of the defaults on this layer and the parameters passed via newParams.</td></tr>

208

209

</table></div>

210

<h1><a name="OpenLayers.Layer.Grid">OpenLayers.Layer.Grid</a></h1><div class="classref">

211

212

The Grid layer is the base layer for almost all image layers. This is a subclass of HTTPRequest.

213

214

</table>

215

<h2>Constructor</h2>

216

<table>

217

  <tr><td>  OpenLayers.Layer.Grid(name, url, params, options)</td><td>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.</td></tr>

218

219

</table>

220

<h2>Methods</h2>

221

<table>

222

  <tr><td>  getGridBounds()</td><td><a href="#OpenLayers.Bounds" title="OpenLayers.Bounds">OpenLayers.Bounds</a></td><td>return geographic extent of the grid of tiles.</td></tr>

223

  <tr><td>  _initTiles()</td><td>none</td><td>Used to initialize the tile grid, creating image elements as neccesary and filling them with the correct images.</td></tr>

224

  <tr><td>  spiralTileLoad()</td><td>none</td><td>Called from _initTiles. Rotates through the grid filling in the images for the grid.</td></tr>

225

  <tr><td>  clone()</td><td><a href="#OpenLayers.Layer.Grid" title="OpenLayers.Layer.Grid">OpenLayers.Layer.Grid</a></td><td>create a clone of the layer. Subclassed from {OpenLayers.Layer}.</td></tr>

226

  <tr><td>  setMap(map)</td><td>none</td><td>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 <a href="#OpenLayers.Layer" title="OpenLayers.Layer">OpenLayers.Layer</a>.</td></tr>

227

  <tr><td>  moveTo(<a href="#OpenLayers.Bounds" title="OpenLayers.Bounds">bounds</a>, <span class="type" title="Boolean">zoomChanged</span>)</td><td>none</td><td>Not implemented here, but the general function called on dragging or setCenter, to move the Layer to a new geographic location. Subclassed from <a href="#OpenLayers.Layer" title="OpenLayers.Layer">OpenLayers.Layer</a>.</td></tr>

228

  <tr><td>  getResolution()</td><td><span class="type" title="float">float</span></td><td>Return the current resolution of the map, in units/pixel. Subclassed from <a href="#OpenLayers.Layer" title="OpenLayers.Layer">OpenLayers.Layer</a>.</td></tr>

229

  <tr><td>  getExtent()</td><td><a href="#OpenLayers.Bounds" title="OpenLayers.Bounds">OpenLayers.Bounds</a></td><td>Return the geographic extent of the current map viewport. Subclassed from {OpenLayers.Layer}.</td></tr>

230

  <tr><td>  getZoomForExtent(<a href="#OpenLayers.Bounds" title="OpenLayers.Bounds">bounds</a>)</td><td><span class="type" title="Integer">Integer</span></td><td>return the integer zoom which most closely matches the passed bounds. Subclassed from <a href="#OpenLayers.Layer" title="OpenLayers.Layer">OpenLayers.Layer</a>.</td></tr>

231

  <tr><td>  getLonLatFromViewPortPx(<a href="#OpenLayers.Pixel" title="OpenLayers.Pixel">pixel</a>)</td><td><a href="#OpenLayers.LonLat" title="OpenLayers.LonLat">OpenLayers.LonLat</a></td><td>Returns an OpenLayers.LonLat which is the passed-in view port OpenLayers.Pixel, translated into lon/lat by the layer. Subclassed from {OpenLayers.Layer}.</td></tr>

232

  <tr><td>  getViewPortPxFromLonLat(<a href="#OpenLayers.LonLat" title="OpenLayers.LonLat">lonlat</a>)</td><td><a href="#OpenLayers.Pixel" title="OpenLayers.Pixel">OpenLayers.Pixel</a></td><td>Returns An OpenLayers.Pixel which is the passed-in OpenLayers.LonLat, translated into view port pixels. Subclassed from {OpenLayers.Layer}.</td></tr>

233

234

</table>

235

<h2>Parameters</h2>

236

<table>

237

  <tr><td>  buffer</td><td>Default 2. Number of tiles around the central map area which OpenLayers will preload so that dragging goes more smoothly.</td></tr>

238

  </table>

239

240

<h3>Subclassed from OpenLayers.Layer</h3>

241

  <table>

242

  <tr><td>  isBaseLayer</td><td>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.</td></tr>

243

  <tr><td>  projection</td><td>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.</td></tr>

244

  <tr><td>  maxExtent</td><td>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.</td></tr>

245

  <tr><td>  maxResolution</td><td>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.</td></tr>

246

  <tr><td>  maxZoomLevel</td><td>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.</td></tr>

247

  <tr><td>  minScale</td><td>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.</td></tr>

248

  <tr><td>  maxScale</td><td>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.</td></tr>

249

  <tr><td>  units</td><td>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.</td></tr>

250

</table></div>

251

<h1><a name="OpenLayers.Layer.WMS">OpenLayers.Layer.WMS</a></h1><div class="classref">

252

253

The WMS layer allows one to connect to a WMS server to obtain images. Params are available as a hash on the layer object, however, all keys are upper-cased automatically for maximum compatibility with WMS servers, so a parameter which is set as 'layers' will be uppercased to LAYERS. Where 'layer' is your Javscript variable for the layer, layer.params.LAYERS is the value of the layers param as set by the constructor.

254

255

If you wish to change params, you should use mergeNewParams, rather than accessing the parameters directly.

256

257

</table>

258

<h2>Constructor</h2>

259

<table>

260

  <tr><td>  OpenLayers.Layer.WMS(name, url, params, options)</td><td>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.</td></tr>

261

262

</table>

263

<h2>Methods</h2>

264

<table>

265

  <tr><td>  getURL(<a href="#OpenLayers.Bounds" title="OpenLayers.Bounds">bounds</a>)</td><td><span class="type" title="String">String</span></td><td>Returns a WMS URL for the given bounds based on the properties of the layer.</td></tr>

266

  All other methods are inherited from <a href="#OpenLayers.Layer.Grid" title="OpenLayers.Layer.Grid">OpenLayers.Layer.Grid</a>

267

268

</table>

269

<h2>Options </h2>

270

<table>

271

  <tr><td>  isBaseLayer</td><td>WMS layers default to being base layers unless one of their parameters is 'transparent':'true'.</td></tr>

272

</table></div>

273

<h1><a name="OpenLayers.Layer.KaMap">OpenLayers.Layer.KaMap</a></h1><div class="classref">

274

275

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.

276

277

</table>

278

<h2>Construtor</h2>

279

<table>

280

  <tr><td>  OpenLayers.Layer.KaMap(name, url, params, options)</td><td>URL is the url of the tile.php for KaMap.</td></tr>

281

282

</table></div>

283

<h1><a name="OpenLayers.Layer.EventPane">OpenLayers.Layer.EventPane</a></h1><div class="classref">

284

285

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.

286

287

</table>

288

<h2>Constructor</h2>

289

<table>

290

  <tr><td>  OpenLayers.Layer.EventPane(name, options)</td><td>Only designed to be used by subclasses.</td></tr>

291

</table></div>

292

<h1><a name="OpenLayers.Layer.Google">OpenLayers.Layer.Google</a></h1><div class="classref">

293

294

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,

295

296

</table>

297

<h2>Constructor</h2>

298

<table>

299

  <tr><td>  OpenLayers.Layer.Google(name, options?)</td><td>Constructor for Google layer. Accepts name and options.</td></tr>

300

301

</table>

302

<h2>Methods</h2>

303

<table>

304

  <tr><td>  getOLLonLatFromGLatLng(GLonLat)</td><td><a href="#OpenLayers.LonLat" title="OpenLayers.LonLat">OpenLayers.LonLat</a></td><td>Convert from GLatLon to OpenLayers LonLat</td></tr>

305

  <tr><td>  getGLatLngFromOLLonLat(<a href="#OpenLayers.LonLat" title="OpenLayers.LonLat">lonlat</a>)</td><td>GLatLon</td><td>Convert From OpenLayers LonLat to GLatLon</td></tr>

306

  <tr><td>  getOLPixelFromGPoint(GPoint)</td><td><a href="#OpenLayers.Pixel" title="OpenLayers.Pixel">OpenLayers.Pixel</a></td><td>Convert from GPoint to OpenLayers.Pixel</td></tr>

307

  <tr><td>  getGPointFromOLPixel(<a href="#OpenLayers.Pixel" title="OpenLayers.Pixel">pixel</a>)</td><td>GPoint</td><td>Create GPoint from OpenLayers Pixel.</td></tr>

308

309

</table>

310

<h2>Parameters</h2>

311

<table>

312

  <tr><td>  type</td><td>one of G_MAP, G_SATELLITE_MAP, G_HYBRID_MAP, used to choose the type of map to display.</td></tr>

313

314

</table></div>

315

<h1><a name="OpenLayers.Layer.VirtualEarth">OpenLayers.Layer.VirtualEarth</a></h1><div class="classref">

316

317

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.

318

319

</table>

320

<h2>Constructor</h2>

321

<table>

322

  <tr><td>  OpenLayers.Layer.VirtualEarth(name)</td><td>Constructor for Virtual Earth layer. Accepts name.</td></tr>

323

324

</table>

325

<h2>Methods</h2>

326

<table>

327

  <tr><td>  getOLLonLatFromVELatLng(VELatLon)</td><td><a href="#OpenLayers.LonLat" title="OpenLayers.LonLat">OpenLayers.LonLat</a></td><td>Convert from VELatLon to OpenLayers LonLat</td></tr>

328

  <tr><td>  getVELatLngFromOLLonLat(<a href="#OpenLayers.LonLat" title="OpenLayers.LonLat">lonlat</a>)</td><td>VELatLon</td><td>Convert From OpenLayers LonLat to VELatLon</td></tr>

329

  <tr><td>  getOLPixelFromVEPoint(Msn.VE.Pixel)</td><td><a href="#OpenLayers.Pixel" title="OpenLayers.Pixel">OpenLayers.Pixel</a></td><td>Convert from VEPoint to OpenLayers.Pixel</td></tr>

330

  <tr><td>  getGPointFromOLPixel(<a href="#OpenLayers.Pixel" title="OpenLayers.Pixel">pixel</a>)</td><td>Msn.VE.Pixel</td><td>Create Msvn.VE.Pixel from OpenLayers Pixel.</td></tr>

331

332

333

</table></div>

334

<h1><a name="OpenLayers.Layer.Markers">OpenLayers.Layer.Markers</a></h1><div class="classref">

335

336

The base class for all vector drawing, The OpenLayers.Layer.Markers layer is the primary way to get annotations into your map.

337

338

</table>

339

<h2>Constructor</h2>

340

<table>

341

  <tr><td>  OpenLayers.Layer.Markers(name, options)</td><td>Name and options for layer.</td></tr>

342

343

</table>

344

<h2>Methods</h2>

345

<table>

346

  <tr><td>  addMarker(<a href="#OpenLayers.Marker" title="OpenLayers.Marker">Marker</a>)</td><td>none</td><td>Adds a marker to the layer, sets the map object on the marker, and calls drawMarker on the marker.</td></tr>

347

  <tr><td>  removeMarker(<a href="#OpenLayers.Marker" title="OpenLayers.Marker">Marker</a>)</td><td>none</td><td>Remove the marker from the layer and map.</td></tr>

348

  <tr><td>  clearMarkers()</td><td>none</td><td>Remove all markers from the layer with removeMarker.</td></tr>

349

  <tr><td>  redraw()</td><td>none</td><td>Redraw all markers. Used so that markers can change their position when a base layer changes.</td></tr>

350

  <tr><td>  drawMarker</td><td>none</td><td>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.</td></tr>

351

</table></div>

352

<h1><a name="OpenLayers.Layer.Text">OpenLayers.Layer.Text</a></h1><div class="classref">

353

354

Subclass of Markers layer which retrieves CSV file from the web, and parses content to create markers and popups.

355

356

</table>

357

<h2>Constructor</h2>

358

<table>

359

  <tr><td>  OpenLayers.Layer.Text(name, options)</td><td>Pass in name, and set location: 'URL of CSV file' in the options hash.</td></tr>

360

361

</table>

362

<h2>Methods</h2>

363

<table>

364

  <tr><td>  parseData(ajaxRequest)</td><td>none</td><td>Parses returned CSV file. </td></tr>

365

366

</table></div>

367

<h1><a name="OpenLayers.Layer.GeoRSS">OpenLayers.Layer.GeoRSS</a></h1><div class="classref">

368

369

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. The GeoRSS layer supports 1.0 and 2.0 in IE and Firefox, and supports 2.0 in Safari. (Ticket #111 explains the reason for this difference.)

370

371

372

</table>

373

<h2>Constructor</h2>

374

<table>

375

  <tr><td>  OpenLayers.Layer.GeoRSS(name, url)</td><td>Name and location of GeoRSS XML file.</td></tr>

376

377

</table>

378

<h2>Methods</h2>

379

<table>

380

  <tr><td>  parseData(ajaxResponse)</td><td>none</td><td>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'.</td></tr>

381

  <tr><td>  markerClick(Event)</td><td>none</td><td>Action to perform when a marker is clicked.</td></tr>

382

  <tr><td>  clearFeatures()</td><td>none</td><td>Removes all features and markers from the map.</td></tr>

383

</table></div>

384

<h1><a name="OpenLayers.Layer.Boxes">OpenLayers.Layer.Boxes</a></h1><div class="classref">

385

386

A subclass of the markers layer, this layer draws boxes using div elements

387

instead of icons using images.

388

389

</table>

390

<h2>Constructor</h2>

391

<table>

392

  <tr><td>  OpenLayers.Layer.Boxes(name, options)</td><td>Same as OpenLayers.Layer.Markers.</td></tr>

393

</table></div>

394

<h1><a name="OpenLayers.Icon">OpenLayers.Icon</a></h1><div class="classref">

395

396

Icon is used as the visual representation of a Marker. Creating such a representation requres up to three parts: An Icon URL, a size, and an offset. The icon URL is a pointer to an image to use as an icon. The size is the size of the image, as an <a href="#OpenLayers.Size" title="OpenLayers.Size">OpenLayers.Size</a> object, and the offset is the position of the top left corner of the image in pixels, relative to the latitude and longitude of the Marker.

397

398

</table>

399

<h2>Constructor</h2>

400

<table>

401

  <tr><td>  OpenLayers.Icon(<span class="type" title="String">url</span>, <a href="#OpenLayers.Size" title="OpenLayers.Size">size</a>, <a href="#OpenLayers.Pixel" title="OpenLayers.Pixel">offset</a>)</td><td>creates a new icon.</td></tr>

402

403

</table>

404

<h2>Methods</h2>

405

<table>

406

  <tr><td>  clone()</td><td><a href="#OpenLayers.Icon" title="OpenLayers.Icon">OpenLayers.Icon</a></td><td>Create an exact copy of the icon.</td></tr>

407

</table></div>

408

<h1><a name="OpenLayers.Marker">OpenLayers.Marker</a></h1><div class="classref">

409

410

Instantiate class <a href="#OpenLayers.Marker" title="OpenLayers.Marker">OpenLayers.Marker</a> in order to create a marker.

411

412

</table>

413

<h2>Constructor</h2>

414

<table>

415

  <tr><td>  OpenLayers.Marker(<a href="#OpenLayers.LonLat" title="OpenLayers.LonLat">lonlat</a>, <a href="#OpenLayers.Icon" title="OpenLayers.Icon">icon</a>?  )</td><td>Creates a new marker object. This object must be added to a Marker layer and will then be displayed. The icon can be left null</td><td>if this is the case, then the default OpenLayers icon will be used.</td></tr>

416

417

</table>

418

<h2>Methods</h2>

419

<table>

420

  <tr><td>  onScreen()</td><td><span class="type" title="boolean">boolean</span></td><td>Returns whether or not the marker is currently visible on screen.</td></tr>

421

  <tr><td>  inflate(<span class="type" title="float">float</span>)</td><td>none</td><td>Changes the size of the Icon by a factor of the passed float.</td></tr>

422

  <tr><td>  display(<span class="type" title="string">string</span>)</td><td>none</td><td>Sets the style.display property of the Icon.</td></tr>

423

424

</table>

425

<h2>Events</h2>

426

<table>

427

  Standard browser events are available.

428

429

</table></div>

430

<h1><a name="OpenLayers.Marker.Box">OpenLayers.Marker.Box</a></h1><div class="classref">

431

432

A different kind of Marker, designed to be added to a Boxes layer instead of a Markers layer.

433

434

</table>

435

<h2>Constructor</h2>

436

<table>

437

  <tr><td>  OpenLayers.Marker.Box(<a href="#OpenLayers.Bounds" title="OpenLayers.Bounds">bounds</a>, borderColor, borderWidth)</td><td>Set up a box. Defaults are red, with a width of 2.</td></tr>

438

439

</table>

440

<h2>Methods</h2>

441

<table>

442

  <tr><td>  setBorder(color, width)</td><td>sets properties of border color and width.</td></tr>

443

444

</table></div>

445

<h1><a name="OpenLayers.Tile">OpenLayers.Tile</a></h1><div class="classref">

446

447

This is a class designed to designate a single tile, however

448

it is explicitly designed to do relatively little. Tiles store information

449

  <tr><td>about themselves</td><td>such as the URL that they are related to, and their </td></tr>

450

size - but do not add themselves to the layer div automatically, for

451

example.

452

453

</table>

454

<h2>Constructor</h2>

455

<table>

456

  <tr><td>  OpenLayers.Tile(<a href="#OpenLayers.Layer" title="OpenLayers.Layer">layer</a>, <a href="#OpenLayers.Pixel" title="OpenLayers.Pixel">position</a>, <a href="#OpenLayers.Bounds" title="OpenLayers.Bounds">bounds</a>, <span class="type" title="String">url</span>, <a href="#OpenLayers.Size" title="OpenLayers.Size">size</a>)</td><td>Create a new tile, with properties passed.</td></tr>

457

</table></div>

458

<h1><a name="OpenLayers.Tile.Image">OpenLayers.Tile.Image</a></h1><div class="classref">

459

460

The image tile is designed to hold images for all types of layers, from WMS to KaMap to WorldWind.

461

462

</table>

463

<h2>Constructor</h2>

464

<table>

465

  <tr><td>  OpenLayers.Tile.Image(<a href="#OpenLayers.Layer" title="OpenLayers.Layer">layer</a>, <a href="#OpenLayers.Pixel" title="OpenLayers.Pixel">position</a>, <a href="#OpenLayers.Bounds" title="OpenLayers.Bounds">bounds</a>, <span class="type" title="String">url</span>, <a href="#OpenLayers.Size" title="OpenLayers.Size">size</a>)</td><td>Create a new tile, with properties passed.</td></tr>

466

467

</table></div>

468

<h1><a name="OpenLayers.Tile.WFS">OpenLayers.Tile.WFS</a></h1><div class="classref">

469

470

The WFS tile allows you to load any number of WFS URLs into a single tile.

471

472

</table>

473

<h2>Constructor</h2>

474

<table>

475

  <tr><td>  OpenLayers.Tile.WFS(<a href="#OpenLayers.Layer" title="OpenLayers.Layer">layer</a>, <a href="#OpenLayers.Pixel" title="OpenLayers.Pixel">position</a>, <a href="#OpenLayers.Bounds" title="OpenLayers.Bounds">bounds</a>, <span class="type" title="String">urls</span>, <a href="#OpenLayers.Size" title="OpenLayers.Size">size</a>)</td><td>Create a new tile, with properties passed. The major difference between this tile and other tiles is what it does with results: The WFS tile is designed to parse XML responses, and create features for each item in the response. </td></tr>

476

</table></div>

477

<h1><a name="OpenLayers.Control">OpenLayers.Control</a></h1><div class="classref">

478

479

Base class from which controls are derived. Controls are elements of the map used to control things like zoom, layer status, or to provide information to the user about the status of the map, such as scale or copyright information.

480

481

</table>

482

<h2>Constructor</h2>

483

<table>

484

  <tr><td>  OpenLayers.Control(<span class="type" title="Object">options</span>?)</td><td>Creates a new control. The options here are used to control parameters of the control. The base control defines only "position", which is designed to be an <a href="#OpenLayers.Pixel" title="OpenLayers.Pixel">OpenLayers.Pixel</a> which is the top-left of the location of the control relative to the map div. </td></tr>

485

486

</table>

487

<h2>Parameters</h2>

488

<table>

489

  <tr><td>  position</td><td><a href="#OpenLayers.Pixel" title="OpenLayers.Pixel">OpenLayers.Pixel</a> to use as the top-left corner of the control div, relative to the map area.</td></tr>

490

</table></div>

491

<h1><a name="OpenLayers.Control.LayerSwitcher">OpenLayers.Control.LayerSwitcher</a></h1><div class="classref">

492

493

This control will by default display a small image in the upper right corner of the map. When clicked, this image expands into a control which allows one to select between multiple types of layers, seperated into two types: Base Layers and Overlays. Only one base layer can be selected at a time, and is enforced by a radio button control being used. Multiple overlays can be selected at once, and a checkbox control is visible for this functionality.

494

</table>

495

<h2>Constructor</h2>

496

<table>

497

  <tr><td>  OpenLayers.Control.LayerSwitcher(<span class="type" title="Object">options</span>?)</td><td>Creates a new control.</td></tr>

498

499

</table>

500

<h2>Methods</h2>

501

<table>

502

  <tr><td>  maximizeControl()</td><td>none</td><td>Expand the layer switcher control.</td></tr>

503

  <tr><td>  minimizeControl()</td><td>none</td><td>Close the layer switcher control.</td></tr>

504

505

</table>

506

<h2>Parameters</h2>

507

<table>

508

  <tr><td>  position</td><td>(inherited from <a href="#OpenLayers.Control" title="OpenLayers.Control">OpenLayers.Control</a>) {OpenLayers.Pixel} to use as the top-left corner of the control div, relative to the map area.</td></tr>

509

  <tr><td>  activeColor</td><td>The color to use for the background of the layer switcher div.</td></tr>

510

511

</table></div>

512

<h1><a name="OpenLayers.Control.MouseDefaults">OpenLayers.Control.MouseDefaults</a></h1><div class="classref">

513

514

Control to set up mouse handling. This includes clicks, double clicks, scrollwheel events, and mouse movement. There are a number of functions which act as the default handlers for these events: if you wish to create your own mouse control which behaves differently, you should create a subclass of MouseDefaults, replacing the functions whose behavior you wish to change.

515

516

517

</table>

518

<h2>Constructor</h2>

519

<table>

520

  <tr><td>  OpenLayers.Control()</td><td>Creates a new control. No options available. </td></tr>

521

522

</table>

523

<h2>Methods</h2>

524

<table>

525

  <tr><td>  defaultClick</td><td>none</td><td>This event takes place when a click event occurs on the map.</td></tr>

526

  <tr><td>  defaultDblClick</td><td>none</td><td>This event re-centers the map on the clicked location.</td></tr>

527

  <tr><td>  defaultMouseDown</td><td>none</td><td>This event starts a dragging event, so that the map can be dragged. If the shift key is held, it starts a 'zoombox' or rubber-band-zoom action instead.</td></tr>

528

  <tr><td>  defaultMouseMove</td><td>none</td><td>If a mouseDrag is in operation, this function causes the map to move to follow the cursor. If a zoombox is in place, this increases the size of the zoombox element to match the cursor.</td></tr>

529

  <tr><td>  defaultMouseUp</td><td>none</td><td>This function is called when a mouseup event is received, and either sets the center of the map to be the final location or zooms to the zoombox if enabled.</td></tr>

530

  <tr><td>  defaultMouseOut</td><td>none</td><td>This calls defaultMouseUp, so that when you mouse out of the map div, the events are stopped.</td></tr>

531

  <tr><td>  defaultWheelUp</td><td>none</td><td>Zooms in one level. Called by onWheelEvent</td></tr>

532

  <tr><td>  defaultWheelDown</td><td>none</td><td>Zooms out one level. Called by onWheelEvent.</td></tr>

533

  <tr><td>  onWheelEvent</td><td>none</td><td>catches the map wheel event, and handles it, zooming appropriately. </td></tr>

534

535

</table></div>

536

<h1><a name="OpenLayers.Control.MouseToolbar">OpenLayers.Control.MouseToolbar</a></h1><div class="classref">

537

538

Control to set up mouse handling. This includes clicks, double clicks, scrollwheel events, and mouse movement. There are a number of functions which act as the default handlers for these events: if you wish to create your own mouse control which behaves differently, you should create a subclass of MouseToolbar, replacing the functions whose behavior you wish to change. Additionally, a toolbar of images can be clicked to start events, as well as using the keyboard shortcuts.

539

540

</table>

541

<h2>Constructor</h2>

542

<table>

543

  <tr><td>  OpenLayers.Control.MouseToolbar(<a href="#OpenLayers.Pixel" title="OpenLayers.Pixel">position</a>, <span class="type" title="String">direction</span>)</td><td>Creates a new control. The direction of the control can be either "vertical" or "horizontal". The default is vertical.</td></tr>

544

545

</table>

546

<h2>Methods</h2>

547

<table>

548

  <tr><td>  defaultClick</td><td>none</td><td>This event takes place when a click event occurs on the map.</td></tr>

549

  <tr><td>  defaultDblClick</td><td>none</td><td>This event re-centers the map on the clicked location.</td></tr>

550

  <tr><td>  defaultMouseDown</td><td>none</td><td>This event starts a dragging event, so that the map can be dragged. If the shift key is held, it starts a 'zoombox' or rubber-band-zoom action instead.</td></tr>

551

  <tr><td>  defaultMouseMove</td><td>none</td><td>If a mouseDrag is in operation, this function causes the map to move to follow the cursor. If a zoombox is in place, this increases the size of the zoombox element to match the cursor.</td></tr>

552

  <tr><td>  defaultMouseUp</td><td>none</td><td>This function is called when a mouseup event is received, and either sets the center of the map to be the final location or zooms to the zoombox if enabled.</td></tr>

553

  <tr><td>  defaultMouseOut</td><td>none</td><td>This calls defaultMouseUp, so that when you mouse out of the map div, the events are stopped.</td></tr>

554

555

</table></div>

556

<h1><a name="OpenLayers.Control.PanZoom">OpenLayers.Control.PanZoom</a></h1><div class="classref">

557

558

Creates a small toolset for controlling the location of the map with panning and zooming, including four directional arrows, a zoom in and zoom out, and one button which zooms to the max extent of the map.

559

560

</table>

561

<h2>Constructor</h2>

562

<table>

563

  <tr><td>  OpenLayers.Control.PanZoom(<span class="type" title="Object">options</span>)</td><td>Creates a new panzoom control.</td></tr>

564

565

</table>

566

<h2>Parameters</h2>

567

<table>

568

  <tr><td>  slideFactor</td><td>Number of pixels by which to slide the map when a pan arrow is clicked.</td></tr>

569

</table></div>

570

<h1><a name="OpenLayers.Control.PanZoom">OpenLayers.Control.PanZoom</a></h1><div class="classref">

571

572

Creates a small toolset for controlling the location of the map with panning and zooming, including four directional arrows, a zoom in and zoom out, and a bar on which a slider can be moved to zoom in or out by multiple stops at once.

573

574

</table>

575

<h2>Constructor</h2>

576

<table>

577

  <tr><td>  OpenLayers.Control.PanZoomBar()</td><td>Creates a new panzoombar control.</td></tr>

578

</table></div>

579

<h1><a name="OpenLayers.Control.Permalink">OpenLayers.Control.Permalink</a></h1><div class="classref">

580

581

A small control which updates a "Permalink" to the map every time the viewport changes. This allows users to copy a link to a specfic map view. By default, it places itself in the lower right corner of the map. This control must be added to the map after a baselayer has been set.

582

583

</table>

584

<h2>Constructor</h2>

585

<table>

586

  <tr><td>  OpenLayers.Control.Scale(<span class="type" title="DOMElement">element</span>?, <span class="type" title="String">base</span>)</td><td>Creates a new permalink control. The DOMElement is used, if passed, as the element on which the 'href' is set. If you prefer to put this link on an element outside of the map, set this element to an anchor element to have its href updated when the map moves. If you wish to make the link go to some other URL (for example, an editing interface rather than the current URL), the 'base' property can be used, to which the ?lat=&lon=&zoom= will be appended after the map has moved.</td></tr>

587

</table></div>

588

<h1><a name="OpenLayers.Control.Scale">OpenLayers.Control.Scale</a></h1><div class="classref">

589

590

A small control which displays an informative scale value, a la "1:50K" , by defualt in the lower right of the map viewport.

591

592

</table>

593

<h2>Constructor</h2>

594

<table>

595

  <tr><td>  OpenLayers.Control.Scale(<span class="type" title="DOMElement">element</span>?)</td><td>Creates a new scale control. The DOMElement is used, if passed, to put the scale inside</td><td>this allows you to have the scale displayed in some location outside the map. </td></tr>

596

</table></div>

597

<h1><a name="OpenLayers.LonLat">OpenLayers.LonLat</a></h1><div class="classref">

598

599

This class represents a geographic coordinate pair, either projected or unprojected.

600

601

</table>

602

<h2>Constructor</h2>

603

<table>

604

  <tr><td>  OpenLayers.LonLat(<span class="type" title="float">lon</span>, <span class="type" title="float">lat</span>)</td><td>Create LonLat.</td></tr>

605

606

</table>

607

<h2>Methods</h2>

608

<table>

609

  <tr><td>  toString()</td><td><span class="type" title="String">String</span></td><td>Converts to human readable string.</td></tr>

610

  <tr><td>  toShortString()</td><td><span class="type" title="String">String</span></td><td>Converts to short human readable string.</td></tr>

611

  <tr><td>  clone()</td><td><a href="#OpenLayers.Size" title="OpenLayers.Size">OpenLayers.Size</a></td><td>Returns a copy of the pixel.</td></tr>

612

  <tr><td>  equals(<a href="#OpenLayers.LonLat" title="OpenLayers.LonLat">ll</a>)</td><td><span class="type" title="Boolean">Boolean</span></td><td>Compares two LonLats. </td></tr>

613

  <tr><td>  add(<span class="type" title="int">lon</span>, <span class="type" title="int">lat</span>)</td><td><a href="#OpenLayers.LonLat" title="OpenLayers.LonLat">OpenLayers.LonLat</a></td><td>add x and y to the current coordinates.</td></tr>

614

</table></div>

615

<h1><a name="OpenLayers.Size">OpenLayers.Size</a></h1><div class="classref">

616

617

This class represents a width/height pair.

618

619

</table>

620

<h2>Constructor</h2>

621

<table>

622

  <tr><td>  OpenLayers.Size(<span class="type" title="float">h</span>, <span class="type" title="float">w</span>)</td><td>Create Size.</td></tr>

623

624

</table>

625

<h2>Methods</h2>

626

<table>

627

  <tr><td>  toString()</td><td><span class="type" title="String">String</span></td><td>Converts to human readable string.</td></tr>

628

  <tr><td>  clone()</td><td><a href="#OpenLayers.Size" title="OpenLayers.Size">OpenLayers.Size</a></td><td>Returns a copy of the pixel.</td></tr>

629

  <tr><td>  add(<span class="type" title="int">x</span>, <span class="type" title="int">y</span>)</td><td><a href="#OpenLayers.Size" title="OpenLayers.Size">OpenLayers.Size</a></td><td>add x and y to the current coordinates.</td></tr>

630

</table></div>

631

<h1><a name="OpenLayers.Pixel">OpenLayers.Pixel</a></h1><div class="classref">

632

633

This class represents a screen coordinate in x and y coordinates.

634

635

</table>

636

<h2>Constructor</h2>

637

<table>

638

  <tr><td>  OpenLayers.Pixel(<span class="type" title="float">x</span>, <span class="type" title="float">y</span>)</td><td>Create Pixel.</td></tr>

639

640

</table>

641

<h2>Methods</h2>

642

<table>

643

  <tr><td>  toString()</td><td><span class="type" title="String">String</span></td><td>Converts to human readable string.</td></tr>

644

  <tr><td>  clone()</td><td><a href="#OpenLayers.Pixel" title="OpenLayers.Pixel">OpenLayers.Pixel</a></td><td>Returns a copy of the pixel.</td></tr>

645

  <tr><td>  equals(<a href="#OpenLayers.Pixel" title="OpenLayers.Pixel">px</a>)</td><td><span class="type" title="Boolean">Boolean</span></td><td>Tests for equivilance.</td></tr>

646

  <tr><td>  add(<span class="type" title="int">x</span>, <span class="type" title="int">y</span>)</td><td><a href="#OpenLayers.Pixel" title="OpenLayers.Pixel">OpenLayers.Pixel</a></td><td>add x and y to the current coordinates.</td></tr>

647

  <tr><td>  offset(<a href="#OpenLayers.Pixel" title="OpenLayers.Pixel">pixel</a>)</td><td><a href="#OpenLayers.Pixel" title="OpenLayers.Pixel">OpenLayers.Pixel</a></td><td>Add pixels together.</td></tr>

648

</table></div>

649

<h1><a name="OpenLayers.Bounds">OpenLayers.Bounds</a></h1><div class="classref">

650

651

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

652

653

</table>

654

<h2>Constructor</h2>

655

<table>

656

  <tr><td>  OpenLayers.Bounds(left, bottom, right, top)</td><td>Create new Bounds.</td></tr>

657

658

</table>

659

<h2>Methods</h2>

660

<table>

661

  <tr><td>  clone()</td><td><a href="#OpenLayers.Bounds" title="OpenLayers.Bounds">OpenLayers.Bounds</a></td><td>Return copy of the current bounds.</td></tr>

662

  <tr><td>  toString()</td><td><span class="type" title="String">String</span></td><td>Return bounds as string. </td></tr>

663

  <tr><td>  toBBOX()</td><td><span class="type" title="String">String</span></td><td>Return bounds as simple string, usable for WMS.</td></tr>

664

  <tr><td>  getWidth()</td><td><span class="type" title="float">float</span></td><td>Return width of bounds.</td></tr>

665

  <tr><td>  getHeight()</td><td><span class="type" title="float">float</span></td><td>Return height of bounds.</td></tr>

666

  <tr><td>  getSize()</td><td><a href="#OpenLayers.Size" title="OpenLayers.Size">OpenLayers.Size</a></td><td>Return size of bounds.</td></tr>

667

  <tr><td>  getCenterPixel()</td><td><a href="#OpenLayers.Pixel" title="OpenLayers.Pixel">OpenLayers.Pixel</a></td><td>Return center of bounds as pixel.</td></tr>

668

  <tr><td>  getCenterLonLat()</td><td><a href="#OpenLayers.LonLat" title="OpenLayers.LonLat">OpenLayers.LonLat</a></td><td>Return center of bounds as LonLat.</td></tr>

669

  <tr><td>  equals(<a href="#OpenLayers.Bounds" title="OpenLayers.Bounds">bounds</a>)</td><td><span class="type" title="Boolean">Boolean</span></td><td>whether or not the bounds are equivilant.</td></tr>

670

  <tr><td>  add(<span class="type" title="float">x</span>, <span class="type" title="float">y</span>)</td><td><a href="#OpenLayers.Bounds" title="OpenLayers.Bounds">OpenLayers.Bounds</a></td><td>Shift bounds by x and y. </td></tr>

671

  <tr><td>  contains(<span class="type" title="float">x</span>, <span class="type" title="float">y</span>, <span class="type" title="Boolean">inclusive</span>)</td><td><span class="type" title="Boolean">Boolean</span></td><td>Return Whether or not the passed-in coordinates are within this bounds </td></tr>

672

  <tr><td>  containsBounds(<a href="#OpenLayers.Bounds" title="OpenLayers.Bounds">bounds</a>, <span class="type" title="Boolean">partial</span>, <span class="type" title="Boolean">inclusive</span>)</td><td><span class="type" title="Boolean">Boolean</span></td><td>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.</td></tr>

673

  <tr><td>  determineQuadrant(<a href="#OpenLayers.LonLat" title="OpenLayers.LonLat">lonlat</a>)</td><td><span class="type" title="String">String</span></td><td>Determine which quadrant the LonLat is in. Returns combination of "b" or "t" and "l" or "r".</td></tr>

674

</table></div>

675

  </body>

676

</html>

Project

General

Profile

Metacat

Project

General

Profile

Metacat

metacat/lib/spatial/openlayers/doc/reference.html @ 4472