Class Index | File Index

Classes


Class LABKEY.vis.Geom.BarPlot

Bar plot geom, used to generate bar plots for a given set of data.
Defined in: geom.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Config Summary
Config Attributes Config Name and Description
 
(Optional) A click function
 
(Optional) A string value used for the line colors in the bar plot.
 
(Optional) A string value used for the line colors in the cumulative bar plot.
 
(Optional) A string value used for the fill color in the bar plot.
 
(Optional) A string value used for the fill color in the cumulative bar plot.
 
(Optional) A hover function
 
(Optional) A used to set the width of the lines used in the bar plot.
 
(Optional) A used to set the width of the lines used in the cumulative bar plot.
 
(Optional) A number between 0 and 1 used to set the opacity of the bar plot.
 
(Optional) A number between 0 and 1 used to set the opacity of the cumulative bar plot.
 
(Optional) True to show cumulative totals next to the individual bars.
 
(Optional) True to show the bar height values as text above the rendered bar.
Class Detail
LABKEY.vis.Geom.BarPlot(config)
Parameters:
config
An object with the following properties:
Config Detail
{Function} config.clickFn
(Optional) A click function

{String} config.color
(Optional) A string value used for the line colors in the bar plot. Defaults to black (#000000)

{String} config.colorTotal
(Optional) A string value used for the line colors in the cumulative bar plot. Defaults to black (#000000)

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

{String} config.fillTotal
(Optional) A string value used for the fill color in the cumulative bar plot. Defaults to black (#000000)

{Function} config.hoverFn
(Optional) A hover function

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

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

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

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

{Boolean} config.showCumulativeTotals
(Optional) True to show cumulative totals next to the individual bars.

{Boolean} config.showValues
(Optional) True to show the bar height values as text above the rendered bar.

Documentation generated by JsDoc Toolkit 2.3.2 on Thu Mar 14 2019 22:39:27 GMT-0000 (UTC)