File: viewer.Rd

package info (click to toggle)
r-cran-shiny 1.10.0%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 10,948 kB
  • sloc: javascript: 39,934; sh: 28; makefile: 20
file content (38 lines) | stat: -rw-r--r-- 1,362 bytes parent folder | download | duplicates (2)
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/viewer.R
\name{viewer}
\alias{viewer}
\alias{paneViewer}
\alias{dialogViewer}
\alias{browserViewer}
\title{Viewer options}
\usage{
paneViewer(minHeight = NULL)

dialogViewer(dialogName, width = 600, height = 600)

browserViewer(browser = getOption("browser"))
}
\arguments{
\item{minHeight}{The minimum height (in pixels) desired to show the gadget in
the viewer pane. If a positive number, resize the pane if necessary to show
at least that many pixels. If \code{NULL}, use the existing viewer pane
size. If \code{"maximize"}, use the maximum available vertical space.}

\item{dialogName}{The window title to display for the dialog.}

\item{width, height}{The desired dialog width/height, in pixels.}

\item{browser}{See \code{\link[utils:browseURL]{utils::browseURL()}}.}
}
\value{
A function that takes a single \code{url} parameter, suitable for
passing as the \code{viewer} argument of \code{\link[=runGadget]{runGadget()}}.
}
\description{
Use these functions to control where the gadget is displayed in RStudio (or
other R environments that emulate RStudio's viewer pane/dialog APIs). If
viewer APIs are not available in the current R environment, then the gadget
will be displayed in the system's default web browser (see
\code{\link[utils:browseURL]{utils::browseURL()}}).
}