init

man/pmColors.Rd

@@ -0,0 +1,96 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/colors.R
+\name{pmColors}
+\alias{pmColors}
+\title{Create custom color overrides}
+\usage{
+pmColors(
+  background = NULL,
+  earth = NULL,
+  water = NULL,
+  park = NULL,
+  wood = NULL,
+  hospital = NULL,
+  industrial = NULL,
+  school = NULL,
+  beach = NULL,
+  glacier = NULL,
+  highway = NULL,
+  major = NULL,
+  minor = NULL,
+  city_label = NULL,
+  state_label = NULL,
+  country_label = NULL,
+  ocean_label = NULL,
+  ...
+)
+}
+\arguments{
+\item{background}{Background color}
+
+\item{earth}{Land/earth color}
+
+\item{water}{Water color}
+
+\item{park}{Park/green space color (also called park_a or park_b)}
+
+\item{wood}{Forest/woodland color (also called wood_a or wood_b)}
+
+\item{hospital}{Hospital area color}
+
+\item{industrial}{Industrial area color}
+
+\item{school}{School/university area color}
+
+\item{beach}{Beach color}
+
+\item{glacier}{Glacier color}
+
+\item{highway}{Highway road color}
+
+\item{major}{Major road color}
+
+\item{minor}{Minor road color}
+
+\item{city_label}{City label color}
+
+\item{state_label}{State/region label color}
+
+\item{country_label}{Country label color}
+
+\item{ocean_label}{Ocean label color}
+
+\item{...}{Additional color properties}
+}
+\value{
+A list of color overrides to pass to \code{\link{addProtomaps}}.
+}
+\description{
+Creates a list of color overrides that can be applied to a built-in flavor.
+This is the recommended way to customize map colors while keeping the
+proper rendering rules (zoom handling, polygon simplification, etc.).
+}
+\examples{
+# Simple earth and water colors
+pmColors(earth = "#d3d3d3", water = "#1a3a5c")
+
+# Dark theme with custom colors
+pmColors(
+  background = "#1a1a2e",
+  earth = "#1a1a2e",
+  water = "#16213e",
+  park = "#1f4037",
+  highway = "#4a4a6a"
+)
+
+# Minimal grayscale
+pmColors(
+  background = "#ffffff",
+  earth = "#f5f5f5",
+  water = "#e0e0e0"
+)
+
+}
+\seealso{
+\code{\link{addProtomaps}}, \code{\link{protomaps_colors}}
+}