Files
shiny/man/configureBookmarking.Rd
2016-06-27 08:02:03 -07:00

30 lines
968 B
R

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/save-state.R
\name{configureBookmarking}
\alias{configureBookmarking}
\title{Configure bookmarking for the current session}
\usage{
configureBookmarking(eventExpr, type = c("save", "encode", "disable"),
exclude = NULL, onSave = NULL, onRestore = NULL, onBookmarked = NULL,
session = getDefaultReactiveDomain())
}
\arguments{
\item{eventExpr}{An expression to listen for, similar to
\code{\link{observeEvent}}.}
\item{type}{Either \code{"save"}, which saves to disk, \code{"encode"}, which
encodes all of the relevant values in a URL, or \code{"disable"}, which
disables any previously-enabled bookmarking.}
\item{exclude}{Input values to exclude from bookmarking.}
\item{onBookmarked}{A callback function to invoke after the bookmarking has
been done.}
\item{session}{A Shiny session object.}
}
\description{
There are two types of bookmarking: saving state, and encoding state.
}