File: newFigure.Rd

package info (click to toggle)
r-cran-nozzle.r1 1.1-1%2Bdfsg-4
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 796 kB
  • sloc: javascript: 553; makefile: 12
file content (38 lines) | stat: -rw-r--r-- 940 bytes parent folder | download | duplicates (3)
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
\name{newFigure}
\alias{newFigure}
\title{Create a new list element.}
\usage{
  newFigure(file, ..., fileHighRes = NA,
    type = IMAGE.TYPE.RASTER, exportId = NULL,
    protection = PROTECTION.PUBLIC)
}
\arguments{
  \item{file}{Path or URL to the image file. Paths can be
  absolute or relative.}

  \item{...}{Strings that will be concatenated to form the
  figure caption.}

  \item{fileHighRes}{Path or URL to a high-resolution or
  vector-based version of the image file. Paths can be
  absolute or relative.}

  \item{type}{Currenlty only IMAGE.TYPE.RASTER is allowed.}

  \item{exportId}{Unique string to identify this element.
  Used to retrieve the element using
  \code{getExportedElement}.}

  \item{protection}{Procection level. One of
  PROTECTION.PUBLIC, PROTECTION.GROUP, PROTECTION.PRIVATE.}
}
\value{
  New element.
}
\description{
  Create a new list element.
}
\author{
  Nils Gehlenborg \email{nils@hms.harvard.edu}
}