Skip to content
Spencer Childress edited this page Nov 30, 2018 · 4 revisions

The clinicalTimelines is a function that accepts a CSS selector and a configuration object and returns the clinical timelines chart, the ID-level timelines chart, the ID-level data listing, and a number of other components. Its central method is called init which accepts a data array and initializes the renderer.

clinicalTimelines(element = 'body', settings = {})

a function that returns an instance of the clinicalTimelines

Param Type Description
element string CSS selector that identifies the DOM node in which to render the display; defaults to 'body'
settings object configuration object that specifies all options for how the display appears and behaves; defaults to {}; see Configuration

clinicalTimelines.init(data)

a function that initializes the clinicalTimelines instance with the given data array

Param Type Description
data object data array of one record per participant per event; see Data Guidelines
Clone this wiki locally