Estimate the display width of a text string — text_width

Returns an estimated display width in inches for a character string rendered in the given font and size. For Courier New (monospace) the estimate is reliable; for proportional fonts (Arial) it is an average-width approximation.

Usage

text_width_in(
  text,
  font = NULL,
  font_size_half_points = 18L,
  size_half_points = NULL
)

Arguments

text: A character vector. NA is treated as "".
font: Font name: "Courier New" / "courier_new", "Courier", or "Arial" (case and spaces do not matter). NULL (default) is the package's font, getOption("rtfreporter.font") ("Courier"), as for every other font =. Unrecognised values fall back to Courier New.
font_size_half_points: Font size in half-points (the unit used by RTF and the document's default_format$font_size_half_points). Default 18 = 9 pt.
size_half_points: Superseded by font_size_half_points (the name every other function uses); documented, still working, not warned.

Value

A numeric vector of estimated widths in inches (same length as text).

Examples

text_width_in("Hello, World!")          # ~0.88 inches at 9pt Courier New
#> [1] 0.9777083
text_width_in("abc", font_size_half_points = 24)   # 12pt
#> [1] 0.3008333