115 lines
5.9 KiB
R
115 lines
5.9 KiB
R
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/ufDashboardApplication.R
|
|
\name{UFDashboardApplication}
|
|
\alias{UFDashboardApplication}
|
|
\title{UserFrosting full dashboard R shiny application}
|
|
\value{
|
|
An R Shiny tagList for \link[shiny]{shinyApp}
|
|
}
|
|
\description{
|
|
UserFrosting full dashboard R shiny application
|
|
|
|
UserFrosting full dashboard R shiny application
|
|
}
|
|
\section{Super classes}{
|
|
\code{\link[AVSDevR.ShinyApplication:FrameApplication]{AVSDevR.ShinyApplication::FrameApplication}} -> \code{\link[AVSDevR.ShinyApplication:AdminLTEApplication]{AVSDevR.ShinyApplication::AdminLTEApplication}} -> \code{\link[AVSDevR.ShinyApplication:UFApplication]{AVSDevR.ShinyApplication::UFApplication}} -> \code{UFDashboardApplication}
|
|
}
|
|
\section{Methods}{
|
|
\subsection{Public methods}{
|
|
\itemize{
|
|
\item \href{#method-UFDashboardApplication-withSidebarCollapsed}{\code{UFDashboardApplication$withSidebarCollapsed()}}
|
|
\item \href{#method-UFDashboardApplication-ui}{\code{UFDashboardApplication$ui()}}
|
|
\item \href{#method-UFDashboardApplication-server}{\code{UFDashboardApplication$server()}}
|
|
\item \href{#method-UFDashboardApplication-clone}{\code{UFDashboardApplication$clone()}}
|
|
}
|
|
}
|
|
\if{html}{\out{
|
|
<details><summary>Inherited methods</summary>
|
|
<ul>
|
|
<li><span class="pkg-link" data-pkg="AVSDevR.ShinyApplication" data-topic="FrameApplication" data-id="getSessionDBClient"><a href='../../AVSDevR.ShinyApplication/html/FrameApplication.html#method-FrameApplication-getSessionDBClient'><code>AVSDevR.ShinyApplication::FrameApplication$getSessionDBClient()</code></a></span></li>
|
|
<li><span class="pkg-link" data-pkg="AVSDevR.ShinyApplication" data-topic="FrameApplication" data-id="initialize"><a href='../../AVSDevR.ShinyApplication/html/FrameApplication.html#method-FrameApplication-initialize'><code>AVSDevR.ShinyApplication::FrameApplication$initialize()</code></a></span></li>
|
|
<li><span class="pkg-link" data-pkg="AVSDevR.ShinyApplication" data-topic="FrameApplication" data-id="withBootstrap4Shim"><a href='../../AVSDevR.ShinyApplication/html/FrameApplication.html#method-FrameApplication-withBootstrap4Shim'><code>AVSDevR.ShinyApplication::FrameApplication$withBootstrap4Shim()</code></a></span></li>
|
|
<li><span class="pkg-link" data-pkg="AVSDevR.ShinyApplication" data-topic="FrameApplication" data-id="withSessionLogger"><a href='../../AVSDevR.ShinyApplication/html/FrameApplication.html#method-FrameApplication-withSessionLogger'><code>AVSDevR.ShinyApplication::FrameApplication$withSessionLogger()</code></a></span></li>
|
|
<li><span class="pkg-link" data-pkg="AVSDevR.ShinyApplication" data-topic="AdminLTEApplication" data-id="frameUI"><a href='../../AVSDevR.ShinyApplication/html/AdminLTEApplication.html#method-AdminLTEApplication-frameUI'><code>AVSDevR.ShinyApplication::AdminLTEApplication$frameUI()</code></a></span></li>
|
|
<li><span class="pkg-link" data-pkg="AVSDevR.ShinyApplication" data-topic="AdminLTEApplication" data-id="withSkin"><a href='../../AVSDevR.ShinyApplication/html/AdminLTEApplication.html#method-AdminLTEApplication-withSkin'><code>AVSDevR.ShinyApplication::AdminLTEApplication$withSkin()</code></a></span></li>
|
|
<li><span class="pkg-link" data-pkg="AVSDevR.ShinyApplication" data-topic="UFApplication" data-id="app"><a href='../../AVSDevR.ShinyApplication/html/UFApplication.html#method-UFApplication-app'><code>AVSDevR.ShinyApplication::UFApplication$app()</code></a></span></li>
|
|
<li><span class="pkg-link" data-pkg="AVSDevR.ShinyApplication" data-topic="UFApplication" data-id="configureUF"><a href='../../AVSDevR.ShinyApplication/html/UFApplication.html#method-UFApplication-configureUF'><code>AVSDevR.ShinyApplication::UFApplication$configureUF()</code></a></span></li>
|
|
</ul>
|
|
</details>
|
|
}}
|
|
\if{html}{\out{<hr>}}
|
|
\if{html}{\out{<a id="method-UFDashboardApplication-withSidebarCollapsed"></a>}}
|
|
\if{latex}{\out{\hypertarget{method-UFDashboardApplication-withSidebarCollapsed}{}}}
|
|
\subsection{Method \code{withSidebarCollapsed()}}{
|
|
Starts the application with the UserFrosting sidebar
|
|
collapsed by default
|
|
\subsection{Usage}{
|
|
\if{html}{\out{<div class="r">}}\preformatted{UFDashboardApplication$withSidebarCollapsed()}\if{html}{\out{</div>}}
|
|
}
|
|
|
|
}
|
|
\if{html}{\out{<hr>}}
|
|
\if{html}{\out{<a id="method-UFDashboardApplication-ui"></a>}}
|
|
\if{latex}{\out{\hypertarget{method-UFDashboardApplication-ui}{}}}
|
|
\subsection{Method \code{ui()}}{
|
|
Creates the UserFrosting UI component for an R Shiny
|
|
application
|
|
\subsection{Usage}{
|
|
\if{html}{\out{<div class="r">}}\preformatted{UFDashboardApplication$ui()}\if{html}{\out{</div>}}
|
|
}
|
|
|
|
}
|
|
\if{html}{\out{<hr>}}
|
|
\if{html}{\out{<a id="method-UFDashboardApplication-server"></a>}}
|
|
\if{latex}{\out{\hypertarget{method-UFDashboardApplication-server}{}}}
|
|
\subsection{Method \code{server()}}{
|
|
Creates the UserFrosting server component for an R Shiny
|
|
application
|
|
\subsection{Usage}{
|
|
\if{html}{\out{<div class="r">}}\preformatted{UFDashboardApplication$server(
|
|
input,
|
|
output,
|
|
session,
|
|
ufApi = NULL,
|
|
ufUser = NULL,
|
|
...
|
|
)}\if{html}{\out{</div>}}
|
|
}
|
|
|
|
\subsection{Arguments}{
|
|
\if{html}{\out{<div class="arguments">}}
|
|
\describe{
|
|
\item{\code{input}}{The UI inputs bound for the session}
|
|
|
|
\item{\code{output}}{The UI outputs bound for the session}
|
|
|
|
\item{\code{session}}{The current session}
|
|
|
|
\item{\code{ufApi}}{The UserFrosting API instance}
|
|
|
|
\item{\code{ufUser}}{The UserFrosting user if authenticated and verified}
|
|
|
|
\item{\code{...}}{Parameters passed into the inner application}
|
|
}
|
|
\if{html}{\out{</div>}}
|
|
}
|
|
}
|
|
\if{html}{\out{<hr>}}
|
|
\if{html}{\out{<a id="method-UFDashboardApplication-clone"></a>}}
|
|
\if{latex}{\out{\hypertarget{method-UFDashboardApplication-clone}{}}}
|
|
\subsection{Method \code{clone()}}{
|
|
The objects of this class are cloneable with this method.
|
|
\subsection{Usage}{
|
|
\if{html}{\out{<div class="r">}}\preformatted{UFDashboardApplication$clone(deep = FALSE)}\if{html}{\out{</div>}}
|
|
}
|
|
|
|
\subsection{Arguments}{
|
|
\if{html}{\out{<div class="arguments">}}
|
|
\describe{
|
|
\item{\code{deep}}{Whether to make a deep clone.}
|
|
}
|
|
\if{html}{\out{</div>}}
|
|
}
|
|
}
|
|
}
|