Update documentation

parker00811 · Mar 17, 2015 · 30f9291 · 30f9291
1 parent 2400a44
commit 30f9291
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 5 deletions.
diff --git a/man/brushOpts.Rd b/man/brushOpts.Rd
@@ -1,12 +1,12 @@
 % Generated by roxygen2 (4.1.0): do not edit by hand
-% Please edit documentation in R/hover-brush-options.R
+% Please edit documentation in R/image-interact-opts.R
 \name{brushOpts}
 \alias{brushOpts}
 \title{Create an object representing brushing options}
 \usage{
 brushOpts(id = NULL, color = "#666", outline = "#000", opacity = 0.3,
   delay = 300, delayType = c("debounce", "throttle"), clip = TRUE,
-  direction = c("xy", "x", "y"))
+  direction = c("xy", "x", "y"), resetOnNew = FALSE)
 }
 \arguments{
 \item{id}{Input value name. For example, if the value is \code{"plot_brush"},
@@ -34,6 +34,12 @@ it is still inside the image.}
 \item{direction}{The direction for brushing. If \code{"xy"}, the brush can be
 drawn and moved in both x and y directions. If \code{"x"}, or \code{"y"},
 the brush wil work horizontally or vertically.}
+
+\item{resetOnNew}{When a new image is sent to the browser (via
+\code{\link{renderImage}}), should the brush be reset? The default,
+\code{FALSE}, is useful if you want to update the plot while keeping the
+brush. Using \code{TRUE} is useful if you want to clear the brush whenever
+the plot is updated.}
 }
 \description{
 This generates an object representing brushing options, to be passed as the

diff --git a/man/clickOpts.Rd b/man/clickOpts.Rd
@@ -1,5 +1,5 @@
 % Generated by roxygen2 (4.1.0): do not edit by hand
-% Please edit documentation in R/hover-brush-options.R
+% Please edit documentation in R/image-interact-opts.R
 \name{clickOpts}
 \alias{clickOpts}
 \title{Create an object representing click options}

diff --git a/man/dblclickOpts.Rd b/man/dblclickOpts.Rd
@@ -1,5 +1,5 @@
 % Generated by roxygen2 (4.1.0): do not edit by hand
-% Please edit documentation in R/hover-brush-options.R
+% Please edit documentation in R/image-interact-opts.R
 \name{dblclickOpts}
 \alias{dblclickOpts}
 \title{Create an object representing double-click options}

diff --git a/man/hoverOpts.Rd b/man/hoverOpts.Rd
@@ -1,5 +1,5 @@
 % Generated by roxygen2 (4.1.0): do not edit by hand
-% Please edit documentation in R/hover-brush-options.R
+% Please edit documentation in R/image-interact-opts.R
 \name{hoverOpts}
 \alias{hoverOpts}
 \title{Create an object representing hover options}