Export map as an image (non-Shiny context) — export_map

This function exports a map widget as an image file using webshot2 or mapview. Works in non-Shiny contexts like RMarkdown, scripts, or interactive sessions.

Usage

export_map_image(
  map,
  filepath,
  width = 800,
  height = 600,
  delay = 2,
  zoom = 1,
  ...
)

Arguments

map: A map object created by map().
filepath: The file path to save the image (including extension).
width: The width of the image in pixels. Default is 800.
height: The height of the image in pixels. Default is 600.
delay: The delay in seconds before capturing. Default is 2.
zoom: The zoom factor for the capture. Default is 1.
...: Additional arguments passed to webshot2::webshot() or mapview::mapshot().

Value

The file path of the saved image (invisibly).

Examples

# \donttest{
# Load library
library(sf)

data <- data.frame(lon = 174.8210, lat = -41.3096) |>
  sf::st_as_sf(coords = c("lon", "lat"), crs = 4326)
# Create and export a map
my_map <- map() |>
  add_circle_layer("epi_circle", source = data)

export_map_image(my_map, file.path(tempdir(), "my_map.png"), width = 1200, height = 800)
#> file:////private/var/folders/60/t3r81yp572q7bdlk6hg3rc6w0000gn/T/Rtmp5ZrbGt/file75af51d5200e.html screenshot completed
#> Map exported to: /var/folders/60/t3r81yp572q7bdlk6hg3rc6w0000gn/T//Rtmp5ZrbGt/my_map.png
# }