ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Files
de8e596024898380a9a2ef3b928a09e9e4d57335
openlayers/files/OpenLayers/Layer-js.html
Tim Schaub de8e596024 natural documentation for a handful of classes 
git-svn-id: http://svn.openlayers.org/sandbox/tschaub/naturaldocs/doc@3373 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf
2007-06-20 20:33:15 +00:00

60 lines
16 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.Layer - 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('MGroupContent2')">OpenLayers</a><div class=MGroupContent id=MGroupContent2><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 id=MSelected>Layer</div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent1')">Layer</a><div class=MGroupContent id=MGroupContent1><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><a href="Map-js.html">Map</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent3')">Index</a><div class=MGroupContent id=MGroupContent3><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></div></div><!--END_ND_MENU--></td>
<td class=ContentSection valign=top><div class=CClass id=MainTopic><div class=CTopic><h1 class=CTitle><a name="OpenLayers.Layer"></a>OpenLayers.<span class=HB> </span>Layer</h1><div class=CBody><!--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.Layer" >OpenLayers.<span class=HB> </span>Layer</a></div></div></td><td class=SDescriptionSize><div class=SMain><div class=SDescription></div></div></td></tr><tr><td><div class=SGroup><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Layer.Properties" >Properties</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.Layer.gutter" >gutter</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{Integer} Determines the width (in pixels) of the gutter around image tiles to ignore. </div></div></div></td></tr><tr><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Layer.projection" >projection</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{String} Set in the layer options to override the default projection string this layer - also set maxExtent, maxResolution, and units if appropriate.</div></div></div></td></tr><tr class=SMarked><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Layer.units" >units</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{String} The layer map units. </div></div></div></td></tr><tr><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Layer.scales" >scales</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{Array}</div></div></div></td></tr><tr class=SMarked><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Layer.resolutions" >resolutions</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{Array}</div></div></div></td></tr><tr><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Layer.maxExtent" >maxExtent</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{OpenLayers.Bounds}</div></div></div></td></tr><tr class=SMarked><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Layer.minExtent" >minExtent</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{OpenLayers.Bounds}</div></div></div></td></tr><tr><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Layer.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 class=SMarked><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Layer.minResolution" >minResolution</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.Layer.numZoomLevels" >numZoomLevels</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{Integer}</div></div></div></td></tr><tr class=SMarked><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Layer.minScale" >minScale</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.Layer.maxScale" >maxScale</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.Layer.displayOutsideMaxExtent" >displayOutsideMaxExtent</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{Boolean} Request map tiles that are completely outside of the max extent for this layer. </div></div></div></td></tr><tr><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Layer.wrapDateLine" >wrapDateLine</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{Boolean} #487 for more info.</div></div></div></td></tr><tr><td><div class=SGroup><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Layer.Functions" >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=SFunction><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Layer.OpenLayers.Layer" >OpenLayers.<span class=HB> </span>Layer</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2></div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Layer.destroy" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">destroy</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>Destroy is a destructor: this is to alleviate cyclic references which the Javascript garbage cleaner can not take care of on its own.</div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Layer.clone" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">clone</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2></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.Layer.Properties"></a>Properties</h3></div></div>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.gutter"></a>gutter</h3><div class=CBody><p class=CParagraph>{Integer} Determines the width (in pixels) of the gutter around image tiles to ignore.&nbsp; By setting this property to a non-zero value, images will be requested that are wider and taller than the tile size by a value of 2 x gutter.&nbsp; This allows artifacts of rendering at tile edges to be ignored.&nbsp; Set a gutter value that is equal to half the size of the widest symbol that needs to be displayed.&nbsp; Defaults to zero.&nbsp; Non-tiled layers always have zero gutter.</p></div></div></div>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.projection"></a>projection</h3><div class=CBody><p class=CParagraph>{String} Set in the layer options to override the default projection string this layer - also set maxExtent, maxResolution, and units if appropriate.</p></div></div></div>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.units"></a>units</h3><div class=CBody><p class=CParagraph>{String} The layer 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.Layer.scales"></a>scales</h3><div class=CBody><p class=CParagraph>{Array}</p></div></div></div>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.resolutions"></a>resolutions</h3><div class=CBody><p class=CParagraph>{Array}</p></div></div></div>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.maxExtent"></a>maxExtent</h3><div class=CBody><p class=CParagraph>{OpenLayers.Bounds}</p></div></div></div>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.minExtent"></a>minExtent</h3><div class=CBody><p class=CParagraph>{OpenLayers.Bounds}</p></div></div></div>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.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 layer 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.Layer.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.Layer.numZoomLevels"></a>numZoomLevels</h3><div class=CBody><p class=CParagraph>{Integer}</p></div></div></div>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.minScale"></a>minScale</h3><div class=CBody><p class=CParagraph>{Number}</p></div></div></div>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.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.Layer.displayOutsideMaxExtent"></a>displayOutsideMaxExtent</h3><div class=CBody><p class=CParagraph>{Boolean} Request map tiles that are completely outside of the max extent for this layer.&nbsp; Defaults to false</p></div></div></div>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.wrapDateLine"></a>wrapDateLine</h3><div class=CBody><p class=CParagraph>{Boolean} #487 for more info.</p></div></div></div>
<div class=CGroup><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.Functions"></a>Functions</h3></div></div>
<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.OpenLayers.Layer"></a>OpenLayers.<span class=HB> </span>Layer</h3><div class=CBody><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>name</td><td class=CDLDescription>{String} The layer name</td></tr><tr><td class=CDLEntry>options</td><td class=CDLDescription>{Object} Hashtable of extra options to tag onto the layer</td></tr></table><h4 class=CHeading>Return</h4><p class=CParagraph>An instance of OpenLayers.Layer</p></div></div></div>
<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.destroy"></a>destroy</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>destroy: function(</td><td class=PParameter nowrap>setNewBaseLayer</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p class=CParagraph>Destroy is a destructor: this is to alleviate cyclic references which the Javascript garbage cleaner can not take care of on its own.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>setNewBaseLayer</td><td class=CDLDescription>{Boolean} Should a new baselayer be selected when this has been removed?&nbsp; Default is true.</td></tr></table></div></div></div>
<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.clone"></a>clone</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>clone: function (</td><td class=PParameter nowrap>obj</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>obj</td><td class=CDLDescription>{<a href="#OpenLayers.Layer.OpenLayers.Layer" class=LFunction >OpenLayers.Layer</a>} The layer to be cloned</td></tr></table><h4 class=CHeading>Return</h4><p class=CParagraph>{<a href="#OpenLayers.Layer.OpenLayers.Layer" class=LFunction >OpenLayers.Layer</a>} An exact clone of this OpenLayers.Layer</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=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>destroy: function(</td><td class=PParameter nowrap>setNewBaseLayer</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Destroy is a destructor: this is to alleviate cyclic references which the Javascript garbage cleaner can not take care of on its own.</div></div><div class=CToolTip id="tt2"><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>clone: function (</td><td class=PParameter nowrap>obj</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></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