grid.segments.html
2.88 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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><title>R: Draw Line Segments</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.segments {grid}"><tr><td>grid.segments {grid}</td><td align="right">R Documentation</td></tr></table>
<h2>Draw Line Segments</h2>
<h3>Description</h3>
<p>
These functions create and draw line segments.
</p>
<h3>Usage</h3>
<pre>
grid.segments(x0 = unit(0, "npc"), y0 = unit(0, "npc"),
x1 = unit(1, "npc"), y1 = unit(1, "npc"),
default.units = "npc",
arrow = NULL,
name = NULL, gp = gpar(), draw = TRUE, vp = NULL)
segmentsGrob(x0 = unit(0, "npc"), y0 = unit(0, "npc"),
x1 = unit(1, "npc"), y1 = unit(1, "npc"),
default.units = "npc",
arrow = NULL, name = NULL, gp = gpar(), vp = NULL)
</pre>
<h3>Arguments</h3>
<table summary="R argblock">
<tr valign="top"><td><code>x0</code></td>
<td>
Numeric indicating the starting x-values of the line segments. </td></tr>
<tr valign="top"><td><code>y0</code></td>
<td>
Numeric indicating the starting y-values of the line
segments. </td></tr>
<tr valign="top"><td><code>x1</code></td>
<td>
Numeric indicating the stopping x-values of the line
segments. </td></tr>
<tr valign="top"><td><code>y1</code></td>
<td>
Numeric indicating the stopping y-values of the line segments.</td></tr>
<tr valign="top"><td><code>default.units</code></td>
<td>
A string. </td></tr>
<tr valign="top"><td><code>arrow</code></td>
<td>
A list describing arrow heads to place at either end
of the line segments, as produced by the <code>arrow</code> function.</td></tr>
<tr valign="top"><td><code>name</code></td>
<td>
A character identifier. </td></tr>
<tr valign="top"><td><code>gp</code></td>
<td>
An object of class <code>gpar</code>. </td></tr>
<tr valign="top"><td><code>draw</code></td>
<td>
A logical value indicating whether graphics output
should be produced.</td></tr>
<tr valign="top"><td><code>vp</code></td>
<td>
A Grid viewport object (or NULL).</td></tr>
</table>
<h3>Details</h3>
<p>
Both functions create a segments grob (a graphical object describing
segments), but only <code>grid.segments</code>
draws the segments (and then only if <code>draw</code> is <code>TRUE</code>).
</p>
<h3>Value</h3>
<p>
A segments grob. <code>grid.segments</code> returns the value invisibly.</p>
<h3>Author(s)</h3>
<p>
Paul Murrell
</p>
<h3>See Also</h3>
<p>
<a href="Grid.html">Grid</a>,
<code><a href="viewport.html">viewport</a></code>,
<code><a href="arrow.html">arrow</a></code>
</p>
<hr><div align="center">[Package <em>grid</em> version 2.5.1 <a href="00Index.html">Index]</a></div>
</body></html>