current.viewport.html
2.55 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><title>R: Get the Current Grid Viewport (Tree)</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link rel="stylesheet" type="text/css" href="../../R.css">
</head><body>
<table width="100%" summary="page for Querying the Viewport Tree {grid}"><tr><td>Querying the Viewport Tree {grid}</td><td align="right">R Documentation</td></tr></table>
<h2>Get the Current Grid Viewport (Tree)</h2>
<h3>Description</h3>
<p>
<code>current.viewport()</code>
returns the viewport that Grid is going to draw into.
</p>
<p>
<code>current.vpTree</code> returns the entire Grid viewport tree.
</p>
<p>
<code>current.vpPath</code> returns the viewport path to the current viewport.
</p>
<p>
<code>current.transform</code> returns the transformation
matrix for the current viewport.
</p>
<h3>Usage</h3>
<pre>
current.viewport(vp=NULL)
current.vpTree(all=TRUE)
current.vpPath()
current.transform()
</pre>
<h3>Arguments</h3>
<table summary="R argblock">
<tr valign="top"><td><code>vp</code></td>
<td>
A Grid viewport object. Use of this argument has been deprecated.</td></tr>
<tr valign="top"><td><code>all</code></td>
<td>
A logical value indicating whether the entire viewport
tree should be returned.</td></tr>
</table>
<h3>Details</h3>
<p>
If <code>all</code> is <code>FALSE</code> then
<code>current.vpTree</code> only returns the subtree below
the current viewport.
</p>
<h3>Value</h3>
<p>
A Grid viewport object from <code>current.viewport</code> or
<code>current.vpTree</code>.
<br>
<code>current.transform</code> returns a 4x4 transformation matrix.
<br>
The viewport path returned by <code>current.vpPath</code> is <code>NULL</code>
if the current viewport is the <code>ROOT</code> viewport</p>
<h3>Author(s)</h3>
<p>
Paul Murrell
</p>
<h3>See Also</h3>
<p>
<code><a href="viewport.html">viewport</a></code>
</p>
<h3>Examples</h3>
<pre>
grid.newpage()
pushViewport(viewport(width=0.8, height=0.8, name="A"))
pushViewport(viewport(x=0.1, width=0.3, height=0.6,
just="left", name="B"))
upViewport(1)
pushViewport(viewport(x=0.5, width=0.4, height=0.8,
just="left", name="C"))
pushViewport(viewport(width=0.8, height=0.8, name="D"))
current.vpPath()
upViewport(1)
current.vpPath()
current.vpTree()
current.viewport()
current.vpTree(all=FALSE)
popViewport(0)
</pre>
<hr><div align="center">[Package <em>grid</em> version 2.5.1 <a href="00Index.html">Index]</a></div>
</body></html>