R/globe.R

In JohnCoene/echarts4: Create Interactive Graphs with 'Echarts JavaScript' Version 5

#' Globe
#'
#' Add globe.
#'
#' @inheritParams e_bar
#' @param environment Texture of background.
#' @param base_texture Base texture of globe.
#' @param height_texture Texture of height.
#'
#' @examples
#' \dontrun{
#' url <- paste0(
#'   "https://echarts.apache.org/examples/",
#'   "data-gl/asset/data/population.json"
#' )
#' data <- jsonlite::fromJSON(url)
#' data <- as.data.frame(data)
#' names(data) <- c("lon", "lat", "value")
#'
#' data |>
#'   e_charts(lon) |>
#'   e_globe(
#'     displacementScale = 0.04
#'   ) |>
#'   e_bar_3d(lat, value, "globe") |>
#'   e_visual_map(show = FALSE)
#' }
#'
#' @seealso \code{\link{e_country_names}}, \href{https://echarts.apache.org/en/option-gl.html#globe}{Additional arguments}
#'
#' @export
e_globe <- function(e, environment = NULL, base_texture = NULL, height_texture = NULL, ...) {
  if (missing(e)) {
    stop("missing e", call. = FALSE)
  }

  if (is.null(base_texture)) {
    message("`base_texture` is `NULL`, see echarts4r-assets.john-coene.com")
  }

  e$x$mainOpts$renderer <- "webgl"

  ls <- list(
    environment = environment,
    heightTexture = height_texture,
    baseTexture = base_texture,
    series = list(),
    ...
  )

  if (!e$x$tl) {
    e$x$opts$globe <- ls
  } else {
    e$x$opts$baseOption$globe <- ls
  }

  e
}