Add func to build basemap style

eoda-dev · Oct 4, 2024 · 54444f1 · 54444f1
1 parent 48959ab
commit 54444f1
Show file tree

Hide file tree

Showing 13 changed files with 109 additions and 38 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -10,6 +10,7 @@ export(add_layer)
 export(add_marker)
 export(add_popup)
 export(add_tooltip)
+export(construct_basemap_style)
 export(mapOptions)
 export(maplibre)
 export(maplibreOutput)

diff --git a/R/basemaps.R b/R/basemaps.R
@@ -0,0 +1,16 @@
+#' Create a basemap style definition
+#' @param sources The sources to be used for the basemap style.
+#' @param layers The layers to be used for the basemap style.
+#' @param name The name of the basemap style.
+#' @returns list
+#' @example examples/pmtiles.R
+#' @export
+construct_basemap_style <- function(sources, layers, name = "custom-basemap") {
+  basemap_style <- list(
+    name = name,
+    version = 8L,
+    sources = sources,
+    layers = layers
+  )
+  return(rdantic(basemap_style, TYPES_BASEMAP_STYLE))
+}
diff --git a/R/types.R b/R/types.R
@@ -0,0 +1,6 @@
+TYPES_BASEMAP_STYLE <- list(
+  name = is.character,
+  version = is.integer,
+  sources = is.list,
+  layers = is.list
+)
diff --git a/examples/pmtiles.R b/examples/pmtiles.R
@@ -24,8 +24,9 @@ roads <- Layer(
   paint = list("line-color" = "black"),
 )
 
-custom_basemap <- list(
-  name = "custom-style", version = 8, sources = sources, layers = list(landuse, roads)
+custom_basemap <- construct_basemap_style(
+  sources,
+  layers = list(landuse, roads)
 )
 
 setup <- mapOptions(

diff --git a/man/Layer.Rd b/man/Layer.Rd
diff --git a/man/Marker.Rd b/man/Marker.Rd
diff --git a/man/MarkerOptions.Rd b/man/MarkerOptions.Rd
diff --git a/man/add_layer.Rd b/man/add_layer.Rd
diff --git a/man/add_marker.Rd b/man/add_marker.Rd
diff --git a/man/add_popup.Rd b/man/add_popup.Rd
diff --git a/man/add_tooltip.Rd b/man/add_tooltip.Rd
diff --git a/man/construct_basemap_style.Rd b/man/construct_basemap_style.Rd
diff --git a/man/maplibre.Rd b/man/maplibre.Rd