geom_textbox: Draw boxes containing text

Description

Draw boxes of defined width and height containing word-wrapped text. Multiple boxes can be drawn at once. Most styling parameters can be used as aesthetics and can be applied separately to each text box drawn. The exception is styling parameters that are specified as grid units (e.g., box.padding or box.r), which can only be specified for all text boxes at once. See examples for details.

Usage

geom_textbox(
  mapping = NULL,
  data = NULL,
  stat = "identity",
  position = "identity",
  ...,
  nudge_x = 0,
  nudge_y = 0,
  box.padding = unit(c(5.5, 5.5, 5.5, 5.5), "pt"),
  box.margin = unit(c(0, 0, 0, 0), "pt"),
  box.r = unit(5.5, "pt"),
  width = unit(2, "inch"),
  minwidth = NULL,
  maxwidth = NULL,
  height = NULL,
  minheight = NULL,
  maxheight = NULL,
  na.rm = FALSE,
  show.legend = NA,
  inherit.aes = TRUE
)

Value

A ggplot2 layer that can be added to a plot created with ggplot2::ggplot().

Arguments

mapping

Set of aesthetic mappings created by aes() or aes_(). If specified and inherit.aes = TRUE (the default), it is combined with the default mapping at the top level of the plot. You must supply mapping if there is no plot mapping.

data

The data to be displayed in this layer. There are three options:

If NULL, the default, the data is inherited from the plot data as specified in the call to ggplot().

A data.frame, or other object, will override the plot data. All objects will be fortified to produce a data frame. See fortify() for which variables will be created.

A function will be called with a single argument, the plot data. The return value must be a data.frame, and will be used as the layer data. A function can be created from a formula (e.g. ~ head(.x, 10)).

stat

The statistical transformation to use on the data for this layer, as a string.

position

Position adjustment, either as a string, or the result of a call to a position adjustment function. Cannot be jointy specified with nudge_x or nudge_y.

...

Other arguments passed on to layer(). These are often aesthetics, used to set an aesthetic to a fixed value, like colour = "red" or size = 3. They may also be parameters to the paired geom/stat.

nudge_x, nudge_y

Horizontal and vertical adjustment to nudge text boxes by. Useful for offsetting text from points, particularly on discrete scales. Cannot be jointly specified with position.

box.padding

Unit vector of length four specifying the padding inside the text box.

box.margin

Unit vector of length four specifying the margin outside the text box.

box.r

Unit vector of length one specifying the radius of the box.

width, height

Unit values specifying the width and height of the text box (including margins!). If height = NULL (the default), the height is chosen automatically to accommodate all the text.

minwidth, maxwidth, minheight, maxheight

Unit values specifying the minimum and maximum values for width and height, respectively. If set to NULL, are not enforced.

na.rm

If FALSE, the default, missing values are removed with a warning. If TRUE, missing values are silently removed.

show.legend

logical. Should this layer be included in the legends? NA, the default, includes if any aesthetics are mapped. FALSE never includes, and TRUE always includes. It can also be a named logical vector to finely select the aesthetics to display.

inherit.aes

If FALSE, overrides the default aesthetics, rather than combining with them. This is most useful for helper functions that define both data and aesthetics and shouldn't inherit behaviour from the default plot specification, e.g. borders().

Aesthetics

geom_textbox() understands the following aesthetics (required aesthetics are in bold; select aesthetics are annotated):

x
y
label
alpha
box.colour Color of box outline. Overrides colour.
box.size Width of box outline.
colour Default color of box text and box outline.
family
fontface
fill Default fill color of box background.
group
halign Horizontal alignment of text inside box.
hjust Horizontal alignment of box.
lineheight
orientation One of "upright", "left-rotated", "right-rotated", "inverted".
size Default font size of box text.
text.colour Color of box text. Overrides colour.
valign Vertical alignment of text inside box.
vjust Vertical alignment of box.

Examples

Run this code

library(ggplot2)

df <- data.frame(
  label = rep("Lorem ipsum dolor **sit amet,** consectetur adipiscing elit,
    sed do *eiusmod tempor incididunt* ut labore et dolore magna
    aliqua.", 2),
  x = c(0, .6),
  y = c(1, .6),
  hjust = c(0, 0),
  vjust = c(1, 0),
  orientation = c("upright", "right-rotated"),
  color = c("black", "blue"),
  fill = c("cornsilk", "white")
)

ggplot(df) +
  aes(
    x, y, label = label, color = color, fill = fill,
    hjust = hjust, vjust = vjust,
    orientation = orientation
  ) +
  geom_textbox(width = unit(0.4, "npc")) +
  geom_point(color = "black", size = 2) +
  scale_discrete_identity(aesthetics = c("color", "fill", "orientation")) +
  xlim(0, 1) + ylim(0, 1)