Package {geolibre}

Add a 3D Tiles layer

Description

Add a 3D Tiles layer

Usage

add_3d_tiles(
  map,
  url,
  name = "3D Tiles",
  altitude_offset = 0,
  request_headers = NULL,
  style = list(),
  visible = TRUE,
  opacity = 1,
  ...
)

Arguments

Value

The modified widget.

Examples

map <- geolibre() |>
  add_3d_tiles("https://example.com/tileset.json", altitude_offset = 20)
stopifnot(map$x$project$layers[[1]]$type == "3d-tiles")

Add a data-driven choropleth layer

Description

Classifies column into class_count numeric ranges and colors each range from colormap, producing the same graduated symbology the application's Style panel builds from the interface.

Usage

add_choropleth(
  map,
  data,
  column,
  name = "Choropleth",
  class_count = 5,
  colormap = "viridis",
  scheme = c("equal-interval", "quantile"),
  style = list(),
  visible = TRUE,
  opacity = 1,
  ...
)

Arguments

Value

The modified widget.

See Also

classify_layer() to symbolize a layer that is already on the map.

Examples

counties <- list(
  type = "FeatureCollection",
  features = list(
    list(
      type = "Feature", properties = list(pop = 100),
      geometry = list(type = "Point", coordinates = c(-77, 39))
    ),
    list(
      type = "Feature", properties = list(pop = 900),
      geometry = list(type = "Point", coordinates = c(-76, 40))
    )
  )
)
map <- geolibre() |>
  add_choropleth(counties, column = "pop", colormap = "blues", class_count = 3)
stopifnot(map$x$project$layers[[1]]$style$vectorStyleMode == "graduated")

Add circle markers

Description

add_markers() with the circle radius surfaced as a named argument.

Usage

add_circle_markers(
  map,
  points,
  name = "Circle Markers",
  radius = NULL,
  style = list(),
  visible = TRUE,
  opacity = 1,
  ...
)

Arguments

Value

The modified widget.

Examples

map <- geolibre() |>
  add_circle_markers(list(c(-77, 39)), radius = 12, fillColor = "#16a34a")

Add a Cloud Optimized GeoTIFF layer

Description

Add a Cloud Optimized GeoTIFF layer

Usage

add_cog(
  map,
  url,
  name = "COG",
  bands = NULL,
  colormap = NULL,
  rescale = NULL,
  style = list(),
  visible = TRUE,
  opacity = 1,
  ...
)

Arguments

Value

The modified widget.

See Also

add_raster(), add_tile_layer(), add_colorbar()

Examples

map <- geolibre() |>
  add_cog("https://example.com/image.tif", bands = c(1, 2, 3))
stopifnot(map$x$project$layers[[1]]$type == "cog")

Add a colorbar to the map

Description

Renders a gradient with minimum and maximum ticks, from either a named color ramp or an explicit list of CSS colors. Each call adds another colorbar.

Usage

add_colorbar(
  map,
  colormap = "viridis",
  vmin = 0,
  vmax = 1,
  label = "",
  units = "",
  colors = NULL,
  orientation = c("vertical", "horizontal"),
  position = c("bottom-right", "bottom-left", "top-left", "top-right")
)

Arguments

Value

The modified widget.

See Also

add_legend() for categorical classes

Examples

map <- geolibre() |>
  add_raster("https://example.com/dem.tif", bands = 1, colormap = "terrain") |>
  add_colorbar(
    colormap = "terrain", vmin = 0, vmax = 3000,
    label = "Elevation", units = "m"
  )

Add a colorbar from a named color ramp

Description

add_colorbar() with colormap in the leading position, for parity with the Python API.

Usage

add_colormap(map, colormap = "viridis", vmin = 0, vmax = 1, label = "", ...)

Arguments

Value

The modified widget.

Examples

geolibre() |> add_colormap("plasma", vmin = 0, vmax = 100, label = "Index")

Add a CSV of point coordinates

Description

add_xy_data() with a CSV-oriented default layer name.

Usage

add_csv(
  map,
  data,
  x = "longitude",
  y = "latitude",
  name = "CSV",
  style = list(),
  visible = TRUE,
  opacity = 1,
  ...
)

Arguments

Value

The modified widget.

Examples

text <- "name,longitude,latitude\nDC,-77.0369,38.9072"
map <- geolibre() |> add_csv(text)

Add data, optionally symbolized by a column

Description

With column supplied this is add_choropleth(); without it, add_geojson(). Provided for parity with the Python API.

Usage

add_data(map, data, column = NULL, name = "Data", ...)

Arguments

Value

The modified widget.

Examples

point <- list(type = "Point", coordinates = c(-77, 39))
map <- geolibre() |> add_data(point, name = "Point")

Add a FlatGeobuf layer

Description

Add a FlatGeobuf layer

Usage

add_flatgeobuf(map, data, name = "FlatGeobuf", ...)

Arguments

Value

The modified widget.

Examples

geolibre() |> add_flatgeobuf("https://example.com/data.fgb")

