Build a Share URL for vizRd — build_share

Construct a stable URL for a template dashboard or generic explorer state.

Usage

build_share_url(
  base_url,
  dataset,
  view = NULL,
  metric = NULL,
  x_metric = NULL,
  y_metric = NULL,
  year = NULL,
  date = NULL,
  geos = NULL,
  chart = NULL,
  numeric = NULL,
  numeric2 = NULL,
  category = NULL,
  datetime = NULL,
  group = NULL,
  embed = FALSE,
  area_mode = NULL,
  area_series = NULL
)

Arguments

base_url: Base app URL. HTTP(S) URLs and app-relative paths are supported; local filesystem paths and unsafe schemes are rejected.
dataset: Dataset id.
view: Optional template view: "map", "bars", "line", "scatter", or "area".
metric: Optional template 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.
chart: Optional generic explorer chart id.
numeric: Optional generic explorer numeric column.
numeric2: Optional generic explorer secondary numeric column.
category: Optional generic explorer category column.
datetime: Optional generic explorer datetime column.
group: Optional generic explorer grouping column.
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_share_url(
  base_url = "https://example.org/vizrd/",
  dataset = "sales",
  chart = "histogram",
  numeric = "total_sales"
)
#> [1] "https://example.org/vizrd/?dataset=sales&chart=histogram&numeric=total_sales"