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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/orca.R
\name{orca}
\alias{orca}
\alias{orca_serve}
\title{Static image exporting via orca}
\usage{
orca(
p,
file = "plot.png",
format = tools::file_ext(file),
scale = NULL,
width = NULL,
height = NULL,
mathjax = FALSE,
parallel_limit = NULL,
verbose = FALSE,
debug = FALSE,
safe = FALSE,
more_args = NULL,
...
)
orca_serve(
port = 5151,
mathjax = FALSE,
safe = FALSE,
request_limit = NULL,
keep_alive = TRUE,
window_max_number = NULL,
quiet = FALSE,
debug = FALSE,
more_args = NULL,
...
)
}
\arguments{
\item{p}{a plotly object.}
\item{file}{output filename.}
\item{format}{the output format (png, jpeg, webp, svg, pdf, eps).}
\item{scale}{Sets the image scale. Applies to all output images.}
\item{width}{Sets the image width. If not set, defaults to \code{layout.width} value.
Applies to all output images.}
\item{height}{Sets the image height. If not set, defaults to \code{layout.height} value.
Applies to all output images.}
\item{mathjax}{whether or not to include MathJax (required to render \link{TeX}).
If \code{TRUE}, the PLOTLY_MATHJAX_PATH environment variable must be set and point
to the location of MathJax (this variable is also used to render \link{TeX} in
interactive graphs, see \link{config}).}
\item{parallel_limit}{Sets the limit of parallel tasks run.}
\item{verbose}{Turn on verbose logging on stdout.}
\item{debug}{Starts app in debug mode and turn on verbose logs on stdout.}
\item{safe}{Turns on safe mode: where figures likely to make browser window
hang during image generating are skipped.}
\item{more_args}{additional arguments to pass along to system command. This is useful
for specifying display and/or electron options, such as \code{--enable-webgl} or \code{--disable-gpu}.}
\item{...}{for \code{orca()}, additional arguments passed along to \code{processx::run}. For
\code{orca_serve()}, additional arguments passed along to \code{processx::process}.}
\item{port}{Sets the server's port number.}
\item{request_limit}{Sets a request limit that makes orca exit when reached.}
\item{keep_alive}{Turn on keep alive mode where orca will (try to) relaunch server if process unexpectedly exits.}
\item{window_max_number}{Sets maximum number of browser windows the server can keep open at a given time.}
\item{quiet}{Suppress all logging info.}
}
\description{
Superseded by \code{\link[=kaleido]{kaleido()}}.
}
\section{Methods}{
The \code{orca_serve()} function returns an object with two methods:
\describe{
\item{\code{export(p, file = "plot.png", format = tools::file_ext(file), scale = NULL, width = NULL, height = NULL)}}{
Export a static image of a plotly graph. Arguments found here are the same as those found in \code{orca()}
}
\item{\code{close()}}{Close down the orca server and kill the underlying node process.}
}
}
\section{Fields}{
The \code{orca_serve()} function returns an object with two fields:
\describe{
\item{\code{port}}{The port number that the server is listening to.}
\item{\code{process}}{An R6 class for controlling and querying the underlying node process.}
}
}
\examples{
\dontshow{if (interactive() || !identical(.Platform$OS.type, "windows")) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf}
\dontrun{
# NOTE: in a headless environment, you may need to set `more_args="--enable-webgl"`
# to export webgl correctly
p <- plot_ly(z = ~volcano) \%>\% add_surface()
orca(p, "surface-plot.svg")
#' # launch the server
server <- orca_serve()
# export as many graphs as you'd like
server$export(qplot(1:10), "test1.pdf")
server$export(plot_ly(x = 1:10, y = 1:10), "test2.pdf")
# the underlying process is exposed as a field, so you
# have full control over the external process
server$process$is_alive()
# convenience method for closing down the server
server$close()
# remove the exported files from disk
unlink("test1.pdf")
unlink("test2.pdf")
}
\dontshow{\}) # examplesIf}
}
\author{
Carson Sievert
}
|
