apex-grid
    Preparing search index...

    Interface GridTreeConfiguration<T>

    Grid-level tree-data (nested rows) configuration.

    Tree mode renders hierarchical data as nested rows that share the same column layout — collapsible parents with indented children, AG Grid's "tree data" pattern. The data array stays flat; the grid derives the hierarchy from getDataPath at runtime.

    This is distinct from GridExpansionConfiguration (master-detail), which expands a row to show an arbitrary detail panel. Tree mode and expansion mode can be enabled together, but the chevron column is reserved by whichever is currently rendering the chevron — typically the tree feature when both are enabled.

    grid.tree = {
      enabled: true,
      getDataPath: (row) => row.path,
    };
    interface GridTreeConfiguration<T extends object> {
        childIndent?: number;
        defaultExpanded?: number | boolean;
        enabled?: boolean;
        getDataPath: (row: T) => readonly string[];
        groupColumnKey?: keyof T;
    }

    Type Parameters

    • T extends object
    Index

    Properties

    childIndent? defaultExpanded? enabled? getDataPath groupColumnKey?

    Properties

    childIndent?: number

    Pixels of indentation per depth level. Defaults to 20.

    defaultExpanded?: number | boolean

    Initial expansion state:

    • false (default): all rows collapsed.
    • true: every row expanded.
    • number: expand all rows up to and including the given depth (0 = roots only).
    enabled?: boolean

    Whether tree mode is enabled. Disabled by default.

    getDataPath: (row: T) => readonly string[]

    Callback that returns the hierarchical path for a row. The path is a sequence of segments from root to the row's own position — for example ['Adrian'] for a CEO, ['Adrian', 'Bryan'] for a VP under Adrian, and so on. Required when enabled is true.

    groupColumnKey?: keyof T

    Which column displays the chevron + indentation. Defaults to the first visible non-hidden data column.

    Settings

    Member Visibility

    On This Page

    Properties