clinical-timeline

by cBioPortal

master5408ab2  created March 1st 2017

other versions

59
Functions

fx
clinicalTimelineExporterremove
  • timeline
  • spec

Kind
function
Scope
instance
Source
js/plugins/exportTimeline.js:123

cleans up the HTML of the export-button

Arguments:

  1. timeline

    clinicalTimeline object

  2. specoptional, default:

    specification specific to the plugin

fx
clinicalTimelineExporterrun
  • timeline
  • spec

Kind
function
Scope
instance
Source
js/plugins/exportTimeline.js:16

runs the clinicalTimelineExporter plugin

Arguments:

  1. timeline

    clinicalTimeline object

  2. specoptional, default:

    specification specific to the plugin

fx
clinicalTimelineHelperLinesrun
  • timeline
  • spec

Kind
function
Scope
instance
Source
js/plugins/helperLines.js:16

runs the clinicalTimelineHelperLines plugin

Arguments:

  1. timeline

    clinicalTimeline object

  2. specoptional, default:

    specification specific to the plugin

fx
clinicalTimelineOverviewAxisrun
  • timeline
  • spec

Kind
function
Scope
instance
Source
js/plugins/overviewAxis.js:16

runs the clinicalTimelineOverviewAxis plugin

Arguments:

  1. timeline

    clinicalTimeline object

  2. specoptional, default:

    specification specific to the plugin

clinicalTimelineOverviewAxisrun~xScaleOverview

Kind
member
Scope
inner
Source
js/plugins/overviewAxis.js:43

scale for drawing the the overviewAxis and ticks in the specified width

clinicalTimelineOverviewAxisrun~xScaleOverviewZoomed

Kind
member
Scope
inner
Source
js/plugins/overviewAxis.js:95

scale to map the amount dragged on the zoomedWidth of original timeline to the overviewAxis width helps position the overview-rectangle correctly if original timeline dragged

clinicalTimelineOverviewAxisrun~xScaleRectangle

Kind
member
Scope
inner
Source
js/plugins/overviewAxis.js:102

scale to map the amount dragged on the overview-rectangle to the orignal timeline's zoomedWidth helps position the original-timeline correctly if the overview rectagle is dragged

fx
clinicalTimelineUtilgetDifferenceTicksDays
  • zoomLevel

Kind
function
Scope
static
Source
js/plugins/util.js:22

calculates the the difference (in days) between ticks on x-axis based on current zoom level

Arguments:

  1. zoomLevel

    current zoom-level

Returns:

  1. difference between ticks on clinical-timeline

fx
clinicalTimelineUtilgetLowerBoundIndex
  • arr
  • ele

Kind
function
Scope
static
Source
js/plugins/util.js:49

uses binary search to calculate the lower index of the indices between which the element(ele) lies in an array(arr)

Arguments:

  1. arr

    array to calculate index upon

  2. ele

    value of the element whose index has to be calculated

Returns:

  1. lower index

fx
clinicalTimelineUtilroundDown
  • numToRound
  • multiple

Kind
function
Scope
static
Source
js/plugins/util.js:87

rounds down to the nearest multiple of a number

Arguments:

  1. numToRound

    number to round

  2. multiple

    nearest multiple of a number to round off to

Returns:

  1. rounded down number

fx
clinicalTimelineUtilroundUp
  • numToRound
  • multiple

Kind
function
Scope
static
Source
js/plugins/util.js:69

rounds up to the nearest multiple of a number

Arguments:

  1. numToRound

    number to round

  2. multiple

    nearest multiple of a number to round off to

Returns:

  1. rounded up number

clinicalTimelineUtiltimelineConstants

Kind
member
Type
Scope
static
Source
js/plugins/util.js:11

stores various contstants shared between different functions and plugins of clinical-timeline

fx
clinicalTimelineVerticalLineremove
  • timeline
  • spec

Kind
function
Scope
instance
Source
js/plugins/verticalLine.js:102

cleans up the HTML of the verticalLine

Arguments:

  1. timeline

    clinicalTimeline object

  2. specoptional, default:

    specification specific to the plugin

fx
clinicalTimelineVerticalLinerun
  • timeline
  • spec

Kind
function
Scope
instance
Source
js/plugins/verticalLine.js:16

runs the clinicalTimelineVerticalLine plugin

Arguments:

  1. timeline

    clinicalTimeline object

  2. specoptional, default:

    specification specific to the plugin

clinicalTimelineVerticalLinerun~hoverScale

Kind
member
Scope
inner
Source
js/plugins/verticalLine.js:45

scale to map the coordinates hovered upon (according to the svg coordinates) to the clinical-timeline days

clinicalTimelineVerticalLinerun~tooltipOnVerticalLine

Kind
member
Type
Scope
inner
Source
js/plugins/verticalLine.js:52

Boolean to toggle the visibility of tooltips along with the vertical line

fx
clinicalTimelineZoomrun
  • timeline
  • spec

Kind
function
Scope
instance
Source
js/plugins/zoom.js:16

runs the clinicalTimelineZoom plugin

Arguments:

  1. timeline

    clinicalTimeline object

  2. specoptional, default:

    specification specific to the plugin

fx
clinicalTimelineZoomrun~brushend

    Kind
    function
    Scope
    inner
    Source
    js/plugins/zoom.js:38

    Add rectangular zoom selection zoom in after brush ends

    fx
    clinicalTimelineZoomrun~zoomExplanation
    • divId
    • svg
    • text
    • visibility
    • pos

    Kind
    function
    Scope
    inner
    Source
    js/plugins/zoom.js:128

    adds textual explanation for the present current zoom state

    Arguments:

    1. divId

      divId for clinical-timeline

    2. svg

      clinical-timeline's svg object

    3. text

      explanation's text

    4. visibility

      css property to hide/show the explanation

    5. pos

      position of the explanation's text

    fx
    clinicalTimelineisDurationTrack

      Kind
      function
      Scope
      inner
      Source
      js/clinicalTimeline.js:195

      Checks wheter a timeline track contains timepoints with varying start and end dates.

      fx
      clinicalTimelinemergeTooltipTablesAtEqualTimepoint

        Kind
        function
        Scope
        inner
        Source
        js/clinicalTimeline.js:230

        Merge timepoints that have the same starting_time into one timepoint with multiple tooltip_tables

        fx
        clinicalTimelineroundUpDays

          <