gdtools (version 0.5.0)

m_str_extents: Compute string extents for a vector of strings.

Description

For each x element, determines the width and height of a bounding box that's big enough to (just) enclose the provided text. Unit is points.

Usage

m_str_extents(
  x,
  fontname = "sans",
  fontsize = 10,
  bold = FALSE,
  italic = FALSE,
  fontfile = NULL
)

Arguments

x

Character vector of strings to measure

fontname

Font name. A character vector, recycled to match x.

fontsize

Font size. A numeric vector, recycled to match x.

bold, italic

Is text bold/italic? A logical vector, recycled to match x.

fontfile

Font file. A character vector, recycled to match x.

See Also

Other functions for font metrics: str_metrics(), strings_sizes()

Examples

# \donttest{
# The first run can be slow when font caches are missing
# as font files are then being scanned to build those font caches.
m_str_extents(letters, fontsize = 1:26)
m_str_extents(letters[1:3],
  bold = c(TRUE, FALSE, TRUE),
  italic = c(FALSE, TRUE, TRUE),
  fontname = c("sans", "sans", "sans") )
# }