Merge pull request #3 from eodaGmbH/nfr

Add marker update documentation

DESCRIPTION

@@ -16,4 +16,6 @@ Depends:
     R (>= 2.10)
 URL: https://eodagmbh.github.io/r-maplibregl/
 Imports: 
-    htmlwidgets
+    geojsonsf,
+    htmlwidgets,
+    purrr

NAMESPACE

@@ -1,9 +1,11 @@
 # Generated by roxygen2: do not edit by hand
 
+export(Layer)
+export(Marker)
 export(add_call)
 export(add_control)
 export(add_layer)
-export(layer)
+export(add_marker)
 export(maplibre)
 export(maplibreOutput)
 export(renderMaplibre)

R/layer.R

@@ -7,15 +7,17 @@
 #' @param layout
 #'
 #' @export
-layer <- function(type, id, source = NULL, paint = NULL, layout = NULL, ...) {
-  list(
+Layer <- function(type, id, source = NULL, paint = NULL, layout = NULL, ...) {
+  lay <- list(
     type = type,
     id = id,
     source = source,
     paint = paint,
     layout = layout
   ) |>
     purrr::compact()
+  class(lay) <- "MapLibreLayer"
+  return(lay)
 }
 
 

R/maplibre.R

@@ -1,8 +1,3 @@
-mapOptions <- function(style = basemaps$carto$dark_matter, ...) {
-  list(style = style, ...)
-}
-
-
 #' <Add Title>
 #'
 #' <Add Description>
@@ -12,8 +7,7 @@ mapOptions <- function(style = basemaps$carto$dark_matter, ...) {
 #' @export
 #' @example examples/basemap.R
 #'
-
-maplibre <- function(map_options = mapOptions(), width = NULL, height = NULL, elementId = NULL, ...) {
+maplibre <- function(map_options = mapOptions(), width = "100%", height = NULL, elementId = NULL, ...) {
   if (inherits(map_options$bounds, "bbox")) {
     map_options$bounds <- unname(map_options$bounds)
   }
@@ -36,6 +30,11 @@ maplibre <- function(map_options = mapOptions(), width = NULL, height = NULL, el
   )
 }
 
+mapOptions <- function(style = basemaps$carto$dark_matter, ...) {
+  list(style = style, ...)
+}
+
+
 #' Shiny bindings for maplibre
 #'
 #' Output and render functions for using maplibre within Shiny

R/marker.R

@@ -0,0 +1,38 @@
+#' Create a Marker
+#'
+#' @param lngLat
+#' @param popup
+#' @export
+#' @example examples/markers.R
+Marker <- function(lngLat, popup , ...) {
+  mark <- list(
+    lngLat  = lngLat,
+    popup = popup,
+    options = MarkerOptions(...)
+  ) |>
+    purrr::compact()
+  class(mark) <- "MapLibreMarker"
+  return(mark)
+}
+
+MarkerOptions <- function(...){
+  marker_options <- list(...)
+  stopifnot(sapply(marker_options[c("anchor", "color", "pitchAlignment", "rotationAlignment")], function(x){is.null(x) | is.character(x)}))
+  stopifnot(sapply(marker_options["draggable"], function(x) {is.null(x) | is.logical(x)}))
+  stopifnot(sapply(marker_options[c("rotation", "scale")], function(x) {is.null(x) | is.numeric(x)}))
+  marker_options <- marker_options |>
+    purrr::compact()
+  class(marker_options) <- "MarkerOptions"
+  return(marker_options)
+}
+
+#' Add a marker to map
+#'
+#' @param .map
+#' @param marker
+#'
+#' @export
+#' @example examples/markers.R
+add_marker <- function(.map, marker) {
+  .map |> add_call("addMarker", marker)
+}

examples/basemap.R

@@ -1,9 +1,10 @@
-test <- mapOptions(
+map_options <- mapOptions(
   center = c(-123.1256, 49.24658),
   hash = TRUE,
   pitch = 0,
   style = basemaps$carto$dark_matter,
   test = NULL
 )
-maplibre(test, zoom = 12) |>
+maplibre(map_options, zoom = 12) |>
   add_control("NavigationControl", "top-left", showCompass = F)
+

examples/earthquakes.R → examples/layers.R

@@ -5,7 +5,7 @@ earthquakes_source <- list(
   data = "https://docs.mapbox.com/mapbox-gl-js/assets/earthquakes.geojson"
 )
 
-earthquakes_layer <- layer(
+earthquakes_layer <- Layer(
   id = "earthquakes",
   type = "circle",
   source = earthquakes_source,
@@ -14,3 +14,5 @@ earthquakes_layer <- layer(
 
 maplibre() |>
   add_layer(earthquakes_layer)
+
+

examples/markers.R

@@ -0,0 +1,9 @@
+library(maplibre)
+marker = Marker(
+  lngLat = c(9.5,51.31667),
+  popup = list(text = "This is a marker",options = list(closeButton = F)),
+  color= "darkred"
+)
+
+maplibre(mapOptions(center = c(9.5,51.31667)),zoom = 4) |>
+  add_marker(marker)