Add GeoJSON to a GeoLibre map

Description

Add GeoJSON to a GeoLibre map

Usage

add_geojson(
  map,
  data,
  name = "GeoJSON",
  style = list(),
  visible = TRUE,
  opacity = 1,
  ...
)

Arguments

Value

The modified widget.

See Also

add_sf(), add_choropleth(), add_vector()

Examples

point <- list(
  type = "Feature",
  properties = list(name = "Washington, DC"),
  geometry = list(type = "Point", coordinates = c(-77.0369, 38.9072))
)
map <- geolibre() |> add_geojson(point, name = "Places", fillColor = "#dc2626")
stopifnot(length(map$x$project$layers) == 1L)

Add a GeoParquet layer

Description

Add a GeoParquet layer

Usage

add_geoparquet(map, data, name = "GeoParquet", ...)

Arguments

Value

The modified widget.

Examples

geolibre() |> add_geoparquet("https://example.com/data.parquet")

Add a GeoPackage layer

Description

Add a GeoPackage layer

Usage

add_gpkg(map, data, name = "GeoPackage", layer = NULL, ...)

Arguments

Value

The modified widget.

Examples

geolibre() |> add_gpkg("https://example.com/data.gpkg", layer = "parcels")

Add a point density heatmap

Description

Add a point density heatmap

Usage

add_heatmap(
  map,
  points,
  name = "Heatmap",
  radius = 30,
  intensity = 1,
  style = list(),
  visible = TRUE,
  opacity = 1,
  ...
)

Arguments

Value

The modified widget.

Examples

map <- geolibre() |>
  add_heatmap(list(c(-77, 39), c(-77.05, 39.02)), radius = 40)
stopifnot(map$x$project$layers[[1]]$style$pointRenderer == "heatmap")

Add a KML or KMZ layer

Description

Add a KML or KMZ layer

Usage

add_kml(map, data, name = "KML", ...)

Arguments

Value

The modified widget.

Examples

geolibre() |> add_kml("https://example.com/places.kml")

Add a legend to the map

Description

Supply the legend entries exactly one of three ways: a built-in preset (builtin), a named vector or list of label-to-color pairs (legend), or parallel labels and colors vectors. Each call adds another legend, so a map can carry several at once.

Usage

add_legend(
  map,
  title = NULL,
  legend = NULL,
  labels = NULL,
  colors = NULL,
  builtin = NULL,
  position = c("bottom-left", "bottom-right", "top-left", "top-right"),
  shape = c("square", "circle", "line")
)

Arguments

Value

The modified widget.

See Also

add_colorbar() for continuous rasters, builtin_legend_names()

Examples

map <- geolibre() |>
  add_legend(
    "Land cover",
    legend = c(Water = "#466b9f", Forest = "#1c5f2c"),
    position = "bottom-left"
  )

# A built-in preset carries its own title and colors.
geolibre() |> add_legend(builtin = "nlcd")

Add a single point marker

Description

Add a single point marker

Usage

add_marker(
  map,
  lng,
  lat,
  name = "Marker",
  properties = NULL,
  style = list(),
  visible = TRUE,
  opacity = 1,
  ...
)

Arguments

Value

The modified widget.

Examples

map <- geolibre() |>
  add_marker(-77.0369, 38.9072, name = "DC", circleRadius = 10)

Add clustered point markers

Description

Builds a point layer with the cluster renderer enabled, so nearby points collapse into count bubbles that split apart as the map zooms in.

Usage

add_marker_cluster(
  map,
  points,
  name = "Marker Cluster",
  cluster_radius = 50,
  cluster_max_zoom = 14,
  style = list(),
  visible = TRUE,
  opacity = 1,
  ...
)

Arguments

Value

The modified widget.

Examples

map <- geolibre() |>
  add_marker_cluster(list(c(-77, 39), c(-77.1, 39.1)), cluster_radius = 60)
stopifnot(map$x$project$layers[[1]]$style$pointRenderer == "cluster")

Add point markers

Description

Add point markers

Usage

add_markers(
  map,
  points,
  name = "Markers",
  style = list(),
  visible = TRUE,
  opacity = 1,
  ...
)

Arguments

Value

The modified widget.

See Also

add_circle_markers(), add_marker_cluster(), add_heatmap()

Examples

map <- geolibre() |>
  add_markers(list(c(-77.0369, 38.9072), c(-74.006, 40.7128)), name = "Cities")
stopifnot(length(map$x$project$layers[[1]]$geojson$features) == 2L)

Add a PMTiles layer

Description

The application registers the ⁠pmtiles://⁠ protocol itself, so a plain ⁠https://⁠ URL to the archive is what this expects.

Usage

add_pmtiles(
  map,
  url,
  name = "PMTiles",
  tile_type = c("vector", "raster"),
  source_layers = NULL,
  style = list(),
  visible = TRUE,
  opacity = 1,
  ...
)

Arguments

Value

The modified widget.

Examples

