The R Project SVN R

Rev

Rev 78848 | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 78848 Rev 86005
Line 60... Line 60...
60
  validating, drawing,
60
  validating, drawing,
61
  and modifying graphical objects.  Both \code{grob()} and
61
  and modifying graphical objects.  Both \code{grob()} and
62
  \code{gTree()} call the function \code{\link{validDetails}} to check
62
  \code{gTree()} call the function \code{\link{validDetails}} to check
63
  that the object returned is internally coherent.
63
  that the object returned is internally coherent.
64
 
64
 
65
  A \code{"gTree"} can have other grobs as children;  when a gTree is drawn, it
65
  A \code{"gTree"} can have other grobs as children;  when a \I{gTree} is drawn, it
66
  draws all of its children.  Before drawing its children, a gTree
66
  draws all of its children.  Before drawing its children, a \I{gTree}
67
  pushes its \code{childrenvp} slot and then navigates back up (calls
67
  pushes its \code{childrenvp} slot and then navigates back up (calls
68
  \code{\link{upViewport}}) so that the children can specify their location
68
  \code{\link{upViewport}}) so that the children can specify their location
69
  within the \code{childrenvp} via a \code{\link{vpPath}}.
69
  within the \code{childrenvp} via a \code{\link{vpPath}}.
70
 
70
 
71
  Grob names need not be unique in general, but all children of a
71
  Grob names need not be unique in general, but all children of a
72
  gTree must have different names.
72
  \I{gTree} must have different names.
73
  A grob name can be any string, though it is not
73
  A grob name can be any string, though it is not
74
  advisable to use the \code{\link{gPath}} separator (currently
74
  advisable to use the \code{\link{gPath}} separator (currently
75
  \code{::}) in grob names.
75
  \code{::}) in grob names.
76
 
76
 
77
  The function \code{childNames} returns the names of the grobs
77
  The function \code{childNames} returns the names of the grobs
78
  which are children of a gTree.
78
  which are children of a \I{gTree}.
79
 
79
 
80
  All grid primitives (\code{\link{grid.lines}}, \code{grid.rect}, ...)
80
  All grid primitives (\code{\link{grid.lines}}, \code{grid.rect}, ...)
81
  and some higher-level grid components (e.g., \code{\link{grid.xaxis}}
81
  and some higher-level grid components (e.g., \code{\link{grid.xaxis}}
82
  and \code{grid.yaxis}) are derived from these classes.
82
  and \code{grid.yaxis}) are derived from these classes.
83
 
83
 
84
  \code{grobTree} is just a convenient wrapper for \code{gTree}
84
  \code{grobTree} is just a convenient wrapper for \code{gTree}
85
  when the only components of the gTree are grobs (so all
85
  when the only components of the \I{gTree} are grobs (so all
86
  unnamed arguments become children of the gTree).
86
  unnamed arguments become children of the \I{gTree}).
87
 
87
 
88
  The \code{grid.grob} function is defunct.
88
  The \code{grid.grob} function is defunct.
89
}
89
}
90
\value{
90
\value{
91
  An \R object of class \code{"grob"}, a \bold{gr}aphical \bold{ob}ject.
91
  An \R object of class \code{"grob"}, a \bold{gr}aphical \bold{ob}ject.