R/controls.R

Defines functions clearControls removeControl addControl

Documented in addControl clearControls removeControl

#' @param html the content of the control. May be provided as string or as HTML
#'   generated with Shiny/htmltools tags
#' @param position position of control: "topleft", "topright", "bottomleft", or
#'   "bottomright"
#' @param className extra CSS classes to append to the control, space separated
#'
#' @describeIn map-layers Add arbitrary HTML controls to the map
#' @export
addControl <- function(
  map, html, position = c("topleft", "topright", "bottomleft", "bottomright"),
  layerId = NULL, className = "info legend", data = getMapData(map)
) {

    position <- match.arg(position)

    deps <- htmltools::resolveDependencies(htmltools::findDependencies(html))
    html <- as.character(html)

    map$dependencies <- c(map$dependencies, deps)
    invokeMethod(map, data, "addControl", html, position, layerId, className)
}

#' @export
#' @rdname remove
removeControl <- function(map, layerId) {
    invokeMethod(map, NULL, "removeControl", layerId)
}

#' @export
#' @rdname remove
clearControls <- function(map) {
    invokeMethod(map, NULL, "clearControls")
}

Try the leaflet package in your browser

Any scripts or data that you put into this service are public.

leaflet documentation built on May 29, 2024, 1:19 a.m.