Title: | A Wrapper of the 'JavaScript' Library 'agGrid' |
---|---|
Description: | Data objects in 'R' can be rendered as 'HTML' tables using the 'JavaScript' library 'ag-grid' (typically via 'R Markdown' or 'Shiny'). The 'ag-grid' library has been included in this 'R' package. The package name 'RagGrid' is an abbreviation of 'R agGrid'. |
Authors: | Srikkanth M [aut, cre], Praveen N [aut, ctb] |
Maintainer: | Srikkanth M <[email protected]> |
License: | MIT + file LICENSE |
Version: | 0.2.0 |
Built: | 2024-11-12 05:26:45 UTC |
Source: | https://github.com/no-types/raggrid |
This function creates a HTML widget to display matrix or a dataframe using ag-grid.
aggrid(data, options = list(), colOpts = list(), formattingOptions = list(), sparkLineOptions = list(), theme = "ag-theme-balham", filterOnSelect = TRUE, licenseKey = NULL, width = NULL, height = NULL, elementId = NULL)
aggrid(data, options = list(), colOpts = list(), formattingOptions = list(), sparkLineOptions = list(), theme = "ag-theme-balham", filterOnSelect = TRUE, licenseKey = NULL, width = NULL, height = NULL, elementId = NULL)
data |
a dataobject (either a matrix or a dataframe) |
options |
a list of ag-grid grid options (see https://www.ag-grid.com/javascript-grid-properties/); |
colOpts |
a list of ag-grid column options (see https://www.ag-grid.com/javascript-grid-column-definitions/); |
formattingOptions |
a list of ag-grid column formatting options (see
http://numeraljs.com/#format) Also see |
sparkLineOptions |
options for rendering sparkline in the table |
theme |
a theme class name that need to be applied for grid (see https://www.ag-grid.com/javascript-grid-styling//); |
filterOnSelect |
specify whether filter is need to be perfromed on selecting a row item |
licenseKey |
if you wish to use the enterprise version of ag-grid |
width , height
|
Width/Height in pixels (optional, defaults to automatic sizing) |
elementId |
An id for the widget (a random string by default). |
aggrid(iris)
aggrid(iris)
Format table columns
formatColumns(table, columns, format)
formatColumns(table, columns, format)
table |
a table object created from |
columns |
the indices of the columns |
format |
format based on numeral.js (see http://numeraljs.com/#format); |
Get dependencies
getDeps(plugin, version)
getDeps(plugin, version)
plugin |
plugin |
version |
version |
Output and render functions for using RagGrid within Shiny applications and interactive Rmd documents.
RagGridOutput(outputId, width = "100%", height = "400px") renderRagGrid(expr, env = parent.frame(), quoted = FALSE)
RagGridOutput(outputId, width = "100%", height = "400px") renderRagGrid(expr, env = parent.frame(), quoted = FALSE)
outputId |
output variable to read from |
width , height
|
Must be a valid CSS unit (like |
expr |
An expression that generates a RagGrid |
env |
The environment in which to evaluate |
quoted |
Is |