protomapr/man/pmStyle.Rd

48 lines
1.3 KiB
Text
Raw Normal View History

2026-03-06 15:46:39 +11:00
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/styles.R
\name{pmStyle}
\alias{pmStyle}
\title{Get a preset map style}
\usage{
pmStyle(
name = c("minimal", "minimal-dark", "muted", "watercolor", "ink", "terrain", "transit")
)
}
\arguments{
\item{name}{Character. Name of the preset style. One of:
\describe{
\item{"minimal"}{Light gray land, light blue water, no labels}
\item{"minimal-dark"}{Dark land, dark blue water, no labels}
\item{"muted"}{Subtle colors, faint roads, major labels only}
\item{"watercolor"}{Soft, painterly aesthetic}
\item{"ink"}{Black lines on white, like a pen drawing}
\item{"terrain"}{Earthy tones with subtle elevation feel}
\item{"transit"}{Muted base with emphasized rail lines}
}}
}
\value{
A list with style components to pass to \code{\link{addProtomaps}}.
}
\description{
Returns a preset style configuration. Available presets provide common
styling patterns without manual configuration.
}
\examples{
\dontrun{
library(leaflet)
library(protomapr)
leaflet() \%>\%
setView(lng = -122.4, lat = 37.8, zoom = 10) \%>\%
addProtomaps(url = protomaps_url(), style = pmStyle("minimal"))
leaflet() \%>\%
setView(lng = -122.4, lat = 37.8, zoom = 10) \%>\%
addProtomaps(url = protomaps_url(), style = pmStyle("watercolor"))
}
}
\seealso{
\code{\link{pmMinimal}}, \code{\link{addProtomaps}}
}