Class: FNote

FNote(froca, row)

Note is the main node and concept in Trilium.

Constructor

new FNote(froca, row)

Parameters:
Name Type Description
froca Froca
row Object.<string, Object>
Source:

Members

attachments :Array.<FAttachment>|null

Type:
Source:

attributes :Array.<string>

Type:
  • Array.<string>
Source:

childToBranch :Object.<string, string>

Type:
  • Object.<string, string>
Source:

children :Array.<string>

Type:
  • Array.<string>
Source:

froca :Froca

Type:
  • Froca
Source:

isProtected :boolean

Type:
  • boolean
Source:

mime :string

content-type, e.g. "application/json"
Type:
  • string
Source:

noteId :string

Type:
  • string
Source:

parentToBranch :Object.<string, string>

Type:
  • Object.<string, string>
Source:

parents :Array.<string>

Type:
  • Array.<string>
Source:

targetRelations :Array.<string>

Type:
  • Array.<string>
Source:

title :string

Type:
  • string
Source:

type :NoteType

See {@see NoteType} for info on values.
Type:
Source:

Methods

getAllNotePaths() → {Array.<Array.<string>>}

Gives all possible note paths leading to this note. Paths containing search note are ignored (could form cycles)
Source:
Returns:
- array of notePaths (each represented by array of noteIds constituting the particular note path)
Type
Array.<Array.<string>>

(async) getAttachmentById() → {Promise.<FAttachment>}

Source:
Returns:
Type
Promise.<FAttachment>

(async) getAttachments() → {Promise.<Array.<FAttachment>>}

Source:
Returns:
Type
Promise.<Array.<FAttachment>>

(async) getAttachmentsByRole() → {Promise.<Array.<FAttachment>>}

Source:
Returns:
Type
Promise.<Array.<FAttachment>>

getAttribute(type, name) → {FAttribute}

Parameters:
Name Type Description
type AttributeType attribute type (label, relation, etc.)
name string attribute name
Source:
Returns:
attribute of the given type and name. If there are more such attributes, first is returned. Returns null if there's no such attribute belonging to this note.
Type
FAttribute

getAttributeValue(type, name) → {string}

Parameters:
Name Type Description
type AttributeType attribute type (label, relation, etc.)
name string attribute name
Source:
Returns:
attribute value of the given type and name or null if no such attribute exists.
Type
string

getAttributes(typeopt, nameopt) → {Array.<FAttribute>}

Parameters:
Name Type Attributes Description
type string <optional>
 (optional) attribute type to filter
name string <optional>
 (optional) attribute name to filter
Source:
Returns:
all note's attributes, including inherited ones
Type
Array.<FAttribute>

getBestNotePath(hoistedNoteIdopt) → {Array.<string>}

Returns the note path considered to be the "best"
Parameters:
Name Type Attributes Default Description
hoistedNoteId string <optional>
 'root'
Source:
Returns:
array of noteIds constituting the particular note path
Type
Array.<string>

getBestNotePathString(hoistedNoteIdopt) → {string}

Returns the note path considered to be the "best"
Parameters:
Name Type Attributes Default Description
hoistedNoteId string <optional>
 'root'
Source:
Returns:
serialized note path (e.g. 'root/a1h315/js725h')
Type
string

(async) getBlob() → {Promise.<FBlob>}

Source:
Returns:
Type
Promise.<FBlob>

getBranchIds() → {Array.<string>}

Deprecated:
  • use getParentBranchIds() instead
Source:
Returns:
Type
Array.<string>

getBranches() → {Array.<FBranch>}

Deprecated:
  • use getParentBranches() instead
Source:
Returns:
Type
Array.<FBranch>

getChildBranches() → {Array.<FBranch>}

Source:
Returns:
Type
Array.<FBranch>

getChildNoteIds() → {Array.<string>}

Source:
Returns:
Type
Array.<string>

(async) getChildNotes() → {Promise.<Array.<FNote>>}

Source:
Returns:
Type
Promise.<Array.<FNote>>

getLabel(name) → {FAttribute}

Parameters:
Name Type Description
name string label name
Source:
Returns:
label if it exists, null otherwise
Type
FAttribute

getLabelValue(name) → {string}

Parameters:
Name Type Description
name string label name
Source:
Returns:
label value if label exists, null otherwise
Type
string

getLabels(nameopt) → {Array.<FAttribute>}

Parameters:
Name Type Attributes Description
name string <optional>
 label name to filter
Source:
Returns:
all note's labels (attributes with type label), including inherited ones
Type
Array.<FAttribute>

(async) getMetadata() → {Promise.<{dateCreated: string, utcDateCreated: string, dateModified: string, utcDateModified: string}>}

Provides note's date metadata.
Source:
Returns:
Type
Promise.<{dateCreated: string, utcDateCreated: string, dateModified: string, utcDateModified: string}>

(async) getNoteComplement() → {Promise.<FBlob>}

Deprecated:
  • use getBlob() instead
Source:
Returns:
Type
Promise.<FBlob>

getNotesToInheritAttributesFrom() → {Array.<FNote>}

Source:
Returns:
Type
Array.<FNote>

getOwnedAttribute(type, name) → {FAttribute}

Parameters:
Name Type Description
type AttributeType attribute type (label, relation, etc.)
name string attribute name
Source:
Returns:
attribute of the given type and name. If there are more such attributes, first is returned. Returns null if there's no such attribute belonging to this note.
Type
FAttribute

getOwnedAttributeValue(type, name) → {string}

Parameters:
Name Type Description
type AttributeType attribute type (label, relation, etc.)
name string attribute name
Source:
Returns:
attribute value of the given type and name or null if no such attribute exists.
Type
string

