vpPath.html
1.98 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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><title>R: Concatenate Viewport Names</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 vpPath {grid}"><tr><td>vpPath {grid}</td><td align="right">R Documentation</td></tr></table>
<h2>Concatenate Viewport Names</h2>
<h3>Description</h3>
<p>
This function can be used to generate a viewport path for use
in <code>downViewport</code> or <code>seekViewport</code>.
</p>
<p>
A viewport path is a list of nested viewport names.
</p>
<h3>Usage</h3>
<pre>
vpPath(...)
</pre>
<h3>Arguments</h3>
<table summary="R argblock">
<tr valign="top"><td><code>...</code></td>
<td>
Character values which are viewport names. </td></tr>
</table>
<h3>Details</h3>
<p>
Viewport names must only be unique amongst viewports which
share the same parent in the viewport tree.
</p>
<p>
This function can be used to generate a specification for
a viewport that includes the viewport's parent's name
(and the name of its parent and so on).
</p>
<p>
For interactive use, it is possible to directly specify
a path, but it is strongly recommended that this function
is used otherwise in case the path separator is changed
in future versions of grid.
</p>
<h3>Value</h3>
<p>
A <code> vpPath </code> object.</p>
<h3>See Also</h3>
<p>
<code><a href="viewport.html">viewport</a></code>,
<code><a href="viewports.html">pushViewport</a></code>,
<code><a href="viewports.html">popViewport</a></code>,
<code><a href="viewports.html">downViewport</a></code>,
<code><a href="viewports.html">seekViewport</a></code>,
<code><a href="viewports.html">upViewport</a></code>
</p>
<h3>Examples</h3>
<pre>
vpPath("vp1", "vp2")
</pre>
<hr><div align="center">[Package <em>grid</em> version 2.5.1 <a href="00Index.html">Index]</a></div>
</body></html>