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

72 lines
1.9 KiB
R

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/colors.R
\name{protomaps_colors}
\alias{protomaps_colors}
\title{Protomaps Color Properties Reference}
\description{
Reference documentation for all available color properties that can be
customized using \code{\link{pmColors}}.
}
\section{Base Colors}{
\describe{
\item{\code{background}}{Map background color}
\item{\code{earth}}{Land/terrain color}
\item{\code{water}}{Water bodies color}
}
}
\section{Land Use Colors}{
\describe{
\item{\code{park_a}, \code{park_b}}{Park colors (use \code{park} in pmColors)}
\item{\code{wood_a}, \code{wood_b}}{Forest/woodland colors (use \code{wood} in pmColors)}
\item{\code{hospital}}{Hospital areas}
\item{\code{industrial}}{Industrial zones}
\item{\code{school}}{Schools and universities}
\item{\code{beach}}{Beach areas}
\item{\code{zoo}}{Zoo areas}
\item{\code{aerodrome}}{Airport areas}
\item{\code{glacier}}{Glacier areas}
}
}
\section{Road Colors}{
\describe{
\item{\code{highway}}{Highway/motorway color}
\item{\code{major}}{Major road color}
\item{\code{minor_a}, \code{minor_b}}{Minor road colors (use \code{minor} in pmColors)}
\item{\code{railway}}{Railway lines}
\item{\code{pier}}{Pier/dock structures}
}
}
\section{Label Colors}{
\describe{
\item{\code{city_label}}{City name labels}
\item{\code{state_label}}{State/region labels}
\item{\code{country_label}}{Country name labels}
\item{\code{ocean_label}}{Ocean/sea labels}
\item{\code{roads_label_major}}{Major road name labels}
\item{\code{roads_label_minor}}{Minor road name labels}
}
}
\section{Landcover Colors (optional object)}{
These are specified as a nested object:
\describe{
\item{\code{grassland}}{Grassland areas}
\item{\code{barren}}{Barren land}
\item{\code{urban_area}}{Urban zones}
\item{\code{farmland}}{Agricultural areas}
\item{\code{forest}}{Forest areas}
\item{\code{scrub}}{Scrubland}
}
}
\seealso{
\code{\link{pmColors}}, \code{\link{addProtomaps}}
}