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.VectorLegend — 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.WMSLegend" href="WMSLegend.html" /> |
---|
26 | <link rel="prev" title="GeoExt.UrlLegend" href="UrlLegend.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.VectorLegend</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.VectorLegend</span></tt></a><ul> |
---|
70 | <li><a class="reference external" href="#config-options">Config Options</a></li> |
---|
71 | <li><a class="reference external" href="#public-methods">Public Methods</a></li> |
---|
72 | <li><a class="reference external" href="#events">Events</a></li> |
---|
73 | </ul> |
---|
74 | </li> |
---|
75 | </ul> |
---|
76 | |
---|
77 | <h4>Previous topic</h4> |
---|
78 | <p class="topless"><a href="UrlLegend.html" |
---|
79 | title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">GeoExt.UrlLegend</span></tt></a></p> |
---|
80 | <h4>Next topic</h4> |
---|
81 | <p class="topless"><a href="WMSLegend.html" |
---|
82 | title="next chapter"><tt class="docutils literal"><span class="pre">GeoExt.WMSLegend</span></tt></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="geoext-vectorlegend"> |
---|
93 | <h1><a title="GeoExt.VectorLegend" class="reference internal" href="#GeoExt.VectorLegend"><tt class="xref docutils literal"><span class="pre">GeoExt.VectorLegend</span></tt></a><a class="headerlink" href="#geoext-vectorlegend" title="Permalink to this headline">¶</a></h1> |
---|
94 | <dl class="meta docutils"> |
---|
95 | <dt>Extends</dt> |
---|
96 | <dd><ul class="first last simple"> |
---|
97 | <li><a class="reference external" href="http://dev.sencha.com/deploy/dev/docs/?class=Ext.Container">Ext.Container</a></li> |
---|
98 | <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> |
---|
99 | </ul> |
---|
100 | </dd> |
---|
101 | <dt>xtype</dt> |
---|
102 | <dd><tt class="docutils literal"><span class="pre">gx_vectorlegend</span></tt></dd> |
---|
103 | </dl> |
---|
104 | <dl class="class"> |
---|
105 | <dt id="GeoExt.VectorLegend"> |
---|
106 | <em class="property">class </em><tt class="descclassname">GeoExt.</tt><tt class="descname">VectorLegend</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#GeoExt.VectorLegend" title="Permalink to this definition">¶</a></dt> |
---|
107 | <dd>Create a vector legend.</dd></dl> |
---|
108 | |
---|
109 | <div class="section" id="config-options"> |
---|
110 | <h2>Config Options<a class="headerlink" href="#config-options" title="Permalink to this headline">¶</a></h2> |
---|
111 | <p>Configuration properties in addition to |
---|
112 | those listed for <a class="reference external" href="http://dev.sencha.com/deploy/dev/docs/?class=Ext.Container">Ext.Container</a>.</p> |
---|
113 | <dl class="describe"> |
---|
114 | <dt> |
---|
115 | <tt class="descname">bodyBorder</tt></dt> |
---|
116 | <dd><tt class="docutils literal"><span class="pre">Boolean</span></tt> |
---|
117 | Show a border around the legend panel. Default is <tt class="docutils literal"><span class="pre">false</span></tt>.</dd></dl> |
---|
118 | |
---|
119 | <dl class="describe"> |
---|
120 | <dt> |
---|
121 | <tt class="descname">clickableSymbol</tt></dt> |
---|
122 | <dd><tt class="docutils literal"><span class="pre">Boolean</span></tt> |
---|
123 | Set cursor style to “pointer” for symbolizers. Register for |
---|
124 | the <tt class="docutils literal"><span class="pre">symbolclick</span></tt> event to handle clicks. Note that click events |
---|
125 | are fired regardless of this value. If <tt class="docutils literal"><span class="pre">false</span></tt>, no cursor style will |
---|
126 | be set. Default is <tt class="docutils literal"><span class="pre">false</span></tt>.</dd></dl> |
---|
127 | |
---|
128 | <dl class="describe"> |
---|
129 | <dt> |
---|
130 | <tt class="descname">clickableTitle</tt></dt> |
---|
131 | <dd><tt class="docutils literal"><span class="pre">Boolean</span></tt> |
---|
132 | Set cursor style to “pointer” for rule titles. Register for |
---|
133 | the <tt class="docutils literal"><span class="pre">titleclick</span></tt> event to handle clicks. Note that click events |
---|
134 | are fired regardless of this value. If <tt class="docutils literal"><span class="pre">false</span></tt>, no cursor style will |
---|
135 | be set. Default is <tt class="docutils literal"><span class="pre">false</span></tt>.</dd></dl> |
---|
136 | |
---|
137 | <dl class="describe"> |
---|
138 | <dt> |
---|
139 | <tt class="descname">enableDD</tt></dt> |
---|
140 | <dd><tt class="docutils literal"><span class="pre">Boolean</span></tt> |
---|
141 | Allow drag and drop of rules. Default is <tt class="docutils literal"><span class="pre">false</span></tt>.</dd></dl> |
---|
142 | |
---|
143 | <dl class="describe"> |
---|
144 | <dt> |
---|
145 | <tt class="descname">labelCls</tt></dt> |
---|
146 | <dd><tt class="docutils literal"><span class="pre">String</span></tt> |
---|
147 | Optional css class to use for the layer title labels.</dd></dl> |
---|
148 | |
---|
149 | <dl class="describe"> |
---|
150 | <dt> |
---|
151 | <tt class="descname">layer</tt></dt> |
---|
152 | <dd><tt class="docutils literal"><span class="pre">OpenLayers.Layer.Vector</span></tt> |
---|
153 | The layer that this legend will be based on. One of <tt class="docutils literal"><span class="pre">layer</span></tt>, |
---|
154 | <tt class="docutils literal"><span class="pre">rules</span></tt>, or <tt class="docutils literal"><span class="pre">layerRecord</span></tt> must be specified in the config.</dd></dl> |
---|
155 | |
---|
156 | <dl class="describe"> |
---|
157 | <dt> |
---|
158 | <tt class="descname">layerRecord</tt></dt> |
---|
159 | <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> |
---|
160 | The record containing a vector layer that this legend will be based on. |
---|
161 | One of <tt class="docutils literal"><span class="pre">layerRecord</span></tt>, <tt class="docutils literal"><span class="pre">layer</span></tt>, or <tt class="docutils literal"><span class="pre">rules</span></tt> must be specified in |
---|
162 | the config.</dd></dl> |
---|
163 | |
---|
164 | <dl class="describe"> |
---|
165 | <dt> |
---|
166 | <tt class="descname">legendTitle</tt></dt> |
---|
167 | <dd><tt class="docutils literal"><span class="pre">String</span></tt> |
---|
168 | Optional title to be displayed instead of the layer title. If this is |
---|
169 | set, the value of <tt class="docutils literal"><span class="pre">showTitle</span></tt> will be ignored (assumed to be true).</dd></dl> |
---|
170 | |
---|
171 | <dl class="describe"> |
---|
172 | <dt> |
---|
173 | <tt class="descname">rules</tt></dt> |
---|
174 | <dd><dl class="docutils"> |
---|
175 | <dt><tt class="docutils literal"><span class="pre">Array(OpenLayers.Rule)</span></tt></dt> |
---|
176 | <dd>List of rules. One of <tt class="docutils literal"><span class="pre">rules</span></tt>, <tt class="docutils literal"><span class="pre">layer</span></tt>, or <tt class="docutils literal"><span class="pre">layerRecord</span></tt> must be |
---|
177 | specified in the config. The <tt class="docutils literal"><span class="pre">symbolType</span></tt> property must also be |
---|
178 | provided if only <tt class="docutils literal"><span class="pre">rules</span></tt> are given in the config.</dd> |
---|
179 | </dl> |
---|
180 | </dd></dl> |
---|
181 | |
---|
182 | <dl class="describe"> |
---|
183 | <dt> |
---|
184 | <tt class="descname">selectOnClick</tt></dt> |
---|
185 | <dd><tt class="docutils literal"><span class="pre">Boolean</span></tt> |
---|
186 | Set to true if a rule should be selected by clicking on the |
---|
187 | symbol or title. Selection will trigger the ruleselected event, and |
---|
188 | a click on a selected rule will unselect it and trigger the |
---|
189 | <tt class="docutils literal"><span class="pre">ruleunselected</span></tt> event. Default is <tt class="docutils literal"><span class="pre">false</span></tt>.</dd></dl> |
---|
190 | |
---|
191 | <dl class="describe"> |
---|
192 | <dt> |
---|
193 | <tt class="descname">showTitle</tt></dt> |
---|
194 | <dd><tt class="docutils literal"><span class="pre">Boolean</span></tt> |
---|
195 | Whether or not to show the title of a layer. This can be overridden |
---|
196 | on the LayerStore record using the hideTitle property.</dd></dl> |
---|
197 | |
---|
198 | <dl class="describe"> |
---|
199 | <dt> |
---|
200 | <tt class="descname">symbolType</tt></dt> |
---|
201 | <dd><tt class="docutils literal"><span class="pre">String</span></tt> |
---|
202 | The symbol type for legend swatches. Must be one of <tt class="docutils literal"><span class="pre">"Point"</span></tt>, |
---|
203 | <tt class="docutils literal"><span class="pre">"Line"</span></tt>, or <tt class="docutils literal"><span class="pre">"Polygon"</span></tt>. If not provided, the <tt class="docutils literal"><span class="pre">layer</span></tt> or |
---|
204 | <tt class="docutils literal"><span class="pre">layerRecord</span></tt> config property must be specified, and the geometry type |
---|
205 | of the first feature found on the layer will be used. If a rule does |
---|
206 | not have a symbolizer for <tt class="docutils literal"><span class="pre">symbolType</span></tt>, we look at the symbolizers |
---|
207 | for the rule, and see if it has a <tt class="docutils literal"><span class="pre">"Point"</span></tt>, <tt class="docutils literal"><span class="pre">"Line"</span></tt> or |
---|
208 | <tt class="docutils literal"><span class="pre">"Polygon"</span></tt> symbolizer, which we use for rendering a swatch of the |
---|
209 | respective geometry type.</dd></dl> |
---|
210 | |
---|
211 | <dl class="describe"> |
---|
212 | <dt> |
---|
213 | <tt class="descname">untitledPrefix</tt></dt> |
---|
214 | <dd><tt class="docutils literal"><span class="pre">String</span></tt> |
---|
215 | The prefix to use as a title for rules with no title or |
---|
216 | name. Default is <tt class="docutils literal"><span class="pre">"Untitled</span> <span class="pre">"</span></tt>. Prefix will be appended with a |
---|
217 | number that corresponds to the index of the rule (1 for first rule).</dd></dl> |
---|
218 | |
---|
219 | </div> |
---|
220 | <div class="section" id="public-methods"> |
---|
221 | <h2>Public Methods<a class="headerlink" href="#public-methods" title="Permalink to this headline">¶</a></h2> |
---|
222 | <p>Public methods in addition to those |
---|
223 | listed for <a class="reference external" href="http://dev.sencha.com/deploy/dev/docs/?class=Ext.Container">Ext.Container</a>.</p> |
---|
224 | <dl class="method"> |
---|
225 | <dt id="GeoExt.VectorLegend.setCurrentScaleDenominator"> |
---|
226 | <tt class="descclassname">VectorLegend.</tt><tt class="descname">setCurrentScaleDenominator</tt><big>(</big><big>)</big><a class="headerlink" href="#GeoExt.VectorLegend.setCurrentScaleDenominator" title="Permalink to this definition">¶</a></dt> |
---|
227 | <dd><table class="docutils field-list" frame="void" rules="none"> |
---|
228 | <col class="field-name" /> |
---|
229 | <col class="field-body" /> |
---|
230 | <tbody valign="top"> |
---|
231 | <tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>scale</em> – <tt class="docutils literal"><span class="pre">Number</span></tt> The scale denominator.</td> |
---|
232 | </tr> |
---|
233 | </tbody> |
---|
234 | </table> |
---|
235 | <p>Set the current scale denominator. This will hide entries for any |
---|
236 | rules that don’t apply at the current scale.</p> |
---|
237 | </dd></dl> |
---|
238 | |
---|
239 | <dl class="method"> |
---|
240 | <dt id="GeoExt.VectorLegend.update"> |
---|
241 | <tt class="descclassname">VectorLegend.</tt><tt class="descname">update</tt><big>(</big><big>)</big><a class="headerlink" href="#GeoExt.VectorLegend.update" title="Permalink to this definition">¶</a></dt> |
---|
242 | <dd>Update rule titles and symbolizers.</dd></dl> |
---|
243 | |
---|
244 | </div> |
---|
245 | <div class="section" id="events"> |
---|
246 | <h2>Events<a class="headerlink" href="#events" title="Permalink to this headline">¶</a></h2> |
---|
247 | <p>Events in addition to those |
---|
248 | listed for <a class="reference external" href="http://dev.sencha.com/deploy/dev/docs/?class=Ext.Container">Ext.Container</a>.</p> |
---|
249 | <dl class="describe"> |
---|
250 | <dt> |
---|
251 | <tt class="descname">ruleclick</tt></dt> |
---|
252 | <dd><p>Fires when a rule entry is clicked (fired with symbolizer or |
---|
253 | title click).</p> |
---|
254 | <p>Listener arguments:</p> |
---|
255 | <ul class="simple"> |
---|
256 | <li>comp - <tt class="xref docutils literal"><span class="pre">GeoExt.VectorLegend`</span></tt> This component.</li> |
---|
257 | <li>rule - <tt class="docutils literal"><span class="pre">OpenLayers.Rule</span></tt> The rule that was clicked.</li> |
---|
258 | </ul> |
---|
259 | </dd></dl> |
---|
260 | |
---|
261 | <dl class="describe"> |
---|
262 | <dt> |
---|
263 | <tt class="descname">rulemoved</tt></dt> |
---|
264 | <dd><p>Fires when a rule is moved.</p> |
---|
265 | <p>Listener arguments:</p> |
---|
266 | <ul class="simple"> |
---|
267 | <li>comp - <tt class="xref docutils literal"><span class="pre">GeoExt.VectorLegend`</span></tt> This component.</li> |
---|
268 | <li>rule - <tt class="docutils literal"><span class="pre">OpenLayers.Rule</span></tt> The rule that was moved.</li> |
---|
269 | </ul> |
---|
270 | </dd></dl> |
---|
271 | |
---|
272 | <dl class="describe"> |
---|
273 | <dt> |
---|
274 | <tt class="descname">ruleselected</tt></dt> |
---|
275 | <dd><p>Fires when a rule is clicked and <tt class="docutils literal"><span class="pre">selectOnClick</span></tt> is set to |
---|
276 | <tt class="docutils literal"><span class="pre">true</span></tt>.</p> |
---|
277 | <p>Listener arguments:</p> |
---|
278 | <ul class="simple"> |
---|
279 | <li>comp - <tt class="xref docutils literal"><span class="pre">GeoExt.VectorLegend`</span></tt> This component.</li> |
---|
280 | <li>rule - <tt class="docutils literal"><span class="pre">OpenLayers.Rule</span></tt> The rule that was selected.</li> |
---|
281 | </ul> |
---|
282 | </dd></dl> |
---|
283 | |
---|
284 | <dl class="describe"> |
---|
285 | <dt> |
---|
286 | <tt class="descname">ruleunselected</tt></dt> |
---|
287 | <dd><p>Fires when the selected rule is clicked and <tt class="docutils literal"><span class="pre">selectOnClick</span></tt> |
---|
288 | is set to <tt class="docutils literal"><span class="pre">true</span></tt>, or when a rule is unselected by selecting a |
---|
289 | different one.</p> |
---|
290 | <p>Listener arguments:</p> |
---|
291 | <ul class="simple"> |
---|
292 | <li>comp - <tt class="xref docutils literal"><span class="pre">GeoExt.VectorLegend`</span></tt> This component.</li> |
---|
293 | <li>rule - <tt class="docutils literal"><span class="pre">OpenLayers.Rule</span></tt> The rule that was unselected.</li> |
---|
294 | </ul> |
---|
295 | </dd></dl> |
---|
296 | |
---|
297 | <dl class="describe"> |
---|
298 | <dt> |
---|
299 | <tt class="descname">symbolclick</tt></dt> |
---|
300 | <dd><p>Fires when a rule symbolizer is clicked.</p> |
---|
301 | <p>Listener arguments:</p> |
---|
302 | <ul class="simple"> |
---|
303 | <li>comp - <tt class="xref docutils literal"><span class="pre">GeoExt.VectorLegend`</span></tt> This component.</li> |
---|
304 | <li>rule - <tt class="docutils literal"><span class="pre">OpenLayers.Rule</span></tt> The rule whose symbol was clicked.</li> |
---|
305 | </ul> |
---|
306 | </dd></dl> |
---|
307 | |
---|
308 | <dl class="describe"> |
---|
309 | <dt> |
---|
310 | <tt class="descname">titleclick</tt></dt> |
---|
311 | <dd><p>Fires when a rule title is clicked.</p> |
---|
312 | <p>Listener arguments:</p> |
---|
313 | <ul class="simple"> |
---|
314 | <li>comp - <tt class="xref docutils literal"><span class="pre">GeoExt.VectorLegend`</span></tt> This component.</li> |
---|
315 | <li>rule - <tt class="docutils literal"><span class="pre">OpenLayers.Rule</span></tt> The rule whose title was clicked.</li> |
---|
316 | </ul> |
---|
317 | </dd></dl> |
---|
318 | |
---|
319 | </div> |
---|
320 | </div> |
---|
321 | |
---|
322 | |
---|
323 | </div> |
---|
324 | </div> |
---|
325 | </div> |
---|
326 | <div class="clearer"></div> |
---|
327 | </div> |
---|
328 | <div class="related"> |
---|
329 | <h3>Navigation</h3> |
---|
330 | <ul> |
---|
331 | <li class="right" style="margin-right: 10px"> |
---|
332 | <a href="../../../genindex.html" title="General Index" |
---|
333 | accesskey="I">index</a></li> |
---|
334 | <li class="right" > |
---|
335 | <a href="../../../modindex.html" title="Global Module Index" |
---|
336 | accesskey="M">modules</a> |</li> |
---|
337 | <li class="right" > |
---|
338 | <a href="WMSLegend.html" title="GeoExt.WMSLegend" |
---|
339 | accesskey="N">next</a> |</li> |
---|
340 | <li class="right" > |
---|
341 | <a href="UrlLegend.html" title="GeoExt.UrlLegend" |
---|
342 | accesskey="P">previous</a> |</li> |
---|
343 | <li><a href="../../../index.html">GeoExt</a> »</li> |
---|
344 | <li><a href="../../index.html" >API Reference</a> »</li> |
---|
345 | <li><a href="../widgets.html" >Widgets</a> »</li> |
---|
346 | <li><a href="#"><tt class="docutils literal docutils literal"><span class="pre">GeoExt.VectorLegend</span></tt></a></li> |
---|
347 | </ul> |
---|
348 | </div> |
---|
349 | |
---|
350 | <div class="footer"> |
---|
351 | © Copyright 2009-2010, GeoExt Community. |
---|
352 | </div> |
---|
353 | </body> |
---|
354 | </html> |
---|