The R Project SVN R

Rev

Rev 59039 | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 59039 Rev 61433
Line 7... Line 7...
7 
\alias{grid.arrows}
 7 
\alias{grid.arrows}
8 
\alias{arrowsGrob}
 8 
\alias{arrowsGrob}
9 
\title{ Draw Arrows }
 9 
\title{ Draw Arrows }
10 
\description{
 10 
\description{
11 
  Functions to create and draw arrows at either end of a line, or at
 11 
  Functions to create and draw arrows at either end of a line, or at
12 
  either end of a
12 
  either end of a
13 
  line.to, lines, or segments grob.
 13 
  line.to, lines, or segments grob.
14 
 
 14 
 
15 
  These functions have been deprecated in favour of \code{arrow}
 15 
  These functions have been deprecated in favour of \code{arrow}
16 
  arguments to the line-related primitives.
 16 
  arguments to the line-related primitives.
17 
}
 17 
}
Line 30... Line 30...
30 
}
 30 
}
31 
\arguments{
 31 
\arguments{
32 
  \item{x}{A numeric vector or unit object specifying x-values.}
 32 
  \item{x}{A numeric vector or unit object specifying x-values.}
33 
  \item{y}{A numeric vector or unit object specifying y-values.}
 33 
  \item{y}{A numeric vector or unit object specifying y-values.}
34 
  \item{default.units}{A string indicating the default units to use
 34 
  \item{default.units}{A string indicating the default units to use
35 
    if \code{x} or \code{y} are only given as numeric vectors.}
35 
    if \code{x} or \code{y} are only given as numeric vectors.}
36 
  \item{grob}{ A grob to add arrows to;  currently can only be
 36 
  \item{grob}{ A grob to add arrows to;  currently can only be
37 
    a line.to, lines, or segments grob. }
 37 
    a line.to, lines, or segments grob. }
38 
  \item{angle}{ A numeric specifying (half) the width of the arrow head
 38 
  \item{angle}{ A numeric specifying (half) the width of the arrow head
39 
    (in degrees). }
 39 
    (in degrees). }
40 
  \item{length}{ A unit object specifying the length of the arrow head. }
 40 
  \item{length}{ A unit object specifying the length of the arrow head. }
Line 49... Line 49...
49 
  \item{draw}{A logical value indicating whether graphics output
 49 
  \item{draw}{A logical value indicating whether graphics output
50 
    should be produced.}
 50 
    should be produced.}
51 
  \item{vp}{A Grid viewport object (or NULL).}
 51 
  \item{vp}{A Grid viewport object (or NULL).}
52 
}
 52 
}
53 
\details{
 53 
\details{
54 
  Both functions create an arrows grob (a graphical object describing
54 
  Both functions create an arrows grob (a graphical object describing
55 
  arrows), but only \code{grid.arrows()}
 55 
  arrows), but only \code{grid.arrows()}
56 
  draws the arrows (and then only if \code{draw} is \code{TRUE}).
 56 
  draws the arrows (and then only if \code{draw} is \code{TRUE}).
57
57 
 
58 
  If the grob argument is specified, this overrides any x
 58 
  If the grob argument is specified, this overrides any x
59 
  and/or y arguments.
 59 
  and/or y arguments.
60 
}
 60 
}
61 
\value{
 61 
\value{
62 
  An arrows grob.  \code{grid.arrows()} returns the value invisibly.
 62 
  An arrows grob.  \code{grid.arrows()} returns the value invisibly.