Options
All
  • Public
  • Public/Protected
  • All
Menu

Module subscriptions

Index

Functions

Functions

subscriptionFor

  • subscriptionFor(seriesObservable: Observable<ChartData>, onSubscribe: (subscription: Subscription) => void, windowingTime: number, axisAssignments: Map<string, AxesAssignment>, xAxesState: AxesState, onUpdateData: (seriesName: string, data: Datum[]) => void, dropDataAfter: number, updateTimingAndPlot: (ranges: Map<string, ContinuousAxisRange>) => void, seriesMap: Map<string, Series>, setCurrentTime: (axisId: string, end: number) => void): Subscription

  • Creates a subscription to the series observable with the data stream. The common code is shared by the plots.

    Parameters

    • seriesObservable: Observable<ChartData>

      The series observable holding the stream of chart data

    • onSubscribe: (subscription: Subscription) => void

      Callback for when the observable is subscribed to

        • (subscription: Subscription): void

        • Parameters

          • subscription: Subscription

          Returns void

    • windowingTime: number

      Basically the update time where data is collected and then rendered

    • axisAssignments: Map<string, AxesAssignment>

      The assignment of the series to their x- and y-axes

    • xAxesState: AxesState

      The current state of the x-axis

    • onUpdateData: (seriesName: string, data: Datum[]) => void

      Callback for when data is updated

        • (seriesName: string, data: Datum[]): void

        • Parameters

          • seriesName: string
          • data: Datum[]

          Returns void

    • dropDataAfter: number

      Limits the amount of data stored. Any data older than this value (ms) will be dropped on the next update

    • updateTimingAndPlot: (ranges: Map<string, ContinuousAxisRange>) => void

      The callback function to update the plot and timing

    • seriesMap: Map<string, Series>

      The series-name and the associated series

    • setCurrentTime: (axisId: string, end: number) => void

      Callback to update the current time based on the streamed data

        • (axisId: string, end: number): void

        • Parameters

          • axisId: string
          • end: number

          Returns void

    Returns Subscription

    A subscription to the observable (for cancelling and the likes)

subscriptionWithCadenceFor

  • subscriptionWithCadenceFor(seriesObservable: Observable<ChartData>, onSubscribe: (subscription: Subscription) => void, windowingTime: number, axisAssignments: Map<string, AxesAssignment>, xAxesState: AxesState, onUpdateData: (seriesName: string, data: Datum[]) => void, dropDataAfter: number, updateTimingAndPlot: (ranges: Map<string, ContinuousAxisRange>) => void, seriesMap: Map<string, Series>, setCurrentTime: (axisId: string, end: number) => void, cadencePeriod: number): Subscription

  • Function has side-effects on the Series (for performance).

    Creates a subscription to the series observable with the data stream. The common code is shared by the plots.

    Parameters

    • seriesObservable: Observable<ChartData>

      The series observable holding the stream of chart data

    • onSubscribe: (subscription: Subscription) => void

      Callback for when the observable is subscribed to

        • (subscription: Subscription): void

        • Parameters

          • subscription: Subscription

          Returns void

    • windowingTime: number

      Basically the update time where data is collected and then rendered

    • axisAssignments: Map<string, AxesAssignment>

      The assignment of the series to their x- and y-axes

    • xAxesState: AxesState

      The current state of the x-axis

    • onUpdateData: (seriesName: string, data: Datum[]) => void

      Callback for when data is updated

        • (seriesName: string, data: Datum[]): void

        • Parameters

          • seriesName: string
          • data: Datum[]

          Returns void

    • dropDataAfter: number

      Limits the amount of data stored. Any data older than this value (ms) will be dropped on the next update

    • updateTimingAndPlot: (ranges: Map<string, ContinuousAxisRange>) => void

      The callback function to update the plot and timing

    • seriesMap: Map<string, Series>

      The series-name and the associated series

    • setCurrentTime: (axisId: string, end: number) => void

      Callback to update the current time based on the streamed data

        • (axisId: string, end: number): void

        • Parameters

          • axisId: string
          • end: number

          Returns void

    • cadencePeriod: number

      The number of milliseconds between time updates

    Returns Subscription

    A subscription to the observable (for cancelling and the likes)

Generated using TypeDoc