-
Notifications
You must be signed in to change notification settings - Fork 633
/
Copy pathconfig.Rd
57 lines (41 loc) · 1.91 KB
/
config.Rd
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/plotly.R
\name{config}
\alias{config}
\title{Set the default configuration for plotly}
\usage{
config(p = last_plot(), staticPlot = F, workspace = F, editable = F,
autosizable = F, fillFrame = F, scrollZoom = F,
doubleClick = "reset+autosize", showTips = F, showLink = T,
sendData = T, linkText = "Edit chart", displayModeBar = "hover",
displaylogo = T, plot3dPixelRatio = 2, mathjax = FALSE)
}
\arguments{
\item{p}{a plotly object}
\item{staticPlot}{for export or image generation}
\item{workspace}{we're in the workspace, so need toolbar etc (TODO describe functionality instead)?}
\item{editable}{edit titles, move annotations, etc}
\item{autosizable}{respect layout.autosize=true and infer its container size?}
\item{fillFrame}{if we DO autosize, do we fill the container or the screen?}
\item{scrollZoom}{mousewheel or two-finger scroll zooms the plot}
\item{doubleClick}{double click interaction (false, 'reset', 'autosize' or 'reset+autosize')}
\item{showTips}{see some hints about interactivity}
\item{showLink}{link to open this plot in plotly}
\item{sendData}{if we show a link, does it contain data or just link to a plotly file?}
\item{linkText}{text appearing in the sendData link}
\item{displayModeBar}{display the modebar (T, F, or 'hover')}
\item{displaylogo}{add the plotly logo on the end of the modebar}
\item{plot3dPixelRatio}{increase the pixel ratio for 3D plot images}
\item{mathjax}{If \code{FALSE}, don't attempt to include mathjax.
If \code{'cdn'}, mathjax will be loaded externally (meaning an internet
connection is needed to view the graph). If \code{'local'}, a local copy
of mathjax will be included. For this to work, you'll need a local copy of
plotly.js and set the environment variable plotly_jsdir to its location on
your machine.}
}
\description{
Set the default configuration for plotly
}
\author{
Carson Sievert
}