1771 Technologies Logo

Grid API

RowApi<T>

Methods for managing the rows in Graphite Grid.

Type parameters

Type parameterValue
Tunknown

Properties

  • Name
    getAllBranchIdsAtDepthExn
    Type
    (params: object) => string[] | Promise<string[]>
    Description

    Returns all branch Ids at a specific depth. Throws if not supported by the data source.

  • Name
    getAllBranchIdsExn
    Type
    () => string[] | Promise<string[]>
    Description

    Returns all branch Ids for rows. Throws if not supported by the data source.

  • Name
    getAllChildrenIdsForRowExn
    Type
    (id: string | RowNodeBranch<T>) => string[]
    Description

    Returns all child row Ids for a given row. Throws if not supported by the data source.

  • Name
    getAutosizeOnGroupExpansion
    Type
    () => boolean
    Description

    Returns true if Graphite Grid will autosize on group expansion

  • Name
    getRowBranchExpansions
    Type
    () => Set<string>
    Description

    Gets the expansion state of row branches in the grid.

  • Name
    getRowById
    Type
    (id: string) => null | RowNode<T>
    Description

    Returns a row node for the given row Id. Returns null if not found.

  • Name
    getRowByIndexExn
    Type
    (index: number) => RowNode<T>
    Description

    Returns a row node for the given row index. Throws if the index is out of bounds.

  • Name
    getRowCount
    Type
    (section?: | "top" | "all" | "center" | "bot" | "top-and-center" | "top-and-bot") => number
    Description

    Returns the row count for the specified section of the grid.

  • Name
    getRowDataSource
    Type
    () => null | RowDataSource<T>
    Description

    Returns the current data source used by the grid.

  • Name
    getRowHeightCalculator
    Type
    () => RowHeight<T>
    Description

    Returns the rowHeight property used to determine row heights.

  • Name
    getRowPivotDisplayMode
    Type
    () => "group"
    Description

    Returns the current row pivot display mode used by the grid.

  • Name
    getRowPivotModel
    Type
    () => string[]
    Description

    Returns the current row pivot model used by the grid.

  • Name
    hasActiveRowPivot
    Type
    () => boolean
    Description

    Returns true if the grid has an active row pivot.

  • Name
    isRowBranchExpanded
    Type
    (id: string | RowNode<T>) => boolean
    Description

    Returns true if the given row is expanded.

  • Name
    refreshRowDataSource
    Type
    () => void
    Description

    Refreshes the row data source, causing Graphite Grid to recompute cell values.

  • Name
    setAutosizeOnGroupExpansion
    Type
    (autosize: boolean | Omit<AutosizeColumnsParams, "dryRun">) => void
    Description

    Sets the autosize on group expansion value. Autosizes columns every time a row branch is expanded or collapsed.

  • Name
    setRowBranchExpansions
    Type
    (expansions: Set<string>) => void
    Description

    Sets the expansion state of row branches in the grid.

  • Name
    setRowDataSource
    Type
    (dataSource: null | RowDataSource<T>) => void
    Description

    Sets the row data source the grid should use.

  • Name
    setRowHeightCalculator
    Type
    (rowHeight: RowHeight<T>) => void
    Description

    Sets the rowHeight property used to calculate row heights.

  • Name
    setRowPivotDisplayMode
    Type
    (mode: "group") => void
    Description

    Sets the row pivot display mode the grid should use.

  • Name
    setRowPivotModel
    Type
    (model: string[]) => void
    Description

    Sets the row pivot model the grid should use.

  • Name
    toggleRowBranchExpansion
    Type
    (row: string | number | RowNode<T>) => void
    Description

    Toggles the expansion state of a given row branch.

  • Name
    updateRowPivotGroupDefinition
    Type
    (definition: RowPivotGroupDefinition<T>) => void
    Description

    Updates the column definition for the automatic row pivot group column.