Member Junction
    Preparing search index...

    Declarative configuration options for the HierarchyTreeComponent.

    interface HierarchyTreeConfig {
        ActiveRecordID?: string;
        AllowDragDropReparent?: boolean;
        AllowNodeActions?: boolean;
        AutoRootFocus?: boolean;
        ColorField?: string;
        DefaultColor?: string;
        DefaultIcon?: string;
        EntityName: string;
        ExtraFilter?: string;
        FocusRecordID?: string;
        Height?: string;
        IconField?: string;
        InitialExpandDepth?: number;
        LevelSpacing?: number;
        MaxRows?: number;
        MinHeight?: string;
        NameField?: string;
        NavigateOnNodeClick?: boolean;
        NodeHeight?: number;
        NodeStyle?: HierarchyNodeStyle;
        NodeWidth?: number;
        OrderBy?: string;
        Orientation?: HierarchyTreeOrientation;
        ParentField?: string;
        ShowSearch?: boolean;
        ShowToolbar?: boolean;
        SiblingSpacing?: number;
        SubtitleField?: string;
        Verbose?: boolean;
    }
    Index

    Properties

    ActiveRecordID?: string

    Optional active / selected record ID. When provided, the node is highlighted and all ancestors are expanded so it is visible in full tree context.

    AllowDragDropReparent?: boolean

    Whether to allow interactive drag-and-drop reparenting of nodes.

    false
    
    AllowNodeActions?: boolean

    Whether to display quick node action buttons (Open Record, Add Child, Focus Subtree) on node cards.

    true
    
    AutoRootFocus?: boolean

    When multiple root trees exist and an active/focus record is specified, automatically focuses on the root branch containing the active record. Users can click "Show All Roots" to zoom out to the full forest.

    true
    
    ColorField?: string

    Optional field name containing a hex color or theme token for the node accent.

    DefaultColor?: string

    Default accent color when a node does not provide one. Prefer a design token over a literal so the accent follows the active theme.

    'var(--mj-brand-primary, #38bdf8)'

    DefaultIcon?: string

    Default Font Awesome icon class when a node does not provide one.

    'fa-solid fa-sitemap'

    EntityName: string

    The MemberJunction entity name (e.g. 'MJ_BizApps_Common: Organizations', 'MJ_BizApps_Orders: Product Categories'). The component queries this entity and uses its metadata for primary keys and foreign keys.

    ExtraFilter?: string

    Optional SQL-like filter string applied to the RunView query (e.g. 'IsActive = 1').

    FocusRecordID?: string

    Optional subtree focus record ID. When provided, the tree renders only the specified record and its descendants.

    Height?: string

    Total height of the tree container (e.g. '100%', '560px').

    '100%'

    IconField?: string

    Optional field name containing a Font Awesome icon class or image URL.

    InitialExpandDepth?: number

    Maximum depth to expand initially upon loading. 0 expands all levels.

    0
    
    LevelSpacing?: number

    Vertical spacing between hierarchy depth levels in pixels.

    70
    
    MaxRows?: number

    Optional maximum number of rows to retrieve via RunView. 0 loads all records.

    0
    
    MinHeight?: string

    Minimum height of the tree container.

    '500px'

    NameField?: string

    The field name to use for the primary node label. If omitted, automatically defaults to the entity's configured NameField / IsNameField.

    NavigateOnNodeClick?: boolean

    Whether single-clicking a node card triggers navigation to that record.

    true
    
    NodeHeight?: number

    Height of individual node cards in pixels.

    90
    
    NodeStyle?: HierarchyNodeStyle

    Visual style for node cards.

    'card'

    NodeWidth?: number

    Width of individual node cards in pixels.

    230
    
    OrderBy?: string

    Optional order-by clause for sorting sibling nodes (e.g. 'Name ASC', 'Sequence ASC').

    'Name ASC'

    Layout orientation.

    'top-to-bottom'

    ParentField?: string

    The self-referencing foreign key field name that points to the parent record (e.g. 'ParentID', 'ParentCategoryID'). If omitted, defaults to 'ParentID' or automatically resolves from the entity's self-referencing foreign key metadata.

    ShowSearch?: boolean

    Whether to display the interactive search / filter bar at the top of the tree.

    true
    
    ShowToolbar?: boolean

    Whether to display the zoom / navigation toolbar (Fit, Zoom In, Zoom Out, Expand All, Collapse All).

    true
    
    SiblingSpacing?: number

    Horizontal spacing between sibling nodes in pixels.

    40
    
    SubtitleField?: string

    Optional field name to use for the node subtitle / secondary tag (e.g. 'OrganizationType', 'AccountCode').

    Verbose?: boolean

    Whether to enable verbose diagnostic console logging.

    false