The R Project SVN – R – Diff – /trunk/src/library/grid/man/grid.grob.Rd



  These functions create grid graphical objects.
}
\usage{
grid.grob(list.struct, cl = NULL, draw = TRUE)
grob(..., name = NULL, gp = NULL, vp = NULL, cl = NULL)
gTree(..., name = NULL, gp = NULL, vp = NULL, children = NULL,
      childrenvp = NULL, cl = NULL)
grobTree(..., name = NULL, gp = NULL, vp = NULL,
         childrenvp = NULL, cl = NULL)
childNames(gTree)
gList(...)
is.grob(x)
}

  \item{x}{ An R object. }
}
\details{
  These functions can be used to create a basic grob, gTree, or gList
  object, or a new class derived from one of these.
 
  A grid graphical object (grob) is a description of a graphical
  item.  These basic classes provide default behaviour for
  validating, drawing,
  and modifying graphical objects.  Both call the function
  \code{validDetails} to check that the object returned is coherent.

  pushes its childrenvp slot and then navigates back up (calls
  \code{upViewport}) so that the children can specify their location
  within the childrenvp via a vpPath.
 
  Grob names need not be unique in general, but all children of a
  gTree must have different names.
    A grob name can be any string, though
    it is not
    advisable to use the gPath separator  (currently \code{::}) in
    grob names.
 
  The function \code{childNames} returns the names of the grobs
  which are children of a gTree.
 
  All grid primitives (\code{grid.lines}, \code{grid.rect}, ...) and
  some higher-level grid components (e.g., \code{grid.xaxis} and
  \code{grid.yaxis}) are derived from these classes.
 
  \code{grobTree} is just a convenient wrapper for \code{gTree}
  when the only components of the gTree are grobs (so all
  unnamed arguments become children of the gTree).
 
  \code{grid.grob} is deprecated.
 
}
\value{
  A grob object.

The R Project SVN R

(root)/trunk/src/library/grid/man/grid.grob.Rd – Rev 59039 → 61433

Rev 59039		Rev 61433
Line 16...		Line 16...
16	`These functions create grid graphical objects.`	16	`These functions create grid graphical objects.`
17	`}`	17	`}`
18	`\usage{`	18	`\usage{`
19	`grid.grob(list.struct, cl = NULL, draw = TRUE)`	19	`grid.grob(list.struct, cl = NULL, draw = TRUE)`
20	`grob(..., name = NULL, gp = NULL, vp = NULL, cl = NULL)`	20	`grob(..., name = NULL, gp = NULL, vp = NULL, cl = NULL)`
21	`gTree(..., name = NULL, gp = NULL, vp = NULL, children = NULL,`	21	`gTree(..., name = NULL, gp = NULL, vp = NULL, children = NULL,`
22	`childrenvp = NULL, cl = NULL)`	22	`childrenvp = NULL, cl = NULL)`
23	`grobTree(..., name = NULL, gp = NULL, vp = NULL,`	23	`grobTree(..., name = NULL, gp = NULL, vp = NULL,`
24	`childrenvp = NULL, cl = NULL)`	24	`childrenvp = NULL, cl = NULL)`
25	`childNames(gTree)`	25	`childNames(gTree)`
26	`gList(...)`	26	`gList(...)`
27	`is.grob(x)`	27	`is.grob(x)`
28	`}`	28	`}`
Line 47...		Line 47...
47	`\item{x}{ An R object. }`	47	`\item{x}{ An R object. }`
48	`}`	48	`}`
49	`\details{`	49	`\details{`
50	`These functions can be used to create a basic grob, gTree, or gList`	50	`These functions can be used to create a basic grob, gTree, or gList`
51	`object, or a new class derived from one of these.`	51	`object, or a new class derived from one of these.`
52		52
53	`A grid graphical object (grob) is a description of a graphical`	53	`A grid graphical object (grob) is a description of a graphical`
54	`item. These basic classes provide default behaviour for`	54	`item. These basic classes provide default behaviour for`
55	`validating, drawing,`	55	`validating, drawing,`
56	`and modifying graphical objects. Both call the function`	56	`and modifying graphical objects. Both call the function`
57	`\code{validDetails} to check that the object returned is coherent.`	57	`\code{validDetails} to check that the object returned is coherent.`
Line 61...		Line 61...
61	`pushes its childrenvp slot and then navigates back up (calls`	61	`pushes its childrenvp slot and then navigates back up (calls`
62	`\code{upViewport}) so that the children can specify their location`	62	`\code{upViewport}) so that the children can specify their location`
63	`within the childrenvp via a vpPath.`	63	`within the childrenvp via a vpPath.`
64		64
65	`Grob names need not be unique in general, but all children of a`	65	`Grob names need not be unique in general, but all children of a`
66	`gTree must have different names.`	66	`gTree must have different names.`
67	`A grob name can be any string, though`	67	`A grob name can be any string, though`
68	`it is not`	68	`it is not`
69	`advisable to use the gPath separator (currently \code{::}) in`	69	`advisable to use the gPath separator (currently \code{::}) in`
70	`grob names.`	70	`grob names.`
71		71
72	`The function \code{childNames} returns the names of the grobs`	72	`The function \code{childNames} returns the names of the grobs`
73	`which are children of a gTree.`	73	`which are children of a gTree.`
74		74
75	`All grid primitives (\code{grid.lines}, \code{grid.rect}, ...) and`	75	`All grid primitives (\code{grid.lines}, \code{grid.rect}, ...) and`
76	`some higher-level grid components (e.g., \code{grid.xaxis} and`	76	`some higher-level grid components (e.g., \code{grid.xaxis} and`
77	`\code{grid.yaxis}) are derived from these classes.`	77	`\code{grid.yaxis}) are derived from these classes.`
78		78
79	`\code{grobTree} is just a convenient wrapper for \code{gTree}`	79	`\code{grobTree} is just a convenient wrapper for \code{gTree}`
80	`when the only components of the gTree are grobs (so all`	80	`when the only components of the gTree are grobs (so all`
81	`unnamed arguments become children of the gTree).`	81	`unnamed arguments become children of the gTree).`
82		82
83	`\code{grid.grob} is deprecated.`	83	`\code{grid.grob} is deprecated.`
84		84
85	`}`	85	`}`
86	`\value{`	86	`\value{`
87	`A grob object.`	87	`A grob object.`