Interface TreeViewportData

Similar to ViewportData, but with additional properties to reflect the tree structure.

Hierarchy

Accessors

columns offset rows treeSize

Methods

get getData getFormat

Accessors

columns

  • get columns(): Column[]

  • Returns Column[]

offset

  • get offset(): number

  • The position of the first returned row within the tree.

    Returns number

rows

  • get rows(): TreeRow[]

  • A lazily computed array of all rows available on the client.

    Returns TreeRow[]

treeSize

  • get treeSize(): number

  • Returns number

Methods

get

  • 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

getData

  • 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

getFormat

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

    Parameters

    Returns Format

    a Format instance with any server-specified details

Settings

Member Visibility

Theme

On This Page