All Changes as per comments in rstudio/leaflet/#294 & rstudio/leaflet/#295

Author: bhaskarvk

NAMESPACE

@@ -56,9 +56,7 @@ export(colorQuantile)
 export(createLeafletMap)
 export(dispatch)
 export(easyButton)
-export(easyButtonList)
 export(easyButtonState)
-export(easyButtonStateList)
 export(fitBounds)
 export(hideGroup)
 export(iconList)
@@ -70,6 +68,7 @@ export(layersControlOptions)
 export(leaflet)
 export(leafletCRS)
 export(leafletMap)
+export(leafletOptions)
 export(leafletOutput)
 export(leafletProxy)
 export(makeAwesomeIcon)

NEWS

@@ -1,6 +1,8 @@
 leaflet 1.1
 --------------------------------------------------------------------------------
 
+* Added 2 new plugins Proj4Leaflet (PR #294) and EasyButton (PR #295).
+
 * Upgraded existing plugins to their respective latest versions and added missing/new functionality from those plugins. (PR #293)
 
 * Added Graticule plugin (PR #293)

R/layers.R

@@ -333,7 +333,8 @@ addWMSTiles = function(
 #' @param transparent if \code{TRUE}, the WMS service will return images with
 #'   transparency
 #' @param version version of the WMS service to use
-#' @param crs Coordinate Reference System to use for the WMS requests, defaults
+#' @param crs Coordinate Reference System to use for the WMS requests, defaults.
+#' @seealso \code{\link{leafletCRS}}
 #'   to map CRS (don't change this if you're not sure what it means)
 #' @describeIn map-options Options for WMS tile layers
 #' @export

R/leaflet.R

@@ -25,7 +25,7 @@
 #' @example inst/examples/leaflet.R
 #' @export
 leaflet = function(data = NULL, width = NULL, height = NULL,
-                   padding = 0, options = list()) {
+                   padding = 0, options = leafletOptions()) {
 
   # Validate the CRS if specified
   if(!is.null(options[['crs']]) &&
@@ -99,9 +99,35 @@ mapOptions <- function(map, zoomToLimits = c("always", "first", "never")) {
   map
 }
 
+#' Options for Map creation
+#' @param  minZoom Minimum zoom level of the map. Overrides any minZoom set on map layers.
+#' @param  maxZoom Maximum zoom level of the map. This overrides any maxZoom set on map layers.
+#' @param  crs Coordinate Reference System to use. Don't change this if you're not sure what it means.
+#' @seealso \code{\link{leafletCRS}} for creating a custom CRS.
+#' @param  worldCopyJump With this option enabled, the map tracks when you pan to another "copy" of the world and seamlessly jumps to the original one so that all overlays like markers and vector layers are still visible.
+#' @param ... other options.
+#' @describeIn leaflet Options for map creation
+#' @seealso \url{http://leafletjs.com/reference.html#map-options} for details.
+#' @export
+leafletOptions <- function(
+  minZoom = NULL,
+  maxZoom = NULL,
+  crs = leafletCRS(),
+  worldCopyJump = NULL,
+  ...) {
+  filterNULL(
+    list(
+      minZoom = minZoom,
+      maxZoom = maxZoom,
+      crs = crs,
+      worldCopyJump = worldCopyJump,
+      ...)
+  )
+}
+
 # CRS classes supported
-crsClasses <- list( 'L.CRS.EPSG3857', 'L.CRS.EPSG4326', 'L.CRS.EPSG3395',
-                    'L.CRS.Simple', 'L.Proj.CRS', 'L.Proj.CRS.TMS' )
+crsClasses <- list('L.CRS.EPSG3857', 'L.CRS.EPSG4326', 'L.CRS.EPSG3395',
+                   'L.CRS.Simple', 'L.Proj.CRS', 'L.Proj.CRS.TMS')
 
 #' creates a custom CRS
 #' Refer to \url{https://kartena.github.io/Proj4Leaflet/api/} for details.
@@ -121,6 +147,7 @@ crsClasses <- list( 'L.CRS.EPSG3857', 'L.CRS.EPSG4326', 'L.CRS.EPSG3395',
 #'    defaulting to Leaflet's default CRS size
 #' @param tileSize Tile size, in pixels, to use in this CRS (Default 256)
 #'    Only needed when crsClass = 'L.Proj.CRS.TMS'
+#' @describeIn leaflet class to create a custom CRS
 #' @export
 leafletCRS <- function(
   crsClass = 'L.CRS.EPSG3857',

R/plugin-easybutton.R

@@ -11,10 +11,9 @@ leafletEasyButtonDependencies <- function() {
 }
 
 #' Create an easyButton statestate
-#' @param stateName the name of the state
-#' @param icon the button icon
-#' @param title text to show on hover
-#' @param onClick the action to take
+#' @param stateName a unique name for the state
+#' @seealso \code{\link{easyButton}}
+#' @describeIn easyButton state of an easyButton.
 #' @export
 easyButtonState <- function(
    stateName,
@@ -34,22 +33,8 @@ easyButtonState <- function(
       class='leaflet_easybutton_state')
 }
 
-#' Create a list of easyButton states.
-#' @param ... states created from \code{\link{easyButtonState}()}
-#' @export
-easyButtonStateList <- function(...) {
-  res = structure(
-    list(...),
-    class = "leaflet_easybutton_state_list"
-  )
-  cls = unlist(lapply(res, inherits, 'leaflet_easybutton_state'))
-  if (any(!cls))
-    stop('Arguments passed to easyButtonStateList() must be icon objects returned from easyButtonState()')
-  res
-}
-
 #' Creates an easy button.
-#' see \url{https://github.com/CliffCloud/Leaflet.EasyButton}
+#' @seealso \url{https://github.com/CliffCloud/Leaflet.EasyButton}
 #' @param icon the button icon
 #' @param title text to show on hover
 #' @param onClick the action to take
@@ -68,8 +53,10 @@ easyButton <- function(
   if(!inherits(onClick,'JS_EVAL')) {
     stop("onClick needs to be a returned value from a JS() call")
   }
-  if(!is.null(states) && !inherits(states,'leaflet_easybutton_state_list')) {
-    stop("states needs to be a returned value from a easyButtonStateList() call")
+  if(!is.null(states) && ! (
+    inherits(states,'list') &&
+    all(sapply(states,function(x) inherits(x,'leaflet_easybutton_state'))))) {
+    stop("states needs to be a list() of easyButton instances")
   }
   structure(list(
     icon = as.character(icon),
@@ -82,20 +69,6 @@ easyButton <- function(
       class='leaflet_easybutton')
 }
 
-#' Creates a list of easy buttons.
-#' @param ... icons created from \code{\link{easyButton}()}
-#' @export
-easyButtonList = function(...) {
-  res = structure(
-    list(...),
-    class = "leaflet_easybutton_list"
-  )
-  cls = unlist(lapply(res, inherits, 'leaflet_easybutton'))
-  if (any(!cls))
-    stop('Arguments passed to easyButtonList() must be icon objects returned from easyButton()')
-  res
-}
-
 #' Add a EasyButton on the map
 #' see \url{https://github.com/CliffCloud/Leaflet.EasyButton}
 #'
@@ -110,6 +83,7 @@ easyButtonList = function(...) {
 #'      icon = htmltools::span(class='star','&starf;'),
 #'      onClick = JS("function(btn, map){ map.setZoom(1);}")))
 #'
+#' @describeIn easyButton add an EasyButton to the map
 #' @export
 addEasyButton <- function(
   map,
@@ -150,33 +124,34 @@ addEasyButton <- function(
 #' Add a easyButton bar on the map
 #' see \url{https://github.com/CliffCloud/Leaflet.EasyButton}
 #'
-#' @param map a map widget object
-#' @param buttons the buttons object created with \code{\link{easyButtonList}}
-#' @param position topleft|topright|bottomleft|bottomright
-#' @param id id for the button bar
+#' @param ... a list of buttons created with \code{\link{easyButton}}
+#' @seealso \code{\link{addEasyButton}}
 #' @examples
 #' library(leaflet)
 #'
 #' leaf <- leaflet() %>%
 #'   addTiles() %>%
-#'   addEasyButtonBar(easyButtonList(
+#'   addEasyButtonBar(
 #'    easyButton(
 #'      icon = htmltools::span(class='star','&starf;'),
 #'      onClick = JS("function(btn, map){ alert('Button 1');}")),
 #'    easyButton(
 #'      icon = htmltools::span(class='star','&target;'),
-#'      onClick = JS("function(btn, map){ alert('Button 2');}"))))
+#'      onClick = JS("function(btn, map){ alert('Button 2');}")))
 #'
 #'
+#' @describeIn easyButton add an EasyButton to the map
 #' @export
 addEasyButtonBar <- function(
   map,
-  buttons,
+  ...,
   position = 'topleft',
   id = NULL
 ) {
-  if(!inherits(buttons,'leaflet_easybutton_list')) {
-    stop('button should be created with easyButtonList()')
+  buttons <- list(...)
+  if(!length(buttons) >= 1 ||
+    !all(sapply(buttons,function(x) inherits(x,'leaflet_easybutton')))) {
+    stop('need buttons created with easyButton()')
   }
 
   map$dependencies <- c(map$dependencies, leafletEasyButtonDependencies())
@@ -209,4 +184,3 @@ addEasyButtonBar <- function(
     id
   )
 }
-