1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">
3 <html><head><title>OpenLayers Base Types - 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="CFile"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="OpenLayers_Base_Types"></a>OpenLayers Base Types</h1><div class=CBody><p>OpenLayers custom string, number and function functions are described here.</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#OpenLayers_Base_Types" >OpenLayers Base Types</a></td><td class=SDescription>OpenLayers custom string, number and function functions are described here.</td></tr><tr class="SClass"><td class=SEntry><a href="#OpenLayers.String" >OpenLayers.<wbr>String</a></td><td class=SDescription>Contains convenience functions for string manipulation.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#OpenLayers.String.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.String.startsWith" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">startsWith</a></td><td class=SDescription>Test whether a string starts with another string.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.String.contains" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">contains</a></td><td class=SDescription>Test whether a string contains another string.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.String.trim" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">trim</a></td><td class=SDescription>Removes leading and trailing whitespace characters from a string.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.String.camelize" id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">camelize</a></td><td class=SDescription>Camel-case a hyphenated string. </td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.String.format" id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')">format</a></td><td class=SDescription>Given a string with tokens in the form ${token}, return a string with tokens replaced with properties from the given context object. </td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.String.OpenLayers.String.isNumeric" >OpenLayers.<wbr>String.<wbr>isNumeric</a></td><td class=SDescription>Determine whether a string contains only a numeric value.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.String.numericIf" id=link6 onMouseOver="ShowTip(event, 'tt6', 'link6')" onMouseOut="HideTip('tt6')">numericIf</a></td><td class=SDescription>Converts a string that appears to be a numeric value into a number.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.String.String.startsWith" >String.<wbr>startsWith</a></td><td class=SDescription><b>Deprecated</b>. </td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.String.String.contains" >String.<wbr>contains</a></td><td class=SDescription><b>Deprecated</b>. </td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.String.String.trim" >String.trim</a></td><td class=SDescription><b>Deprecated</b>. </td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.String.String.camelize" >String.<wbr>camelize</a></td><td class=SDescription><b>Deprecated</b>. </td></tr><tr class="SClass"><td class=SEntry><a href="#OpenLayers.Number" >OpenLayers.<wbr>Number</a></td><td class=SDescription>Contains convenience functions for manipulating numbers.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#OpenLayers.Number.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Number.limitSigDigs" id=link7 onMouseOver="ShowTip(event, 'tt7', 'link7')" onMouseOut="HideTip('tt7')">limitSigDigs</a></td><td class=SDescription>Limit the number of significant digits on a float.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Number.format" id=link8 onMouseOver="ShowTip(event, 'tt8', 'link8')" onMouseOut="HideTip('tt8')">format</a></td><td class=SDescription>Formats a number for output.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Number.Number.limitSigDigs" >Number.<wbr>limitSigDigs</a></td><td class=SDescription><b>Deprecated</b>. </td></tr><tr class="SClass"><td class=SEntry><a href="#OpenLayers.Function" >OpenLayers.<wbr>Function</a></td><td class=SDescription>Contains convenience functions for function manipulation.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#OpenLayers.Function.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Function.bind" id=link9 onMouseOver="ShowTip(event, 'tt9', 'link9')" onMouseOut="HideTip('tt9')">bind</a></td><td class=SDescription>Bind a function to an object. </td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Function.bindAsEventListener" id=link10 onMouseOver="ShowTip(event, 'tt10', 'link10')" onMouseOut="HideTip('tt10')">bindAsEventListener</a></td><td class=SDescription>Bind a function to an object, and configure it to receive the event object as first parameter when called.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Function.Function.bind" >Function.bind</a></td><td class=SDescription><b>Deprecated</b>. </td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Function.Function.bindAsEventListener" >Function.<wbr>bindAsEventListener</a></td><td class=SDescription><b>Deprecated</b>. </td></tr><tr class="SClass"><td class=SEntry><a href="#OpenLayers.Array" >OpenLayers.<wbr>Array</a></td><td class=SDescription>Contains convenience functions for array manipulation.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#OpenLayers.Array.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Array.filter" id=link11 onMouseOver="ShowTip(event, 'tt11', 'link11')" onMouseOut="HideTip('tt11')">filter</a></td><td class=SDescription>Filter an array. </td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
16 <div class="CClass"><div class=CTopic><h2 class=CTitle><a name="OpenLayers.String"></a>OpenLayers.<wbr>String</h2><div class=CBody><p>Contains convenience functions for string manipulation.</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SGroup"><td class=SEntry><a href="#OpenLayers.String.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#OpenLayers.String.startsWith" id=link12 onMouseOver="ShowTip(event, 'tt1', 'link12')" onMouseOut="HideTip('tt1')">startsWith</a></td><td class=SDescription>Test whether a string starts with another string.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#OpenLayers.String.contains" id=link13 onMouseOver="ShowTip(event, 'tt2', 'link13')" onMouseOut="HideTip('tt2')">contains</a></td><td class=SDescription>Test whether a string contains another string.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#OpenLayers.String.trim" id=link14 onMouseOver="ShowTip(event, 'tt3', 'link14')" onMouseOut="HideTip('tt3')">trim</a></td><td class=SDescription>Removes leading and trailing whitespace characters from a string.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#OpenLayers.String.camelize" id=link15 onMouseOver="ShowTip(event, 'tt4', 'link15')" onMouseOut="HideTip('tt4')">camelize</a></td><td class=SDescription>Camel-case a hyphenated string. </td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#OpenLayers.String.format" id=link16 onMouseOver="ShowTip(event, 'tt5', 'link16')" onMouseOut="HideTip('tt5')">format</a></td><td class=SDescription>Given a string with tokens in the form ${token}, return a string with tokens replaced with properties from the given context object. </td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#OpenLayers.String.OpenLayers.String.isNumeric" >OpenLayers.<wbr>String.<wbr>isNumeric</a></td><td class=SDescription>Determine whether a string contains only a numeric value.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#OpenLayers.String.numericIf" id=link17 onMouseOver="ShowTip(event, 'tt6', 'link17')" onMouseOut="HideTip('tt6')">numericIf</a></td><td class=SDescription>Converts a string that appears to be a numeric value into a number.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#OpenLayers.String.String.startsWith" >String.<wbr>startsWith</a></td><td class=SDescription><b>Deprecated</b>. </td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#OpenLayers.String.String.contains" >String.<wbr>contains</a></td><td class=SDescription><b>Deprecated</b>. </td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#OpenLayers.String.String.trim" >String.trim</a></td><td class=SDescription><b>Deprecated</b>. </td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#OpenLayers.String.String.camelize" >String.<wbr>camelize</a></td><td class=SDescription><b>Deprecated</b>. </td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
18 <div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.String.Functions"></a>Functions</h3></div></div>
20 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.String.startsWith"></a>startsWith</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>startsWith: function(</td><td class=PParameter nowrap>str,</td></tr><tr><td></td><td class=PParameter nowrap>sub</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Test whether a string starts with another string.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>str</td><td class=CDLDescription>{String} The string to test.</td></tr><tr><td class=CDLEntry>sub</td><td class=CDLDescription>{Sring} The substring to look for.</td></tr></table><h4 class=CHeading>Returns</h4><p>{Boolean} The first string starts with the second.</p></div></div></div>
22 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.String.contains"></a>contains</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>contains: function(</td><td class=PParameter nowrap>str,</td></tr><tr><td></td><td class=PParameter nowrap>sub</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Test whether a string contains another string.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>str</td><td class=CDLDescription>{String} The string to test.</td></tr><tr><td class=CDLEntry>sub</td><td class=CDLDescription>{String} The substring to look for.</td></tr></table><h4 class=CHeading>Returns</h4><p>{Boolean} The first string contains the second.</p></div></div></div>
24 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.String.trim"></a>trim</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>trim: function(</td><td class=PParameter nowrap>str</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Removes leading and trailing whitespace characters from a string.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>str</td><td class=CDLDescription>{String} The (potentially) space padded string. This string is not modified.</td></tr></table><h4 class=CHeading>Returns</h4><p>{String} A trimmed version of the string with all leading and trailing spaces removed.</p></div></div></div>
26 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.String.camelize"></a>camelize</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>camelize: function(</td><td class=PParameter nowrap>str</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Camel-case a hyphenated string. Ex. “chicken-head” becomes “chickenHead”, and “-chicken-head” becomes “ChickenHead”.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>str</td><td class=CDLDescription>{String} The string to be camelized. The original is not modified.</td></tr></table><h4 class=CHeading>Returns</h4><p>{String} The string, camelized</p></div></div></div>
28 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.String.format"></a>format</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>format: function(</td><td class=PParameter nowrap>template,</td></tr><tr><td></td><td class=PParameter nowrap>context,</td></tr><tr><td></td><td class=PParameter nowrap>args</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Given a string with tokens in the form ${token}, return a string with tokens replaced with properties from the given context object. Represent a literal “${“ by doubling it, e.g. “${${“.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>template</td><td class=CDLDescription>{String} A string with tokens to be replaced. A template has the form “literal ${token}” where the token will be replaced by the value of context[“token”].</td></tr><tr><td class=CDLEntry>context</td><td class=CDLDescription>{Object} An optional object with properties corresponding to the tokens in the format string. If no context is sent, the window object will be used.</td></tr><tr><td class=CDLEntry>args</td><td class=CDLDescription>{Array} Optional arguments to pass to any functions found in the context. If a context property is a function, the token will be replaced by the return from the function called with these arguments.</td></tr></table><h4 class=CHeading>Returns</h4><p>{String} A string with tokens replaced from the context object.</p></div></div></div>
30 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.String.OpenLayers.String.isNumeric"></a>OpenLayers.<wbr>String.<wbr>isNumeric</h3><div class=CBody><p>Determine whether a string contains only a numeric value.</p><h4 class=CHeading>Examples</h4><blockquote><pre>OpenLayers.String.isNumeric("6.02e23") // true
31 OpenLayers.String.isNumeric("12 dozen") // false
32 OpenLayers.String.isNumeric("4") // true
33 OpenLayers.String.isNumeric(" 4 ") // false</pre></blockquote><h4 class=CHeading>Returns</h4><p>{Boolean} String contains only a number.</p></div></div></div>
35 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.String.numericIf"></a>numericIf</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>numericIf: function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Converts a string that appears to be a numeric value into a number.</p><p>Returns {Number|String} a Number if the passed value is a number, a String otherwise.</p></div></div></div>
37 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.String.String.startsWith"></a>String.<wbr>startsWith</h3><div class=CBody><p><b>Deprecated</b>. Whether or not a string starts with another string.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>sStart</td><td class=CDLDescription>{Sring} The string we’re testing for.</td></tr></table><h4 class=CHeading>Returns</h4><p>{Boolean} Whether or not this string starts with the string passed in.</p></div></div></div>
39 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.String.String.contains"></a>String.<wbr>contains</h3><div class=CBody><p><b>Deprecated</b>. Whether or not a string contains another string.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>str</td><td class=CDLDescription>{String} The string that we’re testing for.</td></tr></table><h4 class=CHeading>Returns</h4><p>{Boolean} Whether or not this string contains with the string passed in.</p></div></div></div>
41 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.String.String.trim"></a>String.trim</h3><div class=CBody><p><b>Deprecated</b>. Removes leading and trailing whitespace characters from a string.</p><h4 class=CHeading>Returns</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>{String} A trimmed version of the string</td><td class=CDLDescription>all leading and trailing spaces removed</td></tr></table></div></div></div>
43 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.String.String.camelize"></a>String.<wbr>camelize</h3><div class=CBody><p><b>Deprecated</b>. Camel-case a hyphenated string. Ex. “chicken-head” becomes “chickenHead”, and “-chicken-head” becomes “ChickenHead”.</p><h4 class=CHeading>Returns</h4><p>{String} The string, camelized</p></div></div></div>
45 <div class="CClass"><div class=CTopic><h2 class=CTitle><a name="OpenLayers.Number"></a>OpenLayers.<wbr>Number</h2><div class=CBody><p>Contains convenience functions for manipulating numbers.</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SGroup"><td class=SEntry><a href="#OpenLayers.Number.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#OpenLayers.Number.limitSigDigs" id=link18 onMouseOver="ShowTip(event, 'tt7', 'link18')" onMouseOut="HideTip('tt7')">limitSigDigs</a></td><td class=SDescription>Limit the number of significant digits on a float.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#OpenLayers.Number.format" id=link19 onMouseOver="ShowTip(event, 'tt8', 'link19')" onMouseOut="HideTip('tt8')">format</a></td><td class=SDescription>Formats a number for output.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#OpenLayers.Number.Number.limitSigDigs" >Number.<wbr>limitSigDigs</a></td><td class=SDescription><b>Deprecated</b>. </td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
47 <div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Number.Functions"></a>Functions</h3></div></div>
49 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Number.limitSigDigs"></a>limitSigDigs</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>limitSigDigs: function(</td><td class=PParameter nowrap>num,</td></tr><tr><td></td><td class=PParameter nowrap>sig</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Limit the number of significant digits on a float.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>num</td><td class=CDLDescription>{Float}</td></tr><tr><td class=CDLEntry>sig</td><td class=CDLDescription>{Integer}</td></tr></table><h4 class=CHeading>Returns</h4><p>{Float} The number, rounded to the specified number of significant digits.</p></div></div></div>
51 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Number.format"></a>format</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>format: function(</td><td class=PParameter nowrap>num,</td></tr><tr><td></td><td class=PParameter nowrap>dec,</td></tr><tr><td></td><td class=PParameter nowrap>tsep,</td></tr><tr><td></td><td class=PParameter nowrap>dsep</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Formats a number for output.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>num</td><td class=CDLDescription>{Float}</td></tr><tr><td class=CDLEntry>dec</td><td class=CDLDescription>{Integer} Number of decimal places to round to. Defaults to 0. Set to null to leave decimal places unchanged.</td></tr><tr><td class=CDLEntry>tsep</td><td class=CDLDescription>{String} Thousands separator. Default is “,”.</td></tr><tr><td class=CDLEntry>dsep</td><td class=CDLDescription>{String} Decimal separator. Default is “.”.</td></tr></table><h4 class=CHeading>Returns</h4><p>{String} A string representing the formatted number.</p></div></div></div>
53 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Number.Number.limitSigDigs"></a>Number.<wbr>limitSigDigs</h3><div class=CBody><p><b>Deprecated</b>. Limit the number of significant digits on an integer. Does <b>not</b> work with floats!</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>sig</td><td class=CDLDescription>{Integer}</td></tr></table><h4 class=CHeading>Returns</h4><p>{Integer} The number, rounded to the specified number of significant digits. If null, 0, or negative value passed in, returns 0</p></div></div></div>
55 <div class="CClass"><div class=CTopic><h2 class=CTitle><a name="OpenLayers.Function"></a>OpenLayers.<wbr>Function</h2><div class=CBody><p>Contains convenience functions for function manipulation.</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SGroup"><td class=SEntry><a href="#OpenLayers.Function.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#OpenLayers.Function.bind" id=link20 onMouseOver="ShowTip(event, 'tt9', 'link20')" onMouseOut="HideTip('tt9')">bind</a></td><td class=SDescription>Bind a function to an object. </td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#OpenLayers.Function.bindAsEventListener" id=link21 onMouseOver="ShowTip(event, 'tt10', 'link21')" onMouseOut="HideTip('tt10')">bindAsEventListener</a></td><td class=SDescription>Bind a function to an object, and configure it to receive the event object as first parameter when called.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#OpenLayers.Function.Function.bind" >Function.bind</a></td><td class=SDescription><b>Deprecated</b>. </td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#OpenLayers.Function.Function.bindAsEventListener" >Function.<wbr>bindAsEventListener</a></td><td class=SDescription><b>Deprecated</b>. </td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
57 <div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Function.Functions"></a>Functions</h3></div></div>
59 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Function.bind"></a>bind</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>bind: function(</td><td class=PParameter nowrap>func,</td></tr><tr><td></td><td class=PParameter nowrap>object</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Bind a function to an object. Method to easily create closures with ‘this’ altered.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>func</td><td class=CDLDescription>{Function} Input function.</td></tr><tr><td class=CDLEntry>object</td><td class=CDLDescription>{Object} The object to bind to the input function (as this).</td></tr></table><h4 class=CHeading>Returns</h4><p>{Function} A closure with ‘this’ set to the passed in object.</p></div></div></div>
61 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Function.bindAsEventListener"></a>bindAsEventListener</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>bindAsEventListener: function(</td><td class=PParameter nowrap>func,</td></tr><tr><td></td><td class=PParameter nowrap>object</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Bind a function to an object, and configure it to receive the event object as first parameter when called.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>func</td><td class=CDLDescription>{Function} Input function to serve as an event listener.</td></tr><tr><td class=CDLEntry>object</td><td class=CDLDescription>{Object} A reference to this.</td></tr></table><h4 class=CHeading>Returns</h4><p>{Function}</p></div></div></div>
63 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Function.Function.bind"></a>Function.bind</h3><div class=CBody><p><b>Deprecated</b>. Bind a function to an object. Method to easily create closures with ‘this’ altered.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>object</td><td class=CDLDescription>{Object} the this parameter</td></tr></table><h4 class=CHeading>Returns</h4><p>{Function} A closure with ‘this’ altered to the first argument.</p></div></div></div>
65 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Function.Function.bindAsEventListener"></a>Function.<wbr>bindAsEventListener</h3><div class=CBody><p><b>Deprecated</b>. Bind a function to an object, and configure it to receive the event object as first parameter when called.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>object</td><td class=CDLDescription>{Object} A reference to this.</td></tr></table><h4 class=CHeading>Returns</h4><p>{Function}</p></div></div></div>
67 <div class="CClass"><div class=CTopic><h2 class=CTitle><a name="OpenLayers.Array"></a>OpenLayers.<wbr>Array</h2><div class=CBody><p>Contains convenience functions for array manipulation.</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SGroup"><td class=SEntry><a href="#OpenLayers.Array.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#OpenLayers.Array.filter" id=link22 onMouseOver="ShowTip(event, 'tt11', 'link22')" onMouseOut="HideTip('tt11')">filter</a></td><td class=SDescription>Filter an array. </td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
69 <div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Array.Functions"></a>Functions</h3></div></div>
71 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Array.filter"></a>filter</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>filter: function(</td><td class=PParameter nowrap>array,</td></tr><tr><td></td><td class=PParameter nowrap>callback,</td></tr><tr><td></td><td class=PParameter nowrap>caller</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Filter an array. Provides the functionality of the Array.prototype.filter extension to the ECMA-262 standard. Where available, Array.prototype.filter will be used.</p><p>Based on well known example from <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Objects:Array:filter" class=LURL target=_top>http://developer.mozilla.org<wbr>/en<wbr>/docs<wbr>/Core_JavaScript_1.5_Reference:Objects:Array:filter</a></p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>array</td><td class=CDLDescription>{Array} The array to be filtered. This array is not mutated. Elements added to this array by the callback will not be visited.</td></tr><tr><td class=CDLEntry>callback</td><td class=CDLDescription>{Function} A function that is called for each element in the array. If this function returns true, the element will be included in the return. The function will be called with three arguments: the element in the array, the index of that element, and the array itself. If the optional caller parameter is specified the callback will be called with this set to caller.</td></tr><tr><td class=CDLEntry>caller</td><td class=CDLDescription>{Object} Optional object to be set as this when the callback is called.</td></tr></table><h4 class=CHeading>Returns</h4><p>{Array} An array of elements from the passed in array for which the callback returns true.</p></div></div></div>
76 <div id=Footer><a href="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer-->
79 <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 id=MSelected>Base Types</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</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent11')">WFST</a><div class=MGroupContent id=MGroupContent11><div class=MEntry><div class=MFile><a href="Format/WFST-js.html">WFST</a></div></div><div class=MEntry><div class=MFile><a href="Format/WFST/v1-js.html">v1</a></div></div><div class=MEntry><div class=MFile><a href="Format/WFST/v1_0_0-js.html">v1_0_0</a></div></div><div class=MEntry><div class=MFile><a href="Format/WFST/v1_1_0-js.html">v1_1_0</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="Format/WKT-js.html">WKT</a></div></div><div class=MEntry><div class=MFile><a href="Format/WMSCapabilities-js.html">WMSCapabilities</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent12')">WMSCapabilities</a><div class=MGroupContent id=MGroupContent12><div class=MEntry><div class=MFile><a href="Format/WMSCapabilities/v1_1-js.html">WMSCapabilities.v1_1</a></div></div><div class=MEntry><div class=MFile><a href="Format/WMSCapabilities/v1_1_0-js.html">WMSCapabilities/<wbr>v1_1_0</a></div></div><div class=MEntry><div class=MFile><a href="Format/WMSCapabilities/v1_1_1-js.html">WMSCapabilities/<wbr>v1_1_1</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="Format/WMSDescribeLayer-js.html">WMSDescribeLayer</a></div></div><div class=MEntry><div class=MFile><a href="Format/WMSDescribeLayer/v1_1-js.html">WMSDescribeLayer.v1_1</a></div></div><div class=MEntry><div class=MFile><a href="Format/WMSGetFeatureInfo-js.html">WMSGetFeatureInfo</a></div></div><div class=MEntry><div class=MFile><a href="Format/XML-js.html">XML</a></div></div></div></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent15')">Geometry</a><div class=MGroupContent id=MGroupContent15><div class=MEntry><div class=MFile><a href="Geometry-js.html">Geometry</a></div></div><div class=MEntry><div class=MFile><a href="Geometry/Collection-js.html">Collection</a></div></div><div class=MEntry><div class=MFile><a href="Geometry/Curve-js.html">Curve</a></div></div><div class=MEntry><div class=MFile><a href="Geometry/LinearRing-js.html">LinearRing</a></div></div><div class=MEntry><div class=MFile><a href="Geometry/LineString-js.html">LineString</a></div></div><div class=MEntry><div class=MFile><a href="Geometry/MultiLineString-js.html">MultiLineString</a></div></div><div class=MEntry><div class=MFile><a href="Geometry/MultiPoint-js.html">MultiPoint</a></div></div><div class=MEntry><div class=MFile><a href="Geometry/MultiPolygon-js.html">MultiPolygon</a></div></div><div class=MEntry><div class=MFile><a href="Geometry/Point-js.html">Point</a></div></div><div class=MEntry><div class=MFile><a href="Geometry/Polygon-js.html">Polygon</a></div></div><div class=MEntry><div class=MFile><a href="Geometry/Rectangle-js.html">Rectangle</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent16')">Handler</a><div class=MGroupContent id=MGroupContent16><div class=MEntry><div class=MFile><a href="Handler-js.html">Handler</a></div></div><div class=MEntry><div class=MFile><a href="Handler/Box-js.html">Box</a></div></div><div class=MEntry><div class=MFile><a href="Handler/Click-js.html">Click</a></div></div><div class=MEntry><div class=MFile><a href="Handler/Drag-js.html">Drag</a></div></div><div class=MEntry><div class=MFile><a href="Handler/Feature-js.html">Feature</a></div></div><div class=MEntry><div class=MFile><a href="Handler/Hover-js.html">Hover</a></div></div><div class=MEntry><div class=MFile><a href="Handler/Keyboard-js.html">Keyboard</a></div></div><div class=MEntry><div class=MFile><a href="Handler/MouseWheel-js.html">MouseWheel</a></div></div><div class=MEntry><div class=MFile><a href="Handler/Path-js.html">Path</a></div></div><div class=MEntry><div class=MFile><a href="Handler/Point-js.html">Point</a></div></div><div class=MEntry><div class=MFile><a href="Handler/Polygon-js.html">Polygon</a></div></div><div class=MEntry><div class=MFile><a href="Handler/RegularPolygon-js.html">RegularPolygon</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="Icon-js.html">Icon</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent17')">Lang</a><div class=MGroupContent id=MGroupContent17><div class=MEntry><div class=MFile><a href="Lang-js.html">Lang</a></div></div><div class=MEntry><div class=MFile><a href="Lang/ca-js.html">ca</a></div></div><div class=MEntry><div class=MFile><a href="Lang/cs-CZ-js.html">cs-CZ</a></div></div><div class=MEntry><div class=MFile><a href="Lang/da-DK-js.html">da-DK</a></div></div><div class=MEntry><div class=MFile><a href="Lang/de-js.html">de</a></div></div><div class=MEntry><div class=MFile><a href="Lang/en-js.html">en</a></div></div><div class=MEntry><div class=MFile><a href="Lang/en-CA-js.html">en-CA</a></div></div><div class=MEntry><div class=MFile><a href="Lang/es-js.html">es</a></div></div><div class=MEntry><div class=MFile><a href="Lang/fr-js.html">fr</a></div></div><div class=MEntry><div class=MFile><a href="Lang/it-js.html">it</a></div></div><div class=MEntry><div class=MFile><a href="Lang/nb-js.html">nb</a></div></div><div class=MEntry><div class=MFile><a href="Lang/nl-js.html">nl</a></div></div><div class=MEntry><div class=MFile><a href="Lang/pt-BR-js.html">pt-BR</a></div></div><div class=MEntry><div class=MFile><a href="Lang/sv-SE-js.html">sv-SE</a></div></div><div class=MEntry><div class=MFile><a href="Lang/zh-CN-js.html">zh-CN</a></div></div><div class=MEntry><div class=MFile><a href="Lang/zh-TW-js.html">zh-TW</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent19')">Layer</a><div class=MGroupContent id=MGroupContent19><div class=MEntry><div class=MFile><a href="Layer-js.html">Layer</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent18')">Layer</a><div class=MGroupContent id=MGroupContent18><div class=MEntry><div class=MFile><a href="Layer/ArcGIS93Rest-js.html">ArcGIS93Rest</a></div></div><div class=MEntry><div class=MFile><a href="Layer/Boxes-js.html">Boxes</a></div></div><div class=MEntry><div class=MFile><a href="Layer/EventPane-js.html">EventPane</a></div></div><div class=MEntry><div class=MFile><a href="Layer/FixedZoomLevels-js.html">FixedZoomLevels</a></div></div><div class=MEntry><div class=MFile><a href="Layer/GeoRSS-js.html">GeoRSS</a></div></div><div class=MEntry><div class=MFile><a href="Layer/GML-js.html">GML</a></div></div><div class=MEntry><div class=MFile><a href="Layer/Google-js.html">Google</a></div></div><div class=MEntry><div class=MFile><a href="Layer/Grid-js.html">Grid</a></div></div><div class=MEntry><div class=MFile><a href="Layer/HTTPRequest-js.html">HTTPRequest</a></div></div><div class=MEntry><div class=MFile><a href="Layer/Image-js.html">Image</a></div></div><div class=MEntry><div class=MFile><a href="Layer/KaMap-js.html">KaMap</a></div></div><div class=MEntry><div class=MFile><a href="Layer/KaMapCache-js.html">KaMapCache</a></div></div><div class=MEntry><div class=MFile><a href="Layer/MapGuide-js.html">MapGuide</a></div></div><div class=MEntry><div class=MFile><a href="Layer/MapServer-js.html">MapServer</a></div></div><div class=MEntry><div class=MFile><a href="Layer/MapServer/Untiled-js.html">MapServer.<wbr>Untiled</a></div></div><div class=MEntry><div class=MFile><a href="Layer/Markers-js.html">Markers</a></div></div><div class=MEntry><div class=MFile><a href="Layer/MultiMap-js.html">MultiMap</a></div></div><div class=MEntry><div class=MFile><a href="Layer/PointTrack-js.html">PointTrack</a></div></div><div class=MEntry><div class=MFile><a href="Layer/SphericalMercator-js.html">SphericalMercator</a></div></div><div class=MEntry><div class=MFile><a href="Layer/Text-js.html">Text</a></div></div><div class=MEntry><div class=MFile><a href="Layer/TileCache-js.html">TileCache</a></div></div><div class=MEntry><div class=MFile><a href="Layer/TMS-js.html">TMS</a></div></div><div class=MEntry><div class=MFile><a href="Layer/Vector-js.html">Vector</a></div></div><div class=MEntry><div class=MFile><a href="Layer/Vector/RootContainer-js.html">Vector.<wbr>RootContainer</a></div></div><div class=MEntry><div class=MFile><a href="Layer/VirtualEarth-js.html">VirtualEarth</a></div></div><div class=MEntry><div class=MFile><a href="Layer/WFS-js.html">WFS</a></div></div><div class=MEntry><div class=MFile><a href="Layer/WMS-js.html">WMS</a></div></div><div class=MEntry><div class=MFile><a href="Layer/WMS/Untiled-js.html">WMS.<wbr>Untiled</a></div></div><div class=MEntry><div class=MFile><a href="Layer/WorldWind-js.html">WorldWind</a></div></div><div class=MEntry><div class=MFile><a href="Layer/Yahoo-js.html">Yahoo</a></div></div><div class=MEntry><div class=MFile><a href="Layer/ArcIMS-js.html">ArcIMS</a></div></div><div class=MEntry><div class=MFile><a href="Layer/XYZ-js.html">XYZ</a></div></div></div></div></div></div></div></div><div class=MEntry><div class=MFile><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"><!--
80 var searchPanel = new SearchPanel("searchPanel", "HTML", "../../search");
81 --></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><!--
82 HideAllBut([1, 29], 31);// --></script></div><!--Menu-->
86 <!--START_ND_TOOLTIPS-->
87 <div class=CToolTip id="tt1"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>startsWith: function(</td><td class=PParameter nowrap>str,</td></tr><tr><td></td><td class=PParameter nowrap>sub</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Test whether a string starts with another string.</div></div><div class=CToolTip id="tt2"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>contains: function(</td><td class=PParameter nowrap>str,</td></tr><tr><td></td><td class=PParameter nowrap>sub</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Test whether a string contains another string.</div></div><div class=CToolTip id="tt3"><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>trim: function(</td><td class=PParameter nowrap>str</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Removes leading and trailing whitespace characters from a string.</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>camelize: function(</td><td class=PParameter nowrap>str</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Camel-case a hyphenated string. </div></div><div class=CToolTip id="tt5"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>format: function(</td><td class=PParameter nowrap>template,</td></tr><tr><td></td><td class=PParameter nowrap>context,</td></tr><tr><td></td><td class=PParameter nowrap>args</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Given a string with tokens in the form ${token}, return a string with tokens replaced with properties from the given context object. </div></div><div class=CToolTip id="tt6"><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>numericIf: function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Converts a string that appears to be a numeric value into a number.</div></div><div class=CToolTip id="tt7"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>limitSigDigs: function(</td><td class=PParameter nowrap>num,</td></tr><tr><td></td><td class=PParameter nowrap>sig</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Limit the number of significant digits on a float.</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>format: function(</td><td class=PParameter nowrap>num,</td></tr><tr><td></td><td class=PParameter nowrap>dec,</td></tr><tr><td></td><td class=PParameter nowrap>tsep,</td></tr><tr><td></td><td class=PParameter nowrap>dsep</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Formats a number for output.</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>bind: function(</td><td class=PParameter nowrap>func,</td></tr><tr><td></td><td class=PParameter nowrap>object</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Bind a function to an object. </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>bindAsEventListener: function(</td><td class=PParameter nowrap>func,</td></tr><tr><td></td><td class=PParameter nowrap>object</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Bind a function to an object, and configure it to receive the event object as first parameter when called.</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>filter: function(</td><td class=PParameter nowrap>array,</td></tr><tr><td></td><td class=PParameter nowrap>callback,</td></tr><tr><td></td><td class=PParameter nowrap>caller</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Filter an array. </div></div><!--END_ND_TOOLTIPS-->
92 <div id=MSearchResultsWindow><iframe src="" frameborder=0 name=MSearchResults id=MSearchResults></iframe><a href="javascript:searchPanel.CloseResultsWindow()" id=MSearchResultsWindowClose>Close</a></div>
95 <script language=JavaScript><!--
96 if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>