map <- geolibre() |>
  add_pmtiles("https://example.com/data.pmtiles", source_layers = "buildings")
stopifnot(map$x$project$layers[[1]]$type == "pmtiles")

Add a remote raster to a GeoLibre map

Description

add_cog() with a generic default layer name.

Usage

add_raster(
  map,
  url,
  name = "Raster",
  bands = NULL,
  colormap = NULL,
  rescale = NULL,
  style = list(),
  visible = TRUE,
  opacity = 1,
  ...
)

Arguments

Value

The modified widget.

Examples

map <- geolibre() |>
  add_raster("https://example.com/image.tif", bands = c(1, 2, 3))
stopifnot(map$x$project$layers[[1]]$type == "cog")

Add an sf object to a GeoLibre map

Description

The object is transformed to EPSG:4326 before serialization. An object with no CRS is taken to be in longitude/latitude order already, since that is what GeoJSON means.

Usage

add_sf(
  map,
  data,
  name = NULL,
  style = list(),
  visible = TRUE,
  opacity = 1,
  ...
)

Arguments

Value

The modified widget.

Examples

if (requireNamespace("sf", quietly = TRUE)) {
  point <- sf::st_sf(
    name = "Washington, DC",
    geometry = sf::st_sfc(sf::st_point(c(-77.0369, 38.9072)), crs = 4326)
  )
  map <- geolibre() |> add_sf(point, name = "Places")
}

Add a Shapefile layer

Description

Add a Shapefile layer

Usage

add_shp(map, data, name = "Shapefile", ...)

Arguments

Value

The modified widget.

Examples

geolibre() |> add_shp("https://example.com/data.zip")

Add an XYZ raster tile layer

Description

Add an XYZ raster tile layer

Usage

add_tile_layer(
  map,
  url,
  name = "Tile Layer",
  tile_size = 256,
  attribution = NULL,
  style = list(),
  visible = TRUE,
  opacity = 1,
  ...
)

Arguments

Value

The modified widget.

Examples

map <- geolibre() |>
  add_tile_layer(
    "https://tile.openstreetmap.org/{z}/{x}/{y}.png",
    name = "OpenStreetMap",
    attribution = "OpenStreetMap contributors"
  )
stopifnot(map$x$project$layers[[1]]$type == "xyz")

Add a vector dataset from a URL or local file

Description

A remote URL is handed to the application's in-browser vector control, so any format it reads (GeoParquet, FlatGeobuf, zipped Shapefile, GeoPackage, GeoJSON, KML, ...) streams without being inlined in the project. A local file is read with sf and inlined as GeoJSON, since the browser cannot reach a file on this machine.

Usage

add_vector(
  map,
  data,
  name = "Vector",
  render_mode = c("geojson", "tiles"),
  data_format = NULL,
  source_layer = NULL,
  picker = NULL,
  ingest_mode = NULL,
  style = list(),
  visible = TRUE,
  opacity = 1,
  ...
)

Arguments

Value

The modified widget.

Examples

map <- geolibre() |>
  add_vector("https://example.com/data.parquet", name = "Parcels")
stopifnot(map$x$project$layers[[1]]$metadata$sourceKind == "maplibre-gl-vector")

Add a vector tile layer from a TileJSON endpoint

Description

Add a vector tile layer from a TileJSON endpoint

Usage

add_vector_tiles(
  map,
  url,
  name = "Vector Tiles",
  source_layers = NULL,
  source_layer = NULL,
  style = list(),
  visible = TRUE,
  opacity = 1,
  ...
)

Arguments

Value

The modified widget.

Examples

map <- geolibre() |>
  add_vector_tiles("https://example.com/tiles.json", source_layer = "roads")
stopifnot(map$x$project$layers[[1]]$type == "vector-tiles")

Add a georeferenced video layer

Description

Add a georeferenced video layer

Usage

add_video(
  map,
  urls,
  coordinates,
  name = "Video",
  style = list(),
  visible = TRUE,
  opacity = 1,
  ...
)

Arguments

Value

The modified widget.

Examples

map <- geolibre() |>
  add_video(
    "https://example.com/clip.mp4",
    coordinates = list(
      c(-77.1, 39.0), c(-77.0, 39.0), c(-77.0, 38.9), c(-77.1, 38.9)
    )
  )
stopifnot(map$x$project$layers[[1]]$type == "video")

Add a WFS layer

Description

The GetFeature response is fetched and inlined into the project, so the endpoint must be able to return GeoJSON. This function contacts the service when called.

Usage

add_wfs(
  map,
  endpoint,
  type_name,
  name = "WFS Layer",
  version = "2.0.0",
  output_format = "application/json",
  srs_name = "EPSG:4326",
  max_features = 1000,
  style = list(),
  visible = TRUE,
  opacity = 1,
  ...
)

Arguments

Value

The modified widget.

Examples

## Not run: 
geolibre() |>
  add_wfs("https://ahocevar.com/geoserver/wfs", type_name = "topp:states")

## End(Not run)

