tm_legend: Legend

In r-tmap/tmap: Thematic Maps

Legend

Description

Legend specification

Usage

tm_legend(
  title,
  show,
  orientation,
  design,
  reverse,
  na.show,
  position,
  width,
  height,
  stack,
  z,
  group.frame,
  resize.as.group,
  title.color,
  title.size,
  title.fontface,
  title.fontfamily,
  title.padding,
  text.color,
  text.size,
  text.fontface,
  text.fontfamily,
  format,
  frame,
  frame.lwd,
  frame.r,
  bg.color,
  bg.alpha,
  item.height,
  item.width,
  item.space,
  item.na.height,
  item.na.width,
  item.na.space,
  item.shape,
  ticks,
  ticks.disable.na,
  ticks.col,
  ticks.lwd,
  title.align,
  margins,
  margin.item.text,
  ...
)

tm_legend_hide()

tm_legend_combine(variable)

Arguments

title	Legend title
show	Show legend?
orientation	Orientation of the legend: "portrait" or "landscape"
design	PARAM_DESCRIPTION
reverse	Should the legend be reversed?
na.show	PARAM_DESCRIPTION
position	PARAM_DESCRIPTION
width	Width of the legend
height	Height of the legend
stack	PARAM_DESCRIPTION
z	PARAM_DESCRIPTION
group.frame	PARAM_DESCRIPTION
resize.as.group	PARAM_DESCRIPTION
title.color	Color of the legend title
title.size	Size of the legend title
title.fontface	Font face of the legend title
title.fontfamily	Font family of the legend title
title.padding	PARAM_DESCRIPTION
text.color	Color of the legend text
text.size	Size of the legend text
text.fontface	Font face of the legend text
text.fontfamily	Font family of the legend text
format	PARAM_DESCRIPTION
frame	PARAM_DESCRIPTION
frame.lwd	PARAM_DESCRIPTION
frame.r	PARAM_DESCRIPTION
bg.color	Background color of the legend
bg.alpha	Background transparency of the legend
item.height	PARAM_DESCRIPTION
item.width	PARAM_DESCRIPTION
item.space	PARAM_DESCRIPTION
item.na.height	PARAM_DESCRIPTION
item.na.width	PARAM_DESCRIPTION
item.na.space	PARAM_DESCRIPTION
item.shape	PARAM_DESCRIPTION
ticks	PARAM_DESCRIPTION
ticks.disable.na	PARAM_DESCRIPTION
ticks.col	PARAM_DESCRIPTION
ticks.lwd	PARAM_DESCRIPTION
title.align	PARAM_DESCRIPTION
margins	PARAM_DESCRIPTION
margin.item.text	PARAM_DESCRIPTION
...	passed on (?)
variable	visual (or transformation) variable to combine the legend with: e.g. "fill" or "size"

Value

OUTPUT_DESCRIPTION

r-tmap/tmap documentation built on June 23, 2024, 9:58 a.m.