AboutSupportDeveloper GuideVersion 1.5.0

An object that updates the values of a cell range at a given interval.

Hierarchy

  • DataStream

Properties

id: string

The unique id of the data stream.

updateInterval: number

The time (in milliseconds) between updates.

Any changes to this value will be not be reflected until the data stream is restarted.

worksheetId: string

The unique id of the worksheet where this data stream was created.

Methods

  • Closes the data stream.

    Calling start or stop on a closed data stream will result in an error being thrown.

    Returns void

    Throws

    ApiError if the data stream has already been closed.

  • Starts the data stream and begins updating the values of the cells in the range at the period defined in updateInterval.

    Calling start again will restart the data stream, allowing any changes to updateInterval to be reflected.

    Returns void

    Throws

    ApiError if the data stream has already been closed.

  • Stops the data stream.

    Returns void

    Throws

    ApiError if the data stream has already been closed.

Generated using TypeDoc