Class Index | File Index

Classes


Class LABKEY.vis.Geom.Boxplot

The Boxplot Geom, used to generate box plots for a given set of data. In order to get multiple box plots for a set of data with a continuous x-axis scale, the user must define an accessor with the name "group" in the config.aes object of the {LABKEY.vis.Plot} or {LABKEY.vis.Layer} object. For example if the data looked like {x: 12, y: 35, name: "Alan"} the config.aes.group accessor could be "Alan", or a function: function(row){return row.name}. Each unique name would get a separate box plot. If aes.group is not present one boxplot will be generated for all of the data. This geom also supports the outlierColor, outlierShape, hoverText, outlierHoverText, and pointClickFn aesthetics from the {LABKEY.vis.Plot} and/or {LABKEY.vis.Layer} objects. Boxplots are drawn as follows:


Defined in: geom.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Config Summary
Config Attributes Config Name and Description
 
(Optional) A string value used for the line colors in the box plot.
 
(Optional) A string value used for the fill color in the box plot.
 
(Optional) A used to set the width of the lines used in the box plot.
 
(Optional) A number between 0 and 1 used to set the opacity of the box plot.
 
(Optional) A string value used to set the fill color of the outliers.
 
(Optional) A number between 0 and 1 used to set the opacity of the outliers.
 
(Optional) A used to set the size of outliers.
 
(Optional) A string used to determine how to position the outliers.
 
(Optional) Used to toggle whether or not outliers are rendered.
Class Detail
LABKEY.vis.Geom.Boxplot(config)
Parameters:
{Object} config
An object with the following properties:
Config Detail
{String} config.color
(Optional) A string value used for the line colors in the box plot. Defaults to black (#000000)

{String} config.fill
(Optional) A string value used for the fill color in the box plot. Defaults to white (#ffffff)

{Number} config.lineWidth
(Optional) A used to set the width of the lines used in the box plot. Defaults to 1.

{Number} config.opacity
(Optional) A number between 0 and 1 used to set the opacity of the box plot. Defaults to 1.

{String} config.outlierFill
(Optional) A string value used to set the fill color of the outliers. Defaults to black (#000000).

{Number} config.outlierOpacity
(Optional) A number between 0 and 1 used to set the opacity of the outliers. Defaults to 1.

{Number} config.outlierSize
(Optional) A used to set the size of outliers. Defaults to 3.

{String} config.position
(Optional) A string used to determine how to position the outliers. Currently the only possible value is "jitter", which will move the points to the left or right of the center of the box plot by a random amount. Defaults to undefined.

{Boolean} config.showOutliers
(Optional) Used to toggle whether or not outliers are rendered. Defaults to true.

Documentation generated by JsDoc Toolkit 2.3.2 on Thu Jun 11 2020 17:30:57 GMT-0000 (UTC)