forked from no-types/RagGrid
-
Notifications
You must be signed in to change notification settings - Fork 0
/
aggrid.Rd
45 lines (34 loc) · 1.49 KB
/
aggrid.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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/RagGrid.R
\name{aggrid}
\alias{aggrid}
\title{Create a HTML widget using the ag-grid library}
\usage{
aggrid(data, options = list(), colOpts = list(),
formattingOptions = list(), sparkLineOptions = list(),
theme = "ag-theme-balham", filterOnSelect = TRUE, licenseKey = NULL,
width = NULL, height = NULL, elementId = NULL)
}
\arguments{
\item{data}{a dataobject (either a matrix or a dataframe)}
\item{options}{a list of ag-grid grid options (see
\url{https://www.ag-grid.com/javascript-grid-properties/});}
\item{colOpts}{a list of ag-grid column options (see
\url{https://www.ag-grid.com/javascript-grid-column-definitions/});}
\item{formattingOptions}{a list of ag-grid column formatting options (see
\url{http://numeraljs.com/#format}) Also see \code{\link{formatColumns}()};}
\item{sparkLineOptions}{options for rendering sparkline in the table}
\item{theme}{a theme class name that need to be applied for grid (see
\url{https://www.ag-grid.com/javascript-grid-styling//});}
\item{filterOnSelect}{specify whether filter is need to be perfromed on selecting a row item}
\item{licenseKey}{if you wish to use the enterprise version of ag-grid}
\item{width, height}{Width/Height in pixels (optional, defaults to automatic
sizing)}
\item{elementId}{An id for the widget (a random string by default).}
}
\description{
This function creates a HTML widget to display matrix or a dataframe using ag-grid.
}
\examples{
aggrid(iris)
}