Interface DataStream

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

Hierarchy

  • DataStream

Properties

cellRange close id start stop updateInterval worksheetId

Properties

cellRange

cellRange: string

The range of cells whose values will be updated by the data stream.

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

Readonly close

close: (() => void)

Type declaration

    • (): void

    • Closes the data stream.

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

      Throws

      ApiError if the data stream has already been closed.

      Returns void

Readonly id

id: string

The unique id of the data stream.

Readonly start

start: (() => void)

Type declaration

    • (): void

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

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

      Throws

      ApiError if the data stream has already been closed.

      Returns void

Readonly stop

stop: (() => void)

Type declaration

    • (): void

    • Stops the data stream.

      Throws

      ApiError if the data stream has already been closed.

      Returns void

updateInterval

updateInterval: number

The time (in milliseconds) between updates.

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

Readonly worksheetId

worksheetId: string

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

Settings

Member Visibility

Theme

Generated using TypeDoc