Add a WMS layer

Description

The layer is rendered as tiled raster from WMS GetMap requests, built exactly as the application's Add Data dialog builds them.

Usage

add_wms(
  map,
  endpoint,
  layers,
  name = "WMS Layer",
  styles = "",
  image_format = "image/png",
  transparent = TRUE,
  tile_size = 256,
  version = "1.1.1",
  style = list(),
  visible = TRUE,
  opacity = 1,
  ...
)

Arguments

Value

The modified widget.

Examples

map <- geolibre() |>
  add_wms(
    "https://example.com/geoserver/wms",
    layers = "topp:states",
    name = "States"
  )
stopifnot(map$x$project$layers[[1]]$type == "wms")

Add a WMTS layer

Description

Add a WMTS layer

Usage

add_wmts(
  map,
  url,
  name = "WMTS Layer",
  tile_size = 256,
  style = list(),
  visible = TRUE,
  opacity = 1,
  ...
)

Arguments

Value

The modified widget.

Examples

map <- geolibre() |>
  add_wmts("https://example.com/wmts/layer/{z}/{y}/{x}.png", name = "Imagery")
stopifnot(map$x$project$layers[[1]]$type == "wmts")

Add points from tabular longitude and latitude columns

Description

Add points from tabular longitude and latitude columns

Usage

add_xy_data(
  map,
  data,
  x = "longitude",
  y = "latitude",
  name = "XY Data",
  style = list(),
  visible = TRUE,
  opacity = 1,
  ...
)

Arguments

Value

The modified widget.

Examples

cities <- data.frame(
  name = c("Washington", "New York"),
  longitude = c(-77.0369, -74.006),
  latitude = c(38.9072, 40.7128)
)
map <- geolibre() |> add_xy_data(cities, name = "Cities")
stopifnot(length(map$x$project$layers[[1]]$geojson$features) == 2L)

Named GeoLibre basemaps

Description

Lists the vector basemap styles that set_basemap() and geolibre() accept by name. Raster tile basemaps such as OpenStreetMap are added as layers with add_tile_layer() instead.

Usage

basemaps()

Value

A named character vector mapping basemap name to MapLibre style URL.

Examples

basemaps()
names(basemaps())

Built-in legend preset names

Description

The preset names accepted by the builtin argument of add_legend().

Usage

builtin_legend_names()

Value

A character vector of preset names.

Examples

builtin_legend_names()

Symbolize an existing layer as a choropleth

Description

Symbolize an existing layer as a choropleth

Usage

classify_layer(
  map,
  layer,
  column,
  class_count = 5,
  colormap = "viridis",
  scheme = c("equal-interval", "quantile")
)

Arguments

Value

The modified widget.

See Also

add_choropleth() to add and symbolize in one call.

Examples

counties <- list(
  type = "FeatureCollection",
  features = list(
    list(
      type = "Feature", properties = list(pop = 10),
      geometry = list(type = "Point", coordinates = c(-77, 39))
    ),
    list(
      type = "Feature", properties = list(pop = 90),
      geometry = list(type = "Point", coordinates = c(-76, 40))
    )
  )
)
map <- geolibre() |>
  add_geojson(counties, name = "Counties") |>
  classify_layer("Counties", "pop", colormap = "reds")
stopifnot(map$x$project$layers[[1]]$style$vectorStyleProperty == "pop")

Remove every layer

Description

Remove every layer

Usage

clear_layers(map)

Arguments

Value

The modified widget.

Examples

map <- geolibre() |> add_marker(-77, 39) |> clear_layers()
stopifnot(length(map$x$project$layers) == 0L)

Available color ramp names

Description

The ramp names accepted by add_choropleth(), classify_layer(), and add_colorbar().

Usage

color_ramp_names()

Value

A character vector of ramp names.

Examples

color_ramp_names()

Read one feature property across a layer

Description

Read one feature property across a layer

Usage

column_values(x, layer, column)

Arguments

Value

A list of the raw values, one per feature, with NULL where the property is absent.

Examples

point <- list(
  type = "Feature", properties = list(pop = 700000),
  geometry = list(type = "Point", coordinates = c(-77, 39))
)
map <- geolibre() |> add_geojson(point, name = "Places")
column_values(map, "Places", "pop")

Summarize a GeoLibre project

Description

Reports the camera, basemap, layers, and active map controls. URLs come back with their credentials stripped, since several basemap providers put an API key in the style URL itself.

Usage

describe_project(project)

Arguments

Value

A list with the project name, version, mapView, basemapStyleUrl, layerCount, a layers data frame, and the names of the active mapControls.

See Also

get_layers()

Examples

map <- geolibre() |>
  add_marker(-77, 39, name = "Pin") |>
  add_legend(legend = c(Pin = "#3b82f6"))
summary <- describe_project(map)
summary$layerCount
summary$mapControls

Duplicate a layer

Description

The copy is appended to the top of the draw order, where a newly added layer lands. Use move_layer() to put it elsewhere.

Usage

