Back to Trilium

Class FBranch

docs/Script API/classes/Frontend_Script_API.FBranch.html

0.102.22.9 KB
Original Source

Class FBranch

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

Index

Constructors

constructor

Properties

branchIdfromSearchNoteisExpanded?noteIdnotePositionparentNoteIdprefix?

Accessors

pojotoString

Methods

getNotegetNoteFromCachegetParentNoteisTopLevelupdate

Constructors

constructor

new FBranch(froca: Froca, row: FBranchRow): FBranch

Parameters

Returns FBranch

Properties

branchId

branchId: string

primary key

fromSearchNote

fromSearchNote: boolean

OptionalisExpanded

isExpanded?: boolean

noteId

noteId: string

notePosition

notePosition: number

parentNoteId

parentNoteId: string

Optionalprefix

prefix?: string

Accessors

pojo

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

Returns Omit<FBranch, "froca">

toString

get toString(): string

Returns string

Methods

getNote

getNote(): Promise<null | FNote>

Returns Promise<null | FNote>

getNoteFromCache

getNoteFromCache(): FNote

Returns FNote

getParentNote

getParentNote(): Promise<null | FNote>

Returns Promise<null | FNote>

isTopLevel

isTopLevel(): boolean

Returns boolean

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

update

update(row: FBranchRow): void

Parameters

Returns void

Settings

Member Visibility

  • Protected
  • Inherited
  • External

ThemeOSLightDark

On This Page

Constructors constructor Properties branchIdfromSearchNoteisExpandednoteIdnotePositionparentNoteIdprefix Accessors pojotoString Methods getNotegetNoteFromCachegetParentNoteisTopLevelupdate