trilium
    Preparing search index...

    Class FNote

    Note is the main node and concept in Trilium.

    Index

    Constructors

    constructor

    Properties

    attachments attributes blobId children childToBranch highlightedTokens? isProtected mime noteId parents parentToBranch searchResultsLoaded? targetRelations title type

    Accessors

    dto isArchived

    Methods

    __getInheritableAttributes __validateTypeName addChild addParent executeScript getAllNotePaths getAttachmentById getAttachments getAttachmentsByRole getAttribute getAttributes getAttributeValue getBestNotePath getBestNotePathString getBlob getBranches getBranchIds getChildBranches getChildNoteIds getChildNotes getColorClass getContent getCssClass getFilteredChildBranches getIcon getJsonContent getLabel getLabels getLabelValue getMetadata getNoteComplement getNotesToInheritAttributesFrom getOwnedAttribute getOwnedAttributes getOwnedAttributeValue getOwnedLabel getOwnedLabels getOwnedLabelValue getOwnedRelation getOwnedRelations getOwnedRelationValue getParentBranches getParentBranchIds getParentNoteIds getParentNotes getPromotedDefinitionAttributes getRelation getRelations getRelationTarget getRelationTargets getRelationValue getScriptEnv getSortedNotePathRecords getTargetRelations getTargetRelationSourceNotes getWorkspaceIconClass getWorkspaceTabBackgroundColor hasAncestor hasAttribute hasChildren hasLabel hasOwnedAttribute hasOwnedLabel hasOwnedRelation hasRelation invalidateAttributeCache isContentAvailable isEligibleForConversionToAttachment isFolder isHiddenCompletely isHtml isInHiddenSubtree isJavaScript isJson isLabelTruthy isLaunchBarConfig isOptions isRoot isShared sortChildren sortParents toString update

    Constructors

    Properties

    attachments: null | FAttachment[]
    attributes: string[]
    blobId: string
    children: string[]
    childToBranch: Record<string, string>
    highlightedTokens?: string[]
    isProtected: boolean
    mime: string

    content-type, e.g. "application/json"

    noteId: string
    parents: string[]
    parentToBranch: Record<string, string>
    searchResultsLoaded?: boolean
    targetRelations: string[]
    title: string
    type: NoteType

    Accessors

    Methods

    __getInheritableAttributes

    __validateTypeName

    • Parameters

      • childNoteId: string
      • branchId: string
      • sort: boolean = true

      Returns void

    • Parameters

      • parentNoteId: string
      • branchId: string
      • sort: boolean = true

      Returns void

    • Gives all possible note paths leading to this note. Paths containing search note are ignored (could form cycles)

      Returns string[][]

      array of notePaths (each represented by array of noteIds constituting the particular note path)

    • Parameters

      • type: AttributeType

        attribute type (label, relation, etc.)

      • name: string

        attribute name

      Returns null | string

      attribute value of the given type and name or null if no such attribute exists.

    • Returns the note path considered to be the "best"

      Parameters

      • OptionalhoistedNoteId: string = "root"

      Returns string[]

      array of noteIds constituting the particular note path

    • Returns the note path considered to be the "best"

      Parameters

      • OptionalhoistedNoteId: string = "root"

      Returns string

      serialized note path (e.g. 'root/a1h315/js725h')

    • Parameters

      • name: string

        label name

      Returns null | string

      label value if label exists, null otherwise

    • Parameters

      • type: AttributeType

        attribute type (label, relation, etc.)

      • name: string

        attribute name

      Returns null | string

      attribute value of the given type and name or null if no such attribute exists.

    • Parameters

      • name: string

        label name

      Returns null | string

      label value if label exists, null otherwise

    • Parameters

      • name: string

        relation name

      Returns null | string

      relation value if relation exists, null otherwise

    • Parameters

      • name: string

      Returns Promise<null | FNote>

      target note of the relation or null (if target is empty or note was not found)

    • Parameters

      • name: string

        relation name

      Returns null | string

      relation value if relation exists, null otherwise

    • Returns null | "frontend" | "backend"

      JS script environment - either "frontend" or "backend"

    • Parameters

      • ancestorNoteId: string
      • followTemplates: boolean = false
      • visitedNoteIds: null | Set<string> = null

      Returns boolean

    • Parameters

      • name: string

        relation name

      Returns boolean

      true if relation exists (excluding inherited)

    • Parameters

      • name: string

        label name

      Returns boolean

      true if label exists (including inherited) and does not have "false" value.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    __getInheritableAttributes__validateTypeNameaddChildaddParentexecuteScriptgetAllNotePathsgetAttachmentByIdgetAttachmentsgetAttachmentsByRolegetAttributegetAttributesgetAttributeValuegetBestNotePathgetBestNotePathStringgetBlobgetBranchesgetBranchIdsgetChildBranchesgetChildNoteIdsgetChildNotesgetColorClassgetContentgetCssClassgetFilteredChildBranchesgetIcongetJsonContentgetLabelgetLabelsgetLabelValuegetMetadatagetNoteComplementgetNotesToInheritAttributesFromgetOwnedAttributegetOwnedAttributesgetOwnedAttributeValuegetOwnedLabelgetOwnedLabelsgetOwnedLabelValuegetOwnedRelationgetOwnedRelationsgetOwnedRelationValuegetParentBranchesgetParentBranchIdsgetParentNoteIdsgetParentNotesgetPromotedDefinitionAttributesgetRelationgetRelationsgetRelationTargetgetRelationTargetsgetRelationValuegetScriptEnvgetSortedNotePathRecordsgetTargetRelationsgetTargetRelationSourceNotesgetWorkspaceIconClassgetWorkspaceTabBackgroundColorhasAncestorhasAttributehasChildrenhasLabelhasOwnedAttributehasOwnedLabelhasOwnedRelationhasRelationinvalidateAttributeCacheisContentAvailableisEligibleForConversionToAttachmentisFolderisHiddenCompletelyisHtmlisInHiddenSubtreeisJavaScriptisJsonisLabelTruthyisLaunchBarConfigisOptionsisRootisSharedsortChildrensortParentstoStringupdate