duplicate_layer(map, layer, name = NULL)

Arguments

Value

The modified widget.

Examples

map <- geolibre() |>
  add_marker(-77, 39, name = "Pin") |>
  duplicate_layer("Pin")
stopifnot(layer_names(map)[[2]] == "Pin copy")

Position of a layer in the draw order

Description

Position of a layer in the draw order

Usage

find_layer_index(x, name)

Arguments

Value

The one-based index of the first matching layer, or -1 when none matches. Unlike the functions that modify a layer, a name several layers share resolves to the first of them rather than raising.

Examples

map <- geolibre() |> add_marker(-77, 39, name = "Pin")
find_layer_index(map, "Pin")
find_layer_index(map, "Missing")

Frame a bounding box

Description

A saved project records a center and zoom rather than a box to fit: the application applies mapView$center and mapView$zoom verbatim when it opens a project. So the box is resolved to a camera here, using an assumed viewport, and recorded alongside it for reference. The result is approximate by construction; expect the application's own "zoom to layer" to land within roughly half a zoom level.

Usage

fit_bounds(map, bbox, padding = 40)

Arguments

Value

The modified widget.

Examples

map <- geolibre() |> fit_bounds(c(-125, 24, -66, 50))
round(map$x$project$mapView$zoom, 1)

Create a GeoLibre widget

Description

Creates an htmlwidget that embeds the GeoLibre geographic information system. The widget carries a .geolibre.json project, which the ⁠add_*()⁠, ⁠set_*()⁠, and control functions build up with the pipe.

Usage

geolibre(
  project = NULL,
  center = NULL,
  zoom = NULL,
  basemap = NULL,
  name = "Untitled Project",
  width = NULL,
  height = NULL,
  app_url = getOption("geolibre.app_url", "https://web.geolibre.app/"),
  layout = c("embed", "full", "maponly"),
  theme = c("light", "dark"),
  map_only = FALSE,
  elementId = NULL,
  panels = c("expanded", "collapsed", "hidden")
)

Arguments

Details

The default hosted application requires internet access when the widget is displayed. Package installation, project construction, and file operations do not contact it. Set app_url or the geolibre.app_url option to use a self-hosted deployment.

Value

An htmlwidget that can be modified with ⁠add_*()⁠ functions.

See Also

add_geojson(), set_view(), save_project()

Examples

map <- geolibre(center = c(-77.0369, 38.9072), zoom = 10, layout = "maponly")
stopifnot(inherits(map, "geolibre"))

# A dark-themed map with the full application interface.
geolibre(basemap = "dark", layout = "full")

Shiny bindings for GeoLibre

Description

Shiny bindings for GeoLibre

Usage

geolibreOutput(outputId, width = "100%", height = "700px")

renderGeolibre(expr, env = parent.frame(), quoted = FALSE)

Arguments

Value

geolibreOutput() returns a Shiny output element; renderGeolibre() returns a render function for it.

Shiny inputs

A rendered widget reports back through four inputs, where id is the outputId:

• input$id_project — the full project each time the user edits the map.

• input$id_error — the message from a project the application rejected.

• input$id_result — the reply to a proxy command; a list with requestId, method, ok, and then value or error.

• input$id_event — user interaction; a list with event, one of "click", "selection-change", or "layer-change", and its payload.

Examples

if (requireNamespace("shiny", quietly = TRUE)) {
  output <- geolibreOutput("map", height = "500px")
  stopifnot(inherits(output, "shiny.tag.list"))
}

Send a command to a live GeoLibre map

Description

The escape hatch behind the ⁠geolibre_*()⁠ command functions: it forwards any method the application's scripting bridge implements. The reply arrives asynchronously on the input$id_result input described in geolibreOutput().

Usage

geolibre_command(proxy, method, params = list(), request_id = NULL)

Arguments

Value

The proxy, invisibly.

See Also

geolibre_fly_to(), geolibre_get_view(), geolibre_run_algorithm()

Examples

if (interactive() && requireNamespace("shiny", quietly = TRUE)) {
  geolibre_command(geolibre_proxy("map"), "zoomToLayer", list(layerId = "abc"))
}

Fit a live GeoLibre map to a bounding box

Description

Fit a live GeoLibre map to a bounding box

Usage

geolibre_fit_bounds(proxy, bbox, request_id = NULL)

Arguments

Value

The proxy, invisibly.

Examples

if (interactive() && requireNamespace("shiny", quietly = TRUE)) {
  geolibre_fit_bounds(geolibre_proxy("map"), c(-125, 24, -66, 50))
}

Animate the camera of a live GeoLibre map

Description

Unlike set_view(), which records the camera a project opens at, this animates the map that is already on screen. Omitted fields keep their current value.

Usage

geolibre_fly_to(
  proxy,
  center = NULL,
  zoom = NULL,
  bearing = NULL,
  pitch = NULL,
  duration = NULL,
  request_id = NULL
)

Arguments

Value

The proxy, invisibly.

Examples

