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.data.PrintPage — 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="GeoExt.data" href="../data.html" /> |
---|
25 | <link rel="next" title="GeoExt.data.PrintProvider" href="PrintProvider.html" /> |
---|
26 | <link rel="prev" title="GeoExt.data.LayerStore" href="LayerStore.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="../data.html" accesskey="U"><tt class="docutils literal docutils literal docutils literal docutils literal docutils literal docutils literal docutils literal docutils literal docutils literal docutils literal docutils literal"><span class="pre">GeoExt.data</span></tt></a> »</li> |
---|
61 | <li><a href="#"><tt class="docutils literal docutils literal"><span class="pre">GeoExt.data.PrintPage</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.data.PrintPage</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-properties">Public Properties</a></li> |
---|
72 | <li><a class="reference external" href="#public-methods">Public Methods</a></li> |
---|
73 | <li><a class="reference external" href="#events">Events</a></li> |
---|
74 | </ul> |
---|
75 | </li> |
---|
76 | </ul> |
---|
77 | |
---|
78 | <h4>Previous topic</h4> |
---|
79 | <p class="topless"><a href="LayerStore.html" |
---|
80 | title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">GeoExt.data.LayerStore</span></tt></a></p> |
---|
81 | <h4>Next topic</h4> |
---|
82 | <p class="topless"><a href="PrintProvider.html" |
---|
83 | title="next chapter"><tt class="docutils literal"><span class="pre">GeoExt.data.PrintProvider</span></tt></a></p> |
---|
84 | </div> |
---|
85 | </div> |
---|
86 | |
---|
87 | |
---|
88 | <div class="document"> |
---|
89 | <div class="documentwrapper"> |
---|
90 | <div class="bodywrapper"> |
---|
91 | <div class="body"> |
---|
92 | |
---|
93 | <div class="section" id="geoext-data-printpage"> |
---|
94 | <h1><a title="GeoExt.data.PrintPage" class="reference internal" href="#GeoExt.data.PrintPage"><tt class="xref docutils literal"><span class="pre">GeoExt.data.PrintPage</span></tt></a><a class="headerlink" href="#geoext-data-printpage" title="Permalink to this headline">¶</a></h1> |
---|
95 | <dl class="meta docutils"> |
---|
96 | <dt>Extends</dt> |
---|
97 | <dd><ul class="first last simple"> |
---|
98 | <li><a class="reference external" href="http://dev.sencha.com/deploy/dev/docs/?class=Ext.util.Observable">Ext.util.Observable</a></li> |
---|
99 | </ul> |
---|
100 | </dd> |
---|
101 | </dl> |
---|
102 | <dl class="class"> |
---|
103 | <dt id="GeoExt.data.PrintPage"> |
---|
104 | <em class="property">class </em><tt class="descclassname">GeoExt.data.</tt><tt class="descname">PrintPage</tt><a class="headerlink" href="#GeoExt.data.PrintPage" title="Permalink to this definition">¶</a></dt> |
---|
105 | <dd></dd></dl> |
---|
106 | |
---|
107 | <p>Provides a representation of a print page for |
---|
108 | <a title="GeoExt.data.PrintProvider" class="reference external" href="PrintProvider.html#GeoExt.data.PrintProvider"><tt class="xref docutils literal"><span class="pre">GeoExt.data.PrintProvider</span></tt></a>. The extent of the page is stored as |
---|
109 | <tt class="docutils literal"><span class="pre">OpenLayers.Feature.Vector</span></tt>. Widgets can use this to display the print |
---|
110 | extent on the map.</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.util.Observable">Ext.util.Observable</a>.</p> |
---|
115 | <dl class="describe"> |
---|
116 | <dt> |
---|
117 | <tt class="descname">customParams</tt></dt> |
---|
118 | <dd><tt class="docutils literal"><span class="pre">Object</span></tt> Key-value pairs of additional parameters that the |
---|
119 | printProvider will send to the print service for this page.</dd></dl> |
---|
120 | |
---|
121 | <dl class="describe"> |
---|
122 | <dt> |
---|
123 | <tt class="descname">printProvider</tt></dt> |
---|
124 | <dd><a title="GeoExt.data.PrintProvider" class="reference external" href="PrintProvider.html#GeoExt.data.PrintProvider"><tt class="xref docutils literal"><span class="pre">GeoExt.data.PrintProvider</span></tt></a> The print provider to use with |
---|
125 | this page.</dd></dl> |
---|
126 | |
---|
127 | </div> |
---|
128 | <div class="section" id="public-properties"> |
---|
129 | <h2>Public Properties<a class="headerlink" href="#public-properties" title="Permalink to this headline">¶</a></h2> |
---|
130 | <p>Public properties in addition to those |
---|
131 | listed for <a class="reference external" href="http://dev.sencha.com/deploy/dev/docs/?class=Ext.util.Observable">Ext.util.Observable</a>.</p> |
---|
132 | <dl class="attribute"> |
---|
133 | <dt id="GeoExt.data.PrintPage.center"> |
---|
134 | <tt class="descclassname">PrintPage.</tt><tt class="descname">center</tt><a class="headerlink" href="#GeoExt.data.PrintPage.center" title="Permalink to this definition">¶</a></dt> |
---|
135 | <dd><tt class="docutils literal"><span class="pre">OpenLayers.LonLat</span></tt> The current center of the page. Read-only.</dd></dl> |
---|
136 | |
---|
137 | <dl class="attribute"> |
---|
138 | <dt id="GeoExt.data.PrintPage.customParams"> |
---|
139 | <tt class="descclassname">PrintPage.</tt><tt class="descname">customParams</tt><a class="headerlink" href="#GeoExt.data.PrintPage.customParams" title="Permalink to this definition">¶</a></dt> |
---|
140 | <dd><tt class="docutils literal"><span class="pre">Object</span></tt> Key-value pairs of additional parameters that the |
---|
141 | printProvider will send to the print service for this page.</dd></dl> |
---|
142 | |
---|
143 | <dl class="attribute"> |
---|
144 | <dt id="GeoExt.data.PrintPage.feature"> |
---|
145 | <tt class="descclassname">PrintPage.</tt><tt class="descname">feature</tt><a class="headerlink" href="#GeoExt.data.PrintPage.feature" title="Permalink to this definition">¶</a></dt> |
---|
146 | <dd><tt class="docutils literal"><span class="pre">OpenLayers.Feature.Vector</span></tt> Feature representing the page extent. To |
---|
147 | get the extent of the print page for a specific map, use |
---|
148 | <tt class="docutils literal"><span class="pre">getPrintExtent</span></tt>. |
---|
149 | Read-only.</dd></dl> |
---|
150 | |
---|
151 | <dl class="attribute"> |
---|
152 | <dt id="GeoExt.data.PrintPage.rotation"> |
---|
153 | <tt class="descclassname">PrintPage.</tt><tt class="descname">rotation</tt><a class="headerlink" href="#GeoExt.data.PrintPage.rotation" title="Permalink to this definition">¶</a></dt> |
---|
154 | <dd><tt class="docutils literal"><span class="pre">Float</span></tt> The current rotation of the page. Read-only.</dd></dl> |
---|
155 | |
---|
156 | <dl class="attribute"> |
---|
157 | <dt id="GeoExt.data.PrintPage.scale"> |
---|
158 | <tt class="descclassname">PrintPage.</tt><tt class="descname">scale</tt><a class="headerlink" href="#GeoExt.data.PrintPage.scale" title="Permalink to this definition">¶</a></dt> |
---|
159 | <dd><tt class="docutils literal"><span class="pre">Ext.data.Record</span></tt> The current scale record of the page. Read-only.</dd></dl> |
---|
160 | |
---|
161 | </div> |
---|
162 | <div class="section" id="public-methods"> |
---|
163 | <h2>Public Methods<a class="headerlink" href="#public-methods" title="Permalink to this headline">¶</a></h2> |
---|
164 | <p>Public methods in addition to those |
---|
165 | listed for <a class="reference external" href="http://dev.sencha.com/deploy/dev/docs/?class=Ext.util.Observable">Ext.util.Observable</a>.</p> |
---|
166 | <dl class="method"> |
---|
167 | <dt id="GeoExt.data.PrintPage.fit"> |
---|
168 | <tt class="descclassname">PrintPage.</tt><tt class="descname">fit</tt><big>(</big><big>)</big><a class="headerlink" href="#GeoExt.data.PrintPage.fit" 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>fitTo</em> – <a title="GeoExt.MapPanel" class="reference external" href="../widgets/MapPanel.html#GeoExt.MapPanel"><tt class="xref docutils literal"><span class="pre">GeoExt.MapPanel</span></tt></a> or <tt class="docutils literal"><span class="pre">OpenLayers.Map</span></tt> or <tt class="docutils literal"><span class="pre">OpenLayers.Feature.Vector</span></tt> |
---|
175 | The map or feature to fit the page to.</li> |
---|
176 | <li><em>options</em> – <tt class="docutils literal"><span class="pre">Object</span></tt> Additional options to determine how to fit</li> |
---|
177 | </ul> |
---|
178 | </td> |
---|
179 | </tr> |
---|
180 | </tbody> |
---|
181 | </table> |
---|
182 | <p>Fits the page layout to a map or feature extent. If the map extent has |
---|
183 | not been centered yet, this will do nothing.</p> |
---|
184 | <p>Available options:</p> |
---|
185 | <ul class="simple"> |
---|
186 | <li>mode - <tt class="docutils literal"><span class="pre">String</span></tt> How to calculate the print extent? If “closest”, |
---|
187 | the closest matching print extent will be chosen. If “printer”, the |
---|
188 | chosen print extent will be the closest one that can show the entire |
---|
189 | <tt class="docutils literal"><span class="pre">fitTo</span></tt> extent on the printer. If “screen”, it will be the closest |
---|
190 | one that is entirely visible inside the <tt class="docutils literal"><span class="pre">fitTo</span></tt> extent. Default is |
---|
191 | “printer”.</li> |
---|
192 | </ul> |
---|
193 | </dd></dl> |
---|
194 | |
---|
195 | <dl class="method"> |
---|
196 | <dt id="GeoExt.data.PrintPage.getPrintExtent"> |
---|
197 | <tt class="descclassname">PrintPage.</tt><tt class="descname">getPrintExtent</tt><big>(</big><big>)</big><a class="headerlink" href="#GeoExt.data.PrintPage.getPrintExtent" title="Permalink to this definition">¶</a></dt> |
---|
198 | <dd><table class="docutils field-list" frame="void" rules="none"> |
---|
199 | <col class="field-name" /> |
---|
200 | <col class="field-body" /> |
---|
201 | <tbody valign="top"> |
---|
202 | <tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>map</em> – <tt class="docutils literal"><span class="pre">OpenLayers.Map</span></tt> or <a title="GeoExt.MapPanel" class="reference external" href="../widgets/MapPanel.html#GeoExt.MapPanel"><tt class="xref docutils literal"><span class="pre">GeoExt.MapPanel</span></tt></a> the map to |
---|
203 | get the print extent for.</td> |
---|
204 | </tr> |
---|
205 | <tr class="field"><th class="field-name">Returns:</th><td class="field-body"><tt class="docutils literal"><span class="pre">OpenLayers.Bounds</span></tt></td> |
---|
206 | </tr> |
---|
207 | </tbody> |
---|
208 | </table> |
---|
209 | <p>Gets this page’s print extent for the provided map.</p> |
---|
210 | </dd></dl> |
---|
211 | |
---|
212 | <dl class="method"> |
---|
213 | <dt id="GeoExt.data.PrintPage.setCenter"> |
---|
214 | <tt class="descclassname">PrintPage.</tt><tt class="descname">setCenter</tt><big>(</big><big>)</big><a class="headerlink" href="#GeoExt.data.PrintPage.setCenter" title="Permalink to this definition">¶</a></dt> |
---|
215 | <dd><table class="docutils field-list" frame="void" rules="none"> |
---|
216 | <col class="field-name" /> |
---|
217 | <col class="field-body" /> |
---|
218 | <tbody valign="top"> |
---|
219 | <tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>center</em> – <tt class="docutils literal"><span class="pre">OpenLayers.LonLat</span></tt> The new center.</td> |
---|
220 | </tr> |
---|
221 | </tbody> |
---|
222 | </table> |
---|
223 | <p>Moves the page extent to a new center.</p> |
---|
224 | </dd></dl> |
---|
225 | |
---|
226 | <dl class="method"> |
---|
227 | <dt id="GeoExt.data.PrintPage.setRotation"> |
---|
228 | <tt class="descclassname">PrintPage.</tt><tt class="descname">setRotation</tt><big>(</big><big>)</big><a class="headerlink" href="#GeoExt.data.PrintPage.setRotation" title="Permalink to this definition">¶</a></dt> |
---|
229 | <dd><table class="docutils field-list" frame="void" rules="none"> |
---|
230 | <col class="field-name" /> |
---|
231 | <col class="field-body" /> |
---|
232 | <tbody valign="top"> |
---|
233 | <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
234 | <li><em>rotation</em> – <tt class="docutils literal"><span class="pre">Float</span></tt> The new rotation.</li> |
---|
235 | <li><em>force</em> – <tt class="docutils literal"><span class="pre">Boolean</span></tt> If set to true, the rotation will also be |
---|
236 | set when the layout does not support it. Default is false.</li> |
---|
237 | </ul> |
---|
238 | </td> |
---|
239 | </tr> |
---|
240 | </tbody> |
---|
241 | </table> |
---|
242 | <p>Sets a new rotation for the page geometry.</p> |
---|
243 | </dd></dl> |
---|
244 | |
---|
245 | <dl class="method"> |
---|
246 | <dt id="GeoExt.data.PrintPage.setScale"> |
---|
247 | <tt class="descclassname">PrintPage.</tt><tt class="descname">setScale</tt><big>(</big><big>)</big><a class="headerlink" href="#GeoExt.data.PrintPage.setScale" title="Permalink to this definition">¶</a></dt> |
---|
248 | <dd><table class="docutils field-list" frame="void" rules="none"> |
---|
249 | <col class="field-name" /> |
---|
250 | <col class="field-body" /> |
---|
251 | <tbody valign="top"> |
---|
252 | <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
253 | <li><em>scale</em> – <tt class="docutils literal"><span class="pre">Ext.data.Record</span></tt> The new scale record.</li> |
---|
254 | <li><em>units</em> – <tt class="docutils literal"><span class="pre">String</span></tt> map units to use for the scale calculation. |
---|
255 | Optional if the <tt class="docutils literal"><span class="pre">feature</span></tt> is on a layer which is added to a map. |
---|
256 | If not found, “dd” will be assumed.</li> |
---|
257 | </ul> |
---|
258 | </td> |
---|
259 | </tr> |
---|
260 | </tbody> |
---|
261 | </table> |
---|
262 | <p>Updates the page geometry to match a given scale. Since this takes the |
---|
263 | current layout of the printProvider into account, this can be used to |
---|
264 | update the page geometry feature when the layout has changed.</p> |
---|
265 | </dd></dl> |
---|
266 | |
---|
267 | </div> |
---|
268 | <div class="section" id="events"> |
---|
269 | <h2>Events<a class="headerlink" href="#events" title="Permalink to this headline">¶</a></h2> |
---|
270 | <p>Events in addition to those |
---|
271 | listed for <a class="reference external" href="http://dev.sencha.com/deploy/dev/docs/?class=Ext.util.Observable">Ext.util.Observable</a>.</p> |
---|
272 | <dl class="describe"> |
---|
273 | <dt> |
---|
274 | <tt class="descname">change</tt></dt> |
---|
275 | <dd><p>Triggered when any of the page properties have changed</p> |
---|
276 | <p>Listener arguments:</p> |
---|
277 | <ul> |
---|
278 | <li><p class="first">printPage - <a title="GeoExt.data.PrintPage" class="reference internal" href="#GeoExt.data.PrintPage"><tt class="xref docutils literal"><span class="pre">GeoExt.data.PrintPage</span></tt></a> this printPage</p> |
---|
279 | </li> |
---|
280 | <li><dl class="first docutils"> |
---|
281 | <dt>modifications - <tt class="docutils literal"><span class="pre">Object</span></tt> Object with one or more of</dt> |
---|
282 | <dd><p class="first last"><tt class="docutils literal"><span class="pre">scale</span></tt>, <tt class="docutils literal"><span class="pre">center</span></tt> and <tt class="docutils literal"><span class="pre">rotation</span></tt>, notifying |
---|
283 | listeners of the changed properties.</p> |
---|
284 | </dd> |
---|
285 | </dl> |
---|
286 | </li> |
---|
287 | </ul> |
---|
288 | </dd></dl> |
---|
289 | |
---|
290 | </div> |
---|
291 | </div> |
---|
292 | |
---|
293 | |
---|
294 | </div> |
---|
295 | </div> |
---|
296 | </div> |
---|
297 | <div class="clearer"></div> |
---|
298 | </div> |
---|
299 | <div class="related"> |
---|
300 | <h3>Navigation</h3> |
---|
301 | <ul> |
---|
302 | <li class="right" style="margin-right: 10px"> |
---|
303 | <a href="../../../genindex.html" title="General Index" |
---|
304 | accesskey="I">index</a></li> |
---|
305 | <li class="right" > |
---|
306 | <a href="../../../modindex.html" title="Global Module Index" |
---|
307 | accesskey="M">modules</a> |</li> |
---|
308 | <li class="right" > |
---|
309 | <a href="PrintProvider.html" title="GeoExt.data.PrintProvider" |
---|
310 | accesskey="N">next</a> |</li> |
---|
311 | <li class="right" > |
---|
312 | <a href="LayerStore.html" title="GeoExt.data.LayerStore" |
---|
313 | accesskey="P">previous</a> |</li> |
---|
314 | <li><a href="../../../index.html">GeoExt</a> »</li> |
---|
315 | <li><a href="../../index.html" >API Reference</a> »</li> |
---|
316 | <li><a href="../data.html" ><tt class="docutils literal docutils literal docutils literal docutils literal docutils literal docutils literal docutils literal docutils literal docutils literal docutils literal docutils literal"><span class="pre">GeoExt.data</span></tt></a> »</li> |
---|
317 | <li><a href="#"><tt class="docutils literal docutils literal"><span class="pre">GeoExt.data.PrintPage</span></tt></a></li> |
---|
318 | </ul> |
---|
319 | </div> |
---|
320 | |
---|
321 | <div class="footer"> |
---|
322 | © Copyright 2009-2010, GeoExt Community. |
---|
323 | </div> |
---|
324 | </body> |
---|
325 | </html> |
---|