@deephaven/jsapi-types
    Preparing search index...

    Interface TreeRow

    dh.TableData.Row implementation that also provides additional read-only properties. Represents visible rows in the table, but with additional properties to reflect the tree structure.

    interface TreeRow {
        get depth(): number;
        get hasChildren(): boolean;
        get index(): LongWrapper;
        get isExpanded(): boolean;
        get(column: Column): any;
        getFormat(column: Column): Format;
    }

    Hierarchy (View Summary)

    Index
    • get depth(): number

      The number of levels above this node; zero for top level nodes. Generally used by the UI to indent the row and its expand/collapse icon.

      Returns number

      int

    • get hasChildren(): boolean

      true if this node has children and can be expanded; false otherwise. Note that this value may change when the table updates, depending on the table's configuration.

      Returns boolean

      boolean

    • get isExpanded(): boolean

      true if this node is currently expanded to show its children; false otherwise. Those children are the rows below this one with a greater depth than this one.

      Returns boolean

      boolean

    • Returns the value for the given column in this row.

      Parameters

      • column: Column

        the column to read

      Returns any

      the value in this row for the specified column

    • Returns the server-specified Format for the given column in this row.

      Parameters

      • column: Column

        the column to read

      Returns Format

      the format details for the specified column in this row