Type:	Package
Title:	Extra Functionality for 'leaflet' Package
Version:	1.3.1
Description:	Several 'leaflet' plugins are integrated, which are available as extension to the 'leaflet' package.
License:	GPL-3 | file LICENSE
Encoding:	UTF-8
LazyData:	true
Depends:	R (≥ 3.5.0), leaflet (≥ 2.0.0)
Imports:	htmltools, magrittr, utils
Suggests:	jsonlite, shiny, sf, yyjsonr, sp, testthat (≥ 2.1.0), fontawesome, htmlwidgets, grDevices, xfun, covr, curl
URL:	https://trafficonese.github.io/leaflet.extras2/, https://github.com/trafficonese/leaflet.extras2
BugReports:	https://github.com/trafficonese/leaflet.extras2/issues
RoxygenNote:	7.3.2
NeedsCompilation:	no
Packaged:	2025-03-05 09:33:03 UTC; kona1
Author:	Gatscha Sebastian [aut, cre], Ricardo Rodrigo Basa [ctb], Jeffrey O Hanson [ctb]
Maintainer:	Gatscha Sebastian <sebastian_gatscha@gmx.at>
Repository:	CRAN
Date/Publication:	2025-03-05 13:40:06 UTC

leaflet.extras2: Extra Functionality for 'leaflet' Package

Description

Several 'leaflet' plugins are integrated, which are available as extension to the 'leaflet' package.

Author(s)

Maintainer: Gatscha Sebastian sebastian_gatscha@gmx.at

Other contributors:

• Ricardo Rodrigo Basa radbasa@gmail.com [contributor]

• Jeffrey O Hanson jeffrey.hanson@uqconnect.edu.au (ORCID) [contributor]

See Also

Useful links:

• https://trafficonese.github.io/leaflet.extras2/

• https://github.com/trafficonese/leaflet.extras2

• Report bugs at https://github.com/trafficonese/leaflet.extras2/issues

Add LayerGroup Collision Plugin

Description

Integrates the LayerGroup Collision plugin into a Leaflet map, which hides overlapping markers and only displays the first added marker in a collision group. Markers must be static; dynamic changes, dragging, and deletions are not supported. The function transforms spatial data into GeoJSON format and uses 'L.DivIcon', allowing you to pass HTML content and CSS classes to style the markers.

Usage

addLayerGroupCollision(
  map,
  group = NULL,
  className = NULL,
  html = NULL,
  margin = 5,
  data = getMapData(map)
)

Arguments

Value

A leaflet map object with the LayerGroup Collision plugin added.

References

https://github.com/MazeMap/Leaflet.LayerGroup.Collision

Examples

library(leaflet)
library(sf)
library(leaflet.extras2)

df <- sf::st_as_sf(atlStorms2005)
df <- suppressWarnings(st_cast(df, "POINT"))
df$classes <- sample(x = 1:5, nrow(df), replace = TRUE)

leaflet() %>%
  addProviderTiles("CartoDB.Positron") %>%
  leaflet::addLayersControl(overlayGroups = c("Labels")) %>%
  addPolylines(data = sf::st_as_sf(atlStorms2005), label = ~Name) %>%
  addLayerGroupCollision(
    data = df, margin = 40,
    html = ~ paste0(
      '<div style="width: max-content; background-color: #cbc0c04f" class="custom-html">',
      '<div class="title">', Name, "</div>",
      '<div class="subtitle">MaxWind: ', MaxWind, "</div>",
      "</div>"
    ),
    className = ~ paste0("my-label my-label-", classes),
    group = "Labels"
  )

leaflet_mapkey_icon_set

Description

leaflet_mapkey_icon_set

Usage

## S3 method for class 'leaflet_mapkey_icon_set'
x[i]

Arguments

See Also

Other Mapkey Functions: addMapkeyMarkers(), makeMapkeyIcon(), mapkeyIconList(), mapkeyIcons()

Add Antpath Lines

Description

Can be used almost exactly like addPolylines but instead of pathOptions you can use antpathOptions to adapt the Antpath behaviour. See leaflet-ant-path for further details.

Usage

addAntpath(
  map,
  lng = NULL,
  lat = NULL,
  layerId = NULL,
  group = NULL,
  stroke = TRUE,
  color = "#03F",
  weight = 5,
  opacity = 0.5,
  fill = FALSE,
  fillColor = color,
  fillOpacity = 0.2,
  dashArray = NULL,
  smoothFactor = 1,
  noClip = FALSE,
  popup = NULL,
  popupOptions = NULL,
  label = NULL,
  labelOptions = NULL,
  options = antpathOptions(),
  highlightOptions = NULL,
  data = getMapData(map)
)

Arguments

Value

A modified leaflet map, with an 'ant-path' animated polyline

References

https://github.com/rubenspgcavalcante/leaflet-ant-path

See Also

Other Antpath Functions: antpathOptions(), clearAntpath(), removeAntpath()

Examples

library(leaflet)
leaflet() %>%
  addAntpath(data = atlStorms2005)

Add Lines with an arrowhead

Description

Can be used almost exactly like addPolylines but instead of pathOptions you can use arrowheadOptions. See leaflet-arrowheads for further details.

Usage

addArrowhead(
  map,
  lng = NULL,
  lat = NULL,
  layerId = NULL,
  group = NULL,
  stroke = TRUE,
  color = "#03F",
  weight = 5,
  opacity = 0.5,
  fill = FALSE,
  fillColor = color,
  fillOpacity = 0.2,
  dashArray = NULL,
  smoothFactor = 1,
  noClip = FALSE,
  popup = NULL,
  popupOptions = NULL,
  label = NULL,
  labelOptions = NULL,
  options = arrowheadOptions(),
  highlightOptions = NULL,
  data = getMapData(map)
)

Arguments

Value

A modified leaflet map with a polyline with arrowheads

References

https://github.com/slutske22/leaflet-arrowheads

See Also

Other Arrowhead Functions: arrowheadOptions(), clearArrowhead(), removeArrowhead()

Examples

library(leaflet)
leaflet() %>%
  addArrowhead(data = atlStorms2005)

Add OSM-Buildings to a Leaflet Map

Description

This function adds 2.5D buildings to a Leaflet map using the OSM Buildings plugin.

Usage

addBuildings(
  map,
  buildingURL = "https://{s}.data.osmbuildings.org/0.2/59fcc2e8/tile/{z}/{x}/{y}.json",
  group = NULL,
  eachFn = NULL,
  clickFn = NULL,
  data = NULL
)

Arguments

Details

The 'data' parameter allows you to provide custom building data as a GeoJSON object. The following properties can be used within the GeoJSON:

• height

• minHeight

• color/wallColor

• material

• roofColor

• roofMaterial

• shape

• roofShape

• roofHeight

See the OSM Wiki: Simple_3D_Buildings

See Also

https://github.com/kekscom/osmbuildings/ for more details on the OSM Buildings plugin and available properties.

Other OSM-Buildings Plugin: setBuildingData(), setBuildingStyle(), updateBuildingTime()

Examples

library(leaflet)
library(leaflet.extras2)

leaflet() %>%
  addProviderTiles("CartoDB") %>%
  addBuildings(group = "Buildings") %>%
  addLayersControl(overlayGroups = "Buildings") %>%
  setView(lng = 13.4, lat = 52.51, zoom = 15)

addClusterCharts

Description

Clusters markers on a Leaflet map and visualizes them using customizable charts, such as pie or bar charts, showing counts by category. When using the "custom" type, a pie chart is rendered with aggregated data, employing methods like sum, min, max, mean, or median.

Usage

addClusterCharts(
  map,
  layerId = NULL,
  group = NULL,
  type = c("pie", "bar", "horizontal", "custom"),
  aggregation = c("sum", "min", "max", "mean", "median"),
  valueField = NULL,
  options = clusterchartOptions(),
  icon = NULL,
  html = NULL,
  popup = NULL,
  popupOptions = NULL,
  label = NULL,
  labelOptions = NULL,
  clusterOptions = NULL,
  clusterId = NULL,
  categoryField,
  categoryMap,
  popupFields = NULL,
  popupLabels = NULL,
  markerOptions = NULL,
  legendOptions = list(title = "", position = "topright"),
  data = getMapData(map)
)

Arguments

Details

The ‘clusterCharts' use Leaflet’s 'L.DivIcon', allowing you to fully customize the styling of individual markers and clusters using CSS. Each individual marker within a cluster is assigned the CSS class 'clustermarker', while the entire cluster is assigned the class 'clustermarker-cluster'. You can modify the appearance of these elements by targeting these classes in your custom CSS.

See Also

Other clusterCharts: clusterchartOptions()

Examples

# Example usage:
library(sf)
library(leaflet)
library(leaflet.extras2)

data <- sf::st_as_sf(breweries91)
categories <- c("Schwer", "Mäßig", "Leicht", "kein Schaden")
data$category <- sample(categories, size = nrow(data), replace = TRUE)

