Merge pull request #6 from eodaGmbH/feature/add_layerprops

Feature/add layerprops

DESCRIPTION

@@ -13,8 +13,8 @@ Encoding: UTF-8
 LazyData: true
 RoxygenNote: 7.2.3
 Depends: 
-    R (>= 4.1.0)
-URL: https://eodagmbh.github.io/r-maplibregl/
+  R (>= 4.1.0)
+URL: https://eodagmbh.github.io/r-maplibregl, https://github.com/eodaGmbH/r-maplibregl
 Imports: 
     geojsonsf,
     htmlwidgets,

NAMESPACE

@@ -7,6 +7,8 @@ export(add_call)
 export(add_control)
 export(add_layer)
 export(add_marker)
+export(add_popup)
+export(add_tooltip)
 export(mapOptions)
 export(maplibre)
 export(maplibreOutput)

R/layer.R

@@ -6,6 +6,8 @@
 #' @param paint
 #' @param layout
 #'
+#' @example examples/layers.R
+#'
 #' @export
 Layer <- function(type, id, source = NULL, paint = NULL, layout = NULL, ...) {
   list(
@@ -25,7 +27,39 @@ Layer <- function(type, id, source = NULL, paint = NULL, layout = NULL, ...) {
 #' @param .map
 #' @param layer
 #'
+#' @example examples/layers.R
 #' @export
 add_layer <- function(.map, layer) {
   .map |> add_call("addLayer", layer)
 }
+
+
+#' Add popup property to layer
+#'
+#' @param .map
+#' @param layer_id
+#' @param prop
+#'
+#' @return
+#' @export
+#'
+#' @example examples/layers.R
+add_popup <- function(.map, layer_id, prop){
+  .map |> add_call("addPopup", layer_id, prop)
+}
+
+
+#' Title
+#'
+#' @param .map
+#' @param layer_id
+#' @param prop
+#'
+#' @return
+#' @export
+#'
+#' @examples
+#' @example examples/layers.R
+add_tooltip <- function(.map, layer_id, prop){
+  .map |> add_call("addTooltip", layer_id, prop)
+}

R/marker.R

@@ -14,7 +14,23 @@ Marker <- function(lngLat, popup = NULL, ...) {
     set_maplibre_class("MapLibreMarker")
 }
 
-MarkerOptions <- function(...) {
+#' Title
+#'
+#' @param ...
+#' @param anchor
+#' @param color
+#' @param pitchAlignment
+#' @param rotationAlignment
+#' @param draggable
+#' @param rotation
+#' @param scale
+#'
+#' @return
+#' @export
+#'
+#' @example examples/markers.R
+MarkerOptions <- function(anchor = NULL, color = NULL, pitchAlignment = NULL, rotationAlignment = NULL,
+                          draggable = NULL, rotation = NULL, scale = NULL,...){
   marker_options <- list(...)
   stopifnot(sapply(marker_options[c("anchor", "color", "pitchAlignment", "rotationAlignment")], function(x) {
     is.null(x) | is.character(x)

_pkgdown.yml

@@ -1,4 +1,9 @@
 url: https://eodagmbh.github.io/r-maplibregl/
 template:
   bootstrap: 5
+navbar:
+  structure:
+    left:  [intro, reference]
+    right: [search, github]
+
 

examples/layers.R

@@ -12,7 +12,15 @@ earthquakes_layer <- Layer(
   paint = list("circle-color" = "yellow", "circle-radius" = 2)
 )
 
+# Adds a tooltip that appears when hovering over it
+
 maplibre() |>
-  add_layer(earthquakes_layer)
+  add_layer(earthquakes_layer) |>
+  add_tooltip("earthquakes", prop = "mag")
+
+# Adds a popup that appears when clicking on the layer
 
+maplibre() |>
+  add_layer(earthquakes_layer) |>
+  add_popup("earthquakes", prop = "mag")