API Docs for:
Show:

TimelineView Class

Defined in: view\TimelineView.js:10
Module: modules

Template: timeline.html

Methods

animate

()

Defined in view\TimelineView.js:294

This method starts the animation of the timeline. The animation of the timeline is a set of consecutive seek invocation.

calculateSelectionChartPage

(
  • An
)
Integer

Defined in view\TimelineView.js:778

This method returns the page of the given event.

Parameters:

  • An Object

    instance of Event

Returns:

Integer: The number of the current page

checkSliderSelection

()

Defined in view\TimelineView.js:1026

This method checks and prevents inconsistent selection of the Control Timeline.

confirmSlidersSelection

()

Defined in view\TimelineView.js:854

This method is triggered when a user changes the selection on the Control Timeline.

drawControlChart

()

Defined in view\TimelineView.js:366

This method draws the Control Timeline

drawIntervalOnSelectionCanvas

()

Defined in view\TimelineView.js:1076

This method draws on the Selection Timeline an interval selected on the Control Timeline

drawSelectionChart

()

Defined in view\TimelineView.js:460

This method draws the Selection Timeline

getEventColor

(
  • The
)

Defined in view\TimelineView.js:894

This method provides a color for each type of event.

Parameters:

  • The String

    type of an event

getEventVerboseType

(
  • The
)

Defined in view\TimelineView.js:932

This method provides a description for each type of event.

Parameters:

  • The String

    type of an event

getNumberOfEventsBetween

(
  • A
  • A
)
Integer

Defined in view\TimelineView.js:323

This method returns the number of events occurring between two unix timestamps.

Parameters:

  • A Integer

    unix timestamp

  • A Integer

    unix timestamp

Returns:

Integer: The number of events

initialize

(
  • A
)

Defined in view\TimelineView.js:25

The initialization method of this object.

Parameters:

  • A Map

    map of parameters

logarithmicSeekTime

(
  • A
)
Float

Defined in view\TimelineView.js:272

This method is useful to calculate the duration for a seek operation with a logarithm approach.

Parameters:

  • A Float

    time interval

Returns:

Float: A time interval

manageSelectionChartArrows

()

Defined in view\TimelineView.js:682

This method manages the arrows useful to change the page of the Selection Timeline.

miniArrowsManager

()

Defined in view\TimelineView.js:1180

This method manages the mini arrows. The mini arrows are the two green arrows that appear when the timeline sliders (selectors) disappear from the visible selection timeline.

nextEvent

(
  • An
  • If
)
Object

Defined in view\TimelineView.js:170

This method returns the next event in the timeline.

Parameters:

  • An Object

    instance of Instant

  • If Boolean

    this optional parameter is true then the next event will be the first of the next block

Returns:

Object: An instance of Event

nextSelectionChart

()

Defined in view\TimelineView.js:635

This method draws the next page of the Selection Timeline

prevSelectionChart

()

Defined in view\TimelineView.js:646

This method draws the previous page of the Selection Timeline

render

()

Defined in view\TimelineView.js:116

This method draws this module (eg. inject the DOM and elements).

scrollSelectionCanvas

(
  • An
)

Defined in view\TimelineView.js:793

This method auto-scrolls the Selection Canvas when the selected instant is represented close to a margin.

Parameters:

  • An Object

    instance of Instant

seek

(
  • An
  • The
)

Defined in view\TimelineView.js:202

This method manages the animation of the time cursor along the timeline.

Parameters:

  • An Object

    instance of Instant which will be the final position of the time cursor

  • The Float

    duration of the animation

selectionChartPages

() Array

Defined in view\TimelineView.js:657

This method creates an array of events each of which is the first of the related page.

Returns:

Array: Array of events

stopAnimation

()

Defined in view\TimelineView.js:1014

This method stops a seek process

updateControlCanvas

()

Defined in view\TimelineView.js:701

This method updates the representation of the Control Timeline

updateCursorPosition

()

Defined in view\TimelineView.js:970

This method is triggered when a user clicks on the Control Timeline in order to change the current instant

updateSelectedEvent

()

Defined in view\TimelineView.js:990

This method is triggered when a user clicks on the Selection Timeline in order to change the current event

updateSelectionCanvas

()

Defined in view\TimelineView.js:739

This method updates the representation of the Selection Timeline

writeTimelineDate

()

Defined in view\TimelineView.js:351

This method prints information about the position of the time cursor.

writeTimelineInfo

(
  • Information
)

Defined in view\TimelineView.js:335

This method prints information about the timeline.

Parameters:

  • Information String