aps.one.dataset.div: aps.one.dataset.div

In apomatix/AnalysisPageServer: A framework for sharing interactive data and plots from R through the web

Description

Create HTML for a div element to contain one AnalysisPageServer data set

Usage

aps.one.dataset.div(svg.path = NULL, data.path = NULL,
  show.sidebar = TRUE, show.table = TRUE, allow.zoom = TRUE,
  plot.height = NULL, div.width = NULL, style = NULL,
  num.table.rows = 10, extra.html.class = character(),
  extra.div.attr = NULL)

Arguments

svg.path	Path (could be relative to index.html) to (annotated) SVG file. NULL to only have data table and no picture.
data.path	Path (could be relative to index.html) to JSON file containing data set. NULL to only have SVG and no table
show.sidebar	Boolean. If TRUE (default) then show sidebar. If FALSE then omit it.
show.table	Boolean. If TRUE (default) then show sidebar. If FALSE then omit it.
allow.zoom	If TRUE (default) then allow zooming and panning. IF FALSE then do not allow it.
plot.height	If NULL (default) then do not specify 'data-plot-height' attribute. Otherwise, use this number as 'data-plot-height' attribute, which will specify the plot height (in pixels)
div.width	If NULL (default) then do not specify div width in style. Otherwise, supply a valid CSS width (e.g. "200px" or "60 and this will be rolled into the inline-style
style	String specifying inline style of this div or NULL (default). If NULL then and div.width is also NULL then do not specfiy any inline style. If NULL and div.width is non-NULL then create a centered div of div.width pixels wide with style="width:100px; margin:0 auto" (or whatever div.width is, instead of "100px"). If non-NULL then use the string directly as the style attribute of the div.
num.table.rows	Number of table rows to show. Default: 10
extra.html.class	Thesee are extra classes to add to the div. This could be used for whatever extended purpose you want, like extra styling or logic. Should be an unnamed charvec. Default is character(), just use the basic required for APS.
extra.div.attr	These are extra attributes to add to the div. For example you could add an id attribute. It should be a named charvec, or NULL (default) to not anything extra beyond that required for APS.

Details

Create HTML for a div element to contain one AnalysisPageServer data set. This function does not created, modify, or even check for existance of the SVG and JSON files. You provide paths and this function just includes those paths, however awful, in the HTML returned.

Value

HTML string

Author(s)

Brad Friedman

See Also

aps.dataset.divs, a convenience wrapper for this function to create multple divs at once.

apomatix/AnalysisPageServer documentation built on May 26, 2019, 11:36 a.m.