Class Index | File Index

Classes


Class LABKEY.vis.Geom.TimelinePlot

Timeline plot geom, used to generate a timeline plot 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) Name of value that is paired with @param config.activeEventKey to identify a unique event in the data.
 
(Optional) Name of property that is paired with @param config.activeEventIdentifier to identify a unique event in the data.
 
(Optional) Hex color to specify what color the active event rect's stroke will be, if found in the data.
 
(Optional) A string value used for the timeline event icon border color.
 
(Optional) property name of the date value that data objects contain.
 
(Optional) Object containing key:[value] pairs whose keys are property names of a data object and whose value is an array of possible values that should have a highlight line drawn on the chart when found.
 
(Optional) Hex color to specify the color of emphasis event ticks, if found in the data.
 
(Optional) Hex color of event square stroke.
 
(Optional) Hex color of event square inner fill.
 
(Optional) Float between 0 - 1 (inclusive) to specify how transparent the fill of event icons will be.
 
(Optional) Size of event square width/height dimensions.
 
(Optional) A string value used for the timeline event icon fill color.
 
(Optional) Special Data object containing information to highlight a specific row in the timeline.
 
(Optional) Hex color to specify what color the highlighted row will be if, found in the data.
 
(Optional) If true, the timeline collapses subtypes into their parent rows.
 
(Optional) Array of length 2 containing string Hex values for the two alternating colors of timeline row rectangles.
 
(Optional) The height of individual rows in pixels.
 
(Optional) A numeric value used for the timeline event icon size in pixels.
 
(Optional) Hex color to specify the color of Axis ticks.
 
(Optional) Unit of time to use when calculating how far an event's date is from the start date.
Class Detail
LABKEY.vis.Geom.TimelinePlot(config)
Parameters:
config
An object with the following properties:
Config Detail
{String} config.activeEventIdentifier
(Optional) Name of value that is paired with @param config.activeEventKey to identify a unique event in the data.

{String} config.activeEventKey
(Optional) Name of property that is paired with @param config.activeEventIdentifier to identify a unique event in the data.

{String} config.activeEventStrokeColor
(Optional) Hex color to specify what color the active event rect's stroke will be, if found in the data. Defaults to red.

{String} config.color
(Optional) A string value used for the timeline event icon border color. Defaults to black (#000000).

{String} config.dateKey
(Optional) property name of the date value that data objects contain. Used to create tooltips on hover. Defaults to 'date'.

{Object} config.emphasisEvents
(Optional) Object containing key:[value] pairs whose keys are property names of a data object and whose value is an array of possible values that should have a highlight line drawn on the chart when found. Example: {'type': ['death', 'Withdrawal']}

{String} config.emphasisTickColor
(Optional) Hex color to specify the color of emphasis event ticks, if found in the data. Defaults to #1a969d.

{String} config.eventIconColor
(Optional) Hex color of event square stroke.

{String} config.eventIconFill
(Optional) Hex color of event square inner fill. Defaults to black (#000000).

{Number} config.eventIconOpacity
(Optional) Float between 0 - 1 (inclusive) to specify how transparent the fill of event icons will be. Defaults to 1.

{Number} config.eventIconSize
(Optional) Size of event square width/height dimensions.

{String} config.fill
(Optional) A string value used for the timeline event icon fill color. Defaults to black (#000000).

{Object} config.highlight
(Optional) Special Data object containing information to highlight a specific row in the timeline. Must have the same shape & properties as all other input data.

{String} config.highlightRowColor
(Optional) Hex color to specify what color the highlighted row will be if, found in the data. Defaults to #74B0C4.

{Boolean} config.isCollapsed
(Optional) If true, the timeline collapses subtypes into their parent rows. Defaults to True.

{Array} config.rowColorDomain
(Optional) Array of length 2 containing string Hex values for the two alternating colors of timeline row rectangles. Defaults to ['#f2f2f2', '#ffffff'].

{Number} config.rowHeight
(Optional) The height of individual rows in pixels. For expanded timelines, row height will resize to 75% of this value. Defaults to 40px.

{String} config.size
(Optional) A numeric value used for the timeline event icon size in pixels. Defaults to 10.

{String} config.tickColor
(Optional) Hex color to specify the color of Axis ticks. Defaults to #DDDDDD.

{String} config.timeUnit
(Optional) Unit of time to use when calculating how far an event's date is from the start date. Default is years. Valid string values include minutes, hours, days, years, and decades.

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