R/properties.R

In deckgl: An R Interface to 'deck.gl'

#' Create a getPosition data accessor
#'
#' Creates a JS method to retrieve the position of each object.
#'
#' @param latitude latitude property of data object
#' @param longitude longitude property of data object
#' @param coordinates coordinates property of data object
#'   (in this case \code{latitude} and \code{longitude} parameters are ignored)
#'
#' @return JavaScript code evaluated on the client-side
#'
#' @export
get_position <- function(latitude = NULL, longitude = NULL, coordinates = NULL) {
  coordinates_ <- is.null(coordinates) %>%
    ifelse(
      sprintf("[data.%s, data.%s]", longitude, latitude),
      sprintf("data.%s", coordinates)
    )
  sprintf("data => %s", coordinates_) %>% JS()
}

#' Create a data accessor
#'
#' Creates a JS method to retrieve a given property of each object.
#'
#' @param property_name property name of data object
#'
#' @return JavaScript code evaluated on the client-side
#'
#' @export
get_property <- function(property_name) {
  sprintf("data => data.%s", property_name) %>% JS()
}

#' Create a getColor data accessor
#'
#' Creates a JS method to retrieve the color of each object.
#' The method parses the HEX color property of the data object to an rgb color array.
#'
#' @param color_property property name of data object containing the HEX color
#'
#' @return JavaScript code evaluated on the client-side
#'
#' @export
get_color_to_rgb_array <- function(color_property) {
  sprintf("d => _deckWidget.convertColor(d.%s)", color_property) %>% JS()
}