grid.remove.html
3.16 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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><title>R: Remove 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.remove {grid}"><tr><td>grid.remove {grid}</td><td align="right">R Documentation</td></tr></table>
<h2>Remove a Grid Graphical Object</h2>
<h3>Description</h3>
<p>
Remove a grob from a gTree or a descendant of a gTree.
</p>
<h3>Usage</h3>
<pre>
grid.remove(gPath, warn = TRUE, strict = FALSE, grep = FALSE,
global = FALSE, allDevices = FALSE, redraw = TRUE)
removeGrob(gTree, gPath, strict = FALSE, grep = FALSE,
global = FALSE, warn = TRUE)
</pre>
<h3>Arguments</h3>
<table summary="R argblock">
<tr valign="top"><td><code>gTree</code></td>
<td>
A gTree object.</td></tr>
<tr valign="top"><td><code>gPath</code></td>
<td>
A gPath object. For <code>grid.remove</code> this
specifies a gTree on the display list. For <code>removeGrob</code> this
specifies a descendant of the specified gTree. </td></tr>
<tr valign="top"><td><code>strict</code></td>
<td>
A boolean indicating whether the gPath must be
matched exactly. </td></tr>
<tr valign="top"><td><code>grep</code></td>
<td>
A boolean indicating whether the <code>gPath</code> should
be treated as a regular expression. Values are recycled across
elements of the <code>gPath</code> (e.g., <code>c(TRUE, FALSE)</code> means
that every odd element of the <code>gPath</code> will be treated as
a regular expression).
</td></tr>
<tr valign="top"><td><code>global</code></td>
<td>
A boolean indicating whether the function should affect
just the first match of the <code>gPath</code>, or whether all matches
should be affected.
</td></tr>
<tr valign="top"><td><code>allDevices</code></td>
<td>
A boolean indicating whether all open devices
should
be searched for matches, or just the current device.
NOT YET IMPLEMENTED.
</td></tr>
<tr valign="top"><td><code>warn</code></td>
<td>
A logical to indicate whether failing to find the
specified grob should trigger an error. </td></tr>
<tr valign="top"><td><code>redraw</code></td>
<td>
A logical value to indicate whether to redraw the grob. </td></tr>
</table>
<h3>Details</h3>
<p>
<code>removeGrob</code> copies the specified grob and returns a modified
grob.
</p>
<p>
<code>grid.remove</code> destructively modifies a grob on the display list.
If <code>redraw</code>
is <code>TRUE</code> it then redraws everything to reflect the change.
</p>
<h3>Value</h3>
<p>
<code>removeGrob</code> returns a grob object; <code>grid.remove</code> returns
<code>NULL</code>.</p>
<h3>Author(s)</h3>
<p>
Paul Murrell
</p>
<h3>See Also</h3>
<p>
<code><a href="grid.grob.html">grob</a></code>, <code><a href="grid.get.html">getGrob</a></code>,
<code><a href="grid.remove.html">removeGrob</a></code>, <code><a href="grid.remove.html">removeGrob</a></code>.
</p>
<hr><div align="center">[Package <em>grid</em> version 2.5.1 <a href="00Index.html">Index]</a></div>
</body></html>