Skip to contents

Scalebar

Source: R/bt_functions.R
bt_scalebar.Rd

Scalebar

Usage

bt_scalebar(
  bertin,
  x = "left",
  y = "bottom",
  units = "kilometers",
  display = TRUE
)

Arguments

bertin

map object

x

position in x (pixel)

y

position in y (pixel)

units

distance unit, miles or kilometers

display

Boolean to allow to show or hide the layer. This parameter has no effect on the calculation of the extent

Value

a map object

Examples

library(sf)
world <- st_read(system.file("gpkg/world.gpkg", package = "bertin"),
                 layer = "world", quiet = TRUE)
bt_outline(fill = "#ADD8F7") |>
  bt_layer(data = world) |>
  bt_scalebar() |>
  bt_draw()