Interface ViewportData

Extends TableData, but only contains data in the current viewport. The only API change from TableData is that ViewportData also contains the offset to this data, so that the actual row number may be determined.

For viewport subscriptions, it is not necessary to read with the key, only with the position.

Do not assume that the first row in `rows` is the first visible row, because extra rows may be provided for easier scrolling without going to the server.

Hierarchy

Accessors

Methods

Accessors

  • get columns(): Column[]
  • Returns Column[]

  • get offset(): number
  • The position of the first returned row, null if this data is not for a viewport.

    Returns number

  • get rows(): ViewportRow[]
  • A lazily computed array of all rows available on the client.

    Returns ViewportRow[]

Methods

  • Reads a specific cell from the table, by row key and column.

    Parameters

    • index: number | LongWrapper

      the row in the table to get data from

    • column: Column

      the column to read

    Returns any

    the value in the table

  • The server-specified Format to use for the cell at the given position.

    Parameters

    Returns Format

    a Format instance with any server-specified details