Class TimelineIndexInternal

A thing which contains a timeline reference, and an index into it.

Hierarchy

  • TimelineIndex

Constructors

constructor

Properties

index pendingPaginate? timeline

Methods

advance maxIndex minIndex retreat

Constructors

constructor

Properties

index

index: number

Optional pendingPaginate

pendingPaginate?: Promise<boolean>

timeline

timeline: EventTimeline

Methods

advance

  • Try move the index forward, or into the neighbouring timeline

    Returns

    number of events successfully advanced by

    Parameters

    • delta: number

      number of events to advance by

    Returns number

maxIndex

  • Returns

    the maximum possible value for the index in the current timeline (exclusive - ie, it actually returns one more than the index of the last element).

    Returns number

minIndex

  • Returns

    the minimum possible value for the index in the current timeline

    Returns number

retreat

  • Try move the index backwards, or into the neighbouring timeline

    Returns

    number of events successfully retreated by

    Parameters

    • delta: number

      number of events to retreat by

    Returns number

Settings

Member Visibility

Theme

Generated using TypeDoc