if (interactive() && requireNamespace("shiny", quietly = TRUE)) {
  geolibre_fly_to(geolibre_proxy("map"), center = c(-77.0369, 38.9072), zoom = 12)
}

Read the camera of a live GeoLibre map

Description

The reply arrives on input$id_result with a value holding center, zoom, bearing, pitch, and the current bbox.

Usage

geolibre_get_view(proxy, request_id = NULL)

Arguments

Value

The proxy, invisibly.

Examples

if (interactive() && requireNamespace("shiny", quietly = TRUE)) {
  geolibre_get_view(geolibre_proxy("map"))
}

Identify features at a point on a live GeoLibre map

Description

Identify features at a point on a live GeoLibre map

Usage

geolibre_identify(proxy, lnglat, layer_id = NULL, request_id = NULL)

Arguments

Value

The proxy, invisibly.

Examples

if (interactive() && requireNamespace("shiny", quietly = TRUE)) {
  geolibre_identify(geolibre_proxy("map"), c(-77.0369, 38.9072))
}

Read features from a live GeoLibre map

Description

geolibre_layer_features() returns one layer's features, geolibre_selected_features() the current selection, and geolibre_drawn_features() whatever the user drew with the map's editing tools. Each reply arrives on input$id_result.

Usage

geolibre_layer_features(proxy, layer_id, request_id = NULL)

geolibre_selected_features(proxy, request_id = NULL)

geolibre_drawn_features(proxy, request_id = NULL)

Arguments

Value

The proxy, invisibly.

Examples

if (interactive() && requireNamespace("shiny", quietly = TRUE)) {
  geolibre_drawn_features(geolibre_proxy("map"))
}

Create a GeoLibre Shiny proxy

Description

A proxy addresses a widget that is already on screen, so a Shiny app can replace its project with update_geolibre() or drive the live map with the ⁠geolibre_*()⁠ command functions, without re-rendering the widget.

Usage

geolibre_proxy(outputId, session = NULL)

Arguments

Value

A geolibre_proxy object.

See Also

update_geolibre(), geolibre_fly_to(), geolibre_command()

Examples

if (interactive() && requireNamespace("shiny", quietly = TRUE)) {
  proxy <- geolibre_proxy("map")
}

Run a processing algorithm on a live GeoLibre map

Description

geolibre_list_algorithms() reports the available tools with their parameters; geolibre_run_algorithm() runs one in the browser. Results arrive on input$id_result, and any output layers are added to the map.

Usage

geolibre_run_algorithm(proxy, algorithm, params = list(), request_id = NULL)

geolibre_list_algorithms(proxy, request_id = NULL)

Arguments

Value

The proxy, invisibly.

Examples

if (interactive() && requireNamespace("shiny", quietly = TRUE)) {
  proxy <- geolibre_proxy("map")
  geolibre_list_algorithms(proxy)
  geolibre_run_algorithm(proxy, "buffer", list(layerId = "abc", distance = 500))
}

Capture a live GeoLibre map as a PNG

Description

The reply arrives on input$id_result with a value holding a ⁠data:image/png;base64,...⁠ URL. Strip the prefix up to the comma and pass the rest to jsonlite::base64_dec() to recover the PNG bytes.

Usage

geolibre_to_image(proxy, request_id = NULL)

Arguments

Value

The proxy, invisibly.

Examples

if (interactive() && requireNamespace("shiny", quietly = TRUE)) {
  geolibre_to_image(geolibre_proxy("map"))
}

Zoom a live GeoLibre map to a layer's extent

Description

Zoom a live GeoLibre map to a layer's extent

Usage

geolibre_zoom_to_layer(proxy, layer_id, request_id = NULL)

Arguments

Value

The proxy, invisibly.

Examples

if (interactive() && requireNamespace("shiny", quietly = TRUE)) {
  geolibre_zoom_to_layer(geolibre_proxy("map"), "layer-id")
}

Anchor colors of a color ramp

Description

Anchor colors of a color ramp

Usage

get_color_ramp(name = "viridis")

Arguments

Value

A character vector of ⁠#rrggbb⁠ colors.

Examples

get_color_ramp("viridis")
get_color_ramp("blues")

Read one layer's full definition

Description

Read one layer's full definition

Usage

get_layer(x, layer)

Arguments

Value

The layer as a list, with credential-bearing fields stripped.

Examples

map <- geolibre() |> add_marker(-77, 39, name = "Pin")
get_layer(map, "Pin")$type

Summarize a project's layers

Description

Summarize a project's layers

Usage

get_layers(x)

Arguments

Value

A data frame with one row per layer, in draw order, holding its id, name, type, visible, opacity, source URL (credentials stripped), and inlined features count.

Examples

map <- geolibre() |>
  add_marker(-77, 39, name = "Pin") |>
  add_raster("https://example.com/image.tif", name = "Image")
get_layers(map)

Read a project out of a widget

Description

Read a project out of a widget

Usage

get_project(map, keep_credentials = FALSE)

Arguments

