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.FeatureRenderer — 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.LayerLegend" href="LayerLegend.html" /> |
---|
26 | <link rel="prev" title="GeoExt.Action" href="Action.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.FeatureRenderer</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.FeatureRenderer</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="Action.html" |
---|
79 | title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">GeoExt.Action</span></tt></a></p> |
---|
80 | <h4>Next topic</h4> |
---|
81 | <p class="topless"><a href="LayerLegend.html" |
---|
82 | title="next chapter"><tt class="docutils literal"><span class="pre">GeoExt.LayerLegend</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-featurerenderer"> |
---|
93 | <h1><a title="GeoExt.FeatureRenderer" class="reference internal" href="#GeoExt.FeatureRenderer"><tt class="xref docutils literal"><span class="pre">GeoExt.FeatureRenderer</span></tt></a><a class="headerlink" href="#geoext-featurerenderer" 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.BoxComponent">Ext.BoxComponent</a></li> |
---|
98 | </ul> |
---|
99 | </dd> |
---|
100 | <dt>xtype</dt> |
---|
101 | <dd><tt class="docutils literal"><span class="pre">gx_renderer</span></tt></dd> |
---|
102 | </dl> |
---|
103 | <dl class="class"> |
---|
104 | <dt id="GeoExt.FeatureRenderer"> |
---|
105 | <em class="property">class </em><tt class="descclassname">GeoExt.</tt><tt class="descname">FeatureRenderer</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#GeoExt.FeatureRenderer" title="Permalink to this definition">¶</a></dt> |
---|
106 | <dd>Create a box component for rendering a vector feature.</dd></dl> |
---|
107 | |
---|
108 | <div class="section" id="config-options"> |
---|
109 | <h2>Config Options<a class="headerlink" href="#config-options" title="Permalink to this headline">¶</a></h2> |
---|
110 | <p>Configuration properties in addition to |
---|
111 | those listed for <a class="reference external" href="http://dev.sencha.com/deploy/dev/docs/?class=Ext.BoxComponent">Ext.BoxComponent</a>.</p> |
---|
112 | <dl class="describe"> |
---|
113 | <dt> |
---|
114 | <tt class="descname">feature</tt></dt> |
---|
115 | <dd><tt class="docutils literal"><span class="pre">OpenLayers.Feature.Vector</span></tt> |
---|
116 | Optional vector to be drawn. If not provided, and if <tt class="docutils literal"><span class="pre">symbolizers</span></tt> |
---|
117 | is configured with an array of plain symbolizer objects, <tt class="docutils literal"><span class="pre">symbolType</span></tt> |
---|
118 | should be configured.</dd></dl> |
---|
119 | |
---|
120 | <dl class="describe"> |
---|
121 | <dt> |
---|
122 | <tt class="descname">symbolizers</tt></dt> |
---|
123 | <dd><tt class="docutils literal"><span class="pre">Array(Object)</span></tt> |
---|
124 | An array of <tt class="docutils literal"><span class="pre">OpenLayers.Symbolizer</span></tt> instances or plain symbolizer |
---|
125 | objects (in painters order) for rendering a feature. If no |
---|
126 | symbolizers are provided, the OpenLayers default will be used. If a |
---|
127 | symbolizer is an instance of <tt class="docutils literal"><span class="pre">OpenLayers.Symbolizer</span></tt>, its type will |
---|
128 | override the symbolType for rendering.</dd></dl> |
---|
129 | |
---|
130 | <dl class="describe"> |
---|
131 | <dt> |
---|
132 | <tt class="descname">symbolType</tt></dt> |
---|
133 | <dd><tt class="docutils literal"><span class="pre">String</span></tt> |
---|
134 | One of <tt class="docutils literal"><span class="pre">"Point"</span></tt>, <tt class="docutils literal"><span class="pre">"Line"</span></tt>, or <tt class="docutils literal"><span class="pre">"Polygon"</span></tt>. Only pertinent if |
---|
135 | OpenLayers.Symbolizer objects are not used. If <tt class="docutils literal"><span class="pre">feature</span></tt> |
---|
136 | is provided, it will be preferred. The default is “Polygon”.</dd></dl> |
---|
137 | |
---|
138 | </div> |
---|
139 | <div class="section" id="public-methods"> |
---|
140 | <h2>Public Methods<a class="headerlink" href="#public-methods" title="Permalink to this headline">¶</a></h2> |
---|
141 | <p>Public methods in addition to those |
---|
142 | listed for <a class="reference external" href="http://dev.sencha.com/deploy/dev/docs/?class=Ext.BoxComponent">Ext.BoxComponent</a>.</p> |
---|
143 | <dl class="method"> |
---|
144 | <dt id="GeoExt.FeatureRenderer.setFeature"> |
---|
145 | <tt class="descclassname">FeatureRenderer.</tt><tt class="descname">setFeature</tt><big>(</big><big>)</big><a class="headerlink" href="#GeoExt.FeatureRenderer.setFeature" title="Permalink to this definition">¶</a></dt> |
---|
146 | <dd><table class="docutils field-list" frame="void" rules="none"> |
---|
147 | <col class="field-name" /> |
---|
148 | <col class="field-body" /> |
---|
149 | <tbody valign="top"> |
---|
150 | <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
151 | <li><em>feature</em> – <tt class="docutils literal"><span class="pre">OpenLayers.Feature.Vector</span></tt> The feature to be rendered. |
---|
152 | If none is provided, one will be created based on <tt class="docutils literal"><span class="pre">symbolType</span></tt>.</li> |
---|
153 | <li><em>options</em> – <tt class="docutils literal"><span class="pre">Object</span></tt></li> |
---|
154 | </ul> |
---|
155 | </td> |
---|
156 | </tr> |
---|
157 | </tbody> |
---|
158 | </table> |
---|
159 | <p>Update the feature and redraw.</p> |
---|
160 | <p>Valid options:</p> |
---|
161 | <ul class="simple"> |
---|
162 | <li>draw - <tt class="docutils literal"><span class="pre">Boolean</span></tt> Draw the feature after setting it. Default is <tt class="docutils literal"><span class="pre">true</span></tt>.</li> |
---|
163 | </ul> |
---|
164 | </dd></dl> |
---|
165 | |
---|
166 | <dl class="method"> |
---|
167 | <dt id="GeoExt.FeatureRenderer.setSymbolizers"> |
---|
168 | <tt class="descclassname">FeatureRenderer.</tt><tt class="descname">setSymbolizers</tt><big>(</big><big>)</big><a class="headerlink" href="#GeoExt.FeatureRenderer.setSymbolizers" title="Permalink to this definition">¶</a></dt> |
---|
169 | <dd><table class="docutils field-list" frame="void" rules="none"> |
---|
170 | <col class="field-name" /> |
---|
171 | <col class="field-body" /> |
---|
172 | <tbody valign="top"> |
---|
173 | <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
174 | <li><em>symbolizers</em> – <tt class="docutils literal"><span class="pre">Array(Object)</span></tt> An array of symbolizers</li> |
---|
175 | <li><em>options</em> – <tt class="docutils literal"><span class="pre">Object</span></tt></li> |
---|
176 | </ul> |
---|
177 | </td> |
---|
178 | </tr> |
---|
179 | </tbody> |
---|
180 | </table> |
---|
181 | <p>Update the symbolizers used to render the feature.</p> |
---|
182 | <p>Valid options:</p> |
---|
183 | <ul class="simple"> |
---|
184 | <li>draw - <tt class="docutils literal"><span class="pre">Boolean</span></tt> Draw the feature after setting it. Default is <tt class="docutils literal"><span class="pre">true</span></tt>.</li> |
---|
185 | </ul> |
---|
186 | </dd></dl> |
---|
187 | |
---|
188 | <dl class="method"> |
---|
189 | <dt id="GeoExt.FeatureRenderer.setSymbolType"> |
---|
190 | <tt class="descclassname">FeatureRenderer.</tt><tt class="descname">setSymbolType</tt><big>(</big><big>)</big><a class="headerlink" href="#GeoExt.FeatureRenderer.setSymbolType" title="Permalink to this definition">¶</a></dt> |
---|
191 | <dd><table class="docutils field-list" frame="void" rules="none"> |
---|
192 | <col class="field-name" /> |
---|
193 | <col class="field-body" /> |
---|
194 | <tbody valign="top"> |
---|
195 | <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
196 | <li><em>type</em> – <tt class="docutils literal"><span class="pre">String</span></tt> One of the <tt class="docutils literal"><span class="pre">symbolType</span></tt> strings.</li> |
---|
197 | <li><em>options</em> – <tt class="docutils literal"><span class="pre">Object</span></tt></li> |
---|
198 | </ul> |
---|
199 | </td> |
---|
200 | </tr> |
---|
201 | </tbody> |
---|
202 | </table> |
---|
203 | <p>Create a new feature based on the geometry type and render it.</p> |
---|
204 | <p>Valid options:</p> |
---|
205 | <ul class="simple"> |
---|
206 | <li>draw - <tt class="docutils literal"><span class="pre">Boolean</span></tt> Draw the feature after setting it. Default is <tt class="docutils literal"><span class="pre">true</span></tt>.</li> |
---|
207 | </ul> |
---|
208 | </dd></dl> |
---|
209 | |
---|
210 | <dl class="method"> |
---|
211 | <dt id="GeoExt.FeatureRenderer.update"> |
---|
212 | <tt class="descclassname">FeatureRenderer.</tt><tt class="descname">update</tt><big>(</big><big>)</big><a class="headerlink" href="#GeoExt.FeatureRenderer.update" title="Permalink to this definition">¶</a></dt> |
---|
213 | <dd><table class="docutils field-list" frame="void" rules="none"> |
---|
214 | <col class="field-name" /> |
---|
215 | <col class="field-body" /> |
---|
216 | <tbody valign="top"> |
---|
217 | <tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>options</em> – <tt class="docutils literal"><span class="pre">Object</span></tt> Object with properties to be updated.</td> |
---|
218 | </tr> |
---|
219 | </tbody> |
---|
220 | </table> |
---|
221 | <p>Update the <tt class="docutils literal"><span class="pre">symbolType</span></tt> or <tt class="docutils literal"><span class="pre">feature</span></tt> and <tt class="docutils literal"><span class="pre">symbolizer</span></tt> and redraw |
---|
222 | the feature.</p> |
---|
223 | <p>Valid options:</p> |
---|
224 | <ul> |
---|
225 | <li><dl class="first docutils"> |
---|
226 | <dt>feature - <tt class="docutils literal"><span class="pre">OpenLayers.Feature.Vector</span></tt> The new or updated feature.</dt> |
---|
227 | <dd><p class="first last">If provided, the feature gets precedence over <tt class="docutils literal"><span class="pre">symbolType</span></tt>.</p> |
---|
228 | </dd> |
---|
229 | </dl> |
---|
230 | </li> |
---|
231 | <li><p class="first">symbolType - <tt class="docutils literal"><span class="pre">String</span></tt> One of the allowed <tt class="docutils literal"><span class="pre">symbolType</span></tt> values.</p> |
---|
232 | </li> |
---|
233 | <li><p class="first">symbolizers - <tt class="docutils literal"><span class="pre">Array(Object)</span></tt> An array of symbolizer objects.</p> |
---|
234 | </li> |
---|
235 | </ul> |
---|
236 | </dd></dl> |
---|
237 | |
---|
238 | </div> |
---|
239 | <div class="section" id="events"> |
---|
240 | <h2>Events<a class="headerlink" href="#events" title="Permalink to this headline">¶</a></h2> |
---|
241 | <p>Events in addition to those |
---|
242 | listed for <a class="reference external" href="http://dev.sencha.com/deploy/dev/docs/?class=Ext.BoxComponent">Ext.BoxComponent</a>.</p> |
---|
243 | <dl class="describe"> |
---|
244 | <dt> |
---|
245 | <tt class="descname">click</tt></dt> |
---|
246 | <dd><p>Fires when the feature is clicked on.</p> |
---|
247 | <p>Listener arguments:</p> |
---|
248 | <ul class="simple"> |
---|
249 | <li>renderer - <a title="GeoExt.FeatureRenderer" class="reference internal" href="#GeoExt.FeatureRenderer"><tt class="xref docutils literal"><span class="pre">GeoExt.FeatureRenderer</span></tt></a> This feature renderer.</li> |
---|
250 | </ul> |
---|
251 | </dd></dl> |
---|
252 | |
---|
253 | </div> |
---|
254 | </div> |
---|
255 | |
---|
256 | |
---|
257 | </div> |
---|
258 | </div> |
---|
259 | </div> |
---|
260 | <div class="clearer"></div> |
---|
261 | </div> |
---|
262 | <div class="related"> |
---|
263 | <h3>Navigation</h3> |
---|
264 | <ul> |
---|
265 | <li class="right" style="margin-right: 10px"> |
---|
266 | <a href="../../../genindex.html" title="General Index" |
---|
267 | accesskey="I">index</a></li> |
---|
268 | <li class="right" > |
---|
269 | <a href="../../../modindex.html" title="Global Module Index" |
---|
270 | accesskey="M">modules</a> |</li> |
---|
271 | <li class="right" > |
---|
272 | <a href="LayerLegend.html" title="GeoExt.LayerLegend" |
---|
273 | accesskey="N">next</a> |</li> |
---|
274 | <li class="right" > |
---|
275 | <a href="Action.html" title="GeoExt.Action" |
---|
276 | accesskey="P">previous</a> |</li> |
---|
277 | <li><a href="../../../index.html">GeoExt</a> »</li> |
---|
278 | <li><a href="../../index.html" >API Reference</a> »</li> |
---|
279 | <li><a href="../widgets.html" >Widgets</a> »</li> |
---|
280 | <li><a href="#"><tt class="docutils literal docutils literal"><span class="pre">GeoExt.FeatureRenderer</span></tt></a></li> |
---|
281 | </ul> |
---|
282 | </div> |
---|
283 | |
---|
284 | <div class="footer"> |
---|
285 | © Copyright 2009-2010, GeoExt Community. |
---|
286 | </div> |
---|
287 | </body> |
---|
288 | </html> |
---|