Class Index | File Index

Classes


Class LABKEY.vis.Layer

LABKEY.vis.Layer class. Used to define layers used in LABKEY.vis.Plot objects.
Defined in: layer.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
LABKEY.vis.Layer objects are used to define layers in a plot.
Config Summary
Config Attributes Config Name and Description
 
(Optional) The aesthetic map object used to define aesthetic mappings such as x, y, color etc.
 
The array of data to use when rendering this layer.
 
A geom object to use when rendering this layer.
 
(Optional) Name of the layer.
Class Detail
LABKEY.vis.Layer(config)
LABKEY.vis.Layer objects are used to define layers in a plot. The user should not worry about any methods on this object, all methods are used internally by the LABKEY.vis.Plot object.
Parameters:
config
An object with the following properties.
Config Detail
{Object} config.aes
(Optional) The aesthetic map object used to define aesthetic mappings such as x, y, color etc. If not present then it defaults to the aes object on the LABKEY.vis.Plot object. For an in depth description of the config.aes object please see the documentation for LABKEY.vis.Plot.

{Array} config.data
The array of data to use when rendering this layer. If not present then it defaults to the data array on the LABKEY.vis.Plot object.

{Object} config.geom
A geom object to use when rendering this layer. See LABKEY.vis.Geom.

{String} config.name
(Optional) Name of the layer. You can give layers the same name or a different name. It Is primarily used if you have more than one layer that is using a color or shape scale and each layer has an overlap of values, but you want to differentiate each color or shape depending on the layer and aesthetic value. For example if you have a plot with two layers, each layer has a Path Geom on it, one layer could be used to plot weight over time, the other could be used to plot blood pressure over time for the same participant. If you want the lines to be different colors you could name each layer differently (i.e. Weight and Blood Pressure).

Documentation generated by JsDoc Toolkit 2.3.2 on Thu Mar 16 2017 20:36:36 GMT-0000 (UTC)