The R Project SVN R

Rev

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

Rev 85983 Rev 86005
Line 11... Line 11...
11
\title{ List the names of grobs or viewports }
11
\title{ List the names of grobs or viewports }
12
\description{
12
\description{
13
  Return a listing of the names of grobs or viewports.
13
  Return a listing of the names of grobs or viewports.
14
 
14
 
15
  This is a generic function with methods for grobs (including
15
  This is a generic function with methods for grobs (including
16
  gTrees) and viewports (including \I{vpTree}s).
16
  \I{gTree}s) and viewports (including \I{vpTree}s).
17
}
17
}
18
\usage{
18
\usage{
19
grid.ls(x=NULL, grobs=TRUE, viewports=FALSE, fullNames=FALSE,
19
grid.ls(x=NULL, grobs=TRUE, viewports=FALSE, fullNames=FALSE,
20
        recursive=TRUE, print=TRUE, flatten=TRUE, ...)
20
        recursive=TRUE, print=TRUE, flatten=TRUE, ...)
21
 
21
 
Line 60... Line 60...
60
  Otherwise, \code{x} should be a grob or a viewport.
60
  Otherwise, \code{x} should be a grob or a viewport.
61
 
61
 
62
  The default behaviour of this function is to print information
62
  The default behaviour of this function is to print information
63
  about the grobs in the current scene.  It is also possible to
63
  about the grobs in the current scene.  It is also possible to
64
  add information about the viewports in the scene.  By default,
64
  add information about the viewports in the scene.  By default,
65
  the listing is recursive, so all children of gTrees and all
65
  the listing is recursive, so all children of \I{gTree}s and all
66
  nested viewports are reported.
66
  nested viewports are reported.
67
 
67
 
68
  The format of the information can be controlled via the \code{print}
68
  The format of the information can be controlled via the \code{print}
69
  argument, which can be given a function to perform the formatting.
69
  argument, which can be given a function to perform the formatting.
70
  The \code{nestedListing} function produces a line per grob or
70
  The \code{nestedListing} function produces a line per grob or