1 | |
---|
2 | .. currentmodule:: GeoExt.data |
---|
3 | |
---|
4 | :class:`GeoExt.data.PrintPage` |
---|
5 | ================================================================================ |
---|
6 | |
---|
7 | |
---|
8 | .. cssclass:: meta |
---|
9 | |
---|
10 | |
---|
11 | Extends |
---|
12 | * `Ext.util.Observable <http://dev.sencha.com/deploy/dev/docs/?class=Ext.util.Observable>`_ |
---|
13 | |
---|
14 | |
---|
15 | |
---|
16 | |
---|
17 | |
---|
18 | |
---|
19 | |
---|
20 | .. class:: PrintPage |
---|
21 | |
---|
22 | Provides a representation of a print page for |
---|
23 | :class:`GeoExt.data.PrintProvider`. The extent of the page is stored as |
---|
24 | ``OpenLayers.Feature.Vector``. Widgets can use this to display the print |
---|
25 | extent on the map. |
---|
26 | |
---|
27 | |
---|
28 | |
---|
29 | |
---|
30 | |
---|
31 | Config Options |
---|
32 | -------------- |
---|
33 | |
---|
34 | Configuration properties in addition to |
---|
35 | those listed for `Ext.util.Observable <http://dev.sencha.com/deploy/dev/docs/?class=Ext.util.Observable>`_. |
---|
36 | |
---|
37 | |
---|
38 | .. describe:: customParams |
---|
39 | |
---|
40 | ``Object`` Key-value pairs of additional parameters that the |
---|
41 | printProvider will send to the print service for this page. |
---|
42 | |
---|
43 | .. describe:: printProvider |
---|
44 | |
---|
45 | :class:`GeoExt.data.PrintProvider` The print provider to use with |
---|
46 | this page. |
---|
47 | |
---|
48 | |
---|
49 | |
---|
50 | |
---|
51 | Public Properties |
---|
52 | ----------------- |
---|
53 | |
---|
54 | Public properties in addition to those |
---|
55 | listed for `Ext.util.Observable <http://dev.sencha.com/deploy/dev/docs/?class=Ext.util.Observable>`_. |
---|
56 | |
---|
57 | |
---|
58 | .. attribute:: PrintPage.center |
---|
59 | |
---|
60 | ``OpenLayers.LonLat`` The current center of the page. Read-only. |
---|
61 | |
---|
62 | .. attribute:: PrintPage.customParams |
---|
63 | |
---|
64 | ``Object`` Key-value pairs of additional parameters that the |
---|
65 | printProvider will send to the print service for this page. |
---|
66 | |
---|
67 | .. attribute:: PrintPage.feature |
---|
68 | |
---|
69 | ``OpenLayers.Feature.Vector`` Feature representing the page extent. To |
---|
70 | get the extent of the print page for a specific map, use |
---|
71 | ``getPrintExtent``. |
---|
72 | Read-only. |
---|
73 | |
---|
74 | .. attribute:: PrintPage.rotation |
---|
75 | |
---|
76 | ``Float`` The current rotation of the page. Read-only. |
---|
77 | |
---|
78 | .. attribute:: PrintPage.scale |
---|
79 | |
---|
80 | ``Ext.data.Record`` The current scale record of the page. Read-only. |
---|
81 | |
---|
82 | |
---|
83 | |
---|
84 | |
---|
85 | Public Methods |
---|
86 | -------------- |
---|
87 | |
---|
88 | Public methods in addition to those |
---|
89 | listed for `Ext.util.Observable <http://dev.sencha.com/deploy/dev/docs/?class=Ext.util.Observable>`_. |
---|
90 | |
---|
91 | |
---|
92 | .. method:: PrintPage.fit |
---|
93 | |
---|
94 | :param fitTo: :class:`GeoExt.MapPanel` or ``OpenLayers.Map`` or ``OpenLayers.Feature.Vector`` |
---|
95 | The map or feature to fit the page to. |
---|
96 | :param options: ``Object`` Additional options to determine how to fit |
---|
97 | |
---|
98 | Fits the page layout to a map or feature extent. If the map extent has |
---|
99 | not been centered yet, this will do nothing. |
---|
100 | |
---|
101 | Available options: |
---|
102 | |
---|
103 | * mode - ``String`` How to calculate the print extent? If "closest", |
---|
104 | the closest matching print extent will be chosen. If "printer", the |
---|
105 | chosen print extent will be the closest one that can show the entire |
---|
106 | ``fitTo`` extent on the printer. If "screen", it will be the closest |
---|
107 | one that is entirely visible inside the ``fitTo`` extent. Default is |
---|
108 | "printer". |
---|
109 | |
---|
110 | |
---|
111 | .. method:: PrintPage.getPrintExtent |
---|
112 | |
---|
113 | :param map: ``OpenLayers.Map`` or :class:`GeoExt.MapPanel` the map to |
---|
114 | get the print extent for. |
---|
115 | :returns: ``OpenLayers.Bounds`` |
---|
116 | |
---|
117 | Gets this page's print extent for the provided map. |
---|
118 | |
---|
119 | .. method:: PrintPage.setCenter |
---|
120 | |
---|
121 | :param center: ``OpenLayers.LonLat`` The new center. |
---|
122 | |
---|
123 | Moves the page extent to a new center. |
---|
124 | |
---|
125 | .. method:: PrintPage.setRotation |
---|
126 | |
---|
127 | :param rotation: ``Float`` The new rotation. |
---|
128 | :param force: ``Boolean`` If set to true, the rotation will also be |
---|
129 | set when the layout does not support it. Default is false. |
---|
130 | |
---|
131 | Sets a new rotation for the page geometry. |
---|
132 | |
---|
133 | .. method:: PrintPage.setScale |
---|
134 | |
---|
135 | :param scale: ``Ext.data.Record`` The new scale record. |
---|
136 | :param units: ``String`` map units to use for the scale calculation. |
---|
137 | Optional if the ``feature`` is on a layer which is added to a map. |
---|
138 | If not found, "dd" will be assumed. |
---|
139 | |
---|
140 | Updates the page geometry to match a given scale. Since this takes the |
---|
141 | current layout of the printProvider into account, this can be used to |
---|
142 | update the page geometry feature when the layout has changed. |
---|
143 | |
---|
144 | |
---|
145 | |
---|
146 | |
---|
147 | Events |
---|
148 | ------ |
---|
149 | |
---|
150 | Events in addition to those |
---|
151 | listed for `Ext.util.Observable <http://dev.sencha.com/deploy/dev/docs/?class=Ext.util.Observable>`_. |
---|
152 | |
---|
153 | |
---|
154 | .. describe:: change |
---|
155 | |
---|
156 | Triggered when any of the page properties have changed |
---|
157 | |
---|
158 | Listener arguments: |
---|
159 | |
---|
160 | * printPage - :class:`GeoExt.data.PrintPage` this printPage |
---|
161 | * modifications - ``Object`` Object with one or more of |
---|
162 | ``scale``, ``center`` and ``rotation``, notifying |
---|
163 | listeners of the changed properties. |
---|
164 | |
---|
165 | |
---|
166 | |
---|