grid.xaxis.html
3.38 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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><title>R: Draw an X-Axis</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.xaxis {grid}"><tr><td>grid.xaxis {grid}</td><td align="right">R Documentation</td></tr></table>
<h2>Draw an X-Axis</h2>
<h3>Description</h3>
<p>
These functions create and draw an x-axis.
</p>
<h3>Usage</h3>
<pre>
grid.xaxis(at = NULL, label = TRUE, main = TRUE,
edits = NULL, name = NULL,
gp = gpar(), draw = TRUE, vp = NULL)
xaxisGrob(at = NULL, label = TRUE, main = TRUE,
edits = NULL, name = NULL,
gp = gpar(), vp = NULL)
</pre>
<h3>Arguments</h3>
<table summary="R argblock">
<tr valign="top"><td><code>at</code></td>
<td>
A numeric vector of x-value locations for the tick marks.</td></tr>
<tr valign="top"><td><code>label</code></td>
<td>
A logical value indicating whether to draw the labels
on the tick marks, or an expression or character vector which
specify the labels to use. If not logical, must be the same
length as the <code>at</code> argument.</td></tr>
<tr valign="top"><td><code>main</code></td>
<td>
A logical value indicating whether to draw the axis
at the bottom (<code>TRUE</code>) or at the top (<code>FALSE</code>) of the
viewport.</td></tr>
<tr valign="top"><td><code>edits</code></td>
<td>
A gEdit or gEditList containing edit operations
to apply (to the children of the axis)
when the axis is first created and during redrawing
whenever <code>at</code> is <code>NULL</code>.
</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>, 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>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 obect (or <code>NULL</code>).</td></tr>
</table>
<h3>Details</h3>
<p>
Both functions create an xaxis grob (a graphical object describing an
xaxis), but only <code>grid.xaxis</code>
draws the xaxis (and then only if <code>draw</code> is <code>TRUE</code>).
</p>
<h3>Value</h3>
<p>
An xaxis grob. <code>grid.xaxis</code> returns the value invisibly.</p>
<h3>Children</h3>
<p>
If the <code>at</code> slot of an xaxis grob is not <code>NULL</code> then
the xaxis will have the following children:
<dl>
<dt>major</dt><dd>representing the line at the base of the
tick marks.</dd>
<dt>ticks</dt><dd>representing the tick marks.</dd>
<dt>labels</dt><dd>representing the tick labels.</dd>
</dl>
<p>
If the <code>at</code> slot is <code>NULL</code> then there are no children
and ticks are drawn based on the current viewport scale.
</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="grid.yaxis.html">grid.yaxis</a></code>
</p>
<hr><div align="center">[Package <em>grid</em> version 2.5.1 <a href="00Index.html">Index]</a></div>
</body></html>