1% File src/library/grDevices/man/pdf.options.Rd
2% Part of the R package, https://www.R-project.org
3% Copyright 1995-2011 R Core Team
4% Distributed under GPL 2 or later
5
6\name{windows.options}
7\alias{windows.options}
8\title{Auxiliary Function to Set/View Defaults for Arguments of windows()}
9\description{
10  The auxiliary function \code{windows.options} can be used to set or view
11  (if called without arguments) the default values for the arguments of
12  \code{\link{windows}}.
13
14  \code{windows.options} needs to be called before calling \code{windows},
15  and the default values it sets can be overridden by supplying
16  arguments to \code{windows}.
17  }
18\usage{
19windows.options(\dots, reset = FALSE)
20}
21\arguments{
22  \item{\dots}{arguments \code{width}, \code{height}, \code{pointsize},
23    \code{record}, \code{rescale}, \code{xpinch}, \code{ypinch},
24    \code{bg}, \code{canvas}, \code{gamma}, \code{xpos}, \code{ypos},
25    \code{buffered}, \code{restoreConsole}, \code{clickToConfirm},
26    \code{title}, \code{fillOddEven} and \code{antialias} can be supplied.}
27  \item{reset}{logical: should the defaults be reset to their
28    \sQuote{factory-fresh} values?}
29}
30\details{
31  If both \code{reset = TRUE} and \code{...} are supplied the defaults
32  are first reset to the \sQuote{factory-fresh} values and then the new
33  values are applied.
34
35  Option \code{antialias} applies to screen devices (\code{windows},
36  \code{win.graph}, \code{X11} and \code{x11}).  There is a separate option,
37  \code{bitmap.aa.win}, for bitmap devices with \code{type = "windows"}.
38}
39\value{
40  A named list of all the defaults.  If any arguments are supplied the
41  returned values are the old values and the result has the visibility
42  flag turned off.
43}
44\seealso{
45  \code{\link{windows}}, \code{\link{ps.options}}.
46}
47\examples{\dontrun{
48## put something like this is your .Rprofile to customize the defaults
49setHook(packageEvent("grDevices", "onLoad"),
50        function(...)
51            grDevices::windows.options(width = 8, height = 6,
52                                       xpos = 0, pointsize = 10,
53                                       bitmap.aa.win = "cleartype"))
54}}
55\keyword{device}
56