The R Project SVN R

Rev

Rev 68948 | Go to most recent revision | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 68948 Rev 72561
Line 1... Line 1...
1 
% File src/library/grid/man/grid.remove.Rd
 1 
% File src/library/grid/man/grid.remove.Rd
2 
% Part of the R package, https://www.R-project.org
 2 
% Part of the R package, https://www.R-project.org
3 
% Copyright 1995-2007 R Core Team
 3 
% Copyright 1995-2017 R Core Team
4 
% Distributed under GPL 2 or later
 4 
% Distributed under GPL 2 or later
5 
 
 5 
 
6 
\name{grid.remove}
 6 
\name{grid.remove}
7 
\alias{grid.remove}
 7 
\alias{grid.remove}
8 
\alias{grid.gremove}
 8 
\alias{grid.gremove}
Line 10... Line 10...
10 
\title{Remove a Grid Graphical Object}
 10 
\title{Remove a Grid Graphical Object}
11 
\description{
 11 
\description{
12 
  Remove a grob from a gTree or a descendant of a gTree.
 12 
  Remove a grob from a gTree or a descendant of a gTree.
13 
}
 13 
}
14 
\usage{
 14 
\usage{
15 
grid.remove(gPath, warn = TRUE, strict  =  FALSE, grep = FALSE,
 15 
grid.remove(gPath, warn = TRUE, strict = FALSE, grep = FALSE,
16 
            global = FALSE, allDevices = FALSE, redraw = TRUE)
 16 
            global = FALSE, allDevices = FALSE, redraw = TRUE)
17 
 
 17 
 
18 
grid.gremove(\dots, grep = TRUE, global = TRUE)
 18 
grid.gremove(\dots, grep = TRUE, global = TRUE)
19 
 
 19 
 
20 
removeGrob(gTree, gPath, strict = FALSE, grep = FALSE,
 20 
removeGrob(gTree, gPath, strict = FALSE, grep = FALSE,
21 
           global = FALSE, warn = TRUE)
 21 
           global = FALSE, warn = TRUE)
22 
}
 22 
}
23 
\arguments{
 23 
\arguments{
24 
  \item{gTree}{A gTree object.}
 24 
  \item{gTree}{A gTree object.}
25 
  \item{gPath}{ A gPath object. For \code{grid.remove} this
 25 
  \item{gPath}{a gPath object. For \code{grid.remove} this
26 
    specifies a gTree on the display list.  For \code{removeGrob} this
 26 
    specifies a gTree on the display list.  For \code{removeGrob} this
27 
    specifies a descendant of the specified gTree. }
 27 
    specifies a descendant of the specified \code{gTree}.}
28 
  \item{strict}{ A boolean indicating whether the gPath must be
 28 
  \item{strict}{a \code{\link{logical}} indicating whether the \code{gPath} must be
29 
    matched exactly. }
 29 
    matched exactly.}
30 
  \item{grep}{A boolean indicating whether the \code{gPath} should
 30 
  \item{grep}{a \code{\link{logical}} indicating whether the \code{gPath} should
31 
    be treated as a regular expression.  Values are recycled across
 31 
    be treated as a regular expression.  Values are recycled across
32 
    elements of the \code{gPath} (e.g., \code{c(TRUE, FALSE)} means
 32 
    elements of the \code{gPath} (e.g., \code{c(TRUE, FALSE)} means
33 
    that every odd element of the \code{gPath} will be treated as
 33 
    that every odd element of the \code{gPath} will be treated as
34 
    a regular expression).
 34 
    a regular expression).
35 
  }
 35 
  }
36 
  \item{global}{ A boolean indicating whether the function should affect
 36 
  \item{global}{a \code{\link{logical}} indicating whether the function should affect
37 
    just the first match of the \code{gPath}, or whether all matches
 37 
    just the first match of the \code{gPath}, or whether all matches
38 
    should be affected.
 38 
    should be affected.
39 
  }
 39 
  }
40 
  \item{allDevices}{ A boolean indicating whether all open devices
 40 
  \item{allDevices}{a \code{\link{logical}} indicating whether all open
41 
    should
 - 
 
42 
    be searched for matches, or just the current device.
 41 
    devices should be searched for matches, or just the current device.
43 
    NOT YET IMPLEMENTED.
 42 
    NOT YET IMPLEMENTED.
44 
  }
 43 
  }
45 
  \item{warn}{A logical to indicate whether failing to find the
 44 
  \item{warn}{A logical to indicate whether failing to find the
46 
    specified grob should trigger an error.  }
 45 
    specified grob should trigger an error.  }
47 
  \item{redraw}{A logical value to indicate whether to redraw the grob. }
 46 
  \item{redraw}{A logical value to indicate whether to redraw the grob. }
48 
  \item{\dots}{ Arguments that are passed to \code{grid.get}. }
 47 
  \item{\dots}{arguments passed to \code{\link{grid.get}}.}
49 
}
 48 
}
50 
\details{
 49 
\details{
51 
  \code{removeGrob} copies the specified grob and returns a modified
 50 
  \code{removeGrob} copies the specified grob and returns a modified
52 
  grob.
 51 
  grob.
53 
 
 52 
 
Line 62... Line 61...
62 
  \code{removeGrob} returns a grob object;  \code{grid.remove} returns
 61 
  \code{removeGrob} returns a grob object;  \code{grid.remove} returns
63 
  \code{NULL}.
 62 
  \code{NULL}.
64 
}
 63 
}
65 
\author{Paul Murrell}
 64 
\author{Paul Murrell}
66 
\seealso{
 65 
\seealso{
67 
  \code{\link{grob}}, \code{\link{getGrob}},
 66 
  \code{\link{grob}}, \code{\link{getGrob}}.
68 
  \code{\link{removeGrob}}, \code{\link{removeGrob}}.
 - 
 
69 
}
 67 
}
70 
\keyword{dplot}
 68 
\keyword{dplot}