gEdit.html
2.3 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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><title>R: Create and Apply Edit Objects</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 gEdit {grid}"><tr><td>gEdit {grid}</td><td align="right">R Documentation</td></tr></table>
<h2>Create and Apply Edit Objects</h2>
<h3>Description</h3>
<p>
The functions <code>gEdit</code> and <code>gEditList</code> create
objects representing an edit operation (essentially a list
of arguments to <code>editGrob</code>).
</p>
<p>
The functions <code>applyEdit</code> and <code>applyEdits</code> apply
one or more edit operations to a graphical object.
</p>
<p>
These functions are most useful for developers creating new
graphical functions and objects.
</p>
<h3>Usage</h3>
<pre>
gEdit(...)
gEditList(...)
applyEdit(x, edit)
applyEdits(x, edits)
</pre>
<h3>Arguments</h3>
<table summary="R argblock">
<tr valign="top"><td><code>...</code></td>
<td>
one or more arguments to the <code>editGrob</code> function
(for <code>gEdit</code>) or one or more <code>"gEdit"</code> objects
(for <code>gEditList</code>).</td></tr>
<tr valign="top"><td><code>x</code></td>
<td>
a grob (grid graphical object).</td></tr>
<tr valign="top"><td><code>edit</code></td>
<td>
a <code>"gEdit"</code> object.</td></tr>
<tr valign="top"><td><code>edits</code></td>
<td>
either a <code>"gEdit"</code> object or a <code>"gEditList"</code>
object.</td></tr>
</table>
<h3>Value</h3>
<p>
<code>gEdit</code> returns an object of class <code>"gEdit"</code>.
<br>
<code>gEditList</code> returns an object of class <code>"gEditList"</code>.
<br>
<code>applyEdit</code> and <code>applyEditList</code> return the modified grob.</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.edit.html">editGrob</a></code>
</p>
<h3>Examples</h3>
<pre>
grid.rect(gp=gpar(col="red"))
# same thing, but more verbose
grid.draw(applyEdit(rectGrob(), gEdit(gp=gpar(col="red"))))
</pre>
<hr><div align="center">[Package <em>grid</em> version 2.5.1 <a href="00Index.html">Index]</a></div>
</body></html>