Create a rect grob

ig_bbox is a simple variant where the (x, y) coords default to defining the bottom left corner. This can be easier to reason about in some cases.

ig_bbox(
  x = 0,
  y = 0,
  width = 1,
  height = 1,
  just = c("left", "bottom"),
  hjust = NULL,
  vjust = NULL,
  default.units = getOption("ingrid.default.units", "npc"),
  name = NULL,
  gp = NULL,
  vp = NULL,
  col,
  fill,
  alpha,
  lty,
  lwd,
  lex,
  lineend,
  linejoin,
  linemitre,
  fontsize,
  cex,
  fontfamily,
  fontface,
  lineheight,
  mask,
  clip,
  layout,
  layout.pos.row,
  layout.pos.col
)

ig_rect(
  x = 0.5,
  y = 0.5,
  width = 1,
  height = 1,
  just = "centre",
  hjust = NULL,
  vjust = NULL,
  default.units = getOption("ingrid.default.units", "npc"),
  name = NULL,
  gp = NULL,
  vp = NULL,
  col,
  fill,
  alpha,
  lty,
  lwd,
  lex,
  lineend,
  linejoin,
  linemitre,
  fontsize,
  cex,
  fontfamily,
  fontface,
  lineheight,
  mask,
  clip,
  layout,
  layout.pos.row,
  layout.pos.col
)

Arguments

x, y

x,y location

width, height

extents

just

The justification of the shape relative to its (x, y) location. If there are two values, the first value specifies horizontal justification and the second value specifies vertical justification. Possible string values are: "left", "right", "centre", "center", "bottom", and "top". For numeric values, 0 means left alignment and 1 means right alignment.

hjust

A numeric vector specifying horizontal justification. If specified, overrides the just setting.

vjust

A numeric vector specifying vertical justification. If specified, overrides the just setting.

default.units

getOption("ingrid.default.units", 'npc')

name

grob name. default: NULL

gp

graphical parameter object created by grid::gpar() or ingrid::gp(). If NULL (default), then a gpar object is created from the relevant arguments to this function i.e. fill, col, etc

vp

viewport object created by grid::viewport(). If NULL (default), then a viewport object is created from a limited subset of arguments to this function i.e. mask, clip, etc

col, fill, alpha, lty, lwd, lex, lineend, linejoin, linemitre, fontsize, cex, fontfamily, fontface, lineheight

See documentation for gp()

mask, clip, layout, layout.pos.row, layout.pos.col

See documentation for grid::viewport()

See also

Other grobs: ig_bezier(), ig_circle(), ig_lines(), ig_null(), ig_path(), ig_points(), ig_polygon(), ig_polyline(), ig_raster(), ig_roundrect(), ig_segments(), ig_text()

Examples

if (FALSE) {
ig_bbox(width = 40, fill = 'red')
}