The R Project SVN R

Rev

Rev 68948 | Go to most recent revision | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 68948 Rev 74460
Line 1... Line 1...
1 
% File src/library/graphics/man/screen.Rd
 1 
% File src/library/graphics/man/screen.Rd
2 
% Part of the R package, https://www.R-project.org
 2 
% Part of the R package, https://www.R-project.org
3 
% Copyright 1995-2014 R Core Team
 3 
% Copyright 1995-2018 R Core Team
4 
% Distributed under GPL 2 or later
 4 
% Distributed under GPL 2 or later
5 
 
 5 
 
6 
\name{screen}
 6 
\name{screen}
7 
\title{Creating and Controlling Multiple Screens on a Single Device}
 7 
\title{Creating and Controlling Multiple Screens on a Single Device}
8 
\usage{
 8 
\usage{
Line 14... Line 14...
14 
\alias{screen}
 14 
\alias{screen}
15 
\alias{split.screen}
 15 
\alias{split.screen}
16 
\alias{erase.screen}
 16 
\alias{erase.screen}
17 
\alias{close.screen}
 17 
\alias{close.screen}
18 
\arguments{
 18 
\arguments{
19 
  \item{figs}{A two-element vector describing the number of rows and the
 19 
  \item{figs}{a two-element vector describing the number of rows and the
20 
    number of columns in a screen matrix \emph{or} a matrix with 4 columns.
 20 
    number of columns in a screen matrix \emph{or} a matrix with 4 columns.
21 
    If a matrix, then each row describes a screen with values for the left,
 21 
    If a matrix, then each row describes a screen with values for the left,
22 
    right, bottom, and top of the screen (in that order) in NDC units,
 22 
    right, bottom, and top of the screen (in that order) in NDC units,
23 
    that is 0 at the lower left corner of the device surface, and 1 at
 23 
    that is 0 at the lower left corner of the device surface, and 1 at
24 
    the upper right corner.}
 24 
    the upper right corner.}
25 
  \item{screen}{A number giving the screen to be split.  It defaults to
 25 
  \item{screen}{a number giving the screen to be split.  It defaults to
26 
    the current screen if there is one, otherwise the whole device region.}
 26 
    the current screen if there is one, otherwise the whole device region.}
27 
  \item{erase}{logical: should be selected screen be cleared?}
 27 
  \item{erase}{logical: should the selected screen be cleared?}
28 
  \item{n}{A number indicating which screen to prepare for drawing
 28 
  \item{n}{a number indicating which screen to prepare for drawing
29 
    (\code{screen}), erase (\code{erase.screen}), or close
 29 
    (\code{screen}), erase (\code{erase.screen}), or close
30 
    (\code{close.screen}).  (\code{close.screen} will accept a vector of
 30 
    (\code{close.screen}).  (\code{close.screen} will accept a vector of
31 
    screen numbers.)}
 31 
    screen numbers.)}
32 
  \item{new}{A logical value indicating whether the screen should be
 32 
  \item{new}{logical value indicating whether the screen should be
33 
    erased as part of the preparation for drawing in the screen.}
 33 
    erased as part of the preparation for drawing in the screen.}
34 
  \item{all.screens}{A logical value indicating whether all of the
 34 
  \item{all.screens}{logical value indicating whether all of the
35 
    screens should be closed.}
 35 
    screens should be closed.}
36 
}
 36 
}
37 
\description{
 37 
\description{
38 
  \code{split.screen} defines a number of regions within the current
 38 
  \code{split.screen} defines a number of regions within the current
39 
  device which can, to some extent, be treated as separate graphics
 39 
  device which can, to some extent, be treated as separate graphics
Line 58... Line 58...
58 
  If the current screen is closed, \code{close.screen} sets the current
 58 
  If the current screen is closed, \code{close.screen} sets the current
59 
  screen to be the next larger screen number if there is one, otherwise
 59 
  screen to be the next larger screen number if there is one, otherwise
60 
  to the first available screen.
 60 
  to the first available screen.
61 
}
 61 
}
62 
\value{
 62 
\value{
63 
  \code{split.screen} returns a vector of screen numbers for the
 63 
  \code{split.screen(*)} returns a vector of screen numbers for the
64 
  newly-created screens.  With no arguments, \code{split.screen} returns
 64 
  newly-created screens.  With no arguments, \code{split.screen()}
65 
  a vector of valid screen numbers.
 65 
  returns a vector of valid screen numbers.
66 
 
 66 
 
67 
  \code{screen} invisibly returns the number of the selected screen.
 67 
  \code{screen(n)} invisibly returns \code{n}, the number of the
68 
  With no arguments, \code{screen} returns the number of the current
 68 
  selected screen. With no arguments, \code{screen()} returns the number
69 
  screen.
 69 
  of the current screen.
70 
 
 70 
 
71 
  \code{close.screen} returns a vector of valid screen numbers.
 71 
  \code{close.screen()} returns a vector of valid screen numbers.
72 
 
 72 
 
73 
  \code{screen}, \code{erase.screen}, and \code{close.screen} all return
 73 
  \code{screen}, \code{erase.screen}, and \code{close.screen} all return
74 
  \code{FALSE} if \R is not in split-screen mode.
 74 
  \code{FALSE} if \R is not in split-screen mode.
75 
}
 75 
}
76 
 
 76