| % File src/library/grid/man/grid.show.layout.Rd |
| % Part of the R package, https://www.R-project.org |
| % Copyright 1995-2013 R Core Team |
| % Distributed under GPL 2 or later |
| |
| \name{grid.show.layout} |
| \alias{grid.show.layout} |
| \title{Draw a Diagram of a Grid Layout} |
| \description{ |
| This function uses Grid graphics to draw a diagram of a |
| Grid layout. |
| } |
| \usage{ |
| grid.show.layout(l, newpage=TRUE, vp.ex = 0.8, bg = "light grey", |
| cell.border = "blue", cell.fill = "light blue", |
| cell.label = TRUE, label.col = "blue", |
| unit.col = "red", vp = NULL, \dots) |
| } |
| \arguments{ |
| \item{l}{A Grid layout object.} |
| \item{newpage}{A logical value indicating whether to move on |
| to a new page before drawing the diagram.} |
| \item{vp.ex}{positive number, typically in \eqn{(0,1]}, specifying the |
| scaling of the layout.} |
| \item{bg}{The colour used for the background.} |
| \item{cell.border}{The colour used to draw the borders of the cells |
| in the layout.} |
| \item{cell.fill}{The colour used to fill the cells in the layout.} |
| \item{cell.label}{A logical indicating whether the layout cells |
| should be labelled.} |
| \item{label.col}{The colour used for layout cell labels.} |
| \item{unit.col}{The colour used for labelling the widths/heights of |
| columns/rows.} |
| \item{vp}{A Grid viewport object (or NULL).} |
| \item{\dots}{Arguments passed to \code{format} for formatting the |
| layout width and height annotations.} |
| } |
| \details{ |
| A viewport is created within \code{vp} to provide a margin for |
| annotation, and the layout is drawn within that new viewport. |
| The margin is filled with light grey, the new viewport is filled |
| with white and framed with a black border, and the layout regions |
| are filled with light blue and framed with a blue border. |
| The diagram is annotated with the widths and heights (including units) |
| of the columns and rows of the layout using red text. (All colours |
| are defaults and may be customised via function arguments.) |
| } |
| \value{ |
| None. |
| } |
| \author{Paul Murrell} |
| \seealso{ |
| \link{Grid}, |
| \code{\link{viewport}}, |
| \code{\link{grid.layout}} |
| } |
| |
| \examples{ |
| ## Diagram of a simple layout |
| grid.show.layout(grid.layout(4,2, |
| heights=unit(rep(1, 4), |
| c("lines", "lines", "lines", "null")), |
| widths=unit(c(1, 1), "inches"))) |
| } |
| \keyword{dplot} |