removeControl

0th

Percentile

Remove elements from a map

Remove one or more features from a map, identified by layerId; or, clear all features of the given type or group.

Usage
removeControl(map, layerId)

clearControls(map)

clearGroup(map, group)

removeImage(map, layerId)

clearImages(map)

removeTiles(map, layerId)

clearTiles(map)

removePopup(map, layerId)

clearPopups(map)

removeMarker(map, layerId)

clearMarkers(map)

removeMarkerCluster(map, layerId)

clearMarkerClusters(map)

removeMarkerFromCluster(map, layerId, clusterId)

removeShape(map, layerId)

clearShapes(map)

removeGeoJSON(map, layerId)

clearGeoJSON(map)

Arguments
map
a map widget object, possibly created from leaflet() but more likely from leafletProxy()
layerId
character vector; the layer id(s) of the item to remove
group
the name of the group whose members should be removed
clusterId
the id of the marker cluster layer
Value

  • the new map object

Note

When used with a leaflet() map object, these functions don't actually remove the features from the map object, but simply add an operation that will cause those features to be removed after they are added. In other words, if you add a polygon "foo" and the call removeShape("foo"), it's not smart enough to prevent the polygon from being added in the first place; instead, when the map is rendered, the polygon will be added and then removed.

For that reason, these functions aren't that useful with leaflet map objects and are really intended to be used with leafletProxy instead.

WMS tile layers are extensions of tile layers, so they can also be removed or cleared via removeTiles() or clearTiles().

Aliases
  • clearControls
  • clearGeoJSON
  • clearGroup
  • clearImages
  • clearMarkerClusters
  • clearMarkers
  • clearPopups
  • clearShapes
  • clearTiles
  • remove
  • removeControl
  • removeGeoJSON
  • removeImage
  • removeMarker
  • removeMarkerCluster
  • removeMarkerFromCluster
  • removePopup
  • removeShape
  • removeTiles
Documentation reproduced from package leaflet, version 1.0.0, License: GPL-3 | file LICENSE

Community examples

Looks like there are no examples yet.