09ea4c15ea
git-svn-id: http://svn.openlayers.org/sandbox/tschaub/naturaldocs/doc@3401 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf
47 lines
20 KiB
HTML
47 lines
20 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">
|
|
|
|
<html><head><title>OpenLayers.Tile.Image - 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><a href="../Map-js.html">Map</a></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="../Marker/Box-js.html">Marker.Box</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 id=MSelected>Image</div></div><div class=MEntry><div class=MFile><a href="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 != 4 && menu != 5 && menu != 3){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.Tile.Image"></a>OpenLayers.<span class=HB> </span>Tile.<span class=HB> </span>Image</h1><div class=CBody><p class=CParagraph>Instances of OpenLayers.Tile.Image are used to manage the image tiles used by various layers. Create a new image tile with the <a href="#OpenLayers.Tile.Image.OpenLayers.Tile.Image" class=LFunction id=link8 onMouseOver="ShowTip(event, 'tt1', 'link8')" onMouseOut="HideTip('tt1')">OpenLayers.Tile.Image</a> constructor. Inherits from <a href="../Tile-js.html#OpenLayers.Tile" class=LClass id=link9 onMouseOver="ShowTip(event, 'tt8', 'link9')" onMouseOut="HideTip('tt8')">OpenLayers.Tile</a>.</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.Tile.Image" >OpenLayers.<span class=HB> </span>Tile.<span class=HB> </span>Image</a></div></div></td><td class=SDescriptionSize><div class=SMain><div class=SDescription>Instances of OpenLayers.Tile.Image are used to manage the image tiles used by various layers. </div></div></td></tr><tr><td><div class=SGroup><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Tile.Image.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.Tile.Image.url" >url</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{String} The URL of the image being requested. </div></div></div></td></tr><tr><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Tile.Image.imgDiv" >imgDiv</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{DOMElement} The div element which wraps the image.</div></div></div></td></tr><tr class=SMarked><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Tile.Image.frame" >frame</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{DOMElement} The image element is appended to the frame. </div></div></div></td></tr><tr><td><div class=SGroup><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Tile.Image.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.Tile.Image.OpenLayers.Tile.Image" >OpenLayers.<span class=HB> </span>Tile.<span class=HB> </span>Image</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>Constructor for a new <a href="#OpenLayers.Tile.Image.OpenLayers.Tile.Image" class=LFunction id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">OpenLayers.Tile.Image</a> instance.</div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Tile.Image.destroy" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">destroy</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>nullify references to prevent circular references and memory leaks</div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Tile.Image.draw" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">draw</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>Check that a tile should be drawn, and draw it.</div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Tile.Image.clear" id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">clear</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>Clear the tile of any bounds/position-related data so that it can be reused in a new location.</div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Tile.Image.moveTo" id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')">moveTo</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>Reposition the tile.</div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Tile.Image.initImgDiv" id=link6 onMouseOver="ShowTip(event, 'tt6', 'link6')" onMouseOut="HideTip('tt6')">initImgDiv</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>Creates the imgDiv property on the tile.</div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Tile.Image.checkImgURL" id=link7 onMouseOver="ShowTip(event, 'tt7', 'link7')" onMouseOut="HideTip('tt7')">checkImgURL</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>Make sure that the image that just loaded is the one this tile is meant to display, since panning/zooming might have changed the tile’s URL in the meantime. </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.Tile.Image.Properties"></a>Properties</h3></div></div>
|
|
|
|
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Tile.Image.url"></a>url</h3><div class=CBody><p class=CParagraph>{String} The URL of the image being requested. No default. Filled in by layer.getURL() function.</p></div></div></div>
|
|
|
|
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Tile.Image.imgDiv"></a>imgDiv</h3><div class=CBody><p class=CParagraph>{DOMElement} The div element which wraps the image.</p></div></div></div>
|
|
|
|
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Tile.Image.frame"></a>frame</h3><div class=CBody><p class=CParagraph>{DOMElement} The image element is appended to the frame. Any gutter on the image will be hidden behind the frame.</p></div></div></div>
|
|
|
|
<div class=CGroup><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Tile.Image.Functions"></a>Functions</h3></div></div>
|
|
|
|
<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Tile.Image.OpenLayers.Tile.Image"></a>OpenLayers.<span class=HB> </span>Tile.<span class=HB> </span>Image</h3><div class=CBody><p class=CParagraph>Constructor for a new <a href="#OpenLayers.Tile.Image.OpenLayers.Tile.Image" class=LFunction id=link10 onMouseOver="ShowTip(event, 'tt1', 'link10')" onMouseOut="HideTip('tt1')">OpenLayers.Tile.Image</a> instance.</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>} layer that the tile will go in.</td></tr><tr><td class=CDLEntry>position</td><td class=CDLDescription>{<a href="../BaseTypes-js.html#OpenLayers.Pixel" class=LClass id=link11 onMouseOver="ShowTip(event, 'tt9', 'link11')" onMouseOut="HideTip('tt9')">OpenLayers.Pixel</a>}</td></tr><tr><td class=CDLEntry>bounds</td><td class=CDLDescription>{<a href="../BaseTypes-js.html#OpenLayers.Bounds" class=LClass id=link12 onMouseOver="ShowTip(event, 'tt10', 'link12')" onMouseOut="HideTip('tt10')">OpenLayers.Bounds</a>}</td></tr><tr><td class=CDLEntry>url</td><td class=CDLDescription>{<String>}</td></tr><tr><td class=CDLEntry>size</td><td class=CDLDescription>{<a href="../BaseTypes-js.html#OpenLayers.Size" class=LClass id=link13 onMouseOver="ShowTip(event, 'tt11', 'link13')" onMouseOut="HideTip('tt11')">OpenLayers.Size</a>}</td></tr></table></div></div></div>
|
|
|
|
<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Tile.Image.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>nullify references to prevent circular references and memory leaks</p></div></div></div>
|
|
|
|
<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Tile.Image.draw"></a>draw</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>draw:function()</td></tr></table></blockquote><p class=CParagraph>Check that a tile should be drawn, and draw it.</p><h4 class=CHeading>Return</h4><p class=CParagraph>{Boolean} Always returns true.</p></div></div></div>
|
|
|
|
<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Tile.Image.clear"></a>clear</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>clear: function()</td></tr></table></blockquote><p class=CParagraph>Clear the tile of any bounds/position-related data so that it can be reused in a new location.</p></div></div></div>
|
|
|
|
<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Tile.Image.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>bounds,</td></tr><tr><td></td><td class=PParameter nowrap>position,</td></tr><tr><td></td><td class=PParameter nowrap>redraw</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p class=CParagraph>Reposition the tile.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>bounds</td><td class=CDLDescription>{OpenLayers.Bounds}</td></tr><tr><td class=CDLEntry>position</td><td class=CDLDescription>{OpenLayers.pixel}</td></tr><tr><td class=CDLEntry>redraw</td><td class=CDLDescription>{Boolean} Call draw method on tile after moving? Default is true</td></tr></table></div></div></div>
|
|
|
|
<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Tile.Image.initImgDiv"></a>initImgDiv</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>initImgDiv: function()</td></tr></table></blockquote><p class=CParagraph>Creates the imgDiv property on the tile.</p></div></div></div>
|
|
|
|
<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Tile.Image.checkImgURL"></a>checkImgURL</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>checkImgURL: function ()</td></tr></table></blockquote><p class=CParagraph>Make sure that the image that just loaded is the one this tile is meant to display, since panning/zooming might have changed the tile’s URL in the meantime. If the tile URL did change before the image loaded, set the imgDiv display to ‘none’, as either (a) it will be reset to visible when the new URL loads in the image, or (b) we don’t want to display this tile after all because its new bounds are outside our maxExtent.</p><p class=CParagraph>This function should no longer be neccesary with the improvements to Grid.js in OpenLayers 2.3. The lack of a good isEquivilantURL function caused problems in 2.2, but it’s possible that with the improved isEquivilant URL function, this might be neccesary at some point.</p><p class=CParagraph>See discussion in the thread at <a href="http://openlayers.org/pipermail/dev/2007-January/000205.html" class=LURL>http://openlayers.org<span class=HB>- </span>/pipermail<span class=HB>- </span>/dev<span class=HB>- </span>/2007-January<span class=HB>- </span>/000205.html</a></p><p class=CParagraph>@private</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>Constructor for a new OpenLayers.Tile.Image instance.</div></div><div class=CToolTip id="tt2"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>destroy: function()</td></tr></table></blockquote>nullify references to prevent circular references and memory leaks</div></div><div class=CToolTip id="tt3"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>draw:function()</td></tr></table></blockquote>Check that a tile should be drawn, and draw it.</div></div><div class=CToolTip id="tt4"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>clear: function()</td></tr></table></blockquote>Clear the tile of any bounds/position-related data so that it can be reused in a new location.</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>moveTo: function (</td><td class=PParameter nowrap>bounds,</td></tr><tr><td></td><td class=PParameter nowrap>position,</td></tr><tr><td></td><td class=PParameter nowrap>redraw</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Reposition the tile.</div></div><div class=CToolTip id="tt6"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>initImgDiv: function()</td></tr></table></blockquote>Creates the imgDiv property on the tile.</div></div><div class=CToolTip id="tt7"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>checkImgURL: function ()</td></tr></table></blockquote>Make sure that the image that just loaded is the one this tile is meant to display, since panning/zooming might have changed the tile’s URL in the meantime. </div></div><div class=CToolTip id="tt8"><div class=CClass>This is a class designed to designate a single tile, however it is explicitly designed to do relatively little. </div></div><div class=CToolTip id="tt9"><div class=CClass>This class represents a screen coordinate, in x and y coordinates</div></div><div class=CToolTip id="tt10"><div class=CClass>Instances of this class represent bounding boxes. </div></div><div class=CToolTip id="tt11"><div class=CClass>Instances of this class represent a width/height pair</div></div><!--END_ND_TOOLTIPS-->
|
|
|
|
<script language=JavaScript><!--
|
|
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html> |