mapsf (version 0.11.0)

mf_legend_c: Plot a legend for a choropleth map

Description

Deprecated.

This function plots a legend for a choropleth map.

Usage

mf_legend_c(
  pos = "topleft",
  val,
  pal,
  title = "Legend Title",
  title_cex = 0.8,
  val_cex = 0.6,
  val_rnd = 2,
  col_na = "white",
  no_data = FALSE,
  no_data_txt = "No Data",
  frame = FALSE,
  border,
  bg,
  fg,
  cex = 1
)

Value

No return value, a legend is displayed.

Arguments

pos

position of the legend, one of "topleft", "top", "topright", "right", "bottomright", "bottom", "bottomleft", "left", "interactive" or a vector of two coordinates in map units (c(x, y))

val

break labels

pal

a set of colors.

title

title of the legend

title_cex

size of the legend title

val_cex

size of the values in the legend

val_rnd

number of decimal places of the values in the legend.

col_na

color for missing values

no_data

if TRUE a "missing value" box is plotted

no_data_txt

label for missing values

frame

whether to add a frame to the legend (TRUE) or not (FALSE)

border

color of the boxes' borders

bg

background of the legend

fg

foreground of the legend

cex

size of the legend; 2 means two times bigger

Examples

if (FALSE) {
plot.new()
plot.window(xlim = c(0, 1), ylim = c(0, 1), asp = 1)
mf_legend_c(val = c(1, 2, 3, 4), pal = c("red1", "red3", "red4"))
}