Skip to contents

String legend

Source: R/guide_stringlegend.R
guide_stringlegend.Rd

[Questioning] This type of legend shows colour and fill mappings as coloured text. It does not draw keys as guide_legend() does. The function is questioned due to a possible migration of guide functions after ggplot2 releases a new guide system.

Usage

guide_stringlegend(
  title = waiver(),
  title.position = NULL,
  title.theme = NULL,
  title.hjust = NULL,
  title.vjust = NULL,
  label.theme = NULL,
  label.hjust = NULL,
  label.vjust = NULL,
  family = NULL,
  face = NULL,
  size = NULL,
  spacing.x = NULL,
  spacing.y = NULL,
  spacing = NULL,
  default.units = "pt",
  direction = NULL,
  nrow = NULL,
  ncol = NULL,
  byrow = FALSE,
  reverse = FALSE,
  order = 0,
  ...
)

Arguments

title

A character string or expression indicating a title of guide. If NULL, the title is not shown. By default (waiver()), the name of the scale object or the name specified in labs() is used for the title.

title.position

A character string indicating the position of a title. One of "top", "bottom", "left" or "right".

title.theme

A theme object for rendering the title text.

title.hjust, title.vjust

A number specifying horizontal and vertical justification of the title text.

label.theme

A theme object for rendering the legend text.

label.hjust, label.vjust

A numer specifying horizontal and vertical justification of the legend text.

family

A character(1) setting a font family for labels.

face

A character(1) setting a font face for labels. One of the following: "plain", "italic" or "bold", "bold.italic".

size

A numeric(1) setting the label text size in pts.

spacing.x, spacing.y, spacing

A numeric(1) or unit for the spacing between label rows and columns. Internally defaults to half the size of the title.

default.units

A character(1) indicating the default units to use if the spacing.* arguments are only given as numeric vectors.

direction

A character string indicating the direction of the guide. One of "horizontal" or "vertical."

nrow, ncol

The desired number of rows and column of legends respectively.

byrow

logical. If FALSE (default) the legend-matrix is filled by columns, otherwise the legend-matrix is filled by rows.

reverse

logical. If TRUE the order of legends is reversed.

order

positive integer less than 99 that specifies the order of this guide among multiple guides. This controls the order in which multiple guides are displayed, not the contents of the guide itself. If 0 (default), the order is determined by a secret algorithm.

...

ignored.

Value

A guide, stringlegend S3 object.

Examples

p <- ggplot(mpg, aes(displ, hwy)) +
  geom_point(aes(colour = manufacturer))

# String legend can be set in the `guides()` function
p + guides(colour = guide_stringlegend(ncol = 2))


# The string legend can also be set as argument to the scale
p + scale_colour_viridis_d(guide = "stringlegend")