Class: Branch

Branch()

Branch represents a relationship between a child note and its parent note. Trilium allows a note to have multiple parents. Note that you should not rely on the branch's identity, since it can change easily with a note's move. Always check noteId instead.

Constructor

new Branch()

Source:

Extends

Members

(protected) becca

Overrides:
Source:

branchId :string

Type:
  • string
Source:

childNote

Source:

isExpanded :boolean

Type:
  • boolean
Source:

isWeak

Branch is weak when its existence should not hinder deletion of its note. As a result, note with only weak branches should be immediately deleted. An example is shared or bookmarked clones - they are created automatically and exist for technical reasons, not as user-intended actions. From user perspective, they don't count as real clones and for the purpose of deletion should not act as a clone.
Source:

noteId :string

Type:
  • string
Source:

notePosition :int

Type:
  • int
Source:

parentNote

Source:

parentNoteId :string

Type:
  • string
Source:

prefix :string

Type:
  • string
Source:

utcDateModified :string

Type:
  • string
Source:

Methods

(protected) addEntityChange()

Overrides:
Source:

(protected) beforeSaving()

Overrides:
Source:

deleteBranch(deleteIdopt, taskContextopt) → {boolean}

Delete a branch. If this is a last note's branch, delete the note as well.
Parameters:
Name Type Attributes Description
deleteId string <optional>
optional delete identified
taskContext TaskContext <optional>
Source:
Returns:
- true if note has been deleted, false otherwise
Type
boolean

(protected) generateHash()

Overrides:
Source:

(protected) generateIdIfNecessary()

Overrides:
Source:

(protected) getPojoToSave()

Overrides:
Source:

(protected) getUtcDateChanged()

Overrides:
Source:

markAsDeleted(deleteIdopt)

Mark the entity as (soft) deleted. It will be completely erased later. This is a low level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead.
Parameters:
Name Type Attributes Default Description
deleteId <optional>
null
Overrides:
Source:

save() → {this}

Saves entity - executes SQL, but doesn't commit the transaction on its own
Overrides:
Source:
Returns:
Type
this