Value

The project as a list.

Examples

map <- geolibre() |> add_marker(-77, 39, name = "Pin")
project <- get_project(map)
project$layers[[1]]$name

Sample a color ramp into evenly spaced colors

Description

Mirrors the application's ramp interpolation, so a palette generated here matches the one the Style panel would compute.

Usage

interpolate_ramp_colors(name = "viridis", count = 5)

Arguments

Value

A character vector of count ⁠#rrggbb⁠ colors.

Examples

interpolate_ramp_colors("viridis", 5)

Layer names in draw order

Description

Layer names in draw order

Usage

layer_names(x)

Arguments

Value

A character vector of layer names, bottom layer first.

Examples

map <- geolibre() |> add_marker(-77, 39, name = "Pin")
layer_names(map)

Sample a layer's feature properties

Description

Lets you discover what an inlined vector layer can be styled or filtered by without reading every feature back.

Usage

layer_properties(x, layer)

Arguments

Value

A named list mapping each property name to up to 25 distinct sample values, in first-seen order.

Examples

point <- list(
  type = "Feature", properties = list(name = "DC", pop = 700000),
  geometry = list(type = "Point", coordinates = c(-77, 39))
)
map <- geolibre() |> add_geojson(point, name = "Places")
layer_properties(map, "Places")

Read a GeoLibre project

Description

Read a GeoLibre project

Usage

load_project(source)

Arguments

Value

A project list.

See Also

save_project(), describe_project()

Examples

project <- load_project('{"version":"0.2.0","name":"Example","mapView":{}}')
stopifnot(project$name == "Example")

# A saved project can be reopened as a widget.
path <- tempfile(fileext = ".geolibre.json")
save_project(geolibre() |> add_marker(-77, 39), path)
map <- geolibre(load_project(path))

Move a layer in the draw order

Description

Move a layer in the draw order

Usage

move_layer(map, layer, index)

Arguments

Value

The modified widget.

Examples

map <- geolibre() |>
  add_marker(-77, 39, name = "Bottom") |>
  add_marker(-76, 40, name = "Top") |>
  move_layer("Top", 1)
stopifnot(layer_names(map)[[1]] == "Top")

Strip credentials from a whole project

Description

Returns a project safe to publish, export, or hand to someone else: layer request headers and signed URLs, basemap style keys, geocoding keys, stored environment variables, and third-party plugin settings are all removed. The first-party map controls (legend, colorbar, swipe) are kept, since a project needs them to render as it was built.

Usage

redact_credentials(project)

Arguments

Details

save_project() applies this by default.

Value

The project list with credentials removed.

Examples

map <- geolibre() |> add_marker(-77, 39)
safe <- redact_credentials(map)
safe$name

Strip credentials from one layer

Description

Strip credentials from one layer

Usage

redact_layer(layer)

Arguments

Value

The layer with its credential-bearing configuration removed.

Examples

map <- geolibre() |>
  add_3d_tiles(
    "https://example.com/tileset.json",
    request_headers = list(Authorization = "Bearer secret")
  )
layer <- redact_layer(map$x$project$layers[[1]])
is.null(layer$source$requestHeaders)

Strip credentials from a URL

Description

Removes any ⁠user:password@⁠ prefix and any query parameter whose name marks it as a credential, such as api_key, access_token, or an Azure shared-access signature. The rest of the URL is left byte-for-byte intact.

Usage

redact_url(url)

Arguments

Value

The URL with its credentials removed.

Examples

redact_url("https://tiles.example.com/style.json?api_key=secret&lang=en")
redact_url("https://user:pw@example.com/data.tif")

Remove a layer

Description

Remove a layer

Usage

remove_layer(map, layer)

Arguments

Value

The modified widget.

Examples

map <- geolibre() |>
  add_marker(-77, 39, name = "Pin") |>
  remove_layer("Pin")
stopifnot(length(map$x$project$layers) == 0L)

Rename a layer

Description

Rename a layer

Usage

rename_layer(map, layer, name)

Arguments

Value

The modified widget.

Examples

map <- geolibre() |>
  add_marker(-77, 39, name = "Pin") |>
  rename_layer("Pin", "Capital")
stopifnot(layer_names(map) == "Capital")

Save a GeoLibre project

Description

Save a GeoLibre project

Usage

save_project(map, path, keep_credentials = FALSE)

Arguments

Value

path, invisibly.

See Also

load_project(), redact_credentials()

Examples

path <- tempfile(fileext = ".geolibre.json")
save_project(geolibre(), path)
project <- load_project(path)
stopifnot(project$name == "Untitled Project")

Set the background basemap

Description

Set the background basemap

Usage

set_basemap(map, basemap)

add_basemap(map, basemap)

Arguments

Value

The modified widget.

See Also

basemaps(), add_tile_layer() for raster basemaps such as OpenStreetMap.

Examples

map <- geolibre() |> set_basemap("dark")
map$x$project$basemapStyleUrl

Set the camera bearing

Description

