1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
|
\name{chartTheme}
\alias{chartTheme}
\alias{.chart.theme}
\title{ Create A Chart Theme }
\description{
Create a chart.theme object for use within chartSeries
to manage desired chart colors.
}
\usage{
chartTheme(theme = "black", ...)
}
%- maybe also 'usage' for other objects documented here.
\arguments{
\item{theme}{ name of base theme }
\item{\dots}{ name=value pairs to modify }
}
\details{
Used as an argument to the chartSeries family of functions,
\code{chartTheme} allows for on-the-fly modification
of pre-specified chart \sQuote{themes}. Users can modify
a pre-built theme in-place, or copy the theme to a new
variable for use in subsequent charting calls.
Internally a chart.theme object is nothing more than
a list of values organized by chart components. The primary
purpose of this is to facilitate minor modification on
the fly, as well as provide a template for larger changes.
Setting style arguments for TA calls via chartTheme requires
the user to pass the styles as name=value pairs with a name
containing the TA call in question. See examples for assistance.
Current components that may be modified with appropriate
values:
\itemize{
\item \code{fg.col}: foreground color
\item \code{bg.col}: background color
\item \code{grid.col}: grid color
\item \code{border}: border color
\item \code{minor.tick}: minor tickmark color
\item \code{major.tick}: major tickmark color
\item \code{up.col}: up bar/candle color
\item \code{dn.col}: down bar/candle color
\item \code{up.up.col}: up after up bar/candle color
\item \code{up.dn.col}: up after down bar/candle color
\item \code{dn.dn.col}: down after down bar/candle color
\item \code{dn.up.col}: down after up bar/candle color
\item \code{up.border}: up bar/candle border color
\item \code{dn.border}: down bar/candle border color
\item \code{up.up.border}: up after up bar/candle border color
\item \code{up.dn.border}: up after down bar/candle border color
\item \code{dn.dn.border}: down after down bar/candle border color
\item \code{dn.up.border}: down after up bar/candle border color
}
}
\value{
A chart.theme object
}
\author{ Jeffrey A. Ryan }
\seealso{ \code{\link{chartSeries}} }
\examples{
chartTheme()
chartTheme('white')
chartTheme('white',up.col='blue',dn.col='red')
# A TA example
chartTheme(addRSI.col='red')
str(chartTheme())
}
\keyword{ utilities }
|