% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/tmapOnLoad.R, R/tmap_providers.R
\name{.tmap_providers}
\alias{.tmap_providers}
\alias{tmap_provider_credits}
\alias{tmap_providers}
\title{Get basemap tile providers}
\usage{
.tmap_providers

tmap_provider_credits(provider)

tmap_providers(mode, credits = FALSE, as.list = credits)
}
\arguments{
\item{provider}{provider name}

\item{mode}{mode. If not specified the current active mode is used.}

\item{credits}{If \code{TRUE} the credit (attribution) text is returned.
If \code{FALSE} (default) the provider name.}

\item{as.list}{Should the output be returned as a list where names are
provider names? By default \code{TRUE} when \code{credits} is also
\code{TRUE}.}
}
\value{
\code{tmap_providers()} returns a list or vector (see
\code{as.list}) of provider names or credits.
\code{tmap_provider_credits()} returns the attribution text for the
specified provider. \code{.tmap_providers} is an environment; see
Details.
}
\description{
Get basemap tile providers and their credits (attribution text).
\code{tmap_providers()} returns a list or vector of provider names or
credits. \code{tmap_provider_credits()} returns the attribution text for a
specific provider.
}
\details{
\code{.tmap_providers} is an environment populated with all available
provider names as named entries. Its primary purpose is to enable
autocomplete in IDEs such as RStudio: typing \code{.tmap_providers$} in the
console or a script triggers a dropdown list of all available providers,
making it easy to discover and select provider names without consulting the
documentation. It is not intended to be called as a function.
}
\examples{
# List all providers for the current mode
tmap_providers()

# Use IDE autocomplete to discover providers interactively:
# type .tmap_providers$ in the RStudio console
}