## Pie Chart
leaflet() %>%
  addProviderTiles("CartoDB.Positron") %>%
  leaflet::addLayersControl(overlayGroups = "clustermarkers") %>%
  addClusterCharts(
    data = data,
    categoryField = "category",
    categoryMap = data.frame(
      labels = categories,
      colors = c("#F88", "#FA0", "#FF3", "#BFB"),
      strokes = "gray"
    ),
    group = "clustermarkers",
    popupFields = c("brewery", "address", "zipcode", "category"),
    popupLabels = c("Brauerei", "Adresse", "PLZ", "Art"),
    label = "brewery"
  )

## Bar Chart
leaflet() %>%
  addProviderTiles("CartoDB.Positron") %>%
  leaflet::addLayersControl(overlayGroups = "clustermarkers") %>%
  addClusterCharts(
    data = data,
    type = "bar",
    categoryField = "category",
    categoryMap = data.frame(
      labels = categories,
      colors = c("#F88", "#FA0", "#FF3", "#BFB"),
      strokes = "gray"
    ),
    group = "clustermarkers",
    popupFields = c("brewery", "address", "zipcode", "category"),
    popupLabels = c("Brauerei", "Adresse", "PLZ", "Art"),
    label = "brewery"
  )

## Custom Pie Chart with "mean" aggregation on column "value"
data <- sf::st_as_sf(breweries91)
categories <- c("Schwer", "Mäßig", "Leicht", "kein Schaden")
data$category <- sample(categories, size = nrow(data), replace = TRUE)
data$value <- round(runif(nrow(data), 0, 100), 0)

leaflet() %>%
  addProviderTiles("CartoDB.Positron") %>%
  leaflet::addLayersControl(overlayGroups = "clustermarkers") %>%
  addClusterCharts(
    data = data,
    type = "custom",
    valueField = "value",
    aggregation = "mean",
    categoryField = "category",
    categoryMap = data.frame(
      labels = categories,
      colors = c("#F88", "#FA0", "#FF3", "#BFB"),
      strokes = "gray"
    ),
    options = clusterchartOptions(rmax = 50, digits = 0, innerRadius = 20),
    group = "clustermarkers",
    popupFields = c("brewery", "address", "zipcode", "category", "value"),
    popupLabels = c("Brauerei", "Adresse", "PLZ", "Art", "Value"),
    label = "brewery"
  )

## For Shiny examples, please run:
# runApp(system.file("examples/clusterCharts_app.R", package = "leaflet.extras2"))
# runApp(system.file("examples/clustercharts_sum.R", package = "leaflet.extras2"))

Add contextmenu Plugin

Description

Add a contextmenu to the map or markers/vector layers.

Usage

addContextmenu(map)

Arguments

Details

This function is only used to include the required JavaScript and CSS bindings and to set up some Shiny event handlers.

Contextmenu initialization

The contextmenu for

• the map must be defined in leafletOptions.

• the markers/vector layers must be defined in markerOptions or pathOptions.

Contextmenu selection

