Add a home button / zoom-to-layer button to a map.

This function adds a button to the map that enables zooming to a provided extent / bbox.

Usage

addHomeButton(
  map,
  ext,
  group = "layer",
  position = "bottomright",
  add = TRUE,
  css = list(),
  hover_css = list()
)

removeHomeButton(map)

Arguments

map: a mapview or leaflet object.
ext: the extent / bbox to zoom to.
group: the name of the group/layer to be zoomed to (or any character string)
position: the position of the button (one of 'topleft', 'topright', 'bottomleft', 'bottomright'). Defaults to 'bottomright'.
add: logical. Whether to add the button to the map (mainly for internal use).
css, hover_css: list of valid CSS key-value pairs. See e.g. https://www.w3schools.com/cssref/index.php for possible values.

Functions

removeHomeButton(): remove a homeButton from a map

Examples

library(leaflet)
library(raster)
#> Loading required package: sp

## pass a group name only
m <- leaflet() %>%
  addProviderTiles("OpenStreetMap") %>%
  addCircleMarkers(data = breweries91, group = "breweries91") %>%
  addHomeButton(group = "breweries91")
m


## pass a raster extent - group can now be an arbitrary label
m <- leaflet() %>%
  addProviderTiles("OpenStreetMap") %>%
  addCircleMarkers(data = breweries91, group = "breweries91") %>%
  addHomeButton(ext = extent(breweries91), group = "Brew")
m


## remove the button
removeHomeButton(m)