Class Index | File Index

Classes


Class LABKEY.vis.Geom.Path

The path geom, used to draw paths in a plot. In order to get multiple lines for a set of data 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 line. The geom also supports color and size aesthetics from the {LABKEY.vis.Plot} and/or {LABKEY.vis.Layer} objects.
Defined in: geom.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Config Summary
Config Attributes Config Name and Description
 
(Optional) String used to determine the color of all paths.
 
(Optional) True for dashed path, false for solid path.
 
(Optional) Number between 0 and 1, used to determine the opacity of all paths.
 
(Optional) Number used to determine the size of all paths.
Class Detail
LABKEY.vis.Geom.Path(config)
Parameters:
{Object} config
An object with the following properties:
Config Detail
{String} config.color
(Optional) String used to determine the color of all paths. Defaults to black (#000000).

{boolean} config.dashed
(Optional) True for dashed path, false for solid path. Defaults to false.

{Number} config.opacity
(Optional) Number between 0 and 1, used to determine the opacity of all paths. Useful if there are many overlapping paths. Defaults to 1.

{Number} config.size
(Optional) Number used to determine the size of all paths. Defaults to 3.

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