Class Index | File Index

Classes


Class LABKEY.vis.Geom.Point

The Point geom, used to generate points of data on a plot such as points on a line or points in a scatter plot. This geom supports the use of size, color, shape, hoverText, and pointClickFn aesthetics from the LABKEY.vis.Layer and/or LABKEY.vis.Plot 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 points.
 
(Optional) Number between 0 and 1, used to determine the opacity of all points.
 
(Optional) Used to toggle whether or not a row of data with the value of null will be plotted.
 
(Optional) String with possible value "jitter".
 
(Optional) Number used to determine the size of all points.
Class Detail
LABKEY.vis.Geom.Point(config)
Parameters:
{Object} config
An object with the following properties:
Config Detail
{String} config.color
(Optional) String used to determine the color of all points. Defaults to black (#000000).

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

{Boolean} config.plotNullPoints
(Optional) Used to toggle whether or not a row of data with the value of null will be plotted. If true null or undefined values will be plotted just outside the axis with data. For example if a row of data looks like {x: 50, y: null} the point would appear at 50 on the x-axis, and just below the x axis. If both x and y values are null the point will be drawn to the bottom left of the origin. Defaults to false.

{String} config.position
(Optional) String with possible value "jitter". If config.position is "jitter" and the x or y scale is discrete it will be moved just before or after the position on the grid by a random amount. Useful if there is overlapping data. Defaults to undefined.

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

Documentation generated by JsDoc Toolkit 2.3.2 on Tue Sep 11 2018 10:11:00 GMT-0000 (UTC)