Trilium Frontend API
    Preparing search index...

    Interface FBranch

    Branch represents a relationship between a child note and its parent note. Trilium allows a note to have multiple parents.

    interface FBranch {
        branchId: string;
        fromSearchNote: boolean;
        isExpanded?: boolean;
        noteId: string;
        notePosition: number;
        parentNoteId: string;
        prefix?: string;
        get pojo(): Omit<FBranch, "froca">;
        get toString(): string;
        getNote(): Promise<FNote>;
        getNoteFromCache(): FNote;
        getParentNote(): Promise<FNote>;
        isTopLevel(): boolean;
        update(row: FBranchRow): void;
    }
    Index

    Properties

    branchId fromSearchNote isExpanded? noteId notePosition parentNoteId prefix?

    Accessors

    pojo toString

    Methods

    getNote getNoteFromCache getParentNote isTopLevel update

    Properties

    branchId: string

    primary key

    fromSearchNote: boolean
    isExpanded?: boolean
    noteId: string
    notePosition: number
    parentNoteId: string
    prefix?: string

    Accessors

    • get pojo(): Omit<FBranch, "froca">

      Returns Omit<FBranch, "froca">

    • get toString(): string

      Returns string

    Methods

    • Returns Promise<FNote>

    • Returns FNote

    • Returns Promise<FNote>

    • Returns boolean

      true if it's top level, meaning its parent is the root note

    • Parameters

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods