Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Point

A point in a time series, either specified by the event number or a time

Hierarchy

  • Point

Index

Constructors

constructor

  • new Point(value: number | Long, type: Type): Point
  • Create a Point instance

    Parameters

    • value: number | Long

      the point value

    • type: Type

      the point type

    Returns Point

Properties

type

type: Type

The point type

value

value: number | Long

The point value

Methods

equals

  • equals(other: any): boolean
  • Check if the Point is equal to another object

    Parameters

    • other: any

      the other object

    Returns boolean

    true if the other object is a Point and is equal

Static at

  • at(sequence: Date | number): Point
  • Create a new point that is anchored at an absolute position.

    Parameters

    • sequence: Date | number

      the date or number at which the point is anchored

    Returns Point

    a new point

Static atStart

  • Get a start point

    Returns Point

    a unique instance of the start point

Static next

  • next(count: number): Point
  • Create a point following a previous point by a number of events

    oaram

    count the number of events

    Parameters

    • count: number

    Returns Point

    a new point

Static nextMillis

  • nextMillis(timespan: number): Point
  • Create a point following a previous point by a time span

    oaram

    timespan the number of milliseconds

    Parameters

    • timespan: number

    Returns Point

    a new point

Static offset

  • offset(count: number): Point
  • Create a point with a sequence offset. The point refers to a position count events before the end of the sequence

    oaram

    count the sequence offset

    Parameters

    • count: number

    Returns Point

    a new point

Static offsetMillis

  • offsetMillis(timespan: number): Point
  • Create a point with a time offset. The point refers to a position timespan milliseconds before the end of the sequence.

    oaram

    count the time offset in milliseconds

    Parameters

    • timespan: number

    Returns Point

    a new point

Static previous

  • previous(count: number): Point
  • Create a point preceding another point by a number of events

    oaram

    count the number of events

    Parameters

    • count: number

    Returns Point

    a new point

Static previousMillis

  • previousMillis(timespan: number): Point
  • Create a point preceding another point by a time span

    oaram

    timespan the number of milliseconds

    Parameters

    • timespan: number

    Returns Point

    a new point