grid.grob.html
3.99 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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><title>R: Create a Grid Graphical Object</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 grid.grob {grid}"><tr><td>grid.grob {grid}</td><td align="right">R Documentation</td></tr></table>
<h2>Create a Grid Graphical Object</h2>
<h3>Description</h3>
<p>
These functions create grid graphical objects.
</p>
<h3>Usage</h3>
<pre>
grid.grob(list.struct, cl = NULL, draw = TRUE)
grob(..., name = NULL, gp = NULL, vp = NULL, cl = NULL)
gTree(..., name = NULL, gp = NULL, vp = NULL, children = NULL,
childrenvp = NULL, cl = NULL)
childNames(gTree)
gList(...)
</pre>
<h3>Arguments</h3>
<table summary="R argblock">
<tr valign="top"><td><code>...</code></td>
<td>
For <code>grob</code> and <code>gTree</code>, the
named slots describing important features of
the graphical object. For <code>gList</code>, a series of grob objects. </td></tr>
<tr valign="top"><td><code>list.struct</code></td>
<td>
A list (preferably with each element named).</td></tr>
<tr valign="top"><td><code>name</code></td>
<td>
A character identifier for the grob. Used to find the
grob on the display list and/or as a child of another grob. </td></tr>
<tr valign="top"><td><code>children</code></td>
<td>
A gList object. </td></tr>
<tr valign="top"><td><code>childrenvp</code></td>
<td>
A viewport object (or <code>NULL</code>).</td></tr>
<tr valign="top"><td><code>gp</code></td>
<td>
A gpar object, typically the output
from a call to the function <code>gpar</code>. This is basically
a list of graphical parameter settings.</td></tr>
<tr valign="top"><td><code>vp</code></td>
<td>
A viewport object (or <code>NULL</code>).</td></tr>
<tr valign="top"><td><code>cl</code></td>
<td>
A string giving the class attribute for the <code>list.struct</code></td></tr>
<tr valign="top"><td><code>draw</code></td>
<td>
A logical value to indicate whether to produce
graphical output.</td></tr>
<tr valign="top"><td><code>gTree</code></td>
<td>
A gTree object.</td></tr>
</table>
<h3>Details</h3>
<p>
These functions can be used to create a basic grob, gTree, or gList
object, or a new class derived from one of these.
</p>
<p>
A grid graphical object (grob) is a description of a graphical
item. These basic classes provide default behaviour for
validating, drawing,
and modifying graphical objects. Both call the function
<code>validDetails</code> to check that the object returned is coherent.
</p>
<p>
A gTree can have other grobs as children; when a gTree is drawn, it
draws all of its children. Before drawing its children, a gTree
pushes its childrenvp slot and then navigates back up (calls
<code>upViewport</code>) so that the children can specify their location
within the childrenvp via a vpPath.
</p>
<p>
Grob names need not be unique in general, but all children of a
gTree must have different names.
A grob name can be any string, though
it is not
advisable to use the gPath separator (currently <code>::</code>) in
grob names.
</p>
<p>
The function <code>childNames</code> returns the names of the grobs
which are children of a gTree.
</p>
<p>
All grid primitives (<code>grid.lines</code>, <code>grid.rect</code>, ...) and
some higher-level grid components (e.g., <code>grid.xaxis</code> and
<code>grid.yaxis</code>) are derived from these classes.
</p>
<p>
<code>grid.grob</code> is deprecated.
</p>
<h3>Value</h3>
<p>
A grob object.</p>
<h3>Author(s)</h3>
<p>
Paul Murrell
</p>
<h3>See Also</h3>
<p>
<code><a href="grid.draw.html">grid.draw</a></code>,
<code><a href="grid.edit.html">grid.edit</a></code>,
<code><a href="grid.get.html">grid.get</a></code>.
</p>
<h3>Examples</h3>
<pre>
</pre>
<hr><div align="center">[Package <em>grid</em> version 2.5.1 <a href="00Index.html">Index]</a></div>
</body></html>