Option to switch to remote version of Mapbox GL JS v2

DESCRIPTION

@@ -20,7 +20,7 @@ Imports:
   methods
 Encoding: UTF-8
 LazyData: true
-RoxygenNote: 6.1.1
+RoxygenNote: 7.2.3
 Suggests: 
     knitr,
     rmarkdown,

NAMESPACE

@@ -33,12 +33,16 @@ export(mapbox_source)
 export(mapboxer)
 export(mapboxerOutput)
 export(mapboxer_proxy)
+export(mapboxer_use_v2)
+export(mapboxer_use_version)
 export(renderMapboxer)
 export(set_data)
 export(set_filter)
+export(set_fog)
 export(set_layout_property)
 export(set_paint_property)
 export(set_style)
+export(set_terrain)
 export(set_view_state)
 export(stamen_raster_tiles)
 export(update_mapboxer)

R/deps.R

@@ -19,3 +19,103 @@ add_deps <- function(widget, deps) {
   widget$dependencies <- c(widget$dependencies, deps)
   widget
 }
+
+
+#' Switch between Mapbox GL JS v1 or v2 in a mapboxer project
+#'
+#' @param use_v2 If \code{TRUE}, mapboxer will use Mapbox GL JS version 2, which includes new features (such as Globe view and non-Mercator projections) but is less permissively licensed than Mapbox GL JS v1.  Please review the Mapbox terms of service at https://www.mapbox.com/legal/tos/ for more information.
+#'
+#' @return Returns the vale of \code{use_v2} invisibly.
+#' @export
+#' @examples \dontrun{
+#'
+#' library(mapboxer)
+#' mapboxer_use_v2(TRUE)
+#'
+#' # Globe view is only available in V2
+#' mapboxer(
+#'  center = c(-73.9165, 40.7114),
+#'  style = basemaps$Mapbox$streets_v11,
+#'  zoom = 2,
+#'  projection = "globe"
+#' )
+#'
+#' }
+mapboxer_use_v2 <- function(use_v2) {
+
+  current_opt <- getOption("mapbox_version", default = "mapbox-gl")
+
+  if (use_v2) {
+
+    if (current_opt != "mapbox-gl2") {
+      options(mapbox_version = "mapbox-gl2")
+      message("Using Mapbox GL JS v2.\nPlease review the Mapbox terms of service for version 2\nat https://www.mapbox.com/legal/tos/.")
+      invisible(use_v2)
+
+    }
+
+  } else {
+    if (current_opt != "mapbox-gl") {
+      options(mapbox_version = "mapbox-gl")
+      message("Using Mapbox GL JS v1.")
+      invisible(use_v2)
+    }
+  }
+
+}
+
+
+#' Switch between Mapbox GL JS versions in a mapboxer project
+#'
+#' @param version The version to use
+#'
+#' @return Returns the value of \code{version} invisibly.
+#' @export
+#' @examples \dontrun{
+#'
+#' library(mapboxer)
+#' mapboxer_use_version("mapbox-gl3")
+#'
+#' # Globe view is only available in V2
+#' mapboxer(
+#'  center = c(-73.9165, 40.7114),
+#'  style = basemaps$Mapbox$streets_v11,
+#'  zoom = 2,
+#'  projection = "globe"
+#' )
+#'
+#' }
+mapboxer_use_version <- function(version = c("mapbox-gl", "mapbox-gl2", "mapbox-gl3")) {
+
+  version <- match.arg(version)
+
+  current_opt <- getOption("mapbox_version", default = "mapbox-gl")
+
+  if (version == "mapbox-gl2") {
+
+    if (current_opt != "mapbox-gl2") {
+      options(mapbox_version = "mapbox-gl2")
+      message("Using Mapbox GL JS v2.\nPlease review the Mapbox terms of service for version 2\nat https://www.mapbox.com/legal/tos/.")
+      invisible(version)
+
+    }
+
+  } else if (version == "mapbox-gl3") {
+
+    if (current_opt != "mapbox-gl3") {
+      options(mapbox_version = "mapbox-gl3")
+      message("Using Mapbox GL JS v3.\nPlease review the Mapbox terms of service for version 3\nat https://www.mapbox.com/legal/tos/.")
+      invisible(version)
+
+    }
+
+
+  } else {
+    if (current_opt != "mapbox-gl") {
+      options(mapbox_version = "mapbox-gl")
+      message("Using Mapbox GL JS v1.")
+      invisible(version)
+    }
+  }
+
+}

