ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Files
72757614601f0a69749f67522d5db818d6fad34b
openlayers/files/OpenLayers/Map-js.html
crschmidt 7275761460 Regenerate docs again. looking almost real now. 
git-svn-id: http://svn.openlayers.org/sandbox/tschaub/naturaldocs/doc@3399 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf
2007-06-21 01:36:46 +00:00

103 lines
34 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">
<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></head><body class=UnframedPage onLoad="NDOnLoad()"><script language=JavaScript><!--
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
<!-- Generated by Natural Docs, version 1.35 -->
<!-- http://www.naturaldocs.org -->
<!-- saved from url=(0026)http://www.naturaldocs.org -->
<table border=0 cellspacing=0 cellpadding=0 width=100%><tr><td class=MenuSection valign=top><!--START_ND_MENU--><div class=MTitle>OpenLayers<div class=MSubTitle>JavaScript Mapping Library</div></div><div class=MEntry><div class=MFile><a href="../OpenLayers-js.html">OpenLayers</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent5')">OpenLayers</a><div class=MGroupContent id=MGroupContent5><div class=MEntry><div class=MFile><a href="BaseTypes-js.html">Base Types</a></div></div><div class=MEntry><div class=MFile><a href="Console-js.html">Console</a></div></div><div class=MEntry><div class=MFile><a href="Control-js.html">Control.js</a></div></div><div class=MEntry><div class=MFile><a href="Feature-js.html">Feature</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent1')">Feature</a><div class=MGroupContent id=MGroupContent1><div class=MEntry><div class=MFile><a href="Feature/WFS-js.html">WFS</a></div></div><div class=MEntry><div class=MFile><a href="Feature/Vector-js.html">Vector</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="Format-js.html">Format</a></div></div><div class=MEntry><div class=MFile><a href="Geometry-js.html">Geometry</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent2')">Geometry</a><div class=MGroupContent id=MGroupContent2><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/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/Point-js.html">Point</a></div></div><div class=MEntry><div class=MFile><a href="Geometry/Polygon-js.html">Polygon</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=MFile><a href="Layer-js.html">Layer</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent3')">Layer</a><div class=MGroupContent id=MGroupContent3><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/Vector-js.html">Vector</a></div></div><div class=MEntry><div class=MFile><a href="Layer/WMS-js.html">WMS</a></div></div></div></div></div><div class=MEntry><div class=MFile id=MSelected>Map</div></div><div class=MEntry><div class=MFile><a href="Marker-js.html">Marker</a></div></div><div class=MEntry><div class=MFile><a href="Popup-js.html">Popup</a></div></div><div class=MEntry><div class=MFile><a href="Tile-js.html">Tile</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent4')">Tile</a><div class=MGroupContent id=MGroupContent4><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></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent6')">Index</a><div class=MGroupContent id=MGroupContent6><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></div></div><script language=JavaScript><!--
if (document.getElementById){for (var menu = 1; menu < 7; menu++){if (menu != 5 && menu != 1){document.getElementById("MGroupContent" + menu).style.display = "none";};};}// --></script><!--END_ND_MENU--></td>
<td class=ContentSection valign=top><div class=CClass id=MainTopic><div class=CTopic><h1 class=CTitle><a name="OpenLayers.Map"></a>OpenLayers.Map</h1><div class=CBody><p class=CParagraph>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=LFunction id=link11 onMouseOver="ShowTip(event, 'tt8', 'link11')" onMouseOut="HideTip('tt8')">OpenLayers.Map</a> constructor.</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><td class=SEntrySize><div class=SMain><div class=SEntry><a href="#OpenLayers.Map" >OpenLayers.Map</a></div></div></td><td class=SDescriptionSize><div class=SMain><div class=SDescription>Instances of OpenLayers.Map are interactive maps embedded in a web page. </div></div></td></tr><tr><td><div class=SGroup><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Map.Constants" >Constants</a></div></div></div></td><td><div class=SGroup><div class=SDescription><div class=SIndent1></div></div></div></td></tr><tr class=SMarked><td><div class=SConstant><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Map.TILE_WIDTH" >TILE_WIDTH</a></div></div></div></td><td><div class=SConstant><div class=SDescription><div class=SIndent2>{Integer} 256</div></div></div></td></tr><tr><td><div class=SConstant><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Map.TILE_HEIGHT" >TILE_HEIGHT</a></div></div></div></td><td><div class=SConstant><div class=SDescription><div class=SIndent2>{Integer} 256</div></div></div></td></tr><tr class=SMarked><td><div class=SConstant><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Map.Z_INDEX_BASE" >Z_INDEX_BASE</a></div></div></div></td><td><div class=SConstant><div class=SDescription><div class=SIndent2>{Object} Base z-indexes for different classes of thing</div></div></div></td></tr><tr><td><div class=SConstant><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Map.EVENT_TYPES" >EVENT_TYPES</a></div></div></div></td><td><div class=SConstant><div class=SDescription><div class=SIndent2>{Array} supported application event types</div></div></div></td></tr><tr><td><div class=SGroup><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Map.Properties_and_Functions" >Properties and Functions</a></div></div></div></td><td><div class=SGroup><div class=SDescription><div class=SIndent1></div></div></div></td></tr><tr class=SMarked><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Map.id" >id</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{String} Unique identifier for the map</div></div></div></td></tr><tr><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Map.events" >events</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{&lt;OpenLayers.Events&gt;} An events object that handles all events on the map</div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Map.unloadDestroy" >unloadDestroy</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>Function that is called to destroy the map on page unload. </div></div></div></td></tr><tr><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Map.div" >div</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{DOMElement} The element that contains the map</div></div></div></td></tr><tr class=SMarked><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Map.size" >size</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{<a href="BaseTypes-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)</div></div></div></td></tr><tr><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Map.viewPortDiv" >viewPortDiv</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{HTMLDivElement} The element that represents the map viewport</div></div></div></td></tr><tr class=SMarked><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Map.layerContainerOrigin" >layerContainerOrigin</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{<a href="BaseTypes-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)</div></div></div></td></tr><tr><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Map.layerContainerDiv" >layerContainerDiv</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{HTMLDivElement} The element that contains the layers.</div></div></div></td></tr><tr class=SMarked><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Map.layers" >layers</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{Array(<a href="Layer-js.html#OpenLayers.Layer" class=LClass >OpenLayers.Layer</a>)} Ordered list of layers in the map</div></div></div></td></tr><tr><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Map.controls" >controls</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{Array(&lt;OpenLayers.Control&gt;)} List of controls associated with the map</div></div></div></td></tr><tr class=SMarked><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Map.popups" >popups</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{Array(<a href="Popup-js.html#OpenLayers.Popup" class=LClass >OpenLayers.Popup</a>)} List of popups associated with the map</div></div></div></td></tr><tr><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Map.baseLayer" >baseLayer</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2></div></div></div></td></tr><tr class=SMarked><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Map.center" >center</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{<a href="BaseTypes-js.html#OpenLayers.LonLat" class=LClass id=link3 onMouseOver="ShowTip(event, 'tt2', 'link3')" onMouseOut="HideTip('tt2')">OpenLayers.LonLat</a>} The current center of the map</div></div></div></td></tr><tr><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Map.zoom" >zoom</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{Integer} The current zoom level of the map</div></div></div></td></tr><tr class=SMarked><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Map.viewRequestID" >viewRequestID</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{String} Used to store a unique identifier that changes when the map view changes. </div></div></div></td></tr><tr><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Map.tileSize" >tileSize</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{<a href="BaseTypes-js.html#OpenLayers.Size" class=LClass id=link4 onMouseOver="ShowTip(event, 'tt1', 'link4')" onMouseOut="HideTip('tt1')">OpenLayers.Size</a>} Set in the map options to override the default tile size for this map.</div></div></div></td></tr><tr class=SMarked><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Map.projection" >projection</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{String} Set in the map options to override the default projection string this map - also set maxExtent, maxResolution, and units if appropriate.</div></div></div></td></tr><tr><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Map.units" >units</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{String} The map units. </div></div></div></td></tr><tr class=SMarked><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Map.maxResolution" >maxResolution</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{Number} Default max is 360 deg / 256 px, which corresponds to zoom level 0 on gmaps. </div></div></div></td></tr><tr><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Map.minResolution" >minResolution</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{Number}</div></div></div></td></tr><tr class=SMarked><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Map.maxScale" >maxScale</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{Number}</div></div></div></td></tr><tr><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Map.minScale" >minScale</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2></div></div></div></td></tr><tr class=SMarked><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Map.maxExtent" >maxExtent</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{<a href="BaseTypes-js.html#OpenLayers.Bounds" class=LClass id=link5 onMouseOver="ShowTip(event, 'tt3', 'link5')" onMouseOut="HideTip('tt3')">OpenLayers.Bounds</a>} The maximum extent for the map. </div></div></div></td></tr><tr><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Map.minExtent" >minExtent</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{<a href="BaseTypes-js.html#OpenLayers.Bounds" class=LClass id=link6 onMouseOver="ShowTip(event, 'tt3', 'link6')" onMouseOut="HideTip('tt3')">OpenLayers.Bounds</a>}</div></div></div></td></tr><tr class=SMarked><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Map.numZoomLevels" >numZoomLevels</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{Integer} Number of zoom levels for the map. </div></div></div></td></tr><tr><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Map.theme" >theme</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{String} Relative path to a CSS file from which to load theme styles. </div></div></div></td></tr><tr class=SMarked><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Map.fallThrough" >fallThrough</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{Boolean} Should OpenLayers allow events on the map to fall through to other elements on the page, or should it swallow them?&nbsp; </div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Map.OpenLayers.Map" >OpenLayers.Map</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>Constructor for a new OpenLayers.Map instance.</div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Map.destroy" id=link7 onMouseOver="ShowTip(event, 'tt4', 'link7')" onMouseOut="HideTip('tt4')">destroy</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>Destroy this map</div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Map.setOptions" id=link8 onMouseOver="ShowTip(event, 'tt5', 'link8')" onMouseOut="HideTip('tt5')">setOptions</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>Change the map options</div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Map.getTileSize" id=link9 onMouseOver="ShowTip(event, 'tt6', 'link9')" onMouseOut="HideTip('tt6')">getTileSize</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>Get the tile size for the map</div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Map.getLayer" id=link10 onMouseOver="ShowTip(event, 'tt7', 'link10')" onMouseOut="HideTip('tt7')">getLayer</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>Get a layer based on its id</div></div></div></td></tr><tr><td><div class=SGroup><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Map.Constants" >Constants</a></div></div></div></td><td><div class=SGroup><div class=SDescription><div class=SIndent1></div></div></div></td></tr><tr class=SMarked><td><div class=SConstant><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Map.CLASS_NAME" >CLASS_NAME</a></div></div></div></td><td><div class=SConstant><div class=SDescription><div class=SIndent2>{String} OpenLayers.Map</div></div></div></td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
<div class=CGroup><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.Constants"></a>Constants</h3></div></div>
<div class=CConstant><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.TILE_WIDTH"></a>TILE_WIDTH</h3><div class=CBody><p class=CParagraph>{Integer} 256</p></div></div></div>
<div class=CConstant><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.TILE_HEIGHT"></a>TILE_HEIGHT</h3><div class=CBody><p class=CParagraph>{Integer} 256</p></div></div></div>
<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 class=CParagraph>{Object} Base z-indexes for different classes of thing</p></div></div></div>
<div class=CConstant><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.EVENT_TYPES"></a>EVENT_TYPES</h3><div class=CBody><p class=CParagraph>{Array} supported application event types</p></div></div></div>
<div class=CGroup><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.Properties_and_Functions"></a>Properties and Functions</h3></div></div>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.id"></a>id</h3><div class=CBody><p class=CParagraph>{String} Unique identifier for the map</p></div></div></div>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.events"></a>events</h3><div class=CBody><p class=CParagraph>{&lt;OpenLayers.Events&gt;} An events object that handles all events on the map</p></div></div></div>
<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.unloadDestroy"></a>unloadDestroy</h3><div class=CBody><p class=CParagraph>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>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.div"></a>div</h3><div class=CBody><p class=CParagraph>{DOMElement} The element that contains the map</p></div></div></div>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.size"></a>size</h3><div class=CBody><p class=CParagraph>{<a href="BaseTypes-js.html#OpenLayers.Size" class=LClass id=link12 onMouseOver="ShowTip(event, 'tt1', 'link12')" onMouseOut="HideTip('tt1')">OpenLayers.Size</a>} Size of the main div (this.div)</p></div></div></div>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.viewPortDiv"></a>viewPortDiv</h3><div class=CBody><p class=CParagraph>{HTMLDivElement} The element that represents the map viewport</p></div></div></div>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.layerContainerOrigin"></a>layerContainerOrigin</h3><div class=CBody><p class=CParagraph>{<a href="BaseTypes-js.html#OpenLayers.LonLat" class=LClass id=link13 onMouseOver="ShowTip(event, 'tt2', 'link13')" onMouseOut="HideTip('tt2')">OpenLayers.LonLat</a>} The lonlat at which the later container was re-initialized (on-zoom)</p></div></div></div>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.layerContainerDiv"></a>layerContainerDiv</h3><div class=CBody><p class=CParagraph>{HTMLDivElement} The element that contains the layers.</p></div></div></div>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.layers"></a>layers</h3><div class=CBody><p class=CParagraph>{Array(<a href="Layer-js.html#OpenLayers.Layer" class=LClass >OpenLayers.Layer</a>)} Ordered list of layers in the map</p></div></div></div>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.controls"></a>controls</h3><div class=CBody><p class=CParagraph>{Array(&lt;OpenLayers.Control&gt;)} List of controls associated with the map</p></div></div></div>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.popups"></a>popups</h3><div class=CBody><p class=CParagraph>{Array(<a href="Popup-js.html#OpenLayers.Popup" class=LClass >OpenLayers.Popup</a>)} List of popups associated with the map</p></div></div></div>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.baseLayer"></a>baseLayer</h3><div class=CBody><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>{&lt;OpenLayers.Layer&gt;} The currently selected base layer</td><td class=CDLDescription>this determines min/max zoom level, projection, etc.</td></tr></table></div></div></div>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.center"></a>center</h3><div class=CBody><p class=CParagraph>{<a href="BaseTypes-js.html#OpenLayers.LonLat" class=LClass id=link14 onMouseOver="ShowTip(event, 'tt2', 'link14')" onMouseOut="HideTip('tt2')">OpenLayers.LonLat</a>} The current center of the map</p></div></div></div>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.zoom"></a>zoom</h3><div class=CBody><p class=CParagraph>{Integer} The current zoom level of the map</p></div></div></div>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.viewRequestID"></a>viewRequestID</h3><div class=CBody><p class=CParagraph>{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>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.tileSize"></a>tileSize</h3><div class=CBody><p class=CParagraph>{<a href="BaseTypes-js.html#OpenLayers.Size" class=LClass id=link15 onMouseOver="ShowTip(event, 'tt1', 'link15')" onMouseOut="HideTip('tt1')">OpenLayers.Size</a>} Set in the map options to override the default tile size for this map.</p></div></div></div>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.projection"></a>projection</h3><div class=CBody><p class=CParagraph>{String} Set in the map options to override the default projection string this map - also set maxExtent, maxResolution, and units if appropriate.</p></div></div></div>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.units"></a>units</h3><div class=CBody><p class=CParagraph>{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>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.maxResolution"></a>maxResolution</h3><div class=CBody><p class=CParagraph>{Number} 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>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.minResolution"></a>minResolution</h3><div class=CBody><p class=CParagraph>{Number}</p></div></div></div>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.maxScale"></a>maxScale</h3><div class=CBody><p class=CParagraph>{Number}</p></div></div></div>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.minScale"></a>minScale</h3></div></div>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.maxExtent"></a>maxExtent</h3><div class=CBody><p class=CParagraph>{<a href="BaseTypes-js.html#OpenLayers.Bounds" class=LClass id=link16 onMouseOver="ShowTip(event, 'tt3', 'link16')" onMouseOut="HideTip('tt3')">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>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.minExtent"></a>minExtent</h3><div class=CBody><p class=CParagraph>{<a href="BaseTypes-js.html#OpenLayers.Bounds" class=LClass id=link17 onMouseOver="ShowTip(event, 'tt3', 'link17')" onMouseOut="HideTip('tt3')">OpenLayers.Bounds</a>}</p></div></div></div>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.numZoomLevels"></a>numZoomLevels</h3><div class=CBody><p class=CParagraph>{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>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.theme"></a>theme</h3><div class=CBody><p class=CParagraph>{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>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.fallThrough"></a>fallThrough</h3><div class=CBody><p class=CParagraph>{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 swallow them.</p></div></div></div>
<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.OpenLayers.Map"></a>OpenLayers.Map</h3><div class=CBody><p class=CParagraph>Constructor for a new OpenLayers.Map instance.</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} The id of an element in your page that will contain the map</td></tr><tr><td class=CDLEntry>options</td><td class=CDLDescription>{Object} An optional object with properties to tag onto the map</td></tr></table><h4 class=CHeading>Examples</h4><blockquote><pre class=CCode>// create a map with default options in an element with the id &quot;map1&quot;<br>var map = new OpenLayers.Map(&quot;map1&quot;);<br><br>// create a map with non-default options in an element with id &quot;map2&quot;<br>var options = {<br> maxExtent: new OpenLayers.Bounds(-200000, -200000, 200000, 200000),<br> maxResolution: 156543,<br> units: 'meters',<br> projection: &quot;EPSG:41001&quot;<br>};<br>var map = new OpenLayers.Map(&quot;map2&quot;, options);</pre></blockquote><h4 class=CHeading>Return</h4><p class=CParagraph>A new OpenLayers.Map instance</p></div></div></div>
<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 class=CParagraph>Destroy this map</p></div></div></div>
<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 class=CParagraph>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>
<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 class=CParagraph>Get the tile size for the map</p><h4 class=CHeading>Return</h4><p class=CParagraph>{<a href="BaseTypes-js.html#OpenLayers.Size" class=LClass id=link18 onMouseOver="ShowTip(event, 'tt1', 'link18')" onMouseOut="HideTip('tt1')">OpenLayers.Size</a>}</p></div></div></div>
<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 class=CParagraph>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>Return</h4><p class=CParagraph>{<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>
<div class=CGroup><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.Constants"></a>Constants</h3></div></div>
<div class=CConstant><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Map.CLASS_NAME"></a>CLASS_NAME</h3><div class=CBody><p class=CParagraph>{String} OpenLayers.Map</p></div></div></div>
</td>
</tr></table><div class=Footer><!--START_ND_FOOTER-->Generated by <a href="http://www.naturaldocs.org">Natural Docs</a><!--END_ND_FOOTER--></div>
<!--START_ND_TOOLTIPS-->
<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>Instances of this class represent bounding boxes. </div></div><div class=CToolTip id="tt4"><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="tt5"><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="tt6"><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="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>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="tt8"><div class=CFunction>Constructor for a new OpenLayers.Map instance.</div></div><!--END_ND_TOOLTIPS-->
<script language=JavaScript><!--
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>
Reference in New Issue View Git Blame Copy Permalink