addMeasure.Rd

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/plugin-measure.R
\name{addMeasure}
\alias{addMeasure}
\title{Add a measure control to the map.}
\usage{
addMeasure(
  map,
  position = "topright",
  primaryLengthUnit = "feet",
  secondaryLengthUnit = NULL,
  primaryAreaUnit = "acres",
  secondaryAreaUnit = NULL,
  activeColor = "#ABE67E",
  completedColor = "#C8F2BE",
  popupOptions = list(className = "leaflet-measure-resultpopup", autoPanPadding = c(10,
    10)),
  captureZIndex = 10000,
  localization = "en",
  decPoint = ".",
  thousandsSep = ","
)
}
\arguments{
\item{map}{a map widget object}

\item{position}{standard \href{https://web.archive.org/web/20220702182250/https://leafletjs.com/reference-1.3.4.html#control-positions}{Leaflet control position options}.}

\item{primaryLengthUnit, secondaryLengthUnit}{units used to display length
results. secondaryLengthUnit is optional.
Valid values are \code{"feet"}, \code{"meters"}, \code{"miles"}, and \code{"kilometers"}.}

\item{primaryAreaUnit, secondaryAreaUnit}{units used to display area results.
secondaryAreaUnit is optional.  Valid values are
\code{"acres"}, \code{"hectares"}, \code{"sqmeters"}, and \code{"sqmiles"}.}

\item{activeColor}{base color to use for map features rendered while
actively performing a measurement.
Value should be a color represented as a hexadecimal string.}

\item{completedColor}{base color to use for features generated
from a completed measurement.
Value should be a color represented as a hexadecimal string.}

\item{popupOptions}{\code{list} of options applied to the popup
of the resulting measure feature.
Properties may be any \href{https://web.archive.org/web/20220702182250/https://leafletjs.com/reference-1.3.4.html#popup-option}{standard Leaflet popup options}.}

\item{captureZIndex}{Z-index of the marker used to capture measure clicks.
Set this value higher than the z-index of all other map layers to
disable click events on other layers while a measurement is active.}

\item{localization}{Locale to translate displayed text.
Available locales include en (default), cn, de, es, fr, it, nl, pt,
pt_BR, pt_PT, ru, and tr}

\item{decPoint}{Decimal point used when displaying measurements.
If not specified, values are defined by the localization.}

\item{thousandsSep}{Thousands separator used when displaying measurements.
If not specified, values are defined by the localization.}
}
\value{
modified map
}
\description{
Add a measure control to the map.
}
\examples{
leaf <- leaflet() \%>\%
  addTiles() \%>\%
  # central park
  fitBounds( -73.9, 40.75, -73.95, 40.8 ) \%>\%
  addMeasure()

leaf

# customizing
leaf \%>\% addMeasure(
  position = "bottomleft",
  primaryLengthUnit = "meters",
  primaryAreaUnit = "sqmeters",
  activeColor = "#3D535D",
  completedColor = "#7D4479",
  localization = "de"
)

}