Class Index | File Index

Classes


Class LABKEY.vis.TimelinePlot

TimelinePlot Wrapper to create a plot which shows timeline events with event types on the y-axis and days/time on the x-axis.
Defined in: plot.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Config Summary
Config Attributes Config Name and Description
 
The array of event data including event types and subtypes for the plot.
 
Object specifying whether to disable rendering of any Axes on the plot.
 
Possible options are 'y', 'x', and 'both' to determine which sets of grid lines are rendered on the plot.
 
The chart canvas height in pixels.
 
(Optional) Display options as defined in LABKEY.vis.Geom.TimelinePlot.
 
to identify a unique event in the data.
 
(Optional) Name of value that is paired with
 
(Optional) Name of property that is paired with
 
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) 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) 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) The start date to use to calculate number of days until event date.
 
(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.
 
The id of the div/span to insert the svg element into.
 
The chart canvas width in pixels.
Class Detail
LABKEY.vis.TimelinePlot(config)
Parameters:
{Object} config
An object that contains the following properties
Config Detail
{Array} config.data
The array of event data including event types and subtypes for the plot.

{Object} config.disableAxis
Object specifying whether to disable rendering of any Axes on the plot. Default: {xTop: false, xBottom: false, yLeft: false, yRight: false}

{String} config.gridLinesVisible
Possible options are 'y', 'x', and 'both' to determine which sets of grid lines are rendered on the plot. Default is 'both'.

{Number} config.height
The chart canvas height in pixels.

{Object} config.options
(Optional) Display options as defined in LABKEY.vis.Geom.TimelinePlot.

config.options.activeEventIdentifier
to identify a unique event in the data.

{String} config.options.activeEventIdentifier
(Optional) Name of value that is paired with

{String} config.options.activeEventKey
(Optional) Name of property that is paired with

config.options.activeEventKey
to identify a unique event in the data.

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

{Object} config.options.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.options.emphasisTickColor
(Optional) Hex color to specify the color of emphasis event ticks, if found in the data. Defaults to #1a969d.

{String} config.options.eventIconColor
(Optional) Hex color of event square stroke. Defaults to black (#0000000).

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

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

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

{Object} config.options.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.options.highlightRowColor
(Optional) Hex color to specify what color the highlighted row will be if, found in the data. Defaults to #74B0C4.

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

{Array} config.options.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.options.rowHeight
(Optional) The height of individual rows in pixels. For expanded timelines, row height will resize to 75% of this value. Defaults to 1.

{Date} config.options.startDate
(Optional) The start date to use to calculate number of days until event date.

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

{String} config.options.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.

{String} config.renderTo
The id of the div/span to insert the svg element into.

{Number} config.width
The chart canvas width in pixels.

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