R/layers_hexagon-layer.R

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

#' Add a hexagon layer to the deckgl widget
#'
#' The \code{HexagonLayer} renders a hexagon heatmap based on an array of points. It takes the radius of hexagon bin, projects points into hexagon bins.
#' The color and height of the hexagon is scaled by number of points it contains.
#'
#' @inheritParams add_layer
#' @seealso \url{https://deck.gl/#/documentation/deckgl-api-reference/layers/hexagon-layer}
#' @example inst/examples/deckgl-api-reference/hexagon-layer.R
#' @export
add_hexagon_layer <- function(deckgl, data = NULL, properties = list(), ..., id = "hexagon-layer") {
  add_layer(deckgl, "HexagonLayer", data, properties, ..., id = id)
}