When a contextmenu is selected, a Shiny input with the ID "MAPID_contextmenu_select" is set (‘MAPID' refers to the map’s id).

If the selected contextmenu item is triggered from:

• the map, the returned list contains the text of the item.

• the markers, the returned list also contains the layerId, group, lat, lng and label.

• the vector layers, the returned list also contains the layerId, group and label.

Value

A leaflet map object

References

https://github.com/aratcliffe/Leaflet.contextmenu

See Also

Other Contextmenu Functions: addItemContextmenu(), context_mapmenuItems(), context_markermenuItems(), context_menuItem(), disableContextmenu(), enableContextmenu(), hideContextmenu(), insertItemContextmenu(), mapmenuItems(), markermenuItems(), menuItem(), removeItemContextmenu(), removeallItemsContextmenu(), setDisabledContextmenu(), showContextmenu()

Examples

library(leaflet)
leaflet(options = leafletOptions(
  contextmenu = TRUE,
  contextmenuWidth = 200,
  contextmenuItems =
    context_mapmenuItems(
      context_menuItem("Zoom Out", "function(e) {this.zoomOut()}", disabled = FALSE),
      "-",
      context_menuItem("Zoom In", "function(e) {this.zoomIn()}")
    )
)) %>%
  addTiles(group = "base") %>%
  addContextmenu() %>%
  addMarkers(
    data = breweries91, label = ~brewery,
    layerId = ~founded, group = "marker",
    options = markerOptions(
      contextmenu = TRUE,
      contextmenuWidth = 200,
      contextmenuItems =
        context_markermenuItems(
          context_menuItem(
            text = "Show Marker Coords",
            callback = "function(e) {alert(e.latlng);}",
            index = 1
          )
        )
    )
  )

Add DivIcon Markers to a Leaflet Map

Description

Adds customizable DivIcon markers to a Leaflet map. The function can accept either spatial data (lines or points) in the form of a Simple Feature (sf) object or numeric vectors for latitude and longitude coordinates. It allows for the application of custom HTML content and CSS classes to each marker, providing high flexibility in marker design.

Usage

addDivicon(
  map,
  lng = NULL,
  lat = NULL,
  layerId = NULL,
  group = NULL,
  popup = NULL,
  popupOptions = NULL,
  label = NULL,
  labelOptions = NULL,
  className = NULL,
  html = NULL,
  options = markerOptions(),
  clusterOptions = NULL,
  clusterId = NULL,
  divOptions = list(),
  data = getMapData(map)
)

Arguments

Value

The modified Leaflet map object.

Examples

library(sf)
library(leaflet)
library(leaflet.extras2)

# Sample data
df <- sf::st_as_sf(atlStorms2005)
df <- suppressWarnings(st_cast(df, "POINT"))
df <- df[sample(1:nrow(df), 50, replace = FALSE), ]
df$classes <- sample(x = c("myclass1", "myclass2", "myclass3"), nrow(df), replace = TRUE)
df$ID <- paste0("ID_", 1:nrow(df))

leaflet() %>%
  addTiles() %>%
  addDivicon(
    data = df,
    html = ~ paste0(
      '<div class="custom-html">',
      '<div class="title">', Name, "</div>",
      '<div class="subtitle">MaxWind: ', MaxWind, "</div>",
      "</div>"
    ),
    label = ~Name,
    layerId = ~ID,
    group = "Divicons",
    popup = ~ paste(
      "ID: ", ID, "<br>",
      "Name: ", Name, "<br>",
      "MaxWind:", MaxWind, "<br>",
      "MinPress:", MinPress
    ),
    options = markerOptions(draggable = TRUE)
  )

Add easyPrint Plugin

Description

Add a control, which allows to print or export a map as .PNG.

Usage

addEasyprint(map, options = easyprintOptions())

Arguments

Value

A leaflet map object

References

https://github.com/rowanwins/leaflet-easyPrint

See Also

Other EasyPrint Functions: easyprintMap(), easyprintOptions(), removeEasyprint()

Examples

library(leaflet)
leaflet() %>%
  addTiles() %>%
  addEasyprint(options = easyprintOptions(
    title = "Print map",
    position = "bottomleft",
    exportOnly = TRUE
  ))

Add GIBS Layers

Description

A leaflet plugin for NASA EOSDIS GIBS imagery integration. 154 products are available. The date can be set dynamically for multi-temporal products. No-data pixels of MODIS Multiband Imagery can be made transparent.

Usage

addGIBS(
  map,
  layers = NULL,
  group = NULL,
  dates = NULL,
  opacity = 0.5,
  transparent = TRUE
)

Arguments

Value

the new map object

References

https://github.com/aparshin/leaflet-GIBS

See Also

Other GIBS Functions: setDate(), setTransparent()

Examples

library(leaflet)
library(leaflet.extras2)

layers <- gibs_layers$title[c(35, 128, 185)]

leaflet() %>%
  addTiles() %>%
  setView(9, 50, 4) %>%
  addGIBS(
    layers = layers,
    dates = Sys.Date() - 1,
    group = layers
  ) %>%
  addLayersControl(overlayGroups = layers)

Add a Heightgraph layer

Description

Visualize height information and road attributes of linestring segments. The linestrings must be a Simple Feature LINESTRING Z and are transformed to GeoJSON. The function therefore inherits arguments from addGeoJSON.

Usage

addHeightgraph(
  map,
  data = NULL,
  columns = NULL,
  layerId = NULL,
  group = NULL,
  color = "#03F",
  weight = 5,
  opacity = 0.5,
  dashArray = NULL,
  smoothFactor = 1,
  noClip = FALSE,
  pathOpts = leaflet::pathOptions(),
  options = heightgraphOptions()
)

Arguments

Value

the new map object

Note

When used in Shiny, 3 events update a certain Shiny Input:

1. A click updates input$MAPID_heightgraph_click

2. A mouseover updates input$MAPID_heightgraph_mouseover

3. A mouseout updates input$MAPID_heightgraph_mouseout

If you want to explicitly remove the Heightgraph control, please use removeControl with the layerId = "hg_control".

References

https://github.com/GIScience/Leaflet.Heightgraph

See Also

Other Heightgraph Functions: heightgraphOptions()

Examples

library(leaflet)
library(leaflet.extras2)
library(sf)

data <- st_cast(st_as_sf(leaflet::atlStorms2005[4, ]), "LINESTRING")
data <- st_transform(data, 4326)
data <- data.frame(st_coordinates(data))
data$elev <- round(runif(nrow(data), 10, 500), 2)
data$L1 <- NULL
L1 <- round(seq.int(1, 4, length.out = nrow(data)))
data <- st_as_sf(st_sfc(lapply(split(data, L1), function(x) {
  st_linestring(as.matrix(x))
})))
data$steepness <- 1:nrow(data)
data$suitability <- nrow(data):1
data$popup <- apply(data, 1, function(x) {
  sprintf("Steepness: %s<br>Suitability: %s", x$steepness, x$suitability)
})

leaflet() %>%
  addTiles(group = "base") %>%
  addHeightgraph(
    color = "red", columns = c("steepness", "suitability"),
    opacity = 1, data = data, group = "heightgraph",
    options = heightgraphOptions(width = 400)
  )

Add a Hexbin layer

Description

Create dynamic hexbin-based heatmaps on Leaflet maps. This plugin leverages the data-binding power of d3 to allow you to dynamically update the data and visualize the transitions.

Usage

addHexbin(
  map,
  lng = NULL,
  lat = NULL,
  radius = 20,
  layerId = NULL,
  group = NULL,
  opacity = 0.5,
  options = hexbinOptions(),
  data = getMapData(map)
)

Arguments

Value

the new map object

Note

Currently doesn't respect layerId nor group.

References

https://github.com/bluehalo/leaflet-d3#hexbins-api

See Also

Other Hexbin-D3 Functions: clearHexbin(), hexbinOptions(), hideHexbin(), showHexbin(), updateHexbin()

Examples

library(leaflet)
library(leaflet.extras2)

n <- 1000
df <- data.frame(
  lat = rnorm(n, 42.0285, .01),
  lng = rnorm(n, -93.65, .01)
)

leaflet() %>%
  addTiles() %>%
  addHexbin(
    lng = df$lng, lat = df$lat,
    options = hexbinOptions(
      colorRange = c("red", "yellow", "blue"),
      radiusRange = c(10, 20)
    )
  )

Add History Plugin

Description

The plugin enables tracking of map movements in a history similar to a web browser. By default, it is a simple pair of buttons – back and forward.

Usage

addHistory(map, layerId = NULL, options = historyOptions())

Arguments

Value

the new map object

References

https://github.com/cscott530/leaflet-history

See Also

Other History Functions: clearFuture(), clearHistory(), goBackHistory(), goForwardHistory(), historyOptions()

Examples

library(leaflet)
leaflet() %>%
  addTiles() %>%
  addHistory()

addItemContextmenu

Description

Add a new contextmenu menu item

Usage

addItemContextmenu(map, option)

Arguments

Value

A leaflet map object

See Also

Other Contextmenu Functions: addContextmenu(), context_mapmenuItems(), context_markermenuItems(), context_menuItem(), disableContextmenu(), enableContextmenu(), hideContextmenu(), insertItemContextmenu(), mapmenuItems(), markermenuItems(), menuItem(), removeItemContextmenu(), removeallItemsContextmenu(), setDisabledContextmenu(), showContextmenu()

Add addLabelgun Plugin

Description

The plugin allows to avoid cluttering in marker labels and gives priority to labels of your choice (with higher weight).

Usage

addLabelgun(map, group = NULL, weight = NULL, entries = NULL)

Arguments

Value

A leaflet map object

Note

It is important to invoke the function after the markers have been added to the map. Otherwise nothing will happen.

References

https://github.com/Geovation/labelgun

Examples

library(leaflet)
library(leaflet.extras2)

leaflet() %>%
  addTiles() %>%
  addMarkers(
    data = breweries91,
    label = ~brewery,
    group = "markers",
    labelOptions = labelOptions(permanent = TRUE)
  ) %>%
  addLabelgun("markers", 1)

addLayerGroupConditional

Description

addLayerGroupConditional

Usage

addLayerGroupConditional(map, groups = NULL, conditions = NULL)

Arguments

  condition = list(
    "(zoomLevel) => zoomLevel < 4" = "group1",
    "(zoomLevel) => zoomLevel >= 4 && zoomLevel < 6" = "group2",
    "(zoomLevel) => zoomLevel >= 6" = c("group3", "group4")
  )

See Also

https://github.com/Solfisk/Leaflet.LayerGroup.Conditional?tab=readme-ov-file for more details about the plugin.

Other LayerGroupConditional Plugin: clearConditionalLayers(), removeConditionalLayer()

Examples

library(leaflet)
library(sf)
library(leaflet.extras2)

breweries91 <- st_as_sf(breweries91)
lines <- st_as_sf(atlStorms2005)
polys <- st_as_sf(leaflet::gadmCHE)
groups <- c("atlStorms", "breweries", "gadmCHE")

leaflet() %>%
  addTiles() %>%
  # leafem::addMouseCoordinates() %>%
  addPolylines(data = lines, label = ~Name, group = groups[1]) %>%
  addCircleMarkers(data = breweries91, label = ~brewery, group = groups[2]) %>%
  addPolygons(data = polys, label = ~NAME_1, group = groups[3]) %>%
  addLayerGroupConditional(
    groups = groups,
    conditions = list(
      "(zoomLevel) => zoomLevel < 4" = groups[1],
      "(zoomLevel) => zoomLevel >= 4 & zoomLevel < 6 " = groups[2],
      "(zoomLevel) => zoomLevel >= 6" = groups[3]
    )
  ) %>%
  hideGroup(groups) %>%
  addLayersControl(
    overlayGroups = groups,
    options = layersControlOptions(collapsed = FALSE)
  )

Synchronize multiple Leaflet map

Description

The plugin allows you to synchronize and unsynchronize multiple leaflet maps in a Shiny application. You can pass additional options to leafletsyncOptions. For more information see Leaflet.Sync

Usage

addLeafletsync(
  map,
  ids = NULL,
  synclist = "all",
  options = leafletsyncOptions()
)

Arguments

Value

A modified leaflet map

Note

If you synchronize multiple maps, a map may not yet be initialized and therefore cannot be used. Make sure to use addLeafletsync after all maps have been rendered.

References

https://github.com/jieter/Leaflet.Sync

See Also

Other leafletsync Functions: addLeafletsyncDependency(), isSynced(), leafletsyncOptions(), unsync()

Add the Leaflet Sync JS dependencies

Description

Sometimes it makes sense to include the Leaflet Sync dependencies already before synchronizing maps. For example, if you want to use the 'L.Sync.offsetHelper'. See the example in ./inst/examples/offsetHelper.R

Usage

addLeafletsyncDependency(map)

Arguments

Value

A modified leaflet map

See Also

Other leafletsync Functions: addLeafletsync(), isSynced(), leafletsyncOptions(), unsync()

Add Mapkey Markers

Description

Add Mapkey Markers

Usage

addMapkeyMarkers(
  map,
  lng = NULL,
  lat = NULL,
  layerId = NULL,
  group = NULL,
  icon = NULL,
  popup = NULL,
  popupOptions = NULL,
  label = NULL,
  labelOptions = NULL,
  options = leaflet::markerOptions(),
  clusterOptions = NULL,
  clusterId = NULL,
  data = leaflet::getMapData(map)
)

Arguments

Value

the new map object

References

https://github.com/mapshakers/leaflet-mapkey-icon

See Also

Other Mapkey Functions: [.leaflet_mapkey_icon_set(), makeMapkeyIcon(), mapkeyIconList(), mapkeyIcons()

Examples

library(leaflet)

leaflet() %>%
  addTiles() %>%
  addMapkeyMarkers(
    data = breweries91,
    icon = makeMapkeyIcon(
      icon = "mapkey",
      iconSize = 30,
      boxShadow = FALSE,
      background = "transparent"
    ),
    group = "mapkey",
    label = ~state, popup = ~village
  )

Add Moving Markers

Description

The function expects either line or point data as spatial data or as Simple Feature. Alternatively, coordinates can also be passed as numeric vectors.

Usage

addMovingMarker(
  map,
  lng = NULL,
  lat = NULL,
  layerId = NULL,
  group = NULL,
  duration = 2000,
  icon = NULL,
  popup = NULL,
  popupOptions = NULL,
  label = NULL,
  labelOptions = NULL,
  movingOptions = movingMarkerOptions(),
  options = leaflet::markerOptions(),
  data = leaflet::getMapData(map)
)

Arguments

Value

the new map object

References

https://github.com/ewoken/Leaflet.MovingMarker

See Also

Other MovingMarker Functions: movingMarkerOptions(), startMoving()

Examples

library(sf)
library(leaflet)
library(leaflet.extras2)

crds <- data.frame(structure(
  c(
    -67.5, -68.5, -69.6, -70.5, -71.3, -72.2, -72.7,
    -72.9, -73, -72.4, -70.8, 15.8, 16.5, 17.3, 17.8, 18.3, 18.6,
    19.8, 21.6, 23.5, 25.1, 27.9, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1
  ),
  dim = c(11L, 3L), dimnames = list(NULL, c("X", "Y", "L1"))
))
df <- st_sf(st_sfc(st_linestring(as.matrix(crds), dim = "XYZ"), crs = 4326))
st_geometry(df) <- "geometry"
df <- st_zm(df)

leaflet() %>%
  addTiles() %>%
  addPolylines(data = df) %>%
  addMovingMarker(
    data = df,
    movingOptions = movingMarkerOptions(autostart = TRUE, loop = TRUE),
    label = "I am a pirate!",
    popup = "Arrr"
  )

Add current OpenWeatherMap Marker

Description

Add current OpenWeatherMap Marker

Usage

addOpenweatherCurrent(
  map,
  apikey = NULL,
  group = NULL,
  layerId = NULL,
  options = openweatherCurrentOptions()
)

Arguments

Value

the new map object

Note

The current weather icons will appear beginning with zoom level 9 and if used in Shiny, a click on an icon will update a Shiny input at input$MAPID_owm_click.

References

https://github.com/trafficonese/leaflet-openweathermap

See Also

Other Openweathermap Functions: addOpenweatherTiles(), openweatherCurrentOptions(), openweatherOptions()

Examples

## Not run: 
library(leaflet)
library(leaflet.extras2)

Sys.setenv("OPENWEATHERMAP" = "Your_API_Key")

leaflet() %>%
  addTiles() %>%
  setView(9, 50, 9) %>%
  addOpenweatherCurrent(options = openweatherCurrentOptions(
    lang = "en", popup = TRUE
  ))

## End(Not run)

Add OpenWeatherMap Tiles

Description

Add OpenWeatherMap Tiles

Usage

addOpenweatherTiles(
  map,
  apikey = NULL,
  layers = NULL,
  group = NULL,
  layerId = NULL,
  opacity = 0.5,
  options = openweatherOptions()
)

Arguments

Value

the new map object

Note

Out of the box a legend image is only available for Pressure, Precipitation Classic, Clouds Classic, Rain Classic, Snow, Temperature and Wind Speed. Please add your own images if you need some more.

References

https://github.com/trafficonese/leaflet-openweathermap

See Also

Other Openweathermap Functions: addOpenweatherCurrent(), openweatherCurrentOptions(), openweatherOptions()

Examples

## Not run: 
library(leaflet)
library(leaflet.extras2)

Sys.setenv("OPENWEATHERMAP" = "Your_API_Key")

leaflet() %>%
  addTiles() %>%
  setView(9, 50, 6) %>%
  addOpenweatherTiles(layers = "wind")

## End(Not run)

Add Playback to Leaflet

Description

The LeafletPlayback plugin provides the ability to replay GPS Points in the form of POINT Simple Features. Rather than simply animating a marker along a polyline, the speed of the animation is synchronized to a clock. The playback functionality is similar to a video player; you can start and stop playback or change the playback speed.

Usage

addPlayback(
  map,
  data,
  time = "time",
  icon = NULL,
  pathOpts = pathOptions(),
  popup = NULL,
  label = NULL,
  popupOptions = NULL,
  labelOptions = NULL,
  options = playbackOptions(),
  name = NULL
)

Arguments

Value

the new map object

Note

If used in Shiny, you can listen to 2 events

• 'map-ID'+"_pb_mouseover"

• 'map-ID'+"_pb_click"

References

https://github.com/hallahan/LeafletPlayback

See Also

Other Playback Functions: playbackOptions(), removePlayback()

Examples

library(leaflet)
library(leaflet.extras2)
library(sf)

## Single Elements
data <- sf::st_as_sf(leaflet::atlStorms2005[1, ])
data <- st_cast(data, "POINT")
data$time <- as.POSIXct(
  seq.POSIXt(Sys.time() - 1000, Sys.time(), length.out = nrow(data))
)
data$label <- as.character(data$time)

leaflet() %>%
  addTiles() %>%
  addPlayback(
    data = data, label = ~label,
    popup = ~ sprintf(
      "I am a popup for <b>%s</b> and <b>%s</b>",
      Name, label
    ),
    popupOptions = popupOptions(offset = c(0, -35)),
    options = playbackOptions(
      radius = 3,
      tickLen = 36000,
      speed = 50,
      maxInterpolationTime = 1000
    ),
    pathOpts = pathOptions(weight = 5)
  )


## Multiple Elements
data <- sf::st_as_sf(leaflet::atlStorms2005[1:5, ])
data$Name <- as.character(data$Name)
data <- st_cast(data, "POINT")
data$time <- unlist(lapply(rle(data$Name)$lengths, function(x) {
  seq.POSIXt(as.POSIXct(Sys.Date() - 2), as.POSIXct(Sys.Date()), length.out = x)
}))
data$time <- as.POSIXct(data$time, origin = "1970-01-01")
data$label <- paste0("Time: ", data$time)
data$popup <- sprintf(
  "<h3>Customized Popup</h3><b>Name</b>: %s<br><b>Time</b>: %s",
  data$Name, data$time
)
data <- split(data, f = data$Name)

leaflet() %>%
  addTiles() %>%
  addPlayback(
    data = data,
    popup = ~popup,
    label = ~label,
    popupOptions = popupOptions(offset = c(0, -35)),
    labelOptions = labelOptions(noHide = TRUE),
    options = playbackOptions(
      radius = 3,
      tickLen = 1000000,
      speed = 5000,
      maxInterpolationTime = 10000,
      transitionpopup = FALSE,
      transitionlabel = FALSE,
      playCommand = "Let's go",
      stopCommand = "Stop it!",
      color = c(
        "red", "green", "blue",
        "orange", "yellow"
      )
    ),
    pathOpts = pathOptions(weight = 5)
  )

Add Isochrones to Leaflet

Description

A leaflet plugin which shows areas of reachability based on time or distance for different modes of travel using the openrouteservice isochrones API. Based on the leaflet.reachability plugin

Usage

addReachability(map, apikey = NULL, options = reachabilityOptions())

Arguments

Value

the new map object

Note

When used in Shiny, 3 events update a certain shiny Input:

1. reachability:displayed updates input$MAPID_reachability_displayed

2. reachability:delete updates input$MAPID_reachability_delete

3. reachability:error updates input$MAPID_reachability_error

References

https://github.com/traffordDataLab/leaflet.reachability

See Also

Other Reachability Functions: reachabilityOptions(), removeReachability()

Examples

## Not run: 
library(leaflet)
library(leaflet.extras2)

Sys.setenv("OPRS" = "Your_API_Key")

leaflet() %>%
  addTiles() %>%
  setView(8, 50, 10) %>%
  addReachability()

## End(Not run)

Add a Sidebar Leaflet Control

Description

The sidebar HTML must be created with sidebar_tabs and sidebar_pane before leafletOutput is called.

Usage

addSidebar(map, id = "sidebar", options = list(position = "left"), ns = NULL)

Arguments

Value

the new map object

References

https://github.com/Turbo87/sidebar-v2

See Also

Other Sidebar Functions: closeSidebar(), openSidebar(), removeSidebar(), sidebar_pane(), sidebar_tabs()

Examples

## Not run: 
library(shiny)

# run example app showing a single sidebar
runApp(paste0(
  system.file("examples", package = "leaflet.extras2"),
  "/sidebar_app.R"
))

# run example app showing two sidebars
runApp(paste0(
  system.file("examples", package = "leaflet.extras2"),
  "/multi_sidebar_app.R"
))

## End(Not run)

Add Side by Side View

Description

A Leaflet control to add a split screen to compare two map overlays. The plugin works with Panes, see the example.

Usage

addSidebyside(
  map,
  layerId = NULL,
  leftId = NULL,
  rightId = NULL,
  options = list(thumbSize = 42, padding = 0)
)

Arguments

Value

the new map object

Note

It is currently not working correctly if the baseGroups are defined in addLayersControl.

References

https://github.com/digidem/leaflet-side-by-side

See Also

Other Sidebyside Functions: removeSidebyside()

Examples

library(leaflet)
library(leaflet.extras2)

leaflet(quakes) %>%
  addMapPane("left", zIndex = 0) %>%
  addMapPane("right", zIndex = 0) %>%
  addTiles(
    group = "base", layerId = "baseid",
    options = pathOptions(pane = "right")
  ) %>%
  addProviderTiles(providers$CartoDB.DarkMatter,
    group = "carto", layerId = "cartoid",
    options = pathOptions(pane = "left")
  ) %>%
  addCircleMarkers(
    data = breweries91[1:15, ], color = "blue", group = "blue",
    options = pathOptions(pane = "left")
  ) %>%
  addCircleMarkers(data = breweries91[15:20, ], color = "yellow", group = "yellow") %>%
  addCircleMarkers(
    data = breweries91[15:30, ], color = "red", group = "red",
    options = pathOptions(pane = "right")
  ) %>%
  addLayersControl(overlayGroups = c("blue", "red", "yellow")) %>%
  addSidebyside(
    layerId = "sidecontrols",
    rightId = "baseid",
    leftId = "cartoid"
  )

Add Spin Plugin

Description

Adds an animated loading spinning over the map.

Usage

addSpinner(map)

startSpinner(map, options = NULL)

stopSpinner(map)

Arguments

Value

A leaflet map object

References

https://github.com/makinacorpus/Leaflet.Spin

https://github.com/fgnass/spin.js

Examples

library(leaflet)
library(leaflet.extras2)

leaflet(data = quakes) %>%
  addTiles() %>%
  addSpinner() %>%
  startSpinner(options = list("lines" = 7, "length" = 20)) %>%
  addMarkers(~long, ~lat, popup = ~ as.character(mag), label = ~ as.character(mag)) %>%
  stopSpinner()

Adds a Tangram layer to a Leaflet map in a Shiny App.

Description

Adds a Tangram layer to a Leaflet map in a Shiny App.

Usage

addTangram(map, scene = NULL, layerId = NULL, group = NULL, options = NULL)

Arguments

Value

the new map object

Note

Only works correctly in a Shiny-App environment.

References

https://github.com/tangrams/tangram

Examples

## Not run: 
library(shiny)
library(leaflet)
library(leaflet.extras2)

## In the /www folder of a ShinyApp. Must contain the Nextzen API-key
scene <- "scene.yaml"

ui <- fluidPage(leafletOutput("map"))

server <- function(input, output, session) {
  output$map <- renderLeaflet({
    leaflet() %>%
      addTiles(group = "base") %>%
      addTangram(scene = scene, group = "tangram") %>%
      addCircleMarkers(data = breweries91, group = "brews") %>%
      setView(11, 49.4, 14) %>%
      addLayersControl(
        baseGroups = c("tangram", "base"),
        overlayGroups = c("brews")
      )
  })
}

shinyApp(ui, server)

## End(Not run)

Add Time Slider to Leaflet

Description

The LeafletSlider plugin enables you to dynamically add and remove Markers/Lines on a map by using a JQuery UI slider.

Usage

addTimeslider(
  map,
  data,
  radius = 10,
  stroke = TRUE,
  color = "#03F",
  weight = 5,
  opacity = 0.5,
  fill = TRUE,
  fillColor = color,
  fillOpacity = 0.2,
  dashArray = NULL,
  popup = NULL,
  popupOptions = NULL,
  label = NULL,
  labelOptions = NULL,
  ordertime = TRUE,
  options = timesliderOptions()
)

Arguments

Value

the new map object

References

https://github.com/dwilhelm89/LeafletSlider

See Also

Other Timeslider Functions: removeTimeslider(), timesliderOptions()

Examples

library(leaflet)
library(leaflet.extras2)
library(sf)

data <- sf::st_as_sf(leaflet::atlStorms2005[1, ])
data <- st_cast(data, "POINT")
data$time <- as.POSIXct(
  seq.POSIXt(Sys.time() - 1000, Sys.time(), length.out = nrow(data))
)

leaflet() %>%
  addTiles() %>%
  addTimeslider(
    data = data,
    options = timesliderOptions(
      position = "topright",
      timeAttribute = "time",
      range = TRUE
    )
  ) %>%
  setView(-72, 22, 4)

Add Velocity Animation

Description

Add velocity animated data to leaflet. Based on the leaflet-velocity plugin

Usage

addVelocity(
  map,
  layerId = NULL,
  group = NULL,
  content = NULL,
  options = velocityOptions()
)

Arguments

Value

the new map object

References

https://github.com/onaci/leaflet-velocity

See Also

Other Velocity Functions: removeVelocity(), setOptionsVelocity(), velocityOptions()

Examples

## Not run: 
library(leaflet)
library(leaflet.extras2)
content <- "https://raw.githubusercontent.com/onaci/leaflet-velocity/master/demo/water-gbr.json"
leaflet() %>%
  addTiles(group = "base") %>%
  setView(145, -20, 4) %>%
  addVelocity(content = content, group = "velo", layerId = "veloid") %>%
  addLayersControl(baseGroups = "base", overlayGroups = "velo")

## End(Not run)

Add Queryable WMS Layer

Description

A Leaflet plugin for working with Web Map services, providing: single-tile/untiled/nontiled layers, shared WMS sources, and GetFeatureInfo-powered identify.

You can also use CQL-Filters by appending a string to the 'baseUrl'.

Something like 'http://server/wms?cql_filter=attribute=value'

Usage

addWMS(
  map,
  baseUrl,
  layerId = NULL,
  group = NULL,
  options = WMSTileOptions(),
  attribution = NULL,
  layers = NULL,
  popupOptions = NULL,
  checkempty = FALSE,
  data = getMapData(map)
)

Arguments

Value

the new map object

References

https://github.com/heigeo/leaflet.wms

Examples

library(leaflet)
library(leaflet.extras2)

leaflet() %>%
  addTiles(group = "base") %>%
  setView(9, 50, 5) %>%
  addWMS(
    baseUrl = "https://maps.dwd.de/geoserver/dwd/wms",
    layers = "dwd:BRD_1km_winddaten_10m",
    popupOptions = popupOptions(maxWidth = 600),
    checkempty = TRUE,
    options = WMSTileOptions(
      transparent = TRUE,
      format = "image/png",
      info_format = "text/html"
    )
  )

Antpath Options

Description

Additional list of options for 'ant-path' animated polylines.

Usage

antpathOptions(
  delay = 400,
  paused = FALSE,
  reverse = FALSE,
  hardwareAccelerated = FALSE,
  dashArray = c(10, 20),
  pulseColor = "#ffffff",
  lineCap = NULL,
  lineJoin = NULL,
  interactive = TRUE,
  pointerEvents = NULL,
  className = "",
  ...
)

Arguments

Value

A list of options for addAntpath animated polylines

See Also

Other Antpath Functions: addAntpath(), clearAntpath(), removeAntpath()

Arrowhead Options

Description

Additional list of options for polylines with arrowheads. You can also pass options inherited from L.Path

Usage

arrowheadOptions(
  yawn = 60,
  size = "15%",
  frequency = "allvertices",
  proportionalToTotal = FALSE,
  offsets = NULL,
  perArrowheadOptions = NULL,
  ...
)

Arguments

Value

A list of options for addArrowhead polylines

References

https://github.com/slutske22/leaflet-arrowheads#options

See Also

Other Arrowhead Functions: addArrowhead(), clearArrowhead(), removeArrowhead()

clearAntpath

Description

Clear all Antpaths

Usage

clearAntpath(map)

Arguments

Value

the new map object

See Also

Other Antpath Functions: addAntpath(), antpathOptions(), removeAntpath()

Remove arrowheads from Lines by group

Description

Remove arrowheads from Lines by group

Usage

clearArrowhead(map, group)

Arguments

Value

A modified leaflet map

See Also

Other Arrowhead Functions: addArrowhead(), arrowheadOptions(), removeArrowhead()

clearConditionalLayers

Description

clearConditionalLayers

Usage

clearConditionalLayers(map)

Arguments

See Also

Other LayerGroupConditional Plugin: addLayerGroupConditional(), removeConditionalLayer()

clearFuture

Description

Resets the stack of future items.

Usage

clearFuture(map)

Arguments

Value

the new map object

References

https://github.com/cscott530/leaflet-history

See Also

Other History Functions: addHistory(), clearHistory(), goBackHistory(), goForwardHistory(), historyOptions()

clearHexbin

Description

Clears the data of the hexbinLayer.

Usage

clearHexbin(map)

Arguments

Value

the new map object

See Also

Other Hexbin-D3 Functions: addHexbin(), hexbinOptions(), hideHexbin(), showHexbin(), updateHexbin()

clearHistory

Description

Resets the stack of history items.

Usage

clearHistory(map)

Arguments

Value

the new map object

References

https://github.com/cscott530/leaflet-history

See Also

Other History Functions: addHistory(), clearFuture(), goBackHistory(), goForwardHistory(), historyOptions()

Close the Sidebar

Description

Close the Sidebar

Usage

closeSidebar(map, sidebar_id = NULL)

Arguments

Value

the new map object

See Also

Other Sidebar Functions: addSidebar(), openSidebar(), removeSidebar(), sidebar_pane(), sidebar_tabs()

clusterchartOptions

Description

Adds options for clusterCharts

Usage

clusterchartOptions(
  rmax = 30,
  size = c(20, 20),
  width = 40,
  height = 50,
  strokeWidth = 1,
  innerRadius = 10,
  labelBackground = FALSE,
  labelFill = "white",
  labelStroke = "black",
  labelColor = "black",
  labelOpacity = 0.9,
  digits = 2,
  sortTitlebyCount = TRUE
)

Arguments

See Also

Other clusterCharts: addClusterCharts()

context_mapmenuItems

Description

context_mapmenuItems

Usage

context_mapmenuItems(...)

Arguments

Value

A list of context_menuItem for the map

See Also

Other Contextmenu Functions: addContextmenu(), addItemContextmenu(), context_markermenuItems(), context_menuItem(), disableContextmenu(), enableContextmenu(), hideContextmenu(), insertItemContextmenu(), mapmenuItems(), markermenuItems(), menuItem(), removeItemContextmenu(), removeallItemsContextmenu(), setDisabledContextmenu(), showContextmenu()

context_markermenuItems

Description

context_markermenuItems

Usage

context_markermenuItems(...)

Arguments

Value

A list of context_menuItem for markers

See Also

Other Contextmenu Functions: addContextmenu(), addItemContextmenu(), context_mapmenuItems(), context_menuItem(), disableContextmenu(), enableContextmenu(), hideContextmenu(), insertItemContextmenu(), mapmenuItems(), markermenuItems(), menuItem(), removeItemContextmenu(), removeallItemsContextmenu(), setDisabledContextmenu(), showContextmenu()

context_menuItem

Description

context_menuItem

Usage

context_menuItem(text, callback = NULL, ...)

Arguments

Value

A contextmenu item list

See Also

Other Contextmenu Functions: addContextmenu(), addItemContextmenu(), context_mapmenuItems(), context_markermenuItems(), disableContextmenu(), enableContextmenu(), hideContextmenu(), insertItemContextmenu(), mapmenuItems(), markermenuItems(), menuItem(), removeItemContextmenu(), removeallItemsContextmenu(), setDisabledContextmenu(), showContextmenu()

disableContextmenu

Description

Disable the contextmenu

Usage

disableContextmenu(map)

Arguments

Value

A leaflet map object

See Also

Other Contextmenu Functions: addContextmenu(), addItemContextmenu(), context_mapmenuItems(), context_markermenuItems(), context_menuItem(), enableContextmenu(), hideContextmenu(), insertItemContextmenu(), mapmenuItems(), markermenuItems(), menuItem(), removeItemContextmenu(), removeallItemsContextmenu(), setDisabledContextmenu(), showContextmenu()

easyprintMap

Description

Print or export a map programmatically (e.g. in a Shiny environment).

Usage

easyprintMap(map, sizeModes = "A4Portrait", filename = "map")

Arguments

Value

A leaflet map object

See Also

Other EasyPrint Functions: addEasyprint(), easyprintOptions(), removeEasyprint()

Examples

## Only run examples in interactive R sessions
if (interactive()) {
  library(shiny)
  library(leaflet)
  library(leaflet.extras2)

  ui <- fluidPage(
    leafletOutput("map"),
    selectInput("scene", "Select Scene", choices = c("CurrentSize", "A4Landscape", "A4Portrait")),
    actionButton("print", "Print Map")
  )

  server <- function(input, output, session) {
    output$map <- renderLeaflet({
      input$print
      leaflet() %>%
        addTiles() %>%
        setView(10, 50, 9) %>%
        addEasyprint(options = easyprintOptions(
          exportOnly = TRUE
        ))
    })
    observeEvent(input$print, {
      leafletProxy("map") %>%
        easyprintMap(sizeModes = input$scene)
    })
  }

  shinyApp(ui, server)
}

easyprintOptions

Description

Create a list of further options for the easyprint plugin.

Usage

easyprintOptions(
  title = "Print map",
  position = "topleft",
  sizeModes = list("A4Portrait", "A4Landscape", "CurrentSize"),
  defaultSizeTitles = NULL,
  exportOnly = FALSE,
  tileLayer = NULL,
  tileWait = 500,
  filename = "map",
  hidden = FALSE,
  hideControlContainer = TRUE,
  hideClasses = NULL,
  customWindowTitle = NULL,
  spinnerBgColor = "#0DC5C1",
  customSpinnerClass = "epLoader"
)

Arguments

Value

A list of options for the 'easyprint' control

References

https://github.com/rowanwins/leaflet-easyPrint

See Also

Other EasyPrint Functions: addEasyprint(), easyprintMap(), removeEasyprint()

enableContextmenu

Description

Enable the contextmenu

Usage

enableContextmenu(map)

Arguments

Value

A leaflet map object

See Also

Other Contextmenu Functions: addContextmenu(), addItemContextmenu(), context_mapmenuItems(), context_markermenuItems(), context_menuItem(), disableContextmenu(), hideContextmenu(), insertItemContextmenu(), mapmenuItems(), markermenuItems(), menuItem(), removeItemContextmenu(), removeallItemsContextmenu(), setDisabledContextmenu(), showContextmenu()

The available GIBS layers with attributes

Description

The available GIBS layers with attributes

Usage

gibs_layers

Format

An object of class data.frame with 276 rows and 4 columns.

goBackHistory

Description

If possible, will go to previous map extent. Pushes current extent to the "future" stack.

Usage

goBackHistory(map)

Arguments

Value

the new map object

References

https://github.com/cscott530/leaflet-history

See Also

Other History Functions: addHistory(), clearFuture(), clearHistory(), goForwardHistory(), historyOptions()

goForwardHistory

Description

If possible, will go to next map extent. Pushes current extent to the "back" stack.

Usage

goForwardHistory(map)

Arguments

Value

the new map object

References

https://github.com/cscott530/leaflet-history

See Also

Other History Functions: addHistory(), clearFuture(), clearHistory(), goBackHistory(), historyOptions()

heightgraphOptions

Description

Customize the heightgraph with the following additional options.

Usage

heightgraphOptions(
  position = c("bottomright", "topleft", "topright", "bottomleft"),
  width = 800,
  height = 200,
  margins = list(top = 10, right = 30, bottom = 55, left = 50),
  expand = TRUE,
  expandCallback = NULL,
  mappings = NULL,
  highlightStyle = list(color = "red"),
  translation = NULL,
  xTicks = 3,
  yTicks = 3
)

Arguments

Value

A list of further options for addHeightgraph

See Also

Other Heightgraph Functions: addHeightgraph()

hexbinOptions

Description

A list of options for customizing the appearance/behavior of the hexbin layer.

Usage

hexbinOptions(
  duration = 200,
  colorScaleExtent = NULL,
  radiusScaleExtent = NULL,
  colorRange = c("#f7fbff", "#08306b"),
  radiusRange = c(5, 15),
  pointerEvents = "all",
  resizetoCount = FALSE,
  tooltip = "Count "
)

Arguments

Value

A list of hexbin-specific options

See Also

Other Hexbin-D3 Functions: addHexbin(), clearHexbin(), hideHexbin(), showHexbin(), updateHexbin()

hideContextmenu

Description

Hide the contextmenu

Usage

hideContextmenu(map)

Arguments

Value

A leaflet map object

See Also

Other Contextmenu Functions: addContextmenu(), addItemContextmenu(), context_mapmenuItems(), context_markermenuItems(), context_menuItem(), disableContextmenu(), enableContextmenu(), insertItemContextmenu(), mapmenuItems(), markermenuItems(), menuItem(), removeItemContextmenu(), removeallItemsContextmenu(), setDisabledContextmenu(), showContextmenu()

hideHexbin

Description

Hide the hexbinLayer.

Usage

hideHexbin(map)

Arguments

Value

the new map object

See Also

Other Hexbin-D3 Functions: addHexbin(), clearHexbin(), hexbinOptions(), showHexbin(), updateHexbin()

History Options

Description

History Options

Usage

historyOptions(
  position = c("topright", "topleft", "bottomleft", "bottomright"),
  maxMovesToSave = 10,
  backImage = "fa fa-caret-left",
  forwardImage = "fa fa-caret-right",
  backText = "",
  forwardText = "",
  backTooltip = "Go to Previous Extent",
  forwardTooltip = "Go to Next Extent",
  backImageBeforeText = TRUE,
  forwardImageBeforeText = FALSE,
  orientation = c("horizontal", "vertical"),
  shouldSaveMoveInHistory = NULL
)

Arguments

Value

A list of further options for addHistory

References

https://github.com/cscott530/leaflet-history

See Also

Other History Functions: addHistory(), clearFuture(), clearHistory(), goBackHistory(), goForwardHistory()

Examples

library(leaflet)
leaflet() %>%
  addTiles() %>%
  addHistory(options = historyOptions(
    position = "bottomright",
    maxMovesToSave = 20,
    backText = "Go back",
    forwardText = "Go forward",
    orientation = "vertical"
  ))

insertItemContextmenu

Description

Insert a new contextmenu menu item at a specific index

Usage

insertItemContextmenu(map, option, index)

Arguments

Value

A leaflet map object

See Also

Other Contextmenu Functions: addContextmenu(), addItemContextmenu(), context_mapmenuItems(), context_markermenuItems(), context_menuItem(), disableContextmenu(), enableContextmenu(), hideContextmenu(), mapmenuItems(), markermenuItems(), menuItem(), removeItemContextmenu(), removeallItemsContextmenu(), setDisabledContextmenu(), showContextmenu()

Is a map synchronized?

Description

Is a map snychronized with any or a specific map? Invoking this method sets a Shiny input that returns TRUE when the map is synchronized with another map. If syncwith is set, TRUE is returned if the map is synchronized exactly with that other map.

Usage

isSynced(map, id = NULL, syncwith = NULL)

Arguments

Details

The Siny input name is combined of the map-id and "_synced". For a map with id map1 the input can be retrieved with input$map1_synced.

Value

A map

See Also

Other leafletsync Functions: addLeafletsync(), addLeafletsyncDependency(), leafletsyncOptions(), unsync()

leafletsync Options

Description

Additional list of options.

Usage

leafletsyncOptions(
  noInitialSync = FALSE,
  syncCursor = TRUE,
  offsetFn = JS("function (center, zoom, refMap, tgtMap) { return center; }")
)

Arguments

Value

A list of options for addLeafletsync

See Also

Other leafletsync Functions: addLeafletsync(), addLeafletsyncDependency(), isSynced(), unsync()

Make Mapkey Icon

Description

Make Mapkey Icon

Usage

makeMapkeyIcon(
  icon = "mapkey",
  color = "#ff0000",
  iconSize = 12,
  background = "#1F7499",
  borderRadius = "100%",
  hoverScale = 1.4,
  hoverEffect = TRUE,
  additionalCSS = NULL,
  hoverCSS = NULL,
  htmlCode = NULL,
  boxShadow = TRUE
)

Arguments

Value

A list of mapkey-icon data that can be passed to the argument icon

References

https://github.com/mapshakers/leaflet-mapkey-icon

See Also

Other Mapkey Functions: [.leaflet_mapkey_icon_set(), addMapkeyMarkers(), mapkeyIconList(), mapkeyIcons()

Examples

makeMapkeyIcon(
  icon = "traffic_signal",
  color = "#0000ff",
  iconSize = 12,
  boxShadow = FALSE,
  background = "transparent"
)

Make Mapkey-icon set

Description

Make Mapkey-icon set

Usage

mapkeyIconList(...)

Arguments

Value

A list of class "leaflet_mapkey_icon_set"

References

https://github.com/mapshakers/leaflet-mapkey-icon

See Also

Other Mapkey Functions: [.leaflet_mapkey_icon_set(), addMapkeyMarkers(), makeMapkeyIcon(), mapkeyIcons()

Examples

iconSet <- mapkeyIconList(
  red = makeMapkeyIcon(color = "#ff0000"),
  blue = makeMapkeyIcon(color = "#0000ff")
)
iconSet[c("red", "blue")]

Create a list of Mapkey icon data

Description

An icon can be represented as a list of the form list(color, iconSize, ...). This function is vectorized over its arguments to create a list of icon data. Shorter argument values will be re-cycled. NULL values for these arguments will be ignored.

Usage

mapkeyIcons(
  icon = "mapkey",
  color = "#ff0000",
  iconSize = 12,
  background = "#1F7499",
  borderRadius = "100%",
  hoverScale = 1.4,
  hoverEffect = TRUE,
  hoverCSS = NULL,
  additionalCSS = NULL,
  htmlCode = NULL,
  boxShadow = TRUE
)

Arguments

Value

A list of mapkey-icon data that can be passed to the argument icon

References

https://github.com/mapshakers/leaflet-mapkey-icon

See Also

Other Mapkey Functions: [.leaflet_mapkey_icon_set(), addMapkeyMarkers(), makeMapkeyIcon(), mapkeyIconList()

Examples

## Not run: 
library(leaflet)
leaflet() %>%
  addMapkeyMarkers(
    data = breweries91,
    icon = mapkeyIcons(
      color = "red",
      borderRadius = 0,
      iconSize = 25
    )
  )

## End(Not run)

mapmenuItems

Description

mapmenuItems

Usage

mapmenuItems(...)

Arguments

Value

A list of menuItem for the map

See Also

Other Contextmenu Functions: addContextmenu(), addItemContextmenu(), context_mapmenuItems(), context_markermenuItems(), context_menuItem(), disableContextmenu(), enableContextmenu(), hideContextmenu(), insertItemContextmenu(), markermenuItems(), menuItem(), removeItemContextmenu(), removeallItemsContextmenu(), setDisabledContextmenu(), showContextmenu()

markermenuItems

Description

markermenuItems

Usage

markermenuItems(...)

Arguments

Value

A list of menuItem for markers

See Also

Other Contextmenu Functions: addContextmenu(), addItemContextmenu(), context_mapmenuItems(), context_markermenuItems(), context_menuItem(), disableContextmenu(), enableContextmenu(), hideContextmenu(), insertItemContextmenu(), mapmenuItems(), menuItem(), removeItemContextmenu(), removeallItemsContextmenu(), setDisabledContextmenu(), showContextmenu()

menuItem

Description

menuItem

Usage

menuItem(text, callback = NULL, ...)

Arguments

Value

A contextmenu item list

See Also

Other Contextmenu Functions: addContextmenu(), addItemContextmenu(), context_mapmenuItems(), context_markermenuItems(), context_menuItem(), disableContextmenu(), enableContextmenu(), hideContextmenu(), insertItemContextmenu(), mapmenuItems(), markermenuItems(), removeItemContextmenu(), removeallItemsContextmenu(), setDisabledContextmenu(), showContextmenu()

Set options for Moving Markers

Description

Set options for Moving Markers

Usage

movingMarkerOptions(autostart = FALSE, loop = FALSE, pauseOnZoom = FALSE)

Arguments

Value

A list of extra options for moving markers

References

https://github.com/ewoken/Leaflet.MovingMarker

See Also

Other MovingMarker Functions: addMovingMarker(), startMoving()

Open the Sidebar by ID

Description

Open the Sidebar by ID

Usage

openSidebar(map, id, sidebar_id = NULL, ns = NULL)

Arguments

Value

the new map object

See Also

Other Sidebar Functions: addSidebar(), closeSidebar(), removeSidebar(), sidebar_pane(), sidebar_tabs()

openweatherCurrentOptions

Description

openweatherCurrentOptions

Usage

openweatherCurrentOptions(lang = "en", minZoom = 7, interval = 10, ...)

Arguments

Value

A list of options for addOpenweatherCurrent

See Also

Other Openweathermap Functions: addOpenweatherCurrent(), addOpenweatherTiles(), openweatherOptions()

OpenWeatherMap Options

Description

OpenWeatherMap Options

Usage

openweatherOptions(
  showLegend = TRUE,
  legendImagePath = NULL,
  legendPosition = c("bottomleft", "bottomright", "topleft", "topright")
)

Arguments

Value

A list of options for addOpenweatherTiles

See Also

Other Openweathermap Functions: addOpenweatherCurrent(), addOpenweatherTiles(), openweatherCurrentOptions()

playbackOptions

Description

A list of options for addPlayback. For a full list please visit the plugin repository.

Usage

playbackOptions(
  color = "blue",
  radius = 5,
  tickLen = 250,
  speed = 50,
  maxInterpolationTime = 5 * 60 * 1000,
  tracksLayer = TRUE,
  playControl = TRUE,
  dateControl = TRUE,
  sliderControl = TRUE,
  orientIcons = FALSE,
  staleTime = 60 * 60 * 1000,
  transitionpopup = TRUE,
  transitionlabel = TRUE,
  ...
)

Arguments

Value

A list of options for addPlayback

References

https://github.com/hallahan/LeafletPlayback

See Also

Other Playback Functions: addPlayback(), removePlayback()

reachabilityOptions

Description

Add extra options. For a full list please visit the plugin repository.

Usage

reachabilityOptions(
  collapsed = TRUE,
  pane = "overlayPane",
  position = "topleft",
  ...
)

Arguments

Value

A list of options for addReachability

References

https://github.com/traffordDataLab/leaflet.reachability

See Also

Other Reachability Functions: addReachability(), removeReachability()

removeAntpath

Description

Remove one or more Antpaths from a map, identified by layerId.

Usage

removeAntpath(map, layerId = NULL)

Arguments

Value

the new map object

See Also

Other Antpath Functions: addAntpath(), antpathOptions(), clearAntpath()

Remove arrowheads from Lines by layerId

Description

Remove arrowheads from Lines by layerId

Usage

removeArrowhead(map, layerId)

Arguments

Value

A modified leaflet map

See Also

Other Arrowhead Functions: addArrowhead(), arrowheadOptions(), clearArrowhead()

removeConditionalLayer

Description

removeConditionalLayer

Usage

removeConditionalLayer(map, groups)

Arguments

See Also

Other LayerGroupConditional Plugin: addLayerGroupConditional(), clearConditionalLayers()

removeEasyprint

Description

Removes the easyprint control from the map.

Usage

removeEasyprint(map)

Arguments

Value

A leaflet map object

See Also

Other EasyPrint Functions: addEasyprint(), easyprintMap(), easyprintOptions()

removeItemContextmenu

Description

Remove a contextmenu item by index.

Usage

removeItemContextmenu(map, index)

Arguments

Value

A leaflet map object

See Also

Other Contextmenu Functions: addContextmenu(), addItemContextmenu(), context_mapmenuItems(), context_markermenuItems(), context_menuItem(), disableContextmenu(), enableContextmenu(), hideContextmenu(), insertItemContextmenu(), mapmenuItems(), markermenuItems(), menuItem(), removeallItemsContextmenu(), setDisabledContextmenu(), showContextmenu()

removePlayback

Description

Remove the Playback controls and markers.

Usage

removePlayback(map)

Arguments

Value

the new map object

See Also

Other Playback Functions: addPlayback(), playbackOptions()

removeReachability

Description

Remove the reachability controls.

Usage

removeReachability(map)

Arguments

Value

the new map object

See Also

Other Reachability Functions: addReachability(), reachabilityOptions()

Remove the Sidebar

Description

Remove the Sidebar

Usage

removeSidebar(map, sidebar_id = NULL)

Arguments

Value

the new map object

See Also

Other Sidebar Functions: addSidebar(), closeSidebar(), openSidebar(), sidebar_pane(), sidebar_tabs()

removeSidebyside

Description

removeSidebyside

Usage

removeSidebyside(map, layerId = NULL)

Arguments

Value

the new map object

See Also

Other Sidebyside Functions: addSidebyside()

removeTimeslider

Description

Remove the Timeslider controls and markers.

Usage

removeTimeslider(map)

Arguments

Value

the new map object

See Also

Other Timeslider Functions: addTimeslider(), timesliderOptions()

removeVelocity

Description

removeVelocity

Usage

removeVelocity(map, group)

Arguments

Value

the new map object

See Also

Other Velocity Functions: addVelocity(), setOptionsVelocity(), velocityOptions()

removeallItemsContextmenu

Description

Remove all contextmenu items from the map.

Usage

removeallItemsContextmenu(map)

Arguments

Value

A leaflet map object

See Also

Other Contextmenu Functions: addContextmenu(), addItemContextmenu(), context_mapmenuItems(), context_markermenuItems(), context_menuItem(), disableContextmenu(), enableContextmenu(), hideContextmenu(), insertItemContextmenu(), mapmenuItems(), markermenuItems(), menuItem(), removeItemContextmenu(), setDisabledContextmenu(), showContextmenu()

Update the OSM-Buildings Data

Description

Update the OSM-Buildings Data

Usage

setBuildingData(map, data)

Arguments

See Also

Other OSM-Buildings Plugin: addBuildings(), setBuildingStyle(), updateBuildingTime()

Update the OSM-Buildings Style

Description

Update the OSM-Buildings Style

Usage

setBuildingStyle(
  map,
  style = list(color = "#ffcc00", wallColor = "#ffcc00", roofColor = "orange", shadows =
    TRUE)
)

Arguments

See Also

Other OSM-Buildings Plugin: addBuildings(), setBuildingData(), updateBuildingTime()

Examples

library(leaflet)
library(leaflet.extras2)

style <- list(color = "#0000ff", wallColor = "gray", roofColor = "orange", shadows = TRUE)
leaflet() %>%
  addTiles() %>%
  addBuildings() %>%
  setBuildingStyle(style) %>%
  setView(13.40, 52.51836, 15)

Set Date for GIBS Layers

Description

Set a new date for multi-temporal layers.

Usage

setDate(map, layers = NULL, dates = NULL)

Arguments

Value

the new map object

See Also

Other GIBS Functions: addGIBS(), setTransparent()

setDisabledContextmenu

Description

Enable/Disable a contextmenu item by index.

Usage

setDisabledContextmenu(map, index, disabled = TRUE)

Arguments

Value

A leaflet map object

See Also

Other Contextmenu Functions: addContextmenu(), addItemContextmenu(), context_mapmenuItems(), context_markermenuItems(), context_menuItem(), disableContextmenu(), enableContextmenu(), hideContextmenu(), insertItemContextmenu(), mapmenuItems(), markermenuItems(), menuItem(), removeItemContextmenu(), removeallItemsContextmenu(), showContextmenu()

setOptionsVelocity

Description

setOptionsVelocity

Usage

setOptionsVelocity(map, layerId, options)

Arguments

Value

the new map object

See Also

Other Velocity Functions: addVelocity(), removeVelocity(), velocityOptions()

Set Transparency for GIBS Layers

Description

Change the transparency for no-data pixels.

Usage

setTransparent(map, layers = NULL, transparent = TRUE)

Arguments

Value

the new map object

See Also

Other GIBS Functions: addGIBS(), setDate()

showContextmenu

Description

Open the contextmenu at certain lat/lng-coordinates

Usage

showContextmenu(map, lat = NULL, lng = NULL, data = leaflet::getMapData(map))

Arguments

Value

A leaflet map object

See Also

Other Contextmenu Functions: addContextmenu(), addItemContextmenu(), context_mapmenuItems(), context_markermenuItems(), context_menuItem(), disableContextmenu(), enableContextmenu(), hideContextmenu(), insertItemContextmenu(), mapmenuItems(), markermenuItems(), menuItem(), removeItemContextmenu(), removeallItemsContextmenu(), setDisabledContextmenu()

showHexbin

Description

Show the hexbinLayer.

Usage

showHexbin(map)

Arguments

Value

the new map object

See Also

Other Hexbin-D3 Functions: addHexbin(), clearHexbin(), hexbinOptions(), hideHexbin(), updateHexbin()

Create a Sidebar Pane

Description

Create a Sidebar Pane

Usage

sidebar_pane(
  title = "Sidebar Title",
  id = NULL,
  icon = icon("caret-right"),
  ...
)

Arguments

Value

A shiny.tag with sidebar-specific HTML classes

References

https://github.com/Turbo87/sidebar-v2, https://github.com/Turbo87/sidebar-v2/blob/master/doc/usage.md

See Also

Other Sidebar Functions: addSidebar(), closeSidebar(), openSidebar(), removeSidebar(), sidebar_tabs()

Examples

## Not run: 
library(shiny)
sidebar_pane(id = "id", icon = icon("cars"), tags$div())

## End(Not run)

Create a Sidebar

Description

Create a Sidebar

Usage

sidebar_tabs(id = "sidebar", iconList = NULL, ...)

Arguments

Value

A shiny.tag with individual sidebar panes

References

https://github.com/Turbo87/sidebar-v2, https://github.com/Turbo87/sidebar-v2/blob/master/doc/usage.md

See Also

Other Sidebar Functions: addSidebar(), closeSidebar(), openSidebar(), removeSidebar(), sidebar_pane()

Examples

## Not run: 
library(shiny)

# run example app showing a single sidebar
runApp(paste0(
  system.file("examples", package = "leaflet.extras2"),
  "/sidebar_app.R"
))

# run example app showing two sidebars
runApp(paste0(
  system.file("examples", package = "leaflet.extras2"),
  "/multi_sidebar_app.R"
))

## End(Not run)

Interact with the moving markers

Description

The marker begins its path or resumes if it is paused.

Usage

startMoving(map, layerId = NULL)

stopMoving(map, layerId = NULL)

pauseMoving(map, layerId = NULL)

resumeMoving(map, layerId = NULL)

addLatLngMoving(map, layerId = NULL, latlng, duration)

moveToMoving(map, layerId = NULL, latlng, duration)

addStationMoving(map, layerId = NULL, pointIndex, duration)

Arguments

Value

the new map object

Functions

• stopMoving(): Manually stops the marker, if you call start after, the marker starts again the polyline at the beginning.

• pauseMoving(): Pauses the marker

• resumeMoving(): The marker resumes its animation

• addLatLngMoving(): Adds a point to the polyline. Useful, if we have to set the path one by one.

• moveToMoving(): Stop the current animation and make the marker move to latlng in duration ms.

• addStationMoving(): The marker will stop at the pointIndex point of the polyline for duration milliseconds. You can't add a station at the first or last point of the polyline.

References

https://github.com/ewoken/Leaflet.MovingMarker

See Also

Other MovingMarker Functions: addMovingMarker(), movingMarkerOptions()

timesliderOptions

Description

A list of options for addTimeslider.

Usage

timesliderOptions(
  position = c("topright", "bottomleft", "bottomright", "topleft"),
  timeAttribute = "time",
  isEpoch = FALSE,
  startTimeIdx = 0,
  timeStrLength = 19,
  maxValue = -1,
  minValue = 0,
  showAllOnStart = FALSE,
  range = FALSE,
  follow = FALSE,
  alwaysShowDate = FALSE,
  rezoom = NULL,
  sameDate = FALSE
)

Arguments

Value

A list of options for addTimeslider

References

https://github.com/dwilhelm89/LeafletSlider

See Also

Other Timeslider Functions: addTimeslider(), removeTimeslider()

to_jsonformat Transform object to JSON expected format

Description

to_jsonformat Transform object to JSON expected format

Usage

to_jsonformat(data, time, popup = NULL, label = NULL, name = NULL)

Arguments

Value

A list that is transformed to the expected JSON format

to_ms Change POSIX or Date to milliseconds

Description

to_ms Change POSIX or Date to milliseconds

Usage

to_ms(data, time)

Arguments

Value

A data.frame with the time column in milliseconds

Removes synchronization.

Description

Removes the synchronization of multiple maps from a specific map.

Usage

unsync(map, id = NULL, unsyncids = NULL)

Arguments

Value

A map

See Also

Other leafletsync Functions: addLeafletsync(), addLeafletsyncDependency(), isSynced(), leafletsyncOptions()

Update the Shadows OSM-Buildings with a POSIXct timestamp

Description

Update the Shadows OSM-Buildings with a POSIXct timestamp

Usage

updateBuildingTime(map, time)

Arguments

See Also

Other OSM-Buildings Plugin: addBuildings(), setBuildingData(), setBuildingStyle()

Examples

library(leaflet)
library(leaflet.extras2)

leaflet() %>%
  addTiles() %>%
  addBuildings() %>%
  updateBuildingTime(as.POSIXct("2024-09-01 19:00:00 CET")) %>%
  setView(13.40, 52.51836, 15)

updateHexbin

Description

Dynamically change the data and/or the colorRange.

Usage

updateHexbin(map, data = NULL, lng = NULL, lat = NULL, colorRange = NULL)

Arguments

Value

the new map object

See Also

Other Hexbin-D3 Functions: addHexbin(), clearHexbin(), hexbinOptions(), hideHexbin(), showHexbin()

velocityOptions

Description

Define further options for the velocity layer.

Usage

velocityOptions(
  speedUnit = c("m/s", "k/h", "kt"),
  minVelocity = 0,
  maxVelocity = 10,
  velocityScale = 0.005,
  colorScale = NULL,
  ...
)

Arguments

Value

A list of further options for addVelocity

See Also

Other Velocity Functions: addVelocity(), removeVelocity(), setOptionsVelocity()