protomapr/man/pmMinimal.Rd
2026-03-06 15:46:39 +11:00

52 lines
1.3 KiB
R

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/styles.R
\name{pmMinimal}
\alias{pmMinimal}
\title{Create a minimal basemap style}
\usage{
pmMinimal(
land = "#f8f8f8",
water = "#e0e8f0",
labels = FALSE,
label_color = "#666666"
)
}
\arguments{
\item{land}{Character. Color for all land features. Default is "#f8f8f8".}
\item{water}{Character. Color for water features. Default is "#e0e8f0".}
\item{labels}{Logical. Whether to show city labels. Default is FALSE.}
\item{label_color}{Character. Color for labels if shown. Default is "#666666".}
}
\value{
A list with \code{colors} and \code{labelRules} components to pass to
\code{\link{addProtomaps}}.
}
\description{
Creates a minimal style with uniform land color, hiding roads, buildings,
and most labels. Ideal for data visualization overlays.
}
\examples{
\dontrun{
library(leaflet)
library(protomapr)
# Ultra-minimal basemap
style <- pmMinimal()
leaflet() \%>\%
setView(lng = -122.4, lat = 37.8, zoom = 10) \%>\%
addProtomaps(url = protomaps_url(), style = style)
# Custom colors with major city labels
style <- pmMinimal(land = "#f5f5f0", water = "#1a3a5c", labels = TRUE)
leaflet() \%>\%
setView(lng = -122.4, lat = 37.8, zoom = 8) \%>\%
addProtomaps(url = protomaps_url(), style = style)
}
}
\seealso{
\code{\link{pmStyle}}, \code{\link{addProtomaps}}
}