Map component: scale bar

Map component that adds a scale bar.

Usage

tm_scalebar(
  breaks,
  width,
  allow_clipping,
  text.size,
  text.color,
  color.dark,
  color.light,
  lwd,
  position,
  group_id,
  bg,
  bg.color,
  bg.alpha,
  size = "deprecated",
  stack,
  frame,
  frame.color,
  frame.alpha,
  frame.lwd,
  frame.r,
  margins,
  z
)

Arguments

breaks: breaks. E.g. c(0, 10, 50) places scale bar breaks at 0, 10, and 50 units. These units are specified in tm_shape().
width: width of the scale bar. Units are number of text line heights, which is similar to the number of characters. In case beaks are specified, the width is only handy to finetune the approximated width, e.g. in case clipping of the labels occurs, or there is too much whitespace.
allow_clipping: should clipping of the last label by allowed? If TRUE (default), the last break label including unit is printed even when it doesn't fit the frame. If FALSE it will not be printed. Instead the unit suffix is added to the second last label.
text.size: text size
text.color: text.color
color.dark: color.dark
color.light: color.light
lwd: linewidth
position: The position specification of the component: 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. In case multiple components should be combined (stacked), use group_id and specify component in tm_comp_group().
group_id: Component group id name. All components (e.g. legends, titles, etc) with the same group_id will be grouped. The specifications of how they are placed (e.g. stacking, margins etc.) are determined in tm_comp_group() where its argument id should correspond to group_id.
bg: Show background?
bg.color: Background color
bg.alpha: Background transparency
size: Deprecated (use text.size instead)
stack: stack with other map components, either "vertical" or "horizontal".
frame: frame should a frame be drawn?
frame.color: frame color
frame.alpha: frame alpha transparancy
frame.lwd: frame line width
frame.r: Radius of the rounded frame corners. 0 means no rounding.
margins: margins
z: z index, e.g. the place of the component relative to the other componets

Usage

Arguments

See also