Build an Embed URL for vizRd — build_embed

Helper to construct iframe URLs for template views.

Usage

build_embed_url(
  base_url,
  dataset,
  view = c("map", "bars", "line", "scatter", "area"),
  metric = NULL,
  x_metric = NULL,
  y_metric = NULL,
  year = NULL,
  date = NULL,
  geos = NULL,
  embed = TRUE,
  area_mode = NULL,
  area_series = NULL
)

Arguments

base_url: Base app URL (for example https://example.org/viz/).
dataset: Dataset id.
view: One of "map", "bars", "line", "scatter", "area".
metric: Optional metric key.
x_metric: Optional x-axis metric key for scatter.
y_metric: Optional y-axis metric key for scatter.
year: Optional year.
date: Optional date string (YYYY-MM-DD).
geos: Optional vector of ISO3 codes.
embed: Whether to force embed mode.
area_mode: Optional area rendering mode, either "absolute" or "percent". Emitted only when view = "area".
area_series: Optional displayed area-series labels. Emitted only when view = "area" and non-empty.

Value

A URL string with query parameters.

Examples

build_embed_url(
  base_url = "https://example.org/vizrd/",
  dataset = "excises",
  view = "area",
  metric = "total_excise",
  geos = c("AUT", "DEU"),
  area_mode = "percent"
)
#> [1] "https://example.org/vizrd/?dataset=excises&view=area&metric=total_excise&geos=AUT%2CDEU&area_mode=percent&embed=1"