Set the camera bearing

Usage

set_bearing(map, bearing)

Arguments

Value

The modified widget.

Examples

map <- geolibre() |> set_bearing(45)
stopifnot(map$x$project$mapView$bearing == 45)

Center the map

Description

Center the map

Usage

set_center(map, lng, lat, zoom = NULL)

Arguments

Value

The modified widget.

Examples

map <- geolibre() |> set_center(-77.0369, 38.9072, zoom = 11)
stopifnot(map$x$project$mapView$zoom == 11)

Set a layer's opacity

Description

Set a layer's opacity

Usage

set_layer_opacity(map, layer, opacity)

Arguments

Value

The modified widget.

Examples

map <- geolibre() |>
  add_marker(-77, 39, name = "Pin") |>
  set_layer_opacity("Pin", 0.4)
stopifnot(map$x$project$layers[[1]]$opacity == 0.4)

Restyle a layer

Description

Merges style overrides into a layer's existing style. Keys not mentioned keep their current values.

Usage

set_layer_style(map, layer, style = list(), ...)

Arguments

Value

The modified widget.

Examples

map <- geolibre() |>
  add_marker(-77, 39, name = "Pin") |>
  set_layer_style("Pin", fillColor = "#f59e0b", circleRadius = 9)
stopifnot(map$x$project$layers[[1]]$style$fillColor == "#f59e0b")

Show or hide a layer

Description

Show or hide a layer

Usage

set_layer_visibility(map, layer, visible = TRUE)

show_layer(map, layer)

hide_layer(map, layer)

Arguments

Value

The modified widget.

Examples

map <- geolibre() |>
  add_marker(-77, 39, name = "Pin") |>
  set_layer_visibility("Pin", FALSE)
stopifnot(isFALSE(map$x$project$layers[[1]]$visible))

Set the camera pitch

Description

Set the camera pitch

Usage

set_pitch(map, pitch)

Arguments

Value

The modified widget.

Examples

map <- geolibre() |> set_pitch(60)
stopifnot(map$x$project$mapView$pitch == 60)

Set the project name

Description

Set the project name

Usage

set_project_name(map, name)

Arguments

Value

The modified widget.

Examples

map <- geolibre() |> set_project_name("Chesapeake Bay")
map$x$project$name

Set the GeoLibre camera

Description

Set the GeoLibre camera

Usage

set_view(
  map,
  center = NULL,
  zoom = NULL,
  bearing = NULL,
  pitch = NULL,
  bbox = NULL
)

Arguments

Value

The modified widget.

See Also

fit_bounds(), set_center(), set_zoom()

Examples

map <- geolibre() |>
  set_view(center = c(-77.0369, 38.9072), zoom = 10, pitch = 30)
stopifnot(map$x$project$mapView$zoom == 10)

Set the map zoom

Description

Set the map zoom

Usage

set_zoom(map, zoom)

Arguments

Value

The modified widget.

Examples

map <- geolibre() |> set_zoom(6)
stopifnot(map$x$project$mapView$zoom == 6)

Add a split-map comparison slider

Description

Enables the Layer Swipe control, which clips one set of layers to one side of a draggable slider and another set to the other, for before-and-after comparisons.

Usage

split_map(
  map,
  left_layers = NULL,
  right_layers = NULL,
  orientation = c("vertical", "horizontal"),
  position = 50,
  control_position = c("top-left", "top-right", "bottom-left", "bottom-right")
)

Arguments

Value

The modified widget.

Examples

map <- geolibre() |>
  add_raster("https://example.com/before.tif", name = "Before") |>
  add_raster("https://example.com/after.tif", name = "After") |>
  split_map("Before", "After")
stopifnot(length(map$x$project$plugins$settings) == 1L)

Export a map as a standalone HTML page

Description

The page embeds the GeoLibre application in an iframe and injects the project into it over the same postMessage bridge the widget uses, so it renders the map as configured. Unlike the widget it needs no running R session; by default it loads the hosted application over the network so the file stays portable.

Usage

to_html(
  map,
  path = NULL,
  title = "GeoLibre Map",
  width = "100%",
  height = "800px",
  app_url = getOption("geolibre.app_url", "https://web.geolibre.app/")
)

Arguments

Details

Credentials are stripped from the inlined project on the way out, as save_project() does.

Value

The HTML string, or path invisibly when path is supplied.

See Also

save_project() to write the project itself

Examples

map <- geolibre() |> add_marker(-77.0369, 38.9072, name = "DC")
html <- to_html(map, title = "Washington, DC")
substr(html, 1, 15)

path <- tempfile(fileext = ".html")
to_html(map, path)

Replace the project displayed by a GeoLibre Shiny widget

Description

Replace the project displayed by a GeoLibre Shiny widget

Usage

update_geolibre(proxy, map)

Arguments

Value

The proxy, invisibly.

Examples

if (interactive() && requireNamespace("shiny", quietly = TRUE)) {
  update_geolibre(geolibre_proxy("map"), geolibre())
}