[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>GeoExt.WMSLegend — 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="up" title="Widgets" href="../widgets.html" /> |
---|
| 25 | <link rel="next" title="GeoExt.ZoomSlider" href="ZoomSlider.html" /> |
---|
| 26 | <link rel="prev" title="GeoExt.VectorLegend" href="VectorLegend.html" /> |
---|
| 27 | |
---|
| 28 | |
---|
| 29 | |
---|
| 30 | |
---|
| 31 | |
---|
| 32 | |
---|
| 33 | </head> |
---|
| 34 | <body> |
---|
| 35 | <div class="header"> |
---|
| 36 | <div class="wrap"> |
---|
| 37 | <h1 id="logo"><a href="../../../index.html">GeoExt</a></h1> |
---|
| 38 | <ul id="top-nav"> |
---|
| 39 | <li class="first"><a href="../../../docs.html">Documentation</a></li> |
---|
| 40 | <li><a href="../../../examples.html">Examples</a></li> |
---|
| 41 | <li><a href="../../../downloads.html">Download</a></li> |
---|
| 42 | <li><a href="http://trac.geoext.org/">Development</a></li> |
---|
| 43 | </ul> |
---|
| 44 | <div id="searchbox"> |
---|
| 45 | <form class="search" action="../../../search.html" method="get"> |
---|
| 46 | <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='';" /> |
---|
| 47 | <input id="searchbox-submit" type="image" value="Search" src="../../../_static/img/search_icon_green.png" /> |
---|
| 48 | <input type="hidden" name="check_keywords" value="yes" /> |
---|
| 49 | <input type="hidden" name="area" value="default" /> |
---|
| 50 | </form> |
---|
| 51 | </div> |
---|
| 52 | </div> |
---|
| 53 | </div> |
---|
| 54 | |
---|
| 55 | <div class="related"> |
---|
| 56 | <h3>Navigation</h3> |
---|
| 57 | <ul> |
---|
| 58 | <li><a href="../../../index.html">GeoExt</a> »</li> |
---|
| 59 | <li><a href="../../index.html" >API Reference</a> »</li> |
---|
| 60 | <li><a href="../widgets.html" accesskey="U">Widgets</a> »</li> |
---|
| 61 | <li><a href="#"><tt class="docutils literal docutils literal"><span class="pre">GeoExt.WMSLegend</span></tt></a></li> |
---|
| 62 | </ul> |
---|
| 63 | </div> |
---|
| 64 | |
---|
| 65 | <div class="sphinxsidebar"> |
---|
| 66 | <div class="sphinxsidebarwrapper"> |
---|
| 67 | <h3><a href="../../../index.html">Table Of Contents</a></h3> |
---|
| 68 | <ul> |
---|
| 69 | <li><a class="reference external" href="#"><tt class="docutils literal"><span class="pre">GeoExt.WMSLegend</span></tt></a><ul> |
---|
| 70 | <li><a class="reference external" href="#config-options">Config Options</a></li> |
---|
| 71 | </ul> |
---|
| 72 | </li> |
---|
| 73 | </ul> |
---|
| 74 | |
---|
| 75 | <h4>Previous topic</h4> |
---|
| 76 | <p class="topless"><a href="VectorLegend.html" |
---|
| 77 | title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">GeoExt.VectorLegend</span></tt></a></p> |
---|
| 78 | <h4>Next topic</h4> |
---|
| 79 | <p class="topless"><a href="ZoomSlider.html" |
---|
| 80 | title="next chapter"><tt class="docutils literal"><span class="pre">GeoExt.ZoomSlider</span></tt></a></p> |
---|
| 81 | </div> |
---|
| 82 | </div> |
---|
| 83 | |
---|
| 84 | |
---|
| 85 | <div class="document"> |
---|
| 86 | <div class="documentwrapper"> |
---|
| 87 | <div class="bodywrapper"> |
---|
| 88 | <div class="body"> |
---|
| 89 | |
---|
| 90 | <div class="section" id="geoext-wmslegend"> |
---|
| 91 | <h1><a title="GeoExt.WMSLegend" class="reference internal" href="#GeoExt.WMSLegend"><tt class="xref docutils literal"><span class="pre">GeoExt.WMSLegend</span></tt></a><a class="headerlink" href="#geoext-wmslegend" title="Permalink to this headline">¶</a></h1> |
---|
| 92 | <dl class="meta docutils"> |
---|
| 93 | <dt>Extends</dt> |
---|
| 94 | <dd><ul class="first last simple"> |
---|
| 95 | <li><a class="reference external" href="http://dev.sencha.com/deploy/dev/docs/?class=Ext.Container">Ext.Container</a></li> |
---|
| 96 | <li><a title="GeoExt.LayerLegend" class="reference external" href="LayerLegend.html#GeoExt.LayerLegend"><tt class="xref docutils literal"><span class="pre">GeoExt.LayerLegend</span></tt></a></li> |
---|
| 97 | </ul> |
---|
| 98 | </dd> |
---|
| 99 | <dt>xtype</dt> |
---|
| 100 | <dd><tt class="docutils literal"><span class="pre">gx_wmslegend</span></tt></dd> |
---|
| 101 | </dl> |
---|
| 102 | <dl class="class"> |
---|
| 103 | <dt id="GeoExt.WMSLegend"> |
---|
| 104 | <em class="property">class </em><tt class="descclassname">GeoExt.</tt><tt class="descname">WMSLegend</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#GeoExt.WMSLegend" title="Permalink to this definition">¶</a></dt> |
---|
| 105 | <dd></dd></dl> |
---|
| 106 | |
---|
| 107 | <p>Show a legend image for a WMS layer. The image can be read from the styles |
---|
| 108 | field of a layer record (if the record comes e.g. from a |
---|
| 109 | <a title="GeoExt.data.WMSCapabilitiesReader" class="reference external" href="../data/WMSCapabilitiesReader.html#GeoExt.data.WMSCapabilitiesReader"><tt class="xref docutils literal"><span class="pre">GeoExt.data.WMSCapabilitiesReader</span></tt></a>). If not provided, a |
---|
| 110 | GetLegendGraphic request will be issued to retrieve the image.</p> |
---|
| 111 | <div class="section" id="config-options"> |
---|
| 112 | <h2>Config Options<a class="headerlink" href="#config-options" title="Permalink to this headline">¶</a></h2> |
---|
| 113 | <p>Configuration properties in addition to |
---|
| 114 | those listed for <a class="reference external" href="http://dev.sencha.com/deploy/dev/docs/?class=Ext.Container">Ext.Container</a>.</p> |
---|
| 115 | <dl class="describe"> |
---|
| 116 | <dt> |
---|
| 117 | <tt class="descname">baseParams</tt></dt> |
---|
| 118 | <dd><dl class="docutils"> |
---|
| 119 | <dt><tt class="docutils literal"><span class="pre">Object</span></tt></dt> |
---|
| 120 | <dd><p class="first">Optional parameters to add to the legend url, this can e.g. be used to |
---|
| 121 | support vendor-specific parameters in a SLD WMS GetLegendGraphic |
---|
| 122 | request. To override the default MIME type of image/gif use the |
---|
| 123 | FORMAT parameter in baseParams.</p> |
---|
| 124 | <div class="last highlight-javascript"><div class="highlight"><pre><span class="kd">var</span> <span class="nx">legendPanel</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">GeoExt</span><span class="p">.</span><span class="nx">LegendPanel</span><span class="p">({</span> |
---|
| 125 | <span class="nx">map</span><span class="o">:</span> <span class="nx">map</span><span class="p">,</span> |
---|
| 126 | <span class="nx">title</span><span class="o">:</span> <span class="s1">'Legend Panel'</span><span class="p">,</span> |
---|
| 127 | <span class="nx">defaults</span><span class="o">:</span> <span class="p">{</span> |
---|
| 128 | <span class="nx">style</span><span class="o">:</span> <span class="s1">'padding:5px'</span><span class="p">,</span> |
---|
| 129 | <span class="nx">baseParams</span><span class="o">:</span> <span class="p">{</span> |
---|
| 130 | <span class="nx">FORMAT</span><span class="o">:</span> <span class="s1">'image/png'</span><span class="p">,</span> |
---|
| 131 | <span class="nx">LEGEND_OPTIONS</span><span class="o">:</span> <span class="s1">'forceLabels:on'</span> |
---|
| 132 | <span class="p">}</span> |
---|
| 133 | <span class="p">}</span> |
---|
| 134 | <span class="p">});</span> |
---|
| 135 | </pre></div> |
---|
| 136 | </div> |
---|
| 137 | </dd> |
---|
| 138 | </dl> |
---|
| 139 | </dd></dl> |
---|
| 140 | |
---|
| 141 | <dl class="describe"> |
---|
| 142 | <dt> |
---|
| 143 | <tt class="descname">defaultStyleIsFirst</tt></dt> |
---|
| 144 | <dd><tt class="docutils literal"><span class="pre">Boolean</span></tt> |
---|
| 145 | The WMS spec does not say if the first style advertised for a layer in |
---|
| 146 | a Capabilities document is the default style that the layer is |
---|
| 147 | rendered with. We make this assumption by default. To be strictly WMS |
---|
| 148 | compliant, set this to false, but make sure to configure a STYLES |
---|
| 149 | param with your WMS layers, otherwise LegendURLs advertised in the |
---|
| 150 | GetCapabilities document cannot be used.</dd></dl> |
---|
| 151 | |
---|
| 152 | <dl class="describe"> |
---|
| 153 | <dt> |
---|
| 154 | <tt class="descname">labelCls</tt></dt> |
---|
| 155 | <dd><tt class="docutils literal"><span class="pre">String</span></tt> |
---|
| 156 | Optional css class to use for the layer title labels.</dd></dl> |
---|
| 157 | |
---|
| 158 | <dl class="describe"> |
---|
| 159 | <dt> |
---|
| 160 | <tt class="descname">layerRecord</tt></dt> |
---|
| 161 | <dd><a title="GeoExt.data.LayerRecord" class="reference external" href="../data/LayerRecord.html#GeoExt.data.LayerRecord"><tt class="xref docutils literal"><span class="pre">GeoExt.data.LayerRecord</span></tt></a> The layer record for the legend</dd></dl> |
---|
| 162 | |
---|
| 163 | <dl class="describe"> |
---|
| 164 | <dt> |
---|
| 165 | <tt class="descname">legendTitle</tt></dt> |
---|
| 166 | <dd><tt class="docutils literal"><span class="pre">String</span></tt> |
---|
| 167 | Optional title to be displayed instead of the layer title. If this is |
---|
| 168 | set, the value of <tt class="docutils literal"><span class="pre">showTitle</span></tt> will be ignored (assumed to be true).</dd></dl> |
---|
| 169 | |
---|
| 170 | <dl class="describe"> |
---|
| 171 | <dt> |
---|
| 172 | <tt class="descname">showTitle</tt></dt> |
---|
| 173 | <dd><tt class="docutils literal"><span class="pre">Boolean</span></tt> |
---|
| 174 | Whether or not to show the title of a layer. This can be overridden |
---|
| 175 | on the LayerStore record using the hideTitle property.</dd></dl> |
---|
| 176 | |
---|
| 177 | <dl class="describe"> |
---|
| 178 | <dt> |
---|
| 179 | <tt class="descname">useScaleParameter</tt></dt> |
---|
| 180 | <dd><tt class="docutils literal"><span class="pre">Boolean</span></tt> |
---|
| 181 | Should we use the optional SCALE parameter in the SLD WMS |
---|
| 182 | GetLegendGraphic request? Defaults to true.</dd></dl> |
---|
| 183 | |
---|
| 184 | </div> |
---|
| 185 | </div> |
---|
| 186 | |
---|
| 187 | |
---|
| 188 | </div> |
---|
| 189 | </div> |
---|
| 190 | </div> |
---|
| 191 | <div class="clearer"></div> |
---|
| 192 | </div> |
---|
| 193 | <div class="related"> |
---|
| 194 | <h3>Navigation</h3> |
---|
| 195 | <ul> |
---|
| 196 | <li class="right" style="margin-right: 10px"> |
---|
| 197 | <a href="../../../genindex.html" title="General Index" |
---|
| 198 | accesskey="I">index</a></li> |
---|
| 199 | <li class="right" > |
---|
| 200 | <a href="../../../modindex.html" title="Global Module Index" |
---|
| 201 | accesskey="M">modules</a> |</li> |
---|
| 202 | <li class="right" > |
---|
| 203 | <a href="ZoomSlider.html" title="GeoExt.ZoomSlider" |
---|
| 204 | accesskey="N">next</a> |</li> |
---|
| 205 | <li class="right" > |
---|
| 206 | <a href="VectorLegend.html" title="GeoExt.VectorLegend" |
---|
| 207 | accesskey="P">previous</a> |</li> |
---|
| 208 | <li><a href="../../../index.html">GeoExt</a> »</li> |
---|
| 209 | <li><a href="../../index.html" >API Reference</a> »</li> |
---|
| 210 | <li><a href="../widgets.html" >Widgets</a> »</li> |
---|
| 211 | <li><a href="#"><tt class="docutils literal docutils literal"><span class="pre">GeoExt.WMSLegend</span></tt></a></li> |
---|
| 212 | </ul> |
---|
| 213 | </div> |
---|
| 214 | |
---|
| 215 | <div class="footer"> |
---|
| 216 | © Copyright 2009-2010, GeoExt Community. |
---|
| 217 | </div> |
---|
| 218 | </body> |
---|
| 219 | </html> |
---|