Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DataStream

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

Hierarchy

  • DataStream

Index

Properties

Methods

Properties

cellRange

cellRange: string

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

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

Readonly id

id: string

The unique id of the datastream.

updateInterval

updateInterval: number

The time (in milliseconds) between updates.

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

Readonly worksheetId

worksheetId: string

The unique id of the worksheet where this datastream was created.

Methods

Readonly close

  • close(): void

  • Closes the datastream.

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

    throws

    ApiError if the datastream has already been closed.

    Returns void

Readonly start

  • start(): void

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

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

    throws

    ApiError if the datastream has already been closed.

    Returns void

Readonly stop

  • stop(): void

  • Stops the datastream.

    throws

    ApiError if the datastream has already been closed.

    Returns void

Generated using TypeDoc