1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">
3 <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><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>
6 <!-- Generated by Natural Docs, version 1.4 -->
7 <!-- http://www.naturaldocs.org -->
9 <!-- saved from url=(0026)http://www.naturaldocs.org -->
14 <div id=Content><div class="CClass"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="OpenLayers.Layer"></a>OpenLayers.<wbr>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 class="SMain"><td class=SEntry><a href="#OpenLayers.Layer" >OpenLayers.<wbr>Layer</a></td><td class=SDescription></td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#OpenLayers.Layer.Properties" >Properties</a></td><td class=SDescription></td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Layer.id" >id</a></td><td class=SDescription>{String}</td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#OpenLayers.Layer.name" >name</a></td><td class=SDescription>{String}</td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Layer.div" >div</a></td><td class=SDescription>{DOMElement}</td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#OpenLayers.Layer.opacity" >opacity</a></td><td class=SDescription>{Float} The layer’s opacity. </td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Layer.alwaysInRange" >alwaysInRange</a></td><td class=SDescription>{Boolean} If a layer’s display should not be scale-based, this should be set to true. </td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#OpenLayers.Layer.Constants" >Constants</a></td><td class=SDescription></td></tr><tr class="SConstant SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Layer.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.Layer.Properties" >Properties</a></td><td class=SDescription></td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Layer.events" >events</a></td><td class=SDescription>{<a href="Events-js.html#OpenLayers.Events" class=LClass >OpenLayers.Events</a>}</td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#OpenLayers.Layer.map" >map</a></td><td class=SDescription>{<a href="Map-js.html#OpenLayers.Map" class=LClass id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">OpenLayers.Map</a>} This variable is set when the layer is added to the map, via the accessor function setMap().</td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Layer.isBaseLayer" >isBaseLayer</a></td><td class=SDescription>{Boolean} Whether or not the layer is a base layer. </td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#OpenLayers.Layer.alpha" >alpha</a></td><td class=SDescription>{Boolean} The layer’s images have an alpha channel. </td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Layer.displayInLayerSwitcher" >displayInLayerSwitcher</a></td><td class=SDescription>{Boolean} Display the layer’s name in the layer switcher. </td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#OpenLayers.Layer.visibility" >visibility</a></td><td class=SDescription>{Boolean} The layer should be displayed in the map. </td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Layer.attribution" >attribution</a></td><td class=SDescription>{String} Attribution string, displayed when an <a href="Control/Attribution-js.html#OpenLayers.Control.Attribution" class=LClass id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">OpenLayers.Control.Attribution</a> has been added to the map.</td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#OpenLayers.Layer.inRange" >inRange</a></td><td class=SDescription>{Boolean} The current map resolution is within the layer’s min/max range. </td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Layer.imageOffset" >imageOffset</a></td><td class=SDescription>{<a href="BaseTypes/Pixel-js.html#OpenLayers.Pixel" class=LClass id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">OpenLayers.Pixel</a>} For layers with a gutter, the image offset represents displacement due to the gutter.</td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#OpenLayers.Layer.options" >options</a></td><td class=SDescription>{Object} An optional object whose properties will be set on the layer. </td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Layer.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=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">OpenLayers.Events.on</a>. </td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#OpenLayers.Layer.gutter" >gutter</a></td><td class=SDescription>{Integer} Determines the width (in pixels) of the gutter around image tiles to ignore. </td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Layer.projection" >projection</a></td><td class=SDescription>{<a href="Projection-js.html#OpenLayers.Projection" class=LClass id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')">OpenLayers.Projection</a>} or {<a href="BaseTypes-js.html#OpenLayers.String" class=LClass id=link6 onMouseOver="ShowTip(event, 'tt6', 'link6')" onMouseOut="HideTip('tt6')">String</a>} Set in the layer options to override the default projection string this layer - also set maxExtent, maxResolution, and units if appropriate. </td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#OpenLayers.Layer.units" >units</a></td><td class=SDescription>{String} The layer map units. </td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Layer.scales" >scales</a></td><td class=SDescription>{Array} An array of map scales in descending order. </td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#OpenLayers.Layer.resolutions" >resolutions</a></td><td class=SDescription>{Array} A list of map resolutions (map units per pixel) in descending order. </td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Layer.maxExtent" >maxExtent</a></td><td class=SDescription>{<a href="BaseTypes/Bounds-js.html#OpenLayers.Bounds" class=LClass id=link7 onMouseOver="ShowTip(event, 'tt7', 'link7')" onMouseOut="HideTip('tt7')">OpenLayers.Bounds</a>} The center of these bounds will not stray outside of the viewport extent during panning. </td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#OpenLayers.Layer.minExtent" >minExtent</a></td><td class=SDescription>{<a href="BaseTypes/Bounds-js.html#OpenLayers.Bounds" class=LClass id=link8 onMouseOver="ShowTip(event, 'tt7', 'link8')" onMouseOut="HideTip('tt7')">OpenLayers.Bounds</a>}</td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Layer.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"><td class=SEntry><a href="#OpenLayers.Layer.minResolution" >minResolution</a></td><td class=SDescription>{Float}</td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Layer.numZoomLevels" >numZoomLevels</a></td><td class=SDescription>{Integer}</td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#OpenLayers.Layer.minScale" >minScale</a></td><td class=SDescription>{Float}</td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Layer.maxScale" >maxScale</a></td><td class=SDescription>{Float}</td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#OpenLayers.Layer.displayOutsideMaxExtent" >displayOutsideMaxExtent</a></td><td class=SDescription>{Boolean} Request map tiles that are completely outside of the max extent for this layer. </td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Layer.wrapDateLine" >wrapDateLine</a></td><td class=SDescription>{Boolean} #487 for more info.</td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#OpenLayers.Layer.transitionEffect" >transitionEffect</a></td><td class=SDescription>{String} The transition effect to use when the map is panned or zoomed.</td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Layer.SUPPORTED_TRANSITIONS" >SUPPORTED_TRANSITIONS</a></td><td class=SDescription>{Array} An immutable (that means don’t change it!)</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#OpenLayers.Layer.Constructor" >Constructor</a></td><td class=SDescription></td></tr><tr class="SConstructor SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Layer.OpenLayers.Layer" >OpenLayers.<wbr>Layer</a></td><td class=SDescription></td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#OpenLayers.Layer.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Layer.destroy" id=link9 onMouseOver="ShowTip(event, 'tt8', 'link9')" onMouseOut="HideTip('tt8')">destroy</a></td><td class=SDescription>Destroy is a destructor: this is to alleviate cyclic references which the Javascript garbage cleaner can not take care of on its own.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Layer.clone" id=link10 onMouseOver="ShowTip(event, 'tt9', 'link10')" onMouseOut="HideTip('tt9')">clone</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Layer.setName" id=link11 onMouseOver="ShowTip(event, 'tt10', 'link11')" onMouseOut="HideTip('tt10')">setName</a></td><td class=SDescription>Sets the new layer name for this layer. </td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Layer.addOptions" id=link12 onMouseOver="ShowTip(event, 'tt11', 'link12')" onMouseOut="HideTip('tt11')">addOptions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Layer.onMapResize" id=link13 onMouseOver="ShowTip(event, 'tt12', 'link13')" onMouseOut="HideTip('tt12')">onMapResize</a></td><td class=SDescription>This function can be implemented by subclasses</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Layer.redraw" id=link14 onMouseOver="ShowTip(event, 'tt13', 'link14')" onMouseOut="HideTip('tt13')">redraw</a></td><td class=SDescription>Redraws the layer. </td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Layer.moveTo" id=link15 onMouseOver="ShowTip(event, 'tt14', 'link15')" onMouseOut="HideTip('tt14')">moveTo</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Layer.setMap" id=link16 onMouseOver="ShowTip(event, 'tt15', 'link16')" onMouseOut="HideTip('tt15')">setMap</a></td><td class=SDescription>Set the map property for the layer. </td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Layer.afterAdd" id=link17 onMouseOver="ShowTip(event, 'tt16', 'link17')" onMouseOut="HideTip('tt16')">afterAdd</a></td><td class=SDescription>Called at the end of the map.addLayer sequence. </td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Layer.removeMap" id=link18 onMouseOver="ShowTip(event, 'tt17', 'link18')" onMouseOut="HideTip('tt17')">removeMap</a></td><td class=SDescription>Just as setMap() allows each layer the possibility to take a personalized action on being added to the map, removeMap() allows each layer to take a personalized action on being removed from it. </td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Layer.getImageSize" id=link19 onMouseOver="ShowTip(event, 'tt18', 'link19')" onMouseOut="HideTip('tt18')">getImageSize</a></td><td class=SDescription>{<a href="BaseTypes/Size-js.html#OpenLayers.Size" class=LClass id=link20 onMouseOver="ShowTip(event, 'tt19', 'link20')" onMouseOut="HideTip('tt19')">OpenLayers.Size</a>} The size that the image should be, taking into account gutters.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Layer.setTileSize" id=link21 onMouseOver="ShowTip(event, 'tt20', 'link21')" onMouseOut="HideTip('tt20')">setTileSize</a></td><td class=SDescription>Set the tile size based on the map size. </td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Layer.getVisibility" id=link22 onMouseOver="ShowTip(event, 'tt21', 'link22')" onMouseOut="HideTip('tt21')">getVisibility</a></td><td class=SDescription>{Boolean} The layer should be displayed (if in range).</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Layer.setVisibility" id=link23 onMouseOver="ShowTip(event, 'tt22', 'link23')" onMouseOut="HideTip('tt22')">setVisibility</a></td><td class=SDescription>Set the visibility flag for the layer and hide/show & redraw accordingly. </td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Layer.display" id=link24 onMouseOver="ShowTip(event, 'tt23', 'link24')" onMouseOut="HideTip('tt23')">display</a></td><td class=SDescription>Hide or show the Layer</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Layer.calculateInRange" id=link25 onMouseOver="ShowTip(event, 'tt24', 'link25')" onMouseOut="HideTip('tt24')">calculateInRange</a></td><td class=SDescription>{Boolean} The layer is displayable at the current map’s current resolution. </td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Layer.setIsBaseLayer" id=link26 onMouseOver="ShowTip(event, 'tt25', 'link26')" onMouseOut="HideTip('tt25')">setIsBaseLayer</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Layer.initResolutions" id=link27 onMouseOver="ShowTip(event, 'tt26', 'link27')" onMouseOut="HideTip('tt26')">initResolutions</a></td><td class=SDescription>This method’s responsibility is to set up the ‘resolutions’ array for the layer -- this array is what the layer will use to interface between the zoom levels of the map and the resolution display of the layer.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Layer.getResolution" id=link28 onMouseOver="ShowTip(event, 'tt27', 'link28')" onMouseOut="HideTip('tt27')">getResolution</a></td><td class=SDescription>{Float} The currently selected resolution of the map, taken from the resolutions array, indexed by current zoom level.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Layer.getExtent" id=link29 onMouseOver="ShowTip(event, 'tt28', 'link29')" onMouseOut="HideTip('tt28')">getExtent</a></td><td class=SDescription>{<a href="BaseTypes/Bounds-js.html#OpenLayers.Bounds" class=LClass id=link30 onMouseOver="ShowTip(event, 'tt7', 'link30')" onMouseOut="HideTip('tt7')">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.Layer.getZoomForExtent" id=link31 onMouseOver="ShowTip(event, 'tt29', 'link31')" onMouseOut="HideTip('tt29')">getZoomForExtent</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Layer.getDataExtent" id=link32 onMouseOver="ShowTip(event, 'tt30', 'link32')" onMouseOut="HideTip('tt30')">getDataExtent</a></td><td class=SDescription>Calculates the max extent which includes all of the data for the layer. </td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Layer.getResolutionForZoom" id=link33 onMouseOver="ShowTip(event, 'tt31', 'link33')" onMouseOut="HideTip('tt31')">getResolutionForZoom</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Layer.getZoomForResolution" id=link34 onMouseOver="ShowTip(event, 'tt32', 'link34')" onMouseOut="HideTip('tt32')">getZoomForResolution</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Layer.getLonLatFromViewPortPx" id=link35 onMouseOver="ShowTip(event, 'tt33', 'link35')" onMouseOut="HideTip('tt33')">getLonLatFromViewPortPx</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Layer.getViewPortPxFromLonLat" id=link36 onMouseOver="ShowTip(event, 'tt34', 'link36')" onMouseOut="HideTip('tt34')">getViewPortPxFromLonLat</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.Layer.setOpacity" id=link37 onMouseOver="ShowTip(event, 'tt35', 'link37')" onMouseOut="HideTip('tt35')">setOpacity</a></td><td class=SDescription>Sets the opacity for the entire layer (all images)</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Layer.getZIndex" id=link38 onMouseOver="ShowTip(event, 'tt36', 'link38')" onMouseOut="HideTip('tt36')">getZIndex</a></td><td class=SDescription>{Integer} the z-index of this layer</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Layer.setZIndex" id=link39 onMouseOver="ShowTip(event, 'tt37', 'link39')" onMouseOut="HideTip('tt37')">setZIndex</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Layer.adjustBounds" id=link40 onMouseOver="ShowTip(event, 'tt38', 'link40')" onMouseOut="HideTip('tt38')">adjustBounds</a></td><td class=SDescription>This function will take a bounds, and if wrapDateLine option is set on the layer, it will return a bounds which is wrapped around the world. </td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
16 <div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.Properties"></a>Properties</h3></div></div>
18 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.id"></a>id</h3><div class=CBody><p>{String}</p></div></div></div>
20 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.name"></a>name</h3><div class=CBody><p>{String}</p></div></div></div>
22 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.div"></a>div</h3><div class=CBody><p>{DOMElement}</p></div></div></div>
24 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.opacity"></a>opacity</h3><div class=CBody><p>{Float} The layer’s opacity. Float number between 0.0 and 1.0.</p></div></div></div>
26 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.alwaysInRange"></a>alwaysInRange</h3><div class=CBody><p>{Boolean} If a layer’s display should not be scale-based, this should be set to true. This will cause the layer, as an overlay, to always be ‘active’, by always returning true from the calculateInRange() function.</p><p>If not explicitly specified for a layer, its value will be determined on startup in initResolutions() based on whether or not any scale-specific properties have been set as options on the layer. If no scale-specific options have been set on the layer, we assume that it should always be in range.</p><p>See #987 for more info.</p></div></div></div>
28 <div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.Constants"></a>Constants</h3></div></div>
30 <div class="CConstant"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.EVENT_TYPES"></a>EVENT_TYPES</h3><div class=CBody><p>{Array(String)} Supported application event types. Register a listener for a particular event with the following syntax:</p><blockquote><pre>layer.events.register(type, obj, listener);</pre></blockquote><p>Listeners will be called with a reference to an event object. The properties of this event depends on exactly what happened.</p><h4 class=CHeading>All event objects have at least the following properties</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>object</td><td class=CDLDescription>{Object} A reference to layer.events.object.</td></tr><tr><td class=CDLEntry>element</td><td class=CDLDescription>{DOMElement} A reference to layer.events.element.</td></tr></table><h4 class=CHeading>Supported map event types</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>loadstart</td><td class=CDLDescription>Triggered when layer loading starts.</td></tr><tr><td class=CDLEntry>loadend</td><td class=CDLDescription>Triggered when layer loading ends.</td></tr><tr><td class=CDLEntry>loadcancel</td><td class=CDLDescription>Triggered when layer loading is canceled.</td></tr><tr><td class=CDLEntry>visibilitychanged</td><td class=CDLDescription>Triggered when layer visibility is changed.</td></tr><tr><td class=CDLEntry>move</td><td class=CDLDescription>Triggered when layer moves (triggered with every mousemove during a drag).</td></tr><tr><td class=CDLEntry>moveend</td><td class=CDLDescription>Triggered when layer is done moving, object passed as argument has a zoomChanged boolean property which tells that the zoom has changed.</td></tr></table></div></div></div>
32 <div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.Properties"></a>Properties</h3></div></div>
34 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.events"></a>events</h3><div class=CBody><p>{<a href="Events-js.html#OpenLayers.Events" class=LClass >OpenLayers.Events</a>}</p></div></div></div>
36 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.map"></a>map</h3><div class=CBody><p>{<a href="Map-js.html#OpenLayers.Map" class=LClass id=link41 onMouseOver="ShowTip(event, 'tt1', 'link41')" onMouseOut="HideTip('tt1')">OpenLayers.Map</a>} This variable is set when the layer is added to the map, via the accessor function setMap().</p></div></div></div>
38 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.isBaseLayer"></a>isBaseLayer</h3><div class=CBody><p>{Boolean} Whether or not the layer is a base layer. This should be set individually by all subclasses. Default is false</p></div></div></div>
40 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.alpha"></a>alpha</h3><div class=CBody><p>{Boolean} The layer’s images have an alpha channel. Default is false.</p></div></div></div>
42 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.displayInLayerSwitcher"></a>displayInLayerSwitcher</h3><div class=CBody><p>{Boolean} Display the layer’s name in the layer switcher. Default is true.</p></div></div></div>
44 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.visibility"></a>visibility</h3><div class=CBody><p>{Boolean} The layer should be displayed in the map. Default is true.</p></div></div></div>
46 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.attribution"></a>attribution</h3><div class=CBody><p>{String} Attribution string, displayed when an <a href="Control/Attribution-js.html#OpenLayers.Control.Attribution" class=LClass id=link42 onMouseOver="ShowTip(event, 'tt2', 'link42')" onMouseOut="HideTip('tt2')">OpenLayers.Control.Attribution</a> has been added to the map.</p></div></div></div>
48 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.inRange"></a>inRange</h3><div class=CBody><p>{Boolean} The current map resolution is within the layer’s min/max range. This is set in <a href="Map-js.html#OpenLayers.Map.setCenter" class=LFunction id=link43 onMouseOver="ShowTip(event, 'tt39', 'link43')" onMouseOut="HideTip('tt39')">OpenLayers.Map.setCenter</a> whenever the zoom changes.</p></div></div></div>
50 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.imageOffset"></a>imageOffset</h3><div class=CBody><p>{<a href="BaseTypes/Pixel-js.html#OpenLayers.Pixel" class=LClass id=link44 onMouseOver="ShowTip(event, 'tt3', 'link44')" onMouseOut="HideTip('tt3')">OpenLayers.Pixel</a>} For layers with a gutter, the image offset represents displacement due to the gutter.</p></div></div></div>
52 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.options"></a>options</h3><div class=CBody><p>{Object} An optional object whose properties will be set on the layer. Any of the layer properties can be set as a property of the options object and sent to the constructor when the layer is created.</p></div></div></div>
54 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.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=link45 onMouseOver="ShowTip(event, 'tt4', 'link45')" onMouseOut="HideTip('tt4')">OpenLayers.Events.on</a>. Object structure must be a listeners object as shown in the example for the events.on method.</p></div></div></div>
56 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.gutter"></a>gutter</h3><div class=CBody><p>{Integer} Determines the width (in pixels) of the gutter around image tiles to ignore. 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. This allows artifacts of rendering at tile edges to be ignored. Set a gutter value that is equal to half the size of the widest symbol that needs to be displayed. Defaults to zero. Non-tiled layers always have zero gutter.</p></div></div></div>
58 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.projection"></a>projection</h3><div class=CBody><p>{<a href="Projection-js.html#OpenLayers.Projection" class=LClass id=link46 onMouseOver="ShowTip(event, 'tt5', 'link46')" onMouseOut="HideTip('tt5')">OpenLayers.Projection</a>} or {<a href="BaseTypes-js.html#OpenLayers.String" class=LClass id=link47 onMouseOver="ShowTip(event, 'tt6', 'link47')" onMouseOut="HideTip('tt6')">String</a>} Set in the layer options to override the default projection string this layer - also set maxExtent, maxResolution, and units if appropriate. Can be either a string or an <a href="Projection-js.html#OpenLayers.Projection" class=LClass id=link48 onMouseOver="ShowTip(event, 'tt5', 'link48')" onMouseOut="HideTip('tt5')">OpenLayers.Projection</a> object when created -- will be converted to an object when setMap is called if a string is passed.</p></div></div></div>
60 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.units"></a>units</h3><div class=CBody><p>{String} The layer map units. Defaults to ‘degrees’. Possible values are ‘degrees’ (or ‘dd’), ‘m’, ‘ft’, ‘km’, ‘mi’, ‘inches’.</p></div></div></div>
62 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.scales"></a>scales</h3><div class=CBody><p>{Array} An array of map scales in descending order. The values in the array correspond to the map scale denominator. Note that these values only make sense if the display (monitor) resolution of the client is correctly guessed by whomever is configuring the application. In addition, the units property must also be set. Use <a href="#OpenLayers.Layer.resolutions" class=LProperty id=link49 onMouseOver="ShowTip(event, 'tt40', 'link49')" onMouseOut="HideTip('tt40')">resolutions</a> instead wherever possible.</p></div></div></div>
64 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.resolutions"></a>resolutions</h3><div class=CBody><p>{Array} A list of map resolutions (map units per pixel) in descending order. 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>
66 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.maxExtent"></a>maxExtent</h3><div class=CBody><p>{<a href="BaseTypes/Bounds-js.html#OpenLayers.Bounds" class=LClass id=link50 onMouseOver="ShowTip(event, 'tt7', 'link50')" onMouseOut="HideTip('tt7')">OpenLayers.Bounds</a>} The center of these bounds will not stray outside of the viewport extent during panning. In addition, if <a href="#OpenLayers.Layer.displayOutsideMaxExtent" class=LProperty id=link51 onMouseOver="ShowTip(event, 'tt41', 'link51')" onMouseOut="HideTip('tt41')">displayOutsideMaxExtent</a> is set to false, data will not be requested that falls completely outside of these bounds.</p></div></div></div>
68 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.minExtent"></a>minExtent</h3><div class=CBody><p>{<a href="BaseTypes/Bounds-js.html#OpenLayers.Bounds" class=LClass id=link52 onMouseOver="ShowTip(event, 'tt7', 'link52')" onMouseOut="HideTip('tt7')">OpenLayers.Bounds</a>}</p></div></div></div>
70 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.maxResolution"></a>maxResolution</h3><div class=CBody><p>{Float} Default max is 360 deg / 256 px, which corresponds to zoom level 0 on gmaps. 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>
72 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.minResolution"></a>minResolution</h3><div class=CBody><p>{Float}</p></div></div></div>
74 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.numZoomLevels"></a>numZoomLevels</h3><div class=CBody><p>{Integer}</p></div></div></div>
76 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.minScale"></a>minScale</h3><div class=CBody><p>{Float}</p></div></div></div>
78 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.maxScale"></a>maxScale</h3><div class=CBody><p>{Float}</p></div></div></div>
80 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.displayOutsideMaxExtent"></a>displayOutsideMaxExtent</h3><div class=CBody><p>{Boolean} Request map tiles that are completely outside of the max extent for this layer. Defaults to false.</p></div></div></div>
82 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.wrapDateLine"></a>wrapDateLine</h3><div class=CBody><p>{Boolean} #487 for more info.</p></div></div></div>
84 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.transitionEffect"></a>transitionEffect</h3><div class=CBody><p>{String} The transition effect to use when the map is panned or zoomed.</p><h4 class=CHeading>There are currently two supported values</h4><ul><li><b>null</b> No transition effect (the default).</li><li><b>resize</b> Existing tiles are resized on zoom to provide a visual effect of the zoom having taken place immediately. As the new tiles become available, they are drawn over top of the resized tiles.</li></ul></div></div></div>
86 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.SUPPORTED_TRANSITIONS"></a>SUPPORTED_TRANSITIONS</h3><div class=CBody><p>{Array} An immutable (that means don’t change it!) list of supported transitionEffect values.</p></div></div></div>
88 <div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.Constructor"></a>Constructor</h3></div></div>
90 <div class="CConstructor"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.OpenLayers.Layer"></a>OpenLayers.<wbr>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></div></div></div>
92 <div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.Functions"></a>Functions</h3></div></div>
94 <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>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} Set a new base layer when this layer has been destroyed. Default is true.</td></tr></table></div></div></div>
96 <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=LConstructor >OpenLayers.Layer</a>} The layer to be cloned</td></tr></table><h4 class=CHeading>Returns</h4><p>{<a href="#OpenLayers.Layer.OpenLayers.Layer" class=LConstructor >OpenLayers.Layer</a>} An exact clone of this <a href="#OpenLayers.Layer.OpenLayers.Layer" class=LConstructor >OpenLayers.Layer</a></p></div></div></div>
98 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.setName"></a>setName</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>setName: function(</td><td class=PParameter nowrap>newName</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the new layer name for this layer. Can trigger a changelayer event on the map.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>newName</td><td class=CDLDescription>{String} The new name.</td></tr></table></div></div></div>
100 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.addOptions"></a>addOptions</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>addOptions: function (</td><td class=PParameter nowrap>newOptions</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>newOptions</td><td class=CDLDescription>{Object}</td></tr></table></div></div></div>
102 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.onMapResize"></a>onMapResize</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>onMapResize: function()</td></tr></table></blockquote><p>This function can be implemented by subclasses</p></div></div></div>
104 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.redraw"></a>redraw</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>redraw: function()</td></tr></table></blockquote><p>Redraws the layer. Returns true if the layer was redrawn, false if not.</p><h4 class=CHeading>Returns</h4><p>{Boolean} The layer was redrawn.</p></div></div></div>
106 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.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>zoomChanged,</td></tr><tr><td></td><td class=PParameter nowrap>dragging</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>bound</td><td class=CDLDescription>{<a href="BaseTypes/Bounds-js.html#OpenLayers.Bounds" class=LClass id=link53 onMouseOver="ShowTip(event, 'tt7', 'link53')" onMouseOut="HideTip('tt7')">OpenLayers.Bounds</a>}</td></tr><tr><td class=CDLEntry>zoomChanged</td><td class=CDLDescription>{Boolean} Tells when zoom has changed, as layers have to do some init work in that case.</td></tr><tr><td class=CDLEntry>dragging</td><td class=CDLDescription>{Boolean}</td></tr></table></div></div></div>
108 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.setMap"></a>setMap</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>setMap: function(</td><td class=PParameter nowrap>map</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Set the map property for the layer. This is done through an accessor so that subclasses can override this and take special action once they have their map variable set.</p><p>Here we take care to bring over any of the necessary default properties from the map.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>map</td><td class=CDLDescription>{<a href="Map-js.html#OpenLayers.Map" class=LClass id=link54 onMouseOver="ShowTip(event, 'tt1', 'link54')" onMouseOut="HideTip('tt1')">OpenLayers.Map</a>}</td></tr></table></div></div></div>
110 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.afterAdd"></a>afterAdd</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>afterAdd: function()</td></tr></table></blockquote><p>Called at the end of the map.addLayer sequence. At this point, the map will have a base layer. To be overridden by subclasses.</p></div></div></div>
112 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.removeMap"></a>removeMap</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>removeMap: function(</td><td class=PParameter nowrap>map</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Just as setMap() allows each layer the possibility to take a personalized action on being added to the map, removeMap() allows each layer to take a personalized action on being removed from it. For now, this will be mostly unused, except for the EventPane layer, which needs this hook so that it can remove the special invisible pane.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>map</td><td class=CDLDescription>{<a href="Map-js.html#OpenLayers.Map" class=LClass id=link55 onMouseOver="ShowTip(event, 'tt1', 'link55')" onMouseOut="HideTip('tt1')">OpenLayers.Map</a>}</td></tr></table></div></div></div>
114 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.getImageSize"></a>getImageSize</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getImageSize: function()</td></tr></table></blockquote><h4 class=CHeading>Returns</h4><p>{<a href="BaseTypes/Size-js.html#OpenLayers.Size" class=LClass id=link56 onMouseOver="ShowTip(event, 'tt19', 'link56')" onMouseOut="HideTip('tt19')">OpenLayers.Size</a>} The size that the image should be, taking into account gutters.</p></div></div></div>
116 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.setTileSize"></a>setTileSize</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>setTileSize: function(</td><td class=PParameter nowrap>size</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Set the tile size based on the map size. This also sets layer.imageSize and layer.imageOffset for use by Tile.Image.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>size</td><td class=CDLDescription>{<a href="BaseTypes/Size-js.html#OpenLayers.Size" class=LClass id=link57 onMouseOver="ShowTip(event, 'tt19', 'link57')" onMouseOut="HideTip('tt19')">OpenLayers.Size</a>}</td></tr></table></div></div></div>
118 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.getVisibility"></a>getVisibility</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getVisibility: function()</td></tr></table></blockquote><h4 class=CHeading>Returns</h4><p>{Boolean} The layer should be displayed (if in range).</p></div></div></div>
120 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.setVisibility"></a>setVisibility</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>setVisibility: function(</td><td class=PParameter nowrap>visibility</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Set the visibility flag for the layer and hide/show & redraw accordingly. Fire event unless otherwise specified</p><p>Note that visibility is no longer simply whether or not the layer’s style.display is set to “block”. Now we store a ‘visibility’ state property on the layer class, this allows us to remember whether or not we <b>desire</b> for a layer to be visible. In the case where the map’s resolution is out of the layer’s range, this desire may be subverted.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>visible</td><td class=CDLDescription>{Boolean} Whether or not to display the layer (if in range)</td></tr></table></div></div></div>
122 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.display"></a>display</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>display: function(</td><td class=PParameter nowrap>display</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Hide or show the Layer</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>display</td><td class=CDLDescription>{Boolean}</td></tr></table></div></div></div>
124 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.calculateInRange"></a>calculateInRange</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>calculateInRange: function()</td></tr></table></blockquote><h4 class=CHeading>Returns</h4><p>{Boolean} The layer is displayable at the current map’s current resolution. Note that if ‘alwaysInRange’ is true for the layer, this function will always return true.</p></div></div></div>
126 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.setIsBaseLayer"></a>setIsBaseLayer</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>setIsBaseLayer: function(</td><td class=PParameter nowrap>isBaseLayer</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>isBaseLayer</td><td class=CDLDescription>{Boolean}</td></tr></table></div></div></div>
128 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.initResolutions"></a>initResolutions</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>initResolutions: function()</td></tr></table></blockquote><p>This method’s responsibility is to set up the ‘resolutions’ array for the layer -- this array is what the layer will use to interface between the zoom levels of the map and the resolution display of the layer.</p><p>The user has several options that determine how the array is set up.</p><p>For a detailed explanation, see the following wiki from the openlayers.org homepage: <a href="http://trac.openlayers.org/wiki/SettingZoomLevels" class=LURL target=_top>http://trac.openlayers.org/wiki/SettingZoomLevels</a></p></div></div></div>
130 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.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 currently selected resolution of the map, taken from the resolutions array, indexed by current zoom level.</p></div></div></div>
132 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.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=link58 onMouseOver="ShowTip(event, 'tt7', 'link58')" onMouseOut="HideTip('tt7')">OpenLayers.Bounds</a>} A Bounds object which represents the lon/lat bounds of the current viewPort.</p></div></div></div>
134 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.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>extent,</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=link59 onMouseOver="ShowTip(event, 'tt7', 'link59')" onMouseOut="HideTip('tt7')">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. Note that this may result in a zoom that does not exactly contain the entire extent. Default is false.</td></tr></table><h4 class=CHeading>Returns</h4><p>{Integer} The index of the zoomLevel (entry in the resolutions array) for the passed-in extent. We do this by calculating the ideal resolution for the given extent (based on the map size) and then calling getZoomForResolution(), passing along the ‘closest’ parameter.</p></div></div></div>
136 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.getDataExtent"></a>getDataExtent</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getDataExtent: function ()</td></tr></table></blockquote><p>Calculates the max extent which includes all of the data for the layer. This function is to be implemented by subclasses.</p><h4 class=CHeading>Returns</h4><p>{<a href="BaseTypes/Bounds-js.html#OpenLayers.Bounds" class=LClass id=link60 onMouseOver="ShowTip(event, 'tt7', 'link60')" onMouseOut="HideTip('tt7')">OpenLayers.Bounds</a>}</p></div></div></div>
138 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.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.</p></div></div></div>
140 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.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>Parameters</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’ll be close). Default is false.</td></tr></table><h4 class=CHeading>Returns</h4><p>{Integer} The index of the zoomLevel (entry in the resolutions array) that corresponds to the best fit resolution given the passed in value and the ‘closest’ specification.</p></div></div></div>
142 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.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=link61 onMouseOver="ShowTip(event, 'tt3', 'link61')" onMouseOut="HideTip('tt3')">OpenLayers.Pixel</a>}</td></tr></table><h4 class=CHeading>Returns</h4><p>{<a href="BaseTypes/LonLat-js.html#OpenLayers.LonLat" class=LClass id=link62 onMouseOver="ShowTip(event, 'tt42', 'link62')" onMouseOut="HideTip('tt42')">OpenLayers.LonLat</a>} An OpenLayers.LonLat which is the passed-in view port <a href="BaseTypes/Pixel-js.html#OpenLayers.Pixel" class=LClass id=link63 onMouseOver="ShowTip(event, 'tt3', 'link63')" onMouseOut="HideTip('tt3')">OpenLayers.Pixel</a>, translated into lon/lat by the layer.</p></div></div></div>
144 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.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><p>Returns a pixel location given a map location. This method will return fractional pixel values.</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=link64 onMouseOver="ShowTip(event, 'tt42', 'link64')" onMouseOut="HideTip('tt42')">OpenLayers.LonLat</a>}</td></tr></table><h4 class=CHeading>Returns</h4><p>{<a href="BaseTypes/Pixel-js.html#OpenLayers.Pixel" class=LClass id=link65 onMouseOver="ShowTip(event, 'tt3', 'link65')" onMouseOut="HideTip('tt3')">OpenLayers.Pixel</a>} An <a href="BaseTypes/Pixel-js.html#OpenLayers.Pixel" class=LClass id=link66 onMouseOver="ShowTip(event, 'tt3', 'link66')" onMouseOut="HideTip('tt3')">OpenLayers.Pixel</a> which is the passed-in <a href="BaseTypes/LonLat-js.html#OpenLayers.LonLat" class=LClass id=link67 onMouseOver="ShowTip(event, 'tt42', 'link67')" onMouseOut="HideTip('tt42')">OpenLayers.LonLat</a>,translated into view port pixels.</p></div></div></div>
146 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.setOpacity"></a>setOpacity</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>setOpacity: function(</td><td class=PParameter nowrap>opacity</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the opacity for the entire layer (all images)</p><h4 class=CHeading>Parameter</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>opacity</td><td class=CDLDescription>{Float}</td></tr></table></div></div></div>
148 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.getZIndex"></a>getZIndex</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getZIndex: function ()</td></tr></table></blockquote><h4 class=CHeading>Returns</h4><p>{Integer} the z-index of this layer</p></div></div></div>
150 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.setZIndex"></a>setZIndex</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>setZIndex: function (</td><td class=PParameter nowrap>zIndex</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>zIndex</td><td class=CDLDescription>{Integer}</td></tr></table></div></div></div>
152 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Layer.adjustBounds"></a>adjustBounds</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>adjustBounds: function (</td><td class=PParameter nowrap>bounds</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>This function will take a bounds, and if wrapDateLine option is set on the layer, it will return a bounds which is wrapped around the world. We do not wrap for bounds which <b>cross</b> the maxExtent.left/right, only bounds which are entirely to the left or entirely to the right.</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=link68 onMouseOver="ShowTip(event, 'tt7', 'link68')" onMouseOut="HideTip('tt7')">OpenLayers.Bounds</a>}</td></tr></table></div></div></div>
157 <div id=Footer><a href="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer-->
160 <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 id=MSelected>Layer</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><a href="Map-js.html">Map</a></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"><!--
161 var searchPanel = new SearchPanel("searchPanel", "HTML", "../../search");
162 --></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><!--
163 HideAllBut([19, 29], 31);// --></script></div><!--Menu-->
167 <!--START_ND_TOOLTIPS-->
168 <div class=CToolTip id="tt1"><div class=CClass>Instances of OpenLayers.Map are interactive maps embedded in a web page. </div></div><div class=CToolTip id="tt2"><div class=CClass>The attribution control adds attribution from layers to the map display. </div></div><div class=CToolTip id="tt3"><div class=CClass>This class represents a screen coordinate, in x and y coordinates</div></div><div class=CToolTip id="tt4"><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="tt5"><div class=CClass>Class for coordinate transforms between coordinate systems. </div></div><div class=CToolTip id="tt6"><div class=CClass>Contains convenience functions for string manipulation.</div></div><div class=CToolTip id="tt7"><div class=CClass>Instances of this class represent bounding boxes. </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>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="tt9"><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><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>setName: function(</td><td class=PParameter nowrap>newName</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Sets the new layer name for this layer. </div></div><div class=CToolTip id="tt11"><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>addOptions: function (</td><td class=PParameter nowrap>newOptions</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt12"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>onMapResize: function()</td></tr></table></blockquote>This function can be implemented by subclasses</div></div><div class=CToolTip id="tt13"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>redraw: function()</td></tr></table></blockquote>Redraws the layer. </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>moveTo:function(</td><td class=PParameter nowrap>bounds,</td></tr><tr><td></td><td class=PParameter nowrap>zoomChanged,</td></tr><tr><td></td><td class=PParameter nowrap>dragging</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></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>setMap: function(</td><td class=PParameter nowrap>map</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Set the map property for the layer. </div></div><div class=CToolTip id="tt16"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>afterAdd: function()</td></tr></table></blockquote>Called at the end of the map.addLayer sequence. </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>removeMap: function(</td><td class=PParameter nowrap>map</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Just as setMap() allows each layer the possibility to take a personalized action on being added to the map, removeMap() allows each layer to take a personalized action on being removed from it. </div></div><div class=CToolTip id="tt18"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getImageSize: function()</td></tr></table></blockquote>{OpenLayers.Size} The size that the image should be, taking into account gutters.</div></div><div class=CToolTip id="tt19"><div class=CClass>Instances of this class represent a width/height pair</div></div><div class=CToolTip id="tt20"><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>setTileSize: function(</td><td class=PParameter nowrap>size</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Set the tile size based on the map size. </div></div><div class=CToolTip id="tt21"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getVisibility: function()</td></tr></table></blockquote>{Boolean} The layer should be displayed (if in range).</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>setVisibility: function(</td><td class=PParameter nowrap>visibility</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Set the visibility flag for the layer and hide/show & redraw accordingly. </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>display: function(</td><td class=PParameter nowrap>display</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Hide or show the Layer</div></div><div class=CToolTip id="tt24"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>calculateInRange: function()</td></tr></table></blockquote>{Boolean} The layer is displayable at the current map’s current resolution. </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>setIsBaseLayer: function(</td><td class=PParameter nowrap>isBaseLayer</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>initResolutions: function()</td></tr></table></blockquote>This method’s responsibility is to set up the ‘resolutions’ array for the layer -- this array is what the layer will use to interface between the zoom levels of the map and the resolution display of the layer.</div></div><div class=CToolTip id="tt27"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getResolution: function()</td></tr></table></blockquote>{Float} The currently selected resolution of the map, taken from the resolutions array, indexed by current zoom level.</div></div><div class=CToolTip id="tt28"><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="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>getZoomForExtent: function(</td><td class=PParameter nowrap>extent,</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="tt30"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getDataExtent: function ()</td></tr></table></blockquote>Calculates the max extent which includes all of the data for the layer. </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>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="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>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="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>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="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>getViewPortPxFromLonLat: 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="tt35"><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>setOpacity: function(</td><td class=PParameter nowrap>opacity</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Sets the opacity for the entire layer (all images)</div></div><div class=CToolTip id="tt36"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getZIndex: function ()</td></tr></table></blockquote>{Integer} the z-index of this layer</div></div><div class=CToolTip id="tt37"><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>setZIndex: function (</td><td class=PParameter nowrap>zIndex</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></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>adjustBounds: function (</td><td class=PParameter nowrap>bounds</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>This function will take a bounds, and if wrapDateLine option is set on the layer, it will return a bounds which is wrapped around the world. </div></div><div class=CToolTip id="tt39"><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="tt40"><div class=CProperty>{Array} A list of map resolutions (map units per pixel) in descending order. </div></div><div class=CToolTip id="tt41"><div class=CProperty>{Boolean} Request map tiles that are completely outside of the max extent for this layer. </div></div><div class=CToolTip id="tt42"><div class=CClass>This class represents a longitude and latitude pair</div></div><!--END_ND_TOOLTIPS-->
173 <div id=MSearchResultsWindow><iframe src="" frameborder=0 name=MSearchResults id=MSearchResults></iframe><a href="javascript:searchPanel.CloseResultsWindow()" id=MSearchResultsWindowClose>Close</a></div>
176 <script language=JavaScript><!--
177 if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>