tm_compass: Map component: compass

In tmap: Thematic Maps

Map component: compass

Description

Map component that adds a compass

Usage

tm_compass(
  north,
  type,
  text.size,
  size,
  show.labels,
  cardinal.directions,
  text.color,
  color.dark,
  color.light,
  lwd,
  position,
  bg.color,
  bg.alpha,
  stack,
  just,
  frame,
  frame.lwd,
  frame.r,
  margins,
  z,
  ...
)

Arguments

north	north
type	compass type, one of: "arrow", "4star", "8star", "radar", "rose". The default is controlled by tm_layout (which uses "arrow" for the default style)
text.size	text.size
size	size
show.labels	show.labels
cardinal.directions	cardinal.directions
text.color	text.color
color.dark	color.dark
color.light	color.light
lwd	lwd
position	An object created with tm_pos_in() or tm_pos_out(). Or, as a shortcut, a vector of two values, specifying the x and y coordinates. The first is "left", "center" or "right" (or upper case, meaning tighter to the map frame), the second "top", "center" or "bottom". Numeric values are also supported, where 0, 0 means left bottom and 1, 1 right top. See also vignette about positioning.
bg.color	Background color
bg.alpha	Background transparency
stack	stack with other map components, either "vertical" or "horizontal".
just	just
frame	frame
frame.lwd	frame line width
frame.r	Radius of the rounded frame corners. 0 means no rounding.
margins	margins
z	z
...	to catch deprecated arguments (alpha)

See Also

Vignette about components

tmap documentation built on April 4, 2025, 2:05 a.m.