R/fog_terrain.R

@@ -0,0 +1,19 @@
+#' Set the fog properties for a map
+#' @param map A \link{mapboxer} object.
+#' @param ... Optional arguments, see \url{https://docs.mapbox.com/mapbox-gl-js/api/map/#map#setfog}.
+#' @export
+set_fog <- function(map, ...) {
+    invoke_method(map, "setFog", options = list(...))
+}
+
+#' Set the terrain properties for a map
+#' @param map A \link{mapboxer} object.
+#' @param terrain_source A Mapbox source of type 'raster-dem'
+#' @param exaggeration The exaggeration factor
+#' @param ... Optional arguments, see \url{https://docs.mapbox.com/mapbox-gl-js/example/add-terrain/}.
+#' @export
+set_terrain <- function(map, terrain_source, exaggeration = 1.5, ...) {
+  invoke_method(map, "setTerrain", source = terrain_source,
+                exaggeration = exaggeration, options = list(...))
+}
+

R/mapboxer.R

@@ -27,14 +27,16 @@ mapboxer <- function(source = NULL, style = basemaps$Carto$dark_matter, ...,
     accessToken = token
   )
 
+  mb_version <- getOption("mapbox_version", "mapbox-gl")
+
   htmlwidgets::createWidget(
     name = "mapboxer",
     x = widget_data,
     width = width,
     height = height,
     package = "mapboxer",
     elementId = element_id,
-    dependencies = use_deps("mapbox-gl")
+    dependencies = use_deps(mb_version)
   )
 }
 
@@ -54,7 +56,15 @@ mapboxer <- function(source = NULL, style = basemaps$Carto$dark_matter, ...,
 #' @example examples/api-reference/shiny.R
 #' @export
 mapboxerOutput <- function(outputId, width = "100%", height = "400px") {
-  htmlwidgets::shinyWidgetOutput(outputId, "mapboxer", width, height, package = "mapboxer")
+
+  mb_version <- getOption("mapbox_version", "mapbox-gl")
+
+  htmltools::attachDependencies(
+    htmlwidgets::shinyWidgetOutput(outputId, "mapboxer", width, height, package = "mapboxer"),
+    use_deps(mb_version),
+    append = TRUE
+  )
+
 }
 
 #' @rdname mapboxer-shiny

examples/vector-layer-filled-polygons.R

@@ -19,7 +19,8 @@ layer_style <- list(
 mapboxer(
   style = basemaps$Carto$positron,
   center = c(0, 0),
+  projection = "globe",
   zoom = 1
 ) %>%
   add_source(vector_src, id = SRC_ID) %>%
-  add_layer(layer_style)
+  add_layer(layer_style, popup = "Hiya!")

inst/htmlwidgets/deps.yaml

@@ -6,11 +6,27 @@ mapbox-gl:
   stylesheet: "mapbox-gl.css"
   all_files: false
   package: "mapboxer"
+mapbox-gl2:
+  name: "mapbox-gl"
+  version: "2.11.0"
+  src:
+    href: "https://api.mapbox.com/mapbox-gl-js/v2.11.0"
+  script: "mapbox-gl.js"
+  stylesheet: "mapbox-gl.css"
+  all_files: false
+mapbox-gl3:
+  name: "mapbox-gl"
+  version: "3.0.0"
+  src:
+    href: "https://api.mapbox.com/mapbox-gl-js/v3.0.0-beta.1"
+  script: "mapbox-gl.js"
+  stylesheet: "mapbox-gl.css"
+  all_files: false
 mapbox-gl-draw:
   name: "mapbox-gl-draw"
   version: "1.2.0"
   src:
-    href: "https://api.mapbox.com/mapbox-gl-js/plugins/mapbox-gl-draw/v1.2.0/"
+    href: "https://api.mapbox.com/mapbox-gl-js/plugins/mapbox-gl-draw/v1.2.0"
   script: "mapbox-gl-draw.js"
   stylesheet: "mapbox-gl-draw.css"
   all_files: false