[76] | 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
---|
| 2 | "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
---|
| 3 | |
---|
| 4 | <html xmlns="http://www.w3.org/1999/xhtml"> |
---|
| 5 | <head> |
---|
| 6 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
---|
| 7 | |
---|
| 8 | <title>API Reference — GeoExt v1.0</title> |
---|
| 9 | <link rel="stylesheet" href="../_static/geoext.css" type="text/css" /> |
---|
| 10 | <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> |
---|
| 11 | <script type="text/javascript"> |
---|
| 12 | var DOCUMENTATION_OPTIONS = { |
---|
| 13 | URL_ROOT: '../', |
---|
| 14 | VERSION: '1.0', |
---|
| 15 | COLLAPSE_MODINDEX: false, |
---|
| 16 | FILE_SUFFIX: '.html', |
---|
| 17 | HAS_SOURCE: true |
---|
| 18 | }; |
---|
| 19 | </script> |
---|
| 20 | <script type="text/javascript" src="../_static/jquery.js"></script> |
---|
| 21 | <script type="text/javascript" src="../_static/doctools.js"></script> |
---|
| 22 | <link rel="shortcut icon" href="../_static/favicon.ico"/> |
---|
| 23 | <link rel="top" title="GeoExt v1.0" href="../index.html" /> |
---|
| 24 | <link rel="next" title="Widgets" href="GeoExt/widgets.html" /> |
---|
| 25 | <link rel="prev" title="GeoExt Community Involvement" href="../developer/index.html" /> |
---|
| 26 | |
---|
| 27 | |
---|
| 28 | |
---|
| 29 | |
---|
| 30 | |
---|
| 31 | |
---|
| 32 | </head> |
---|
| 33 | <body> |
---|
| 34 | <div class="header"> |
---|
| 35 | <div class="wrap"> |
---|
| 36 | <h1 id="logo"><a href="../index.html">GeoExt</a></h1> |
---|
| 37 | <ul id="top-nav"> |
---|
| 38 | <li class="first"><a href="../docs.html">Documentation</a></li> |
---|
| 39 | <li><a href="../examples.html">Examples</a></li> |
---|
| 40 | <li><a href="../downloads.html">Download</a></li> |
---|
| 41 | <li><a href="http://trac.geoext.org/">Development</a></li> |
---|
| 42 | </ul> |
---|
| 43 | <div id="searchbox"> |
---|
| 44 | <form class="search" action="../search.html" method="get"> |
---|
| 45 | <input id="searchbox-query" type="text" name="q" size="25" value="Search …" tabindex="3" onblur="if(this.value=='') this.value='Search …';" onfocus="if(this.value=='Search …') this.value='';" /> |
---|
| 46 | <input id="searchbox-submit" type="image" value="Search" src="../_static/img/search_icon_green.png" /> |
---|
| 47 | <input type="hidden" name="check_keywords" value="yes" /> |
---|
| 48 | <input type="hidden" name="area" value="default" /> |
---|
| 49 | </form> |
---|
| 50 | </div> |
---|
| 51 | </div> |
---|
| 52 | </div> |
---|
| 53 | |
---|
| 54 | <div class="related"> |
---|
| 55 | <h3>Navigation</h3> |
---|
| 56 | <ul> |
---|
| 57 | <li><a href="../index.html">GeoExt</a> »</li> |
---|
| 58 | <li><a href="#">API Reference</a></li> |
---|
| 59 | </ul> |
---|
| 60 | </div> |
---|
| 61 | |
---|
| 62 | <div class="sphinxsidebar"> |
---|
| 63 | <div class="sphinxsidebarwrapper"> |
---|
| 64 | <h3><a href="../index.html">Table Of Contents</a></h3> |
---|
| 65 | <ul> |
---|
| 66 | <li><a class="reference external" href="#">API Reference</a><ul> |
---|
| 67 | <li><a class="reference external" href="#geoext"><tt class="docutils literal"><span class="pre">GeoExt</span></tt></a><ul> |
---|
| 68 | </ul> |
---|
| 69 | </li> |
---|
| 70 | <li><a class="reference external" href="#overrides">Overrides</a><ul> |
---|
| 71 | </ul> |
---|
| 72 | </li> |
---|
| 73 | </ul> |
---|
| 74 | </li> |
---|
| 75 | </ul> |
---|
| 76 | |
---|
| 77 | <h4>Previous topic</h4> |
---|
| 78 | <p class="topless"><a href="../developer/index.html" |
---|
| 79 | title="previous chapter">GeoExt Community Involvement</a></p> |
---|
| 80 | <h4>Next topic</h4> |
---|
| 81 | <p class="topless"><a href="GeoExt/widgets.html" |
---|
| 82 | title="next chapter">Widgets</a></p> |
---|
| 83 | </div> |
---|
| 84 | </div> |
---|
| 85 | |
---|
| 86 | |
---|
| 87 | <div class="document"> |
---|
| 88 | <div class="documentwrapper"> |
---|
| 89 | <div class="bodywrapper"> |
---|
| 90 | <div class="body"> |
---|
| 91 | |
---|
| 92 | <div class="section" id="module-GeoExt"> |
---|
| 93 | <span id="api-reference"></span><h1>API Reference<a class="headerlink" href="#module-GeoExt" title="Permalink to this headline">¶</a></h1> |
---|
| 94 | <p>GeoExt components and data utility classes extend map related functionality to |
---|
| 95 | equivalent classes in Ext. The API reference here documents the properties, |
---|
| 96 | methods, and events that are extensions or modifications to the Ext parent |
---|
| 97 | classes. Documentation for each class contains links to the Ext parent class, |
---|
| 98 | and for a full picture of the API, it is essential to have a copy of the |
---|
| 99 | <a class="reference external" href="http://dev.sencha.com/deploy/dev/docs/">Ext API Documentation</a> at hand.</p> |
---|
| 100 | <p>GeoExt classes are typically configured with OpenLayers objects. For detail on |
---|
| 101 | methods and properties provided by these objects, see the |
---|
| 102 | <a class="reference external" href="http://dev.openlayers.org/apidocs">OpenLayers API Documentation</a>.</p> |
---|
| 103 | <div class="section" id="geoext"> |
---|
| 104 | <h2><tt class="xref docutils literal"><span class="pre">GeoExt</span></tt><a class="headerlink" href="#geoext" title="Permalink to this headline">¶</a></h2> |
---|
| 105 | <ul> |
---|
| 106 | <li class="toctree-l1"><a class="reference external" href="GeoExt/widgets.html">Widgets</a><ul> |
---|
| 107 | <li class="toctree-l2"><a class="reference external" href="GeoExt/widgets/Action.html"><tt class="docutils literal"><span class="pre">GeoExt.Action</span></tt></a></li> |
---|
| 108 | <li class="toctree-l2"><a class="reference external" href="GeoExt/widgets/FeatureRenderer.html"><tt class="docutils literal"><span class="pre">GeoExt.FeatureRenderer</span></tt></a></li> |
---|
| 109 | <li class="toctree-l2"><a class="reference external" href="GeoExt/widgets/LayerLegend.html"><tt class="docutils literal"><span class="pre">GeoExt.LayerLegend</span></tt></a></li> |
---|
| 110 | <li class="toctree-l2"><a class="reference external" href="GeoExt/widgets/LayerOpacitySlider.html"><tt class="docutils literal"><span class="pre">GeoExt.LayerOpacitySlider</span></tt></a></li> |
---|
| 111 | <li class="toctree-l2"><a class="reference external" href="GeoExt/widgets/LegendImage.html"><tt class="docutils literal"><span class="pre">GeoExt.LegendImage</span></tt></a></li> |
---|
| 112 | <li class="toctree-l2"><a class="reference external" href="GeoExt/widgets/LegendPanel.html"><tt class="docutils literal"><span class="pre">GeoExt.LegendPanel</span></tt></a></li> |
---|
| 113 | <li class="toctree-l2"><a class="reference external" href="GeoExt/widgets/MapPanel.html"><tt class="docutils literal"><span class="pre">GeoExt.MapPanel</span></tt></a></li> |
---|
| 114 | <li class="toctree-l2"><a class="reference external" href="GeoExt/widgets/Popup.html"><tt class="docutils literal"><span class="pre">GeoExt.Popup</span></tt></a></li> |
---|
| 115 | <li class="toctree-l2"><a class="reference external" href="GeoExt/widgets/PrintMapPanel.html"><tt class="docutils literal"><span class="pre">GeoExt.PrintMapPanel</span></tt></a></li> |
---|
| 116 | <li class="toctree-l2"><a class="reference external" href="GeoExt/widgets/UrlLegend.html"><tt class="docutils literal"><span class="pre">GeoExt.UrlLegend</span></tt></a></li> |
---|
| 117 | <li class="toctree-l2"><a class="reference external" href="GeoExt/widgets/VectorLegend.html"><tt class="docutils literal"><span class="pre">GeoExt.VectorLegend</span></tt></a></li> |
---|
| 118 | <li class="toctree-l2"><a class="reference external" href="GeoExt/widgets/WMSLegend.html"><tt class="docutils literal"><span class="pre">GeoExt.WMSLegend</span></tt></a></li> |
---|
| 119 | <li class="toctree-l2"><a class="reference external" href="GeoExt/widgets/ZoomSlider.html"><tt class="docutils literal"><span class="pre">GeoExt.ZoomSlider</span></tt></a></li> |
---|
| 120 | <li class="toctree-l2"><a class="reference external" href="GeoExt/widgets/tips/LayerOpacitySliderTip.html"><tt class="docutils literal"><span class="pre">GeoExt.LayerOpacitySliderTip</span></tt></a></li> |
---|
| 121 | <li class="toctree-l2"><a class="reference external" href="GeoExt/widgets/tips/SliderTip.html"><tt class="docutils literal"><span class="pre">GeoExt.SliderTip</span></tt></a></li> |
---|
| 122 | <li class="toctree-l2"><a class="reference external" href="GeoExt/widgets/tips/ZoomSliderTip.html"><tt class="docutils literal"><span class="pre">GeoExt.ZoomSliderTip</span></tt></a></li> |
---|
| 123 | </ul> |
---|
| 124 | </li> |
---|
| 125 | <li class="toctree-l1"><a class="reference external" href="GeoExt/widgets.html#module-GeoExt.grid"><tt class="docutils literal"><span class="pre">GeoExt.form</span></tt></a><ul> |
---|
| 126 | <li class="toctree-l2"><a class="reference external" href="GeoExt/widgets/form/BasicForm.html"><tt class="docutils literal"><span class="pre">GeoExt.form.BasicForm</span></tt></a></li> |
---|
| 127 | <li class="toctree-l2"><a class="reference external" href="GeoExt/widgets/form/FormPanel.html"><tt class="docutils literal"><span class="pre">GeoExt.form.FormPanel</span></tt></a></li> |
---|
| 128 | <li class="toctree-l2"><a class="reference external" href="GeoExt/widgets/form/SearchAction.html"><tt class="docutils literal"><span class="pre">GeoExt.form.SearchAction</span></tt></a></li> |
---|
| 129 | </ul> |
---|
| 130 | </li> |
---|
| 131 | <li class="toctree-l1"><a class="reference external" href="GeoExt/widgets.html#module-GeoExt.tree"><tt class="docutils literal"><span class="pre">GeoExt.grid</span></tt></a><ul> |
---|
| 132 | <li class="toctree-l2"><a class="reference external" href="GeoExt/widgets/grid/FeatureSelectionModel.html"><tt class="docutils literal"><span class="pre">GeoExt.grid.FeatureSelectionModel</span></tt></a></li> |
---|
| 133 | </ul> |
---|
| 134 | </li> |
---|
| 135 | <li class="toctree-l1"><a class="reference external" href="GeoExt/widgets.html#geoext-tree"><tt class="docutils literal"><span class="pre">GeoExt.tree</span></tt></a><ul> |
---|
| 136 | <li class="toctree-l2"><a class="reference external" href="GeoExt/widgets/tree/BaseLayerContainer.html"><tt class="docutils literal"><span class="pre">GeoExt.tree.BaseLayerContainer</span></tt></a></li> |
---|
| 137 | <li class="toctree-l2"><a class="reference external" href="GeoExt/widgets/tree/LayerContainer.html"><tt class="docutils literal"><span class="pre">GeoExt.tree.LayerContainer</span></tt></a></li> |
---|
| 138 | <li class="toctree-l2"><a class="reference external" href="GeoExt/widgets/tree/LayerLoader.html"><tt class="docutils literal"><span class="pre">GeoExt.tree.LayerLoader</span></tt></a></li> |
---|
| 139 | <li class="toctree-l2"><a class="reference external" href="GeoExt/widgets/tree/LayerNode.html"><tt class="docutils literal"><span class="pre">GeoExt.tree.LayerNode</span></tt></a></li> |
---|
| 140 | <li class="toctree-l2"><a class="reference external" href="GeoExt/widgets/tree/LayerParamLoader.html"><tt class="docutils literal"><span class="pre">GeoExt.tree.LayerParamLoader</span></tt></a></li> |
---|
| 141 | <li class="toctree-l2"><a class="reference external" href="GeoExt/widgets/tree/LayerParamNode.html"><tt class="docutils literal"><span class="pre">GeoExt.tree.LayerParamNode</span></tt></a></li> |
---|
| 142 | <li class="toctree-l2"><a class="reference external" href="GeoExt/widgets/tree/OverlayLayerContainer.html"><tt class="docutils literal"><span class="pre">GeoExt.tree.OverlayLayerContainer</span></tt></a></li> |
---|
| 143 | <li class="toctree-l2"><a class="reference external" href="GeoExt/widgets/tree/TreeNodeUIEventMixin.html"><tt class="docutils literal"><span class="pre">GeoExt.tree.TreeNodeUIEventMixin</span></tt></a></li> |
---|
| 144 | <li class="toctree-l2"><a class="reference external" href="GeoExt/widgets/tree/WMSCapabilitiesLoader.html"><tt class="docutils literal"><span class="pre">GeoExt.tree.WMSCapabilitiesLoader</span></tt></a></li> |
---|
| 145 | </ul> |
---|
| 146 | </li> |
---|
| 147 | </ul> |
---|
| 148 | <ul> |
---|
| 149 | <li class="toctree-l1"><a class="reference external" href="GeoExt/data.html"><tt class="docutils literal"><span class="pre">GeoExt.data</span></tt></a><ul> |
---|
| 150 | <li class="toctree-l2"><a class="reference external" href="GeoExt/data/AttributeReader.html"><tt class="docutils literal"><span class="pre">GeoExt.data.AttributeReader</span></tt></a></li> |
---|
| 151 | <li class="toctree-l2"><a class="reference external" href="GeoExt/data/AttributeStore.html"><tt class="docutils literal"><span class="pre">GeoExt.data.AttributeStore</span></tt></a></li> |
---|
| 152 | <li class="toctree-l2"><a class="reference external" href="GeoExt/data/FeatureReader.html"><tt class="docutils literal"><span class="pre">GeoExt.data.FeatureReader</span></tt></a></li> |
---|
| 153 | <li class="toctree-l2"><a class="reference external" href="GeoExt/data/FeatureRecord.html"><tt class="docutils literal"><span class="pre">GeoExt.data.FeatureRecord</span></tt></a></li> |
---|
| 154 | <li class="toctree-l2"><a class="reference external" href="GeoExt/data/FeatureStore.html"><tt class="docutils literal"><span class="pre">GeoExt.data.FeatureStore</span></tt></a></li> |
---|
| 155 | <li class="toctree-l2"><a class="reference external" href="GeoExt/data/LayerReader.html"><tt class="docutils literal"><span class="pre">GeoExt.data.LayerReader</span></tt></a></li> |
---|
| 156 | <li class="toctree-l2"><a class="reference external" href="GeoExt/data/LayerRecord.html"><tt class="docutils literal"><span class="pre">GeoExt.data.LayerRecord</span></tt></a></li> |
---|
| 157 | <li class="toctree-l2"><a class="reference external" href="GeoExt/data/LayerStore.html"><tt class="docutils literal"><span class="pre">GeoExt.data.LayerStore</span></tt></a></li> |
---|
| 158 | <li class="toctree-l2"><a class="reference external" href="GeoExt/data/PrintPage.html"><tt class="docutils literal"><span class="pre">GeoExt.data.PrintPage</span></tt></a></li> |
---|
| 159 | <li class="toctree-l2"><a class="reference external" href="GeoExt/data/PrintProvider.html"><tt class="docutils literal"><span class="pre">GeoExt.data.PrintProvider</span></tt></a></li> |
---|
| 160 | <li class="toctree-l2"><a class="reference external" href="GeoExt/data/ProtocolProxy.html"><tt class="docutils literal"><span class="pre">GeoExt.data.ProtocolProxy</span></tt></a></li> |
---|
| 161 | <li class="toctree-l2"><a class="reference external" href="GeoExt/data/ScaleStore.html"><tt class="docutils literal"><span class="pre">GeoExt.data.ScaleStore</span></tt></a></li> |
---|
| 162 | <li class="toctree-l2"><a class="reference external" href="GeoExt/data/WFSCapabilitiesReader.html"><tt class="docutils literal"><span class="pre">GeoExt.data.WFSCapabilitiesReader</span></tt></a></li> |
---|
| 163 | <li class="toctree-l2"><a class="reference external" href="GeoExt/data/WFSCapabilitiesStore.html"><tt class="docutils literal"><span class="pre">GeoExt.data.WFSCapabilitiesStore</span></tt></a></li> |
---|
| 164 | <li class="toctree-l2"><a class="reference external" href="GeoExt/data/WMCReader.html"><tt class="docutils literal"><span class="pre">GeoExt.data.WMCReader</span></tt></a></li> |
---|
| 165 | <li class="toctree-l2"><a class="reference external" href="GeoExt/data/WMSCapabilitiesReader.html"><tt class="docutils literal"><span class="pre">GeoExt.data.WMSCapabilitiesReader</span></tt></a></li> |
---|
| 166 | <li class="toctree-l2"><a class="reference external" href="GeoExt/data/WMSCapabilitiesStore.html"><tt class="docutils literal"><span class="pre">GeoExt.data.WMSCapabilitiesStore</span></tt></a></li> |
---|
| 167 | <li class="toctree-l2"><a class="reference external" href="GeoExt/data/WMSDescribeLayerReader.html"><tt class="docutils literal"><span class="pre">GeoExt.data.WMSDescribeLayerReader</span></tt></a></li> |
---|
| 168 | <li class="toctree-l2"><a class="reference external" href="GeoExt/data/WMSDescribeLayerStore.html"><tt class="docutils literal"><span class="pre">GeoExt.data.WMSDescribeLayerStore</span></tt></a></li> |
---|
| 169 | </ul> |
---|
| 170 | </li> |
---|
| 171 | </ul> |
---|
| 172 | <ul> |
---|
| 173 | <li class="toctree-l1"><a class="reference external" href="GeoExt/plugins.html"><tt class="docutils literal"><span class="pre">GeoExt.plugins</span></tt></a><ul> |
---|
| 174 | <li class="toctree-l2"><a class="reference external" href="GeoExt/plugins/AttributeForm.html"><tt class="docutils literal"><span class="pre">GeoExt.plugins.AttributeForm</span></tt></a></li> |
---|
| 175 | <li class="toctree-l2"><a class="reference external" href="GeoExt/plugins/PrintExtent.html"><tt class="docutils literal"><span class="pre">GeoExt.plugins.PrintExtent</span></tt></a></li> |
---|
| 176 | <li class="toctree-l2"><a class="reference external" href="GeoExt/plugins/PrintPageField.html"><tt class="docutils literal"><span class="pre">GeoExt.plugins.PrintPageField</span></tt></a></li> |
---|
| 177 | <li class="toctree-l2"><a class="reference external" href="GeoExt/plugins/PrintProviderField.html"><tt class="docutils literal"><span class="pre">GeoExt.plugins.PrintProviderField</span></tt></a></li> |
---|
| 178 | <li class="toctree-l2"><a class="reference external" href="GeoExt/plugins/TreeNodeComponent.html"><tt class="docutils literal"><span class="pre">GeoExt.plugins.TreeNodeComponent</span></tt></a></li> |
---|
| 179 | <li class="toctree-l2"><a class="reference external" href="GeoExt/plugins/TreeNodeRadioButton.html"><tt class="docutils literal"><span class="pre">GeoExt.plugins.TreeNodeRadioButton</span></tt></a></li> |
---|
| 180 | </ul> |
---|
| 181 | </li> |
---|
| 182 | </ul> |
---|
| 183 | <ul> |
---|
| 184 | <li class="toctree-l1"><a class="reference external" href="GeoExt/state.html"><tt class="docutils literal"><span class="pre">GeoExt.state</span></tt></a><ul> |
---|
| 185 | <li class="toctree-l2"><a class="reference external" href="GeoExt/state/PermalinkProvider.html"><tt class="docutils literal"><span class="pre">GeoExt.state.PermalinkProvider</span></tt></a></li> |
---|
| 186 | </ul> |
---|
| 187 | </li> |
---|
| 188 | </ul> |
---|
| 189 | </div> |
---|
| 190 | <div class="section" id="overrides"> |
---|
| 191 | <h2>Overrides<a class="headerlink" href="#overrides" title="Permalink to this headline">¶</a></h2> |
---|
| 192 | <ul> |
---|
| 193 | <li class="toctree-l1"><a class="reference external" href="overrides.html">Ext Overrides</a><ul> |
---|
| 194 | <li class="toctree-l2"><a class="reference external" href="overrides/override-ext-ajax.html">Ext.Ajax Overrides</a></li> |
---|
| 195 | </ul> |
---|
| 196 | </li> |
---|
| 197 | </ul> |
---|
| 198 | </div> |
---|
| 199 | </div> |
---|
| 200 | |
---|
| 201 | |
---|
| 202 | </div> |
---|
| 203 | </div> |
---|
| 204 | </div> |
---|
| 205 | <div class="clearer"></div> |
---|
| 206 | </div> |
---|
| 207 | <div class="related"> |
---|
| 208 | <h3>Navigation</h3> |
---|
| 209 | <ul> |
---|
| 210 | <li class="right" style="margin-right: 10px"> |
---|
| 211 | <a href="../genindex.html" title="General Index" |
---|
| 212 | accesskey="I">index</a></li> |
---|
| 213 | <li class="right" > |
---|
| 214 | <a href="../modindex.html" title="Global Module Index" |
---|
| 215 | accesskey="M">modules</a> |</li> |
---|
| 216 | <li class="right" > |
---|
| 217 | <a href="GeoExt/widgets.html" title="Widgets" |
---|
| 218 | accesskey="N">next</a> |</li> |
---|
| 219 | <li class="right" > |
---|
| 220 | <a href="../developer/index.html" title="GeoExt Community Involvement" |
---|
| 221 | accesskey="P">previous</a> |</li> |
---|
| 222 | <li><a href="../index.html">GeoExt</a> »</li> |
---|
| 223 | <li><a href="#">API Reference</a></li> |
---|
| 224 | </ul> |
---|
| 225 | </div> |
---|
| 226 | |
---|
| 227 | <div class="footer"> |
---|
| 228 | © Copyright 2009-2010, GeoExt Community. |
---|
| 229 | </div> |
---|
| 230 | </body> |
---|
| 231 | </html> |
---|