getOwnedAttributes(typeopt, nameopt) → {Array.<FAttribute>}

Parameters:
Name Type Attributes Description
type string <optional>
 (optional) attribute type to filter
name string <optional>
 (optional) attribute name to filter
Source:
Returns:
all note's attributes, including inherited ones
Type
Array.<FAttribute>

getOwnedLabel(name) → {FAttribute}

Parameters:
Name Type Description
name string label name
Source:
Returns:
label if it exists, null otherwise
Type
FAttribute

getOwnedLabelValue(name) → {string}

Parameters:
Name Type Description
name string label name
Source:
Returns:
label value if label exists, null otherwise
Type
string

getOwnedLabels(nameopt) → {Array.<FAttribute>}

Parameters:
Name Type Attributes Description
name string <optional>
 label name to filter
Source:
Returns:
all note's labels (attributes with type label), including inherited ones
Type
Array.<FAttribute>

getOwnedRelation(name) → {FAttribute}

Parameters:
Name Type Description
name string relation name
Source:
Returns:
relation if it exists, null otherwise
Type
FAttribute

getOwnedRelationValue(name) → {string}

Parameters:
Name Type Description
name string relation name
Source:
Returns:
relation value if relation exists, null otherwise
Type
string

getOwnedRelations(nameopt) → {Array.<FAttribute>}

Parameters:
Name Type Attributes Description
name string <optional>
 relation name to filter
Source:
Returns:
all note's relations (attributes with type relation), including inherited ones
Type
Array.<FAttribute>

getParentBranchIds() → {Array.<string>}

Source:
Returns:
Type
Array.<string>

getParentBranches() → {Array.<FBranch>}

Source:
Returns:
Type
Array.<FBranch>

getParentNoteIds() → {Array.<string>}

Source:
Returns:
Type
Array.<string>

getParentNotes() → {Array.<FNote>}

Source:
Returns:
Type
Array.<FNote>

getRelation(name) → {FAttribute}

Parameters:
Name Type Description
name string relation name
Source:
Returns:
relation if it exists, null otherwise
Type
FAttribute

(async) getRelationTarget(name) → {Promise.<FNote>|null}

Parameters:
Name Type Description
name string
Source:
Returns:
target note of the relation or null (if target is empty or note was not found)
Type
Promise.<FNote> | null

(async) getRelationTargets(nameopt) → {Promise.<Array.<FNote>>}

Parameters:
Name Type Attributes Description
name string <optional>
 relation name to filter
Source:
Returns:
Type
Promise.<Array.<FNote>>

getRelationValue(name) → {string}

Parameters:
Name Type Description
name string relation name
Source:
Returns:
relation value if relation exists, null otherwise
Type
string

getRelations(nameopt) → {Array.<FAttribute>}

Parameters:
Name Type Attributes Description
name string <optional>
 relation name to filter
Source:
Returns:
all note's relations (attributes with type relation), including inherited ones
Type
Array.<FAttribute>

getScriptEnv() → {string|null}

Source:
Returns:
JS script environment - either "frontend" or "backend"
Type
string | null

getSortedNotePathRecords(hoistedNoteIdopt) → {Array.<NotePathRecord>}

Parameters:
Name Type Attributes Default Description
hoistedNoteId string <optional>
 'root'
Source:
Returns:
Type
Array.<NotePathRecord>

(async) getTargetRelationSourceNotes() → {Promise.<Array.<FNote>>}

Get relations which target this note
Source:
Returns:
Type
Promise.<Array.<FNote>>

getTargetRelations() → {Array.<FAttribute>}

Get relations which target this note
Source:
Returns:
Type
Array.<FAttribute>

hasAttribute(type, name) → {boolean}

Parameters:
Name Type Description
type AttributeType attribute type (label, relation, etc.)
name string attribute name
Source:
Returns:
true if note has an attribute with given type and name (including inherited)
Type
boolean

hasChildren() → {boolean}

Source:
Returns:
Type
boolean

hasLabel(name) → {boolean}

Parameters:
Name Type Description
name string label name
Source:
Returns:
true if label exists (including inherited)
Type
boolean

hasOwnedAttribute(type, name) → {boolean}

Parameters:
Name Type Description
type AttributeType attribute type (label, relation, etc.)
name string attribute name
Source:
Returns:
true if note has an attribute with given type and name (including inherited)
Type
boolean

hasOwnedLabel(name) → {boolean}

Parameters:
Name Type Description
name string label name
Source:
Returns:
true if label exists (excluding inherited)
Type
boolean

hasOwnedRelation(name) → {boolean}

Parameters:
Name Type Description
name string relation name
Source:
Returns:
true if relation exists (excluding inherited)
Type
boolean

hasRelation(name) → {boolean}

Parameters:
Name Type Description
name string relation name
Source:
Returns:
true if relation exists (including inherited)
Type
boolean

invalidateAttributeCache()

Deprecated:
  • NOOP
Source:

isHiddenCompletely()

Source:
Returns:
boolean - true if there's no non-hidden path, note is not cloned to the visible tree

isHtml() → {boolean}

Source:
Returns:
true if this note is HTML
Type
boolean

isJavaScript() → {boolean}

Source:
Returns:
true if this note is JavaScript (code or file)
Type
boolean

isJson() → {boolean}

Source:
Returns:
Type
boolean

isLabelTruthy(name) → {boolean}

Parameters:
Name Type Description
name string label name
Source:
Returns:
true if label exists (including inherited) and does not have "false" value.
Type
boolean