Configure ggWebGL Transport Options — ggwebgl

ggwebgl_transport() controls how large renderer payloads are encoded before they are handed to the browser. Small scenes keep the existing JSON arrays by default; large point layers can use base64 typed arrays, palette color lookup, deterministic preview LOD, and progressive GPU upload.

Usage

ggwebgl_transport(
  mode = c("auto", "compact", "legacy"),
  threshold = 100000L,
  progressive = c("auto", "on", "off"),
  chunk_size = 100000L,
  position = c("float32", "quantized"),
  colors = c("auto", "palette", "rgba"),
  lod = c("auto", "grid", "none"),
  lod_max_points = 5000L
)

Arguments

mode: Transport mode. "auto" compacts point layers at or above threshold, "compact" compacts all point layers, and "legacy" keeps the original JSON-array payloads.
threshold: Row threshold used when mode = "auto".
progressive: Progressive upload policy. "auto" enables progressive upload for compact layers, "on" forces it, and "off" disables it.
chunk_size: Number of points per progressive upload chunk.
position: Position encoding, either "float32" or "quantized".
colors: Color encoding. "auto" uses palette lookup when beneficial and byte RGBA otherwise; "palette" requires palette lookup when possible; and "rgba" stores byte RGBA.
lod: LOD preview policy. "auto" generates deterministic grid previews for compact point layers, "grid" forces them, and "none" disables them.
lod_max_points: Maximum number of preview points generated by the grid LOD helper.

Value

A normalized ggwebgl_transport list.

Examples

ggwebgl_transport(threshold = 100000L, chunk_size = 50000L)
#> $mode
#> [1] "auto"
#> 
#> $threshold
#> [1] 100000
#> 
#> $progressive
#> [1] "auto"
#> 
#> $chunk_size
#> [1] 50000
#> 
#> $position
#> [1] "float32"
#> 
#> $colors
#> [1] "auto"
#> 
#> $lod
#> [1] "auto"
#> 
#> $lod_max_points
#> [1] 5000
#> 
#> attr(,"class")
#> [1] "ggwebgl_transport" "list"