grid.edit.html
3.67 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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><title>R: Edit the Description of 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.edit {grid}"><tr><td>grid.edit {grid}</td><td align="right">R Documentation</td></tr></table>
<h2>Edit the Description of a Grid Graphical Object</h2>
<h3>Description</h3>
<p>
Changes the value of one of the slots of a grob
and redraws the grob.
</p>
<h3>Usage</h3>
<pre>
grid.edit(gPath, ..., strict = FALSE, grep = FALSE, global = FALSE,
allDevices = FALSE, redraw = TRUE)
editGrob(grob, gPath = NULL, ..., strict = FALSE, grep = FALSE,
global = FALSE)
</pre>
<h3>Arguments</h3>
<table summary="R argblock">
<tr valign="top"><td><code>grob</code></td>
<td>
A grob object.</td></tr>
<tr valign="top"><td><code>...</code></td>
<td>
Zero or more named arguments specifying new slot values.</td></tr>
<tr valign="top"><td><code>gPath</code></td>
<td>
A gPath object. For <code>grid.edit</code> this
specifies a grob on the display list. For <code>editGrob</code> this
specifies a descendant of the specified grob. </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>redraw</code></td>
<td>
A logical value to indicate whether to redraw the grob. </td></tr>
</table>
<h3>Details</h3>
<p>
<code>editGrob</code> copies the specified grob and returns a modified
grob.
</p>
<p>
<code>grid.edit</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>
<p>
Both functions call <code>editDetails</code> to allow a grob to perform
custom actions and <code>validDetails</code> to check that the modified grob
is still coherent.
</p>
<h3>Value</h3>
<p>
<code>editGrob</code> returns a grob object; <code>grid.edit</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.add.html">addGrob</a></code>, <code><a href="grid.remove.html">removeGrob</a></code>.
</p>
<h3>Examples</h3>
<pre>
grid.newpage()
grid.xaxis(name = "xa", vp = viewport(width=.5, height=.5))
grid.edit("xa", gp = gpar(col="red"))
# won't work because no ticks (at is NULL)
try(grid.edit(gPath("xa", "ticks"), gp = gpar(col="green")))
grid.edit("xa", at = 1:4/5)
# Now it should work
try(grid.edit(gPath("xa", "ticks"), gp = gpar(col="green")))
</pre>
<hr><div align="center">[Package <em>grid</em> version 2.5.1 <a href="00Index.html">Index]</a></div>
</body></html>