Interface TreeViewportData

Common interface for various ways of accessing table data and formatting for viewport or non-viewport subscriptions on tables, data in trees, and snapshots.

Generally speaking, it is more efficient to access data in column-major order, rather than iterating through each Row and accessing all columns that it holds. The rows accessor can be useful to read row data, but may incur other costs - it is likely faster to access data by columns using getData.

Hierarchy

Accessors

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

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

    Returns TreeRow[]

  • get treeSize(): number
  • Returns number

Methods

  • Reads a row object from the table, from which any subscribed column can be read.

    Parameters

    • index: number | LongWrapper

      the position or key to access

    Returns TreeRow

    the row at the given location

  • 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