R/pm.R

In leafpm: Leaflet Map Plugin for Drawing and Editing

#' Add 'leaflet-pm' Toolbar to a Leaflet 'htmlwidget'
#'
#' @param map \code{leaflet} map htmlwidget to which the toolbar should be added
#' @param targetLayerId \code{string} id of the feature to edit
#' @param targetGroup \code{string} name of the group to edit
#' @param toolbarOptions \code{\link{pmToolbarOptions}}
#' @param drawOptions \code{\link{pmDrawOptions}}
#' @param editOptions \code{\link{pmEditOptions}}
#' @param cutOptions \code{\link{pmCutOptions}}
#'
#' @return \code{leaflet} htmlwidget
#'
#' @example inst/examples/examples_roxygen.R
#' @export
addPmToolbar <- function(
  map = NULL,
  targetLayerId = NULL,
  targetGroup = NULL,
  toolbarOptions = pmToolbarOptions(),
  drawOptions = pmDrawOptions(),
  editOptions = pmEditOptions(),
  cutOptions = pmCutOptions()
) {
  if(is.null(map)) {
    stop("Please add required map argument.  This should be a leaflet htmlwidget.")
  }

  map$dependencies <- c(map$dependencies, pmDependencies())

  leaflet::invokeMethod(
    map,
    leaflet::getMapData(map),
    "addPmToolbar",
    targetLayerId,
    targetGroup,
    list(
      toolbarOptions = toolbarOptions,
      drawOptions = drawOptions,
      editOptions = editOptions,
      cutOptions = cutOptions
    )
  )
}

#' Removes the 'leaflet.pm' toolbar
#' @param map \code{leaflet} map htmlwidget from which the toolbar should be removed
#' @param clearFeatures whether to clear the map of drawn features. currently not working
#' @return \code{leaflet} htmlwidget
#'
#' @export
removePmToolbar <- function(map, clearFeatures = FALSE) {
  leaflet::invokeMethod(map, leaflet::getMapData(map), "removePmToolbar", clearFeatures)
}