]> dev.renevier.net Git - syp.git/blob - openlayers/doc/devdocs/files/OpenLayers/Map-js.html
initial commit
[syp.git] / openlayers / doc / devdocs / files / OpenLayers / Map-js.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">
2
3 <html><head><title>OpenLayers.Map - OpenLayers</title><link rel="stylesheet" type="text/css" href="../../styles/main.css"><script language=JavaScript src="../../javascript/main.js"></script><script language=JavaScript src="../../javascript/searchdata.js"></script></head><body class="ContentPage" onLoad="NDOnLoad()"><script language=JavaScript><!--
4 if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
5
6 <!--  Generated by Natural Docs, version 1.4 -->
7 <!--  http://www.naturaldocs.org  -->
8
9 <!-- saved from url=(0026)http://www.naturaldocs.org -->
10
11
12
13
14 <div id=Content><div class="CClass"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="OpenLayers.Map"></a>OpenLayers.Map</h1><div class=CBody><p>Instances of OpenLayers.Map are interactive maps embedded in a web page.&nbsp; Create a new map with the <a href="#OpenLayers.Map.OpenLayers.Map" class=LConstructor id=link85 onMouseOver="ShowTip(event, 'tt74', 'link85')" onMouseOut="HideTip('tt74')">OpenLayers.Map</a> constructor.</p><p>On their own maps do not provide much functionality.&nbsp;  To extend a map it&rsquo;s necessary to add controls (<a href="Control-js.html#OpenLayers.Control" class=LClass id=link86 onMouseOver="ShowTip(event, 'tt3', 'link86')" onMouseOut="HideTip('tt3')">OpenLayers.Control</a>) and layers (<a href="Layer-js.html#OpenLayers.Layer" class=LClass >OpenLayers.Layer</a>) to the map.</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#OpenLayers.Map" >OpenLayers.Map</a></td><td class=SDescription>Instances of OpenLayers.Map are interactive maps embedded in a web page. </td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#OpenLayers.Map.Constants" >Constants</a></td><td class=SDescription></td></tr><tr class="SConstant SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.Z_INDEX_BASE" >Z_INDEX_BASE</a></td><td class=SDescription>{Object} Base z-indexes for different classes of thing</td></tr><tr class="SConstant SIndent2"><td class=SEntry><a href="#OpenLayers.Map.EVENT_TYPES" >EVENT_TYPES</a></td><td class=SDescription>{Array(String)} Supported application event types. </td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#OpenLayers.Map.Properties" >Properties</a></td><td class=SDescription></td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.id" >id</a></td><td class=SDescription>{String} Unique identifier for the map</td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#OpenLayers.Map.fractionalZoom" >fractionalZoom</a></td><td class=SDescription>{Boolean} For a base layer that supports it, allow the map resolution to be set to a value between one of the values in the resolutions array. </td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.events" >events</a></td><td class=SDescription>{<a href="Events-js.html#OpenLayers.Events" class=LClass >OpenLayers.Events</a>} An events object that handles all events on the map</td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#OpenLayers.Map.allOverlays" >allOverlays</a></td><td class=SDescription>{Boolean} Allow the map to function with &ldquo;overlays&rdquo; only. </td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.div" >div</a></td><td class=SDescription>{DOMElement|String} The element that contains the map (or an id for that element). </td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#OpenLayers.Map.dragging" >dragging</a></td><td class=SDescription>{Boolean} The map is currently being dragged.</td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.size" >size</a></td><td class=SDescription>{<a href="BaseTypes/Size-js.html#OpenLayers.Size" class=LClass id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">OpenLayers.Size</a>} Size of the main div (this.div)</td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#OpenLayers.Map.viewPortDiv" >viewPortDiv</a></td><td class=SDescription>{HTMLDivElement} The element that represents the map viewport</td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.layerContainerOrigin" >layerContainerOrigin</a></td><td class=SDescription>{<a href="BaseTypes/LonLat-js.html#OpenLayers.LonLat" class=LClass id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">OpenLayers.LonLat</a>} The lonlat at which the later container was re-initialized (on-zoom)</td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#OpenLayers.Map.layerContainerDiv" >layerContainerDiv</a></td><td class=SDescription>{HTMLDivElement} The element that contains the layers.</td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.layers" >layers</a></td><td class=SDescription>{Array(<a href="Layer-js.html#OpenLayers.Layer" class=LClass >OpenLayers.Layer</a>)} Ordered list of layers in the map</td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#OpenLayers.Map.controls" >controls</a></td><td class=SDescription>{Array(<a href="Control-js.html#OpenLayers.Control" class=LClass id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">OpenLayers.Control</a>)} List of controls associated with the map.</td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.popups" >popups</a></td><td class=SDescription>{Array(<a href="Popup-js.html#OpenLayers.Popup" class=LClass id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">OpenLayers.Popup</a>)} List of popups associated with the map</td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#OpenLayers.Map.baseLayer" >baseLayer</a></td><td class=SDescription>{<a href="Layer-js.html#OpenLayers.Layer" class=LClass >OpenLayers.Layer</a>} The currently selected base layer. </td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.center" >center</a></td><td class=SDescription>{<a href="BaseTypes/LonLat-js.html#OpenLayers.LonLat" class=LClass id=link5 onMouseOver="ShowTip(event, 'tt2', 'link5')" onMouseOut="HideTip('tt2')">OpenLayers.LonLat</a>} The current center of the map</td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#OpenLayers.Map.resolution" >resolution</a></td><td class=SDescription>{Float} The resolution of the map.</td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.zoom" >zoom</a></td><td class=SDescription>{Integer} The current zoom level of the map</td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#OpenLayers.Map.panRatio" >panRatio</a></td><td class=SDescription>{Float} The ratio of the current extent within which panning will tween.</td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.viewRequestID" >viewRequestID</a></td><td class=SDescription>{String} Used to store a unique identifier that changes when the map view changes. </td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#OpenLayers.Map.tileSize" >tileSize</a></td><td class=SDescription>{<a href="BaseTypes/Size-js.html#OpenLayers.Size" class=LClass id=link6 onMouseOver="ShowTip(event, 'tt1', 'link6')" onMouseOut="HideTip('tt1')">OpenLayers.Size</a>} Set in the map options to override the default tile size for this map.</td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.projection" >projection</a></td><td class=SDescription>{String} Set in the map options to override the default projection string this map - also set maxExtent, maxResolution, and units if appropriate. </td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#OpenLayers.Map.units" >units</a></td><td class=SDescription>{String} The map units. </td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.resolutions" >resolutions</a></td><td class=SDescription>{Array(Float)} A list of map resolutions (map units per pixel) in descending order. </td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#OpenLayers.Map.maxResolution" >maxResolution</a></td><td class=SDescription>{Float} Default max is 360 deg / 256 px, which corresponds to zoom level 0 on gmaps. </td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.minResolution" >minResolution</a></td><td class=SDescription>{Float}</td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#OpenLayers.Map.maxScale" >maxScale</a></td><td class=SDescription>{Float}</td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.minScale" >minScale</a></td><td class=SDescription>{Float}</td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#OpenLayers.Map.maxExtent" >maxExtent</a></td><td class=SDescription>{<a href="BaseTypes/Bounds-js.html#OpenLayers.Bounds" class=LClass id=link7 onMouseOver="ShowTip(event, 'tt5', 'link7')" onMouseOut="HideTip('tt5')">OpenLayers.Bounds</a>} The maximum extent for the map. </td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.minExtent" >minExtent</a></td><td class=SDescription>{<a href="BaseTypes/Bounds-js.html#OpenLayers.Bounds" class=LClass id=link8 onMouseOver="ShowTip(event, 'tt5', 'link8')" onMouseOut="HideTip('tt5')">OpenLayers.Bounds</a>}</td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#OpenLayers.Map.restrictedExtent" >restrictedExtent</a></td><td class=SDescription>{<a href="BaseTypes/Bounds-js.html#OpenLayers.Bounds" class=LClass id=link9 onMouseOver="ShowTip(event, 'tt5', 'link9')" onMouseOut="HideTip('tt5')">OpenLayers.Bounds</a>} Limit map navigation to this extent where possible. </td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.numZoomLevels" >numZoomLevels</a></td><td class=SDescription>{Integer} Number of zoom levels for the map. </td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#OpenLayers.Map.theme" >theme</a></td><td class=SDescription>{String} Relative path to a CSS file from which to load theme styles. </td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.displayProjection" >displayProjection</a></td><td class=SDescription>{<a href="Projection-js.html#OpenLayers.Projection" class=LClass id=link10 onMouseOver="ShowTip(event, 'tt6', 'link10')" onMouseOut="HideTip('tt6')">OpenLayers.Projection</a>} Requires proj4js support.Projection used by several controls to display data to user. </td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#OpenLayers.Map.fallThrough" >fallThrough</a></td><td class=SDescription>{Boolean} Should OpenLayers allow events on the map to fall through to other elements on the page, or should it swallow them?&nbsp; </td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.panTween" >panTween</a></td><td class=SDescription>{OpenLayers.Tween} Animated panning tween object, see panTo()</td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#OpenLayers.Map.eventListeners" >eventListeners</a></td><td class=SDescription>{Object} If set as an option at construction, the eventListeners object will be registered with <a href="Events-js.html#OpenLayers.Events.on" class=LFunction id=link11 onMouseOver="ShowTip(event, 'tt7', 'link11')" onMouseOut="HideTip('tt7')">OpenLayers.Events.on</a>. </td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.panMethod" >panMethod</a></td><td class=SDescription>{Function} The Easing function to be used for tweening. </td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#OpenLayers.Map.panDuration" >panDuration</a></td><td class=SDescription>{Integer} The number of steps to be passed to the OpenLayers.Tween.start() method when the map is panned. </td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.paddingForPopups" >paddingForPopups</a></td><td class=SDescription>{<a href="BaseTypes/Bounds-js.html#OpenLayers.Bounds" class=LClass id=link12 onMouseOver="ShowTip(event, 'tt5', 'link12')" onMouseOut="HideTip('tt5')">OpenLayers.Bounds</a>} Outside margin of the popup. </td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#OpenLayers.Map.Constructor" >Constructor</a></td><td class=SDescription></td></tr><tr class="SConstructor SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.OpenLayers.Map" >OpenLayers.Map</a></td><td class=SDescription>Constructor for a new OpenLayers.Map instance. </td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#OpenLayers.Map.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.render" id=link13 onMouseOver="ShowTip(event, 'tt8', 'link13')" onMouseOut="HideTip('tt8')">render</a></td><td class=SDescription>Render the map to a specified container.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Map.unloadDestroy" >unloadDestroy</a></td><td class=SDescription>Function that is called to destroy the map on page unload. </td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.updateSizeDestroy" >updateSizeDestroy</a></td><td class=SDescription>When the map is destroyed, we need to stop listening to updateSize events: this method stores the function we need to unregister in non-IE browsers.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Map.destroy" id=link14 onMouseOver="ShowTip(event, 'tt9', 'link14')" onMouseOut="HideTip('tt9')">destroy</a></td><td class=SDescription>Destroy this map</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.setOptions" id=link15 onMouseOver="ShowTip(event, 'tt10', 'link15')" onMouseOut="HideTip('tt10')">setOptions</a></td><td class=SDescription>Change the map options</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Map.getTileSize" id=link16 onMouseOver="ShowTip(event, 'tt11', 'link16')" onMouseOut="HideTip('tt11')">getTileSize</a></td><td class=SDescription>Get the tile size for the map</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.getBy" id=link17 onMouseOver="ShowTip(event, 'tt12', 'link17')" onMouseOut="HideTip('tt12')">getBy</a></td><td class=SDescription>Get a list of objects given a property and a match item.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Map.getLayersBy" id=link18 onMouseOver="ShowTip(event, 'tt13', 'link18')" onMouseOut="HideTip('tt13')">getLayersBy</a></td><td class=SDescription>Get a list of layers with properties matching the given criteria.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.getLayersByName" id=link19 onMouseOver="ShowTip(event, 'tt14', 'link19')" onMouseOut="HideTip('tt14')">getLayersByName</a></td><td class=SDescription>Get a list of layers with names matching the given name.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Map.getLayersByClass" id=link20 onMouseOver="ShowTip(event, 'tt15', 'link20')" onMouseOut="HideTip('tt15')">getLayersByClass</a></td><td class=SDescription>Get a list of layers of a given class (CLASS_NAME).</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.getControlsBy" id=link21 onMouseOver="ShowTip(event, 'tt16', 'link21')" onMouseOut="HideTip('tt16')">getControlsBy</a></td><td class=SDescription>Get a list of controls with properties matching the given criteria.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Map.getControlsByClass" id=link22 onMouseOver="ShowTip(event, 'tt17', 'link22')" onMouseOut="HideTip('tt17')">getControlsByClass</a></td><td class=SDescription>Get a list of controls of a given class (CLASS_NAME).</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.getLayer" id=link23 onMouseOver="ShowTip(event, 'tt18', 'link23')" onMouseOut="HideTip('tt18')">getLayer</a></td><td class=SDescription>Get a layer based on its id</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Map.setLayerZIndex" id=link24 onMouseOver="ShowTip(event, 'tt19', 'link24')" onMouseOut="HideTip('tt19')">setLayerZIndex</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.resetLayersZIndex" id=link25 onMouseOver="ShowTip(event, 'tt20', 'link25')" onMouseOut="HideTip('tt20')">resetLayersZIndex</a></td><td class=SDescription>Reset each layer&rsquo;s z-index based on layer&rsquo;s array index</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Map.addLayer" id=link26 onMouseOver="ShowTip(event, 'tt21', 'link26')" onMouseOut="HideTip('tt21')">addLayer</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.addLayers" id=link27 onMouseOver="ShowTip(event, 'tt22', 'link27')" onMouseOut="HideTip('tt22')">addLayers</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Map.removeLayer" id=link28 onMouseOver="ShowTip(event, 'tt23', 'link28')" onMouseOut="HideTip('tt23')">removeLayer</a></td><td class=SDescription>Removes a layer from the map by removing its visual element (the layer.div property), then removing it from the map&rsquo;s internal list of layers, setting the layer&rsquo;s map property to null.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.getNumLayers" id=link29 onMouseOver="ShowTip(event, 'tt24', 'link29')" onMouseOut="HideTip('tt24')">getNumLayers</a></td><td class=SDescription>{Int} The number of layers attached to the map.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Map.getLayerIndex" id=link30 onMouseOver="ShowTip(event, 'tt25', 'link30')" onMouseOut="HideTip('tt25')">getLayerIndex</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.setLayerIndex" id=link31 onMouseOver="ShowTip(event, 'tt26', 'link31')" onMouseOut="HideTip('tt26')">setLayerIndex</a></td><td class=SDescription>Move the given layer to the specified (zero-based) index in the layer list, changing its z-index in the map display. </td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Map.raiseLayer" id=link32 onMouseOver="ShowTip(event, 'tt27', 'link32')" onMouseOut="HideTip('tt27')">raiseLayer</a></td><td class=SDescription>Change the index of the given layer by delta. </td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.setBaseLayer" id=link33 onMouseOver="ShowTip(event, 'tt28', 'link33')" onMouseOut="HideTip('tt28')">setBaseLayer</a></td><td class=SDescription>Allows user to specify one of the currently-loaded layers as the Map&rsquo;s new base layer.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Map.addControl" id=link34 onMouseOver="ShowTip(event, 'tt29', 'link34')" onMouseOut="HideTip('tt29')">addControl</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.addControlToMap" id=link35 onMouseOver="ShowTip(event, 'tt30', 'link35')" onMouseOut="HideTip('tt30')">addControlToMap</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Map.getControl" id=link36 onMouseOver="ShowTip(event, 'tt31', 'link36')" onMouseOut="HideTip('tt31')">getControl</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.removeControl" id=link37 onMouseOver="ShowTip(event, 'tt32', 'link37')" onMouseOut="HideTip('tt32')">removeControl</a></td><td class=SDescription>Remove a control from the map. </td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Map.addPopup" id=link38 onMouseOver="ShowTip(event, 'tt33', 'link38')" onMouseOut="HideTip('tt33')">addPopup</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.removePopup" id=link39 onMouseOver="ShowTip(event, 'tt34', 'link39')" onMouseOut="HideTip('tt34')">removePopup</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Map.getSize" id=link40 onMouseOver="ShowTip(event, 'tt35', 'link40')" onMouseOut="HideTip('tt35')">getSize</a></td><td class=SDescription>{<a href="BaseTypes/Size-js.html#OpenLayers.Size" class=LClass id=link41 onMouseOver="ShowTip(event, 'tt1', 'link41')" onMouseOut="HideTip('tt1')">OpenLayers.Size</a>} An <a href="BaseTypes/Size-js.html#OpenLayers.Size" class=LClass id=link42 onMouseOver="ShowTip(event, 'tt1', 'link42')" onMouseOut="HideTip('tt1')">OpenLayers.Size</a> object that represents the size, in pixels, of the div into which OpenLayers has been loaded. </td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.updateSize" id=link43 onMouseOver="ShowTip(event, 'tt36', 'link43')" onMouseOut="HideTip('tt36')">updateSize</a></td><td class=SDescription>This function should be called by any external code which dynamically changes the size of the map div (because mozilla wont let us catch the &ldquo;onresize&rdquo; for an element)</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Map.getCurrentSize" id=link44 onMouseOver="ShowTip(event, 'tt37', 'link44')" onMouseOut="HideTip('tt37')">getCurrentSize</a></td><td class=SDescription>{<a href="BaseTypes/Size-js.html#OpenLayers.Size" class=LClass id=link45 onMouseOver="ShowTip(event, 'tt1', 'link45')" onMouseOut="HideTip('tt1')">OpenLayers.Size</a>} A new <a href="BaseTypes/Size-js.html#OpenLayers.Size" class=LClass id=link46 onMouseOver="ShowTip(event, 'tt1', 'link46')" onMouseOut="HideTip('tt1')">OpenLayers.Size</a> object with the dimensions of the map div</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.calculateBounds" id=link47 onMouseOver="ShowTip(event, 'tt38', 'link47')" onMouseOut="HideTip('tt38')">calculateBounds</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Map.getCenter" id=link48 onMouseOver="ShowTip(event, 'tt39', 'link48')" onMouseOut="HideTip('tt39')">getCenter</a></td><td class=SDescription>{<a href="BaseTypes/LonLat-js.html#OpenLayers.LonLat" class=LClass id=link49 onMouseOver="ShowTip(event, 'tt2', 'link49')" onMouseOut="HideTip('tt2')">OpenLayers.LonLat</a>}</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.getZoom" id=link50 onMouseOver="ShowTip(event, 'tt40', 'link50')" onMouseOut="HideTip('tt40')">getZoom</a></td><td class=SDescription>{Integer}</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Map.pan" id=link51 onMouseOver="ShowTip(event, 'tt41', 'link51')" onMouseOut="HideTip('tt41')">pan</a></td><td class=SDescription>Allows user to pan by a value of screen pixels</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.panTo" id=link52 onMouseOver="ShowTip(event, 'tt42', 'link52')" onMouseOut="HideTip('tt42')">panTo</a></td><td class=SDescription>Allows user to pan to a new lonlat If the new lonlat is in the current extent the map will slide smoothly</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Map.setCenter" id=link53 onMouseOver="ShowTip(event, 'tt43', 'link53')" onMouseOut="HideTip('tt43')">setCenter</a></td><td class=SDescription>Set the map center (and optionally, the zoom level).</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.moveTo" id=link54 onMouseOver="ShowTip(event, 'tt44', 'link54')" onMouseOut="HideTip('tt44')">moveTo</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Map.centerLayerContainer" id=link55 onMouseOver="ShowTip(event, 'tt45', 'link55')" onMouseOut="HideTip('tt45')">centerLayerContainer</a></td><td class=SDescription>This function takes care to recenter the layerContainerDiv.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.isValidZoomLevel" id=link56 onMouseOver="ShowTip(event, 'tt46', 'link56')" onMouseOut="HideTip('tt46')">isValidZoomLevel</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Map.isValidLonLat" id=link57 onMouseOver="ShowTip(event, 'tt47', 'link57')" onMouseOut="HideTip('tt47')">isValidLonLat</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.getProjection" id=link58 onMouseOver="ShowTip(event, 'tt48', 'link58')" onMouseOut="HideTip('tt48')">getProjection</a></td><td class=SDescription>This method returns a string representing the projection. </td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Map.getProjectionObject" id=link59 onMouseOver="ShowTip(event, 'tt49', 'link59')" onMouseOut="HideTip('tt49')">getProjectionObject</a></td><td class=SDescription>Returns the projection obect from the baselayer.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.getMaxResolution" id=link60 onMouseOver="ShowTip(event, 'tt50', 'link60')" onMouseOut="HideTip('tt50')">getMaxResolution</a></td><td class=SDescription>{String} The Map&rsquo;s Maximum Resolution</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Map.getMaxExtent" id=link61 onMouseOver="ShowTip(event, 'tt51', 'link61')" onMouseOut="HideTip('tt51')">getMaxExtent</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.getNumZoomLevels" id=link62 onMouseOver="ShowTip(event, 'tt52', 'link62')" onMouseOut="HideTip('tt52')">getNumZoomLevels</a></td><td class=SDescription>{Integer} The total number of zoom levels that can be displayed by the current baseLayer.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Map.getExtent" id=link63 onMouseOver="ShowTip(event, 'tt53', 'link63')" onMouseOut="HideTip('tt53')">getExtent</a></td><td class=SDescription>{<a href="BaseTypes/Bounds-js.html#OpenLayers.Bounds" class=LClass id=link64 onMouseOver="ShowTip(event, 'tt5', 'link64')" onMouseOut="HideTip('tt5')">OpenLayers.Bounds</a>} A Bounds object which represents the lon/lat bounds of the current viewPort. </td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.getResolution" id=link65 onMouseOver="ShowTip(event, 'tt54', 'link65')" onMouseOut="HideTip('tt54')">getResolution</a></td><td class=SDescription>{Float} The current resolution of the map. </td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Map.getUnits" id=link66 onMouseOver="ShowTip(event, 'tt55', 'link66')" onMouseOut="HideTip('tt55')">getUnits</a></td><td class=SDescription>{Float} The current units of the map. </td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.getScale" id=link67 onMouseOver="ShowTip(event, 'tt56', 'link67')" onMouseOut="HideTip('tt56')">getScale</a></td><td class=SDescription>{Float} The current scale denominator of the map. </td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Map.getZoomForExtent" id=link68 onMouseOver="ShowTip(event, 'tt57', 'link68')" onMouseOut="HideTip('tt57')">getZoomForExtent</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.getResolutionForZoom" id=link69 onMouseOver="ShowTip(event, 'tt58', 'link69')" onMouseOut="HideTip('tt58')">getResolutionForZoom</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Map.getZoomForResolution" id=link70 onMouseOver="ShowTip(event, 'tt59', 'link70')" onMouseOut="HideTip('tt59')">getZoomForResolution</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.zoomTo" id=link71 onMouseOver="ShowTip(event, 'tt60', 'link71')" onMouseOut="HideTip('tt60')">zoomTo</a></td><td class=SDescription>Zoom to a specific zoom level</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Map.zoomIn" id=link72 onMouseOver="ShowTip(event, 'tt61', 'link72')" onMouseOut="HideTip('tt61')">zoomIn</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.zoomOut" id=link73 onMouseOver="ShowTip(event, 'tt62', 'link73')" onMouseOut="HideTip('tt62')">zoomOut</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Map.zoomToExtent" id=link74 onMouseOver="ShowTip(event, 'tt63', 'link74')" onMouseOut="HideTip('tt63')">zoomToExtent</a></td><td class=SDescription>Zoom to the passed in bounds, recenter</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.zoomToMaxExtent" id=link75 onMouseOver="ShowTip(event, 'tt64', 'link75')" onMouseOut="HideTip('tt64')">zoomToMaxExtent</a></td><td class=SDescription>Zoom to the full extent and recenter.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Map.zoomToScale" id=link76 onMouseOver="ShowTip(event, 'tt65', 'link76')" onMouseOut="HideTip('tt65')">zoomToScale</a></td><td class=SDescription>Zoom to a specified scale</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.getLonLatFromViewPortPx" id=link77 onMouseOver="ShowTip(event, 'tt66', 'link77')" onMouseOut="HideTip('tt66')">getLonLatFromViewPortPx</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Map.getViewPortPxFromLonLat" id=link78 onMouseOver="ShowTip(event, 'tt67', 'link78')" onMouseOut="HideTip('tt67')">getViewPortPxFromLonLat</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.getLonLatFromPixel" id=link79 onMouseOver="ShowTip(event, 'tt68', 'link79')" onMouseOut="HideTip('tt68')">getLonLatFromPixel</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Map.getPixelFromLonLat" id=link80 onMouseOver="ShowTip(event, 'tt69', 'link80')" onMouseOut="HideTip('tt69')">getPixelFromLonLat</a></td><td class=SDescription>Returns a pixel location given a map location. </td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.getViewPortPxFromLayerPx" id=link81 onMouseOver="ShowTip(event, 'tt70', 'link81')" onMouseOut="HideTip('tt70')">getViewPortPxFromLayerPx</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Map.getLayerPxFromViewPortPx" id=link82 onMouseOver="ShowTip(event, 'tt71', 'link82')" onMouseOut="HideTip('tt71')">getLayerPxFromViewPortPx</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.getLonLatFromLayerPx" id=link83 onMouseOver="ShowTip(event, 'tt72', 'link83')" onMouseOut="HideTip('tt72')">getLonLatFromLayerPx</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Map.getLayerPxFromLonLat" id=link84 onMouseOver="ShowTip(event, 'tt73', 'link84')" onMouseOut="HideTip('tt73')">getLayerPxFromLonLat</a></td><td class=SDescription></td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#OpenLayers.Map.Constants" >Constants</a></td><td class=SDescription></td></tr><tr class="SConstant SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Map.TILE_WIDTH" >TILE_WIDTH</a></td><td class=SDescription>{Integer} 256 Default tile width (unless otherwise specified)</td></tr><tr class="SConstant SIndent2"><td class=SEntry><a href="#OpenLayers.Map.TILE_HEIGHT" >TILE_HEIGHT</a></td><td class=SDescription>{Integer} 256 Default tile height (unless otherwise specified)</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
15
16 <div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.Constants"></a>Constants</h3></div></div>
17
18 <div class="CConstant"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.Z_INDEX_BASE"></a>Z_INDEX_BASE</h3><div class=CBody><p>{Object} Base z-indexes for different classes of thing</p></div></div></div>
19
20 <div class="CConstant"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.EVENT_TYPES"></a>EVENT_TYPES</h3><div class=CBody><p>{Array(String)} Supported application event types.&nbsp;  Register a listener for a particular event with the following syntax:</p><blockquote><pre>map.events.register(type, obj, listener);</pre></blockquote><p>Listeners will be called with a reference to an event object.&nbsp;  The properties of this event depends on exactly what happened.</p><h4 class=CHeading>All event objects have at least the following properties</h4><ul><li><b>object</b> {Object} A reference to map.events.object.</li><li><b>element</b> {DOMElement} A reference to map.events.element.</li></ul><h4 class=CHeading>Browser events have the following additional properties</h4><ul><li><b>xy</b> {<a href="BaseTypes/Pixel-js.html#OpenLayers.Pixel" class=LClass id=link87 onMouseOver="ShowTip(event, 'tt75', 'link87')" onMouseOut="HideTip('tt75')">OpenLayers.Pixel</a>} The pixel location of the event (relative to the the map viewport).</li><li>other properties that come with browser events</li></ul><h4 class=CHeading>Supported map event types</h4><ul><li><b>preaddlayer</b> triggered before a layer has been added.&nbsp;  The event object will include a <b>layer</b> property that references the layer to be added.</li><li><b>addlayer</b> triggered after a layer has been added.&nbsp;  The event object will include a <b>layer</b> property that references the added layer.</li><li><b>removelayer</b> triggered after a layer has been removed.&nbsp;  The event object will include a <b>layer</b> property that references the removed layer.</li><li><b>changelayer</b> triggered after a layer name change, order change, or visibility change (due to resolution thresholds).&nbsp;  Listeners will receive an event object with <b>layer</b> and <b>property</b> properties.&nbsp;  The <b>layer</b> property will be a reference to the changed layer.&nbsp;  The <b>property</b> property will be a key to the changed property (name, visibility, or order).</li><li><b>movestart</b> triggered after the start of a drag, pan, or zoom</li><li><b>move</b> triggered after each drag, pan, or zoom</li><li><b>moveend</b> triggered after a drag, pan, or zoom completes</li><li><b>zoomend</b> triggered after a zoom completes</li><li><b>addmarker</b> triggered after a marker has been added</li><li><b>removemarker</b> triggered after a marker has been removed</li><li><b>clearmarkers</b> triggered after markers have been cleared</li><li><b>mouseover</b> triggered after mouseover the map</li><li><b>mouseout</b> triggered after mouseout the map</li><li><b>mousemove</b> triggered after mousemove the map</li><li><b>dragstart</b> Does not work.&nbsp;  Register for movestart instead.</li><li><b>drag</b> Does not work.&nbsp;  Register for move instead.</li><li><b>dragend</b> Does not work.&nbsp;  Register for moveend instead.</li><li><b>changebaselayer</b> triggered after the base layer changes</li></ul></div></div></div>
21
22 <div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.Properties"></a>Properties</h3></div></div>
23
24 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.id"></a>id</h3><div class=CBody><p>{String} Unique identifier for the map</p></div></div></div>
25
26 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.fractionalZoom"></a>fractionalZoom</h3><div class=CBody><p>{Boolean} For a base layer that supports it, allow the map resolution to be set to a value between one of the values in the resolutions array.&nbsp;  Default is false.</p><p>When fractionalZoom is set to true, it is possible to zoom to an arbitrary extent.&nbsp;  This requires a base layer from a source that supports requests for arbitrary extents (i.e. not cached tiles on a regular lattice).&nbsp;  This means that fractionalZoom will not work with commercial layers (Google, Yahoo, VE), layers using TileCache, or any other pre-cached data sources.</p><p>If you are using fractionalZoom, then you should also use <a href="#OpenLayers.Map.getResolutionForZoom" class=LFunction id=link88 onMouseOver="ShowTip(event, 'tt58', 'link88')" onMouseOut="HideTip('tt58')">getResolutionForZoom</a> instead of layer.resolutions[zoom] as the former works for non-integer zoom levels.</p></div></div></div>
27
28 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.events"></a>events</h3><div class=CBody><p>{<a href="Events-js.html#OpenLayers.Events" class=LClass >OpenLayers.Events</a>} An events object that handles all events on the map</p></div></div></div>
29
30 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.allOverlays"></a>allOverlays</h3><div class=CBody><p>{Boolean} Allow the map to function with &ldquo;overlays&rdquo; only.&nbsp;  Defaults to false.&nbsp;  If true, the lowest layer in the draw order will act as the base layer.&nbsp;  In addition, if set to true, all layers will have isBaseLayer set to false when they are added to the map.</p><h4 class=CHeading>Note</h4><p>If you set map.allOverlays to true, then you <b>cannot</b> use map.setBaseLayer or layer.setIsBaseLayer.&nbsp;  With allOverlays true, the lowest layer in the draw layer is the base layer.&nbsp;  So, to change the base layer, use <a href="#OpenLayers.Map.setLayerIndex" class=LFunction id=link89 onMouseOver="ShowTip(event, 'tt26', 'link89')" onMouseOut="HideTip('tt26')">setLayerIndex</a> or <a href="#OpenLayers.Map.raiseLayer" class=LFunction id=link90 onMouseOver="ShowTip(event, 'tt27', 'link90')" onMouseOut="HideTip('tt27')">raiseLayer</a> to set the layer index to 0.</p></div></div></div>
31
32 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.div"></a>div</h3><div class=CBody><p>{DOMElement|String} The element that contains the map (or an id for that element).&nbsp;  If the <a href="#OpenLayers.Map.OpenLayers.Map" class=LConstructor id=link91 onMouseOver="ShowTip(event, 'tt74', 'link91')" onMouseOut="HideTip('tt74')">OpenLayers.Map</a> constructor is called with two arguments, this should be provided as the first argument.&nbsp; Alternatively, the map constructor can be called with the options object as the only argument.&nbsp;  In this case (one argument), a div property may or may not be provided.&nbsp;  If the div property is not provided, the map can be rendered to a container later using the <a href="#OpenLayers.Map.render" class=LFunction id=link92 onMouseOver="ShowTip(event, 'tt8', 'link92')" onMouseOut="HideTip('tt8')">render</a> method.</p><p>Note: If you calling <a href="#OpenLayers.Map.render" class=LFunction id=link93 onMouseOver="ShowTip(event, 'tt8', 'link93')" onMouseOut="HideTip('tt8')">render</a> after map construction, do not use <a href="#OpenLayers.Map.maxResolution" class=LProperty id=link94 onMouseOver="ShowTip(event, 'tt76', 'link94')" onMouseOut="HideTip('tt76')">maxResolution</a>  auto.&nbsp;  Instead, divide your <a href="#OpenLayers.Map.maxExtent" class=LProperty id=link95 onMouseOver="ShowTip(event, 'tt77', 'link95')" onMouseOut="HideTip('tt77')">maxExtent</a> by your maximum expected dimension.</p></div></div></div>
33
34 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.dragging"></a>dragging</h3><div class=CBody><p>{Boolean} The map is currently being dragged.</p></div></div></div>
35
36 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.size"></a>size</h3><div class=CBody><p>{<a href="BaseTypes/Size-js.html#OpenLayers.Size" class=LClass id=link96 onMouseOver="ShowTip(event, 'tt1', 'link96')" onMouseOut="HideTip('tt1')">OpenLayers.Size</a>} Size of the main div (this.div)</p></div></div></div>
37
38 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.viewPortDiv"></a>viewPortDiv</h3><div class=CBody><p>{HTMLDivElement} The element that represents the map viewport</p></div></div></div>
39
40 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.layerContainerOrigin"></a>layerContainerOrigin</h3><div class=CBody><p>{<a href="BaseTypes/LonLat-js.html#OpenLayers.LonLat" class=LClass id=link97 onMouseOver="ShowTip(event, 'tt2', 'link97')" onMouseOut="HideTip('tt2')">OpenLayers.LonLat</a>} The lonlat at which the later container was re-initialized (on-zoom)</p></div></div></div>
41
42 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.layerContainerDiv"></a>layerContainerDiv</h3><div class=CBody><p>{HTMLDivElement} The element that contains the layers.</p></div></div></div>
43
44 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.layers"></a>layers</h3><div class=CBody><p>{Array(<a href="Layer-js.html#OpenLayers.Layer" class=LClass >OpenLayers.Layer</a>)} Ordered list of layers in the map</p></div></div></div>
45
46 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.controls"></a>controls</h3><div class=CBody><p>{Array(<a href="Control-js.html#OpenLayers.Control" class=LClass id=link98 onMouseOver="ShowTip(event, 'tt3', 'link98')" onMouseOut="HideTip('tt3')">OpenLayers.Control</a>)} List of controls associated with the map.</p><p>If not provided in the map options at construction, the map will be given the following controls by default:</p><ul><li><a href="Control/Navigation-js.html#OpenLayers.Control.Navigation" class=LClass id=link99 onMouseOver="ShowTip(event, 'tt78', 'link99')" onMouseOut="HideTip('tt78')">OpenLayers.Control.Navigation</a></li><li><a href="Control/PanZoom-js.html#OpenLayers.Control.PanZoom" class=LClass id=link100 onMouseOver="ShowTip(event, 'tt79', 'link100')" onMouseOut="HideTip('tt79')">OpenLayers.Control.PanZoom</a></li><li><a href="Control/ArgParser-js.html#OpenLayers.Control.ArgParser" class=LClass id=link101 onMouseOver="ShowTip(event, 'tt80', 'link101')" onMouseOut="HideTip('tt80')">OpenLayers.Control.ArgParser</a></li><li><a href="Control/Attribution-js.html#OpenLayers.Control.Attribution" class=LClass id=link102 onMouseOver="ShowTip(event, 'tt81', 'link102')" onMouseOut="HideTip('tt81')">OpenLayers.Control.Attribution</a></li></ul></div></div></div>
47
48 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.popups"></a>popups</h3><div class=CBody><p>{Array(<a href="Popup-js.html#OpenLayers.Popup" class=LClass id=link103 onMouseOver="ShowTip(event, 'tt4', 'link103')" onMouseOut="HideTip('tt4')">OpenLayers.Popup</a>)} List of popups associated with the map</p></div></div></div>
49
50 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.baseLayer"></a>baseLayer</h3><div class=CBody><p>{<a href="Layer-js.html#OpenLayers.Layer" class=LClass >OpenLayers.Layer</a>} The currently selected base layer.&nbsp;  This determines min/max zoom level, projection, etc.</p></div></div></div>
51
52 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.center"></a>center</h3><div class=CBody><p>{<a href="BaseTypes/LonLat-js.html#OpenLayers.LonLat" class=LClass id=link104 onMouseOver="ShowTip(event, 'tt2', 'link104')" onMouseOut="HideTip('tt2')">OpenLayers.LonLat</a>} The current center of the map</p></div></div></div>
53
54 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.resolution"></a>resolution</h3><div class=CBody><p>{Float} The resolution of the map.</p></div></div></div>
55
56 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.zoom"></a>zoom</h3><div class=CBody><p>{Integer} The current zoom level of the map</p></div></div></div>
57
58 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.panRatio"></a>panRatio</h3><div class=CBody><p>{Float} The ratio of the current extent within which panning will tween.</p></div></div></div>
59
60 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.viewRequestID"></a>viewRequestID</h3><div class=CBody><p>{String} Used to store a unique identifier that changes when the map view changes. viewRequestID should be used when adding data asynchronously to the map: viewRequestID is incremented when you initiate your request (right now during changing of baselayers and changing of zooms).&nbsp; It is stored here in the map and also in the data that will be coming back asynchronously.&nbsp; Before displaying this data on request completion, we check that the viewRequestID of the data is still the same as that of the map.&nbsp; Fix for #480</p></div></div></div>
61
62 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.tileSize"></a>tileSize</h3><div class=CBody><p>{<a href="BaseTypes/Size-js.html#OpenLayers.Size" class=LClass id=link105 onMouseOver="ShowTip(event, 'tt1', 'link105')" onMouseOut="HideTip('tt1')">OpenLayers.Size</a>} Set in the map options to override the default tile size for this map.</p></div></div></div>
63
64 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.projection"></a>projection</h3><div class=CBody><p>{String} Set in the map options to override the default projection string this map - also set maxExtent, maxResolution, and units if appropriate.&nbsp;  Default is &ldquo;EPSG:4326&rdquo;.</p></div></div></div>
65
66 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.units"></a>units</h3><div class=CBody><p>{String} The map units.&nbsp;  Defaults to &lsquo;degrees&rsquo;.&nbsp;  Possible values are &lsquo;degrees&rsquo; (or &lsquo;dd&rsquo;), &lsquo;m&rsquo;, &lsquo;ft&rsquo;, &lsquo;km&rsquo;, &lsquo;mi&rsquo;, &lsquo;inches&rsquo;.</p></div></div></div>
67
68 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.resolutions"></a>resolutions</h3><div class=CBody><p>{Array(Float)} A list of map resolutions (map units per pixel) in descending order.&nbsp;  If this is not set in the layer constructor, it will be set based on other resolution related properties (maxExtent, maxResolution, maxScale, etc.).</p></div></div></div>
69
70 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.maxResolution"></a>maxResolution</h3><div class=CBody><p>{Float} Default max is 360 deg / 256 px, which corresponds to zoom level 0 on gmaps.&nbsp;  Specify a different value in the map options if you are not using a geographic projection and displaying the whole world.</p></div></div></div>
71
72 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.minResolution"></a>minResolution</h3><div class=CBody><p>{Float}</p></div></div></div>
73
74 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.maxScale"></a>maxScale</h3><div class=CBody><p>{Float}</p></div></div></div>
75
76 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.minScale"></a>minScale</h3><div class=CBody><p>{Float}</p></div></div></div>
77
78 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.maxExtent"></a>maxExtent</h3><div class=CBody><p>{<a href="BaseTypes/Bounds-js.html#OpenLayers.Bounds" class=LClass id=link106 onMouseOver="ShowTip(event, 'tt5', 'link106')" onMouseOut="HideTip('tt5')">OpenLayers.Bounds</a>} The maximum extent for the map.&nbsp;  Defaults to the whole world in decimal degrees (-180, -90, 180, 90).&nbsp;  Specify a different extent in the map options if you are not using a geographic projection and displaying the whole world.</p></div></div></div>
79
80 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.minExtent"></a>minExtent</h3><div class=CBody><p>{<a href="BaseTypes/Bounds-js.html#OpenLayers.Bounds" class=LClass id=link107 onMouseOver="ShowTip(event, 'tt5', 'link107')" onMouseOut="HideTip('tt5')">OpenLayers.Bounds</a>}</p></div></div></div>
81
82 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.restrictedExtent"></a>restrictedExtent</h3><div class=CBody><p>{<a href="BaseTypes/Bounds-js.html#OpenLayers.Bounds" class=LClass id=link108 onMouseOver="ShowTip(event, 'tt5', 'link108')" onMouseOut="HideTip('tt5')">OpenLayers.Bounds</a>} Limit map navigation to this extent where possible.&nbsp; If a non-null restrictedExtent is set, panning will be restricted to the given bounds.&nbsp;  In addition, zooming to a resolution that displays more than the restricted extent will center the map on the restricted extent.&nbsp;  If you wish to limit the zoom level or resolution, use maxResolution.</p></div></div></div>
83
84 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.numZoomLevels"></a>numZoomLevels</h3><div class=CBody><p>{Integer} Number of zoom levels for the map.&nbsp;  Defaults to 16.&nbsp;  Set a different value in the map options if needed.</p></div></div></div>
85
86 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.theme"></a>theme</h3><div class=CBody><p>{String} Relative path to a CSS file from which to load theme styles.&nbsp; Specify null in the map options (e.g.&nbsp; {theme: null}) if you want to get cascading style declarations - by putting links to stylesheets or style declarations directly in your page.</p></div></div></div>
87
88 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.displayProjection"></a>displayProjection</h3><div class=CBody><p>{<a href="Projection-js.html#OpenLayers.Projection" class=LClass id=link109 onMouseOver="ShowTip(event, 'tt6', 'link109')" onMouseOut="HideTip('tt6')">OpenLayers.Projection</a>} Requires proj4js support.Projection used by several controls to display data to user.&nbsp; If this property is set, it will be set on any control which has a null displayProjection property at the time the control is added to the map.</p></div></div></div>
89
90 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.fallThrough"></a>fallThrough</h3><div class=CBody><p>{Boolean} Should OpenLayers allow events on the map to fall through to other elements on the page, or should it swallow them?&nbsp; (#457) Default is to fall through.</p></div></div></div>
91
92 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.panTween"></a>panTween</h3><div class=CBody><p>{OpenLayers.Tween} Animated panning tween object, see panTo()</p></div></div></div>
93
94 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.eventListeners"></a>eventListeners</h3><div class=CBody><p>{Object} If set as an option at construction, the eventListeners object will be registered with <a href="Events-js.html#OpenLayers.Events.on" class=LFunction id=link110 onMouseOver="ShowTip(event, 'tt7', 'link110')" onMouseOut="HideTip('tt7')">OpenLayers.Events.on</a>.&nbsp;  Object structure must be a listeners object as shown in the example for the events.on method.</p></div></div></div>
95
96 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.panMethod"></a>panMethod</h3><div class=CBody><p>{Function} The Easing function to be used for tweening.&nbsp;  Default is OpenLayers.Easing.Expo.easeOut.&nbsp; Setting this to &lsquo;null&rsquo; turns off animated panning.</p></div></div></div>
97
98 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.panDuration"></a>panDuration</h3><div class=CBody><p>{Integer} The number of steps to be passed to the OpenLayers.Tween.start() method when the map is panned.&nbsp; Default is 50.</p></div></div></div>
99
100 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.paddingForPopups"></a>paddingForPopups</h3><div class=CBody><p>{<a href="BaseTypes/Bounds-js.html#OpenLayers.Bounds" class=LClass id=link111 onMouseOver="ShowTip(event, 'tt5', 'link111')" onMouseOut="HideTip('tt5')">OpenLayers.Bounds</a>} Outside margin of the popup.&nbsp; Used to prevent the popup from getting too close to the map border.</p></div></div></div>
101
102 <div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.Constructor"></a>Constructor</h3></div></div>
103
104 <div class="CConstructor"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.OpenLayers.Map"></a>OpenLayers.Map</h3><div class=CBody><p>Constructor for a new OpenLayers.Map instance.&nbsp;  There are two possible ways to call the map constructor.&nbsp;  See the examples below.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>div</td><td class=CDLDescription>{String} Id of an element in your page that will contain the map.&nbsp; May be omitted if the <a href="#OpenLayers.Map.div" class=LProperty id=link112 onMouseOver="ShowTip(event, 'tt82', 'link112')" onMouseOut="HideTip('tt82')">div</a> option is provided or if you intend to use <a href="#OpenLayers.Map.render" class=LFunction id=link113 onMouseOver="ShowTip(event, 'tt8', 'link113')" onMouseOut="HideTip('tt8')">render</a> later.</td></tr><tr><td class=CDLEntry>options</td><td class=CDLDescription>{Object} Optional object with properties to tag onto the map.</td></tr></table><h4 class=CHeading>Examples (method one)</h4><blockquote><pre>// create a map with default options in an element with the id &quot;map1&quot;
105 var map = new OpenLayers.Map(&quot;map1&quot;);
106
107 // create a map with non-default options in an element with id &quot;map2&quot;
108 var options = {
109     maxExtent: new OpenLayers.Bounds(-200000, -200000, 200000, 200000),
110     maxResolution: 156543,
111     units: 'm',
112     projection: &quot;EPSG:41001&quot;
113 };
114 var map = new OpenLayers.Map(&quot;map2&quot;, options);</pre></blockquote><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>Examples (method two</td><td class=CDLDescription>single argument):</td></tr></table><blockquote><pre>// create a map with non-default options
115 var map = new OpenLayers.Map({
116     div: &quot;map_id&quot;,
117     maxExtent: new OpenLayers.Bounds(-200000, -200000, 200000, 200000),
118     maxResolution: 156543,
119     units: 'm',
120     projection: &quot;EPSG:41001&quot;
121 });
122
123 // create a map without a reference to a container - call render later
124 var map = new OpenLayers.Map({
125     maxExtent: new OpenLayers.Bounds(-200000, -200000, 200000, 200000),
126     maxResolution: 156543,
127     units: 'm',
128     projection: &quot;EPSG:41001&quot;
129 });</pre></blockquote></div></div></div>
130
131 <div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.Functions"></a>Functions</h3></div></div>
132
133 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.render"></a>render</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>render: function(</td><td class=PParameter nowrap>div</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Render the map to a specified container.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>div</td><td class=CDLDescription>{String|DOMElement} The container that the map should be rendered to.&nbsp; If different than the current container, the map viewport will be moved from the current to the new container.</td></tr></table></div></div></div>
134
135 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.unloadDestroy"></a>unloadDestroy</h3><div class=CBody><p>Function that is called to destroy the map on page unload. stored here so that if map is manually destroyed, we can unregister this.</p></div></div></div>
136
137 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.updateSizeDestroy"></a>updateSizeDestroy</h3><div class=CBody><p>When the map is destroyed, we need to stop listening to updateSize events: this method stores the function we need to unregister in non-IE browsers.</p></div></div></div>
138
139 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.destroy"></a>destroy</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>destroy:function()</td></tr></table></blockquote><p>Destroy this map</p></div></div></div>
140
141 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.setOptions"></a>setOptions</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>setOptions: function(</td><td class=PParameter nowrap>options</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Change the map options</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>options</td><td class=CDLDescription>{Object} Hashtable of options to tag to the map</td></tr></table></div></div></div>
142
143 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.getTileSize"></a>getTileSize</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getTileSize: function()</td></tr></table></blockquote><p>Get the tile size for the map</p><h4 class=CHeading>Returns</h4><p>{<a href="BaseTypes/Size-js.html#OpenLayers.Size" class=LClass id=link114 onMouseOver="ShowTip(event, 'tt1', 'link114')" onMouseOut="HideTip('tt1')">OpenLayers.Size</a>}</p></div></div></div>
144
145 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.getBy"></a>getBy</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>getBy: function(</td><td class=PParameter nowrap>array,</td></tr><tr><td></td><td class=PParameter nowrap>property,</td></tr><tr><td></td><td class=PParameter nowrap>match</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Get a list of objects given a property and a match item.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>array</td><td class=CDLDescription>{String} A property on the map whose value is an array.</td></tr><tr><td class=CDLEntry>property</td><td class=CDLDescription>{String} A property on each item of the given array.</td></tr><tr><td class=CDLEntry>match</td><td class=CDLDescription>{String | Object} A string to match.&nbsp;  Can also be a regular expression literal or object.&nbsp;  In addition, it can be any object with a method named test.&nbsp;  For reqular expressions or other, if match.test(map[array][i][property]) evaluates to true, the item will be included in the array returned.&nbsp;  If no items are found, an empty array is returned.</td></tr></table><h4 class=CHeading>Returns</h4><p>{Array} An array of items where the given property matches the given criteria.</p></div></div></div>
146
147 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.getLayersBy"></a>getLayersBy</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>getLayersBy: function(</td><td class=PParameter nowrap>property,</td></tr><tr><td></td><td class=PParameter nowrap>match</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Get a list of layers with properties matching the given criteria.</p><h4 class=CHeading>Parameter</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>property</td><td class=CDLDescription>{String} A layer property to be matched.</td></tr><tr><td class=CDLEntry>match</td><td class=CDLDescription>{String | Object} A string to match.&nbsp;  Can also be a regular expression literal or object.&nbsp;  In addition, it can be any object with a method named test.&nbsp;  For reqular expressions or other, if match.test(layer[property]) evaluates to true, the layer will be included in the array returned.&nbsp;  If no layers are found, an empty array is returned.</td></tr></table><h4 class=CHeading>Returns</h4><p>{Array(<a href="Layer-js.html#OpenLayers.Layer" class=LClass >OpenLayers.Layer</a>)} A list of layers matching the given criteria.&nbsp; An empty array is returned if no matches are found.</p></div></div></div>
148
149 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.getLayersByName"></a>getLayersByName</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>getLayersByName: function(</td><td class=PParameter nowrap>match</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Get a list of layers with names matching the given name.</p><h4 class=CHeading>Parameter</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>match</td><td class=CDLDescription>{String | Object} A layer name.&nbsp;  The name can also be a regular expression literal or object.&nbsp;  In addition, it can be any object with a method named test.&nbsp;  For reqular expressions or other, if name.test(layer.name) evaluates to true, the layer will be included in the list of layers returned.&nbsp;  If no layers are found, an empty array is returned.</td></tr></table><h4 class=CHeading>Returns</h4><p>{Array(<a href="Layer-js.html#OpenLayers.Layer" class=LClass >OpenLayers.Layer</a>)} A list of layers matching the given name.&nbsp; An empty array is returned if no matches are found.</p></div></div></div>
150
151 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.getLayersByClass"></a>getLayersByClass</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>getLayersByClass: function(</td><td class=PParameter nowrap>match</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Get a list of layers of a given class (CLASS_NAME).</p><h4 class=CHeading>Parameter</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>match</td><td class=CDLDescription>{String | Object} A layer class name.&nbsp;  The match can also be a regular expression literal or object.&nbsp;  In addition, it can be any object with a method named test.&nbsp;  For reqular expressions or other, if type.test(layer.CLASS_NAME) evaluates to true, the layer will be included in the list of layers returned.&nbsp;  If no layers are found, an empty array is returned.</td></tr></table><h4 class=CHeading>Returns</h4><p>{Array(<a href="Layer-js.html#OpenLayers.Layer" class=LClass >OpenLayers.Layer</a>)} A list of layers matching the given class.&nbsp; An empty array is returned if no matches are found.</p></div></div></div>
152
153 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.getControlsBy"></a>getControlsBy</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>getControlsBy: function(</td><td class=PParameter nowrap>property,</td></tr><tr><td></td><td class=PParameter nowrap>match</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Get a list of controls with properties matching the given criteria.</p><h4 class=CHeading>Parameter</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>property</td><td class=CDLDescription>{String} A control property to be matched.</td></tr><tr><td class=CDLEntry>match</td><td class=CDLDescription>{String | Object} A string to match.&nbsp;  Can also be a regular expression literal or object.&nbsp;  In addition, it can be any object with a method named test.&nbsp;  For reqular expressions or other, if match.test(layer[property]) evaluates to true, the layer will be included in the array returned.&nbsp;  If no layers are found, an empty array is returned.</td></tr></table><h4 class=CHeading>Returns</h4><p>{Array(<a href="Control-js.html#OpenLayers.Control" class=LClass id=link115 onMouseOver="ShowTip(event, 'tt3', 'link115')" onMouseOut="HideTip('tt3')">OpenLayers.Control</a>)} A list of controls matching the given criteria.&nbsp;  An empty array is returned if no matches are found.</p></div></div></div>
154
155 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.getControlsByClass"></a>getControlsByClass</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>getControlsByClass: function(</td><td class=PParameter nowrap>match</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Get a list of controls of a given class (CLASS_NAME).</p><h4 class=CHeading>Parameter</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>match</td><td class=CDLDescription>{String | Object} A control class name.&nbsp;  The match can also be a regular expression literal or object.&nbsp;  In addition, it can be any object with a method named test.&nbsp;  For reqular expressions or other, if type.test(control.CLASS_NAME) evaluates to true, the control will be included in the list of controls returned.&nbsp;  If no controls are found, an empty array is returned.</td></tr></table><h4 class=CHeading>Returns</h4><p>{Array(<a href="Control-js.html#OpenLayers.Control" class=LClass id=link116 onMouseOver="ShowTip(event, 'tt3', 'link116')" onMouseOut="HideTip('tt3')">OpenLayers.Control</a>)} A list of controls matching the given class.&nbsp; An empty array is returned if no matches are found.</p></div></div></div>
156
157 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.getLayer"></a>getLayer</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>getLayer: function(</td><td class=PParameter nowrap>id</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Get a layer based on its id</p><h4 class=CHeading>Parameter</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>id</td><td class=CDLDescription>{String} A layer id</td></tr></table><h4 class=CHeading>Returns</h4><p>{<a href="Layer-js.html#OpenLayers.Layer" class=LClass >OpenLayers.Layer</a>} The Layer with the corresponding id from the map&rsquo;s layer collection, or null if not found.</p></div></div></div>
158
159 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.setLayerZIndex"></a>setLayerZIndex</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>setLayerZIndex: function (</td><td class=PParameter nowrap>layer,</td></tr><tr><td></td><td class=PParameter nowrap>zIdx</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>layer</td><td class=CDLDescription>{<a href="Layer-js.html#OpenLayers.Layer" class=LClass >OpenLayers.Layer</a>}</td></tr><tr><td class=CDLEntry>zIdx</td><td class=CDLDescription>{int}</td></tr></table></div></div></div>
160
161 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.resetLayersZIndex"></a>resetLayersZIndex</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>resetLayersZIndex: function()</td></tr></table></blockquote><p>Reset each layer&rsquo;s z-index based on layer&rsquo;s array index</p></div></div></div>
162
163 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.addLayer"></a>addLayer</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>addLayer: function (</td><td class=PParameter nowrap>layer</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>layer</td><td class=CDLDescription>{<a href="Layer-js.html#OpenLayers.Layer" class=LClass >OpenLayers.Layer</a>}</td></tr></table></div></div></div>
164
165 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.addLayers"></a>addLayers</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>addLayers: function (</td><td class=PParameter nowrap>layers</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>layers</td><td class=CDLDescription>{Array(<a href="Layer-js.html#OpenLayers.Layer" class=LClass >OpenLayers.Layer</a>)}</td></tr></table></div></div></div>
166
167 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.removeLayer"></a>removeLayer</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>removeLayer: function(</td><td class=PParameter nowrap>layer,</td></tr><tr><td></td><td class=PParameter nowrap>setNewBaseLayer</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Removes a layer from the map by removing its visual element (the layer.div property), then removing it from the map&rsquo;s internal list of layers, setting the layer&rsquo;s map property to null.</p><p>a &ldquo;removelayer&rdquo; event is triggered.</p><p>very worthy of mention is that simply removing a layer from a map will not cause the removal of any popups which may have been created by the layer. this is due to the fact that it was decided at some point that popups would not belong to layers. thus there is no way for us to know here to which layer the popup belongs.</p><p>A simple solution to this is simply to call destroy() on the layer. the default OpenLayers.Layer class&rsquo;s destroy() function automatically takes care to remove itself from whatever map it has been attached to.</p><p>The correct solution is for the layer itself to register an event-handler on &ldquo;removelayer&rdquo; and when it is called, if it recognizes itself as the layer being removed, then it cycles through its own personal list of popups, removing them from the map.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>layer</td><td class=CDLDescription>{<a href="Layer-js.html#OpenLayers.Layer" class=LClass >OpenLayers.Layer</a>}</td></tr><tr><td class=CDLEntry>setNewBaseLayer</td><td class=CDLDescription>{Boolean} Default is true</td></tr></table></div></div></div>
168
169 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.getNumLayers"></a>getNumLayers</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getNumLayers: function ()</td></tr></table></blockquote><h4 class=CHeading>Returns</h4><p>{Int} The number of layers attached to the map.</p></div></div></div>
170
171 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.getLayerIndex"></a>getLayerIndex</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>getLayerIndex: function (</td><td class=PParameter nowrap>layer</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>layer</td><td class=CDLDescription>{<a href="Layer-js.html#OpenLayers.Layer" class=LClass >OpenLayers.Layer</a>}</td></tr></table><h4 class=CHeading>Returns</h4><p>{Integer} The current (zero-based) index of the given layer in the map&rsquo;s layer stack.&nbsp; Returns -1 if the layer isn&rsquo;t on the map.</p></div></div></div>
172
173 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.setLayerIndex"></a>setLayerIndex</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>setLayerIndex: function (</td><td class=PParameter nowrap>layer,</td></tr><tr><td></td><td class=PParameter nowrap>idx</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Move the given layer to the specified (zero-based) index in the layer list, changing its z-index in the map display.&nbsp; Use map.getLayerIndex() to find out the current index of a layer.&nbsp; Note that this cannot (or at least should not) be effectively used to raise base layers above overlays.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>layer</td><td class=CDLDescription>{<a href="Layer-js.html#OpenLayers.Layer" class=LClass >OpenLayers.Layer</a>}</td></tr><tr><td class=CDLEntry>idx</td><td class=CDLDescription>{int}</td></tr></table></div></div></div>
174
175 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.raiseLayer"></a>raiseLayer</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>raiseLayer: function (</td><td class=PParameter nowrap>layer,</td></tr><tr><td></td><td class=PParameter nowrap>delta</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Change the index of the given layer by delta.&nbsp; If delta is positive, the layer is moved up the map&rsquo;s layer stack; if delta is negative, the layer is moved down.&nbsp;  Again, note that this cannot (or at least should not) be effectively used to raise base layers above overlays.</p><h4 class=CHeading>Paremeters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>layer</td><td class=CDLDescription>{<a href="Layer-js.html#OpenLayers.Layer" class=LClass >OpenLayers.Layer</a>}</td></tr><tr><td class=CDLEntry>delta</td><td class=CDLDescription>{int}</td></tr></table></div></div></div>
176
177 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.setBaseLayer"></a>setBaseLayer</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>setBaseLayer: function(</td><td class=PParameter nowrap>newBaseLayer</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Allows user to specify one of the currently-loaded layers as the Map&rsquo;s new base layer.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>newBaseLayer</td><td class=CDLDescription>{<a href="Layer-js.html#OpenLayers.Layer" class=LClass >OpenLayers.Layer</a>}</td></tr></table></div></div></div>
178
179 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.addControl"></a>addControl</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>addControl: function (</td><td class=PParameter nowrap>control,</td></tr><tr><td></td><td class=PParameter nowrap>px</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>control</td><td class=CDLDescription>{<a href="Control-js.html#OpenLayers.Control" class=LClass id=link117 onMouseOver="ShowTip(event, 'tt3', 'link117')" onMouseOut="HideTip('tt3')">OpenLayers.Control</a>}</td></tr><tr><td class=CDLEntry>px</td><td class=CDLDescription>{<a href="BaseTypes/Pixel-js.html#OpenLayers.Pixel" class=LClass id=link118 onMouseOver="ShowTip(event, 'tt75', 'link118')" onMouseOut="HideTip('tt75')">OpenLayers.Pixel</a>}</td></tr></table></div></div></div>
180
181 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.addControlToMap"></a>addControlToMap</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>addControlToMap: function (</td><td class=PParameter nowrap>control,</td></tr><tr><td></td><td class=PParameter nowrap>px</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>control</td><td class=CDLDescription>{<a href="Control-js.html#OpenLayers.Control" class=LClass id=link119 onMouseOver="ShowTip(event, 'tt3', 'link119')" onMouseOut="HideTip('tt3')">OpenLayers.Control</a>}</td></tr><tr><td class=CDLEntry>px</td><td class=CDLDescription>{<a href="BaseTypes/Pixel-js.html#OpenLayers.Pixel" class=LClass id=link120 onMouseOver="ShowTip(event, 'tt75', 'link120')" onMouseOut="HideTip('tt75')">OpenLayers.Pixel</a>}</td></tr></table></div></div></div>
182
183 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.getControl"></a>getControl</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>getControl: function (</td><td class=PParameter nowrap>id</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>id</td><td class=CDLDescription>{String} ID of the control to return.</td></tr></table><h4 class=CHeading>Returns</h4><p>{<a href="Control-js.html#OpenLayers.Control" class=LClass id=link121 onMouseOver="ShowTip(event, 'tt3', 'link121')" onMouseOut="HideTip('tt3')">OpenLayers.Control</a>} The control from the map&rsquo;s list of controls which has a matching &lsquo;id&rsquo;.&nbsp; If none found, returns null.</p></div></div></div>
184
185 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.removeControl"></a>removeControl</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>removeControl: function (</td><td class=PParameter nowrap>control</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Remove a control from the map.&nbsp; Removes the control both from the map object&rsquo;s internal array of controls, as well as from the map&rsquo;s viewPort (assuming the control was not added outsideViewport)</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>control</td><td class=CDLDescription>{<a href="Control-js.html#OpenLayers.Control" class=LClass id=link122 onMouseOver="ShowTip(event, 'tt3', 'link122')" onMouseOut="HideTip('tt3')">OpenLayers.Control</a>} The control to remove.</td></tr></table></div></div></div>
186
187 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.addPopup"></a>addPopup</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>addPopup: function(</td><td class=PParameter nowrap>popup,</td></tr><tr><td></td><td class=PParameter nowrap>exclusive</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>popup</td><td class=CDLDescription>{<a href="Popup-js.html#OpenLayers.Popup" class=LClass id=link123 onMouseOver="ShowTip(event, 'tt4', 'link123')" onMouseOut="HideTip('tt4')">OpenLayers.Popup</a>}</td></tr><tr><td class=CDLEntry>exclusive</td><td class=CDLDescription>{Boolean} If true, closes all other popups first</td></tr></table></div></div></div>
188
189 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.removePopup"></a>removePopup</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>removePopup: function(</td><td class=PParameter nowrap>popup</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>popup</td><td class=CDLDescription>{<a href="Popup-js.html#OpenLayers.Popup" class=LClass id=link124 onMouseOver="ShowTip(event, 'tt4', 'link124')" onMouseOut="HideTip('tt4')">OpenLayers.Popup</a>}</td></tr></table></div></div></div>
190
191 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.getSize"></a>getSize</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getSize: function ()</td></tr></table></blockquote><h4 class=CHeading>Returns</h4><p>{<a href="BaseTypes/Size-js.html#OpenLayers.Size" class=LClass id=link125 onMouseOver="ShowTip(event, 'tt1', 'link125')" onMouseOut="HideTip('tt1')">OpenLayers.Size</a>} An <a href="BaseTypes/Size-js.html#OpenLayers.Size" class=LClass id=link126 onMouseOver="ShowTip(event, 'tt1', 'link126')" onMouseOut="HideTip('tt1')">OpenLayers.Size</a> object that represents the size, in pixels, of the div into which OpenLayers has been loaded.&nbsp; Note - A clone() of this locally cached variable is returned, so as not to allow users to modify it.</p></div></div></div>
192
193 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.updateSize"></a>updateSize</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>updateSize: function()</td></tr></table></blockquote><p>This function should be called by any external code which dynamically changes the size of the map div (because mozilla wont let us catch the &ldquo;onresize&rdquo; for an element)</p></div></div></div>
194
195 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.getCurrentSize"></a>getCurrentSize</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getCurrentSize: function()</td></tr></table></blockquote><h4 class=CHeading>Returns</h4><p>{<a href="BaseTypes/Size-js.html#OpenLayers.Size" class=LClass id=link127 onMouseOver="ShowTip(event, 'tt1', 'link127')" onMouseOut="HideTip('tt1')">OpenLayers.Size</a>} A new <a href="BaseTypes/Size-js.html#OpenLayers.Size" class=LClass id=link128 onMouseOver="ShowTip(event, 'tt1', 'link128')" onMouseOut="HideTip('tt1')">OpenLayers.Size</a> object with the dimensions of the map div</p></div></div></div>
196
197 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.calculateBounds"></a>calculateBounds</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>calculateBounds: function(</td><td class=PParameter nowrap>center,</td></tr><tr><td></td><td class=PParameter nowrap>resolution</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>center</td><td class=CDLDescription>{<a href="BaseTypes/LonLat-js.html#OpenLayers.LonLat" class=LClass id=link129 onMouseOver="ShowTip(event, 'tt2', 'link129')" onMouseOut="HideTip('tt2')">OpenLayers.LonLat</a>} Default is this.getCenter()</td></tr><tr><td class=CDLEntry>resolution</td><td class=CDLDescription>{float} Default is this.getResolution()</td></tr></table><h4 class=CHeading>Returns</h4><p>{<a href="BaseTypes/Bounds-js.html#OpenLayers.Bounds" class=LClass id=link130 onMouseOver="ShowTip(event, 'tt5', 'link130')" onMouseOut="HideTip('tt5')">OpenLayers.Bounds</a>} A bounds based on resolution, center, and current mapsize.</p></div></div></div>
198
199 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.getCenter"></a>getCenter</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getCenter: function ()</td></tr></table></blockquote><h4 class=CHeading>Returns</h4><p>{<a href="BaseTypes/LonLat-js.html#OpenLayers.LonLat" class=LClass id=link131 onMouseOver="ShowTip(event, 'tt2', 'link131')" onMouseOut="HideTip('tt2')">OpenLayers.LonLat</a>}</p></div></div></div>
200
201 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.getZoom"></a>getZoom</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getZoom: function ()</td></tr></table></blockquote><h4 class=CHeading>Returns</h4><p>{Integer}</p></div></div></div>
202
203 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.pan"></a>pan</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>pan: function(</td><td class=PParameter nowrap>dx,</td></tr><tr><td></td><td class=PParameter nowrap>dy,</td></tr><tr><td></td><td class=PParameter nowrap>options</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Allows user to pan by a value of screen pixels</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>dx</td><td class=CDLDescription>{Integer}</td></tr><tr><td class=CDLEntry>dy</td><td class=CDLDescription>{Integer}</td></tr><tr><td class=CDLEntry>options</td><td class=CDLDescription>{Object} Options to configure panning:</td></tr></table><ul><li><b>animate</b> {Boolean} Use panTo instead of setCenter.&nbsp; Default is true.</li><li><b>dragging</b> {Boolean} Call setCenter with dragging true.&nbsp;  Default is false.</li></ul></div></div></div>
204
205 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.panTo"></a>panTo</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>panTo: function(</td><td class=PParameter nowrap>lonlat</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Allows user to pan to a new lonlat If the new lonlat is in the current extent the map will slide smoothly</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>lonlat</td><td class=CDLDescription>{&lt;OpenLayers.Lonlat&gt;}</td></tr></table></div></div></div>
206
207 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.setCenter"></a>setCenter</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>setCenter: function(</td><td class=PParameter nowrap>lonlat,</td></tr><tr><td></td><td class=PParameter nowrap>zoom,</td></tr><tr><td></td><td class=PParameter nowrap>dragging,</td></tr><tr><td></td><td class=PParameter nowrap>forceZoomChange</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Set the map center (and optionally, the zoom level).</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>lonlat</td><td class=CDLDescription>{<a href="BaseTypes/LonLat-js.html#OpenLayers.LonLat" class=LClass id=link132 onMouseOver="ShowTip(event, 'tt2', 'link132')" onMouseOut="HideTip('tt2')">OpenLayers.LonLat</a>} The new center location.</td></tr><tr><td class=CDLEntry>zoom</td><td class=CDLDescription>{Integer} Optional zoom level.</td></tr><tr><td class=CDLEntry>dragging</td><td class=CDLDescription>{Boolean} Specifies whether or not to trigger movestart/end events</td></tr><tr><td class=CDLEntry>forceZoomChange</td><td class=CDLDescription>{Boolean} Specifies whether or not to trigger zoom change events (needed on baseLayer change)</td></tr></table><p>TBD: reconsider forceZoomChange in 3.0</p></div></div></div>
208
209 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.moveTo"></a>moveTo</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>moveTo: function(</td><td class=PParameter nowrap>lonlat,</td></tr><tr><td></td><td class=PParameter nowrap>zoom,</td></tr><tr><td></td><td class=PParameter nowrap>options</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>lonlat</td><td class=CDLDescription>{<a href="BaseTypes/LonLat-js.html#OpenLayers.LonLat" class=LClass id=link133 onMouseOver="ShowTip(event, 'tt2', 'link133')" onMouseOut="HideTip('tt2')">OpenLayers.LonLat</a>}</td></tr><tr><td class=CDLEntry>zoom</td><td class=CDLDescription>{Integer}</td></tr><tr><td class=CDLEntry>options</td><td class=CDLDescription>{Object}</td></tr></table></div></div></div>
210
211 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.centerLayerContainer"></a>centerLayerContainer</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>centerLayerContainer: function (</td><td class=PParameter nowrap>lonlat</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>This function takes care to recenter the layerContainerDiv.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>lonlat</td><td class=CDLDescription>{<a href="BaseTypes/LonLat-js.html#OpenLayers.LonLat" class=LClass id=link134 onMouseOver="ShowTip(event, 'tt2', 'link134')" onMouseOut="HideTip('tt2')">OpenLayers.LonLat</a>}</td></tr></table></div></div></div>
212
213 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.isValidZoomLevel"></a>isValidZoomLevel</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>isValidZoomLevel: function(</td><td class=PParameter nowrap>zoomLevel</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>zoomLevel</td><td class=CDLDescription>{Integer}</td></tr></table><h4 class=CHeading>Returns</h4><p>{Boolean} Whether or not the zoom level passed in is non-null and within the min/max range of zoom levels.</p></div></div></div>
214
215 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.isValidLonLat"></a>isValidLonLat</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>isValidLonLat: function(</td><td class=PParameter nowrap>lonlat</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>lonlat</td><td class=CDLDescription>{<a href="BaseTypes/LonLat-js.html#OpenLayers.LonLat" class=LClass id=link135 onMouseOver="ShowTip(event, 'tt2', 'link135')" onMouseOut="HideTip('tt2')">OpenLayers.LonLat</a>}</td></tr></table><h4 class=CHeading>Returns</h4><p>{Boolean} Whether or not the lonlat passed in is non-null and within the maxExtent bounds</p></div></div></div>
216
217 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.getProjection"></a>getProjection</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getProjection: function()</td></tr></table></blockquote><p>This method returns a string representing the projection.&nbsp; In the case of projection support, this will be the srsCode which is loaded -- otherwise it will simply be the string value that was passed to the projection at startup.</p><p>FIXME: In 3.0, we will remove getProjectionObject, and instead return a Projection object from this function.</p><h4 class=CHeading>Returns</h4><p>{String} The Projection string from the base layer or null.</p></div></div></div>
218
219 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.getProjectionObject"></a>getProjectionObject</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getProjectionObject: function()</td></tr></table></blockquote><p>Returns the projection obect from the baselayer.</p><h4 class=CHeading>Returns</h4><p>{<a href="Projection-js.html#OpenLayers.Projection" class=LClass id=link136 onMouseOver="ShowTip(event, 'tt6', 'link136')" onMouseOut="HideTip('tt6')">OpenLayers.Projection</a>} The Projection of the base layer.</p></div></div></div>
220
221 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.getMaxResolution"></a>getMaxResolution</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getMaxResolution: function()</td></tr></table></blockquote><h4 class=CHeading>Returns</h4><p>{String} The Map&rsquo;s Maximum Resolution</p></div></div></div>
222
223 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.getMaxExtent"></a>getMaxExtent</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>getMaxExtent: function (</td><td class=PParameter nowrap>options</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>options</td><td class=CDLDescription>{Object}</td></tr></table><h4 class=CHeading>Allowed Options</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>restricted</td><td class=CDLDescription>{Boolean} If true, returns restricted extent (if it is available.)</td></tr></table><h4 class=CHeading>Returns</h4><p>{<a href="BaseTypes/Bounds-js.html#OpenLayers.Bounds" class=LClass id=link137 onMouseOver="ShowTip(event, 'tt5', 'link137')" onMouseOut="HideTip('tt5')">OpenLayers.Bounds</a>} The maxExtent property as set on the current baselayer, unless the &lsquo;restricted&rsquo; option is set, in which case the &lsquo;restrictedExtent&rsquo; option from the map is returned (if it is set).</p></div></div></div>
224
225 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.getNumZoomLevels"></a>getNumZoomLevels</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getNumZoomLevels: function()</td></tr></table></blockquote><h4 class=CHeading>Returns</h4><p>{Integer} The total number of zoom levels that can be displayed by the current baseLayer.</p></div></div></div>
226
227 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.getExtent"></a>getExtent</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getExtent: function ()</td></tr></table></blockquote><h4 class=CHeading>Returns</h4><p>{<a href="BaseTypes/Bounds-js.html#OpenLayers.Bounds" class=LClass id=link138 onMouseOver="ShowTip(event, 'tt5', 'link138')" onMouseOut="HideTip('tt5')">OpenLayers.Bounds</a>} A Bounds object which represents the lon/lat bounds of the current viewPort.&nbsp; If no baselayer is set, returns null.</p></div></div></div>
228
229 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.getResolution"></a>getResolution</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getResolution: function ()</td></tr></table></blockquote><h4 class=CHeading>Returns</h4><p>{Float} The current resolution of the map.&nbsp; If no baselayer is set, returns null.</p></div></div></div>
230
231 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.getUnits"></a>getUnits</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getUnits: function ()</td></tr></table></blockquote><h4 class=CHeading>Returns</h4><p>{Float} The current units of the map.&nbsp; If no baselayer is set, returns null.</p></div></div></div>
232
233 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.getScale"></a>getScale</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getScale: function ()</td></tr></table></blockquote><h4 class=CHeading>Returns</h4><p>{Float} The current scale denominator of the map.&nbsp; If no baselayer is set, returns null.</p></div></div></div>
234
235 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.getZoomForExtent"></a>getZoomForExtent</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>getZoomForExtent: function (</td><td class=PParameter nowrap>bounds,</td></tr><tr><td></td><td class=PParameter nowrap>closest</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>bounds</td><td class=CDLDescription>{<a href="BaseTypes/Bounds-js.html#OpenLayers.Bounds" class=LClass id=link139 onMouseOver="ShowTip(event, 'tt5', 'link139')" onMouseOut="HideTip('tt5')">OpenLayers.Bounds</a>}</td></tr><tr><td class=CDLEntry>closest</td><td class=CDLDescription>{Boolean} Find the zoom level that most closely fits the specified bounds.&nbsp; Note that this may result in a zoom that does not exactly contain the entire extent.&nbsp; Default is false.</td></tr></table><h4 class=CHeading>Returns</h4><p>{Integer} A suitable zoom level for the specified bounds.&nbsp; If no baselayer is set, returns null.</p></div></div></div>
236
237 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.getResolutionForZoom"></a>getResolutionForZoom</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>getResolutionForZoom: function(</td><td class=PParameter nowrap>zoom</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Parameter</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>zoom</td><td class=CDLDescription>{Float}</td></tr></table><h4 class=CHeading>Returns</h4><p>{Float} A suitable resolution for the specified zoom.&nbsp;  If no baselayer is set, returns null.</p></div></div></div>
238
239 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.getZoomForResolution"></a>getZoomForResolution</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>getZoomForResolution: function(</td><td class=PParameter nowrap>resolution,</td></tr><tr><td></td><td class=PParameter nowrap>closest</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Parameter</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>resolution</td><td class=CDLDescription>{Float}</td></tr><tr><td class=CDLEntry>closest</td><td class=CDLDescription>{Boolean} Find the zoom level that corresponds to the absolute closest resolution, which may result in a zoom whose corresponding resolution is actually smaller than we would have desired (if this is being called from a getZoomForExtent() call, then this means that the returned zoom index might not actually contain the entire extent specified... but it&rsquo;ll be close).&nbsp; Default is false.</td></tr></table><h4 class=CHeading>Returns</h4><p>{Integer} A suitable zoom level for the specified resolution.&nbsp; If no baselayer is set, returns null.</p></div></div></div>
240
241 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.zoomTo"></a>zoomTo</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>zoomTo: function(</td><td class=PParameter nowrap>zoom</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Zoom to a specific zoom level</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>zoom</td><td class=CDLDescription>{Integer}</td></tr></table></div></div></div>
242
243 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.zoomIn"></a>zoomIn</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>zoomIn: function()</td></tr></table></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>zoom</td><td class=CDLDescription>{int}</td></tr></table></div></div></div>
244
245 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.zoomOut"></a>zoomOut</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>zoomOut: function()</td></tr></table></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>zoom</td><td class=CDLDescription>{int}</td></tr></table></div></div></div>
246
247 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.zoomToExtent"></a>zoomToExtent</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>zoomToExtent: function(</td><td class=PParameter nowrap>bounds,</td></tr><tr><td></td><td class=PParameter nowrap>closest</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Zoom to the passed in bounds, recenter</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>bounds</td><td class=CDLDescription>{<a href="BaseTypes/Bounds-js.html#OpenLayers.Bounds" class=LClass id=link140 onMouseOver="ShowTip(event, 'tt5', 'link140')" onMouseOut="HideTip('tt5')">OpenLayers.Bounds</a>}</td></tr><tr><td class=CDLEntry>closest</td><td class=CDLDescription>{Boolean} Find the zoom level that most closely fits the specified bounds.&nbsp; Note that this may result in a zoom that does not exactly contain the entire extent.&nbsp; Default is false.</td></tr></table></div></div></div>
248
249 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.zoomToMaxExtent"></a>zoomToMaxExtent</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>zoomToMaxExtent: function(</td><td class=PParameter nowrap>options</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Zoom to the full extent and recenter.</p><h4 class=CHeading>Parameters</h4><p>options -</p><h4 class=CHeading>Allowed Options</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>restricted</td><td class=CDLDescription>{Boolean} True to zoom to restricted extent if it is set.&nbsp; Defaults to true.</td></tr></table></div></div></div>
250
251 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.zoomToScale"></a>zoomToScale</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>zoomToScale: function(</td><td class=PParameter nowrap>scale,</td></tr><tr><td></td><td class=PParameter nowrap>closest</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Zoom to a specified scale</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>scale</td><td class=CDLDescription>{float}</td></tr><tr><td class=CDLEntry>closest</td><td class=CDLDescription>{Boolean} Find the zoom level that most closely fits the specified scale.&nbsp; Note that this may result in a zoom that does not exactly contain the entire extent.&nbsp; Default is false.</td></tr></table></div></div></div>
252
253 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.getLonLatFromViewPortPx"></a>getLonLatFromViewPortPx</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>getLonLatFromViewPortPx: function (</td><td class=PParameter nowrap>viewPortPx</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>viewPortPx</td><td class=CDLDescription>{<a href="BaseTypes/Pixel-js.html#OpenLayers.Pixel" class=LClass id=link141 onMouseOver="ShowTip(event, 'tt75', 'link141')" onMouseOut="HideTip('tt75')">OpenLayers.Pixel</a>}</td></tr></table><h4 class=CHeading>Returns</h4><p>{<a href="BaseTypes/LonLat-js.html#OpenLayers.LonLat" class=LClass id=link142 onMouseOver="ShowTip(event, 'tt2', 'link142')" onMouseOut="HideTip('tt2')">OpenLayers.LonLat</a>} An OpenLayers.LonLat which is the passed-in view port <a href="BaseTypes/Pixel-js.html#OpenLayers.Pixel" class=LClass id=link143 onMouseOver="ShowTip(event, 'tt75', 'link143')" onMouseOut="HideTip('tt75')">OpenLayers.Pixel</a>, translated into lon/lat by the current base layer.</p></div></div></div>
254
255 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.getViewPortPxFromLonLat"></a>getViewPortPxFromLonLat</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>getViewPortPxFromLonLat: function (</td><td class=PParameter nowrap>lonlat</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>lonlat</td><td class=CDLDescription>{<a href="BaseTypes/LonLat-js.html#OpenLayers.LonLat" class=LClass id=link144 onMouseOver="ShowTip(event, 'tt2', 'link144')" onMouseOut="HideTip('tt2')">OpenLayers.LonLat</a>}</td></tr></table><h4 class=CHeading>Returns</h4><p>{<a href="BaseTypes/Pixel-js.html#OpenLayers.Pixel" class=LClass id=link145 onMouseOver="ShowTip(event, 'tt75', 'link145')" onMouseOut="HideTip('tt75')">OpenLayers.Pixel</a>} An OpenLayers.Pixel which is the passed-in <a href="BaseTypes/LonLat-js.html#OpenLayers.LonLat" class=LClass id=link146 onMouseOver="ShowTip(event, 'tt2', 'link146')" onMouseOut="HideTip('tt2')">OpenLayers.LonLat</a>, translated into view port pixels by the current base layer.</p></div></div></div>
256
257 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.getLonLatFromPixel"></a>getLonLatFromPixel</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>getLonLatFromPixel: function (</td><td class=PParameter nowrap>px</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>px</td><td class=CDLDescription>{<a href="BaseTypes/Pixel-js.html#OpenLayers.Pixel" class=LClass id=link147 onMouseOver="ShowTip(event, 'tt75', 'link147')" onMouseOut="HideTip('tt75')">OpenLayers.Pixel</a>}</td></tr></table><h4 class=CHeading>Returns</h4><p>{<a href="BaseTypes/LonLat-js.html#OpenLayers.LonLat" class=LClass id=link148 onMouseOver="ShowTip(event, 'tt2', 'link148')" onMouseOut="HideTip('tt2')">OpenLayers.LonLat</a>} An OpenLayers.LonLat corresponding to the given OpenLayers.Pixel, translated into lon/lat by the current base layer</p></div></div></div>
258
259 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.getPixelFromLonLat"></a>getPixelFromLonLat</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>getPixelFromLonLat: function (</td><td class=PParameter nowrap>lonlat</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns a pixel location given a map location.&nbsp;  The map location is translated to an integer pixel location (in viewport pixel coordinates) by the current base layer.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>lonlat</td><td class=CDLDescription>{<a href="BaseTypes/LonLat-js.html#OpenLayers.LonLat" class=LClass id=link149 onMouseOver="ShowTip(event, 'tt2', 'link149')" onMouseOut="HideTip('tt2')">OpenLayers.LonLat</a>} A map location.</td></tr></table><h4 class=CHeading>Returns</h4><p>{<a href="BaseTypes/Pixel-js.html#OpenLayers.Pixel" class=LClass id=link150 onMouseOver="ShowTip(event, 'tt75', 'link150')" onMouseOut="HideTip('tt75')">OpenLayers.Pixel</a>} An OpenLayers.Pixel corresponding to the <a href="BaseTypes/LonLat-js.html#OpenLayers.LonLat" class=LClass id=link151 onMouseOver="ShowTip(event, 'tt2', 'link151')" onMouseOut="HideTip('tt2')">OpenLayers.LonLat</a> translated into view port pixels by the current base layer.</p></div></div></div>
260
261 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.getViewPortPxFromLayerPx"></a>getViewPortPxFromLayerPx</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>getViewPortPxFromLayerPx:function(</td><td class=PParameter nowrap>layerPx</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>layerPx</td><td class=CDLDescription>{<a href="BaseTypes/Pixel-js.html#OpenLayers.Pixel" class=LClass id=link152 onMouseOver="ShowTip(event, 'tt75', 'link152')" onMouseOut="HideTip('tt75')">OpenLayers.Pixel</a>}</td></tr></table><h4 class=CHeading>Returns</h4><p>{<a href="BaseTypes/Pixel-js.html#OpenLayers.Pixel" class=LClass id=link153 onMouseOver="ShowTip(event, 'tt75', 'link153')" onMouseOut="HideTip('tt75')">OpenLayers.Pixel</a>} Layer Pixel translated into ViewPort Pixel coordinates</p></div></div></div>
262
263 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.getLayerPxFromViewPortPx"></a>getLayerPxFromViewPortPx</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>getLayerPxFromViewPortPx:function(</td><td class=PParameter nowrap>viewPortPx</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>viewPortPx</td><td class=CDLDescription>{<a href="BaseTypes/Pixel-js.html#OpenLayers.Pixel" class=LClass id=link154 onMouseOver="ShowTip(event, 'tt75', 'link154')" onMouseOut="HideTip('tt75')">OpenLayers.Pixel</a>}</td></tr></table><h4 class=CHeading>Returns</h4><p>{<a href="BaseTypes/Pixel-js.html#OpenLayers.Pixel" class=LClass id=link155 onMouseOver="ShowTip(event, 'tt75', 'link155')" onMouseOut="HideTip('tt75')">OpenLayers.Pixel</a>} ViewPort Pixel translated into Layer Pixel coordinates</p></div></div></div>
264
265 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.getLonLatFromLayerPx"></a>getLonLatFromLayerPx</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>getLonLatFromLayerPx: function (</td><td class=PParameter nowrap>px</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>px</td><td class=CDLDescription>{<a href="BaseTypes/Pixel-js.html#OpenLayers.Pixel" class=LClass id=link156 onMouseOver="ShowTip(event, 'tt75', 'link156')" onMouseOut="HideTip('tt75')">OpenLayers.Pixel</a>}</td></tr></table><h4 class=CHeading>Returns</h4><p>{<a href="BaseTypes/LonLat-js.html#OpenLayers.LonLat" class=LClass id=link157 onMouseOver="ShowTip(event, 'tt2', 'link157')" onMouseOut="HideTip('tt2')">OpenLayers.LonLat</a>}</p></div></div></div>
266
267 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.getLayerPxFromLonLat"></a>getLayerPxFromLonLat</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>getLayerPxFromLonLat: function (</td><td class=PParameter nowrap>lonlat</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>lonlat</td><td class=CDLDescription>{<a href="BaseTypes/LonLat-js.html#OpenLayers.LonLat" class=LClass id=link158 onMouseOver="ShowTip(event, 'tt2', 'link158')" onMouseOut="HideTip('tt2')">OpenLayers.LonLat</a>} lonlat</td></tr></table><h4 class=CHeading>Returns</h4><p>{<a href="BaseTypes/Pixel-js.html#OpenLayers.Pixel" class=LClass id=link159 onMouseOver="ShowTip(event, 'tt75', 'link159')" onMouseOut="HideTip('tt75')">OpenLayers.Pixel</a>} An OpenLayers.Pixel which is the passed-in <a href="BaseTypes/LonLat-js.html#OpenLayers.LonLat" class=LClass id=link160 onMouseOver="ShowTip(event, 'tt2', 'link160')" onMouseOut="HideTip('tt2')">OpenLayers.LonLat</a>, translated into layer pixels by the current base layer</p></div></div></div>
268
269 <div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.Constants"></a>Constants</h3></div></div>
270
271 <div class="CConstant"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.TILE_WIDTH"></a>TILE_WIDTH</h3><div class=CBody><p>{Integer} 256 Default tile width (unless otherwise specified)</p></div></div></div>
272
273 <div class="CConstant"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.TILE_HEIGHT"></a>TILE_HEIGHT</h3><div class=CBody><p>{Integer} 256 Default tile height (unless otherwise specified)</p></div></div></div>
274
275 </div><!--Content-->
276
277
278 <div id=Footer><a href="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer-->
279
280
281 <div id=Menu><div class=MTitle>OpenLayers<div class=MSubTitle>JavaScript Mapping Library</div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent29')">OpenLayers</a><div class=MGroupContent id=MGroupContent29><div class=MEntry><div class=MFile><a href="../OpenLayers-js.html">OpenLayers</a></div></div><div class=MEntry><div class=MFile><a href="Ajax-js.html">Ajax</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent1')">BaseTypes</a><div class=MGroupContent id=MGroupContent1><div class=MEntry><div class=MFile><a href="BaseTypes-js.html">Base Types</a></div></div><div class=MEntry><div class=MFile><a href="BaseTypes/Bounds-js.html">Bounds</a></div></div><div class=MEntry><div class=MFile><a href="BaseTypes/Class-js.html">Class</a></div></div><div class=MEntry><div class=MFile><a href="BaseTypes/Element-js.html">Element</a></div></div><div class=MEntry><div class=MFile><a href="BaseTypes/LonLat-js.html">LonLat</a></div></div><div class=MEntry><div class=MFile><a href="BaseTypes/Pixel-js.html">Pixel</a></div></div><div class=MEntry><div class=MFile><a href="BaseTypes/Size-js.html">Size</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="Console-js.html">Console</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent3')">Control</a><div class=MGroupContent id=MGroupContent3><div class=MEntry><div class=MFile><a href="Control-js.html">Control</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent2')">Control</a><div class=MGroupContent id=MGroupContent2><div class=MEntry><div class=MFile><a href="Control/ArgParser-js.html">ArgParser</a></div></div><div class=MEntry><div class=MFile><a href="Control/Attribution-js.html">Attribution</a></div></div><div class=MEntry><div class=MFile><a href="Control/Button-js.html">Button</a></div></div><div class=MEntry><div class=MFile><a href="Control/DragFeature-js.html">DragFeature</a></div></div><div class=MEntry><div class=MFile><a href="Control/DragPan-js.html">DragPan</a></div></div><div class=MEntry><div class=MFile><a href="Control/DrawFeature-js.html">DrawFeature</a></div></div><div class=MEntry><div class=MFile><a href="Control/EditingToolbar-js.html">EditingToolbar</a></div></div><div class=MEntry><div class=MFile><a href="Control/GetFeature-js.html">GetFeature</a></div></div><div class=MEntry><div class=MFile><a href="Control/KeyboardDefaults-js.html">KeyboardDefaults</a></div></div><div class=MEntry><div class=MFile><a href="Control/LayerSwitcher-js.html">LayerSwitcher</a></div></div><div class=MEntry><div class=MFile><a href="Control/Measure-js.html">Measure</a></div></div><div class=MEntry><div class=MFile><a href="Control/ModifyFeature-js.html">ModifyFeature</a></div></div><div class=MEntry><div class=MFile><a href="Control/MouseDefaults-js.html">MouseDefaults</a></div></div><div class=MEntry><div class=MFile><a href="Control/MousePosition-js.html">MousePosition</a></div></div><div class=MEntry><div class=MFile><a href="Control/MouseToolbar-js.html">MouseToolbar</a></div></div><div class=MEntry><div class=MFile><a href="Control/Navigation-js.html">Navigation</a></div></div><div class=MEntry><div class=MFile><a href="Control/NavigationHistory-js.html">NavigationHistory</a></div></div><div class=MEntry><div class=MFile><a href="Control/NavToolbar-js.html">NavToolbar</a></div></div><div class=MEntry><div class=MFile><a href="Control/OverviewMap-js.html">OverviewMap</a></div></div><div class=MEntry><div class=MFile><a href="Control/Pan-js.html">Pan</a></div></div><div class=MEntry><div class=MFile><a href="Control/Panel-js.html">Panel</a></div></div><div class=MEntry><div class=MFile><a href="Control/PanPanel-js.html">PanPanel</a></div></div><div class=MEntry><div class=MFile><a href="Control/PanZoom-js.html">PanZoom</a></div></div><div class=MEntry><div class=MFile><a href="Control/PanZoomBar-js.html">PanZoomBar</a></div></div><div class=MEntry><div class=MFile><a href="Control/Permalink-js.html">Permalink</a></div></div><div class=MEntry><div class=MFile><a href="Control/Scale-js.html">Scale</a></div></div><div class=MEntry><div class=MFile><a href="Control/ScaleLine-js.html">ScaleLine</a></div></div><div class=MEntry><div class=MFile><a href="Control/SelectFeature-js.html">SelectFeature</a></div></div><div class=MEntry><div class=MFile><a href="Control/Snapping-js.html">Snapping</a></div></div><div class=MEntry><div class=MFile><a href="Control/Split-js.html">Split</a></div></div><div class=MEntry><div class=MFile><a href="Control/WMSGetFeatureInfo-js.html">WMSGetFeatureInfo</a></div></div><div class=MEntry><div class=MFile><a href="Control/ZoomBox-js.html">ZoomBox</a></div></div><div class=MEntry><div class=MFile><a href="Control/ZoomIn-js.html">ZoomIn</a></div></div><div class=MEntry><div class=MFile><a href="Control/ZoomOut-js.html">ZoomOut</a></div></div><div class=MEntry><div class=MFile><a href="Control/ZoomPanel-js.html">ZoomPanel</a></div></div><div class=MEntry><div class=MFile><a href="Control/ZoomToMaxExtent-js.html">ZoomToMaxExtent</a></div></div></div></div></div></div></div></div><div class=MEntry><div class=MFile><a href="Events-js.html">Events</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent4')">Feature</a><div class=MGroupContent id=MGroupContent4><div class=MEntry><div class=MFile><a href="Feature-js.html">Feature</a></div></div><div class=MEntry><div class=MFile><a href="Feature/Vector-js.html">Vector</a></div></div><div class=MEntry><div class=MFile><a href="Feature/WFS-js.html">WFS</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent5')">Filter</a><div class=MGroupContent id=MGroupContent5><div class=MEntry><div class=MFile><a href="Filter-js.html">Filter</a></div></div><div class=MEntry><div class=MFile><a href="Filter/Comparison-js.html">Comparison</a></div></div><div class=MEntry><div class=MFile><a href="Filter/FeatureId-js.html">FeatureId</a></div></div><div class=MEntry><div class=MFile><a href="Filter/Logical-js.html">Logical</a></div></div><div class=MEntry><div class=MFile><a href="Filter/Spatial-js.html">Spatial</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent14')">Format</a><div class=MGroupContent id=MGroupContent14><div class=MEntry><div class=MFile><a href="Format-js.html">Format</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent6')">Filter</a><div class=MGroupContent id=MGroupContent6><div class=MEntry><div class=MFile><a href="Format/Filter-js.html">Filter</a></div></div><div class=MEntry><div class=MFile><a href="Format/Filter/v1-js.html">v1</a></div></div><div class=MEntry><div class=MFile><a href="Format/Filter/v1_0_0-js.html">v1_0_0</a></div></div><div class=MEntry><div class=MFile><a href="Format/Filter/v1_1_0-js.html">v1_1_0</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent7')">GML</a><div class=MGroupContent id=MGroupContent7><div class=MEntry><div class=MFile><a href="Format/GML-js.html">GML</a></div></div><div class=MEntry><div class=MFile><a href="Format/GML/Base-js.html">Base</a></div></div><div class=MEntry><div class=MFile><a href="Format/GML/v2-js.html">v2</a></div></div><div class=MEntry><div class=MFile><a href="Format/GML/v3-js.html">v3</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent8')">SLD</a><div class=MGroupContent id=MGroupContent8><div class=MEntry><div class=MFile><a href="Format/SLD-js.html">SLD</a></div></div><div class=MEntry><div class=MFile><a href="Format/SLD/v1-js.html">v1</a></div></div><div class=MEntry><div class=MFile><a href="Format/SLD/v1_0_0-js.html">v1_0_0</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent9')">WMC</a><div class=MGroupContent id=MGroupContent9><div class=MEntry><div class=MFile><a href="Format/WMC-js.html">WMC</a></div></div><div class=MEntry><div class=MFile><a href="Format/WMC/v1-js.html">v1</a></div></div><div class=MEntry><div class=MFile><a href="Format/WMC/v1_0_0-js.html">v1_0_0</a></div></div><div class=MEntry><div class=MFile><a href="Format/WMC/v1_1_0-js.html">v1_1_0</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent13')">Format</a><div class=MGroupContent id=MGroupContent13><div class=MEntry><div class=MFile><a href="Format/ArcXML-js.html">ArcXML</a></div></div><div class=MEntry><div class=MFile><a href="Format/ArcXML/Features-js.html">ArcXML.<wbr>Features</a></div></div><div class=MEntry><div class=MFile><a href="Format/GeoJSON-js.html">GeoJSON</a></div></div><div class=MEntry><div class=MFile><a href="Format/GeoRSS-js.html">GeoRSS</a></div></div><div class=MEntry><div class=MFile><a href="Format/GPX-js.html">GPX</a></div></div><div class=MEntry><div class=MFile><a href="Format/JSON-js.html">JSON</a></div></div><div class=MEntry><div class=MFile><a href="Format/KML-js.html">KML</a></div></div><div class=MEntry><div class=MFile><a href="Format/OSM-js.html">OSM</a></div></div><div class=MEntry><div class=MFile><a href="Format/Text-js.html">Text</a></div></div><div class=MEntry><div class=MFile><a href="Format/WFS-js.html">WFS</a></div></div><div class=MEntry><div class=MFile><a href="Format/WFSCapabilities-js.html">WFSCapabilities</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent10')">WFSCapabilities</a><div class=MGroupContent id=MGroupContent10><div class=MEntry><div class=MFile><a href="Format/WFSCapabilities/v1-js.html">WFSCapabilities.v1</a></div></div><div class=MEntry><div class=MFile><a href="Format/WFSCapabilities/v1_0_0-js.html">WFSCapabilities/<wbr>v1_0_0</a></div></div><div class=MEntry><div class=MFile><a href="Format/WFSCapabilities/v1_1_0-js.html">WFSCapabilities/<wbr>v1_1_0</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="Format/WFSDescribeFeatureType-js.html">WFSDescribeFeatureType.js</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent11')">WFST</a><div class=MGroupContent id=MGroupContent11><div class=MEntry><div class=MFile><a href="Format/WFST-js.html">WFST</a></div></div><div class=MEntry><div class=MFile><a href="Format/WFST/v1-js.html">v1</a></div></div><div class=MEntry><div class=MFile><a href="Format/WFST/v1_0_0-js.html">v1_0_0</a></div></div><div class=MEntry><div class=MFile><a href="Format/WFST/v1_1_0-js.html">v1_1_0</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="Format/WKT-js.html">WKT</a></div></div><div class=MEntry><div class=MFile><a href="Format/WMSCapabilities-js.html">WMSCapabilities</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent12')">WMSCapabilities</a><div class=MGroupContent id=MGroupContent12><div class=MEntry><div class=MFile><a href="Format/WMSCapabilities/v1_1-js.html">WMSCapabilities.v1_1</a></div></div><div class=MEntry><div class=MFile><a href="Format/WMSCapabilities/v1_1_0-js.html">WMSCapabilities/<wbr>v1_1_0</a></div></div><div class=MEntry><div class=MFile><a href="Format/WMSCapabilities/v1_1_1-js.html">WMSCapabilities/<wbr>v1_1_1</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="Format/WMSDescribeLayer-js.html">WMSDescribeLayer</a></div></div><div class=MEntry><div class=MFile><a href="Format/WMSDescribeLayer/v1_1-js.html">WMSDescribeLayer.v1_1</a></div></div><div class=MEntry><div class=MFile><a href="Format/WMSGetFeatureInfo-js.html">WMSGetFeatureInfo</a></div></div><div class=MEntry><div class=MFile><a href="Format/XML-js.html">XML</a></div></div></div></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent15')">Geometry</a><div class=MGroupContent id=MGroupContent15><div class=MEntry><div class=MFile><a href="Geometry-js.html">Geometry</a></div></div><div class=MEntry><div class=MFile><a href="Geometry/Collection-js.html">Collection</a></div></div><div class=MEntry><div class=MFile><a href="Geometry/Curve-js.html">Curve</a></div></div><div class=MEntry><div class=MFile><a href="Geometry/LinearRing-js.html">LinearRing</a></div></div><div class=MEntry><div class=MFile><a href="Geometry/LineString-js.html">LineString</a></div></div><div class=MEntry><div class=MFile><a href="Geometry/MultiLineString-js.html">MultiLineString</a></div></div><div class=MEntry><div class=MFile><a href="Geometry/MultiPoint-js.html">MultiPoint</a></div></div><div class=MEntry><div class=MFile><a href="Geometry/MultiPolygon-js.html">MultiPolygon</a></div></div><div class=MEntry><div class=MFile><a href="Geometry/Point-js.html">Point</a></div></div><div class=MEntry><div class=MFile><a href="Geometry/Polygon-js.html">Polygon</a></div></div><div class=MEntry><div class=MFile><a href="Geometry/Rectangle-js.html">Rectangle</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent16')">Handler</a><div class=MGroupContent id=MGroupContent16><div class=MEntry><div class=MFile><a href="Handler-js.html">Handler</a></div></div><div class=MEntry><div class=MFile><a href="Handler/Box-js.html">Box</a></div></div><div class=MEntry><div class=MFile><a href="Handler/Click-js.html">Click</a></div></div><div class=MEntry><div class=MFile><a href="Handler/Drag-js.html">Drag</a></div></div><div class=MEntry><div class=MFile><a href="Handler/Feature-js.html">Feature</a></div></div><div class=MEntry><div class=MFile><a href="Handler/Hover-js.html">Hover</a></div></div><div class=MEntry><div class=MFile><a href="Handler/Keyboard-js.html">Keyboard</a></div></div><div class=MEntry><div class=MFile><a href="Handler/MouseWheel-js.html">MouseWheel</a></div></div><div class=MEntry><div class=MFile><a href="Handler/Path-js.html">Path</a></div></div><div class=MEntry><div class=MFile><a href="Handler/Point-js.html">Point</a></div></div><div class=MEntry><div class=MFile><a href="Handler/Polygon-js.html">Polygon</a></div></div><div class=MEntry><div class=MFile><a href="Handler/RegularPolygon-js.html">RegularPolygon</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="Icon-js.html">Icon</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent17')">Lang</a><div class=MGroupContent id=MGroupContent17><div class=MEntry><div class=MFile><a href="Lang-js.html">Lang</a></div></div><div class=MEntry><div class=MFile><a href="Lang/ca-js.html">ca</a></div></div><div class=MEntry><div class=MFile><a href="Lang/cs-CZ-js.html">cs-CZ</a></div></div><div class=MEntry><div class=MFile><a href="Lang/da-DK-js.html">da-DK</a></div></div><div class=MEntry><div class=MFile><a href="Lang/de-js.html">de</a></div></div><div class=MEntry><div class=MFile><a href="Lang/en-js.html">en</a></div></div><div class=MEntry><div class=MFile><a href="Lang/en-CA-js.html">en-CA</a></div></div><div class=MEntry><div class=MFile><a href="Lang/es-js.html">es</a></div></div><div class=MEntry><div class=MFile><a href="Lang/fr-js.html">fr</a></div></div><div class=MEntry><div class=MFile><a href="Lang/it-js.html">it</a></div></div><div class=MEntry><div class=MFile><a href="Lang/nb-js.html">nb</a></div></div><div class=MEntry><div class=MFile><a href="Lang/nl-js.html">nl</a></div></div><div class=MEntry><div class=MFile><a href="Lang/pt-BR-js.html">pt-BR</a></div></div><div class=MEntry><div class=MFile><a href="Lang/sv-SE-js.html">sv-SE</a></div></div><div class=MEntry><div class=MFile><a href="Lang/zh-CN-js.html">zh-CN</a></div></div><div class=MEntry><div class=MFile><a href="Lang/zh-TW-js.html">zh-TW</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent19')">Layer</a><div class=MGroupContent id=MGroupContent19><div class=MEntry><div class=MFile><a href="Layer-js.html">Layer</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent18')">Layer</a><div class=MGroupContent id=MGroupContent18><div class=MEntry><div class=MFile><a href="Layer/ArcGIS93Rest-js.html">ArcGIS93Rest</a></div></div><div class=MEntry><div class=MFile><a href="Layer/Boxes-js.html">Boxes</a></div></div><div class=MEntry><div class=MFile><a href="Layer/EventPane-js.html">EventPane</a></div></div><div class=MEntry><div class=MFile><a href="Layer/FixedZoomLevels-js.html">FixedZoomLevels</a></div></div><div class=MEntry><div class=MFile><a href="Layer/GeoRSS-js.html">GeoRSS</a></div></div><div class=MEntry><div class=MFile><a href="Layer/GML-js.html">GML</a></div></div><div class=MEntry><div class=MFile><a href="Layer/Google-js.html">Google</a></div></div><div class=MEntry><div class=MFile><a href="Layer/Grid-js.html">Grid</a></div></div><div class=MEntry><div class=MFile><a href="Layer/HTTPRequest-js.html">HTTPRequest</a></div></div><div class=MEntry><div class=MFile><a href="Layer/Image-js.html">Image</a></div></div><div class=MEntry><div class=MFile><a href="Layer/KaMap-js.html">KaMap</a></div></div><div class=MEntry><div class=MFile><a href="Layer/KaMapCache-js.html">KaMapCache</a></div></div><div class=MEntry><div class=MFile><a href="Layer/MapGuide-js.html">MapGuide</a></div></div><div class=MEntry><div class=MFile><a href="Layer/MapServer-js.html">MapServer</a></div></div><div class=MEntry><div class=MFile><a href="Layer/MapServer/Untiled-js.html">MapServer.<wbr>Untiled</a></div></div><div class=MEntry><div class=MFile><a href="Layer/Markers-js.html">Markers</a></div></div><div class=MEntry><div class=MFile><a href="Layer/MultiMap-js.html">MultiMap</a></div></div><div class=MEntry><div class=MFile><a href="Layer/PointTrack-js.html">PointTrack</a></div></div><div class=MEntry><div class=MFile><a href="Layer/SphericalMercator-js.html">SphericalMercator</a></div></div><div class=MEntry><div class=MFile><a href="Layer/Text-js.html">Text</a></div></div><div class=MEntry><div class=MFile><a href="Layer/TileCache-js.html">TileCache</a></div></div><div class=MEntry><div class=MFile><a href="Layer/TMS-js.html">TMS</a></div></div><div class=MEntry><div class=MFile><a href="Layer/Vector-js.html">Vector</a></div></div><div class=MEntry><div class=MFile><a href="Layer/Vector/RootContainer-js.html">Vector.<wbr>RootContainer</a></div></div><div class=MEntry><div class=MFile><a href="Layer/VirtualEarth-js.html">VirtualEarth</a></div></div><div class=MEntry><div class=MFile><a href="Layer/WFS-js.html">WFS</a></div></div><div class=MEntry><div class=MFile><a href="Layer/WMS-js.html">WMS</a></div></div><div class=MEntry><div class=MFile><a href="Layer/WMS/Untiled-js.html">WMS.<wbr>Untiled</a></div></div><div class=MEntry><div class=MFile><a href="Layer/WorldWind-js.html">WorldWind</a></div></div><div class=MEntry><div class=MFile><a href="Layer/Yahoo-js.html">Yahoo</a></div></div><div class=MEntry><div class=MFile><a href="Layer/ArcIMS-js.html">ArcIMS</a></div></div><div class=MEntry><div class=MFile><a href="Layer/XYZ-js.html">XYZ</a></div></div></div></div></div></div></div></div><div class=MEntry><div class=MFile id=MSelected>Map</div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent20')">Marker</a><div class=MGroupContent id=MGroupContent20><div class=MEntry><div class=MFile><a href="Marker-js.html">Marker</a></div></div><div class=MEntry><div class=MFile><a href="Marker/Box-js.html">Box</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent21')">Popup</a><div class=MGroupContent id=MGroupContent21><div class=MEntry><div class=MFile><a href="Popup-js.html">Popup</a></div></div><div class=MEntry><div class=MFile><a href="Popup/Anchored-js.html">Anchored</a></div></div><div class=MEntry><div class=MFile><a href="Popup/AnchoredBubble-js.html">AnchoredBubble</a></div></div><div class=MEntry><div class=MFile><a href="Popup/Framed-js.html">Framed</a></div></div><div class=MEntry><div class=MFile><a href="Popup/FramedCloud-js.html">FramedCloud</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="Projection-js.html">Projection</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent24')">Protocol</a><div class=MGroupContent id=MGroupContent24><div class=MEntry><div class=MFile><a href="Protocol-js.html">Protocol</a></div></div><div class=MEntry><div class=MFile><a href="Protocol/HTTP-js.html">HTTP</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent22')">SQL</a><div class=MGroupContent id=MGroupContent22><div class=MEntry><div class=MFile><a href="Protocol/SQL-js.html">SQL</a></div></div><div class=MEntry><div class=MFile><a href="Protocol/SQL/Gears-js.html">Gears</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent23')">WFS</a><div class=MGroupContent id=MGroupContent23><div class=MEntry><div class=MFile><a href="Protocol/WFS-js.html">WFS</a></div></div><div class=MEntry><div class=MFile><a href="Protocol/WFS/v1-js.html">v1</a></div></div><div class=MEntry><div class=MFile><a href="Protocol/WFS/v1_0_0-js.html">v1_0_0</a></div></div><div class=MEntry><div class=MFile><a href="Protocol/WFS/v1_1_0-js.html">v1_1_0</a></div></div></div></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent25')">Renderer</a><div class=MGroupContent id=MGroupContent25><div class=MEntry><div class=MFile><a href="Renderer-js.html">Renderer</a></div></div><div class=MEntry><div class=MFile><a href="Renderer/Canvas-js.html">Canvas</a></div></div><div class=MEntry><div class=MFile><a href="Renderer/Elements-js.html">Elements</a></div></div><div class=MEntry><div class=MFile><a href="Renderer/SVG-js.html">SVG</a></div></div><div class=MEntry><div class=MFile><a href="Renderer/VML-js.html">VML</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent26')">Request</a><div class=MGroupContent id=MGroupContent26><div class=MEntry><div class=MFile><a href="Request-js.html">Request</a></div></div><div class=MEntry><div class=MFile><a href="Request/XMLHttpRequest-js.html">XMLHttpRequest</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="Rule-js.html">Rule</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent27')">Strategy</a><div class=MGroupContent id=MGroupContent27><div class=MEntry><div class=MFile><a href="Strategy-js.html">Strategy</a></div></div><div class=MEntry><div class=MFile><a href="Strategy/BBOX-js.html">BBOX</a></div></div><div class=MEntry><div class=MFile><a href="Strategy/Cluster-js.html">Cluster</a></div></div><div class=MEntry><div class=MFile><a href="Strategy/Fixed-js.html">Fixed</a></div></div><div class=MEntry><div class=MFile><a href="Strategy/Paging-js.html">Paging</a></div></div><div class=MEntry><div class=MFile><a href="Strategy/Save-js.html">Save</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="Style-js.html">Style</a></div></div><div class=MEntry><div class=MFile><a href="StyleMap-js.html">StyleMap</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent28')">Tile</a><div class=MGroupContent id=MGroupContent28><div class=MEntry><div class=MFile><a href="Tile-js.html">Tile</a></div></div><div class=MEntry><div class=MFile><a href="Tile/Image-js.html">Image</a></div></div><div class=MEntry><div class=MFile><a href="Tile/WFS-js.html">WFS</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="Tween-js.html">Tween</a></div></div><div class=MEntry><div class=MFile><a href="Util-js.html">Util</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent30')">Index</a><div class=MGroupContent id=MGroupContent30><div class=MEntry><div class=MIndex><a href="../../index/General.html">Everything</a></div></div><div class=MEntry><div class=MIndex><a href="../../index/Classes.html">Classes</a></div></div><div class=MEntry><div class=MIndex><a href="../../index/Constants.html">Constants</a></div></div><div class=MEntry><div class=MIndex><a href="../../index/Functions.html">Functions</a></div></div><div class=MEntry><div class=MIndex><a href="../../index/Properties.html">Properties</a></div></div><div class=MEntry><div class=MIndex><a href="../../index/Files.html">Files</a></div></div><div class=MEntry><div class=MIndex><a href="../../index/Constructor.html">Constructor</a></div></div></div></div></div><script type="text/javascript"><!--
282 var searchPanel = new SearchPanel("searchPanel", "HTML", "../../search");
283 --></script><div id=MSearchPanel class=MSearchPanelInactive><input type=text id=MSearchField value=Search onFocus="searchPanel.OnSearchFieldFocus(true)" onBlur="searchPanel.OnSearchFieldFocus(false)" onKeyUp="searchPanel.OnSearchFieldChange()"><select id=MSearchType onFocus="searchPanel.OnSearchTypeFocus(true)" onBlur="searchPanel.OnSearchTypeFocus(false)" onChange="searchPanel.OnSearchTypeChange()"><option  id=MSearchEverything selected value="General">Everything</option><option value="Classes">Classes</option><option value="Constants">Constants</option><option value="Constructor">Constructor</option><option value="Files">Files</option><option value="Functions">Functions</option><option value="Properties">Properties</option></select></div><script language=JavaScript><!--
284 HideAllBut([29], 31);// --></script></div><!--Menu-->
285
286
287
288 <!--START_ND_TOOLTIPS-->
289 <div class=CToolTip id="tt1"><div class=CClass>Instances of this class represent a width/height pair</div></div><div class=CToolTip id="tt2"><div class=CClass>This class represents a longitude and latitude pair</div></div><div class=CToolTip id="tt3"><div class=CClass>Controls affect the display or behavior of the map. </div></div><div class=CToolTip id="tt4"><div class=CClass>A popup is a small div that can opened and closed on the map. </div></div><div class=CToolTip id="tt5"><div class=CClass>Instances of this class represent bounding boxes. </div></div><div class=CToolTip id="tt6"><div class=CClass>Class for coordinate transforms between coordinate systems. </div></div><div class=CToolTip id="tt7"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>on: function(</td><td class=PParameter nowrap>object</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Convenience method for registering listeners with a common scope.</div></div><div class=CToolTip id="tt8"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>render: function(</td><td class=PParameter nowrap>div</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Render the map to a specified container.</div></div><div class=CToolTip id="tt9"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>destroy:function()</td></tr></table></blockquote>Destroy this map</div></div><div class=CToolTip id="tt10"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>setOptions: function(</td><td class=PParameter nowrap>options</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Change the map options</div></div><div class=CToolTip id="tt11"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getTileSize: function()</td></tr></table></blockquote>Get the tile size for the map</div></div><div class=CToolTip id="tt12"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>getBy: function(</td><td class=PParameter nowrap>array,</td></tr><tr><td></td><td class=PParameter nowrap>property,</td></tr><tr><td></td><td class=PParameter nowrap>match</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Get a list of objects given a property and a match item.</div></div><div class=CToolTip id="tt13"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>getLayersBy: function(</td><td class=PParameter nowrap>property,</td></tr><tr><td></td><td class=PParameter nowrap>match</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Get a list of layers with properties matching the given criteria.</div></div><div class=CToolTip id="tt14"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>getLayersByName: function(</td><td class=PParameter nowrap>match</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Get a list of layers with names matching the given name.</div></div><div class=CToolTip id="tt15"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>getLayersByClass: function(</td><td class=PParameter nowrap>match</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Get a list of layers of a given class (CLASS_NAME).</div></div><div class=CToolTip id="tt16"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>getControlsBy: function(</td><td class=PParameter nowrap>property,</td></tr><tr><td></td><td class=PParameter nowrap>match</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Get a list of controls with properties matching the given criteria.</div></div><div class=CToolTip id="tt17"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>getControlsByClass: function(</td><td class=PParameter nowrap>match</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Get a list of controls of a given class (CLASS_NAME).</div></div><div class=CToolTip id="tt18"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>getLayer: function(</td><td class=PParameter nowrap>id</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Get a layer based on its id</div></div><div class=CToolTip id="tt19"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>setLayerZIndex: function (</td><td class=PParameter nowrap>layer,</td></tr><tr><td></td><td class=PParameter nowrap>zIdx</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt20"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>resetLayersZIndex: function()</td></tr></table></blockquote>Reset each layer&rsquo;s z-index based on layer&rsquo;s array index</div></div><div class=CToolTip id="tt21"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>addLayer: function (</td><td class=PParameter nowrap>layer</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt22"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>addLayers: function (</td><td class=PParameter nowrap>layers</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt23"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>removeLayer: function(</td><td class=PParameter nowrap>layer,</td></tr><tr><td></td><td class=PParameter nowrap>setNewBaseLayer</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Removes a layer from the map by removing its visual element (the layer.div property), then removing it from the map&rsquo;s internal list of layers, setting the layer&rsquo;s map property to null.</div></div><div class=CToolTip id="tt24"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getNumLayers: function ()</td></tr></table></blockquote>{Int} The number of layers attached to the map.</div></div><div class=CToolTip id="tt25"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>getLayerIndex: function (</td><td class=PParameter nowrap>layer</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt26"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>setLayerIndex: function (</td><td class=PParameter nowrap>layer,</td></tr><tr><td></td><td class=PParameter nowrap>idx</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Move the given layer to the specified (zero-based) index in the layer list, changing its z-index in the map display. </div></div><div class=CToolTip id="tt27"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>raiseLayer: function (</td><td class=PParameter nowrap>layer,</td></tr><tr><td></td><td class=PParameter nowrap>delta</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Change the index of the given layer by delta. </div></div><div class=CToolTip id="tt28"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>setBaseLayer: function(</td><td class=PParameter nowrap>newBaseLayer</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Allows user to specify one of the currently-loaded layers as the Map&rsquo;s new base layer.</div></div><div class=CToolTip id="tt29"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>addControl: function (</td><td class=PParameter nowrap>control,</td></tr><tr><td></td><td class=PParameter nowrap>px</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt30"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>addControlToMap: function (</td><td class=PParameter nowrap>control,</td></tr><tr><td></td><td class=PParameter nowrap>px</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt31"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>getControl: function (</td><td class=PParameter nowrap>id</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt32"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>removeControl: function (</td><td class=PParameter nowrap>control</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Remove a control from the map. </div></div><div class=CToolTip id="tt33"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>addPopup: function(</td><td class=PParameter nowrap>popup,</td></tr><tr><td></td><td class=PParameter nowrap>exclusive</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt34"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>removePopup: function(</td><td class=PParameter nowrap>popup</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt35"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getSize: function ()</td></tr></table></blockquote>{OpenLayers.Size} An OpenLayers.Size object that represents the size, in pixels, of the div into which OpenLayers has been loaded. </div></div><div class=CToolTip id="tt36"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>updateSize: function()</td></tr></table></blockquote>This function should be called by any external code which dynamically changes the size of the map div (because mozilla wont let us catch the &ldquo;onresize&rdquo; for an element)</div></div><div class=CToolTip id="tt37"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getCurrentSize: function()</td></tr></table></blockquote>{OpenLayers.Size} A new OpenLayers.Size object with the dimensions of the map div</div></div><div class=CToolTip id="tt38"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>calculateBounds: function(</td><td class=PParameter nowrap>center,</td></tr><tr><td></td><td class=PParameter nowrap>resolution</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt39"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getCenter: function ()</td></tr></table></blockquote>{OpenLayers.LonLat}</div></div><div class=CToolTip id="tt40"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getZoom: function ()</td></tr></table></blockquote>{Integer}</div></div><div class=CToolTip id="tt41"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>pan: function(</td><td class=PParameter nowrap>dx,</td></tr><tr><td></td><td class=PParameter nowrap>dy,</td></tr><tr><td></td><td class=PParameter nowrap>options</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Allows user to pan by a value of screen pixels</div></div><div class=CToolTip id="tt42"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>panTo: function(</td><td class=PParameter nowrap>lonlat</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Allows user to pan to a new lonlat If the new lonlat is in the current extent the map will slide smoothly</div></div><div class=CToolTip id="tt43"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>setCenter: function(</td><td class=PParameter nowrap>lonlat,</td></tr><tr><td></td><td class=PParameter nowrap>zoom,</td></tr><tr><td></td><td class=PParameter nowrap>dragging,</td></tr><tr><td></td><td class=PParameter nowrap>forceZoomChange</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Set the map center (and optionally, the zoom level).</div></div><div class=CToolTip id="tt44"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>moveTo: function(</td><td class=PParameter nowrap>lonlat,</td></tr><tr><td></td><td class=PParameter nowrap>zoom,</td></tr><tr><td></td><td class=PParameter nowrap>options</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt45"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>centerLayerContainer: function (</td><td class=PParameter nowrap>lonlat</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>This function takes care to recenter the layerContainerDiv.</div></div><div class=CToolTip id="tt46"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>isValidZoomLevel: function(</td><td class=PParameter nowrap>zoomLevel</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt47"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>isValidLonLat: function(</td><td class=PParameter nowrap>lonlat</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt48"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getProjection: function()</td></tr></table></blockquote>This method returns a string representing the projection. </div></div><div class=CToolTip id="tt49"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getProjectionObject: function()</td></tr></table></blockquote>Returns the projection obect from the baselayer.</div></div><div class=CToolTip id="tt50"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getMaxResolution: function()</td></tr></table></blockquote>{String} The Map&rsquo;s Maximum Resolution</div></div><div class=CToolTip id="tt51"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>getMaxExtent: function (</td><td class=PParameter nowrap>options</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt52"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getNumZoomLevels: function()</td></tr></table></blockquote>{Integer} The total number of zoom levels that can be displayed by the current baseLayer.</div></div><div class=CToolTip id="tt53"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getExtent: function ()</td></tr></table></blockquote>{OpenLayers.Bounds} A Bounds object which represents the lon/lat bounds of the current viewPort. </div></div><div class=CToolTip id="tt54"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getResolution: function ()</td></tr></table></blockquote>{Float} The current resolution of the map. </div></div><div class=CToolTip id="tt55"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getUnits: function ()</td></tr></table></blockquote>{Float} The current units of the map. </div></div><div class=CToolTip id="tt56"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getScale: function ()</td></tr></table></blockquote>{Float} The current scale denominator of the map. </div></div><div class=CToolTip id="tt57"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>getZoomForExtent: function (</td><td class=PParameter nowrap>bounds,</td></tr><tr><td></td><td class=PParameter nowrap>closest</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt58"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>getResolutionForZoom: function(</td><td class=PParameter nowrap>zoom</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt59"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>getZoomForResolution: function(</td><td class=PParameter nowrap>resolution,</td></tr><tr><td></td><td class=PParameter nowrap>closest</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt60"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>zoomTo: function(</td><td class=PParameter nowrap>zoom</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Zoom to a specific zoom level</div></div><div class=CToolTip id="tt61"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>zoomIn: function()</td></tr></table></blockquote></div></div><div class=CToolTip id="tt62"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>zoomOut: function()</td></tr></table></blockquote></div></div><div class=CToolTip id="tt63"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>zoomToExtent: function(</td><td class=PParameter nowrap>bounds,</td></tr><tr><td></td><td class=PParameter nowrap>closest</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Zoom to the passed in bounds, recenter</div></div><div class=CToolTip id="tt64"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>zoomToMaxExtent: function(</td><td class=PParameter nowrap>options</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Zoom to the full extent and recenter.</div></div><div class=CToolTip id="tt65"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>zoomToScale: function(</td><td class=PParameter nowrap>scale,</td></tr><tr><td></td><td class=PParameter nowrap>closest</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Zoom to a specified scale</div></div><div class=CToolTip id="tt66"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>getLonLatFromViewPortPx: function (</td><td class=PParameter nowrap>viewPortPx</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt67"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>getViewPortPxFromLonLat: function (</td><td class=PParameter nowrap>lonlat</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt68"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>getLonLatFromPixel: function (</td><td class=PParameter nowrap>px</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt69"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>getPixelFromLonLat: function (</td><td class=PParameter nowrap>lonlat</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Returns a pixel location given a map location. </div></div><div class=CToolTip id="tt70"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>getViewPortPxFromLayerPx:function(</td><td class=PParameter nowrap>layerPx</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt71"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>getLayerPxFromViewPortPx:function(</td><td class=PParameter nowrap>viewPortPx</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt72"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>getLonLatFromLayerPx: function (</td><td class=PParameter nowrap>px</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt73"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>getLayerPxFromLonLat: function (</td><td class=PParameter nowrap>lonlat</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt74"><div class=CConstructor>Constructor for a new OpenLayers.Map instance. </div></div><div class=CToolTip id="tt75"><div class=CClass>This class represents a screen coordinate, in x and y coordinates</div></div><div class=CToolTip id="tt76"><div class=CProperty>{Float} Default max is 360 deg / 256 px, which corresponds to zoom level 0 on gmaps. </div></div><div class=CToolTip id="tt77"><div class=CProperty>{OpenLayers.Bounds} The maximum extent for the map. </div></div><div class=CToolTip id="tt78"><div class=CClass>The navigation control handles map browsing with mouse events (dragging, double-clicking, and scrolling the wheel). </div></div><div class=CToolTip id="tt79"><div class=CClass>The PanZoom is a visible control, composed of a OpenLayers.Control.PanPanel and a OpenLayers.Control.ZoomPanel. </div></div><div class=CToolTip id="tt80"><div class=CClass>The ArgParser control adds location bar querystring parsing functionality to an OpenLayers Map. </div></div><div class=CToolTip id="tt81"><div class=CClass>The attribution control adds attribution from layers to the map display. </div></div><div class=CToolTip id="tt82"><div class=CProperty>{DOMElement|String} The element that contains the map (or an id for that element). </div></div><!--END_ND_TOOLTIPS-->
290
291
292
293
294 <div id=MSearchResultsWindow><iframe src="" frameborder=0 name=MSearchResults id=MSearchResults></iframe><a href="javascript:searchPanel.CloseResultsWindow()" id=MSearchResultsWindowClose>Close</a></div>
295
296
297 <script language=JavaScript><!--
298 if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>